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.audit.AuditEvent;
  23 import org.apache.archiva.audit.AuditListener;
  24 import org.apache.archiva.scheduler.ArchivaTaskScheduler;
  25 import org.apache.archiva.scheduler.repository.RepositoryArchivaTaskScheduler;
  26 import org.apache.archiva.scheduler.repository.RepositoryTask;
  27 import org.apache.commons.io.FileUtils;
  28 import org.apache.commons.io.IOUtils;
  29 import org.apache.jackrabbit.util.Text;
  30 import org.apache.jackrabbit.webdav.DavException;
  31 import org.apache.jackrabbit.webdav.DavResource;
  32 import org.apache.jackrabbit.webdav.DavResourceFactory;
  33 import org.apache.jackrabbit.webdav.DavResourceIterator;
  34 import org.apache.jackrabbit.webdav.DavResourceIteratorImpl;
  35 import org.apache.jackrabbit.webdav.DavResourceLocator;
  36 import org.apache.jackrabbit.webdav.DavServletResponse;
  37 import org.apache.jackrabbit.webdav.DavSession;
  38 import org.apache.jackrabbit.webdav.MultiStatusResponse;
  39 import org.apache.jackrabbit.webdav.io.InputContext;
  40 import org.apache.jackrabbit.webdav.io.OutputContext;
  41 import org.apache.jackrabbit.webdav.lock.ActiveLock;
  42 import org.apache.jackrabbit.webdav.lock.LockInfo;
  43 import org.apache.jackrabbit.webdav.lock.LockManager;
  44 import org.apache.jackrabbit.webdav.lock.Scope;
  45 import org.apache.jackrabbit.webdav.lock.Type;
  46 import org.apache.jackrabbit.webdav.property.DavProperty;
  47 import org.apache.jackrabbit.webdav.property.DavPropertyName;
  48 import org.apache.jackrabbit.webdav.property.DavPropertyNameSet;
  49 import org.apache.jackrabbit.webdav.property.DavPropertySet;
  50 import org.apache.jackrabbit.webdav.property.DefaultDavProperty;
  51 import org.apache.jackrabbit.webdav.property.ResourceType;
  52 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  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 '{}' (current user '{}')", resource.getDisplayName(), 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 '{}' retrieved by '{}'", item, 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                     if ( !FileUtils.deleteQuietly( resource ) )
 388                     {
 389                         throw new IOException( "Could not remove directory" );
 390                     }
 391
 392                     triggerAuditEvent( member, AuditEvent.REMOVE_DIR );
 393                 }
 394                 else
 395                 {
 396                     if ( !resource.delete() )
 397                     {
 398                         throw new IOException( "Could not remove file" );
 399                     }
 400
 401                     triggerAuditEvent( member, AuditEvent.REMOVE_FILE );
 402                 }
 403                 log.debug( ( resource.isDirectory() ? "Directory '" : "File '" ) + member.getDisplayName() +
 404                     "' removed (current user '" + this.principal + "')" );
 405             }
 406             catch ( IOException e )
 407             {
 408                 throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR );
 409             }
 410         }
 411         else
 412         {
 413             throw new DavException( HttpServletResponse.SC_NOT_FOUND );
 414         }
 415     }
 416
 417     private void triggerAuditEvent( DavResource member, String event )
 418         throws DavException
 419     {
 420         String path = logicalResource + "/" + member.getDisplayName();
 421
 422         ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( member );
 423         AuditEvent auditEvent = new AuditEvent( locator.getRepositoryId(), resource.principal, path, event );
 424         auditEvent.setRemoteIP( resource.remoteAddr );
 425
 426         for ( AuditListener listener : auditListeners )
 427         {
 428             listener.auditEvent( auditEvent );
 429         }
 430     }
 431
 432     public void move( DavResource destination )
 433         throws DavException
 434     {
 435         if ( !exists() )
 436         {
 437             throw new DavException( HttpServletResponse.SC_NOT_FOUND, "Resource to copy does not exist." );
 438         }
 439
 440         try
 441         {
 442             ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( destination );
 443             if ( isCollection() )
 444             {
 445                 FileUtils.moveDirectory( getLocalResource(), resource.getLocalResource() );
 446
 447                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.MOVE_DIRECTORY );
 448             }
 449             else
 450             {
 451                 FileUtils.moveFile( getLocalResource(), resource.getLocalResource() );
 452
 453                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.MOVE_FILE );
 454             }
 455
 456             log.debug( ( isCollection() ? "Directory '" : "File '" ) + getLocalResource().getName() + "' moved to '" +
 457                 destination + "' (current user '" + this.principal + "')" );
 458         }
 459         catch ( IOException e )
 460         {
 461             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
 462         }
 463     }
 464
 465     public void copy( DavResource destination, boolean shallow )
 466         throws DavException
 467     {
 468         if ( !exists() )
 469         {
 470             throw new DavException( HttpServletResponse.SC_NOT_FOUND, "Resource to copy does not exist." );
 471         }
 472
 473         if ( shallow && isCollection() )
 474         {
 475             throw new DavException( DavServletResponse.SC_FORBIDDEN, "Unable to perform shallow copy for collection" );
 476         }
 477
 478         try
 479         {
 480             ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( destination );
 481             if ( isCollection() )
 482             {
 483                 FileUtils.copyDirectory( getLocalResource(), resource.getLocalResource() );
 484
 485                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.COPY_DIRECTORY );
 486             }
 487             else
 488             {
 489                 FileUtils.copyFile( getLocalResource(), resource.getLocalResource() );
 490
 491                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.COPY_FILE );
 492             }
 493             log.debug( ( isCollection() ? "Directory '" : "File '" ) + getLocalResource().getName() + "' copied to '" +
 494                 destination + "' (current user '" + this.principal + "')" );
 495         }
 496         catch ( IOException e )
 497         {
 498             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
 499         }
 500     }
 501
 502     public boolean isLockable( Type type, Scope scope )
 503     {
 504         return Type.WRITE.equals( type ) && Scope.EXCLUSIVE.equals( scope );
 505     }
 506
 507     public boolean hasLock( Type type, Scope scope )
 508     {
 509         return getLock( type, scope ) != null;
 510     }
 511
 512     public ActiveLock getLock( Type type, Scope scope )
 513     {
 514         ActiveLock lock = null;
 515         if ( exists() && Type.WRITE.equals( type ) && Scope.EXCLUSIVE.equals( scope ) )
 516         {
 517             lock = lockManager.getLock( type, scope, this );
 518         }
 519         return lock;
 520     }
 521
 522     public ActiveLock[] getLocks()
 523     {
 524         ActiveLock writeLock = getLock( Type.WRITE, Scope.EXCLUSIVE );
 525         return ( writeLock != null ) ? new ActiveLock[]{writeLock} : new ActiveLock[0];
 526     }
 527
 528     public ActiveLock lock( LockInfo lockInfo )
 529         throws DavException
 530     {
 531         ActiveLock lock = null;
 532         if ( isLockable( lockInfo.getType(), lockInfo.getScope() ) )
 533         {
 534             lock = lockManager.createLock( lockInfo, this );
 535         }
 536         else
 537         {
 538             throw new DavException( DavServletResponse.SC_PRECONDITION_FAILED, "Unsupported lock type or scope." );
 539         }
 540         return lock;
 541     }
 542
 543     public ActiveLock refreshLock( LockInfo lockInfo, String lockToken )
 544         throws DavException
 545     {
 546         if ( !exists() )
 547         {
 548             throw new DavException( DavServletResponse.SC_NOT_FOUND );
 549         }
 550         ActiveLock lock = getLock( lockInfo.getType(), lockInfo.getScope() );
 551         if ( lock == null )
 552         {
 553             throw new DavException( DavServletResponse.SC_PRECONDITION_FAILED,
 554                                     "No lock with the given type/scope present on resource " + getResourcePath() );
 555         }
 556
 557         lock = lockManager.refreshLock( lockInfo, lockToken, this );
 558
 559         return lock;
 560     }
 561
 562     public void unlock( String lockToken )
 563         throws DavException
 564     {
 565         ActiveLock lock = getLock( Type.WRITE, Scope.EXCLUSIVE );
 566         if ( lock == null )
 567         {
 568             throw new DavException( HttpServletResponse.SC_PRECONDITION_FAILED );
 569         }
 570         else if ( lock.isLockedByToken( lockToken ) )
 571         {
 572             lockManager.releaseLock( lockToken, this );
 573         }
 574         else
 575         {
 576             throw new DavException( DavServletResponse.SC_LOCKED );
 577         }
 578     }
 579
 580     public void addLockManager( LockManager lockManager )
 581     {
 582         this.lockManager = lockManager;
 583     }
 584
 585     public DavResourceFactory getFactory()
 586     {
 587         return factory;
 588     }
 589
 590     public DavSession getSession()
 591     {
 592         return session;
 593     }
 594
 595     /**
 596      * Fill the set of properties
 597      */
 598     protected DavPropertySet initProperties()
 599     {
 600         if ( !exists() )
 601         {
 602             properties = new DavPropertySet();
 603         }
 604
 605         if ( properties != null )
 606         {
 607             return properties;
 608         }
 609
 610         DavPropertySet properties = new DavPropertySet();
 611
 612         // set (or reset) fundamental properties
 613         if ( getDisplayName() != null )
 614         {
 615             properties.add( new DefaultDavProperty( DavPropertyName.DISPLAYNAME, getDisplayName() ) );
 616         }
 617         if ( isCollection() )
 618         {
 619             properties.add( new ResourceType( ResourceType.COLLECTION ) );
 620             // Windows XP support
 621             properties.add( new DefaultDavProperty( DavPropertyName.ISCOLLECTION, "1" ) );
 622         }
 623         else
 624         {
 625             properties.add( new ResourceType( ResourceType.DEFAULT_RESOURCE ) );
 626
 627             // Windows XP support
 628             properties.add( new DefaultDavProperty( DavPropertyName.ISCOLLECTION, "0" ) );
 629         }
 630
 631         // Need to get the ISO8601 date for properties
 632         DateTime dt = new DateTime( localResource.lastModified() );
 633         DateTimeFormatter fmt = ISODateTimeFormat.dateTime();
 634         String modifiedDate = fmt.print( dt );
 635
 636         properties.add( new DefaultDavProperty( DavPropertyName.GETLASTMODIFIED, modifiedDate ) );
 637
 638         properties.add( new DefaultDavProperty( DavPropertyName.CREATIONDATE, modifiedDate ) );
 639
 640         properties.add( new DefaultDavProperty( DavPropertyName.GETCONTENTLENGTH, localResource.length() ) );
 641
 642         this.properties = properties;
 643
 644         return properties;
 645     }
 646
 647     private ArchivaDavResource checkDavResourceIsArchivaDavResource( DavResource resource )
 648         throws DavException
 649     {
 650         if ( !( resource instanceof ArchivaDavResource ) )
 651         {
 652             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
 653                                     "DavResource is not instance of ArchivaDavResource" );
 654         }
 655         return (ArchivaDavResource) resource;
 656     }
 657
 658     private void triggerAuditEvent( String remoteIP, String repositoryId, String resource, String action )
 659     {
 660         AuditEvent event = new AuditEvent( repositoryId, principal, resource, action );
 661         event.setRemoteIP( remoteIP );
 662
 663         for ( AuditListener listener : auditListeners )
 664         {
 665             listener.auditEvent( event );
 666         }
 667     }
 668
 669     private void queueRepositoryTask( File localFile )
 670     {
 671         RepositoryTask task = new RepositoryTask();
 672         task.setRepositoryId( repository.getId() );
 673         task.setResourceFile( localFile );
 674         task.setUpdateRelatedArtifacts( false );
 675         task.setScanAll( true );
 676
 677         try
 678         {
 679             scheduler.queueTask( task );
 680         }
 681         catch ( TaskQueueException e )
 682         {
 683             log.error(
 684                 "Unable to queue repository task to execute consumers on resource file ['" + localFile.getName() +
 685                     "']." );
 686         }
 687     }
 688 }