The Unified and Autonomous Development Platform
feat(system-setting): make noreply email domain configurable
Robin Shena7d4c8e92203
diff --git a/server-core/src/main/java/io/onedev/server/data/DefaultDataService.java b/server-core/src/main/java/io/onedev/server/data/DefaultDataService.javaindex 910676ae4d..c0b7a03c0b 100644--- a/server-core/src/main/java/io/onedev/server/data/DefaultDataService.java+++ b/server-core/src/main/java/io/onedev/server/data/DefaultDataService.java@@ -10,6 +10,7 @@ import static io.onedev.server.model.support.administration.SystemSetting.PROP_Simport static io.onedev.server.model.support.administration.SystemSetting.PROP_SSH_ROOT_URL;import static io.onedev.server.model.support.administration.SystemSetting.PROP_USE_AVATAR_SERVICE;import static io.onedev.server.model.support.administration.SystemSetting.PROP_DEFAULT_FORK_ROOT;+import static io.onedev.server.model.support.administration.SystemSetting.PROP_NOREPLY_EMAIL_DOMAIN;import static io.onedev.server.persistence.PersistenceUtils.tableExists;import static org.unbescape.html.HtmlEscape.escapeHtml5;@@ -725,7 +726,7 @@ public class DefaultDataService implements DataService, Serializable {}if (systemSetting != null) {- Collection<String> excludedProps = Sets.newHashSet(PROP_SSH_ROOT_URL, PROP_DISABLE_AUTO_UPDATE_CHECK, PROP_USE_AVATAR_SERVICE, PROP_SESSION_TIMEOUT, PROP_DEFAULT_FORK_ROOT);+ Collection<String> excludedProps = Sets.newHashSet(PROP_SSH_ROOT_URL, PROP_DISABLE_AUTO_UPDATE_CHECK, PROP_USE_AVATAR_SERVICE, PROP_SESSION_TIMEOUT, PROP_DEFAULT_FORK_ROOT, PROP_NOREPLY_EMAIL_DOMAIN);if (Bootstrap.isInDocker()) {excludedProps.add(PROP_GIT_LOCATION);excludedProps.add(PROP_CURL_LOCATION);diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.javaindex 29595e2bd9..db40fc0fa9 100644--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java@@ -74,6 +74,7 @@ import io.onedev.server.model.PullRequestComment;import io.onedev.server.model.User;import io.onedev.server.model.support.TimeGroups;import io.onedev.server.model.support.administration.AiSetting;+import io.onedev.server.model.support.administration.SystemSetting;import io.onedev.server.model.support.issue.CommitMessageFixSetting;import io.onedev.server.model.support.issue.field.spec.BuildChoiceField;import io.onedev.server.service.SettingService;@@ -9223,4 +9224,22 @@ public class DataMigrator {}}+ private void migrate237(File dataDir, Stack<Integer> versions) {+ for (File file : dataDir.listFiles()) {+ if (file.getName().startsWith("Settings.xml")) {+ var dom = VersionedXmlDoc.fromFile(file);+ for (Element element : dom.getRootElement().elements()) {+ if (element.elementTextTrim("key").equals("SYSTEM")) {+ Element valueElement = element.element("value");+ if (valueElement != null) {+ valueElement.addElement("noreplyEmailDomain")+ .setText(SystemSetting.DEFAULT_NOREPLY_EMAIL_DOMAIN);+ }+ }+ }+ dom.writeToFile(file, false);+ }+ }+ }+}diff --git a/server-core/src/main/java/io/onedev/server/model/User.java b/server-core/src/main/java/io/onedev/server/model/User.javaindex 48716ae2a7..cf8b4200eb 100644--- a/server-core/src/main/java/io/onedev/server/model/User.java+++ b/server-core/src/main/java/io/onedev/server/model/User.java@@ -83,16 +83,8 @@ public class User extends AbstractEntity implements AuthenticationInfo {public static final Long ROOT_ID = 1L;- private static final String SERVICE_ACCOUNT_EMAIL_PREFIX = "sc-";-- private static final String AI_ACCOUNT_EMAIL_PREFIX = "ai-";-- private static final String SERVICE_OR_AI_ACCOUNT_EMAIL_SUFFIX = "@onedev";-public static final String SYSTEM_NAME = "OneDev";- public static final String SYSTEM_EMAIL_ADDRESS = "system@onedev";-public static final String UNKNOWN_NAME = "unknown";public static final String PROP_NAME = "name";@@ -781,7 +773,7 @@ public class User extends AbstractEntity implements AuthenticationInfo {if (isUnknown()) {throw new ExplicitException("Unknown user does not have git identity");} else if (isSystem()) {- return new PersonIdent(User.SYSTEM_NAME, User.SYSTEM_EMAIL_ADDRESS);+ return new PersonIdent(User.SYSTEM_NAME, getSystemEmailAddress());} else {EmailAddress emailAddress = getGitEmailAddress();if (emailAddress != null && emailAddress.isVerified())@@ -1309,8 +1301,7 @@ public class User extends AbstractEntity implements AuthenticationInfo {public EmailAddress getServiceOrAiAccountEmailAddress() {if (getType() == Type.SERVICE || getType() == Type.AI) {var emailAddress = new EmailAddress();- var emailPrefix = getType() == Type.SERVICE ? SERVICE_ACCOUNT_EMAIL_PREFIX : AI_ACCOUNT_EMAIL_PREFIX;- emailAddress.setValue(emailPrefix + getName() + SERVICE_OR_AI_ACCOUNT_EMAIL_SUFFIX);+ emailAddress.setValue(getName() + "@" + getNoreplyEmailDomain());emailAddress.setOwner(this);emailAddress.setPrimary(true);emailAddress.setGit(true);@@ -1322,6 +1313,14 @@ public class User extends AbstractEntity implements AuthenticationInfo {}}+ public static String getNoreplyEmailDomain() {+ return OneDev.getInstance(SettingService.class).getSystemSetting().getNoreplyEmailDomain();+ }++ public static String getSystemEmailAddress() {+ return "system@" + getNoreplyEmailDomain();+ }+public void addEmailAddress(EmailAddress emailAddress) {emailAddress.setOwner(this);emailAddress.setPrimary(getEmailAddresses().stream().noneMatch(it->it.isPrimary()));@@ -1367,15 +1366,11 @@ public class User extends AbstractEntity implements AuthenticationInfo {@Nullablepublic static String getServiceOrAiAccountName(String value) {- if (value.endsWith(SERVICE_OR_AI_ACCOUNT_EMAIL_SUFFIX)) {- value = value.substring(0, value.length() - SERVICE_OR_AI_ACCOUNT_EMAIL_SUFFIX.length());- if (value.startsWith(SERVICE_ACCOUNT_EMAIL_PREFIX)) {- return value.substring(SERVICE_ACCOUNT_EMAIL_PREFIX.length());- } else if (value.startsWith(AI_ACCOUNT_EMAIL_PREFIX)) {- return value.substring(AI_ACCOUNT_EMAIL_PREFIX.length());- }- }- return null;+ var noreplyEmailSuffix = "@" + getNoreplyEmailDomain();+ if (value.endsWith(noreplyEmailSuffix))+ return value.substring(0, value.length() - noreplyEmailSuffix.length());+ else+ return null;}public static String encodeWorkspaceDataKey(String dataKey) {diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/GpgSetting.java b/server-core/src/main/java/io/onedev/server/model/support/administration/GpgSetting.javaindex 634e9995c2..7cfbf756ec 100644--- a/server-core/src/main/java/io/onedev/server/model/support/administration/GpgSetting.java+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/GpgSetting.java@@ -55,6 +55,7 @@ public class GpgSetting implements Serializable {public void setEncodedSigningKey(@Nullable byte[] encodedSigningKey) {this.encodedSigningKey = encodedSigningKey;+ signingKey = null;}@Nullablediff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/SystemSetting.java b/server-core/src/main/java/io/onedev/server/model/support/administration/SystemSetting.javaindex d8db7c753e..a4dede1170 100644--- a/server-core/src/main/java/io/onedev/server/model/support/administration/SystemSetting.java+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/SystemSetting.java@@ -10,6 +10,7 @@ import javax.validation.Valid;import javax.validation.constraints.Min;import javax.validation.constraints.NotEmpty;import javax.validation.constraints.NotNull;+import javax.validation.constraints.Pattern;import org.apache.commons.lang3.StringUtils;@@ -50,6 +51,10 @@ public class SystemSetting implements Serializable, Validatable {public static final String PROP_DISABLE_AUTO_UPDATE_CHECK = "disableAutoUpdateCheck";public static final String PROP_DEFAULT_FORK_ROOT = "defaultForkRoot";++ public static final String PROP_NOREPLY_EMAIL_DOMAIN = "noreplyEmailDomain";++ public static final String DEFAULT_NOREPLY_EMAIL_DOMAIN = "noreply.onedev";private String serverUrl;@@ -70,6 +75,8 @@ public class SystemSetting implements Serializable, Validatable {private String avatarServiceUrl = "https://secure.gravatar.com/avatar/";private String defaultForkRoot = "forks";++ private String noreplyEmailDomain = DEFAULT_NOREPLY_EMAIL_DOMAIN;@Editable(name="Server URL", order=90, description="Specify root URL to access this server")@NotEmpty@@ -217,6 +224,19 @@ public class SystemSetting implements Serializable, Validatable {this.defaultForkRoot = defaultForkRoot;}+ @Editable(order=800, name="Noreply Email Domain", description="""+ Specify domain of various noreply email addresses for git operations if users want+ to keep their own email addresses private""")+ @NotEmpty+ @Pattern(regexp = "[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+", message = "Not a valid email domain")+ public String getNoreplyEmailDomain() {+ return noreplyEmailDomain;+ }++ public void setNoreplyEmailDomain(String noreplyEmailDomain) {+ this.noreplyEmailDomain = noreplyEmailDomain;+ }+public void onMoveProject(String oldPath, String newPath) {if (defaultForkRoot != null && PathUtils.isSelfOrAncestor(oldPath, defaultForkRoot))defaultForkRoot = PathUtils.substituteSelfOrAncestor(defaultForkRoot, oldPath, newPath);diff --git a/server-core/src/main/java/io/onedev/server/model/support/pullrequest/MergeStrategy.java b/server-core/src/main/java/io/onedev/server/model/support/pullrequest/MergeStrategy.javaindex f11a0e96be..624f1377d6 100644--- a/server-core/src/main/java/io/onedev/server/model/support/pullrequest/MergeStrategy.java+++ b/server-core/src/main/java/io/onedev/server/model/support/pullrequest/MergeStrategy.java@@ -18,7 +18,7 @@ public enum MergeStrategy {@Overridepublic ObjectId merge(PullRequest request, String commitMessage) {- PersonIdent user = new PersonIdent(User.SYSTEM_NAME, User.SYSTEM_EMAIL_ADDRESS);+ PersonIdent user = new PersonIdent(User.SYSTEM_NAME, User.getSystemEmailAddress());ObjectId requestHead = request.getLatestUpdate().getHeadCommit();ObjectId targetHead = request.getTarget().getObjectId();return getGitService().merge(request.getTargetProject(), targetHead, requestHead,@@ -36,7 +36,7 @@ public enum MergeStrategy {if (getGitService().isMergedInto(project, null, targetHead, requestHead)) {return requestHead;} else {- PersonIdent user = new PersonIdent(User.SYSTEM_NAME, User.SYSTEM_EMAIL_ADDRESS);+ PersonIdent user = new PersonIdent(User.SYSTEM_NAME, User.getSystemEmailAddress());return getGitService().merge(project, targetHead, requestHead, false, user, user,commitMessage, false);}@@ -49,7 +49,7 @@ public enum MergeStrategy {public ObjectId merge(PullRequest request, String commitMessage) {ObjectId requestHead = request.getLatestUpdate().getHeadCommit();ObjectId targetHead = request.getTarget().getObjectId();- PersonIdent committer = new PersonIdent(User.SYSTEM_NAME, User.SYSTEM_EMAIL_ADDRESS);+ PersonIdent committer = new PersonIdent(User.SYSTEM_NAME, User.getSystemEmailAddress());return getGitService().merge(request.getTargetProject(), targetHead, requestHead, true,committer, request.getSubmitter().asPerson(), commitMessage, false);}@@ -61,7 +61,7 @@ public enum MergeStrategy {public ObjectId merge(PullRequest request, String commitMessage) {ObjectId requestHead = request.getLatestUpdate().getHeadCommit();ObjectId targetHead = request.getTarget().getObjectId();- PersonIdent user = new PersonIdent(User.SYSTEM_NAME, User.SYSTEM_EMAIL_ADDRESS);+ PersonIdent user = new PersonIdent(User.SYSTEM_NAME, User.getSystemEmailAddress());return getGitService().rebase(request.getTargetProject(), requestHead, targetHead, user);}diff --git a/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.javaindex d9b01bafc5..82c59fd4ff 100644--- a/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/BuildNotificationManager.java@@ -72,7 +72,7 @@ public class BuildNotificationManager implements Serializable {@Sessionalpublic void notify(BuildEvent event, Collection<String> emails) {- emails = emails.stream().filter(it -> !it.equals(User.SYSTEM_EMAIL_ADDRESS)).collect(toList());+ emails = emails.stream().filter(it -> !it.equals(User.getSystemEmailAddress())).collect(toList());if (!emails.isEmpty()) {Build build = event.getBuild();diff --git a/server-core/src/main/java/io/onedev/server/notification/PackNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/PackNotificationManager.javaindex 68d416ea59..e97ef21c5e 100644--- a/server-core/src/main/java/io/onedev/server/notification/PackNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/PackNotificationManager.java@@ -60,7 +60,7 @@ public class PackNotificationManager {@Sessionalpublic void notify(PackEvent event, Collection<String> emails) {- emails = emails.stream().filter(it -> !it.equals(User.SYSTEM_EMAIL_ADDRESS)).collect(toList());+ emails = emails.stream().filter(it -> !it.equals(User.getSystemEmailAddress())).collect(toList());if (!emails.isEmpty()) {Pack pack = event.getPack();diff --git a/server-core/src/main/java/io/onedev/server/notification/WorkspaceNotificationManager.java b/server-core/src/main/java/io/onedev/server/notification/WorkspaceNotificationManager.javaindex 51e2730d25..49ef4ce9cc 100644--- a/server-core/src/main/java/io/onedev/server/notification/WorkspaceNotificationManager.java+++ b/server-core/src/main/java/io/onedev/server/notification/WorkspaceNotificationManager.java@@ -66,7 +66,7 @@ public class WorkspaceNotificationManager {@Sessionalpublic void notify(WorkspaceEvent event, Collection<String> emails) {- emails = emails.stream().filter(it -> !it.equals(User.SYSTEM_EMAIL_ADDRESS)).collect(toList());+ emails = emails.stream().filter(it -> !it.equals(User.getSystemEmailAddress())).collect(toList());if (!emails.isEmpty()) {Workspace workspace = event.getWorkspace();diff --git a/server-core/src/main/java/io/onedev/server/service/impl/DefaultPullRequestService.java b/server-core/src/main/java/io/onedev/server/service/impl/DefaultPullRequestService.javaindex 7011ea87aa..e15a233254 100644--- a/server-core/src/main/java/io/onedev/server/service/impl/DefaultPullRequestService.java+++ b/server-core/src/main/java/io/onedev/server/service/impl/DefaultPullRequestService.java@@ -1272,7 +1272,7 @@ public class DefaultPullRequestService extends BaseEntityService<PullRequest>comparisonBase = mergeBase1;break;} else {- PersonIdent person = new PersonIdent(User.SYSTEM_NAME, User.SYSTEM_EMAIL_ADDRESS);+ PersonIdent person = new PersonIdent(User.SYSTEM_NAME, User.getSystemEmailAddress());comparisonBase = getGitService().merge(targetProject, oldCommitId, mergeBase1,false, person, person, "helper commit", true);break;diff --git a/server-core/src/main/java/io/onedev/server/service/impl/DefaultSettingService.java b/server-core/src/main/java/io/onedev/server/service/impl/DefaultSettingService.javaindex bb82f6b838..23d2735145 100644--- a/server-core/src/main/java/io/onedev/server/service/impl/DefaultSettingService.java+++ b/server-core/src/main/java/io/onedev/server/service/impl/DefaultSettingService.java@@ -3,6 +3,8 @@ package io.onedev.server.service.impl;import static io.onedev.server.model.Setting.PROP_KEY;import static org.hibernate.criterion.Restrictions.eq;+import java.io.ByteArrayOutputStream;+import java.io.IOException;import java.io.ObjectStreamException;import java.io.Serializable;import java.lang.reflect.InvocationTargetException;@@ -13,6 +15,9 @@ import java.util.Map;import java.util.Optional;import java.util.concurrent.ConcurrentHashMap;+import org.bouncycastle.openpgp.PGPException;+import org.bouncycastle.openpgp.PGPKeyRingGenerator;+import javax.inject.Inject;import javax.inject.Singleton;import javax.validation.Validator;@@ -30,6 +35,7 @@ import io.onedev.server.event.entity.EntityPersisted;import io.onedev.server.event.system.SystemStarting;import io.onedev.server.model.Setting;import io.onedev.server.model.Setting.Key;+import io.onedev.server.model.User;import io.onedev.server.model.support.administration.AgentSetting;import io.onedev.server.model.support.administration.AiSetting;import io.onedev.server.model.support.administration.AlertSetting;@@ -58,6 +64,7 @@ import io.onedev.server.model.support.administration.workspaceprovisioner.Workspimport io.onedev.server.persistence.annotation.Sessional;import io.onedev.server.persistence.annotation.Transactional;import io.onedev.server.service.SettingService;+import io.onedev.server.util.GpgUtils;import io.onedev.server.util.usage.Usage;import io.onedev.server.web.component.issue.workflowreconcile.UndefinedFieldResolution;import io.onedev.server.web.component.issue.workflowreconcile.UndefinedFieldValue;@@ -269,7 +276,29 @@ public class DefaultSettingService extends BaseEntityService<Setting> implements@Transactional@Overridepublic void saveSystemSetting(SystemSetting systemSetting) {+ String oldNoreplyEmailDomain = null;+ var setting = findSetting(Key.SYSTEM);+ if (setting != null)+ oldNoreplyEmailDomain = ((SystemSetting) setting.getValue()).getNoreplyEmailDomain();+saveSetting(Key.SYSTEM, systemSetting);++ if (oldNoreplyEmailDomain != null+ && !oldNoreplyEmailDomain.equals(systemSetting.getNoreplyEmailDomain())) {+ var gpgSetting = getGpgSetting();+ if (gpgSetting != null && gpgSetting.getEncodedSigningKey() != null) {+ try {+ PGPKeyRingGenerator generator = GpgUtils.generateKeyRingGenerator(+ User.SYSTEM_NAME + "<system@" + systemSetting.getNoreplyEmailDomain() + ">");+ var baos = new ByteArrayOutputStream();+ generator.generateSecretKeyRing().encode(baos);+ gpgSetting.setEncodedSigningKey(baos.toByteArray());+ saveGpgSetting(gpgSetting);+ } catch (PGPException | IOException e) {+ throw new RuntimeException(e);+ }+ }+ }}@Transactionaldiff --git a/server-core/src/main/java/io/onedev/server/web/page/admin/gpgsigningkey/GpgSigningKeyPage.java b/server-core/src/main/java/io/onedev/server/web/page/admin/gpgsigningkey/GpgSigningKeyPage.javaindex 3f04d8a5da..fd3d44ba49 100644--- a/server-core/src/main/java/io/onedev/server/web/page/admin/gpgsigningkey/GpgSigningKeyPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/admin/gpgsigningkey/GpgSigningKeyPage.java@@ -96,7 +96,7 @@ public class GpgSigningKeyPage extends AdministrationPage {ByteArrayOutputStream baos;try {PGPKeyRingGenerator generator = GpgUtils.generateKeyRingGenerator(- User.SYSTEM_NAME + "<" + User.SYSTEM_EMAIL_ADDRESS + ">");+ User.SYSTEM_NAME + "<" + User.getSystemEmailAddress() + ">");PGPSecretKeyRing secretKeyRing = generator.generateSecretKeyRing();baos = new ByteArrayOutputStream();