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      * <p>
 108      * Tests the path to see if it conforms to the expectations of a support file request.
 109      * </p>
 110      * <p>
 111      * Tests for <code>.sha1</code>, <code>.md5</code>, <code>.asc</code>, and <code>.php</code>.
 112      * </p>
 113      * <p>
 114      * NOTE: This does a cursory check on the path's extension only.  A result of true
 115      * from this method is not a guarantee that the support resource is in a valid format, or
 116      * that it even contains data.
 117      * </p>
 118      *
 119      * @param requestedPath the path to test.
 120      * @return true if the requestedPath is likely that of a support file request.
 121      */
 122     public boolean isSupportFile( String requestedPath )
 123     {
 124         int idx = requestedPath.lastIndexOf( '.' );
 125         if ( idx <= 0 )
 126         {
 127             return false;
 128         }
 129
 130         String ext = requestedPath.substring( idx );
 131         return ( ".sha1".equals( ext ) || ".md5".equals( ext ) || ".asc".equals( ext ) || ".pgp".equals( ext ) );
 132     }
 133
 134     public boolean isMetadataSupportFile( String requestedPath )
 135     {
 136         if ( isSupportFile( requestedPath ) )
 137         {
 138             String basefilePath = StringUtils.substring( requestedPath, 0, requestedPath.lastIndexOf( '.' ) );
 139             if ( isMetadata( basefilePath ) )
 140             {
 141                 return true;
 142             }
 143         }
 144
 145         return false;
 146     }
 147
 148     /**
 149      * <p>
 150      * Tests the path to see if it conforms to the expectations of a default layout request.
 151      * </p>
 152      * <p>
 153      * NOTE: This does a cursory check on the count of path elements only.  A result of
 154      * true from this method is not a guarantee that the path sections are valid and
 155      * can be resolved to an artifact reference.  use {@link #toArtifactReference(String)}
 156      * if you want a more complete analysis of the validity of the path.
 157      * </p>
 158      *
 159      * @param requestedPath the path to test.
 160      * @return true if the requestedPath is likely that of a default layout request.
 161      */
 162     public boolean isDefault( String requestedPath )
 163     {
 164         if ( StringUtils.isBlank( requestedPath ) )
 165         {
 166             return false;
 167         }
 168
 169         String pathParts[] = StringUtils.splitPreserveAllTokens( requestedPath, '/' );
 170         if ( pathParts.length > 3 )
 171         {
 172             return true;
 173         }
 174         else if ( pathParts.length == 3 )
 175         {
 176             // check if artifact-level metadata (ex. eclipse/jdtcore/maven-metadata.xml)
 177             if ( isMetadata( requestedPath ) )
 178             {
 179                 return true;
 180             }
 181             else
 182             {
 183                 // check if checksum of artifact-level metadata (ex. eclipse/jdtcore/maven-metadata.xml.sha1)
 184                 int idx = requestedPath.lastIndexOf( '.' );
 185                 if ( idx > 0 )
 186                 {
 187                     String base = requestedPath.substring( 0, idx );
 188                     if ( isMetadata( base ) && isSupportFile( requestedPath ) )
 189                     {
 190                         return true;
 191                     }
 192                 }
 193
 194                 return false;
 195             }
 196         }
 197         else
 198         {
 199             return false;
 200         }
 201     }
 202
 203     /**
 204      * <p>
 205      * Tests the path to see if it conforms to the expectations of a legacy layout request.
 206      * </p>
 207      * <p>
 208      * NOTE: This does a cursory check on the count of path elements only.  A result of
 209      * true from this method is not a guarantee that the path sections are valid and
 210      * can be resolved to an artifact reference.  use {@link #toArtifactReference(String)}
 211      * if you want a more complete analysis of the validity of the path.
 212      * </p>
 213      *
 214      * @param requestedPath the path to test.
 215      * @return true if the requestedPath is likely that of a legacy layout request.
 216      */
 217     public boolean isLegacy( String requestedPath )
 218     {
 219         if ( StringUtils.isBlank( requestedPath ) )
 220         {
 221             return false;
 222         }
 223
 224         String pathParts[] = StringUtils.splitPreserveAllTokens( requestedPath, '/' );
 225         return pathParts.length == 3;
 226     }
 227
 228     /**
 229      * Adjust the requestedPath to conform to the native layout of the provided {@link ManagedRepositoryContent}.
 230      *
 231      * @param requestedPath the incoming requested path.
 232      * @param repository    the repository to adjust to.
 233      * @return the adjusted (to native) path.
 234      * @throws LayoutException if the path cannot be parsed.
 235      */
 236     public String toNativePath( String requestedPath, ManagedRepositoryContent repository )
 237         throws LayoutException
 238     {
 239         if ( StringUtils.isBlank( requestedPath ) )
 240         {
 241             throw new LayoutException( "Request Path is blank." );
 242         }
 243
 244         String referencedResource = requestedPath;
 245         // No checksum by default.
 246         String supportfile = "";
 247
 248         // Figure out support file, and actual referencedResource.
 249         if ( isSupportFile( requestedPath ) )
 250         {
 251             int idx = requestedPath.lastIndexOf( '.' );
 252             referencedResource = requestedPath.substring( 0, idx );
 253             supportfile = requestedPath.substring( idx );
 254         }
 255
 256         if ( isMetadata( referencedResource ) )
 257         {
 258             if ( repository instanceof ManagedLegacyRepositoryContent )
 259             {
 260                 throw new LayoutException( "Cannot translate metadata request to legacy layout." );
 261             }
 262
 263             /* Nothing to translate.
 264              * Default layout is the only layout that can contain maven-metadata.xml files, and
 265              * if the managedRepository is layout legacy, this request would never occur.
 266              */
 267             return requestedPath;
 268         }
 269
 270         // Treat as an artifact reference.
 271         ArtifactReference ref = toArtifactReference( referencedResource );
 272         String adjustedPath = repository.toPath( ref );
 273         return adjustedPath + supportfile;
 274     }
 275 }