Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- <?php
- // v1.4.5
- class FeverAPI extends Handler {
- const API_LEVEL = 3;
- const STATUS_OK = 1;
- const STATUS_ERR = 0;
- // debugging only functions with JSON
- const DEBUG = false; // enable if you need some debug output in your tinytinyrss root
- const DEBUG_USER = 0; // your user id you need to debug - look it up in your mysql database and set it to a value bigger than 0
- const DEBUG_FILE = './debug_fever.txt'; // the file for debugging output
- private $xml;
- // always include api_version, status as 'auth'
- // output json/xml
- function wrap($status, $reply)
- {
- $arr = array("api_version" => self::API_LEVEL,
- "auth" => $status);
- if ($status == self::STATUS_OK)
- {
- $arr["last_refreshed_on_time"] = $this->lastRefreshedOnTime()."";
- if (!empty($reply) && is_array($reply))
- $arr = array_merge($arr, $reply);
- }
- if ($this->xml)
- {
- print $this->array_to_xml($arr);
- }
- else
- {
- print json_encode($arr);
- if (self::DEBUG) {
- // debug output
- file_put_contents(self::DEBUG_FILE,'answer : '.json_encode($arr)."\n",FILE_APPEND);
- }
- }
- }
- // fever supports xml wrapped in <response> tags
- private function array_to_xml($array, $container = 'response', $is_root = true)
- {
- if (!is_array($array)) return array_to_xml(array($array));
- $xml = '';
- if ($is_root)
- {
- $xml .= '<?xml version="1.0" encoding="utf-8"?>';
- $xml .= "<{$container}>";
- }
- foreach($array as $key => $value)
- {
- // make sure key is a string
- $elem = $key;
- if (!is_string($key) && !empty($container))
- {
- $elem = $container;
- }
- $xml .= "<{$elem}>";
- if (is_array($value))
- {
- if (array_keys($value) !== array_keys(array_keys($value)))
- {
- $xml .= array_to_xml($value, '', false);
- }
- else
- {
- $xml .= array_to_xml($value, r('/s$/', '', $elem), false);
- }
- }
- else
- {
- $xml .= (htmlspecialchars($value, ENT_COMPAT, 'ISO-8859-1') != $value) ? "<![CDATA[{$value}]]>" : $value;
- }
- $xml .= "</{$elem}>";
- }
- if ($is_root)
- {
- $xml .= "</{$container}>";
- }
- return preg_replace('/[\x00-\x1F\x7F]/', '', $xml);
- }
- // every authenticated method includes last_refreshed_on_time
- private function lastRefreshedOnTime()
- {
- $result = $this->dbh->query("SELECT last_updated
- FROM ttrss_feeds
- WHERE owner_uid = " . $_SESSION["uid"] . "
- ORDER BY last_updated DESC");
- if ($this->dbh->num_rows($result) > 0)
- {
- $last_refreshed_on_time = strtotime($this->dbh->fetch_result($result, 0, "last_updated"));
- }
- else
- {
- $last_refreshed_on_time = 0;
- }
- return $last_refreshed_on_time;
- }
- // find the user in the db with a particular api key
- private function setUser()
- {
- $apikey = isset($_REQUEST["api_key"])?$_REQUEST["api_key"]:'';
- // here comes Mr.Reader special API for logging in
- if ((strlen($apikey)==0)&&
- (isset($_REQUEST["action"]))&&
- ($_REQUEST["action"]=='login')&&
- (isset($_REQUEST["email"]))&&
- (isset($_REQUEST["password"]))) {
- $email = $_REQUEST["email"];
- $password = $_REQUEST["password"];
- $apikey = strtoupper(md5($email.":".$password));
- setcookie('fever_auth',$apikey,time()+60*60*24*30);
- if (self::DEBUG) {
- // debug output
- $output = array();
- $output['email'] = $email;
- $output['apikey'] = $apikey;
- file_put_contents(self::DEBUG_FILE,'auth POST: '.json_encode($output)."\n",FILE_APPEND);
- }
- }
- if ((strlen($apikey)==0)&&isset($_COOKIE['fever_auth'])) { // override for Mr.Reader when doing some stuff
- $apikey = $_COOKIE['fever_auth'];
- }
- if (strlen($apikey)>0)
- {
- $result = $this->dbh->query("SELECT owner_uid
- FROM ttrss_plugin_storage
- WHERE content = '".db_escape_string('a:1:{s:8:"password";s:32:"'.strtolower($apikey).'";}') . "'");
- if ($this->dbh->num_rows($result) > 0)
- {
- $_SESSION["uid"] = $this->dbh->fetch_result($result, 0, "owner_uid");
- }
- if (self::DEBUG_USER>0) {
- $_SESSION["uid"] = self::DEBUG_USER; // always authenticate and set debug user
- }
- }
- }
- // set whether xml or json
- private function setXml()
- {
- $this->xml = false;
- if (isset($_REQUEST["api"]))
- {
- if (strtolower($_REQUEST["api"]) == "xml")
- $this->xml = true;
- }
- }
- private function flattenGroups(&$groupsToGroups, &$groups, &$groupsToTitle, $index)
- {
- foreach ($groupsToGroups[$index] as $item)
- {
- $id = substr($item, strpos($item, "-") + 1);
- array_push($groups, array("id" => intval($id), "title" => $groupsToTitle[$id]));
- if (isset($groupsToGroups[$id]))
- $this->flattenGroups($groupsToGroups, $groups, $groupsToTitle, $id);
- }
- }
- function getGroups()
- {
- // TODO: ordering of child categories etc
- $groups = array();
- $result = $this->dbh->query("SELECT id, title, parent_cat
- FROM ttrss_feed_categories
- WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
- ORDER BY order_id ASC");
- $groupsToGroups = array();
- $groupsToTitle = array();
- while ($line = $this->dbh->fetch_assoc($result))
- {
- if ($line["parent_cat"] === NULL)
- {
- if (!isset($groupsToGroups[-1]))
- {
- $groupsToGroups[-1] = array();
- }
- array_push($groupsToGroups[-1], $line["order_id"] . "-" . $line["id"]);
- }
- else
- {
- if (!isset($groupsToGroups[$line["parent_cat"]]))
- {
- $groupsToGroups[$line["parent_cat"]] = array();
- }
- array_push($groupsToGroups[$line["parent_cat"]], $line["order_id"] . "-" . $line["id"]);
- }
- $groupsToTitle[$line["id"]] = $line["title"];
- }
- foreach ($groupsToGroups as $key => $value)
- {
- sort($value);
- }
- if (isset($groupsToGroups[-1]))
- $this->flattenGroups($groupsToGroups, $groups, $groupsToTitle, -1);
- return $groups;
- }
- function getFeeds()
- {
- $feeds = array();
- $result = $this->dbh->query("SELECT id, title, feed_url, site_url, last_updated
- FROM ttrss_feeds
- WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
- ORDER BY order_id ASC");
- while ($line = $this->dbh->fetch_assoc($result))
- {
- array_push($feeds, array("id" => intval($line["id"]),
- "favicon_id" => intval($line["id"]),
- "title" => $line["title"],
- "url" => $line["feed_url"],
- "site_url" => $line["site_url"],
- "is_spark" => 0, // unsported
- "last_updated_on_time" => strtotime($line["last_updated"])
- ));
- }
- return $feeds;
- }
- function getFavicons()
- {
- $favicons = array();
- $result = $this->dbh->query("SELECT id
- FROM ttrss_feeds
- WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
- ORDER BY order_id ASC");
- // data = "image/gif;base64,<base64 encoded image>
- while ($line = $this->dbh->fetch_assoc($result))
- {
- $filename = "feed-icons/" . $line["id"] . ".ico";
- if (file_exists($filename))
- {
- array_push($favicons, array("id" => intval($line["id"]),
- "data" => image_type_to_mime_type(exif_imagetype($filename)) . ";base64," . base64_encode(file_get_contents($filename))
- ));
- }
- }
- return $favicons;
- }
- function getLinks()
- {
- // TODO: is there a 'hot links' alternative in ttrss?
- // use ttrss_user_entries / score>0
- $links = array();
- return $links;
- }
- function getItems()
- {
- // items from specific groups, feeds
- $items = array();
- $item_limit = 50;
- $where = " owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND ref_id = id ";
- if (isset($_REQUEST["feed_ids"]) || isset($_REQUEST["group_ids"])) // added 0.3
- {
- $feed_ids = array();
- if (isset($_REQUEST["feed_ids"]))
- {
- $feed_ids = explode(",", $_REQUEST["feed_ids"]);
- }
- if (isset($_REQUEST["group_ids"]))
- {
- $group_ids = explode(",", $_REQUEST["group_ids"]);
- $num_group_ids = sizeof($group_ids);
- $groups_query = " AND cat_id IN (";
- foreach ($group_ids as $group_id)
- {
- if (is_numeric($group_id))
- $groups_query .= db_escape_string(intval($group_id)) . ",";
- else
- $num_group_ids--;
- }
- if ($num_group_ids <= 0)
- $groups_query = " AND cat_id IN ('') ";
- else
- $groups_query = trim($groups_query, ",") . ")";
- $feeds_in_group_result = $this->dbh->query("SELECT id
- FROM ttrss_feeds
- WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' " . $groups_query);
- $group_feed_ids = array();
- while ($line = $this->dbh->fetch_assoc($feeds_in_group_result))
- {
- array_push($group_feed_ids, $line["id"]);
- }
- $feed_ids = array_unique(array_merge($feed_ids, $group_feed_ids));
- }
- $query = " feed_id IN (";
- $num_feed_ids = sizeof($feed_ids);
- foreach ($feed_ids as $feed_id)
- {
- if (is_numeric($feed_id))
- $query.= db_escape_string(intval($feed_id)) . ",";
- else
- $num_feed_ids--;
- }
- if ($num_feed_ids <= 0)
- $query = " feed_id IN ('') ";
- else
- $query = trim($query, ",") . ")";
- if (!empty($where)) $where .= " AND ";
- $where .= $query;
- }
- if (isset($_REQUEST["max_id"])) // descending from most recently added
- {
- // use the max_id argument to request the previous $item_limit items
- if (is_numeric($_REQUEST["max_id"]))
- {
- $max_id = ($_REQUEST["max_id"] > 0) ? intval($_REQUEST["max_id"]) : 0;
- if ($max_id)
- {
- if (!empty($where)) $where .= " AND ";
- $where .= "id < " . db_escape_string($max_id) . " ";
- }
- else if (empty($where))
- {
- $where .= "1";
- }
- $where .= " ORDER BY id DESC";
- }
- }
- else if (isset($_REQUEST["with_ids"])) // selective
- {
- if (!empty($where)) $where .= " AND "; // group_ids & feed_ids don't make sense with this query but just in case
- $item_ids = explode(",", $_REQUEST["with_ids"]);
- $query = "id IN (";
- $num_ids = sizeof($item_ids);
- foreach ($item_ids as $item_id)
- {
- if (is_numeric($item_id))
- $query .= db_escape_string(intval($item_id)) . ",";
- else
- $num_ids--;
- }
- if ($num_ids <= 0)
- $query = "id IN ('') ";
- else
- $query = trim($query, ",") . ") ";
- $where .= $query;
- }
- else // ascending from first added
- {
- if (is_numeric($_REQUEST["since_id"]))
- {
- // use the since_id argument to request the next $item_limit items
- $since_id = isset($_GET["since_id"]) ? intval($_GET["since_id"]) : 0;
- if ($since_id)
- {
- if (!empty($where)) $where .= " AND ";
- //$where .= "id > " . db_escape_string($since_id) . " ";
- $where .= "id > " . db_escape_string($since_id) . " "; // NASTY hack for Mr. Reader 2.0 on iOS and TinyTiny RSS Fever
- }
- else if (empty($where))
- {
- $where .= "1";
- }
- $where .= " ORDER BY id ASC";
- }
- }
- $where .= " LIMIT " . $item_limit;
- // id, feed_id, title, author, html, url, is_saved, is_read, created_on_time
- $result = $this->dbh->query("SELECT ref_id, feed_id, title, link, content, id, marked, unread, author, updated
- FROM ttrss_entries, ttrss_user_entries
- WHERE " . $where);
- while ($line = $this->dbh->fetch_assoc($result))
- {
- array_push($items, array("id" => intval($line["id"]),
- "feed_id" => intval($line["feed_id"]),
- "title" => $line["title"],
- "author" => $line["author"],
- "html" => $line["content"],
- "url" => $line["link"],
- "is_saved" => (sql_bool_to_bool($line["marked"]) ? 1 : 0),
- "is_read" => ( (!sql_bool_to_bool($line["unread"])) ? 1 : 0),
- "created_on_time" => strtotime($line["updated"])
- ));
- }
- return $items;
- }
- function getTotalItems()
- {
- // number of total items
- $total_items = 0;
- $where = " owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'";
- $result = $this->dbh->query("SELECT COUNT(ref_id) as total_items
- FROM ttrss_user_entries
- WHERE " . $where);
- if ($this->dbh->num_rows($result) > 0)
- {
- $total_items = $this->dbh->fetch_result($result, 0, "total_items");
- }
- return $total_items;
- }
- function getFeedsGroup()
- {
- $feeds_groups = array();
- $result = $this->dbh->query("SELECT id, cat_id
- FROM ttrss_feeds
- WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'
- AND cat_id IS NOT NULL
- ORDER BY id ASC");
- $groupsToFeeds = array();
- while ($line = $this->dbh->fetch_assoc($result))
- {
- if (!array_key_exists($line["cat_id"], $groupsToFeeds))
- $groupsToFeeds[$line["cat_id"]] = array();
- array_push($groupsToFeeds[$line["cat_id"]], $line["id"]);
- }
- foreach ($groupsToFeeds as $group => $feeds)
- {
- $feedsStr = "";
- foreach ($feeds as $feed)
- $feedsStr .= $feed . ",";
- $feedsStr = trim($feedsStr, ",");
- array_push($feeds_groups, array("group_id" => $group,
- "feed_ids" => $feedsStr));
- }
- return $feeds_groups;
- }
- function getUnreadItemIds()
- {
- $unreadItemIdsCSV = "";
- $result = $this->dbh->query("SELECT ref_id
- FROM ttrss_user_entries
- WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'" . "AND unread"); // ORDER BY red_id DESC
- while ($line = $this->dbh->fetch_assoc($result))
- {
- $unreadItemIdsCSV .= $line["ref_id"] . ",";
- }
- $unreadItemIdsCSV = trim($unreadItemIdsCSV, ",");
- return $unreadItemIdsCSV;
- }
- function getSavedItemIds()
- {
- $savedItemIdsCSV = "";
- $result = $this->dbh->query("SELECT ref_id
- FROM ttrss_user_entries
- WHERE owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'" . "AND marked OR published OR feed_id IS NULL OR uuid != ''");
- while ($line = $this->dbh->fetch_assoc($result))
- {
- $savedItemIdsCSV .= $line["ref_id"] . ",";
- }
- $savedItemIdsCSV = trim($savedItemIdsCSV, ",");
- return $savedItemIdsCSV;
- }
- function setItem($id, $field_raw, $mode, $before = 0)
- {
- $field = "";
- $set_to = "";
- switch ($field_raw) {
- case 0:
- $field = "marked";
- $additional_fields = ",last_marked = NOW()";
- break;
- case 1:
- $field = "unread";
- $additional_fields = ",last_read = NOW()";
- break;
- };
- switch ($mode) {
- case 1:
- $set_to = "true";
- break;
- case 0:
- $set_to = "false";
- break;
- }
- if ($field && $set_to)
- {
- $article_ids = db_escape_string($id);
- $result = $this->dbh->query("UPDATE ttrss_user_entries SET $field = $set_to $additional_fields WHERE ref_id IN ($article_ids) AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "'");
- $num_updated = $this->dbh->affected_rows($result);
- if ($num_updated > 0 && $field == "unread") {
- $result = $this->dbh->query("SELECT DISTINCT feed_id FROM ttrss_user_entries
- WHERE ref_id IN ($article_ids)");
- while ($line = $this->dbh->fetch_assoc($result)) {
- ccache_update($line["feed_id"], $_SESSION["uid"]);
- }
- }
- }
- }
- function setItemAsRead($id)
- {
- $this->setItem($id, 1, 0);
- }
- function setItemAsUnread($id)
- {
- $this->setItem($id, 1, 1);
- }
- function setItemAsSaved($id)
- {
- $this->setItem($id, 0, 1);
- }
- function setItemAsUnsaved($id)
- {
- $this->setItem($id, 0, 0);
- }
- function setFeed($id, $cat, $before=0)
- {
- // if before is zero, set it to now so feeds all items are read from before this point in time
- if ($before == 0)
- $before = time();
- if (is_numeric($id))
- {
- // this is a category
- if ($cat)
- {
- // if not special feed
- if ($id > 0)
- {
- db_query("UPDATE ttrss_user_entries
- SET unread = false, last_read = NOW() WHERE ref_id IN
- (SELECT id FROM
- (SELECT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
- AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND unread = true AND feed_id IN
- (SELECT id FROM ttrss_feeds WHERE cat_id IN (" . intval($id) . ")) AND date_entered < '" . date("Y-m-d H:i:s", $before) . "' ) as tmp)");
- }
- // this is "all" to fever, but internally "all" is -4
- else if ($id == 0)
- {
- $id = -4;
- db_query("UPDATE ttrss_user_entries
- SET unread = false, last_read = NOW() WHERE ref_id IN
- (SELECT id FROM
- (SELECT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
- AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND unread = true AND date_entered < '" . date("Y-m-d H:i:s", $before) . "' ) as tmp)");
- }
- }
- // not a category
- else if ($id > 0)
- {
- db_query("UPDATE ttrss_user_entries
- SET unread = false, last_read = NOW() WHERE ref_id IN
- (SELECT id FROM
- (SELECT id FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id
- AND owner_uid = '" . db_escape_string($_SESSION["uid"]) . "' AND unread = true AND feed_id = " . intval($id) . " AND date_entered < '" . date("Y-m-d H:i:s", $before) . "' ) as tmp)");
- }
- ccache_update($id,$_SESSION["uid"], $cat);
- }
- }
- function setFeedAsRead($id, $before)
- {
- $this->setFeed($id, false, $before);
- }
- function setGroupAsRead($id, $before)
- {
- $this->setFeed($id, true, $before);
- }
- // this does all the processing, since the fever api does not have a specific variable that specifies the operation
- function index()
- {
- $response_arr = array();
- if (isset($_REQUEST["groups"]))
- {
- $response_arr["groups"] = $this->getGroups();
- $response_arr["feeds_groups"] = $this->getFeedsGroup();
- }
- if (isset($_REQUEST["feeds"]))
- {
- $response_arr["feeds"] = $this->getFeeds();
- $response_arr["feeds_groups"] = $this->getFeedsGroup();
- }
- // TODO: favicon support
- if (isset($_REQUEST["favicons"]))
- {
- $response_arr["favicons"] = $this->getFavicons();
- }
- if (isset($_REQUEST["items"]))
- {
- $response_arr["total_items"] = $this->getTotalItems();
- $response_arr["items"] = $this->getItems();
- }
- if (isset($_REQUEST["links"]))
- {
- $response_arr["links"] = $this->getLinks();
- }
- if (isset($_REQUEST["unread_item_ids"]))
- {
- $response_arr["unread_item_ids"] = $this->getUnreadItemIds();
- }
- if (isset($_REQUEST["saved_item_ids"]))
- {
- $response_arr["saved_item_ids"] = $this->getSavedItemIds();
- }
- if (isset($_REQUEST["mark"], $_REQUEST["as"], $_REQUEST["id"]))
- {
- if (is_numeric($_REQUEST["id"]))
- {
- $before = (isset($_REQUEST["before"])) ? $_REQUEST["before"] : null;
- $method_name = "set" . ucfirst($_REQUEST["mark"]) . "As" . ucfirst($_REQUEST["as"]);
- if (method_exists($this, $method_name))
- {
- $id = intval($_REQUEST["id"]);
- $this->{$method_name}($id, $before);
- switch($_REQUEST["as"])
- {
- case "read":
- case "unread":
- $response_arr["unread_item_ids"] = $this->getUnreadItemIds();
- break;
- case 'saved':
- case 'unsaved':
- $response_arr["saved_item_ids"] = $this->getSavedItemIds();
- break;
- }
- }
- }
- }
- if ($_SESSION["uid"])
- $this->wrap(self::STATUS_OK, $response_arr);
- else if (!$_SESSION["uid"])
- $this->wrap(self::STATUS_ERR, NULL);
- }
- // validate the api_key, user preferences
- function before($method) {
- if (parent::before($method)) {
- if (self::DEBUG) {
- // add request to debug log
- file_put_contents(self::DEBUG_FILE,'parameter: '.json_encode($_REQUEST)."\n",FILE_APPEND);
- }
- // set the user from the db
- $this->setUser();
- // are we xml or json?
- $this->setXml();
- if ($this->xml)
- header("Content-Type: text/xml");
- else
- header("Content-Type: application/json");
- // check we have a valid user
- if (!$_SESSION["uid"]) {
- $this->wrap(self::STATUS_ERR, NULL);
- return false;
- }
- // check if user has api access enabled
- if ($_SESSION["uid"] && !get_pref('ENABLE_API_ACCESS')) {
- $this->wrap(self::STATUS_ERR, NULL);
- return false;
- }
- return true;
- }
- return false;
- }
- }
- ?>
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement