include/api.php

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