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
  50 class FollowEveryonePlugin extends Plugin
  51 {
  52     /**
  53      * Called when a new user is registered.
  54      *
  55      * We find all users, and try to subscribe them to the new user, and
  56      * the new user to them. Exceptions (like silenced users or whatever)
  57      * are caught, logged, and ignored.
  58      *
  59      * @param Profile &$newProfile The new user's profile
  60      * @param User    &$newUser    The new user
  61      *
  62      * @return boolean hook value
  63      *
  64      */
  65
  66     function onEndUserRegister(&$newProfile, &$newUser)
  67     {
  68         $otherUser = new User();
  69         $otherUser->whereAdd('id != ' . $newUser->id);
  70
  71         if ($otherUser->find()) {
  72             while ($otherUser->fetch()) {
  73                 $otherProfile = $otherUser->getProfile();
  74                 try {
  75                     if (User_followeveryone_prefs::followEveryone($otherUser->id)) {
  76                         Subscription::start($otherProfile, $newProfile);
  77                     }
  78                     Subscription::start($newProfile, $otherProfile);
  79                 } catch (Exception $e) {
  80                     common_log(LOG_WARNING, $e->getMessage());
  81                     continue;
  82                 }
  83             }
  84         }
  85
  86         $ufep = new User_followeveryone_prefs();
  87
  88         $ufep->user_id        = $newUser->id;
  89         $ufep->followeveryone = true;
  90
  91         $ufep->insert();
  92
  93         return true;
  94     }
  95
  96     /**
  97      * Database schema setup
  98      *
  99      * Plugins can add their own tables to the StatusNet database. Plugins
 100      * should use StatusNet's schema interface to add or delete tables. The
 101      * ensureTable() method provides an easy way to ensure a table's structure
 102      * and availability.
 103      *
 104      * By default, the schema is checked every time StatusNet is run (say, when
 105      * a Web page is hit). Admins can configure their systems to only check the
 106      * schema when the checkschema.php script is run, greatly improving performance.
 107      * However, they need to remember to run that script after installing or
 108      * upgrading a plugin!
 109      *
 110      * @see Schema
 111      * @see ColumnDef
 112      *
 113      * @return boolean hook value; true means continue processing, false means stop.
 114      */
 115
 116     function onCheckSchema()
 117     {
 118         $schema = Schema::get();
 119
 120         // For storing user-submitted flags on profiles
 121
 122         $schema->ensureTable('user_followeveryone_prefs',
 123                              array(new ColumnDef('user_id', 'integer', null,
 124                                                  true, 'PRI'),
 125                                    new ColumnDef('followeveryone', 'tinyint', null,
 126                                                  false, null, 1)));
 127
 128         return true;
 129     }
 130
 131     /**
 132      * Load related modules when needed
 133      *
 134      * @param string $cls Name of the class to be loaded
 135      *
 136      * @return boolean hook value; true means continue processing, false means stop.
 137      */
 138
 139     function onAutoload($cls)
 140     {
 141         $dir = dirname(__FILE__);
 142
 143         switch ($cls)
 144         {
 145         case 'User_followeveryone_prefs':
 146             include_once $dir . '/'.$cls.'.php';
 147             return false;
 148         default:
 149             return true;
 150         }
 151     }
 152
 153     /**
 154      * Provide version information about this plugin.
 155      *
 156      * @param Array &$versions Array of version data
 157      *
 158      * @return boolean hook value
 159      *
 160      */
 161
 162     function onPluginVersion(&$versions)
 163     {
 164         $versions[] = array('name' => 'FollowEveryone',
 165                             'version' => STATUSNET_VERSION,
 166                             'author' => 'Evan Prodromou',
 167                             'homepage' => 'http://status.net/wiki/Plugin:FollowEveryone',
 168                             'rawdescription' =>
 169                             _m('New users follow everyone at registration and are followed in return.'));
 170         return true;
 171     }
 172 }