]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/activity.php
Improved type-hint for following methods:
[quix0rs-gnu-social.git] / lib / activity.php
index e6fefca28f9a9523a9dfeb037d7e2117674ca899..6fd04c4db1709e16862475de53ad6da4c463b090 100644 (file)
@@ -100,12 +100,13 @@ class Activity
     public $title;   // title of the activity
     public $categories = array(); // list of AtomCategory objects
     public $enclosures = array(); // list of enclosure URL references
+    public $attachments = array(); // list of attachments
 
     public $extra = array(); // extra elements as array(tag, attrs, content)
     public $source;  // ActivitySource object representing 'home feed'
     public $selfLink; // <link rel='self' type='application/atom+xml'>
     public $editLink; // <link rel='edit' type='application/atom+xml'>
-
+    public $generator; // ActivityObject representing the generating application
     /**
      * Turns a regular old Atom <entry> into a magical activity
      *
@@ -135,6 +136,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}");
@@ -168,14 +172,22 @@ class Activity
             // XXX: do other implied stuff here
         }
 
-        $objectEls = $entry->getElementsByTagNameNS(self::SPEC, self::OBJECT);
+        // get immediate object children
+
+        $objectEls = ActivityUtils::children($entry, self::OBJECT, self::SPEC);
 
-        if ($objectEls->length > 0) {
-            for ($i = 0; $i < $objectEls->length; $i++) {
-                $objectEl = $objectEls->item($i);
-                $this->objects[] = new ActivityObject($objectEl);
+        if (count($objectEls) > 0) {
+            foreach ($objectEls as $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);
         }
 
@@ -232,6 +244,9 @@ class Activity
 
         if (!empty($targetEl)) {
             $this->target = new ActivityObject($targetEl);
+        } elseif (ActivityUtils::compareTypes($this->verb, array(ActivityVerb::FAVORITE))) {
+            // StatusNet didn't send a 'target' for their Favorite atom entries
+            $this->target = clone($this->objects[0]);
         }
 
         $this->summary = ActivityUtils::childContent($entry, 'summary');
@@ -351,26 +366,109 @@ class Activity
         // actor
         $activity['actor'] = $this->actor->asArray();
 
-        // body
-        $activity['body'] = $this->content;
+        // content
+        $activity['content'] = $this->content;
 
-        // generator <--- might be useful; might be too much junk
+        // generator
 
-        // icon <-- should we use this?
+        if (!empty($this->generator)) {
+            $activity['generator'] = $this->generator->asArray();
+        }
+
+        // icon <-- possibly a mini object representing verb?
+
+        // id
+        $activity['id'] = $this->id;
 
         // object
-        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
-            $activity['object'] = $this->objects[0]->asArray();
+
+        if (count($this->objects) == 0) {
+            common_log(LOG_ERR, "Can't save " . $this->id);
         } else {
-            $activity['object'] = array();
-            foreach($this->objects as $object) {
-                $activity['object'][] = $object->asArray();
+            if (count($this->objects) > 1) {
+                common_log(LOG_WARNING, "Ignoring " . (count($this->objects) - 1) . " extra objects in JSON output for activity " . $this->id);
+            }
+            $object = $this->objects[0];
+
+            if ($object instanceof Activity) {
+                // Sharing a post activity is more like sharing the original object
+                if (ActivityVerb::canonical($this->verb) == ActivityVerb::canonical(ActivityVerb::SHARE) &&
+                    ActivityVerb::canonical($object->verb) == ActivityVerb::canonical(ActivityVerb::POST)) {
+                    // XXX: Here's one for the obfuscation record books
+                    $object = $object->objects[0];
+                }
+            }
+
+            $activity['object'] = $object->asArray();
+
+            if ($object instanceof Activity) {
+                $activity['object']['objectType'] = 'activity';
+            }
+
+            foreach ($this->attachments as $attachment) {
+                if (empty($activity['object']['attachments'])) {
+                    $activity['object']['attachments'] = array();
+                }
+                $activity['object']['attachments'][] = $attachment->asArray();
             }
         }
+        
+        // Context stuff.
 
-        $activity['postedTime'] = self::iso8601Date($this->time); // Change to exactly be RFC3339?
+        if (!empty($this->context)) {
+
+            if (!empty($this->context->location)) {
+                $loc = $this->context->location;
+
+                $activity['location'] = array(
+                    'objectType' => 'place',
+                    'position' => sprintf("%+02.5F%+03.5F/", $loc->lat, $loc->lon),
+                    'lat' => $loc->lat,
+                    'lon' => $loc->lon
+                );
+
+                $name = $loc->getName();
+
+                if ($name) {
+                    $activity['location']['displayName'] = $name;
+                }
+                    
+                $url = $loc->getURL();
+
+                if ($url) {
+                    $activity['location']['url'] = $url;
+                }
+            }
+
+            $activity['to']      = $this->context->getToArray();
 
-        // provider <--- again not sure we should use this
+            $ctxarr = $this->context->asArray();
+
+            if (array_key_exists('inReplyTo', $ctxarr)) {
+                $activity['object']['inReplyTo'] = $ctxarr['inReplyTo'];
+                unset($ctxarr['inReplyTo']);
+            }
+
+            if (!array_key_exists('status_net', $activity)) {
+                $activity['status_net'] = array();
+            }
+
+            foreach ($ctxarr as $key => $value) {
+                $activity['status_net'][$key] = $value;
+            }
+        }
+
+        // published
+        $activity['published'] = self::iso8601Date($this->time);
+
+        // provider
+        $provider = array(
+            'objectType' => 'service',
+            'displayName' => common_config('site', 'name'),
+            'url' => common_root_url()
+        );
+
+        $activity['provider'] = $provider;
 
         // target
         if (!empty($this->target)) {
@@ -380,12 +478,52 @@ class Activity
         // title
         $activity['title'] = $this->title;
 
-        // updatedTime <-- should we use? spec says activity MAY have this
+        // updated <-- Optional. Should we use this to indicate the time we r
+        //             eceived a remote notice? Probably not.
 
         // verb
-        $activity['verb'] = $this->verb;
 
-        // TODO: extensions (ActivityContext, OStatus stuff, etc.)
+        $activity['verb'] = ActivityVerb::canonical($this->verb);
+
+        // url
+        if ($this->link) {
+            $activity['url'] = $this->link;
+        }
+
+        /* Purely extensions hereafter */
+
+        if ($activity['verb'] == 'post') {
+            $tags = array();
+            foreach ($this->categories as $cat) {
+                if (mb_strlen($cat->term) > 0) {
+                    // Couldn't figure out which object type to use, so...
+                    $tags[] = array('objectType' => 'http://activityschema.org/object/hashtag',
+                                    'displayName' => $cat->term);
+                }
+            }
+            if (count($tags) > 0) {
+                $activity['object']['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)) {
+                $parts = explode(":", $objectName);
+                if (count($parts) == 2 && $parts[0] == "statusnet") {
+                    if (!array_key_exists('status_net', $activity)) {
+                        $activity['status_net'] = array();
+                    }
+                    $activity['status_net'][$parts[1]] = $props;
+                } else {
+                    $activity[$objectName] = $props;
+                }
+            }
+        }
 
         return array_filter($activity);
     }
@@ -397,7 +535,7 @@ class Activity
         return $xs->getString();
     }
 
-    function outputTo($xs, $namespace=false, $author=true, $source=false)
+    function outputTo($xs, $namespace=false, $author=true, $source=false, $tag='entry')
     {
         if ($namespace) {
             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
@@ -412,16 +550,26 @@ class Activity
             $attrs = array();
         }
 
-        $xs->elementStart('entry', $attrs);
+        $xs->elementStart($tag, $attrs);
 
-        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
+        if ($tag != 'entry') {
+            $xs->element('activity:object-type', null, ActivityObject::ACTIVITY);
+        }
+
+        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1 && $tag == 'entry') {
 
             $obj = $this->objects[0];
                        $obj->outputTo($xs, null);
 
         } else {
             $xs->element('id', null, $this->id);
-            $xs->element('title', null, $this->title);
+
+            if ($this->title) {
+                $xs->element('title', null, $this->title);
+            } else {
+                // Require element
+                $xs->element('title', null, "");
+            }
 
             $xs->element('content', array('type' => 'html'), $this->content);
 
@@ -446,23 +594,15 @@ class Activity
 
         if ($author) {
             $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) {
-                $object->outputTo($xs, 'activity:object');
+                if ($object instanceof Activity) {
+                    $object->outputTo($xs, false, true, true, 'activity:object');
+                } else {
+                    $object->outputTo($xs, 'activity:object');
+                }
             }
         }
 
@@ -485,30 +625,16 @@ class Activity
             }
 
             if (!empty($this->context->conversation)) {
-                $xs->element('link', array('rel' => 'ostatus:conversation',
+                $xs->element('link', array('rel' => ActivityContext::CONVERSATION,
                                            'href' => $this->context->conversation));
             }
 
-            foreach ($this->context->attention as $attnURI) {
-                $xs->element('link', array('rel' => 'ostatus:attention',
-                                           'href' => $attnURI));
-                $xs->element('link', array('rel' => 'mentioned',
+            foreach ($this->context->attention as $attnURI=>$type) {
+                $xs->element('link', array('rel' => ActivityContext::MENTIONED,
+                                           ActivityContext::OBJECTTYPE => $type,  // FIXME: undocumented 
                                            'href' => $attnURI));
             }
 
-            // XXX: shoulda used ActivityVerb::SHARE
-
-            if (!empty($this->context->forwardID)) {
-                if (!empty($this->context->forwardUrl)) {
-                    $xs->element('ostatus:forward',
-                                 array('ref' => $this->context->forwardID,
-                                       'href' => $this->context->forwardUrl));
-                } else {
-                    $xs->element('ostatus:forward',
-                                 array('ref' => $this->context->forwardID));
-                }
-            }
-
             if (!empty($this->context->location)) {
                 $loc = $this->context->location;
                 $xs->element('georss:point', null, $loc->lat . ' ' . $loc->lon);
@@ -596,7 +722,7 @@ class Activity
             $xs->element($tag, $attrs, $content);
         }
 
-        $xs->elementEnd('entry');
+        $xs->elementEnd($tag);
 
         return;
     }
@@ -606,11 +732,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');
     }
 }