source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.repository.content;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *  http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import org.apache.commons.lang.StringUtils;
  23 import org.apache.archiva.model.ArtifactReference;
  24 import org.apache.archiva.repository.ManagedRepositoryContent;
  25 import org.apache.archiva.repository.layout.LayoutException;
  26 import org.apache.archiva.repository.metadata.MetadataTools;
  27
  28 /**
  29  * RepositoryRequest is used to determine the type of request that is incoming, and convert it to an appropriate
  30  * ArtifactReference.
  31  *
  32  *
  33  * <p/>
  34  */
  35 public class RepositoryRequest
  36 {
  37     private PathParser defaultPathParser = new DefaultPathParser();
  38
  39     private PathParser legacyPathParser;
  40
  41     public RepositoryRequest (LegacyPathParser legacyPathParser)
  42     {
  43         this.legacyPathParser = legacyPathParser;
  44     }
  45
  46     /**
  47      * Takes an incoming requested path (in "/" format) and gleans the layout
  48      * and ArtifactReference appropriate for that content.
  49      *
  50      * @param requestedPath the relative path to the content.
  51      * @return the ArtifactReference for the requestedPath.
  52      * @throws LayoutException if the request path is not layout valid.
  53      */
  54     public ArtifactReference toArtifactReference( String requestedPath )
  55         throws LayoutException
  56     {
  57         if ( StringUtils.isBlank( requestedPath ) )
  58         {
  59             throw new LayoutException( "Blank request path is not a valid." );
  60         }
  61
  62         String path = requestedPath;
  63         while ( path.startsWith( "/" ) )
  64         {
  65             path = path.substring( 1 );
  66
  67             // Only slash? that's bad, mmm-kay?
  68             if ( "/".equals( path ) )
  69             {
  70                 throw new LayoutException( "Invalid request path: Slash only." );
  71             }
  72         }
  73
  74         if ( isDefault( path ) )
  75         {
  76             return defaultPathParser.toArtifactReference( path );
  77         }
  78         else if ( isLegacy( path ) )
  79         {
  80             return legacyPathParser.toArtifactReference( path );
  81         }
  82         else
  83         {
  84             throw new LayoutException( "Not a valid request path layout, too short." );
  85         }
  86     }
  87
  88     /**
  89      * <p>
  90      * Tests the path to see if it conforms to the expectations of a metadata request.
  91      * </p>
  92      * <p>
  93      * NOTE: This does a cursory check on the path's last element.  A result of true
  94      * from this method is not a guarantee that the metadata is in a valid format, or
  95      * that it even contains data.
  96      * </p>
  97      *
  98      * @param requestedPath the path to test.
  99      * @return true if the requestedPath is likely a metadata request.
 100      */
 101     public boolean isMetadata( String requestedPath )
 102     {
 103         return requestedPath.endsWith( "/" + MetadataTools.MAVEN_METADATA );
 104     }
 105
 106     /**
 107      *
 108      * @param requestedPath
 109      * @return true if the requestedPath is likely an archetype catalog request.
 110      */
 111     public boolean isArchetypeCatalog( String requestedPath )
 112     {
 113         //TODO: Make it static final String
 114         return requestedPath.endsWith( "/archetype-catalog.xml");
 115     }
 116
 117     /**
 118      * <p>
 119      * Tests the path to see if it conforms to the expectations of a support file request.
 120      * </p>
 121      * <p>
 122      * Tests for <code>.sha1</code>, <code>.md5</code>, <code>.asc</code>, and <code>.php</code>.
 123      * </p>
 124      * <p>
 125      * NOTE: This does a cursory check on the path's extension only.  A result of true
 126      * from this method is not a guarantee that the support resource is in a valid format, or
 127      * that it even contains data.
 128      * </p>
 129      *
 130      * @param requestedPath the path to test.
 131      * @return true if the requestedPath is likely that of a support file request.
 132      */
 133     public boolean isSupportFile( String requestedPath )
 134     {
 135         int idx = requestedPath.lastIndexOf( '.' );
 136         if ( idx <= 0 )
 137         {
 138             return false;
 139         }
 140
 141         String ext = requestedPath.substring( idx );
 142         return ( ".sha1".equals( ext ) || ".md5".equals( ext ) || ".asc".equals( ext ) || ".pgp".equals( ext ) );
 143     }
 144
 145     public boolean isMetadataSupportFile( String requestedPath )
 146     {
 147         if ( isSupportFile( requestedPath ) )
 148         {
 149             String basefilePath = StringUtils.substring( requestedPath, 0, requestedPath.lastIndexOf( '.' ) );
 150             if ( isMetadata( basefilePath ) )
 151             {
 152                 return true;
 153             }
 154         }
 155
 156         return false;
 157     }
 158
 159     /**
 160      * <p>
 161      * Tests the path to see if it conforms to the expectations of a default layout request.
 162      * </p>
 163      * <p>
 164      * NOTE: This does a cursory check on the count of path elements only.  A result of
 165      * true from this method is not a guarantee that the path sections are valid and
 166      * can be resolved to an artifact reference.  use {@link #toArtifactReference(String)}
 167      * if you want a more complete analysis of the validity of the path.
 168      * </p>
 169      *
 170      * @param requestedPath the path to test.
 171      * @return true if the requestedPath is likely that of a default layout request.
 172      */
 173     public boolean isDefault( String requestedPath )
 174     {
 175         if ( StringUtils.isBlank( requestedPath ) )
 176         {
 177             return false;
 178         }
 179
 180         String pathParts[] = StringUtils.splitPreserveAllTokens( requestedPath, '/' );
 181         if ( pathParts.length > 3 )
 182         {
 183             return true;
 184         }
 185         else if ( pathParts.length == 3 )
 186         {
 187             // check if artifact-level metadata (ex. eclipse/jdtcore/maven-metadata.xml)
 188             if ( isMetadata( requestedPath ) )
 189             {
 190                 return true;
 191             }
 192             else
 193             {
 194                 // check if checksum of artifact-level metadata (ex. eclipse/jdtcore/maven-metadata.xml.sha1)
 195                 int idx = requestedPath.lastIndexOf( '.' );
 196                 if ( idx > 0 )
 197                 {
 198                     String base = requestedPath.substring( 0, idx );
 199                     if ( isMetadata( base ) && isSupportFile( requestedPath ) )
 200                     {
 201                         return true;
 202                     }
 203                 }
 204
 205                 return false;
 206             }
 207         }
 208         else
 209         {
 210             return false;
 211         }
 212     }
 213
 214     /**
 215      * <p>
 216      * Tests the path to see if it conforms to the expectations of a legacy layout request.
 217      * </p>
 218      * <p>
 219      * NOTE: This does a cursory check on the count of path elements only.  A result of
 220      * true from this method is not a guarantee that the path sections are valid and
 221      * can be resolved to an artifact reference.  use {@link #toArtifactReference(String)}
 222      * if you want a more complete analysis of the validity of the path.
 223      * </p>
 224      *
 225      * @param requestedPath the path to test.
 226      * @return true if the requestedPath is likely that of a legacy layout request.
 227      */
 228     public boolean isLegacy( String requestedPath )
 229     {
 230         if ( StringUtils.isBlank( requestedPath ) )
 231         {
 232             return false;
 233         }
 234
 235         String pathParts[] = StringUtils.splitPreserveAllTokens( requestedPath, '/' );
 236         return pathParts.length == 3;
 237     }
 238
 239     /**
 240      * Adjust the requestedPath to conform to the native layout of the provided {@link ManagedRepositoryContent}.
 241      *
 242      * @param requestedPath the incoming requested path.
 243      * @param repository    the repository to adjust to.
 244      * @return the adjusted (to native) path.
 245      * @throws LayoutException if the path cannot be parsed.
 246      */
 247     public String toNativePath( String requestedPath, ManagedRepositoryContent repository )
 248         throws LayoutException
 249     {
 250         if ( StringUtils.isBlank( requestedPath ) )
 251         {
 252             throw new LayoutException( "Request Path is blank." );
 253         }
 254
 255         String referencedResource = requestedPath;
 256         // No checksum by default.
 257         String supportfile = "";
 258
 259         // Figure out support file, and actual referencedResource.
 260         if ( isSupportFile( requestedPath ) )
 261         {
 262             int idx = requestedPath.lastIndexOf( '.' );
 263             referencedResource = requestedPath.substring( 0, idx );
 264             supportfile = requestedPath.substring( idx );
 265         }
 266
 267         if ( isMetadata( referencedResource ) )
 268         {
 269             if ( repository instanceof ManagedLegacyRepositoryContent )
 270             {
 271                 throw new LayoutException( "Cannot translate metadata request to legacy layout." );
 272             }
 273
 274             /* Nothing to translate.
 275              * Default layout is the only layout that can contain maven-metadata.xml files, and
 276              * if the managedRepository is layout legacy, this request would never occur.
 277              */
 278             return requestedPath;
 279         }
 280
 281         // Treat as an artifact reference.
 282         ArtifactReference ref = toArtifactReference( referencedResource );
 283         String adjustedPath = repository.toPath( ref );
 284         return adjustedPath + supportfile;
 285     }
 286 }