]> git.wh0rd.org - tt-rss.git/blobdiff - classes/api.php
pref/feeds: start user category ordering from 1
[tt-rss.git] / classes / api.php
index 30bde1ffe304469971ec2f147825bf54f451b754..00e58ee502b1d31c502680b57ce748cd129e1743 100644 (file)
@@ -1,8 +1,7 @@
 <?php
-
 class API extends Handler {
 
-       const API_LEVEL  = 11;
+       const API_LEVEL  = 14;
 
        const STATUS_OK  = 0;
        const STATUS_ERR = 1;
@@ -102,13 +101,13 @@ class API extends Handler {
                if ($feed_id) {
                        $this->wrap(self::STATUS_OK, array("unread" => getFeedUnread($feed_id, $is_cat)));
                } else {
-                       $this->wrap(self::STATUS_OK, array("unread" => getGlobalUnread()));
+                       $this->wrap(self::STATUS_OK, array("unread" => Feeds::getGlobalUnread()));
                }
        }
 
        /* Method added for ttrss-reader for Android */
        function getCounters() {
-               $this->wrap(self::STATUS_OK, getAllCounters());
+               $this->wrap(self::STATUS_OK, Counters::getAllCounters());
        }
 
        function getFeeds() {
@@ -153,7 +152,7 @@ class API extends Handler {
                                $unread = getFeedUnread($line["id"], true);
 
                                if ($enable_nested)
-                                       $unread += getCategoryChildrenUnread($line["id"]);
+                                       $unread += Feeds::getCategoryChildrenUnread($line["id"]);
 
                                if ($unread || !$unread_only) {
                                        array_push($cats, array("id" => $line["id"],
@@ -171,7 +170,7 @@ class API extends Handler {
 
                                if ($unread || !$unread_only) {
                                        array_push($cats, array("id" => $cat_id,
-                                               "title" => getCategoryTitle($cat_id),
+                                               "title" => Feeds::getCategoryTitle($cat_id),
                                                "unread" => $unread));
                                }
                        }
@@ -184,6 +183,8 @@ class API extends Handler {
                $feed_id = $this->dbh->escape_string($_REQUEST["feed_id"]);
                if ($feed_id != "") {
 
+                       if (is_numeric($feed_id)) $feed_id = (int) $feed_id;
+
                        $limit = (int)$this->dbh->escape_string($_REQUEST["limit"]);
 
                        if (!$limit || $limit >= 200) $limit = 200;
@@ -203,9 +204,13 @@ class API extends Handler {
                        $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"]);
+                       $check_first_id = (int)$this->dbh->escape_string($_REQUEST["check_first_id"]);
+                       $include_header = sql_bool_to_bool($_REQUEST["include_header"]);
 
                        $_SESSION['hasSandbox'] = $has_sandbox;
 
+                       $skip_first_id_check = false;
+
                        $override_order = false;
                        switch ($_REQUEST["order_by"]) {
                                case "title":
@@ -213,6 +218,7 @@ class API extends Handler {
                                        break;
                                case "date_reverse":
                                        $override_order = "score DESC, date_entered, updated";
+                                       $skip_first_id_check = true;
                                        break;
                                case "feed_dates":
                                        $override_order = "updated DESC";
@@ -223,12 +229,16 @@ class API extends Handler {
 
                        $search = $this->dbh->escape_string($_REQUEST["search"]);
 
-                       $headlines = $this->api_get_headlines($feed_id, $limit, $offset,
+                       list($headlines, $headlines_header) = $this->api_get_headlines($feed_id, $limit, $offset,
                                $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $override_order,
                                $include_attachments, $since_id, $search,
-                               $include_nested, $sanitize_content, $force_update, $excerpt_length);
+                               $include_nested, $sanitize_content, $force_update, $excerpt_length, $check_first_id, $skip_first_id_check);
 
-                       $this->wrap(self::STATUS_OK, $headlines);
+                       if ($include_header) {
+                               $this->wrap(self::STATUS_OK, array($headlines_header, $headlines));
+                       } else {
+                               $this->wrap(self::STATUS_OK, $headlines);
+                       }
                } else {
                        $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
                }
@@ -287,18 +297,7 @@ class API extends Handler {
                                        WHERE ref_id IN ($article_ids)");
 
                                while ($line = $this->dbh->fetch_assoc($result)) {
-                                       ccache_update($line["feed_id"], $_SESSION["uid"]);
-                               }
-                       }
-
-                       if ($num_updated > 0 && $field == "published") {
-                               if (PUBSUBHUBBUB_HUB) {
-                                       $rss_link = get_self_url_prefix() .
-                                               "/public.php?op=rss&id=-2&key=" .
-                                               get_feed_access_key(-2, false);
-
-                                       $p = new Publisher(PUBSUBHUBBUB_HUB);
-                                       $pubsub_result = $p->publish_update($rss_link);
+                                       CCache::update($line["feed_id"], $_SESSION["uid"]);
                                }
                        }
 
@@ -314,13 +313,17 @@ class API extends Handler {
        function getArticle() {
 
                $article_id = join(",", array_filter(explode(",", $this->dbh->escape_string($_REQUEST["article_id"])), is_numeric));
+               $sanitize_content = !isset($_REQUEST["sanitize"]) ||
+                       sql_bool_to_bool($_REQUEST["sanitize"]);
 
                if ($article_id) {
 
-                       $query = "SELECT id,title,link,content,feed_id,comments,int_id,
+                       $query = "SELECT id,guid,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
+                               author,(SELECT title FROM ttrss_feeds WHERE id = feed_id) AS feed_title,
+                               (SELECT site_url FROM ttrss_feeds WHERE id = feed_id) AS site_url,
+                               (SELECT hide_images FROM ttrss_feeds WHERE id = feed_id) AS hide_images
                                FROM ttrss_entries,ttrss_user_entries
                                WHERE   id IN ($article_id) AND ref_id = id AND owner_uid = " .
                                        $_SESSION["uid"] ;
@@ -333,20 +336,20 @@ class API extends Handler {
 
                                while ($line = $this->dbh->fetch_assoc($result)) {
 
-                                       $attachments = get_article_enclosures($line['id']);
+                                       $attachments = Article::get_article_enclosures($line['id']);
 
                                        $article = array(
                                                "id" => $line["id"],
+                                               "guid" => $line["guid"],
                                                "title" => $line["title"],
                                                "link" => $line["link"],
-                                               "labels" => get_article_labels($line['id']),
+                                               "labels" => Article::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"],
@@ -355,6 +358,15 @@ class API extends Handler {
                                                "lang" => $line["lang"]
                                        );
 
+                                       if ($sanitize_content) {
+                                               $article["content"] = sanitize(
+                                                       $line["content"],
+                                                       sql_bool_to_bool($line['hide_images']),
+                                                       false, $line["site_url"], false, $line["id"]);
+                                       } else {
+                                               $article["content"] = $line["content"];
+                                       }
+
                                        foreach (PluginHost::getInstance()->get_hooks(PluginHost::HOOK_RENDER_ARTICLE_API) as $p) {
                                                $article = $p->hook_render_article_api(array("article" => $article));
                                        }
@@ -389,11 +401,11 @@ class API extends Handler {
        }
 
        function updateFeed() {
-               require_once "include/rssfuncs.php";
-
                $feed_id = (int) $this->dbh->escape_string($_REQUEST["feed_id"]);
 
-               update_rss_feed($feed_id, true);
+               if (!ini_get("open_basedir")) {
+                       RSSUtils::update_rss_feed($feed_id);
+               }
 
                $this->wrap(self::STATUS_OK, array("status" => "OK"));
        }
@@ -402,7 +414,7 @@ class API extends Handler {
                $feed_id = $this->dbh->escape_string($_REQUEST["feed_id"]);
                $is_cat = $this->dbh->escape_string($_REQUEST["is_cat"]);
 
-               catchup_feed($feed_id, $is_cat);
+               Feeds::catchup_feed($feed_id, $is_cat);
 
                $this->wrap(self::STATUS_OK, array("status" => "OK"));
        }
@@ -425,7 +437,7 @@ class API extends Handler {
                        WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
 
                if ($article_id)
-                       $article_labels = get_article_labels($article_id);
+                       $article_labels = Article::get_article_labels($article_id);
                else
                        $article_labels = array();
 
@@ -433,14 +445,14 @@ class API extends Handler {
 
                        $checked = false;
                        foreach ($article_labels as $al) {
-                               if (feed_to_label_id($al[0]) == $line['id']) {
+                               if (Labels::feed_to_label_id($al[0]) == $line['id']) {
                                        $checked = true;
                                        break;
                                }
                        }
 
                        array_push($rv, array(
-                               "id" => (int)label_to_feed_id($line['id']),
+                               "id" => (int)Labels::label_to_feed_id($line['id']),
                                "caption" => $line['caption'],
                                "fg_color" => $line['fg_color'],
                                "bg_color" => $line['bg_color'],
@@ -454,10 +466,10 @@ class API extends Handler {
 
                $article_ids = array_filter(explode(",", $this->dbh->escape_string($_REQUEST["article_ids"])), is_numeric);
                $label_id = (int) $this->dbh->escape_string($_REQUEST['label_id']);
-               $assign = (bool) $this->dbh->escape_string($_REQUEST['assign']) == "true";
+               $assign = (bool) ($this->dbh->escape_string($_REQUEST['assign']) == "true");
 
-               $label = $this->dbh->escape_string(label_find_caption(
-                       feed_to_label_id($label_id), $_SESSION["uid"]));
+               $label = $this->dbh->escape_string(Labels::find_caption(
+                       Labels::feed_to_label_id($label_id), $_SESSION["uid"]));
 
                $num_updated = 0;
 
@@ -466,9 +478,9 @@ class API extends Handler {
                        foreach ($article_ids as $id) {
 
                                if ($assign)
-                                       label_add_article($id, $label, $_SESSION["uid"]);
+                                       Labels::add_article($id, $label, $_SESSION["uid"]);
                                else
-                                       label_remove_article($id, $label, $_SESSION["uid"]);
+                                       Labels::remove_article($id, $label, $_SESSION["uid"]);
 
                                ++$num_updated;
 
@@ -512,7 +524,7 @@ class API extends Handler {
                        /* Labels */
 
                        if ($cat_id == -4 || $cat_id == -2) {
-                               $counters = getLabelCounters(true);
+                               $counters = Counters::getLabelCounters(true);
 
                                foreach (array_values($counters) as $cv) {
 
@@ -539,7 +551,7 @@ class API extends Handler {
                                        $unread = getFeedUnread($i);
 
                                        if ($unread || !$unread_only) {
-                                               $title = getFeedTitle($i);
+                                               $title = Feeds::getFeedTitle($i);
 
                                                $row = array(
                                                                "id" => $i,
@@ -557,13 +569,13 @@ class API extends Handler {
 
                        if ($include_nested && $cat_id) {
                                $result = db_query("SELECT
-                                       id, title FROM ttrss_feed_categories
+                                       id, title, order_id FROM ttrss_feed_categories
                                        WHERE parent_cat = '$cat_id' AND owner_uid = " . $_SESSION["uid"] .
                                " ORDER BY id, title");
 
                                while ($line = db_fetch_assoc($result)) {
                                        $unread = getFeedUnread($line["id"], true) +
-                                               getCategoryChildrenUnread($line["id"]);
+                                               Feeds::getCategoryChildrenUnread($line["id"]);
 
                                        if ($unread || !$unread_only) {
                                                $row = array(
@@ -571,6 +583,7 @@ class API extends Handler {
                                                                "title" => $line["title"],
                                                                "unread" => $unread,
                                                                "is_cat" => true,
+                                "order_id" => (int) $line["order_id"]
                                                        );
                                                array_push($feeds, $row);
                                        }
@@ -632,10 +645,14 @@ class API extends Handler {
                return $feeds;
        }
 
+       /**
+        * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+        */
        static function api_get_headlines($feed_id, $limit, $offset,
                                $filter, $is_cat, $show_excerpt, $show_content, $view_mode, $order,
                                $include_attachments, $since_id,
-                               $search = "", $include_nested = false, $sanitize_content = true, $force_update = false, $excerpt_length = 100) {
+                               $search = "", $include_nested = false, $sanitize_content = true,
+                               $force_update = false, $excerpt_length = 100, $check_first_id = false, $skip_first_id_check = false) {
 
                        if ($force_update && $feed_id > 0 && is_numeric($feed_id)) {
                                // Update the feed if required with some basic flood control
@@ -649,8 +666,7 @@ class API extends Handler {
                                        $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);
+                                               RSSUtils::update_rss_feed($feed_id, true);
                                        } else {
                                                db_query("UPDATE ttrss_feeds SET last_updated = '1970-01-01', last_update_started = '1970-01-01'
                                                        WHERE id = '$feed_id'");
@@ -658,15 +674,6 @@ class API extends Handler {
                                }
                        }
 
-                       /*$qfh_ret = queryFeedHeadlines($feed_id, $limit,
-                               $view_mode, $is_cat, $search, false,
-                               $order, $offset, 0, false, $since_id, $include_nested);*/
-
-                       //function queryFeedHeadlines($feed, $limit,
-                       // $view_mode, $cat_view, $search, $search_mode,
-                       // $override_order = false, $offset = 0, $owner_uid = 0, $filter = false, $since_id = 0, $include_children = false,
-                       // $ignore_vfeed_group = false, $override_strategy = false, $override_vfeed = false, $start_ts = false, $check_top_id = false) {
-
                        $params = array(
                                "feed" => $feed_id,
                                "limit" => $limit,
@@ -677,16 +684,24 @@ class API extends Handler {
                                "offset" => $offset,
                                "since_id" => $since_id,
                                "include_children" => $include_nested,
+                               "check_first_id" => $check_first_id,
+                               "skip_first_id_check" => $skip_first_id_check
                        );
 
-                       $qfh_ret = queryFeedHeadlines($params);
+                       $qfh_ret = Feeds::queryFeedHeadlines($params);
 
                        $result = $qfh_ret[0];
                        $feed_title = $qfh_ret[1];
+                       $first_id = $qfh_ret[6];
 
                        $headlines = array();
 
-                       if (is_resource($result)) {
+                       $headlines_header = array(
+                               'id' => $feed_id,
+                               'first_id' => $first_id,
+                               'is_cat' => $is_cat);
+
+                       if (!is_numeric($result)) {
                                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) {
@@ -712,13 +727,11 @@ class API extends Handler {
                                                }
                                        }
 
-                                       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"]);
+                                       if (!is_array($labels)) $labels = Article::get_article_labels($line["id"]);
 
                                        $headline_row = array(
                                                "id" => (int)$line["id"],
+                                               "guid" => $line["guid"],
                                                "unread" => sql_bool_to_bool($line["unread"]),
                                                "marked" => sql_bool_to_bool($line["marked"]),
                                                "published" => sql_bool_to_bool($line["published"]),
@@ -731,7 +744,7 @@ class API extends Handler {
                                        );
 
                                        if ($include_attachments)
-                                               $headline_row['attachments'] = get_article_enclosures(
+                                               $headline_row['attachments'] = Article::get_article_enclosures(
                                                        $line['id']);
 
                                        if ($show_excerpt)
@@ -774,9 +787,11 @@ class API extends Handler {
 
                                        array_push($headlines, $headline_row);
                                }
+                       } else if (is_numeric($result) && $result == -1) {
+                               $headlines_header['first_id_changed'] = true;
                        }
 
-                       return $headlines;
+                       return array($headlines, $headlines_header);
        }
 
        function unsubscribeFeed() {
@@ -800,7 +815,7 @@ class API extends Handler {
                $password = $this->dbh->escape_string($_REQUEST["password"]);
 
                if ($feed_url) {
-                       $rc = subscribe_to_feed($feed_url, $category_id, $login, $password);
+                       $rc = Feeds::subscribe_to_feed($feed_url, $category_id, $login, $password);
 
                        $this->wrap(self::STATUS_OK, array("status" => $rc));
                } else {
@@ -848,5 +863,3 @@ class API extends Handler {
 
 
 }
-
-?>