]>
git.wh0rd.org - tt-rss.git/blob - classes/api.php
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( '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( $_REQUEST["user"]);
54 $password = $_REQUEST["password"];
55 $password_base64 = base64_decode($_REQUEST["password"]);
57 if (SINGLE_USER_MODE
) $login = "admin";
59 $result = db_query( "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( "ENABLE_API_ACCESS", $uid)) {
73 if (authenticate_user( $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( $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( $_REQUEST["feed_id"]);
99 $is_cat = db_escape_string( $_REQUEST["is_cat"]);
102 print $this->wrap(self
::STATUS_OK
, array("unread" => getFeedUnread( $feed_id, $is_cat)));
104 print $this->wrap(self
::STATUS_OK
, array("unread" => getGlobalUnread()));
108 /* Method added for ttrss-reader for Android */
109 function getCounters() {
110 print $this->wrap(self
::STATUS_OK
, getAllCounters());
113 function getFeeds() {
114 $cat_id = db_escape_string( $_REQUEST["cat_id"]);
115 $unread_only = sql_bool_to_bool($_REQUEST["unread_only"]);
116 $limit = (int) db_escape_string( $_REQUEST["limit"]);
117 $offset = (int) db_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 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( "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( $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 print $this->wrap(self
::STATUS_OK
, $cats);
182 function getHeadlines() {
183 $feed_id = db_escape_string( $_REQUEST["feed_id"]);
184 if ($feed_id != "") {
186 $limit = (int)db_escape_string( $_REQUEST["limit"]);
188 if (!$limit ||
$limit >= 60) $limit = 60;
190 $offset = (int)db_escape_string( $_REQUEST["skip"]);
191 $filter = db_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 = db_escape_string( $_REQUEST["view_mode"]);
197 $include_attachments = sql_bool_to_bool($_REQUEST["include_attachments"]);
198 $since_id = (int)db_escape_string( $_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( $_REQUEST["search"]);
215 $search_mode = db_escape_string( $_REQUEST["search_mode"]);
217 $headlines = $this->api_get_headlines( $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( $_REQUEST["article_ids"])), is_numeric
);
230 $mode = (int) db_escape_string( $_REQUEST["mode"]);
231 $data = db_escape_string( $_REQUEST["data"]);
232 $field_raw = (int)db_escape_string( $_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( "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( $result);
276 if ($num_updated > 0 && $field == "unread") {
277 $result = db_query( "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( $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( -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( $_REQUEST["article_id"])), is_numeric
));
309 $query = "SELECT id,title,link,content,cached_content,feed_id,comments,int_id,
310 marked,unread,published,score,
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( $query);
321 if (db_num_rows($result) != 0) {
323 while ($line = db_fetch_assoc($result)) {
325 $attachments = get_article_enclosures( $line['id']);
329 "title" => $line["title"],
330 "link" => $line["link"],
331 "labels" => get_article_labels( $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,
341 "score" => (int)$line["score"]
345 foreach ($pluginhost->get_hooks($pluginhost::HOOK_RENDER_ARTICLE_API
) as $p) {
346 $article = $p->hook_render_article_api(array("article" => $article));
350 array_push($articles, $article);
355 print $this->wrap(self
::STATUS_OK
, $articles);
359 function getConfig() {
361 "icons_dir" => ICONS_DIR
,
362 "icons_url" => ICONS_URL
);
364 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
366 $result = db_query( "SELECT COUNT(*) AS cf FROM
367 ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
369 $num_feeds = db_fetch_result($result, 0, "cf");
371 $config["num_feeds"] = (int)$num_feeds;
373 print $this->wrap(self
::STATUS_OK
, $config);
376 function updateFeed() {
377 require_once "include/rssfuncs.php";
379 $feed_id = (int) db_escape_string( $_REQUEST["feed_id"]);
381 update_rss_feed( $feed_id, true);
383 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
386 function catchupFeed() {
387 $feed_id = db_escape_string( $_REQUEST["feed_id"]);
388 $is_cat = db_escape_string( $_REQUEST["is_cat"]);
390 catchup_feed( $feed_id, $is_cat);
392 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
396 $pref_name = db_escape_string( $_REQUEST["pref_name"]);
398 print $this->wrap(self
::STATUS_OK
, array("value" => get_pref( $pref_name)));
401 function getLabels() {
402 //$article_ids = array_filter(explode(",", db_escape_string( $_REQUEST["article_ids"])), is_numeric);
404 $article_id = (int)$_REQUEST['article_id'];
408 $result = db_query( "SELECT id, caption, fg_color, bg_color
410 WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
413 $article_labels = get_article_labels( $article_id);
415 $article_labels = array();
417 while ($line = db_fetch_assoc($result)) {
420 foreach ($article_labels as $al) {
421 if ($al[0] == $line['id']) {
427 array_push($rv, array(
428 "id" => (int)$line['id'],
429 "caption" => $line['caption'],
430 "fg_color" => $line['fg_color'],
431 "bg_color" => $line['bg_color'],
432 "checked" => $checked));
435 print $this->wrap(self
::STATUS_OK
, $rv);
438 function setArticleLabel() {
440 $article_ids = array_filter(explode(",", db_escape_string( $_REQUEST["article_ids"])), is_numeric
);
441 $label_id = (int) db_escape_string( $_REQUEST['label_id']);
442 $assign = (bool) db_escape_string( $_REQUEST['assign']) == "true";
444 $label = db_escape_string( label_find_caption(
445 $label_id, $_SESSION["uid"]));
451 foreach ($article_ids as $id) {
454 label_add_article( $id, $label, $_SESSION["uid"]);
456 label_remove_article( $id, $label, $_SESSION["uid"]);
463 print $this->wrap(self
::STATUS_OK
, array("status" => "OK",
464 "updated" => $num_updated));
468 function index($method) {
471 $plugin = $pluginhost->get_api_method(strtolower($method));
473 if ($plugin && method_exists($plugin, $method)) {
474 $reply = $plugin->$method();
476 print $this->wrap($reply[0], $reply[1]);
479 print $this->wrap(self
::STATUS_ERR
, array("error" => 'UNKNOWN_METHOD', "method" => $method));
483 function shareToPublished() {
484 $title = db_escape_string( strip_tags($_REQUEST["title"]));
485 $url = db_escape_string( strip_tags($_REQUEST["url"]));
486 $content = db_escape_string( strip_tags($_REQUEST["content"]));
488 if (Article
::create_published_article( $title, $url, $content, "", $_SESSION["uid"])) {
489 print $this->wrap(self
::STATUS_OK
, array("status" => 'OK'));
491 print $this->wrap(self
::STATUS_ERR
, array("error" => 'Publishing failed'));
495 static function api_get_feeds( $cat_id, $unread_only, $limit, $offset, $include_nested = false) {
501 if ($cat_id == -4 ||
$cat_id == -2) {
502 $counters = getLabelCounters( true);
504 foreach (array_values($counters) as $cv) {
506 $unread = $cv["counter"];
508 if ($unread ||
!$unread_only) {
512 "title" => $cv["description"],
513 "unread" => $cv["counter"],
517 array_push($feeds, $row);
524 if ($cat_id == -4 ||
$cat_id == -1) {
525 foreach (array(-1, -2, -3, -4, -6, 0) as $i) {
526 $unread = getFeedUnread( $i);
528 if ($unread ||
!$unread_only) {
529 $title = getFeedTitle( $i);
537 array_push($feeds, $row);
545 if ($include_nested && $cat_id) {
546 $result = db_query( "SELECT
547 id, title FROM ttrss_feed_categories
548 WHERE parent_cat = '$cat_id' AND owner_uid = " . $_SESSION["uid"] .
549 " ORDER BY id, title");
551 while ($line = db_fetch_assoc($result)) {
552 $unread = getFeedUnread( $line["id"], true) +
553 getCategoryChildrenUnread( $line["id"]);
555 if ($unread ||
!$unread_only) {
558 "title" => $line["title"],
562 array_push($feeds, $row);
570 $limit_qpart = "LIMIT $limit OFFSET $offset";
575 if ($cat_id == -4 ||
$cat_id == -3) {
576 $result = db_query( "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 owner_uid = " . $_SESSION["uid"] .
580 " ORDER BY cat_id, title " . $limit_qpart);
584 $cat_qpart = "cat_id = '$cat_id'";
586 $cat_qpart = "cat_id IS NULL";
588 $result = db_query( "SELECT
589 id, feed_url, cat_id, title, order_id, ".
590 SUBSTRING_FOR_DATE
."(last_updated,1,19) AS last_updated
591 FROM ttrss_feeds WHERE
592 $cat_qpart AND owner_uid = " . $_SESSION["uid"] .
593 " ORDER BY cat_id, title " . $limit_qpart);
596 while ($line = db_fetch_assoc($result)) {
598 $unread = getFeedUnread( $line["id"]);
600 $has_icon = feed_has_icon($line['id']);
602 if ($unread ||
!$unread_only) {
605 "feed_url" => $line["feed_url"],
606 "title" => $line["title"],
607 "id" => (int)$line["id"],
608 "unread" => (int)$unread,
609 "has_icon" => $has_icon,
610 "cat_id" => (int)$line["cat_id"],
611 "last_updated" => (int) strtotime($line["last_updated"]),
612 "order_id" => (int) $line["order_id"],
615 array_push($feeds, $row);
622 static function api_get_headlines( $feed_id, $limit, $offset,
623 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $order,
624 $include_attachments, $since_id,
625 $search = "", $search_mode = "",
626 $include_nested = false, $sanitize_content = true) {
628 $qfh_ret = queryFeedHeadlines( $feed_id, $limit,
629 $view_mode, $is_cat, $search, $search_mode,
630 $order, $offset, 0, false, $since_id, $include_nested);
632 $result = $qfh_ret[0];
633 $feed_title = $qfh_ret[1];
635 $headlines = array();
637 while ($line = db_fetch_assoc($result)) {
638 $is_updated = ($line["last_read"] == "" &&
639 ($line["unread"] != "t" && $line["unread"] != "1"));
641 $tags = explode(",", $line["tag_cache"]);
642 $labels = json_decode($line["label_cache"], true);
644 //if (!$tags) $tags = get_article_tags( $line["id"]);
645 //if (!$labels) $labels = get_article_labels( $line["id"]);
647 $headline_row = array(
648 "id" => (int)$line["id"],
649 "unread" => sql_bool_to_bool($line["unread"]),
650 "marked" => sql_bool_to_bool($line["marked"]),
651 "published" => sql_bool_to_bool($line["published"]),
652 "updated" => (int) strtotime($line["updated"]),
653 "is_updated" => $is_updated,
654 "title" => $line["title"],
655 "link" => $line["link"],
656 "feed_id" => $line["feed_id"],
660 if ($include_attachments)
661 $headline_row['attachments'] = get_article_enclosures(
665 $excerpt = truncate_string(strip_tags($line["content_preview"]), 100);
666 $headline_row["excerpt"] = $excerpt;
671 if ($line["cached_content"] != "") {
672 $line["content_preview"] =& $line["cached_content"];
675 if ($sanitize_content) {
676 $headline_row["content"] = sanitize(
677 $line["content_preview"],
678 sql_bool_to_bool($line['hide_images']),
679 false, $line["site_url"]);
681 $headline_row["content"] = $line["content_preview"];
685 // unify label output to ease parsing
686 if ($labels["no-labels"] == 1) $labels = array();
688 $headline_row["labels"] = $labels;
690 $headline_row["feed_title"] = $line["feed_title"];
692 $headline_row["comments_count"] = (int)$line["num_comments"];
693 $headline_row["comments_link"] = $line["comments"];
695 $headline_row["always_display_attachments"] = sql_bool_to_bool($line["always_display_enclosures"]);
697 $headline_row["author"] = $line["author"];
698 $headline_row["score"] = (int)$line["score"];
701 foreach ($pluginhost->get_hooks($pluginhost::HOOK_RENDER_ARTICLE_API
) as $p) {
702 $headline_row = $p->hook_render_article_api(array("headline" => $headline_row));
705 array_push($headlines, $headline_row);
711 function unsubscribeFeed() {
712 $feed_id = (int) db_escape_string( $_REQUEST["feed_id"]);
714 $result = db_query( "SELECT id FROM ttrss_feeds WHERE
715 id = '$feed_id' AND owner_uid = ".$_SESSION["uid"]);
717 if (db_num_rows($result) != 0) {
718 Pref_Feeds
::remove_feed( $feed_id, $_SESSION["uid"]);
719 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
721 print $this->wrap(self
::STATUS_ERR
, array("error" => "FEED_NOT_FOUND"));
725 function subscribeToFeed() {
726 $feed_url = db_escape_string( $_REQUEST["feed_url"]);
727 $category_id = (int) db_escape_string( $_REQUEST["category_id"]);
728 $login = db_escape_string( $_REQUEST["login"]);
729 $password = db_escape_string( $_REQUEST["password"]);
732 $rc = subscribe_to_feed( $feed_url, $category_id,
733 $login, $password, false);
735 print $this->wrap(self
::STATUS_OK
, array("status" => $rc));
737 print $this->wrap(self
::STATUS_ERR
, array("error" => 'INCORRECT_USAGE'));
741 function getFeedTree() {
742 $include_empty = sql_bool_to_bool($_REQUEST['include_empty']);
744 $pf = new Pref_Feeds( $_REQUEST);
746 $_REQUEST['mode'] = 2;
747 $_REQUEST['force_show_empty'] = $include_empty;
750 $data = $pf->makefeedtree();
751 print $this->wrap(self
::STATUS_OK
, array("categories" => $data));
753 print $this->wrap(self
::STATUS_ERR
, array("error" =>
754 'UNABLE_TO_INSTANTIATE_OBJECT'));
759 // only works for labels or uncategorized for the time being
760 private function isCategoryEmpty($id) {
763 $result = db_query( "SELECT COUNT(*) AS count FROM ttrss_labels2
764 WHERE owner_uid = " . $_SESSION["uid"]);
766 return db_fetch_result($result, 0, "count") == 0;
768 } else if ($id == 0) {
769 $result = db_query( "SELECT COUNT(*) AS count FROM ttrss_feeds
770 WHERE cat_id IS NULL AND owner_uid = " . $_SESSION["uid"]);
772 return db_fetch_result($result, 0, "count") == 0;