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
49 * Database schema setup
51 * @return boolean hook value
53 function onCheckSchema()
55 $schema = Schema::get();
57 // For storing user-submitted flags on profiles
58 $schema->ensureTable('email_summary_status', Email_summary_status::schemaDef());
63 * Load related modules when needed
65 * @param string $cls Name of the class to be loaded
67 * @return boolean hook value; true means continue processing, false means stop.
70 function onAutoload($cls)
72 $dir = dirname(__FILE__);
76 case 'SiteEmailSummaryHandler':
77 case 'UserEmailSummaryHandler':
78 include_once $dir . '/'.strtolower($cls).'.php';
80 case 'Email_summary_status':
81 include_once $dir . '/'.$cls.'.php';
89 * Version info for this plugin
91 * @param array &$versions array of version data
93 * @return boolean hook value; true means continue processing, false means stop.
95 function onPluginVersion(&$versions)
97 $versions[] = array('name' => 'EmailSummary',
98 'version' => STATUSNET_VERSION,
99 'author' => 'Evan Prodromou',
100 'homepage' => 'http://status.net/wiki/Plugin:EmailSummary',
102 // TRANS: Plugin description.
103 _m('Send an email summary of the inbox to users.'));
108 * Register our queue handlers
110 * @param QueueManager $qm Current queue manager
112 * @return boolean hook value
114 function onEndInitializeQueueManager($qm)
116 $qm->connect('sitesum', 'SiteEmailSummaryHandler');
117 $qm->connect('usersum', 'UserEmailSummaryHandler');
122 * Add a checkbox to turn off email summaries
124 * @param Action $action Action being executed (emailsettings)
126 * @return boolean hook value
128 function onEndEmailFormData($action)
130 $user = common_current_user();
132 $action->elementStart('li');
133 $action->checkbox('emailsummary',
134 // TRANS: Checkbox label in e-mail preferences form.
135 _m('Send me a periodic summary of updates from my network'),
136 Email_summary_status::getSendSummary($user->id));
137 $action->elementEnd('li');
142 * Add a checkbox to turn off email summaries
144 * @param Action $action Action being executed (emailsettings)
146 * @return boolean hook value
148 function onEndEmailSaveForm($action)
150 $sendSummary = $action->boolean('emailsummary');
152 $user = common_current_user();
156 $ess = Email_summary_status::getKV('user_id', $user->id);
160 $ess = new Email_summary_status();
162 $ess->user_id = $user->id;
163 $ess->send_summary = $sendSummary;
164 $ess->created = common_sql_now();
165 $ess->modified = common_sql_now();
173 $ess->send_summary = $sendSummary;
174 $ess->modified = common_sql_now();