Add All-Users project to store meta data for all users

This change adds a migration that creates an All-Users project for
storing meta data for all users. With this change no data is stored in
this repository yet, but future changes will e.g. store user
preferences in this repository by creating a ref per user.

Change-Id: Ib1ba5e4c2fb7a2f8e49d3bcf994c99d9e911475c
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>

Documentation/config-gerrit.txt

@@ -1338,6 +1338,13 @@ relative to `gerrit.basePath`.
 +
 Defaults to `All-Projects` if not set.
 
+[[gerrit.allUsers]]gerrit.allUsers::
++
+Name of the project in which meta data of all users is stored.
+The name is relative to `gerrit.basePath`.
++
+Defaults to `All-Users` if not set.
+
 [[gerrit.canonicalWebUrl]]gerrit.canonicalWebUrl::
 +
 The default URL for Gerrit to be accessed through.

gerrit-pgm/src/main/java/com/google/gerrit/pgm/init/AllUsersNameOnInitProvider.java

@@ -0,0 +1,36 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.gerrit.pgm.init;
+
+import com.google.common.base.Objects;
+import com.google.common.base.Strings;
+import com.google.gerrit.server.config.AllUsersNameProvider;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+
+public class AllUsersNameOnInitProvider implements Provider<String> {
+  private final String name;
+
+  @Inject
+  AllUsersNameOnInitProvider(Section.Factory sections) {
+    String n = sections.get("gerrit", null).get("allUsers");
+    name = Objects.firstNonNull(
+        Strings.emptyToNull(n), AllUsersNameProvider.DEFAULT);
+  }
+
+  public String get() {
+    return name;
+  }
+}

gerrit-server/src/main/java/com/google/gerrit/server/config/AllUsersName.java

@@ -0,0 +1,25 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.gerrit.server.config;
+
+import com.google.gerrit.reviewdb.client.Project;
+
+/** Special name of the project in which meta data for all users is stored. */
+@SuppressWarnings("serial")
+public class AllUsersName extends Project.NameKey {
+  public AllUsersName(String name) {
+    super(name);
+  }
+}

gerrit-server/src/main/java/com/google/gerrit/server/config/AllUsersNameProvider.java

@@ -0,0 +1,39 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.gerrit.server.config;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+
+import org.eclipse.jgit.lib.Config;
+
+public class AllUsersNameProvider implements Provider<AllUsersName> {
+  public static final String DEFAULT = "All-Users";
+
+  private final AllUsersName name;
+
+  @Inject
+  AllUsersNameProvider(@GerritServerConfig Config cfg) {
+    String n = cfg.getString("gerrit", null, "allUsers");
+    if (n == null || n.isEmpty()) {
+      n = DEFAULT;
+    }
+    name = new AllUsersName(n);
+  }
+
+  public AllUsersName get() {
+    return name;
+  }
+}

gerrit-server/src/main/java/com/google/gerrit/server/project/ProjectCache.java

@@ -25,6 +25,9 @@ public interface ProjectCache {
   /** @return the parent state for all projects on this server. */
   public ProjectState getAllProjects();
 
+  /** @return the project state of the project storing meta data for all users. */
+  public ProjectState getAllUsers();
+
   /**
    * Get the cached data for a project by its unique name.
    *

gerrit-server/src/main/java/com/google/gerrit/server/project/ProjectCacheImpl.java

@@ -22,6 +22,7 @@ import com.google.gerrit.reviewdb.client.AccountGroup;
 import com.google.gerrit.reviewdb.client.Project;
 import com.google.gerrit.server.cache.CacheModule;
 import com.google.gerrit.server.config.AllProjectsName;
+import com.google.gerrit.server.config.AllUsersName;
 import com.google.gerrit.server.git.GitRepositoryManager;
 import com.google.gerrit.server.git.ProjectConfig;
 import com.google.inject.Inject;
@@ -74,6 +75,7 @@ public class ProjectCacheImpl implements ProjectCache {
   }
 
   private final AllProjectsName allProjectsName;
+  private final AllUsersName allUsersName;
   private final LoadingCache<String, ProjectState> byName;
   private final LoadingCache<ListKey, SortedSet<Project.NameKey>> list;
   private final Lock listLock;
@@ -82,10 +84,12 @@ public class ProjectCacheImpl implements ProjectCache {
   @Inject
   ProjectCacheImpl(
       final AllProjectsName allProjectsName,
+      final AllUsersName allUsersName,
       @Named(CACHE_NAME) LoadingCache<String, ProjectState> byName,
       @Named(CACHE_LIST) LoadingCache<ListKey, SortedSet<Project.NameKey>> list,
       ProjectCacheClock clock) {
     this.allProjectsName = allProjectsName;
+    this.allUsersName = allUsersName;
     this.byName = byName;
     this.list = list;
     this.listLock = new ReentrantLock(true /* fair */);
@@ -103,6 +107,16 @@ public class ProjectCacheImpl implements ProjectCache {
     return state;
   }
 
+  @Override
+  public ProjectState getAllUsers() {
+    ProjectState state = get(allUsersName);
+    if (state == null) {
+      // This should never occur.
+      throw new IllegalStateException("Missing project " + allUsersName);
+    }
+    return state;
+  }
+
   @Override
   public ProjectState get(final Project.NameKey projectName) {
      try {

gerrit-server/src/main/java/com/google/gerrit/server/schema/AllUsersCreator.java

@@ -0,0 +1,55 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.gerrit.server.schema;
+
+import com.google.gerrit.server.config.AllUsersName;
+import com.google.gerrit.server.git.GitRepositoryManager;
+import com.google.inject.Inject;
+
+import org.eclipse.jgit.errors.ConfigInvalidException;
+import org.eclipse.jgit.errors.RepositoryNotFoundException;
+import org.eclipse.jgit.lib.Repository;
+
+import java.io.IOException;
+
+/** Creates the {@code All-Users} repository. */
+public class AllUsersCreator {
+  private final GitRepositoryManager mgr;
+  private final AllUsersName allUsersName;
+
+  @Inject
+  AllUsersCreator(GitRepositoryManager mgr, AllUsersName allUsersName) {
+    this.mgr = mgr;
+    this.allUsersName = allUsersName;
+  }
+
+  public void create() throws IOException, ConfigInvalidException {
+    Repository git = null;
+    try {
+      git = mgr.openRepository(allUsersName);
+    } catch (RepositoryNotFoundException notFound) {
+      try {
+        git = mgr.createRepository(allUsersName);
+      } catch (RepositoryNotFoundException err) {
+        String name = allUsersName.get();
+        throw new IOException("Cannot create repository " + name, err);
+      }
+    } finally {
+      if (git != null) {
+        git.close();
+      }
+    }
+  }
+}

gerrit-server/src/main/java/com/google/gerrit/server/schema/SchemaCreator.java

@@ -42,6 +42,7 @@ public class SchemaCreator {
   File site_path;
 
   private final AllProjectsCreator allProjectsCreator;
+  private final AllUsersCreator allUsersCreator;
   private final PersonIdent serverUser;
   private final DataSourceType dataSourceType;
 
@@ -54,18 +55,21 @@ public class SchemaCreator {
   public SchemaCreator(SitePaths site,
       @Current SchemaVersion version,
       AllProjectsCreator ap,
+      AllUsersCreator auc,
       @GerritPersonIdent PersonIdent au,
       DataSourceType dst) {
-    this(site.site_path, version, ap, au, dst);
+    this(site.site_path, version, ap, auc, au, dst);
   }
 
   public SchemaCreator(@SitePath File site,
       @Current SchemaVersion version,
       AllProjectsCreator ap,
+      AllUsersCreator auc,
       @GerritPersonIdent PersonIdent au,
       DataSourceType dst) {
     site_path = site;
     allProjectsCreator = ap;
+    allUsersCreator = auc;
     serverUser = au;
     dataSourceType = dst;
     versionNbr = version.getVersionNbr();
@@ -90,6 +94,7 @@ public class SchemaCreator {
       .setAdministrators(GroupReference.forGroup(admin))
       .setBatchUsers(GroupReference.forGroup(batch))
       .create();
+    allUsersCreator.create();
     dataSourceType.getIndexScript().run(db);
   }
 

gerrit-server/src/main/java/com/google/gerrit/server/schema/SchemaModule.java

@@ -20,6 +20,8 @@ import com.google.gerrit.server.GerritPersonIdent;
 import com.google.gerrit.server.GerritPersonIdentProvider;
 import com.google.gerrit.server.config.AllProjectsName;
 import com.google.gerrit.server.config.AllProjectsNameProvider;
+import com.google.gerrit.server.config.AllUsersName;
+import com.google.gerrit.server.config.AllUsersNameProvider;
 import com.google.gerrit.server.config.AnonymousCowardName;
 import com.google.gerrit.server.config.AnonymousCowardNameProvider;
 import com.google.gerrit.server.config.FactoryModule;
@@ -39,6 +41,10 @@ public class SchemaModule extends FactoryModule {
       .toProvider(AllProjectsNameProvider.class)
       .in(SINGLETON);
 
+    bind(AllUsersName.class)
+      .toProvider(AllUsersNameProvider.class)
+      .in(SINGLETON);
+
     bind(String.class).annotatedWith(AnonymousCowardName.class).toProvider(
         AnonymousCowardNameProvider.class);
   }

gerrit-server/src/main/java/com/google/gerrit/server/schema/SchemaVersion.java

@@ -32,7 +32,7 @@ import java.util.List;
 /** A version of the database schema. */
 public abstract class SchemaVersion {
   /** The current schema version. */
-  public static final Class<Schema_94> C = Schema_94.class;
+  public static final Class<Schema_95> C = Schema_95.class;
 
   public static class Module extends AbstractModule {
     @Override

gerrit-server/src/main/java/com/google/gerrit/server/schema/Schema_95.java

@@ -0,0 +1,45 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.gerrit.server.schema;
+
+import com.google.gerrit.reviewdb.server.ReviewDb;
+import com.google.gwtorm.server.OrmException;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+
+import org.eclipse.jgit.errors.ConfigInvalidException;
+
+import java.io.IOException;
+import java.sql.SQLException;
+
+public class Schema_95 extends SchemaVersion {
+  private final AllUsersCreator allUsersCreator;
+
+  @Inject
+  Schema_95(Provider<Schema_94> prior, AllUsersCreator allUsersCreator) {
+    super(prior);
+    this.allUsersCreator = allUsersCreator;
+  }
+
+  @Override
+  protected void migrateData(ReviewDb db, UpdateUI ui) throws OrmException,
+      SQLException {
+    try {
+      allUsersCreator.create();
+    } catch (IOException | ConfigInvalidException e) {
+      throw new OrmException(e);
+    }
+  }
+}

gerrit-server/src/test/java/com/google/gerrit/server/project/Util.java

@@ -155,6 +155,11 @@ public class Util {
         return get(allProjectsName);
       }
 
+      @Override
+      public ProjectState getAllUsers() {
+        return null;
+      }
+
       @Override
       public ProjectState get(Project.NameKey projectName) {
         return all.get(projectName);

gerrit-server/src/test/java/com/google/gerrit/testutil/InMemoryModule.java

@@ -29,6 +29,8 @@ import com.google.gerrit.server.cache.h2.DefaultCacheFactory;
 import com.google.gerrit.server.change.MergeabilityChecksExecutorModule;
 import com.google.gerrit.server.config.AllProjectsName;
 import com.google.gerrit.server.config.AllProjectsNameProvider;
+import com.google.gerrit.server.config.AllUsersName;
+import com.google.gerrit.server.config.AllUsersNameProvider;
 import com.google.gerrit.server.config.AnonymousCowardName;
 import com.google.gerrit.server.config.AnonymousCowardNameProvider;
 import com.google.gerrit.server.config.CanonicalWebUrlModule;
@@ -132,6 +134,8 @@ public class InMemoryModule extends FactoryModule {
       .toProvider(AnonymousCowardNameProvider.class);
     bind(AllProjectsName.class)
         .toProvider(AllProjectsNameProvider.class);
+    bind(AllUsersName.class)
+        .toProvider(AllUsersNameProvider.class);
     bind(GitRepositoryManager.class)
         .to(InMemoryRepositoryManager.class);
     bind(InMemoryRepositoryManager.class).in(SINGLETON);