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