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\Logger;
31 use Friendica\Core\Protocol;
32 use Friendica\Core\System;
33 use Friendica\Database\DBA;
35 use Friendica\Model\Contact;
36 use Friendica\Model\Group;
37 use Friendica\Model\Item;
38 use Friendica\Model\Mail;
39 use Friendica\Model\Notification;
40 use Friendica\Model\Photo;
41 use Friendica\Model\Post;
42 use Friendica\Model\Profile;
43 use Friendica\Model\User;
44 use Friendica\Model\Verb;
45 use Friendica\Module\BaseApi;
46 use Friendica\Network\HTTPException;
47 use Friendica\Network\HTTPException\BadRequestException;
48 use Friendica\Network\HTTPException\ForbiddenException;
49 use Friendica\Network\HTTPException\InternalServerErrorException;
50 use Friendica\Network\HTTPException\MethodNotAllowedException;
51 use Friendica\Network\HTTPException\NotFoundException;
52 use Friendica\Network\HTTPException\TooManyRequestsException;
53 use Friendica\Network\HTTPException\UnauthorizedException;
54 use Friendica\Object\Image;
55 use Friendica\Protocol\Activity;
56 use Friendica\Security\BasicAuth;
57 use Friendica\Security\OAuth;
58 use Friendica\Util\DateTimeFormat;
59 use Friendica\Util\Images;
60 use Friendica\Util\Network;
61 use Friendica\Util\Strings;
63 require_once __DIR__ . '/../mod/item.php';
64 require_once __DIR__ . '/../mod/wall_upload.php';
66 define('API_METHOD_ANY', '*');
67 define('API_METHOD_GET', 'GET');
68 define('API_METHOD_POST', 'POST,PUT');
69 define('API_METHOD_DELETE', 'POST,DELETE');
71 define('API_LOG_PREFIX', 'API {action} - ');
79 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
80 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
81 * into a page, and visitors will post something without noticing it).
85 $user = BaseApi::getCurrentUserID();
90 if (!empty($_SESSION['allow_api'])) {
98 * Get source name from API client
100 * Clients can send 'source' parameter to be show in post metadata
101 * as "sent via <source>".
102 * Some clients doesn't send a source param, we support ones we know
103 * (only Twidere, atm)
106 * Client source name, default to "api" if unset/unknown
109 function api_source()
111 if (requestdata('source')) {
112 return requestdata('source');
115 // Support for known clients that doesn't send a source name
116 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
117 if(strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
121 Logger::info(API_LOG_PREFIX . 'Unrecognized user-agent', ['module' => 'api', 'action' => 'source', 'http_user_agent' => $_SERVER['HTTP_USER_AGENT']]);
123 Logger::info(API_LOG_PREFIX . 'Empty user-agent', ['module' => 'api', 'action' => 'source']);
130 * Format date for API
132 * @param string $str Source date, as UTC
133 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
136 function api_date($str)
138 // Wed May 23 06:01:13 +0000 2007
139 return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
143 * Register a function to be the endpoint for defined API path.
145 * @param string $path API URL path, relative to DI::baseUrl()
146 * @param string $func Function name to call on path request
147 * @param bool $auth API need logged user
148 * @param string $method HTTP method reqiured to call this endpoint.
149 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
150 * Default to API_METHOD_ANY
152 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
162 // Workaround for hotot
163 $path = str_replace("api/", "api/1.1/", $path);
173 * Check HTTP method of called API
175 * API endpoints can define which HTTP method to accept when called.
176 * This function check the current HTTP method agains endpoint
179 * @param string $method Required methods, uppercase, separated by comma
182 function api_check_method($method)
184 if ($method == "*") {
187 return (stripos($method, $_SERVER['REQUEST_METHOD'] ?? 'GET') !== false);
191 * Main API entry point
193 * Authenticate user, call registered API function, set HTTP headers
196 * @param App\Arguments $args The app arguments (optional, will retrieved by the DI-Container in case of missing)
197 * @return string|array API call result
200 function api_call(App $a, App\Arguments $args = null)
202 global $API, $called_api;
209 if (strpos($args->getCommand(), ".xml") > 0) {
212 if (strpos($args->getCommand(), ".json") > 0) {
215 if (strpos($args->getCommand(), ".rss") > 0) {
218 if (strpos($args->getCommand(), ".atom") > 0) {
223 foreach ($API as $p => $info) {
224 if (strpos($args->getCommand(), $p) === 0) {
225 if (!api_check_method($info['method'])) {
226 throw new MethodNotAllowedException();
229 $called_api = explode("/", $p);
231 if (!empty($info['auth']) && api_user() === false) {
232 BasicAuth::getCurrentUserID(true);
233 Logger::info(API_LOG_PREFIX . 'nickname {nickname}', ['module' => 'api', 'action' => 'call', 'nickname' => $a->getLoggedInUserNickname()]);
236 Logger::debug(API_LOG_PREFIX . 'parameters', ['module' => 'api', 'action' => 'call', 'parameters' => $_REQUEST]);
238 $stamp = microtime(true);
239 $return = call_user_func($info['func'], $type);
240 $duration = floatval(microtime(true) - $stamp);
242 Logger::info(API_LOG_PREFIX . 'duration {duration}', ['module' => 'api', 'action' => 'call', 'duration' => round($duration, 2)]);
244 DI::profiler()->saveLog(DI::logger(), API_LOG_PREFIX . 'performance');
246 if (false === $return) {
248 * api function returned false withour throw an
249 * exception. This should not happend, throw a 500
251 throw new InternalServerErrorException();
256 header("Content-Type: text/xml");
259 header("Content-Type: application/json");
260 if (!empty($return)) {
261 $json = json_encode(end($return));
262 if (!empty($_GET['callback'])) {
263 $json = $_GET['callback'] . "(" . $json . ")";
269 header("Content-Type: application/rss+xml");
270 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
273 header("Content-Type: application/atom+xml");
274 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
281 Logger::warning(API_LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]);
282 throw new NotFoundException();
283 } catch (HTTPException $e) {
284 DI::apiResponse()->error($e->getCode(), $e->getDescription(), $e->getMessage(), $type);
289 * Set values for RSS template
291 * @param array $arr Array to be passed to template
292 * @param array $user_info User info
294 * @throws BadRequestException
295 * @throws ImagickException
296 * @throws InternalServerErrorException
297 * @throws UnauthorizedException
298 * @todo find proper type-hints
300 function api_rss_extra($arr, $user_info)
302 if (is_null($user_info)) {
305 throw new ForbiddenException();
308 $user_info = DI::twitterUser()->createFromUserId($uid)->toArray();
311 $arr['$user'] = $user_info;
313 'alternate' => $user_info['url'],
314 'self' => DI::baseUrl() . "/" . DI::args()->getQueryString(),
315 'base' => DI::baseUrl(),
316 'updated' => api_date(null),
317 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
318 'language' => $user_info['lang'],
319 'logo' => DI::baseUrl() . "/images/friendica-32.png",
327 * Unique contact to contact url.
329 * @param int $id Contact id
330 * @return bool|string
331 * Contact url or False if contact id is unknown
334 function api_unique_id_to_nurl($id)
336 $r = DBA::selectFirst('contact', ['nurl'], ['id' => $id]);
338 if (DBA::isResult($r)) {
346 * Get user info array.
349 * @param int|string $contact_id Contact ID or URL
351 * @throws BadRequestException
352 * @throws ImagickException
353 * @throws InternalServerErrorException
354 * @throws UnauthorizedException
356 function api_get_user($contact_id = null)
364 Logger::info(API_LOG_PREFIX . 'Fetching data for user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $contact_id]);
366 // Searching for contact URL
367 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
368 $user = Strings::normaliseLink($contact_id);
370 $extra_query = "AND `contact`.`nurl` = ? ";
371 if (api_user() !== false) {
372 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
376 // Searching for contact id with uid = 0
377 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
378 $user = api_unique_id_to_nurl(intval($contact_id));
381 throw new BadRequestException("User ID ".$contact_id." not found.");
385 $extra_query = "AND `contact`.`nurl` = ? ";
386 if (api_user() !== false) {
387 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
391 if (is_null($user) && !empty($_GET['user_id'])) {
392 $user = api_unique_id_to_nurl($_GET['user_id']);
395 throw new BadRequestException("User ID ".$_GET['user_id']." not found.");
399 $extra_query = "AND `contact`.`nurl` = ? ";
400 if (api_user() !== false) {
401 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
404 if (is_null($user) && !empty($_GET['screen_name'])) {
405 $user = $_GET['screen_name'];
406 $extra_query = "AND `contact`.`nick` = ? ";
407 if (api_user() !== false) {
408 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
412 if (is_null($user) && !empty($_GET['profileurl'])) {
413 $user = Strings::normaliseLink($_GET['profileurl']);
414 $extra_query = "AND `contact`.`nurl` = ? ";
415 if (api_user() !== false) {
416 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
420 // $called_api is the API path exploded on / and is expected to have at least 2 elements
421 if (is_null($user) && (DI::args()->getArgc() > (count($called_api) - 1)) && (count($called_api) > 0)) {
422 $argid = count($called_api);
423 if (!empty(DI::args()->getArgv()[$argid])) {
424 $data = explode(".", DI::args()->getArgv()[$argid]);
425 if (count($data) > 1) {
426 [$user, $null] = $data;
429 if (is_numeric($user)) {
430 $user = api_unique_id_to_nurl(intval($user));
434 $extra_query = "AND `contact`.`nurl` = ? ";
435 if (api_user() !== false) {
436 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
440 $extra_query = "AND `contact`.`nick` = ? ";
441 if (api_user() !== false) {
442 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
447 Logger::info(API_LOG_PREFIX . 'getting user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user]);
450 if (api_user() === false) {
451 BasicAuth::getCurrentUserID(true);
455 $extra_query = "AND `contact`.`uid` = ? AND `contact`.`self` ";
459 Logger::info(API_LOG_PREFIX . 'found user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user, 'extra_query' => $extra_query]);
462 $uinfo = DBA::toArray(DBA::p(
463 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
469 if (DBA::isResult($uinfo)) {
470 // Selecting the id by priority, friendica first
471 api_best_nickname($uinfo);
472 return DI::twitterUser()->createFromContactId($uinfo[0]['cid'], $uinfo[0]['uid'])->toArray();
476 throw new BadRequestException("User not found.");
479 $cid = Contact::getIdForURL($url, 0, false);
482 return DI::twitterUser()->createFromContactId($cid, 0)->toArray();
484 throw new BadRequestException("User ".$url." not found.");
489 * return api-formatted array for item's author and owner
492 * @param array $item item from db
493 * @return array(array:author, array:owner)
494 * @throws BadRequestException
495 * @throws ImagickException
496 * @throws InternalServerErrorException
497 * @throws UnauthorizedException
499 function api_item_get_user(App $a, $item)
501 $status_user = DI::twitterUser()->createFromContactId($item['author-id'] ?? null, api_user())->toArray();
503 $author_user = $status_user;
505 $status_user["protected"] = isset($item['private']) && ($item['private'] == Item::PRIVATE);
507 if (($item['thr-parent'] ?? '') == ($item['uri'] ?? '')) {
508 $owner_user = DI::twitterUser()->createFromContactId($item['owner-id'] ?? null, api_user())->toArray();
510 $owner_user = $author_user;
513 return ([$status_user, $author_user, $owner_user]);
521 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
522 * returns a 401 status code and an error message if not.
524 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
526 * @param string $type Return type (atom, rss, xml, json)
527 * @return array|string
528 * @throws BadRequestException
529 * @throws ForbiddenException
530 * @throws ImagickException
531 * @throws InternalServerErrorException
532 * @throws UnauthorizedException
534 function api_account_verify_credentials($type)
536 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
538 unset($_REQUEST["user_id"]);
539 unset($_GET["user_id"]);
541 unset($_REQUEST["screen_name"]);
542 unset($_GET["screen_name"]);
544 $skip_status = $_REQUEST['skip_status'] ?? false;
546 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
548 // "verified" isn't used here in the standard
549 unset($user_info["verified"]);
551 // - Adding last status
553 $item = api_get_last_status($user_info['pid'], $user_info['uid']);
555 $user_info['status'] = api_format_item($item, $type);
559 // "uid" and "self" are only needed for some internal stuff, so remove it from here
560 unset($user_info["uid"]);
561 unset($user_info["self"]);
563 return DI::apiResponse()->formatData("user", $type, ['user' => $user_info]);
566 /// @TODO move to top of file or somewhere better
567 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
570 * Get data from $_POST or $_GET
575 function requestdata($k)
577 if (!empty($_POST[$k])) {
580 if (!empty($_GET[$k])) {
587 * Deprecated function to upload media.
589 * @param string $type Return type (atom, rss, xml, json)
591 * @return array|string
592 * @throws BadRequestException
593 * @throws ForbiddenException
594 * @throws ImagickException
595 * @throws InternalServerErrorException
596 * @throws UnauthorizedException
598 function api_statuses_mediap($type)
602 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
604 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
606 $_REQUEST['profile_uid'] = api_user();
607 $_REQUEST['api_source'] = true;
608 $txt = requestdata('status') ?? '';
609 /// @TODO old-lost code?
610 //$txt = urldecode(requestdata('status'));
612 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
613 $txt = HTML::toBBCodeVideo($txt);
614 $config = HTMLPurifier_Config::createDefault();
615 $config->set('Cache.DefinitionImpl', null);
616 $purifier = new HTMLPurifier($config);
617 $txt = $purifier->purify($txt);
619 $txt = HTML::toBBCode($txt);
621 DI::args()->getArgv()[1] = $user_info['screen_name']; //should be set to username?
623 $picture = wall_upload_post($a, false);
625 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
626 $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
627 $item_id = item_post($a);
629 // output the post that we just posted.
630 return api_status_show($type, $item_id);
633 /// @TODO move this to top of file or somewhere better!
634 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
637 * Updates the user’s current status.
639 * @param string $type Return type (atom, rss, xml, json)
641 * @return array|string
642 * @throws BadRequestException
643 * @throws ForbiddenException
644 * @throws ImagickException
645 * @throws InternalServerErrorException
646 * @throws TooManyRequestsException
647 * @throws UnauthorizedException
648 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
650 function api_statuses_update($type)
654 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
656 // convert $_POST array items to the form we use for web posts.
657 if (requestdata('htmlstatus')) {
658 $txt = requestdata('htmlstatus') ?? '';
659 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
660 $txt = HTML::toBBCodeVideo($txt);
662 $config = HTMLPurifier_Config::createDefault();
663 $config->set('Cache.DefinitionImpl', null);
665 $purifier = new HTMLPurifier($config);
666 $txt = $purifier->purify($txt);
668 $_REQUEST['body'] = HTML::toBBCode($txt);
671 $_REQUEST['body'] = requestdata('status');
674 $_REQUEST['title'] = requestdata('title');
676 $parent = requestdata('in_reply_to_status_id');
678 // Twidere sends "-1" if it is no reply ...
683 if (ctype_digit($parent)) {
684 $_REQUEST['parent'] = $parent;
686 $_REQUEST['parent_uri'] = $parent;
689 if (requestdata('lat') && requestdata('long')) {
690 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
692 $_REQUEST['profile_uid'] = api_user();
695 // Check for throttling (maximum posts per day, week and month)
696 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
697 if ($throttle_day > 0) {
698 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
700 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, api_user(), $datefrom];
701 $posts_day = Post::count($condition);
703 if ($posts_day > $throttle_day) {
704 logger::info('Daily posting limit reached for user '.api_user());
705 // die(api_error($type, DI::l10n()->t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
706 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));
710 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
711 if ($throttle_week > 0) {
712 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
714 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, api_user(), $datefrom];
715 $posts_week = Post::count($condition);
717 if ($posts_week > $throttle_week) {
718 logger::info('Weekly posting limit reached for user '.api_user());
719 // die(api_error($type, DI::l10n()->t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
720 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));
724 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
725 if ($throttle_month > 0) {
726 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
728 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, api_user(), $datefrom];
729 $posts_month = Post::count($condition);
731 if ($posts_month > $throttle_month) {
732 logger::info('Monthly posting limit reached for user '.api_user());
733 // die(api_error($type, DI::l10n()->t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
734 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));
739 if (requestdata('media_ids')) {
740 $ids = explode(',', requestdata('media_ids') ?? '');
741 } elseif (!empty($_FILES['media'])) {
742 // upload the image if we have one
743 $picture = wall_upload_post($a, false);
744 if (is_array($picture)) {
745 $ids[] = $picture['id'];
753 foreach ($ids as $id) {
754 $media = DBA::toArray(DBA::p("SELECT `resource-id`, `scale`, `nickname`, `type`, `desc`, `filename`, `datasize`, `width`, `height` FROM `photo`
755 INNER JOIN `user` ON `user`.`uid` = `photo`.`uid` WHERE `resource-id` IN
756 (SELECT `resource-id` FROM `photo` WHERE `id` = ?) AND `photo`.`uid` = ?
757 ORDER BY `photo`.`width` DESC LIMIT 2", $id, api_user()));
759 if (!empty($media)) {
760 $ressources[] = $media[0]['resource-id'];
761 $phototypes = Images::supportedTypes();
762 $ext = $phototypes[$media[0]['type']];
764 $attachment = ['type' => Post\Media::IMAGE, 'mimetype' => $media[0]['type'],
765 'url' => DI::baseUrl() . '/photo/' . $media[0]['resource-id'] . '-' . $media[0]['scale'] . '.' . $ext,
766 'size' => $media[0]['datasize'],
767 'name' => $media[0]['filename'] ?: $media[0]['resource-id'],
768 'description' => $media[0]['desc'] ?? '',
769 'width' => $media[0]['width'],
770 'height' => $media[0]['height']];
772 if (count($media) > 1) {
773 $attachment['preview'] = DI::baseUrl() . '/photo/' . $media[1]['resource-id'] . '-' . $media[1]['scale'] . '.' . $ext;
774 $attachment['preview-width'] = $media[1]['width'];
775 $attachment['preview-height'] = $media[1]['height'];
777 $attachments[] = $attachment;
781 // We have to avoid that the post is rejected because of an empty body
782 if (empty($_REQUEST['body'])) {
783 $_REQUEST['body'] = '[hr]';
787 if (!empty($attachments)) {
788 $_REQUEST['attachments'] = $attachments;
791 // set this so that the item_post() function is quiet and doesn't redirect or emit json
793 $_REQUEST['api_source'] = true;
795 if (empty($_REQUEST['source'])) {
796 $_REQUEST["source"] = api_source();
799 // call out normal post function
800 $item_id = item_post($a);
802 if (!empty($ressources) && !empty($item_id)) {
803 $item = Post::selectFirst(['uri-id', 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid'], ['id' => $item_id]);
804 foreach ($ressources as $ressource) {
805 Photo::setPermissionForRessource($ressource, api_user(), $item['allow_cid'], $item['allow_gid'], $item['deny_cid'], $item['deny_gid']);
809 // output the post that we just posted.
810 return api_status_show($type, $item_id);
813 /// @TODO move to top of file or somewhere better
814 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
815 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
818 * Uploads an image to Friendica.
821 * @throws BadRequestException
822 * @throws ForbiddenException
823 * @throws ImagickException
824 * @throws InternalServerErrorException
825 * @throws UnauthorizedException
826 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
828 function api_media_upload()
832 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
834 if (empty($_FILES['media'])) {
836 throw new BadRequestException("No media.");
839 $media = wall_upload_post($a, false);
842 throw new InternalServerErrorException();
846 $returndata["media_id"] = $media["id"];
847 $returndata["media_id_string"] = (string)$media["id"];
848 $returndata["size"] = $media["size"];
849 $returndata["image"] = ["w" => $media["width"],
850 "h" => $media["height"],
851 "image_type" => $media["type"],
852 "friendica_preview_url" => $media["preview"]];
854 Logger::info('Media uploaded', ['return' => $returndata]);
856 return ["media" => $returndata];
859 /// @TODO move to top of file or somewhere better
860 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
863 * Updates media meta data (picture descriptions)
865 * @param string $type Return type (atom, rss, xml, json)
867 * @return array|string
868 * @throws BadRequestException
869 * @throws ForbiddenException
870 * @throws ImagickException
871 * @throws InternalServerErrorException
872 * @throws TooManyRequestsException
873 * @throws UnauthorizedException
874 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
876 * @todo Compare the corresponding Twitter function for correct return values
878 function api_media_metadata_create($type)
880 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
882 $postdata = Network::postdata();
884 if (empty($postdata)) {
885 throw new BadRequestException("No post data");
888 $data = json_decode($postdata, true);
890 throw new BadRequestException("Invalid post data");
893 if (empty($data['media_id']) || empty($data['alt_text'])) {
894 throw new BadRequestException("Missing post data values");
897 if (empty($data['alt_text']['text'])) {
898 throw new BadRequestException("No alt text.");
901 Logger::info('Updating metadata', ['media_id' => $data['media_id']]);
903 $condition = ['id' => $data['media_id'], 'uid' => api_user()];
904 $photo = DBA::selectFirst('photo', ['resource-id'], $condition);
905 if (!DBA::isResult($photo)) {
906 throw new BadRequestException("Metadata not found.");
909 DBA::update('photo', ['desc' => $data['alt_text']['text']], ['resource-id' => $photo['resource-id']]);
912 api_register_func('api/media/metadata/create', 'api_media_metadata_create', true, API_METHOD_POST);
915 * @param string $type Return format (atom, rss, xml, json)
916 * @param int $item_id
917 * @return array|string
920 function api_status_show($type, $item_id)
922 Logger::info(API_LOG_PREFIX . 'Start', ['action' => 'status_show', 'type' => $type, 'item_id' => $item_id]);
926 $item = api_get_item(['id' => $item_id]);
928 $status_info = api_format_item($item, $type);
931 Logger::info(API_LOG_PREFIX . 'End', ['action' => 'get_status', 'status_info' => $status_info]);
933 return DI::apiResponse()->formatData('statuses', $type, ['status' => $status_info]);
937 * Retrieves the last public status of the provided user info
939 * @param int $ownerId Public contact Id
940 * @param int $uid User Id
944 function api_get_last_status($ownerId, $uid)
947 'author-id'=> $ownerId,
949 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT],
950 'private' => [Item::PUBLIC, Item::UNLISTED]
953 $item = api_get_item($condition);
959 * Retrieves a single item record based on the provided condition and converts it for API use.
961 * @param array $condition Item table condition array
965 function api_get_item(array $condition)
967 $item = Post::selectFirst(Item::DISPLAY_FIELDLIST, $condition, ['order' => ['id' => true]]);
973 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
974 * The author's most recent status will be returned inline.
976 * @param string $type Return type (atom, rss, xml, json)
977 * @return array|string
978 * @throws BadRequestException
979 * @throws ImagickException
980 * @throws InternalServerErrorException
981 * @throws UnauthorizedException
982 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
984 function api_users_show($type)
986 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
988 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
990 $item = api_get_last_status($user_info['pid'], $user_info['uid']);
992 $user_info['status'] = api_format_item($item, $type);
995 // "uid" and "self" are only needed for some internal stuff, so remove it from here
996 unset($user_info['uid']);
997 unset($user_info['self']);
999 return DI::apiResponse()->formatData('user', $type, ['user' => $user_info]);
1002 /// @TODO move to top of file or somewhere better
1003 api_register_func('api/users/show', 'api_users_show');
1004 api_register_func('api/externalprofile/show', 'api_users_show');
1007 * Search a public user account.
1009 * @param string $type Return type (atom, rss, xml, json)
1011 * @return array|string
1012 * @throws BadRequestException
1013 * @throws ImagickException
1014 * @throws InternalServerErrorException
1015 * @throws UnauthorizedException
1016 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1018 function api_users_search($type)
1022 if (!empty($_GET['q'])) {
1023 $contacts = Contact::selectToArray(
1026 '`uid` = 0 AND (`name` = ? OR `nick` = ? OR `url` = ? OR `addr` = ?)',
1034 if (DBA::isResult($contacts)) {
1036 foreach ($contacts as $contact) {
1037 $user_info = DI::twitterUser()->createFromContactId($contact['id'], api_user())->toArray();
1039 if ($type == 'xml') {
1040 $userlist[$k++ . ':user'] = $user_info;
1042 $userlist[] = $user_info;
1045 $userlist = ['users' => $userlist];
1047 throw new NotFoundException('User ' . $_GET['q'] . ' not found.');
1050 throw new BadRequestException('No search term specified.');
1053 return DI::apiResponse()->formatData('users', $type, $userlist);
1056 /// @TODO move to top of file or somewhere better
1057 api_register_func('api/users/search', 'api_users_search');
1060 * Return user objects
1062 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1064 * @param string $type Return format: json or xml
1066 * @return array|string
1067 * @throws BadRequestException
1068 * @throws ImagickException
1069 * @throws InternalServerErrorException
1070 * @throws NotFoundException if the results are empty.
1071 * @throws UnauthorizedException
1073 function api_users_lookup($type)
1077 if (!empty($_REQUEST['user_id'])) {
1078 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1080 $users[] = api_get_user($id);
1085 if (empty($users)) {
1086 throw new NotFoundException;
1089 return DI::apiResponse()->formatData("users", $type, ['users' => $users]);
1092 /// @TODO move to top of file or somewhere better
1093 api_register_func('api/users/lookup', 'api_users_lookup', true);
1096 * Returns statuses that match a specified query.
1098 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1100 * @param string $type Return format: json, xml, atom, rss
1102 * @return array|string
1103 * @throws BadRequestException if the "q" parameter is missing.
1104 * @throws ForbiddenException
1105 * @throws ImagickException
1106 * @throws InternalServerErrorException
1107 * @throws UnauthorizedException
1109 function api_search($type)
1111 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1113 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1115 if (empty($_REQUEST['q'])) {
1116 throw new BadRequestException('q parameter is required.');
1119 $searchTerm = trim(rawurldecode($_REQUEST['q']));
1122 $data['status'] = [];
1124 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1125 if (!empty($_REQUEST['rpp'])) {
1126 $count = $_REQUEST['rpp'];
1127 } elseif (!empty($_REQUEST['count'])) {
1128 $count = $_REQUEST['count'];
1131 $since_id = $_REQUEST['since_id'] ?? 0;
1132 $max_id = $_REQUEST['max_id'] ?? 0;
1133 $page = $_REQUEST['page'] ?? 1;
1135 $start = max(0, ($page - 1) * $count);
1137 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1138 if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) {
1139 $searchTerm = $matches[1];
1140 $condition = ["`iid` > ? AND `name` = ? AND (NOT `private` OR (`private` AND `uid` = ?))", $since_id, $searchTerm, local_user()];
1141 $tags = DBA::select('tag-search-view', ['uri-id'], $condition);
1143 while ($tag = DBA::fetch($tags)) {
1144 $uriids[] = $tag['uri-id'];
1148 if (empty($uriids)) {
1149 return DI::apiResponse()->formatData('statuses', $type, $data);
1152 $condition = ['uri-id' => $uriids];
1153 if ($exclude_replies) {
1154 $condition['gravity'] = GRAVITY_PARENT;
1157 $params['group_by'] = ['uri-id'];
1159 $condition = ["`id` > ?
1160 " . ($exclude_replies ? " AND `gravity` = " . GRAVITY_PARENT : ' ') . "
1161 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1162 AND `body` LIKE CONCAT('%',?,'%')",
1163 $since_id, api_user(), $_REQUEST['q']];
1165 $condition[0] .= ' AND `id` <= ?';
1166 $condition[] = $max_id;
1172 if (parse_url($searchTerm, PHP_URL_SCHEME) != '') {
1173 $id = Item::fetchByLink($searchTerm, api_user());
1176 $id = Item::fetchByLink($searchTerm);
1180 $statuses = Post::select([], ['id' => $id]);
1184 $statuses = $statuses ?: Post::selectForUser(api_user(), [], $condition, $params);
1186 $data['status'] = api_format_items(Post::toArray($statuses), $user_info);
1188 bindComments($data['status']);
1190 return DI::apiResponse()->formatData('statuses', $type, $data);
1193 /// @TODO move to top of file or somewhere better
1194 api_register_func('api/search/tweets', 'api_search', true);
1195 api_register_func('api/search', 'api_search', true);
1198 * Returns the most recent statuses posted by the user and the users they follow.
1200 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1202 * @param string $type Return type (atom, rss, xml, json)
1204 * @return array|string
1205 * @throws BadRequestException
1206 * @throws ForbiddenException
1207 * @throws ImagickException
1208 * @throws InternalServerErrorException
1209 * @throws UnauthorizedException
1210 * @todo Optional parameters
1211 * @todo Add reply info
1213 function api_statuses_home_timeline($type)
1215 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1217 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1219 unset($_REQUEST["user_id"]);
1220 unset($_GET["user_id"]);
1222 unset($_REQUEST["screen_name"]);
1223 unset($_GET["screen_name"]);
1225 // get last network messages
1228 $count = $_REQUEST['count'] ?? 20;
1229 $page = $_REQUEST['page']?? 0;
1230 $since_id = $_REQUEST['since_id'] ?? 0;
1231 $max_id = $_REQUEST['max_id'] ?? 0;
1232 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1233 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1235 $start = max(0, ($page - 1) * $count);
1237 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ?",
1238 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1241 $condition[0] .= " AND `id` <= ?";
1242 $condition[] = $max_id;
1244 if ($exclude_replies) {
1245 $condition[0] .= ' AND `gravity` = ?';
1246 $condition[] = GRAVITY_PARENT;
1248 if ($conversation_id > 0) {
1249 $condition[0] .= " AND `parent` = ?";
1250 $condition[] = $conversation_id;
1253 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1254 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1256 $items = Post::toArray($statuses);
1258 $ret = api_format_items($items, $user_info, false, $type);
1260 // Set all posts from the query above to seen
1262 foreach ($items as $item) {
1263 $idarray[] = intval($item["id"]);
1266 if (!empty($idarray)) {
1267 $unseen = Post::exists(['unseen' => true, 'id' => $idarray]);
1269 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1275 $data = ['status' => $ret];
1280 $data = api_rss_extra($data, $user_info);
1284 return DI::apiResponse()->formatData("statuses", $type, $data);
1288 /// @TODO move to top of file or somewhere better
1289 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1290 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1293 * Returns the most recent statuses from public users.
1295 * @param string $type Return type (atom, rss, xml, json)
1297 * @return array|string
1298 * @throws BadRequestException
1299 * @throws ForbiddenException
1300 * @throws ImagickException
1301 * @throws InternalServerErrorException
1302 * @throws UnauthorizedException
1304 function api_statuses_public_timeline($type)
1306 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1308 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1310 // get last network messages
1313 $count = $_REQUEST['count'] ?? 20;
1314 $page = $_REQUEST['page'] ?? 1;
1315 $since_id = $_REQUEST['since_id'] ?? 0;
1316 $max_id = $_REQUEST['max_id'] ?? 0;
1317 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
1318 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1320 $start = max(0, ($page - 1) * $count);
1322 if ($exclude_replies && !$conversation_id) {
1323 $condition = ["`gravity` = ? AND `id` > ? AND `private` = ? AND `wall` AND NOT `author-hidden`",
1324 GRAVITY_PARENT, $since_id, Item::PUBLIC];
1327 $condition[0] .= " AND `id` <= ?";
1328 $condition[] = $max_id;
1331 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1332 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1334 $r = Post::toArray($statuses);
1336 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND `private` = ? AND `wall` AND `origin` AND NOT `author-hidden`",
1337 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC];
1340 $condition[0] .= " AND `id` <= ?";
1341 $condition[] = $max_id;
1343 if ($conversation_id > 0) {
1344 $condition[0] .= " AND `parent` = ?";
1345 $condition[] = $conversation_id;
1348 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1349 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1351 $r = Post::toArray($statuses);
1354 $ret = api_format_items($r, $user_info, false, $type);
1358 $data = ['status' => $ret];
1363 $data = api_rss_extra($data, $user_info);
1367 return DI::apiResponse()->formatData("statuses", $type, $data);
1370 /// @TODO move to top of file or somewhere better
1371 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1374 * Returns the most recent statuses posted by users this node knows about.
1376 * @param string $type Return format: json, xml, atom, rss
1377 * @return array|string
1378 * @throws BadRequestException
1379 * @throws ForbiddenException
1380 * @throws ImagickException
1381 * @throws InternalServerErrorException
1382 * @throws UnauthorizedException
1384 function api_statuses_networkpublic_timeline($type)
1386 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1388 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1390 $since_id = $_REQUEST['since_id'] ?? 0;
1391 $max_id = $_REQUEST['max_id'] ?? 0;
1394 $count = $_REQUEST['count'] ?? 20;
1395 $page = $_REQUEST['page'] ?? 1;
1397 $start = max(0, ($page - 1) * $count);
1399 $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `id` > ? AND `private` = ?",
1400 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC];
1403 $condition[0] .= " AND `id` <= ?";
1404 $condition[] = $max_id;
1407 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1408 $statuses = Post::toArray(Post::selectForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params));
1410 $ret = api_format_items($statuses, $user_info, false, $type);
1414 $data = ['status' => $ret];
1419 $data = api_rss_extra($data, $user_info);
1423 return DI::apiResponse()->formatData("statuses", $type, $data);
1426 /// @TODO move to top of file or somewhere better
1427 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1430 * Returns a single status.
1432 * @param string $type Return type (atom, rss, xml, json)
1434 * @return array|string
1435 * @throws BadRequestException
1436 * @throws ForbiddenException
1437 * @throws ImagickException
1438 * @throws InternalServerErrorException
1439 * @throws UnauthorizedException
1440 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1442 function api_statuses_show($type)
1444 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1446 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1449 $id = intval(DI::args()->getArgv()[3] ?? 0);
1452 $id = intval($_REQUEST['id'] ?? 0);
1457 $id = intval(DI::args()->getArgv()[4] ?? 0);
1460 logger::notice('API: api_statuses_show: ' . $id);
1462 $conversation = !empty($_REQUEST['conversation']);
1464 // try to fetch the item for the local user - or the public item, if there is no local one
1465 $uri_item = Post::selectFirst(['uri-id'], ['id' => $id]);
1466 if (!DBA::isResult($uri_item)) {
1467 throw new BadRequestException(sprintf("There is no status with the id %d", $id));
1470 $item = Post::selectFirst(['id'], ['uri-id' => $uri_item['uri-id'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1471 if (!DBA::isResult($item)) {
1472 throw new BadRequestException(sprintf("There is no status with the uri-id %d for the given user.", $uri_item['uri-id']));
1477 if ($conversation) {
1478 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1479 $params = ['order' => ['id' => true]];
1481 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1485 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1487 /// @TODO How about copying this to above methods which don't check $r ?
1488 if (!DBA::isResult($statuses)) {
1489 throw new BadRequestException(sprintf("There is no status or conversation with the id %d.", $id));
1492 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
1494 if ($conversation) {
1495 $data = ['status' => $ret];
1496 return DI::apiResponse()->formatData("statuses", $type, $data);
1498 $data = ['status' => $ret[0]];
1499 return DI::apiResponse()->formatData("status", $type, $data);
1503 /// @TODO move to top of file or somewhere better
1504 api_register_func('api/statuses/show', 'api_statuses_show', true);
1508 * @param string $type Return type (atom, rss, xml, json)
1510 * @return array|string
1511 * @throws BadRequestException
1512 * @throws ForbiddenException
1513 * @throws ImagickException
1514 * @throws InternalServerErrorException
1515 * @throws UnauthorizedException
1516 * @todo nothing to say?
1518 function api_conversation_show($type)
1520 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1522 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1525 $id = intval(DI::args()->getArgv()[3] ?? 0);
1526 $since_id = intval($_REQUEST['since_id'] ?? 0);
1527 $max_id = intval($_REQUEST['max_id'] ?? 0);
1528 $count = intval($_REQUEST['count'] ?? 20);
1529 $page = intval($_REQUEST['page'] ?? 1);
1531 $start = max(0, ($page - 1) * $count);
1534 $id = intval($_REQUEST['id'] ?? 0);
1539 $id = intval(DI::args()->getArgv()[4] ?? 0);
1542 Logger::info(API_LOG_PREFIX . '{subaction}', ['module' => 'api', 'action' => 'conversation', 'subaction' => 'show', 'id' => $id]);
1544 // try to fetch the item for the local user - or the public item, if there is no local one
1545 $item = Post::selectFirst(['parent-uri-id'], ['id' => $id]);
1546 if (!DBA::isResult($item)) {
1547 throw new BadRequestException("There is no status with the id $id.");
1550 $parent = Post::selectFirst(['id'], ['uri-id' => $item['parent-uri-id'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1551 if (!DBA::isResult($parent)) {
1552 throw new BadRequestException("There is no status with this id.");
1555 $id = $parent['id'];
1557 $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `id` > ?",
1558 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1561 $condition[0] .= " AND `id` <= ?";
1562 $condition[] = $max_id;
1565 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1566 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1568 if (!DBA::isResult($statuses)) {
1569 throw new BadRequestException("There is no status with id $id.");
1572 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
1574 $data = ['status' => $ret];
1575 return DI::apiResponse()->formatData("statuses", $type, $data);
1578 /// @TODO move to top of file or somewhere better
1579 api_register_func('api/conversation/show', 'api_conversation_show', true);
1580 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
1585 * @param string $type Return type (atom, rss, xml, json)
1587 * @return array|string
1588 * @throws BadRequestException
1589 * @throws ForbiddenException
1590 * @throws ImagickException
1591 * @throws InternalServerErrorException
1592 * @throws UnauthorizedException
1593 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
1595 function api_statuses_repeat($type)
1601 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
1604 $id = intval(DI::args()->getArgv()[3] ?? 0);
1607 $id = intval($_REQUEST['id'] ?? 0);
1612 $id = intval(DI::args()->getArgv()[4] ?? 0);
1615 logger::notice('API: api_statuses_repeat: ' . $id);
1617 $fields = ['uri-id', 'network', 'body', 'title', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
1618 $item = Post::selectFirst($fields, ['id' => $id, 'private' => [Item::PUBLIC, Item::UNLISTED]]);
1620 if (DBA::isResult($item) && !empty($item['body'])) {
1621 if (in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::TWITTER])) {
1622 if (!Item::performActivity($id, 'announce', local_user())) {
1623 throw new InternalServerErrorException();
1628 if (strpos($item['body'], "[/share]") !== false) {
1629 $pos = strpos($item['body'], "[share");
1630 $post = substr($item['body'], $pos);
1632 $post = BBCode::getShareOpeningTag($item['author-name'], $item['author-link'], $item['author-avatar'], $item['plink'], $item['created'], $item['guid']);
1634 if (!empty($item['title'])) {
1635 $post .= '[h3]' . $item['title'] . "[/h3]\n";
1638 $post .= $item['body'];
1639 $post .= "[/share]";
1641 $_REQUEST['body'] = $post;
1642 $_REQUEST['profile_uid'] = api_user();
1643 $_REQUEST['api_source'] = true;
1645 if (empty($_REQUEST['source'])) {
1646 $_REQUEST["source"] = api_source();
1649 $item_id = item_post($a);
1652 throw new ForbiddenException();
1655 // output the post that we just posted.
1657 return api_status_show($type, $item_id);
1660 /// @TODO move to top of file or somewhere better
1661 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
1664 * Destroys a specific status.
1666 * @param string $type Return type (atom, rss, xml, json)
1668 * @return array|string
1669 * @throws BadRequestException
1670 * @throws ForbiddenException
1671 * @throws ImagickException
1672 * @throws InternalServerErrorException
1673 * @throws UnauthorizedException
1674 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
1676 function api_statuses_destroy($type)
1678 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
1681 $id = intval(DI::args()->getArgv()[3] ?? 0);
1684 $id = intval($_REQUEST['id'] ?? 0);
1689 $id = intval(DI::args()->getArgv()[4] ?? 0);
1692 logger::notice('API: api_statuses_destroy: ' . $id);
1694 $ret = api_statuses_show($type);
1696 Item::deleteForUser(['id' => $id], api_user());
1701 /// @TODO move to top of file or somewhere better
1702 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
1705 * Returns the most recent mentions.
1707 * @param string $type Return type (atom, rss, xml, json)
1709 * @return array|string
1710 * @throws BadRequestException
1711 * @throws ForbiddenException
1712 * @throws ImagickException
1713 * @throws InternalServerErrorException
1714 * @throws UnauthorizedException
1715 * @see http://developer.twitter.com/doc/get/statuses/mentions
1717 function api_statuses_mentions($type)
1719 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1721 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1723 unset($_REQUEST["user_id"]);
1724 unset($_GET["user_id"]);
1726 unset($_REQUEST["screen_name"]);
1727 unset($_GET["screen_name"]);
1729 // get last network messages
1732 $since_id = intval($_REQUEST['since_id'] ?? 0);
1733 $max_id = intval($_REQUEST['max_id'] ?? 0);
1734 $count = intval($_REQUEST['count'] ?? 20);
1735 $page = intval($_REQUEST['page'] ?? 1);
1737 $start = max(0, ($page - 1) * $count);
1739 $query = "`gravity` IN (?, ?) AND `uri-id` IN
1740 (SELECT `uri-id` FROM `post-user-notification` WHERE `uid` = ? AND `notification-type` & ? != 0 ORDER BY `uri-id`)
1741 AND (`uid` = 0 OR (`uid` = ? AND NOT `global`)) AND `id` > ?";
1744 GRAVITY_PARENT, GRAVITY_COMMENT,
1746 Post\UserNotification::TYPE_EXPLICIT_TAGGED | Post\UserNotification::TYPE_IMPLICIT_TAGGED |
1747 Post\UserNotification::TYPE_THREAD_COMMENT | Post\UserNotification::TYPE_DIRECT_COMMENT |
1748 Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT,
1749 api_user(), $since_id,
1753 $query .= " AND `id` <= ?";
1754 $condition[] = $max_id;
1757 array_unshift($condition, $query);
1759 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1760 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1762 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
1764 $data = ['status' => $ret];
1769 $data = api_rss_extra($data, $user_info);
1773 return DI::apiResponse()->formatData("statuses", $type, $data);
1776 /// @TODO move to top of file or somewhere better
1777 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
1778 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
1781 * Returns the most recent statuses posted by the user.
1783 * @param string $type Either "json" or "xml"
1784 * @return string|array
1785 * @throws BadRequestException
1786 * @throws ForbiddenException
1787 * @throws ImagickException
1788 * @throws InternalServerErrorException
1789 * @throws UnauthorizedException
1790 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
1792 function api_statuses_user_timeline($type)
1794 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1796 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1798 Logger::info('api_statuses_user_timeline', ['api_user' => api_user(), 'user_info' => $user_info, '_REQUEST' => $_REQUEST]);
1800 $since_id = $_REQUEST['since_id'] ?? 0;
1801 $max_id = $_REQUEST['max_id'] ?? 0;
1802 $exclude_replies = !empty($_REQUEST['exclude_replies']);
1803 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1806 $count = $_REQUEST['count'] ?? 20;
1807 $page = $_REQUEST['page'] ?? 1;
1809 $start = max(0, ($page - 1) * $count);
1811 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `contact-id` = ?",
1812 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
1814 if ($user_info['self'] == 1) {
1815 $condition[0] .= ' AND `wall` ';
1818 if ($exclude_replies) {
1819 $condition[0] .= ' AND `gravity` = ?';
1820 $condition[] = GRAVITY_PARENT;
1823 if ($conversation_id > 0) {
1824 $condition[0] .= " AND `parent` = ?";
1825 $condition[] = $conversation_id;
1829 $condition[0] .= " AND `id` <= ?";
1830 $condition[] = $max_id;
1832 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1833 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1835 $ret = api_format_items(Post::toArray($statuses), $user_info, true, $type);
1839 $data = ['status' => $ret];
1844 $data = api_rss_extra($data, $user_info);
1848 return DI::apiResponse()->formatData("statuses", $type, $data);
1851 /// @TODO move to top of file or somewhere better
1852 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
1855 * Star/unstar an item.
1856 * param: id : id of the item
1858 * @param string $type Return type (atom, rss, xml, json)
1860 * @return array|string
1861 * @throws BadRequestException
1862 * @throws ForbiddenException
1863 * @throws ImagickException
1864 * @throws InternalServerErrorException
1865 * @throws UnauthorizedException
1866 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
1868 function api_favorites_create_destroy($type)
1870 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
1872 // for versioned api.
1873 /// @TODO We need a better global soluton
1874 $action_argv_id = 2;
1875 if (count(DI::args()->getArgv()) > 1 && DI::args()->getArgv()[1] == "1.1") {
1876 $action_argv_id = 3;
1879 if (DI::args()->getArgc() <= $action_argv_id) {
1880 throw new BadRequestException("Invalid request.");
1882 $action = str_replace("." . $type, "", DI::args()->getArgv()[$action_argv_id]);
1883 if (DI::args()->getArgc() == $action_argv_id + 2) {
1884 $itemid = intval(DI::args()->getArgv()[$action_argv_id + 1] ?? 0);
1886 $itemid = intval($_REQUEST['id'] ?? 0);
1889 $item = Post::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
1891 if (!DBA::isResult($item)) {
1892 throw new BadRequestException("Invalid item.");
1897 $item['starred'] = 1;
1900 $item['starred'] = 0;
1903 throw new BadRequestException("Invalid action ".$action);
1906 $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
1909 throw new InternalServerErrorException("DB error");
1912 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1913 $rets = api_format_items([$item], $user_info, false, $type);
1916 $data = ['status' => $ret];
1921 $data = api_rss_extra($data, $user_info);
1925 return DI::apiResponse()->formatData("status", $type, $data);
1928 /// @TODO move to top of file or somewhere better
1929 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
1930 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
1933 * Returns the most recent favorite statuses.
1935 * @param string $type Return type (atom, rss, xml, json)
1937 * @return string|array
1938 * @throws BadRequestException
1939 * @throws ForbiddenException
1940 * @throws ImagickException
1941 * @throws InternalServerErrorException
1942 * @throws UnauthorizedException
1944 function api_favorites($type)
1948 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
1950 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
1954 // in friendica starred item are private
1955 // return favorites only for self
1956 Logger::info(API_LOG_PREFIX . 'for {self}', ['module' => 'api', 'action' => 'favorites', 'self' => $user_info['self']]);
1958 if ($user_info['self'] == 0) {
1962 $since_id = $_REQUEST['since_id'] ?? 0;
1963 $max_id = $_REQUEST['max_id'] ?? 0;
1964 $count = $_GET['count'] ?? 20;
1965 $page = $_REQUEST['page'] ?? 1;
1967 $start = max(0, ($page - 1) * $count);
1969 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
1970 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1972 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1975 $condition[0] .= " AND `id` <= ?";
1976 $condition[] = $max_id;
1979 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
1981 $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
1986 $data = ['status' => $ret];
1991 $data = api_rss_extra($data, $user_info);
1995 return DI::apiResponse()->formatData("statuses", $type, $data);
1998 /// @TODO move to top of file or somewhere better
1999 api_register_func('api/favorites', 'api_favorites', true);
2003 * @param array $item
2004 * @param array $recipient
2005 * @param array $sender
2008 * @throws InternalServerErrorException
2010 function api_format_messages($item, $recipient, $sender)
2012 // standard meta information
2014 'id' => $item['id'],
2015 'sender_id' => $sender['id'],
2017 'recipient_id' => $recipient['id'],
2018 'created_at' => api_date($item['created'] ?? DateTimeFormat::utcNow()),
2019 'sender_screen_name' => $sender['screen_name'],
2020 'recipient_screen_name' => $recipient['screen_name'],
2021 'sender' => $sender,
2022 'recipient' => $recipient,
2024 'friendica_seen' => $item['seen'] ?? 0,
2025 'friendica_parent_uri' => $item['parent-uri'] ?? '',
2028 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2029 if (isset($ret['sender']['uid'])) {
2030 unset($ret['sender']['uid']);
2032 if (isset($ret['sender']['self'])) {
2033 unset($ret['sender']['self']);
2035 if (isset($ret['recipient']['uid'])) {
2036 unset($ret['recipient']['uid']);
2038 if (isset($ret['recipient']['self'])) {
2039 unset($ret['recipient']['self']);
2042 //don't send title to regular StatusNET requests to avoid confusing these apps
2043 if (!empty($_GET['getText'])) {
2044 $ret['title'] = $item['title'];
2045 if ($_GET['getText'] == 'html') {
2046 $ret['text'] = BBCode::convertForUriId($item['uri-id'], $item['body'], BBCode::API);
2047 } elseif ($_GET['getText'] == 'plain') {
2048 $ret['text'] = trim(HTML::toPlaintext(BBCode::convertForUriId($item['uri-id'], api_clean_plain_items($item['body']), BBCode::API), 0));
2051 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convertForUriId($item['uri-id'], api_clean_plain_items($item['body']), BBCode::API), 0);
2053 if (!empty($_GET['getUserObjects']) && $_GET['getUserObjects'] == 'false') {
2054 unset($ret['sender']);
2055 unset($ret['recipient']);
2063 * @param array $item
2066 * @throws InternalServerErrorException
2068 function api_convert_item($item)
2070 $body = api_add_attachments_to_body($item);
2072 $entities = api_get_entitities($statustext, $body, $item['uri-id']);
2074 // Add pictures to the attachment array and remove them from the body
2075 $attachments = api_get_attachments($body, $item['uri-id']);
2077 // Workaround for ostatus messages where the title is identically to the body
2078 $html = BBCode::convertForUriId($item['uri-id'], api_clean_plain_items($body), BBCode::API);
2079 $statusbody = trim(HTML::toPlaintext($html, 0));
2081 // handle data: images
2082 $statusbody = api_format_items_embeded_images($item, $statusbody);
2084 $statustitle = trim($item['title']);
2086 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2087 $statustext = trim($statusbody);
2089 $statustext = trim($statustitle."\n\n".$statusbody);
2092 if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (mb_strlen($statustext)> 1000)) {
2093 $statustext = mb_substr($statustext, 0, 1000) . "... \n" . ($item['plink'] ?? '');
2096 $statushtml = BBCode::convertForUriId($item['uri-id'], BBCode::removeAttachment($body), BBCode::API);
2098 // Workaround for clients with limited HTML parser functionality
2099 $search = ["<br>", "<blockquote>", "</blockquote>",
2100 "<h1>", "</h1>", "<h2>", "</h2>",
2101 "<h3>", "</h3>", "<h4>", "</h4>",
2102 "<h5>", "</h5>", "<h6>", "</h6>"];
2103 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2104 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2105 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2106 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2107 $statushtml = str_replace($search, $replace, $statushtml);
2109 if ($item['title'] != "") {
2110 $statushtml = "<br><h4>" . BBCode::convertForUriId($item['uri-id'], $item['title']) . "</h4><br>" . $statushtml;
2114 $oldtext = $statushtml;
2115 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2116 } while ($oldtext != $statushtml);
2118 if (substr($statushtml, 0, 4) == '<br>') {
2119 $statushtml = substr($statushtml, 4);
2122 if (substr($statushtml, 0, -4) == '<br>') {
2123 $statushtml = substr($statushtml, -4);
2126 // feeds without body should contain the link
2127 if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2128 $statushtml .= BBCode::convertForUriId($item['uri-id'], $item['plink']);
2132 "text" => $statustext,
2133 "html" => $statushtml,
2134 "attachments" => $attachments,
2135 "entities" => $entities
2140 * Add media attachments to the body
2142 * @param array $item
2143 * @return string body with added media
2145 function api_add_attachments_to_body(array $item)
2147 $body = Post\Media::addAttachmentsToBody($item['uri-id'], $item['body']);
2149 if (strpos($body, '[/img]') !== false) {
2153 foreach (Post\Media::getByURIId($item['uri-id'], [Post\Media::HTML]) as $media) {
2154 if (!empty($media['preview'])) {
2155 $description = $media['description'] ?: $media['name'];
2156 if (!empty($description)) {
2157 $body .= "\n[img=" . $media['preview'] . ']' . $description .'[/img]';
2159 $body .= "\n[img]" . $media['preview'] .'[/img]';
2169 * @param string $body
2173 * @throws InternalServerErrorException
2175 function api_get_attachments(&$body, $uriid)
2177 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
2178 $body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $body);
2180 $URLSearchString = "^\[\]";
2181 if (!preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $body, $images)) {
2185 // Remove all embedded pictures, since they are added as attachments
2186 foreach ($images[0] as $orig) {
2187 $body = str_replace($orig, '', $body);
2192 foreach ($images[1] as $image) {
2193 $imagedata = Images::getInfoFromURLCached($image);
2196 $attachments[] = ["url" => Post\Link::getByLink($uriid, $image), "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2200 return $attachments;
2205 * @param string $text
2206 * @param string $bbcode
2209 * @throws InternalServerErrorException
2210 * @todo Links at the first character of the post
2212 function api_get_entitities(&$text, $bbcode, $uriid)
2214 $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
2216 if ($include_entities != "true") {
2217 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2219 foreach ($images[1] as $image) {
2220 $replace = Post\Link::getByLink($uriid, $image);
2221 $text = str_replace($image, $replace, $text);
2226 $bbcode = BBCode::cleanPictureLinks($bbcode);
2228 // Change pure links in text to bbcode uris
2229 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2232 $entities["hashtags"] = [];
2233 $entities["symbols"] = [];
2234 $entities["urls"] = [];
2235 $entities["user_mentions"] = [];
2237 $URLSearchString = "^\[\]";
2239 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2241 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2242 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2244 $bbcode = preg_replace(
2245 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2246 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2249 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2251 $bbcode = preg_replace(
2252 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2253 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2256 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2258 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2260 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2263 foreach ($urls[1] as $id => $url) {
2264 $start = iconv_strpos($text, $url, 0, "UTF-8");
2265 if (!($start === false)) {
2266 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2270 ksort($ordered_urls);
2274 foreach ($ordered_urls as $url) {
2275 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2276 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2278 $display_url = $url["title"];
2280 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2281 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2283 if (strlen($display_url) > 26) {
2284 $display_url = substr($display_url, 0, 25)."…";
2288 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2289 if (!($start === false)) {
2290 $entities["urls"][] = ["url" => $url["url"],
2291 "expanded_url" => $url["url"],
2292 "display_url" => $display_url,
2293 "indices" => [$start, $start+strlen($url["url"])]];
2294 $offset = $start + 1;
2298 preg_match_all("/\[img\=(.*?)\](.*?)\[\/img\]/ism", $bbcode, $images, PREG_SET_ORDER);
2299 $ordered_images = [];
2300 foreach ($images as $image) {
2301 $start = iconv_strpos($text, $image[1], 0, "UTF-8");
2302 if (!($start === false)) {
2303 $ordered_images[$start] = ['url' => $image[1], 'alt' => $image[2]];
2307 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2308 foreach ($images[1] as $image) {
2309 $start = iconv_strpos($text, $image, 0, "UTF-8");
2310 if (!($start === false)) {
2311 $ordered_images[$start] = ['url' => $image, 'alt' => ''];
2317 foreach ($ordered_images as $image) {
2318 $url = $image['url'];
2319 $ext_alt_text = $image['alt'];
2321 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2322 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2324 if (strlen($display_url) > 26) {
2325 $display_url = substr($display_url, 0, 25)."…";
2328 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2329 if (!($start === false)) {
2330 $image = Images::getInfoFromURLCached($url);
2332 $media_url = Post\Link::getByLink($uriid, $url);
2333 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2335 $entities["media"][] = [
2337 "id_str" => (string) ($start + 1),
2338 "indices" => [$start, $start+strlen($url)],
2339 "media_url" => Strings::normaliseLink($media_url),
2340 "media_url_https" => $media_url,
2342 "display_url" => $display_url,
2343 "expanded_url" => $url,
2344 "ext_alt_text" => $ext_alt_text,
2348 $offset = $start + 1;
2357 * @param array $item
2358 * @param string $text
2362 function api_format_items_embeded_images($item, $text)
2364 $text = preg_replace_callback(
2365 '|data:image/([^;]+)[^=]+=*|m',
2366 function () use ($item) {
2367 return DI::baseUrl() . '/display/' . $item['guid'];
2375 * return <a href='url'>name</a> as array
2377 * @param string $txt text
2382 function api_contactlink_to_array($txt)
2385 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2386 if ($r && count($match)==3) {
2388 'name' => $match[2],
2402 * return likes, dislikes and attend status for item
2404 * @param array $item array
2405 * @param string $type Return type (atom, rss, xml, json)
2408 * likes => int count,
2409 * dislikes => int count
2410 * @throws BadRequestException
2411 * @throws ImagickException
2412 * @throws InternalServerErrorException
2413 * @throws UnauthorizedException
2415 function api_format_items_activities($item, $type = "json")
2422 'attendmaybe' => [],
2426 $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY];
2427 $ret = Post::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2429 while ($parent_item = Post::fetch($ret)) {
2430 // not used as result should be structured like other user data
2431 //builtin_activity_puller($i, $activities);
2433 // get user data and add it to the array of the activity
2434 $user = DI::twitterUser()->createFromContactId($parent_item['author-id'], api_user())->toArray();
2435 switch ($parent_item['verb']) {
2436 case Activity::LIKE:
2437 $activities['like'][] = $user;
2439 case Activity::DISLIKE:
2440 $activities['dislike'][] = $user;
2442 case Activity::ATTEND:
2443 $activities['attendyes'][] = $user;
2445 case Activity::ATTENDNO:
2446 $activities['attendno'][] = $user;
2448 case Activity::ATTENDMAYBE:
2449 $activities['attendmaybe'][] = $user;
2451 case Activity::ANNOUNCE:
2452 $activities['announce'][] = $user;
2461 if ($type == "xml") {
2462 $xml_activities = [];
2463 foreach ($activities as $k => $v) {
2464 // change xml element from "like" to "friendica:like"
2465 $xml_activities["friendica:".$k] = $v;
2466 // add user data into xml output
2468 foreach ($v as $user) {
2469 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2472 $activities = $xml_activities;
2479 * format items to be returned by api
2481 * @param array $items array of items
2482 * @param array $user_info
2483 * @param bool $filter_user filter items by $user_info
2484 * @param string $type Return type (atom, rss, xml, json)
2486 * @throws BadRequestException
2487 * @throws ImagickException
2488 * @throws InternalServerErrorException
2489 * @throws UnauthorizedException
2491 function api_format_items($items, $user_info, $filter_user = false, $type = "json")
2497 if (empty($items)) {
2501 foreach ((array)$items as $item) {
2502 [$status_user, $author_user, $owner_user] = api_item_get_user($a, $item);
2504 // Look if the posts are matching if they should be filtered by user id
2505 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2509 $status = api_format_item($item, $type, $status_user, $author_user, $owner_user);
2518 * @param array $item Item record
2519 * @param string $type Return format (atom, rss, xml, json)
2520 * @param array $status_user User record of the item author, can be provided by api_item_get_user()
2521 * @param array $author_user User record of the item author, can be provided by api_item_get_user()
2522 * @param array $owner_user User record of the item owner, can be provided by api_item_get_user()
2523 * @return array API-formatted status
2524 * @throws BadRequestException
2525 * @throws ImagickException
2526 * @throws InternalServerErrorException
2527 * @throws UnauthorizedException
2529 function api_format_item($item, $type = "json", $status_user = null, $author_user = null, $owner_user = null)
2533 if (empty($status_user) || empty($author_user) || empty($owner_user)) {
2534 [$status_user, $author_user, $owner_user] = api_item_get_user($a, $item);
2537 DI::contentItem()->localize($item);
2539 $in_reply_to = api_in_reply_to($item);
2541 $converted = api_convert_item($item);
2543 if ($type == "xml") {
2544 $geo = "georss:point";
2550 'text' => $converted["text"],
2551 'truncated' => false,
2552 'created_at'=> api_date($item['created']),
2553 'in_reply_to_status_id' => $in_reply_to['status_id'],
2554 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
2555 'source' => (($item['app']) ? $item['app'] : 'web'),
2556 'id' => intval($item['id']),
2557 'id_str' => (string) intval($item['id']),
2558 'in_reply_to_user_id' => $in_reply_to['user_id'],
2559 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
2560 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
2562 'favorited' => $item['starred'] ? true : false,
2563 'user' => $status_user,
2564 'friendica_author' => $author_user,
2565 'friendica_owner' => $owner_user,
2566 'friendica_private' => $item['private'] == Item::PRIVATE,
2567 //'entities' => NULL,
2568 'statusnet_html' => $converted["html"],
2569 'statusnet_conversation_id' => $item['parent'],
2570 'external_url' => DI::baseUrl() . "/display/" . $item['guid'],
2571 'friendica_activities' => api_format_items_activities($item, $type),
2572 'friendica_title' => $item['title'],
2573 'friendica_html' => BBCode::convertForUriId($item['uri-id'], $item['body'], BBCode::EXTERNAL)
2576 if (count($converted["attachments"]) > 0) {
2577 $status["attachments"] = $converted["attachments"];
2580 if (count($converted["entities"]) > 0) {
2581 $status["entities"] = $converted["entities"];
2584 if ($status["source"] == 'web') {
2585 $status["source"] = ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']);
2586 } elseif (ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']) != $status["source"]) {
2587 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']).')');
2590 $retweeted_item = [];
2593 if (empty($retweeted_item) && ($item['owner-id'] == $item['author-id'])) {
2594 $announce = api_get_announce($item);
2595 if (!empty($announce)) {
2596 $retweeted_item = $item;
2598 $status['friendica_owner'] = DI::twitterUser()->createFromContactId($announce['author-id'], api_user())->toArray();
2602 if (!empty($quoted_item)) {
2603 if ($quoted_item['id'] != $item['id']) {
2604 $quoted_status = api_format_item($quoted_item);
2605 /// @todo Only remove the attachments that are also contained in the quotes status
2606 unset($status['attachments']);
2607 unset($status['entities']);
2609 $conv_quoted = api_convert_item($quoted_item);
2610 $quoted_status = $status;
2611 unset($quoted_status['attachments']);
2612 unset($quoted_status['entities']);
2613 unset($quoted_status['statusnet_conversation_id']);
2614 $quoted_status['text'] = $conv_quoted['text'];
2615 $quoted_status['statusnet_html'] = $conv_quoted['html'];
2617 $quoted_status["user"] = DI::twitterUser()->createFromContactId($quoted_item['author-id'], api_user())->toArray();
2618 } catch (BadRequestException $e) {
2619 // user not found. should be found?
2620 /// @todo check if the user should be always found
2621 $quoted_status["user"] = [];
2624 unset($quoted_status['friendica_author']);
2625 unset($quoted_status['friendica_owner']);
2626 unset($quoted_status['friendica_activities']);
2627 unset($quoted_status['friendica_private']);
2630 if (!empty($retweeted_item)) {
2631 $retweeted_status = $status;
2632 unset($retweeted_status['friendica_author']);
2633 unset($retweeted_status['friendica_owner']);
2634 unset($retweeted_status['friendica_activities']);
2635 unset($retweeted_status['friendica_private']);
2636 unset($retweeted_status['statusnet_conversation_id']);
2637 $status['user'] = $status['friendica_owner'];
2639 $retweeted_status["user"] = DI::twitterUser()->createFromContactId($retweeted_item['author-id'], api_user())->toArray();
2640 } catch (BadRequestException $e) {
2641 // user not found. should be found?
2642 /// @todo check if the user should be always found
2643 $retweeted_status["user"] = [];
2646 $rt_converted = api_convert_item($retweeted_item);
2648 $retweeted_status['text'] = $rt_converted["text"];
2649 $retweeted_status['statusnet_html'] = $rt_converted["html"];
2650 $retweeted_status['friendica_html'] = $rt_converted["html"];
2651 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
2653 if (!empty($quoted_status)) {
2654 $retweeted_status['quoted_status'] = $quoted_status;
2657 $status['friendica_author'] = $retweeted_status['user'];
2658 $status['retweeted_status'] = $retweeted_status;
2659 } elseif (!empty($quoted_status)) {
2660 $root_status = api_convert_item($item);
2662 $status['text'] = $root_status["text"];
2663 $status['statusnet_html'] = $root_status["html"];
2664 $status['quoted_status'] = $quoted_status;
2667 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2668 unset($status["user"]["uid"]);
2669 unset($status["user"]["self"]);
2671 if ($item["coord"] != "") {
2672 $coords = explode(' ', $item["coord"]);
2673 if (count($coords) == 2) {
2674 if ($type == "json") {
2675 $status["geo"] = ['type' => 'Point',
2676 'coordinates' => [(float) $coords[0],
2677 (float) $coords[1]]];
2678 } else {// Not sure if this is the official format - if someone founds a documentation we can check
2679 $status["georss:point"] = $item["coord"];
2688 * Returns all lists the user subscribes to.
2690 * @param string $type Return type (atom, rss, xml, json)
2692 * @return array|string
2693 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
2695 function api_lists_list($type)
2698 /// @TODO $ret is not filled here?
2699 return DI::apiResponse()->formatData('lists', $type, ["lists_list" => $ret]);
2702 /// @TODO move to top of file or somewhere better
2703 api_register_func('api/lists/list', 'api_lists_list', true);
2704 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
2707 * Returns all groups the user owns.
2709 * @param string $type Return type (atom, rss, xml, json)
2711 * @return array|string
2712 * @throws BadRequestException
2713 * @throws ForbiddenException
2714 * @throws ImagickException
2715 * @throws InternalServerErrorException
2716 * @throws UnauthorizedException
2717 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
2719 function api_lists_ownerships($type)
2721 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
2724 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
2725 $uid = $user_info['uid'];
2727 $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
2729 // loop through all groups
2731 foreach ($groups as $group) {
2732 if ($group['visible']) {
2738 'name' => $group['name'],
2739 'id' => intval($group['id']),
2740 'id_str' => (string) $group['id'],
2741 'user' => $user_info,
2745 return DI::apiResponse()->formatData("lists", $type, ['lists' => ['lists' => $lists]]);
2748 /// @TODO move to top of file or somewhere better
2749 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
2752 * Returns recent statuses from users in the specified group.
2754 * @param string $type Return type (atom, rss, xml, json)
2756 * @return array|string
2757 * @throws BadRequestException
2758 * @throws ForbiddenException
2759 * @throws ImagickException
2760 * @throws InternalServerErrorException
2761 * @throws UnauthorizedException
2762 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
2764 function api_lists_statuses($type)
2766 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
2768 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
2770 unset($_REQUEST["user_id"]);
2771 unset($_GET["user_id"]);
2773 unset($_REQUEST["screen_name"]);
2774 unset($_GET["screen_name"]);
2776 if (empty($_REQUEST['list_id'])) {
2777 throw new BadRequestException('list_id not specified');
2781 $count = $_REQUEST['count'] ?? 20;
2782 $page = $_REQUEST['page'] ?? 1;
2783 $since_id = $_REQUEST['since_id'] ?? 0;
2784 $max_id = $_REQUEST['max_id'] ?? 0;
2785 $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
2786 $conversation_id = $_REQUEST['conversation_id'] ?? 0;
2788 $start = max(0, ($page - 1) * $count);
2790 $groups = DBA::selectToArray('group_member', ['contact-id'], ['gid' => 1]);
2791 $gids = array_column($groups, 'contact-id');
2792 $condition = ['uid' => api_user(), 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'group-id' => $gids];
2793 $condition = DBA::mergeConditions($condition, ["`id` > ?", $since_id]);
2796 $condition[0] .= " AND `id` <= ?";
2797 $condition[] = $max_id;
2799 if ($exclude_replies > 0) {
2800 $condition[0] .= ' AND `gravity` = ?';
2801 $condition[] = GRAVITY_PARENT;
2803 if ($conversation_id > 0) {
2804 $condition[0] .= " AND `parent` = ?";
2805 $condition[] = $conversation_id;
2808 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2809 $statuses = Post::selectForUser(api_user(), [], $condition, $params);
2811 $items = api_format_items(Post::toArray($statuses), $user_info, false, $type);
2813 $data = ['status' => $items];
2818 $data = api_rss_extra($data, $user_info);
2822 return DI::apiResponse()->formatData("statuses", $type, $data);
2825 /// @TODO move to top of file or somewhere better
2826 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
2829 * Returns either the friends of the follower list
2831 * Considers friends and followers lists to be private and won't return
2832 * anything if any user_id parameter is passed.
2834 * @param string $qtype Either "friends" or "followers"
2835 * @return boolean|array
2836 * @throws BadRequestException
2837 * @throws ForbiddenException
2838 * @throws ImagickException
2839 * @throws InternalServerErrorException
2840 * @throws UnauthorizedException
2842 function api_statuses_f($qtype)
2844 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
2847 $count = $_GET['count'] ?? 20;
2848 $page = $_GET['page'] ?? 1;
2850 $start = max(0, ($page - 1) * $count);
2852 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
2854 if (!empty($_GET['cursor']) && $_GET['cursor'] == 'undefined') {
2855 /* this is to stop Hotot to load friends multiple times
2856 * I'm not sure if I'm missing return something or
2857 * is a bug in hotot. Workaround, meantime
2861 return array('$users' => $ret);*/
2866 if ($qtype == 'friends') {
2867 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
2868 } elseif ($qtype == 'followers') {
2869 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
2872 // friends and followers only for self
2873 if ($user_info['self'] == 0) {
2874 $sql_extra = " AND false ";
2877 if ($qtype == 'blocks') {
2878 $sql_filter = 'AND `blocked` AND NOT `pending`';
2879 } elseif ($qtype == 'incoming') {
2880 $sql_filter = 'AND `pending`';
2882 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
2885 // @todo This query most likely can be replaced with a Contact::select...
2886 $r = DBA::toArray(DBA::p(
2901 foreach ($r as $cid) {
2902 $user = DI::twitterUser()->createFromContactId($cid['id'], api_user())->toArray();
2903 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2904 unset($user["uid"]);
2905 unset($user["self"]);
2912 return ['user' => $ret];
2917 * Returns the list of friends of the provided user
2919 * @deprecated By Twitter API in favor of friends/list
2921 * @param string $type Either "json" or "xml"
2922 * @return boolean|string|array
2923 * @throws BadRequestException
2924 * @throws ForbiddenException
2926 function api_statuses_friends($type)
2928 $data = api_statuses_f("friends");
2929 if ($data === false) {
2932 return DI::apiResponse()->formatData("users", $type, $data);
2936 * Returns the list of followers of the provided user
2938 * @deprecated By Twitter API in favor of friends/list
2940 * @param string $type Either "json" or "xml"
2941 * @return boolean|string|array
2942 * @throws BadRequestException
2943 * @throws ForbiddenException
2945 function api_statuses_followers($type)
2947 $data = api_statuses_f("followers");
2948 if ($data === false) {
2951 return DI::apiResponse()->formatData("users", $type, $data);
2954 /// @TODO move to top of file or somewhere better
2955 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
2956 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
2959 * Returns the list of blocked users
2961 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
2963 * @param string $type Either "json" or "xml"
2965 * @return boolean|string|array
2966 * @throws BadRequestException
2967 * @throws ForbiddenException
2969 function api_blocks_list($type)
2971 $data = api_statuses_f('blocks');
2972 if ($data === false) {
2975 return DI::apiResponse()->formatData("users", $type, $data);
2978 /// @TODO move to top of file or somewhere better
2979 api_register_func('api/blocks/list', 'api_blocks_list', true);
2982 * Returns the list of pending users IDs
2984 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
2986 * @param string $type Either "json" or "xml"
2988 * @return boolean|string|array
2989 * @throws BadRequestException
2990 * @throws ForbiddenException
2992 function api_friendships_incoming($type)
2994 $data = api_statuses_f('incoming');
2995 if ($data === false) {
3000 foreach ($data['user'] as $user) {
3001 $ids[] = $user['id'];
3004 return DI::apiResponse()->formatData("ids", $type, ['id' => $ids]);
3007 /// @TODO move to top of file or somewhere better
3008 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3011 * Sends a new direct message.
3013 * @param string $type Return type (atom, rss, xml, json)
3015 * @return array|string
3016 * @throws BadRequestException
3017 * @throws ForbiddenException
3018 * @throws ImagickException
3019 * @throws InternalServerErrorException
3020 * @throws NotFoundException
3021 * @throws UnauthorizedException
3022 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3024 function api_direct_messages_new($type)
3026 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
3030 throw new ForbiddenException();
3033 if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3037 $sender = DI::twitterUser()->createFromUserId($uid)->toArray();
3040 if (!empty($_POST['screen_name'])) {
3041 $contacts = Contact::selectToArray(['id', 'nurl', 'network'], ['uid' => api_user(), 'nick' => $_POST['screen_name']]);
3042 if (DBA::isResult($contacts)) {
3043 // Selecting the id by priority, friendica first
3044 api_best_nickname($contacts);
3046 $recipient = DI::twitterUser()->createFromContactId($contacts[0]['id'], $uid)->toArray();
3049 $recipient = api_get_user($_POST['user_id']);
3052 if (empty($recipient)) {
3053 throw new NotFoundException('Recipient not found');
3057 if (!empty($_REQUEST['replyto'])) {
3058 $mail = DBA::selectFirst('mail', ['parent-uri', 'title'], ['uid' => api_user(), 'id' => $_REQUEST['replyto']]);
3059 $replyto = $mail['parent-uri'];
3060 $sub = $mail['title'];
3062 if (!empty($_REQUEST['title'])) {
3063 $sub = $_REQUEST['title'];
3065 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3069 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3072 $mail = DBA::selectFirst('mail', [], ['id' => $id]);
3073 $ret = api_format_messages($mail, $recipient, $sender);
3075 $ret = ["error" => $id];
3078 $data = ['direct_message'=>$ret];
3084 $data = api_rss_extra($data, $sender);
3088 return DI::apiResponse()->formatData("direct-messages", $type, $data);
3091 /// @TODO move to top of file or somewhere better
3092 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3095 * delete a direct_message from mail table through api
3097 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3098 * @return string|array
3099 * @throws BadRequestException
3100 * @throws ForbiddenException
3101 * @throws ImagickException
3102 * @throws InternalServerErrorException
3103 * @throws UnauthorizedException
3104 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3106 function api_direct_messages_destroy($type)
3108 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
3111 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
3113 $id = $_REQUEST['id'] ?? 0;
3115 $parenturi = $_REQUEST['friendica_parenturi'] ?? '';
3116 $verbose = (!empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false");
3117 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3119 $uid = $user_info['uid'];
3120 // error if no id or parenturi specified (for clients posting parent-uri as well)
3121 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3122 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3123 return DI::apiResponse()->formatData("direct_messages_delete", $type, ['$result' => $answer]);
3126 // BadRequestException if no id specified (for clients using Twitter API)
3128 throw new BadRequestException('Message id not specified');
3131 // add parent-uri to sql command if specified by calling app
3132 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3134 // error message if specified id is not in database
3135 if (!DBA::exists('mail', ["`uid` = ? AND `id` = ? " . $sql_extra, $uid, $id])) {
3136 if ($verbose == "true") {
3137 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3138 return DI::apiResponse()->formatData("direct_messages_delete", $type, ['$result' => $answer]);
3140 /// @todo BadRequestException ok for Twitter API clients?
3141 throw new BadRequestException('message id not in database');
3145 $result = DBA::delete('mail', ["`uid` = ? AND `id` = ? " . $sql_extra, $uid, $id]);
3147 if ($verbose == "true") {
3150 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3151 return DI::apiResponse()->formatData("direct_message_delete", $type, ['$result' => $answer]);
3153 $answer = ['result' => 'error', 'message' => 'unknown error'];
3154 return DI::apiResponse()->formatData("direct_messages_delete", $type, ['$result' => $answer]);
3157 /// @todo return JSON data like Twitter API not yet implemented
3160 /// @TODO move to top of file or somewhere better
3161 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3166 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3167 * @return string|array
3168 * @throws HTTPException\BadRequestException
3169 * @throws HTTPException\ExpectationFailedException
3170 * @throws HTTPException\ForbiddenException
3171 * @throws HTTPException\InternalServerErrorException
3172 * @throws HTTPException\NotFoundException
3173 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3175 function api_friendships_destroy($type)
3179 if ($uid === false) {
3180 throw new HTTPException\ForbiddenException();
3183 $owner = User::getOwnerDataById($uid);
3185 Logger::notice(API_LOG_PREFIX . 'No owner {uid} found', ['module' => 'api', 'action' => 'friendships_destroy', 'uid' => $uid]);
3186 throw new HTTPException\NotFoundException('Error Processing Request');
3189 $contact_id = $_REQUEST['user_id'] ?? 0;
3191 if (empty($contact_id)) {
3192 Logger::notice(API_LOG_PREFIX . 'No user_id specified', ['module' => 'api', 'action' => 'friendships_destroy']);
3193 throw new HTTPException\BadRequestException('no user_id specified');
3196 // Get Contact by given id
3197 $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3199 if(!DBA::isResult($contact)) {
3200 Logger::notice(API_LOG_PREFIX . 'No public contact found for ID {contact}', ['module' => 'api', 'action' => 'friendships_destroy', 'contact' => $contact_id]);
3201 throw new HTTPException\NotFoundException('no contact found to given ID');
3204 $url = $contact['url'];
3206 $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3207 $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url),
3208 Strings::normaliseLink($url), $url];
3209 $contact = DBA::selectFirst('contact', [], $condition);
3211 if (!DBA::isResult($contact)) {
3212 Logger::notice(API_LOG_PREFIX . 'Not following contact', ['module' => 'api', 'action' => 'friendships_destroy']);
3213 throw new HTTPException\NotFoundException('Not following Contact');
3217 $result = Contact::terminateFriendship($owner, $contact);
3219 if ($result === null) {
3220 Logger::notice(API_LOG_PREFIX . 'Not supported for {network}', ['module' => 'api', 'action' => 'friendships_destroy', 'network' => $contact['network']]);
3221 throw new HTTPException\ExpectationFailedException('Unfollowing is currently not supported by this contact\'s network.');
3224 if ($result === false) {
3225 throw new HTTPException\ServiceUnavailableException('Unable to unfollow this contact, please retry in a few minutes or contact your administrator.');
3227 } catch (Exception $e) {
3228 Logger::error(API_LOG_PREFIX . $e->getMessage(), ['owner' => $owner, 'contact' => $contact]);
3229 throw new HTTPException\InternalServerErrorException('Unable to unfollow this contact, please contact your administrator');
3232 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3233 unset($contact['uid']);
3234 unset($contact['self']);
3236 // Set screen_name since Twidere requests it
3237 $contact['screen_name'] = $contact['nick'];
3239 return DI::apiResponse()->formatData('friendships-destroy', $type, ['user' => $contact]);
3242 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3246 * @param string $type Return type (atom, rss, xml, json)
3247 * @param string $box
3248 * @param string $verbose
3250 * @return array|string
3251 * @throws BadRequestException
3252 * @throws ForbiddenException
3253 * @throws ImagickException
3254 * @throws InternalServerErrorException
3255 * @throws UnauthorizedException
3257 function api_direct_messages_box($type, $box, $verbose)
3259 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
3262 $count = $_GET['count'] ?? 20;
3263 $page = $_REQUEST['page'] ?? 1;
3265 $since_id = $_REQUEST['since_id'] ?? 0;
3266 $max_id = $_REQUEST['max_id'] ?? 0;
3268 $user_id = $_REQUEST['user_id'] ?? '';
3269 $screen_name = $_REQUEST['screen_name'] ?? '';
3272 unset($_REQUEST["user_id"]);
3273 unset($_GET["user_id"]);
3275 unset($_REQUEST["screen_name"]);
3276 unset($_GET["screen_name"]);
3278 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
3280 $profile_url = $user_info["url"];
3283 $start = max(0, ($page - 1) * $count);
3288 if ($box=="sentbox") {
3289 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
3290 } elseif ($box == "conversation") {
3291 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape($_GET['uri'] ?? '') . "'";
3292 } elseif ($box == "all") {
3293 $sql_extra = "true";
3294 } elseif ($box == "inbox") {
3295 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
3299 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3302 if ($user_id != "") {
3303 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3304 } elseif ($screen_name !="") {
3305 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
3308 $r = DBA::toArray(DBA::p(
3309 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid` = ? AND $sql_extra AND `mail`.`id` > ? ORDER BY `mail`.`id` DESC LIMIT ?,?",
3315 if ($verbose == "true" && !DBA::isResult($r)) {
3316 $answer = ['result' => 'error', 'message' => 'no mails available'];
3317 return DI::apiResponse()->formatData("direct_messages_all", $type, ['$result' => $answer]);
3321 foreach ($r as $item) {
3322 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3323 $recipient = $user_info;
3324 $sender = DI::twitterUser()->createFromContactId($item['contact-id'], api_user())->toArray();
3325 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3326 $recipient = DI::twitterUser()->createFromContactId($item['contact-id'], api_user())->toArray();
3327 $sender = $user_info;
3330 if (isset($recipient) && isset($sender)) {
3331 $ret[] = api_format_messages($item, $recipient, $sender);
3336 $data = ['direct_message' => $ret];
3341 $data = api_rss_extra($data, $user_info);
3345 return DI::apiResponse()->formatData("direct-messages", $type, $data);
3349 * Returns the most recent direct messages sent by the user.
3351 * @param string $type Return type (atom, rss, xml, json)
3353 * @return array|string
3354 * @throws BadRequestException
3355 * @throws ForbiddenException
3356 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3358 function api_direct_messages_sentbox($type)
3360 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3361 return api_direct_messages_box($type, "sentbox", $verbose);
3365 * Returns the most recent direct messages sent to the user.
3367 * @param string $type Return type (atom, rss, xml, json)
3369 * @return array|string
3370 * @throws BadRequestException
3371 * @throws ForbiddenException
3372 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3374 function api_direct_messages_inbox($type)
3376 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3377 return api_direct_messages_box($type, "inbox", $verbose);
3382 * @param string $type Return type (atom, rss, xml, json)
3384 * @return array|string
3385 * @throws BadRequestException
3386 * @throws ForbiddenException
3388 function api_direct_messages_all($type)
3390 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3391 return api_direct_messages_box($type, "all", $verbose);
3396 * @param string $type Return type (atom, rss, xml, json)
3398 * @return array|string
3399 * @throws BadRequestException
3400 * @throws ForbiddenException
3402 function api_direct_messages_conversation($type)
3404 $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3405 return api_direct_messages_box($type, "conversation", $verbose);
3408 /// @TODO move to top of file or somewhere better
3409 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3410 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3411 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3412 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3415 * list all photos of the authenticated user
3417 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3418 * @return string|array
3419 * @throws ForbiddenException
3420 * @throws InternalServerErrorException
3422 function api_fr_photos_list($type)
3424 if (api_user() === false) {
3425 throw new ForbiddenException();
3427 $r = DBA::toArray(DBA::p(
3428 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
3429 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
3430 WHERE `uid` = ? AND NOT `photo-type` IN (?, ?) GROUP BY `resource-id`, `album`, `filename`, `type`",
3431 local_user(), Photo::CONTACT_AVATAR, Photo::CONTACT_BANNER
3434 'image/jpeg' => 'jpg',
3435 'image/png' => 'png',
3436 'image/gif' => 'gif'
3438 $data = ['photo'=>[]];
3439 if (DBA::isResult($r)) {
3440 foreach ($r as $rr) {
3442 $photo['id'] = $rr['resource-id'];
3443 $photo['album'] = $rr['album'];
3444 $photo['filename'] = $rr['filename'];
3445 $photo['type'] = $rr['type'];
3446 $thumb = DI::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
3447 $photo['created'] = $rr['created'];
3448 $photo['edited'] = $rr['edited'];
3449 $photo['desc'] = $rr['desc'];
3451 if ($type == "xml") {
3452 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
3454 $photo['thumb'] = $thumb;
3455 $data['photo'][] = $photo;
3459 return DI::apiResponse()->formatData("photos", $type, $data);
3463 * upload a new photo or change an existing photo
3465 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3466 * @return string|array
3467 * @throws BadRequestException
3468 * @throws ForbiddenException
3469 * @throws ImagickException
3470 * @throws InternalServerErrorException
3471 * @throws NotFoundException
3473 function api_fr_photo_create_update($type)
3475 if (api_user() === false) {
3476 throw new ForbiddenException();
3479 $photo_id = $_REQUEST['photo_id'] ?? null;
3480 $desc = $_REQUEST['desc'] ?? null;
3481 $album = $_REQUEST['album'] ?? null;
3482 $album_new = $_REQUEST['album_new'] ?? null;
3483 $allow_cid = $_REQUEST['allow_cid'] ?? null;
3484 $deny_cid = $_REQUEST['deny_cid' ] ?? null;
3485 $allow_gid = $_REQUEST['allow_gid'] ?? null;
3486 $deny_gid = $_REQUEST['deny_gid' ] ?? null;
3487 $visibility = !$allow_cid && !$deny_cid && !$allow_gid && !$deny_gid;
3489 // do several checks on input parameters
3490 // we do not allow calls without album string
3491 if ($album == null) {
3492 throw new BadRequestException("no albumname specified");
3494 // if photo_id == null --> we are uploading a new photo
3495 if ($photo_id == null) {
3498 // error if no media posted in create-mode
3499 if (empty($_FILES['media'])) {
3501 throw new BadRequestException("no media data submitted");
3504 // album_new will be ignored in create-mode
3509 // check if photo is existing in databasei
3510 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user(), 'album' => $album])) {
3511 throw new BadRequestException("photo not available");
3515 // checks on acl strings provided by clients
3516 $acl_input_error = false;
3517 $acl_input_error |= check_acl_input($allow_cid);
3518 $acl_input_error |= check_acl_input($deny_cid);
3519 $acl_input_error |= check_acl_input($allow_gid);
3520 $acl_input_error |= check_acl_input($deny_gid);
3521 if ($acl_input_error) {
3522 throw new BadRequestException("acl data invalid");
3524 // now let's upload the new media in create-mode
3525 if ($mode == "create") {
3526 $media = $_FILES['media'];
3527 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, Photo::DEFAULT, $visibility);
3529 // return success of updating or error message
3530 if (!is_null($data)) {
3531 return DI::apiResponse()->formatData("photo_create", $type, $data);
3533 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
3537 // now let's do the changes in update-mode
3538 if ($mode == "update") {
3539 $updated_fields = [];
3541 if (!is_null($desc)) {
3542 $updated_fields['desc'] = $desc;
3545 if (!is_null($album_new)) {
3546 $updated_fields['album'] = $album_new;
3549 if (!is_null($allow_cid)) {
3550 $allow_cid = trim($allow_cid);
3551 $updated_fields['allow_cid'] = $allow_cid;
3554 if (!is_null($deny_cid)) {
3555 $deny_cid = trim($deny_cid);
3556 $updated_fields['deny_cid'] = $deny_cid;
3559 if (!is_null($allow_gid)) {
3560 $allow_gid = trim($allow_gid);
3561 $updated_fields['allow_gid'] = $allow_gid;
3564 if (!is_null($deny_gid)) {
3565 $deny_gid = trim($deny_gid);
3566 $updated_fields['deny_gid'] = $deny_gid;
3570 if (count($updated_fields) > 0) {
3571 $nothingtodo = false;
3572 $result = Photo::update($updated_fields, ['uid' => api_user(), 'resource-id' => $photo_id, 'album' => $album]);
3574 $nothingtodo = true;
3577 if (!empty($_FILES['media'])) {
3578 $nothingtodo = false;
3579 $media = $_FILES['media'];
3580 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, Photo::DEFAULT, $visibility, $photo_id);
3581 if (!is_null($data)) {
3582 return DI::apiResponse()->formatData("photo_update", $type, $data);
3586 // return success of updating or error message
3588 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
3589 return DI::apiResponse()->formatData("photo_update", $type, ['$result' => $answer]);
3592 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
3593 return DI::apiResponse()->formatData("photo_update", $type, ['$result' => $answer]);
3595 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
3598 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
3602 * returns the details of a specified photo id, if scale is given, returns the photo data in base 64
3604 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3605 * @return string|array
3606 * @throws BadRequestException
3607 * @throws ForbiddenException
3608 * @throws InternalServerErrorException
3609 * @throws NotFoundException
3611 function api_fr_photo_detail($type)
3613 if (api_user() === false) {
3614 throw new ForbiddenException();
3616 if (empty($_REQUEST['photo_id'])) {
3617 throw new BadRequestException("No photo id.");
3620 $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
3621 $photo_id = $_REQUEST['photo_id'];
3623 // prepare json/xml output with data from database for the requested photo
3624 $data = prepare_photo_data($type, $scale, $photo_id);
3626 return DI::apiResponse()->formatData("photo_detail", $type, $data);
3631 * updates the profile image for the user (either a specified profile or the default profile)
3633 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3635 * @return string|array
3636 * @throws BadRequestException
3637 * @throws ForbiddenException
3638 * @throws ImagickException
3639 * @throws InternalServerErrorException
3640 * @throws NotFoundException
3641 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
3643 function api_account_update_profile_image($type)
3645 if (api_user() === false) {
3646 throw new ForbiddenException();
3649 $profile_id = $_REQUEST['profile_id'] ?? 0;
3651 // error if image data is missing
3652 if (empty($_FILES['image'])) {
3653 throw new BadRequestException("no media data submitted");
3656 // check if specified profile id is valid
3657 if ($profile_id != 0) {
3658 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
3659 // error message if specified profile id is not in database
3660 if (!DBA::isResult($profile)) {
3661 throw new BadRequestException("profile_id not available");
3663 $is_default_profile = $profile['is-default'];
3665 $is_default_profile = 1;
3668 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
3670 if (!empty($_FILES['image'])) {
3671 $media = $_FILES['image'];
3672 } elseif (!empty($_FILES['media'])) {
3673 $media = $_FILES['media'];
3675 // save new profile image
3676 $data = save_media_to_database("profileimage", $media, $type, DI::l10n()->t(Photo::PROFILE_PHOTOS), "", "", "", "", "", Photo::USER_AVATAR);
3679 if (is_array($media['type'])) {
3680 $filetype = $media['type'][0];
3682 $filetype = $media['type'];
3684 if ($filetype == "image/jpeg") {
3686 } elseif ($filetype == "image/png") {
3689 throw new InternalServerErrorException('Unsupported filetype');
3692 // change specified profile or all profiles to the new resource-id
3693 if ($is_default_profile) {
3694 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
3695 Photo::update(['profile' => false, 'photo-type' => Photo::DEFAULT], $condition);
3697 $fields = ['photo' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext,
3698 'thumb' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext];
3699 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
3702 Contact::updateSelfFromUserID(api_user(), true);
3704 // Update global directory in background
3705 Profile::publishUpdate(api_user());
3707 // output for client
3709 return api_account_verify_credentials($type);
3711 // SaveMediaToDatabase failed for some reason
3712 throw new InternalServerErrorException("image upload failed");
3716 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
3717 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
3718 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
3719 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
3720 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
3721 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
3724 * Update user profile
3726 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3728 * @return array|string
3729 * @throws BadRequestException
3730 * @throws ForbiddenException
3731 * @throws ImagickException
3732 * @throws InternalServerErrorException
3733 * @throws UnauthorizedException
3735 function api_account_update_profile($type)
3737 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
3739 $local_user = api_user();
3741 $api_user = DI::twitterUser()->createFromUserId(api_user())->toArray();
3743 if (!empty($_POST['name'])) {
3744 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
3745 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
3746 Contact::update(['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
3747 Contact::update(['name' => $_POST['name']], ['id' => $api_user['id']]);
3750 if (isset($_POST['description'])) {
3751 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
3752 Contact::update(['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
3753 Contact::update(['about' => $_POST['description']], ['id' => $api_user['id']]);
3756 Profile::publishUpdate($local_user);
3758 return api_account_verify_credentials($type);
3761 /// @TODO move to top of file or somewhere better
3762 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
3766 * @param string $acl_string
3770 function check_acl_input($acl_string)
3772 if (empty($acl_string)) {
3776 $contact_not_found = false;
3778 // split <x><y><z> into array of cid's
3779 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
3781 // check for each cid if it is available on server
3782 $cid_array = $array[0];
3783 foreach ($cid_array as $cid) {
3784 $cid = str_replace("<", "", $cid);
3785 $cid = str_replace(">", "", $cid);
3786 $condition = ['id' => $cid, 'uid' => api_user()];
3787 $contact_not_found |= !DBA::exists('contact', $condition);
3789 return $contact_not_found;
3793 * @param string $mediatype
3794 * @param array $media
3795 * @param string $type
3796 * @param string $album
3797 * @param string $allow_cid
3798 * @param string $deny_cid
3799 * @param string $allow_gid
3800 * @param string $deny_gid
3801 * @param string $desc
3802 * @param integer $phototype
3803 * @param boolean $visibility
3804 * @param string $photo_id
3806 * @throws BadRequestException
3807 * @throws ForbiddenException
3808 * @throws ImagickException
3809 * @throws InternalServerErrorException
3810 * @throws NotFoundException
3811 * @throws UnauthorizedException
3813 function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, $phototype = 0, $visibility = false, $photo_id = null)
3821 if (is_array($media)) {
3822 if (is_array($media['tmp_name'])) {
3823 $src = $media['tmp_name'][0];
3825 $src = $media['tmp_name'];
3827 if (is_array($media['name'])) {
3828 $filename = basename($media['name'][0]);
3830 $filename = basename($media['name']);
3832 if (is_array($media['size'])) {
3833 $filesize = intval($media['size'][0]);
3835 $filesize = intval($media['size']);
3837 if (is_array($media['type'])) {
3838 $filetype = $media['type'][0];
3840 $filetype = $media['type'];
3844 $filetype = Images::getMimeTypeBySource($src, $filename, $filetype);
3847 "File upload src: " . $src . " - filename: " . $filename .
3848 " - size: " . $filesize . " - type: " . $filetype);
3850 // check if there was a php upload error
3851 if ($filesize == 0 && $media['error'] == 1) {
3852 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
3854 // check against max upload size within Friendica instance
3855 $maximagesize = DI::config()->get('system', 'maximagesize');
3856 if ($maximagesize && ($filesize > $maximagesize)) {
3857 $formattedBytes = Strings::formatBytes($maximagesize);
3858 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
3861 // create Photo instance with the data of the image
3862 $imagedata = @file_get_contents($src);
3863 $Image = new Image($imagedata, $filetype);
3864 if (!$Image->isValid()) {
3865 throw new InternalServerErrorException("unable to process image data");
3868 // check orientation of image
3869 $Image->orient($src);
3872 // check max length of images on server
3873 $max_length = DI::config()->get('system', 'max_image_length');
3874 if ($max_length > 0) {
3875 $Image->scaleDown($max_length);
3876 logger::info("File upload: Scaling picture to new size " . $max_length);
3878 $width = $Image->getWidth();
3879 $height = $Image->getHeight();
3881 // create a new resource-id if not already provided
3882 $resource_id = ($photo_id == null) ? Photo::newResource() : $photo_id;
3884 if ($mediatype == "photo") {
3885 // upload normal image (scales 0, 1, 2)
3886 logger::info("photo upload: starting new photo upload");
3888 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 0, Photo::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
3890 logger::notice("photo upload: image upload with scale 0 (original size) failed");
3892 if ($width > 640 || $height > 640) {
3893 $Image->scaleDown(640);
3894 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 1, Photo::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
3896 logger::notice("photo upload: image upload with scale 1 (640x640) failed");
3900 if ($width > 320 || $height > 320) {
3901 $Image->scaleDown(320);
3902 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 2, Photo::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
3904 logger::notice("photo upload: image upload with scale 2 (320x320) failed");
3907 logger::info("photo upload: new photo upload ended");
3908 } elseif ($mediatype == "profileimage") {
3909 // upload profile image (scales 4, 5, 6)
3910 logger::info("photo upload: starting new profile image upload");
3912 if ($width > 300 || $height > 300) {
3913 $Image->scaleDown(300);
3914 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 4, $phototype, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
3916 logger::notice("photo upload: profile image upload with scale 4 (300x300) failed");
3920 if ($width > 80 || $height > 80) {
3921 $Image->scaleDown(80);
3922 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 5, $phototype, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
3924 logger::notice("photo upload: profile image upload with scale 5 (80x80) failed");
3928 if ($width > 48 || $height > 48) {
3929 $Image->scaleDown(48);
3930 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 6, $phototype, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
3932 logger::notice("photo upload: profile image upload with scale 6 (48x48) failed");
3935 $Image->__destruct();
3936 logger::info("photo upload: new profile image upload ended");
3940 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
3941 if ($photo_id == null && $mediatype == "photo") {
3942 post_photo_item($resource_id, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
3944 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
3945 return prepare_photo_data($type, false, $resource_id);
3947 throw new InternalServerErrorException("image upload failed");
3953 * @param string $hash
3954 * @param string $allow_cid
3955 * @param string $deny_cid
3956 * @param string $allow_gid
3957 * @param string $deny_gid
3958 * @param string $filetype
3959 * @param boolean $visibility
3960 * @throws InternalServerErrorException
3962 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
3964 // get data about the api authenticated user
3965 $uri = Item::newURI(intval(api_user()));
3966 $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
3969 $arr['guid'] = System::createUUID();
3970 $arr['uid'] = intval(api_user());
3972 $arr['type'] = 'photo';
3974 $arr['resource-id'] = $hash;
3975 $arr['contact-id'] = $owner_record['id'];
3976 $arr['owner-name'] = $owner_record['name'];
3977 $arr['owner-link'] = $owner_record['url'];
3978 $arr['owner-avatar'] = $owner_record['thumb'];
3979 $arr['author-name'] = $owner_record['name'];
3980 $arr['author-link'] = $owner_record['url'];
3981 $arr['author-avatar'] = $owner_record['thumb'];
3983 $arr['allow_cid'] = $allow_cid;
3984 $arr['allow_gid'] = $allow_gid;
3985 $arr['deny_cid'] = $deny_cid;
3986 $arr['deny_gid'] = $deny_gid;
3987 $arr['visible'] = $visibility;
3991 'image/jpeg' => 'jpg',
3992 'image/png' => 'png',
3993 'image/gif' => 'gif'
3996 // adds link to the thumbnail scale photo
3997 $arr['body'] = '[url=' . DI::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
3998 . '[img]' . DI::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4001 // do the magic for storing the item in the database and trigger the federation to other contacts
4007 * @param string $type
4009 * @param string $photo_id
4012 * @throws BadRequestException
4013 * @throws ForbiddenException
4014 * @throws ImagickException
4015 * @throws InternalServerErrorException
4016 * @throws NotFoundException
4017 * @throws UnauthorizedException
4019 function prepare_photo_data($type, $scale, $photo_id)
4021 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
4023 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4025 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4026 $data_sql = ($scale === false ? "" : "data, ");
4028 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4029 // clients needs to convert this in their way for further processing
4030 $r = DBA::toArray(DBA::p(
4031 "SELECT $data_sql `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4032 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4033 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4034 FROM `photo` WHERE `uid` = ? AND `resource-id` = ? $scale_sql GROUP BY
4035 `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4036 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`",
4042 'image/jpeg' => 'jpg',
4043 'image/png' => 'png',
4044 'image/gif' => 'gif'
4047 // prepare output data for photo
4048 if (DBA::isResult($r)) {
4049 $data = ['photo' => $r[0]];
4050 $data['photo']['id'] = $data['photo']['resource-id'];
4051 if ($scale !== false) {
4052 $data['photo']['data'] = base64_encode($data['photo']['data']);
4054 unset($data['photo']['datasize']); //needed only with scale param
4056 if ($type == "xml") {
4057 $data['photo']['links'] = [];
4058 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4059 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4061 "href" => DI::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4064 $data['photo']['link'] = [];
4065 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4067 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4068 $data['photo']['link'][$i] = DI::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4072 unset($data['photo']['resource-id']);
4073 unset($data['photo']['minscale']);
4074 unset($data['photo']['maxscale']);
4076 throw new NotFoundException();
4079 // retrieve item element for getting activities (like, dislike etc.) related to photo
4080 $condition = ['uid' => api_user(), 'resource-id' => $photo_id];
4081 $item = Post::selectFirst(['id', 'uid', 'uri', 'parent', 'allow_cid', 'deny_cid', 'allow_gid', 'deny_gid'], $condition);
4082 if (!DBA::isResult($item)) {
4083 throw new NotFoundException('Photo-related item not found.');
4086 $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4088 // retrieve comments on photo
4089 $condition = ["`parent` = ? AND `uid` = ? AND `gravity` IN (?, ?)",
4090 $item['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4092 $statuses = Post::selectForUser(api_user(), [], $condition);
4094 // prepare output of comments
4095 $commentData = api_format_items(Post::toArray($statuses), $user_info, false, $type);
4097 if ($type == "xml") {
4099 foreach ($commentData as $comment) {
4100 $comments[$k++ . ":comment"] = $comment;
4103 foreach ($commentData as $comment) {
4104 $comments[] = $comment;
4107 $data['photo']['friendica_comments'] = $comments;
4109 // include info if rights on photo and rights on item are mismatching
4110 $rights_mismatch = $data['photo']['allow_cid'] != $item['allow_cid'] ||
4111 $data['photo']['deny_cid'] != $item['deny_cid'] ||
4112 $data['photo']['allow_gid'] != $item['allow_gid'] ||
4113 $data['photo']['deny_gid'] != $item['deny_gid'];
4114 $data['photo']['rights_mismatch'] = $rights_mismatch;
4120 * Return an item with announcer data if it had been announced
4122 * @param array $item Item array
4123 * @return array Item array with announce data
4125 function api_get_announce($item)
4127 // Quit if the item already has got a different owner and author
4128 if ($item['owner-id'] != $item['author-id']) {
4132 // Don't change original or Diaspora posts
4133 if ($item['origin'] || in_array($item['network'], [Protocol::DIASPORA])) {
4137 // Quit if we do now the original author and it had been a post from a native network
4138 if (!empty($item['contact-uid']) && in_array($item['network'], Protocol::NATIVE_SUPPORT)) {
4142 $fields = ['author-id', 'author-name', 'author-link', 'author-avatar'];
4143 $condition = ['parent-uri' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY, 'uid' => [0, $item['uid']], 'vid' => Verb::getID(Activity::ANNOUNCE)];
4144 $announce = Post::selectFirstForUser($item['uid'], $fields, $condition, ['order' => ['received' => true]]);
4145 if (!DBA::isResult($announce)) {
4149 return array_merge($item, $announce);
4154 * @param array $item
4159 function api_in_reply_to($item)
4163 $in_reply_to['status_id'] = null;
4164 $in_reply_to['user_id'] = null;
4165 $in_reply_to['status_id_str'] = null;
4166 $in_reply_to['user_id_str'] = null;
4167 $in_reply_to['screen_name'] = null;
4169 if (($item['thr-parent'] != $item['uri']) && ($item['gravity'] != GRAVITY_PARENT)) {
4170 $parent = Post::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
4171 if (DBA::isResult($parent)) {
4172 $in_reply_to['status_id'] = intval($parent['id']);
4174 $in_reply_to['status_id'] = intval($item['parent']);
4177 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
4179 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
4180 $parent = Post::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
4182 if (DBA::isResult($parent)) {
4183 $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
4184 $in_reply_to['user_id'] = intval($parent['author-id']);
4185 $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
4188 // There seems to be situation, where both fields are identical:
4189 // https://github.com/friendica/friendica/issues/1010
4190 // This is a bugfix for that.
4191 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
4192 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']]);
4193 $in_reply_to['status_id'] = null;
4194 $in_reply_to['user_id'] = null;
4195 $in_reply_to['status_id_str'] = null;
4196 $in_reply_to['user_id_str'] = null;
4197 $in_reply_to['screen_name'] = null;
4201 return $in_reply_to;
4206 * @param string $text
4209 * @throws InternalServerErrorException
4211 function api_clean_plain_items($text)
4213 $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
4215 $text = BBCode::cleanPictureLinks($text);
4216 $URLSearchString = "^\[\]";
4218 $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
4220 if ($include_entities == "true") {
4221 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
4224 // Simplify "attachment" element
4225 $text = BBCode::removeAttachment($text);
4232 * @param array $contacts
4236 function api_best_nickname(&$contacts)
4240 if (count($contacts) == 0) {
4244 foreach ($contacts as $contact) {
4245 if ($contact["network"] == "") {
4246 $contact["network"] = "dfrn";
4247 $best_contact = [$contact];
4251 if (sizeof($best_contact) == 0) {
4252 foreach ($contacts as $contact) {
4253 if ($contact["network"] == "dfrn") {
4254 $best_contact = [$contact];
4259 if (sizeof($best_contact) == 0) {
4260 foreach ($contacts as $contact) {
4261 if ($contact["network"] == "dspr") {
4262 $best_contact = [$contact];
4267 if (sizeof($best_contact) == 0) {
4268 foreach ($contacts as $contact) {
4269 if ($contact["network"] == "stat") {
4270 $best_contact = [$contact];
4275 if (sizeof($best_contact) == 0) {
4276 foreach ($contacts as $contact) {
4277 if ($contact["network"] == "pump") {
4278 $best_contact = [$contact];
4283 if (sizeof($best_contact) == 0) {
4284 foreach ($contacts as $contact) {
4285 if ($contact["network"] == "twit") {
4286 $best_contact = [$contact];
4291 if (sizeof($best_contact) == 1) {
4292 $contacts = $best_contact;
4294 $contacts = [$contacts[0]];
4299 * Return all or a specified group of the user with the containing contacts.
4301 * @param string $type Return type (atom, rss, xml, json)
4303 * @return array|string
4304 * @throws BadRequestException
4305 * @throws ForbiddenException
4306 * @throws ImagickException
4307 * @throws InternalServerErrorException
4308 * @throws UnauthorizedException
4310 function api_friendica_group_show($type)
4312 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
4315 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4316 $gid = $_REQUEST['gid'] ?? 0;
4317 $uid = $user_info['uid'];
4319 // get data of the specified group id or all groups if not specified
4321 $groups = DBA::selectToArray('group', [], ['deleted' => false, 'uid' => $uid, 'id' => $gid]);
4323 // error message if specified gid is not in database
4324 if (!DBA::isResult($groups)) {
4325 throw new BadRequestException("gid not available");
4328 $groups = DBA::selectToArray('group', [], ['deleted' => false, 'uid' => $uid]);
4331 // loop through all groups and retrieve all members for adding data in the user array
4333 foreach ($groups as $rr) {
4334 $members = Contact\Group::getById($rr['id']);
4337 if ($type == "xml") {
4338 $user_element = "users";
4340 foreach ($members as $member) {
4341 $user = DI::twitterUser()->createFromContactId($member['contact-id'], api_user())->toArray();
4342 $users[$k++.":user"] = $user;
4345 $user_element = "user";
4346 foreach ($members as $member) {
4347 $user = DI::twitterUser()->createFromContactId($member['contact-id'], api_user())->toArray();
4351 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
4353 return DI::apiResponse()->formatData("groups", $type, ['group' => $grps]);
4356 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
4361 * @param string $type Return type (atom, rss, xml, json)
4363 * @return array|string
4364 * @throws BadRequestException
4365 * @throws ForbiddenException
4366 * @throws ImagickException
4367 * @throws InternalServerErrorException
4368 * @throws UnauthorizedException
4369 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
4371 function api_lists_destroy($type)
4373 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
4376 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4377 $gid = $_REQUEST['list_id'] ?? 0;
4378 $uid = $user_info['uid'];
4380 // error if no gid specified
4382 throw new BadRequestException('gid not specified');
4385 // get data of the specified group id
4386 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
4387 // error message if specified gid is not in database
4389 throw new BadRequestException('gid not available');
4392 if (Group::remove($gid)) {
4394 'name' => $group['name'],
4395 'id' => intval($gid),
4396 'id_str' => (string) $gid,
4397 'user' => $user_info
4400 return DI::apiResponse()->formatData("lists", $type, ['lists' => $list]);
4404 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
4407 * Add a new group to the database.
4409 * @param string $name Group name
4410 * @param int $uid User ID
4411 * @param array $users List of users to add to the group
4414 * @throws BadRequestException
4416 function group_create($name, $uid, $users = [])
4418 // error if no name specified
4420 throw new BadRequestException('group name not specified');
4423 // error message if specified group name already exists
4424 if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => false])) {
4425 throw new BadRequestException('group name already exists');
4428 // Check if the group needs to be reactivated
4429 if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => true])) {
4430 $reactivate_group = true;
4434 $ret = Group::create($uid, $name);
4436 $gid = Group::getIdByName($uid, $name);
4438 throw new BadRequestException('other API error');
4442 $erroraddinguser = false;
4444 foreach ($users as $user) {
4445 $cid = $user['cid'];
4446 if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) {
4447 Group::addMember($gid, $cid);
4449 $erroraddinguser = true;
4450 $errorusers[] = $cid;
4454 // return success message incl. missing users in array
4455 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
4457 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
4461 * Create the specified group with the posted array of contacts.
4463 * @param string $type Return type (atom, rss, xml, json)
4465 * @return array|string
4466 * @throws BadRequestException
4467 * @throws ForbiddenException
4468 * @throws ImagickException
4469 * @throws InternalServerErrorException
4470 * @throws UnauthorizedException
4472 function api_friendica_group_create($type)
4474 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
4477 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4478 $name = $_REQUEST['name'] ?? '';
4479 $uid = $user_info['uid'];
4480 $json = json_decode($_POST['json'], true);
4481 $users = $json['user'];
4483 $success = group_create($name, $uid, $users);
4485 return DI::apiResponse()->formatData("group_create", $type, ['result' => $success]);
4488 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
4491 * Create a new group.
4493 * @param string $type Return type (atom, rss, xml, json)
4495 * @return array|string
4496 * @throws BadRequestException
4497 * @throws ForbiddenException
4498 * @throws ImagickException
4499 * @throws InternalServerErrorException
4500 * @throws UnauthorizedException
4501 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
4503 function api_lists_create($type)
4505 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
4508 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4509 $name = $_REQUEST['name'] ?? '';
4510 $uid = $user_info['uid'];
4512 $success = group_create($name, $uid);
4513 if ($success['success']) {
4515 'name' => $success['name'],
4516 'id' => intval($success['gid']),
4517 'id_str' => (string) $success['gid'],
4518 'user' => $user_info
4521 return DI::apiResponse()->formatData("lists", $type, ['lists' => $grp]);
4525 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
4528 * Update the specified group with the posted array of contacts.
4530 * @param string $type Return type (atom, rss, xml, json)
4532 * @return array|string
4533 * @throws BadRequestException
4534 * @throws ForbiddenException
4535 * @throws ImagickException
4536 * @throws InternalServerErrorException
4537 * @throws UnauthorizedException
4539 function api_friendica_group_update($type)
4541 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
4544 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4545 $uid = $user_info['uid'];
4546 $gid = $_REQUEST['gid'] ?? 0;
4547 $name = $_REQUEST['name'] ?? '';
4548 $json = json_decode($_POST['json'], true);
4549 $users = $json['user'];
4551 // error if no name specified
4553 throw new BadRequestException('group name not specified');
4556 // error if no gid specified
4558 throw new BadRequestException('gid not specified');
4562 $members = Contact\Group::getById($gid);
4563 foreach ($members as $member) {
4564 $cid = $member['id'];
4565 foreach ($users as $user) {
4566 $found = ($user['cid'] == $cid ? true : false);
4568 if (!isset($found) || !$found) {
4569 $gid = Group::getIdByName($uid, $name);
4570 Group::removeMember($gid, $cid);
4575 $erroraddinguser = false;
4577 foreach ($users as $user) {
4578 $cid = $user['cid'];
4580 if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) {
4581 Group::addMember($gid, $cid);
4583 $erroraddinguser = true;
4584 $errorusers[] = $cid;
4588 // return success message incl. missing users in array
4589 $status = ($erroraddinguser ? "missing user" : "ok");
4590 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
4591 return DI::apiResponse()->formatData("group_update", $type, ['result' => $success]);
4594 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
4597 * Update information about a group.
4599 * @param string $type Return type (atom, rss, xml, json)
4601 * @return array|string
4602 * @throws BadRequestException
4603 * @throws ForbiddenException
4604 * @throws ImagickException
4605 * @throws InternalServerErrorException
4606 * @throws UnauthorizedException
4607 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
4609 function api_lists_update($type)
4611 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
4614 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4615 $gid = $_REQUEST['list_id'] ?? 0;
4616 $name = $_REQUEST['name'] ?? '';
4617 $uid = $user_info['uid'];
4619 // error if no gid specified
4621 throw new BadRequestException('gid not specified');
4624 // get data of the specified group id
4625 $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
4626 // error message if specified gid is not in database
4628 throw new BadRequestException('gid not available');
4631 if (Group::update($gid, $name)) {
4634 'id' => intval($gid),
4635 'id_str' => (string) $gid,
4636 'user' => $user_info
4639 return DI::apiResponse()->formatData("lists", $type, ['lists' => $list]);
4643 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
4646 * Set notification as seen and returns associated item (if possible)
4648 * POST request with 'id' param as notification id
4650 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4651 * @return string|array
4652 * @throws BadRequestException
4653 * @throws ForbiddenException
4654 * @throws ImagickException
4655 * @throws InternalServerErrorException
4656 * @throws UnauthorizedException
4658 function api_friendica_notification_seen($type)
4660 BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
4662 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4664 if (DI::args()->getArgc() !== 4) {
4665 throw new BadRequestException('Invalid argument count');
4668 $id = intval($_REQUEST['id'] ?? 0);
4671 $Notify = DI::notify()->selectOneById($id);
4672 if ($Notify->uid !== api_user()) {
4673 throw new NotFoundException();
4676 if ($Notify->uriId) {
4677 DI::notification()->setAllSeenForUser($Notify->uid, ['target-uri-id' => $Notify->uriId]);
4681 DI::notify()->save($Notify);
4683 if ($Notify->otype === Notification\ObjectType::ITEM) {
4684 $item = Post::selectFirstForUser(api_user(), [], ['id' => $Notify->iid, 'uid' => api_user()]);
4685 if (DBA::isResult($item)) {
4686 // we found the item, return it to the user
4687 $ret = api_format_items([$item], $user_info, false, $type);
4688 $data = ['status' => $ret];
4689 return DI::apiResponse()->formatData('status', $type, $data);
4691 // the item can't be found, but we set the notification as seen, so we count this as a success
4694 return DI::apiResponse()->formatData('result', $type, ['result' => 'success']);
4695 } catch (NotFoundException $e) {
4696 throw new BadRequestException('Invalid argument', $e);
4697 } catch (Exception $e) {
4698 throw new InternalServerErrorException('Internal Server exception', $e);
4702 /// @TODO move to top of file or somewhere better
4703 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
4706 * search for direct_messages containing a searchstring through api
4708 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4709 * @param string $box
4710 * @return string|array (success: success=true if found and search_result contains found messages,
4711 * success=false if nothing was found, search_result='nothing found',
4712 * error: result=error with error message)
4713 * @throws BadRequestException
4714 * @throws ForbiddenException
4715 * @throws ImagickException
4716 * @throws InternalServerErrorException
4717 * @throws UnauthorizedException
4719 function api_friendica_direct_messages_search($type, $box = "")
4721 BaseApi::checkAllowedScope(BaseApi::SCOPE_READ);
4724 $user_info = DI::twitterUser()->createFromUserId(api_user())->toArray();
4725 $searchstring = $_REQUEST['searchstring'] ?? '';
4726 $uid = $user_info['uid'];
4728 // error if no searchstring specified
4729 if ($searchstring == "") {
4730 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
4731 return DI::apiResponse()->formatData("direct_messages_search", $type, ['$result' => $answer]);
4734 // get data for the specified searchstring
4735 $r = DBA::toArray(DBA::p(
4736 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid` = ? AND `body` LIKE ? ORDER BY `mail`.`id` DESC",
4738 '%'.$searchstring.'%'
4741 $profile_url = $user_info["url"];
4743 // message if nothing was found
4744 if (!DBA::isResult($r)) {
4745 $success = ['success' => false, 'search_results' => 'problem with query'];
4746 } elseif (count($r) == 0) {
4747 $success = ['success' => false, 'search_results' => 'nothing found'];
4750 foreach ($r as $item) {
4751 if ($box == "inbox" || $item['from-url'] != $profile_url) {
4752 $recipient = $user_info;
4753 $sender = DI::twitterUser()->createFromContactId($item['contact-id'], api_user())->toArray();
4754 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
4755 $recipient = DI::twitterUser()->createFromContactId($item['contact-id'], api_user())->toArray();
4756 $sender = $user_info;
4759 if (isset($recipient) && isset($sender)) {
4760 $ret[] = api_format_messages($item, $recipient, $sender);
4763 $success = ['success' => true, 'search_results' => $ret];
4766 return DI::apiResponse()->formatData("direct_message_search", $type, ['$result' => $success]);
4769 /// @TODO move to top of file or somewhere better
4770 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
4773 * Number of comments
4775 * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
4777 * @param object $data [Status, Status]
4781 function bindComments(&$data)
4783 if (count($data) == 0) {
4789 foreach ($data as $item) {
4790 $ids[] = $item['id'];
4793 $idStr = DBA::escape(implode(', ', $ids));
4794 $sql = "SELECT `parent`, COUNT(*) as comments FROM `post-user-view` WHERE `parent` IN ($idStr) AND `deleted` = ? AND `gravity`= ? GROUP BY `parent`";
4795 $items = DBA::p($sql, 0, GRAVITY_COMMENT);
4796 $itemsData = DBA::toArray($items);
4798 foreach ($itemsData as $item) {
4799 $comments[$item['parent']] = $item['comments'];
4802 foreach ($data as $idx => $item) {
4804 $data[$idx]['friendica_comments'] = isset($comments[$id]) ? $comments[$id] : 0;
4809 @TODO Maybe open to implement?
4811 [pagename] => api/1.1/statuses/lookup.json
4812 [id] => 605138389168451584
4813 [include_cards] => true
4814 [cards_platform] => Android-12
4815 [include_entities] => true
4816 [include_my_retweet] => 1
4818 [include_reply_count] => true
4819 [include_descendent_reply_count] => true
4823 Not implemented by now:
4824 statuses/retweets_of_me
4829 account/update_location
4830 account/update_profile_background_image
4833 friendica/profile/update
4834 friendica/profile/create
4835 friendica/profile/delete
4837 Not implemented in status.net:
4838 statuses/retweeted_to_me
4839 statuses/retweeted_by_me
4840 direct_messages/destroy
4842 account/update_delivery_device
4843 notifications/follow