]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OStatus/classes/Ostatus_profile.php
fetch conversation URI in processPost, not processShare
[quix0rs-gnu-social.git] / plugins / OStatus / classes / Ostatus_profile.php
index 59eccc52d06b7a6d778edfdd7e54618c3ed00663..96ab7f6be72ab4cef7bb78d83ec2f183ab4d5b69 100644 (file)
@@ -63,10 +63,10 @@ class Ostatus_profile extends Managed_DataObject
             ),
             'primary key' => array('uri'),
             'unique keys' => array(
-                'ostatus_profile_profile_id_idx' => array('profile_id'),
-                'ostatus_profile_group_id_idx' => array('group_id'),
-                'ostatus_profile_peopletag_id_idx' => array('peopletag_id'),
-                'ostatus_profile_feeduri_idx' => array('feeduri'),
+                'ostatus_profile_profile_id_key' => array('profile_id'),
+                'ostatus_profile_group_id_key' => array('group_id'),
+                'ostatus_profile_peopletag_id_key' => array('peopletag_id'),
+                'ostatus_profile_feeduri_key' => array('feeduri'),
             ),
             'foreign keys' => array(
                 'ostatus_profile_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
@@ -82,15 +82,21 @@ class Ostatus_profile extends Managed_DataObject
     }
 
     /**
-     * Fetch the StatusNet-side profile for this feed
+     * Fetch the locally stored profile for this feed
      * @return Profile
+     * @throws NoProfileException if it was not found
      */
     public function localProfile()
     {
-        if ($this->profile_id) {
-            return Profile::getKV('id', $this->profile_id);
+        if ($this->isGroup()) {
+            return $this->localGroup()->getProfile();
         }
-        return null;
+
+        $profile = Profile::getKV('id', $this->profile_id);
+        if ($profile instanceof Profile) {
+            return $profile;
+        }
+        throw new NoProfileException($this->profile_id);
     }
 
     /**
@@ -130,7 +136,7 @@ class Ostatus_profile extends Managed_DataObject
         } else if ($this->isPeopletag()) {
             return ActivityObject::fromPeopletag($this->localPeopletag());
         } else {
-            return ActivityObject::fromProfile($this->localProfile());
+            return $this->localProfile()->asActivityObject();
         }
     }
 
@@ -154,7 +160,7 @@ class Ostatus_profile extends Managed_DataObject
             $noun = ActivityObject::fromPeopletag($this->localPeopletag());
             return $noun->asString('activity:' . $element);
         } else {
-            $noun = ActivityObject::fromProfile($this->localProfile());
+            $noun = $this->localProfile()->asActivityObject();
             return $noun->asString('activity:' . $element);
         }
     }
@@ -199,42 +205,48 @@ class Ostatus_profile extends Managed_DataObject
      * Send a subscription request to the hub for this feed.
      * The hub will later send us a confirmation POST to /main/push/callback.
      *
-     * @return bool true on success, false on failure
-     * @throws ServerException if feed state is not valid
+     * @return void
+     * @throws ServerException if feed state is not valid or subscription fails.
      */
     public function subscribe()
     {
         $feedsub = FeedSub::ensureFeed($this->feeduri);
         if ($feedsub->sub_state == 'active') {
             // Active subscription, we don't need to do anything.
-            return true;
-        } else {
-            // Inactive or we got left in an inconsistent state.
-            // Run a subscription request to make sure we're current!
-            return $feedsub->subscribe();
+            return;
         }
+
+        // Inactive or we got left in an inconsistent state.
+        // Run a subscription request to make sure we're current!
+        return $feedsub->subscribe();
     }
 
     /**
      * Check if this remote profile has any active local subscriptions, and
      * if not drop the PuSH subscription feed.
      *
-     * @return bool true on success, false on failure
+     * @return boolean true if subscription is removed, false if there are still subscribers to the feed
+     * @throws Exception of various kinds on failure.
      */
     public function unsubscribe() {
-        $this->garbageCollect();
+        return $this->garbageCollect();
     }
 
     /**
      * Check if this remote profile has any active local subscriptions, and
      * if not drop the PuSH subscription feed.
      *
-     * @return boolean
+     * @return boolean true if subscription is removed, false if there are still subscribers to the feed
+     * @throws Exception of various kinds on failure.
      */
     public function garbageCollect()
     {
         $feedsub = FeedSub::getKV('uri', $this->feeduri);
-        return $feedsub->garbageCollect();
+        if ($feedsub instanceof FeedSub) {
+            return $feedsub->garbageCollect();
+        }
+        // Since there's no FeedSub we can assume it's already garbage collected
+        return true;
     }
 
     /**
@@ -245,6 +257,7 @@ class Ostatus_profile extends Managed_DataObject
      * FeedSub::garbageCollect().
      *
      * @return int
+     * @throws NoProfileException if there is no local profile for the object
      */
     public function subscriberCount()
     {
@@ -256,9 +269,10 @@ class Ostatus_profile extends Managed_DataObject
             $count = $subscribers->N;
         } else {
             $profile = $this->localProfile();
-            $count = $profile->subscriberCount();
             if ($profile->hasLocalTags()) {
                 $count = 1;
+            } else {
+                $count = $profile->subscriberCount();
             }
         }
         common_log(LOG_INFO, __METHOD__ . " SUB COUNT BEFORE: $count");
@@ -279,59 +293,49 @@ class Ostatus_profile extends Managed_DataObject
      * @param string  $verb   Activity::SUBSCRIBE or Activity::JOIN
      * @param Object  $object object of the action; must define asActivityNoun($tag)
      */
-    public function notify($actor, $verb, $object=null, $target=null)
+    public function notify(Profile $actor, $verb, $object=null, $target=null)
     {
-        if (!($actor instanceof Profile)) {
-            $type = gettype($actor);
-            if ($type == 'object') {
-                $type = get_class($actor);
-            }
-            // TRANS: Server exception.
-            // TRANS: %1$s is the method name the exception occured in, %2$s is the actor type.
-            throw new ServerException(sprintf(_m('Invalid actor passed to %1$s: %2$s.'),__METHOD__,$type));
-        }
         if ($object == null) {
             $object = $this;
         }
-        if ($this->salmonuri) {
-            $text = 'update';
-            $id = TagURI::mint('%s:%s:%s',
-                               $verb,
-                               $actor->getURI(),
-                               common_date_iso8601(time()));
-
-            // @todo FIXME: Consolidate all these NS settings somewhere.
-            $attributes = array('xmlns' => Activity::ATOM,
-                                'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
-                                'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
-                                'xmlns:georss' => 'http://www.georss.org/georss',
-                                'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
-                                'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
-                                'xmlns:media' => 'http://purl.org/syndication/atommedia');
-
-            $entry = new XMLStringer();
-            $entry->elementStart('entry', $attributes);
-            $entry->element('id', null, $id);
-            $entry->element('title', null, $text);
-            $entry->element('summary', null, $text);
-            $entry->element('published', null, common_date_w3dtf(common_sql_now()));
-
-            $entry->element('activity:verb', null, $verb);
-            $entry->raw($actor->asAtomAuthor());
-            $entry->raw($actor->asActivityActor());
-            $entry->raw($object->asActivityNoun('object'));
-            if ($target != null) {
-                $entry->raw($target->asActivityNoun('target'));
-            }
-            $entry->elementEnd('entry');
-
-            $xml = $entry->getString();
-            common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
-
-            $salmon = new Salmon(); // ?
-            return $salmon->post($this->salmonuri, $xml, $actor);
+        if (empty($this->salmonuri)) {
+            return false;
         }
-        return false;
+        $text = 'update';
+        $id = TagURI::mint('%s:%s:%s',
+                           $verb,
+                           $actor->getURI(),
+                           common_date_iso8601(time()));
+
+        // @todo FIXME: Consolidate all these NS settings somewhere.
+        $attributes = array('xmlns' => Activity::ATOM,
+                            'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
+                            'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
+                            'xmlns:georss' => 'http://www.georss.org/georss',
+                            'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
+                            'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
+                            'xmlns:media' => 'http://purl.org/syndication/atommedia');
+
+        $entry = new XMLStringer();
+        $entry->elementStart('entry', $attributes);
+        $entry->element('id', null, $id);
+        $entry->element('title', null, $text);
+        $entry->element('summary', null, $text);
+        $entry->element('published', null, common_date_w3dtf(common_sql_now()));
+
+        $entry->element('activity:verb', null, $verb);
+        $entry->raw($actor->asAtomAuthor());
+        $entry->raw($actor->asActivityActor());
+        $entry->raw($object->asActivityNoun('object'));
+        if ($target != null) {
+            $entry->raw($target->asActivityNoun('target'));
+        }
+        $entry->elementEnd('entry');
+
+        $xml = $entry->getString();
+        common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
+
+        Salmon::post($this->salmonuri, $xml, $actor->getUser());
     }
 
     /**
@@ -342,12 +346,12 @@ class Ostatus_profile extends Managed_DataObject
      * @param Profile $actor
      * @return boolean success
      */
-    public function notifyActivity($entry, $actor)
+    public function notifyActivity($entry, Profile $actor)
     {
         if ($this->salmonuri) {
-            $salmon = new Salmon();
-            return $salmon->post($this->salmonuri, $this->notifyPrepXml($entry), $actor);
+            return Salmon::post($this->salmonuri, $this->notifyPrepXml($entry), $actor->getUser());
         }
+        common_debug(__CLASS__.' error: No salmonuri for Ostatus_profile uri: '.$this->uri);
 
         return false;
     }
@@ -478,7 +482,7 @@ class Ostatus_profile extends Managed_DataObject
 
         // The "WithProfile" events were added later.
 
-        if (Event::handle('StartHandleFeedEntryWithProfile', array($activity, $this, &$notice)) &&
+        if (Event::handle('StartHandleFeedEntryWithProfile', array($activity, $this->localProfile(), &$notice)) &&
             Event::handle('StartHandleFeedEntry', array($activity))) {
 
             switch ($activity->verb) {
@@ -516,10 +520,9 @@ class Ostatus_profile extends Managed_DataObject
     {
         $notice = null;
 
-        $oprofile = $this->checkAuthorship($activity);
-
-        if (!$oprofile instanceof Ostatus_profile) {
-            common_log(LOG_INFO, "No author matched share activity");
+        try {
+            $profile = ActivityUtils::checkAuthorship($activity, $this->localProfile());
+        } catch (ServerException $e) {
             return null;
         }
 
@@ -608,7 +611,7 @@ class Ostatus_profile extends Managed_DataObject
         // Get (safe!) HTML and text versions of the content
 
         $rendered = $this->purify($sourceContent);
-        $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
+        $content = common_strip_html($rendered);
 
         $shortened = common_shorten_links($content);
 
@@ -619,7 +622,7 @@ class Ostatus_profile extends Managed_DataObject
 
         if (Notice::contentTooLong($shortened)) {
             $attachment = $this->saveHTMLFile($activity->title, $rendered);
-            $summary = html_entity_decode(strip_tags($activity->summary), ENT_QUOTES, 'UTF-8');
+            $summary = common_strip_html($activity->summary);
             if (empty($summary)) {
                 $summary = $content;
             }
@@ -670,7 +673,7 @@ class Ostatus_profile extends Managed_DataObject
         if ($activity->context) {
             // TODO: context->attention
             list($options['groups'], $options['replies'])
-                = $this->filterAttention($oprofile, $activity->context->attention);
+                = self::filterAttention($profile, $activity->context->attention);
 
             // Maintain direct reply associations
             // @todo FIXME: What about conversation ID?
@@ -713,7 +716,7 @@ class Ostatus_profile extends Managed_DataObject
             $options['urls'][] = $href;
         }
 
-        $notice = Notice::saveNew($oprofile->profile_id,
+        $notice = Notice::saveNew($profile->id,
                                   $content,
                                   'ostatus',
                                   $options);
@@ -732,11 +735,7 @@ class Ostatus_profile extends Managed_DataObject
     {
         $notice = null;
 
-        $oprofile = $this->checkAuthorship($activity);
-
-        if (!$oprofile instanceof Ostatus_profile) {
-            return null;
-        }
+        $profile = ActivityUtils::checkAuthorship($activity, $this->localProfile());
 
         // It's not always an ActivityObject::NOTE, but... let's just say it is.
 
@@ -779,7 +778,7 @@ class Ostatus_profile extends Managed_DataObject
         // Get (safe!) HTML and text versions of the content
 
         $rendered = $this->purify($sourceContent);
-        $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
+        $content = common_strip_html($rendered);
 
         $shortened = common_shorten_links($content);
 
@@ -790,7 +789,7 @@ class Ostatus_profile extends Managed_DataObject
 
         if (Notice::contentTooLong($shortened)) {
             $attachment = $this->saveHTMLFile($note->title, $rendered);
-            $summary = html_entity_decode(strip_tags($note->summary), ENT_QUOTES, 'UTF-8');
+            $summary = common_strip_html($note->summary);
             if (empty($summary)) {
                 $summary = $content;
             }
@@ -839,7 +838,7 @@ class Ostatus_profile extends Managed_DataObject
         if ($activity->context) {
             // TODO: context->attention
             list($options['groups'], $options['replies'])
-                = $this->filterAttention($oprofile, $activity->context->attention);
+                = self::filterAttention($profile, $activity->context->attention);
 
             // Maintain direct reply associations
             // @todo FIXME: What about conversation ID?
@@ -849,6 +848,10 @@ class Ostatus_profile extends Managed_DataObject
                     $options['reply_to'] = $orig->id;
                 }
             }
+            if (!empty($activity->context->conversation)) {
+                // we store the URI here, Notice class can look it up later
+                $options['conversation'] = $activity->context->conversation;
+            }
 
             $location = $activity->context->location;
             if ($location) {
@@ -882,7 +885,7 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         try {
-            $saved = Notice::saveNew($oprofile->profile_id,
+            $saved = Notice::saveNew($profile->id,
                                      $content,
                                      'ostatus',
                                      $options);
@@ -913,11 +916,11 @@ class Ostatus_profile extends Managed_DataObject
 
     /**
      * Filters a list of recipient ID URIs to just those for local delivery.
-     * @param Ostatus_profile local profile of sender
+     * @param Profile local profile of sender
      * @param array in/out &$attention_uris set of URIs, will be pruned on output
      * @return array of group IDs
      */
-    protected function filterAttention($sender, array $attention)
+    static public function filterAttention(Profile $sender, array $attention)
     {
         common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', array_keys($attention)));
         $groups = array();
@@ -938,11 +941,10 @@ class Ostatus_profile extends Managed_DataObject
                 $group = User_group::getKV('id', $id);
                 if ($group instanceof User_group) {
                     // Deliver to all members of this local group if allowed.
-                    $profile = $sender->localProfile();
-                    if ($profile->isMember($group)) {
+                    if ($sender->isMember($group)) {
                         $groups[] = $group->id;
                     } else {
-                        common_log(LOG_DEBUG, "Skipping reply to local group $group->nickname as sender $profile->id is not a member");
+                        common_log(LOG_DEBUG, sprintf('Skipping reply to local group %s as sender %d is not a member', $group->getNickname(), $sender->id));
                     }
                     continue;
                 } else {
@@ -1078,17 +1080,17 @@ class Ostatus_profile extends Managed_DataObject
             return null;
         }
 
-        // Is it a known Ostatus profile?
-        $oprofile = Ostatus_profile::getKV('profile_id', $profile->id);
-        if ($oprofile instanceof Ostatus_profile) {
+        try {
+            $oprofile = self::getFromProfile($profile);
+            // We found the profile, return it!
             return $oprofile;
-        }
-
-        // Is it a local user?
-        $user = User::getKV('id', $profile->id);
-        if ($user instanceof User) {
-            // @todo i18n FIXME: use sprintf and add i18n (?)
-            throw new OStatusShadowException($profile, "'$profile_url' is the profile for local user '{$user->nickname}'.");
+        } catch (NoResultException $e) {
+            // Could not find an OStatus profile, is it instead a local user?
+            $user = User::getKV('id', $profile->id);
+            if ($user instanceof User) {
+                // @todo i18n FIXME: use sprintf and add i18n (?)
+                throw new OStatusShadowException($profile, "'$profile_url' is the profile for local user '{$user->nickname}'.");
+            }
         }
 
         // Continue discovery; it's a remote profile
@@ -1098,6 +1100,16 @@ class Ostatus_profile extends Managed_DataObject
         return null;
     }
 
+    static function getFromProfile(Profile $profile)
+    {
+        $oprofile = new Ostatus_profile();
+        $oprofile->profile_id = $profile->id;
+        if (!$oprofile->find(true)) {
+            throw new NoResultException($oprofile);
+        }
+        return $oprofile;
+    }
+
     /**
      * Look up and if necessary create an Ostatus_profile for remote entity
      * with the given update feed. This should never return null -- you will
@@ -1224,8 +1236,10 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         if ($this->isGroup()) {
+            // FIXME: throw exception for localGroup
             $self = $this->localGroup();
         } else {
+            // this throws an exception already
             $self = $this->localProfile();
         }
         if (!$self) {
@@ -1381,7 +1395,7 @@ class Ostatus_profile extends Managed_DataObject
     public static function ensureActivityObjectProfile($object, $hints=array())
     {
         $profile = self::getActivityObjectProfile($object);
-        if ($profile) {
+        if ($profile instanceof Ostatus_profile) {
             $profile->updateFromActivityObject($object, $hints);
         } else {
             $profile = self::createActivityObjectProfile($object, $hints);
@@ -1916,7 +1930,7 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         // Try looking it up
-        $oprofile = Ostatus_profile::getKV('uri', 'acct:'.$addr);
+        $oprofile = Ostatus_profile::getKV('uri', Discovery::normalize($addr));
 
         if ($oprofile instanceof Ostatus_profile) {
             self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
@@ -1953,7 +1967,9 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         // If we got a feed URL, try that
+        $feedUrl = null;
         if (array_key_exists('feedurl', $hints)) {
+            $feedUrl = $hints['feedurl'];
             try {
                 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
                 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
@@ -1966,7 +1982,9 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         // If we got a profile page, try that!
+        $profileUrl = null;
         if (array_key_exists('profileurl', $hints)) {
+            $profileUrl = $hints['profileurl'];
             try {
                 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
                 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
@@ -2003,7 +2021,7 @@ class Ostatus_profile extends Managed_DataObject
             $profile->nickname = self::nicknameFromUri($uri);
             $profile->created  = common_sql_now();
 
-            if (isset($profileUrl)) {
+            if (!is_null($profileUrl)) {
                 $profile->profileurl = $profileUrl;
             }
 
@@ -2022,13 +2040,14 @@ class Ostatus_profile extends Managed_DataObject
             $oprofile->profile_id = $profile_id;
             $oprofile->created    = common_sql_now();
 
-            if (isset($feedUrl)) {
-                $profile->feeduri = $feedUrl;
+            if (!is_null($feedUrl)) {
+                $oprofile->feeduri = $feedUrl;
             }
 
             $result = $oprofile->insert();
 
             if ($result === false) {
+                $profile->delete();
                 common_log_db_error($oprofile, 'INSERT', __FILE__);
                 // TRANS: Exception. %s is a webfinger address.
                 throw new Exception(sprintf(_m('Could not save OStatus profile for "%s".'),$addr));
@@ -2129,7 +2148,7 @@ class Ostatus_profile extends Managed_DataObject
         return $oprofile;
     }
 
-    function checkAuthorship($activity)
+    public function checkAuthorship(Activity $activity)
     {
         if ($this->isGroup() || $this->isPeopletag()) {
             // A group or propletag feed will contain posts from multiple authors.
@@ -2139,7 +2158,7 @@ class Ostatus_profile extends Managed_DataObject
                 common_log(LOG_WARNING,
                     "OStatus: skipping post with group listed ".
                     "as author: " . $oprofile->getUri() . " in feed from " . $this->getUri());
-                return false;
+                throw new ServerException('Activity author is a non-actor');
             }
         } else {
             $actor = $activity->actor;
@@ -2164,7 +2183,7 @@ class Ostatus_profile extends Managed_DataObject
             $oprofile = $this;
         }
 
-        return $oprofile;
+        return $oprofile->localProfile();
     }
 }