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