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                     Subscription::start($otherProfile, $newProfile);
  76                     Subscription::start($newProfile, $otherProfile);
  77                 } catch (Exception $e) {
  78                     common_log(LOG_WARNING, $e->getMessage());
  79                     continue;
  80                 }
  81             }
  82         }
  83
  84         return true;
  85     }
  86
  87     /**
  88      * Provide version information about this plugin.
  89      *
  90      * @param Array &$versions Array of version data
  91      *
  92      * @return boolean hook value
  93      *
  94      */
  95
  96     function onPluginVersion(&$versions)
  97     {
  98         $versions[] = array('name' => 'FollowEveryone',
  99                             'version' => STATUSNET_VERSION,
 100                             'author' => 'Evan Prodromou',
 101                             'homepage' => 'http://status.net/wiki/Plugin:FollowEveryone',
 102                             'rawdescription' =>
 103                             _m('New users follow everyone at registration and are followed in return.'));
 104         return true;
 105     }
 106 }