3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 * Friendica implementation of statusnet/twitter API
22 * @file include/api.php
23 * @todo Automatically detect if incoming data is HTML or BBCode
27 use Friendica\Content\ContactSelector;
28 use Friendica\Content\Text\BBCode;
29 use Friendica\Content\Text\HTML;
30 use Friendica\Core\Hook;
31 use Friendica\Core\Logger;
32 use Friendica\Core\Protocol;
33 use Friendica\Core\Session;
34 use Friendica\Core\System;
35 use Friendica\Core\Worker;
36 use Friendica\Database\DBA;
38 use Friendica\Model\Contact;
39 use Friendica\Model\Group;
40 use Friendica\Model\Item;
41 use Friendica\Model\Mail;
42 use Friendica\Model\Notification;
43 use Friendica\Model\Photo;
44 use Friendica\Model\Post;
45 use Friendica\Model\User;
46 use Friendica\Model\Verb;
47 use Friendica\Network\HTTPException;
48 use Friendica\Network\HTTPException\BadRequestException;
49 use Friendica\Network\HTTPException\ExpectationFailedException;
50 use Friendica\Network\HTTPException\ForbiddenException;
51 use Friendica\Network\HTTPException\InternalServerErrorException;
52 use Friendica\Network\HTTPException\MethodNotAllowedException;
53 use Friendica\Network\HTTPException\NotFoundException;
54 use Friendica\Network\HTTPException\TooManyRequestsException;
55 use Friendica\Network\HTTPException\UnauthorizedException;
56 use Friendica\Object\Image;
57 use Friendica\Protocol\Activity;
58 use Friendica\Protocol\Diaspora;
59 use Friendica\Security\FKOAuth1;
60 use Friendica\Security\OAuth1\OAuthRequest;
61 use Friendica\Security\OAuth1\OAuthUtil;
62 use Friendica\Util\DateTimeFormat;
63 use Friendica\Util\Images;
64 use Friendica\Util\Network;
65 use Friendica\Util\Proxy as ProxyUtils;
66 use Friendica\Util\Strings;
67 use Friendica\Util\XML;
69 require_once __DIR__ . '/../mod/item.php';
70 require_once __DIR__ . '/../mod/wall_upload.php';
72 define('API_METHOD_ANY', '*');
73 define('API_METHOD_GET', 'GET');
74 define('API_METHOD_POST', 'POST,PUT');
75 define('API_METHOD_DELETE', 'POST,DELETE');
77 define('API_LOG_PREFIX', 'API {action} - ');
85 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
86 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
87 * into a page, and visitors will post something without noticing it).
91 if (!empty($_SESSION['allow_api'])) {
99 * Get source name from API client
101 * Clients can send 'source' parameter to be show in post metadata
102 * as "sent via <source>".
103 * Some clients doesn't send a source param, we support ones we know
104 * (only Twidere, atm)
107 * Client source name, default to "api" if unset/unknown
110 function api_source()
112 if (requestdata('source')) {
113 return requestdata('source');
116 // Support for known clients that doesn't send a source name
117 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
118 if(strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
122 Logger::info(API_LOG_PREFIX . 'Unrecognized user-agent', ['module' => 'api', 'action' => 'source', 'http_user_agent' => $_SERVER['HTTP_USER_AGENT']]);
124 Logger::info(API_LOG_PREFIX . 'Empty user-agent', ['module' => 'api', 'action' => 'source']);
131 * Format date for API
133 * @param string $str Source date, as UTC
134 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
137 function api_date($str)
139 // Wed May 23 06:01:13 +0000 2007
140 return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
144 * Register a function to be the endpoint for defined API path.
146 * @param string $path API URL path, relative to DI::baseUrl()
147 * @param string $func Function name to call on path request
148 * @param bool $auth API need logged user
149 * @param string $method HTTP method reqiured to call this endpoint.
150 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
151 * Default to API_METHOD_ANY
153 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
163 // Workaround for hotot
164 $path = str_replace("api/", "api/1.1/", $path);
174 * Log in user via OAuth1 or Simple HTTP Auth.
175 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
178 * @throws ForbiddenException
179 * @throws InternalServerErrorException
180 * @throws UnauthorizedException
181 * @hook 'authenticate'
183 * 'username' => username from login form
184 * 'password' => password from login form
185 * 'authenticated' => return status,
186 * 'user_record' => return authenticated user record
188 function api_login(App $a)
190 // workaround for HTTP-auth in CGI mode
191 if (!empty($_SERVER['REDIRECT_REMOTE_USER'])) {
192 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6));
193 if (strlen($userpass)) {
194 list($name, $password) = explode(':', $userpass);
195 $_SERVER['PHP_AUTH_USER'] = $name;
196 $_SERVER['PHP_AUTH_PW'] = $password;
200 if (empty($_SERVER['PHP_AUTH_USER'])) {
201 // Try OAuth when no user is provided
202 $oauth1 = new FKOAuth1();
205 $request = OAuthRequest::from_request();
206 list($consumer, $token) = $oauth1->verify_request($request);
207 if (!is_null($token)) {
208 $oauth1->loginUser($token->uid);
209 Session::set('allow_api', true);
212 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
213 var_dump($consumer, $token);
215 } catch (Exception $e) {
216 Logger::warning(API_LOG_PREFIX . 'OAuth error', ['module' => 'api', 'action' => 'login', 'exception' => $e->getMessage()]);
219 Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]);
220 header('WWW-Authenticate: Basic realm="Friendica"');
221 throw new UnauthorizedException("This API requires login");
224 $user = $_SERVER['PHP_AUTH_USER'] ?? '';
225 $password = $_SERVER['PHP_AUTH_PW'] ?? '';
227 // allow "user@server" login (but ignore 'server' part)
228 $at = strstr($user, "@", true);
233 // next code from mod/auth.php. needs better solution
237 'username' => trim($user),
238 'password' => trim($password),
239 'authenticated' => 0,
240 'user_record' => null,
244 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
245 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
246 * and later addons should not interfere with an earlier one that succeeded.
248 Hook::callAll('authenticate', $addon_auth);
250 if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
251 $record = $addon_auth['user_record'];
253 $user_id = User::authenticate(trim($user), trim($password), true);
254 if ($user_id !== false) {
255 $record = DBA::selectFirst('user', [], ['uid' => $user_id]);
259 if (!DBA::isResult($record)) {
260 Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]);
261 header('WWW-Authenticate: Basic realm="Friendica"');
262 //header('HTTP/1.0 401 Unauthorized');
263 //die('This api requires login');
264 throw new UnauthorizedException("This API requires login");
267 // Don't refresh the login date more often than twice a day to spare database writes
268 $login_refresh = strcmp(DateTimeFormat::utc('now - 12 hours'), $record['login_date']) > 0;
270 DI::auth()->setForUser($a, $record, false, false, $login_refresh);
272 $_SESSION["allow_api"] = true;
274 Hook::callAll('logged_in', $a->user);
278 * Check HTTP method of called API
280 * API endpoints can define which HTTP method to accept when called.
281 * This function check the current HTTP method agains endpoint
284 * @param string $method Required methods, uppercase, separated by comma
287 function api_check_method($method)
289 if ($method == "*") {
292 return (stripos($method, $_SERVER['REQUEST_METHOD'] ?? 'GET') !== false);
296 * Main API entry point
298 * Authenticate user, call registered API function, set HTTP headers
301 * @param App\Arguments $args The app arguments (optional, will retrieved by the DI-Container in case of missing)
302 * @return string|array API call result
305 function api_call(App $a, App\Arguments $args = null)
307 global $API, $called_api;
314 if (strpos($args->getCommand(), ".xml") > 0) {
317 if (strpos($args->getCommand(), ".json") > 0) {
320 if (strpos($args->getCommand(), ".rss") > 0) {
323 if (strpos($args->getCommand(), ".atom") > 0) {
328 foreach ($API as $p => $info) {
329 if (strpos($args->getCommand(), $p) === 0) {
330 if (!api_check_method($info['method'])) {
331 throw new MethodNotAllowedException();
334 $called_api = explode("/", $p);
336 if (!empty($info['auth']) && api_user() === false) {
338 Logger::info(API_LOG_PREFIX . 'username {username}', ['module' => 'api', 'action' => 'call', 'username' => $a->user['username']]);
341 Logger::debug(API_LOG_PREFIX . 'parameters', ['module' => 'api', 'action' => 'call', 'parameters' => $_REQUEST]);
343 $stamp = microtime(true);
344 $return = call_user_func($info['func'], $type);
345 $duration = floatval(microtime(true) - $stamp);
347 Logger::info(API_LOG_PREFIX . 'duration {duration}', ['module' => 'api', 'action' => 'call', 'duration' => round($duration, 2)]);
349 DI::profiler()->saveLog(DI::logger(), API_LOG_PREFIX . 'performance');
351 if (false === $return) {
353 * api function returned false withour throw an
354 * exception. This should not happend, throw a 500
356 throw new InternalServerErrorException();
361 header("Content-Type: text/xml");
364 header("Content-Type: application/json");
365 if (!empty($return)) {
366 $json = json_encode(end($return));
367 if (!empty($_GET['callback'])) {
368 $json = $_GET['callback'] . "(" . $json . ")";
374 header("Content-Type: application/rss+xml");
375 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
378 header("Content-Type: application/atom+xml");
379 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
386 Logger::warning(API_LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]);
387 throw new NotFoundException();
388 } catch (HTTPException $e) {
389 header("HTTP/1.1 {$e->getCode()} {$e->httpdesc}");
390 return api_error($type, $e, $args);
395 * Format API error string
397 * @param string $type Return type (xml, json, rss, as)
398 * @param object $e HTTPException Error object
399 * @param App\Arguments $args The App arguments
400 * @return string|array error message formatted as $type
402 function api_error($type, $e, App\Arguments $args)
404 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
405 /// @TODO: https://dev.twitter.com/overview/api/response-codes
407 $error = ["error" => $error,
408 "code" => $e->getCode() . " " . $e->httpdesc,
409 "request" => $args->getQueryString()];
411 $return = api_format_data('status', $type, ['status' => $error]);
415 header("Content-Type: text/xml");
418 header("Content-Type: application/json");
419 $return = json_encode($return);
422 header("Content-Type: application/rss+xml");
425 header("Content-Type: application/atom+xml");
433 * Set values for RSS template
436 * @param array $arr Array to be passed to template
437 * @param array $user_info User info
439 * @throws BadRequestException
440 * @throws ImagickException
441 * @throws InternalServerErrorException
442 * @throws UnauthorizedException
443 * @todo find proper type-hints
445 function api_rss_extra(App $a, $arr, $user_info)
447 if (is_null($user_info)) {
448 $user_info = api_get_user($a);
451 $arr['$user'] = $user_info;
453 'alternate' => $user_info['url'],
454 'self' => DI::baseUrl() . "/" . DI::args()->getQueryString(),
455 'base' => DI::baseUrl(),
456 'updated' => api_date(null),
457 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
458 'language' => $user_info['lang'],
459 'logo' => DI::baseUrl() . "/images/friendica-32.png",
467 * Unique contact to contact url.
469 * @param int $id Contact id
470 * @return bool|string
471 * Contact url or False if contact id is unknown
474 function api_unique_id_to_nurl($id)
476 $r = DBA::selectFirst('contact', ['nurl'], ['id' => $id]);
478 if (DBA::isResult($r)) {
486 * Get user info array.
489 * @param int|string $contact_id Contact ID or URL
491 * @throws BadRequestException
492 * @throws ImagickException
493 * @throws InternalServerErrorException
494 * @throws UnauthorizedException
496 function api_get_user(App $a, $contact_id = null)
504 Logger::info(API_LOG_PREFIX . 'Fetching data for user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $contact_id]);
506 // Searching for contact URL
507 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
508 $user = DBA::escape(Strings::normaliseLink($contact_id));
510 $extra_query = "AND `contact`.`nurl` = '%s' ";
511 if (api_user() !== false) {
512 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
516 // Searching for contact id with uid = 0
517 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
518 $user = DBA::escape(api_unique_id_to_nurl(intval($contact_id)));
521 throw new BadRequestException("User ID ".$contact_id." not found.");
525 $extra_query = "AND `contact`.`nurl` = '%s' ";
526 if (api_user() !== false) {
527 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
531 if (is_null($user) && !empty($_GET['user_id'])) {
532 $user = DBA::escape(api_unique_id_to_nurl($_GET['user_id']));
535 throw new BadRequestException("User ID ".$_GET['user_id']." not found.");
539 $extra_query = "AND `contact`.`nurl` = '%s' ";
540 if (api_user() !== false) {
541 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
544 if (is_null($user) && !empty($_GET['screen_name'])) {
545 $user = DBA::escape($_GET['screen_name']);
546 $extra_query = "AND `contact`.`nick` = '%s' ";
547 if (api_user() !== false) {
548 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
552 if (is_null($user) && !empty($_GET['profileurl'])) {
553 $user = DBA::escape(Strings::normaliseLink($_GET['profileurl']));
554 $extra_query = "AND `contact`.`nurl` = '%s' ";
555 if (api_user() !== false) {
556 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
560 // $called_api is the API path exploded on / and is expected to have at least 2 elements
561 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
562 $argid = count($called_api);
563 if (!empty($a->argv[$argid])) {
564 $data = explode(".", $a->argv[$argid]);
565 if (count($data) > 1) {
566 list($user, $null) = $data;
569 if (is_numeric($user)) {
570 $user = DBA::escape(api_unique_id_to_nurl(intval($user)));
574 $extra_query = "AND `contact`.`nurl` = '%s' ";
575 if (api_user() !== false) {
576 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
580 $user = DBA::escape($user);
581 $extra_query = "AND `contact`.`nick` = '%s' ";
582 if (api_user() !== false) {
583 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
588 Logger::info(API_LOG_PREFIX . 'getting user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user]);
591 if (api_user() === false) {
595 $user = $_SESSION['uid'];
596 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
600 Logger::info(API_LOG_PREFIX . 'found user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user, 'extra_query' => $extra_query]);
604 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
610 // Selecting the id by priority, friendica first
611 if (is_array($uinfo)) {
612 api_best_nickname($uinfo);
615 // if the contact wasn't found, fetch it from the contacts with uid = 0
616 if (!DBA::isResult($uinfo)) {
618 throw new BadRequestException("User not found.");
621 $contact = DBA::selectFirst('contact', [], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
623 if (DBA::isResult($contact)) {
625 'id' => $contact["id"],
626 'id_str' => (string) $contact["id"],
627 'name' => $contact["name"],
628 'screen_name' => (($contact['nick']) ? $contact['nick'] : $contact['name']),
629 'location' => ($contact["location"] != "") ? $contact["location"] : ContactSelector::networkToName($contact['network'], $contact['url'], $contact['protocol']),
630 'description' => BBCode::toPlaintext($contact["about"] ?? ''),
631 'profile_image_url' => $contact["micro"],
632 'profile_image_url_https' => $contact["micro"],
633 'profile_image_url_profile_size' => $contact["thumb"],
634 'profile_image_url_large' => $contact["photo"],
635 'url' => $contact["url"],
636 'protected' => false,
637 'followers_count' => 0,
638 'friends_count' => 0,
640 'created_at' => api_date($contact["created"]),
641 'favourites_count' => 0,
643 'time_zone' => 'UTC',
644 'geo_enabled' => false,
646 'statuses_count' => 0,
648 'contributors_enabled' => false,
649 'is_translator' => false,
650 'is_translation_enabled' => false,
651 'following' => false,
652 'follow_request_sent' => false,
653 'statusnet_blocking' => false,
654 'notifications' => false,
655 'statusnet_profile_url' => $contact["url"],
657 'cid' => Contact::getIdForURL($contact["url"], api_user(), false),
658 'pid' => Contact::getIdForURL($contact["url"], 0, false),
660 'network' => $contact["network"],
665 throw new BadRequestException("User ".$url." not found.");
669 if ($uinfo[0]['self']) {
670 if ($uinfo[0]['network'] == "") {
671 $uinfo[0]['network'] = Protocol::DFRN;
674 $usr = DBA::selectFirst('user', ['default-location'], ['uid' => api_user()]);
675 $profile = DBA::selectFirst('profile', ['about'], ['uid' => api_user(), 'is-default' => true]);
682 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, false);
684 if (!empty($profile['about'])) {
685 $description = $profile['about'];
687 $description = $uinfo[0]["about"];
690 if (!empty($usr['default-location'])) {
691 $location = $usr['default-location'];
692 } elseif (!empty($uinfo[0]["location"])) {
693 $location = $uinfo[0]["location"];
695 $location = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url'], $uinfo[0]['protocol']);
699 'id' => intval($pcontact_id),
700 'id_str' => (string) intval($pcontact_id),
701 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
702 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
703 'location' => $location,
704 'description' => BBCode::toPlaintext($description ?? ''),
705 'profile_image_url' => $uinfo[0]['micro'],
706 'profile_image_url_https' => $uinfo[0]['micro'],
707 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
708 'profile_image_url_large' => $uinfo[0]["photo"],
709 'url' => $uinfo[0]['url'],
710 'protected' => false,
711 'followers_count' => intval($countfollowers),
712 'friends_count' => intval($countfriends),
714 'created_at' => api_date($uinfo[0]['created']),
715 'favourites_count' => intval($starred),
717 'time_zone' => 'UTC',
718 'geo_enabled' => false,
720 'statuses_count' => intval($countitems),
722 'contributors_enabled' => false,
723 'is_translator' => false,
724 'is_translation_enabled' => false,
725 'following' => (($uinfo[0]['rel'] == Contact::FOLLOWER) || ($uinfo[0]['rel'] == Contact::FRIEND)),
726 'follow_request_sent' => false,
727 'statusnet_blocking' => false,
728 'notifications' => false,
730 //'statusnet_profile_url' => DI::baseUrl()."/contact/".$uinfo[0]['cid'],
731 'statusnet_profile_url' => $uinfo[0]['url'],
732 'uid' => intval($uinfo[0]['uid']),
733 'cid' => intval($uinfo[0]['cid']),
734 'pid' => Contact::getIdForURL($uinfo[0]["url"], 0, false),
735 'self' => $uinfo[0]['self'],
736 'network' => $uinfo[0]['network'],
739 // If this is a local user and it uses Frio, we can get its color preferences.
741 $theme_info = DBA::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
742 if ($theme_info['theme'] === 'frio') {
743 $schema = DI::pConfig()->get($ret['uid'], 'frio', 'schema');
745 if ($schema && ($schema != '---')) {
746 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
747 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
748 require_once $schemefile;
751 $nav_bg = DI::pConfig()->get($ret['uid'], 'frio', 'nav_bg');
752 $link_color = DI::pConfig()->get($ret['uid'], 'frio', 'link_color');
753 $bgcolor = DI::pConfig()->get($ret['uid'], 'frio', 'background_color');
755 if (empty($nav_bg)) {
758 if (empty($link_color)) {
759 $link_color = "#6fdbe8";
761 if (empty($bgcolor)) {
762 $bgcolor = "#ededed";
765 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
766 $ret['profile_link_color'] = str_replace('#', '', $link_color);
767 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
775 * return api-formatted array for item's author and owner
778 * @param array $item item from db
779 * @return array(array:author, array:owner)
780 * @throws BadRequestException
781 * @throws ImagickException
782 * @throws InternalServerErrorException
783 * @throws UnauthorizedException
785 function api_item_get_user(App $a, $item)
787 $status_user = api_get_user($a, $item['author-id'] ?? null);
789 $author_user = $status_user;
791 $status_user["protected"] = isset($item['private']) && ($item['private'] == Item::PRIVATE);
793 if (($item['thr-parent'] ?? '') == ($item['uri'] ?? '')) {
794 $owner_user = api_get_user($a, $item['owner-id'] ?? null);
796 $owner_user = $author_user;
799 return ([$status_user, $author_user, $owner_user]);
803 * walks recursively through an array with the possibility to change value and key
805 * @param array $array The array to walk through
806 * @param callable $callback The callback function
808 * @return array the transformed array
810 function api_walk_recursive(array &$array, callable $callback)
814 foreach ($array as $k => $v) {
816 if ($callback($v, $k)) {
817 $new_array[$k] = api_walk_recursive($v, $callback);
820 if ($callback($v, $k)) {
831 * Callback function to transform the array in an array that can be transformed in a XML file
833 * @param mixed $item Array item value
834 * @param string $key Array key
836 * @return boolean Should the array item be deleted?
838 function api_reformat_xml(&$item, &$key)
840 if (is_bool($item)) {
841 $item = ($item ? "true" : "false");
844 if (substr($key, 0, 10) == "statusnet_") {
845 $key = "statusnet:".substr($key, 10);
846 } elseif (substr($key, 0, 10) == "friendica_") {
847 $key = "friendica:".substr($key, 10);
849 /// @TODO old-lost code?
851 // $key = "default:".$key;
857 * Creates the XML from a JSON style array
859 * @param array $data JSON style array
860 * @param string $root_element Name of the root element
862 * @return string The XML data
864 function api_create_xml(array $data, $root_element)
866 $childname = key($data);
867 $data2 = array_pop($data);
869 $namespaces = ["" => "http://api.twitter.com",
870 "statusnet" => "http://status.net/schema/api/1/",
871 "friendica" => "http://friendi.ca/schema/api/1/",
872 "georss" => "http://www.georss.org/georss"];
874 /// @todo Auto detection of needed namespaces
875 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
879 if (is_array($data2)) {
881 api_walk_recursive($data2, "api_reformat_xml");
887 foreach ($data2 as $item) {
888 $data4[$i++ . ":" . $childname] = $item;
895 $data3 = [$root_element => $data2];
897 $ret = XML::fromArray($data3, $xml, false, $namespaces);
902 * Formats the data according to the data type
904 * @param string $root_element Name of the root element
905 * @param string $type Return type (atom, rss, xml, json)
906 * @param array $data JSON style array
908 * @return array|string (string|array) XML data or JSON data
910 function api_format_data($root_element, $type, $data)
916 $ret = api_create_xml($data, $root_element);
931 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
932 * returns a 401 status code and an error message if not.
934 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
936 * @param string $type Return type (atom, rss, xml, json)
937 * @return array|string
938 * @throws BadRequestException
939 * @throws ForbiddenException
940 * @throws ImagickException
941 * @throws InternalServerErrorException
942 * @throws UnauthorizedException
944 function api_account_verify_credentials($type)
948 if (api_user() === false) {
949 throw new ForbiddenException();
952 unset($_REQUEST["user_id"]);
953 unset($_GET["user_id"]);
955 unset($_REQUEST["screen_name"]);
956 unset($_GET["screen_name"]);
958 $skip_status = $_REQUEST['skip_status'] ?? false;
960 $user_info = api_get_user($a);
962 // "verified" isn't used here in the standard
963 unset($user_info["verified"]);
965 // - Adding last status
967 $item = api_get_last_status($user_info['pid'], $user_info['uid']);
969 $user_info['status'] = api_format_item($item, $type);
973 // "uid" and "self" are only needed for some internal stuff, so remove it from here
974 unset($user_info["uid"]);
975 unset($user_info["self"]);
977 return api_format_data("user", $type, ['user' => $user_info]);
980 /// @TODO move to top of file or somewhere better
981 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
984 * Get data from $_POST or $_GET
989 function requestdata($k)
991 if (!empty($_POST[$k])) {
994 if (!empty($_GET[$k])) {
1001 * Deprecated function to upload media.
1003 * @param string $type Return type (atom, rss, xml, json)
1005 * @return array|string
1006 * @throws BadRequestException
1007 * @throws ForbiddenException
1008 * @throws ImagickException
1009 * @throws InternalServerErrorException
1010 * @throws UnauthorizedException
1012 function api_statuses_mediap($type)
1016 if (api_user() === false) {
1017 Logger::log('api_statuses_update: no user');
1018 throw new ForbiddenException();
1020 $user_info = api_get_user($a);
1022 $_REQUEST['profile_uid'] = api_user();
1023 $_REQUEST['api_source'] = true;
1024 $txt = requestdata('status');
1025 /// @TODO old-lost code?
1026 //$txt = urldecode(requestdata('status'));
1028 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1029 $txt = HTML::toBBCodeVideo($txt);
1030 $config = HTMLPurifier_Config::createDefault();
1031 $config->set('Cache.DefinitionImpl', null);
1032 $purifier = new HTMLPurifier($config);
1033 $txt = $purifier->purify($txt);
1035 $txt = HTML::toBBCode($txt);
1037 $a->argv[1] = $user_info['screen_name']; //should be set to username?
1039 $picture = wall_upload_post($a, false);
1041 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1042 $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1043 $item_id = item_post($a);
1045 // output the post that we just posted.
1046 return api_status_show($type, $item_id);
1049 /// @TODO move this to top of file or somewhere better!
1050 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1053 * Updates the user’s current status.
1055 * @param string $type Return type (atom, rss, xml, json)
1057 * @return array|string
1058 * @throws BadRequestException
1059 * @throws ForbiddenException
1060 * @throws ImagickException
1061 * @throws InternalServerErrorException
1062 * @throws TooManyRequestsException
1063 * @throws UnauthorizedException
1064 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1066 function api_statuses_update($type)
1070 if (api_user() === false) {
1071 Logger::log('api_statuses_update: no user');
1072 throw new ForbiddenException();
1077 // convert $_POST array items to the form we use for web posts.
1078 if (requestdata('htmlstatus')) {
1079 $txt = requestdata('htmlstatus');
1080 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1081 $txt = HTML::toBBCodeVideo($txt);
1083 $config = HTMLPurifier_Config::createDefault();
1084 $config->set('Cache.DefinitionImpl', null);
1086 $purifier = new HTMLPurifier($config);
1087 $txt = $purifier->purify($txt);
1089 $_REQUEST['body'] = HTML::toBBCode($txt);
1092 $_REQUEST['body'] = requestdata('status');
1095 $_REQUEST['title'] = requestdata('title');
1097 $parent = requestdata('in_reply_to_status_id');
1099 // Twidere sends "-1" if it is no reply ...
1100 if ($parent == -1) {
1104 if (ctype_digit($parent)) {
1105 $_REQUEST['parent'] = $parent;
1107 $_REQUEST['parent_uri'] = $parent;
1110 if (requestdata('lat') && requestdata('long')) {
1111 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1113 $_REQUEST['profile_uid'] = api_user();
1116 // Check for throttling (maximum posts per day, week and month)
1117 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
1118 if ($throttle_day > 0) {
1119 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1121 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, api_user(), $datefrom];
1122 $posts_day = Post::count($condition);
1124 if ($posts_day > $throttle_day) {
1125 Logger::log('Daily posting limit reached for user '.api_user(), Logger::DEBUG);
1126 // die(api_error($type, DI::l10n()->t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1127 throw new TooManyRequestsException(DI::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));
1131 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
1132 if ($throttle_week > 0) {
1133 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1135 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, api_user(), $datefrom];
1136 $posts_week = Post::count($condition);
1138 if ($posts_week > $throttle_week) {
1139 Logger::log('Weekly posting limit reached for user '.api_user(), Logger::DEBUG);
1140 // die(api_error($type, DI::l10n()->t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1141 throw new TooManyRequestsException(DI::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));
1145 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
1146 if ($throttle_month > 0) {
1147 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1149 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, api_user(), $datefrom];
1150 $posts_month = Post::count($condition);
1152 if ($posts_month > $throttle_month) {
1153 Logger::log('Monthly posting limit reached for user '.api_user(), Logger::DEBUG);
1154 // die(api_error($type, DI::l10n()->t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1155 throw new TooManyRequestsException(DI::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));
1160 if (!empty($_FILES['media'])) {
1161 // upload the image if we have one
1162 $picture = wall_upload_post($a, false);
1163 if (is_array($picture)) {
1164 $_REQUEST['body'] .= "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1168 if (requestdata('media_ids')) {
1169 $ids = explode(',', requestdata('media_ids'));
1170 foreach ($ids as $id) {
1172 "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",
1176 if (DBA::isResult($r)) {
1177 $phototypes = Images::supportedTypes();
1178 $ext = $phototypes[$r[0]['type']];
1179 $description = $r[0]['desc'] ?? '';
1180 $_REQUEST['body'] .= "\n\n" . '[url=' . DI::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1181 $_REQUEST['body'] .= '[img=' . DI::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . ']' . $description . '[/img][/url]';
1186 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1188 $_REQUEST['api_source'] = true;
1190 if (empty($_REQUEST['source'])) {
1191 $_REQUEST["source"] = api_source();
1194 // call out normal post function
1195 $item_id = item_post($a);
1197 // output the post that we just posted.
1198 return api_status_show($type, $item_id);
1201 /// @TODO move to top of file or somewhere better
1202 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1203 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1206 * Uploads an image to Friendica.
1209 * @throws BadRequestException
1210 * @throws ForbiddenException
1211 * @throws ImagickException
1212 * @throws InternalServerErrorException
1213 * @throws UnauthorizedException
1214 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1216 function api_media_upload()
1220 if (api_user() === false) {
1221 Logger::log('no user');
1222 throw new ForbiddenException();
1227 if (empty($_FILES['media'])) {
1229 throw new BadRequestException("No media.");
1232 $media = wall_upload_post($a, false);
1235 throw new InternalServerErrorException();
1239 $returndata["media_id"] = $media["id"];
1240 $returndata["media_id_string"] = (string)$media["id"];
1241 $returndata["size"] = $media["size"];
1242 $returndata["image"] = ["w" => $media["width"],
1243 "h" => $media["height"],
1244 "image_type" => $media["type"],
1245 "friendica_preview_url" => $media["preview"]];
1247 Logger::info('Media uploaded', ['return' => $returndata]);
1249 return ["media" => $returndata];
1252 /// @TODO move to top of file or somewhere better
1253 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1256 * Updates media meta data (picture descriptions)
1258 * @param string $type Return type (atom, rss, xml, json)
1260 * @return array|string
1261 * @throws BadRequestException
1262 * @throws ForbiddenException
1263 * @throws ImagickException
1264 * @throws InternalServerErrorException
1265 * @throws TooManyRequestsException
1266 * @throws UnauthorizedException
1267 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1269 * @todo Compare the corresponding Twitter function for correct return values
1271 function api_media_metadata_create($type)
1275 if (api_user() === false) {
1276 Logger::info('no user');
1277 throw new ForbiddenException();
1282 $postdata = Network::postdata();
1284 if (empty($postdata)) {
1285 throw new BadRequestException("No post data");
1288 $data = json_decode($postdata, true);
1290 throw new BadRequestException("Invalid post data");
1293 if (empty($data['media_id']) || empty($data['alt_text'])) {
1294 throw new BadRequestException("Missing post data values");
1297 if (empty($data['alt_text']['text'])) {
1298 throw new BadRequestException("No alt text.");
1301 Logger::info('Updating metadata', ['media_id' => $data['media_id']]);
1303 $condition = ['id' => $data['media_id'], 'uid' => api_user()];
1304 $photo = DBA::selectFirst('photo', ['resource-id'], $condition);
1305 if (!DBA::isResult($photo)) {
1306 throw new BadRequestException("Metadata not found.");
1309 DBA::update('photo', ['desc' => $data['alt_text']['text']], ['resource-id' => $photo['resource-id']]);
1312 api_register_func('api/media/metadata/create', 'api_media_metadata_create', true, API_METHOD_POST);
1315 * @param string $type Return format (atom, rss, xml, json)
1316 * @param int $item_id
1317 * @return array|string
1320 function api_status_show($type, $item_id)
1322 Logger::info(API_LOG_PREFIX . 'Start', ['action' => 'status_show', 'type' => $type, 'item_id' => $item_id]);
1326 $item = api_get_item(['id' => $item_id]);
1327 if (!empty($item)) {
1328 $status_info = api_format_item($item, $type);
1331 Logger::info(API_LOG_PREFIX . 'End', ['action' => 'get_status', 'status_info' => $status_info]);
1333 return api_format_data('statuses', $type, ['status' => $status_info]);
1337 * Retrieves the last public status of the provided user info
1339 * @param int $ownerId Public contact Id
1340 * @param int $uid User Id
1344 function api_get_last_status($ownerId, $uid)
1347 'author-id'=> $ownerId,
1349 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT],
1350 'private' => [Item::PUBLIC, Item::UNLISTED]
1353 $item = api_get_item($condition);
1359 * Retrieves a single item record based on the provided condition and converts it for API use.
1361 * @param array $condition Item table condition array
1365 function api_get_item(array $condition)
1367 $item = Post::selectFirst(Item::DISPLAY_FIELDLIST, $condition, ['order' => ['id' => true]]);
1373 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1374 * The author's most recent status will be returned inline.
1376 * @param string $type Return type (atom, rss, xml, json)
1377 * @return array|string
1378 * @throws BadRequestException
1379 * @throws ImagickException
1380 * @throws InternalServerErrorException
1381 * @throws UnauthorizedException
1382 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1384 function api_users_show($type)
1386 $a = Friendica\DI::app();
1388 $user_info = api_get_user($a);
1390 $item = api_get_last_status($user_info['pid'], $user_info['uid']);
1391 if (!empty($item)) {
1392 $user_info['status'] = api_format_item($item, $type);
1395 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1396 unset($user_info['uid']);
1397 unset($user_info['self']);
1399 return api_format_data('user', $type, ['user' => $user_info]);
1402 /// @TODO move to top of file or somewhere better
1403 api_register_func('api/users/show', 'api_users_show');
1404 api_register_func('api/externalprofile/show', 'api_users_show');
1407 * Search a public user account.
1409 * @param string $type Return type (atom, rss, xml, json)
1411 * @return array|string
1412 * @throws BadRequestException
1413 * @throws ImagickException
1414 * @throws InternalServerErrorException
1415 * @throws UnauthorizedException
1416 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1418 function api_users_search($type)
1424 if (!empty($_GET['q'])) {
1425 $contacts = Contact::selectToArray(
1428 '`uid` = 0 AND (`name` = ? OR `nick` = ? OR `url` = ? OR `addr` = ?)',
1436 if (DBA::isResult($contacts)) {
1438 foreach ($contacts as $contact) {
1439 $user_info = api_get_user($a, $contact['id']);
1441 if ($type == 'xml') {
1442 $userlist[$k++ . ':user'] = $user_info;
1444 $userlist[] = $user_info;
1447 $userlist = ['users' => $userlist];
1449 throw new NotFoundException('User ' . $_GET['q'] . ' not found.');
1452 throw new BadRequestException('No search term specified.');
1455 return api_format_data('users', $type, $userlist);
1458 /// @TODO move to top of file or somewhere better
1459 api_register_func('api/users/search', 'api_users_search');
1462 * Return user objects
1464 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1466 * @param string $type Return format: json or xml
1468 * @return array|string
1469 * @throws BadRequestException
1470 * @throws ImagickException
1471 * @throws InternalServerErrorException
1472 * @throws NotFoundException if the results are empty.
1473 * @throws UnauthorizedException
1475 function api_users_lookup($type)
1479 if (!empty($_REQUEST['user_id'])) {
1480 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1482 $users[] = api_get_user(DI::app(), $id);
1487 if (empty($users)) {
1488 throw new NotFoundException;
1491 return api_format_data("users", $type, ['users' => $users]);
1494 /// @TODO move to top of file or somewhere better
1495 api_register_func('api/users/lookup', 'api_users_lookup', true);
1498 * Returns statuses that match a specified query.
1500 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1502 * @param string $type Return format: json, xml, atom, rss
1504 * @return array|string
1505 * @throws BadRequestException if the "q" parameter is missing.
1506 * @throws ForbiddenException
1507 * @throws ImagickException
1508 * @throws InternalServerErrorException
1509 * @throws UnauthorizedException
1511 function api_search($type)
1514 $user_info = api_get_user($a);
1516 if (api_user() === false || $user_info === false) {
1517 throw new ForbiddenException();
1520 if (empty($_REQUEST['q'])) {
1521 throw new BadRequestException('q parameter is required.');
1524 $searchTerm = trim(rawurldecode($_REQUEST['q']));
1527 $data['status'] = [];
1529 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1530 if (!empty($_REQUEST['rpp'])) {
1531 $count = $_REQUEST['rpp'];
1532 } elseif (!empty($_REQUEST['count'])) {
1533 $count = $_REQUEST['count'];
1536 $since_id = $_REQUEST['since_id'] ?? 0;
1537 $max_id = $_REQUEST['max_id'] ?? 0;
1538 $page = $_REQUEST['page'] ?? 1;
1540 $start = max(0, ($page - 1) * $count);
1542 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1543 if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) {
1544 $searchTerm = $matches[1];
1545 $condition = ["`iid` > ? AND `name` = ? AND (NOT `private` OR (`private` AND `uid` = ?))", $since_id, $searchTerm, local_user()];
1546 $tags = DBA::select('tag-search-view', ['uri-id'], $condition);
1548 while ($tag = DBA::fetch($tags)) {
1549 $uriids[] = $tag['uri-id'];
1553 if (empty($uriids)) {
1554 return api_format_data('statuses', $type, $data);
1557 $condition = ['uri-id' => $uriids];
1558 if ($exclude_replies) {
1559 $condition['gravity'] = GRAVITY_PARENT;
1562 $params['group_by'] = ['uri-id'];
1564 $condition = ["`id` > ?
1565 " . ($exclude_replies ? " AND `gravity` = " . GRAVITY_PARENT : ' ') . "
1566 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1567 AND `body` LIKE CONCAT('%',?,'%')",
1568 $since_id, api_user(), $_REQUEST['q']];
1570 $condition[0] .= ' AND `id` <= ?';
1571 $condition[] = $max_id;
1577 if (parse_url($searchTerm, PHP_URL_SCHEME) != '') {
1578 $id = Item::fetchByLink($searchTerm, api_user());
1581 $id = Item::fetchByLink($searchTerm);
1585 $statuses = Post::select([], ['id' => $id]);
1589 $statuses = $statuses ?: Post::selectForUser(api_user(), [], $condition, $params);
1591 $data['status'] = api_format_items(Post::toArray($statuses), $user_info);
1593 bindComments($data['status']);
1595 return api_format_data('statuses', $type, $data);
1598 /// @TODO move to top of file or somewhere better
1599 api_register_func('api/search/tweets', 'api_search', true);
1600 api_register_func('api/search', 'api_search', true);
1603 * Returns the most recent statuses posted by the user and the users they follow.
1605 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1607 * @param string $type Return type (atom, rss, xml, json)
1609 * @return array|string
1610 * @throws BadRequestException
1611 * @throws ForbiddenException
1612 * @throws ImagickException
1613 * @throws InternalServerErrorException
1614 * @throws UnauthorizedException
1615 * @todo Optional parameters
1616 * @todo Add reply info
1618 function api_statuses_home_timeline($type)
1621 $user_info = api_get_user($a);
1623 if (api_user() === false || $user_info === false) {
1624 throw new ForbiddenException();
1627 unset($_REQUEST["user_id"]);
1628 unset($_GET["user_id"]);
1630 unset($_REQUEST["screen_name"]);
1631 unset($_GET["screen_name"]);
1633 // get last network messages
1636 $count = $_REQUEST['count'] ?? 20;
1637 $page = $_REQUEST['page']?? 0;
1638 $since_id = $_REQUEST['since_id'] ?? 0;
1639 $max_id = $_REQUEST['max_id'] ?? 0;
1640 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1641 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1643 $start = max(0, ($page - 1) * $count);
1645 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ?",
1646 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1649 $condition[0] .= " AND `id` <= ?";
1650 $condition[] = $max_id;
1652 if ($exclude_replies) {
1653 $condition[0] .= ' AND `gravity` = ?';
1654 $condition[] = GRAVITY_PARENT;
1656 if ($conversation_id > 0) {
1657 $condition[0] .= " AND `parent` = ?";
1658 $condition[] = $conversation_id;
1661 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1662 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1664 $items = Post::toArray($statuses);
1666 $ret = api_format_items($items, $user_info, false, $type);
1668 // Set all posts from the query above to seen
1670 foreach ($items as $item) {
1671 $idarray[] = intval($item["id"]);
1674 if (!empty($idarray)) {
1675 $unseen = Post::exists(['unseen' => true, 'id' => $idarray]);
1677 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1683 $data = ['status' => $ret];
1688 $data = api_rss_extra($a, $data, $user_info);
1692 return api_format_data("statuses", $type, $data);
1696 /// @TODO move to top of file or somewhere better
1697 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1698 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1701 * Returns the most recent statuses from public users.
1703 * @param string $type Return type (atom, rss, xml, json)
1705 * @return array|string
1706 * @throws BadRequestException
1707 * @throws ForbiddenException
1708 * @throws ImagickException
1709 * @throws InternalServerErrorException
1710 * @throws UnauthorizedException
1712 function api_statuses_public_timeline($type)
1715 $user_info = api_get_user($a);
1717 if (api_user() === false || $user_info === false) {
1718 throw new ForbiddenException();
1721 // get last network messages
1724 $count = $_REQUEST['count'] ?? 20;
1725 $page = $_REQUEST['page'] ?? 1;
1726 $since_id = $_REQUEST['since_id'] ?? 0;
1727 $max_id = $_REQUEST['max_id'] ?? 0;
1728 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
1729 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1731 $start = max(0, ($page - 1) * $count);
1733 if ($exclude_replies && !$conversation_id) {
1734 $condition = ["`gravity` = ? AND `id` > ? AND `private` = ? AND `wall` AND NOT `author-hidden`",
1735 GRAVITY_PARENT, $since_id, Item::PUBLIC];
1738 $condition[0] .= " AND `id` <= ?";
1739 $condition[] = $max_id;
1742 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1743 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1745 $r = Post::toArray($statuses);
1747 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND `private` = ? AND `wall` AND `origin` AND NOT `author-hidden`",
1748 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC];
1751 $condition[0] .= " AND `id` <= ?";
1752 $condition[] = $max_id;
1754 if ($conversation_id > 0) {
1755 $condition[0] .= " AND `parent` = ?";
1756 $condition[] = $conversation_id;
1759 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1760 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1762 $r = Post::toArray($statuses);
1765 $ret = api_format_items($r, $user_info, false, $type);
1769 $data = ['status' => $ret];
1774 $data = api_rss_extra($a, $data, $user_info);
1778 return api_format_data("statuses", $type, $data);
1781 /// @TODO move to top of file or somewhere better
1782 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1785 * Returns the most recent statuses posted by users this node knows about.
1787 * @param string $type Return format: json, xml, atom, rss
1788 * @return array|string
1789 * @throws BadRequestException
1790 * @throws ForbiddenException
1791 * @throws ImagickException
1792 * @throws InternalServerErrorException
1793 * @throws UnauthorizedException
1795 function api_statuses_networkpublic_timeline($type)
1798 $user_info = api_get_user($a);
1800 if (api_user() === false || $user_info === false) {
1801 throw new ForbiddenException();
1804 $since_id = $_REQUEST['since_id'] ?? 0;
1805 $max_id = $_REQUEST['max_id'] ?? 0;
1808 $count = $_REQUEST['count'] ?? 20;
1809 $page = $_REQUEST['page'] ?? 1;
1811 $start = max(0, ($page - 1) * $count);
1813 $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `id` > ? AND `private` = ?",
1814 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC];
1817 $condition[0] .= " AND `id` <= ?";
1818 $condition[] = $max_id;
1821 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1822 $statuses = Post::toArray(Post::selectForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params));
1824 $ret = api_format_items($statuses, $user_info, false, $type);
1828 $data = ['status' => $ret];
1833 $data = api_rss_extra($a, $data, $user_info);
1837 return api_format_data("statuses", $type, $data);
1840 /// @TODO move to top of file or somewhere better
1841 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1844 * Returns a single status.
1846 * @param string $type Return type (atom, rss, xml, json)
1848 * @return array|string
1849 * @throws BadRequestException
1850 * @throws ForbiddenException
1851 * @throws ImagickException
1852 * @throws InternalServerErrorException
1853 * @throws UnauthorizedException
1854 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1856 function api_statuses_show($type)
1859 $user_info = api_get_user($a);
1861 if (api_user() === false || $user_info === false) {
1862 throw new ForbiddenException();
1866 $id = intval($a->argv[3] ?? 0);
1869 $id = intval($_REQUEST['id'] ?? 0);
1874 $id = intval($a->argv[4] ?? 0);
1877 Logger::log('API: api_statuses_show: ' . $id);
1879 $conversation = !empty($_REQUEST['conversation']);
1881 // try to fetch the item for the local user - or the public item, if there is no local one
1882 $uri_item = Post::selectFirst(['uri-id'], ['id' => $id]);
1883 if (!DBA::isResult($uri_item)) {
1884 throw new BadRequestException(sprintf("There is no status with the id %d", $id));
1887 $item = Post::selectFirst(['id'], ['uri-id' => $uri_item['uri-id'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1888 if (!DBA::isResult($item)) {
1889 throw new BadRequestException(sprintf("There is no status with the uri-id %d for the given user.", $uri_item['uri-id']));
1894 if ($conversation) {
1895 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1896 $params = ['order' => ['id' => true]];
1898 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1902 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1904 /// @TODO How about copying this to above methods which don't check $r ?
1905 if (!DBA::isResult($statuses)) {
1906 throw new BadRequestException(sprintf("There is no status or conversation with the id %d.", $id));
1909 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
1911 if ($conversation) {
1912 $data = ['status' => $ret];
1913 return api_format_data("statuses", $type, $data);
1915 $data = ['status' => $ret[0]];
1916 return api_format_data("status", $type, $data);
1920 /// @TODO move to top of file or somewhere better
1921 api_register_func('api/statuses/show', 'api_statuses_show', true);
1925 * @param string $type Return type (atom, rss, xml, json)
1927 * @return array|string
1928 * @throws BadRequestException
1929 * @throws ForbiddenException
1930 * @throws ImagickException
1931 * @throws InternalServerErrorException
1932 * @throws UnauthorizedException
1933 * @todo nothing to say?
1935 function api_conversation_show($type)
1938 $user_info = api_get_user($a);
1940 if (api_user() === false || $user_info === false) {
1941 throw new ForbiddenException();
1945 $id = intval($a->argv[3] ?? 0);
1946 $since_id = intval($_REQUEST['since_id'] ?? 0);
1947 $max_id = intval($_REQUEST['max_id'] ?? 0);
1948 $count = intval($_REQUEST['count'] ?? 20);
1949 $page = intval($_REQUEST['page'] ?? 1);
1951 $start = max(0, ($page - 1) * $count);
1954 $id = intval($_REQUEST['id'] ?? 0);
1959 $id = intval($a->argv[4] ?? 0);
1962 Logger::info(API_LOG_PREFIX . '{subaction}', ['module' => 'api', 'action' => 'conversation', 'subaction' => 'show', 'id' => $id]);
1964 // try to fetch the item for the local user - or the public item, if there is no local one
1965 $item = Post::selectFirst(['parent-uri-id'], ['id' => $id]);
1966 if (!DBA::isResult($item)) {
1967 throw new BadRequestException("There is no status with this id.");
1970 $parent = Post::selectFirst(['id'], ['uri-id' => $item['parent-uri-id'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1971 if (!DBA::isResult($parent)) {
1972 throw new BadRequestException("There is no status with this id.");
1975 $id = $parent['id'];
1977 $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `id` > ?",
1978 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1981 $condition[0] .= " AND `id` <= ?";
1982 $condition[] = $max_id;
1985 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1986 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1988 if (!DBA::isResult($statuses)) {
1989 throw new BadRequestException("There is no status with id $id.");
1992 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
1994 $data = ['status' => $ret];
1995 return api_format_data("statuses", $type, $data);
1998 /// @TODO move to top of file or somewhere better
1999 api_register_func('api/conversation/show', 'api_conversation_show', true);
2000 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
2005 * @param string $type Return type (atom, rss, xml, json)
2007 * @return array|string
2008 * @throws BadRequestException
2009 * @throws ForbiddenException
2010 * @throws ImagickException
2011 * @throws InternalServerErrorException
2012 * @throws UnauthorizedException
2013 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
2015 function api_statuses_repeat($type)
2021 if (api_user() === false) {
2022 throw new ForbiddenException();
2028 $id = intval($a->argv[3] ?? 0);
2031 $id = intval($_REQUEST['id'] ?? 0);
2036 $id = intval($a->argv[4] ?? 0);
2039 Logger::log('API: api_statuses_repeat: '.$id);
2041 $fields = ['uri-id', 'network', 'body', 'title', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
2042 $item = Post::selectFirst($fields, ['id' => $id, 'private' => [Item::PUBLIC, Item::UNLISTED]]);
2044 if (DBA::isResult($item) && !empty($item['body'])) {
2045 if (in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::TWITTER])) {
2046 if (!Item::performActivity($id, 'announce', local_user())) {
2047 throw new InternalServerErrorException();
2052 if (strpos($item['body'], "[/share]") !== false) {
2053 $pos = strpos($item['body'], "[share");
2054 $post = substr($item['body'], $pos);
2056 $post = BBCode::getShareOpeningTag($item['author-name'], $item['author-link'], $item['author-avatar'], $item['plink'], $item['created'], $item['guid']);
2058 if (!empty($item['title'])) {
2059 $post .= '[h3]' . $item['title'] . "[/h3]\n";
2062 $post .= $item['body'];
2063 $post .= "[/share]";
2065 $_REQUEST['body'] = $post;
2066 $_REQUEST['profile_uid'] = api_user();
2067 $_REQUEST['api_source'] = true;
2069 if (empty($_REQUEST['source'])) {
2070 $_REQUEST["source"] = api_source();
2073 $item_id = item_post($a);
2076 throw new ForbiddenException();
2079 // output the post that we just posted.
2081 return api_status_show($type, $item_id);
2084 /// @TODO move to top of file or somewhere better
2085 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2088 * Destroys a specific status.
2090 * @param string $type Return type (atom, rss, xml, json)
2092 * @return array|string
2093 * @throws BadRequestException
2094 * @throws ForbiddenException
2095 * @throws ImagickException
2096 * @throws InternalServerErrorException
2097 * @throws UnauthorizedException
2098 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2100 function api_statuses_destroy($type)
2104 if (api_user() === false) {
2105 throw new ForbiddenException();
2111 $id = intval($a->argv[3] ?? 0);
2114 $id = intval($_REQUEST['id'] ?? 0);
2119 $id = intval($a->argv[4] ?? 0);
2122 Logger::log('API: api_statuses_destroy: '.$id);
2124 $ret = api_statuses_show($type);
2126 Item::deleteForUser(['id' => $id], api_user());
2131 /// @TODO move to top of file or somewhere better
2132 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2135 * Returns the most recent mentions.
2137 * @param string $type Return type (atom, rss, xml, json)
2139 * @return array|string
2140 * @throws BadRequestException
2141 * @throws ForbiddenException
2142 * @throws ImagickException
2143 * @throws InternalServerErrorException
2144 * @throws UnauthorizedException
2145 * @see http://developer.twitter.com/doc/get/statuses/mentions
2147 function api_statuses_mentions($type)
2150 $user_info = api_get_user($a);
2152 if (api_user() === false || $user_info === false) {
2153 throw new ForbiddenException();
2156 unset($_REQUEST["user_id"]);
2157 unset($_GET["user_id"]);
2159 unset($_REQUEST["screen_name"]);
2160 unset($_GET["screen_name"]);
2162 // get last network messages
2165 $since_id = intval($_REQUEST['since_id'] ?? 0);
2166 $max_id = intval($_REQUEST['max_id'] ?? 0);
2167 $count = intval($_REQUEST['count'] ?? 20);
2168 $page = intval($_REQUEST['page'] ?? 1);
2170 $start = max(0, ($page - 1) * $count);
2172 $query = "`gravity` IN (?, ?) AND `uri-id` IN
2173 (SELECT `uri-id` FROM `post-user-notification` WHERE `uid` = ? AND `notification-type` & ? != 0 ORDER BY `uri-id`)
2174 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`)) AND `id` > ?";
2176 $condition = [GRAVITY_PARENT, GRAVITY_COMMENT, api_user(),
2177 Post\UserNotification::NOTIF_EXPLICIT_TAGGED | Post\UserNotification::NOTIF_IMPLICIT_TAGGED |
2178 Post\UserNotification::NOTIF_THREAD_COMMENT | Post\UserNotification::NOTIF_DIRECT_COMMENT |
2179 Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT,
2180 api_user(), $since_id];
2183 $query .= " AND `id` <= ?";
2184 $condition[] = $max_id;
2187 array_unshift($condition, $query);
2189 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2190 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
2192 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
2194 $data = ['status' => $ret];
2199 $data = api_rss_extra($a, $data, $user_info);
2203 return api_format_data("statuses", $type, $data);
2206 /// @TODO move to top of file or somewhere better
2207 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2208 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2211 * Returns the most recent statuses posted by the user.
2213 * @param string $type Either "json" or "xml"
2214 * @return string|array
2215 * @throws BadRequestException
2216 * @throws ForbiddenException
2217 * @throws ImagickException
2218 * @throws InternalServerErrorException
2219 * @throws UnauthorizedException
2220 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2222 function api_statuses_user_timeline($type)
2225 $user_info = api_get_user($a);
2227 if (api_user() === false || $user_info === false) {
2228 throw new ForbiddenException();
2231 Logger::info('api_statuses_user_timeline', ['api_user' => api_user(), 'user_info' => $user_info, '_REQUEST' => $_REQUEST]);
2233 $since_id = $_REQUEST['since_id'] ?? 0;
2234 $max_id = $_REQUEST['max_id'] ?? 0;
2235 $exclude_replies = !empty($_REQUEST['exclude_replies']);
2236 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
2239 $count = $_REQUEST['count'] ?? 20;
2240 $page = $_REQUEST['page'] ?? 1;
2242 $start = max(0, ($page - 1) * $count);
2244 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `contact-id` = ?",
2245 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2247 if ($user_info['self'] == 1) {
2248 $condition[0] .= ' AND `wall` ';
2251 if ($exclude_replies) {
2252 $condition[0] .= ' AND `gravity` = ?';
2253 $condition[] = GRAVITY_PARENT;
2256 if ($conversation_id > 0) {
2257 $condition[0] .= " AND `parent` = ?";
2258 $condition[] = $conversation_id;
2262 $condition[0] .= " AND `id` <= ?";
2263 $condition[] = $max_id;
2265 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2266 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
2268 $ret = api_format_items(Post::toArray($statuses), $user_info, true, $type);
2272 $data = ['status' => $ret];
2277 $data = api_rss_extra($a, $data, $user_info);
2281 return api_format_data("statuses", $type, $data);
2284 /// @TODO move to top of file or somewhere better
2285 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2288 * Star/unstar an item.
2289 * param: id : id of the item
2291 * @param string $type Return type (atom, rss, xml, json)
2293 * @return array|string
2294 * @throws BadRequestException
2295 * @throws ForbiddenException
2296 * @throws ImagickException
2297 * @throws InternalServerErrorException
2298 * @throws UnauthorizedException
2299 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2301 function api_favorites_create_destroy($type)
2305 if (api_user() === false) {
2306 throw new ForbiddenException();
2309 // for versioned api.
2310 /// @TODO We need a better global soluton
2311 $action_argv_id = 2;
2312 if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2313 $action_argv_id = 3;
2316 if ($a->argc <= $action_argv_id) {
2317 throw new BadRequestException("Invalid request.");
2319 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2320 if ($a->argc == $action_argv_id + 2) {
2321 $itemid = intval($a->argv[$action_argv_id + 1] ?? 0);
2323 $itemid = intval($_REQUEST['id'] ?? 0);
2326 $item = Post::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2328 if (!DBA::isResult($item)) {
2329 throw new BadRequestException("Invalid item.");
2334 $item['starred'] = 1;
2337 $item['starred'] = 0;
2340 throw new BadRequestException("Invalid action ".$action);
2343 $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2346 throw new InternalServerErrorException("DB error");
2350 $user_info = api_get_user($a);
2351 $rets = api_format_items([$item], $user_info, false, $type);
2354 $data = ['status' => $ret];
2359 $data = api_rss_extra($a, $data, $user_info);
2363 return api_format_data("status", $type, $data);
2366 /// @TODO move to top of file or somewhere better
2367 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2368 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2371 * Returns the most recent favorite statuses.
2373 * @param string $type Return type (atom, rss, xml, json)
2375 * @return string|array
2376 * @throws BadRequestException
2377 * @throws ForbiddenException
2378 * @throws ImagickException
2379 * @throws InternalServerErrorException
2380 * @throws UnauthorizedException
2382 function api_favorites($type)
2387 $user_info = api_get_user($a);
2389 if (api_user() === false || $user_info === false) {
2390 throw new ForbiddenException();
2395 // in friendica starred item are private
2396 // return favorites only for self
2397 Logger::info(API_LOG_PREFIX . 'for {self}', ['module' => 'api', 'action' => 'favorites', 'self' => $user_info['self']]);
2399 if ($user_info['self'] == 0) {
2403 $since_id = $_REQUEST['since_id'] ?? 0;
2404 $max_id = $_REQUEST['max_id'] ?? 0;
2405 $count = $_GET['count'] ?? 20;
2406 $page = $_REQUEST['page'] ?? 1;
2408 $start = max(0, ($page - 1) * $count);
2410 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2411 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2413 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2416 $condition[0] .= " AND `id` <= ?";
2417 $condition[] = $max_id;
2420 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
2422 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
2427 $data = ['status' => $ret];
2432 $data = api_rss_extra($a, $data, $user_info);
2436 return api_format_data("statuses", $type, $data);
2439 /// @TODO move to top of file or somewhere better
2440 api_register_func('api/favorites', 'api_favorites', true);
2444 * @param array $item
2445 * @param array $recipient
2446 * @param array $sender
2449 * @throws InternalServerErrorException
2451 function api_format_messages($item, $recipient, $sender)
2453 // standard meta information
2455 'id' => $item['id'],
2456 'sender_id' => $sender['id'],
2458 'recipient_id' => $recipient['id'],
2459 'created_at' => api_date($item['created'] ?? DateTimeFormat::utcNow()),
2460 'sender_screen_name' => $sender['screen_name'],
2461 'recipient_screen_name' => $recipient['screen_name'],
2462 'sender' => $sender,
2463 'recipient' => $recipient,
2465 'friendica_seen' => $item['seen'] ?? 0,
2466 'friendica_parent_uri' => $item['parent-uri'] ?? '',
2469 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2470 if (isset($ret['sender']['uid'])) {
2471 unset($ret['sender']['uid']);
2473 if (isset($ret['sender']['self'])) {
2474 unset($ret['sender']['self']);
2476 if (isset($ret['recipient']['uid'])) {
2477 unset($ret['recipient']['uid']);
2479 if (isset($ret['recipient']['self'])) {
2480 unset($ret['recipient']['self']);
2483 //don't send title to regular StatusNET requests to avoid confusing these apps
2484 if (!empty($_GET['getText'])) {
2485 $ret['title'] = $item['title'];
2486 if ($_GET['getText'] == 'html') {
2487 $ret['text'] = BBCode::convert($item['body'], false);
2488 } elseif ($_GET['getText'] == 'plain') {
2489 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, BBCode::API, true), 0));
2492 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, BBCode::API, true), 0);
2494 if (!empty($_GET['getUserObjects']) && $_GET['getUserObjects'] == 'false') {
2495 unset($ret['sender']);
2496 unset($ret['recipient']);
2504 * @param array $item
2507 * @throws InternalServerErrorException
2509 function api_convert_item($item)
2511 $body = api_add_attachments_to_body($item);
2513 $entities = api_get_entitities($statustext, $body);
2515 // Add pictures to the attachment array and remove them from the body
2516 $attachments = api_get_attachments($body);
2518 // Workaround for ostatus messages where the title is identically to the body
2519 $html = BBCode::convert(api_clean_plain_items($body), false, BBCode::API, true);
2520 $statusbody = trim(HTML::toPlaintext($html, 0));
2522 // handle data: images
2523 $statusbody = api_format_items_embeded_images($item, $statusbody);
2525 $statustitle = trim($item['title']);
2527 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2528 $statustext = trim($statusbody);
2530 $statustext = trim($statustitle."\n\n".$statusbody);
2533 if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (mb_strlen($statustext)> 1000)) {
2534 $statustext = mb_substr($statustext, 0, 1000) . "... \n" . ($item['plink'] ?? '');
2537 $statushtml = BBCode::convert(BBCode::removeAttachment($body), false);
2539 // Workaround for clients with limited HTML parser functionality
2540 $search = ["<br>", "<blockquote>", "</blockquote>",
2541 "<h1>", "</h1>", "<h2>", "</h2>",
2542 "<h3>", "</h3>", "<h4>", "</h4>",
2543 "<h5>", "</h5>", "<h6>", "</h6>"];
2544 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2545 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2546 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2547 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2548 $statushtml = str_replace($search, $replace, $statushtml);
2550 if ($item['title'] != "") {
2551 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2555 $oldtext = $statushtml;
2556 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2557 } while ($oldtext != $statushtml);
2559 if (substr($statushtml, 0, 4) == '<br>') {
2560 $statushtml = substr($statushtml, 4);
2563 if (substr($statushtml, 0, -4) == '<br>') {
2564 $statushtml = substr($statushtml, -4);
2567 // feeds without body should contain the link
2568 if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2569 $statushtml .= BBCode::convert($item['plink']);
2573 "text" => $statustext,
2574 "html" => $statushtml,
2575 "attachments" => $attachments,
2576 "entities" => $entities
2581 * Add media attachments to the body
2583 * @param array $item
2584 * @return string body with added media
2586 function api_add_attachments_to_body(array $item)
2588 $body = $item['body'];
2590 foreach (Post\Media::getByURIId($item['uri-id'], [Post\Media::IMAGE, Post\Media::AUDIO, Post\Media::VIDEO]) as $media) {
2591 if (Item::containsLink($item['body'], $media['url'])) {
2595 if ($media['type'] == Post\Media::IMAGE) {
2596 if (!empty($media['description'])) {
2597 $body .= "\n[img=" . $media['url'] . ']' . $media['description'] .'[/img]';
2599 $body .= "\n[img]" . $media['url'] .'[/img]';
2601 } elseif ($media['type'] == Post\Media::AUDIO) {
2602 $body .= "\n[audio]" . $media['url'] . "[/audio]\n";
2603 } elseif ($media['type'] == Post\Media::VIDEO) {
2604 $body .= "\n[video]" . $media['url'] . "[/video]\n";
2608 if (strpos($body, '[/img]') !== false) {
2612 foreach (Post\Media::getByURIId($item['uri-id'], [Post\Media::HTML]) as $media) {
2613 if (!empty($media['preview'])) {
2614 $description = $media['description'] ?: $media['name'];
2615 if (!empty($description)) {
2616 $body .= "\n[img=" . $media['preview'] . ']' . $description .'[/img]';
2618 $body .= "\n[img]" . $media['preview'] .'[/img]';
2628 * @param string $body
2631 * @throws InternalServerErrorException
2633 function api_get_attachments(&$body)
2635 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
2636 $body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $body);
2638 $URLSearchString = "^\[\]";
2639 if (!preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $body, $images)) {
2643 // Remove all embedded pictures, since they are added as attachments
2644 foreach ($images[0] as $orig) {
2645 $body = str_replace($orig, '', $body);
2650 foreach ($images[1] as $image) {
2651 $imagedata = Images::getInfoFromURLCached($image);
2654 if (DI::config()->get("system", "proxy_disabled")) {
2655 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2657 $attachments[] = ["url" => ProxyUtils::proxifyUrl($image, false), "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2662 return $attachments;
2667 * @param string $text
2668 * @param string $bbcode
2671 * @throws InternalServerErrorException
2672 * @todo Links at the first character of the post
2674 function api_get_entitities(&$text, $bbcode)
2676 $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
2678 if ($include_entities != "true") {
2679 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2681 foreach ($images[1] as $image) {
2682 $replace = ProxyUtils::proxifyUrl($image, false);
2683 $text = str_replace($image, $replace, $text);
2688 $bbcode = BBCode::cleanPictureLinks($bbcode);
2690 // Change pure links in text to bbcode uris
2691 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2694 $entities["hashtags"] = [];
2695 $entities["symbols"] = [];
2696 $entities["urls"] = [];
2697 $entities["user_mentions"] = [];
2699 $URLSearchString = "^\[\]";
2701 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2703 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2704 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2706 $bbcode = preg_replace(
2707 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2708 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2711 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2713 $bbcode = preg_replace(
2714 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2715 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2718 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2720 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2722 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2725 foreach ($urls[1] as $id => $url) {
2726 $start = iconv_strpos($text, $url, 0, "UTF-8");
2727 if (!($start === false)) {
2728 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2732 ksort($ordered_urls);
2736 foreach ($ordered_urls as $url) {
2737 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2738 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2740 $display_url = $url["title"];
2742 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2743 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2745 if (strlen($display_url) > 26) {
2746 $display_url = substr($display_url, 0, 25)."…";
2750 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2751 if (!($start === false)) {
2752 $entities["urls"][] = ["url" => $url["url"],
2753 "expanded_url" => $url["url"],
2754 "display_url" => $display_url,
2755 "indices" => [$start, $start+strlen($url["url"])]];
2756 $offset = $start + 1;
2760 preg_match_all("/\[img\=(.*?)\](.*?)\[\/img\]/ism", $bbcode, $images, PREG_SET_ORDER);
2761 $ordered_images = [];
2762 foreach ($images as $image) {
2763 $start = iconv_strpos($text, $image[1], 0, "UTF-8");
2764 if (!($start === false)) {
2765 $ordered_images[$start] = ['url' => $image[1], 'alt' => $image[2]];
2769 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2770 foreach ($images[1] as $image) {
2771 $start = iconv_strpos($text, $image, 0, "UTF-8");
2772 if (!($start === false)) {
2773 $ordered_images[$start] = ['url' => $image, 'alt' => ''];
2779 foreach ($ordered_images as $image) {
2780 $url = $image['url'];
2781 $ext_alt_text = $image['alt'];
2783 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2784 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2786 if (strlen($display_url) > 26) {
2787 $display_url = substr($display_url, 0, 25)."…";
2790 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2791 if (!($start === false)) {
2792 $image = Images::getInfoFromURLCached($url);
2794 // If image cache is activated, then use the following sizes:
2795 // thumb (150), small (340), medium (600) and large (1024)
2796 if (!DI::config()->get("system", "proxy_disabled")) {
2797 $media_url = ProxyUtils::proxifyUrl($url, false);
2800 $scale = Images::getScalingDimensions($image[0], $image[1], 150);
2801 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2803 if (($image[0] > 150) || ($image[1] > 150)) {
2804 $scale = Images::getScalingDimensions($image[0], $image[1], 340);
2805 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2808 $scale = Images::getScalingDimensions($image[0], $image[1], 600);
2809 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2811 if (($image[0] > 600) || ($image[1] > 600)) {
2812 $scale = Images::getScalingDimensions($image[0], $image[1], 1024);
2813 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2817 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2820 $entities["media"][] = [
2822 "id_str" => (string) ($start + 1),
2823 "indices" => [$start, $start+strlen($url)],
2824 "media_url" => Strings::normaliseLink($media_url),
2825 "media_url_https" => $media_url,
2827 "display_url" => $display_url,
2828 "expanded_url" => $url,
2829 "ext_alt_text" => $ext_alt_text,
2833 $offset = $start + 1;
2842 * @param array $item
2843 * @param string $text
2847 function api_format_items_embeded_images($item, $text)
2849 $text = preg_replace_callback(
2850 '|data:image/([^;]+)[^=]+=*|m',
2851 function () use ($item) {
2852 return DI::baseUrl() . '/display/' . $item['guid'];
2860 * return <a href='url'>name</a> as array
2862 * @param string $txt text
2867 function api_contactlink_to_array($txt)
2870 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2871 if ($r && count($match)==3) {
2873 'name' => $match[2],
2887 * return likes, dislikes and attend status for item
2889 * @param array $item array
2890 * @param string $type Return type (atom, rss, xml, json)
2893 * likes => int count,
2894 * dislikes => int count
2895 * @throws BadRequestException
2896 * @throws ImagickException
2897 * @throws InternalServerErrorException
2898 * @throws UnauthorizedException
2900 function api_format_items_activities($item, $type = "json")
2909 'attendmaybe' => [],
2913 $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY];
2914 $ret = Post::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2916 while ($parent_item = Post::fetch($ret)) {
2917 // not used as result should be structured like other user data
2918 //builtin_activity_puller($i, $activities);
2920 // get user data and add it to the array of the activity
2921 $user = api_get_user($a, $parent_item['author-id']);
2922 switch ($parent_item['verb']) {
2923 case Activity::LIKE:
2924 $activities['like'][] = $user;
2926 case Activity::DISLIKE:
2927 $activities['dislike'][] = $user;
2929 case Activity::ATTEND:
2930 $activities['attendyes'][] = $user;
2932 case Activity::ATTENDNO:
2933 $activities['attendno'][] = $user;
2935 case Activity::ATTENDMAYBE:
2936 $activities['attendmaybe'][] = $user;
2938 case Activity::ANNOUNCE:
2939 $activities['announce'][] = $user;
2948 if ($type == "xml") {
2949 $xml_activities = [];
2950 foreach ($activities as $k => $v) {
2951 // change xml element from "like" to "friendica:like"
2952 $xml_activities["friendica:".$k] = $v;
2953 // add user data into xml output
2955 foreach ($v as $user) {
2956 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2959 $activities = $xml_activities;
2966 * format items to be returned by api
2968 * @param array $items array of items
2969 * @param array $user_info
2970 * @param bool $filter_user filter items by $user_info
2971 * @param string $type Return type (atom, rss, xml, json)
2973 * @throws BadRequestException
2974 * @throws ImagickException
2975 * @throws InternalServerErrorException
2976 * @throws UnauthorizedException
2978 function api_format_items($items, $user_info, $filter_user = false, $type = "json")
2980 $a = Friendica\DI::app();
2984 if (empty($items)) {
2988 foreach ((array)$items as $item) {
2989 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
2991 // Look if the posts are matching if they should be filtered by user id
2992 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2996 $status = api_format_item($item, $type, $status_user, $author_user, $owner_user);
3005 * @param array $item Item record
3006 * @param string $type Return format (atom, rss, xml, json)
3007 * @param array $status_user User record of the item author, can be provided by api_item_get_user()
3008 * @param array $author_user User record of the item author, can be provided by api_item_get_user()
3009 * @param array $owner_user User record of the item owner, can be provided by api_item_get_user()
3010 * @return array API-formatted status
3011 * @throws BadRequestException
3012 * @throws ImagickException
3013 * @throws InternalServerErrorException
3014 * @throws UnauthorizedException
3016 function api_format_item($item, $type = "json", $status_user = null, $author_user = null, $owner_user = null)
3018 $a = Friendica\DI::app();
3020 if (empty($status_user) || empty($author_user) || empty($owner_user)) {
3021 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
3024 localize_item($item);
3026 $in_reply_to = api_in_reply_to($item);
3028 $converted = api_convert_item($item);
3030 if ($type == "xml") {
3031 $geo = "georss:point";
3037 'text' => $converted["text"],
3038 'truncated' => false,
3039 'created_at'=> api_date($item['created']),
3040 'in_reply_to_status_id' => $in_reply_to['status_id'],
3041 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
3042 'source' => (($item['app']) ? $item['app'] : 'web'),
3043 'id' => intval($item['id']),
3044 'id_str' => (string) intval($item['id']),
3045 'in_reply_to_user_id' => $in_reply_to['user_id'],
3046 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
3047 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
3049 'favorited' => $item['starred'] ? true : false,
3050 'user' => $status_user,
3051 'friendica_author' => $author_user,
3052 'friendica_owner' => $owner_user,
3053 'friendica_private' => $item['private'] == Item::PRIVATE,
3054 //'entities' => NULL,
3055 'statusnet_html' => $converted["html"],
3056 'statusnet_conversation_id' => $item['parent'],
3057 'external_url' => DI::baseUrl() . "/display/" . $item['guid'],
3058 'friendica_activities' => api_format_items_activities($item, $type),
3059 'friendica_title' => $item['title'],
3060 'friendica_html' => BBCode::convert($item['body'], false)
3063 if (count($converted["attachments"]) > 0) {
3064 $status["attachments"] = $converted["attachments"];
3067 if (count($converted["entities"]) > 0) {
3068 $status["entities"] = $converted["entities"];
3071 if ($status["source"] == 'web') {
3072 $status["source"] = ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']);
3073 } elseif (ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']) != $status["source"]) {
3074 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']).')');
3077 $retweeted_item = [];
3080 if ($item['gravity'] == GRAVITY_PARENT) {
3081 $body = $item['body'];
3082 $retweeted_item = api_share_as_retweet($item);
3083 if ($body != $item['body']) {
3084 $quoted_item = $retweeted_item;
3085 $retweeted_item = [];
3089 if (empty($retweeted_item) && ($item['owner-id'] == $item['author-id'])) {
3090 $announce = api_get_announce($item);
3091 if (!empty($announce)) {
3092 $retweeted_item = $item;
3094 $status['friendica_owner'] = api_get_user($a, $announce['author-id']);
3098 if (!empty($quoted_item)) {
3099 if ($quoted_item['id'] != $item['id']) {
3100 $quoted_status = api_format_item($quoted_item);
3101 /// @todo Only remove the attachments that are also contained in the quotes status
3102 unset($status['attachments']);
3103 unset($status['entities']);
3105 $conv_quoted = api_convert_item($quoted_item);
3106 $quoted_status = $status;
3107 unset($quoted_status['attachments']);
3108 unset($quoted_status['entities']);
3109 unset($quoted_status['statusnet_conversation_id']);
3110 $quoted_status['text'] = $conv_quoted['text'];
3111 $quoted_status['statusnet_html'] = $conv_quoted['html'];
3113 $quoted_status["user"] = api_get_user($a, $quoted_item["author-id"]);
3114 } catch (BadRequestException $e) {
3115 // user not found. should be found?
3116 /// @todo check if the user should be always found
3117 $quoted_status["user"] = [];
3120 unset($quoted_status['friendica_author']);
3121 unset($quoted_status['friendica_owner']);
3122 unset($quoted_status['friendica_activities']);
3123 unset($quoted_status['friendica_private']);
3126 if (!empty($retweeted_item)) {
3127 $retweeted_status = $status;
3128 unset($retweeted_status['friendica_author']);
3129 unset($retweeted_status['friendica_owner']);
3130 unset($retweeted_status['friendica_activities']);
3131 unset($retweeted_status['friendica_private']);
3132 unset($retweeted_status['statusnet_conversation_id']);
3133 $status['user'] = $status['friendica_owner'];
3135 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
3136 } catch (BadRequestException $e) {
3137 // user not found. should be found?
3138 /// @todo check if the user should be always found
3139 $retweeted_status["user"] = [];
3142 $rt_converted = api_convert_item($retweeted_item);
3144 $retweeted_status['text'] = $rt_converted["text"];
3145 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3146 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
3148 if (!empty($quoted_status)) {
3149 $retweeted_status['quoted_status'] = $quoted_status;
3152 $status['friendica_author'] = $retweeted_status['user'];
3153 $status['retweeted_status'] = $retweeted_status;
3154 } elseif (!empty($quoted_status)) {
3155 $root_status = api_convert_item($item);
3157 $status['text'] = $root_status["text"];
3158 $status['statusnet_html'] = $root_status["html"];
3159 $status['quoted_status'] = $quoted_status;
3162 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3163 unset($status["user"]["uid"]);
3164 unset($status["user"]["self"]);
3166 if ($item["coord"] != "") {
3167 $coords = explode(' ', $item["coord"]);
3168 if (count($coords) == 2) {
3169 if ($type == "json") {
3170 $status["geo"] = ['type' => 'Point',
3171 'coordinates' => [(float) $coords[0],
3172 (float) $coords[1]]];
3173 } else {// Not sure if this is the official format - if someone founds a documentation we can check
3174 $status["georss:point"] = $item["coord"];
3183 * Returns the remaining number of API requests available to the user before the API limit is reached.
3185 * @param string $type Return type (atom, rss, xml, json)
3187 * @return array|string
3190 function api_account_rate_limit_status($type)
3192 if ($type == "xml") {
3194 'remaining-hits' => '150',
3195 '@attributes' => ["type" => "integer"],
3196 'hourly-limit' => '150',
3197 '@attributes2' => ["type" => "integer"],
3198 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
3199 '@attributes3' => ["type" => "datetime"],
3200 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3201 '@attributes4' => ["type" => "integer"],
3205 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3206 'remaining_hits' => '150',
3207 'hourly_limit' => '150',
3208 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
3212 return api_format_data('hash', $type, ['hash' => $hash]);
3215 /// @TODO move to top of file or somewhere better
3216 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3219 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3221 * @param string $type Return type (atom, rss, xml, json)
3223 * @return array|string
3225 function api_help_test($type)
3227 if ($type == 'xml') {
3233 return api_format_data('ok', $type, ["ok" => $ok]);
3236 /// @TODO move to top of file or somewhere better
3237 api_register_func('api/help/test', 'api_help_test', false);
3240 * Returns all lists the user subscribes to.
3242 * @param string $type Return type (atom, rss, xml, json)
3244 * @return array|string
3245 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3247 function api_lists_list($type)
3250 /// @TODO $ret is not filled here?
3251 return api_format_data('lists', $type, ["lists_list" => $ret]);
3254 /// @TODO move to top of file or somewhere better
3255 api_register_func('api/lists/list', 'api_lists_list', true);
3256 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3259 * Returns all groups the user owns.
3261 * @param string $type Return type (atom, rss, xml, json)
3263 * @return array|string
3264 * @throws BadRequestException
3265 * @throws ForbiddenException
3266 * @throws ImagickException
3267 * @throws InternalServerErrorException
3268 * @throws UnauthorizedException
3269 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3271 function api_lists_ownerships($type)
3275 if (api_user() === false) {
3276 throw new ForbiddenException();
3280 $user_info = api_get_user($a);
3281 $uid = $user_info['uid'];
3283 $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3285 // loop through all groups
3287 foreach ($groups as $group) {
3288 if ($group['visible']) {
3294 'name' => $group['name'],
3295 'id' => intval($group['id']),
3296 'id_str' => (string) $group['id'],
3297 'user' => $user_info,
3301 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3304 /// @TODO move to top of file or somewhere better
3305 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3308 * Returns recent statuses from users in the specified group.
3310 * @param string $type Return type (atom, rss, xml, json)
3312 * @return array|string
3313 * @throws BadRequestException
3314 * @throws ForbiddenException
3315 * @throws ImagickException
3316 * @throws InternalServerErrorException
3317 * @throws UnauthorizedException
3318 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3320 function api_lists_statuses($type)
3324 $user_info = api_get_user($a);
3325 if (api_user() === false || $user_info === false) {
3326 throw new ForbiddenException();
3329 unset($_REQUEST["user_id"]);
3330 unset($_GET["user_id"]);
3332 unset($_REQUEST["screen_name"]);
3333 unset($_GET["screen_name"]);
3335 if (empty($_REQUEST['list_id'])) {
3336 throw new BadRequestException('list_id not specified');
3340 $count = $_REQUEST['count'] ?? 20;
3341 $page = $_REQUEST['page'] ?? 1;
3342 $since_id = $_REQUEST['since_id'] ?? 0;
3343 $max_id = $_REQUEST['max_id'] ?? 0;
3344 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
3345 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
3347 $start = max(0, ($page - 1) * $count);
3349 $groups = DBA::selectToArray('group_member', ['contact-id'], ['gid' => 1]);
3350 $gids = array_column($groups, 'contact-id');
3351 $condition = ['uid' => api_user(), 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'group-id' => $gids];
3352 $condition = DBA::mergeConditions($condition, ["`id` > ?", $since_id]);
3355 $condition[0] .= " AND `id` <= ?";
3356 $condition[] = $max_id;
3358 if ($exclude_replies > 0) {
3359 $condition[0] .= ' AND `gravity` = ?';
3360 $condition[] = GRAVITY_PARENT;
3362 if ($conversation_id > 0) {
3363 $condition[0] .= " AND `parent` = ?";
3364 $condition[] = $conversation_id;
3367 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3368 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
3370 $items = api_format_items(Post::toArray($statuses), $user_info, false, $type);
3372 $data = ['status' => $items];
3377 $data = api_rss_extra($a, $data, $user_info);
3381 return api_format_data("statuses", $type, $data);
3384 /// @TODO move to top of file or somewhere better
3385 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3388 * Returns either the friends of the follower list
3390 * Considers friends and followers lists to be private and won't return
3391 * anything if any user_id parameter is passed.
3393 * @param string $qtype Either "friends" or "followers"
3394 * @return boolean|array
3395 * @throws BadRequestException
3396 * @throws ForbiddenException
3397 * @throws ImagickException
3398 * @throws InternalServerErrorException
3399 * @throws UnauthorizedException
3401 function api_statuses_f($qtype)
3405 if (api_user() === false) {
3406 throw new ForbiddenException();
3410 $count = $_GET['count'] ?? 20;
3411 $page = $_GET['page'] ?? 1;
3413 $start = max(0, ($page - 1) * $count);
3415 $user_info = api_get_user($a);
3417 if (!empty($_GET['cursor']) && $_GET['cursor'] == 'undefined') {
3418 /* this is to stop Hotot to load friends multiple times
3419 * I'm not sure if I'm missing return something or
3420 * is a bug in hotot. Workaround, meantime
3424 return array('$users' => $ret);*/
3429 if ($qtype == 'friends') {
3430 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
3431 } elseif ($qtype == 'followers') {
3432 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
3435 // friends and followers only for self
3436 if ($user_info['self'] == 0) {
3437 $sql_extra = " AND false ";
3440 if ($qtype == 'blocks') {
3441 $sql_filter = 'AND `blocked` AND NOT `pending`';
3442 } elseif ($qtype == 'incoming') {
3443 $sql_filter = 'AND `pending`';
3445 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3463 foreach ($r as $cid) {
3464 $user = api_get_user($a, $cid['nurl']);
3465 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3466 unset($user["uid"]);
3467 unset($user["self"]);
3474 return ['user' => $ret];
3479 * Returns the list of friends of the provided user
3481 * @deprecated By Twitter API in favor of friends/list
3483 * @param string $type Either "json" or "xml"
3484 * @return boolean|string|array
3485 * @throws BadRequestException
3486 * @throws ForbiddenException
3488 function api_statuses_friends($type)
3490 $data = api_statuses_f("friends");
3491 if ($data === false) {
3494 return api_format_data("users", $type, $data);
3498 * Returns the list of followers of the provided user
3500 * @deprecated By Twitter API in favor of friends/list
3502 * @param string $type Either "json" or "xml"
3503 * @return boolean|string|array
3504 * @throws BadRequestException
3505 * @throws ForbiddenException
3507 function api_statuses_followers($type)
3509 $data = api_statuses_f("followers");
3510 if ($data === false) {
3513 return api_format_data("users", $type, $data);
3516 /// @TODO move to top of file or somewhere better
3517 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3518 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3521 * Returns the list of blocked users
3523 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3525 * @param string $type Either "json" or "xml"
3527 * @return boolean|string|array
3528 * @throws BadRequestException
3529 * @throws ForbiddenException
3531 function api_blocks_list($type)
3533 $data = api_statuses_f('blocks');
3534 if ($data === false) {
3537 return api_format_data("users", $type, $data);
3540 /// @TODO move to top of file or somewhere better
3541 api_register_func('api/blocks/list', 'api_blocks_list', true);
3544 * Returns the list of pending users IDs
3546 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3548 * @param string $type Either "json" or "xml"
3550 * @return boolean|string|array
3551 * @throws BadRequestException
3552 * @throws ForbiddenException
3554 function api_friendships_incoming($type)
3556 $data = api_statuses_f('incoming');
3557 if ($data === false) {
3562 foreach ($data['user'] as $user) {
3563 $ids[] = $user['id'];
3566 return api_format_data("ids", $type, ['id' => $ids]);
3569 /// @TODO move to top of file or somewhere better
3570 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3573 * Returns the instance's configuration information.
3575 * @param string $type Return type (atom, rss, xml, json)
3577 * @return array|string
3578 * @throws InternalServerErrorException
3580 function api_statusnet_config($type)
3582 $name = DI::config()->get('config', 'sitename');
3583 $server = DI::baseUrl()->getHostname();
3584 $logo = DI::baseUrl() . '/images/friendica-64.png';
3585 $email = DI::config()->get('config', 'admin_email');
3586 $closed = intval(DI::config()->get('config', 'register_policy')) === \Friendica\Module\Register::CLOSED ? 'true' : 'false';
3587 $private = DI::config()->get('system', 'block_public') ? 'true' : 'false';
3588 $textlimit = (string) DI::config()->get('config', 'api_import_size', DI::config()->get('config', 'max_import_size', 200000));
3589 $ssl = DI::config()->get('system', 'have_ssl') ? 'true' : 'false';
3590 $sslserver = DI::config()->get('system', 'have_ssl') ? str_replace('http:', 'https:', DI::baseUrl()) : '';
3593 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3594 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3595 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3596 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3597 'shorturllength' => '30',
3599 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3600 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3601 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3602 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3607 return api_format_data('config', $type, ['config' => $config]);
3610 /// @TODO move to top of file or somewhere better
3611 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3612 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3616 * @param string $type Return type (atom, rss, xml, json)
3618 * @return array|string
3620 function api_statusnet_version($type)
3623 $fake_statusnet_version = "0.9.7";
3625 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3628 /// @TODO move to top of file or somewhere better
3629 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3630 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3633 * Sends a new direct message.
3635 * @param string $type Return type (atom, rss, xml, json)
3637 * @return array|string
3638 * @throws BadRequestException
3639 * @throws ForbiddenException
3640 * @throws ImagickException
3641 * @throws InternalServerErrorException
3642 * @throws NotFoundException
3643 * @throws UnauthorizedException
3644 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3646 function api_direct_messages_new($type)
3650 if (api_user() === false) {
3651 throw new ForbiddenException();
3654 if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3658 $sender = api_get_user($a);
3661 if (!empty($_POST['screen_name'])) {
3663 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3665 DBA::escape($_POST['screen_name'])
3668 if (DBA::isResult($r)) {
3669 // Selecting the id by priority, friendica first
3670 api_best_nickname($r);
3672 $recipient = api_get_user($a, $r[0]['nurl']);
3675 $recipient = api_get_user($a, $_POST['user_id']);
3678 if (empty($recipient)) {
3679 throw new NotFoundException('Recipient not found');
3683 if (!empty($_REQUEST['replyto'])) {
3685 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3687 intval($_REQUEST['replyto'])
3689 $replyto = $r[0]['parent-uri'];
3690 $sub = $r[0]['title'];
3692 if (!empty($_REQUEST['title'])) {
3693 $sub = $_REQUEST['title'];
3695 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3699 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3702 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3703 $ret = api_format_messages($r[0], $recipient, $sender);
3705 $ret = ["error"=>$id];
3708 $data = ['direct_message'=>$ret];
3714 $data = api_rss_extra($a, $data, $sender);
3718 return api_format_data("direct-messages", $type, $data);
3721 /// @TODO move to top of file or somewhere better
3722 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3725 * delete a direct_message from mail table through api
3727 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3728 * @return string|array
3729 * @throws BadRequestException
3730 * @throws ForbiddenException
3731 * @throws ImagickException
3732 * @throws InternalServerErrorException
3733 * @throws UnauthorizedException
3734 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3736 function api_direct_messages_destroy($type)
3740 if (api_user() === false) {
3741 throw new ForbiddenException();
3745 $user_info = api_get_user($a);
3747 $id = $_REQUEST['id'] ?? 0;
3749 $parenturi = $_REQUEST['friendica_parenturi'] ?? '';
3750 $verbose = (!empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false");
3751 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3753 $uid = $user_info['uid'];
3754 // error if no id or parenturi specified (for clients posting parent-uri as well)
3755 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3756 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3757 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3760 // BadRequestException if no id specified (for clients using Twitter API)
3762 throw new BadRequestException('Message id not specified');
3765 // add parent-uri to sql command if specified by calling app
3766 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3768 // get data of the specified message id
3770 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3775 // error message if specified id is not in database
3776 if (!DBA::isResult($r)) {
3777 if ($verbose == "true") {
3778 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3779 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3781 /// @todo BadRequestException ok for Twitter API clients?
3782 throw new BadRequestException('message id not in database');
3787 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3792 if ($verbose == "true") {
3795 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3796 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3798 $answer = ['result' => 'error', 'message' => 'unknown error'];
3799 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3802 /// @todo return JSON data like Twitter API not yet implemented
3805 /// @TODO move to top of file or somewhere better
3806 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3811 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3812 * @return string|array
3813 * @throws BadRequestException
3814 * @throws ForbiddenException
3815 * @throws ImagickException
3816 * @throws InternalServerErrorException
3817 * @throws NotFoundException
3818 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3820 function api_friendships_destroy($type)
3824 if ($uid === false) {
3825 throw new ForbiddenException();
3828 $contact_id = $_REQUEST['user_id'] ?? 0;
3830 if (empty($contact_id)) {
3831 Logger::notice(API_LOG_PREFIX . 'No user_id specified', ['module' => 'api', 'action' => 'friendships_destroy']);
3832 throw new BadRequestException("no user_id specified");
3835 // Get Contact by given id
3836 $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3838 if(!DBA::isResult($contact)) {
3839 Logger::notice(API_LOG_PREFIX . 'No contact found for ID {contact}', ['module' => 'api', 'action' => 'friendships_destroy', 'contact' => $contact_id]);
3840 throw new NotFoundException("no contact found to given ID");
3843 $url = $contact["url"];
3845 $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3846 $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url),
3847 Strings::normaliseLink($url), $url];
3848 $contact = DBA::selectFirst('contact', [], $condition);
3850 if (!DBA::isResult($contact)) {
3851 Logger::notice(API_LOG_PREFIX . 'Not following contact', ['module' => 'api', 'action' => 'friendships_destroy']);
3852 throw new NotFoundException("Not following Contact");
3855 if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
3856 Logger::notice(API_LOG_PREFIX . 'Not supported for {network}', ['module' => 'api', 'action' => 'friendships_destroy', 'network' => $contact['network']]);
3857 throw new ExpectationFailedException("Not supported");
3860 $dissolve = ($contact['rel'] == Contact::SHARING);
3862 $owner = User::getOwnerDataById($uid);
3864 Contact::terminateFriendship($owner, $contact, $dissolve);
3867 Logger::notice(API_LOG_PREFIX . 'No owner {uid} found', ['module' => 'api', 'action' => 'friendships_destroy', 'uid' => $uid]);
3868 throw new NotFoundException("Error Processing Request");
3871 // Sharing-only contacts get deleted as there no relationship any more
3873 Contact::remove($contact['id']);
3875 DBA::update('contact', ['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
3878 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3879 unset($contact["uid"]);
3880 unset($contact["self"]);
3882 // Set screen_name since Twidere requests it
3883 $contact["screen_name"] = $contact["nick"];
3885 return api_format_data("friendships-destroy", $type, ['user' => $contact]);
3887 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3891 * @param string $type Return type (atom, rss, xml, json)
3892 * @param string $box
3893 * @param string $verbose
3895 * @return array|string
3896 * @throws BadRequestException
3897 * @throws ForbiddenException
3898 * @throws ImagickException
3899 * @throws InternalServerErrorException
3900 * @throws UnauthorizedException
3902 function api_direct_messages_box($type, $box, $verbose)
3905 if (api_user() === false) {
3906 throw new ForbiddenException();
3909 $count = $_GET['count'] ?? 20;
3910 $page = $_REQUEST['page'] ?? 1;
3912 $since_id = $_REQUEST['since_id'] ?? 0;
3913 $max_id = $_REQUEST['max_id'] ?? 0;
3915 $user_id = $_REQUEST['user_id'] ?? '';
3916 $screen_name = $_REQUEST['screen_name'] ?? '';
3919 unset($_REQUEST["user_id"]);
3920 unset($_GET["user_id"]);
3922 unset($_REQUEST["screen_name"]);
3923 unset($_GET["screen_name"]);
3925 $user_info = api_get_user($a);
3926 if ($user_info === false) {
3927 throw new ForbiddenException();
3929 $profile_url = $user_info["url"];
3932 $start = max(0, ($page - 1) * $count);
3937 if ($box=="sentbox") {
3938 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
3939 } elseif ($box == "conversation") {
3940 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape($_GET['uri'] ?? '') . "'";
3941 } elseif ($box == "all") {
3942 $sql_extra = "true";
3943 } elseif ($box == "inbox") {
3944 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
3948 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3951 if ($user_id != "") {
3952 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3953 } elseif ($screen_name !="") {
3954 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
3958 "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",
3964 if ($verbose == "true" && !DBA::isResult($r)) {
3965 $answer = ['result' => 'error', 'message' => 'no mails available'];
3966 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3970 foreach ($r as $item) {
3971 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3972 $recipient = $user_info;
3973 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3974 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3975 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3976 $sender = $user_info;
3979 if (isset($recipient) && isset($sender)) {
3980 $ret[] = api_format_messages($item, $recipient, $sender);
3985 $data = ['direct_message' => $ret];
3990 $data = api_rss_extra($a, $data, $user_info);
3994 return api_format_data("direct-messages", $type, $data);
3998 * Returns the most recent direct messages sent by the user.
4000 * @param string $type Return type (atom, rss, xml, json)
4002 * @return array|string
4003 * @throws BadRequestException
4004 * @throws ForbiddenException
4005 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
4007 function api_direct_messages_sentbox($type)
4009 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4010 return api_direct_messages_box($type, "sentbox", $verbose);
4014 * Returns the most recent direct messages sent to the user.
4016 * @param string $type Return type (atom, rss, xml, json)
4018 * @return array|string
4019 * @throws BadRequestException
4020 * @throws ForbiddenException
4021 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
4023 function api_direct_messages_inbox($type)
4025 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4026 return api_direct_messages_box($type, "inbox", $verbose);
4031 * @param string $type Return type (atom, rss, xml, json)
4033 * @return array|string
4034 * @throws BadRequestException
4035 * @throws ForbiddenException
4037 function api_direct_messages_all($type)
4039 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4040 return api_direct_messages_box($type, "all", $verbose);
4045 * @param string $type Return type (atom, rss, xml, json)
4047 * @return array|string
4048 * @throws BadRequestException
4049 * @throws ForbiddenException
4051 function api_direct_messages_conversation($type)
4053 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4054 return api_direct_messages_box($type, "conversation", $verbose);
4057 /// @TODO move to top of file or somewhere better
4058 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
4059 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
4060 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
4061 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
4064 * Returns an OAuth Request Token.
4066 * @see https://oauth.net/core/1.0/#auth_step1
4068 function api_oauth_request_token()
4070 $oauth1 = new FKOAuth1();
4072 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
4073 } catch (Exception $e) {
4074 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
4082 * Returns an OAuth Access Token.
4084 * @return array|string
4085 * @see https://oauth.net/core/1.0/#auth_step3
4087 function api_oauth_access_token()
4089 $oauth1 = new FKOAuth1();
4091 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
4092 } catch (Exception $e) {
4093 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
4100 /// @TODO move to top of file or somewhere better
4101 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
4102 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
4106 * delete a complete photoalbum with all containing photos from database through api
4108 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4109 * @return string|array
4110 * @throws BadRequestException
4111 * @throws ForbiddenException
4112 * @throws InternalServerErrorException
4114 function api_fr_photoalbum_delete($type)
4116 if (api_user() === false) {
4117 throw new ForbiddenException();
4120 $album = $_REQUEST['album'] ?? '';
4122 // we do not allow calls without album string
4124 throw new BadRequestException("no albumname specified");
4126 // check if album is existing
4128 $photos = DBA::selectToArray('photo', ['resource-id'], ['uid' => api_user(), 'album' => $album], ['group_by' => ['resource-id']]);
4129 if (!DBA::isResult($photos)) {
4130 throw new BadRequestException("album not available");
4133 $resourceIds = array_column($photos, 'resource-id');
4135 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4136 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
4137 $condition = ['uid' => api_user(), 'resource-id' => $resourceIds, 'type' => 'photo'];
4138 Item::deleteForUser($condition, api_user());
4140 // now let's delete all photos from the album
4141 $result = Photo::delete(['uid' => api_user(), 'album' => $album]);
4143 // return success of deletion or error message
4145 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
4146 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
4148 throw new InternalServerErrorException("unknown error - deleting from database failed");
4153 * update the name of the album for all photos of an album
4155 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4156 * @return string|array
4157 * @throws BadRequestException
4158 * @throws ForbiddenException
4159 * @throws InternalServerErrorException
4161 function api_fr_photoalbum_update($type)
4163 if (api_user() === false) {
4164 throw new ForbiddenException();
4167 $album = $_REQUEST['album'] ?? '';
4168 $album_new = $_REQUEST['album_new'] ?? '';
4170 // we do not allow calls without album string
4172 throw new BadRequestException("no albumname specified");
4174 if ($album_new == "") {
4175 throw new BadRequestException("no new albumname specified");
4177 // check if album is existing
4178 if (!Photo::exists(['uid' => api_user(), 'album' => $album])) {
4179 throw new BadRequestException("album not available");
4181 // now let's update all photos to the albumname
4182 $result = Photo::update(['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
4184 // return success of updating or error message
4186 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4187 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4189 throw new InternalServerErrorException("unknown error - updating in database failed");
4195 * list all photos of the authenticated user
4197 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4198 * @return string|array
4199 * @throws ForbiddenException
4200 * @throws InternalServerErrorException
4202 function api_fr_photos_list($type)
4204 if (api_user() === false) {
4205 throw new ForbiddenException();
4208 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4209 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4210 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`, `album`, `filename`, `type`",
4211 intval(local_user())
4214 'image/jpeg' => 'jpg',
4215 'image/png' => 'png',
4216 'image/gif' => 'gif'
4218 $data = ['photo'=>[]];
4219 if (DBA::isResult($r)) {
4220 foreach ($r as $rr) {
4222 $photo['id'] = $rr['resource-id'];
4223 $photo['album'] = $rr['album'];
4224 $photo['filename'] = $rr['filename'];
4225 $photo['type'] = $rr['type'];
4226 $thumb = DI::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4227 $photo['created'] = $rr['created'];
4228 $photo['edited'] = $rr['edited'];
4229 $photo['desc'] = $rr['desc'];
4231 if ($type == "xml") {
4232 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4234 $photo['thumb'] = $thumb;
4235 $data['photo'][] = $photo;
4239 return api_format_data("photos", $type, $data);
4243 * upload a new photo or change an existing photo
4245 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4246 * @return string|array
4247 * @throws BadRequestException
4248 * @throws ForbiddenException
4249 * @throws ImagickException
4250 * @throws InternalServerErrorException
4251 * @throws NotFoundException
4253 function api_fr_photo_create_update($type)
4255 if (api_user() === false) {
4256 throw new ForbiddenException();
4259 $photo_id = $_REQUEST['photo_id'] ?? null;
4260 $desc = $_REQUEST['desc'] ?? null;
4261 $album = $_REQUEST['album'] ?? null;
4262 $album_new = $_REQUEST['album_new'] ?? null;
4263 $allow_cid = $_REQUEST['allow_cid'] ?? null;
4264 $deny_cid = $_REQUEST['deny_cid' ] ?? null;
4265 $allow_gid = $_REQUEST['allow_gid'] ?? null;
4266 $deny_gid = $_REQUEST['deny_gid' ] ?? null;
4267 $visibility = !$allow_cid && !$deny_cid && !$allow_gid && !$deny_gid;
4269 // do several checks on input parameters
4270 // we do not allow calls without album string
4271 if ($album == null) {
4272 throw new BadRequestException("no albumname specified");
4274 // if photo_id == null --> we are uploading a new photo
4275 if ($photo_id == null) {
4278 // error if no media posted in create-mode
4279 if (empty($_FILES['media'])) {
4281 throw new BadRequestException("no media data submitted");
4284 // album_new will be ignored in create-mode
4289 // check if photo is existing in databasei
4290 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user(), 'album' => $album])) {
4291 throw new BadRequestException("photo not available");
4295 // checks on acl strings provided by clients
4296 $acl_input_error = false;
4297 $acl_input_error |= check_acl_input($allow_cid);
4298 $acl_input_error |= check_acl_input($deny_cid);
4299 $acl_input_error |= check_acl_input($allow_gid);
4300 $acl_input_error |= check_acl_input($deny_gid);
4301 if ($acl_input_error) {
4302 throw new BadRequestException("acl data invalid");
4304 // now let's upload the new media in create-mode
4305 if ($mode == "create") {
4306 $media = $_FILES['media'];
4307 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4309 // return success of updating or error message
4310 if (!is_null($data)) {
4311 return api_format_data("photo_create", $type, $data);
4313 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4317 // now let's do the changes in update-mode
4318 if ($mode == "update") {
4319 $updated_fields = [];
4321 if (!is_null($desc)) {
4322 $updated_fields['desc'] = $desc;
4325 if (!is_null($album_new)) {
4326 $updated_fields['album'] = $album_new;
4329 if (!is_null($allow_cid)) {
4330 $allow_cid = trim($allow_cid);
4331 $updated_fields['allow_cid'] = $allow_cid;
4334 if (!is_null($deny_cid)) {
4335 $deny_cid = trim($deny_cid);
4336 $updated_fields['deny_cid'] = $deny_cid;
4339 if (!is_null($allow_gid)) {
4340 $allow_gid = trim($allow_gid);
4341 $updated_fields['allow_gid'] = $allow_gid;
4344 if (!is_null($deny_gid)) {
4345 $deny_gid = trim($deny_gid);
4346 $updated_fields['deny_gid'] = $deny_gid;
4350 if (count($updated_fields) > 0) {
4351 $nothingtodo = false;
4352 $result = Photo::update($updated_fields, ['uid' => api_user(), 'resource-id' => $photo_id, 'album' => $album]);
4354 $nothingtodo = true;
4357 if (!empty($_FILES['media'])) {
4358 $nothingtodo = false;
4359 $media = $_FILES['media'];
4360 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4361 if (!is_null($data)) {
4362 return api_format_data("photo_update", $type, $data);
4366 // return success of updating or error message
4368 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4369 return api_format_data("photo_update", $type, ['$result' => $answer]);
4372 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4373 return api_format_data("photo_update", $type, ['$result' => $answer]);
4375 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4378 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4382 * delete a single photo from the database through api
4384 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4385 * @return string|array
4386 * @throws BadRequestException
4387 * @throws ForbiddenException
4388 * @throws InternalServerErrorException
4390 function api_fr_photo_delete($type)
4392 if (api_user() === false) {
4393 throw new ForbiddenException();
4397 $photo_id = $_REQUEST['photo_id'] ?? null;
4399 // do several checks on input parameters
4400 // we do not allow calls without photo id
4401 if ($photo_id == null) {
4402 throw new BadRequestException("no photo_id specified");
4405 // check if photo is existing in database
4406 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user()])) {
4407 throw new BadRequestException("photo not available");
4410 // now we can perform on the deletion of the photo
4411 $result = Photo::delete(['uid' => api_user(), 'resource-id' => $photo_id]);
4413 // return success of deletion or error message
4415 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4416 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4417 $condition = ['uid' => api_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4418 Item::deleteForUser($condition, api_user());
4420 $result = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4421 return api_format_data("photo_delete", $type, ['$result' => $result]);
4423 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4429 * returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4431 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4432 * @return string|array
4433 * @throws BadRequestException
4434 * @throws ForbiddenException
4435 * @throws InternalServerErrorException
4436 * @throws NotFoundException
4438 function api_fr_photo_detail($type)
4440 if (api_user() === false) {
4441 throw new ForbiddenException();
4443 if (empty($_REQUEST['photo_id'])) {
4444 throw new BadRequestException("No photo id.");
4447 $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
4448 $photo_id = $_REQUEST['photo_id'];
4450 // prepare json/xml output with data from database for the requested photo
4451 $data = prepare_photo_data($type, $scale, $photo_id);
4453 return api_format_data("photo_detail", $type, $data);
4458 * updates the profile image for the user (either a specified profile or the default profile)
4460 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4462 * @return string|array
4463 * @throws BadRequestException
4464 * @throws ForbiddenException
4465 * @throws ImagickException
4466 * @throws InternalServerErrorException
4467 * @throws NotFoundException
4468 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4470 function api_account_update_profile_image($type)
4472 if (api_user() === false) {
4473 throw new ForbiddenException();
4476 $profile_id = $_REQUEST['profile_id'] ?? 0;
4478 // error if image data is missing
4479 if (empty($_FILES['image'])) {
4480 throw new BadRequestException("no media data submitted");
4483 // check if specified profile id is valid
4484 if ($profile_id != 0) {
4485 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4486 // error message if specified profile id is not in database
4487 if (!DBA::isResult($profile)) {
4488 throw new BadRequestException("profile_id not available");
4490 $is_default_profile = $profile['is-default'];
4492 $is_default_profile = 1;
4495 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4497 if (!empty($_FILES['image'])) {
4498 $media = $_FILES['image'];
4499 } elseif (!empty($_FILES['media'])) {
4500 $media = $_FILES['media'];
4502 // save new profile image
4503 $data = save_media_to_database("profileimage", $media, $type, DI::l10n()->t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4506 if (is_array($media['type'])) {
4507 $filetype = $media['type'][0];
4509 $filetype = $media['type'];
4511 if ($filetype == "image/jpeg") {
4513 } elseif ($filetype == "image/png") {
4516 throw new InternalServerErrorException('Unsupported filetype');
4519 // change specified profile or all profiles to the new resource-id
4520 if ($is_default_profile) {
4521 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4522 Photo::update(['profile' => false], $condition);
4524 $fields = ['photo' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext,
4525 'thumb' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext];
4526 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4529 Contact::updateSelfFromUserID(api_user(), true);
4531 // Update global directory in background
4532 $url = DI::baseUrl() . '/profile/' . DI::app()->user['nickname'];
4533 if ($url && strlen(DI::config()->get('system', 'directory'))) {
4534 Worker::add(PRIORITY_LOW, "Directory", $url);
4537 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4539 // output for client
4541 return api_account_verify_credentials($type);
4543 // SaveMediaToDatabase failed for some reason
4544 throw new InternalServerErrorException("image upload failed");
4548 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4549 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4550 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4551 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4552 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4553 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4554 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4555 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4556 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4559 * Update user profile
4561 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4563 * @return array|string
4564 * @throws BadRequestException
4565 * @throws ForbiddenException
4566 * @throws ImagickException
4567 * @throws InternalServerErrorException
4568 * @throws UnauthorizedException
4570 function api_account_update_profile($type)
4572 $local_user = api_user();
4573 $api_user = api_get_user(DI::app());
4575 if (!empty($_POST['name'])) {
4576 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4577 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4578 DBA::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4579 DBA::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4582 if (isset($_POST['description'])) {
4583 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4584 DBA::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4585 DBA::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4588 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4589 // Update global directory in background
4590 if ($api_user['url'] && strlen(DI::config()->get('system', 'directory'))) {
4591 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4594 return api_account_verify_credentials($type);
4597 /// @TODO move to top of file or somewhere better
4598 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4602 * @param string $acl_string
4606 function check_acl_input($acl_string)
4608 if (empty($acl_string)) {
4612 $contact_not_found = false;
4614 // split <x><y><z> into array of cid's
4615 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4617 // check for each cid if it is available on server
4618 $cid_array = $array[0];
4619 foreach ($cid_array as $cid) {
4620 $cid = str_replace("<", "", $cid);
4621 $cid = str_replace(">", "", $cid);
4622 $condition = ['id' => $cid, 'uid' => api_user()];
4623 $contact_not_found |= !DBA::exists('contact', $condition);
4625 return $contact_not_found;
4629 * @param string $mediatype
4630 * @param array $media
4631 * @param string $type
4632 * @param string $album
4633 * @param string $allow_cid
4634 * @param string $deny_cid
4635 * @param string $allow_gid
4636 * @param string $deny_gid
4637 * @param string $desc
4638 * @param integer $profile
4639 * @param boolean $visibility
4640 * @param string $photo_id
4642 * @throws BadRequestException
4643 * @throws ForbiddenException
4644 * @throws ImagickException
4645 * @throws InternalServerErrorException
4646 * @throws NotFoundException
4647 * @throws UnauthorizedException
4649 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)
4657 if (is_array($media)) {
4658 if (is_array($media['tmp_name'])) {
4659 $src = $media['tmp_name'][0];
4661 $src = $media['tmp_name'];
4663 if (is_array($media['name'])) {
4664 $filename = basename($media['name'][0]);
4666 $filename = basename($media['name']);
4668 if (is_array($media['size'])) {
4669 $filesize = intval($media['size'][0]);
4671 $filesize = intval($media['size']);
4673 if (is_array($media['type'])) {
4674 $filetype = $media['type'][0];
4676 $filetype = $media['type'];
4680 $filetype = Images::getMimeTypeBySource($src, $filename, $filetype);
4683 "File upload src: " . $src . " - filename: " . $filename .
4684 " - size: " . $filesize . " - type: " . $filetype,
4688 // check if there was a php upload error
4689 if ($filesize == 0 && $media['error'] == 1) {
4690 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4692 // check against max upload size within Friendica instance
4693 $maximagesize = DI::config()->get('system', 'maximagesize');
4694 if ($maximagesize && ($filesize > $maximagesize)) {
4695 $formattedBytes = Strings::formatBytes($maximagesize);
4696 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4699 // create Photo instance with the data of the image
4700 $imagedata = @file_get_contents($src);
4701 $Image = new Image($imagedata, $filetype);
4702 if (!$Image->isValid()) {
4703 throw new InternalServerErrorException("unable to process image data");
4706 // check orientation of image
4707 $Image->orient($src);
4710 // check max length of images on server
4711 $max_length = DI::config()->get('system', 'max_image_length');
4713 $max_length = MAX_IMAGE_LENGTH;
4715 if ($max_length > 0) {
4716 $Image->scaleDown($max_length);
4717 Logger::log("File upload: Scaling picture to new size " . $max_length, Logger::DEBUG);
4719 $width = $Image->getWidth();
4720 $height = $Image->getHeight();
4722 // create a new resource-id if not already provided
4723 $resource_id = ($photo_id == null) ? Photo::newResource() : $photo_id;
4725 if ($mediatype == "photo") {
4726 // upload normal image (scales 0, 1, 2)
4727 Logger::log("photo upload: starting new photo upload", Logger::DEBUG);
4729 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4731 Logger::log("photo upload: image upload with scale 0 (original size) failed");
4733 if ($width > 640 || $height > 640) {
4734 $Image->scaleDown(640);
4735 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4737 Logger::log("photo upload: image upload with scale 1 (640x640) failed");
4741 if ($width > 320 || $height > 320) {
4742 $Image->scaleDown(320);
4743 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4745 Logger::log("photo upload: image upload with scale 2 (320x320) failed");
4748 Logger::log("photo upload: new photo upload ended", Logger::DEBUG);
4749 } elseif ($mediatype == "profileimage") {
4750 // upload profile image (scales 4, 5, 6)
4751 Logger::log("photo upload: starting new profile image upload", Logger::DEBUG);
4753 if ($width > 300 || $height > 300) {
4754 $Image->scaleDown(300);
4755 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4757 Logger::log("photo upload: profile image upload with scale 4 (300x300) failed");
4761 if ($width > 80 || $height > 80) {
4762 $Image->scaleDown(80);
4763 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4765 Logger::log("photo upload: profile image upload with scale 5 (80x80) failed");
4769 if ($width > 48 || $height > 48) {
4770 $Image->scaleDown(48);
4771 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4773 Logger::log("photo upload: profile image upload with scale 6 (48x48) failed");
4776 $Image->__destruct();
4777 Logger::log("photo upload: new profile image upload ended", Logger::DEBUG);
4781 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4782 if ($photo_id == null && $mediatype == "photo") {
4783 post_photo_item($resource_id, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4785 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4786 return prepare_photo_data($type, false, $resource_id);
4788 throw new InternalServerErrorException("image upload failed");
4794 * @param string $hash
4795 * @param string $allow_cid
4796 * @param string $deny_cid
4797 * @param string $allow_gid
4798 * @param string $deny_gid
4799 * @param string $filetype
4800 * @param boolean $visibility
4801 * @throws InternalServerErrorException
4803 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4805 // get data about the api authenticated user
4806 $uri = Item::newURI(intval(api_user()));
4807 $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
4810 $arr['guid'] = System::createUUID();
4811 $arr['uid'] = intval(api_user());
4813 $arr['type'] = 'photo';
4815 $arr['resource-id'] = $hash;
4816 $arr['contact-id'] = $owner_record['id'];
4817 $arr['owner-name'] = $owner_record['name'];
4818 $arr['owner-link'] = $owner_record['url'];
4819 $arr['owner-avatar'] = $owner_record['thumb'];
4820 $arr['author-name'] = $owner_record['name'];
4821 $arr['author-link'] = $owner_record['url'];
4822 $arr['author-avatar'] = $owner_record['thumb'];
4824 $arr['allow_cid'] = $allow_cid;
4825 $arr['allow_gid'] = $allow_gid;
4826 $arr['deny_cid'] = $deny_cid;
4827 $arr['deny_gid'] = $deny_gid;
4828 $arr['visible'] = $visibility;
4832 'image/jpeg' => 'jpg',
4833 'image/png' => 'png',
4834 'image/gif' => 'gif'
4837 // adds link to the thumbnail scale photo
4838 $arr['body'] = '[url=' . DI::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
4839 . '[img]' . DI::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4842 // do the magic for storing the item in the database and trigger the federation to other contacts
4848 * @param string $type
4850 * @param string $photo_id
4853 * @throws BadRequestException
4854 * @throws ForbiddenException
4855 * @throws ImagickException
4856 * @throws InternalServerErrorException
4857 * @throws NotFoundException
4858 * @throws UnauthorizedException
4860 function prepare_photo_data($type, $scale, $photo_id)
4863 $user_info = api_get_user($a);
4865 if ($user_info === false) {
4866 throw new ForbiddenException();
4869 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4870 $data_sql = ($scale === false ? "" : "data, ");
4872 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4873 // clients needs to convert this in their way for further processing
4875 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4876 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4877 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4878 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY
4879 `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4880 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`",
4882 intval(local_user()),
4883 DBA::escape($photo_id),
4888 'image/jpeg' => 'jpg',
4889 'image/png' => 'png',
4890 'image/gif' => 'gif'
4893 // prepare output data for photo
4894 if (DBA::isResult($r)) {
4895 $data = ['photo' => $r[0]];
4896 $data['photo']['id'] = $data['photo']['resource-id'];
4897 if ($scale !== false) {
4898 $data['photo']['data'] = base64_encode($data['photo']['data']);
4900 unset($data['photo']['datasize']); //needed only with scale param
4902 if ($type == "xml") {
4903 $data['photo']['links'] = [];
4904 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4905 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4907 "href" => DI::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4910 $data['photo']['link'] = [];
4911 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4913 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4914 $data['photo']['link'][$i] = DI::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4918 unset($data['photo']['resource-id']);
4919 unset($data['photo']['minscale']);
4920 unset($data['photo']['maxscale']);
4922 throw new NotFoundException();
4925 // retrieve item element for getting activities (like, dislike etc.) related to photo
4926 $condition = ['uid' => api_user(), 'resource-id' => $photo_id];
4927 $item = Post::selectFirst(['id', 'uid', 'uri', 'parent', 'allow_cid', 'deny_cid', 'allow_gid', 'deny_gid'], $condition);
4928 if (!DBA::isResult($item)) {
4929 throw new NotFoundException('Photo-related item not found.');
4932 $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4934 // retrieve comments on photo
4935 $condition = ["`parent` = ? AND `uid` = ? AND `gravity` IN (?, ?)",
4936 $item['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4938 $statuses = Post::selectForUser(api_user(), [], $condition);
4940 // prepare output of comments
4941 $commentData = api_format_items(Post::toArray($statuses), $user_info, false, $type);
4943 if ($type == "xml") {
4945 foreach ($commentData as $comment) {
4946 $comments[$k++ . ":comment"] = $comment;
4949 foreach ($commentData as $comment) {
4950 $comments[] = $comment;
4953 $data['photo']['friendica_comments'] = $comments;
4955 // include info if rights on photo and rights on item are mismatching
4956 $rights_mismatch = $data['photo']['allow_cid'] != $item['allow_cid'] ||
4957 $data['photo']['deny_cid'] != $item['deny_cid'] ||
4958 $data['photo']['allow_gid'] != $item['allow_gid'] ||
4959 $data['photo']['deny_gid'] != $item['deny_gid'];
4960 $data['photo']['rights_mismatch'] = $rights_mismatch;
4967 * Similar as /mod/redir.php
4968 * redirect to 'url' after dfrn auth
4970 * Why this when there is mod/redir.php already?
4971 * This use api_user() and api_login()
4974 * c_url: url of remote contact to auth to
4975 * url: string, url to redirect after auth
4977 function api_friendica_remoteauth()
4979 $url = $_GET['url'] ?? '';
4980 $c_url = $_GET['c_url'] ?? '';
4982 if ($url === '' || $c_url === '') {
4983 throw new BadRequestException("Wrong parameters.");
4986 $c_url = Strings::normaliseLink($c_url);
4990 $contact = DBA::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4991 if (!DBA::isResult($contact)) {
4992 throw new BadRequestException("Unknown contact");
4995 $cid = $contact['id'];
4997 $dfrn_id = $contact['issued-id'] ?: $contact['dfrn-id'];
4999 if (($contact['network'] !== Protocol::DFRN) || empty($dfrn_id)) {
5000 System::externalRedirect($url ?: $c_url);
5003 if ($contact['duplex'] && $contact['issued-id']) {
5004 $orig_id = $contact['issued-id'];
5005 $dfrn_id = '1:' . $orig_id;
5007 if ($contact['duplex'] && $contact['dfrn-id']) {
5008 $orig_id = $contact['dfrn-id'];
5009 $dfrn_id = '0:' . $orig_id;
5012 $sec = Strings::getRandomHex();
5014 $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
5015 'sec' => $sec, 'expire' => time() + 45];
5016 DBA::insert('profile_check', $fields);
5018 Logger::info(API_LOG_PREFIX . 'for contact {contact}', ['module' => 'api', 'action' => 'friendica_remoteauth', 'contact' => $contact['name'], 'hey' => $sec]);
5019 $dest = ($url ? '&destination_url=' . $url : '');
5021 System::externalRedirect(
5022 $contact['poll'] . '?dfrn_id=' . $dfrn_id
5023 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
5024 . '&type=profile&sec=' . $sec . $dest
5027 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
5030 * Return an item with announcer data if it had been announced
5032 * @param array $item Item array
5033 * @return array Item array with announce data
5035 function api_get_announce($item)
5037 // Quit if the item already has got a different owner and author
5038 if ($item['owner-id'] != $item['author-id']) {
5042 // Don't change original or Diaspora posts
5043 if ($item['origin'] || in_array($item['network'], [Protocol::DIASPORA])) {
5047 // Quit if we do now the original author and it had been a post from a native network
5048 if (!empty($item['contact-uid']) && in_array($item['network'], Protocol::NATIVE_SUPPORT)) {
5052 $fields = ['author-id', 'author-name', 'author-link', 'author-avatar'];
5053 $condition = ['parent-uri' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY, 'uid' => [0, $item['uid']], 'vid' => Verb::getID(Activity::ANNOUNCE)];
5054 $announce = Post::selectFirstForUser($item['uid'], $fields, $condition, ['order' => ['received' => true]]);
5055 if (!DBA::isResult($announce)) {
5059 return array_merge($item, $announce);
5063 * Return the item shared, if the item contains only the [share] tag
5065 * @param array $item Sharer item
5066 * @return array|false Shared item or false if not a reshare
5067 * @throws ImagickException
5068 * @throws InternalServerErrorException
5070 function api_share_as_retweet(&$item)
5072 $body = trim($item["body"]);
5074 if (Diaspora::isReshare($body, false) === false) {
5075 if ($item['author-id'] == $item['owner-id']) {
5078 // Reshares from OStatus, ActivityPub and Twitter
5079 $reshared_item = $item;
5080 $reshared_item['owner-id'] = $reshared_item['author-id'];
5081 $reshared_item['owner-link'] = $reshared_item['author-link'];
5082 $reshared_item['owner-name'] = $reshared_item['author-name'];
5083 $reshared_item['owner-avatar'] = $reshared_item['author-avatar'];
5084 return $reshared_item;
5088 $reshared = Item::getShareArray($item);
5089 if (empty($reshared)) {
5093 $reshared_item = $item;
5095 if (empty($reshared['shared']) || empty($reshared['profile']) || empty($reshared['author']) || empty($reshared['avatar']) || empty($reshared['posted'])) {
5099 if (!empty($reshared['comment'])) {
5100 $item['body'] = $reshared['comment'];
5103 $reshared_item["share-pre-body"] = $reshared['comment'];
5104 $reshared_item["body"] = $reshared['shared'];
5105 $reshared_item["author-id"] = Contact::getIdForURL($reshared['profile'], 0, false);
5106 $reshared_item["author-name"] = $reshared['author'];
5107 $reshared_item["author-link"] = $reshared['profile'];
5108 $reshared_item["author-avatar"] = $reshared['avatar'];
5109 $reshared_item["plink"] = $reshared['link'] ?? '';
5110 $reshared_item["created"] = $reshared['posted'];
5111 $reshared_item["edited"] = $reshared['posted'];
5113 // Try to fetch the original item
5114 if (!empty($reshared['guid'])) {
5115 $condition = ['guid' => $reshared['guid'], 'uid' => [0, $item['uid']]];
5116 } elseif (!empty($reshared_item['plink']) && ($original_id = Item::searchByLink($reshared_item['plink']))) {
5117 $condition = ['id' => $original_id];
5122 if (!empty($condition)) {
5123 $original_item = Post::selectFirst([], $condition);
5124 if (DBA::isResult($original_item)) {
5125 $reshared_item = array_merge($reshared_item, $original_item);
5129 return $reshared_item;
5134 * @param array $item
5139 function api_in_reply_to($item)
5143 $in_reply_to['status_id'] = null;
5144 $in_reply_to['user_id'] = null;
5145 $in_reply_to['status_id_str'] = null;
5146 $in_reply_to['user_id_str'] = null;
5147 $in_reply_to['screen_name'] = null;
5149 if (($item['thr-parent'] != $item['uri']) && ($item['gravity'] != GRAVITY_PARENT)) {
5150 $parent = Post::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
5151 if (DBA::isResult($parent)) {
5152 $in_reply_to['status_id'] = intval($parent['id']);
5154 $in_reply_to['status_id'] = intval($item['parent']);
5157 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5159 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
5160 $parent = Post::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
5162 if (DBA::isResult($parent)) {
5163 $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
5164 $in_reply_to['user_id'] = intval($parent['author-id']);
5165 $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
5168 // There seems to be situation, where both fields are identical:
5169 // https://github.com/friendica/friendica/issues/1010
5170 // This is a bugfix for that.
5171 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5172 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']]);
5173 $in_reply_to['status_id'] = null;
5174 $in_reply_to['user_id'] = null;
5175 $in_reply_to['status_id_str'] = null;
5176 $in_reply_to['user_id_str'] = null;
5177 $in_reply_to['screen_name'] = null;
5181 return $in_reply_to;
5186 * @param string $text
5189 * @throws InternalServerErrorException
5191 function api_clean_plain_items($text)
5193 $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
5195 $text = BBCode::cleanPictureLinks($text);
5196 $URLSearchString = "^\[\]";
5198 $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
5200 if ($include_entities == "true") {
5201 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5204 // Simplify "attachment" element
5205 $text = BBCode::removeAttachment($text);
5212 * @param array $contacts
5216 function api_best_nickname(&$contacts)
5220 if (count($contacts) == 0) {
5224 foreach ($contacts as $contact) {
5225 if ($contact["network"] == "") {
5226 $contact["network"] = "dfrn";
5227 $best_contact = [$contact];
5231 if (sizeof($best_contact) == 0) {
5232 foreach ($contacts as $contact) {
5233 if ($contact["network"] == "dfrn") {
5234 $best_contact = [$contact];
5239 if (sizeof($best_contact) == 0) {
5240 foreach ($contacts as $contact) {
5241 if ($contact["network"] == "dspr") {
5242 $best_contact = [$contact];
5247 if (sizeof($best_contact) == 0) {
5248 foreach ($contacts as $contact) {
5249 if ($contact["network"] == "stat") {
5250 $best_contact = [$contact];
5255 if (sizeof($best_contact) == 0) {
5256 foreach ($contacts as $contact) {
5257 if ($contact["network"] == "pump") {
5258 $best_contact = [$contact];
5263 if (sizeof($best_contact) == 0) {
5264 foreach ($contacts as $contact) {
5265 if ($contact["network"] == "twit") {
5266 $best_contact = [$contact];
5271 if (sizeof($best_contact) == 1) {
5272 $contacts = $best_contact;
5274 $contacts = [$contacts[0]];
5279 * Return all or a specified group of the user with the containing contacts.
5281 * @param string $type Return type (atom, rss, xml, json)
5283 * @return array|string
5284 * @throws BadRequestException
5285 * @throws ForbiddenException
5286 * @throws ImagickException
5287 * @throws InternalServerErrorException
5288 * @throws UnauthorizedException
5290 function api_friendica_group_show($type)
5294 if (api_user() === false) {
5295 throw new ForbiddenException();
5299 $user_info = api_get_user($a);
5300 $gid = $_REQUEST['gid'] ?? 0;
5301 $uid = $user_info['uid'];
5303 // get data of the specified group id or all groups if not specified
5306 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5310 // error message if specified gid is not in database
5311 if (!DBA::isResult($r)) {
5312 throw new BadRequestException("gid not available");
5316 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5321 // loop through all groups and retrieve all members for adding data in the user array
5323 foreach ($r as $rr) {
5324 $members = Contact\Group::getById($rr['id']);
5327 if ($type == "xml") {
5328 $user_element = "users";
5330 foreach ($members as $member) {
5331 $user = api_get_user($a, $member['nurl']);
5332 $users[$k++.":user"] = $user;
5335 $user_element = "user";
5336 foreach ($members as $member) {
5337 $user = api_get_user($a, $member['nurl']);
5341 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5343 return api_format_data("groups", $type, ['group' => $grps]);
5345 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5349 * Delete the specified group of the user.
5351 * @param string $type Return type (atom, rss, xml, json)
5353 * @return array|string
5354 * @throws BadRequestException
5355 * @throws ForbiddenException
5356 * @throws ImagickException
5357 * @throws InternalServerErrorException
5358 * @throws UnauthorizedException
5360 function api_friendica_group_delete($type)
5364 if (api_user() === false) {
5365 throw new ForbiddenException();
5369 $user_info = api_get_user($a);
5370 $gid = $_REQUEST['gid'] ?? 0;
5371 $name = $_REQUEST['name'] ?? '';
5372 $uid = $user_info['uid'];
5374 // error if no gid specified
5375 if ($gid == 0 || $name == "") {
5376 throw new BadRequestException('gid or name not specified');
5379 // get data of the specified group id
5381 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5385 // error message if specified gid is not in database
5386 if (!DBA::isResult($r)) {
5387 throw new BadRequestException('gid not available');
5390 // get data of the specified group id and group name
5392 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5397 // error message if specified gid is not in database
5398 if (!DBA::isResult($rname)) {
5399 throw new BadRequestException('wrong group name');
5403 $ret = Group::removeByName($uid, $name);
5406 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5407 return api_format_data("group_delete", $type, ['result' => $success]);
5409 throw new BadRequestException('other API error');
5412 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5417 * @param string $type Return type (atom, rss, xml, json)
5419 * @return array|string
5420 * @throws BadRequestException
5421 * @throws ForbiddenException
5422 * @throws ImagickException
5423 * @throws InternalServerErrorException
5424 * @throws UnauthorizedException
5425 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5427 function api_lists_destroy($type)
5431 if (api_user() === false) {
5432 throw new ForbiddenException();
5436 $user_info = api_get_user($a);
5437 $gid = $_REQUEST['list_id'] ?? 0;
5438 $uid = $user_info['uid'];
5440 // error if no gid specified
5442 throw new BadRequestException('gid not specified');
5445 // get data of the specified group id
5446 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5447 // error message if specified gid is not in database
5449 throw new BadRequestException('gid not available');
5452 if (Group::remove($gid)) {
5454 'name' => $group['name'],
5455 'id' => intval($gid),
5456 'id_str' => (string) $gid,
5457 'user' => $user_info
5460 return api_format_data("lists", $type, ['lists' => $list]);
5463 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5466 * Add a new group to the database.
5468 * @param string $name Group name
5469 * @param int $uid User ID
5470 * @param array $users List of users to add to the group
5473 * @throws BadRequestException
5475 function group_create($name, $uid, $users = [])
5477 // error if no name specified
5479 throw new BadRequestException('group name not specified');
5482 // get data of the specified group name
5484 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5488 // error message if specified group name already exists
5489 if (DBA::isResult($rname)) {
5490 throw new BadRequestException('group name already exists');
5493 // check if specified group name is a deleted group
5495 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5499 // error message if specified group name already exists
5500 if (DBA::isResult($rname)) {
5501 $reactivate_group = true;
5505 $ret = Group::create($uid, $name);
5507 $gid = Group::getIdByName($uid, $name);
5509 throw new BadRequestException('other API error');
5513 $erroraddinguser = false;
5515 foreach ($users as $user) {
5516 $cid = $user['cid'];
5517 // check if user really exists as contact
5519 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5523 if (count($contact)) {
5524 Group::addMember($gid, $cid);
5526 $erroraddinguser = true;
5527 $errorusers[] = $cid;
5531 // return success message incl. missing users in array
5532 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5534 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5538 * Create the specified group with the posted array of contacts.
5540 * @param string $type Return type (atom, rss, xml, json)
5542 * @return array|string
5543 * @throws BadRequestException
5544 * @throws ForbiddenException
5545 * @throws ImagickException
5546 * @throws InternalServerErrorException
5547 * @throws UnauthorizedException
5549 function api_friendica_group_create($type)
5553 if (api_user() === false) {
5554 throw new ForbiddenException();
5558 $user_info = api_get_user($a);
5559 $name = $_REQUEST['name'] ?? '';
5560 $uid = $user_info['uid'];
5561 $json = json_decode($_POST['json'], true);
5562 $users = $json['user'];
5564 $success = group_create($name, $uid, $users);
5566 return api_format_data("group_create", $type, ['result' => $success]);
5568 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5571 * Create a new group.
5573 * @param string $type Return type (atom, rss, xml, json)
5575 * @return array|string
5576 * @throws BadRequestException
5577 * @throws ForbiddenException
5578 * @throws ImagickException
5579 * @throws InternalServerErrorException
5580 * @throws UnauthorizedException
5581 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5583 function api_lists_create($type)
5587 if (api_user() === false) {
5588 throw new ForbiddenException();
5592 $user_info = api_get_user($a);
5593 $name = $_REQUEST['name'] ?? '';
5594 $uid = $user_info['uid'];
5596 $success = group_create($name, $uid);
5597 if ($success['success']) {
5599 'name' => $success['name'],
5600 'id' => intval($success['gid']),
5601 'id_str' => (string) $success['gid'],
5602 'user' => $user_info
5605 return api_format_data("lists", $type, ['lists'=>$grp]);
5608 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5611 * Update the specified group with the posted array of contacts.
5613 * @param string $type Return type (atom, rss, xml, json)
5615 * @return array|string
5616 * @throws BadRequestException
5617 * @throws ForbiddenException
5618 * @throws ImagickException
5619 * @throws InternalServerErrorException
5620 * @throws UnauthorizedException
5622 function api_friendica_group_update($type)
5626 if (api_user() === false) {
5627 throw new ForbiddenException();
5631 $user_info = api_get_user($a);
5632 $uid = $user_info['uid'];
5633 $gid = $_REQUEST['gid'] ?? 0;
5634 $name = $_REQUEST['name'] ?? '';
5635 $json = json_decode($_POST['json'], true);
5636 $users = $json['user'];
5638 // error if no name specified
5640 throw new BadRequestException('group name not specified');
5643 // error if no gid specified
5645 throw new BadRequestException('gid not specified');
5649 $members = Contact\Group::getById($gid);
5650 foreach ($members as $member) {
5651 $cid = $member['id'];
5652 foreach ($users as $user) {
5653 $found = ($user['cid'] == $cid ? true : false);
5655 if (!isset($found) || !$found) {
5656 Group::removeMemberByName($uid, $name, $cid);
5661 $erroraddinguser = false;
5663 foreach ($users as $user) {
5664 $cid = $user['cid'];
5665 // check if user really exists as contact
5667 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5672 if (count($contact)) {
5673 Group::addMember($gid, $cid);
5675 $erroraddinguser = true;
5676 $errorusers[] = $cid;
5680 // return success message incl. missing users in array
5681 $status = ($erroraddinguser ? "missing user" : "ok");
5682 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5683 return api_format_data("group_update", $type, ['result' => $success]);
5686 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5689 * Update information about a group.
5691 * @param string $type Return type (atom, rss, xml, json)
5693 * @return array|string
5694 * @throws BadRequestException
5695 * @throws ForbiddenException
5696 * @throws ImagickException
5697 * @throws InternalServerErrorException
5698 * @throws UnauthorizedException
5699 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5701 function api_lists_update($type)
5705 if (api_user() === false) {
5706 throw new ForbiddenException();
5710 $user_info = api_get_user($a);
5711 $gid = $_REQUEST['list_id'] ?? 0;
5712 $name = $_REQUEST['name'] ?? '';
5713 $uid = $user_info['uid'];
5715 // error if no gid specified
5717 throw new BadRequestException('gid not specified');
5720 // get data of the specified group id
5721 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5722 // error message if specified gid is not in database
5724 throw new BadRequestException('gid not available');
5727 if (Group::update($gid, $name)) {
5730 'id' => intval($gid),
5731 'id_str' => (string) $gid,
5732 'user' => $user_info
5735 return api_format_data("lists", $type, ['lists' => $list]);
5739 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5743 * @param string $type Return type (atom, rss, xml, json)
5745 * @return array|string
5746 * @throws BadRequestException
5747 * @throws ForbiddenException
5748 * @throws ImagickException
5749 * @throws InternalServerErrorException
5751 function api_friendica_activity($type)
5755 if (api_user() === false) {
5756 throw new ForbiddenException();
5758 $verb = strtolower($a->argv[3]);
5759 $verb = preg_replace("|\..*$|", "", $verb);
5761 $id = $_REQUEST['id'] ?? 0;
5763 $res = Item::performActivity($id, $verb, api_user());
5766 if ($type == "xml") {
5771 return api_format_data('ok', $type, ['ok' => $ok]);
5773 throw new BadRequestException('Error adding activity');
5777 /// @TODO move to top of file or somewhere better
5778 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5779 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5780 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5781 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5782 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5783 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5784 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5785 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5786 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5787 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5790 * Returns notifications
5792 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5794 * @return string|array
5795 * @throws ForbiddenException
5796 * @throws BadRequestException
5799 function api_friendica_notification($type)
5803 if (api_user() === false) {
5804 throw new ForbiddenException();
5807 throw new BadRequestException("Invalid argument count");
5810 $notifications = DI::notification()->getApiList(local_user());
5812 if ($type == "xml") {
5814 if (!empty($notifications)) {
5815 foreach ($notifications as $notification) {
5816 $xmlnotes[] = ["@attributes" => $notification->toArray()];
5820 $result = $xmlnotes;
5821 } elseif (count($notifications) > 0) {
5822 $result = $notifications->getArrayCopy();
5827 return api_format_data("notes", $type, ['note' => $result]);
5831 * Set notification as seen and returns associated item (if possible)
5833 * POST request with 'id' param as notification id
5835 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5836 * @return string|array
5837 * @throws BadRequestException
5838 * @throws ForbiddenException
5839 * @throws ImagickException
5840 * @throws InternalServerErrorException
5841 * @throws UnauthorizedException
5843 function api_friendica_notification_seen($type)
5846 $user_info = api_get_user($a);
5848 if (api_user() === false || $user_info === false) {
5849 throw new ForbiddenException();
5851 if ($a->argc !== 4) {
5852 throw new BadRequestException("Invalid argument count");
5855 $id = (!empty($_REQUEST['id']) ? intval($_REQUEST['id']) : 0);
5858 $notify = DI::notify()->getByID($id, api_user());
5859 DI::notify()->setSeen(true, $notify);
5861 if ($notify->otype === Notification\ObjectType::ITEM) {
5862 $item = Post::selectFirstForUser(api_user(), [], ['id' => $notify->iid, 'uid' => api_user()]);
5863 if (DBA::isResult($item)) {
5864 // we found the item, return it to the user
5865 $ret = api_format_items([$item], $user_info, false, $type);
5866 $data = ['status' => $ret];
5867 return api_format_data("status", $type, $data);
5869 // the item can't be found, but we set the notification as seen, so we count this as a success
5871 return api_format_data('result', $type, ['result' => "success"]);
5872 } catch (NotFoundException $e) {
5873 throw new BadRequestException('Invalid argument', $e);
5874 } catch (Exception $e) {
5875 throw new InternalServerErrorException('Internal Server exception', $e);
5879 /// @TODO move to top of file or somewhere better
5880 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5881 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5884 * update a direct_message to seen state
5886 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5887 * @return string|array (success result=ok, error result=error with error message)
5888 * @throws BadRequestException
5889 * @throws ForbiddenException
5890 * @throws ImagickException
5891 * @throws InternalServerErrorException
5892 * @throws UnauthorizedException
5894 function api_friendica_direct_messages_setseen($type)
5897 if (api_user() === false) {
5898 throw new ForbiddenException();
5902 $user_info = api_get_user($a);
5903 $uid = $user_info['uid'];
5904 $id = $_REQUEST['id'] ?? 0;
5906 // return error if id is zero
5908 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5909 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5912 // error message if specified id is not in database
5913 if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
5914 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5915 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5918 // update seen indicator
5919 $result = DBA::update('mail', ['seen' => true], ['id' => $id]);
5923 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
5924 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
5926 $answer = ['result' => 'error', 'message' => 'unknown error'];
5927 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5931 /// @TODO move to top of file or somewhere better
5932 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5935 * search for direct_messages containing a searchstring through api
5937 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5938 * @param string $box
5939 * @return string|array (success: success=true if found and search_result contains found messages,
5940 * success=false if nothing was found, search_result='nothing found',
5941 * error: result=error with error message)
5942 * @throws BadRequestException
5943 * @throws ForbiddenException
5944 * @throws ImagickException
5945 * @throws InternalServerErrorException
5946 * @throws UnauthorizedException
5948 function api_friendica_direct_messages_search($type, $box = "")
5952 if (api_user() === false) {
5953 throw new ForbiddenException();
5957 $user_info = api_get_user($a);
5958 $searchstring = $_REQUEST['searchstring'] ?? '';
5959 $uid = $user_info['uid'];
5961 // error if no searchstring specified
5962 if ($searchstring == "") {
5963 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
5964 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
5967 // get data for the specified searchstring
5969 "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",
5971 DBA::escape('%'.$searchstring.'%')
5974 $profile_url = $user_info["url"];
5976 // message if nothing was found
5977 if (!DBA::isResult($r)) {
5978 $success = ['success' => false, 'search_results' => 'problem with query'];
5979 } elseif (count($r) == 0) {
5980 $success = ['success' => false, 'search_results' => 'nothing found'];
5983 foreach ($r as $item) {
5984 if ($box == "inbox" || $item['from-url'] != $profile_url) {
5985 $recipient = $user_info;
5986 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5987 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5988 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5989 $sender = $user_info;
5992 if (isset($recipient) && isset($sender)) {
5993 $ret[] = api_format_messages($item, $recipient, $sender);
5996 $success = ['success' => true, 'search_results' => $ret];
5999 return api_format_data("direct_message_search", $type, ['$result' => $success]);
6002 /// @TODO move to top of file or somewhere better
6003 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
6006 * Returns a list of saved searches.
6008 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
6010 * @param string $type Return format: json or xml
6012 * @return string|array
6015 function api_saved_searches_list($type)
6017 $terms = DBA::select('search', ['id', 'term'], ['uid' => local_user()]);
6020 while ($term = DBA::fetch($terms)) {
6022 'created_at' => api_date(time()),
6023 'id' => intval($term['id']),
6024 'id_str' => $term['id'],
6025 'name' => $term['term'],
6027 'query' => $term['term']
6033 return api_format_data("terms", $type, ['terms' => $result]);
6036 /// @TODO move to top of file or somewhere better
6037 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
6040 * Number of comments
6042 * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
6044 * @param object $data [Status, Status]
6048 function bindComments(&$data)
6050 if (count($data) == 0) {
6056 foreach ($data as $item) {
6057 $ids[] = $item['id'];
6060 $idStr = DBA::escape(implode(', ', $ids));
6061 $sql = "SELECT `parent`, COUNT(*) as comments FROM `post-user-view` WHERE `parent` IN ($idStr) AND `deleted` = ? AND `gravity`= ? GROUP BY `parent`";
6062 $items = DBA::p($sql, 0, GRAVITY_COMMENT);
6063 $itemsData = DBA::toArray($items);
6065 foreach ($itemsData as $item) {
6066 $comments[$item['parent']] = $item['comments'];
6069 foreach ($data as $idx => $item) {
6071 $data[$idx]['friendica_comments'] = isset($comments[$id]) ? $comments[$id] : 0;
6076 @TODO Maybe open to implement?
6078 [pagename] => api/1.1/statuses/lookup.json
6079 [id] => 605138389168451584
6080 [include_cards] => true
6081 [cards_platform] => Android-12
6082 [include_entities] => true
6083 [include_my_retweet] => 1
6085 [include_reply_count] => true
6086 [include_descendent_reply_count] => true
6090 Not implemented by now:
6091 statuses/retweets_of_me
6096 account/update_location
6097 account/update_profile_background_image
6100 friendica/profile/update
6101 friendica/profile/create
6102 friendica/profile/delete
6104 Not implemented in status.net:
6105 statuses/retweeted_to_me
6106 statuses/retweeted_by_me
6107 direct_messages/destroy
6109 account/update_delivery_device
6110 notifications/follow