opendev/gerrit
Code Issues Proposed changes

/accounts/self/preferences REST API

Browse Source 
Allow clients to manage account preferences using a REST API style
invocation.  Some of these preferences are likely to be renamed or
disappear in the near future so the API is not documented.

Change-Id: I70d0981e84555ac3fa977b86b56bdb9e5289d01e
This commit is contained in:
Shawn Pearce
2013-08-22 17:41:54 -07:00
parent 973f38bc4a
commit 23e23c4464
3 changed files with 222 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
gerrit-server/src/main/java/com/google/gerrit/server/account/GetPreferences.java Normal file
View File

@@ -0,0 +1,81 @@
// 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 com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.CommentVisibilityStrategy;
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.DownloadScheme;
import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.TimeFormat;
import com.google.gerrit.server.CurrentUser;
import com.google.inject.Inject;
import com.google.inject.Provider;
public class GetPreferences implements RestReadView<AccountResource> {
private final Provider<CurrentUser> self;
@Inject
GetPreferences(Provider<CurrentUser> self) {
this.self = self;
}
@Override
public PreferenceInfo apply(AccountResource rsrc) throws AuthException {
if (self.get() != rsrc.getUser()
&& !self.get().getCapabilities().canAdministrateServer()) {
throw new AuthException("restricted to administrator");
}
return new PreferenceInfo(rsrc.getUser().getAccount()
.getGeneralPreferences());
}
static class PreferenceInfo {
final String kind = "gerritcodereview#preferences";
short changesPerPage;
Boolean showSiteHeader;
Boolean useFlashClipboard;
DownloadScheme downloadScheme;
DownloadCommand downloadCommand;
Boolean copySelfOnEmail;
DateFormat dateFormat;
TimeFormat timeFormat;
Boolean reversePatchSetOrder;
Boolean showUsernameInReviewCategory;
Boolean relativeDateInChangeTable;
CommentVisibilityStrategy commentVisibilityStrategy;
DiffView diffView;
PreferenceInfo(AccountGeneralPreferences p) {
changesPerPage = p.getMaximumPageSize();
showSiteHeader = p.isShowSiteHeader() ? true : null;
useFlashClipboard = p.isUseFlashClipboard() ? true : null;
downloadScheme = p.getDownloadUrl();
downloadCommand = p.getDownloadCommand();
copySelfOnEmail = p.isCopySelfOnEmails() ? true : null;
dateFormat = p.getDateFormat();
timeFormat = p.getTimeFormat();
reversePatchSetOrder = p.isReversePatchSetOrder() ? true : null;
showUsernameInReviewCategory = p.isShowUsernameInReviewCategory() ? true : null;
relativeDateInChangeTable = p.isRelativeDateInChangeTable() ? true : null;
commentVisibilityStrategy = p.getCommentVisibilityStrategy();
diffView = p.getDiffView();
}
}
}

2
gerrit-server/src/main/java/com/google/gerrit/server/account/Module.java
View File

@@ -59,6 +59,8 @@ public class Module extends RestApiModule {
get(ACCOUNT_KIND, "avatar.change.url").to(GetAvatarChangeUrl.class);
child(ACCOUNT_KIND, "capabilities").to(Capabilities.class);
get(ACCOUNT_KIND, "groups").to(GetGroups.class);
get(ACCOUNT_KIND, "preferences").to(GetPreferences.class);
post(ACCOUNT_KIND, "preferences").to(SetPreferences.class);
get(ACCOUNT_KIND, "preferences.diff").to(GetDiffPreferences.class);
put(ACCOUNT_KIND, "preferences.diff").to(SetDiffPreferences.class);
get(CAPABILITY_KIND).to(GetCapabilities.CheckOne.class);

139
gerrit-server/src/main/java/com/google/gerrit/server/account/SetPreferences.java Normal file
View File

@@ -0,0 +1,139 @@
// 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 com.google.gerrit.extensions.restapi.AuthException;
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.CommentVisibilityStrategy;
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.DownloadScheme;
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.account.SetPreferences.Input;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.util.Collections;
public class SetPreferences implements RestModifyView<AccountResource, Input> {
static class Input {
Short changesPerPage;
Boolean showSiteHeader;
Boolean useFlashClipboard;
DownloadScheme downloadScheme;
DownloadCommand downloadCommand;
Boolean copySelfOnEmail;
DateFormat dateFormat;
TimeFormat timeFormat;
Boolean reversePatchSetOrder;
Boolean showUsernameInReviewCategory;
Boolean relativeDateInChangeTable;
CommentVisibilityStrategy commentVisibilityStrategy;
DiffView diffView;
}
private final Provider<CurrentUser> self;
private final AccountCache cache;
private final ReviewDb db;
@Inject
SetPreferences(Provider<CurrentUser> self, AccountCache cache, ReviewDb db) {
this.self = self;
this.cache = cache;
this.db = db;
}
@Override
public GetPreferences.PreferenceInfo apply(AccountResource rsrc, Input i)
throws AuthException, ResourceNotFoundException, OrmException {
if (self.get() != rsrc.getUser()
&& !self.get().getCapabilities().canAdministrateServer()) {
throw new AuthException("restricted to administrator");
}
if (i == null) {
i = new Input();
}
Account.Id accountId = rsrc.getUser().getAccountId();
AccountGeneralPreferences p;
db.accounts().beginTransaction(accountId);
try {
Account a = db.accounts().get(accountId);
if (a == null) {
throw new ResourceNotFoundException();
}
p = a.getGeneralPreferences();
if (p == null) {
p = new AccountGeneralPreferences();
a.setGeneralPreferences(p);
}
if (i.changesPerPage != null) {
p.setMaximumPageSize(i.changesPerPage);
}
if (i.showSiteHeader != null) {
p.setShowSiteHeader(i.showSiteHeader);
}
if (i.useFlashClipboard != null) {
p.setUseFlashClipboard(i.useFlashClipboard);
}
if (i.downloadScheme != null) {
p.setDownloadUrl(i.downloadScheme);
}
if (i.downloadCommand != null) {
p.setDownloadCommand(i.downloadCommand);
}
if (i.copySelfOnEmail != null) {
p.setCopySelfOnEmails(i.copySelfOnEmail);
}
if (i.dateFormat != null) {
p.setDateFormat(i.dateFormat);
}
if (i.timeFormat != null) {
p.setTimeFormat(i.timeFormat);
}
if (i.reversePatchSetOrder != null) {
p.setReversePatchSetOrder(i.reversePatchSetOrder);
}
if (i.showUsernameInReviewCategory != null) {
p.setShowUsernameInReviewCategory(i.showUsernameInReviewCategory);
}
if (i.relativeDateInChangeTable != null) {
p.setRelativeDateInChangeTable(i.relativeDateInChangeTable);
}
if (i.commentVisibilityStrategy != null) {
p.setCommentVisibilityStrategy(i.commentVisibilityStrategy);
}
if (i.diffView != null) {
p.setDiffView(i.diffView);
}
db.accounts().update(Collections.singleton(a));
db.commit();
cache.evict(accountId);
} finally {
db.rollback();
}
return new GetPreferences.PreferenceInfo(p);
}
}