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   GNUsocial
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2008-2010 StatusNet, Inc.
  26  * @copyright 2013 Free Software Foundation, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://www.gnu.org/software/social/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * Action handler for Twitter-compatible API search
  35  *
  36  * @category Search
  37  * @package  StatusNet
  38  * @author   Zach Copley <zach@status.net>
  39  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  40  * @link     http://status.net/
  41  * @see      ApiAction
  42  */
  43 class ApiSearchJSONAction extends ApiPrivateAuthAction
  44 {
  45     var $query;
  46     var $lang;
  47     var $rpp;
  48     var $page;
  49     var $since_id;
  50     var $limit;
  51     var $geocode;
  52
  53     /**
  54      * Initialization.
  55      *
  56      * @param array $args Web and URL arguments
  57      *
  58      * @return boolean true if nothing goes wrong
  59      */
  60     function prepare($args)
  61     {
  62         parent::prepare($args);
  63
  64         $this->query = $this->trimmed('q');
  65         $this->lang  = $this->trimmed('lang');
  66         $this->rpp   = $this->trimmed('rpp');
  67
  68         if (!$this->rpp) {
  69             $this->rpp = 15;
  70         }
  71
  72         if ($this->rpp > 100) {
  73             $this->rpp = 100;
  74         }
  75
  76         $this->page = $this->trimmed('page');
  77
  78         if (!$this->page) {
  79             $this->page = 1;
  80         }
  81
  82         // TODO: Suppport max_id -- we need to tweak the backend
  83         // Search classes to support it.
  84
  85         $this->since_id = $this->trimmed('since_id');
  86         $this->geocode  = $this->trimmed('geocode');
  87
  88         return true;
  89     }
  90
  91     /**
  92      * Handle a request
  93      *
  94      * @param array $args Arguments from $_REQUEST
  95      *
  96      * @return void
  97      */
  98     function handle($args)
  99     {
 100         parent::handle($args);
 101         $this->showResults();
 102     }
 103
 104     /**
 105      * Show search results
 106      *
 107      * @return void
 108      */
 109     function showResults()
 110     {
 111         // TODO: Support search operators like from: and to:, boolean, etc.
 112
 113         $notice = new Notice();
 114
 115         $this->notices = array();
 116         $search_engine = $notice->getSearchEngine('notice');
 117         $search_engine->set_sort_mode('chron');
 118         $search_engine->limit(($this->page - 1) * $this->rpp, $this->rpp + 1);
 119         if ($search_engine->query($this->query)) {
 120             $cnt = $notice->find();
 121             $this->notices = $notice->fetchAll();
 122         }
 123
 124        $this->showJsonTimeline($this->notices);
 125     }
 126
 127     /**
 128      * Do we need to write to the database?
 129      *
 130      * @return boolean true
 131      */
 132     function isReadOnly($args)
 133     {
 134         return true;
 135     }
 136 }