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',
59 array(new ColumnDef('user_id', 'integer', null,
61 new ColumnDef('send_summary', 'tinyint', null,
63 new ColumnDef('last_summary_id', 'integer', null,
65 new ColumnDef('created', 'datetime', null,
67 new ColumnDef('modified', 'datetime', null,
75 * Load related modules when needed
77 * @param string $cls Name of the class to be loaded
79 * @return boolean hook value; true means continue processing, false means stop.
82 function onAutoload($cls)
84 $dir = dirname(__FILE__);
88 case 'SiteEmailSummaryHandler':
89 case 'UserEmailSummaryHandler':
90 include_once $dir . '/'.strtolower($cls).'.php';
92 case 'Email_summary_status':
93 include_once $dir . '/'.$cls.'.php';
101 * Version info for this plugin
103 * @param array &$versions array of version data
105 * @return boolean hook value; true means continue processing, false means stop.
107 function onPluginVersion(&$versions)
109 $versions[] = array('name' => 'EmailSummary',
110 'version' => STATUSNET_VERSION,
111 'author' => 'Evan Prodromou',
112 'homepage' => 'http://status.net/wiki/Plugin:EmailSummary',
114 // TRANS: Plugin description.
115 _m('Send an email summary of the inbox to users.'));
120 * Register our queue handlers
122 * @param QueueManager $qm Current queue manager
124 * @return boolean hook value
126 function onEndInitializeQueueManager($qm)
128 $qm->connect('sitesum', 'SiteEmailSummaryHandler');
129 $qm->connect('usersum', 'UserEmailSummaryHandler');
134 * Add a checkbox to turn off email summaries
136 * @param Action $action Action being executed (emailsettings)
138 * @return boolean hook value
140 function onEndEmailFormData($action)
142 $user = common_current_user();
144 $action->elementStart('li');
145 $action->checkbox('emailsummary',
146 // TRANS: Checkbox label in e-mail preferences form.
147 _m('Send me a periodic summary of updates from my network'),
148 Email_summary_status::getSendSummary($user->id));
149 $action->elementEnd('li');
154 * Add a checkbox to turn off email summaries
156 * @param Action $action Action being executed (emailsettings)
158 * @return boolean hook value
160 function onEndEmailSaveForm($action)
162 $sendSummary = $action->boolean('emailsummary');
164 $user = common_current_user();
168 $ess = Email_summary_status::staticGet('user_id', $user->id);
172 $ess = new Email_summary_status();
174 $ess->user_id = $user->id;
175 $ess->send_summary = $sendSummary;
176 $ess->created = common_sql_now();
177 $ess->modified = common_sql_now();
185 $ess->send_summary = $sendSummary;
186 $ess->modified = common_sql_now();