3 * Friendica implementation of statusnet/twitter API
5 * @file include/api.php
6 * @todo Automatically detect if incoming data is HTML or BBCode
10 use Friendica\Content\ContactSelector;
11 use Friendica\Content\Feature;
12 use Friendica\Content\Text\BBCode;
13 use Friendica\Content\Text\HTML;
14 use Friendica\Core\Addon;
15 use Friendica\Core\Config;
16 use Friendica\Core\L10n;
17 use Friendica\Core\NotificationsManager;
18 use Friendica\Core\PConfig;
19 use Friendica\Core\Protocol;
20 use Friendica\Core\System;
21 use Friendica\Core\Worker;
22 use Friendica\Database\DBM;
23 use Friendica\Model\Contact;
24 use Friendica\Model\Group;
25 use Friendica\Model\Item;
26 use Friendica\Model\Mail;
27 use Friendica\Model\Photo;
28 use Friendica\Model\User;
29 use Friendica\Network\FKOAuth1;
30 use Friendica\Network\HTTPException;
31 use Friendica\Network\HTTPException\BadRequestException;
32 use Friendica\Network\HTTPException\ForbiddenException;
33 use Friendica\Network\HTTPException\InternalServerErrorException;
34 use Friendica\Network\HTTPException\MethodNotAllowedException;
35 use Friendica\Network\HTTPException\NotFoundException;
36 use Friendica\Network\HTTPException\NotImplementedException;
37 use Friendica\Network\HTTPException\TooManyRequestsException;
38 use Friendica\Network\HTTPException\UnauthorizedException;
39 use Friendica\Object\Image;
40 use Friendica\Protocol\Diaspora;
41 use Friendica\Util\DateTimeFormat;
42 use Friendica\Util\Network;
43 use Friendica\Util\XML;
45 require_once 'include/conversation.php';
46 require_once 'mod/share.php';
47 require_once 'mod/item.php';
48 require_once 'include/security.php';
49 require_once 'mod/wall_upload.php';
50 require_once 'mod/proxy.php';
52 define('API_METHOD_ANY', '*');
53 define('API_METHOD_GET', 'GET');
54 define('API_METHOD_POST', 'POST,PUT');
55 define('API_METHOD_DELETE', 'POST,DELETE');
61 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
62 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
63 * into a page, and visitors will post something without noticing it).
65 * @brief Auth API user
69 if (x($_SESSION, 'allow_api')) {
77 * Clients can send 'source' parameter to be show in post metadata
78 * as "sent via <source>".
79 * Some clients doesn't send a source param, we support ones we know
82 * @brief Get source name from API client
85 * Client source name, default to "api" if unset/unknown
89 if (requestdata('source')) {
90 return requestdata('source');
93 // Support for known clients that doesn't send a source name
94 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
95 if(strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
99 logger("Unrecognized user-agent ".$_SERVER['HTTP_USER_AGENT'], LOGGER_DEBUG);
101 logger("Empty user-agent", LOGGER_DEBUG);
108 * @brief Format date for API
110 * @param string $str Source date, as UTC
111 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
113 function api_date($str)
115 // Wed May 23 06:01:13 +0000 2007
116 return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
120 * Register a function to be the endpoint for defined API path.
122 * @brief Register API endpoint
124 * @param string $path API URL path, relative to System::baseUrl()
125 * @param string $func Function name to call on path request
126 * @param bool $auth API need logged user
127 * @param string $method HTTP method reqiured to call this endpoint.
128 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
129 * Default to API_METHOD_ANY
131 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
141 // Workaround for hotot
142 $path = str_replace("api/", "api/1.1/", $path);
152 * Log in user via OAuth1 or Simple HTTP Auth.
153 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
155 * @brief Login API user
157 * @param object $a App
158 * @hook 'authenticate'
160 * 'username' => username from login form
161 * 'password' => password from login form
162 * 'authenticated' => return status,
163 * 'user_record' => return authenticated user record
165 * array $user logged user record
167 function api_login(App $a)
169 $oauth1 = new FKOAuth1();
172 $request = OAuthRequest::from_request();
173 list($consumer, $token) = $oauth1->verify_request($request);
174 if (!is_null($token)) {
175 $oauth1->loginUser($token->uid);
176 Addon::callHooks('logged_in', $a->user);
179 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
180 var_dump($consumer, $token);
182 } catch (Exception $e) {
186 // workaround for HTTP-auth in CGI mode
187 if (x($_SERVER, 'REDIRECT_REMOTE_USER')) {
188 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6)) ;
189 if (strlen($userpass)) {
190 list($name, $password) = explode(':', $userpass);
191 $_SERVER['PHP_AUTH_USER'] = $name;
192 $_SERVER['PHP_AUTH_PW'] = $password;
196 if (!x($_SERVER, 'PHP_AUTH_USER')) {
197 logger('API_login: ' . print_r($_SERVER, true), LOGGER_DEBUG);
198 header('WWW-Authenticate: Basic realm="Friendica"');
199 throw new UnauthorizedException("This API requires login");
202 $user = defaults($_SERVER, 'PHP_AUTH_USER', '');
203 $password = defaults($_SERVER, 'PHP_AUTH_PW', '');
205 // allow "user@server" login (but ignore 'server' part)
206 $at = strstr($user, "@", true);
211 // next code from mod/auth.php. needs better solution
215 'username' => trim($user),
216 'password' => trim($password),
217 'authenticated' => 0,
218 'user_record' => null,
222 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
223 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
224 * and later addons should not interfere with an earlier one that succeeded.
226 Addon::callHooks('authenticate', $addon_auth);
228 if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
229 $record = $addon_auth['user_record'];
231 $user_id = User::authenticate(trim($user), trim($password));
232 if ($user_id !== false) {
233 $record = dba::selectFirst('user', [], ['uid' => $user_id]);
237 if (!DBM::is_result($record)) {
238 logger('API_login failure: ' . print_r($_SERVER, true), LOGGER_DEBUG);
239 header('WWW-Authenticate: Basic realm="Friendica"');
240 //header('HTTP/1.0 401 Unauthorized');
241 //die('This api requires login');
242 throw new UnauthorizedException("This API requires login");
245 authenticate_success($record);
247 $_SESSION["allow_api"] = true;
249 Addon::callHooks('logged_in', $a->user);
253 * API endpoints can define which HTTP method to accept when called.
254 * This function check the current HTTP method agains endpoint
257 * @brief Check HTTP method of called API
259 * @param string $method Required methods, uppercase, separated by comma
262 function api_check_method($method)
264 if ($method == "*") {
267 return (stripos($method, defaults($_SERVER, 'REQUEST_METHOD', 'GET')) !== false);
271 * Authenticate user, call registered API function, set HTTP headers
273 * @brief Main API entry point
275 * @param object $a App
276 * @return string|array API call result
278 function api_call(App $a)
280 global $API, $called_api;
283 if (strpos($a->query_string, ".xml") > 0) {
286 if (strpos($a->query_string, ".json") > 0) {
289 if (strpos($a->query_string, ".rss") > 0) {
292 if (strpos($a->query_string, ".atom") > 0) {
297 foreach ($API as $p => $info) {
298 if (strpos($a->query_string, $p) === 0) {
299 if (!api_check_method($info['method'])) {
300 throw new MethodNotAllowedException();
303 $called_api = explode("/", $p);
304 //unset($_SERVER['PHP_AUTH_USER']);
306 /// @TODO should be "true ==[=] $info['auth']", if you miss only one = character, you assign a variable (only with ==). Let's make all this even.
307 if (!empty($info['auth']) && api_user() === false) {
311 logger('API call for ' . $a->user['username'] . ': ' . $a->query_string);
312 logger('API parameters: ' . print_r($_REQUEST, true));
314 $stamp = microtime(true);
315 $return = call_user_func($info['func'], $type);
316 $duration = (float) (microtime(true) - $stamp);
317 logger("API call duration: " . round($duration, 2) . "\t" . $a->query_string, LOGGER_DEBUG);
319 if (Config::get("system", "profiler")) {
320 $duration = microtime(true)-$a->performance["start"];
322 /// @TODO round() really everywhere?
324 parse_url($a->query_string, PHP_URL_PATH) . ": " . sprintf(
325 "Database: %s/%s, Cache %s/%s, Network: %s, I/O: %s, Other: %s, Total: %s",
326 round($a->performance["database"] - $a->performance["database_write"], 3),
327 round($a->performance["database_write"], 3),
328 round($a->performance["cache"], 3),
329 round($a->performance["cache_write"], 3),
330 round($a->performance["network"], 2),
331 round($a->performance["file"], 2),
332 round($duration - ($a->performance["database"]
333 + $a->performance["cache"] + $a->performance["cache_write"]
334 + $a->performance["network"] + $a->performance["file"]), 2),
340 if (Config::get("rendertime", "callstack")) {
341 $o = "Database Read:\n";
342 foreach ($a->callstack["database"] as $func => $time) {
343 $time = round($time, 3);
345 $o .= $func . ": " . $time . "\n";
348 $o .= "\nDatabase Write:\n";
349 foreach ($a->callstack["database_write"] as $func => $time) {
350 $time = round($time, 3);
352 $o .= $func . ": " . $time . "\n";
356 $o = "Cache Read:\n";
357 foreach ($a->callstack["cache"] as $func => $time) {
358 $time = round($time, 3);
360 $o .= $func . ": " . $time . "\n";
363 $o .= "\nCache Write:\n";
364 foreach ($a->callstack["cache_write"] as $func => $time) {
365 $time = round($time, 3);
367 $o .= $func . ": " . $time . "\n";
371 $o .= "\nNetwork:\n";
372 foreach ($a->callstack["network"] as $func => $time) {
373 $time = round($time, 3);
375 $o .= $func . ": " . $time . "\n";
378 logger($o, LOGGER_DEBUG);
382 if (false === $return) {
384 * api function returned false withour throw an
385 * exception. This should not happend, throw a 500
387 throw new InternalServerErrorException();
392 header("Content-Type: text/xml");
395 header("Content-Type: application/json");
396 $json = json_encode(end($return));
397 if (x($_GET, 'callback')) {
398 $json = $_GET['callback'] . "(" . $json . ")";
403 header("Content-Type: application/rss+xml");
404 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
407 header("Content-Type: application/atom+xml");
408 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
415 logger('API call not implemented: ' . $a->query_string);
416 throw new NotImplementedException();
417 } catch (HTTPException $e) {
418 header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}");
419 return api_error($type, $e);
424 * @brief Format API error string
426 * @param string $type Return type (xml, json, rss, as)
427 * @param object $e HTTPException Error object
428 * @return string|array error message formatted as $type
430 function api_error($type, $e)
434 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
435 /// @TODO: https://dev.twitter.com/overview/api/response-codes
437 $error = ["error" => $error,
438 "code" => $e->httpcode . " " . $e->httpdesc,
439 "request" => $a->query_string];
441 $return = api_format_data('status', $type, ['status' => $error]);
445 header("Content-Type: text/xml");
448 header("Content-Type: application/json");
449 $return = json_encode($return);
452 header("Content-Type: application/rss+xml");
455 header("Content-Type: application/atom+xml");
463 * @brief Set values for RSS template
466 * @param array $arr Array to be passed to template
467 * @param array $user_info User info
469 * @todo find proper type-hints
471 function api_rss_extra(App $a, $arr, $user_info)
473 if (is_null($user_info)) {
474 $user_info = api_get_user($a);
477 $arr['$user'] = $user_info;
479 'alternate' => $user_info['url'],
480 'self' => System::baseUrl() . "/" . $a->query_string,
481 'base' => System::baseUrl(),
482 'updated' => api_date(null),
483 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
484 'language' => $user_info['lang'],
485 'logo' => System::baseUrl() . "/images/friendica-32.png",
493 * @brief Unique contact to contact url.
495 * @param int $id Contact id
496 * @return bool|string
497 * Contact url or False if contact id is unknown
499 function api_unique_id_to_nurl($id)
501 $r = dba::selectFirst('contact', ['nurl'], ['id' => $id]);
503 if (DBM::is_result($r)) {
511 * @brief Get user info array.
513 * @param object $a App
514 * @param int|string $contact_id Contact ID or URL
516 function api_get_user(App $a, $contact_id = null)
524 logger("api_get_user: Fetching user data for user ".$contact_id, LOGGER_DEBUG);
526 // Searching for contact URL
527 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
528 $user = dbesc(normalise_link($contact_id));
530 $extra_query = "AND `contact`.`nurl` = '%s' ";
531 if (api_user() !== false) {
532 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
536 // Searching for contact id with uid = 0
537 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
538 $user = dbesc(api_unique_id_to_nurl(intval($contact_id)));
541 throw new BadRequestException("User ID ".$contact_id." not found.");
545 $extra_query = "AND `contact`.`nurl` = '%s' ";
546 if (api_user() !== false) {
547 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
551 if (is_null($user) && x($_GET, 'user_id')) {
552 $user = dbesc(api_unique_id_to_nurl($_GET['user_id']));
555 throw new BadRequestException("User ID ".$_GET['user_id']." not found.");
559 $extra_query = "AND `contact`.`nurl` = '%s' ";
560 if (api_user() !== false) {
561 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
564 if (is_null($user) && x($_GET, 'screen_name')) {
565 $user = dbesc($_GET['screen_name']);
566 $extra_query = "AND `contact`.`nick` = '%s' ";
567 if (api_user() !== false) {
568 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
572 if (is_null($user) && x($_GET, 'profileurl')) {
573 $user = dbesc(normalise_link($_GET['profileurl']));
574 $extra_query = "AND `contact`.`nurl` = '%s' ";
575 if (api_user() !== false) {
576 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
580 // $called_api is the API path exploded on / and is expected to have at least 2 elements
581 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
582 $argid = count($called_api);
583 if (!empty($a->argv[$argid])) {
584 list($user, $null) = explode(".", $a->argv[$argid]);
586 if (is_numeric($user)) {
587 $user = dbesc(api_unique_id_to_nurl(intval($user)));
591 $extra_query = "AND `contact`.`nurl` = '%s' ";
592 if (api_user() !== false) {
593 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
597 $user = dbesc($user);
598 $extra_query = "AND `contact`.`nick` = '%s' ";
599 if (api_user() !== false) {
600 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
605 logger("api_get_user: user ".$user, LOGGER_DEBUG);
608 if (api_user() === false) {
612 $user = $_SESSION['uid'];
613 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
617 logger('api_user: ' . $extra_query . ', user: ' . $user);
621 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
627 // Selecting the id by priority, friendica first
628 if (is_array($uinfo)) {
629 api_best_nickname($uinfo);
632 // if the contact wasn't found, fetch it from the contacts with uid = 0
633 if (!DBM::is_result($uinfo)) {
637 $r = q("SELECT * FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s' LIMIT 1", dbesc(normalise_link($url)));
640 if (DBM::is_result($r)) {
641 $network_name = ContactSelector::networkToName($r[0]['network'], $r[0]['url']);
643 // If no nick where given, extract it from the address
644 if (($r[0]['nick'] == "") || ($r[0]['name'] == $r[0]['nick'])) {
645 $r[0]['nick'] = api_get_nick($r[0]["url"]);
650 'id_str' => (string) $r[0]["id"],
651 'name' => $r[0]["name"],
652 'screen_name' => (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']),
653 'location' => ($r[0]["location"] != "") ? $r[0]["location"] : $network_name,
654 'description' => $r[0]["about"],
655 'profile_image_url' => $r[0]["micro"],
656 'profile_image_url_https' => $r[0]["micro"],
657 'profile_image_url_profile_size' => $r[0]["thumb"],
658 'profile_image_url_large' => $r[0]["photo"],
659 'url' => $r[0]["url"],
660 'protected' => false,
661 'followers_count' => 0,
662 'friends_count' => 0,
664 'created_at' => api_date($r[0]["created"]),
665 'favourites_count' => 0,
667 'time_zone' => 'UTC',
668 'geo_enabled' => false,
670 'statuses_count' => 0,
672 'contributors_enabled' => false,
673 'is_translator' => false,
674 'is_translation_enabled' => false,
675 'following' => false,
676 'follow_request_sent' => false,
677 'statusnet_blocking' => false,
678 'notifications' => false,
679 'statusnet_profile_url' => $r[0]["url"],
681 'cid' => Contact::getIdForURL($r[0]["url"], api_user(), true),
682 'pid' => Contact::getIdForURL($r[0]["url"], 0, true),
684 'network' => $r[0]["network"],
689 throw new BadRequestException("User ".$url." not found.");
693 if ($uinfo[0]['self']) {
694 if ($uinfo[0]['network'] == "") {
695 $uinfo[0]['network'] = NETWORK_DFRN;
698 $usr = dba::selectFirst('user', ['default-location'], ['uid' => api_user()]);
699 $profile = dba::selectFirst('profile', ['about'], ['uid' => api_user(), 'is-default' => true]);
706 // Add a nick if it isn't present there
707 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
708 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
711 $network_name = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
713 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
715 if (!empty($profile['about'])) {
716 $description = $profile['about'];
718 $description = $uinfo[0]["about"];
721 if (!empty($usr['default-location'])) {
722 $location = $usr['default-location'];
723 } elseif (!empty($uinfo[0]["location"])) {
724 $location = $uinfo[0]["location"];
726 $location = $network_name;
730 'id' => intval($pcontact_id),
731 'id_str' => (string) intval($pcontact_id),
732 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
733 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
734 'location' => $location,
735 'description' => $description,
736 'profile_image_url' => $uinfo[0]['micro'],
737 'profile_image_url_https' => $uinfo[0]['micro'],
738 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
739 'profile_image_url_large' => $uinfo[0]["photo"],
740 'url' => $uinfo[0]['url'],
741 'protected' => false,
742 'followers_count' => intval($countfollowers),
743 'friends_count' => intval($countfriends),
745 'created_at' => api_date($uinfo[0]['created']),
746 'favourites_count' => intval($starred),
748 'time_zone' => 'UTC',
749 'geo_enabled' => false,
751 'statuses_count' => intval($countitems),
753 'contributors_enabled' => false,
754 'is_translator' => false,
755 'is_translation_enabled' => false,
756 'following' => (($uinfo[0]['rel'] == CONTACT_IS_FOLLOWER) || ($uinfo[0]['rel'] == CONTACT_IS_FRIEND)),
757 'follow_request_sent' => false,
758 'statusnet_blocking' => false,
759 'notifications' => false,
761 //'statusnet_profile_url' => System::baseUrl()."/contacts/".$uinfo[0]['cid'],
762 'statusnet_profile_url' => $uinfo[0]['url'],
763 'uid' => intval($uinfo[0]['uid']),
764 'cid' => intval($uinfo[0]['cid']),
765 'pid' => Contact::getIdForURL($uinfo[0]["url"], 0, true),
766 'self' => $uinfo[0]['self'],
767 'network' => $uinfo[0]['network'],
770 // If this is a local user and it uses Frio, we can get its color preferences.
772 $theme_info = dba::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
773 if ($theme_info['theme'] === 'frio') {
774 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
776 if ($schema && ($schema != '---')) {
777 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
778 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
779 require_once $schemefile;
782 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
783 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
784 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
786 if (empty($nav_bg)) {
789 if (empty($link_color)) {
790 $link_color = "#6fdbe8";
792 if (empty($bgcolor)) {
793 $bgcolor = "#ededed";
796 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
797 $ret['profile_link_color'] = str_replace('#', '', $link_color);
798 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
806 * @brief return api-formatted array for item's author and owner
808 * @param object $a App
809 * @param array $item item from db
810 * @return array(array:author, array:owner)
812 function api_item_get_user(App $a, $item)
814 $status_user = api_get_user($a, defaults($item, 'author-id', null));
816 $status_user["protected"] = defaults($item, 'private', 0);
818 if (defaults($item, 'thr-parent', '') == defaults($item, 'uri', '')) {
819 $owner_user = api_get_user($a, defaults($item, 'author-id', null));
821 $owner_user = $status_user;
824 return ([$status_user, $owner_user]);
828 * @brief walks recursively through an array with the possibility to change value and key
830 * @param array $array The array to walk through
831 * @param string $callback The callback function
833 * @return array the transformed array
835 function api_walk_recursive(array &$array, callable $callback)
839 foreach ($array as $k => $v) {
841 if ($callback($v, $k)) {
842 $new_array[$k] = api_walk_recursive($v, $callback);
845 if ($callback($v, $k)) {
856 * @brief Callback function to transform the array in an array that can be transformed in a XML file
858 * @param mixed $item Array item value
859 * @param string $key Array key
861 * @return boolean Should the array item be deleted?
863 function api_reformat_xml(&$item, &$key)
865 if (is_bool($item)) {
866 $item = ($item ? "true" : "false");
869 if (substr($key, 0, 10) == "statusnet_") {
870 $key = "statusnet:".substr($key, 10);
871 } elseif (substr($key, 0, 10) == "friendica_") {
872 $key = "friendica:".substr($key, 10);
874 /// @TODO old-lost code?
876 // $key = "default:".$key;
882 * @brief Creates the XML from a JSON style array
884 * @param array $data JSON style array
885 * @param string $root_element Name of the root element
887 * @return string The XML data
889 function api_create_xml(array $data, $root_element)
891 $childname = key($data);
892 $data2 = array_pop($data);
894 $namespaces = ["" => "http://api.twitter.com",
895 "statusnet" => "http://status.net/schema/api/1/",
896 "friendica" => "http://friendi.ca/schema/api/1/",
897 "georss" => "http://www.georss.org/georss"];
899 /// @todo Auto detection of needed namespaces
900 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
904 if (is_array($data2)) {
906 api_walk_recursive($data2, "api_reformat_xml");
912 foreach ($data2 as $item) {
913 $data4[$i++ . ":" . $childname] = $item;
920 $data3 = [$root_element => $data2];
922 $ret = XML::fromArray($data3, $xml, false, $namespaces);
927 * @brief Formats the data according to the data type
929 * @param string $root_element Name of the root element
930 * @param string $type Return type (atom, rss, xml, json)
931 * @param array $data JSON style array
933 * @return (string|array) XML data or JSON data
935 function api_format_data($root_element, $type, $data)
941 $ret = api_create_xml($data, $root_element);
957 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
958 * returns a 401 status code and an error message if not.
959 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
961 * @param string $type Return type (atom, rss, xml, json)
963 function api_account_verify_credentials($type)
968 if (api_user() === false) {
969 throw new ForbiddenException();
972 unset($_REQUEST["user_id"]);
973 unset($_GET["user_id"]);
975 unset($_REQUEST["screen_name"]);
976 unset($_GET["screen_name"]);
978 $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false);
980 $user_info = api_get_user($a);
982 // "verified" isn't used here in the standard
983 unset($user_info["verified"]);
985 // - Adding last status
987 $user_info["status"] = api_status_show("raw");
988 if (!count($user_info["status"])) {
989 unset($user_info["status"]);
991 unset($user_info["status"]["user"]);
995 // "uid" and "self" are only needed for some internal stuff, so remove it from here
996 unset($user_info["uid"]);
997 unset($user_info["self"]);
999 return api_format_data("user", $type, ['user' => $user_info]);
1002 /// @TODO move to top of file or somewhere better
1003 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1006 * Get data from $_POST or $_GET
1010 function requestdata($k)
1012 if (x($_POST, $k)) {
1022 * Deprecated function to upload media.
1024 * @param string $type Return type (atom, rss, xml, json)
1026 * @return array|string
1028 function api_statuses_mediap($type)
1032 if (api_user() === false) {
1033 logger('api_statuses_update: no user');
1034 throw new ForbiddenException();
1036 $user_info = api_get_user($a);
1038 $_REQUEST['type'] = 'wall';
1039 $_REQUEST['profile_uid'] = api_user();
1040 $_REQUEST['api_source'] = true;
1041 $txt = requestdata('status');
1042 /// @TODO old-lost code?
1043 //$txt = urldecode(requestdata('status'));
1045 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1046 $txt = html2bb_video($txt);
1047 $config = HTMLPurifier_Config::createDefault();
1048 $config->set('Cache.DefinitionImpl', null);
1049 $purifier = new HTMLPurifier($config);
1050 $txt = $purifier->purify($txt);
1052 $txt = HTML::toBBCode($txt);
1054 $a->argv[1] = $user_info['screen_name']; //should be set to username?
1056 $picture = wall_upload_post($a, false);
1058 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1059 $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1062 // this should output the last post (the one we just posted).
1063 return api_status_show($type);
1066 /// @TODO move this to top of file or somewhere better!
1067 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1070 * Updates the user’s current status.
1072 * @param string $type Return type (atom, rss, xml, json)
1074 * @return array|string
1075 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1077 function api_statuses_update($type)
1082 if (api_user() === false) {
1083 logger('api_statuses_update: no user');
1084 throw new ForbiddenException();
1089 // convert $_POST array items to the form we use for web posts.
1090 if (requestdata('htmlstatus')) {
1091 $txt = requestdata('htmlstatus');
1092 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1093 $txt = html2bb_video($txt);
1095 $config = HTMLPurifier_Config::createDefault();
1096 $config->set('Cache.DefinitionImpl', null);
1098 $purifier = new HTMLPurifier($config);
1099 $txt = $purifier->purify($txt);
1101 $_REQUEST['body'] = HTML::toBBCode($txt);
1104 $_REQUEST['body'] = requestdata('status');
1107 $_REQUEST['title'] = requestdata('title');
1109 $parent = requestdata('in_reply_to_status_id');
1111 // Twidere sends "-1" if it is no reply ...
1112 if ($parent == -1) {
1116 if (ctype_digit($parent)) {
1117 $_REQUEST['parent'] = $parent;
1119 $_REQUEST['parent_uri'] = $parent;
1122 if (requestdata('lat') && requestdata('long')) {
1123 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1125 $_REQUEST['profile_uid'] = api_user();
1128 $_REQUEST['type'] = 'net-comment';
1130 // Check for throttling (maximum posts per day, week and month)
1131 $throttle_day = Config::get('system', 'throttle_limit_day');
1132 if ($throttle_day > 0) {
1133 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1135 $condition = ["`uid` = ? AND `wall` AND `created` > ? AND `id` = `parent`", api_user(), $datefrom];
1136 $posts_day = dba::count('item', $condition);
1138 if ($posts_day > $throttle_day) {
1139 logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG);
1140 // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1141 throw new TooManyRequestsException(L10n::tt("Daily posting limit of %d post reached. The post was rejected.", "Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1145 $throttle_week = Config::get('system', 'throttle_limit_week');
1146 if ($throttle_week > 0) {
1147 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1149 $condition = ["`uid` = ? AND `wall` AND `created` > ? AND `id` = `parent`", api_user(), $datefrom];
1150 $posts_week = dba::count('item', $condition);
1152 if ($posts_week > $throttle_week) {
1153 logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1154 // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1155 throw new TooManyRequestsException(L10n::tt("Weekly posting limit of %d post reached. The post was rejected.", "Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week));
1159 $throttle_month = Config::get('system', 'throttle_limit_month');
1160 if ($throttle_month > 0) {
1161 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1163 $condition = ["`uid` = ? AND `wall` AND `created` > ? AND `id` = `parent`", api_user(), $datefrom];
1164 $posts_month = dba::count('item', $condition);
1166 if ($posts_month > $throttle_month) {
1167 logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1168 // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1169 throw new TooManyRequestsException(L10n::t("Monthly posting limit of %d post reached. The post was rejected.", "Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1173 $_REQUEST['type'] = 'wall';
1176 if (x($_FILES, 'media')) {
1177 // upload the image if we have one
1178 $picture = wall_upload_post($a, false);
1179 if (is_array($picture)) {
1180 $_REQUEST['body'] .= "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1184 // To-Do: Multiple IDs
1185 if (requestdata('media_ids')) {
1187 "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",
1188 intval(requestdata('media_ids')),
1191 if (DBM::is_result($r)) {
1192 $phototypes = Image::supportedTypes();
1193 $ext = $phototypes[$r[0]['type']];
1194 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1195 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1199 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1201 $_REQUEST['api_source'] = true;
1203 if (!x($_REQUEST, "source")) {
1204 $_REQUEST["source"] = api_source();
1207 // call out normal post function
1210 // this should output the last post (the one we just posted).
1211 return api_status_show($type);
1214 /// @TODO move to top of file or somewhere better
1215 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1216 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1219 * Uploads an image to Friendica.
1222 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1224 function api_media_upload()
1228 if (api_user() === false) {
1230 throw new ForbiddenException();
1235 if (!x($_FILES, 'media')) {
1237 throw new BadRequestException("No media.");
1240 $media = wall_upload_post($a, false);
1243 throw new InternalServerErrorException();
1247 $returndata["media_id"] = $media["id"];
1248 $returndata["media_id_string"] = (string)$media["id"];
1249 $returndata["size"] = $media["size"];
1250 $returndata["image"] = ["w" => $media["width"],
1251 "h" => $media["height"],
1252 "image_type" => $media["type"]];
1254 logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG);
1256 return ["media" => $returndata];
1259 /// @TODO move to top of file or somewhere better
1260 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1264 * @param string $type Return type (atom, rss, xml, json)
1266 * @return array|string
1268 function api_status_show($type)
1272 $user_info = api_get_user($a);
1274 logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG);
1276 if ($type == "raw") {
1277 $privacy_sql = "AND NOT `private`";
1282 // get last public wall message
1283 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1284 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1285 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1287 if (DBM::is_result($lastwall)) {
1288 $in_reply_to = api_in_reply_to($lastwall);
1290 $converted = api_convert_item($lastwall);
1292 if ($type == "xml") {
1293 $geo = "georss:point";
1299 'created_at' => api_date($lastwall['created']),
1300 'id' => intval($lastwall['id']),
1301 'id_str' => (string) $lastwall['id'],
1302 'text' => $converted["text"],
1303 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1304 'truncated' => false,
1305 'in_reply_to_status_id' => $in_reply_to['status_id'],
1306 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1307 'in_reply_to_user_id' => $in_reply_to['user_id'],
1308 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1309 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1310 'user' => $user_info,
1312 'coordinates' => '',
1314 'contributors' => '',
1315 'is_quote_status' => false,
1316 'retweet_count' => 0,
1317 'favorite_count' => 0,
1318 'favorited' => $lastwall['starred'] ? true : false,
1319 'retweeted' => false,
1320 'possibly_sensitive' => false,
1322 'statusnet_html' => $converted["html"],
1323 'statusnet_conversation_id' => $lastwall['parent'],
1324 'external_url' => System::baseUrl() . '/display/' . $lastwall['guid'],
1327 if (count($converted["attachments"]) > 0) {
1328 $status_info["attachments"] = $converted["attachments"];
1331 if (count($converted["entities"]) > 0) {
1332 $status_info["entities"] = $converted["entities"];
1335 if ($status_info["source"] == 'web') {
1336 $status_info["source"] = ContactSelector::networkToName($lastwall['network'], $user_info['url']);
1337 } elseif (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $status_info["source"]) {
1338 $status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['network'], $user_info['url']).')');
1341 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1342 unset($status_info["user"]["uid"]);
1343 unset($status_info["user"]["self"]);
1345 logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG);
1347 if ($type == "raw") {
1348 return $status_info;
1351 return api_format_data("statuses", $type, ['status' => $status_info]);
1356 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1357 * The author's most recent status will be returned inline.
1359 * @param string $type Return type (atom, rss, xml, json)
1360 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1362 function api_users_show($type)
1366 $user_info = api_get_user($a);
1368 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1369 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'private' => false];
1370 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1372 if (DBM::is_result($lastwall)) {
1373 $in_reply_to = api_in_reply_to($lastwall);
1375 $converted = api_convert_item($lastwall);
1377 if ($type == "xml") {
1378 $geo = "georss:point";
1383 $user_info['status'] = [
1384 'text' => $converted["text"],
1385 'truncated' => false,
1386 'created_at' => api_date($lastwall['created']),
1387 'in_reply_to_status_id' => $in_reply_to['status_id'],
1388 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1389 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1390 'id' => intval($lastwall['contact-id']),
1391 'id_str' => (string) $lastwall['contact-id'],
1392 'in_reply_to_user_id' => $in_reply_to['user_id'],
1393 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1394 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1396 'favorited' => $lastwall['starred'] ? true : false,
1397 'statusnet_html' => $converted["html"],
1398 'statusnet_conversation_id' => $lastwall['parent'],
1399 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1402 if (count($converted["attachments"]) > 0) {
1403 $user_info["status"]["attachments"] = $converted["attachments"];
1406 if (count($converted["entities"]) > 0) {
1407 $user_info["status"]["entities"] = $converted["entities"];
1410 if ($user_info["status"]["source"] == 'web') {
1411 $user_info["status"]["source"] = ContactSelector::networkToName($lastwall['network'], $user_info['url']);
1414 if (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $user_info["status"]["source"]) {
1415 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['network'], $user_info['url']) . ')');
1419 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1420 unset($user_info["uid"]);
1421 unset($user_info["self"]);
1423 return api_format_data("user", $type, ['user' => $user_info]);
1426 /// @TODO move to top of file or somewhere better
1427 api_register_func('api/users/show', 'api_users_show');
1428 api_register_func('api/externalprofile/show', 'api_users_show');
1431 * Search a public user account.
1433 * @param string $type Return type (atom, rss, xml, json)
1435 * @return array|string
1436 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1438 function api_users_search($type)
1444 if (x($_GET, 'q')) {
1445 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", dbesc($_GET["q"]));
1447 if (!DBM::is_result($r)) {
1448 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", dbesc($_GET["q"]));
1451 if (DBM::is_result($r)) {
1453 foreach ($r as $user) {
1454 $user_info = api_get_user($a, $user["id"]);
1456 if ($type == "xml") {
1457 $userlist[$k++.":user"] = $user_info;
1459 $userlist[] = $user_info;
1462 $userlist = ["users" => $userlist];
1464 throw new BadRequestException("User ".$_GET["q"]." not found.");
1467 throw new BadRequestException("No user specified.");
1470 return api_format_data("users", $type, $userlist);
1473 /// @TODO move to top of file or somewhere better
1474 api_register_func('api/users/search', 'api_users_search');
1477 * Return user objects
1479 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1481 * @param string $type Return format: json or xml
1483 * @return array|string
1484 * @throws NotFoundException if the results are empty.
1486 function api_users_lookup($type)
1490 if (!empty($_REQUEST['user_id'])) {
1491 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1493 $users[] = api_get_user(get_app(), $id);
1498 if (empty($users)) {
1499 throw new NotFoundException;
1502 return api_format_data("users", $type, ['users' => $users]);
1505 /// @TODO move to top of file or somewhere better
1506 api_register_func('api/users/lookup', 'api_users_lookup', true);
1509 * Returns statuses that match a specified query.
1511 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1513 * @param string $type Return format: json, xml, atom, rss
1515 * @return array|string
1516 * @throws BadRequestException if the "q" parameter is missing.
1518 function api_search($type)
1521 $user_info = api_get_user($a);
1523 if (api_user() === false || $user_info === false) {
1524 throw new ForbiddenException();
1529 if (!x($_REQUEST, 'q')) {
1530 throw new BadRequestException("q parameter is required.");
1533 if (x($_REQUEST, 'rpp')) {
1534 $count = $_REQUEST['rpp'];
1535 } elseif (x($_REQUEST, 'count')) {
1536 $count = $_REQUEST['count'];
1541 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1542 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1543 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1545 $start = $page * $count;
1547 $condition = ["`gravity` IN (?, ?) AND `item`.`id` > ?
1548 AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))
1549 AND `item`.`body` LIKE CONCAT('%',?,'%')",
1550 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, api_user(), $_REQUEST['q']];
1553 $condition[0] .= " AND `item`.`id` <= ?";
1554 $condition[] = $max_id;
1557 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1558 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1560 $data['status'] = api_format_items(Item::inArray($statuses), $user_info);
1562 return api_format_data("statuses", $type, $data);
1565 /// @TODO move to top of file or somewhere better
1566 api_register_func('api/search/tweets', 'api_search', true);
1567 api_register_func('api/search', 'api_search', true);
1570 * Returns the most recent statuses posted by the user and the users they follow.
1572 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1574 * @param string $type Return type (atom, rss, xml, json)
1576 * @todo Optional parameters
1577 * @todo Add reply info
1579 function api_statuses_home_timeline($type)
1582 $user_info = api_get_user($a);
1584 if (api_user() === false || $user_info === false) {
1585 throw new ForbiddenException();
1588 unset($_REQUEST["user_id"]);
1589 unset($_GET["user_id"]);
1591 unset($_REQUEST["screen_name"]);
1592 unset($_GET["screen_name"]);
1594 // get last network messages
1597 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1598 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1602 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1603 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1604 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1605 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1606 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1608 $start = $page * $count;
1610 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1611 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1614 $condition[0] .= " AND `item`.`id` <= ?";
1615 $condition[] = $max_id;
1617 if ($exclude_replies > 0) {
1618 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
1620 if ($conversation_id > 0) {
1621 $condition[0] .= " AND `item`.`parent` = ?";
1622 $condition[] = $conversation_id;
1625 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1626 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1628 $items = Item::inArray($statuses);
1630 $ret = api_format_items($items, $user_info, false, $type);
1632 // Set all posts from the query above to seen
1634 foreach ($items as $item) {
1635 $idarray[] = intval($item["id"]);
1638 if (!empty($idarray)) {
1639 $unseen = Item::exists(['unseen' => true, 'id' => $idarray]);
1641 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1645 $data = ['status' => $ret];
1649 $data = api_rss_extra($a, $data, $user_info);
1653 return api_format_data("statuses", $type, $data);
1656 /// @TODO move to top of file or somewhere better
1657 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1658 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1661 * Returns the most recent statuses from public users.
1663 * @param string $type Return type (atom, rss, xml, json)
1665 * @return array|string
1667 function api_statuses_public_timeline($type)
1670 $user_info = api_get_user($a);
1672 if (api_user() === false || $user_info === false) {
1673 throw new ForbiddenException();
1676 // get last network messages
1679 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1680 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
1684 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1685 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1686 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1687 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1688 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1690 $start = $page * $count;
1693 if ($exclude_replies && !$conversation_id) {
1694 $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall`",
1695 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1698 $condition[0] .= " AND `thread`.`iid` <= ?";
1699 $condition[] = $max_id;
1702 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1703 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1705 $r = Item::inArray($statuses);
1707 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND `item`.`origin`",
1708 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1711 $condition[0] .= " AND `item`.`id` <= ?";
1712 $condition[] = $max_id;
1714 if ($conversation_id > 0) {
1715 $condition[0] .= " AND `item`.`parent` = ?";
1716 $condition[] = $conversation_id;
1719 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1720 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1722 $r = Item::inArray($statuses);
1725 $ret = api_format_items($r, $user_info, false, $type);
1727 $data = ['status' => $ret];
1731 $data = api_rss_extra($a, $data, $user_info);
1735 return api_format_data("statuses", $type, $data);
1738 /// @TODO move to top of file or somewhere better
1739 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1742 * Returns the most recent statuses posted by users this node knows about.
1744 * @brief Returns the list of public federated posts this node knows about
1746 * @param string $type Return format: json, xml, atom, rss
1747 * @return array|string
1748 * @throws ForbiddenException
1750 function api_statuses_networkpublic_timeline($type)
1753 $user_info = api_get_user($a);
1755 if (api_user() === false || $user_info === false) {
1756 throw new ForbiddenException();
1759 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
1760 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
1763 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
1764 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
1768 $start = ($page - 1) * $count;
1770 $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `thread`.`iid` > ? AND NOT `private`",
1771 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1774 $condition[0] .= " AND `thread`.`iid` <= ?";
1775 $condition[] = $max_id;
1778 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1779 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1781 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1783 $data = ['status' => $ret];
1787 $data = api_rss_extra($a, $data, $user_info);
1791 return api_format_data("statuses", $type, $data);
1794 /// @TODO move to top of file or somewhere better
1795 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1798 * Returns a single status.
1800 * @param string $type Return type (atom, rss, xml, json)
1802 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1804 function api_statuses_show($type)
1807 $user_info = api_get_user($a);
1809 if (api_user() === false || $user_info === false) {
1810 throw new ForbiddenException();
1814 $id = intval(defaults($a->argv, 3, 0));
1817 $id = intval(defaults($_REQUEST, 'id', 0));
1822 $id = intval(defaults($a->argv, 4, 0));
1825 logger('API: api_statuses_show: ' . $id);
1827 $conversation = !empty($_REQUEST['conversation']);
1829 // try to fetch the item for the local user - or the public item, if there is no local one
1830 $uri_item = Item::selectFirst(['uri'], ['id' => $id]);
1831 if (!DBM::is_result($uri_item)) {
1832 throw new BadRequestException("There is no status with this id.");
1835 $item = Item::selectFirst(['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1836 if (!DBM::is_result($item)) {
1837 throw new BadRequestException("There is no status with this id.");
1842 if ($conversation) {
1843 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1844 $params = ['order' => ['id' => true]];
1846 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1850 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1852 /// @TODO How about copying this to above methods which don't check $r ?
1853 if (!DBM::is_result($statuses)) {
1854 throw new BadRequestException("There is no status with this id.");
1857 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1859 if ($conversation) {
1860 $data = ['status' => $ret];
1861 return api_format_data("statuses", $type, $data);
1863 $data = ['status' => $ret[0]];
1864 return api_format_data("status", $type, $data);
1868 /// @TODO move to top of file or somewhere better
1869 api_register_func('api/statuses/show', 'api_statuses_show', true);
1873 * @param string $type Return type (atom, rss, xml, json)
1875 * @todo nothing to say?
1877 function api_conversation_show($type)
1880 $user_info = api_get_user($a);
1882 if (api_user() === false || $user_info === false) {
1883 throw new ForbiddenException();
1887 $id = intval(defaults($a->argv , 3 , 0));
1888 $since_id = intval(defaults($_REQUEST, 'since_id', 0));
1889 $max_id = intval(defaults($_REQUEST, 'max_id' , 0));
1890 $count = intval(defaults($_REQUEST, 'count' , 20));
1891 $page = intval(defaults($_REQUEST, 'page' , 1)) - 1;
1896 $start = $page * $count;
1899 $id = intval(defaults($_REQUEST, 'id', 0));
1904 $id = intval(defaults($a->argv, 4, 0));
1907 logger('API: api_conversation_show: '.$id);
1909 // try to fetch the item for the local user - or the public item, if there is no local one
1910 $item = Item::selectFirst(['parent-uri'], ['id' => $id]);
1911 if (!DBM::is_result($item)) {
1912 throw new BadRequestException("There is no status with this id.");
1915 $parent = Item::selectFirst(['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1916 if (!DBM::is_result($parent)) {
1917 throw new BadRequestException("There is no status with this id.");
1920 $id = $parent['id'];
1922 $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1923 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1926 $condition[0] .= " AND `item`.`id` <= ?";
1927 $condition[] = $max_id;
1930 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1931 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1933 if (!DBM::is_result($statuses)) {
1934 throw new BadRequestException("There is no status with id $id.");
1937 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1939 $data = ['status' => $ret];
1940 return api_format_data("statuses", $type, $data);
1943 /// @TODO move to top of file or somewhere better
1944 api_register_func('api/conversation/show', 'api_conversation_show', true);
1945 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
1950 * @param string $type Return type (atom, rss, xml, json)
1952 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
1954 function api_statuses_repeat($type)
1960 if (api_user() === false) {
1961 throw new ForbiddenException();
1967 $id = intval(defaults($a->argv, 3, 0));
1970 $id = intval(defaults($_REQUEST, 'id', 0));
1975 $id = intval(defaults($a->argv, 4, 0));
1978 logger('API: api_statuses_repeat: '.$id);
1980 $fields = ['body', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
1981 $item = Item::selectFirst($fields, ['id' => $id, 'private' => false]);
1983 if (DBM::is_result($item) && $item['body'] != "") {
1984 if (strpos($item['body'], "[/share]") !== false) {
1985 $pos = strpos($item['body'], "[share");
1986 $post = substr($item['body'], $pos);
1988 $post = share_header($item['author-name'], $item['author-link'], $item['author-avatar'], $item['guid'], $item['created'], $item['plink']);
1990 $post .= $item['body'];
1991 $post .= "[/share]";
1993 $_REQUEST['body'] = $post;
1994 $_REQUEST['profile_uid'] = api_user();
1995 $_REQUEST['type'] = 'wall';
1996 $_REQUEST['api_source'] = true;
1998 if (!x($_REQUEST, "source")) {
1999 $_REQUEST["source"] = api_source();
2004 throw new ForbiddenException();
2007 // this should output the last post (the one we just posted).
2009 return api_status_show($type);
2012 /// @TODO move to top of file or somewhere better
2013 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2016 * Destroys a specific status.
2018 * @param string $type Return type (atom, rss, xml, json)
2020 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2022 function api_statuses_destroy($type)
2026 if (api_user() === false) {
2027 throw new ForbiddenException();
2033 $id = intval(defaults($a->argv, 3, 0));
2036 $id = intval(defaults($_REQUEST, 'id', 0));
2041 $id = intval(defaults($a->argv, 4, 0));
2044 logger('API: api_statuses_destroy: '.$id);
2046 $ret = api_statuses_show($type);
2048 Item::deleteForUser(['id' => $id], api_user());
2053 /// @TODO move to top of file or somewhere better
2054 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2057 * Returns the most recent mentions.
2059 * @param string $type Return type (atom, rss, xml, json)
2061 * @see http://developer.twitter.com/doc/get/statuses/mentions
2063 function api_statuses_mentions($type)
2066 $user_info = api_get_user($a);
2068 if (api_user() === false || $user_info === false) {
2069 throw new ForbiddenException();
2072 unset($_REQUEST["user_id"]);
2073 unset($_GET["user_id"]);
2075 unset($_REQUEST["screen_name"]);
2076 unset($_GET["screen_name"]);
2078 // get last network messages
2081 $since_id = defaults($_REQUEST, 'since_id', 0);
2082 $max_id = defaults($_REQUEST, 'max_id' , 0);
2083 $count = defaults($_REQUEST, 'count' , 20);
2084 $page = defaults($_REQUEST, 'page' , 1);
2089 $start = ($page - 1) * $count;
2091 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `author-id` != ?
2092 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `thread`.`uid` = ? AND `thread`.`mention` AND NOT `thread`.`ignored`)",
2093 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['pid'], api_user()];
2096 $condition[0] .= " AND `item`.`id` <= ?";
2097 $condition[] = $max_id;
2100 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2101 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2103 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2105 $data = ['status' => $ret];
2109 $data = api_rss_extra($a, $data, $user_info);
2113 return api_format_data("statuses", $type, $data);
2116 /// @TODO move to top of file or somewhere better
2117 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2118 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2121 * Returns the most recent statuses posted by the user.
2123 * @brief Returns a user's public timeline
2125 * @param string $type Either "json" or "xml"
2126 * @return string|array
2127 * @throws ForbiddenException
2128 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2130 function api_statuses_user_timeline($type)
2133 $user_info = api_get_user($a);
2135 if (api_user() === false || $user_info === false) {
2136 throw new ForbiddenException();
2140 "api_statuses_user_timeline: api_user: ". api_user() .
2141 "\nuser_info: ".print_r($user_info, true) .
2142 "\n_REQUEST: ".print_r($_REQUEST, true),
2146 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
2147 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
2148 $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0;
2149 $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0;
2152 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
2153 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
2157 $start = ($page - 1) * $count;
2159 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `item`.`contact-id` = ?",
2160 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2162 if ($user_info['self'] == 1) {
2163 $condition[0] .= ' AND `item`.`wall` ';
2166 if ($exclude_replies > 0) {
2167 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
2170 if ($conversation_id > 0) {
2171 $condition[0] .= " AND `item`.`parent` = ?";
2172 $condition[] = $conversation_id;
2176 $condition[0] .= " AND `item`.`id` <= ?";
2177 $condition[] = $max_id;
2180 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2181 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2183 $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type);
2185 $data = ['status' => $ret];
2189 $data = api_rss_extra($a, $data, $user_info);
2193 return api_format_data("statuses", $type, $data);
2196 /// @TODO move to top of file or somewhere better
2197 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2200 * Star/unstar an item.
2201 * param: id : id of the item
2203 * @param string $type Return type (atom, rss, xml, json)
2205 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2207 function api_favorites_create_destroy($type)
2211 if (api_user() === false) {
2212 throw new ForbiddenException();
2215 // for versioned api.
2216 /// @TODO We need a better global soluton
2217 $action_argv_id = 2;
2218 if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2219 $action_argv_id = 3;
2222 if ($a->argc <= $action_argv_id) {
2223 throw new BadRequestException("Invalid request.");
2225 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2226 if ($a->argc == $action_argv_id + 2) {
2227 $itemid = intval(defaults($a->argv, $action_argv_id + 1, 0));
2229 $itemid = intval(defaults($_REQUEST, 'id', 0));
2232 $item = Item::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2234 if (!DBM::is_result($item)) {
2235 throw new BadRequestException("Invalid item.");
2240 $item['starred'] = 1;
2243 $item['starred'] = 0;
2246 throw new BadRequestException("Invalid action ".$action);
2249 $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2252 throw new InternalServerErrorException("DB error");
2256 $user_info = api_get_user($a);
2257 $rets = api_format_items([$item], $user_info, false, $type);
2260 $data = ['status' => $ret];
2264 $data = api_rss_extra($a, $data, $user_info);
2267 return api_format_data("status", $type, $data);
2270 /// @TODO move to top of file or somewhere better
2271 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2272 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2275 * Returns the most recent favorite statuses.
2277 * @param string $type Return type (atom, rss, xml, json)
2279 * @return string|array
2281 function api_favorites($type)
2286 $user_info = api_get_user($a);
2288 if (api_user() === false || $user_info === false) {
2289 throw new ForbiddenException();
2294 // in friendica starred item are private
2295 // return favorites only for self
2296 logger('api_favorites: self:' . $user_info['self']);
2298 if ($user_info['self'] == 0) {
2302 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2303 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2304 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
2305 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2310 $start = $page*$count;
2312 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2313 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2315 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2318 $condition[0] .= " AND `item`.`id` <= ?";
2319 $condition[] = $max_id;
2322 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2324 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2327 $data = ['status' => $ret];
2331 $data = api_rss_extra($a, $data, $user_info);
2334 return api_format_data("statuses", $type, $data);
2337 /// @TODO move to top of file or somewhere better
2338 api_register_func('api/favorites', 'api_favorites', true);
2342 * @param array $item
2343 * @param array $recipient
2344 * @param array $sender
2348 function api_format_messages($item, $recipient, $sender)
2350 // standard meta information
2352 'id' => $item['id'],
2353 'sender_id' => $sender['id'] ,
2355 'recipient_id' => $recipient['id'],
2356 'created_at' => api_date(defaults($item, 'created', DateTimeFormat::utcNow())),
2357 'sender_screen_name' => $sender['screen_name'],
2358 'recipient_screen_name' => $recipient['screen_name'],
2359 'sender' => $sender,
2360 'recipient' => $recipient,
2362 'friendica_seen' => defaults($item, 'seen', 0),
2363 'friendica_parent_uri' => defaults($item, 'parent-uri', ''),
2366 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2367 if (isset($ret['sender']['uid'])) {
2368 unset($ret['sender']['uid']);
2370 if (isset($ret['sender']['self'])) {
2371 unset($ret['sender']['self']);
2373 if (isset($ret['recipient']['uid'])) {
2374 unset($ret['recipient']['uid']);
2376 if (isset($ret['recipient']['self'])) {
2377 unset($ret['recipient']['self']);
2380 //don't send title to regular StatusNET requests to avoid confusing these apps
2381 if (x($_GET, 'getText')) {
2382 $ret['title'] = $item['title'];
2383 if ($_GET['getText'] == 'html') {
2384 $ret['text'] = BBCode::convert($item['body'], false);
2385 } elseif ($_GET['getText'] == 'plain') {
2386 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2389 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2391 if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') {
2392 unset($ret['sender']);
2393 unset($ret['recipient']);
2401 * @param array $item
2405 function api_convert_item($item)
2407 $body = $item['body'];
2408 $attachments = api_get_attachments($body);
2410 // Workaround for ostatus messages where the title is identically to the body
2411 $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2412 $statusbody = trim(HTML::toPlaintext($html, 0));
2414 // handle data: images
2415 $statusbody = api_format_items_embeded_images($item, $statusbody);
2417 $statustitle = trim($item['title']);
2419 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2420 $statustext = trim($statusbody);
2422 $statustext = trim($statustitle."\n\n".$statusbody);
2425 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($statustext)> 1000)) {
2426 $statustext = substr($statustext, 0, 1000) . "... \n" . defaults($item, 'plink', '');
2429 $statushtml = BBCode::convert(api_clean_attachments($body), false);
2431 // Workaround for clients with limited HTML parser functionality
2432 $search = ["<br>", "<blockquote>", "</blockquote>",
2433 "<h1>", "</h1>", "<h2>", "</h2>",
2434 "<h3>", "</h3>", "<h4>", "</h4>",
2435 "<h5>", "</h5>", "<h6>", "</h6>"];
2436 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2437 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2438 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2439 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2440 $statushtml = str_replace($search, $replace, $statushtml);
2442 if ($item['title'] != "") {
2443 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2447 $oldtext = $statushtml;
2448 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2449 } while ($oldtext != $statushtml);
2451 if (substr($statushtml, 0, 4) == '<br>') {
2452 $statushtml = substr($statushtml, 4);
2455 if (substr($statushtml, 0, -4) == '<br>') {
2456 $statushtml = substr($statushtml, -4);
2459 // feeds without body should contain the link
2460 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2461 $statushtml .= BBCode::convert($item['plink']);
2464 $entities = api_get_entitities($statustext, $body);
2467 "text" => $statustext,
2468 "html" => $statushtml,
2469 "attachments" => $attachments,
2470 "entities" => $entities
2476 * @param string $body
2480 function api_get_attachments(&$body)
2483 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2485 $URLSearchString = "^\[\]";
2486 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2494 foreach ($images[1] as $image) {
2495 $imagedata = Image::getInfoFromURL($image);
2498 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2502 if (strstr(defaults($_SERVER, 'HTTP_USER_AGENT', ''), "AndStatus")) {
2503 foreach ($images[0] as $orig) {
2504 $body = str_replace($orig, "", $body);
2508 return $attachments;
2513 * @param string $text
2514 * @param string $bbcode
2517 * @todo Links at the first character of the post
2519 function api_get_entitities(&$text, $bbcode)
2521 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
2523 if ($include_entities != "true") {
2524 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2526 foreach ($images[1] as $image) {
2527 $replace = proxy_url($image);
2528 $text = str_replace($image, $replace, $text);
2533 $bbcode = BBCode::cleanPictureLinks($bbcode);
2535 // Change pure links in text to bbcode uris
2536 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2539 $entities["hashtags"] = [];
2540 $entities["symbols"] = [];
2541 $entities["urls"] = [];
2542 $entities["user_mentions"] = [];
2544 $URLSearchString = "^\[\]";
2546 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2548 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2549 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2550 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2552 $bbcode = preg_replace(
2553 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2554 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2557 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2559 $bbcode = preg_replace(
2560 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2561 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2564 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2566 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2568 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2569 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2572 foreach ($urls[1] as $id => $url) {
2573 //$start = strpos($text, $url, $offset);
2574 $start = iconv_strpos($text, $url, 0, "UTF-8");
2575 if (!($start === false)) {
2576 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2580 ksort($ordered_urls);
2583 //foreach ($urls[1] AS $id=>$url) {
2584 foreach ($ordered_urls as $url) {
2585 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2586 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2588 $display_url = $url["title"];
2590 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2591 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2593 if (strlen($display_url) > 26) {
2594 $display_url = substr($display_url, 0, 25)."…";
2598 //$start = strpos($text, $url, $offset);
2599 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2600 if (!($start === false)) {
2601 $entities["urls"][] = ["url" => $url["url"],
2602 "expanded_url" => $url["url"],
2603 "display_url" => $display_url,
2604 "indices" => [$start, $start+strlen($url["url"])]];
2605 $offset = $start + 1;
2609 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2610 $ordered_images = [];
2611 foreach ($images[1] as $image) {
2612 //$start = strpos($text, $url, $offset);
2613 $start = iconv_strpos($text, $image, 0, "UTF-8");
2614 if (!($start === false)) {
2615 $ordered_images[$start] = $image;
2618 //$entities["media"] = array();
2621 foreach ($ordered_images as $url) {
2622 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2623 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2625 if (strlen($display_url) > 26) {
2626 $display_url = substr($display_url, 0, 25)."…";
2629 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2630 if (!($start === false)) {
2631 $image = Image::getInfoFromURL($url);
2633 // If image cache is activated, then use the following sizes:
2634 // thumb (150), small (340), medium (600) and large (1024)
2635 if (!Config::get("system", "proxy_disabled")) {
2636 $media_url = proxy_url($url);
2639 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2640 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2642 if (($image[0] > 150) || ($image[1] > 150)) {
2643 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2644 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2647 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2648 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2650 if (($image[0] > 600) || ($image[1] > 600)) {
2651 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2652 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2656 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2659 $entities["media"][] = [
2661 "id_str" => (string)$start+1,
2662 "indices" => [$start, $start+strlen($url)],
2663 "media_url" => normalise_link($media_url),
2664 "media_url_https" => $media_url,
2666 "display_url" => $display_url,
2667 "expanded_url" => $url,
2671 $offset = $start + 1;
2680 * @param array $item
2681 * @param string $text
2685 function api_format_items_embeded_images($item, $text)
2687 $text = preg_replace_callback(
2688 '|data:image/([^;]+)[^=]+=*|m',
2689 function () use ($item) {
2690 return System::baseUrl() . '/display/' . $item['guid'];
2698 * @brief return <a href='url'>name</a> as array
2700 * @param string $txt text
2705 function api_contactlink_to_array($txt)
2708 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2709 if ($r && count($match)==3) {
2711 'name' => $match[2],
2725 * @brief return likes, dislikes and attend status for item
2727 * @param array $item array
2728 * @param string $type Return type (atom, rss, xml, json)
2731 * likes => int count,
2732 * dislikes => int count
2734 function api_format_items_activities(&$item, $type = "json")
2743 'attendmaybe' => [],
2746 $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri']];
2747 $ret = Item::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2749 while ($item = Item::fetch($ret)) {
2750 // not used as result should be structured like other user data
2751 //builtin_activity_puller($i, $activities);
2753 // get user data and add it to the array of the activity
2754 $user = api_get_user($a, $item['author-id']);
2755 switch ($item['verb']) {
2757 $activities['like'][] = $user;
2759 case ACTIVITY_DISLIKE:
2760 $activities['dislike'][] = $user;
2762 case ACTIVITY_ATTEND:
2763 $activities['attendyes'][] = $user;
2765 case ACTIVITY_ATTENDNO:
2766 $activities['attendno'][] = $user;
2768 case ACTIVITY_ATTENDMAYBE:
2769 $activities['attendmaybe'][] = $user;
2778 if ($type == "xml") {
2779 $xml_activities = [];
2780 foreach ($activities as $k => $v) {
2781 // change xml element from "like" to "friendica:like"
2782 $xml_activities["friendica:".$k] = $v;
2783 // add user data into xml output
2785 foreach ($v as $user) {
2786 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2789 $activities = $xml_activities;
2797 * @brief return data from profiles
2799 * @param array $profile_row array containing data from db table 'profile'
2802 function api_format_items_profiles($profile_row)
2805 'profile_id' => $profile_row['id'],
2806 'profile_name' => $profile_row['profile-name'],
2807 'is_default' => $profile_row['is-default'] ? true : false,
2808 'hide_friends' => $profile_row['hide-friends'] ? true : false,
2809 'profile_photo' => $profile_row['photo'],
2810 'profile_thumb' => $profile_row['thumb'],
2811 'publish' => $profile_row['publish'] ? true : false,
2812 'net_publish' => $profile_row['net-publish'] ? true : false,
2813 'description' => $profile_row['pdesc'],
2814 'date_of_birth' => $profile_row['dob'],
2815 'address' => $profile_row['address'],
2816 'city' => $profile_row['locality'],
2817 'region' => $profile_row['region'],
2818 'postal_code' => $profile_row['postal-code'],
2819 'country' => $profile_row['country-name'],
2820 'hometown' => $profile_row['hometown'],
2821 'gender' => $profile_row['gender'],
2822 'marital' => $profile_row['marital'],
2823 'marital_with' => $profile_row['with'],
2824 'marital_since' => $profile_row['howlong'],
2825 'sexual' => $profile_row['sexual'],
2826 'politic' => $profile_row['politic'],
2827 'religion' => $profile_row['religion'],
2828 'public_keywords' => $profile_row['pub_keywords'],
2829 'private_keywords' => $profile_row['prv_keywords'],
2830 'likes' => BBCode::convert(api_clean_plain_items($profile_row['likes']) , false, 2),
2831 'dislikes' => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
2832 'about' => BBCode::convert(api_clean_plain_items($profile_row['about']) , false, 2),
2833 'music' => BBCode::convert(api_clean_plain_items($profile_row['music']) , false, 2),
2834 'book' => BBCode::convert(api_clean_plain_items($profile_row['book']) , false, 2),
2835 'tv' => BBCode::convert(api_clean_plain_items($profile_row['tv']) , false, 2),
2836 'film' => BBCode::convert(api_clean_plain_items($profile_row['film']) , false, 2),
2837 'interest' => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
2838 'romance' => BBCode::convert(api_clean_plain_items($profile_row['romance']) , false, 2),
2839 'work' => BBCode::convert(api_clean_plain_items($profile_row['work']) , false, 2),
2840 'education' => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
2841 'social_networks' => BBCode::convert(api_clean_plain_items($profile_row['contact']) , false, 2),
2842 'homepage' => $profile_row['homepage'],
2849 * @brief format items to be returned by api
2851 * @param array $r array of items
2852 * @param array $user_info
2853 * @param bool $filter_user filter items by $user_info
2854 * @param string $type Return type (atom, rss, xml, json)
2856 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
2862 foreach ($r as $item) {
2863 localize_item($item);
2864 list($status_user, $owner_user) = api_item_get_user($a, $item);
2866 // Look if the posts are matching if they should be filtered by user id
2867 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2871 $in_reply_to = api_in_reply_to($item);
2873 $converted = api_convert_item($item);
2875 if ($type == "xml") {
2876 $geo = "georss:point";
2882 'text' => $converted["text"],
2883 'truncated' => false,
2884 'created_at'=> api_date($item['created']),
2885 'in_reply_to_status_id' => $in_reply_to['status_id'],
2886 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
2887 'source' => (($item['app']) ? $item['app'] : 'web'),
2888 'id' => intval($item['id']),
2889 'id_str' => (string) intval($item['id']),
2890 'in_reply_to_user_id' => $in_reply_to['user_id'],
2891 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
2892 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
2894 'favorited' => $item['starred'] ? true : false,
2895 'user' => $status_user ,
2896 'friendica_owner' => $owner_user,
2897 //'entities' => NULL,
2898 'statusnet_html' => $converted["html"],
2899 'statusnet_conversation_id' => $item['parent'],
2900 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
2901 'friendica_activities' => api_format_items_activities($item, $type),
2904 if (count($converted["attachments"]) > 0) {
2905 $status["attachments"] = $converted["attachments"];
2908 if (count($converted["entities"]) > 0) {
2909 $status["entities"] = $converted["entities"];
2912 if ($status["source"] == 'web') {
2913 $status["source"] = ContactSelector::networkToName($item['network'], $user_info['url']);
2914 } elseif (ContactSelector::networkToName($item['network'], $user_info['url']) != $status["source"]) {
2915 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $user_info['url']).')');
2918 if ($item["id"] == $item["parent"]) {
2919 $retweeted_item = api_share_as_retweet($item);
2920 if ($retweeted_item !== false) {
2921 $retweeted_status = $status;
2923 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
2924 } catch (BadRequestException $e) {
2925 // user not found. should be found?
2926 /// @todo check if the user should be always found
2927 $retweeted_status["user"] = [];
2930 $rt_converted = api_convert_item($retweeted_item);
2932 $retweeted_status['text'] = $rt_converted["text"];
2933 $retweeted_status['statusnet_html'] = $rt_converted["html"];
2934 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
2935 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
2936 $status['retweeted_status'] = $retweeted_status;
2940 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2941 unset($status["user"]["uid"]);
2942 unset($status["user"]["self"]);
2944 if ($item["coord"] != "") {
2945 $coords = explode(' ', $item["coord"]);
2946 if (count($coords) == 2) {
2947 if ($type == "json") {
2948 $status["geo"] = ['type' => 'Point',
2949 'coordinates' => [(float) $coords[0],
2950 (float) $coords[1]]];
2951 } else {// Not sure if this is the official format - if someone founds a documentation we can check
2952 $status["georss:point"] = $item["coord"];
2962 * Returns the remaining number of API requests available to the user before the API limit is reached.
2964 * @param string $type Return type (atom, rss, xml, json)
2966 * @return array|string
2968 function api_account_rate_limit_status($type)
2970 if ($type == "xml") {
2972 'remaining-hits' => '150',
2973 '@attributes' => ["type" => "integer"],
2974 'hourly-limit' => '150',
2975 '@attributes2' => ["type" => "integer"],
2976 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
2977 '@attributes3' => ["type" => "datetime"],
2978 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2979 '@attributes4' => ["type" => "integer"],
2983 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2984 'remaining_hits' => '150',
2985 'hourly_limit' => '150',
2986 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
2990 return api_format_data('hash', $type, ['hash' => $hash]);
2993 /// @TODO move to top of file or somewhere better
2994 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
2997 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
2999 * @param string $type Return type (atom, rss, xml, json)
3001 * @return array|string
3003 function api_help_test($type)
3005 if ($type == 'xml') {
3011 return api_format_data('ok', $type, ["ok" => $ok]);
3014 /// @TODO move to top of file or somewhere better
3015 api_register_func('api/help/test', 'api_help_test', false);
3018 * Returns all lists the user subscribes to.
3020 * @param string $type Return type (atom, rss, xml, json)
3022 * @return array|string
3023 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3025 function api_lists_list($type)
3028 /// @TODO $ret is not filled here?
3029 return api_format_data('lists', $type, ["lists_list" => $ret]);
3032 /// @TODO move to top of file or somewhere better
3033 api_register_func('api/lists/list', 'api_lists_list', true);
3034 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3037 * Returns all groups the user owns.
3039 * @param string $type Return type (atom, rss, xml, json)
3041 * @return array|string
3042 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3044 function api_lists_ownerships($type)
3048 if (api_user() === false) {
3049 throw new ForbiddenException();
3053 $user_info = api_get_user($a);
3054 $uid = $user_info['uid'];
3056 $groups = dba::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3058 // loop through all groups
3060 foreach ($groups as $group) {
3061 if ($group['visible']) {
3067 'name' => $group['name'],
3068 'id' => intval($group['id']),
3069 'id_str' => (string) $group['id'],
3070 'user' => $user_info,
3074 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3077 /// @TODO move to top of file or somewhere better
3078 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3081 * Returns recent statuses from users in the specified group.
3083 * @param string $type Return type (atom, rss, xml, json)
3085 * @return array|string
3086 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3088 function api_lists_statuses($type)
3092 $user_info = api_get_user($a);
3093 if (api_user() === false || $user_info === false) {
3094 throw new ForbiddenException();
3097 unset($_REQUEST["user_id"]);
3098 unset($_GET["user_id"]);
3100 unset($_REQUEST["screen_name"]);
3101 unset($_GET["screen_name"]);
3103 if (empty($_REQUEST['list_id'])) {
3104 throw new BadRequestException('list_id not specified');
3108 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
3109 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
3113 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3114 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3115 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
3116 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
3118 $start = $page * $count;
3120 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3121 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3124 $condition[0] .= " AND `item`.`id` <= ?";
3125 $condition[] = $max_id;
3127 if ($exclude_replies > 0) {
3128 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
3130 if ($conversation_id > 0) {
3131 $condition[0] .= " AND `item`.`parent` = ?";
3132 $condition[] = $conversation_id;
3135 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3136 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3138 $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3140 $data = ['status' => $items];
3144 $data = api_rss_extra($a, $data, $user_info);
3148 return api_format_data("statuses", $type, $data);
3151 /// @TODO move to top of file or somewhere better
3152 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3155 * Considers friends and followers lists to be private and won't return
3156 * anything if any user_id parameter is passed.
3158 * @brief Returns either the friends of the follower list
3160 * @param string $qtype Either "friends" or "followers"
3161 * @return boolean|array
3162 * @throws ForbiddenException
3164 function api_statuses_f($qtype)
3168 if (api_user() === false) {
3169 throw new ForbiddenException();
3173 $count = x($_GET, 'count') ? $_GET['count'] : 20;
3174 $page = x($_GET, 'page') ? $_GET['page'] : 1;
3178 $start = ($page - 1) * $count;
3180 $user_info = api_get_user($a);
3182 if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3183 /* this is to stop Hotot to load friends multiple times
3184 * I'm not sure if I'm missing return something or
3185 * is a bug in hotot. Workaround, meantime
3189 return array('$users' => $ret);*/
3194 if ($qtype == 'friends') {
3195 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_SHARING), intval(CONTACT_IS_FRIEND));
3196 } elseif ($qtype == 'followers') {
3197 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_FOLLOWER), intval(CONTACT_IS_FRIEND));
3200 // friends and followers only for self
3201 if ($user_info['self'] == 0) {
3202 $sql_extra = " AND false ";
3205 if ($qtype == 'blocks') {
3206 $sql_filter = 'AND `blocked` AND NOT `pending`';
3207 } elseif ($qtype == 'incoming') {
3208 $sql_filter = 'AND `pending`';
3210 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3228 foreach ($r as $cid) {
3229 $user = api_get_user($a, $cid['nurl']);
3230 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3231 unset($user["uid"]);
3232 unset($user["self"]);
3239 return ['user' => $ret];
3244 * Returns the user's friends.
3246 * @brief Returns the list of friends of the provided user
3248 * @deprecated By Twitter API in favor of friends/list
3250 * @param string $type Either "json" or "xml"
3251 * @return boolean|string|array
3253 function api_statuses_friends($type)
3255 $data = api_statuses_f("friends");
3256 if ($data === false) {
3259 return api_format_data("users", $type, $data);
3263 * Returns the user's followers.
3265 * @brief Returns the list of followers of the provided user
3267 * @deprecated By Twitter API in favor of friends/list
3269 * @param string $type Either "json" or "xml"
3270 * @return boolean|string|array
3272 function api_statuses_followers($type)
3274 $data = api_statuses_f("followers");
3275 if ($data === false) {
3278 return api_format_data("users", $type, $data);
3281 /// @TODO move to top of file or somewhere better
3282 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3283 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3286 * Returns the list of blocked users
3288 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3290 * @param string $type Either "json" or "xml"
3292 * @return boolean|string|array
3294 function api_blocks_list($type)
3296 $data = api_statuses_f('blocks');
3297 if ($data === false) {
3300 return api_format_data("users", $type, $data);
3303 /// @TODO move to top of file or somewhere better
3304 api_register_func('api/blocks/list', 'api_blocks_list', true);
3307 * Returns the list of pending users IDs
3309 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3311 * @param string $type Either "json" or "xml"
3313 * @return boolean|string|array
3315 function api_friendships_incoming($type)
3317 $data = api_statuses_f('incoming');
3318 if ($data === false) {
3323 foreach ($data['user'] as $user) {
3324 $ids[] = $user['id'];
3327 return api_format_data("ids", $type, ['id' => $ids]);
3330 /// @TODO move to top of file or somewhere better
3331 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3334 * Returns the instance's configuration information.
3336 * @param string $type Return type (atom, rss, xml, json)
3338 * @return array|string
3340 function api_statusnet_config($type)
3344 $name = Config::get('config', 'sitename');
3345 $server = $a->get_hostname();
3346 $logo = System::baseUrl() . '/images/friendica-64.png';
3347 $email = Config::get('config', 'admin_email');
3348 $closed = intval(Config::get('config', 'register_policy')) === REGISTER_CLOSED ? 'true' : 'false';
3349 $private = Config::get('system', 'block_public') ? 'true' : 'false';
3350 $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000));
3351 $ssl = Config::get('system', 'have_ssl') ? 'true' : 'false';
3352 $sslserver = Config::get('system', 'have_ssl') ? str_replace('http:', 'https:', System::baseUrl()) : '';
3355 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3356 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3357 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3358 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3359 'shorturllength' => '30',
3361 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3362 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3363 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3364 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3369 return api_format_data('config', $type, ['config' => $config]);
3372 /// @TODO move to top of file or somewhere better
3373 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3374 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3378 * @param string $type Return type (atom, rss, xml, json)
3380 * @return array|string
3382 function api_statusnet_version($type)
3385 $fake_statusnet_version = "0.9.7";
3387 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3390 /// @TODO move to top of file or somewhere better
3391 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3392 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3396 * @param string $type Return type (atom, rss, xml, json)
3398 * @todo use api_format_data() to return data
3400 function api_ff_ids($type)
3403 throw new ForbiddenException();
3410 $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3413 "SELECT `pcontact`.`id` FROM `contact`
3414 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3415 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3418 if (!DBM::is_result($r)) {
3423 foreach ($r as $rr) {
3424 if ($stringify_ids) {
3427 $ids[] = intval($rr['id']);
3431 return api_format_data("ids", $type, ['id' => $ids]);
3435 * Returns the ID of every user the user is following.
3437 * @param string $type Return type (atom, rss, xml, json)
3439 * @return array|string
3440 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3442 function api_friends_ids($type)
3444 return api_ff_ids($type);
3448 * Returns the ID of every user following the user.
3450 * @param string $type Return type (atom, rss, xml, json)
3452 * @return array|string
3453 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3455 function api_followers_ids($type)
3457 return api_ff_ids($type);
3460 /// @TODO move to top of file or somewhere better
3461 api_register_func('api/friends/ids', 'api_friends_ids', true);
3462 api_register_func('api/followers/ids', 'api_followers_ids', true);
3465 * Sends a new direct message.
3467 * @param string $type Return type (atom, rss, xml, json)
3469 * @return array|string
3470 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3472 function api_direct_messages_new($type)
3476 if (api_user() === false) {
3477 throw new ForbiddenException();
3480 if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3484 $sender = api_get_user($a);
3487 if (!empty($_POST['screen_name'])) {
3489 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3491 dbesc($_POST['screen_name'])
3494 if (DBM::is_result($r)) {
3495 // Selecting the id by priority, friendica first
3496 api_best_nickname($r);
3498 $recipient = api_get_user($a, $r[0]['nurl']);
3501 $recipient = api_get_user($a, $_POST['user_id']);
3504 if (empty($recipient)) {
3505 throw new NotFoundException('Recipient not found');
3510 if (x($_REQUEST, 'replyto')) {
3512 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3514 intval($_REQUEST['replyto'])
3516 $replyto = $r[0]['parent-uri'];
3517 $sub = $r[0]['title'];
3519 if (x($_REQUEST, 'title')) {
3520 $sub = $_REQUEST['title'];
3522 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3526 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3529 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3530 $ret = api_format_messages($r[0], $recipient, $sender);
3532 $ret = ["error"=>$id];
3535 $data = ['direct_message'=>$ret];
3540 $data = api_rss_extra($a, $data, $sender);
3543 return api_format_data("direct-messages", $type, $data);
3546 /// @TODO move to top of file or somewhere better
3547 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3550 * Destroys a direct message.
3552 * @brief delete a direct_message from mail table through api
3554 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3555 * @return string|array
3556 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3558 function api_direct_messages_destroy($type)
3562 if (api_user() === false) {
3563 throw new ForbiddenException();
3567 $user_info = api_get_user($a);
3569 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3571 $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3572 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3573 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3575 $uid = $user_info['uid'];
3576 // error if no id or parenturi specified (for clients posting parent-uri as well)
3577 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3578 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3579 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3582 // BadRequestException if no id specified (for clients using Twitter API)
3584 throw new BadRequestException('Message id not specified');
3587 // add parent-uri to sql command if specified by calling app
3588 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . dbesc($parenturi) . "'" : "");
3590 // get data of the specified message id
3592 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3597 // error message if specified id is not in database
3598 if (!DBM::is_result($r)) {
3599 if ($verbose == "true") {
3600 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3601 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3603 /// @todo BadRequestException ok for Twitter API clients?
3604 throw new BadRequestException('message id not in database');
3609 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3614 if ($verbose == "true") {
3617 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3618 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3620 $answer = ['result' => 'error', 'message' => 'unknown error'];
3621 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3624 /// @todo return JSON data like Twitter API not yet implemented
3627 /// @TODO move to top of file or somewhere better
3628 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3632 * @param string $type Return type (atom, rss, xml, json)
3633 * @param string $box
3634 * @param string $verbose
3636 * @return array|string
3638 function api_direct_messages_box($type, $box, $verbose)
3641 if (api_user() === false) {
3642 throw new ForbiddenException();
3645 $count = defaults($_GET, 'count', 20);
3646 $page = defaults($_REQUEST, 'page', 1) - 1;
3651 $since_id = defaults($_REQUEST, 'since_id', 0);
3652 $max_id = defaults($_REQUEST, 'max_id', 0);
3654 $user_id = defaults($_REQUEST, 'user_id', '');
3655 $screen_name = defaults($_REQUEST, 'screen_name', '');
3658 unset($_REQUEST["user_id"]);
3659 unset($_GET["user_id"]);
3661 unset($_REQUEST["screen_name"]);
3662 unset($_GET["screen_name"]);
3664 $user_info = api_get_user($a);
3665 if ($user_info === false) {
3666 throw new ForbiddenException();
3668 $profile_url = $user_info["url"];
3671 $start = $page * $count;
3676 if ($box=="sentbox") {
3677 $sql_extra = "`mail`.`from-url`='" . dbesc($profile_url) . "'";
3678 } elseif ($box == "conversation") {
3679 $sql_extra = "`mail`.`parent-uri`='" . dbesc(defaults($_GET, 'uri', '')) . "'";
3680 } elseif ($box == "all") {
3681 $sql_extra = "true";
3682 } elseif ($box == "inbox") {
3683 $sql_extra = "`mail`.`from-url`!='" . dbesc($profile_url) . "'";
3687 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3690 if ($user_id != "") {
3691 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3692 } elseif ($screen_name !="") {
3693 $sql_extra .= " AND `contact`.`nick` = '" . dbesc($screen_name). "'";
3697 "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",
3703 if ($verbose == "true" && !DBM::is_result($r)) {
3704 $answer = ['result' => 'error', 'message' => 'no mails available'];
3705 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3709 foreach ($r as $item) {
3710 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3711 $recipient = $user_info;
3712 $sender = api_get_user($a, normalise_link($item['contact-url']));
3713 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3714 $recipient = api_get_user($a, normalise_link($item['contact-url']));
3715 $sender = $user_info;
3718 if (isset($recipient) && isset($sender)) {
3719 $ret[] = api_format_messages($item, $recipient, $sender);
3724 $data = ['direct_message' => $ret];
3728 $data = api_rss_extra($a, $data, $user_info);
3731 return api_format_data("direct-messages", $type, $data);
3735 * Returns the most recent direct messages sent by the user.
3737 * @param string $type Return type (atom, rss, xml, json)
3739 * @return array|string
3740 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3742 function api_direct_messages_sentbox($type)
3744 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3745 return api_direct_messages_box($type, "sentbox", $verbose);
3749 * Returns the most recent direct messages sent to the user.
3751 * @param string $type Return type (atom, rss, xml, json)
3753 * @return array|string
3754 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3756 function api_direct_messages_inbox($type)
3758 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3759 return api_direct_messages_box($type, "inbox", $verbose);
3764 * @param string $type Return type (atom, rss, xml, json)
3766 * @return array|string
3768 function api_direct_messages_all($type)
3770 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3771 return api_direct_messages_box($type, "all", $verbose);
3776 * @param string $type Return type (atom, rss, xml, json)
3778 * @return array|string
3780 function api_direct_messages_conversation($type)
3782 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3783 return api_direct_messages_box($type, "conversation", $verbose);
3786 /// @TODO move to top of file or somewhere better
3787 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3788 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3789 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3790 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3793 * Returns an OAuth Request Token.
3795 * @see https://oauth.net/core/1.0/#auth_step1
3797 function api_oauth_request_token()
3799 $oauth1 = new FKOAuth1();
3801 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
3802 } catch (Exception $e) {
3803 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
3811 * Returns an OAuth Access Token.
3813 * @return array|string
3814 * @see https://oauth.net/core/1.0/#auth_step3
3816 function api_oauth_access_token()
3818 $oauth1 = new FKOAuth1();
3820 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
3821 } catch (Exception $e) {
3822 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
3829 /// @TODO move to top of file or somewhere better
3830 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
3831 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
3835 * @brief delete a complete photoalbum with all containing photos from database through api
3837 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3838 * @return string|array
3840 function api_fr_photoalbum_delete($type)
3842 if (api_user() === false) {
3843 throw new ForbiddenException();
3846 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3848 // we do not allow calls without album string
3850 throw new BadRequestException("no albumname specified");
3852 // check if album is existing
3854 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3858 if (!DBM::is_result($r)) {
3859 throw new BadRequestException("album not available");
3862 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
3863 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
3864 foreach ($r as $rr) {
3865 $condition = ['uid' => local_user(), 'resource-id' => $rr['resource-id'], 'type' => 'photo'];
3866 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
3868 if (!DBM::is_result($photo_item)) {
3869 throw new InternalServerErrorException("problem with deleting items occured");
3871 Item::deleteForUser(['id' => $photo_item['id']], api_user());
3874 // now let's delete all photos from the album
3875 $result = dba::delete('photo', ['uid' => api_user(), 'album' => $album]);
3877 // return success of deletion or error message
3879 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
3880 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
3882 throw new InternalServerErrorException("unknown error - deleting from database failed");
3887 * @brief update the name of the album for all photos of an album
3889 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3890 * @return string|array
3892 function api_fr_photoalbum_update($type)
3894 if (api_user() === false) {
3895 throw new ForbiddenException();
3898 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3899 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
3901 // we do not allow calls without album string
3903 throw new BadRequestException("no albumname specified");
3905 if ($album_new == "") {
3906 throw new BadRequestException("no new albumname specified");
3908 // check if album is existing
3909 if (!dba::exists('photo', ['uid' => api_user(), 'album' => $album])) {
3910 throw new BadRequestException("album not available");
3912 // now let's update all photos to the albumname
3913 $result = dba::update('photo', ['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
3915 // return success of updating or error message
3917 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
3918 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
3920 throw new InternalServerErrorException("unknown error - updating in database failed");
3926 * @brief list all photos of the authenticated user
3928 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3929 * @return string|array
3931 function api_fr_photos_list($type)
3933 if (api_user() === false) {
3934 throw new ForbiddenException();
3937 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
3938 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
3939 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
3940 intval(local_user())
3943 'image/jpeg' => 'jpg',
3944 'image/png' => 'png',
3945 'image/gif' => 'gif'
3947 $data = ['photo'=>[]];
3948 if (DBM::is_result($r)) {
3949 foreach ($r as $rr) {
3951 $photo['id'] = $rr['resource-id'];
3952 $photo['album'] = $rr['album'];
3953 $photo['filename'] = $rr['filename'];
3954 $photo['type'] = $rr['type'];
3955 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
3956 $photo['created'] = $rr['created'];
3957 $photo['edited'] = $rr['edited'];
3958 $photo['desc'] = $rr['desc'];
3960 if ($type == "xml") {
3961 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
3963 $photo['thumb'] = $thumb;
3964 $data['photo'][] = $photo;
3968 return api_format_data("photos", $type, $data);
3972 * @brief upload a new photo or change an existing photo
3974 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3975 * @return string|array
3977 function api_fr_photo_create_update($type)
3979 if (api_user() === false) {
3980 throw new ForbiddenException();
3983 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
3984 $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
3985 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
3986 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
3987 $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
3988 $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
3989 $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
3990 $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
3991 $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
3993 // do several checks on input parameters
3994 // we do not allow calls without album string
3995 if ($album == null) {
3996 throw new BadRequestException("no albumname specified");
3998 // if photo_id == null --> we are uploading a new photo
3999 if ($photo_id == null) {
4002 // error if no media posted in create-mode
4003 if (!x($_FILES, 'media')) {
4005 throw new BadRequestException("no media data submitted");
4008 // album_new will be ignored in create-mode
4013 // check if photo is existing in database
4015 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4020 if (!DBM::is_result($r)) {
4021 throw new BadRequestException("photo not available");
4025 // checks on acl strings provided by clients
4026 $acl_input_error = false;
4027 $acl_input_error |= check_acl_input($allow_cid);
4028 $acl_input_error |= check_acl_input($deny_cid);
4029 $acl_input_error |= check_acl_input($allow_gid);
4030 $acl_input_error |= check_acl_input($deny_gid);
4031 if ($acl_input_error) {
4032 throw new BadRequestException("acl data invalid");
4034 // now let's upload the new media in create-mode
4035 if ($mode == "create") {
4036 $media = $_FILES['media'];
4037 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4039 // return success of updating or error message
4040 if (!is_null($data)) {
4041 return api_format_data("photo_create", $type, $data);
4043 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4047 // now let's do the changes in update-mode
4048 if ($mode == "update") {
4051 if (!is_null($desc)) {
4052 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
4055 if (!is_null($album_new)) {
4056 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
4059 if (!is_null($allow_cid)) {
4060 $allow_cid = trim($allow_cid);
4061 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
4064 if (!is_null($deny_cid)) {
4065 $deny_cid = trim($deny_cid);
4066 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
4069 if (!is_null($allow_gid)) {
4070 $allow_gid = trim($allow_gid);
4071 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
4074 if (!is_null($deny_gid)) {
4075 $deny_gid = trim($deny_gid);
4076 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
4080 if ($sql_extra != "") {
4081 $nothingtodo = false;
4083 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4085 DateTimeFormat::utcNow(), // update edited timestamp
4091 $nothingtodo = true;
4094 if (x($_FILES, 'media')) {
4095 $nothingtodo = false;
4096 $media = $_FILES['media'];
4097 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4098 if (!is_null($data)) {
4099 return api_format_data("photo_update", $type, $data);
4103 // return success of updating or error message
4105 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4106 return api_format_data("photo_update", $type, ['$result' => $answer]);
4109 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4110 return api_format_data("photo_update", $type, ['$result' => $answer]);
4112 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4115 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4119 * @brief delete a single photo from the database through api
4121 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4122 * @return string|array
4124 function api_fr_photo_delete($type)
4126 if (api_user() === false) {
4127 throw new ForbiddenException();
4130 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4132 // do several checks on input parameters
4133 // we do not allow calls without photo id
4134 if ($photo_id == null) {
4135 throw new BadRequestException("no photo_id specified");
4137 // check if photo is existing in database
4139 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4143 if (!DBM::is_result($r)) {
4144 throw new BadRequestException("photo not available");
4146 // now we can perform on the deletion of the photo
4147 $result = dba::delete('photo', ['uid' => api_user(), 'resource-id' => $photo_id]);
4149 // return success of deletion or error message
4151 // retrieve the id of the parent element (the photo element)
4152 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4153 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4155 if (!DBM::is_result($photo_item)) {
4156 throw new InternalServerErrorException("problem with deleting items occured");
4158 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4159 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4160 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4162 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4163 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4165 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4171 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4173 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4174 * @return string|array
4176 function api_fr_photo_detail($type)
4178 if (api_user() === false) {
4179 throw new ForbiddenException();
4181 if (!x($_REQUEST, 'photo_id')) {
4182 throw new BadRequestException("No photo id.");
4185 $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4186 $photo_id = $_REQUEST['photo_id'];
4188 // prepare json/xml output with data from database for the requested photo
4189 $data = prepare_photo_data($type, $scale, $photo_id);
4191 return api_format_data("photo_detail", $type, $data);
4196 * Updates the user’s profile image.
4198 * @brief updates the profile image for the user (either a specified profile or the default profile)
4200 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4202 * @return string|array
4203 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4205 function api_account_update_profile_image($type)
4207 if (api_user() === false) {
4208 throw new ForbiddenException();
4211 $profile_id = defaults($_REQUEST, 'profile_id', 0);
4213 // error if image data is missing
4214 if (!x($_FILES, 'image')) {
4215 throw new BadRequestException("no media data submitted");
4218 // check if specified profile id is valid
4219 if ($profile_id != 0) {
4220 $profile = dba::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4221 // error message if specified profile id is not in database
4222 if (!DBM::is_result($profile)) {
4223 throw new BadRequestException("profile_id not available");
4225 $is_default_profile = $profile['is-default'];
4227 $is_default_profile = 1;
4230 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4232 if (x($_FILES, 'image')) {
4233 $media = $_FILES['image'];
4234 } elseif (x($_FILES, 'media')) {
4235 $media = $_FILES['media'];
4237 // save new profile image
4238 $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4241 if (is_array($media['type'])) {
4242 $filetype = $media['type'][0];
4244 $filetype = $media['type'];
4246 if ($filetype == "image/jpeg") {
4248 } elseif ($filetype == "image/png") {
4251 throw new InternalServerErrorException('Unsupported filetype');
4254 // change specified profile or all profiles to the new resource-id
4255 if ($is_default_profile) {
4256 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4257 dba::update('photo', ['profile' => false], $condition);
4259 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype,
4260 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype];
4261 dba::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4264 Contact::updateSelfFromUserID(api_user(), true);
4266 // Update global directory in background
4267 $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4268 if ($url && strlen(Config::get('system', 'directory'))) {
4269 Worker::add(PRIORITY_LOW, "Directory", $url);
4272 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4274 // output for client
4276 return api_account_verify_credentials($type);
4278 // SaveMediaToDatabase failed for some reason
4279 throw new InternalServerErrorException("image upload failed");
4283 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4284 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4285 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4286 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4287 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4288 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4289 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4290 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4291 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4294 * Update user profile
4296 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4298 * @return array|string
4300 function api_account_update_profile($type)
4302 $local_user = api_user();
4303 $api_user = api_get_user(get_app());
4305 if (!empty($_POST['name'])) {
4306 dba::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4307 dba::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4308 dba::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4309 dba::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4312 if (isset($_POST['description'])) {
4313 dba::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4314 dba::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4315 dba::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4318 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4319 // Update global directory in background
4320 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4321 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4324 return api_account_verify_credentials($type);
4327 /// @TODO move to top of file or somewhere better
4328 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4332 * @param string $acl_string
4334 function check_acl_input($acl_string)
4336 if ($acl_string == null || $acl_string == " ") {
4339 $contact_not_found = false;
4341 // split <x><y><z> into array of cid's
4342 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4344 // check for each cid if it is available on server
4345 $cid_array = $array[0];
4346 foreach ($cid_array as $cid) {
4347 $cid = str_replace("<", "", $cid);
4348 $cid = str_replace(">", "", $cid);
4350 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
4354 $contact_not_found |= !DBM::is_result($contact);
4356 return $contact_not_found;
4361 * @param string $mediatype
4362 * @param array $media
4363 * @param string $type
4364 * @param string $album
4365 * @param string $allow_cid
4366 * @param string $deny_cid
4367 * @param string $allow_gid
4368 * @param string $deny_gid
4369 * @param string $desc
4370 * @param integer $profile
4371 * @param boolean $visibility
4372 * @param string $photo_id
4374 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)
4382 if (is_array($media)) {
4383 if (is_array($media['tmp_name'])) {
4384 $src = $media['tmp_name'][0];
4386 $src = $media['tmp_name'];
4388 if (is_array($media['name'])) {
4389 $filename = basename($media['name'][0]);
4391 $filename = basename($media['name']);
4393 if (is_array($media['size'])) {
4394 $filesize = intval($media['size'][0]);
4396 $filesize = intval($media['size']);
4398 if (is_array($media['type'])) {
4399 $filetype = $media['type'][0];
4401 $filetype = $media['type'];
4405 if ($filetype == "") {
4406 $filetype=Image::guessType($filename);
4408 $imagedata = getimagesize($src);
4410 $filetype = $imagedata['mime'];
4413 "File upload src: " . $src . " - filename: " . $filename .
4414 " - size: " . $filesize . " - type: " . $filetype,
4418 // check if there was a php upload error
4419 if ($filesize == 0 && $media['error'] == 1) {
4420 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4422 // check against max upload size within Friendica instance
4423 $maximagesize = Config::get('system', 'maximagesize');
4424 if ($maximagesize && ($filesize > $maximagesize)) {
4425 $formattedBytes = formatBytes($maximagesize);
4426 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4429 // create Photo instance with the data of the image
4430 $imagedata = @file_get_contents($src);
4431 $Image = new Image($imagedata, $filetype);
4432 if (! $Image->isValid()) {
4433 throw new InternalServerErrorException("unable to process image data");
4436 // check orientation of image
4437 $Image->orient($src);
4440 // check max length of images on server
4441 $max_length = Config::get('system', 'max_image_length');
4442 if (! $max_length) {
4443 $max_length = MAX_IMAGE_LENGTH;
4445 if ($max_length > 0) {
4446 $Image->scaleDown($max_length);
4447 logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG);
4449 $width = $Image->getWidth();
4450 $height = $Image->getHeight();
4452 // create a new resource-id if not already provided
4453 $hash = ($photo_id == null) ? Photo::newResource() : $photo_id;
4455 if ($mediatype == "photo") {
4456 // upload normal image (scales 0, 1, 2)
4457 logger("photo upload: starting new photo upload", LOGGER_DEBUG);
4459 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4461 logger("photo upload: image upload with scale 0 (original size) failed");
4463 if ($width > 640 || $height > 640) {
4464 $Image->scaleDown(640);
4465 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4467 logger("photo upload: image upload with scale 1 (640x640) failed");
4471 if ($width > 320 || $height > 320) {
4472 $Image->scaleDown(320);
4473 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4475 logger("photo upload: image upload with scale 2 (320x320) failed");
4478 logger("photo upload: new photo upload ended", LOGGER_DEBUG);
4479 } elseif ($mediatype == "profileimage") {
4480 // upload profile image (scales 4, 5, 6)
4481 logger("photo upload: starting new profile image upload", LOGGER_DEBUG);
4483 if ($width > 175 || $height > 175) {
4484 $Image->scaleDown(175);
4485 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4487 logger("photo upload: profile image upload with scale 4 (175x175) failed");
4491 if ($width > 80 || $height > 80) {
4492 $Image->scaleDown(80);
4493 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4495 logger("photo upload: profile image upload with scale 5 (80x80) failed");
4499 if ($width > 48 || $height > 48) {
4500 $Image->scaleDown(48);
4501 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4503 logger("photo upload: profile image upload with scale 6 (48x48) failed");
4506 $Image->__destruct();
4507 logger("photo upload: new profile image upload ended", LOGGER_DEBUG);
4510 if (isset($r) && $r) {
4511 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4512 if ($photo_id == null && $mediatype == "photo") {
4513 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4515 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4516 return prepare_photo_data($type, false, $hash);
4518 throw new InternalServerErrorException("image upload failed");
4524 * @param string $hash
4525 * @param string $allow_cid
4526 * @param string $deny_cid
4527 * @param string $allow_gid
4528 * @param string $deny_gid
4529 * @param string $filetype
4530 * @param boolean $visibility
4532 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4534 // get data about the api authenticated user
4535 $uri = Item::newURI(intval(api_user()));
4536 $owner_record = q("SELECT * FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
4539 $arr['guid'] = System::createGUID(32);
4540 $arr['uid'] = intval(api_user());
4542 $arr['parent-uri'] = $uri;
4543 $arr['type'] = 'photo';
4545 $arr['resource-id'] = $hash;
4546 $arr['contact-id'] = $owner_record[0]['id'];
4547 $arr['owner-name'] = $owner_record[0]['name'];
4548 $arr['owner-link'] = $owner_record[0]['url'];
4549 $arr['owner-avatar'] = $owner_record[0]['thumb'];
4550 $arr['author-name'] = $owner_record[0]['name'];
4551 $arr['author-link'] = $owner_record[0]['url'];
4552 $arr['author-avatar'] = $owner_record[0]['thumb'];
4554 $arr['allow_cid'] = $allow_cid;
4555 $arr['allow_gid'] = $allow_gid;
4556 $arr['deny_cid'] = $deny_cid;
4557 $arr['deny_gid'] = $deny_gid;
4558 $arr['visible'] = $visibility;
4562 'image/jpeg' => 'jpg',
4563 'image/png' => 'png',
4564 'image/gif' => 'gif'
4567 // adds link to the thumbnail scale photo
4568 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record[0]['nick'] . '/image/' . $hash . ']'
4569 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4572 // do the magic for storing the item in the database and trigger the federation to other contacts
4578 * @param string $type
4580 * @param string $photo_id
4584 function prepare_photo_data($type, $scale, $photo_id)
4587 $user_info = api_get_user($a);
4589 if ($user_info === false) {
4590 throw new ForbiddenException();
4593 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4594 $data_sql = ($scale === false ? "" : "data, ");
4596 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4597 // clients needs to convert this in their way for further processing
4599 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4600 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4601 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4602 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4604 intval(local_user()),
4610 'image/jpeg' => 'jpg',
4611 'image/png' => 'png',
4612 'image/gif' => 'gif'
4615 // prepare output data for photo
4616 if (DBM::is_result($r)) {
4617 $data = ['photo' => $r[0]];
4618 $data['photo']['id'] = $data['photo']['resource-id'];
4619 if ($scale !== false) {
4620 $data['photo']['data'] = base64_encode($data['photo']['data']);
4622 unset($data['photo']['datasize']); //needed only with scale param
4624 if ($type == "xml") {
4625 $data['photo']['links'] = [];
4626 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4627 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4629 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4632 $data['photo']['link'] = [];
4633 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4635 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4636 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4640 unset($data['photo']['resource-id']);
4641 unset($data['photo']['minscale']);
4642 unset($data['photo']['maxscale']);
4644 throw new NotFoundException();
4647 // retrieve item element for getting activities (like, dislike etc.) related to photo
4648 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4649 $item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4651 $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4653 // retrieve comments on photo
4654 $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
4655 $item[0]['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4657 $statuses = Item::selectForUser(api_user(), [], $condition);
4659 // prepare output of comments
4660 $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
4662 if ($type == "xml") {
4664 foreach ($commentData as $comment) {
4665 $comments[$k++ . ":comment"] = $comment;
4668 foreach ($commentData as $comment) {
4669 $comments[] = $comment;
4672 $data['photo']['friendica_comments'] = $comments;
4674 // include info if rights on photo and rights on item are mismatching
4675 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4676 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4677 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4678 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4679 $data['photo']['rights_mismatch'] = $rights_mismatch;
4686 * Similar as /mod/redir.php
4687 * redirect to 'url' after dfrn auth
4689 * Why this when there is mod/redir.php already?
4690 * This use api_user() and api_login()
4693 * c_url: url of remote contact to auth to
4694 * url: string, url to redirect after auth
4696 function api_friendica_remoteauth()
4698 $url = (x($_GET, 'url') ? $_GET['url'] : '');
4699 $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : '');
4701 if ($url === '' || $c_url === '') {
4702 throw new BadRequestException("Wrong parameters.");
4705 $c_url = normalise_link($c_url);
4709 $contact = dba::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4711 if (!DBM::is_result($contact) || ($contact['network'] !== NETWORK_DFRN)) {
4712 throw new BadRequestException("Unknown contact");
4715 $cid = $contact['id'];
4717 $dfrn_id = defaults($contact, 'issued-id', $contact['dfrn-id']);
4719 if ($contact['duplex'] && $contact['issued-id']) {
4720 $orig_id = $contact['issued-id'];
4721 $dfrn_id = '1:' . $orig_id;
4723 if ($contact['duplex'] && $contact['dfrn-id']) {
4724 $orig_id = $contact['dfrn-id'];
4725 $dfrn_id = '0:' . $orig_id;
4728 $sec = random_string();
4730 $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
4731 'sec' => $sec, 'expire' => time() + 45];
4732 dba::insert('profile_check', $fields);
4734 logger($contact['name'] . ' ' . $sec, LOGGER_DEBUG);
4735 $dest = ($url ? '&destination_url=' . $url : '');
4737 $contact['poll'] . '?dfrn_id=' . $dfrn_id
4738 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4739 . '&type=profile&sec=' . $sec . $dest
4742 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4745 * @brief Return the item shared, if the item contains only the [share] tag
4747 * @param array $item Sharer item
4748 * @return array|false Shared item or false if not a reshare
4750 function api_share_as_retweet(&$item)
4752 $body = trim($item["body"]);
4754 if (Diaspora::isReshare($body, false)===false) {
4758 /// @TODO "$1" should maybe mean '$1' ?
4759 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
4761 * Skip if there is no shared message in there
4762 * we already checked this in diaspora::isReshare()
4763 * but better one more than one less...
4765 if ($body == $attributes) {
4770 // build the fake reshared item
4771 $reshared_item = $item;
4774 preg_match("/author='(.*?)'/ism", $attributes, $matches);
4775 if ($matches[1] != "") {
4776 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
4779 preg_match('/author="(.*?)"/ism', $attributes, $matches);
4780 if ($matches[1] != "") {
4781 $author = $matches[1];
4785 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
4786 if ($matches[1] != "") {
4787 $profile = $matches[1];
4790 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
4791 if ($matches[1] != "") {
4792 $profile = $matches[1];
4796 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
4797 if ($matches[1] != "") {
4798 $avatar = $matches[1];
4801 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
4802 if ($matches[1] != "") {
4803 $avatar = $matches[1];
4807 preg_match("/link='(.*?)'/ism", $attributes, $matches);
4808 if ($matches[1] != "") {
4809 $link = $matches[1];
4812 preg_match('/link="(.*?)"/ism', $attributes, $matches);
4813 if ($matches[1] != "") {
4814 $link = $matches[1];
4818 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
4819 if ($matches[1] != "") {
4820 $posted = $matches[1];
4823 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
4824 if ($matches[1] != "") {
4825 $posted = $matches[1];
4828 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
4830 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
4834 $reshared_item["body"] = $shared_body;
4835 $reshared_item["author-name"] = $author;
4836 $reshared_item["author-link"] = $profile;
4837 $reshared_item["author-avatar"] = $avatar;
4838 $reshared_item["plink"] = $link;
4839 $reshared_item["created"] = $posted;
4840 $reshared_item["edited"] = $posted;
4842 return $reshared_item;
4847 * @param string $profile
4849 * @return string|false
4850 * @todo remove trailing junk from profile url
4851 * @todo pump.io check has to check the website
4853 function api_get_nick($profile)
4858 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4859 dbesc(normalise_link($profile))
4862 if (DBM::is_result($r)) {
4863 $nick = $r[0]["nick"];
4868 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4869 dbesc(normalise_link($profile))
4872 if (DBM::is_result($r)) {
4873 $nick = $r[0]["nick"];
4878 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
4879 if ($friendica != $profile) {
4885 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
4886 if ($diaspora != $profile) {
4892 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
4893 if ($twitter != $profile) {
4900 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
4901 if ($StatusnetHost != $profile) {
4902 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
4903 if ($StatusnetUser != $profile) {
4904 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
4905 $user = json_decode($UserData);
4907 $nick = $user->screen_name;
4913 // To-Do: look at the page if its really a pumpio site
4914 //if (!$nick == "") {
4915 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
4916 // if ($pumpio != $profile)
4918 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
4931 * @param array $item
4935 function api_in_reply_to($item)
4939 $in_reply_to['status_id'] = null;
4940 $in_reply_to['user_id'] = null;
4941 $in_reply_to['status_id_str'] = null;
4942 $in_reply_to['user_id_str'] = null;
4943 $in_reply_to['screen_name'] = null;
4945 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
4946 $parent = Item::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
4947 if (DBM::is_result($parent)) {
4948 $in_reply_to['status_id'] = intval($parent['id']);
4950 $in_reply_to['status_id'] = intval($item['parent']);
4953 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
4955 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
4956 $parent = Item::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
4958 if (DBM::is_result($parent)) {
4959 if ($parent['author-nick'] == "") {
4960 $parent['author-nick'] = api_get_nick($parent['author-link']);
4963 $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
4964 $in_reply_to['user_id'] = intval($parent['author-id']);
4965 $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
4968 // There seems to be situation, where both fields are identical:
4969 // https://github.com/friendica/friendica/issues/1010
4970 // This is a bugfix for that.
4971 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
4972 logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG);
4973 $in_reply_to['status_id'] = null;
4974 $in_reply_to['user_id'] = null;
4975 $in_reply_to['status_id_str'] = null;
4976 $in_reply_to['user_id_str'] = null;
4977 $in_reply_to['screen_name'] = null;
4981 return $in_reply_to;
4986 * @param string $text
4990 function api_clean_plain_items($text)
4992 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
4994 $text = BBCode::cleanPictureLinks($text);
4995 $URLSearchString = "^\[\]";
4997 $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
4999 if ($include_entities == "true") {
5000 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5003 // Simplify "attachment" element
5004 $text = api_clean_attachments($text);
5010 * @brief Removes most sharing information for API text export
5012 * @param string $body The original body
5014 * @return string Cleaned body
5016 function api_clean_attachments($body)
5018 $data = BBCode::getAttachmentData($body);
5025 if (isset($data["text"])) {
5026 $body = $data["text"];
5028 if (($body == "") && isset($data["title"])) {
5029 $body = $data["title"];
5031 if (isset($data["url"])) {
5032 $body .= "\n".$data["url"];
5034 $body .= $data["after"];
5041 * @param array $contacts
5045 function api_best_nickname(&$contacts)
5049 if (count($contacts) == 0) {
5053 foreach ($contacts as $contact) {
5054 if ($contact["network"] == "") {
5055 $contact["network"] = "dfrn";
5056 $best_contact = [$contact];
5060 if (sizeof($best_contact) == 0) {
5061 foreach ($contacts as $contact) {
5062 if ($contact["network"] == "dfrn") {
5063 $best_contact = [$contact];
5068 if (sizeof($best_contact) == 0) {
5069 foreach ($contacts as $contact) {
5070 if ($contact["network"] == "dspr") {
5071 $best_contact = [$contact];
5076 if (sizeof($best_contact) == 0) {
5077 foreach ($contacts as $contact) {
5078 if ($contact["network"] == "stat") {
5079 $best_contact = [$contact];
5084 if (sizeof($best_contact) == 0) {
5085 foreach ($contacts as $contact) {
5086 if ($contact["network"] == "pump") {
5087 $best_contact = [$contact];
5092 if (sizeof($best_contact) == 0) {
5093 foreach ($contacts as $contact) {
5094 if ($contact["network"] == "twit") {
5095 $best_contact = [$contact];
5100 if (sizeof($best_contact) == 1) {
5101 $contacts = $best_contact;
5103 $contacts = [$contacts[0]];
5108 * Return all or a specified group of the user with the containing contacts.
5110 * @param string $type Return type (atom, rss, xml, json)
5112 * @return array|string
5114 function api_friendica_group_show($type)
5118 if (api_user() === false) {
5119 throw new ForbiddenException();
5123 $user_info = api_get_user($a);
5124 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5125 $uid = $user_info['uid'];
5127 // get data of the specified group id or all groups if not specified
5130 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5134 // error message if specified gid is not in database
5135 if (!DBM::is_result($r)) {
5136 throw new BadRequestException("gid not available");
5140 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5145 // loop through all groups and retrieve all members for adding data in the user array
5147 foreach ($r as $rr) {
5148 $members = Contact::getByGroupId($rr['id']);
5151 if ($type == "xml") {
5152 $user_element = "users";
5154 foreach ($members as $member) {
5155 $user = api_get_user($a, $member['nurl']);
5156 $users[$k++.":user"] = $user;
5159 $user_element = "user";
5160 foreach ($members as $member) {
5161 $user = api_get_user($a, $member['nurl']);
5165 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5167 return api_format_data("groups", $type, ['group' => $grps]);
5169 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5173 * Delete the specified group of the user.
5175 * @param string $type Return type (atom, rss, xml, json)
5177 * @return array|string
5179 function api_friendica_group_delete($type)
5183 if (api_user() === false) {
5184 throw new ForbiddenException();
5188 $user_info = api_get_user($a);
5189 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5190 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5191 $uid = $user_info['uid'];
5193 // error if no gid specified
5194 if ($gid == 0 || $name == "") {
5195 throw new BadRequestException('gid or name not specified');
5198 // get data of the specified group id
5200 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5204 // error message if specified gid is not in database
5205 if (!DBM::is_result($r)) {
5206 throw new BadRequestException('gid not available');
5209 // get data of the specified group id and group name
5211 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5216 // error message if specified gid is not in database
5217 if (!DBM::is_result($rname)) {
5218 throw new BadRequestException('wrong group name');
5222 $ret = Group::removeByName($uid, $name);
5225 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5226 return api_format_data("group_delete", $type, ['result' => $success]);
5228 throw new BadRequestException('other API error');
5231 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5236 * @param string $type Return type (atom, rss, xml, json)
5238 * @return array|string
5239 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5241 function api_lists_destroy($type)
5245 if (api_user() === false) {
5246 throw new ForbiddenException();
5250 $user_info = api_get_user($a);
5251 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5252 $uid = $user_info['uid'];
5254 // error if no gid specified
5256 throw new BadRequestException('gid not specified');
5259 // get data of the specified group id
5260 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5261 // error message if specified gid is not in database
5263 throw new BadRequestException('gid not available');
5266 if (Group::remove($gid)) {
5268 'name' => $group['name'],
5269 'id' => intval($gid),
5270 'id_str' => (string) $gid,
5271 'user' => $user_info
5274 return api_format_data("lists", $type, ['lists' => $list]);
5277 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5280 * Add a new group to the database.
5282 * @param string $name Group name
5283 * @param int $uid User ID
5284 * @param array $users List of users to add to the group
5288 function group_create($name, $uid, $users = [])
5290 // error if no name specified
5292 throw new BadRequestException('group name not specified');
5295 // get data of the specified group name
5297 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5301 // error message if specified group name already exists
5302 if (DBM::is_result($rname)) {
5303 throw new BadRequestException('group name already exists');
5306 // check if specified group name is a deleted group
5308 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5312 // error message if specified group name already exists
5313 if (DBM::is_result($rname)) {
5314 $reactivate_group = true;
5318 $ret = Group::create($uid, $name);
5320 $gid = Group::getIdByName($uid, $name);
5322 throw new BadRequestException('other API error');
5326 $erroraddinguser = false;
5328 foreach ($users as $user) {
5329 $cid = $user['cid'];
5330 // check if user really exists as contact
5332 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5336 if (count($contact)) {
5337 Group::addMember($gid, $cid);
5339 $erroraddinguser = true;
5340 $errorusers[] = $cid;
5344 // return success message incl. missing users in array
5345 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5347 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5351 * Create the specified group with the posted array of contacts.
5353 * @param string $type Return type (atom, rss, xml, json)
5355 * @return array|string
5357 function api_friendica_group_create($type)
5361 if (api_user() === false) {
5362 throw new ForbiddenException();
5366 $user_info = api_get_user($a);
5367 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5368 $uid = $user_info['uid'];
5369 $json = json_decode($_POST['json'], true);
5370 $users = $json['user'];
5372 $success = group_create($name, $uid, $users);
5374 return api_format_data("group_create", $type, ['result' => $success]);
5376 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5379 * Create a new group.
5381 * @param string $type Return type (atom, rss, xml, json)
5383 * @return array|string
5384 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5386 function api_lists_create($type)
5390 if (api_user() === false) {
5391 throw new ForbiddenException();
5395 $user_info = api_get_user($a);
5396 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5397 $uid = $user_info['uid'];
5399 $success = group_create($name, $uid);
5400 if ($success['success']) {
5402 'name' => $success['name'],
5403 'id' => intval($success['gid']),
5404 'id_str' => (string) $success['gid'],
5405 'user' => $user_info
5408 return api_format_data("lists", $type, ['lists'=>$grp]);
5411 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5414 * Update the specified group with the posted array of contacts.
5416 * @param string $type Return type (atom, rss, xml, json)
5418 * @return array|string
5420 function api_friendica_group_update($type)
5424 if (api_user() === false) {
5425 throw new ForbiddenException();
5429 $user_info = api_get_user($a);
5430 $uid = $user_info['uid'];
5431 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5432 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5433 $json = json_decode($_POST['json'], true);
5434 $users = $json['user'];
5436 // error if no name specified
5438 throw new BadRequestException('group name not specified');
5441 // error if no gid specified
5443 throw new BadRequestException('gid not specified');
5447 $members = Contact::getByGroupId($gid);
5448 foreach ($members as $member) {
5449 $cid = $member['id'];
5450 foreach ($users as $user) {
5451 $found = ($user['cid'] == $cid ? true : false);
5453 if (!isset($found) || !$found) {
5454 Group::removeMemberByName($uid, $name, $cid);
5459 $erroraddinguser = false;
5461 foreach ($users as $user) {
5462 $cid = $user['cid'];
5463 // check if user really exists as contact
5465 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5470 if (count($contact)) {
5471 Group::addMember($gid, $cid);
5473 $erroraddinguser = true;
5474 $errorusers[] = $cid;
5478 // return success message incl. missing users in array
5479 $status = ($erroraddinguser ? "missing user" : "ok");
5480 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5481 return api_format_data("group_update", $type, ['result' => $success]);
5484 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5487 * Update information about a group.
5489 * @param string $type Return type (atom, rss, xml, json)
5491 * @return array|string
5492 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5494 function api_lists_update($type)
5498 if (api_user() === false) {
5499 throw new ForbiddenException();
5503 $user_info = api_get_user($a);
5504 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5505 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5506 $uid = $user_info['uid'];
5508 // error if no gid specified
5510 throw new BadRequestException('gid not specified');
5513 // get data of the specified group id
5514 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5515 // error message if specified gid is not in database
5517 throw new BadRequestException('gid not available');
5520 if (Group::update($gid, $name)) {
5523 'id' => intval($gid),
5524 'id_str' => (string) $gid,
5525 'user' => $user_info
5528 return api_format_data("lists", $type, ['lists' => $list]);
5532 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5536 * @param string $type Return type (atom, rss, xml, json)
5538 * @return array|string
5540 function api_friendica_activity($type)
5544 if (api_user() === false) {
5545 throw new ForbiddenException();
5547 $verb = strtolower($a->argv[3]);
5548 $verb = preg_replace("|\..*$|", "", $verb);
5550 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5552 $res = Item::performLike($id, $verb);
5555 if ($type == "xml") {
5560 return api_format_data('ok', $type, ['ok' => $ok]);
5562 throw new BadRequestException('Error adding activity');
5566 /// @TODO move to top of file or somewhere better
5567 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5568 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5569 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5570 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5571 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5572 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5573 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5574 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5575 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5576 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5579 * @brief Returns notifications
5581 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5582 * @return string|array
5584 function api_friendica_notification($type)
5588 if (api_user() === false) {
5589 throw new ForbiddenException();
5592 throw new BadRequestException("Invalid argument count");
5594 $nm = new NotificationsManager();
5596 $notes = $nm->getAll([], "+seen -date", 50);
5598 if ($type == "xml") {
5600 if (!empty($notes)) {
5601 foreach ($notes as $note) {
5602 $xmlnotes[] = ["@attributes" => $note];
5609 return api_format_data("notes", $type, ['note' => $notes]);
5613 * POST request with 'id' param as notification id
5615 * @brief Set notification as seen and returns associated item (if possible)
5617 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5618 * @return string|array
5620 function api_friendica_notification_seen($type)
5623 $user_info = api_get_user($a);
5625 if (api_user() === false || $user_info === false) {
5626 throw new ForbiddenException();
5629 throw new BadRequestException("Invalid argument count");
5632 $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5634 $nm = new NotificationsManager();
5635 $note = $nm->getByID($id);
5636 if (is_null($note)) {
5637 throw new BadRequestException("Invalid argument");
5640 $nm->setSeen($note);
5641 if ($note['otype']=='item') {
5642 // would be really better with an ItemsManager and $im->getByID() :-P
5643 $item = Item::selectFirstForUser(api_user(), [], ['id' => $note['iid'], 'uid' => api_user()]);
5644 if (DBM::is_result($$item)) {
5645 // we found the item, return it to the user
5646 $ret = api_format_items([$item], $user_info, false, $type);
5647 $data = ['status' => $ret];
5648 return api_format_data("status", $type, $data);
5650 // the item can't be found, but we set the note as seen, so we count this as a success
5652 return api_format_data('result', $type, ['result' => "success"]);
5655 /// @TODO move to top of file or somewhere better
5656 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5657 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5660 * @brief update a direct_message to seen state
5662 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5663 * @return string|array (success result=ok, error result=error with error message)
5665 function api_friendica_direct_messages_setseen($type)
5668 if (api_user() === false) {
5669 throw new ForbiddenException();
5673 $user_info = api_get_user($a);
5674 $uid = $user_info['uid'];
5675 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5677 // return error if id is zero
5679 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5680 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5683 // error message if specified id is not in database
5684 if (!dba::exists('mail', ['id' => $id, 'uid' => $uid])) {
5685 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5686 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5689 // update seen indicator
5690 $result = dba::update('mail', ['seen' => true], ['id' => $id]);
5694 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
5695 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
5697 $answer = ['result' => 'error', 'message' => 'unknown error'];
5698 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5702 /// @TODO move to top of file or somewhere better
5703 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5706 * @brief search for direct_messages containing a searchstring through api
5708 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5709 * @param string $box
5710 * @return string|array (success: success=true if found and search_result contains found messages,
5711 * success=false if nothing was found, search_result='nothing found',
5712 * error: result=error with error message)
5714 function api_friendica_direct_messages_search($type, $box = "")
5718 if (api_user() === false) {
5719 throw new ForbiddenException();
5723 $user_info = api_get_user($a);
5724 $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
5725 $uid = $user_info['uid'];
5727 // error if no searchstring specified
5728 if ($searchstring == "") {
5729 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
5730 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
5733 // get data for the specified searchstring
5735 "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",
5737 dbesc('%'.$searchstring.'%')
5740 $profile_url = $user_info["url"];
5742 // message if nothing was found
5743 if (!DBM::is_result($r)) {
5744 $success = ['success' => false, 'search_results' => 'problem with query'];
5745 } elseif (count($r) == 0) {
5746 $success = ['success' => false, 'search_results' => 'nothing found'];
5749 foreach ($r as $item) {
5750 if ($box == "inbox" || $item['from-url'] != $profile_url) {
5751 $recipient = $user_info;
5752 $sender = api_get_user($a, normalise_link($item['contact-url']));
5753 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5754 $recipient = api_get_user($a, normalise_link($item['contact-url']));
5755 $sender = $user_info;
5758 if (isset($recipient) && isset($sender)) {
5759 $ret[] = api_format_messages($item, $recipient, $sender);
5762 $success = ['success' => true, 'search_results' => $ret];
5765 return api_format_data("direct_message_search", $type, ['$result' => $success]);
5768 /// @TODO move to top of file or somewhere better
5769 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5772 * @brief return data of all the profiles a user has to the client
5774 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5775 * @return string|array
5777 function api_friendica_profile_show($type)
5781 if (api_user() === false) {
5782 throw new ForbiddenException();
5786 $profile_id = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
5788 // retrieve general information about profiles for user
5789 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
5790 $directory = Config::get('system', 'directory');
5792 // get data of the specified profile id or all profiles of the user if not specified
5793 if ($profile_id != 0) {
5795 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
5800 // error message if specified gid is not in database
5801 if (!DBM::is_result($r)) {
5802 throw new BadRequestException("profile_id not available");
5806 "SELECT * FROM `profile` WHERE `uid` = %d",
5810 // loop through all returned profiles and retrieve data and users
5813 foreach ($r as $rr) {
5814 $profile = api_format_items_profiles($rr);
5816 // select all users from contact table, loop and prepare standard return for user data
5819 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
5821 intval($rr['profile_id'])
5824 foreach ($nurls as $nurl) {
5825 $user = api_get_user($a, $nurl['nurl']);
5826 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
5828 $profile['users'] = $users;
5830 // add prepared profile data to array for final return
5831 if ($type == "xml") {
5832 $profiles[$k++ . ":profile"] = $profile;
5834 $profiles[] = $profile;
5838 // return settings, authenticated user and profiles data
5839 $self = q("SELECT `nurl` FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
5841 $result = ['multi_profiles' => $multi_profiles ? true : false,
5842 'global_dir' => $directory,
5843 'friendica_owner' => api_get_user($a, $self[0]['nurl']),
5844 'profiles' => $profiles];
5845 return api_format_data("friendica_profiles", $type, ['$result' => $result]);
5847 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
5850 * Returns a list of saved searches.
5852 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5854 * @param string $type Return format: json or xml
5856 * @return string|array
5858 function api_saved_searches_list($type)
5860 $terms = dba::select('search', ['id', 'term'], ['uid' => local_user()]);
5863 while ($term = $terms->fetch()) {
5865 'created_at' => api_date(time()),
5866 'id' => intval($term['id']),
5867 'id_str' => $term['id'],
5868 'name' => $term['term'],
5870 'query' => $term['term']
5876 return api_format_data("terms", $type, ['terms' => $result]);
5879 /// @TODO move to top of file or somewhere better
5880 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5883 @TODO Maybe open to implement?
5885 [pagename] => api/1.1/statuses/lookup.json
5886 [id] => 605138389168451584
5887 [include_cards] => true
5888 [cards_platform] => Android-12
5889 [include_entities] => true
5890 [include_my_retweet] => 1
5892 [include_reply_count] => true
5893 [include_descendent_reply_count] => true
5897 Not implemented by now:
5898 statuses/retweets_of_me
5903 account/update_location
5904 account/update_profile_background_image
5907 friendica/profile/update
5908 friendica/profile/create
5909 friendica/profile/delete
5911 Not implemented in status.net:
5912 statuses/retweeted_to_me
5913 statuses/retweeted_by_me
5914 direct_messages/destroy
5916 account/update_delivery_device
5917 notifications/follow