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

   1 package org.apache.maven.archiva.webdav;
   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.archiva.scheduler.ArchivaTaskScheduler;
  23 import org.apache.archiva.scheduler.repository.RepositoryArchivaTaskScheduler;
  24 import org.apache.archiva.scheduler.repository.RepositoryTask;
  25 import org.apache.commons.io.FileUtils;
  26 import org.apache.commons.io.IOUtils;
  27 import org.apache.jackrabbit.util.Text;
  28 import org.apache.jackrabbit.webdav.DavException;
  29 import org.apache.jackrabbit.webdav.DavResource;
  30 import org.apache.jackrabbit.webdav.DavResourceFactory;
  31 import org.apache.jackrabbit.webdav.DavResourceIterator;
  32 import org.apache.jackrabbit.webdav.DavResourceIteratorImpl;
  33 import org.apache.jackrabbit.webdav.DavResourceLocator;
  34 import org.apache.jackrabbit.webdav.DavServletResponse;
  35 import org.apache.jackrabbit.webdav.DavSession;
  36 import org.apache.jackrabbit.webdav.MultiStatusResponse;
  37 import org.apache.jackrabbit.webdav.io.InputContext;
  38 import org.apache.jackrabbit.webdav.io.OutputContext;
  39 import org.apache.jackrabbit.webdav.lock.ActiveLock;
  40 import org.apache.jackrabbit.webdav.lock.LockInfo;
  41 import org.apache.jackrabbit.webdav.lock.LockManager;
  42 import org.apache.jackrabbit.webdav.lock.Scope;
  43 import org.apache.jackrabbit.webdav.lock.Type;
  44 import org.apache.jackrabbit.webdav.property.DavProperty;
  45 import org.apache.jackrabbit.webdav.property.DavPropertyName;
  46 import org.apache.jackrabbit.webdav.property.DavPropertyNameSet;
  47 import org.apache.jackrabbit.webdav.property.DavPropertySet;
  48 import org.apache.jackrabbit.webdav.property.DefaultDavProperty;
  49 import org.apache.jackrabbit.webdav.property.ResourceType;
  50 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  51 import org.apache.maven.archiva.repository.audit.AuditEvent;
  52 import org.apache.maven.archiva.repository.audit.AuditListener;
  53 import org.apache.maven.archiva.webdav.util.IndexWriter;
  54 import org.apache.maven.archiva.webdav.util.MimeTypes;
  55 import org.codehaus.plexus.taskqueue.TaskQueueException;
  56 import org.joda.time.DateTime;
  57 import org.joda.time.format.DateTimeFormatter;
  58 import org.joda.time.format.ISODateTimeFormat;
  59 import org.slf4j.Logger;
  60 import org.slf4j.LoggerFactory;
  61
  62 import java.io.File;
  63 import java.io.FileInputStream;
  64 import java.io.FileOutputStream;
  65 import java.io.IOException;
  66 import java.util.ArrayList;
  67 import java.util.List;
  68 import javax.servlet.http.HttpServletResponse;
  69
  70 /**
  71  */
  72 public class ArchivaDavResource
  73     implements DavResource
  74 {
  75     public static final String HIDDEN_PATH_PREFIX = ".";
  76
  77     private final ArchivaDavResourceLocator locator;
  78
  79     private final DavResourceFactory factory;
  80
  81     private final File localResource;
  82
  83     private final String logicalResource;
  84
  85     private DavPropertySet properties = null;
  86
  87     private LockManager lockManager;
  88
  89     private final DavSession session;
  90
  91     private String remoteAddr;
  92
  93     private final ManagedRepositoryConfiguration repository;
  94
  95     private final MimeTypes mimeTypes;
  96
  97     private List<AuditListener> auditListeners;
  98
  99     private String principal;
 100
 101     public static final String COMPLIANCE_CLASS = "1, 2";
 102
 103     private ArchivaTaskScheduler scheduler;
 104
 105     private Logger log = LoggerFactory.getLogger( ArchivaDavResource.class );
 106
 107     public ArchivaDavResource( String localResource, String logicalResource, ManagedRepositoryConfiguration repository,
 108                                DavSession session, ArchivaDavResourceLocator locator, DavResourceFactory factory,
 109                                MimeTypes mimeTypes, List<AuditListener> auditListeners,
 110                                RepositoryArchivaTaskScheduler scheduler )
 111     {
 112         this.localResource = new File( localResource );
 113         this.logicalResource = logicalResource;
 114         this.locator = locator;
 115         this.factory = factory;
 116         this.session = session;
 117
 118         // TODO: push into locator as well as moving any references out of the resource factory
 119         this.repository = repository;
 120
 121         // TODO: these should be pushed into the repository layer, along with the physical file operations in this class
 122         this.mimeTypes = mimeTypes;
 123         this.auditListeners = auditListeners;
 124         this.scheduler = scheduler;
 125     }
 126
 127     public ArchivaDavResource( String localResource, String logicalResource, ManagedRepositoryConfiguration repository,
 128                                String remoteAddr, String principal, DavSession session,
 129                                ArchivaDavResourceLocator locator, DavResourceFactory factory, MimeTypes mimeTypes,
 130                                List<AuditListener> auditListeners, RepositoryArchivaTaskScheduler scheduler )
 131     {
 132         this( localResource, logicalResource, repository, session, locator, factory, mimeTypes, auditListeners,
 133               scheduler );
 134
 135         this.remoteAddr = remoteAddr;
 136         this.principal = principal;
 137     }
 138
 139     public String getComplianceClass()
 140     {
 141         return COMPLIANCE_CLASS;
 142     }
 143
 144     public String getSupportedMethods()
 145     {
 146         return METHODS;
 147     }
 148
 149     public boolean exists()
 150     {
 151         return localResource.exists();
 152     }
 153
 154     public boolean isCollection()
 155     {
 156         return localResource.isDirectory();
 157     }
 158
 159     public String getDisplayName()
 160     {
 161         String resPath = getResourcePath();
 162         return ( resPath != null ) ? Text.getName( resPath ) : resPath;
 163     }
 164
 165     public DavResourceLocator getLocator()
 166     {
 167         return locator;
 168     }
 169
 170     public File getLocalResource()
 171     {
 172         return localResource;
 173     }
 174
 175     public String getResourcePath()
 176     {
 177         return locator.getResourcePath();
 178     }
 179
 180     public String getHref()
 181     {
 182         return locator.getHref( isCollection() );
 183     }
 184
 185     public long getModificationTime()
 186     {
 187         return localResource.lastModified();
 188     }
 189
 190     public void spool( OutputContext outputContext )
 191         throws IOException
 192     {
 193         if ( !isCollection() )
 194         {
 195             outputContext.setContentLength( localResource.length() );
 196             outputContext.setContentType( mimeTypes.getMimeType( localResource.getName() ) );
 197         }
 198
 199         if ( !isCollection() && outputContext.hasStream() )
 200         {
 201             FileInputStream is = null;
 202             try
 203             {
 204                 // Write content to stream
 205                 is = new FileInputStream( localResource );
 206                 IOUtils.copy( is, outputContext.getOutputStream() );
 207             }
 208             finally
 209             {
 210                 IOUtils.closeQuietly( is );
 211             }
 212         }
 213         else if ( outputContext.hasStream() )
 214         {
 215             IndexWriter writer = new IndexWriter( this, localResource, logicalResource );
 216             writer.write( outputContext );
 217         }
 218     }
 219
 220     public DavPropertyName[] getPropertyNames()
 221     {
 222         return getProperties().getPropertyNames();
 223     }
 224
 225     public DavProperty getProperty( DavPropertyName name )
 226     {
 227         return getProperties().get( name );
 228     }
 229
 230     public DavPropertySet getProperties()
 231     {
 232         return initProperties();
 233     }
 234
 235     public void setProperty( DavProperty property )
 236         throws DavException
 237     {
 238     }
 239
 240     public void removeProperty( DavPropertyName propertyName )
 241         throws DavException
 242     {
 243     }
 244
 245     public MultiStatusResponse alterProperties( DavPropertySet setProperties, DavPropertyNameSet removePropertyNames )
 246         throws DavException
 247     {
 248         return null;
 249     }
 250
 251     @SuppressWarnings( "unchecked" )
 252     public MultiStatusResponse alterProperties( List changeList )
 253         throws DavException
 254     {
 255         return null;
 256     }
 257
 258     public DavResource getCollection()
 259     {
 260         DavResource parent = null;
 261         if ( getResourcePath() != null && !getResourcePath().equals( "/" ) )
 262         {
 263             String parentPath = Text.getRelativeParent( getResourcePath(), 1 );
 264             if ( parentPath.equals( "" ) )
 265             {
 266                 parentPath = "/";
 267             }
 268             DavResourceLocator parentloc = locator.getFactory().createResourceLocator( locator.getPrefix(),
 269                                                                                        parentPath );
 270             try
 271             {
 272                 parent = factory.createResource( parentloc, session );
 273             }
 274             catch ( DavException e )
 275             {
 276                 // should not occur
 277             }
 278         }
 279         return parent;
 280     }
 281
 282     public void addMember( DavResource resource, InputContext inputContext )
 283         throws DavException
 284     {
 285         File localFile = new File( localResource, resource.getDisplayName() );
 286         boolean exists = localFile.exists();
 287
 288         if ( isCollection() && inputContext.hasStream() ) // New File
 289         {
 290             FileOutputStream stream = null;
 291             try
 292             {
 293                 stream = new FileOutputStream( localFile );
 294                 IOUtils.copy( inputContext.getInputStream(), stream );
 295             }
 296             catch ( IOException e )
 297             {
 298                 throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
 299             }
 300             finally
 301             {
 302                 IOUtils.closeQuietly( stream );
 303             }
 304
 305             // TODO: a bad deployment shouldn't delete an existing file - do we need to write to a temporary location first?
 306             long expectedContentLength = inputContext.getContentLength();
 307             long actualContentLength = localFile.length();
 308             // length of -1 is given for a chunked request or unknown length, in which case we accept what was uploaded
 309             if ( expectedContentLength >= 0 && expectedContentLength != actualContentLength )
 310             {
 311                 String msg =
 312                     "Content Header length was " + expectedContentLength + " but was " + actualContentLength;
 313                 log.debug( "Upload failed: " + msg );
 314
 315                 FileUtils.deleteQuietly( localFile );
 316                 throw new DavException( HttpServletResponse.SC_BAD_REQUEST, msg );
 317             }
 318
 319             queueRepositoryTask( localFile );
 320
 321             log.debug(
 322                 "File '" + resource.getDisplayName() + ( exists ? "' modified " : "' created " ) + "(current user '" +
 323                     this.principal + "')" );
 324
 325             triggerAuditEvent( resource, exists ? AuditEvent.MODIFY_FILE : AuditEvent.CREATE_FILE );
 326         }
 327         else if ( !inputContext.hasStream() && isCollection() ) // New directory
 328         {
 329             localFile.mkdir();
 330
 331             log.debug( "Directory '" + resource.getDisplayName() + "' (current user '" + this.principal + "')" );
 332
 333             triggerAuditEvent( resource, AuditEvent.CREATE_DIR );
 334         }
 335         else
 336         {
 337             String msg = "Could not write member " + resource.getResourcePath() + " at " + getResourcePath() +
 338                 " as this is not a DAV collection";
 339             log.debug( msg );
 340             throw new DavException( HttpServletResponse.SC_BAD_REQUEST, msg );
 341         }
 342     }
 343
 344     public DavResourceIterator getMembers()
 345     {
 346         List<DavResource> list = new ArrayList<DavResource>();
 347         if ( exists() && isCollection() )
 348         {
 349             for ( String item : localResource.list() )
 350             {
 351                 try
 352                 {
 353                     if ( !item.startsWith( HIDDEN_PATH_PREFIX ) )
 354                     {
 355                         String path = locator.getResourcePath() + '/' + item;
 356                         DavResourceLocator resourceLocator = locator.getFactory().createResourceLocator(
 357                             locator.getPrefix(), path );
 358                         DavResource resource = factory.createResource( resourceLocator, session );
 359
 360                         if ( resource != null )
 361                         {
 362                             list.add( resource );
 363                         }
 364                         log.debug( "Resource '" + item + "' retrieved by '" + this.principal + "'" );
 365                     }
 366                 }
 367                 catch ( DavException e )
 368                 {
 369                     // Should not occur
 370                 }
 371             }
 372         }
 373         return new DavResourceIteratorImpl( list );
 374     }
 375
 376     public void removeMember( DavResource member )
 377         throws DavException
 378     {
 379         File resource = checkDavResourceIsArchivaDavResource( member ).getLocalResource();
 380
 381         if ( resource.exists() )
 382         {
 383             try
 384             {
 385                 if ( resource.isDirectory() )
 386                 {
 387                     FileUtils.deleteDirectory( resource );
 388
 389                     triggerAuditEvent( member, AuditEvent.REMOVE_DIR );
 390                 }
 391                 else
 392                 {
 393                     if ( !resource.delete() )
 394                     {
 395                         throw new IOException( "Could not remove file" );
 396                     }
 397
 398                     triggerAuditEvent( member, AuditEvent.REMOVE_FILE );
 399                 }
 400                 log.debug( ( resource.isDirectory() ? "Directory '" : "File '" ) + member.getDisplayName() +
 401                     "' removed (current user '" + this.principal + "')" );
 402             }
 403             catch ( IOException e )
 404             {
 405                 throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR );
 406             }
 407         }
 408         else
 409         {
 410             throw new DavException( HttpServletResponse.SC_NOT_FOUND );
 411         }
 412     }
 413
 414     private void triggerAuditEvent( DavResource member, String event )
 415         throws DavException
 416     {
 417         String path = logicalResource + "/" + member.getDisplayName();
 418
 419         ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( member );
 420         AuditEvent auditEvent = new AuditEvent( locator.getRepositoryId(), resource.principal, path, event );
 421         auditEvent.setRemoteIP( resource.remoteAddr );
 422
 423         for ( AuditListener listener : auditListeners )
 424         {
 425             listener.auditEvent( auditEvent );
 426         }
 427     }
 428
 429     public void move( DavResource destination )
 430         throws DavException
 431     {
 432         if ( !exists() )
 433         {
 434             throw new DavException( HttpServletResponse.SC_NOT_FOUND, "Resource to copy does not exist." );
 435         }
 436
 437         try
 438         {
 439             ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( destination );
 440             if ( isCollection() )
 441             {
 442                 FileUtils.moveDirectory( getLocalResource(), resource.getLocalResource() );
 443
 444                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.MOVE_DIRECTORY );
 445             }
 446             else
 447             {
 448                 FileUtils.moveFile( getLocalResource(), resource.getLocalResource() );
 449
 450                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.MOVE_FILE );
 451             }
 452
 453             log.debug( ( isCollection() ? "Directory '" : "File '" ) + getLocalResource().getName() + "' moved to '" +
 454                 destination + "' (current user '" + this.principal + "')" );
 455         }
 456         catch ( IOException e )
 457         {
 458             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
 459         }
 460     }
 461
 462     public void copy( DavResource destination, boolean shallow )
 463         throws DavException
 464     {
 465         if ( !exists() )
 466         {
 467             throw new DavException( HttpServletResponse.SC_NOT_FOUND, "Resource to copy does not exist." );
 468         }
 469
 470         if ( shallow && isCollection() )
 471         {
 472             throw new DavException( DavServletResponse.SC_FORBIDDEN, "Unable to perform shallow copy for collection" );
 473         }
 474
 475         try
 476         {
 477             ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( destination );
 478             if ( isCollection() )
 479             {
 480                 FileUtils.copyDirectory( getLocalResource(), resource.getLocalResource() );
 481
 482                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.COPY_DIRECTORY );
 483             }
 484             else
 485             {
 486                 FileUtils.copyFile( getLocalResource(), resource.getLocalResource() );
 487
 488                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.COPY_FILE );
 489             }
 490             log.debug( ( isCollection() ? "Directory '" : "File '" ) + getLocalResource().getName() + "' copied to '" +
 491                 destination + "' (current user '" + this.principal + "')" );
 492         }
 493         catch ( IOException e )
 494         {
 495             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
 496         }
 497     }
 498
 499     public boolean isLockable( Type type, Scope scope )
 500     {
 501         return Type.WRITE.equals( type ) && Scope.EXCLUSIVE.equals( scope );
 502     }
 503
 504     public boolean hasLock( Type type, Scope scope )
 505     {
 506         return getLock( type, scope ) != null;
 507     }
 508
 509     public ActiveLock getLock( Type type, Scope scope )
 510     {
 511         ActiveLock lock = null;
 512         if ( exists() && Type.WRITE.equals( type ) && Scope.EXCLUSIVE.equals( scope ) )
 513         {
 514             lock = lockManager.getLock( type, scope, this );
 515         }
 516         return lock;
 517     }
 518
 519     public ActiveLock[] getLocks()
 520     {
 521         ActiveLock writeLock = getLock( Type.WRITE, Scope.EXCLUSIVE );
 522         return ( writeLock != null ) ? new ActiveLock[]{writeLock} : new ActiveLock[0];
 523     }
 524
 525     public ActiveLock lock( LockInfo lockInfo )
 526         throws DavException
 527     {
 528         ActiveLock lock = null;
 529         if ( isLockable( lockInfo.getType(), lockInfo.getScope() ) )
 530         {
 531             lock = lockManager.createLock( lockInfo, this );
 532         }
 533         else
 534         {
 535             throw new DavException( DavServletResponse.SC_PRECONDITION_FAILED, "Unsupported lock type or scope." );
 536         }
 537         return lock;
 538     }
 539
 540     public ActiveLock refreshLock( LockInfo lockInfo, String lockToken )
 541         throws DavException
 542     {
 543         if ( !exists() )
 544         {
 545             throw new DavException( DavServletResponse.SC_NOT_FOUND );
 546         }
 547         ActiveLock lock = getLock( lockInfo.getType(), lockInfo.getScope() );
 548         if ( lock == null )
 549         {
 550             throw new DavException( DavServletResponse.SC_PRECONDITION_FAILED,
 551                                     "No lock with the given type/scope present on resource " + getResourcePath() );
 552         }
 553
 554         lock = lockManager.refreshLock( lockInfo, lockToken, this );
 555
 556         return lock;
 557     }
 558
 559     public void unlock( String lockToken )
 560         throws DavException
 561     {
 562         ActiveLock lock = getLock( Type.WRITE, Scope.EXCLUSIVE );
 563         if ( lock == null )
 564         {
 565             throw new DavException( HttpServletResponse.SC_PRECONDITION_FAILED );
 566         }
 567         else if ( lock.isLockedByToken( lockToken ) )
 568         {
 569             lockManager.releaseLock( lockToken, this );
 570         }
 571         else
 572         {
 573             throw new DavException( DavServletResponse.SC_LOCKED );
 574         }
 575     }
 576
 577     public void addLockManager( LockManager lockManager )
 578     {
 579         this.lockManager = lockManager;
 580     }
 581
 582     public DavResourceFactory getFactory()
 583     {
 584         return factory;
 585     }
 586
 587     public DavSession getSession()
 588     {
 589         return session;
 590     }
 591
 592     /**
 593      * Fill the set of properties
 594      */
 595     protected DavPropertySet initProperties()
 596     {
 597         if ( !exists() )
 598         {
 599             properties = new DavPropertySet();
 600         }
 601
 602         if ( properties != null )
 603         {
 604             return properties;
 605         }
 606
 607         DavPropertySet properties = new DavPropertySet();
 608
 609         // set (or reset) fundamental properties
 610         if ( getDisplayName() != null )
 611         {
 612             properties.add( new DefaultDavProperty( DavPropertyName.DISPLAYNAME, getDisplayName() ) );
 613         }
 614         if ( isCollection() )
 615         {
 616             properties.add( new ResourceType( ResourceType.COLLECTION ) );
 617             // Windows XP support
 618             properties.add( new DefaultDavProperty( DavPropertyName.ISCOLLECTION, "1" ) );
 619         }
 620         else
 621         {
 622             properties.add( new ResourceType( ResourceType.DEFAULT_RESOURCE ) );
 623
 624             // Windows XP support
 625             properties.add( new DefaultDavProperty( DavPropertyName.ISCOLLECTION, "0" ) );
 626         }
 627
 628         // Need to get the ISO8601 date for properties
 629         DateTime dt = new DateTime( localResource.lastModified() );
 630         DateTimeFormatter fmt = ISODateTimeFormat.dateTime();
 631         String modifiedDate = fmt.print( dt );
 632
 633         properties.add( new DefaultDavProperty( DavPropertyName.GETLASTMODIFIED, modifiedDate ) );
 634
 635         properties.add( new DefaultDavProperty( DavPropertyName.CREATIONDATE, modifiedDate ) );
 636
 637         properties.add( new DefaultDavProperty( DavPropertyName.GETCONTENTLENGTH, localResource.length() ) );
 638
 639         this.properties = properties;
 640
 641         return properties;
 642     }
 643
 644     private ArchivaDavResource checkDavResourceIsArchivaDavResource( DavResource resource )
 645         throws DavException
 646     {
 647         if ( !( resource instanceof ArchivaDavResource ) )
 648         {
 649             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
 650                                     "DavResource is not instance of ArchivaDavResource" );
 651         }
 652         return (ArchivaDavResource) resource;
 653     }
 654
 655     private void triggerAuditEvent( String remoteIP, String repositoryId, String resource, String action )
 656     {
 657         AuditEvent event = new AuditEvent( repositoryId, principal, resource, action );
 658         event.setRemoteIP( remoteIP );
 659
 660         for ( AuditListener listener : auditListeners )
 661         {
 662             listener.auditEvent( event );
 663         }
 664     }
 665
 666     private void queueRepositoryTask( File localFile )
 667     {
 668         RepositoryTask task = new RepositoryTask();
 669         task.setRepositoryId( repository.getId() );
 670         task.setResourceFile( localFile );
 671         task.setUpdateRelatedArtifacts( false );
 672         task.setScanAll( true );
 673
 674         try
 675         {
 676             scheduler.queueTask( task );
 677         }
 678         catch ( TaskQueueException e )
 679         {
 680             log.error(
 681                 "Unable to queue repository task to execute consumers on resource file ['" + localFile.getName() +
 682                     "']." );
 683         }
 684     }
 685 }