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