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                                 try {
2927                                         $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
2928                                 } catch (BadRequestException $e) {
2929                                         // user not found. should be found?
2930                                         /// @todo check if the user should be always found
2931                                         $retweeted_status["user"] = [];
2932                                 }
2933
2934                                 $rt_converted = api_convert_item($retweeted_item);
2935
2936                                 $retweeted_status['text'] = $rt_converted["text"];
2937                                 $retweeted_status['statusnet_html'] = $rt_converted["html"];
2938                                 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
2939                                 $retweeted_status['created_at'] =  api_date($retweeted_item['created']);
2940                                 $status['retweeted_status'] = $retweeted_status;
2941                         }
2942                 }
2943
2944                 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2945                 unset($status["user"]["uid"]);
2946                 unset($status["user"]["self"]);
2947
2948                 if ($item["coord"] != "") {
2949                         $coords = explode(' ', $item["coord"]);
2950                         if (count($coords) == 2) {
2951                                 if ($type == "json") {
2952                                         $status["geo"] = ['type' => 'Point',
2953                                                         'coordinates' => [(float) $coords[0],
2954                                                                                 (float) $coords[1]]];
2955                                 } else {// Not sure if this is the official format - if someone founds a documentation we can check
2956                                         $status["georss:point"] = $item["coord"];
2957                                 }
2958                         }
2959                 }
2960                 $ret[] = $status;
2961         };
2962         return $ret;
2963 }
2964
2965 /**
2966  * Returns the remaining number of API requests available to the user before the API limit is reached.
2967  *
2968  * @param string $type Return type (atom, rss, xml, json)
2969  *
2970  * @return array|string
2971  */
2972 function api_account_rate_limit_status($type)
2973 {
2974         if ($type == "xml") {
2975                 $hash = [
2976                                 'remaining-hits' => '150',
2977                                 '@attributes' => ["type" => "integer"],
2978                                 'hourly-limit' => '150',
2979                                 '@attributes2' => ["type" => "integer"],
2980                                 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
2981                                 '@attributes3' => ["type" => "datetime"],
2982                                 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2983                                 '@attributes4' => ["type" => "integer"],
2984                         ];
2985         } else {
2986                 $hash = [
2987                                 'reset_time_in_seconds' => strtotime('now + 1 hour'),
2988                                 'remaining_hits' => '150',
2989                                 'hourly_limit' => '150',
2990                                 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
2991                         ];
2992         }
2993
2994         return api_format_data('hash', $type, ['hash' => $hash]);
2995 }
2996
2997 /// @TODO move to top of file or somewhere better
2998 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
2999
3000 /**
3001  * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3002  *
3003  * @param string $type Return type (atom, rss, xml, json)
3004  *
3005  * @return array|string
3006  */
3007 function api_help_test($type)
3008 {
3009         if ($type == 'xml') {
3010                 $ok = "true";
3011         } else {
3012                 $ok = "ok";
3013         }
3014
3015         return api_format_data('ok', $type, ["ok" => $ok]);
3016 }
3017
3018 /// @TODO move to top of file or somewhere better
3019 api_register_func('api/help/test', 'api_help_test', false);
3020
3021 /**
3022  * Returns all lists the user subscribes to.
3023  *
3024  * @param string $type Return type (atom, rss, xml, json)
3025  *
3026  * @return array|string
3027  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3028  */
3029 function api_lists_list($type)
3030 {
3031         $ret = [];
3032         /// @TODO $ret is not filled here?
3033         return api_format_data('lists', $type, ["lists_list" => $ret]);
3034 }
3035
3036 /// @TODO move to top of file or somewhere better
3037 api_register_func('api/lists/list', 'api_lists_list', true);
3038 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3039
3040 /**
3041  * Returns all groups the user owns.
3042  *
3043  * @param string $type Return type (atom, rss, xml, json)
3044  *
3045  * @return array|string
3046  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3047  */
3048 function api_lists_ownerships($type)
3049 {
3050         $a = get_app();
3051
3052         if (api_user() === false) {
3053                 throw new ForbiddenException();
3054         }
3055
3056         // params
3057         $user_info = api_get_user($a);
3058         $uid = $user_info['uid'];
3059
3060         $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3061
3062         // loop through all groups
3063         $lists = [];
3064         foreach ($groups as $group) {
3065                 if ($group['visible']) {
3066                         $mode = 'public';
3067                 } else {
3068                         $mode = 'private';
3069                 }
3070                 $lists[] = [
3071                         'name' => $group['name'],
3072                         'id' => intval($group['id']),
3073                         'id_str' => (string) $group['id'],
3074                         'user' => $user_info,
3075                         'mode' => $mode
3076                 ];
3077         }
3078         return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3079 }
3080
3081 /// @TODO move to top of file or somewhere better
3082 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3083
3084 /**
3085  * Returns recent statuses from users in the specified group.
3086  *
3087  * @param string $type Return type (atom, rss, xml, json)
3088  *
3089  * @return array|string
3090  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3091  */
3092 function api_lists_statuses($type)
3093 {
3094         $a = get_app();
3095
3096         $user_info = api_get_user($a);
3097         if (api_user() === false || $user_info === false) {
3098                 throw new ForbiddenException();
3099         }
3100
3101         unset($_REQUEST["user_id"]);
3102         unset($_GET["user_id"]);
3103
3104         unset($_REQUEST["screen_name"]);
3105         unset($_GET["screen_name"]);
3106
3107         if (empty($_REQUEST['list_id'])) {
3108                 throw new BadRequestException('list_id not specified');
3109         }
3110
3111         // params
3112         $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
3113         $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
3114         if ($page < 0) {
3115                 $page = 0;
3116         }
3117         $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3118         $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3119         $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
3120         $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
3121
3122         $start = $page * $count;
3123
3124         $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `group_member`.`gid` = ?",
3125                 api_user(), GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $_REQUEST['list_id']];
3126
3127         if ($max_id > 0) {
3128                 $condition[0] .= " AND `item`.`id` <= ?";
3129                 $condition[] = $max_id;
3130         }
3131         if ($exclude_replies > 0) {
3132                 $condition[0] .= ' AND `item`.`parent` = `item`.`id`';
3133         }
3134         if ($conversation_id > 0) {
3135                 $condition[0] .= " AND `item`.`parent` = ?";
3136                 $condition[] = $conversation_id;
3137         }
3138
3139         $params = ['order' => ['id' => true], 'limit' => [$start, $count]];
3140         $statuses = Item::selectForUser(api_user(), [], $condition, $params);
3141
3142         $items = api_format_items(Item::inArray($statuses), $user_info, false, $type);
3143
3144         $data = ['status' => $items];
3145         switch ($type) {
3146                 case "atom":
3147                 case "rss":
3148                         $data = api_rss_extra($a, $data, $user_info);
3149                         break;
3150         }
3151
3152         return api_format_data("statuses", $type, $data);
3153 }
3154
3155 /// @TODO move to top of file or somewhere better
3156 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3157
3158 /**
3159  * Considers friends and followers lists to be private and won't return
3160  * anything if any user_id parameter is passed.
3161  *
3162  * @brief Returns either the friends of the follower list
3163  *
3164  * @param string $qtype Either "friends" or "followers"
3165  * @return boolean|array
3166  * @throws ForbiddenException
3167  */
3168 function api_statuses_f($qtype)
3169 {
3170         $a = get_app();
3171
3172         if (api_user() === false) {
3173                 throw new ForbiddenException();
3174         }
3175
3176         // pagination
3177         $count = x($_GET, 'count') ? $_GET['count'] : 20;
3178         $page = x($_GET, 'page') ? $_GET['page'] : 1;
3179         if ($page < 1) {
3180                 $page = 1;
3181         }
3182         $start = ($page - 1) * $count;
3183
3184         $user_info = api_get_user($a);
3185
3186         if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3187                 /* this is to stop Hotot to load friends multiple times
3188                 *  I'm not sure if I'm missing return something or
3189                 *  is a bug in hotot. Workaround, meantime
3190                 */
3191
3192                 /*$ret=Array();
3193                 return array('$users' => $ret);*/
3194                 return false;
3195         }
3196
3197         $sql_extra = '';
3198         if ($qtype == 'friends') {
3199                 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND));
3200         } elseif ($qtype == 'followers') {
3201                 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND));
3202         }
3203
3204         // friends and followers only for self
3205         if ($user_info['self'] == 0) {
3206                 $sql_extra = " AND false ";
3207         }
3208
3209         if ($qtype == 'blocks') {
3210                 $sql_filter = 'AND `blocked` AND NOT `pending`';
3211         } elseif ($qtype == 'incoming') {
3212                 $sql_filter = 'AND `pending`';
3213         } else {
3214                 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3215         }
3216
3217         $r = q(
3218                 "SELECT `nurl`
3219                 FROM `contact`
3220                 WHERE `uid` = %d
3221                 AND NOT `self`
3222                 $sql_filter
3223                 $sql_extra
3224                 ORDER BY `nick`
3225                 LIMIT %d, %d",
3226                 intval(api_user()),
3227                 intval($start),
3228                 intval($count)
3229         );
3230
3231         $ret = [];
3232         foreach ($r as $cid) {
3233                 $user = api_get_user($a, $cid['nurl']);
3234                 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3235                 unset($user["uid"]);
3236                 unset($user["self"]);
3237
3238                 if ($user) {
3239                         $ret[] = $user;
3240                 }
3241         }
3242
3243         return ['user' => $ret];
3244 }
3245
3246
3247 /**
3248  * Returns the user's friends.
3249  *
3250  * @brief Returns the list of friends of the provided user
3251  *
3252  * @deprecated By Twitter API in favor of friends/list
3253  *
3254  * @param string $type Either "json" or "xml"
3255  * @return boolean|string|array
3256  */
3257 function api_statuses_friends($type)
3258 {
3259         $data =  api_statuses_f("friends");
3260         if ($data === false) {
3261                 return false;
3262         }
3263         return api_format_data("users", $type, $data);
3264 }
3265
3266 /**
3267  * Returns the user's followers.
3268  *
3269  * @brief Returns the list of followers of the provided user
3270  *
3271  * @deprecated By Twitter API in favor of friends/list
3272  *
3273  * @param string $type Either "json" or "xml"
3274  * @return boolean|string|array
3275  */
3276 function api_statuses_followers($type)
3277 {
3278         $data = api_statuses_f("followers");
3279         if ($data === false) {
3280                 return false;
3281         }
3282         return api_format_data("users", $type, $data);
3283 }
3284
3285 /// @TODO move to top of file or somewhere better
3286 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3287 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3288
3289 /**
3290  * Returns the list of blocked users
3291  *
3292  * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3293  *
3294  * @param string $type Either "json" or "xml"
3295  *
3296  * @return boolean|string|array
3297  */
3298 function api_blocks_list($type)
3299 {
3300         $data =  api_statuses_f('blocks');
3301         if ($data === false) {
3302                 return false;
3303         }
3304         return api_format_data("users", $type, $data);
3305 }
3306
3307 /// @TODO move to top of file or somewhere better
3308 api_register_func('api/blocks/list', 'api_blocks_list', true);
3309
3310 /**
3311  * Returns the list of pending users IDs
3312  *
3313  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3314  *
3315  * @param string $type Either "json" or "xml"
3316  *
3317  * @return boolean|string|array
3318  */
3319 function api_friendships_incoming($type)
3320 {
3321         $data =  api_statuses_f('incoming');
3322         if ($data === false) {
3323                 return false;
3324         }
3325
3326         $ids = [];
3327         foreach ($data['user'] as $user) {
3328                 $ids[] = $user['id'];
3329         }
3330
3331         return api_format_data("ids", $type, ['id' => $ids]);
3332 }
3333
3334 /// @TODO move to top of file or somewhere better
3335 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3336
3337 /**
3338  * Returns the instance's configuration information.
3339  *
3340  * @param string $type Return type (atom, rss, xml, json)
3341  *
3342  * @return array|string
3343  */
3344 function api_statusnet_config($type)
3345 {
3346         $a = get_app();
3347
3348         $name      = Config::get('config', 'sitename');
3349         $server    = $a->getHostName();
3350         $logo      = System::baseUrl() . '/images/friendica-64.png';
3351         $email     = Config::get('config', 'admin_email');
3352         $closed    = intval(Config::get('config', 'register_policy')) === REGISTER_CLOSED ? 'true' : 'false';
3353         $private   = Config::get('system', 'block_public') ? 'true' : 'false';
3354         $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000));
3355         $ssl       = Config::get('system', 'have_ssl') ? 'true' : 'false';
3356         $sslserver = Config::get('system', 'have_ssl') ? str_replace('http:', 'https:', System::baseUrl()) : '';
3357
3358         $config = [
3359                 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3360                         'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3361                         'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3362                         'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3363                         'shorturllength' => '30',
3364                         'friendica' => [
3365                                         'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3366                                         'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3367                                         'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3368                                         'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3369                                         ]
3370                 ],
3371         ];
3372
3373         return api_format_data('config', $type, ['config' => $config]);
3374 }
3375
3376 /// @TODO move to top of file or somewhere better
3377 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3378 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3379
3380 /**
3381  *
3382  * @param string $type Return type (atom, rss, xml, json)
3383  *
3384  * @return array|string
3385  */
3386 function api_statusnet_version($type)
3387 {
3388         // liar
3389         $fake_statusnet_version = "0.9.7";
3390
3391         return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3392 }
3393
3394 /// @TODO move to top of file or somewhere better
3395 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3396 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3397
3398 /**
3399  *
3400  * @param string $type Return type (atom, rss, xml, json)
3401  *
3402  * @todo use api_format_data() to return data
3403  */
3404 function api_ff_ids($type)
3405 {
3406         if (!api_user()) {
3407                 throw new ForbiddenException();
3408         }
3409
3410         $a = get_app();
3411
3412         api_get_user($a);
3413
3414         $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3415
3416         $r = q(
3417                 "SELECT `pcontact`.`id` FROM `contact`
3418                         INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3419                         WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3420                 intval(api_user())
3421         );
3422         if (!DBA::isResult($r)) {
3423                 return;
3424         }
3425
3426         $ids = [];
3427         foreach ($r as $rr) {
3428                 if ($stringify_ids) {
3429                         $ids[] = $rr['id'];
3430                 } else {
3431                         $ids[] = intval($rr['id']);
3432                 }
3433         }
3434
3435         return api_format_data("ids", $type, ['id' => $ids]);
3436 }
3437
3438 /**
3439  * Returns the ID of every user the user is following.
3440  *
3441  * @param string $type Return type (atom, rss, xml, json)
3442  *
3443  * @return array|string
3444  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3445  */
3446 function api_friends_ids($type)
3447 {
3448         return api_ff_ids($type);
3449 }
3450
3451 /**
3452  * Returns the ID of every user following the user.
3453  *
3454  * @param string $type Return type (atom, rss, xml, json)
3455  *
3456  * @return array|string
3457  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3458  */
3459 function api_followers_ids($type)
3460 {
3461         return api_ff_ids($type);
3462 }
3463
3464 /// @TODO move to top of file or somewhere better
3465 api_register_func('api/friends/ids', 'api_friends_ids', true);
3466 api_register_func('api/followers/ids', 'api_followers_ids', true);
3467
3468 /**
3469  * Sends a new direct message.
3470  *
3471  * @param string $type Return type (atom, rss, xml, json)
3472  *
3473  * @return array|string
3474  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3475  */
3476 function api_direct_messages_new($type)
3477 {
3478         $a = get_app();
3479
3480         if (api_user() === false) {
3481                 throw new ForbiddenException();
3482         }
3483
3484         if (empty($_POST["text"]) || empty($_POST["screen_name"]) && empty($_POST["user_id"])) {
3485                 return;
3486         }
3487
3488         $sender = api_get_user($a);
3489
3490         $recipient = null;
3491         if (!empty($_POST['screen_name'])) {
3492                 $r = q(
3493                         "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3494                         intval(api_user()),
3495                         DBA::escape($_POST['screen_name'])
3496                 );
3497
3498                 if (DBA::isResult($r)) {
3499                         // Selecting the id by priority, friendica first
3500                         api_best_nickname($r);
3501
3502                         $recipient = api_get_user($a, $r[0]['nurl']);
3503                 }
3504         } else {
3505                 $recipient = api_get_user($a, $_POST['user_id']);
3506         }
3507
3508         if (empty($recipient)) {
3509                 throw new NotFoundException('Recipient not found');
3510         }
3511
3512         $replyto = '';
3513         $sub     = '';
3514         if (x($_REQUEST, 'replyto')) {
3515                 $r = q(
3516                         'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3517                         intval(api_user()),
3518                         intval($_REQUEST['replyto'])
3519                 );
3520                 $replyto = $r[0]['parent-uri'];
3521                 $sub     = $r[0]['title'];
3522         } else {
3523                 if (x($_REQUEST, 'title')) {
3524                         $sub = $_REQUEST['title'];
3525                 } else {
3526                         $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3527                 }
3528         }
3529
3530         $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3531
3532         if ($id > -1) {
3533                 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3534                 $ret = api_format_messages($r[0], $recipient, $sender);
3535         } else {
3536                 $ret = ["error"=>$id];
3537         }
3538
3539         $data = ['direct_message'=>$ret];
3540
3541         switch ($type) {
3542                 case "atom":
3543                 case "rss":
3544                         $data = api_rss_extra($a, $data, $sender);
3545         }
3546
3547         return api_format_data("direct-messages", $type, $data);
3548 }
3549
3550 /// @TODO move to top of file or somewhere better
3551 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3552
3553 /**
3554  * Destroys a direct message.
3555  *
3556  * @brief delete a direct_message from mail table through api
3557  *
3558  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3559  * @return string|array
3560  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3561  */
3562 function api_direct_messages_destroy($type)
3563 {
3564         $a = get_app();
3565
3566         if (api_user() === false) {
3567                 throw new ForbiddenException();
3568         }
3569
3570         // params
3571         $user_info = api_get_user($a);
3572         //required
3573         $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3574         // optional
3575         $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3576         $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3577         /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3578
3579         $uid = $user_info['uid'];
3580         // error if no id or parenturi specified (for clients posting parent-uri as well)
3581         if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3582                 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3583                 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3584         }
3585
3586         // BadRequestException if no id specified (for clients using Twitter API)
3587         if ($id == 0) {
3588                 throw new BadRequestException('Message id not specified');
3589         }
3590
3591         // add parent-uri to sql command if specified by calling app
3592         $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . DBA::escape($parenturi) . "'" : "");
3593
3594         // get data of the specified message id
3595         $r = q(
3596                 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3597                 intval($uid),
3598                 intval($id)
3599         );
3600
3601         // error message if specified id is not in database
3602         if (!DBA::isResult($r)) {
3603                 if ($verbose == "true") {
3604                         $answer = ['result' => 'error', 'message' => 'message id not in database'];
3605                         return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3606                 }
3607                 /// @todo BadRequestException ok for Twitter API clients?
3608                 throw new BadRequestException('message id not in database');
3609         }
3610
3611         // delete message
3612         $result = q(
3613                 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3614                 intval($uid),
3615                 intval($id)
3616         );
3617
3618         if ($verbose == "true") {
3619                 if ($result) {
3620                         // return success
3621                         $answer = ['result' => 'ok', 'message' => 'message deleted'];
3622                         return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3623                 } else {
3624                         $answer = ['result' => 'error', 'message' => 'unknown error'];
3625                         return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3626                 }
3627         }
3628         /// @todo return JSON data like Twitter API not yet implemented
3629 }
3630
3631 /// @TODO move to top of file or somewhere better
3632 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3633
3634 /**
3635  * Unfollow Contact
3636  *
3637  * @brief unfollow contact
3638  *
3639  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3640  * @return string|array
3641  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html
3642  */
3643 function api_friendships_destroy($type)
3644 {
3645         $uid = api_user();
3646
3647         if ($uid === false) {
3648                 throw new ForbiddenException();
3649         }
3650
3651         $contact_id = defaults($_REQUEST, 'user_id');
3652
3653         if (empty($contact_id)) {
3654                 Logger::log("No user_id specified", Logger::DEBUG);
3655                 throw new BadRequestException("no user_id specified");
3656         }
3657
3658         // Get Contact by given id
3659         $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]);
3660
3661         if(!DBA::isResult($contact)) {
3662                 Logger::log("No contact found for ID" . $contact_id, Logger::DEBUG);
3663                 throw new NotFoundException("no contact found to given ID");
3664         }
3665
3666         $url = $contact["url"];
3667
3668         $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)",
3669                         $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url),
3670                         Strings::normaliseLink($url), $url];
3671         $contact = DBA::selectFirst('contact', [], $condition);
3672
3673         if (!DBA::isResult($contact)) {
3674                 Logger::log("Not following Contact", Logger::DEBUG);
3675                 throw new NotFoundException("Not following Contact");
3676         }
3677
3678         if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
3679                 Logger::log("Not supported", Logger::DEBUG);
3680                 throw new ExpectationFailedException("Not supported");
3681         }
3682
3683         $dissolve = ($contact['rel'] == Contact::SHARING);
3684
3685         $owner = User::getOwnerDataById($uid);
3686         if ($owner) {
3687                 Contact::terminateFriendship($owner, $contact, $dissolve);
3688         }
3689         else {
3690                 Logger::log("No owner found", Logger::DEBUG);
3691                 throw new NotFoundException("Error Processing Request");
3692         }
3693
3694         // Sharing-only contacts get deleted as there no relationship any more
3695         if ($dissolve) {
3696                 Contact::remove($contact['id']);
3697         } else {
3698                 DBA::update('contact', ['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
3699         }
3700
3701         // "uid" and "self" are only needed for some internal stuff, so remove it from here
3702         unset($contact["uid"]);
3703         unset($contact["self"]);
3704
3705         // Set screen_name since Twidere requests it
3706         $contact["screen_name"] = $contact["nick"];
3707
3708         return api_format_data("friendships-destroy", $type, ['user' => $contact]);
3709 }
3710 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
3711
3712 /**
3713  *
3714  * @param string $type Return type (atom, rss, xml, json)
3715  * @param string $box
3716  * @param string $verbose
3717  *
3718  * @return array|string
3719  */
3720 function api_direct_messages_box($type, $box, $verbose)
3721 {
3722         $a = get_app();
3723         if (api_user() === false) {
3724                 throw new ForbiddenException();
3725         }
3726         // params
3727         $count = defaults($_GET, 'count', 20);
3728         $page = defaults($_REQUEST, 'page', 1) - 1;
3729         if ($page < 0) {
3730                 $page = 0;
3731         }
3732
3733         $since_id = defaults($_REQUEST, 'since_id', 0);
3734         $max_id = defaults($_REQUEST, 'max_id', 0);
3735
3736         $user_id = defaults($_REQUEST, 'user_id', '');
3737         $screen_name = defaults($_REQUEST, 'screen_name', '');
3738
3739         //  caller user info
3740         unset($_REQUEST["user_id"]);
3741         unset($_GET["user_id"]);
3742
3743         unset($_REQUEST["screen_name"]);
3744         unset($_GET["screen_name"]);
3745
3746         $user_info = api_get_user($a);
3747         if ($user_info === false) {
3748                 throw new ForbiddenException();
3749         }
3750         $profile_url = $user_info["url"];
3751
3752         // pagination
3753         $start = $page * $count;
3754
3755         $sql_extra = "";
3756
3757         // filters
3758         if ($box=="sentbox") {
3759                 $sql_extra = "`mail`.`from-url`='" . DBA::escape($profile_url) . "'";
3760         } elseif ($box == "conversation") {
3761                 $sql_extra = "`mail`.`parent-uri`='" . DBA::escape(defaults($_GET, 'uri', ''))  . "'";
3762         } elseif ($box == "all") {
3763                 $sql_extra = "true";
3764         } elseif ($box == "inbox") {
3765                 $sql_extra = "`mail`.`from-url`!='" . DBA::escape($profile_url) . "'";
3766         }
3767
3768         if ($max_id > 0) {
3769                 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3770         }
3771
3772         if ($user_id != "") {
3773                 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3774         } elseif ($screen_name !="") {
3775                 $sql_extra .= " AND `contact`.`nick` = '" . DBA::escape($screen_name). "'";
3776         }
3777
3778         $r = q(
3779                 "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",
3780                 intval(api_user()),
3781                 intval($since_id),
3782                 intval($start),
3783                 intval($count)
3784         );
3785         if ($verbose == "true" && !DBA::isResult($r)) {
3786                 $answer = ['result' => 'error', 'message' => 'no mails available'];
3787                 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3788         }
3789
3790         $ret = [];
3791         foreach ($r as $item) {
3792                 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3793                         $recipient = $user_info;
3794                         $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3795                 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3796                         $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
3797                         $sender = $user_info;
3798                 }
3799
3800                 if (isset($recipient) && isset($sender)) {
3801                         $ret[] = api_format_messages($item, $recipient, $sender);
3802                 }
3803         }
3804
3805
3806         $data = ['direct_message' => $ret];
3807         switch ($type) {
3808                 case "atom":
3809                 case "rss":
3810                         $data = api_rss_extra($a, $data, $user_info);
3811         }
3812
3813         return api_format_data("direct-messages", $type, $data);
3814 }
3815
3816 /**
3817  * Returns the most recent direct messages sent by the user.
3818  *
3819  * @param string $type Return type (atom, rss, xml, json)
3820  *
3821  * @return array|string
3822  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3823  */
3824 function api_direct_messages_sentbox($type)
3825 {
3826         $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3827         return api_direct_messages_box($type, "sentbox", $verbose);
3828 }
3829
3830 /**
3831  * Returns the most recent direct messages sent to the user.
3832  *
3833  * @param string $type Return type (atom, rss, xml, json)
3834  *
3835  * @return array|string
3836  * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3837  */
3838 function api_direct_messages_inbox($type)
3839 {
3840         $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3841         return api_direct_messages_box($type, "inbox", $verbose);
3842 }
3843
3844 /**
3845  *
3846  * @param string $type Return type (atom, rss, xml, json)
3847  *
3848  * @return array|string
3849  */
3850 function api_direct_messages_all($type)
3851 {
3852         $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3853         return api_direct_messages_box($type, "all", $verbose);
3854 }
3855
3856 /**
3857  *
3858  * @param string $type Return type (atom, rss, xml, json)
3859  *
3860  * @return array|string
3861  */
3862 function api_direct_messages_conversation($type)
3863 {
3864         $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3865         return api_direct_messages_box($type, "conversation", $verbose);
3866 }
3867
3868 /// @TODO move to top of file or somewhere better
3869 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3870 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3871 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3872 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3873
3874 /**
3875  * Returns an OAuth Request Token.
3876  *
3877  * @see https://oauth.net/core/1.0/#auth_step1
3878  */
3879 function api_oauth_request_token()
3880 {
3881         $oauth1 = new FKOAuth1();
3882         try {
3883                 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
3884         } catch (Exception $e) {
3885                 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
3886                 killme();
3887         }
3888         echo $r;
3889         killme();
3890 }
3891
3892 /**
3893  * Returns an OAuth Access Token.
3894  *
3895  * @return array|string
3896  * @see https://oauth.net/core/1.0/#auth_step3
3897  */
3898 function api_oauth_access_token()
3899 {
3900         $oauth1 = new FKOAuth1();
3901         try {
3902                 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
3903         } catch (Exception $e) {
3904                 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
3905                 killme();
3906         }
3907         echo $r;
3908         killme();
3909 }
3910
3911 /// @TODO move to top of file or somewhere better
3912 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
3913 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
3914
3915
3916 /**
3917  * @brief delete a complete photoalbum with all containing photos from database through api
3918  *
3919  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3920  * @return string|array
3921  */
3922 function api_fr_photoalbum_delete($type)
3923 {
3924         if (api_user() === false) {
3925                 throw new ForbiddenException();
3926         }
3927         // input params
3928         $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3929
3930         // we do not allow calls without album string
3931         if ($album == "") {
3932                 throw new BadRequestException("no albumname specified");
3933         }
3934         // check if album is existing
3935         $r = q(
3936                 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3937                 intval(api_user()),
3938                 DBA::escape($album)
3939         );
3940         if (!DBA::isResult($r)) {
3941                 throw new BadRequestException("album not available");
3942         }
3943
3944         // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
3945         // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
3946         foreach ($r as $rr) {
3947                 $condition = ['uid' => local_user(), 'resource-id' => $rr['resource-id'], 'type' => 'photo'];
3948                 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
3949
3950                 if (!DBA::isResult($photo_item)) {
3951                         throw new InternalServerErrorException("problem with deleting items occured");
3952                 }
3953                 Item::deleteForUser(['id' => $photo_item['id']], api_user());
3954         }
3955
3956         // now let's delete all photos from the album
3957         $result = DBA::delete('photo', ['uid' => api_user(), 'album' => $album]);
3958
3959         // return success of deletion or error message
3960         if ($result) {
3961                 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
3962                 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
3963         } else {
3964                 throw new InternalServerErrorException("unknown error - deleting from database failed");
3965         }
3966 }
3967
3968 /**
3969  * @brief update the name of the album for all photos of an album
3970  *
3971  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3972  * @return string|array
3973  */
3974 function api_fr_photoalbum_update($type)
3975 {
3976         if (api_user() === false) {
3977                 throw new ForbiddenException();
3978         }
3979         // input params
3980         $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3981         $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
3982
3983         // we do not allow calls without album string
3984         if ($album == "") {
3985                 throw new BadRequestException("no albumname specified");
3986         }
3987         if ($album_new == "") {
3988                 throw new BadRequestException("no new albumname specified");
3989         }
3990         // check if album is existing
3991         if (!DBA::exists('photo', ['uid' => api_user(), 'album' => $album])) {
3992                 throw new BadRequestException("album not available");
3993         }
3994         // now let's update all photos to the albumname
3995         $result = DBA::update('photo', ['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
3996
3997         // return success of updating or error message
3998         if ($result) {
3999                 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4000                 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4001         } else {
4002                 throw new InternalServerErrorException("unknown error - updating in database failed");
4003         }
4004 }
4005
4006
4007 /**
4008  * @brief list all photos of the authenticated user
4009  *
4010  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4011  * @return string|array
4012  */
4013 function api_fr_photos_list($type)
4014 {
4015         if (api_user() === false) {
4016                 throw new ForbiddenException();
4017         }
4018         $r = q(
4019                 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4020                 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4021                 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
4022                 intval(local_user())
4023         );
4024         $typetoext = [
4025                 'image/jpeg' => 'jpg',
4026                 'image/png' => 'png',
4027                 'image/gif' => 'gif'
4028         ];
4029         $data = ['photo'=>[]];
4030         if (DBA::isResult($r)) {
4031                 foreach ($r as $rr) {
4032                         $photo = [];
4033                         $photo['id'] = $rr['resource-id'];
4034                         $photo['album'] = $rr['album'];
4035                         $photo['filename'] = $rr['filename'];
4036                         $photo['type'] = $rr['type'];
4037                         $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4038                         $photo['created'] = $rr['created'];
4039                         $photo['edited'] = $rr['edited'];
4040                         $photo['desc'] = $rr['desc'];
4041
4042                         if ($type == "xml") {
4043                                 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4044                         } else {
4045                                 $photo['thumb'] = $thumb;
4046                                 $data['photo'][] = $photo;
4047                         }
4048                 }
4049         }
4050         return api_format_data("photos", $type, $data);
4051 }
4052
4053 /**
4054  * @brief upload a new photo or change an existing photo
4055  *
4056  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4057  * @return string|array
4058  */
4059 function api_fr_photo_create_update($type)
4060 {
4061         if (api_user() === false) {
4062                 throw new ForbiddenException();
4063         }
4064         // input params
4065         $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4066         $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
4067         $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
4068         $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
4069         $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
4070         $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
4071         $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
4072         $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
4073         $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
4074
4075         // do several checks on input parameters
4076         // we do not allow calls without album string
4077         if ($album == null) {
4078                 throw new BadRequestException("no albumname specified");
4079         }
4080         // if photo_id == null --> we are uploading a new photo
4081         if ($photo_id == null) {
4082                 $mode = "create";
4083
4084                 // error if no media posted in create-mode
4085                 if (!x($_FILES, 'media')) {
4086                         // Output error
4087                         throw new BadRequestException("no media data submitted");
4088                 }
4089
4090                 // album_new will be ignored in create-mode
4091                 $album_new = "";
4092         } else {
4093                 $mode = "update";
4094
4095                 // check if photo is existing in database
4096                 $r = q(
4097                         "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4098                         intval(api_user()),
4099                         DBA::escape($photo_id),
4100                         DBA::escape($album)
4101                 );
4102                 if (!DBA::isResult($r)) {
4103                         throw new BadRequestException("photo not available");
4104                 }
4105         }
4106
4107         // checks on acl strings provided by clients
4108         $acl_input_error = false;
4109         $acl_input_error |= check_acl_input($allow_cid);
4110         $acl_input_error |= check_acl_input($deny_cid);
4111         $acl_input_error |= check_acl_input($allow_gid);
4112         $acl_input_error |= check_acl_input($deny_gid);
4113         if ($acl_input_error) {
4114                 throw new BadRequestException("acl data invalid");
4115         }
4116         // now let's upload the new media in create-mode
4117         if ($mode == "create") {
4118                 $media = $_FILES['media'];
4119                 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4120
4121                 // return success of updating or error message
4122                 if (!is_null($data)) {
4123                         return api_format_data("photo_create", $type, $data);
4124                 } else {
4125                         throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4126                 }
4127         }
4128
4129         // now let's do the changes in update-mode
4130         if ($mode == "update") {
4131                 $sql_extra = "";
4132
4133                 if (!is_null($desc)) {
4134                         $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
4135                 }
4136
4137                 if (!is_null($album_new)) {
4138                         $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
4139                 }
4140
4141                 if (!is_null($allow_cid)) {
4142                         $allow_cid = trim($allow_cid);
4143                         $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
4144                 }
4145
4146                 if (!is_null($deny_cid)) {
4147                         $deny_cid = trim($deny_cid);
4148                         $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
4149                 }
4150
4151                 if (!is_null($allow_gid)) {
4152                         $allow_gid = trim($allow_gid);
4153                         $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
4154                 }
4155
4156                 if (!is_null($deny_gid)) {
4157                         $deny_gid = trim($deny_gid);
4158                         $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
4159                 }
4160
4161                 $result = false;
4162                 if ($sql_extra != "") {
4163                         $nothingtodo = false;
4164                         $result = q(
4165                                 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4166                                 $sql_extra,
4167                                 DateTimeFormat::utcNow(),   // update edited timestamp
4168                                 intval(api_user()),
4169                                 DBA::escape($photo_id),
4170                                 DBA::escape($album)
4171                         );
4172                 } else {
4173                         $nothingtodo = true;
4174                 }
4175
4176                 if (x($_FILES, 'media')) {
4177                         $nothingtodo = false;
4178                         $media = $_FILES['media'];
4179                         $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4180                         if (!is_null($data)) {
4181                                 return api_format_data("photo_update", $type, $data);
4182                         }
4183                 }
4184
4185                 // return success of updating or error message
4186                 if ($result) {
4187                         $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4188                         return api_format_data("photo_update", $type, ['$result' => $answer]);
4189                 } else {
4190                         if ($nothingtodo) {
4191                                 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4192                                 return api_format_data("photo_update", $type, ['$result' => $answer]);
4193                         }
4194                         throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4195                 }
4196         }
4197         throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4198 }
4199
4200 /**
4201  * @brief delete a single photo from the database through api
4202  *
4203  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4204  * @return string|array
4205  */
4206 function api_fr_photo_delete($type)
4207 {
4208         if (api_user() === false) {
4209                 throw new ForbiddenException();
4210         }
4211         // input params
4212         $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4213
4214         // do several checks on input parameters
4215         // we do not allow calls without photo id
4216         if ($photo_id == null) {
4217                 throw new BadRequestException("no photo_id specified");
4218         }
4219         // check if photo is existing in database
4220         $r = q(
4221                 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4222                 intval(api_user()),
4223                 DBA::escape($photo_id)
4224         );
4225         if (!DBA::isResult($r)) {
4226                 throw new BadRequestException("photo not available");
4227         }
4228         // now we can perform on the deletion of the photo
4229         $result = DBA::delete('photo', ['uid' => api_user(), 'resource-id' => $photo_id]);
4230
4231         // return success of deletion or error message
4232         if ($result) {
4233                 // retrieve the id of the parent element (the photo element)
4234                 $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4235                 $photo_item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4236
4237                 if (!DBA::isResult($photo_item)) {
4238                         throw new InternalServerErrorException("problem with deleting items occured");
4239                 }
4240                 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4241                 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4242                 Item::deleteForUser(['id' => $photo_item['id']], api_user());
4243
4244                 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4245                 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4246         } else {
4247                 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4248         }
4249 }
4250
4251
4252 /**
4253  * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4254  *
4255  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4256  * @return string|array
4257  */
4258 function api_fr_photo_detail($type)
4259 {
4260         if (api_user() === false) {
4261                 throw new ForbiddenException();
4262         }
4263         if (!x($_REQUEST, 'photo_id')) {
4264                 throw new BadRequestException("No photo id.");
4265         }
4266
4267         $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4268         $photo_id = $_REQUEST['photo_id'];
4269
4270         // prepare json/xml output with data from database for the requested photo
4271         $data = prepare_photo_data($type, $scale, $photo_id);
4272
4273         return api_format_data("photo_detail", $type, $data);
4274 }
4275
4276
4277 /**
4278  * Updates the user’s profile image.
4279  *
4280  * @brief updates the profile image for the user (either a specified profile or the default profile)
4281  *
4282  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4283  *
4284  * @return string|array
4285  * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4286  */
4287 function api_account_update_profile_image($type)
4288 {
4289         if (api_user() === false) {
4290                 throw new ForbiddenException();
4291         }
4292         // input params
4293         $profile_id = defaults($_REQUEST, 'profile_id', 0);
4294
4295         // error if image data is missing
4296         if (!x($_FILES, 'image')) {
4297                 throw new BadRequestException("no media data submitted");
4298         }
4299
4300         // check if specified profile id is valid
4301         if ($profile_id != 0) {
4302                 $profile = DBA::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4303                 // error message if specified profile id is not in database
4304                 if (!DBA::isResult($profile)) {
4305                         throw new BadRequestException("profile_id not available");
4306                 }
4307                 $is_default_profile = $profile['is-default'];
4308         } else {
4309                 $is_default_profile = 1;
4310         }
4311
4312         // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4313         $media = null;
4314         if (x($_FILES, 'image')) {
4315                 $media = $_FILES['image'];
4316         } elseif (x($_FILES, 'media')) {
4317                 $media = $_FILES['media'];
4318         }
4319         // save new profile image
4320         $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4321
4322         // get filetype
4323         if (is_array($media['type'])) {
4324                 $filetype = $media['type'][0];
4325         } else {
4326                 $filetype = $media['type'];
4327         }
4328         if ($filetype == "image/jpeg") {
4329                 $fileext = "jpg";
4330         } elseif ($filetype == "image/png") {
4331                 $fileext = "png";
4332         } else {
4333                 throw new InternalServerErrorException('Unsupported filetype');
4334         }
4335
4336         // change specified profile or all profiles to the new resource-id
4337         if ($is_default_profile) {
4338                 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4339                 DBA::update('photo', ['profile' => false], $condition);
4340         } else {
4341                 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype,
4342                         'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype];
4343                 DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4344         }
4345
4346         Contact::updateSelfFromUserID(api_user(), true);
4347
4348         // Update global directory in background
4349         $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4350         if ($url && strlen(Config::get('system', 'directory'))) {
4351                 Worker::add(PRIORITY_LOW, "Directory", $url);
4352         }
4353
4354         Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4355
4356         // output for client
4357         if ($data) {
4358                 return api_account_verify_credentials($type);
4359         } else {
4360                 // SaveMediaToDatabase failed for some reason
4361                 throw new InternalServerErrorException("image upload failed");
4362         }
4363 }
4364
4365 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4366 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4367 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4368 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4369 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4370 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4371 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4372 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4373 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4374
4375 /**
4376  * Update user profile
4377  *
4378  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4379  *
4380  * @return array|string
4381  */
4382 function api_account_update_profile($type)
4383 {
4384         $local_user = api_user();
4385         $api_user = api_get_user(get_app());
4386
4387         if (!empty($_POST['name'])) {
4388                 DBA::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4389                 DBA::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4390                 DBA::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4391                 DBA::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4392         }
4393
4394         if (isset($_POST['description'])) {
4395                 DBA::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4396                 DBA::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4397                 DBA::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4398         }
4399
4400         Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4401         // Update global directory in background
4402         if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4403                 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4404         }
4405
4406         return api_account_verify_credentials($type);
4407 }
4408
4409 /// @TODO move to top of file or somewhere better
4410 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4411
4412 /**
4413  *
4414  * @param string $acl_string
4415  */
4416 function check_acl_input($acl_string)
4417 {
4418         if ($acl_string == null || $acl_string == " ") {
4419                 return false;
4420         }
4421         $contact_not_found = false;
4422
4423         // split <x><y><z> into array of cid's
4424         preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4425
4426         // check for each cid if it is available on server
4427         $cid_array = $array[0];
4428         foreach ($cid_array as $cid) {
4429                 $cid = str_replace("<", "", $cid);
4430                 $cid = str_replace(">", "", $cid);
4431                 $condition = ['id' => $cid, 'uid' => api_user()];
4432                 $contact_not_found |= !DBA::exists('contact', $condition);
4433         }
4434         return $contact_not_found;
4435 }
4436
4437 /**
4438  *
4439  * @param string  $mediatype
4440  * @param array   $media
4441  * @param string  $type
4442  * @param string  $album
4443  * @param string  $allow_cid
4444  * @param string  $deny_cid
4445  * @param string  $allow_gid
4446  * @param string  $deny_gid
4447  * @param string  $desc
4448  * @param integer $profile
4449  * @param boolean $visibility
4450  * @param string  $photo_id
4451  */
4452 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)
4453 {
4454         $visitor   = 0;
4455         $src = "";
4456         $filetype = "";
4457         $filename = "";
4458         $filesize = 0;
4459
4460         if (is_array($media)) {
4461                 if (is_array($media['tmp_name'])) {
4462                         $src = $media['tmp_name'][0];
4463                 } else {
4464                         $src = $media['tmp_name'];
4465                 }
4466                 if (is_array($media['name'])) {
4467                         $filename = basename($media['name'][0]);
4468                 } else {
4469                         $filename = basename($media['name']);
4470                 }
4471                 if (is_array($media['size'])) {
4472                         $filesize = intval($media['size'][0]);
4473                 } else {
4474                         $filesize = intval($media['size']);
4475                 }
4476                 if (is_array($media['type'])) {
4477                         $filetype = $media['type'][0];
4478                 } else {
4479                         $filetype = $media['type'];
4480                 }
4481         }
4482
4483         if ($filetype == "") {
4484                 $filetype=Image::guessType($filename);
4485         }
4486         $imagedata = @getimagesize($src);
4487         if ($imagedata) {
4488                 $filetype = $imagedata['mime'];
4489         }
4490         Logger::log(
4491                 "File upload src: " . $src . " - filename: " . $filename .
4492                 " - size: " . $filesize . " - type: " . $filetype,
4493                 Logger::DEBUG
4494         );
4495
4496         // check if there was a php upload error
4497         if ($filesize == 0 && $media['error'] == 1) {
4498                 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4499         }
4500         // check against max upload size within Friendica instance
4501         $maximagesize = Config::get('system', 'maximagesize');
4502         if ($maximagesize && ($filesize > $maximagesize)) {
4503                 $formattedBytes = Strings::formatBytes($maximagesize);
4504                 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4505         }
4506
4507         // create Photo instance with the data of the image
4508         $imagedata = @file_get_contents($src);
4509         $Image = new Image($imagedata, $filetype);
4510         if (!$Image->isValid()) {
4511                 throw new InternalServerErrorException("unable to process image data");
4512         }
4513
4514         // check orientation of image
4515         $Image->orient($src);
4516         @unlink($src);
4517
4518         // check max length of images on server
4519         $max_length = Config::get('system', 'max_image_length');
4520         if (!$max_length) {
4521                 $max_length = MAX_IMAGE_LENGTH;
4522         }
4523         if ($max_length > 0) {
4524                 $Image->scaleDown($max_length);
4525                 Logger::log("File upload: Scaling picture to new size " . $max_length, Logger::DEBUG);
4526         }
4527         $width = $Image->getWidth();
4528         $height = $Image->getHeight();
4529
4530         // create a new resource-id if not already provided
4531         $hash = ($photo_id == null) ? Photo::newResource() : $photo_id;
4532
4533         if ($mediatype == "photo") {
4534                 // upload normal image (scales 0, 1, 2)
4535                 Logger::log("photo upload: starting new photo upload", Logger::DEBUG);
4536
4537                 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4538                 if (!$r) {
4539                         Logger::log("photo upload: image upload with scale 0 (original size) failed");
4540                 }
4541                 if ($width > 640 || $height > 640) {
4542                         $Image->scaleDown(640);
4543                         $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4544                         if (!$r) {
4545                                 Logger::log("photo upload: image upload with scale 1 (640x640) failed");
4546                         }
4547                 }
4548
4549                 if ($width > 320 || $height > 320) {
4550                         $Image->scaleDown(320);
4551                         $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4552                         if (!$r) {
4553                                 Logger::log("photo upload: image upload with scale 2 (320x320) failed");
4554                         }
4555                 }
4556                 Logger::log("photo upload: new photo upload ended", Logger::DEBUG);
4557         } elseif ($mediatype == "profileimage") {
4558                 // upload profile image (scales 4, 5, 6)
4559                 Logger::log("photo upload: starting new profile image upload", Logger::DEBUG);
4560
4561                 if ($width > 300 || $height > 300) {
4562                         $Image->scaleDown(300);
4563                         $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4564                         if (!$r) {
4565                                 Logger::log("photo upload: profile image upload with scale 4 (300x300) failed");
4566                         }
4567                 }
4568
4569                 if ($width > 80 || $height > 80) {
4570                         $Image->scaleDown(80);
4571                         $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4572                         if (!$r) {
4573                                 Logger::log("photo upload: profile image upload with scale 5 (80x80) failed");
4574                         }
4575                 }
4576
4577                 if ($width > 48 || $height > 48) {
4578                         $Image->scaleDown(48);
4579                         $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4580                         if (!$r) {
4581                                 Logger::log("photo upload: profile image upload with scale 6 (48x48) failed");
4582                         }
4583                 }
4584                 $Image->__destruct();
4585                 Logger::log("photo upload: new profile image upload ended", Logger::DEBUG);
4586         }
4587
4588         if (isset($r) && $r) {
4589                 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4590                 if ($photo_id == null && $mediatype == "photo") {
4591                         post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4592                 }
4593                 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4594                 return prepare_photo_data($type, false, $hash);
4595         } else {
4596                 throw new InternalServerErrorException("image upload failed");
4597         }
4598 }
4599
4600 /**
4601  *
4602  * @param string  $hash
4603  * @param string  $allow_cid
4604  * @param string  $deny_cid
4605  * @param string  $allow_gid
4606  * @param string  $deny_gid
4607  * @param string  $filetype
4608  * @param boolean $visibility
4609  */
4610 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4611 {
4612         // get data about the api authenticated user
4613         $uri = Item::newURI(intval(api_user()));
4614         $owner_record = DBA::selectFirst('contact', [], ['uid' => api_user(), 'self' => true]);
4615
4616         $arr = [];
4617         $arr['guid']          = System::createUUID();
4618         $arr['uid']           = intval(api_user());
4619         $arr['uri']           = $uri;
4620         $arr['parent-uri']    = $uri;
4621         $arr['type']          = 'photo';
4622         $arr['wall']          = 1;
4623         $arr['resource-id']   = $hash;
4624         $arr['contact-id']    = $owner_record['id'];
4625         $arr['owner-name']    = $owner_record['name'];
4626         $arr['owner-link']    = $owner_record['url'];
4627         $arr['owner-avatar']  = $owner_record['thumb'];
4628         $arr['author-name']   = $owner_record['name'];
4629         $arr['author-link']   = $owner_record['url'];
4630         $arr['author-avatar'] = $owner_record['thumb'];
4631         $arr['title']         = "";
4632         $arr['allow_cid']     = $allow_cid;
4633         $arr['allow_gid']     = $allow_gid;
4634         $arr['deny_cid']      = $deny_cid;
4635         $arr['deny_gid']      = $deny_gid;
4636         $arr['visible']       = $visibility;
4637         $arr['origin']        = 1;
4638
4639         $typetoext = [
4640                         'image/jpeg' => 'jpg',
4641                         'image/png' => 'png',
4642                         'image/gif' => 'gif'
4643                         ];
4644
4645         // adds link to the thumbnail scale photo
4646         $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
4647                                 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4648                                 . '[/url]';
4649
4650         // do the magic for storing the item in the database and trigger the federation to other contacts
4651         Item::insert($arr);
4652 }
4653
4654 /**
4655  *
4656  * @param string $type
4657  * @param int    $scale
4658  * @param string $photo_id
4659  *
4660  * @return array
4661  */
4662 function prepare_photo_data($type, $scale, $photo_id)
4663 {
4664         $a = get_app();
4665         $user_info = api_get_user($a);
4666
4667         if ($user_info === false) {
4668                 throw new ForbiddenException();
4669         }
4670
4671         $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4672         $data_sql = ($scale === false ? "" : "data, ");
4673
4674         // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4675         // clients needs to convert this in their way for further processing
4676         $r = q(
4677                 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4678                                         `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4679                                         MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4680                         FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4681                 $data_sql,
4682                 intval(local_user()),
4683                 DBA::escape($photo_id),
4684                 $scale_sql
4685         );
4686
4687         $typetoext = [
4688                 'image/jpeg' => 'jpg',
4689                 'image/png' => 'png',
4690                 'image/gif' => 'gif'
4691         ];
4692
4693         // prepare output data for photo
4694         if (DBA::isResult($r)) {
4695                 $data = ['photo' => $r[0]];
4696                 $data['photo']['id'] = $data['photo']['resource-id'];
4697                 if ($scale !== false) {
4698                         $data['photo']['data'] = base64_encode($data['photo']['data']);
4699                 } else {
4700                         unset($data['photo']['datasize']); //needed only with scale param
4701                 }
4702                 if ($type == "xml") {
4703                         $data['photo']['links'] = [];
4704                         for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4705                                 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4706                                                                                 "scale" => $k,
4707                                                                                 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4708                         }
4709                 } else {
4710                         $data['photo']['link'] = [];
4711                         // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4712                         $i = 0;
4713                         for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4714                                 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4715                                 $i++;
4716                         }
4717                 }
4718                 unset($data['photo']['resource-id']);
4719                 unset($data['photo']['minscale']);
4720                 unset($data['photo']['maxscale']);
4721         } else {
4722                 throw new NotFoundException();
4723         }
4724
4725         // retrieve item element for getting activities (like, dislike etc.) related to photo
4726         $condition = ['uid' => local_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
4727         $item = Item::selectFirstForUser(local_user(), ['id'], $condition);
4728
4729         $data['photo']['friendica_activities'] = api_format_items_activities($item, $type);
4730
4731         // retrieve comments on photo
4732         $condition = ["`parent` = ? AND `uid` = ? AND (`gravity` IN (?, ?) OR `type`='photo')",
4733                 $item[0]['parent'], api_user(), GRAVITY_PARENT, GRAVITY_COMMENT];
4734
4735         $statuses = Item::selectForUser(api_user(), [], $condition);
4736
4737         // prepare output of comments
4738         $commentData = api_format_items(Item::inArray($statuses), $user_info, false, $type);
4739         $comments = [];
4740         if ($type == "xml") {
4741                 $k = 0;
4742                 foreach ($commentData as $comment) {
4743                         $comments[$k++ . ":comment"] = $comment;
4744                 }
4745         } else {
4746                 foreach ($commentData as $comment) {
4747                         $comments[] = $comment;
4748                 }
4749         }
4750         $data['photo']['friendica_comments'] = $comments;
4751
4752         // include info if rights on photo and rights on item are mismatching
4753         $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4754                 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4755                 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4756                 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4757         $data['photo']['rights_mismatch'] = $rights_mismatch;
4758
4759         return $data;
4760 }
4761
4762
4763 /**
4764  * Similar as /mod/redir.php
4765  * redirect to 'url' after dfrn auth
4766  *
4767  * Why this when there is mod/redir.php already?
4768  * This use api_user() and api_login()
4769  *
4770  * params
4771  *              c_url: url of remote contact to auth to
4772  *              url: string, url to redirect after auth
4773  */
4774 function api_friendica_remoteauth()
4775 {
4776         $url = (x($_GET, 'url') ? $_GET['url'] : '');
4777         $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : '');
4778
4779         if ($url === '' || $c_url === '') {
4780                 throw new BadRequestException("Wrong parameters.");
4781         }
4782
4783         $c_url = Strings::normaliseLink($c_url);
4784
4785         // traditional DFRN
4786
4787         $contact = DBA::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4788
4789         if (!DBA::isResult($contact) || ($contact['network'] !== Protocol::DFRN)) {
4790                 throw new BadRequestException("Unknown contact");
4791         }
4792
4793         $cid = $contact['id'];
4794
4795         $dfrn_id = defaults($contact, 'issued-id', $contact['dfrn-id']);
4796
4797         if ($contact['duplex'] && $contact['issued-id']) {
4798                 $orig_id = $contact['issued-id'];
4799                 $dfrn_id = '1:' . $orig_id;
4800         }
4801         if ($contact['duplex'] && $contact['dfrn-id']) {
4802                 $orig_id = $contact['dfrn-id'];
4803                 $dfrn_id = '0:' . $orig_id;
4804         }
4805
4806         $sec = Strings::getRandomHex();
4807
4808         $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
4809                 'sec' => $sec, 'expire' => time() + 45];
4810         DBA::insert('profile_check', $fields);
4811
4812         Logger::log($contact['name'] . ' ' . $sec, Logger::DEBUG);
4813         $dest = ($url ? '&destination_url=' . $url : '');
4814
4815         System::externalRedirect(
4816                 $contact['poll'] . '?dfrn_id=' . $dfrn_id
4817                 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4818                 . '&type=profile&sec=' . $sec . $dest
4819         );
4820 }
4821 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4822
4823 /**
4824  * @brief Return the item shared, if the item contains only the [share] tag
4825  *
4826  * @param array $item Sharer item
4827  * @return array|false Shared item or false if not a reshare
4828  */
4829 function api_share_as_retweet(&$item)
4830 {
4831         $body = trim($item["body"]);
4832
4833         if (Diaspora::isReshare($body, false) === false) {
4834                 if ($item['author-id'] == $item['owner-id']) {
4835                         return false;
4836                 } else {
4837                         // Reshares from OStatus, ActivityPub and Twitter
4838                         $reshared_item = $item;
4839                         $reshared_item['owner-id'] = $reshared_item['author-id'];
4840                         $reshared_item['owner-link'] = $reshared_item['author-link'];
4841                         $reshared_item['owner-name'] = $reshared_item['author-name'];
4842                         $reshared_item['owner-avatar'] = $reshared_item['author-avatar'];
4843                         return $reshared_item;
4844                 }
4845         }
4846
4847         /// @TODO "$1" should maybe mean '$1' ?
4848         $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
4849         /*
4850          * Skip if there is no shared message in there
4851          * we already checked this in diaspora::isReshare()
4852          * but better one more than one less...
4853          */
4854         if (($body == $attributes) || empty($attributes)) {
4855                 return false;
4856         }
4857
4858         // build the fake reshared item
4859         $reshared_item = $item;
4860
4861         $author = "";
4862         preg_match("/author='(.*?)'/ism", $attributes, $matches);
4863         if (!empty($matches[1])) {
4864                 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
4865         }
4866
4867         preg_match('/author="(.*?)"/ism', $attributes, $matches);
4868         if (!empty($matches[1])) {
4869                 $author = $matches[1];
4870         }
4871
4872         $profile = "";
4873         preg_match("/profile='(.*?)'/ism", $attributes, $matches);
4874         if (!empty($matches[1])) {
4875                 $profile = $matches[1];
4876         }
4877
4878         preg_match('/profile="(.*?)"/ism', $attributes, $matches);
4879         if (!empty($matches[1])) {
4880                 $profile = $matches[1];
4881         }
4882
4883         $avatar = "";
4884         preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
4885         if (!empty($matches[1])) {
4886                 $avatar = $matches[1];
4887         }
4888
4889         preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
4890         if (!empty($matches[1])) {
4891                 $avatar = $matches[1];
4892         }
4893
4894         $link = "";
4895         preg_match("/link='(.*?)'/ism", $attributes, $matches);
4896         if (!empty($matches[1])) {
4897                 $link = $matches[1];
4898         }
4899
4900         preg_match('/link="(.*?)"/ism', $attributes, $matches);
4901         if (!empty($matches[1])) {
4902                 $link = $matches[1];
4903         }
4904
4905         $posted = "";
4906         preg_match("/posted='(.*?)'/ism", $attributes, $matches);
4907         if (!empty($matches[1])) {
4908                 $posted = $matches[1];
4909         }
4910
4911         preg_match('/posted="(.*?)"/ism', $attributes, $matches);
4912         if (!empty($matches[1])) {
4913                 $posted = $matches[1];
4914         }
4915
4916         $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
4917
4918         if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
4919                 return false;
4920         }
4921
4922         $reshared_item["body"] = $shared_body;
4923         $reshared_item["author-name"] = $author;
4924         $reshared_item["author-link"] = $profile;
4925         $reshared_item["author-avatar"] = $avatar;
4926         $reshared_item["plink"] = $link;
4927         $reshared_item["created"] = $posted;
4928         $reshared_item["edited"] = $posted;
4929
4930         return $reshared_item;
4931 }
4932
4933 /**
4934  *
4935  * @param string $profile
4936  *
4937  * @return string|false
4938  * @todo remove trailing junk from profile url
4939  * @todo pump.io check has to check the website
4940  */
4941 function api_get_nick($profile)
4942 {
4943         $nick = "";
4944
4945         $r = q(
4946                 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4947                 DBA::escape(Strings::normaliseLink($profile))
4948         );
4949
4950         if (DBA::isResult($r)) {
4951                 $nick = $r[0]["nick"];
4952         }
4953
4954         if (!$nick == "") {
4955                 $r = q(
4956                         "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
4957                         DBA::escape(Strings::normaliseLink($profile))
4958                 );
4959
4960                 if (DBA::isResult($r)) {
4961                         $nick = $r[0]["nick"];
4962                 }
4963         }
4964
4965         if (!$nick == "") {
4966                 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
4967                 if ($friendica != $profile) {
4968                         $nick = $friendica;
4969                 }
4970         }
4971
4972         if (!$nick == "") {
4973                 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
4974                 if ($diaspora != $profile) {
4975                         $nick = $diaspora;
4976                 }
4977         }
4978
4979         if (!$nick == "") {
4980                 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
4981                 if ($twitter != $profile) {
4982                         $nick = $twitter;
4983                 }
4984         }
4985
4986
4987         if (!$nick == "") {
4988                 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
4989                 if ($StatusnetHost != $profile) {
4990                         $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
4991                         if ($StatusnetUser != $profile) {
4992                                 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
4993                                 $user = json_decode($UserData);
4994                                 if ($user) {
4995                                         $nick = $user->screen_name;
4996                                 }
4997                         }
4998                 }
4999         }
5000
5001         // To-Do: look at the page if its really a pumpio site
5002         //if (!$nick == "") {
5003         //      $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
5004         //      if ($pumpio != $profile)
5005         //              $nick = $pumpio;
5006                 //      <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5007
5008         //}
5009
5010         if ($nick != "") {
5011                 return $nick;
5012         }
5013
5014         return false;
5015 }
5016
5017 /**
5018  *
5019  * @param array $item
5020  *
5021  * @return array
5022  */
5023 function api_in_reply_to($item)
5024 {
5025         $in_reply_to = [];
5026
5027         $in_reply_to['status_id'] = null;
5028         $in_reply_to['user_id'] = null;
5029         $in_reply_to['status_id_str'] = null;
5030         $in_reply_to['user_id_str'] = null;
5031         $in_reply_to['screen_name'] = null;
5032
5033         if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5034                 $parent = Item::selectFirst(['id'], ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
5035                 if (DBA::isResult($parent)) {
5036                         $in_reply_to['status_id'] = intval($parent['id']);
5037                 } else {
5038                         $in_reply_to['status_id'] = intval($item['parent']);
5039                 }
5040
5041                 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5042
5043                 $fields = ['author-nick', 'author-name', 'author-id', 'author-link'];
5044                 $parent = Item::selectFirst($fields, ['id' => $in_reply_to['status_id']]);
5045
5046                 if (DBA::isResult($parent)) {
5047                         if ($parent['author-nick'] == "") {
5048                                 $parent['author-nick'] = api_get_nick($parent['author-link']);
5049                         }
5050
5051                         $in_reply_to['screen_name'] = (($parent['author-nick']) ? $parent['author-nick'] : $parent['author-name']);
5052                         $in_reply_to['user_id'] = intval($parent['author-id']);
5053                         $in_reply_to['user_id_str'] = (string) intval($parent['author-id']);
5054                 }
5055
5056                 // There seems to be situation, where both fields are identical:
5057                 // https://github.com/friendica/friendica/issues/1010
5058                 // This is a bugfix for that.
5059                 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5060                         Logger::log('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], Logger::DEBUG);
5061                         $in_reply_to['status_id'] = null;
5062                         $in_reply_to['user_id'] = null;
5063                         $in_reply_to['status_id_str'] = null;
5064                         $in_reply_to['user_id_str'] = null;
5065                         $in_reply_to['screen_name'] = null;
5066                 }
5067         }
5068
5069         return $in_reply_to;
5070 }
5071
5072 /**
5073  *
5074  * @param string $text
5075  *
5076  * @return string
5077  */
5078 function api_clean_plain_items($text)
5079 {
5080         $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
5081
5082         $text = BBCode::cleanPictureLinks($text);
5083         $URLSearchString = "^\[\]";
5084
5085         $text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $text);
5086
5087         if ($include_entities == "true") {
5088                 $text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $text);
5089         }
5090
5091         // Simplify "attachment" element
5092         $text = api_clean_attachments($text);
5093
5094         return $text;
5095 }
5096
5097 /**
5098  * @brief Removes most sharing information for API text export
5099  *
5100  * @param string $body The original body
5101  *
5102  * @return string Cleaned body
5103  */
5104 function api_clean_attachments($body)
5105 {
5106         $data = BBCode::getAttachmentData($body);
5107
5108         if (empty($data)) {
5109                 return $body;
5110         }
5111         $body = "";
5112
5113         if (isset($data["text"])) {
5114                 $body = $data["text"];
5115         }
5116         if (($body == "") && isset($data["title"])) {
5117                 $body = $data["title"];
5118         }
5119         if (isset($data["url"])) {
5120                 $body .= "\n".$data["url"];
5121         }
5122         $body .= $data["after"];
5123
5124         return $body;
5125 }
5126
5127 /**
5128  *
5129  * @param array $contacts
5130  *
5131  * @return array
5132  */
5133 function api_best_nickname(&$contacts)
5134 {
5135         $best_contact = [];
5136
5137         if (count($contacts) == 0) {
5138                 return;
5139         }
5140
5141         foreach ($contacts as $contact) {
5142                 if ($contact["network"] == "") {
5143                         $contact["network"] = "dfrn";
5144                         $best_contact = [$contact];
5145                 }
5146         }
5147
5148         if (sizeof($best_contact) == 0) {
5149                 foreach ($contacts as $contact) {
5150                         if ($contact["network"] == "dfrn") {
5151                                 $best_contact = [$contact];
5152                         }
5153                 }
5154         }
5155
5156         if (sizeof($best_contact) == 0) {
5157                 foreach ($contacts as $contact) {
5158                         if ($contact["network"] == "dspr") {
5159                                 $best_contact = [$contact];
5160                         }
5161                 }
5162         }
5163
5164         if (sizeof($best_contact) == 0) {
5165                 foreach ($contacts as $contact) {
5166                         if ($contact["network"] == "stat") {
5167                                 $best_contact = [$contact];
5168                         }
5169                 }
5170         }
5171
5172         if (sizeof($best_contact) == 0) {
5173                 foreach ($contacts as $contact) {
5174                         if ($contact["network"] == "pump") {
5175                                 $best_contact = [$contact];
5176                         }
5177                 }
5178         }
5179
5180         if (sizeof($best_contact) == 0) {
5181                 foreach ($contacts as $contact) {
5182                         if ($contact["network"] == "twit") {
5183                                 $best_contact = [$contact];
5184                         }
5185                 }
5186         }
5187
5188         if (sizeof($best_contact) == 1) {
5189                 $contacts = $best_contact;
5190         } else {
5191                 $contacts = [$contacts[0]];
5192         }
5193 }
5194
5195 /**
5196  * Return all or a specified group of the user with the containing contacts.
5197  *
5198  * @param string $type Return type (atom, rss, xml, json)
5199  *
5200  * @return array|string
5201  */
5202 function api_friendica_group_show($type)
5203 {
5204         $a = get_app();
5205
5206         if (api_user() === false) {
5207                 throw new ForbiddenException();
5208         }
5209
5210         // params
5211         $user_info = api_get_user($a);
5212         $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5213         $uid = $user_info['uid'];
5214
5215         // get data of the specified group id or all groups if not specified
5216         if ($gid != 0) {
5217                 $r = q(
5218                         "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5219                         intval($uid),
5220                         intval($gid)
5221                 );
5222                 // error message if specified gid is not in database
5223                 if (!DBA::isResult($r)) {
5224                         throw new BadRequestException("gid not available");
5225                 }
5226         } else {
5227                 $r = q(
5228                         "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5229                         intval($uid)
5230                 );
5231         }
5232
5233         // loop through all groups and retrieve all members for adding data in the user array
5234         $grps = [];
5235         foreach ($r as $rr) {
5236                 $members = Contact::getByGroupId($rr['id']);
5237                 $users = [];
5238
5239                 if ($type == "xml") {
5240                         $user_element = "users";
5241                         $k = 0;
5242                         foreach ($members as $member) {
5243                                 $user = api_get_user($a, $member['nurl']);
5244                                 $users[$k++.":user"] = $user;
5245                         }
5246                 } else {
5247                         $user_element = "user";
5248                         foreach ($members as $member) {
5249                                 $user = api_get_user($a, $member['nurl']);
5250                                 $users[] = $user;
5251                         }
5252                 }
5253                 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5254         }
5255         return api_format_data("groups", $type, ['group' => $grps]);
5256 }
5257 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5258
5259
5260 /**
5261  * Delete the specified group of the user.
5262  *
5263  * @param string $type Return type (atom, rss, xml, json)
5264  *
5265  * @return array|string
5266  */
5267 function api_friendica_group_delete($type)
5268 {
5269         $a = get_app();
5270
5271         if (api_user() === false) {
5272                 throw new ForbiddenException();
5273         }
5274
5275         // params
5276         $user_info = api_get_user($a);
5277         $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5278         $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5279         $uid = $user_info['uid'];
5280
5281         // error if no gid specified
5282         if ($gid == 0 || $name == "") {
5283                 throw new BadRequestException('gid or name not specified');
5284         }
5285
5286         // get data of the specified group id
5287         $r = q(
5288                 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5289                 intval($uid),
5290                 intval($gid)
5291         );
5292         // error message if specified gid is not in database
5293         if (!DBA::isResult($r)) {
5294                 throw new BadRequestException('gid not available');
5295         }
5296
5297         // get data of the specified group id and group name
5298         $rname = q(
5299                 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5300                 intval($uid),
5301                 intval($gid),
5302                 DBA::escape($name)
5303         );
5304         // error message if specified gid is not in database
5305         if (!DBA::isResult($rname)) {
5306                 throw new BadRequestException('wrong group name');
5307         }
5308
5309         // delete group
5310         $ret = Group::removeByName($uid, $name);
5311         if ($ret) {
5312                 // return success
5313                 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5314                 return api_format_data("group_delete", $type, ['result' => $success]);
5315         } else {
5316                 throw new BadRequestException('other API error');
5317         }
5318 }
5319 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5320
5321 /**
5322  * Delete a group.
5323  *
5324  * @param string $type Return type (atom, rss, xml, json)
5325  *
5326  * @return array|string
5327  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5328  */
5329 function api_lists_destroy($type)
5330 {
5331         $a = get_app();
5332
5333         if (api_user() === false) {
5334                 throw new ForbiddenException();
5335         }
5336
5337         // params
5338         $user_info = api_get_user($a);
5339         $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5340         $uid = $user_info['uid'];
5341
5342         // error if no gid specified
5343         if ($gid == 0) {
5344                 throw new BadRequestException('gid not specified');
5345         }
5346
5347         // get data of the specified group id
5348         $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5349         // error message if specified gid is not in database
5350         if (!$group) {
5351                 throw new BadRequestException('gid not available');
5352         }
5353
5354         if (Group::remove($gid)) {
5355                 $list = [
5356                         'name' => $group['name'],
5357                         'id' => intval($gid),
5358                         'id_str' => (string) $gid,
5359                         'user' => $user_info
5360                 ];
5361
5362                 return api_format_data("lists", $type, ['lists' => $list]);
5363         }
5364 }
5365 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5366
5367 /**
5368  * Add a new group to the database.
5369  *
5370  * @param  string $name  Group name
5371  * @param  int    $uid   User ID
5372  * @param  array  $users List of users to add to the group
5373  *
5374  * @return array
5375  */
5376 function group_create($name, $uid, $users = [])
5377 {
5378         // error if no name specified
5379         if ($name == "") {
5380                 throw new BadRequestException('group name not specified');
5381         }
5382
5383         // get data of the specified group name
5384         $rname = q(
5385                 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5386                 intval($uid),
5387                 DBA::escape($name)
5388         );
5389         // error message if specified group name already exists
5390         if (DBA::isResult($rname)) {
5391                 throw new BadRequestException('group name already exists');
5392         }
5393
5394         // check if specified group name is a deleted group
5395         $rname = q(
5396                 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5397                 intval($uid),
5398                 DBA::escape($name)
5399         );
5400         // error message if specified group name already exists
5401         if (DBA::isResult($rname)) {
5402                 $reactivate_group = true;
5403         }
5404
5405         // create group
5406         $ret = Group::create($uid, $name);
5407         if ($ret) {
5408                 $gid = Group::getIdByName($uid, $name);
5409         } else {
5410                 throw new BadRequestException('other API error');
5411         }
5412
5413         // add members
5414         $erroraddinguser = false;
5415         $errorusers = [];
5416         foreach ($users as $user) {
5417                 $cid = $user['cid'];
5418                 // check if user really exists as contact
5419                 $contact = q(
5420                         "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5421                         intval($cid),
5422                         intval($uid)
5423                 );
5424                 if (count($contact)) {
5425                         Group::addMember($gid, $cid);
5426                 } else {
5427                         $erroraddinguser = true;
5428                         $errorusers[] = $cid;
5429                 }
5430         }
5431
5432         // return success message incl. missing users in array
5433         $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5434
5435         return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5436 }
5437
5438 /**
5439  * Create the specified group with the posted array of contacts.
5440  *
5441  * @param string $type Return type (atom, rss, xml, json)
5442  *
5443  * @return array|string
5444  */
5445 function api_friendica_group_create($type)
5446 {
5447         $a = get_app();
5448
5449         if (api_user() === false) {
5450                 throw new ForbiddenException();
5451         }
5452
5453         // params
5454         $user_info = api_get_user($a);
5455         $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5456         $uid = $user_info['uid'];
5457         $json = json_decode($_POST['json'], true);
5458         $users = $json['user'];
5459
5460         $success = group_create($name, $uid, $users);
5461
5462         return api_format_data("group_create", $type, ['result' => $success]);
5463 }
5464 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5465
5466 /**
5467  * Create a new group.
5468  *
5469  * @param string $type Return type (atom, rss, xml, json)
5470  *
5471  * @return array|string
5472  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5473  */
5474 function api_lists_create($type)
5475 {
5476         $a = get_app();
5477
5478         if (api_user() === false) {
5479                 throw new ForbiddenException();
5480         }
5481
5482         // params
5483         $user_info = api_get_user($a);
5484         $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5485         $uid = $user_info['uid'];
5486
5487         $success = group_create($name, $uid);
5488         if ($success['success']) {
5489                 $grp = [
5490                         'name' => $success['name'],
5491                         'id' => intval($success['gid']),
5492                         'id_str' => (string) $success['gid'],
5493                         'user' => $user_info
5494                 ];
5495
5496                 return api_format_data("lists", $type, ['lists'=>$grp]);
5497         }
5498 }
5499 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5500
5501 /**
5502  * Update the specified group with the posted array of contacts.
5503  *
5504  * @param string $type Return type (atom, rss, xml, json)
5505  *
5506  * @return array|string
5507  */
5508 function api_friendica_group_update($type)
5509 {
5510         $a = get_app();
5511
5512         if (api_user() === false) {
5513                 throw new ForbiddenException();
5514         }
5515
5516         // params
5517         $user_info = api_get_user($a);
5518         $uid = $user_info['uid'];
5519         $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5520         $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5521         $json = json_decode($_POST['json'], true);
5522         $users = $json['user'];
5523
5524         // error if no name specified
5525         if ($name == "") {
5526                 throw new BadRequestException('group name not specified');
5527         }
5528
5529         // error if no gid specified
5530         if ($gid == "") {
5531                 throw new BadRequestException('gid not specified');
5532         }
5533
5534         // remove members
5535         $members = Contact::getByGroupId($gid);
5536         foreach ($members as $member) {
5537                 $cid = $member['id'];
5538                 foreach ($users as $user) {
5539                         $found = ($user['cid'] == $cid ? true : false);
5540                 }
5541                 if (!isset($found) || !$found) {
5542                         Group::removeMemberByName($uid, $name, $cid);
5543                 }
5544         }
5545
5546         // add members
5547         $erroraddinguser = false;
5548         $errorusers = [];
5549         foreach ($users as $user) {
5550                 $cid = $user['cid'];
5551                 // check if user really exists as contact
5552                 $contact = q(
5553                         "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5554                         intval($cid),
5555                         intval($uid)
5556                 );
5557
5558                 if (count($contact)) {
5559                         Group::addMember($gid, $cid);
5560                 } else {
5561                         $erroraddinguser = true;
5562                         $errorusers[] = $cid;
5563                 }
5564         }
5565
5566         // return success message incl. missing users in array
5567         $status = ($erroraddinguser ? "missing user" : "ok");
5568         $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5569         return api_format_data("group_update", $type, ['result' => $success]);
5570 }
5571
5572 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5573
5574 /**
5575  * Update information about a group.
5576  *
5577  * @param string $type Return type (atom, rss, xml, json)
5578  *
5579  * @return array|string
5580  * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5581  */
5582 function api_lists_update($type)
5583 {
5584         $a = get_app();
5585
5586         if (api_user() === false) {
5587                 throw new ForbiddenException();
5588         }
5589
5590         // params
5591         $user_info = api_get_user($a);
5592         $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5593         $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5594         $uid = $user_info['uid'];
5595
5596         // error if no gid specified
5597         if ($gid == 0) {
5598                 throw new BadRequestException('gid not specified');
5599         }
5600
5601         // get data of the specified group id
5602         $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5603         // error message if specified gid is not in database
5604         if (!$group) {
5605                 throw new BadRequestException('gid not available');
5606         }
5607
5608         if (Group::update($gid, $name)) {
5609                 $list = [
5610                         'name' => $name,
5611                         'id' => intval($gid),
5612                         'id_str' => (string) $gid,
5613                         'user' => $user_info
5614                 ];
5615
5616                 return api_format_data("lists", $type, ['lists' => $list]);
5617         }
5618 }
5619
5620 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5621
5622 /**
5623  *
5624  * @param string $type Return type (atom, rss, xml, json)
5625  *
5626  * @return array|string
5627  */
5628 function api_friendica_activity($type)
5629 {
5630         $a = get_app();
5631
5632         if (api_user() === false) {
5633                 throw new ForbiddenException();
5634         }
5635         $verb = strtolower($a->argv[3]);
5636         $verb = preg_replace("|\..*$|", "", $verb);
5637
5638         $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5639
5640         $res = Item::performLike($id, $verb);
5641
5642         if ($res) {
5643                 if ($type == "xml") {
5644                         $ok = "true";
5645                 } else {
5646                         $ok = "ok";
5647                 }
5648                 return api_format_data('ok', $type, ['ok' => $ok]);
5649         } else {
5650                 throw new BadRequestException('Error adding activity');
5651         }
5652 }
5653
5654 /// @TODO move to top of file or somewhere better
5655 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5656 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5657 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5658 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5659 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5660 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5661 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5662 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5663 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5664 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5665
5666 /**
5667  * @brief Returns notifications
5668  *
5669  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5670  * @return string|array
5671 */
5672 function api_friendica_notification($type)
5673 {
5674         $a = get_app();
5675
5676         if (api_user() === false) {
5677                 throw new ForbiddenException();
5678         }
5679         if ($a->argc!==3) {
5680                 throw new BadRequestException("Invalid argument count");
5681         }
5682         $nm = new NotificationsManager();
5683
5684         $notes = $nm->getAll([], "+seen -date", 50);
5685
5686         if ($type == "xml") {
5687                 $xmlnotes = [];
5688                 if (!empty($notes)) {
5689                         foreach ($notes as $note) {
5690                                 $xmlnotes[] = ["@attributes" => $note];
5691                         }
5692                 }
5693
5694                 $notes = $xmlnotes;
5695         }
5696
5697         return api_format_data("notes", $type, ['note' => $notes]);
5698 }
5699
5700 /**
5701  * POST request with 'id' param as notification id
5702  *
5703  * @brief Set notification as seen and returns associated item (if possible)
5704  *
5705  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5706  * @return string|array
5707  */
5708 function api_friendica_notification_seen($type)
5709 {
5710         $a = get_app();
5711         $user_info = api_get_user($a);
5712
5713         if (api_user() === false || $user_info === false) {
5714                 throw new ForbiddenException();
5715         }
5716         if ($a->argc!==4) {
5717                 throw new BadRequestException("Invalid argument count");
5718         }
5719
5720         $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5721
5722         $nm = new NotificationsManager();
5723         $note = $nm->getByID($id);
5724         if (is_null($note)) {
5725                 throw new BadRequestException("Invalid argument");
5726         }
5727
5728         $nm->setSeen($note);
5729         if ($note['otype']=='item') {
5730                 // would be really better with an ItemsManager and $im->getByID() :-P
5731                 $item = Item::selectFirstForUser(api_user(), [], ['id' => $note['iid'], 'uid' => api_user()]);
5732                 if (DBA::isResult($item)) {
5733                         // we found the item, return it to the user
5734                         $ret = api_format_items([$item], $user_info, false, $type);
5735                         $data = ['status' => $ret];
5736                         return api_format_data("status", $type, $data);
5737                 }
5738                 // the item can't be found, but we set the note as seen, so we count this as a success
5739         }
5740         return api_format_data('result', $type, ['result' => "success"]);
5741 }
5742
5743 /// @TODO move to top of file or somewhere better
5744 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5745 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5746
5747 /**
5748  * @brief update a direct_message to seen state
5749  *
5750  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5751  * @return string|array (success result=ok, error result=error with error message)
5752  */
5753 function api_friendica_direct_messages_setseen($type)
5754 {
5755         $a = get_app();
5756         if (api_user() === false) {
5757                 throw new ForbiddenException();
5758         }
5759
5760         // params
5761         $user_info = api_get_user($a);
5762         $uid = $user_info['uid'];
5763         $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5764
5765         // return error if id is zero
5766         if ($id == "") {
5767                 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5768                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5769         }
5770
5771         // error message if specified id is not in database
5772         if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
5773                 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5774                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5775         }
5776
5777         // update seen indicator
5778         $result = DBA::update('mail', ['seen' => true], ['id' => $id]);
5779
5780         if ($result) {
5781                 // return success
5782                 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
5783                 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
5784         } else {
5785                 $answer = ['result' => 'error', 'message' => 'unknown error'];
5786                 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5787         }
5788 }
5789
5790 /// @TODO move to top of file or somewhere better
5791 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5792
5793 /**
5794  * @brief search for direct_messages containing a searchstring through api
5795  *
5796  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5797  * @param string $box
5798  * @return string|array (success: success=true if found and search_result contains found messages,
5799  *                          success=false if nothing was found, search_result='nothing found',
5800  *                 error: result=error with error message)
5801  */
5802 function api_friendica_direct_messages_search($type, $box = "")
5803 {
5804         $a = get_app();
5805
5806         if (api_user() === false) {
5807                 throw new ForbiddenException();
5808         }
5809
5810         // params
5811         $user_info = api_get_user($a);
5812         $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
5813         $uid = $user_info['uid'];
5814
5815         // error if no searchstring specified
5816         if ($searchstring == "") {
5817                 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
5818                 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
5819         }
5820
5821         // get data for the specified searchstring
5822         $r = q(
5823                 "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",
5824                 intval($uid),
5825                 DBA::escape('%'.$searchstring.'%')
5826         );
5827
5828         $profile_url = $user_info["url"];
5829
5830         // message if nothing was found
5831         if (!DBA::isResult($r)) {
5832                 $success = ['success' => false, 'search_results' => 'problem with query'];
5833         } elseif (count($r) == 0) {
5834                 $success = ['success' => false, 'search_results' => 'nothing found'];
5835         } else {
5836                 $ret = [];
5837                 foreach ($r as $item) {
5838                         if ($box == "inbox" || $item['from-url'] != $profile_url) {
5839                                 $recipient = $user_info;
5840                                 $sender = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5841                         } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5842                                 $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url']));
5843                                 $sender = $user_info;
5844                         }
5845
5846                         if (isset($recipient) && isset($sender)) {
5847                                 $ret[] = api_format_messages($item, $recipient, $sender);
5848                         }
5849                 }
5850                 $success = ['success' => true, 'search_results' => $ret];
5851         }
5852
5853         return api_format_data("direct_message_search", $type, ['$result' => $success]);
5854 }
5855
5856 /// @TODO move to top of file or somewhere better
5857 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5858
5859 /**
5860  * @brief return data of all the profiles a user has to the client
5861  *
5862  * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5863  * @return string|array
5864  */
5865 function api_friendica_profile_show($type)
5866 {
5867         $a = get_app();
5868
5869         if (api_user() === false) {
5870                 throw new ForbiddenException();
5871         }
5872
5873         // input params
5874         $profile_id = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
5875
5876         // retrieve general information about profiles for user
5877         $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
5878         $directory = Config::get('system', 'directory');
5879
5880         // get data of the specified profile id or all profiles of the user if not specified
5881         if ($profile_id != 0) {
5882                 $r = q(
5883                         "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
5884                         intval(api_user()),
5885                         intval($profile_id)
5886                 );
5887
5888                 // error message if specified gid is not in database
5889                 if (!DBA::isResult($r)) {
5890                         throw new BadRequestException("profile_id not available");
5891                 }
5892         } else {
5893                 $r = q(
5894                         "SELECT * FROM `profile` WHERE `uid` = %d",
5895                         intval(api_user())
5896                 );
5897         }
5898         // loop through all returned profiles and retrieve data and users
5899         $k = 0;
5900         $profiles = [];
5901         foreach ($r as $rr) {
5902                 $profile = api_format_items_profiles($rr);
5903
5904                 // select all users from contact table, loop and prepare standard return for user data
5905                 $users = [];
5906                 $nurls = q(
5907                         "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
5908                         intval(api_user()),
5909                         intval($rr['id'])
5910                 );
5911
5912                 foreach ($nurls as $nurl) {
5913                         $user = api_get_user($a, $nurl['nurl']);
5914                         ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
5915                 }
5916                 $profile['users'] = $users;
5917
5918                 // add prepared profile data to array for final return
5919                 if ($type == "xml") {
5920                         $profiles[$k++ . ":profile"] = $profile;
5921                 } else {
5922                         $profiles[] = $profile;
5923                 }
5924         }
5925
5926         // return settings, authenticated user and profiles data
5927         $self = DBA::selectFirst('contact', ['nurl'], ['uid' => api_user(), 'self' => true]);
5928
5929         $result = ['multi_profiles' => $multi_profiles ? true : false,
5930                                         'global_dir' => $directory,
5931                                         'friendica_owner' => api_get_user($a, $self['nurl']),
5932                                         'profiles' => $profiles];
5933         return api_format_data("friendica_profiles", $type, ['$result' => $result]);
5934 }
5935 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
5936
5937 /**
5938  * Returns a list of saved searches.
5939  *
5940  * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5941  *
5942  * @param  string $type Return format: json or xml
5943  *
5944  * @return string|array
5945  */
5946 function api_saved_searches_list($type)
5947 {
5948         $terms = DBA::select('search', ['id', 'term'], ['uid' => local_user()]);
5949
5950         $result = [];
5951         while ($term = $terms->fetch()) {
5952                 $result[] = [
5953                         'created_at' => api_date(time()),
5954                         'id' => intval($term['id']),
5955                         'id_str' => $term['id'],
5956                         'name' => $term['term'],
5957                         'position' => null,
5958                         'query' => $term['term']
5959                 ];
5960         }
5961
5962         DBA::close($terms);
5963
5964         return api_format_data("terms", $type, ['terms' => $result]);
5965 }
5966
5967 /// @TODO move to top of file or somewhere better
5968 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5969
5970 /*
5971 @TODO Maybe open to implement?
5972 To.Do:
5973         [pagename] => api/1.1/statuses/lookup.json
5974         [id] => 605138389168451584
5975         [include_cards] => true
5976         [cards_platform] => Android-12
5977         [include_entities] => true
5978         [include_my_retweet] => 1
5979         [include_rts] => 1
5980         [include_reply_count] => true
5981         [include_descendent_reply_count] => true
5982 (?)
5983
5984
5985 Not implemented by now:
5986 statuses/retweets_of_me
5987 friendships/create
5988 friendships/destroy
5989 friendships/exists
5990 friendships/show
5991 account/update_location
5992 account/update_profile_background_image
5993 blocks/create
5994 blocks/destroy
5995 friendica/profile/update
5996 friendica/profile/create
5997 friendica/profile/delete
5998
5999 Not implemented in status.net:
6000 statuses/retweeted_to_me
6001 statuses/retweeted_by_me
6002 direct_messages/destroy
6003 account/end_session
6004 account/update_delivery_device
6005 notifications/follow
6006 notifications/leave
6007 blocks/exists
6008 blocks/blocking
6009 lists
6010 */