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         if (false === $search_engine->query($q)) {
 169             $this->cnt = 0;
 170         } else {
 171             $this->cnt = $notice->find();
 172         }
 173
 174         $cnt = 0;
 175
 176         if ($this->cnt > 0) {
 177             while ($notice->fetch()) {
 178
 179                 ++$cnt;
 180
 181                 if (!$this->max_id) {
 182                     $this->max_id = $notice->id;
 183                 }
 184
 185                 if ($cnt > $this->rpp) {
 186                     break;
 187                 }
 188
 189                 $notices[] = clone($notice);
 190             }
 191         }
 192
 193         return $notices;
 194     }
 195
 196     /**
 197      * Output search results as an Atom feed
 198      *
 199      * @return void
 200      */
 201
 202     function showAtom()
 203     {
 204         $notices = $this->getNotices();
 205
 206         $this->initAtom();
 207         $this->showFeed();
 208
 209         foreach ($notices as $n) {
 210             $this->showEntry($n);
 211         }
 212
 213         $this->endAtom();
 214     }
 215
 216     /**
 217      * Show feed specific Atom elements
 218      *
 219      * @return void
 220      */
 221
 222     function showFeed()
 223     {
 224         // TODO: A9 OpenSearch stuff like search.twitter.com?
 225
 226         $server   = common_config('site', 'server');
 227         $sitename = common_config('site', 'name');
 228
 229         // XXX: Use xmlns:laconica instead?
 230
 231         $this->elementStart('feed',
 232             array('xmlns' => 'http://www.w3.org/2005/Atom',
 233
 234                              // XXX: xmlns:twitter causes Atom validation to fail
 235                              // It's used for the source attr on notices
 236
 237                              'xmlns:twitter' => 'http://api.twitter.com/',
 238                              'xml:lang' => 'en-US')); // XXX Other locales ?
 239
 240         $taguribase = common_config('integration', 'taguri');
 241         $this->element('id', null, "tag:$taguribase:search/$server");
 242
 243         $site_uri = common_path(false);
 244
 245         $search_uri = $site_uri . 'api/search.atom?q=' . urlencode($this->query);
 246
 247         if ($this->rpp != 15) {
 248             $search_uri .= '&rpp=' . $this->rpp;
 249         }
 250
 251         // FIXME: this alternate link is not quite right because our
 252         // web-based notice search doesn't support a rpp (responses per
 253         // page) param yet
 254
 255         $this->element('link', array('type' => 'text/html',
 256                                      'rel'  => 'alternate',
 257                                      'href' => $site_uri . 'search/notice?q=' .
 258                                         urlencode($this->query)));
 259
 260         // self link
 261
 262         $self_uri = $search_uri;
 263         $self_uri .= ($this->page > 1) ? '&page=' . $this->page : '';
 264
 265         $this->element('link', array('type' => 'application/atom+xml',
 266                                      'rel'  => 'self',
 267                                      'href' => $self_uri));
 268
 269         $this->element('title', null, "$this->query - $sitename Search");
 270         $this->element('updated', null, common_date_iso8601('now'));
 271
 272         // XXX: The below "rel" links are not valid Atom, but it's what
 273         // Twitter does...
 274
 275         // refresh link
 276
 277         $refresh_uri = $search_uri . "&since_id=" . $this->max_id;
 278
 279         $this->element('link', array('type' => 'application/atom+xml',
 280                                      'rel'  => 'refresh',
 281                                      'href' => $refresh_uri));
 282
 283         // pagination links
 284
 285         if ($this->cnt > $this->rpp) {
 286
 287             $next_uri = $search_uri . "&max_id=" . $this->max_id .
 288                 '&page=' . ($this->page + 1);
 289
 290             $this->element('link', array('type' => 'application/atom+xml',
 291                                          'rel'  => 'next',
 292                                          'href' => $next_uri));
 293         }
 294
 295         if ($this->page > 1) {
 296
 297             $previous_uri = $search_uri . "&max_id=" . $this->max_id .
 298                 '&page=' . ($this->page - 1);
 299
 300             $this->element('link', array('type' => 'application/atom+xml',
 301                                          'rel'  => 'previous',
 302                                          'href' => $previous_uri));
 303         }
 304
 305     }
 306
 307     /**
 308      * Build an Atom entry similar to search.twitter.com's based on
 309      * a given notice
 310      *
 311      * @param Notice $notice the notice to use
 312      *
 313      * @return void
 314      */
 315
 316     function showEntry($notice)
 317     {
 318         $server  = common_config('site', 'server');
 319         $profile = $notice->getProfile();
 320         $nurl    = common_local_url('shownotice', array('notice' => $notice->id));
 321
 322         $this->elementStart('entry');
 323
 324         $taguribase = common_config('integration', 'taguri');
 325
 326         $this->element('id', null, "tag:$taguribase:$notice->id");
 327         $this->element('published', null, common_date_w3dtf($notice->created));
 328         $this->element('link', array('type' => 'text/html',
 329                                      'rel'  => 'alternate',
 330                                      'href' => $nurl));
 331         $this->element('title', null, common_xml_safe_str(trim($notice->content)));
 332         $this->element('content', array('type' => 'html'), $notice->rendered);
 333         $this->element('updated', null, common_date_w3dtf($notice->created));
 334         $this->element('link', array('type' => 'image/png',
 335                                      // XXX: Twitter uses rel="image" (not valid)
 336                                      'rel' => 'related',
 337                                      'href' => $profile->avatarUrl()));
 338
 339         // TODO: Here is where we'd put in a link to an atom feed for threads
 340
 341         $this->element("twitter:source", null,
 342             htmlentities($this->source_link($notice->source)));
 343
 344         $this->elementStart('author');
 345
 346         $name = $profile->nickname;
 347
 348         if ($profile->fullname) {
 349             $name .= ' (' . $profile->fullname . ')';
 350         }
 351
 352         $this->element('name', null, $name);
 353         $this->element('uri', null, common_profile_uri($profile));
 354         $this->elementEnd('author');
 355
 356         $this->elementEnd('entry');
 357     }
 358
 359     /**
 360      * Initialize the Atom output, send headers
 361      *
 362      * @return void
 363      */
 364
 365     function initAtom()
 366     {
 367         header('Content-Type: application/atom+xml; charset=utf-8');
 368         $this->startXml();
 369     }
 370
 371     /**
 372      * End the Atom feed
 373      *
 374      * @return void
 375      */
 376
 377     function endAtom()
 378     {
 379         $this->elementEnd('feed');
 380     }
 381
 382 }