]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/activity.php
Add image to JSON ActivityObject and title + links to the JSON document
[quix0rs-gnu-social.git] / lib / activity.php
index d3eeadcee9eb106d095e7e901f892e58a476a338..e6fefca28f9a9523a9dfeb037d7e2117674ca899 100644 (file)
@@ -182,6 +182,9 @@ class Activity
         $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 +199,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,23 +331,74 @@ class Activity
      *
      * @return DOMElement Atom entry
      */
+
     function toAtomEntry()
     {
         return null;
     }
 
-    function asString($namespace=false, $author=true)
+    /**
+     * Returns an array based on this activity suitable
+     * for encoding as a JSON object
+     *
+     * @return array $activity
+     */
+
+    function asArray()
     {
-        $c = Cache::instance();
+        $activity = array();
+
+        // actor
+        $activity['actor'] = $this->actor->asArray();
 
-        $str = $c->get(Cache::codeKey('activity:as-string:'.$this->id));
+        // body
+        $activity['body'] = $this->content;
 
-        if (!empty($str)) {
-            return $str;
+        // generator <--- might be useful; might be too much junk
+
+        // icon <-- should we use this?
+
+        // object
+        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
+            $activity['object'] = $this->objects[0]->asArray();
+        } else {
+            $activity['object'] = array();
+            foreach($this->objects as $object) {
+                $activity['object'][] = $object->asArray();
+            }
         }
 
+        $activity['postedTime'] = self::iso8601Date($this->time); // Change to exactly be RFC3339?
+
+        // provider <--- again not sure we should use this
+
+        // target
+        if (!empty($this->target)) {
+            $activity['target'] = $this->target->asArray();
+        }
+
+        // title
+        $activity['title'] = $this->title;
+
+        // updatedTime <-- should we use? spec says activity MAY have this
+
+        // verb
+        $activity['verb'] = $this->verb;
+
+        // TODO: extensions (ActivityContext, OStatus stuff, etc.)
+
+        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)
+    {
         if ($namespace) {
             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
                            'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
@@ -357,43 +417,18 @@ class Activity
         if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
 
             $obj = $this->objects[0];
-
-            $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 (!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);
-            }
-
-            // XXX: some object types might have other values here.
+                       $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'),
@@ -405,23 +440,29 @@ 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) {
             foreach($this->objects as $object) {
-                $xs->raw($object->asString());
+                $object->outputTo($xs, 'activity:object');
             }
         }
 
@@ -475,15 +516,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',
@@ -502,9 +543,9 @@ class Activity
 
         // Info on the source feed
 
-        if (!empty($this->source)) {
+        if ($source && !empty($this->source)) {
             $xs->elementStart('source');
-           
+
             $xs->element('id', null, $this->source->id);
             $xs->element('title', null, $this->source->title);
 
@@ -513,7 +554,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',
@@ -532,7 +573,7 @@ class Activity
             if (!empty($this->source->updated)) {
                 $xs->element('updated', null, $this->source->updated);
             }
-           
+
             $xs->elementEnd('source');
         }
 
@@ -549,7 +590,7 @@ 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);
@@ -557,11 +598,7 @@ class Activity
 
         $xs->elementEnd('entry');
 
-        $str = $xs->getString();
-       
-        $c->set(Cache::codeKey('activity:as-string:'.$this->id), $str);
-       
-        return $str;
+        return;
     }
 
     private function _child($element, $tag, $namespace=self::SPEC)