KTEmail.php
12.7 KB
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<?php
require_once(KT_LIB_DIR . '/actions/actionregistry.inc.php');
require_once(KT_LIB_DIR . "/email/Email.inc");
require_once(KT_LIB_DIR . "/users/User.inc");
require_once(KT_LIB_DIR . "/groups/Group.inc");
require_once(KT_LIB_DIR . "/documentmanagement/DocumentTransaction.inc");
require_once(KT_LIB_DIR . "/documentmanagement/Document.inc");
/**
* Sends emails to the selected groups
*/
function sendGroupEmails($aGroupIDs, $oDocument, $sComment = "", $bAttachDocument, &$aEmailErrors) {
global $default;
// loop through groups
for ($i=0; $i<count($aGroupIDs); $i++) {
// validate the group id
if ($aGroupIDs[$i] > 0) {
$oDestGroup = Group::get($aGroupIDs[$i]);
$default->log->info("sendingEmail to group " . $oDestGroup->getName());
// for each group, retrieve all the users
$aUsers = $oDestGroup->getUsers();
// FIXME: this should send one email with multiple To: users
for ($j=0; $j<count($aUsers); $j++) {
$default->log->info("sendingEmail to group-member " . $aUsers[$j]->getName() . " with email " . $aUsers[$j]->getEmail());
// the user has an email address and has email notification enabled
if (strlen($aUsers[$j]->getEmail())>0 && $aUsers[$j]->getEmailNotification()) {
//if the to address is valid, send the mail
if (validateEmailAddress($aUsers[$j]->getEmail())) {
sendEmail($aUsers[$j]->getEmail(), $aUsers[$j]->getName(), $oDocument->getID(), $oDocument->getName(), $sComment, $bAttachDocument, $aEmailErrors);
} else {
$default->log->error("email validation failed for " . $aUsers[$j]->getEmail());
}
} else {
$default->log->info("either " . $aUsers[$j]->getUserName() . " has no email address, or notification is not enabled");
}
}
} else {
$default->log->info("filtered group id=" . $aGroupIDs[$i]);
}
}
}
/**
* Sends emails to the selected users
*/
function sendUserEmails($aUserIDs, $oDocument, $sComment = "", $bAttachDocument, &$aEmailErrors) {
global $default;
// loop through users
for ($i=0; $i<count($aUserIDs); $i++) {
if ($aUserIDs[$i] > 0) {
$oDestUser = User::get($aUserIDs[$i]);
$default->log->info("sendingEmail to user " . $oDestUser->getName() . " with email " . $oDestUser->getEmail());
// the user has an email address and has email notification enabled
if (strlen($oDestUser->getEmail())>0 && $oDestUser->getEmailNotification()) {
//if the to address is valid, send the mail
if (validateEmailAddress($oDestUser->getEmail())) {
sendEmail($oDestUser->getEmail(), $oDestUser->getName(), $oDocument->getID(), $oDocument->getName(), $sComment, $bAttachDocument, $aEmailErrors);
}
} else {
$default->log->info("either " . $oDestUser->getUserName() . " has no email address, or notification is not enabled");
}
} else {
$default->log->info("filtered user id=" . $aUserIDs[$i]);
}
}
}
/**
* Sends emails to the manually entered email addresses
*/
function sendManualEmails($aEmailAddresses, $oDocument, $sComment = "", $bAttachDocument, &$aEmailErrors) {
global $default;
// loop through users
foreach ($aEmailAddresses as $sEmailAddress) {
$default->log->info("sendingEmail to address " . $sEmailAddress);
if (validateEmailAddress($sEmailAddress)) {
sendEmail($sEmailAddress, $sEmailAddress, $oDocument->getID(), $oDocument->getName(), $sComment, $bAttachDocument, $aEmailErrors);
}
}
}
/**
* Constructs the email message text and sends the message
*/
function sendEmail($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment, $bAttachDocument = false, &$aEmailErrors) {
if ($bAttachDocument !== true) {
return sendEmailHyperlink($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment, $aEmailErrors);
} else {
return sendEmailDocument($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment, $aEmailErrors);
}
}
function sendEmailDocument($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment, &$aEmailErrors) {
global $default;
$oSendingUser = User::get($_SESSION["userID"]);
$sMessage = 'Your colleague, ' . $oSendingUser->getName() . ', wishes you to view the attached document entitled "' . $sDocumentName . '".';
$sMessage .= "\n\n";
if (strlen($sComment) > 0) {
$sMessage .= "<br><br>Comments:<br>$sComment";
}
$sTitle = "Document: " . $sDocumentName . " from " . $oSendingUser->getName();
$oEmail = new Email();
$oDocument = Document::get($iDocumentID);
// Request a standard file path so that it can be attached to the
// email
$oStorage =& KTStorageManagerUtil::getSingleton();
$sDocumentPath = $oStorage->temporaryFile($oDocument);
$sDocumentFileName = $oDocument->getFileName();
$res = $oEmail->sendAttachment($sDestEmailAddress, $sTitle, $sMessage, $sDocumentPath, $sDocumentFileName);
// Tell the storage we don't need the temporary file anymore.
$oStorage->freeTemporaryFile($sDocumentPath);
if (PEAR::isError($res)) {
$default->log->error($res->getMessage());
$aEmailErrors[] = $res->getMessage();
return $res;
} else if ($res === false) {
$default->log->error("Error sending email ($sTitle) to $sDestEmailAddress");
$aEmailErrors[] = "Error sending email ($sTitle) to $sDestEmailAddress";
return PEAR::raiseError("Error sending email ($sTitle) to $sDestEmailAddress");
} else {
$default->log->info("Send email ($sTitle) to $sDestEmailAddress");
}
// emailed link transaction
$oDocumentTransaction = & new DocumentTransaction($oDocument, "Document link emailed to " . $sDestEmailAddress, 'ktcore.transactions.email_attachment');
if ($oDocumentTransaction->create()) {
$default->log->debug("emailBL.php created email link document transaction for document ID=$iDocumentID");
} else {
$default->log->error("emailBL.php couldn't create email link document transaction for document ID=$iDocumentID");
}
}
function sendEmailHyperlink($sDestEmailAddress, $sDestUserName, $iDocumentID, $sDocumentName, $sComment, &$aEmailErrors) {
global $default;
$oSendingUser = User::get($_SESSION["userID"]);
$sMessage = "<font face=\"arial\" size=\"2\">";
if ($sDestUserName) {
$sMessage .= $sDestUserName . ",<br><br>";
}
$sMessage .= "Your colleague, " . $oSendingUser->getName() . ", wishes you to view the document entitled '" . $sDocumentName . "'.\n ";
$sMessage .= "Click on the hyperlink below to view it.";
// add the link to the document to the mail
$sMessage .= "<br>" . generateControllerLink("viewDocument", "fDocumentID=$iDocumentID", $sDocumentName);
// add optional comment
if (strlen($sComment) > 0) {
$sMessage .= "<br><br>Comments:<br>$sComment";
}
$sMessage .= "</font>";
$sTitle = "Link: " . $sDocumentName . " from " . $oSendingUser->getName();
//email the hyperlink
$oEmail = new Email();
$res = $oEmail->send($sDestEmailAddress, $sTitle, $sMessage);
if (PEAR::isError($res)) {
$default->log->error($res->getMessage());
$aEmailErrors[] = $res->getMessage();
return $res;
} else if ($res === false) {
$default->log->error("Error sending email ($sTitle) to $sDestEmailAddress");
$aEmailErrors[] = "Error sending email ($sTitle) to $sDestEmailAddress";
return PEAR::raiseError("Error sending email ($sTitle) to $sDestEmailAddress");
} else {
$default->log->info("Send email ($sTitle) to $sDestEmailAddress");
}
// emailed link transaction
// need a document to do this.
$oDocument =& Document::get($iDocumentID);
$oDocumentTransaction = & new DocumentTransaction($oDocument, "Document link emailed to " . $sDestEmailAddress, 'ktcore.transactions.email_link');
if ($oDocumentTransaction->create()) {
$default->log->debug("emailBL.php created email link document transaction for document ID=$iDocumentID");
} else {
$default->log->error("emailBL.php couldn't create email link document transaction for document ID=$iDocumentID");
}
}
function validateEmailAddress($sEmailAddress) {
$aEmailAddresses = array();
if (strpos($sEmailAddress, ";")) {
$aEmailAddresses = explode(";", $sEmailAddress);
} else {
$aEmailAddresses[] = $sEmailAddress;
}
$bToReturn = true;
for ($i=0; $i<count($aEmailAddresses); $i++) {
$bResult = ereg ("^[^@ ]+@[^@ ]+\.[^@ \.]+$", $aEmailAddresses[$i] );
$bToReturn = $bToReturn && $bResult;
}
return $bToReturn;
}
class KTDocumentEmailAction extends KTDocumentAction {
var $sName = 'ktcore.actions.document.email';
function getDisplayName() {
return _('Email');
}
function do_main() {
$oTemplate =& $this->oValidator->validateTemplate('ktstandard/action/email');
$fields = array();
$oConfig = KTConfig::getSingleton();
$bAttachment = $oConfig->get('email/allowAttachment', false);
$bEmailAddresses = $oConfig->get('email/allowEmailAddresses', false);
if ($bAttachment) {
$fields[] = new KTCheckboxWidget(_("Attach document"), _("By default, documents are sent as links into the document management system. Select this option if you want the document contents to be sent as an attachment in the email."), 'fAttachDocument', null, $this->oPage);
}
if ($bEmailAddresses) {
$fields[] = new KTTextWidget(_("Email addresses"), _("Add extra email addresses here"), 'fEmailAddresses', "", $this->oPage);
}
$fields[] = new KTTextWidget(_("Comment"), _("A message for those who receive the document"), 'fComment', "", $this->oPage, true);
$aGroups = Group::getList();
$aUsers = User::getEmailUsers();
$aTemplateData = array(
'context' => &$this,
'fields' => $fields,
'groups' => $aGroups,
'users' => $aUsers,
);
return $oTemplate->render($aTemplateData);
}
function do_email() {
$groupNewRight = trim($_REQUEST['groupNewRight'], chr(160));
$userNewRight = trim($_REQUEST['userNewRight'], chr(160));
$fEmailAddresses = trim($_REQUEST['fEmailAddresses']);
$fAttachDocument = $_REQUEST['fAttachDocument'];
$fComment = $this->oValidator->validateString($_REQUEST['fComment'],
array('redirect_to'=>array('', sprintf('fDocumentId=%d', $this->oDocument->getId()))));
// explode group and user ids
$aGroupIDs = array();
$aUserIDs = array();
$aEmailAddresses = array();
if (!empty($groupNewRight)) {
$aGroupIDs = explode(",", $groupNewRight);
}
if (!empty($userNewRight)) {
$aUserIDs = explode(",", $userNewRight);
}
if (!empty($fEmailAddresses)) {
$aEmailAddresses = explode(" ", $fEmailAddresses);
}
$oConfig = KTConfig::getSingleton();
$bAttachment = $oConfig->get('email/allowAttachment', false);
$bEmailAddresses = $oConfig->get('email/allowEmailAddresses', false);
if (empty($bAttachment)) {
$fAttachDocument = false;
}
if (empty($bEmailAddresses)) {
$aEmailAddresses = array();
}
//if we're going to send a mail, first make there is someone to send it to
if ((count($aGroupIDs) == 0) && (count($aUserIDs) == 0) && (count($aEmailAddresses) == 0)) {
$this->errorRedirectToMain(_('No recipients set'), sprintf('fDocumentId=%d', $this->oDocument->getId()));
exit(0);
}
$aEmailErrors = array();
// send group emails
sendGroupEmails($aGroupIDs, $this->oDocument, $fComment, (boolean)$fAttachDocument, $aEmailErrors);
// send user emails
sendUserEmails($aUserIDs, $this->oDocument, $fComment, (boolean)$fAttachDocument, $aEmailErrors);
// send manual email addresses
sendManualEmails($aEmailAddresses, $this->oDocument, $fComment, (boolean)$fAttachDocument, $aEmailErrors);
if (count($aEmailErrors)) {
$_SESSION['KTErrorMessage'][] = join("<br />\n", $aEmailErrors);
}
$_SESSION['KTInfoMessage'][] = _("Email sent");
//go back to the document view page
controllerRedirect("viewDocument", sprintf("fDocumentId=%d", $this->oDocument->getId()));
}
}
class KTEmailPlugin extends KTPlugin {
var $sNamespace = "ktstandard.email.plugin";
function setup() {
$this->registerAction('documentaction', 'KTDocumentEmailAction', 'ktcore.actions.document.email');
}
}
$oRegistry =& KTPluginRegistry::getSingleton();
$oRegistry->registerPlugin('KTEmailPlugin', 'ktstandard.email.plugin', __FILE__);