]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OStatus/classes/Ostatus_profile.php
wiring in magicsig
[quix0rs-gnu-social.git] / plugins / OStatus / classes / Ostatus_profile.php
index 319b76a661c5802b09d3c0c91d7d5894912abee5..0e12f8fc6e14005b50648b22311c832f320e91f6 100644 (file)
@@ -56,7 +56,7 @@ class Ostatus_profile extends Memcached_DataObject
         return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
                      'profile_id' => DB_DATAOBJECT_INT,
                      'group_id' => DB_DATAOBJECT_INT,
-                     'feeduri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
+                     'feeduri' => DB_DATAOBJECT_STR,
                      'salmonuri' =>  DB_DATAOBJECT_STR,
                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
                      'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
@@ -71,7 +71,7 @@ class Ostatus_profile extends Memcached_DataObject
                      new ColumnDef('group_id', 'integer',
                                    null, true, 'UNI'),
                      new ColumnDef('feeduri', 'varchar',
-                                   255, false, 'UNI'),
+                                   255, true, 'UNI'),
                      new ColumnDef('salmonuri', 'text',
                                    null, true),
                      new ColumnDef('created', 'datetime',
@@ -149,7 +149,6 @@ class Ostatus_profile extends Memcached_DataObject
     function asActivityNoun($element)
     {
         $xs = new XMLStringer(true);
-
         $avatarHref = Avatar::defaultImage(AVATAR_PROFILE_SIZE);
         $avatarType = 'image/png';
         if ($this->isGroup()) {
@@ -173,8 +172,8 @@ class Ostatus_profile extends Memcached_DataObject
             $self = $this->localProfile();
             $avatar = $self->getAvatar(AVATAR_PROFILE_SIZE);
             if ($avatar) {
-                $avatarHref = $avatar->
-                $avatarType = $avatar->mediatype;
+                  $avatarHref = $avatar->url;
+                  $avatarType = $avatar->mediatype;
             }
         }
         $xs->elementStart('activity:' . $element);
@@ -272,7 +271,7 @@ class Ostatus_profile extends Memcached_DataObject
      * @return bool true on success, false on failure
      * @throws ServerException if feed state is not valid
      */
-    public function subscribe($mode='subscribe')
+    public function subscribe()
     {
         $feedsub = FeedSub::ensureFeed($this->feeduri);
         if ($feedsub->sub_state == 'active' || $feedsub->sub_state == 'subscribe') {
@@ -306,25 +305,39 @@ class Ostatus_profile extends Memcached_DataObject
      * Send an Activity Streams notification to the remote Salmon endpoint,
      * if so configured.
      *
-     * @param Profile $actor
-     * @param $verb eg Activity::SUBSCRIBE or Activity::JOIN
-     * @param $object object of the action; if null, the remote entity itself is assumed
+     * @param Profile $actor  Actor who did the activity
+     * @param string  $verb   Activity::SUBSCRIBE or Activity::JOIN
+     * @param Object  $object object of the action; must define asActivityNoun($tag)
      */
-    public function notify(Profile $actor, $verb, $object=null)
+    public function notify($actor, $verb, $object=null)
     {
+        if (!($actor instanceof Profile)) {
+            $type = gettype($actor);
+            if ($type == 'object') {
+                $type = get_class($actor);
+            }
+            throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
+        }
         if ($object == null) {
             $object = $this;
         }
         if ($this->salmonuri) {
-            $text = 'update'; // @fixme
-            $id = 'tag:' . common_config('site', 'server') .
-                ':' . $verb .
-                ':' . $actor->id .
-                ':' . time(); // @fixme
 
-            //$entry = new Atom10Entry();
+            $text = 'update';
+            $id = TagURI::mint('%s:%s:%s',
+                               $verb,
+                               $actor->getURI(),
+                               common_date_iso8601(time()));
+
+            // @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');
+
             $entry = new XMLStringer();
-            $entry->elementStart('entry');
+            $entry->elementStart('entry', $attributes);
             $entry->element('id', null, $id);
             $entry->element('title', null, $text);
             $entry->element('summary', null, $text);
@@ -336,15 +349,26 @@ class Ostatus_profile extends Memcached_DataObject
             $entry->raw($object->asActivityNoun('object'));
             $entry->elementEnd('entry');
 
-            $feed = $this->atomFeed($actor);
-            $feed->addEntry($entry);
+            $xml = $entry->getString();
+            common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
 
-            $xml = $feed->getString();
-            common_log(LOG_INFO, "Posting to Salmon endpoint $salmon: $xml");
+            $salmon = new Salmon(); // ?
+            $salmon->post($this->salmonuri, $xml);
+        }
+    }
+
+    public function notifyActivity($activity)
+    {
+        if ($this->salmonuri) {
+
+            $xml = $activity->asString(true);
 
             $salmon = new Salmon(); // ?
+
             $salmon->post($this->salmonuri, $xml);
         }
+
+        return;
     }
 
     function getBestName()
@@ -448,28 +472,33 @@ class Ostatus_profile extends Memcached_DataObject
             $oprofile = $this;
         }
 
-        if ($activity->object->link) {
-            $sourceUri = $activity->object->link;
-        } else if (preg_match('!^https?://!', $activity->object->id)) {
-            $sourceUri = $activity->object->id;
-        } else {
-            common_log(LOG_INFO, "OStatus: ignoring post with no source link: id $activity->object->id");
-            return;
-        }
+        $sourceUri = $activity->object->id;
 
         $dupe = Notice::staticGet('uri', $sourceUri);
+
         if ($dupe) {
-            common_log(LOG_INFO, "OStatus: ignoring duplicate post: $noticeLink");
+            common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
             return;
         }
 
+        $sourceUrl = null;
+
+        if ($activity->object->link) {
+            $sourceUrl = $activity->object->link;
+        } else if (preg_match('!^https?://!', $activity->object->id)) {
+            $sourceUrl = $activity->object->id;
+        }
+
         // @fixme sanitize and save HTML content if available
+
         $content = $activity->object->title;
 
         $params = array('is_local' => Notice::REMOTE_OMB,
+                        'url' => $sourceUrl,
                         'uri' => $sourceUri);
 
-        $location = $this->getEntryLocation($activity->entry);
+        $location = $activity->context->location;
+
         if ($location) {
             $params['lat'] = $location->lat;
             $params['lon'] = $location->lon;
@@ -479,13 +508,15 @@ class Ostatus_profile extends Memcached_DataObject
             }
         }
 
-        // @fixme save detailed ostatus source info
         // @fixme ensure that groups get handled correctly
 
         $saved = Notice::saveNew($oprofile->localProfile()->id,
                                  $content,
                                  'ostatus',
                                  $params);
+
+        // Record which feed this came through...
+        Ostatus_source::saveNew($saved, $this, 'push');
     }
 
     /**
@@ -493,13 +524,13 @@ 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();
         $feeduri = $discover->discoverFromURL($profile_uri);
 
-        $feedsub = FeedSub::ensureFeed($feeduri, $discover->feed);
+        //$feedsub = FeedSub::ensureFeed($feeduri, $discover->feed);
         $huburi = $discover->getAtomLink('hub');
         $salmonuri = $discover->getAtomLink('salmon');
 
@@ -508,18 +539,58 @@ class Ostatus_profile extends Memcached_DataObject
             throw new FeedSubNoHubException();
         }
 
-        // Ok this is going to be a terrible hack!
-        // Won't be suitable for groups, empty feeds, or getting
-        // info that's only available on the profile page.
+        // Try to get a profile from the feed activity:subject
+
+        $feedEl = $discover->feed->documentElement;
+
+        $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC);
+
+        if (!empty($subject)) {
+            $subjObject = new ActivityObject($subject);
+            return self::ensureActivityObjectProfile($subjObject, $feeduri, $salmonuri, $hints);
+        }
+
+        // Otherwise, try the feed author
+
+        $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM);
+
+        if (!empty($author)) {
+            $authorObject = new ActivityObject($author);
+            return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri, $hints);
+        }
+
+        // Sheesh. Not a very nice feed! Let's try fingerpoken in the
+        // entries.
+
         $entries = $discover->feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
-        if (!$entries || $entries->length == 0) {
-            throw new FeedSubException('empty feed');
+
+        if (!empty($entries) && $entries->length > 0) {
+
+            $entry = $entries->item(0);
+
+            $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC);
+
+            if (!empty($actor)) {
+                $actorObject = new ActivityObject($actor);
+                return self::ensureActivityObjectProfile($actorObject, $feeduri, $salmonuri, $hints);
+
+            }
+
+            $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM);
+
+            if (!empty($author)) {
+                $authorObject = new ActivityObject($author);
+                return self::ensureActivityObjectProfile($authorObject, $feeduri, $salmonuri, $hints);
+            }
         }
-        $first = new Activity($entries->item(0), $discover->feed);
-        return self::ensureActorProfile($first, $feeduri, $salmonuri);
+
+        // XXX: make some educated guesses here
+
+        throw new FeedSubException("Can't find enough profile information to make a feed.");
     }
 
     /**
+     *
      * Download and update given avatar image
      * @param string $url
      * @throws Exception in various failure cases
@@ -531,9 +602,14 @@ class Ostatus_profile extends Memcached_DataObject
         $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
         copy($url, $temp_filename);
 
+        if ($this->isGroup()) {
+            $id = $this->group_id;
+        } else {
+            $id = $this->profile_id;
+        }
         // @fixme should we be using different ids?
-        $imagefile = new ImageFile($this->id, $temp_filename);
-        $filename = Avatar::filename($this->id,
+        $imagefile = new ImageFile($id, $temp_filename);
+        $filename = Avatar::filename($id,
                                      image_type_to_extension($imagefile->type),
                                      null,
                                      common_timestamp());
@@ -547,6 +623,12 @@ class Ostatus_profile extends Memcached_DataObject
         }
     }
 
+    protected static function getActivityObjectAvatar($object)
+    {
+        // XXX: go poke around in the feed
+        return $object->avatar;
+    }
+
     /**
      * Get an appropriate avatar image source URL, if available.
      *
@@ -554,6 +636,7 @@ class Ostatus_profile extends Memcached_DataObject
      * @param DOMElement $feed
      * @return string
      */
+
     protected static function getAvatar($actor, $feed)
     {
         $url = '';
@@ -601,11 +684,17 @@ class Ostatus_profile extends Memcached_DataObject
      * @param string $salmonuri if we already know the salmon return channel URI
      * @return Ostatus_profile
      */
+
     public static function ensureActorProfile($activity, $feeduri=null, $salmonuri=null)
     {
-        $profile = self::getActorProfile($activity);
+        return self::ensureActivityObjectProfile($activity->actor, $feeduri, $salmonuri);
+    }
+
+    public static function ensureActivityObjectProfile($object, $feeduri=null, $salmonuri=null, $hints=array())
+    {
+        $profile = self::getActivityObjectProfile($object);
         if (!$profile) {
-            $profile = self::createActorProfile($activity, $feeduri, $salmonuri);
+            $profile = self::createActivityObjectProfile($object, $feeduri, $salmonuri, $hints);
         }
         return $profile;
     }
@@ -616,8 +705,18 @@ class Ostatus_profile extends Memcached_DataObject
      */
     protected static function getActorProfile($activity)
     {
-        $homeuri = self::getActorProfileURI($activity);
-        return self::staticGet('uri', $homeuri);
+        return self::getActivityObjectProfile($activity->actor);
+    }
+
+    protected static function getActivityObjectProfile($object)
+    {
+        $uri = self::getActivityObjectProfileURI($object);
+        return Ostatus_profile::staticGet('uri', $uri);
+    }
+
+    protected static function getActorProfileURI($activity)
+    {
+        return self::getActivityObjectProfileURI($activity->actor);
     }
 
     /**
@@ -625,15 +724,14 @@ class Ostatus_profile extends Memcached_DataObject
      * @return string
      * @throws ServerException
      */
-    protected static function getActorProfileURI($activity)
+    protected static function getActivityObjectProfileURI($object)
     {
         $opts = array('allowed_schemes' => array('http', 'https'));
-        $actor = $activity->actor;
-        if ($actor->id && Validate::uri($actor->id, $opts)) {
-            return $actor->id;
+        if ($object->id && Validate::uri($object->id, $opts)) {
+            return $object->id;
         }
-        if ($actor->link && Validate::uri($actor->link, $opts)) {
-            return $actor->link;
+        if ($object->link && Validate::uri($object->link, $opts)) {
+            return $object->link;
         }
         throw new ServerException("No author ID URI found");
     }
@@ -641,52 +739,89 @@ class Ostatus_profile extends Memcached_DataObject
     /**
      * @fixme validate stuff somewhere
      */
+
     protected static function createActorProfile($activity, $feeduri=null, $salmonuri=null)
     {
         $actor = $activity->actor;
-        $homeuri = self::getActorProfileURI($activity);
-        $nickname = self::getAuthorNick($activity);
-        $avatar = self::getAvatar($actor, $feed);
+
+        self::createActivityObjectProfile($actor, $feeduri, $salmonuri);
+    }
+
+    protected static function createActivityObjectProfile($object, $feeduri=null, $salmonuri=null, $hints=array())
+    {
+        $homeuri  = $object->id;
+        $nickname = self::getActivityObjectNickname($object, $hints);
+        $avatar   = self::getActivityObjectAvatar($object);
 
         if (!$homeuri) {
             common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
             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();
+            $feeduri = $discover->discoverFromURL($homeuri);
+
+            $huburi = $discover->getAtomLink('hub');
+            $salmonuri = $discover->getAtomLink('salmon');
+
+            if (!$huburi) {
+                // We can only deal with folks with a PuSH hub
+                throw new FeedSubNoHubException();
+            }
+        }
+
         $profile = new Profile();
         $profile->nickname   = $nickname;
-        $profile->fullname   = $actor->displayName;
-        $profile->homepage   = $actor->link; // @fixme
-        $profile->profileurl = $homeuri;
+        $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?
 
-        $ok = $profile->insert();
-        if (!$ok) {
+        $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;
-        if ($feeduri) {
-            // If we don't have these, we can look them up later.
-            $oprofile->feeduri = $feeduri;
-            if ($salmonuri) {
-                $oprofile->salmonuri = $salmonuri;
-            }
-        }
-        $oprofile->profile_id = $profile->id;
 
-        $oprofile->created = common_sql_now();
-        $oprofile->modified = common_sql_now();
+        $oprofile->uri        = $homeuri;
+        $oprofile->feeduri    = $feeduri;
+        $oprofile->salmonuri  = $salmonuri;
+        $oprofile->profile_id = $profile_id;
+
+        $oprofile->created    = common_sql_now();
+        $oprofile->modified   = common_sql_now();
 
         $ok = $oprofile->insert();
+
         if ($ok) {
             $oprofile->updateAvatar($avatar);
             return $oprofile;
@@ -695,24 +830,167 @@ class Ostatus_profile extends Memcached_DataObject
         }
     }
 
-    /**
-     * @fixme move this into Activity?
-     * @param Activity $activity
-     * @return string
-     */
-    protected static function getAuthorNick($activity)
-    {
-        // @fixme not technically part of the actor?
-        foreach (array($activity->entry, $activity->feed) as $source) {
-            $author = ActivityUtils::child($source, 'author', Activity::ATOM);
-            if ($author) {
-                $name = ActivityUtils::child($author, 'name', Activity::ATOM);
-                if ($name) {
-                    return trim($name->textContent);
-                }
+    protected static function getActivityObjectNickname($object, $hints=array())
+    {
+        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']);
             }
         }
-        return false;
+
+        // Try the name
+
+        if (empty($nickname)) {
+            $nickname = common_nicknamize($object->title);
+        }
+
+        return $nickname;
+    }
+
+    protected static function nicknameFromURI($uri)
+    {
+        preg_match('/(\w+):/', $uri, $matches);
+
+        $protocol = $matches[1];
+
+        switch ($protocol) {
+        case 'acct':
+        case 'mailto':
+            if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
+                return common_canonical_nickname($matches[1]);
+            }
+            return null;
+        case 'http':
+            return common_url_to_nickname($uri);
+            break;
+        default:
+            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;
+    }
 }