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\BaseObject;
11 use Friendica\Content\ContactSelector;
12 use Friendica\Content\Feature;
13 use Friendica\Content\Text\BBCode;
14 use Friendica\Content\Text\HTML;
15 use Friendica\Core\Config;
16 use Friendica\Core\Hook;
17 use Friendica\Core\L10n;
18 use Friendica\Core\Logger;
19 use Friendica\Core\PConfig;
20 use Friendica\Core\Protocol;
21 use Friendica\Core\Session;
22 use Friendica\Core\System;
23 use Friendica\Core\Worker;
24 use Friendica\Database\DBA;
25 use Friendica\Model\Contact;
26 use Friendica\Model\Group;
27 use Friendica\Model\Item;
28 use Friendica\Model\Mail;
29 use Friendica\Model\Notify;
30 use Friendica\Model\Photo;
31 use Friendica\Model\Profile;
32 use Friendica\Model\User;
33 use Friendica\Network\FKOAuth1;
34 use Friendica\Network\HTTPException;
35 use Friendica\Network\HTTPException\BadRequestException;
36 use Friendica\Network\HTTPException\ExpectationFailedException;
37 use Friendica\Network\HTTPException\ForbiddenException;
38 use Friendica\Network\HTTPException\InternalServerErrorException;
39 use Friendica\Network\HTTPException\MethodNotAllowedException;
40 use Friendica\Network\HTTPException\NotFoundException;
41 use Friendica\Network\HTTPException\NotImplementedException;
42 use Friendica\Network\HTTPException\TooManyRequestsException;
43 use Friendica\Network\HTTPException\UnauthorizedException;
44 use Friendica\Object\Image;
45 use Friendica\Protocol\Activity;
46 use Friendica\Protocol\Diaspora;
47 use Friendica\Util\DateTimeFormat;
48 use Friendica\Util\Images;
49 use Friendica\Util\Network;
50 use Friendica\Util\Proxy as ProxyUtils;
51 use Friendica\Util\Strings;
52 use Friendica\Util\XML;
54 require_once __DIR__ . '/../mod/share.php';
55 require_once __DIR__ . '/../mod/item.php';
56 require_once __DIR__ . '/../mod/wall_upload.php';
58 define('API_METHOD_ANY', '*');
59 define('API_METHOD_GET', 'GET');
60 define('API_METHOD_POST', 'POST,PUT');
61 define('API_METHOD_DELETE', 'POST,DELETE');
63 define('API_LOG_PREFIX', 'API {action} - ');
69 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
70 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
71 * into a page, and visitors will post something without noticing it).
73 * @brief Auth API user
77 if (!empty($_SESSION['allow_api'])) {
85 * Clients can send 'source' parameter to be show in post metadata
86 * as "sent via <source>".
87 * Some clients doesn't send a source param, we support ones we know
90 * @brief Get source name from API client
93 * Client source name, default to "api" if unset/unknown
98 if (requestdata('source')) {
99 return requestdata('source');
102 // Support for known clients that doesn't send a source name
103 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
104 if(strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
108 Logger::info(API_LOG_PREFIX . 'Unrecognized user-agent', ['module' => 'api', 'action' => 'source', 'http_user_agent' => $_SERVER['HTTP_USER_AGENT']]);
110 Logger::info(API_LOG_PREFIX . 'Empty user-agent', ['module' => 'api', 'action' => 'source']);
117 * @brief Format date for API
119 * @param string $str Source date, as UTC
120 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
123 function api_date($str)
125 // Wed May 23 06:01:13 +0000 2007
126 return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
130 * Register a function to be the endpoint for defined API path.
132 * @brief Register API endpoint
134 * @param string $path API URL path, relative to System::baseUrl()
135 * @param string $func Function name to call on path request
136 * @param bool $auth API need logged user
137 * @param string $method HTTP method reqiured to call this endpoint.
138 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
139 * Default to API_METHOD_ANY
141 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
151 // Workaround for hotot
152 $path = str_replace("api/", "api/1.1/", $path);
162 * Log in user via OAuth1 or Simple HTTP Auth.
163 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
165 * @brief Login API user
168 * @throws ForbiddenException
169 * @throws InternalServerErrorException
170 * @throws UnauthorizedException
171 * @hook 'authenticate'
173 * 'username' => username from login form
174 * 'password' => password from login form
175 * 'authenticated' => return status,
176 * 'user_record' => return authenticated user record
178 function api_login(App $a)
180 $oauth1 = new FKOAuth1();
183 $request = OAuthRequest::from_request();
184 list($consumer, $token) = $oauth1->verify_request($request);
185 if (!is_null($token)) {
186 $oauth1->loginUser($token->uid);
187 Session::set('allow_api', true);
190 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
191 var_dump($consumer, $token);
193 } catch (Exception $e) {
194 Logger::warning(API_LOG_PREFIX . 'error', ['module' => 'api', 'action' => 'login', 'exception' => $e->getMessage()]);
197 // workaround for HTTP-auth in CGI mode
198 if (!empty($_SERVER['REDIRECT_REMOTE_USER'])) {
199 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6));
200 if (strlen($userpass)) {
201 list($name, $password) = explode(':', $userpass);
202 $_SERVER['PHP_AUTH_USER'] = $name;
203 $_SERVER['PHP_AUTH_PW'] = $password;
207 if (empty($_SERVER['PHP_AUTH_USER'])) {
208 Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]);
209 header('WWW-Authenticate: Basic realm="Friendica"');
210 throw new UnauthorizedException("This API requires login");
213 $user = $_SERVER['PHP_AUTH_USER'] ?? '';
214 $password = $_SERVER['PHP_AUTH_PW'] ?? '';
216 // allow "user@server" login (but ignore 'server' part)
217 $at = strstr($user, "@", true);
222 // next code from mod/auth.php. needs better solution
226 'username' => trim($user),
227 'password' => trim($password),
228 'authenticated' => 0,
229 'user_record' => null,
233 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
234 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
235 * and later addons should not interfere with an earlier one that succeeded.
237 Hook::callAll('authenticate', $addon_auth);
239 if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
240 $record = $addon_auth['user_record'];
242 $user_id = User::authenticate(trim($user), trim($password), true);
243 if ($user_id !== false) {
244 $record = DBA::selectFirst('user', [], ['uid' => $user_id]);
248 if (!DBA::isResult($record)) {
249 Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]);
250 header('WWW-Authenticate: Basic realm="Friendica"');
251 //header('HTTP/1.0 401 Unauthorized');
252 //die('This api requires login');
253 throw new UnauthorizedException("This API requires login");
256 Session::setAuthenticatedForUser($a, $record);
258 $_SESSION["allow_api"] = true;
260 Hook::callAll('logged_in', $a->user);
264 * API endpoints can define which HTTP method to accept when called.
265 * This function check the current HTTP method agains endpoint
268 * @brief Check HTTP method of called API
270 * @param string $method Required methods, uppercase, separated by comma
273 function api_check_method($method)
275 if ($method == "*") {
278 return (stripos($method, $_SERVER['REQUEST_METHOD'] ?? 'GET') !== false);
282 * Authenticate user, call registered API function, set HTTP headers
284 * @brief Main API entry point
287 * @return string|array API call result
290 function api_call(App $a)
292 global $API, $called_api;
295 if (strpos($a->query_string, ".xml") > 0) {
298 if (strpos($a->query_string, ".json") > 0) {
301 if (strpos($a->query_string, ".rss") > 0) {
304 if (strpos($a->query_string, ".atom") > 0) {
309 foreach ($API as $p => $info) {
310 if (strpos($a->query_string, $p) === 0) {
311 if (!api_check_method($info['method'])) {
312 throw new MethodNotAllowedException();
315 $called_api = explode("/", $p);
316 //unset($_SERVER['PHP_AUTH_USER']);
318 /// @TODO should be "true ==[=] $info['auth']", if you miss only one = character, you assign a variable (only with ==). Let's make all this even.
319 if (!empty($info['auth']) && api_user() === false) {
323 Logger::info(API_LOG_PREFIX . 'username {username}', ['module' => 'api', 'action' => 'call', 'username' => $a->user['username']]);
324 Logger::debug(API_LOG_PREFIX . 'parameters', ['module' => 'api', 'action' => 'call', 'parameters' => $_REQUEST]);
326 $stamp = microtime(true);
327 $return = call_user_func($info['func'], $type);
328 $duration = floatval(microtime(true) - $stamp);
330 Logger::info(API_LOG_PREFIX . 'username {username}', ['module' => 'api', 'action' => 'call', 'username' => $a->user['username'], 'duration' => round($duration, 2)]);
332 $a->getProfiler()->saveLog($a->getLogger(), API_LOG_PREFIX . 'performance');
334 if (false === $return) {
336 * api function returned false withour throw an
337 * exception. This should not happend, throw a 500
339 throw new InternalServerErrorException();
344 header("Content-Type: text/xml");
347 header("Content-Type: application/json");
348 if (!empty($return)) {
349 $json = json_encode(end($return));
350 if (!empty($_GET['callback'])) {
351 $json = $_GET['callback'] . "(" . $json . ")";
357 header("Content-Type: application/rss+xml");
358 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
361 header("Content-Type: application/atom+xml");
362 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
369 Logger::warning(API_LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => $a->query_string]);
370 throw new NotImplementedException();
371 } catch (HTTPException $e) {
372 header("HTTP/1.1 {$e->getCode()} {$e->httpdesc}");
373 return api_error($type, $e);
378 * @brief Format API error string
380 * @param string $type Return type (xml, json, rss, as)
381 * @param object $e HTTPException Error object
382 * @return string|array error message formatted as $type
384 function api_error($type, $e)
388 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
389 /// @TODO: https://dev.twitter.com/overview/api/response-codes
391 $error = ["error" => $error,
392 "code" => $e->getCode() . " " . $e->httpdesc,
393 "request" => $a->query_string];
395 $return = api_format_data('status', $type, ['status' => $error]);
399 header("Content-Type: text/xml");
402 header("Content-Type: application/json");
403 $return = json_encode($return);
406 header("Content-Type: application/rss+xml");
409 header("Content-Type: application/atom+xml");
417 * @brief Set values for RSS template
420 * @param array $arr Array to be passed to template
421 * @param array $user_info User info
423 * @throws BadRequestException
424 * @throws ImagickException
425 * @throws InternalServerErrorException
426 * @throws UnauthorizedException
427 * @todo find proper type-hints
429 function api_rss_extra(App $a, $arr, $user_info)
431 if (is_null($user_info)) {
432 $user_info = api_get_user($a);
435 $arr['$user'] = $user_info;
437 'alternate' => $user_info['url'],
438 'self' => System::baseUrl() . "/" . $a->query_string,
439 'base' => System::baseUrl(),
440 'updated' => api_date(null),
441 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
442 'language' => $user_info['lang'],
443 'logo' => System::baseUrl() . "/images/friendica-32.png",
451 * @brief Unique contact to contact url.
453 * @param int $id Contact id
454 * @return bool|string
455 * Contact url or False if contact id is unknown
458 function api_unique_id_to_nurl($id)
460 $r = DBA::selectFirst('contact', ['nurl'], ['id' => $id]);
462 if (DBA::isResult($r)) {
470 * @brief Get user info array.
473 * @param int|string $contact_id Contact ID or URL
475 * @throws BadRequestException
476 * @throws ImagickException
477 * @throws InternalServerErrorException
478 * @throws UnauthorizedException
480 function api_get_user(App $a, $contact_id = null)
488 Logger::info(API_LOG_PREFIX . 'Fetching data for user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $contact_id]);
490 // Searching for contact URL
491 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
492 $user = DBA::escape(Strings::normaliseLink($contact_id));
494 $extra_query = "AND `contact`.`nurl` = '%s' ";
495 if (api_user() !== false) {
496 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
500 // Searching for contact id with uid = 0
501 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
502 $user = DBA::escape(api_unique_id_to_nurl(intval($contact_id)));
505 throw new BadRequestException("User ID ".$contact_id." not found.");
509 $extra_query = "AND `contact`.`nurl` = '%s' ";
510 if (api_user() !== false) {
511 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
515 if (is_null($user) && !empty($_GET['user_id'])) {
516 $user = DBA::escape(api_unique_id_to_nurl($_GET['user_id']));
519 throw new BadRequestException("User ID ".$_GET['user_id']." not found.");
523 $extra_query = "AND `contact`.`nurl` = '%s' ";
524 if (api_user() !== false) {
525 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
528 if (is_null($user) && !empty($_GET['screen_name'])) {
529 $user = DBA::escape($_GET['screen_name']);
530 $extra_query = "AND `contact`.`nick` = '%s' ";
531 if (api_user() !== false) {
532 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
536 if (is_null($user) && !empty($_GET['profileurl'])) {
537 $user = DBA::escape(Strings::normaliseLink($_GET['profileurl']));
538 $extra_query = "AND `contact`.`nurl` = '%s' ";
539 if (api_user() !== false) {
540 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
544 // $called_api is the API path exploded on / and is expected to have at least 2 elements
545 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
546 $argid = count($called_api);
547 if (!empty($a->argv[$argid])) {
548 $data = explode(".", $a->argv[$argid]);
549 if (count($data) > 1) {
550 list($user, $null) = $data;
553 if (is_numeric($user)) {
554 $user = DBA::escape(api_unique_id_to_nurl(intval($user)));
558 $extra_query = "AND `contact`.`nurl` = '%s' ";
559 if (api_user() !== false) {
560 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
564 $user = DBA::escape($user);
565 $extra_query = "AND `contact`.`nick` = '%s' ";
566 if (api_user() !== false) {
567 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
572 Logger::info(API_LOG_PREFIX . 'getting user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user]);
575 if (api_user() === false) {
579 $user = $_SESSION['uid'];
580 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
584 Logger::info(API_LOG_PREFIX . 'found user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user, 'extra_query' => $extra_query]);
588 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
594 // Selecting the id by priority, friendica first
595 if (is_array($uinfo)) {
596 api_best_nickname($uinfo);
599 // if the contact wasn't found, fetch it from the contacts with uid = 0
600 if (!DBA::isResult($uinfo)) {
602 throw new BadRequestException("User not found.");
605 $contact = DBA::selectFirst('contact', [], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
607 if (DBA::isResult($contact)) {
608 // If no nick where given, extract it from the address
609 if (($contact['nick'] == "") || ($contact['name'] == $contact['nick'])) {
610 $contact['nick'] = api_get_nick($contact["url"]);
614 'id' => $contact["id"],
615 'id_str' => (string) $contact["id"],
616 'name' => $contact["name"],
617 'screen_name' => (($contact['nick']) ? $contact['nick'] : $contact['name']),
618 'location' => ($contact["location"] != "") ? $contact["location"] : ContactSelector::networkToName($contact['network'], $contact['url']),
619 'description' => BBCode::toPlaintext($contact["about"]),
620 'profile_image_url' => $contact["micro"],
621 'profile_image_url_https' => $contact["micro"],
622 'profile_image_url_profile_size' => $contact["thumb"],
623 'profile_image_url_large' => $contact["photo"],
624 'url' => $contact["url"],
625 'protected' => false,
626 'followers_count' => 0,
627 'friends_count' => 0,
629 'created_at' => api_date($contact["created"]),
630 'favourites_count' => 0,
632 'time_zone' => 'UTC',
633 'geo_enabled' => false,
635 'statuses_count' => 0,
637 'contributors_enabled' => false,
638 'is_translator' => false,
639 'is_translation_enabled' => false,
640 'following' => false,
641 'follow_request_sent' => false,
642 'statusnet_blocking' => false,
643 'notifications' => false,
644 'statusnet_profile_url' => $contact["url"],
646 'cid' => Contact::getIdForURL($contact["url"], api_user(), true),
647 'pid' => Contact::getIdForURL($contact["url"], 0, true),
649 'network' => $contact["network"],
654 throw new BadRequestException("User ".$url." not found.");
658 if ($uinfo[0]['self']) {
659 if ($uinfo[0]['network'] == "") {
660 $uinfo[0]['network'] = Protocol::DFRN;
663 $usr = DBA::selectFirst('user', ['default-location'], ['uid' => api_user()]);
664 $profile = DBA::selectFirst('profile', ['about'], ['uid' => api_user(), 'is-default' => true]);
671 // Add a nick if it isn't present there
672 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
673 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
676 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
678 if (!empty($profile['about'])) {
679 $description = $profile['about'];
681 $description = $uinfo[0]["about"];
684 if (!empty($usr['default-location'])) {
685 $location = $usr['default-location'];
686 } elseif (!empty($uinfo[0]["location"])) {
687 $location = $uinfo[0]["location"];
689 $location = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
693 'id' => intval($pcontact_id),
694 'id_str' => (string) intval($pcontact_id),
695 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
696 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
697 'location' => $location,
698 'description' => BBCode::toPlaintext($description),
699 'profile_image_url' => $uinfo[0]['micro'],
700 'profile_image_url_https' => $uinfo[0]['micro'],
701 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
702 'profile_image_url_large' => $uinfo[0]["photo"],
703 'url' => $uinfo[0]['url'],
704 'protected' => false,
705 'followers_count' => intval($countfollowers),
706 'friends_count' => intval($countfriends),
708 'created_at' => api_date($uinfo[0]['created']),
709 'favourites_count' => intval($starred),
711 'time_zone' => 'UTC',
712 'geo_enabled' => false,
714 'statuses_count' => intval($countitems),
716 'contributors_enabled' => false,
717 'is_translator' => false,
718 'is_translation_enabled' => false,
719 'following' => (($uinfo[0]['rel'] == Contact::FOLLOWER) || ($uinfo[0]['rel'] == Contact::FRIEND)),
720 'follow_request_sent' => false,
721 'statusnet_blocking' => false,
722 'notifications' => false,
724 //'statusnet_profile_url' => System::baseUrl()."/contact/".$uinfo[0]['cid'],
725 'statusnet_profile_url' => $uinfo[0]['url'],
726 'uid' => intval($uinfo[0]['uid']),
727 'cid' => intval($uinfo[0]['cid']),
728 'pid' => Contact::getIdForURL($uinfo[0]["url"], 0, true),
729 'self' => $uinfo[0]['self'],
730 'network' => $uinfo[0]['network'],
733 // If this is a local user and it uses Frio, we can get its color preferences.
735 $theme_info = DBA::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
736 if ($theme_info['theme'] === 'frio') {
737 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
739 if ($schema && ($schema != '---')) {
740 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
741 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
742 require_once $schemefile;
745 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
746 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
747 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
749 if (empty($nav_bg)) {
752 if (empty($link_color)) {
753 $link_color = "#6fdbe8";
755 if (empty($bgcolor)) {
756 $bgcolor = "#ededed";
759 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
760 $ret['profile_link_color'] = str_replace('#', '', $link_color);
761 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
769 * @brief return api-formatted array for item's author and owner
772 * @param array $item item from db
773 * @return array(array:author, array:owner)
774 * @throws BadRequestException
775 * @throws ImagickException
776 * @throws InternalServerErrorException
777 * @throws UnauthorizedException
779 function api_item_get_user(App $a, $item)
781 $status_user = api_get_user($a, $item['author-id'] ?? null);
783 $author_user = $status_user;
785 $status_user["protected"] = $item['private'] ?? 0;
787 if (($item['thr-parent'] ?? '') == ($item['uri'] ?? '')) {
788 $owner_user = api_get_user($a, $item['owner-id'] ?? null);
790 $owner_user = $author_user;
793 return ([$status_user, $author_user, $owner_user]);
797 * @brief walks recursively through an array with the possibility to change value and key
799 * @param array $array The array to walk through
800 * @param callable $callback The callback function
802 * @return array the transformed array
804 function api_walk_recursive(array &$array, callable $callback)
808 foreach ($array as $k => $v) {
810 if ($callback($v, $k)) {
811 $new_array[$k] = api_walk_recursive($v, $callback);
814 if ($callback($v, $k)) {
825 * @brief Callback function to transform the array in an array that can be transformed in a XML file
827 * @param mixed $item Array item value
828 * @param string $key Array key
830 * @return boolean Should the array item be deleted?
832 function api_reformat_xml(&$item, &$key)
834 if (is_bool($item)) {
835 $item = ($item ? "true" : "false");
838 if (substr($key, 0, 10) == "statusnet_") {
839 $key = "statusnet:".substr($key, 10);
840 } elseif (substr($key, 0, 10) == "friendica_") {
841 $key = "friendica:".substr($key, 10);
843 /// @TODO old-lost code?
845 // $key = "default:".$key;
851 * @brief Creates the XML from a JSON style array
853 * @param array $data JSON style array
854 * @param string $root_element Name of the root element
856 * @return string The XML data
858 function api_create_xml(array $data, $root_element)
860 $childname = key($data);
861 $data2 = array_pop($data);
863 $namespaces = ["" => "http://api.twitter.com",
864 "statusnet" => "http://status.net/schema/api/1/",
865 "friendica" => "http://friendi.ca/schema/api/1/",
866 "georss" => "http://www.georss.org/georss"];
868 /// @todo Auto detection of needed namespaces
869 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
873 if (is_array($data2)) {
875 api_walk_recursive($data2, "api_reformat_xml");
881 foreach ($data2 as $item) {
882 $data4[$i++ . ":" . $childname] = $item;
889 $data3 = [$root_element => $data2];
891 $ret = XML::fromArray($data3, $xml, false, $namespaces);
896 * @brief Formats the data according to the data type
898 * @param string $root_element Name of the root element
899 * @param string $type Return type (atom, rss, xml, json)
900 * @param array $data JSON style array
902 * @return array|string (string|array) XML data or JSON data
904 function api_format_data($root_element, $type, $data)
910 $ret = api_create_xml($data, $root_element);
925 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
926 * returns a 401 status code and an error message if not.
928 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
930 * @param string $type Return type (atom, rss, xml, json)
931 * @return array|string
932 * @throws BadRequestException
933 * @throws ForbiddenException
934 * @throws ImagickException
935 * @throws InternalServerErrorException
936 * @throws UnauthorizedException
938 function api_account_verify_credentials($type)
942 if (api_user() === false) {
943 throw new ForbiddenException();
946 unset($_REQUEST["user_id"]);
947 unset($_GET["user_id"]);
949 unset($_REQUEST["screen_name"]);
950 unset($_GET["screen_name"]);
952 $skip_status = $_REQUEST['skip_status'] ?? false;
954 $user_info = api_get_user($a);
956 // "verified" isn't used here in the standard
957 unset($user_info["verified"]);
959 // - Adding last status
961 $item = api_get_last_status($user_info['pid'], $user_info['uid']);
963 $user_info['status'] = api_format_item($item, $type);
967 // "uid" and "self" are only needed for some internal stuff, so remove it from here
968 unset($user_info["uid"]);
969 unset($user_info["self"]);
971 return api_format_data("user", $type, ['user' => $user_info]);
974 /// @TODO move to top of file or somewhere better
975 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
978 * Get data from $_POST or $_GET
983 function requestdata($k)
985 if (!empty($_POST[$k])) {
988 if (!empty($_GET[$k])) {
995 * Deprecated function to upload media.
997 * @param string $type Return type (atom, rss, xml, json)
999 * @return array|string
1000 * @throws BadRequestException
1001 * @throws ForbiddenException
1002 * @throws ImagickException
1003 * @throws InternalServerErrorException
1004 * @throws UnauthorizedException
1006 function api_statuses_mediap($type)
1010 if (api_user() === false) {
1011 Logger::log('api_statuses_update: no user');
1012 throw new ForbiddenException();
1014 $user_info = api_get_user($a);
1016 $_REQUEST['profile_uid'] = api_user();
1017 $_REQUEST['api_source'] = true;
1018 $txt = requestdata('status');
1019 /// @TODO old-lost code?
1020 //$txt = urldecode(requestdata('status'));
1022 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1023 $txt = HTML::toBBCodeVideo($txt);
1024 $config = HTMLPurifier_Config::createDefault();
1025 $config->set('Cache.DefinitionImpl', null);
1026 $purifier = new HTMLPurifier($config);
1027 $txt = $purifier->purify($txt);
1029 $txt = HTML::toBBCode($txt);
1031 $a->argv[1] = $user_info['screen_name']; //should be set to username?
1033 $picture = wall_upload_post($a, false);
1035 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1036 $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1037 $item_id = item_post($a);
1039 // output the post that we just posted.
1040 return api_status_show($type, $item_id);
1043 /// @TODO move this to top of file or somewhere better!
1044 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1047 * Updates the user’s current status.
1049 * @param string $type Return type (atom, rss, xml, json)
1051 * @return array|string
1052 * @throws BadRequestException
1053 * @throws ForbiddenException
1054 * @throws ImagickException
1055 * @throws InternalServerErrorException
1056 * @throws TooManyRequestsException
1057 * @throws UnauthorizedException
1058 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1060 function api_statuses_update($type)
1064 if (api_user() === false) {
1065 Logger::log('api_statuses_update: no user');
1066 throw new ForbiddenException();
1071 // convert $_POST array items to the form we use for web posts.
1072 if (requestdata('htmlstatus')) {
1073 $txt = requestdata('htmlstatus');
1074 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1075 $txt = HTML::toBBCodeVideo($txt);
1077 $config = HTMLPurifier_Config::createDefault();
1078 $config->set('Cache.DefinitionImpl', null);
1080 $purifier = new HTMLPurifier($config);
1081 $txt = $purifier->purify($txt);
1083 $_REQUEST['body'] = HTML::toBBCode($txt);
1086 $_REQUEST['body'] = requestdata('status');
1089 $_REQUEST['title'] = requestdata('title');
1091 $parent = requestdata('in_reply_to_status_id');
1093 // Twidere sends "-1" if it is no reply ...
1094 if ($parent == -1) {
1098 if (ctype_digit($parent)) {
1099 $_REQUEST['parent'] = $parent;
1101 $_REQUEST['parent_uri'] = $parent;
1104 if (requestdata('lat') && requestdata('long')) {
1105 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1107 $_REQUEST['profile_uid'] = api_user();
1110 // Check for throttling (maximum posts per day, week and month)
1111 $throttle_day = Config::get('system', 'throttle_limit_day');
1112 if ($throttle_day > 0) {
1113 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1115 $condition = ["`uid` = ? AND `wall` AND `received` > ?", api_user(), $datefrom];
1116 $posts_day = DBA::count('thread', $condition);
1118 if ($posts_day > $throttle_day) {
1119 Logger::log('Daily posting limit reached for user '.api_user(), Logger::DEBUG);
1120 // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1121 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));
1125 $throttle_week = Config::get('system', 'throttle_limit_week');
1126 if ($throttle_week > 0) {
1127 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1129 $condition = ["`uid` = ? AND `wall` AND `received` > ?", api_user(), $datefrom];
1130 $posts_week = DBA::count('thread', $condition);
1132 if ($posts_week > $throttle_week) {
1133 Logger::log('Weekly posting limit reached for user '.api_user(), Logger::DEBUG);
1134 // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1135 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));
1139 $throttle_month = Config::get('system', 'throttle_limit_month');
1140 if ($throttle_month > 0) {
1141 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1143 $condition = ["`uid` = ? AND `wall` AND `received` > ?", api_user(), $datefrom];
1144 $posts_month = DBA::count('thread', $condition);
1146 if ($posts_month > $throttle_month) {
1147 Logger::log('Monthly posting limit reached for user '.api_user(), Logger::DEBUG);
1148 // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1149 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));
1154 if (!empty($_FILES['media'])) {
1155 // upload the image if we have one
1156 $picture = wall_upload_post($a, false);
1157 if (is_array($picture)) {
1158 $_REQUEST['body'] .= "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1162 if (requestdata('media_ids')) {
1163 $ids = explode(',', requestdata('media_ids'));
1164 foreach ($ids as $id) {
1166 "SELECT `resource-id`, `scale`, `nickname`, `type`, `desc` 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",
1170 if (DBA::isResult($r)) {
1171 $phototypes = Images::supportedTypes();
1172 $ext = $phototypes[$r[0]['type']];
1173 $description = $r[0]['desc'] ?? '';
1174 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1175 $_REQUEST['body'] .= '[img=' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . ']' . $description . '[/img][/url]';
1180 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1182 $_REQUEST['api_source'] = true;
1184 if (empty($_REQUEST['source'])) {
1185 $_REQUEST["source"] = api_source();
1188 // call out normal post function
1189 $item_id = item_post($a);
1191 // output the post that we just posted.
1192 return api_status_show($type, $item_id);
1195 /// @TODO move to top of file or somewhere better
1196 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1197 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1200 * Uploads an image to Friendica.
1203 * @throws BadRequestException
1204 * @throws ForbiddenException
1205 * @throws ImagickException
1206 * @throws InternalServerErrorException
1207 * @throws UnauthorizedException
1208 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1210 function api_media_upload()
1214 if (api_user() === false) {
1215 Logger::log('no user');
1216 throw new ForbiddenException();
1221 if (empty($_FILES['media'])) {
1223 throw new BadRequestException("No media.");
1226 $media = wall_upload_post($a, false);
1229 throw new InternalServerErrorException();
1233 $returndata["media_id"] = $media["id"];
1234 $returndata["media_id_string"] = (string)$media["id"];
1235 $returndata["size"] = $media["size"];
1236 $returndata["image"] = ["w" => $media["width"],
1237 "h" => $media["height"],
1238 "image_type" => $media["type"],
1239 "friendica_preview_url" => $media["preview"]];
1241 Logger::log("Media uploaded: " . print_r($returndata, true), Logger::DEBUG);
1243 return ["media" => $returndata];
1246 /// @TODO move to top of file or somewhere better
1247 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1250 * Updates media meta data (picture descriptions)
1252 * @param string $type Return type (atom, rss, xml, json)
1254 * @return array|string
1255 * @throws BadRequestException
1256 * @throws ForbiddenException
1257 * @throws ImagickException
1258 * @throws InternalServerErrorException
1259 * @throws TooManyRequestsException
1260 * @throws UnauthorizedException
1261 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1263 * @todo Compare the corresponding Twitter function for correct return values
1265 function api_media_metadata_create($type)
1269 if (api_user() === false) {
1270 Logger::info('no user');
1271 throw new ForbiddenException();
1276 $postdata = Network::postdata();
1278 if (empty($postdata)) {
1279 throw new BadRequestException("No post data");
1282 $data = json_decode($postdata, true);
1284 throw new BadRequestException("Invalid post data");
1287 if (empty($data['media_id']) || empty($data['alt_text'])) {
1288 throw new BadRequestException("Missing post data values");
1291 if (empty($data['alt_text']['text'])) {
1292 throw new BadRequestException("No alt text.");
1295 Logger::info('Updating metadata', ['media_id' => $data['media_id']]);
1297 $condition = ['id' => $data['media_id'], 'uid' => api_user()];
1298 $photo = DBA::selectFirst('photo', ['resource-id'], $condition);
1299 if (!DBA::isResult($photo)) {
1300 throw new BadRequestException("Metadata not found.");
1303 DBA::update('photo', ['desc' => $data['alt_text']['text']], ['resource-id' => $photo['resource-id']]);
1306 api_register_func('api/media/metadata/create', 'api_media_metadata_create', true, API_METHOD_POST);
1309 * @param string $type Return format (atom, rss, xml, json)
1310 * @param int $item_id
1314 function api_status_show($type, $item_id)
1316 Logger::info(API_LOG_PREFIX . 'Start', ['action' => 'status_show', 'type' => $type, 'item_id' => $item_id]);
1320 $item = api_get_item(['id' => $item_id]);
1321 if (!empty($item)) {
1322 $status_info = api_format_item($item, $type);
1325 Logger::info(API_LOG_PREFIX . 'End', ['action' => 'get_status', 'status_info' => $status_info]);
1327 return api_format_data('statuses', $type, ['status' => $status_info]);
1331 * Retrieves the last public status of the provided user info
1333 * @param int $ownerId Public contact Id
1334 * @param int $uid User Id
1338 function api_get_last_status($ownerId, $uid)
1341 'author-id'=> $ownerId,
1343 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT],
1347 $item = api_get_item($condition);
1353 * Retrieves a single item record based on the provided condition and converts it for API use.
1355 * @param array $condition Item table condition array
1359 function api_get_item(array $condition)
1361 $item = Item::selectFirst(Item::DISPLAY_FIELDLIST, $condition, ['order' => ['id' => true]]);
1367 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1368 * The author's most recent status will be returned inline.
1370 * @param string $type Return type (atom, rss, xml, json)
1371 * @return array|string
1372 * @throws BadRequestException
1373 * @throws ImagickException
1374 * @throws InternalServerErrorException
1375 * @throws UnauthorizedException
1376 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1378 function api_users_show($type)
1380 $a = BaseObject::getApp();
1382 $user_info = api_get_user($a);
1384 $item = api_get_last_status($user_info['pid'], $user_info['uid']);
1385 if (!empty($item)) {
1386 $user_info['status'] = api_format_item($item, $type);
1389 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1390 unset($user_info['uid']);
1391 unset($user_info['self']);
1393 return api_format_data('user', $type, ['user' => $user_info]);
1396 /// @TODO move to top of file or somewhere better
1397 api_register_func('api/users/show', 'api_users_show');
1398 api_register_func('api/externalprofile/show', 'api_users_show');
1401 * Search a public user account.
1403 * @param string $type Return type (atom, rss, xml, json)
1405 * @return array|string
1406 * @throws BadRequestException
1407 * @throws ImagickException
1408 * @throws InternalServerErrorException
1409 * @throws UnauthorizedException
1410 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1412 function api_users_search($type)
1418 if (!empty($_GET['q'])) {
1419 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", DBA::escape($_GET["q"]));
1421 if (!DBA::isResult($r)) {
1422 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", DBA::escape($_GET["q"]));
1425 if (DBA::isResult($r)) {
1427 foreach ($r as $user) {
1428 $user_info = api_get_user($a, $user["id"]);
1430 if ($type == "xml") {
1431 $userlist[$k++.":user"] = $user_info;
1433 $userlist[] = $user_info;
1436 $userlist = ["users" => $userlist];
1438 throw new BadRequestException("User ".$_GET["q"]." not found.");
1441 throw new BadRequestException("No user specified.");
1444 return api_format_data("users", $type, $userlist);
1447 /// @TODO move to top of file or somewhere better
1448 api_register_func('api/users/search', 'api_users_search');
1451 * Return user objects
1453 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1455 * @param string $type Return format: json or xml
1457 * @return array|string
1458 * @throws BadRequestException
1459 * @throws ImagickException
1460 * @throws InternalServerErrorException
1461 * @throws NotFoundException if the results are empty.
1462 * @throws UnauthorizedException
1464 function api_users_lookup($type)
1468 if (!empty($_REQUEST['user_id'])) {
1469 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1471 $users[] = api_get_user(get_app(), $id);
1476 if (empty($users)) {
1477 throw new NotFoundException;
1480 return api_format_data("users", $type, ['users' => $users]);
1483 /// @TODO move to top of file or somewhere better
1484 api_register_func('api/users/lookup', 'api_users_lookup', true);
1487 * Returns statuses that match a specified query.
1489 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1491 * @param string $type Return format: json, xml, atom, rss
1493 * @return array|string
1494 * @throws BadRequestException if the "q" parameter is missing.
1495 * @throws ForbiddenException
1496 * @throws ImagickException
1497 * @throws InternalServerErrorException
1498 * @throws UnauthorizedException
1500 function api_search($type)
1503 $user_info = api_get_user($a);
1505 if (api_user() === false || $user_info === false) { throw new ForbiddenException(); }
1507 if (empty($_REQUEST['q'])) {
1508 throw new BadRequestException('q parameter is required.');
1511 $searchTerm = trim(rawurldecode($_REQUEST['q']));
1514 $data['status'] = [];
1516 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1517 if (!empty($_REQUEST['rpp'])) {
1518 $count = $_REQUEST['rpp'];
1519 } elseif (!empty($_REQUEST['count'])) {
1520 $count = $_REQUEST['count'];
1523 $since_id = $_REQUEST['since_id'] ?? 0;
1524 $max_id = $_REQUEST['max_id'] ?? 0;
1525 $page = $_REQUEST['page'] ?? 1;
1527 $start = max(0, ($page - 1) * $count);
1529 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1530 if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) {
1531 $searchTerm = $matches[1];
1532 $condition = ["`oid` > ?
1533 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1534 AND `otype` = ? AND `type` = ? AND `term` = ?",
1535 $since_id, local_user(), TERM_OBJ_POST, TERM_HASHTAG, $searchTerm];
1537 $condition[0] .= ' AND `oid` <= ?';
1538 $condition[] = $max_id;
1540 $terms = DBA::select('term', ['oid'], $condition, []);
1542 while ($term = DBA::fetch($terms)) {
1543 $itemIds[] = $term['oid'];
1547 if (empty($itemIds)) {
1548 return api_format_data('statuses', $type, $data);
1551 $preCondition = ['`id` IN (' . implode(', ', $itemIds) . ')'];
1552 if ($exclude_replies) {
1553 $preCondition[] = '`id` = `parent`';
1556 $condition = [implode(' AND ', $preCondition)];
1558 $condition = ["`id` > ?
1559 " . ($exclude_replies ? " AND `id` = `parent` " : ' ') . "
1560 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1561 AND `body` LIKE CONCAT('%',?,'%')",
1562 $since_id, api_user(), $_REQUEST['q']];
1564 $condition[0] .= ' AND `id` <= ?';
1565 $condition[] = $max_id;
1569 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1571 $data['status'] = api_format_items(Item::inArray($statuses), $user_info);
1573 bindComments($data['status']);
1575 return api_format_data('statuses', $type, $data);
1578 /// @TODO move to top of file or somewhere better
1579 api_register_func('api/search/tweets', 'api_search', true);
1580 api_register_func('api/search', 'api_search', true);
1583 * Returns the most recent statuses posted by the user and the users they follow.
1585 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1587 * @param string $type Return type (atom, rss, xml, json)
1589 * @return array|string
1590 * @throws BadRequestException
1591 * @throws ForbiddenException
1592 * @throws ImagickException
1593 * @throws InternalServerErrorException
1594 * @throws UnauthorizedException
1595 * @todo Optional parameters
1596 * @todo Add reply info
1598 function api_statuses_home_timeline($type)
1601 $user_info = api_get_user($a);
1603 if (api_user() === false || $user_info === false) {
1604 throw new ForbiddenException();
1607 unset($_REQUEST["user_id"]);
1608 unset($_GET["user_id"]);
1610 unset($_REQUEST["screen_name"]);
1611 unset($_GET["screen_name"]);
1613 // get last network messages
1616 $count = $_REQUEST['count'] ?? 20;
1617 $page = $_REQUEST['page']?? 0;
1618 $since_id = $_REQUEST['since_id'] ?? 0;
1619 $max_id = $_REQUEST['max_id'] ?? 0;
1620 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1621 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1623 $start = max(0, ($page - 1) * $count);
1625 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1626 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1629 $condition[0] .= " AND `item`.`id` <= ?";
1630 $condition[] = $max_id;
1632 if ($exclude_replies) {
1633 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
1635 if ($conversation_id > 0) {
1636 $condition[0] .= " AND `item`.`parent` = ?";
1637 $condition[] = $conversation_id;
1640 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1641 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1643 $items = Item::inArray($statuses);
1645 $ret = api_format_items($items, $user_info, false, $type);
1647 // Set all posts from the query above to seen
1649 foreach ($items as $item) {
1650 $idarray[] = intval($item["id"]);
1653 if (!empty($idarray)) {
1654 $unseen = Item::exists(['unseen' => true, 'id' => $idarray]);
1656 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1662 $data = ['status' => $ret];
1667 $data = api_rss_extra($a, $data, $user_info);
1671 return api_format_data("statuses", $type, $data);
1675 /// @TODO move to top of file or somewhere better
1676 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1677 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1680 * Returns the most recent statuses from public users.
1682 * @param string $type Return type (atom, rss, xml, json)
1684 * @return array|string
1685 * @throws BadRequestException
1686 * @throws ForbiddenException
1687 * @throws ImagickException
1688 * @throws InternalServerErrorException
1689 * @throws UnauthorizedException
1691 function api_statuses_public_timeline($type)
1694 $user_info = api_get_user($a);
1696 if (api_user() === false || $user_info === false) {
1697 throw new ForbiddenException();
1700 // get last network messages
1703 $count = $_REQUEST['count'] ?? 20;
1704 $page = $_REQUEST['page'] ?? 1;
1705 $since_id = $_REQUEST['since_id'] ?? 0;
1706 $max_id = $_REQUEST['max_id'] ?? 0;
1707 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
1708 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1710 $start = max(0, ($page - 1) * $count);
1712 if ($exclude_replies && !$conversation_id) {
1713 $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND NOT `author`.`hidden`",
1714 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1717 $condition[0] .= " AND `thread`.`iid` <= ?";
1718 $condition[] = $max_id;
1721 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1722 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1724 $r = Item::inArray($statuses);
1726 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND `item`.`origin` AND NOT `author`.`hidden`",
1727 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1730 $condition[0] .= " AND `item`.`id` <= ?";
1731 $condition[] = $max_id;
1733 if ($conversation_id > 0) {
1734 $condition[0] .= " AND `item`.`parent` = ?";
1735 $condition[] = $conversation_id;
1738 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1739 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1741 $r = Item::inArray($statuses);
1744 $ret = api_format_items($r, $user_info, false, $type);
1748 $data = ['status' => $ret];
1753 $data = api_rss_extra($a, $data, $user_info);
1757 return api_format_data("statuses", $type, $data);
1760 /// @TODO move to top of file or somewhere better
1761 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1764 * Returns the most recent statuses posted by users this node knows about.
1766 * @brief Returns the list of public federated posts this node knows about
1768 * @param string $type Return format: json, xml, atom, rss
1769 * @return array|string
1770 * @throws BadRequestException
1771 * @throws ForbiddenException
1772 * @throws ImagickException
1773 * @throws InternalServerErrorException
1774 * @throws UnauthorizedException
1776 function api_statuses_networkpublic_timeline($type)
1779 $user_info = api_get_user($a);
1781 if (api_user() === false || $user_info === false) {
1782 throw new ForbiddenException();
1785 $since_id = $_REQUEST['since_id'] ?? 0;
1786 $max_id = $_REQUEST['max_id'] ?? 0;
1789 $count = $_REQUEST['count'] ?? 20;
1790 $page = $_REQUEST['page'] ?? 1;
1792 $start = max(0, ($page - 1) * $count);
1794 $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `thread`.`iid` > ? AND NOT `private`",
1795 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1798 $condition[0] .= " AND `thread`.`iid` <= ?";
1799 $condition[] = $max_id;
1802 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1803 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1805 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1809 $data = ['status' => $ret];
1814 $data = api_rss_extra($a, $data, $user_info);
1818 return api_format_data("statuses", $type, $data);
1821 /// @TODO move to top of file or somewhere better
1822 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1825 * Returns a single status.
1827 * @param string $type Return type (atom, rss, xml, json)
1829 * @return array|string
1830 * @throws BadRequestException
1831 * @throws ForbiddenException
1832 * @throws ImagickException
1833 * @throws InternalServerErrorException
1834 * @throws UnauthorizedException
1835 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1837 function api_statuses_show($type)
1840 $user_info = api_get_user($a);
1842 if (api_user() === false || $user_info === false) {
1843 throw new ForbiddenException();
1847 $id = intval($a->argv[3] ?? 0);
1850 $id = intval($_REQUEST['id'] ?? 0);
1855 $id = intval($a->argv[4] ?? 0);
1858 Logger::log('API: api_statuses_show: ' . $id);
1860 $conversation = !empty($_REQUEST['conversation']);
1862 // try to fetch the item for the local user - or the public item, if there is no local one
1863 $uri_item = Item::selectFirst(['uri'], ['id' => $id]);
1864 if (!DBA::isResult($uri_item)) {
1865 throw new BadRequestException("There is no status with this id.");
1868 $item = Item::selectFirst(['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1869 if (!DBA::isResult($item)) {
1870 throw new BadRequestException("There is no status with this id.");
1875 if ($conversation) {
1876 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1877 $params = ['order' => ['id' => true]];
1879 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1883 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1885 /// @TODO How about copying this to above methods which don't check $r ?
1886 if (!DBA::isResult($statuses)) {
1887 throw new BadRequestException("There is no status with this id.");
1890 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1892 if ($conversation) {
1893 $data = ['status' => $ret];
1894 return api_format_data("statuses", $type, $data);
1896 $data = ['status' => $ret[0]];
1897 return api_format_data("status", $type, $data);
1901 /// @TODO move to top of file or somewhere better
1902 api_register_func('api/statuses/show', 'api_statuses_show', true);
1906 * @param string $type Return type (atom, rss, xml, json)
1908 * @return array|string
1909 * @throws BadRequestException
1910 * @throws ForbiddenException
1911 * @throws ImagickException
1912 * @throws InternalServerErrorException
1913 * @throws UnauthorizedException
1914 * @todo nothing to say?
1916 function api_conversation_show($type)
1919 $user_info = api_get_user($a);
1921 if (api_user() === false || $user_info === false) {
1922 throw new ForbiddenException();
1926 $id = intval($a->argv[3] ?? 0);
1927 $since_id = intval($_REQUEST['since_id'] ?? 0);
1928 $max_id = intval($_REQUEST['max_id'] ?? 0);
1929 $count = intval($_REQUEST['count'] ?? 20);
1930 $page = intval($_REQUEST['page'] ?? 1);
1932 $start = max(0, ($page - 1) * $count);
1935 $id = intval($_REQUEST['id'] ?? 0);
1940 $id = intval($a->argv[4] ?? 0);
1943 Logger::info(API_LOG_PREFIX . '{subaction}', ['module' => 'api', 'action' => 'conversation', 'subaction' => 'show', 'id' => $id]);
1945 // try to fetch the item for the local user - or the public item, if there is no local one
1946 $item = Item::selectFirst(['parent-uri'], ['id' => $id]);
1947 if (!DBA::isResult($item)) {
1948 throw new BadRequestException("There is no status with this id.");
1951 $parent = Item::selectFirst(['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1952 if (!DBA::isResult($parent)) {
1953 throw new BadRequestException("There is no status with this id.");
1956 $id = $parent['id'];
1958 $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1959 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1962 $condition[0] .= " AND `item`.`id` <= ?";
1963 $condition[] = $max_id;
1966 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1967 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1969 if (!DBA::isResult($statuses)) {
1970 throw new BadRequestException("There is no status with id $id.");
1973 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1975 $data = ['status' => $ret];
1976 return api_format_data("statuses", $type, $data);
1979 /// @TODO move to top of file or somewhere better
1980 api_register_func('api/conversation/show', 'api_conversation_show', true);
1981 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
1986 * @param string $type Return type (atom, rss, xml, json)
1988 * @return array|string
1989 * @throws BadRequestException
1990 * @throws ForbiddenException
1991 * @throws ImagickException
1992 * @throws InternalServerErrorException
1993 * @throws UnauthorizedException
1994 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
1996 function api_statuses_repeat($type)
2002 if (api_user() === false) {
2003 throw new ForbiddenException();
2009 $id = intval($a->argv[3] ?? 0);
2012 $id = intval($_REQUEST['id'] ?? 0);
2017 $id = intval($a->argv[4] ?? 0);
2020 Logger::log('API: api_statuses_repeat: '.$id);
2022 $fields = ['body', 'title', 'attach', 'tag', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
2023 $item = Item::selectFirst($fields, ['id' => $id, 'private' => false]);
2025 if (DBA::isResult($item) && $item['body'] != "") {
2026 if (strpos($item['body'], "[/share]") !== false) {
2027 $pos = strpos($item['body'], "[share");
2028 $post = substr($item['body'], $pos);
2030 $post = share_header($item['author-name'], $item['author-link'], $item['author-avatar'], $item['guid'], $item['created'], $item['plink']);
2032 if (!empty($item['title'])) {
2033 $post .= '[h3]' . $item['title'] . "[/h3]\n";
2036 $post .= $item['body'];
2037 $post .= "[/share]";
2039 $_REQUEST['body'] = $post;
2040 $_REQUEST['tag'] = $item['tag'];
2041 $_REQUEST['attach'] = $item['attach'];
2042 $_REQUEST['profile_uid'] = api_user();
2043 $_REQUEST['api_source'] = true;
2045 if (empty($_REQUEST['source'])) {
2046 $_REQUEST["source"] = api_source();
2049 $item_id = item_post($a);
2051 throw new ForbiddenException();
2054 // output the post that we just posted.
2056 return api_status_show($type, $item_id);
2059 /// @TODO move to top of file or somewhere better
2060 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2063 * Destroys a specific status.
2065 * @param string $type Return type (atom, rss, xml, json)
2067 * @return array|string
2068 * @throws BadRequestException
2069 * @throws ForbiddenException
2070 * @throws ImagickException
2071 * @throws InternalServerErrorException
2072 * @throws UnauthorizedException
2073 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2075 function api_statuses_destroy($type)
2079 if (api_user() === false) {
2080 throw new ForbiddenException();
2086 $id = intval($a->argv[3] ?? 0);
2089 $id = intval($_REQUEST['id'] ?? 0);
2094 $id = intval($a->argv[4] ?? 0);
2097 Logger::log('API: api_statuses_destroy: '.$id);
2099 $ret = api_statuses_show($type);
2101 Item::deleteForUser(['id' => $id], api_user());
2106 /// @TODO move to top of file or somewhere better
2107 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2110 * Returns the most recent mentions.
2112 * @param string $type Return type (atom, rss, xml, json)
2114 * @return array|string
2115 * @throws BadRequestException
2116 * @throws ForbiddenException
2117 * @throws ImagickException
2118 * @throws InternalServerErrorException
2119 * @throws UnauthorizedException
2120 * @see http://developer.twitter.com/doc/get/statuses/mentions
2122 function api_statuses_mentions($type)
2125 $user_info = api_get_user($a);
2127 if (api_user() === false || $user_info === false) {
2128 throw new ForbiddenException();
2131 unset($_REQUEST["user_id"]);
2132 unset($_GET["user_id"]);
2134 unset($_REQUEST["screen_name"]);
2135 unset($_GET["screen_name"]);
2137 // get last network messages
2140 $since_id = $_REQUEST['since_id'] ?? 0;
2141 $max_id = $_REQUEST['max_id'] ?? 0;
2142 $count = $_REQUEST['count'] ?? 20;
2143 $page = $_REQUEST['page'] ?? 1;
2145 $start = max(0, ($page - 1) * $count);
2147 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `author-id` != ?
2148 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `thread`.`uid` = ? AND `thread`.`mention` AND NOT `thread`.`ignored`)",
2149 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['pid'], api_user()];
2152 $condition[0] .= " AND `item`.`id` <= ?";
2153 $condition[] = $max_id;
2156 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2157 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2159 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2161 $data = ['status' => $ret];
2166 $data = api_rss_extra($a, $data, $user_info);
2170 return api_format_data("statuses", $type, $data);
2173 /// @TODO move to top of file or somewhere better
2174 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2175 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2178 * Returns the most recent statuses posted by the user.
2180 * @brief Returns a user's public timeline
2182 * @param string $type Either "json" or "xml"
2183 * @return string|array
2184 * @throws BadRequestException
2185 * @throws ForbiddenException
2186 * @throws ImagickException
2187 * @throws InternalServerErrorException
2188 * @throws UnauthorizedException
2189 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2191 function api_statuses_user_timeline($type)
2194 $user_info = api_get_user($a);
2196 if (api_user() === false || $user_info === false) {
2197 throw new ForbiddenException();
2201 "api_statuses_user_timeline: api_user: ". api_user() .
2202 "\nuser_info: ".print_r($user_info, true) .
2203 "\n_REQUEST: ".print_r($_REQUEST, true),
2207 $since_id = $_REQUEST['since_id'] ?? 0;
2208 $max_id = $_REQUEST['max_id'] ?? 0;
2209 $exclude_replies = !empty($_REQUEST['exclude_replies']);
2210 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
2213 $count = $_REQUEST['count'] ?? 20;
2214 $page = $_REQUEST['page'] ?? 1;
2216 $start = max(0, ($page - 1) * $count);
2218 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `item`.`contact-id` = ?",
2219 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2221 if ($user_info['self'] == 1) {
2222 $condition[0] .= ' AND `item`.`wall` ';
2225 if ($exclude_replies) {
2226 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
2229 if ($conversation_id > 0) {
2230 $condition[0] .= " AND `item`.`parent` = ?";
2231 $condition[] = $conversation_id;
2235 $condition[0] .= " AND `item`.`id` <= ?";
2236 $condition[] = $max_id;
2239 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2240 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2242 $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type);
2246 $data = ['status' => $ret];
2251 $data = api_rss_extra($a, $data, $user_info);
2255 return api_format_data("statuses", $type, $data);
2258 /// @TODO move to top of file or somewhere better
2259 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2262 * Star/unstar an item.
2263 * param: id : id of the item
2265 * @param string $type Return type (atom, rss, xml, json)
2267 * @return array|string
2268 * @throws BadRequestException
2269 * @throws ForbiddenException
2270 * @throws ImagickException
2271 * @throws InternalServerErrorException
2272 * @throws UnauthorizedException
2273 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2275 function api_favorites_create_destroy($type)
2279 if (api_user() === false) {
2280 throw new ForbiddenException();
2283 // for versioned api.
2284 /// @TODO We need a better global soluton
2285 $action_argv_id = 2;
2286 if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2287 $action_argv_id = 3;
2290 if ($a->argc <= $action_argv_id) {
2291 throw new BadRequestException("Invalid request.");
2293 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2294 if ($a->argc == $action_argv_id + 2) {
2295 $itemid = intval($a->argv[$action_argv_id + 1] ?? 0);
2297 $itemid = intval($_REQUEST['id'] ?? 0);
2300 $item = Item::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2302 if (!DBA::isResult($item)) {
2303 throw new BadRequestException("Invalid item.");
2308 $item['starred'] = 1;
2311 $item['starred'] = 0;
2314 throw new BadRequestException("Invalid action ".$action);
2317 $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2320 throw new InternalServerErrorException("DB error");
2324 $user_info = api_get_user($a);
2325 $rets = api_format_items([$item], $user_info, false, $type);
2328 $data = ['status' => $ret];
2333 $data = api_rss_extra($a, $data, $user_info);
2337 return api_format_data("status", $type, $data);
2340 /// @TODO move to top of file or somewhere better
2341 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2342 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2345 * Returns the most recent favorite statuses.
2347 * @param string $type Return type (atom, rss, xml, json)
2349 * @return string|array
2350 * @throws BadRequestException
2351 * @throws ForbiddenException
2352 * @throws ImagickException
2353 * @throws InternalServerErrorException
2354 * @throws UnauthorizedException
2356 function api_favorites($type)
2361 $user_info = api_get_user($a);
2363 if (api_user() === false || $user_info === false) {
2364 throw new ForbiddenException();
2369 // in friendica starred item are private
2370 // return favorites only for self
2371 Logger::info(API_LOG_PREFIX . 'for {self}', ['module' => 'api', 'action' => 'favorites', 'self' => $user_info['self']]);
2373 if ($user_info['self'] == 0) {
2377 $since_id = $_REQUEST['since_id'] ?? 0;
2378 $max_id = $_REQUEST['max_id'] ?? 0;
2379 $count = $_GET['count'] ?? 20;
2380 $page = $_REQUEST['page'] ?? 1;
2382 $start = max(0, ($page - 1) * $count);
2384 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2385 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2387 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2390 $condition[0] .= " AND `item`.`id` <= ?";
2391 $condition[] = $max_id;
2394 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2396 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2401 $data = ['status' => $ret];
2406 $data = api_rss_extra($a, $data, $user_info);
2410 return api_format_data("statuses", $type, $data);
2413 /// @TODO move to top of file or somewhere better
2414 api_register_func('api/favorites', 'api_favorites', true);
2418 * @param array $item
2419 * @param array $recipient
2420 * @param array $sender
2423 * @throws InternalServerErrorException
2425 function api_format_messages($item, $recipient, $sender)
2427 // standard meta information
2429 'id' => $item['id'],
2430 'sender_id' => $sender['id'],
2432 'recipient_id' => $recipient['id'],
2433 'created_at' => api_date($item['created'] ?? DateTimeFormat::utcNow()),
2434 'sender_screen_name' => $sender['screen_name'],
2435 'recipient_screen_name' => $recipient['screen_name'],
2436 'sender' => $sender,
2437 'recipient' => $recipient,
2439 'friendica_seen' => $item['seen'] ?? 0,
2440 'friendica_parent_uri' => $item['parent-uri'] ?? '',
2443 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2444 if (isset($ret['sender']['uid'])) {
2445 unset($ret['sender']['uid']);
2447 if (isset($ret['sender']['self'])) {
2448 unset($ret['sender']['self']);
2450 if (isset($ret['recipient']['uid'])) {
2451 unset($ret['recipient']['uid']);
2453 if (isset($ret['recipient']['self'])) {
2454 unset($ret['recipient']['self']);
2457 //don't send title to regular StatusNET requests to avoid confusing these apps
2458 if (!empty($_GET['getText'])) {
2459 $ret['title'] = $item['title'];
2460 if ($_GET['getText'] == 'html') {
2461 $ret['text'] = BBCode::convert($item['body'], false);
2462 } elseif ($_GET['getText'] == 'plain') {
2463 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2466 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2468 if (!empty($_GET['getUserObjects']) && $_GET['getUserObjects'] == 'false') {
2469 unset($ret['sender']);
2470 unset($ret['recipient']);
2478 * @param array $item
2481 * @throws InternalServerErrorException
2483 function api_convert_item($item)
2485 $body = $item['body'];
2486 $attachments = api_get_attachments($body);
2488 // Workaround for ostatus messages where the title is identically to the body
2489 $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2490 $statusbody = trim(HTML::toPlaintext($html, 0));
2492 // handle data: images
2493 $statusbody = api_format_items_embeded_images($item, $statusbody);
2495 $statustitle = trim($item['title']);
2497 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2498 $statustext = trim($statusbody);
2500 $statustext = trim($statustitle."\n\n".$statusbody);
2503 if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (mb_strlen($statustext)> 1000)) {
2504 $statustext = mb_substr($statustext, 0, 1000) . "... \n" . ($item['plink'] ?? '');
2507 $statushtml = BBCode::convert(BBCode::removeAttachment($body), false);
2509 // Workaround for clients with limited HTML parser functionality
2510 $search = ["<br>", "<blockquote>", "</blockquote>",
2511 "<h1>", "</h1>", "<h2>", "</h2>",
2512 "<h3>", "</h3>", "<h4>", "</h4>",
2513 "<h5>", "</h5>", "<h6>", "</h6>"];
2514 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2515 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2516 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2517 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2518 $statushtml = str_replace($search, $replace, $statushtml);
2520 if ($item['title'] != "") {
2521 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2525 $oldtext = $statushtml;
2526 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2527 } while ($oldtext != $statushtml);
2529 if (substr($statushtml, 0, 4) == '<br>') {
2530 $statushtml = substr($statushtml, 4);
2533 if (substr($statushtml, 0, -4) == '<br>') {
2534 $statushtml = substr($statushtml, -4);
2537 // feeds without body should contain the link
2538 if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2539 $statushtml .= BBCode::convert($item['plink']);
2542 $entities = api_get_entitities($statustext, $body);
2545 "text" => $statustext,
2546 "html" => $statushtml,
2547 "attachments" => $attachments,
2548 "entities" => $entities
2554 * @param string $body
2557 * @throws InternalServerErrorException
2559 function api_get_attachments(&$body)
2562 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2563 $text = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $text);
2565 $URLSearchString = "^\[\]";
2566 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2574 foreach ($images[1] as $image) {
2575 $imagedata = Images::getInfoFromURLCached($image);
2578 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2582 if (strstr($_SERVER['HTTP_USER_AGENT'] ?? '', 'AndStatus')) {
2583 foreach ($images[0] as $orig) {
2584 $body = str_replace($orig, "", $body);
2588 return $attachments;
2593 * @param string $text
2594 * @param string $bbcode
2597 * @throws InternalServerErrorException
2598 * @todo Links at the first character of the post
2600 function api_get_entitities(&$text, $bbcode)
2602 $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
2604 if ($include_entities != "true") {
2605 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2607 foreach ($images[1] as $image) {
2608 $replace = ProxyUtils::proxifyUrl($image);
2609 $text = str_replace($image, $replace, $text);
2614 $bbcode = BBCode::cleanPictureLinks($bbcode);
2616 // Change pure links in text to bbcode uris
2617 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2620 $entities["hashtags"] = [];
2621 $entities["symbols"] = [];
2622 $entities["urls"] = [];
2623 $entities["user_mentions"] = [];
2625 $URLSearchString = "^\[\]";
2627 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2629 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2630 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2631 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2633 $bbcode = preg_replace(
2634 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2635 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2638 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2640 $bbcode = preg_replace(
2641 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2642 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2645 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2647 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2649 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2650 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2653 foreach ($urls[1] as $id => $url) {
2654 //$start = strpos($text, $url, $offset);
2655 $start = iconv_strpos($text, $url, 0, "UTF-8");
2656 if (!($start === false)) {
2657 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2661 ksort($ordered_urls);
2664 //foreach ($urls[1] AS $id=>$url) {
2665 foreach ($ordered_urls as $url) {
2666 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2667 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2669 $display_url = $url["title"];
2671 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2672 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2674 if (strlen($display_url) > 26) {
2675 $display_url = substr($display_url, 0, 25)."…";
2679 //$start = strpos($text, $url, $offset);
2680 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2681 if (!($start === false)) {
2682 $entities["urls"][] = ["url" => $url["url"],
2683 "expanded_url" => $url["url"],
2684 "display_url" => $display_url,
2685 "indices" => [$start, $start+strlen($url["url"])]];
2686 $offset = $start + 1;
2690 preg_match_all("/\[img\=(.*?)\](.*?)\[\/img\]/ism", $bbcode, $images, PREG_SET_ORDER);
2691 $ordered_images = [];
2692 foreach ($images as $image) {
2693 $start = iconv_strpos($text, $image[1], 0, "UTF-8");
2694 if (!($start === false)) {
2695 $ordered_images[$start] = ['url' => $image[1], 'alt' => $image[2]];
2699 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2700 foreach ($images[1] as $image) {
2701 $start = iconv_strpos($text, $image, 0, "UTF-8");
2702 if (!($start === false)) {
2703 $ordered_images[$start] = ['url' => $image, 'alt' => ''];
2706 //$entities["media"] = array();
2709 foreach ($ordered_images as $image) {
2710 $url = $image['url'];
2711 $ext_alt_text = $image['alt'];
2713 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2714 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2716 if (strlen($display_url) > 26) {
2717 $display_url = substr($display_url, 0, 25)."…";
2720 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2721 if (!($start === false)) {
2722 $image = Images::getInfoFromURLCached($url);
2724 // If image cache is activated, then use the following sizes:
2725 // thumb (150), small (340), medium (600) and large (1024)
2726 if (!Config::get("system", "proxy_disabled")) {
2727 $media_url = ProxyUtils::proxifyUrl($url);
2730 $scale = Images::getScalingDimensions($image[0], $image[1], 150);
2731 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2733 if (($image[0] > 150) || ($image[1] > 150)) {
2734 $scale = Images::getScalingDimensions($image[0], $image[1], 340);
2735 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2738 $scale = Images::getScalingDimensions($image[0], $image[1], 600);
2739 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2741 if (($image[0] > 600) || ($image[1] > 600)) {
2742 $scale = Images::getScalingDimensions($image[0], $image[1], 1024);
2743 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2747 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2750 $entities["media"][] = [
2752 "id_str" => (string) ($start + 1),
2753 "indices" => [$start, $start+strlen($url)],
2754 "media_url" => Strings::normaliseLink($media_url),
2755 "media_url_https" => $media_url,
2757 "display_url" => $display_url,
2758 "expanded_url" => $url,
2759 "ext_alt_text" => $ext_alt_text,
2763 $offset = $start + 1;
2772 * @param array $item
2773 * @param string $text
2777 function api_format_items_embeded_images($item, $text)
2779 $text = preg_replace_callback(
2780 '|data:image/([^;]+)[^=]+=*|m',
2781 function () use ($item) {
2782 return System::baseUrl() . '/display/' . $item['guid'];
2790 * @brief return <a href='url'>name</a> as array
2792 * @param string $txt text
2797 function api_contactlink_to_array($txt)
2800 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2801 if ($r && count($match)==3) {
2803 'name' => $match[2],
2817 * @brief return likes, dislikes and attend status for item
2819 * @param array $item array
2820 * @param string $type Return type (atom, rss, xml, json)
2823 * likes => int count,
2824 * dislikes => int count
2825 * @throws BadRequestException
2826 * @throws ImagickException
2827 * @throws InternalServerErrorException
2828 * @throws UnauthorizedException
2830 function api_format_items_activities($item, $type = "json")
2839 'attendmaybe' => [],
2842 $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri']];
2843 $ret = Item::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2845 while ($parent_item = Item::fetch($ret)) {
2846 // not used as result should be structured like other user data
2847 //builtin_activity_puller($i, $activities);
2849 // get user data and add it to the array of the activity
2850 $user = api_get_user($a, $parent_item['author-id']);
2851 switch ($parent_item['verb']) {
2852 case Activity::LIKE:
2853 $activities['like'][] = $user;
2855 case Activity::DISLIKE:
2856 $activities['dislike'][] = $user;
2858 case Activity::ATTEND:
2859 $activities['attendyes'][] = $user;
2861 case Activity::ATTENDNO:
2862 $activities['attendno'][] = $user;
2864 case Activity::ATTENDMAYBE:
2865 $activities['attendmaybe'][] = $user;
2874 if ($type == "xml") {
2875 $xml_activities = [];
2876 foreach ($activities as $k => $v) {
2877 // change xml element from "like" to "friendica:like"
2878 $xml_activities["friendica:".$k] = $v;
2879 // add user data into xml output
2881 foreach ($v as $user) {
2882 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2885 $activities = $xml_activities;
2893 * @brief return data from profiles
2895 * @param array $profile_row array containing data from db table 'profile'
2897 * @throws InternalServerErrorException
2899 function api_format_items_profiles($profile_row)
2902 'profile_id' => $profile_row['id'],
2903 'profile_name' => $profile_row['profile-name'],
2904 'is_default' => $profile_row['is-default'] ? true : false,
2905 'hide_friends' => $profile_row['hide-friends'] ? true : false,
2906 'profile_photo' => $profile_row['photo'],
2907 'profile_thumb' => $profile_row['thumb'],
2908 'publish' => $profile_row['publish'] ? true : false,
2909 'net_publish' => $profile_row['net-publish'] ? true : false,
2910 'description' => $profile_row['pdesc'],
2911 'date_of_birth' => $profile_row['dob'],
2912 'address' => $profile_row['address'],
2913 'city' => $profile_row['locality'],
2914 'region' => $profile_row['region'],
2915 'postal_code' => $profile_row['postal-code'],
2916 'country' => $profile_row['country-name'],
2917 'hometown' => $profile_row['hometown'],
2918 'gender' => $profile_row['gender'],
2919 'marital' => $profile_row['marital'],
2920 'marital_with' => $profile_row['with'],
2921 'marital_since' => $profile_row['howlong'],
2922 'sexual' => $profile_row['sexual'],
2923 'politic' => $profile_row['politic'],
2924 'religion' => $profile_row['religion'],
2925 'public_keywords' => $profile_row['pub_keywords'],
2926 'private_keywords' => $profile_row['prv_keywords'],
2927 'likes' => BBCode::convert(api_clean_plain_items($profile_row['likes']) , false, 2),
2928 'dislikes' => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
2929 'about' => BBCode::convert(api_clean_plain_items($profile_row['about']) , false, 2),
2930 'music' => BBCode::convert(api_clean_plain_items($profile_row['music']) , false, 2),
2931 'book' => BBCode::convert(api_clean_plain_items($profile_row['book']) , false, 2),
2932 'tv' => BBCode::convert(api_clean_plain_items($profile_row['tv']) , false, 2),
2933 'film' => BBCode::convert(api_clean_plain_items($profile_row['film']) , false, 2),
2934 'interest' => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
2935 'romance' => BBCode::convert(api_clean_plain_items($profile_row['romance']) , false, 2),
2936 'work' => BBCode::convert(api_clean_plain_items($profile_row['work']) , false, 2),
2937 'education' => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
2938 'social_networks' => BBCode::convert(api_clean_plain_items($profile_row['contact']) , false, 2),
2939 'homepage' => $profile_row['homepage'],
2946 * @brief format items to be returned by api
2948 * @param array $items array of items
2949 * @param array $user_info
2950 * @param bool $filter_user filter items by $user_info
2951 * @param string $type Return type (atom, rss, xml, json)
2953 * @throws BadRequestException
2954 * @throws ImagickException
2955 * @throws InternalServerErrorException
2956 * @throws UnauthorizedException
2958 function api_format_items($items, $user_info, $filter_user = false, $type = "json")
2960 $a = BaseObject::getApp();
2964 foreach ((array)$items as $item) {
2965 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
2967 // Look if the posts are matching if they should be filtered by user id
2968 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2972 $status = api_format_item($item, $type, $status_user, $author_user, $owner_user);
2981 * @param array $item Item record
2982 * @param string $type Return format (atom, rss, xml, json)
2983 * @param array $status_user User record of the item author, can be provided by api_item_get_user()
2984 * @param array $author_user User record of the item author, can be provided by api_item_get_user()
2985 * @param array $owner_user User record of the item owner, can be provided by api_item_get_user()
2986 * @return array API-formatted status
2987 * @throws BadRequestException
2988 * @throws ImagickException
2989 * @throws InternalServerErrorException
2990 * @throws UnauthorizedException
2992 function api_format_item($item, $type = "json", $status_user = null, $author_user = null, $owner_user = null)
2994 $a = BaseObject::getApp();
2996 if (empty($status_user) || empty($author_user) || empty($owner_user)) {
2997 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
3000 localize_item($item);
3002 $in_reply_to = api_in_reply_to($item);
3004 $converted = api_convert_item($item);
3006 if ($type == "xml") {
3007 $geo = "georss:point";
3013 'text' => $converted["text"],
3014 'truncated' => false,
3015 'created_at'=> api_date($item['created']),
3016 'in_reply_to_status_id' => $in_reply_to['status_id'],
3017 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
3018 'source' => (($item['app']) ? $item['app'] : 'web'),
3019 'id' => intval($item['id']),
3020 'id_str' => (string) intval($item['id']),
3021 'in_reply_to_user_id' => $in_reply_to['user_id'],
3022 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
3023 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
3025 'favorited' => $item['starred'] ? true : false,
3026 'user' => $status_user,
3027 'friendica_author' => $author_user,
3028 'friendica_owner' => $owner_user,
3029 'friendica_private' => $item['private'] == 1,
3030 //'entities' => NULL,
3031 'statusnet_html' => $converted["html"],
3032 'statusnet_conversation_id' => $item['parent'],
3033 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
3034 'friendica_activities' => api_format_items_activities($item, $type),
3035 'friendica_title' => $item['title'],
3036 'friendica_html' => BBCode::convert($item['body'], false)
3039 if (count($converted["attachments"]) > 0) {
3040 $status["attachments"] = $converted["attachments"];
3043 if (count($converted["entities"]) > 0) {
3044 $status["entities"] = $converted["entities"];
3047 if ($status["source"] == 'web') {
3048 $status["source"] = ContactSelector::networkToName($item['network'], $item['author-link']);
3049 } elseif (ContactSelector::networkToName($item['network'], $item['author-link']) != $status["source"]) {
3050 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $item['author-link']).')');
3053 $retweeted_item = [];
3056 if ($item["id"] == $item["parent"]) {
3057 $body = $item['body'];
3058 $retweeted_item = api_share_as_retweet($item);
3059 if ($body != $item['body']) {
3060 $quoted_item = $retweeted_item;
3061 $retweeted_item = [];
3065 if (empty($retweeted_item) && ($item['owner-id'] == $item['author-id'])) {
3066 $announce = api_get_announce($item);
3067 if (!empty($announce)) {
3068 $retweeted_item = $item;
3070 $status['friendica_owner'] = api_get_user($a, $announce['author-id']);
3074 if (!empty($quoted_item)) {
3075 $conv_quoted = api_convert_item($quoted_item);
3076 $quoted_status = $status;
3077 unset($quoted_status['friendica_author']);
3078 unset($quoted_status['friendica_owner']);
3079 unset($quoted_status['friendica_activities']);
3080 unset($quoted_status['friendica_private']);
3081 unset($quoted_status['statusnet_conversation_id']);
3082 $quoted_status['text'] = $conv_quoted['text'];
3083 $quoted_status['statusnet_html'] = $conv_quoted['html'];
3085 $quoted_status["user"] = api_get_user($a, $quoted_item["author-id"]);
3086 } catch (BadRequestException $e) {
3087 // user not found. should be found?
3088 /// @todo check if the user should be always found
3089 $quoted_status["user"] = [];
3093 if (!empty($retweeted_item)) {
3094 $retweeted_status = $status;
3095 unset($retweeted_status['friendica_author']);
3096 unset($retweeted_status['friendica_owner']);
3097 unset($retweeted_status['friendica_activities']);
3098 unset($retweeted_status['friendica_private']);
3099 unset($retweeted_status['statusnet_conversation_id']);
3100 $status['user'] = $status['friendica_owner'];
3102 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
3103 } catch (BadRequestException $e) {
3104 // user not found. should be found?
3105 /// @todo check if the user should be always found
3106 $retweeted_status["user"] = [];
3109 $rt_converted = api_convert_item($retweeted_item);
3111 $retweeted_status['text'] = $rt_converted["text"];
3112 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3113 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
3115 if (!empty($quoted_status)) {
3116 $retweeted_status['quoted_status'] = $quoted_status;
3119 $status['friendica_author'] = $retweeted_status['user'];
3120 $status['retweeted_status'] = $retweeted_status;
3121 } elseif (!empty($quoted_status)) {
3122 $root_status = api_convert_item($item);
3124 $status['text'] = $root_status["text"];
3125 $status['statusnet_html'] = $root_status["html"];
3126 $status['quoted_status'] = $quoted_status;
3129 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3130 unset($status["user"]["uid"]);
3131 unset($status["user"]["self"]);
3133 if ($item["coord"] != "") {
3134 $coords = explode(' ', $item["coord"]);
3135 if (count($coords) == 2) {
3136 if ($type == "json") {
3137 $status["geo"] = ['type' => 'Point',
3138 'coordinates' => [(float) $coords[0],
3139 (float) $coords[1]]];
3140 } else {// Not sure if this is the official format - if someone founds a documentation we can check
3141 $status["georss:point"] = $item["coord"];
3150 * Returns the remaining number of API requests available to the user before the API limit is reached.
3152 * @param string $type Return type (atom, rss, xml, json)
3154 * @return array|string
3157 function api_account_rate_limit_status($type)
3159 if ($type == "xml") {
3161 'remaining-hits' => '150',
3162 '@attributes' => ["type" => "integer"],
3163 'hourly-limit' => '150',
3164 '@attributes2' => ["type" => "integer"],
3165 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
3166 '@attributes3' => ["type" => "datetime"],
3167 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3168 '@attributes4' => ["type" => "integer"],
3172 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3173 'remaining_hits' => '150',
3174 'hourly_limit' => '150',
3175 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
3179 return api_format_data('hash', $type, ['hash' => $hash]);
3182 /// @TODO move to top of file or somewhere better
3183 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3186 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3188 * @param string $type Return type (atom, rss, xml, json)
3190 * @return array|string
3192 function api_help_test($type)
3194 if ($type == 'xml') {
3200 return api_format_data('ok', $type, ["ok" => $ok]);
3203 /// @TODO move to top of file or somewhere better
3204 api_register_func('api/help/test', 'api_help_test', false);
3207 * Returns all lists the user subscribes to.
3209 * @param string $type Return type (atom, rss, xml, json)
3211 * @return array|string
3212 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3214 function api_lists_list($type)
3217 /// @TODO $ret is not filled here?
3218 return api_format_data('lists', $type, ["lists_list" => $ret]);
3221 /// @TODO move to top of file or somewhere better
3222 api_register_func('api/lists/list', 'api_lists_list', true);
3223 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3226 * Returns all groups the user owns.
3228 * @param string $type Return type (atom, rss, xml, json)
3230 * @return array|string
3231 * @throws BadRequestException
3232 * @throws ForbiddenException
3233 * @throws ImagickException
3234 * @throws InternalServerErrorException
3235 * @throws UnauthorizedException
3236 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3238 function api_lists_ownerships($type)
3242 if (api_user() === false) {
3243 throw new ForbiddenException();
3247 $user_info = api_get_user($a);
3248 $uid = $user_info['uid'];
3250 $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3252 // loop through all groups
3254 foreach ($groups as $group) {
3255 if ($group['visible']) {
3261 'name' => $group['name'],
3262 'id' => intval($group['id']),
3263 'id_str' => (string) $group['id'],
3264 'user' => $user_info,
3268 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3271 /// @TODO move to top of file or somewhere better
3272 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3275 * Returns recent statuses from users in the specified group.
3277 * @param string $type Return type (atom, rss, xml, json)
3279 * @return array|string
3280 * @throws BadRequestException
3281 * @throws ForbiddenException
3282 * @throws ImagickException
3283 * @throws InternalServerErrorException
3284 * @throws UnauthorizedException
3285 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3287 function api_lists_statuses($type)
3291 $user_info = api_get_user($a);
3292 if (api_user() === false || $user_info === false) {
3293 throw new ForbiddenException();
3296 unset($_REQUEST["user_id"]);
3297 unset($_GET["user_id"]);
3299 unset($_REQUEST["screen_name"]);
3300 unset($_GET["screen_name"]);
3302 if (empty($_REQUEST['list_id'])) {
3303 throw new BadRequestException('list_id not specified');
3307 $count = $_REQUEST['count'] ?? 20;
3308 $page = $_REQUEST['page'] ?? 1;
3309 $since_id = $_REQUEST['since_id'] ?? 0;
3310 $max_id = $_REQUEST['max_id'] ?? 0;
3311 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
3312 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
3314 $start = max(0, ($page - 1) * $count);
3316 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3317 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3320 $condition[0] .= " AND `item`.`id` <= ?";
3321 $condition[] = $max_id;
3323 if ($exclude_replies > 0) {
3324 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
3326 if ($conversation_id > 0) {
3327 $condition[0] .= " AND `item`.`parent` = ?";
3328 $condition[] = $conversation_id;
3331 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3332 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3334 $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3336 $data = ['status' => $items];
3341 $data = api_rss_extra($a, $data, $user_info);
3345 return api_format_data("statuses", $type, $data);
3348 /// @TODO move to top of file or somewhere better
3349 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3352 * Considers friends and followers lists to be private and won't return
3353 * anything if any user_id parameter is passed.
3355 * @brief Returns either the friends of the follower list
3357 * @param string $qtype Either "friends" or "followers"
3358 * @return boolean|array
3359 * @throws BadRequestException
3360 * @throws ForbiddenException
3361 * @throws ImagickException
3362 * @throws InternalServerErrorException
3363 * @throws UnauthorizedException
3365 function api_statuses_f($qtype)
3369 if (api_user() === false) {
3370 throw new ForbiddenException();
3374 $count = $_GET['count'] ?? 20;
3375 $page = $_GET['page'] ?? 1;
3377 $start = max(0, ($page - 1) * $count);
3379 $user_info = api_get_user($a);
3381 if (!empty($_GET['cursor']) && $_GET['cursor'] == 'undefined') {
3382 /* this is to stop Hotot to load friends multiple times
3383 * I'm not sure if I'm missing return something or
3384 * is a bug in hotot. Workaround, meantime
3388 return array('$users' => $ret);*/
3393 if ($qtype == 'friends') {
3394 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
3395 } elseif ($qtype == 'followers') {
3396 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
3399 // friends and followers only for self
3400 if ($user_info['self'] == 0) {
3401 $sql_extra = " AND false ";
3404 if ($qtype == 'blocks') {
3405 $sql_filter = 'AND `blocked` AND NOT `pending`';
3406 } elseif ($qtype == 'incoming') {
3407 $sql_filter = 'AND `pending`';
3409 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3427 foreach ($r as $cid) {
3428 $user = api_get_user($a, $cid['nurl']);
3429 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3430 unset($user["uid"]);
3431 unset($user["self"]);
3438 return ['user' => $ret];
3443 * Returns the user's friends.
3445 * @brief Returns the list of friends of the provided user
3447 * @deprecated By Twitter API in favor of friends/list
3449 * @param string $type Either "json" or "xml"
3450 * @return boolean|string|array
3451 * @throws BadRequestException
3452 * @throws ForbiddenException
3454 function api_statuses_friends($type)
3456 $data = api_statuses_f("friends");
3457 if ($data === false) {
3460 return api_format_data("users", $type, $data);
3464 * Returns the user's followers.
3466 * @brief Returns the list of followers of the provided user
3468 * @deprecated By Twitter API in favor of friends/list
3470 * @param string $type Either "json" or "xml"
3471 * @return boolean|string|array
3472 * @throws BadRequestException
3473 * @throws ForbiddenException
3475 function api_statuses_followers($type)
3477 $data = api_statuses_f("followers");
3478 if ($data === false) {
3481 return api_format_data("users", $type, $data);
3484 /// @TODO move to top of file or somewhere better
3485 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3486 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3489 * Returns the list of blocked users
3491 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3493 * @param string $type Either "json" or "xml"
3495 * @return boolean|string|array
3496 * @throws BadRequestException
3497 * @throws ForbiddenException
3499 function api_blocks_list($type)
3501 $data = api_statuses_f('blocks');
3502 if ($data === false) {
3505 return api_format_data("users", $type, $data);
3508 /// @TODO move to top of file or somewhere better
3509 api_register_func('api/blocks/list', 'api_blocks_list', true);
3512 * Returns the list of pending users IDs
3514 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3516 * @param string $type Either "json" or "xml"
3518 * @return boolean|string|array
3519 * @throws BadRequestException
3520 * @throws ForbiddenException
3522 function api_friendships_incoming($type)
3524 $data = api_statuses_f('incoming');
3525 if ($data === false) {
3530 foreach ($data['user'] as $user) {
3531 $ids[] = $user['id'];
3534 return api_format_data("ids", $type, ['id' => $ids]);
3537 /// @TODO move to top of file or somewhere better
3538 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3541 * Returns the instance's configuration information.
3543 * @param string $type Return type (atom, rss, xml, json)
3545 * @return array|string
3546 * @throws InternalServerErrorException
3548 function api_statusnet_config($type)
3552 $name = Config::get('config', 'sitename');
3553 $server = $a->getHostName();
3554 $logo = System::baseUrl() . '/images/friendica-64.png';
3555 $email = Config::get('config', 'admin_email');
3556 $closed = intval(Config::get('config', 'register_policy')) === \Friendica\Module\Register::CLOSED ? 'true' : 'false';
3557 $private = Config::get('system', 'block_public') ? 'true' : 'false';
3558 $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000));
3559 $ssl = Config::get('system', 'have_ssl') ? 'true' : 'false';
3560 $sslserver = Config::get('system', 'have_ssl') ? str_replace('http:', 'https:', System::baseUrl()) : '';
3563 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3564 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3565 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3566 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3567 'shorturllength' => '30',
3569 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3570 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3571 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3572 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3577 return api_format_data('config', $type, ['config' => $config]);
3580 /// @TODO move to top of file or somewhere better
3581 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3582 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3586 * @param string $type Return type (atom, rss, xml, json)
3588 * @return array|string
3590 function api_statusnet_version($type)
3593 $fake_statusnet_version = "0.9.7";
3595 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3598 /// @TODO move to top of file or somewhere better
3599 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3600 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3604 * @param string $type Return type (atom, rss, xml, json)
3606 * @return array|string|void
3607 * @throws BadRequestException
3608 * @throws ForbiddenException
3609 * @throws ImagickException
3610 * @throws InternalServerErrorException
3611 * @throws UnauthorizedException
3612 * @todo use api_format_data() to return data
3614 function api_ff_ids($type)
3617 throw new ForbiddenException();
3624 $stringify_ids = $_REQUEST['stringify_ids'] ?? false;
3627 "SELECT `pcontact`.`id` FROM `contact`
3628 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3629 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3632 if (!DBA::isResult($r)) {
3637 foreach ($r as $rr) {
3638 if ($stringify_ids) {
3641 $ids[] = intval($rr['id']);
3645 return api_format_data("ids", $type, ['id' => $ids]);
3649 * Returns the ID of every user the user is following.
3651 * @param string $type Return type (atom, rss, xml, json)
3653 * @return array|string
3654 * @throws BadRequestException
3655 * @throws ForbiddenException
3656 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3658 function api_friends_ids($type)
3660 return api_ff_ids($type);
3664 * Returns the ID of every user following the user.
3666 * @param string $type Return type (atom, rss, xml, json)
3668 * @return array|string
3669 * @throws BadRequestException
3670 * @throws ForbiddenException
3671 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3673 function api_followers_ids($type)
3675 return api_ff_ids($type);
3678 /// @TODO move to top of file or somewhere better
3679 api_register_func('api/friends/ids', 'api_friends_ids', true);
3680 api_register_func('api/followers/ids', 'api_followers_ids', true);
3683 * Sends a new direct message.
3685 * @param string $type Return type (atom, rss, xml, json)
3687 * @return array|string
3688 * @throws BadRequestException
3689 * @throws ForbiddenException
3690 * @throws ImagickException
3691 * @throws InternalServerErrorException
3692 * @throws NotFoundException
3693 * @throws UnauthorizedException
3694 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3696 function api_direct_messages_new($type)
3700 if (api_user() === false) {
3701 throw new ForbiddenException();
3704 if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3708 $sender = api_get_user($a);
3711 if (!empty($_POST['screen_name'])) {
3713 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3715 DBA::escape($_POST['screen_name'])
3718 if (DBA::isResult($r)) {
3719 // Selecting the id by priority, friendica first
3720 api_best_nickname($r);
3722 $recipient = api_get_user($a, $r[0]['nurl']);
3725 $recipient = api_get_user($a, $_POST['user_id']);
3728 if (empty($recipient)) {
3729 throw new NotFoundException('Recipient not found');
3733 if (!empty($_REQUEST['replyto'])) {
3735 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3737 intval($_REQUEST['replyto'])
3739 $replyto = $r[0]['parent-uri'];
3740 $sub = $r[0]['title'];
3742 if (!empty($_REQUEST['title'])) {
3743 $sub = $_REQUEST['title'];
3745 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3749 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3752 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3753 $ret = api_format_messages($r[0], $recipient, $sender);
3755 $ret = ["error"=>$id];
3758 $data = ['direct_message'=>$ret];
3764 $data = api_rss_extra($a, $data, $sender);
3768 return api_format_data("direct-messages", $type, $data);
3771 /// @TODO move to top of file or somewhere better
3772 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3775 * Destroys a direct message.
3777 * @brief delete a direct_message from mail table through api
3779 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3780 * @return string|array
3781 * @throws BadRequestException
3782 * @throws ForbiddenException
3783 * @throws ImagickException
3784 * @throws InternalServerErrorException
3785 * @throws UnauthorizedException
3786 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3788 function api_direct_messages_destroy($type)
3792 if (api_user() === false) {
3793 throw new ForbiddenException();
3797 $user_info = api_get_user($a);
3799 $id = $_REQUEST['id'] ?? 0;
3801 $parenturi = $_REQUEST['friendica_parenturi'] ?? '';
3802 $verbose = (!empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false");
3803 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3805 $uid = $user_info['uid'];
3806 // error if no id or parenturi specified (for clients posting parent-uri as well)
3807 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3808 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3809 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3812 // BadRequestException if no id specified (for clients using Twitter API)
3814 throw new BadRequestException('Message id not specified');
3817 // add parent-uri to sql command if specified by calling app
3818 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3820 // get data of the specified message id
3822 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3827 // error message if specified id is not in database
3828 if (!DBA::isResult($r)) {
3829 if ($verbose == "true") {
3830 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3831 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3833 /// @todo BadRequestException ok for Twitter API clients?
3834 throw new BadRequestException('message id not in database');
3839 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3844 if ($verbose == "true") {
3847 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3848 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3850 $answer = ['result' => 'error', 'message' => 'unknown error'];
3851 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3854 /// @todo return JSON data like Twitter API not yet implemented
3857 /// @TODO move to top of file or somewhere better
3858 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3863 * @brief unfollow contact
3865 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3866 * @return string|array
3867 * @throws BadRequestException
3868 * @throws ForbiddenException
3869 * @throws ImagickException
3870 * @throws InternalServerErrorException
3871 * @throws NotFoundException
3872 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3874 function api_friendships_destroy($type)
3878 if ($uid === false) {
3879 throw new ForbiddenException();
3882 $contact_id = $_REQUEST['user_id'] ?? 0;
3884 if (empty($contact_id)) {
3885 Logger::notice(API_LOG_PREFIX . 'No user_id specified', ['module' => 'api', 'action' => 'friendships_destroy']);
3886 throw new BadRequestException("no user_id specified");
3889 // Get Contact by given id
3890 $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3892 if(!DBA::isResult($contact)) {
3893 Logger::notice(API_LOG_PREFIX . 'No contact found for ID {contact}', ['module' => 'api', 'action' => 'friendships_destroy', 'contact' => $contact_id]);
3894 throw new NotFoundException("no contact found to given ID");
3897 $url = $contact["url"];
3899 $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3900 $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url),
3901 Strings::normaliseLink($url), $url];
3902 $contact = DBA::selectFirst('contact', [], $condition);
3904 if (!DBA::isResult($contact)) {
3905 Logger::notice(API_LOG_PREFIX . 'Not following contact', ['module' => 'api', 'action' => 'friendships_destroy']);
3906 throw new NotFoundException("Not following Contact");
3909 if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
3910 Logger::notice(API_LOG_PREFIX . 'Not supported for {network}', ['module' => 'api', 'action' => 'friendships_destroy', 'network' => $contact['network']]);
3911 throw new ExpectationFailedException("Not supported");
3914 $dissolve = ($contact['rel'] == Contact::SHARING);
3916 $owner = User::getOwnerDataById($uid);
3918 Contact::terminateFriendship($owner, $contact, $dissolve);
3921 Logger::notice(API_LOG_PREFIX . 'No owner {uid} found', ['module' => 'api', 'action' => 'friendships_destroy', 'uid' => $uid]);
3922 throw new NotFoundException("Error Processing Request");
3925 // Sharing-only contacts get deleted as there no relationship any more
3927 Contact::remove($contact['id']);
3929 DBA::update('contact', ['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
3932 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3933 unset($contact["uid"]);
3934 unset($contact["self"]);
3936 // Set screen_name since Twidere requests it
3937 $contact["screen_name"] = $contact["nick"];
3939 return api_format_data("friendships-destroy", $type, ['user' => $contact]);
3941 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3945 * @param string $type Return type (atom, rss, xml, json)
3946 * @param string $box
3947 * @param string $verbose
3949 * @return array|string
3950 * @throws BadRequestException
3951 * @throws ForbiddenException
3952 * @throws ImagickException
3953 * @throws InternalServerErrorException
3954 * @throws UnauthorizedException
3956 function api_direct_messages_box($type, $box, $verbose)
3959 if (api_user() === false) {
3960 throw new ForbiddenException();
3963 $count = $_GET['count'] ?? 20;
3964 $page = $_REQUEST['page'] ?? 1;
3966 $since_id = $_REQUEST['since_id'] ?? 0;
3967 $max_id = $_REQUEST['max_id'] ?? 0;
3969 $user_id = $_REQUEST['user_id'] ?? '';
3970 $screen_name = $_REQUEST['screen_name'] ?? '';
3973 unset($_REQUEST["user_id"]);
3974 unset($_GET["user_id"]);
3976 unset($_REQUEST["screen_name"]);
3977 unset($_GET["screen_name"]);
3979 $user_info = api_get_user($a);
3980 if ($user_info === false) {
3981 throw new ForbiddenException();
3983 $profile_url = $user_info["url"];
3986 $start = max(0, ($page - 1) * $count);
3991 if ($box=="sentbox") {
3992 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
3993 } elseif ($box == "conversation") {
3994 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape($_GET['uri'] ?? '') . "'";
3995 } elseif ($box == "all") {
3996 $sql_extra = "true";
3997 } elseif ($box == "inbox") {
3998 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
4002 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
4005 if ($user_id != "") {
4006 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
4007 } elseif ($screen_name !="") {
4008 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
4012 "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",
4018 if ($verbose == "true" && !DBA::isResult($r)) {
4019 $answer = ['result' => 'error', 'message' => 'no mails available'];
4020 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
4024 foreach ($r as $item) {
4025 if ($box == "inbox" || $item['from-url'] != $profile_url) {
4026 $recipient = $user_info;
4027 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
4028 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
4029 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
4030 $sender = $user_info;
4033 if (isset($recipient) && isset($sender)) {
4034 $ret[] = api_format_messages($item, $recipient, $sender);
4039 $data = ['direct_message' => $ret];
4044 $data = api_rss_extra($a, $data, $user_info);
4048 return api_format_data("direct-messages", $type, $data);
4052 * Returns the most recent direct messages sent by the user.
4054 * @param string $type Return type (atom, rss, xml, json)
4056 * @return array|string
4057 * @throws BadRequestException
4058 * @throws ForbiddenException
4059 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
4061 function api_direct_messages_sentbox($type)
4063 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4064 return api_direct_messages_box($type, "sentbox", $verbose);
4068 * Returns the most recent direct messages sent to the user.
4070 * @param string $type Return type (atom, rss, xml, json)
4072 * @return array|string
4073 * @throws BadRequestException
4074 * @throws ForbiddenException
4075 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
4077 function api_direct_messages_inbox($type)
4079 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4080 return api_direct_messages_box($type, "inbox", $verbose);
4085 * @param string $type Return type (atom, rss, xml, json)
4087 * @return array|string
4088 * @throws BadRequestException
4089 * @throws ForbiddenException
4091 function api_direct_messages_all($type)
4093 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4094 return api_direct_messages_box($type, "all", $verbose);
4099 * @param string $type Return type (atom, rss, xml, json)
4101 * @return array|string
4102 * @throws BadRequestException
4103 * @throws ForbiddenException
4105 function api_direct_messages_conversation($type)
4107 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4108 return api_direct_messages_box($type, "conversation", $verbose);
4111 /// @TODO move to top of file or somewhere better
4112 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
4113 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
4114 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
4115 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
4118 * Returns an OAuth Request Token.
4120 * @see https://oauth.net/core/1.0/#auth_step1
4122 function api_oauth_request_token()
4124 $oauth1 = new FKOAuth1();
4126 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
4127 } catch (Exception $e) {
4128 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
4136 * Returns an OAuth Access Token.
4138 * @return array|string
4139 * @see https://oauth.net/core/1.0/#auth_step3
4141 function api_oauth_access_token()
4143 $oauth1 = new FKOAuth1();
4145 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
4146 } catch (Exception $e) {
4147 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
4154 /// @TODO move to top of file or somewhere better
4155 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
4156 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
4160 * @brief delete a complete photoalbum with all containing photos from database through api
4162 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4163 * @return string|array
4164 * @throws BadRequestException
4165 * @throws ForbiddenException
4166 * @throws InternalServerErrorException
4168 function api_fr_photoalbum_delete($type)
4170 if (api_user() === false) {
4171 throw new ForbiddenException();
4174 $album = $_REQUEST['album'] ?? '';
4176 // we do not allow calls without album string
4178 throw new BadRequestException("no albumname specified");
4180 // check if album is existing
4182 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
4186 if (!DBA::isResult($r)) {
4187 throw new BadRequestException("album not available");
4190 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4191 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
4192 foreach ($r as $rr) {
4193 $condition = ['uid' => local_user(), 'resource-id' => $rr['resource-id'], 'type' => 'photo'];
4194 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4196 if (!DBA::isResult($photo_item)) {
4197 throw new InternalServerErrorException("problem with deleting items occured");
4199 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4202 // now let's delete all photos from the album
4203 $result = Photo::delete(['uid' => api_user(), 'album' => $album]);
4205 // return success of deletion or error message
4207 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
4208 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
4210 throw new InternalServerErrorException("unknown error - deleting from database failed");
4215 * @brief update the name of the album for all photos of an album
4217 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4218 * @return string|array
4219 * @throws BadRequestException
4220 * @throws ForbiddenException
4221 * @throws InternalServerErrorException
4223 function api_fr_photoalbum_update($type)
4225 if (api_user() === false) {
4226 throw new ForbiddenException();
4229 $album = $_REQUEST['album'] ?? '';
4230 $album_new = $_REQUEST['album_new'] ?? '';
4232 // we do not allow calls without album string
4234 throw new BadRequestException("no albumname specified");
4236 if ($album_new == "") {
4237 throw new BadRequestException("no new albumname specified");
4239 // check if album is existing
4240 if (!Photo::exists(['uid' => api_user(), 'album' => $album])) {
4241 throw new BadRequestException("album not available");
4243 // now let's update all photos to the albumname
4244 $result = Photo::update(['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
4246 // return success of updating or error message
4248 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4249 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4251 throw new InternalServerErrorException("unknown error - updating in database failed");
4257 * @brief list all photos of the authenticated user
4259 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4260 * @return string|array
4261 * @throws ForbiddenException
4262 * @throws InternalServerErrorException
4264 function api_fr_photos_list($type)
4266 if (api_user() === false) {
4267 throw new ForbiddenException();
4270 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4271 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4272 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`, `album`, `filename`, `type`",
4273 intval(local_user())
4276 'image/jpeg' => 'jpg',
4277 'image/png' => 'png',
4278 'image/gif' => 'gif'
4280 $data = ['photo'=>[]];
4281 if (DBA::isResult($r)) {
4282 foreach ($r as $rr) {
4284 $photo['id'] = $rr['resource-id'];
4285 $photo['album'] = $rr['album'];
4286 $photo['filename'] = $rr['filename'];
4287 $photo['type'] = $rr['type'];
4288 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4289 $photo['created'] = $rr['created'];
4290 $photo['edited'] = $rr['edited'];
4291 $photo['desc'] = $rr['desc'];
4293 if ($type == "xml") {
4294 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4296 $photo['thumb'] = $thumb;
4297 $data['photo'][] = $photo;
4301 return api_format_data("photos", $type, $data);
4305 * @brief upload a new photo or change an existing photo
4307 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4308 * @return string|array
4309 * @throws BadRequestException
4310 * @throws ForbiddenException
4311 * @throws ImagickException
4312 * @throws InternalServerErrorException
4313 * @throws NotFoundException
4315 function api_fr_photo_create_update($type)
4317 if (api_user() === false) {
4318 throw new ForbiddenException();
4321 $photo_id = $_REQUEST['photo_id'] ?? null;
4322 $desc = $_REQUEST['desc'] ?? null;
4323 $album = $_REQUEST['album'] ?? null;
4324 $album_new = $_REQUEST['album_new'] ?? null;
4325 $allow_cid = $_REQUEST['allow_cid'] ?? null;
4326 $deny_cid = $_REQUEST['deny_cid' ] ?? null;
4327 $allow_gid = $_REQUEST['allow_gid'] ?? null;
4328 $deny_gid = $_REQUEST['deny_gid' ] ?? null;
4329 $visibility = !empty($_REQUEST['visibility']) && $_REQUEST['visibility'] !== "false";
4331 // do several checks on input parameters
4332 // we do not allow calls without album string
4333 if ($album == null) {
4334 throw new BadRequestException("no albumname specified");
4336 // if photo_id == null --> we are uploading a new photo
4337 if ($photo_id == null) {
4340 // error if no media posted in create-mode
4341 if (empty($_FILES['media'])) {
4343 throw new BadRequestException("no media data submitted");
4346 // album_new will be ignored in create-mode
4351 // check if photo is existing in databasei
4352 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user(), 'album' => $album])) {
4353 throw new BadRequestException("photo not available");
4357 // checks on acl strings provided by clients
4358 $acl_input_error = false;
4359 $acl_input_error |= check_acl_input($allow_cid);
4360 $acl_input_error |= check_acl_input($deny_cid);
4361 $acl_input_error |= check_acl_input($allow_gid);
4362 $acl_input_error |= check_acl_input($deny_gid);
4363 if ($acl_input_error) {
4364 throw new BadRequestException("acl data invalid");
4366 // now let's upload the new media in create-mode
4367 if ($mode == "create") {
4368 $media = $_FILES['media'];
4369 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4371 // return success of updating or error message
4372 if (!is_null($data)) {
4373 return api_format_data("photo_create", $type, $data);
4375 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4379 // now let's do the changes in update-mode
4380 if ($mode == "update") {
4381 $updated_fields = [];
4383 if (!is_null($desc)) {
4384 $updated_fields['desc'] = $desc;
4387 if (!is_null($album_new)) {
4388 $updated_fields['album'] = $album_new;
4391 if (!is_null($allow_cid)) {
4392 $allow_cid = trim($allow_cid);
4393 $updated_fields['allow_cid'] = $allow_cid;
4396 if (!is_null($deny_cid)) {
4397 $deny_cid = trim($deny_cid);
4398 $updated_fields['deny_cid'] = $deny_cid;
4401 if (!is_null($allow_gid)) {
4402 $allow_gid = trim($allow_gid);
4403 $updated_fields['allow_gid'] = $allow_gid;
4406 if (!is_null($deny_gid)) {
4407 $deny_gid = trim($deny_gid);
4408 $updated_fields['deny_gid'] = $deny_gid;
4412 if (count($updated_fields) > 0) {
4413 $nothingtodo = false;
4414 $result = Photo::update($updated_fields, ['uid' => api_user(), 'resource-id' => $photo_id, 'album' => $album]);
4416 $nothingtodo = true;
4419 if (!empty($_FILES['media'])) {
4420 $nothingtodo = false;
4421 $media = $_FILES['media'];
4422 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4423 if (!is_null($data)) {
4424 return api_format_data("photo_update", $type, $data);
4428 // return success of updating or error message
4430 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4431 return api_format_data("photo_update", $type, ['$result' => $answer]);
4434 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4435 return api_format_data("photo_update", $type, ['$result' => $answer]);
4437 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4440 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4444 * @brief delete a single photo from the database through api
4446 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4447 * @return string|array
4448 * @throws BadRequestException
4449 * @throws ForbiddenException
4450 * @throws InternalServerErrorException
4452 function api_fr_photo_delete($type)
4454 if (api_user() === false) {
4455 throw new ForbiddenException();
4459 $photo_id = $_REQUEST['photo_id'] ?? null;
4461 // do several checks on input parameters
4462 // we do not allow calls without photo id
4463 if ($photo_id == null) {
4464 throw new BadRequestException("no photo_id specified");
4467 // check if photo is existing in database
4468 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user()])) {
4469 throw new BadRequestException("photo not available");
4472 // now we can perform on the deletion of the photo
4473 $result = Photo::delete(['uid' => api_user(), 'resource-id' => $photo_id]);
4475 // return success of deletion or error message
4477 // retrieve the id of the parent element (the photo element)
4478 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4479 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4481 if (!DBA::isResult($photo_item)) {
4482 throw new InternalServerErrorException("problem with deleting items occured");
4484 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4485 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4486 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4488 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4489 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4491 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4497 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4499 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4500 * @return string|array
4501 * @throws BadRequestException
4502 * @throws ForbiddenException
4503 * @throws InternalServerErrorException
4504 * @throws NotFoundException
4506 function api_fr_photo_detail($type)
4508 if (api_user() === false) {
4509 throw new ForbiddenException();
4511 if (empty($_REQUEST['photo_id'])) {
4512 throw new BadRequestException("No photo id.");
4515 $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
4516 $photo_id = $_REQUEST['photo_id'];
4518 // prepare json/xml output with data from database for the requested photo
4519 $data = prepare_photo_data($type, $scale, $photo_id);
4521 return api_format_data("photo_detail", $type, $data);
4526 * Updates the user’s profile image.
4528 * @brief updates the profile image for the user (either a specified profile or the default profile)
4530 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4532 * @return string|array
4533 * @throws BadRequestException
4534 * @throws ForbiddenException
4535 * @throws ImagickException
4536 * @throws InternalServerErrorException
4537 * @throws NotFoundException
4538 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4540 function api_account_update_profile_image($type)
4542 if (api_user() === false) {
4543 throw new ForbiddenException();
4546 $profile_id = $_REQUEST['profile_id'] ?? 0;
4548 // error if image data is missing
4549 if (empty($_FILES['image'])) {
4550 throw new BadRequestException("no media data submitted");
4553 // check if specified profile id is valid
4554 if ($profile_id != 0) {
4555 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4556 // error message if specified profile id is not in database
4557 if (!DBA::isResult($profile)) {
4558 throw new BadRequestException("profile_id not available");
4560 $is_default_profile = $profile['is-default'];
4562 $is_default_profile = 1;
4565 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4567 if (!empty($_FILES['image'])) {
4568 $media = $_FILES['image'];
4569 } elseif (!empty($_FILES['media'])) {
4570 $media = $_FILES['media'];
4572 // save new profile image
4573 $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4576 if (is_array($media['type'])) {
4577 $filetype = $media['type'][0];
4579 $filetype = $media['type'];
4581 if ($filetype == "image/jpeg") {
4583 } elseif ($filetype == "image/png") {
4586 throw new InternalServerErrorException('Unsupported filetype');
4589 // change specified profile or all profiles to the new resource-id
4590 if ($is_default_profile) {
4591 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4592 Photo::update(['profile' => false], $condition);
4594 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext,
4595 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext];
4596 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4599 Contact::updateSelfFromUserID(api_user(), true);
4601 // Update global directory in background
4602 $url = System::baseUrl() . '/profile/' . \get_app()->user['nickname'];
4603 if ($url && strlen(Config::get('system', 'directory'))) {
4604 Worker::add(PRIORITY_LOW, "Directory", $url);
4607 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4609 // output for client
4611 return api_account_verify_credentials($type);
4613 // SaveMediaToDatabase failed for some reason
4614 throw new InternalServerErrorException("image upload failed");
4618 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4619 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4620 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4621 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4622 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4623 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4624 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4625 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4626 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4629 * Update user profile
4631 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4633 * @return array|string
4634 * @throws BadRequestException
4635 * @throws ForbiddenException
4636 * @throws ImagickException
4637 * @throws InternalServerErrorException
4638 * @throws UnauthorizedException
4640 function api_account_update_profile($type)
4642 $local_user = api_user();
4643 $api_user = api_get_user(get_app());
4645 if (!empty($_POST['name'])) {
4646 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4647 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4648 DBA::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4649 DBA::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4652 if (isset($_POST['description'])) {
4653 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4654 DBA::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4655 DBA::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4658 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4659 // Update global directory in background
4660 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4661 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4664 return api_account_verify_credentials($type);
4667 /// @TODO move to top of file or somewhere better
4668 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4672 * @param string $acl_string
4676 function check_acl_input($acl_string)
4678 if (empty($acl_string)) {
4682 $contact_not_found = false;
4684 // split <x><y><z> into array of cid's
4685 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4687 // check for each cid if it is available on server
4688 $cid_array = $array[0];
4689 foreach ($cid_array as $cid) {
4690 $cid = str_replace("<", "", $cid);
4691 $cid = str_replace(">", "", $cid);
4692 $condition = ['id' => $cid, 'uid' => api_user()];
4693 $contact_not_found |= !DBA::exists('contact', $condition);
4695 return $contact_not_found;
4699 * @param string $mediatype
4700 * @param array $media
4701 * @param string $type
4702 * @param string $album
4703 * @param string $allow_cid
4704 * @param string $deny_cid
4705 * @param string $allow_gid
4706 * @param string $deny_gid
4707 * @param string $desc
4708 * @param integer $profile
4709 * @param boolean $visibility
4710 * @param string $photo_id
4712 * @throws BadRequestException
4713 * @throws ForbiddenException
4714 * @throws ImagickException
4715 * @throws InternalServerErrorException
4716 * @throws NotFoundException
4717 * @throws UnauthorizedException
4719 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)
4727 if (is_array($media)) {
4728 if (is_array($media['tmp_name'])) {
4729 $src = $media['tmp_name'][0];
4731 $src = $media['tmp_name'];
4733 if (is_array($media['name'])) {
4734 $filename = basename($media['name'][0]);
4736 $filename = basename($media['name']);
4738 if (is_array($media['size'])) {
4739 $filesize = intval($media['size'][0]);
4741 $filesize = intval($media['size']);
4743 if (is_array($media['type'])) {
4744 $filetype = $media['type'][0];
4746 $filetype = $media['type'];
4750 if ($filetype == "") {
4751 $filetype = Images::guessType($filename);
4753 $imagedata = @getimagesize($src);
4755 $filetype = $imagedata['mime'];
4758 "File upload src: " . $src . " - filename: " . $filename .
4759 " - size: " . $filesize . " - type: " . $filetype,
4763 // check if there was a php upload error
4764 if ($filesize == 0 && $media['error'] == 1) {
4765 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4767 // check against max upload size within Friendica instance
4768 $maximagesize = Config::get('system', 'maximagesize');
4769 if ($maximagesize && ($filesize > $maximagesize)) {
4770 $formattedBytes = Strings::formatBytes($maximagesize);
4771 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4774 // create Photo instance with the data of the image
4775 $imagedata = @file_get_contents($src);
4776 $Image = new Image($imagedata, $filetype);
4777 if (!$Image->isValid()) {
4778 throw new InternalServerErrorException("unable to process image data");
4781 // check orientation of image
4782 $Image->orient($src);
4785 // check max length of images on server
4786 $max_length = Config::get('system', 'max_image_length');
4788 $max_length = MAX_IMAGE_LENGTH;
4790 if ($max_length > 0) {
4791 $Image->scaleDown($max_length);
4792 Logger::log("File upload: Scaling picture to new size " . $max_length, Logger::DEBUG);
4794 $width = $Image->getWidth();
4795 $height = $Image->getHeight();
4797 // create a new resource-id if not already provided
4798 $resource_id = ($photo_id == null) ? Photo::newResource() : $photo_id;
4800 if ($mediatype == "photo") {
4801 // upload normal image (scales 0, 1, 2)
4802 Logger::log("photo upload: starting new photo upload", Logger::DEBUG);
4804 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4806 Logger::log("photo upload: image upload with scale 0 (original size) failed");
4808 if ($width > 640 || $height > 640) {
4809 $Image->scaleDown(640);
4810 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4812 Logger::log("photo upload: image upload with scale 1 (640x640) failed");
4816 if ($width > 320 || $height > 320) {
4817 $Image->scaleDown(320);
4818 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4820 Logger::log("photo upload: image upload with scale 2 (320x320) failed");
4823 Logger::log("photo upload: new photo upload ended", Logger::DEBUG);
4824 } elseif ($mediatype == "profileimage") {
4825 // upload profile image (scales 4, 5, 6)
4826 Logger::log("photo upload: starting new profile image upload", Logger::DEBUG);
4828 if ($width > 300 || $height > 300) {
4829 $Image->scaleDown(300);
4830 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4832 Logger::log("photo upload: profile image upload with scale 4 (300x300) failed");
4836 if ($width > 80 || $height > 80) {
4837 $Image->scaleDown(80);
4838 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4840 Logger::log("photo upload: profile image upload with scale 5 (80x80) failed");
4844 if ($width > 48 || $height > 48) {
4845 $Image->scaleDown(48);
4846 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4848 Logger::log("photo upload: profile image upload with scale 6 (48x48) failed");
4851 $Image->__destruct();
4852 Logger::log("photo upload: new profile image upload ended", Logger::DEBUG);
4855 if (isset($r) && $r) {
4856 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4857 if ($photo_id == null && $mediatype == "photo") {
4858 post_photo_item($resource_id, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4860 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4861 return prepare_photo_data($type, false, $resource_id);
4863 throw new InternalServerErrorException("image upload failed");
4869 * @param string $hash
4870 * @param string $allow_cid
4871 * @param string $deny_cid
4872 * @param string $allow_gid
4873 * @param string $deny_gid
4874 * @param string $filetype
4875 * @param boolean $visibility
4876 * @throws InternalServerErrorException
4878 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4880 // get data about the api authenticated user
4881 $uri = Item::newURI(intval(api_user()));
4882 $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
4885 $arr['guid'] = System::createUUID();
4886 $arr['uid'] = intval(api_user());
4888 $arr['parent-uri'] = $uri;
4889 $arr['type'] = 'photo';
4891 $arr['resource-id'] = $hash;
4892 $arr['contact-id'] = $owner_record['id'];
4893 $arr['owner-name'] = $owner_record['name'];
4894 $arr['owner-link'] = $owner_record['url'];
4895 $arr['owner-avatar'] = $owner_record['thumb'];
4896 $arr['author-name'] = $owner_record['name'];
4897 $arr['author-link'] = $owner_record['url'];
4898 $arr['author-avatar'] = $owner_record['thumb'];
4900 $arr['allow_cid'] = $allow_cid;
4901 $arr['allow_gid'] = $allow_gid;
4902 $arr['deny_cid'] = $deny_cid;
4903 $arr['deny_gid'] = $deny_gid;
4904 $arr['visible'] = $visibility;
4908 'image/jpeg' => 'jpg',
4909 'image/png' => 'png',
4910 'image/gif' => 'gif'
4913 // adds link to the thumbnail scale photo
4914 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
4915 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4918 // do the magic for storing the item in the database and trigger the federation to other contacts
4924 * @param string $type
4926 * @param string $photo_id
4929 * @throws BadRequestException
4930 * @throws ForbiddenException
4931 * @throws ImagickException
4932 * @throws InternalServerErrorException
4933 * @throws NotFoundException
4934 * @throws UnauthorizedException
4936 function prepare_photo_data($type, $scale, $photo_id)
4939 $user_info = api_get_user($a);
4941 if ($user_info === false) {
4942 throw new ForbiddenException();
4945 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4946 $data_sql = ($scale === false ? "" : "data, ");
4948 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4949 // clients needs to convert this in their way for further processing
4951 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4952 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4953 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4954 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY
4955 `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4956 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`",
4958 intval(local_user()),
4959 DBA::escape($photo_id),
4964 'image/jpeg' => 'jpg',
4965 'image/png' => 'png',
4966 'image/gif' => 'gif'
4969 // prepare output data for photo
4970 if (DBA::isResult($r)) {
4971 $data = ['photo' => $r[0]];
4972 $data['photo']['id'] = $data['photo']['resource-id'];
4973 if ($scale !== false) {
4974 $data['photo']['data'] = base64_encode($data['photo']['data']);
4976 unset($data['photo']['datasize']); //needed only with scale param
4978 if ($type == "xml") {
4979 $data['photo']['links'] = [];
4980 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4981 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4983 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4986 $data['photo']['link'] = [];
4987 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4989 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4990 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4994 unset($data['photo']['resource-id']);
4995 unset($data['photo']['minscale']);
4996 unset($data['photo']['maxscale']);
4998 throw new NotFoundException();
5001 // retrieve item element for getting activities (like, dislike etc.) related to photo
5002 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
5003 $item = Item::selectFirstForUser(local_user(), ['id'], $condition);
5005 $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
5007 // retrieve comments on photo
5008 $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
5009 $item[0]['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
5011 $statuses = Item::selectForUser(api_user(), [], $condition);
5013 // prepare output of comments
5014 $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
5016 if ($type == "xml") {
5018 foreach ($commentData as $comment) {
5019 $comments[$k++ . ":comment"] = $comment;
5022 foreach ($commentData as $comment) {
5023 $comments[] = $comment;
5026 $data['photo']['friendica_comments'] = $comments;
5028 // include info if rights on photo and rights on item are mismatching
5029 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
5030 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
5031 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
5032 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
5033 $data['photo']['rights_mismatch'] = $rights_mismatch;
5040 * Similar as /mod/redir.php
5041 * redirect to 'url' after dfrn auth
5043 * Why this when there is mod/redir.php already?
5044 * This use api_user() and api_login()
5047 * c_url: url of remote contact to auth to
5048 * url: string, url to redirect after auth
5050 function api_friendica_remoteauth()
5052 $url = $_GET['url'] ?? '';
5053 $c_url = $_GET['c_url'] ?? '';
5055 if ($url === '' || $c_url === '') {
5056 throw new BadRequestException("Wrong parameters.");
5059 $c_url = Strings::normaliseLink($c_url);
5063 $contact = DBA::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
5065 if (!DBA::isResult($contact) || ($contact['network'] !== Protocol::DFRN)) {
5066 throw new BadRequestException("Unknown contact");
5069 $cid = $contact['id'];
5071 $dfrn_id = $contact['issued-id'] ?? $contact['dfrn-id'];
5073 if ($contact['duplex'] && $contact['issued-id']) {
5074 $orig_id = $contact['issued-id'];
5075 $dfrn_id = '1:' . $orig_id;
5077 if ($contact['duplex'] && $contact['dfrn-id']) {
5078 $orig_id = $contact['dfrn-id'];
5079 $dfrn_id = '0:' . $orig_id;
5082 $sec = Strings::getRandomHex();
5084 $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
5085 'sec' => $sec, 'expire' => time() + 45];
5086 DBA::insert('profile_check', $fields);
5088 Logger::info(API_LOG_PREFIX . 'for contact {contact}', ['module' => 'api', 'action' => 'friendica_remoteauth', 'contact' => $contact['name'], 'hey' => $sec]);
5089 $dest = ($url ? '&destination_url=' . $url : '');
5091 System::externalRedirect(
5092 $contact['poll'] . '?dfrn_id=' . $dfrn_id
5093 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
5094 . '&type=profile&sec=' . $sec . $dest
5097 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
5100 * Return an item with announcer data if it had been announced
5102 * @param array $item Item array
5103 * @return array Item array with announce data
5105 function api_get_announce($item)
5107 // Quit if the item already has got a different owner and author
5108 if ($item['owner-id'] != $item['author-id']) {
5112 // Don't change original or Diaspora posts
5113 if ($item['origin'] || in_array($item['network'], [Protocol::DIASPORA])) {
5117 // Quit if we do now the original author and it had been a post from a native network
5118 if (!empty($item['contact-uid']) && in_array($item['network'], Protocol::NATIVE_SUPPORT)) {
5122 $fields = ['author-id', 'author-name', 'author-link', 'author-avatar'];
5123 $activity = Item::activityToIndex(Activity::ANNOUNCE);
5124 $condition = ['parent-uri' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY, 'uid' => [0, $item['uid']], 'activity' => $activity];
5125 $announce = Item::selectFirstForUser($item['uid'], $fields, $condition, ['order' => ['received' => true]]);
5126 if (!DBA::isResult($announce)) {
5130 return array_merge($item, $announce);
5134 * @brief Return the item shared, if the item contains only the [share] tag
5136 * @param array $item Sharer item
5137 * @return array|false Shared item or false if not a reshare
5138 * @throws ImagickException
5139 * @throws InternalServerErrorException
5141 function api_share_as_retweet(&$item)
5143 $body = trim($item["body"]);
5145 if (Diaspora::isReshare($body, false) === false) {
5146 if ($item['author-id'] == $item['owner-id']) {
5149 // Reshares from OStatus, ActivityPub and Twitter
5150 $reshared_item = $item;
5151 $reshared_item['owner-id'] = $reshared_item['author-id'];
5152 $reshared_item['owner-link'] = $reshared_item['author-link'];
5153 $reshared_item['owner-name'] = $reshared_item['author-name'];
5154 $reshared_item['owner-avatar'] = $reshared_item['author-avatar'];
5155 return $reshared_item;
5159 $reshared = Item::getShareArray($item);
5160 if (empty($reshared)) {
5164 $reshared_item = $item;
5166 if (empty($reshared['shared']) || empty($reshared['profile']) || empty($reshared['author']) || empty($reshared['avatar']) || empty($reshared['posted'])) {
5170 if (!empty($reshared['comment'])) {
5171 $item['body'] = $reshared['comment'];
5174 $reshared_item["share-pre-body"] = $reshared['comment'];
5175 $reshared_item["body"] = $reshared['shared'];
5176 $reshared_item["author-id"] = Contact::getIdForURL($reshared['profile'], 0, true);
5177 $reshared_item["author-name"] = $reshared['author'];
5178 $reshared_item["author-link"] = $reshared['profile'];
5179 $reshared_item["author-avatar"] = $reshared['avatar'];
5180 $reshared_item["plink"] = $reshared['link'] ?? '';
5181 $reshared_item["created"] = $reshared['posted'];
5182 $reshared_item["edited"] = $reshared['posted'];
5184 return $reshared_item;
5189 * @param string $profile
5191 * @return string|false
5192 * @throws InternalServerErrorException
5193 * @todo remove trailing junk from profile url
5194 * @todo pump.io check has to check the website
5196 function api_get_nick($profile)
5201 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5202 DBA::escape(Strings::normaliseLink($profile))
5205 if (DBA::isResult($r)) {
5206 $nick = $r[0]["nick"];
5211 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5212 DBA::escape(Strings::normaliseLink($profile))
5215 if (DBA::isResult($r)) {
5216 $nick = $r[0]["nick"];
5221 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
5222 if ($friendica != $profile) {
5228 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
5229 if ($diaspora != $profile) {
5235 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
5236 if ($twitter != $profile) {
5243 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
5244 if ($StatusnetHost != $profile) {
5245 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
5246 if ($StatusnetUser != $profile) {
5247 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
5248 $user = json_decode($UserData);
5250 $nick = $user->screen_name;
5256 // To-Do: look at the page if its really a pumpio site
5257 //if (!$nick == "") {
5258 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
5259 // if ($pumpio != $profile)
5261 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5274 * @param array $item
5279 function api_in_reply_to($item)
5283 $in_reply_to['status_id'] = null;
5284 $in_reply_to['user_id'] = null;
5285 $in_reply_to['status_id_str'] = null;
5286 $in_reply_to['user_id_str'] = null;
5287 $in_reply_to['screen_name'] = null;
5289 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5290 $parent = Item::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
5291 if (DBA::isResult($parent)) {
5292 $in_reply_to['status_id'] = intval($parent['id']);
5294 $in_reply_to['status_id'] = intval($item['parent']);
5297 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5299 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
5300 $parent = Item::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
5302 if (DBA::isResult($parent)) {
5303 if ($parent['author-nick'] == "") {
5304 $parent['author-nick'] = api_get_nick($parent['author-link']);
5307 $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
5308 $in_reply_to['user_id'] = intval($parent['author-id']);
5309 $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
5312 // There seems to be situation, where both fields are identical:
5313 // https://github.com/friendica/friendica/issues/1010
5314 // This is a bugfix for that.
5315 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5316 Logger::warning(API_LOG_PREFIX . 'ID {id} is similar to reply-to {reply-to}', ['module' => 'api', 'action' => 'in_reply_to', 'id' => $item['id'], 'reply-to' => $in_reply_to['status_id']]);
5317 $in_reply_to['status_id'] = null;
5318 $in_reply_to['user_id'] = null;
5319 $in_reply_to['status_id_str'] = null;
5320 $in_reply_to['user_id_str'] = null;
5321 $in_reply_to['screen_name'] = null;
5325 return $in_reply_to;
5330 * @param string $text
5333 * @throws InternalServerErrorException
5335 function api_clean_plain_items($text)
5337 $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
5339 $text = BBCode::cleanPictureLinks($text);
5340 $URLSearchString = "^\[\]";
5342 $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
5344 if ($include_entities == "true") {
5345 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5348 // Simplify "attachment" element
5349 $text = BBCode::removeAttachment($text);
5356 * @param array $contacts
5360 function api_best_nickname(&$contacts)
5364 if (count($contacts) == 0) {
5368 foreach ($contacts as $contact) {
5369 if ($contact["network"] == "") {
5370 $contact["network"] = "dfrn";
5371 $best_contact = [$contact];
5375 if (sizeof($best_contact) == 0) {
5376 foreach ($contacts as $contact) {
5377 if ($contact["network"] == "dfrn") {
5378 $best_contact = [$contact];
5383 if (sizeof($best_contact) == 0) {
5384 foreach ($contacts as $contact) {
5385 if ($contact["network"] == "dspr") {
5386 $best_contact = [$contact];
5391 if (sizeof($best_contact) == 0) {
5392 foreach ($contacts as $contact) {
5393 if ($contact["network"] == "stat") {
5394 $best_contact = [$contact];
5399 if (sizeof($best_contact) == 0) {
5400 foreach ($contacts as $contact) {
5401 if ($contact["network"] == "pump") {
5402 $best_contact = [$contact];
5407 if (sizeof($best_contact) == 0) {
5408 foreach ($contacts as $contact) {
5409 if ($contact["network"] == "twit") {
5410 $best_contact = [$contact];
5415 if (sizeof($best_contact) == 1) {
5416 $contacts = $best_contact;
5418 $contacts = [$contacts[0]];
5423 * Return all or a specified group of the user with the containing contacts.
5425 * @param string $type Return type (atom, rss, xml, json)
5427 * @return array|string
5428 * @throws BadRequestException
5429 * @throws ForbiddenException
5430 * @throws ImagickException
5431 * @throws InternalServerErrorException
5432 * @throws UnauthorizedException
5434 function api_friendica_group_show($type)
5438 if (api_user() === false) {
5439 throw new ForbiddenException();
5443 $user_info = api_get_user($a);
5444 $gid = $_REQUEST['gid'] ?? 0;
5445 $uid = $user_info['uid'];
5447 // get data of the specified group id or all groups if not specified
5450 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5454 // error message if specified gid is not in database
5455 if (!DBA::isResult($r)) {
5456 throw new BadRequestException("gid not available");
5460 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5465 // loop through all groups and retrieve all members for adding data in the user array
5467 foreach ($r as $rr) {
5468 $members = Contact::getByGroupId($rr['id']);
5471 if ($type == "xml") {
5472 $user_element = "users";
5474 foreach ($members as $member) {
5475 $user = api_get_user($a, $member['nurl']);
5476 $users[$k++.":user"] = $user;
5479 $user_element = "user";
5480 foreach ($members as $member) {
5481 $user = api_get_user($a, $member['nurl']);
5485 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5487 return api_format_data("groups", $type, ['group' => $grps]);
5489 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5493 * Delete the specified group of the user.
5495 * @param string $type Return type (atom, rss, xml, json)
5497 * @return array|string
5498 * @throws BadRequestException
5499 * @throws ForbiddenException
5500 * @throws ImagickException
5501 * @throws InternalServerErrorException
5502 * @throws UnauthorizedException
5504 function api_friendica_group_delete($type)
5508 if (api_user() === false) {
5509 throw new ForbiddenException();
5513 $user_info = api_get_user($a);
5514 $gid = $_REQUEST['gid'] ?? 0;
5515 $name = $_REQUEST['name'] ?? '';
5516 $uid = $user_info['uid'];
5518 // error if no gid specified
5519 if ($gid == 0 || $name == "") {
5520 throw new BadRequestException('gid or name not specified');
5523 // get data of the specified group id
5525 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5529 // error message if specified gid is not in database
5530 if (!DBA::isResult($r)) {
5531 throw new BadRequestException('gid not available');
5534 // get data of the specified group id and group name
5536 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5541 // error message if specified gid is not in database
5542 if (!DBA::isResult($rname)) {
5543 throw new BadRequestException('wrong group name');
5547 $ret = Group::removeByName($uid, $name);
5550 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5551 return api_format_data("group_delete", $type, ['result' => $success]);
5553 throw new BadRequestException('other API error');
5556 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5561 * @param string $type Return type (atom, rss, xml, json)
5563 * @return array|string
5564 * @throws BadRequestException
5565 * @throws ForbiddenException
5566 * @throws ImagickException
5567 * @throws InternalServerErrorException
5568 * @throws UnauthorizedException
5569 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5571 function api_lists_destroy($type)
5575 if (api_user() === false) {
5576 throw new ForbiddenException();
5580 $user_info = api_get_user($a);
5581 $gid = $_REQUEST['list_id'] ?? 0;
5582 $uid = $user_info['uid'];
5584 // error if no gid specified
5586 throw new BadRequestException('gid not specified');
5589 // get data of the specified group id
5590 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5591 // error message if specified gid is not in database
5593 throw new BadRequestException('gid not available');
5596 if (Group::remove($gid)) {
5598 'name' => $group['name'],
5599 'id' => intval($gid),
5600 'id_str' => (string) $gid,
5601 'user' => $user_info
5604 return api_format_data("lists", $type, ['lists' => $list]);
5607 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5610 * Add a new group to the database.
5612 * @param string $name Group name
5613 * @param int $uid User ID
5614 * @param array $users List of users to add to the group
5617 * @throws BadRequestException
5619 function group_create($name, $uid, $users = [])
5621 // error if no name specified
5623 throw new BadRequestException('group name not specified');
5626 // get data of the specified group name
5628 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5632 // error message if specified group name already exists
5633 if (DBA::isResult($rname)) {
5634 throw new BadRequestException('group name already exists');
5637 // check if specified group name is a deleted group
5639 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5643 // error message if specified group name already exists
5644 if (DBA::isResult($rname)) {
5645 $reactivate_group = true;
5649 $ret = Group::create($uid, $name);
5651 $gid = Group::getIdByName($uid, $name);
5653 throw new BadRequestException('other API error');
5657 $erroraddinguser = false;
5659 foreach ($users as $user) {
5660 $cid = $user['cid'];
5661 // check if user really exists as contact
5663 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5667 if (count($contact)) {
5668 Group::addMember($gid, $cid);
5670 $erroraddinguser = true;
5671 $errorusers[] = $cid;
5675 // return success message incl. missing users in array
5676 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5678 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5682 * Create the specified group with the posted array of contacts.
5684 * @param string $type Return type (atom, rss, xml, json)
5686 * @return array|string
5687 * @throws BadRequestException
5688 * @throws ForbiddenException
5689 * @throws ImagickException
5690 * @throws InternalServerErrorException
5691 * @throws UnauthorizedException
5693 function api_friendica_group_create($type)
5697 if (api_user() === false) {
5698 throw new ForbiddenException();
5702 $user_info = api_get_user($a);
5703 $name = $_REQUEST['name'] ?? '';
5704 $uid = $user_info['uid'];
5705 $json = json_decode($_POST['json'], true);
5706 $users = $json['user'];
5708 $success = group_create($name, $uid, $users);
5710 return api_format_data("group_create", $type, ['result' => $success]);
5712 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5715 * Create a new group.
5717 * @param string $type Return type (atom, rss, xml, json)
5719 * @return array|string
5720 * @throws BadRequestException
5721 * @throws ForbiddenException
5722 * @throws ImagickException
5723 * @throws InternalServerErrorException
5724 * @throws UnauthorizedException
5725 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5727 function api_lists_create($type)
5731 if (api_user() === false) {
5732 throw new ForbiddenException();
5736 $user_info = api_get_user($a);
5737 $name = $_REQUEST['name'] ?? '';
5738 $uid = $user_info['uid'];
5740 $success = group_create($name, $uid);
5741 if ($success['success']) {
5743 'name' => $success['name'],
5744 'id' => intval($success['gid']),
5745 'id_str' => (string) $success['gid'],
5746 'user' => $user_info
5749 return api_format_data("lists", $type, ['lists'=>$grp]);
5752 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5755 * Update the specified group with the posted array of contacts.
5757 * @param string $type Return type (atom, rss, xml, json)
5759 * @return array|string
5760 * @throws BadRequestException
5761 * @throws ForbiddenException
5762 * @throws ImagickException
5763 * @throws InternalServerErrorException
5764 * @throws UnauthorizedException
5766 function api_friendica_group_update($type)
5770 if (api_user() === false) {
5771 throw new ForbiddenException();
5775 $user_info = api_get_user($a);
5776 $uid = $user_info['uid'];
5777 $gid = $_REQUEST['gid'] ?? 0;
5778 $name = $_REQUEST['name'] ?? '';
5779 $json = json_decode($_POST['json'], true);
5780 $users = $json['user'];
5782 // error if no name specified
5784 throw new BadRequestException('group name not specified');
5787 // error if no gid specified
5789 throw new BadRequestException('gid not specified');
5793 $members = Contact::getByGroupId($gid);
5794 foreach ($members as $member) {
5795 $cid = $member['id'];
5796 foreach ($users as $user) {
5797 $found = ($user['cid'] == $cid ? true : false);
5799 if (!isset($found) || !$found) {
5800 Group::removeMemberByName($uid, $name, $cid);
5805 $erroraddinguser = false;
5807 foreach ($users as $user) {
5808 $cid = $user['cid'];
5809 // check if user really exists as contact
5811 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5816 if (count($contact)) {
5817 Group::addMember($gid, $cid);
5819 $erroraddinguser = true;
5820 $errorusers[] = $cid;
5824 // return success message incl. missing users in array
5825 $status = ($erroraddinguser ? "missing user" : "ok");
5826 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5827 return api_format_data("group_update", $type, ['result' => $success]);
5830 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5833 * Update information about a group.
5835 * @param string $type Return type (atom, rss, xml, json)
5837 * @return array|string
5838 * @throws BadRequestException
5839 * @throws ForbiddenException
5840 * @throws ImagickException
5841 * @throws InternalServerErrorException
5842 * @throws UnauthorizedException
5843 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5845 function api_lists_update($type)
5849 if (api_user() === false) {
5850 throw new ForbiddenException();
5854 $user_info = api_get_user($a);
5855 $gid = $_REQUEST['list_id'] ?? 0;
5856 $name = $_REQUEST['name'] ?? '';
5857 $uid = $user_info['uid'];
5859 // error if no gid specified
5861 throw new BadRequestException('gid not specified');
5864 // get data of the specified group id
5865 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5866 // error message if specified gid is not in database
5868 throw new BadRequestException('gid not available');
5871 if (Group::update($gid, $name)) {
5874 'id' => intval($gid),
5875 'id_str' => (string) $gid,
5876 'user' => $user_info
5879 return api_format_data("lists", $type, ['lists' => $list]);
5883 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5887 * @param string $type Return type (atom, rss, xml, json)
5889 * @return array|string
5890 * @throws BadRequestException
5891 * @throws ForbiddenException
5892 * @throws ImagickException
5893 * @throws InternalServerErrorException
5895 function api_friendica_activity($type)
5899 if (api_user() === false) {
5900 throw new ForbiddenException();
5902 $verb = strtolower($a->argv[3]);
5903 $verb = preg_replace("|\..*$|", "", $verb);
5905 $id = $_REQUEST['id'] ?? 0;
5907 $res = Item::performLike($id, $verb);
5910 if ($type == "xml") {
5915 return api_format_data('ok', $type, ['ok' => $ok]);
5917 throw new BadRequestException('Error adding activity');
5921 /// @TODO move to top of file or somewhere better
5922 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5923 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5924 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5925 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5926 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5927 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5928 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5929 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5930 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5931 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5934 * @brief Returns notifications
5936 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5937 * @return string|array
5938 * @throws BadRequestException
5939 * @throws ForbiddenException
5940 * @throws InternalServerErrorException
5942 function api_friendica_notification($type)
5946 if (api_user() === false) {
5947 throw new ForbiddenException();
5950 throw new BadRequestException("Invalid argument count");
5952 /** @var Notify $nm */
5953 $nm = BaseObject::getClass(Notify::class);
5955 $notes = $nm->getAll([], ['seen' => 'ASC', 'date' => 'DESC'], 50);
5957 if ($type == "xml") {
5959 if (!empty($notes)) {
5960 foreach ($notes as $note) {
5961 $xmlnotes[] = ["@attributes" => $note];
5967 return api_format_data("notes", $type, ['note' => $notes]);
5971 * POST request with 'id' param as notification id
5973 * @brief Set notification as seen and returns associated item (if possible)
5975 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5976 * @return string|array
5977 * @throws BadRequestException
5978 * @throws ForbiddenException
5979 * @throws ImagickException
5980 * @throws InternalServerErrorException
5981 * @throws UnauthorizedException
5983 function api_friendica_notification_seen($type)
5986 $user_info = api_get_user($a);
5988 if (api_user() === false || $user_info === false) {
5989 throw new ForbiddenException();
5992 throw new BadRequestException("Invalid argument count");
5995 $id = (!empty($_REQUEST['id']) ? intval($_REQUEST['id']) : 0);
5997 /** @var Notify $nm */
5998 $nm = BaseObject::getClass(Notify::class);
5999 $note = $nm->getByID($id);
6000 if (is_null($note)) {
6001 throw new BadRequestException("Invalid argument");
6004 $nm->setSeen($note);
6005 if ($note['otype']=='item') {
6006 // would be really better with an ItemsManager and $im->getByID() :-P
6007 $item = Item::selectFirstForUser(api_user(), [], ['id' => $note['iid'], 'uid' => api_user()]);
6008 if (DBA::isResult($item)) {
6009 // we found the item, return it to the user
6010 $ret = api_format_items([$item], $user_info, false, $type);
6011 $data = ['status' => $ret];
6012 return api_format_data("status", $type, $data);
6014 // the item can't be found, but we set the note as seen, so we count this as a success
6016 return api_format_data('result', $type, ['result' => "success"]);
6019 /// @TODO move to top of file or somewhere better
6020 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
6021 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
6024 * @brief update a direct_message to seen state
6026 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6027 * @return string|array (success result=ok, error result=error with error message)
6028 * @throws BadRequestException
6029 * @throws ForbiddenException
6030 * @throws ImagickException
6031 * @throws InternalServerErrorException
6032 * @throws UnauthorizedException
6034 function api_friendica_direct_messages_setseen($type)
6037 if (api_user() === false) {
6038 throw new ForbiddenException();
6042 $user_info = api_get_user($a);
6043 $uid = $user_info['uid'];
6044 $id = $_REQUEST['id'] ?? 0;
6046 // return error if id is zero
6048 $answer = ['result' => 'error', 'message' => 'message id not specified'];
6049 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6052 // error message if specified id is not in database
6053 if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
6054 $answer = ['result' => 'error', 'message' => 'message id not in database'];
6055 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6058 // update seen indicator
6059 $result = DBA::update('mail', ['seen' => true], ['id' => $id]);
6063 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
6064 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
6066 $answer = ['result' => 'error', 'message' => 'unknown error'];
6067 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6071 /// @TODO move to top of file or somewhere better
6072 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
6075 * @brief search for direct_messages containing a searchstring through api
6077 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6078 * @param string $box
6079 * @return string|array (success: success=true if found and search_result contains found messages,
6080 * success=false if nothing was found, search_result='nothing found',
6081 * error: result=error with error message)
6082 * @throws BadRequestException
6083 * @throws ForbiddenException
6084 * @throws ImagickException
6085 * @throws InternalServerErrorException
6086 * @throws UnauthorizedException
6088 function api_friendica_direct_messages_search($type, $box = "")
6092 if (api_user() === false) {
6093 throw new ForbiddenException();
6097 $user_info = api_get_user($a);
6098 $searchstring = $_REQUEST['searchstring'] ?? '';
6099 $uid = $user_info['uid'];
6101 // error if no searchstring specified
6102 if ($searchstring == "") {
6103 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
6104 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
6107 // get data for the specified searchstring
6109 "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",
6111 DBA::escape('%'.$searchstring.'%')
6114 $profile_url = $user_info["url"];
6116 // message if nothing was found
6117 if (!DBA::isResult($r)) {
6118 $success = ['success' => false, 'search_results' => 'problem with query'];
6119 } elseif (count($r) == 0) {
6120 $success = ['success' => false, 'search_results' => 'nothing found'];
6123 foreach ($r as $item) {
6124 if ($box == "inbox" || $item['from-url'] != $profile_url) {
6125 $recipient = $user_info;
6126 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
6127 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
6128 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
6129 $sender = $user_info;
6132 if (isset($recipient) && isset($sender)) {
6133 $ret[] = api_format_messages($item, $recipient, $sender);
6136 $success = ['success' => true, 'search_results' => $ret];
6139 return api_format_data("direct_message_search", $type, ['$result' => $success]);
6142 /// @TODO move to top of file or somewhere better
6143 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
6146 * @brief return data of all the profiles a user has to the client
6148 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6149 * @return string|array
6150 * @throws BadRequestException
6151 * @throws ForbiddenException
6152 * @throws ImagickException
6153 * @throws InternalServerErrorException
6154 * @throws UnauthorizedException
6156 function api_friendica_profile_show($type)
6160 if (api_user() === false) {
6161 throw new ForbiddenException();
6165 $profile_id = $_REQUEST['profile_id'] ?? 0;
6167 // retrieve general information about profiles for user
6168 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
6169 $directory = Config::get('system', 'directory');
6171 // get data of the specified profile id or all profiles of the user if not specified
6172 if ($profile_id != 0) {
6173 $r = Profile::getById(api_user(), $profile_id);
6174 // error message if specified gid is not in database
6175 if (!DBA::isResult($r)) {
6176 throw new BadRequestException("profile_id not available");
6179 $r = Profile::getListByUser(api_user());
6181 // loop through all returned profiles and retrieve data and users
6184 if (DBA::isResult($r)) {
6185 foreach ($r as $rr) {
6186 $profile = api_format_items_profiles($rr);
6188 // select all users from contact table, loop and prepare standard return for user data
6190 $nurls = Contact::selectToArray(['id', 'nurl'], ['uid' => api_user(), 'profile-id' => $rr['id']]);
6191 foreach ($nurls as $nurl) {
6192 $user = api_get_user($a, $nurl['nurl']);
6193 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
6195 $profile['users'] = $users;
6197 // add prepared profile data to array for final return
6198 if ($type == "xml") {
6199 $profiles[$k++ . ":profile"] = $profile;
6201 $profiles[] = $profile;
6206 // return settings, authenticated user and profiles data
6207 $self = DBA::selectFirst('contact', ['nurl'], ['uid' => api_user(), 'self' => true]);
6209 $result = ['multi_profiles' => $multi_profiles ? true : false,
6210 'global_dir' => $directory,
6211 'friendica_owner' => api_get_user($a, $self['nurl']),
6212 'profiles' => $profiles];
6213 return api_format_data("friendica_profiles", $type, ['$result' => $result]);
6215 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
6218 * Returns a list of saved searches.
6220 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
6222 * @param string $type Return format: json or xml
6224 * @return string|array
6227 function api_saved_searches_list($type)
6229 $terms = DBA::select('search', ['id', 'term'], ['uid' => local_user()]);
6232 while ($term = DBA::fetch($terms)) {
6234 'created_at' => api_date(time()),
6235 'id' => intval($term['id']),
6236 'id_str' => $term['id'],
6237 'name' => $term['term'],
6239 'query' => $term['term']
6245 return api_format_data("terms", $type, ['terms' => $result]);
6248 /// @TODO move to top of file or somewhere better
6249 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
6252 * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
6254 * @brief Number of comments
6256 * @param object $data [Status, Status]
6260 function bindComments(&$data)
6262 if (count($data) == 0) {
6268 foreach ($data as $item) {
6269 $ids[] = $item['id'];
6272 $idStr = DBA::escape(implode(', ', $ids));
6273 $sql = "SELECT `parent`, COUNT(*) as comments FROM `item` WHERE `parent` IN ($idStr) AND `deleted` = ? AND `gravity`= ? GROUP BY `parent`";
6274 $items = DBA::p($sql, 0, GRAVITY_COMMENT);
6275 $itemsData = DBA::toArray($items);
6277 foreach ($itemsData as $item) {
6278 $comments[$item['parent']] = $item['comments'];
6281 foreach ($data as $idx => $item) {
6283 $data[$idx]['friendica_comments'] = isset($comments[$id]) ? $comments[$id] : 0;
6288 @TODO Maybe open to implement?
6290 [pagename] => api/1.1/statuses/lookup.json
6291 [id] => 605138389168451584
6292 [include_cards] => true
6293 [cards_platform] => Android-12
6294 [include_entities] => true
6295 [include_my_retweet] => 1
6297 [include_reply_count] => true
6298 [include_descendent_reply_count] => true
6302 Not implemented by now:
6303 statuses/retweets_of_me
6308 account/update_location
6309 account/update_profile_background_image
6312 friendica/profile/update
6313 friendica/profile/create
6314 friendica/profile/delete
6316 Not implemented in status.net:
6317 statuses/retweeted_to_me
6318 statuses/retweeted_by_me
6319 direct_messages/destroy
6321 account/update_delivery_device
6322 notifications/follow