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

   1 package org.apache.maven.archiva.consumers.lucene;
   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.commons.io.FileUtils;
  23 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  24 import org.apache.maven.archiva.configuration.FileTypes;
  25 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  26 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  27 import org.apache.maven.archiva.consumers.ConsumerException;
  28 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
  29 import org.apache.maven.archiva.indexer.RepositoryContentIndex;
  30 import org.apache.maven.archiva.indexer.RepositoryContentIndexFactory;
  31 import org.apache.maven.archiva.indexer.RepositoryIndexException;
  32 import org.apache.maven.archiva.indexer.filecontent.FileContentRecord;
  33 import org.apache.maven.archiva.model.ArchivaArtifact;
  34 import org.apache.maven.archiva.model.ArtifactReference;
  35 import org.apache.maven.archiva.repository.ManagedRepositoryContent;
  36 import org.apache.maven.archiva.repository.RepositoryContentFactory;
  37 import org.apache.maven.archiva.repository.RepositoryException;
  38 import org.apache.maven.archiva.repository.layout.LayoutException;
  39 import org.apache.maven.archiva.repository.metadata.MetadataTools;
  40 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
  41 import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
  42 import org.codehaus.plexus.registry.Registry;
  43 import org.codehaus.plexus.registry.RegistryListener;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 import java.io.File;
  48 import java.io.IOException;
  49 import java.util.ArrayList;
  50 import java.util.Date;
  51 import java.util.List;
  52
  53 /**
  54  * IndexContentConsumer - generic full file content indexing consumer.
  55  *
  56  * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
  57  * @version $Id$
  58  * @plexus.component role="org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer"
  59  * role-hint="index-content"
  60  * instantiation-strategy="per-lookup"
  61  */
  62 public class IndexContentConsumer
  63     extends AbstractMonitoredConsumer
  64     implements KnownRepositoryContentConsumer, RegistryListener, Initializable
  65 {
  66     private Logger log = LoggerFactory.getLogger( IndexContentConsumer.class );
  67
  68     private static final String READ_CONTENT = "read_content";
  69
  70     private static final String INDEX_ERROR = "indexing_error";
  71
  72     /**
  73      * @plexus.configuration default-value="index-content"
  74      */
  75     private String id;
  76
  77     /**
  78      * @plexus.configuration default-value="Text and XML file contents indexing"
  79      */
  80     private String description;
  81
  82     /**
  83      * @plexus.requirement
  84      */
  85     private ArchivaConfiguration configuration;
  86
  87     /**
  88      * @plexus.requirement
  89      */
  90     private FileTypes filetypes;
  91
  92     /**
  93      * @plexus.requirement
  94      */
  95     private RepositoryContentFactory repositoryFactory;
  96
  97     /**
  98      * @plexus.requirement role-hint="lucene"
  99      */
 100     private RepositoryContentIndexFactory indexFactory;
 101
 102     private List<String> propertyNameTriggers = new ArrayList<String>();
 103
 104     private List<String> includes = new ArrayList<String>();
 105
 106     private RepositoryContentIndex index;
 107
 108     private ManagedRepositoryContent repository;
 109
 110     private File repositoryDir;
 111
 112     public String getId()
 113     {
 114         return this.id;
 115     }
 116
 117     public String getDescription()
 118     {
 119         return this.description;
 120     }
 121
 122     public boolean isPermanent()
 123     {
 124         return false;
 125     }
 126
 127     public List<String> getExcludes()
 128     {
 129         return null;
 130     }
 131
 132     public List<String> getIncludes()
 133     {
 134         return this.includes;
 135     }
 136
 137     public void beginScan( ManagedRepositoryConfiguration repo, Date whenGathered )
 138         throws ConsumerException
 139     {
 140         try
 141         {
 142             this.repository = repositoryFactory.getManagedRepositoryContent( repo.getId() );
 143             this.repositoryDir = new File( repository.getRepoRoot() );
 144             this.index = indexFactory.createFileContentIndex( repository.getRepository() );
 145         }
 146         catch ( RepositoryException e )
 147         {
 148             throw new ConsumerException( "Unable to start IndexContentConsumer: " + e.getMessage(), e );
 149         }
 150     }
 151
 152     public void processFile( String path )
 153         throws ConsumerException
 154     {
 155         if ( path.endsWith( "/" + MetadataTools.MAVEN_METADATA ) )
 156         {
 157             log.debug( "File is a metadata file. Not indexing." );
 158             return;
 159         }
 160
 161         FileContentRecord record = new FileContentRecord();
 162         try
 163         {
 164             File file = new File( repositoryDir, path );
 165             record.setRepositoryId( this.repository.getId() );
 166             record.setFilename( path );
 167             record.setContents( FileUtils.readFileToString( file, null ) );
 168
 169             // Test for possible artifact reference syntax.
 170             try
 171             {
 172                 ArtifactReference ref = repository.toArtifactReference( path );
 173                 ArchivaArtifact artifact = new ArchivaArtifact( ref );
 174                 record.setArtifact( artifact );
 175             }
 176             catch ( LayoutException e )
 177             {
 178                 // Not an artifact.
 179             }
 180
 181             index.modifyRecord( record );
 182         }
 183         catch ( IOException e )
 184         {
 185             triggerConsumerError( READ_CONTENT, "Unable to read file contents: " + e.getMessage() );
 186         }
 187         catch ( RepositoryIndexException e )
 188         {
 189             triggerConsumerError( INDEX_ERROR, "Unable to index file contents: " + e.getMessage() );
 190         }
 191     }
 192
 193     public void completeScan()
 194     {
 195         /* do nothing */
 196     }
 197
 198     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 199     {
 200         if ( propertyNameTriggers.contains( propertyName ) )
 201         {
 202             initIncludes();
 203         }
 204     }
 205
 206     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 207     {
 208         /* do nothing */
 209     }
 210
 211     private void initIncludes()
 212     {
 213         includes.clear();
 214
 215         includes.addAll( filetypes.getFileTypePatterns( FileTypes.INDEXABLE_CONTENT ) );
 216     }
 217
 218     public void initialize()
 219         throws InitializationException
 220     {
 221         propertyNameTriggers = new ArrayList<String>();
 222         propertyNameTriggers.add( "repositoryScanning" );
 223         propertyNameTriggers.add( "fileTypes" );
 224         propertyNameTriggers.add( "fileType" );
 225         propertyNameTriggers.add( "patterns" );
 226         propertyNameTriggers.add( "pattern" );
 227
 228         configuration.addChangeListener( this );
 229
 230         initIncludes();
 231     }
 232 }