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
66 * Just wraps the Action constructor.
68 * @param string $output URI to output to, default = stdout
69 * @param boolean $indent Whether to indent output, default true
71 * @see Action::__construct
74 function __construct($output='php://output', $indent=true)
76 parent::__construct($output, $indent);
80 * Do we need to write to the database?
82 * @return boolean true
91 * Read arguments and initialize members
93 * @param array $args Arguments from $_REQUEST
95 * @return boolean success
99 function prepare($args)
101 parent::prepare($args);
103 $this->query = $this->trimmed('q');
104 $this->lang = $this->trimmed('lang');
105 $this->rpp = $this->trimmed('rpp');
111 if ($this->rpp > 100) {
115 $this->page = $this->trimmed('page');
121 // TODO: Suppport since_id -- we need to tweak the backend
122 // Search classes to support it.
124 $this->since_id = $this->trimmed('since_id');
125 $this->geocode = $this->trimmed('geocode');
127 // TODO: Also, language and geocode
135 * @param array $args Arguments from $_REQUEST
140 function handle($args)
142 parent::handle($args);
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.
151 * @return array an array of Notice objects sorted in reverse chron
154 function getNotices()
156 // 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();
174 while ($notice->fetch()) {
178 if (!$this->max_id) {
179 $this->max_id = $notice->id;
182 if ($cnt > $this->rpp) {
186 $notices[] = clone($notice);
193 * Output search results as an Atom feed
200 $notices = $this->getNotices();
205 foreach ($notices as $n) {
206 $this->showEntry($n);
213 * Show feed specific Atom elements
220 // TODO: A9 OpenSearch stuff like search.twitter.com?
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',
230 // XXX: xmlns:twitter causes Atom validation to fail
231 // It's used for the source attr on notices
233 'xmlns:twitter' => 'http://api.twitter.com/',
234 'xml:lang' => 'en-US')); // XXX Other locales ?
236 $taguribase = common_config('integration', 'taguri');
237 $this->element('id', null, "tag:$taguribase:search/$server");
239 $site_uri = common_path(false);
241 $search_uri = $site_uri . 'api/search.atom?q=' . urlencode($this->query);
243 if ($this->rpp != 15) {
244 $search_uri .= '&rpp=' . $this->rpp;
247 // FIXME: this alternate link is not quite right because our
248 // web-based notice search doesn't support a rpp (responses per
251 $this->element('link', array('type' => 'text/html',
252 'rel' => 'alternate',
253 'href' => $site_uri . 'search/notice?q=' .
254 urlencode($this->query)));
258 $self_uri = $search_uri;
259 $self_uri .= ($this->page > 1) ? '&page=' . $this->page : '';
261 $this->element('link', array('type' => 'application/atom+xml',
263 'href' => $self_uri));
265 $this->element('title', null, "$this->query - $sitename Search");
266 $this->element('updated', null, common_date_iso8601('now'));
268 // XXX: The below "rel" links are not valid Atom, but it's what
273 $refresh_uri = $search_uri . "&since_id=" . $this->max_id;
275 $this->element('link', array('type' => 'application/atom+xml',
277 'href' => $refresh_uri));
281 if ($this->cnt > $this->rpp) {
283 $next_uri = $search_uri . "&max_id=" . $this->max_id .
284 '&page=' . ($this->page + 1);
286 $this->element('link', array('type' => 'application/atom+xml',
288 'href' => $next_uri));
291 if ($this->page > 1) {
293 $previous_uri = $search_uri . "&max_id=" . $this->max_id .
294 '&page=' . ($this->page - 1);
296 $this->element('link', array('type' => 'application/atom+xml',
298 'href' => $previous_uri));
304 * Build an Atom entry similar to search.twitter.com's based on
307 * @param Notice $notice the notice to use
312 function showEntry($notice)
314 $server = common_config('site', 'server');
315 $profile = $notice->getProfile();
316 $nurl = common_local_url('shownotice', array('notice' => $notice->id));
318 $this->elementStart('entry');
320 $taguribase = common_config('integration', 'taguri');
322 $this->element('id', null, "tag:$taguribase:$notice->id");
323 $this->element('published', null, common_date_w3dtf($notice->created));
324 $this->element('link', array('type' => 'text/html',
325 'rel' => 'alternate',
327 $this->element('title', null, common_xml_safe_str(trim($notice->content)));
328 $this->element('content', array('type' => 'html'), $notice->rendered);
329 $this->element('updated', null, common_date_w3dtf($notice->created));
330 $this->element('link', array('type' => 'image/png',
331 // XXX: Twitter uses rel="image" (not valid)
333 'href' => $profile->avatarUrl()));
335 // TODO: Here is where we'd put in a link to an atom feed for threads
337 $this->element("twitter:source", null,
338 htmlentities($this->source_link($notice->source)));
340 $this->elementStart('author');
342 $name = $profile->nickname;
344 if ($profile->fullname) {
345 $name .= ' (' . $profile->fullname . ')';
348 $this->element('name', null, $name);
349 $this->element('uri', null, common_profile_uri($profile));
350 $this->elementEnd('author');
352 $this->elementEnd('entry');
356 * Initialize the Atom output, send headers
363 header('Content-Type: application/atom+xml; charset=utf-8');
375 $this->elementEnd('feed');