3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * Sends an email summary of the inbox to users in the network
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 Evan Prodromou <evan@status.net>
26 * @copyright 2010 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')) {
36 * Plugin for sending email summaries to users
40 * @author Brion Vibber <brionv@status.net>
41 * @author Evan Prodromou <evan@status.net>
42 * @copyright 2010 StatusNet, Inc.
43 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
44 * @link http://status.net/
46 class EmailSummaryPlugin extends Plugin
48 const PLUGIN_VERSION = '2.0.0';
50 * Database schema setup
52 * @return boolean hook value
54 function onCheckSchema()
56 $schema = Schema::get();
58 // For storing user-submitted flags on profiles
59 $schema->ensureTable('email_summary_status', Email_summary_status::schemaDef());
64 * Version info for this plugin
66 * @param array &$versions array of version data
68 * @return boolean hook value; true means continue processing, false means stop.
70 function onPluginVersion(array &$versions)
72 $versions[] = array('name' => 'EmailSummary',
73 'version' => self::PLUGIN_VERSION,
74 'author' => 'Evan Prodromou',
75 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/EmailSummary',
77 // TRANS: Plugin description.
78 _m('Send an email summary of the inbox to users.'));
83 * Register our queue handlers
85 * @param QueueManager $qm Current queue manager
87 * @return boolean hook value
89 function onEndInitializeQueueManager($qm)
91 $qm->connect('sitesum', 'SiteEmailSummaryHandler');
92 $qm->connect('usersum', 'UserEmailSummaryHandler');
97 * Add a checkbox to turn off email summaries
99 * @param Action $action Action being executed (emailsettings)
100 * @param Profile $scoped Profile for whom settings are configured (current user)
102 * @return boolean hook value
104 public function onEndEmailFormData(Action $action, Profile $scoped)
106 $action->elementStart('li');
107 $action->checkbox('emailsummary',
108 // TRANS: Checkbox label in e-mail preferences form.
109 _m('Send me a periodic summary of updates from my network'),
110 Email_summary_status::getSendSummary($scoped->id));
111 $action->elementEnd('li');
116 * Add a checkbox to turn off email summaries
118 * @param Action $action Action being executed (emailsettings)
119 * @param Profile $scoped Profile for whom settings are configured (current user)
121 * @return boolean hook value
123 public function onEndEmailSaveForm(Action $action, Profile $scoped)
125 $sendSummary = $action->boolean('emailsummary');
127 $ess = Email_summary_status::getKV('user_id', $scoped->id);
131 $ess = new Email_summary_status();
133 $ess->user_id = $scoped->id;
134 $ess->send_summary = $sendSummary;
135 $ess->created = common_sql_now();
136 $ess->modified = common_sql_now();
144 $ess->send_summary = $sendSummary;
145 $ess->modified = common_sql_now();