]>
git.wh0rd.org - tt-rss.git/blob - classes/api.php
3 class API
extends Handler
{
12 function before($method) {
13 if (parent
::before($method)) {
15 if (!$_SESSION["uid"] && $method != "login" && $method != "isloggedin") {
16 print $this->wrap(self
::STATUS_ERR
, array("error" => 'NOT_LOGGED_IN'));
20 if ($_SESSION["uid"] && $method != "logout" && !get_pref($this->link
, 'ENABLE_API_ACCESS')) {
21 print $this->wrap(self
::STATUS_ERR
, array("error" => 'API_DISABLED'));
25 $this->seq
= (int) $_REQUEST['seq'];
27 header("Content-Type: text/plain");
33 function wrap($status, $reply) {
34 print json_encode(array("seq" => $this->seq
,
36 "content" => $reply));
39 function getVersion() {
40 $rv = array("version" => VERSION
);
41 print $this->wrap(self
::STATUS_OK
, $rv);
44 function getApiLevel() {
45 $rv = array("level" => self
::API_LEVEL
);
46 print $this->wrap(self
::STATUS_OK
, $rv);
50 $login = db_escape_string($_REQUEST["user"]);
51 $password = $_REQUEST["password"];
52 $password_base64 = base64_decode($_REQUEST["password"]);
54 if (SINGLE_USER_MODE
) $login = "admin";
56 $result = db_query($this->link
, "SELECT id FROM ttrss_users WHERE login = '$login'");
58 if (db_num_rows($result) != 0) {
59 $uid = db_fetch_result($result, 0, "id");
65 print $this->wrap(self
::STATUS_ERR
, array("error" => "LOGIN_ERROR"));
69 if (get_pref($this->link
, "ENABLE_API_ACCESS", $uid)) {
70 if (authenticate_user($this->link
, $login, $password)) { // try login with normal password
71 print $this->wrap(self
::STATUS_OK
, array("session_id" => session_id()));
72 } else if (authenticate_user($this->link
, $login, $password_base64)) { // else try with base64_decoded password
73 print $this->wrap(self
::STATUS_OK
, array("session_id" => session_id()));
74 } else { // else we are not logged in
75 print $this->wrap(self
::STATUS_ERR
, array("error" => "LOGIN_ERROR"));
78 print $this->wrap(self
::STATUS_ERR
, array("error" => "API_DISABLED"));
85 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
88 function isLoggedIn() {
89 print $this->wrap(self
::STATUS_OK
, array("status" => $_SESSION["uid"] != ''));
92 function getUnread() {
93 $feed_id = db_escape_string($_REQUEST["feed_id"]);
94 $is_cat = db_escape_string($_REQUEST["is_cat"]);
97 print $this->wrap(self
::STATUS_OK
, array("unread" => getFeedUnread($this->link
, $feed_id, $is_cat)));
99 print $this->wrap(self
::STATUS_OK
, array("unread" => getGlobalUnread($this->link
)));
103 /* Method added for ttrss-reader for Android */
104 function getCounters() {
106 /* flct (flc is the default) FIXME: document */
107 $output_mode = db_escape_string($_REQUEST["output_mode"]);
109 print $this->wrap(self
::STATUS_OK
, getAllCounters($this->link
, $output_mode));
112 function getFeeds() {
113 $cat_id = db_escape_string($_REQUEST["cat_id"]);
114 $unread_only = (bool)db_escape_string($_REQUEST["unread_only"]);
115 $limit = (int) db_escape_string($_REQUEST["limit"]);
116 $offset = (int) db_escape_string($_REQUEST["offset"]);
118 $feeds = api_get_feeds($this->link
, $cat_id, $unread_only, $limit, $offset);
120 print $this->wrap(self
::STATUS_OK
, $feeds);
123 function getCategories() {
124 $unread_only = (bool)db_escape_string($_REQUEST["unread_only"]);
126 // TODO do not return empty categories, return Uncategorized and standard virtual cats
128 $result = db_query($this->link
, "SELECT
129 id, title FROM ttrss_feed_categories
130 WHERE owner_uid = " .
135 while ($line = db_fetch_assoc($result)) {
136 $unread = getFeedUnread($this->link
, $line["id"], true);
138 if ($unread ||
!$unread_only) {
139 array_push($cats, array("id" => $line["id"],
140 "title" => $line["title"],
141 "unread" => $unread));
145 foreach (array(-2,-1,0) as $cat_id) {
146 $unread = getFeedUnread($this->link
, $cat_id, true);
148 if ($unread ||
!$unread_only) {
149 array_push($cats, array("id" => $cat_id,
150 "title" => getCategoryTitle($this->link
, $cat_id),
151 "unread" => $unread));
155 print $this->wrap(self
::STATUS_OK
, $cats);
158 function getHeadlines() {
159 $feed_id = db_escape_string($_REQUEST["feed_id"]);
160 if ($feed_id != "") {
162 $limit = (int)db_escape_string($_REQUEST["limit"]);
163 $offset = (int)db_escape_string($_REQUEST["skip"]);
164 $filter = db_escape_string($_REQUEST["filter"]);
165 $is_cat = (bool)db_escape_string($_REQUEST["is_cat"]);
166 $show_excerpt = (bool)db_escape_string($_REQUEST["show_excerpt"]);
167 $show_content = (bool)db_escape_string($_REQUEST["show_content"]);
168 /* all_articles, unread, adaptive, marked, updated */
169 $view_mode = db_escape_string($_REQUEST["view_mode"]);
170 $include_attachments = (bool)db_escape_string($_REQUEST["include_attachments"]);
171 $since_id = (int)db_escape_string($_REQUEST["since_id"]);
173 /* do not rely on params below */
175 $search = db_escape_string($_REQUEST["search"]);
176 $search_mode = db_escape_string($_REQUEST["search_mode"]);
177 $match_on = db_escape_string($_REQUEST["match_on"]);
179 $headlines = api_get_headlines($this->link
, $feed_id, $limit, $offset,
180 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, false,
181 $include_attachments, $since_id, $search, $search_mode, $match_on);
183 print $this->wrap(self
::STATUS_OK
, $headlines);
185 print $this->wrap(self
::STATUS_ERR
, array("error" => 'INCORRECT_USAGE'));
189 function updateArticle() {
190 $article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric
);
191 $mode = (int) db_escape_string($_REQUEST["mode"]);
192 $data = db_escape_string($_REQUEST["data"]);
193 $field_raw = (int)db_escape_string($_REQUEST["field"]);
198 switch ($field_raw) {
203 $field = "published";
220 $set_to = "NOT $field";
224 if ($field == "note") $set_to = "'$data'";
226 if ($field && $set_to && count($article_ids) > 0) {
228 $article_ids = join(", ", $article_ids);
230 if ($field == "unread") {
231 $result = db_query($this->link
, "UPDATE ttrss_user_entries SET $field = $set_to,
233 WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
235 $result = db_query($this->link
, "UPDATE ttrss_user_entries SET $field = $set_to
236 WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
239 $num_updated = db_affected_rows($this->link
, $result);
241 if ($num_updated > 0 && $field == "unread") {
242 $result = db_query($this->link
, "SELECT DISTINCT feed_id FROM ttrss_user_entries
243 WHERE ref_id IN ($article_ids)");
245 while ($line = db_fetch_assoc($result)) {
246 ccache_update($this->link
, $line["feed_id"], $_SESSION["uid"]);
250 print $this->wrap(self
::STATUS_OK
, array("status" => "OK",
251 "updated" => $num_updated));
254 print $this->wrap(self
::STATUS_ERR
, array("error" => 'INCORRECT_USAGE'));
259 function getArticle() {
261 $article_id = join(",", array_filter(explode(",", db_escape_string($_REQUEST["article_id"])), is_numeric
));
263 $query = "SELECT id,title,link,content,feed_id,comments,int_id,
264 marked,unread,published,
265 ".SUBSTRING_FOR_DATE
."(updated,1,16) as updated,
267 FROM ttrss_entries,ttrss_user_entries
268 WHERE id IN ($article_id) AND ref_id = id AND owner_uid = " .
271 $result = db_query($this->link
, $query);
275 if (db_num_rows($result) != 0) {
277 while ($line = db_fetch_assoc($result)) {
279 $attachments = get_article_enclosures($this->link
, $line['id']);
283 "title" => $line["title"],
284 "link" => $line["link"],
285 "labels" => get_article_labels($this->link
, $line['id']),
286 "unread" => sql_bool_to_bool($line["unread"]),
287 "marked" => sql_bool_to_bool($line["marked"]),
288 "published" => sql_bool_to_bool($line["published"]),
289 "comments" => $line["comments"],
290 "author" => $line["author"],
291 "updated" => strtotime($line["updated"]),
292 "content" => $line["content"],
293 "feed_id" => $line["feed_id"],
294 "attachments" => $attachments
297 array_push($articles, $article);
302 print $this->wrap(self
::STATUS_OK
, $articles);
306 function getConfig() {
308 "icons_dir" => ICONS_DIR
,
309 "icons_url" => ICONS_URL
);
311 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
313 $result = db_query($this->link
, "SELECT COUNT(*) AS cf FROM
314 ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
316 $num_feeds = db_fetch_result($result, 0, "cf");
318 $config["num_feeds"] = (int)$num_feeds;
320 print $this->wrap(self
::STATUS_OK
, $config);
323 function updateFeed() {
324 $feed_id = db_escape_string($_REQUEST["feed_id"]);
326 update_rss_feed($this->link
, $feed_id, true);
328 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
331 function catchupFeed() {
332 $feed_id = db_escape_string($_REQUEST["feed_id"]);
333 $is_cat = db_escape_string($_REQUEST["is_cat"]);
335 catchup_feed($this->link
, $feed_id, $is_cat);
337 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
341 $pref_name = db_escape_string($_REQUEST["pref_name"]);
343 print $this->wrap(self
::STATUS_OK
, array("value" => get_pref($this->link
, $pref_name)));
346 function getLabels() {
347 //$article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric);
349 $article_id = (int)$_REQUEST['article_id'];
353 $result = db_query($this->link
, "SELECT id, caption, fg_color, bg_color
355 WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
358 $article_labels = get_article_labels($this->link
, $article_id);
360 $article_labels = array();
362 while ($line = db_fetch_assoc($result)) {
365 foreach ($article_labels as $al) {
366 if ($al[0] == $line['id']) {
372 array_push($rv, array(
373 "id" => (int)$line['id'],
374 "caption" => $line['caption'],
375 "fg_color" => $line['fg_color'],
376 "bg_color" => $line['bg_color'],
377 "checked" => $checked));
380 print $this->wrap(self
::STATUS_OK
, $rv);
383 function setArticleLabel() {
385 $article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric
);
386 $label_id = (int) db_escape_string($_REQUEST['label_id']);
387 $assign = (bool) db_escape_string($_REQUEST['assign']) == "true";
389 $label = db_escape_string(label_find_caption($this->link
,
390 $label_id, $_SESSION["uid"]));
396 foreach ($article_ids as $id) {
399 label_add_article($this->link
, $id, $label, $_SESSION["uid"]);
401 label_remove_article($this->link
, $id, $label, $_SESSION["uid"]);
408 print $this->wrap(self
::STATUS_OK
, array("status" => "OK",
409 "updated" => $num_updated));
414 print $this->wrap(self
::STATUS_ERR
, array("error" => 'UNKNOWN_METHOD'));