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\DBA;
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\Proxy as ProxyUtils;
44 use Friendica\Util\XML;
46 require_once 'include/conversation.php';
47 require_once 'mod/share.php';
48 require_once 'mod/item.php';
49 require_once 'include/security.php';
50 require_once 'mod/wall_upload.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 (!DBA::isResult($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 (DBA::isResult($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 = DBA::escape(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 = DBA::escape(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 = DBA::escape(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 = DBA::escape($_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 = DBA::escape(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 $data = explode(".", $a->argv[$argid]);
585 if (count($data) > 1) {
586 list($user, $null) = $data;
589 if (is_numeric($user)) {
590 $user = DBA::escape(api_unique_id_to_nurl(intval($user)));
594 $extra_query = "AND `contact`.`nurl` = '%s' ";
595 if (api_user() !== false) {
596 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
600 $user = DBA::escape($user);
601 $extra_query = "AND `contact`.`nick` = '%s' ";
602 if (api_user() !== false) {
603 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
608 logger("api_get_user: user ".$user, LOGGER_DEBUG);
611 if (api_user() === false) {
615 $user = $_SESSION['uid'];
616 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
620 logger('api_user: ' . $extra_query . ', user: ' . $user);
624 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
630 // Selecting the id by priority, friendica first
631 if (is_array($uinfo)) {
632 api_best_nickname($uinfo);
635 // if the contact wasn't found, fetch it from the contacts with uid = 0
636 if (!DBA::isResult($uinfo)) {
638 throw new BadRequestException("User not found.");
641 $contact = DBA::selectFirst('contact', [], ['uid' => 0, 'nurl' => normalise_link($url)]);
643 if (DBA::isResult($contact)) {
644 $network_name = ContactSelector::networkToName($contact['network'], $contact['url']);
646 // If no nick where given, extract it from the address
647 if (($contact['nick'] == "") || ($contact['name'] == $contact['nick'])) {
648 $contact['nick'] = api_get_nick($contact["url"]);
652 'id' => $contact["id"],
653 'id_str' => (string) $contact["id"],
654 'name' => $contact["name"],
655 'screen_name' => (($contact['nick']) ? $contact['nick'] : $contact['name']),
656 'location' => ($contact["location"] != "") ? $contact["location"] : $network_name,
657 'description' => $contact["about"],
658 'profile_image_url' => $contact["micro"],
659 'profile_image_url_https' => $contact["micro"],
660 'profile_image_url_profile_size' => $contact["thumb"],
661 'profile_image_url_large' => $contact["photo"],
662 'url' => $contact["url"],
663 'protected' => false,
664 'followers_count' => 0,
665 'friends_count' => 0,
667 'created_at' => api_date($contact["created"]),
668 'favourites_count' => 0,
670 'time_zone' => 'UTC',
671 'geo_enabled' => false,
673 'statuses_count' => 0,
675 'contributors_enabled' => false,
676 'is_translator' => false,
677 'is_translation_enabled' => false,
678 'following' => false,
679 'follow_request_sent' => false,
680 'statusnet_blocking' => false,
681 'notifications' => false,
682 'statusnet_profile_url' => $contact["url"],
684 'cid' => Contact::getIdForURL($contact["url"], api_user(), true),
685 'pid' => Contact::getIdForURL($contact["url"], 0, true),
687 'network' => $contact["network"],
692 throw new BadRequestException("User ".$url." not found.");
696 if ($uinfo[0]['self']) {
697 if ($uinfo[0]['network'] == "") {
698 $uinfo[0]['network'] = Protocol::DFRN;
701 $usr = DBA::selectFirst('user', ['default-location'], ['uid' => api_user()]);
702 $profile = DBA::selectFirst('profile', ['about'], ['uid' => api_user(), 'is-default' => true]);
709 // Add a nick if it isn't present there
710 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
711 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
714 $network_name = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
716 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
718 if (!empty($profile['about'])) {
719 $description = $profile['about'];
721 $description = $uinfo[0]["about"];
724 if (!empty($usr['default-location'])) {
725 $location = $usr['default-location'];
726 } elseif (!empty($uinfo[0]["location"])) {
727 $location = $uinfo[0]["location"];
729 $location = $network_name;
733 'id' => intval($pcontact_id),
734 'id_str' => (string) intval($pcontact_id),
735 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
736 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
737 'location' => $location,
738 'description' => $description,
739 'profile_image_url' => $uinfo[0]['micro'],
740 'profile_image_url_https' => $uinfo[0]['micro'],
741 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
742 'profile_image_url_large' => $uinfo[0]["photo"],
743 'url' => $uinfo[0]['url'],
744 'protected' => false,
745 'followers_count' => intval($countfollowers),
746 'friends_count' => intval($countfriends),
748 'created_at' => api_date($uinfo[0]['created']),
749 'favourites_count' => intval($starred),
751 'time_zone' => 'UTC',
752 'geo_enabled' => false,
754 'statuses_count' => intval($countitems),
756 'contributors_enabled' => false,
757 'is_translator' => false,
758 'is_translation_enabled' => false,
759 'following' => (($uinfo[0]['rel'] == Contact::FOLLOWER) || ($uinfo[0]['rel'] == Contact::FRIEND)),
760 'follow_request_sent' => false,
761 'statusnet_blocking' => false,
762 'notifications' => false,
764 //'statusnet_profile_url' => System::baseUrl()."/contacts/".$uinfo[0]['cid'],
765 'statusnet_profile_url' => $uinfo[0]['url'],
766 'uid' => intval($uinfo[0]['uid']),
767 'cid' => intval($uinfo[0]['cid']),
768 'pid' => Contact::getIdForURL($uinfo[0]["url"], 0, true),
769 'self' => $uinfo[0]['self'],
770 'network' => $uinfo[0]['network'],
773 // If this is a local user and it uses Frio, we can get its color preferences.
775 $theme_info = DBA::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
776 if ($theme_info['theme'] === 'frio') {
777 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
779 if ($schema && ($schema != '---')) {
780 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
781 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
782 require_once $schemefile;
785 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
786 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
787 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
789 if (empty($nav_bg)) {
792 if (empty($link_color)) {
793 $link_color = "#6fdbe8";
795 if (empty($bgcolor)) {
796 $bgcolor = "#ededed";
799 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
800 $ret['profile_link_color'] = str_replace('#', '', $link_color);
801 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
809 * @brief return api-formatted array for item's author and owner
811 * @param object $a App
812 * @param array $item item from db
813 * @return array(array:author, array:owner)
815 function api_item_get_user(App $a, $item)
817 $status_user = api_get_user($a, defaults($item, 'author-id', null));
819 $status_user["protected"] = defaults($item, 'private', 0);
821 if (defaults($item, 'thr-parent', '') == defaults($item, 'uri', '')) {
822 $owner_user = api_get_user($a, defaults($item, 'author-id', null));
824 $owner_user = $status_user;
827 return ([$status_user, $owner_user]);
831 * @brief walks recursively through an array with the possibility to change value and key
833 * @param array $array The array to walk through
834 * @param string $callback The callback function
836 * @return array the transformed array
838 function api_walk_recursive(array &$array, callable $callback)
842 foreach ($array as $k => $v) {
844 if ($callback($v, $k)) {
845 $new_array[$k] = api_walk_recursive($v, $callback);
848 if ($callback($v, $k)) {
859 * @brief Callback function to transform the array in an array that can be transformed in a XML file
861 * @param mixed $item Array item value
862 * @param string $key Array key
864 * @return boolean Should the array item be deleted?
866 function api_reformat_xml(&$item, &$key)
868 if (is_bool($item)) {
869 $item = ($item ? "true" : "false");
872 if (substr($key, 0, 10) == "statusnet_") {
873 $key = "statusnet:".substr($key, 10);
874 } elseif (substr($key, 0, 10) == "friendica_") {
875 $key = "friendica:".substr($key, 10);
877 /// @TODO old-lost code?
879 // $key = "default:".$key;
885 * @brief Creates the XML from a JSON style array
887 * @param array $data JSON style array
888 * @param string $root_element Name of the root element
890 * @return string The XML data
892 function api_create_xml(array $data, $root_element)
894 $childname = key($data);
895 $data2 = array_pop($data);
897 $namespaces = ["" => "http://api.twitter.com",
898 "statusnet" => "http://status.net/schema/api/1/",
899 "friendica" => "http://friendi.ca/schema/api/1/",
900 "georss" => "http://www.georss.org/georss"];
902 /// @todo Auto detection of needed namespaces
903 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
907 if (is_array($data2)) {
909 api_walk_recursive($data2, "api_reformat_xml");
915 foreach ($data2 as $item) {
916 $data4[$i++ . ":" . $childname] = $item;
923 $data3 = [$root_element => $data2];
925 $ret = XML::fromArray($data3, $xml, false, $namespaces);
930 * @brief Formats the data according to the data type
932 * @param string $root_element Name of the root element
933 * @param string $type Return type (atom, rss, xml, json)
934 * @param array $data JSON style array
936 * @return (string|array) XML data or JSON data
938 function api_format_data($root_element, $type, $data)
944 $ret = api_create_xml($data, $root_element);
960 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
961 * returns a 401 status code and an error message if not.
962 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
964 * @param string $type Return type (atom, rss, xml, json)
966 function api_account_verify_credentials($type)
971 if (api_user() === false) {
972 throw new ForbiddenException();
975 unset($_REQUEST["user_id"]);
976 unset($_GET["user_id"]);
978 unset($_REQUEST["screen_name"]);
979 unset($_GET["screen_name"]);
981 $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false);
983 $user_info = api_get_user($a);
985 // "verified" isn't used here in the standard
986 unset($user_info["verified"]);
988 // - Adding last status
990 $user_info["status"] = api_status_show("raw");
991 if (!count($user_info["status"])) {
992 unset($user_info["status"]);
994 unset($user_info["status"]["user"]);
998 // "uid" and "self" are only needed for some internal stuff, so remove it from here
999 unset($user_info["uid"]);
1000 unset($user_info["self"]);
1002 return api_format_data("user", $type, ['user' => $user_info]);
1005 /// @TODO move to top of file or somewhere better
1006 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1009 * Get data from $_POST or $_GET
1013 function requestdata($k)
1015 if (x($_POST, $k)) {
1025 * Deprecated function to upload media.
1027 * @param string $type Return type (atom, rss, xml, json)
1029 * @return array|string
1031 function api_statuses_mediap($type)
1035 if (api_user() === false) {
1036 logger('api_statuses_update: no user');
1037 throw new ForbiddenException();
1039 $user_info = api_get_user($a);
1041 $_REQUEST['profile_uid'] = api_user();
1042 $_REQUEST['api_source'] = true;
1043 $txt = requestdata('status');
1044 /// @TODO old-lost code?
1045 //$txt = urldecode(requestdata('status'));
1047 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1048 $txt = html2bb_video($txt);
1049 $config = HTMLPurifier_Config::createDefault();
1050 $config->set('Cache.DefinitionImpl', null);
1051 $purifier = new HTMLPurifier($config);
1052 $txt = $purifier->purify($txt);
1054 $txt = HTML::toBBCode($txt);
1056 $a->argv[1] = $user_info['screen_name']; //should be set to username?
1058 $picture = wall_upload_post($a, false);
1060 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1061 $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1062 $item_id = item_post($a);
1064 // output the post that we just posted.
1065 return api_status_show($type, $item_id);
1068 /// @TODO move this to top of file or somewhere better!
1069 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1072 * Updates the user’s current status.
1074 * @param string $type Return type (atom, rss, xml, json)
1076 * @return array|string
1077 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1079 function api_statuses_update($type)
1083 if (api_user() === false) {
1084 logger('api_statuses_update: no user');
1085 throw new ForbiddenException();
1090 // convert $_POST array items to the form we use for web posts.
1091 if (requestdata('htmlstatus')) {
1092 $txt = requestdata('htmlstatus');
1093 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1094 $txt = html2bb_video($txt);
1096 $config = HTMLPurifier_Config::createDefault();
1097 $config->set('Cache.DefinitionImpl', null);
1099 $purifier = new HTMLPurifier($config);
1100 $txt = $purifier->purify($txt);
1102 $_REQUEST['body'] = HTML::toBBCode($txt);
1105 $_REQUEST['body'] = requestdata('status');
1108 $_REQUEST['title'] = requestdata('title');
1110 $parent = requestdata('in_reply_to_status_id');
1112 // Twidere sends "-1" if it is no reply ...
1113 if ($parent == -1) {
1117 if (ctype_digit($parent)) {
1118 $_REQUEST['parent'] = $parent;
1120 $_REQUEST['parent_uri'] = $parent;
1123 if (requestdata('lat') && requestdata('long')) {
1124 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1126 $_REQUEST['profile_uid'] = api_user();
1129 // Check for throttling (maximum posts per day, week and month)
1130 $throttle_day = Config::get('system', 'throttle_limit_day');
1131 if ($throttle_day > 0) {
1132 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1134 $condition = ["`uid` = ? AND `wall` AND `created` > ?", api_user(), $datefrom];
1135 $posts_day = DBA::count('thread', $condition);
1137 if ($posts_day > $throttle_day) {
1138 logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG);
1139 // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1140 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));
1144 $throttle_week = Config::get('system', 'throttle_limit_week');
1145 if ($throttle_week > 0) {
1146 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1148 $condition = ["`uid` = ? AND `wall` AND `created` > ?", api_user(), $datefrom];
1149 $posts_week = DBA::count('thread', $condition);
1151 if ($posts_week > $throttle_week) {
1152 logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1153 // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1154 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));
1158 $throttle_month = Config::get('system', 'throttle_limit_month');
1159 if ($throttle_month > 0) {
1160 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1162 $condition = ["`uid` = ? AND `wall` AND `created` > ?", api_user(), $datefrom];
1163 $posts_month = DBA::count('thread', $condition);
1165 if ($posts_month > $throttle_month) {
1166 logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1167 // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1168 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 if (x($_FILES, 'media')) {
1174 // upload the image if we have one
1175 $picture = wall_upload_post($a, false);
1176 if (is_array($picture)) {
1177 $_REQUEST['body'] .= "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1181 // To-Do: Multiple IDs
1182 if (requestdata('media_ids')) {
1184 "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",
1185 intval(requestdata('media_ids')),
1188 if (DBA::isResult($r)) {
1189 $phototypes = Image::supportedTypes();
1190 $ext = $phototypes[$r[0]['type']];
1191 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1192 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1196 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1198 $_REQUEST['api_source'] = true;
1200 if (!x($_REQUEST, "source")) {
1201 $_REQUEST["source"] = api_source();
1204 // call out normal post function
1205 $item_id = item_post($a);
1207 // output the post that we just posted.
1208 return api_status_show($type, $item_id);
1211 /// @TODO move to top of file or somewhere better
1212 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1213 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1216 * Uploads an image to Friendica.
1219 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1221 function api_media_upload()
1225 if (api_user() === false) {
1227 throw new ForbiddenException();
1232 if (!x($_FILES, 'media')) {
1234 throw new BadRequestException("No media.");
1237 $media = wall_upload_post($a, false);
1240 throw new InternalServerErrorException();
1244 $returndata["media_id"] = $media["id"];
1245 $returndata["media_id_string"] = (string)$media["id"];
1246 $returndata["size"] = $media["size"];
1247 $returndata["image"] = ["w" => $media["width"],
1248 "h" => $media["height"],
1249 "image_type" => $media["type"]];
1251 logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG);
1253 return ["media" => $returndata];
1256 /// @TODO move to top of file or somewhere better
1257 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1261 * @param string $type Return type (atom, rss, xml, json)
1263 * @return array|string
1265 function api_status_show($type, $item_id = 0)
1269 $user_info = api_get_user($a);
1271 logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG);
1273 if ($type == "raw") {
1274 $privacy_sql = "AND NOT `private`";
1279 if (!empty($item_id)) {
1280 // Get the item with the given id
1281 $condition = ['id' => $item_id];
1283 // get last public wall message
1284 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1285 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1287 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1289 if (DBA::isResult($lastwall)) {
1290 $in_reply_to = api_in_reply_to($lastwall);
1292 $converted = api_convert_item($lastwall);
1294 if ($type == "xml") {
1295 $geo = "georss:point";
1301 'created_at' => api_date($lastwall['created']),
1302 'id' => intval($lastwall['id']),
1303 'id_str' => (string) $lastwall['id'],
1304 'text' => $converted["text"],
1305 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1306 'truncated' => false,
1307 'in_reply_to_status_id' => $in_reply_to['status_id'],
1308 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1309 'in_reply_to_user_id' => $in_reply_to['user_id'],
1310 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1311 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1312 'user' => $user_info,
1314 'coordinates' => '',
1316 'contributors' => '',
1317 'is_quote_status' => false,
1318 'retweet_count' => 0,
1319 'favorite_count' => 0,
1320 'favorited' => $lastwall['starred'] ? true : false,
1321 'retweeted' => false,
1322 'possibly_sensitive' => false,
1324 'statusnet_html' => $converted["html"],
1325 'statusnet_conversation_id' => $lastwall['parent'],
1326 'external_url' => System::baseUrl() . '/display/' . $lastwall['guid'],
1329 if (count($converted["attachments"]) > 0) {
1330 $status_info["attachments"] = $converted["attachments"];
1333 if (count($converted["entities"]) > 0) {
1334 $status_info["entities"] = $converted["entities"];
1337 if ($status_info["source"] == 'web') {
1338 $status_info["source"] = ContactSelector::networkToName($lastwall['network'], $user_info['url']);
1339 } elseif (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $status_info["source"]) {
1340 $status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['network'], $user_info['url']).')');
1343 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1344 unset($status_info["user"]["uid"]);
1345 unset($status_info["user"]["self"]);
1347 logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG);
1349 if ($type == "raw") {
1350 return $status_info;
1353 return api_format_data("statuses", $type, ['status' => $status_info]);
1358 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1359 * The author's most recent status will be returned inline.
1361 * @param string $type Return type (atom, rss, xml, json)
1362 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1364 function api_users_show($type)
1368 $user_info = api_get_user($a);
1370 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1371 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'private' => false];
1372 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1374 if (DBA::isResult($lastwall)) {
1375 $in_reply_to = api_in_reply_to($lastwall);
1377 $converted = api_convert_item($lastwall);
1379 if ($type == "xml") {
1380 $geo = "georss:point";
1385 $user_info['status'] = [
1386 'text' => $converted["text"],
1387 'truncated' => false,
1388 'created_at' => api_date($lastwall['created']),
1389 'in_reply_to_status_id' => $in_reply_to['status_id'],
1390 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1391 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1392 'id' => intval($lastwall['contact-id']),
1393 'id_str' => (string) $lastwall['contact-id'],
1394 'in_reply_to_user_id' => $in_reply_to['user_id'],
1395 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1396 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1398 'favorited' => $lastwall['starred'] ? true : false,
1399 'statusnet_html' => $converted["html"],
1400 'statusnet_conversation_id' => $lastwall['parent'],
1401 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1404 if (count($converted["attachments"]) > 0) {
1405 $user_info["status"]["attachments"] = $converted["attachments"];
1408 if (count($converted["entities"]) > 0) {
1409 $user_info["status"]["entities"] = $converted["entities"];
1412 if ($user_info["status"]["source"] == 'web') {
1413 $user_info["status"]["source"] = ContactSelector::networkToName($lastwall['network'], $user_info['url']);
1416 if (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $user_info["status"]["source"]) {
1417 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['network'], $user_info['url']) . ')');
1421 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1422 unset($user_info["uid"]);
1423 unset($user_info["self"]);
1425 return api_format_data("user", $type, ['user' => $user_info]);
1428 /// @TODO move to top of file or somewhere better
1429 api_register_func('api/users/show', 'api_users_show');
1430 api_register_func('api/externalprofile/show', 'api_users_show');
1433 * Search a public user account.
1435 * @param string $type Return type (atom, rss, xml, json)
1437 * @return array|string
1438 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1440 function api_users_search($type)
1446 if (x($_GET, 'q')) {
1447 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", DBA::escape($_GET["q"]));
1449 if (!DBA::isResult($r)) {
1450 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", DBA::escape($_GET["q"]));
1453 if (DBA::isResult($r)) {
1455 foreach ($r as $user) {
1456 $user_info = api_get_user($a, $user["id"]);
1458 if ($type == "xml") {
1459 $userlist[$k++.":user"] = $user_info;
1461 $userlist[] = $user_info;
1464 $userlist = ["users" => $userlist];
1466 throw new BadRequestException("User ".$_GET["q"]." not found.");
1469 throw new BadRequestException("No user specified.");
1472 return api_format_data("users", $type, $userlist);
1475 /// @TODO move to top of file or somewhere better
1476 api_register_func('api/users/search', 'api_users_search');
1479 * Return user objects
1481 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1483 * @param string $type Return format: json or xml
1485 * @return array|string
1486 * @throws NotFoundException if the results are empty.
1488 function api_users_lookup($type)
1492 if (!empty($_REQUEST['user_id'])) {
1493 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1495 $users[] = api_get_user(get_app(), $id);
1500 if (empty($users)) {
1501 throw new NotFoundException;
1504 return api_format_data("users", $type, ['users' => $users]);
1507 /// @TODO move to top of file or somewhere better
1508 api_register_func('api/users/lookup', 'api_users_lookup', true);
1511 * Returns statuses that match a specified query.
1513 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1515 * @param string $type Return format: json, xml, atom, rss
1517 * @return array|string
1518 * @throws BadRequestException if the "q" parameter is missing.
1520 function api_search($type)
1523 $user_info = api_get_user($a);
1525 if (api_user() === false || $user_info === false) {
1526 throw new ForbiddenException();
1531 if (!x($_REQUEST, 'q')) {
1532 throw new BadRequestException("q parameter is required.");
1535 if (x($_REQUEST, 'rpp')) {
1536 $count = $_REQUEST['rpp'];
1537 } elseif (x($_REQUEST, 'count')) {
1538 $count = $_REQUEST['count'];
1543 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1544 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1545 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1547 $start = $page * $count;
1549 $condition = ["`gravity` IN (?, ?) AND `item`.`id` > ?
1550 AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))
1551 AND `item`.`body` LIKE CONCAT('%',?,'%')",
1552 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, api_user(), $_REQUEST['q']];
1555 $condition[0] .= " AND `item`.`id` <= ?";
1556 $condition[] = $max_id;
1559 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1560 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1562 $data['status'] = api_format_items(Item::inArray($statuses), $user_info);
1564 return api_format_data("statuses", $type, $data);
1567 /// @TODO move to top of file or somewhere better
1568 api_register_func('api/search/tweets', 'api_search', true);
1569 api_register_func('api/search', 'api_search', true);
1572 * Returns the most recent statuses posted by the user and the users they follow.
1574 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1576 * @param string $type Return type (atom, rss, xml, json)
1578 * @todo Optional parameters
1579 * @todo Add reply info
1581 function api_statuses_home_timeline($type)
1584 $user_info = api_get_user($a);
1586 if (api_user() === false || $user_info === false) {
1587 throw new ForbiddenException();
1590 unset($_REQUEST["user_id"]);
1591 unset($_GET["user_id"]);
1593 unset($_REQUEST["screen_name"]);
1594 unset($_GET["screen_name"]);
1596 // get last network messages
1599 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1600 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1604 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1605 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1606 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1607 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1608 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1610 $start = $page * $count;
1612 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1613 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1616 $condition[0] .= " AND `item`.`id` <= ?";
1617 $condition[] = $max_id;
1619 if ($exclude_replies > 0) {
1620 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
1622 if ($conversation_id > 0) {
1623 $condition[0] .= " AND `item`.`parent` = ?";
1624 $condition[] = $conversation_id;
1627 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1628 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1630 $items = Item::inArray($statuses);
1632 $ret = api_format_items($items, $user_info, false, $type);
1634 // Set all posts from the query above to seen
1636 foreach ($items as $item) {
1637 $idarray[] = intval($item["id"]);
1640 if (!empty($idarray)) {
1641 $unseen = Item::exists(['unseen' => true, 'id' => $idarray]);
1643 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1647 $data = ['status' => $ret];
1651 $data = api_rss_extra($a, $data, $user_info);
1655 return api_format_data("statuses", $type, $data);
1658 /// @TODO move to top of file or somewhere better
1659 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1660 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1663 * Returns the most recent statuses from public users.
1665 * @param string $type Return type (atom, rss, xml, json)
1667 * @return array|string
1669 function api_statuses_public_timeline($type)
1672 $user_info = api_get_user($a);
1674 if (api_user() === false || $user_info === false) {
1675 throw new ForbiddenException();
1678 // get last network messages
1681 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1682 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
1686 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1687 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1688 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1689 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1690 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1692 $start = $page * $count;
1695 if ($exclude_replies && !$conversation_id) {
1696 $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall`",
1697 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1700 $condition[0] .= " AND `thread`.`iid` <= ?";
1701 $condition[] = $max_id;
1704 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1705 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1707 $r = Item::inArray($statuses);
1709 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND `item`.`origin`",
1710 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1713 $condition[0] .= " AND `item`.`id` <= ?";
1714 $condition[] = $max_id;
1716 if ($conversation_id > 0) {
1717 $condition[0] .= " AND `item`.`parent` = ?";
1718 $condition[] = $conversation_id;
1721 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1722 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1724 $r = Item::inArray($statuses);
1727 $ret = api_format_items($r, $user_info, false, $type);
1729 $data = ['status' => $ret];
1733 $data = api_rss_extra($a, $data, $user_info);
1737 return api_format_data("statuses", $type, $data);
1740 /// @TODO move to top of file or somewhere better
1741 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1744 * Returns the most recent statuses posted by users this node knows about.
1746 * @brief Returns the list of public federated posts this node knows about
1748 * @param string $type Return format: json, xml, atom, rss
1749 * @return array|string
1750 * @throws ForbiddenException
1752 function api_statuses_networkpublic_timeline($type)
1755 $user_info = api_get_user($a);
1757 if (api_user() === false || $user_info === false) {
1758 throw new ForbiddenException();
1761 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
1762 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
1765 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
1766 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
1770 $start = ($page - 1) * $count;
1772 $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `thread`.`iid` > ? AND NOT `private`",
1773 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1776 $condition[0] .= " AND `thread`.`iid` <= ?";
1777 $condition[] = $max_id;
1780 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1781 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1783 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1785 $data = ['status' => $ret];
1789 $data = api_rss_extra($a, $data, $user_info);
1793 return api_format_data("statuses", $type, $data);
1796 /// @TODO move to top of file or somewhere better
1797 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1800 * Returns a single status.
1802 * @param string $type Return type (atom, rss, xml, json)
1804 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1806 function api_statuses_show($type)
1809 $user_info = api_get_user($a);
1811 if (api_user() === false || $user_info === false) {
1812 throw new ForbiddenException();
1816 $id = intval(defaults($a->argv, 3, 0));
1819 $id = intval(defaults($_REQUEST, 'id', 0));
1824 $id = intval(defaults($a->argv, 4, 0));
1827 logger('API: api_statuses_show: ' . $id);
1829 $conversation = !empty($_REQUEST['conversation']);
1831 // try to fetch the item for the local user - or the public item, if there is no local one
1832 $uri_item = Item::selectFirst(['uri'], ['id' => $id]);
1833 if (!DBA::isResult($uri_item)) {
1834 throw new BadRequestException("There is no status with this id.");
1837 $item = Item::selectFirst(['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1838 if (!DBA::isResult($item)) {
1839 throw new BadRequestException("There is no status with this id.");
1844 if ($conversation) {
1845 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1846 $params = ['order' => ['id' => true]];
1848 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1852 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1854 /// @TODO How about copying this to above methods which don't check $r ?
1855 if (!DBA::isResult($statuses)) {
1856 throw new BadRequestException("There is no status with this id.");
1859 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1861 if ($conversation) {
1862 $data = ['status' => $ret];
1863 return api_format_data("statuses", $type, $data);
1865 $data = ['status' => $ret[0]];
1866 return api_format_data("status", $type, $data);
1870 /// @TODO move to top of file or somewhere better
1871 api_register_func('api/statuses/show', 'api_statuses_show', true);
1875 * @param string $type Return type (atom, rss, xml, json)
1877 * @todo nothing to say?
1879 function api_conversation_show($type)
1882 $user_info = api_get_user($a);
1884 if (api_user() === false || $user_info === false) {
1885 throw new ForbiddenException();
1889 $id = intval(defaults($a->argv , 3 , 0));
1890 $since_id = intval(defaults($_REQUEST, 'since_id', 0));
1891 $max_id = intval(defaults($_REQUEST, 'max_id' , 0));
1892 $count = intval(defaults($_REQUEST, 'count' , 20));
1893 $page = intval(defaults($_REQUEST, 'page' , 1)) - 1;
1898 $start = $page * $count;
1901 $id = intval(defaults($_REQUEST, 'id', 0));
1906 $id = intval(defaults($a->argv, 4, 0));
1909 logger('API: api_conversation_show: '.$id);
1911 // try to fetch the item for the local user - or the public item, if there is no local one
1912 $item = Item::selectFirst(['parent-uri'], ['id' => $id]);
1913 if (!DBA::isResult($item)) {
1914 throw new BadRequestException("There is no status with this id.");
1917 $parent = Item::selectFirst(['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1918 if (!DBA::isResult($parent)) {
1919 throw new BadRequestException("There is no status with this id.");
1922 $id = $parent['id'];
1924 $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1925 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1928 $condition[0] .= " AND `item`.`id` <= ?";
1929 $condition[] = $max_id;
1932 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1933 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1935 if (!DBA::isResult($statuses)) {
1936 throw new BadRequestException("There is no status with id $id.");
1939 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1941 $data = ['status' => $ret];
1942 return api_format_data("statuses", $type, $data);
1945 /// @TODO move to top of file or somewhere better
1946 api_register_func('api/conversation/show', 'api_conversation_show', true);
1947 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
1952 * @param string $type Return type (atom, rss, xml, json)
1954 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
1956 function api_statuses_repeat($type)
1962 if (api_user() === false) {
1963 throw new ForbiddenException();
1969 $id = intval(defaults($a->argv, 3, 0));
1972 $id = intval(defaults($_REQUEST, 'id', 0));
1977 $id = intval(defaults($a->argv, 4, 0));
1980 logger('API: api_statuses_repeat: '.$id);
1982 $fields = ['body', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
1983 $item = Item::selectFirst($fields, ['id' => $id, 'private' => false]);
1985 if (DBA::isResult($item) && $item['body'] != "") {
1986 if (strpos($item['body'], "[/share]") !== false) {
1987 $pos = strpos($item['body'], "[share");
1988 $post = substr($item['body'], $pos);
1990 $post = share_header($item['author-name'], $item['author-link'], $item['author-avatar'], $item['guid'], $item['created'], $item['plink']);
1992 $post .= $item['body'];
1993 $post .= "[/share]";
1995 $_REQUEST['body'] = $post;
1996 $_REQUEST['profile_uid'] = api_user();
1997 $_REQUEST['api_source'] = true;
1999 if (!x($_REQUEST, "source")) {
2000 $_REQUEST["source"] = api_source();
2003 $item_id = item_post($a);
2005 throw new ForbiddenException();
2008 // output the post that we just posted.
2010 return api_status_show($type, $item_id);
2013 /// @TODO move to top of file or somewhere better
2014 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2017 * Destroys a specific status.
2019 * @param string $type Return type (atom, rss, xml, json)
2021 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2023 function api_statuses_destroy($type)
2027 if (api_user() === false) {
2028 throw new ForbiddenException();
2034 $id = intval(defaults($a->argv, 3, 0));
2037 $id = intval(defaults($_REQUEST, 'id', 0));
2042 $id = intval(defaults($a->argv, 4, 0));
2045 logger('API: api_statuses_destroy: '.$id);
2047 $ret = api_statuses_show($type);
2049 Item::deleteForUser(['id' => $id], api_user());
2054 /// @TODO move to top of file or somewhere better
2055 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2058 * Returns the most recent mentions.
2060 * @param string $type Return type (atom, rss, xml, json)
2062 * @see http://developer.twitter.com/doc/get/statuses/mentions
2064 function api_statuses_mentions($type)
2067 $user_info = api_get_user($a);
2069 if (api_user() === false || $user_info === false) {
2070 throw new ForbiddenException();
2073 unset($_REQUEST["user_id"]);
2074 unset($_GET["user_id"]);
2076 unset($_REQUEST["screen_name"]);
2077 unset($_GET["screen_name"]);
2079 // get last network messages
2082 $since_id = defaults($_REQUEST, 'since_id', 0);
2083 $max_id = defaults($_REQUEST, 'max_id' , 0);
2084 $count = defaults($_REQUEST, 'count' , 20);
2085 $page = defaults($_REQUEST, 'page' , 1);
2090 $start = ($page - 1) * $count;
2092 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `author-id` != ?
2093 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `thread`.`uid` = ? AND `thread`.`mention` AND NOT `thread`.`ignored`)",
2094 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['pid'], api_user()];
2097 $condition[0] .= " AND `item`.`id` <= ?";
2098 $condition[] = $max_id;
2101 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2102 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2104 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2106 $data = ['status' => $ret];
2110 $data = api_rss_extra($a, $data, $user_info);
2114 return api_format_data("statuses", $type, $data);
2117 /// @TODO move to top of file or somewhere better
2118 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2119 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2122 * Returns the most recent statuses posted by the user.
2124 * @brief Returns a user's public timeline
2126 * @param string $type Either "json" or "xml"
2127 * @return string|array
2128 * @throws ForbiddenException
2129 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2131 function api_statuses_user_timeline($type)
2134 $user_info = api_get_user($a);
2136 if (api_user() === false || $user_info === false) {
2137 throw new ForbiddenException();
2141 "api_statuses_user_timeline: api_user: ". api_user() .
2142 "\nuser_info: ".print_r($user_info, true) .
2143 "\n_REQUEST: ".print_r($_REQUEST, true),
2147 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
2148 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
2149 $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0;
2150 $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0;
2153 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
2154 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
2158 $start = ($page - 1) * $count;
2160 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `item`.`contact-id` = ?",
2161 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2163 if ($user_info['self'] == 1) {
2164 $condition[0] .= ' AND `item`.`wall` ';
2167 if ($exclude_replies > 0) {
2168 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
2171 if ($conversation_id > 0) {
2172 $condition[0] .= " AND `item`.`parent` = ?";
2173 $condition[] = $conversation_id;
2177 $condition[0] .= " AND `item`.`id` <= ?";
2178 $condition[] = $max_id;
2181 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2182 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2184 $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type);
2186 $data = ['status' => $ret];
2190 $data = api_rss_extra($a, $data, $user_info);
2194 return api_format_data("statuses", $type, $data);
2197 /// @TODO move to top of file or somewhere better
2198 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2201 * Star/unstar an item.
2202 * param: id : id of the item
2204 * @param string $type Return type (atom, rss, xml, json)
2206 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2208 function api_favorites_create_destroy($type)
2212 if (api_user() === false) {
2213 throw new ForbiddenException();
2216 // for versioned api.
2217 /// @TODO We need a better global soluton
2218 $action_argv_id = 2;
2219 if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2220 $action_argv_id = 3;
2223 if ($a->argc <= $action_argv_id) {
2224 throw new BadRequestException("Invalid request.");
2226 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2227 if ($a->argc == $action_argv_id + 2) {
2228 $itemid = intval(defaults($a->argv, $action_argv_id + 1, 0));
2230 $itemid = intval(defaults($_REQUEST, 'id', 0));
2233 $item = Item::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2235 if (!DBA::isResult($item)) {
2236 throw new BadRequestException("Invalid item.");
2241 $item['starred'] = 1;
2244 $item['starred'] = 0;
2247 throw new BadRequestException("Invalid action ".$action);
2250 $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2253 throw new InternalServerErrorException("DB error");
2257 $user_info = api_get_user($a);
2258 $rets = api_format_items([$item], $user_info, false, $type);
2261 $data = ['status' => $ret];
2265 $data = api_rss_extra($a, $data, $user_info);
2268 return api_format_data("status", $type, $data);
2271 /// @TODO move to top of file or somewhere better
2272 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2273 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2276 * Returns the most recent favorite statuses.
2278 * @param string $type Return type (atom, rss, xml, json)
2280 * @return string|array
2282 function api_favorites($type)
2287 $user_info = api_get_user($a);
2289 if (api_user() === false || $user_info === false) {
2290 throw new ForbiddenException();
2295 // in friendica starred item are private
2296 // return favorites only for self
2297 logger('api_favorites: self:' . $user_info['self']);
2299 if ($user_info['self'] == 0) {
2303 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2304 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2305 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
2306 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2311 $start = $page*$count;
2313 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2314 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2316 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2319 $condition[0] .= " AND `item`.`id` <= ?";
2320 $condition[] = $max_id;
2323 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2325 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2328 $data = ['status' => $ret];
2332 $data = api_rss_extra($a, $data, $user_info);
2335 return api_format_data("statuses", $type, $data);
2338 /// @TODO move to top of file or somewhere better
2339 api_register_func('api/favorites', 'api_favorites', true);
2343 * @param array $item
2344 * @param array $recipient
2345 * @param array $sender
2349 function api_format_messages($item, $recipient, $sender)
2351 // standard meta information
2353 'id' => $item['id'],
2354 'sender_id' => $sender['id'] ,
2356 'recipient_id' => $recipient['id'],
2357 'created_at' => api_date(defaults($item, 'created', DateTimeFormat::utcNow())),
2358 'sender_screen_name' => $sender['screen_name'],
2359 'recipient_screen_name' => $recipient['screen_name'],
2360 'sender' => $sender,
2361 'recipient' => $recipient,
2363 'friendica_seen' => defaults($item, 'seen', 0),
2364 'friendica_parent_uri' => defaults($item, 'parent-uri', ''),
2367 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2368 if (isset($ret['sender']['uid'])) {
2369 unset($ret['sender']['uid']);
2371 if (isset($ret['sender']['self'])) {
2372 unset($ret['sender']['self']);
2374 if (isset($ret['recipient']['uid'])) {
2375 unset($ret['recipient']['uid']);
2377 if (isset($ret['recipient']['self'])) {
2378 unset($ret['recipient']['self']);
2381 //don't send title to regular StatusNET requests to avoid confusing these apps
2382 if (x($_GET, 'getText')) {
2383 $ret['title'] = $item['title'];
2384 if ($_GET['getText'] == 'html') {
2385 $ret['text'] = BBCode::convert($item['body'], false);
2386 } elseif ($_GET['getText'] == 'plain') {
2387 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2390 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2392 if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') {
2393 unset($ret['sender']);
2394 unset($ret['recipient']);
2402 * @param array $item
2406 function api_convert_item($item)
2408 $body = $item['body'];
2409 $attachments = api_get_attachments($body);
2411 // Workaround for ostatus messages where the title is identically to the body
2412 $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2413 $statusbody = trim(HTML::toPlaintext($html, 0));
2415 // handle data: images
2416 $statusbody = api_format_items_embeded_images($item, $statusbody);
2418 $statustitle = trim($item['title']);
2420 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2421 $statustext = trim($statusbody);
2423 $statustext = trim($statustitle."\n\n".$statusbody);
2426 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($statustext)> 1000)) {
2427 $statustext = substr($statustext, 0, 1000) . "... \n" . defaults($item, 'plink', '');
2430 $statushtml = BBCode::convert(api_clean_attachments($body), false);
2432 // Workaround for clients with limited HTML parser functionality
2433 $search = ["<br>", "<blockquote>", "</blockquote>",
2434 "<h1>", "</h1>", "<h2>", "</h2>",
2435 "<h3>", "</h3>", "<h4>", "</h4>",
2436 "<h5>", "</h5>", "<h6>", "</h6>"];
2437 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2438 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2439 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2440 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2441 $statushtml = str_replace($search, $replace, $statushtml);
2443 if ($item['title'] != "") {
2444 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2448 $oldtext = $statushtml;
2449 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2450 } while ($oldtext != $statushtml);
2452 if (substr($statushtml, 0, 4) == '<br>') {
2453 $statushtml = substr($statushtml, 4);
2456 if (substr($statushtml, 0, -4) == '<br>') {
2457 $statushtml = substr($statushtml, -4);
2460 // feeds without body should contain the link
2461 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2462 $statushtml .= BBCode::convert($item['plink']);
2465 $entities = api_get_entitities($statustext, $body);
2468 "text" => $statustext,
2469 "html" => $statushtml,
2470 "attachments" => $attachments,
2471 "entities" => $entities
2477 * @param string $body
2481 function api_get_attachments(&$body)
2484 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2486 $URLSearchString = "^\[\]";
2487 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2495 foreach ($images[1] as $image) {
2496 $imagedata = Image::getInfoFromURL($image);
2499 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2503 if (strstr(defaults($_SERVER, 'HTTP_USER_AGENT', ''), "AndStatus")) {
2504 foreach ($images[0] as $orig) {
2505 $body = str_replace($orig, "", $body);
2509 return $attachments;
2514 * @param string $text
2515 * @param string $bbcode
2518 * @todo Links at the first character of the post
2520 function api_get_entitities(&$text, $bbcode)
2522 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
2524 if ($include_entities != "true") {
2525 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2527 foreach ($images[1] as $image) {
2528 $replace = ProxyUtils::proxifyUrl($image);
2529 $text = str_replace($image, $replace, $text);
2534 $bbcode = BBCode::cleanPictureLinks($bbcode);
2536 // Change pure links in text to bbcode uris
2537 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2540 $entities["hashtags"] = [];
2541 $entities["symbols"] = [];
2542 $entities["urls"] = [];
2543 $entities["user_mentions"] = [];
2545 $URLSearchString = "^\[\]";
2547 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2549 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2550 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2551 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2553 $bbcode = preg_replace(
2554 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2555 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2558 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2560 $bbcode = preg_replace(
2561 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2562 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2565 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2567 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2569 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2570 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2573 foreach ($urls[1] as $id => $url) {
2574 //$start = strpos($text, $url, $offset);
2575 $start = iconv_strpos($text, $url, 0, "UTF-8");
2576 if (!($start === false)) {
2577 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2581 ksort($ordered_urls);
2584 //foreach ($urls[1] AS $id=>$url) {
2585 foreach ($ordered_urls as $url) {
2586 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2587 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2589 $display_url = $url["title"];
2591 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2592 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2594 if (strlen($display_url) > 26) {
2595 $display_url = substr($display_url, 0, 25)."…";
2599 //$start = strpos($text, $url, $offset);
2600 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2601 if (!($start === false)) {
2602 $entities["urls"][] = ["url" => $url["url"],
2603 "expanded_url" => $url["url"],
2604 "display_url" => $display_url,
2605 "indices" => [$start, $start+strlen($url["url"])]];
2606 $offset = $start + 1;
2610 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2611 $ordered_images = [];
2612 foreach ($images[1] as $image) {
2613 //$start = strpos($text, $url, $offset);
2614 $start = iconv_strpos($text, $image, 0, "UTF-8");
2615 if (!($start === false)) {
2616 $ordered_images[$start] = $image;
2619 //$entities["media"] = array();
2622 foreach ($ordered_images as $url) {
2623 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2624 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2626 if (strlen($display_url) > 26) {
2627 $display_url = substr($display_url, 0, 25)."…";
2630 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2631 if (!($start === false)) {
2632 $image = Image::getInfoFromURL($url);
2634 // If image cache is activated, then use the following sizes:
2635 // thumb (150), small (340), medium (600) and large (1024)
2636 if (!Config::get("system", "proxy_disabled")) {
2637 $media_url = ProxyUtils::proxifyUrl($url);
2640 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2641 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2643 if (($image[0] > 150) || ($image[1] > 150)) {
2644 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2645 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2648 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2649 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2651 if (($image[0] > 600) || ($image[1] > 600)) {
2652 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2653 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2657 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2660 $entities["media"][] = [
2662 "id_str" => (string)$start+1,
2663 "indices" => [$start, $start+strlen($url)],
2664 "media_url" => normalise_link($media_url),
2665 "media_url_https" => $media_url,
2667 "display_url" => $display_url,
2668 "expanded_url" => $url,
2672 $offset = $start + 1;
2681 * @param array $item
2682 * @param string $text
2686 function api_format_items_embeded_images($item, $text)
2688 $text = preg_replace_callback(
2689 '|data:image/([^;]+)[^=]+=*|m',
2690 function () use ($item) {
2691 return System::baseUrl() . '/display/' . $item['guid'];
2699 * @brief return <a href='url'>name</a> as array
2701 * @param string $txt text
2706 function api_contactlink_to_array($txt)
2709 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2710 if ($r && count($match)==3) {
2712 'name' => $match[2],
2726 * @brief return likes, dislikes and attend status for item
2728 * @param array $item array
2729 * @param string $type Return type (atom, rss, xml, json)
2732 * likes => int count,
2733 * dislikes => int count
2735 function api_format_items_activities(&$item, $type = "json")
2744 'attendmaybe' => [],
2747 $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri']];
2748 $ret = Item::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2750 while ($item = Item::fetch($ret)) {
2751 // not used as result should be structured like other user data
2752 //builtin_activity_puller($i, $activities);
2754 // get user data and add it to the array of the activity
2755 $user = api_get_user($a, $item['author-id']);
2756 switch ($item['verb']) {
2758 $activities['like'][] = $user;
2760 case ACTIVITY_DISLIKE:
2761 $activities['dislike'][] = $user;
2763 case ACTIVITY_ATTEND:
2764 $activities['attendyes'][] = $user;
2766 case ACTIVITY_ATTENDNO:
2767 $activities['attendno'][] = $user;
2769 case ACTIVITY_ATTENDMAYBE:
2770 $activities['attendmaybe'][] = $user;
2779 if ($type == "xml") {
2780 $xml_activities = [];
2781 foreach ($activities as $k => $v) {
2782 // change xml element from "like" to "friendica:like"
2783 $xml_activities["friendica:".$k] = $v;
2784 // add user data into xml output
2786 foreach ($v as $user) {
2787 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2790 $activities = $xml_activities;
2798 * @brief return data from profiles
2800 * @param array $profile_row array containing data from db table 'profile'
2803 function api_format_items_profiles($profile_row)
2806 'profile_id' => $profile_row['id'],
2807 'profile_name' => $profile_row['profile-name'],
2808 'is_default' => $profile_row['is-default'] ? true : false,
2809 'hide_friends' => $profile_row['hide-friends'] ? true : false,
2810 'profile_photo' => $profile_row['photo'],
2811 'profile_thumb' => $profile_row['thumb'],
2812 'publish' => $profile_row['publish'] ? true : false,
2813 'net_publish' => $profile_row['net-publish'] ? true : false,
2814 'description' => $profile_row['pdesc'],
2815 'date_of_birth' => $profile_row['dob'],
2816 'address' => $profile_row['address'],
2817 'city' => $profile_row['locality'],
2818 'region' => $profile_row['region'],
2819 'postal_code' => $profile_row['postal-code'],
2820 'country' => $profile_row['country-name'],
2821 'hometown' => $profile_row['hometown'],
2822 'gender' => $profile_row['gender'],
2823 'marital' => $profile_row['marital'],
2824 'marital_with' => $profile_row['with'],
2825 'marital_since' => $profile_row['howlong'],
2826 'sexual' => $profile_row['sexual'],
2827 'politic' => $profile_row['politic'],
2828 'religion' => $profile_row['religion'],
2829 'public_keywords' => $profile_row['pub_keywords'],
2830 'private_keywords' => $profile_row['prv_keywords'],
2831 'likes' => BBCode::convert(api_clean_plain_items($profile_row['likes']) , false, 2),
2832 'dislikes' => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
2833 'about' => BBCode::convert(api_clean_plain_items($profile_row['about']) , false, 2),
2834 'music' => BBCode::convert(api_clean_plain_items($profile_row['music']) , false, 2),
2835 'book' => BBCode::convert(api_clean_plain_items($profile_row['book']) , false, 2),
2836 'tv' => BBCode::convert(api_clean_plain_items($profile_row['tv']) , false, 2),
2837 'film' => BBCode::convert(api_clean_plain_items($profile_row['film']) , false, 2),
2838 'interest' => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
2839 'romance' => BBCode::convert(api_clean_plain_items($profile_row['romance']) , false, 2),
2840 'work' => BBCode::convert(api_clean_plain_items($profile_row['work']) , false, 2),
2841 'education' => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
2842 'social_networks' => BBCode::convert(api_clean_plain_items($profile_row['contact']) , false, 2),
2843 'homepage' => $profile_row['homepage'],
2850 * @brief format items to be returned by api
2852 * @param array $r array of items
2853 * @param array $user_info
2854 * @param bool $filter_user filter items by $user_info
2855 * @param string $type Return type (atom, rss, xml, json)
2857 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
2863 foreach ($r as $item) {
2864 localize_item($item);
2865 list($status_user, $owner_user) = api_item_get_user($a, $item);
2867 // Look if the posts are matching if they should be filtered by user id
2868 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2872 $in_reply_to = api_in_reply_to($item);
2874 $converted = api_convert_item($item);
2876 if ($type == "xml") {
2877 $geo = "georss:point";
2883 'text' => $converted["text"],
2884 'truncated' => false,
2885 'created_at'=> api_date($item['created']),
2886 'in_reply_to_status_id' => $in_reply_to['status_id'],
2887 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
2888 'source' => (($item['app']) ? $item['app'] : 'web'),
2889 'id' => intval($item['id']),
2890 'id_str' => (string) intval($item['id']),
2891 'in_reply_to_user_id' => $in_reply_to['user_id'],
2892 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
2893 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
2895 'favorited' => $item['starred'] ? true : false,
2896 'user' => $status_user ,
2897 'friendica_owner' => $owner_user,
2898 'friendica_private' => $item['private'] == 1,
2899 //'entities' => NULL,
2900 'statusnet_html' => $converted["html"],
2901 'statusnet_conversation_id' => $item['parent'],
2902 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
2903 'friendica_activities' => api_format_items_activities($item, $type),
2906 if (count($converted["attachments"]) > 0) {
2907 $status["attachments"] = $converted["attachments"];
2910 if (count($converted["entities"]) > 0) {
2911 $status["entities"] = $converted["entities"];
2914 if ($status["source"] == 'web') {
2915 $status["source"] = ContactSelector::networkToName($item['network'], $user_info['url']);
2916 } elseif (ContactSelector::networkToName($item['network'], $user_info['url']) != $status["source"]) {
2917 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $user_info['url']).')');
2920 if ($item["id"] == $item["parent"]) {
2921 $retweeted_item = api_share_as_retweet($item);
2922 if ($retweeted_item !== false) {
2923 $retweeted_status = $status;
2925 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
2926 } catch (BadRequestException $e) {
2927 // user not found. should be found?
2928 /// @todo check if the user should be always found
2929 $retweeted_status["user"] = [];
2932 $rt_converted = api_convert_item($retweeted_item);
2934 $retweeted_status['text'] = $rt_converted["text"];
2935 $retweeted_status['statusnet_html'] = $rt_converted["html"];
2936 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
2937 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
2938 $status['retweeted_status'] = $retweeted_status;
2942 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2943 unset($status["user"]["uid"]);
2944 unset($status["user"]["self"]);
2946 if ($item["coord"] != "") {
2947 $coords = explode(' ', $item["coord"]);
2948 if (count($coords) == 2) {
2949 if ($type == "json") {
2950 $status["geo"] = ['type' => 'Point',
2951 'coordinates' => [(float) $coords[0],
2952 (float) $coords[1]]];
2953 } else {// Not sure if this is the official format - if someone founds a documentation we can check
2954 $status["georss:point"] = $item["coord"];
2964 * Returns the remaining number of API requests available to the user before the API limit is reached.
2966 * @param string $type Return type (atom, rss, xml, json)
2968 * @return array|string
2970 function api_account_rate_limit_status($type)
2972 if ($type == "xml") {
2974 'remaining-hits' => '150',
2975 '@attributes' => ["type" => "integer"],
2976 'hourly-limit' => '150',
2977 '@attributes2' => ["type" => "integer"],
2978 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
2979 '@attributes3' => ["type" => "datetime"],
2980 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2981 '@attributes4' => ["type" => "integer"],
2985 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2986 'remaining_hits' => '150',
2987 'hourly_limit' => '150',
2988 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
2992 return api_format_data('hash', $type, ['hash' => $hash]);
2995 /// @TODO move to top of file or somewhere better
2996 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
2999 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3001 * @param string $type Return type (atom, rss, xml, json)
3003 * @return array|string
3005 function api_help_test($type)
3007 if ($type == 'xml') {
3013 return api_format_data('ok', $type, ["ok" => $ok]);
3016 /// @TODO move to top of file or somewhere better
3017 api_register_func('api/help/test', 'api_help_test', false);
3020 * Returns all lists the user subscribes to.
3022 * @param string $type Return type (atom, rss, xml, json)
3024 * @return array|string
3025 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3027 function api_lists_list($type)
3030 /// @TODO $ret is not filled here?
3031 return api_format_data('lists', $type, ["lists_list" => $ret]);
3034 /// @TODO move to top of file or somewhere better
3035 api_register_func('api/lists/list', 'api_lists_list', true);
3036 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3039 * Returns all groups the user owns.
3041 * @param string $type Return type (atom, rss, xml, json)
3043 * @return array|string
3044 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3046 function api_lists_ownerships($type)
3050 if (api_user() === false) {
3051 throw new ForbiddenException();
3055 $user_info = api_get_user($a);
3056 $uid = $user_info['uid'];
3058 $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3060 // loop through all groups
3062 foreach ($groups as $group) {
3063 if ($group['visible']) {
3069 'name' => $group['name'],
3070 'id' => intval($group['id']),
3071 'id_str' => (string) $group['id'],
3072 'user' => $user_info,
3076 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3079 /// @TODO move to top of file or somewhere better
3080 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3083 * Returns recent statuses from users in the specified group.
3085 * @param string $type Return type (atom, rss, xml, json)
3087 * @return array|string
3088 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3090 function api_lists_statuses($type)
3094 $user_info = api_get_user($a);
3095 if (api_user() === false || $user_info === false) {
3096 throw new ForbiddenException();
3099 unset($_REQUEST["user_id"]);
3100 unset($_GET["user_id"]);
3102 unset($_REQUEST["screen_name"]);
3103 unset($_GET["screen_name"]);
3105 if (empty($_REQUEST['list_id'])) {
3106 throw new BadRequestException('list_id not specified');
3110 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
3111 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
3115 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3116 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3117 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
3118 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
3120 $start = $page * $count;
3122 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3123 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3126 $condition[0] .= " AND `item`.`id` <= ?";
3127 $condition[] = $max_id;
3129 if ($exclude_replies > 0) {
3130 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
3132 if ($conversation_id > 0) {
3133 $condition[0] .= " AND `item`.`parent` = ?";
3134 $condition[] = $conversation_id;
3137 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3138 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3140 $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3142 $data = ['status' => $items];
3146 $data = api_rss_extra($a, $data, $user_info);
3150 return api_format_data("statuses", $type, $data);
3153 /// @TODO move to top of file or somewhere better
3154 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3157 * Considers friends and followers lists to be private and won't return
3158 * anything if any user_id parameter is passed.
3160 * @brief Returns either the friends of the follower list
3162 * @param string $qtype Either "friends" or "followers"
3163 * @return boolean|array
3164 * @throws ForbiddenException
3166 function api_statuses_f($qtype)
3170 if (api_user() === false) {
3171 throw new ForbiddenException();
3175 $count = x($_GET, 'count') ? $_GET['count'] : 20;
3176 $page = x($_GET, 'page') ? $_GET['page'] : 1;
3180 $start = ($page - 1) * $count;
3182 $user_info = api_get_user($a);
3184 if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3185 /* this is to stop Hotot to load friends multiple times
3186 * I'm not sure if I'm missing return something or
3187 * is a bug in hotot. Workaround, meantime
3191 return array('$users' => $ret);*/
3196 if ($qtype == 'friends') {
3197 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
3198 } elseif ($qtype == 'followers') {
3199 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
3202 // friends and followers only for self
3203 if ($user_info['self'] == 0) {
3204 $sql_extra = " AND false ";
3207 if ($qtype == 'blocks') {
3208 $sql_filter = 'AND `blocked` AND NOT `pending`';
3209 } elseif ($qtype == 'incoming') {
3210 $sql_filter = 'AND `pending`';
3212 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3230 foreach ($r as $cid) {
3231 $user = api_get_user($a, $cid['nurl']);
3232 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3233 unset($user["uid"]);
3234 unset($user["self"]);
3241 return ['user' => $ret];
3246 * Returns the user's friends.
3248 * @brief Returns the list of friends of the provided user
3250 * @deprecated By Twitter API in favor of friends/list
3252 * @param string $type Either "json" or "xml"
3253 * @return boolean|string|array
3255 function api_statuses_friends($type)
3257 $data = api_statuses_f("friends");
3258 if ($data === false) {
3261 return api_format_data("users", $type, $data);
3265 * Returns the user's followers.
3267 * @brief Returns the list of followers of the provided user
3269 * @deprecated By Twitter API in favor of friends/list
3271 * @param string $type Either "json" or "xml"
3272 * @return boolean|string|array
3274 function api_statuses_followers($type)
3276 $data = api_statuses_f("followers");
3277 if ($data === false) {
3280 return api_format_data("users", $type, $data);
3283 /// @TODO move to top of file or somewhere better
3284 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3285 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3288 * Returns the list of blocked users
3290 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3292 * @param string $type Either "json" or "xml"
3294 * @return boolean|string|array
3296 function api_blocks_list($type)
3298 $data = api_statuses_f('blocks');
3299 if ($data === false) {
3302 return api_format_data("users", $type, $data);
3305 /// @TODO move to top of file or somewhere better
3306 api_register_func('api/blocks/list', 'api_blocks_list', true);
3309 * Returns the list of pending users IDs
3311 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3313 * @param string $type Either "json" or "xml"
3315 * @return boolean|string|array
3317 function api_friendships_incoming($type)
3319 $data = api_statuses_f('incoming');
3320 if ($data === false) {
3325 foreach ($data['user'] as $user) {
3326 $ids[] = $user['id'];
3329 return api_format_data("ids", $type, ['id' => $ids]);
3332 /// @TODO move to top of file or somewhere better
3333 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3336 * Returns the instance's configuration information.
3338 * @param string $type Return type (atom, rss, xml, json)
3340 * @return array|string
3342 function api_statusnet_config($type)
3346 $name = Config::get('config', 'sitename');
3347 $server = $a->get_hostname();
3348 $logo = System::baseUrl() . '/images/friendica-64.png';
3349 $email = Config::get('config', 'admin_email');
3350 $closed = intval(Config::get('config', 'register_policy')) === REGISTER_CLOSED ? 'true' : 'false';
3351 $private = Config::get('system', 'block_public') ? 'true' : 'false';
3352 $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000));
3353 $ssl = Config::get('system', 'have_ssl') ? 'true' : 'false';
3354 $sslserver = Config::get('system', 'have_ssl') ? str_replace('http:', 'https:', System::baseUrl()) : '';
3357 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3358 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3359 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3360 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3361 'shorturllength' => '30',
3363 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3364 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3365 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3366 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3371 return api_format_data('config', $type, ['config' => $config]);
3374 /// @TODO move to top of file or somewhere better
3375 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3376 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3380 * @param string $type Return type (atom, rss, xml, json)
3382 * @return array|string
3384 function api_statusnet_version($type)
3387 $fake_statusnet_version = "0.9.7";
3389 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3392 /// @TODO move to top of file or somewhere better
3393 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3394 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3398 * @param string $type Return type (atom, rss, xml, json)
3400 * @todo use api_format_data() to return data
3402 function api_ff_ids($type)
3405 throw new ForbiddenException();
3412 $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3415 "SELECT `pcontact`.`id` FROM `contact`
3416 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3417 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3420 if (!DBA::isResult($r)) {
3425 foreach ($r as $rr) {
3426 if ($stringify_ids) {
3429 $ids[] = intval($rr['id']);
3433 return api_format_data("ids", $type, ['id' => $ids]);
3437 * Returns the ID of every user the user is following.
3439 * @param string $type Return type (atom, rss, xml, json)
3441 * @return array|string
3442 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3444 function api_friends_ids($type)
3446 return api_ff_ids($type);
3450 * Returns the ID of every user following the user.
3452 * @param string $type Return type (atom, rss, xml, json)
3454 * @return array|string
3455 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3457 function api_followers_ids($type)
3459 return api_ff_ids($type);
3462 /// @TODO move to top of file or somewhere better
3463 api_register_func('api/friends/ids', 'api_friends_ids', true);
3464 api_register_func('api/followers/ids', 'api_followers_ids', true);
3467 * Sends a new direct message.
3469 * @param string $type Return type (atom, rss, xml, json)
3471 * @return array|string
3472 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3474 function api_direct_messages_new($type)
3478 if (api_user() === false) {
3479 throw new ForbiddenException();
3482 if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3486 $sender = api_get_user($a);
3489 if (!empty($_POST['screen_name'])) {
3491 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3493 DBA::escape($_POST['screen_name'])
3496 if (DBA::isResult($r)) {
3497 // Selecting the id by priority, friendica first
3498 api_best_nickname($r);
3500 $recipient = api_get_user($a, $r[0]['nurl']);
3503 $recipient = api_get_user($a, $_POST['user_id']);
3506 if (empty($recipient)) {
3507 throw new NotFoundException('Recipient not found');
3512 if (x($_REQUEST, 'replyto')) {
3514 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3516 intval($_REQUEST['replyto'])
3518 $replyto = $r[0]['parent-uri'];
3519 $sub = $r[0]['title'];
3521 if (x($_REQUEST, 'title')) {
3522 $sub = $_REQUEST['title'];
3524 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3528 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3531 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3532 $ret = api_format_messages($r[0], $recipient, $sender);
3534 $ret = ["error"=>$id];
3537 $data = ['direct_message'=>$ret];
3542 $data = api_rss_extra($a, $data, $sender);
3545 return api_format_data("direct-messages", $type, $data);
3548 /// @TODO move to top of file or somewhere better
3549 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3552 * Destroys a direct message.
3554 * @brief delete a direct_message from mail table through api
3556 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3557 * @return string|array
3558 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3560 function api_direct_messages_destroy($type)
3564 if (api_user() === false) {
3565 throw new ForbiddenException();
3569 $user_info = api_get_user($a);
3571 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3573 $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3574 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3575 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3577 $uid = $user_info['uid'];
3578 // error if no id or parenturi specified (for clients posting parent-uri as well)
3579 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3580 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3581 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3584 // BadRequestException if no id specified (for clients using Twitter API)
3586 throw new BadRequestException('Message id not specified');
3589 // add parent-uri to sql command if specified by calling app
3590 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3592 // get data of the specified message id
3594 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3599 // error message if specified id is not in database
3600 if (!DBA::isResult($r)) {
3601 if ($verbose == "true") {
3602 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3603 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3605 /// @todo BadRequestException ok for Twitter API clients?
3606 throw new BadRequestException('message id not in database');
3611 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3616 if ($verbose == "true") {
3619 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3620 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3622 $answer = ['result' => 'error', 'message' => 'unknown error'];
3623 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3626 /// @todo return JSON data like Twitter API not yet implemented
3629 /// @TODO move to top of file or somewhere better
3630 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3635 * @brief unfollow contact
3637 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3638 * @return string|array
3639 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3641 function api_friendships_destroy($type)
3645 if ($uid === false) {
3646 throw new ForbiddenException();
3649 $contact_id = defaults($_REQUEST, 'user_id');
3651 if (empty($contact_id)) {
3652 logger("No user_id specified", LOGGER_DEBUG);
3653 throw new BadRequestException("no user_id specified");
3656 // Get Contact by given id
3657 $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3659 if(!DBA::isResult($contact)) {
3660 logger("No contact found for ID" . $contact_id, LOGGER_DEBUG);
3661 throw new NotFoundException("no contact found to given ID");
3664 $url = $contact["url"];
3666 $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3667 $uid, Contact::SHARING, Contact::FRIEND, normalise_link($url),
3668 normalise_link($url), $url];
3669 $contact = DBA::selectFirst('contact', [], $condition);
3671 if (!DBA::isResult($contact)) {
3672 logger("Not following Contact", LOGGER_DEBUG);
3673 throw new NotFoundException("Not following Contact");
3676 if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
3677 logger("Not supported", LOGGER_DEBUG);
3678 throw new ExpectationFailedException("Not supported");
3681 $dissolve = ($contact['rel'] == Contact::SHARING);
3683 $owner = User::getOwnerDataById($uid);
3685 Contact::terminateFriendship($owner, $contact, $dissolve);
3688 logger("No owner found", LOGGER_DEBUG);
3689 throw new NotFoundException("Error Processing Request");
3692 // Sharing-only contacts get deleted as there no relationship any more
3694 Contact::remove($contact['id']);
3696 DBA::update('contact', ['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
3699 $answer = ['result' => 'ok', 'user_id' => $contact_id, 'contact' => 'contact deleted'];
3700 return api_format_data("friendships-destroy", $type, ['result' => $answer]);
3702 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3706 * @param string $type Return type (atom, rss, xml, json)
3707 * @param string $box
3708 * @param string $verbose
3710 * @return array|string
3712 function api_direct_messages_box($type, $box, $verbose)
3715 if (api_user() === false) {
3716 throw new ForbiddenException();
3719 $count = defaults($_GET, 'count', 20);
3720 $page = defaults($_REQUEST, 'page', 1) - 1;
3725 $since_id = defaults($_REQUEST, 'since_id', 0);
3726 $max_id = defaults($_REQUEST, 'max_id', 0);
3728 $user_id = defaults($_REQUEST, 'user_id', '');
3729 $screen_name = defaults($_REQUEST, 'screen_name', '');
3732 unset($_REQUEST["user_id"]);
3733 unset($_GET["user_id"]);
3735 unset($_REQUEST["screen_name"]);
3736 unset($_GET["screen_name"]);
3738 $user_info = api_get_user($a);
3739 if ($user_info === false) {
3740 throw new ForbiddenException();
3742 $profile_url = $user_info["url"];
3745 $start = $page * $count;
3750 if ($box=="sentbox") {
3751 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
3752 } elseif ($box == "conversation") {
3753 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape(defaults($_GET, 'uri', '')) . "'";
3754 } elseif ($box == "all") {
3755 $sql_extra = "true";
3756 } elseif ($box == "inbox") {
3757 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
3761 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3764 if ($user_id != "") {
3765 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3766 } elseif ($screen_name !="") {
3767 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
3771 "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",
3777 if ($verbose == "true" && !DBA::isResult($r)) {
3778 $answer = ['result' => 'error', 'message' => 'no mails available'];
3779 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3783 foreach ($r as $item) {
3784 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3785 $recipient = $user_info;
3786 $sender = api_get_user($a, normalise_link($item['contact-url']));
3787 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3788 $recipient = api_get_user($a, normalise_link($item['contact-url']));
3789 $sender = $user_info;
3792 if (isset($recipient) && isset($sender)) {
3793 $ret[] = api_format_messages($item, $recipient, $sender);
3798 $data = ['direct_message' => $ret];
3802 $data = api_rss_extra($a, $data, $user_info);
3805 return api_format_data("direct-messages", $type, $data);
3809 * Returns the most recent direct messages sent by the user.
3811 * @param string $type Return type (atom, rss, xml, json)
3813 * @return array|string
3814 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3816 function api_direct_messages_sentbox($type)
3818 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3819 return api_direct_messages_box($type, "sentbox", $verbose);
3823 * Returns the most recent direct messages sent to the user.
3825 * @param string $type Return type (atom, rss, xml, json)
3827 * @return array|string
3828 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3830 function api_direct_messages_inbox($type)
3832 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3833 return api_direct_messages_box($type, "inbox", $verbose);
3838 * @param string $type Return type (atom, rss, xml, json)
3840 * @return array|string
3842 function api_direct_messages_all($type)
3844 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3845 return api_direct_messages_box($type, "all", $verbose);
3850 * @param string $type Return type (atom, rss, xml, json)
3852 * @return array|string
3854 function api_direct_messages_conversation($type)
3856 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3857 return api_direct_messages_box($type, "conversation", $verbose);
3860 /// @TODO move to top of file or somewhere better
3861 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3862 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3863 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3864 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3867 * Returns an OAuth Request Token.
3869 * @see https://oauth.net/core/1.0/#auth_step1
3871 function api_oauth_request_token()
3873 $oauth1 = new FKOAuth1();
3875 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
3876 } catch (Exception $e) {
3877 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
3885 * Returns an OAuth Access Token.
3887 * @return array|string
3888 * @see https://oauth.net/core/1.0/#auth_step3
3890 function api_oauth_access_token()
3892 $oauth1 = new FKOAuth1();
3894 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
3895 } catch (Exception $e) {
3896 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
3903 /// @TODO move to top of file or somewhere better
3904 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
3905 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
3909 * @brief delete a complete photoalbum with all containing photos from database through api
3911 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3912 * @return string|array
3914 function api_fr_photoalbum_delete($type)
3916 if (api_user() === false) {
3917 throw new ForbiddenException();
3920 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3922 // we do not allow calls without album string
3924 throw new BadRequestException("no albumname specified");
3926 // check if album is existing
3928 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3932 if (!DBA::isResult($r)) {
3933 throw new BadRequestException("album not available");
3936 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
3937 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
3938 foreach ($r as $rr) {
3939 $condition = ['uid' => local_user(), 'resource-id' => $rr['resource-id'], 'type' => 'photo'];
3940 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
3942 if (!DBA::isResult($photo_item)) {
3943 throw new InternalServerErrorException("problem with deleting items occured");
3945 Item::deleteForUser(['id' => $photo_item['id']], api_user());
3948 // now let's delete all photos from the album
3949 $result = DBA::delete('photo', ['uid' => api_user(), 'album' => $album]);
3951 // return success of deletion or error message
3953 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
3954 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
3956 throw new InternalServerErrorException("unknown error - deleting from database failed");
3961 * @brief update the name of the album for all photos of an album
3963 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3964 * @return string|array
3966 function api_fr_photoalbum_update($type)
3968 if (api_user() === false) {
3969 throw new ForbiddenException();
3972 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3973 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
3975 // we do not allow calls without album string
3977 throw new BadRequestException("no albumname specified");
3979 if ($album_new == "") {
3980 throw new BadRequestException("no new albumname specified");
3982 // check if album is existing
3983 if (!DBA::exists('photo', ['uid' => api_user(), 'album' => $album])) {
3984 throw new BadRequestException("album not available");
3986 // now let's update all photos to the albumname
3987 $result = DBA::update('photo', ['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
3989 // return success of updating or error message
3991 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
3992 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
3994 throw new InternalServerErrorException("unknown error - updating in database failed");
4000 * @brief list all photos of the authenticated user
4002 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4003 * @return string|array
4005 function api_fr_photos_list($type)
4007 if (api_user() === false) {
4008 throw new ForbiddenException();
4011 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4012 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4013 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
4014 intval(local_user())
4017 'image/jpeg' => 'jpg',
4018 'image/png' => 'png',
4019 'image/gif' => 'gif'
4021 $data = ['photo'=>[]];
4022 if (DBA::isResult($r)) {
4023 foreach ($r as $rr) {
4025 $photo['id'] = $rr['resource-id'];
4026 $photo['album'] = $rr['album'];
4027 $photo['filename'] = $rr['filename'];
4028 $photo['type'] = $rr['type'];
4029 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4030 $photo['created'] = $rr['created'];
4031 $photo['edited'] = $rr['edited'];
4032 $photo['desc'] = $rr['desc'];
4034 if ($type == "xml") {
4035 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4037 $photo['thumb'] = $thumb;
4038 $data['photo'][] = $photo;
4042 return api_format_data("photos", $type, $data);
4046 * @brief upload a new photo or change an existing photo
4048 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4049 * @return string|array
4051 function api_fr_photo_create_update($type)
4053 if (api_user() === false) {
4054 throw new ForbiddenException();
4057 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4058 $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
4059 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
4060 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
4061 $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
4062 $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
4063 $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
4064 $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
4065 $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
4067 // do several checks on input parameters
4068 // we do not allow calls without album string
4069 if ($album == null) {
4070 throw new BadRequestException("no albumname specified");
4072 // if photo_id == null --> we are uploading a new photo
4073 if ($photo_id == null) {
4076 // error if no media posted in create-mode
4077 if (!x($_FILES, 'media')) {
4079 throw new BadRequestException("no media data submitted");
4082 // album_new will be ignored in create-mode
4087 // check if photo is existing in database
4089 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4091 DBA::escape($photo_id),
4094 if (!DBA::isResult($r)) {
4095 throw new BadRequestException("photo not available");
4099 // checks on acl strings provided by clients
4100 $acl_input_error = false;
4101 $acl_input_error |= check_acl_input($allow_cid);
4102 $acl_input_error |= check_acl_input($deny_cid);
4103 $acl_input_error |= check_acl_input($allow_gid);
4104 $acl_input_error |= check_acl_input($deny_gid);
4105 if ($acl_input_error) {
4106 throw new BadRequestException("acl data invalid");
4108 // now let's upload the new media in create-mode
4109 if ($mode == "create") {
4110 $media = $_FILES['media'];
4111 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4113 // return success of updating or error message
4114 if (!is_null($data)) {
4115 return api_format_data("photo_create", $type, $data);
4117 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4121 // now let's do the changes in update-mode
4122 if ($mode == "update") {
4125 if (!is_null($desc)) {
4126 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
4129 if (!is_null($album_new)) {
4130 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
4133 if (!is_null($allow_cid)) {
4134 $allow_cid = trim($allow_cid);
4135 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
4138 if (!is_null($deny_cid)) {
4139 $deny_cid = trim($deny_cid);
4140 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
4143 if (!is_null($allow_gid)) {
4144 $allow_gid = trim($allow_gid);
4145 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
4148 if (!is_null($deny_gid)) {
4149 $deny_gid = trim($deny_gid);
4150 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
4154 if ($sql_extra != "") {
4155 $nothingtodo = false;
4157 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4159 DateTimeFormat::utcNow(), // update edited timestamp
4161 DBA::escape($photo_id),
4165 $nothingtodo = true;
4168 if (x($_FILES, 'media')) {
4169 $nothingtodo = false;
4170 $media = $_FILES['media'];
4171 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4172 if (!is_null($data)) {
4173 return api_format_data("photo_update", $type, $data);
4177 // return success of updating or error message
4179 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4180 return api_format_data("photo_update", $type, ['$result' => $answer]);
4183 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4184 return api_format_data("photo_update", $type, ['$result' => $answer]);
4186 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4189 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4193 * @brief delete a single photo from the database through api
4195 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4196 * @return string|array
4198 function api_fr_photo_delete($type)
4200 if (api_user() === false) {
4201 throw new ForbiddenException();
4204 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4206 // do several checks on input parameters
4207 // we do not allow calls without photo id
4208 if ($photo_id == null) {
4209 throw new BadRequestException("no photo_id specified");
4211 // check if photo is existing in database
4213 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4215 DBA::escape($photo_id)
4217 if (!DBA::isResult($r)) {
4218 throw new BadRequestException("photo not available");
4220 // now we can perform on the deletion of the photo
4221 $result = DBA::delete('photo', ['uid' => api_user(), 'resource-id' => $photo_id]);
4223 // return success of deletion or error message
4225 // retrieve the id of the parent element (the photo element)
4226 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4227 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4229 if (!DBA::isResult($photo_item)) {
4230 throw new InternalServerErrorException("problem with deleting items occured");
4232 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4233 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4234 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4236 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4237 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4239 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4245 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4247 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4248 * @return string|array
4250 function api_fr_photo_detail($type)
4252 if (api_user() === false) {
4253 throw new ForbiddenException();
4255 if (!x($_REQUEST, 'photo_id')) {
4256 throw new BadRequestException("No photo id.");
4259 $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4260 $photo_id = $_REQUEST['photo_id'];
4262 // prepare json/xml output with data from database for the requested photo
4263 $data = prepare_photo_data($type, $scale, $photo_id);
4265 return api_format_data("photo_detail", $type, $data);
4270 * Updates the user’s profile image.
4272 * @brief updates the profile image for the user (either a specified profile or the default profile)
4274 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4276 * @return string|array
4277 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4279 function api_account_update_profile_image($type)
4281 if (api_user() === false) {
4282 throw new ForbiddenException();
4285 $profile_id = defaults($_REQUEST, 'profile_id', 0);
4287 // error if image data is missing
4288 if (!x($_FILES, 'image')) {
4289 throw new BadRequestException("no media data submitted");
4292 // check if specified profile id is valid
4293 if ($profile_id != 0) {
4294 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4295 // error message if specified profile id is not in database
4296 if (!DBA::isResult($profile)) {
4297 throw new BadRequestException("profile_id not available");
4299 $is_default_profile = $profile['is-default'];
4301 $is_default_profile = 1;
4304 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4306 if (x($_FILES, 'image')) {
4307 $media = $_FILES['image'];
4308 } elseif (x($_FILES, 'media')) {
4309 $media = $_FILES['media'];
4311 // save new profile image
4312 $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4315 if (is_array($media['type'])) {
4316 $filetype = $media['type'][0];
4318 $filetype = $media['type'];
4320 if ($filetype == "image/jpeg") {
4322 } elseif ($filetype == "image/png") {
4325 throw new InternalServerErrorException('Unsupported filetype');
4328 // change specified profile or all profiles to the new resource-id
4329 if ($is_default_profile) {
4330 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4331 DBA::update('photo', ['profile' => false], $condition);
4333 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype,
4334 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype];
4335 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4338 Contact::updateSelfFromUserID(api_user(), true);
4340 // Update global directory in background
4341 $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4342 if ($url && strlen(Config::get('system', 'directory'))) {
4343 Worker::add(PRIORITY_LOW, "Directory", $url);
4346 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4348 // output for client
4350 return api_account_verify_credentials($type);
4352 // SaveMediaToDatabase failed for some reason
4353 throw new InternalServerErrorException("image upload failed");
4357 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4358 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4359 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4360 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4361 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4362 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4363 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4364 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4365 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4368 * Update user profile
4370 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4372 * @return array|string
4374 function api_account_update_profile($type)
4376 $local_user = api_user();
4377 $api_user = api_get_user(get_app());
4379 if (!empty($_POST['name'])) {
4380 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4381 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4382 DBA::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4383 DBA::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4386 if (isset($_POST['description'])) {
4387 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4388 DBA::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4389 DBA::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4392 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4393 // Update global directory in background
4394 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4395 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4398 return api_account_verify_credentials($type);
4401 /// @TODO move to top of file or somewhere better
4402 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4406 * @param string $acl_string
4408 function check_acl_input($acl_string)
4410 if ($acl_string == null || $acl_string == " ") {
4413 $contact_not_found = false;
4415 // split <x><y><z> into array of cid's
4416 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4418 // check for each cid if it is available on server
4419 $cid_array = $array[0];
4420 foreach ($cid_array as $cid) {
4421 $cid = str_replace("<", "", $cid);
4422 $cid = str_replace(">", "", $cid);
4423 $condition = ['id' => $cid, 'uid' => api_user()];
4424 $contact_not_found |= !DBA::exists('contact', $condition);
4426 return $contact_not_found;
4431 * @param string $mediatype
4432 * @param array $media
4433 * @param string $type
4434 * @param string $album
4435 * @param string $allow_cid
4436 * @param string $deny_cid
4437 * @param string $allow_gid
4438 * @param string $deny_gid
4439 * @param string $desc
4440 * @param integer $profile
4441 * @param boolean $visibility
4442 * @param string $photo_id
4444 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)
4452 if (is_array($media)) {
4453 if (is_array($media['tmp_name'])) {
4454 $src = $media['tmp_name'][0];
4456 $src = $media['tmp_name'];
4458 if (is_array($media['name'])) {
4459 $filename = basename($media['name'][0]);
4461 $filename = basename($media['name']);
4463 if (is_array($media['size'])) {
4464 $filesize = intval($media['size'][0]);
4466 $filesize = intval($media['size']);
4468 if (is_array($media['type'])) {
4469 $filetype = $media['type'][0];
4471 $filetype = $media['type'];
4475 if ($filetype == "") {
4476 $filetype=Image::guessType($filename);
4478 $imagedata = @getimagesize($src);
4480 $filetype = $imagedata['mime'];
4483 "File upload src: " . $src . " - filename: " . $filename .
4484 " - size: " . $filesize . " - type: " . $filetype,
4488 // check if there was a php upload error
4489 if ($filesize == 0 && $media['error'] == 1) {
4490 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4492 // check against max upload size within Friendica instance
4493 $maximagesize = Config::get('system', 'maximagesize');
4494 if ($maximagesize && ($filesize > $maximagesize)) {
4495 $formattedBytes = formatBytes($maximagesize);
4496 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4499 // create Photo instance with the data of the image
4500 $imagedata = @file_get_contents($src);
4501 $Image = new Image($imagedata, $filetype);
4502 if (! $Image->isValid()) {
4503 throw new InternalServerErrorException("unable to process image data");
4506 // check orientation of image
4507 $Image->orient($src);
4510 // check max length of images on server
4511 $max_length = Config::get('system', 'max_image_length');
4512 if (! $max_length) {
4513 $max_length = MAX_IMAGE_LENGTH;
4515 if ($max_length > 0) {
4516 $Image->scaleDown($max_length);
4517 logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG);
4519 $width = $Image->getWidth();
4520 $height = $Image->getHeight();
4522 // create a new resource-id if not already provided
4523 $hash = ($photo_id == null) ? Photo::newResource() : $photo_id;
4525 if ($mediatype == "photo") {
4526 // upload normal image (scales 0, 1, 2)
4527 logger("photo upload: starting new photo upload", LOGGER_DEBUG);
4529 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4531 logger("photo upload: image upload with scale 0 (original size) failed");
4533 if ($width > 640 || $height > 640) {
4534 $Image->scaleDown(640);
4535 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4537 logger("photo upload: image upload with scale 1 (640x640) failed");
4541 if ($width > 320 || $height > 320) {
4542 $Image->scaleDown(320);
4543 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4545 logger("photo upload: image upload with scale 2 (320x320) failed");
4548 logger("photo upload: new photo upload ended", LOGGER_DEBUG);
4549 } elseif ($mediatype == "profileimage") {
4550 // upload profile image (scales 4, 5, 6)
4551 logger("photo upload: starting new profile image upload", LOGGER_DEBUG);
4553 if ($width > 175 || $height > 175) {
4554 $Image->scaleDown(175);
4555 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4557 logger("photo upload: profile image upload with scale 4 (175x175) failed");
4561 if ($width > 80 || $height > 80) {
4562 $Image->scaleDown(80);
4563 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4565 logger("photo upload: profile image upload with scale 5 (80x80) failed");
4569 if ($width > 48 || $height > 48) {
4570 $Image->scaleDown(48);
4571 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4573 logger("photo upload: profile image upload with scale 6 (48x48) failed");
4576 $Image->__destruct();
4577 logger("photo upload: new profile image upload ended", LOGGER_DEBUG);
4580 if (isset($r) && $r) {
4581 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4582 if ($photo_id == null && $mediatype == "photo") {
4583 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4585 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4586 return prepare_photo_data($type, false, $hash);
4588 throw new InternalServerErrorException("image upload failed");
4594 * @param string $hash
4595 * @param string $allow_cid
4596 * @param string $deny_cid
4597 * @param string $allow_gid
4598 * @param string $deny_gid
4599 * @param string $filetype
4600 * @param boolean $visibility
4602 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4604 // get data about the api authenticated user
4605 $uri = Item::newURI(intval(api_user()));
4606 $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
4609 $arr['guid'] = System::createGUID(32);
4610 $arr['uid'] = intval(api_user());
4612 $arr['parent-uri'] = $uri;
4613 $arr['type'] = 'photo';
4615 $arr['resource-id'] = $hash;
4616 $arr['contact-id'] = $owner_record['id'];
4617 $arr['owner-name'] = $owner_record['name'];
4618 $arr['owner-link'] = $owner_record['url'];
4619 $arr['owner-avatar'] = $owner_record['thumb'];
4620 $arr['author-name'] = $owner_record['name'];
4621 $arr['author-link'] = $owner_record['url'];
4622 $arr['author-avatar'] = $owner_record['thumb'];
4624 $arr['allow_cid'] = $allow_cid;
4625 $arr['allow_gid'] = $allow_gid;
4626 $arr['deny_cid'] = $deny_cid;
4627 $arr['deny_gid'] = $deny_gid;
4628 $arr['visible'] = $visibility;
4632 'image/jpeg' => 'jpg',
4633 'image/png' => 'png',
4634 'image/gif' => 'gif'
4637 // adds link to the thumbnail scale photo
4638 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
4639 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4642 // do the magic for storing the item in the database and trigger the federation to other contacts
4648 * @param string $type
4650 * @param string $photo_id
4654 function prepare_photo_data($type, $scale, $photo_id)
4657 $user_info = api_get_user($a);
4659 if ($user_info === false) {
4660 throw new ForbiddenException();
4663 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4664 $data_sql = ($scale === false ? "" : "data, ");
4666 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4667 // clients needs to convert this in their way for further processing
4669 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4670 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4671 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4672 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4674 intval(local_user()),
4675 DBA::escape($photo_id),
4680 'image/jpeg' => 'jpg',
4681 'image/png' => 'png',
4682 'image/gif' => 'gif'
4685 // prepare output data for photo
4686 if (DBA::isResult($r)) {
4687 $data = ['photo' => $r[0]];
4688 $data['photo']['id'] = $data['photo']['resource-id'];
4689 if ($scale !== false) {
4690 $data['photo']['data'] = base64_encode($data['photo']['data']);
4692 unset($data['photo']['datasize']); //needed only with scale param
4694 if ($type == "xml") {
4695 $data['photo']['links'] = [];
4696 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4697 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4699 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4702 $data['photo']['link'] = [];
4703 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4705 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4706 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4710 unset($data['photo']['resource-id']);
4711 unset($data['photo']['minscale']);
4712 unset($data['photo']['maxscale']);
4714 throw new NotFoundException();
4717 // retrieve item element for getting activities (like, dislike etc.) related to photo
4718 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4719 $item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4721 $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4723 // retrieve comments on photo
4724 $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
4725 $item[0]['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4727 $statuses = Item::selectForUser(api_user(), [], $condition);
4729 // prepare output of comments
4730 $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
4732 if ($type == "xml") {
4734 foreach ($commentData as $comment) {
4735 $comments[$k++ . ":comment"] = $comment;
4738 foreach ($commentData as $comment) {
4739 $comments[] = $comment;
4742 $data['photo']['friendica_comments'] = $comments;
4744 // include info if rights on photo and rights on item are mismatching
4745 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4746 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4747 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4748 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4749 $data['photo']['rights_mismatch'] = $rights_mismatch;
4756 * Similar as /mod/redir.php
4757 * redirect to 'url' after dfrn auth
4759 * Why this when there is mod/redir.php already?
4760 * This use api_user() and api_login()
4763 * c_url: url of remote contact to auth to
4764 * url: string, url to redirect after auth
4766 function api_friendica_remoteauth()
4768 $url = (x($_GET, 'url') ? $_GET['url'] : '');
4769 $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : '');
4771 if ($url === '' || $c_url === '') {
4772 throw new BadRequestException("Wrong parameters.");
4775 $c_url = normalise_link($c_url);
4779 $contact = DBA::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4781 if (!DBA::isResult($contact) || ($contact['network'] !== Protocol::DFRN)) {
4782 throw new BadRequestException("Unknown contact");
4785 $cid = $contact['id'];
4787 $dfrn_id = defaults($contact, 'issued-id', $contact['dfrn-id']);
4789 if ($contact['duplex'] && $contact['issued-id']) {
4790 $orig_id = $contact['issued-id'];
4791 $dfrn_id = '1:' . $orig_id;
4793 if ($contact['duplex'] && $contact['dfrn-id']) {
4794 $orig_id = $contact['dfrn-id'];
4795 $dfrn_id = '0:' . $orig_id;
4798 $sec = random_string();
4800 $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
4801 'sec' => $sec, 'expire' => time() + 45];
4802 DBA::insert('profile_check', $fields);
4804 logger($contact['name'] . ' ' . $sec, LOGGER_DEBUG);
4805 $dest = ($url ? '&destination_url=' . $url : '');
4807 $contact['poll'] . '?dfrn_id=' . $dfrn_id
4808 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4809 . '&type=profile&sec=' . $sec . $dest
4812 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4815 * @brief Return the item shared, if the item contains only the [share] tag
4817 * @param array $item Sharer item
4818 * @return array|false Shared item or false if not a reshare
4820 function api_share_as_retweet(&$item)
4822 $body = trim($item["body"]);
4824 if (Diaspora::isReshare($body, false)===false) {
4828 /// @TODO "$1" should maybe mean '$1' ?
4829 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
4831 * Skip if there is no shared message in there
4832 * we already checked this in diaspora::isReshare()
4833 * but better one more than one less...
4835 if ($body == $attributes) {
4840 // build the fake reshared item
4841 $reshared_item = $item;
4844 preg_match("/author='(.*?)'/ism", $attributes, $matches);
4845 if ($matches[1] != "") {
4846 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
4849 preg_match('/author="(.*?)"/ism', $attributes, $matches);
4850 if ($matches[1] != "") {
4851 $author = $matches[1];
4855 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
4856 if ($matches[1] != "") {
4857 $profile = $matches[1];
4860 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
4861 if ($matches[1] != "") {
4862 $profile = $matches[1];
4866 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
4867 if ($matches[1] != "") {
4868 $avatar = $matches[1];
4871 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
4872 if ($matches[1] != "") {
4873 $avatar = $matches[1];
4877 preg_match("/link='(.*?)'/ism", $attributes, $matches);
4878 if ($matches[1] != "") {
4879 $link = $matches[1];
4882 preg_match('/link="(.*?)"/ism', $attributes, $matches);
4883 if ($matches[1] != "") {
4884 $link = $matches[1];
4888 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
4889 if ($matches[1] != "") {
4890 $posted = $matches[1];
4893 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
4894 if ($matches[1] != "") {
4895 $posted = $matches[1];
4898 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
4900 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
4904 $reshared_item["body"] = $shared_body;
4905 $reshared_item["author-name"] = $author;
4906 $reshared_item["author-link"] = $profile;
4907 $reshared_item["author-avatar"] = $avatar;
4908 $reshared_item["plink"] = $link;
4909 $reshared_item["created"] = $posted;
4910 $reshared_item["edited"] = $posted;
4912 return $reshared_item;
4917 * @param string $profile
4919 * @return string|false
4920 * @todo remove trailing junk from profile url
4921 * @todo pump.io check has to check the website
4923 function api_get_nick($profile)
4928 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4929 DBA::escape(normalise_link($profile))
4932 if (DBA::isResult($r)) {
4933 $nick = $r[0]["nick"];
4938 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4939 DBA::escape(normalise_link($profile))
4942 if (DBA::isResult($r)) {
4943 $nick = $r[0]["nick"];
4948 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
4949 if ($friendica != $profile) {
4955 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
4956 if ($diaspora != $profile) {
4962 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
4963 if ($twitter != $profile) {
4970 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
4971 if ($StatusnetHost != $profile) {
4972 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
4973 if ($StatusnetUser != $profile) {
4974 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
4975 $user = json_decode($UserData);
4977 $nick = $user->screen_name;
4983 // To-Do: look at the page if its really a pumpio site
4984 //if (!$nick == "") {
4985 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
4986 // if ($pumpio != $profile)
4988 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5001 * @param array $item
5005 function api_in_reply_to($item)
5009 $in_reply_to['status_id'] = null;
5010 $in_reply_to['user_id'] = null;
5011 $in_reply_to['status_id_str'] = null;
5012 $in_reply_to['user_id_str'] = null;
5013 $in_reply_to['screen_name'] = null;
5015 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5016 $parent = Item::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
5017 if (DBA::isResult($parent)) {
5018 $in_reply_to['status_id'] = intval($parent['id']);
5020 $in_reply_to['status_id'] = intval($item['parent']);
5023 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5025 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
5026 $parent = Item::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
5028 if (DBA::isResult($parent)) {
5029 if ($parent['author-nick'] == "") {
5030 $parent['author-nick'] = api_get_nick($parent['author-link']);
5033 $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
5034 $in_reply_to['user_id'] = intval($parent['author-id']);
5035 $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
5038 // There seems to be situation, where both fields are identical:
5039 // https://github.com/friendica/friendica/issues/1010
5040 // This is a bugfix for that.
5041 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5042 logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG);
5043 $in_reply_to['status_id'] = null;
5044 $in_reply_to['user_id'] = null;
5045 $in_reply_to['status_id_str'] = null;
5046 $in_reply_to['user_id_str'] = null;
5047 $in_reply_to['screen_name'] = null;
5051 return $in_reply_to;
5056 * @param string $text
5060 function api_clean_plain_items($text)
5062 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
5064 $text = BBCode::cleanPictureLinks($text);
5065 $URLSearchString = "^\[\]";
5067 $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
5069 if ($include_entities == "true") {
5070 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5073 // Simplify "attachment" element
5074 $text = api_clean_attachments($text);
5080 * @brief Removes most sharing information for API text export
5082 * @param string $body The original body
5084 * @return string Cleaned body
5086 function api_clean_attachments($body)
5088 $data = BBCode::getAttachmentData($body);
5095 if (isset($data["text"])) {
5096 $body = $data["text"];
5098 if (($body == "") && isset($data["title"])) {
5099 $body = $data["title"];
5101 if (isset($data["url"])) {
5102 $body .= "\n".$data["url"];
5104 $body .= $data["after"];
5111 * @param array $contacts
5115 function api_best_nickname(&$contacts)
5119 if (count($contacts) == 0) {
5123 foreach ($contacts as $contact) {
5124 if ($contact["network"] == "") {
5125 $contact["network"] = "dfrn";
5126 $best_contact = [$contact];
5130 if (sizeof($best_contact) == 0) {
5131 foreach ($contacts as $contact) {
5132 if ($contact["network"] == "dfrn") {
5133 $best_contact = [$contact];
5138 if (sizeof($best_contact) == 0) {
5139 foreach ($contacts as $contact) {
5140 if ($contact["network"] == "dspr") {
5141 $best_contact = [$contact];
5146 if (sizeof($best_contact) == 0) {
5147 foreach ($contacts as $contact) {
5148 if ($contact["network"] == "stat") {
5149 $best_contact = [$contact];
5154 if (sizeof($best_contact) == 0) {
5155 foreach ($contacts as $contact) {
5156 if ($contact["network"] == "pump") {
5157 $best_contact = [$contact];
5162 if (sizeof($best_contact) == 0) {
5163 foreach ($contacts as $contact) {
5164 if ($contact["network"] == "twit") {
5165 $best_contact = [$contact];
5170 if (sizeof($best_contact) == 1) {
5171 $contacts = $best_contact;
5173 $contacts = [$contacts[0]];
5178 * Return all or a specified group of the user with the containing contacts.
5180 * @param string $type Return type (atom, rss, xml, json)
5182 * @return array|string
5184 function api_friendica_group_show($type)
5188 if (api_user() === false) {
5189 throw new ForbiddenException();
5193 $user_info = api_get_user($a);
5194 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5195 $uid = $user_info['uid'];
5197 // get data of the specified group id or all groups if not specified
5200 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5204 // error message if specified gid is not in database
5205 if (!DBA::isResult($r)) {
5206 throw new BadRequestException("gid not available");
5210 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5215 // loop through all groups and retrieve all members for adding data in the user array
5217 foreach ($r as $rr) {
5218 $members = Contact::getByGroupId($rr['id']);
5221 if ($type == "xml") {
5222 $user_element = "users";
5224 foreach ($members as $member) {
5225 $user = api_get_user($a, $member['nurl']);
5226 $users[$k++.":user"] = $user;
5229 $user_element = "user";
5230 foreach ($members as $member) {
5231 $user = api_get_user($a, $member['nurl']);
5235 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5237 return api_format_data("groups", $type, ['group' => $grps]);
5239 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5243 * Delete the specified group of the user.
5245 * @param string $type Return type (atom, rss, xml, json)
5247 * @return array|string
5249 function api_friendica_group_delete($type)
5253 if (api_user() === false) {
5254 throw new ForbiddenException();
5258 $user_info = api_get_user($a);
5259 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5260 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5261 $uid = $user_info['uid'];
5263 // error if no gid specified
5264 if ($gid == 0 || $name == "") {
5265 throw new BadRequestException('gid or name not specified');
5268 // get data of the specified group id
5270 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5274 // error message if specified gid is not in database
5275 if (!DBA::isResult($r)) {
5276 throw new BadRequestException('gid not available');
5279 // get data of the specified group id and group name
5281 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5286 // error message if specified gid is not in database
5287 if (!DBA::isResult($rname)) {
5288 throw new BadRequestException('wrong group name');
5292 $ret = Group::removeByName($uid, $name);
5295 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5296 return api_format_data("group_delete", $type, ['result' => $success]);
5298 throw new BadRequestException('other API error');
5301 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5306 * @param string $type Return type (atom, rss, xml, json)
5308 * @return array|string
5309 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5311 function api_lists_destroy($type)
5315 if (api_user() === false) {
5316 throw new ForbiddenException();
5320 $user_info = api_get_user($a);
5321 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5322 $uid = $user_info['uid'];
5324 // error if no gid specified
5326 throw new BadRequestException('gid not specified');
5329 // get data of the specified group id
5330 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5331 // error message if specified gid is not in database
5333 throw new BadRequestException('gid not available');
5336 if (Group::remove($gid)) {
5338 'name' => $group['name'],
5339 'id' => intval($gid),
5340 'id_str' => (string) $gid,
5341 'user' => $user_info
5344 return api_format_data("lists", $type, ['lists' => $list]);
5347 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5350 * Add a new group to the database.
5352 * @param string $name Group name
5353 * @param int $uid User ID
5354 * @param array $users List of users to add to the group
5358 function group_create($name, $uid, $users = [])
5360 // error if no name specified
5362 throw new BadRequestException('group name not specified');
5365 // get data of the specified group name
5367 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5371 // error message if specified group name already exists
5372 if (DBA::isResult($rname)) {
5373 throw new BadRequestException('group name already exists');
5376 // check if specified group name is a deleted group
5378 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5382 // error message if specified group name already exists
5383 if (DBA::isResult($rname)) {
5384 $reactivate_group = true;
5388 $ret = Group::create($uid, $name);
5390 $gid = Group::getIdByName($uid, $name);
5392 throw new BadRequestException('other API error');
5396 $erroraddinguser = false;
5398 foreach ($users as $user) {
5399 $cid = $user['cid'];
5400 // check if user really exists as contact
5402 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5406 if (count($contact)) {
5407 Group::addMember($gid, $cid);
5409 $erroraddinguser = true;
5410 $errorusers[] = $cid;
5414 // return success message incl. missing users in array
5415 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5417 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5421 * Create the specified group with the posted array of contacts.
5423 * @param string $type Return type (atom, rss, xml, json)
5425 * @return array|string
5427 function api_friendica_group_create($type)
5431 if (api_user() === false) {
5432 throw new ForbiddenException();
5436 $user_info = api_get_user($a);
5437 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5438 $uid = $user_info['uid'];
5439 $json = json_decode($_POST['json'], true);
5440 $users = $json['user'];
5442 $success = group_create($name, $uid, $users);
5444 return api_format_data("group_create", $type, ['result' => $success]);
5446 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5449 * Create a new group.
5451 * @param string $type Return type (atom, rss, xml, json)
5453 * @return array|string
5454 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5456 function api_lists_create($type)
5460 if (api_user() === false) {
5461 throw new ForbiddenException();
5465 $user_info = api_get_user($a);
5466 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5467 $uid = $user_info['uid'];
5469 $success = group_create($name, $uid);
5470 if ($success['success']) {
5472 'name' => $success['name'],
5473 'id' => intval($success['gid']),
5474 'id_str' => (string) $success['gid'],
5475 'user' => $user_info
5478 return api_format_data("lists", $type, ['lists'=>$grp]);
5481 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5484 * Update the specified group with the posted array of contacts.
5486 * @param string $type Return type (atom, rss, xml, json)
5488 * @return array|string
5490 function api_friendica_group_update($type)
5494 if (api_user() === false) {
5495 throw new ForbiddenException();
5499 $user_info = api_get_user($a);
5500 $uid = $user_info['uid'];
5501 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5502 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5503 $json = json_decode($_POST['json'], true);
5504 $users = $json['user'];
5506 // error if no name specified
5508 throw new BadRequestException('group name not specified');
5511 // error if no gid specified
5513 throw new BadRequestException('gid not specified');
5517 $members = Contact::getByGroupId($gid);
5518 foreach ($members as $member) {
5519 $cid = $member['id'];
5520 foreach ($users as $user) {
5521 $found = ($user['cid'] == $cid ? true : false);
5523 if (!isset($found) || !$found) {
5524 Group::removeMemberByName($uid, $name, $cid);
5529 $erroraddinguser = false;
5531 foreach ($users as $user) {
5532 $cid = $user['cid'];
5533 // check if user really exists as contact
5535 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5540 if (count($contact)) {
5541 Group::addMember($gid, $cid);
5543 $erroraddinguser = true;
5544 $errorusers[] = $cid;
5548 // return success message incl. missing users in array
5549 $status = ($erroraddinguser ? "missing user" : "ok");
5550 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5551 return api_format_data("group_update", $type, ['result' => $success]);
5554 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5557 * Update information about a group.
5559 * @param string $type Return type (atom, rss, xml, json)
5561 * @return array|string
5562 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5564 function api_lists_update($type)
5568 if (api_user() === false) {
5569 throw new ForbiddenException();
5573 $user_info = api_get_user($a);
5574 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5575 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5576 $uid = $user_info['uid'];
5578 // error if no gid specified
5580 throw new BadRequestException('gid not specified');
5583 // get data of the specified group id
5584 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5585 // error message if specified gid is not in database
5587 throw new BadRequestException('gid not available');
5590 if (Group::update($gid, $name)) {
5593 'id' => intval($gid),
5594 'id_str' => (string) $gid,
5595 'user' => $user_info
5598 return api_format_data("lists", $type, ['lists' => $list]);
5602 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5606 * @param string $type Return type (atom, rss, xml, json)
5608 * @return array|string
5610 function api_friendica_activity($type)
5614 if (api_user() === false) {
5615 throw new ForbiddenException();
5617 $verb = strtolower($a->argv[3]);
5618 $verb = preg_replace("|\..*$|", "", $verb);
5620 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5622 $res = Item::performLike($id, $verb);
5625 if ($type == "xml") {
5630 return api_format_data('ok', $type, ['ok' => $ok]);
5632 throw new BadRequestException('Error adding activity');
5636 /// @TODO move to top of file or somewhere better
5637 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5638 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5639 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5640 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5641 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5642 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5643 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5644 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5645 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5646 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5649 * @brief Returns notifications
5651 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5652 * @return string|array
5654 function api_friendica_notification($type)
5658 if (api_user() === false) {
5659 throw new ForbiddenException();
5662 throw new BadRequestException("Invalid argument count");
5664 $nm = new NotificationsManager();
5666 $notes = $nm->getAll([], "+seen -date", 50);
5668 if ($type == "xml") {
5670 if (!empty($notes)) {
5671 foreach ($notes as $note) {
5672 $xmlnotes[] = ["@attributes" => $note];
5679 return api_format_data("notes", $type, ['note' => $notes]);
5683 * POST request with 'id' param as notification id
5685 * @brief Set notification as seen and returns associated item (if possible)
5687 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5688 * @return string|array
5690 function api_friendica_notification_seen($type)
5693 $user_info = api_get_user($a);
5695 if (api_user() === false || $user_info === false) {
5696 throw new ForbiddenException();
5699 throw new BadRequestException("Invalid argument count");
5702 $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5704 $nm = new NotificationsManager();
5705 $note = $nm->getByID($id);
5706 if (is_null($note)) {
5707 throw new BadRequestException("Invalid argument");
5710 $nm->setSeen($note);
5711 if ($note['otype']=='item') {
5712 // would be really better with an ItemsManager and $im->getByID() :-P
5713 $item = Item::selectFirstForUser(api_user(), [], ['id' => $note['iid'], 'uid' => api_user()]);
5714 if (DBA::isResult($item)) {
5715 // we found the item, return it to the user
5716 $ret = api_format_items([$item], $user_info, false, $type);
5717 $data = ['status' => $ret];
5718 return api_format_data("status", $type, $data);
5720 // the item can't be found, but we set the note as seen, so we count this as a success
5722 return api_format_data('result', $type, ['result' => "success"]);
5725 /// @TODO move to top of file or somewhere better
5726 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5727 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5730 * @brief update a direct_message to seen state
5732 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5733 * @return string|array (success result=ok, error result=error with error message)
5735 function api_friendica_direct_messages_setseen($type)
5738 if (api_user() === false) {
5739 throw new ForbiddenException();
5743 $user_info = api_get_user($a);
5744 $uid = $user_info['uid'];
5745 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5747 // return error if id is zero
5749 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5750 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5753 // error message if specified id is not in database
5754 if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
5755 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5756 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5759 // update seen indicator
5760 $result = DBA::update('mail', ['seen' => true], ['id' => $id]);
5764 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
5765 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
5767 $answer = ['result' => 'error', 'message' => 'unknown error'];
5768 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5772 /// @TODO move to top of file or somewhere better
5773 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5776 * @brief search for direct_messages containing a searchstring through api
5778 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5779 * @param string $box
5780 * @return string|array (success: success=true if found and search_result contains found messages,
5781 * success=false if nothing was found, search_result='nothing found',
5782 * error: result=error with error message)
5784 function api_friendica_direct_messages_search($type, $box = "")
5788 if (api_user() === false) {
5789 throw new ForbiddenException();
5793 $user_info = api_get_user($a);
5794 $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
5795 $uid = $user_info['uid'];
5797 // error if no searchstring specified
5798 if ($searchstring == "") {
5799 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
5800 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
5803 // get data for the specified searchstring
5805 "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",
5807 DBA::escape('%'.$searchstring.'%')
5810 $profile_url = $user_info["url"];
5812 // message if nothing was found
5813 if (!DBA::isResult($r)) {
5814 $success = ['success' => false, 'search_results' => 'problem with query'];
5815 } elseif (count($r) == 0) {
5816 $success = ['success' => false, 'search_results' => 'nothing found'];
5819 foreach ($r as $item) {
5820 if ($box == "inbox" || $item['from-url'] != $profile_url) {
5821 $recipient = $user_info;
5822 $sender = api_get_user($a, normalise_link($item['contact-url']));
5823 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5824 $recipient = api_get_user($a, normalise_link($item['contact-url']));
5825 $sender = $user_info;
5828 if (isset($recipient) && isset($sender)) {
5829 $ret[] = api_format_messages($item, $recipient, $sender);
5832 $success = ['success' => true, 'search_results' => $ret];
5835 return api_format_data("direct_message_search", $type, ['$result' => $success]);
5838 /// @TODO move to top of file or somewhere better
5839 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5842 * @brief return data of all the profiles a user has to the client
5844 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5845 * @return string|array
5847 function api_friendica_profile_show($type)
5851 if (api_user() === false) {
5852 throw new ForbiddenException();
5856 $profile_id = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
5858 // retrieve general information about profiles for user
5859 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
5860 $directory = Config::get('system', 'directory');
5862 // get data of the specified profile id or all profiles of the user if not specified
5863 if ($profile_id != 0) {
5865 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
5870 // error message if specified gid is not in database
5871 if (!DBA::isResult($r)) {
5872 throw new BadRequestException("profile_id not available");
5876 "SELECT * FROM `profile` WHERE `uid` = %d",
5880 // loop through all returned profiles and retrieve data and users
5883 foreach ($r as $rr) {
5884 $profile = api_format_items_profiles($rr);
5886 // select all users from contact table, loop and prepare standard return for user data
5889 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
5894 foreach ($nurls as $nurl) {
5895 $user = api_get_user($a, $nurl['nurl']);
5896 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
5898 $profile['users'] = $users;
5900 // add prepared profile data to array for final return
5901 if ($type == "xml") {
5902 $profiles[$k++ . ":profile"] = $profile;
5904 $profiles[] = $profile;
5908 // return settings, authenticated user and profiles data
5909 $self = DBA::selectFirst('contact', ['nurl'], ['uid' => api_user(), 'self' => true]);
5911 $result = ['multi_profiles' => $multi_profiles ? true : false,
5912 'global_dir' => $directory,
5913 'friendica_owner' => api_get_user($a, $self['nurl']),
5914 'profiles' => $profiles];
5915 return api_format_data("friendica_profiles", $type, ['$result' => $result]);
5917 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
5920 * Returns a list of saved searches.
5922 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5924 * @param string $type Return format: json or xml
5926 * @return string|array
5928 function api_saved_searches_list($type)
5930 $terms = DBA::select('search', ['id', 'term'], ['uid' => local_user()]);
5933 while ($term = $terms->fetch()) {
5935 'created_at' => api_date(time()),
5936 'id' => intval($term['id']),
5937 'id_str' => $term['id'],
5938 'name' => $term['term'],
5940 'query' => $term['term']
5946 return api_format_data("terms", $type, ['terms' => $result]);
5949 /// @TODO move to top of file or somewhere better
5950 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5953 @TODO Maybe open to implement?
5955 [pagename] => api/1.1/statuses/lookup.json
5956 [id] => 605138389168451584
5957 [include_cards] => true
5958 [cards_platform] => Android-12
5959 [include_entities] => true
5960 [include_my_retweet] => 1
5962 [include_reply_count] => true
5963 [include_descendent_reply_count] => true
5967 Not implemented by now:
5968 statuses/retweets_of_me
5973 account/update_location
5974 account/update_profile_background_image
5977 friendica/profile/update
5978 friendica/profile/create
5979 friendica/profile/delete
5981 Not implemented in status.net:
5982 statuses/retweeted_to_me
5983 statuses/retweeted_by_me
5984 direct_messages/destroy
5986 account/update_delivery_device
5987 notifications/follow