3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * Plugin for sending email reminders about various things
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2011 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Email reminder plugin
42 * @author Zach Copley <zach@status.net>
43 * @copyright 2011 StatusNet, Inc.
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
45 * @link http://status.net/
47 class EmailReminderPlugin extends Plugin
50 * Set up email_reminder table
55 * @return boolean hook value; true means continue processing, false means stop.
57 function onCheckSchema()
59 $schema = Schema::get();
60 $schema->ensureTable('email_reminder', Email_reminder::schemaDef());
65 * Load related modules when needed
67 * @param string $cls Name of the class to be loaded
69 * @return boolean hook value; true means continue processing, false
72 function onAutoload($cls) {
73 $base = dirname(__FILE__);
74 $lower = strtolower($cls);
76 $files = array("$base/classes/$cls.php",
77 "$base/lib/$lower.php");
78 if (substr($lower, -6) == 'action') {
79 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
81 foreach ($files as $file) {
82 if (file_exists($file)) {
91 * Register our queue handlers
93 * @param QueueManager $qm Current queue manager
95 * @return boolean hook value
97 function onEndInitializeQueueManager($qm)
99 $qm->connect('siterem', 'SiteConfirmReminderHandler');
100 $qm->connect('uregrem', 'UserConfirmRegReminderHandler');
101 $qm->connect('uinvrem', 'UserInviteReminderHandler');
106 function onEndDocFileForTitle($title, $paths, &$filename)
108 if (empty($filename)) {
109 $filename = dirname(__FILE__) . '/mail-src/' . $title;
118 * @param type $object
119 * @param type $subject
122 static function sendReminder($type, $object, $subject, $day)
124 common_debug("QQQQQ sendReminder() enter ... ", __FILE__);
126 $title = "{$type}-{$day}";
128 common_debug("QQQQ title = {$title}", __FILE__);
130 // Record the fact that we sent a reminder
131 if (self::sendReminderEmail($type, $object, $subject, $title)) {
132 common_debug("Recording reminder record for {$object->address}", __FILE__);
134 Email_reminder::recordReminder($type, $object, $day);
135 } catch (Exception $e) {
137 common_log(LOG_ERR, $e->getMessage(), __FILE__);
141 common_debug("QQQQQ sendReminder() exit ... ", __FILE__);
148 * @param type $object
149 * @param type $subject
153 static function sendReminderEmail($type, $object, $subject, $title=null) {
155 $sitename = common_config('site', 'name');
156 $recipients = array($object->address);
160 if ($type == UserInviteReminderHandler::INVITE_REMINDER) {
161 $user = User::staticGet($object->user_id);
163 $profile = $user->getProfile();
164 $inviter = $profile->getBestName();
165 $inviterUrl = $profile->profileurl;
169 $headers['From'] = mail_notify_from();
170 $headers['To'] = trim($object->address);
171 // TRANS: Subject for confirmation e-mail.
172 // TRANS: %s is the StatusNet sitename.
173 $headers['Subject'] = $subject;
174 $headers['Content-Type'] = 'text/html; charset=UTF-8';
176 $confirmUrl = common_local_url('register', array('code' => $object->code));
178 $template = DocFile::forTitle($title, DocFile::mailPaths());
180 $body = $template->toHTML(
182 'confirmurl' => $confirmUrl,
183 'inviter' => $inviter,
184 'inviterurl' => $inviterUrl
185 // @todo private invitation message
189 return mail_send($recipients, $headers, $body);
194 * @param type $versions
197 function onPluginVersion(&$versions)
200 'name' => 'EmailReminder',
201 'version' => STATUSNET_VERSION,
202 'author' => 'Zach Copley',
203 'homepage' => 'http://status.net/wiki/Plugin:EmailReminder',
204 // TRANS: Plugin description.
205 'rawdescription' => _m('Send email reminders for various things.')