actions/apisearchjson.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Action for showing Twitter-like JSON 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   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2008-2010 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/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/apiprivateauth.php';
  35 require_once INSTALLDIR.'/lib/jsonsearchresultslist.php';
  36
  37 /**
  38  * Action handler for Twitter-compatible API search
  39  *
  40  * @category Search
  41  * @package  StatusNet
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  * @see      ApiAction
  46  */
  47
  48 class ApiSearchJSONAction extends ApiPrivateAuthAction
  49 {
  50     var $query;
  51     var $lang;
  52     var $rpp;
  53     var $page;
  54     var $since_id;
  55     var $limit;
  56     var $geocode;
  57
  58     /**
  59      * Initialization.
  60      *
  61      * @param array $args Web and URL arguments
  62      *
  63      * @return boolean true if nothing goes wrong
  64      */
  65
  66     function prepare($args)
  67     {
  68         common_debug("apisearchjson prepare()");
  69
  70         parent::prepare($args);
  71
  72         $this->query = $this->trimmed('q');
  73         $this->lang  = $this->trimmed('lang');
  74         $this->rpp   = $this->trimmed('rpp');
  75
  76         if (!$this->rpp) {
  77             $this->rpp = 15;
  78         }
  79
  80         if ($this->rpp > 100) {
  81             $this->rpp = 100;
  82         }
  83
  84         $this->page = $this->trimmed('page');
  85
  86         if (!$this->page) {
  87             $this->page = 1;
  88         }
  89
  90         $this->since_id = $this->trimmed('since_id');
  91         $this->geocode  = $this->trimmed('geocode');
  92
  93         return true;
  94     }
  95
  96     /**
  97      * Handle a request
  98      *
  99      * @param array $args Arguments from $_REQUEST
 100      *
 101      * @return void
 102      */
 103
 104     function handle($args)
 105     {
 106         parent::handle($args);
 107         $this->showResults();
 108     }
 109
 110     /**
 111      * Show search results
 112      *
 113      * @return void
 114      */
 115
 116     function showResults()
 117     {
 118
 119         // TODO: Support search operators like from: and to:, boolean, etc.
 120
 121         $notice = new Notice();
 122
 123         // lcase it for comparison
 124         $q = strtolower($this->query);
 125
 126         $search_engine = $notice->getSearchEngine('notice');
 127         $search_engine->set_sort_mode('chron');
 128         $search_engine->limit(($this->page - 1) * $this->rpp, $this->rpp + 1, true);
 129         if (false === $search_engine->query($q)) {
 130             $cnt = 0;
 131         } else {
 132             $cnt = $notice->find();
 133         }
 134
 135         // TODO: since_id, lang, geocode
 136
 137         $results = new JSONSearchResultsList($notice, $q, $this->rpp, $this->page);
 138
 139         $this->initDocument('json');
 140         $results->show();
 141         $this->endDocument('json');
 142     }
 143
 144     /**
 145      * Do we need to write to the database?
 146      *
 147      * @return boolean true
 148      */
 149
 150     function isReadOnly($args)
 151     {
 152         return true;
 153     }
 154 }