]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/activitystreamjsondocument.php
Merge remote-tracking branch 'upstream/nightly' into nightly
[quix0rs-gnu-social.git] / lib / activitystreamjsondocument.php
index 57ece9f6bf78d84cdd4a36fc5f24495b5e61e62d..12c3882c25d444b299293f27544294762719010d 100644 (file)
@@ -41,13 +41,30 @@ if (!defined('STATUSNET'))
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
-class ActivityStreamJSONDocument
+class ActivityStreamJSONDocument extends JSONActivityCollection
 {
+    // Note: Lot of AS folks think the content type should be:
+    // 'application/stream+json; charset=utf-8', but this is more
+    // useful at the moment, because some programs actually understand
+    // it.
+    const CONTENT_TYPE = 'application/json; charset=utf-8';
+
     /* Top level array representing the document */
     protected $doc = array();
 
     /* The current authenticated user */
-    protected $cur = null;
+    protected $cur;
+    protected $scoped = null;
+
+    /* Title of the document */
+    protected $title;
+
+    /* Links associated with this document */
+    protected $links;
+
+    /* Count of items in this document */
+    // XXX This is cryptically referred to in the spec: "The Stream serialization MAY contain a count property."
+    protected $count;
 
     /**
      * Constructor
@@ -55,13 +72,46 @@ class ActivityStreamJSONDocument
      * @param User $cur the current authenticated user
      */
 
-    function __construct($cur = null)
+    function __construct($cur = null, $title = null, $items = null, $links = null, $url = null)
     {
-        $this->cur = $cur;
+        parent::__construct($items, $url);
+
+        $this->cur = $cur ?: common_current_user();
+        $this->scoped = !is_null($this->cur) ? $this->cur->getProfile() : null;
+
+        /* Title of the JSON document */
+        $this->title = $title;
+
+        if (!empty($items)) {
+            $this->count = count($this->items);
+        }
+
+        /* Array of links associated with the document */
+        $this->links = empty($links) ? array() : $items;
 
-        $this->doc['items'] = array();
+        /* URL of a document, this document? containing a list of all the items in the stream */
+        if (!empty($this->url)) {
+            $this->url = $this->url;
+        }
     }
 
+    /**
+     * Set the title of the document
+     *
+     * @param String $title the title
+     */
+
+    function setTitle($title)
+    {
+        $this->title = $title;
+    }
+
+    function setUrl($url)
+    {
+        $this->url = $url;
+    }
+
+
     /**
      * Add more than one Item to the document
      *
@@ -71,7 +121,6 @@ class ActivityStreamJSONDocument
 
     function addItemsFromNotices($notices)
     {
-        common_debug("addItemsFromNotices");
         if (is_array($notices)) {
             foreach ($notices as $notice) {
                 $this->addItemFromNotice($notice);
@@ -91,12 +140,22 @@ class ActivityStreamJSONDocument
 
     function addItemFromNotice($notice)
     {
-        $cur = empty($this->cur) ? common_current_user() : $this->cur;
-
-        $act          = $notice->asActivity();
-        $act->extra[] = $notice->noticeInfo($cur);
+        $act          = $notice->asActivity($this->scoped);
+        $act->extra[] = $notice->noticeInfo($this->scoped);
+        array_push($this->items, $act->asArray());
+        $this->count++;
+    }
 
-        array_push($this->doc['items'], $act->asArray());
+    /**
+     * Add a link to the JSON document
+     *
+     * @param string $url the URL for the link
+     * @param string $rel the link relationship
+     */
+    function addLink($url = null, $rel = null, $mediaType = null)
+    {
+        $link = new ActivityStreamsLink($url, $rel, $mediaType);
+        array_push($this->links, $link->asArray());
     }
 
     /*
@@ -106,7 +165,13 @@ class ActivityStreamJSONDocument
      */
     function asString()
     {
-        return json_encode($this->doc);
+        $this->doc['generator'] = 'GNU social ' . GNUSOCIAL_VERSION; // extension
+        $this->doc['title'] = $this->title;
+        $this->doc['url']   = $this->url;
+        $this->doc['totalItems'] = $this->count;
+        $this->doc['items'] = $this->items;
+        $this->doc['links'] = $this->links; // extension
+        return json_encode(array_filter($this->doc)); // filter out empty elements
     }
 
 }