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