classes/api.php

   1 <?php
   2
   3 class API extends Handler {
   4
   5         const API_LEVEL  = 2;
   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" => self::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
 164                         if (!$limit || $limit >= 60) $limit = 60;
 165
 166                         $offset = (int)db_escape_string($_REQUEST["skip"]);
 167                         $filter = db_escape_string($_REQUEST["filter"]);
 168                         $is_cat = (bool)db_escape_string($_REQUEST["is_cat"]);
 169                         $show_excerpt = (bool)db_escape_string($_REQUEST["show_excerpt"]);
 170                         $show_content = (bool)db_escape_string($_REQUEST["show_content"]);
 171                         /* all_articles, unread, adaptive, marked, updated */
 172                         $view_mode = db_escape_string($_REQUEST["view_mode"]);
 173                         $include_attachments = (bool)db_escape_string($_REQUEST["include_attachments"]);
 174                         $since_id = (int)db_escape_string($_REQUEST["since_id"]);
 175
 176                         /* do not rely on params below */
 177
 178                         $search = db_escape_string($_REQUEST["search"]);
 179                         $search_mode = db_escape_string($_REQUEST["search_mode"]);
 180                         $match_on = db_escape_string($_REQUEST["match_on"]);
 181
 182                         $headlines = api_get_headlines($this->link, $feed_id, $limit, $offset,
 183                                 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, false,
 184                                 $include_attachments, $since_id, $search, $search_mode, $match_on);
 185
 186                         print $this->wrap(self::STATUS_OK, $headlines);
 187                 } else {
 188                         print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
 189                 }
 190         }
 191
 192         function updateArticle() {
 193                 $article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric);
 194                 $mode = (int) db_escape_string($_REQUEST["mode"]);
 195                 $data = db_escape_string($_REQUEST["data"]);
 196                 $field_raw = (int)db_escape_string($_REQUEST["field"]);
 197
 198                 $field = "";
 199                 $set_to = "";
 200
 201                 switch ($field_raw) {
 202                         case 0:
 203                                 $field = "marked";
 204                                 break;
 205                         case 1:
 206                                 $field = "published";
 207                                 break;
 208                         case 2:
 209                                 $field = "unread";
 210                                 break;
 211                         case 3:
 212                                 $field = "note";
 213                 };
 214
 215                 switch ($mode) {
 216                         case 1:
 217                                 $set_to = "true";
 218                                 break;
 219                         case 0:
 220                                 $set_to = "false";
 221                                 break;
 222                         case 2:
 223                                 $set_to = "NOT $field";
 224                                 break;
 225                 }
 226
 227                 if ($field == "note") $set_to = "'$data'";
 228
 229                 if ($field && $set_to && count($article_ids) > 0) {
 230
 231                         $article_ids = join(", ", $article_ids);
 232
 233                         if ($field == "unread") {
 234                                 $result = db_query($this->link, "UPDATE ttrss_user_entries SET $field = $set_to,
 235                                         last_read = NOW()
 236                                         WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
 237                         } else {
 238                                 $result = db_query($this->link, "UPDATE ttrss_user_entries SET $field = $set_to
 239                                         WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
 240                         }
 241
 242                         $num_updated = db_affected_rows($this->link, $result);
 243
 244                         if ($num_updated > 0 && $field == "unread") {
 245                                 $result = db_query($this->link, "SELECT DISTINCT feed_id FROM ttrss_user_entries
 246                                         WHERE ref_id IN ($article_ids)");
 247
 248                                 while ($line = db_fetch_assoc($result)) {
 249                                         ccache_update($this->link, $line["feed_id"], $_SESSION["uid"]);
 250                                 }
 251                         }
 252
 253                         print $this->wrap(self::STATUS_OK, array("status" => "OK",
 254                                 "updated" => $num_updated));
 255
 256                 } else {
 257                         print $this->wrap(self::STATUS_ERR, array("error" => 'INCORRECT_USAGE'));
 258                 }
 259
 260         }
 261
 262         function getArticle() {
 263
 264                 $article_id = join(",", array_filter(explode(",", db_escape_string($_REQUEST["article_id"])), is_numeric));
 265
 266                 $query = "SELECT id,title,link,content,feed_id,comments,int_id,
 267                         marked,unread,published,
 268                         ".SUBSTRING_FOR_DATE."(updated,1,16) as updated,
 269                         author
 270                         FROM ttrss_entries,ttrss_user_entries
 271                         WHERE   id IN ($article_id) AND ref_id = id AND owner_uid = " .
 272                                 $_SESSION["uid"] ;
 273
 274                 $result = db_query($this->link, $query);
 275
 276                 $articles = array();
 277
 278                 if (db_num_rows($result) != 0) {
 279
 280                         while ($line = db_fetch_assoc($result)) {
 281
 282                                 $attachments = get_article_enclosures($this->link, $line['id']);
 283
 284                                 $article = array(
 285                                         "id" => $line["id"],
 286                                         "title" => $line["title"],
 287                                         "link" => $line["link"],
 288                                         "labels" => get_article_labels($this->link, $line['id']),
 289                                         "unread" => sql_bool_to_bool($line["unread"]),
 290                                         "marked" => sql_bool_to_bool($line["marked"]),
 291                                         "published" => sql_bool_to_bool($line["published"]),
 292                                         "comments" => $line["comments"],
 293                                         "author" => $line["author"],
 294                                         "updated" => strtotime($line["updated"]),
 295                                         "content" => $line["content"],
 296                                         "feed_id" => $line["feed_id"],
 297                                         "attachments" => $attachments
 298                                 );
 299
 300                                 array_push($articles, $article);
 301
 302                         }
 303                 }
 304
 305                 print $this->wrap(self::STATUS_OK, $articles);
 306
 307         }
 308
 309         function getConfig() {
 310                 $config = array(
 311                         "icons_dir" => ICONS_DIR,
 312                         "icons_url" => ICONS_URL);
 313
 314                 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
 315
 316                 $result = db_query($this->link, "SELECT COUNT(*) AS cf FROM
 317                         ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
 318
 319                 $num_feeds = db_fetch_result($result, 0, "cf");
 320
 321                 $config["num_feeds"] = (int)$num_feeds;
 322
 323                 print $this->wrap(self::STATUS_OK, $config);
 324         }
 325
 326         function updateFeed() {
 327                 $feed_id = db_escape_string($_REQUEST["feed_id"]);
 328
 329                 update_rss_feed($this->link, $feed_id, true);
 330
 331                 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
 332         }
 333
 334         function catchupFeed() {
 335                 $feed_id = db_escape_string($_REQUEST["feed_id"]);
 336                 $is_cat = db_escape_string($_REQUEST["is_cat"]);
 337
 338                 catchup_feed($this->link, $feed_id, $is_cat);
 339
 340                 print $this->wrap(self::STATUS_OK, array("status" => "OK"));
 341         }
 342
 343         function getPref() {
 344                 $pref_name = db_escape_string($_REQUEST["pref_name"]);
 345
 346                 print $this->wrap(self::STATUS_OK, array("value" => get_pref($this->link, $pref_name)));
 347         }
 348
 349         function getLabels() {
 350                 //$article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric);
 351
 352                 $article_id = (int)$_REQUEST['article_id'];
 353
 354                 $rv = array();
 355
 356                 $result = db_query($this->link, "SELECT id, caption, fg_color, bg_color
 357                         FROM ttrss_labels2
 358                         WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
 359
 360                 if ($article_id)
 361                         $article_labels = get_article_labels($this->link, $article_id);
 362                 else
 363                         $article_labels = array();
 364
 365                 while ($line = db_fetch_assoc($result)) {
 366
 367                         $checked = false;
 368                         foreach ($article_labels as $al) {
 369                                 if ($al[0] == $line['id']) {
 370                                         $checked = true;
 371                                         break;
 372                                 }
 373                         }
 374
 375                         array_push($rv, array(
 376                                 "id" => (int)$line['id'],
 377                                 "caption" => $line['caption'],
 378                                 "fg_color" => $line['fg_color'],
 379                                 "bg_color" => $line['bg_color'],
 380                                 "checked" => $checked));
 381                 }
 382
 383                 print $this->wrap(self::STATUS_OK, $rv);
 384         }
 385
 386         function setArticleLabel() {
 387
 388                 $article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric);
 389                 $label_id = (int) db_escape_string($_REQUEST['label_id']);
 390                 $assign = (bool) db_escape_string($_REQUEST['assign']) == "true";
 391
 392                 $label = db_escape_string(label_find_caption($this->link,
 393                         $label_id, $_SESSION["uid"]));
 394
 395                 $num_updated = 0;
 396
 397                 if ($label) {
 398
 399                         foreach ($article_ids as $id) {
 400
 401                                 if ($assign)
 402                                         label_add_article($this->link, $id, $label, $_SESSION["uid"]);
 403                                 else
 404                                         label_remove_article($this->link, $id, $label, $_SESSION["uid"]);
 405
 406                                 ++$num_updated;
 407
 408                         }
 409                 }
 410
 411                 print $this->wrap(self::STATUS_OK, array("status" => "OK",
 412                         "updated" => $num_updated));
 413
 414         }
 415
 416         function index() {
 417                 print $this->wrap(self::STATUS_ERR, array("error" => 'UNKNOWN_METHOD'));
 418         }
 419
 420 }
 421
 422 ?>