3 * @file include/api.php
4 * Friendica implementation of statusnet/twitter API
6 * @todo Automatically detect if incoming data is HTML or BBCode
9 use Friendica\Content\Feature;
10 use Friendica\Core\System;
11 use Friendica\Core\Config;
12 use Friendica\Core\NotificationsManager;
13 use Friendica\Core\PConfig;
14 use Friendica\Core\Worker;
15 use Friendica\Database\DBM;
16 use Friendica\Model\Contact;
17 use Friendica\Model\Group;
18 use Friendica\Model\Photo;
19 use Friendica\Model\User;
20 use Friendica\Network\FKOAuth1;
21 use Friendica\Network\HTTPException;
22 use Friendica\Network\HTTPException\BadRequestException;
23 use Friendica\Network\HTTPException\ForbiddenException;
24 use Friendica\Network\HTTPException\InternalServerErrorException;
25 use Friendica\Network\HTTPException\MethodNotAllowedException;
26 use Friendica\Network\HTTPException\NotFoundException;
27 use Friendica\Network\HTTPException\NotImplementedException;
28 use Friendica\Network\HTTPException\UnauthorizedException;
29 use Friendica\Network\HTTPException\TooManyRequestsException;
30 use Friendica\Object\Image;
31 use Friendica\Protocol\Diaspora;
32 use Friendica\Util\XML;
34 require_once 'include/bbcode.php';
35 require_once 'include/datetime.php';
36 require_once 'include/conversation.php';
37 require_once 'include/html2plain.php';
38 require_once 'mod/share.php';
39 require_once 'mod/item.php';
40 require_once 'include/security.php';
41 require_once 'include/contact_selectors.php';
42 require_once 'include/html2bbcode.php';
43 require_once 'mod/wall_upload.php';
44 require_once 'mod/proxy.php';
45 require_once 'include/message.php';
46 require_once 'include/like.php';
47 require_once 'include/plaintext.php';
49 define('API_METHOD_ANY', '*');
50 define('API_METHOD_GET', 'GET');
51 define('API_METHOD_POST', 'POST,PUT');
52 define('API_METHOD_DELETE', 'POST,DELETE');
58 * @brief Auth API user
60 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
61 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
62 * into a page, and visitors will post something without noticing it).
66 if (x($_SESSION, 'allow_api')) {
74 * @brief Get source name from API client
76 * Clients can send 'source' parameter to be show in post metadata
77 * as "sent via <source>".
78 * Some clients doesn't send a source param, we support ones we know
82 * Client source name, default to "api" if unset/unknown
86 if (requestdata('source')) {
87 return requestdata('source');
90 // Support for known clients that doesn't send a source name
91 if (strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
95 logger("Unrecognized user-agent ".$_SERVER['HTTP_USER_AGENT'], LOGGER_DEBUG);
101 * @brief Format date for API
103 * @param string $str Source date, as UTC
104 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
106 function api_date($str)
108 // Wed May 23 06:01:13 +0000 2007
109 return datetime_convert('UTC', 'UTC', $str, "D M d H:i:s +0000 Y");
113 * @brief Register API endpoint
115 * Register a function to be the endpont for defined API path.
117 * @param string $path API URL path, relative to System::baseUrl()
118 * @param string $func Function name to call on path request
119 * @param bool $auth API need logged user
120 * @param string $method HTTP method reqiured to call this endpoint.
121 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
122 * Default to API_METHOD_ANY
124 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
134 // Workaround for hotot
135 $path = str_replace("api/", "api/1.1/", $path);
145 * @brief Login API user
147 * Log in user via OAuth1 or Simple HTTP Auth.
148 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
150 * @param object $a App
151 * @hook 'authenticate'
153 * 'username' => username from login form
154 * 'password' => password from login form
155 * 'authenticated' => return status,
156 * 'user_record' => return authenticated user record
158 * array $user logged user record
160 function api_login(App $a)
162 $oauth1 = new FKOAuth1();
165 list($consumer, $token) = $oauth1->verify_request(OAuthRequest::from_request());
166 if (!is_null($token)) {
167 $oauth1->loginUser($token->uid);
168 call_hooks('logged_in', $a->user);
171 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
172 var_dump($consumer, $token);
174 } catch (Exception $e) {
178 // workaround for HTTP-auth in CGI mode
179 if (x($_SERVER, 'REDIRECT_REMOTE_USER')) {
180 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6)) ;
181 if (strlen($userpass)) {
182 list($name, $password) = explode(':', $userpass);
183 $_SERVER['PHP_AUTH_USER'] = $name;
184 $_SERVER['PHP_AUTH_PW'] = $password;
188 if (!x($_SERVER, 'PHP_AUTH_USER')) {
189 logger('API_login: ' . print_r($_SERVER,true), LOGGER_DEBUG);
190 header('WWW-Authenticate: Basic realm="Friendica"');
191 throw new UnauthorizedException("This API requires login");
194 $user = $_SERVER['PHP_AUTH_USER'];
195 $password = $_SERVER['PHP_AUTH_PW'];
197 // allow "user@server" login (but ignore 'server' part)
198 $at = strstr($user, "@", true);
203 // next code from mod/auth.php. needs better solution
207 'username' => trim($user),
208 'password' => trim($password),
209 'authenticated' => 0,
210 'user_record' => null,
214 * A plugin indicates successful login by setting 'authenticated' to non-zero value and returning a user record
215 * Plugins should never set 'authenticated' except to indicate success - as hooks may be chained
216 * and later plugins should not interfere with an earlier one that succeeded.
218 call_hooks('authenticate', $addon_auth);
220 if (($addon_auth['authenticated']) && (count($addon_auth['user_record']))) {
221 $record = $addon_auth['user_record'];
223 $user_id = User::authenticate(trim($user), trim($password));
225 $record = dba::select('user', [], ['uid' => $user_id], ['limit' => 1]);
229 if ((! $record) || (! count($record))) {
230 logger('API_login failure: ' . print_r($_SERVER, true), LOGGER_DEBUG);
231 header('WWW-Authenticate: Basic realm="Friendica"');
232 //header('HTTP/1.0 401 Unauthorized');
233 //die('This api requires login');
234 throw new UnauthorizedException("This API requires login");
237 authenticate_success($record);
239 $_SESSION["allow_api"] = true;
241 call_hooks('logged_in', $a->user);
245 * @brief Check HTTP method of called API
247 * API endpoints can define which HTTP method to accept when called.
248 * This function check the current HTTP method agains endpoint
251 * @param string $method Required methods, uppercase, separated by comma
254 function api_check_method($method)
256 if ($method == "*") {
259 return (strpos($method, $_SERVER['REQUEST_METHOD']) !== false);
263 * @brief Main API entry point
265 * Authenticate user, call registered API function, set HTTP headers
267 * @param object $a App
268 * @return string API call result
270 function api_call(App $a)
272 global $API, $called_api;
275 if (strpos($a->query_string, ".xml") > 0) {
278 if (strpos($a->query_string, ".json") > 0) {
281 if (strpos($a->query_string, ".rss") > 0) {
284 if (strpos($a->query_string, ".atom") > 0) {
289 foreach ($API as $p => $info) {
290 if (strpos($a->query_string, $p) === 0) {
291 if (!api_check_method($info['method'])) {
292 throw new MethodNotAllowedException();
295 $called_api = explode("/", $p);
296 //unset($_SERVER['PHP_AUTH_USER']);
298 /// @TODO should be "true ==[=] $info['auth']", if you miss only one = character, you assign a variable (only with ==). Let's make all this even.
299 if ($info['auth'] === true && api_user() === false) {
303 logger('API call for ' . $a->user['username'] . ': ' . $a->query_string);
304 logger('API parameters: ' . print_r($_REQUEST, true));
306 $stamp = microtime(true);
307 $r = call_user_func($info['func'], $type);
308 $duration = (float) (microtime(true) - $stamp);
309 logger("API call duration: " . round($duration, 2) . "\t" . $a->query_string, LOGGER_DEBUG);
311 if (Config::get("system", "profiler")) {
312 $duration = microtime(true)-$a->performance["start"];
314 /// @TODO round() really everywhere?
316 parse_url($a->query_string, PHP_URL_PATH) . ": " . sprintf(
317 "Database: %s/%s, Network: %s, I/O: %s, Other: %s, Total: %s",
318 round($a->performance["database"] - $a->performance["database_write"], 3),
319 round($a->performance["database_write"], 3),
320 round($a->performance["network"], 2),
321 round($a->performance["file"], 2),
322 round($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
328 if (Config::get("rendertime", "callstack")) {
329 $o = "Database Read:\n";
330 foreach ($a->callstack["database"] as $func => $time) {
331 $time = round($time, 3);
333 $o .= $func . ": " . $time . "\n";
336 $o .= "\nDatabase Write:\n";
337 foreach ($a->callstack["database_write"] as $func => $time) {
338 $time = round($time, 3);
340 $o .= $func . ": " . $time . "\n";
344 $o .= "\nNetwork:\n";
345 foreach ($a->callstack["network"] as $func => $time) {
346 $time = round($time, 3);
348 $o .= $func . ": " . $time . "\n";
351 logger($o, LOGGER_DEBUG);
357 * api function returned false withour throw an
358 * exception. This should not happend, throw a 500
360 throw new InternalServerErrorException();
365 header("Content-Type: text/xml");
369 header("Content-Type: application/json");
371 $json = json_encode($rr);
372 if (x($_GET, 'callback')) {
373 $json = $_GET['callback'] . "(" . $json . ")";
378 header("Content-Type: application/rss+xml");
379 return '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $r;
382 header("Content-Type: application/atom+xml");
383 return '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $r;
389 logger('API call not implemented: ' . $a->query_string);
390 throw new NotImplementedException();
391 } catch (HTTPException $e) {
392 header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}");
393 return api_error($type, $e);
398 * @brief Format API error string
400 * @param string $type Return type (xml, json, rss, as)
401 * @param object $e HTTPException Error object
402 * @return string error message formatted as $type
404 function api_error($type, $e)
408 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
409 /// @TODO: https://dev.twitter.com/overview/api/response-codes
411 $error = array("error" => $error,
412 "code" => $e->httpcode . " " . $e->httpdesc,
413 "request" => $a->query_string);
415 $ret = api_format_data('status', $type, array('status' => $error));
419 header("Content-Type: text/xml");
423 header("Content-Type: application/json");
424 return json_encode($ret);
427 header("Content-Type: application/rss+xml");
431 header("Content-Type: application/atom+xml");
438 * @brief Set values for RSS template
441 * @param array $arr Array to be passed to template
442 * @param array $user_info User info
444 * @todo find proper type-hints
446 function api_rss_extra(App $a, $arr, $user_info)
448 if (is_null($user_info)) {
449 $user_info = api_get_user($a);
452 $arr['$user'] = $user_info;
453 $arr['$rss'] = array(
454 'alternate' => $user_info['url'],
455 'self' => System::baseUrl() . "/" . $a->query_string,
456 'base' => System::baseUrl(),
457 'updated' => api_date(null),
458 'atom_updated' => datetime_convert('UTC', 'UTC', 'now', ATOM_TIME),
459 'language' => $user_info['language'],
460 'logo' => System::baseUrl() . "/images/friendica-32.png",
468 * @brief Unique contact to contact url.
470 * @param int $id Contact id
471 * @return bool|string
472 * Contact url or False if contact id is unknown
474 function api_unique_id_to_nurl($id)
476 $r = dba::select('contact', array('nurl'), array('uid' => 0, 'id' => $id), array('limit' => 1));
478 if (DBM::is_result($r)) {
486 * @brief Get user info array.
488 * @param object $a App
489 * @param int|string $contact_id Contact ID or URL
491 function api_get_user(App $a, $contact_id = null)
500 logger("api_get_user: Fetching user data for user ".$contact_id, LOGGER_DEBUG);
502 // Searching for contact URL
503 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
504 $user = dbesc(normalise_link($contact_id));
506 $extra_query = "AND `contact`.`nurl` = '%s' ";
507 if (api_user() !== false) {
508 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
512 // Searching for contact id with uid = 0
513 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
514 $user = dbesc(api_unique_id_to_nurl($contact_id));
517 throw new BadRequestException("User not found.");
521 $extra_query = "AND `contact`.`nurl` = '%s' ";
522 if (api_user() !== false) {
523 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
527 if (is_null($user) && x($_GET, 'user_id')) {
528 $user = dbesc(api_unique_id_to_nurl($_GET['user_id']));
531 throw new BadRequestException("User not found.");
535 $extra_query = "AND `contact`.`nurl` = '%s' ";
536 if (api_user() !== false) {
537 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
540 if (is_null($user) && x($_GET, 'screen_name')) {
541 $user = dbesc($_GET['screen_name']);
543 $extra_query = "AND `contact`.`nick` = '%s' ";
544 if (api_user() !== false) {
545 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
549 if (is_null($user) && x($_GET, 'profileurl')) {
550 $user = dbesc(normalise_link($_GET['profileurl']));
552 $extra_query = "AND `contact`.`nurl` = '%s' ";
553 if (api_user() !== false) {
554 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
558 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
559 $argid = count($called_api);
560 list($user, $null) = explode(".", $a->argv[$argid]);
561 if (is_numeric($user)) {
562 $user = dbesc(api_unique_id_to_nurl($user));
569 $extra_query = "AND `contact`.`nurl` = '%s' ";
570 if (api_user() !== false) {
571 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
574 $user = dbesc($user);
576 $extra_query = "AND `contact`.`nick` = '%s' ";
577 if (api_user() !== false) {
578 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
583 logger("api_get_user: user ".$user, LOGGER_DEBUG);
586 if (api_user() === false) {
590 $user = $_SESSION['uid'];
591 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
595 logger('api_user: ' . $extra_query . ', user: ' . $user);
599 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
605 // Selecting the id by priority, friendica first
606 api_best_nickname($uinfo);
608 // if the contact wasn't found, fetch it from the contacts with uid = 0
609 if (!DBM::is_result($uinfo)) {
613 $r = q("SELECT * FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s' LIMIT 1", dbesc(normalise_link($url)));
616 if (DBM::is_result($r)) {
617 $network_name = network_to_name($r[0]['network'], $r[0]['url']);
619 // If no nick where given, extract it from the address
620 if (($r[0]['nick'] == "") || ($r[0]['name'] == $r[0]['nick'])) {
621 $r[0]['nick'] = api_get_nick($r[0]["url"]);
626 'id_str' => (string) $r[0]["id"],
627 'name' => $r[0]["name"],
628 'screen_name' => (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']),
629 'location' => ($r[0]["location"] != "") ? $r[0]["location"] : $network_name,
630 'description' => $r[0]["about"],
631 'profile_image_url' => $r[0]["micro"],
632 'profile_image_url_https' => $r[0]["micro"],
633 'url' => $r[0]["url"],
634 'protected' => false,
635 'followers_count' => 0,
636 'friends_count' => 0,
638 'created_at' => api_date($r[0]["created"]),
639 'favourites_count' => 0,
641 'time_zone' => 'UTC',
642 'geo_enabled' => false,
644 'statuses_count' => 0,
646 'contributors_enabled' => false,
647 'is_translator' => false,
648 'is_translation_enabled' => false,
649 'following' => false,
650 'follow_request_sent' => false,
651 'statusnet_blocking' => false,
652 'notifications' => false,
653 'statusnet_profile_url' => $r[0]["url"],
655 'cid' => Contact::getIdForURL($r[0]["url"], api_user(), true),
657 'network' => $r[0]["network"],
662 throw new BadRequestException("User not found.");
666 if ($uinfo[0]['self']) {
667 if ($uinfo[0]['network'] == "") {
668 $uinfo[0]['network'] = NETWORK_DFRN;
672 "SELECT * FROM `user` WHERE `uid` = %d LIMIT 1",
676 "SELECT * FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
680 /// @TODO old-lost code? (twice)
681 // Counting is deactivated by now, due to performance issues
682 // count public wall messages
683 //$r = q("SELECT COUNT(*) as `count` FROM `item` WHERE `uid` = %d AND `wall`",
684 // intval($uinfo[0]['uid'])
686 //$countitms = $r[0]['count'];
689 // Counting is deactivated by now, due to performance issues
690 //$r = q("SELECT count(*) as `count` FROM `item`
691 // WHERE `contact-id` = %d",
692 // intval($uinfo[0]['id'])
694 //$countitms = $r[0]['count'];
698 /// @TODO old-lost code? (twice)
700 // Counting is deactivated by now, due to performance issues
702 $r = q("SELECT count(*) as `count` FROM `contact`
703 WHERE `uid` = %d AND `rel` IN ( %d, %d )
704 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
705 intval($uinfo[0]['uid']),
706 intval(CONTACT_IS_SHARING),
707 intval(CONTACT_IS_FRIEND)
709 $countfriends = $r[0]['count'];
711 $r = q("SELECT count(*) as `count` FROM `contact`
712 WHERE `uid` = %d AND `rel` IN ( %d, %d )
713 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
714 intval($uinfo[0]['uid']),
715 intval(CONTACT_IS_FOLLOWER),
716 intval(CONTACT_IS_FRIEND)
718 $countfollowers = $r[0]['count'];
720 $r = q("SELECT count(*) as `count` FROM item where starred = 1 and uid = %d and deleted = 0",
721 intval($uinfo[0]['uid'])
723 $starred = $r[0]['count'];
726 if (! $uinfo[0]['self']) {
736 // Add a nick if it isn't present there
737 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
738 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
741 $network_name = network_to_name($uinfo[0]['network'], $uinfo[0]['url']);
743 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
746 'id' => intval($pcontact_id),
747 'id_str' => (string) intval($pcontact_id),
748 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
749 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
750 'location' => ($usr) ? $usr[0]['default-location'] : $network_name,
751 'description' => (($profile) ? $profile[0]['pdesc'] : null),
752 'profile_image_url' => $uinfo[0]['micro'],
753 'profile_image_url_https' => $uinfo[0]['micro'],
754 'url' => $uinfo[0]['url'],
755 'protected' => false,
756 'followers_count' => intval($countfollowers),
757 'friends_count' => intval($countfriends),
759 'created_at' => api_date($uinfo[0]['created']),
760 'favourites_count' => intval($starred),
762 'time_zone' => 'UTC',
763 'geo_enabled' => false,
765 'statuses_count' => intval($countitms),
767 'contributors_enabled' => false,
768 'is_translator' => false,
769 'is_translation_enabled' => false,
770 'following' => (($uinfo[0]['rel'] == CONTACT_IS_FOLLOWER) || ($uinfo[0]['rel'] == CONTACT_IS_FRIEND)),
771 'follow_request_sent' => false,
772 'statusnet_blocking' => false,
773 'notifications' => false,
775 //'statusnet_profile_url' => System::baseUrl()."/contacts/".$uinfo[0]['cid'],
776 'statusnet_profile_url' => $uinfo[0]['url'],
777 'uid' => intval($uinfo[0]['uid']),
778 'cid' => intval($uinfo[0]['cid']),
779 'self' => $uinfo[0]['self'],
780 'network' => $uinfo[0]['network'],
783 // If this is a local user and it uses Frio, we can get its color preferences.
785 $theme_info = dba::select('user', ['theme'], ['uid' => $ret['uid']], ['limit' => 1]);
786 if ($theme_info['theme'] === 'frio') {
787 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
788 if ($schema && ($schema != '---')) {
789 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
790 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
791 require_once $schemefile;
794 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
795 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
796 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
802 $link_color = "#6fdbe8";
805 $bgcolor = "#ededed";
808 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
809 $ret['profile_link_color'] = str_replace('#', '', $link_color);
810 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
818 * @brief return api-formatted array for item's author and owner
820 * @param object $a App
821 * @param array $item item from db
822 * @return array(array:author, array:owner)
824 function api_item_get_user(App $a, $item)
826 $status_user = api_get_user($a, $item["author-link"]);
828 $status_user["protected"] = (($item["allow_cid"] != "") ||
829 ($item["allow_gid"] != "") ||
830 ($item["deny_cid"] != "") ||
831 ($item["deny_gid"] != "") ||
834 if ($item['thr-parent'] == $item['uri']) {
835 $owner_user = api_get_user($a, $item["owner-link"]);
837 $owner_user = $status_user;
840 return (array($status_user, $owner_user));
844 * @brief walks recursively through an array with the possibility to change value and key
846 * @param array $array The array to walk through
847 * @param string $callback The callback function
849 * @return array the transformed array
851 function api_walk_recursive(array &$array, callable $callback)
853 $new_array = array();
855 foreach ($array as $k => $v) {
857 if ($callback($v, $k)) {
858 $new_array[$k] = api_walk_recursive($v, $callback);
861 if ($callback($v, $k)) {
872 * @brief Callback function to transform the array in an array that can be transformed in a XML file
874 * @param mixed $item Array item value
875 * @param string $key Array key
877 * @return boolean Should the array item be deleted?
879 function api_reformat_xml(&$item, &$key)
881 if (is_bool($item)) {
882 $item = ($item ? "true" : "false");
885 if (substr($key, 0, 10) == "statusnet_") {
886 $key = "statusnet:".substr($key, 10);
887 } elseif (substr($key, 0, 10) == "friendica_") {
888 $key = "friendica:".substr($key, 10);
890 /// @TODO old-lost code?
892 // $key = "default:".$key;
898 * @brief Creates the XML from a JSON style array
900 * @param array $data JSON style array
901 * @param string $root_element Name of the root element
903 * @return string The XML data
905 function api_create_xml($data, $root_element)
907 $childname = key($data);
908 $data2 = array_pop($data);
911 $namespaces = array("" => "http://api.twitter.com",
912 "statusnet" => "http://status.net/schema/api/1/",
913 "friendica" => "http://friendi.ca/schema/api/1/",
914 "georss" => "http://www.georss.org/georss");
916 /// @todo Auto detection of needed namespaces
917 if (in_array($root_element, array("ok", "hash", "config", "version", "ids", "notes", "photos"))) {
918 $namespaces = array();
921 if (is_array($data2)) {
922 api_walk_recursive($data2, "api_reformat_xml");
929 foreach ($data2 as $item) {
930 $data4[$i++.":".$childname] = $item;
936 $data3 = array($root_element => $data2);
938 $ret = XML::fromArray($data3, $xml, false, $namespaces);
943 * @brief Formats the data according to the data type
945 * @param string $root_element Name of the root element
946 * @param string $type Return type (atom, rss, xml, json)
947 * @param array $data JSON style array
949 * @return (string|object|array) XML data or JSON data
951 function api_format_data($root_element, $type, $data)
957 $ret = api_create_xml($data, $root_element);
972 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
973 * returns a 401 status code and an error message if not.
974 * http://developer.twitter.com/doc/get/account/verify_credentials
976 function api_account_verify_credentials($type)
981 if (api_user() === false) {
982 throw new ForbiddenException();
985 unset($_REQUEST["user_id"]);
986 unset($_GET["user_id"]);
988 unset($_REQUEST["screen_name"]);
989 unset($_GET["screen_name"]);
991 $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false);
993 $user_info = api_get_user($a);
995 // "verified" isn't used here in the standard
996 unset($user_info["verified"]);
998 // - Adding last status
1000 $user_info["status"] = api_status_show("raw");
1001 if (!count($user_info["status"])) {
1002 unset($user_info["status"]);
1004 unset($user_info["status"]["user"]);
1008 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1009 unset($user_info["uid"]);
1010 unset($user_info["self"]);
1012 return api_format_data("user", $type, array('user' => $user_info));
1015 /// @TODO move to top of file or somwhere better
1016 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1019 * Get data from $_POST or $_GET
1021 function requestdata($k)
1023 if (x($_POST, $k)) {
1032 /*Waitman Gobble Mod*/
1033 function api_statuses_mediap($type)
1037 if (api_user() === false) {
1038 logger('api_statuses_update: no user');
1039 throw new ForbiddenException();
1041 $user_info = api_get_user($a);
1043 $_REQUEST['type'] = 'wall';
1044 $_REQUEST['profile_uid'] = api_user();
1045 $_REQUEST['api_source'] = true;
1046 $txt = requestdata('status');
1047 /// @TODO old-lost code?
1048 //$txt = urldecode(requestdata('status'));
1050 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1051 $txt = html2bb_video($txt);
1052 $config = HTMLPurifier_Config::createDefault();
1053 $config->set('Cache.DefinitionImpl', null);
1054 $purifier = new HTMLPurifier($config);
1055 $txt = $purifier->purify($txt);
1057 $txt = html2bbcode($txt);
1059 $a->argv[1]=$user_info['screen_name']; //should be set to username?
1061 // tell wall_upload function to return img info instead of echo
1062 $_REQUEST['hush'] = 'yeah';
1063 $bebop = wall_upload_post($a);
1065 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1066 $_REQUEST['body'] = $txt . "\n\n" . $bebop;
1069 // this should output the last post (the one we just posted).
1070 return api_status_show($type);
1073 /// @TODO move this to top of file or somewhere better!
1074 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1076 function api_statuses_update($type)
1081 if (api_user() === false) {
1082 logger('api_statuses_update: no user');
1083 throw new ForbiddenException();
1086 $user_info = api_get_user($a);
1088 // convert $_POST array items to the form we use for web posts.
1090 // logger('api_post: ' . print_r($_POST,true));
1092 if (requestdata('htmlstatus')) {
1093 $txt = requestdata('htmlstatus');
1094 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1095 $txt = html2bb_video($txt);
1097 $config = HTMLPurifier_Config::createDefault();
1098 $config->set('Cache.DefinitionImpl', null);
1100 $purifier = new HTMLPurifier($config);
1101 $txt = $purifier->purify($txt);
1103 $_REQUEST['body'] = html2bbcode($txt);
1106 $_REQUEST['body'] = requestdata('status');
1109 $_REQUEST['title'] = requestdata('title');
1111 $parent = requestdata('in_reply_to_status_id');
1113 // Twidere sends "-1" if it is no reply ...
1114 if ($parent == -1) {
1118 if (ctype_digit($parent)) {
1119 $_REQUEST['parent'] = $parent;
1121 $_REQUEST['parent_uri'] = $parent;
1124 if (requestdata('lat') && requestdata('long')) {
1125 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1127 $_REQUEST['profile_uid'] = api_user();
1130 $_REQUEST['type'] = 'net-comment';
1132 // Check for throttling (maximum posts per day, week and month)
1133 $throttle_day = Config::get('system', 'throttle_limit_day');
1134 if ($throttle_day > 0) {
1135 $datefrom = date("Y-m-d H:i:s", time() - 24*60*60);
1138 "SELECT COUNT(*) AS `posts_day` FROM `item` WHERE `uid`=%d AND `wall`
1139 AND `created` > '%s' AND `id` = `parent`",
1144 if (DBM::is_result($r)) {
1145 $posts_day = $r[0]["posts_day"];
1150 if ($posts_day > $throttle_day) {
1151 logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG);
1152 // die(api_error($type, sprintf(t("Daily posting limit of %d posts reached. The post was rejected."), $throttle_day)));
1153 throw new TooManyRequestsException(sprintf(t("Daily posting limit of %d posts reached. The post was rejected."), $throttle_day));
1157 $throttle_week = Config::get('system', 'throttle_limit_week');
1158 if ($throttle_week > 0) {
1159 $datefrom = date("Y-m-d H:i:s", time() - 24*60*60*7);
1162 "SELECT COUNT(*) AS `posts_week` FROM `item` WHERE `uid`=%d AND `wall`
1163 AND `created` > '%s' AND `id` = `parent`",
1168 if (DBM::is_result($r)) {
1169 $posts_week = $r[0]["posts_week"];
1174 if ($posts_week > $throttle_week) {
1175 logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1176 // die(api_error($type, sprintf(t("Weekly posting limit of %d posts reached. The post was rejected."), $throttle_week)));
1177 throw new TooManyRequestsException(sprintf(t("Weekly posting limit of %d posts reached. The post was rejected."), $throttle_week));
1181 $throttle_month = Config::get('system', 'throttle_limit_month');
1182 if ($throttle_month > 0) {
1183 $datefrom = date("Y-m-d H:i:s", time() - 24*60*60*30);
1186 "SELECT COUNT(*) AS `posts_month` FROM `item` WHERE `uid`=%d AND `wall`
1187 AND `created` > '%s' AND `id` = `parent`",
1192 if (DBM::is_result($r)) {
1193 $posts_month = $r[0]["posts_month"];
1198 if ($posts_month > $throttle_month) {
1199 logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1200 // die(api_error($type, sprintf(t("Monthly posting limit of %d posts reached. The post was rejected."), $throttle_month)));
1201 throw new TooManyRequestsException(sprintf(t("Monthly posting limit of %d posts reached. The post was rejected."), $throttle_month));
1205 $_REQUEST['type'] = 'wall';
1208 if (x($_FILES, 'media')) {
1209 // upload the image if we have one
1210 $_REQUEST['hush'] = 'yeah'; //tell wall_upload function to return img info instead of echo
1211 $media = wall_upload_post($a);
1212 if (strlen($media) > 0) {
1213 $_REQUEST['body'] .= "\n\n" . $media;
1217 // To-Do: Multiple IDs
1218 if (requestdata('media_ids')) {
1220 "SELECT `resource-id`, `scale`, `nickname`, `type` FROM `photo` INNER JOIN `user` ON `user`.`uid` = `photo`.`uid` WHERE `resource-id` IN (SELECT `resource-id` FROM `photo` WHERE `id` = %d) AND `scale` > 0 AND `photo`.`uid` = %d ORDER BY `photo`.`width` DESC LIMIT 1",
1221 intval(requestdata('media_ids')),
1224 if (DBM::is_result($r)) {
1225 $phototypes = Image::supportedTypes();
1226 $ext = $phototypes[$r[0]['type']];
1227 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1228 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1232 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1234 $_REQUEST['api_source'] = true;
1236 if (!x($_REQUEST, "source")) {
1237 $_REQUEST["source"] = api_source();
1240 // call out normal post function
1243 // this should output the last post (the one we just posted).
1244 return api_status_show($type);
1247 /// @TODO move to top of file or somwhere better
1248 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1249 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1251 function api_media_upload($type)
1255 if (api_user() === false) {
1257 throw new ForbiddenException();
1260 $user_info = api_get_user($a);
1262 if (!x($_FILES, 'media')) {
1264 throw new BadRequestException("No media.");
1267 $media = wall_upload_post($a, false);
1270 throw new InternalServerErrorException();
1273 $returndata = array();
1274 $returndata["media_id"] = $media["id"];
1275 $returndata["media_id_string"] = (string)$media["id"];
1276 $returndata["size"] = $media["size"];
1277 $returndata["image"] = array("w" => $media["width"],
1278 "h" => $media["height"],
1279 "image_type" => $media["type"]);
1281 logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG);
1283 return array("media" => $returndata);
1286 /// @TODO move to top of file or somwhere better
1287 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1289 function api_status_show($type)
1293 $user_info = api_get_user($a);
1295 logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG);
1297 if ($type == "raw") {
1298 $privacy_sql = "AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''";
1303 // get last public wall message
1307 WHERE `item`.`contact-id` = %d AND `item`.`uid` = %d
1308 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1309 AND `item`.`type` != 'activity' $privacy_sql
1310 ORDER BY `item`.`id` DESC
1312 intval($user_info['cid']),
1314 dbesc($user_info['url']),
1315 dbesc(normalise_link($user_info['url'])),
1316 dbesc($user_info['url']),
1317 dbesc(normalise_link($user_info['url']))
1320 if (DBM::is_result($lastwall)) {
1321 $lastwall = $lastwall[0];
1323 $in_reply_to = api_in_reply_to($lastwall);
1325 $converted = api_convert_item($lastwall);
1327 if ($type == "xml") {
1328 $geo = "georss:point";
1333 $status_info = array(
1334 'created_at' => api_date($lastwall['created']),
1335 'id' => intval($lastwall['id']),
1336 'id_str' => (string) $lastwall['id'],
1337 'text' => $converted["text"],
1338 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1339 'truncated' => false,
1340 'in_reply_to_status_id' => $in_reply_to['status_id'],
1341 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1342 'in_reply_to_user_id' => $in_reply_to['user_id'],
1343 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1344 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1345 'user' => $user_info,
1347 'coordinates' => "",
1349 'contributors' => "",
1350 'is_quote_status' => false,
1351 'retweet_count' => 0,
1352 'favorite_count' => 0,
1353 'favorited' => $lastwall['starred'] ? true : false,
1354 'retweeted' => false,
1355 'possibly_sensitive' => false,
1357 'statusnet_html' => $converted["html"],
1358 'statusnet_conversation_id' => $lastwall['parent'],
1359 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1362 if (count($converted["attachments"]) > 0) {
1363 $status_info["attachments"] = $converted["attachments"];
1366 if (count($converted["entities"]) > 0) {
1367 $status_info["entities"] = $converted["entities"];
1370 if (($lastwall['item_network'] != "") && ($status["source"] == 'web')) {
1371 $status_info["source"] = network_to_name($lastwall['item_network'], $user_info['url']);
1372 } elseif (($lastwall['item_network'] != "") && (network_to_name($lastwall['item_network'], $user_info['url']) != $status_info["source"])) {
1373 $status_info["source"] = trim($status_info["source"].' ('.network_to_name($lastwall['item_network'], $user_info['url']).')');
1376 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1377 unset($status_info["user"]["uid"]);
1378 unset($status_info["user"]["self"]);
1381 logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG);
1383 if ($type == "raw") {
1384 return $status_info;
1387 return api_format_data("statuses", $type, array('status' => $status_info));
1391 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1392 * The author's most recent status will be returned inline.
1393 * http://developer.twitter.com/doc/get/users/show
1395 function api_users_show($type)
1399 $user_info = api_get_user($a);
1403 INNER JOIN `contact` ON `contact`.`id`=`item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1404 WHERE `item`.`uid` = %d AND `verb` = '%s' AND `item`.`contact-id` = %d
1405 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1406 AND `type`!='activity'
1407 AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
1411 dbesc(ACTIVITY_POST),
1412 intval($user_info['cid']),
1413 dbesc($user_info['url']),
1414 dbesc(normalise_link($user_info['url'])),
1415 dbesc($user_info['url']),
1416 dbesc(normalise_link($user_info['url']))
1419 if (DBM::is_result($lastwall)) {
1420 $lastwall = $lastwall[0];
1422 $in_reply_to = api_in_reply_to($lastwall);
1424 $converted = api_convert_item($lastwall);
1426 if ($type == "xml") {
1427 $geo = "georss:point";
1432 $user_info['status'] = array(
1433 'text' => $converted["text"],
1434 'truncated' => false,
1435 'created_at' => api_date($lastwall['created']),
1436 'in_reply_to_status_id' => $in_reply_to['status_id'],
1437 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1438 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1439 'id' => intval($lastwall['contact-id']),
1440 'id_str' => (string) $lastwall['contact-id'],
1441 'in_reply_to_user_id' => $in_reply_to['user_id'],
1442 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1443 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1445 'favorited' => $lastwall['starred'] ? true : false,
1446 'statusnet_html' => $converted["html"],
1447 'statusnet_conversation_id' => $lastwall['parent'],
1448 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1451 if (count($converted["attachments"]) > 0) {
1452 $user_info["status"]["attachments"] = $converted["attachments"];
1455 if (count($converted["entities"]) > 0) {
1456 $user_info["status"]["entities"] = $converted["entities"];
1459 if (($lastwall['item_network'] != "") && ($user_info["status"]["source"] == 'web')) {
1460 $user_info["status"]["source"] = network_to_name($lastwall['item_network'], $user_info['url']);
1463 if (($lastwall['item_network'] != "") && (network_to_name($lastwall['item_network'], $user_info['url']) != $user_info["status"]["source"])) {
1464 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . network_to_name($lastwall['item_network'], $user_info['url']) . ')');
1468 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1469 unset($user_info["uid"]);
1470 unset($user_info["self"]);
1472 return api_format_data("user", $type, array('user' => $user_info));
1475 /// @TODO move to top of file or somewhere better
1476 api_register_func('api/users/show', 'api_users_show');
1477 api_register_func('api/externalprofile/show', 'api_users_show');
1479 function api_users_search($type)
1483 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1485 $userlist = array();
1487 if (x($_GET, 'q')) {
1488 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", dbesc($_GET["q"]));
1490 if (!DBM::is_result($r)) {
1491 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", dbesc($_GET["q"]));
1494 if (DBM::is_result($r)) {
1496 foreach ($r as $user) {
1497 $user_info = api_get_user($a, $user["id"]);
1499 if ($type == "xml") {
1500 $userlist[$k++.":user"] = $user_info;
1502 $userlist[] = $user_info;
1505 $userlist = array("users" => $userlist);
1507 throw new BadRequestException("User not found.");
1510 throw new BadRequestException("User not found.");
1512 return api_format_data("users", $type, $userlist);
1515 /// @TODO move to top of file or somewhere better
1516 api_register_func('api/users/search', 'api_users_search');
1519 * Return user objects
1521 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1523 * @param string $type Return format: json or xml
1525 * @return array|string
1526 * @throws NotFoundException if the results are empty.
1528 function api_users_lookup($type)
1532 if (x($_REQUEST['user_id'])) {
1533 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1535 $users[] = api_get_user(get_app(), $id);
1540 if (empty($users)) {
1541 throw new NotFoundException;
1544 return api_format_data("users", $type, array('users' => $users));
1547 /// @TODO move to top of file or somewhere better
1548 api_register_func('api/users/lookup', 'api_users_lookup', true);
1551 * Returns statuses that match a specified query.
1553 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1555 * @param string $type Return format: json, xml, atom, rss
1557 * @return array|string
1558 * @throws BadRequestException if the "q" parameter is missing.
1560 function api_search($type)
1564 if (!x($_REQUEST, 'q')) {
1565 throw new BadRequestException("q parameter is required.");
1568 if (x($_REQUEST, 'rpp')) {
1569 $count = $_REQUEST['rpp'];
1570 } elseif (x($_REQUEST, 'count')) {
1571 $count = $_REQUEST['count'];
1576 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1577 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1578 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1580 $start = $page * $count;
1583 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1587 "SELECT ".item_fieldlists()."
1588 FROM `item` ".item_joins()."
1589 WHERE ".item_condition()." AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))
1590 AND `item`.`body` LIKE CONCAT('%',?,'%')
1593 ORDER BY `item`.`id` DESC LIMIT ".intval($start)." ,".intval($count)." ",
1599 $data['status'] = api_format_items(dba::inArray($r), api_get_user(get_app()));
1601 return api_format_data("statuses", $type, $data);
1604 /// @TODO move to top of file or somewhere better
1605 api_register_func('api/search/tweets', 'api_search', true);
1606 api_register_func('api/search', 'api_search', true);
1610 * http://developer.twitter.com/doc/get/statuses/home_timeline
1612 * TODO: Optional parameters
1613 * TODO: Add reply info
1615 function api_statuses_home_timeline($type)
1619 if (api_user() === false) {
1620 throw new ForbiddenException();
1623 unset($_REQUEST["user_id"]);
1624 unset($_GET["user_id"]);
1626 unset($_REQUEST["screen_name"]);
1627 unset($_GET["screen_name"]);
1629 $user_info = api_get_user($a);
1630 // get last newtork messages
1633 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1634 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1638 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1639 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1640 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1641 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1642 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1644 $start = $page * $count;
1648 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1650 if ($exclude_replies > 0) {
1651 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
1653 if ($conversation_id > 0) {
1654 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1658 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
1659 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
1660 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
1661 `contact`.`id` AS `cid`
1663 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1664 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
1665 WHERE `item`.`uid` = %d AND `verb` = '%s'
1666 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
1669 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
1671 dbesc(ACTIVITY_POST),
1677 $ret = api_format_items($r, $user_info, false, $type);
1679 // Set all posts from the query above to seen
1681 foreach ($r as $item) {
1682 $idarray[] = intval($item["id"]);
1685 $idlist = implode(",", $idarray);
1687 if ($idlist != "") {
1688 $unseen = q("SELECT `id` FROM `item` WHERE `unseen` AND `id` IN (%s)", $idlist);
1691 $r = q("UPDATE `item` SET `unseen` = 0 WHERE `unseen` AND `id` IN (%s)", $idlist);
1695 $data = array('status' => $ret);
1699 $data = api_rss_extra($a, $data, $user_info);
1703 return api_format_data("statuses", $type, $data);
1706 /// @TODO move to top of file or somewhere better
1707 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1708 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1710 function api_statuses_public_timeline($type)
1714 if (api_user() === false) {
1715 throw new ForbiddenException();
1718 $user_info = api_get_user($a);
1719 // get last newtork messages
1722 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1723 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
1727 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1728 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1729 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1730 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1731 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1733 $start = $page * $count;
1735 if ($exclude_replies && !$conversation_id) {
1737 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1740 $r = dba::p("SELECT " . item_fieldlists() . "
1742 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1743 " . item_joins() . "
1744 STRAIGHT_JOIN `user` ON `user`.`uid` = `thread`.`uid`
1745 AND NOT `user`.`hidewall`
1747 AND NOT `thread`.`private`
1749 AND `thread`.`visible`
1750 AND NOT `thread`.`deleted`
1751 AND NOT `thread`.`moderated`
1752 AND `thread`.`iid` > ?
1754 ORDER BY `thread`.`iid` DESC
1755 LIMIT " . intval($start) . ", " . intval($count),
1760 $r = dba::inArray($r);
1763 $sql_extra = 'AND `item`.`id` <= ' . intval($max_id);
1765 if ($conversation_id > 0) {
1766 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1769 $r = dba::p("SELECT " . item_fieldlists() . "
1771 " . item_joins() . "
1772 STRAIGHT_JOIN `user` ON `user`.`uid` = `item`.`uid`
1773 AND NOT `user`.`hidewall`
1775 AND NOT `item`.`private`
1777 AND `item`.`visible`
1778 AND NOT `item`.`deleted`
1779 AND NOT `item`.`moderated`
1782 ORDER BY `item`.`id` DESC
1783 LIMIT " . intval($start) . ", " . intval($count),
1788 $r = dba::inArray($r);
1791 $ret = api_format_items($r, $user_info, false, $type);
1793 $data = array('status' => $ret);
1797 $data = api_rss_extra($a, $data, $user_info);
1801 return api_format_data("statuses", $type, $data);
1804 /// @TODO move to top of file or somewhere better
1805 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1808 * @brief Returns the list of public federated posts this node knows about
1810 * @param string $type Return format: json, xml, atom, rss
1811 * @return array|string
1812 * @throws ForbiddenException
1814 function api_statuses_networkpublic_timeline($type)
1818 if (api_user() === false) {
1819 throw new ForbiddenException();
1822 $user_info = api_get_user($a);
1824 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
1825 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
1828 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
1829 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
1833 $start = ($page - 1) * $count;
1837 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1840 $r = dba::p("SELECT " . item_fieldlists() . "
1842 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1843 " . item_joins() . "
1844 WHERE `thread`.`uid` = 0
1846 AND NOT `thread`.`private`
1847 AND `thread`.`visible`
1848 AND NOT `thread`.`deleted`
1849 AND NOT `thread`.`moderated`
1850 AND `thread`.`iid` > ?
1852 ORDER BY `thread`.`iid` DESC
1853 LIMIT " . intval($start) . ", " . intval($count),
1858 $r = dba::inArray($r);
1860 $ret = api_format_items($r, $user_info, false, $type);
1862 $data = array('status' => $ret);
1866 $data = api_rss_extra($a, $data, $user_info);
1870 return api_format_data("statuses", $type, $data);
1873 /// @TODO move to top of file or somewhere better
1874 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1877 * @TODO nothing to say?
1879 function api_statuses_show($type)
1883 if (api_user() === false) {
1884 throw new ForbiddenException();
1887 $user_info = api_get_user($a);
1890 $id = intval($a->argv[3]);
1893 $id = intval($_REQUEST["id"]);
1898 $id = intval($a->argv[4]);
1901 logger('API: api_statuses_show: ' . $id);
1903 $conversation = (x($_REQUEST, 'conversation') ? 1 : 0);
1906 if ($conversation) {
1907 $sql_extra .= " AND `item`.`parent` = %d ORDER BY `id` ASC ";
1909 $sql_extra .= " AND `item`.`id` = %d";
1913 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
1914 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
1915 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
1916 `contact`.`id` AS `cid`
1918 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1919 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
1920 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
1921 AND `item`.`uid` = %d AND `item`.`verb` = '%s'
1924 dbesc(ACTIVITY_POST),
1928 /// @TODO How about copying this to above methods which don't check $r ?
1929 if (!DBM::is_result($r)) {
1930 throw new BadRequestException("There is no status with this id.");
1933 $ret = api_format_items($r, $user_info, false, $type);
1935 if ($conversation) {
1936 $data = array('status' => $ret);
1937 return api_format_data("statuses", $type, $data);
1939 $data = array('status' => $ret[0]);
1940 return api_format_data("status", $type, $data);
1944 /// @TODO move to top of file or somewhere better
1945 api_register_func('api/statuses/show', 'api_statuses_show', true);
1948 * @TODO nothing to say?
1950 function api_conversation_show($type)
1954 if (api_user() === false) {
1955 throw new ForbiddenException();
1958 $user_info = api_get_user($a);
1961 $id = intval($a->argv[3]);
1962 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1963 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1967 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1968 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1970 $start = $page*$count;
1973 $id = intval($_REQUEST["id"]);
1978 $id = intval($a->argv[4]);
1981 logger('API: api_conversation_show: '.$id);
1983 $r = q("SELECT `parent` FROM `item` WHERE `id` = %d", intval($id));
1984 if (DBM::is_result($r)) {
1985 $id = $r[0]["parent"];
1991 $sql_extra = ' AND `item`.`id` <= ' . intval($max_id);
1994 // Not sure why this query was so complicated. We should keep it here for a while,
1995 // just to make sure that we really don't need it.
1996 // FROM `item` INNER JOIN (SELECT `uri`,`parent` FROM `item` WHERE `id` = %d) AS `temp1`
1997 // ON (`item`.`thr-parent` = `temp1`.`uri` AND `item`.`parent` = `temp1`.`parent`)
2000 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2001 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2002 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2003 `contact`.`id` AS `cid`
2005 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2006 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2007 WHERE `item`.`parent` = %d AND `item`.`visible`
2008 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2009 AND `item`.`uid` = %d AND `item`.`verb` = '%s'
2010 AND `item`.`id`>%d $sql_extra
2011 ORDER BY `item`.`id` DESC LIMIT %d ,%d",
2012 intval($id), intval(api_user()),
2013 dbesc(ACTIVITY_POST),
2015 intval($start), intval($count)
2018 if (!DBM::is_result($r)) {
2019 throw new BadRequestException("There is no status with this id.");
2022 $ret = api_format_items($r, $user_info, false, $type);
2024 $data = array('status' => $ret);
2025 return api_format_data("statuses", $type, $data);
2028 /// @TODO move to top of file or somewhere better
2029 api_register_func('api/conversation/show', 'api_conversation_show', true);
2030 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
2033 * @TODO nothing to say?
2035 function api_statuses_repeat($type)
2041 if (api_user() === false) {
2042 throw new ForbiddenException();
2045 $user_info = api_get_user($a);
2048 $id = intval($a->argv[3]);
2051 $id = intval($_REQUEST["id"]);
2056 $id = intval($a->argv[4]);
2059 logger('API: api_statuses_repeat: '.$id);
2062 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`, `contact`.`nick` as `reply_author`,
2063 `contact`.`name`, `contact`.`photo` as `reply_photo`, `contact`.`url` as `reply_url`, `contact`.`rel`,
2064 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2065 `contact`.`id` AS `cid`
2067 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2068 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2069 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2070 AND NOT `item`.`private` AND `item`.`allow_cid` = '' AND `item`.`allow_gid` = ''
2071 AND `item`.`deny_cid` = '' AND `item`.`deny_gid` = ''
2073 AND `item`.`id`=%d",
2077 /// @TODO other style than above functions!
2078 if (DBM::is_result($r) && $r[0]['body'] != "") {
2079 if (strpos($r[0]['body'], "[/share]") !== false) {
2080 $pos = strpos($r[0]['body'], "[share");
2081 $post = substr($r[0]['body'], $pos);
2083 $post = share_header($r[0]['author-name'], $r[0]['author-link'], $r[0]['author-avatar'], $r[0]['guid'], $r[0]['created'], $r[0]['plink']);
2085 $post .= $r[0]['body'];
2086 $post .= "[/share]";
2088 $_REQUEST['body'] = $post;
2089 $_REQUEST['profile_uid'] = api_user();
2090 $_REQUEST['type'] = 'wall';
2091 $_REQUEST['api_source'] = true;
2093 if (!x($_REQUEST, "source")) {
2094 $_REQUEST["source"] = api_source();
2099 throw new ForbiddenException();
2102 // this should output the last post (the one we just posted).
2104 return api_status_show($type);
2107 /// @TODO move to top of file or somewhere better
2108 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2111 * @TODO nothing to say?
2113 function api_statuses_destroy($type)
2117 if (api_user() === false) {
2118 throw new ForbiddenException();
2121 $user_info = api_get_user($a);
2124 $id = intval($a->argv[3]);
2127 $id = intval($_REQUEST["id"]);
2132 $id = intval($a->argv[4]);
2135 logger('API: api_statuses_destroy: '.$id);
2137 $ret = api_statuses_show($type);
2139 drop_item($id, false);
2144 /// @TODO move to top of file or somewhere better
2145 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2148 * @TODO Nothing more than an URL to say?
2149 * http://developer.twitter.com/doc/get/statuses/mentions
2151 function api_statuses_mentions($type)
2155 if (api_user() === false) {
2156 throw new ForbiddenException();
2159 unset($_REQUEST["user_id"]);
2160 unset($_GET["user_id"]);
2162 unset($_REQUEST["screen_name"]);
2163 unset($_GET["screen_name"]);
2165 $user_info = api_get_user($a);
2166 // get last newtork messages
2170 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
2171 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2175 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2176 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2177 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
2179 $start = $page * $count;
2181 // Ugly code - should be changed
2182 $myurl = System::baseUrl() . '/profile/'. $a->user['nickname'];
2183 $myurl = substr($myurl, strpos($myurl, '://') + 3);
2184 //$myurl = str_replace(array('www.','.'),array('','\\.'),$myurl);
2185 $myurl = str_replace('www.', '', $myurl);
2186 $diasp_url = str_replace('/profile/', '/u/', $myurl);
2189 $sql_extra = ' AND `item`.`id` <= ' . intval($max_id);
2193 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2194 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2195 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2196 `contact`.`id` AS `cid`
2197 FROM `item` FORCE INDEX (`uid_id`)
2198 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2199 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2200 WHERE `item`.`uid` = %d AND `verb` = '%s'
2201 AND NOT (`item`.`author-link` IN ('https://%s', 'http://%s'))
2202 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2203 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `uid` = %d AND `mention` AND !`ignored`)
2206 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2208 dbesc(ACTIVITY_POST),
2209 dbesc(protect_sprintf($myurl)),
2210 dbesc(protect_sprintf($myurl)),
2217 $ret = api_format_items($r, $user_info, false, $type);
2219 $data = array('status' => $ret);
2223 $data = api_rss_extra($a, $data, $user_info);
2227 return api_format_data("statuses", $type, $data);
2230 /// @TODO move to top of file or somewhere better
2231 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2232 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2235 * @brief Returns a user's public timeline
2237 * @param string $type Either "json" or "xml"
2238 * @return string|array
2239 * @throws ForbiddenException
2241 function api_statuses_user_timeline($type)
2245 if (api_user() === false) {
2246 throw new ForbiddenException();
2249 $user_info = api_get_user($a);
2252 "api_statuses_user_timeline: api_user: ". api_user() .
2253 "\nuser_info: ".print_r($user_info, true) .
2254 "\n_REQUEST: ".print_r($_REQUEST, true),
2258 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
2259 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
2260 $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0;
2261 $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0;
2264 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
2265 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
2269 $start = ($page - 1) * $count;
2272 if ($user_info['self'] == 1) {
2273 $sql_extra .= " AND `item`.`wall` = 1 ";
2276 if ($exclude_replies > 0) {
2277 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
2280 if ($conversation_id > 0) {
2281 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
2285 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2289 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2290 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2291 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2292 `contact`.`id` AS `cid`
2293 FROM `item` FORCE INDEX (`uid_contactid_id`)
2294 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2295 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2296 WHERE `item`.`uid` = %d AND `verb` = '%s'
2297 AND `item`.`contact-id` = %d
2298 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2300 AND `item`.`id` > %d
2301 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2303 dbesc(ACTIVITY_POST),
2304 intval($user_info['cid']),
2310 $ret = api_format_items($r, $user_info, true, $type);
2312 $data = array('status' => $ret);
2316 $data = api_rss_extra($a, $data, $user_info);
2320 return api_format_data("statuses", $type, $data);
2323 /// @TODO move to top of file or somwhere better
2324 api_register_func('api/statuses/user_timeline','api_statuses_user_timeline', true);
2327 * Star/unstar an item
2328 * param: id : id of the item
2330 * api v1 : https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2332 function api_favorites_create_destroy($type)
2336 if (api_user() === false) {
2337 throw new ForbiddenException();
2340 // for versioned api.
2341 /// @TODO We need a better global soluton
2342 $action_argv_id = 2;
2343 if ($a->argv[1] == "1.1") {
2344 $action_argv_id = 3;
2347 if ($a->argc <= $action_argv_id) {
2348 throw new BadRequestException("Invalid request.");
2350 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2351 if ($a->argc == $action_argv_id + 2) {
2352 $itemid = intval($a->argv[$action_argv_id + 1]);
2354 /// @TODO use x() to check if _REQUEST contains 'id'
2355 $itemid = intval($_REQUEST['id']);
2358 $item = q("SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d LIMIT 1", $itemid, api_user());
2360 if (!DBM::is_result($item) || count($item) == 0) {
2361 throw new BadRequestException("Invalid item.");
2366 $item[0]['starred'] = 1;
2369 $item[0]['starred'] = 0;
2372 throw new BadRequestException("Invalid action ".$action);
2375 $r = q("UPDATE item SET starred=%d WHERE id=%d AND uid=%d", $item[0]['starred'], $itemid, api_user());
2377 q("UPDATE thread SET starred=%d WHERE iid=%d AND uid=%d", $item[0]['starred'], $itemid, api_user());
2380 throw new InternalServerErrorException("DB error");
2384 $user_info = api_get_user($a);
2385 $rets = api_format_items($item, $user_info, false, $type);
2388 $data = array('status' => $ret);
2392 $data = api_rss_extra($a, $data, $user_info);
2395 return api_format_data("status", $type, $data);
2398 /// @TODO move to top of file or somwhere better
2399 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2400 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2402 function api_favorites($type)
2408 if (api_user() === false) {
2409 throw new ForbiddenException();
2412 $called_api = array();
2414 $user_info = api_get_user($a);
2416 // in friendica starred item are private
2417 // return favorites only for self
2418 logger('api_favorites: self:' . $user_info['self']);
2420 if ($user_info['self'] == 0) {
2426 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2427 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2428 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
2429 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2434 $start = $page*$count;
2437 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2441 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2442 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2443 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2444 `contact`.`id` AS `cid`
2445 FROM `item`, `contact`
2446 WHERE `item`.`uid` = %d
2447 AND `item`.`visible` = 1 AND `item`.`moderated` = 0 AND `item`.`deleted` = 0
2448 AND `item`.`starred` = 1
2449 AND `contact`.`id` = `item`.`contact-id`
2450 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2453 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2460 $ret = api_format_items($r, $user_info, false, $type);
2463 $data = array('status' => $ret);
2467 $data = api_rss_extra($a, $data, $user_info);
2470 return api_format_data("statuses", $type, $data);
2473 /// @TODO move to top of file or somwhere better
2474 api_register_func('api/favorites', 'api_favorites', true);
2476 function api_format_messages($item, $recipient, $sender)
2478 // standard meta information
2480 'id' => $item['id'],
2481 'sender_id' => $sender['id'] ,
2483 'recipient_id' => $recipient['id'],
2484 'created_at' => api_date($item['created']),
2485 'sender_screen_name' => $sender['screen_name'],
2486 'recipient_screen_name' => $recipient['screen_name'],
2487 'sender' => $sender,
2488 'recipient' => $recipient,
2490 'friendica_seen' => $item['seen'],
2491 'friendica_parent_uri' => $item['parent-uri'],
2494 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2495 unset($ret["sender"]["uid"]);
2496 unset($ret["sender"]["self"]);
2497 unset($ret["recipient"]["uid"]);
2498 unset($ret["recipient"]["self"]);
2500 //don't send title to regular StatusNET requests to avoid confusing these apps
2501 if (x($_GET, 'getText')) {
2502 $ret['title'] = $item['title'];
2503 if ($_GET['getText'] == 'html') {
2504 $ret['text'] = bbcode($item['body'], false, false);
2505 } elseif ($_GET['getText'] == 'plain') {
2506 //$ret['text'] = html2plain(bbcode($item['body'], false, false, true), 0);
2507 $ret['text'] = trim(html2plain(bbcode(api_clean_plain_items($item['body']), false, false, 2, true), 0));
2510 $ret['text'] = $item['title'] . "\n" . html2plain(bbcode(api_clean_plain_items($item['body']), false, false, 2, true), 0);
2512 if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') {
2513 unset($ret['sender']);
2514 unset($ret['recipient']);
2520 function api_convert_item($item)
2522 $body = $item['body'];
2523 $attachments = api_get_attachments($body);
2525 // Workaround for ostatus messages where the title is identically to the body
2526 $html = bbcode(api_clean_plain_items($body), false, false, 2, true);
2527 $statusbody = trim(html2plain($html, 0));
2529 // handle data: images
2530 $statusbody = api_format_items_embeded_images($item, $statusbody);
2532 $statustitle = trim($item['title']);
2534 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2535 $statustext = trim($statusbody);
2537 $statustext = trim($statustitle."\n\n".$statusbody);
2540 if (($item["network"] == NETWORK_FEED) && (strlen($statustext)> 1000)) {
2541 $statustext = substr($statustext, 0, 1000)."... \n".$item["plink"];
2544 $statushtml = trim(bbcode($body, false, false));
2546 // Workaround for clients with limited HTML parser functionality
2547 $search = array("<br>", "<blockquote>", "</blockquote>",
2548 "<h1>", "</h1>", "<h2>", "</h2>",
2549 "<h3>", "</h3>", "<h4>", "</h4>",
2550 "<h5>", "</h5>", "<h6>", "</h6>");
2551 $replace = array("<br>", "<br><blockquote>", "</blockquote><br>",
2552 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2553 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2554 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>");
2555 $statushtml = str_replace($search, $replace, $statushtml);
2557 if ($item['title'] != "") {
2558 $statushtml = "<br><h4>" . bbcode($item['title']) . "</h4><br>" . $statushtml;
2562 $oldtext = $statushtml;
2563 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2564 } while ($oldtext != $statushtml);
2566 if (substr($statushtml, 0, 4) == '<br>') {
2567 $statushtml = substr($statushtml, 4);
2570 if (substr($statushtml, 0, -4) == '<br>') {
2571 $statushtml = substr($statushtml, -4);
2574 // feeds without body should contain the link
2575 if (($item['network'] == NETWORK_FEED) && (strlen($item['body']) == 0)) {
2576 $statushtml .= bbcode($item['plink']);
2579 $entities = api_get_entitities($statustext, $body);
2582 "text" => $statustext,
2583 "html" => $statushtml,
2584 "attachments" => $attachments,
2585 "entities" => $entities
2589 function api_get_attachments(&$body)
2592 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2594 $URLSearchString = "^\[\]";
2595 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2601 $attachments = array();
2603 foreach ($images[1] as $image) {
2604 $imagedata = Image::getInfoFromURL($image);
2607 $attachments[] = array("url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]);
2611 if (strstr($_SERVER['HTTP_USER_AGENT'], "AndStatus")) {
2612 foreach ($images[0] as $orig) {
2613 $body = str_replace($orig, "", $body);
2617 return $attachments;
2620 function api_get_entitities(&$text, $bbcode)
2624 * Links at the first character of the post
2629 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
2631 if ($include_entities != "true") {
2632 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2634 foreach ($images[1] as $image) {
2635 $replace = proxy_url($image);
2636 $text = str_replace($image, $replace, $text);
2641 $bbcode = bb_CleanPictureLinks($bbcode);
2643 // Change pure links in text to bbcode uris
2644 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2646 $entities = array();
2647 $entities["hashtags"] = array();
2648 $entities["symbols"] = array();
2649 $entities["urls"] = array();
2650 $entities["user_mentions"] = array();
2652 $URLSearchString = "^\[\]";
2654 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2656 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2657 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2658 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2660 $bbcode = preg_replace(
2661 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2662 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2665 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2667 $bbcode = preg_replace(
2668 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2669 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2672 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2674 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2676 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2677 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2679 $ordered_urls = array();
2680 foreach ($urls[1] as $id => $url) {
2681 //$start = strpos($text, $url, $offset);
2682 $start = iconv_strpos($text, $url, 0, "UTF-8");
2683 if (!($start === false)) {
2684 $ordered_urls[$start] = array("url" => $url, "title" => $urls[2][$id]);
2688 ksort($ordered_urls);
2691 //foreach ($urls[1] AS $id=>$url) {
2692 foreach ($ordered_urls as $url) {
2693 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2694 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2696 $display_url = $url["title"];
2698 $display_url = str_replace(array("http://www.", "https://www."), array("", ""), $url["url"]);
2699 $display_url = str_replace(array("http://", "https://"), array("", ""), $display_url);
2701 if (strlen($display_url) > 26)
2702 $display_url = substr($display_url, 0, 25)."…";
2705 //$start = strpos($text, $url, $offset);
2706 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2707 if (!($start === false)) {
2708 $entities["urls"][] = array("url" => $url["url"],
2709 "expanded_url" => $url["url"],
2710 "display_url" => $display_url,
2711 "indices" => array($start, $start+strlen($url["url"])));
2712 $offset = $start + 1;
2716 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2717 $ordered_images = array();
2718 foreach ($images[1] as $image) {
2719 //$start = strpos($text, $url, $offset);
2720 $start = iconv_strpos($text, $image, 0, "UTF-8");
2721 if (!($start === false))
2722 $ordered_images[$start] = $image;
2724 //$entities["media"] = array();
2727 foreach ($ordered_images as $url) {
2728 $display_url = str_replace(array("http://www.", "https://www."), array("", ""), $url);
2729 $display_url = str_replace(array("http://", "https://"), array("", ""), $display_url);
2731 if (strlen($display_url) > 26)
2732 $display_url = substr($display_url, 0, 25)."…";
2734 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2735 if (!($start === false)) {
2736 $image = Image::getInfoFromURL($url);
2738 // If image cache is activated, then use the following sizes:
2739 // thumb (150), small (340), medium (600) and large (1024)
2740 if (!Config::get("system", "proxy_disabled")) {
2741 $media_url = proxy_url($url);
2744 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2745 $sizes["thumb"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2747 if (($image[0] > 150) || ($image[1] > 150)) {
2748 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2749 $sizes["small"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2752 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2753 $sizes["medium"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2755 if (($image[0] > 600) || ($image[1] > 600)) {
2756 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2757 $sizes["large"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2761 $sizes["medium"] = array("w" => $image[0], "h" => $image[1], "resize" => "fit");
2764 $entities["media"][] = array(
2766 "id_str" => (string)$start+1,
2767 "indices" => array($start, $start+strlen($url)),
2768 "media_url" => normalise_link($media_url),
2769 "media_url_https" => $media_url,
2771 "display_url" => $display_url,
2772 "expanded_url" => $url,
2776 $offset = $start + 1;
2782 function api_format_items_embeded_images(&$item, $text)
2784 $text = preg_replace_callback(
2785 "|data:image/([^;]+)[^=]+=*|m",
2786 function ($match) use ($item) {
2787 return System::baseUrl()."/display/".$item['guid'];
2796 * @brief return <a href='url'>name</a> as array
2798 * @param string $txt text
2803 function api_contactlink_to_array($txt)
2806 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2807 if ($r && count($match)==3) {
2809 'name' => $match[2],
2823 * @brief return likes, dislikes and attend status for item
2825 * @param array $item array
2827 * likes => int count
2828 * dislikes => int count
2830 function api_format_items_activities(&$item, $type = "json")
2834 $activities = array(
2836 'dislike' => array(),
2837 'attendyes' => array(),
2838 'attendno' => array(),
2839 'attendmaybe' => array(),
2844 WHERE uid=%d AND `thr-parent`="%s" AND visible AND NOT deleted',
2845 intval($item['uid']),
2849 foreach ($items as $i) {
2850 // not used as result should be structured like other user data
2851 //builtin_activity_puller($i, $activities);
2853 // get user data and add it to the array of the activity
2854 $user = api_get_user($a, $i['author-link']);
2855 switch ($i['verb']) {
2857 $activities['like'][] = $user;
2859 case ACTIVITY_DISLIKE:
2860 $activities['dislike'][] = $user;
2862 case ACTIVITY_ATTEND:
2863 $activities['attendyes'][] = $user;
2865 case ACTIVITY_ATTENDNO:
2866 $activities['attendno'][] = $user;
2868 case ACTIVITY_ATTENDMAYBE:
2869 $activities['attendmaybe'][] = $user;
2876 if ($type == "xml") {
2877 $xml_activities = array();
2878 foreach ($activities as $k => $v) {
2879 // change xml element from "like" to "friendica:like"
2880 $xml_activities["friendica:".$k] = $v;
2881 // add user data into xml output
2883 foreach ($v as $user)
2884 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2886 $activities = $xml_activities;
2894 * @brief return data from profiles
2896 * @param array $profile array containing data from db table 'profile'
2897 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
2900 function api_format_items_profiles(&$profile = null, $type = "json")
2902 if ($profile != null) {
2903 $profile = array('profile_id' => $profile['id'],
2904 'profile_name' => $profile['profile-name'],
2905 'is_default' => $profile['is-default'] ? true : false,
2906 'hide_friends'=> $profile['hide-friends'] ? true : false,
2907 'profile_photo' => $profile['photo'],
2908 'profile_thumb' => $profile['thumb'],
2909 'publish' => $profile['publish'] ? true : false,
2910 'net_publish' => $profile['net-publish'] ? true : false,
2911 'description' => $profile['pdesc'],
2912 'date_of_birth' => $profile['dob'],
2913 'address' => $profile['address'],
2914 'city' => $profile['locality'],
2915 'region' => $profile['region'],
2916 'postal_code' => $profile['postal-code'],
2917 'country' => $profile['country-name'],
2918 'hometown' => $profile['hometown'],
2919 'gender' => $profile['gender'],
2920 'marital' => $profile['marital'],
2921 'marital_with' => $profile['with'],
2922 'marital_since' => $profile['howlong'],
2923 'sexual' => $profile['sexual'],
2924 'politic' => $profile['politic'],
2925 'religion' => $profile['religion'],
2926 'public_keywords' => $profile['pub_keywords'],
2927 'private_keywords' => $profile['prv_keywords'],
2928 'likes' => bbcode(api_clean_plain_items($profile['likes']), false, false, 2, false),
2929 'dislikes' => bbcode(api_clean_plain_items($profile['dislikes']), false, false, 2, false),
2930 'about' => bbcode(api_clean_plain_items($profile['about']), false, false, 2, false),
2931 'music' => bbcode(api_clean_plain_items($profile['music']), false, false, 2, false),
2932 'book' => bbcode(api_clean_plain_items($profile['book']), false, false, 2, false),
2933 'tv' => bbcode(api_clean_plain_items($profile['tv']), false, false, 2, false),
2934 'film' => bbcode(api_clean_plain_items($profile['film']), false, false, 2, false),
2935 'interest' => bbcode(api_clean_plain_items($profile['interest']), false, false, 2, false),
2936 'romance' => bbcode(api_clean_plain_items($profile['romance']), false, false, 2, false),
2937 'work' => bbcode(api_clean_plain_items($profile['work']), false, false, 2, false),
2938 'education' => bbcode(api_clean_plain_items($profile['education']), false, false, 2, false),
2939 'social_networks' => bbcode(api_clean_plain_items($profile['contact']), false, false, 2, false),
2940 'homepage' => $profile['homepage'],
2947 * @brief format items to be returned by api
2949 * @param array $r array of items
2950 * @param array $user_info
2951 * @param bool $filter_user filter items by $user_info
2953 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
2959 foreach ($r as $item) {
2960 localize_item($item);
2961 list($status_user, $owner_user) = api_item_get_user($a, $item);
2963 // Look if the posts are matching if they should be filtered by user id
2964 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2968 $in_reply_to = api_in_reply_to($item);
2970 $converted = api_convert_item($item);
2972 if ($type == "xml") {
2973 $geo = "georss:point";
2979 'text' => $converted["text"],
2980 'truncated' => false,
2981 'created_at'=> api_date($item['created']),
2982 'in_reply_to_status_id' => $in_reply_to['status_id'],
2983 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
2984 'source' => (($item['app']) ? $item['app'] : 'web'),
2985 'id' => intval($item['id']),
2986 'id_str' => (string) intval($item['id']),
2987 'in_reply_to_user_id' => $in_reply_to['user_id'],
2988 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
2989 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
2991 'favorited' => $item['starred'] ? true : false,
2992 'user' => $status_user ,
2993 'friendica_owner' => $owner_user,
2994 //'entities' => NULL,
2995 'statusnet_html' => $converted["html"],
2996 'statusnet_conversation_id' => $item['parent'],
2997 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
2998 'friendica_activities' => api_format_items_activities($item, $type),
3001 if (count($converted["attachments"]) > 0) {
3002 $status["attachments"] = $converted["attachments"];
3005 if (count($converted["entities"]) > 0) {
3006 $status["entities"] = $converted["entities"];
3009 if (($item['item_network'] != "") && ($status["source"] == 'web')) {
3010 $status["source"] = network_to_name($item['item_network'], $user_info['url']);
3011 } elseif (($item['item_network'] != "") && (network_to_name($item['item_network'], $user_info['url']) != $status["source"])) {
3012 $status["source"] = trim($status["source"].' ('.network_to_name($item['item_network'], $user_info['url']).')');
3016 // Retweets are only valid for top postings
3017 // It doesn't work reliable with the link if its a feed
3018 //$IsRetweet = ($item['owner-link'] != $item['author-link']);
3020 // $IsRetweet = (($item['owner-name'] != $item['author-name']) || ($item['owner-avatar'] != $item['author-avatar']));
3023 if ($item["id"] == $item["parent"]) {
3024 $retweeted_item = api_share_as_retweet($item);
3025 if ($retweeted_item !== false) {
3026 $retweeted_status = $status;
3028 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-link"]);
3029 } catch (BadRequestException $e) {
3030 // user not found. should be found?
3031 /// @todo check if the user should be always found
3032 $retweeted_status["user"] = array();
3035 $rt_converted = api_convert_item($retweeted_item);
3037 $retweeted_status['text'] = $rt_converted["text"];
3038 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3039 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
3040 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
3041 $status['retweeted_status'] = $retweeted_status;
3045 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3046 unset($status["user"]["uid"]);
3047 unset($status["user"]["self"]);
3049 if ($item["coord"] != "") {
3050 $coords = explode(' ', $item["coord"]);
3051 if (count($coords) == 2) {
3052 if ($type == "json")
3053 $status["geo"] = array('type' => 'Point',
3054 'coordinates' => array((float) $coords[0],
3055 (float) $coords[1]));
3056 else // Not sure if this is the official format - if someone founds a documentation we can check
3057 $status["georss:point"] = $item["coord"];
3065 function api_account_rate_limit_status($type)
3067 if ($type == "xml") {
3069 'remaining-hits' => '150',
3070 '@attributes' => array("type" => "integer"),
3071 'hourly-limit' => '150',
3072 '@attributes2' => array("type" => "integer"),
3073 'reset-time' => datetime_convert('UTC', 'UTC', 'now + 1 hour', ATOM_TIME),
3074 '@attributes3' => array("type" => "datetime"),
3075 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3076 '@attributes4' => array("type" => "integer"),
3080 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3081 'remaining_hits' => '150',
3082 'hourly_limit' => '150',
3083 'reset_time' => api_date(datetime_convert('UTC', 'UTC', 'now + 1 hour', ATOM_TIME)),
3087 return api_format_data('hash', $type, array('hash' => $hash));
3090 /// @TODO move to top of file or somwhere better
3091 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3093 function api_help_test($type)
3095 if ($type == 'xml') {
3101 return api_format_data('ok', $type, array("ok" => $ok));
3104 /// @TODO move to top of file or somwhere better
3105 api_register_func('api/help/test', 'api_help_test', false);
3107 function api_lists($type)
3110 /// @TODO $ret is not filled here?
3111 return api_format_data('lists', $type, array("lists_list" => $ret));
3114 /// @TODO move to top of file or somwhere better
3115 api_register_func('api/lists', 'api_lists', true);
3117 function api_lists_list($type)
3120 /// @TODO $ret is not filled here?
3121 return api_format_data('lists', $type, array("lists_list" => $ret));
3124 /// @TODO move to top of file or somwhere better
3125 api_register_func('api/lists/list', 'api_lists_list', true);
3128 * @brief Returns either the friends of the follower list
3130 * Note: Considers friends and followers lists to be private and won't return
3131 * anything if any user_id parameter is passed.
3133 * @param string $qtype Either "friends" or "followers"
3134 * @return boolean|array
3135 * @throws ForbiddenException
3137 function api_statuses_f($qtype)
3141 if (api_user() === false) {
3142 throw new ForbiddenException();
3146 $count = x($_GET, 'count') ? $_GET['count'] : 20;
3147 $page = x($_GET, 'page') ? $_GET['page'] : 1;
3151 $start = ($page - 1) * $count;
3153 $user_info = api_get_user($a);
3155 if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3156 /* this is to stop Hotot to load friends multiple times
3157 * I'm not sure if I'm missing return something or
3158 * is a bug in hotot. Workaround, meantime
3162 return array('$users' => $ret);*/
3167 if ($qtype == 'friends') {
3168 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_SHARING), intval(CONTACT_IS_FRIEND));
3169 } elseif ($qtype == 'followers') {
3170 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_FOLLOWER), intval(CONTACT_IS_FRIEND));
3173 // friends and followers only for self
3174 if ($user_info['self'] == 0) {
3175 $sql_extra = " AND false ";
3178 if ($qtype == 'blocks') {
3179 $sql_filter = 'AND `blocked` AND NOT `pending`';
3180 } elseif ($qtype == 'incoming') {
3181 $sql_filter = 'AND `pending`';
3183 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3201 foreach ($r as $cid) {
3202 $user = api_get_user($a, $cid['nurl']);
3203 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3204 unset($user["uid"]);
3205 unset($user["self"]);
3212 return array('user' => $ret);
3217 * @brief Returns the list of friends of the provided user
3219 * @deprecated By Twitter API in favor of friends/list
3221 * @param string $type Either "json" or "xml"
3222 * @return boolean|string|array
3224 function api_statuses_friends($type)
3226 $data = api_statuses_f("friends");
3227 if ($data === false) {
3230 return api_format_data("users", $type, $data);
3234 * @brief Returns the list of friends of the provided user
3236 * @deprecated By Twitter API in favor of friends/list
3238 * @param string $type Either "json" or "xml"
3239 * @return boolean|string|array
3241 function api_statuses_followers($type)
3243 $data = api_statuses_f("followers");
3244 if ($data === false) {
3247 return api_format_data("users", $type, $data);
3250 /// @TODO move to top of file or somewhere better
3251 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3252 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3255 * Returns the list of blocked users
3257 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3259 * @param string $type Either "json" or "xml"
3261 * @return boolean|string|array
3263 function api_blocks_list($type)
3265 $data = api_statuses_f('blocks');
3266 if ($data === false) {
3269 return api_format_data("users", $type, $data);
3272 /// @TODO move to top of file or somewhere better
3273 api_register_func('api/blocks/list', 'api_blocks_list', true);
3276 * Returns the list of pending users IDs
3278 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3280 * @param string $type Either "json" or "xml"
3282 * @return boolean|string|array
3284 function api_friendships_incoming($type)
3286 $data = api_statuses_f('incoming');
3287 if ($data === false) {
3292 foreach ($data['user'] as $user) {
3293 $ids[] = $user['id'];
3296 return api_format_data("ids", $type, array('id' => $ids));
3299 /// @TODO move to top of file or somewhere better
3300 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3302 function api_statusnet_config($type)
3306 $name = $a->config['sitename'];
3307 $server = $a->get_hostname();
3308 $logo = System::baseUrl() . '/images/friendica-64.png';
3309 $email = $a->config['admin_email'];
3310 $closed = (($a->config['register_policy'] == REGISTER_CLOSED) ? 'true' : 'false');
3311 $private = ((Config::get('system', 'block_public')) ? 'true' : 'false');
3312 $textlimit = (string) (($a->config['max_import_size']) ? $a->config['max_import_size'] : 200000);
3313 if ($a->config['api_import_size']) {
3314 $texlimit = string($a->config['api_import_size']);
3316 $ssl = ((Config::get('system', 'have_ssl')) ? 'true' : 'false');
3317 $sslserver = (($ssl === 'true') ? str_replace('http:', 'https:', System::baseUrl()) : '');
3320 'site' => array('name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3321 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3322 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3323 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3324 'shorturllength' => '30',
3325 'friendica' => array(
3326 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3327 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3328 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3329 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3334 return api_format_data('config', $type, array('config' => $config));
3337 /// @TODO move to top of file or somewhere better
3338 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3339 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3341 function api_statusnet_version($type)
3344 $fake_statusnet_version = "0.9.7";
3346 return api_format_data('version', $type, array('version' => $fake_statusnet_version));
3349 /// @TODO move to top of file or somewhere better
3350 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3351 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3354 * @todo use api_format_data() to return data
3356 function api_ff_ids($type,$qtype)
3361 throw new ForbiddenException();
3364 $user_info = api_get_user($a);
3366 if ($qtype == 'friends') {
3367 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_SHARING), intval(CONTACT_IS_FRIEND));
3369 if ($qtype == 'followers') {
3370 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_FOLLOWER), intval(CONTACT_IS_FRIEND));
3373 if (!$user_info["self"]) {
3374 $sql_extra = " AND false ";
3377 $stringify_ids = (x($_REQUEST, 'stringify_ids') ? $_REQUEST['stringify_ids'] : false);
3380 "SELECT `pcontact`.`id` FROM `contact`
3381 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3382 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3386 if (!DBM::is_result($r)) {
3391 foreach ($r as $rr) {
3392 if ($stringify_ids) {
3395 $ids[] = intval($rr['id']);
3399 return api_format_data("ids", $type, array('id' => $ids));
3402 function api_friends_ids($type)
3404 return api_ff_ids($type, 'friends');
3407 function api_followers_ids($type)
3409 return api_ff_ids($type, 'followers');
3412 /// @TODO move to top of file or somewhere better
3413 api_register_func('api/friends/ids', 'api_friends_ids', true);
3414 api_register_func('api/followers/ids', 'api_followers_ids', true);
3416 function api_direct_messages_new($type)
3421 if (api_user() === false) throw new ForbiddenException();
3423 if (!x($_POST, "text") || (!x($_POST, "screen_name") && !x($_POST, "user_id"))) return;
3425 $sender = api_get_user($a);
3427 if ($_POST['screen_name']) {
3429 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3431 dbesc($_POST['screen_name'])
3434 // Selecting the id by priority, friendica first
3435 api_best_nickname($r);
3437 $recipient = api_get_user($a, $r[0]['nurl']);
3439 $recipient = api_get_user($a, $_POST['user_id']);
3444 if (x($_REQUEST, 'replyto')) {
3446 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3448 intval($_REQUEST['replyto'])
3450 $replyto = $r[0]['parent-uri'];
3451 $sub = $r[0]['title'];
3453 if (x($_REQUEST, 'title')) {
3454 $sub = $_REQUEST['title'];
3456 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3460 $id = send_message($recipient['cid'], $_POST['text'], $sub, $replyto);
3463 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3464 $ret = api_format_messages($r[0], $recipient, $sender);
3466 $ret = array("error"=>$id);
3469 $data = array('direct_message'=>$ret);
3474 $data = api_rss_extra($a, $data, $user_info);
3477 return api_format_data("direct-messages", $type, $data);
3481 /// @TODO move to top of file or somewhere better
3482 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3485 * @brief delete a direct_message from mail table through api
3487 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3490 function api_direct_messages_destroy($type)
3494 if (api_user() === false) {
3495 throw new ForbiddenException();
3499 $user_info = api_get_user($a);
3501 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3503 $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3504 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3505 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3507 $uid = $user_info['uid'];
3508 // error if no id or parenturi specified (for clients posting parent-uri as well)
3509 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3510 $answer = array('result' => 'error', 'message' => 'message id or parenturi not specified');
3511 return api_format_data("direct_messages_delete", $type, array('$result' => $answer));
3514 // BadRequestException if no id specified (for clients using Twitter API)
3516 throw new BadRequestException('Message id not specified');
3519 // add parent-uri to sql command if specified by calling app
3520 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . dbesc($parenturi) . "'" : "");
3522 // get data of the specified message id
3524 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3529 // error message if specified id is not in database
3530 if (!DBM::is_result($r)) {
3531 if ($verbose == "true") {
3532 $answer = array('result' => 'error', 'message' => 'message id not in database');
3533 return api_format_data("direct_messages_delete", $type, array('$result' => $answer));
3535 /// @todo BadRequestException ok for Twitter API clients?
3536 throw new BadRequestException('message id not in database');
3541 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3546 if ($verbose == "true") {
3549 $answer = array('result' => 'ok', 'message' => 'message deleted');
3550 return api_format_data("direct_message_delete", $type, array('$result' => $answer));
3552 $answer = array('result' => 'error', 'message' => 'unknown error');
3553 return api_format_data("direct_messages_delete", $type, array('$result' => $answer));
3556 /// @todo return JSON data like Twitter API not yet implemented
3560 /// @TODO move to top of file or somewhere better
3561 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3563 function api_direct_messages_box($type, $box, $verbose)
3567 if (api_user() === false) {
3568 throw new ForbiddenException();
3572 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
3573 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
3578 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3579 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3581 $user_id = (x($_REQUEST, 'user_id') ? $_REQUEST['user_id'] : "");
3582 $screen_name = (x($_REQUEST, 'screen_name') ? $_REQUEST['screen_name'] : "");
3585 unset($_REQUEST["user_id"]);
3586 unset($_GET["user_id"]);
3588 unset($_REQUEST["screen_name"]);
3589 unset($_GET["screen_name"]);
3591 $user_info = api_get_user($a);
3592 $profile_url = $user_info["url"];
3595 $start = $page * $count;
3598 if ($box=="sentbox") {
3599 $sql_extra = "`mail`.`from-url`='" . dbesc($profile_url) . "'";
3600 } elseif ($box == "conversation") {
3601 $sql_extra = "`mail`.`parent-uri`='" . dbesc($_GET["uri"]) . "'";
3602 } elseif ($box == "all") {
3603 $sql_extra = "true";
3604 } elseif ($box == "inbox") {
3605 $sql_extra = "`mail`.`from-url`!='" . dbesc($profile_url) . "'";
3609 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3612 if ($user_id != "") {
3613 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3614 } elseif ($screen_name !="") {
3615 $sql_extra .= " AND `contact`.`nick` = '" . dbesc($screen_name). "'";
3619 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid`=%d AND $sql_extra AND `mail`.`id` > %d ORDER BY `mail`.`id` DESC LIMIT %d,%d",
3625 if ($verbose == "true" && !DBM::is_result($r)) {
3626 $answer = array('result' => 'error', 'message' => 'no mails available');
3627 return api_format_data("direct_messages_all", $type, array('$result' => $answer));
3631 foreach ($r as $item) {
3632 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3633 $recipient = $user_info;
3634 $sender = api_get_user($a, normalise_link($item['contact-url']));
3635 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3636 $recipient = api_get_user($a, normalise_link($item['contact-url']));
3637 $sender = $user_info;
3640 $ret[] = api_format_messages($item, $recipient, $sender);
3644 $data = array('direct_message' => $ret);
3648 $data = api_rss_extra($a, $data, $user_info);
3651 return api_format_data("direct-messages", $type, $data);
3654 function api_direct_messages_sentbox($type)
3656 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3657 return api_direct_messages_box($type, "sentbox", $verbose);
3660 function api_direct_messages_inbox($type)
3662 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3663 return api_direct_messages_box($type, "inbox", $verbose);
3666 function api_direct_messages_all($type)
3668 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3669 return api_direct_messages_box($type, "all", $verbose);
3672 function api_direct_messages_conversation($type)
3674 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3675 return api_direct_messages_box($type, "conversation", $verbose);
3678 /// @TODO move to top of file or somewhere better
3679 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3680 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3681 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3682 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3684 function api_oauth_request_token($type)
3686 $oauth1 = new FKOAuth1();
3688 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
3689 } catch (Exception $e) {
3690 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
3697 function api_oauth_access_token($type)
3699 $oauth1 = new FKOAuth1();
3701 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
3702 } catch (Exception $e) {
3703 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
3710 /// @TODO move to top of file or somewhere better
3711 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
3712 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
3716 * @brief delete a complete photoalbum with all containing photos from database through api
3718 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3721 function api_fr_photoalbum_delete($type)
3723 if (api_user() === false) {
3724 throw new ForbiddenException();
3727 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3729 // we do not allow calls without album string
3731 throw new BadRequestException("no albumname specified");
3733 // check if album is existing
3735 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3739 if (!DBM::is_result($r))
3740 throw new BadRequestException("album not available");
3742 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
3743 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
3744 foreach ($r as $rr) {
3746 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
3747 intval(local_user()),
3748 dbesc($rr['resource-id'])
3751 if (!DBM::is_result($photo_item)) {
3752 throw new InternalServerErrorException("problem with deleting items occured");
3754 drop_item($photo_item[0]['id'], false);
3757 // now let's delete all photos from the album
3758 $result = dba::delete('photo', array('uid' => api_user(), 'album' => $album));
3760 // return success of deletion or error message
3762 $answer = array('result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.');
3763 return api_format_data("photoalbum_delete", $type, array('$result' => $answer));
3765 throw new InternalServerErrorException("unknown error - deleting from database failed");
3770 * @brief update the name of the album for all photos of an album
3772 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3775 function api_fr_photoalbum_update($type)
3777 if (api_user() === false) {
3778 throw new ForbiddenException();
3781 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3782 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
3784 // we do not allow calls without album string
3786 throw new BadRequestException("no albumname specified");
3788 if ($album_new == "") {
3789 throw new BadRequestException("no new albumname specified");
3791 // check if album is existing
3793 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3797 if (!DBM::is_result($r)) {
3798 throw new BadRequestException("album not available");
3800 // now let's update all photos to the albumname
3802 "UPDATE `photo` SET `album` = '%s' WHERE `uid` = %d AND `album` = '%s'",
3808 // return success of updating or error message
3810 $answer = array('result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.');
3811 return api_format_data("photoalbum_update", $type, array('$result' => $answer));
3813 throw new InternalServerErrorException("unknown error - updating in database failed");
3819 * @brief list all photos of the authenticated user
3821 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3824 function api_fr_photos_list($type)
3826 if (api_user() === false) {
3827 throw new ForbiddenException();
3830 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
3831 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
3832 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
3833 intval(local_user())
3836 'image/jpeg' => 'jpg',
3837 'image/png' => 'png',
3838 'image/gif' => 'gif'
3840 $data = array('photo'=>array());
3841 if (DBM::is_result($r)) {
3842 foreach ($r as $rr) {
3844 $photo['id'] = $rr['resource-id'];
3845 $photo['album'] = $rr['album'];
3846 $photo['filename'] = $rr['filename'];
3847 $photo['type'] = $rr['type'];
3848 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
3849 $photo['created'] = $rr['created'];
3850 $photo['edited'] = $rr['edited'];
3851 $photo['desc'] = $rr['desc'];
3853 if ($type == "xml") {
3854 $data['photo'][] = array("@attributes" => $photo, "1" => $thumb);
3856 $photo['thumb'] = $thumb;
3857 $data['photo'][] = $photo;
3861 return api_format_data("photos", $type, $data);
3865 * @brief upload a new photo or change an existing photo
3867 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3870 function api_fr_photo_create_update($type)
3872 if (api_user() === false) {
3873 throw new ForbiddenException();
3876 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
3877 $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
3878 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
3879 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
3880 $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
3881 $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
3882 $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
3883 $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
3884 $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
3886 // do several checks on input parameters
3887 // we do not allow calls without album string
3888 if ($album == null) {
3889 throw new BadRequestException("no albumname specified");
3891 // if photo_id == null --> we are uploading a new photo
3892 if ($photo_id == null) {
3895 // error if no media posted in create-mode
3896 if (!x($_FILES, 'media')) {
3898 throw new BadRequestException("no media data submitted");
3901 // album_new will be ignored in create-mode
3906 // check if photo is existing in database
3908 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
3913 if (!DBM::is_result($r)) {
3914 throw new BadRequestException("photo not available");
3918 // checks on acl strings provided by clients
3919 $acl_input_error = false;
3920 $acl_input_error |= check_acl_input($allow_cid);
3921 $acl_input_error |= check_acl_input($deny_cid);
3922 $acl_input_error |= check_acl_input($allow_gid);
3923 $acl_input_error |= check_acl_input($deny_gid);
3924 if ($acl_input_error) {
3925 throw new BadRequestException("acl data invalid");
3927 // now let's upload the new media in create-mode
3928 if ($mode == "create") {
3929 $media = $_FILES['media'];
3930 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
3932 // return success of updating or error message
3933 if (!is_null($data)) {
3934 return api_format_data("photo_create", $type, $data);
3936 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
3940 // now let's do the changes in update-mode
3941 if ($mode == "update") {
3944 if (!is_null($desc)) {
3945 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
3948 if (!is_null($album_new)) {
3949 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
3952 if (!is_null($allow_cid)) {
3953 $allow_cid = trim($allow_cid);
3954 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
3957 if (!is_null($deny_cid)) {
3958 $deny_cid = trim($deny_cid);
3959 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
3962 if (!is_null($allow_gid)) {
3963 $allow_gid = trim($allow_gid);
3964 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
3967 if (!is_null($deny_gid)) {
3968 $deny_gid = trim($deny_gid);
3969 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
3973 if ($sql_extra != "") {
3974 $nothingtodo = false;
3976 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
3978 datetime_convert(), // update edited timestamp
3984 $nothingtodo = true;
3987 if (x($_FILES, 'media')) {
3988 $nothingtodo = false;
3989 $media = $_FILES['media'];
3990 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
3991 if (!is_null($data)) {
3992 return api_format_data("photo_update", $type, $data);
3996 // return success of updating or error message
3998 $answer = array('result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.');
3999 return api_format_data("photo_update", $type, array('$result' => $answer));
4002 $answer = array('result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.');
4003 return api_format_data("photo_update", $type, array('$result' => $answer));
4005 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4008 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4013 * @brief delete a single photo from the database through api
4015 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4018 function api_fr_photo_delete($type)
4020 if (api_user() === false) {
4021 throw new ForbiddenException();
4024 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4026 // do several checks on input parameters
4027 // we do not allow calls without photo id
4028 if ($photo_id == null) {
4029 throw new BadRequestException("no photo_id specified");
4031 // check if photo is existing in database
4033 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4037 if (!DBM::is_result($r)) {
4038 throw new BadRequestException("photo not available");
4040 // now we can perform on the deletion of the photo
4041 $result = dba::delete('photo', array('uid' => api_user(), 'resource-id' => $photo_id));
4043 // return success of deletion or error message
4045 // retrieve the id of the parent element (the photo element)
4047 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4048 intval(local_user()),
4052 if (!DBM::is_result($photo_item)) {
4053 throw new InternalServerErrorException("problem with deleting items occured");
4055 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4056 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4057 drop_item($photo_item[0]['id'], false);
4059 $answer = array('result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.');
4060 return api_format_data("photo_delete", $type, array('$result' => $answer));
4062 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4068 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4070 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4073 function api_fr_photo_detail($type)
4075 if (api_user() === false) {
4076 throw new ForbiddenException();
4078 if (!x($_REQUEST, 'photo_id')) {
4079 throw new BadRequestException("No photo id.");
4082 $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4083 $photo_id = $_REQUEST['photo_id'];
4085 // prepare json/xml output with data from database for the requested photo
4086 $data = prepare_photo_data($type, $scale, $photo_id);
4088 return api_format_data("photo_detail", $type, $data);
4093 * @brief updates the profile image for the user (either a specified profile or the default profile)
4095 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4098 function api_account_update_profile_image($type)
4100 if (api_user() === false) {
4101 throw new ForbiddenException();
4104 $profileid = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
4106 // error if image data is missing
4107 if (!x($_FILES, 'image')) {
4108 throw new BadRequestException("no media data submitted");
4111 // check if specified profile id is valid
4112 if ($profileid != 0) {
4114 "SELECT `id` FROM `profile` WHERE `uid` = %d AND `id` = %d",
4118 // error message if specified profile id is not in database
4119 if (!DBM::is_result($r)) {
4120 throw new BadRequestException("profile_id not available");
4122 $is_default_profile = $r['profile'];
4124 $is_default_profile = 1;
4127 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4129 if (x($_FILES, 'image')) {
4130 $media = $_FILES['image'];
4131 } elseif (x($_FILES, 'media')) {
4132 $media = $_FILES['media'];
4134 // save new profile image
4135 $data = save_media_to_database("profileimage", $media, $type, t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4138 if (is_array($media['type'])) {
4139 $filetype = $media['type'][0];
4141 $filetype = $media['type'];
4143 if ($filetype == "image/jpeg") {
4145 } elseif ($filetype == "image/png") {
4148 // change specified profile or all profiles to the new resource-id
4149 if ($is_default_profile) {
4151 "UPDATE `photo` SET `profile` = 0 WHERE `profile` = 1 AND `resource-id` != '%s' AND `uid` = %d",
4152 dbesc($data['photo']['id']),
4153 intval(local_user())
4157 "UPDATE `contact` SET `photo` = '%s', `thumb` = '%s', `micro` = '%s' WHERE `self` AND `uid` = %d",
4158 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext),
4159 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext),
4160 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-6.' . $fileext),
4161 intval(local_user())
4165 "UPDATE `profile` SET `photo` = '%s', `thumb` = '%s' WHERE `id` = %d AND `uid` = %d",
4166 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype),
4167 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype),
4168 intval($_REQUEST['profile']),
4169 intval(local_user())
4173 // we'll set the updated profile-photo timestamp even if it isn't the default profile,
4174 // so that browsers will do a cache update unconditionally
4177 "UPDATE `contact` SET `avatar-date` = '%s' WHERE `self` = 1 AND `uid` = %d",
4178 dbesc(datetime_convert()),
4179 intval(local_user())
4182 // Update global directory in background
4183 //$user = api_get_user(get_app());
4184 $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4185 if ($url && strlen(Config::get('system', 'directory'))) {
4186 Worker::add(PRIORITY_LOW, "Directory", $url);
4189 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4191 // output for client
4193 return api_account_verify_credentials($type);
4195 // SaveMediaToDatabase failed for some reason
4196 throw new InternalServerErrorException("image upload failed");
4200 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4201 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4202 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4203 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4204 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4205 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4206 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4207 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4208 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4211 function check_acl_input($acl_string)
4213 if ($acl_string == null || $acl_string == " ") {
4216 $contact_not_found = false;
4218 // split <x><y><z> into array of cid's
4219 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4221 // check for each cid if it is available on server
4222 $cid_array = $array[0];
4223 foreach ($cid_array as $cid) {
4224 $cid = str_replace("<", "", $cid);
4225 $cid = str_replace(">", "", $cid);
4227 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
4231 $contact_not_found |= !DBM::is_result($contact);
4233 return $contact_not_found;
4236 function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, $profile = 0, $visibility = false, $photo_id = null)
4244 if (is_array($media)) {
4245 if (is_array($media['tmp_name'])) {
4246 $src = $media['tmp_name'][0];
4248 $src = $media['tmp_name'];
4250 if (is_array($media['name'])) {
4251 $filename = basename($media['name'][0]);
4253 $filename = basename($media['name']);
4255 if (is_array($media['size'])) {
4256 $filesize = intval($media['size'][0]);
4258 $filesize = intval($media['size']);
4260 if (is_array($media['type'])) {
4261 $filetype = $media['type'][0];
4263 $filetype = $media['type'];
4267 if ($filetype == "") {
4268 $filetype=Image::guessType($filename);
4270 $imagedata = getimagesize($src);
4272 $filetype = $imagedata['mime'];
4275 "File upload src: " . $src . " - filename: " . $filename .
4276 " - size: " . $filesize . " - type: " . $filetype, LOGGER_DEBUG
4279 // check if there was a php upload error
4280 if ($filesize == 0 && $media['error'] == 1) {
4281 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4283 // check against max upload size within Friendica instance
4284 $maximagesize = Config::get('system', 'maximagesize');
4285 if (($maximagesize) && ($filesize > $maximagesize)) {
4286 $formattedBytes = formatBytes($maximagesize);
4287 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4290 // create Photo instance with the data of the image
4291 $imagedata = @file_get_contents($src);
4292 $Image = new Image($imagedata, $filetype);
4293 if (! $Image->isValid()) {
4294 throw new InternalServerErrorException("unable to process image data");
4297 // check orientation of image
4298 $Image->orient($src);
4301 // check max length of images on server
4302 $max_length = Config::get('system', 'max_image_length');
4303 if (! $max_length) {
4304 $max_length = MAX_IMAGE_LENGTH;
4306 if ($max_length > 0) {
4307 $Image->scaleDown($max_length);
4308 logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG);
4310 $width = $Image->getWidth();
4311 $height = $Image->getHeight();
4313 // create a new resource-id if not already provided
4314 $hash = ($photo_id == null) ? photo_new_resource() : $photo_id;
4316 if ($mediatype == "photo") {
4317 // upload normal image (scales 0, 1, 2)
4318 logger("photo upload: starting new photo upload", LOGGER_DEBUG);
4320 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4322 logger("photo upload: image upload with scale 0 (original size) failed");
4324 if ($width > 640 || $height > 640) {
4325 $Image->scaleDown(640);
4326 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4328 logger("photo upload: image upload with scale 1 (640x640) failed");
4332 if ($width > 320 || $height > 320) {
4333 $Image->scaleDown(320);
4334 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4336 logger("photo upload: image upload with scale 2 (320x320) failed");
4339 logger("photo upload: new photo upload ended", LOGGER_DEBUG);
4340 } elseif ($mediatype == "profileimage") {
4341 // upload profile image (scales 4, 5, 6)
4342 logger("photo upload: starting new profile image upload", LOGGER_DEBUG);
4344 if ($width > 175 || $height > 175) {
4345 $Image->scaleDown(175);
4346 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4348 logger("photo upload: profile image upload with scale 4 (175x175) failed");
4352 if ($width > 80 || $height > 80) {
4353 $Image->scaleDown(80);
4354 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4356 logger("photo upload: profile image upload with scale 5 (80x80) failed");
4360 if ($width > 48 || $height > 48) {
4361 $Image->scaleDown(48);
4362 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4364 logger("photo upload: profile image upload with scale 6 (48x48) failed");
4367 $Image->__destruct();
4368 logger("photo upload: new profile image upload ended", LOGGER_DEBUG);
4372 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4373 if ($photo_id == null && $mediatype == "photo") {
4374 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4376 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4377 return prepare_photo_data($type, false, $hash);
4379 throw new InternalServerErrorException("image upload failed");
4383 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4385 // get data about the api authenticated user
4386 $uri = item_new_uri(get_app()->get_hostname(), intval(api_user()));
4387 $owner_record = q("SELECT * FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
4390 $arr['guid'] = get_guid(32);
4391 $arr['uid'] = intval(api_user());
4393 $arr['parent-uri'] = $uri;
4394 $arr['type'] = 'photo';
4396 $arr['resource-id'] = $hash;
4397 $arr['contact-id'] = $owner_record[0]['id'];
4398 $arr['owner-name'] = $owner_record[0]['name'];
4399 $arr['owner-link'] = $owner_record[0]['url'];
4400 $arr['owner-avatar'] = $owner_record[0]['thumb'];
4401 $arr['author-name'] = $owner_record[0]['name'];
4402 $arr['author-link'] = $owner_record[0]['url'];
4403 $arr['author-avatar'] = $owner_record[0]['thumb'];
4405 $arr['allow_cid'] = $allow_cid;
4406 $arr['allow_gid'] = $allow_gid;
4407 $arr['deny_cid'] = $deny_cid;
4408 $arr['deny_gid'] = $deny_gid;
4409 $arr['last-child'] = 1;
4410 $arr['visible'] = $visibility;
4414 'image/jpeg' => 'jpg',
4415 'image/png' => 'png',
4416 'image/gif' => 'gif'
4419 // adds link to the thumbnail scale photo
4420 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record[0]['nick'] . '/image/' . $hash . ']'
4421 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4424 // do the magic for storing the item in the database and trigger the federation to other contacts
4428 function prepare_photo_data($type, $scale, $photo_id)
4430 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4431 $data_sql = ($scale === false ? "" : "data, ");
4433 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4434 // clients needs to convert this in their way for further processing
4436 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4437 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4438 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4439 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4441 intval(local_user()),
4447 'image/jpeg' => 'jpg',
4448 'image/png' => 'png',
4449 'image/gif' => 'gif'
4452 // prepare output data for photo
4453 if (DBM::is_result($r)) {
4454 $data = array('photo' => $r[0]);
4455 $data['photo']['id'] = $data['photo']['resource-id'];
4456 if ($scale !== false) {
4457 $data['photo']['data'] = base64_encode($data['photo']['data']);
4459 unset($data['photo']['datasize']); //needed only with scale param
4461 if ($type == "xml") {
4462 $data['photo']['links'] = array();
4463 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4464 $data['photo']['links'][$k . ":link"]["@attributes"] = array("type" => $data['photo']['type'],
4466 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]);
4469 $data['photo']['link'] = array();
4470 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4472 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4473 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4477 unset($data['photo']['resource-id']);
4478 unset($data['photo']['minscale']);
4479 unset($data['photo']['maxscale']);
4481 throw new NotFoundException();
4484 // retrieve item element for getting activities (like, dislike etc.) related to photo
4486 "SELECT * FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4487 intval(local_user()),
4490 $data['photo']['friendica_activities'] = api_format_items_activities($item[0], $type);
4492 // retrieve comments on photo
4494 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
4495 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
4496 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
4497 `contact`.`id` AS `cid`
4499 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
4500 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
4501 WHERE `item`.`parent` = %d AND `item`.`visible`
4502 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
4503 AND `item`.`uid` = %d AND (`item`.`verb`='%s' OR `type`='photo')",
4504 intval($item[0]['parent']),
4506 dbesc(ACTIVITY_POST)
4509 // prepare output of comments
4510 $commentData = api_format_items($r, api_get_user(get_app()), false, $type);
4511 $comments = array();
4512 if ($type == "xml") {
4514 foreach ($commentData as $comment) {
4515 $comments[$k++ . ":comment"] = $comment;
4518 foreach ($commentData as $comment) {
4519 $comments[] = $comment;
4522 $data['photo']['friendica_comments'] = $comments;
4524 // include info if rights on photo and rights on item are mismatching
4525 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4526 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4527 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4528 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4529 $data['photo']['rights_mismatch'] = $rights_mismatch;
4536 * Similar as /mod/redir.php
4537 * redirect to 'url' after dfrn auth
4539 * Why this when there is mod/redir.php already?
4540 * This use api_user() and api_login()
4543 * c_url: url of remote contact to auth to
4544 * url: string, url to redirect after auth
4546 function api_friendica_remoteauth()
4548 $url = ((x($_GET, 'url')) ? $_GET['url'] : '');
4549 $c_url = ((x($_GET, 'c_url')) ? $_GET['c_url'] : '');
4551 if ($url === '' || $c_url === '') {
4552 throw new BadRequestException("Wrong parameters.");
4555 $c_url = normalise_link($c_url);
4560 "SELECT * FROM `contact` WHERE `id` = %d AND `nurl` = '%s' LIMIT 1",
4565 if ((! DBM::is_result($r)) || ($r[0]['network'] !== NETWORK_DFRN)) {
4566 throw new BadRequestException("Unknown contact");
4571 $dfrn_id = $orig_id = (($r[0]['issued-id']) ? $r[0]['issued-id'] : $r[0]['dfrn-id']);
4573 if ($r[0]['duplex'] && $r[0]['issued-id']) {
4574 $orig_id = $r[0]['issued-id'];
4575 $dfrn_id = '1:' . $orig_id;
4577 if ($r[0]['duplex'] && $r[0]['dfrn-id']) {
4578 $orig_id = $r[0]['dfrn-id'];
4579 $dfrn_id = '0:' . $orig_id;
4582 $sec = random_string();
4585 "INSERT INTO `profile_check` ( `uid`, `cid`, `dfrn_id`, `sec`, `expire`)
4586 VALUES( %d, %s, '%s', '%s', %d )",
4594 logger($r[0]['name'] . ' ' . $sec, LOGGER_DEBUG);
4595 $dest = (($url) ? '&destination_url=' . $url : '');
4597 $r[0]['poll'] . '?dfrn_id=' . $dfrn_id
4598 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4599 . '&type=profile&sec=' . $sec . $dest . $quiet
4602 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4605 * @brief Return the item shared, if the item contains only the [share] tag
4607 * @param array $item Sharer item
4608 * @return array Shared item or false if not a reshare
4610 function api_share_as_retweet(&$item)
4612 $body = trim($item["body"]);
4614 if (Diaspora::isReshare($body, false)===false) {
4618 /// @TODO "$1" should maybe mean '$1' ?
4619 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
4621 * Skip if there is no shared message in there
4622 * we already checked this in diaspora::isReshare()
4623 * but better one more than one less...
4625 if ($body == $attributes) {
4630 // build the fake reshared item
4631 $reshared_item = $item;
4634 preg_match("/author='(.*?)'/ism", $attributes, $matches);
4635 if ($matches[1] != "") {
4636 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
4639 preg_match('/author="(.*?)"/ism', $attributes, $matches);
4640 if ($matches[1] != "") {
4641 $author = $matches[1];
4645 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
4646 if ($matches[1] != "") {
4647 $profile = $matches[1];
4650 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
4651 if ($matches[1] != "") {
4652 $profile = $matches[1];
4656 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
4657 if ($matches[1] != "") {
4658 $avatar = $matches[1];
4661 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
4662 if ($matches[1] != "") {
4663 $avatar = $matches[1];
4667 preg_match("/link='(.*?)'/ism", $attributes, $matches);
4668 if ($matches[1] != "") {
4669 $link = $matches[1];
4672 preg_match('/link="(.*?)"/ism', $attributes, $matches);
4673 if ($matches[1] != "") {
4674 $link = $matches[1];
4678 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
4679 if ($matches[1] != "")
4680 $posted = $matches[1];
4682 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
4683 if ($matches[1] != "") {
4684 $posted = $matches[1];
4687 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
4689 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
4693 $reshared_item["body"] = $shared_body;
4694 $reshared_item["author-name"] = $author;
4695 $reshared_item["author-link"] = $profile;
4696 $reshared_item["author-avatar"] = $avatar;
4697 $reshared_item["plink"] = $link;
4698 $reshared_item["created"] = $posted;
4699 $reshared_item["edited"] = $posted;
4701 return $reshared_item;
4705 function api_get_nick($profile)
4708 - remove trailing junk from profile url
4709 - pump.io check has to check the website
4715 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4716 dbesc(normalise_link($profile))
4719 if (DBM::is_result($r)) {
4720 $nick = $r[0]["nick"];
4725 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4726 dbesc(normalise_link($profile))
4729 if (DBM::is_result($r)) {
4730 $nick = $r[0]["nick"];
4735 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
4736 if ($friendica != $profile) {
4742 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
4743 if ($diaspora != $profile) {
4749 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
4750 if ($twitter != $profile) {
4757 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
4758 if ($StatusnetHost != $profile) {
4759 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
4760 if ($StatusnetUser != $profile) {
4761 $UserData = fetch_url("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
4762 $user = json_decode($UserData);
4764 $nick = $user->screen_name;
4770 // To-Do: look at the page if its really a pumpio site
4771 //if (!$nick == "") {
4772 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
4773 // if ($pumpio != $profile)
4775 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
4786 function api_in_reply_to($item)
4788 $in_reply_to = array();
4790 $in_reply_to['status_id'] = null;
4791 $in_reply_to['user_id'] = null;
4792 $in_reply_to['status_id_str'] = null;
4793 $in_reply_to['user_id_str'] = null;
4794 $in_reply_to['screen_name'] = null;
4796 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
4797 $r = q("SELECT `id` FROM `item` WHERE `uid` = %d AND `uri` = '%s' LIMIT 1",
4798 intval($item['uid']),
4799 dbesc($item['thr-parent']));
4801 if (DBM::is_result($r)) {
4802 $in_reply_to['status_id'] = intval($r[0]['id']);
4804 $in_reply_to['status_id'] = intval($item['parent']);
4807 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
4809 $r = q("SELECT `contact`.`nick`, `contact`.`name`, `contact`.`id`, `contact`.`url` FROM item
4810 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`author-id`
4811 WHERE `item`.`id` = %d LIMIT 1",
4812 intval($in_reply_to['status_id'])
4815 if (DBM::is_result($r)) {
4816 if ($r[0]['nick'] == "") {
4817 $r[0]['nick'] = api_get_nick($r[0]["url"]);
4820 $in_reply_to['screen_name'] = (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']);
4821 $in_reply_to['user_id'] = intval($r[0]['id']);
4822 $in_reply_to['user_id_str'] = (string) intval($r[0]['id']);
4825 // There seems to be situation, where both fields are identical:
4826 // https://github.com/friendica/friendica/issues/1010
4827 // This is a bugfix for that.
4828 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
4829 logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG);
4830 $in_reply_to['status_id'] = null;
4831 $in_reply_to['user_id'] = null;
4832 $in_reply_to['status_id_str'] = null;
4833 $in_reply_to['user_id_str'] = null;
4834 $in_reply_to['screen_name'] = null;
4838 return $in_reply_to;
4841 function api_clean_plain_items($Text)
4843 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
4845 $Text = bb_CleanPictureLinks($Text);
4846 $URLSearchString = "^\[\]";
4848 $Text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $Text);
4850 if ($include_entities == "true") {
4851 $Text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $Text);
4854 // Simplify "attachment" element
4855 $Text = api_clean_attachments($Text);
4861 * @brief Removes most sharing information for API text export
4863 * @param string $body The original body
4865 * @return string Cleaned body
4867 function api_clean_attachments($body)
4869 $data = get_attachment_data($body);
4876 if (isset($data["text"]))
4877 $body = $data["text"];
4879 if (($body == "") && (isset($data["title"])))
4880 $body = $data["title"];
4882 if (isset($data["url"]))
4883 $body .= "\n".$data["url"];
4885 $body .= $data["after"];
4890 function api_best_nickname(&$contacts)
4892 $best_contact = array();
4894 if (count($contact) == 0)
4897 foreach ($contacts as $contact)
4898 if ($contact["network"] == "") {
4899 $contact["network"] = "dfrn";
4900 $best_contact = array($contact);
4903 if (sizeof($best_contact) == 0)
4904 foreach ($contacts as $contact)
4905 if ($contact["network"] == "dfrn")
4906 $best_contact = array($contact);
4908 if (sizeof($best_contact) == 0)
4909 foreach ($contacts as $contact)
4910 if ($contact["network"] == "dspr")
4911 $best_contact = array($contact);
4913 if (sizeof($best_contact) == 0)
4914 foreach ($contacts as $contact)
4915 if ($contact["network"] == "stat")
4916 $best_contact = array($contact);
4918 if (sizeof($best_contact) == 0)
4919 foreach ($contacts as $contact)
4920 if ($contact["network"] == "pump")
4921 $best_contact = array($contact);
4923 if (sizeof($best_contact) == 0)
4924 foreach ($contacts as $contact)
4925 if ($contact["network"] == "twit")
4926 $best_contact = array($contact);
4928 if (sizeof($best_contact) == 1) {
4929 $contacts = $best_contact;
4931 $contacts = array($contacts[0]);
4935 // return all or a specified group of the user with the containing contacts
4936 function api_friendica_group_show($type)
4940 if (api_user() === false) throw new ForbiddenException();
4943 $user_info = api_get_user($a);
4944 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
4945 $uid = $user_info['uid'];
4947 // get data of the specified group id or all groups if not specified
4950 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
4954 // error message if specified gid is not in database
4955 if (!DBM::is_result($r))
4956 throw new BadRequestException("gid not available");
4959 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
4964 // loop through all groups and retrieve all members for adding data in the user array
4965 foreach ($r as $rr) {
4966 $members = Contact::getByGroupId($rr['id']);
4969 if ($type == "xml") {
4970 $user_element = "users";
4972 foreach ($members as $member) {
4973 $user = api_get_user($a, $member['nurl']);
4974 $users[$k++.":user"] = $user;
4977 $user_element = "user";
4978 foreach ($members as $member) {
4979 $user = api_get_user($a, $member['nurl']);
4983 $grps[] = array('name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users);
4985 return api_format_data("groups", $type, array('group' => $grps));
4987 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
4990 // delete the specified group of the user
4991 function api_friendica_group_delete($type)
4995 if (api_user() === false) {
4996 throw new ForbiddenException();
5000 $user_info = api_get_user($a);
5001 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5002 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5003 $uid = $user_info['uid'];
5005 // error if no gid specified
5006 if ($gid == 0 || $name == "") {
5007 throw new BadRequestException('gid or name not specified');
5010 // get data of the specified group id
5012 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5016 // error message if specified gid is not in database
5017 if (!DBM::is_result($r)) {
5018 throw new BadRequestException('gid not available');
5021 // get data of the specified group id and group name
5023 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5028 // error message if specified gid is not in database
5029 if (!DBM::is_result($rname)) {
5030 throw new BadRequestException('wrong group name');
5034 $ret = Group::removeByName($uid, $name);
5037 $success = array('success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => array());
5038 return api_format_data("group_delete", $type, array('result' => $success));
5040 throw new BadRequestException('other API error');
5043 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5046 // create the specified group with the posted array of contacts
5047 function api_friendica_group_create($type)
5051 if (api_user() === false) throw new ForbiddenException();
5054 $user_info = api_get_user($a);
5055 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5056 $uid = $user_info['uid'];
5057 $json = json_decode($_POST['json'], true);
5058 $users = $json['user'];
5060 // error if no name specified
5062 throw new BadRequestException('group name not specified');
5064 // get data of the specified group name
5066 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5070 // error message if specified group name already exists
5071 if (DBM::is_result($rname))
5072 throw new BadRequestException('group name already exists');
5074 // check if specified group name is a deleted group
5076 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5080 // error message if specified group name already exists
5081 if (DBM::is_result($rname))
5082 $reactivate_group = true;
5085 $ret = Group::create($uid, $name);
5087 $gid = Group::getIdByName($uid, $name);
5089 throw new BadRequestException('other API error');
5093 $erroraddinguser = false;
5094 $errorusers = array();
5095 foreach ($users as $user) {
5096 $cid = $user['cid'];
5097 // check if user really exists as contact
5099 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5103 if (count($contact))
5104 $result = Group::addMember($gid, $cid);
5106 $erroraddinguser = true;
5107 $errorusers[] = $cid;
5111 // return success message incl. missing users in array
5112 $status = ($erroraddinguser ? "missing user" : ($reactivate_group ? "reactivated" : "ok"));
5113 $success = array('success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers);
5114 return api_format_data("group_create", $type, array('result' => $success));
5116 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5119 // update the specified group with the posted array of contacts
5120 function api_friendica_group_update($type)
5124 if (api_user() === false) throw new ForbiddenException();
5127 $user_info = api_get_user($a);
5128 $uid = $user_info['uid'];
5129 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5130 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5131 $json = json_decode($_POST['json'], true);
5132 $users = $json['user'];
5134 // error if no name specified
5136 throw new BadRequestException('group name not specified');
5138 // error if no gid specified
5140 throw new BadRequestException('gid not specified');
5143 $members = Contact::getByGroupId($gid);
5144 foreach ($members as $member) {
5145 $cid = $member['id'];
5146 foreach ($users as $user) {
5147 $found = ($user['cid'] == $cid ? true : false);
5150 $ret = Group::removeMemberByName($uid, $name, $cid);
5155 $erroraddinguser = false;
5156 $errorusers = array();
5157 foreach ($users as $user) {
5158 $cid = $user['cid'];
5159 // check if user really exists as contact
5161 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5166 if (count($contact)) {
5167 $result = Group::addMember($gid, $cid);
5169 $erroraddinguser = true;
5170 $errorusers[] = $cid;
5174 // return success message incl. missing users in array
5175 $status = ($erroraddinguser ? "missing user" : "ok");
5176 $success = array('success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers);
5177 return api_format_data("group_update", $type, array('result' => $success));
5180 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5182 function api_friendica_activity($type)
5186 if (api_user() === false) throw new ForbiddenException();
5187 $verb = strtolower($a->argv[3]);
5188 $verb = preg_replace("|\..*$|", "", $verb);
5190 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5192 $res = do_like($id, $verb);
5195 if ($type == "xml") {
5200 return api_format_data('ok', $type, array('ok' => $ok));
5202 throw new BadRequestException('Error adding activity');
5206 /// @TODO move to top of file or somwhere better
5207 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5208 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5209 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5210 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5211 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5212 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5213 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5214 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5215 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5216 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5219 * @brief Returns notifications
5221 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5224 function api_friendica_notification($type)
5228 if (api_user() === false) throw new ForbiddenException();
5229 if ($a->argc!==3) throw new BadRequestException("Invalid argument count");
5230 $nm = new NotificationsManager();
5232 $notes = $nm->getAll(array(), "+seen -date", 50);
5234 if ($type == "xml") {
5235 $xmlnotes = array();
5236 foreach ($notes as $note)
5237 $xmlnotes[] = array("@attributes" => $note);
5242 return api_format_data("notes", $type, array('note' => $notes));
5246 * @brief Set notification as seen and returns associated item (if possible)
5248 * POST request with 'id' param as notification id
5250 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5253 function api_friendica_notification_seen($type)
5257 if (api_user() === false) throw new ForbiddenException();
5258 if ($a->argc!==4) throw new BadRequestException("Invalid argument count");
5260 $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5262 $nm = new NotificationsManager();
5263 $note = $nm->getByID($id);
5264 if (is_null($note)) throw new BadRequestException("Invalid argument");
5266 $nm->setSeen($note);
5267 if ($note['otype']=='item') {
5268 // would be really better with an ItemsManager and $im->getByID() :-P
5270 "SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d",
5271 intval($note['iid']),
5272 intval(local_user())
5275 // we found the item, return it to the user
5276 $user_info = api_get_user($a);
5277 $ret = api_format_items($r, $user_info, false, $type);
5278 $data = array('status' => $ret);
5279 return api_format_data("status", $type, $data);
5281 // the item can't be found, but we set the note as seen, so we count this as a success
5283 return api_format_data('result', $type, array('result' => "success"));
5286 /// @TODO move to top of file or somwhere better
5287 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5288 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5291 * @brief update a direct_message to seen state
5293 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5294 * @return string (success result=ok, error result=error with error message)
5296 function api_friendica_direct_messages_setseen($type)
5299 if (api_user() === false) {
5300 throw new ForbiddenException();
5304 $user_info = api_get_user($a);
5305 $uid = $user_info['uid'];
5306 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5308 // return error if id is zero
5310 $answer = array('result' => 'error', 'message' => 'message id not specified');
5311 return api_format_data("direct_messages_setseen", $type, array('$result' => $answer));
5314 // get data of the specified message id
5316 "SELECT `id` FROM `mail` WHERE `id` = %d AND `uid` = %d",
5321 // error message if specified id is not in database
5322 if (!DBM::is_result($r)) {
5323 $answer = array('result' => 'error', 'message' => 'message id not in database');
5324 return api_format_data("direct_messages_setseen", $type, array('$result' => $answer));
5327 // update seen indicator
5329 "UPDATE `mail` SET `seen` = 1 WHERE `id` = %d AND `uid` = %d",
5336 $answer = array('result' => 'ok', 'message' => 'message set to seen');
5337 return api_format_data("direct_message_setseen", $type, array('$result' => $answer));
5339 $answer = array('result' => 'error', 'message' => 'unknown error');
5340 return api_format_data("direct_messages_setseen", $type, array('$result' => $answer));
5344 /// @TODO move to top of file or somwhere better
5345 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5348 * @brief search for direct_messages containing a searchstring through api
5350 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5351 * @return string (success: success=true if found and search_result contains found messages
5352 * success=false if nothing was found, search_result='nothing found',
5353 * error: result=error with error message)
5355 function api_friendica_direct_messages_search($type)
5359 if (api_user() === false) {
5360 throw new ForbiddenException();
5364 $user_info = api_get_user($a);
5365 $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
5366 $uid = $user_info['uid'];
5368 // error if no searchstring specified
5369 if ($searchstring == "") {
5370 $answer = array('result' => 'error', 'message' => 'searchstring not specified');
5371 return api_format_data("direct_messages_search", $type, array('$result' => $answer));
5374 // get data for the specified searchstring
5376 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid`=%d AND `body` LIKE '%s' ORDER BY `mail`.`id` DESC",
5378 dbesc('%'.$searchstring.'%')
5381 $profile_url = $user_info["url"];
5383 // message if nothing was found
5384 if (!DBM::is_result($r)) {
5385 $success = array('success' => false, 'search_results' => 'problem with query');
5386 } elseif (count($r) == 0) {
5387 $success = array('success' => false, 'search_results' => 'nothing found');
5390 foreach ($r as $item) {
5391 if ($box == "inbox" || $item['from-url'] != $profile_url) {
5392 $recipient = $user_info;
5393 $sender = api_get_user($a, normalise_link($item['contact-url']));
5394 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5395 $recipient = api_get_user($a, normalise_link($item['contact-url']));
5396 $sender = $user_info;
5399 $ret[] = api_format_messages($item, $recipient, $sender);
5401 $success = array('success' => true, 'search_results' => $ret);
5404 return api_format_data("direct_message_search", $type, array('$result' => $success));
5407 /// @TODO move to top of file or somwhere better
5408 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5411 * @brief return data of all the profiles a user has to the client
5413 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5416 function api_friendica_profile_show($type)
5420 if (api_user() === false) {
5421 throw new ForbiddenException();
5425 $profileid = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
5427 // retrieve general information about profiles for user
5428 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
5429 $directory = Config::get('system', 'directory');
5431 // get data of the specified profile id or all profiles of the user if not specified
5432 if ($profileid != 0) {
5434 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
5439 // error message if specified gid is not in database
5440 if (!DBM::is_result($r)) {
5441 throw new BadRequestException("profile_id not available");
5445 "SELECT * FROM `profile` WHERE `uid` = %d",
5449 // loop through all returned profiles and retrieve data and users
5451 foreach ($r as $rr) {
5452 $profile = api_format_items_profiles($rr, $type);
5454 // select all users from contact table, loop and prepare standard return for user data
5457 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
5459 intval($rr['profile_id'])
5462 foreach ($r as $rr) {
5463 $user = api_get_user($a, $rr['nurl']);
5464 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
5466 $profile['users'] = $users;
5468 // add prepared profile data to array for final return
5469 if ($type == "xml") {
5470 $profiles[$k++ . ":profile"] = $profile;
5472 $profiles[] = $profile;
5476 // return settings, authenticated user and profiles data
5477 $self = q("SELECT `nurl` FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
5479 $result = array('multi_profiles' => $multi_profiles ? true : false,
5480 'global_dir' => $directory,
5481 'friendica_owner' => api_get_user($a, $self[0]['nurl']),
5482 'profiles' => $profiles);
5483 return api_format_data("friendica_profiles", $type, array('$result' => $result));
5485 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
5488 * Returns a list of saved searches.
5490 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5492 * @param string $type Return format: json or xml
5494 * @return string|array
5496 function api_saved_searches_list($type)
5498 $terms = dba::select('search', array('id', 'term'), array('uid' => local_user()));
5501 while ($term = $terms->fetch()) {
5503 'name' => $term['term'],
5504 'query' => $term['term'],
5505 'id_str' => $term['id'],
5506 'id' => intval($term['id'])
5512 return api_format_data("terms", $type, array('terms' => $result));
5515 /// @TODO move to top of file or somwhere better
5516 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5519 @TODO Maybe open to implement?
5521 [pagename] => api/1.1/statuses/lookup.json
5522 [id] => 605138389168451584
5523 [include_cards] => true
5524 [cards_platform] => Android-12
5525 [include_entities] => true
5526 [include_my_retweet] => 1
5528 [include_reply_count] => true
5529 [include_descendent_reply_count] => true
5533 Not implemented by now:
5534 statuses/retweets_of_me
5539 account/update_location
5540 account/update_profile_background_image
5543 friendica/profile/update
5544 friendica/profile/create
5545 friendica/profile/delete
5547 Not implemented in status.net:
5548 statuses/retweeted_to_me
5549 statuses/retweeted_by_me
5550 direct_messages/destroy
5552 account/update_delivery_device
5553 notifications/follow