plugins/FollowEveryone/FollowEveryonePlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * When a new user registers, all existing users follow them automatically.
   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  Community
  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     // 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  * Plugin to make all users follow each other at registration
  39  *
  40  * Users can unfollow afterwards if they want.
  41  *
  42  * @category  Sample
  43  * @package   StatusNet
  44  * @author    Evan Prodromou <evan@status.net>
  45  * @copyright 2010 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 FollowEveryonePlugin extends Plugin
  50 {
  51     /**
  52      * Called when a new user is registered.
  53      *
  54      * We find all users, and try to subscribe them to the new user, and
  55      * the new user to them. Exceptions (like silenced users or whatever)
  56      * are caught, logged, and ignored.
  57      *
  58      * @param Profile &$newProfile The new user's profile
  59      * @param User    &$newUser    The new user
  60      *
  61      * @return boolean hook value
  62      *
  63      */
  64     function onEndUserRegister(&$newProfile, &$newUser)
  65     {
  66         $otherUser = new User();
  67         $otherUser->whereAdd('id != ' . $newUser->id);
  68
  69         if ($otherUser->find()) {
  70             while ($otherUser->fetch()) {
  71                 $otherProfile = $otherUser->getProfile();
  72                 try {
  73                     if (User_followeveryone_prefs::followEveryone($otherUser->id)) {
  74                         Subscription::start($otherProfile, $newProfile);
  75                     }
  76                     Subscription::start($newProfile, $otherProfile);
  77                 } catch (Exception $e) {
  78                     common_log(LOG_WARNING, $e->getMessage());
  79                     continue;
  80                 }
  81             }
  82         }
  83
  84         $ufep = new User_followeveryone_prefs();
  85
  86         $ufep->user_id        = $newUser->id;
  87         $ufep->followeveryone = true;
  88
  89         $ufep->insert();
  90
  91         return true;
  92     }
  93
  94     /**
  95      * Database schema setup
  96      *
  97      * Plugins can add their own tables to the StatusNet database. Plugins
  98      * should use StatusNet's schema interface to add or delete tables. The
  99      * ensureTable() method provides an easy way to ensure a table's structure
 100      * and availability.
 101      *
 102      * By default, the schema is checked every time StatusNet is run (say, when
 103      * a Web page is hit). Admins can configure their systems to only check the
 104      * schema when the checkschema.php script is run, greatly improving performance.
 105      * However, they need to remember to run that script after installing or
 106      * upgrading a plugin!
 107      *
 108      * @see Schema
 109      * @see ColumnDef
 110      *
 111      * @return boolean hook value; true means continue processing, false means stop.
 112      */
 113     function onCheckSchema()
 114     {
 115         $schema = Schema::get();
 116
 117         // For storing user-submitted flags on profiles
 118
 119         $schema->ensureTable('user_followeveryone_prefs',
 120                              array(new ColumnDef('user_id', 'integer', null,
 121                                                  true, 'PRI'),
 122                                    new ColumnDef('followeveryone', 'tinyint', null,
 123                                                  false, null, 1)));
 124
 125         return true;
 126     }
 127
 128     /**
 129      * Load related modules when needed
 130      *
 131      * @param string $cls Name of the class to be loaded
 132      *
 133      * @return boolean hook value; true means continue processing, false means stop.
 134      */
 135     function onAutoload($cls)
 136     {
 137         $dir = dirname(__FILE__);
 138
 139         switch ($cls)
 140         {
 141         case 'User_followeveryone_prefs':
 142             include_once $dir . '/'.$cls.'.php';
 143             return false;
 144         default:
 145             return true;
 146         }
 147     }
 148
 149     /**
 150      * Show a checkbox on the profile form to ask whether to follow everyone
 151      *
 152      * @param Action $action The action being executed
 153      *
 154      * @return boolean hook value
 155      */
 156     function onEndProfileFormData($action)
 157     {
 158         $user = common_current_user();
 159
 160         $action->elementStart('li');
 161         // TRANS: Checkbox label in form for profile settings.
 162         $action->checkbox('followeveryone', _('Follow everyone'),
 163                           ($action->arg('followeveryone')) ?
 164                           $action->arg('followeveryone') :
 165                           User_followeveryone_prefs::followEveryone($user->id));
 166         $action->elementEnd('li');
 167
 168         return true;
 169     }
 170
 171     /**
 172      * Save checkbox value for following everyone
 173      *
 174      * @param Action $action The action being executed
 175      *
 176      * @return boolean hook value
 177      */
 178     function onEndProfileSaveForm($action)
 179     {
 180         $user = common_current_user();
 181
 182         User_followeveryone_prefs::savePref($user->id,
 183                                             $action->boolean('followeveryone'));
 184
 185         return true;
 186     }
 187
 188     /**
 189      * Provide version information about this plugin.
 190      *
 191      * @param Array &$versions Array of version data
 192      *
 193      * @return boolean hook value
 194      *
 195      */
 196     function onPluginVersion(&$versions)
 197     {
 198         $versions[] = array('name' => 'FollowEveryone',
 199                             'version' => STATUSNET_VERSION,
 200                             'author' => 'Evan Prodromou',
 201                             'homepage' => 'http://status.net/wiki/Plugin:FollowEveryone',
 202                             'rawdescription' =>
 203                             _m('New users follow everyone at registration and are followed in return.'));
 204         return true;
 205     }
 206 }