opendev
/
gerrit
Code Issues Proposed changes

Use a template to set the contents of the MergedEmails. 

Add an admin editable Merged.vm template used to format the
contents of the merged change emails.

Change-Id: I79823c2135383a7dbf7f245abea3d693db025150
This commit is contained in:
Martin Fick 2010-07-23 17:31:26 -06:00
parent b7f3b2d5be
commit 7305be4faf
5 changed files with 93 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/config-mail.txt
View File

@ -31,6 +31,13 @@ ChangeSubject.vm
The `ChangeSubject.vm` template will determine the contents of the email
subject line for ALL emails related to changes.
Merged.vm
~~~~~~~~~
The `Merged.vm` template will determine the contents of the email related to
a change successfully merged to the head. It is a `ChangeEmail`: see
`ChangeSubject.vm` and `ChangeFooter.vm`.
Mail Variables and Methods
--------------------------

1
gerrit-pgm/src/main/java/com/google/gerrit/pgm/init/SitePathInitializer.java
View File

@ -86,6 +86,7 @@ public class SitePathInitializer {
chmod(0755, site.gerrit_sh);
extractMailExample("ChangeSubject.vm");
extractMailExample("Merged.vm");
if (!ui.isBatch()) {
System.err.println();

20
gerrit-server/src/main/java/com/google/gerrit/server/mail/ChangeEmail.java
View File

@ -252,21 +252,27 @@ public abstract class ChangeEmail extends OutgoingEmail {
/** Format the change message and the affected file list. */
protected void formatChangeDetail() {
appendText(getChangeDetail());
}
/** Create the change message and the affected file list. */
public String getChangeDetail() {
StringBuilder detail = new StringBuilder();
if (patchSetInfo != null) {
appendText(patchSetInfo.getMessage().trim());
appendText("\n");
detail.append(patchSetInfo.getMessage().trim() + "\n");
} else {
appendText(change.getSubject().trim());
appendText("\n");
detail.append(change.getSubject().trim() + "\n");
}
if (patchSet != null) {
appendText("---\n");
detail.append("---\n");
for (PatchListEntry p : getPatchList().getPatches()) {
appendText(p.getChangeType().getCode() + " " + p.getNewName() + "\n");
detail.append(p.getChangeType().getCode() + " " + p.getNewName() + "\n");
}
appendText("\n");
detail.append("\n");
}
return detail.toString();
}
/** Get the patch list corresponding to this patch set. */

78
gerrit-server/src/main/java/com/google/gerrit/server/mail/MergedSender.java
View File

@ -62,57 +62,46 @@ public class MergedSender extends ReplyToChangeSender {
@Override
protected void formatChange() throws EmailException {
appendText("Change " + change.getKey().abbreviate());
if (patchSetInfo != null && patchSetInfo.getAuthor() != null
&& patchSetInfo.getAuthor().getName() != null) {
appendText(" by ");
appendText(patchSetInfo.getAuthor().getName());
}
appendText(" submitted to ");
appendText(dest.getShortName());
appendText(":\n\n");
formatChangeDetail();
formatApprovals();
appendText(velocifyFile("Merged.vm"));
}
private void formatApprovals() {
if (patchSet != null) {
try {
final Map<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>> pos =
new HashMap<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>>();
public String getApprovals() {
try {
final Map<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>> pos =
new HashMap<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>>();
final Map<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>> neg =
new HashMap<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>>();
final Map<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>> neg =
new HashMap<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>>();
for (PatchSetApproval ca : args.db.get().patchSetApprovals()
.byPatchSet(patchSet.getId())) {
if (ca.getValue() > 0) {
insert(pos, ca);
} else if (ca.getValue() < 0) {
insert(neg, ca);
}
for (PatchSetApproval ca : args.db.get().patchSetApprovals()
.byPatchSet(patchSet.getId())) {
if (ca.getValue() > 0) {
insert(pos, ca);
} else if (ca.getValue() < 0) {
insert(neg, ca);
}
format("Approvals", pos);
format("Objections", neg);
} catch (OrmException err) {
// Don't list the approvals
}
return format("Approvals", pos) + format("Objections", neg);
} catch (OrmException err) {
// Don't list the approvals
}
return "";
}
private void format(final String type,
private String format(final String type,
final Map<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>> list) {
StringBuilder txt = new StringBuilder();
if (list.isEmpty()) {
return;
return "";
}
appendText(type + ":\n");
txt.append(type + ":\n");
for (final Map.Entry<Account.Id, Map<ApprovalCategory.Id, PatchSetApproval>> ent : list
.entrySet()) {
final Map<ApprovalCategory.Id, PatchSetApproval> l = ent.getValue();
appendText(" ");
appendText(getNameFor(ent.getKey()));
appendText(": ");
txt.append(" ");
txt.append(getNameFor(ent.getKey()));
txt.append(": ");
boolean first = true;
for (ApprovalType at : approvalTypes.getApprovalTypes()) {
final PatchSetApproval ca = l.get(at.getCategory().getId());
@ -123,24 +112,25 @@ public class MergedSender extends ReplyToChangeSender {
if (first) {
first = false;
} else {
appendText("; ");
txt.append("; ");
}
final ApprovalCategoryValue v = at.getValue(ca);
if (v != null) {
appendText(v.getName());
txt.append(v.getName());
} else {
appendText(at.getCategory().getName());
appendText("=");
txt.append(at.getCategory().getName());
txt.append("=");
if (ca.getValue() > 0) {
appendText("+");
txt.append("+");
}
appendText("" + ca.getValue());
txt.append("" + ca.getValue());
}
}
appendText("\n");
txt.append("\n");
}
appendText("\n");
txt.append("\n");
return txt.toString();
}
private void insert(

38
gerrit-server/src/main/resources/com/google/gerrit/server/mail/Merged.vm Normal file
View File

@ -0,0 +1,38 @@
## Copyright (C) 2010 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.
##
##
## Template Type:
## -------------
## This is a velocity mail template, see: http://velocity.apache.org and the
## gerrit-docs:config-mail.txt for more info on modifying gerrit mail templates.
##
## Template File Names and extensions:
## ----------------------------------
## Gerrit will use templates ending in ".vm" but will ignore templates ending
## in ".vm.example". If a .vm template does not exist, the default internal
## gerrit template which is the same as the .vm.example will be used. If you
## want to override the default template, copy the .vm.exmaple file to a .vm
## file and edit it appropriately.
##
## This Template:
## --------------
## The Merged.vm template will determine the contents of the email related to
## a change successfully merged to the head. It is a ChangeEmail: see
## ChangeSubject.vm and ChangeFooter.vm.
##
Change $changeId.abbreviate()#if ($patchSetInfo.author.name)
by $patchSetInfo.author.name#end submitted to $change.dest.shortName:
$email.changeDetail$email.approvals