]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/EmailSummary/EmailSummaryPlugin.php
Maximum character limit with utf8mb4 is 191 in varchar
[quix0rs-gnu-social.git] / plugins / EmailSummary / EmailSummaryPlugin.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2010, StatusNet, Inc.
5  *
6  * Sends an email summary of the inbox to users in the network
7  *
8  * PHP version 5
9  *
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.
14  *
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.
19  *
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/>.
22  *
23  * @category  Sample
24  * @package   StatusNet
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/
29  */
30
31 if (!defined('STATUSNET')) {
32     exit(1);
33 }
34
35 /**
36  * Plugin for sending email summaries to users
37  *
38  * @category  Email
39  * @package   StatusNet
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/
45  */
46 class EmailSummaryPlugin extends Plugin
47 {
48     /**
49      * Database schema setup
50      *
51      * @return boolean hook value
52      */
53     function onCheckSchema()
54     {
55         $schema = Schema::get();
56
57         // For storing user-submitted flags on profiles
58         $schema->ensureTable('email_summary_status', Email_summary_status::schemaDef());
59         return true;
60     }
61
62     /**
63      * Version info for this plugin
64      *
65      * @param array &$versions array of version data
66      *
67      * @return boolean hook value; true means continue processing, false means stop.
68      */
69     function onPluginVersion(array &$versions)
70     {
71         $versions[] = array('name' => 'EmailSummary',
72                             'version' => GNUSOCIAL_VERSION,
73                             'author' => 'Evan Prodromou',
74                             'homepage' => 'http://status.net/wiki/Plugin:EmailSummary',
75                             'rawdescription' =>
76                             // TRANS: Plugin description.
77                             _m('Send an email summary of the inbox to users.'));
78         return true;
79     }
80
81     /**
82      * Register our queue handlers
83      *
84      * @param QueueManager $qm Current queue manager
85      *
86      * @return boolean hook value
87      */
88     function onEndInitializeQueueManager($qm)
89     {
90         $qm->connect('sitesum', 'SiteEmailSummaryHandler');
91         $qm->connect('usersum', 'UserEmailSummaryHandler');
92         return true;
93     }
94
95     /**
96      * Add a checkbox to turn off email summaries
97      *
98      * @param Action $action Action being executed (emailsettings)
99      * @param Profile $scoped Profile for whom settings are configured (current user)
100      *
101      * @return boolean hook value
102      */
103     public function onEndEmailFormData(Action $action, Profile $scoped)
104     {
105         $action->elementStart('li');
106         $action->checkbox('emailsummary',
107                           // TRANS: Checkbox label in e-mail preferences form.
108                           _m('Send me a periodic summary of updates from my network'),
109                           Email_summary_status::getSendSummary($scoped->id));
110         $action->elementEnd('li');
111         return true;
112     }
113
114     /**
115      * Add a checkbox to turn off email summaries
116      *
117      * @param Action $action Action being executed (emailsettings)
118      * @param Profile $scoped Profile for whom settings are configured (current user)
119      *
120      * @return boolean hook value
121      */
122     public function onEndEmailSaveForm(Action $action, Profile $scoped)
123     {
124         $sendSummary = $action->boolean('emailsummary');
125
126         $ess = Email_summary_status::getKV('user_id', $scoped->id);
127
128         if (empty($ess)) {
129
130             $ess = new Email_summary_status();
131
132             $ess->user_id      = $scoped->id;
133             $ess->send_summary = $sendSummary;
134             $ess->created      = common_sql_now();
135             $ess->modified     = common_sql_now();
136
137             $ess->insert();
138
139         } else {
140
141             $orig = clone($ess);
142
143             $ess->send_summary = $sendSummary;
144             $ess->modified     = common_sql_now();
145
146             $ess->update($orig);
147         }
148
149         return true;
150     }
151 }