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