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