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