1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
// Copyright (C) 2012 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.mail;
import com.google.common.collect.Iterables;
import com.google.gerrit.common.errors.EmailException;
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.AccountProjectWatch.NotifyType;
import com.google.gerrit.reviewdb.client.Branch;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.mail.ProjectWatch.Watchers;
import com.google.gwtorm.server.OrmException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Common class for notifications that are related to a project and branch
*/
public abstract class NotificationEmail extends OutgoingEmail {
private static final Logger log =
LoggerFactory.getLogger(NotificationEmail.class);
protected Project.NameKey project;
protected Branch.NameKey branch;
protected NotificationEmail(EmailArguments ea,
String mc, Project.NameKey project, Branch.NameKey branch) {
super(ea, mc);
this.project = project;
this.branch = branch;
}
@Override
protected void init() throws EmailException {
super.init();
setListIdHeader();
}
private void setListIdHeader() throws EmailException {
// Set a reasonable list id so that filters can be used to sort messages
setVHeader("List-Id", "<$email.listId.replace('@', '.')>");
if (getSettingsUrl() != null) {
setVHeader("List-Unsubscribe", "<$email.settingsUrl>");
}
}
public String getListId() throws EmailException {
return velocify("gerrit-$projectName.replace('/', '-')@$email.gerritHost");
}
/** Include users and groups that want notification of events. */
protected void includeWatchers(NotifyType type) {
try {
Watchers matching = getWatchers(type);
add(RecipientType.TO, matching.to);
add(RecipientType.CC, matching.cc);
add(RecipientType.BCC, matching.bcc);
} catch (OrmException err) {
// Just don't CC everyone. Better to send a partial message to those
// we already have queued up then to fail deliver entirely to people
// who have a lower interest in the change.
log.warn("Cannot BCC watchers for " + type, err);
}
}
/** Returns all watchers that are relevant */
protected abstract Watchers getWatchers(NotifyType type) throws OrmException;
/** Add users or email addresses to the TO, CC, or BCC list. */
protected void add(RecipientType type, Watchers.List list) {
for (Account.Id user : list.accounts) {
add(type, user);
}
for (Address addr : list.emails) {
add(type, addr);
}
}
public String getSshHost() {
String host = Iterables.getFirst(args.sshAddresses, null);
if (host == null) {
return null;
}
if (host.startsWith("*:")) {
return getGerritHost() + host.substring(1);
}
return host;
}
@Override
protected void setupVelocityContext() {
super.setupVelocityContext();
velocityContext.put("projectName", project.get());
velocityContext.put("branch", branch);
}
}
|
