]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/activity.php
special case for parsing embedded activities in SHARE verb
[quix0rs-gnu-social.git] / lib / activity.php
index c3a984a7b994f289995dccf521ee0e4eb8b83fda..f5590047d46733f84278978d13cbc3e0586c0c99 100644 (file)
@@ -135,6 +135,9 @@ class Activity
         } else if ($entry->namespaceURI == Activity::RSS &&
                    $entry->localName == 'item') {
             $this->_fromRssItem($entry, $feed);
+        } else if ($entry->namespaceURI == Activity::SPEC &&
+                   $entry->localName == 'object') {
+            $this->_fromAtomEntry($entry, $feed);
         } else {
             // Low level exception. No need for i18n.
             throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
@@ -173,15 +176,25 @@ class Activity
         if ($objectEls->length > 0) {
             for ($i = 0; $i < $objectEls->length; $i++) {
                 $objectEl = $objectEls->item($i);
-                $this->objects[] = new ActivityObject($objectEl);
+                // Special case for embedded activities
+                $objectType = ActivityUtils::childContent($objectEl, self::OBJECTTYPE, self::SPEC);
+                if (!empty($objectType) && $objectType == ActivityObject::ACTIVITY) {
+                    $this->objects[] = new Activity($objectEl);
+                } else {
+                    $this->objects[] = new ActivityObject($objectEl);
+                }
             }
         } else {
+            // XXX: really?
             $this->objects[] = new ActivityObject($entry);
         }
 
         $actorEl = $this->_child($entry, self::ACTOR);
 
         if (!empty($actorEl)) {
+            // Standalone <activity:actor> elements are a holdover from older
+            // versions of ActivityStreams. Newer feeds should have this data
+            // integrated straight into <atom:author>.
 
             $this->actor = new ActivityObject($actorEl);
 
@@ -196,18 +209,24 @@ class Activity
                     $this->actor->id = $authorObj->id;
                 }
             }
+        } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
+
+            // An <atom:author> in the entry overrides any author info on
+            // the surrounding feed.
+            $this->actor = new ActivityObject($authorEl);
+
         } else if (!empty($feed) &&
                    $subjectEl = $this->_child($feed, self::SUBJECT)) {
 
+            // Feed subject is used for things like groups.
+            // Should actually possibly not be interpreted as an actor...?
             $this->actor = new ActivityObject($subjectEl);
 
-        } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
-
-            $this->actor = new ActivityObject($authorEl);
-
         } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
                                                               self::ATOM)) {
 
+            // If there's no <atom:author> on the entry, it's safe to assume
+            // the containing feed's authorship info applies.
             $this->actor = new ActivityObject($authorEl);
         }
 
@@ -322,15 +341,178 @@ class Activity
      *
      * @return DOMElement Atom entry
      */
+
     function toAtomEntry()
     {
         return null;
     }
 
+    /**
+     * Returns an array based on this activity suitable
+     * for encoding as a JSON object
+     *
+     * @return array $activity
+     */
+
+    function asArray()
+    {
+        $activity = array();
+
+        // actor
+        $activity['actor'] = $this->actor->asArray();
+
+        // body
+        $activity['body'] = $this->content;
+
+        // generator <-- We could use this when we know a notice is created
+        //               locally. Or if we know the upstream Generator.
+
+        // icon <-- I've decided to use the posting user's stream avatar here
+        //          for now (also included in the avatarLinks extension)
+
+
+        // object
+        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
+            $activity['object'] = $this->objects[0]->asArray();
+
+            // Context stuff. For now I'm just sticking most of it
+            // in a property called "context"
+
+            if (!empty($this->context)) {
+
+                if (!empty($this->context->location)) {
+                    $loc = $this->context->location;
+
+                    // GeoJSON
+
+                    $activity['geopoint'] = array(
+                        'type'        => 'Point',
+                        'coordinates' => array($loc->lat, $loc->lon)
+                    );
+
+                }
+
+                $activity['to']      = $this->context->getToArray();
+                $activity['context'] = $this->context->asArray();
+            }
+
+            // Instead of adding enclosures as an extension to JSON
+            // Activities, it seems like we should be using the
+            // attachedObjects property of ActivityObject
+
+            $attachedObjects = array();
+
+            // XXX: OK, this is kinda cheating. We should probably figure out
+            // what kind of objects these are based on mime-type and then
+            // create specific object types. Right now this rely on
+            // duck-typing.  Also, we should include an embed code for
+            // video attachments.
+
+            foreach ($this->enclosures as $enclosure) {
+
+                if (is_string($enclosure)) {
+
+                    $attachedObjects[]['id']  = $enclosure;
+
+                } else {
+
+                    $attachedObjects[]['id']  = $enclosure->url;
+
+                    $mediaLink = new ActivityStreamsMediaLink(
+                        $enclosure->url,
+                        null,
+                        null,
+                        $enclosure->mimetype
+                        // XXX: Add 'size' as an extension to MediaLink?
+                    );
+
+                    $attachedObjects[]['mediaLink'] = $mediaLink->asArray(); // extension
+
+                    if ($enclosure->title) {
+                        $attachedObjects[]['displayName'] = $enclosure->title;
+                    }
+               }
+            }
+
+            if (!empty($attachedObjects)) {
+                $activity['object']['attachedObjects'] = $attachedObjects;
+            }
+
+        } else {
+            $activity['object'] = array();
+            foreach($this->objects as $object) {
+                $oa = $object->asArray();
+                if ($object instanceof Activity) {
+                    // throw in a type
+                    // XXX: hackety-hack
+                    $oa['objectType'] = 'activity';
+                }
+                $activity['object'][] = $oa;
+            }
+        }
+
+        $activity['postedTime'] = self::iso8601Date($this->time); // Change to exactly be RFC3339?
+
+        // provider
+        $provider = array(
+            'objectType' => 'service',
+            'displayName' => common_config('site', 'name'),
+            'url' => common_root_url()
+        );
+
+        $activity['provider'] = $provider;
+
+        // target
+        if (!empty($this->target)) {
+            $activity['target'] = $this->target->asArray();
+        }
+
+        // title
+        $activity['title'] = $this->title;
+
+        // updatedTime <-- Should we use this to indicate the time we received
+        //                 a remote notice? Probably not.
+
+        // verb
+        //
+        // We can probably use the whole schema URL here but probably the
+        // relative simple name is easier to parse
+        $activity['verb'] = substr($this->verb, strrpos($this->verb, '/') + 1);
+
+        /* Purely extensions hereafter */
+
+        $tags = array();
+
+        // Use an Activity Object for term? Which object? Note?
+        foreach ($this->categories as $cat) {
+            $tags[] = $cat->term;
+        }
+
+        $activity['tags'] = $tags;
+
+        // XXX: a bit of a hack... Since JSON isn't namespaced we probably
+        // shouldn't be using 'statusnet:notice_info', but this will work
+        // for the moment.
+
+        foreach ($this->extra as $e) {
+            list($objectName, $props, $txt) = $e;
+            if (!empty($objectName)) {
+                $activity[$objectName] = $props;
+            }
+        }
+
+        return array_filter($activity);
+    }
+
     function asString($namespace=false, $author=true, $source=false)
     {
         $xs = new XMLStringer(true);
+        $this->outputTo($xs, $namespace, $author, $source);
+        return $xs->getString();
+    }
 
+    function outputTo($xs, $namespace=false, $author=true, $source=false, $tag='entry')
+    {
         if ($namespace) {
             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
                            'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
@@ -344,48 +526,27 @@ class Activity
             $attrs = array();
         }
 
-        $xs->elementStart('entry', $attrs);
-
-        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
-
-            $obj = $this->objects[0];
+        $xs->elementStart($tag, $attrs);
 
-            $xs->element('id', null, $obj->id);
-            $xs->element('activity:object-type', null, $obj->type);
-            
-            if (!empty($obj->title)) {
-                $xs->element('title', null, $obj->title);
-            } else {
-                // XXX need a better default title
-                $xs->element('title', null, _('Post'));
-            }
+        if ($tag != 'entry') {
+            $xs->element('activity:object-type', null, ActivityObject::ACTIVITY);
+        }
 
-            if (!empty($obj->content)) {
-                $xs->element('content', array('type' => 'html'), $obj->content);
-            }
-            
-            if (!empty($obj->summary)) {
-                $xs->element('summary', null, $obj->summary);
-            }
-            
-            if (!empty($obj->link)) {
-                $xs->element('link', array('rel' => 'alternate',
-                                           'type' => 'text/html'),
-                             $obj->link);
-            }
+        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1 && $tag == 'entry') {
 
-            // XXX: some object types might have other values here.
+            $obj = $this->objects[0];
+                       $obj->outputTo($xs, null);
 
         } else {
             $xs->element('id', null, $this->id);
             $xs->element('title', null, $this->title);
 
             $xs->element('content', array('type' => 'html'), $this->content);
-            
+
             if (!empty($this->summary)) {
                 $xs->element('summary', null, $this->summary);
             }
-            
+
             if (!empty($this->link)) {
                 $xs->element('link', array('rel' => 'alternate',
                                            'type' => 'text/html'),
@@ -397,23 +558,33 @@ class Activity
         $xs->element('activity:verb', null, $this->verb);
 
         $published = self::iso8601Date($this->time);
-            
+
         $xs->element('published', null, $published);
         $xs->element('updated', null, $published);
-            
+
         if ($author) {
-            $xs->elementStart('author');
-            $xs->element('uri', array(), $this->actor->id);
-            if ($this->actor->title) {
-                $xs->element('name', array(), $this->actor->title);
-            }
-            $xs->elementEnd('author');
-            $xs->raw($this->actor->asString('activity:actor'));
+            $this->actor->outputTo($xs, 'author');
+
+            // XXX: Remove <activity:actor> ASAP! Author information
+            // has been moved to the author element in the Activity
+            // Streams spec. We're outputting actor only for backward
+            // compatibility with clients that can only parse
+            // activities based on older versions of the spec.
+
+            $depMsg = 'Deprecation warning: activity:actor is present '
+                . 'only for backward compatibility. It will be '
+                . 'removed in the next version of StatusNet.';
+            $xs->comment($depMsg);
+            $this->actor->outputTo($xs, 'activity:actor');
         }
 
-        if ($this->verb != ActivityVerb::POST || count($this->objects) != 1) {
+        if ($this->verb != ActivityVerb::POST || count($this->objects) != 1 || $tag != 'entry') {
             foreach($this->objects as $object) {
-                $xs->raw($object->asString());
+                if ($object instanceof Activity) {
+                    $object->outputTo($xs, false, true, true, 'activity:object');
+                } else {
+                    $object->outputTo($xs, 'activity:object');
+                }
             }
         }
 
@@ -467,15 +638,15 @@ class Activity
         }
 
         if ($this->target) {
-            $xs->raw($this->target->asString('activity:target'));
+            $this->target->outputTo($xs, 'activity:target');
         }
 
         foreach ($this->categories as $cat) {
-            $xs->raw($cat->asString());
+            $cat->outputTo($xs);
         }
 
         // can be either URLs or enclosure objects
-        
+
         foreach ($this->enclosures as $enclosure) {
             if (is_string($enclosure)) {
                 $xs->element('link', array('rel' => 'enclosure',
@@ -496,7 +667,7 @@ class Activity
 
         if ($source && !empty($this->source)) {
             $xs->elementStart('source');
-           
+
             $xs->element('id', null, $this->source->id);
             $xs->element('title', null, $this->source->title);
 
@@ -505,7 +676,7 @@ class Activity
                                            'type' => 'text/html',
                                            'href' => $this->source->links['alternate']));
             }
-           
+
             if (array_key_exists('self', $this->source->links)) {
                 $xs->element('link', array('rel' => 'self',
                                            'type' => 'application/atom+xml',
@@ -524,7 +695,7 @@ class Activity
             if (!empty($this->source->updated)) {
                 $xs->element('updated', null, $this->source->updated);
             }
-           
+
             $xs->elementEnd('source');
         }
 
@@ -541,17 +712,15 @@ class Activity
         }
 
         // For throwing in extra elements; used for statusnet:notice_info
-       
+
         foreach ($this->extra as $el) {
             list($tag, $attrs, $content) = $el;
             $xs->element($tag, $attrs, $content);
         }
 
-        $xs->elementEnd('entry');
+        $xs->elementEnd($tag);
 
-        $str = $xs->getString();
-       
-        return $str;
+        return;
     }
 
     private function _child($element, $tag, $namespace=self::SPEC)
@@ -559,11 +728,18 @@ class Activity
         return ActivityUtils::child($element, $tag, $namespace);
     }
 
+    /**
+     * For consistency, we'll always output UTC rather than local time.
+     * Note that clients *should* accept any timezone we give them as long
+     * as it's properly formatted.
+     *
+     * @param int $tm Unix timestamp
+     * @return string
+     */
     static function iso8601Date($tm)
     {
         $dateStr = date('d F Y H:i:s', $tm);
         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
-        $d->setTimezone(new DateTimeZone(common_timezone()));
         return $d->format('c');
     }
 }