3 * StatusNet, the distributed open-source microblogging tool
5 * Allows users to flag content and accounts as offensive/spam/whatever
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.
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.
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/>.
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/
30 if (!defined('STATUSNET')) {
35 * Allows users to flag content and accounts as offensive/spam/whatever
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/
43 class UserFlagPlugin extends Plugin
45 const REVIEWFLAGS = 'UserFlagPlugin::reviewflags';
46 const CLEARFLAGS = 'UserFlagPlugin::clearflags';
48 public $flagOnBlock = true;
51 * Hook for ensuring our tables are created
53 * Ensures that the user_flag_profile table exists
54 * and has the right columns.
56 * @return boolean hook return
58 function onCheckSchema()
60 $schema = Schema::get();
62 // For storing user-submitted flags on profiles
63 $schema->ensureTable('user_flag_profile', User_flag_profile::schemaDef());
68 * Add our actions to the URL router
70 * @param Net_URL_Mapper $m URL mapper for this hit
72 * @return boolean hook return
74 function onRouterInitialized($m)
76 $m->connect('main/flag/profile', array('action' => 'flagprofile'));
77 $m->connect('main/flag/clear', array('action' => 'clearflag'));
78 $m->connect('panel/profile/flag', array('action' => 'adminprofileflag'));
83 * Auto-load our classes if called
85 * @param string $cls Class to load
87 * @return boolean hook return
89 function onAutoload($cls)
91 switch (strtolower($cls))
93 case 'flagprofileaction':
94 case 'adminprofileflagaction':
95 case 'clearflagaction':
96 include_once INSTALLDIR.'/plugins/UserFlag/' .
97 strtolower(mb_substr($cls, 0, -6)) . '.php';
99 case 'flagprofileform':
100 case 'clearflagform':
101 include_once INSTALLDIR.'/plugins/UserFlag/' . strtolower($cls . '.php');
103 case 'user_flag_profile':
104 include_once INSTALLDIR.'/plugins/UserFlag/'.ucfirst(strtolower($cls)).'.php';
112 * Add a 'flag' button to profile page
114 * @param Action $action The action being called
115 * @param Profile $profile Profile being shown
117 * @return boolean hook result
119 function onEndProfilePageActionsElements($action, $profile)
121 $this->showFlagButton($action, $profile,
122 array('action' => 'showstream',
123 'nickname' => $profile->nickname));
129 * Add a 'flag' button to profiles in a list
131 * @param ProfileListItem $item item being shown
133 * @return boolean hook result
135 function onEndProfileListItemActionElements($item)
137 list($action, $args) = $item->action->returnToArgs();
138 $args['action'] = $action;
139 $this->showFlagButton($item->action, $item->profile, $args);
145 * Actually output a flag button. If the target profile has already been
146 * flagged by the current user, a null-action faux button is shown.
148 * @param Action $action
149 * @param Profile $profile
150 * @param array $returnToArgs
152 protected function showFlagButton($action, $profile, $returnToArgs)
154 $user = common_current_user();
156 if (!empty($user) && ($user->id != $profile->id)) {
158 $action->elementStart('li', 'entity_flag');
160 if (User_flag_profile::exists($profile->id, $user->id)) {
161 // @todo FIXME: Add a title explaining what 'flagged' means?
162 // TRANS: Message added to a profile if it has been flagged for review.
163 $action->element('p', 'flagged', _m('Flagged'));
165 $form = new FlagProfileForm($action, $profile, $returnToArgs);
169 $action->elementEnd('li');
174 * Check whether a user has one of our defined rights
176 * We define extra rights; this function checks to see if a
177 * user has one of them.
179 * @param User $user User being checked
180 * @param string $right Right we're checking
181 * @param boolean &$result out, result of the check
183 * @return boolean hook result
185 function onUserRightsCheck($user, $right, &$result)
188 case self::REVIEWFLAGS:
189 case self::CLEARFLAGS:
190 $result = $user->hasRole('moderator');
191 return false; // done processing!
194 return true; // unchanged!
198 * Optionally flag profile when a block happens
200 * We optionally add a flag when a profile has been blocked
202 * @param User $user User doing the block
203 * @param Profile $profile Profile being blocked
205 * @return boolean hook result
207 function onEndBlockProfile($user, $profile)
209 if ($this->flagOnBlock && !User_flag_profile::exists($profile->id,
212 User_flag_profile::create($user->id, $profile->id);
218 * Ensure that flag entries for a profile are deleted
219 * along with the profile when deleting users.
220 * This prevents breakage of the admin profile flag UI.
222 * @param Profile $profile
223 * @param array &$related list of related tables; entries
224 * with matching profile_id will be deleted.
226 * @return boolean hook result
228 function onProfileDeleteRelated($profile, &$related)
230 $related[] = 'user_flag_profile';
235 * Ensure that flag entries created by a user are deleted
236 * when that user gets deleted.
239 * @param array &$related list of related tables; entries
240 * with matching user_id will be deleted.
242 * @return boolean hook result
244 function onUserDeleteRelated($user, &$related)
246 $related[] = 'user_flag_profile';
251 * Provide plugin version information.
253 * This data is used when showing the version page.
255 * @param array &$versions array of version data arrays; see EVENTS.txt
257 * @return boolean hook value
259 function onPluginVersion(&$versions)
261 $url = 'http://status.net/wiki/Plugin:UserFlag';
263 $versions[] = array('name' => 'UserFlag',
264 'version' => STATUSNET_VERSION,
265 'author' => 'Evan Prodromou',
268 // TRANS: Plugin description.
269 _m('This plugin allows flagging of profiles for review and reviewing flagged profiles.'));