3 class API extends Handler {
12 function before($method) {
13 if (parent::before($method)) {
14 header("Content-Type: text/json");
16 if (!$_SESSION["uid"] && $method != "login" && $method != "isloggedin") {
17 $this->wrap(self::STATUS_ERR, array("error" => 'NOT_LOGGED_IN'));
21 if ($_SESSION["uid"] && $method != "logout" && !get_pref('ENABLE_API_ACCESS')) {
22 $this->wrap(self::STATUS_ERR, array("error" => 'API_DISABLED'));
26 $this->seq = (int) $_REQUEST['seq'];
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 $this->wrap(self::STATUS_OK, $rv);
44 function getApiLevel() {
45 $rv = array("level" => self::API_LEVEL);
46 $this->wrap(self::STATUS_OK, $rv);
53 $login = $this->dbh->escape_string($_REQUEST["user"]);
54 $password = $_REQUEST["password"];
55 $password_base64 = base64_decode($_REQUEST["password"]);
57 if (SINGLE_USER_MODE) $login = "admin";
59 $result = $this->dbh->query("SELECT id FROM ttrss_users WHERE login = '$login'");
61 if ($this->dbh->num_rows($result) != 0) {
62 $uid = $this->dbh->fetch_result($result, 0, "id");
68 $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
72 if (get_pref("ENABLE_API_ACCESS", $uid)) {
73 if (authenticate_user($login, $password)) { // try login with normal password
74 $this->wrap(self::STATUS_OK, array("session_id" => session_id(),
75 "api_level" => self::API_LEVEL));
76 } else if (authenticate_user($login, $password_base64)) { // else try with base64_decoded password
77 $this->wrap(self::STATUS_OK, array("session_id" => session_id(),
78 "api_level" => self::API_LEVEL));
79 } else { // else we are not logged in
80 $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
83 $this->wrap(self::STATUS_ERR, array("error" => "API_DISABLED"));
90 $this->wrap(self::STATUS_OK, array("status" => "OK"));
93 function isLoggedIn() {
94 $this->wrap(self::STATUS_OK, array("status" => $_SESSION["uid"] != ''));
97 function getUnread() {
98 $feed_id = $this->dbh->escape_string($_REQUEST["feed_id"]);
99 $is_cat = $this->dbh->escape_string($_REQUEST["is_cat"]);
102 $this->wrap(self::STATUS_OK, array("unread" => getFeedUnread($feed_id, $is_cat)));
104 $this->wrap(self::STATUS_OK, array("unread" => getGlobalUnread()));
108 /* Method added for ttrss-reader for Android */
109 function getCounters() {
110 $this->wrap(self::STATUS_OK, getAllCounters());
113 function getFeeds() {
114 $cat_id = $this->dbh->escape_string($_REQUEST["cat_id"]);
115 $unread_only = sql_bool_to_bool($_REQUEST["unread_only"]);
116 $limit = (int) $this->dbh->escape_string($_REQUEST["limit"]);
117 $offset = (int) $this->dbh->escape_string($_REQUEST["offset"]);
118 $include_nested = sql_bool_to_bool($_REQUEST["include_nested"]);
120 $feeds = $this->api_get_feeds($cat_id, $unread_only, $limit, $offset, $include_nested);
122 $this->wrap(self::STATUS_OK, $feeds);
125 function getCategories() {
126 $unread_only = sql_bool_to_bool($_REQUEST["unread_only"]);
127 $enable_nested = sql_bool_to_bool($_REQUEST["enable_nested"]);
128 $include_empty = sql_bool_to_bool($_REQUEST['include_empty']);
130 // TODO do not return empty categories, return Uncategorized and standard virtual cats
133 $nested_qpart = "parent_cat IS NULL";
135 $nested_qpart = "true";
137 $result = $this->dbh->query("SELECT
138 id, title, order_id, (SELECT COUNT(id) FROM
140 ttrss_feed_categories.id IS NOT NULL AND cat_id = ttrss_feed_categories.id) AS num_feeds,
141 (SELECT COUNT(id) FROM
142 ttrss_feed_categories AS c2 WHERE
143 c2.parent_cat = ttrss_feed_categories.id) AS num_cats
144 FROM ttrss_feed_categories
145 WHERE $nested_qpart AND owner_uid = " .
150 while ($line = $this->dbh->fetch_assoc($result)) {
151 if ($include_empty || $line["num_feeds"] > 0 || $line["num_cats"] > 0) {
152 $unread = getFeedUnread($line["id"], true);
155 $unread += getCategoryChildrenUnread($line["id"]);
157 if ($unread || !$unread_only) {
158 array_push($cats, array("id" => $line["id"],
159 "title" => $line["title"],
161 "order_id" => (int) $line["order_id"],
167 foreach (array(-2,-1,0) as $cat_id) {
168 if ($include_empty || !$this->isCategoryEmpty($cat_id)) {
169 $unread = getFeedUnread($cat_id, true);
171 if ($unread || !$unread_only) {
172 array_push($cats, array("id" => $cat_id,
173 "title" => getCategoryTitle($cat_id),
174 "unread" => $unread));
179 $this->wrap(self::STATUS_OK, $cats);
182 function getHeadlines() {
183 $feed_id = $this->dbh->escape_string($_REQUEST["feed_id"]);
184 if ($feed_id != "") {
186 $limit = (int)$this->dbh->escape_string($_REQUEST["limit"]);
188 if (!$limit || $limit >= 200) $limit = 200;
190 $offset = (int)$this->dbh->escape_string($_REQUEST["skip"]);
191 $filter = $this->dbh->escape_string($_REQUEST["filter"]);
192 $is_cat = sql_bool_to_bool($_REQUEST["is_cat"]);
193 $show_excerpt = sql_bool_to_bool($_REQUEST["show_excerpt"]);
194 $show_content = sql_bool_to_bool($_REQUEST["show_content"]);
195 /* all_articles, unread, adaptive, marked, updated */
196 $view_mode = $this->dbh->escape_string($_REQUEST["view_mode"]);
197 $include_attachments = sql_bool_to_bool($_REQUEST["include_attachments"]);
198 $since_id = (int)$this->dbh->escape_string($_REQUEST["since_id"]);
199 $include_nested = sql_bool_to_bool($_REQUEST["include_nested"]);
200 $sanitize_content = !isset($_REQUEST["sanitize"]) ||
201 sql_bool_to_bool($_REQUEST["sanitize"]);
203 $override_order = false;
204 switch ($_REQUEST["order_by"]) {
206 $override_order = "ttrss_entries.title";
209 $override_order = "score DESC, date_entered, updated";
212 $override_order = "updated DESC";
216 /* do not rely on params below */
218 $search = $this->dbh->escape_string($_REQUEST["search"]);
219 $search_mode = $this->dbh->escape_string($_REQUEST["search_mode"]);
221 $headlines = $this->api_get_headlines($feed_id, $limit, $offset,
222 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $override_order,
223 $include_attachments, $since_id, $search, $search_mode,
224 $include_nested, $sanitize_content);
226 $this->wrap(self::STATUS_OK, $headlines);
228 $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
232 function updateArticle() {
233 $article_ids = array_filter(explode(",", $this->dbh->escape_string($_REQUEST["article_ids"])), is_numeric);
234 $mode = (int) $this->dbh->escape_string($_REQUEST["mode"]);
235 $data = $this->dbh->escape_string($_REQUEST["data"]);
236 $field_raw = (int)$this->dbh->escape_string($_REQUEST["field"]);
241 switch ($field_raw) {
244 $additional_fields = ",last_marked = NOW()";
247 $field = "published";
248 $additional_fields = ",last_published = NOW()";
252 $additional_fields = ",last_read = NOW()";
266 $set_to = "NOT $field";
270 if ($field == "note") $set_to = "'$data'";
272 if ($field && $set_to && count($article_ids) > 0) {
274 $article_ids = join(", ", $article_ids);
276 $result = $this->dbh->query("UPDATE ttrss_user_entries SET $field = $set_to $additional_fields WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
278 $num_updated = $this->dbh->affected_rows($result);
280 if ($num_updated > 0 && $field == "unread") {
281 $result = $this->dbh->query("SELECT DISTINCT feed_id FROM ttrss_user_entries
282 WHERE ref_id IN ($article_ids)");
284 while ($line = $this->dbh->fetch_assoc($result)) {
285 ccache_update($line["feed_id"], $_SESSION["uid"]);
289 if ($num_updated > 0 && $field == "published") {
290 if (PUBSUBHUBBUB_HUB) {
291 $rss_link = get_self_url_prefix() .
292 "/public.php?op=rss&id=-2&key=" .
293 get_feed_access_key(-2, false);
295 $p = new Publisher(PUBSUBHUBBUB_HUB);
296 $pubsub_result = $p->publish_update($rss_link);
300 $this->wrap(self::STATUS_OK, array("status" => "OK",
301 "updated" => $num_updated));
304 $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
309 function getArticle() {
311 $article_id = join(",", array_filter(explode(",", $this->dbh->escape_string($_REQUEST["article_id"])), is_numeric));
315 $query = "SELECT id,title,link,content,feed_id,comments,int_id,
316 marked,unread,published,score,note,
317 ".SUBSTRING_FOR_DATE."(updated,1,16) as updated,
318 author,(SELECT title FROM ttrss_feeds WHERE id = feed_id) AS feed_title
319 FROM ttrss_entries,ttrss_user_entries
320 WHERE id IN ($article_id) AND ref_id = id AND owner_uid = " .
323 $result = $this->dbh->query($query);
327 if ($this->dbh->num_rows($result) != 0) {
329 while ($line = $this->dbh->fetch_assoc($result)) {
331 $attachments = get_article_enclosures($line['id']);
335 "title" => $line["title"],
336 "link" => $line["link"],
337 "labels" => get_article_labels($line['id']),
338 "unread" => sql_bool_to_bool($line["unread"]),
339 "marked" => sql_bool_to_bool($line["marked"]),
340 "published" => sql_bool_to_bool($line["published"]),
341 "comments" => $line["comments"],
342 "author" => $line["author"],
343 "updated" => (int) strtotime($line["updated"]),
344 "content" => $line["content"],
345 "feed_id" => $line["feed_id"],
346 "attachments" => $attachments,
347 "score" => (int)$line["score"],
348 "feed_title" => $line["feed_title"],
349 "note" => $line["note"]
352 foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_RENDER_ARTICLE_API) as $p) {
353 $article = $p->hook_render_article_api(array("article" => $article));
357 array_push($articles, $article);
362 $this->wrap(self::STATUS_OK, $articles);
364 $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
368 function getConfig() {
370 "icons_dir" => ICONS_DIR,
371 "icons_url" => ICONS_URL);
373 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
375 $result = $this->dbh->query("SELECT COUNT(*) AS cf FROM
376 ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
378 $num_feeds = $this->dbh->fetch_result($result, 0, "cf");
380 $config["num_feeds"] = (int)$num_feeds;
382 $this->wrap(self::STATUS_OK, $config);
385 function updateFeed() {
386 require_once "include/rssfuncs.php";
388 $feed_id = (int) $this->dbh->escape_string($_REQUEST["feed_id"]);
390 update_rss_feed($feed_id, true);
392 $this->wrap(self::STATUS_OK, array("status" => "OK"));
395 function catchupFeed() {
396 $feed_id = $this->dbh->escape_string($_REQUEST["feed_id"]);
397 $is_cat = $this->dbh->escape_string($_REQUEST["is_cat"]);
399 catchup_feed($feed_id, $is_cat);
401 $this->wrap(self::STATUS_OK, array("status" => "OK"));
405 $pref_name = $this->dbh->escape_string($_REQUEST["pref_name"]);
407 $this->wrap(self::STATUS_OK, array("value" => get_pref($pref_name)));
410 function getLabels() {
411 //$article_ids = array_filter(explode(",", $this->dbh->escape_string($_REQUEST["article_ids"])), is_numeric);
413 $article_id = (int)$_REQUEST['article_id'];
417 $result = $this->dbh->query("SELECT id, caption, fg_color, bg_color
419 WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
422 $article_labels = get_article_labels($article_id);
424 $article_labels = array();
426 while ($line = $this->dbh->fetch_assoc($result)) {
429 foreach ($article_labels as $al) {
430 if (feed_to_label_id($al[0]) == $line['id']) {
436 array_push($rv, array(
437 "id" => (int)label_to_feed_id($line['id']),
438 "caption" => $line['caption'],
439 "fg_color" => $line['fg_color'],
440 "bg_color" => $line['bg_color'],
441 "checked" => $checked));
444 $this->wrap(self::STATUS_OK, $rv);
447 function setArticleLabel() {
449 $article_ids = array_filter(explode(",", $this->dbh->escape_string($_REQUEST["article_ids"])), is_numeric);
450 $label_id = (int) $this->dbh->escape_string($_REQUEST['label_id']);
451 $assign = (bool) $this->dbh->escape_string($_REQUEST['assign']) == "true";
453 $label = $this->dbh->escape_string(label_find_caption(
454 feed_to_label_id($label_id), $_SESSION["uid"]));
460 foreach ($article_ids as $id) {
463 label_add_article($id, $label, $_SESSION["uid"]);
465 label_remove_article($id, $label, $_SESSION["uid"]);
472 $this->wrap(self::STATUS_OK, array("status" => "OK",
473 "updated" => $num_updated));
477 function index($method) {
478 $plugin = PluginHost::getInstance()->get_api_method(strtolower($method));
480 if ($plugin && method_exists($plugin, $method)) {
481 $reply = $plugin->$method();
483 $this->wrap($reply[0], $reply[1]);
486 $this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD', "method" => $method));
490 function shareToPublished() {
491 $title = $this->dbh->escape_string(strip_tags($_REQUEST["title"]));
492 $url = $this->dbh->escape_string(strip_tags($_REQUEST["url"]));
493 $content = $this->dbh->escape_string(strip_tags($_REQUEST["content"]));
495 if (Article::create_published_article($title, $url, $content, "", $_SESSION["uid"])) {
496 $this->wrap(self::STATUS_OK, array("status" => 'OK'));
498 $this->wrap(self::STATUS_ERR, array("error" => 'Publishing failed'));
502 static function api_get_feeds($cat_id, $unread_only, $limit, $offset, $include_nested = false) {
508 if ($cat_id == -4 || $cat_id == -2) {
509 $counters = getLabelCounters(true);
511 foreach (array_values($counters) as $cv) {
513 $unread = $cv["counter"];
515 if ($unread || !$unread_only) {
519 "title" => $cv["description"],
520 "unread" => $cv["counter"],
524 array_push($feeds, $row);
531 if ($cat_id == -4 || $cat_id == -1) {
532 foreach (array(-1, -2, -3, -4, -6, 0) as $i) {
533 $unread = getFeedUnread($i);
535 if ($unread || !$unread_only) {
536 $title = getFeedTitle($i);
544 array_push($feeds, $row);
552 if ($include_nested && $cat_id) {
553 $result = db_query("SELECT
554 id, title FROM ttrss_feed_categories
555 WHERE parent_cat = '$cat_id' AND owner_uid = " . $_SESSION["uid"] .
556 " ORDER BY id, title");
558 while ($line = db_fetch_assoc($result)) {
559 $unread = getFeedUnread($line["id"], true) +
560 getCategoryChildrenUnread($line["id"]);
562 if ($unread || !$unread_only) {
565 "title" => $line["title"],
569 array_push($feeds, $row);
577 $limit_qpart = "LIMIT $limit OFFSET $offset";
582 if ($cat_id == -4 || $cat_id == -3) {
583 $result = db_query("SELECT
584 id, feed_url, cat_id, title, order_id, ".
585 SUBSTRING_FOR_DATE."(last_updated,1,19) AS last_updated
586 FROM ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"] .
587 " ORDER BY cat_id, title " . $limit_qpart);
591 $cat_qpart = "cat_id = '$cat_id'";
593 $cat_qpart = "cat_id IS NULL";
595 $result = db_query("SELECT
596 id, feed_url, cat_id, title, order_id, ".
597 SUBSTRING_FOR_DATE."(last_updated,1,19) AS last_updated
598 FROM ttrss_feeds WHERE
599 $cat_qpart AND owner_uid = " . $_SESSION["uid"] .
600 " ORDER BY cat_id, title " . $limit_qpart);
603 while ($line = db_fetch_assoc($result)) {
605 $unread = getFeedUnread($line["id"]);
607 $has_icon = feed_has_icon($line['id']);
609 if ($unread || !$unread_only) {
612 "feed_url" => $line["feed_url"],
613 "title" => $line["title"],
614 "id" => (int)$line["id"],
615 "unread" => (int)$unread,
616 "has_icon" => $has_icon,
617 "cat_id" => (int)$line["cat_id"],
618 "last_updated" => (int) strtotime($line["last_updated"]),
619 "order_id" => (int) $line["order_id"],
622 array_push($feeds, $row);
629 static function api_get_headlines($feed_id, $limit, $offset,
630 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $order,
631 $include_attachments, $since_id,
632 $search = "", $search_mode = "",
633 $include_nested = false, $sanitize_content = true) {
635 $qfh_ret = queryFeedHeadlines($feed_id, $limit,
636 $view_mode, $is_cat, $search, $search_mode,
637 $order, $offset, 0, false, $since_id, $include_nested);
639 $result = $qfh_ret[0];
640 $feed_title = $qfh_ret[1];
642 $headlines = array();
644 while ($line = db_fetch_assoc($result)) {
645 $line["content_preview"] = truncate_string(strip_tags($line["content_preview"]), 100);
646 foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_QUERY_HEADLINES) as $p) {
647 $line = $p->hook_query_headlines($line, 100, true);
650 $is_updated = ($line["last_read"] == "" &&
651 ($line["unread"] != "t" && $line["unread"] != "1"));
653 $tags = explode(",", $line["tag_cache"]);
654 $labels = json_decode($line["label_cache"], true);
656 //if (!$tags) $tags = get_article_tags($line["id"]);
657 //if (!$labels) $labels = get_article_labels($line["id"]);
659 $headline_row = array(
660 "id" => (int)$line["id"],
661 "unread" => sql_bool_to_bool($line["unread"]),
662 "marked" => sql_bool_to_bool($line["marked"]),
663 "published" => sql_bool_to_bool($line["published"]),
664 "updated" => (int) strtotime($line["updated"]),
665 "is_updated" => $is_updated,
666 "title" => $line["title"],
667 "link" => $line["link"],
668 "feed_id" => $line["feed_id"],
672 if ($include_attachments)
673 $headline_row['attachments'] = get_article_enclosures(
677 $headline_row["excerpt"] = $line["content_preview"];
681 if ($sanitize_content) {
682 $headline_row["content"] = sanitize(
684 sql_bool_to_bool($line['hide_images']),
685 false, $line["site_url"], false, $line["id"]);
687 $headline_row["content"] = $line["content"];
691 // unify label output to ease parsing
692 if ($labels["no-labels"] == 1) $labels = array();
694 $headline_row["labels"] = $labels;
696 $headline_row["feed_title"] = $line["feed_title"] ? $line["feed_title"] :
699 $headline_row["comments_count"] = (int)$line["num_comments"];
700 $headline_row["comments_link"] = $line["comments"];
702 $headline_row["always_display_attachments"] = sql_bool_to_bool($line["always_display_enclosures"]);
704 $headline_row["author"] = $line["author"];
706 $headline_row["score"] = (int)$line["score"];
707 $headline_row["note"] = $line["note"];
709 foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_RENDER_ARTICLE_API) as $p) {
710 $headline_row = $p->hook_render_article_api(array("headline" => $headline_row));
713 array_push($headlines, $headline_row);
719 function unsubscribeFeed() {
720 $feed_id = (int) $this->dbh->escape_string($_REQUEST["feed_id"]);
722 $result = $this->dbh->query("SELECT id FROM ttrss_feeds WHERE
723 id = '$feed_id' AND owner_uid = ".$_SESSION["uid"]);
725 if ($this->dbh->num_rows($result) != 0) {
726 Pref_Feeds::remove_feed($feed_id, $_SESSION["uid"]);
727 $this->wrap(self::STATUS_OK, array("status" => "OK"));
729 $this->wrap(self::STATUS_ERR, array("error" => "FEED_NOT_FOUND"));
733 function subscribeToFeed() {
734 $feed_url = $this->dbh->escape_string($_REQUEST["feed_url"]);
735 $category_id = (int) $this->dbh->escape_string($_REQUEST["category_id"]);
736 $login = $this->dbh->escape_string($_REQUEST["login"]);
737 $password = $this->dbh->escape_string($_REQUEST["password"]);
740 $rc = subscribe_to_feed($feed_url, $category_id, $login, $password);
742 $this->wrap(self::STATUS_OK, array("status" => $rc));
744 $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
748 function getFeedTree() {
749 $include_empty = sql_bool_to_bool($_REQUEST['include_empty']);
751 $pf = new Pref_Feeds($_REQUEST);
753 $_REQUEST['mode'] = 2;
754 $_REQUEST['force_show_empty'] = $include_empty;
757 $data = $pf->makefeedtree();
758 $this->wrap(self::STATUS_OK, array("categories" => $data));
760 $this->wrap(self::STATUS_ERR, array("error" =>
761 'UNABLE_TO_INSTANTIATE_OBJECT'));
766 // only works for labels or uncategorized for the time being
767 private function isCategoryEmpty($id) {
770 $result = $this->dbh->query("SELECT COUNT(*) AS count FROM ttrss_labels2
771 WHERE owner_uid = " . $_SESSION["uid"]);
773 return $this->dbh->fetch_result($result, 0, "count") == 0;
775 } else if ($id == 0) {
776 $result = $this->dbh->query("SELECT COUNT(*) AS count FROM ttrss_feeds
777 WHERE cat_id IS NULL AND owner_uid = " . $_SESSION["uid"]);
779 return $this->dbh->fetch_result($result, 0, "count") == 0;