]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apisearchjson.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / 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 class ApiSearchJSONAction extends ApiPrivateAuthAction
48 {
49     var $query;
50     var $lang;
51     var $rpp;
52     var $page;
53     var $since_id;
54     var $limit;
55     var $geocode;
56
57     /**
58      * Initialization.
59      *
60      * @param array $args Web and URL arguments
61      *
62      * @return boolean true if nothing goes wrong
63      */
64     function prepare($args)
65     {
66         common_debug("apisearchjson prepare()");
67
68         parent::prepare($args);
69
70         $this->query = $this->trimmed('q');
71         $this->lang  = $this->trimmed('lang');
72         $this->rpp   = $this->trimmed('rpp');
73
74         if (!$this->rpp) {
75             $this->rpp = 15;
76         }
77
78         if ($this->rpp > 100) {
79             $this->rpp = 100;
80         }
81
82         $this->page = $this->trimmed('page');
83
84         if (!$this->page) {
85             $this->page = 1;
86         }
87
88         $this->since_id = $this->trimmed('since_id');
89         $this->geocode  = $this->trimmed('geocode');
90
91         return true;
92     }
93
94     /**
95      * Handle a request
96      *
97      * @param array $args Arguments from $_REQUEST
98      *
99      * @return void
100      */
101     function handle($args)
102     {
103         parent::handle($args);
104         $this->showResults();
105     }
106
107     /**
108      * Show search results
109      *
110      * @return void
111      */
112     function showResults()
113     {
114         // TODO: Support search operators like from: and to:, boolean, etc.
115
116         $notice = new Notice();
117
118         // lcase it for comparison
119         $q = strtolower($this->query);
120
121         $search_engine = $notice->getSearchEngine('notice');
122         $search_engine->set_sort_mode('chron');
123         $search_engine->limit(($this->page - 1) * $this->rpp, $this->rpp + 1, true);
124         if (false === $search_engine->query($q)) {
125             $cnt = 0;
126         } else {
127             $cnt = $notice->find();
128         }
129
130         // TODO: since_id, lang, geocode
131
132         $results = new JSONSearchResultsList($notice, $q, $this->rpp, $this->page);
133
134         $this->initDocument('json');
135         $results->show();
136         $this->endDocument('json');
137     }
138
139     /**
140      * Do we need to write to the database?
141      *
142      * @return boolean true
143      */
144     function isReadOnly($args)
145     {
146         return true;
147     }
148 }