]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OStatus/classes/Ostatus_profile.php
Stronger typing and function access control in OStatus
[quix0rs-gnu-social.git] / plugins / OStatus / classes / Ostatus_profile.php
index a862c978d27d0005f880b161e0c0a6eff52011bd..7ab5b7c8f030818d3e6fd32ff4caaf230123cd23 100644 (file)
@@ -76,6 +76,11 @@ class Ostatus_profile extends Managed_DataObject
         );
     }
 
+    public function getUri()
+    {
+        return $this->uri;
+    }
+
     /**
      * Fetch the StatusNet-side profile for this feed
      * @return Profile
@@ -165,10 +170,10 @@ class Ostatus_profile extends Managed_DataObject
             return true;
         } else if ($this->group_id && ($this->profile_id || $this->peopletag_id)) {
             // TRANS: Server exception. %s is a URI
-            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->uri));
+            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->getUri()));
         } else {
             // TRANS: Server exception. %s is a URI
-            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->uri));
+            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->getUri()));
         }
     }
 
@@ -183,10 +188,10 @@ class Ostatus_profile extends Managed_DataObject
             return true;
         } else if ($this->peopletag_id && ($this->profile_id || $this->group_id)) {
             // TRANS: Server exception. %s is a URI
-            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->uri));
+            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->getUri()));
         } else {
             // TRANS: Server exception. %s is a URI
-            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->uri));
+            throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->getUri()));
         }
     }
 
@@ -337,12 +342,13 @@ 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);
         }
+        common_debug(__CLASS__.' error: No salmonuri for Ostatus_profile uri: '.$this->uri);
 
         return false;
     }
@@ -513,11 +519,20 @@ class Ostatus_profile extends Managed_DataObject
 
         $oprofile = $this->checkAuthorship($activity);
 
-        if (empty($oprofile)) {
+        if (!$oprofile instanceof Ostatus_profile) {
             common_log(LOG_INFO, "No author matched share activity");
             return null;
         }
 
+        // The id URI will be used as a unique identifier for the notice,
+        // protecting against duplicate saves. It isn't required to be a URL;
+        // tag: URIs for instance are found in Google Buzz feeds.
+        $dupe = Notice::getKV('uri', $activity->id);
+        if ($dupe instanceof Notice) {
+            common_log(LOG_INFO, "OStatus: ignoring duplicate post: {$activity->id}");
+            return $dupe;
+        }
+
         if (count($activity->objects) != 1) {
             // TRANS: Client exception thrown when trying to share multiple activities at once.
             throw new ClientException(_m('Can only handle share activities with exactly one object.'));
@@ -525,43 +540,48 @@ class Ostatus_profile extends Managed_DataObject
 
         $shared = $activity->objects[0];
 
-        if (!($shared instanceof Activity)) {
+        if (!$shared instanceof Activity) {
             // TRANS: Client exception thrown when trying to share a non-activity object.
             throw new ClientException(_m('Can only handle shared activities.'));
         }
 
+        $sharedId = $shared->id;
+        if (!empty($shared->objects[0]->id)) {
+            // Because StatusNet since commit 8cc4660 sets $shared->id to a TagURI which
+            // fucks up federation, because the URI is no longer recognised by the origin.
+            // So we set it to the object ID if it exists, otherwise we trust $shared->id
+            $sharedId = $shared->objects[0]->id;
+        }
+        if (empty($sharedId)) {
+            throw new ClientException(_m('Shared activity does not have an id'));
+        }
+
         // First check if we have the shared activity. This has to be done first, because
         // we can't use these functions to "ensureActivityObjectProfile" of a local user,
         // who might be the creator of the shared activity in question.
-        $sharedId = ($shared->id) ? $shared->id : $shared->objects[0]->id;
         $sharedNotice = Notice::getKV('uri', $sharedId);
-        if (!($sharedNotice instanceof Notice)) {
-            // If no local notice is found, process it!
+        if (!$sharedNotice instanceof Notice) {
+            // If no locally stored notice is found, process it!
             // TODO: Remember to check Deleted_notice!
-            $other = Ostatus_profile::ensureActivityObjectProfile($shared->actor);
-            $sharedNotice = $other->processActivity($shared, $method);
-        }
-
-        if (!($sharedNotice instanceof Notice)) {
-            // And if we apparently can't get the shared notice, we'll abort the whole thing.
-            // TRANS: Client exception thrown when saving an activity share fails.
-            // TRANS: %s is a share ID.
-            throw new ClientException(sprintf(_m('Failed to save activity %s.'), $sharedId));
-        }
-
-        // The id URI will be used as a unique identifier for for the notice,
-        // protecting against duplicate saves. It isn't required to be a URL;
-        // tag: URIs for instance are found in Google Buzz feeds.
-
-        $sourceUri = $activity->id;
-
-        $dupe = Notice::getKV('uri', $sourceUri);
-        if ($dupe) {
-            common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
-            return $dupe;
+            // TODO: If a post is shared that we can't retrieve - what to do?
+            try {
+                $other = self::ensureActivityObjectProfile($shared->actor);
+                $sharedNotice = $other->processActivity($shared, $method);
+                if (!$sharedNotice instanceof Notice) {
+                    // And if we apparently can't get the shared notice, we'll abort the whole thing.
+                    // TRANS: Client exception thrown when saving an activity share fails.
+                    // TRANS: %s is a share ID.
+                    throw new ClientException(sprintf(_m('Failed to save activity %s.'), $sharedId));
+                }
+            } catch (FeedSubException $e) {
+                // Remote feed could not be found or verified, should we
+                // transform this into an "RT @user Blah, blah, blah..."?
+                common_log(LOG_INFO, __METHOD__ . ' got a ' . get_class($e) . ': ' . $e->getMessage());
+                return null;
+            }
         }
 
-        // We'll also want to save a web link to the original notice, if provided.
+        // We'll want to save a web link to the original notice, if provided.
 
         $sourceUrl = null;
         if ($activity->link) {
@@ -583,7 +603,7 @@ class Ostatus_profile extends Managed_DataObject
         } else {
             // @todo FIXME: Fetch from $sourceUrl?
             // TRANS: Client exception. %s is a source URI.
-            throw new ClientException(sprintf(_m('No content for notice %s.'),$sourceUri));
+            throw new ClientException(sprintf(_m('No content for notice %s.'), $activity->id));
         }
 
         // Get (safe!) HTML and text versions of the content
@@ -632,7 +652,7 @@ class Ostatus_profile extends Managed_DataObject
 
         $options = array('is_local' => Notice::REMOTE,
                          'url' => $sourceUrl,
-                         'uri' => $sourceUri,
+                         'uri' => $activity->id,
                          'rendered' => $rendered,
                          'replies' => array(),
                          'groups' => array(),
@@ -649,17 +669,16 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         if ($activity->context) {
-            // Any individual or group attn: targets?
-            $replies = $activity->context->attention;
-            $options['groups'] = $this->filterReplies($oprofile, $replies);
-            $options['replies'] = $replies;
+            // TODO: context->attention
+            list($options['groups'], $options['replies'])
+                = $this->filterAttention($oprofile, $activity->context->attention);
 
             // Maintain direct reply associations
             // @todo FIXME: What about conversation ID?
             if (!empty($activity->context->replyToID)) {
                 $orig = Notice::getKV('uri',
                                           $activity->context->replyToID);
-                if (!empty($orig)) {
+                if ($orig instanceof Notice) {
                     $options['reply_to'] = $orig->id;
                 }
             }
@@ -716,7 +735,7 @@ class Ostatus_profile extends Managed_DataObject
 
         $oprofile = $this->checkAuthorship($activity);
 
-        if (empty($oprofile)) {
+        if (!$oprofile instanceof Ostatus_profile) {
             return null;
         }
 
@@ -724,12 +743,12 @@ class Ostatus_profile extends Managed_DataObject
 
         $note = $activity->objects[0];
 
-        // The id URI will be used as a unique identifier for for the notice,
+        // The id URI will be used as a unique identifier for the notice,
         // protecting against duplicate saves. It isn't required to be a URL;
         // tag: URIs for instance are found in Google Buzz feeds.
         $sourceUri = $note->id;
         $dupe = Notice::getKV('uri', $sourceUri);
-        if ($dupe) {
+        if ($dupe instanceof Notice) {
             common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
             return $dupe;
         }
@@ -819,17 +838,15 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         if ($activity->context) {
-            // Any individual or group attn: targets?
-            $replies = $activity->context->attention;
-            $options['groups'] = $this->filterReplies($oprofile, $replies);
-            $options['replies'] = $replies;
+            // TODO: context->attention
+            list($options['groups'], $options['replies'])
+                = $this->filterAttention($oprofile, $activity->context->attention);
 
             // Maintain direct reply associations
             // @todo FIXME: What about conversation ID?
             if (!empty($activity->context->replyToID)) {
-                $orig = Notice::getKV('uri',
-                                          $activity->context->replyToID);
-                if (!empty($orig)) {
+                $orig = Notice::getKV('uri', $activity->context->replyToID);
+                if ($orig instanceof Notice) {
                     $options['reply_to'] = $orig->id;
                 }
             }
@@ -870,7 +887,7 @@ class Ostatus_profile extends Managed_DataObject
                                      $content,
                                      'ostatus',
                                      $options);
-            if ($saved) {
+            if ($saved instanceof Notice) {
                 Ostatus_source::saveNew($saved, $this, $method);
                 if (!empty($attachment)) {
                     File_to_post::processNew($attachment->id, $saved->id);
@@ -901,26 +918,26 @@ class Ostatus_profile extends Managed_DataObject
      * @param array in/out &$attention_uris set of URIs, will be pruned on output
      * @return array of group IDs
      */
-    protected function filterReplies($sender, &$attention_uris)
+    protected function filterAttention($sender, array $attention)
     {
-        common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', $attention_uris));
+        common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', array_keys($attention)));
         $groups = array();
         $replies = array();
-        foreach (array_unique($attention_uris) as $recipient) {
+        foreach ($attention as $recipient=>$type) {
             // Is the recipient a local user?
             $user = User::getKV('uri', $recipient);
-            if ($user) {
+            if ($user instanceof User) {
                 // @todo FIXME: Sender verification, spam etc?
                 $replies[] = $recipient;
                 continue;
             }
 
             // Is the recipient a local group?
-            // $group = User_group::getKV('uri', $recipient);
+            // TODO: $group = User_group::getKV('uri', $recipient);
             $id = OStatusPlugin::localGroupFromUrl($recipient);
             if ($id) {
                 $group = User_group::getKV('id', $id);
-                if ($group) {
+                if ($group instanceof User_group) {
                     // Deliver to all members of this local group if allowed.
                     $profile = $sender->localProfile();
                     if ($profile->isMember($group)) {
@@ -936,14 +953,14 @@ class Ostatus_profile extends Managed_DataObject
 
             // Is the recipient a remote user or group?
             try {
-                $oprofile = Ostatus_profile::ensureProfileURI($recipient);
+                $oprofile = self::ensureProfileURI($recipient);
                 if ($oprofile->isGroup()) {
                     // Deliver to local members of this remote group.
                     // @todo FIXME: Sender verification?
                     $groups[] = $oprofile->group_id;
                 } else {
                     // may be canonicalized or something
-                    $replies[] = $oprofile->uri;
+                    $replies[] = $oprofile->getUri();
                 }
                 continue;
             } catch (Exception $e) {
@@ -952,10 +969,9 @@ class Ostatus_profile extends Managed_DataObject
             }
 
         }
-        $attention_uris = $replies;
         common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
         common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
-        return $groups;
+        return array($groups, $replies);
     }
 
     /**
@@ -972,7 +988,7 @@ class Ostatus_profile extends Managed_DataObject
     {
         $oprofile = self::getFromProfileURL($profile_url);
 
-        if (!empty($oprofile)) {
+        if ($oprofile instanceof Ostatus_profile) {
             return $oprofile;
         }
 
@@ -1000,7 +1016,7 @@ class Ostatus_profile extends Managed_DataObject
 
             $oprofile = self::getFromProfileURL($finalUrl);
 
-            if (!empty($oprofile)) {
+            if ($oprofile instanceof Ostatus_profile) {
                 return $oprofile;
             }
         }
@@ -1059,24 +1075,19 @@ class Ostatus_profile extends Managed_DataObject
     static function getFromProfileURL($profile_url)
     {
         $profile = Profile::getKV('profileurl', $profile_url);
-
-        if (empty($profile)) {
+        if (!$profile instanceof Profile) {
             return null;
         }
 
         // Is it a known Ostatus profile?
-
         $oprofile = Ostatus_profile::getKV('profile_id', $profile->id);
-
-        if (!empty($oprofile)) {
+        if ($oprofile instanceof Ostatus_profile) {
             return $oprofile;
         }
 
         // Is it a local user?
-
         $user = User::getKV('id', $profile->id);
-
-        if (!empty($user)) {
+        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}'.");
         }
@@ -1105,7 +1116,10 @@ class Ostatus_profile extends Managed_DataObject
 
         $huburi = $discover->getHubLink();
         $hints['hub'] = $huburi;
-        $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
+
+        // XXX: NS_REPLIES is deprecated anyway, so let's remove it in the future.
+        $salmonuri = $discover->getAtomLink(Salmon::REL_SALMON)
+                        ?: $discover->getAtomLink(Salmon::NS_REPLIES);
         $hints['salmon'] = $salmonuri;
 
         if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
@@ -1219,7 +1233,7 @@ class Ostatus_profile extends Managed_DataObject
             throw new ServerException(sprintf(
                 // TRANS: Server exception. %s is a URI.
                 _m('Tried to update avatar for unsaved remote profile %s.'),
-                $this->uri));
+                $this->getUri()));
         }
 
         // @todo FIXME: This should be better encapsulated
@@ -1451,7 +1465,7 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         $user = User::getKV('uri', $homeuri);
-        if ($user) {
+        if ($user instanceof User) {
             // TRANS: Exception.
             throw new Exception(_m('Local user cannot be referenced as remote.'));
         }
@@ -1462,9 +1476,9 @@ class Ostatus_profile extends Managed_DataObject
         }
 
         $ptag = Profile_list::getKV('uri', $homeuri);
-        if ($ptag) {
+        if ($ptag instanceof Profile_list) {
             $local_user = User::getKV('id', $ptag->tagger);
-            if (!empty($local_user)) {
+            if ($local_user instanceof User) {
                 // TRANS: Exception.
                 throw new Exception(_m('Local list cannot be referenced as remote.'));
             }
@@ -1484,7 +1498,9 @@ class Ostatus_profile extends Managed_DataObject
                 $discover = new FeedDiscovery();
                 $discover->discoverFromFeedURL($hints['feedurl']);
             }
-            $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
+            // XXX: NS_REPLIES is deprecated anyway, so let's remove it in the future.
+            $salmonuri = $discover->getAtomLink(Salmon::REL_SALMON)
+                            ?: $discover->getAtomLink(Salmon::NS_REPLIES);
         }
 
         if (array_key_exists('hub', $hints)) {
@@ -1895,7 +1911,7 @@ class Ostatus_profile extends Managed_DataObject
                 throw new Exception(_m('Not a valid webfinger address.'));
             }
             $oprofile = Ostatus_profile::getKV('uri', $uri);
-            if (!empty($oprofile)) {
+            if ($oprofile instanceof Ostatus_profile) {
                 return $oprofile;
             }
         }
@@ -1903,8 +1919,8 @@ class Ostatus_profile extends Managed_DataObject
         // Try looking it up
         $oprofile = Ostatus_profile::getKV('uri', 'acct:'.$addr);
 
-        if (!empty($oprofile)) {
-            self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
+        if ($oprofile instanceof Ostatus_profile) {
+            self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
             return $oprofile;
         }
 
@@ -1942,7 +1958,7 @@ class Ostatus_profile extends Managed_DataObject
             try {
                 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
                 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
-                self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
+                self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
                 return $oprofile;
             } catch (Exception $e) {
                 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
@@ -1955,7 +1971,7 @@ class Ostatus_profile extends Managed_DataObject
             try {
                 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
                 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
-                self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
+                self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
                 return $oprofile;
             } catch (OStatusShadowException $e) {
                 // We've ended up with a remote reference to a local user or group.
@@ -1994,7 +2010,7 @@ class Ostatus_profile extends Managed_DataObject
 
             $profile_id = $profile->insert();
 
-            if (!$profile_id) {
+            if ($profile_id === false) {
                 common_log_db_error($profile, 'INSERT', __FILE__);
                 // TRANS: Exception. %s is a webfinger address.
                 throw new Exception(sprintf(_m('Could not save profile for "%s".'),$addr));
@@ -2013,13 +2029,13 @@ class Ostatus_profile extends Managed_DataObject
 
             $result = $oprofile->insert();
 
-            if (!$result) {
+            if ($result === false) {
                 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));
             }
 
-            self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
+            self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
             return $oprofile;
         }
 
@@ -2081,33 +2097,34 @@ class Ostatus_profile extends Managed_DataObject
 
         $oprofile = Ostatus_profile::getKV('uri', $uri);
 
-        // If unfound, do discovery stuff
+        if ($oprofile instanceof Ostatus_profile) {
+            return $oprofile;
+        }
 
-        if (empty($oprofile)) {
-            if (preg_match("/^(\w+)\:(.*)/", $uri, $match)) {
-                $protocol = $match[1];
-                switch ($protocol) {
-                case 'http':
-                case 'https':
-                    $oprofile = Ostatus_profile::ensureProfileURL($uri);
-                    break;
-                case 'acct':
-                case 'mailto':
-                    $rest = $match[2];
-                    $oprofile = Ostatus_profile::ensureWebfinger($rest);
-                    break;
-                default:
-                    // TRANS: Server exception.
-                    // TRANS: %1$s is a protocol, %2$s is a URI.
-                    throw new ServerException(sprintf(_m('Unrecognized URI protocol for profile: %1$s (%2$s).'),
-                                                      $protocol,
-                                                      $uri));
-                    break;
-                }
-            } else {
-                // TRANS: Server exception. %s is a URI.
-                throw new ServerException(sprintf(_m('No URI protocol for profile: %s.'),$uri));
+        // If unfound, do discovery stuff
+        if (preg_match("/^(\w+)\:(.*)/", $uri, $match)) {
+            $protocol = $match[1];
+            switch ($protocol) {
+            case 'http':
+            case 'https':
+                $oprofile = self::ensureProfileURL($uri);
+                break;
+            case 'acct':
+            case 'mailto':
+                $rest = $match[2];
+                $oprofile = self::ensureWebfinger($rest);
+                break;
+            default:
+                // TRANS: Server exception.
+                // TRANS: %1$s is a protocol, %2$s is a URI.
+                throw new ServerException(sprintf(_m('Unrecognized URI protocol for profile: %1$s (%2$s).'),
+                                                  $protocol,
+                                                  $uri));
+                break;
             }
+        } else {
+            // TRANS: Server exception. %s is a URI.
+            throw new ServerException(sprintf(_m('No URI protocol for profile: %s.'),$uri));
         }
 
         return $oprofile;
@@ -2122,7 +2139,7 @@ class Ostatus_profile extends Managed_DataObject
                 // Groups can't post notices in StatusNet.
                 common_log(LOG_WARNING,
                     "OStatus: skipping post with group listed ".
-                    "as author: $oprofile->uri in feed from $this->uri");
+                    "as author: " . $oprofile->getUri() . " in feed from " . $this->getUri());
                 return false;
             }
         } else {
@@ -2130,7 +2147,7 @@ class Ostatus_profile extends Managed_DataObject
 
             if (empty($actor)) {
                 // OK here! assume the default
-            } else if ($actor->id == $this->uri || $actor->link == $this->uri) {
+            } else if ($actor->id == $this->getUri() || $actor->link == $this->getUri()) {
                 $this->updateFromActivityObject($actor);
             } else if ($actor->id) {
                 // We have an ActivityStreams actor with an explicit ID that doesn't match the feed owner.
@@ -2139,7 +2156,7 @@ class Ostatus_profile extends Managed_DataObject
                 // Most likely this is a plain ol' blog feed of some kind which
                 // doesn't match our expectations. We'll take the entry, but ignore
                 // the <author> info.
-                common_log(LOG_WARNING, "Got an actor '{$actor->title}' ({$actor->id}) on single-user feed for {$this->uri}");
+                common_log(LOG_WARNING, "Got an actor '{$actor->title}' ({$actor->id}) on single-user feed for " . $this->getUri());
             } else {
                 // Plain <author> without ActivityStreams actor info.
                 // We'll just ignore this info for now and save the update under the feed's identity.