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 /* do not rely on params below */
204 $search = db_escape_string($this->link, $_REQUEST["search"]);
205 $search_mode = db_escape_string($this->link, $_REQUEST["search_mode"]);
207 $headlines = $this->api_get_headlines($this->link, $feed_id, $limit, $offset,
208 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, false,
209 $include_attachments, $since_id, $search, $search_mode,
210 $include_nested, $sanitize_content);
212 print $this->wrap(self::STATUS_OK, $headlines);
214 print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
218 function updateArticle() {
219 $article_ids = array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_ids"])), is_numeric);
220 $mode = (int) db_escape_string($this->link, $_REQUEST["mode"]);
221 $data = db_escape_string($this->link, $_REQUEST["data"]);
222 $field_raw = (int)db_escape_string($this->link, $_REQUEST["field"]);
227 switch ($field_raw) {
230 $additional_fields = ",last_marked = NOW()";
233 $field = "published";
234 $additional_fields = ",last_published = NOW()";
238 $additional_fields = ",last_read = NOW()";
252 $set_to = "NOT $field";
256 if ($field == "note") $set_to = "'$data'";
258 if ($field && $set_to && count($article_ids) > 0) {
260 $article_ids = join(", ", $article_ids);
262 $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"]);
264 $num_updated = db_affected_rows($this->link, $result);
266 if ($num_updated > 0 && $field == "unread") {
267 $result = db_query($this->link, "SELECT DISTINCT feed_id FROM ttrss_user_entries
268 WHERE ref_id IN ($article_ids)");
270 while ($line = db_fetch_assoc($result)) {
271 ccache_update($this->link, $line["feed_id"], $_SESSION["uid"]);
275 if ($num_updated > 0 && $field == "published") {
276 if (PUBSUBHUBBUB_HUB) {
277 $rss_link = get_self_url_prefix() .
278 "/public.php?op=rss&id=-2&key=" .
279 get_feed_access_key($this->link, -2, false);
281 $p = new Publisher(PUBSUBHUBBUB_HUB);
282 $pubsub_result = $p->publish_update($rss_link);
286 print $this->wrap(self::STATUS_OK, array("status" => "OK",
287 "updated" => $num_updated));
290 print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
295 function getArticle() {
297 $article_id = join(",", array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_id"])), is_numeric));
299 $query = "SELECT id,title,link,content,cached_content,feed_id,comments,int_id,
300 marked,unread,published,
301 ".SUBSTRING_FOR_DATE."(updated,1,16) as updated,
303 FROM ttrss_entries,ttrss_user_entries
304 WHERE id IN ($article_id) AND ref_id = id AND owner_uid = " .
307 $result = db_query($this->link, $query);
311 if (db_num_rows($result) != 0) {
313 while ($line = db_fetch_assoc($result)) {
315 $attachments = get_article_enclosures($this->link, $line['id']);
319 "title" => $line["title"],
320 "link" => $line["link"],
321 "labels" => get_article_labels($this->link, $line['id']),
322 "unread" => sql_bool_to_bool($line["unread"]),
323 "marked" => sql_bool_to_bool($line["marked"]),
324 "published" => sql_bool_to_bool($line["published"]),
325 "comments" => $line["comments"],
326 "author" => $line["author"],
327 "updated" => (int) strtotime($line["updated"]),
328 "content" => $line["cached_content"] != "" ? $line["cached_content"] : $line["content"],
329 "feed_id" => $line["feed_id"],
330 "attachments" => $attachments
333 array_push($articles, $article);
338 print $this->wrap(self::STATUS_OK, $articles);
342 function getConfig() {
344 "icons_dir" => ICONS_DIR,
345 "icons_url" => ICONS_URL);
347 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
349 $result = db_query($this->link, "SELECT COUNT(*) AS cf FROM
350 ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
352 $num_feeds = db_fetch_result($result, 0, "cf");
354 $config["num_feeds"] = (int)$num_feeds;
356 print $this->wrap(self::STATUS_OK, $config);
359 function updateFeed() {
360 require_once "include/rssfuncs.php";
362 $feed_id = (int) db_escape_string($this->link, $_REQUEST["feed_id"]);
364 update_rss_feed($this->link, $feed_id, true);
366 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
369 function catchupFeed() {
370 $feed_id = db_escape_string($this->link, $_REQUEST["feed_id"]);
371 $is_cat = db_escape_string($this->link, $_REQUEST["is_cat"]);
373 catchup_feed($this->link, $feed_id, $is_cat);
375 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
379 $pref_name = db_escape_string($this->link, $_REQUEST["pref_name"]);
381 print $this->wrap(self::STATUS_OK, array("value" => get_pref($this->link, $pref_name)));
384 function getLabels() {
385 //$article_ids = array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_ids"])), is_numeric);
387 $article_id = (int)$_REQUEST['article_id'];
391 $result = db_query($this->link, "SELECT id, caption, fg_color, bg_color
393 WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
396 $article_labels = get_article_labels($this->link, $article_id);
398 $article_labels = array();
400 while ($line = db_fetch_assoc($result)) {
403 foreach ($article_labels as $al) {
404 if ($al[0] == $line['id']) {
410 array_push($rv, array(
411 "id" => (int)$line['id'],
412 "caption" => $line['caption'],
413 "fg_color" => $line['fg_color'],
414 "bg_color" => $line['bg_color'],
415 "checked" => $checked));
418 print $this->wrap(self::STATUS_OK, $rv);
421 function setArticleLabel() {
423 $article_ids = array_filter(explode(",", db_escape_string($this->link, $_REQUEST["article_ids"])), is_numeric);
424 $label_id = (int) db_escape_string($this->link, $_REQUEST['label_id']);
425 $assign = (bool) db_escape_string($this->link, $_REQUEST['assign']) == "true";
427 $label = db_escape_string($this->link, label_find_caption($this->link,
428 $label_id, $_SESSION["uid"]));
434 foreach ($article_ids as $id) {
437 label_add_article($this->link, $id, $label, $_SESSION["uid"]);
439 label_remove_article($this->link, $id, $label, $_SESSION["uid"]);
446 print $this->wrap(self::STATUS_OK, array("status" => "OK",
447 "updated" => $num_updated));
452 print $this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD'));
455 function shareToPublished() {
456 $title = db_escape_string($this->link, strip_tags($_REQUEST["title"]));
457 $url = db_escape_string($this->link, strip_tags($_REQUEST["url"]));
458 $content = db_escape_string($this->link, strip_tags($_REQUEST["content"]));
460 if (Article::create_published_article($this->link, $title, $url, $content, "", $_SESSION["uid"])) {
461 print $this->wrap(self::STATUS_OK, array("status" => 'OK'));
463 print $this->wrap(self::STATUS_ERR, array("error" => 'Publishing failed'));
467 static function api_get_feeds($link, $cat_id, $unread_only, $limit, $offset, $include_nested = false) {
473 if ($cat_id == -4 || $cat_id == -2) {
474 $counters = getLabelCounters($link, true);
476 foreach (array_values($counters) as $cv) {
478 $unread = $cv["counter"];
480 if ($unread || !$unread_only) {
484 "title" => $cv["description"],
485 "unread" => $cv["counter"],
489 array_push($feeds, $row);
496 if ($cat_id == -4 || $cat_id == -1) {
497 foreach (array(-1, -2, -3, -4, -6, 0) as $i) {
498 $unread = getFeedUnread($link, $i);
500 if ($unread || !$unread_only) {
501 $title = getFeedTitle($link, $i);
509 array_push($feeds, $row);
517 if ($include_nested && $cat_id) {
518 $result = db_query($link, "SELECT
519 id, title FROM ttrss_feed_categories
520 WHERE parent_cat = '$cat_id' AND owner_uid = " . $_SESSION["uid"] .
521 " ORDER BY id, title");
523 while ($line = db_fetch_assoc($result)) {
524 $unread = getFeedUnread($link, $line["id"], true) +
525 getCategoryChildrenUnread($link, $line["id"]);
527 if ($unread || !$unread_only) {
530 "title" => $line["title"],
534 array_push($feeds, $row);
542 $limit_qpart = "LIMIT $limit OFFSET $offset";
547 if ($cat_id == -4 || $cat_id == -3) {
548 $result = db_query($link, "SELECT
549 id, feed_url, cat_id, title, order_id, ".
550 SUBSTRING_FOR_DATE."(last_updated,1,19) AS last_updated
551 FROM ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"] .
552 " ORDER BY cat_id, title " . $limit_qpart);
556 $cat_qpart = "cat_id = '$cat_id'";
558 $cat_qpart = "cat_id IS NULL";
560 $result = db_query($link, "SELECT
561 id, feed_url, cat_id, title, order_id, ".
562 SUBSTRING_FOR_DATE."(last_updated,1,19) AS last_updated
563 FROM ttrss_feeds WHERE
564 $cat_qpart AND owner_uid = " . $_SESSION["uid"] .
565 " ORDER BY cat_id, title " . $limit_qpart);
568 while ($line = db_fetch_assoc($result)) {
570 $unread = getFeedUnread($link, $line["id"]);
572 $has_icon = feed_has_icon($line['id']);
574 if ($unread || !$unread_only) {
577 "feed_url" => $line["feed_url"],
578 "title" => $line["title"],
579 "id" => (int)$line["id"],
580 "unread" => (int)$unread,
581 "has_icon" => $has_icon,
582 "cat_id" => (int)$line["cat_id"],
583 "last_updated" => (int) strtotime($line["last_updated"]),
584 "order_id" => (int) $line["order_id"],
587 array_push($feeds, $row);
594 static function api_get_headlines($link, $feed_id, $limit, $offset,
595 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $order,
596 $include_attachments, $since_id,
597 $search = "", $search_mode = "",
598 $include_nested = false, $sanitize_content = true) {
600 $qfh_ret = queryFeedHeadlines($link, $feed_id, $limit,
601 $view_mode, $is_cat, $search, $search_mode,
602 $order, $offset, 0, false, $since_id, $include_nested);
604 $result = $qfh_ret[0];
605 $feed_title = $qfh_ret[1];
607 $headlines = array();
609 while ($line = db_fetch_assoc($result)) {
610 $is_updated = ($line["last_read"] == "" &&
611 ($line["unread"] != "t" && $line["unread"] != "1"));
613 $tags = explode(",", $line["tag_cache"]);
614 $labels = json_decode($line["label_cache"], true);
616 //if (!$tags) $tags = get_article_tags($link, $line["id"]);
617 //if (!$labels) $labels = get_article_labels($link, $line["id"]);
619 $headline_row = array(
620 "id" => (int)$line["id"],
621 "unread" => sql_bool_to_bool($line["unread"]),
622 "marked" => sql_bool_to_bool($line["marked"]),
623 "published" => sql_bool_to_bool($line["published"]),
624 "updated" => (int) strtotime($line["updated"]),
625 "is_updated" => $is_updated,
626 "title" => $line["title"],
627 "link" => $line["link"],
628 "feed_id" => $line["feed_id"],
632 if ($include_attachments)
633 $headline_row['attachments'] = get_article_enclosures($link,
637 $excerpt = truncate_string(strip_tags($line["content_preview"]), 100);
638 $headline_row["excerpt"] = $excerpt;
643 if ($line["cached_content"] != "") {
644 $line["content_preview"] =& $line["cached_content"];
647 if ($sanitize_content) {
648 $headline_row["content"] = sanitize($link,
649 $line["content_preview"],
650 sql_bool_to_bool($line['hide_images']),
651 false, $line["site_url"]);
653 $headline_row["content"] = $line["content_preview"];
657 // unify label output to ease parsing
658 if ($labels["no-labels"] == 1) $labels = array();
660 $headline_row["labels"] = $labels;
662 $headline_row["feed_title"] = $line["feed_title"];
664 $headline_row["comments_count"] = (int)$line["num_comments"];
665 $headline_row["comments_link"] = $line["comments"];
667 $headline_row["always_display_attachments"] = sql_bool_to_bool($line["always_display_enclosures"]);
669 $headline_row["author"] = $line["author"];
672 foreach ($pluginhost->get_hooks($pluginhost::HOOK_RENDER_ARTICLE_API) as $p) {
673 $headline_row = $p->hook_render_article_api($headline_row);
676 array_push($headlines, $headline_row);
682 function unsubscribeFeed() {
683 $feed_id = (int) db_escape_string($this->link, $_REQUEST["feed_id"]);
685 $result = db_query($this->link, "SELECT id FROM ttrss_feeds WHERE
686 id = '$feed_id' AND owner_uid = ".$_SESSION["uid"]);
688 if (db_num_rows($result) != 0) {
689 Pref_Feeds::remove_feed($this->link, $feed_id, $_SESSION["uid"]);
690 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
692 print $this->wrap(self::STATUS_ERR, array("error" => "FEED_NOT_FOUND"));
696 function subscribeToFeed() {
697 $feed_url = db_escape_string($this->link, $_REQUEST["feed_url"]);
698 $category_id = (int) db_escape_string($this->link, $_REQUEST["category_id"]);
699 $login = db_escape_string($this->link, $_REQUEST["login"]);
700 $password = db_escape_string($this->link, $_REQUEST["password"]);
703 $rc = subscribe_to_feed($this->link, $feed_url, $category_id,
704 $login, $password, false);
706 print $this->wrap(self::STATUS_OK, array("status" => $rc));
708 print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
712 function getFeedTree() {
713 $include_empty = sql_bool_to_bool($_REQUEST['include_empty']);
715 $pf = new Pref_Feeds($this->link, $_REQUEST);
717 $_REQUEST['mode'] = 2;
718 $_REQUEST['force_show_empty'] = $include_empty;
721 $data = $pf->makefeedtree();
722 print $this->wrap(self::STATUS_OK, array("categories" => $data));
724 print $this->wrap(self::STATUS_ERR, array("error" =>
725 'UNABLE_TO_INSTANTIATE_OBJECT'));
730 // only works for labels or uncategorized for the time being
731 private function isCategoryEmpty($id) {
734 $result = db_query($this->link, "SELECT COUNT(*) AS count FROM ttrss_labels2
735 WHERE owner_uid = " . $_SESSION["uid"]);
737 return db_fetch_result($result, 0, "count") == 0;
739 } else if ($id == 0) {
740 $result = db_query($this->link, "SELECT COUNT(*) AS count FROM ttrss_feeds
741 WHERE cat_id IS NULL AND owner_uid = " . $_SESSION["uid"]);
743 return db_fetch_result($result, 0, "count") == 0;