plugins/UserFlag/UserFlagPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Allows users to flag content and accounts as offensive/spam/whatever
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Allows users to flag content and accounts as offensive/spam/whatever
  36  *
  37  * @category Plugin
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43
  44 class UserFlagPlugin extends Plugin
  45 {
  46     const REVIEWFLAGS = 'UserFlagPlugin::reviewflags';
  47     const CLEARFLAGS  = 'UserFlagPlugin::clearflags';
  48
  49     public $flagOnBlock = true;
  50
  51     /**
  52      * Hook for ensuring our tables are created
  53      *
  54      * Ensures that the user_flag_profile table exists
  55      * and has the right columns.
  56      *
  57      * @return boolean hook return
  58      */
  59
  60     function onCheckSchema()
  61     {
  62         $schema = Schema::get();
  63
  64         // For storing user-submitted flags on profiles
  65
  66         $schema->ensureTable('user_flag_profile',
  67                              array(new ColumnDef('profile_id', 'integer', null,
  68                                                  false, 'PRI'),
  69                                    new ColumnDef('user_id', 'integer', null,
  70                                                  false, 'PRI'),
  71                                    new ColumnDef('created', 'datetime', null,
  72                                                  false, 'MUL'),
  73                                    new ColumnDef('cleared', 'datetime', null,
  74                                                  true, 'MUL')));
  75
  76         return true;
  77     }
  78
  79     /**
  80      * Add our actions to the URL router
  81      *
  82      * @param Net_URL_Mapper $m URL mapper for this hit
  83      *
  84      * @return boolean hook return
  85      */
  86
  87     function onRouterInitialized($m)
  88     {
  89         $m->connect('main/flag/profile', array('action' => 'flagprofile'));
  90         $m->connect('main/flag/clear', array('action' => 'clearflag'));
  91         $m->connect('admin/profile/flag', array('action' => 'adminprofileflag'));
  92         return true;
  93     }
  94
  95     /**
  96      * Auto-load our classes if called
  97      *
  98      * @param string $cls Class to load
  99      *
 100      * @return boolean hook return
 101      */
 102
 103     function onAutoload($cls)
 104     {
 105         switch (strtolower($cls))
 106         {
 107         case 'flagprofileaction':
 108         case 'adminprofileflagaction':
 109         case 'clearflagaction':
 110             include_once INSTALLDIR.'/plugins/UserFlag/' .
 111               strtolower(mb_substr($cls, 0, -6)) . '.php';
 112             return false;
 113         case 'flagprofileform':
 114         case 'clearflagform':
 115             include_once INSTALLDIR.'/plugins/UserFlag/' . strtolower($cls . '.php');
 116             return false;
 117         case 'user_flag_profile':
 118             include_once INSTALLDIR.'/plugins/UserFlag/'.ucfirst(strtolower($cls)).'.php';
 119             return false;
 120         default:
 121             return true;
 122         }
 123     }
 124
 125     /**
 126      * Add a 'flag' button to profile page
 127      *
 128      * @param Action  &$action The action being called
 129      * @param Profile $profile Profile being shown
 130      *
 131      * @return boolean hook result
 132      */
 133
 134     function onEndProfilePageActionsElements(&$action, $profile)
 135     {
 136         $user = common_current_user();
 137
 138         if (!empty($user) && ($user->id != $profile->id)) {
 139
 140             $action->elementStart('li', 'entity_flag');
 141
 142             if (User_flag_profile::exists($profile->id, $user->id)) {
 143                 $action->element('p', 'flagged', _('Flagged'));
 144             } else {
 145                 $form = new FlagProfileForm($action, $profile,
 146                                             array('action' => 'showstream',
 147                                                   'nickname' => $profile->nickname));
 148                 $form->show();
 149             }
 150
 151             $action->elementEnd('li');
 152         }
 153
 154         return true;
 155     }
 156
 157     /**
 158      * Add a 'flag' button to profiles in a list
 159      *
 160      * @param ProfileListItem $item item being shown
 161      *
 162      * @return boolean hook result
 163      */
 164
 165     function onEndProfileListItemActionElements($item)
 166     {
 167         $user = common_current_user();
 168
 169         if (!empty($user)) {
 170
 171             list($action, $args) = $item->action->returnToArgs();
 172
 173             $args['action'] = $action;
 174
 175             $form = new FlagProfileForm($item->action, $item->profile, $args);
 176
 177             $item->action->elementStart('li', 'entity_flag');
 178             $form->show();
 179             $item->action->elementEnd('li');
 180         }
 181
 182         return true;
 183     }
 184
 185     /**
 186      * Initialize any flagging buttons on the page
 187      *
 188      * @param Action $action action being shown
 189      *
 190      * @return boolean hook result
 191      */
 192
 193     function onEndShowScripts($action)
 194     {
 195         $action->inlineScript('if ($(".form_entity_flag").length > 0) { '.
 196                               '$(".form_entity_flag").bind("click", function() {'.
 197                               'SN.U.FormXHR($(this)); return false; }); }');
 198         return true;
 199     }
 200
 201     /**
 202      * Check whether a user has one of our defined rights
 203      *
 204      * We define extra rights; this function checks to see if a
 205      * user has one of them.
 206      *
 207      * @param User    $user    User being checked
 208      * @param string  $right   Right we're checking
 209      * @param boolean &$result out, result of the check
 210      *
 211      * @return boolean hook result
 212      */
 213
 214     function onUserRightsCheck($user, $right, &$result)
 215     {
 216         switch ($right) {
 217         case self::REVIEWFLAGS:
 218         case self::CLEARFLAGS:
 219             $result = $user->hasRole('moderator');
 220             return false; // done processing!
 221         }
 222
 223         return true; // unchanged!
 224     }
 225
 226     /**
 227      * Optionally flag profile when a block happens
 228      *
 229      * We optionally add a flag when a profile has been blocked
 230      *
 231      * @param User    $user    User doing the block
 232      * @param Profile $profile Profile being blocked
 233      *
 234      * @return boolean hook result
 235      */
 236
 237     function onEndBlockProfile($user, $profile)
 238     {
 239         if ($this->flagOnBlock && !User_flag_profile::exists($profile->id,
 240                                                              $user->id)) {
 241
 242             User_flag_profile::create($user->id, $profile->id);
 243         }
 244         return true;
 245     }
 246
 247     /**
 248      * Ensure that flag entries for a profile are deleted
 249      * along with the profile when deleting users.
 250      * This prevents breakage of the admin profile flag UI.
 251      *
 252      * @param Profile $profile
 253      * @param array &$related list of related tables; entries
 254      *              with matching profile_id will be deleted.
 255      *
 256      * @return boolean hook result
 257      */
 258
 259     function onProfileDeleteRelated($profile, &$related)
 260     {
 261         $related[] = 'user_flag_profile';
 262         return true;
 263     }
 264
 265     /**
 266      * Ensure that flag entries created by a user are deleted
 267      * when that user gets deleted.
 268      *
 269      * @param User $user
 270      * @param array &$related list of related tables; entries
 271      *              with matching user_id will be deleted.
 272      *
 273      * @return boolean hook result
 274      */
 275
 276     function onUserDeleteRelated($user, &$related)
 277     {
 278         $related[] = 'user_flag_profile';
 279         return true;
 280     }
 281 }