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