]> source.dussan.org Git - archiva.git/blob
f359c9c77bfe3f0745deba67f6e09c093b6eedc7
[archiva.git] /
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 java.io.File;
23 import java.io.FileInputStream;
24 import java.io.FileOutputStream;
25 import java.io.IOException;
26 import java.util.ArrayList;
27 import java.util.Calendar;
28 import java.util.List;
29
30 import javax.servlet.http.HttpServletResponse;
31
32 import org.apache.commons.io.FileUtils;
33 import org.apache.commons.io.IOUtils;
34 import org.apache.jackrabbit.util.Text;
35 import org.apache.jackrabbit.webdav.DavConstants;
36 import org.apache.jackrabbit.webdav.DavException;
37 import org.apache.jackrabbit.webdav.DavResource;
38 import org.apache.jackrabbit.webdav.DavResourceFactory;
39 import org.apache.jackrabbit.webdav.DavResourceIterator;
40 import org.apache.jackrabbit.webdav.DavResourceIteratorImpl;
41 import org.apache.jackrabbit.webdav.DavResourceLocator;
42 import org.apache.jackrabbit.webdav.DavServletResponse;
43 import org.apache.jackrabbit.webdav.DavSession;
44 import org.apache.jackrabbit.webdav.MultiStatusResponse;
45 import org.apache.jackrabbit.webdav.io.InputContext;
46 import org.apache.jackrabbit.webdav.io.OutputContext;
47 import org.apache.jackrabbit.webdav.lock.ActiveLock;
48 import org.apache.jackrabbit.webdav.lock.LockInfo;
49 import org.apache.jackrabbit.webdav.lock.LockManager;
50 import org.apache.jackrabbit.webdav.lock.Scope;
51 import org.apache.jackrabbit.webdav.lock.Type;
52 import org.apache.jackrabbit.webdav.property.DavProperty;
53 import org.apache.jackrabbit.webdav.property.DavPropertyName;
54 import org.apache.jackrabbit.webdav.property.DavPropertyNameSet;
55 import org.apache.jackrabbit.webdav.property.DavPropertySet;
56 import org.apache.jackrabbit.webdav.property.DefaultDavProperty;
57 import org.apache.jackrabbit.webdav.property.ResourceType;
58 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
59 import org.apache.maven.archiva.database.ArchivaAuditLogsDao;
60 import org.apache.maven.archiva.model.ArchivaAuditLogs;
61 import org.apache.maven.archiva.repository.audit.AuditEvent;
62 import org.apache.maven.archiva.repository.audit.AuditListener;
63 import org.apache.maven.archiva.scheduled.ArchivaTaskScheduler;
64 import org.apache.maven.archiva.scheduled.tasks.RepositoryTask;
65 import org.apache.maven.archiva.scheduled.tasks.TaskCreator;
66 import org.apache.maven.archiva.webdav.util.IndexWriter;
67 import org.apache.maven.archiva.webdav.util.MimeTypes;
68 import org.codehaus.plexus.taskqueue.TaskQueueException;
69 import org.joda.time.DateTime;
70 import org.joda.time.format.DateTimeFormatter;
71 import org.joda.time.format.ISODateTimeFormat;
72 import org.slf4j.Logger;
73 import org.slf4j.LoggerFactory;
74
75 /**
76  */
77 public class ArchivaDavResource
78     implements DavResource
79 {
80     public static final String HIDDEN_PATH_PREFIX = ".";
81
82     private final ArchivaDavResourceLocator locator;
83
84     private final DavResourceFactory factory;
85
86     private final File localResource;
87
88     private final String logicalResource;
89
90     private DavPropertySet properties = null;
91
92     private LockManager lockManager;
93
94     private final DavSession session;
95
96     private String remoteAddr;
97
98     private final ManagedRepositoryConfiguration repository;
99
100     private final MimeTypes mimeTypes;
101
102     private List<AuditListener> auditListeners;
103
104     private String principal;
105
106     public static final String COMPLIANCE_CLASS = "1, 2";
107
108     private ArchivaTaskScheduler scheduler;
109
110     private Logger log = LoggerFactory.getLogger( ArchivaDavResource.class );
111     
112     private ArchivaAuditLogsDao auditLogsDao;
113
114     public ArchivaDavResource( String localResource, String logicalResource, ManagedRepositoryConfiguration repository,
115                                DavSession session, ArchivaDavResourceLocator locator, DavResourceFactory factory,
116                                MimeTypes mimeTypes, List<AuditListener> auditListeners,
117                                ArchivaTaskScheduler scheduler, ArchivaAuditLogsDao auditLogsDao )
118     {
119         this.localResource = new File( localResource );
120         this.logicalResource = logicalResource;
121         this.locator = locator;
122         this.factory = factory;
123         this.session = session;
124
125         // TODO: push into locator as well as moving any references out of the resource factory
126         this.repository = repository;
127
128         // TODO: these should be pushed into the repository layer, along with the physical file operations in this class
129         this.mimeTypes = mimeTypes;
130         this.auditListeners = auditListeners;
131         this.scheduler = scheduler;
132         this.auditLogsDao = auditLogsDao;
133     }
134
135     public ArchivaDavResource( String localResource, String logicalResource, ManagedRepositoryConfiguration repository,
136                                String remoteAddr, String principal, DavSession session, ArchivaDavResourceLocator locator,
137                                DavResourceFactory factory, MimeTypes mimeTypes, List<AuditListener> auditListeners,
138                                ArchivaTaskScheduler scheduler, ArchivaAuditLogsDao auditLogsDao )
139     {
140         this( localResource, logicalResource, repository, session, locator, factory, mimeTypes, auditListeners,
141               scheduler, auditLogsDao );
142
143         this.remoteAddr = remoteAddr;
144         this.principal = principal;
145     }
146
147     public String getComplianceClass()
148     {
149         return COMPLIANCE_CLASS;
150     }
151
152     public String getSupportedMethods()
153     {
154         return METHODS;
155     }
156
157     public boolean exists()
158     {
159         return localResource.exists();
160     }
161
162     public boolean isCollection()
163     {
164         return localResource.isDirectory();
165     }
166
167     public String getDisplayName()
168     {
169         String resPath = getResourcePath();
170         return ( resPath != null ) ? Text.getName( resPath ) : resPath;
171     }
172
173     public DavResourceLocator getLocator()
174     {
175         return locator;
176     }
177
178     public File getLocalResource()
179     {
180         return localResource;
181     }
182
183     public String getResourcePath()
184     {
185         return locator.getResourcePath();
186     }
187
188     public String getHref()
189     {
190         return locator.getHref( isCollection() );
191     }
192
193     public long getModificationTime()
194     {
195         return localResource.lastModified();
196     }
197
198     public void spool( OutputContext outputContext )
199         throws IOException
200     {
201         if ( !isCollection() )
202         {
203             outputContext.setProperty( DavConstants.HEADER_CONTENT_LENGTH, Long.toString( localResource.length() ) );
204             outputContext.setContentType( mimeTypes.getMimeType( localResource.getName() ) );
205         }
206
207         if ( !isCollection() && outputContext.hasStream() )
208         {
209             FileInputStream is = null;
210             try
211             {
212                 // Write content to stream
213                 is = new FileInputStream( localResource );
214                 IOUtils.copy( is, outputContext.getOutputStream() );
215             }
216             finally
217             {
218                 IOUtils.closeQuietly( is );
219             }
220         }
221         else if ( outputContext.hasStream() )
222         {
223             IndexWriter writer = new IndexWriter( this, localResource, logicalResource );
224             writer.write( outputContext );
225         }
226     }
227
228     public DavPropertyName[] getPropertyNames()
229     {
230         return getProperties().getPropertyNames();
231     }
232
233     public DavProperty getProperty( DavPropertyName name )
234     {
235         return getProperties().get( name );
236     }
237
238     public DavPropertySet getProperties()
239     {
240         return initProperties();
241     }
242
243     public void setProperty( DavProperty property )
244         throws DavException
245     {
246     }
247
248     public void removeProperty( DavPropertyName propertyName )
249         throws DavException
250     {
251     }
252
253     public MultiStatusResponse alterProperties( DavPropertySet setProperties, DavPropertyNameSet removePropertyNames )
254         throws DavException
255     {
256         return null;
257     }
258
259     @SuppressWarnings( "unchecked" )
260     public MultiStatusResponse alterProperties( List changeList )
261         throws DavException
262     {
263         return null;
264     }
265
266     public DavResource getCollection()
267     {
268         DavResource parent = null;
269         if ( getResourcePath() != null && !getResourcePath().equals( "/" ) )
270         {
271             String parentPath = Text.getRelativeParent( getResourcePath(), 1 );
272             if ( parentPath.equals( "" ) )
273             {
274                 parentPath = "/";
275             }
276             DavResourceLocator parentloc = locator.getFactory().createResourceLocator( locator.getPrefix(),
277                                                                                        parentPath );
278             try
279             {
280                 parent = factory.createResource( parentloc, session );
281             }
282             catch ( DavException e )
283             {
284                 // should not occur
285             }
286         }
287         return parent;
288     }
289
290     public void addMember( DavResource resource, InputContext inputContext )
291         throws DavException
292     {
293         File localFile = new File( localResource, resource.getDisplayName() );
294         boolean exists = localFile.exists();
295
296         if ( isCollection() && inputContext.hasStream() ) // New File
297         {
298             FileOutputStream stream = null;
299             try
300             {
301                 stream = new FileOutputStream( localFile );
302                 IOUtils.copy( inputContext.getInputStream(), stream );
303             }
304             catch ( IOException e )
305             {
306                 throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e );
307             }
308             finally
309             {
310                 IOUtils.closeQuietly( stream );
311             }
312
313             // TODO: a bad deployment shouldn't delete an existing file - do we need to write to a temporary location first?
314             long expectedContentLength = Long.parseLong( inputContext.getProperty( DavConstants.HEADER_CONTENT_LENGTH ) );
315             long actualContentLength = localFile.length();
316             // length of -1 is given for a chunked request or unknown length, in which case we accept what was uploaded
317             if ( expectedContentLength >= 0 && expectedContentLength != actualContentLength )
318             {
319                 String msg =
320                     "Content Header length was " + expectedContentLength + " but was " + actualContentLength;
321                 log.debug( "Upload failed: " + msg );
322
323                 FileUtils.deleteQuietly( localFile );
324                 throw new DavException( HttpServletResponse.SC_BAD_REQUEST, msg );
325             }
326
327             queueRepositoryTask( localFile );
328
329             log.debug(
330                 "File '" + resource.getDisplayName() + ( exists ? "' modified " : "' created " ) + "(current user '" +
331                     this.principal + "')" );
332
333             triggerAuditEvent( resource, exists ? AuditEvent.MODIFY_FILE : AuditEvent.CREATE_FILE );
334         }
335         else if ( !inputContext.hasStream() && isCollection() ) // New directory
336         {
337             localFile.mkdir();
338
339             log.debug( "Directory '" + resource.getDisplayName() + "' (current user '" + this.principal + "')" );
340
341             triggerAuditEvent( resource, AuditEvent.CREATE_DIR );
342         }
343         else
344         {
345             String msg = "Could not write member " + resource.getResourcePath() + " at " + getResourcePath() +
346                 " as this is not a DAV collection";
347             log.debug( msg );
348             throw new DavException( HttpServletResponse.SC_BAD_REQUEST, msg );
349         }
350     }
351
352     public DavResourceIterator getMembers()
353     {
354         List<DavResource> list = new ArrayList<DavResource>();
355         if ( exists() && isCollection() )
356         {
357             for ( String item : localResource.list() )
358             {
359                 try
360                 {
361                     if ( !item.startsWith( HIDDEN_PATH_PREFIX ) )
362                     {
363                         String path = locator.getResourcePath() + '/' + item;
364                         DavResourceLocator resourceLocator = locator.getFactory().createResourceLocator(
365                             locator.getPrefix(), path );
366                         DavResource resource = factory.createResource( resourceLocator, session );
367
368                         if ( resource != null )
369                         {
370                             list.add( resource );
371                         }
372                         log.debug( "Resource '" + item + "' retrieved by '" + this.principal + "'" );
373                     }
374                 }
375                 catch ( DavException e )
376                 {
377                     // Should not occur
378                 }
379             }
380         }
381         return new DavResourceIteratorImpl( list );
382     }
383
384     public void removeMember( DavResource member )
385         throws DavException
386     {
387         File resource = checkDavResourceIsArchivaDavResource( member ).getLocalResource();
388
389         if ( resource.exists() )
390         {
391             try
392             {
393                 if ( resource.isDirectory() )
394                 {
395                     FileUtils.deleteDirectory( resource );
396
397                     triggerAuditEvent( member, AuditEvent.REMOVE_DIR );
398                 }
399                 else
400                 {
401                     if ( !resource.delete() )
402                     {
403                         throw new IOException( "Could not remove file" );
404                     }
405
406                     triggerAuditEvent( member, AuditEvent.REMOVE_FILE );
407                 }
408                 log.debug( ( resource.isDirectory() ? "Directory '" : "File '" ) + member.getDisplayName() +
409                     "' removed (current user '" + this.principal + "')" );
410             }
411             catch ( IOException e )
412             {
413                 throw new DavException( HttpServletResponse.SC_INTERNAL_SERVER_ERROR );
414             }
415         }
416         else
417         {
418             throw new DavException( HttpServletResponse.SC_NOT_FOUND );
419         }
420     }
421
422     private void triggerAuditEvent( DavResource member, String event )
423         throws DavException
424     {
425         String path = logicalResource + "/" + member.getDisplayName();
426
427         ArchivaDavResource resource = checkDavResourceIsArchivaDavResource( member );
428         triggerAuditEvent( resource.remoteAddr, resource.principal, locator.getRepositoryId(), path,
429                            event );
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, principal, locator.getRepositoryId(), logicalResource, AuditEvent.MOVE_DIRECTORY );
448             }
449             else
450             {
451                 FileUtils.moveFile( getLocalResource(), resource.getLocalResource() );
452
453                 triggerAuditEvent( remoteAddr, principal, 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, principal, locator.getRepositoryId(), logicalResource, AuditEvent.COPY_DIRECTORY );
486             }
487             else
488             {
489                 FileUtils.copyFile( getLocalResource(), resource.getLocalResource() );
490
491                 triggerAuditEvent( remoteAddr, principal, 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 principal, String repositoryId, String resource,
659                                     String action )
660     {
661         AuditEvent event = new AuditEvent( repositoryId, principal, resource, action );
662         event.setRemoteIP( remoteIP );
663
664         for ( AuditListener listener : auditListeners )
665         {
666             listener.auditEvent( event );
667         }
668         
669         // identify as artifact deployment/upload
670         if( action.equals( AuditEvent.CREATE_FILE ) )
671         {
672             action = AuditEvent.UPLOAD_FILE;
673         }
674         
675         String user = principal;
676         if( principal == null )
677         {
678             user = "guest";
679         }
680         
681         ArchivaAuditLogs auditLogs = new ArchivaAuditLogs();
682         auditLogs.setArtifact( resource );
683         auditLogs.setEvent( action );
684         auditLogs.setEventDate( Calendar.getInstance().getTime() );
685         auditLogs.setRepositoryId( repositoryId );
686         auditLogs.setUsername( user );
687         
688         auditLogsDao.saveAuditLogs( auditLogs );
689     }
690
691     private void queueRepositoryTask( File localFile )
692     {
693         RepositoryTask task = TaskCreator.createRepositoryTask( repository.getId(), localFile, false, true );
694         
695         try
696         {
697             scheduler.queueRepositoryTask( task );
698         }
699         catch ( TaskQueueException e )
700         {
701             log.error(
702                 "Unable to queue repository task to execute consumers on resource file ['" + localFile.getName() +
703                     "']." );
704         }
705     }
706 }