]>
git.wh0rd.org - tt-rss.git/blob - classes/api.php
3 class API
extends Handler
{
12 function before($method) {
13 if (parent
::before($method)) {
15 if (!$_SESSION["uid"] && $method != "login" && $method != "isloggedin") {
16 print $this->wrap(self
::STATUS_ERR
, array("error" => 'NOT_LOGGED_IN'));
20 if ($_SESSION["uid"] && $method != "logout" && !get_pref($this->link
, 'ENABLE_API_ACCESS')) {
21 print $this->wrap(self
::STATUS_ERR
, array("error" => 'API_DISABLED'));
25 $this->seq
= (int) $_REQUEST['seq'];
27 header("Content-Type: text/plain");
33 function wrap($status, $reply) {
34 print json_encode(array("seq" => $this->seq
,
36 "content" => $reply));
39 function getVersion() {
40 $rv = array("version" => VERSION
);
41 print $this->wrap(self
::STATUS_OK
, $rv);
44 function getApiLevel() {
45 $rv = array("level" => self
::API_LEVEL
);
46 print $this->wrap(self
::STATUS_OK
, $rv);
50 $login = db_escape_string($_REQUEST["user"]);
51 $password = $_REQUEST["password"];
52 $password_base64 = base64_decode($_REQUEST["password"]);
54 if (SINGLE_USER_MODE
) $login = "admin";
56 $result = db_query($this->link
, "SELECT id FROM ttrss_users WHERE login = '$login'");
58 if (db_num_rows($result) != 0) {
59 $uid = db_fetch_result($result, 0, "id");
65 print $this->wrap(self
::STATUS_ERR
, array("error" => "LOGIN_ERROR"));
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"));
78 print $this->wrap(self
::STATUS_ERR
, array("error" => "API_DISABLED"));
85 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
88 function isLoggedIn() {
89 print $this->wrap(self
::STATUS_OK
, array("status" => $_SESSION["uid"] != ''));
92 function getUnread() {
93 $feed_id = db_escape_string($_REQUEST["feed_id"]);
94 $is_cat = db_escape_string($_REQUEST["is_cat"]);
97 print $this->wrap(self
::STATUS_OK
, array("unread" => getFeedUnread($this->link
, $feed_id, $is_cat)));
99 print $this->wrap(self
::STATUS_OK
, array("unread" => getGlobalUnread($this->link
)));
103 /* Method added for ttrss-reader for Android */
104 function getCounters() {
106 /* flct (flc is the default) FIXME: document */
107 $output_mode = db_escape_string($_REQUEST["output_mode"]);
109 print $this->wrap(self
::STATUS_OK
, getAllCounters($this->link
, $output_mode));
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"]);
118 $feeds = api_get_feeds($this->link
, $cat_id, $unread_only, $limit, $offset);
120 print $this->wrap(self
::STATUS_OK
, $feeds);
123 function getCategories() {
124 $unread_only = (bool)db_escape_string($_REQUEST["unread_only"]);
126 // TODO do not return empty categories, return Uncategorized and standard virtual cats
128 $result = db_query($this->link
, "SELECT
129 id, title, order_id FROM ttrss_feed_categories
130 WHERE owner_uid = " .
135 while ($line = db_fetch_assoc($result)) {
136 $unread = getFeedUnread($this->link
, $line["id"], true);
138 if ($unread ||
!$unread_only) {
139 array_push($cats, array("id" => $line["id"],
140 "title" => $line["title"],
142 "order_id" => (int) $line["order_id"],
147 foreach (array(-2,-1,0) as $cat_id) {
148 $unread = getFeedUnread($this->link
, $cat_id, true);
150 if ($unread ||
!$unread_only) {
151 array_push($cats, array("id" => $cat_id,
152 "title" => getCategoryTitle($this->link
, $cat_id),
153 "unread" => $unread));
157 print $this->wrap(self
::STATUS_OK
, $cats);
160 function getHeadlines() {
161 $feed_id = db_escape_string($_REQUEST["feed_id"]);
162 if ($feed_id != "") {
164 $limit = (int)db_escape_string($_REQUEST["limit"]);
166 if (!$limit ||
$limit >= 60) $limit = 60;
168 $offset = (int)db_escape_string($_REQUEST["skip"]);
169 $filter = db_escape_string($_REQUEST["filter"]);
170 $is_cat = (bool)db_escape_string($_REQUEST["is_cat"]);
171 $show_excerpt = (bool)db_escape_string($_REQUEST["show_excerpt"]);
172 $show_content = (bool)db_escape_string($_REQUEST["show_content"]);
173 /* all_articles, unread, adaptive, marked, updated */
174 $view_mode = db_escape_string($_REQUEST["view_mode"]);
175 $include_attachments = (bool)db_escape_string($_REQUEST["include_attachments"]);
176 $since_id = (int)db_escape_string($_REQUEST["since_id"]);
178 /* do not rely on params below */
180 $search = db_escape_string($_REQUEST["search"]);
181 $search_mode = db_escape_string($_REQUEST["search_mode"]);
182 $match_on = db_escape_string($_REQUEST["match_on"]);
184 $headlines = api_get_headlines($this->link
, $feed_id, $limit, $offset,
185 $filter, $is_cat, $show_excerpt, $show_content, $view_mode, false,
186 $include_attachments, $since_id, $search, $search_mode, $match_on);
188 print $this->wrap(self
::STATUS_OK
, $headlines);
190 print $this->wrap(self
::STATUS_ERR
, array("error" => 'INCORRECT_USAGE'));
194 function updateArticle() {
195 $article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric
);
196 $mode = (int) db_escape_string($_REQUEST["mode"]);
197 $data = db_escape_string($_REQUEST["data"]);
198 $field_raw = (int)db_escape_string($_REQUEST["field"]);
203 switch ($field_raw) {
208 $field = "published";
225 $set_to = "NOT $field";
229 if ($field == "note") $set_to = "'$data'";
231 if ($field && $set_to && count($article_ids) > 0) {
233 $article_ids = join(", ", $article_ids);
235 if ($field == "unread") {
236 $result = db_query($this->link
, "UPDATE ttrss_user_entries SET $field = $set_to,
238 WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
240 $result = db_query($this->link
, "UPDATE ttrss_user_entries SET $field = $set_to
241 WHERE ref_id IN ($article_ids) AND owner_uid = " . $_SESSION["uid"]);
244 $num_updated = db_affected_rows($this->link
, $result);
246 if ($num_updated > 0 && $field == "unread") {
247 $result = db_query($this->link
, "SELECT DISTINCT feed_id FROM ttrss_user_entries
248 WHERE ref_id IN ($article_ids)");
250 while ($line = db_fetch_assoc($result)) {
251 ccache_update($this->link
, $line["feed_id"], $_SESSION["uid"]);
255 print $this->wrap(self
::STATUS_OK
, array("status" => "OK",
256 "updated" => $num_updated));
259 print $this->wrap(self
::STATUS_ERR
, array("error" => 'INCORRECT_USAGE'));
264 function getArticle() {
266 $article_id = join(",", array_filter(explode(",", db_escape_string($_REQUEST["article_id"])), is_numeric
));
268 $query = "SELECT id,title,link,content,feed_id,comments,int_id,
269 marked,unread,published,
270 ".SUBSTRING_FOR_DATE
."(updated,1,16) as updated,
272 FROM ttrss_entries,ttrss_user_entries
273 WHERE id IN ($article_id) AND ref_id = id AND owner_uid = " .
276 $result = db_query($this->link
, $query);
280 if (db_num_rows($result) != 0) {
282 while ($line = db_fetch_assoc($result)) {
284 $attachments = get_article_enclosures($this->link
, $line['id']);
288 "title" => $line["title"],
289 "link" => $line["link"],
290 "labels" => get_article_labels($this->link
, $line['id']),
291 "unread" => sql_bool_to_bool($line["unread"]),
292 "marked" => sql_bool_to_bool($line["marked"]),
293 "published" => sql_bool_to_bool($line["published"]),
294 "comments" => $line["comments"],
295 "author" => $line["author"],
296 "updated" => strtotime($line["updated"]),
297 "content" => $line["content"],
298 "feed_id" => $line["feed_id"],
299 "attachments" => $attachments
302 array_push($articles, $article);
307 print $this->wrap(self
::STATUS_OK
, $articles);
311 function getConfig() {
313 "icons_dir" => ICONS_DIR
,
314 "icons_url" => ICONS_URL
);
316 $config["daemon_is_running"] = file_is_locked("update_daemon.lock");
318 $result = db_query($this->link
, "SELECT COUNT(*) AS cf FROM
319 ttrss_feeds WHERE owner_uid = " . $_SESSION["uid"]);
321 $num_feeds = db_fetch_result($result, 0, "cf");
323 $config["num_feeds"] = (int)$num_feeds;
325 print $this->wrap(self
::STATUS_OK
, $config);
328 function updateFeed() {
329 $feed_id = db_escape_string($_REQUEST["feed_id"]);
331 update_rss_feed($this->link
, $feed_id, true);
333 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
336 function catchupFeed() {
337 $feed_id = db_escape_string($_REQUEST["feed_id"]);
338 $is_cat = db_escape_string($_REQUEST["is_cat"]);
340 catchup_feed($this->link
, $feed_id, $is_cat);
342 print $this->wrap(self
::STATUS_OK
, array("status" => "OK"));
346 $pref_name = db_escape_string($_REQUEST["pref_name"]);
348 print $this->wrap(self
::STATUS_OK
, array("value" => get_pref($this->link
, $pref_name)));
351 function getLabels() {
352 //$article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric);
354 $article_id = (int)$_REQUEST['article_id'];
358 $result = db_query($this->link
, "SELECT id, caption, fg_color, bg_color
360 WHERE owner_uid = '".$_SESSION['uid']."' ORDER BY caption");
363 $article_labels = get_article_labels($this->link
, $article_id);
365 $article_labels = array();
367 while ($line = db_fetch_assoc($result)) {
370 foreach ($article_labels as $al) {
371 if ($al[0] == $line['id']) {
377 array_push($rv, array(
378 "id" => (int)$line['id'],
379 "caption" => $line['caption'],
380 "fg_color" => $line['fg_color'],
381 "bg_color" => $line['bg_color'],
382 "checked" => $checked));
385 print $this->wrap(self
::STATUS_OK
, $rv);
388 function setArticleLabel() {
390 $article_ids = array_filter(explode(",", db_escape_string($_REQUEST["article_ids"])), is_numeric
);
391 $label_id = (int) db_escape_string($_REQUEST['label_id']);
392 $assign = (bool) db_escape_string($_REQUEST['assign']) == "true";
394 $label = db_escape_string(label_find_caption($this->link
,
395 $label_id, $_SESSION["uid"]));
401 foreach ($article_ids as $id) {
404 label_add_article($this->link
, $id, $label, $_SESSION["uid"]);
406 label_remove_article($this->link
, $id, $label, $_SESSION["uid"]);
413 print $this->wrap(self
::STATUS_OK
, array("status" => "OK",
414 "updated" => $num_updated));
419 print $this->wrap(self
::STATUS_ERR
, array("error" => 'UNKNOWN_METHOD'));