include/api.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  * Friendica implementation of statusnet/twitter API
  21  *
  22  * @file include/api.php
  23  * @todo Automatically detect if incoming data is HTML or BBCode
  24  */
  25
  26 use Friendica\App;
  27 use Friendica\Content\ContactSelector;
  28 use Friendica\Content\Text\BBCode;
  29 use Friendica\Content\Text\HTML;
  30 use Friendica\Core\Hook;
  31 use Friendica\Core\Logger;
  32 use Friendica\Core\Protocol;
  33 use Friendica\Core\Session;
  34 use Friendica\Core\System;
  35 use Friendica\Core\Worker;
  36 use Friendica\Database\DBA;
  37 use Friendica\DI;
  38 use Friendica\Model\Contact;
  39 use Friendica\Model\Group;
  40 use Friendica\Model\Item;
  41 use Friendica\Model\Mail;
  42 use Friendica\Model\Notify;
  43 use Friendica\Model\Photo;
  44 use Friendica\Model\Post;
  45 use Friendica\Model\User;
  46 use Friendica\Model\UserItem;
  47 use Friendica\Model\Verb;
  48 use Friendica\Security\FKOAuth1;
  49 use Friendica\Network\HTTPException;
  50 use Friendica\Network\HTTPException\BadRequestException;
  51 use Friendica\Network\HTTPException\ExpectationFailedException;
  52 use Friendica\Network\HTTPException\ForbiddenException;
  53 use Friendica\Network\HTTPException\InternalServerErrorException;
  54 use Friendica\Network\HTTPException\MethodNotAllowedException;
  55 use Friendica\Network\HTTPException\NotFoundException;
  56 use Friendica\Network\HTTPException\NotImplementedException;
  57 use Friendica\Network\HTTPException\TooManyRequestsException;
  58 use Friendica\Network\HTTPException\UnauthorizedException;
  59 use Friendica\Object\Image;
  60 use Friendica\Protocol\Activity;
  61 use Friendica\Protocol\Diaspora;
  62 use Friendica\Security\OAuth1\OAuthRequest;
  63 use Friendica\Security\OAuth1\OAuthUtil;
  64 use Friendica\Util\DateTimeFormat;
  65 use Friendica\Util\Images;
  66 use Friendica\Util\Network;
  67 use Friendica\Util\Proxy as ProxyUtils;
  68 use Friendica\Util\Strings;
  69 use Friendica\Util\XML;
  70
  71 require_once __DIR__ . '/../mod/item.php';
  72 require_once __DIR__ . '/../mod/wall_upload.php';
  73
  74 define('API_METHOD_ANY', '*');
  75 define('API_METHOD_GET', 'GET');
  76 define('API_METHOD_POST', 'POST,PUT');
  77 define('API_METHOD_DELETE', 'POST,DELETE');
  78
  79 define('API_LOG_PREFIX', 'API {action} - ');
  80
  81 $API = [];
  82 $called_api = [];
  83
  84 /**
  85  * Auth API user
  86  *
  87  * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
  88  * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
  89  * into a page, and visitors will post something without noticing it).
  90  */
  91 function api_user()
  92 {
  93         if (!empty($_SESSION['allow_api'])) {
  94                 return local_user();
  95         }
  96
  97         return false;
  98 }
  99
 100 /**
 101  * Get source name from API client
 102  *
 103  * Clients can send 'source' parameter to be show in post metadata
 104  * as "sent via <source>".
 105  * Some clients doesn't send a source param, we support ones we know
 106  * (only Twidere, atm)
 107  *
 108  * @return string
 109  *        Client source name, default to "api" if unset/unknown
 110  * @throws Exception
 111  */
 112 function api_source()
 113 {
 114         if (requestdata('source')) {
 115                 return requestdata('source');
 116         }
 117
 118         // Support for known clients that doesn't send a source name
 119         if (!empty($_SERVER['HTTP_USER_AGENT'])) {
 120                 if(strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
 121                         return "Twidere";
 122                 }
 123
 124                 Logger::info(API_LOG_PREFIX . 'Unrecognized user-agent', ['module' => 'api', 'action' => 'source', 'http_user_agent' => $_SERVER['HTTP_USER_AGENT']]);
 125         } else {
 126                 Logger::info(API_LOG_PREFIX . 'Empty user-agent', ['module' => 'api', 'action' => 'source']);
 127         }
 128
 129         return "api";
 130 }
 131
 132 /**
 133  * Format date for API
 134  *
 135  * @param string $str Source date, as UTC
 136  * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
 137  * @throws Exception
 138  */
 139 function api_date($str)
 140 {
 141         // Wed May 23 06:01:13 +0000 2007
 142         return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
 143 }
 144
 145 /**
 146  * Register a function to be the endpoint for defined API path.
 147  *
 148  * @param string $path   API URL path, relative to DI::baseUrl()
 149  * @param string $func   Function name to call on path request
 150  * @param bool   $auth   API need logged user
 151  * @param string $method HTTP method reqiured to call this endpoint.
 152  *                       One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
 153  *                       Default to API_METHOD_ANY
 154  */
 155 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
 156 {
 157         global $API;
 158
 159         $API[$path] = [
 160                 'func'   => $func,
 161                 'auth'   => $auth,
 162                 'method' => $method,
 163         ];
 164
 165         // Workaround for hotot
 166         $path = str_replace("api/", "api/1.1/", $path);
 167
 168         $API[$path] = [
 169                 'func'   => $func,
 170                 'auth'   => $auth,
 171                 'method' => $method,
 172         ];
 173 }
 174
 175 /**
 176  * Log in user via OAuth1 or Simple HTTP Auth.
 177  * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
 178  *
 179  * @param App $a App
 180  * @throws ForbiddenException
 181  * @throws InternalServerErrorException
 182  * @throws UnauthorizedException
 183  * @hook  'authenticate'
 184  *               array $addon_auth
 185  *               'username' => username from login form
 186  *               'password' => password from login form
 187  *               'authenticated' => return status,
 188  *               'user_record' => return authenticated user record
 189  */
 190 function api_login(App $a)
 191 {
 192         // workaround for HTTP-auth in CGI mode
 193         if (!empty($_SERVER['REDIRECT_REMOTE_USER'])) {
 194                 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6));
 195                 if (strlen($userpass)) {
 196                         list($name, $password) = explode(':', $userpass);
 197                         $_SERVER['PHP_AUTH_USER'] = $name;
 198                         $_SERVER['PHP_AUTH_PW'] = $password;
 199                 }
 200         }
 201
 202         if (empty($_SERVER['PHP_AUTH_USER'])) {
 203                 // Try OAuth when no user is provided
 204                 $oauth1 = new FKOAuth1();
 205                 // login with oauth
 206                 try {
 207                         $request = OAuthRequest::from_request();
 208                         list($consumer, $token) = $oauth1->verify_request($request);
 209                         if (!is_null($token)) {
 210                                 $oauth1->loginUser($token->uid);
 211                                 Session::set('allow_api', true);
 212                                 return;
 213                         }
 214                         echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
 215                         var_dump($consumer, $token);
 216                         die();
 217                 } catch (Exception $e) {
 218                         Logger::warning(API_LOG_PREFIX . 'OAuth error', ['module' => 'api', 'action' => 'login', 'exception' => $e->getMessage()]);
 219                 }
 220
 221                 Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]);
 222                 header('WWW-Authenticate: Basic realm="Friendica"');
 223                 throw new UnauthorizedException("This API requires login");
 224         }
 225
 226         $user = $_SERVER['PHP_AUTH_USER'] ?? '';
 227         $password = $_SERVER['PHP_AUTH_PW'] ?? '';
 228
 229         // allow "user@server" login (but ignore 'server' part)
 230         $at = strstr($user, "@", true);
 231         if ($at) {
 232                 $user = $at;
 233         }
 234
 235         // next code from mod/auth.php. needs better solution
 236         $record = null;
 237
 238         $addon_auth = [
 239                 'username' => trim($user),
 240                 'password' => trim($password),
 241                 'authenticated' => 0,
 242                 'user_record' => null,
 243         ];
 244
 245         /*
 246         * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
 247         * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
 248         * and later addons should not interfere with an earlier one that succeeded.
 249         */
 250         Hook::callAll('authenticate', $addon_auth);
 251
 252         if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
 253                 $record = $addon_auth['user_record'];
 254         } else {
 255                 $user_id = User::authenticate(trim($user), trim($password), true);
 256                 if ($user_id !== false) {
 257                         $record = DBA::selectFirst('user', [], ['uid' => $user_id]);
 258                 }
 259         }
 260
 261         if (!DBA::isResult($record)) {
 262                 Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]);
 263                 header('WWW-Authenticate: Basic realm="Friendica"');
 264                 //header('HTTP/1.0 401 Unauthorized');
 265                 //die('This api requires login');
 266                 throw new UnauthorizedException("This API requires login");
 267         }
 268
 269         // Don't refresh the login date more often than twice a day to spare database writes
 270         $login_refresh = strcmp(DateTimeFormat::utc('now - 12 hours'), $record['login_date']) > 0;
 271
 272         DI::auth()->setForUser($a, $record, false, false, $login_refresh);
 273
 274         $_SESSION["allow_api"] = true;
 275
 276         Hook::callAll('logged_in', $a->user);
 277 }
 278
 279 /**
 280  * Check HTTP method of called API
 281  *
 282  * API endpoints can define which HTTP method to accept when called.
 283  * This function check the current HTTP method agains endpoint
 284  * registered method.
 285  *
 286  * @param string $method Required methods, uppercase, separated by comma
 287  * @return bool
 288  */
 289 function api_check_method($method)
 290 {
 291         if ($method == "*") {
 292                 return true;
 293         }
 294         return (stripos($method, $_SERVER['REQUEST_METHOD'] ?? 'GET') !== false);
 295 }
 296
 297 /**
 298  * Main API entry point
 299  *
 300  * Authenticate user, call registered API function, set HTTP headers
 301  *
 302  * @param App $a App
 303  * @param App\Arguments $args The app arguments (optional, will retrieved by the DI-Container in case of missing)
 304  * @return string|array API call result
 305  * @throws Exception
 306  */
 307 function api_call(App $a, App\Arguments $args = null)
 308 {
 309         global $API, $called_api;
 310
 311         if ($args == null) {
 312                 $args = DI::args();
 313         }
 314
 315         $type = "json";
 316         if (strpos($args->getCommand(), ".xml") > 0) {
 317                 $type = "xml";
 318         }
 319         if (strpos($args->getCommand(), ".json") > 0) {
 320                 $type = "json";
 321         }
 322         if (strpos($args->getCommand(), ".rss") > 0) {
 323                 $type = "rss";
 324         }
 325         if (strpos($args->getCommand(), ".atom") > 0) {
 326                 $type = "atom";
 327         }
 328
 329         try {
 330                 foreach ($API as $p => $info) {
 331                         if (strpos($args->getCommand(), $p) === 0) {
 332                                 if (!api_check_method($info['method'])) {
 333                                         throw new MethodNotAllowedException();
 334                                 }
 335
 336                                 $called_api = explode("/", $p);
 337
 338                                 if (!empty($info['auth']) && api_user() === false) {
 339                                         api_login($a);
 340                                         Logger::info(API_LOG_PREFIX . 'username {username}', ['module' => 'api', 'action' => 'call', 'username' => $a->user['username']]);
 341                                 }
 342
 343                                 Logger::debug(API_LOG_PREFIX . 'parameters', ['module' => 'api', 'action' => 'call', 'parameters' => $_REQUEST]);
 344
 345                                 $stamp =  microtime(true);
 346                                 $return = call_user_func($info['func'], $type);
 347                                 $duration = floatval(microtime(true) - $stamp);
 348
 349                                 Logger::info(API_LOG_PREFIX . 'duration {duration}', ['module' => 'api', 'action' => 'call', 'duration' => round($duration, 2)]);
 350
 351                                 DI::profiler()->saveLog(DI::logger(), API_LOG_PREFIX . 'performance');
 352
 353                                 if (false === $return) {
 354                                         /*
 355                                                 * api function returned false withour throw an
 356                                                 * exception. This should not happend, throw a 500
 357                                                 */
 358                                         throw new InternalServerErrorException();
 359                                 }
 360
 361                                 switch ($type) {
 362                                         case "xml":
 363                                                 header("Content-Type: text/xml");
 364                                                 break;
 365                                         case "json":
 366                                                 header("Content-Type: application/json");
 367                                                 if (!empty($return)) {
 368                                                         $json = json_encode(end($return));
 369                                                         if (!empty($_GET['callback'])) {
 370                                                                 $json = $_GET['callback'] . "(" . $json . ")";
 371                                                         }
 372                                                         $return = $json;
 373                                                 }
 374                                                 break;
 375                                         case "rss":
 376                                                 header("Content-Type: application/rss+xml");
 377                                                 $return  = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
 378                                                 break;
 379                                         case "atom":
 380                                                 header("Content-Type: application/atom+xml");
 381                                                 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
 382                                                 break;
 383                                 }
 384                                 return $return;
 385                         }
 386                 }
 387
 388                 Logger::warning(API_LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]);
 389                 throw new NotFoundException();
 390         } catch (HTTPException $e) {
 391                 header("HTTP/1.1 {$e->getCode()} {$e->httpdesc}");
 392                 return api_error($type, $e, $args);
 393         }
 394 }
 395
 396 /**
 397  * Format API error string
 398  *
 399  * @param string $type Return type (xml, json, rss, as)
 400  * @param object $e    HTTPException Error object
 401  * @param App\Arguments $args The App arguments
 402  * @return string|array error message formatted as $type
 403  */
 404 function api_error($type, $e, App\Arguments $args)
 405 {
 406         $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
 407         /// @TODO:  https://dev.twitter.com/overview/api/response-codes
 408
 409         $error = ["error" => $error,
 410                         "code" => $e->getCode() . " " . $e->httpdesc,
 411                         "request" => $args->getQueryString()];
 412
 413         $return = api_format_data('status', $type, ['status' => $error]);
 414
 415         switch ($type) {
 416                 case "xml":
 417                         header("Content-Type: text/xml");
 418                         break;
 419                 case "json":
 420                         header("Content-Type: application/json");
 421                         $return = json_encode($return);
 422                         break;
 423                 case "rss":
 424                         header("Content-Type: application/rss+xml");
 425                         break;
 426                 case "atom":
 427                         header("Content-Type: application/atom+xml");
 428                         break;
 429         }
 430
 431         return $return;
 432 }
 433
 434 /**
 435  * Set values for RSS template
 436  *
 437  * @param App   $a
 438  * @param array $arr       Array to be passed to template
 439  * @param array $user_info User info
 440  * @return array
 441  * @throws BadRequestException
 442  * @throws ImagickException
 443  * @throws InternalServerErrorException
 444  * @throws UnauthorizedException
 445  * @todo  find proper type-hints
 446  */
 447 function api_rss_extra(App $a, $arr, $user_info)
 448 {
 449         if (is_null($user_info)) {
 450                 $user_info = api_get_user($a);
 451         }
 452
 453         $arr['$user'] = $user_info;
 454         $arr['$rss'] = [
 455                 'alternate'    => $user_info['url'],
 456                 'self'         => DI::baseUrl() . "/" . DI::args()->getQueryString(),
 457                 'base'         => DI::baseUrl(),
 458                 'updated'      => api_date(null),
 459                 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
 460                 'language'     => $user_info['lang'],
 461                 'logo'         => DI::baseUrl() . "/images/friendica-32.png",
 462         ];
 463
 464         return $arr;
 465 }
 466
 467
 468 /**
 469  * Unique contact to contact url.
 470  *
 471  * @param int $id Contact id
 472  * @return bool|string
 473  *                Contact url or False if contact id is unknown
 474  * @throws Exception
 475  */
 476 function api_unique_id_to_nurl($id)
 477 {
 478         $r = DBA::selectFirst('contact', ['nurl'], ['id' => $id]);
 479
 480         if (DBA::isResult($r)) {
 481                 return $r["nurl"];
 482         } else {
 483                 return false;
 484         }
 485 }
 486
 487 /**
 488  * Get user info array.
 489  *
 490  * @param App        $a          App
 491  * @param int|string $contact_id Contact ID or URL
 492  * @return array|bool
 493  * @throws BadRequestException
 494  * @throws ImagickException
 495  * @throws InternalServerErrorException
 496  * @throws UnauthorizedException
 497  */
 498 function api_get_user(App $a, $contact_id = null)
 499 {
 500         global $called_api;
 501
 502         $user = null;
 503         $extra_query = "";
 504         $url = "";
 505
 506         Logger::info(API_LOG_PREFIX . 'Fetching data for user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $contact_id]);
 507
 508         // Searching for contact URL
 509         if (!is_null($contact_id) && (intval($contact_id) == 0)) {
 510                 $user = DBA::escape(Strings::normaliseLink($contact_id));
 511                 $url = $user;
 512                 $extra_query = "AND `contact`.`nurl` = '%s' ";
 513                 if (api_user() !== false) {
 514                         $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
 515                 }
 516         }
 517
 518         // Searching for contact id with uid = 0
 519         if (!is_null($contact_id) && (intval($contact_id) != 0)) {
 520                 $user = DBA::escape(api_unique_id_to_nurl(intval($contact_id)));
 521
 522                 if ($user == "") {
 523                         throw new BadRequestException("User ID ".$contact_id." not found.");
 524                 }
 525
 526                 $url = $user;
 527                 $extra_query = "AND `contact`.`nurl` = '%s' ";
 528                 if (api_user() !== false) {
 529                         $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
 530                 }
 531         }
 532
 533         if (is_null($user) && !empty($_GET['user_id'])) {
 534                 $user = DBA::escape(api_unique_id_to_nurl($_GET['user_id']));
 535
 536                 if ($user == "") {
 537                         throw new BadRequestException("User ID ".$_GET['user_id']." not found.");
 538                 }
 539
 540                 $url = $user;
 541                 $extra_query = "AND `contact`.`nurl` = '%s' ";
 542                 if (api_user() !== false) {
 543                         $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
 544                 }
 545         }
 546         if (is_null($user) && !empty($_GET['screen_name'])) {
 547                 $user = DBA::escape($_GET['screen_name']);
 548                 $extra_query = "AND `contact`.`nick` = '%s' ";
 549                 if (api_user() !== false) {
 550                         $extra_query .= "AND `contact`.`uid`=".intval(api_user());
 551                 }
 552         }
 553
 554         if (is_null($user) && !empty($_GET['profileurl'])) {
 555                 $user = DBA::escape(Strings::normaliseLink($_GET['profileurl']));
 556                 $extra_query = "AND `contact`.`nurl` = '%s' ";
 557                 if (api_user() !== false) {
 558                         $extra_query .= "AND `contact`.`uid`=".intval(api_user());
 559                 }
 560         }
 561
 562         // $called_api is the API path exploded on / and is expected to have at least 2 elements
 563         if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
 564                 $argid = count($called_api);
 565                 if (!empty($a->argv[$argid])) {
 566                         $data = explode(".", $a->argv[$argid]);
 567                         if (count($data) > 1) {
 568                                 list($user, $null) = $data;
 569                         }
 570                 }
 571                 if (is_numeric($user)) {
 572                         $user = DBA::escape(api_unique_id_to_nurl(intval($user)));
 573
 574                         if ($user != "") {
 575                                 $url = $user;
 576                                 $extra_query = "AND `contact`.`nurl` = '%s' ";
 577                                 if (api_user() !== false) {
 578                                         $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
 579                                 }
 580                         }
 581                 } else {
 582                         $user = DBA::escape($user);
 583                         $extra_query = "AND `contact`.`nick` = '%s' ";
 584                         if (api_user() !== false) {
 585                                 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
 586                         }
 587                 }
 588         }
 589
 590         Logger::info(API_LOG_PREFIX . 'getting user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user]);
 591
 592         if (!$user) {
 593                 if (api_user() === false) {
 594                         api_login($a);
 595                         return false;
 596                 } else {
 597                         $user = $_SESSION['uid'];
 598                         $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
 599                 }
 600         }
 601
 602         Logger::info(API_LOG_PREFIX . 'found user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user, 'extra_query' => $extra_query]);
 603
 604         // user info
 605         $uinfo = q(
 606                 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
 607                         WHERE 1
 608                 $extra_query",
 609                 $user
 610         );
 611
 612         // Selecting the id by priority, friendica first
 613         if (is_array($uinfo)) {
 614                 api_best_nickname($uinfo);
 615         }
 616
 617         // if the contact wasn't found, fetch it from the contacts with uid = 0
 618         if (!DBA::isResult($uinfo)) {
 619                 if ($url == "") {
 620                         throw new BadRequestException("User not found.");
 621                 }
 622
 623                 $contact = DBA::selectFirst('contact', [], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
 624
 625                 if (DBA::isResult($contact)) {
 626                         $ret = [
 627                                 'id' => $contact["id"],
 628                                 'id_str' => (string) $contact["id"],
 629                                 'name' => $contact["name"],
 630                                 'screen_name' => (($contact['nick']) ? $contact['nick'] : $contact['name']),
 631                                 'location' => ($contact["location"] != "") ? $contact["location"] : ContactSelector::networkToName($contact['network'], $contact['url'], $contact['protocol']),
 632                                 'description' => BBCode::toPlaintext($contact["about"] ?? ''),
 633                                 'profile_image_url' => $contact["micro"],
 634                                 'profile_image_url_https' => $contact["micro"],
 635                                 'profile_image_url_profile_size' => $contact["thumb"],
 636                                 'profile_image_url_large' => $contact["photo"],
 637                                 'url' => $contact["url"],
 638                                 'protected' => false,
 639                                 'followers_count' => 0,
 640                                 'friends_count' => 0,
 641                                 'listed_count' => 0,
 642                                 'created_at' => api_date($contact["created"]),
 643                                 'favourites_count' => 0,
 644                                 'utc_offset' => 0,
 645                                 'time_zone' => 'UTC',
 646                                 'geo_enabled' => false,
 647                                 'verified' => false,
 648                                 'statuses_count' => 0,
 649                                 'lang' => '',
 650                                 'contributors_enabled' => false,
 651                                 'is_translator' => false,
 652                                 'is_translation_enabled' => false,
 653                                 'following' => false,
 654                                 'follow_request_sent' => false,
 655                                 'statusnet_blocking' => false,
 656                                 'notifications' => false,
 657                                 'statusnet_profile_url' => $contact["url"],
 658                                 'uid' => 0,
 659                                 'cid' => Contact::getIdForURL($contact["url"], api_user(), false),
 660                                 'pid' => Contact::getIdForURL($contact["url"], 0, false),
 661                                 'self' => 0,
 662                                 'network' => $contact["network"],
 663                         ];
 664
 665                         return $ret;
 666                 } else {
 667                         throw new BadRequestException("User ".$url." not found.");
 668                 }
 669         }
 670
 671         if ($uinfo[0]['self']) {
 672                 if ($uinfo[0]['network'] == "") {
 673                         $uinfo[0]['network'] = Protocol::DFRN;
 674                 }
 675
 676                 $usr = DBA::selectFirst('user', ['default-location'], ['uid' => api_user()]);
 677                 $profile = DBA::selectFirst('profile', ['about'], ['uid' => api_user(), 'is-default' => true]);
 678         }
 679         $countitems = 0;
 680         $countfriends = 0;
 681         $countfollowers = 0;
 682         $starred = 0;
 683
 684         $pcontact_id  = Contact::getIdForURL($uinfo[0]['url'], 0, false);
 685
 686         if (!empty($profile['about'])) {
 687                 $description = $profile['about'];
 688         } else {
 689                 $description = $uinfo[0]["about"];
 690         }
 691
 692         if (!empty($usr['default-location'])) {
 693                 $location = $usr['default-location'];
 694         } elseif (!empty($uinfo[0]["location"])) {
 695                 $location = $uinfo[0]["location"];
 696         } else {
 697                 $location = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url'], $uinfo[0]['protocol']);
 698         }
 699
 700         $ret = [
 701                 'id' => intval($pcontact_id),
 702                 'id_str' => (string) intval($pcontact_id),
 703                 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
 704                 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
 705                 'location' => $location,
 706                 'description' => BBCode::toPlaintext($description ?? ''),
 707                 'profile_image_url' => $uinfo[0]['micro'],
 708                 'profile_image_url_https' => $uinfo[0]['micro'],
 709                 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
 710                 'profile_image_url_large' => $uinfo[0]["photo"],
 711                 'url' => $uinfo[0]['url'],
 712                 'protected' => false,
 713                 'followers_count' => intval($countfollowers),
 714                 'friends_count' => intval($countfriends),
 715                 'listed_count' => 0,
 716                 'created_at' => api_date($uinfo[0]['created']),
 717                 'favourites_count' => intval($starred),
 718                 'utc_offset' => "0",
 719                 'time_zone' => 'UTC',
 720                 'geo_enabled' => false,
 721                 'verified' => true,
 722                 'statuses_count' => intval($countitems),
 723                 'lang' => '',
 724                 'contributors_enabled' => false,
 725                 'is_translator' => false,
 726                 'is_translation_enabled' => false,
 727                 'following' => (($uinfo[0]['rel'] == Contact::FOLLOWER) || ($uinfo[0]['rel'] == Contact::FRIEND)),
 728                 'follow_request_sent' => false,
 729                 'statusnet_blocking' => false,
 730                 'notifications' => false,
 731                 /// @TODO old way?
 732                 //'statusnet_profile_url' => DI::baseUrl()."/contact/".$uinfo[0]['cid'],
 733                 'statusnet_profile_url' => $uinfo[0]['url'],
 734                 'uid' => intval($uinfo[0]['uid']),
 735                 'cid' => intval($uinfo[0]['cid']),
 736                 'pid' => Contact::getIdForURL($uinfo[0]["url"], 0, false),
 737                 'self' => $uinfo[0]['self'],
 738                 'network' => $uinfo[0]['network'],
 739         ];
 740
 741         // If this is a local user and it uses Frio, we can get its color preferences.
 742         if ($ret['self']) {
 743                 $theme_info = DBA::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
 744                 if ($theme_info['theme'] === 'frio') {
 745                         $schema = DI::pConfig()->get($ret['uid'], 'frio', 'schema');
 746
 747                         if ($schema && ($schema != '---')) {
 748                                 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
 749                                         $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
 750                                         require_once $schemefile;
 751                                 }
 752                         } else {
 753                                 $nav_bg = DI::pConfig()->get($ret['uid'], 'frio', 'nav_bg');
 754                                 $link_color = DI::pConfig()->get($ret['uid'], 'frio', 'link_color');
 755                                 $bgcolor = DI::pConfig()->get($ret['uid'], 'frio', 'background_color');
 756                         }
 757                         if (empty($nav_bg)) {
 758                                 $nav_bg = "#708fa0";
 759                         }
 760                         if (empty($link_color)) {
 761                                 $link_color = "#6fdbe8";
 762                         }
 763                         if (empty($bgcolor)) {
 764                                 $bgcolor = "#ededed";
 765                         }
 766
 767                         $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
 768                         $ret['profile_link_color'] = str_replace('#', '', $link_color);
 769                         $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
 770                 }
 771         }
 772
 773         return $ret;
 774 }
 775
 776 /**
 777  * return api-formatted array for item's author and owner
 778  *
 779  * @param App   $a    App
 780  * @param array $item item from db
 781  * @return array(array:author, array:owner)
 782  * @throws BadRequestException
 783  * @throws ImagickException
 784  * @throws InternalServerErrorException
 785  * @throws UnauthorizedException
 786  */
 787 function api_item_get_user(App $a, $item)
 788 {
 789         $status_user = api_get_user($a, $item['author-id'] ?? null);
 790
 791         $author_user = $status_user;
 792
 793         $status_user["protected"] = isset($item['private']) && ($item['private'] == Item::PRIVATE);
 794
 795         if (($item['thr-parent'] ?? '') == ($item['uri'] ?? '')) {
 796                 $owner_user = api_get_user($a, $item['owner-id'] ?? null);
 797         } else {
 798                 $owner_user = $author_user;
 799         }
 800
 801         return ([$status_user, $author_user, $owner_user]);
 802 }
 803
 804 /**
 805  * walks recursively through an array with the possibility to change value and key
 806  *
 807  * @param array    $array    The array to walk through
 808  * @param callable $callback The callback function
 809  *
 810  * @return array the transformed array
 811  */
 812 function api_walk_recursive(array &$array, callable $callback)
 813 {
 814         $new_array = [];
 815
 816         foreach ($array as $k => $v) {
 817                 if (is_array($v)) {
 818                         if ($callback($v, $k)) {
 819                                 $new_array[$k] = api_walk_recursive($v, $callback);
 820                         }
 821                 } else {
 822                         if ($callback($v, $k)) {
 823                                 $new_array[$k] = $v;
 824                         }
 825                 }
 826         }
 827         $array = $new_array;
 828
 829         return $array;
 830 }
 831
 832 /**
 833  * Callback function to transform the array in an array that can be transformed in a XML file
 834  *
 835  * @param mixed  $item Array item value
 836  * @param string $key  Array key
 837  *
 838  * @return boolean Should the array item be deleted?
 839  */
 840 function api_reformat_xml(&$item, &$key)
 841 {
 842         if (is_bool($item)) {
 843                 $item = ($item ? "true" : "false");
 844         }
 845
 846         if (substr($key, 0, 10) == "statusnet_") {
 847                 $key = "statusnet:".substr($key, 10);
 848         } elseif (substr($key, 0, 10) == "friendica_") {
 849                 $key = "friendica:".substr($key, 10);
 850         }
 851         /// @TODO old-lost code?
 852         //else
 853         //      $key = "default:".$key;
 854
 855         return true;
 856 }
 857
 858 /**
 859  * Creates the XML from a JSON style array
 860  *
 861  * @param array  $data         JSON style array
 862  * @param string $root_element Name of the root element
 863  *
 864  * @return string The XML data
 865  */
 866 function api_create_xml(array $data, $root_element)
 867 {
 868         $childname = key($data);
 869         $data2 = array_pop($data);
 870
 871         $namespaces = ["" => "http://api.twitter.com",
 872                                 "statusnet" => "http://status.net/schema/api/1/",
 873                                 "friendica" => "http://friendi.ca/schema/api/1/",
 874                                 "georss" => "http://www.georss.org/georss"];
 875
 876         /// @todo Auto detection of needed namespaces
 877         if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
 878                 $namespaces = [];
 879         }
 880
 881         if (is_array($data2)) {
 882                 $key = key($data2);
 883                 api_walk_recursive($data2, "api_reformat_xml");
 884
 885                 if ($key == "0") {
 886                         $data4 = [];
 887                         $i = 1;
 888
 889                         foreach ($data2 as $item) {
 890                                 $data4[$i++ . ":" . $childname] = $item;
 891                         }
 892
 893                         $data2 = $data4;
 894                 }
 895         }
 896
 897         $data3 = [$root_element => $data2];
 898
 899         $ret = XML::fromArray($data3, $xml, false, $namespaces);
 900         return $ret;
 901 }
 902
 903 /**
 904  * Formats the data according to the data type
 905  *
 906  * @param string $root_element Name of the root element
 907  * @param string $type         Return type (atom, rss, xml, json)
 908  * @param array  $data         JSON style array
 909  *
 910  * @return array|string (string|array) XML data or JSON data
 911  */
 912 function api_format_data($root_element, $type, $data)
 913 {
 914         switch ($type) {
 915                 case "atom":
 916                 case "rss":
 917                 case "xml":
 918                         $ret = api_create_xml($data, $root_element);
 919                         break;
 920                 case "json":
 921                 default:
 922                         $ret = $data;
 923                         break;
 924         }
 925         return $ret;
 926 }
 927
 928 /**
 929  * TWITTER API
 930  */
 931
 932 /**
 933  * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
 934  * returns a 401 status code and an error message if not.
 935  *
 936  * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
 937  *
 938  * @param string $type Return type (atom, rss, xml, json)
 939  * @return array|string
 940  * @throws BadRequestException
 941  * @throws ForbiddenException
 942  * @throws ImagickException
 943  * @throws InternalServerErrorException
 944  * @throws UnauthorizedException
 945  */
 946 function api_account_verify_credentials($type)
 947 {
 948         $a = DI::app();
 949
 950         if (api_user() === false) {
 951                 throw new ForbiddenException();
 952         }
 953
 954         unset($_REQUEST["user_id"]);
 955         unset($_GET["user_id"]);
 956
 957         unset($_REQUEST["screen_name"]);
 958         unset($_GET["screen_name"]);
 959
 960         $skip_status = $_REQUEST['skip_status'] ?? false;
 961
 962         $user_info = api_get_user($a);
 963
 964         // "verified" isn't used here in the standard
 965         unset($user_info["verified"]);
 966
 967         // - Adding last status
 968         if (!$skip_status) {
 969                 $item = api_get_last_status($user_info['pid'], $user_info['uid']);
 970                 if (!empty($item)) {
 971                         $user_info['status'] = api_format_item($item, $type);
 972                 }
 973         }
 974
 975         // "uid" and "self" are only needed for some internal stuff, so remove it from here
 976         unset($user_info["uid"]);
 977         unset($user_info["self"]);
 978
 979         return api_format_data("user", $type, ['user' => $user_info]);
 980 }
 981
 982 /// @TODO move to top of file or somewhere better
 983 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
 984
 985 /**
 986  * Get data from $_POST or $_GET
 987  *
 988  * @param string $k
 989  * @return null
 990  */
 991 function requestdata($k)
 992 {
 993         if (!empty($_POST[$k])) {
 994                 return $_POST[$k];
 995         }
 996         if (!empty($_GET[$k])) {
 997                 return $_GET[$k];
 998         }
 999         return null;
1000 }
1001
1002 /**
1003  * Deprecated function to upload media.
1004  *
1005  * @param string $type Return type (atom, rss, xml, json)
1006  *
1007  * @return array|string
1008  * @throws BadRequestException
1009  * @throws ForbiddenException
1010  * @throws ImagickException
1011  * @throws InternalServerErrorException
1012  * @throws UnauthorizedException
1013  */
1014 function api_statuses_mediap($type)
1015 {
1016         $a = DI::app();
1017
1018         if (api_user() === false) {
1019                 Logger::log('api_statuses_update: no user');
1020                 throw new ForbiddenException();
1021         }
1022         $user_info = api_get_user($a);
1023
1024         $_REQUEST['profile_uid'] = api_user();
1025         $_REQUEST['api_source'] = true;
1026         $txt = requestdata('status');
1027         /// @TODO old-lost code?
1028         //$txt = urldecode(requestdata('status'));
1029
1030         if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1031                 $txt = HTML::toBBCodeVideo($txt);
1032                 $config = HTMLPurifier_Config::createDefault();
1033                 $config->set('Cache.DefinitionImpl', null);
1034                 $purifier = new HTMLPurifier($config);
1035                 $txt = $purifier->purify($txt);
1036         }
1037         $txt = HTML::toBBCode($txt);
1038
1039         $a->argv[1] = $user_info['screen_name']; //should be set to username?
1040
1041         $picture = wall_upload_post($a, false);
1042
1043         // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1044         $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1045         $item_id = item_post($a);
1046
1047         // output the post that we just posted.
1048         return api_status_show($type, $item_id);
1049 }
1050
1051 /// @TODO move this to top of file or somewhere better!
1052 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1053
1054 /**
1055  * Updates the user’s current status.
1056  *
1057  * @param string $type Return type (atom, rss, xml, json)
1058  *
1059  * @return array|string
1060  * @throws BadRequestException
1061  * @throws ForbiddenException
1062  * @throws ImagickException
1063  * @throws InternalServerErrorException
1064  * @throws TooManyRequestsException
1065  * @throws UnauthorizedException
1066  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1067  */
1068 function api_statuses_update($type)
1069 {
1070         $a = DI::app();
1071
1072         if (api_user() === false) {
1073                 Logger::log('api_statuses_update: no user');
1074                 throw new ForbiddenException();
1075         }
1076
1077         api_get_user($a);
1078
1079         // convert $_POST array items to the form we use for web posts.
1080         if (requestdata('htmlstatus')) {
1081                 $txt = requestdata('htmlstatus');
1082                 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1083                         $txt = HTML::toBBCodeVideo($txt);
1084
1085                         $config = HTMLPurifier_Config::createDefault();
1086                         $config->set('Cache.DefinitionImpl', null);
1087
1088                         $purifier = new HTMLPurifier($config);
1089                         $txt = $purifier->purify($txt);
1090
1091                         $_REQUEST['body'] = HTML::toBBCode($txt);
1092                 }
1093         } else {
1094                 $_REQUEST['body'] = requestdata('status');
1095         }
1096
1097         $_REQUEST['title'] = requestdata('title');
1098
1099         $parent = requestdata('in_reply_to_status_id');
1100
1101         // Twidere sends "-1" if it is no reply ...
1102         if ($parent == -1) {
1103                 $parent = "";
1104         }
1105
1106         if (ctype_digit($parent)) {
1107                 $_REQUEST['parent'] = $parent;
1108         } else {
1109                 $_REQUEST['parent_uri'] = $parent;
1110         }
1111
1112         if (requestdata('lat') && requestdata('long')) {
1113                 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1114         }
1115         $_REQUEST['profile_uid'] = api_user();
1116
1117         if (!$parent) {
1118                 // Check for throttling (maximum posts per day, week and month)
1119                 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
1120                 if ($throttle_day > 0) {
1121                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1122
1123                         $condition = ["`uid` = ? AND `wall` AND `received` > ?", api_user(), $datefrom];
1124                         $posts_day = DBA::count('thread', $condition);
1125
1126                         if ($posts_day > $throttle_day) {
1127                                 Logger::log('Daily posting limit reached for user '.api_user(), Logger::DEBUG);
1128                                 // die(api_error($type, DI::l10n()->t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1129                                 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));
1130                         }
1131                 }
1132
1133                 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
1134                 if ($throttle_week > 0) {
1135                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1136
1137                         $condition = ["`uid` = ? AND `wall` AND `received` > ?", api_user(), $datefrom];
1138                         $posts_week = DBA::count('thread', $condition);
1139
1140                         if ($posts_week > $throttle_week) {
1141                                 Logger::log('Weekly posting limit reached for user '.api_user(), Logger::DEBUG);
1142                                 // die(api_error($type, DI::l10n()->t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1143                                 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));
1144                         }
1145                 }
1146
1147                 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
1148                 if ($throttle_month > 0) {
1149                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1150
1151                         $condition = ["`uid` = ? AND `wall` AND `received` > ?", api_user(), $datefrom];
1152                         $posts_month = DBA::count('thread', $condition);
1153
1154                         if ($posts_month > $throttle_month) {
1155                                 Logger::log('Monthly posting limit reached for user '.api_user(), Logger::DEBUG);
1156                                 // die(api_error($type, DI::l10n()->t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1157                                 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));
1158                         }
1159                 }
1160         }
1161
1162         if (!empty($_FILES['media'])) {
1163                 // upload the image if we have one
1164                 $picture = wall_upload_post($a, false);
1165                 if (is_array($picture)) {
1166                         $_REQUEST['body'] .= "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]";
1167                 }
1168         }
1169
1170         if (requestdata('media_ids')) {
1171                 $ids = explode(',', requestdata('media_ids'));
1172                 foreach ($ids as $id) {
1173                         $r = q(
1174                                 "SELECT `resource-id`, `scale`, `nickname`, `type`, `desc` FROM `photo` INNER JOIN `user` ON `user`.`uid` = `photo`.`uid` WHERE `resource-id` IN (SELECT `resource-id` FROM `photo` WHERE `id` = %d) AND `scale` > 0 AND `photo`.`uid` = %d ORDER BY `photo`.`width` DESC LIMIT 1",
1175                                 intval($id),
1176                                 api_user()
1177                         );
1178                         if (DBA::isResult($r)) {
1179                                 $phototypes = Images::supportedTypes();
1180                                 $ext = $phototypes[$r[0]['type']];
1181                                 $description = $r[0]['desc'] ?? '';
1182                                 $_REQUEST['body'] .= "\n\n" . '[url=' . DI::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1183                                 $_REQUEST['body'] .= '[img=' . DI::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . ']' . $description . '[/img][/url]';
1184                         }
1185                 }
1186         }
1187
1188         // set this so that the item_post() function is quiet and doesn't redirect or emit json
1189
1190         $_REQUEST['api_source'] = true;
1191
1192         if (empty($_REQUEST['source'])) {
1193                 $_REQUEST["source"] = api_source();
1194         }
1195
1196         // call out normal post function
1197         $item_id = item_post($a);
1198
1199         // output the post that we just posted.
1200         return api_status_show($type, $item_id);
1201 }
1202
1203 /// @TODO move to top of file or somewhere better
1204 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1205 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1206
1207 /**
1208  * Uploads an image to Friendica.
1209  *
1210  * @return array
1211  * @throws BadRequestException
1212  * @throws ForbiddenException
1213  * @throws ImagickException
1214  * @throws InternalServerErrorException
1215  * @throws UnauthorizedException
1216  * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1217  */
1218 function api_media_upload()
1219 {
1220         $a = DI::app();
1221
1222         if (api_user() === false) {
1223                 Logger::log('no user');
1224                 throw new ForbiddenException();
1225         }
1226
1227         api_get_user($a);
1228
1229         if (empty($_FILES['media'])) {
1230                 // Output error
1231                 throw new BadRequestException("No media.");
1232         }
1233
1234         $media = wall_upload_post($a, false);
1235         if (!$media) {
1236                 // Output error
1237                 throw new InternalServerErrorException();
1238         }
1239
1240         $returndata = [];
1241         $returndata["media_id"] = $media["id"];
1242         $returndata["media_id_string"] = (string)$media["id"];
1243         $returndata["size"] = $media["size"];
1244         $returndata["image"] = ["w" => $media["width"],
1245                                 "h" => $media["height"],
1246                                 "image_type" => $media["type"],
1247                                 "friendica_preview_url" => $media["preview"]];
1248
1249         Logger::info('Media uploaded', ['return' => $returndata]);
1250
1251         return ["media" => $returndata];
1252 }
1253
1254 /// @TODO move to top of file or somewhere better
1255 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1256
1257 /**
1258  * Updates media meta data (picture descriptions)
1259  *
1260  * @param string $type Return type (atom, rss, xml, json)
1261  *
1262  * @return array|string
1263  * @throws BadRequestException
1264  * @throws ForbiddenException
1265  * @throws ImagickException
1266  * @throws InternalServerErrorException
1267  * @throws TooManyRequestsException
1268  * @throws UnauthorizedException
1269  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1270  *
1271  * @todo Compare the corresponding Twitter function for correct return values
1272  */
1273 function api_media_metadata_create($type)
1274 {
1275         $a = DI::app();
1276
1277         if (api_user() === false) {
1278                 Logger::info('no user');
1279                 throw new ForbiddenException();
1280         }
1281
1282         api_get_user($a);
1283
1284         $postdata = Network::postdata();
1285
1286         if (empty($postdata)) {
1287                 throw new BadRequestException("No post data");
1288         }
1289
1290         $data = json_decode($postdata, true);
1291         if (empty($data)) {
1292                 throw new BadRequestException("Invalid post data");
1293         }
1294
1295         if (empty($data['media_id']) || empty($data['alt_text'])) {
1296                 throw new BadRequestException("Missing post data values");
1297         }
1298
1299         if (empty($data['alt_text']['text'])) {
1300                 throw new BadRequestException("No alt text.");
1301         }
1302
1303         Logger::info('Updating metadata', ['media_id' => $data['media_id']]);
1304
1305         $condition =  ['id' => $data['media_id'], 'uid' => api_user()];
1306         $photo = DBA::selectFirst('photo', ['resource-id'], $condition);
1307         if (!DBA::isResult($photo)) {
1308                 throw new BadRequestException("Metadata not found.");
1309         }
1310
1311         DBA::update('photo', ['desc' => $data['alt_text']['text']], ['resource-id' => $photo['resource-id']]);
1312 }
1313
1314 api_register_func('api/media/metadata/create', 'api_media_metadata_create', true, API_METHOD_POST);
1315
1316 /**
1317  * @param string $type    Return format (atom, rss, xml, json)
1318  * @param int    $item_id
1319  * @return array|string
1320  * @throws Exception
1321  */
1322 function api_status_show($type, $item_id)
1323 {
1324         Logger::info(API_LOG_PREFIX . 'Start', ['action' => 'status_show', 'type' => $type, 'item_id' => $item_id]);
1325
1326         $status_info = [];
1327
1328         $item = api_get_item(['id' => $item_id]);
1329         if (!empty($item)) {
1330                 $status_info = api_format_item($item, $type);
1331         }
1332
1333         Logger::info(API_LOG_PREFIX . 'End', ['action' => 'get_status', 'status_info' => $status_info]);
1334
1335         return api_format_data('statuses', $type, ['status' => $status_info]);
1336 }
1337
1338 /**
1339  * Retrieves the last public status of the provided user info
1340  *
1341  * @param int    $ownerId Public contact Id
1342  * @param int    $uid     User Id
1343  * @return array
1344  * @throws Exception
1345  */
1346 function api_get_last_status($ownerId, $uid)
1347 {
1348         $condition = [
1349                 'author-id'=> $ownerId,
1350                 'uid'      => $uid,
1351                 'gravity'  => [GRAVITY_PARENT, GRAVITY_COMMENT],
1352                 'private'  => [Item::PUBLIC, Item::UNLISTED]
1353         ];
1354
1355         $item = api_get_item($condition);
1356
1357         return $item;
1358 }
1359
1360 /**
1361  * Retrieves a single item record based on the provided condition and converts it for API use.
1362  *
1363  * @param array $condition Item table condition array
1364  * @return array
1365  * @throws Exception
1366  */
1367 function api_get_item(array $condition)
1368 {
1369         $item = Post::selectFirst(Item::DISPLAY_FIELDLIST, $condition, ['order' => ['id' => true]]);
1370
1371         return $item;
1372 }
1373
1374 /**
1375  * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1376  * The author's most recent status will be returned inline.
1377  *
1378  * @param string $type Return type (atom, rss, xml, json)
1379  * @return array|string
1380  * @throws BadRequestException
1381  * @throws ImagickException
1382  * @throws InternalServerErrorException
1383  * @throws UnauthorizedException
1384  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1385  */
1386 function api_users_show($type)
1387 {
1388         $a = Friendica\DI::app();
1389
1390         $user_info = api_get_user($a);
1391
1392         $item = api_get_last_status($user_info['pid'], $user_info['uid']);
1393         if (!empty($item)) {
1394                 $user_info['status'] = api_format_item($item, $type);
1395         }
1396
1397         // "uid" and "self" are only needed for some internal stuff, so remove it from here
1398         unset($user_info['uid']);
1399         unset($user_info['self']);
1400
1401         return api_format_data('user', $type, ['user' => $user_info]);
1402 }
1403
1404 /// @TODO move to top of file or somewhere better
1405 api_register_func('api/users/show', 'api_users_show');
1406 api_register_func('api/externalprofile/show', 'api_users_show');
1407
1408 /**
1409  * Search a public user account.
1410  *
1411  * @param string $type Return type (atom, rss, xml, json)
1412  *
1413  * @return array|string
1414  * @throws BadRequestException
1415  * @throws ImagickException
1416  * @throws InternalServerErrorException
1417  * @throws UnauthorizedException
1418  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1419  */
1420 function api_users_search($type)
1421 {
1422         $a = DI::app();
1423
1424         $userlist = [];
1425
1426         if (!empty($_GET['q'])) {
1427                 $contacts = Contact::selectToArray(
1428                         ['id'],
1429                         [
1430                                 '`uid` = 0 AND (`name` = ? OR `nick` = ? OR `url` = ? OR `addr` = ?)',
1431                                 $_GET['q'],
1432                                 $_GET['q'],
1433                                 $_GET['q'],
1434                                 $_GET['q'],
1435                         ]
1436                 );
1437
1438                 if (DBA::isResult($contacts)) {
1439                         $k = 0;
1440                         foreach ($contacts as $contact) {
1441                                 $user_info = api_get_user($a, $contact['id']);
1442
1443                                 if ($type == 'xml') {
1444                                         $userlist[$k++ . ':user'] = $user_info;
1445                                 } else {
1446                                         $userlist[] = $user_info;
1447                                 }
1448                         }
1449                         $userlist = ['users' => $userlist];
1450                 } else {
1451                         throw new NotFoundException('User ' . $_GET['q'] . ' not found.');
1452                 }
1453         } else {
1454                 throw new BadRequestException('No search term specified.');
1455         }
1456
1457         return api_format_data('users', $type, $userlist);
1458 }
1459
1460 /// @TODO move to top of file or somewhere better
1461 api_register_func('api/users/search', 'api_users_search');
1462
1463 /**
1464  * Return user objects
1465  *
1466  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1467  *
1468  * @param string $type Return format: json or xml
1469  *
1470  * @return array|string
1471  * @throws BadRequestException
1472  * @throws ImagickException
1473  * @throws InternalServerErrorException
1474  * @throws NotFoundException if the results are empty.
1475  * @throws UnauthorizedException
1476  */
1477 function api_users_lookup($type)
1478 {
1479         $users = [];
1480
1481         if (!empty($_REQUEST['user_id'])) {
1482                 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1483                         if (!empty($id)) {
1484                                 $users[] = api_get_user(DI::app(), $id);
1485                         }
1486                 }
1487         }
1488
1489         if (empty($users)) {
1490                 throw new NotFoundException;
1491         }
1492
1493         return api_format_data("users", $type, ['users' => $users]);
1494 }
1495
1496 /// @TODO move to top of file or somewhere better
1497 api_register_func('api/users/lookup', 'api_users_lookup', true);
1498
1499 /**
1500  * Returns statuses that match a specified query.
1501  *
1502  * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1503  *
1504  * @param string $type Return format: json, xml, atom, rss
1505  *
1506  * @return array|string
1507  * @throws BadRequestException if the "q" parameter is missing.
1508  * @throws ForbiddenException
1509  * @throws ImagickException
1510  * @throws InternalServerErrorException
1511  * @throws UnauthorizedException
1512  */
1513 function api_search($type)
1514 {
1515         $a = DI::app();
1516         $user_info = api_get_user($a);
1517
1518         if (api_user() === false || $user_info === false) {
1519                 throw new ForbiddenException();
1520         }
1521
1522         if (empty($_REQUEST['q'])) {
1523                 throw new BadRequestException('q parameter is required.');
1524         }
1525
1526         $searchTerm = trim(rawurldecode($_REQUEST['q']));
1527
1528         $data = [];
1529         $data['status'] = [];
1530         $count = 15;
1531         $exclude_replies = !empty($_REQUEST['exclude_replies']);
1532         if (!empty($_REQUEST['rpp'])) {
1533                 $count = $_REQUEST['rpp'];
1534         } elseif (!empty($_REQUEST['count'])) {
1535                 $count = $_REQUEST['count'];
1536         }
1537
1538         $since_id = $_REQUEST['since_id'] ?? 0;
1539         $max_id = $_REQUEST['max_id'] ?? 0;
1540         $page = $_REQUEST['page'] ?? 1;
1541
1542         $start = max(0, ($page - 1) * $count);
1543
1544         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1545         if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) {
1546                 $searchTerm = $matches[1];
1547                 $condition = ["`iid` > ? AND `name` = ? AND (NOT `private` OR (`private` AND `uid` = ?))", $since_id, $searchTerm, local_user()];
1548                 $tags = DBA::select('tag-search-view', ['uri-id'], $condition);
1549                 $uriids = [];
1550                 while ($tag = DBA::fetch($tags)) {
1551                         $uriids[] = $tag['uri-id'];
1552                 }
1553                 DBA::close($tags);
1554
1555                 if (empty($uriids)) {
1556                         return api_format_data('statuses', $type, $data);
1557                 }
1558
1559                 $condition = ['uri-id' => $uriids];
1560                 if ($exclude_replies) {
1561                         $condition['gravity'] = GRAVITY_PARENT;
1562                 }
1563
1564                 $params['group_by'] = ['uri-id'];
1565         } else {
1566                 $condition = ["`id` > ?
1567                         " . ($exclude_replies ? " AND `gravity` = " . GRAVITY_PARENT : ' ') . "
1568                         AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1569                         AND `body` LIKE CONCAT('%',?,'%')",
1570                         $since_id, api_user(), $_REQUEST['q']];
1571                 if ($max_id > 0) {
1572                         $condition[0] .= ' AND `id` <= ?';
1573                         $condition[] = $max_id;
1574                 }
1575         }
1576
1577         $statuses = [];
1578
1579         if (parse_url($searchTerm, PHP_URL_SCHEME) != '') {
1580                 $id = Item::fetchByLink($searchTerm, api_user());
1581                 if (!$id) {
1582                         // Public post
1583                         $id = Item::fetchByLink($searchTerm);
1584                 }
1585
1586                 if (!empty($id)) {
1587                         $statuses = Item::select([], ['id' => $id]);
1588                 }
1589         }
1590
1591         $statuses = $statuses ?: Item::selectForUser(api_user(), [], $condition, $params);
1592
1593         $data['status'] = api_format_items(Item::inArray($statuses), $user_info);
1594
1595         bindComments($data['status']);
1596
1597         return api_format_data('statuses', $type, $data);
1598 }
1599
1600 /// @TODO move to top of file or somewhere better
1601 api_register_func('api/search/tweets', 'api_search', true);
1602 api_register_func('api/search', 'api_search', true);
1603
1604 /**
1605  * Returns the most recent statuses posted by the user and the users they follow.
1606  *
1607  * @see  https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1608  *
1609  * @param string $type Return type (atom, rss, xml, json)
1610  *
1611  * @return array|string
1612  * @throws BadRequestException
1613  * @throws ForbiddenException
1614  * @throws ImagickException
1615  * @throws InternalServerErrorException
1616  * @throws UnauthorizedException
1617  * @todo Optional parameters
1618  * @todo Add reply info
1619  */
1620 function api_statuses_home_timeline($type)
1621 {
1622         $a = DI::app();
1623         $user_info = api_get_user($a);
1624
1625         if (api_user() === false || $user_info === false) {
1626                 throw new ForbiddenException();
1627         }
1628
1629         unset($_REQUEST["user_id"]);
1630         unset($_GET["user_id"]);
1631
1632         unset($_REQUEST["screen_name"]);
1633         unset($_GET["screen_name"]);
1634
1635         // get last network messages
1636
1637         // params
1638         $count = $_REQUEST['count'] ?? 20;
1639         $page = $_REQUEST['page']?? 0;
1640         $since_id = $_REQUEST['since_id'] ?? 0;
1641         $max_id = $_REQUEST['max_id'] ?? 0;
1642         $exclude_replies = !empty($_REQUEST['exclude_replies']);
1643         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1644
1645         $start = max(0, ($page - 1) * $count);
1646
1647         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1648                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1649
1650         if ($max_id > 0) {
1651                 $condition[0] .= " AND `item`.`id` <= ?";
1652                 $condition[] = $max_id;
1653         }
1654         if ($exclude_replies) {
1655                 $condition[0] .= ' AND `item`.`gravity` = ?';
1656                 $condition[] = GRAVITY_PARENT;
1657         }
1658         if ($conversation_id > 0) {
1659                 $condition[0] .= " AND `item`.`parent` = ?";
1660                 $condition[] = $conversation_id;
1661         }
1662
1663         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1664         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1665
1666         $items = Item::inArray($statuses);
1667
1668         $ret = api_format_items($items, $user_info, false, $type);
1669
1670         // Set all posts from the query above to seen
1671         $idarray = [];
1672         foreach ($items as $item) {
1673                 $idarray[] = intval($item["id"]);
1674         }
1675
1676         if (!empty($idarray)) {
1677                 $unseen = Post::exists(['unseen' => true, 'id' => $idarray]);
1678                 if ($unseen) {
1679                         Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1680                 }
1681         }
1682
1683         bindComments($ret);
1684
1685         $data = ['status' => $ret];
1686         switch ($type) {
1687                 case "atom":
1688                         break;
1689                 case "rss":
1690                         $data = api_rss_extra($a, $data, $user_info);
1691                         break;
1692         }
1693
1694         return api_format_data("statuses", $type, $data);
1695 }
1696
1697
1698 /// @TODO move to top of file or somewhere better
1699 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1700 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1701
1702 /**
1703  * Returns the most recent statuses from public users.
1704  *
1705  * @param string $type Return type (atom, rss, xml, json)
1706  *
1707  * @return array|string
1708  * @throws BadRequestException
1709  * @throws ForbiddenException
1710  * @throws ImagickException
1711  * @throws InternalServerErrorException
1712  * @throws UnauthorizedException
1713  */
1714 function api_statuses_public_timeline($type)
1715 {
1716         $a = DI::app();
1717         $user_info = api_get_user($a);
1718
1719         if (api_user() === false || $user_info === false) {
1720                 throw new ForbiddenException();
1721         }
1722
1723         // get last network messages
1724
1725         // params
1726         $count = $_REQUEST['count'] ?? 20;
1727         $page = $_REQUEST['page'] ?? 1;
1728         $since_id = $_REQUEST['since_id'] ?? 0;
1729         $max_id = $_REQUEST['max_id'] ?? 0;
1730         $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
1731         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1732
1733         $start = max(0, ($page - 1) * $count);
1734
1735         if ($exclude_replies && !$conversation_id) {
1736                 $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND `private` = ? AND `wall` AND NOT `author`.`hidden`",
1737                         GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC];
1738
1739                 if ($max_id > 0) {
1740                         $condition[0] .= " AND `thread`.`iid` <= ?";
1741                         $condition[] = $max_id;
1742                 }
1743
1744                 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1745                 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1746
1747                 $r = Item::inArray($statuses);
1748         } else {
1749                 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND `private` = ? AND `wall` AND `item`.`origin` AND NOT `author`.`hidden`",
1750                         GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC];
1751
1752                 if ($max_id > 0) {
1753                         $condition[0] .= " AND `item`.`id` <= ?";
1754                         $condition[] = $max_id;
1755                 }
1756                 if ($conversation_id > 0) {
1757                         $condition[0] .= " AND `item`.`parent` = ?";
1758                         $condition[] = $conversation_id;
1759                 }
1760
1761                 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1762                 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1763
1764                 $r = Item::inArray($statuses);
1765         }
1766
1767         $ret = api_format_items($r, $user_info, false, $type);
1768
1769         bindComments($ret);
1770
1771         $data = ['status' => $ret];
1772         switch ($type) {
1773                 case "atom":
1774                         break;
1775                 case "rss":
1776                         $data = api_rss_extra($a, $data, $user_info);
1777                         break;
1778         }
1779
1780         return api_format_data("statuses", $type, $data);
1781 }
1782
1783 /// @TODO move to top of file or somewhere better
1784 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1785
1786 /**
1787  * Returns the most recent statuses posted by users this node knows about.
1788  *
1789  * @param string $type Return format: json, xml, atom, rss
1790  * @return array|string
1791  * @throws BadRequestException
1792  * @throws ForbiddenException
1793  * @throws ImagickException
1794  * @throws InternalServerErrorException
1795  * @throws UnauthorizedException
1796  */
1797 function api_statuses_networkpublic_timeline($type)
1798 {
1799         $a = DI::app();
1800         $user_info = api_get_user($a);
1801
1802         if (api_user() === false || $user_info === false) {
1803                 throw new ForbiddenException();
1804         }
1805
1806         $since_id        = $_REQUEST['since_id'] ?? 0;
1807         $max_id          = $_REQUEST['max_id'] ?? 0;
1808
1809         // pagination
1810         $count = $_REQUEST['count'] ?? 20;
1811         $page  = $_REQUEST['page'] ?? 1;
1812
1813         $start = max(0, ($page - 1) * $count);
1814
1815         $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `thread`.`iid` > ? AND `private` = ?",
1816                 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC];
1817
1818         if ($max_id > 0) {
1819                 $condition[0] .= " AND `thread`.`iid` <= ?";
1820                 $condition[] = $max_id;
1821         }
1822
1823         $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1824         $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1825
1826         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1827
1828         bindComments($ret);
1829
1830         $data = ['status' => $ret];
1831         switch ($type) {
1832                 case "atom":
1833                         break;
1834                 case "rss":
1835                         $data = api_rss_extra($a, $data, $user_info);
1836                         break;
1837         }
1838
1839         return api_format_data("statuses", $type, $data);
1840 }
1841
1842 /// @TODO move to top of file or somewhere better
1843 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1844
1845 /**
1846  * Returns a single status.
1847  *
1848  * @param string $type Return type (atom, rss, xml, json)
1849  *
1850  * @return array|string
1851  * @throws BadRequestException
1852  * @throws ForbiddenException
1853  * @throws ImagickException
1854  * @throws InternalServerErrorException
1855  * @throws UnauthorizedException
1856  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1857  */
1858 function api_statuses_show($type)
1859 {
1860         $a = DI::app();
1861         $user_info = api_get_user($a);
1862
1863         if (api_user() === false || $user_info === false) {
1864                 throw new ForbiddenException();
1865         }
1866
1867         // params
1868         $id = intval($a->argv[3] ?? 0);
1869
1870         if ($id == 0) {
1871                 $id = intval($_REQUEST['id'] ?? 0);
1872         }
1873
1874         // Hotot workaround
1875         if ($id == 0) {
1876                 $id = intval($a->argv[4] ?? 0);
1877         }
1878
1879         Logger::log('API: api_statuses_show: ' . $id);
1880
1881         $conversation = !empty($_REQUEST['conversation']);
1882
1883         // try to fetch the item for the local user - or the public item, if there is no local one
1884         $uri_item = Post::selectFirst(['uri'], ['id' => $id]);
1885         if (!DBA::isResult($uri_item)) {
1886                 throw new BadRequestException("There is no status with this id.");
1887         }
1888
1889         $item = Post::selectFirst(['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1890         if (!DBA::isResult($item)) {
1891                 throw new BadRequestException("There is no status with this id.");
1892         }
1893
1894         $id = $item['id'];
1895
1896         if ($conversation) {
1897                 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1898                 $params = ['order' => ['id' => true]];
1899         } else {
1900                 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1901                 $params = [];
1902         }
1903
1904         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1905
1906         /// @TODO How about copying this to above methods which don't check $r ?
1907         if (!DBA::isResult($statuses)) {
1908                 throw new BadRequestException("There is no status with this id.");
1909         }
1910
1911         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1912
1913         if ($conversation) {
1914                 $data = ['status' => $ret];
1915                 return api_format_data("statuses", $type, $data);
1916         } else {
1917                 $data = ['status' => $ret[0]];
1918                 return api_format_data("status", $type, $data);
1919         }
1920 }
1921
1922 /// @TODO move to top of file or somewhere better
1923 api_register_func('api/statuses/show', 'api_statuses_show', true);
1924
1925 /**
1926  *
1927  * @param string $type Return type (atom, rss, xml, json)
1928  *
1929  * @return array|string
1930  * @throws BadRequestException
1931  * @throws ForbiddenException
1932  * @throws ImagickException
1933  * @throws InternalServerErrorException
1934  * @throws UnauthorizedException
1935  * @todo nothing to say?
1936  */
1937 function api_conversation_show($type)
1938 {
1939         $a = DI::app();
1940         $user_info = api_get_user($a);
1941
1942         if (api_user() === false || $user_info === false) {
1943                 throw new ForbiddenException();
1944         }
1945
1946         // params
1947         $id       = intval($a->argv[3]           ?? 0);
1948         $since_id = intval($_REQUEST['since_id'] ?? 0);
1949         $max_id   = intval($_REQUEST['max_id']   ?? 0);
1950         $count    = intval($_REQUEST['count']    ?? 20);
1951         $page     = intval($_REQUEST['page']     ?? 1);
1952
1953         $start = max(0, ($page - 1) * $count);
1954
1955         if ($id == 0) {
1956                 $id = intval($_REQUEST['id'] ?? 0);
1957         }
1958
1959         // Hotot workaround
1960         if ($id == 0) {
1961                 $id = intval($a->argv[4] ?? 0);
1962         }
1963
1964         Logger::info(API_LOG_PREFIX . '{subaction}', ['module' => 'api', 'action' => 'conversation', 'subaction' => 'show', 'id' => $id]);
1965
1966         // try to fetch the item for the local user - or the public item, if there is no local one
1967         $item = Post::selectFirst(['parent-uri'], ['id' => $id]);
1968         if (!DBA::isResult($item)) {
1969                 throw new BadRequestException("There is no status with this id.");
1970         }
1971
1972         $parent = Post::selectFirst(['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1973         if (!DBA::isResult($parent)) {
1974                 throw new BadRequestException("There is no status with this id.");
1975         }
1976
1977         $id = $parent['id'];
1978
1979         $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1980                 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1981
1982         if ($max_id > 0) {
1983                 $condition[0] .= " AND `item`.`id` <= ?";
1984                 $condition[] = $max_id;
1985         }
1986
1987         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1988         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1989
1990         if (!DBA::isResult($statuses)) {
1991                 throw new BadRequestException("There is no status with id $id.");
1992         }
1993
1994         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1995
1996         $data = ['status' => $ret];
1997         return api_format_data("statuses", $type, $data);
1998 }
1999
2000 /// @TODO move to top of file or somewhere better
2001 api_register_func('api/conversation/show', 'api_conversation_show', true);
2002 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
2003
2004 /**
2005  * Repeats a status.
2006  *
2007  * @param string $type Return type (atom, rss, xml, json)
2008  *
2009  * @return array|string
2010  * @throws BadRequestException
2011  * @throws ForbiddenException
2012  * @throws ImagickException
2013  * @throws InternalServerErrorException
2014  * @throws UnauthorizedException
2015  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
2016  */
2017 function api_statuses_repeat($type)
2018 {
2019         global $called_api;
2020
2021         $a = DI::app();
2022
2023         if (api_user() === false) {
2024                 throw new ForbiddenException();
2025         }
2026
2027         api_get_user($a);
2028
2029         // params
2030         $id = intval($a->argv[3] ?? 0);
2031
2032         if ($id == 0) {
2033                 $id = intval($_REQUEST['id'] ?? 0);
2034         }
2035
2036         // Hotot workaround
2037         if ($id == 0) {
2038                 $id = intval($a->argv[4] ?? 0);
2039         }
2040
2041         Logger::log('API: api_statuses_repeat: '.$id);
2042
2043         $fields = ['uri-id', 'network', 'body', 'title', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
2044         $item = Item::selectFirst($fields, ['id' => $id, 'private' => [Item::PUBLIC, Item::UNLISTED]]);
2045
2046         if (DBA::isResult($item) && $item['body'] != "") {
2047                 if (in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::TWITTER])) {
2048                         if (!Item::performActivity($id, 'announce', local_user())) {
2049                                 throw new InternalServerErrorException();
2050                         }
2051
2052                         $item_id = $id;
2053                 } else {
2054                         if (strpos($item['body'], "[/share]") !== false) {
2055                                 $pos = strpos($item['body'], "[share");
2056                                 $post = substr($item['body'], $pos);
2057                         } else {
2058                                 $post = BBCode::getShareOpeningTag($item['author-name'], $item['author-link'], $item['author-avatar'], $item['plink'], $item['created'], $item['guid']);
2059
2060                                 if (!empty($item['title'])) {
2061                                         $post .= '[h3]' . $item['title'] . "[/h3]\n";
2062                                 }
2063
2064                                 $post .= $item['body'];
2065                                 $post .= "[/share]";
2066                         }
2067                         $_REQUEST['body'] = $post;
2068                         $_REQUEST['profile_uid'] = api_user();
2069                         $_REQUEST['api_source'] = true;
2070
2071                         if (empty($_REQUEST['source'])) {
2072                                 $_REQUEST["source"] = api_source();
2073                         }
2074
2075                         $item_id = item_post($a);
2076                 }
2077         } else {
2078                 throw new ForbiddenException();
2079         }
2080
2081         // output the post that we just posted.
2082         $called_api = [];
2083         return api_status_show($type, $item_id);
2084 }
2085
2086 /// @TODO move to top of file or somewhere better
2087 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2088
2089 /**
2090  * Destroys a specific status.
2091  *
2092  * @param string $type Return type (atom, rss, xml, json)
2093  *
2094  * @return array|string
2095  * @throws BadRequestException
2096  * @throws ForbiddenException
2097  * @throws ImagickException
2098  * @throws InternalServerErrorException
2099  * @throws UnauthorizedException
2100  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2101  */
2102 function api_statuses_destroy($type)
2103 {
2104         $a = DI::app();
2105
2106         if (api_user() === false) {
2107                 throw new ForbiddenException();
2108         }
2109
2110         api_get_user($a);
2111
2112         // params
2113         $id = intval($a->argv[3] ?? 0);
2114
2115         if ($id == 0) {
2116                 $id = intval($_REQUEST['id'] ?? 0);
2117         }
2118
2119         // Hotot workaround
2120         if ($id == 0) {
2121                 $id = intval($a->argv[4] ?? 0);
2122         }
2123
2124         Logger::log('API: api_statuses_destroy: '.$id);
2125
2126         $ret = api_statuses_show($type);
2127
2128         Item::deleteForUser(['id' => $id], api_user());
2129
2130         return $ret;
2131 }
2132
2133 /// @TODO move to top of file or somewhere better
2134 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2135
2136 /**
2137  * Returns the most recent mentions.
2138  *
2139  * @param string $type Return type (atom, rss, xml, json)
2140  *
2141  * @return array|string
2142  * @throws BadRequestException
2143  * @throws ForbiddenException
2144  * @throws ImagickException
2145  * @throws InternalServerErrorException
2146  * @throws UnauthorizedException
2147  * @see http://developer.twitter.com/doc/get/statuses/mentions
2148  */
2149 function api_statuses_mentions($type)
2150 {
2151         $a = DI::app();
2152         $user_info = api_get_user($a);
2153
2154         if (api_user() === false || $user_info === false) {
2155                 throw new ForbiddenException();
2156         }
2157
2158         unset($_REQUEST["user_id"]);
2159         unset($_GET["user_id"]);
2160
2161         unset($_REQUEST["screen_name"]);
2162         unset($_GET["screen_name"]);
2163
2164         // get last network messages
2165
2166         // params
2167         $since_id = intval($_REQUEST['since_id'] ?? 0);
2168         $max_id   = intval($_REQUEST['max_id']   ?? 0);
2169         $count    = intval($_REQUEST['count']    ?? 20);
2170         $page     = intval($_REQUEST['page']     ?? 1);
2171
2172         $start = max(0, ($page - 1) * $count);
2173
2174         $query = "SELECT `item`.`id` FROM `user-item`
2175                 INNER JOIN `item` ON `item`.`id` = `user-item`.`iid` AND `item`.`gravity` IN (?, ?)
2176                 WHERE (`user-item`.`hidden` IS NULL OR NOT `user-item`.`hidden`) AND
2177                         `user-item`.`uid` = ? AND `user-item`.`notification-type` & ? != 0
2178                         AND `user-item`.`iid` > ?";
2179         $condition = [GRAVITY_PARENT, GRAVITY_COMMENT, api_user(),
2180                 UserItem::NOTIF_EXPLICIT_TAGGED | UserItem::NOTIF_IMPLICIT_TAGGED |
2181                 UserItem::NOTIF_THREAD_COMMENT | UserItem::NOTIF_DIRECT_COMMENT |
2182                 UserItem::NOTIF_DIRECT_THREAD_COMMENT,
2183                 $since_id];
2184
2185         if ($max_id > 0) {
2186                 $query .= " AND `item`.`id` <= ?";
2187                 $condition[] = $max_id;
2188         }
2189
2190         $query .= " ORDER BY `user-item`.`iid` DESC LIMIT ?, ?";
2191         $condition[] = $start;
2192         $condition[] = $count;
2193
2194         $useritems = DBA::p($query, $condition);
2195         $itemids = [];
2196         while ($useritem = DBA::fetch($useritems)) {
2197                 $itemids[] = $useritem['id'];
2198         }
2199         DBA::close($useritems);
2200
2201         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2202         $statuses = Item::selectForUser(api_user(), [], ['id' => $itemids], $params);
2203
2204         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2205
2206         $data = ['status' => $ret];
2207         switch ($type) {
2208                 case "atom":
2209                         break;
2210                 case "rss":
2211                         $data = api_rss_extra($a, $data, $user_info);
2212                         break;
2213         }
2214
2215         return api_format_data("statuses", $type, $data);
2216 }
2217
2218 /// @TODO move to top of file or somewhere better
2219 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2220 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2221
2222 /**
2223  * Returns the most recent statuses posted by the user.
2224  *
2225  * @param string $type Either "json" or "xml"
2226  * @return string|array
2227  * @throws BadRequestException
2228  * @throws ForbiddenException
2229  * @throws ImagickException
2230  * @throws InternalServerErrorException
2231  * @throws UnauthorizedException
2232  * @see   https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2233  */
2234 function api_statuses_user_timeline($type)
2235 {
2236         $a = DI::app();
2237         $user_info = api_get_user($a);
2238
2239         if (api_user() === false || $user_info === false) {
2240                 throw new ForbiddenException();
2241         }
2242
2243         Logger::info('api_statuses_user_timeline', ['api_user' => api_user(), 'user_info' => $user_info, '_REQUEST' => $_REQUEST]);
2244
2245         $since_id        = $_REQUEST['since_id'] ?? 0;
2246         $max_id          = $_REQUEST['max_id'] ?? 0;
2247         $exclude_replies = !empty($_REQUEST['exclude_replies']);
2248         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
2249
2250         // pagination
2251         $count = $_REQUEST['count'] ?? 20;
2252         $page  = $_REQUEST['page'] ?? 1;
2253
2254         $start = max(0, ($page - 1) * $count);
2255
2256         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `item`.`contact-id` = ?",
2257                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2258
2259         if ($user_info['self'] == 1) {
2260                 $condition[0] .= ' AND `item`.`wall` ';
2261         }
2262
2263         if ($exclude_replies) {
2264                 $condition[0] .= ' AND `item`.`gravity` = ?';
2265                 $condition[] = GRAVITY_PARENT;
2266         }
2267
2268         if ($conversation_id > 0) {
2269                 $condition[0] .= " AND `item`.`parent` = ?";
2270                 $condition[] = $conversation_id;
2271         }
2272
2273         if ($max_id > 0) {
2274                 $condition[0] .= " AND `item`.`id` <= ?";
2275                 $condition[] = $max_id;
2276         }
2277
2278         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2279         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2280
2281         $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type);
2282
2283         bindComments($ret);
2284
2285         $data = ['status' => $ret];
2286         switch ($type) {
2287                 case "atom":
2288                         break;
2289                 case "rss":
2290                         $data = api_rss_extra($a, $data, $user_info);
2291                         break;
2292         }
2293
2294         return api_format_data("statuses", $type, $data);
2295 }
2296
2297 /// @TODO move to top of file or somewhere better
2298 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2299
2300 /**
2301  * Star/unstar an item.
2302  * param: id : id of the item
2303  *
2304  * @param string $type Return type (atom, rss, xml, json)
2305  *
2306  * @return array|string
2307  * @throws BadRequestException
2308  * @throws ForbiddenException
2309  * @throws ImagickException
2310  * @throws InternalServerErrorException
2311  * @throws UnauthorizedException
2312  * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2313  */
2314 function api_favorites_create_destroy($type)
2315 {
2316         $a = DI::app();
2317
2318         if (api_user() === false) {
2319                 throw new ForbiddenException();
2320         }
2321
2322         // for versioned api.
2323         /// @TODO We need a better global soluton
2324         $action_argv_id = 2;
2325         if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2326                 $action_argv_id = 3;
2327         }
2328
2329         if ($a->argc <= $action_argv_id) {
2330                 throw new BadRequestException("Invalid request.");
2331         }
2332         $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2333         if ($a->argc == $action_argv_id + 2) {
2334                 $itemid = intval($a->argv[$action_argv_id + 1] ?? 0);
2335         } else {
2336                 $itemid = intval($_REQUEST['id'] ?? 0);
2337         }
2338
2339         $item = Item::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2340
2341         if (!DBA::isResult($item)) {
2342                 throw new BadRequestException("Invalid item.");
2343         }
2344
2345         switch ($action) {
2346                 case "create":
2347                         $item['starred'] = 1;
2348                         break;
2349                 case "destroy":
2350                         $item['starred'] = 0;
2351                         break;
2352                 default:
2353                         throw new BadRequestException("Invalid action ".$action);
2354         }
2355
2356         $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2357
2358         if ($r === false) {
2359                 throw new InternalServerErrorException("DB error");
2360         }
2361
2362
2363         $user_info = api_get_user($a);
2364         $rets = api_format_items([$item], $user_info, false, $type);
2365         $ret = $rets[0];
2366
2367         $data = ['status' => $ret];
2368         switch ($type) {
2369                 case "atom":
2370                         break;
2371                 case "rss":
2372                         $data = api_rss_extra($a, $data, $user_info);
2373                         break;
2374         }
2375
2376         return api_format_data("status", $type, $data);
2377 }
2378
2379 /// @TODO move to top of file or somewhere better
2380 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2381 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2382
2383 /**
2384  * Returns the most recent favorite statuses.
2385  *
2386  * @param string $type Return type (atom, rss, xml, json)
2387  *
2388  * @return string|array
2389  * @throws BadRequestException
2390  * @throws ForbiddenException
2391  * @throws ImagickException
2392  * @throws InternalServerErrorException
2393  * @throws UnauthorizedException
2394  */
2395 function api_favorites($type)
2396 {
2397         global $called_api;
2398
2399         $a = DI::app();
2400         $user_info = api_get_user($a);
2401
2402         if (api_user() === false || $user_info === false) {
2403                 throw new ForbiddenException();
2404         }
2405
2406         $called_api = [];
2407
2408         // in friendica starred item are private
2409         // return favorites only for self
2410         Logger::info(API_LOG_PREFIX . 'for {self}', ['module' => 'api', 'action' => 'favorites', 'self' => $user_info['self']]);
2411
2412         if ($user_info['self'] == 0) {
2413                 $ret = [];
2414         } else {
2415                 // params
2416                 $since_id = $_REQUEST['since_id'] ?? 0;
2417                 $max_id = $_REQUEST['max_id'] ?? 0;
2418                 $count = $_GET['count'] ?? 20;
2419                 $page = $_REQUEST['page'] ?? 1;
2420
2421                 $start = max(0, ($page - 1) * $count);
2422
2423                 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2424                         api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2425
2426                 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2427
2428                 if ($max_id > 0) {
2429                         $condition[0] .= " AND `item`.`id` <= ?";
2430                         $condition[] = $max_id;
2431                 }
2432
2433                 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2434
2435                 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2436         }
2437
2438         bindComments($ret);
2439
2440         $data = ['status' => $ret];
2441         switch ($type) {
2442                 case "atom":
2443                         break;
2444                 case "rss":
2445                         $data = api_rss_extra($a, $data, $user_info);
2446                         break;
2447         }
2448
2449         return api_format_data("statuses", $type, $data);
2450 }
2451
2452 /// @TODO move to top of file or somewhere better
2453 api_register_func('api/favorites', 'api_favorites', true);
2454
2455 /**
2456  *
2457  * @param array $item
2458  * @param array $recipient
2459  * @param array $sender
2460  *
2461  * @return array
2462  * @throws InternalServerErrorException
2463  */
2464 function api_format_messages($item, $recipient, $sender)
2465 {
2466         // standard meta information
2467         $ret = [
2468                 'id'                    => $item['id'],
2469                 'sender_id'             => $sender['id'],
2470                 'text'                  => "",
2471                 'recipient_id'          => $recipient['id'],
2472                 'created_at'            => api_date($item['created'] ?? DateTimeFormat::utcNow()),
2473                 'sender_screen_name'    => $sender['screen_name'],
2474                 'recipient_screen_name' => $recipient['screen_name'],
2475                 'sender'                => $sender,
2476                 'recipient'             => $recipient,
2477                 'title'                 => "",
2478                 'friendica_seen'        => $item['seen'] ?? 0,
2479                 'friendica_parent_uri'  => $item['parent-uri'] ?? '',
2480         ];
2481
2482         // "uid" and "self" are only needed for some internal stuff, so remove it from here
2483         if (isset($ret['sender']['uid'])) {
2484                 unset($ret['sender']['uid']);
2485         }
2486         if (isset($ret['sender']['self'])) {
2487                 unset($ret['sender']['self']);
2488         }
2489         if (isset($ret['recipient']['uid'])) {
2490                 unset($ret['recipient']['uid']);
2491         }
2492         if (isset($ret['recipient']['self'])) {
2493                 unset($ret['recipient']['self']);
2494         }
2495
2496         //don't send title to regular StatusNET requests to avoid confusing these apps
2497         if (!empty($_GET['getText'])) {
2498                 $ret['title'] = $item['title'];
2499                 if ($_GET['getText'] == 'html') {
2500                         $ret['text'] = BBCode::convert($item['body'], false);
2501                 } elseif ($_GET['getText'] == 'plain') {
2502                         $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, BBCode::API, true), 0));
2503                 }
2504         } else {
2505                 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, BBCode::API, true), 0);
2506         }
2507         if (!empty($_GET['getUserObjects']) && $_GET['getUserObjects'] == 'false') {
2508                 unset($ret['sender']);
2509                 unset($ret['recipient']);
2510         }
2511
2512         return $ret;
2513 }
2514
2515 /**
2516  *
2517  * @param array $item
2518  *
2519  * @return array
2520  * @throws InternalServerErrorException
2521  */
2522 function api_convert_item($item)
2523 {
2524         $body = $item['body'];
2525         $entities = api_get_entitities($statustext, $body);
2526
2527         // Add pictures to the attachment array and remove them from the body
2528         $attachments = api_get_attachments($body);
2529
2530         // Workaround for ostatus messages where the title is identically to the body
2531         $html = BBCode::convert(api_clean_plain_items($body), false, BBCode::API, true);
2532         $statusbody = trim(HTML::toPlaintext($html, 0));
2533
2534         // handle data: images
2535         $statusbody = api_format_items_embeded_images($item, $statusbody);
2536
2537         $statustitle = trim($item['title']);
2538
2539         if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2540                 $statustext = trim($statusbody);
2541         } else {
2542                 $statustext = trim($statustitle."\n\n".$statusbody);
2543         }
2544
2545         if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (mb_strlen($statustext)> 1000)) {
2546                 $statustext = mb_substr($statustext, 0, 1000) . "... \n" . ($item['plink'] ?? '');
2547         }
2548
2549         $statushtml = BBCode::convert(BBCode::removeAttachment($body), false);
2550
2551         // Workaround for clients with limited HTML parser functionality
2552         $search = ["<br>", "<blockquote>", "</blockquote>",
2553                         "<h1>", "</h1>", "<h2>", "</h2>",
2554                         "<h3>", "</h3>", "<h4>", "</h4>",
2555                         "<h5>", "</h5>", "<h6>", "</h6>"];
2556         $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2557                         "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2558                         "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2559                         "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2560         $statushtml = str_replace($search, $replace, $statushtml);
2561
2562         if ($item['title'] != "") {
2563                 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2564         }
2565
2566         do {
2567                 $oldtext = $statushtml;
2568                 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2569         } while ($oldtext != $statushtml);
2570
2571         if (substr($statushtml, 0, 4) == '<br>') {
2572                 $statushtml = substr($statushtml, 4);
2573         }
2574
2575         if (substr($statushtml, 0, -4) == '<br>') {
2576                 $statushtml = substr($statushtml, -4);
2577         }
2578
2579         // feeds without body should contain the link
2580         if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2581                 $statushtml .= BBCode::convert($item['plink']);
2582         }
2583
2584         return [
2585                 "text" => $statustext,
2586                 "html" => $statushtml,
2587                 "attachments" => $attachments,
2588                 "entities" => $entities
2589         ];
2590 }
2591
2592 /**
2593  *
2594  * @param string $body
2595  *
2596  * @return array
2597  * @throws InternalServerErrorException
2598  */
2599 function api_get_attachments(&$body)
2600 {
2601         $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
2602         $body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $body);
2603
2604         $URLSearchString = "^\[\]";
2605         if (!preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $body, $images)) {
2606                 return [];
2607         }
2608
2609         // Remove all embedded pictures, since they are added as attachments
2610         foreach ($images[0] as $orig) {
2611                 $body = str_replace($orig, '', $body);
2612         }
2613
2614         $attachments = [];
2615
2616         foreach ($images[1] as $image) {
2617                 $imagedata = Images::getInfoFromURLCached($image);
2618
2619                 if ($imagedata) {
2620                         $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2621                 }
2622         }
2623
2624         return $attachments;
2625 }
2626
2627 /**
2628  *
2629  * @param string $text
2630  * @param string $bbcode
2631  *
2632  * @return array
2633  * @throws InternalServerErrorException
2634  * @todo Links at the first character of the post
2635  */
2636 function api_get_entitities(&$text, $bbcode)
2637 {
2638         $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
2639
2640         if ($include_entities != "true") {
2641                 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2642
2643                 foreach ($images[1] as $image) {
2644                         $replace = ProxyUtils::proxifyUrl($image);
2645                         $text = str_replace($image, $replace, $text);
2646                 }
2647                 return [];
2648         }
2649
2650         $bbcode = BBCode::cleanPictureLinks($bbcode);
2651
2652         // Change pure links in text to bbcode uris
2653         $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2654
2655         $entities = [];
2656         $entities["hashtags"] = [];
2657         $entities["symbols"] = [];
2658         $entities["urls"] = [];
2659         $entities["user_mentions"] = [];
2660
2661         $URLSearchString = "^\[\]";
2662
2663         $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2664
2665         $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2666         $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2667
2668         $bbcode = preg_replace(
2669                 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2670                 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2671                 $bbcode
2672         );
2673         $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2674
2675         $bbcode = preg_replace(
2676                 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2677                 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2678                 $bbcode
2679         );
2680         $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2681
2682         $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2683
2684         preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2685
2686         $ordered_urls = [];
2687         foreach ($urls[1] as $id => $url) {
2688                 $start = iconv_strpos($text, $url, 0, "UTF-8");
2689                 if (!($start === false)) {
2690                         $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2691                 }
2692         }
2693
2694         ksort($ordered_urls);
2695
2696         $offset = 0;
2697
2698         foreach ($ordered_urls as $url) {
2699                 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2700                         && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2701                 ) {
2702                         $display_url = $url["title"];
2703                 } else {
2704                         $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2705                         $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2706
2707                         if (strlen($display_url) > 26) {
2708                                 $display_url = substr($display_url, 0, 25)."…";
2709                         }
2710                 }
2711
2712                 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2713                 if (!($start === false)) {
2714                         $entities["urls"][] = ["url" => $url["url"],
2715                                                         "expanded_url" => $url["url"],
2716                                                         "display_url" => $display_url,
2717                                                         "indices" => [$start, $start+strlen($url["url"])]];
2718                         $offset = $start + 1;
2719                 }
2720         }
2721
2722         preg_match_all("/\[img\=(.*?)\](.*?)\[\/img\]/ism", $bbcode, $images, PREG_SET_ORDER);
2723         $ordered_images = [];
2724         foreach ($images as $image) {
2725                 $start = iconv_strpos($text, $image[1], 0, "UTF-8");
2726                 if (!($start === false)) {
2727                         $ordered_images[$start] = ['url' => $image[1], 'alt' => $image[2]];
2728                 }
2729         }
2730
2731         preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2732         foreach ($images[1] as $image) {
2733                 $start = iconv_strpos($text, $image, 0, "UTF-8");
2734                 if (!($start === false)) {
2735                         $ordered_images[$start] = ['url' => $image, 'alt' => ''];
2736                 }
2737         }
2738
2739         $offset = 0;
2740
2741         foreach ($ordered_images as $image) {
2742                 $url = $image['url'];
2743                 $ext_alt_text = $image['alt'];
2744
2745                 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2746                 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2747
2748                 if (strlen($display_url) > 26) {
2749                         $display_url = substr($display_url, 0, 25)."…";
2750                 }
2751
2752                 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2753                 if (!($start === false)) {
2754                         $image = Images::getInfoFromURLCached($url);
2755                         if ($image) {
2756                                 // If image cache is activated, then use the following sizes:
2757                                 // thumb  (150), small (340), medium (600) and large (1024)
2758                                 if (!DI::config()->get("system", "proxy_disabled")) {
2759                                         $media_url = ProxyUtils::proxifyUrl($url);
2760
2761                                         $sizes = [];
2762                                         $scale = Images::getScalingDimensions($image[0], $image[1], 150);
2763                                         $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2764
2765                                         if (($image[0] > 150) || ($image[1] > 150)) {
2766                                                 $scale = Images::getScalingDimensions($image[0], $image[1], 340);
2767                                                 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2768                                         }
2769
2770                                         $scale = Images::getScalingDimensions($image[0], $image[1], 600);
2771                                         $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2772
2773                                         if (($image[0] > 600) || ($image[1] > 600)) {
2774                                                 $scale = Images::getScalingDimensions($image[0], $image[1], 1024);
2775                                                 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2776                                         }
2777                                 } else {
2778                                         $media_url = $url;
2779                                         $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2780                                 }
2781
2782                                 $entities["media"][] = [
2783                                                         "id" => $start+1,
2784                                                         "id_str" => (string) ($start + 1),
2785                                                         "indices" => [$start, $start+strlen($url)],
2786                                                         "media_url" => Strings::normaliseLink($media_url),
2787                                                         "media_url_https" => $media_url,
2788                                                         "url" => $url,
2789                                                         "display_url" => $display_url,
2790                                                         "expanded_url" => $url,
2791                                                         "ext_alt_text" => $ext_alt_text,
2792                                                         "type" => "photo",
2793                                                         "sizes" => $sizes];
2794                         }
2795                         $offset = $start + 1;
2796                 }
2797         }
2798
2799         return $entities;
2800 }
2801
2802 /**
2803  *
2804  * @param array $item
2805  * @param string $text
2806  *
2807  * @return string
2808  */
2809 function api_format_items_embeded_images($item, $text)
2810 {
2811         $text = preg_replace_callback(
2812                 '|data:image/([^;]+)[^=]+=*|m',
2813                 function () use ($item) {
2814                         return DI::baseUrl() . '/display/' . $item['guid'];
2815                 },
2816                 $text
2817         );
2818         return $text;
2819 }
2820
2821 /**
2822  * return <a href='url'>name</a> as array
2823  *
2824  * @param string $txt text
2825  * @return array
2826  *                      'name' => 'name',
2827  *                      'url => 'url'
2828  */
2829 function api_contactlink_to_array($txt)
2830 {
2831         $match = [];
2832         $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2833         if ($r && count($match)==3) {
2834                 $res = [
2835                         'name' => $match[2],
2836                         'url' => $match[1]
2837                 ];
2838         } else {
2839                 $res = [
2840                         'name' => $txt,
2841                         'url' => ""
2842                 ];
2843         }
2844         return $res;
2845 }
2846
2847
2848 /**
2849  * return likes, dislikes and attend status for item
2850  *
2851  * @param array  $item array
2852  * @param string $type Return type (atom, rss, xml, json)
2853  *
2854  * @return array
2855  *            likes => int count,
2856  *            dislikes => int count
2857  * @throws BadRequestException
2858  * @throws ImagickException
2859  * @throws InternalServerErrorException
2860  * @throws UnauthorizedException
2861  */
2862 function api_format_items_activities($item, $type = "json")
2863 {
2864         $a = DI::app();
2865
2866         $activities = [
2867                 'like' => [],
2868                 'dislike' => [],
2869                 'attendyes' => [],
2870                 'attendno' => [],
2871                 'attendmaybe' => [],
2872                 'announce' => [],
2873         ];
2874
2875         $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY];
2876         $ret = Item::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2877
2878         while ($parent_item = Item::fetch($ret)) {
2879                 // not used as result should be structured like other user data
2880                 //builtin_activity_puller($i, $activities);
2881
2882                 // get user data and add it to the array of the activity
2883                 $user = api_get_user($a, $parent_item['author-id']);
2884                 switch ($parent_item['verb']) {
2885                         case Activity::LIKE:
2886                                 $activities['like'][] = $user;
2887                                 break;
2888                         case Activity::DISLIKE:
2889                                 $activities['dislike'][] = $user;
2890                                 break;
2891                         case Activity::ATTEND:
2892                                 $activities['attendyes'][] = $user;
2893                                 break;
2894                         case Activity::ATTENDNO:
2895                                 $activities['attendno'][] = $user;
2896                                 break;
2897                         case Activity::ATTENDMAYBE:
2898                                 $activities['attendmaybe'][] = $user;
2899                                 break;
2900                         case Activity::ANNOUNCE:
2901                                 $activities['announce'][] = $user;
2902                                 break;
2903                         default:
2904                                 break;
2905                 }
2906         }
2907
2908         DBA::close($ret);
2909
2910         if ($type == "xml") {
2911                 $xml_activities = [];
2912                 foreach ($activities as $k => $v) {
2913                         // change xml element from "like" to "friendica:like"
2914                         $xml_activities["friendica:".$k] = $v;
2915                         // add user data into xml output
2916                         $k_user = 0;
2917                         foreach ($v as $user) {
2918                                 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2919                         }
2920                 }
2921                 $activities = $xml_activities;
2922         }
2923
2924         return $activities;
2925 }
2926
2927 /**
2928  * format items to be returned by api
2929  *
2930  * @param array  $items       array of items
2931  * @param array  $user_info
2932  * @param bool   $filter_user filter items by $user_info
2933  * @param string $type        Return type (atom, rss, xml, json)
2934  * @return array
2935  * @throws BadRequestException
2936  * @throws ImagickException
2937  * @throws InternalServerErrorException
2938  * @throws UnauthorizedException
2939  */
2940 function api_format_items($items, $user_info, $filter_user = false, $type = "json")
2941 {
2942         $a = Friendica\DI::app();
2943
2944         $ret = [];
2945
2946         foreach ((array)$items as $item) {
2947                 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
2948
2949                 // Look if the posts are matching if they should be filtered by user id
2950                 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2951                         continue;
2952                 }
2953
2954                 $status = api_format_item($item, $type, $status_user, $author_user, $owner_user);
2955
2956                 $ret[] = $status;
2957         }
2958
2959         return $ret;
2960 }
2961
2962 /**
2963  * @param array  $item       Item record
2964  * @param string $type       Return format (atom, rss, xml, json)
2965  * @param array $status_user User record of the item author, can be provided by api_item_get_user()
2966  * @param array $author_user User record of the item author, can be provided by api_item_get_user()
2967  * @param array $owner_user  User record of the item owner, can be provided by api_item_get_user()
2968  * @return array API-formatted status
2969  * @throws BadRequestException
2970  * @throws ImagickException
2971  * @throws InternalServerErrorException
2972  * @throws UnauthorizedException
2973  */
2974 function api_format_item($item, $type = "json", $status_user = null, $author_user = null, $owner_user = null)
2975 {
2976         $a = Friendica\DI::app();
2977
2978         if (empty($status_user) || empty($author_user) || empty($owner_user)) {
2979                 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
2980         }
2981
2982         localize_item($item);
2983
2984         $in_reply_to = api_in_reply_to($item);
2985
2986         $converted = api_convert_item($item);
2987
2988         if ($type == "xml") {
2989                 $geo = "georss:point";
2990         } else {
2991                 $geo = "geo";
2992         }
2993
2994         $status = [
2995                 'text'          => $converted["text"],
2996                 'truncated' => false,
2997                 'created_at'=> api_date($item['created']),
2998                 'in_reply_to_status_id' => $in_reply_to['status_id'],
2999                 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
3000                 'source'    => (($item['app']) ? $item['app'] : 'web'),
3001                 'id'            => intval($item['id']),
3002                 'id_str'        => (string) intval($item['id']),
3003                 'in_reply_to_user_id' => $in_reply_to['user_id'],
3004                 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
3005                 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
3006                 $geo => null,
3007                 'favorited' => $item['starred'] ? true : false,
3008                 'user' =>  $status_user,
3009                 'friendica_author' => $author_user,
3010                 'friendica_owner' => $owner_user,
3011                 'friendica_private' => $item['private'] == Item::PRIVATE,
3012                 //'entities' => NULL,
3013                 'statusnet_html' => $converted["html"],
3014                 'statusnet_conversation_id' => $item['parent'],
3015                 'external_url' => DI::baseUrl() . "/display/" . $item['guid'],
3016                 'friendica_activities' => api_format_items_activities($item, $type),
3017                 'friendica_title' => $item['title'],
3018                 'friendica_html' => BBCode::convert($item['body'], false)
3019         ];
3020
3021         if (count($converted["attachments"]) > 0) {
3022                 $status["attachments"] = $converted["attachments"];
3023         }
3024
3025         if (count($converted["entities"]) > 0) {
3026                 $status["entities"] = $converted["entities"];
3027         }
3028
3029         if ($status["source"] == 'web') {
3030                 $status["source"] = ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']);
3031         } elseif (ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']) != $status["source"]) {
3032                 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']).')');
3033         }
3034
3035         $retweeted_item = [];
3036         $quoted_item = [];
3037
3038         if ($item['gravity'] == GRAVITY_PARENT) {
3039                 $body = $item['body'];
3040                 $retweeted_item = api_share_as_retweet($item);
3041                 if ($body != $item['body']) {
3042                         $quoted_item = $retweeted_item;
3043                         $retweeted_item = [];
3044                 }
3045         }
3046
3047         if (empty($retweeted_item) && ($item['owner-id'] == $item['author-id'])) {
3048                 $announce = api_get_announce($item);
3049                 if (!empty($announce)) {
3050                         $retweeted_item = $item;
3051                         $item = $announce;
3052                         $status['friendica_owner'] = api_get_user($a, $announce['author-id']);
3053                 }
3054         }
3055
3056         if (!empty($quoted_item)) {
3057                 if ($quoted_item['id'] != $item['id']) {
3058                         $quoted_status = api_format_item($quoted_item);
3059                         /// @todo Only remove the attachments that are also contained in the quotes status
3060                         unset($status['attachments']);
3061                         unset($status['entities']);
3062                 } else {
3063                         $conv_quoted = api_convert_item($quoted_item);
3064                         $quoted_status = $status;
3065                         unset($quoted_status['attachments']);
3066                         unset($quoted_status['entities']);
3067                         unset($quoted_status['statusnet_conversation_id']);
3068                         $quoted_status['text'] = $conv_quoted['text'];
3069                         $quoted_status['statusnet_html'] = $conv_quoted['html'];
3070                         try {
3071                                 $quoted_status["user"] = api_get_user($a, $quoted_item["author-id"]);
3072                         } catch (BadRequestException $e) {
3073                                 // user not found. should be found?
3074                                 /// @todo check if the user should be always found
3075                                 $quoted_status["user"] = [];
3076                         }
3077                 }
3078                 unset($quoted_status['friendica_author']);
3079                 unset($quoted_status['friendica_owner']);
3080                 unset($quoted_status['friendica_activities']);
3081                 unset($quoted_status['friendica_private']);
3082         }
3083
3084         if (!empty($retweeted_item)) {
3085                 $retweeted_status = $status;
3086                 unset($retweeted_status['friendica_author']);
3087                 unset($retweeted_status['friendica_owner']);
3088                 unset($retweeted_status['friendica_activities']);
3089                 unset($retweeted_status['friendica_private']);
3090                 unset($retweeted_status['statusnet_conversation_id']);
3091                 $status['user'] = $status['friendica_owner'];
3092                 try {
3093                         $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
3094                 } catch (BadRequestException $e) {
3095                         // user not found. should be found?
3096                         /// @todo check if the user should be always found
3097                         $retweeted_status["user"] = [];
3098                 }
3099
3100                 $rt_converted = api_convert_item($retweeted_item);
3101
3102                 $retweeted_status['text'] = $rt_converted["text"];
3103                 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3104                 $retweeted_status['created_at'] =  api_date($retweeted_item['created']);
3105
3106                 if (!empty($quoted_status)) {
3107                         $retweeted_status['quoted_status'] = $quoted_status;
3108                 }
3109
3110                 $status['friendica_author'] = $retweeted_status['user'];
3111                 $status['retweeted_status'] = $retweeted_status;
3112         } elseif (!empty($quoted_status)) {
3113                 $root_status = api_convert_item($item);
3114
3115                 $status['text'] = $root_status["text"];
3116                 $status['statusnet_html'] = $root_status["html"];
3117                 $status['quoted_status'] = $quoted_status;
3118         }
3119
3120         // "uid" and "self" are only needed for some internal stuff, so remove it from here
3121         unset($status["user"]["uid"]);
3122         unset($status["user"]["self"]);
3123
3124         if ($item["coord"] != "") {
3125                 $coords = explode(' ', $item["coord"]);
3126                 if (count($coords) == 2) {
3127                         if ($type == "json") {
3128                                 $status["geo"] = ['type' => 'Point',
3129                                         'coordinates' => [(float) $coords[0],
3130                                                 (float) $coords[1]]];
3131                         } else {// Not sure if this is the official format - if someone founds a documentation we can check
3132                                 $status["georss:point"] = $item["coord"];
3133                         }
3134                 }
3135         }
3136
3137         return $status;
3138 }
3139
3140 /**
3141  * Returns the remaining number of API requests available to the user before the API limit is reached.
3142  *
3143  * @param string $type Return type (atom, rss, xml, json)
3144  *
3145  * @return array|string
3146  * @throws Exception
3147  */
3148 function api_account_rate_limit_status($type)
3149 {
3150         if ($type == "xml") {
3151                 $hash = [
3152                                 'remaining-hits' => '150',
3153                                 '@attributes' => ["type" => "integer"],
3154                                 'hourly-limit' => '150',
3155                                 '@attributes2' => ["type" => "integer"],
3156                                 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
3157                                 '@attributes3' => ["type" => "datetime"],
3158                                 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3159                                 '@attributes4' => ["type" => "integer"],
3160                         ];
3161         } else {
3162                 $hash = [
3163                                 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3164                                 'remaining_hits' => '150',
3165                                 'hourly_limit' => '150',
3166                                 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
3167                         ];
3168         }
3169
3170         return api_format_data('hash', $type, ['hash' => $hash]);
3171 }
3172
3173 /// @TODO move to top of file or somewhere better
3174 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3175
3176 /**
3177  * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3178  *
3179  * @param string $type Return type (atom, rss, xml, json)
3180  *
3181  * @return array|string
3182  */
3183 function api_help_test($type)
3184 {
3185         if ($type == 'xml') {
3186                 $ok = "true";
3187         } else {
3188                 $ok = "ok";
3189         }
3190
3191         return api_format_data('ok', $type, ["ok" => $ok]);
3192 }
3193
3194 /// @TODO move to top of file or somewhere better
3195 api_register_func('api/help/test', 'api_help_test', false);
3196
3197 /**
3198  * Returns all lists the user subscribes to.
3199  *
3200  * @param string $type Return type (atom, rss, xml, json)
3201  *
3202  * @return array|string
3203  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3204  */
3205 function api_lists_list($type)
3206 {
3207         $ret = [];
3208         /// @TODO $ret is not filled here?
3209         return api_format_data('lists', $type, ["lists_list" => $ret]);
3210 }
3211
3212 /// @TODO move to top of file or somewhere better
3213 api_register_func('api/lists/list', 'api_lists_list', true);
3214 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3215
3216 /**
3217  * Returns all groups the user owns.
3218  *
3219  * @param string $type Return type (atom, rss, xml, json)
3220  *
3221  * @return array|string
3222  * @throws BadRequestException
3223  * @throws ForbiddenException
3224  * @throws ImagickException
3225  * @throws InternalServerErrorException
3226  * @throws UnauthorizedException
3227  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3228  */
3229 function api_lists_ownerships($type)
3230 {
3231         $a = DI::app();
3232
3233         if (api_user() === false) {
3234                 throw new ForbiddenException();
3235         }
3236
3237         // params
3238         $user_info = api_get_user($a);
3239         $uid = $user_info['uid'];
3240
3241         $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3242
3243         // loop through all groups
3244         $lists = [];
3245         foreach ($groups as $group) {
3246                 if ($group['visible']) {
3247                         $mode = 'public';
3248                 } else {
3249                         $mode = 'private';
3250                 }
3251                 $lists[] = [
3252                         'name' => $group['name'],
3253                         'id' => intval($group['id']),
3254                         'id_str' => (string) $group['id'],
3255                         'user' => $user_info,
3256                         'mode' => $mode
3257                 ];
3258         }
3259         return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3260 }
3261
3262 /// @TODO move to top of file or somewhere better
3263 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3264
3265 /**
3266  * Returns recent statuses from users in the specified group.
3267  *
3268  * @param string $type Return type (atom, rss, xml, json)
3269  *
3270  * @return array|string
3271  * @throws BadRequestException
3272  * @throws ForbiddenException
3273  * @throws ImagickException
3274  * @throws InternalServerErrorException
3275  * @throws UnauthorizedException
3276  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3277  */
3278 function api_lists_statuses($type)
3279 {
3280         $a = DI::app();
3281
3282         $user_info = api_get_user($a);
3283         if (api_user() === false || $user_info === false) {
3284                 throw new ForbiddenException();
3285         }
3286
3287         unset($_REQUEST["user_id"]);
3288         unset($_GET["user_id"]);
3289
3290         unset($_REQUEST["screen_name"]);
3291         unset($_GET["screen_name"]);
3292
3293         if (empty($_REQUEST['list_id'])) {
3294                 throw new BadRequestException('list_id not specified');
3295         }
3296
3297         // params
3298         $count = $_REQUEST['count'] ?? 20;
3299         $page = $_REQUEST['page'] ?? 1;
3300         $since_id = $_REQUEST['since_id'] ?? 0;
3301         $max_id = $_REQUEST['max_id'] ?? 0;
3302         $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
3303         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
3304
3305         $start = max(0, ($page - 1) * $count);
3306
3307         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3308                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3309
3310         if ($max_id > 0) {
3311                 $condition[0] .= " AND `item`.`id` <= ?";
3312                 $condition[] = $max_id;
3313         }
3314         if ($exclude_replies > 0) {
3315                 $condition[0] .= ' AND `item`.`gravity` = ?';
3316                 $condition[] = GRAVITY_PARENT;
3317         }
3318         if ($conversation_id > 0) {
3319                 $condition[0] .= " AND `item`.`parent` = ?";
3320                 $condition[] = $conversation_id;
3321         }
3322
3323         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3324         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3325
3326         $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3327
3328         $data = ['status' => $items];
3329         switch ($type) {
3330                 case "atom":
3331                         break;
3332                 case "rss":
3333                         $data = api_rss_extra($a, $data, $user_info);
3334                         break;
3335         }
3336
3337         return api_format_data("statuses", $type, $data);
3338 }
3339
3340 /// @TODO move to top of file or somewhere better
3341 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3342
3343 /**
3344  * Returns either the friends of the follower list
3345  *
3346  * Considers friends and followers lists to be private and won't return
3347  * anything if any user_id parameter is passed.
3348  *
3349  * @param string $qtype Either "friends" or "followers"
3350  * @return boolean|array
3351  * @throws BadRequestException
3352  * @throws ForbiddenException
3353  * @throws ImagickException
3354  * @throws InternalServerErrorException
3355  * @throws UnauthorizedException
3356  */
3357 function api_statuses_f($qtype)
3358 {
3359         $a = DI::app();
3360
3361         if (api_user() === false) {
3362                 throw new ForbiddenException();
3363         }
3364
3365         // pagination
3366         $count = $_GET['count'] ?? 20;
3367         $page = $_GET['page'] ?? 1;
3368
3369         $start = max(0, ($page - 1) * $count);
3370
3371         $user_info = api_get_user($a);
3372
3373         if (!empty($_GET['cursor']) && $_GET['cursor'] == 'undefined') {
3374                 /* this is to stop Hotot to load friends multiple times
3375                 *  I'm not sure if I'm missing return something or
3376                 *  is a bug in hotot. Workaround, meantime
3377                 */
3378
3379                 /*$ret=Array();
3380                 return array('$users' => $ret);*/
3381                 return false;
3382         }
3383
3384         $sql_extra = '';
3385         if ($qtype == 'friends') {
3386                 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
3387         } elseif ($qtype == 'followers') {
3388                 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
3389         }
3390
3391         // friends and followers only for self
3392         if ($user_info['self'] == 0) {
3393                 $sql_extra = " AND false ";
3394         }
3395
3396         if ($qtype == 'blocks') {
3397                 $sql_filter = 'AND `blocked` AND NOT `pending`';
3398         } elseif ($qtype == 'incoming') {
3399                 $sql_filter = 'AND `pending`';
3400         } else {
3401                 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3402         }
3403
3404         $r = q(
3405                 "SELECT `nurl`
3406                 FROM `contact`
3407                 WHERE `uid` = %d
3408                 AND NOT `self`
3409                 $sql_filter
3410                 $sql_extra
3411                 ORDER BY `nick`
3412                 LIMIT %d, %d",
3413                 intval(api_user()),
3414                 intval($start),
3415                 intval($count)
3416         );
3417
3418         $ret = [];
3419         foreach ($r as $cid) {
3420                 $user = api_get_user($a, $cid['nurl']);
3421                 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3422                 unset($user["uid"]);
3423                 unset($user["self"]);
3424
3425                 if ($user) {
3426                         $ret[] = $user;
3427                 }
3428         }
3429
3430         return ['user' => $ret];
3431 }
3432
3433
3434 /**
3435  * Returns the list of friends of the provided user
3436  *
3437  * @deprecated By Twitter API in favor of friends/list
3438  *
3439  * @param string $type Either "json" or "xml"
3440  * @return boolean|string|array
3441  * @throws BadRequestException
3442  * @throws ForbiddenException
3443  */
3444 function api_statuses_friends($type)
3445 {
3446         $data =  api_statuses_f("friends");
3447         if ($data === false) {
3448                 return false;
3449         }
3450         return api_format_data("users", $type, $data);
3451 }
3452
3453 /**
3454  * Returns the list of followers of the provided user
3455  *
3456  * @deprecated By Twitter API in favor of friends/list
3457  *
3458  * @param string $type Either "json" or "xml"
3459  * @return boolean|string|array
3460  * @throws BadRequestException
3461  * @throws ForbiddenException
3462  */
3463 function api_statuses_followers($type)
3464 {
3465         $data = api_statuses_f("followers");
3466         if ($data === false) {
3467                 return false;
3468         }
3469         return api_format_data("users", $type, $data);
3470 }
3471
3472 /// @TODO move to top of file or somewhere better
3473 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3474 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3475
3476 /**
3477  * Returns the list of blocked users
3478  *
3479  * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3480  *
3481  * @param string $type Either "json" or "xml"
3482  *
3483  * @return boolean|string|array
3484  * @throws BadRequestException
3485  * @throws ForbiddenException
3486  */
3487 function api_blocks_list($type)
3488 {
3489         $data =  api_statuses_f('blocks');
3490         if ($data === false) {
3491                 return false;
3492         }
3493         return api_format_data("users", $type, $data);
3494 }
3495
3496 /// @TODO move to top of file or somewhere better
3497 api_register_func('api/blocks/list', 'api_blocks_list', true);
3498
3499 /**
3500  * Returns the list of pending users IDs
3501  *
3502  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3503  *
3504  * @param string $type Either "json" or "xml"
3505  *
3506  * @return boolean|string|array
3507  * @throws BadRequestException
3508  * @throws ForbiddenException
3509  */
3510 function api_friendships_incoming($type)
3511 {
3512         $data =  api_statuses_f('incoming');
3513         if ($data === false) {
3514                 return false;
3515         }
3516
3517         $ids = [];
3518         foreach ($data['user'] as $user) {
3519                 $ids[] = $user['id'];
3520         }
3521
3522         return api_format_data("ids", $type, ['id' => $ids]);
3523 }
3524
3525 /// @TODO move to top of file or somewhere better
3526 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3527
3528 /**
3529  * Returns the instance's configuration information.
3530  *
3531  * @param string $type Return type (atom, rss, xml, json)
3532  *
3533  * @return array|string
3534  * @throws InternalServerErrorException
3535  */
3536 function api_statusnet_config($type)
3537 {
3538         $name      = DI::config()->get('config', 'sitename');
3539         $server    = DI::baseUrl()->getHostname();
3540         $logo      = DI::baseUrl() . '/images/friendica-64.png';
3541         $email     = DI::config()->get('config', 'admin_email');
3542         $closed    = intval(DI::config()->get('config', 'register_policy')) === \Friendica\Module\Register::CLOSED ? 'true' : 'false';
3543         $private   = DI::config()->get('system', 'block_public') ? 'true' : 'false';
3544         $textlimit = (string) DI::config()->get('config', 'api_import_size', DI::config()->get('config', 'max_import_size', 200000));
3545         $ssl       = DI::config()->get('system', 'have_ssl') ? 'true' : 'false';
3546         $sslserver = DI::config()->get('system', 'have_ssl') ? str_replace('http:', 'https:', DI::baseUrl()) : '';
3547
3548         $config = [
3549                 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3550                         'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3551                         'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3552                         'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3553                         'shorturllength' => '30',
3554                         'friendica' => [
3555                                         'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3556                                         'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3557                                         'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3558                                         'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3559                                         ]
3560                 ],
3561         ];
3562
3563         return api_format_data('config', $type, ['config' => $config]);
3564 }
3565
3566 /// @TODO move to top of file or somewhere better
3567 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3568 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3569
3570 /**
3571  *
3572  * @param string $type Return type (atom, rss, xml, json)
3573  *
3574  * @return array|string
3575  */
3576 function api_statusnet_version($type)
3577 {
3578         // liar
3579         $fake_statusnet_version = "0.9.7";
3580
3581         return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3582 }
3583
3584 /// @TODO move to top of file or somewhere better
3585 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3586 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3587
3588 /**
3589  * Sends a new direct message.
3590  *
3591  * @param string $type Return type (atom, rss, xml, json)
3592  *
3593  * @return array|string
3594  * @throws BadRequestException
3595  * @throws ForbiddenException
3596  * @throws ImagickException
3597  * @throws InternalServerErrorException
3598  * @throws NotFoundException
3599  * @throws UnauthorizedException
3600  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3601  */
3602 function api_direct_messages_new($type)
3603 {
3604         $a = DI::app();
3605
3606         if (api_user() === false) {
3607                 throw new ForbiddenException();
3608         }
3609
3610         if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3611                 return;
3612         }
3613
3614         $sender = api_get_user($a);
3615
3616         $recipient = null;
3617         if (!empty($_POST['screen_name'])) {
3618                 $r = q(
3619                         "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3620                         intval(api_user()),
3621                         DBA::escape($_POST['screen_name'])
3622                 );
3623
3624                 if (DBA::isResult($r)) {
3625                         // Selecting the id by priority, friendica first
3626                         api_best_nickname($r);
3627
3628                         $recipient = api_get_user($a, $r[0]['nurl']);
3629                 }
3630         } else {
3631                 $recipient = api_get_user($a, $_POST['user_id']);
3632         }
3633
3634         if (empty($recipient)) {
3635                 throw new NotFoundException('Recipient not found');
3636         }
3637
3638         $replyto = '';
3639         if (!empty($_REQUEST['replyto'])) {
3640                 $r = q(
3641                         'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3642                         intval(api_user()),
3643                         intval($_REQUEST['replyto'])
3644                 );
3645                 $replyto = $r[0]['parent-uri'];
3646                 $sub     = $r[0]['title'];
3647         } else {
3648                 if (!empty($_REQUEST['title'])) {
3649                         $sub = $_REQUEST['title'];
3650                 } else {
3651                         $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3652                 }
3653         }
3654
3655         $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3656
3657         if ($id > -1) {
3658                 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3659                 $ret = api_format_messages($r[0], $recipient, $sender);
3660         } else {
3661                 $ret = ["error"=>$id];
3662         }
3663
3664         $data = ['direct_message'=>$ret];
3665
3666         switch ($type) {
3667                 case "atom":
3668                         break;
3669                 case "rss":
3670                         $data = api_rss_extra($a, $data, $sender);
3671                         break;
3672         }
3673
3674         return api_format_data("direct-messages", $type, $data);
3675 }
3676
3677 /// @TODO move to top of file or somewhere better
3678 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3679
3680 /**
3681  * delete a direct_message from mail table through api
3682  *
3683  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3684  * @return string|array
3685  * @throws BadRequestException
3686  * @throws ForbiddenException
3687  * @throws ImagickException
3688  * @throws InternalServerErrorException
3689  * @throws UnauthorizedException
3690  * @see   https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3691  */
3692 function api_direct_messages_destroy($type)
3693 {
3694         $a = DI::app();
3695
3696         if (api_user() === false) {
3697                 throw new ForbiddenException();
3698         }
3699
3700         // params
3701         $user_info = api_get_user($a);
3702         //required
3703         $id = $_REQUEST['id'] ?? 0;
3704         // optional
3705         $parenturi = $_REQUEST['friendica_parenturi'] ?? '';
3706         $verbose = (!empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false");
3707         /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3708
3709         $uid = $user_info['uid'];
3710         // error if no id or parenturi specified (for clients posting parent-uri as well)
3711         if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3712                 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3713                 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3714         }
3715
3716         // BadRequestException if no id specified (for clients using Twitter API)
3717         if ($id == 0) {
3718                 throw new BadRequestException('Message id not specified');
3719         }
3720
3721         // add parent-uri to sql command if specified by calling app
3722         $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3723
3724         // get data of the specified message id
3725         $r = q(
3726                 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3727                 intval($uid),
3728                 intval($id)
3729         );
3730
3731         // error message if specified id is not in database
3732         if (!DBA::isResult($r)) {
3733                 if ($verbose == "true") {
3734                         $answer = ['result' => 'error', 'message' => 'message id not in database'];
3735                         return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3736                 }
3737                 /// @todo BadRequestException ok for Twitter API clients?
3738                 throw new BadRequestException('message id not in database');
3739         }
3740
3741         // delete message
3742         $result = q(
3743                 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3744                 intval($uid),
3745                 intval($id)
3746         );
3747
3748         if ($verbose == "true") {
3749                 if ($result) {
3750                         // return success
3751                         $answer = ['result' => 'ok', 'message' => 'message deleted'];
3752                         return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3753                 } else {
3754                         $answer = ['result' => 'error', 'message' => 'unknown error'];
3755                         return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3756                 }
3757         }
3758         /// @todo return JSON data like Twitter API not yet implemented
3759 }
3760
3761 /// @TODO move to top of file or somewhere better
3762 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3763
3764 /**
3765  * Unfollow Contact
3766  *
3767  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3768  * @return string|array
3769  * @throws BadRequestException
3770  * @throws ForbiddenException
3771  * @throws ImagickException
3772  * @throws InternalServerErrorException
3773  * @throws NotFoundException
3774  * @see   https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3775  */
3776 function api_friendships_destroy($type)
3777 {
3778         $uid = api_user();
3779
3780         if ($uid === false) {
3781                 throw new ForbiddenException();
3782         }
3783
3784         $contact_id = $_REQUEST['user_id'] ?? 0;
3785
3786         if (empty($contact_id)) {
3787                 Logger::notice(API_LOG_PREFIX . 'No user_id specified', ['module' => 'api', 'action' => 'friendships_destroy']);
3788                 throw new BadRequestException("no user_id specified");
3789         }
3790
3791         // Get Contact by given id
3792         $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3793
3794         if(!DBA::isResult($contact)) {
3795                 Logger::notice(API_LOG_PREFIX . 'No contact found for ID {contact}', ['module' => 'api', 'action' => 'friendships_destroy', 'contact' => $contact_id]);
3796                 throw new NotFoundException("no contact found to given ID");
3797         }
3798
3799         $url = $contact["url"];
3800
3801         $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3802                         $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url),
3803                         Strings::normaliseLink($url), $url];
3804         $contact = DBA::selectFirst('contact', [], $condition);
3805
3806         if (!DBA::isResult($contact)) {
3807                 Logger::notice(API_LOG_PREFIX . 'Not following contact', ['module' => 'api', 'action' => 'friendships_destroy']);
3808                 throw new NotFoundException("Not following Contact");
3809         }
3810
3811         if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
3812                 Logger::notice(API_LOG_PREFIX . 'Not supported for {network}', ['module' => 'api', 'action' => 'friendships_destroy', 'network' => $contact['network']]);
3813                 throw new ExpectationFailedException("Not supported");
3814         }
3815
3816         $dissolve = ($contact['rel'] == Contact::SHARING);
3817
3818         $owner = User::getOwnerDataById($uid);
3819         if ($owner) {
3820                 Contact::terminateFriendship($owner, $contact, $dissolve);
3821         }
3822         else {
3823                 Logger::notice(API_LOG_PREFIX . 'No owner {uid} found', ['module' => 'api', 'action' => 'friendships_destroy', 'uid' => $uid]);
3824                 throw new NotFoundException("Error Processing Request");
3825         }
3826
3827         // Sharing-only contacts get deleted as there no relationship any more
3828         if ($dissolve) {
3829                 Contact::remove($contact['id']);
3830         } else {
3831                 DBA::update('contact', ['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
3832         }
3833
3834         // "uid" and "self" are only needed for some internal stuff, so remove it from here
3835         unset($contact["uid"]);
3836         unset($contact["self"]);
3837
3838         // Set screen_name since Twidere requests it
3839         $contact["screen_name"] = $contact["nick"];
3840
3841         return api_format_data("friendships-destroy", $type, ['user' => $contact]);
3842 }
3843 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3844
3845 /**
3846  *
3847  * @param string $type Return type (atom, rss, xml, json)
3848  * @param string $box
3849  * @param string $verbose
3850  *
3851  * @return array|string
3852  * @throws BadRequestException
3853  * @throws ForbiddenException
3854  * @throws ImagickException
3855  * @throws InternalServerErrorException
3856  * @throws UnauthorizedException
3857  */
3858 function api_direct_messages_box($type, $box, $verbose)
3859 {
3860         $a = DI::app();
3861         if (api_user() === false) {
3862                 throw new ForbiddenException();
3863         }
3864         // params
3865         $count = $_GET['count'] ?? 20;
3866         $page = $_REQUEST['page'] ?? 1;
3867
3868         $since_id = $_REQUEST['since_id'] ?? 0;
3869         $max_id = $_REQUEST['max_id'] ?? 0;
3870
3871         $user_id = $_REQUEST['user_id'] ?? '';
3872         $screen_name = $_REQUEST['screen_name'] ?? '';
3873
3874         //  caller user info
3875         unset($_REQUEST["user_id"]);
3876         unset($_GET["user_id"]);
3877
3878         unset($_REQUEST["screen_name"]);
3879         unset($_GET["screen_name"]);
3880
3881         $user_info = api_get_user($a);
3882         if ($user_info === false) {
3883                 throw new ForbiddenException();
3884         }
3885         $profile_url = $user_info["url"];
3886
3887         // pagination
3888         $start = max(0, ($page - 1) * $count);
3889
3890         $sql_extra = "";
3891
3892         // filters
3893         if ($box=="sentbox") {
3894                 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
3895         } elseif ($box == "conversation") {
3896                 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape($_GET['uri'] ?? '')  . "'";
3897         } elseif ($box == "all") {
3898                 $sql_extra = "true";
3899         } elseif ($box == "inbox") {
3900                 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
3901         }
3902
3903         if ($max_id > 0) {
3904                 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3905         }
3906
3907         if ($user_id != "") {
3908                 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3909         } elseif ($screen_name !="") {
3910                 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
3911         }
3912
3913         $r = q(
3914                 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid`=%d AND $sql_extra AND `mail`.`id` > %d ORDER BY `mail`.`id` DESC LIMIT %d,%d",
3915                 intval(api_user()),
3916                 intval($since_id),
3917                 intval($start),
3918                 intval($count)
3919         );
3920         if ($verbose == "true" && !DBA::isResult($r)) {
3921                 $answer = ['result' => 'error', 'message' => 'no mails available'];
3922                 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3923         }
3924
3925         $ret = [];
3926         foreach ($r as $item) {
3927                 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3928                         $recipient = $user_info;
3929                         $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3930                 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3931                         $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3932                         $sender = $user_info;
3933                 }
3934
3935                 if (isset($recipient) && isset($sender)) {
3936                         $ret[] = api_format_messages($item, $recipient, $sender);
3937                 }
3938         }
3939
3940
3941         $data = ['direct_message' => $ret];
3942         switch ($type) {
3943                 case "atom":
3944                         break;
3945                 case "rss":
3946                         $data = api_rss_extra($a, $data, $user_info);
3947                         break;
3948         }
3949
3950         return api_format_data("direct-messages", $type, $data);
3951 }
3952
3953 /**
3954  * Returns the most recent direct messages sent by the user.
3955  *
3956  * @param string $type Return type (atom, rss, xml, json)
3957  *
3958  * @return array|string
3959  * @throws BadRequestException
3960  * @throws ForbiddenException
3961  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3962  */
3963 function api_direct_messages_sentbox($type)
3964 {
3965         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3966         return api_direct_messages_box($type, "sentbox", $verbose);
3967 }
3968
3969 /**
3970  * Returns the most recent direct messages sent to the user.
3971  *
3972  * @param string $type Return type (atom, rss, xml, json)
3973  *
3974  * @return array|string
3975  * @throws BadRequestException
3976  * @throws ForbiddenException
3977  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3978  */
3979 function api_direct_messages_inbox($type)
3980 {
3981         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3982         return api_direct_messages_box($type, "inbox", $verbose);
3983 }
3984
3985 /**
3986  *
3987  * @param string $type Return type (atom, rss, xml, json)
3988  *
3989  * @return array|string
3990  * @throws BadRequestException
3991  * @throws ForbiddenException
3992  */
3993 function api_direct_messages_all($type)
3994 {
3995         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
3996         return api_direct_messages_box($type, "all", $verbose);
3997 }
3998
3999 /**
4000  *
4001  * @param string $type Return type (atom, rss, xml, json)
4002  *
4003  * @return array|string
4004  * @throws BadRequestException
4005  * @throws ForbiddenException
4006  */
4007 function api_direct_messages_conversation($type)
4008 {
4009         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4010         return api_direct_messages_box($type, "conversation", $verbose);
4011 }
4012
4013 /// @TODO move to top of file or somewhere better
4014 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
4015 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
4016 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
4017 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
4018
4019 /**
4020  * Returns an OAuth Request Token.
4021  *
4022  * @see https://oauth.net/core/1.0/#auth_step1
4023  */
4024 function api_oauth_request_token()
4025 {
4026         $oauth1 = new FKOAuth1();
4027         try {
4028                 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
4029         } catch (Exception $e) {
4030                 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
4031                 exit();
4032         }
4033         echo $r;
4034         exit();
4035 }
4036
4037 /**
4038  * Returns an OAuth Access Token.
4039  *
4040  * @return array|string
4041  * @see https://oauth.net/core/1.0/#auth_step3
4042  */
4043 function api_oauth_access_token()
4044 {
4045         $oauth1 = new FKOAuth1();
4046         try {
4047                 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
4048         } catch (Exception $e) {
4049                 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
4050                 exit();
4051         }
4052         echo $r;
4053         exit();
4054 }
4055
4056 /// @TODO move to top of file or somewhere better
4057 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
4058 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
4059
4060
4061 /**
4062  * delete a complete photoalbum with all containing photos from database through api
4063  *
4064  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4065  * @return string|array
4066  * @throws BadRequestException
4067  * @throws ForbiddenException
4068  * @throws InternalServerErrorException
4069  */
4070 function api_fr_photoalbum_delete($type)
4071 {
4072         if (api_user() === false) {
4073                 throw new ForbiddenException();
4074         }
4075         // input params
4076         $album = $_REQUEST['album'] ?? '';
4077
4078         // we do not allow calls without album string
4079         if ($album == "") {
4080                 throw new BadRequestException("no albumname specified");
4081         }
4082         // check if album is existing
4083
4084         $photos = DBA::selectToArray('photo', ['resource-id'], ['uid' => api_user(), 'album' => $album], ['group_by' => ['resource-id']]);
4085         if (!DBA::isResult($photos)) {
4086                 throw new BadRequestException("album not available");
4087         }
4088
4089         $resourceIds = array_column($photos, 'resource-id');
4090
4091         // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4092         // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
4093         $condition = ['uid' => api_user(), 'resource-id' => $resourceIds, 'type' => 'photo'];
4094         Item::deleteForUser($condition, api_user());
4095
4096         // now let's delete all photos from the album
4097         $result = Photo::delete(['uid' => api_user(), 'album' => $album]);
4098
4099         // return success of deletion or error message
4100         if ($result) {
4101                 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
4102                 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
4103         } else {
4104                 throw new InternalServerErrorException("unknown error - deleting from database failed");
4105         }
4106 }
4107
4108 /**
4109  * update the name of the album for all photos of an album
4110  *
4111  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4112  * @return string|array
4113  * @throws BadRequestException
4114  * @throws ForbiddenException
4115  * @throws InternalServerErrorException
4116  */
4117 function api_fr_photoalbum_update($type)
4118 {
4119         if (api_user() === false) {
4120                 throw new ForbiddenException();
4121         }
4122         // input params
4123         $album = $_REQUEST['album'] ?? '';
4124         $album_new = $_REQUEST['album_new'] ?? '';
4125
4126         // we do not allow calls without album string
4127         if ($album == "") {
4128                 throw new BadRequestException("no albumname specified");
4129         }
4130         if ($album_new == "") {
4131                 throw new BadRequestException("no new albumname specified");
4132         }
4133         // check if album is existing
4134         if (!Photo::exists(['uid' => api_user(), 'album' => $album])) {
4135                 throw new BadRequestException("album not available");
4136         }
4137         // now let's update all photos to the albumname
4138         $result = Photo::update(['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
4139
4140         // return success of updating or error message
4141         if ($result) {
4142                 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4143                 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4144         } else {
4145                 throw new InternalServerErrorException("unknown error - updating in database failed");
4146         }
4147 }
4148
4149
4150 /**
4151  * list all photos of the authenticated user
4152  *
4153  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4154  * @return string|array
4155  * @throws ForbiddenException
4156  * @throws InternalServerErrorException
4157  */
4158 function api_fr_photos_list($type)
4159 {
4160         if (api_user() === false) {
4161                 throw new ForbiddenException();
4162         }
4163         $r = q(
4164                 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4165                 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4166                 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`, `album`, `filename`, `type`",
4167                 intval(local_user())
4168         );
4169         $typetoext = [
4170                 'image/jpeg' => 'jpg',
4171                 'image/png' => 'png',
4172                 'image/gif' => 'gif'
4173         ];
4174         $data = ['photo'=>[]];
4175         if (DBA::isResult($r)) {
4176                 foreach ($r as $rr) {
4177                         $photo = [];
4178                         $photo['id'] = $rr['resource-id'];
4179                         $photo['album'] = $rr['album'];
4180                         $photo['filename'] = $rr['filename'];
4181                         $photo['type'] = $rr['type'];
4182                         $thumb = DI::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4183                         $photo['created'] = $rr['created'];
4184                         $photo['edited'] = $rr['edited'];
4185                         $photo['desc'] = $rr['desc'];
4186
4187                         if ($type == "xml") {
4188                                 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4189                         } else {
4190                                 $photo['thumb'] = $thumb;
4191                                 $data['photo'][] = $photo;
4192                         }
4193                 }
4194         }
4195         return api_format_data("photos", $type, $data);
4196 }
4197
4198 /**
4199  * upload a new photo or change an existing photo
4200  *
4201  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4202  * @return string|array
4203  * @throws BadRequestException
4204  * @throws ForbiddenException
4205  * @throws ImagickException
4206  * @throws InternalServerErrorException
4207  * @throws NotFoundException
4208  */
4209 function api_fr_photo_create_update($type)
4210 {
4211         if (api_user() === false) {
4212                 throw new ForbiddenException();
4213         }
4214         // input params
4215         $photo_id  = $_REQUEST['photo_id']  ?? null;
4216         $desc      = $_REQUEST['desc']      ?? null;
4217         $album     = $_REQUEST['album']     ?? null;
4218         $album_new = $_REQUEST['album_new'] ?? null;
4219         $allow_cid = $_REQUEST['allow_cid'] ?? null;
4220         $deny_cid  = $_REQUEST['deny_cid' ] ?? null;
4221         $allow_gid = $_REQUEST['allow_gid'] ?? null;
4222         $deny_gid  = $_REQUEST['deny_gid' ] ?? null;
4223         $visibility = !$allow_cid && !$deny_cid && !$allow_gid && !$deny_gid;
4224
4225         // do several checks on input parameters
4226         // we do not allow calls without album string
4227         if ($album == null) {
4228                 throw new BadRequestException("no albumname specified");
4229         }
4230         // if photo_id == null --> we are uploading a new photo
4231         if ($photo_id == null) {
4232                 $mode = "create";
4233
4234                 // error if no media posted in create-mode
4235                 if (empty($_FILES['media'])) {
4236                         // Output error
4237                         throw new BadRequestException("no media data submitted");
4238                 }
4239
4240                 // album_new will be ignored in create-mode
4241                 $album_new = "";
4242         } else {
4243                 $mode = "update";
4244
4245                 // check if photo is existing in databasei
4246                 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user(), 'album' => $album])) {
4247                         throw new BadRequestException("photo not available");
4248                 }
4249         }
4250
4251         // checks on acl strings provided by clients
4252         $acl_input_error = false;
4253         $acl_input_error |= check_acl_input($allow_cid);
4254         $acl_input_error |= check_acl_input($deny_cid);
4255         $acl_input_error |= check_acl_input($allow_gid);
4256         $acl_input_error |= check_acl_input($deny_gid);
4257         if ($acl_input_error) {
4258                 throw new BadRequestException("acl data invalid");
4259         }
4260         // now let's upload the new media in create-mode
4261         if ($mode == "create") {
4262                 $media = $_FILES['media'];
4263                 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4264
4265                 // return success of updating or error message
4266                 if (!is_null($data)) {
4267                         return api_format_data("photo_create", $type, $data);
4268                 } else {
4269                         throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4270                 }
4271         }
4272
4273         // now let's do the changes in update-mode
4274         if ($mode == "update") {
4275                 $updated_fields = [];
4276
4277                 if (!is_null($desc)) {
4278                         $updated_fields['desc'] = $desc;
4279                 }
4280
4281                 if (!is_null($album_new)) {
4282                         $updated_fields['album'] = $album_new;
4283                 }
4284
4285                 if (!is_null($allow_cid)) {
4286                         $allow_cid = trim($allow_cid);
4287                         $updated_fields['allow_cid'] = $allow_cid;
4288                 }
4289
4290                 if (!is_null($deny_cid)) {
4291                         $deny_cid = trim($deny_cid);
4292                         $updated_fields['deny_cid'] = $deny_cid;
4293                 }
4294
4295                 if (!is_null($allow_gid)) {
4296                         $allow_gid = trim($allow_gid);
4297                         $updated_fields['allow_gid'] = $allow_gid;
4298                 }
4299
4300                 if (!is_null($deny_gid)) {
4301                         $deny_gid = trim($deny_gid);
4302                         $updated_fields['deny_gid'] = $deny_gid;
4303                 }
4304
4305                 $result = false;
4306                 if (count($updated_fields) > 0) {
4307                         $nothingtodo = false;
4308                         $result = Photo::update($updated_fields, ['uid' => api_user(), 'resource-id' => $photo_id, 'album' => $album]);
4309                 } else {
4310                         $nothingtodo = true;
4311                 }
4312
4313                 if (!empty($_FILES['media'])) {
4314                         $nothingtodo = false;
4315                         $media = $_FILES['media'];
4316                         $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4317                         if (!is_null($data)) {
4318                                 return api_format_data("photo_update", $type, $data);
4319                         }
4320                 }
4321
4322                 // return success of updating or error message
4323                 if ($result) {
4324                         $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4325                         return api_format_data("photo_update", $type, ['$result' => $answer]);
4326                 } else {
4327                         if ($nothingtodo) {
4328                                 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4329                                 return api_format_data("photo_update", $type, ['$result' => $answer]);
4330                         }
4331                         throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4332                 }
4333         }
4334         throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4335 }
4336
4337 /**
4338  * delete a single photo from the database through api
4339  *
4340  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4341  * @return string|array
4342  * @throws BadRequestException
4343  * @throws ForbiddenException
4344  * @throws InternalServerErrorException
4345  */
4346 function api_fr_photo_delete($type)
4347 {
4348         if (api_user() === false) {
4349                 throw new ForbiddenException();
4350         }
4351
4352         // input params
4353         $photo_id = $_REQUEST['photo_id'] ?? null;
4354
4355         // do several checks on input parameters
4356         // we do not allow calls without photo id
4357         if ($photo_id == null) {
4358                 throw new BadRequestException("no photo_id specified");
4359         }
4360
4361         // check if photo is existing in database
4362         if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user()])) {
4363                 throw new BadRequestException("photo not available");
4364         }
4365
4366         // now we can perform on the deletion of the photo
4367         $result = Photo::delete(['uid' => api_user(), 'resource-id' => $photo_id]);
4368
4369         // return success of deletion or error message
4370         if ($result) {
4371                 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4372                 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4373                 $condition = ['uid' => api_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4374                 Item::deleteForUser($condition, api_user());
4375
4376                 $result = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4377                 return api_format_data("photo_delete", $type, ['$result' => $result]);
4378         } else {
4379                 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4380         }
4381 }
4382
4383
4384 /**
4385  * returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4386  *
4387  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4388  * @return string|array
4389  * @throws BadRequestException
4390  * @throws ForbiddenException
4391  * @throws InternalServerErrorException
4392  * @throws NotFoundException
4393  */
4394 function api_fr_photo_detail($type)
4395 {
4396         if (api_user() === false) {
4397                 throw new ForbiddenException();
4398         }
4399         if (empty($_REQUEST['photo_id'])) {
4400                 throw new BadRequestException("No photo id.");
4401         }
4402
4403         $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
4404         $photo_id = $_REQUEST['photo_id'];
4405
4406         // prepare json/xml output with data from database for the requested photo
4407         $data = prepare_photo_data($type, $scale, $photo_id);
4408
4409         return api_format_data("photo_detail", $type, $data);
4410 }
4411
4412
4413 /**
4414  * updates the profile image for the user (either a specified profile or the default profile)
4415  *
4416  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4417  *
4418  * @return string|array
4419  * @throws BadRequestException
4420  * @throws ForbiddenException
4421  * @throws ImagickException
4422  * @throws InternalServerErrorException
4423  * @throws NotFoundException
4424  * @see   https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4425  */
4426 function api_account_update_profile_image($type)
4427 {
4428         if (api_user() === false) {
4429                 throw new ForbiddenException();
4430         }
4431         // input params
4432         $profile_id = $_REQUEST['profile_id'] ?? 0;
4433
4434         // error if image data is missing
4435         if (empty($_FILES['image'])) {
4436                 throw new BadRequestException("no media data submitted");
4437         }
4438
4439         // check if specified profile id is valid
4440         if ($profile_id != 0) {
4441                 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4442                 // error message if specified profile id is not in database
4443                 if (!DBA::isResult($profile)) {
4444                         throw new BadRequestException("profile_id not available");
4445                 }
4446                 $is_default_profile = $profile['is-default'];
4447         } else {
4448                 $is_default_profile = 1;
4449         }
4450
4451         // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4452         $media = null;
4453         if (!empty($_FILES['image'])) {
4454                 $media = $_FILES['image'];
4455         } elseif (!empty($_FILES['media'])) {
4456                 $media = $_FILES['media'];
4457         }
4458         // save new profile image
4459         $data = save_media_to_database("profileimage", $media, $type, DI::l10n()->t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4460
4461         // get filetype
4462         if (is_array($media['type'])) {
4463                 $filetype = $media['type'][0];
4464         } else {
4465                 $filetype = $media['type'];
4466         }
4467         if ($filetype == "image/jpeg") {
4468                 $fileext = "jpg";
4469         } elseif ($filetype == "image/png") {
4470                 $fileext = "png";
4471         } else {
4472                 throw new InternalServerErrorException('Unsupported filetype');
4473         }
4474
4475         // change specified profile or all profiles to the new resource-id
4476         if ($is_default_profile) {
4477                 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4478                 Photo::update(['profile' => false], $condition);
4479         } else {
4480                 $fields = ['photo' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext,
4481                         'thumb' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext];
4482                 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4483         }
4484
4485         Contact::updateSelfFromUserID(api_user(), true);
4486
4487         // Update global directory in background
4488         $url = DI::baseUrl() . '/profile/' . DI::app()->user['nickname'];
4489         if ($url && strlen(DI::config()->get('system', 'directory'))) {
4490                 Worker::add(PRIORITY_LOW, "Directory", $url);
4491         }
4492
4493         Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4494
4495         // output for client
4496         if ($data) {
4497                 return api_account_verify_credentials($type);
4498         } else {
4499                 // SaveMediaToDatabase failed for some reason
4500                 throw new InternalServerErrorException("image upload failed");
4501         }
4502 }
4503
4504 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4505 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4506 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4507 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4508 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4509 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4510 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4511 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4512 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4513
4514 /**
4515  * Update user profile
4516  *
4517  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4518  *
4519  * @return array|string
4520  * @throws BadRequestException
4521  * @throws ForbiddenException
4522  * @throws ImagickException
4523  * @throws InternalServerErrorException
4524  * @throws UnauthorizedException
4525  */
4526 function api_account_update_profile($type)
4527 {
4528         $local_user = api_user();
4529         $api_user = api_get_user(DI::app());
4530
4531         if (!empty($_POST['name'])) {
4532                 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4533                 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4534                 DBA::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4535                 DBA::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4536         }
4537
4538         if (isset($_POST['description'])) {
4539                 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4540                 DBA::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4541                 DBA::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4542         }
4543
4544         Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4545         // Update global directory in background
4546         if ($api_user['url'] && strlen(DI::config()->get('system', 'directory'))) {
4547                 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4548         }
4549
4550         return api_account_verify_credentials($type);
4551 }
4552
4553 /// @TODO move to top of file or somewhere better
4554 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4555
4556 /**
4557  *
4558  * @param string $acl_string
4559  * @return bool
4560  * @throws Exception
4561  */
4562 function check_acl_input($acl_string)
4563 {
4564         if (empty($acl_string)) {
4565                 return false;
4566         }
4567
4568         $contact_not_found = false;
4569
4570         // split <x><y><z> into array of cid's
4571         preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4572
4573         // check for each cid if it is available on server
4574         $cid_array = $array[0];
4575         foreach ($cid_array as $cid) {
4576                 $cid = str_replace("<", "", $cid);
4577                 $cid = str_replace(">", "", $cid);
4578                 $condition = ['id' => $cid, 'uid' => api_user()];
4579                 $contact_not_found |= !DBA::exists('contact', $condition);
4580         }
4581         return $contact_not_found;
4582 }
4583
4584 /**
4585  * @param string  $mediatype
4586  * @param array   $media
4587  * @param string  $type
4588  * @param string  $album
4589  * @param string  $allow_cid
4590  * @param string  $deny_cid
4591  * @param string  $allow_gid
4592  * @param string  $deny_gid
4593  * @param string  $desc
4594  * @param integer $profile
4595  * @param boolean $visibility
4596  * @param string  $photo_id
4597  * @return array
4598  * @throws BadRequestException
4599  * @throws ForbiddenException
4600  * @throws ImagickException
4601  * @throws InternalServerErrorException
4602  * @throws NotFoundException
4603  * @throws UnauthorizedException
4604  */
4605 function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, $profile = 0, $visibility = false, $photo_id = null)
4606 {
4607         $visitor   = 0;
4608         $src = "";
4609         $filetype = "";
4610         $filename = "";
4611         $filesize = 0;
4612
4613         if (is_array($media)) {
4614                 if (is_array($media['tmp_name'])) {
4615                         $src = $media['tmp_name'][0];
4616                 } else {
4617                         $src = $media['tmp_name'];
4618                 }
4619                 if (is_array($media['name'])) {
4620                         $filename = basename($media['name'][0]);
4621                 } else {
4622                         $filename = basename($media['name']);
4623                 }
4624                 if (is_array($media['size'])) {
4625                         $filesize = intval($media['size'][0]);
4626                 } else {
4627                         $filesize = intval($media['size']);
4628                 }
4629                 if (is_array($media['type'])) {
4630                         $filetype = $media['type'][0];
4631                 } else {
4632                         $filetype = $media['type'];
4633                 }
4634         }
4635
4636         $filetype = Images::getMimeTypeBySource($src, $filename, $filetype);
4637
4638         Logger::log(
4639                 "File upload src: " . $src . " - filename: " . $filename .
4640                 " - size: " . $filesize . " - type: " . $filetype,
4641                 Logger::DEBUG
4642         );
4643
4644         // check if there was a php upload error
4645         if ($filesize == 0 && $media['error'] == 1) {
4646                 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4647         }
4648         // check against max upload size within Friendica instance
4649         $maximagesize = DI::config()->get('system', 'maximagesize');
4650         if ($maximagesize && ($filesize > $maximagesize)) {
4651                 $formattedBytes = Strings::formatBytes($maximagesize);
4652                 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4653         }
4654
4655         // create Photo instance with the data of the image
4656         $imagedata = @file_get_contents($src);
4657         $Image = new Image($imagedata, $filetype);
4658         if (!$Image->isValid()) {
4659                 throw new InternalServerErrorException("unable to process image data");
4660         }
4661
4662         // check orientation of image
4663         $Image->orient($src);
4664         @unlink($src);
4665
4666         // check max length of images on server
4667         $max_length = DI::config()->get('system', 'max_image_length');
4668         if (!$max_length) {
4669                 $max_length = MAX_IMAGE_LENGTH;
4670         }
4671         if ($max_length > 0) {
4672                 $Image->scaleDown($max_length);
4673                 Logger::log("File upload: Scaling picture to new size " . $max_length, Logger::DEBUG);
4674         }
4675         $width = $Image->getWidth();
4676         $height = $Image->getHeight();
4677
4678         // create a new resource-id if not already provided
4679         $resource_id = ($photo_id == null) ? Photo::newResource() : $photo_id;
4680
4681         if ($mediatype == "photo") {
4682                 // upload normal image (scales 0, 1, 2)
4683                 Logger::log("photo upload: starting new photo upload", Logger::DEBUG);
4684
4685                 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4686                 if (!$r) {
4687                         Logger::log("photo upload: image upload with scale 0 (original size) failed");
4688                 }
4689                 if ($width > 640 || $height > 640) {
4690                         $Image->scaleDown(640);
4691                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4692                         if (!$r) {
4693                                 Logger::log("photo upload: image upload with scale 1 (640x640) failed");
4694                         }
4695                 }
4696
4697                 if ($width > 320 || $height > 320) {
4698                         $Image->scaleDown(320);
4699                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4700                         if (!$r) {
4701                                 Logger::log("photo upload: image upload with scale 2 (320x320) failed");
4702                         }
4703                 }
4704                 Logger::log("photo upload: new photo upload ended", Logger::DEBUG);
4705         } elseif ($mediatype == "profileimage") {
4706                 // upload profile image (scales 4, 5, 6)
4707                 Logger::log("photo upload: starting new profile image upload", Logger::DEBUG);
4708
4709                 if ($width > 300 || $height > 300) {
4710                         $Image->scaleDown(300);
4711                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4712                         if (!$r) {
4713                                 Logger::log("photo upload: profile image upload with scale 4 (300x300) failed");
4714                         }
4715                 }
4716
4717                 if ($width > 80 || $height > 80) {
4718                         $Image->scaleDown(80);
4719                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4720                         if (!$r) {
4721                                 Logger::log("photo upload: profile image upload with scale 5 (80x80) failed");
4722                         }
4723                 }
4724
4725                 if ($width > 48 || $height > 48) {
4726                         $Image->scaleDown(48);
4727                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4728                         if (!$r) {
4729                                 Logger::log("photo upload: profile image upload with scale 6 (48x48) failed");
4730                         }
4731                 }
4732                 $Image->__destruct();
4733                 Logger::log("photo upload: new profile image upload ended", Logger::DEBUG);
4734         }
4735
4736         if (!empty($r)) {
4737                 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4738                 if ($photo_id == null && $mediatype == "photo") {
4739                         post_photo_item($resource_id, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4740                 }
4741                 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4742                 return prepare_photo_data($type, false, $resource_id);
4743         } else {
4744                 throw new InternalServerErrorException("image upload failed");
4745         }
4746 }
4747
4748 /**
4749  *
4750  * @param string  $hash
4751  * @param string  $allow_cid
4752  * @param string  $deny_cid
4753  * @param string  $allow_gid
4754  * @param string  $deny_gid
4755  * @param string  $filetype
4756  * @param boolean $visibility
4757  * @throws InternalServerErrorException
4758  */
4759 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4760 {
4761         // get data about the api authenticated user
4762         $uri = Item::newURI(intval(api_user()));
4763         $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
4764
4765         $arr = [];
4766         $arr['guid']          = System::createUUID();
4767         $arr['uid']           = intval(api_user());
4768         $arr['uri']           = $uri;
4769         $arr['type']          = 'photo';
4770         $arr['wall']          = 1;
4771         $arr['resource-id']   = $hash;
4772         $arr['contact-id']    = $owner_record['id'];
4773         $arr['owner-name']    = $owner_record['name'];
4774         $arr['owner-link']    = $owner_record['url'];
4775         $arr['owner-avatar']  = $owner_record['thumb'];
4776         $arr['author-name']   = $owner_record['name'];
4777         $arr['author-link']   = $owner_record['url'];
4778         $arr['author-avatar'] = $owner_record['thumb'];
4779         $arr['title']         = "";
4780         $arr['allow_cid']     = $allow_cid;
4781         $arr['allow_gid']     = $allow_gid;
4782         $arr['deny_cid']      = $deny_cid;
4783         $arr['deny_gid']      = $deny_gid;
4784         $arr['visible']       = $visibility;
4785         $arr['origin']        = 1;
4786
4787         $typetoext = [
4788                         'image/jpeg' => 'jpg',
4789                         'image/png' => 'png',
4790                         'image/gif' => 'gif'
4791                         ];
4792
4793         // adds link to the thumbnail scale photo
4794         $arr['body'] = '[url=' . DI::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
4795                                 . '[img]' . DI::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4796                                 . '[/url]';
4797
4798         // do the magic for storing the item in the database and trigger the federation to other contacts
4799         Item::insert($arr);
4800 }
4801
4802 /**
4803  *
4804  * @param string $type
4805  * @param int    $scale
4806  * @param string $photo_id
4807  *
4808  * @return array
4809  * @throws BadRequestException
4810  * @throws ForbiddenException
4811  * @throws ImagickException
4812  * @throws InternalServerErrorException
4813  * @throws NotFoundException
4814  * @throws UnauthorizedException
4815  */
4816 function prepare_photo_data($type, $scale, $photo_id)
4817 {
4818         $a = DI::app();
4819         $user_info = api_get_user($a);
4820
4821         if ($user_info === false) {
4822                 throw new ForbiddenException();
4823         }
4824
4825         $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4826         $data_sql = ($scale === false ? "" : "data, ");
4827
4828         // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4829         // clients needs to convert this in their way for further processing
4830         $r = q(
4831                 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4832                                         `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4833                                         MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4834                         FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY
4835                                `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4836                                `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`",
4837                 $data_sql,
4838                 intval(local_user()),
4839                 DBA::escape($photo_id),
4840                 $scale_sql
4841         );
4842
4843         $typetoext = [
4844                 'image/jpeg' => 'jpg',
4845                 'image/png' => 'png',
4846                 'image/gif' => 'gif'
4847         ];
4848
4849         // prepare output data for photo
4850         if (DBA::isResult($r)) {
4851                 $data = ['photo' => $r[0]];
4852                 $data['photo']['id'] = $data['photo']['resource-id'];
4853                 if ($scale !== false) {
4854                         $data['photo']['data'] = base64_encode($data['photo']['data']);
4855                 } else {
4856                         unset($data['photo']['datasize']); //needed only with scale param
4857                 }
4858                 if ($type == "xml") {
4859                         $data['photo']['links'] = [];
4860                         for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4861                                 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4862                                                                                 "scale" => $k,
4863                                                                                 "href" => DI::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4864                         }
4865                 } else {
4866                         $data['photo']['link'] = [];
4867                         // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4868                         $i = 0;
4869                         for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4870                                 $data['photo']['link'][$i] = DI::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4871                                 $i++;
4872                         }
4873                 }
4874                 unset($data['photo']['resource-id']);
4875                 unset($data['photo']['minscale']);
4876                 unset($data['photo']['maxscale']);
4877         } else {
4878                 throw new NotFoundException();
4879         }
4880
4881         // retrieve item element for getting activities (like, dislike etc.) related to photo
4882         $condition = ['uid' => api_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4883         $item = Post::selectFirst(['id', 'uid', 'uri', 'parent', 'allow_cid', 'deny_cid', 'allow_gid', 'deny_gid'], $condition);
4884         if (!DBA::isResult($item)) {
4885                 throw new NotFoundException('Photo-related item not found.');
4886         }
4887
4888         $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4889
4890         // retrieve comments on photo
4891         $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
4892                 $item['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4893
4894         $statuses = Item::selectForUser(api_user(), [], $condition);
4895
4896         // prepare output of comments
4897         $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
4898         $comments = [];
4899         if ($type == "xml") {
4900                 $k = 0;
4901                 foreach ($commentData as $comment) {
4902                         $comments[$k++ . ":comment"] = $comment;
4903                 }
4904         } else {
4905                 foreach ($commentData as $comment) {
4906                         $comments[] = $comment;
4907                 }
4908         }
4909         $data['photo']['friendica_comments'] = $comments;
4910
4911         // include info if rights on photo and rights on item are mismatching
4912         $rights_mismatch = $data['photo']['allow_cid'] != $item['allow_cid'] ||
4913                 $data['photo']['deny_cid'] != $item['deny_cid'] ||
4914                 $data['photo']['allow_gid'] != $item['allow_gid'] ||
4915                 $data['photo']['deny_gid'] != $item['deny_gid'];
4916         $data['photo']['rights_mismatch'] = $rights_mismatch;
4917
4918         return $data;
4919 }
4920
4921
4922 /**
4923  * Similar as /mod/redir.php
4924  * redirect to 'url' after dfrn auth
4925  *
4926  * Why this when there is mod/redir.php already?
4927  * This use api_user() and api_login()
4928  *
4929  * params
4930  *              c_url: url of remote contact to auth to
4931  *              url: string, url to redirect after auth
4932  */
4933 function api_friendica_remoteauth()
4934 {
4935         $url = $_GET['url'] ?? '';
4936         $c_url = $_GET['c_url'] ?? '';
4937
4938         if ($url === '' || $c_url === '') {
4939                 throw new BadRequestException("Wrong parameters.");
4940         }
4941
4942         $c_url = Strings::normaliseLink($c_url);
4943
4944         // traditional DFRN
4945
4946         $contact = DBA::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4947         if (!DBA::isResult($contact)) {
4948                 throw new BadRequestException("Unknown contact");
4949         }
4950
4951         $cid = $contact['id'];
4952
4953         $dfrn_id = $contact['issued-id'] ?: $contact['dfrn-id'];
4954
4955         if (($contact['network'] !== Protocol::DFRN) || empty($dfrn_id)) {
4956                 System::externalRedirect($url ?: $c_url);
4957         }
4958
4959         if ($contact['duplex'] && $contact['issued-id']) {
4960                 $orig_id = $contact['issued-id'];
4961                 $dfrn_id = '1:' . $orig_id;
4962         }
4963         if ($contact['duplex'] && $contact['dfrn-id']) {
4964                 $orig_id = $contact['dfrn-id'];
4965                 $dfrn_id = '0:' . $orig_id;
4966         }
4967
4968         $sec = Strings::getRandomHex();
4969
4970         $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
4971                 'sec' => $sec, 'expire' => time() + 45];
4972         DBA::insert('profile_check', $fields);
4973
4974         Logger::info(API_LOG_PREFIX . 'for contact {contact}', ['module' => 'api', 'action' => 'friendica_remoteauth', 'contact' => $contact['name'], 'hey' => $sec]);
4975         $dest = ($url ? '&destination_url=' . $url : '');
4976
4977         System::externalRedirect(
4978                 $contact['poll'] . '?dfrn_id=' . $dfrn_id
4979                 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4980                 . '&type=profile&sec=' . $sec . $dest
4981         );
4982 }
4983 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4984
4985 /**
4986  * Return an item with announcer data if it had been announced
4987  *
4988  * @param array $item Item array
4989  * @return array Item array with announce data
4990  */
4991 function api_get_announce($item)
4992 {
4993         // Quit if the item already has got a different owner and author
4994         if ($item['owner-id'] != $item['author-id']) {
4995                 return [];
4996         }
4997
4998         // Don't change original or Diaspora posts
4999         if ($item['origin'] || in_array($item['network'], [Protocol::DIASPORA])) {
5000                 return [];
5001         }
5002
5003         // Quit if we do now the original author and it had been a post from a native network
5004         if (!empty($item['contact-uid']) && in_array($item['network'], Protocol::NATIVE_SUPPORT)) {
5005                 return [];
5006         }
5007
5008         $fields = ['author-id', 'author-name', 'author-link', 'author-avatar'];
5009         $condition = ['parent-uri' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY, 'uid' => [0, $item['uid']], 'vid' => Verb::getID(Activity::ANNOUNCE)];
5010         $announce = Item::selectFirstForUser($item['uid'], $fields, $condition, ['order' => ['received' => true]]);
5011         if (!DBA::isResult($announce)) {
5012                 return [];
5013         }
5014
5015         return array_merge($item, $announce);
5016 }
5017
5018 /**
5019  * Return the item shared, if the item contains only the [share] tag
5020  *
5021  * @param array $item Sharer item
5022  * @return array|false Shared item or false if not a reshare
5023  * @throws ImagickException
5024  * @throws InternalServerErrorException
5025  */
5026 function api_share_as_retweet(&$item)
5027 {
5028         $body = trim($item["body"]);
5029
5030         if (Diaspora::isReshare($body, false) === false) {
5031                 if ($item['author-id'] == $item['owner-id']) {
5032                         return false;
5033                 } else {
5034                         // Reshares from OStatus, ActivityPub and Twitter
5035                         $reshared_item = $item;
5036                         $reshared_item['owner-id'] = $reshared_item['author-id'];
5037                         $reshared_item['owner-link'] = $reshared_item['author-link'];
5038                         $reshared_item['owner-name'] = $reshared_item['author-name'];
5039                         $reshared_item['owner-avatar'] = $reshared_item['author-avatar'];
5040                         return $reshared_item;
5041                 }
5042         }
5043
5044         $reshared = Item::getShareArray($item);
5045         if (empty($reshared)) {
5046                 return false;
5047         }
5048
5049         $reshared_item = $item;
5050
5051         if (empty($reshared['shared']) || empty($reshared['profile']) || empty($reshared['author']) || empty($reshared['avatar']) || empty($reshared['posted'])) {
5052                 return false;
5053         }
5054
5055         if (!empty($reshared['comment'])) {
5056                 $item['body'] = $reshared['comment'];
5057         }
5058
5059         $reshared_item["share-pre-body"] = $reshared['comment'];
5060         $reshared_item["body"] = $reshared['shared'];
5061         $reshared_item["author-id"] = Contact::getIdForURL($reshared['profile'], 0, false);
5062         $reshared_item["author-name"] = $reshared['author'];
5063         $reshared_item["author-link"] = $reshared['profile'];
5064         $reshared_item["author-avatar"] = $reshared['avatar'];
5065         $reshared_item["plink"] = $reshared['link'] ?? '';
5066         $reshared_item["created"] = $reshared['posted'];
5067         $reshared_item["edited"] = $reshared['posted'];
5068
5069         // Try to fetch the original item
5070         if (!empty($reshared['guid'])) {
5071                 $condition = ['guid' => $reshared['guid'], 'uid' => [0, $item['uid']]];
5072         } elseif (!empty($reshared_item['plink']) && ($original_id = Item::searchByLink($reshared_item['plink']))) {
5073                 $condition = ['id' => $original_id];
5074         } else {
5075                 $condition = [];
5076         }
5077
5078         if (!empty($condition)) {
5079                 $original_item = Post::selectFirst([], $condition);
5080                 if (DBA::isResult($original_item)) {
5081                         $reshared_item = array_merge($reshared_item, $original_item);
5082                 }
5083         }
5084
5085         return $reshared_item;
5086 }
5087
5088 /**
5089  *
5090  * @param array $item
5091  *
5092  * @return array
5093  * @throws Exception
5094  */
5095 function api_in_reply_to($item)
5096 {
5097         $in_reply_to = [];
5098
5099         $in_reply_to['status_id'] = null;
5100         $in_reply_to['user_id'] = null;
5101         $in_reply_to['status_id_str'] = null;
5102         $in_reply_to['user_id_str'] = null;
5103         $in_reply_to['screen_name'] = null;
5104
5105         if (($item['thr-parent'] != $item['uri']) && ($item['gravity'] != GRAVITY_PARENT)) {
5106                 $parent = Post::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
5107                 if (DBA::isResult($parent)) {
5108                         $in_reply_to['status_id'] = intval($parent['id']);
5109                 } else {
5110                         $in_reply_to['status_id'] = intval($item['parent']);
5111                 }
5112
5113                 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5114
5115                 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
5116                 $parent = Post::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
5117
5118                 if (DBA::isResult($parent)) {
5119                         $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
5120                         $in_reply_to['user_id'] = intval($parent['author-id']);
5121                         $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
5122                 }
5123
5124                 // There seems to be situation, where both fields are identical:
5125                 // https://github.com/friendica/friendica/issues/1010
5126                 // This is a bugfix for that.
5127                 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5128                         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']]);
5129                         $in_reply_to['status_id'] = null;
5130                         $in_reply_to['user_id'] = null;
5131                         $in_reply_to['status_id_str'] = null;
5132                         $in_reply_to['user_id_str'] = null;
5133                         $in_reply_to['screen_name'] = null;
5134                 }
5135         }
5136
5137         return $in_reply_to;
5138 }
5139
5140 /**
5141  *
5142  * @param string $text
5143  *
5144  * @return string
5145  * @throws InternalServerErrorException
5146  */
5147 function api_clean_plain_items($text)
5148 {
5149         $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
5150
5151         $text = BBCode::cleanPictureLinks($text);
5152         $URLSearchString = "^\[\]";
5153
5154         $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
5155
5156         if ($include_entities == "true") {
5157                 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5158         }
5159
5160         // Simplify "attachment" element
5161         $text = BBCode::removeAttachment($text);
5162
5163         return $text;
5164 }
5165
5166 /**
5167  *
5168  * @param array $contacts
5169  *
5170  * @return void
5171  */
5172 function api_best_nickname(&$contacts)
5173 {
5174         $best_contact = [];
5175
5176         if (count($contacts) == 0) {
5177                 return;
5178         }
5179
5180         foreach ($contacts as $contact) {
5181                 if ($contact["network"] == "") {
5182                         $contact["network"] = "dfrn";
5183                         $best_contact = [$contact];
5184                 }
5185         }
5186
5187         if (sizeof($best_contact) == 0) {
5188                 foreach ($contacts as $contact) {
5189                         if ($contact["network"] == "dfrn") {
5190                                 $best_contact = [$contact];
5191                         }
5192                 }
5193         }
5194
5195         if (sizeof($best_contact) == 0) {
5196                 foreach ($contacts as $contact) {
5197                         if ($contact["network"] == "dspr") {
5198                                 $best_contact = [$contact];
5199                         }
5200                 }
5201         }
5202
5203         if (sizeof($best_contact) == 0) {
5204                 foreach ($contacts as $contact) {
5205                         if ($contact["network"] == "stat") {
5206                                 $best_contact = [$contact];
5207                         }
5208                 }
5209         }
5210
5211         if (sizeof($best_contact) == 0) {
5212                 foreach ($contacts as $contact) {
5213                         if ($contact["network"] == "pump") {
5214                                 $best_contact = [$contact];
5215                         }
5216                 }
5217         }
5218
5219         if (sizeof($best_contact) == 0) {
5220                 foreach ($contacts as $contact) {
5221                         if ($contact["network"] == "twit") {
5222                                 $best_contact = [$contact];
5223                         }
5224                 }
5225         }
5226
5227         if (sizeof($best_contact) == 1) {
5228                 $contacts = $best_contact;
5229         } else {
5230                 $contacts = [$contacts[0]];
5231         }
5232 }
5233
5234 /**
5235  * Return all or a specified group of the user with the containing contacts.
5236  *
5237  * @param string $type Return type (atom, rss, xml, json)
5238  *
5239  * @return array|string
5240  * @throws BadRequestException
5241  * @throws ForbiddenException
5242  * @throws ImagickException
5243  * @throws InternalServerErrorException
5244  * @throws UnauthorizedException
5245  */
5246 function api_friendica_group_show($type)
5247 {
5248         $a = DI::app();
5249
5250         if (api_user() === false) {
5251                 throw new ForbiddenException();
5252         }
5253
5254         // params
5255         $user_info = api_get_user($a);
5256         $gid = $_REQUEST['gid'] ?? 0;
5257         $uid = $user_info['uid'];
5258
5259         // get data of the specified group id or all groups if not specified
5260         if ($gid != 0) {
5261                 $r = q(
5262                         "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5263                         intval($uid),
5264                         intval($gid)
5265                 );
5266                 // error message if specified gid is not in database
5267                 if (!DBA::isResult($r)) {
5268                         throw new BadRequestException("gid not available");
5269                 }
5270         } else {
5271                 $r = q(
5272                         "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5273                         intval($uid)
5274                 );
5275         }
5276
5277         // loop through all groups and retrieve all members for adding data in the user array
5278         $grps = [];
5279         foreach ($r as $rr) {
5280                 $members = Contact\Group::getById($rr['id']);
5281                 $users = [];
5282
5283                 if ($type == "xml") {
5284                         $user_element = "users";
5285                         $k = 0;
5286                         foreach ($members as $member) {
5287                                 $user = api_get_user($a, $member['nurl']);
5288                                 $users[$k++.":user"] = $user;
5289                         }
5290                 } else {
5291                         $user_element = "user";
5292                         foreach ($members as $member) {
5293                                 $user = api_get_user($a, $member['nurl']);
5294                                 $users[] = $user;
5295                         }
5296                 }
5297                 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5298         }
5299         return api_format_data("groups", $type, ['group' => $grps]);
5300 }
5301 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5302
5303
5304 /**
5305  * Delete the specified group of the user.
5306  *
5307  * @param string $type Return type (atom, rss, xml, json)
5308  *
5309  * @return array|string
5310  * @throws BadRequestException
5311  * @throws ForbiddenException
5312  * @throws ImagickException
5313  * @throws InternalServerErrorException
5314  * @throws UnauthorizedException
5315  */
5316 function api_friendica_group_delete($type)
5317 {
5318         $a = DI::app();
5319
5320         if (api_user() === false) {
5321                 throw new ForbiddenException();
5322         }
5323
5324         // params
5325         $user_info = api_get_user($a);
5326         $gid = $_REQUEST['gid'] ?? 0;
5327         $name = $_REQUEST['name'] ?? '';
5328         $uid = $user_info['uid'];
5329
5330         // error if no gid specified
5331         if ($gid == 0 || $name == "") {
5332                 throw new BadRequestException('gid or name not specified');
5333         }
5334
5335         // get data of the specified group id
5336         $r = q(
5337                 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5338                 intval($uid),
5339                 intval($gid)
5340         );
5341         // error message if specified gid is not in database
5342         if (!DBA::isResult($r)) {
5343                 throw new BadRequestException('gid not available');
5344         }
5345
5346         // get data of the specified group id and group name
5347         $rname = q(
5348                 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5349                 intval($uid),
5350                 intval($gid),
5351                 DBA::escape($name)
5352         );
5353         // error message if specified gid is not in database
5354         if (!DBA::isResult($rname)) {
5355                 throw new BadRequestException('wrong group name');
5356         }
5357
5358         // delete group
5359         $ret = Group::removeByName($uid, $name);
5360         if ($ret) {
5361                 // return success
5362                 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5363                 return api_format_data("group_delete", $type, ['result' => $success]);
5364         } else {
5365                 throw new BadRequestException('other API error');
5366         }
5367 }
5368 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5369
5370 /**
5371  * Delete a group.
5372  *
5373  * @param string $type Return type (atom, rss, xml, json)
5374  *
5375  * @return array|string
5376  * @throws BadRequestException
5377  * @throws ForbiddenException
5378  * @throws ImagickException
5379  * @throws InternalServerErrorException
5380  * @throws UnauthorizedException
5381  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5382  */
5383 function api_lists_destroy($type)
5384 {
5385         $a = DI::app();
5386
5387         if (api_user() === false) {
5388                 throw new ForbiddenException();
5389         }
5390
5391         // params
5392         $user_info = api_get_user($a);
5393         $gid = $_REQUEST['list_id'] ?? 0;
5394         $uid = $user_info['uid'];
5395
5396         // error if no gid specified
5397         if ($gid == 0) {
5398                 throw new BadRequestException('gid not specified');
5399         }
5400
5401         // get data of the specified group id
5402         $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5403         // error message if specified gid is not in database
5404         if (!$group) {
5405                 throw new BadRequestException('gid not available');
5406         }
5407
5408         if (Group::remove($gid)) {
5409                 $list = [
5410                         'name' => $group['name'],
5411                         'id' => intval($gid),
5412                         'id_str' => (string) $gid,
5413                         'user' => $user_info
5414                 ];
5415
5416                 return api_format_data("lists", $type, ['lists' => $list]);
5417         }
5418 }
5419 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5420
5421 /**
5422  * Add a new group to the database.
5423  *
5424  * @param  string $name  Group name
5425  * @param  int    $uid   User ID
5426  * @param  array  $users List of users to add to the group
5427  *
5428  * @return array
5429  * @throws BadRequestException
5430  */
5431 function group_create($name, $uid, $users = [])
5432 {
5433         // error if no name specified
5434         if ($name == "") {
5435                 throw new BadRequestException('group name not specified');
5436         }
5437
5438         // get data of the specified group name
5439         $rname = q(
5440                 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5441                 intval($uid),
5442                 DBA::escape($name)
5443         );
5444         // error message if specified group name already exists
5445         if (DBA::isResult($rname)) {
5446                 throw new BadRequestException('group name already exists');
5447         }
5448
5449         // check if specified group name is a deleted group
5450         $rname = q(
5451                 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5452                 intval($uid),
5453                 DBA::escape($name)
5454         );
5455         // error message if specified group name already exists
5456         if (DBA::isResult($rname)) {
5457                 $reactivate_group = true;
5458         }
5459
5460         // create group
5461         $ret = Group::create($uid, $name);
5462         if ($ret) {
5463                 $gid = Group::getIdByName($uid, $name);
5464         } else {
5465                 throw new BadRequestException('other API error');
5466         }
5467
5468         // add members
5469         $erroraddinguser = false;
5470         $errorusers = [];
5471         foreach ($users as $user) {
5472                 $cid = $user['cid'];
5473                 // check if user really exists as contact
5474                 $contact = q(
5475                         "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5476                         intval($cid),
5477                         intval($uid)
5478                 );
5479                 if (count($contact)) {
5480                         Group::addMember($gid, $cid);
5481                 } else {
5482                         $erroraddinguser = true;
5483                         $errorusers[] = $cid;
5484                 }
5485         }
5486
5487         // return success message incl. missing users in array
5488         $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5489
5490         return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5491 }
5492
5493 /**
5494  * Create the specified group with the posted array of contacts.
5495  *
5496  * @param string $type Return type (atom, rss, xml, json)
5497  *
5498  * @return array|string
5499  * @throws BadRequestException
5500  * @throws ForbiddenException
5501  * @throws ImagickException
5502  * @throws InternalServerErrorException
5503  * @throws UnauthorizedException
5504  */
5505 function api_friendica_group_create($type)
5506 {
5507         $a = DI::app();
5508
5509         if (api_user() === false) {
5510                 throw new ForbiddenException();
5511         }
5512
5513         // params
5514         $user_info = api_get_user($a);
5515         $name = $_REQUEST['name'] ?? '';
5516         $uid = $user_info['uid'];
5517         $json = json_decode($_POST['json'], true);
5518         $users = $json['user'];
5519
5520         $success = group_create($name, $uid, $users);
5521
5522         return api_format_data("group_create", $type, ['result' => $success]);
5523 }
5524 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5525
5526 /**
5527  * Create a new group.
5528  *
5529  * @param string $type Return type (atom, rss, xml, json)
5530  *
5531  * @return array|string
5532  * @throws BadRequestException
5533  * @throws ForbiddenException
5534  * @throws ImagickException
5535  * @throws InternalServerErrorException
5536  * @throws UnauthorizedException
5537  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5538  */
5539 function api_lists_create($type)
5540 {
5541         $a = DI::app();
5542
5543         if (api_user() === false) {
5544                 throw new ForbiddenException();
5545         }
5546
5547         // params
5548         $user_info = api_get_user($a);
5549         $name = $_REQUEST['name'] ?? '';
5550         $uid = $user_info['uid'];
5551
5552         $success = group_create($name, $uid);
5553         if ($success['success']) {
5554                 $grp = [
5555                         'name' => $success['name'],
5556                         'id' => intval($success['gid']),
5557                         'id_str' => (string) $success['gid'],
5558                         'user' => $user_info
5559                 ];
5560
5561                 return api_format_data("lists", $type, ['lists'=>$grp]);
5562         }
5563 }
5564 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5565
5566 /**
5567  * Update the specified group with the posted array of contacts.
5568  *
5569  * @param string $type Return type (atom, rss, xml, json)
5570  *
5571  * @return array|string
5572  * @throws BadRequestException
5573  * @throws ForbiddenException
5574  * @throws ImagickException
5575  * @throws InternalServerErrorException
5576  * @throws UnauthorizedException
5577  */
5578 function api_friendica_group_update($type)
5579 {
5580         $a = DI::app();
5581
5582         if (api_user() === false) {
5583                 throw new ForbiddenException();
5584         }
5585
5586         // params
5587         $user_info = api_get_user($a);
5588         $uid = $user_info['uid'];
5589         $gid = $_REQUEST['gid'] ?? 0;
5590         $name = $_REQUEST['name'] ?? '';
5591         $json = json_decode($_POST['json'], true);
5592         $users = $json['user'];
5593
5594         // error if no name specified
5595         if ($name == "") {
5596                 throw new BadRequestException('group name not specified');
5597         }
5598
5599         // error if no gid specified
5600         if ($gid == "") {
5601                 throw new BadRequestException('gid not specified');
5602         }
5603
5604         // remove members
5605         $members = Contact\Group::getById($gid);
5606         foreach ($members as $member) {
5607                 $cid = $member['id'];
5608                 foreach ($users as $user) {
5609                         $found = ($user['cid'] == $cid ? true : false);
5610                 }
5611                 if (!isset($found) || !$found) {
5612                         Group::removeMemberByName($uid, $name, $cid);
5613                 }
5614         }
5615
5616         // add members
5617         $erroraddinguser = false;
5618         $errorusers = [];
5619         foreach ($users as $user) {
5620                 $cid = $user['cid'];
5621                 // check if user really exists as contact
5622                 $contact = q(
5623                         "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5624                         intval($cid),
5625                         intval($uid)
5626                 );
5627
5628                 if (count($contact)) {
5629                         Group::addMember($gid, $cid);
5630                 } else {
5631                         $erroraddinguser = true;
5632                         $errorusers[] = $cid;
5633                 }
5634         }
5635
5636         // return success message incl. missing users in array
5637         $status = ($erroraddinguser ? "missing user" : "ok");
5638         $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5639         return api_format_data("group_update", $type, ['result' => $success]);
5640 }
5641
5642 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5643
5644 /**
5645  * Update information about a group.
5646  *
5647  * @param string $type Return type (atom, rss, xml, json)
5648  *
5649  * @return array|string
5650  * @throws BadRequestException
5651  * @throws ForbiddenException
5652  * @throws ImagickException
5653  * @throws InternalServerErrorException
5654  * @throws UnauthorizedException
5655  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5656  */
5657 function api_lists_update($type)
5658 {
5659         $a = DI::app();
5660
5661         if (api_user() === false) {
5662                 throw new ForbiddenException();
5663         }
5664
5665         // params
5666         $user_info = api_get_user($a);
5667         $gid = $_REQUEST['list_id'] ?? 0;
5668         $name = $_REQUEST['name'] ?? '';
5669         $uid = $user_info['uid'];
5670
5671         // error if no gid specified
5672         if ($gid == 0) {
5673                 throw new BadRequestException('gid not specified');
5674         }
5675
5676         // get data of the specified group id
5677         $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5678         // error message if specified gid is not in database
5679         if (!$group) {
5680                 throw new BadRequestException('gid not available');
5681         }
5682
5683         if (Group::update($gid, $name)) {
5684                 $list = [
5685                         'name' => $name,
5686                         'id' => intval($gid),
5687                         'id_str' => (string) $gid,
5688                         'user' => $user_info
5689                 ];
5690
5691                 return api_format_data("lists", $type, ['lists' => $list]);
5692         }
5693 }
5694
5695 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5696
5697 /**
5698  *
5699  * @param string $type Return type (atom, rss, xml, json)
5700  *
5701  * @return array|string
5702  * @throws BadRequestException
5703  * @throws ForbiddenException
5704  * @throws ImagickException
5705  * @throws InternalServerErrorException
5706  */
5707 function api_friendica_activity($type)
5708 {
5709         $a = DI::app();
5710
5711         if (api_user() === false) {
5712                 throw new ForbiddenException();
5713         }
5714         $verb = strtolower($a->argv[3]);
5715         $verb = preg_replace("|\..*$|", "", $verb);
5716
5717         $id = $_REQUEST['id'] ?? 0;
5718
5719         $res = Item::performActivity($id, $verb, api_user());
5720
5721         if ($res) {
5722                 if ($type == "xml") {
5723                         $ok = "true";
5724                 } else {
5725                         $ok = "ok";
5726                 }
5727                 return api_format_data('ok', $type, ['ok' => $ok]);
5728         } else {
5729                 throw new BadRequestException('Error adding activity');
5730         }
5731 }
5732
5733 /// @TODO move to top of file or somewhere better
5734 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5735 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5736 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5737 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5738 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5739 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5740 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5741 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5742 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5743 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5744
5745 /**
5746  * Returns notifications
5747  *
5748  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5749  *
5750  * @return string|array
5751  * @throws ForbiddenException
5752  * @throws BadRequestException
5753  * @throws Exception
5754  */
5755 function api_friendica_notification($type)
5756 {
5757         $a = DI::app();
5758
5759         if (api_user() === false) {
5760                 throw new ForbiddenException();
5761         }
5762         if ($a->argc!==3) {
5763                 throw new BadRequestException("Invalid argument count");
5764         }
5765
5766         $notifications = DI::notification()->getApiList(local_user());
5767
5768         if ($type == "xml") {
5769                 $xmlnotes = false;
5770                 if (!empty($notifications)) {
5771                         foreach ($notifications as $notification) {
5772                                 $xmlnotes[] = ["@attributes" => $notification->toArray()];
5773                         }
5774                 }
5775
5776                 $result = $xmlnotes;
5777         } elseif (count($notifications) > 0) {
5778                 $result = $notifications->getArrayCopy();
5779         } else {
5780                 $result = false;
5781         }
5782
5783         return api_format_data("notes", $type, ['note' => $result]);
5784 }
5785
5786 /**
5787  * Set notification as seen and returns associated item (if possible)
5788  *
5789  * POST request with 'id' param as notification id
5790  *
5791  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5792  * @return string|array
5793  * @throws BadRequestException
5794  * @throws ForbiddenException
5795  * @throws ImagickException
5796  * @throws InternalServerErrorException
5797  * @throws UnauthorizedException
5798  */
5799 function api_friendica_notification_seen($type)
5800 {
5801         $a         = DI::app();
5802         $user_info = api_get_user($a);
5803
5804         if (api_user() === false || $user_info === false) {
5805                 throw new ForbiddenException();
5806         }
5807         if ($a->argc !== 4) {
5808                 throw new BadRequestException("Invalid argument count");
5809         }
5810
5811         $id = (!empty($_REQUEST['id']) ? intval($_REQUEST['id']) : 0);
5812
5813         try {
5814                 $notify = DI::notify()->getByID($id, api_user());
5815                 DI::notify()->setSeen(true, $notify);
5816
5817                 if ($notify->otype === Notify\ObjectType::ITEM) {
5818                         $item = Item::selectFirstForUser(api_user(), [], ['id' => $notify->iid, 'uid' => api_user()]);
5819                         if (DBA::isResult($item)) {
5820                                 // we found the item, return it to the user
5821                                 $ret  = api_format_items([$item], $user_info, false, $type);
5822                                 $data = ['status' => $ret];
5823                                 return api_format_data("status", $type, $data);
5824                         }
5825                         // the item can't be found, but we set the notification as seen, so we count this as a success
5826                 }
5827                 return api_format_data('result', $type, ['result' => "success"]);
5828         } catch (NotFoundException $e) {
5829                 throw new BadRequestException('Invalid argument', $e);
5830         } catch (Exception $e) {
5831                 throw new InternalServerErrorException('Internal Server exception', $e);
5832         }
5833 }
5834
5835 /// @TODO move to top of file or somewhere better
5836 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5837 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5838
5839 /**
5840  * update a direct_message to seen state
5841  *
5842  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5843  * @return string|array (success result=ok, error result=error with error message)
5844  * @throws BadRequestException
5845  * @throws ForbiddenException
5846  * @throws ImagickException
5847  * @throws InternalServerErrorException
5848  * @throws UnauthorizedException
5849  */
5850 function api_friendica_direct_messages_setseen($type)
5851 {
5852         $a = DI::app();
5853         if (api_user() === false) {
5854                 throw new ForbiddenException();
5855         }
5856
5857         // params
5858         $user_info = api_get_user($a);
5859         $uid = $user_info['uid'];
5860         $id = $_REQUEST['id'] ?? 0;
5861
5862         // return error if id is zero
5863         if ($id == "") {
5864                 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5865                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5866         }
5867
5868         // error message if specified id is not in database
5869         if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
5870                 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5871                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5872         }
5873
5874         // update seen indicator
5875         $result = DBA::update('mail', ['seen' => true], ['id' => $id]);
5876
5877         if ($result) {
5878                 // return success
5879                 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
5880                 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
5881         } else {
5882                 $answer = ['result' => 'error', 'message' => 'unknown error'];
5883                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5884         }
5885 }
5886
5887 /// @TODO move to top of file or somewhere better
5888 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5889
5890 /**
5891  * search for direct_messages containing a searchstring through api
5892  *
5893  * @param string $type      Known types are 'atom', 'rss', 'xml' and 'json'
5894  * @param string $box
5895  * @return string|array (success: success=true if found and search_result contains found messages,
5896  *                          success=false if nothing was found, search_result='nothing found',
5897  *                          error: result=error with error message)
5898  * @throws BadRequestException
5899  * @throws ForbiddenException
5900  * @throws ImagickException
5901  * @throws InternalServerErrorException
5902  * @throws UnauthorizedException
5903  */
5904 function api_friendica_direct_messages_search($type, $box = "")
5905 {
5906         $a = DI::app();
5907
5908         if (api_user() === false) {
5909                 throw new ForbiddenException();
5910         }
5911
5912         // params
5913         $user_info = api_get_user($a);
5914         $searchstring = $_REQUEST['searchstring'] ?? '';
5915         $uid = $user_info['uid'];
5916
5917         // error if no searchstring specified
5918         if ($searchstring == "") {
5919                 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
5920                 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
5921         }
5922
5923         // get data for the specified searchstring
5924         $r = q(
5925                 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid`=%d AND `body` LIKE '%s' ORDER BY `mail`.`id` DESC",
5926                 intval($uid),
5927                 DBA::escape('%'.$searchstring.'%')
5928         );
5929
5930         $profile_url = $user_info["url"];
5931
5932         // message if nothing was found
5933         if (!DBA::isResult($r)) {
5934                 $success = ['success' => false, 'search_results' => 'problem with query'];
5935         } elseif (count($r) == 0) {
5936                 $success = ['success' => false, 'search_results' => 'nothing found'];
5937         } else {
5938                 $ret = [];
5939                 foreach ($r as $item) {
5940                         if ($box == "inbox" || $item['from-url'] != $profile_url) {
5941                                 $recipient = $user_info;
5942                                 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5943                         } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5944                                 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5945                                 $sender = $user_info;
5946                         }
5947
5948                         if (isset($recipient) && isset($sender)) {
5949                                 $ret[] = api_format_messages($item, $recipient, $sender);
5950                         }
5951                 }
5952                 $success = ['success' => true, 'search_results' => $ret];
5953         }
5954
5955         return api_format_data("direct_message_search", $type, ['$result' => $success]);
5956 }
5957
5958 /// @TODO move to top of file or somewhere better
5959 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5960
5961 /**
5962  * Returns a list of saved searches.
5963  *
5964  * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5965  *
5966  * @param  string $type Return format: json or xml
5967  *
5968  * @return string|array
5969  * @throws Exception
5970  */
5971 function api_saved_searches_list($type)
5972 {
5973         $terms = DBA::select('search', ['id', 'term'], ['uid' => local_user()]);
5974
5975         $result = [];
5976         while ($term = DBA::fetch($terms)) {
5977                 $result[] = [
5978                         'created_at' => api_date(time()),
5979                         'id' => intval($term['id']),
5980                         'id_str' => $term['id'],
5981                         'name' => $term['term'],
5982                         'position' => null,
5983                         'query' => $term['term']
5984                 ];
5985         }
5986
5987         DBA::close($terms);
5988
5989         return api_format_data("terms", $type, ['terms' => $result]);
5990 }
5991
5992 /// @TODO move to top of file or somewhere better
5993 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5994
5995 /*
5996  * Number of comments
5997  *
5998  * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
5999  *
6000  * @param object $data [Status, Status]
6001  *
6002  * @return void
6003  */
6004 function bindComments(&$data)
6005 {
6006         if (count($data) == 0) {
6007                 return;
6008         }
6009
6010         $ids = [];
6011         $comments = [];
6012         foreach ($data as $item) {
6013                 $ids[] = $item['id'];
6014         }
6015
6016         $idStr = DBA::escape(implode(', ', $ids));
6017         $sql = "SELECT `parent`, COUNT(*) as comments FROM `item` WHERE `parent` IN ($idStr) AND `deleted` = ? AND `gravity`= ? GROUP BY `parent`";
6018         $items = DBA::p($sql, 0, GRAVITY_COMMENT);
6019         $itemsData = DBA::toArray($items);
6020
6021         foreach ($itemsData as $item) {
6022                 $comments[$item['parent']] = $item['comments'];
6023         }
6024
6025         foreach ($data as $idx => $item) {
6026                 $id = $item['id'];
6027                 $data[$idx]['friendica_comments'] = isset($comments[$id]) ? $comments[$id] : 0;
6028         }
6029 }
6030
6031 /*
6032 @TODO Maybe open to implement?
6033 To.Do:
6034         [pagename] => api/1.1/statuses/lookup.json
6035         [id] => 605138389168451584
6036         [include_cards] => true
6037         [cards_platform] => Android-12
6038         [include_entities] => true
6039         [include_my_retweet] => 1
6040         [include_rts] => 1
6041         [include_reply_count] => true
6042         [include_descendent_reply_count] => true
6043 (?)
6044
6045
6046 Not implemented by now:
6047 statuses/retweets_of_me
6048 friendships/create
6049 friendships/destroy
6050 friendships/exists
6051 friendships/show
6052 account/update_location
6053 account/update_profile_background_image
6054 blocks/create
6055 blocks/destroy
6056 friendica/profile/update
6057 friendica/profile/create
6058 friendica/profile/delete
6059
6060 Not implemented in status.net:
6061 statuses/retweeted_to_me
6062 statuses/retweeted_by_me
6063 direct_messages/destroy
6064 account/end_session
6065 account/update_delivery_device
6066 notifications/follow
6067 notifications/leave
6068 blocks/exists
6069 blocks/blocking
6070 lists
6071 */