* @link http://status.net/
*/
-if (!defined('STATUSNET') && !defined('LACONICA')) {
+if (!defined('STATUSNET')) {
exit(1);
}
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
-
class UserFlagPlugin extends Plugin
{
+ const REVIEWFLAGS = 'UserFlagPlugin::reviewflags';
+ const CLEARFLAGS = 'UserFlagPlugin::clearflags';
+
+ public $flagOnBlock = true;
+
+ /**
+ * Hook for ensuring our tables are created
+ *
+ * Ensures that the user_flag_profile table exists
+ * and has the right columns.
+ *
+ * @return boolean hook return
+ */
function onCheckSchema()
{
$schema = Schema::get();
// For storing user-submitted flags on profiles
- $schema->ensureDataObject('User_flag_profile');
-
+ $schema->ensureTable('user_flag_profile', User_flag_profile::schemaDef());
return true;
}
- function onInitializePlugin()
+ /**
+ * Add our actions to the URL router
+ *
+ * @param URLMapper $m URL mapper for this hit
+ *
+ * @return boolean hook return
+ */
+ public function onRouterInitialized(URLMapper $m)
{
- // XXX: do something here?
+ $m->connect('main/flag/profile', array('action' => 'flagprofile'));
+ $m->connect('main/flag/clear', array('action' => 'clearflag'));
+ $m->connect('panel/profile/flag', array('action' => 'adminprofileflag'));
return true;
}
- function onRouterInitialized(&$m) {
- $m->connect('main/flag/profile', array('action' => 'flagprofile'));
- $m->connect('admin/profile/flag', array('action' => 'adminprofileflag'));
+ /**
+ * Add a 'flag' button to profile page
+ *
+ * @param Action $action The action being called
+ * @param Profile $profile Profile being shown
+ *
+ * @return boolean hook result
+ */
+ function onEndProfilePageActionsElements($action, $profile)
+ {
+ $this->showFlagButton($action, $profile,
+ array('action' => 'showstream',
+ 'nickname' => $profile->nickname));
+
return true;
}
- function onAutoload($cls)
+ /**
+ * Add a 'flag' button to profiles in a list
+ *
+ * @param ProfileListItem $item item being shown
+ *
+ * @return boolean hook result
+ */
+ function onEndProfileListItemActionElements($item)
{
- switch ($cls)
- {
- case 'FlagprofileAction':
- case 'AdminprofileflagAction':
- require_once(INSTALLDIR.'/plugins/UserFlag/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
- return false;
- case 'FlagProfileForm':
- require_once(INSTALLDIR.'/plugins/UserFlag/' . strtolower($cls . '.php'));
- return false;
- case 'User_flag_profile':
- require_once(INSTALLDIR.'/plugins/UserFlag/'.$cls.'.php');
- return false;
- default:
- return true;
- }
+ list($action, $args) = $item->action->returnToArgs();
+ $args['action'] = $action;
+ $this->showFlagButton($item->action, $item->profile, $args);
+
+ return true;
}
- function onEndProfilePageActionsElements(&$action, $profile)
+ /**
+ * Actually output a flag button. If the target profile has already been
+ * flagged by the current user, a null-action faux button is shown.
+ *
+ * @param Action $action
+ * @param Profile $profile
+ * @param array $returnToArgs
+ */
+ protected function showFlagButton($action, $profile, $returnToArgs)
{
$user = common_current_user();
$action->elementStart('li', 'entity_flag');
if (User_flag_profile::exists($profile->id, $user->id)) {
- $action->element('p', 'flagged', _('Flagged'));
+ // @todo FIXME: Add a title explaining what 'flagged' means?
+ // TRANS: Message added to a profile if it has been flagged for review.
+ $action->element('p', 'flagged', _m('Flagged'));
} else {
- $form = new FlagProfileForm($action, $profile,
- array('action' => 'showstream',
- 'nickname' => $profile->nickname));
+ $form = new FlagProfileForm($action, $profile, $returnToArgs);
$form->show();
}
$action->elementEnd('li');
}
-
- return true;
}
- function onEndProfileListItemActionElements($item)
+ /**
+ * Check whether a user has one of our defined rights
+ *
+ * We define extra rights; this function checks to see if a
+ * user has one of them.
+ *
+ * @param User $user User being checked
+ * @param string $right Right we're checking
+ * @param boolean &$result out, result of the check
+ *
+ * @return boolean hook result
+ */
+ function onUserRightsCheck($user, $right, &$result)
{
- $user = common_current_user();
-
- if (!empty($user)) {
-
- list($action, $args) = $item->action->returnToArgs();
+ switch ($right) {
+ case self::REVIEWFLAGS:
+ case self::CLEARFLAGS:
+ $result = $user->hasRole('moderator');
+ return false; // done processing!
+ }
- $args['action'] = $action;
+ return true; // unchanged!
+ }
- $form = new FlagProfileForm($item->action, $item->profile, $args);
+ /**
+ * Optionally flag profile when a block happens
+ *
+ * We optionally add a flag when a profile has been blocked
+ *
+ * @param User $user User doing the block
+ * @param Profile $profile Profile being blocked
+ *
+ * @return boolean hook result
+ */
+ function onEndBlockProfile($user, $profile)
+ {
+ if ($this->flagOnBlock && !User_flag_profile::exists($profile->id,
+ $user->id)) {
- $item->action->elementStart('li', 'entity_flag');
- $form->show();
- $item->action->elementEnd('li');
+ User_flag_profile::create($user->id, $profile->id);
}
-
return true;
}
- function onEndShowStatusNetStyles($action)
+ /**
+ * Ensure that flag entries for a profile are deleted
+ * along with the profile when deleting users.
+ * This prevents breakage of the admin profile flag UI.
+ *
+ * @param Profile $profile
+ * @param array &$related list of related tables; entries
+ * with matching profile_id will be deleted.
+ *
+ * @return boolean hook result
+ */
+ function onProfileDeleteRelated($profile, &$related)
{
- $action->elementStart('style', array('type' => 'text/css'));
- $action->raw('.entity_flag input, .entity_flag p {'.
- ' background:url('.common_path('plugins/UserFlag/flag.gif').') 5px 5px no-repeat;'.
- ' }');
- $action->elementEnd('style');
+ $related[] = 'user_flag_profile';
+ return true;
+ }
+ /**
+ * Ensure that flag entries created by a user are deleted
+ * when that user gets deleted.
+ *
+ * @param User $user
+ * @param array &$related list of related tables; entries
+ * with matching user_id will be deleted.
+ *
+ * @return boolean hook result
+ */
+ function onUserDeleteRelated($user, &$related)
+ {
+ $related[] = 'user_flag_profile';
return true;
}
- function onEndShowScripts($action)
+ /**
+ * Provide plugin version information.
+ *
+ * This data is used when showing the version page.
+ *
+ * @param array &$versions array of version data arrays; see EVENTS.txt
+ *
+ * @return boolean hook value
+ */
+ function onPluginVersion(array &$versions)
{
- $action->elementStart('script', array('type' => 'text/javascript'));
- $action->raw('/*<![CDATA[*/ SN.U.FormXHR($(".form_entity_flag")); /*]]>*/');
- $action->elementEnd('script');
+ $url = 'http://status.net/wiki/Plugin:UserFlag';
+
+ $versions[] = array('name' => 'UserFlag',
+ 'version' => GNUSOCIAL_VERSION,
+ 'author' => 'Evan Prodromou',
+ 'homepage' => $url,
+ 'rawdescription' =>
+ // TRANS: Plugin description.
+ _m('This plugin allows flagging of profiles for review and reviewing flagged profiles.'));
+
return true;
}
}
projects / quix0rs-gnu-social.git / blobdiff