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