]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apilistsubscriptions.php
Merge activity plugin into mainline
[quix0rs-gnu-social.git] / actions / apilistsubscriptions.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Get a list of lists a user is subscribed to.
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  * @copyright 2009 StatusNet, Inc.
25  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
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/apibareauth.php';
35
36 class ApiListSubscriptionsAction extends ApiBareAuthAction
37 {
38     var $lists = array();
39     var $cursor = -1;
40     var $next_cursor = 0;
41     var $prev_cursor = 0;
42
43     /**
44      * Take arguments for running
45      *
46      * @param array $args $_REQUEST args
47      *
48      * @return boolean success flag
49      *
50      */
51     function prepare($args)
52     {
53         parent::prepare($args);
54
55         $this->cursor = (int) $this->arg('cursor', -1);
56         $this->user = $this->getTargetUser($this->arg('user'));
57         $this->getLists();
58
59         return true;
60     }
61
62     /**
63      * Handle the request
64      *
65      * Show the lists
66      *
67      * @param array $args $_REQUEST data (unused)
68      *
69      * @return void
70      */
71     function handle($args)
72     {
73         parent::handle($args);
74
75         if (empty($this->user)) {
76             // TRANS: Client error displayed trying to perform an action related to a non-existing user.
77             $this->clientError(_('No such user.'), 404, $this->format);
78             return;
79         }
80
81         switch($this->format) {
82         case 'xml':
83             $this->showXmlLists($this->lists, $this->next_cursor, $this->prev_cursor);
84             break;
85         case 'json':
86             $this->showJsonLists($this->lists, $this->next_cursor, $this->prev_cursor);
87             break;
88         default:
89             $this->clientError(
90                 // TRANS: Client error displayed when coming across a non-supported API method.
91                 _('API method not found.'),
92                 400,
93                 $this->format
94             );
95             break;
96         }
97     }
98
99     /**
100      * Return true if read only.
101      *
102      * MAY override
103      *
104      * @param array $args other arguments
105      *
106      * @return boolean is read only action?
107      */
108     function isReadOnly($args)
109     {
110         return true;
111     }
112
113     function getLists()
114     {
115         if(empty($this->user)) {
116             return;
117         }
118
119         $profile = $this->user->getProfile();
120         $fn = array($profile, 'getTagSubscriptions');
121         # 20 lists
122         list($this->lists, $this->next_cursor, $this->prev_cursor) =
123                 Profile_list::getAtCursor($fn, array(), $this->cursor, 20);
124     }
125 }