X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fapi.php;h=052d32b17b1f8d788db0d7c65559febeb6cd3aa1;hb=33b491f2a6ce9f7030851fcdd55394c575e4322f;hp=f28f18253207cb6391c864143b0d63398f1b809c;hpb=2f49c4a0586610c3a89b6342a90b916b95719d10;p=friendica.git diff --git a/include/api.php b/include/api.php index f28f182532..052d32b17b 100644 --- a/include/api.php +++ b/include/api.php @@ -31,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; @@ -55,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 = []; @@ -83,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() { @@ -97,9 +101,9 @@ function api_source() return "Twidere"; } - Logger::log("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::log("Empty user-agent", Logger::DEBUG); + Logger::info(API_LOG_PREFIX . 'Empty user-agent', ['module' => 'api', 'action' => 'source']); } return "api"; @@ -110,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) { @@ -155,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) { @@ -181,7 +188,7 @@ function api_login(App $a) var_dump($consumer, $token); die(); } catch (Exception $e) { - Logger::log($e); + Logger::warning(API_LOG_PREFIX . 'error', ['module' => 'api', 'action' => 'login', 'exception' => $e->getMessage()]); } // workaround for HTTP-auth in CGI mode @@ -195,7 +202,7 @@ function api_login(App $a) } if (empty($_SERVER['PHP_AUTH_USER'])) { - Logger::log('API_login: ' . print_r($_SERVER, true), Logger::DEBUG); + 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"); } @@ -236,7 +243,7 @@ function api_login(App $a) } if (!DBA::isResult($record)) { - Logger::log('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'); @@ -273,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) { @@ -309,33 +317,35 @@ function api_call(App $a) api_login($a); } - Logger::log('API call for ' . $a->user['username'] . ': ' . $a->query_string); - Logger::log('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::log("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::log( - 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")) { @@ -376,7 +386,7 @@ function api_call(App $a) $o .= $func . ": " . $time . "\n"; } } - Logger::log($o, Logger::DEBUG); + Logger::debug(API_LOG_PREFIX . $o, ['module' => 'api', 'action' => 'call']); } } @@ -413,7 +423,7 @@ function api_call(App $a) } } - Logger::log('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}"); @@ -463,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) { @@ -495,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) { @@ -511,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) { @@ -522,7 +542,7 @@ function api_get_user(App $a, $contact_id = null) $extra_query = ""; $url = ""; - Logger::log("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)) { @@ -606,7 +626,7 @@ function api_get_user(App $a, $contact_id = null) } } - Logger::log("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) { @@ -618,7 +638,7 @@ function api_get_user(App $a, $contact_id = null) } } - Logger::log('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( @@ -805,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) { @@ -827,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 */ @@ -930,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) { @@ -955,9 +979,16 @@ 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) { @@ -1005,6 +1036,7 @@ 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) { @@ -1023,6 +1055,11 @@ 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) { @@ -1070,6 +1107,12 @@ 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) @@ -1212,6 +1255,11 @@ 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() @@ -1257,7 +1305,12 @@ 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) { @@ -1267,12 +1320,6 @@ function api_status_show($type, $item_id = 0) Logger::log('api_status_show: user_info: '.print_r($user_info, true), Logger::DEBUG); - if ($type == "raw") { - $privacy_sql = "AND NOT `private`"; - } else { - $privacy_sql = ""; - } - if (!empty($item_id)) { // Get the item with the given id $condition = ['id' => $item_id]; @@ -1281,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)) { @@ -1356,6 +1408,11 @@ 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) @@ -1432,6 +1489,10 @@ 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) @@ -1480,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) { @@ -1513,6 +1578,10 @@ 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) { @@ -1595,10 +1664,16 @@ 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 */ @@ -1692,6 +1767,11 @@ 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) { @@ -1775,7 +1855,11 @@ 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) { @@ -1832,6 +1916,12 @@ 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) @@ -1905,6 +1995,12 @@ 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) @@ -1937,7 +2033,7 @@ function api_conversation_show($type) $id = intval(defaults($a->argv, 4, 0)); } - Logger::log('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]); @@ -1982,6 +2078,12 @@ 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) @@ -2049,6 +2151,12 @@ 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) @@ -2090,6 +2198,12 @@ 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) @@ -2157,8 +2271,12 @@ 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) { @@ -2238,6 +2356,12 @@ 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) @@ -2315,6 +2439,11 @@ 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) { @@ -2331,7 +2460,7 @@ function api_favorites($type) // in friendica starred item are private // return favorites only for self - Logger::log('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 = []; @@ -2386,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) { @@ -2443,6 +2573,7 @@ function api_format_messages($item, $recipient, $sender) * @param array $item * * @return array + * @throws InternalServerErrorException */ function api_convert_item($item) { @@ -2518,6 +2649,7 @@ function api_convert_item($item) * @param string $body * * @return array + * @throws InternalServerErrorException */ function api_get_attachments(&$body) { @@ -2556,6 +2688,7 @@ 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) @@ -2700,7 +2833,7 @@ 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" => Strings::normaliseLink($media_url), "media_url_https" => $media_url, @@ -2766,12 +2899,16 @@ 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") { @@ -2838,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) { @@ -2890,10 +3028,15 @@ 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") { @@ -3008,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) { @@ -3083,6 +3227,11 @@ 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) @@ -3127,6 +3276,11 @@ 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) @@ -3204,7 +3358,11 @@ 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) { @@ -3288,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) { @@ -3307,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) { @@ -3335,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) { @@ -3356,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) { @@ -3381,6 +3547,7 @@ 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) { @@ -3390,7 +3557,7 @@ function api_statusnet_config($type) $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'; @@ -3440,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) @@ -3482,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) @@ -3495,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) @@ -3512,6 +3689,12 @@ 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) @@ -3551,7 +3734,6 @@ function api_direct_messages_new($type) } $replyto = ''; - $sub = ''; if (!empty($_REQUEST['replyto'])) { $r = q( 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d', @@ -3600,7 +3782,12 @@ 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) { @@ -3681,7 +3868,12 @@ api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', * * @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) { @@ -3694,7 +3886,7 @@ function api_friendships_destroy($type) $contact_id = defaults($_REQUEST, 'user_id'); if (empty($contact_id)) { - Logger::log("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"); } @@ -3702,7 +3894,7 @@ function api_friendships_destroy($type) $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]); if(!DBA::isResult($contact)) { - Logger::log("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"); } @@ -3714,12 +3906,12 @@ function api_friendships_destroy($type) $contact = DBA::selectFirst('contact', [], $condition); if (!DBA::isResult($contact)) { - Logger::log("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::log("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"); } @@ -3730,7 +3922,7 @@ function api_friendships_destroy($type) Contact::terminateFriendship($owner, $contact, $dissolve); } else { - Logger::log("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"); } @@ -3759,6 +3951,11 @@ 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) { @@ -3864,6 +4061,8 @@ 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) @@ -3878,6 +4077,8 @@ 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) @@ -3891,6 +4092,8 @@ 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) { @@ -3903,6 +4106,8 @@ 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) { @@ -3963,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) { @@ -4015,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) { @@ -4054,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) { @@ -4100,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) { @@ -4234,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) { @@ -4282,6 +4503,10 @@ 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) { @@ -4310,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) { @@ -4366,8 +4596,8 @@ function api_account_update_profile_image($type) $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()]; 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()]); } @@ -4406,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) { @@ -4440,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) { @@ -4476,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) { @@ -4634,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) { @@ -4686,6 +4930,12 @@ 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) { @@ -4837,7 +5087,7 @@ function api_friendica_remoteauth() 'sec' => $sec, 'expire' => time() + 45]; DBA::insert('profile_check', $fields); - Logger::log($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( @@ -4853,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) { @@ -4964,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 */ @@ -5048,6 +5301,7 @@ function api_get_nick($profile) * @param array $item * * @return array + * @throws Exception */ function api_in_reply_to($item) { @@ -5086,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::log('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; @@ -5103,6 +5357,7 @@ function api_in_reply_to($item) * @param string $text * * @return string + * @throws InternalServerErrorException */ function api_clean_plain_items($text) { @@ -5129,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) { @@ -5157,7 +5413,7 @@ function api_clean_attachments($body) * * @param array $contacts * - * @return array + * @return void */ function api_best_nickname(&$contacts) { @@ -5227,6 +5483,11 @@ 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) { @@ -5292,6 +5553,11 @@ 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) { @@ -5353,6 +5619,11 @@ 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) @@ -5397,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 = []) { @@ -5470,6 +5742,11 @@ 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) { @@ -5498,6 +5775,11 @@ 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) @@ -5533,6 +5815,11 @@ 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) { @@ -5606,6 +5893,11 @@ 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) @@ -5653,6 +5945,10 @@ 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) { @@ -5697,7 +5993,10 @@ 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(); @@ -5732,6 +6031,11 @@ 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) { @@ -5777,6 +6081,11 @@ 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) { @@ -5821,11 +6130,16 @@ 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 = "") { @@ -5889,6 +6203,11 @@ 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) { @@ -5970,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) {