]> git.wh0rd.org - tt-rss.git/blobdiff - classes/api.php
api: getHeadlines: add configurable excerpt_length (bump api version)
[tt-rss.git] / classes / api.php
index 2e243d0254d86a3ee231d41bb5e32978897d7865..3c5d084087ba592ef39b9656688ee0830403f78f 100644 (file)
@@ -2,7 +2,7 @@
 
 class API extends Handler {
 
-       const API_LEVEL  = 6;
+       const API_LEVEL  = 11;
 
        const STATUS_OK  = 0;
        const STATUS_ERR = 1;
@@ -14,12 +14,12 @@ class API extends Handler {
                        header("Content-Type: text/json");
 
                        if (!$_SESSION["uid"] && $method != "login" && $method != "isloggedin") {
-                               print $this->wrap(self::STATUS_ERR, array("error" => 'NOT_LOGGED_IN'));
+                               $this->wrap(self::STATUS_ERR, array("error" => 'NOT_LOGGED_IN'));
                                return false;
                        }
 
                        if ($_SESSION["uid"] && $method != "logout" && !get_pref('ENABLE_API_ACCESS')) {
-                               print $this->wrap(self::STATUS_ERR, array("error" => 'API_DISABLED'));
+                               $this->wrap(self::STATUS_ERR, array("error" => 'API_DISABLED'));
                                return false;
                        }
 
@@ -38,12 +38,12 @@ class API extends Handler {
 
        function getVersion() {
                $rv = array("version" => VERSION);
-               print $this->wrap(self::STATUS_OK, $rv);
+               $this->wrap(self::STATUS_OK, $rv);
        }
 
        function getApiLevel() {
                $rv = array("level" => self::API_LEVEL);
-               print $this->wrap(self::STATUS_OK, $rv);
+               $this->wrap(self::STATUS_OK, $rv);
        }
 
        function login() {
@@ -65,33 +65,34 @@ class API extends Handler {
                }
 
                if (!$uid) {
-                       print $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
+                       $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
                        return;
                }
 
                if (get_pref("ENABLE_API_ACCESS", $uid)) {
                        if (authenticate_user($login, $password)) {               // try login with normal password
-                               print $this->wrap(self::STATUS_OK, array("session_id" => session_id(),
+                               $this->wrap(self::STATUS_OK, array("session_id" => session_id(),
                                        "api_level" => self::API_LEVEL));
                        } else if (authenticate_user($login, $password_base64)) { // else try with base64_decoded password
-                               print $this->wrap(self::STATUS_OK,      array("session_id" => session_id(),
+                               $this->wrap(self::STATUS_OK,    array("session_id" => session_id(),
                                        "api_level" => self::API_LEVEL));
                        } else {                                                         // else we are not logged in
-                               print $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
+                               user_error("Failed login attempt for $login from {$_SERVER['REMOTE_ADDR']}", E_USER_WARNING);
+                               $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
                        }
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" => "API_DISABLED"));
+                       $this->wrap(self::STATUS_ERR, array("error" => "API_DISABLED"));
                }
 
        }
 
        function logout() {
                logout_user();
-               print $this->wrap(self::STATUS_OK, array("status" => "OK"));
+               $this->wrap(self::STATUS_OK, array("status" => "OK"));
        }
 
        function isLoggedIn() {
-               print $this->wrap(self::STATUS_OK, array("status" => $_SESSION["uid"] != ''));
+               $this->wrap(self::STATUS_OK, array("status" => $_SESSION["uid"] != ''));
        }
 
        function getUnread() {
@@ -99,15 +100,15 @@ class API extends Handler {
                $is_cat = $this->dbh->escape_string($_REQUEST["is_cat"]);
 
                if ($feed_id) {
-                       print $this->wrap(self::STATUS_OK, array("unread" => getFeedUnread($feed_id, $is_cat)));
+                       $this->wrap(self::STATUS_OK, array("unread" => getFeedUnread($feed_id, $is_cat)));
                } else {
-                       print $this->wrap(self::STATUS_OK, array("unread" => getGlobalUnread()));
+                       $this->wrap(self::STATUS_OK, array("unread" => getGlobalUnread()));
                }
        }
 
        /* Method added for ttrss-reader for Android */
        function getCounters() {
-               print $this->wrap(self::STATUS_OK, getAllCounters());
+               $this->wrap(self::STATUS_OK, getAllCounters());
        }
 
        function getFeeds() {
@@ -119,7 +120,7 @@ class API extends Handler {
 
                $feeds = $this->api_get_feeds($cat_id, $unread_only, $limit, $offset, $include_nested);
 
-               print $this->wrap(self::STATUS_OK, $feeds);
+               $this->wrap(self::STATUS_OK, $feeds);
        }
 
        function getCategories() {
@@ -176,7 +177,7 @@ class API extends Handler {
                        }
                }
 
-               print $this->wrap(self::STATUS_OK, $cats);
+               $this->wrap(self::STATUS_OK, $cats);
        }
 
        function getHeadlines() {
@@ -197,12 +198,21 @@ class API extends Handler {
                        $include_attachments = sql_bool_to_bool($_REQUEST["include_attachments"]);
                        $since_id = (int)$this->dbh->escape_string($_REQUEST["since_id"]);
                        $include_nested = sql_bool_to_bool($_REQUEST["include_nested"]);
-                       $sanitize_content = true;
+                       $sanitize_content = !isset($_REQUEST["sanitize"]) ||
+                               sql_bool_to_bool($_REQUEST["sanitize"]);
+                       $force_update = sql_bool_to_bool($_REQUEST["force_update"]);
+                       $has_sandbox = sql_bool_to_bool($_REQUEST["has_sandbox"]);
+                       $excerpt_length = (int)$this->dbh->escape_string($_REQUEST["excerpt_length"]);
+
+                       $_SESSION['hasSandbox'] = $has_sandbox;
 
                        $override_order = false;
                        switch ($_REQUEST["order_by"]) {
+                               case "title":
+                                       $override_order = "ttrss_entries.title";
+                                       break;
                                case "date_reverse":
-                                       $override_order = "date_entered, updated";
+                                       $override_order = "score DESC, date_entered, updated";
                                        break;
                                case "feed_dates":
                                        $override_order = "updated DESC";
@@ -217,11 +227,11 @@ class API extends Handler {
                        $headlines = $this->api_get_headlines($feed_id, $limit, $offset,
                                $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $override_order,
                                $include_attachments, $since_id, $search, $search_mode,
-                               $include_nested, $sanitize_content);
+                               $include_nested, $sanitize_content, $force_update, $excerpt_length);
 
-                       print $this->wrap(self::STATUS_OK, $headlines);
+                       $this->wrap(self::STATUS_OK, $headlines);
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
+                       $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
                }
        }
 
@@ -293,11 +303,11 @@ class API extends Handler {
                                }
                        }
 
-                       print $this->wrap(self::STATUS_OK, array("status" => "OK",
+                       $this->wrap(self::STATUS_OK, array("status" => "OK",
                                "updated" => $num_updated));
 
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
+                       $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
                }
 
        }
@@ -306,54 +316,60 @@ class API extends Handler {
 
                $article_id = join(",", array_filter(explode(",", $this->dbh->escape_string($_REQUEST["article_id"])), is_numeric));
 
-               $query = "SELECT id,title,link,content,cached_content,feed_id,comments,int_id,
-                       marked,unread,published,score,
-                       ".SUBSTRING_FOR_DATE."(updated,1,16) as updated,
-                       author,(SELECT title FROM ttrss_feeds WHERE id = feed_id) AS feed_title
-                       FROM ttrss_entries,ttrss_user_entries
-                       WHERE   id IN ($article_id) AND ref_id = id AND owner_uid = " .
-                               $_SESSION["uid"] ;
+               if ($article_id) {
 
-               $result = $this->dbh->query($query);
+                       $query = "SELECT id,title,link,content,feed_id,comments,int_id,
+                               marked,unread,published,score,note,lang,
+                               ".SUBSTRING_FOR_DATE."(updated,1,16) as updated,
+                               author,(SELECT title FROM ttrss_feeds WHERE id = feed_id) AS feed_title
+                               FROM ttrss_entries,ttrss_user_entries
+                               WHERE   id IN ($article_id) AND ref_id = id AND owner_uid = " .
+                                       $_SESSION["uid"] ;
 
-               $articles = array();
+                       $result = $this->dbh->query($query);
 
-               if ($this->dbh->num_rows($result) != 0) {
+                       $articles = array();
 
-                       while ($line = $this->dbh->fetch_assoc($result)) {
-
-                               $attachments = get_article_enclosures($line['id']);
-
-                               $article = array(
-                                       "id" => $line["id"],
-                                       "title" => $line["title"],
-                                       "link" => $line["link"],
-                                       "labels" => get_article_labels($line['id']),
-                                       "unread" => sql_bool_to_bool($line["unread"]),
-                                       "marked" => sql_bool_to_bool($line["marked"]),
-                                       "published" => sql_bool_to_bool($line["published"]),
-                                       "comments" => $line["comments"],
-                                       "author" => $line["author"],
-                                       "updated" => (int) strtotime($line["updated"]),
-                                       "content" => $line["cached_content"] != "" ? $line["cached_content"] : $line["content"],
-                                       "feed_id" => $line["feed_id"],
-                                       "attachments" => $attachments,
-                                       "score" => (int)$line["score"],
-                                       "feed_title" => $line["feed_title"]
-                               );
+                       if ($this->dbh->num_rows($result) != 0) {
 
-                               foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_RENDER_ARTICLE_API) as $p) {
-                                       $article = $p->hook_render_article_api(array("article" => $article));
-                               }
+                               while ($line = $this->dbh->fetch_assoc($result)) {
+
+                                       $attachments = get_article_enclosures($line['id']);
+
+                                       $article = array(
+                                               "id" => $line["id"],
+                                               "title" => $line["title"],
+                                               "link" => $line["link"],
+                                               "labels" => get_article_labels($line['id']),
+                                               "unread" => sql_bool_to_bool($line["unread"]),
+                                               "marked" => sql_bool_to_bool($line["marked"]),
+                                               "published" => sql_bool_to_bool($line["published"]),
+                                               "comments" => $line["comments"],
+                                               "author" => $line["author"],
+                                               "updated" => (int) strtotime($line["updated"]),
+                                               "content" => $line["content"],
+                                               "feed_id" => $line["feed_id"],
+                                               "attachments" => $attachments,
+                                               "score" => (int)$line["score"],
+                                               "feed_title" => $line["feed_title"],
+                                               "note" => $line["note"],
+                                               "lang" => $line["lang"]
+                                       );
 
+                                       foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_RENDER_ARTICLE_API) as $p) {
+                                               $article = $p->hook_render_article_api(array("article" => $article));
+                                       }
 
-                               array_push($articles, $article);
 
-                       }
-               }
+                                       array_push($articles, $article);
 
-               print $this->wrap(self::STATUS_OK, $articles);
+                               }
+                       }
 
+                       $this->wrap(self::STATUS_OK, $articles);
+               } else {
+                       $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
+               }
        }
 
        function getConfig() {
@@ -370,7 +386,7 @@ class API extends Handler {
 
                $config["num_feeds"] = (int)$num_feeds;
 
-               print $this->wrap(self::STATUS_OK, $config);
+               $this->wrap(self::STATUS_OK, $config);
        }
 
        function updateFeed() {
@@ -380,7 +396,7 @@ class API extends Handler {
 
                update_rss_feed($feed_id, true);
 
-               print $this->wrap(self::STATUS_OK, array("status" => "OK"));
+               $this->wrap(self::STATUS_OK, array("status" => "OK"));
        }
 
        function catchupFeed() {
@@ -389,13 +405,13 @@ class API extends Handler {
 
                catchup_feed($feed_id, $is_cat);
 
-               print $this->wrap(self::STATUS_OK, array("status" => "OK"));
+               $this->wrap(self::STATUS_OK, array("status" => "OK"));
        }
 
        function getPref() {
                $pref_name = $this->dbh->escape_string($_REQUEST["pref_name"]);
 
-               print $this->wrap(self::STATUS_OK, array("value" => get_pref($pref_name)));
+               $this->wrap(self::STATUS_OK, array("value" => get_pref($pref_name)));
        }
 
        function getLabels() {
@@ -418,21 +434,21 @@ class API extends Handler {
 
                        $checked = false;
                        foreach ($article_labels as $al) {
-                               if ($al[0] == $line['id']) {
+                               if (feed_to_label_id($al[0]) == $line['id']) {
                                        $checked = true;
                                        break;
                                }
                        }
 
                        array_push($rv, array(
-                               "id" => (int)$line['id'],
+                               "id" => (int)label_to_feed_id($line['id']),
                                "caption" => $line['caption'],
                                "fg_color" => $line['fg_color'],
                                "bg_color" => $line['bg_color'],
                                "checked" => $checked));
                }
 
-               print $this->wrap(self::STATUS_OK, $rv);
+               $this->wrap(self::STATUS_OK, $rv);
        }
 
        function setArticleLabel() {
@@ -442,7 +458,7 @@ class API extends Handler {
                $assign = (bool) $this->dbh->escape_string($_REQUEST['assign']) == "true";
 
                $label = $this->dbh->escape_string(label_find_caption(
-                       $label_id, $_SESSION["uid"]));
+                       feed_to_label_id($label_id), $_SESSION["uid"]));
 
                $num_updated = 0;
 
@@ -460,7 +476,7 @@ class API extends Handler {
                        }
                }
 
-               print $this->wrap(self::STATUS_OK, array("status" => "OK",
+               $this->wrap(self::STATUS_OK, array("status" => "OK",
                        "updated" => $num_updated));
 
        }
@@ -471,10 +487,10 @@ class API extends Handler {
                if ($plugin && method_exists($plugin, $method)) {
                        $reply = $plugin->$method();
 
-                       print $this->wrap($reply[0], $reply[1]);
+                       $this->wrap($reply[0], $reply[1]);
 
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD', "method" => $method));
+                       $this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD', "method" => $method));
                }
        }
 
@@ -484,9 +500,9 @@ class API extends Handler {
                $content = $this->dbh->escape_string(strip_tags($_REQUEST["content"]));
 
                if (Article::create_published_article($title, $url, $content, "", $_SESSION["uid"])) {
-                       print $this->wrap(self::STATUS_OK, array("status" => 'OK'));
+                       $this->wrap(self::STATUS_OK, array("status" => 'OK'));
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" => 'Publishing failed'));
+                       $this->wrap(self::STATUS_ERR, array("error" => 'Publishing failed'));
                }
        }
 
@@ -506,7 +522,7 @@ class API extends Handler {
                                        if ($unread || !$unread_only) {
 
                                                $row = array(
-                                                               "id" => $cv["id"],
+                                                               "id" => (int) $cv["id"],
                                                                "title" => $cv["description"],
                                                                "unread" => $cv["counter"],
                                                                "cat_id" => -2,
@@ -552,7 +568,7 @@ class API extends Handler {
 
                                        if ($unread || !$unread_only) {
                                                $row = array(
-                                                               "id" => $line["id"],
+                                                               "id" => (int) $line["id"],
                                                                "title" => $line["title"],
                                                                "unread" => $unread,
                                                                "is_cat" => true,
@@ -621,7 +637,28 @@ class API extends Handler {
                                $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $order,
                                $include_attachments, $since_id,
                                $search = "", $search_mode = "",
-                               $include_nested = false, $sanitize_content = true) {
+                               $include_nested = false, $sanitize_content = true, $force_update = false, $excerpt_length = 100) {
+
+                       if ($force_update && $feed_id > 0 && is_numeric($feed_id)) {
+                               // Update the feed if required with some basic flood control
+
+                               $result = db_query(
+                                       "SELECT cache_images,".SUBSTRING_FOR_DATE."(last_updated,1,19) AS last_updated
+                                               FROM ttrss_feeds WHERE id = '$feed_id'");
+
+                               if (db_num_rows($result) != 0) {
+                                       $last_updated = strtotime(db_fetch_result($result, 0, "last_updated"));
+                                       $cache_images = sql_bool_to_bool(db_fetch_result($result, 0, "cache_images"));
+
+                                       if (!$cache_images && time() - $last_updated > 120) {
+                                               include "rssfuncs.php";
+                                               update_rss_feed($feed_id, true, true);
+                                       } else {
+                                               db_query("UPDATE ttrss_feeds SET last_updated = '1970-01-01', last_update_started = '1970-01-01'
+                                                       WHERE id = '$feed_id'");
+                                       }
+                               }
+                       }
 
                        $qfh_ret = queryFeedHeadlines($feed_id, $limit,
                                $view_mode, $is_cat, $search, $search_mode,
@@ -633,11 +670,31 @@ class API extends Handler {
                        $headlines = array();
 
                        while ($line = db_fetch_assoc($result)) {
+                               $line["content_preview"] = truncate_string(strip_tags($line["content"]), $excerpt_length);
+                               foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_QUERY_HEADLINES) as $p) {
+                                       $line = $p->hook_query_headlines($line, $excerpt_length, true);
+                               }
+
                                $is_updated = ($line["last_read"] == "" &&
                                        ($line["unread"] != "t" && $line["unread"] != "1"));
 
                                $tags = explode(",", $line["tag_cache"]);
-                               $labels = json_decode($line["label_cache"], true);
+
+                               $label_cache = $line["label_cache"];
+                               $labels = false;
+
+                               if ($label_cache) {
+                                       $label_cache = json_decode($label_cache, true);
+
+                                       if ($label_cache) {
+                                               if ($label_cache["no-labels"] == 1)
+                                                       $labels = array();
+                                               else
+                                                       $labels = $label_cache;
+                                       }
+                               }
+
+                               if (!is_array($labels)) $labels = get_article_labels($line["id"]);
 
                                //if (!$tags) $tags = get_article_tags($line["id"]);
                                //if (!$labels) $labels = get_article_labels($line["id"]);
@@ -655,28 +712,22 @@ class API extends Handler {
                                                "tags" => $tags,
                                        );
 
-                                       if ($include_attachments)
-                                               $headline_row['attachments'] = get_article_enclosures(
-                                                       $line['id']);
+                               if ($include_attachments)
+                                       $headline_row['attachments'] = get_article_enclosures(
+                                               $line['id']);
 
-                               if ($show_excerpt) {
-                                       $excerpt = truncate_string(strip_tags($line["content_preview"]), 100);
-                                       $headline_row["excerpt"] = $excerpt;
-                               }
+                               if ($show_excerpt)
+                                       $headline_row["excerpt"] = $line["content_preview"];
 
                                if ($show_content) {
 
-                                       if ($line["cached_content"] != "") {
-                                               $line["content_preview"] =& $line["cached_content"];
-                                       }
-
                                        if ($sanitize_content) {
                                                $headline_row["content"] = sanitize(
-                                                       $line["content_preview"],
+                                                       $line["content"],
                                                        sql_bool_to_bool($line['hide_images']),
-                                                       false, $line["site_url"]);
+                                                       false, $line["site_url"], false, $line["id"]);
                                        } else {
-                                               $headline_row["content"] = $line["content_preview"];
+                                               $headline_row["content"] = $line["content"];
                                        }
                                }
 
@@ -685,7 +736,8 @@ class API extends Handler {
 
                                $headline_row["labels"] = $labels;
 
-                               $headline_row["feed_title"] = $line["feed_title"];
+                               $headline_row["feed_title"] = $line["feed_title"] ? $line["feed_title"] :
+                                       $feed_title;
 
                                $headline_row["comments_count"] = (int)$line["num_comments"];
                                $headline_row["comments_link"] = $line["comments"];
@@ -693,7 +745,10 @@ class API extends Handler {
                                $headline_row["always_display_attachments"] = sql_bool_to_bool($line["always_display_enclosures"]);
 
                                $headline_row["author"] = $line["author"];
+
                                $headline_row["score"] = (int)$line["score"];
+                               $headline_row["note"] = $line["note"];
+                               $headline_row["lang"] = $line["lang"];
 
                                foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_RENDER_ARTICLE_API) as $p) {
                                        $headline_row = $p->hook_render_article_api(array("headline" => $headline_row));
@@ -713,9 +768,9 @@ class API extends Handler {
 
                if ($this->dbh->num_rows($result) != 0) {
                        Pref_Feeds::remove_feed($feed_id, $_SESSION["uid"]);
-                       print $this->wrap(self::STATUS_OK, array("status" => "OK"));
+                       $this->wrap(self::STATUS_OK, array("status" => "OK"));
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" => "FEED_NOT_FOUND"));
+                       $this->wrap(self::STATUS_ERR, array("error" => "FEED_NOT_FOUND"));
                }
        }
 
@@ -726,12 +781,11 @@ class API extends Handler {
                $password = $this->dbh->escape_string($_REQUEST["password"]);
 
                if ($feed_url) {
-                       $rc = subscribe_to_feed($feed_url, $category_id,
-                               $login, $password, false);
+                       $rc = subscribe_to_feed($feed_url, $category_id, $login, $password);
 
-                       print $this->wrap(self::STATUS_OK, array("status" => $rc));
+                       $this->wrap(self::STATUS_OK, array("status" => $rc));
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
+                       $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
                }
        }
 
@@ -745,9 +799,9 @@ class API extends Handler {
 
                if ($pf){
                        $data = $pf->makefeedtree();
-                       print $this->wrap(self::STATUS_OK, array("categories" => $data));
+                       $this->wrap(self::STATUS_OK, array("categories" => $data));
                } else {
-                       print $this->wrap(self::STATUS_ERR, array("error" =>
+                       $this->wrap(self::STATUS_ERR, array("error" =>
                                'UNABLE_TO_INSTANTIATE_OBJECT'));
                }