3 * StatusNet, 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@status.net>
25 * @copyright 2008-2009 StatusNet, Inc.
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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 require_once INSTALLDIR.'/lib/api.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@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
52 class TwitapisearchatomAction extends ApiAction
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=null)
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('notice');
165 $search_engine->set_sort_mode('chron');
166 $search_engine->limit(($this->page - 1) * $this->rpp,
167 $this->rpp + 1, true);
168 if (false === $search_engine->query($q)) {
171 $this->cnt = $notice->find();
177 if ($this->cnt > 0) {
178 while ($notice->fetch()) {
182 if (!$this->max_id) {
183 $this->max_id = $notice->id;
186 if ($cnt > $this->rpp) {
190 $notices[] = clone($notice);
198 * Output search results as an Atom feed
205 $notices = $this->getNotices();
210 foreach ($notices as $n) {
212 $profile = $n->getProfile();
214 // Don't show notices from deleted users
216 if (!empty($profile)) {
217 $this->showEntry($n);
225 * Show feed specific Atom elements
232 // TODO: A9 OpenSearch stuff like search.twitter.com?
234 $server = common_config('site', 'server');
235 $sitename = common_config('site', 'name');
237 // XXX: Use xmlns:statusnet instead?
239 $this->elementStart('feed',
240 array('xmlns' => 'http://www.w3.org/2005/Atom',
242 // XXX: xmlns:twitter causes Atom validation to fail
243 // It's used for the source attr on notices
245 'xmlns:twitter' => 'http://api.twitter.com/',
246 'xml:lang' => 'en-US')); // XXX Other locales ?
248 $taguribase = common_config('integration', 'taguri');
249 $this->element('id', null, "tag:$taguribase:search/$server");
251 $site_uri = common_path(false);
253 $search_uri = $site_uri . 'api/search.atom?q=' . urlencode($this->query);
255 if ($this->rpp != 15) {
256 $search_uri .= '&rpp=' . $this->rpp;
259 // FIXME: this alternate link is not quite right because our
260 // web-based notice search doesn't support a rpp (responses per
263 $this->element('link', array('type' => 'text/html',
264 'rel' => 'alternate',
265 'href' => $site_uri . 'search/notice?q=' .
266 urlencode($this->query)));
270 $self_uri = $search_uri;
271 $self_uri .= ($this->page > 1) ? '&page=' . $this->page : '';
273 $this->element('link', array('type' => 'application/atom+xml',
275 'href' => $self_uri));
277 $this->element('title', null, "$this->query - $sitename Search");
278 $this->element('updated', null, common_date_iso8601('now'));
280 // XXX: The below "rel" links are not valid Atom, but it's what
285 $refresh_uri = $search_uri . "&since_id=" . $this->max_id;
287 $this->element('link', array('type' => 'application/atom+xml',
289 'href' => $refresh_uri));
293 if ($this->cnt > $this->rpp) {
295 $next_uri = $search_uri . "&max_id=" . $this->max_id .
296 '&page=' . ($this->page + 1);
298 $this->element('link', array('type' => 'application/atom+xml',
300 'href' => $next_uri));
303 if ($this->page > 1) {
305 $previous_uri = $search_uri . "&max_id=" . $this->max_id .
306 '&page=' . ($this->page - 1);
308 $this->element('link', array('type' => 'application/atom+xml',
310 'href' => $previous_uri));
316 * Build an Atom entry similar to search.twitter.com's based on
319 * @param Notice $notice the notice to use
324 function showEntry($notice)
326 $server = common_config('site', 'server');
327 $profile = $notice->getProfile();
328 $nurl = common_local_url('shownotice', array('notice' => $notice->id));
330 $this->elementStart('entry');
332 $taguribase = common_config('integration', 'taguri');
334 $this->element('id', null, "tag:$taguribase:$notice->id");
335 $this->element('published', null, common_date_w3dtf($notice->created));
336 $this->element('link', array('type' => 'text/html',
337 'rel' => 'alternate',
339 $this->element('title', null, common_xml_safe_str(trim($notice->content)));
340 $this->element('content', array('type' => 'html'), $notice->rendered);
341 $this->element('updated', null, common_date_w3dtf($notice->created));
342 $this->element('link', array('type' => 'image/png',
343 // XXX: Twitter uses rel="image" (not valid)
345 'href' => $profile->avatarUrl()));
347 // TODO: Here is where we'd put in a link to an atom feed for threads
349 $this->element("twitter:source", null,
350 htmlentities($this->sourceLink($notice->source)));
352 $this->elementStart('author');
354 $name = $profile->nickname;
356 if ($profile->fullname) {
357 $name .= ' (' . $profile->fullname . ')';
360 $this->element('name', null, $name);
361 $this->element('uri', null, common_profile_uri($profile));
362 $this->elementEnd('author');
364 $this->elementEnd('entry');
368 * Initialize the Atom output, send headers
375 header('Content-Type: application/atom+xml; charset=utf-8');
387 $this->elementEnd('feed');