]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Favorite/FavoritePlugin.php
Found some unreachable code in Favorite
[quix0rs-gnu-social.git] / plugins / Favorite / FavoritePlugin.php
index 6248b332c41d3fd6e5d704b8984d855dc437a661..017b78d8b9c366e24f0673ca2fa11236ec6471e2 100644 (file)
@@ -25,6 +25,8 @@ if (!defined('GNUSOCIAL')) { exit(1); }
  */
 class FavoritePlugin extends ActivityHandlerPlugin
 {
+    protected $email_notify_fave = 1;
+
     public function tag()
     {
         return 'favorite';
@@ -46,6 +48,31 @@ class FavoritePlugin extends ActivityHandlerPlugin
         $schema->ensureTable('fave', Fave::schemaDef());
         return true;
     }
+
+    public function onStartUpgrade()
+    {
+        // This is a migration feature that will make sure we move
+        // certain User preferences to the Profile_prefs table.
+        // Introduced after commit b5fd2a048fc621ea05d756caba17275ab3dd0af4
+        // on Sun Jul 13 16:30:37 2014 +0200
+        $user = new User();
+        $user->whereAdd('emailnotifyfav IS NOT NULL');
+        if ($user->find()) {
+            printfnq("Detected old User table (emailnotifyfav IS NOT NULL). Moving 'emailnotifyfav' property to Profile_prefs...");
+            // First we'll make sure Profile_prefs exists
+            $schema = Schema::get();
+            $schema->ensureTable('profile_prefs', Profile_prefs::schemaDef());
+
+            // Make sure we have our own tables setup properly
+            while ($user->fetch()) {
+                $user->setPref('email', 'notify_fave', $user->emailnotifyfav);
+                $orig = clone($user);
+                $user->emailnotifyfav = 'null';   // flag this preference as migrated
+                $user->update($orig);
+            }
+            printfnq("DONE.\n");
+        }
+    }
     
     public function onEndUpgrade()
     {
@@ -63,7 +90,7 @@ class FavoritePlugin extends ActivityHandlerPlugin
                                          '    modified = "%s" '.
                                          'WHERE user_id = %d '.
                                          'AND notice_id = %d',
-                                         Fave::newURI($fave->user_id, $fave->notice_id, $fave->modified),
+                                         Fave::newUri($fave->user_id, $fave->notice_id, $fave->modified),
                                          common_sql_date(strtotime($fave->modified)),
                                          $fave->user_id,
                                          $fave->notice_id));
@@ -147,16 +174,69 @@ class FavoritePlugin extends ActivityHandlerPlugin
                           'format' => '(xml|json)'));
     }
 
-    public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
+    // FIXME: Set this to abstract public in lib/activityhandlerplugin.php ddwhen all plugins have migrated!
+    protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())  
+    {
+        assert($this->isMyActivity($act));
+
+        // If empty, we should've created it ourselves on our node.
+        if (!isset($options['created'])) {
+            $options['created'] = !empty($act->time) ? common_sql_date($act->time) : common_sql_now();
+        }
+
+        // We must have an objects[0] here because in isMyActivity we require the count to be == 1
+        $actobj = $act->objects[0];
+
+        $object = Fave::saveActivityObject($actobj, $stored);
+        return $object;
+    }
+
+    // FIXME: Put this in lib/activityhandlerplugin.php when we're ready
+    //          with the other microapps/activityhandlers as well.
+    //          Also it should be StartNoticeAsActivity (with a prepped Activity, including ->context etc.)
+    public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
+    {
+        if (!$this->isMyNotice($stored)) {
+            return true;
+        }
+
+        common_debug('Extending activity '.$stored->id.' with '.get_called_class());
+        $this->extendActivity($stored, $act, $scoped);
+        return false;
+    }
+
+    public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
     {
+        Fave::extendActivity($stored, $act, $scoped);
     }
 
     public function activityObjectFromNotice(Notice $notice)
     {
+        $fave = Fave::fromStored($notice);
+        return $fave->asActivityObject();
     }
 
     public function deleteRelated(Notice $notice)
     {
+        try {
+            $fave = Fave::fromStored($notice);
+            $fave->delete();
+        } catch (NoResultException $e) {
+            // Cool, no problem. We wanted to get rid of it anyway.
+        }
+    }
+
+    protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
+    {
+        require_once INSTALLDIR.'/lib/mail.php';
+
+        foreach ($mentioned_ids as $id) {
+            $mentioned = User::getKV('id', $id);
+            if ($mentioned instanceof User && $mentioned->id != $stored->profile_id
+                    && $mentioned->email && $mentioned->getPref('email', 'notify_fave', $this->email_notify_fave)) {   // do we have an email, and does user want it?
+                mail_notify_fave($mentioned, $stored->getProfile(), $stored->getParent());
+            }
+        }
     }
 
     // API stuff
@@ -196,15 +276,15 @@ class FavoritePlugin extends ActivityHandlerPlugin
     {
         parent::onNoticeDeleteRelated($notice);
 
-        // The below algorithm is because we have faves not stored as
-        // proper activities in Notice from legacy versions of SN/GNU social
+        // The below algorithm is because we want to delete fave
+        // activities on any notice which _has_ faves, and not as
+        // in the parent function only ones that _are_ faves.
 
         $fave = new Fave();
         $fave->notice_id = $notice->id;
 
         if ($fave->find()) {
             while ($fave->fetch()) {
-                Fave::blowCacheForProfileId($fave->user_id);
                 $fave->delete();
             }
         }
@@ -256,6 +336,19 @@ class FavoritePlugin extends ActivityHandlerPlugin
         }
     }
 
+    public function showNoticeListItem(NoticeListItem $nli)
+    {
+        // pass
+    }
+    public function openNoticeListItemElement(NoticeListItem $nli)
+    {
+        // pass
+    }
+    public function closeNoticeListItemElement(NoticeListItem $nli)
+    {
+        // pass
+    }
+
     public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
     {
         $faves = array();
@@ -304,7 +397,7 @@ class FavoritePlugin extends ActivityHandlerPlugin
             if (empty($arg)) {
                 $result = null;
             } else {
-                list($other, $extra) = $this->split_arg($arg);
+                list($other, $extra) = CommandInterpreter::split_arg($arg);
                 if (!empty($extra)) {
                     $result = null;
                 } else {
@@ -327,11 +420,46 @@ class FavoritePlugin extends ActivityHandlerPlugin
     /**
      * Are we allowed to perform a certain command over the API?
      */
-    public function onCommandSupportedAPI(Command $cmd, array &$supported)
+    public function onCommandSupportedAPI(Command $cmd, &$supported)
     {
         $supported = $supported || $cmd instanceof FavCommand;
     }
 
+    // Form stuff (settings etc.)
+
+    public function onEndEmailFormData(Action $action, Profile $scoped)
+    {
+        // getConfigData will fall back on systemwide default
+        // and we only wish to save numerical true or false.
+        $emailfave = $scoped->getPref('email', 'notify_fave', $this->email_notify_fave) ? 1 : 0;
+
+        $action->elementStart('li');
+        $action->checkbox('email-notify_fave',
+                        // TRANS: Checkbox label in e-mail preferences form.
+                        _('Send me email when someone adds my notice as a favorite.'),
+                        $emailfave);
+        $action->elementEnd('li');
+
+        return true;
+    }
+
+    public function onStartEmailSaveForm(Action $action, Profile $scoped)
+    {
+        $emailfave = $action->boolean('email-notify_fave') ? 1 : 0;
+        try {
+            if ($emailfave == $scoped->getPref('email', 'notify_fave')) {
+                // No need to update setting
+                return true;
+            }
+        } catch (NoResultException $e) {
+            // Apparently there's no previously stored setting, then continue to save it as it is now.
+        }
+
+        $scoped->setPref('email', 'notify_fave', $emailfave);
+
+        return true;
+    }
+
     // Layout stuff
 
     public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)