blob: 3f1feb4fe792ac4436f300d3074007635e09e736 [file] [log] [blame]
// Copyright (C) 2013 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.account;
import static com.google.gerrit.server.account.GetPreferences.KEY_ID;
import static com.google.gerrit.server.account.GetPreferences.KEY_MATCH;
import static com.google.gerrit.server.account.GetPreferences.KEY_TARGET;
import static com.google.gerrit.server.account.GetPreferences.KEY_TOKEN;
import static com.google.gerrit.server.account.GetPreferences.KEY_URL;
import static com.google.gerrit.server.account.GetPreferences.URL_ALIAS;
import static com.google.gerrit.server.account.GetPreferences.initFromDb;
import static com.google.gerrit.server.account.GetPreferences.readFromGit;
import static com.google.gerrit.server.config.ConfigUtil.storeSection;
import com.google.common.base.Strings;
import com.google.gerrit.extensions.client.GeneralPreferencesInfo;
import com.google.gerrit.extensions.client.MenuItem;
import com.google.gerrit.extensions.config.DownloadScheme;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.RestModifyView;
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DateFormat;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DiffView;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.EmailStrategy;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.ReviewCategoryStrategy;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.TimeFormat;
import com.google.gerrit.reviewdb.server.ReviewDb;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.config.AllUsersName;
import com.google.gerrit.server.config.GerritServerConfig;
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.gerrit.server.git.MetaDataUpdate;
import com.google.gerrit.server.git.UserConfigSections;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.errors.RepositoryNotFoundException;
import org.eclipse.jgit.lib.Config;
import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
@Singleton
public class SetPreferences implements
RestModifyView<AccountResource, GeneralPreferencesInfo> {
private final Provider<CurrentUser> self;
private final AccountCache cache;
private final GitRepositoryManager gitMgr;
private final Provider<ReviewDb> db;
private final Provider<MetaDataUpdate.User> metaDataUpdateFactory;
private final AllUsersName allUsersName;
private final DynamicMap<DownloadScheme> downloadSchemes;
private final boolean readFromGit;
@Inject
SetPreferences(Provider<CurrentUser> self,
AccountCache cache,
@GerritServerConfig Config cfg,
GitRepositoryManager gitMgr,
Provider<ReviewDb> db,
Provider<MetaDataUpdate.User> metaDataUpdateFactory,
AllUsersName allUsersName,
DynamicMap<DownloadScheme> downloadSchemes) {
this.self = self;
this.cache = cache;
this.gitMgr = gitMgr;
this.db = db;
this.metaDataUpdateFactory = metaDataUpdateFactory;
this.allUsersName = allUsersName;
this.downloadSchemes = downloadSchemes;
readFromGit = cfg.getBoolean("user", null, "readPrefsFromGit", false);
}
@Override
public GeneralPreferencesInfo apply(AccountResource rsrc,
GeneralPreferencesInfo i)
throws AuthException, ResourceNotFoundException, BadRequestException,
OrmException, IOException, ConfigInvalidException {
if (self.get() != rsrc.getUser()
&& !self.get().getCapabilities().canModifyAccount()) {
throw new AuthException("requires Modify Account capability");
}
checkDownloadScheme(i.downloadScheme);
Account.Id id = rsrc.getUser().getAccountId();
GeneralPreferencesInfo n = readFromGit
? readFromGit(id, gitMgr, allUsersName, i)
: merge(initFromDb(
db.get().accounts().get(id).getGeneralPreferences()), i);
n.my = i.my;
n.urlAliases = i.urlAliases;
writeToGit(id, n);
writeToDb(id, n);
cache.evict(id);
return GetPreferences.readFromGit(id, gitMgr, allUsersName, null);
}
private void writeToGit(Account.Id id, GeneralPreferencesInfo i)
throws RepositoryNotFoundException, IOException, ConfigInvalidException {
VersionedAccountPreferences prefs;
try (MetaDataUpdate md = metaDataUpdateFactory.get().create(allUsersName)) {
prefs = VersionedAccountPreferences.forUser(id);
prefs.load(md);
storeSection(prefs.getConfig(), UserConfigSections.GENERAL, null, i,
GeneralPreferencesInfo.defaults());
storeMyMenus(prefs, i.my);
storeUrlAliases(prefs, i.urlAliases);
prefs.commit(md);
}
}
private void writeToDb(Account.Id id, GeneralPreferencesInfo i)
throws RepositoryNotFoundException, IOException, OrmException,
ConfigInvalidException {
MetaDataUpdate md = metaDataUpdateFactory.get().create(allUsersName);
db.get().accounts().beginTransaction(id);
try {
Account a = db.get().accounts().get(id);
VersionedAccountPreferences versionedPrefs =
VersionedAccountPreferences.forUser(id);
versionedPrefs.load(md);
AccountGeneralPreferences p = a.getGeneralPreferences();
if (p == null) {
p = new AccountGeneralPreferences();
a.setGeneralPreferences(p);
}
initAccountGeneralPreferences(p, i);
db.get().accounts().update(Collections.singleton(a));
db.get().commit();
storeMyMenus(versionedPrefs, i.my);
storeUrlAliases(versionedPrefs, i.urlAliases);
versionedPrefs.commit(md);
} finally {
db.get().rollback();
}
}
public static void storeMyMenus(VersionedAccountPreferences prefs,
List<MenuItem> my) {
Config cfg = prefs.getConfig();
if (my != null) {
unsetSection(cfg, UserConfigSections.MY);
for (MenuItem item : my) {
set(cfg, item.name, KEY_URL, item.url);
set(cfg, item.name, KEY_TARGET, item.target);
set(cfg, item.name, KEY_ID, item.id);
}
}
}
private static void set(Config cfg, String section, String key, String val) {
if (Strings.isNullOrEmpty(val)) {
cfg.unset(UserConfigSections.MY, section, key);
} else {
cfg.setString(UserConfigSections.MY, section, key, val);
}
}
private static void unsetSection(Config cfg, String section) {
cfg.unsetSection(section, null);
for (String subsection: cfg.getSubsections(section)) {
cfg.unsetSection(section, subsection);
}
}
public static void storeUrlAliases(VersionedAccountPreferences prefs,
Map<String, String> urlAliases) {
if (urlAliases != null) {
Config cfg = prefs.getConfig();
for (String subsection : cfg.getSubsections(URL_ALIAS)) {
cfg.unsetSection(URL_ALIAS, subsection);
}
int i = 1;
for (Entry<String, String> e : urlAliases.entrySet()) {
cfg.setString(URL_ALIAS, URL_ALIAS + i, KEY_MATCH, e.getKey());
cfg.setString(URL_ALIAS, URL_ALIAS + i, KEY_TOKEN, e.getValue());
i++;
}
}
}
private void checkDownloadScheme(String downloadScheme)
throws BadRequestException {
if (Strings.isNullOrEmpty(downloadScheme)) {
return;
}
for (DynamicMap.Entry<DownloadScheme> e : downloadSchemes) {
if (e.getExportName().equals(downloadScheme)
&& e.getProvider().get().isEnabled()) {
return;
}
}
throw new BadRequestException(
"Unsupported download scheme: " + downloadScheme);
}
private GeneralPreferencesInfo merge(GeneralPreferencesInfo p,
GeneralPreferencesInfo i) {
if (i.changesPerPage != null) {
p.changesPerPage = i.changesPerPage;
}
if (i.showSiteHeader != null) {
p.showSiteHeader = i.showSiteHeader;
}
if (i.useFlashClipboard != null) {
p.useFlashClipboard = i.useFlashClipboard;
}
if (i.downloadScheme != null) {
p.downloadScheme = i.downloadScheme;
}
if (i.downloadCommand != null) {
p.downloadCommand = i.downloadCommand;
}
if (i.dateFormat != null) {
p.dateFormat = i.dateFormat;
}
if (i.timeFormat != null) {
p.timeFormat = i.timeFormat;
}
if (i.relativeDateInChangeTable != null) {
p.relativeDateInChangeTable = i.relativeDateInChangeTable;
}
if (i.sizeBarInChangeTable != null) {
p.sizeBarInChangeTable = i.sizeBarInChangeTable;
}
if (i.legacycidInChangeTable != null) {
p.legacycidInChangeTable = i.legacycidInChangeTable;
}
if (i.muteCommonPathPrefixes != null) {
p.muteCommonPathPrefixes = i.muteCommonPathPrefixes;
}
if (i.reviewCategoryStrategy != null) {
p.reviewCategoryStrategy = i.reviewCategoryStrategy;
}
if (i.diffView != null) {
p.diffView = i.diffView;
}
if (i.emailStrategy != null) {
p.emailStrategy = i.emailStrategy;
}
return p;
}
private static void initAccountGeneralPreferences(
AccountGeneralPreferences a, GeneralPreferencesInfo i) {
if (a == null) {
a = AccountGeneralPreferences.createDefault();
}
a.setMaximumPageSize((short)(int)i.changesPerPage);
a.setShowSiteHeader(b(i.showSiteHeader));
a.setUseFlashClipboard(b(i.useFlashClipboard));
a.setDownloadUrl(i.downloadScheme);
if (i.downloadCommand != null) {
a.setDownloadCommand(DownloadCommand.valueOf(i.downloadCommand.name()));
}
a.setEmailStrategy(EmailStrategy.valueOf(i.getEmailStrategy().name()));
a.setDateFormat(DateFormat.valueOf(i.getDateFormat().name()));
a.setTimeFormat(TimeFormat.valueOf(i.getTimeFormat().name()));
a.setRelativeDateInChangeTable(b(i.relativeDateInChangeTable));
a.setSizeBarInChangeTable(b(i.sizeBarInChangeTable));
a.setLegacycidInChangeTable(b(i.legacycidInChangeTable));
a.setMuteCommonPathPrefixes(b(i.muteCommonPathPrefixes));
a.setReviewCategoryStrategy(ReviewCategoryStrategy.valueOf(
i.getReviewCategoryStrategy().name()));
a.setDiffView(DiffView.valueOf(i.getDiffView().name()));
}
private static boolean b(Boolean b) {
return b == null ? false : b;
}
}