]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/GroupPrivateMessage/GroupPrivateMessagePlugin.php
plugins onAutoload now only overloads if necessary (extlibs etc.)
[quix0rs-gnu-social.git] / plugins / GroupPrivateMessage / GroupPrivateMessagePlugin.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2011, StatusNet, Inc.
5  *
6  * Private groups for StatusNet 0.9.x
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  Privacy
24  * @package   StatusNet
25  * @author    Evan Prodromou <evan@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/
29  */
30
31 if (!defined('STATUSNET')) {
32     // This check helps protect against security problems;
33     // your code file can't be executed directly from the web.
34     exit(1);
35 }
36
37 /**
38  * Private groups
39  *
40  * This plugin allows users to send private messages to a group.
41  *
42  * @category  Privacy
43  * @package   StatusNet
44  * @author    Evan Prodromou <evan@status.net>
45  * @copyright 2011 StatusNet, Inc.
46  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
47  * @link      http://status.net/
48  */
49 class GroupPrivateMessagePlugin extends Plugin
50 {
51     /**
52      * Database schema setup
53      *
54      * @see Schema
55      * @see ColumnDef
56      *
57      * @return boolean hook value
58      */
59     function onCheckSchema()
60     {
61         $schema = Schema::get();
62
63         // For storing user-submitted flags on profiles
64         $schema->ensureTable('group_privacy_settings', Group_privacy_settings::schemaDef());
65         $schema->ensureTable('group_message', Group_message::schemaDef());
66         $schema->ensureTable('group_message_profile', Group_message_profile::schemaDef());
67         return true;
68     }
69
70     /**
71      * Map URLs to actions
72      *
73      * @param Net_URL_Mapper $m path-to-action mapper
74      *
75      * @return boolean hook value
76      */
77     function onRouterInitialized($m)
78     {
79         $m->connect('group/:nickname/inbox',
80                     array('action' => 'groupinbox'),
81                     array('nickname' => Nickname::DISPLAY_FMT));
82
83         $m->connect('group/message/:id',
84                     array('action' => 'showgroupmessage'),
85                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
86
87         $m->connect('group/:nickname/message/new',
88                     array('action' => 'newgroupmessage'),
89                     array('nickname' => Nickname::DISPLAY_FMT));
90
91         return true;
92     }
93
94     /**
95      * Add group inbox to the menu
96      *
97      * @param Action $action The current action handler. Use this to
98      *                       do any output.
99      *
100      * @return boolean hook value; true means continue processing, false means stop.
101      *
102      * @see Action
103      */
104     function onEndGroupGroupNav($groupnav)
105     {
106         $action = $groupnav->action;
107         $group  = $groupnav->group;
108
109         $action->menuItem(common_local_url('groupinbox',
110                                            array('nickname' => $group->nickname)),
111                           // TRANS: Menu item in group page.
112                           _m('MENU','Inbox'),
113                           // TRANS: Menu title in group page.
114                           _m('Private messages for this group.'),
115                           $action->trimmed('action') == 'groupinbox',
116                           'nav_group_inbox');
117         return true;
118     }
119
120     /**
121      * Create default group privacy settings at group create time
122      *
123      * @param User_group $group Group that was just created
124      *
125      * @result boolean hook value
126      */
127     function onEndGroupSave($group)
128     {
129         $gps = new Group_privacy_settings();
130
131         $gps->group_id      = $group->id;
132         $gps->allow_privacy = Group_privacy_settings::SOMETIMES;
133         $gps->allow_sender  = Group_privacy_settings::MEMBER;
134         $gps->created       = common_sql_now();
135         $gps->modified      = $gps->created;
136
137         // This will throw an exception on error
138
139         $gps->insert();
140
141         return true;
142     }
143
144     /**
145      * Show group privacy controls on group edit form
146      *
147      * @param GroupEditForm $form form being shown
148      */
149     function onEndGroupEditFormData($form)
150     {
151         $gps = null;
152
153         if (!empty($form->group)) {
154             $gps = Group_privacy_settings::getKV('group_id', $form->group->id);
155         }
156
157         $form->out->elementStart('li');
158         $form->out->dropdown('allow_privacy',
159                              // TRANS: Dropdown label in group settings page for if group allows private messages.
160                              _m('Private messages'),
161                              // TRANS: Dropdown option in group settings page for allowing private messages.
162                              array(Group_privacy_settings::SOMETIMES => _m('Sometimes'),
163                                    // TRANS: Dropdown option in group settings page for allowing private messages.
164                                    Group_privacy_settings::ALWAYS => _m('Always'),
165                                    // TRANS: Dropdown option in group settings page for allowing private messages.
166                                    Group_privacy_settings::NEVER => _m('Never')),
167                              // TRANS: Dropdown title in group settings page for if group allows private messages.
168                              _m('Whether to allow private messages to this group.'),
169                              false,
170                              (empty($gps)) ? Group_privacy_settings::SOMETIMES : $gps->allow_privacy);
171         $form->out->elementEnd('li');
172         $form->out->elementStart('li');
173         $form->out->dropdown('allow_sender',
174                              // TRANS: Dropdown label in group settings page for who can send private messages to the group.
175                              _m('Private senders'),
176                              // TRANS: Dropdown option in group settings page for who can send private messages.
177                              array(Group_privacy_settings::EVERYONE => _m('Everyone'),
178                                    // TRANS: Dropdown option in group settings page for who can send private messages.
179                                    Group_privacy_settings::MEMBER => _m('Member'),
180                                    // TRANS: Dropdown option in group settings page for who can send private messages.
181                                    Group_privacy_settings::ADMIN => _m('Admin')),
182                              // TRANS: Dropdown title in group settings page for who can send private messages to the group.
183                              _m('Who can send private messages to the group.'),
184                              false,
185                              (empty($gps)) ? Group_privacy_settings::MEMBER : $gps->allow_sender);
186         $form->out->elementEnd('li');
187         return true;
188     }
189
190     function onEndGroupSaveForm($action)
191     {
192         $gps = null;
193
194         if (!empty($action->group)) {
195             $gps = Group_privacy_settings::getKV('group_id', $action->group->id);
196         }
197
198         $orig = null;
199
200         if (empty($gps)) {
201             $gps = new Group_privacy_settings();
202             $gps->group_id = $action->group->id;
203         } else {
204             $orig = clone($gps);
205         }
206
207         $gps->allow_privacy = $action->trimmed('allow_privacy');
208         $gps->allow_sender  = $action->trimmed('allow_sender');
209
210         if (empty($orig)) {
211             $gps->created = common_sql_now();
212             $gps->insert();
213         } else {
214             $gps->update($orig);
215         }
216
217         return true;
218     }
219
220     /**
221      * Overload 'd' command to send private messages to groups.
222      *
223      * 'd !group word word word' will send the private message
224      * 'word word word' to the group 'group'.
225      *
226      * @param string  $cmd     Command being run
227      * @param string  $arg     Rest of the message (including address)
228      * @param User    $user    User sending the message
229      * @param Command &$result The resulting command object to be run.
230      *
231      * @return boolean hook value
232      */
233     function onStartIntepretCommand($cmd, $arg, $user, &$result)
234     {
235         if ($cmd == 'd' || $cmd == 'dm') {
236
237             $this->debug('Got a d command');
238
239             // Break off the first word as the address
240
241             $pieces = explode(' ', $arg, 2);
242
243             if (count($pieces) == 1) {
244                 $pieces[] = null;
245             }
246
247             list($addr, $msg) = $pieces;
248
249             if (!empty($addr) && $addr[0] == '!') {
250                 $result = new GroupMessageCommand($user, substr($addr, 1), $msg);
251                 Event::handle('EndInterpretCommand', array($cmd, $arg, $user, $result));
252                 return false;
253             }
254         }
255
256         return true;
257     }
258
259     /**
260      * To add a "Message" button to the group profile page
261      *
262      * @param Widget     $widget The showgroup action being shown
263      * @param User_group $group  The current group
264      *
265      * @return boolean hook value
266      */
267     function onEndGroupActionsList($widget, $group)
268     {
269         $cur = common_current_user();
270         $action = $widget->out;
271
272         if (empty($cur)) {
273             return true;
274         }
275
276         try {
277             Group_privacy_settings::ensurePost($cur, $group);
278         } catch (Exception $e) {
279             return true;
280         }
281
282         $action->elementStart('li', 'entity_send-a-message');
283         $action->element('a', array('href' => common_local_url('newgroupmessage', array('nickname' => $group->nickname)),
284                                     // TRANS: Title for action in group actions list.
285                                     'title' => _m('Send a direct message to this group.')),
286                          // TRANS: Link text for action in group actions list to send a private message to a group.
287                          _m('LINKTEXT','Message'));
288         // $form = new GroupMessageForm($action, $group);
289         // $form->hidden = true;
290         // $form->show();
291         $action->elementEnd('li');
292         return true;
293     }
294
295     /**
296      * When saving a notice, check its groups. If any of them has
297      * privacy == always, force a group private message to all mentioned groups.
298      * If any of the groups disallows private messages, skip it.
299      *
300      * @param
301      */
302     function onStartNoticeSave(&$notice) {
303         // Look for group tags
304         // FIXME: won't work for remote groups
305         // @fixme if Notice::saveNew is refactored so we can just pull its list
306         // of groups between processing and saving, make use of it
307
308         $count = preg_match_all('/(?:^|\s)!(' . Nickname::DISPLAY_FMT . ')/',
309                                 strtolower($notice->content),
310                                 $match);
311
312         $groups = array();
313         $ignored = array();
314
315         $forcePrivate = false;
316         $profile = $notice->getProfile();
317
318         if ($count > 0) {
319             /* Add them to the database */
320
321             foreach (array_unique($match[1]) as $nickname) {
322                 $group = User_group::getForNickname($nickname, $profile);
323
324                 if (empty($group)) {
325                     continue;
326                 }
327
328                 $gps = Group_privacy_settings::forGroup($group);
329
330                 switch ($gps->allow_privacy) {
331                 case Group_privacy_settings::ALWAYS:
332                     $forcePrivate = true;
333                     // fall through
334                 case Group_privacy_settings::SOMETIMES:
335                     $groups[] = $group;
336                     break;
337                 case Group_privacy_settings::NEVER:
338                     $ignored[] = $group;
339                     break;
340                 }
341             }
342
343             if ($forcePrivate) {
344                 foreach ($ignored as $group) {
345                     common_log(LOG_NOTICE,
346                                "Notice forced to group direct message ".
347                                "but group ".$group->nickname." does not allow them.");
348                 }
349
350                 $user = User::getKV('id', $notice->profile_id);
351
352                 if (empty($user)) {
353                     common_log(LOG_WARNING,
354                                "Notice forced to group direct message ".
355                                "but profile ".$notice->profile_id." is not a local user.");
356                 } else {
357                     foreach ($groups as $group) {
358                         Group_message::send($user, $group, $notice->content);
359                     }
360                 }
361
362                 // Don't save the notice!
363                 // FIXME: this is probably cheating.
364                 // TRANS: Client exception thrown when a private group message has to be forced.
365                 throw new ClientException(sprintf(_m('Forced notice to private group message.')),
366                                           200);
367             }
368         }
369
370         return true;
371     }
372
373     /**
374      * Show an indicator that the group is (essentially) private on the group page
375      *
376      * @param Action     $action The action being shown
377      * @param User_group $group  The group being shown
378      *
379      * @return boolean hook value
380      */
381     function onEndGroupProfileElements($action, $group)
382     {
383         $gps = Group_privacy_settings::forGroup($group);
384
385         if ($gps->allow_privacy == Group_privacy_settings::ALWAYS) {
386             // TRANS: Indicator on the group page that the group is (essentially) private.
387             $action->element('p', 'privategroupindicator', _m('Private'));
388         }
389
390         return true;
391     }
392
393     function onStartShowExportData($action)
394     {
395         if ($action instanceof ShowgroupAction) {
396             $gps = Group_privacy_settings::forGroup($action->group);
397
398             if ($gps->allow_privacy == Group_privacy_settings::ALWAYS) {
399                 return false;
400             }
401         }
402         return true;
403     }
404
405     function onPluginVersion(&$versions)
406     {
407         $versions[] = array('name' => 'GroupPrivateMessage',
408                             'version' => STATUSNET_VERSION,
409                             'author' => 'Evan Prodromou',
410                             'homepage' => 'http://status.net/wiki/Plugin:GroupPrivateMessage',
411                             'rawdescription' =>
412                             // TRANS: Plugin description.
413                             _m('Allow posting private messages to groups.'));
414         return true;
415     }
416 }