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 print $this->wrap(self::STATUS_ERR, array("error" => 'NOT_LOGGED_IN'));
21 if ($_SESSION["uid"] && $method != "logout" && !get_pref($this->link, 'ENABLE_API_ACCESS')) {
22 print $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 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);
53 $login = db_escape_string($this->link, $_REQUEST["user"]);
54 $password = $_REQUEST["password"];
55 $password_base64 = base64_decode($_REQUEST["password"]);
57 if (SINGLE_USER_MODE) $login = "admin";
59 $result = db_query($this->link, "SELECT id FROM ttrss_users WHERE login = '$login'");
61 if (db_num_rows($result) != 0) {
62 $uid = db_fetch_result($result, 0, "id");
68 print $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
72 if (get_pref($this->link, "ENABLE_API_ACCESS", $uid)) {
73 if (authenticate_user($this->link, $login, $password)) { // try login with normal password
74 print $this->wrap(self::STATUS_OK, array("session_id" => session_id(),
75 "api_level" => self::API_LEVEL));
76 } else if (authenticate_user($this->link, $login, $password_base64)) { // else try with base64_decoded password
77 print $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 print $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
83 print $this->wrap(self::STATUS_ERR, array("error" => "API_DISABLED"));
90 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
93 function isLoggedIn() {
94 print $this->wrap(self::STATUS_OK, array("status" => $_SESSION["uid"] != ''));
97 function getUnread() {
98 $feed_id = db_escape_string($this->link, $_REQUEST["feed_id"]);
99 $is_cat = db_escape_string($this->link, $_REQUEST["is_cat"]);
102 print $this->wrap(self::STATUS_OK, array("unread" => getFeedUnread($this->link, $feed_id, $is_cat)));
104 print $this->wrap(self::STATUS_OK, array("unread" => getGlobalUnread($this->link)));
108 /* Method added for ttrss-reader for Android */
109 function getCounters() {
110 print $this->wrap(self::STATUS_OK, getAllCounters($this->link));
113 function getFeeds() {
114 $cat_id = db_escape_string($this->link, $_REQUEST["cat_id"]);
115 $unread_only = sql_bool_to_bool($_REQUEST["unread_only"]);
116 $limit = (int) db_escape_string($this->link, $_REQUEST["limit"]);
117 $offset = (int) db_escape_string($this->link, $_REQUEST["offset"]);
118 $include_nested = sql_bool_to_bool($_REQUEST["include_nested"]);
120 $feeds = $this->api_get_feeds($this->link, $cat_id, $unread_only, $limit, $offset, $include_nested);
122 print $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 = db_query($this->link, "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 = db_fetch_assoc($result)) {
151 if ($include_empty || $line["num_feeds"] > 0 || $line["num_cats"] > 0) {
152 $unread = getFeedUnread($this->link, $line["id"], true);
155 $unread += getCategoryChildrenUnread($this->link, $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($this->link, $cat_id, true);
171 if ($unread || !$unread_only) {
172 array_push($cats, array("id" => $cat_id,
173 "title" => getCategoryTitle($this->link, $cat_id),
174 "unread" => $unread));
179 print $this->wrap(self::STATUS_OK, $cats);
182 function getHeadlines() {
183 $feed_id = db_escape_string($this->link, $_REQUEST["feed_id"]);
184 if ($feed_id != "") {
186 $limit = (int)db_escape_string($this->link, $_REQUEST["limit"]);
188 if (!$limit || $limit >= 60) $limit = 60;
190 $offset = (int)db_escape_string($this->link, $_REQUEST["skip"]);
191 $filter = db_escape_string($this->link, $_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 = db_escape_string($this->link, $_REQUEST["view_mode"]);
197 $include_attachments = sql_bool_to_bool($_REQUEST["include_attachments"]);
198 $since_id = (int)db_escape_string($this->link, $_REQUEST["since_id"]);
199 $include_nested = sql_bool_to_bool($_REQUEST["include_nested"]);
200 $sanitize_content = true;
202 $override_order = false;
203 switch ($_REQUEST["order_by"]) {
205 $override_order = "date_entered, updated";
208 $override_order = "updated DESC";
212 /* do not rely on params below */
214 $search = db_escape_string($this->link, $_REQUEST["search"]);
215 $search_mode = db_escape_string($this->link, $_REQUEST["search_mode"]);
217 $headlines = $this->api_get_headlines($this->link, $feed_id, $limit, $offset,
218 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $override_order,
219 $include_attachments, $since_id, $search, $search_mode,
220 $include_nested, $sanitize_content);
222 print $this->wrap(self::STATUS_OK, $headlines);
224 print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
228 function updateArticle() {
229 $article_ids = array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_ids"])), is_numeric);
230 $mode = (int) db_escape_string($this->link, $_REQUEST["mode"]);
231 $data = db_escape_string($this->link, $_REQUEST["data"]);
232 $field_raw = (int)db_escape_string($this->link, $_REQUEST["field"]);
237 switch ($field_raw) {
240 $additional_fields = ",last_marked = NOW()";
243 $field = "published";
244 $additional_fields = ",last_published = NOW()";
248 $additional_fields = ",last_read = NOW()";
262 $set_to = "NOT $field";
266 if ($field == "note") $set_to = "'$data'";
268 if ($field && $set_to && count($article_ids) > 0) {
270 $article_ids = join(", ", $article_ids);
272 $result = db_query($this->link, "UPDATE ttrss_user_entries SET $field = $set_to $additional_fields WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
274 $num_updated = db_affected_rows($this->link, $result);
276 if ($num_updated > 0 && $field == "unread") {
277 $result = db_query($this->link, "SELECT DISTINCT feed_id FROM ttrss_user_entries
278 WHERE ref_id IN ($article_ids)");
280 while ($line = db_fetch_assoc($result)) {
281 ccache_update($this->link, $line["feed_id"], $_SESSION["uid"]);
285 if ($num_updated > 0 && $field == "published") {
286 if (PUBSUBHUBBUB_HUB) {
287 $rss_link = get_self_url_prefix() .
288 "/public.php?op=rss&id=-2&key=" .
289 get_feed_access_key($this->link, -2, false);
291 $p = new Publisher(PUBSUBHUBBUB_HUB);
292 $pubsub_result = $p->publish_update($rss_link);
296 print $this->wrap(self::STATUS_OK, array("status" => "OK",
297 "updated" => $num_updated));
300 print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
305 function getArticle() {
307 $article_id = join(",", array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_id"])), is_numeric));
309 $query = "SELECT id,title,link,content,cached_content,feed_id,comments,int_id,
310 marked,unread,published,
311 ".SUBSTRING_FOR_DATE."(updated,1,16) as updated,
313 FROM ttrss_entries,ttrss_user_entries
314 WHERE id IN ($article_id) AND ref_id = id AND owner_uid = " .
317 $result = db_query($this->link, $query);
321 if (db_num_rows($result) != 0) {
323 while ($line = db_fetch_assoc($result)) {
325 $attachments = get_article_enclosures($this->link, $line['id']);
329 "title" => $line["title"],
330 "link" => $line["link"],
331 "labels" => get_article_labels($this->link, $line['id']),
332 "unread" => sql_bool_to_bool($line["unread"]),
333 "marked" => sql_bool_to_bool($line["marked"]),
334 "published" => sql_bool_to_bool($line["published"]),
335 "comments" => $line["comments"],
336 "author" => $line["author"],
337 "updated" => (int) strtotime($line["updated"]),
338 "content" => $line["cached_content"] != "" ? $line["cached_content"] : $line["content"],
339 "feed_id" => $line["feed_id"],
340 "attachments" => $attachments
344 foreach ($pluginhost->get_hooks($pluginhost::HOOK_RENDER_ARTICLE_API) as $p) {
345 $article = $p->hook_render_article_api(array("article" => $article));
349 array_push($articles, $article);
354 print $this->wrap(self::STATUS_OK, $articles);
358 function getConfig() {
360 "icons_dir" => ICONS_DIR,
361 "icons_url" => ICONS_URL);
363 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
365 $result = db_query($this->link, "SELECT COUNT(*) AS cf FROM
366 ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
368 $num_feeds = db_fetch_result($result, 0, "cf");
370 $config["num_feeds"] = (int)$num_feeds;
372 print $this->wrap(self::STATUS_OK, $config);
375 function updateFeed() {
376 require_once "include/rssfuncs.php";
378 $feed_id = (int) db_escape_string($this->link, $_REQUEST["feed_id"]);
380 update_rss_feed($this->link, $feed_id, true);
382 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
385 function catchupFeed() {
386 $feed_id = db_escape_string($this->link, $_REQUEST["feed_id"]);
387 $is_cat = db_escape_string($this->link, $_REQUEST["is_cat"]);
389 catchup_feed($this->link, $feed_id, $is_cat);
391 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
395 $pref_name = db_escape_string($this->link, $_REQUEST["pref_name"]);
397 print $this->wrap(self::STATUS_OK, array("value" => get_pref($this->link, $pref_name)));
400 function getLabels() {
401 //$article_ids = array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_ids"])), is_numeric);
403 $article_id = (int)$_REQUEST['article_id'];
407 $result = db_query($this->link, "SELECT id, caption, fg_color, bg_color
409 WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
412 $article_labels = get_article_labels($this->link, $article_id);
414 $article_labels = array();
416 while ($line = db_fetch_assoc($result)) {
419 foreach ($article_labels as $al) {
420 if ($al[0] == $line['id']) {
426 array_push($rv, array(
427 "id" => (int)$line['id'],
428 "caption" => $line['caption'],
429 "fg_color" => $line['fg_color'],
430 "bg_color" => $line['bg_color'],
431 "checked" => $checked));
434 print $this->wrap(self::STATUS_OK, $rv);
437 function setArticleLabel() {
439 $article_ids = array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_ids"])), is_numeric);
440 $label_id = (int) db_escape_string($this->link, $_REQUEST['label_id']);
441 $assign = (bool) db_escape_string($this->link, $_REQUEST['assign']) == "true";
443 $label = db_escape_string($this->link, label_find_caption($this->link,
444 $label_id, $_SESSION["uid"]));
450 foreach ($article_ids as $id) {
453 label_add_article($this->link, $id, $label, $_SESSION["uid"]);
455 label_remove_article($this->link, $id, $label, $_SESSION["uid"]);
462 print $this->wrap(self::STATUS_OK, array("status" => "OK",
463 "updated" => $num_updated));
468 print $this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD'));
471 function shareToPublished() {
472 $title = db_escape_string($this->link, strip_tags($_REQUEST["title"]));
473 $url = db_escape_string($this->link, strip_tags($_REQUEST["url"]));
474 $content = db_escape_string($this->link, strip_tags($_REQUEST["content"]));
476 if (Article::create_published_article($this->link, $title, $url, $content, "", $_SESSION["uid"])) {
477 print $this->wrap(self::STATUS_OK, array("status" => 'OK'));
479 print $this->wrap(self::STATUS_ERR, array("error" => 'Publishing failed'));
483 static function api_get_feeds($link, $cat_id, $unread_only, $limit, $offset, $include_nested = false) {
489 if ($cat_id == -4 || $cat_id == -2) {
490 $counters = getLabelCounters($link, true);
492 foreach (array_values($counters) as $cv) {
494 $unread = $cv["counter"];
496 if ($unread || !$unread_only) {
500 "title" => $cv["description"],
501 "unread" => $cv["counter"],
505 array_push($feeds, $row);
512 if ($cat_id == -4 || $cat_id == -1) {
513 foreach (array(-1, -2, -3, -4, -6, 0) as $i) {
514 $unread = getFeedUnread($link, $i);
516 if ($unread || !$unread_only) {
517 $title = getFeedTitle($link, $i);
525 array_push($feeds, $row);
533 if ($include_nested && $cat_id) {
534 $result = db_query($link, "SELECT
535 id, title FROM ttrss_feed_categories
536 WHERE parent_cat = '$cat_id' AND owner_uid = " . $_SESSION["uid"] .
537 " ORDER BY id, title");
539 while ($line = db_fetch_assoc($result)) {
540 $unread = getFeedUnread($link, $line["id"], true) +
541 getCategoryChildrenUnread($link, $line["id"]);
543 if ($unread || !$unread_only) {
546 "title" => $line["title"],
550 array_push($feeds, $row);
558 $limit_qpart = "LIMIT $limit OFFSET $offset";
563 if ($cat_id == -4 || $cat_id == -3) {
564 $result = db_query($link, "SELECT
565 id, feed_url, cat_id, title, order_id, ".
566 SUBSTRING_FOR_DATE."(last_updated,1,19) AS last_updated
567 FROM ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"] .
568 " ORDER BY cat_id, title " . $limit_qpart);
572 $cat_qpart = "cat_id = '$cat_id'";
574 $cat_qpart = "cat_id IS NULL";
576 $result = db_query($link, "SELECT
577 id, feed_url, cat_id, title, order_id, ".
578 SUBSTRING_FOR_DATE."(last_updated,1,19) AS last_updated
579 FROM ttrss_feeds WHERE
580 $cat_qpart AND owner_uid = " . $_SESSION["uid"] .
581 " ORDER BY cat_id, title " . $limit_qpart);
584 while ($line = db_fetch_assoc($result)) {
586 $unread = getFeedUnread($link, $line["id"]);
588 $has_icon = feed_has_icon($line['id']);
590 if ($unread || !$unread_only) {
593 "feed_url" => $line["feed_url"],
594 "title" => $line["title"],
595 "id" => (int)$line["id"],
596 "unread" => (int)$unread,
597 "has_icon" => $has_icon,
598 "cat_id" => (int)$line["cat_id"],
599 "last_updated" => (int) strtotime($line["last_updated"]),
600 "order_id" => (int) $line["order_id"],
603 array_push($feeds, $row);
610 static function api_get_headlines($link, $feed_id, $limit, $offset,
611 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $order,
612 $include_attachments, $since_id,
613 $search = "", $search_mode = "",
614 $include_nested = false, $sanitize_content = true) {
616 $qfh_ret = queryFeedHeadlines($link, $feed_id, $limit,
617 $view_mode, $is_cat, $search, $search_mode,
618 $order, $offset, 0, false, $since_id, $include_nested);
620 $result = $qfh_ret[0];
621 $feed_title = $qfh_ret[1];
623 $headlines = array();
625 while ($line = db_fetch_assoc($result)) {
626 $is_updated = ($line["last_read"] == "" &&
627 ($line["unread"] != "t" && $line["unread"] != "1"));
629 $tags = explode(",", $line["tag_cache"]);
630 $labels = json_decode($line["label_cache"], true);
632 //if (!$tags) $tags = get_article_tags($link, $line["id"]);
633 //if (!$labels) $labels = get_article_labels($link, $line["id"]);
635 $headline_row = array(
636 "id" => (int)$line["id"],
637 "unread" => sql_bool_to_bool($line["unread"]),
638 "marked" => sql_bool_to_bool($line["marked"]),
639 "published" => sql_bool_to_bool($line["published"]),
640 "updated" => (int) strtotime($line["updated"]),
641 "is_updated" => $is_updated,
642 "title" => $line["title"],
643 "link" => $line["link"],
644 "feed_id" => $line["feed_id"],
648 if ($include_attachments)
649 $headline_row['attachments'] = get_article_enclosures($link,
653 $excerpt = truncate_string(strip_tags($line["content_preview"]), 100);
654 $headline_row["excerpt"] = $excerpt;
659 if ($line["cached_content"] != "") {
660 $line["content_preview"] =& $line["cached_content"];
663 if ($sanitize_content) {
664 $headline_row["content"] = sanitize($link,
665 $line["content_preview"],
666 sql_bool_to_bool($line['hide_images']),
667 false, $line["site_url"]);
669 $headline_row["content"] = $line["content_preview"];
673 // unify label output to ease parsing
674 if ($labels["no-labels"] == 1) $labels = array();
676 $headline_row["labels"] = $labels;
678 $headline_row["feed_title"] = $line["feed_title"];
680 $headline_row["comments_count"] = (int)$line["num_comments"];
681 $headline_row["comments_link"] = $line["comments"];
683 $headline_row["always_display_attachments"] = sql_bool_to_bool($line["always_display_enclosures"]);
685 $headline_row["author"] = $line["author"];
688 foreach ($pluginhost->get_hooks($pluginhost::HOOK_RENDER_ARTICLE_API) as $p) {
689 $headline_row = $p->hook_render_article_api(array("headline" => $headline_row));
692 array_push($headlines, $headline_row);
698 function unsubscribeFeed() {
699 $feed_id = (int) db_escape_string($this->link, $_REQUEST["feed_id"]);
701 $result = db_query($this->link, "SELECT id FROM ttrss_feeds WHERE
702 id = '$feed_id' AND owner_uid = ".$_SESSION["uid"]);
704 if (db_num_rows($result) != 0) {
705 Pref_Feeds::remove_feed($this->link, $feed_id, $_SESSION["uid"]);
706 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
708 print $this->wrap(self::STATUS_ERR, array("error" => "FEED_NOT_FOUND"));
712 function subscribeToFeed() {
713 $feed_url = db_escape_string($this->link, $_REQUEST["feed_url"]);
714 $category_id = (int) db_escape_string($this->link, $_REQUEST["category_id"]);
715 $login = db_escape_string($this->link, $_REQUEST["login"]);
716 $password = db_escape_string($this->link, $_REQUEST["password"]);
719 $rc = subscribe_to_feed($this->link, $feed_url, $category_id,
720 $login, $password, false);
722 print $this->wrap(self::STATUS_OK, array("status" => $rc));
724 print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
728 function getFeedTree() {
729 $include_empty = sql_bool_to_bool($_REQUEST['include_empty']);
731 $pf = new Pref_Feeds($this->link, $_REQUEST);
733 $_REQUEST['mode'] = 2;
734 $_REQUEST['force_show_empty'] = $include_empty;
737 $data = $pf->makefeedtree();
738 print $this->wrap(self::STATUS_OK, array("categories" => $data));
740 print $this->wrap(self::STATUS_ERR, array("error" =>
741 'UNABLE_TO_INSTANTIATE_OBJECT'));
746 // only works for labels or uncategorized for the time being
747 private function isCategoryEmpty($id) {
750 $result = db_query($this->link, "SELECT COUNT(*) AS count FROM ttrss_labels2
751 WHERE owner_uid = " . $_SESSION["uid"]);
753 return db_fetch_result($result, 0, "count") == 0;
755 } else if ($id == 0) {
756 $result = db_query($this->link, "SELECT COUNT(*) AS count FROM ttrss_feeds
757 WHERE cat_id IS NULL AND owner_uid = " . $_SESSION["uid"]);
759 return db_fetch_result($result, 0, "count") == 0;