]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apitimelinegroup.php
Use array_merge instead of array_replace (same effect, and array_merge works with...
[quix0rs-gnu-social.git] / actions / apitimelinegroup.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show a group's notices
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  API
23  * @package   StatusNet
24  * @author    Craig Andrews <candrews@integralblue.com>
25  * @author    Evan Prodromou <evan@status.net>
26  * @author    Jeffery To <jeffery.to@gmail.com>
27  * @author    Zach Copley <zach@status.net>
28  * @copyright 2009-2010 StatusNet, Inc.
29  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
30  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
31  * @link      http://status.net/
32  */
33
34 if (!defined('STATUSNET')) {
35     exit(1);
36 }
37
38 require_once INSTALLDIR . '/lib/apiprivateauth.php';
39
40 /**
41  * Returns the most recent notices (default 20) posted to the group specified by ID
42  *
43  * @category API
44  * @package  StatusNet
45  * @author   Craig Andrews <candrews@integralblue.com>
46  * @author   Evan Prodromou <evan@status.net>
47  * @author   Jeffery To <jeffery.to@gmail.com>
48  * @author   Zach Copley <zach@status.net>
49  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
50  * @link     http://status.net/
51  */
52 class ApiTimelineGroupAction extends ApiPrivateAuthAction
53 {
54     var $group   = null;
55     var $notices = null;
56
57     /**
58      * Take arguments for running
59      *
60      * @param array $args $_REQUEST args
61      *
62      * @return boolean success flag
63      *
64      */
65     function prepare($args)
66     {
67         parent::prepare($args);
68
69         $this->group   = $this->getTargetGroup($this->arg('id'));
70
71         return true;
72     }
73
74     /**
75      * Handle the request
76      *
77      * Just show the notices
78      *
79      * @param array $args $_REQUEST data (unused)
80      *
81      * @return void
82      */
83     function handle($args)
84     {
85         parent::handle($args);
86
87         if (empty($this->group)) {
88             // TRANS: Client error displayed requesting most recent notices to a group for a non-existing group.
89             $this->clientError(_('Group not found.'), 404, $this->format);
90             return false;
91         }
92
93         $this->notices = $this->getNotices();
94         $this->showTimeline();
95     }
96
97     /**
98      * Show the timeline of notices
99      *
100      * @return void
101      */
102     function showTimeline()
103     {
104         // We'll pull common formatting out of this for other formats
105         $atom = new AtomGroupNoticeFeed($this->group, $this->auth_user);
106
107         $self = $this->getSelfUri();
108
109         $link = common_local_url('showgroup',
110                                  array('nickname' => $this->group->nickname));
111
112         switch($this->format) {
113         case 'xml':
114             $this->showXmlTimeline($this->notices);
115             break;
116         case 'rss':
117             $this->showRssTimeline(
118                 $this->notices,
119                 $atom->title,
120                 $this->group->homeUrl(),
121                 $atom->subtitle,
122                 null,
123                 $atom->logo,
124                 $self
125             );
126             break;
127         case 'atom':
128             header('Content-Type: application/atom+xml; charset=utf-8');
129                 $atom->addEntryFromNotices($this->notices);
130                 $this->raw($atom->getString());
131             break;
132         case 'json':
133             $this->showJsonTimeline($this->notices);
134             break;
135         case 'as':
136             header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
137             $doc = new ActivityStreamJSONDocument($this->auth_user);
138             $doc->setTitle($atom->title);
139             $doc->addLink($link, 'alternate', 'text/html');
140             $doc->addItemsFromNotices($this->notices);
141             $this->raw($doc->asString());
142             break;
143         default:
144             $this->clientError(
145                 // TRANS: Client error displayed when trying to handle an unknown API method.
146                 _('API method not found.'),
147                 404,
148                 $this->format
149             );
150             break;
151         }
152     }
153
154     /**
155      * Get notices
156      *
157      * @return array notices
158      */
159     function getNotices()
160     {
161         $notices = array();
162
163         $notice = $this->group->getNotices(
164             ($this->page-1) * $this->count,
165             $this->count,
166             $this->since_id,
167             $this->max_id
168         );
169
170         while ($notice->fetch()) {
171             $notices[] = clone($notice);
172         }
173
174         return $notices;
175     }
176
177     /**
178      * Is this action read only?
179      *
180      * @param array $args other arguments
181      *
182      * @return boolean true
183      */
184     function isReadOnly($args)
185     {
186         return true;
187     }
188
189     /**
190      * When was this feed last modified?
191      *
192      * @return string datestamp of the latest notice in the stream
193      */
194     function lastModified()
195     {
196         if (!empty($this->notices) && (count($this->notices) > 0)) {
197             return strtotime($this->notices[0]->created);
198         }
199
200         return null;
201     }
202
203     /**
204      * An entity tag for this stream
205      *
206      * Returns an Etag based on the action name, language, group ID and
207      * timestamps of the first and last notice in the timeline
208      *
209      * @return string etag
210      */
211     function etag()
212     {
213         if (!empty($this->notices) && (count($this->notices) > 0)) {
214
215             $last = count($this->notices) - 1;
216
217             return '"' . implode(
218                 ':',
219                 array($this->arg('action'),
220                       common_user_cache_hash($this->auth_user),
221                       common_language(),
222                       $this->group->id,
223                       strtotime($this->notices[0]->created),
224                       strtotime($this->notices[$last]->created))
225             )
226             . '"';
227         }
228
229         return null;
230     }
231 }