]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apitimelineretweetedtome.php
Give NoticeListItem its own class
[quix0rs-gnu-social.git] / actions / apitimelineretweetedtome.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show most recent notices that are repeats in user's inbox
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    Evan Prodromou <evan@status.net>
25  * @copyright 2009 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/
28  */
29
30 if (!defined('STATUSNET')) {
31     exit(1);
32 }
33
34 require_once INSTALLDIR . '/lib/apiauth.php';
35
36 /**
37  * Show most recent notices that are repeats in user's inbox
38  *
39  * @category API
40  * @package  StatusNet
41  * @author   Evan Prodromou <evan@status.net>
42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43  * @link     http://status.net/
44  */
45 class ApiTimelineRetweetedToMeAction extends ApiAuthAction
46 {
47     const DEFAULTCOUNT = 20;
48     const MAXCOUNT     = 200;
49     const MAXNOTICES   = 3200;
50
51     var $repeats  = null;
52     var $cnt      = self::DEFAULTCOUNT;
53     var $page     = 1;
54     var $since_id = null;
55     var $max_id   = null;
56
57     /**
58      * Take arguments for running
59      *
60      * @param array $args $_REQUEST args
61      *
62      * @return boolean success flag
63      */
64     function prepare($args)
65     {
66         parent::prepare($args);
67
68         $cnt = $this->int('count', self::DEFAULTCOUNT, self::MAXCOUNT, 1);
69
70         $page = $this->int('page', 1, (self::MAXNOTICES/$this->cnt));
71
72         $since_id = $this->int('since_id');
73
74         $max_id = $this->int('max_id');
75
76         return true;
77     }
78
79     /**
80      * Handle the request
81      *
82      * show a timeline of the user's repeated notices
83      *
84      * @param array $args $_REQUEST data (unused)
85      *
86      * @return void
87      */
88     function handle($args)
89     {
90         parent::handle($args);
91
92         $offset = ($this->page-1) * $this->cnt;
93         $limit  = $this->cnt;
94
95         // TRANS: Title for Atom feed "repeated to me". %s is the user nickname.
96         $title      = sprintf(_("Repeated to %s"), $this->auth_user->nickname);
97         $subtitle   = sprintf(
98             _('%1$s notices that were to repeated to %2$s / %3$s.'),
99             $sitename, $this->user->nickname, $profile->getBestName()
100         );
101         $taguribase = TagURI::base();
102         $id         = "tag:$taguribase:RepeatedToMe:" . $this->auth_user->id;
103
104         $link = common_local_url(
105             'all',
106              array('nickname' => $this->auth_user->nickname)
107         );
108
109         $strm = $this->auth_user->repeatedToMe($offset, $limit, $this->since_id, $this->max_id);
110
111         switch ($this->format) {
112         case 'xml':
113             $this->showXmlTimeline($strm);
114             break;
115         case 'json':
116             $this->showJsonTimeline($strm);
117             break;
118         case 'atom':
119             header('Content-Type: application/atom+xml; charset=utf-8');
120
121             $atom = new AtomNoticeFeed($this->auth_user);
122
123             $atom->setId($id);
124             $atom->setTitle($title);
125             $atom->setSubtitle($subtitle);
126             $atom->setUpdated('now');
127             $atom->addLink($link);
128
129             $id = $this->arg('id');
130
131             $atom->setSelfLink($self);
132             $atom->addEntryFromNotices($strm);
133
134             $this->raw($atom->getString());
135
136             break;
137         case 'as':
138             header('Content-Type: application/json; charset=utf-8');
139             $doc = new ActivityStreamJSONDocument($this->auth_user);
140             $doc->setTitle($title);
141             $doc->addLink($link, 'alternate', 'text/html');
142             $doc->addItemsFromNotices($strm);
143             $this->raw($doc->asString());
144             break;
145         default:
146             // TRANS: Client error displayed when trying to handle an unknown API method.
147             $this->clientError(_('API method not found.'), $code = 404);
148             break;
149         }
150     }
151
152     /**
153      * Return true if read only.
154      *
155      * MAY override
156      *
157      * @param array $args other arguments
158      *
159      * @return boolean is read only action?
160      */
161     function isReadOnly($args)
162     {
163         return true;
164     }
165 }