]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/twitapisearchatom.php
Merge branch '0.8.x' of git://gitorious.org/laconica/dev into 0.8.x
[quix0rs-gnu-social.git] / actions / twitapisearchatom.php
1 <?php
2 /**
3  * Laconica, the distributed open-source microblogging tool
4  *
5  * Action for showing Twitter-like Atom search results
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  Search
23  * @package   Laconica
24  * @author    Zach Copley <zach@controlyourself.ca>
25  * @copyright 2008-2009 Control Yourself, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://laconi.ca/
28  */
29
30 if (!defined('LACONICA')) {
31     exit(1);
32 }
33
34 require_once INSTALLDIR.'/lib/twitterapi.php';
35
36 /**
37  * Action for outputting search results in Twitter compatible Atom
38  * format.
39  *
40  * TODO: abstract Atom stuff into a ruseable base class like
41  * RSS10Action.
42  *
43  * @category Search
44  * @package  Laconica
45  * @author   Zach Copley <zach@controlyourself.ca>
46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47  * @link     http://laconi.ca/
48  *
49  * @see      TwitterapiAction
50  */
51
52 class TwitapisearchatomAction extends TwitterapiAction
53 {
54
55     var $cnt;
56     var $query;
57     var $lang;
58     var $rpp;
59     var $page;
60     var $since_id;
61     var $geocode;
62
63     /**
64      * Constructor
65      *
66      * Just wraps the Action constructor.
67      *
68      * @param string  $output URI to output to, default = stdout
69      * @param boolean $indent Whether to indent output, default true
70      *
71      * @see Action::__construct
72      */
73
74     function __construct($output='php://output', $indent=true)
75     {
76         parent::__construct($output, $indent);
77     }
78
79     /**
80      * Do we need to write to the database?
81      *
82      * @return boolean true
83      */
84
85     function isReadonly()
86     {
87         return true;
88     }
89
90     /**
91      * Read arguments and initialize members
92      *
93      * @param array $args Arguments from $_REQUEST
94      *
95      * @return boolean success
96      *
97      */
98
99     function prepare($args)
100     {
101         parent::prepare($args);
102
103         $this->query = $this->trimmed('q');
104         $this->lang  = $this->trimmed('lang');
105         $this->rpp   = $this->trimmed('rpp');
106
107         if (!$this->rpp) {
108             $this->rpp = 15;
109         }
110
111         if ($this->rpp > 100) {
112             $this->rpp = 100;
113         }
114
115         $this->page = $this->trimmed('page');
116
117         if (!$this->page) {
118             $this->page = 1;
119         }
120
121         // TODO: Suppport since_id -- we need to tweak the backend
122         // Search classes to support it.
123
124         $this->since_id = $this->trimmed('since_id');
125         $this->geocode  = $this->trimmed('geocode');
126
127         // TODO: Also, language and geocode
128
129         return true;
130     }
131
132     /**
133      * Handle a request
134      *
135      * @param array $args Arguments from $_REQUEST
136      *
137      * @return void
138      */
139
140     function handle($args)
141     {
142         parent::handle($args);
143         $this->showAtom();
144     }
145
146     /**
147      * Get the notices to output as results. This also sets some class
148      * attrs so we can use them to calculate pagination, and output
149      * since_id and max_id.
150      *
151      * @return array an array of Notice objects sorted in reverse chron
152      */
153
154     function getNotices()
155     {
156         // TODO: Support search operators like from: and to:, boolean, etc.
157
158         $notices = array();
159         $notice = new Notice();
160
161         // lcase it for comparison
162         $q = strtolower($this->query);
163
164         $search_engine = $notice->getSearchEngine('identica_notices');
165         $search_engine->set_sort_mode('chron');
166         $search_engine->limit(($this->page - 1) * $this->rpp,
167             $this->rpp + 1, true);
168         $search_engine->query($q);
169         $this->cnt = $notice->find();
170
171         $cnt = 0;
172
173         while ($notice->fetch()) {
174
175             ++$cnt;
176
177             if (!$this->max_id) {
178                 $this->max_id = $notice->id;
179             }
180
181             if ($cnt > $this->rpp) {
182                 break;
183             }
184
185             $notices[] = clone($notice);
186         }
187
188         return $notices;
189     }
190
191     /**
192      * Output search results as an Atom feed
193      *
194      * @return void
195      */
196
197     function showAtom()
198     {
199         $notices = $this->getNotices();
200
201         $this->initAtom();
202         $this->showFeed();
203
204         foreach ($notices as $n) {
205             $this->showEntry($n);
206         }
207
208         $this->endAtom();
209     }
210
211     /**
212      * Show feed specific Atom elements
213      *
214      * @return void
215      */
216
217     function showFeed()
218     {
219         // TODO: A9 OpenSearch stuff like search.twitter.com?
220
221         $server   = common_config('site', 'server');
222         $sitename = common_config('site', 'name');
223
224         // XXX: Use xmlns:laconica instead?
225
226         $this->elementStart('feed',
227             array('xmlns' => 'http://www.w3.org/2005/Atom',
228
229                              // XXX: xmlns:twitter causes Atom validation to fail
230                              // It's used for the source attr on notices
231
232                              'xmlns:twitter' => 'http://api.twitter.com/',
233                              'xml:lang' => 'en-US')); // XXX Other locales ?
234
235         $taguribase = common_config('integration', 'taguri');
236         $this->element('id', null, "tag:$taguribase:search/$server");
237
238         $site_uri = common_path(false);
239
240         $search_uri = $site_uri . 'api/search.atom?q=' . urlencode($this->query);
241
242         if ($this->rpp != 15) {
243             $search_uri .= '&rpp=' . $this->rpp;
244         }
245
246         // FIXME: this alternate link is not quite right because our
247         // web-based notice search doesn't support a rpp (responses per
248         // page) param yet
249
250         $this->element('link', array('type' => 'text/html',
251                                      'rel'  => 'alternate',
252                                      'href' => $site_uri . 'search/notice?q=' .
253                                         urlencode($this->query)));
254
255         // self link
256
257         $self_uri = $search_uri;
258         $self_uri .= ($this->page > 1) ? '&page=' . $this->page : '';
259
260         $this->element('link', array('type' => 'application/atom+xml',
261                                      'rel'  => 'self',
262                                      'href' => $self_uri));
263
264         $this->element('title', null, "$this->query - $sitename Search");
265         $this->element('updated', null, common_date_iso8601('now'));
266
267         // XXX: The below "rel" links are not valid Atom, but it's what
268         // Twitter does...
269
270         // refresh link
271
272         $refresh_uri = $search_uri . "&since_id=" . $this->max_id;
273
274         $this->element('link', array('type' => 'application/atom+xml',
275                                      'rel'  => 'refresh',
276                                      'href' => $refresh_uri));
277
278         // pagination links
279
280         if ($this->cnt > $this->rpp) {
281
282             $next_uri = $search_uri . "&max_id=" . $this->max_id .
283                 '&page=' . ($this->page + 1);
284
285             $this->element('link', array('type' => 'application/atom+xml',
286                                          'rel'  => 'next',
287                                          'href' => $next_uri));
288         }
289
290         if ($this->page > 1) {
291
292             $previous_uri = $search_uri . "&max_id=" . $this->max_id .
293                 '&page=' . ($this->page - 1);
294
295             $this->element('link', array('type' => 'application/atom+xml',
296                                          'rel'  => 'previous',
297                                          'href' => $previous_uri));
298         }
299
300     }
301
302     /**
303      * Build an Atom entry similar to search.twitter.com's based on
304      * a given notice
305      *
306      * @param Notice $notice the notice to use
307      *
308      * @return void
309      */
310
311     function showEntry($notice)
312     {
313         $server  = common_config('site', 'server');
314         $profile = $notice->getProfile();
315         $nurl    = common_local_url('shownotice', array('notice' => $notice->id));
316
317         $this->elementStart('entry');
318
319         $taguribase = common_config('integration', 'taguri');
320
321         $this->element('id', null, "tag:$taguribase:$notice->id");
322         $this->element('published', null, common_date_w3dtf($notice->created));
323         $this->element('link', array('type' => 'text/html',
324                                      'rel'  => 'alternate',
325                                      'href' => $nurl));
326         $this->element('title', null, common_xml_safe_str(trim($notice->content)));
327         $this->element('content', array('type' => 'html'), $notice->rendered);
328         $this->element('updated', null, common_date_w3dtf($notice->created));
329         $this->element('link', array('type' => 'image/png',
330                                      // XXX: Twitter uses rel="image" (not valid)
331                                      'rel' => 'related',
332                                      'href' => $profile->avatarUrl()));
333
334         // TODO: Here is where we'd put in a link to an atom feed for threads
335
336         $this->element("twitter:source", null,
337             htmlentities($this->source_link($notice->source)));
338
339         $this->elementStart('author');
340
341         $name = $profile->nickname;
342
343         if ($profile->fullname) {
344             $name .= ' (' . $profile->fullname . ')';
345         }
346
347         $this->element('name', null, $name);
348         $this->element('uri', null, common_profile_uri($profile));
349         $this->elementEnd('author');
350
351         $this->elementEnd('entry');
352     }
353
354     /**
355      * Initialize the Atom output, send headers
356      *
357      * @return void
358      */
359
360     function initAtom()
361     {
362         header('Content-Type: application/atom+xml; charset=utf-8');
363         $this->startXml();
364     }
365
366     /**
367      * End the Atom feed
368      *
369      * @return void
370      */
371
372     function endAtom()
373     {
374         $this->elementEnd('feed');
375     }
376
377 }