]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apitimelinehome.php
Merge branch '1.0.x' into shortcontrol10x
[quix0rs-gnu-social.git] / actions / apitimelinehome.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show the home timeline
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    mac65 <mac65@mac65.com>
28  * @author    Mike Cochrane <mikec@mikenz.geek.nz>
29  * @author    Robin Millette <robin@millette.info>
30  * @author    Zach Copley <zach@status.net>
31  * @copyright 2009 StatusNet, Inc.
32  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
33  * @link      http://status.net/
34  */
35
36 if (!defined('STATUSNET')) {
37     exit(1);
38 }
39
40 require_once INSTALLDIR . '/lib/apibareauth.php';
41
42 /**
43  * Returns the most recent notices (default 20) posted by the target user.
44  * This is the equivalent of 'You and friends' page accessed via Web.
45  *
46  * @category API
47  * @package  StatusNet
48  * @author   Craig Andrews <candrews@integralblue.com>
49  * @author   Evan Prodromou <evan@status.net>
50  * @author   Jeffery To <jeffery.to@gmail.com>
51  * @author   mac65 <mac65@mac65.com>
52  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
53  * @author   Robin Millette <robin@millette.info>
54  * @author   Zach Copley <zach@status.net>
55  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
56  * @link     http://status.net/
57  */
58
59 class ApiTimelineHomeAction extends ApiBareAuthAction
60 {
61     var $notices  = null;
62
63     /**
64      * Take arguments for running
65      *
66      * @param array $args $_REQUEST args
67      *
68      * @return boolean success flag
69      *
70      */
71
72     function prepare($args)
73     {
74         parent::prepare($args);
75
76         $this->user = $this->getTargetUser($this->arg('id'));
77
78         if (empty($this->user)) {
79             $this->clientError(_('No such user.'), 404, $this->format);
80             return;
81         }
82
83         $this->notices = $this->getNotices();
84
85         return true;
86     }
87
88     /**
89      * Handle the request
90      *
91      * Just show the notices
92      *
93      * @param array $args $_REQUEST data (unused)
94      *
95      * @return void
96      */
97
98     function handle($args)
99     {
100         parent::handle($args);
101         $this->showTimeline();
102     }
103
104     /**
105      * Show the timeline of notices
106      *
107      * @return void
108      */
109
110     function showTimeline()
111     {
112         $profile    = $this->user->getProfile();
113         $avatar     = $profile->getAvatar(AVATAR_PROFILE_SIZE);
114         $sitename   = common_config('site', 'name');
115         $title      = sprintf(_("%s and friends"), $this->user->nickname);
116         $taguribase = TagURI::base();
117         $id         = "tag:$taguribase:HomeTimeline:" . $this->user->id;
118
119         $subtitle   = sprintf(
120             // TRANS: Message is used as a subtitle. %1$s is a user nickname, %2$s is a site name.
121             _('Updates from %1$s and friends on %2$s!'),
122             $this->user->nickname, $sitename
123         );
124
125         $link = common_local_url(
126             'all',
127             array('nickname' => $this->user->nickname)
128         );
129
130         $self = $this->getSelfUri();
131
132         $logo = (!empty($avatar))
133             ? $avatar->displayUrl()
134             : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
135
136         switch($this->format) {
137         case 'xml':
138             $this->showXmlTimeline($this->notices);
139             break;
140         case 'rss':
141             $this->showRssTimeline(
142                 $this->notices,
143                 $title,
144                 $link,
145                 $subtitle,
146                 null,
147                 $logo,
148                 $self
149             );
150             break;
151         case 'atom':
152
153             header('Content-Type: application/atom+xml; charset=utf-8');
154
155             $atom = new AtomNoticeFeed();
156
157             $atom->setId($id);
158             $atom->setTitle($title);
159             $atom->setSubtitle($subtitle);
160             $atom->setLogo($logo);
161             $atom->setUpdated('now');
162
163             $atom->addLink($link);
164             $atom->setSelfLink($self);
165
166             $atom->addEntryFromNotices($this->notices);
167             $this->raw($atom->getString());
168
169             break;
170         case 'json':
171             $this->showJsonTimeline($this->notices);
172             break;
173         default:
174             $this->clientError(_('API method not found.'), $code = 404);
175             break;
176         }
177     }
178
179     /**
180      * Get notices
181      *
182      * @return array notices
183      */
184
185     function getNotices()
186     {
187         $notices = array();
188
189         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
190             $notice = $this->user->noticeInbox(
191                 ($this->page-1) * $this->count,
192                 $this->count, $this->since_id,
193                 $this->max_id
194             );
195         } else {
196             $notice = $this->user->noticesWithFriends(
197                 ($this->page-1) * $this->count,
198                 $this->count, $this->since_id,
199                 $this->max_id
200             );
201         }
202
203         while ($notice->fetch()) {
204             $notices[] = clone($notice);
205         }
206
207         return $notices;
208     }
209
210     /**
211      * Is this action read only?
212      *
213      * @param array $args other arguments
214      *
215      * @return boolean true
216      */
217
218     function isReadOnly($args)
219     {
220         return true;
221     }
222
223     /**
224      * When was this feed last modified?
225      *
226      * @return string datestamp of the latest notice in the stream
227      */
228
229     function lastModified()
230     {
231         if (!empty($this->notices) && (count($this->notices) > 0)) {
232             return strtotime($this->notices[0]->created);
233         }
234
235         return null;
236     }
237
238     /**
239      * An entity tag for this stream
240      *
241      * Returns an Etag based on the action name, language, user ID, and
242      * timestamps of the first and last notice in the timeline
243      *
244      * @return string etag
245      */
246
247     function etag()
248     {
249         if (!empty($this->notices) && (count($this->notices) > 0)) {
250
251             $last = count($this->notices) - 1;
252
253             return '"' . implode(
254                 ':',
255                 array($this->arg('action'),
256                       common_language(),
257                       $this->user->id,
258                       strtotime($this->notices[0]->created),
259                       strtotime($this->notices[$last]->created))
260             )
261             . '"';
262         }
263
264         return null;
265     }
266
267 }