]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/implugin.php
Merge remote-tracking branch 'upstream/master' into social-master
[quix0rs-gnu-social.git] / lib / implugin.php
index d096c41a28378794257242ac1af13b5b2911d0f4..9e4de6beb195fafaa675c25d7a4bee25d30bf1a3 100644 (file)
@@ -49,6 +49,8 @@ abstract class ImPlugin extends Plugin
     //list of screennames that should get all public notices
     public $public = array();
 
+    protected $requires_cli = true;
+
     /**
      * normalize a screenname for comparison
      *
@@ -84,7 +86,7 @@ abstract class ImPlugin extends Plugin
      *
      * @return boolean success value
      */
-    function sendNotice($screenname, $notice)
+    function sendNotice($screenname, Notice $notice)
     {
         return $this->sendMessage($screenname, $this->formatNotice($notice));
     }
@@ -124,17 +126,6 @@ abstract class ImPlugin extends Plugin
      */
     abstract function daemonScreenname();
 
-    /**
-     * get the microid uri of a given screenname
-     *
-     * @param string $screenname screenname
-     *
-     * @return string microid uri
-     */
-    function microiduri($screenname)
-    {
-        return $this->transport . ':' . $screenname;
-    }
     //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - MISC ========================\
 
     /**
@@ -170,7 +161,7 @@ abstract class ImPlugin extends Plugin
     {
         $user_im_prefs = $this->getUserImPrefsFromScreenname($screenname);
         if($user_im_prefs){
-            $user = User::staticGet('id', $user_im_prefs->user_id);
+            $user = User::getKV('id', $user_im_prefs->user_id);
             $user_im_prefs->free();
             return $user;
         }else{
@@ -252,13 +243,12 @@ abstract class ImPlugin extends Plugin
      *
      * @param string $screenname screenname sending to
      * @param string $code the confirmation code
-     * @param User $user user sending to
+     * @param Profile $target For whom the code is valid for
      *
      * @return boolean success value
      */
-    function sendConfirmationCode($screenname, $code, $user)
+    function sendConfirmationCode($screenname, $code, Profile $target)
     {
-        // @todo FIXME: parameter 4 is not being used. Should para3 and para4 be a markdown link?
         // TRANS: Body text for confirmation code e-mail.
         // TRANS: %1$s is a user nickname, %2$s is the StatusNet sitename,
         // TRANS: %3$s is the display name of an IM plugin.
@@ -268,7 +258,7 @@ abstract class ImPlugin extends Plugin
           ' . (If you cannot click it, copy-and-paste it into the ' .
           'address bar of your browser). If that user is not you, ' .
           'or if you did not request this confirmation, just ignore this message.'),
-          $user->nickname, common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', array('code' => $code)));
+          $target->getNickname(), common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', null, array('code' => $code)));
 
         return $this->sendMessage($screenname, $body);
     }
@@ -322,7 +312,7 @@ abstract class ImPlugin extends Plugin
         $ni = $notice->whoGets();
 
         foreach ($ni as $user_id => $reason) {
-            $user = User::staticGet($user_id);
+            $user = User::getKV($user_id);
             if (empty($user)) {
                 // either not a local user, or just not found
                 continue;
@@ -371,10 +361,22 @@ abstract class ImPlugin extends Plugin
      * @return string plain-text version of the notice, with user nickname prefixed
      */
 
-    function formatNotice($notice)
+    protected function formatNotice(Notice $notice)
     {
         $profile = $notice->getProfile();
-        return $profile->nickname . ': ' . $notice->content . ' [' . $notice->id . ']';
+        $nicknames = $profile->getNickname();
+
+        try {
+            $parent = $notice->getParent();
+            $orig_profile = $parent->getProfile();
+            $nicknames = sprintf('%1$s => %2$s', $profile->getNickname(), $orig_profile->getNickname());
+        } catch (NoParentNoticeException $e) {
+            // Not a reply, no parent notice stored
+        } catch (NoResultException $e) {
+            // Parent notice was probably deleted
+        }
+
+        return sprintf('%1$s: %2$s [%3$u]', $nicknames, $notice->content, $notice->id);
     }
     //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - RECEIVING ========================\
 
@@ -392,9 +394,8 @@ abstract class ImPlugin extends Plugin
             $chan = new IMChannel($this);
             $cmd->execute($chan);
             return true;
-        } else {
-            return false;
         }
+        return false;
     }
 
     /**
@@ -520,11 +521,16 @@ abstract class ImPlugin extends Plugin
      *
      * @return boolean hook return
      */
-    function onEndInitializeQueueManager($manager)
+    function onEndInitializeQueueManager(QueueManager $manager)
     {
-        $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im');
-        $manager->connect($this->transport, new ImQueueHandler($this));
-        $manager->connect($this->transport . '-out', new ImSenderQueueHandler($this), 'im');
+        // If we don't require CLI mode, or if we do and GNUSOCIAL_CLI _is_ set, then connect the transports
+        // This check is made mostly because some IM plugins can't deliver to transports unless they
+        // have continously running daemons (such as XMPP) and we can't have that over HTTP requests.
+        if (!$this->requires_cli || defined('GNUSOCIAL_CLI')) {
+            $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im');
+            $manager->connect($this->transport, new ImQueueHandler($this));
+            $manager->connect($this->transport . '-out', new ImSenderQueueHandler($this), 'im');
+        }
         return true;
     }
 
@@ -534,9 +540,9 @@ abstract class ImPlugin extends Plugin
         return true;
     }
 
-    function onStartEnqueueNotice($notice, &$transports)
+    function onStartEnqueueNotice(Notice $notice, array &$transports)
     {
-        $profile = Profile::staticGet($notice->profile_id);
+        $profile = Profile::getKV($notice->profile_id);
 
         if (!$profile) {
             common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
@@ -549,35 +555,20 @@ abstract class ImPlugin extends Plugin
         return true;
     }
 
-    function onEndShowHeadElements($action)
+    function onEndShowHeadElements(Action $action)
     {
-        $aname = $action->trimmed('action');
-
-        if ($aname == 'shownotice') {
+        if ($action instanceof ShownoticeAction) {
 
             $user_im_prefs = new User_im_prefs();
-            $user_im_prefs->user_id = $action->profile->id;
+            $user_im_prefs->user_id = $action->notice->getProfile()->getID();
             $user_im_prefs->transport = $this->transport;
 
-            if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->notice->uri) {
-                $id = new Microid($this->microiduri($user_im_prefs->screenname),
-                                  $action->notice->uri);
-                $action->element('meta', array('name' => 'microid',
-                                             'content' => $id->toString()));
-            }
-
-        } else if ($aname == 'showstream') {
+        } elseif ($action instanceof ShowstreamAction) {
 
             $user_im_prefs = new User_im_prefs();
-            $user_im_prefs->user_id = $action->user->id;
+            $user_im_prefs->user_id = $action->getTarget()->getID();
             $user_im_prefs->transport = $this->transport;
 
-            if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->profile->profileurl) {
-                $id = new Microid($this->microiduri($user_im_prefs->screenname),
-                                  $action->selfUrl());
-                $action->element('meta', array('name' => 'microid',
-                                               'content' => $id->toString()));
-            }
         }
     }
 
@@ -606,11 +597,11 @@ abstract class ImPlugin extends Plugin
             'daemonScreenname' => $this->daemonScreenname());
     }
 
-    function onSendImConfirmationCode($transport, $screenname, $code, $user)
+    function onSendImConfirmationCode($transport, $screenname, $code, Profile $target)
     {
         if($transport == $this->transport)
         {
-            $this->sendConfirmationCode($screenname, $code, $user);
+            $this->sendConfirmationCode($screenname, $code, $target);
             return false;
         }
     }
@@ -621,6 +612,11 @@ abstract class ImPlugin extends Plugin
         return true;
     }
 
+    function onHaveImPlugin(&$haveImPlugin) {
+        $haveImPlugin = true; // set flag true (we're loaded, after all!)
+        return false; // stop looking
+    }
+
     function initialize()
     {
         if( ! common_config('queue', 'enabled'))