James Moger
2012-03-27 f5432e015d173f2665f7ca34735057e7b2b25d16
src/com/gitblit/LuceneExecutor.java
@@ -25,7 +25,6 @@
import java.text.MessageFormat;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
@@ -74,6 +73,7 @@
import org.eclipse.jgit.lib.ObjectLoader;
import org.eclipse.jgit.lib.ObjectReader;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.RepositoryCache.FileKey;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevTree;
import org.eclipse.jgit.revwalk.RevWalk;
@@ -138,35 +138,33 @@
   private final Map<String, IndexSearcher> searchers = new ConcurrentHashMap<String, IndexSearcher>();
   private final Map<String, IndexWriter> writers = new ConcurrentHashMap<String, IndexWriter>();
   
   private final Set<String> excludedExtensions = new TreeSet<String>(Arrays.asList("7z", "arc",
         "arj", "bin", "bmp", "dll", "doc", "docx", "exe", "gif", "gz", "jar", "jpg", "lib",
         "lzh", "odg", "pdf", "ppt", "png", "so", "swf", "xcf", "xls", "xlsx", "zip"));
   private final String luceneIgnoreExtensions = "7z arc arj bin bmp dll doc docx exe gif gz jar jpg lib lzh odg odf odt pdf ppt png so swf xcf xls xlsx zip";
   private Set<String> excludedExtensions;
   public LuceneExecutor(IStoredSettings settings, File repositoriesFolder) {
      this.storedSettings = settings;
      this.repositoriesFolder = repositoriesFolder;
      String exts = luceneIgnoreExtensions;
      if (settings != null) {
         exts = settings.getString(Keys.web.luceneIgnoreExtensions, exts);
      }
      excludedExtensions = new TreeSet<String>(StringUtils.getStringsFromValue(exts));
   }
   /**
    * Indicates if the Lucene executor can index repositories.
    *
    * @return true if the Lucene executor is ready to index repositories
    */
   public boolean isReady() {
      return storedSettings.getBoolean(Keys.lucene.enable, false);
   }
   /**
    * Run is executed by the gitblit executor service at whatever frequency
    * is specified in the settings.  Because this is called by an executor
    * service, calls will queue - i.e. there can never be concurrent execution
    * of repository index updates.
    * Run is executed by the Gitblit executor service.  Because this is called
    * by an executor service, calls will queue - i.e. there can never be
    * concurrent execution of repository index updates.
    */
   @Override
   public void run() {
      if (!isReady()) {
      if (!storedSettings.getBoolean(Keys.web.allowLuceneIndexing, true)) {
         // Lucene indexing is disabled
         return;
      }
      // reload the excluded extensions
      String exts = storedSettings.getString(Keys.web.luceneIgnoreExtensions, luceneIgnoreExtensions);
      excludedExtensions = new TreeSet<String>(StringUtils.getStringsFromValue(exts));
      for (String repositoryName: GitBlit.self().getRepositoryList()) {
         RepositoryModel model = GitBlit.self().getRepositoryModel(repositoryName);
@@ -188,7 +186,7 @@
    * @param repository
    *            the repository object
    */
   protected void index(RepositoryModel model, Repository repository) {
   private void index(RepositoryModel model, Repository repository) {
      try {
         if (shouldReindex(repository)) {
            // (re)build the entire index
@@ -349,7 +347,7 @@
    * @return tree
    * @throws IOException
    */
   protected RevTree getTree(final RevWalk walk, final RevCommit commit)
   private RevTree getTree(final RevWalk walk, final RevCommit commit)
         throws IOException {
      final RevTree tree = commit.getTree();
      if (tree != null) {
@@ -389,7 +387,7 @@
    * @param repository
    * @return true of the on-disk index format is different than INDEX_VERSION
    */
   protected boolean shouldReindex(Repository repository) {
   private boolean shouldReindex(Repository repository) {
      try {
         FileBasedConfig config = getConfig(repository);
         config.load();
@@ -450,7 +448,7 @@
         ObjectId defaultBranchId = JGitUtils.getDefaultBranch(repository);
         for (RefModel branch :  branches) {
            if (branch.getObjectId().equals(defaultBranchId)) {
               defaultBranch = branch;
               defaultBranch = branch;
               break;
            }
         }
@@ -460,8 +458,22 @@
         // walk through each branch
         for (RefModel branch : branches) {
            boolean indexBranch = false;
            if (model.indexedBranches.contains(com.gitblit.Constants.DEFAULT_BRANCH)
                  && branch.equals(defaultBranch)) {
               // indexing "default" branch
               indexBranch = true;
            } else if (IssueUtils.GB_ISSUES.equals(branch)) {
               // skip the GB_ISSUES branch because it is indexed later
               // note: this is different than updateIndex
               indexBranch = false;
            } else {
               // normal explicit branch check
               indexBranch = model.indexedBranches.contains(branch.getName());
            }
            // if this branch is not specifically indexed then skip
            if (!model.indexedBranches.contains(branch.getName())) {
            if (!indexBranch) {
               continue;
            }
@@ -544,7 +556,7 @@
                  // index the blob content
                  if (StringUtils.isEmpty(ext) || !excludedExtensions.contains(ext)) {                     
                     ObjectLoader ldr = repository.open(blobId, Constants.OBJ_BLOB);
                     InputStream in = ldr.openStream();
                     InputStream in = ldr.openStream();
                     int n;
                     while ((n = in.read(tmp)) > 0) {
                        os.write(tmp, 0, n);
@@ -636,7 +648,7 @@
         IndexWriter writer = getIndexWriter(repositoryName);
         for (PathChangeModel path : changedPaths) {
            // delete the indexed blob
            deleteBlob(repositoryName, branch, path.path);
            deleteBlob(repositoryName, branch, path.name);
            // re-index the blob
            if (!ChangeType.DELETE.equals(path.changeType)) {
@@ -669,8 +681,17 @@
            }
         }
         writer.commit();
         Document doc = createDocument(commit, null);
         // get any annotated commit tags
         List<String> commitTags = new ArrayList<String>();
         for (RefModel ref : JGitUtils.getTags(repository, false, -1)) {
            if (ref.isAnnotatedTag() && ref.getReferencedObjectId().equals(commit.getId())) {
               commitTags.add(ref.displayName);
            }
         }
         // create and write the Lucene document
         Document doc = createDocument(commit, commitTags);
         doc.add(new Field(FIELD_BRANCH, branch, Store.YES, Index.ANALYZED));
         result.commitCount++;
         result.success = index(repositoryName, doc);
@@ -748,7 +769,7 @@
    * @param repository
    * @return IndexResult
    */
   protected IndexResult updateIndex(RepositoryModel model, Repository repository) {
   private IndexResult updateIndex(RepositoryModel model, Repository repository) {
      IndexResult result = new IndexResult();
      try {
         FileBasedConfig config = getConfig(repository);
@@ -776,20 +797,55 @@
            deletedBranches.add(branch);
         }
         // walk through each branches
         // get the local branches
         List<RefModel> branches = JGitUtils.getLocalBranches(repository, true, -1);
         // sort them by most recently updated
         Collections.sort(branches, new Comparator<RefModel>() {
            @Override
            public int compare(RefModel ref1, RefModel ref2) {
               return ref2.getDate().compareTo(ref1.getDate());
            }
         });
         // reorder default branch to first position
         RefModel defaultBranch = null;
         ObjectId defaultBranchId = JGitUtils.getDefaultBranch(repository);
         for (RefModel branch :  branches) {
            if (branch.getObjectId().equals(defaultBranchId)) {
               defaultBranch = branch;
               break;
            }
         }
         branches.remove(defaultBranch);
         branches.add(0, defaultBranch);
         // walk through each branches
         for (RefModel branch : branches) {
            String branchName = branch.getName();
            // determine if we should skip this branch
            if (!IssueUtils.GB_ISSUES.equals(branch)
                  && !model.indexedBranches.contains(branch.getName())) {
            boolean indexBranch = false;
            if (model.indexedBranches.contains(com.gitblit.Constants.DEFAULT_BRANCH)
                  && branch.equals(defaultBranch)) {
               // indexing "default" branch
               indexBranch = true;
            } else if (IssueUtils.GB_ISSUES.equals(branch)) {
               // update issues modified on the GB_ISSUES branch
               // note: this is different than reindex
               indexBranch = true;
            } else {
               // normal explicit branch check
               indexBranch = model.indexedBranches.contains(branch.getName());
            }
            // if this branch is not specifically indexed then skip
            if (!indexBranch) {
               continue;
            }
            
            // remove this branch from the deletedBranches set
            deletedBranches.remove(branchName);
            // determine last commit
            String keyName = getBranchKey(branchName);
            String lastCommit = config.getString(CONF_BRANCH, null, keyName);
@@ -987,8 +1043,8 @@
    * @throws IOException
    */
   private IndexWriter getIndexWriter(String repository) throws IOException {
      IndexWriter indexWriter = writers.get(repository);
      File repositoryFolder = new File(repositoriesFolder, repository);
      IndexWriter indexWriter = writers.get(repository);
      File repositoryFolder = FileKey.resolve(new File(repositoriesFolder, repository), FS.DETECTED);
      File indexFolder = new File(repositoryFolder, LUCENE_DIR);
      Directory directory = FSDirectory.open(indexFolder);      
@@ -1119,42 +1175,82 @@
    */
   private String getHighlightedFragment(Analyzer analyzer, Query query,
         String content, SearchResult result) throws IOException, InvalidTokenOffsetsException {
      content = content == null ? "":StringUtils.escapeForHtml(content, false);
      if (content == null) {
         content = "";
      }
      int fragmentLength = SearchObjectType.commit == result.type ? 512 : 150;
      QueryScorer scorer = new QueryScorer(query, "content");
      Fragmenter fragmenter;
      // TODO improve the fragmenter - hopefully on line breaks
      if (SearchObjectType.commit == result.type) {
         fragmenter = new SimpleSpanFragmenter(scorer, 1024);
      } else {
         fragmenter = new SimpleSpanFragmenter(scorer, 150);
      }
      Fragmenter fragmenter = new SimpleSpanFragmenter(scorer, fragmentLength);
      // use an artificial delimiter for the token
      String termTag = "<!--[";
      String termTagEnd = "]-->";
      String termTag = "!!--[";
      String termTagEnd = "]--!!";
      SimpleHTMLFormatter formatter = new SimpleHTMLFormatter(termTag, termTagEnd);
      Highlighter highlighter = new Highlighter(formatter, scorer);      
      highlighter.setTextFragmenter(fragmenter);
      String [] fragments = highlighter.getBestFragments(analyzer, "content", content, 5);
      String [] fragments = highlighter.getBestFragments(analyzer, "content", content, 3);
      if (ArrayUtils.isEmpty(fragments)) {
         if (SearchObjectType.blob  == result.type) {
            return "";
         }
         return "<pre class=\"text\">" + content + "</pre>";
         // clip commit message
         String fragment = content;
         if (fragment.length() > fragmentLength) {
            fragment = fragment.substring(0, fragmentLength) + "...";
         }
         return "<pre class=\"text\">" + StringUtils.escapeForHtml(fragment, true) + "</pre>";
      }
      int contentPos = 0;
      StringBuilder sb = new StringBuilder();
      for (int i = 0, len = fragments.length; i < len; i++) {
         String fragment = fragments[i];
         String tag = "<pre class=\"text\">";
         // resurrect the raw fragment from removing the artificial delimiters
         String raw = fragment.replace(termTag, "").replace(termTagEnd, "");
         sb.append(getPreTag(result, raw, content));
         String raw = fragment.replace(termTag, "").replace(termTagEnd, "");
         // determine position of the raw fragment in the content
         int pos = content.indexOf(raw, contentPos);
         // restore complete first line of fragment
         int c = pos;
         while (c > 0) {
            c--;
            if (content.charAt(c) == '\n') {
               break;
            }
         }
         if (c > 0) {
            // inject leading chunk of first fragment line
            fragment = content.substring(c + 1, pos) + fragment;
         }
         if (SearchObjectType.blob  == result.type) {
            // count lines as offset into the content for this fragment
            int line = Math.max(1, StringUtils.countLines(content.substring(0, pos)));
            // create fragment tag with line number and language
            String lang = "";
            String ext = StringUtils.getFileExtension(result.path).toLowerCase();
            if (!StringUtils.isEmpty(ext)) {
               // maintain leading space!
               lang = " lang-" + ext;
            }
            tag = MessageFormat.format("<pre class=\"prettyprint linenums:{0,number,0}{1}\">", line, lang);
            // update offset into content
            contentPos = pos + raw.length() + 1;
         }
         
         sb.append(tag);
         // replace the artificial delimiter with html tags
         String html = fragment.replace(termTag, "<span class=\"highlight\">").replace(termTagEnd, "</span>");
         String html = StringUtils.escapeForHtml(fragment, false);
         html = html.replace(termTag, "<span class=\"highlight\">").replace(termTagEnd, "</span>");
         sb.append(html);
         sb.append("</pre>");
         if (i < len - 1) {
@@ -1162,31 +1258,7 @@
         }
      }
      return sb.toString();
   }
   /**
    * Returns the appropriate tag for a fragment. Commit messages are visually
    * differentiated from blob fragments.
    *
    * @param result
    * @param fragment
    * @param content
    * @return an html tag appropriate for the fragment
    */
   private String getPreTag(SearchResult result, String fragment, String content) {
      String pre = "<pre class=\"text\">";
      if (SearchObjectType.blob  == result.type) {
         int line = StringUtils.countLines(content.substring(0, content.indexOf(fragment)));
         int lastDot = result.path.lastIndexOf('.');
         if (lastDot > -1) {
            String ext = result.path.substring(lastDot + 1).toLowerCase();
            pre = MessageFormat.format("<pre class=\"prettyprint linenums:{0,number,0} lang-{1}\">", line, ext);
         } else {
            pre = MessageFormat.format("<pre class=\"prettyprint linenums:{0,number,0}\">", line);
         }
      }
      return pre;
   }
   }
   
   /**
    * Simple class to track the results of an index update.