opendev/gerrit
Code Issues Proposed changes

Merge "Upgrade most change emails with HTML"

Browse Source
This commit is contained in:
Wyatt Allen
2016-09-16 20:29:28 +00:00
committed by Gerrit Code Review
parent beb55fc218 f94255f94e
commit 060e13cade
21 changed files with 538 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
gerrit-server/src/main/java/com/google/gerrit/server/mail/AbandonedSender.java
View File

@@ -51,5 +51,11 @@ public class AbandonedSender extends ReplyToChangeSender {
@Override
protected void formatChange() throws EmailException {
appendText(textTemplate("Abandoned"));
appendHtml(soyHtmlTemplate("AbandonedHtml"));
}
@Override
protected boolean useHtml() {
return true;
}
}

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

@@ -122,6 +122,9 @@ public abstract class ChangeEmail extends NotificationEmail {
protected void format() throws EmailException {
formatChange();
appendText(textTemplate("ChangeFooter"));
if (useHtml()) {
appendHtml(soyHtmlTemplate("ChangeFooterHtml"));
}
try {
TreeSet<String> names = new TreeSet<>();
for (Account.Id who : changeData.reviewers().all()) {

6
gerrit-server/src/main/java/com/google/gerrit/server/mail/DeleteReviewerSender.java
View File

@@ -66,6 +66,7 @@ public class DeleteReviewerSender extends ReplyToChangeSender {
@Override
protected void formatChange() throws EmailException {
appendText(textTemplate("DeleteReviewer"));
appendHtml(soyHtmlTemplate("DeleteReviewerHtml"));
}
public List<String> getReviewerNames() {
@@ -84,4 +85,9 @@ public class DeleteReviewerSender extends ReplyToChangeSender {
super.setupSoyContext();
soyContextEmailData.put("reviewerNames", getReviewerNames());
}
@Override
protected boolean useHtml() {
return true;
}
}

6
gerrit-server/src/main/java/com/google/gerrit/server/mail/DeleteVoteSender.java
View File

@@ -50,5 +50,11 @@ public class DeleteVoteSender extends ReplyToChangeSender {
@Override
protected void formatChange() throws EmailException {
appendText(textTemplate("DeleteVote"));
appendHtml(soyHtmlTemplate("DeleteVoteHtml"));
}
@Override
protected boolean useHtml() {
return true;
}
}

12
gerrit-server/src/main/java/com/google/gerrit/server/mail/MailSoyTofuProvider.java
View File

@@ -37,22 +37,32 @@ public class MailSoyTofuProvider implements Provider<SoyTofu> {
// Note: will fail to construct the tofu object if this array is empty.
private static final String[] TEMPLATES = {
"Abandoned.soy",
"AbandonedHtml.soy",
"AddKey.soy",
"AddKeyHtml.soy",
"ChangeSubject.soy",
"ChangeFooter.soy",
"ChangeFooterHtml.soy",
"ChangeSubject.soy",
"Comment.soy",
"CommentFooter.soy",
"DeleteReviewer.soy",
"DeleteReviewerHtml.soy",
"DeleteVote.soy",
"DeleteVoteHtml.soy",
"Footer.soy",
"FooterHtml.soy",
"HeaderHtml.soy",
"Merged.soy",
"NewChange.soy",
"NewChangeHtml.soy",
"RegisterNewEmail.soy",
"ReplacePatchSet.soy",
"ReplacePatchSetHtml.soy",
"Restored.soy",
"RestoredHtml.soy",
"Reverted.soy",
"RevertedHtml.soy",
"ViewChangeButton.soy",
};
private final SitePaths site;

6
gerrit-server/src/main/java/com/google/gerrit/server/mail/NewChangeSender.java
View File

@@ -68,6 +68,7 @@ public abstract class NewChangeSender extends ChangeEmail {
@Override
protected void formatChange() throws EmailException {
appendText(textTemplate("NewChange"));
appendHtml(soyHtmlTemplate("NewChangeHtml"));
}
public List<String> getReviewerNames() {
@@ -86,4 +87,9 @@ public abstract class NewChangeSender extends ChangeEmail {
super.setupSoyContext();
soyContextEmailData.put("reviewerNames", getReviewerNames());
}
@Override
protected boolean useHtml() {
return true;
}
}

3
gerrit-server/src/main/java/com/google/gerrit/server/mail/OutgoingEmail.java
View File

@@ -109,6 +109,9 @@ public abstract class OutgoingEmail {
}
init();
if (useHtml()) {
appendHtml(soyHtmlTemplate("HeaderHtml"));
}
format();
appendText(textTemplate("Footer"));
if (useHtml()) {

6
gerrit-server/src/main/java/com/google/gerrit/server/mail/ReplacePatchSetSender.java
View File

@@ -73,6 +73,7 @@ public class ReplacePatchSetSender extends ReplyToChangeSender {
@Override
protected void formatChange() throws EmailException {
appendText(textTemplate("ReplacePatchSet"));
appendHtml(soyHtmlTemplate("ReplacePatchSetHtml"));
}
public List<String> getReviewerNames() {
@@ -94,4 +95,9 @@ public class ReplacePatchSetSender extends ReplyToChangeSender {
super.setupSoyContext();
soyContextEmailData.put("reviewerNames", getReviewerNames());
}
@Override
protected boolean useHtml() {
return true;
}
}

6
gerrit-server/src/main/java/com/google/gerrit/server/mail/RestoredSender.java
View File

@@ -50,5 +50,11 @@ public class RestoredSender extends ReplyToChangeSender {
@Override
protected void formatChange() throws EmailException {
appendText(textTemplate("Restored"));
appendHtml(soyHtmlTemplate("RestoredHtml"));
}
@Override
protected boolean useHtml() {
return true;
}
}

6
gerrit-server/src/main/java/com/google/gerrit/server/mail/RevertedSender.java
View File

@@ -48,5 +48,11 @@ public class RevertedSender extends ReplyToChangeSender {
@Override
protected void formatChange() throws EmailException {
appendText(textTemplate("Reverted"));
appendHtml(soyHtmlTemplate("RevertedHtml"));
}
@Override
protected boolean useHtml() {
return true;
}
}

44
gerrit-server/src/main/resources/com/google/gerrit/server/mail/AbandonedHtml.soy Normal file
View File

@@ -0,0 +1,44 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param change
* @param coverLetter
* @param email
* @param fromName
*/
{template .AbandonedHtml autoescape="strict" kind="html"}
<p>
{$fromName} has abandoned this change.
</p>
{if $email.changeUrl}
<p>
{call .ViewChangeButton data="all" /}
</p>
{/if}
<p>
Change subject: {$change.subject}
</p>
<hr/>
{if $coverLetter}
<pre>{$coverLetter}</pre>
{/if}
{/template}

49
gerrit-server/src/main/resources/com/google/gerrit/server/mail/ChangeFooterHtml.soy Normal file
View File

@@ -0,0 +1,49 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param branch
* @param change
* @param changeId
* @param email
* @param messageClass
* @param patchSet
* @param projectName
*/
{template .ChangeFooterHtml autoescape="strict" kind="html"}
{if $email.changeUrl or $email.settingsUrl}
<p>
{if $email.changeUrl}
To view, visit <a href="{$email.changeUrl}">this change</a>.
{/if}
{if $email.changeUrl and $email.settingsUrl}{sp}{/if}
{if $email.settingsUrl}
To unsubscribe, visit <a href="{$email.settingsUrl}">settings</a>.
{/if}
</p>
{/if}
<p style="color: #555;">
Gerrit-MessageType: {$messageClass}<br/>
Gerrit-Change-Id: {$changeId}<br/>
Gerrit-PatchSet: {$patchSet.patchSetId}<br/>
Gerrit-Project: {$projectName}<br/>
Gerrit-Branch: {$branch.shortName}<br/>
Gerrit-Owner: {$change.ownerEmail}
</p>
{/template}

49
gerrit-server/src/main/resources/com/google/gerrit/server/mail/DeleteReviewerHtml.soy Normal file
View File

@@ -0,0 +1,49 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param change
* @param coverLetter
* @param email
* @param fromName
*/
{template .DeleteReviewerHtml autoescape="strict" kind="html"}
<p>
{$fromName} has removed{sp}
{foreach $reviewerName in $email.reviewerNames}
{if not isFirst($reviewerName)},{sp}{/if}
{$reviewerName}
{/foreach}{sp}
from this change.
</p>
{if $email.changeUrl}
<p>
{call .ViewChangeButton data="all" /}
</p>
{/if}
<p>
Change subject: {$change.subject}
</p>
<hr/>
{if $coverLetter}
<pre>{$coverLetter}</pre>
{/if}
{/template}

44
gerrit-server/src/main/resources/com/google/gerrit/server/mail/DeleteVoteHtml.soy Normal file
View File

@@ -0,0 +1,44 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param change
* @param coverLetter
* @param email
* @param fromName
*/
{template .DeleteVoteHtml autoescape="strict" kind="html"}
<p>
{$fromName} removed a vote on this change.
</p>
{if $email.changeUrl}
<p>
{call .ViewChangeButton data="all" /}
</p>
{/if}
<p>
Change subject: {$change.subject}
</p>
<hr/>
{if $coverLetter}
<pre>{$coverLetter}</pre>
{/if}
{/template}

20
gerrit-server/src/main/resources/com/google/gerrit/server/mail/HeaderHtml.soy Normal file
View File

@@ -0,0 +1,20 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
{template .HeaderHtml autoescape="strict" kind="html"}
{/template}

78
gerrit-server/src/main/resources/com/google/gerrit/server/mail/NewChangeHtml.soy Normal file
View File

@@ -0,0 +1,78 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param change
* @param email
* @param fromName
* @param patchSet
* @param projectName
*/
{template .NewChangeHtml autoescape="strict" kind="html"}
{if $email.reviewerNames}
<p>
Hello{sp}
{foreach $reviewerName in $email.reviewerNames}
{if not isFirst($reviewerName)},{sp}{/if}
{$reviewerName}
{/foreach},
</p>
<p>
I'd like you to do a code review.
</p>
{if $email.changeUrl}
<p>
Please visit <a href="{$email.changeUrl}">this change</a> to review.
</p>
{/if}
{else}
<p>
{$fromName} has uploaded a new change for review.
</p>
{if $email.changeUrl}
<p>
{call .ViewChangeButton data="all" /}
</p>
{/if}
{/if}
<p>
Change subject: {$change.subject}
</p>
<hr/>
<pre>
{$email.changeDetail}
</pre>
{if $email.sshHost}
<pre>
git pull ssh:{print '//'}{$email.sshHost}/{$projectName}
{sp}{$patchSet.refName}
</pre>
{/if}
{if $email.includeDiff}
<pre>
{$email.unifiedDiff}
</pre>
{/if}
{/template}

72
gerrit-server/src/main/resources/com/google/gerrit/server/mail/ReplacePatchSetHtml.soy Normal file
View File

@@ -0,0 +1,72 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param change
* @param email
* @param fromName
* @param patchSet
* @param projectName
*/
{template .ReplacePatchSetHtml autoescape="strict" kind="html"}
{if $email.reviewerNames}
<p>
Hello{sp}
{foreach $reviewerName in $email.reviewerNames}
{$reviewerName},{sp}
{/foreach}
</p>
<p>
I'd like you to reexamine a change.
</p>
{if $email.changeUrl}
<p>
Please visit <a href="{$email.changeUrl}">this change</a> to look at{sp}
the new patch set (#{$patchSet.patchSetId}).
</p>
{/if}
{else}
<p>
{$fromName} has uploaded a new patch set (#{$patchSet.patchSetId}).
</p>
{if $email.changeUrl}
<p>
{call .ViewChangeButton data="all" /}
</p>
{/if}
{/if}
<p>
Change subject: {$change.subject}
</p>
<hr/>
<pre>
{$email.changeDetail}
</pre>
{if $email.sshHost}
<pre>
git pull ssh:{print '//'}{$email.sshHost}/{$projectName}{sp}
{$patchSet.refName}
</pre>
{/if}
{/template}

44
gerrit-server/src/main/resources/com/google/gerrit/server/mail/RestoredHtml.soy Normal file
View File

@@ -0,0 +1,44 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param change
* @param coverLetter
* @param email
* @param fromName
*/
{template .RestoredHtml autoescape="strict" kind="html"}
<p>
{$fromName} has restored this change.
</p>
{if $email.changeUrl}
<p>
{call .ViewChangeButton data="all" /}
</p>
{/if}
<p>
Change subject: {$change.subject}
</p>
<hr/>
{if $coverLetter}
<pre>{$coverLetter}</pre>
{/if}
{/template}

44
gerrit-server/src/main/resources/com/google/gerrit/server/mail/RevertedHtml.soy Normal file
View File

@@ -0,0 +1,44 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* @param change
* @param coverLetter
* @param email
* @param fromName
*/
{template .RevertedHtml autoescape="strict" kind="html"}
<p>
{$fromName} has reverted this change.
</p>
{if $email.changeUrl}
<p>
{call .ViewChangeButton data="all" /}
</p>
{/if}
<p>
Change subject: {$change.subject}
</p>
<hr/>
{if $coverLetter}
<pre>{$coverLetter}</pre>
{/if}
{/template}

25
gerrit-server/src/main/resources/com/google/gerrit/server/mail/ViewChangeButton.soy Normal file
View File

@@ -0,0 +1,25 @@
/**
* Copyright (C) 2016 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.
*/
{namespace com.google.gerrit.server.mail.template}
/**
* Private template to generate "View Change" buttons.
* @param email
*/
{template .ViewChangeButton private="true" autoescape="strict" kind="html"}
<a href="{$email.changeUrl}">View Change</a>
{/template}