classes/api.php

   1 <?php
   2
   3 class API extends Handler {
   4
   5         const API_LEVEL  = 1;
   6
   7         const STATUS_OK  = 0;
   8         const STATUS_ERR = 1;
   9
  10         private $seq;
  11
  12         function before($method) {
  13                 if (parent::before($method)) {
  14
  15                         if (!$_SESSION["uid"] && $method != "login" && $method != "isloggedin") {
  16                                 print $this->wrap(self::STATUS_ERR, array("error" => 'NOT_LOGGED_IN'));
  17                                 return false;
  18                         }
  19
  20                         if ($_SESSION["uid"] && $method != "logout" && !get_pref($this->link, 'ENABLE_API_ACCESS')) {
  21                                 print $this->wrap(self::STATUS_ERR, array("error" => 'API_DISABLED'));
  22                                 return false;
  23                         }
  24
  25                         $this->seq = (int) $_REQUEST['seq'];
  26
  27                         header("Content-Type: text/plain");
  28                         return true;
  29                 }
  30                 return false;
  31         }
  32
  33         function wrap($status, $reply) {
  34                 print json_encode(array("seq" => $this->seq,
  35                         "status" => $status,
  36                         "content" => $reply));
  37         }
  38
  39         function getVersion() {
  40                 $rv = array("version" => VERSION);
  41                 print $this->wrap(self::STATUS_OK, $rv);
  42         }
  43
  44         function getApiLevel() {
  45                 $rv = array("level" => API_LEVEL);
  46                 print $this->wrap(self::STATUS_OK, $rv);
  47         }
  48
  49         function login() {
  50                 $login = db_escape_string($_REQUEST["user"]);
  51                 $password = $_REQUEST["password"];
  52                 $password_base64 = base64_decode($_REQUEST["password"]);
  53
  54                 if (SINGLE_USER_MODE) $login = "admin";
  55
  56                 $result = db_query($this->link, "SELECT id FROM ttrss_users WHERE login = '$login'");
  57
  58                 if (db_num_rows($result) != 0) {
  59                         $uid = db_fetch_result($result, 0, "id");
  60                 } else {
  61                         $uid = 0;
  62                 }
  63
  64                 if (!$uid) {
  65                         print $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
  66                         return;
  67                 }
  68
  69                 if (get_pref($this->link, "ENABLE_API_ACCESS", $uid)) {
  70                         if (authenticate_user($this->link, $login, $password)) {               // try login with normal password
  71                                 print $this->wrap(self::STATUS_OK, array("session_id" => session_id()));
  72                         } else if (authenticate_user($this->link, $login, $password_base64)) { // else try with base64_decoded password
  73                                 print $this->wrap(self::STATUS_OK,      array("session_id" => session_id()));
  74                         } else {                                                         // else we are not logged in
  75                                 print $this->wrap(self::STATUS_ERR, array("error" => "LOGIN_ERROR"));
  76                         }
  77                 } else {
  78                         print $this->wrap(self::STATUS_ERR, array("error" => "API_DISABLED"));
  79                 }
  80
  81         }
  82
  83         function logout() {
  84                 logout_user();
  85                 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
  86         }
  87
  88         function isLoggedIn() {
  89                 print $this->wrap(self::STATUS_OK, array("status" => $_SESSION["uid"] != ''));
  90         }
  91
  92         function getUnread() {
  93                 $feed_id = db_escape_string($_REQUEST["feed_id"]);
  94                 $is_cat = db_escape_string($_REQUEST["is_cat"]);
  95
  96                 if ($feed_id) {
  97                         print $this->wrap(self::STATUS_OK, array("unread" => getFeedUnread($this->link, $feed_id, $is_cat)));
  98                 } else {
  99                         print $this->wrap(self::STATUS_OK, array("unread" => getGlobalUnread($this->link)));
 100                 }
 101         }
 102
 103         /* Method added for ttrss-reader for Android */
 104         function getCounters() {
 105
 106                 /* flct (flc is the default) FIXME: document */
 107                 $output_mode = db_escape_string($_REQUEST["output_mode"]);
 108
 109                 print $this->wrap(self::STATUS_OK, getAllCounters($this->link, $output_mode));
 110         }
 111
 112         function getFeeds() {
 113                 $cat_id = db_escape_string($_REQUEST["cat_id"]);
 114                 $unread_only = (bool)db_escape_string($_REQUEST["unread_only"]);
 115                 $limit = (int) db_escape_string($_REQUEST["limit"]);
 116                 $offset = (int) db_escape_string($_REQUEST["offset"]);
 117
 118                 $feeds = api_get_feeds($this->link, $cat_id, $unread_only, $limit, $offset);
 119
 120                 print $this->wrap(self::STATUS_OK, $feeds);
 121         }
 122
 123         function getCategories() {
 124                 $unread_only = (bool)db_escape_string($_REQUEST["unread_only"]);
 125
 126                 // TODO do not return empty categories, return Uncategorized and standard virtual cats
 127
 128                 $result = db_query($this->link, "SELECT
 129                                 id, title FROM ttrss_feed_categories
 130                         WHERE owner_uid = " .
 131                         $_SESSION["uid"]);
 132
 133                 $cats = array();
 134
 135                 while ($line = db_fetch_assoc($result)) {
 136                         $unread = getFeedUnread($this->link, $line["id"], true);
 137
 138                         if ($unread || !$unread_only) {
 139                                 array_push($cats, array("id" => $line["id"],
 140                                         "title" => $line["title"],
 141                                         "unread" => $unread));
 142                         }
 143                 }
 144
 145                 foreach (array(-2,-1,0) as $cat_id) {
 146                         $unread = getFeedUnread($this->link, $cat_id, true);
 147
 148                         if ($unread || !$unread_only) {
 149                                 array_push($cats, array("id" => $cat_id,
 150                                         "title" => getCategoryTitle($this->link, $cat_id),
 151                                         "unread" => $unread));
 152                         }
 153                 }
 154
 155                 print $this->wrap(self::STATUS_OK, $cats);
 156         }
 157
 158         function getHeadlines() {
 159                 $feed_id = db_escape_string($_REQUEST["feed_id"]);
 160                 if ($feed_id) {
 161
 162                         $limit = (int)db_escape_string($_REQUEST["limit"]);
 163                         $offset = (int)db_escape_string($_REQUEST["skip"]);
 164                         $filter = db_escape_string($_REQUEST["filter"]);
 165                         $is_cat = (bool)db_escape_string($_REQUEST["is_cat"]);
 166                         $show_excerpt = (bool)db_escape_string($_REQUEST["show_excerpt"]);
 167                         $show_content = (bool)db_escape_string($_REQUEST["show_content"]);
 168                         /* all_articles, unread, adaptive, marked, updated */
 169                         $view_mode = db_escape_string($_REQUEST["view_mode"]);
 170                         $include_attachments = (bool)db_escape_string($_REQUEST["include_attachments"]);
 171                         $since_id = (int)db_escape_string($_REQUEST["since_id"]);
 172
 173                         $headlines = api_get_headlines($this->link, $feed_id, $limit, $offset,
 174                                 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, false,
 175                                 $include_attachments, $since_id);
 176
 177                         print $this->wrap(self::STATUS_OK, $headlines);
 178                 } else {
 179                         print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
 180                 }
 181         }
 182
 183         function updateArticle() {
 184                 $article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric);
 185                 $mode = (int) db_escape_string($_REQUEST["mode"]);
 186                 $data = db_escape_string($_REQUEST["data"]);
 187                 $field_raw = (int)db_escape_string($_REQUEST["field"]);
 188
 189                 $field = "";
 190                 $set_to = "";
 191
 192                 switch ($field_raw) {
 193                         case 0:
 194                                 $field = "marked";
 195                                 break;
 196                         case 1:
 197                                 $field = "published";
 198                                 break;
 199                         case 2:
 200                                 $field = "unread";
 201                                 break;
 202                         case 3:
 203                                 $field = "note";
 204                 };
 205
 206                 switch ($mode) {
 207                         case 1:
 208                                 $set_to = "true";
 209                                 break;
 210                         case 0:
 211                                 $set_to = "false";
 212                                 break;
 213                         case 2:
 214                                 $set_to = "NOT $field";
 215                                 break;
 216                 }
 217
 218                 if ($field == "note") $set_to = "'$data'";
 219
 220                 if ($field && $set_to && count($article_ids) > 0) {
 221
 222                         $article_ids = join(", ", $article_ids);
 223
 224                         if ($field == "unread") {
 225                                 $result = db_query($this->link, "UPDATE ttrss_user_entries SET $field = $set_to,
 226                                         last_read = NOW()
 227                                         WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
 228                         } else {
 229                                 $result = db_query($this->link, "UPDATE ttrss_user_entries SET $field = $set_to
 230                                         WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
 231                         }
 232
 233                         $num_updated = db_affected_rows($this->link, $result);
 234
 235                         if ($num_updated > 0 && $field == "unread") {
 236                                 $result = db_query($this->link, "SELECT DISTINCT feed_id FROM ttrss_user_entries
 237                                         WHERE ref_id IN ($article_ids)");
 238
 239                                 while ($line = db_fetch_assoc($result)) {
 240                                         ccache_update($this->link, $line["feed_id"], $_SESSION["uid"]);
 241                                 }
 242                         }
 243
 244                         print $this->wrap(self::STATUS_OK, array("status" => "OK",
 245                                 "updated" => $num_updated));
 246
 247                 } else {
 248                         print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
 249                 }
 250
 251         }
 252
 253         function getArticle() {
 254
 255                 $article_id = join(",", array_filter(explode(",", db_escape_string($_REQUEST["article_id"])), is_numeric));
 256
 257                 $query = "SELECT id,title,link,content,feed_id,comments,int_id,
 258                         marked,unread,published,
 259                         ".SUBSTRING_FOR_DATE."(updated,1,16) as updated,
 260                         author
 261                         FROM ttrss_entries,ttrss_user_entries
 262                         WHERE   id IN ($article_id) AND ref_id = id AND owner_uid = " .
 263                                 $_SESSION["uid"] ;
 264
 265                 $result = db_query($this->link, $query);
 266
 267                 $articles = array();
 268
 269                 if (db_num_rows($result) != 0) {
 270
 271                         while ($line = db_fetch_assoc($result)) {
 272
 273                                 $attachments = get_article_enclosures($this->link, $line['id']);
 274
 275                                 $article = array(
 276                                         "id" => $line["id"],
 277                                         "title" => $line["title"],
 278                                         "link" => $line["link"],
 279                                         "labels" => get_article_labels($this->link, $line['id']),
 280                                         "unread" => sql_bool_to_bool($line["unread"]),
 281                                         "marked" => sql_bool_to_bool($line["marked"]),
 282                                         "published" => sql_bool_to_bool($line["published"]),
 283                                         "comments" => $line["comments"],
 284                                         "author" => $line["author"],
 285                                         "updated" => strtotime($line["updated"]),
 286                                         "content" => $line["content"],
 287                                         "feed_id" => $line["feed_id"],
 288                                         "attachments" => $attachments
 289                                 );
 290
 291                                 array_push($articles, $article);
 292
 293                         }
 294                 }
 295
 296                 print $this->wrap(self::STATUS_OK, $articles);
 297
 298         }
 299
 300         function getConfig() {
 301                 $config = array(
 302                         "icons_dir" => ICONS_DIR,
 303                         "icons_url" => ICONS_URL);
 304
 305                 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
 306
 307                 $result = db_query($this->link, "SELECT COUNT(*) AS cf FROM
 308                         ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
 309
 310                 $num_feeds = db_fetch_result($result, 0, "cf");
 311
 312                 $config["num_feeds"] = (int)$num_feeds;
 313
 314                 print $this->wrap(self::STATUS_OK, $config);
 315         }
 316
 317         function updateFeed() {
 318                 $feed_id = db_escape_string($_REQUEST["feed_id"]);
 319
 320                 update_rss_feed($this->link, $feed_id, true);
 321
 322                 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
 323         }
 324
 325         function catchupFeed() {
 326                 $feed_id = db_escape_string($_REQUEST["feed_id"]);
 327                 $is_cat = db_escape_string($_REQUEST["is_cat"]);
 328
 329                 catchup_feed($this->link, $feed_id, $is_cat);
 330
 331                 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
 332         }
 333
 334         function getPref() {
 335                 $pref_name = db_escape_string($_REQUEST["pref_name"]);
 336
 337                 print $this->wrap(self::STATUS_OK, array("value" => get_pref($this->link, $pref_name)));
 338         }
 339
 340         function index() {
 341                 print $this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD'));
 342         }
 343
 344 }
 345
 346 ?>