convert Project List to HashMap

Author: vladak

src/org/opensolaris/opengrok/configuration/Configuration.java

@@ -116,7 +116,7 @@ public final class Configuration {
      */
     private boolean authorizationWatchdogEnabled;
     private AuthorizationStack pluginStack;
-    private List<Project> projects;
+    private Map<String,Project> projects; // project name -> Project
     private Set<Group> groups;
     private String sourceRoot;
     private String dataRoot;
@@ -125,8 +125,8 @@ public final class Configuration {
     private boolean generateHtml;
     /**
      * Default projects will be used, when no project is selected and no project
-     * is in cookie, so basically only the first time you open the first page,
-     * or when you clear your web cookies
+     * is in cookie, so basically only the first time a page is opened,
+     * or when web cookies are cleared.
      */
     private Set<Project> defaultProjects;
     /**
@@ -374,7 +374,7 @@ public Configuration() {
         setPluginDirectory(null);
         setPluginStack(new AuthorizationStack(AuthControlFlag.REQUIRED, "default stack"));
         setPrintProgress(false);
-        setProjects(new ArrayList<>());
+        setProjects(new HashMap<>());
         setQuickContextScan(true);
         //below can cause an outofmemory error, since it is defaulting to NO LIMIT
         setRamBufferSize(defaultRamBufferSize); //MB
@@ -572,11 +572,11 @@ public void setHandleHistoryOfRenamedFiles(boolean enable) {
         this.handleHistoryOfRenamedFiles = enable;
     }
 
-    public List<Project> getProjects() {
+    public Map<String,Project> getProjects() {
         return projects;
     }
 
-    public void setProjects(List<Project> projects) {
+    public void setProjects(Map<String,Project> projects) {
         this.projects = projects;
     }
 

src/org/opensolaris/opengrok/configuration/Groups.java

@@ -254,11 +254,10 @@ public boolean call(Group g) {
      *
      * @param out stream to write the results
      * @param groups set of groups
-     * @param match project description
+     * @param match project name
      */
     private static void matchGroups(PrintStream out, Set<Group> groups, String match) {
-        Project p = new Project();
-        p.setName(match);
+        Project p = new Project(match);
 
         List<Group> matched = new ArrayList<>();
         linearTraverseGroups(groups, new Walker() {

src/org/opensolaris/opengrok/configuration/Project.java

@@ -53,6 +53,19 @@ public class Project implements Comparable<Project>, Nameable {
      */
     private Set<Group> groups = new TreeSet<>();
 
+    // This empty constructor is needed for serialization.
+    public Project () {
+    }
+
+    public Project (String name) {
+        this.name = name;
+    }
+
+    public Project (String name, String path) {
+        this.name = name;
+        this.path = path;
+    }
+
     /**
      * Get a textual name of this project
      *
@@ -95,6 +108,9 @@ public int getTabSize() {
      * Set a textual name of this project, prefferably don't use " , " in the
      * name, since it's used as delimiter for more projects
      *
+     * XXX we should not allow setting project name after it has been constructed
+     * because it is probably part of HashMap.
+     *
      * @param name a textual name of the project
      */
     @Override
@@ -171,7 +187,7 @@ public static Project getProject(String path) {
         final RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         if (env.hasProjects()) {
             final String lpath = path.replace(File.separatorChar, '/');
-            for (Project p : env.getProjects()) {
+            for (Project p : env.getProjectList()) {
                 String pp = p.getPath();
                 // Check if the project's path is a prefix of the given
                 // path. It has to be an exact match, or the project's path
@@ -217,10 +233,9 @@ public static Project getProject(File file) {
     public static Project getByName(String name) {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         if (env.hasProjects()) {
-            for (Project proj : env.getProjects()) {
-                if (name.equals(proj.getName())) {
+            Project proj;
+            if ((proj = env.getProjects().get(name)) != null) {
                     return (proj);
-                }
             }
         }
         return null;

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

@@ -395,21 +395,29 @@ public String getPathRelativeToSourceRoot(File file, int stripCount) throws IOEx
     }
 
     /**
-     * Do we have projects?
+     * Do we have any projects ?
      *
      * @return true if we have projects
      */
     public boolean hasProjects() {
-        List<Project> proj = getProjects();
-        return (proj != null && !proj.isEmpty());
+        return (getProjects().size() > 0);
     }
 
     /**
-     * Get all of the projects
+     * Get list of projects.
      *
-     * @return a list containing all of the projects (may be null)
+     * @return a list containing all of the projects
      */
-    public List<Project> getProjects() {
+    public List<Project> getProjectList() {
+        return new ArrayList<Project>(threadConfig.get().getProjects().values());
+    }
+
+    /**
+     * Get project map.
+     *
+     * @return a Map with all of the projects
+     */
+    public Map<String,Project> getProjects() {
         return threadConfig.get().getProjects();
     }
 
@@ -419,17 +427,19 @@ public List<Project> getProjects() {
      * @return a list containing descriptions of all projects.
      */
     public List<String> getProjectDescriptions() {
-        return threadConfig.get().getProjects().stream().
+        return getProjectList().stream().
             map(Project::getName).collect(Collectors.toList());
     }
 
     /**
      * Set the list of the projects
      *
-     * @param projects the list of projects to use
+     * @param projects the map of projects to use
      */
-    public void setProjects(List<Project> projects) {
-        populateGroups(getGroups(), projects);
+    public void setProjects(Map<String,Project> projects) {
+        if (projects != null) {
+            populateGroups(getGroups(), new TreeSet<Project>(projects.values()));
+        }
         threadConfig.get().setProjects(projects);
     }
 
@@ -457,7 +467,7 @@ public Set<Group> getGroups() {
      * @param groups the set of groups to use
      */
     public void setGroups(Set<Group> groups) {
-        populateGroups(groups, getProjects());
+        populateGroups(groups, new TreeSet<Project>(getProjects().values()));
         threadConfig.get().setGroups(groups);
     }
 
@@ -1213,7 +1223,7 @@ private void generateProjectRepositoriesMap() throws IOException {
     /**
      * Classifies projects and puts them in their groups.
      */
-    private void populateGroups(Set<Group> groups, List<Project> projects) {
+    private void populateGroups(Set<Group> groups, Set<Project> projects) {
         if (projects == null || groups == null) {
             return;
         }
@@ -1259,7 +1269,7 @@ public void setConfiguration(Configuration configuration, List<String> subFileLi
         } catch (IOException ex) {
             LOGGER.log(Level.SEVERE, "Cannot generate project - repository map", ex);
         }
-        populateGroups(getGroups(), getProjects());
+        populateGroups(getGroups(), new TreeSet<Project>(getProjects().values()));
         if (subFileList != null) {
             HistoryGuru.getInstance().invalidateRepositories(
                 configuration.getRepositories(), subFileList);

src/org/opensolaris/opengrok/index/IndexDatabase.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opensolaris.opengrok.index;
 
@@ -164,7 +164,7 @@ static void updateAll(ExecutorService executor, IndexChangedListener listener) t
         List<IndexDatabase> dbs = new ArrayList<>();
 
         if (env.hasProjects()) {
-            for (Project project : env.getProjects()) {
+            for (Project project : env.getProjectList()) {
                 dbs.add(new IndexDatabase(project));
             }
         } else {
@@ -465,7 +465,7 @@ static void optimizeAll(ExecutorService executor) throws IOException {
         List<IndexDatabase> dbs = new ArrayList<>();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         if (env.hasProjects()) {
-            for (Project project : env.getProjects()) {
+            for (Project project : env.getProjectList()) {
                 dbs.add(new IndexDatabase(project));
             }
         } else {
@@ -949,7 +949,7 @@ public static void listAllFiles(List<String> subFiles) throws IOException {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         if (env.hasProjects()) {
             if (subFiles == null || subFiles.isEmpty()) {
-                for (Project project : env.getProjects()) {
+                for (Project project : env.getProjectList()) {
                     IndexDatabase db = new IndexDatabase(project);
                     db.listFiles();
                 }
@@ -1015,9 +1015,9 @@ static void listFrequentTokens(List<String> subFiles) throws IOException {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         if (env.hasProjects()) {
             if (subFiles == null || subFiles.isEmpty()) {
-                for (Project project : env.getProjects()) {
+                for (Project project : env.getProjectList()) {
                     IndexDatabase db = new IndexDatabase(project);
-                    db.listTokens(4);
+                    db.listTokens(limit);
                 }
             } else {
                 for (String path : subFiles) {
@@ -1026,7 +1026,7 @@ static void listFrequentTokens(List<String> subFiles) throws IOException {
                         LOGGER.log(Level.WARNING, "Could not find a project for \"{0}\"", path);
                     } else {
                         IndexDatabase db = new IndexDatabase(project);
-                        db.listTokens(4);
+                        db.listTokens(limit);
                     }
                 }
             }

src/org/opensolaris/opengrok/index/Indexer.java

@@ -696,13 +696,13 @@ public void prepareIndexer(RuntimeEnvironment env,
 
         if (addProjects) {
             File files[] = env.getSourceRootFile().listFiles();
-            List<Project> projects = env.getProjects();
+            Map<String,Project> projects = env.getProjects();
 
             // Keep a copy of the old project list so that we can preserve
             // the customization of existing projects.
             Map<String, Project> oldProjects = new HashMap<>();
-            for (Project p : projects) {
-                oldProjects.put(p.getPath(), p);
+            for (Project p : projects.values()) {
+                oldProjects.put(p.getName(), p);
             }
 
             projects.clear();
@@ -711,48 +711,29 @@ public void prepareIndexer(RuntimeEnvironment env,
             for (File file : files) {
                 String name = file.getName();
                 String path = "/" + name;
-                if (oldProjects.containsKey(path)) {
+                if (oldProjects.containsKey(name)) {
                     // This is an existing object. Reuse the old project,
                     // possibly with customizations, instead of creating a
                     // new with default values.
-                    projects.add(oldProjects.get(path));
+                    projects.put(name, oldProjects.get(name));
                 } else if (!name.startsWith(".") && file.isDirectory()) {
                     // Found a new directory with no matching project, so
                     // create a new project with default properties.
-                    Project p = new Project();
-                    p.setName(name);
-                    p.setPath(path);
+                    Project p = new Project(name, path);
                     p.setTabSize(env.getConfiguration().getTabSize());
-                    projects.add(p);
+                    projects.put(p.getName(), p);
                 }
             }
-
-            // The projects should be sorted...
-            Collections.sort(projects, new Comparator<Project>() {
-                @Override
-                public int compare(Project p1, Project p2) {
-                    String s1 = p1.getName();
-                    String s2 = p2.getName();
-
-                    int ret;
-                    if (s1 == null) {
-                        ret = (s2 == null) ? 0 : 1;
-                    } else {
-                        ret = s1.compareTo(s2);
-                    }
-                    return ret;
-                }
-            });
         }
 
         if (defaultProjects != null && !defaultProjects.isEmpty()) {
             Set<Project> projects = new TreeSet<>();
             for (String projectPath : defaultProjects) {
                 if (projectPath.equals("__all__")) {
-                    projects.addAll(env.getProjects());
+                    projects.addAll(env.getProjects().values());
                     break;
                 }
-                for (Project p : env.getProjects()) {
+                for (Project p : env.getProjectList()) {
                     if (p.getPath().equals(projectPath)) {
                         projects.add(p);
                         break;

src/org/opensolaris/opengrok/search/SearchEngine.java

@@ -214,6 +214,7 @@ private void searchMultiDatabase(List<Project> root, boolean paging) throws IOEx
         for (Project p : root) {
             projects.add(p.getName());
         }
+
         // We use MultiReader even for single project. This should
         // not matter given that MultiReader is just a cheap wrapper
         // around set of IndexReader objects.
@@ -261,7 +262,7 @@ public int search(HttpServletRequest req, String... projectNames) {
         List<Project> filteredProjects = new ArrayList<Project>();
         for(Project project: projects) {
             for (String name : projectNames) {
-                if(project.getName().equalsIgnoreCase(name)) {
+                if (project.getName().equalsIgnoreCase(name)) {
                     filteredProjects.add(project);
                 }
             }
@@ -310,7 +311,7 @@ public int search(HttpServletRequest req) {
     public int search() {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         return search(
-                env.hasProjects() ? env.getProjects() : new ArrayList<Project>(),
+                env.hasProjects() ? env.getProjectList() : new ArrayList<Project>(),
                 new File(env.getDataRootFile(), IndexDatabase.INDEX_DIR));
     }