]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OStatus/classes/Ostatus_profile.php
OStatus: do PuSH subscription setup from subscribe/join event hooks, so resubscribing...
[quix0rs-gnu-social.git] / plugins / OStatus / classes / Ostatus_profile.php
index b67e2020265d738e36bbd628c0cec3cb1e145226..91b957fa23f591515863ee1d6bf284e6be325346 100644 (file)
@@ -137,12 +137,49 @@ class Ostatus_profile extends Memcached_DataObject
         return null;
     }
 
+    /**
+     * Returns an ActivityObject describing this remote user or group profile.
+     * Can then be used to generate Atom chunks.
+     *
+     * @return ActivityObject
+     */
+    function asActivityObject()
+    {
+        if ($this->isGroup()) {
+            $object = new ActivityObject();
+            $object->type = 'http://activitystrea.ms/schema/1.0/group';
+            $object->id = $this->uri;
+            $self = $this->localGroup();
+
+            // @fixme put a standard getAvatar() interface on groups too
+            if ($self->homepage_logo) {
+                $object->avatar = $self->homepage_logo;
+                $map = array('png' => 'image/png',
+                             'jpg' => 'image/jpeg',
+                             'jpeg' => 'image/jpeg',
+                             'gif' => 'image/gif');
+                $extension = pathinfo(parse_url($avatarHref, PHP_URL_PATH), PATHINFO_EXTENSION);
+                if (isset($map[$extension])) {
+                    // @fixme this ain't used/saved yet
+                    $object->avatarType = $map[$extension];
+                }
+            }
+
+            $object->link = $this->uri; // @fixme accurate?
+            return $object;
+        } else {
+            return ActivityObject::fromProfile($this->localProfile());
+        }
+    }
+
     /**
      * Returns an XML string fragment with profile information as an
      * Activity Streams noun object with the given element type.
      *
      * Assumes that 'activity' namespace has been previously defined.
      *
+     * @fixme replace with wrappers on asActivityObject when it's got everything.
+     *
      * @param string $element one of 'actor', 'subject', 'object', 'target'
      * @return string
      */
@@ -202,11 +239,19 @@ class Ostatus_profile extends Memcached_DataObject
     }
 
     /**
-     * Damn dirty hack!
+     * @return boolean true if this is a remote group
      */
     function isGroup()
     {
-        return (strpos($this->feeduri, '/groups/') !== false);
+        if ($this->profile_id && !$this->group_id) {
+            return false;
+        } else if ($this->group_id && !$this->profile_id) {
+            return true;
+        } else if ($this->group_id && $this->profile_id) {
+            throw new ServerException("Invalid ostatus_profile state: both group and profile IDs set for $this->uri");
+        } else {
+            throw new ServerException("Invalid ostatus_profile state: both group and profile IDs empty for $this->uri");
+        }
     }
 
     /**
@@ -301,6 +346,29 @@ class Ostatus_profile extends Memcached_DataObject
         }
     }
 
+    /**
+     * Check if this remote profile has any active local subscriptions, and
+     * if not drop the PuSH subscription feed.
+     *
+     * @return boolean
+     */
+    public function garbageCollect()
+    {
+        if ($this->isGroup()) {
+            $members = $this->localGroup()->getMembers(0, 1);
+            $count = $members->N;
+        } else {
+            $count = $this->localProfile()->subscriberCount();
+        }
+        if ($count == 0) {
+            common_log(LOG_INFO, "Unsubscribing from now-unused remote feed $oprofile->feeduri");
+            $this->unsubscribe();
+            return true;
+        } else {
+            return false;
+        }
+    }
+
     /**
      * Send an Activity Streams notification to the remote Salmon endpoint,
      * if so configured.
@@ -334,7 +402,8 @@ class Ostatus_profile extends Memcached_DataObject
                                 '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:ostatus' => 'http://ostatus.org/schema/1.0',
+                                'xmlns:poco' => 'http://portablecontacts.net/spec/1.0');
 
             $entry = new XMLStringer();
             $entry->elementStart('entry', $attributes);
@@ -353,22 +422,24 @@ class Ostatus_profile extends Memcached_DataObject
             common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
 
             $salmon = new Salmon(); // ?
-            $salmon->post($this->salmonuri, $xml);
+            return $salmon->post($this->salmonuri, $xml);
         }
+        return false;
     }
 
     public function notifyActivity($activity)
     {
         if ($this->salmonuri) {
 
-            $xml = $activity->asString(true);
+            $xml = '<?xml version="1.0" encoding="UTF-8" ?' . '>' .
+                          $activity->asString(true);
 
             $salmon = new Salmon(); // ?
 
-            $salmon->post($this->salmonuri, $xml);
+            return $salmon->post($this->salmonuri, $xml);
         }
 
-        return;
+        return false;
     }
 
     function getBestName()
@@ -454,6 +525,7 @@ class Ostatus_profile extends Memcached_DataObject
     /**
      * Process an incoming post activity from this remote feed.
      * @param Activity $activity
+     * @fixme break up this function, it's getting nasty long
      */
     protected function processPost($activity)
     {
@@ -471,7 +543,6 @@ class Ostatus_profile extends Memcached_DataObject
             }
             $oprofile = $this;
         }
-
         $sourceUri = $activity->object->id;
 
         $dupe = Notice::staticGet('uri', $sourceUri);
@@ -508,13 +579,76 @@ class Ostatus_profile extends Memcached_DataObject
             }
         }
 
-        // @fixme save detailed ostatus source info
-        // @fixme ensure that groups get handled correctly
+        $profile = $oprofile->localProfile();
+        $params['groups'] = array();
+        $params['replies'] = array();
+        if ($activity->context) {
+            foreach ($activity->context->attention as $recipient) {
+                $roprofile = Ostatus_profile::staticGet('uri', $recipient);
+                if ($roprofile) {
+                    if ($roprofile->isGroup()) {
+                        // Deliver to local recipients of this remote group.
+                        // @fixme sender verification?
+                        $params['groups'][] = $roprofile->group_id;
+                        continue;
+                    } else {
+                        // Delivery to remote users is the source service's job.
+                        continue;
+                    }
+                }
+    
+                $user = User::staticGet('uri', $recipient);
+                if ($user) {
+                    // An @-reply directed to a local user.
+                    // @fixme sender verification, spam etc?
+                    $params['replies'][] = $recipient;
+                    continue;
+                }
+    
+                // @fixme we need a uri on user_group
+                // $group = User_group::staticGet('uri', $recipient);
+                $template = common_local_url('groupbyid', array('id' => '31337'));
+                $template = preg_quote($template, '/');
+                $template = str_replace('31337', '(\d+)', $template);
+                common_log(LOG_DEBUG, $template);
+                if (preg_match("/$template/", $recipient, $matches)) {
+                    $id = $matches[1];
+                    $group = User_group::staticGet('id', $id);
+                    if ($group) {
+                        // Deliver to all members of this local group.
+                        // @fixme sender verification?
+                        if ($profile->isMember($group)) {
+                            common_log(LOG_DEBUG, "delivering to group $id $group->nickname");
+                            $params['groups'][] = $group->id;
+                        } else {
+                            common_log(LOG_DEBUG, "not delivering to group $id $group->nickname because sender $profile->nickname is not a member");
+                        }
+                        continue;
+                    } else {
+                        common_log(LOG_DEBUG, "not delivering to missing group $id");
+                    }
+                } else {
+                    common_log(LOG_DEBUG, "not delivering to groups for $recipient");
+                }
+            }
+        }
+
+        try {
+            $saved = Notice::saveNew($profile->id,
+                                     $content,
+                                     'ostatus',
+                                     $params);
+        } catch (Exception $e) {
+            common_log(LOG_ERR, "Failed saving notice entry for $sourceUri: " . $e->getMessage());
+            return;
+        }
 
-        $saved = Notice::saveNew($oprofile->localProfile()->id,
-                                 $content,
-                                 'ostatus',
-                                 $params);
+        // Record which feed this came through...
+        try {
+            Ostatus_source::saveNew($saved, $this, 'push');
+        } catch (Exception $e) {
+            common_log(LOG_ERR, "Failed saving ostatus_source entry for $saved->notice_id: " . $e->getMessage());
+        }
     }
 
     /**
@@ -522,7 +656,7 @@ class Ostatus_profile extends Memcached_DataObject
      * @return Ostatus_profile
      * @throws FeedSubException
      */
-    public static function ensureProfile($profile_uri)
+    public static function ensureProfile($profile_uri, $hints=array())
     {
         // Get the canonical feed URI and check it
         $discover = new FeedDiscovery();
@@ -545,7 +679,7 @@ class Ostatus_profile extends Memcached_DataObject
 
         if (!empty($subject)) {
             $subjObject = new ActivityObject($subject);
-            return self::ensureActivityObjectProfile($subjObject, $feeduri, $salmonuri);
+            return self::ensureActivityObjectProfile($subjObject, $feeduri, $salmonuri, $hints);
         }
 
         // Otherwise, try the feed author
@@ -554,7 +688,7 @@ class Ostatus_profile extends Memcached_DataObject
 
         if (!empty($author)) {
             $authorObject = new ActivityObject($author);
-            return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri);
+            return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri, $hints);
         }
 
         // Sheesh. Not a very nice feed! Let's try fingerpoken in the
@@ -570,7 +704,7 @@ class Ostatus_profile extends Memcached_DataObject
 
             if (!empty($actor)) {
                 $actorObject = new ActivityObject($actor);
-                return self::ensureActivityObjectProfile($actorObject, $feeduri, $salmonuri);
+                return self::ensureActivityObjectProfile($actorObject, $feeduri, $salmonuri, $hints);
 
             }
 
@@ -578,7 +712,7 @@ class Ostatus_profile extends Memcached_DataObject
 
             if (!empty($author)) {
                 $authorObject = new ActivityObject($author);
-                return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri);
+                return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri, $hints);
             }
         }
 
@@ -595,10 +729,23 @@ class Ostatus_profile extends Memcached_DataObject
      */
     protected function updateAvatar($url)
     {
+        if ($this->isGroup()) {
+            $self = $this->localGroup();
+        } else {
+            $self = $this->localProfile();
+        }
+        if (!$self) {
+            throw new ServerException(sprintf(
+                _m("Tried to update avatar for unsaved remote profile %s"),
+                $this->uri));
+        }
+
         // @fixme this should be better encapsulated
         // ripped from oauthstore.php (for old OMB client)
         $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
-        copy($url, $temp_filename);
+        if (!copy($url, $temp_filename)) {
+            throw new ServerException(sprintf(_m("Unable to fetch avatar from %s"), $url));
+        }
 
         if ($this->isGroup()) {
             $id = $this->group_id;
@@ -612,13 +759,7 @@ class Ostatus_profile extends Memcached_DataObject
                                      null,
                                      common_timestamp());
         rename($temp_filename, Avatar::path($filename));
-        if ($this->isGroup()) {
-            $group = $this->localGroup();
-            $group->setOriginal($filename);
-        } else {
-            $profile = $this->localProfile();
-            $profile->setOriginal($filename);
-        }
+        $self->setOriginal($filename);
     }
 
     protected static function getActivityObjectAvatar($object)
@@ -688,11 +829,11 @@ class Ostatus_profile extends Memcached_DataObject
         return self::ensureActivityObjectProfile($activity->actor, $feeduri, $salmonuri);
     }
 
-    public static function ensureActivityObjectProfile($object, $feeduri=null, $salmonuri=null)
+    public static function ensureActivityObjectProfile($object, $feeduri=null, $salmonuri=null, $hints=array())
     {
         $profile = self::getActivityObjectProfile($object);
         if (!$profile) {
-            $profile = self::createActivityObjectProfile($object, $feeduri, $salmonuri);
+            $profile = self::createActivityObjectProfile($object, $feeduri, $salmonuri, $hints);
         }
         return $profile;
     }
@@ -745,10 +886,22 @@ class Ostatus_profile extends Memcached_DataObject
         self::createActivityObjectProfile($actor, $feeduri, $salmonuri);
     }
 
-    protected static function createActivityObjectProfile($object, $feeduri=null, $salmonuri=null)
+    /**
+     * Create local ostatus_profile and profile/user_group entries for
+     * the provided remote user or group.
+     *
+     * @param ActivityObject $object
+     * @param string $feeduri
+     * @param string $salmonuri
+     * @param array $hints
+     *
+     * @fixme fold $feeduri/$salmonuri into $hints
+     * @return Ostatus_profile
+     */
+    protected static function createActivityObjectProfile($object, $feeduri=null, $salmonuri=null, $hints=array())
     {
         $homeuri  = $object->id;
-        $nickname = self::getActivityObjectNickname($object);
+        $nickname = self::getActivityObjectNickname($object, $hints);
         $avatar   = self::getActivityObjectAvatar($object);
 
         if (!$homeuri) {
@@ -756,6 +909,18 @@ class Ostatus_profile extends Memcached_DataObject
             throw new ServerException("No profile URI");
         }
 
+        if (empty($feeduri)) {
+            if (array_key_exists('feedurl', $hints)) {
+                $feeduri = $hints['feedurl'];
+            }
+        }
+
+        if (empty($salmonuri)) {
+            if (array_key_exists('salmon', $hints)) {
+                $salmonuri = $hints['salmon'];
+            }
+        }
+
         if (!$feeduri || !$salmonuri) {
             // Get the canonical feed URI and check it
             $discover = new FeedDiscovery();
@@ -770,54 +935,91 @@ class Ostatus_profile extends Memcached_DataObject
             }
         }
 
-        $profile = new Profile();
-        $profile->nickname   = $nickname;
-        $profile->fullname   = $object->title;
-        $profile->profileurl = $object->link;
-        $profile->created    = common_sql_now();
-
-        // @fixme bio
-        // @fixme tags/categories
-        // @fixme location?
-        // @todo tags from categories
-        // @todo lat/lon/location?
-
-        $profile_id = $profile->insert();
-
-        if (!$profile_id) {
-            throw new ServerException("Can't save local profile");
-        }
-
-        // @fixme either need to do feed discovery here
-        // or need to split out some of the feed stuff
-        // so we can leave it empty until later.
-
         $oprofile = new Ostatus_profile();
 
         $oprofile->uri        = $homeuri;
         $oprofile->feeduri    = $feeduri;
         $oprofile->salmonuri  = $salmonuri;
-        $oprofile->profile_id = $profile_id;
 
         $oprofile->created    = common_sql_now();
         $oprofile->modified   = common_sql_now();
 
+        if ($object->type == ActivityObject::PERSON) {
+            $profile = new Profile();
+            $profile->nickname   = $nickname;
+            $profile->fullname   = $object->title;
+            if (!empty($object->link)) {
+                $profile->profileurl = $object->link;
+            } else if (array_key_exists('profileurl', $hints)) {
+                $profile->profileurl = $hints['profileurl'];
+            }
+            $profile->created    = common_sql_now();
+    
+            // @fixme bio
+            // @fixme tags/categories
+            // @fixme location?
+            // @todo tags from categories
+            // @todo lat/lon/location?
+    
+            $oprofile->profile_id = $profile->insert();
+    
+            if (!$oprofile->profile_id) {
+                throw new ServerException("Can't save local profile");
+            }
+        } else {
+            $group = new User_group();
+            $group->nickname = $nickname;
+            $group->fullname = $object->title;
+            // @fixme no canonical profileurl; using homepage instead for now
+            $group->homepage = $homeuri;
+            $group->created = common_sql_now();
+
+            // @fixme homepage
+            // @fixme bio
+            // @fixme tags/categories
+            // @fixme location?
+            // @todo tags from categories
+            // @todo lat/lon/location?
+
+            $oprofile->group_id = $group->insert();
+
+            if (!$oprofile->group_id) {
+                throw new ServerException("Can't save local profile");
+            }
+        }
+
         $ok = $oprofile->insert();
 
         if ($ok) {
-            $oprofile->updateAvatar($avatar);
+            if ($avatar) {
+                $oprofile->updateAvatar($avatar);
+            }
             return $oprofile;
         } else {
             throw new ServerException("Can't save OStatus profile");
         }
     }
 
-    protected static function getActivityObjectNickname($object)
+    protected static function getActivityObjectNickname($object, $hints=array())
     {
-        // XXX: check whatever PoCo calls a nickname first
+        if (!empty($object->nickname)) {
+            return common_nicknamize($object->nickname);
+        }
+
+        // Try the definitive ID
 
         $nickname = self::nicknameFromURI($object->id);
 
+        // Try a Webfinger if one was passed (way) down
+
+        if (empty($nickname)) {
+            if (array_key_exists('webfinger', $hints)) {
+                $nickname = self::nicknameFromURI($hints['webfinger']);
+            }
+        }
+
+        // Try the name
+
         if (empty($nickname)) {
             $nickname = common_nicknamize($object->title);
         }
@@ -845,4 +1047,120 @@ class Ostatus_profile extends Memcached_DataObject
             return null;
         }
     }
+
+    public static function ensureWebfinger($addr)
+    {
+        // First, look it up
+
+        $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
+
+        if (!empty($oprofile)) {
+            return $oprofile;
+        }
+
+        // Now, try some discovery
+
+        $wf = new Webfinger();
+
+        $result = $wf->lookup($addr);
+
+        if (!$result) {
+            return null;
+        }
+
+        foreach ($result->links as $link) {
+            switch ($link['rel']) {
+            case Webfinger::PROFILEPAGE:
+                $profileUrl = $link['href'];
+                break;
+            case 'salmon':
+                $salmonEndpoint = $link['href'];
+                break;
+            case Webfinger::UPDATESFROM:
+                $feedUrl = $link['href'];
+                break;
+            default:
+                common_log(LOG_NOTICE, "Don't know what to do with rel = '{$link['rel']}'");
+                break;
+            }
+        }
+
+        $hints = array('webfinger' => $addr,
+                       'profileurl' => $profileUrl,
+                       'feedurl' => $feedUrl,
+                       'salmon' => $salmonEndpoint);
+
+        // If we got a feed URL, try that
+
+        if (isset($feedUrl)) {
+            try {
+                $oprofile = self::ensureProfile($feedUrl, $hints);
+                return $oprofile;
+            } catch (Exception $e) {
+                common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
+                // keep looking
+            }
+        }
+
+        // If we got a profile page, try that!
+
+        if (isset($profileUrl)) {
+            try {
+                $oprofile = self::ensureProfile($profileUrl, $hints);
+                return $oprofile;
+            } catch (Exception $e) {
+                common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
+                // keep looking
+            }
+        }
+
+        // XXX: try hcard
+        // XXX: try FOAF
+
+        if (isset($salmonEndpoint)) {
+
+            // An account URL, a salmon endpoint, and a dream? Not much to go
+            // on, but let's give it a try
+
+            $uri = 'acct:'.$addr;
+
+            $profile = new Profile();
+
+            $profile->nickname = self::nicknameFromUri($uri);
+            $profile->created  = common_sql_now();
+
+            if (isset($profileUrl)) {
+                $profile->profileurl = $profileUrl;
+            }
+
+            $profile_id = $profile->insert();
+
+            if (!$profile_id) {
+                common_log_db_error($profile, 'INSERT', __FILE__);
+                throw new Exception("Couldn't save profile for '$addr'");
+            }
+
+            $oprofile = new Ostatus_profile();
+
+            $oprofile->uri        = $uri;
+            $oprofile->salmonuri  = $salmonEndpoint;
+            $oprofile->profile_id = $profile_id;
+            $oprofile->created    = common_sql_now();
+
+            if (isset($feedUrl)) {
+                $profile->feeduri = $feedUrl;
+            }
+
+            $result = $oprofile->insert();
+
+            if (!$result) {
+                common_log_db_error($oprofile, 'INSERT', __FILE__);
+                throw new Exception("Couldn't save ostatus_profile for '$addr'");
+            }
+
+            return $oprofile;
+        }
+
+        return null;
+    }
 }