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\Authentication;
15 use Friendica\Core\Config;
16 use Friendica\Core\Hook;
17 use Friendica\Core\L10n;
18 use Friendica\Core\Logger;
19 use Friendica\Core\NotificationsManager;
20 use Friendica\Core\PConfig;
21 use Friendica\Core\Protocol;
22 use Friendica\Core\System;
23 use Friendica\Core\Worker;
24 use Friendica\Database\DBA;
25 use Friendica\Model\Contact;
26 use Friendica\Model\Group;
27 use Friendica\Model\Item;
28 use Friendica\Model\Mail;
29 use Friendica\Model\Photo;
30 use Friendica\Model\User;
31 use Friendica\Network\FKOAuth1;
32 use Friendica\Network\HTTPException;
33 use Friendica\Network\HTTPException\BadRequestException;
34 use Friendica\Network\HTTPException\ForbiddenException;
35 use Friendica\Network\HTTPException\InternalServerErrorException;
36 use Friendica\Network\HTTPException\MethodNotAllowedException;
37 use Friendica\Network\HTTPException\NotFoundException;
38 use Friendica\Network\HTTPException\NotImplementedException;
39 use Friendica\Network\HTTPException\TooManyRequestsException;
40 use Friendica\Network\HTTPException\UnauthorizedException;
41 use Friendica\Object\Image;
42 use Friendica\Protocol\Diaspora;
43 use Friendica\Util\DateTimeFormat;
44 use Friendica\Util\Network;
45 use Friendica\Util\Proxy as ProxyUtils;
46 use Friendica\Util\Strings;
47 use Friendica\Util\XML;
49 require_once 'mod/share.php';
50 require_once 'mod/item.php';
51 require_once 'mod/wall_upload.php';
53 define('API_METHOD_ANY', '*');
54 define('API_METHOD_GET', 'GET');
55 define('API_METHOD_POST', 'POST,PUT');
56 define('API_METHOD_DELETE', 'POST,DELETE');
62 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
63 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
64 * into a page, and visitors will post something without noticing it).
66 * @brief Auth API user
70 if (!empty($_SESSION['allow_api'])) {
78 * Clients can send 'source' parameter to be show in post metadata
79 * as "sent via <source>".
80 * Some clients doesn't send a source param, we support ones we know
83 * @brief Get source name from API client
86 * Client source name, default to "api" if unset/unknown
90 if (requestdata('source')) {
91 return requestdata('source');
94 // Support for known clients that doesn't send a source name
95 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
96 if(strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
100 Logger::log("Unrecognized user-agent ".$_SERVER['HTTP_USER_AGENT'], Logger::DEBUG);
102 Logger::log("Empty user-agent", Logger::DEBUG);
109 * @brief Format date for API
111 * @param string $str Source date, as UTC
112 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
114 function api_date($str)
116 // Wed May 23 06:01:13 +0000 2007
117 return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
121 * Register a function to be the endpoint for defined API path.
123 * @brief Register API endpoint
125 * @param string $path API URL path, relative to System::baseUrl()
126 * @param string $func Function name to call on path request
127 * @param bool $auth API need logged user
128 * @param string $method HTTP method reqiured to call this endpoint.
129 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
130 * Default to API_METHOD_ANY
132 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
142 // Workaround for hotot
143 $path = str_replace("api/", "api/1.1/", $path);
153 * Log in user via OAuth1 or Simple HTTP Auth.
154 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
156 * @brief Login API user
158 * @param object $a App
159 * @hook 'authenticate'
161 * 'username' => username from login form
162 * 'password' => password from login form
163 * 'authenticated' => return status,
164 * 'user_record' => return authenticated user record
166 * array $user logged user record
168 function api_login(App $a)
170 $oauth1 = new FKOAuth1();
173 $request = OAuthRequest::from_request();
174 list($consumer, $token) = $oauth1->verify_request($request);
175 if (!is_null($token)) {
176 $oauth1->loginUser($token->uid);
177 Hook::callAll('logged_in', $a->user);
180 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
181 var_dump($consumer, $token);
183 } catch (Exception $e) {
187 // workaround for HTTP-auth in CGI mode
188 if (!empty($_SERVER['REDIRECT_REMOTE_USER'])) {
189 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6));
190 if (strlen($userpass)) {
191 list($name, $password) = explode(':', $userpass);
192 $_SERVER['PHP_AUTH_USER'] = $name;
193 $_SERVER['PHP_AUTH_PW'] = $password;
197 if (empty($_SERVER['PHP_AUTH_USER'])) {
198 Logger::log('API_login: ' . print_r($_SERVER, true), Logger::DEBUG);
199 header('WWW-Authenticate: Basic realm="Friendica"');
200 throw new UnauthorizedException("This API requires login");
203 $user = defaults($_SERVER, 'PHP_AUTH_USER', '');
204 $password = defaults($_SERVER, 'PHP_AUTH_PW', '');
206 // allow "user@server" login (but ignore 'server' part)
207 $at = strstr($user, "@", true);
212 // next code from mod/auth.php. needs better solution
216 'username' => trim($user),
217 'password' => trim($password),
218 'authenticated' => 0,
219 'user_record' => null,
223 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
224 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
225 * and later addons should not interfere with an earlier one that succeeded.
227 Hook::callAll('authenticate', $addon_auth);
229 if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
230 $record = $addon_auth['user_record'];
232 $user_id = User::authenticate(trim($user), trim($password));
233 if ($user_id !== false) {
234 $record = DBA::selectFirst('user', [], ['uid' => $user_id]);
238 if (!DBA::isResult($record)) {
239 Logger::log('API_login failure: ' . print_r($_SERVER, true), Logger::DEBUG);
240 header('WWW-Authenticate: Basic realm="Friendica"');
241 //header('HTTP/1.0 401 Unauthorized');
242 //die('This api requires login');
243 throw new UnauthorizedException("This API requires login");
246 Authentication::setAuthenticatedSessionForUser($record);
248 $_SESSION["allow_api"] = true;
250 Hook::callAll('logged_in', $a->user);
254 * API endpoints can define which HTTP method to accept when called.
255 * This function check the current HTTP method agains endpoint
258 * @brief Check HTTP method of called API
260 * @param string $method Required methods, uppercase, separated by comma
263 function api_check_method($method)
265 if ($method == "*") {
268 return (stripos($method, defaults($_SERVER, 'REQUEST_METHOD', 'GET')) !== false);
272 * Authenticate user, call registered API function, set HTTP headers
274 * @brief Main API entry point
276 * @param object $a App
277 * @return string|array API call result
279 function api_call(App $a)
281 global $API, $called_api;
284 if (strpos($a->query_string, ".xml") > 0) {
287 if (strpos($a->query_string, ".json") > 0) {
290 if (strpos($a->query_string, ".rss") > 0) {
293 if (strpos($a->query_string, ".atom") > 0) {
298 foreach ($API as $p => $info) {
299 if (strpos($a->query_string, $p) === 0) {
300 if (!api_check_method($info['method'])) {
301 throw new MethodNotAllowedException();
304 $called_api = explode("/", $p);
305 //unset($_SERVER['PHP_AUTH_USER']);
307 /// @TODO should be "true ==[=] $info['auth']", if you miss only one = character, you assign a variable (only with ==). Let's make all this even.
308 if (!empty($info['auth']) && api_user() === false) {
312 Logger::log('API call for ' . $a->user['username'] . ': ' . $a->query_string);
313 Logger::log('API parameters: ' . print_r($_REQUEST, true));
315 $stamp = microtime(true);
316 $return = call_user_func($info['func'], $type);
317 $duration = (float) (microtime(true) - $stamp);
318 Logger::log("API call duration: " . round($duration, 2) . "\t" . $a->query_string, Logger::DEBUG);
320 if (Config::get("system", "profiler")) {
321 $duration = microtime(true)-$a->performance["start"];
323 /// @TODO round() really everywhere?
325 parse_url($a->query_string, PHP_URL_PATH) . ": " . sprintf(
326 "Database: %s/%s, Cache %s/%s, Network: %s, I/O: %s, Other: %s, Total: %s",
327 round($a->performance["database"] - $a->performance["database_write"], 3),
328 round($a->performance["database_write"], 3),
329 round($a->performance["cache"], 3),
330 round($a->performance["cache_write"], 3),
331 round($a->performance["network"], 2),
332 round($a->performance["file"], 2),
333 round($duration - ($a->performance["database"]
334 + $a->performance["cache"] + $a->performance["cache_write"]
335 + $a->performance["network"] + $a->performance["file"]), 2),
341 if (Config::get("rendertime", "callstack")) {
342 $o = "Database Read:\n";
343 foreach ($a->callstack["database"] as $func => $time) {
344 $time = round($time, 3);
346 $o .= $func . ": " . $time . "\n";
349 $o .= "\nDatabase Write:\n";
350 foreach ($a->callstack["database_write"] as $func => $time) {
351 $time = round($time, 3);
353 $o .= $func . ": " . $time . "\n";
357 $o = "Cache Read:\n";
358 foreach ($a->callstack["cache"] as $func => $time) {
359 $time = round($time, 3);
361 $o .= $func . ": " . $time . "\n";
364 $o .= "\nCache Write:\n";
365 foreach ($a->callstack["cache_write"] as $func => $time) {
366 $time = round($time, 3);
368 $o .= $func . ": " . $time . "\n";
372 $o .= "\nNetwork:\n";
373 foreach ($a->callstack["network"] as $func => $time) {
374 $time = round($time, 3);
376 $o .= $func . ": " . $time . "\n";
379 Logger::log($o, Logger::DEBUG);
383 if (false === $return) {
385 * api function returned false withour throw an
386 * exception. This should not happend, throw a 500
388 throw new InternalServerErrorException();
393 header("Content-Type: text/xml");
396 header("Content-Type: application/json");
397 $json = json_encode(end($return));
398 if (!empty($_GET['callback'])) {
399 $json = $_GET['callback'] . "(" . $json . ")";
404 header("Content-Type: application/rss+xml");
405 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
408 header("Content-Type: application/atom+xml");
409 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
416 Logger::log('API call not implemented: ' . $a->query_string);
417 throw new NotImplementedException();
418 } catch (HTTPException $e) {
419 header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}");
420 return api_error($type, $e);
425 * @brief Format API error string
427 * @param string $type Return type (xml, json, rss, as)
428 * @param object $e HTTPException Error object
429 * @return string|array error message formatted as $type
431 function api_error($type, $e)
435 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
436 /// @TODO: https://dev.twitter.com/overview/api/response-codes
438 $error = ["error" => $error,
439 "code" => $e->httpcode . " " . $e->httpdesc,
440 "request" => $a->query_string];
442 $return = api_format_data('status', $type, ['status' => $error]);
446 header("Content-Type: text/xml");
449 header("Content-Type: application/json");
450 $return = json_encode($return);
453 header("Content-Type: application/rss+xml");
456 header("Content-Type: application/atom+xml");
464 * @brief Set values for RSS template
467 * @param array $arr Array to be passed to template
468 * @param array $user_info User info
470 * @todo find proper type-hints
472 function api_rss_extra(App $a, $arr, $user_info)
474 if (is_null($user_info)) {
475 $user_info = api_get_user($a);
478 $arr['$user'] = $user_info;
480 'alternate' => $user_info['url'],
481 'self' => System::baseUrl() . "/" . $a->query_string,
482 'base' => System::baseUrl(),
483 'updated' => api_date(null),
484 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
485 'language' => $user_info['lang'],
486 'logo' => System::baseUrl() . "/images/friendica-32.png",
494 * @brief Unique contact to contact url.
496 * @param int $id Contact id
497 * @return bool|string
498 * Contact url or False if contact id is unknown
500 function api_unique_id_to_nurl($id)
502 $r = DBA::selectFirst('contact', ['nurl'], ['id' => $id]);
504 if (DBA::isResult($r)) {
512 * @brief Get user info array.
514 * @param object $a App
515 * @param int|string $contact_id Contact ID or URL
517 function api_get_user(App $a, $contact_id = null)
525 Logger::log("api_get_user: Fetching user data for user ".$contact_id, Logger::DEBUG);
527 // Searching for contact URL
528 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
529 $user = DBA::escape(Strings::normaliseLink($contact_id));
531 $extra_query = "AND `contact`.`nurl` = '%s' ";
532 if (api_user() !== false) {
533 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
537 // Searching for contact id with uid = 0
538 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
539 $user = DBA::escape(api_unique_id_to_nurl(intval($contact_id)));
542 throw new BadRequestException("User ID ".$contact_id." not found.");
546 $extra_query = "AND `contact`.`nurl` = '%s' ";
547 if (api_user() !== false) {
548 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
552 if (is_null($user) && !empty($_GET['user_id'])) {
553 $user = DBA::escape(api_unique_id_to_nurl($_GET['user_id']));
556 throw new BadRequestException("User ID ".$_GET['user_id']." not found.");
560 $extra_query = "AND `contact`.`nurl` = '%s' ";
561 if (api_user() !== false) {
562 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
565 if (is_null($user) && !empty($_GET['screen_name'])) {
566 $user = DBA::escape($_GET['screen_name']);
567 $extra_query = "AND `contact`.`nick` = '%s' ";
568 if (api_user() !== false) {
569 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
573 if (is_null($user) && !empty($_GET['profileurl'])) {
574 $user = DBA::escape(Strings::normaliseLink($_GET['profileurl']));
575 $extra_query = "AND `contact`.`nurl` = '%s' ";
576 if (api_user() !== false) {
577 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
581 // $called_api is the API path exploded on / and is expected to have at least 2 elements
582 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
583 $argid = count($called_api);
584 if (!empty($a->argv[$argid])) {
585 $data = explode(".", $a->argv[$argid]);
586 if (count($data) > 1) {
587 list($user, $null) = $data;
590 if (is_numeric($user)) {
591 $user = DBA::escape(api_unique_id_to_nurl(intval($user)));
595 $extra_query = "AND `contact`.`nurl` = '%s' ";
596 if (api_user() !== false) {
597 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
601 $user = DBA::escape($user);
602 $extra_query = "AND `contact`.`nick` = '%s' ";
603 if (api_user() !== false) {
604 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
609 Logger::log("api_get_user: user ".$user, Logger::DEBUG);
612 if (api_user() === false) {
616 $user = $_SESSION['uid'];
617 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
621 Logger::log('api_user: ' . $extra_query . ', user: ' . $user);
625 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
631 // Selecting the id by priority, friendica first
632 if (is_array($uinfo)) {
633 api_best_nickname($uinfo);
636 // if the contact wasn't found, fetch it from the contacts with uid = 0
637 if (!DBA::isResult($uinfo)) {
639 throw new BadRequestException("User not found.");
642 $contact = DBA::selectFirst('contact', [], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
644 if (DBA::isResult($contact)) {
645 // If no nick where given, extract it from the address
646 if (($contact['nick'] == "") || ($contact['name'] == $contact['nick'])) {
647 $contact['nick'] = api_get_nick($contact["url"]);
651 'id' => $contact["id"],
652 'id_str' => (string) $contact["id"],
653 'name' => $contact["name"],
654 'screen_name' => (($contact['nick']) ? $contact['nick'] : $contact['name']),
655 'location' => ($contact["location"] != "") ? $contact["location"] : ContactSelector::networkToName($contact['network'], $contact['url']),
656 'description' => $contact["about"],
657 'profile_image_url' => $contact["micro"],
658 'profile_image_url_https' => $contact["micro"],
659 'profile_image_url_profile_size' => $contact["thumb"],
660 'profile_image_url_large' => $contact["photo"],
661 'url' => $contact["url"],
662 'protected' => false,
663 'followers_count' => 0,
664 'friends_count' => 0,
666 'created_at' => api_date($contact["created"]),
667 'favourites_count' => 0,
669 'time_zone' => 'UTC',
670 'geo_enabled' => false,
672 'statuses_count' => 0,
674 'contributors_enabled' => false,
675 'is_translator' => false,
676 'is_translation_enabled' => false,
677 'following' => false,
678 'follow_request_sent' => false,
679 'statusnet_blocking' => false,
680 'notifications' => false,
681 'statusnet_profile_url' => $contact["url"],
683 'cid' => Contact::getIdForURL($contact["url"], api_user(), true),
684 'pid' => Contact::getIdForURL($contact["url"], 0, true),
686 'network' => $contact["network"],
691 throw new BadRequestException("User ".$url." not found.");
695 if ($uinfo[0]['self']) {
696 if ($uinfo[0]['network'] == "") {
697 $uinfo[0]['network'] = Protocol::DFRN;
700 $usr = DBA::selectFirst('user', ['default-location'], ['uid' => api_user()]);
701 $profile = DBA::selectFirst('profile', ['about'], ['uid' => api_user(), 'is-default' => true]);
708 // Add a nick if it isn't present there
709 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
710 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
713 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
715 if (!empty($profile['about'])) {
716 $description = $profile['about'];
718 $description = $uinfo[0]["about"];
721 if (!empty($usr['default-location'])) {
722 $location = $usr['default-location'];
723 } elseif (!empty($uinfo[0]["location"])) {
724 $location = $uinfo[0]["location"];
726 $location = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
730 'id' => intval($pcontact_id),
731 'id_str' => (string) intval($pcontact_id),
732 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
733 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
734 'location' => $location,
735 'description' => $description,
736 'profile_image_url' => $uinfo[0]['micro'],
737 'profile_image_url_https' => $uinfo[0]['micro'],
738 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
739 'profile_image_url_large' => $uinfo[0]["photo"],
740 'url' => $uinfo[0]['url'],
741 'protected' => false,
742 'followers_count' => intval($countfollowers),
743 'friends_count' => intval($countfriends),
745 'created_at' => api_date($uinfo[0]['created']),
746 'favourites_count' => intval($starred),
748 'time_zone' => 'UTC',
749 'geo_enabled' => false,
751 'statuses_count' => intval($countitems),
753 'contributors_enabled' => false,
754 'is_translator' => false,
755 'is_translation_enabled' => false,
756 'following' => (($uinfo[0]['rel'] == Contact::FOLLOWER) || ($uinfo[0]['rel'] == Contact::FRIEND)),
757 'follow_request_sent' => false,
758 'statusnet_blocking' => false,
759 'notifications' => false,
761 //'statusnet_profile_url' => System::baseUrl()."/contact/".$uinfo[0]['cid'],
762 'statusnet_profile_url' => $uinfo[0]['url'],
763 'uid' => intval($uinfo[0]['uid']),
764 'cid' => intval($uinfo[0]['cid']),
765 'pid' => Contact::getIdForURL($uinfo[0]["url"], 0, true),
766 'self' => $uinfo[0]['self'],
767 'network' => $uinfo[0]['network'],
770 // If this is a local user and it uses Frio, we can get its color preferences.
772 $theme_info = DBA::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
773 if ($theme_info['theme'] === 'frio') {
774 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
776 if ($schema && ($schema != '---')) {
777 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
778 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
779 require_once $schemefile;
782 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
783 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
784 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
786 if (empty($nav_bg)) {
789 if (empty($link_color)) {
790 $link_color = "#6fdbe8";
792 if (empty($bgcolor)) {
793 $bgcolor = "#ededed";
796 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
797 $ret['profile_link_color'] = str_replace('#', '', $link_color);
798 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
806 * @brief return api-formatted array for item's author and owner
808 * @param object $a App
809 * @param array $item item from db
810 * @return array(array:author, array:owner)
812 function api_item_get_user(App $a, $item)
814 $status_user = api_get_user($a, defaults($item, 'author-id', null));
816 $status_user["protected"] = defaults($item, 'private', 0);
818 if (defaults($item, 'thr-parent', '') == defaults($item, 'uri', '')) {
819 $owner_user = api_get_user($a, defaults($item, 'owner-id', null));
821 $owner_user = $status_user;
824 return ([$status_user, $owner_user]);
828 * @brief walks recursively through an array with the possibility to change value and key
830 * @param array $array The array to walk through
831 * @param string $callback The callback function
833 * @return array the transformed array
835 function api_walk_recursive(array &$array, callable $callback)
839 foreach ($array as $k => $v) {
841 if ($callback($v, $k)) {
842 $new_array[$k] = api_walk_recursive($v, $callback);
845 if ($callback($v, $k)) {
856 * @brief Callback function to transform the array in an array that can be transformed in a XML file
858 * @param mixed $item Array item value
859 * @param string $key Array key
861 * @return boolean Should the array item be deleted?
863 function api_reformat_xml(&$item, &$key)
865 if (is_bool($item)) {
866 $item = ($item ? "true" : "false");
869 if (substr($key, 0, 10) == "statusnet_") {
870 $key = "statusnet:".substr($key, 10);
871 } elseif (substr($key, 0, 10) == "friendica_") {
872 $key = "friendica:".substr($key, 10);
874 /// @TODO old-lost code?
876 // $key = "default:".$key;
882 * @brief Creates the XML from a JSON style array
884 * @param array $data JSON style array
885 * @param string $root_element Name of the root element
887 * @return string The XML data
889 function api_create_xml(array $data, $root_element)
891 $childname = key($data);
892 $data2 = array_pop($data);
894 $namespaces = ["" => "http://api.twitter.com",
895 "statusnet" => "http://status.net/schema/api/1/",
896 "friendica" => "http://friendi.ca/schema/api/1/",
897 "georss" => "http://www.georss.org/georss"];
899 /// @todo Auto detection of needed namespaces
900 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
904 if (is_array($data2)) {
906 api_walk_recursive($data2, "api_reformat_xml");
912 foreach ($data2 as $item) {
913 $data4[$i++ . ":" . $childname] = $item;
920 $data3 = [$root_element => $data2];
922 $ret = XML::fromArray($data3, $xml, false, $namespaces);
927 * @brief Formats the data according to the data type
929 * @param string $root_element Name of the root element
930 * @param string $type Return type (atom, rss, xml, json)
931 * @param array $data JSON style array
933 * @return (string|array) XML data or JSON data
935 function api_format_data($root_element, $type, $data)
941 $ret = api_create_xml($data, $root_element);
956 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
957 * returns a 401 status code and an error message if not.
958 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
960 * @param string $type Return type (atom, rss, xml, json)
962 function api_account_verify_credentials($type)
967 if (api_user() === false) {
968 throw new ForbiddenException();
971 unset($_REQUEST["user_id"]);
972 unset($_GET["user_id"]);
974 unset($_REQUEST["screen_name"]);
975 unset($_GET["screen_name"]);
977 $skip_status = defaults($_REQUEST, 'skip_status', false);
979 $user_info = api_get_user($a);
981 // "verified" isn't used here in the standard
982 unset($user_info["verified"]);
984 // - Adding last status
986 $user_info["status"] = api_status_show("raw");
987 if (!count($user_info["status"])) {
988 unset($user_info["status"]);
990 unset($user_info["status"]["user"]);
994 // "uid" and "self" are only needed for some internal stuff, so remove it from here
995 unset($user_info["uid"]);
996 unset($user_info["self"]);
998 return api_format_data("user", $type, ['user' => $user_info]);
1001 /// @TODO move to top of file or somewhere better
1002 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1005 * Get data from $_POST or $_GET
1009 function requestdata($k)
1011 if (!empty($_POST[$k])) {
1014 if (!empty($_GET[$k])) {
1021 * Deprecated function to upload media.
1023 * @param string $type Return type (atom, rss, xml, json)
1025 * @return array|string
1027 function api_statuses_mediap($type)
1031 if (api_user() === false) {
1032 Logger::log('api_statuses_update: no user');
1033 throw new ForbiddenException();
1035 $user_info = api_get_user($a);
1037 $_REQUEST['profile_uid'] = api_user();
1038 $_REQUEST['api_source'] = true;
1039 $txt = requestdata('status');
1040 /// @TODO old-lost code?
1041 //$txt = urldecode(requestdata('status'));
1043 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1044 $txt = HTML::toBBCodeVideo($txt);
1045 $config = HTMLPurifier_Config::createDefault();
1046 $config->set('Cache.DefinitionImpl', null);
1047 $purifier = new HTMLPurifier($config);
1048 $txt = $purifier->purify($txt);
1050 $txt = HTML::toBBCode($txt);
1052 $a->argv[1] = $user_info['screen_name']; //should be set to username?
1054 $picture = wall_upload_post($a, false);
1056 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1057 $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1058 $item_id = item_post($a);
1060 // output the post that we just posted.
1061 return api_status_show($type, $item_id);
1064 /// @TODO move this to top of file or somewhere better!
1065 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1068 * Updates the user’s current status.
1070 * @param string $type Return type (atom, rss, xml, json)
1072 * @return array|string
1073 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1075 function api_statuses_update($type)
1079 if (api_user() === false) {
1080 Logger::log('api_statuses_update: no user');
1081 throw new ForbiddenException();
1086 // convert $_POST array items to the form we use for web posts.
1087 if (requestdata('htmlstatus')) {
1088 $txt = requestdata('htmlstatus');
1089 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1090 $txt = HTML::toBBCodeVideo($txt);
1092 $config = HTMLPurifier_Config::createDefault();
1093 $config->set('Cache.DefinitionImpl', null);
1095 $purifier = new HTMLPurifier($config);
1096 $txt = $purifier->purify($txt);
1098 $_REQUEST['body'] = HTML::toBBCode($txt);
1101 $_REQUEST['body'] = requestdata('status');
1104 $_REQUEST['title'] = requestdata('title');
1106 $parent = requestdata('in_reply_to_status_id');
1108 // Twidere sends "-1" if it is no reply ...
1109 if ($parent == -1) {
1113 if (ctype_digit($parent)) {
1114 $_REQUEST['parent'] = $parent;
1116 $_REQUEST['parent_uri'] = $parent;
1119 if (requestdata('lat') && requestdata('long')) {
1120 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1122 $_REQUEST['profile_uid'] = api_user();
1125 // Check for throttling (maximum posts per day, week and month)
1126 $throttle_day = Config::get('system', 'throttle_limit_day');
1127 if ($throttle_day > 0) {
1128 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1130 $condition = ["`uid` = ? AND `wall` AND `created` > ?", api_user(), $datefrom];
1131 $posts_day = DBA::count('thread', $condition);
1133 if ($posts_day > $throttle_day) {
1134 Logger::log('Daily posting limit reached for user '.api_user(), Logger::DEBUG);
1135 // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1136 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));
1140 $throttle_week = Config::get('system', 'throttle_limit_week');
1141 if ($throttle_week > 0) {
1142 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1144 $condition = ["`uid` = ? AND `wall` AND `created` > ?", api_user(), $datefrom];
1145 $posts_week = DBA::count('thread', $condition);
1147 if ($posts_week > $throttle_week) {
1148 Logger::log('Weekly posting limit reached for user '.api_user(), Logger::DEBUG);
1149 // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1150 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));
1154 $throttle_month = Config::get('system', 'throttle_limit_month');
1155 if ($throttle_month > 0) {
1156 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1158 $condition = ["`uid` = ? AND `wall` AND `created` > ?", api_user(), $datefrom];
1159 $posts_month = DBA::count('thread', $condition);
1161 if ($posts_month > $throttle_month) {
1162 Logger::log('Monthly posting limit reached for user '.api_user(), Logger::DEBUG);
1163 // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1164 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));
1169 if (!empty($_FILES['media'])) {
1170 // upload the image if we have one
1171 $picture = wall_upload_post($a, false);
1172 if (is_array($picture)) {
1173 $_REQUEST['body'] .= "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1177 // To-Do: Multiple IDs
1178 if (requestdata('media_ids')) {
1180 "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",
1181 intval(requestdata('media_ids')),
1184 if (DBA::isResult($r)) {
1185 $phototypes = Image::supportedTypes();
1186 $ext = $phototypes[$r[0]['type']];
1187 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1188 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1192 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1194 $_REQUEST['api_source'] = true;
1196 if (empty($_REQUEST['source'])) {
1197 $_REQUEST["source"] = api_source();
1200 // call out normal post function
1201 $item_id = item_post($a);
1203 // output the post that we just posted.
1204 return api_status_show($type, $item_id);
1207 /// @TODO move to top of file or somewhere better
1208 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1209 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1212 * Uploads an image to Friendica.
1215 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1217 function api_media_upload()
1221 if (api_user() === false) {
1222 Logger::log('no user');
1223 throw new ForbiddenException();
1228 if (empty($_FILES['media'])) {
1230 throw new BadRequestException("No media.");
1233 $media = wall_upload_post($a, false);
1236 throw new InternalServerErrorException();
1240 $returndata["media_id"] = $media["id"];
1241 $returndata["media_id_string"] = (string)$media["id"];
1242 $returndata["size"] = $media["size"];
1243 $returndata["image"] = ["w" => $media["width"],
1244 "h" => $media["height"],
1245 "image_type" => $media["type"],
1246 "friendica_preview_url" => $media["preview"]];
1248 Logger::log("Media uploaded: " . print_r($returndata, true), Logger::DEBUG);
1250 return ["media" => $returndata];
1253 /// @TODO move to top of file or somewhere better
1254 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1258 * @param string $type Return type (atom, rss, xml, json)
1260 * @return array|string
1262 function api_status_show($type, $item_id = 0)
1266 $user_info = api_get_user($a);
1268 Logger::log('api_status_show: user_info: '.print_r($user_info, true), Logger::DEBUG);
1270 if ($type == "raw") {
1271 $privacy_sql = "AND NOT `private`";
1276 if (!empty($item_id)) {
1277 // Get the item with the given id
1278 $condition = ['id' => $item_id];
1280 // get last public wall message
1281 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1282 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1284 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1286 if (DBA::isResult($lastwall)) {
1287 $in_reply_to = api_in_reply_to($lastwall);
1289 $converted = api_convert_item($lastwall);
1291 if ($type == "xml") {
1292 $geo = "georss:point";
1298 'created_at' => api_date($lastwall['created']),
1299 'id' => intval($lastwall['id']),
1300 'id_str' => (string) $lastwall['id'],
1301 'text' => $converted["text"],
1302 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1303 'truncated' => false,
1304 'in_reply_to_status_id' => $in_reply_to['status_id'],
1305 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1306 'in_reply_to_user_id' => $in_reply_to['user_id'],
1307 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1308 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1309 'user' => $user_info,
1311 'coordinates' => '',
1313 'contributors' => '',
1314 'is_quote_status' => false,
1315 'retweet_count' => 0,
1316 'favorite_count' => 0,
1317 'favorited' => $lastwall['starred'] ? true : false,
1318 'retweeted' => false,
1319 'possibly_sensitive' => false,
1321 'statusnet_html' => $converted["html"],
1322 'statusnet_conversation_id' => $lastwall['parent'],
1323 'external_url' => System::baseUrl() . '/display/' . $lastwall['guid'],
1326 if (count($converted["attachments"]) > 0) {
1327 $status_info["attachments"] = $converted["attachments"];
1330 if (count($converted["entities"]) > 0) {
1331 $status_info["entities"] = $converted["entities"];
1334 if ($status_info["source"] == 'web') {
1335 $status_info["source"] = ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']);
1336 } elseif (ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']) != $status_info["source"]) {
1337 $status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']).')');
1340 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1341 unset($status_info["user"]["uid"]);
1342 unset($status_info["user"]["self"]);
1344 Logger::log('status_info: '.print_r($status_info, true), Logger::DEBUG);
1346 if ($type == "raw") {
1347 return $status_info;
1350 return api_format_data("statuses", $type, ['status' => $status_info]);
1355 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1356 * The author's most recent status will be returned inline.
1358 * @param string $type Return type (atom, rss, xml, json)
1359 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1361 function api_users_show($type)
1365 $user_info = api_get_user($a);
1367 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1368 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'private' => false];
1369 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1371 if (DBA::isResult($lastwall)) {
1372 $in_reply_to = api_in_reply_to($lastwall);
1374 $converted = api_convert_item($lastwall);
1376 if ($type == "xml") {
1377 $geo = "georss:point";
1382 $user_info['status'] = [
1383 'text' => $converted["text"],
1384 'truncated' => false,
1385 'created_at' => api_date($lastwall['created']),
1386 'in_reply_to_status_id' => $in_reply_to['status_id'],
1387 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1388 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1389 'id' => intval($lastwall['contact-id']),
1390 'id_str' => (string) $lastwall['contact-id'],
1391 'in_reply_to_user_id' => $in_reply_to['user_id'],
1392 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1393 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1395 'favorited' => $lastwall['starred'] ? true : false,
1396 'statusnet_html' => $converted["html"],
1397 'statusnet_conversation_id' => $lastwall['parent'],
1398 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1401 if (count($converted["attachments"]) > 0) {
1402 $user_info["status"]["attachments"] = $converted["attachments"];
1405 if (count($converted["entities"]) > 0) {
1406 $user_info["status"]["entities"] = $converted["entities"];
1409 if ($user_info["status"]["source"] == 'web') {
1410 $user_info["status"]["source"] = ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']);
1413 if (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $user_info["status"]["source"]) {
1414 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']) . ')');
1418 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1419 unset($user_info["uid"]);
1420 unset($user_info["self"]);
1422 return api_format_data("user", $type, ['user' => $user_info]);
1425 /// @TODO move to top of file or somewhere better
1426 api_register_func('api/users/show', 'api_users_show');
1427 api_register_func('api/externalprofile/show', 'api_users_show');
1430 * Search a public user account.
1432 * @param string $type Return type (atom, rss, xml, json)
1434 * @return array|string
1435 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1437 function api_users_search($type)
1443 if (!empty($_GET['q'])) {
1444 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", DBA::escape($_GET["q"]));
1446 if (!DBA::isResult($r)) {
1447 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", DBA::escape($_GET["q"]));
1450 if (DBA::isResult($r)) {
1452 foreach ($r as $user) {
1453 $user_info = api_get_user($a, $user["id"]);
1455 if ($type == "xml") {
1456 $userlist[$k++.":user"] = $user_info;
1458 $userlist[] = $user_info;
1461 $userlist = ["users" => $userlist];
1463 throw new BadRequestException("User ".$_GET["q"]." not found.");
1466 throw new BadRequestException("No user specified.");
1469 return api_format_data("users", $type, $userlist);
1472 /// @TODO move to top of file or somewhere better
1473 api_register_func('api/users/search', 'api_users_search');
1476 * Return user objects
1478 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1480 * @param string $type Return format: json or xml
1482 * @return array|string
1483 * @throws NotFoundException if the results are empty.
1485 function api_users_lookup($type)
1489 if (!empty($_REQUEST['user_id'])) {
1490 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1492 $users[] = api_get_user(get_app(), $id);
1497 if (empty($users)) {
1498 throw new NotFoundException;
1501 return api_format_data("users", $type, ['users' => $users]);
1504 /// @TODO move to top of file or somewhere better
1505 api_register_func('api/users/lookup', 'api_users_lookup', true);
1508 * Returns statuses that match a specified query.
1510 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1512 * @param string $type Return format: json, xml, atom, rss
1514 * @return array|string
1515 * @throws BadRequestException if the "q" parameter is missing.
1517 function api_search($type)
1520 $user_info = api_get_user($a);
1522 if (api_user() === false || $user_info === false) { throw new ForbiddenException(); }
1524 if (empty($_REQUEST['q'])) { throw new BadRequestException('q parameter is required.'); }
1526 $searchTerm = trim(rawurldecode($_REQUEST['q']));
1529 $data['status'] = [];
1531 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1532 if (!empty($_REQUEST['rpp'])) {
1533 $count = $_REQUEST['rpp'];
1534 } elseif (!empty($_REQUEST['count'])) {
1535 $count = $_REQUEST['count'];
1538 $since_id = defaults($_REQUEST, 'since_id', 0);
1539 $max_id = defaults($_REQUEST, 'max_id', 0);
1540 $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] - 1 : 0);
1541 $start = $page * $count;
1542 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1543 if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) {
1544 $searchTerm = $matches[1];
1545 $condition = ["`oid` > ?
1546 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1547 AND `otype` = ? AND `type` = ? AND `term` = ?",
1548 $since_id, local_user(), TERM_OBJ_POST, TERM_HASHTAG, $searchTerm];
1550 $condition[0] .= ' AND `oid` <= ?';
1551 $condition[] = $max_id;
1553 $terms = DBA::select('term', ['oid'], $condition, []);
1555 while ($term = DBA::fetch($terms)) {
1556 $itemIds[] = $term['oid'];
1560 if (empty($itemIds)) {
1561 return api_format_data('statuses', $type, $data);
1564 $preCondition = ['`id` IN (' . implode(', ', $itemIds) . ')'];
1565 if ($exclude_replies) {
1566 $preCondition[] = '`id` = `parent`';
1569 $condition = [implode(' AND ', $preCondition)];
1571 $condition = ["`id` > ?
1572 " . ($exclude_replies ? " AND `id` = `parent` " : ' ') . "
1573 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1574 AND `body` LIKE CONCAT('%',?,'%')",
1575 $since_id, api_user(), $_REQUEST['q']];
1577 $condition[0] .= ' AND `id` <= ?';
1578 $condition[] = $max_id;
1582 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1584 $data['status'] = api_format_items(Item::inArray($statuses), $user_info);
1586 bindComments($data['status']);
1588 return api_format_data('statuses', $type, $data);
1591 /// @TODO move to top of file or somewhere better
1592 api_register_func('api/search/tweets', 'api_search', true);
1593 api_register_func('api/search', 'api_search', true);
1596 * Returns the most recent statuses posted by the user and the users they follow.
1598 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1600 * @param string $type Return type (atom, rss, xml, json)
1602 * @todo Optional parameters
1603 * @todo Add reply info
1605 function api_statuses_home_timeline($type)
1608 $user_info = api_get_user($a);
1610 if (api_user() === false || $user_info === false) {
1611 throw new ForbiddenException();
1614 unset($_REQUEST["user_id"]);
1615 unset($_GET["user_id"]);
1617 unset($_REQUEST["screen_name"]);
1618 unset($_GET["screen_name"]);
1620 // get last network messages
1623 $count = defaults($_REQUEST, 'count', 20);
1624 $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] - 1 : 0);
1628 $since_id = defaults($_REQUEST, 'since_id', 0);
1629 $max_id = defaults($_REQUEST, 'max_id', 0);
1630 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1631 $conversation_id = defaults($_REQUEST, 'conversation_id', 0);
1633 $start = $page * $count;
1635 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1636 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1639 $condition[0] .= " AND `item`.`id` <= ?";
1640 $condition[] = $max_id;
1642 if ($exclude_replies) {
1643 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
1645 if ($conversation_id > 0) {
1646 $condition[0] .= " AND `item`.`parent` = ?";
1647 $condition[] = $conversation_id;
1650 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1651 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1653 $items = Item::inArray($statuses);
1655 $ret = api_format_items($items, $user_info, false, $type);
1657 // Set all posts from the query above to seen
1659 foreach ($items as $item) {
1660 $idarray[] = intval($item["id"]);
1663 if (!empty($idarray)) {
1664 $unseen = Item::exists(['unseen' => true, 'id' => $idarray]);
1666 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1672 $data = ['status' => $ret];
1677 $data = api_rss_extra($a, $data, $user_info);
1681 return api_format_data("statuses", $type, $data);
1685 /// @TODO move to top of file or somewhere better
1686 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1687 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1690 * Returns the most recent statuses from public users.
1692 * @param string $type Return type (atom, rss, xml, json)
1694 * @return array|string
1696 function api_statuses_public_timeline($type)
1699 $user_info = api_get_user($a);
1701 if (api_user() === false || $user_info === false) {
1702 throw new ForbiddenException();
1705 // get last network messages
1708 $count = defaults($_REQUEST, 'count', 20);
1709 $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] -1 : 0);
1713 $since_id = defaults($_REQUEST, 'since_id', 0);
1714 $max_id = defaults($_REQUEST, 'max_id', 0);
1715 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
1716 $conversation_id = defaults($_REQUEST, 'conversation_id', 0);
1718 $start = $page * $count;
1720 if ($exclude_replies && !$conversation_id) {
1721 $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall`",
1722 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1725 $condition[0] .= " AND `thread`.`iid` <= ?";
1726 $condition[] = $max_id;
1729 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1730 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1732 $r = Item::inArray($statuses);
1734 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND `item`.`origin`",
1735 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1738 $condition[0] .= " AND `item`.`id` <= ?";
1739 $condition[] = $max_id;
1741 if ($conversation_id > 0) {
1742 $condition[0] .= " AND `item`.`parent` = ?";
1743 $condition[] = $conversation_id;
1746 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1747 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1749 $r = Item::inArray($statuses);
1752 $ret = api_format_items($r, $user_info, false, $type);
1756 $data = ['status' => $ret];
1761 $data = api_rss_extra($a, $data, $user_info);
1765 return api_format_data("statuses", $type, $data);
1768 /// @TODO move to top of file or somewhere better
1769 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1772 * Returns the most recent statuses posted by users this node knows about.
1774 * @brief Returns the list of public federated posts this node knows about
1776 * @param string $type Return format: json, xml, atom, rss
1777 * @return array|string
1778 * @throws ForbiddenException
1780 function api_statuses_networkpublic_timeline($type)
1783 $user_info = api_get_user($a);
1785 if (api_user() === false || $user_info === false) {
1786 throw new ForbiddenException();
1789 $since_id = defaults($_REQUEST, 'since_id', 0);
1790 $max_id = defaults($_REQUEST, 'max_id', 0);
1793 $count = defaults($_REQUEST, 'count', 20);
1794 $page = defaults($_REQUEST, 'page', 1);
1798 $start = ($page - 1) * $count;
1800 $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `thread`.`iid` > ? AND NOT `private`",
1801 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1804 $condition[0] .= " AND `thread`.`iid` <= ?";
1805 $condition[] = $max_id;
1808 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1809 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1811 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1815 $data = ['status' => $ret];
1820 $data = api_rss_extra($a, $data, $user_info);
1824 return api_format_data("statuses", $type, $data);
1827 /// @TODO move to top of file or somewhere better
1828 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1831 * Returns a single status.
1833 * @param string $type Return type (atom, rss, xml, json)
1835 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1837 function api_statuses_show($type)
1840 $user_info = api_get_user($a);
1842 if (api_user() === false || $user_info === false) {
1843 throw new ForbiddenException();
1847 $id = intval(defaults($a->argv, 3, 0));
1850 $id = intval(defaults($_REQUEST, 'id', 0));
1855 $id = intval(defaults($a->argv, 4, 0));
1858 Logger::log('API: api_statuses_show: ' . $id);
1860 $conversation = !empty($_REQUEST['conversation']);
1862 // try to fetch the item for the local user - or the public item, if there is no local one
1863 $uri_item = Item::selectFirst(['uri'], ['id' => $id]);
1864 if (!DBA::isResult($uri_item)) {
1865 throw new BadRequestException("There is no status with this id.");
1868 $item = Item::selectFirst(['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1869 if (!DBA::isResult($item)) {
1870 throw new BadRequestException("There is no status with this id.");
1875 if ($conversation) {
1876 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1877 $params = ['order' => ['id' => true]];
1879 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1883 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1885 /// @TODO How about copying this to above methods which don't check $r ?
1886 if (!DBA::isResult($statuses)) {
1887 throw new BadRequestException("There is no status with this id.");
1890 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1892 if ($conversation) {
1893 $data = ['status' => $ret];
1894 return api_format_data("statuses", $type, $data);
1896 $data = ['status' => $ret[0]];
1897 return api_format_data("status", $type, $data);
1901 /// @TODO move to top of file or somewhere better
1902 api_register_func('api/statuses/show', 'api_statuses_show', true);
1906 * @param string $type Return type (atom, rss, xml, json)
1908 * @todo nothing to say?
1910 function api_conversation_show($type)
1913 $user_info = api_get_user($a);
1915 if (api_user() === false || $user_info === false) {
1916 throw new ForbiddenException();
1920 $id = intval(defaults($a->argv , 3 , 0));
1921 $since_id = intval(defaults($_REQUEST, 'since_id', 0));
1922 $max_id = intval(defaults($_REQUEST, 'max_id' , 0));
1923 $count = intval(defaults($_REQUEST, 'count' , 20));
1924 $page = intval(defaults($_REQUEST, 'page' , 1)) - 1;
1929 $start = $page * $count;
1932 $id = intval(defaults($_REQUEST, 'id', 0));
1937 $id = intval(defaults($a->argv, 4, 0));
1940 Logger::log('API: api_conversation_show: '.$id);
1942 // try to fetch the item for the local user - or the public item, if there is no local one
1943 $item = Item::selectFirst(['parent-uri'], ['id' => $id]);
1944 if (!DBA::isResult($item)) {
1945 throw new BadRequestException("There is no status with this id.");
1948 $parent = Item::selectFirst(['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1949 if (!DBA::isResult($parent)) {
1950 throw new BadRequestException("There is no status with this id.");
1953 $id = $parent['id'];
1955 $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1956 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1959 $condition[0] .= " AND `item`.`id` <= ?";
1960 $condition[] = $max_id;
1963 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1964 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1966 if (!DBA::isResult($statuses)) {
1967 throw new BadRequestException("There is no status with id $id.");
1970 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1972 $data = ['status' => $ret];
1973 return api_format_data("statuses", $type, $data);
1976 /// @TODO move to top of file or somewhere better
1977 api_register_func('api/conversation/show', 'api_conversation_show', true);
1978 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
1983 * @param string $type Return type (atom, rss, xml, json)
1985 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
1987 function api_statuses_repeat($type)
1993 if (api_user() === false) {
1994 throw new ForbiddenException();
2000 $id = intval(defaults($a->argv, 3, 0));
2003 $id = intval(defaults($_REQUEST, 'id', 0));
2008 $id = intval(defaults($a->argv, 4, 0));
2011 Logger::log('API: api_statuses_repeat: '.$id);
2013 $fields = ['body', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
2014 $item = Item::selectFirst($fields, ['id' => $id, 'private' => false]);
2016 if (DBA::isResult($item) && $item['body'] != "") {
2017 if (strpos($item['body'], "[/share]") !== false) {
2018 $pos = strpos($item['body'], "[share");
2019 $post = substr($item['body'], $pos);
2021 $post = share_header($item['author-name'], $item['author-link'], $item['author-avatar'], $item['guid'], $item['created'], $item['plink']);
2023 $post .= $item['body'];
2024 $post .= "[/share]";
2026 $_REQUEST['body'] = $post;
2027 $_REQUEST['profile_uid'] = api_user();
2028 $_REQUEST['api_source'] = true;
2030 if (empty($_REQUEST['source'])) {
2031 $_REQUEST["source"] = api_source();
2034 $item_id = item_post($a);
2036 throw new ForbiddenException();
2039 // output the post that we just posted.
2041 return api_status_show($type, $item_id);
2044 /// @TODO move to top of file or somewhere better
2045 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2048 * Destroys a specific status.
2050 * @param string $type Return type (atom, rss, xml, json)
2052 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2054 function api_statuses_destroy($type)
2058 if (api_user() === false) {
2059 throw new ForbiddenException();
2065 $id = intval(defaults($a->argv, 3, 0));
2068 $id = intval(defaults($_REQUEST, 'id', 0));
2073 $id = intval(defaults($a->argv, 4, 0));
2076 Logger::log('API: api_statuses_destroy: '.$id);
2078 $ret = api_statuses_show($type);
2080 Item::deleteForUser(['id' => $id], api_user());
2085 /// @TODO move to top of file or somewhere better
2086 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2089 * Returns the most recent mentions.
2091 * @param string $type Return type (atom, rss, xml, json)
2093 * @see http://developer.twitter.com/doc/get/statuses/mentions
2095 function api_statuses_mentions($type)
2098 $user_info = api_get_user($a);
2100 if (api_user() === false || $user_info === false) {
2101 throw new ForbiddenException();
2104 unset($_REQUEST["user_id"]);
2105 unset($_GET["user_id"]);
2107 unset($_REQUEST["screen_name"]);
2108 unset($_GET["screen_name"]);
2110 // get last network messages
2113 $since_id = defaults($_REQUEST, 'since_id', 0);
2114 $max_id = defaults($_REQUEST, 'max_id' , 0);
2115 $count = defaults($_REQUEST, 'count' , 20);
2116 $page = defaults($_REQUEST, 'page' , 1);
2121 $start = ($page - 1) * $count;
2123 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `author-id` != ?
2124 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `thread`.`uid` = ? AND `thread`.`mention` AND NOT `thread`.`ignored`)",
2125 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['pid'], api_user()];
2128 $condition[0] .= " AND `item`.`id` <= ?";
2129 $condition[] = $max_id;
2132 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2133 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2135 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2137 $data = ['status' => $ret];
2142 $data = api_rss_extra($a, $data, $user_info);
2146 return api_format_data("statuses", $type, $data);
2149 /// @TODO move to top of file or somewhere better
2150 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2151 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2154 * Returns the most recent statuses posted by the user.
2156 * @brief Returns a user's public timeline
2158 * @param string $type Either "json" or "xml"
2159 * @return string|array
2160 * @throws ForbiddenException
2161 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2163 function api_statuses_user_timeline($type)
2166 $user_info = api_get_user($a);
2168 if (api_user() === false || $user_info === false) {
2169 throw new ForbiddenException();
2173 "api_statuses_user_timeline: api_user: ". api_user() .
2174 "\nuser_info: ".print_r($user_info, true) .
2175 "\n_REQUEST: ".print_r($_REQUEST, true),
2179 $since_id = defaults($_REQUEST, 'since_id', 0);
2180 $max_id = defaults($_REQUEST, 'max_id', 0);
2181 $exclude_replies = !empty($_REQUEST['exclude_replies']);
2182 $conversation_id = defaults($_REQUEST, 'conversation_id', 0);
2185 $count = defaults($_REQUEST, 'count', 20);
2186 $page = defaults($_REQUEST, 'page', 1);
2190 $start = ($page - 1) * $count;
2192 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `item`.`contact-id` = ?",
2193 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2195 if ($user_info['self'] == 1) {
2196 $condition[0] .= ' AND `item`.`wall` ';
2199 if ($exclude_replies) {
2200 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
2203 if ($conversation_id > 0) {
2204 $condition[0] .= " AND `item`.`parent` = ?";
2205 $condition[] = $conversation_id;
2209 $condition[0] .= " AND `item`.`id` <= ?";
2210 $condition[] = $max_id;
2213 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2214 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2216 $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type);
2220 $data = ['status' => $ret];
2225 $data = api_rss_extra($a, $data, $user_info);
2229 return api_format_data("statuses", $type, $data);
2232 /// @TODO move to top of file or somewhere better
2233 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2236 * Star/unstar an item.
2237 * param: id : id of the item
2239 * @param string $type Return type (atom, rss, xml, json)
2241 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2243 function api_favorites_create_destroy($type)
2247 if (api_user() === false) {
2248 throw new ForbiddenException();
2251 // for versioned api.
2252 /// @TODO We need a better global soluton
2253 $action_argv_id = 2;
2254 if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2255 $action_argv_id = 3;
2258 if ($a->argc <= $action_argv_id) {
2259 throw new BadRequestException("Invalid request.");
2261 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2262 if ($a->argc == $action_argv_id + 2) {
2263 $itemid = intval(defaults($a->argv, $action_argv_id + 1, 0));
2265 $itemid = intval(defaults($_REQUEST, 'id', 0));
2268 $item = Item::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2270 if (!DBA::isResult($item)) {
2271 throw new BadRequestException("Invalid item.");
2276 $item['starred'] = 1;
2279 $item['starred'] = 0;
2282 throw new BadRequestException("Invalid action ".$action);
2285 $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2288 throw new InternalServerErrorException("DB error");
2292 $user_info = api_get_user($a);
2293 $rets = api_format_items([$item], $user_info, false, $type);
2296 $data = ['status' => $ret];
2301 $data = api_rss_extra($a, $data, $user_info);
2305 return api_format_data("status", $type, $data);
2308 /// @TODO move to top of file or somewhere better
2309 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2310 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2313 * Returns the most recent favorite statuses.
2315 * @param string $type Return type (atom, rss, xml, json)
2317 * @return string|array
2319 function api_favorites($type)
2324 $user_info = api_get_user($a);
2326 if (api_user() === false || $user_info === false) {
2327 throw new ForbiddenException();
2332 // in friendica starred item are private
2333 // return favorites only for self
2334 Logger::log('api_favorites: self:' . $user_info['self']);
2336 if ($user_info['self'] == 0) {
2340 $since_id = defaults($_REQUEST, 'since_id', 0);
2341 $max_id = defaults($_REQUEST, 'max_id', 0);
2342 $count = defaults($_GET, 'count', 20);
2343 $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] -1 : 0);
2348 $start = $page*$count;
2350 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2351 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2353 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2356 $condition[0] .= " AND `item`.`id` <= ?";
2357 $condition[] = $max_id;
2360 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2362 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2367 $data = ['status' => $ret];
2372 $data = api_rss_extra($a, $data, $user_info);
2376 return api_format_data("statuses", $type, $data);
2379 /// @TODO move to top of file or somewhere better
2380 api_register_func('api/favorites', 'api_favorites', true);
2384 * @param array $item
2385 * @param array $recipient
2386 * @param array $sender
2390 function api_format_messages($item, $recipient, $sender)
2392 // standard meta information
2394 'id' => $item['id'],
2395 'sender_id' => $sender['id'],
2397 'recipient_id' => $recipient['id'],
2398 'created_at' => api_date(defaults($item, 'created', DateTimeFormat::utcNow())),
2399 'sender_screen_name' => $sender['screen_name'],
2400 'recipient_screen_name' => $recipient['screen_name'],
2401 'sender' => $sender,
2402 'recipient' => $recipient,
2404 'friendica_seen' => defaults($item, 'seen', 0),
2405 'friendica_parent_uri' => defaults($item, 'parent-uri', ''),
2408 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2409 if (isset($ret['sender']['uid'])) {
2410 unset($ret['sender']['uid']);
2412 if (isset($ret['sender']['self'])) {
2413 unset($ret['sender']['self']);
2415 if (isset($ret['recipient']['uid'])) {
2416 unset($ret['recipient']['uid']);
2418 if (isset($ret['recipient']['self'])) {
2419 unset($ret['recipient']['self']);
2422 //don't send title to regular StatusNET requests to avoid confusing these apps
2423 if (!empty($_GET['getText'])) {
2424 $ret['title'] = $item['title'];
2425 if ($_GET['getText'] == 'html') {
2426 $ret['text'] = BBCode::convert($item['body'], false);
2427 } elseif ($_GET['getText'] == 'plain') {
2428 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2431 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2433 if (!empty($_GET['getUserObjects']) && $_GET['getUserObjects'] == 'false') {
2434 unset($ret['sender']);
2435 unset($ret['recipient']);
2443 * @param array $item
2447 function api_convert_item($item)
2449 $body = $item['body'];
2450 $attachments = api_get_attachments($body);
2452 // Workaround for ostatus messages where the title is identically to the body
2453 $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2454 $statusbody = trim(HTML::toPlaintext($html, 0));
2456 // handle data: images
2457 $statusbody = api_format_items_embeded_images($item, $statusbody);
2459 $statustitle = trim($item['title']);
2461 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2462 $statustext = trim($statusbody);
2464 $statustext = trim($statustitle."\n\n".$statusbody);
2467 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($statustext)> 1000)) {
2468 $statustext = substr($statustext, 0, 1000) . "... \n" . defaults($item, 'plink', '');
2471 $statushtml = BBCode::convert(api_clean_attachments($body), false);
2473 // Workaround for clients with limited HTML parser functionality
2474 $search = ["<br>", "<blockquote>", "</blockquote>",
2475 "<h1>", "</h1>", "<h2>", "</h2>",
2476 "<h3>", "</h3>", "<h4>", "</h4>",
2477 "<h5>", "</h5>", "<h6>", "</h6>"];
2478 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2479 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2480 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2481 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2482 $statushtml = str_replace($search, $replace, $statushtml);
2484 if ($item['title'] != "") {
2485 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2489 $oldtext = $statushtml;
2490 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2491 } while ($oldtext != $statushtml);
2493 if (substr($statushtml, 0, 4) == '<br>') {
2494 $statushtml = substr($statushtml, 4);
2497 if (substr($statushtml, 0, -4) == '<br>') {
2498 $statushtml = substr($statushtml, -4);
2501 // feeds without body should contain the link
2502 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2503 $statushtml .= BBCode::convert($item['plink']);
2506 $entities = api_get_entitities($statustext, $body);
2509 "text" => $statustext,
2510 "html" => $statushtml,
2511 "attachments" => $attachments,
2512 "entities" => $entities
2518 * @param string $body
2522 function api_get_attachments(&$body)
2525 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2527 $URLSearchString = "^\[\]";
2528 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2536 foreach ($images[1] as $image) {
2537 $imagedata = Image::getInfoFromURL($image);
2540 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2544 if (strstr(defaults($_SERVER, 'HTTP_USER_AGENT', ''), "AndStatus")) {
2545 foreach ($images[0] as $orig) {
2546 $body = str_replace($orig, "", $body);
2550 return $attachments;
2555 * @param string $text
2556 * @param string $bbcode
2559 * @todo Links at the first character of the post
2561 function api_get_entitities(&$text, $bbcode)
2563 $include_entities = strtolower(defaults($_REQUEST, 'include_entities', "false"));
2565 if ($include_entities != "true") {
2566 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2568 foreach ($images[1] as $image) {
2569 $replace = ProxyUtils::proxifyUrl($image);
2570 $text = str_replace($image, $replace, $text);
2575 $bbcode = BBCode::cleanPictureLinks($bbcode);
2577 // Change pure links in text to bbcode uris
2578 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2581 $entities["hashtags"] = [];
2582 $entities["symbols"] = [];
2583 $entities["urls"] = [];
2584 $entities["user_mentions"] = [];
2586 $URLSearchString = "^\[\]";
2588 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2590 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2591 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2592 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2594 $bbcode = preg_replace(
2595 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2596 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2599 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2601 $bbcode = preg_replace(
2602 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2603 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2606 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2608 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2610 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2611 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2614 foreach ($urls[1] as $id => $url) {
2615 //$start = strpos($text, $url, $offset);
2616 $start = iconv_strpos($text, $url, 0, "UTF-8");
2617 if (!($start === false)) {
2618 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2622 ksort($ordered_urls);
2625 //foreach ($urls[1] AS $id=>$url) {
2626 foreach ($ordered_urls as $url) {
2627 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2628 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2630 $display_url = $url["title"];
2632 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2633 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2635 if (strlen($display_url) > 26) {
2636 $display_url = substr($display_url, 0, 25)."…";
2640 //$start = strpos($text, $url, $offset);
2641 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2642 if (!($start === false)) {
2643 $entities["urls"][] = ["url" => $url["url"],
2644 "expanded_url" => $url["url"],
2645 "display_url" => $display_url,
2646 "indices" => [$start, $start+strlen($url["url"])]];
2647 $offset = $start + 1;
2651 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2652 $ordered_images = [];
2653 foreach ($images[1] as $image) {
2654 //$start = strpos($text, $url, $offset);
2655 $start = iconv_strpos($text, $image, 0, "UTF-8");
2656 if (!($start === false)) {
2657 $ordered_images[$start] = $image;
2660 //$entities["media"] = array();
2663 foreach ($ordered_images as $url) {
2664 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2665 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2667 if (strlen($display_url) > 26) {
2668 $display_url = substr($display_url, 0, 25)."…";
2671 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2672 if (!($start === false)) {
2673 $image = Image::getInfoFromURL($url);
2675 // If image cache is activated, then use the following sizes:
2676 // thumb (150), small (340), medium (600) and large (1024)
2677 if (!Config::get("system", "proxy_disabled")) {
2678 $media_url = ProxyUtils::proxifyUrl($url);
2681 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2682 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2684 if (($image[0] > 150) || ($image[1] > 150)) {
2685 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2686 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2689 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2690 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2692 if (($image[0] > 600) || ($image[1] > 600)) {
2693 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2694 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2698 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2701 $entities["media"][] = [
2703 "id_str" => (string)$start+1,
2704 "indices" => [$start, $start+strlen($url)],
2705 "media_url" => Strings::normaliseLink($media_url),
2706 "media_url_https" => $media_url,
2708 "display_url" => $display_url,
2709 "expanded_url" => $url,
2713 $offset = $start + 1;
2722 * @param array $item
2723 * @param string $text
2727 function api_format_items_embeded_images($item, $text)
2729 $text = preg_replace_callback(
2730 '|data:image/([^;]+)[^=]+=*|m',
2731 function () use ($item) {
2732 return System::baseUrl() . '/display/' . $item['guid'];
2740 * @brief return <a href='url'>name</a> as array
2742 * @param string $txt text
2747 function api_contactlink_to_array($txt)
2750 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2751 if ($r && count($match)==3) {
2753 'name' => $match[2],
2767 * @brief return likes, dislikes and attend status for item
2769 * @param array $item array
2770 * @param string $type Return type (atom, rss, xml, json)
2773 * likes => int count,
2774 * dislikes => int count
2776 function api_format_items_activities($item, $type = "json")
2785 'attendmaybe' => [],
2788 $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri']];
2789 $ret = Item::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2791 while ($parent_item = Item::fetch($ret)) {
2792 // not used as result should be structured like other user data
2793 //builtin_activity_puller($i, $activities);
2795 // get user data and add it to the array of the activity
2796 $user = api_get_user($a, $parent_item['author-id']);
2797 switch ($parent_item['verb']) {
2799 $activities['like'][] = $user;
2801 case ACTIVITY_DISLIKE:
2802 $activities['dislike'][] = $user;
2804 case ACTIVITY_ATTEND:
2805 $activities['attendyes'][] = $user;
2807 case ACTIVITY_ATTENDNO:
2808 $activities['attendno'][] = $user;
2810 case ACTIVITY_ATTENDMAYBE:
2811 $activities['attendmaybe'][] = $user;
2820 if ($type == "xml") {
2821 $xml_activities = [];
2822 foreach ($activities as $k => $v) {
2823 // change xml element from "like" to "friendica:like"
2824 $xml_activities["friendica:".$k] = $v;
2825 // add user data into xml output
2827 foreach ($v as $user) {
2828 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2831 $activities = $xml_activities;
2839 * @brief return data from profiles
2841 * @param array $profile_row array containing data from db table 'profile'
2844 function api_format_items_profiles($profile_row)
2847 'profile_id' => $profile_row['id'],
2848 'profile_name' => $profile_row['profile-name'],
2849 'is_default' => $profile_row['is-default'] ? true : false,
2850 'hide_friends' => $profile_row['hide-friends'] ? true : false,
2851 'profile_photo' => $profile_row['photo'],
2852 'profile_thumb' => $profile_row['thumb'],
2853 'publish' => $profile_row['publish'] ? true : false,
2854 'net_publish' => $profile_row['net-publish'] ? true : false,
2855 'description' => $profile_row['pdesc'],
2856 'date_of_birth' => $profile_row['dob'],
2857 'address' => $profile_row['address'],
2858 'city' => $profile_row['locality'],
2859 'region' => $profile_row['region'],
2860 'postal_code' => $profile_row['postal-code'],
2861 'country' => $profile_row['country-name'],
2862 'hometown' => $profile_row['hometown'],
2863 'gender' => $profile_row['gender'],
2864 'marital' => $profile_row['marital'],
2865 'marital_with' => $profile_row['with'],
2866 'marital_since' => $profile_row['howlong'],
2867 'sexual' => $profile_row['sexual'],
2868 'politic' => $profile_row['politic'],
2869 'religion' => $profile_row['religion'],
2870 'public_keywords' => $profile_row['pub_keywords'],
2871 'private_keywords' => $profile_row['prv_keywords'],
2872 'likes' => BBCode::convert(api_clean_plain_items($profile_row['likes']) , false, 2),
2873 'dislikes' => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
2874 'about' => BBCode::convert(api_clean_plain_items($profile_row['about']) , false, 2),
2875 'music' => BBCode::convert(api_clean_plain_items($profile_row['music']) , false, 2),
2876 'book' => BBCode::convert(api_clean_plain_items($profile_row['book']) , false, 2),
2877 'tv' => BBCode::convert(api_clean_plain_items($profile_row['tv']) , false, 2),
2878 'film' => BBCode::convert(api_clean_plain_items($profile_row['film']) , false, 2),
2879 'interest' => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
2880 'romance' => BBCode::convert(api_clean_plain_items($profile_row['romance']) , false, 2),
2881 'work' => BBCode::convert(api_clean_plain_items($profile_row['work']) , false, 2),
2882 'education' => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
2883 'social_networks' => BBCode::convert(api_clean_plain_items($profile_row['contact']) , false, 2),
2884 'homepage' => $profile_row['homepage'],
2891 * @brief format items to be returned by api
2893 * @param array $r array of items
2894 * @param array $user_info
2895 * @param bool $filter_user filter items by $user_info
2896 * @param string $type Return type (atom, rss, xml, json)
2898 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
2904 foreach ((array)$r as $item) {
2905 localize_item($item);
2906 list($status_user, $owner_user) = api_item_get_user($a, $item);
2908 // Look if the posts are matching if they should be filtered by user id
2909 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2913 $in_reply_to = api_in_reply_to($item);
2915 $converted = api_convert_item($item);
2917 if ($type == "xml") {
2918 $geo = "georss:point";
2924 'text' => $converted["text"],
2925 'truncated' => false,
2926 'created_at'=> api_date($item['created']),
2927 'in_reply_to_status_id' => $in_reply_to['status_id'],
2928 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
2929 'source' => (($item['app']) ? $item['app'] : 'web'),
2930 'id' => intval($item['id']),
2931 'id_str' => (string) intval($item['id']),
2932 'in_reply_to_user_id' => $in_reply_to['user_id'],
2933 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
2934 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
2936 'favorited' => $item['starred'] ? true : false,
2937 'user' => $status_user,
2938 'friendica_owner' => $owner_user,
2939 'friendica_private' => $item['private'] == 1,
2940 //'entities' => NULL,
2941 'statusnet_html' => $converted["html"],
2942 'statusnet_conversation_id' => $item['parent'],
2943 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
2944 'friendica_activities' => api_format_items_activities($item, $type),
2947 if (count($converted["attachments"]) > 0) {
2948 $status["attachments"] = $converted["attachments"];
2951 if (count($converted["entities"]) > 0) {
2952 $status["entities"] = $converted["entities"];
2955 if ($status["source"] == 'web') {
2956 $status["source"] = ContactSelector::networkToName($item['network'], $item['author-link']);
2957 } elseif (ContactSelector::networkToName($item['network'], $item['author-link']) != $status["source"]) {
2958 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $item['author-link']).')');
2961 if ($item["id"] == $item["parent"]) {
2962 $retweeted_item = api_share_as_retweet($item);
2963 if ($retweeted_item !== false) {
2964 $retweeted_status = $status;
2965 $status['user'] = $status['friendica_owner'];
2967 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
2968 } catch (BadRequestException $e) {
2969 // user not found. should be found?
2970 /// @todo check if the user should be always found
2971 $retweeted_status["user"] = [];
2974 $rt_converted = api_convert_item($retweeted_item);
2976 $retweeted_status['text'] = $rt_converted["text"];
2977 $retweeted_status['statusnet_html'] = $rt_converted["html"];
2978 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
2979 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
2980 $status['retweeted_status'] = $retweeted_status;
2984 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2985 unset($status["user"]["uid"]);
2986 unset($status["user"]["self"]);
2988 if ($item["coord"] != "") {
2989 $coords = explode(' ', $item["coord"]);
2990 if (count($coords) == 2) {
2991 if ($type == "json") {
2992 $status["geo"] = ['type' => 'Point',
2993 'coordinates' => [(float) $coords[0],
2994 (float) $coords[1]]];
2995 } else {// Not sure if this is the official format - if someone founds a documentation we can check
2996 $status["georss:point"] = $item["coord"];
3006 * Returns the remaining number of API requests available to the user before the API limit is reached.
3008 * @param string $type Return type (atom, rss, xml, json)
3010 * @return array|string
3012 function api_account_rate_limit_status($type)
3014 if ($type == "xml") {
3016 'remaining-hits' => '150',
3017 '@attributes' => ["type" => "integer"],
3018 'hourly-limit' => '150',
3019 '@attributes2' => ["type" => "integer"],
3020 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
3021 '@attributes3' => ["type" => "datetime"],
3022 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3023 '@attributes4' => ["type" => "integer"],
3027 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3028 'remaining_hits' => '150',
3029 'hourly_limit' => '150',
3030 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
3034 return api_format_data('hash', $type, ['hash' => $hash]);
3037 /// @TODO move to top of file or somewhere better
3038 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3041 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3043 * @param string $type Return type (atom, rss, xml, json)
3045 * @return array|string
3047 function api_help_test($type)
3049 if ($type == 'xml') {
3055 return api_format_data('ok', $type, ["ok" => $ok]);
3058 /// @TODO move to top of file or somewhere better
3059 api_register_func('api/help/test', 'api_help_test', false);
3062 * Returns all lists the user subscribes to.
3064 * @param string $type Return type (atom, rss, xml, json)
3066 * @return array|string
3067 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3069 function api_lists_list($type)
3072 /// @TODO $ret is not filled here?
3073 return api_format_data('lists', $type, ["lists_list" => $ret]);
3076 /// @TODO move to top of file or somewhere better
3077 api_register_func('api/lists/list', 'api_lists_list', true);
3078 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3081 * Returns all groups the user owns.
3083 * @param string $type Return type (atom, rss, xml, json)
3085 * @return array|string
3086 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3088 function api_lists_ownerships($type)
3092 if (api_user() === false) {
3093 throw new ForbiddenException();
3097 $user_info = api_get_user($a);
3098 $uid = $user_info['uid'];
3100 $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3102 // loop through all groups
3104 foreach ($groups as $group) {
3105 if ($group['visible']) {
3111 'name' => $group['name'],
3112 'id' => intval($group['id']),
3113 'id_str' => (string) $group['id'],
3114 'user' => $user_info,
3118 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3121 /// @TODO move to top of file or somewhere better
3122 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3125 * Returns recent statuses from users in the specified group.
3127 * @param string $type Return type (atom, rss, xml, json)
3129 * @return array|string
3130 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3132 function api_lists_statuses($type)
3136 $user_info = api_get_user($a);
3137 if (api_user() === false || $user_info === false) {
3138 throw new ForbiddenException();
3141 unset($_REQUEST["user_id"]);
3142 unset($_GET["user_id"]);
3144 unset($_REQUEST["screen_name"]);
3145 unset($_GET["screen_name"]);
3147 if (empty($_REQUEST['list_id'])) {
3148 throw new BadRequestException('list_id not specified');
3152 $count = defaults($_REQUEST, 'count', 20);
3153 $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] - 1 : 0);
3157 $since_id = defaults($_REQUEST, 'since_id', 0);
3158 $max_id = defaults($_REQUEST, 'max_id', 0);
3159 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
3160 $conversation_id = defaults($_REQUEST, 'conversation_id', 0);
3162 $start = $page * $count;
3164 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3165 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3168 $condition[0] .= " AND `item`.`id` <= ?";
3169 $condition[] = $max_id;
3171 if ($exclude_replies > 0) {
3172 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
3174 if ($conversation_id > 0) {
3175 $condition[0] .= " AND `item`.`parent` = ?";
3176 $condition[] = $conversation_id;
3179 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3180 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3182 $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3184 $data = ['status' => $items];
3189 $data = api_rss_extra($a, $data, $user_info);
3193 return api_format_data("statuses", $type, $data);
3196 /// @TODO move to top of file or somewhere better
3197 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3200 * Considers friends and followers lists to be private and won't return
3201 * anything if any user_id parameter is passed.
3203 * @brief Returns either the friends of the follower list
3205 * @param string $qtype Either "friends" or "followers"
3206 * @return boolean|array
3207 * @throws ForbiddenException
3209 function api_statuses_f($qtype)
3213 if (api_user() === false) {
3214 throw new ForbiddenException();
3218 $count = defaults($_GET, 'count', 20);
3219 $page = defaults($_GET, 'page', 1);
3223 $start = ($page - 1) * $count;
3225 $user_info = api_get_user($a);
3227 if (!empty($_GET['cursor']) && $_GET['cursor'] == 'undefined') {
3228 /* this is to stop Hotot to load friends multiple times
3229 * I'm not sure if I'm missing return something or
3230 * is a bug in hotot. Workaround, meantime
3234 return array('$users' => $ret);*/
3239 if ($qtype == 'friends') {
3240 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
3241 } elseif ($qtype == 'followers') {
3242 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
3245 // friends and followers only for self
3246 if ($user_info['self'] == 0) {
3247 $sql_extra = " AND false ";
3250 if ($qtype == 'blocks') {
3251 $sql_filter = 'AND `blocked` AND NOT `pending`';
3252 } elseif ($qtype == 'incoming') {
3253 $sql_filter = 'AND `pending`';
3255 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3273 foreach ($r as $cid) {
3274 $user = api_get_user($a, $cid['nurl']);
3275 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3276 unset($user["uid"]);
3277 unset($user["self"]);
3284 return ['user' => $ret];
3289 * Returns the user's friends.
3291 * @brief Returns the list of friends of the provided user
3293 * @deprecated By Twitter API in favor of friends/list
3295 * @param string $type Either "json" or "xml"
3296 * @return boolean|string|array
3298 function api_statuses_friends($type)
3300 $data = api_statuses_f("friends");
3301 if ($data === false) {
3304 return api_format_data("users", $type, $data);
3308 * Returns the user's followers.
3310 * @brief Returns the list of followers of the provided user
3312 * @deprecated By Twitter API in favor of friends/list
3314 * @param string $type Either "json" or "xml"
3315 * @return boolean|string|array
3317 function api_statuses_followers($type)
3319 $data = api_statuses_f("followers");
3320 if ($data === false) {
3323 return api_format_data("users", $type, $data);
3326 /// @TODO move to top of file or somewhere better
3327 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3328 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3331 * Returns the list of blocked users
3333 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3335 * @param string $type Either "json" or "xml"
3337 * @return boolean|string|array
3339 function api_blocks_list($type)
3341 $data = api_statuses_f('blocks');
3342 if ($data === false) {
3345 return api_format_data("users", $type, $data);
3348 /// @TODO move to top of file or somewhere better
3349 api_register_func('api/blocks/list', 'api_blocks_list', true);
3352 * Returns the list of pending users IDs
3354 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3356 * @param string $type Either "json" or "xml"
3358 * @return boolean|string|array
3360 function api_friendships_incoming($type)
3362 $data = api_statuses_f('incoming');
3363 if ($data === false) {
3368 foreach ($data['user'] as $user) {
3369 $ids[] = $user['id'];
3372 return api_format_data("ids", $type, ['id' => $ids]);
3375 /// @TODO move to top of file or somewhere better
3376 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3379 * Returns the instance's configuration information.
3381 * @param string $type Return type (atom, rss, xml, json)
3383 * @return array|string
3385 function api_statusnet_config($type)
3389 $name = Config::get('config', 'sitename');
3390 $server = $a->getHostName();
3391 $logo = System::baseUrl() . '/images/friendica-64.png';
3392 $email = Config::get('config', 'admin_email');
3393 $closed = intval(Config::get('config', 'register_policy')) === REGISTER_CLOSED ? 'true' : 'false';
3394 $private = Config::get('system', 'block_public') ? 'true' : 'false';
3395 $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000));
3396 $ssl = Config::get('system', 'have_ssl') ? 'true' : 'false';
3397 $sslserver = Config::get('system', 'have_ssl') ? str_replace('http:', 'https:', System::baseUrl()) : '';
3400 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3401 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3402 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3403 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3404 'shorturllength' => '30',
3406 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3407 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3408 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3409 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3414 return api_format_data('config', $type, ['config' => $config]);
3417 /// @TODO move to top of file or somewhere better
3418 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3419 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3423 * @param string $type Return type (atom, rss, xml, json)
3425 * @return array|string
3427 function api_statusnet_version($type)
3430 $fake_statusnet_version = "0.9.7";
3432 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3435 /// @TODO move to top of file or somewhere better
3436 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3437 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3441 * @param string $type Return type (atom, rss, xml, json)
3443 * @todo use api_format_data() to return data
3445 function api_ff_ids($type)
3448 throw new ForbiddenException();
3455 $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3458 "SELECT `pcontact`.`id` FROM `contact`
3459 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3460 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3463 if (!DBA::isResult($r)) {
3468 foreach ($r as $rr) {
3469 if ($stringify_ids) {
3472 $ids[] = intval($rr['id']);
3476 return api_format_data("ids", $type, ['id' => $ids]);
3480 * Returns the ID of every user the user is following.
3482 * @param string $type Return type (atom, rss, xml, json)
3484 * @return array|string
3485 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3487 function api_friends_ids($type)
3489 return api_ff_ids($type);
3493 * Returns the ID of every user following the user.
3495 * @param string $type Return type (atom, rss, xml, json)
3497 * @return array|string
3498 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3500 function api_followers_ids($type)
3502 return api_ff_ids($type);
3505 /// @TODO move to top of file or somewhere better
3506 api_register_func('api/friends/ids', 'api_friends_ids', true);
3507 api_register_func('api/followers/ids', 'api_followers_ids', true);
3510 * Sends a new direct message.
3512 * @param string $type Return type (atom, rss, xml, json)
3514 * @return array|string
3515 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3517 function api_direct_messages_new($type)
3521 if (api_user() === false) {
3522 throw new ForbiddenException();
3525 if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3529 $sender = api_get_user($a);
3532 if (!empty($_POST['screen_name'])) {
3534 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3536 DBA::escape($_POST['screen_name'])
3539 if (DBA::isResult($r)) {
3540 // Selecting the id by priority, friendica first
3541 api_best_nickname($r);
3543 $recipient = api_get_user($a, $r[0]['nurl']);
3546 $recipient = api_get_user($a, $_POST['user_id']);
3549 if (empty($recipient)) {
3550 throw new NotFoundException('Recipient not found');
3555 if (!empty($_REQUEST['replyto'])) {
3557 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3559 intval($_REQUEST['replyto'])
3561 $replyto = $r[0]['parent-uri'];
3562 $sub = $r[0]['title'];
3564 if (!empty($_REQUEST['title'])) {
3565 $sub = $_REQUEST['title'];
3567 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3571 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3574 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3575 $ret = api_format_messages($r[0], $recipient, $sender);
3577 $ret = ["error"=>$id];
3580 $data = ['direct_message'=>$ret];
3586 $data = api_rss_extra($a, $data, $sender);
3590 return api_format_data("direct-messages", $type, $data);
3593 /// @TODO move to top of file or somewhere better
3594 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3597 * Destroys a direct message.
3599 * @brief delete a direct_message from mail table through api
3601 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3602 * @return string|array
3603 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3605 function api_direct_messages_destroy($type)
3609 if (api_user() === false) {
3610 throw new ForbiddenException();
3614 $user_info = api_get_user($a);
3616 $id = defaults($_REQUEST, 'id', 0);
3618 $parenturi = defaults($_REQUEST, 'friendica_parenturi', "");
3619 $verbose = (!empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false");
3620 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3622 $uid = $user_info['uid'];
3623 // error if no id or parenturi specified (for clients posting parent-uri as well)
3624 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3625 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3626 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3629 // BadRequestException if no id specified (for clients using Twitter API)
3631 throw new BadRequestException('Message id not specified');
3634 // add parent-uri to sql command if specified by calling app
3635 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3637 // get data of the specified message id
3639 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3644 // error message if specified id is not in database
3645 if (!DBA::isResult($r)) {
3646 if ($verbose == "true") {
3647 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3648 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3650 /// @todo BadRequestException ok for Twitter API clients?
3651 throw new BadRequestException('message id not in database');
3656 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3661 if ($verbose == "true") {
3664 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3665 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3667 $answer = ['result' => 'error', 'message' => 'unknown error'];
3668 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3671 /// @todo return JSON data like Twitter API not yet implemented
3674 /// @TODO move to top of file or somewhere better
3675 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3680 * @brief unfollow contact
3682 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3683 * @return string|array
3684 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3686 function api_friendships_destroy($type)
3690 if ($uid === false) {
3691 throw new ForbiddenException();
3694 $contact_id = defaults($_REQUEST, 'user_id');
3696 if (empty($contact_id)) {
3697 Logger::log("No user_id specified", Logger::DEBUG);
3698 throw new BadRequestException("no user_id specified");
3701 // Get Contact by given id
3702 $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3704 if(!DBA::isResult($contact)) {
3705 Logger::log("No contact found for ID" . $contact_id, Logger::DEBUG);
3706 throw new NotFoundException("no contact found to given ID");
3709 $url = $contact["url"];
3711 $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3712 $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url),
3713 Strings::normaliseLink($url), $url];
3714 $contact = DBA::selectFirst('contact', [], $condition);
3716 if (!DBA::isResult($contact)) {
3717 Logger::log("Not following Contact", Logger::DEBUG);
3718 throw new NotFoundException("Not following Contact");
3721 if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
3722 Logger::log("Not supported", Logger::DEBUG);
3723 throw new ExpectationFailedException("Not supported");
3726 $dissolve = ($contact['rel'] == Contact::SHARING);
3728 $owner = User::getOwnerDataById($uid);
3730 Contact::terminateFriendship($owner, $contact, $dissolve);
3733 Logger::log("No owner found", Logger::DEBUG);
3734 throw new NotFoundException("Error Processing Request");
3737 // Sharing-only contacts get deleted as there no relationship any more
3739 Contact::remove($contact['id']);
3741 DBA::update('contact', ['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
3744 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3745 unset($contact["uid"]);
3746 unset($contact["self"]);
3748 // Set screen_name since Twidere requests it
3749 $contact["screen_name"] = $contact["nick"];
3751 return api_format_data("friendships-destroy", $type, ['user' => $contact]);
3753 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3757 * @param string $type Return type (atom, rss, xml, json)
3758 * @param string $box
3759 * @param string $verbose
3761 * @return array|string
3763 function api_direct_messages_box($type, $box, $verbose)
3766 if (api_user() === false) {
3767 throw new ForbiddenException();
3770 $count = defaults($_GET, 'count', 20);
3771 $page = defaults($_REQUEST, 'page', 1) - 1;
3776 $since_id = defaults($_REQUEST, 'since_id', 0);
3777 $max_id = defaults($_REQUEST, 'max_id', 0);
3779 $user_id = defaults($_REQUEST, 'user_id', '');
3780 $screen_name = defaults($_REQUEST, 'screen_name', '');
3783 unset($_REQUEST["user_id"]);
3784 unset($_GET["user_id"]);
3786 unset($_REQUEST["screen_name"]);
3787 unset($_GET["screen_name"]);
3789 $user_info = api_get_user($a);
3790 if ($user_info === false) {
3791 throw new ForbiddenException();
3793 $profile_url = $user_info["url"];
3796 $start = $page * $count;
3801 if ($box=="sentbox") {
3802 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
3803 } elseif ($box == "conversation") {
3804 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape(defaults($_GET, 'uri', '')) . "'";
3805 } elseif ($box == "all") {
3806 $sql_extra = "true";
3807 } elseif ($box == "inbox") {
3808 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
3812 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3815 if ($user_id != "") {
3816 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3817 } elseif ($screen_name !="") {
3818 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
3822 "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",
3828 if ($verbose == "true" && !DBA::isResult($r)) {
3829 $answer = ['result' => 'error', 'message' => 'no mails available'];
3830 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3834 foreach ($r as $item) {
3835 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3836 $recipient = $user_info;
3837 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3838 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3839 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3840 $sender = $user_info;
3843 if (isset($recipient) && isset($sender)) {
3844 $ret[] = api_format_messages($item, $recipient, $sender);
3849 $data = ['direct_message' => $ret];
3854 $data = api_rss_extra($a, $data, $user_info);
3858 return api_format_data("direct-messages", $type, $data);
3862 * Returns the most recent direct messages sent by the user.
3864 * @param string $type Return type (atom, rss, xml, json)
3866 * @return array|string
3867 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3869 function api_direct_messages_sentbox($type)
3871 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3872 return api_direct_messages_box($type, "sentbox", $verbose);
3876 * Returns the most recent direct messages sent to the user.
3878 * @param string $type Return type (atom, rss, xml, json)
3880 * @return array|string
3881 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3883 function api_direct_messages_inbox($type)
3885 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3886 return api_direct_messages_box($type, "inbox", $verbose);
3891 * @param string $type Return type (atom, rss, xml, json)
3893 * @return array|string
3895 function api_direct_messages_all($type)
3897 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3898 return api_direct_messages_box($type, "all", $verbose);
3903 * @param string $type Return type (atom, rss, xml, json)
3905 * @return array|string
3907 function api_direct_messages_conversation($type)
3909 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3910 return api_direct_messages_box($type, "conversation", $verbose);
3913 /// @TODO move to top of file or somewhere better
3914 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3915 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3916 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3917 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3920 * Returns an OAuth Request Token.
3922 * @see https://oauth.net/core/1.0/#auth_step1
3924 function api_oauth_request_token()
3926 $oauth1 = new FKOAuth1();
3928 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
3929 } catch (Exception $e) {
3930 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
3938 * Returns an OAuth Access Token.
3940 * @return array|string
3941 * @see https://oauth.net/core/1.0/#auth_step3
3943 function api_oauth_access_token()
3945 $oauth1 = new FKOAuth1();
3947 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
3948 } catch (Exception $e) {
3949 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
3956 /// @TODO move to top of file or somewhere better
3957 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
3958 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
3962 * @brief delete a complete photoalbum with all containing photos from database through api
3964 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3965 * @return string|array
3967 function api_fr_photoalbum_delete($type)
3969 if (api_user() === false) {
3970 throw new ForbiddenException();
3973 $album = defaults($_REQUEST, 'album', "");
3975 // we do not allow calls without album string
3977 throw new BadRequestException("no albumname specified");
3979 // check if album is existing
3981 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3985 if (!DBA::isResult($r)) {
3986 throw new BadRequestException("album not available");
3989 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
3990 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
3991 foreach ($r as $rr) {
3992 $condition = ['uid' => local_user(), 'resource-id' => $rr['resource-id'], 'type' => 'photo'];
3993 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
3995 if (!DBA::isResult($photo_item)) {
3996 throw new InternalServerErrorException("problem with deleting items occured");
3998 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4001 // now let's delete all photos from the album
4002 $result = Photo::delete(['uid' => api_user(), 'album' => $album]);
4004 // return success of deletion or error message
4006 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
4007 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
4009 throw new InternalServerErrorException("unknown error - deleting from database failed");
4014 * @brief update the name of the album for all photos of an album
4016 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4017 * @return string|array
4019 function api_fr_photoalbum_update($type)
4021 if (api_user() === false) {
4022 throw new ForbiddenException();
4025 $album = defaults($_REQUEST, 'album', "");
4026 $album_new = defaults($_REQUEST, 'album_new', "");
4028 // we do not allow calls without album string
4030 throw new BadRequestException("no albumname specified");
4032 if ($album_new == "") {
4033 throw new BadRequestException("no new albumname specified");
4035 // check if album is existing
4036 if (!Photo::exists(['uid' => api_user(), 'album' => $album])) {
4037 throw new BadRequestException("album not available");
4039 // now let's update all photos to the albumname
4040 $result = Photo::update(['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
4042 // return success of updating or error message
4044 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4045 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4047 throw new InternalServerErrorException("unknown error - updating in database failed");
4053 * @brief list all photos of the authenticated user
4055 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4056 * @return string|array
4058 function api_fr_photos_list($type)
4060 if (api_user() === false) {
4061 throw new ForbiddenException();
4064 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4065 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4066 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
4067 intval(local_user())
4070 'image/jpeg' => 'jpg',
4071 'image/png' => 'png',
4072 'image/gif' => 'gif'
4074 $data = ['photo'=>[]];
4075 if (DBA::isResult($r)) {
4076 foreach ($r as $rr) {
4078 $photo['id'] = $rr['resource-id'];
4079 $photo['album'] = $rr['album'];
4080 $photo['filename'] = $rr['filename'];
4081 $photo['type'] = $rr['type'];
4082 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4083 $photo['created'] = $rr['created'];
4084 $photo['edited'] = $rr['edited'];
4085 $photo['desc'] = $rr['desc'];
4087 if ($type == "xml") {
4088 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4090 $photo['thumb'] = $thumb;
4091 $data['photo'][] = $photo;
4095 return api_format_data("photos", $type, $data);
4099 * @brief upload a new photo or change an existing photo
4101 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4102 * @return string|array
4104 function api_fr_photo_create_update($type)
4106 if (api_user() === false) {
4107 throw new ForbiddenException();
4110 $photo_id = defaults($_REQUEST, 'photo_id', null);
4111 $desc = defaults($_REQUEST, 'desc', (array_key_exists('desc', $_REQUEST) ? "" : null)) ; // extra check necessary to distinguish between 'not provided' and 'empty string'
4112 $album = defaults($_REQUEST, 'album', null);
4113 $album_new = defaults($_REQUEST, 'album_new', null);
4114 $allow_cid = defaults($_REQUEST, 'allow_cid', (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
4115 $deny_cid = defaults($_REQUEST, 'deny_cid' , (array_key_exists('deny_cid' , $_REQUEST) ? " " : null));
4116 $allow_gid = defaults($_REQUEST, 'allow_gid', (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
4117 $deny_gid = defaults($_REQUEST, 'deny_gid' , (array_key_exists('deny_gid' , $_REQUEST) ? " " : null));
4118 $visibility = !empty($_REQUEST['visibility']) && $_REQUEST['visibility'] !== "false";
4120 // do several checks on input parameters
4121 // we do not allow calls without album string
4122 if ($album == null) {
4123 throw new BadRequestException("no albumname specified");
4125 // if photo_id == null --> we are uploading a new photo
4126 if ($photo_id == null) {
4129 // error if no media posted in create-mode
4130 if (empty($_FILES['media'])) {
4132 throw new BadRequestException("no media data submitted");
4135 // album_new will be ignored in create-mode
4140 // check if photo is existing in databasei
4141 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user(), 'album' => $album])) {
4142 throw new BadRequestException("photo not available");
4146 // checks on acl strings provided by clients
4147 $acl_input_error = false;
4148 $acl_input_error |= check_acl_input($allow_cid);
4149 $acl_input_error |= check_acl_input($deny_cid);
4150 $acl_input_error |= check_acl_input($allow_gid);
4151 $acl_input_error |= check_acl_input($deny_gid);
4152 if ($acl_input_error) {
4153 throw new BadRequestException("acl data invalid");
4155 // now let's upload the new media in create-mode
4156 if ($mode == "create") {
4157 $media = $_FILES['media'];
4158 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4160 // return success of updating or error message
4161 if (!is_null($data)) {
4162 return api_format_data("photo_create", $type, $data);
4164 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4168 // now let's do the changes in update-mode
4169 if ($mode == "update") {
4170 $updated_fields = [];
4172 if (!is_null($desc)) {
4173 $updated_fields['desc'] = $desc;
4176 if (!is_null($album_new)) {
4177 $updated_fields['album'] = $album_new;
4180 if (!is_null($allow_cid)) {
4181 $allow_cid = trim($allow_cid);
4182 $updated_fields['allow_cid'] = $allow_cid;
4185 if (!is_null($deny_cid)) {
4186 $deny_cid = trim($deny_cid);
4187 $updated_fields['deny_cid'] = $deny_cid;
4190 if (!is_null($allow_gid)) {
4191 $allow_gid = trim($allow_gid);
4192 $updated_fields['allow_gid'] = $allow_gid;
4195 if (!is_null($deny_gid)) {
4196 $deny_gid = trim($deny_gid);
4197 $updated_fields['deny_gid'] = $deny_gid;
4201 if (count($updated_fields) > 0) {
4202 $nothingtodo = false;
4203 $result = Photo::update($updated_fields, ['uid' => api_user(), 'resource-id' => $photo_id, 'album' => $album]);
4205 $nothingtodo = true;
4208 if (!empty($_FILES['media'])) {
4209 $nothingtodo = false;
4210 $media = $_FILES['media'];
4211 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4212 if (!is_null($data)) {
4213 return api_format_data("photo_update", $type, $data);
4217 // return success of updating or error message
4219 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4220 return api_format_data("photo_update", $type, ['$result' => $answer]);
4223 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4224 return api_format_data("photo_update", $type, ['$result' => $answer]);
4226 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4229 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4233 * @brief delete a single photo from the database through api
4235 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4236 * @return string|array
4238 function api_fr_photo_delete($type)
4240 if (api_user() === false) {
4241 throw new ForbiddenException();
4244 $photo_id = defaults($_REQUEST, 'photo_id', null);
4246 // do several checks on input parameters
4247 // we do not allow calls without photo id
4248 if ($photo_id == null) {
4249 throw new BadRequestException("no photo_id specified");
4251 // check if photo is existing in database
4252 $r = Photo::exists(['resource-id' => $photo_id, 'uid' => api_user()]);
4254 throw new BadRequestException("photo not available");
4256 // now we can perform on the deletion of the photo
4257 $result = Photo::delete(['uid' => api_user(), 'resource-id' => $photo_id]);
4259 // return success of deletion or error message
4261 // retrieve the id of the parent element (the photo element)
4262 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4263 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4265 if (!DBA::isResult($photo_item)) {
4266 throw new InternalServerErrorException("problem with deleting items occured");
4268 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4269 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4270 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4272 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4273 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4275 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4281 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4283 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4284 * @return string|array
4286 function api_fr_photo_detail($type)
4288 if (api_user() === false) {
4289 throw new ForbiddenException();
4291 if (empty($_REQUEST['photo_id'])) {
4292 throw new BadRequestException("No photo id.");
4295 $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
4296 $photo_id = $_REQUEST['photo_id'];
4298 // prepare json/xml output with data from database for the requested photo
4299 $data = prepare_photo_data($type, $scale, $photo_id);
4301 return api_format_data("photo_detail", $type, $data);
4306 * Updates the user’s profile image.
4308 * @brief updates the profile image for the user (either a specified profile or the default profile)
4310 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4312 * @return string|array
4313 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4315 function api_account_update_profile_image($type)
4317 if (api_user() === false) {
4318 throw new ForbiddenException();
4321 $profile_id = defaults($_REQUEST, 'profile_id', 0);
4323 // error if image data is missing
4324 if (empty($_FILES['image'])) {
4325 throw new BadRequestException("no media data submitted");
4328 // check if specified profile id is valid
4329 if ($profile_id != 0) {
4330 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4331 // error message if specified profile id is not in database
4332 if (!DBA::isResult($profile)) {
4333 throw new BadRequestException("profile_id not available");
4335 $is_default_profile = $profile['is-default'];
4337 $is_default_profile = 1;
4340 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4342 if (!empty($_FILES['image'])) {
4343 $media = $_FILES['image'];
4344 } elseif (!empty($_FILES['media'])) {
4345 $media = $_FILES['media'];
4347 // save new profile image
4348 $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4351 if (is_array($media['type'])) {
4352 $filetype = $media['type'][0];
4354 $filetype = $media['type'];
4356 if ($filetype == "image/jpeg") {
4358 } elseif ($filetype == "image/png") {
4361 throw new InternalServerErrorException('Unsupported filetype');
4364 // change specified profile or all profiles to the new resource-id
4365 if ($is_default_profile) {
4366 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4367 Photo::update(['profile' => false], $condition);
4369 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype,
4370 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype];
4371 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4374 Contact::updateSelfFromUserID(api_user(), true);
4376 // Update global directory in background
4377 $url = System::baseUrl() . '/profile/' . \get_app()->user['nickname'];
4378 if ($url && strlen(Config::get('system', 'directory'))) {
4379 Worker::add(PRIORITY_LOW, "Directory", $url);
4382 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4384 // output for client
4386 return api_account_verify_credentials($type);
4388 // SaveMediaToDatabase failed for some reason
4389 throw new InternalServerErrorException("image upload failed");
4393 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4394 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4395 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4396 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4397 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4398 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4399 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4400 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4401 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4404 * Update user profile
4406 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4408 * @return array|string
4410 function api_account_update_profile($type)
4412 $local_user = api_user();
4413 $api_user = api_get_user(get_app());
4415 if (!empty($_POST['name'])) {
4416 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4417 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4418 DBA::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4419 DBA::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4422 if (isset($_POST['description'])) {
4423 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4424 DBA::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4425 DBA::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4428 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4429 // Update global directory in background
4430 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4431 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4434 return api_account_verify_credentials($type);
4437 /// @TODO move to top of file or somewhere better
4438 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4442 * @param string $acl_string
4444 function check_acl_input($acl_string)
4446 if ($acl_string == null || $acl_string == " ") {
4449 $contact_not_found = false;
4451 // split <x><y><z> into array of cid's
4452 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4454 // check for each cid if it is available on server
4455 $cid_array = $array[0];
4456 foreach ($cid_array as $cid) {
4457 $cid = str_replace("<", "", $cid);
4458 $cid = str_replace(">", "", $cid);
4459 $condition = ['id' => $cid, 'uid' => api_user()];
4460 $contact_not_found |= !DBA::exists('contact', $condition);
4462 return $contact_not_found;
4467 * @param string $mediatype
4468 * @param array $media
4469 * @param string $type
4470 * @param string $album
4471 * @param string $allow_cid
4472 * @param string $deny_cid
4473 * @param string $allow_gid
4474 * @param string $deny_gid
4475 * @param string $desc
4476 * @param integer $profile
4477 * @param boolean $visibility
4478 * @param string $photo_id
4480 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)
4488 if (is_array($media)) {
4489 if (is_array($media['tmp_name'])) {
4490 $src = $media['tmp_name'][0];
4492 $src = $media['tmp_name'];
4494 if (is_array($media['name'])) {
4495 $filename = basename($media['name'][0]);
4497 $filename = basename($media['name']);
4499 if (is_array($media['size'])) {
4500 $filesize = intval($media['size'][0]);
4502 $filesize = intval($media['size']);
4504 if (is_array($media['type'])) {
4505 $filetype = $media['type'][0];
4507 $filetype = $media['type'];
4511 if ($filetype == "") {
4512 $filetype=Image::guessType($filename);
4514 $imagedata = @getimagesize($src);
4516 $filetype = $imagedata['mime'];
4519 "File upload src: " . $src . " - filename: " . $filename .
4520 " - size: " . $filesize . " - type: " . $filetype,
4524 // check if there was a php upload error
4525 if ($filesize == 0 && $media['error'] == 1) {
4526 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4528 // check against max upload size within Friendica instance
4529 $maximagesize = Config::get('system', 'maximagesize');
4530 if ($maximagesize && ($filesize > $maximagesize)) {
4531 $formattedBytes = Strings::formatBytes($maximagesize);
4532 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4535 // create Photo instance with the data of the image
4536 $imagedata = @file_get_contents($src);
4537 $Image = new Image($imagedata, $filetype);
4538 if (!$Image->isValid()) {
4539 throw new InternalServerErrorException("unable to process image data");
4542 // check orientation of image
4543 $Image->orient($src);
4546 // check max length of images on server
4547 $max_length = Config::get('system', 'max_image_length');
4549 $max_length = MAX_IMAGE_LENGTH;
4551 if ($max_length > 0) {
4552 $Image->scaleDown($max_length);
4553 Logger::log("File upload: Scaling picture to new size " . $max_length, Logger::DEBUG);
4555 $width = $Image->getWidth();
4556 $height = $Image->getHeight();
4558 // create a new resource-id if not already provided
4559 $hash = ($photo_id == null) ? Photo::newResource() : $photo_id;
4561 if ($mediatype == "photo") {
4562 // upload normal image (scales 0, 1, 2)
4563 Logger::log("photo upload: starting new photo upload", Logger::DEBUG);
4565 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4567 Logger::log("photo upload: image upload with scale 0 (original size) failed");
4569 if ($width > 640 || $height > 640) {
4570 $Image->scaleDown(640);
4571 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4573 Logger::log("photo upload: image upload with scale 1 (640x640) failed");
4577 if ($width > 320 || $height > 320) {
4578 $Image->scaleDown(320);
4579 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4581 Logger::log("photo upload: image upload with scale 2 (320x320) failed");
4584 Logger::log("photo upload: new photo upload ended", Logger::DEBUG);
4585 } elseif ($mediatype == "profileimage") {
4586 // upload profile image (scales 4, 5, 6)
4587 Logger::log("photo upload: starting new profile image upload", Logger::DEBUG);
4589 if ($width > 300 || $height > 300) {
4590 $Image->scaleDown(300);
4591 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4593 Logger::log("photo upload: profile image upload with scale 4 (300x300) failed");
4597 if ($width > 80 || $height > 80) {
4598 $Image->scaleDown(80);
4599 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4601 Logger::log("photo upload: profile image upload with scale 5 (80x80) failed");
4605 if ($width > 48 || $height > 48) {
4606 $Image->scaleDown(48);
4607 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4609 Logger::log("photo upload: profile image upload with scale 6 (48x48) failed");
4612 $Image->__destruct();
4613 Logger::log("photo upload: new profile image upload ended", Logger::DEBUG);
4616 if (isset($r) && $r) {
4617 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4618 if ($photo_id == null && $mediatype == "photo") {
4619 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4621 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4622 return prepare_photo_data($type, false, $hash);
4624 throw new InternalServerErrorException("image upload failed");
4630 * @param string $hash
4631 * @param string $allow_cid
4632 * @param string $deny_cid
4633 * @param string $allow_gid
4634 * @param string $deny_gid
4635 * @param string $filetype
4636 * @param boolean $visibility
4638 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4640 // get data about the api authenticated user
4641 $uri = Item::newURI(intval(api_user()));
4642 $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
4645 $arr['guid'] = System::createUUID();
4646 $arr['uid'] = intval(api_user());
4648 $arr['parent-uri'] = $uri;
4649 $arr['type'] = 'photo';
4651 $arr['resource-id'] = $hash;
4652 $arr['contact-id'] = $owner_record['id'];
4653 $arr['owner-name'] = $owner_record['name'];
4654 $arr['owner-link'] = $owner_record['url'];
4655 $arr['owner-avatar'] = $owner_record['thumb'];
4656 $arr['author-name'] = $owner_record['name'];
4657 $arr['author-link'] = $owner_record['url'];
4658 $arr['author-avatar'] = $owner_record['thumb'];
4660 $arr['allow_cid'] = $allow_cid;
4661 $arr['allow_gid'] = $allow_gid;
4662 $arr['deny_cid'] = $deny_cid;
4663 $arr['deny_gid'] = $deny_gid;
4664 $arr['visible'] = $visibility;
4668 'image/jpeg' => 'jpg',
4669 'image/png' => 'png',
4670 'image/gif' => 'gif'
4673 // adds link to the thumbnail scale photo
4674 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
4675 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4678 // do the magic for storing the item in the database and trigger the federation to other contacts
4684 * @param string $type
4686 * @param string $photo_id
4690 function prepare_photo_data($type, $scale, $photo_id)
4693 $user_info = api_get_user($a);
4695 if ($user_info === false) {
4696 throw new ForbiddenException();
4699 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4700 $data_sql = ($scale === false ? "" : "data, ");
4702 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4703 // clients needs to convert this in their way for further processing
4705 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4706 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4707 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4708 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4710 intval(local_user()),
4711 DBA::escape($photo_id),
4716 'image/jpeg' => 'jpg',
4717 'image/png' => 'png',
4718 'image/gif' => 'gif'
4721 // prepare output data for photo
4722 if (DBA::isResult($r)) {
4723 $data = ['photo' => $r[0]];
4724 $data['photo']['id'] = $data['photo']['resource-id'];
4725 if ($scale !== false) {
4726 $data['photo']['data'] = base64_encode($data['photo']['data']);
4728 unset($data['photo']['datasize']); //needed only with scale param
4730 if ($type == "xml") {
4731 $data['photo']['links'] = [];
4732 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4733 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4735 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4738 $data['photo']['link'] = [];
4739 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4741 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4742 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4746 unset($data['photo']['resource-id']);
4747 unset($data['photo']['minscale']);
4748 unset($data['photo']['maxscale']);
4750 throw new NotFoundException();
4753 // retrieve item element for getting activities (like, dislike etc.) related to photo
4754 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4755 $item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4757 $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4759 // retrieve comments on photo
4760 $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
4761 $item[0]['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4763 $statuses = Item::selectForUser(api_user(), [], $condition);
4765 // prepare output of comments
4766 $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
4768 if ($type == "xml") {
4770 foreach ($commentData as $comment) {
4771 $comments[$k++ . ":comment"] = $comment;
4774 foreach ($commentData as $comment) {
4775 $comments[] = $comment;
4778 $data['photo']['friendica_comments'] = $comments;
4780 // include info if rights on photo and rights on item are mismatching
4781 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4782 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4783 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4784 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4785 $data['photo']['rights_mismatch'] = $rights_mismatch;
4792 * Similar as /mod/redir.php
4793 * redirect to 'url' after dfrn auth
4795 * Why this when there is mod/redir.php already?
4796 * This use api_user() and api_login()
4799 * c_url: url of remote contact to auth to
4800 * url: string, url to redirect after auth
4802 function api_friendica_remoteauth()
4804 $url = defaults($_GET, 'url', '');
4805 $c_url = defaults($_GET, 'c_url', '');
4807 if ($url === '' || $c_url === '') {
4808 throw new BadRequestException("Wrong parameters.");
4811 $c_url = Strings::normaliseLink($c_url);
4815 $contact = DBA::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4817 if (!DBA::isResult($contact) || ($contact['network'] !== Protocol::DFRN)) {
4818 throw new BadRequestException("Unknown contact");
4821 $cid = $contact['id'];
4823 $dfrn_id = defaults($contact, 'issued-id', $contact['dfrn-id']);
4825 if ($contact['duplex'] && $contact['issued-id']) {
4826 $orig_id = $contact['issued-id'];
4827 $dfrn_id = '1:' . $orig_id;
4829 if ($contact['duplex'] && $contact['dfrn-id']) {
4830 $orig_id = $contact['dfrn-id'];
4831 $dfrn_id = '0:' . $orig_id;
4834 $sec = Strings::getRandomHex();
4836 $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
4837 'sec' => $sec, 'expire' => time() + 45];
4838 DBA::insert('profile_check', $fields);
4840 Logger::log($contact['name'] . ' ' . $sec, Logger::DEBUG);
4841 $dest = ($url ? '&destination_url=' . $url : '');
4843 System::externalRedirect(
4844 $contact['poll'] . '?dfrn_id=' . $dfrn_id
4845 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4846 . '&type=profile&sec=' . $sec . $dest
4849 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4852 * @brief Return the item shared, if the item contains only the [share] tag
4854 * @param array $item Sharer item
4855 * @return array|false Shared item or false if not a reshare
4857 function api_share_as_retweet(&$item)
4859 $body = trim($item["body"]);
4861 if (Diaspora::isReshare($body, false) === false) {
4862 if ($item['author-id'] == $item['owner-id']) {
4865 // Reshares from OStatus, ActivityPub and Twitter
4866 $reshared_item = $item;
4867 $reshared_item['owner-id'] = $reshared_item['author-id'];
4868 $reshared_item['owner-link'] = $reshared_item['author-link'];
4869 $reshared_item['owner-name'] = $reshared_item['author-name'];
4870 $reshared_item['owner-avatar'] = $reshared_item['author-avatar'];
4871 return $reshared_item;
4875 /// @TODO "$1" should maybe mean '$1' ?
4876 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
4878 * Skip if there is no shared message in there
4879 * we already checked this in diaspora::isReshare()
4880 * but better one more than one less...
4882 if (($body == $attributes) || empty($attributes)) {
4886 // build the fake reshared item
4887 $reshared_item = $item;
4890 preg_match("/author='(.*?)'/ism", $attributes, $matches);
4891 if (!empty($matches[1])) {
4892 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
4895 preg_match('/author="(.*?)"/ism', $attributes, $matches);
4896 if (!empty($matches[1])) {
4897 $author = $matches[1];
4901 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
4902 if (!empty($matches[1])) {
4903 $profile = $matches[1];
4906 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
4907 if (!empty($matches[1])) {
4908 $profile = $matches[1];
4912 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
4913 if (!empty($matches[1])) {
4914 $avatar = $matches[1];
4917 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
4918 if (!empty($matches[1])) {
4919 $avatar = $matches[1];
4923 preg_match("/link='(.*?)'/ism", $attributes, $matches);
4924 if (!empty($matches[1])) {
4925 $link = $matches[1];
4928 preg_match('/link="(.*?)"/ism', $attributes, $matches);
4929 if (!empty($matches[1])) {
4930 $link = $matches[1];
4934 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
4935 if (!empty($matches[1])) {
4936 $posted = $matches[1];
4939 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
4940 if (!empty($matches[1])) {
4941 $posted = $matches[1];
4944 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
4946 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
4950 $reshared_item["body"] = $shared_body;
4951 $reshared_item["author-id"] = Contact::getIdForURL($profile, 0, true);
4952 $reshared_item["author-name"] = $author;
4953 $reshared_item["author-link"] = $profile;
4954 $reshared_item["author-avatar"] = $avatar;
4955 $reshared_item["plink"] = $link;
4956 $reshared_item["created"] = $posted;
4957 $reshared_item["edited"] = $posted;
4959 return $reshared_item;
4964 * @param string $profile
4966 * @return string|false
4967 * @todo remove trailing junk from profile url
4968 * @todo pump.io check has to check the website
4970 function api_get_nick($profile)
4975 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4976 DBA::escape(Strings::normaliseLink($profile))
4979 if (DBA::isResult($r)) {
4980 $nick = $r[0]["nick"];
4985 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4986 DBA::escape(Strings::normaliseLink($profile))
4989 if (DBA::isResult($r)) {
4990 $nick = $r[0]["nick"];
4995 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
4996 if ($friendica != $profile) {
5002 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
5003 if ($diaspora != $profile) {
5009 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
5010 if ($twitter != $profile) {
5017 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
5018 if ($StatusnetHost != $profile) {
5019 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
5020 if ($StatusnetUser != $profile) {
5021 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
5022 $user = json_decode($UserData);
5024 $nick = $user->screen_name;
5030 // To-Do: look at the page if its really a pumpio site
5031 //if (!$nick == "") {
5032 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
5033 // if ($pumpio != $profile)
5035 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5048 * @param array $item
5052 function api_in_reply_to($item)
5056 $in_reply_to['status_id'] = null;
5057 $in_reply_to['user_id'] = null;
5058 $in_reply_to['status_id_str'] = null;
5059 $in_reply_to['user_id_str'] = null;
5060 $in_reply_to['screen_name'] = null;
5062 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5063 $parent = Item::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
5064 if (DBA::isResult($parent)) {
5065 $in_reply_to['status_id'] = intval($parent['id']);
5067 $in_reply_to['status_id'] = intval($item['parent']);
5070 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5072 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
5073 $parent = Item::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
5075 if (DBA::isResult($parent)) {
5076 if ($parent['author-nick'] == "") {
5077 $parent['author-nick'] = api_get_nick($parent['author-link']);
5080 $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
5081 $in_reply_to['user_id'] = intval($parent['author-id']);
5082 $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
5085 // There seems to be situation, where both fields are identical:
5086 // https://github.com/friendica/friendica/issues/1010
5087 // This is a bugfix for that.
5088 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5089 Logger::log('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], Logger::DEBUG);
5090 $in_reply_to['status_id'] = null;
5091 $in_reply_to['user_id'] = null;
5092 $in_reply_to['status_id_str'] = null;
5093 $in_reply_to['user_id_str'] = null;
5094 $in_reply_to['screen_name'] = null;
5098 return $in_reply_to;
5103 * @param string $text
5107 function api_clean_plain_items($text)
5109 $include_entities = strtolower(defaults($_REQUEST, 'include_entities', "false"));
5111 $text = BBCode::cleanPictureLinks($text);
5112 $URLSearchString = "^\[\]";
5114 $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
5116 if ($include_entities == "true") {
5117 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5120 // Simplify "attachment" element
5121 $text = api_clean_attachments($text);
5127 * @brief Removes most sharing information for API text export
5129 * @param string $body The original body
5131 * @return string Cleaned body
5133 function api_clean_attachments($body)
5135 $data = BBCode::getAttachmentData($body);
5142 if (isset($data["text"])) {
5143 $body = $data["text"];
5145 if (($body == "") && isset($data["title"])) {
5146 $body = $data["title"];
5148 if (isset($data["url"])) {
5149 $body .= "\n".$data["url"];
5151 $body .= $data["after"];
5158 * @param array $contacts
5162 function api_best_nickname(&$contacts)
5166 if (count($contacts) == 0) {
5170 foreach ($contacts as $contact) {
5171 if ($contact["network"] == "") {
5172 $contact["network"] = "dfrn";
5173 $best_contact = [$contact];
5177 if (sizeof($best_contact) == 0) {
5178 foreach ($contacts as $contact) {
5179 if ($contact["network"] == "dfrn") {
5180 $best_contact = [$contact];
5185 if (sizeof($best_contact) == 0) {
5186 foreach ($contacts as $contact) {
5187 if ($contact["network"] == "dspr") {
5188 $best_contact = [$contact];
5193 if (sizeof($best_contact) == 0) {
5194 foreach ($contacts as $contact) {
5195 if ($contact["network"] == "stat") {
5196 $best_contact = [$contact];
5201 if (sizeof($best_contact) == 0) {
5202 foreach ($contacts as $contact) {
5203 if ($contact["network"] == "pump") {
5204 $best_contact = [$contact];
5209 if (sizeof($best_contact) == 0) {
5210 foreach ($contacts as $contact) {
5211 if ($contact["network"] == "twit") {
5212 $best_contact = [$contact];
5217 if (sizeof($best_contact) == 1) {
5218 $contacts = $best_contact;
5220 $contacts = [$contacts[0]];
5225 * Return all or a specified group of the user with the containing contacts.
5227 * @param string $type Return type (atom, rss, xml, json)
5229 * @return array|string
5231 function api_friendica_group_show($type)
5235 if (api_user() === false) {
5236 throw new ForbiddenException();
5240 $user_info = api_get_user($a);
5241 $gid = defaults($_REQUEST, 'gid', 0);
5242 $uid = $user_info['uid'];
5244 // get data of the specified group id or all groups if not specified
5247 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5251 // error message if specified gid is not in database
5252 if (!DBA::isResult($r)) {
5253 throw new BadRequestException("gid not available");
5257 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5262 // loop through all groups and retrieve all members for adding data in the user array
5264 foreach ($r as $rr) {
5265 $members = Contact::getByGroupId($rr['id']);
5268 if ($type == "xml") {
5269 $user_element = "users";
5271 foreach ($members as $member) {
5272 $user = api_get_user($a, $member['nurl']);
5273 $users[$k++.":user"] = $user;
5276 $user_element = "user";
5277 foreach ($members as $member) {
5278 $user = api_get_user($a, $member['nurl']);
5282 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5284 return api_format_data("groups", $type, ['group' => $grps]);
5286 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5290 * Delete the specified group of the user.
5292 * @param string $type Return type (atom, rss, xml, json)
5294 * @return array|string
5296 function api_friendica_group_delete($type)
5300 if (api_user() === false) {
5301 throw new ForbiddenException();
5305 $user_info = api_get_user($a);
5306 $gid = defaults($_REQUEST, 'gid', 0);
5307 $name = defaults($_REQUEST, 'name', "");
5308 $uid = $user_info['uid'];
5310 // error if no gid specified
5311 if ($gid == 0 || $name == "") {
5312 throw new BadRequestException('gid or name not specified');
5315 // get data of the specified group id
5317 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5321 // error message if specified gid is not in database
5322 if (!DBA::isResult($r)) {
5323 throw new BadRequestException('gid not available');
5326 // get data of the specified group id and group name
5328 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5333 // error message if specified gid is not in database
5334 if (!DBA::isResult($rname)) {
5335 throw new BadRequestException('wrong group name');
5339 $ret = Group::removeByName($uid, $name);
5342 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5343 return api_format_data("group_delete", $type, ['result' => $success]);
5345 throw new BadRequestException('other API error');
5348 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5353 * @param string $type Return type (atom, rss, xml, json)
5355 * @return array|string
5356 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5358 function api_lists_destroy($type)
5362 if (api_user() === false) {
5363 throw new ForbiddenException();
5367 $user_info = api_get_user($a);
5368 $gid = defaults($_REQUEST, 'list_id', 0);
5369 $uid = $user_info['uid'];
5371 // error if no gid specified
5373 throw new BadRequestException('gid not specified');
5376 // get data of the specified group id
5377 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5378 // error message if specified gid is not in database
5380 throw new BadRequestException('gid not available');
5383 if (Group::remove($gid)) {
5385 'name' => $group['name'],
5386 'id' => intval($gid),
5387 'id_str' => (string) $gid,
5388 'user' => $user_info
5391 return api_format_data("lists", $type, ['lists' => $list]);
5394 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5397 * Add a new group to the database.
5399 * @param string $name Group name
5400 * @param int $uid User ID
5401 * @param array $users List of users to add to the group
5405 function group_create($name, $uid, $users = [])
5407 // error if no name specified
5409 throw new BadRequestException('group name not specified');
5412 // get data of the specified group name
5414 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5418 // error message if specified group name already exists
5419 if (DBA::isResult($rname)) {
5420 throw new BadRequestException('group name already exists');
5423 // check if specified group name is a deleted group
5425 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5429 // error message if specified group name already exists
5430 if (DBA::isResult($rname)) {
5431 $reactivate_group = true;
5435 $ret = Group::create($uid, $name);
5437 $gid = Group::getIdByName($uid, $name);
5439 throw new BadRequestException('other API error');
5443 $erroraddinguser = false;
5445 foreach ($users as $user) {
5446 $cid = $user['cid'];
5447 // check if user really exists as contact
5449 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5453 if (count($contact)) {
5454 Group::addMember($gid, $cid);
5456 $erroraddinguser = true;
5457 $errorusers[] = $cid;
5461 // return success message incl. missing users in array
5462 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5464 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5468 * Create the specified group with the posted array of contacts.
5470 * @param string $type Return type (atom, rss, xml, json)
5472 * @return array|string
5474 function api_friendica_group_create($type)
5478 if (api_user() === false) {
5479 throw new ForbiddenException();
5483 $user_info = api_get_user($a);
5484 $name = defaults($_REQUEST, 'name', "");
5485 $uid = $user_info['uid'];
5486 $json = json_decode($_POST['json'], true);
5487 $users = $json['user'];
5489 $success = group_create($name, $uid, $users);
5491 return api_format_data("group_create", $type, ['result' => $success]);
5493 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5496 * Create a new group.
5498 * @param string $type Return type (atom, rss, xml, json)
5500 * @return array|string
5501 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5503 function api_lists_create($type)
5507 if (api_user() === false) {
5508 throw new ForbiddenException();
5512 $user_info = api_get_user($a);
5513 $name = defaults($_REQUEST, 'name', "");
5514 $uid = $user_info['uid'];
5516 $success = group_create($name, $uid);
5517 if ($success['success']) {
5519 'name' => $success['name'],
5520 'id' => intval($success['gid']),
5521 'id_str' => (string) $success['gid'],
5522 'user' => $user_info
5525 return api_format_data("lists", $type, ['lists'=>$grp]);
5528 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5531 * Update the specified group with the posted array of contacts.
5533 * @param string $type Return type (atom, rss, xml, json)
5535 * @return array|string
5537 function api_friendica_group_update($type)
5541 if (api_user() === false) {
5542 throw new ForbiddenException();
5546 $user_info = api_get_user($a);
5547 $uid = $user_info['uid'];
5548 $gid = defaults($_REQUEST, 'gid', 0);
5549 $name = defaults($_REQUEST, 'name', "");
5550 $json = json_decode($_POST['json'], true);
5551 $users = $json['user'];
5553 // error if no name specified
5555 throw new BadRequestException('group name not specified');
5558 // error if no gid specified
5560 throw new BadRequestException('gid not specified');
5564 $members = Contact::getByGroupId($gid);
5565 foreach ($members as $member) {
5566 $cid = $member['id'];
5567 foreach ($users as $user) {
5568 $found = ($user['cid'] == $cid ? true : false);
5570 if (!isset($found) || !$found) {
5571 Group::removeMemberByName($uid, $name, $cid);
5576 $erroraddinguser = false;
5578 foreach ($users as $user) {
5579 $cid = $user['cid'];
5580 // check if user really exists as contact
5582 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5587 if (count($contact)) {
5588 Group::addMember($gid, $cid);
5590 $erroraddinguser = true;
5591 $errorusers[] = $cid;
5595 // return success message incl. missing users in array
5596 $status = ($erroraddinguser ? "missing user" : "ok");
5597 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5598 return api_format_data("group_update", $type, ['result' => $success]);
5601 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5604 * Update information about a group.
5606 * @param string $type Return type (atom, rss, xml, json)
5608 * @return array|string
5609 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5611 function api_lists_update($type)
5615 if (api_user() === false) {
5616 throw new ForbiddenException();
5620 $user_info = api_get_user($a);
5621 $gid = defaults($_REQUEST, 'list_id', 0);
5622 $name = defaults($_REQUEST, 'name', "");
5623 $uid = $user_info['uid'];
5625 // error if no gid specified
5627 throw new BadRequestException('gid not specified');
5630 // get data of the specified group id
5631 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5632 // error message if specified gid is not in database
5634 throw new BadRequestException('gid not available');
5637 if (Group::update($gid, $name)) {
5640 'id' => intval($gid),
5641 'id_str' => (string) $gid,
5642 'user' => $user_info
5645 return api_format_data("lists", $type, ['lists' => $list]);
5649 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5653 * @param string $type Return type (atom, rss, xml, json)
5655 * @return array|string
5657 function api_friendica_activity($type)
5661 if (api_user() === false) {
5662 throw new ForbiddenException();
5664 $verb = strtolower($a->argv[3]);
5665 $verb = preg_replace("|\..*$|", "", $verb);
5667 $id = defaults($_REQUEST, 'id', 0);
5669 $res = Item::performLike($id, $verb);
5672 if ($type == "xml") {
5677 return api_format_data('ok', $type, ['ok' => $ok]);
5679 throw new BadRequestException('Error adding activity');
5683 /// @TODO move to top of file or somewhere better
5684 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5685 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5686 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5687 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5688 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5689 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5690 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5691 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5692 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5693 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5696 * @brief Returns notifications
5698 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5699 * @return string|array
5701 function api_friendica_notification($type)
5705 if (api_user() === false) {
5706 throw new ForbiddenException();
5709 throw new BadRequestException("Invalid argument count");
5711 $nm = new NotificationsManager();
5713 $notes = $nm->getAll([], "+seen -date", 50);
5715 if ($type == "xml") {
5717 if (!empty($notes)) {
5718 foreach ($notes as $note) {
5719 $xmlnotes[] = ["@attributes" => $note];
5725 return api_format_data("notes", $type, ['note' => $notes]);
5729 * POST request with 'id' param as notification id
5731 * @brief Set notification as seen and returns associated item (if possible)
5733 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5734 * @return string|array
5736 function api_friendica_notification_seen($type)
5739 $user_info = api_get_user($a);
5741 if (api_user() === false || $user_info === false) {
5742 throw new ForbiddenException();
5745 throw new BadRequestException("Invalid argument count");
5748 $id = (!empty($_REQUEST['id']) ? intval($_REQUEST['id']) : 0);
5750 $nm = new NotificationsManager();
5751 $note = $nm->getByID($id);
5752 if (is_null($note)) {
5753 throw new BadRequestException("Invalid argument");
5756 $nm->setSeen($note);
5757 if ($note['otype']=='item') {
5758 // would be really better with an ItemsManager and $im->getByID() :-P
5759 $item = Item::selectFirstForUser(api_user(), [], ['id' => $note['iid'], 'uid' => api_user()]);
5760 if (DBA::isResult($item)) {
5761 // we found the item, return it to the user
5762 $ret = api_format_items([$item], $user_info, false, $type);
5763 $data = ['status' => $ret];
5764 return api_format_data("status", $type, $data);
5766 // the item can't be found, but we set the note as seen, so we count this as a success
5768 return api_format_data('result', $type, ['result' => "success"]);
5771 /// @TODO move to top of file or somewhere better
5772 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5773 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5776 * @brief update a direct_message to seen state
5778 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5779 * @return string|array (success result=ok, error result=error with error message)
5781 function api_friendica_direct_messages_setseen($type)
5784 if (api_user() === false) {
5785 throw new ForbiddenException();
5789 $user_info = api_get_user($a);
5790 $uid = $user_info['uid'];
5791 $id = defaults($_REQUEST, 'id', 0);
5793 // return error if id is zero
5795 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5796 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5799 // error message if specified id is not in database
5800 if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
5801 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5802 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5805 // update seen indicator
5806 $result = DBA::update('mail', ['seen' => true], ['id' => $id]);
5810 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
5811 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
5813 $answer = ['result' => 'error', 'message' => 'unknown error'];
5814 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5818 /// @TODO move to top of file or somewhere better
5819 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5822 * @brief search for direct_messages containing a searchstring through api
5824 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5825 * @param string $box
5826 * @return string|array (success: success=true if found and search_result contains found messages,
5827 * success=false if nothing was found, search_result='nothing found',
5828 * error: result=error with error message)
5830 function api_friendica_direct_messages_search($type, $box = "")
5834 if (api_user() === false) {
5835 throw new ForbiddenException();
5839 $user_info = api_get_user($a);
5840 $searchstring = defaults($_REQUEST, 'searchstring', "");
5841 $uid = $user_info['uid'];
5843 // error if no searchstring specified
5844 if ($searchstring == "") {
5845 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
5846 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
5849 // get data for the specified searchstring
5851 "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",
5853 DBA::escape('%'.$searchstring.'%')
5856 $profile_url = $user_info["url"];
5858 // message if nothing was found
5859 if (!DBA::isResult($r)) {
5860 $success = ['success' => false, 'search_results' => 'problem with query'];
5861 } elseif (count($r) == 0) {
5862 $success = ['success' => false, 'search_results' => 'nothing found'];
5865 foreach ($r as $item) {
5866 if ($box == "inbox" || $item['from-url'] != $profile_url) {
5867 $recipient = $user_info;
5868 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5869 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5870 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5871 $sender = $user_info;
5874 if (isset($recipient) && isset($sender)) {
5875 $ret[] = api_format_messages($item, $recipient, $sender);
5878 $success = ['success' => true, 'search_results' => $ret];
5881 return api_format_data("direct_message_search", $type, ['$result' => $success]);
5884 /// @TODO move to top of file or somewhere better
5885 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5888 * @brief return data of all the profiles a user has to the client
5890 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5891 * @return string|array
5893 function api_friendica_profile_show($type)
5897 if (api_user() === false) {
5898 throw new ForbiddenException();
5902 $profile_id = defaults($_REQUEST, 'profile_id', 0);
5904 // retrieve general information about profiles for user
5905 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
5906 $directory = Config::get('system', 'directory');
5908 // get data of the specified profile id or all profiles of the user if not specified
5909 if ($profile_id != 0) {
5911 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
5916 // error message if specified gid is not in database
5917 if (!DBA::isResult($r)) {
5918 throw new BadRequestException("profile_id not available");
5922 "SELECT * FROM `profile` WHERE `uid` = %d",
5926 // loop through all returned profiles and retrieve data and users
5929 foreach ($r as $rr) {
5930 $profile = api_format_items_profiles($rr);
5932 // select all users from contact table, loop and prepare standard return for user data
5935 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
5940 foreach ($nurls as $nurl) {
5941 $user = api_get_user($a, $nurl['nurl']);
5942 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
5944 $profile['users'] = $users;
5946 // add prepared profile data to array for final return
5947 if ($type == "xml") {
5948 $profiles[$k++ . ":profile"] = $profile;
5950 $profiles[] = $profile;
5954 // return settings, authenticated user and profiles data
5955 $self = DBA::selectFirst('contact', ['nurl'], ['uid' => api_user(), 'self' => true]);
5957 $result = ['multi_profiles' => $multi_profiles ? true : false,
5958 'global_dir' => $directory,
5959 'friendica_owner' => api_get_user($a, $self['nurl']),
5960 'profiles' => $profiles];
5961 return api_format_data("friendica_profiles", $type, ['$result' => $result]);
5963 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
5966 * Returns a list of saved searches.
5968 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5970 * @param string $type Return format: json or xml
5972 * @return string|array
5974 function api_saved_searches_list($type)
5976 $terms = DBA::select('search', ['id', 'term'], ['uid' => local_user()]);
5979 while ($term = $terms->fetch()) {
5981 'created_at' => api_date(time()),
5982 'id' => intval($term['id']),
5983 'id_str' => $term['id'],
5984 'name' => $term['term'],
5986 'query' => $term['term']
5992 return api_format_data("terms", $type, ['terms' => $result]);
5995 /// @TODO move to top of file or somewhere better
5996 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5999 * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
6001 * @brief Number of comments
6003 * @param object $data [Status, Status]
6007 function bindComments(&$data)
6009 if (count($data) == 0) {
6015 foreach ($data as $item) {
6016 $ids[] = $item['id'];
6019 $idStr = DBA::escape(implode(', ', $ids));
6020 $sql = "SELECT `parent`, COUNT(*) as comments FROM `item` WHERE `parent` IN ($idStr) AND `deleted` = ? AND `gravity`= ? GROUP BY `parent`";
6021 $items = DBA::p($sql, 0, GRAVITY_COMMENT);
6022 $itemsData = DBA::toArray($items);
6024 foreach ($itemsData as $item) {
6025 $comments[$item['parent']] = $item['comments'];
6028 foreach ($data as $idx => $item) {
6030 $data[$idx]['friendica_comments'] = isset($comments[$id]) ? $comments[$id] : 0;
6035 @TODO Maybe open to implement?
6037 [pagename] => api/1.1/statuses/lookup.json
6038 [id] => 605138389168451584
6039 [include_cards] => true
6040 [cards_platform] => Android-12
6041 [include_entities] => true
6042 [include_my_retweet] => 1
6044 [include_reply_count] => true
6045 [include_descendent_reply_count] => true
6049 Not implemented by now:
6050 statuses/retweets_of_me
6055 account/update_location
6056 account/update_profile_background_image
6059 friendica/profile/update
6060 friendica/profile/create
6061 friendica/profile/delete
6063 Not implemented in status.net:
6064 statuses/retweeted_to_me
6065 statuses/retweeted_by_me
6066 direct_messages/destroy
6068 account/update_delivery_device
6069 notifications/follow