]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/activity.php
auth fix
[quix0rs-gnu-social.git] / lib / activity.php
index 691ace1f6f1e245e19b1f5bb00841a1c44ac6cf1..c3a984a7b994f289995dccf521ee0e4eb8b83fda 100644 (file)
@@ -48,11 +48,11 @@ if (!defined('STATUSNET')) {
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  * @link      http://status.net/
  */
-
 class Activity
 {
     const SPEC   = 'http://activitystrea.ms/spec/1.0/';
     const SCHEMA = 'http://activitystrea.ms/schema/1.0/';
+    const MEDIA  = 'http://purl.org/syndication/atommedia';
 
     const VERB       = 'verb';
     const OBJECT     = 'object';
@@ -82,10 +82,11 @@ class Activity
     const CREATOR = 'creator';
 
     const CONTENTNS = 'http://purl.org/rss/1.0/modules/content/';
+    const ENCODED = 'encoded';
 
     public $actor;   // an ActivityObject
     public $verb;    // a string (the URL)
-    public $object;  // an ActivityObject
+    public $objects = array();  // an array of ActivityObjects
     public $target;  // an ActivityObject
     public $context; // an ActivityObject
     public $time;    // Time of the activity
@@ -100,13 +101,17 @@ class Activity
     public $categories = array(); // list of AtomCategory objects
     public $enclosures = array(); // list of enclosure URL references
 
+    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'>
+
     /**
      * Turns a regular old Atom <entry> into a magical activity
      *
      * @param DOMElement $entry Atom entry to poke at
      * @param DOMElement $feed  Atom feed, for context
      */
-
     function __construct($entry = null, $feed = null)
     {
         if (is_null($entry)) {
@@ -116,7 +121,8 @@ class Activity
         // Insist on a feed's root DOMElement; don't allow a DOMDocument
         if ($feed instanceof DOMDocument) {
             throw new ClientException(
-                _("Expecting a root feed element but got a whole XML document.")
+                // TRANS: Client exception thrown when a feed instance is a DOMDocument.
+                _('Expecting a root feed element but got a whole XML document.')
             );
         }
 
@@ -130,6 +136,7 @@ class Activity
                    $entry->localName == 'item') {
             $this->_fromRssItem($entry, $feed);
         } else {
+            // Low level exception. No need for i18n.
             throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
         }
     }
@@ -161,12 +168,15 @@ class Activity
             // XXX: do other implied stuff here
         }
 
-        $objectEl = $this->_child($entry, self::OBJECT);
+        $objectEls = $entry->getElementsByTagNameNS(self::SPEC, self::OBJECT);
 
-        if (!empty($objectEl)) {
-            $this->object = new ActivityObject($objectEl);
+        if ($objectEls->length > 0) {
+            for ($i = 0; $i < $objectEls->length; $i++) {
+                $objectEl = $objectEls->item($i);
+                $this->objects[] = new ActivityObject($objectEl);
+            }
         } else {
-            $this->object = new ActivityObject($entry);
+            $this->objects[] = new ActivityObject($entry);
         }
 
         $actorEl = $this->_child($entry, self::ACTOR);
@@ -175,6 +185,17 @@ class Activity
 
             $this->actor = new ActivityObject($actorEl);
 
+            // Cliqset has bad actor IDs (just nickname of user). We
+            // work around it by getting the author data and using its
+            // id instead
+
+            if (!preg_match('/^\w+:/', $this->actor->id)) {
+                $authorEl = ActivityUtils::child($entry, 'author');
+                if (!empty($authorEl)) {
+                    $authorObj = new ActivityObject($authorEl);
+                    $this->actor->id = $authorObj->id;
+                }
+            }
         } else if (!empty($feed) &&
                    $subjectEl = $this->_child($feed, self::SUBJECT)) {
 
@@ -219,6 +240,11 @@ class Activity
         foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
             $this->enclosures[] = $link->getAttribute('href');
         }
+
+        // From APP. Might be useful.
+
+        $this->selfLink = ActivityUtils::getLink($entry, 'self', 'application/atom+xml');
+        $this->editLink = ActivityUtils::getLink($entry, 'edit', 'application/atom+xml');
     }
 
     function _fromRssItem($item, $channel)
@@ -253,14 +279,21 @@ class Activity
 
         $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, self::RSS);
 
-        $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, self::CONTENTNS);
+        $contentEl = ActivityUtils::child($item, self::ENCODED, self::CONTENTNS);
 
         if (!empty($contentEl)) {
-            $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
+            // <content:encoded> XML node's text content is HTML; no further processing needed.
+            $this->content = $contentEl->textContent;
         } else {
             $descriptionEl = ActivityUtils::child($item, self::DESCRIPTION, self::RSS);
             if (!empty($descriptionEl)) {
-                $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
+                // Per spec, <description> must be plaintext.
+                // In practice, often there's HTML... but these days good
+                // feeds are using <content:encoded> which is explicitly
+                // real HTML.
+                // We'll treat this following spec, and do HTML escaping
+                // to convert from plaintext to HTML.
+                $this->content = htmlspecialchars($descriptionEl->textContent);
             }
         }
 
@@ -280,8 +313,8 @@ class Activity
             }
         }
 
-        $this->object  = new ActivityObject($item);
-        $this->context = new ActivityContext($item);
+        $this->objects[] = new ActivityObject($item);
+        $this->context   = new ActivityContext($item);
     }
 
     /**
@@ -289,58 +322,148 @@ class Activity
      *
      * @return DOMElement Atom entry
      */
-
     function toAtomEntry()
     {
         return null;
     }
 
-    function asString($namespace=false)
+    function asString($namespace=false, $author=true, $source=false)
     {
         $xs = new XMLStringer(true);
 
         if ($namespace) {
             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
+                           'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
                            'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
                            'xmlns:georss' => 'http://www.georss.org/georss',
                            'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
                            'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
-                           'xmlns:media' => 'http://purl.org/syndication/atommedia');
+                           'xmlns:media' => 'http://purl.org/syndication/atommedia',
+                           'xmlns:statusnet' => 'http://status.net/schema/api/1/');
         } else {
             $attrs = array();
         }
 
         $xs->elementStart('entry', $attrs);
 
-        $xs->element('id', null, $this->id);
-        $xs->element('title', null, $this->title);
-        $xs->element('published', null, common_date_iso8601($this->time));
-        $xs->element('content', array('type' => 'html'), $this->content);
+        if ($this->verb == ActivityVerb::POST && count($this->objects) == 1) {
 
-        if (!empty($this->summary)) {
-            $xs->element('summary', null, $this->summary);
-        }
+            $obj = $this->objects[0];
 
-        if (!empty($this->link)) {
-            $xs->element('link', array('rel' => 'alternate',
-                                       'type' => 'text/html'),
-                         $this->link);
-        }
+            $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.
+
+        } else {
+            $xs->element('id', null, $this->id);
+            $xs->element('title', null, $this->title);
 
-        // XXX: add context
+            $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'),
+                             $this->link);
+            }
 
-        $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'));
 
         $xs->element('activity:verb', null, $this->verb);
 
-        if ($this->object) {
-            $xs->raw($this->object->asString());
+        $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'));
+        }
+
+        if ($this->verb != ActivityVerb::POST || count($this->objects) != 1) {
+            foreach($this->objects as $object) {
+                $xs->raw($object->asString());
+            }
+        }
+
+        if (!empty($this->context)) {
+
+            if (!empty($this->context->replyToID)) {
+                if (!empty($this->context->replyToUrl)) {
+                    $xs->element('thr:in-reply-to',
+                                 array('ref' => $this->context->replyToID,
+                                       'href' => $this->context->replyToUrl));
+                } else {
+                    $xs->element('thr:in-reply-to',
+                                 array('ref' => $this->context->replyToID));
+                }
+            }
+
+            if (!empty($this->context->replyToUrl)) {
+                $xs->element('link', array('rel' => 'related',
+                                           'href' => $this->context->replyToUrl));
+            }
+
+            if (!empty($this->context->conversation)) {
+                $xs->element('link', array('rel' => 'ostatus: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',
+                                           '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);
+            }
         }
 
         if ($this->target) {
@@ -351,59 +474,96 @@ class Activity
             $xs->raw($cat->asString());
         }
 
-        $xs->elementEnd('entry');
+        // can be either URLs or enclosure objects
+        
+        foreach ($this->enclosures as $enclosure) {
+            if (is_string($enclosure)) {
+                $xs->element('link', array('rel' => 'enclosure',
+                                           'href' => $enclosure));
+            } else {
+                $attributes = array('rel' => 'enclosure',
+                                    'href' => $enclosure->url,
+                                    'type' => $enclosure->mimetype,
+                                    'length' => $enclosure->size);
+                if ($enclosure->title) {
+                    $attributes['title'] = $enclosure->title;
+                }
+                $xs->element('link', $attributes);
+            }
+        }
 
-        return $xs->getString();
-    }
+        // Info on the source feed
 
-    private function _child($element, $tag, $namespace=self::SPEC)
-    {
-        return ActivityUtils::child($element, $tag, $namespace);
-    }
-}
+        if ($source && !empty($this->source)) {
+            $xs->elementStart('source');
+           
+            $xs->element('id', null, $this->source->id);
+            $xs->element('title', null, $this->source->title);
 
-class AtomCategory
-{
-    public $term;
-    public $scheme;
-    public $label;
+            if (array_key_exists('alternate', $this->source->links)) {
+                $xs->element('link', array('rel' => 'alternate',
+                                           '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',
+                                           'href' => $this->source->links['self']));
+            }
 
-    function __construct($element=null)
-    {
-        if ($element && $element->attributes) {
-            $this->term = $this->extract($element, 'term');
-            $this->scheme = $this->extract($element, 'scheme');
-            $this->label = $this->extract($element, 'label');
+            if (array_key_exists('license', $this->source->links)) {
+                $xs->element('link', array('rel' => 'license',
+                                           'href' => $this->source->links['license']));
+            }
+
+            if (!empty($this->source->icon)) {
+                $xs->element('icon', null, $this->source->icon);
+            }
+
+            if (!empty($this->source->updated)) {
+                $xs->element('updated', null, $this->source->updated);
+            }
+           
+            $xs->elementEnd('source');
         }
-    }
 
-    protected function extract($element, $attrib)
-    {
-        $node = $element->attributes->getNamedItemNS(Activity::ATOM, $attrib);
-        if ($node) {
-            return trim($node->textContent);
+        if (!empty($this->selfLink)) {
+            $xs->element('link', array('rel' => 'self',
+                                       'type' => 'application/atom+xml',
+                                       'href' => $this->selfLink));
         }
-        $node = $element->attributes->getNamedItem($attrib);
-        if ($node) {
-            return trim($node->textContent);
+
+        if (!empty($this->editLink)) {
+            $xs->element('link', array('rel' => 'edit',
+                                       'type' => 'application/atom+xml',
+                                       'href' => $this->editLink));
         }
-        return null;
+
+        // 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');
+
+        $str = $xs->getString();
+       
+        return $str;
     }
 
-    function asString()
+    private function _child($element, $tag, $namespace=self::SPEC)
     {
-        $attribs = array();
-        if ($this->term !== null) {
-            $attribs['term'] = $this->term;
-        }
-        if ($this->scheme !== null) {
-            $attribs['scheme'] = $this->scheme;
-        }
-        if ($this->label !== null) {
-            $attribs['label'] = $this->label;
-        }
-        $xs = new XMLStringer();
-        $xs->element('category', $attribs);
-        return $xs->asString();
+        return ActivityUtils::child($element, $tag, $namespace);
+    }
+
+    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');
     }
 }