include/api.php

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