3 * StatusNet, the distributed open-source microblogging tool
5 * Class for serializing Activity Streams in JSON
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Zach Copley <zach@status.net>
25 * @copyright 2011 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('GNUSOCIAL')) {
35 * A class for generating JSON documents that represent an Activity Streams
39 * @author Zach Copley <zach@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41 * @link http://status.net/
43 class ActivityStreamJSONDocument extends JSONActivityCollection
45 // Note: Lot of AS folks think the content type should be:
46 // 'application/stream+json; charset=utf-8', but this is more
47 // useful at the moment, because some programs actually understand
49 const CONTENT_TYPE = 'application/json; charset=utf-8';
51 /* Top level array representing the document */
54 /* The current authenticated user */
56 protected $scoped = null;
58 /* Title of the document */
61 /* Links associated with this document */
64 /* Count of items in this document */
65 // XXX This is cryptically referred to in the spec: "The Stream serialization MAY contain a count property."
71 * @param User $cur the current authenticated user
72 * @throws UserNoProfileException
75 public function __construct($cur = null, $title = null, array $items = [], $links = null, $url = null)
77 parent::__construct($items, $url);
79 $this->cur = $cur ?: common_current_user();
80 $this->scoped = !is_null($this->cur) ? $this->cur->getProfile() : null;
82 /* Title of the JSON document */
83 $this->title = $title;
86 $this->count = count($this->items);
89 /* Array of links associated with the document */
90 $this->links = empty($links) ? [] : $items;
92 /* URL of a document, this document? containing a list of all the items in the stream */
99 * Set the title of the document
101 * @param string $title the title
104 public function setTitle($title)
106 $this->title = $title;
109 public function setUrl($url)
116 * Add more than one Item to the document
118 * @param mixed $notices an array of Notice objects or handle
119 * @throws ClientException
120 * @throws ServerException
123 public function addItemsFromNotices($notices)
125 if (is_array($notices)) {
126 foreach ($notices as $notice) {
127 $this->addItemFromNotice($notice);
130 while ($notices->fetch()) {
131 $this->addItemFromNotice($notices);
137 * Add a single Notice to the document
139 * @param Notice $notice a Notice to add
142 public function addItemFromNotice($notice)
145 $act = $notice->asActivity($this->scoped);
146 } catch (Exception $e) {
147 // We know exceptions like
148 // "No result found on Fave lookup."
149 // may happen because of deleted notices etc.
150 // These are irrelevant for the feed purposes.
153 $act->extra[] = $notice->noticeInfo($this->scoped);
154 array_push($this->items, $act->asArray());
159 * Add a link to the JSON document
161 * @param string $url the URL for the link
162 * @param string $rel the link relationship
165 public function addLink($url = null, $rel = null, $mediaType = null)
167 $link = new ActivityStreamsLink($url, $rel, $mediaType);
168 array_push($this->links, $link->asArray());
172 * Return the entire document as a big string of JSON
174 * @return string encoded JSON output
176 public function asString()
178 $this->doc['generator'] = 'GNU social ' . GNUSOCIAL_VERSION; // extension
179 $this->doc['title'] = $this->title;
180 $this->doc['url'] = $this->url;
181 $this->doc['totalItems'] = $this->count;
182 $this->doc['items'] = $this->items;
183 $this->doc['links'] = $this->links; // extension
184 return json_encode(array_filter($this->doc)); // filter out empty elements