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                 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", DBA::escape($_GET["q"]));
1420
1421                 if (!DBA::isResult($r)) {
1422                         $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", DBA::escape($_GET["q"]));
1423                 }
1424
1425                 if (DBA::isResult($r)) {
1426                         $k = 0;
1427                         foreach ($r as $user) {
1428                                 $user_info = api_get_user($a, $user["id"]);
1429
1430                                 if ($type == "xml") {
1431                                         $userlist[$k++.":user"] = $user_info;
1432                                 } else {
1433                                         $userlist[] = $user_info;
1434                                 }
1435                         }
1436                         $userlist = ["users" => $userlist];
1437                 } else {
1438                         throw new BadRequestException("User ".$_GET["q"]." not found.");
1439                 }
1440         } else {
1441                 throw new BadRequestException("No user specified.");
1442         }
1443
1444         return api_format_data("users", $type, $userlist);
1445 }
1446
1447 /// @TODO move to top of file or somewhere better
1448 api_register_func('api/users/search', 'api_users_search');
1449
1450 /**
1451  * Return user objects
1452  *
1453  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1454  *
1455  * @param string $type Return format: json or xml
1456  *
1457  * @return array|string
1458  * @throws BadRequestException
1459  * @throws ImagickException
1460  * @throws InternalServerErrorException
1461  * @throws NotFoundException if the results are empty.
1462  * @throws UnauthorizedException
1463  */
1464 function api_users_lookup($type)
1465 {
1466         $users = [];
1467
1468         if (!empty($_REQUEST['user_id'])) {
1469                 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1470                         if (!empty($id)) {
1471                                 $users[] = api_get_user(get_app(), $id);
1472                         }
1473                 }
1474         }
1475
1476         if (empty($users)) {
1477                 throw new NotFoundException;
1478         }
1479
1480         return api_format_data("users", $type, ['users' => $users]);
1481 }
1482
1483 /// @TODO move to top of file or somewhere better
1484 api_register_func('api/users/lookup', 'api_users_lookup', true);
1485
1486 /**
1487  * Returns statuses that match a specified query.
1488  *
1489  * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1490  *
1491  * @param string $type Return format: json, xml, atom, rss
1492  *
1493  * @return array|string
1494  * @throws BadRequestException if the "q" parameter is missing.
1495  * @throws ForbiddenException
1496  * @throws ImagickException
1497  * @throws InternalServerErrorException
1498  * @throws UnauthorizedException
1499  */
1500 function api_search($type)
1501 {
1502         $a = \get_app();
1503         $user_info = api_get_user($a);
1504
1505         if (api_user() === false || $user_info === false) { throw new ForbiddenException(); }
1506
1507         if (empty($_REQUEST['q'])) {
1508                 throw new BadRequestException('q parameter is required.');
1509         }
1510
1511         $searchTerm = trim(rawurldecode($_REQUEST['q']));
1512
1513         $data = [];
1514         $data['status'] = [];
1515         $count = 15;
1516         $exclude_replies = !empty($_REQUEST['exclude_replies']);
1517         if (!empty($_REQUEST['rpp'])) {
1518                 $count = $_REQUEST['rpp'];
1519         } elseif (!empty($_REQUEST['count'])) {
1520                 $count = $_REQUEST['count'];
1521         }
1522
1523         $since_id = $_REQUEST['since_id'] ?? 0;
1524         $max_id = $_REQUEST['max_id'] ?? 0;
1525         $page = $_REQUEST['page'] ?? 1;
1526
1527         $start = max(0, ($page - 1) * $count);
1528
1529         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1530         if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) {
1531                 $searchTerm = $matches[1];
1532                 $condition = ["`oid` > ?
1533                         AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1534                         AND `otype` = ? AND `type` = ? AND `term` = ?",
1535                         $since_id, local_user(), TERM_OBJ_POST, TERM_HASHTAG, $searchTerm];
1536                 if ($max_id > 0) {
1537                         $condition[0] .= ' AND `oid` <= ?';
1538                         $condition[] = $max_id;
1539                 }
1540                 $terms = DBA::select('term', ['oid'], $condition, []);
1541                 $itemIds = [];
1542                 while ($term = DBA::fetch($terms)) {
1543                         $itemIds[] = $term['oid'];
1544                 }
1545                 DBA::close($terms);
1546
1547                 if (empty($itemIds)) {
1548                         return api_format_data('statuses', $type, $data);
1549                 }
1550
1551                 $preCondition = ['`id` IN (' . implode(', ', $itemIds) . ')'];
1552                 if ($exclude_replies) {
1553                         $preCondition[] = '`id` = `parent`';
1554                 }
1555
1556                 $condition = [implode(' AND ', $preCondition)];
1557         } else {
1558                 $condition = ["`id` > ?
1559                         " . ($exclude_replies ? " AND `id` = `parent` " : ' ') . "
1560                         AND (`uid` = 0 OR (`uid` = ? AND NOT `global`))
1561                         AND `body` LIKE CONCAT('%',?,'%')",
1562                         $since_id, api_user(), $_REQUEST['q']];
1563                 if ($max_id > 0) {
1564                         $condition[0] .= ' AND `id` <= ?';
1565                         $condition[] = $max_id;
1566                 }
1567         }
1568
1569         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1570
1571         $data['status'] = api_format_items(Item::inArray($statuses), $user_info);
1572
1573         bindComments($data['status']);
1574
1575         return api_format_data('statuses', $type, $data);
1576 }
1577
1578 /// @TODO move to top of file or somewhere better
1579 api_register_func('api/search/tweets', 'api_search', true);
1580 api_register_func('api/search', 'api_search', true);
1581
1582 /**
1583  * Returns the most recent statuses posted by the user and the users they follow.
1584  *
1585  * @see  https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1586  *
1587  * @param string $type Return type (atom, rss, xml, json)
1588  *
1589  * @return array|string
1590  * @throws BadRequestException
1591  * @throws ForbiddenException
1592  * @throws ImagickException
1593  * @throws InternalServerErrorException
1594  * @throws UnauthorizedException
1595  * @todo Optional parameters
1596  * @todo Add reply info
1597  */
1598 function api_statuses_home_timeline($type)
1599 {
1600         $a = \get_app();
1601         $user_info = api_get_user($a);
1602
1603         if (api_user() === false || $user_info === false) {
1604                 throw new ForbiddenException();
1605         }
1606
1607         unset($_REQUEST["user_id"]);
1608         unset($_GET["user_id"]);
1609
1610         unset($_REQUEST["screen_name"]);
1611         unset($_GET["screen_name"]);
1612
1613         // get last network messages
1614
1615         // params
1616         $count = $_REQUEST['count'] ?? 20;
1617         $page = $_REQUEST['page']?? 0;
1618         $since_id = $_REQUEST['since_id'] ?? 0;
1619         $max_id = $_REQUEST['max_id'] ?? 0;
1620         $exclude_replies = !empty($_REQUEST['exclude_replies']);
1621         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1622
1623         $start = max(0, ($page - 1) * $count);
1624
1625         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1626                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1627
1628         if ($max_id > 0) {
1629                 $condition[0] .= " AND `item`.`id` <= ?";
1630                 $condition[] = $max_id;
1631         }
1632         if ($exclude_replies) {
1633                 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
1634         }
1635         if ($conversation_id > 0) {
1636                 $condition[0] .= " AND `item`.`parent` = ?";
1637                 $condition[] = $conversation_id;
1638         }
1639
1640         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1641         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1642
1643         $items = Item::inArray($statuses);
1644
1645         $ret = api_format_items($items, $user_info, false, $type);
1646
1647         // Set all posts from the query above to seen
1648         $idarray = [];
1649         foreach ($items as $item) {
1650                 $idarray[] = intval($item["id"]);
1651         }
1652
1653         if (!empty($idarray)) {
1654                 $unseen = Item::exists(['unseen' => true, 'id' => $idarray]);
1655                 if ($unseen) {
1656                         Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1657                 }
1658         }
1659
1660         bindComments($ret);
1661
1662         $data = ['status' => $ret];
1663         switch ($type) {
1664                 case "atom":
1665                         break;
1666                 case "rss":
1667                         $data = api_rss_extra($a, $data, $user_info);
1668                         break;
1669         }
1670
1671         return api_format_data("statuses", $type, $data);
1672 }
1673
1674
1675 /// @TODO move to top of file or somewhere better
1676 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1677 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1678
1679 /**
1680  * Returns the most recent statuses from public users.
1681  *
1682  * @param string $type Return type (atom, rss, xml, json)
1683  *
1684  * @return array|string
1685  * @throws BadRequestException
1686  * @throws ForbiddenException
1687  * @throws ImagickException
1688  * @throws InternalServerErrorException
1689  * @throws UnauthorizedException
1690  */
1691 function api_statuses_public_timeline($type)
1692 {
1693         $a = \get_app();
1694         $user_info = api_get_user($a);
1695
1696         if (api_user() === false || $user_info === false) {
1697                 throw new ForbiddenException();
1698         }
1699
1700         // get last network messages
1701
1702         // params
1703         $count = $_REQUEST['count'] ?? 20;
1704         $page = $_REQUEST['page'] ?? 1;
1705         $since_id = $_REQUEST['since_id'] ?? 0;
1706         $max_id = $_REQUEST['max_id'] ?? 0;
1707         $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
1708         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
1709
1710         $start = max(0, ($page - 1) * $count);
1711
1712         if ($exclude_replies && !$conversation_id) {
1713                 $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND NOT `author`.`hidden`",
1714                         GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1715
1716                 if ($max_id > 0) {
1717                         $condition[0] .= " AND `thread`.`iid` <= ?";
1718                         $condition[] = $max_id;
1719                 }
1720
1721                 $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1722                 $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1723
1724                 $r = Item::inArray($statuses);
1725         } else {
1726                 $condition = ["`gravity` IN (?, ?) AND `id` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall` AND `item`.`origin` AND NOT `author`.`hidden`",
1727                         GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1728
1729                 if ($max_id > 0) {
1730                         $condition[0] .= " AND `item`.`id` <= ?";
1731                         $condition[] = $max_id;
1732                 }
1733                 if ($conversation_id > 0) {
1734                         $condition[0] .= " AND `item`.`parent` = ?";
1735                         $condition[] = $conversation_id;
1736                 }
1737
1738                 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1739                 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1740
1741                 $r = Item::inArray($statuses);
1742         }
1743
1744         $ret = api_format_items($r, $user_info, false, $type);
1745
1746         bindComments($ret);
1747
1748         $data = ['status' => $ret];
1749         switch ($type) {
1750                 case "atom":
1751                         break;
1752                 case "rss":
1753                         $data = api_rss_extra($a, $data, $user_info);
1754                         break;
1755         }
1756
1757         return api_format_data("statuses", $type, $data);
1758 }
1759
1760 /// @TODO move to top of file or somewhere better
1761 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1762
1763 /**
1764  * Returns the most recent statuses posted by users this node knows about.
1765  *
1766  * @brief Returns the list of public federated posts this node knows about
1767  *
1768  * @param string $type Return format: json, xml, atom, rss
1769  * @return array|string
1770  * @throws BadRequestException
1771  * @throws ForbiddenException
1772  * @throws ImagickException
1773  * @throws InternalServerErrorException
1774  * @throws UnauthorizedException
1775  */
1776 function api_statuses_networkpublic_timeline($type)
1777 {
1778         $a = \get_app();
1779         $user_info = api_get_user($a);
1780
1781         if (api_user() === false || $user_info === false) {
1782                 throw new ForbiddenException();
1783         }
1784
1785         $since_id        = $_REQUEST['since_id'] ?? 0;
1786         $max_id          = $_REQUEST['max_id'] ?? 0;
1787
1788         // pagination
1789         $count = $_REQUEST['count'] ?? 20;
1790         $page  = $_REQUEST['page'] ?? 1;
1791
1792         $start = max(0, ($page - 1) * $count);
1793
1794         $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `thread`.`iid` > ? AND NOT `private`",
1795                 GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1796
1797         if ($max_id > 0) {
1798                 $condition[0] .= " AND `thread`.`iid` <= ?";
1799                 $condition[] = $max_id;
1800         }
1801
1802         $params = ['order' => ['iid' => true], 'limit' => [$start, $count]];
1803         $statuses = Item::selectThreadForUser(api_user(), Item::DISPLAY_FIELDLIST, $condition, $params);
1804
1805         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1806
1807         bindComments($ret);
1808
1809         $data = ['status' => $ret];
1810         switch ($type) {
1811                 case "atom":
1812                         break;
1813                 case "rss":
1814                         $data = api_rss_extra($a, $data, $user_info);
1815                         break;
1816         }
1817
1818         return api_format_data("statuses", $type, $data);
1819 }
1820
1821 /// @TODO move to top of file or somewhere better
1822 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1823
1824 /**
1825  * Returns a single status.
1826  *
1827  * @param string $type Return type (atom, rss, xml, json)
1828  *
1829  * @return array|string
1830  * @throws BadRequestException
1831  * @throws ForbiddenException
1832  * @throws ImagickException
1833  * @throws InternalServerErrorException
1834  * @throws UnauthorizedException
1835  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1836  */
1837 function api_statuses_show($type)
1838 {
1839         $a = \get_app();
1840         $user_info = api_get_user($a);
1841
1842         if (api_user() === false || $user_info === false) {
1843                 throw new ForbiddenException();
1844         }
1845
1846         // params
1847         $id = intval($a->argv[3] ?? 0);
1848
1849         if ($id == 0) {
1850                 $id = intval($_REQUEST['id'] ?? 0);
1851         }
1852
1853         // Hotot workaround
1854         if ($id == 0) {
1855                 $id = intval($a->argv[4] ?? 0);
1856         }
1857
1858         Logger::log('API: api_statuses_show: ' . $id);
1859
1860         $conversation = !empty($_REQUEST['conversation']);
1861
1862         // try to fetch the item for the local user - or the public item, if there is no local one
1863         $uri_item = Item::selectFirst(['uri'], ['id' => $id]);
1864         if (!DBA::isResult($uri_item)) {
1865                 throw new BadRequestException("There is no status with this id.");
1866         }
1867
1868         $item = Item::selectFirst(['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1869         if (!DBA::isResult($item)) {
1870                 throw new BadRequestException("There is no status with this id.");
1871         }
1872
1873         $id = $item['id'];
1874
1875         if ($conversation) {
1876                 $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1877                 $params = ['order' => ['id' => true]];
1878         } else {
1879                 $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
1880                 $params = [];
1881         }
1882
1883         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1884
1885         /// @TODO How about copying this to above methods which don't check $r ?
1886         if (!DBA::isResult($statuses)) {
1887                 throw new BadRequestException("There is no status with this id.");
1888         }
1889
1890         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1891
1892         if ($conversation) {
1893                 $data = ['status' => $ret];
1894                 return api_format_data("statuses", $type, $data);
1895         } else {
1896                 $data = ['status' => $ret[0]];
1897                 return api_format_data("status", $type, $data);
1898         }
1899 }
1900
1901 /// @TODO move to top of file or somewhere better
1902 api_register_func('api/statuses/show', 'api_statuses_show', true);
1903
1904 /**
1905  *
1906  * @param string $type Return type (atom, rss, xml, json)
1907  *
1908  * @return array|string
1909  * @throws BadRequestException
1910  * @throws ForbiddenException
1911  * @throws ImagickException
1912  * @throws InternalServerErrorException
1913  * @throws UnauthorizedException
1914  * @todo nothing to say?
1915  */
1916 function api_conversation_show($type)
1917 {
1918         $a = \get_app();
1919         $user_info = api_get_user($a);
1920
1921         if (api_user() === false || $user_info === false) {
1922                 throw new ForbiddenException();
1923         }
1924
1925         // params
1926         $id       = intval($a->argv[3]           ?? 0);
1927         $since_id = intval($_REQUEST['since_id'] ?? 0);
1928         $max_id   = intval($_REQUEST['max_id']   ?? 0);
1929         $count    = intval($_REQUEST['count']    ?? 20);
1930         $page     = intval($_REQUEST['page']     ?? 1);
1931
1932         $start = max(0, ($page - 1) * $count);
1933
1934         if ($id == 0) {
1935                 $id = intval($_REQUEST['id'] ?? 0);
1936         }
1937
1938         // Hotot workaround
1939         if ($id == 0) {
1940                 $id = intval($a->argv[4] ?? 0);
1941         }
1942
1943         Logger::info(API_LOG_PREFIX . '{subaction}', ['module' => 'api', 'action' => 'conversation', 'subaction' => 'show', 'id' => $id]);
1944
1945         // try to fetch the item for the local user - or the public item, if there is no local one
1946         $item = Item::selectFirst(['parent-uri'], ['id' => $id]);
1947         if (!DBA::isResult($item)) {
1948                 throw new BadRequestException("There is no status with this id.");
1949         }
1950
1951         $parent = Item::selectFirst(['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
1952         if (!DBA::isResult($parent)) {
1953                 throw new BadRequestException("There is no status with this id.");
1954         }
1955
1956         $id = $parent['id'];
1957
1958         $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `item`.`id` > ?",
1959                 $id, api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
1960
1961         if ($max_id > 0) {
1962                 $condition[0] .= " AND `item`.`id` <= ?";
1963                 $condition[] = $max_id;
1964         }
1965
1966         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
1967         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
1968
1969         if (!DBA::isResult($statuses)) {
1970                 throw new BadRequestException("There is no status with id $id.");
1971         }
1972
1973         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
1974
1975         $data = ['status' => $ret];
1976         return api_format_data("statuses", $type, $data);
1977 }
1978
1979 /// @TODO move to top of file or somewhere better
1980 api_register_func('api/conversation/show', 'api_conversation_show', true);
1981 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
1982
1983 /**
1984  * Repeats a status.
1985  *
1986  * @param string $type Return type (atom, rss, xml, json)
1987  *
1988  * @return array|string
1989  * @throws BadRequestException
1990  * @throws ForbiddenException
1991  * @throws ImagickException
1992  * @throws InternalServerErrorException
1993  * @throws UnauthorizedException
1994  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
1995  */
1996 function api_statuses_repeat($type)
1997 {
1998         global $called_api;
1999
2000         $a = \get_app();
2001
2002         if (api_user() === false) {
2003                 throw new ForbiddenException();
2004         }
2005
2006         api_get_user($a);
2007
2008         // params
2009         $id = intval($a->argv[3] ?? 0);
2010
2011         if ($id == 0) {
2012                 $id = intval($_REQUEST['id'] ?? 0);
2013         }
2014
2015         // Hotot workaround
2016         if ($id == 0) {
2017                 $id = intval($a->argv[4] ?? 0);
2018         }
2019
2020         Logger::log('API: api_statuses_repeat: '.$id);
2021
2022         $fields = ['body', 'title', 'attach', 'tag', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink'];
2023         $item = Item::selectFirst($fields, ['id' => $id, 'private' => false]);
2024
2025         if (DBA::isResult($item) && $item['body'] != "") {
2026                 if (strpos($item['body'], "[/share]") !== false) {
2027                         $pos = strpos($item['body'], "[share");
2028                         $post = substr($item['body'], $pos);
2029                 } else {
2030                         $post = share_header($item['author-name'], $item['author-link'], $item['author-avatar'], $item['guid'], $item['created'], $item['plink']);
2031
2032                         if (!empty($item['title'])) {
2033                                 $post .= '[h3]' . $item['title'] . "[/h3]\n";
2034                         }
2035
2036                         $post .= $item['body'];
2037                         $post .= "[/share]";
2038                 }
2039                 $_REQUEST['body'] = $post;
2040                 $_REQUEST['tag'] = $item['tag'];
2041                 $_REQUEST['attach'] = $item['attach'];
2042                 $_REQUEST['profile_uid'] = api_user();
2043                 $_REQUEST['api_source'] = true;
2044
2045                 if (empty($_REQUEST['source'])) {
2046                         $_REQUEST["source"] = api_source();
2047                 }
2048
2049                 $item_id = item_post($a);
2050         } else {
2051                 throw new ForbiddenException();
2052         }
2053
2054         // output the post that we just posted.
2055         $called_api = [];
2056         return api_status_show($type, $item_id);
2057 }
2058
2059 /// @TODO move to top of file or somewhere better
2060 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2061
2062 /**
2063  * Destroys a specific status.
2064  *
2065  * @param string $type Return type (atom, rss, xml, json)
2066  *
2067  * @return array|string
2068  * @throws BadRequestException
2069  * @throws ForbiddenException
2070  * @throws ImagickException
2071  * @throws InternalServerErrorException
2072  * @throws UnauthorizedException
2073  * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2074  */
2075 function api_statuses_destroy($type)
2076 {
2077         $a = \get_app();
2078
2079         if (api_user() === false) {
2080                 throw new ForbiddenException();
2081         }
2082
2083         api_get_user($a);
2084
2085         // params
2086         $id = intval($a->argv[3] ?? 0);
2087
2088         if ($id == 0) {
2089                 $id = intval($_REQUEST['id'] ?? 0);
2090         }
2091
2092         // Hotot workaround
2093         if ($id == 0) {
2094                 $id = intval($a->argv[4] ?? 0);
2095         }
2096
2097         Logger::log('API: api_statuses_destroy: '.$id);
2098
2099         $ret = api_statuses_show($type);
2100
2101         Item::deleteForUser(['id' => $id], api_user());
2102
2103         return $ret;
2104 }
2105
2106 /// @TODO move to top of file or somewhere better
2107 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2108
2109 /**
2110  * Returns the most recent mentions.
2111  *
2112  * @param string $type Return type (atom, rss, xml, json)
2113  *
2114  * @return array|string
2115  * @throws BadRequestException
2116  * @throws ForbiddenException
2117  * @throws ImagickException
2118  * @throws InternalServerErrorException
2119  * @throws UnauthorizedException
2120  * @see http://developer.twitter.com/doc/get/statuses/mentions
2121  */
2122 function api_statuses_mentions($type)
2123 {
2124         $a = \get_app();
2125         $user_info = api_get_user($a);
2126
2127         if (api_user() === false || $user_info === false) {
2128                 throw new ForbiddenException();
2129         }
2130
2131         unset($_REQUEST["user_id"]);
2132         unset($_GET["user_id"]);
2133
2134         unset($_REQUEST["screen_name"]);
2135         unset($_GET["screen_name"]);
2136
2137         // get last network messages
2138
2139         // params
2140         $since_id = $_REQUEST['since_id'] ?? 0;
2141         $max_id   = $_REQUEST['max_id']   ?? 0;
2142         $count    = $_REQUEST['count']    ?? 20;
2143         $page     = $_REQUEST['page']     ?? 1;
2144
2145         $start = max(0, ($page - 1) * $count);
2146
2147         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `author-id` != ?
2148                 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `thread`.`uid` = ? AND `thread`.`mention` AND NOT `thread`.`ignored`)",
2149                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['pid'], api_user()];
2150
2151         if ($max_id > 0) {
2152                 $condition[0] .= " AND `item`.`id` <= ?";
2153                 $condition[] = $max_id;
2154         }
2155
2156         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2157         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2158
2159         $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2160
2161         $data = ['status' => $ret];
2162         switch ($type) {
2163                 case "atom":
2164                         break;
2165                 case "rss":
2166                         $data = api_rss_extra($a, $data, $user_info);
2167                         break;
2168         }
2169
2170         return api_format_data("statuses", $type, $data);
2171 }
2172
2173 /// @TODO move to top of file or somewhere better
2174 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2175 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2176
2177 /**
2178  * Returns the most recent statuses posted by the user.
2179  *
2180  * @brief Returns a user's public timeline
2181  *
2182  * @param string $type Either "json" or "xml"
2183  * @return string|array
2184  * @throws BadRequestException
2185  * @throws ForbiddenException
2186  * @throws ImagickException
2187  * @throws InternalServerErrorException
2188  * @throws UnauthorizedException
2189  * @see   https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2190  */
2191 function api_statuses_user_timeline($type)
2192 {
2193         $a = \get_app();
2194         $user_info = api_get_user($a);
2195
2196         if (api_user() === false || $user_info === false) {
2197                 throw new ForbiddenException();
2198         }
2199
2200         Logger::log(
2201                 "api_statuses_user_timeline: api_user: ". api_user() .
2202                         "\nuser_info: ".print_r($user_info, true) .
2203                         "\n_REQUEST:  ".print_r($_REQUEST, true),
2204                 Logger::DEBUG
2205         );
2206
2207         $since_id        = $_REQUEST['since_id'] ?? 0;
2208         $max_id          = $_REQUEST['max_id'] ?? 0;
2209         $exclude_replies = !empty($_REQUEST['exclude_replies']);
2210         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
2211
2212         // pagination
2213         $count = $_REQUEST['count'] ?? 20;
2214         $page  = $_REQUEST['page'] ?? 1;
2215
2216         $start = max(0, ($page - 1) * $count);
2217
2218         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `item`.`id` > ? AND `item`.`contact-id` = ?",
2219                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $user_info['cid']];
2220
2221         if ($user_info['self'] == 1) {
2222                 $condition[0] .= ' AND `item`.`wall` ';
2223         }
2224
2225         if ($exclude_replies) {
2226                 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
2227         }
2228
2229         if ($conversation_id > 0) {
2230                 $condition[0] .= " AND `item`.`parent` = ?";
2231                 $condition[] = $conversation_id;
2232         }
2233
2234         if ($max_id > 0) {
2235                 $condition[0] .= " AND `item`.`id` <= ?";
2236                 $condition[] = $max_id;
2237         }
2238
2239         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2240         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2241
2242         $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type);
2243
2244         bindComments($ret);
2245
2246         $data = ['status' => $ret];
2247         switch ($type) {
2248                 case "atom":
2249                         break;
2250                 case "rss":
2251                         $data = api_rss_extra($a, $data, $user_info);
2252                         break;
2253         }
2254
2255         return api_format_data("statuses", $type, $data);
2256 }
2257
2258 /// @TODO move to top of file or somewhere better
2259 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2260
2261 /**
2262  * Star/unstar an item.
2263  * param: id : id of the item
2264  *
2265  * @param string $type Return type (atom, rss, xml, json)
2266  *
2267  * @return array|string
2268  * @throws BadRequestException
2269  * @throws ForbiddenException
2270  * @throws ImagickException
2271  * @throws InternalServerErrorException
2272  * @throws UnauthorizedException
2273  * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2274  */
2275 function api_favorites_create_destroy($type)
2276 {
2277         $a = \get_app();
2278
2279         if (api_user() === false) {
2280                 throw new ForbiddenException();
2281         }
2282
2283         // for versioned api.
2284         /// @TODO We need a better global soluton
2285         $action_argv_id = 2;
2286         if (count($a->argv) > 1 && $a->argv[1] == "1.1") {
2287                 $action_argv_id = 3;
2288         }
2289
2290         if ($a->argc <= $action_argv_id) {
2291                 throw new BadRequestException("Invalid request.");
2292         }
2293         $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2294         if ($a->argc == $action_argv_id + 2) {
2295                 $itemid = intval($a->argv[$action_argv_id + 1] ?? 0);
2296         } else {
2297                 $itemid = intval($_REQUEST['id'] ?? 0);
2298         }
2299
2300         $item = Item::selectFirstForUser(api_user(), [], ['id' => $itemid, 'uid' => api_user()]);
2301
2302         if (!DBA::isResult($item)) {
2303                 throw new BadRequestException("Invalid item.");
2304         }
2305
2306         switch ($action) {
2307                 case "create":
2308                         $item['starred'] = 1;
2309                         break;
2310                 case "destroy":
2311                         $item['starred'] = 0;
2312                         break;
2313                 default:
2314                         throw new BadRequestException("Invalid action ".$action);
2315         }
2316
2317         $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]);
2318
2319         if ($r === false) {
2320                 throw new InternalServerErrorException("DB error");
2321         }
2322
2323
2324         $user_info = api_get_user($a);
2325         $rets = api_format_items([$item], $user_info, false, $type);
2326         $ret = $rets[0];
2327
2328         $data = ['status' => $ret];
2329         switch ($type) {
2330                 case "atom":
2331                         break;
2332                 case "rss":
2333                         $data = api_rss_extra($a, $data, $user_info);
2334                         break;
2335         }
2336
2337         return api_format_data("status", $type, $data);
2338 }
2339
2340 /// @TODO move to top of file or somewhere better
2341 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2342 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2343
2344 /**
2345  * Returns the most recent favorite statuses.
2346  *
2347  * @param string $type Return type (atom, rss, xml, json)
2348  *
2349  * @return string|array
2350  * @throws BadRequestException
2351  * @throws ForbiddenException
2352  * @throws ImagickException
2353  * @throws InternalServerErrorException
2354  * @throws UnauthorizedException
2355  */
2356 function api_favorites($type)
2357 {
2358         global $called_api;
2359
2360         $a = \get_app();
2361         $user_info = api_get_user($a);
2362
2363         if (api_user() === false || $user_info === false) {
2364                 throw new ForbiddenException();
2365         }
2366
2367         $called_api = [];
2368
2369         // in friendica starred item are private
2370         // return favorites only for self
2371         Logger::info(API_LOG_PREFIX . 'for {self}', ['module' => 'api', 'action' => 'favorites', 'self' => $user_info['self']]);
2372
2373         if ($user_info['self'] == 0) {
2374                 $ret = [];
2375         } else {
2376                 // params
2377                 $since_id = $_REQUEST['since_id'] ?? 0;
2378                 $max_id = $_REQUEST['max_id'] ?? 0;
2379                 $count = $_GET['count'] ?? 20;
2380                 $page = $_REQUEST['page'] ?? 1;
2381
2382                 $start = max(0, ($page - 1) * $count);
2383
2384                 $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`",
2385                         api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id];
2386
2387                 $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
2388
2389                 if ($max_id > 0) {
2390                         $condition[0] .= " AND `item`.`id` <= ?";
2391                         $condition[] = $max_id;
2392                 }
2393
2394                 $statuses = Item::selectForUser(api_user(), [], $condition, $params);
2395
2396                 $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type);
2397         }
2398
2399         bindComments($ret);
2400
2401         $data = ['status' => $ret];
2402         switch ($type) {
2403                 case "atom":
2404                         break;
2405                 case "rss":
2406                         $data = api_rss_extra($a, $data, $user_info);
2407                         break;
2408         }
2409
2410         return api_format_data("statuses", $type, $data);
2411 }
2412
2413 /// @TODO move to top of file or somewhere better
2414 api_register_func('api/favorites', 'api_favorites', true);
2415
2416 /**
2417  *
2418  * @param array $item
2419  * @param array $recipient
2420  * @param array $sender
2421  *
2422  * @return array
2423  * @throws InternalServerErrorException
2424  */
2425 function api_format_messages($item, $recipient, $sender)
2426 {
2427         // standard meta information
2428         $ret = [
2429                 'id'                    => $item['id'],
2430                 'sender_id'             => $sender['id'],
2431                 'text'                  => "",
2432                 'recipient_id'          => $recipient['id'],
2433                 'created_at'            => api_date($item['created'] ?? DateTimeFormat::utcNow()),
2434                 'sender_screen_name'    => $sender['screen_name'],
2435                 'recipient_screen_name' => $recipient['screen_name'],
2436                 'sender'                => $sender,
2437                 'recipient'             => $recipient,
2438                 'title'                 => "",
2439                 'friendica_seen'        => $item['seen'] ?? 0,
2440                 'friendica_parent_uri'  => $item['parent-uri'] ?? '',
2441         ];
2442
2443         // "uid" and "self" are only needed for some internal stuff, so remove it from here
2444         if (isset($ret['sender']['uid'])) {
2445                 unset($ret['sender']['uid']);
2446         }
2447         if (isset($ret['sender']['self'])) {
2448                 unset($ret['sender']['self']);
2449         }
2450         if (isset($ret['recipient']['uid'])) {
2451                 unset($ret['recipient']['uid']);
2452         }
2453         if (isset($ret['recipient']['self'])) {
2454                 unset($ret['recipient']['self']);
2455         }
2456
2457         //don't send title to regular StatusNET requests to avoid confusing these apps
2458         if (!empty($_GET['getText'])) {
2459                 $ret['title'] = $item['title'];
2460                 if ($_GET['getText'] == 'html') {
2461                         $ret['text'] = BBCode::convert($item['body'], false);
2462                 } elseif ($_GET['getText'] == 'plain') {
2463                         $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2464                 }
2465         } else {
2466                 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2467         }
2468         if (!empty($_GET['getUserObjects']) && $_GET['getUserObjects'] == 'false') {
2469                 unset($ret['sender']);
2470                 unset($ret['recipient']);
2471         }
2472
2473         return $ret;
2474 }
2475
2476 /**
2477  *
2478  * @param array $item
2479  *
2480  * @return array
2481  * @throws InternalServerErrorException
2482  */
2483 function api_convert_item($item)
2484 {
2485         $body = $item['body'];
2486         $attachments = api_get_attachments($body);
2487
2488         // Workaround for ostatus messages where the title is identically to the body
2489         $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2490         $statusbody = trim(HTML::toPlaintext($html, 0));
2491
2492         // handle data: images
2493         $statusbody = api_format_items_embeded_images($item, $statusbody);
2494
2495         $statustitle = trim($item['title']);
2496
2497         if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2498                 $statustext = trim($statusbody);
2499         } else {
2500                 $statustext = trim($statustitle."\n\n".$statusbody);
2501         }
2502
2503         if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (mb_strlen($statustext)> 1000)) {
2504                 $statustext = mb_substr($statustext, 0, 1000) . "... \n" . ($item['plink'] ?? '');
2505         }
2506
2507         $statushtml = BBCode::convert(BBCode::removeAttachment($body), false);
2508
2509         // Workaround for clients with limited HTML parser functionality
2510         $search = ["<br>", "<blockquote>", "</blockquote>",
2511                         "<h1>", "</h1>", "<h2>", "</h2>",
2512                         "<h3>", "</h3>", "<h4>", "</h4>",
2513                         "<h5>", "</h5>", "<h6>", "</h6>"];
2514         $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2515                         "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2516                         "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2517                         "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2518         $statushtml = str_replace($search, $replace, $statushtml);
2519
2520         if ($item['title'] != "") {
2521                 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2522         }
2523
2524         do {
2525                 $oldtext = $statushtml;
2526                 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2527         } while ($oldtext != $statushtml);
2528
2529         if (substr($statushtml, 0, 4) == '<br>') {
2530                 $statushtml = substr($statushtml, 4);
2531         }
2532
2533         if (substr($statushtml, 0, -4) == '<br>') {
2534                 $statushtml = substr($statushtml, -4);
2535         }
2536
2537         // feeds without body should contain the link
2538         if ((($item['network'] ?? Protocol::PHANTOM) == Protocol::FEED) && (strlen($item['body']) == 0)) {
2539                 $statushtml .= BBCode::convert($item['plink']);
2540         }
2541
2542         $entities = api_get_entitities($statustext, $body);
2543
2544         return [
2545                 "text" => $statustext,
2546                 "html" => $statushtml,
2547                 "attachments" => $attachments,
2548                 "entities" => $entities
2549         ];
2550 }
2551
2552 /**
2553  *
2554  * @param string $body
2555  *
2556  * @return array
2557  * @throws InternalServerErrorException
2558  */
2559 function api_get_attachments(&$body)
2560 {
2561         $text = $body;
2562         $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2563         $text = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $text);
2564
2565         $URLSearchString = "^\[\]";
2566         $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2567
2568         if (!$ret) {
2569                 return [];
2570         }
2571
2572         $attachments = [];
2573
2574         foreach ($images[1] as $image) {
2575                 $imagedata = Images::getInfoFromURLCached($image);
2576
2577                 if ($imagedata) {
2578                         $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2579                 }
2580         }
2581
2582         if (strstr($_SERVER['HTTP_USER_AGENT'] ?? '', 'AndStatus')) {
2583                 foreach ($images[0] as $orig) {
2584                         $body = str_replace($orig, "", $body);
2585                 }
2586         }
2587
2588         return $attachments;
2589 }
2590
2591 /**
2592  *
2593  * @param string $text
2594  * @param string $bbcode
2595  *
2596  * @return array
2597  * @throws InternalServerErrorException
2598  * @todo Links at the first character of the post
2599  */
2600 function api_get_entitities(&$text, $bbcode)
2601 {
2602         $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
2603
2604         if ($include_entities != "true") {
2605                 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2606
2607                 foreach ($images[1] as $image) {
2608                         $replace = ProxyUtils::proxifyUrl($image);
2609                         $text = str_replace($image, $replace, $text);
2610                 }
2611                 return [];
2612         }
2613
2614         $bbcode = BBCode::cleanPictureLinks($bbcode);
2615
2616         // Change pure links in text to bbcode uris
2617         $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2618
2619         $entities = [];
2620         $entities["hashtags"] = [];
2621         $entities["symbols"] = [];
2622         $entities["urls"] = [];
2623         $entities["user_mentions"] = [];
2624
2625         $URLSearchString = "^\[\]";
2626
2627         $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2628
2629         $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2630         //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2631         $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2632
2633         $bbcode = preg_replace(
2634                 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2635                 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2636                 $bbcode
2637         );
2638         $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2639
2640         $bbcode = preg_replace(
2641                 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2642                 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2643                 $bbcode
2644         );
2645         $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2646
2647         $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2648
2649         //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2650         preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2651
2652         $ordered_urls = [];
2653         foreach ($urls[1] as $id => $url) {
2654                 //$start = strpos($text, $url, $offset);
2655                 $start = iconv_strpos($text, $url, 0, "UTF-8");
2656                 if (!($start === false)) {
2657                         $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2658                 }
2659         }
2660
2661         ksort($ordered_urls);
2662
2663         $offset = 0;
2664         //foreach ($urls[1] AS $id=>$url) {
2665         foreach ($ordered_urls as $url) {
2666                 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2667                         && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2668                 ) {
2669                         $display_url = $url["title"];
2670                 } else {
2671                         $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2672                         $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2673
2674                         if (strlen($display_url) > 26) {
2675                                 $display_url = substr($display_url, 0, 25)."…";
2676                         }
2677                 }
2678
2679                 //$start = strpos($text, $url, $offset);
2680                 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2681                 if (!($start === false)) {
2682                         $entities["urls"][] = ["url" => $url["url"],
2683                                                         "expanded_url" => $url["url"],
2684                                                         "display_url" => $display_url,
2685                                                         "indices" => [$start, $start+strlen($url["url"])]];
2686                         $offset = $start + 1;
2687                 }
2688         }
2689
2690         preg_match_all("/\[img\=(.*?)\](.*?)\[\/img\]/ism", $bbcode, $images, PREG_SET_ORDER);
2691         $ordered_images = [];
2692         foreach ($images as $image) {
2693                 $start = iconv_strpos($text, $image[1], 0, "UTF-8");
2694                 if (!($start === false)) {
2695                         $ordered_images[$start] = ['url' => $image[1], 'alt' => $image[2]];
2696                 }
2697         }
2698
2699         preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2700         foreach ($images[1] as $image) {
2701                 $start = iconv_strpos($text, $image, 0, "UTF-8");
2702                 if (!($start === false)) {
2703                         $ordered_images[$start] = ['url' => $image, 'alt' => ''];
2704                 }
2705         }
2706         //$entities["media"] = array();
2707         $offset = 0;
2708
2709         foreach ($ordered_images as $image) {
2710                 $url = $image['url'];
2711                 $ext_alt_text = $image['alt'];
2712
2713                 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2714                 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2715
2716                 if (strlen($display_url) > 26) {
2717                         $display_url = substr($display_url, 0, 25)."…";
2718                 }
2719
2720                 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2721                 if (!($start === false)) {
2722                         $image = Images::getInfoFromURLCached($url);
2723                         if ($image) {
2724                                 // If image cache is activated, then use the following sizes:
2725                                 // thumb  (150), small (340), medium (600) and large (1024)
2726                                 if (!Config::get("system", "proxy_disabled")) {
2727                                         $media_url = ProxyUtils::proxifyUrl($url);
2728
2729                                         $sizes = [];
2730                                         $scale = Images::getScalingDimensions($image[0], $image[1], 150);
2731                                         $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2732
2733                                         if (($image[0] > 150) || ($image[1] > 150)) {
2734                                                 $scale = Images::getScalingDimensions($image[0], $image[1], 340);
2735                                                 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2736                                         }
2737
2738                                         $scale = Images::getScalingDimensions($image[0], $image[1], 600);
2739                                         $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2740
2741                                         if (($image[0] > 600) || ($image[1] > 600)) {
2742                                                 $scale = Images::getScalingDimensions($image[0], $image[1], 1024);
2743                                                 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2744                                         }
2745                                 } else {
2746                                         $media_url = $url;
2747                                         $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2748                                 }
2749
2750                                 $entities["media"][] = [
2751                                                         "id" => $start+1,
2752                                                         "id_str" => (string) ($start + 1),
2753                                                         "indices" => [$start, $start+strlen($url)],
2754                                                         "media_url" => Strings::normaliseLink($media_url),
2755                                                         "media_url_https" => $media_url,
2756                                                         "url" => $url,
2757                                                         "display_url" => $display_url,
2758                                                         "expanded_url" => $url,
2759                                                         "ext_alt_text" => $ext_alt_text,
2760                                                         "type" => "photo",
2761                                                         "sizes" => $sizes];
2762                         }
2763                         $offset = $start + 1;
2764                 }
2765         }
2766
2767         return $entities;
2768 }
2769
2770 /**
2771  *
2772  * @param array $item
2773  * @param string $text
2774  *
2775  * @return string
2776  */
2777 function api_format_items_embeded_images($item, $text)
2778 {
2779         $text = preg_replace_callback(
2780                 '|data:image/([^;]+)[^=]+=*|m',
2781                 function () use ($item) {
2782                         return System::baseUrl() . '/display/' . $item['guid'];
2783                 },
2784                 $text
2785         );
2786         return $text;
2787 }
2788
2789 /**
2790  * @brief return <a href='url'>name</a> as array
2791  *
2792  * @param string $txt text
2793  * @return array
2794  *                      'name' => 'name',
2795  *                      'url => 'url'
2796  */
2797 function api_contactlink_to_array($txt)
2798 {
2799         $match = [];
2800         $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2801         if ($r && count($match)==3) {
2802                 $res = [
2803                         'name' => $match[2],
2804                         'url' => $match[1]
2805                 ];
2806         } else {
2807                 $res = [
2808                         'name' => $txt,
2809                         'url' => ""
2810                 ];
2811         }
2812         return $res;
2813 }
2814
2815
2816 /**
2817  * @brief return likes, dislikes and attend status for item
2818  *
2819  * @param array  $item array
2820  * @param string $type Return type (atom, rss, xml, json)
2821  *
2822  * @return array
2823  *            likes => int count,
2824  *            dislikes => int count
2825  * @throws BadRequestException
2826  * @throws ImagickException
2827  * @throws InternalServerErrorException
2828  * @throws UnauthorizedException
2829  */
2830 function api_format_items_activities($item, $type = "json")
2831 {
2832         $a = \get_app();
2833
2834         $activities = [
2835                 'like' => [],
2836                 'dislike' => [],
2837                 'attendyes' => [],
2838                 'attendno' => [],
2839                 'attendmaybe' => [],
2840         ];
2841
2842         $condition = ['uid' => $item['uid'], 'thr-parent' => $item['uri']];
2843         $ret = Item::selectForUser($item['uid'], ['author-id', 'verb'], $condition);
2844
2845         while ($parent_item = Item::fetch($ret)) {
2846                 // not used as result should be structured like other user data
2847                 //builtin_activity_puller($i, $activities);
2848
2849                 // get user data and add it to the array of the activity
2850                 $user = api_get_user($a, $parent_item['author-id']);
2851                 switch ($parent_item['verb']) {
2852                         case Activity::LIKE:
2853                                 $activities['like'][] = $user;
2854                                 break;
2855                         case Activity::DISLIKE:
2856                                 $activities['dislike'][] = $user;
2857                                 break;
2858                         case Activity::ATTEND:
2859                                 $activities['attendyes'][] = $user;
2860                                 break;
2861                         case Activity::ATTENDNO:
2862                                 $activities['attendno'][] = $user;
2863                                 break;
2864                         case Activity::ATTENDMAYBE:
2865                                 $activities['attendmaybe'][] = $user;
2866                                 break;
2867                         default:
2868                                 break;
2869                 }
2870         }
2871
2872         DBA::close($ret);
2873
2874         if ($type == "xml") {
2875                 $xml_activities = [];
2876                 foreach ($activities as $k => $v) {
2877                         // change xml element from "like" to "friendica:like"
2878                         $xml_activities["friendica:".$k] = $v;
2879                         // add user data into xml output
2880                         $k_user = 0;
2881                         foreach ($v as $user) {
2882                                 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
2883                         }
2884                 }
2885                 $activities = $xml_activities;
2886         }
2887
2888         return $activities;
2889 }
2890
2891
2892 /**
2893  * @brief return data from profiles
2894  *
2895  * @param array $profile_row array containing data from db table 'profile'
2896  * @return array
2897  * @throws InternalServerErrorException
2898  */
2899 function api_format_items_profiles($profile_row)
2900 {
2901         $profile = [
2902                 'profile_id'       => $profile_row['id'],
2903                 'profile_name'     => $profile_row['profile-name'],
2904                 'is_default'       => $profile_row['is-default'] ? true : false,
2905                 'hide_friends'     => $profile_row['hide-friends'] ? true : false,
2906                 'profile_photo'    => $profile_row['photo'],
2907                 'profile_thumb'    => $profile_row['thumb'],
2908                 'publish'          => $profile_row['publish'] ? true : false,
2909                 'net_publish'      => $profile_row['net-publish'] ? true : false,
2910                 'description'      => $profile_row['pdesc'],
2911                 'date_of_birth'    => $profile_row['dob'],
2912                 'address'          => $profile_row['address'],
2913                 'city'             => $profile_row['locality'],
2914                 'region'           => $profile_row['region'],
2915                 'postal_code'      => $profile_row['postal-code'],
2916                 'country'          => $profile_row['country-name'],
2917                 'hometown'         => $profile_row['hometown'],
2918                 'gender'           => $profile_row['gender'],
2919                 'marital'          => $profile_row['marital'],
2920                 'marital_with'     => $profile_row['with'],
2921                 'marital_since'    => $profile_row['howlong'],
2922                 'sexual'           => $profile_row['sexual'],
2923                 'politic'          => $profile_row['politic'],
2924                 'religion'         => $profile_row['religion'],
2925                 'public_keywords'  => $profile_row['pub_keywords'],
2926                 'private_keywords' => $profile_row['prv_keywords'],
2927                 'likes'            => BBCode::convert(api_clean_plain_items($profile_row['likes'])    , false, 2),
2928                 'dislikes'         => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
2929                 'about'            => BBCode::convert(api_clean_plain_items($profile_row['about'])    , false, 2),
2930                 'music'            => BBCode::convert(api_clean_plain_items($profile_row['music'])    , false, 2),
2931                 'book'             => BBCode::convert(api_clean_plain_items($profile_row['book'])     , false, 2),
2932                 'tv'               => BBCode::convert(api_clean_plain_items($profile_row['tv'])       , false, 2),
2933                 'film'             => BBCode::convert(api_clean_plain_items($profile_row['film'])     , false, 2),
2934                 'interest'         => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
2935                 'romance'          => BBCode::convert(api_clean_plain_items($profile_row['romance'])  , false, 2),
2936                 'work'             => BBCode::convert(api_clean_plain_items($profile_row['work'])     , false, 2),
2937                 'education'        => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
2938                 'social_networks'  => BBCode::convert(api_clean_plain_items($profile_row['contact'])  , false, 2),
2939                 'homepage'         => $profile_row['homepage'],
2940                 'users'            => null
2941         ];
2942         return $profile;
2943 }
2944
2945 /**
2946  * @brief format items to be returned by api
2947  *
2948  * @param array  $items       array of items
2949  * @param array  $user_info
2950  * @param bool   $filter_user filter items by $user_info
2951  * @param string $type        Return type (atom, rss, xml, json)
2952  * @return array
2953  * @throws BadRequestException
2954  * @throws ImagickException
2955  * @throws InternalServerErrorException
2956  * @throws UnauthorizedException
2957  */
2958 function api_format_items($items, $user_info, $filter_user = false, $type = "json")
2959 {
2960         $a = BaseObject::getApp();
2961
2962         $ret = [];
2963
2964         foreach ((array)$items as $item) {
2965                 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
2966
2967                 // Look if the posts are matching if they should be filtered by user id
2968                 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
2969                         continue;
2970                 }
2971
2972                 $status = api_format_item($item, $type, $status_user, $author_user, $owner_user);
2973
2974                 $ret[] = $status;
2975         }
2976
2977         return $ret;
2978 }
2979
2980 /**
2981  * @param array  $item       Item record
2982  * @param string $type       Return format (atom, rss, xml, json)
2983  * @param array $status_user User record of the item author, can be provided by api_item_get_user()
2984  * @param array $author_user User record of the item author, can be provided by api_item_get_user()
2985  * @param array $owner_user  User record of the item owner, can be provided by api_item_get_user()
2986  * @return array API-formatted status
2987  * @throws BadRequestException
2988  * @throws ImagickException
2989  * @throws InternalServerErrorException
2990  * @throws UnauthorizedException
2991  */
2992 function api_format_item($item, $type = "json", $status_user = null, $author_user = null, $owner_user = null)
2993 {
2994         $a = BaseObject::getApp();
2995
2996         if (empty($status_user) || empty($author_user) || empty($owner_user)) {
2997                 list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
2998         }
2999
3000         localize_item($item);
3001
3002         $in_reply_to = api_in_reply_to($item);
3003
3004         $converted = api_convert_item($item);
3005
3006         if ($type == "xml") {
3007                 $geo = "georss:point";
3008         } else {
3009                 $geo = "geo";
3010         }
3011
3012         $status = [
3013                 'text'          => $converted["text"],
3014                 'truncated' => false,
3015                 'created_at'=> api_date($item['created']),
3016                 'in_reply_to_status_id' => $in_reply_to['status_id'],
3017                 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
3018                 'source'    => (($item['app']) ? $item['app'] : 'web'),
3019                 'id'            => intval($item['id']),
3020                 'id_str'        => (string) intval($item['id']),
3021                 'in_reply_to_user_id' => $in_reply_to['user_id'],
3022                 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
3023                 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
3024                 $geo => null,
3025                 'favorited' => $item['starred'] ? true : false,
3026                 'user' =>  $status_user,
3027                 'friendica_author' => $author_user,
3028                 'friendica_owner' => $owner_user,
3029                 'friendica_private' => $item['private'] == 1,
3030                 //'entities' => NULL,
3031                 'statusnet_html' => $converted["html"],
3032                 'statusnet_conversation_id' => $item['parent'],
3033                 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
3034                 'friendica_activities' => api_format_items_activities($item, $type),
3035                 'friendica_title' => $item['title'],
3036                 'friendica_html' => BBCode::convert($item['body'], false)
3037         ];
3038
3039         if (count($converted["attachments"]) > 0) {
3040                 $status["attachments"] = $converted["attachments"];
3041         }
3042
3043         if (count($converted["entities"]) > 0) {
3044                 $status["entities"] = $converted["entities"];
3045         }
3046
3047         if ($status["source"] == 'web') {
3048                 $status["source"] = ContactSelector::networkToName($item['network'], $item['author-link']);
3049         } elseif (ContactSelector::networkToName($item['network'], $item['author-link']) != $status["source"]) {
3050                 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $item['author-link']).')');
3051         }
3052
3053         $retweeted_item = [];
3054         $quoted_item = [];
3055
3056         if ($item["id"] == $item["parent"]) {
3057                 $body = $item['body'];
3058                 $retweeted_item = api_share_as_retweet($item);
3059                 if ($body != $item['body']) {
3060                         $quoted_item = $retweeted_item;
3061                         $retweeted_item = [];
3062                 }
3063         }
3064
3065         if (empty($retweeted_item) && ($item['owner-id'] == $item['author-id'])) {
3066                 $announce = api_get_announce($item);
3067                 if (!empty($announce)) {
3068                         $retweeted_item = $item;
3069                         $item = $announce;
3070                         $status['friendica_owner'] = api_get_user($a, $announce['author-id']);
3071                 }
3072         }
3073
3074         if (!empty($quoted_item)) {
3075                 $conv_quoted = api_convert_item($quoted_item);
3076                 $quoted_status = $status;
3077                 unset($quoted_status['friendica_author']);
3078                 unset($quoted_status['friendica_owner']);
3079                 unset($quoted_status['friendica_activities']);
3080                 unset($quoted_status['friendica_private']);
3081                 unset($quoted_status['statusnet_conversation_id']);
3082                 $quoted_status['text'] = $conv_quoted['text'];
3083                 $quoted_status['statusnet_html'] = $conv_quoted['html'];
3084                 try {
3085                         $quoted_status["user"] = api_get_user($a, $quoted_item["author-id"]);
3086                 } catch (BadRequestException $e) {
3087                         // user not found. should be found?
3088                         /// @todo check if the user should be always found
3089                         $quoted_status["user"] = [];
3090                 }
3091         }
3092
3093         if (!empty($retweeted_item)) {
3094                 $retweeted_status = $status;
3095                 unset($retweeted_status['friendica_author']);
3096                 unset($retweeted_status['friendica_owner']);
3097                 unset($retweeted_status['friendica_activities']);
3098                 unset($retweeted_status['friendica_private']);
3099                 unset($retweeted_status['statusnet_conversation_id']);
3100                 $status['user'] = $status['friendica_owner'];
3101                 try {
3102                         $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
3103                 } catch (BadRequestException $e) {
3104                         // user not found. should be found?
3105                         /// @todo check if the user should be always found
3106                         $retweeted_status["user"] = [];
3107                 }
3108
3109                 $rt_converted = api_convert_item($retweeted_item);
3110
3111                 $retweeted_status['text'] = $rt_converted["text"];
3112                 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3113                 $retweeted_status['created_at'] =  api_date($retweeted_item['created']);
3114
3115                 if (!empty($quoted_status)) {
3116                         $retweeted_status['quoted_status'] = $quoted_status;
3117                 }
3118
3119                 $status['friendica_author'] = $retweeted_status['user'];
3120                 $status['retweeted_status'] = $retweeted_status;
3121         } elseif (!empty($quoted_status)) {
3122                 $root_status = api_convert_item($item);
3123
3124                 $status['text'] = $root_status["text"];
3125                 $status['statusnet_html'] = $root_status["html"];
3126                 $status['quoted_status'] = $quoted_status;
3127         }
3128
3129         // "uid" and "self" are only needed for some internal stuff, so remove it from here
3130         unset($status["user"]["uid"]);
3131         unset($status["user"]["self"]);
3132
3133         if ($item["coord"] != "") {
3134                 $coords = explode(' ', $item["coord"]);
3135                 if (count($coords) == 2) {
3136                         if ($type == "json") {
3137                                 $status["geo"] = ['type' => 'Point',
3138                                         'coordinates' => [(float) $coords[0],
3139                                                 (float) $coords[1]]];
3140                         } else {// Not sure if this is the official format - if someone founds a documentation we can check
3141                                 $status["georss:point"] = $item["coord"];
3142                         }
3143                 }
3144         }
3145
3146         return $status;
3147 }
3148
3149 /**
3150  * Returns the remaining number of API requests available to the user before the API limit is reached.
3151  *
3152  * @param string $type Return type (atom, rss, xml, json)
3153  *
3154  * @return array|string
3155  * @throws Exception
3156  */
3157 function api_account_rate_limit_status($type)
3158 {
3159         if ($type == "xml") {
3160                 $hash = [
3161                                 'remaining-hits' => '150',
3162                                 '@attributes' => ["type" => "integer"],
3163                                 'hourly-limit' => '150',
3164                                 '@attributes2' => ["type" => "integer"],
3165                                 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
3166                                 '@attributes3' => ["type" => "datetime"],
3167                                 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3168                                 '@attributes4' => ["type" => "integer"],
3169                         ];
3170         } else {
3171                 $hash = [
3172                                 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3173                                 'remaining_hits' => '150',
3174                                 'hourly_limit' => '150',
3175                                 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
3176                         ];
3177         }
3178
3179         return api_format_data('hash', $type, ['hash' => $hash]);
3180 }
3181
3182 /// @TODO move to top of file or somewhere better
3183 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3184
3185 /**
3186  * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3187  *
3188  * @param string $type Return type (atom, rss, xml, json)
3189  *
3190  * @return array|string
3191  */
3192 function api_help_test($type)
3193 {
3194         if ($type == 'xml') {
3195                 $ok = "true";
3196         } else {
3197                 $ok = "ok";
3198         }
3199
3200         return api_format_data('ok', $type, ["ok" => $ok]);
3201 }
3202
3203 /// @TODO move to top of file or somewhere better
3204 api_register_func('api/help/test', 'api_help_test', false);
3205
3206 /**
3207  * Returns all lists the user subscribes to.
3208  *
3209  * @param string $type Return type (atom, rss, xml, json)
3210  *
3211  * @return array|string
3212  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3213  */
3214 function api_lists_list($type)
3215 {
3216         $ret = [];
3217         /// @TODO $ret is not filled here?
3218         return api_format_data('lists', $type, ["lists_list" => $ret]);
3219 }
3220
3221 /// @TODO move to top of file or somewhere better
3222 api_register_func('api/lists/list', 'api_lists_list', true);
3223 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3224
3225 /**
3226  * Returns all groups the user owns.
3227  *
3228  * @param string $type Return type (atom, rss, xml, json)
3229  *
3230  * @return array|string
3231  * @throws BadRequestException
3232  * @throws ForbiddenException
3233  * @throws ImagickException
3234  * @throws InternalServerErrorException
3235  * @throws UnauthorizedException
3236  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3237  */
3238 function api_lists_ownerships($type)
3239 {
3240         $a = \get_app();
3241
3242         if (api_user() === false) {
3243                 throw new ForbiddenException();
3244         }
3245
3246         // params
3247         $user_info = api_get_user($a);
3248         $uid = $user_info['uid'];
3249
3250         $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3251
3252         // loop through all groups
3253         $lists = [];
3254         foreach ($groups as $group) {
3255                 if ($group['visible']) {
3256                         $mode = 'public';
3257                 } else {
3258                         $mode = 'private';
3259                 }
3260                 $lists[] = [
3261                         'name' => $group['name'],
3262                         'id' => intval($group['id']),
3263                         'id_str' => (string) $group['id'],
3264                         'user' => $user_info,
3265                         'mode' => $mode
3266                 ];
3267         }
3268         return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3269 }
3270
3271 /// @TODO move to top of file or somewhere better
3272 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3273
3274 /**
3275  * Returns recent statuses from users in the specified group.
3276  *
3277  * @param string $type Return type (atom, rss, xml, json)
3278  *
3279  * @return array|string
3280  * @throws BadRequestException
3281  * @throws ForbiddenException
3282  * @throws ImagickException
3283  * @throws InternalServerErrorException
3284  * @throws UnauthorizedException
3285  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3286  */
3287 function api_lists_statuses($type)
3288 {
3289         $a = \get_app();
3290
3291         $user_info = api_get_user($a);
3292         if (api_user() === false || $user_info === false) {
3293                 throw new ForbiddenException();
3294         }
3295
3296         unset($_REQUEST["user_id"]);
3297         unset($_GET["user_id"]);
3298
3299         unset($_REQUEST["screen_name"]);
3300         unset($_GET["screen_name"]);
3301
3302         if (empty($_REQUEST['list_id'])) {
3303                 throw new BadRequestException('list_id not specified');
3304         }
3305
3306         // params
3307         $count = $_REQUEST['count'] ?? 20;
3308         $page = $_REQUEST['page'] ?? 1;
3309         $since_id = $_REQUEST['since_id'] ?? 0;
3310         $max_id = $_REQUEST['max_id'] ?? 0;
3311         $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0);
3312         $conversation_id = $_REQUEST['conversation_id'] ?? 0;
3313
3314         $start = max(0, ($page - 1) * $count);
3315
3316         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3317                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3318
3319         if ($max_id > 0) {
3320                 $condition[0] .= " AND `item`.`id` <= ?";
3321                 $condition[] = $max_id;
3322         }
3323         if ($exclude_replies > 0) {
3324                 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
3325         }
3326         if ($conversation_id > 0) {
3327                 $condition[0] .= " AND `item`.`parent` = ?";
3328                 $condition[] = $conversation_id;
3329         }
3330
3331         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3332         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3333
3334         $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3335
3336         $data = ['status' => $items];
3337         switch ($type) {
3338                 case "atom":
3339                         break;
3340                 case "rss":
3341                         $data = api_rss_extra($a, $data, $user_info);
3342                         break;
3343         }
3344
3345         return api_format_data("statuses", $type, $data);
3346 }
3347
3348 /// @TODO move to top of file or somewhere better
3349 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3350
3351 /**
3352  * Considers friends and followers lists to be private and won't return
3353  * anything if any user_id parameter is passed.
3354  *
3355  * @brief Returns either the friends of the follower list
3356  *
3357  * @param string $qtype Either "friends" or "followers"
3358  * @return boolean|array
3359  * @throws BadRequestException
3360  * @throws ForbiddenException
3361  * @throws ImagickException
3362  * @throws InternalServerErrorException
3363  * @throws UnauthorizedException
3364  */
3365 function api_statuses_f($qtype)
3366 {
3367         $a = \get_app();
3368
3369         if (api_user() === false) {
3370                 throw new ForbiddenException();
3371         }
3372
3373         // pagination
3374         $count = $_GET['count'] ?? 20;
3375         $page = $_GET['page'] ?? 1;
3376
3377         $start = max(0, ($page - 1) * $count);
3378
3379         $user_info = api_get_user($a);
3380
3381         if (!empty($_GET['cursor']) && $_GET['cursor'] == 'undefined') {
3382                 /* this is to stop Hotot to load friends multiple times
3383                 *  I'm not sure if I'm missing return something or
3384                 *  is a bug in hotot. Workaround, meantime
3385                 */
3386
3387                 /*$ret=Array();
3388                 return array('$users' => $ret);*/
3389                 return false;
3390         }
3391
3392         $sql_extra = '';
3393         if ($qtype == 'friends') {
3394                 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
3395         } elseif ($qtype == 'followers') {
3396                 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
3397         }
3398
3399         // friends and followers only for self
3400         if ($user_info['self'] == 0) {
3401                 $sql_extra = " AND false ";
3402         }
3403
3404         if ($qtype == 'blocks') {
3405                 $sql_filter = 'AND `blocked` AND NOT `pending`';
3406         } elseif ($qtype == 'incoming') {
3407                 $sql_filter = 'AND `pending`';
3408         } else {
3409                 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3410         }
3411
3412         $r = q(
3413                 "SELECT `nurl`
3414                 FROM `contact`
3415                 WHERE `uid` = %d
3416                 AND NOT `self`
3417                 $sql_filter
3418                 $sql_extra
3419                 ORDER BY `nick`
3420                 LIMIT %d, %d",
3421                 intval(api_user()),
3422                 intval($start),
3423                 intval($count)
3424         );
3425
3426         $ret = [];
3427         foreach ($r as $cid) {
3428                 $user = api_get_user($a, $cid['nurl']);
3429                 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3430                 unset($user["uid"]);
3431                 unset($user["self"]);
3432
3433                 if ($user) {
3434                         $ret[] = $user;
3435                 }
3436         }
3437
3438         return ['user' => $ret];
3439 }
3440
3441
3442 /**
3443  * Returns the user's friends.
3444  *
3445  * @brief      Returns the list of friends of the provided user
3446  *
3447  * @deprecated By Twitter API in favor of friends/list
3448  *
3449  * @param string $type Either "json" or "xml"
3450  * @return boolean|string|array
3451  * @throws BadRequestException
3452  * @throws ForbiddenException
3453  */
3454 function api_statuses_friends($type)
3455 {
3456         $data =  api_statuses_f("friends");
3457         if ($data === false) {
3458                 return false;
3459         }
3460         return api_format_data("users", $type, $data);
3461 }
3462
3463 /**
3464  * Returns the user's followers.
3465  *
3466  * @brief      Returns the list of followers of the provided user
3467  *
3468  * @deprecated By Twitter API in favor of friends/list
3469  *
3470  * @param string $type Either "json" or "xml"
3471  * @return boolean|string|array
3472  * @throws BadRequestException
3473  * @throws ForbiddenException
3474  */
3475 function api_statuses_followers($type)
3476 {
3477         $data = api_statuses_f("followers");
3478         if ($data === false) {
3479                 return false;
3480         }
3481         return api_format_data("users", $type, $data);
3482 }
3483
3484 /// @TODO move to top of file or somewhere better
3485 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3486 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3487
3488 /**
3489  * Returns the list of blocked users
3490  *
3491  * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3492  *
3493  * @param string $type Either "json" or "xml"
3494  *
3495  * @return boolean|string|array
3496  * @throws BadRequestException
3497  * @throws ForbiddenException
3498  */
3499 function api_blocks_list($type)
3500 {
3501         $data =  api_statuses_f('blocks');
3502         if ($data === false) {
3503                 return false;
3504         }
3505         return api_format_data("users", $type, $data);
3506 }
3507
3508 /// @TODO move to top of file or somewhere better
3509 api_register_func('api/blocks/list', 'api_blocks_list', true);
3510
3511 /**
3512  * Returns the list of pending users IDs
3513  *
3514  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3515  *
3516  * @param string $type Either "json" or "xml"
3517  *
3518  * @return boolean|string|array
3519  * @throws BadRequestException
3520  * @throws ForbiddenException
3521  */
3522 function api_friendships_incoming($type)
3523 {
3524         $data =  api_statuses_f('incoming');
3525         if ($data === false) {
3526                 return false;
3527         }
3528
3529         $ids = [];
3530         foreach ($data['user'] as $user) {
3531                 $ids[] = $user['id'];
3532         }
3533
3534         return api_format_data("ids", $type, ['id' => $ids]);
3535 }
3536
3537 /// @TODO move to top of file or somewhere better
3538 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3539
3540 /**
3541  * Returns the instance's configuration information.
3542  *
3543  * @param string $type Return type (atom, rss, xml, json)
3544  *
3545  * @return array|string
3546  * @throws InternalServerErrorException
3547  */
3548 function api_statusnet_config($type)
3549 {
3550         $a = \get_app();
3551
3552         $name      = Config::get('config', 'sitename');
3553         $server    = $a->getHostName();
3554         $logo      = System::baseUrl() . '/images/friendica-64.png';
3555         $email     = Config::get('config', 'admin_email');
3556         $closed    = intval(Config::get('config', 'register_policy')) === \Friendica\Module\Register::CLOSED ? 'true' : 'false';
3557         $private   = Config::get('system', 'block_public') ? 'true' : 'false';
3558         $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000));
3559         $ssl       = Config::get('system', 'have_ssl') ? 'true' : 'false';
3560         $sslserver = Config::get('system', 'have_ssl') ? str_replace('http:', 'https:', System::baseUrl()) : '';
3561
3562         $config = [
3563                 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3564                         'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3565                         'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3566                         'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3567                         'shorturllength' => '30',
3568                         'friendica' => [
3569                                         'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3570                                         'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3571                                         'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3572                                         'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3573                                         ]
3574                 ],
3575         ];
3576
3577         return api_format_data('config', $type, ['config' => $config]);
3578 }
3579
3580 /// @TODO move to top of file or somewhere better
3581 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3582 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3583
3584 /**
3585  *
3586  * @param string $type Return type (atom, rss, xml, json)
3587  *
3588  * @return array|string
3589  */
3590 function api_statusnet_version($type)
3591 {
3592         // liar
3593         $fake_statusnet_version = "0.9.7";
3594
3595         return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3596 }
3597
3598 /// @TODO move to top of file or somewhere better
3599 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3600 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3601
3602 /**
3603  *
3604  * @param string $type Return type (atom, rss, xml, json)
3605  *
3606  * @param int $rel A contact relationship constant
3607  * @return array|string|void
3608  * @throws BadRequestException
3609  * @throws ForbiddenException
3610  * @throws ImagickException
3611  * @throws InternalServerErrorException
3612  * @throws UnauthorizedException
3613  * @todo use api_format_data() to return data
3614  */
3615 function api_ff_ids($type, int $rel)
3616 {
3617         if (!api_user()) {
3618                 throw new ForbiddenException();
3619         }
3620
3621         $a = \get_app();
3622
3623         api_get_user($a);
3624
3625         $stringify_ids = $_REQUEST['stringify_ids'] ?? false;
3626
3627         $contacts = DBA::p("SELECT `pcontact`.`id`
3628                 FROM `contact`
3629                 INNER JOIN `contact` AS `pcontact`
3630                     ON `contact`.`nurl` = `pcontact`.`nurl`
3631                     AND `pcontact`.`uid` = 0
3632                 WHERE `contact`.`uid` = ?
3633                 AND NOT `contact`.`self`
3634                 AND `contact`.`rel` IN (?, ?)",
3635                 api_user(),
3636                 $rel,
3637                 Contact::FRIEND
3638         );
3639
3640         $ids = [];
3641         foreach (DBA::toArray($contacts) as $contact) {
3642                 if ($stringify_ids) {
3643                         $ids[] = $contact['id'];
3644                 } else {
3645                         $ids[] = intval($contact['id']);
3646                 }
3647         }
3648
3649         return api_format_data('ids', $type, ['id' => $ids]);
3650 }
3651
3652 /**
3653  * Returns the ID of every user the user is following.
3654  *
3655  * @param string $type Return type (atom, rss, xml, json)
3656  *
3657  * @return array|string
3658  * @throws BadRequestException
3659  * @throws ForbiddenException
3660  * @throws ImagickException
3661  * @throws InternalServerErrorException
3662  * @throws UnauthorizedException
3663  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3664  */
3665 function api_friends_ids($type)
3666 {
3667         return api_ff_ids($type, Contact::SHARING);
3668 }
3669
3670 /**
3671  * Returns the ID of every user following the user.
3672  *
3673  * @param string $type Return type (atom, rss, xml, json)
3674  *
3675  * @return array|string
3676  * @throws BadRequestException
3677  * @throws ForbiddenException
3678  * @throws ImagickException
3679  * @throws InternalServerErrorException
3680  * @throws UnauthorizedException
3681  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3682  */
3683 function api_followers_ids($type)
3684 {
3685         return api_ff_ids($type, Contact::FOLLOWER);
3686 }
3687
3688 /// @TODO move to top of file or somewhere better
3689 api_register_func('api/friends/ids', 'api_friends_ids', true);
3690 api_register_func('api/followers/ids', 'api_followers_ids', true);
3691
3692 /**
3693  * Sends a new direct message.
3694  *
3695  * @param string $type Return type (atom, rss, xml, json)
3696  *
3697  * @return array|string
3698  * @throws BadRequestException
3699  * @throws ForbiddenException
3700  * @throws ImagickException
3701  * @throws InternalServerErrorException
3702  * @throws NotFoundException
3703  * @throws UnauthorizedException
3704  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3705  */
3706 function api_direct_messages_new($type)
3707 {
3708         $a = \get_app();
3709
3710         if (api_user() === false) {
3711                 throw new ForbiddenException();
3712         }
3713
3714         if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3715                 return;
3716         }
3717
3718         $sender = api_get_user($a);
3719
3720         $recipient = null;
3721         if (!empty($_POST['screen_name'])) {
3722                 $r = q(
3723                         "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3724                         intval(api_user()),
3725                         DBA::escape($_POST['screen_name'])
3726                 );
3727
3728                 if (DBA::isResult($r)) {
3729                         // Selecting the id by priority, friendica first
3730                         api_best_nickname($r);
3731
3732                         $recipient = api_get_user($a, $r[0]['nurl']);
3733                 }
3734         } else {
3735                 $recipient = api_get_user($a, $_POST['user_id']);
3736         }
3737
3738         if (empty($recipient)) {
3739                 throw new NotFoundException('Recipient not found');
3740         }
3741
3742         $replyto = '';
3743         if (!empty($_REQUEST['replyto'])) {
3744                 $r = q(
3745                         'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3746                         intval(api_user()),
3747                         intval($_REQUEST['replyto'])
3748                 );
3749                 $replyto = $r[0]['parent-uri'];
3750                 $sub     = $r[0]['title'];
3751         } else {
3752                 if (!empty($_REQUEST['title'])) {
3753                         $sub = $_REQUEST['title'];
3754                 } else {
3755                         $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3756                 }
3757         }
3758
3759         $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3760
3761         if ($id > -1) {
3762                 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3763                 $ret = api_format_messages($r[0], $recipient, $sender);
3764         } else {
3765                 $ret = ["error"=>$id];
3766         }
3767
3768         $data = ['direct_message'=>$ret];
3769
3770         switch ($type) {
3771                 case "atom":
3772                         break;
3773                 case "rss":
3774                         $data = api_rss_extra($a, $data, $sender);
3775                         break;
3776         }
3777
3778         return api_format_data("direct-messages", $type, $data);
3779 }
3780
3781 /// @TODO move to top of file or somewhere better
3782 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3783
3784 /**
3785  * Destroys a direct message.
3786  *
3787  * @brief delete a direct_message from mail table through api
3788  *
3789  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3790  * @return string|array
3791  * @throws BadRequestException
3792  * @throws ForbiddenException
3793  * @throws ImagickException
3794  * @throws InternalServerErrorException
3795  * @throws UnauthorizedException
3796  * @see   https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3797  */
3798 function api_direct_messages_destroy($type)
3799 {
3800         $a = \get_app();
3801
3802         if (api_user() === false) {
3803                 throw new ForbiddenException();
3804         }
3805
3806         // params
3807         $user_info = api_get_user($a);
3808         //required
3809         $id = $_REQUEST['id'] ?? 0;
3810         // optional
3811         $parenturi = $_REQUEST['friendica_parenturi'] ?? '';
3812         $verbose = (!empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false");
3813         /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3814
3815         $uid = $user_info['uid'];
3816         // error if no id or parenturi specified (for clients posting parent-uri as well)
3817         if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3818                 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3819                 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3820         }
3821
3822         // BadRequestException if no id specified (for clients using Twitter API)
3823         if ($id == 0) {
3824                 throw new BadRequestException('Message id not specified');
3825         }
3826
3827         // add parent-uri to sql command if specified by calling app
3828         $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3829
3830         // get data of the specified message id
3831         $r = q(
3832                 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3833                 intval($uid),
3834                 intval($id)
3835         );
3836
3837         // error message if specified id is not in database
3838         if (!DBA::isResult($r)) {
3839                 if ($verbose == "true") {
3840                         $answer = ['result' => 'error', 'message' => 'message id not in database'];
3841                         return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3842                 }
3843                 /// @todo BadRequestException ok for Twitter API clients?
3844                 throw new BadRequestException('message id not in database');
3845         }
3846
3847         // delete message
3848         $result = q(
3849                 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3850                 intval($uid),
3851                 intval($id)
3852         );
3853
3854         if ($verbose == "true") {
3855                 if ($result) {
3856                         // return success
3857                         $answer = ['result' => 'ok', 'message' => 'message deleted'];
3858                         return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3859                 } else {
3860                         $answer = ['result' => 'error', 'message' => 'unknown error'];
3861                         return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3862                 }
3863         }
3864         /// @todo return JSON data like Twitter API not yet implemented
3865 }
3866
3867 /// @TODO move to top of file or somewhere better
3868 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3869
3870 /**
3871  * Unfollow Contact
3872  *
3873  * @brief unfollow contact
3874  *
3875  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3876  * @return string|array
3877  * @throws BadRequestException
3878  * @throws ForbiddenException
3879  * @throws ImagickException
3880  * @throws InternalServerErrorException
3881  * @throws NotFoundException
3882  * @see   https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3883  */
3884 function api_friendships_destroy($type)
3885 {
3886         $uid = api_user();
3887
3888         if ($uid === false) {
3889                 throw new ForbiddenException();
3890         }
3891
3892         $contact_id = $_REQUEST['user_id'] ?? 0;
3893
3894         if (empty($contact_id)) {
3895                 Logger::notice(API_LOG_PREFIX . 'No user_id specified', ['module' => 'api', 'action' => 'friendships_destroy']);
3896                 throw new BadRequestException("no user_id specified");
3897         }
3898
3899         // Get Contact by given id
3900         $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3901
3902         if(!DBA::isResult($contact)) {
3903                 Logger::notice(API_LOG_PREFIX . 'No contact found for ID {contact}', ['module' => 'api', 'action' => 'friendships_destroy', 'contact' => $contact_id]);
3904                 throw new NotFoundException("no contact found to given ID");
3905         }
3906
3907         $url = $contact["url"];
3908
3909         $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3910                         $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url),
3911                         Strings::normaliseLink($url), $url];
3912         $contact = DBA::selectFirst('contact', [], $condition);
3913
3914         if (!DBA::isResult($contact)) {
3915                 Logger::notice(API_LOG_PREFIX . 'Not following contact', ['module' => 'api', 'action' => 'friendships_destroy']);
3916                 throw new NotFoundException("Not following Contact");
3917         }
3918
3919         if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
3920                 Logger::notice(API_LOG_PREFIX . 'Not supported for {network}', ['module' => 'api', 'action' => 'friendships_destroy', 'network' => $contact['network']]);
3921                 throw new ExpectationFailedException("Not supported");
3922         }
3923
3924         $dissolve = ($contact['rel'] == Contact::SHARING);
3925
3926         $owner = User::getOwnerDataById($uid);
3927         if ($owner) {
3928                 Contact::terminateFriendship($owner, $contact, $dissolve);
3929         }
3930         else {
3931                 Logger::notice(API_LOG_PREFIX . 'No owner {uid} found', ['module' => 'api', 'action' => 'friendships_destroy', 'uid' => $uid]);
3932                 throw new NotFoundException("Error Processing Request");
3933         }
3934
3935         // Sharing-only contacts get deleted as there no relationship any more
3936         if ($dissolve) {
3937                 Contact::remove($contact['id']);
3938         } else {
3939                 DBA::update('contact', ['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
3940         }
3941
3942         // "uid" and "self" are only needed for some internal stuff, so remove it from here
3943         unset($contact["uid"]);
3944         unset($contact["self"]);
3945
3946         // Set screen_name since Twidere requests it
3947         $contact["screen_name"] = $contact["nick"];
3948
3949         return api_format_data("friendships-destroy", $type, ['user' => $contact]);
3950 }
3951 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3952
3953 /**
3954  *
3955  * @param string $type Return type (atom, rss, xml, json)
3956  * @param string $box
3957  * @param string $verbose
3958  *
3959  * @return array|string
3960  * @throws BadRequestException
3961  * @throws ForbiddenException
3962  * @throws ImagickException
3963  * @throws InternalServerErrorException
3964  * @throws UnauthorizedException
3965  */
3966 function api_direct_messages_box($type, $box, $verbose)
3967 {
3968         $a = \get_app();
3969         if (api_user() === false) {
3970                 throw new ForbiddenException();
3971         }
3972         // params
3973         $count = $_GET['count'] ?? 20;
3974         $page = $_REQUEST['page'] ?? 1;
3975
3976         $since_id = $_REQUEST['since_id'] ?? 0;
3977         $max_id = $_REQUEST['max_id'] ?? 0;
3978
3979         $user_id = $_REQUEST['user_id'] ?? '';
3980         $screen_name = $_REQUEST['screen_name'] ?? '';
3981
3982         //  caller user info
3983         unset($_REQUEST["user_id"]);
3984         unset($_GET["user_id"]);
3985
3986         unset($_REQUEST["screen_name"]);
3987         unset($_GET["screen_name"]);
3988
3989         $user_info = api_get_user($a);
3990         if ($user_info === false) {
3991                 throw new ForbiddenException();
3992         }
3993         $profile_url = $user_info["url"];
3994
3995         // pagination
3996         $start = max(0, ($page - 1) * $count);
3997
3998         $sql_extra = "";
3999
4000         // filters
4001         if ($box=="sentbox") {
4002                 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
4003         } elseif ($box == "conversation") {
4004                 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape($_GET['uri'] ?? '')  . "'";
4005         } elseif ($box == "all") {
4006                 $sql_extra = "true";
4007         } elseif ($box == "inbox") {
4008                 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
4009         }
4010
4011         if ($max_id > 0) {
4012                 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
4013         }
4014
4015         if ($user_id != "") {
4016                 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
4017         } elseif ($screen_name !="") {
4018                 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
4019         }
4020
4021         $r = q(
4022                 "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",
4023                 intval(api_user()),
4024                 intval($since_id),
4025                 intval($start),
4026                 intval($count)
4027         );
4028         if ($verbose == "true" && !DBA::isResult($r)) {
4029                 $answer = ['result' => 'error', 'message' => 'no mails available'];
4030                 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
4031         }
4032
4033         $ret = [];
4034         foreach ($r as $item) {
4035                 if ($box == "inbox" || $item['from-url'] != $profile_url) {
4036                         $recipient = $user_info;
4037                         $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
4038                 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
4039                         $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
4040                         $sender = $user_info;
4041                 }
4042
4043                 if (isset($recipient) && isset($sender)) {
4044                         $ret[] = api_format_messages($item, $recipient, $sender);
4045                 }
4046         }
4047
4048
4049         $data = ['direct_message' => $ret];
4050         switch ($type) {
4051                 case "atom":
4052                         break;
4053                 case "rss":
4054                         $data = api_rss_extra($a, $data, $user_info);
4055                         break;
4056         }
4057
4058         return api_format_data("direct-messages", $type, $data);
4059 }
4060
4061 /**
4062  * Returns the most recent direct messages sent by the user.
4063  *
4064  * @param string $type Return type (atom, rss, xml, json)
4065  *
4066  * @return array|string
4067  * @throws BadRequestException
4068  * @throws ForbiddenException
4069  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
4070  */
4071 function api_direct_messages_sentbox($type)
4072 {
4073         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4074         return api_direct_messages_box($type, "sentbox", $verbose);
4075 }
4076
4077 /**
4078  * Returns the most recent direct messages sent to the user.
4079  *
4080  * @param string $type Return type (atom, rss, xml, json)
4081  *
4082  * @return array|string
4083  * @throws BadRequestException
4084  * @throws ForbiddenException
4085  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
4086  */
4087 function api_direct_messages_inbox($type)
4088 {
4089         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4090         return api_direct_messages_box($type, "inbox", $verbose);
4091 }
4092
4093 /**
4094  *
4095  * @param string $type Return type (atom, rss, xml, json)
4096  *
4097  * @return array|string
4098  * @throws BadRequestException
4099  * @throws ForbiddenException
4100  */
4101 function api_direct_messages_all($type)
4102 {
4103         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4104         return api_direct_messages_box($type, "all", $verbose);
4105 }
4106
4107 /**
4108  *
4109  * @param string $type Return type (atom, rss, xml, json)
4110  *
4111  * @return array|string
4112  * @throws BadRequestException
4113  * @throws ForbiddenException
4114  */
4115 function api_direct_messages_conversation($type)
4116 {
4117         $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false";
4118         return api_direct_messages_box($type, "conversation", $verbose);
4119 }
4120
4121 /// @TODO move to top of file or somewhere better
4122 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
4123 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
4124 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
4125 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
4126
4127 /**
4128  * Returns an OAuth Request Token.
4129  *
4130  * @see https://oauth.net/core/1.0/#auth_step1
4131  */
4132 function api_oauth_request_token()
4133 {
4134         $oauth1 = new FKOAuth1();
4135         try {
4136                 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
4137         } catch (Exception $e) {
4138                 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
4139                 exit();
4140         }
4141         echo $r;
4142         exit();
4143 }
4144
4145 /**
4146  * Returns an OAuth Access Token.
4147  *
4148  * @return array|string
4149  * @see https://oauth.net/core/1.0/#auth_step3
4150  */
4151 function api_oauth_access_token()
4152 {
4153         $oauth1 = new FKOAuth1();
4154         try {
4155                 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
4156         } catch (Exception $e) {
4157                 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
4158                 exit();
4159         }
4160         echo $r;
4161         exit();
4162 }
4163
4164 /// @TODO move to top of file or somewhere better
4165 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
4166 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
4167
4168
4169 /**
4170  * @brief delete a complete photoalbum with all containing photos from database through api
4171  *
4172  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4173  * @return string|array
4174  * @throws BadRequestException
4175  * @throws ForbiddenException
4176  * @throws InternalServerErrorException
4177  */
4178 function api_fr_photoalbum_delete($type)
4179 {
4180         if (api_user() === false) {
4181                 throw new ForbiddenException();
4182         }
4183         // input params
4184         $album = $_REQUEST['album'] ?? '';
4185
4186         // we do not allow calls without album string
4187         if ($album == "") {
4188                 throw new BadRequestException("no albumname specified");
4189         }
4190         // check if album is existing
4191         $r = q(
4192                 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
4193                 intval(api_user()),
4194                 DBA::escape($album)
4195         );
4196         if (!DBA::isResult($r)) {
4197                 throw new BadRequestException("album not available");
4198         }
4199
4200         // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4201         // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
4202         foreach ($r as $rr) {
4203                 $condition = ['uid' => local_user(), 'resource-id' => $rr['resource-id'], 'type' => 'photo'];
4204                 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4205
4206                 if (!DBA::isResult($photo_item)) {
4207                         throw new InternalServerErrorException("problem with deleting items occured");
4208                 }
4209                 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4210         }
4211
4212         // now let's delete all photos from the album
4213         $result = Photo::delete(['uid' => api_user(), 'album' => $album]);
4214
4215         // return success of deletion or error message
4216         if ($result) {
4217                 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
4218                 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
4219         } else {
4220                 throw new InternalServerErrorException("unknown error - deleting from database failed");
4221         }
4222 }
4223
4224 /**
4225  * @brief update the name of the album for all photos of an album
4226  *
4227  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4228  * @return string|array
4229  * @throws BadRequestException
4230  * @throws ForbiddenException
4231  * @throws InternalServerErrorException
4232  */
4233 function api_fr_photoalbum_update($type)
4234 {
4235         if (api_user() === false) {
4236                 throw new ForbiddenException();
4237         }
4238         // input params
4239         $album = $_REQUEST['album'] ?? '';
4240         $album_new = $_REQUEST['album_new'] ?? '';
4241
4242         // we do not allow calls without album string
4243         if ($album == "") {
4244                 throw new BadRequestException("no albumname specified");
4245         }
4246         if ($album_new == "") {
4247                 throw new BadRequestException("no new albumname specified");
4248         }
4249         // check if album is existing
4250         if (!Photo::exists(['uid' => api_user(), 'album' => $album])) {
4251                 throw new BadRequestException("album not available");
4252         }
4253         // now let's update all photos to the albumname
4254         $result = Photo::update(['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
4255
4256         // return success of updating or error message
4257         if ($result) {
4258                 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4259                 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4260         } else {
4261                 throw new InternalServerErrorException("unknown error - updating in database failed");
4262         }
4263 }
4264
4265
4266 /**
4267  * @brief list all photos of the authenticated user
4268  *
4269  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4270  * @return string|array
4271  * @throws ForbiddenException
4272  * @throws InternalServerErrorException
4273  */
4274 function api_fr_photos_list($type)
4275 {
4276         if (api_user() === false) {
4277                 throw new ForbiddenException();
4278         }
4279         $r = q(
4280                 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4281                 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4282                 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`, `album`, `filename`, `type`",
4283                 intval(local_user())
4284         );
4285         $typetoext = [
4286                 'image/jpeg' => 'jpg',
4287                 'image/png' => 'png',
4288                 'image/gif' => 'gif'
4289         ];
4290         $data = ['photo'=>[]];
4291         if (DBA::isResult($r)) {
4292                 foreach ($r as $rr) {
4293                         $photo = [];
4294                         $photo['id'] = $rr['resource-id'];
4295                         $photo['album'] = $rr['album'];
4296                         $photo['filename'] = $rr['filename'];
4297                         $photo['type'] = $rr['type'];
4298                         $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4299                         $photo['created'] = $rr['created'];
4300                         $photo['edited'] = $rr['edited'];
4301                         $photo['desc'] = $rr['desc'];
4302
4303                         if ($type == "xml") {
4304                                 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4305                         } else {
4306                                 $photo['thumb'] = $thumb;
4307                                 $data['photo'][] = $photo;
4308                         }
4309                 }
4310         }
4311         return api_format_data("photos", $type, $data);
4312 }
4313
4314 /**
4315  * @brief upload a new photo or change an existing photo
4316  *
4317  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4318  * @return string|array
4319  * @throws BadRequestException
4320  * @throws ForbiddenException
4321  * @throws ImagickException
4322  * @throws InternalServerErrorException
4323  * @throws NotFoundException
4324  */
4325 function api_fr_photo_create_update($type)
4326 {
4327         if (api_user() === false) {
4328                 throw new ForbiddenException();
4329         }
4330         // input params
4331         $photo_id  = $_REQUEST['photo_id']  ?? null;
4332         $desc      = $_REQUEST['desc']      ?? null;
4333         $album     = $_REQUEST['album']     ?? null;
4334         $album_new = $_REQUEST['album_new'] ?? null;
4335         $allow_cid = $_REQUEST['allow_cid'] ?? null;
4336         $deny_cid  = $_REQUEST['deny_cid' ] ?? null;
4337         $allow_gid = $_REQUEST['allow_gid'] ?? null;
4338         $deny_gid  = $_REQUEST['deny_gid' ] ?? null;
4339         $visibility = !empty($_REQUEST['visibility']) && $_REQUEST['visibility'] !== "false";
4340
4341         // do several checks on input parameters
4342         // we do not allow calls without album string
4343         if ($album == null) {
4344                 throw new BadRequestException("no albumname specified");
4345         }
4346         // if photo_id == null --> we are uploading a new photo
4347         if ($photo_id == null) {
4348                 $mode = "create";
4349
4350                 // error if no media posted in create-mode
4351                 if (empty($_FILES['media'])) {
4352                         // Output error
4353                         throw new BadRequestException("no media data submitted");
4354                 }
4355
4356                 // album_new will be ignored in create-mode
4357                 $album_new = "";
4358         } else {
4359                 $mode = "update";
4360
4361                 // check if photo is existing in databasei
4362                 if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user(), 'album' => $album])) {
4363                         throw new BadRequestException("photo not available");
4364                 }
4365         }
4366
4367         // checks on acl strings provided by clients
4368         $acl_input_error = false;
4369         $acl_input_error |= check_acl_input($allow_cid);
4370         $acl_input_error |= check_acl_input($deny_cid);
4371         $acl_input_error |= check_acl_input($allow_gid);
4372         $acl_input_error |= check_acl_input($deny_gid);
4373         if ($acl_input_error) {
4374                 throw new BadRequestException("acl data invalid");
4375         }
4376         // now let's upload the new media in create-mode
4377         if ($mode == "create") {
4378                 $media = $_FILES['media'];
4379                 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4380
4381                 // return success of updating or error message
4382                 if (!is_null($data)) {
4383                         return api_format_data("photo_create", $type, $data);
4384                 } else {
4385                         throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4386                 }
4387         }
4388
4389         // now let's do the changes in update-mode
4390         if ($mode == "update") {
4391                 $updated_fields = [];
4392
4393                 if (!is_null($desc)) {
4394                         $updated_fields['desc'] = $desc;
4395                 }
4396
4397                 if (!is_null($album_new)) {
4398                         $updated_fields['album'] = $album_new;
4399                 }
4400
4401                 if (!is_null($allow_cid)) {
4402                         $allow_cid = trim($allow_cid);
4403                         $updated_fields['allow_cid'] = $allow_cid;
4404                 }
4405
4406                 if (!is_null($deny_cid)) {
4407                         $deny_cid = trim($deny_cid);
4408                         $updated_fields['deny_cid'] = $deny_cid;
4409                 }
4410
4411                 if (!is_null($allow_gid)) {
4412                         $allow_gid = trim($allow_gid);
4413                         $updated_fields['allow_gid'] = $allow_gid;
4414                 }
4415
4416                 if (!is_null($deny_gid)) {
4417                         $deny_gid = trim($deny_gid);
4418                         $updated_fields['deny_gid'] = $deny_gid;
4419                 }
4420
4421                 $result = false;
4422                 if (count($updated_fields) > 0) {
4423                         $nothingtodo = false;
4424                         $result = Photo::update($updated_fields, ['uid' => api_user(), 'resource-id' => $photo_id, 'album' => $album]);
4425                 } else {
4426                         $nothingtodo = true;
4427                 }
4428
4429                 if (!empty($_FILES['media'])) {
4430                         $nothingtodo = false;
4431                         $media = $_FILES['media'];
4432                         $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4433                         if (!is_null($data)) {
4434                                 return api_format_data("photo_update", $type, $data);
4435                         }
4436                 }
4437
4438                 // return success of updating or error message
4439                 if ($result) {
4440                         $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4441                         return api_format_data("photo_update", $type, ['$result' => $answer]);
4442                 } else {
4443                         if ($nothingtodo) {
4444                                 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4445                                 return api_format_data("photo_update", $type, ['$result' => $answer]);
4446                         }
4447                         throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4448                 }
4449         }
4450         throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4451 }
4452
4453 /**
4454  * @brief delete a single photo from the database through api
4455  *
4456  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4457  * @return string|array
4458  * @throws BadRequestException
4459  * @throws ForbiddenException
4460  * @throws InternalServerErrorException
4461  */
4462 function api_fr_photo_delete($type)
4463 {
4464         if (api_user() === false) {
4465                 throw new ForbiddenException();
4466         }
4467
4468         // input params
4469         $photo_id = $_REQUEST['photo_id'] ?? null;
4470
4471         // do several checks on input parameters
4472         // we do not allow calls without photo id
4473         if ($photo_id == null) {
4474                 throw new BadRequestException("no photo_id specified");
4475         }
4476
4477         // check if photo is existing in database
4478         if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user()])) {
4479                 throw new BadRequestException("photo not available");
4480         }
4481
4482         // now we can perform on the deletion of the photo
4483         $result = Photo::delete(['uid' => api_user(), 'resource-id' => $photo_id]);
4484
4485         // return success of deletion or error message
4486         if ($result) {
4487                 // retrieve the id of the parent element (the photo element)
4488                 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4489                 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4490
4491                 if (!DBA::isResult($photo_item)) {
4492                         throw new InternalServerErrorException("problem with deleting items occured");
4493                 }
4494                 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4495                 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4496                 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4497
4498                 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4499                 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4500         } else {
4501                 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4502         }
4503 }
4504
4505
4506 /**
4507  * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4508  *
4509  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4510  * @return string|array
4511  * @throws BadRequestException
4512  * @throws ForbiddenException
4513  * @throws InternalServerErrorException
4514  * @throws NotFoundException
4515  */
4516 function api_fr_photo_detail($type)
4517 {
4518         if (api_user() === false) {
4519                 throw new ForbiddenException();
4520         }
4521         if (empty($_REQUEST['photo_id'])) {
4522                 throw new BadRequestException("No photo id.");
4523         }
4524
4525         $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
4526         $photo_id = $_REQUEST['photo_id'];
4527
4528         // prepare json/xml output with data from database for the requested photo
4529         $data = prepare_photo_data($type, $scale, $photo_id);
4530
4531         return api_format_data("photo_detail", $type, $data);
4532 }
4533
4534
4535 /**
4536  * Updates the user’s profile image.
4537  *
4538  * @brief updates the profile image for the user (either a specified profile or the default profile)
4539  *
4540  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4541  *
4542  * @return string|array
4543  * @throws BadRequestException
4544  * @throws ForbiddenException
4545  * @throws ImagickException
4546  * @throws InternalServerErrorException
4547  * @throws NotFoundException
4548  * @see   https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4549  */
4550 function api_account_update_profile_image($type)
4551 {
4552         if (api_user() === false) {
4553                 throw new ForbiddenException();
4554         }
4555         // input params
4556         $profile_id = $_REQUEST['profile_id'] ?? 0;
4557
4558         // error if image data is missing
4559         if (empty($_FILES['image'])) {
4560                 throw new BadRequestException("no media data submitted");
4561         }
4562
4563         // check if specified profile id is valid
4564         if ($profile_id != 0) {
4565                 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4566                 // error message if specified profile id is not in database
4567                 if (!DBA::isResult($profile)) {
4568                         throw new BadRequestException("profile_id not available");
4569                 }
4570                 $is_default_profile = $profile['is-default'];
4571         } else {
4572                 $is_default_profile = 1;
4573         }
4574
4575         // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4576         $media = null;
4577         if (!empty($_FILES['image'])) {
4578                 $media = $_FILES['image'];
4579         } elseif (!empty($_FILES['media'])) {
4580                 $media = $_FILES['media'];
4581         }
4582         // save new profile image
4583         $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4584
4585         // get filetype
4586         if (is_array($media['type'])) {
4587                 $filetype = $media['type'][0];
4588         } else {
4589                 $filetype = $media['type'];
4590         }
4591         if ($filetype == "image/jpeg") {
4592                 $fileext = "jpg";
4593         } elseif ($filetype == "image/png") {
4594                 $fileext = "png";
4595         } else {
4596                 throw new InternalServerErrorException('Unsupported filetype');
4597         }
4598
4599         // change specified profile or all profiles to the new resource-id
4600         if ($is_default_profile) {
4601                 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4602                 Photo::update(['profile' => false], $condition);
4603         } else {
4604                 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext,
4605                         'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext];
4606                 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4607         }
4608
4609         Contact::updateSelfFromUserID(api_user(), true);
4610
4611         // Update global directory in background
4612         $url = System::baseUrl() . '/profile/' . \get_app()->user['nickname'];
4613         if ($url && strlen(Config::get('system', 'directory'))) {
4614                 Worker::add(PRIORITY_LOW, "Directory", $url);
4615         }
4616
4617         Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4618
4619         // output for client
4620         if ($data) {
4621                 return api_account_verify_credentials($type);
4622         } else {
4623                 // SaveMediaToDatabase failed for some reason
4624                 throw new InternalServerErrorException("image upload failed");
4625         }
4626 }
4627
4628 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4629 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4630 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4631 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4632 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4633 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4634 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4635 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4636 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4637
4638 /**
4639  * Update user profile
4640  *
4641  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4642  *
4643  * @return array|string
4644  * @throws BadRequestException
4645  * @throws ForbiddenException
4646  * @throws ImagickException
4647  * @throws InternalServerErrorException
4648  * @throws UnauthorizedException
4649  */
4650 function api_account_update_profile($type)
4651 {
4652         $local_user = api_user();
4653         $api_user = api_get_user(get_app());
4654
4655         if (!empty($_POST['name'])) {
4656                 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4657                 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4658                 DBA::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4659                 DBA::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4660         }
4661
4662         if (isset($_POST['description'])) {
4663                 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4664                 DBA::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4665                 DBA::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4666         }
4667
4668         Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4669         // Update global directory in background
4670         if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4671                 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4672         }
4673
4674         return api_account_verify_credentials($type);
4675 }
4676
4677 /// @TODO move to top of file or somewhere better
4678 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4679
4680 /**
4681  *
4682  * @param string $acl_string
4683  * @return bool
4684  * @throws Exception
4685  */
4686 function check_acl_input($acl_string)
4687 {
4688         if (empty($acl_string)) {
4689                 return false;
4690         }
4691
4692         $contact_not_found = false;
4693
4694         // split <x><y><z> into array of cid's
4695         preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4696
4697         // check for each cid if it is available on server
4698         $cid_array = $array[0];
4699         foreach ($cid_array as $cid) {
4700                 $cid = str_replace("<", "", $cid);
4701                 $cid = str_replace(">", "", $cid);
4702                 $condition = ['id' => $cid, 'uid' => api_user()];
4703                 $contact_not_found |= !DBA::exists('contact', $condition);
4704         }
4705         return $contact_not_found;
4706 }
4707
4708 /**
4709  * @param string  $mediatype
4710  * @param array   $media
4711  * @param string  $type
4712  * @param string  $album
4713  * @param string  $allow_cid
4714  * @param string  $deny_cid
4715  * @param string  $allow_gid
4716  * @param string  $deny_gid
4717  * @param string  $desc
4718  * @param integer $profile
4719  * @param boolean $visibility
4720  * @param string  $photo_id
4721  * @return array
4722  * @throws BadRequestException
4723  * @throws ForbiddenException
4724  * @throws ImagickException
4725  * @throws InternalServerErrorException
4726  * @throws NotFoundException
4727  * @throws UnauthorizedException
4728  */
4729 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)
4730 {
4731         $visitor   = 0;
4732         $src = "";
4733         $filetype = "";
4734         $filename = "";
4735         $filesize = 0;
4736
4737         if (is_array($media)) {
4738                 if (is_array($media['tmp_name'])) {
4739                         $src = $media['tmp_name'][0];
4740                 } else {
4741                         $src = $media['tmp_name'];
4742                 }
4743                 if (is_array($media['name'])) {
4744                         $filename = basename($media['name'][0]);
4745                 } else {
4746                         $filename = basename($media['name']);
4747                 }
4748                 if (is_array($media['size'])) {
4749                         $filesize = intval($media['size'][0]);
4750                 } else {
4751                         $filesize = intval($media['size']);
4752                 }
4753                 if (is_array($media['type'])) {
4754                         $filetype = $media['type'][0];
4755                 } else {
4756                         $filetype = $media['type'];
4757                 }
4758         }
4759
4760         if ($filetype == "") {
4761                 $filetype = Images::guessType($filename);
4762         }
4763         $imagedata = @getimagesize($src);
4764         if ($imagedata) {
4765                 $filetype = $imagedata['mime'];
4766         }
4767         Logger::log(
4768                 "File upload src: " . $src . " - filename: " . $filename .
4769                 " - size: " . $filesize . " - type: " . $filetype,
4770                 Logger::DEBUG
4771         );
4772
4773         // check if there was a php upload error
4774         if ($filesize == 0 && $media['error'] == 1) {
4775                 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4776         }
4777         // check against max upload size within Friendica instance
4778         $maximagesize = Config::get('system', 'maximagesize');
4779         if ($maximagesize && ($filesize > $maximagesize)) {
4780                 $formattedBytes = Strings::formatBytes($maximagesize);
4781                 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4782         }
4783
4784         // create Photo instance with the data of the image
4785         $imagedata = @file_get_contents($src);
4786         $Image = new Image($imagedata, $filetype);
4787         if (!$Image->isValid()) {
4788                 throw new InternalServerErrorException("unable to process image data");
4789         }
4790
4791         // check orientation of image
4792         $Image->orient($src);
4793         @unlink($src);
4794
4795         // check max length of images on server
4796         $max_length = Config::get('system', 'max_image_length');
4797         if (!$max_length) {
4798                 $max_length = MAX_IMAGE_LENGTH;
4799         }
4800         if ($max_length > 0) {
4801                 $Image->scaleDown($max_length);
4802                 Logger::log("File upload: Scaling picture to new size " . $max_length, Logger::DEBUG);
4803         }
4804         $width = $Image->getWidth();
4805         $height = $Image->getHeight();
4806
4807         // create a new resource-id if not already provided
4808         $resource_id = ($photo_id == null) ? Photo::newResource() : $photo_id;
4809
4810         if ($mediatype == "photo") {
4811                 // upload normal image (scales 0, 1, 2)
4812                 Logger::log("photo upload: starting new photo upload", Logger::DEBUG);
4813
4814                 $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4815                 if (!$r) {
4816                         Logger::log("photo upload: image upload with scale 0 (original size) failed");
4817                 }
4818                 if ($width > 640 || $height > 640) {
4819                         $Image->scaleDown(640);
4820                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4821                         if (!$r) {
4822                                 Logger::log("photo upload: image upload with scale 1 (640x640) failed");
4823                         }
4824                 }
4825
4826                 if ($width > 320 || $height > 320) {
4827                         $Image->scaleDown(320);
4828                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4829                         if (!$r) {
4830                                 Logger::log("photo upload: image upload with scale 2 (320x320) failed");
4831                         }
4832                 }
4833                 Logger::log("photo upload: new photo upload ended", Logger::DEBUG);
4834         } elseif ($mediatype == "profileimage") {
4835                 // upload profile image (scales 4, 5, 6)
4836                 Logger::log("photo upload: starting new profile image upload", Logger::DEBUG);
4837
4838                 if ($width > 300 || $height > 300) {
4839                         $Image->scaleDown(300);
4840                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4841                         if (!$r) {
4842                                 Logger::log("photo upload: profile image upload with scale 4 (300x300) failed");
4843                         }
4844                 }
4845
4846                 if ($width > 80 || $height > 80) {
4847                         $Image->scaleDown(80);
4848                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4849                         if (!$r) {
4850                                 Logger::log("photo upload: profile image upload with scale 5 (80x80) failed");
4851                         }
4852                 }
4853
4854                 if ($width > 48 || $height > 48) {
4855                         $Image->scaleDown(48);
4856                         $r = Photo::store($Image, local_user(), $visitor, $resource_id, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4857                         if (!$r) {
4858                                 Logger::log("photo upload: profile image upload with scale 6 (48x48) failed");
4859                         }
4860                 }
4861                 $Image->__destruct();
4862                 Logger::log("photo upload: new profile image upload ended", Logger::DEBUG);
4863         }
4864
4865         if (isset($r) && $r) {
4866                 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4867                 if ($photo_id == null && $mediatype == "photo") {
4868                         post_photo_item($resource_id, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4869                 }
4870                 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4871                 return prepare_photo_data($type, false, $resource_id);
4872         } else {
4873                 throw new InternalServerErrorException("image upload failed");
4874         }
4875 }
4876
4877 /**
4878  *
4879  * @param string  $hash
4880  * @param string  $allow_cid
4881  * @param string  $deny_cid
4882  * @param string  $allow_gid
4883  * @param string  $deny_gid
4884  * @param string  $filetype
4885  * @param boolean $visibility
4886  * @throws InternalServerErrorException
4887  */
4888 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4889 {
4890         // get data about the api authenticated user
4891         $uri = Item::newURI(intval(api_user()));
4892         $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
4893
4894         $arr = [];
4895         $arr['guid']          = System::createUUID();
4896         $arr['uid']           = intval(api_user());
4897         $arr['uri']           = $uri;
4898         $arr['parent-uri']    = $uri;
4899         $arr['type']          = 'photo';
4900         $arr['wall']          = 1;
4901         $arr['resource-id']   = $hash;
4902         $arr['contact-id']    = $owner_record['id'];
4903         $arr['owner-name']    = $owner_record['name'];
4904         $arr['owner-link']    = $owner_record['url'];
4905         $arr['owner-avatar']  = $owner_record['thumb'];
4906         $arr['author-name']   = $owner_record['name'];
4907         $arr['author-link']   = $owner_record['url'];
4908         $arr['author-avatar'] = $owner_record['thumb'];
4909         $arr['title']         = "";
4910         $arr['allow_cid']     = $allow_cid;
4911         $arr['allow_gid']     = $allow_gid;
4912         $arr['deny_cid']      = $deny_cid;
4913         $arr['deny_gid']      = $deny_gid;
4914         $arr['visible']       = $visibility;
4915         $arr['origin']        = 1;
4916
4917         $typetoext = [
4918                         'image/jpeg' => 'jpg',
4919                         'image/png' => 'png',
4920                         'image/gif' => 'gif'
4921                         ];
4922
4923         // adds link to the thumbnail scale photo
4924         $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
4925                                 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4926                                 . '[/url]';
4927
4928         // do the magic for storing the item in the database and trigger the federation to other contacts
4929         Item::insert($arr);
4930 }
4931
4932 /**
4933  *
4934  * @param string $type
4935  * @param int    $scale
4936  * @param string $photo_id
4937  *
4938  * @return array
4939  * @throws BadRequestException
4940  * @throws ForbiddenException
4941  * @throws ImagickException
4942  * @throws InternalServerErrorException
4943  * @throws NotFoundException
4944  * @throws UnauthorizedException
4945  */
4946 function prepare_photo_data($type, $scale, $photo_id)
4947 {
4948         $a = \get_app();
4949         $user_info = api_get_user($a);
4950
4951         if ($user_info === false) {
4952                 throw new ForbiddenException();
4953         }
4954
4955         $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4956         $data_sql = ($scale === false ? "" : "data, ");
4957
4958         // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4959         // clients needs to convert this in their way for further processing
4960         $r = q(
4961                 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4962                                         `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4963                                         MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4964                         FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY
4965                                `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4966                                `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`",
4967                 $data_sql,
4968                 intval(local_user()),
4969                 DBA::escape($photo_id),
4970                 $scale_sql
4971         );
4972
4973         $typetoext = [
4974                 'image/jpeg' => 'jpg',
4975                 'image/png' => 'png',
4976                 'image/gif' => 'gif'
4977         ];
4978
4979         // prepare output data for photo
4980         if (DBA::isResult($r)) {
4981                 $data = ['photo' => $r[0]];
4982                 $data['photo']['id'] = $data['photo']['resource-id'];
4983                 if ($scale !== false) {
4984                         $data['photo']['data'] = base64_encode($data['photo']['data']);
4985                 } else {
4986                         unset($data['photo']['datasize']); //needed only with scale param
4987                 }
4988                 if ($type == "xml") {
4989                         $data['photo']['links'] = [];
4990                         for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4991                                 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4992                                                                                 "scale" => $k,
4993                                                                                 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4994                         }
4995                 } else {
4996                         $data['photo']['link'] = [];
4997                         // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4998                         $i = 0;
4999                         for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
5000                                 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
5001                                 $i++;
5002                         }
5003                 }
5004                 unset($data['photo']['resource-id']);
5005                 unset($data['photo']['minscale']);
5006                 unset($data['photo']['maxscale']);
5007         } else {
5008                 throw new NotFoundException();
5009         }
5010
5011         // retrieve item element for getting activities (like, dislike etc.) related to photo
5012         $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
5013         $item = Item::selectFirstForUser(local_user(), ['id'], $condition);
5014
5015         $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
5016
5017         // retrieve comments on photo
5018         $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
5019                 $item[0]['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
5020
5021         $statuses = Item::selectForUser(api_user(), [], $condition);
5022
5023         // prepare output of comments
5024         $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
5025         $comments = [];
5026         if ($type == "xml") {
5027                 $k = 0;
5028                 foreach ($commentData as $comment) {
5029                         $comments[$k++ . ":comment"] = $comment;
5030                 }
5031         } else {
5032                 foreach ($commentData as $comment) {
5033                         $comments[] = $comment;
5034                 }
5035         }
5036         $data['photo']['friendica_comments'] = $comments;
5037
5038         // include info if rights on photo and rights on item are mismatching
5039         $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
5040                 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
5041                 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
5042                 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
5043         $data['photo']['rights_mismatch'] = $rights_mismatch;
5044
5045         return $data;
5046 }
5047
5048
5049 /**
5050  * Similar as /mod/redir.php
5051  * redirect to 'url' after dfrn auth
5052  *
5053  * Why this when there is mod/redir.php already?
5054  * This use api_user() and api_login()
5055  *
5056  * params
5057  *              c_url: url of remote contact to auth to
5058  *              url: string, url to redirect after auth
5059  */
5060 function api_friendica_remoteauth()
5061 {
5062         $url = $_GET['url'] ?? '';
5063         $c_url = $_GET['c_url'] ?? '';
5064
5065         if ($url === '' || $c_url === '') {
5066                 throw new BadRequestException("Wrong parameters.");
5067         }
5068
5069         $c_url = Strings::normaliseLink($c_url);
5070
5071         // traditional DFRN
5072
5073         $contact = DBA::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
5074
5075         if (!DBA::isResult($contact) || ($contact['network'] !== Protocol::DFRN)) {
5076                 throw new BadRequestException("Unknown contact");
5077         }
5078
5079         $cid = $contact['id'];
5080
5081         $dfrn_id = $contact['issued-id'] ?? $contact['dfrn-id'];
5082
5083         if ($contact['duplex'] && $contact['issued-id']) {
5084                 $orig_id = $contact['issued-id'];
5085                 $dfrn_id = '1:' . $orig_id;
5086         }
5087         if ($contact['duplex'] && $contact['dfrn-id']) {
5088                 $orig_id = $contact['dfrn-id'];
5089                 $dfrn_id = '0:' . $orig_id;
5090         }
5091
5092         $sec = Strings::getRandomHex();
5093
5094         $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
5095                 'sec' => $sec, 'expire' => time() + 45];
5096         DBA::insert('profile_check', $fields);
5097
5098         Logger::info(API_LOG_PREFIX . 'for contact {contact}', ['module' => 'api', 'action' => 'friendica_remoteauth', 'contact' => $contact['name'], 'hey' => $sec]);
5099         $dest = ($url ? '&destination_url=' . $url : '');
5100
5101         System::externalRedirect(
5102                 $contact['poll'] . '?dfrn_id=' . $dfrn_id
5103                 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
5104                 . '&type=profile&sec=' . $sec . $dest
5105         );
5106 }
5107 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
5108
5109 /**
5110  * Return an item with announcer data if it had been announced
5111  *
5112  * @param array $item Item array
5113  * @return array Item array with announce data
5114  */
5115 function api_get_announce($item)
5116 {
5117         // Quit if the item already has got a different owner and author
5118         if ($item['owner-id'] != $item['author-id']) {
5119                 return [];
5120         }
5121
5122         // Don't change original or Diaspora posts
5123         if ($item['origin'] || in_array($item['network'], [Protocol::DIASPORA])) {
5124                 return [];
5125         }
5126
5127         // Quit if we do now the original author and it had been a post from a native network
5128         if (!empty($item['contact-uid']) && in_array($item['network'], Protocol::NATIVE_SUPPORT)) {
5129                 return [];
5130         }
5131
5132         $fields = ['author-id', 'author-name', 'author-link', 'author-avatar'];
5133         $activity = Item::activityToIndex(Activity::ANNOUNCE);
5134         $condition = ['parent-uri' => $item['uri'], 'gravity' => GRAVITY_ACTIVITY, 'uid' => [0, $item['uid']], 'activity' => $activity];
5135         $announce = Item::selectFirstForUser($item['uid'], $fields, $condition, ['order' => ['received' => true]]);
5136         if (!DBA::isResult($announce)) {
5137                 return [];
5138         }
5139
5140         return array_merge($item, $announce);
5141 }
5142
5143 /**
5144  * @brief Return the item shared, if the item contains only the [share] tag
5145  *
5146  * @param array $item Sharer item
5147  * @return array|false Shared item or false if not a reshare
5148  * @throws ImagickException
5149  * @throws InternalServerErrorException
5150  */
5151 function api_share_as_retweet(&$item)
5152 {
5153         $body = trim($item["body"]);
5154
5155         if (Diaspora::isReshare($body, false) === false) {
5156                 if ($item['author-id'] == $item['owner-id']) {
5157                         return false;
5158                 } else {
5159                         // Reshares from OStatus, ActivityPub and Twitter
5160                         $reshared_item = $item;
5161                         $reshared_item['owner-id'] = $reshared_item['author-id'];
5162                         $reshared_item['owner-link'] = $reshared_item['author-link'];
5163                         $reshared_item['owner-name'] = $reshared_item['author-name'];
5164                         $reshared_item['owner-avatar'] = $reshared_item['author-avatar'];
5165                         return $reshared_item;
5166                 }
5167         }
5168
5169         $reshared = Item::getShareArray($item);
5170         if (empty($reshared)) {
5171                 return false;
5172         }
5173
5174         $reshared_item = $item;
5175
5176         if (empty($reshared['shared']) || empty($reshared['profile']) || empty($reshared['author']) || empty($reshared['avatar']) || empty($reshared['posted'])) {
5177                 return false;
5178         }
5179
5180         if (!empty($reshared['comment'])) {
5181                 $item['body'] = $reshared['comment'];
5182         }
5183
5184         $reshared_item["share-pre-body"] = $reshared['comment'];
5185         $reshared_item["body"] = $reshared['shared'];
5186         $reshared_item["author-id"] = Contact::getIdForURL($reshared['profile'], 0, true);
5187         $reshared_item["author-name"] = $reshared['author'];
5188         $reshared_item["author-link"] = $reshared['profile'];
5189         $reshared_item["author-avatar"] = $reshared['avatar'];
5190         $reshared_item["plink"] = $reshared['link'] ?? '';
5191         $reshared_item["created"] = $reshared['posted'];
5192         $reshared_item["edited"] = $reshared['posted'];
5193
5194         return $reshared_item;
5195 }
5196
5197 /**
5198  *
5199  * @param string $profile
5200  *
5201  * @return string|false
5202  * @throws InternalServerErrorException
5203  * @todo remove trailing junk from profile url
5204  * @todo pump.io check has to check the website
5205  */
5206 function api_get_nick($profile)
5207 {
5208         $nick = "";
5209
5210         $r = q(
5211                 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5212                 DBA::escape(Strings::normaliseLink($profile))
5213         );
5214
5215         if (DBA::isResult($r)) {
5216                 $nick = $r[0]["nick"];
5217         }
5218
5219         if (!$nick == "") {
5220                 $r = q(
5221                         "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5222                         DBA::escape(Strings::normaliseLink($profile))
5223                 );
5224
5225                 if (DBA::isResult($r)) {
5226                         $nick = $r[0]["nick"];
5227                 }
5228         }
5229
5230         if (!$nick == "") {
5231                 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
5232                 if ($friendica != $profile) {
5233                         $nick = $friendica;
5234                 }
5235         }
5236
5237         if (!$nick == "") {
5238                 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
5239                 if ($diaspora != $profile) {
5240                         $nick = $diaspora;
5241                 }
5242         }
5243
5244         if (!$nick == "") {
5245                 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
5246                 if ($twitter != $profile) {
5247                         $nick = $twitter;
5248                 }
5249         }
5250
5251
5252         if (!$nick == "") {
5253                 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
5254                 if ($StatusnetHost != $profile) {
5255                         $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
5256                         if ($StatusnetUser != $profile) {
5257                                 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
5258                                 $user = json_decode($UserData);
5259                                 if ($user) {
5260                                         $nick = $user->screen_name;
5261                                 }
5262                         }
5263                 }
5264         }
5265
5266         // To-Do: look at the page if its really a pumpio site
5267         //if (!$nick == "") {
5268         //      $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
5269         //      if ($pumpio != $profile)
5270         //              $nick = $pumpio;
5271                 //      <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5272
5273         //}
5274
5275         if ($nick != "") {
5276                 return $nick;
5277         }
5278
5279         return false;
5280 }
5281
5282 /**
5283  *
5284  * @param array $item
5285  *
5286  * @return array
5287  * @throws Exception
5288  */
5289 function api_in_reply_to($item)
5290 {
5291         $in_reply_to = [];
5292
5293         $in_reply_to['status_id'] = null;
5294         $in_reply_to['user_id'] = null;
5295         $in_reply_to['status_id_str'] = null;
5296         $in_reply_to['user_id_str'] = null;
5297         $in_reply_to['screen_name'] = null;
5298
5299         if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5300                 $parent = Item::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
5301                 if (DBA::isResult($parent)) {
5302                         $in_reply_to['status_id'] = intval($parent['id']);
5303                 } else {
5304                         $in_reply_to['status_id'] = intval($item['parent']);
5305                 }
5306
5307                 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5308
5309                 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
5310                 $parent = Item::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
5311
5312                 if (DBA::isResult($parent)) {
5313                         if ($parent['author-nick'] == "") {
5314                                 $parent['author-nick'] = api_get_nick($parent['author-link']);
5315                         }
5316
5317                         $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
5318                         $in_reply_to['user_id'] = intval($parent['author-id']);
5319                         $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
5320                 }
5321
5322                 // There seems to be situation, where both fields are identical:
5323                 // https://github.com/friendica/friendica/issues/1010
5324                 // This is a bugfix for that.
5325                 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5326                         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']]);
5327                         $in_reply_to['status_id'] = null;
5328                         $in_reply_to['user_id'] = null;
5329                         $in_reply_to['status_id_str'] = null;
5330                         $in_reply_to['user_id_str'] = null;
5331                         $in_reply_to['screen_name'] = null;
5332                 }
5333         }
5334
5335         return $in_reply_to;
5336 }
5337
5338 /**
5339  *
5340  * @param string $text
5341  *
5342  * @return string
5343  * @throws InternalServerErrorException
5344  */
5345 function api_clean_plain_items($text)
5346 {
5347         $include_entities = strtolower($_REQUEST['include_entities'] ?? 'false');
5348
5349         $text = BBCode::cleanPictureLinks($text);
5350         $URLSearchString = "^\[\]";
5351
5352         $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
5353
5354         if ($include_entities == "true") {
5355                 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5356         }
5357
5358         // Simplify "attachment" element
5359         $text = BBCode::removeAttachment($text);
5360
5361         return $text;
5362 }
5363
5364 /**
5365  *
5366  * @param array $contacts
5367  *
5368  * @return void
5369  */
5370 function api_best_nickname(&$contacts)
5371 {
5372         $best_contact = [];
5373
5374         if (count($contacts) == 0) {
5375                 return;
5376         }
5377
5378         foreach ($contacts as $contact) {
5379                 if ($contact["network"] == "") {
5380                         $contact["network"] = "dfrn";
5381                         $best_contact = [$contact];
5382                 }
5383         }
5384
5385         if (sizeof($best_contact) == 0) {
5386                 foreach ($contacts as $contact) {
5387                         if ($contact["network"] == "dfrn") {
5388                                 $best_contact = [$contact];
5389                         }
5390                 }
5391         }
5392
5393         if (sizeof($best_contact) == 0) {
5394                 foreach ($contacts as $contact) {
5395                         if ($contact["network"] == "dspr") {
5396                                 $best_contact = [$contact];
5397                         }
5398                 }
5399         }
5400
5401         if (sizeof($best_contact) == 0) {
5402                 foreach ($contacts as $contact) {
5403                         if ($contact["network"] == "stat") {
5404                                 $best_contact = [$contact];
5405                         }
5406                 }
5407         }
5408
5409         if (sizeof($best_contact) == 0) {
5410                 foreach ($contacts as $contact) {
5411                         if ($contact["network"] == "pump") {
5412                                 $best_contact = [$contact];
5413                         }
5414                 }
5415         }
5416
5417         if (sizeof($best_contact) == 0) {
5418                 foreach ($contacts as $contact) {
5419                         if ($contact["network"] == "twit") {
5420                                 $best_contact = [$contact];
5421                         }
5422                 }
5423         }
5424
5425         if (sizeof($best_contact) == 1) {
5426                 $contacts = $best_contact;
5427         } else {
5428                 $contacts = [$contacts[0]];
5429         }
5430 }
5431
5432 /**
5433  * Return all or a specified group of the user with the containing contacts.
5434  *
5435  * @param string $type Return type (atom, rss, xml, json)
5436  *
5437  * @return array|string
5438  * @throws BadRequestException
5439  * @throws ForbiddenException
5440  * @throws ImagickException
5441  * @throws InternalServerErrorException
5442  * @throws UnauthorizedException
5443  */
5444 function api_friendica_group_show($type)
5445 {
5446         $a = \get_app();
5447
5448         if (api_user() === false) {
5449                 throw new ForbiddenException();
5450         }
5451
5452         // params
5453         $user_info = api_get_user($a);
5454         $gid = $_REQUEST['gid'] ?? 0;
5455         $uid = $user_info['uid'];
5456
5457         // get data of the specified group id or all groups if not specified
5458         if ($gid != 0) {
5459                 $r = q(
5460                         "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5461                         intval($uid),
5462                         intval($gid)
5463                 );
5464                 // error message if specified gid is not in database
5465                 if (!DBA::isResult($r)) {
5466                         throw new BadRequestException("gid not available");
5467                 }
5468         } else {
5469                 $r = q(
5470                         "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5471                         intval($uid)
5472                 );
5473         }
5474
5475         // loop through all groups and retrieve all members for adding data in the user array
5476         $grps = [];
5477         foreach ($r as $rr) {
5478                 $members = Contact::getByGroupId($rr['id']);
5479                 $users = [];
5480
5481                 if ($type == "xml") {
5482                         $user_element = "users";
5483                         $k = 0;
5484                         foreach ($members as $member) {
5485                                 $user = api_get_user($a, $member['nurl']);
5486                                 $users[$k++.":user"] = $user;
5487                         }
5488                 } else {
5489                         $user_element = "user";
5490                         foreach ($members as $member) {
5491                                 $user = api_get_user($a, $member['nurl']);
5492                                 $users[] = $user;
5493                         }
5494                 }
5495                 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5496         }
5497         return api_format_data("groups", $type, ['group' => $grps]);
5498 }
5499 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5500
5501
5502 /**
5503  * Delete the specified group of the user.
5504  *
5505  * @param string $type Return type (atom, rss, xml, json)
5506  *
5507  * @return array|string
5508  * @throws BadRequestException
5509  * @throws ForbiddenException
5510  * @throws ImagickException
5511  * @throws InternalServerErrorException
5512  * @throws UnauthorizedException
5513  */
5514 function api_friendica_group_delete($type)
5515 {
5516         $a = \get_app();
5517
5518         if (api_user() === false) {
5519                 throw new ForbiddenException();
5520         }
5521
5522         // params
5523         $user_info = api_get_user($a);
5524         $gid = $_REQUEST['gid'] ?? 0;
5525         $name = $_REQUEST['name'] ?? '';
5526         $uid = $user_info['uid'];
5527
5528         // error if no gid specified
5529         if ($gid == 0 || $name == "") {
5530                 throw new BadRequestException('gid or name not specified');
5531         }
5532
5533         // get data of the specified group id
5534         $r = q(
5535                 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5536                 intval($uid),
5537                 intval($gid)
5538         );
5539         // error message if specified gid is not in database
5540         if (!DBA::isResult($r)) {
5541                 throw new BadRequestException('gid not available');
5542         }
5543
5544         // get data of the specified group id and group name
5545         $rname = q(
5546                 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5547                 intval($uid),
5548                 intval($gid),
5549                 DBA::escape($name)
5550         );
5551         // error message if specified gid is not in database
5552         if (!DBA::isResult($rname)) {
5553                 throw new BadRequestException('wrong group name');
5554         }
5555
5556         // delete group
5557         $ret = Group::removeByName($uid, $name);
5558         if ($ret) {
5559                 // return success
5560                 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5561                 return api_format_data("group_delete", $type, ['result' => $success]);
5562         } else {
5563                 throw new BadRequestException('other API error');
5564         }
5565 }
5566 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5567
5568 /**
5569  * Delete a group.
5570  *
5571  * @param string $type Return type (atom, rss, xml, json)
5572  *
5573  * @return array|string
5574  * @throws BadRequestException
5575  * @throws ForbiddenException
5576  * @throws ImagickException
5577  * @throws InternalServerErrorException
5578  * @throws UnauthorizedException
5579  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5580  */
5581 function api_lists_destroy($type)
5582 {
5583         $a = \get_app();
5584
5585         if (api_user() === false) {
5586                 throw new ForbiddenException();
5587         }
5588
5589         // params
5590         $user_info = api_get_user($a);
5591         $gid = $_REQUEST['list_id'] ?? 0;
5592         $uid = $user_info['uid'];
5593
5594         // error if no gid specified
5595         if ($gid == 0) {
5596                 throw new BadRequestException('gid not specified');
5597         }
5598
5599         // get data of the specified group id
5600         $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5601         // error message if specified gid is not in database
5602         if (!$group) {
5603                 throw new BadRequestException('gid not available');
5604         }
5605
5606         if (Group::remove($gid)) {
5607                 $list = [
5608                         'name' => $group['name'],
5609                         'id' => intval($gid),
5610                         'id_str' => (string) $gid,
5611                         'user' => $user_info
5612                 ];
5613
5614                 return api_format_data("lists", $type, ['lists' => $list]);
5615         }
5616 }
5617 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5618
5619 /**
5620  * Add a new group to the database.
5621  *
5622  * @param  string $name  Group name
5623  * @param  int    $uid   User ID
5624  * @param  array  $users List of users to add to the group
5625  *
5626  * @return array
5627  * @throws BadRequestException
5628  */
5629 function group_create($name, $uid, $users = [])
5630 {
5631         // error if no name specified
5632         if ($name == "") {
5633                 throw new BadRequestException('group name not specified');
5634         }
5635
5636         // get data of the specified group name
5637         $rname = q(
5638                 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5639                 intval($uid),
5640                 DBA::escape($name)
5641         );
5642         // error message if specified group name already exists
5643         if (DBA::isResult($rname)) {
5644                 throw new BadRequestException('group name already exists');
5645         }
5646
5647         // check if specified group name is a deleted group
5648         $rname = q(
5649                 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5650                 intval($uid),
5651                 DBA::escape($name)
5652         );
5653         // error message if specified group name already exists
5654         if (DBA::isResult($rname)) {
5655                 $reactivate_group = true;
5656         }
5657
5658         // create group
5659         $ret = Group::create($uid, $name);
5660         if ($ret) {
5661                 $gid = Group::getIdByName($uid, $name);
5662         } else {
5663                 throw new BadRequestException('other API error');
5664         }
5665
5666         // add members
5667         $erroraddinguser = false;
5668         $errorusers = [];
5669         foreach ($users as $user) {
5670                 $cid = $user['cid'];
5671                 // check if user really exists as contact
5672                 $contact = q(
5673                         "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5674                         intval($cid),
5675                         intval($uid)
5676                 );
5677                 if (count($contact)) {
5678                         Group::addMember($gid, $cid);
5679                 } else {
5680                         $erroraddinguser = true;
5681                         $errorusers[] = $cid;
5682                 }
5683         }
5684
5685         // return success message incl. missing users in array
5686         $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5687
5688         return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5689 }
5690
5691 /**
5692  * Create the specified group with the posted array of contacts.
5693  *
5694  * @param string $type Return type (atom, rss, xml, json)
5695  *
5696  * @return array|string
5697  * @throws BadRequestException
5698  * @throws ForbiddenException
5699  * @throws ImagickException
5700  * @throws InternalServerErrorException
5701  * @throws UnauthorizedException
5702  */
5703 function api_friendica_group_create($type)
5704 {
5705         $a = \get_app();
5706
5707         if (api_user() === false) {
5708                 throw new ForbiddenException();
5709         }
5710
5711         // params
5712         $user_info = api_get_user($a);
5713         $name = $_REQUEST['name'] ?? '';
5714         $uid = $user_info['uid'];
5715         $json = json_decode($_POST['json'], true);
5716         $users = $json['user'];
5717
5718         $success = group_create($name, $uid, $users);
5719
5720         return api_format_data("group_create", $type, ['result' => $success]);
5721 }
5722 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5723
5724 /**
5725  * Create a new group.
5726  *
5727  * @param string $type Return type (atom, rss, xml, json)
5728  *
5729  * @return array|string
5730  * @throws BadRequestException
5731  * @throws ForbiddenException
5732  * @throws ImagickException
5733  * @throws InternalServerErrorException
5734  * @throws UnauthorizedException
5735  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5736  */
5737 function api_lists_create($type)
5738 {
5739         $a = \get_app();
5740
5741         if (api_user() === false) {
5742                 throw new ForbiddenException();
5743         }
5744
5745         // params
5746         $user_info = api_get_user($a);
5747         $name = $_REQUEST['name'] ?? '';
5748         $uid = $user_info['uid'];
5749
5750         $success = group_create($name, $uid);
5751         if ($success['success']) {
5752                 $grp = [
5753                         'name' => $success['name'],
5754                         'id' => intval($success['gid']),
5755                         'id_str' => (string) $success['gid'],
5756                         'user' => $user_info
5757                 ];
5758
5759                 return api_format_data("lists", $type, ['lists'=>$grp]);
5760         }
5761 }
5762 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5763
5764 /**
5765  * Update the specified group with the posted array of contacts.
5766  *
5767  * @param string $type Return type (atom, rss, xml, json)
5768  *
5769  * @return array|string
5770  * @throws BadRequestException
5771  * @throws ForbiddenException
5772  * @throws ImagickException
5773  * @throws InternalServerErrorException
5774  * @throws UnauthorizedException
5775  */
5776 function api_friendica_group_update($type)
5777 {
5778         $a = \get_app();
5779
5780         if (api_user() === false) {
5781                 throw new ForbiddenException();
5782         }
5783
5784         // params
5785         $user_info = api_get_user($a);
5786         $uid = $user_info['uid'];
5787         $gid = $_REQUEST['gid'] ?? 0;
5788         $name = $_REQUEST['name'] ?? '';
5789         $json = json_decode($_POST['json'], true);
5790         $users = $json['user'];
5791
5792         // error if no name specified
5793         if ($name == "") {
5794                 throw new BadRequestException('group name not specified');
5795         }
5796
5797         // error if no gid specified
5798         if ($gid == "") {
5799                 throw new BadRequestException('gid not specified');
5800         }
5801
5802         // remove members
5803         $members = Contact::getByGroupId($gid);
5804         foreach ($members as $member) {
5805                 $cid = $member['id'];
5806                 foreach ($users as $user) {
5807                         $found = ($user['cid'] == $cid ? true : false);
5808                 }
5809                 if (!isset($found) || !$found) {
5810                         Group::removeMemberByName($uid, $name, $cid);
5811                 }
5812         }
5813
5814         // add members
5815         $erroraddinguser = false;
5816         $errorusers = [];
5817         foreach ($users as $user) {
5818                 $cid = $user['cid'];
5819                 // check if user really exists as contact
5820                 $contact = q(
5821                         "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5822                         intval($cid),
5823                         intval($uid)
5824                 );
5825
5826                 if (count($contact)) {
5827                         Group::addMember($gid, $cid);
5828                 } else {
5829                         $erroraddinguser = true;
5830                         $errorusers[] = $cid;
5831                 }
5832         }
5833
5834         // return success message incl. missing users in array
5835         $status = ($erroraddinguser ? "missing user" : "ok");
5836         $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5837         return api_format_data("group_update", $type, ['result' => $success]);
5838 }
5839
5840 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5841
5842 /**
5843  * Update information about a group.
5844  *
5845  * @param string $type Return type (atom, rss, xml, json)
5846  *
5847  * @return array|string
5848  * @throws BadRequestException
5849  * @throws ForbiddenException
5850  * @throws ImagickException
5851  * @throws InternalServerErrorException
5852  * @throws UnauthorizedException
5853  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5854  */
5855 function api_lists_update($type)
5856 {
5857         $a = \get_app();
5858
5859         if (api_user() === false) {
5860                 throw new ForbiddenException();
5861         }
5862
5863         // params
5864         $user_info = api_get_user($a);
5865         $gid = $_REQUEST['list_id'] ?? 0;
5866         $name = $_REQUEST['name'] ?? '';
5867         $uid = $user_info['uid'];
5868
5869         // error if no gid specified
5870         if ($gid == 0) {
5871                 throw new BadRequestException('gid not specified');
5872         }
5873
5874         // get data of the specified group id
5875         $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5876         // error message if specified gid is not in database
5877         if (!$group) {
5878                 throw new BadRequestException('gid not available');
5879         }
5880
5881         if (Group::update($gid, $name)) {
5882                 $list = [
5883                         'name' => $name,
5884                         'id' => intval($gid),
5885                         'id_str' => (string) $gid,
5886                         'user' => $user_info
5887                 ];
5888
5889                 return api_format_data("lists", $type, ['lists' => $list]);
5890         }
5891 }
5892
5893 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5894
5895 /**
5896  *
5897  * @param string $type Return type (atom, rss, xml, json)
5898  *
5899  * @return array|string
5900  * @throws BadRequestException
5901  * @throws ForbiddenException
5902  * @throws ImagickException
5903  * @throws InternalServerErrorException
5904  */
5905 function api_friendica_activity($type)
5906 {
5907         $a = \get_app();
5908
5909         if (api_user() === false) {
5910                 throw new ForbiddenException();
5911         }
5912         $verb = strtolower($a->argv[3]);
5913         $verb = preg_replace("|\..*$|", "", $verb);
5914
5915         $id = $_REQUEST['id'] ?? 0;
5916
5917         $res = Item::performLike($id, $verb);
5918
5919         if ($res) {
5920                 if ($type == "xml") {
5921                         $ok = "true";
5922                 } else {
5923                         $ok = "ok";
5924                 }
5925                 return api_format_data('ok', $type, ['ok' => $ok]);
5926         } else {
5927                 throw new BadRequestException('Error adding activity');
5928         }
5929 }
5930
5931 /// @TODO move to top of file or somewhere better
5932 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5933 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5934 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5935 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5936 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5937 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5938 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5939 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5940 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5941 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5942
5943 /**
5944  * @brief Returns notifications
5945  *
5946  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5947  * @return string|array
5948  * @throws BadRequestException
5949  * @throws ForbiddenException
5950  * @throws InternalServerErrorException
5951  */
5952 function api_friendica_notification($type)
5953 {
5954         $a = \get_app();
5955
5956         if (api_user() === false) {
5957                 throw new ForbiddenException();
5958         }
5959         if ($a->argc!==3) {
5960                 throw new BadRequestException("Invalid argument count");
5961         }
5962         /** @var Notify $nm */
5963         $nm = BaseObject::getClass(Notify::class);
5964
5965         $notes = $nm->getAll([], ['seen' => 'ASC', 'date' => 'DESC'], 50);
5966
5967         if ($type == "xml") {
5968                 $xmlnotes = [];
5969                 if (!empty($notes)) {
5970                         foreach ($notes as $note) {
5971                                 $xmlnotes[] = ["@attributes" => $note];
5972                         }
5973                 }
5974
5975                 $notes = $xmlnotes;
5976         }
5977         return api_format_data("notes", $type, ['note' => $notes]);
5978 }
5979
5980 /**
5981  * POST request with 'id' param as notification id
5982  *
5983  * @brief Set notification as seen and returns associated item (if possible)
5984  *
5985  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5986  * @return string|array
5987  * @throws BadRequestException
5988  * @throws ForbiddenException
5989  * @throws ImagickException
5990  * @throws InternalServerErrorException
5991  * @throws UnauthorizedException
5992  */
5993 function api_friendica_notification_seen($type)
5994 {
5995         $a = \get_app();
5996         $user_info = api_get_user($a);
5997
5998         if (api_user() === false || $user_info === false) {
5999                 throw new ForbiddenException();
6000         }
6001         if ($a->argc!==4) {
6002                 throw new BadRequestException("Invalid argument count");
6003         }
6004
6005         $id = (!empty($_REQUEST['id']) ? intval($_REQUEST['id']) : 0);
6006
6007         /** @var Notify $nm */
6008         $nm = BaseObject::getClass(Notify::class);
6009         $note = $nm->getByID($id);
6010         if (is_null($note)) {
6011                 throw new BadRequestException("Invalid argument");
6012         }
6013
6014         $nm->setSeen($note);
6015         if ($note['otype']=='item') {
6016                 // would be really better with an ItemsManager and $im->getByID() :-P
6017                 $item = Item::selectFirstForUser(api_user(), [], ['id' => $note['iid'], 'uid' => api_user()]);
6018                 if (DBA::isResult($item)) {
6019                         // we found the item, return it to the user
6020                         $ret = api_format_items([$item], $user_info, false, $type);
6021                         $data = ['status' => $ret];
6022                         return api_format_data("status", $type, $data);
6023                 }
6024                 // the item can't be found, but we set the note as seen, so we count this as a success
6025         }
6026         return api_format_data('result', $type, ['result' => "success"]);
6027 }
6028
6029 /// @TODO move to top of file or somewhere better
6030 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
6031 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
6032
6033 /**
6034  * @brief update a direct_message to seen state
6035  *
6036  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6037  * @return string|array (success result=ok, error result=error with error message)
6038  * @throws BadRequestException
6039  * @throws ForbiddenException
6040  * @throws ImagickException
6041  * @throws InternalServerErrorException
6042  * @throws UnauthorizedException
6043  */
6044 function api_friendica_direct_messages_setseen($type)
6045 {
6046         $a = \get_app();
6047         if (api_user() === false) {
6048                 throw new ForbiddenException();
6049         }
6050
6051         // params
6052         $user_info = api_get_user($a);
6053         $uid = $user_info['uid'];
6054         $id = $_REQUEST['id'] ?? 0;
6055
6056         // return error if id is zero
6057         if ($id == "") {
6058                 $answer = ['result' => 'error', 'message' => 'message id not specified'];
6059                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6060         }
6061
6062         // error message if specified id is not in database
6063         if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
6064                 $answer = ['result' => 'error', 'message' => 'message id not in database'];
6065                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6066         }
6067
6068         // update seen indicator
6069         $result = DBA::update('mail', ['seen' => true], ['id' => $id]);
6070
6071         if ($result) {
6072                 // return success
6073                 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
6074                 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
6075         } else {
6076                 $answer = ['result' => 'error', 'message' => 'unknown error'];
6077                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6078         }
6079 }
6080
6081 /// @TODO move to top of file or somewhere better
6082 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
6083
6084 /**
6085  * @brief search for direct_messages containing a searchstring through api
6086  *
6087  * @param string $type      Known types are 'atom', 'rss', 'xml' and 'json'
6088  * @param string $box
6089  * @return string|array (success: success=true if found and search_result contains found messages,
6090  *                          success=false if nothing was found, search_result='nothing found',
6091  *                          error: result=error with error message)
6092  * @throws BadRequestException
6093  * @throws ForbiddenException
6094  * @throws ImagickException
6095  * @throws InternalServerErrorException
6096  * @throws UnauthorizedException
6097  */
6098 function api_friendica_direct_messages_search($type, $box = "")
6099 {
6100         $a = \get_app();
6101
6102         if (api_user() === false) {
6103                 throw new ForbiddenException();
6104         }
6105
6106         // params
6107         $user_info = api_get_user($a);
6108         $searchstring = $_REQUEST['searchstring'] ?? '';
6109         $uid = $user_info['uid'];
6110
6111         // error if no searchstring specified
6112         if ($searchstring == "") {
6113                 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
6114                 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
6115         }
6116
6117         // get data for the specified searchstring
6118         $r = q(
6119                 "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",
6120                 intval($uid),
6121                 DBA::escape('%'.$searchstring.'%')
6122         );
6123
6124         $profile_url = $user_info["url"];
6125
6126         // message if nothing was found
6127         if (!DBA::isResult($r)) {
6128                 $success = ['success' => false, 'search_results' => 'problem with query'];
6129         } elseif (count($r) == 0) {
6130                 $success = ['success' => false, 'search_results' => 'nothing found'];
6131         } else {
6132                 $ret = [];
6133                 foreach ($r as $item) {
6134                         if ($box == "inbox" || $item['from-url'] != $profile_url) {
6135                                 $recipient = $user_info;
6136                                 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
6137                         } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
6138                                 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
6139                                 $sender = $user_info;
6140                         }
6141
6142                         if (isset($recipient) && isset($sender)) {
6143                                 $ret[] = api_format_messages($item, $recipient, $sender);
6144                         }
6145                 }
6146                 $success = ['success' => true, 'search_results' => $ret];
6147         }
6148
6149         return api_format_data("direct_message_search", $type, ['$result' => $success]);
6150 }
6151
6152 /// @TODO move to top of file or somewhere better
6153 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
6154
6155 /**
6156  * @brief return data of all the profiles a user has to the client
6157  *
6158  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6159  * @return string|array
6160  * @throws BadRequestException
6161  * @throws ForbiddenException
6162  * @throws ImagickException
6163  * @throws InternalServerErrorException
6164  * @throws UnauthorizedException
6165  */
6166 function api_friendica_profile_show($type)
6167 {
6168         $a = \get_app();
6169
6170         if (api_user() === false) {
6171                 throw new ForbiddenException();
6172         }
6173
6174         // input params
6175         $profile_id = $_REQUEST['profile_id'] ?? 0;
6176
6177         // retrieve general information about profiles for user
6178         $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
6179         $directory = Config::get('system', 'directory');
6180
6181         // get data of the specified profile id or all profiles of the user if not specified
6182         if ($profile_id != 0) {
6183                 $r = Profile::getById(api_user(), $profile_id);
6184                 // error message if specified gid is not in database
6185                 if (!DBA::isResult($r)) {
6186                         throw new BadRequestException("profile_id not available");
6187                 }
6188         } else {
6189                 $r = Profile::getListByUser(api_user());
6190         }
6191         // loop through all returned profiles and retrieve data and users
6192         $k = 0;
6193         $profiles = [];
6194         if (DBA::isResult($r)) {
6195                 foreach ($r as $rr) {
6196                         $profile = api_format_items_profiles($rr);
6197
6198                         // select all users from contact table, loop and prepare standard return for user data
6199                         $users = [];
6200                         $nurls = Contact::selectToArray(['id', 'nurl'], ['uid' => api_user(), 'profile-id' => $rr['id']]);
6201                         foreach ($nurls as $nurl) {
6202                                 $user = api_get_user($a, $nurl['nurl']);
6203                                 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
6204                         }
6205                         $profile['users'] = $users;
6206
6207                         // add prepared profile data to array for final return
6208                         if ($type == "xml") {
6209                                 $profiles[$k++ . ":profile"] = $profile;
6210                         } else {
6211                                 $profiles[] = $profile;
6212                         }
6213                 }
6214         }
6215
6216         // return settings, authenticated user and profiles data
6217         $self = DBA::selectFirst('contact', ['nurl'], ['uid' => api_user(), 'self' => true]);
6218
6219         $result = ['multi_profiles' => $multi_profiles ? true : false,
6220                                         'global_dir' => $directory,
6221                                         'friendica_owner' => api_get_user($a, $self['nurl']),
6222                                         'profiles' => $profiles];
6223         return api_format_data("friendica_profiles", $type, ['$result' => $result]);
6224 }
6225 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
6226
6227 /**
6228  * Returns a list of saved searches.
6229  *
6230  * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
6231  *
6232  * @param  string $type Return format: json or xml
6233  *
6234  * @return string|array
6235  * @throws Exception
6236  */
6237 function api_saved_searches_list($type)
6238 {
6239         $terms = DBA::select('search', ['id', 'term'], ['uid' => local_user()]);
6240
6241         $result = [];
6242         while ($term = DBA::fetch($terms)) {
6243                 $result[] = [
6244                         'created_at' => api_date(time()),
6245                         'id' => intval($term['id']),
6246                         'id_str' => $term['id'],
6247                         'name' => $term['term'],
6248                         'position' => null,
6249                         'query' => $term['term']
6250                 ];
6251         }
6252
6253         DBA::close($terms);
6254
6255         return api_format_data("terms", $type, ['terms' => $result]);
6256 }
6257
6258 /// @TODO move to top of file or somewhere better
6259 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
6260
6261 /*
6262  * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search
6263  *
6264  * @brief Number of comments
6265  *
6266  * @param object $data [Status, Status]
6267  *
6268  * @return void
6269  */
6270 function bindComments(&$data)
6271 {
6272         if (count($data) == 0) {
6273                 return;
6274         }
6275
6276         $ids = [];
6277         $comments = [];
6278         foreach ($data as $item) {
6279                 $ids[] = $item['id'];
6280         }
6281
6282         $idStr = DBA::escape(implode(', ', $ids));
6283         $sql = "SELECT `parent`, COUNT(*) as comments FROM `item` WHERE `parent` IN ($idStr) AND `deleted` = ? AND `gravity`= ? GROUP BY `parent`";
6284         $items = DBA::p($sql, 0, GRAVITY_COMMENT);
6285         $itemsData = DBA::toArray($items);
6286
6287         foreach ($itemsData as $item) {
6288                 $comments[$item['parent']] = $item['comments'];
6289         }
6290
6291         foreach ($data as $idx => $item) {
6292                 $id = $item['id'];
6293                 $data[$idx]['friendica_comments'] = isset($comments[$id]) ? $comments[$id] : 0;
6294         }
6295 }
6296
6297 /*
6298 @TODO Maybe open to implement?
6299 To.Do:
6300         [pagename] => api/1.1/statuses/lookup.json
6301         [id] => 605138389168451584
6302         [include_cards] => true
6303         [cards_platform] => Android-12
6304         [include_entities] => true
6305         [include_my_retweet] => 1
6306         [include_rts] => 1
6307         [include_reply_count] => true
6308         [include_descendent_reply_count] => true
6309 (?)
6310
6311
6312 Not implemented by now:
6313 statuses/retweets_of_me
6314 friendships/create
6315 friendships/destroy
6316 friendships/exists
6317 friendships/show
6318 account/update_location
6319 account/update_profile_background_image
6320 blocks/create
6321 blocks/destroy
6322 friendica/profile/update
6323 friendica/profile/create
6324 friendica/profile/delete
6325
6326 Not implemented in status.net:
6327 statuses/retweeted_to_me
6328 statuses/retweeted_by_me
6329 direct_messages/destroy
6330 account/end_session
6331 account/update_delivery_device
6332 notifications/follow
6333 notifications/leave
6334 blocks/exists
6335 blocks/blocking
6336 lists
6337 */