3 * Laconica, the distributed open-source microblogging tool
5 * Action for showing Twitter-like Atom search results
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.
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.
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/>.
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/
30 if (!defined('LACONICA')) {
34 require_once INSTALLDIR.'/lib/twitterapi.php';
37 * Action for outputting search results in Twitter compatible Atom
40 * TODO: abstract Atom stuff into a ruseable base class like
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/
49 * @see TwitterapiAction
52 class TwitapisearchatomAction extends TwitterapiAction
67 * Just wraps the Action constructor.
69 * @param string $output URI to output to, default = stdout
70 * @param boolean $indent Whether to indent output, default true
72 * @see Action::__construct
75 function __construct($output='php://output', $indent=true)
77 parent::__construct($output, $indent);
81 * Do we need to write to the database?
83 * @return boolean true
92 * Read arguments and initialize members
94 * @param array $args Arguments from $_REQUEST
96 * @return boolean success
100 function prepare($args)
102 parent::prepare($args);
104 $this->query = $this->trimmed('q');
105 $this->lang = $this->trimmed('lang');
106 $this->rpp = $this->trimmed('rpp');
112 if ($this->rpp > 100) {
116 $this->page = $this->trimmed('page');
122 // TODO: Suppport since_id -- we need to tweak the backend
123 // Search classes to support it.
125 $this->since_id = $this->trimmed('since_id');
126 $this->geocode = $this->trimmed('geocode');
128 // TODO: Also, language and geocode
136 * @param array $args Arguments from $_REQUEST
141 function handle($args)
143 parent::handle($args);
148 * Get the notices to output as results. This also sets some class
149 * attrs so we can use them to calculate pagination, and output
150 * since_id and max_id.
152 * @return array an array of Notice objects sorted in reverse chron
155 function getNotices()
157 // TODO: Support search operators like from: and to:, boolean, etc.
159 $notice = new Notice();
161 // lcase it for comparison
162 $q = strtolower($this->query);
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();
173 while ($notice->fetch()) {
177 if (!$this->max_id) {
178 $this->max_id = $notice->id;
181 if ($cnt > $this->rpp) {
185 $notices[] = clone($notice);
192 * Output search results as an Atom feed
199 $notices = $this->getNotices();
204 foreach ($notices as $n) {
205 $this->showEntry($n);
212 * Show feed specific Atom elements
219 // TODO: A9 OpenSearch stuff like search.twitter.com?
221 $lang = common_config('site', 'language');
222 $server = common_config('site', 'server');
223 $sitename = common_config('site', 'name');
225 // XXX: Use xmlns:laconica instead?
227 $this->elementStart('feed',
228 array('xmlns' => 'http://www.w3.org/2005/Atom',
229 'xmlns:twitter' => 'http://api.twitter.com/',
230 'xml:lang' => $lang));
233 $this->element('id', null, "tag:$server,$year:search/$server");
235 $site_uri = common_path(false);
237 $search_uri = $site_uri . 'api/search.atom?q=' . urlencode($this->query);
239 if ($this->rpp != 15) {
240 $search_uri .= '&rpp=' . $this->rpp;
243 // FIXME: this alternate link is not quite right because our
244 // web-based notice search doesn't support a rpp (responses per
247 $this->element('link', array('type' => 'text/html',
248 'rel' => 'alternate',
249 'href' => $site_uri . 'search/notice?q=' .
250 urlencode($this->query)));
254 $self_uri = $search_uri . '&page=' . $this->page;
256 $this->element('link', array('type' => 'application/atom+xml',
258 'href' => $self_uri));
260 $this->element('title', null, "$this->query - $sitename Search");
264 $refresh_uri = $search_uri . "&since_id=" . $this->max_id;
266 $this->element('link', array('type' => 'application/atom+xml',
268 'href' => $refresh_uri));
272 if ($this->cnt > $this->rpp) {
274 $next_uri = $search_uri . "&max_id=" . $this->max_id .
275 '&page=' . ($this->page + 1);
277 $this->element('link', array('type' => 'application/atom+xml',
279 'href' => $next_uri));
282 if ($this->page > 1) {
284 $previous_uri = $search_uri . "&max_id=" . $this->max_id .
285 '&page=' . ($this->page - 1);
287 $this->element('link', array('type' => 'application/atom+xml',
289 'href' => $previous_uri));
295 * Build an Atom entry similar to search.twitter.com's based on
298 * @param Notice $notice the notice to use
303 function showEntry($notice)
305 $server = common_config('site', 'server');
306 $profile = $notice->getProfile();
307 $nurl = common_local_url('shownotice', array('notice' => $notice->id));
309 $this->elementStart('entry');
311 $year = date('Y', strtotime($notice->created));
313 $this->element('id', null, "tag:$server,$year:$notice->id");
314 $this->element('published', null, common_date_w3dtf($notice->created));
315 $this->element('link', array('type' => 'text/html',
316 'rel' => 'alternate',
318 $this->element('title', null, common_xml_safe_str(trim($notice->content)));
319 $this->element('content', array('type' => 'text/html'), $notice->rendered);
320 $this->element('updated', null, common_date_w3dtf($notice->created));
321 $this->element('link', array('type' => 'image/png',
323 'href' => $profile->avatarUrl()));
325 // TODO: Here is where we'd put in a link to an atom feed for threads
327 $this->element("twitter:source", null,
328 htmlentities($this->source_link($notice->source)));
330 $this->elementStart('author');
332 $name = $profile->nickname;
334 if ($profile->fullname) {
335 $name .= ' (' . $profile->fullname . ')';
338 $this->element('name', null, $name);
339 $this->element('uri', null, common_profile_uri($profile));
340 $this->elementEnd('author');
342 $this->elementEnd('entry');
346 * Initialize the Atom output, send headers
353 header('Content-Type: application/atom+xml; charset=utf-8');
365 $this->elementEnd('feed');