]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/AutoSandbox/AutoSandboxPlugin.php
Events on user registrations now strictly typed
[quix0rs-gnu-social.git] / plugins / AutoSandbox / AutoSandboxPlugin.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Plugin to automatically sandbox newly registered users in an effort to beat
6  * spammers. If the user proves to be legitimate, moderators can un-sandbox them.
7  *
8  * PHP version 5
9  *
10  * LICENCE: 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  Plugin
24  * @package   StatusNet
25  * @author    Sean Carmody<seancarmody@gmail.com>
26  * @copyright 2010
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28  * @link      http://status.net/
29  */
30
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
32     exit(1);
33 }
34
35 define('AUTOSANDBOX', '0.1');
36
37 //require_once(INSTALLDIR.'/plugins/AutoSandbox/autosandbox.php');
38
39 class AutoSandboxPlugin extends Plugin
40 {
41     var $contact;
42     var $debug;
43
44     function onInitializePlugin()
45     {
46         if(!isset($this->debug))
47         {
48             $this->debug = 0;
49         }
50
51         if(!isset($this->contact)) {
52            $default = common_config('newuser', 'default');
53            if (!empty($default)) {
54                $this->contact = $default;
55            }
56         }
57     }
58
59     function onPluginVersion(&$versions)
60     {
61         $versions[] = array('name' => 'AutoSandbox',
62                             'version' => STATUSNET_VERSION,
63                             'author' => 'Sean Carmody',
64                             'homepage' => 'http://status.net/wiki/Plugin:AutoSandbox',
65                             'rawdescription' =>
66                             // TRANS: Plugin description.
67                             _m('Automatically sandboxes newly registered members.'));
68         return true;
69     }
70
71     function onStartRegistrationFormData($action)
72     {
73          // TRANS: User instructions after registration.
74          $instr = _m('Note you will initially be "sandboxed" so your posts will not appear in the public timeline.');
75
76          if (isset($this->contact)) {
77              $contactuser = User::getKV('nickname', $this->contact);
78              if (!empty($contactuser)) {
79                  $contactlink = "@<a href=\"$contactuser->uri\">$contactuser->nickname</a>";
80                  // TRANS: User instructions after registration.
81                  // TRANS: %s is a clickable e-mailaddress.
82                  $instr = sprintf(_m('Note you will initially be "sandboxed" so your posts will not appear in the public timeline. '.
83                    'Send a message to %s to speed up the unsandboxing process.'),$contactlink);
84              }
85          }
86
87          $output = common_markup_to_html($instr);
88          $action->elementStart('div', 'instructions');
89          $action->raw($output);
90          $action->elementEnd('div');
91     }
92
93     public function onEndUserRegister(Profile $profile)
94     {
95         $profile->sandbox();
96         if ($this->debug) {
97             common_log(LOG_WARNING, "AutoSandbox: sandboxed of $profile->nickname");
98         }
99     }
100 }