]> source.dussan.org Git - archiva.git/blob
559f160d80f2251076f024d513ddc232369ea305
[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.setContentType( mimeTypes.getMimeType( localResource.getName() ) );
217         }
218
219         try
220         {
221             if ( !isCollection() && outputContext.hasStream() )
222             {
223                 Lock lock = fileLockManager.readFileLock( localResource );
224                 try (InputStream is = Files.newInputStream( lock.getFile().toPath() ))
225                 {
226                     IOUtils.copy( is, outputContext.getOutputStream() );
227                 }
228             }
229             else if ( outputContext.hasStream() )
230             {
231                 IndexWriter writer = new IndexWriter( this, localResource, logicalResource );
232                 writer.write( outputContext );
233             }
234         }
235         catch ( FileLockException e )
236         {
237             throw new IOException( e.getMessage(), e );
238         }
239         catch ( FileLockTimeoutException e )
240         {
241             throw new IOException( e.getMessage(), e );
242         }
243     }
244
245     @Override
246     public DavPropertyName[] getPropertyNames()
247     {
248         return getProperties().getPropertyNames();
249     }
250
251     @Override
252     public DavProperty getProperty( DavPropertyName name )
253     {
254         return getProperties().get( name );
255     }
256
257     @Override
258     public DavPropertySet getProperties()
259     {
260         return initProperties();
261     }
262
263     @Override
264     public void setProperty( DavProperty property )
265         throws DavException
266     {
267     }
268
269     @Override
270     public void removeProperty( DavPropertyName propertyName )
271         throws DavException
272     {
273     }
274
275     public MultiStatusResponse alterProperties( DavPropertySet setProperties, DavPropertyNameSet removePropertyNames )
276         throws DavException
277     {
278         return null;
279     }
280
281     @SuppressWarnings("unchecked")
282     @Override
283     public MultiStatusResponse alterProperties( List changeList )
284         throws DavException
285     {
286         return null;
287     }
288
289     @Override
290     public DavResource getCollection()
291     {
292         DavResource parent = null;
293         if ( getResourcePath() != null && !getResourcePath().equals( "/" ) )
294         {
295             String parentPath = Text.getRelativeParent( getResourcePath(), 1 );
296             if ( parentPath.equals( "" ) )
297             {
298                 parentPath = "/";
299             }
300             DavResourceLocator parentloc =
301                 locator.getFactory().createResourceLocator( locator.getPrefix(), parentPath );
302             try
303             {
304                 parent = factory.createResource( parentloc, session );
305             }
306             catch ( DavException e )
307             {
308                 // should not occur
309             }
310         }
311         return parent;
312     }
313
314     @Override
315     public void addMember( DavResource resource, InputContext inputContext )
316         throws DavException
317     {
318         File localFile = new File( localResource, resource.getDisplayName() );
319         boolean exists = localFile.exists();
320
321         if ( isCollection() && inputContext.hasStream() ) // New File
322         {
323             try (OutputStream stream = Files.newOutputStream( localFile.toPath() ))
324             {
325                 IOUtils.copy( inputContext.getInputStream(), stream );
326             }
327             catch ( IOException e )
328             {
329                 throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
330             }
331
332             // TODO: a bad deployment shouldn't delete an existing file - do we need to write to a temporary location first?
333             long expectedContentLength = inputContext.getContentLength();
334             long actualContentLength = localFile.length();
335             // length of -1 is given for a chunked request or unknown length, in which case we accept what was uploaded
336             if ( expectedContentLength >= 0 && expectedContentLength != actualContentLength )
337             {
338                 String msg = "Content Header length was " + expectedContentLength + " but was " + actualContentLength;
339                 log.debug( "Upload failed: {}", msg );
340
341                 FileUtils.deleteQuietly( localFile );
342                 throw new DavException( HttpServletResponse.SC_BAD_REQUEST, msg );
343             }
344
345             queueRepositoryTask( localFile );
346
347             log.debug( "File '{}{}(current user '{}')", resource.getDisplayName(),
348                        ( exists ? "' modified " : "' created " ), this.principal );
349
350             triggerAuditEvent( resource, exists ? AuditEvent.MODIFY_FILE : AuditEvent.CREATE_FILE );
351         }
352         else if ( !inputContext.hasStream() && isCollection() ) // New directory
353         {
354             localFile.mkdir();
355
356             log.debug( "Directory '{}' (current user '{}')", resource.getDisplayName(), this.principal );
357
358             triggerAuditEvent( resource, AuditEvent.CREATE_DIR );
359         }
360         else
361         {
362             String msg = "Could not write member " + resource.getResourcePath() + " at " + getResourcePath()
363                 + " as this is not a DAV collection";
364             log.debug( msg );
365             throw new DavException( HttpServletResponse.SC_BAD_REQUEST, msg );
366         }
367     }
368
369     @Override
370     public DavResourceIterator getMembers()
371     {
372         List<DavResource> list = new ArrayList<>();
373         if ( exists() && isCollection() )
374         {
375             for ( String item : localResource.list() )
376             {
377                 try
378                 {
379                     if ( !item.startsWith( HIDDEN_PATH_PREFIX ) )
380                     {
381                         String path = locator.getResourcePath() + '/' + item;
382                         DavResourceLocator resourceLocator =
383                             locator.getFactory().createResourceLocator( locator.getPrefix(), path );
384                         DavResource resource = factory.createResource( resourceLocator, session );
385
386                         if ( resource != null )
387                         {
388                             list.add( resource );
389                         }
390                         log.debug( "Resource '{}' retrieved by '{}'", item, this.principal );
391                     }
392                 }
393                 catch ( DavException e )
394                 {
395                     // Should not occur
396                 }
397             }
398         }
399         return new DavResourceIteratorImpl( list );
400     }
401
402     @Override
403     public void removeMember( DavResource member )
404         throws DavException
405     {
406         File resource = checkDavResourceIsArchivaDavResource( member ).getLocalResource();
407
408         if ( resource.exists() )
409         {
410             try
411             {
412                 if ( resource.isDirectory() )
413                 {
414                     if ( !FileUtils.deleteQuietly( resource ) )
415                     {
416                         throw new IOException( "Could not remove directory" );
417                     }
418
419                     triggerAuditEvent( member, AuditEvent.REMOVE_DIR );
420                 }
421                 else
422                 {
423                     if ( !resource.delete() )
424                     {
425                         throw new IOException( "Could not remove file" );
426                     }
427
428                     triggerAuditEvent( member, AuditEvent.REMOVE_FILE );
429                 }
430
431                 log.debug( "{}{}' removed (current user '{}')", ( resource.isDirectory() ? "Directory '" : "File '" ),
432                            member.getDisplayName(), this.principal );
433
434             }
435             catch ( IOException e )
436             {
437                 throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR );
438             }
439         }
440         else
441         {
442             throw new DavException( HttpServletResponse.SC_NOT_FOUND );
443         }
444     }
445
446     private void triggerAuditEvent( DavResource member, String event )
447         throws DavException
448     {
449         String path = logicalResource + "/" + member.getDisplayName();
450
451         ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( member );
452         AuditEvent auditEvent = new AuditEvent( locator.getRepositoryId(), resource.principal, path, event );
453         auditEvent.setRemoteIP( resource.remoteAddr );
454
455         for ( AuditListener listener : auditListeners )
456         {
457             listener.auditEvent( auditEvent );
458         }
459     }
460
461     @Override
462     public void move( DavResource destination )
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         try
471         {
472             ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( destination );
473             if ( isCollection() )
474             {
475                 FileUtils.moveDirectory( getLocalResource(), resource.getLocalResource() );
476
477                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.MOVE_DIRECTORY );
478             }
479             else
480             {
481                 FileUtils.moveFile( getLocalResource(), resource.getLocalResource() );
482
483                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.MOVE_FILE );
484             }
485
486             log.debug( "{}{}' moved to '{}' (current user '{}')", ( isCollection() ? "Directory '" : "File '" ),
487                        getLocalResource().getName(), destination, this.principal );
488
489         }
490         catch ( IOException e )
491         {
492             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
493         }
494     }
495
496     @Override
497     public void copy( DavResource destination, boolean shallow )
498         throws DavException
499     {
500         if ( !exists() )
501         {
502             throw new DavException( HttpServletResponse.SC_NOT_FOUND, "Resource to copy does not exist." );
503         }
504
505         if ( shallow && isCollection() )
506         {
507             throw new DavException( DavServletResponse.SC_FORBIDDEN, "Unable to perform shallow copy for collection" );
508         }
509
510         try
511         {
512             ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( destination );
513             if ( isCollection() )
514             {
515                 FileUtils.copyDirectory( getLocalResource(), resource.getLocalResource() );
516
517                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.COPY_DIRECTORY );
518             }
519             else
520             {
521                 FileUtils.copyFile( getLocalResource(), resource.getLocalResource() );
522
523                 triggerAuditEvent( remoteAddr, locator.getRepositoryId(), logicalResource, AuditEvent.COPY_FILE );
524             }
525
526             log.debug( "{}{}' copied to '{}' (current user '{)')", ( isCollection() ? "Directory '" : "File '" ),
527                        getLocalResource().getName(), destination, this.principal );
528
529         }
530         catch ( IOException e )
531         {
532             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
533         }
534     }
535
536     @Override
537     public boolean isLockable( Type type, Scope scope )
538     {
539         return Type.WRITE.equals( type ) && Scope.EXCLUSIVE.equals( scope );
540     }
541
542     @Override
543     public boolean hasLock( Type type, Scope scope )
544     {
545         return getLock( type, scope ) != null;
546     }
547
548     @Override
549     public ActiveLock getLock( Type type, Scope scope )
550     {
551         ActiveLock lock = null;
552         if ( exists() && Type.WRITE.equals( type ) && Scope.EXCLUSIVE.equals( scope ) )
553         {
554             lock = lockManager.getLock( type, scope, this );
555         }
556         return lock;
557     }
558
559     @Override
560     public ActiveLock[] getLocks()
561     {
562         ActiveLock writeLock = getLock( Type.WRITE, Scope.EXCLUSIVE );
563         return ( writeLock != null ) ? new ActiveLock[]{ writeLock } : new ActiveLock[0];
564     }
565
566     @Override
567     public ActiveLock lock( LockInfo lockInfo )
568         throws DavException
569     {
570         ActiveLock lock = null;
571         if ( isLockable( lockInfo.getType(), lockInfo.getScope() ) )
572         {
573             lock = lockManager.createLock( lockInfo, this );
574         }
575         else
576         {
577             throw new DavException( DavServletResponse.SC_PRECONDITION_FAILED, "Unsupported lock type or scope." );
578         }
579         return lock;
580     }
581
582     @Override
583     public ActiveLock refreshLock( LockInfo lockInfo, String lockToken )
584         throws DavException
585     {
586         if ( !exists() )
587         {
588             throw new DavException( DavServletResponse.SC_NOT_FOUND );
589         }
590         ActiveLock lock = getLock( lockInfo.getType(), lockInfo.getScope() );
591         if ( lock == null )
592         {
593             throw new DavException( DavServletResponse.SC_PRECONDITION_FAILED,
594                                     "No lock with the given type/scope present on resource " + getResourcePath() );
595         }
596
597         lock = lockManager.refreshLock( lockInfo, lockToken, this );
598
599         return lock;
600     }
601
602     @Override
603     public void unlock( String lockToken )
604         throws DavException
605     {
606         ActiveLock lock = getLock( Type.WRITE, Scope.EXCLUSIVE );
607         if ( lock == null )
608         {
609             throw new DavException( HttpServletResponse.SC_PRECONDITION_FAILED );
610         }
611         else if ( lock.isLockedByToken( lockToken ) )
612         {
613             lockManager.releaseLock( lockToken, this );
614         }
615         else
616         {
617             throw new DavException( DavServletResponse.SC_LOCKED );
618         }
619     }
620
621     @Override
622     public void addLockManager( LockManager lockManager )
623     {
624         this.lockManager = lockManager;
625     }
626
627     @Override
628     public DavResourceFactory getFactory()
629     {
630         return factory;
631     }
632
633     @Override
634     public DavSession getSession()
635     {
636         return session;
637     }
638
639     /**
640      * Fill the set of properties
641      */
642     protected DavPropertySet initProperties()
643     {
644         if ( !exists() )
645         {
646             properties = new DavPropertySet();
647         }
648
649         if ( properties != null )
650         {
651             return properties;
652         }
653
654         DavPropertySet properties = new DavPropertySet();
655
656         // set (or reset) fundamental properties
657         if ( getDisplayName() != null )
658         {
659             properties.add( new DefaultDavProperty( DavPropertyName.DISPLAYNAME, getDisplayName() ) );
660         }
661         if ( isCollection() )
662         {
663             properties.add( new ResourceType( ResourceType.COLLECTION ) );
664             // Windows XP support
665             properties.add( new DefaultDavProperty( DavPropertyName.ISCOLLECTION, "1" ) );
666         }
667         else
668         {
669             properties.add( new ResourceType( ResourceType.DEFAULT_RESOURCE ) );
670
671             // Windows XP support
672             properties.add( new DefaultDavProperty( DavPropertyName.ISCOLLECTION, "0" ) );
673         }
674
675         // Need to get the ISO8601 date for properties
676         DateTime dt = new DateTime( localResource.lastModified() );
677         DateTimeFormatter fmt = ISODateTimeFormat.dateTime();
678         String modifiedDate = fmt.print( dt );
679
680         properties.add( new DefaultDavProperty( DavPropertyName.GETLASTMODIFIED, modifiedDate ) );
681
682         properties.add( new DefaultDavProperty( DavPropertyName.CREATIONDATE, modifiedDate ) );
683
684         properties.add( new DefaultDavProperty( DavPropertyName.GETCONTENTLENGTH, localResource.length() ) );
685
686         this.properties = properties;
687
688         return properties;
689     }
690
691     private ArchivaDavResource checkDavResourceIsArchivaDavResource( DavResource resource )
692         throws DavException
693     {
694         if ( !( resource instanceof ArchivaDavResource ) )
695         {
696             throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
697                                     "DavResource is not instance of ArchivaDavResource" );
698         }
699         return (ArchivaDavResource) resource;
700     }
701
702     private void triggerAuditEvent( String remoteIP, String repositoryId, String resource, String action )
703     {
704         AuditEvent event = new AuditEvent( repositoryId, principal, resource, action );
705         event.setRemoteIP( remoteIP );
706
707         for ( AuditListener listener : auditListeners )
708         {
709             listener.auditEvent( event );
710         }
711     }
712
713     private void queueRepositoryTask( File localFile )
714     {
715         RepositoryTask task = new RepositoryTask();
716         task.setRepositoryId( repository.getId() );
717         task.setResourceFile( localFile );
718         task.setUpdateRelatedArtifacts( false );
719         task.setScanAll( false );
720
721         try
722         {
723             scheduler.queueTask( task );
724         }
725         catch ( TaskQueueException e )
726         {
727             log.error( "Unable to queue repository task to execute consumers on resource file ['" + localFile.getName()
728                            + "']." );
729         }
730     }
731 }