]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/rsd.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / actions / rsd.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2008-2010, StatusNet, Inc.
5  *
6  * Really Simple Discovery (RSD) for API access
7  *
8  * PHP version 5
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Affero General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Affero General Public License for more details.
19  *
20  * You should have received a copy of the GNU Affero General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * @category API
24  * @package  StatusNet
25  * @author   Evan Prodromou <evan@status.net>
26  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
27  * @link     http://status.net/
28  *
29  */
30
31 if (!defined('STATUSNET')) {
32     exit(1);
33 }
34
35 /**
36  * RSD action class
37  *
38  * Really Simple Discovery (RSD) is a simple (to a fault, maybe)
39  * discovery tool for blog APIs.
40  *
41  * http://tales.phrasewise.com/rfc/rsd
42  *
43  * Anil Dash suggested that RSD be used for services that implement
44  * the Twitter API:
45  *
46  * http://dashes.com/anil/2009/12/the-twitter-api-is-finished.html
47  *
48  * It's in use now for WordPress.com blogs:
49  *
50  * http://matt.wordpress.com/xmlrpc.php?rsd
51  *
52  * I (evan@status.net) have tried to stay faithful to the premise of
53  * RSD, while adding information useful to StatusNet client developers.
54  * In particular:
55  *
56  * - There is a link from each user's profile page to their personal
57  *   RSD feed. A personal rsd.xml includes a 'blogID' element that is
58  *   their username.
59  * - There is a link from the public root to '/rsd.xml', a public RSD
60  *   feed. It's identical to the personal rsd except it doesn't include
61  *   a blogId.
62  * - I've added a setting to the API to indicate that OAuth support is
63  *   available.
64  *
65  * @category API
66  * @package  StatusNet
67  * @author   Evan Prodromou <evan@status.net>
68  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
69  * @link     http://status.net/
70  */
71
72 class RsdAction extends Action
73 {
74     /**
75      * Optional attribute for the personal rsd.xml file.
76      */
77
78     var $user = null;
79
80     /**
81      * Prepare the action for use.
82      *
83      * Check for a nickname; redirect if non-canonical; if
84      * not provided, assume public rsd.xml.
85      *
86      * @param array $args GET, POST, and URI arguments.
87      *
88      * @return boolean success flag
89      */
90
91     function prepare($args)
92     {
93         parent::prepare($args);
94
95         // optional argument
96
97         $nickname_arg = $this->arg('nickname');
98
99         if (empty($nickname_arg)) {
100             $this->user = null;
101         } else {
102             $nickname = common_canonical_nickname($nickname_arg);
103
104             // Permanent redirect on non-canonical nickname
105
106             if ($nickname_arg != $nickname) {
107                 common_redirect(common_local_url('rsd',
108                                                  array('nickname' => $nickname)),
109                                 301);
110                 return false;
111             }
112
113             $this->user = User::staticGet('nickname', $nickname);
114
115             if (empty($this->user)) {
116                 $this->clientError(_('No such user.'), 404);
117                 return false;
118             }
119         }
120
121         return true;
122     }
123
124     /**
125      * Action handler.
126      *
127      * Outputs the XML format for an RSD file. May include
128      * personal information if this is a personal file
129      * (based on whether $user attribute is set).
130      *
131      * @param array $args array of arguments
132      *
133      * @return nothing
134      */
135
136     function handle($args)
137     {
138         header('Content-Type: application/rsd+xml');
139
140         $this->startXML();
141
142         $rsdNS = 'http://archipelago.phrasewise.com/rsd';
143         $this->elementStart('rsd', array('version' => '1.0',
144                                          'xmlns' => $rsdNS));
145         $this->elementStart('service');
146         $this->element('engineName', null, _('StatusNet'));
147         $this->element('engineLink', null, 'http://status.net/');
148         $this->elementStart('apis');
149         if (Event::handle('StartRsdListApis', array($this, $this->user))) {
150
151             $blogID   = (empty($this->user)) ? '' : $this->user->nickname;
152             $apiAttrs = array('name' => 'Twitter',
153                               'preferred' => 'true',
154                               'apiLink' => $this->_apiRoot(),
155                               'blogID' => $blogID);
156
157             $this->elementStart('api', $apiAttrs);
158             $this->elementStart('settings');
159             $this->element('docs', null,
160                            'http://status.net/wiki/TwitterCompatibleAPI');
161             $this->element('setting', array('name' => 'OAuth'),
162                            'true');
163             $this->elementEnd('settings');
164             $this->elementEnd('api');
165             Event::handle('EndRsdListApis', array($this, $this->user));
166         }
167         $this->elementEnd('apis');
168         $this->elementEnd('service');
169         $this->elementEnd('rsd');
170
171         $this->endXML();
172
173         return true;
174     }
175
176     /**
177      * Returns last-modified date for use in caching
178      *
179      * Per-user rsd.xml is dated to last change of user
180      * (in case of nickname change); public has no date.
181      *
182      * @return string date of last change of this page
183      */
184
185     function lastModified()
186     {
187         if (!empty($this->user)) {
188             return $this->user->modified;
189         } else {
190             return null;
191         }
192     }
193
194     /**
195      * Flag to indicate if this action is read-only
196      *
197      * It is; it doesn't change the DB.
198      *
199      * @param array $args ignored
200      *
201      * @return boolean true
202      */
203
204     function isReadOnly($args)
205     {
206         return true;
207     }
208
209     /**
210      * Return current site's API root
211      *
212      * Varies based on URL parameters, like if fancy URLs are
213      * turned on.
214      *
215      * @return string API root URI for this site
216      */
217
218     private function _apiRoot()
219     {
220         if (common_config('site', 'fancy')) {
221             return common_path('api/', true);
222         } else {
223             return common_path('index.php/api/', true);
224         }
225     }
226 }