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