X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=plugins%2FUserFlag%2FUserFlagPlugin.php;h=ae3dfe0365155983e6518046afd1def6bb1ec51d;hb=4a71753f2046a17a98c139cc308ff7f77bd4f271;hp=1982028474ab01541d2d513460d4f18926d7cc0b;hpb=b16cabc3bccc1c46178e86dda2a8ba55ff97f28c;p=quix0rs-gnu-social.git

diff --git a/plugins/UserFlag/UserFlagPlugin.php b/plugins/UserFlag/UserFlagPlugin.php
index 1982028474..ae3dfe0365 100644
--- a/plugins/UserFlag/UserFlagPlugin.php
+++ b/plugins/UserFlag/UserFlagPlugin.php
@@ -27,7 +27,7 @@
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET') && !defined('LACONICA')) {
+if (!defined('STATUSNET')) {
     exit(1);
 }
 
@@ -43,6 +43,20 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
 
 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();
@@ -62,42 +76,66 @@ class UserFlagPlugin extends Plugin
         return true;
     }
 
-    function onInitializePlugin()
-    {
-        // XXX: do something here?
-        return true;
-    }
+    /**
+     * Add our actions to the URL router
+     *
+     * @param Net_URL_Mapper $m URL mapper for this hit
+     *
+     * @return boolean hook return
+     */
 
-    function onRouterInitialized(&$m) {
+    function onRouterInitialized($m)
+    {
         $m->connect('main/flag/profile', array('action' => 'flagprofile'));
+        $m->connect('main/flag/clear', array('action' => 'clearflag'));
         $m->connect('admin/profile/flag', array('action' => 'adminprofileflag'));
         return true;
     }
 
-   function onAutoload($cls)
+    /**
+     * Auto-load our classes if called
+     *
+     * @param string $cls Class to load
+     *
+     * @return boolean hook return
+     */
+
+    function onAutoload($cls)
     {
-        switch ($cls)
+        switch (strtolower($cls))
         {
-        case 'FlagprofileAction':
-        case 'AdminprofileflagAction':
-            require_once(INSTALLDIR.'/plugins/UserFlag/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
+        case 'flagprofileaction':
+        case 'adminprofileflagaction':
+        case 'clearflagaction':
+            include_once INSTALLDIR.'/plugins/UserFlag/' .
+              strtolower(mb_substr($cls, 0, -6)) . '.php';
             return false;
-        case 'FlagProfileForm':
-            require_once(INSTALLDIR.'/plugins/UserFlag/' . strtolower($cls . '.php'));
+        case 'flagprofileform':
+        case 'clearflagform':
+            include_once INSTALLDIR.'/plugins/UserFlag/' . strtolower($cls . '.php');
             return false;
-        case 'User_flag_profile':
-            require_once(INSTALLDIR.'/plugins/UserFlag/'.$cls.'.php');
+        case 'user_flag_profile':
+            include_once INSTALLDIR.'/plugins/UserFlag/'.ucfirst(strtolower($cls)).'.php';
             return false;
         default:
             return true;
         }
     }
 
+    /**
+     * 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)
     {
         $user = common_current_user();
 
-        if (!empty($user)) {
+        if (!empty($user) && ($user->id != $profile->id)) {
 
             $action->elementStart('li', 'entity_flag');
 
@@ -105,8 +143,8 @@ class UserFlagPlugin extends Plugin
                 $action->element('p', 'flagged', _('Flagged'));
             } else {
                 $form = new FlagProfileForm($action, $profile,
-                                        array('action' => 'showstream',
-                                              'nickname' => $profile->nickname));
+                                            array('action' => 'showstream',
+                                                  'nickname' => $profile->nickname));
                 $form->show();
             }
 
@@ -116,6 +154,14 @@ class UserFlagPlugin extends Plugin
         return true;
     }
 
+    /**
+     * Add a 'flag' button to profiles in a list
+     *
+     * @param ProfileListItem $item item being shown
+     *
+     * @return boolean hook result
+     */
+
     function onEndProfileListItemActionElements($item)
     {
         $user = common_current_user();
@@ -136,22 +182,100 @@ class UserFlagPlugin extends Plugin
         return true;
     }
 
-    function onEndShowStatusNetStyles($action)
+    /**
+     * Initialize any flagging buttons on the page
+     *
+     * @param Action $action action being shown
+     *
+     * @return boolean hook result
+     */
+
+    function onEndShowScripts($action)
+    {
+        $action->inlineScript('if ($(".form_entity_flag").length > 0) { '.
+                              '$(".form_entity_flag").bind("click", function() {'.
+                              'SN.U.FormXHR($(this)); return false; }); }');
+        return true;
+    }
+
+    /**
+     * 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)
+    {
+        switch ($right) {
+        case self::REVIEWFLAGS:
+        case self::CLEARFLAGS:
+            $result = $user->hasRole('moderator');
+            return false; // done processing!
+        }
+
+        return true; // unchanged!
+    }
+
+    /**
+     * 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)
     {
-        $action->elementStart('style', array('type' => 'text/css'));
-        $action->raw('.entity_flag input, .entity_flag p {'.
-            ' background:url('.common_path('plugins/UserFlag/icon_flag.gif').') 5px 5px no-repeat;'.
-            ' }');
-        $action->elementEnd('style');
+        if ($this->flagOnBlock && !User_flag_profile::exists($profile->id,
+                                                             $user->id)) {
 
+            User_flag_profile::create($user->id, $profile->id);
+        }
         return true;
     }
 
-    function onEndShowScripts($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)
+    {
+        $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)
     {
-        $action->elementStart('script', array('type' => 'text/javascript'));
-        $action->raw('/*<![CDATA[*/ SN.U.FormXHR($(".form_entity_flag")); /*]]>*/');
-        $action->elementEnd('script');
+        $related[] = 'user_flag_profile';
         return true;
     }
 }