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