X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fapi.php;h=052d32b17b1f8d788db0d7c65559febeb6cd3aa1;hb=0637a70b3d57be07d5df28765ab4d9f53a414840;hp=7e54fa382a643ea38c85fff7f7d3a5050a893eba;hpb=dc35d2f2f352b1f378a00dae37c6be3044c9a0a0;p=friendica.git diff --git a/include/api.php b/include/api.php index 7e54fa382a..052d32b17b 100644 --- a/include/api.php +++ b/include/api.php @@ -11,10 +11,11 @@ use Friendica\Content\ContactSelector; use Friendica\Content\Feature; use Friendica\Content\Text\BBCode; use Friendica\Content\Text\HTML; -use Friendica\Core\Addon; use Friendica\Core\Authentication; use Friendica\Core\Config; +use Friendica\Core\Hook; use Friendica\Core\L10n; +use Friendica\Core\Logger; use Friendica\Core\NotificationsManager; use Friendica\Core\PConfig; use Friendica\Core\Protocol; @@ -30,6 +31,7 @@ use Friendica\Model\User; use Friendica\Network\FKOAuth1; use Friendica\Network\HTTPException; use Friendica\Network\HTTPException\BadRequestException; +use Friendica\Network\HTTPException\ExpectationFailedException; use Friendica\Network\HTTPException\ForbiddenException; use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Network\HTTPException\MethodNotAllowedException; @@ -42,9 +44,9 @@ use Friendica\Protocol\Diaspora; use Friendica\Util\DateTimeFormat; use Friendica\Util\Network; use Friendica\Util\Proxy as ProxyUtils; +use Friendica\Util\Strings; use Friendica\Util\XML; -require_once 'include/conversation.php'; require_once 'mod/share.php'; require_once 'mod/item.php'; require_once 'mod/wall_upload.php'; @@ -54,6 +56,8 @@ define('API_METHOD_GET', 'GET'); define('API_METHOD_POST', 'POST,PUT'); define('API_METHOD_DELETE', 'POST,DELETE'); +define('API_LOG_PREFIX', 'API {action} - '); + $API = []; $called_api = []; @@ -66,7 +70,7 @@ $called_api = []; */ function api_user() { - if (x($_SESSION, 'allow_api')) { + if (!empty($_SESSION['allow_api'])) { return local_user(); } @@ -82,7 +86,8 @@ function api_user() * @brief Get source name from API client * * @return string - * Client source name, default to "api" if unset/unknown + * Client source name, default to "api" if unset/unknown + * @throws Exception */ function api_source() { @@ -96,9 +101,9 @@ function api_source() return "Twidere"; } - logger("Unrecognized user-agent ".$_SERVER['HTTP_USER_AGENT'], LOGGER_DEBUG); + Logger::info(API_LOG_PREFIX . 'Unrecognized user-agent', ['module' => 'api', 'action' => 'source', 'http_user_agent' => $_SERVER['HTTP_USER_AGENT']]); } else { - logger("Empty user-agent", LOGGER_DEBUG); + Logger::info(API_LOG_PREFIX . 'Empty user-agent', ['module' => 'api', 'action' => 'source']); } return "api"; @@ -109,6 +114,7 @@ function api_source() * * @param string $str Source date, as UTC * @return string Date in UTC formatted as "D M d H:i:s +0000 Y" + * @throws Exception */ function api_date($str) { @@ -154,15 +160,17 @@ function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY * * @brief Login API user * - * @param object $a App - * @hook 'authenticate' - * array $addon_auth - * 'username' => username from login form - * 'password' => password from login form - * 'authenticated' => return status, - * 'user_record' => return authenticated user record - * @hook 'logged_in' - * array $user logged user record + * @param App $a App + * @throws InternalServerErrorException + * @throws UnauthorizedException + * @hook 'authenticate' + * array $addon_auth + * 'username' => username from login form + * 'password' => password from login form + * 'authenticated' => return status, + * 'user_record' => return authenticated user record + * @hook 'logged_in' + * array $user logged user record */ function api_login(App $a) { @@ -173,19 +181,19 @@ function api_login(App $a) list($consumer, $token) = $oauth1->verify_request($request); if (!is_null($token)) { $oauth1->loginUser($token->uid); - Addon::callHooks('logged_in', $a->user); + Hook::callAll('logged_in', $a->user); return; } echo __FILE__.__LINE__.__FUNCTION__ . "
"; var_dump($consumer, $token); die(); } catch (Exception $e) { - logger($e); + Logger::warning(API_LOG_PREFIX . 'error', ['module' => 'api', 'action' => 'login', 'exception' => $e->getMessage()]); } // workaround for HTTP-auth in CGI mode - if (x($_SERVER, 'REDIRECT_REMOTE_USER')) { - $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6)) ; + if (!empty($_SERVER['REDIRECT_REMOTE_USER'])) { + $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6)); if (strlen($userpass)) { list($name, $password) = explode(':', $userpass); $_SERVER['PHP_AUTH_USER'] = $name; @@ -193,8 +201,8 @@ function api_login(App $a) } } - if (!x($_SERVER, 'PHP_AUTH_USER')) { - logger('API_login: ' . print_r($_SERVER, true), LOGGER_DEBUG); + if (empty($_SERVER['PHP_AUTH_USER'])) { + Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]); header('WWW-Authenticate: Basic realm="Friendica"'); throw new UnauthorizedException("This API requires login"); } @@ -223,7 +231,7 @@ function api_login(App $a) * Addons should never set 'authenticated' except to indicate success - as hooks may be chained * and later addons should not interfere with an earlier one that succeeded. */ - Addon::callHooks('authenticate', $addon_auth); + Hook::callAll('authenticate', $addon_auth); if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) { $record = $addon_auth['user_record']; @@ -235,7 +243,7 @@ function api_login(App $a) } if (!DBA::isResult($record)) { - logger('API_login failure: ' . print_r($_SERVER, true), LOGGER_DEBUG); + Logger::debug(API_LOG_PREFIX . 'failed', ['module' => 'api', 'action' => 'login', 'parameters' => $_SERVER]); header('WWW-Authenticate: Basic realm="Friendica"'); //header('HTTP/1.0 401 Unauthorized'); //die('This api requires login'); @@ -246,7 +254,7 @@ function api_login(App $a) $_SESSION["allow_api"] = true; - Addon::callHooks('logged_in', $a->user); + Hook::callAll('logged_in', $a->user); } /** @@ -272,8 +280,9 @@ function api_check_method($method) * * @brief Main API entry point * - * @param object $a App + * @param App $a App * @return string|array API call result + * @throws Exception */ function api_call(App $a) { @@ -308,33 +317,35 @@ function api_call(App $a) api_login($a); } - logger('API call for ' . $a->user['username'] . ': ' . $a->query_string); - logger('API parameters: ' . print_r($_REQUEST, true)); + Logger::info(API_LOG_PREFIX . 'username {username}', ['module' => 'api', 'action' => 'call', 'username' => $a->user['username']]); + Logger::debug(API_LOG_PREFIX . 'parameters', ['module' => 'api', 'action' => 'call', 'parameters' => $_REQUEST]); $stamp = microtime(true); $return = call_user_func($info['func'], $type); $duration = (float) (microtime(true) - $stamp); - logger("API call duration: " . round($duration, 2) . "\t" . $a->query_string, LOGGER_DEBUG); + + Logger::info(API_LOG_PREFIX . 'username {username}', ['module' => 'api', 'action' => 'call', 'username' => $a->user['username'], 'duration' => round($duration, 2)]); if (Config::get("system", "profiler")) { $duration = microtime(true)-$a->performance["start"]; /// @TODO round() really everywhere? - logger( - parse_url($a->query_string, PHP_URL_PATH) . ": " . sprintf( - "Database: %s/%s, Cache %s/%s, Network: %s, I/O: %s, Other: %s, Total: %s", - round($a->performance["database"] - $a->performance["database_write"], 3), - round($a->performance["database_write"], 3), - round($a->performance["cache"], 3), - round($a->performance["cache_write"], 3), - round($a->performance["network"], 2), - round($a->performance["file"], 2), - round($duration - ($a->performance["database"] - + $a->performance["cache"] + $a->performance["cache_write"] - + $a->performance["network"] + $a->performance["file"]), 2), - round($duration, 2) - ), - LOGGER_DEBUG + Logger::debug( + API_LOG_PREFIX . 'performance', + [ + 'module' => 'api', + 'action' => 'call', + 'database_read' => round($a->performance["database"] - $a->performance["database_write"], 3), + 'database_write' => round($a->performance["database_write"], 3), + 'cache_read' => round($a->performance["cache"], 3), + 'cache_write' => round($a->performance["cache_write"], 3), + 'network_io' => round($a->performance["network"], 2), + 'file_io' => round($a->performance["file"], 2), + 'other_io' => round($duration - ($a->performance["database"] + + $a->performance["cache"] + $a->performance["cache_write"] + + $a->performance["network"] + $a->performance["file"]), 2), + 'total' => round($duration, 2) + ] ); if (Config::get("rendertime", "callstack")) { @@ -375,7 +386,7 @@ function api_call(App $a) $o .= $func . ": " . $time . "\n"; } } - logger($o, LOGGER_DEBUG); + Logger::debug(API_LOG_PREFIX . $o, ['module' => 'api', 'action' => 'call']); } } @@ -394,7 +405,7 @@ function api_call(App $a) case "json": header("Content-Type: application/json"); $json = json_encode(end($return)); - if (x($_GET, 'callback')) { + if (!empty($_GET['callback'])) { $json = $_GET['callback'] . "(" . $json . ")"; } $return = $json; @@ -412,7 +423,7 @@ function api_call(App $a) } } - logger('API call not implemented: ' . $a->query_string); + Logger::warning(API_LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call']); throw new NotImplementedException(); } catch (HTTPException $e) { header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}"); @@ -429,7 +440,7 @@ function api_call(App $a) */ function api_error($type, $e) { - $a = get_app(); + $a = \get_app(); $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc); /// @TODO: https://dev.twitter.com/overview/api/response-codes @@ -462,11 +473,15 @@ function api_error($type, $e) /** * @brief Set values for RSS template * - * @param App $a + * @param App $a * @param array $arr Array to be passed to template * @param array $user_info User info * @return array - * @todo find proper type-hints + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException + * @todo find proper type-hints */ function api_rss_extra(App $a, $arr, $user_info) { @@ -494,7 +509,8 @@ function api_rss_extra(App $a, $arr, $user_info) * * @param int $id Contact id * @return bool|string - * Contact url or False if contact id is unknown + * Contact url or False if contact id is unknown + * @throws Exception */ function api_unique_id_to_nurl($id) { @@ -510,8 +526,13 @@ function api_unique_id_to_nurl($id) /** * @brief Get user info array. * - * @param object $a App + * @param App $a App * @param int|string $contact_id Contact ID or URL + * @return array|bool + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_get_user(App $a, $contact_id = null) { @@ -521,11 +542,11 @@ function api_get_user(App $a, $contact_id = null) $extra_query = ""; $url = ""; - logger("api_get_user: Fetching user data for user ".$contact_id, LOGGER_DEBUG); + Logger::info(API_LOG_PREFIX . 'Fetching data for user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $contact_id]); // Searching for contact URL if (!is_null($contact_id) && (intval($contact_id) == 0)) { - $user = DBA::escape(normalise_link($contact_id)); + $user = DBA::escape(Strings::normaliseLink($contact_id)); $url = $user; $extra_query = "AND `contact`.`nurl` = '%s' "; if (api_user() !== false) { @@ -548,7 +569,7 @@ function api_get_user(App $a, $contact_id = null) } } - if (is_null($user) && x($_GET, 'user_id')) { + if (is_null($user) && !empty($_GET['user_id'])) { $user = DBA::escape(api_unique_id_to_nurl($_GET['user_id'])); if ($user == "") { @@ -561,7 +582,7 @@ function api_get_user(App $a, $contact_id = null) $extra_query .= "AND `contact`.`uid`=" . intval(api_user()); } } - if (is_null($user) && x($_GET, 'screen_name')) { + if (is_null($user) && !empty($_GET['screen_name'])) { $user = DBA::escape($_GET['screen_name']); $extra_query = "AND `contact`.`nick` = '%s' "; if (api_user() !== false) { @@ -569,8 +590,8 @@ function api_get_user(App $a, $contact_id = null) } } - if (is_null($user) && x($_GET, 'profileurl')) { - $user = DBA::escape(normalise_link($_GET['profileurl'])); + if (is_null($user) && !empty($_GET['profileurl'])) { + $user = DBA::escape(Strings::normaliseLink($_GET['profileurl'])); $extra_query = "AND `contact`.`nurl` = '%s' "; if (api_user() !== false) { $extra_query .= "AND `contact`.`uid`=".intval(api_user()); @@ -605,7 +626,7 @@ function api_get_user(App $a, $contact_id = null) } } - logger("api_get_user: user ".$user, LOGGER_DEBUG); + Logger::info(API_LOG_PREFIX . 'getting user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user]); if (!$user) { if (api_user() === false) { @@ -617,7 +638,7 @@ function api_get_user(App $a, $contact_id = null) } } - logger('api_user: ' . $extra_query . ', user: ' . $user); + Logger::info(API_LOG_PREFIX . 'found user {user}', ['module' => 'api', 'action' => 'get_user', 'user' => $user, 'extra_query' => $extra_query]); // user info $uinfo = q( @@ -638,11 +659,9 @@ function api_get_user(App $a, $contact_id = null) throw new BadRequestException("User not found."); } - $contact = DBA::selectFirst('contact', [], ['uid' => 0, 'nurl' => normalise_link($url)]); + $contact = DBA::selectFirst('contact', [], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]); if (DBA::isResult($contact)) { - $network_name = ContactSelector::networkToName($contact['network'], $contact['url']); - // If no nick where given, extract it from the address if (($contact['nick'] == "") || ($contact['name'] == $contact['nick'])) { $contact['nick'] = api_get_nick($contact["url"]); @@ -653,7 +672,7 @@ function api_get_user(App $a, $contact_id = null) 'id_str' => (string) $contact["id"], 'name' => $contact["name"], 'screen_name' => (($contact['nick']) ? $contact['nick'] : $contact['name']), - 'location' => ($contact["location"] != "") ? $contact["location"] : $network_name, + 'location' => ($contact["location"] != "") ? $contact["location"] : ContactSelector::networkToName($contact['network'], $contact['url']), 'description' => $contact["about"], 'profile_image_url' => $contact["micro"], 'profile_image_url_https' => $contact["micro"], @@ -711,8 +730,6 @@ function api_get_user(App $a, $contact_id = null) $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]); } - $network_name = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']); - $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true); if (!empty($profile['about'])) { @@ -726,7 +743,7 @@ function api_get_user(App $a, $contact_id = null) } elseif (!empty($uinfo[0]["location"])) { $location = $uinfo[0]["location"]; } else { - $location = $network_name; + $location = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']); } $ret = [ @@ -808,9 +825,13 @@ function api_get_user(App $a, $contact_id = null) /** * @brief return api-formatted array for item's author and owner * - * @param object $a App - * @param array $item item from db + * @param App $a App + * @param array $item item from db * @return array(array:author, array:owner) + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_item_get_user(App $a, $item) { @@ -830,8 +851,8 @@ function api_item_get_user(App $a, $item) /** * @brief walks recursively through an array with the possibility to change value and key * - * @param array $array The array to walk through - * @param string $callback The callback function + * @param array $array The array to walk through + * @param callable $callback The callback function * * @return array the transformed array */ @@ -933,7 +954,7 @@ function api_create_xml(array $data, $root_element) * @param string $type Return type (atom, rss, xml, json) * @param array $data JSON style array * - * @return (string|array) XML data or JSON data + * @return array|string (string|array) XML data or JSON data */ function api_format_data($root_element, $type, $data) { @@ -948,7 +969,6 @@ function api_format_data($root_element, $type, $data) $ret = $data; break; } - return $ret; } @@ -959,14 +979,21 @@ function api_format_data($root_element, $type, $data) /** * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; * returns a 401 status code and an error message if not. + * * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials * * @param string $type Return type (atom, rss, xml, json) + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_account_verify_credentials($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -978,7 +1005,7 @@ function api_account_verify_credentials($type) unset($_REQUEST["screen_name"]); unset($_GET["screen_name"]); - $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false); + $skip_status = defaults($_REQUEST, 'skip_status', false); $user_info = api_get_user($a); @@ -1009,13 +1036,14 @@ api_register_func('api/account/verify_credentials', 'api_account_verify_credenti * Get data from $_POST or $_GET * * @param string $k + * @return null */ function requestdata($k) { - if (x($_POST, $k)) { + if (!empty($_POST[$k])) { return $_POST[$k]; } - if (x($_GET, $k)) { + if (!empty($_GET[$k])) { return $_GET[$k]; } return null; @@ -1027,13 +1055,18 @@ function requestdata($k) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_statuses_mediap($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { - logger('api_statuses_update: no user'); + Logger::log('api_statuses_update: no user'); throw new ForbiddenException(); } $user_info = api_get_user($a); @@ -1045,7 +1078,7 @@ function api_statuses_mediap($type) //$txt = urldecode(requestdata('status')); if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) { - $txt = html2bb_video($txt); + $txt = HTML::toBBCodeVideo($txt); $config = HTMLPurifier_Config::createDefault(); $config->set('Cache.DefinitionImpl', null); $purifier = new HTMLPurifier($config); @@ -1074,14 +1107,20 @@ api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws TooManyRequestsException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update */ function api_statuses_update($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { - logger('api_statuses_update: no user'); + Logger::log('api_statuses_update: no user'); throw new ForbiddenException(); } @@ -1091,7 +1130,7 @@ function api_statuses_update($type) if (requestdata('htmlstatus')) { $txt = requestdata('htmlstatus'); if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) { - $txt = html2bb_video($txt); + $txt = HTML::toBBCodeVideo($txt); $config = HTMLPurifier_Config::createDefault(); $config->set('Cache.DefinitionImpl', null); @@ -1135,7 +1174,7 @@ function api_statuses_update($type) $posts_day = DBA::count('thread', $condition); if ($posts_day > $throttle_day) { - logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG); + Logger::log('Daily posting limit reached for user '.api_user(), Logger::DEBUG); // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day)); 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)); } @@ -1149,7 +1188,7 @@ function api_statuses_update($type) $posts_week = DBA::count('thread', $condition); if ($posts_week > $throttle_week) { - logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG); + Logger::log('Weekly posting limit reached for user '.api_user(), Logger::DEBUG); // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week))); 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)); } @@ -1163,14 +1202,14 @@ function api_statuses_update($type) $posts_month = DBA::count('thread', $condition); if ($posts_month > $throttle_month) { - logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG); + Logger::log('Monthly posting limit reached for user '.api_user(), Logger::DEBUG); // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month)); 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)); } } } - if (x($_FILES, 'media')) { + if (!empty($_FILES['media'])) { // upload the image if we have one $picture = wall_upload_post($a, false); if (is_array($picture)) { @@ -1197,7 +1236,7 @@ function api_statuses_update($type) $_REQUEST['api_source'] = true; - if (!x($_REQUEST, "source")) { + if (empty($_REQUEST['source'])) { $_REQUEST["source"] = api_source(); } @@ -1216,20 +1255,25 @@ api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, * Uploads an image to Friendica. * * @return array + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload */ function api_media_upload() { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { - logger('no user'); + Logger::log('no user'); throw new ForbiddenException(); } api_get_user($a); - if (!x($_FILES, 'media')) { + if (empty($_FILES['media'])) { // Output error throw new BadRequestException("No media."); } @@ -1245,10 +1289,11 @@ function api_media_upload() $returndata["media_id_string"] = (string)$media["id"]; $returndata["size"] = $media["size"]; $returndata["image"] = ["w" => $media["width"], - "h" => $media["height"], - "image_type" => $media["type"]]; + "h" => $media["height"], + "image_type" => $media["type"], + "friendica_preview_url" => $media["preview"]]; - logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG); + Logger::log("Media uploaded: " . print_r($returndata, true), Logger::DEBUG); return ["media" => $returndata]; } @@ -1260,21 +1305,20 @@ api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST) * * @param string $type Return type (atom, rss, xml, json) * + * @param int $item_id * @return array|string + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_status_show($type, $item_id = 0) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); - logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG); - - if ($type == "raw") { - $privacy_sql = "AND NOT `private`"; - } else { - $privacy_sql = ""; - } + Logger::log('api_status_show: user_info: '.print_r($user_info, true), Logger::DEBUG); if (!empty($item_id)) { // Get the item with the given id @@ -1284,6 +1328,11 @@ function api_status_show($type, $item_id = 0) $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(), 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]]; } + + if ($type == "raw") { + $condition['private'] = false; + } + $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]); if (DBA::isResult($lastwall)) { @@ -1344,7 +1393,7 @@ function api_status_show($type, $item_id = 0) unset($status_info["user"]["uid"]); unset($status_info["user"]["self"]); - logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG); + Logger::log('status_info: '.print_r($status_info, true), Logger::DEBUG); if ($type == "raw") { return $status_info; @@ -1359,11 +1408,16 @@ function api_status_show($type, $item_id = 0) * The author's most recent status will be returned inline. * * @param string $type Return type (atom, rss, xml, json) + * @return array|string + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show */ function api_users_show($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); @@ -1435,15 +1489,19 @@ api_register_func('api/externalprofile/show', 'api_users_show'); * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search */ function api_users_search($type) { - $a = get_app(); + $a = \get_app(); $userlist = []; - if (x($_GET, 'q')) { + if (!empty($_GET['q'])) { $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", DBA::escape($_GET["q"])); if (!DBA::isResult($r)) { @@ -1483,7 +1541,11 @@ api_register_func('api/users/search', 'api_users_search'); * @param string $type Return format: json or xml * * @return array|string + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException * @throws NotFoundException if the results are empty. + * @throws UnauthorizedException */ function api_users_lookup($type) { @@ -1516,52 +1578,83 @@ api_register_func('api/users/lookup', 'api_users_lookup', true); * * @return array|string * @throws BadRequestException if the "q" parameter is missing. + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_search($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); - if (api_user() === false || $user_info === false) { - throw new ForbiddenException(); - } - - $data = []; + if (api_user() === false || $user_info === false) { throw new ForbiddenException(); } - if (!x($_REQUEST, 'q')) { - throw new BadRequestException("q parameter is required."); - } + if (empty($_REQUEST['q'])) { throw new BadRequestException('q parameter is required.'); } + + $searchTerm = trim(rawurldecode($_REQUEST['q'])); - if (x($_REQUEST, 'rpp')) { + $data = []; + $data['status'] = []; + $count = 15; + $exclude_replies = !empty($_REQUEST['exclude_replies']); + if (!empty($_REQUEST['rpp'])) { $count = $_REQUEST['rpp']; - } elseif (x($_REQUEST, 'count')) { + } elseif (!empty($_REQUEST['count'])) { $count = $_REQUEST['count']; - } else { - $count = 15; } - - $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0); - $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0); - $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0); - + + $since_id = defaults($_REQUEST, 'since_id', 0); + $max_id = defaults($_REQUEST, 'max_id', 0); + $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] - 1 : 0); $start = $page * $count; + $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; + if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) { + $searchTerm = $matches[1]; + $condition = ["`oid` > ? + AND (`uid` = 0 OR (`uid` = ? AND NOT `global`)) + AND `otype` = ? AND `type` = ? AND `term` = ?", + $since_id, local_user(), TERM_OBJ_POST, TERM_HASHTAG, $searchTerm]; + if ($max_id > 0) { + $condition[0] .= ' AND `oid` <= ?'; + $condition[] = $max_id; + } + $terms = DBA::select('term', ['oid'], $condition, []); + $itemIds = []; + while ($term = DBA::fetch($terms)) { + $itemIds[] = $term['oid']; + } + DBA::close($terms); - $condition = ["`gravity` IN (?, ?) AND `item`.`id` > ? - AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`)) - AND `item`.`body` LIKE CONCAT('%',?,'%')", - GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, api_user(), $_REQUEST['q']]; + if (empty($itemIds)) { + return api_format_data('statuses', $type, $data); + } - if ($max_id > 0) { - $condition[0] .= " AND `item`.`id` <= ?"; - $condition[] = $max_id; + $preCondition = ['`id` IN (' . implode(', ', $itemIds) . ')']; + if ($exclude_replies) { + $preCondition[] = '`id` = `parent`'; + } + + $condition = [implode(' AND ', $preCondition)]; + } else { + $condition = ["`id` > ? + " . ($exclude_replies ? " AND `id` = `parent` " : ' ') . " + AND (`uid` = 0 OR (`uid` = ? AND NOT `global`)) + AND `body` LIKE CONCAT('%',?,'%')", + $since_id, api_user(), $_REQUEST['q']]; + if ($max_id > 0) { + $condition[0] .= ' AND `id` <= ?'; + $condition[] = $max_id; + } } - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; $statuses = Item::selectForUser(api_user(), [], $condition, $params); $data['status'] = api_format_items(Item::inArray($statuses), $user_info); - return api_format_data("statuses", $type, $data); + bindComments($data['status']); + + return api_format_data('statuses', $type, $data); } /// @TODO move to top of file or somewhere better @@ -1571,16 +1664,22 @@ api_register_func('api/search', 'api_search', true); /** * Returns the most recent statuses posted by the user and the users they follow. * - * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline + * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @todo Optional parameters * @todo Add reply info */ function api_statuses_home_timeline($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -1596,16 +1695,15 @@ function api_statuses_home_timeline($type) // get last network messages // params - $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20); - $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0); + $count = defaults($_REQUEST, 'count', 20); + $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] - 1 : 0); if ($page < 0) { $page = 0; } - $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0); - $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0); - //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0); - $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0); - $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0); + $since_id = defaults($_REQUEST, 'since_id', 0); + $max_id = defaults($_REQUEST, 'max_id', 0); + $exclude_replies = !empty($_REQUEST['exclude_replies']); + $conversation_id = defaults($_REQUEST, 'conversation_id', 0); $start = $page * $count; @@ -1616,7 +1714,7 @@ function api_statuses_home_timeline($type) $condition[0] .= " AND `item`.`id` <= ?"; $condition[] = $max_id; } - if ($exclude_replies > 0) { + if ($exclude_replies) { $condition[0] .= ' AND `item`.`parent` = `item`.`id`'; } if ($conversation_id > 0) { @@ -1643,10 +1741,13 @@ function api_statuses_home_timeline($type) Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]); } } + + bindComments($ret); $data = ['status' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); break; @@ -1655,6 +1756,7 @@ function api_statuses_home_timeline($type) return api_format_data("statuses", $type, $data); } + /// @TODO move to top of file or somewhere better api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true); api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true); @@ -1665,10 +1767,15 @@ api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_statuses_public_timeline($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -1678,19 +1785,17 @@ function api_statuses_public_timeline($type) // get last network messages // params - $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20); - $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0); + $count = defaults($_REQUEST, 'count', 20); + $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] -1 : 0); if ($page < 0) { $page = 0; } - $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0); - $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0); - //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0); - $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0); - $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0); + $since_id = defaults($_REQUEST, 'since_id', 0); + $max_id = defaults($_REQUEST, 'max_id', 0); + $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0); + $conversation_id = defaults($_REQUEST, 'conversation_id', 0); $start = $page * $count; - $sql_extra = ''; if ($exclude_replies && !$conversation_id) { $condition = ["`gravity` IN (?, ?) AND `iid` > ? AND NOT `private` AND `wall` AND NOT `user`.`hidewall`", @@ -1726,9 +1831,12 @@ function api_statuses_public_timeline($type) $ret = api_format_items($r, $user_info, false, $type); + bindComments($ret); + $data = ['status' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); break; @@ -1747,23 +1855,27 @@ api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline' * * @param string $type Return format: json, xml, atom, rss * @return array|string + * @throws BadRequestException * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_statuses_networkpublic_timeline($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { throw new ForbiddenException(); } - $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0; - $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0; + $since_id = defaults($_REQUEST, 'since_id', 0); + $max_id = defaults($_REQUEST, 'max_id', 0); // pagination - $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20; - $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1; + $count = defaults($_REQUEST, 'count', 20); + $page = defaults($_REQUEST, 'page', 1); if ($page < 1) { $page = 1; } @@ -1782,9 +1894,12 @@ function api_statuses_networkpublic_timeline($type) $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type); + bindComments($ret); + $data = ['status' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); break; @@ -1801,11 +1916,17 @@ api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpu * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id */ function api_statuses_show($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -1824,7 +1945,7 @@ function api_statuses_show($type) $id = intval(defaults($a->argv, 4, 0)); } - logger('API: api_statuses_show: ' . $id); + Logger::log('API: api_statuses_show: ' . $id); $conversation = !empty($_REQUEST['conversation']); @@ -1874,11 +1995,17 @@ api_register_func('api/statuses/show', 'api_statuses_show', true); * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @todo nothing to say? */ function api_conversation_show($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -1906,7 +2033,7 @@ function api_conversation_show($type) $id = intval(defaults($a->argv, 4, 0)); } - logger('API: api_conversation_show: '.$id); + Logger::info(API_LOG_PREFIX . '{subaction}', ['module' => 'api', 'action' => 'conversation', 'subaction' => 'show', 'id' => $id]); // try to fetch the item for the local user - or the public item, if there is no local one $item = Item::selectFirst(['parent-uri'], ['id' => $id]); @@ -1951,13 +2078,19 @@ api_register_func('api/statusnet/conversation', 'api_conversation_show', true); * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id */ function api_statuses_repeat($type) { global $called_api; - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -1977,7 +2110,7 @@ function api_statuses_repeat($type) $id = intval(defaults($a->argv, 4, 0)); } - logger('API: api_statuses_repeat: '.$id); + Logger::log('API: api_statuses_repeat: '.$id); $fields = ['body', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink']; $item = Item::selectFirst($fields, ['id' => $id, 'private' => false]); @@ -1996,7 +2129,7 @@ function api_statuses_repeat($type) $_REQUEST['profile_uid'] = api_user(); $_REQUEST['api_source'] = true; - if (!x($_REQUEST, "source")) { + if (empty($_REQUEST['source'])) { $_REQUEST["source"] = api_source(); } @@ -2018,11 +2151,17 @@ api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHO * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id */ function api_statuses_destroy($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -2042,7 +2181,7 @@ function api_statuses_destroy($type) $id = intval(defaults($a->argv, 4, 0)); } - logger('API: api_statuses_destroy: '.$id); + Logger::log('API: api_statuses_destroy: '.$id); $ret = api_statuses_show($type); @@ -2059,11 +2198,17 @@ api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METH * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see http://developer.twitter.com/doc/get/statuses/mentions */ function api_statuses_mentions($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -2106,6 +2251,7 @@ function api_statuses_mentions($type) $data = ['status' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); break; @@ -2125,33 +2271,37 @@ api_register_func('api/statuses/replies', 'api_statuses_mentions', true); * * @param string $type Either "json" or "xml" * @return string|array + * @throws BadRequestException * @throws ForbiddenException - * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException + * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline */ function api_statuses_user_timeline($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { throw new ForbiddenException(); } - logger( + Logger::log( "api_statuses_user_timeline: api_user: ". api_user() . "\nuser_info: ".print_r($user_info, true) . "\n_REQUEST: ".print_r($_REQUEST, true), - LOGGER_DEBUG + Logger::DEBUG ); - $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0; - $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0; - $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0; - $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0; + $since_id = defaults($_REQUEST, 'since_id', 0); + $max_id = defaults($_REQUEST, 'max_id', 0); + $exclude_replies = !empty($_REQUEST['exclude_replies']); + $conversation_id = defaults($_REQUEST, 'conversation_id', 0); // pagination - $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20; - $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1; + $count = defaults($_REQUEST, 'count', 20); + $page = defaults($_REQUEST, 'page', 1); if ($page < 1) { $page = 1; } @@ -2164,7 +2314,7 @@ function api_statuses_user_timeline($type) $condition[0] .= ' AND `item`.`wall` '; } - if ($exclude_replies > 0) { + if ($exclude_replies) { $condition[0] .= ' AND `item`.`parent` = `item`.`id`'; } @@ -2183,9 +2333,12 @@ function api_statuses_user_timeline($type) $ret = api_format_items(Item::inArray($statuses), $user_info, true, $type); + bindComments($ret); + $data = ['status' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); break; @@ -2203,11 +2356,17 @@ api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', tr * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid */ function api_favorites_create_destroy($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -2261,8 +2420,10 @@ function api_favorites_create_destroy($type) $data = ['status' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); + break; } return api_format_data("status", $type, $data); @@ -2278,12 +2439,17 @@ api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, * @param string $type Return type (atom, rss, xml, json) * * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_favorites($type) { global $called_api; - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -2294,16 +2460,16 @@ function api_favorites($type) // in friendica starred item are private // return favorites only for self - logger('api_favorites: self:' . $user_info['self']); + Logger::info(API_LOG_PREFIX . 'for {self}', ['module' => 'api', 'action' => 'favorites', 'self' => $user_info['self']]); if ($user_info['self'] == 0) { $ret = []; } else { // params - $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0); - $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0); - $count = (x($_GET, 'count') ? $_GET['count'] : 20); - $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0); + $since_id = defaults($_REQUEST, 'since_id', 0); + $max_id = defaults($_REQUEST, 'max_id', 0); + $count = defaults($_GET, 'count', 20); + $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] -1 : 0); if ($page < 0) { $page = 0; } @@ -2325,11 +2491,15 @@ function api_favorites($type) $ret = api_format_items(Item::inArray($statuses), $user_info, false, $type); } + bindComments($ret); + $data = ['status' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); + break; } return api_format_data("statuses", $type, $data); @@ -2345,6 +2515,7 @@ api_register_func('api/favorites', 'api_favorites', true); * @param array $sender * * @return array + * @throws InternalServerErrorException */ function api_format_messages($item, $recipient, $sender) { @@ -2379,7 +2550,7 @@ function api_format_messages($item, $recipient, $sender) } //don't send title to regular StatusNET requests to avoid confusing these apps - if (x($_GET, 'getText')) { + if (!empty($_GET['getText'])) { $ret['title'] = $item['title']; if ($_GET['getText'] == 'html') { $ret['text'] = BBCode::convert($item['body'], false); @@ -2389,7 +2560,7 @@ function api_format_messages($item, $recipient, $sender) } else { $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0); } - if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') { + if (!empty($_GET['getUserObjects']) && $_GET['getUserObjects'] == 'false') { unset($ret['sender']); unset($ret['recipient']); } @@ -2402,6 +2573,7 @@ function api_format_messages($item, $recipient, $sender) * @param array $item * * @return array + * @throws InternalServerErrorException */ function api_convert_item($item) { @@ -2477,6 +2649,7 @@ function api_convert_item($item) * @param string $body * * @return array + * @throws InternalServerErrorException */ function api_get_attachments(&$body) { @@ -2515,11 +2688,12 @@ function api_get_attachments(&$body) * @param string $bbcode * * @return array + * @throws InternalServerErrorException * @todo Links at the first character of the post */ function api_get_entitities(&$text, $bbcode) { - $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false"); + $include_entities = strtolower(defaults($_REQUEST, 'include_entities', "false")); if ($include_entities != "true") { preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images); @@ -2659,9 +2833,9 @@ function api_get_entitities(&$text, $bbcode) $entities["media"][] = [ "id" => $start+1, - "id_str" => (string)$start+1, + "id_str" => (string) ($start + 1), "indices" => [$start, $start+strlen($url)], - "media_url" => normalise_link($media_url), + "media_url" => Strings::normaliseLink($media_url), "media_url_https" => $media_url, "url" => $url, "display_url" => $display_url, @@ -2725,16 +2899,20 @@ function api_contactlink_to_array($txt) /** * @brief return likes, dislikes and attend status for item * - * @param array $item array + * @param array $item array * @param string $type Return type (atom, rss, xml, json) * * @return array - * likes => int count, - * dislikes => int count + * likes => int count, + * dislikes => int count + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_format_items_activities($item, $type = "json") { - $a = get_app(); + $a = \get_app(); $activities = [ 'like' => [], @@ -2797,8 +2975,9 @@ function api_format_items_activities($item, $type = "json") /** * @brief return data from profiles * - * @param array $profile_row array containing data from db table 'profile' + * @param array $profile_row array containing data from db table 'profile' * @return array + * @throws InternalServerErrorException */ function api_format_items_profiles($profile_row) { @@ -2849,18 +3028,23 @@ function api_format_items_profiles($profile_row) /** * @brief format items to be returned by api * - * @param array $r array of items + * @param array $r array of items * @param array $user_info * @param bool $filter_user filter items by $user_info - * @param string $type Return type (atom, rss, xml, json) + * @param string $type Return type (atom, rss, xml, json) + * @return array + * @throws BadRequestException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_format_items($r, $user_info, $filter_user = false, $type = "json") { - $a = get_app(); + $a = \get_app(); $ret = []; - foreach ($r as $item) { + foreach ((array)$r as $item) { localize_item($item); list($status_user, $owner_user) = api_item_get_user($a, $item); @@ -2921,6 +3105,7 @@ function api_format_items($r, $user_info, $filter_user = false, $type = "json") $retweeted_item = api_share_as_retweet($item); if ($retweeted_item !== false) { $retweeted_status = $status; + $status['user'] = $status['friendica_owner']; try { $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]); } catch (BadRequestException $e) { @@ -2966,6 +3151,7 @@ function api_format_items($r, $user_info, $filter_user = false, $type = "json") * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws Exception */ function api_account_rate_limit_status($type) { @@ -3041,11 +3227,16 @@ api_register_func('api/lists/subscriptions', 'api_lists_list', true); * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships */ function api_lists_ownerships($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -3085,11 +3276,16 @@ api_register_func('api/lists/ownerships', 'api_lists_ownerships', true); * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships */ function api_lists_statuses($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -3107,15 +3303,15 @@ function api_lists_statuses($type) } // params - $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20); - $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0); + $count = defaults($_REQUEST, 'count', 20); + $page = (!empty($_REQUEST['page']) ? $_REQUEST['page'] - 1 : 0); if ($page < 0) { $page = 0; } - $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0); - $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0); - $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0); - $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0); + $since_id = defaults($_REQUEST, 'since_id', 0); + $max_id = defaults($_REQUEST, 'max_id', 0); + $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0); + $conversation_id = defaults($_REQUEST, 'conversation_id', 0); $start = $page * $count; @@ -3142,6 +3338,7 @@ function api_lists_statuses($type) $data = ['status' => $items]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); break; @@ -3161,19 +3358,23 @@ api_register_func('api/lists/statuses', 'api_lists_statuses', true); * * @param string $qtype Either "friends" or "followers" * @return boolean|array + * @throws BadRequestException * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_statuses_f($qtype) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); } // pagination - $count = x($_GET, 'count') ? $_GET['count'] : 20; - $page = x($_GET, 'page') ? $_GET['page'] : 1; + $count = defaults($_GET, 'count', 20); + $page = defaults($_GET, 'page', 1); if ($page < 1) { $page = 1; } @@ -3181,7 +3382,7 @@ function api_statuses_f($qtype) $user_info = api_get_user($a); - if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') { + if (!empty($_GET['cursor']) && $_GET['cursor'] == 'undefined') { /* this is to stop Hotot to load friends multiple times * I'm not sure if I'm missing return something or * is a bug in hotot. Workaround, meantime @@ -3245,12 +3446,14 @@ function api_statuses_f($qtype) /** * Returns the user's friends. * - * @brief Returns the list of friends of the provided user + * @brief Returns the list of friends of the provided user * * @deprecated By Twitter API in favor of friends/list * * @param string $type Either "json" or "xml" * @return boolean|string|array + * @throws BadRequestException + * @throws ForbiddenException */ function api_statuses_friends($type) { @@ -3264,12 +3467,14 @@ function api_statuses_friends($type) /** * Returns the user's followers. * - * @brief Returns the list of followers of the provided user + * @brief Returns the list of followers of the provided user * * @deprecated By Twitter API in favor of friends/list * * @param string $type Either "json" or "xml" * @return boolean|string|array + * @throws BadRequestException + * @throws ForbiddenException */ function api_statuses_followers($type) { @@ -3292,6 +3497,8 @@ api_register_func('api/statuses/followers', 'api_statuses_followers', true); * @param string $type Either "json" or "xml" * * @return boolean|string|array + * @throws BadRequestException + * @throws ForbiddenException */ function api_blocks_list($type) { @@ -3313,6 +3520,8 @@ api_register_func('api/blocks/list', 'api_blocks_list', true); * @param string $type Either "json" or "xml" * * @return boolean|string|array + * @throws BadRequestException + * @throws ForbiddenException */ function api_friendships_incoming($type) { @@ -3338,16 +3547,17 @@ api_register_func('api/friendships/incoming', 'api_friendships_incoming', true); * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws InternalServerErrorException */ function api_statusnet_config($type) { - $a = get_app(); + $a = \get_app(); $name = Config::get('config', 'sitename'); $server = $a->getHostName(); $logo = System::baseUrl() . '/images/friendica-64.png'; $email = Config::get('config', 'admin_email'); - $closed = intval(Config::get('config', 'register_policy')) === REGISTER_CLOSED ? 'true' : 'false'; + $closed = intval(Config::get('config', 'register_policy')) === \Friendica\Module\Register::CLOSED ? 'true' : 'false'; $private = Config::get('system', 'block_public') ? 'true' : 'false'; $textlimit = (string) Config::get('config', 'api_import_size', Config::get('config', 'max_import_size', 200000)); $ssl = Config::get('system', 'have_ssl') ? 'true' : 'false'; @@ -3397,6 +3607,12 @@ api_register_func('api/statusnet/version', 'api_statusnet_version', false); * * @param string $type Return type (atom, rss, xml, json) * + * @return array|string|void + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @todo use api_format_data() to return data */ function api_ff_ids($type) @@ -3405,7 +3621,7 @@ function api_ff_ids($type) throw new ForbiddenException(); } - $a = get_app(); + $a = \get_app(); api_get_user($a); @@ -3439,6 +3655,8 @@ function api_ff_ids($type) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids */ function api_friends_ids($type) @@ -3452,6 +3670,8 @@ function api_friends_ids($type) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids */ function api_followers_ids($type) @@ -3469,11 +3689,17 @@ api_register_func('api/followers/ids', 'api_followers_ids', true); * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws NotFoundException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message */ function api_direct_messages_new($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -3508,8 +3734,7 @@ function api_direct_messages_new($type) } $replyto = ''; - $sub = ''; - if (x($_REQUEST, 'replyto')) { + if (!empty($_REQUEST['replyto'])) { $r = q( 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d', intval(api_user()), @@ -3518,7 +3743,7 @@ function api_direct_messages_new($type) $replyto = $r[0]['parent-uri']; $sub = $r[0]['title']; } else { - if (x($_REQUEST, 'title')) { + if (!empty($_REQUEST['title'])) { $sub = $_REQUEST['title']; } else { $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']); @@ -3538,8 +3763,10 @@ function api_direct_messages_new($type) switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $sender); + break; } return api_format_data("direct-messages", $type, $data); @@ -3555,11 +3782,16 @@ api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, AP * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array - * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException + * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message */ function api_direct_messages_destroy($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -3568,10 +3800,10 @@ function api_direct_messages_destroy($type) // params $user_info = api_get_user($a); //required - $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0); + $id = defaults($_REQUEST, 'id', 0); // optional - $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : ""); - $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false"); + $parenturi = defaults($_REQUEST, 'friendica_parenturi', ""); + $verbose = (!empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"); /// @todo optional parameter 'include_entities' from Twitter API not yet implemented $uid = $user_info['uid']; @@ -3632,11 +3864,16 @@ api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', /** * Unfollow Contact * - * @brief unfollow contact + * @brief unfollow contact * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array - * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws NotFoundException + * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.html */ function api_friendships_destroy($type) { @@ -3649,7 +3886,7 @@ function api_friendships_destroy($type) $contact_id = defaults($_REQUEST, 'user_id'); if (empty($contact_id)) { - logger("No user_id specified", LOGGER_DEBUG); + Logger::notice(API_LOG_PREFIX . 'No user_id specified', ['module' => 'api', 'action' => 'friendships_destroy']); throw new BadRequestException("no user_id specified"); } @@ -3657,24 +3894,24 @@ function api_friendships_destroy($type) $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]); if(!DBA::isResult($contact)) { - logger("No contact found for ID" . $contact_id, LOGGER_DEBUG); + Logger::notice(API_LOG_PREFIX . 'No contact found for ID {contact}', ['module' => 'api', 'action' => 'friendships_destroy', 'contact' => $contact_id]); throw new NotFoundException("no contact found to given ID"); } $url = $contact["url"]; $condition = ["`uid` = ? AND (`rel` = ? OR `rel` = ?) AND (`nurl` = ? OR `alias` = ? OR `alias` = ?)", - $uid, Contact::SHARING, Contact::FRIEND, normalise_link($url), - normalise_link($url), $url]; + $uid, Contact::SHARING, Contact::FRIEND, Strings::normaliseLink($url), + Strings::normaliseLink($url), $url]; $contact = DBA::selectFirst('contact', [], $condition); if (!DBA::isResult($contact)) { - logger("Not following Contact", LOGGER_DEBUG); + Logger::notice(API_LOG_PREFIX . 'Not following contact', ['module' => 'api', 'action' => 'friendships_destroy']); throw new NotFoundException("Not following Contact"); } if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT)) { - logger("Not supported", LOGGER_DEBUG); + Logger::notice(API_LOG_PREFIX . 'Not supported for {network}', ['module' => 'api', 'action' => 'friendships_destroy', 'network' => $contact['network']]); throw new ExpectationFailedException("Not supported"); } @@ -3685,7 +3922,7 @@ function api_friendships_destroy($type) Contact::terminateFriendship($owner, $contact, $dissolve); } else { - logger("No owner found", LOGGER_DEBUG); + Logger::notice(API_LOG_PREFIX . 'No owner {uid} found', ['module' => 'api', 'action' => 'friendships_destroy', 'uid' => $uid]); throw new NotFoundException("Error Processing Request"); } @@ -3714,10 +3951,15 @@ api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, AP * @param string $verbose * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_direct_messages_box($type, $box, $verbose) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); } @@ -3789,9 +4031,9 @@ function api_direct_messages_box($type, $box, $verbose) foreach ($r as $item) { if ($box == "inbox" || $item['from-url'] != $profile_url) { $recipient = $user_info; - $sender = api_get_user($a, normalise_link($item['contact-url'])); + $sender = api_get_user($a, Strings::normaliseLink($item['contact-url'])); } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) { - $recipient = api_get_user($a, normalise_link($item['contact-url'])); + $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url'])); $sender = $user_info; } @@ -3804,8 +4046,10 @@ function api_direct_messages_box($type, $box, $verbose) $data = ['direct_message' => $ret]; switch ($type) { case "atom": + break; case "rss": $data = api_rss_extra($a, $data, $user_info); + break; } return api_format_data("direct-messages", $type, $data); @@ -3817,11 +4061,13 @@ function api_direct_messages_box($type, $box, $verbose) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message */ function api_direct_messages_sentbox($type) { - $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false"); + $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "sentbox", $verbose); } @@ -3831,11 +4077,13 @@ function api_direct_messages_sentbox($type) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages */ function api_direct_messages_inbox($type) { - $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false"); + $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "inbox", $verbose); } @@ -3844,10 +4092,12 @@ function api_direct_messages_inbox($type) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException */ function api_direct_messages_all($type) { - $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false"); + $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "all", $verbose); } @@ -3856,10 +4106,12 @@ function api_direct_messages_all($type) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException */ function api_direct_messages_conversation($type) { - $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false"); + $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "conversation", $verbose); } @@ -3881,10 +4133,10 @@ function api_oauth_request_token() $r = $oauth1->fetch_request_token(OAuthRequest::from_request()); } catch (Exception $e) { echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage()); - killme(); + exit(); } echo $r; - killme(); + exit(); } /** @@ -3900,10 +4152,10 @@ function api_oauth_access_token() $r = $oauth1->fetch_access_token(OAuthRequest::from_request()); } catch (Exception $e) { echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage()); - killme(); + exit(); } echo $r; - killme(); + exit(); } /// @TODO move to top of file or somewhere better @@ -3916,6 +4168,9 @@ api_register_func('api/oauth/access_token', 'api_oauth_access_token', false); * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws InternalServerErrorException */ function api_fr_photoalbum_delete($type) { @@ -3923,7 +4178,7 @@ function api_fr_photoalbum_delete($type) throw new ForbiddenException(); } // input params - $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : ""); + $album = defaults($_REQUEST, 'album', ""); // we do not allow calls without album string if ($album == "") { @@ -3952,7 +4207,7 @@ function api_fr_photoalbum_delete($type) } // now let's delete all photos from the album - $result = DBA::delete('photo', ['uid' => api_user(), 'album' => $album]); + $result = Photo::delete(['uid' => api_user(), 'album' => $album]); // return success of deletion or error message if ($result) { @@ -3968,6 +4223,9 @@ function api_fr_photoalbum_delete($type) * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws InternalServerErrorException */ function api_fr_photoalbum_update($type) { @@ -3975,8 +4233,8 @@ function api_fr_photoalbum_update($type) throw new ForbiddenException(); } // input params - $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : ""); - $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : ""); + $album = defaults($_REQUEST, 'album', ""); + $album_new = defaults($_REQUEST, 'album_new', ""); // we do not allow calls without album string if ($album == "") { @@ -3986,11 +4244,11 @@ function api_fr_photoalbum_update($type) throw new BadRequestException("no new albumname specified"); } // check if album is existing - if (!DBA::exists('photo', ['uid' => api_user(), 'album' => $album])) { + if (!Photo::exists(['uid' => api_user(), 'album' => $album])) { throw new BadRequestException("album not available"); } // now let's update all photos to the albumname - $result = DBA::update('photo', ['album' => $album_new], ['uid' => api_user(), 'album' => $album]); + $result = Photo::update(['album' => $album_new], ['uid' => api_user(), 'album' => $album]); // return success of updating or error message if ($result) { @@ -4007,6 +4265,8 @@ function api_fr_photoalbum_update($type) * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws ForbiddenException + * @throws InternalServerErrorException */ function api_fr_photos_list($type) { @@ -4053,6 +4313,11 @@ function api_fr_photos_list($type) * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws NotFoundException */ function api_fr_photo_create_update($type) { @@ -4060,15 +4325,15 @@ function api_fr_photo_create_update($type) throw new ForbiddenException(); } // input params - $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null); - $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string' - $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null); - $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null); - $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null)); - $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null)); - $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null)); - $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null)); - $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false); + $photo_id = defaults($_REQUEST, 'photo_id', null); + $desc = defaults($_REQUEST, 'desc', (array_key_exists('desc', $_REQUEST) ? "" : null)) ; // extra check necessary to distinguish between 'not provided' and 'empty string' + $album = defaults($_REQUEST, 'album', null); + $album_new = defaults($_REQUEST, 'album_new', null); + $allow_cid = defaults($_REQUEST, 'allow_cid', (array_key_exists('allow_cid', $_REQUEST) ? " " : null)); + $deny_cid = defaults($_REQUEST, 'deny_cid' , (array_key_exists('deny_cid' , $_REQUEST) ? " " : null)); + $allow_gid = defaults($_REQUEST, 'allow_gid', (array_key_exists('allow_gid', $_REQUEST) ? " " : null)); + $deny_gid = defaults($_REQUEST, 'deny_gid' , (array_key_exists('deny_gid' , $_REQUEST) ? " " : null)); + $visibility = !empty($_REQUEST['visibility']) && $_REQUEST['visibility'] !== "false"; // do several checks on input parameters // we do not allow calls without album string @@ -4080,7 +4345,7 @@ function api_fr_photo_create_update($type) $mode = "create"; // error if no media posted in create-mode - if (!x($_FILES, 'media')) { + if (empty($_FILES['media'])) { // Output error throw new BadRequestException("no media data submitted"); } @@ -4090,14 +4355,8 @@ function api_fr_photo_create_update($type) } else { $mode = "update"; - // check if photo is existing in database - $r = q( - "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'", - intval(api_user()), - DBA::escape($photo_id), - DBA::escape($album) - ); - if (!DBA::isResult($r)) { + // check if photo is existing in databasei + if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user(), 'album' => $album])) { throw new BadRequestException("photo not available"); } } @@ -4126,52 +4385,45 @@ function api_fr_photo_create_update($type) // now let's do the changes in update-mode if ($mode == "update") { - $sql_extra = ""; + $updated_fields = []; if (!is_null($desc)) { - $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'"; + $updated_fields['desc'] = $desc; } if (!is_null($album_new)) { - $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'"; + $updated_fields['album'] = $album_new; } if (!is_null($allow_cid)) { $allow_cid = trim($allow_cid); - $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'"; + $updated_fields['allow_cid'] = $allow_cid; } if (!is_null($deny_cid)) { $deny_cid = trim($deny_cid); - $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'"; + $updated_fields['deny_cid'] = $deny_cid; } if (!is_null($allow_gid)) { $allow_gid = trim($allow_gid); - $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'"; + $updated_fields['allow_gid'] = $allow_gid; } if (!is_null($deny_gid)) { $deny_gid = trim($deny_gid); - $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'"; + $updated_fields['deny_gid'] = $deny_gid; } $result = false; - if ($sql_extra != "") { + if (count($updated_fields) > 0) { $nothingtodo = false; - $result = q( - "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'", - $sql_extra, - DateTimeFormat::utcNow(), // update edited timestamp - intval(api_user()), - DBA::escape($photo_id), - DBA::escape($album) - ); + $result = Photo::update($updated_fields, ['uid' => api_user(), 'resource-id' => $photo_id, 'album' => $album]); } else { $nothingtodo = true; } - if (x($_FILES, 'media')) { + if (!empty($_FILES['media'])) { $nothingtodo = false; $media = $_FILES['media']; $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id); @@ -4200,6 +4452,9 @@ function api_fr_photo_create_update($type) * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws InternalServerErrorException */ function api_fr_photo_delete($type) { @@ -4207,7 +4462,7 @@ function api_fr_photo_delete($type) throw new ForbiddenException(); } // input params - $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null); + $photo_id = defaults($_REQUEST, 'photo_id', null); // do several checks on input parameters // we do not allow calls without photo id @@ -4215,16 +4470,12 @@ function api_fr_photo_delete($type) throw new BadRequestException("no photo_id specified"); } // check if photo is existing in database - $r = q( - "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'", - intval(api_user()), - DBA::escape($photo_id) - ); - if (!DBA::isResult($r)) { + $r = Photo::exists(['resource-id' => $photo_id, 'uid' => api_user()]); + if (!$r) { throw new BadRequestException("photo not available"); } // now we can perform on the deletion of the photo - $result = DBA::delete('photo', ['uid' => api_user(), 'resource-id' => $photo_id]); + $result = Photo::delete(['uid' => api_user(), 'resource-id' => $photo_id]); // return success of deletion or error message if ($result) { @@ -4252,17 +4503,21 @@ function api_fr_photo_delete($type) * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws InternalServerErrorException + * @throws NotFoundException */ function api_fr_photo_detail($type) { if (api_user() === false) { throw new ForbiddenException(); } - if (!x($_REQUEST, 'photo_id')) { + if (empty($_REQUEST['photo_id'])) { throw new BadRequestException("No photo id."); } - $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false); + $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false); $photo_id = $_REQUEST['photo_id']; // prepare json/xml output with data from database for the requested photo @@ -4280,7 +4535,12 @@ function api_fr_photo_detail($type) * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * * @return string|array - * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws NotFoundException + * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image */ function api_account_update_profile_image($type) { @@ -4291,7 +4551,7 @@ function api_account_update_profile_image($type) $profile_id = defaults($_REQUEST, 'profile_id', 0); // error if image data is missing - if (!x($_FILES, 'image')) { + if (empty($_FILES['image'])) { throw new BadRequestException("no media data submitted"); } @@ -4309,9 +4569,9 @@ function api_account_update_profile_image($type) // get mediadata from image or media (Twitter call api/account/update_profile_image provides image) $media = null; - if (x($_FILES, 'image')) { + if (!empty($_FILES['image'])) { $media = $_FILES['image']; - } elseif (x($_FILES, 'media')) { + } elseif (!empty($_FILES['media'])) { $media = $_FILES['media']; } // save new profile image @@ -4334,17 +4594,17 @@ function api_account_update_profile_image($type) // change specified profile or all profiles to the new resource-id if ($is_default_profile) { $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()]; - DBA::update('photo', ['profile' => false], $condition); + Photo::update(['profile' => false], $condition); } else { - $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype, - 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype]; + $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext, + 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext]; DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]); } Contact::updateSelfFromUserID(api_user(), true); // Update global directory in background - $url = System::baseUrl() . '/profile/' . get_app()->user['nickname']; + $url = System::baseUrl() . '/profile/' . \get_app()->user['nickname']; if ($url && strlen(Config::get('system', 'directory'))) { Worker::add(PRIORITY_LOW, "Directory", $url); } @@ -4376,6 +4636,11 @@ api_register_func('api/account/update_profile_image', 'api_account_update_profil * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_account_update_profile($type) { @@ -4410,6 +4675,8 @@ api_register_func('api/account/update_profile', 'api_account_update_profile', tr /** * * @param string $acl_string + * @return bool + * @throws Exception */ function check_acl_input($acl_string) { @@ -4446,6 +4713,12 @@ function check_acl_input($acl_string) * @param integer $profile * @param boolean $visibility * @param string $photo_id + * @return array + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws NotFoundException */ 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) { @@ -4485,10 +4758,10 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ if ($imagedata) { $filetype = $imagedata['mime']; } - logger( + Logger::log( "File upload src: " . $src . " - filename: " . $filename . " - size: " . $filesize . " - type: " . $filetype, - LOGGER_DEBUG + Logger::DEBUG ); // check if there was a php upload error @@ -4498,7 +4771,7 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ // check against max upload size within Friendica instance $maximagesize = Config::get('system', 'maximagesize'); if ($maximagesize && ($filesize > $maximagesize)) { - $formattedBytes = formatBytes($maximagesize); + $formattedBytes = Strings::formatBytes($maximagesize); throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)"); } @@ -4520,7 +4793,7 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ } if ($max_length > 0) { $Image->scaleDown($max_length); - logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG); + Logger::log("File upload: Scaling picture to new size " . $max_length, Logger::DEBUG); } $width = $Image->getWidth(); $height = $Image->getHeight(); @@ -4530,17 +4803,17 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ if ($mediatype == "photo") { // upload normal image (scales 0, 1, 2) - logger("photo upload: starting new photo upload", LOGGER_DEBUG); + Logger::log("photo upload: starting new photo upload", Logger::DEBUG); $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc); if (!$r) { - logger("photo upload: image upload with scale 0 (original size) failed"); + Logger::log("photo upload: image upload with scale 0 (original size) failed"); } if ($width > 640 || $height > 640) { $Image->scaleDown(640); $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc); if (!$r) { - logger("photo upload: image upload with scale 1 (640x640) failed"); + Logger::log("photo upload: image upload with scale 1 (640x640) failed"); } } @@ -4548,19 +4821,19 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ $Image->scaleDown(320); $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc); if (!$r) { - logger("photo upload: image upload with scale 2 (320x320) failed"); + Logger::log("photo upload: image upload with scale 2 (320x320) failed"); } } - logger("photo upload: new photo upload ended", LOGGER_DEBUG); + Logger::log("photo upload: new photo upload ended", Logger::DEBUG); } elseif ($mediatype == "profileimage") { // upload profile image (scales 4, 5, 6) - logger("photo upload: starting new profile image upload", LOGGER_DEBUG); + Logger::log("photo upload: starting new profile image upload", Logger::DEBUG); - if ($width > 175 || $height > 175) { - $Image->scaleDown(175); + if ($width > 300 || $height > 300) { + $Image->scaleDown(300); $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc); if (!$r) { - logger("photo upload: profile image upload with scale 4 (175x175) failed"); + Logger::log("photo upload: profile image upload with scale 4 (300x300) failed"); } } @@ -4568,7 +4841,7 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ $Image->scaleDown(80); $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc); if (!$r) { - logger("photo upload: profile image upload with scale 5 (80x80) failed"); + Logger::log("photo upload: profile image upload with scale 5 (80x80) failed"); } } @@ -4576,11 +4849,11 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ $Image->scaleDown(48); $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc); if (!$r) { - logger("photo upload: profile image upload with scale 6 (48x48) failed"); + Logger::log("photo upload: profile image upload with scale 6 (48x48) failed"); } } $Image->__destruct(); - logger("photo upload: new profile image upload ended", LOGGER_DEBUG); + Logger::log("photo upload: new profile image upload ended", Logger::DEBUG); } if (isset($r) && $r) { @@ -4604,6 +4877,7 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ * @param string $deny_gid * @param string $filetype * @param boolean $visibility + * @throws InternalServerErrorException */ function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false) { @@ -4656,10 +4930,16 @@ function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $f * @param string $photo_id * * @return array + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws NotFoundException + * @throws UnauthorizedException */ function prepare_photo_data($type, $scale, $photo_id) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if ($user_info === false) { @@ -4771,14 +5051,14 @@ function prepare_photo_data($type, $scale, $photo_id) */ function api_friendica_remoteauth() { - $url = (x($_GET, 'url') ? $_GET['url'] : ''); - $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : ''); + $url = defaults($_GET, 'url', ''); + $c_url = defaults($_GET, 'c_url', ''); if ($url === '' || $c_url === '') { throw new BadRequestException("Wrong parameters."); } - $c_url = normalise_link($c_url); + $c_url = Strings::normaliseLink($c_url); // traditional DFRN @@ -4801,13 +5081,13 @@ function api_friendica_remoteauth() $dfrn_id = '0:' . $orig_id; } - $sec = random_string(); + $sec = Strings::getRandomHex(); $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id, 'sec' => $sec, 'expire' => time() + 45]; DBA::insert('profile_check', $fields); - logger($contact['name'] . ' ' . $sec, LOGGER_DEBUG); + Logger::info(API_LOG_PREFIX . 'for contact {contact}', ['module' => 'api', 'action' => 'friendica_remoteauth', 'contact' => $contact['name'], 'hey' => $sec]); $dest = ($url ? '&destination_url=' . $url : ''); System::externalRedirect( @@ -4823,6 +5103,8 @@ api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true); * * @param array $item Sharer item * @return array|false Shared item or false if not a reshare + * @throws ImagickException + * @throws InternalServerErrorException */ function api_share_as_retweet(&$item) { @@ -4918,6 +5200,7 @@ function api_share_as_retweet(&$item) } $reshared_item["body"] = $shared_body; + $reshared_item["author-id"] = Contact::getIdForURL($profile, 0, true); $reshared_item["author-name"] = $author; $reshared_item["author-link"] = $profile; $reshared_item["author-avatar"] = $avatar; @@ -4933,6 +5216,7 @@ function api_share_as_retweet(&$item) * @param string $profile * * @return string|false + * @throws InternalServerErrorException * @todo remove trailing junk from profile url * @todo pump.io check has to check the website */ @@ -4942,7 +5226,7 @@ function api_get_nick($profile) $r = q( "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'", - DBA::escape(normalise_link($profile)) + DBA::escape(Strings::normaliseLink($profile)) ); if (DBA::isResult($r)) { @@ -4952,7 +5236,7 @@ function api_get_nick($profile) if (!$nick == "") { $r = q( "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'", - DBA::escape(normalise_link($profile)) + DBA::escape(Strings::normaliseLink($profile)) ); if (DBA::isResult($r)) { @@ -5017,6 +5301,7 @@ function api_get_nick($profile) * @param array $item * * @return array + * @throws Exception */ function api_in_reply_to($item) { @@ -5055,7 +5340,7 @@ function api_in_reply_to($item) // https://github.com/friendica/friendica/issues/1010 // This is a bugfix for that. if (intval($in_reply_to['status_id']) == intval($item['id'])) { - logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG); + Logger::warning(API_LOG_PREFIX . 'ID {id} is similar to reply-to {reply-to}', ['module' => 'api', 'action' => 'in_reply_to', 'id' => $item['id'], 'reply-to' => $in_reply_to['status_id']]); $in_reply_to['status_id'] = null; $in_reply_to['user_id'] = null; $in_reply_to['status_id_str'] = null; @@ -5072,10 +5357,11 @@ function api_in_reply_to($item) * @param string $text * * @return string + * @throws InternalServerErrorException */ function api_clean_plain_items($text) { - $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false"); + $include_entities = strtolower(defaults($_REQUEST, 'include_entities', "false")); $text = BBCode::cleanPictureLinks($text); $URLSearchString = "^\[\]"; @@ -5098,6 +5384,7 @@ function api_clean_plain_items($text) * @param string $body The original body * * @return string Cleaned body + * @throws InternalServerErrorException */ function api_clean_attachments($body) { @@ -5126,7 +5413,7 @@ function api_clean_attachments($body) * * @param array $contacts * - * @return array + * @return void */ function api_best_nickname(&$contacts) { @@ -5196,10 +5483,15 @@ function api_best_nickname(&$contacts) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_group_show($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5207,7 +5499,7 @@ function api_friendica_group_show($type) // params $user_info = api_get_user($a); - $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0); + $gid = defaults($_REQUEST, 'gid', 0); $uid = $user_info['uid']; // get data of the specified group id or all groups if not specified @@ -5261,10 +5553,15 @@ api_register_func('api/friendica/group_show', 'api_friendica_group_show', true); * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_group_delete($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5272,8 +5569,8 @@ function api_friendica_group_delete($type) // params $user_info = api_get_user($a); - $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0); - $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : ""); + $gid = defaults($_REQUEST, 'gid', 0); + $name = defaults($_REQUEST, 'name', ""); $uid = $user_info['uid']; // error if no gid specified @@ -5322,11 +5619,16 @@ api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', tr * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy */ function api_lists_destroy($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5334,7 +5636,7 @@ function api_lists_destroy($type) // params $user_info = api_get_user($a); - $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0); + $gid = defaults($_REQUEST, 'list_id', 0); $uid = $user_info['uid']; // error if no gid specified @@ -5366,10 +5668,11 @@ api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DEL * Add a new group to the database. * * @param string $name Group name - * @param int $uid User ID + * @param int $uid User ID * @param array $users List of users to add to the group * * @return array + * @throws BadRequestException */ function group_create($name, $uid, $users = []) { @@ -5439,10 +5742,15 @@ function group_create($name, $uid, $users = []) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_group_create($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5450,7 +5758,7 @@ function api_friendica_group_create($type) // params $user_info = api_get_user($a); - $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : ""); + $name = defaults($_REQUEST, 'name', ""); $uid = $user_info['uid']; $json = json_decode($_POST['json'], true); $users = $json['user']; @@ -5467,11 +5775,16 @@ api_register_func('api/friendica/group_create', 'api_friendica_group_create', tr * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create */ function api_lists_create($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5479,7 +5792,7 @@ function api_lists_create($type) // params $user_info = api_get_user($a); - $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : ""); + $name = defaults($_REQUEST, 'name', ""); $uid = $user_info['uid']; $success = group_create($name, $uid); @@ -5502,10 +5815,15 @@ api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_group_update($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5514,8 +5832,8 @@ function api_friendica_group_update($type) // params $user_info = api_get_user($a); $uid = $user_info['uid']; - $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0); - $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : ""); + $gid = defaults($_REQUEST, 'gid', 0); + $name = defaults($_REQUEST, 'name', ""); $json = json_decode($_POST['json'], true); $users = $json['user']; @@ -5575,11 +5893,16 @@ api_register_func('api/friendica/group_update', 'api_friendica_group_update', tr * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update */ function api_lists_update($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5587,8 +5910,8 @@ function api_lists_update($type) // params $user_info = api_get_user($a); - $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0); - $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : ""); + $gid = defaults($_REQUEST, 'list_id', 0); + $name = defaults($_REQUEST, 'name', ""); $uid = $user_info['uid']; // error if no gid specified @@ -5622,10 +5945,14 @@ api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST) * @param string $type Return type (atom, rss, xml, json) * * @return array|string + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException */ function api_friendica_activity($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5633,7 +5960,7 @@ function api_friendica_activity($type) $verb = strtolower($a->argv[3]); $verb = preg_replace("|\..*$|", "", $verb); - $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0); + $id = defaults($_REQUEST, 'id', 0); $res = Item::performLike($id, $verb); @@ -5666,10 +5993,13 @@ api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activit * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array -*/ + * @throws BadRequestException + * @throws ForbiddenException + * @throws InternalServerErrorException + */ function api_friendica_notification($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5691,7 +6021,6 @@ function api_friendica_notification($type) $notes = $xmlnotes; } - return api_format_data("notes", $type, ['note' => $notes]); } @@ -5702,10 +6031,15 @@ function api_friendica_notification($type) * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_notification_seen($type) { - $a = get_app(); + $a = \get_app(); $user_info = api_get_user($a); if (api_user() === false || $user_info === false) { @@ -5715,7 +6049,7 @@ function api_friendica_notification_seen($type) throw new BadRequestException("Invalid argument count"); } - $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0); + $id = (!empty($_REQUEST['id']) ? intval($_REQUEST['id']) : 0); $nm = new NotificationsManager(); $note = $nm->getByID($id); @@ -5747,10 +6081,15 @@ api_register_func('api/friendica/notification', 'api_friendica_notification', tr * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array (success result=ok, error result=error with error message) + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_direct_messages_setseen($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); } @@ -5758,7 +6097,7 @@ function api_friendica_direct_messages_setseen($type) // params $user_info = api_get_user($a); $uid = $user_info['uid']; - $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0); + $id = defaults($_REQUEST, 'id', 0); // return error if id is zero if ($id == "") { @@ -5791,15 +6130,20 @@ api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct /** * @brief search for direct_messages containing a searchstring through api * - * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' + * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $box * @return string|array (success: success=true if found and search_result contains found messages, * success=false if nothing was found, search_result='nothing found', - * error: result=error with error message) + * error: result=error with error message) + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_direct_messages_search($type, $box = "") { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); @@ -5807,7 +6151,7 @@ function api_friendica_direct_messages_search($type, $box = "") // params $user_info = api_get_user($a); - $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : ""); + $searchstring = defaults($_REQUEST, 'searchstring', ""); $uid = $user_info['uid']; // error if no searchstring specified @@ -5835,9 +6179,9 @@ function api_friendica_direct_messages_search($type, $box = "") foreach ($r as $item) { if ($box == "inbox" || $item['from-url'] != $profile_url) { $recipient = $user_info; - $sender = api_get_user($a, normalise_link($item['contact-url'])); + $sender = api_get_user($a, Strings::normaliseLink($item['contact-url'])); } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) { - $recipient = api_get_user($a, normalise_link($item['contact-url'])); + $recipient = api_get_user($a, Strings::normaliseLink($item['contact-url'])); $sender = $user_info; } @@ -5859,17 +6203,22 @@ api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_ * * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @return string|array + * @throws BadRequestException + * @throws ForbiddenException + * @throws ImagickException + * @throws InternalServerErrorException + * @throws UnauthorizedException */ function api_friendica_profile_show($type) { - $a = get_app(); + $a = \get_app(); if (api_user() === false) { throw new ForbiddenException(); } // input params - $profile_id = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0); + $profile_id = defaults($_REQUEST, 'profile_id', 0); // retrieve general information about profiles for user $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles'); @@ -5940,6 +6289,7 @@ api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', tr * @param string $type Return format: json or xml * * @return string|array + * @throws Exception */ function api_saved_searches_list($type) { @@ -5965,6 +6315,42 @@ function api_saved_searches_list($type) /// @TODO move to top of file or somewhere better api_register_func('api/saved_searches/list', 'api_saved_searches_list', true); +/* + * Bind comment numbers(friendica_comments: Int) on each statuses page of *_timeline / favorites / search + * + * @brief Number of comments + * + * @param object $data [Status, Status] + * + * @return void + */ +function bindComments(&$data) +{ + if (count($data) == 0) { + return; + } + + $ids = []; + $comments = []; + foreach ($data as $item) { + $ids[] = $item['id']; + } + + $idStr = DBA::escape(implode(', ', $ids)); + $sql = "SELECT `parent`, COUNT(*) as comments FROM `item` WHERE `parent` IN ($idStr) AND `deleted` = ? AND `gravity`= ? GROUP BY `parent`"; + $items = DBA::p($sql, 0, GRAVITY_COMMENT); + $itemsData = DBA::toArray($items); + + foreach ($itemsData as $item) { + $comments[$item['parent']] = $item['comments']; + } + + foreach ($data as $idx => $item) { + $id = $item['id']; + $data[$idx]['friendica_comments'] = isset($comments[$id]) ? $comments[$id] : 0; + } +} + /* @TODO Maybe open to implement? To.Do: