3 * Friendica implementation of statusnet/twitter API
5 * @file include/api.php
6 * @todo Automatically detect if incoming data is HTML or BBCode
10 use Friendica\Content\ContactSelector;
11 use Friendica\Content\Feature;
12 use Friendica\Content\Text\BBCode;
13 use Friendica\Content\Text\HTML;
14 use Friendica\Core\Addon;
15 use Friendica\Core\Config;
16 use Friendica\Core\L10n;
17 use Friendica\Core\NotificationsManager;
18 use Friendica\Core\PConfig;
19 use Friendica\Core\Protocol;
20 use Friendica\Core\System;
21 use Friendica\Core\Worker;
22 use Friendica\Database\DBM;
23 use Friendica\Model\Contact;
24 use Friendica\Model\Group;
25 use Friendica\Model\Item;
26 use Friendica\Model\Mail;
27 use Friendica\Model\Photo;
28 use Friendica\Model\User;
29 use Friendica\Network\FKOAuth1;
30 use Friendica\Network\HTTPException;
31 use Friendica\Network\HTTPException\BadRequestException;
32 use Friendica\Network\HTTPException\ForbiddenException;
33 use Friendica\Network\HTTPException\InternalServerErrorException;
34 use Friendica\Network\HTTPException\MethodNotAllowedException;
35 use Friendica\Network\HTTPException\NotFoundException;
36 use Friendica\Network\HTTPException\NotImplementedException;
37 use Friendica\Network\HTTPException\TooManyRequestsException;
38 use Friendica\Network\HTTPException\UnauthorizedException;
39 use Friendica\Object\Image;
40 use Friendica\Protocol\Diaspora;
41 use Friendica\Util\DateTimeFormat;
42 use Friendica\Util\Network;
43 use Friendica\Util\XML;
45 require_once 'include/conversation.php';
46 require_once 'mod/share.php';
47 require_once 'mod/item.php';
48 require_once 'include/security.php';
49 require_once 'mod/wall_upload.php';
50 require_once 'mod/proxy.php';
52 define('API_METHOD_ANY', '*');
53 define('API_METHOD_GET', 'GET');
54 define('API_METHOD_POST', 'POST,PUT');
55 define('API_METHOD_DELETE', 'POST,DELETE');
61 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
62 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
63 * into a page, and visitors will post something without noticing it).
65 * @brief Auth API user
69 if (x($_SESSION, 'allow_api')) {
77 * Clients can send 'source' parameter to be show in post metadata
78 * as "sent via <source>".
79 * Some clients doesn't send a source param, we support ones we know
82 * @brief Get source name from API client
85 * Client source name, default to "api" if unset/unknown
89 if (requestdata('source')) {
90 return requestdata('source');
93 // Support for known clients that doesn't send a source name
94 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
95 if(strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
99 logger("Unrecognized user-agent ".$_SERVER['HTTP_USER_AGENT'], LOGGER_DEBUG);
101 logger("Empty user-agent", LOGGER_DEBUG);
108 * @brief Format date for API
110 * @param string $str Source date, as UTC
111 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
113 function api_date($str)
115 // Wed May 23 06:01:13 +0000 2007
116 return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
120 * Register a function to be the endpoint for defined API path.
122 * @brief Register API endpoint
124 * @param string $path API URL path, relative to System::baseUrl()
125 * @param string $func Function name to call on path request
126 * @param bool $auth API need logged user
127 * @param string $method HTTP method reqiured to call this endpoint.
128 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
129 * Default to API_METHOD_ANY
131 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
141 // Workaround for hotot
142 $path = str_replace("api/", "api/1.1/", $path);
152 * Log in user via OAuth1 or Simple HTTP Auth.
153 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
155 * @brief Login API user
157 * @param object $a App
158 * @hook 'authenticate'
160 * 'username' => username from login form
161 * 'password' => password from login form
162 * 'authenticated' => return status,
163 * 'user_record' => return authenticated user record
165 * array $user logged user record
167 function api_login(App $a)
169 $oauth1 = new FKOAuth1();
172 list($consumer, $token) = $oauth1->verify_request(OAuthRequest::from_request());
173 if (!is_null($token)) {
174 $oauth1->loginUser($token->uid);
175 Addon::callHooks('logged_in', $a->user);
178 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
179 var_dump($consumer, $token);
181 } catch (Exception $e) {
185 // workaround for HTTP-auth in CGI mode
186 if (x($_SERVER, 'REDIRECT_REMOTE_USER')) {
187 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6)) ;
188 if (strlen($userpass)) {
189 list($name, $password) = explode(':', $userpass);
190 $_SERVER['PHP_AUTH_USER'] = $name;
191 $_SERVER['PHP_AUTH_PW'] = $password;
195 if (!x($_SERVER, 'PHP_AUTH_USER')) {
196 logger('API_login: ' . print_r($_SERVER, true), LOGGER_DEBUG);
197 header('WWW-Authenticate: Basic realm="Friendica"');
198 throw new UnauthorizedException("This API requires login");
201 $user = defaults($_SERVER, 'PHP_AUTH_USER', '');
202 $password = defaults($_SERVER, 'PHP_AUTH_PW', '');
204 // allow "user@server" login (but ignore 'server' part)
205 $at = strstr($user, "@", true);
210 // next code from mod/auth.php. needs better solution
214 'username' => trim($user),
215 'password' => trim($password),
216 'authenticated' => 0,
217 'user_record' => null,
221 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
222 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
223 * and later addons should not interfere with an earlier one that succeeded.
225 Addon::callHooks('authenticate', $addon_auth);
227 if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
228 $record = $addon_auth['user_record'];
230 $user_id = User::authenticate(trim($user), trim($password));
231 if ($user_id !== false) {
232 $record = dba::selectFirst('user', [], ['uid' => $user_id]);
236 if (!DBM::is_result($record)) {
237 logger('API_login failure: ' . print_r($_SERVER, true), LOGGER_DEBUG);
238 header('WWW-Authenticate: Basic realm="Friendica"');
239 //header('HTTP/1.0 401 Unauthorized');
240 //die('This api requires login');
241 throw new UnauthorizedException("This API requires login");
244 authenticate_success($record);
246 $_SESSION["allow_api"] = true;
248 Addon::callHooks('logged_in', $a->user);
252 * API endpoints can define which HTTP method to accept when called.
253 * This function check the current HTTP method agains endpoint
256 * @brief Check HTTP method of called API
258 * @param string $method Required methods, uppercase, separated by comma
261 function api_check_method($method)
263 if ($method == "*") {
266 return (stripos($method, defaults($_SERVER, 'REQUEST_METHOD', 'GET')) !== false);
270 * Authenticate user, call registered API function, set HTTP headers
272 * @brief Main API entry point
274 * @param object $a App
275 * @return string|array API call result
277 function api_call(App $a)
279 global $API, $called_api;
282 if (strpos($a->query_string, ".xml") > 0) {
285 if (strpos($a->query_string, ".json") > 0) {
288 if (strpos($a->query_string, ".rss") > 0) {
291 if (strpos($a->query_string, ".atom") > 0) {
296 foreach ($API as $p => $info) {
297 if (strpos($a->query_string, $p) === 0) {
298 if (!api_check_method($info['method'])) {
299 throw new MethodNotAllowedException();
302 $called_api = explode("/", $p);
303 //unset($_SERVER['PHP_AUTH_USER']);
305 /// @TODO should be "true ==[=] $info['auth']", if you miss only one = character, you assign a variable (only with ==). Let's make all this even.
306 if (!empty($info['auth']) && api_user() === false) {
310 logger('API call for ' . $a->user['username'] . ': ' . $a->query_string);
311 logger('API parameters: ' . print_r($_REQUEST, true));
313 $stamp = microtime(true);
314 $return = call_user_func($info['func'], $type);
315 $duration = (float) (microtime(true) - $stamp);
316 logger("API call duration: " . round($duration, 2) . "\t" . $a->query_string, LOGGER_DEBUG);
318 if (Config::get("system", "profiler")) {
319 $duration = microtime(true)-$a->performance["start"];
321 /// @TODO round() really everywhere?
323 parse_url($a->query_string, PHP_URL_PATH) . ": " . sprintf(
324 "Database: %s/%s, Cache %s/%s, Network: %s, I/O: %s, Other: %s, Total: %s",
325 round($a->performance["database"] - $a->performance["database_write"], 3),
326 round($a->performance["database_write"], 3),
327 round($a->performance["cache"], 3),
328 round($a->performance["cache_write"], 3),
329 round($a->performance["network"], 2),
330 round($a->performance["file"], 2),
331 round($duration - ($a->performance["database"]
332 + $a->performance["cache"] + $a->performance["cache_write"]
333 + $a->performance["network"] + $a->performance["file"]), 2),
339 if (Config::get("rendertime", "callstack")) {
340 $o = "Database Read:\n";
341 foreach ($a->callstack["database"] as $func => $time) {
342 $time = round($time, 3);
344 $o .= $func . ": " . $time . "\n";
347 $o .= "\nDatabase Write:\n";
348 foreach ($a->callstack["database_write"] as $func => $time) {
349 $time = round($time, 3);
351 $o .= $func . ": " . $time . "\n";
355 $o = "Cache Read:\n";
356 foreach ($a->callstack["cache"] as $func => $time) {
357 $time = round($time, 3);
359 $o .= $func . ": " . $time . "\n";
362 $o .= "\nCache Write:\n";
363 foreach ($a->callstack["cache_write"] as $func => $time) {
364 $time = round($time, 3);
366 $o .= $func . ": " . $time . "\n";
370 $o .= "\nNetwork:\n";
371 foreach ($a->callstack["network"] as $func => $time) {
372 $time = round($time, 3);
374 $o .= $func . ": " . $time . "\n";
377 logger($o, LOGGER_DEBUG);
381 if (false === $return) {
383 * api function returned false withour throw an
384 * exception. This should not happend, throw a 500
386 throw new InternalServerErrorException();
391 header("Content-Type: text/xml");
394 header("Content-Type: application/json");
395 $json = json_encode(end($return));
396 if (x($_GET, 'callback')) {
397 $json = $_GET['callback'] . "(" . $json . ")";
402 header("Content-Type: application/rss+xml");
403 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
406 header("Content-Type: application/atom+xml");
407 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
414 logger('API call not implemented: ' . $a->query_string);
415 throw new NotImplementedException();
416 } catch (HTTPException $e) {
417 header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}");
418 return api_error($type, $e);
423 * @brief Format API error string
425 * @param string $type Return type (xml, json, rss, as)
426 * @param object $e HTTPException Error object
427 * @return string|array error message formatted as $type
429 function api_error($type, $e)
433 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
434 /// @TODO: https://dev.twitter.com/overview/api/response-codes
436 $error = ["error" => $error,
437 "code" => $e->httpcode . " " . $e->httpdesc,
438 "request" => $a->query_string];
440 $return = api_format_data('status', $type, ['status' => $error]);
444 header("Content-Type: text/xml");
447 header("Content-Type: application/json");
448 $return = json_encode($return);
451 header("Content-Type: application/rss+xml");
454 header("Content-Type: application/atom+xml");
462 * @brief Set values for RSS template
465 * @param array $arr Array to be passed to template
466 * @param array $user_info User info
468 * @todo find proper type-hints
470 function api_rss_extra(App $a, $arr, $user_info)
472 if (is_null($user_info)) {
473 $user_info = api_get_user($a);
476 $arr['$user'] = $user_info;
478 'alternate' => $user_info['url'],
479 'self' => System::baseUrl() . "/" . $a->query_string,
480 'base' => System::baseUrl(),
481 'updated' => api_date(null),
482 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
483 'language' => $user_info['lang'],
484 'logo' => System::baseUrl() . "/images/friendica-32.png",
492 * @brief Unique contact to contact url.
494 * @param int $id Contact id
495 * @return bool|string
496 * Contact url or False if contact id is unknown
498 function api_unique_id_to_nurl($id)
500 $r = dba::selectFirst('contact', ['nurl'], ['id' => $id]);
502 if (DBM::is_result($r)) {
510 * @brief Get user info array.
512 * @param object $a App
513 * @param int|string $contact_id Contact ID or URL
515 function api_get_user(App $a, $contact_id = null)
523 logger("api_get_user: Fetching user data for user ".$contact_id, LOGGER_DEBUG);
525 // Searching for contact URL
526 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
527 $user = dbesc(normalise_link($contact_id));
529 $extra_query = "AND `contact`.`nurl` = '%s' ";
530 if (api_user() !== false) {
531 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
535 // Searching for contact id with uid = 0
536 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
537 $user = dbesc(api_unique_id_to_nurl(intval($contact_id)));
540 throw new BadRequestException("User ID ".$contact_id." not found.");
544 $extra_query = "AND `contact`.`nurl` = '%s' ";
545 if (api_user() !== false) {
546 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
550 if (is_null($user) && x($_GET, 'user_id')) {
551 $user = dbesc(api_unique_id_to_nurl($_GET['user_id']));
554 throw new BadRequestException("User ID ".$_GET['user_id']." not found.");
558 $extra_query = "AND `contact`.`nurl` = '%s' ";
559 if (api_user() !== false) {
560 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
563 if (is_null($user) && x($_GET, 'screen_name')) {
564 $user = dbesc($_GET['screen_name']);
565 $extra_query = "AND `contact`.`nick` = '%s' ";
566 if (api_user() !== false) {
567 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
571 if (is_null($user) && x($_GET, 'profileurl')) {
572 $user = dbesc(normalise_link($_GET['profileurl']));
573 $extra_query = "AND `contact`.`nurl` = '%s' ";
574 if (api_user() !== false) {
575 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
579 // $called_api is the API path exploded on / and is expected to have at least 2 elements
580 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
581 $argid = count($called_api);
582 if (!empty($a->argv[$argid])) {
583 list($user, $null) = explode(".", $a->argv[$argid]);
585 if (is_numeric($user)) {
586 $user = dbesc(api_unique_id_to_nurl(intval($user)));
590 $extra_query = "AND `contact`.`nurl` = '%s' ";
591 if (api_user() !== false) {
592 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
596 $user = dbesc($user);
597 $extra_query = "AND `contact`.`nick` = '%s' ";
598 if (api_user() !== false) {
599 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
604 logger("api_get_user: user ".$user, LOGGER_DEBUG);
607 if (api_user() === false) {
611 $user = $_SESSION['uid'];
612 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
616 logger('api_user: ' . $extra_query . ', user: ' . $user);
620 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
626 // Selecting the id by priority, friendica first
627 if (is_array($uinfo)) {
628 api_best_nickname($uinfo);
631 // if the contact wasn't found, fetch it from the contacts with uid = 0
632 if (!DBM::is_result($uinfo)) {
636 $r = q("SELECT * FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s' LIMIT 1", dbesc(normalise_link($url)));
639 if (DBM::is_result($r)) {
640 $network_name = ContactSelector::networkToName($r[0]['network'], $r[0]['url']);
642 // If no nick where given, extract it from the address
643 if (($r[0]['nick'] == "") || ($r[0]['name'] == $r[0]['nick'])) {
644 $r[0]['nick'] = api_get_nick($r[0]["url"]);
649 'id_str' => (string) $r[0]["id"],
650 'name' => $r[0]["name"],
651 'screen_name' => (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']),
652 'location' => ($r[0]["location"] != "") ? $r[0]["location"] : $network_name,
653 'description' => $r[0]["about"],
654 'profile_image_url' => $r[0]["micro"],
655 'profile_image_url_https' => $r[0]["micro"],
656 'profile_image_url_profile_size' => $r[0]["thumb"],
657 'profile_image_url_large' => $r[0]["photo"],
658 'url' => $r[0]["url"],
659 'protected' => false,
660 'followers_count' => 0,
661 'friends_count' => 0,
663 'created_at' => api_date($r[0]["created"]),
664 'favourites_count' => 0,
666 'time_zone' => 'UTC',
667 'geo_enabled' => false,
669 'statuses_count' => 0,
671 'contributors_enabled' => false,
672 'is_translator' => false,
673 'is_translation_enabled' => false,
674 'following' => false,
675 'follow_request_sent' => false,
676 'statusnet_blocking' => false,
677 'notifications' => false,
678 'statusnet_profile_url' => $r[0]["url"],
680 'cid' => Contact::getIdForURL($r[0]["url"], api_user(), true),
681 'pid' => Contact::getIdForURL($r[0]["url"], 0, true),
683 'network' => $r[0]["network"],
688 throw new BadRequestException("User ".$url." not found.");
692 if ($uinfo[0]['self']) {
693 if ($uinfo[0]['network'] == "") {
694 $uinfo[0]['network'] = NETWORK_DFRN;
697 $usr = dba::selectFirst('user', ['default-location'], ['uid' => api_user()]);
698 $profile = dba::selectFirst('profile', ['about'], ['uid' => api_user(), 'is-default' => true]);
705 // Add a nick if it isn't present there
706 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
707 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
710 $network_name = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
712 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
714 if (!empty($profile['about'])) {
715 $description = $profile['about'];
717 $description = $uinfo[0]["about"];
720 if (!empty($usr['default-location'])) {
721 $location = $usr['default-location'];
722 } elseif (!empty($uinfo[0]["location"])) {
723 $location = $uinfo[0]["location"];
725 $location = $network_name;
729 'id' => intval($pcontact_id),
730 'id_str' => (string) intval($pcontact_id),
731 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
732 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
733 'location' => $location,
734 'description' => $description,
735 'profile_image_url' => $uinfo[0]['micro'],
736 'profile_image_url_https' => $uinfo[0]['micro'],
737 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
738 'profile_image_url_large' => $uinfo[0]["photo"],
739 'url' => $uinfo[0]['url'],
740 'protected' => false,
741 'followers_count' => intval($countfollowers),
742 'friends_count' => intval($countfriends),
744 'created_at' => api_date($uinfo[0]['created']),
745 'favourites_count' => intval($starred),
747 'time_zone' => 'UTC',
748 'geo_enabled' => false,
750 'statuses_count' => intval($countitems),
752 'contributors_enabled' => false,
753 'is_translator' => false,
754 'is_translation_enabled' => false,
755 'following' => (($uinfo[0]['rel'] == CONTACT_IS_FOLLOWER) || ($uinfo[0]['rel'] == CONTACT_IS_FRIEND)),
756 'follow_request_sent' => false,
757 'statusnet_blocking' => false,
758 'notifications' => false,
760 //'statusnet_profile_url' => System::baseUrl()."/contacts/".$uinfo[0]['cid'],
761 'statusnet_profile_url' => $uinfo[0]['url'],
762 'uid' => intval($uinfo[0]['uid']),
763 'cid' => intval($uinfo[0]['cid']),
764 'pid' => Contact::getIdForURL($uinfo[0]["url"], 0, true),
765 'self' => $uinfo[0]['self'],
766 'network' => $uinfo[0]['network'],
769 // If this is a local user and it uses Frio, we can get its color preferences.
771 $theme_info = dba::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
772 if ($theme_info['theme'] === 'frio') {
773 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
774 if ($schema && ($schema != '---')) {
775 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
776 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
777 require_once $schemefile;
780 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
781 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
782 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
784 if (empty($nav_bg)) {
787 if (empty($link_color)) {
788 $link_color = "#6fdbe8";
790 if (empty($bgcolor)) {
791 $bgcolor = "#ededed";
794 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
795 $ret['profile_link_color'] = str_replace('#', '', $link_color);
796 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
804 * @brief return api-formatted array for item's author and owner
806 * @param object $a App
807 * @param array $item item from db
808 * @return array(array:author, array:owner)
810 function api_item_get_user(App $a, $item)
812 $status_user = api_get_user($a, defaults($item, 'author-id', null));
814 $status_user["protected"] = defaults($item, 'private', 0);
816 if (defaults($item, 'thr-parent', '') == defaults($item, 'uri', '')) {
817 $owner_user = api_get_user($a, defaults($item, 'author-id', null));
819 $owner_user = $status_user;
822 return ([$status_user, $owner_user]);
826 * @brief walks recursively through an array with the possibility to change value and key
828 * @param array $array The array to walk through
829 * @param string $callback The callback function
831 * @return array the transformed array
833 function api_walk_recursive(array &$array, callable $callback)
837 foreach ($array as $k => $v) {
839 if ($callback($v, $k)) {
840 $new_array[$k] = api_walk_recursive($v, $callback);
843 if ($callback($v, $k)) {
854 * @brief Callback function to transform the array in an array that can be transformed in a XML file
856 * @param mixed $item Array item value
857 * @param string $key Array key
859 * @return boolean Should the array item be deleted?
861 function api_reformat_xml(&$item, &$key)
863 if (is_bool($item)) {
864 $item = ($item ? "true" : "false");
867 if (substr($key, 0, 10) == "statusnet_") {
868 $key = "statusnet:".substr($key, 10);
869 } elseif (substr($key, 0, 10) == "friendica_") {
870 $key = "friendica:".substr($key, 10);
872 /// @TODO old-lost code?
874 // $key = "default:".$key;
880 * @brief Creates the XML from a JSON style array
882 * @param array $data JSON style array
883 * @param string $root_element Name of the root element
885 * @return string The XML data
887 function api_create_xml(array $data, $root_element)
889 $childname = key($data);
890 $data2 = array_pop($data);
892 $namespaces = ["" => "http://api.twitter.com",
893 "statusnet" => "http://status.net/schema/api/1/",
894 "friendica" => "http://friendi.ca/schema/api/1/",
895 "georss" => "http://www.georss.org/georss"];
897 /// @todo Auto detection of needed namespaces
898 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
902 if (is_array($data2)) {
904 api_walk_recursive($data2, "api_reformat_xml");
910 foreach ($data2 as $item) {
911 $data4[$i++ . ":" . $childname] = $item;
918 $data3 = [$root_element => $data2];
920 $ret = XML::fromArray($data3, $xml, false, $namespaces);
925 * @brief Formats the data according to the data type
927 * @param string $root_element Name of the root element
928 * @param string $type Return type (atom, rss, xml, json)
929 * @param array $data JSON style array
931 * @return (string|array) XML data or JSON data
933 function api_format_data($root_element, $type, $data)
939 $ret = api_create_xml($data, $root_element);
955 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
956 * returns a 401 status code and an error message if not.
957 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
959 * @param string $type Return type (atom, rss, xml, json)
961 function api_account_verify_credentials($type)
966 if (api_user() === false) {
967 throw new ForbiddenException();
970 unset($_REQUEST["user_id"]);
971 unset($_GET["user_id"]);
973 unset($_REQUEST["screen_name"]);
974 unset($_GET["screen_name"]);
976 $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false);
978 $user_info = api_get_user($a);
980 // "verified" isn't used here in the standard
981 unset($user_info["verified"]);
983 // - Adding last status
985 $user_info["status"] = api_status_show("raw");
986 if (!count($user_info["status"])) {
987 unset($user_info["status"]);
989 unset($user_info["status"]["user"]);
993 // "uid" and "self" are only needed for some internal stuff, so remove it from here
994 unset($user_info["uid"]);
995 unset($user_info["self"]);
997 return api_format_data("user", $type, ['user' => $user_info]);
1000 /// @TODO move to top of file or somewhere better
1001 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1004 * Get data from $_POST or $_GET
1008 function requestdata($k)
1010 if (x($_POST, $k)) {
1020 * Deprecated function to upload media.
1022 * @param string $type Return type (atom, rss, xml, json)
1024 * @return array|string
1026 function api_statuses_mediap($type)
1030 if (api_user() === false) {
1031 logger('api_statuses_update: no user');
1032 throw new ForbiddenException();
1034 $user_info = api_get_user($a);
1036 $_REQUEST['type'] = 'wall';
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 = html2bb_video($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]";
1060 // this should output the last post (the one we just posted).
1061 return api_status_show($type);
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)
1080 if (api_user() === false) {
1081 logger('api_statuses_update: no user');
1082 throw new ForbiddenException();
1087 // convert $_POST array items to the form we use for web posts.
1088 if (requestdata('htmlstatus')) {
1089 $txt = requestdata('htmlstatus');
1090 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1091 $txt = html2bb_video($txt);
1093 $config = HTMLPurifier_Config::createDefault();
1094 $config->set('Cache.DefinitionImpl', null);
1096 $purifier = new HTMLPurifier($config);
1097 $txt = $purifier->purify($txt);
1099 $_REQUEST['body'] = HTML::toBBCode($txt);
1102 $_REQUEST['body'] = requestdata('status');
1105 $_REQUEST['title'] = requestdata('title');
1107 $parent = requestdata('in_reply_to_status_id');
1109 // Twidere sends "-1" if it is no reply ...
1110 if ($parent == -1) {
1114 if (ctype_digit($parent)) {
1115 $_REQUEST['parent'] = $parent;
1117 $_REQUEST['parent_uri'] = $parent;
1120 if (requestdata('lat') && requestdata('long')) {
1121 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1123 $_REQUEST['profile_uid'] = api_user();
1126 $_REQUEST['type'] = 'net-comment';
1128 // Check for throttling (maximum posts per day, week and month)
1129 $throttle_day = Config::get('system', 'throttle_limit_day');
1130 if ($throttle_day > 0) {
1131 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1133 $condition = ["`uid` = ? AND `wall` AND `created` > ? AND `id` = `parent`", api_user(), $datefrom];
1134 $posts_day = dba::count('item', $condition);
1136 if ($posts_day > $throttle_day) {
1137 logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG);
1138 // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1139 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));
1143 $throttle_week = Config::get('system', 'throttle_limit_week');
1144 if ($throttle_week > 0) {
1145 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1147 $condition = ["`uid` = ? AND `wall` AND `created` > ? AND `id` = `parent`", api_user(), $datefrom];
1148 $posts_week = dba::count('item', $condition);
1150 if ($posts_week > $throttle_week) {
1151 logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1152 // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1153 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));
1157 $throttle_month = Config::get('system', 'throttle_limit_month');
1158 if ($throttle_month > 0) {
1159 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1161 $condition = ["`uid` = ? AND `wall` AND `created` > ? AND `id` = `parent`", api_user(), $datefrom];
1162 $posts_month = dba::count('item', $condition);
1164 if ($posts_month > $throttle_month) {
1165 logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1166 // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1167 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));
1171 $_REQUEST['type'] = 'wall';
1174 if (x($_FILES, 'media')) {
1175 // upload the image if we have one
1176 $picture = wall_upload_post($a, false);
1177 if (is_array($picture)) {
1178 $_REQUEST['body'] .= "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1182 // To-Do: Multiple IDs
1183 if (requestdata('media_ids')) {
1185 "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",
1186 intval(requestdata('media_ids')),
1189 if (DBM::is_result($r)) {
1190 $phototypes = Image::supportedTypes();
1191 $ext = $phototypes[$r[0]['type']];
1192 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1193 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1197 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1199 $_REQUEST['api_source'] = true;
1201 if (!x($_REQUEST, "source")) {
1202 $_REQUEST["source"] = api_source();
1205 // call out normal post function
1208 // this should output the last post (the one we just posted).
1209 return api_status_show($type);
1212 /// @TODO move to top of file or somewhere better
1213 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1214 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1217 * Uploads an image to Friendica.
1220 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1222 function api_media_upload()
1226 if (api_user() === false) {
1228 throw new ForbiddenException();
1233 if (!x($_FILES, 'media')) {
1235 throw new BadRequestException("No media.");
1238 $media = wall_upload_post($a, false);
1241 throw new InternalServerErrorException();
1245 $returndata["media_id"] = $media["id"];
1246 $returndata["media_id_string"] = (string)$media["id"];
1247 $returndata["size"] = $media["size"];
1248 $returndata["image"] = ["w" => $media["width"],
1249 "h" => $media["height"],
1250 "image_type" => $media["type"]];
1252 logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG);
1254 return ["media" => $returndata];
1257 /// @TODO move to top of file or somewhere better
1258 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1262 * @param string $type Return type (atom, rss, xml, json)
1264 * @return array|string
1266 function api_status_show($type)
1270 $user_info = api_get_user($a);
1272 logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG);
1274 if ($type == "raw") {
1275 $privacy_sql = "AND NOT `private`";
1280 // get last public wall message
1281 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1282 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1283 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1285 if (DBM::is_result($lastwall)) {
1286 $in_reply_to = api_in_reply_to($lastwall);
1288 $converted = api_convert_item($lastwall);
1290 if ($type == "xml") {
1291 $geo = "georss:point";
1297 'created_at' => api_date($lastwall['created']),
1298 'id' => intval($lastwall['id']),
1299 'id_str' => (string) $lastwall['id'],
1300 'text' => $converted["text"],
1301 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1302 'truncated' => false,
1303 'in_reply_to_status_id' => $in_reply_to['status_id'],
1304 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1305 'in_reply_to_user_id' => $in_reply_to['user_id'],
1306 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1307 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1308 'user' => $user_info,
1310 'coordinates' => '',
1312 'contributors' => '',
1313 'is_quote_status' => false,
1314 'retweet_count' => 0,
1315 'favorite_count' => 0,
1316 'favorited' => $lastwall['starred'] ? true : false,
1317 'retweeted' => false,
1318 'possibly_sensitive' => false,
1320 'statusnet_html' => $converted["html"],
1321 'statusnet_conversation_id' => $lastwall['parent'],
1322 'external_url' => System::baseUrl() . '/display/' . $lastwall['guid'],
1325 if (count($converted["attachments"]) > 0) {
1326 $status_info["attachments"] = $converted["attachments"];
1329 if (count($converted["entities"]) > 0) {
1330 $status_info["entities"] = $converted["entities"];
1333 if ($status_info["source"] == 'web') {
1334 $status_info["source"] = ContactSelector::networkToName($lastwall['network'], $user_info['url']);
1335 } elseif (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $status_info["source"]) {
1336 $status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['network'], $user_info['url']).')');
1339 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1340 unset($status_info["user"]["uid"]);
1341 unset($status_info["user"]["self"]);
1343 logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG);
1345 if ($type == "raw") {
1346 return $status_info;
1349 return api_format_data("statuses", $type, ['status' => $status_info]);
1354 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1355 * The author's most recent status will be returned inline.
1357 * @param string $type Return type (atom, rss, xml, json)
1358 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1360 function api_users_show($type)
1364 $user_info = api_get_user($a);
1366 $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
1367 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'private' => false];
1368 $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
1370 if (DBM::is_result($lastwall)) {
1371 $in_reply_to = api_in_reply_to($lastwall);
1373 $converted = api_convert_item($lastwall);
1375 if ($type == "xml") {
1376 $geo = "georss:point";
1381 $user_info['status'] = [
1382 'text' => $converted["text"],
1383 'truncated' => false,
1384 'created_at' => api_date($lastwall['created']),
1385 'in_reply_to_status_id' => $in_reply_to['status_id'],
1386 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1387 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1388 'id' => intval($lastwall['contact-id']),
1389 'id_str' => (string) $lastwall['contact-id'],
1390 'in_reply_to_user_id' => $in_reply_to['user_id'],
1391 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1392 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1394 'favorited' => $lastwall['starred'] ? true : false,
1395 'statusnet_html' => $converted["html"],
1396 'statusnet_conversation_id' => $lastwall['parent'],
1397 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1400 if (count($converted["attachments"]) > 0) {
1401 $user_info["status"]["attachments"] = $converted["attachments"];
1404 if (count($converted["entities"]) > 0) {
1405 $user_info["status"]["entities"] = $converted["entities"];
1408 if ($user_info["status"]["source"] == 'web') {
1409 $user_info["status"]["source"] = ContactSelector::networkToName($lastwall['network'], $user_info['url']);
1412 if (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $user_info["status"]["source"]) {
1413 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['network'], $user_info['url']) . ')');
1417 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1418 unset($user_info["uid"]);
1419 unset($user_info["self"]);
1421 return api_format_data("user", $type, ['user' => $user_info]);
1424 /// @TODO move to top of file or somewhere better
1425 api_register_func('api/users/show', 'api_users_show');
1426 api_register_func('api/externalprofile/show', 'api_users_show');
1429 * Search a public user account.
1431 * @param string $type Return type (atom, rss, xml, json)
1433 * @return array|string
1434 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1436 function api_users_search($type)
1442 if (x($_GET, 'q')) {
1443 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", dbesc($_GET["q"]));
1445 if (!DBM::is_result($r)) {
1446 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", dbesc($_GET["q"]));
1449 if (DBM::is_result($r)) {
1451 foreach ($r as $user) {
1452 $user_info = api_get_user($a, $user["id"]);
1454 if ($type == "xml") {
1455 $userlist[$k++.":user"] = $user_info;
1457 $userlist[] = $user_info;
1460 $userlist = ["users" => $userlist];
1462 throw new BadRequestException("User ".$_GET["q"]." not found.");
1465 throw new BadRequestException("No user specified.");
1468 return api_format_data("users", $type, $userlist);
1471 /// @TODO move to top of file or somewhere better
1472 api_register_func('api/users/search', 'api_users_search');
1475 * Return user objects
1477 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1479 * @param string $type Return format: json or xml
1481 * @return array|string
1482 * @throws NotFoundException if the results are empty.
1484 function api_users_lookup($type)
1488 if (!empty($_REQUEST['user_id'])) {
1489 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1491 $users[] = api_get_user(get_app(), $id);
1496 if (empty($users)) {
1497 throw new NotFoundException;
1500 return api_format_data("users", $type, ['users' => $users]);
1503 /// @TODO move to top of file or somewhere better
1504 api_register_func('api/users/lookup', 'api_users_lookup', true);
1507 * Returns statuses that match a specified query.
1509 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1511 * @param string $type Return format: json, xml, atom, rss
1513 * @return array|string
1514 * @throws BadRequestException if the "q" parameter is missing.
1516 function api_search($type)
1519 $user_info = api_get_user($a);
1521 if (api_user() === false || $user_info === false) {
1522 throw new ForbiddenException();
1527 if (!x($_REQUEST, 'q')) {
1528 throw new BadRequestException("q parameter is required.");
1531 if (x($_REQUEST, 'rpp')) {
1532 $count = $_REQUEST['rpp'];
1533 } elseif (x($_REQUEST, 'count')) {
1534 $count = $_REQUEST['count'];
1539 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1540 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1541 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1543 $start = $page * $count;
1545 $condition = ["`gravity` IN (?, ?) AND `item`.`id` > ?
1546 AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))
1547 AND `item`.`body` LIKE CONCAT('%',?,'%')",
1548 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, api_user(), $_REQUEST['q']];
1551 $condition[0] .= " AND `item`.`id` <= ?";
1552 $condition[] = $max_id;
1555 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1556 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1558 $data['status'] = api_format_items(Item::inArray($statuses), $user_info);
1560 return api_format_data("statuses", $type, $data);
1563 /// @TODO move to top of file or somewhere better
1564 api_register_func('api/search/tweets', 'api_search', true);
1565 api_register_func('api/search', 'api_search', true);
1568 * Returns the most recent statuses posted by the user and the users they follow.
1570 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1572 * @param string $type Return type (atom, rss, xml, json)
1574 * @todo Optional parameters
1575 * @todo Add reply info
1577 function api_statuses_home_timeline($type)
1580 $user_info = api_get_user($a);
1582 if (api_user() === false || $user_info === false) {
1583 throw new ForbiddenException();
1586 unset($_REQUEST["user_id"]);
1587 unset($_GET["user_id"]);
1589 unset($_REQUEST["screen_name"]);
1590 unset($_GET["screen_name"]);
1592 // get last network messages
1595 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1596 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1600 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1601 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1602 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1603 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1604 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1606 $start = $page * $count;
1608 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1609 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1612 $condition[0] .= " AND `item`.`id` <= ?";
1613 $condition[] = $max_id;
1615 if ($exclude_replies > 0) {
1616 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
1618 if ($conversation_id > 0) {
1619 $condition[0] .= " AND `item`.`parent` = ?";
1620 $condition[] = $conversation_id;
1623 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1624 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1626 $items = Item::inArray($statuses);
1628 $ret = api_format_items($items, $user_info, false, $type);
1630 // Set all posts from the query above to seen
1632 foreach ($items as $item) {
1633 $idarray[] = intval($item["id"]);
1636 if (!empty($idarray)) {
1637 $unseen = Item::exists(['unseen' => true, 'id' => $idarray]);
1639 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1643 $data = ['status' => $ret];
1647 $data = api_rss_extra($a, $data, $user_info);
1651 return api_format_data("statuses", $type, $data);
1654 /// @TODO move to top of file or somewhere better
1655 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1656 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1659 * Returns the most recent statuses from public users.
1661 * @param string $type Return type (atom, rss, xml, json)
1663 * @return array|string
1665 function api_statuses_public_timeline($type)
1668 $user_info = api_get_user($a);
1670 if (api_user() === false || $user_info === false) {
1671 throw new ForbiddenException();
1674 // get last network messages
1677 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1678 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
1682 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1683 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1684 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1685 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1686 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1688 $start = $page * $count;
1691 if ($exclude_replies && !$conversation_id) {
1692 $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall`",
1693 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1696 $condition[0] .= " AND `thread`.`iid` <= ?";
1697 $condition[] = $max_id;
1700 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1701 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1703 $r = Item::inArray($statuses);
1705 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND `item`.`origin`",
1706 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1709 $condition[0] .= " AND `item`.`id` <= ?";
1710 $condition[] = $max_id;
1712 if ($conversation_id > 0) {
1713 $condition[0] .= " AND `item`.`parent` = ?";
1714 $condition[] = $conversation_id;
1717 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1718 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1720 $r = Item::inArray($statuses);
1723 $ret = api_format_items($r, $user_info, false, $type);
1725 $data = ['status' => $ret];
1729 $data = api_rss_extra($a, $data, $user_info);
1733 return api_format_data("statuses", $type, $data);
1736 /// @TODO move to top of file or somewhere better
1737 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1740 * Returns the most recent statuses posted by users this node knows about.
1742 * @brief Returns the list of public federated posts this node knows about
1744 * @param string $type Return format: json, xml, atom, rss
1745 * @return array|string
1746 * @throws ForbiddenException
1748 function api_statuses_networkpublic_timeline($type)
1751 $user_info = api_get_user($a);
1753 if (api_user() === false || $user_info === false) {
1754 throw new ForbiddenException();
1757 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
1758 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
1761 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
1762 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
1766 $start = ($page - 1) * $count;
1768 $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `thread`.`iid` > ? AND NOT `private`",
1769 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1772 $condition[0] .= " AND `thread`.`iid` <= ?";
1773 $condition[] = $max_id;
1776 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1777 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1779 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1781 $data = ['status' => $ret];
1785 $data = api_rss_extra($a, $data, $user_info);
1789 return api_format_data("statuses", $type, $data);
1792 /// @TODO move to top of file or somewhere better
1793 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1796 * Returns a single status.
1798 * @param string $type Return type (atom, rss, xml, json)
1800 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1802 function api_statuses_show($type)
1805 $user_info = api_get_user($a);
1807 if (api_user() === false || $user_info === false) {
1808 throw new ForbiddenException();
1812 $id = intval(defaults($a->argv, 3, 0));
1815 $id = intval(defaults($_REQUEST, 'id', 0));
1820 $id = intval(defaults($a->argv, 4, 0));
1823 logger('API: api_statuses_show: ' . $id);
1825 $conversation = !empty($_REQUEST['conversation']);
1827 // try to fetch the item for the local user - or the public item, if there is no local one
1828 $uri_item = Item::selectFirst(['uri'], ['id' => $id]);
1829 if (!DBM::is_result($uri_item)) {
1830 throw new BadRequestException("There is no status with this id.");
1833 $item = Item::selectFirst(['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1834 if (!DBM::is_result($item)) {
1835 throw new BadRequestException("There is no status with this id.");
1840 if ($conversation) {
1841 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1842 $params = ['order' => ['id' => true]];
1844 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1848 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1850 /// @TODO How about copying this to above methods which don't check $r ?
1851 if (!DBM::is_result($statuses)) {
1852 throw new BadRequestException("There is no status with this id.");
1855 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1857 if ($conversation) {
1858 $data = ['status' => $ret];
1859 return api_format_data("statuses", $type, $data);
1861 $data = ['status' => $ret[0]];
1862 return api_format_data("status", $type, $data);
1866 /// @TODO move to top of file or somewhere better
1867 api_register_func('api/statuses/show', 'api_statuses_show', true);
1871 * @param string $type Return type (atom, rss, xml, json)
1873 * @todo nothing to say?
1875 function api_conversation_show($type)
1878 $user_info = api_get_user($a);
1880 if (api_user() === false || $user_info === false) {
1881 throw new ForbiddenException();
1885 $id = intval(defaults($a->argv , 3 , 0));
1886 $since_id = intval(defaults($_REQUEST, 'since_id', 0));
1887 $max_id = intval(defaults($_REQUEST, 'max_id' , 0));
1888 $count = intval(defaults($_REQUEST, 'count' , 20));
1889 $page = intval(defaults($_REQUEST, 'page' , 1)) - 1;
1894 $start = $page * $count;
1897 $id = intval(defaults($_REQUEST, 'id', 0));
1902 $id = intval(defaults($a->argv, 4, 0));
1905 logger('API: api_conversation_show: '.$id);
1907 // try to fetch the item for the local user - or the public item, if there is no local one
1908 $item = Item::selectFirst(['parent-uri'], ['id' => $id]);
1909 if (!DBM::is_result($item)) {
1910 throw new BadRequestException("There is no status with this id.");
1913 $parent = Item::selectFirst(['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1914 if (!DBM::is_result($parent)) {
1915 throw new BadRequestException("There is no status with this id.");
1918 $id = $parent['id'];
1920 $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1921 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1924 $condition[0] .= " AND `item`.`id` <= ?";
1925 $condition[] = $max_id;
1928 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1929 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1931 if (!DBM::is_result($statuses)) {
1932 throw new BadRequestException("There is no status with id $id.");
1935 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1937 $data = ['status' => $ret];
1938 return api_format_data("statuses", $type, $data);
1941 /// @TODO move to top of file or somewhere better
1942 api_register_func('api/conversation/show', 'api_conversation_show', true);
1943 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
1948 * @param string $type Return type (atom, rss, xml, json)
1950 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
1952 function api_statuses_repeat($type)
1958 if (api_user() === false) {
1959 throw new ForbiddenException();
1965 $id = intval(defaults($a->argv, 3, 0));
1968 $id = intval(defaults($_REQUEST, 'id', 0));
1973 $id = intval(defaults($a->argv, 4, 0));
1976 logger('API: api_statuses_repeat: '.$id);
1978 $fields = ['body', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
1979 $item = Item::selectFirst($fields, ['id' => $id, 'private' => false]);
1981 if (DBM::is_result($item) && $item['body'] != "") {
1982 if (strpos($item['body'], "[/share]") !== false) {
1983 $pos = strpos($item['body'], "[share");
1984 $post = substr($item['body'], $pos);
1986 $post = share_header($item['author-name'], $item['author-link'], $item['author-avatar'], $item['guid'], $item['created'], $item['plink']);
1988 $post .= $item['body'];
1989 $post .= "[/share]";
1991 $_REQUEST['body'] = $post;
1992 $_REQUEST['profile_uid'] = api_user();
1993 $_REQUEST['type'] = 'wall';
1994 $_REQUEST['api_source'] = true;
1996 if (!x($_REQUEST, "source")) {
1997 $_REQUEST["source"] = api_source();
2002 throw new ForbiddenException();
2005 // this should output the last post (the one we just posted).
2007 return api_status_show($type);
2010 /// @TODO move to top of file or somewhere better
2011 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2014 * Destroys a specific status.
2016 * @param string $type Return type (atom, rss, xml, json)
2018 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2020 function api_statuses_destroy($type)
2024 if (api_user() === false) {
2025 throw new ForbiddenException();
2031 $id = intval(defaults($a->argv, 3, 0));
2034 $id = intval(defaults($_REQUEST, 'id', 0));
2039 $id = intval(defaults($a->argv, 4, 0));
2042 logger('API: api_statuses_destroy: '.$id);
2044 $ret = api_statuses_show($type);
2046 Item::deleteForUser(['id' => $id], api_user());
2051 /// @TODO move to top of file or somewhere better
2052 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2055 * Returns the most recent mentions.
2057 * @param string $type Return type (atom, rss, xml, json)
2059 * @see http://developer.twitter.com/doc/get/statuses/mentions
2061 function api_statuses_mentions($type)
2064 $user_info = api_get_user($a);
2066 if (api_user() === false || $user_info === false) {
2067 throw new ForbiddenException();
2070 unset($_REQUEST["user_id"]);
2071 unset($_GET["user_id"]);
2073 unset($_REQUEST["screen_name"]);
2074 unset($_GET["screen_name"]);
2076 // get last network messages
2079 $since_id = defaults($_REQUEST, 'since_id', 0);
2080 $max_id = defaults($_REQUEST, 'max_id' , 0);
2081 $count = defaults($_REQUEST, 'count' , 20);
2082 $page = defaults($_REQUEST, 'page' , 1);
2087 $start = ($page - 1) * $count;
2089 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `author-id` != ?
2090 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `thread`.`uid` = ? AND `thread`.`mention` AND NOT `thread`.`ignored`)",
2091 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['pid'], api_user()];
2094 $condition[0] .= " AND `item`.`id` <= ?";
2095 $condition[] = $max_id;
2098 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2099 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2101 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2103 $data = ['status' => $ret];
2107 $data = api_rss_extra($a, $data, $user_info);
2111 return api_format_data("statuses", $type, $data);
2114 /// @TODO move to top of file or somewhere better
2115 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2116 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2119 * Returns the most recent statuses posted by the user.
2121 * @brief Returns a user's public timeline
2123 * @param string $type Either "json" or "xml"
2124 * @return string|array
2125 * @throws ForbiddenException
2126 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2128 function api_statuses_user_timeline($type)
2131 $user_info = api_get_user($a);
2133 if (api_user() === false || $user_info === false) {
2134 throw new ForbiddenException();
2138 "api_statuses_user_timeline: api_user: ". api_user() .
2139 "\nuser_info: ".print_r($user_info, true) .
2140 "\n_REQUEST: ".print_r($_REQUEST, true),
2144 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
2145 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
2146 $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0;
2147 $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0;
2150 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
2151 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
2155 $start = ($page - 1) * $count;
2157 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `item`.`contact-id` = ?",
2158 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2160 if ($user_info['self'] == 1) {
2161 $condition[0] .= ' AND `item`.`wall` ';
2164 if ($exclude_replies > 0) {
2165 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
2168 if ($conversation_id > 0) {
2169 $condition[0] .= " AND `item`.`parent` = ?";
2170 $condition[] = $conversation_id;
2174 $condition[0] .= " AND `item`.`id` <= ?";
2175 $condition[] = $max_id;
2178 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2179 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2181 $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type);
2183 $data = ['status' => $ret];
2187 $data = api_rss_extra($a, $data, $user_info);
2191 return api_format_data("statuses", $type, $data);
2194 /// @TODO move to top of file or somewhere better
2195 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2198 * Star/unstar an item.
2199 * param: id : id of the item
2201 * @param string $type Return type (atom, rss, xml, json)
2203 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2205 function api_favorites_create_destroy($type)
2209 if (api_user() === false) {
2210 throw new ForbiddenException();
2213 // for versioned api.
2214 /// @TODO We need a better global soluton
2215 $action_argv_id = 2;
2216 if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2217 $action_argv_id = 3;
2220 if ($a->argc <= $action_argv_id) {
2221 throw new BadRequestException("Invalid request.");
2223 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2224 if ($a->argc == $action_argv_id + 2) {
2225 $itemid = intval(defaults($a->argv, $action_argv_id + 1, 0));
2227 $itemid = intval(defaults($_REQUEST, 'id', 0));
2230 $item = Item::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2232 if (!DBM::is_result($item)) {
2233 throw new BadRequestException("Invalid item.");
2238 $item['starred'] = 1;
2241 $item['starred'] = 0;
2244 throw new BadRequestException("Invalid action ".$action);
2247 $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2250 throw new InternalServerErrorException("DB error");
2254 $user_info = api_get_user($a);
2255 $rets = api_format_items([$item], $user_info, false, $type);
2258 $data = ['status' => $ret];
2262 $data = api_rss_extra($a, $data, $user_info);
2265 return api_format_data("status", $type, $data);
2268 /// @TODO move to top of file or somewhere better
2269 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2270 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2273 * Returns the most recent favorite statuses.
2275 * @param string $type Return type (atom, rss, xml, json)
2277 * @return string|array
2279 function api_favorites($type)
2284 $user_info = api_get_user($a);
2286 if (api_user() === false || $user_info === false) {
2287 throw new ForbiddenException();
2292 // in friendica starred item are private
2293 // return favorites only for self
2294 logger('api_favorites: self:' . $user_info['self']);
2296 if ($user_info['self'] == 0) {
2300 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2301 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2302 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
2303 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2308 $start = $page*$count;
2310 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2311 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2313 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2316 $condition[0] .= " AND `item`.`id` <= ?";
2317 $condition[] = $max_id;
2320 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2322 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2325 $data = ['status' => $ret];
2329 $data = api_rss_extra($a, $data, $user_info);
2332 return api_format_data("statuses", $type, $data);
2335 /// @TODO move to top of file or somewhere better
2336 api_register_func('api/favorites', 'api_favorites', true);
2340 * @param array $item
2341 * @param array $recipient
2342 * @param array $sender
2346 function api_format_messages($item, $recipient, $sender)
2348 // standard meta information
2350 'id' => $item['id'],
2351 'sender_id' => $sender['id'] ,
2353 'recipient_id' => $recipient['id'],
2354 'created_at' => api_date(defaults($item, 'created', DateTimeFormat::utcNow())),
2355 'sender_screen_name' => $sender['screen_name'],
2356 'recipient_screen_name' => $recipient['screen_name'],
2357 'sender' => $sender,
2358 'recipient' => $recipient,
2360 'friendica_seen' => defaults($item, 'seen', 0),
2361 'friendica_parent_uri' => defaults($item, 'parent-uri', ''),
2364 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2365 if (isset($ret['sender']['uid'])) {
2366 unset($ret['sender']['uid']);
2368 if (isset($ret['sender']['self'])) {
2369 unset($ret['sender']['self']);
2371 if (isset($ret['recipient']['uid'])) {
2372 unset($ret['recipient']['uid']);
2374 if (isset($ret['recipient']['self'])) {
2375 unset($ret['recipient']['self']);
2378 //don't send title to regular StatusNET requests to avoid confusing these apps
2379 if (x($_GET, 'getText')) {
2380 $ret['title'] = $item['title'];
2381 if ($_GET['getText'] == 'html') {
2382 $ret['text'] = BBCode::convert($item['body'], false);
2383 } elseif ($_GET['getText'] == 'plain') {
2384 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2387 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2389 if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') {
2390 unset($ret['sender']);
2391 unset($ret['recipient']);
2399 * @param array $item
2403 function api_convert_item($item)
2405 $body = $item['body'];
2406 $attachments = api_get_attachments($body);
2408 // Workaround for ostatus messages where the title is identically to the body
2409 $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2410 $statusbody = trim(HTML::toPlaintext($html, 0));
2412 // handle data: images
2413 $statusbody = api_format_items_embeded_images($item, $statusbody);
2415 $statustitle = trim($item['title']);
2417 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2418 $statustext = trim($statusbody);
2420 $statustext = trim($statustitle."\n\n".$statusbody);
2423 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($statustext)> 1000)) {
2424 $statustext = substr($statustext, 0, 1000) . "... \n" . defaults($item, 'plink', '');
2427 $statushtml = BBCode::convert(api_clean_attachments($body), false);
2429 // Workaround for clients with limited HTML parser functionality
2430 $search = ["<br>", "<blockquote>", "</blockquote>",
2431 "<h1>", "</h1>", "<h2>", "</h2>",
2432 "<h3>", "</h3>", "<h4>", "</h4>",
2433 "<h5>", "</h5>", "<h6>", "</h6>"];
2434 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2435 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2436 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2437 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2438 $statushtml = str_replace($search, $replace, $statushtml);
2440 if ($item['title'] != "") {
2441 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2445 $oldtext = $statushtml;
2446 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2447 } while ($oldtext != $statushtml);
2449 if (substr($statushtml, 0, 4) == '<br>') {
2450 $statushtml = substr($statushtml, 4);
2453 if (substr($statushtml, 0, -4) == '<br>') {
2454 $statushtml = substr($statushtml, -4);
2457 // feeds without body should contain the link
2458 if ((defaults($item, 'network', Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2459 $statushtml .= BBCode::convert($item['plink']);
2462 $entities = api_get_entitities($statustext, $body);
2465 "text" => $statustext,
2466 "html" => $statushtml,
2467 "attachments" => $attachments,
2468 "entities" => $entities
2474 * @param string $body
2478 function api_get_attachments(&$body)
2481 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2483 $URLSearchString = "^\[\]";
2484 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2492 foreach ($images[1] as $image) {
2493 $imagedata = Image::getInfoFromURL($image);
2496 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2500 if (strstr(defaults($_SERVER, 'HTTP_USER_AGENT', ''), "AndStatus")) {
2501 foreach ($images[0] as $orig) {
2502 $body = str_replace($orig, "", $body);
2506 return $attachments;
2511 * @param string $text
2512 * @param string $bbcode
2515 * @todo Links at the first character of the post
2517 function api_get_entitities(&$text, $bbcode)
2519 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
2521 if ($include_entities != "true") {
2522 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2524 foreach ($images[1] as $image) {
2525 $replace = proxy_url($image);
2526 $text = str_replace($image, $replace, $text);
2531 $bbcode = BBCode::cleanPictureLinks($bbcode);
2533 // Change pure links in text to bbcode uris
2534 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2537 $entities["hashtags"] = [];
2538 $entities["symbols"] = [];
2539 $entities["urls"] = [];
2540 $entities["user_mentions"] = [];
2542 $URLSearchString = "^\[\]";
2544 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2546 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2547 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2548 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2550 $bbcode = preg_replace(
2551 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2552 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2555 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2557 $bbcode = preg_replace(
2558 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2559 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2562 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2564 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2566 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2567 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2570 foreach ($urls[1] as $id => $url) {
2571 //$start = strpos($text, $url, $offset);
2572 $start = iconv_strpos($text, $url, 0, "UTF-8");
2573 if (!($start === false)) {
2574 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2578 ksort($ordered_urls);
2581 //foreach ($urls[1] AS $id=>$url) {
2582 foreach ($ordered_urls as $url) {
2583 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2584 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2586 $display_url = $url["title"];
2588 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2589 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2591 if (strlen($display_url) > 26) {
2592 $display_url = substr($display_url, 0, 25)."…";
2596 //$start = strpos($text, $url, $offset);
2597 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2598 if (!($start === false)) {
2599 $entities["urls"][] = ["url" => $url["url"],
2600 "expanded_url" => $url["url"],
2601 "display_url" => $display_url,
2602 "indices" => [$start, $start+strlen($url["url"])]];
2603 $offset = $start + 1;
2607 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2608 $ordered_images = [];
2609 foreach ($images[1] as $image) {
2610 //$start = strpos($text, $url, $offset);
2611 $start = iconv_strpos($text, $image, 0, "UTF-8");
2612 if (!($start === false)) {
2613 $ordered_images[$start] = $image;
2616 //$entities["media"] = array();
2619 foreach ($ordered_images as $url) {
2620 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2621 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2623 if (strlen($display_url) > 26) {
2624 $display_url = substr($display_url, 0, 25)."…";
2627 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2628 if (!($start === false)) {
2629 $image = Image::getInfoFromURL($url);
2631 // If image cache is activated, then use the following sizes:
2632 // thumb (150), small (340), medium (600) and large (1024)
2633 if (!Config::get("system", "proxy_disabled")) {
2634 $media_url = proxy_url($url);
2637 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2638 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2640 if (($image[0] > 150) || ($image[1] > 150)) {
2641 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2642 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2645 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2646 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2648 if (($image[0] > 600) || ($image[1] > 600)) {
2649 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2650 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2654 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2657 $entities["media"][] = [
2659 "id_str" => (string)$start+1,
2660 "indices" => [$start, $start+strlen($url)],
2661 "media_url" => normalise_link($media_url),
2662 "media_url_https" => $media_url,
2664 "display_url" => $display_url,
2665 "expanded_url" => $url,
2669 $offset = $start + 1;
2678 * @param array $item
2679 * @param string $text
2683 function api_format_items_embeded_images($item, $text)
2685 $text = preg_replace_callback(
2686 '|data:image/([^;]+)[^=]+=*|m',
2687 function () use ($item) {
2688 return System::baseUrl() . '/display/' . $item['guid'];
2696 * @brief return <a href='url'>name</a> as array
2698 * @param string $txt text
2703 function api_contactlink_to_array($txt)
2706 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2707 if ($r && count($match)==3) {
2709 'name' => $match[2],
2723 * @brief return likes, dislikes and attend status for item
2725 * @param array $item array
2726 * @param string $type Return type (atom, rss, xml, json)
2729 * likes => int count,
2730 * dislikes => int count
2732 function api_format_items_activities(&$item, $type = "json")
2741 'attendmaybe' => [],
2744 $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri']];
2745 $ret = Item::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2747 while ($item = Item::fetch($ret)) {
2748 // not used as result should be structured like other user data
2749 //builtin_activity_puller($i, $activities);
2751 // get user data and add it to the array of the activity
2752 $user = api_get_user($a, $item['author-id']);
2753 switch ($item['verb']) {
2755 $activities['like'][] = $user;
2757 case ACTIVITY_DISLIKE:
2758 $activities['dislike'][] = $user;
2760 case ACTIVITY_ATTEND:
2761 $activities['attendyes'][] = $user;
2763 case ACTIVITY_ATTENDNO:
2764 $activities['attendno'][] = $user;
2766 case ACTIVITY_ATTENDMAYBE:
2767 $activities['attendmaybe'][] = $user;
2776 if ($type == "xml") {
2777 $xml_activities = [];
2778 foreach ($activities as $k => $v) {
2779 // change xml element from "like" to "friendica:like"
2780 $xml_activities["friendica:".$k] = $v;
2781 // add user data into xml output
2783 foreach ($v as $user) {
2784 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2787 $activities = $xml_activities;
2795 * @brief return data from profiles
2797 * @param array $profile_row array containing data from db table 'profile'
2800 function api_format_items_profiles($profile_row)
2803 'profile_id' => $profile_row['id'],
2804 'profile_name' => $profile_row['profile-name'],
2805 'is_default' => $profile_row['is-default'] ? true : false,
2806 'hide_friends' => $profile_row['hide-friends'] ? true : false,
2807 'profile_photo' => $profile_row['photo'],
2808 'profile_thumb' => $profile_row['thumb'],
2809 'publish' => $profile_row['publish'] ? true : false,
2810 'net_publish' => $profile_row['net-publish'] ? true : false,
2811 'description' => $profile_row['pdesc'],
2812 'date_of_birth' => $profile_row['dob'],
2813 'address' => $profile_row['address'],
2814 'city' => $profile_row['locality'],
2815 'region' => $profile_row['region'],
2816 'postal_code' => $profile_row['postal-code'],
2817 'country' => $profile_row['country-name'],
2818 'hometown' => $profile_row['hometown'],
2819 'gender' => $profile_row['gender'],
2820 'marital' => $profile_row['marital'],
2821 'marital_with' => $profile_row['with'],
2822 'marital_since' => $profile_row['howlong'],
2823 'sexual' => $profile_row['sexual'],
2824 'politic' => $profile_row['politic'],
2825 'religion' => $profile_row['religion'],
2826 'public_keywords' => $profile_row['pub_keywords'],
2827 'private_keywords' => $profile_row['prv_keywords'],
2828 'likes' => BBCode::convert(api_clean_plain_items($profile_row['likes']) , false, 2),
2829 'dislikes' => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
2830 'about' => BBCode::convert(api_clean_plain_items($profile_row['about']) , false, 2),
2831 'music' => BBCode::convert(api_clean_plain_items($profile_row['music']) , false, 2),
2832 'book' => BBCode::convert(api_clean_plain_items($profile_row['book']) , false, 2),
2833 'tv' => BBCode::convert(api_clean_plain_items($profile_row['tv']) , false, 2),
2834 'film' => BBCode::convert(api_clean_plain_items($profile_row['film']) , false, 2),
2835 'interest' => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
2836 'romance' => BBCode::convert(api_clean_plain_items($profile_row['romance']) , false, 2),
2837 'work' => BBCode::convert(api_clean_plain_items($profile_row['work']) , false, 2),
2838 'education' => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
2839 'social_networks' => BBCode::convert(api_clean_plain_items($profile_row['contact']) , false, 2),
2840 'homepage' => $profile_row['homepage'],
2847 * @brief format items to be returned by api
2849 * @param array $r array of items
2850 * @param array $user_info
2851 * @param bool $filter_user filter items by $user_info
2852 * @param string $type Return type (atom, rss, xml, json)
2854 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
2860 foreach ($r as $item) {
2861 localize_item($item);
2862 list($status_user, $owner_user) = api_item_get_user($a, $item);
2864 // Look if the posts are matching if they should be filtered by user id
2865 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2869 $in_reply_to = api_in_reply_to($item);
2871 $converted = api_convert_item($item);
2873 if ($type == "xml") {
2874 $geo = "georss:point";
2880 'text' => $converted["text"],
2881 'truncated' => false,
2882 'created_at'=> api_date($item['created']),
2883 'in_reply_to_status_id' => $in_reply_to['status_id'],
2884 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
2885 'source' => (($item['app']) ? $item['app'] : 'web'),
2886 'id' => intval($item['id']),
2887 'id_str' => (string) intval($item['id']),
2888 'in_reply_to_user_id' => $in_reply_to['user_id'],
2889 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
2890 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
2892 'favorited' => $item['starred'] ? true : false,
2893 'user' => $status_user ,
2894 'friendica_owner' => $owner_user,
2895 //'entities' => NULL,
2896 'statusnet_html' => $converted["html"],
2897 'statusnet_conversation_id' => $item['parent'],
2898 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
2899 'friendica_activities' => api_format_items_activities($item, $type),
2902 if (count($converted["attachments"]) > 0) {
2903 $status["attachments"] = $converted["attachments"];
2906 if (count($converted["entities"]) > 0) {
2907 $status["entities"] = $converted["entities"];
2910 if ($status["source"] == 'web') {
2911 $status["source"] = ContactSelector::networkToName($item['network'], $user_info['url']);
2912 } elseif (ContactSelector::networkToName($item['network'], $user_info['url']) != $status["source"]) {
2913 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $user_info['url']).')');
2916 if ($item["id"] == $item["parent"]) {
2917 $retweeted_item = api_share_as_retweet($item);
2918 if ($retweeted_item !== false) {
2919 $retweeted_status = $status;
2921 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
2922 } catch (BadRequestException $e) {
2923 // user not found. should be found?
2924 /// @todo check if the user should be always found
2925 $retweeted_status["user"] = [];
2928 $rt_converted = api_convert_item($retweeted_item);
2930 $retweeted_status['text'] = $rt_converted["text"];
2931 $retweeted_status['statusnet_html'] = $rt_converted["html"];
2932 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
2933 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
2934 $status['retweeted_status'] = $retweeted_status;
2938 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2939 unset($status["user"]["uid"]);
2940 unset($status["user"]["self"]);
2942 if ($item["coord"] != "") {
2943 $coords = explode(' ', $item["coord"]);
2944 if (count($coords) == 2) {
2945 if ($type == "json") {
2946 $status["geo"] = ['type' => 'Point',
2947 'coordinates' => [(float) $coords[0],
2948 (float) $coords[1]]];
2949 } else {// Not sure if this is the official format - if someone founds a documentation we can check
2950 $status["georss:point"] = $item["coord"];
2960 * Returns the remaining number of API requests available to the user before the API limit is reached.
2962 * @param string $type Return type (atom, rss, xml, json)
2964 * @return array|string
2966 function api_account_rate_limit_status($type)
2968 if ($type == "xml") {
2970 'remaining-hits' => '150',
2971 '@attributes' => ["type" => "integer"],
2972 'hourly-limit' => '150',
2973 '@attributes2' => ["type" => "integer"],
2974 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
2975 '@attributes3' => ["type" => "datetime"],
2976 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2977 '@attributes4' => ["type" => "integer"],
2981 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2982 'remaining_hits' => '150',
2983 'hourly_limit' => '150',
2984 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
2988 return api_format_data('hash', $type, ['hash' => $hash]);
2991 /// @TODO move to top of file or somewhere better
2992 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
2995 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
2997 * @param string $type Return type (atom, rss, xml, json)
2999 * @return array|string
3001 function api_help_test($type)
3003 if ($type == 'xml') {
3009 return api_format_data('ok', $type, ["ok" => $ok]);
3012 /// @TODO move to top of file or somewhere better
3013 api_register_func('api/help/test', 'api_help_test', false);
3016 * Returns all lists the user subscribes to.
3018 * @param string $type Return type (atom, rss, xml, json)
3020 * @return array|string
3021 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3023 function api_lists_list($type)
3026 /// @TODO $ret is not filled here?
3027 return api_format_data('lists', $type, ["lists_list" => $ret]);
3030 /// @TODO move to top of file or somewhere better
3031 api_register_func('api/lists/list', 'api_lists_list', true);
3032 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3035 * Returns all groups the user owns.
3037 * @param string $type Return type (atom, rss, xml, json)
3039 * @return array|string
3040 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3042 function api_lists_ownerships($type)
3046 if (api_user() === false) {
3047 throw new ForbiddenException();
3051 $user_info = api_get_user($a);
3052 $uid = $user_info['uid'];
3054 $groups = dba::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3056 // loop through all groups
3058 foreach ($groups as $group) {
3059 if ($group['visible']) {
3065 'name' => $group['name'],
3066 'id' => intval($group['id']),
3067 'id_str' => (string) $group['id'],
3068 'user' => $user_info,
3072 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3075 /// @TODO move to top of file or somewhere better
3076 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3079 * Returns recent statuses from users in the specified group.
3081 * @param string $type Return type (atom, rss, xml, json)
3083 * @return array|string
3084 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3086 function api_lists_statuses($type)
3090 $user_info = api_get_user($a);
3091 if (api_user() === false || $user_info === false) {
3092 throw new ForbiddenException();
3095 unset($_REQUEST["user_id"]);
3096 unset($_GET["user_id"]);
3098 unset($_REQUEST["screen_name"]);
3099 unset($_GET["screen_name"]);
3101 if (empty($_REQUEST['list_id'])) {
3102 throw new BadRequestException('list_id not specified');
3106 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
3107 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
3111 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3112 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3113 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
3114 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
3116 $start = $page * $count;
3118 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3119 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3122 $condition[0] .= " AND `item`.`id` <= ?";
3123 $condition[] = $max_id;
3125 if ($exclude_replies > 0) {
3126 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
3128 if ($conversation_id > 0) {
3129 $condition[0] .= " AND `item`.`parent` = ?";
3130 $condition[] = $conversation_id;
3133 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3134 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3136 $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3138 $data = ['status' => $items];
3142 $data = api_rss_extra($a, $data, $user_info);
3146 return api_format_data("statuses", $type, $data);
3149 /// @TODO move to top of file or somewhere better
3150 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3153 * Considers friends and followers lists to be private and won't return
3154 * anything if any user_id parameter is passed.
3156 * @brief Returns either the friends of the follower list
3158 * @param string $qtype Either "friends" or "followers"
3159 * @return boolean|array
3160 * @throws ForbiddenException
3162 function api_statuses_f($qtype)
3166 if (api_user() === false) {
3167 throw new ForbiddenException();
3171 $count = x($_GET, 'count') ? $_GET['count'] : 20;
3172 $page = x($_GET, 'page') ? $_GET['page'] : 1;
3176 $start = ($page - 1) * $count;
3178 $user_info = api_get_user($a);
3180 if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3181 /* this is to stop Hotot to load friends multiple times
3182 * I'm not sure if I'm missing return something or
3183 * is a bug in hotot. Workaround, meantime
3187 return array('$users' => $ret);*/
3192 if ($qtype == 'friends') {
3193 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_SHARING), intval(CONTACT_IS_FRIEND));
3194 } elseif ($qtype == 'followers') {
3195 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_FOLLOWER), intval(CONTACT_IS_FRIEND));
3198 // friends and followers only for self
3199 if ($user_info['self'] == 0) {
3200 $sql_extra = " AND false ";
3203 if ($qtype == 'blocks') {
3204 $sql_filter = 'AND `blocked` AND NOT `pending`';
3205 } elseif ($qtype == 'incoming') {
3206 $sql_filter = 'AND `pending`';
3208 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3226 foreach ($r as $cid) {
3227 $user = api_get_user($a, $cid['nurl']);
3228 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3229 unset($user["uid"]);
3230 unset($user["self"]);
3237 return ['user' => $ret];
3242 * Returns the user's friends.
3244 * @brief Returns the list of friends of the provided user
3246 * @deprecated By Twitter API in favor of friends/list
3248 * @param string $type Either "json" or "xml"
3249 * @return boolean|string|array
3251 function api_statuses_friends($type)
3253 $data = api_statuses_f("friends");
3254 if ($data === false) {
3257 return api_format_data("users", $type, $data);
3261 * Returns the user's followers.
3263 * @brief Returns the list of followers of the provided user
3265 * @deprecated By Twitter API in favor of friends/list
3267 * @param string $type Either "json" or "xml"
3268 * @return boolean|string|array
3270 function api_statuses_followers($type)
3272 $data = api_statuses_f("followers");
3273 if ($data === false) {
3276 return api_format_data("users", $type, $data);
3279 /// @TODO move to top of file or somewhere better
3280 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3281 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3284 * Returns the list of blocked users
3286 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3288 * @param string $type Either "json" or "xml"
3290 * @return boolean|string|array
3292 function api_blocks_list($type)
3294 $data = api_statuses_f('blocks');
3295 if ($data === false) {
3298 return api_format_data("users", $type, $data);
3301 /// @TODO move to top of file or somewhere better
3302 api_register_func('api/blocks/list', 'api_blocks_list', true);
3305 * Returns the list of pending users IDs
3307 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3309 * @param string $type Either "json" or "xml"
3311 * @return boolean|string|array
3313 function api_friendships_incoming($type)
3315 $data = api_statuses_f('incoming');
3316 if ($data === false) {
3321 foreach ($data['user'] as $user) {
3322 $ids[] = $user['id'];
3325 return api_format_data("ids", $type, ['id' => $ids]);
3328 /// @TODO move to top of file or somewhere better
3329 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3332 * Returns the instance's configuration information.
3334 * @param string $type Return type (atom, rss, xml, json)
3336 * @return array|string
3338 function api_statusnet_config($type)
3342 $name = Config::get('config', 'sitename');
3343 $server = $a->get_hostname();
3344 $logo = System::baseUrl() . '/images/friendica-64.png';
3345 $email = Config::get('config', 'admin_email');
3346 $closed = Config::get('config', 'register_policy') == REGISTER_CLOSED ? 'true' : 'false';
3347 $private = Config::get('system', 'block_public') ? 'true' : 'false';
3348 $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000));
3349 $ssl = Config::get('system', 'have_ssl') ? 'true' : 'false';
3350 $sslserver = Config::get('system', 'have_ssl') ? str_replace('http:', 'https:', System::baseUrl()) : '';
3353 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3354 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3355 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3356 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3357 'shorturllength' => '30',
3359 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3360 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3361 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3362 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3367 return api_format_data('config', $type, ['config' => $config]);
3370 /// @TODO move to top of file or somewhere better
3371 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3372 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3376 * @param string $type Return type (atom, rss, xml, json)
3378 * @return array|string
3380 function api_statusnet_version($type)
3383 $fake_statusnet_version = "0.9.7";
3385 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3388 /// @TODO move to top of file or somewhere better
3389 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3390 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3394 * @param string $type Return type (atom, rss, xml, json)
3396 * @todo use api_format_data() to return data
3398 function api_ff_ids($type)
3401 throw new ForbiddenException();
3408 $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3411 "SELECT `pcontact`.`id` FROM `contact`
3412 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3413 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3416 if (!DBM::is_result($r)) {
3421 foreach ($r as $rr) {
3422 if ($stringify_ids) {
3425 $ids[] = intval($rr['id']);
3429 return api_format_data("ids", $type, ['id' => $ids]);
3433 * Returns the ID of every user the user is following.
3435 * @param string $type Return type (atom, rss, xml, json)
3437 * @return array|string
3438 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3440 function api_friends_ids($type)
3442 return api_ff_ids($type);
3446 * Returns the ID of every user following the user.
3448 * @param string $type Return type (atom, rss, xml, json)
3450 * @return array|string
3451 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3453 function api_followers_ids($type)
3455 return api_ff_ids($type);
3458 /// @TODO move to top of file or somewhere better
3459 api_register_func('api/friends/ids', 'api_friends_ids', true);
3460 api_register_func('api/followers/ids', 'api_followers_ids', true);
3463 * Sends a new direct message.
3465 * @param string $type Return type (atom, rss, xml, json)
3467 * @return array|string
3468 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3470 function api_direct_messages_new($type)
3474 if (api_user() === false) {
3475 throw new ForbiddenException();
3478 if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3482 $sender = api_get_user($a);
3485 if (!empty($_POST['screen_name'])) {
3487 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3489 dbesc($_POST['screen_name'])
3492 if (DBM::is_result($r)) {
3493 // Selecting the id by priority, friendica first
3494 api_best_nickname($r);
3496 $recipient = api_get_user($a, $r[0]['nurl']);
3499 $recipient = api_get_user($a, $_POST['user_id']);
3502 if (empty($recipient)) {
3503 throw new NotFoundException('Recipient not found');
3508 if (x($_REQUEST, 'replyto')) {
3510 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3512 intval($_REQUEST['replyto'])
3514 $replyto = $r[0]['parent-uri'];
3515 $sub = $r[0]['title'];
3517 if (x($_REQUEST, 'title')) {
3518 $sub = $_REQUEST['title'];
3520 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3524 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3527 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3528 $ret = api_format_messages($r[0], $recipient, $sender);
3530 $ret = ["error"=>$id];
3533 $data = ['direct_message'=>$ret];
3538 $data = api_rss_extra($a, $data, $sender);
3541 return api_format_data("direct-messages", $type, $data);
3544 /// @TODO move to top of file or somewhere better
3545 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3548 * Destroys a direct message.
3550 * @brief delete a direct_message from mail table through api
3552 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3553 * @return string|array
3554 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3556 function api_direct_messages_destroy($type)
3560 if (api_user() === false) {
3561 throw new ForbiddenException();
3565 $user_info = api_get_user($a);
3567 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3569 $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3570 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3571 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3573 $uid = $user_info['uid'];
3574 // error if no id or parenturi specified (for clients posting parent-uri as well)
3575 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3576 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3577 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3580 // BadRequestException if no id specified (for clients using Twitter API)
3582 throw new BadRequestException('Message id not specified');
3585 // add parent-uri to sql command if specified by calling app
3586 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . dbesc($parenturi) . "'" : "");
3588 // get data of the specified message id
3590 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3595 // error message if specified id is not in database
3596 if (!DBM::is_result($r)) {
3597 if ($verbose == "true") {
3598 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3599 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3601 /// @todo BadRequestException ok for Twitter API clients?
3602 throw new BadRequestException('message id not in database');
3607 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3612 if ($verbose == "true") {
3615 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3616 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3618 $answer = ['result' => 'error', 'message' => 'unknown error'];
3619 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3622 /// @todo return JSON data like Twitter API not yet implemented
3625 /// @TODO move to top of file or somewhere better
3626 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3630 * @param string $type Return type (atom, rss, xml, json)
3631 * @param string $box
3632 * @param string $verbose
3634 * @return array|string
3636 function api_direct_messages_box($type, $box, $verbose)
3639 if (api_user() === false) {
3640 throw new ForbiddenException();
3643 $count = defaults($_GET, 'count', 20);
3644 $page = defaults($_REQUEST, 'page', 1) - 1;
3649 $since_id = defaults($_REQUEST, 'since_id', 0);
3650 $max_id = defaults($_REQUEST, 'max_id', 0);
3652 $user_id = defaults($_REQUEST, 'user_id', '');
3653 $screen_name = defaults($_REQUEST, 'screen_name', '');
3656 unset($_REQUEST["user_id"]);
3657 unset($_GET["user_id"]);
3659 unset($_REQUEST["screen_name"]);
3660 unset($_GET["screen_name"]);
3662 $user_info = api_get_user($a);
3663 if ($user_info === false) {
3664 throw new ForbiddenException();
3666 $profile_url = $user_info["url"];
3669 $start = $page * $count;
3674 if ($box=="sentbox") {
3675 $sql_extra = "`mail`.`from-url`='" . dbesc($profile_url) . "'";
3676 } elseif ($box == "conversation") {
3677 $sql_extra = "`mail`.`parent-uri`='" . dbesc(defaults($_GET, 'uri', '')) . "'";
3678 } elseif ($box == "all") {
3679 $sql_extra = "true";
3680 } elseif ($box == "inbox") {
3681 $sql_extra = "`mail`.`from-url`!='" . dbesc($profile_url) . "'";
3685 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3688 if ($user_id != "") {
3689 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3690 } elseif ($screen_name !="") {
3691 $sql_extra .= " AND `contact`.`nick` = '" . dbesc($screen_name). "'";
3695 "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",
3701 if ($verbose == "true" && !DBM::is_result($r)) {
3702 $answer = ['result' => 'error', 'message' => 'no mails available'];
3703 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3707 foreach ($r as $item) {
3708 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3709 $recipient = $user_info;
3710 $sender = api_get_user($a, normalise_link($item['contact-url']));
3711 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3712 $recipient = api_get_user($a, normalise_link($item['contact-url']));
3713 $sender = $user_info;
3716 if (isset($recipient) && isset($sender)) {
3717 $ret[] = api_format_messages($item, $recipient, $sender);
3722 $data = ['direct_message' => $ret];
3726 $data = api_rss_extra($a, $data, $user_info);
3729 return api_format_data("direct-messages", $type, $data);
3733 * Returns the most recent direct messages sent by the user.
3735 * @param string $type Return type (atom, rss, xml, json)
3737 * @return array|string
3738 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3740 function api_direct_messages_sentbox($type)
3742 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3743 return api_direct_messages_box($type, "sentbox", $verbose);
3747 * Returns the most recent direct messages sent to the user.
3749 * @param string $type Return type (atom, rss, xml, json)
3751 * @return array|string
3752 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3754 function api_direct_messages_inbox($type)
3756 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3757 return api_direct_messages_box($type, "inbox", $verbose);
3762 * @param string $type Return type (atom, rss, xml, json)
3764 * @return array|string
3766 function api_direct_messages_all($type)
3768 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3769 return api_direct_messages_box($type, "all", $verbose);
3774 * @param string $type Return type (atom, rss, xml, json)
3776 * @return array|string
3778 function api_direct_messages_conversation($type)
3780 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3781 return api_direct_messages_box($type, "conversation", $verbose);
3784 /// @TODO move to top of file or somewhere better
3785 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3786 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3787 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3788 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3791 * Returns an OAuth Request Token.
3793 * @see https://oauth.net/core/1.0/#auth_step1
3795 function api_oauth_request_token()
3797 $oauth1 = new FKOAuth1();
3799 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
3800 } catch (Exception $e) {
3801 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
3809 * Returns an OAuth Access Token.
3811 * @return array|string
3812 * @see https://oauth.net/core/1.0/#auth_step3
3814 function api_oauth_access_token()
3816 $oauth1 = new FKOAuth1();
3818 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
3819 } catch (Exception $e) {
3820 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
3827 /// @TODO move to top of file or somewhere better
3828 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
3829 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
3833 * @brief delete a complete photoalbum with all containing photos from database through api
3835 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3836 * @return string|array
3838 function api_fr_photoalbum_delete($type)
3840 if (api_user() === false) {
3841 throw new ForbiddenException();
3844 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3846 // we do not allow calls without album string
3848 throw new BadRequestException("no albumname specified");
3850 // check if album is existing
3852 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3856 if (!DBM::is_result($r)) {
3857 throw new BadRequestException("album not available");
3860 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
3861 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
3862 foreach ($r as $rr) {
3863 $condition = ['uid' => local_user(), 'resource-id' => $rr['resource-id'], 'type' => 'photo'];
3864 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
3866 if (!DBM::is_result($photo_item)) {
3867 throw new InternalServerErrorException("problem with deleting items occured");
3869 Item::deleteForUser(['id' => $photo_item['id']], api_user());
3872 // now let's delete all photos from the album
3873 $result = dba::delete('photo', ['uid' => api_user(), 'album' => $album]);
3875 // return success of deletion or error message
3877 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
3878 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
3880 throw new InternalServerErrorException("unknown error - deleting from database failed");
3885 * @brief update the name of the album for all photos of an album
3887 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3888 * @return string|array
3890 function api_fr_photoalbum_update($type)
3892 if (api_user() === false) {
3893 throw new ForbiddenException();
3896 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3897 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
3899 // we do not allow calls without album string
3901 throw new BadRequestException("no albumname specified");
3903 if ($album_new == "") {
3904 throw new BadRequestException("no new albumname specified");
3906 // check if album is existing
3907 if (!dba::exists('photo', ['uid' => api_user(), 'album' => $album])) {
3908 throw new BadRequestException("album not available");
3910 // now let's update all photos to the albumname
3911 $result = dba::update('photo', ['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
3913 // return success of updating or error message
3915 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
3916 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
3918 throw new InternalServerErrorException("unknown error - updating in database failed");
3924 * @brief list all photos of the authenticated user
3926 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3927 * @return string|array
3929 function api_fr_photos_list($type)
3931 if (api_user() === false) {
3932 throw new ForbiddenException();
3935 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
3936 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
3937 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
3938 intval(local_user())
3941 'image/jpeg' => 'jpg',
3942 'image/png' => 'png',
3943 'image/gif' => 'gif'
3945 $data = ['photo'=>[]];
3946 if (DBM::is_result($r)) {
3947 foreach ($r as $rr) {
3949 $photo['id'] = $rr['resource-id'];
3950 $photo['album'] = $rr['album'];
3951 $photo['filename'] = $rr['filename'];
3952 $photo['type'] = $rr['type'];
3953 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
3954 $photo['created'] = $rr['created'];
3955 $photo['edited'] = $rr['edited'];
3956 $photo['desc'] = $rr['desc'];
3958 if ($type == "xml") {
3959 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
3961 $photo['thumb'] = $thumb;
3962 $data['photo'][] = $photo;
3966 return api_format_data("photos", $type, $data);
3970 * @brief upload a new photo or change an existing photo
3972 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3973 * @return string|array
3975 function api_fr_photo_create_update($type)
3977 if (api_user() === false) {
3978 throw new ForbiddenException();
3981 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
3982 $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
3983 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
3984 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
3985 $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
3986 $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
3987 $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
3988 $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
3989 $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
3991 // do several checks on input parameters
3992 // we do not allow calls without album string
3993 if ($album == null) {
3994 throw new BadRequestException("no albumname specified");
3996 // if photo_id == null --> we are uploading a new photo
3997 if ($photo_id == null) {
4000 // error if no media posted in create-mode
4001 if (!x($_FILES, 'media')) {
4003 throw new BadRequestException("no media data submitted");
4006 // album_new will be ignored in create-mode
4011 // check if photo is existing in database
4013 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4018 if (!DBM::is_result($r)) {
4019 throw new BadRequestException("photo not available");
4023 // checks on acl strings provided by clients
4024 $acl_input_error = false;
4025 $acl_input_error |= check_acl_input($allow_cid);
4026 $acl_input_error |= check_acl_input($deny_cid);
4027 $acl_input_error |= check_acl_input($allow_gid);
4028 $acl_input_error |= check_acl_input($deny_gid);
4029 if ($acl_input_error) {
4030 throw new BadRequestException("acl data invalid");
4032 // now let's upload the new media in create-mode
4033 if ($mode == "create") {
4034 $media = $_FILES['media'];
4035 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4037 // return success of updating or error message
4038 if (!is_null($data)) {
4039 return api_format_data("photo_create", $type, $data);
4041 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4045 // now let's do the changes in update-mode
4046 if ($mode == "update") {
4049 if (!is_null($desc)) {
4050 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
4053 if (!is_null($album_new)) {
4054 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
4057 if (!is_null($allow_cid)) {
4058 $allow_cid = trim($allow_cid);
4059 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
4062 if (!is_null($deny_cid)) {
4063 $deny_cid = trim($deny_cid);
4064 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
4067 if (!is_null($allow_gid)) {
4068 $allow_gid = trim($allow_gid);
4069 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
4072 if (!is_null($deny_gid)) {
4073 $deny_gid = trim($deny_gid);
4074 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
4078 if ($sql_extra != "") {
4079 $nothingtodo = false;
4081 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4083 DateTimeFormat::utcNow(), // update edited timestamp
4089 $nothingtodo = true;
4092 if (x($_FILES, 'media')) {
4093 $nothingtodo = false;
4094 $media = $_FILES['media'];
4095 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4096 if (!is_null($data)) {
4097 return api_format_data("photo_update", $type, $data);
4101 // return success of updating or error message
4103 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4104 return api_format_data("photo_update", $type, ['$result' => $answer]);
4107 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4108 return api_format_data("photo_update", $type, ['$result' => $answer]);
4110 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4113 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4117 * @brief delete a single photo from the database through api
4119 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4120 * @return string|array
4122 function api_fr_photo_delete($type)
4124 if (api_user() === false) {
4125 throw new ForbiddenException();
4128 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4130 // do several checks on input parameters
4131 // we do not allow calls without photo id
4132 if ($photo_id == null) {
4133 throw new BadRequestException("no photo_id specified");
4135 // check if photo is existing in database
4137 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4141 if (!DBM::is_result($r)) {
4142 throw new BadRequestException("photo not available");
4144 // now we can perform on the deletion of the photo
4145 $result = dba::delete('photo', ['uid' => api_user(), 'resource-id' => $photo_id]);
4147 // return success of deletion or error message
4149 // retrieve the id of the parent element (the photo element)
4150 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4151 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4153 if (!DBM::is_result($photo_item)) {
4154 throw new InternalServerErrorException("problem with deleting items occured");
4156 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4157 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4158 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4160 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4161 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4163 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4169 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4171 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4172 * @return string|array
4174 function api_fr_photo_detail($type)
4176 if (api_user() === false) {
4177 throw new ForbiddenException();
4179 if (!x($_REQUEST, 'photo_id')) {
4180 throw new BadRequestException("No photo id.");
4183 $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4184 $photo_id = $_REQUEST['photo_id'];
4186 // prepare json/xml output with data from database for the requested photo
4187 $data = prepare_photo_data($type, $scale, $photo_id);
4189 return api_format_data("photo_detail", $type, $data);
4194 * Updates the user’s profile image.
4196 * @brief updates the profile image for the user (either a specified profile or the default profile)
4198 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4200 * @return string|array
4201 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4203 function api_account_update_profile_image($type)
4205 if (api_user() === false) {
4206 throw new ForbiddenException();
4209 $profile_id = defaults($_REQUEST, 'profile_id', 0);
4211 // error if image data is missing
4212 if (!x($_FILES, 'image')) {
4213 throw new BadRequestException("no media data submitted");
4216 // check if specified profile id is valid
4217 if ($profile_id != 0) {
4218 $profile = dba::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4219 // error message if specified profile id is not in database
4220 if (!DBM::is_result($profile)) {
4221 throw new BadRequestException("profile_id not available");
4223 $is_default_profile = $profile['is-default'];
4225 $is_default_profile = 1;
4228 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4230 if (x($_FILES, 'image')) {
4231 $media = $_FILES['image'];
4232 } elseif (x($_FILES, 'media')) {
4233 $media = $_FILES['media'];
4235 // save new profile image
4236 $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4239 if (is_array($media['type'])) {
4240 $filetype = $media['type'][0];
4242 $filetype = $media['type'];
4244 if ($filetype == "image/jpeg") {
4246 } elseif ($filetype == "image/png") {
4249 throw new InternalServerErrorException('Unsupported filetype');
4252 // change specified profile or all profiles to the new resource-id
4253 if ($is_default_profile) {
4254 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4255 dba::update('photo', ['profile' => false], $condition);
4257 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype,
4258 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype];
4259 dba::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4262 Contact::updateSelfFromUserID(api_user(), true);
4264 // Update global directory in background
4265 $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4266 if ($url && strlen(Config::get('system', 'directory'))) {
4267 Worker::add(PRIORITY_LOW, "Directory", $url);
4270 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4272 // output for client
4274 return api_account_verify_credentials($type);
4276 // SaveMediaToDatabase failed for some reason
4277 throw new InternalServerErrorException("image upload failed");
4281 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4282 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4283 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4284 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4285 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4286 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4287 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4288 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4289 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4292 * Update user profile
4294 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4296 * @return array|string
4298 function api_account_update_profile($type)
4300 $local_user = api_user();
4301 $api_user = api_get_user(get_app());
4303 if (!empty($_POST['name'])) {
4304 dba::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4305 dba::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4306 dba::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4307 dba::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4310 if (isset($_POST['description'])) {
4311 dba::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4312 dba::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4313 dba::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4316 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4317 // Update global directory in background
4318 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4319 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4322 return api_account_verify_credentials($type);
4325 /// @TODO move to top of file or somewhere better
4326 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4330 * @param string $acl_string
4332 function check_acl_input($acl_string)
4334 if ($acl_string == null || $acl_string == " ") {
4337 $contact_not_found = false;
4339 // split <x><y><z> into array of cid's
4340 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4342 // check for each cid if it is available on server
4343 $cid_array = $array[0];
4344 foreach ($cid_array as $cid) {
4345 $cid = str_replace("<", "", $cid);
4346 $cid = str_replace(">", "", $cid);
4348 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
4352 $contact_not_found |= !DBM::is_result($contact);
4354 return $contact_not_found;
4359 * @param string $mediatype
4360 * @param array $media
4361 * @param string $type
4362 * @param string $album
4363 * @param string $allow_cid
4364 * @param string $deny_cid
4365 * @param string $allow_gid
4366 * @param string $deny_gid
4367 * @param string $desc
4368 * @param integer $profile
4369 * @param boolean $visibility
4370 * @param string $photo_id
4372 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)
4380 if (is_array($media)) {
4381 if (is_array($media['tmp_name'])) {
4382 $src = $media['tmp_name'][0];
4384 $src = $media['tmp_name'];
4386 if (is_array($media['name'])) {
4387 $filename = basename($media['name'][0]);
4389 $filename = basename($media['name']);
4391 if (is_array($media['size'])) {
4392 $filesize = intval($media['size'][0]);
4394 $filesize = intval($media['size']);
4396 if (is_array($media['type'])) {
4397 $filetype = $media['type'][0];
4399 $filetype = $media['type'];
4403 if ($filetype == "") {
4404 $filetype=Image::guessType($filename);
4406 $imagedata = getimagesize($src);
4408 $filetype = $imagedata['mime'];
4411 "File upload src: " . $src . " - filename: " . $filename .
4412 " - size: " . $filesize . " - type: " . $filetype,
4416 // check if there was a php upload error
4417 if ($filesize == 0 && $media['error'] == 1) {
4418 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4420 // check against max upload size within Friendica instance
4421 $maximagesize = Config::get('system', 'maximagesize');
4422 if ($maximagesize && ($filesize > $maximagesize)) {
4423 $formattedBytes = formatBytes($maximagesize);
4424 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4427 // create Photo instance with the data of the image
4428 $imagedata = @file_get_contents($src);
4429 $Image = new Image($imagedata, $filetype);
4430 if (! $Image->isValid()) {
4431 throw new InternalServerErrorException("unable to process image data");
4434 // check orientation of image
4435 $Image->orient($src);
4438 // check max length of images on server
4439 $max_length = Config::get('system', 'max_image_length');
4440 if (! $max_length) {
4441 $max_length = MAX_IMAGE_LENGTH;
4443 if ($max_length > 0) {
4444 $Image->scaleDown($max_length);
4445 logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG);
4447 $width = $Image->getWidth();
4448 $height = $Image->getHeight();
4450 // create a new resource-id if not already provided
4451 $hash = ($photo_id == null) ? Photo::newResource() : $photo_id;
4453 if ($mediatype == "photo") {
4454 // upload normal image (scales 0, 1, 2)
4455 logger("photo upload: starting new photo upload", LOGGER_DEBUG);
4457 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4459 logger("photo upload: image upload with scale 0 (original size) failed");
4461 if ($width > 640 || $height > 640) {
4462 $Image->scaleDown(640);
4463 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4465 logger("photo upload: image upload with scale 1 (640x640) failed");
4469 if ($width > 320 || $height > 320) {
4470 $Image->scaleDown(320);
4471 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4473 logger("photo upload: image upload with scale 2 (320x320) failed");
4476 logger("photo upload: new photo upload ended", LOGGER_DEBUG);
4477 } elseif ($mediatype == "profileimage") {
4478 // upload profile image (scales 4, 5, 6)
4479 logger("photo upload: starting new profile image upload", LOGGER_DEBUG);
4481 if ($width > 175 || $height > 175) {
4482 $Image->scaleDown(175);
4483 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4485 logger("photo upload: profile image upload with scale 4 (175x175) failed");
4489 if ($width > 80 || $height > 80) {
4490 $Image->scaleDown(80);
4491 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4493 logger("photo upload: profile image upload with scale 5 (80x80) failed");
4497 if ($width > 48 || $height > 48) {
4498 $Image->scaleDown(48);
4499 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4501 logger("photo upload: profile image upload with scale 6 (48x48) failed");
4504 $Image->__destruct();
4505 logger("photo upload: new profile image upload ended", LOGGER_DEBUG);
4508 if (isset($r) && $r) {
4509 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4510 if ($photo_id == null && $mediatype == "photo") {
4511 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4513 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4514 return prepare_photo_data($type, false, $hash);
4516 throw new InternalServerErrorException("image upload failed");
4522 * @param string $hash
4523 * @param string $allow_cid
4524 * @param string $deny_cid
4525 * @param string $allow_gid
4526 * @param string $deny_gid
4527 * @param string $filetype
4528 * @param boolean $visibility
4530 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4532 // get data about the api authenticated user
4533 $uri = Item::newURI(intval(api_user()));
4534 $owner_record = q("SELECT * FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
4537 $arr['guid'] = get_guid(32);
4538 $arr['uid'] = intval(api_user());
4540 $arr['parent-uri'] = $uri;
4541 $arr['type'] = 'photo';
4543 $arr['resource-id'] = $hash;
4544 $arr['contact-id'] = $owner_record[0]['id'];
4545 $arr['owner-name'] = $owner_record[0]['name'];
4546 $arr['owner-link'] = $owner_record[0]['url'];
4547 $arr['owner-avatar'] = $owner_record[0]['thumb'];
4548 $arr['author-name'] = $owner_record[0]['name'];
4549 $arr['author-link'] = $owner_record[0]['url'];
4550 $arr['author-avatar'] = $owner_record[0]['thumb'];
4552 $arr['allow_cid'] = $allow_cid;
4553 $arr['allow_gid'] = $allow_gid;
4554 $arr['deny_cid'] = $deny_cid;
4555 $arr['deny_gid'] = $deny_gid;
4556 $arr['visible'] = $visibility;
4560 'image/jpeg' => 'jpg',
4561 'image/png' => 'png',
4562 'image/gif' => 'gif'
4565 // adds link to the thumbnail scale photo
4566 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record[0]['nick'] . '/image/' . $hash . ']'
4567 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4570 // do the magic for storing the item in the database and trigger the federation to other contacts
4576 * @param string $type
4578 * @param string $photo_id
4582 function prepare_photo_data($type, $scale, $photo_id)
4585 $user_info = api_get_user($a);
4587 if ($user_info === false) {
4588 throw new ForbiddenException();
4591 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4592 $data_sql = ($scale === false ? "" : "data, ");
4594 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4595 // clients needs to convert this in their way for further processing
4597 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4598 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4599 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4600 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4602 intval(local_user()),
4608 'image/jpeg' => 'jpg',
4609 'image/png' => 'png',
4610 'image/gif' => 'gif'
4613 // prepare output data for photo
4614 if (DBM::is_result($r)) {
4615 $data = ['photo' => $r[0]];
4616 $data['photo']['id'] = $data['photo']['resource-id'];
4617 if ($scale !== false) {
4618 $data['photo']['data'] = base64_encode($data['photo']['data']);
4620 unset($data['photo']['datasize']); //needed only with scale param
4622 if ($type == "xml") {
4623 $data['photo']['links'] = [];
4624 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4625 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4627 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4630 $data['photo']['link'] = [];
4631 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4633 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4634 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4638 unset($data['photo']['resource-id']);
4639 unset($data['photo']['minscale']);
4640 unset($data['photo']['maxscale']);
4642 throw new NotFoundException();
4645 // retrieve item element for getting activities (like, dislike etc.) related to photo
4646 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4647 $item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4649 $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4651 // retrieve comments on photo
4652 $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
4653 $item[0]['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4655 $statuses = Item::selectForUser(api_user(), [], $condition);
4657 // prepare output of comments
4658 $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
4660 if ($type == "xml") {
4662 foreach ($commentData as $comment) {
4663 $comments[$k++ . ":comment"] = $comment;
4666 foreach ($commentData as $comment) {
4667 $comments[] = $comment;
4670 $data['photo']['friendica_comments'] = $comments;
4672 // include info if rights on photo and rights on item are mismatching
4673 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4674 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4675 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4676 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4677 $data['photo']['rights_mismatch'] = $rights_mismatch;
4684 * Similar as /mod/redir.php
4685 * redirect to 'url' after dfrn auth
4687 * Why this when there is mod/redir.php already?
4688 * This use api_user() and api_login()
4691 * c_url: url of remote contact to auth to
4692 * url: string, url to redirect after auth
4694 function api_friendica_remoteauth()
4696 $url = (x($_GET, 'url') ? $_GET['url'] : '');
4697 $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : '');
4699 if ($url === '' || $c_url === '') {
4700 throw new BadRequestException("Wrong parameters.");
4703 $c_url = normalise_link($c_url);
4707 $contact = dba::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4709 if (!DBM::is_result($contact) || ($contact['network'] !== NETWORK_DFRN)) {
4710 throw new BadRequestException("Unknown contact");
4713 $cid = $contact['id'];
4715 $dfrn_id = defaults($contact, 'issued-id', $contact['dfrn-id']);
4717 if ($contact['duplex'] && $contact['issued-id']) {
4718 $orig_id = $contact['issued-id'];
4719 $dfrn_id = '1:' . $orig_id;
4721 if ($contact['duplex'] && $contact['dfrn-id']) {
4722 $orig_id = $contact['dfrn-id'];
4723 $dfrn_id = '0:' . $orig_id;
4726 $sec = random_string();
4728 $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
4729 'sec' => $sec, 'expire' => time() + 45];
4730 dba::insert('profile_check', $fields);
4732 logger($contact['name'] . ' ' . $sec, LOGGER_DEBUG);
4733 $dest = ($url ? '&destination_url=' . $url : '');
4735 $contact['poll'] . '?dfrn_id=' . $dfrn_id
4736 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4737 . '&type=profile&sec=' . $sec . $dest
4740 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4743 * @brief Return the item shared, if the item contains only the [share] tag
4745 * @param array $item Sharer item
4746 * @return array|false Shared item or false if not a reshare
4748 function api_share_as_retweet(&$item)
4750 $body = trim($item["body"]);
4752 if (Diaspora::isReshare($body, false)===false) {
4756 /// @TODO "$1" should maybe mean '$1' ?
4757 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
4759 * Skip if there is no shared message in there
4760 * we already checked this in diaspora::isReshare()
4761 * but better one more than one less...
4763 if ($body == $attributes) {
4768 // build the fake reshared item
4769 $reshared_item = $item;
4772 preg_match("/author='(.*?)'/ism", $attributes, $matches);
4773 if ($matches[1] != "") {
4774 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
4777 preg_match('/author="(.*?)"/ism', $attributes, $matches);
4778 if ($matches[1] != "") {
4779 $author = $matches[1];
4783 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
4784 if ($matches[1] != "") {
4785 $profile = $matches[1];
4788 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
4789 if ($matches[1] != "") {
4790 $profile = $matches[1];
4794 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
4795 if ($matches[1] != "") {
4796 $avatar = $matches[1];
4799 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
4800 if ($matches[1] != "") {
4801 $avatar = $matches[1];
4805 preg_match("/link='(.*?)'/ism", $attributes, $matches);
4806 if ($matches[1] != "") {
4807 $link = $matches[1];
4810 preg_match('/link="(.*?)"/ism', $attributes, $matches);
4811 if ($matches[1] != "") {
4812 $link = $matches[1];
4816 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
4817 if ($matches[1] != "") {
4818 $posted = $matches[1];
4821 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
4822 if ($matches[1] != "") {
4823 $posted = $matches[1];
4826 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
4828 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
4832 $reshared_item["body"] = $shared_body;
4833 $reshared_item["author-name"] = $author;
4834 $reshared_item["author-link"] = $profile;
4835 $reshared_item["author-avatar"] = $avatar;
4836 $reshared_item["plink"] = $link;
4837 $reshared_item["created"] = $posted;
4838 $reshared_item["edited"] = $posted;
4840 return $reshared_item;
4845 * @param string $profile
4847 * @return string|false
4848 * @todo remove trailing junk from profile url
4849 * @todo pump.io check has to check the website
4851 function api_get_nick($profile)
4856 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4857 dbesc(normalise_link($profile))
4860 if (DBM::is_result($r)) {
4861 $nick = $r[0]["nick"];
4866 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4867 dbesc(normalise_link($profile))
4870 if (DBM::is_result($r)) {
4871 $nick = $r[0]["nick"];
4876 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
4877 if ($friendica != $profile) {
4883 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
4884 if ($diaspora != $profile) {
4890 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
4891 if ($twitter != $profile) {
4898 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
4899 if ($StatusnetHost != $profile) {
4900 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
4901 if ($StatusnetUser != $profile) {
4902 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
4903 $user = json_decode($UserData);
4905 $nick = $user->screen_name;
4911 // To-Do: look at the page if its really a pumpio site
4912 //if (!$nick == "") {
4913 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
4914 // if ($pumpio != $profile)
4916 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
4929 * @param array $item
4933 function api_in_reply_to($item)
4937 $in_reply_to['status_id'] = null;
4938 $in_reply_to['user_id'] = null;
4939 $in_reply_to['status_id_str'] = null;
4940 $in_reply_to['user_id_str'] = null;
4941 $in_reply_to['screen_name'] = null;
4943 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
4944 $parent = Item::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
4945 if (DBM::is_result($parent)) {
4946 $in_reply_to['status_id'] = intval($parent['id']);
4948 $in_reply_to['status_id'] = intval($item['parent']);
4951 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
4953 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
4954 $parent = Item::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
4956 if (DBM::is_result($parent)) {
4957 if ($parent['author-nick'] == "") {
4958 $parent['author-nick'] = api_get_nick($parent['author-link']);
4961 $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
4962 $in_reply_to['user_id'] = intval($parent['author-id']);
4963 $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
4966 // There seems to be situation, where both fields are identical:
4967 // https://github.com/friendica/friendica/issues/1010
4968 // This is a bugfix for that.
4969 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
4970 logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG);
4971 $in_reply_to['status_id'] = null;
4972 $in_reply_to['user_id'] = null;
4973 $in_reply_to['status_id_str'] = null;
4974 $in_reply_to['user_id_str'] = null;
4975 $in_reply_to['screen_name'] = null;
4979 return $in_reply_to;
4984 * @param string $text
4988 function api_clean_plain_items($text)
4990 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
4992 $text = BBCode::cleanPictureLinks($text);
4993 $URLSearchString = "^\[\]";
4995 $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
4997 if ($include_entities == "true") {
4998 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5001 // Simplify "attachment" element
5002 $text = api_clean_attachments($text);
5008 * @brief Removes most sharing information for API text export
5010 * @param string $body The original body
5012 * @return string Cleaned body
5014 function api_clean_attachments($body)
5016 $data = BBCode::getAttachmentData($body);
5023 if (isset($data["text"])) {
5024 $body = $data["text"];
5026 if (($body == "") && isset($data["title"])) {
5027 $body = $data["title"];
5029 if (isset($data["url"])) {
5030 $body .= "\n".$data["url"];
5032 $body .= $data["after"];
5039 * @param array $contacts
5043 function api_best_nickname(&$contacts)
5047 if (count($contacts) == 0) {
5051 foreach ($contacts as $contact) {
5052 if ($contact["network"] == "") {
5053 $contact["network"] = "dfrn";
5054 $best_contact = [$contact];
5058 if (sizeof($best_contact) == 0) {
5059 foreach ($contacts as $contact) {
5060 if ($contact["network"] == "dfrn") {
5061 $best_contact = [$contact];
5066 if (sizeof($best_contact) == 0) {
5067 foreach ($contacts as $contact) {
5068 if ($contact["network"] == "dspr") {
5069 $best_contact = [$contact];
5074 if (sizeof($best_contact) == 0) {
5075 foreach ($contacts as $contact) {
5076 if ($contact["network"] == "stat") {
5077 $best_contact = [$contact];
5082 if (sizeof($best_contact) == 0) {
5083 foreach ($contacts as $contact) {
5084 if ($contact["network"] == "pump") {
5085 $best_contact = [$contact];
5090 if (sizeof($best_contact) == 0) {
5091 foreach ($contacts as $contact) {
5092 if ($contact["network"] == "twit") {
5093 $best_contact = [$contact];
5098 if (sizeof($best_contact) == 1) {
5099 $contacts = $best_contact;
5101 $contacts = [$contacts[0]];
5106 * Return all or a specified group of the user with the containing contacts.
5108 * @param string $type Return type (atom, rss, xml, json)
5110 * @return array|string
5112 function api_friendica_group_show($type)
5116 if (api_user() === false) {
5117 throw new ForbiddenException();
5121 $user_info = api_get_user($a);
5122 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5123 $uid = $user_info['uid'];
5125 // get data of the specified group id or all groups if not specified
5128 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5132 // error message if specified gid is not in database
5133 if (!DBM::is_result($r)) {
5134 throw new BadRequestException("gid not available");
5138 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5143 // loop through all groups and retrieve all members for adding data in the user array
5145 foreach ($r as $rr) {
5146 $members = Contact::getByGroupId($rr['id']);
5149 if ($type == "xml") {
5150 $user_element = "users";
5152 foreach ($members as $member) {
5153 $user = api_get_user($a, $member['nurl']);
5154 $users[$k++.":user"] = $user;
5157 $user_element = "user";
5158 foreach ($members as $member) {
5159 $user = api_get_user($a, $member['nurl']);
5163 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5165 return api_format_data("groups", $type, ['group' => $grps]);
5167 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5171 * Delete the specified group of the user.
5173 * @param string $type Return type (atom, rss, xml, json)
5175 * @return array|string
5177 function api_friendica_group_delete($type)
5181 if (api_user() === false) {
5182 throw new ForbiddenException();
5186 $user_info = api_get_user($a);
5187 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5188 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5189 $uid = $user_info['uid'];
5191 // error if no gid specified
5192 if ($gid == 0 || $name == "") {
5193 throw new BadRequestException('gid or name not specified');
5196 // get data of the specified group id
5198 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5202 // error message if specified gid is not in database
5203 if (!DBM::is_result($r)) {
5204 throw new BadRequestException('gid not available');
5207 // get data of the specified group id and group name
5209 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5214 // error message if specified gid is not in database
5215 if (!DBM::is_result($rname)) {
5216 throw new BadRequestException('wrong group name');
5220 $ret = Group::removeByName($uid, $name);
5223 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5224 return api_format_data("group_delete", $type, ['result' => $success]);
5226 throw new BadRequestException('other API error');
5229 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5234 * @param string $type Return type (atom, rss, xml, json)
5236 * @return array|string
5237 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5239 function api_lists_destroy($type)
5243 if (api_user() === false) {
5244 throw new ForbiddenException();
5248 $user_info = api_get_user($a);
5249 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5250 $uid = $user_info['uid'];
5252 // error if no gid specified
5254 throw new BadRequestException('gid not specified');
5257 // get data of the specified group id
5258 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5259 // error message if specified gid is not in database
5261 throw new BadRequestException('gid not available');
5264 if (Group::remove($gid)) {
5266 'name' => $group['name'],
5267 'id' => intval($gid),
5268 'id_str' => (string) $gid,
5269 'user' => $user_info
5272 return api_format_data("lists", $type, ['lists' => $list]);
5275 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5278 * Add a new group to the database.
5280 * @param string $name Group name
5281 * @param int $uid User ID
5282 * @param array $users List of users to add to the group
5286 function group_create($name, $uid, $users = [])
5288 // error if no name specified
5290 throw new BadRequestException('group name not specified');
5293 // get data of the specified group name
5295 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5299 // error message if specified group name already exists
5300 if (DBM::is_result($rname)) {
5301 throw new BadRequestException('group name already exists');
5304 // check if specified group name is a deleted group
5306 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5310 // error message if specified group name already exists
5311 if (DBM::is_result($rname)) {
5312 $reactivate_group = true;
5316 $ret = Group::create($uid, $name);
5318 $gid = Group::getIdByName($uid, $name);
5320 throw new BadRequestException('other API error');
5324 $erroraddinguser = false;
5326 foreach ($users as $user) {
5327 $cid = $user['cid'];
5328 // check if user really exists as contact
5330 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5334 if (count($contact)) {
5335 Group::addMember($gid, $cid);
5337 $erroraddinguser = true;
5338 $errorusers[] = $cid;
5342 // return success message incl. missing users in array
5343 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5345 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5349 * Create the specified group with the posted array of contacts.
5351 * @param string $type Return type (atom, rss, xml, json)
5353 * @return array|string
5355 function api_friendica_group_create($type)
5359 if (api_user() === false) {
5360 throw new ForbiddenException();
5364 $user_info = api_get_user($a);
5365 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5366 $uid = $user_info['uid'];
5367 $json = json_decode($_POST['json'], true);
5368 $users = $json['user'];
5370 $success = group_create($name, $uid, $users);
5372 return api_format_data("group_create", $type, ['result' => $success]);
5374 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5377 * Create a new group.
5379 * @param string $type Return type (atom, rss, xml, json)
5381 * @return array|string
5382 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5384 function api_lists_create($type)
5388 if (api_user() === false) {
5389 throw new ForbiddenException();
5393 $user_info = api_get_user($a);
5394 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5395 $uid = $user_info['uid'];
5397 $success = group_create($name, $uid);
5398 if ($success['success']) {
5400 'name' => $success['name'],
5401 'id' => intval($success['gid']),
5402 'id_str' => (string) $success['gid'],
5403 'user' => $user_info
5406 return api_format_data("lists", $type, ['lists'=>$grp]);
5409 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5412 * Update the specified group with the posted array of contacts.
5414 * @param string $type Return type (atom, rss, xml, json)
5416 * @return array|string
5418 function api_friendica_group_update($type)
5422 if (api_user() === false) {
5423 throw new ForbiddenException();
5427 $user_info = api_get_user($a);
5428 $uid = $user_info['uid'];
5429 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5430 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5431 $json = json_decode($_POST['json'], true);
5432 $users = $json['user'];
5434 // error if no name specified
5436 throw new BadRequestException('group name not specified');
5439 // error if no gid specified
5441 throw new BadRequestException('gid not specified');
5445 $members = Contact::getByGroupId($gid);
5446 foreach ($members as $member) {
5447 $cid = $member['id'];
5448 foreach ($users as $user) {
5449 $found = ($user['cid'] == $cid ? true : false);
5451 if (!isset($found) || !$found) {
5452 Group::removeMemberByName($uid, $name, $cid);
5457 $erroraddinguser = false;
5459 foreach ($users as $user) {
5460 $cid = $user['cid'];
5461 // check if user really exists as contact
5463 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5468 if (count($contact)) {
5469 Group::addMember($gid, $cid);
5471 $erroraddinguser = true;
5472 $errorusers[] = $cid;
5476 // return success message incl. missing users in array
5477 $status = ($erroraddinguser ? "missing user" : "ok");
5478 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5479 return api_format_data("group_update", $type, ['result' => $success]);
5482 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5485 * Update information about a group.
5487 * @param string $type Return type (atom, rss, xml, json)
5489 * @return array|string
5490 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5492 function api_lists_update($type)
5496 if (api_user() === false) {
5497 throw new ForbiddenException();
5501 $user_info = api_get_user($a);
5502 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5503 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5504 $uid = $user_info['uid'];
5506 // error if no gid specified
5508 throw new BadRequestException('gid not specified');
5511 // get data of the specified group id
5512 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5513 // error message if specified gid is not in database
5515 throw new BadRequestException('gid not available');
5518 if (Group::update($gid, $name)) {
5521 'id' => intval($gid),
5522 'id_str' => (string) $gid,
5523 'user' => $user_info
5526 return api_format_data("lists", $type, ['lists' => $list]);
5530 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5534 * @param string $type Return type (atom, rss, xml, json)
5536 * @return array|string
5538 function api_friendica_activity($type)
5542 if (api_user() === false) {
5543 throw new ForbiddenException();
5545 $verb = strtolower($a->argv[3]);
5546 $verb = preg_replace("|\..*$|", "", $verb);
5548 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5550 $res = Item::performLike($id, $verb);
5553 if ($type == "xml") {
5558 return api_format_data('ok', $type, ['ok' => $ok]);
5560 throw new BadRequestException('Error adding activity');
5564 /// @TODO move to top of file or somewhere better
5565 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5566 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5567 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5568 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5569 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5570 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5571 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5572 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5573 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5574 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5577 * @brief Returns notifications
5579 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5580 * @return string|array
5582 function api_friendica_notification($type)
5586 if (api_user() === false) {
5587 throw new ForbiddenException();
5590 throw new BadRequestException("Invalid argument count");
5592 $nm = new NotificationsManager();
5594 $notes = $nm->getAll([], "+seen -date", 50);
5596 if ($type == "xml") {
5598 if (!empty($notes)) {
5599 foreach ($notes as $note) {
5600 $xmlnotes[] = ["@attributes" => $note];
5607 return api_format_data("notes", $type, ['note' => $notes]);
5611 * POST request with 'id' param as notification id
5613 * @brief Set notification as seen and returns associated item (if possible)
5615 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5616 * @return string|array
5618 function api_friendica_notification_seen($type)
5621 $user_info = api_get_user($a);
5623 if (api_user() === false || $user_info === false) {
5624 throw new ForbiddenException();
5627 throw new BadRequestException("Invalid argument count");
5630 $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5632 $nm = new NotificationsManager();
5633 $note = $nm->getByID($id);
5634 if (is_null($note)) {
5635 throw new BadRequestException("Invalid argument");
5638 $nm->setSeen($note);
5639 if ($note['otype']=='item') {
5640 // would be really better with an ItemsManager and $im->getByID() :-P
5641 $item = Item::selectFirstForUser(api_user(), [], ['id' => $note['iid'], 'uid' => api_user()]);
5642 if (DBM::is_result($$item)) {
5643 // we found the item, return it to the user
5644 $ret = api_format_items([$item], $user_info, false, $type);
5645 $data = ['status' => $ret];
5646 return api_format_data("status", $type, $data);
5648 // the item can't be found, but we set the note as seen, so we count this as a success
5650 return api_format_data('result', $type, ['result' => "success"]);
5653 /// @TODO move to top of file or somewhere better
5654 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5655 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5658 * @brief update a direct_message to seen state
5660 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5661 * @return string|array (success result=ok, error result=error with error message)
5663 function api_friendica_direct_messages_setseen($type)
5666 if (api_user() === false) {
5667 throw new ForbiddenException();
5671 $user_info = api_get_user($a);
5672 $uid = $user_info['uid'];
5673 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5675 // return error if id is zero
5677 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5678 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5681 // error message if specified id is not in database
5682 if (!dba::exists('mail', ['id' => $id, 'uid' => $uid])) {
5683 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5684 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5687 // update seen indicator
5688 $result = dba::update('mail', ['seen' => true], ['id' => $id]);
5692 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
5693 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
5695 $answer = ['result' => 'error', 'message' => 'unknown error'];
5696 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5700 /// @TODO move to top of file or somewhere better
5701 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5704 * @brief search for direct_messages containing a searchstring through api
5706 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5707 * @param string $box
5708 * @return string|array (success: success=true if found and search_result contains found messages,
5709 * success=false if nothing was found, search_result='nothing found',
5710 * error: result=error with error message)
5712 function api_friendica_direct_messages_search($type, $box = "")
5716 if (api_user() === false) {
5717 throw new ForbiddenException();
5721 $user_info = api_get_user($a);
5722 $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
5723 $uid = $user_info['uid'];
5725 // error if no searchstring specified
5726 if ($searchstring == "") {
5727 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
5728 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
5731 // get data for the specified searchstring
5733 "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",
5735 dbesc('%'.$searchstring.'%')
5738 $profile_url = $user_info["url"];
5740 // message if nothing was found
5741 if (!DBM::is_result($r)) {
5742 $success = ['success' => false, 'search_results' => 'problem with query'];
5743 } elseif (count($r) == 0) {
5744 $success = ['success' => false, 'search_results' => 'nothing found'];
5747 foreach ($r as $item) {
5748 if ($box == "inbox" || $item['from-url'] != $profile_url) {
5749 $recipient = $user_info;
5750 $sender = api_get_user($a, normalise_link($item['contact-url']));
5751 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5752 $recipient = api_get_user($a, normalise_link($item['contact-url']));
5753 $sender = $user_info;
5756 if (isset($recipient) && isset($sender)) {
5757 $ret[] = api_format_messages($item, $recipient, $sender);
5760 $success = ['success' => true, 'search_results' => $ret];
5763 return api_format_data("direct_message_search", $type, ['$result' => $success]);
5766 /// @TODO move to top of file or somewhere better
5767 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5770 * @brief return data of all the profiles a user has to the client
5772 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5773 * @return string|array
5775 function api_friendica_profile_show($type)
5779 if (api_user() === false) {
5780 throw new ForbiddenException();
5784 $profile_id = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
5786 // retrieve general information about profiles for user
5787 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
5788 $directory = Config::get('system', 'directory');
5790 // get data of the specified profile id or all profiles of the user if not specified
5791 if ($profile_id != 0) {
5793 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
5798 // error message if specified gid is not in database
5799 if (!DBM::is_result($r)) {
5800 throw new BadRequestException("profile_id not available");
5804 "SELECT * FROM `profile` WHERE `uid` = %d",
5808 // loop through all returned profiles and retrieve data and users
5811 foreach ($r as $rr) {
5812 $profile = api_format_items_profiles($rr);
5814 // select all users from contact table, loop and prepare standard return for user data
5817 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
5819 intval($rr['profile_id'])
5822 foreach ($nurls as $nurl) {
5823 $user = api_get_user($a, $nurl['nurl']);
5824 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
5826 $profile['users'] = $users;
5828 // add prepared profile data to array for final return
5829 if ($type == "xml") {
5830 $profiles[$k++ . ":profile"] = $profile;
5832 $profiles[] = $profile;
5836 // return settings, authenticated user and profiles data
5837 $self = q("SELECT `nurl` FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
5839 $result = ['multi_profiles' => $multi_profiles ? true : false,
5840 'global_dir' => $directory,
5841 'friendica_owner' => api_get_user($a, $self[0]['nurl']),
5842 'profiles' => $profiles];
5843 return api_format_data("friendica_profiles", $type, ['$result' => $result]);
5845 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
5848 * Returns a list of saved searches.
5850 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5852 * @param string $type Return format: json or xml
5854 * @return string|array
5856 function api_saved_searches_list($type)
5858 $terms = dba::select('search', ['id', 'term'], ['uid' => local_user()]);
5861 while ($term = $terms->fetch()) {
5863 'created_at' => api_date(time()),
5864 'id' => intval($term['id']),
5865 'id_str' => $term['id'],
5866 'name' => $term['term'],
5868 'query' => $term['term']
5874 return api_format_data("terms", $type, ['terms' => $result]);
5877 /// @TODO move to top of file or somewhere better
5878 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5881 @TODO Maybe open to implement?
5883 [pagename] => api/1.1/statuses/lookup.json
5884 [id] => 605138389168451584
5885 [include_cards] => true
5886 [cards_platform] => Android-12
5887 [include_entities] => true
5888 [include_my_retweet] => 1
5890 [include_reply_count] => true
5891 [include_descendent_reply_count] => true
5895 Not implemented by now:
5896 statuses/retweets_of_me
5901 account/update_location
5902 account/update_profile_background_image
5905 friendica/profile/update
5906 friendica/profile/create
5907 friendica/profile/delete
5909 Not implemented in status.net:
5910 statuses/retweeted_to_me
5911 statuses/retweeted_by_me
5912 direct_messages/destroy
5914 account/update_delivery_device
5915 notifications/follow