]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OStatus/OStatusPlugin.php
Merge remote-tracking branch 'upstream/master' into social-master
[quix0rs-gnu-social.git] / plugins / OStatus / OStatusPlugin.php
index d180a27d225aac104df095a0063238c20380e702..9fce923c25458724973d07b492c935732c965814 100644 (file)
@@ -30,28 +30,15 @@ if (!defined('GNUSOCIAL')) { exit(1); }
 
 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phpseclib');
 
-class FeedSubException extends Exception
-{
-    function __construct($msg=null)
-    {
-        $type = get_class($this);
-        if ($msg) {
-            parent::__construct("$type: $msg");
-        } else {
-            parent::__construct($type);
-        }
-    }
-}
-
 class OStatusPlugin extends Plugin
 {
     /**
      * Hook for RouterInitialized event.
      *
-     * @param Net_URL_Mapper $m path-to-action mapper
+     * @param URLMapper $m path-to-action mapper
      * @return boolean hook return
      */
-    function onRouterInitialized($m)
+    public function onRouterInitialized(URLMapper $m)
     {
         // Discovery actions
         $m->connect('main/ostatustag',
@@ -96,6 +83,20 @@ class OStatusPlugin extends Plugin
         return true;
     }
 
+    public function onAutoload($cls)
+    {
+        switch ($cls) {
+        case 'Crypt_AES':
+        case 'Crypt_RSA':
+            // Crypt_AES becomes Crypt/AES.php which is found in extlib/phpseclib/
+            // which has been added to our include_path before
+            require_once str_replace('_', '/', $cls) . '.php';
+            return false;
+        }
+
+        return parent::onAutoload($cls);
+    }
+
     /**
      * Set up queue handlers for outgoing hub pushes
      * @param QueueManager $qm
@@ -117,13 +118,16 @@ class OStatusPlugin extends Plugin
 
         // Incoming from a foreign PuSH hub
         $qm->connect('pushin', 'PushInQueueHandler');
+
+        // Re-subscribe feeds that need renewal
+        $qm->connect('pushrenew', 'PushRenewQueueHandler');
         return true;
     }
 
     /**
      * Put saved notices into the queue for pubsub distribution.
      */
-    function onStartEnqueueNotice($notice, &$transports)
+    function onStartEnqueueNotice(Notice $notice, array &$transports)
     {
         if ($notice->inScope(null)) {
             // put our transport first, in case there's any conflict (like OMB)
@@ -233,81 +237,22 @@ class OStatusPlugin extends Plugin
         return true;
     }
 
-    function onStartShowTagProfileForm($action, $profile)
-    {
-        $action->elementStart('form', array('method' => 'post',
-                                           'id' => 'form_tag_user',
-                                           'class' => 'form_settings',
-                                           'name' => 'tagprofile',
-                                           'action' => common_local_url('tagprofile', array('id' => @$profile->id))));
-
-        $action->elementStart('fieldset');
-        // TRANS: Fieldset legend.
-        $action->element('legend', null, _m('List remote profile'));
-        $action->hidden('token', common_session_token());
-
-        $user = common_current_user();
-
-        $action->elementStart('ul', 'form_data');
-        $action->elementStart('li');
-
-        // TRANS: Field label.
-        $action->input('uri', _m('LABEL','Remote profile'), $action->trimmed('uri'),
-                     // TRANS: Field title.
-                     _m('OStatus user\'s address, like nickname@example.com or http://example.net/nickname.'));
-        $action->elementEnd('li');
-        $action->elementEnd('ul');
-        // TRANS: Button text to fetch remote profile.
-        $action->submit('fetch', _m('BUTTON','Fetch'));
-        $action->elementEnd('fieldset');
-        $action->elementEnd('form');
-    }
-
-    function onStartTagProfileAction($action, $profile)
-    {
-        $err = null;
-        $uri = $action->trimmed('uri');
-
-        if (!$profile && $uri) {
-            try {
-                if (Validate::email($uri)) {
-                    $oprofile = Ostatus_profile::ensureWebfinger($uri);
-                } else if (Validate::uri($uri)) {
-                    $oprofile = Ostatus_profile::ensureProfileURL($uri);
-                } else {
-                    // TRANS: Exception in OStatus when invalid URI was entered.
-                    throw new Exception(_m('Invalid URI.'));
-                }
-
-                // redirect to the new profile.
-                common_redirect(common_local_url('tagprofile', array('id' => $oprofile->profile_id)), 303);
-
-            } catch (Exception $e) {
-                // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com
-                // TRANS: and example.net, as these are official standard domain names for use in examples.
-                $err = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname.");
-            }
-
-            $action->showForm($err);
-            return false;
-        }
-        return true;
-    }
-
     /*
      * If the field being looked for is URI look for the profile
      */
-    function onStartProfileCompletionSearch($action, $profile, $search_engine) {
+    public function onStartProfileCompletionSearch(Action $action, Profile $profile, $search_engine) {
         if ($action->field == 'uri') {
             $profile->joinAdd(array('id', 'user:id'));
             $profile->whereAdd('uri LIKE "%' . $profile->escape($q) . '%"');
             $profile->query();
 
+            $validate = new Validate();
+
             if ($profile->N == 0) {
                 try {
-                    if (Validate::email($q)) {
+                    if ($validate->email($q)) {
                         $oprofile = Ostatus_profile::ensureWebfinger($q);
-                    } else if (Validate::uri($q)) {
+                    } else if ($validate->uri($q)) {
                         $oprofile = Ostatus_profile::ensureProfileURL($q);
                     } else {
                         // TRANS: Exception in OStatus when invalid URI was entered.
@@ -336,7 +281,7 @@ class OStatusPlugin extends Plugin
      * @param array &$mention in/out param: set of found mentions
      * @return boolean hook return value
      */
-    function onEndFindMentions(Profile $sender, $text, &$mentions)
+    function onEndFindMentions(Profile $sender, $text, array &$mentions)
     {
         $matches = array();
 
@@ -356,7 +301,7 @@ class OStatusPlugin extends Plugin
                                                'type' => 'mention',
                                                'text' => $target,
                                                'position' => $pos,
-                                               'url' => $profile->profileurl);
+                                               'url' => $profile->getUrl());
                     }
                 } catch (Exception $e) {
                     $this->log(LOG_ERR, "Webfinger check failed: " . $e->getMessage());
@@ -383,7 +328,7 @@ class OStatusPlugin extends Plugin
                                                    'type' => 'mention',
                                                    'text' => $target,
                                                    'position' => $pos,
-                                                   'url' => $profile->profileurl);
+                                                   'url' => $profile->getUrl());
                             break;
                         }
                     } catch (Exception $e) {
@@ -419,11 +364,16 @@ class OStatusPlugin extends Plugin
      * @param Profile &$profile
      * @return hook return code
      */
-    function onStartCommandGetProfile($command, $arg, &$profile)
+    public function onStartCommandGetProfile(Command $command, $arg, Profile &$profile = null)
     {
         $oprofile = $this->pullRemoteProfile($arg);
         if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) {
-            $profile = $oprofile->localProfile();
+            try {
+                $profile = $oprofile->localProfile();
+            } catch (NoProfileException $e) {
+                // No locally stored profile found for remote profile
+                return true;
+            }
             return false;
         } else {
             return true;
@@ -441,7 +391,7 @@ class OStatusPlugin extends Plugin
      * @param User_group &$group
      * @return hook return code
      */
-    function onStartCommandGetGroup($command, $arg, &$group)
+    function onStartCommandGetGroup(Command $command, $arg, User_group &$group = null)
     {
         $oprofile = $this->pullRemoteProfile($arg);
         if ($oprofile instanceof Ostatus_profile && $oprofile->isGroup()) {
@@ -506,7 +456,7 @@ class OStatusPlugin extends Plugin
         return true;
     }
 
-    function onEndShowStatusNetScripts($action) {
+    public function onEndShowStatusNetScripts(Action $action) {
         $action->script($this->path('js/ostatus.js'));
         return true;
     }
@@ -524,7 +474,7 @@ class OStatusPlugin extends Plugin
     function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
     {
         // If we don't handle this, keep the event handler going
-        if ($notice->source != 'ostatus') {
+        if (!in_array($notice->source, array('ostatus', 'share'))) {
             return true;
         }
 
@@ -564,7 +514,7 @@ class OStatusPlugin extends Plugin
         if ($oprofile instanceof Ostatus_profile) {
             $oprofile->processFeed($feed, 'push');
         } else {
-            common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri");
+            common_debug("No ostatus profile for incoming feed $feedsub->uri");
         }
     }
 
@@ -686,8 +636,8 @@ class OStatusPlugin extends Plugin
                                $profile->getBestName(),
                                $other->getBestName());
 
-        $act->actor   = ActivityObject::fromProfile($profile);
-        $act->object  = ActivityObject::fromProfile($other);
+        $act->actor   = $profile->asActivityObject();
+        $act->object  = $other->asActivityObject();
 
         $oprofile->notifyActivity($act, $profile);
 
@@ -723,7 +673,7 @@ class OStatusPlugin extends Plugin
                                 $group->id,
                                 common_date_iso8601(time()));
 
-        $act->actor = ActivityObject::fromProfile($profile);
+        $act->actor = $profile->asActivityObject();
         $act->verb = ActivityVerb::JOIN;
         $act->object = $oprofile->asActivityObject();
 
@@ -777,7 +727,7 @@ class OStatusPlugin extends Plugin
                                 $group->id,
                                 common_date_iso8601(time()));
 
-        $act->actor = ActivityObject::fromProfile($member);
+        $act->actor = $member->asActivityObject();
         $act->verb = ActivityVerb::LEAVE;
         $act->object = $oprofile->asActivityObject();
 
@@ -823,7 +773,7 @@ class OStatusPlugin extends Plugin
                                 $peopletag->id,
                                 common_date_iso8601(time()));
 
-        $act->actor = ActivityObject::fromProfile($sub);
+        $act->actor = $sub->asActivityObject();
         $act->verb = ActivityVerb::FOLLOW;
         $act->object = $oprofile->asActivityObject();
 
@@ -875,7 +825,7 @@ class OStatusPlugin extends Plugin
                                 $peopletag->id,
                                 common_date_iso8601(time()));
 
-        $act->actor = ActivityObject::fromProfile($member);
+        $act->actor = $member->asActivityObject();
         $act->verb = ActivityVerb::UNFOLLOW;
         $act->object = $oprofile->asActivityObject();
 
@@ -968,8 +918,8 @@ class OStatusPlugin extends Plugin
                                 $tagged->getBestName(),
                                 $plist->getBestName());
 
-        $act->actor  = ActivityObject::fromProfile($tagger);
-        $act->objects = array(ActivityObject::fromProfile($tagged));
+        $act->actor  = $tagger->asActivityObject();
+        $act->objects = array($tagged->asActivityObject());
         $act->target = ActivityObject::fromPeopletag($plist);
 
         $oprofile->notifyDeferred($act, $tagger);
@@ -1019,8 +969,8 @@ class OStatusPlugin extends Plugin
                                 $tagged->getBestName(),
                                 $plist->getBestName());
 
-        $act->actor  = ActivityObject::fromProfile($tagger);
-        $act->objects = array(ActivityObject::fromProfile($tagged));
+        $act->actor  = $tagger->asActivityObject();
+        $act->objects = array($tagged->asActivityObject());
         $act->target = ActivityObject::fromPeopletag($plist);
 
         $oprofile->notifyDeferred($act, $tagger);
@@ -1068,8 +1018,8 @@ class OStatusPlugin extends Plugin
                                $profile->getBestName(),
                                $notice->getUrl());
 
-        $act->actor   = ActivityObject::fromProfile($profile);
-        $act->object  = ActivityObject::fromNotice($notice);
+        $act->actor   = $profile->asActivityObject();
+        $act->object  = $notice->asActivityObject();
 
         $oprofile->notifyActivity($act, $profile);
 
@@ -1132,8 +1082,12 @@ class OStatusPlugin extends Plugin
 
     function showEntityRemoteSubscribe($action, $target='ostatussub')
     {
-        $user = common_current_user();
-        if ($user && ($user->id == $action->profile->id)) {
+        if (!$action->getScoped() instanceof Profile) {
+            // early return if we're not logged in
+            return true;
+        }
+
+        if ($action->getScoped()->sameAs($action->getTarget())) {
             $action->elementStart('div', 'entity_actions');
             $action->elementStart('p', array('id' => 'entity_remote_subscribe',
                                              'class' => 'entity_subscribe'));
@@ -1168,7 +1122,7 @@ class OStatusPlugin extends Plugin
         $oprofile->query(sprintf($sql, $profile->id, $profile->id));
 
         if ($oprofile->N == 0) {
-            common_log(LOG_DEBUG, "No OStatus remote subscribees for $profile->nickname");
+            common_debug("No OStatus remote subscribees for $profile->nickname");
             return true;
         }
 
@@ -1186,7 +1140,7 @@ class OStatusPlugin extends Plugin
         $act->content = sprintf(_m('%s has updated their profile page.'),
                                $profile->getBestName());
 
-        $act->actor   = ActivityObject::fromProfile($profile);
+        $act->actor   = $profile->asActivityObject();
         $act->object  = $act->actor;
 
         while ($oprofile->fetch()) {
@@ -1196,46 +1150,49 @@ class OStatusPlugin extends Plugin
         return true;
     }
 
-    function onStartProfileListItemActionElements($item, $profile=null)
+    // FIXME: This one can accept both an Action and a Widget. Confusing! Refactor to (HTMLOutputter $out, Profile $target)!
+    function onStartProfileListItemActionElements($item)
     {
-        if (!common_logged_in()) {
-
-            $profileUser = User::getKV('id', $item->profile->id);
-
-            if (!empty($profileUser)) {
-
-                if ($item instanceof Action) {
-                    $output = $item;
-                    $profile = $item->profile;
-                } else {
-                    $output = $item->out;
-                }
+        if (common_logged_in()) {
+            // only non-logged in users get to see the "remote subscribe" form
+            return true;
+        } elseif (!$item->getTarget()->isLocal()) {
+            // we can (for now) only provide remote subscribe forms for local users
+            return true;
+        }
 
-                // Add an OStatus subscribe
-                $output->elementStart('li', 'entity_subscribe');
-                $url = common_local_url('ostatusinit',
-                                        array('nickname' => $profileUser->nickname));
-                $output->element('a', array('href' => $url,
-                                            'class' => 'entity_remote_subscribe'),
-                                  // TRANS: Link text for a user to subscribe to an OStatus user.
-                                 _m('Subscribe'));
-                $output->elementEnd('li');
-
-                $output->elementStart('li', 'entity_tag');
-                $url = common_local_url('ostatustag',
-                                        array('nickname' => $profileUser->nickname));
-                $output->element('a', array('href' => $url,
-                                            'class' => 'entity_remote_tag'),
-                                  // TRANS: Link text for a user to list an OStatus user.
-                                 _m('List'));
-                $output->elementEnd('li');
-            }
+        if ($item instanceof ProfileAction) {
+            $output = $item;
+        } elseif ($item instanceof Widget) {
+            $output = $item->out;
+        } else {
+            // Bad $item class, don't know how to use this for outputting!
+            throw new ServerException('Bad item type for onStartProfileListItemActionElements');
         }
 
+        // Add an OStatus subscribe
+        $output->elementStart('li', 'entity_subscribe');
+        $url = common_local_url('ostatusinit',
+                                array('nickname' => $item->getTarget()->getNickname()));
+        $output->element('a', array('href' => $url,
+                                    'class' => 'entity_remote_subscribe'),
+                          // TRANS: Link text for a user to subscribe to an OStatus user.
+                         _m('Subscribe'));
+        $output->elementEnd('li');
+
+        $output->elementStart('li', 'entity_tag');
+        $url = common_local_url('ostatustag',
+                                array('nickname' => $item->getTarget()->getNickname()));
+        $output->element('a', array('href' => $url,
+                                    'class' => 'entity_remote_tag'),
+                          // TRANS: Link text for a user to list an OStatus user.
+                         _m('List'));
+        $output->elementEnd('li');
+
         return true;
     }
 
-    function onPluginVersion(&$versions)
+    function onPluginVersion(array &$versions)
     {
         $versions[] = array('name' => 'OStatus',
                             'version' => GNUSOCIAL_VERSION,
@@ -1314,21 +1271,21 @@ class OStatusPlugin extends Plugin
     function onEndWebFingerNoticeLinks(XML_XRD $xrd, Notice $target)
     {
         $author = $target->getProfile();
-        $salmon_url = common_local_url('usersalmon', array('id' => $author->id));
+        $profiletype = $this->profileTypeString($author);
+        $salmon_url = common_local_url("{$profiletype}salmon", array('id' => $author->id));
         $xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url);
         return true;
     }
 
     function onEndWebFingerProfileLinks(XML_XRD $xrd, Profile $target)
     {
-        $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM,
-                            common_local_url('ApiTimelineUser',
-                                array('id' => $target->id, 'format' => 'atom')),
-                            'application/atom+xml');
+        if ($target->getObjectType() === ActivityObject::PERSON) {
+            $this->addWebFingerPersonLinks($xrd, $target);
+        }
 
-                // Salmon
-        $salmon_url = common_local_url('usersalmon',
-                                       array('id' => $target->id));
+        // Salmon
+        $profiletype = $this->profileTypeString($target);
+        $salmon_url = common_local_url("{$profiletype}salmon", array('id' => $target->id));
 
         $xrd->links[] = new XML_XRD_Element_Link(Salmon::REL_SALMON, $salmon_url);
 
@@ -1336,17 +1293,6 @@ class OStatusPlugin extends Plugin
         $xrd->links[] = new XML_XRD_Element_Link(Salmon::NS_REPLIES, $salmon_url);
         $xrd->links[] = new XML_XRD_Element_Link(Salmon::NS_MENTIONS, $salmon_url);
 
-        // Get this user's keypair
-        $magickey = Magicsig::getKV('user_id', $target->id);
-        if (!($magickey instanceof Magicsig)) {
-            // No keypair yet, let's generate one.
-            $magickey = new Magicsig();
-            $magickey->generate($target->id);
-        }
-
-        $xrd->links[] = new XML_XRD_Element_Link(Magicsig::PUBLICKEYREL,
-                            'data:application/magic-public-key,'. $magickey->toString(false));
-
         // TODO - finalize where the redirect should go on the publisher
         $xrd->links[] = new XML_XRD_Element_Link('http://ostatus.org/schema/1.0/subscribe',
                               common_local_url('ostatussub') . '?profile={uri}',
@@ -1355,4 +1301,120 @@ class OStatusPlugin extends Plugin
 
         return true;
     }
+
+    protected function profileTypeString(Profile $target)
+    {
+        // This is just used to have a definitive string response to "USERsalmon" or "GROUPsalmon"
+        switch ($target->getObjectType()) {
+        case ActivityObject::PERSON:
+            return 'user';
+        case ActivityObject::GROUP:
+            return 'group';
+        default:
+            throw new ServerException('Unknown profile type for WebFinger profile links');
+        }
+    }
+
+    protected function addWebFingerPersonLinks(XML_XRD $xrd, Profile $target)
+    {
+        $xrd->links[] = new XML_XRD_Element_Link(Discovery::UPDATESFROM,
+                            common_local_url('ApiTimelineUser',
+                                array('id' => $target->id, 'format' => 'atom')),
+                            'application/atom+xml');
+
+        // Get this profile's keypair
+        $magicsig = Magicsig::getKV('user_id', $target->id);
+        if (!$magicsig instanceof Magicsig && $target->isLocal()) {
+            $magicsig = Magicsig::generate($target->getUser());
+        }
+
+        if (!$magicsig instanceof Magicsig) {
+            return false;   // value doesn't mean anything, just figured I'd indicate this function didn't do anything
+        }
+        if (Event::handle('StartAttachPubkeyToUserXRD', array($magicsig, $xrd, $target))) {
+            $xrd->links[] = new XML_XRD_Element_Link(Magicsig::PUBLICKEYREL,
+                                'data:application/magic-public-key,'. $magicsig->toString());
+            // The following event handles plugins like Diaspora which add their own version of the Magicsig pubkey
+            Event::handle('EndAttachPubkeyToUserXRD', array($magicsig, $xrd, $target));
+        }
+    }
+
+    public function onGetLocalAttentions(Profile $actor, array $attention_uris, array &$mentions, array &$groups)
+    {
+        list($groups, $mentions) = Ostatus_profile::filterAttention($actor, $attention_uris);
+    }
+
+    // FIXME: Maybe this shouldn't be so authoritative that it breaks other remote profile lookups?
+    static public function onCheckActivityAuthorship(Activity $activity, Profile &$profile)
+    {
+        try {
+            $oprofile = Ostatus_profile::ensureProfileURL($profile->getUrl());
+            $profile = $oprofile->checkAuthorship($activity);
+        } catch (Exception $e) {
+            common_log(LOG_ERR, 'Could not get a profile or check authorship ('.get_class($e).': "'.$e->getMessage().'") for activity ID: '.$activity->id);
+            $profile = null;
+            return false;
+        }
+        return true;
+    }
+
+    public function onProfileDeleteRelated(Profile $profile, array &$related)
+    {
+        // Ostatus_profile has a 'profile_id' property, which will be used to find the object
+        $related[] = 'Ostatus_profile';
+
+        // Magicsig has a "user_id" column instead, so we have to delete it more manually:
+        $magicsig = Magicsig::getKV('user_id', $profile->id);
+        if ($magicsig instanceof Magicsig) {
+            $magicsig->delete();
+        }
+        return true;
+    }
+
+    public function onSalmonSlap($endpoint_uri, MagicEnvelope $magic_env, Profile $target=null)
+    {
+        $envxml = $magic_env->toXML($target);
+
+        $headers = array('Content-Type: application/magic-envelope+xml');
+
+        try {
+            $client = new HTTPClient();
+            $client->setBody($envxml);
+            $response = $client->post($endpoint_uri, $headers);
+        } catch (HTTP_Request2_Exception $e) {
+            common_log(LOG_ERR, "Salmon post to $endpoint_uri failed: " . $e->getMessage());
+            return false;
+        }
+        if ($response->getStatus() === 422) {
+            common_debug(sprintf('Salmon (from profile %d) endpoint %s returned status %s. We assume it is a Diaspora seed; will adapt and try again if that plugin is enabled!', $magic_env->getActor()->getID(), $endpoint_uri, $response->getStatus()));
+            return true;
+        }
+
+        // 200 OK is the best response
+        // 202 Accepted is what we get from Diaspora for example
+        if (!in_array($response->getStatus(), array(200, 202))) {
+            common_log(LOG_ERR, sprintf('Salmon (from profile %d) endpoint %s returned status %s: %s',
+                                $magic_env->getActor()->getID(), $endpoint_uri, $response->getStatus(), $response->getBody()));
+            return true;
+        }
+
+        // Since we completed the salmon slap, we discontinue the event
+        return false;
+    }
+
+    public function onCronDaily()
+    {
+        try {
+            $sub = FeedSub::renewalCheck();
+        } catch (NoResultException $e) {
+            common_log(LOG_INFO, "There were no expiring feeds.");
+            return;
+        }
+
+        $qm = QueueManager::get();
+        while ($sub->fetch()) {
+            $item = array('feedsub_id' => $sub->id);
+            $qm->enqueue($item, 'pushrenew');
+        }
+    }
 }