X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fapi.php;h=9b9850f6facef2afe5a004a8544e8bd67f017735;hb=34260fc619af9561e0b6ed357ee061618e83b239;hp=e526c3c35090a620935465e5a631044d3e0be206;hpb=513a745d07af450efa63ed5b315a34b716729063;p=friendica.git diff --git a/include/api.php b/include/api.php index e526c3c350..9b9850f6fa 100644 --- a/include/api.php +++ b/include/api.php @@ -27,7 +27,6 @@ use Friendica\App; use Friendica\Content\Text\BBCode; use Friendica\Content\Text\HTML; use Friendica\Core\Logger; -use Friendica\Core\Protocol; use Friendica\Core\System; use Friendica\Database\DBA; use Friendica\DI; @@ -35,36 +34,21 @@ use Friendica\Model\Contact; use Friendica\Model\Group; use Friendica\Model\Item; use Friendica\Model\Mail; -use Friendica\Model\Notification; use Friendica\Model\Photo; use Friendica\Model\Post; use Friendica\Model\Profile; -use Friendica\Model\User; use Friendica\Module\BaseApi; use Friendica\Network\HTTPException; use Friendica\Network\HTTPException\BadRequestException; use Friendica\Network\HTTPException\ForbiddenException; use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Network\HTTPException\NotFoundException; -use Friendica\Network\HTTPException\TooManyRequestsException; use Friendica\Network\HTTPException\UnauthorizedException; use Friendica\Object\Image; -use Friendica\Security\BasicAuth; use Friendica\Util\DateTimeFormat; use Friendica\Util\Images; -use Friendica\Util\Network; use Friendica\Util\Strings; -require_once __DIR__ . '/../mod/item.php'; -require_once __DIR__ . '/../mod/wall_upload.php'; - -define('API_METHOD_ANY', '*'); -define('API_METHOD_GET', 'GET'); -define('API_METHOD_POST', 'POST,PUT'); -define('API_METHOD_DELETE', 'POST,DELETE'); - -define('API_LOG_PREFIX', 'API {action} - '); - $API = []; /** @@ -72,19 +56,13 @@ $API = []; * * @param string $path API URL path, relative to DI::baseUrl() * @param string $func Function name to call on path request - * @param bool $auth API need logged user - * @param string $method HTTP method reqiured to call this endpoint. - * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST. - * Default to API_METHOD_ANY */ -function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY) +function api_register_func($path, $func) { global $API; $API[$path] = [ 'func' => $func, - 'auth' => $auth, - 'method' => $method, ]; // Workaround for hotot @@ -92,8 +70,6 @@ function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY $API[$path] = [ 'func' => $func, - 'auth' => $auth, - 'method' => $method, ]; } @@ -102,50 +78,28 @@ function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY * * Authenticate user, call registered API function, set HTTP headers * - * @param App $a App * @param App\Arguments $args The app arguments (optional, will retrieved by the DI-Container in case of missing) * @return string|array API call result * @throws Exception */ -function api_call(App $a, App\Arguments $args = null) +function api_call($command, $extension) { global $API; - if ($args == null) { - $args = DI::args(); - } - - $type = "json"; - if (strpos($args->getCommand(), ".xml") > 0) { - $type = "xml"; - } - if (strpos($args->getCommand(), ".json") > 0) { - $type = "json"; - } - if (strpos($args->getCommand(), ".rss") > 0) { - $type = "rss"; - } - if (strpos($args->getCommand(), ".atom") > 0) { - $type = "atom"; - } + Logger::info('Legacy API call', ['command' => $command, 'extension' => $extension]); try { foreach ($API as $p => $info) { - if (strpos($args->getCommand(), $p) === 0) { - if (!empty($info['auth']) && BaseApi::getCurrentUserID() === false) { - BasicAuth::getCurrentUserID(true); - Logger::info(API_LOG_PREFIX . 'nickname {nickname}', ['module' => 'api', 'action' => 'call', 'nickname' => $a->getLoggedInUserNickname()]); - } - - Logger::debug(API_LOG_PREFIX . 'parameters', ['module' => 'api', 'action' => 'call', 'parameters' => $_REQUEST]); + if (strpos($command, $p) === 0) { + Logger::debug(BaseApi::LOG_PREFIX . 'parameters', ['module' => 'api', 'action' => 'call', 'parameters' => $_REQUEST]); $stamp = microtime(true); - $return = call_user_func($info['func'], $type); + $return = call_user_func($info['func'], $extension); $duration = floatval(microtime(true) - $stamp); - Logger::info(API_LOG_PREFIX . 'duration {duration}', ['module' => 'api', 'action' => 'call', 'duration' => round($duration, 2)]); + Logger::info(BaseApi::LOG_PREFIX . 'duration {duration}', ['module' => 'api', 'action' => 'call', 'duration' => round($duration, 2)]); - DI::profiler()->saveLog(DI::logger(), API_LOG_PREFIX . 'performance'); + DI::profiler()->saveLog(DI::logger(), BaseApi::LOG_PREFIX . 'performance'); if (false === $return) { /* @@ -155,7 +109,7 @@ function api_call(App $a, App\Arguments $args = null) throw new InternalServerErrorException(); } - switch ($type) { + switch ($extension) { case "xml": header("Content-Type: text/xml"); break; @@ -182,11 +136,11 @@ function api_call(App $a, App\Arguments $args = null) } } - Logger::warning(API_LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]); + Logger::warning(BaseApi::LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]); throw new NotFoundException(); } catch (HTTPException $e) { - Logger::notice(API_LOG_PREFIX . 'got exception', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString(), 'error' => $e]); - DI::apiResponse()->error($e->getCode(), $e->getDescription(), $e->getMessage(), $type); + Logger::notice(BaseApi::LOG_PREFIX . 'got exception', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString(), 'error' => $e]); + DI::apiResponse()->error($e->getCode(), $e->getDescription(), $e->getMessage(), $extension); } } @@ -430,6 +384,7 @@ function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $ return prepare_photo_data($type, false, $resource_id, $uid); } else { throw new InternalServerErrorException("image upload failed"); + DI::page()->exit(DI::apiResponse()); } } @@ -453,9 +408,9 @@ function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $f $arr = []; $arr['guid'] = System::createUUID(); - $arr['uid'] = intval($uid); + $arr['uid'] = $uid; $arr['uri'] = $uri; - $arr['type'] = 'photo'; + $arr['post-type'] = Item::PT_IMAGE; $arr['wall'] = 1; $arr['resource-id'] = $hash; $arr['contact-id'] = $owner_record['id']; @@ -465,7 +420,7 @@ function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $f $arr['author-name'] = $owner_record['name']; $arr['author-link'] = $owner_record['url']; $arr['author-avatar'] = $owner_record['thumb']; - $arr['title'] = ""; + $arr['title'] = ''; $arr['allow_cid'] = $allow_cid; $arr['allow_gid'] = $allow_gid; $arr['deny_cid'] = $deny_cid; @@ -473,11 +428,7 @@ function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $f $arr['visible'] = $visibility; $arr['origin'] = 1; - $typetoext = [ - 'image/jpeg' => 'jpg', - 'image/png' => 'png', - 'image/gif' => 'gif' - ]; + $typetoext = Images::supportedTypes(); // adds link to the thumbnail scale photo $arr['body'] = '[url=' . DI::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']' @@ -560,7 +511,7 @@ function prepare_photo_data($type, $scale, $photo_id, $uid) // retrieve item element for getting activities (like, dislike etc.) related to photo $condition = ['uid' => $uid, 'resource-id' => $photo_id]; - $item = Post::selectFirst(['id', 'uid', 'uri', 'parent', 'allow_cid', 'deny_cid', 'allow_gid', 'deny_gid'], $condition); + $item = Post::selectFirst(['id', 'uid', 'uri', 'uri-id', 'parent', 'allow_cid', 'deny_cid', 'allow_gid', 'deny_gid'], $condition); if (!DBA::isResult($item)) { throw new NotFoundException('Photo-related item not found.'); } @@ -644,1664 +595,111 @@ function group_create($name, $uid, $users = []) // error if no name specified if ($name == "") { throw new BadRequestException('group name not specified'); - } - - // error message if specified group name already exists - if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => false])) { - throw new BadRequestException('group name already exists'); - } - - // Check if the group needs to be reactivated - if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => true])) { - $reactivate_group = true; - } - - // create group - $ret = Group::create($uid, $name); - if ($ret) { - $gid = Group::getIdByName($uid, $name); - } else { - throw new BadRequestException('other API error'); - } - - // add members - $erroraddinguser = false; - $errorusers = []; - foreach ($users as $user) { - $cid = $user['cid']; - if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) { - Group::addMember($gid, $cid); - } else { - $erroraddinguser = true; - $errorusers[] = $cid; - } - } - - // return success message incl. missing users in array - $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok")); - - return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers]; -} - -/** - * TWITTER API - */ - -/** - * 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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - $skip_status = $_REQUEST['skip_status'] ?? false; - - $user_info = DI::twitterUser()->createFromUserId($uid, $skip_status)->toArray(); - - // "verified" isn't used here in the standard - unset($user_info["verified"]); - - // "uid" is only needed for some internal stuff, so remove it from here - unset($user_info['uid']); - - return DI::apiResponse()->formatData("user", $type, ['user' => $user_info]); -} - -api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true); - -/** - * Deprecated function to upload media. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - $a = DI::app(); - - $_REQUEST['profile_uid'] = $uid; - $_REQUEST['api_source'] = true; - $txt = $_REQUEST['status'] ?? ''; - - if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) { - $txt = HTML::toBBCodeVideo($txt); - $config = HTMLPurifier_Config::createDefault(); - $config->set('Cache.DefinitionImpl', null); - $purifier = new HTMLPurifier($config); - $txt = $purifier->purify($txt); - } - $txt = HTML::toBBCode($txt); - - $picture = wall_upload_post($a, false); - - // now that we have the img url in bbcode we can add it to the status and insert the wall item. - $_REQUEST['body'] = $txt . "\n\n" . '[url=' . $picture["albumpage"] . '][img]' . $picture["preview"] . "[/img][/url]"; - $item_id = item_post($a); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - // output the post that we just posted. - $status_info = DI::twitterStatus()->createFromItemId($item_id, $include_entities)->toArray(); - return DI::apiResponse()->formatData('statuses', $type, ['status' => $status_info]); -} - -/// @TODO move this to top of file or somewhere better! -api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST); - -/** - * Updates the user’s current status. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - $a = DI::app(); - - // convert $_POST array items to the form we use for web posts. - if (!empty($_REQUEST['htmlstatus'])) { - $txt = $_REQUEST['htmlstatus']; - if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) { - $txt = HTML::toBBCodeVideo($txt); - - $config = HTMLPurifier_Config::createDefault(); - $config->set('Cache.DefinitionImpl', null); - - $purifier = new HTMLPurifier($config); - $txt = $purifier->purify($txt); - - $_REQUEST['body'] = HTML::toBBCode($txt); - } - } else { - $_REQUEST['body'] = $_REQUEST['status'] ?? null; - } - - $_REQUEST['title'] = $_REQUEST['title'] ?? null; - - $parent = $_REQUEST['in_reply_to_status_id'] ?? null; - - // Twidere sends "-1" if it is no reply ... - if ($parent == -1) { - $parent = ""; - } - - if (ctype_digit($parent)) { - $_REQUEST['parent'] = $parent; - } else { - $_REQUEST['parent_uri'] = $parent; - } - - if (!empty($_REQUEST['lat']) && !empty($_REQUEST['long'])) { - $_REQUEST['coord'] = sprintf("%s %s", $_REQUEST['lat'], $_REQUEST['long']); - } - $_REQUEST['profile_uid'] = $uid; - - if (!$parent) { - // Check for throttling (maximum posts per day, week and month) - $throttle_day = DI::config()->get('system', 'throttle_limit_day'); - if ($throttle_day > 0) { - $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60); - - $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom]; - $posts_day = Post::count($condition); - - if ($posts_day > $throttle_day) { - logger::info('Daily posting limit reached for user ' . $uid); - // die(api_error($type, DI::l10n()->t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day)); - throw new TooManyRequestsException(DI::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)); - } - } - - $throttle_week = DI::config()->get('system', 'throttle_limit_week'); - if ($throttle_week > 0) { - $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7); - - $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom]; - $posts_week = Post::count($condition); - - if ($posts_week > $throttle_week) { - logger::info('Weekly posting limit reached for user ' . $uid); - // die(api_error($type, DI::l10n()->t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week))); - throw new TooManyRequestsException(DI::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)); - } - } - - $throttle_month = DI::config()->get('system', 'throttle_limit_month'); - if ($throttle_month > 0) { - $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30); - - $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom]; - $posts_month = Post::count($condition); - - if ($posts_month > $throttle_month) { - logger::info('Monthly posting limit reached for user ' . $uid); - // die(api_error($type, DI::l10n()->t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month)); - throw new TooManyRequestsException(DI::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 (!empty($_REQUEST['media_ids'])) { - $ids = explode(',', $_REQUEST['media_ids']); - } elseif (!empty($_FILES['media'])) { - // upload the image if we have one - $picture = wall_upload_post($a, false); - if (is_array($picture)) { - $ids[] = $picture['id']; - } - } - - $attachments = []; - $ressources = []; - - if (!empty($ids)) { - foreach ($ids as $id) { - $media = DBA::toArray(DBA::p("SELECT `resource-id`, `scale`, `nickname`, `type`, `desc`, `filename`, `datasize`, `width`, `height` FROM `photo` - INNER JOIN `user` ON `user`.`uid` = `photo`.`uid` WHERE `resource-id` IN - (SELECT `resource-id` FROM `photo` WHERE `id` = ?) AND `photo`.`uid` = ? - ORDER BY `photo`.`width` DESC LIMIT 2", $id, $uid)); - - if (!empty($media)) { - $ressources[] = $media[0]['resource-id']; - $phototypes = Images::supportedTypes(); - $ext = $phototypes[$media[0]['type']]; - - $attachment = ['type' => Post\Media::IMAGE, 'mimetype' => $media[0]['type'], - 'url' => DI::baseUrl() . '/photo/' . $media[0]['resource-id'] . '-' . $media[0]['scale'] . '.' . $ext, - 'size' => $media[0]['datasize'], - 'name' => $media[0]['filename'] ?: $media[0]['resource-id'], - 'description' => $media[0]['desc'] ?? '', - 'width' => $media[0]['width'], - 'height' => $media[0]['height']]; - - if (count($media) > 1) { - $attachment['preview'] = DI::baseUrl() . '/photo/' . $media[1]['resource-id'] . '-' . $media[1]['scale'] . '.' . $ext; - $attachment['preview-width'] = $media[1]['width']; - $attachment['preview-height'] = $media[1]['height']; - } - $attachments[] = $attachment; - } - } - - // We have to avoid that the post is rejected because of an empty body - if (empty($_REQUEST['body'])) { - $_REQUEST['body'] = '[hr]'; - } - } - - if (!empty($attachments)) { - $_REQUEST['attachments'] = $attachments; - } - - // set this so that the item_post() function is quiet and doesn't redirect or emit json - - $_REQUEST['api_source'] = true; - - if (empty($_REQUEST['source'])) { - $_REQUEST['source'] = BaseApi::getCurrentApplication()['name'] ?: 'API'; - } - - // call out normal post function - $item_id = item_post($a); - - if (!empty($ressources) && !empty($item_id)) { - $item = Post::selectFirst(['uri-id', 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid'], ['id' => $item_id]); - foreach ($ressources as $ressource) { - Photo::setPermissionForRessource($ressource, $uid, $item['allow_cid'], $item['allow_gid'], $item['deny_cid'], $item['deny_gid']); - } - } - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - // output the post that we just posted. - $status_info = DI::twitterStatus()->createFromItemId($item_id, $include_entities)->toArray(); - return DI::apiResponse()->formatData('statuses', $type, ['status' => $status_info]); -} - -api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST); -api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST); - -/** - * 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() -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - - if (empty($_FILES['media'])) { - // Output error - throw new BadRequestException("No media."); - } - - $media = wall_upload_post(DI::app(), false); - if (!$media) { - // Output error - throw new InternalServerErrorException(); - } - - $returndata = []; - $returndata["media_id"] = $media["id"]; - $returndata["media_id_string"] = (string)$media["id"]; - $returndata["size"] = $media["size"]; - $returndata["image"] = ["w" => $media["width"], - "h" => $media["height"], - "image_type" => $media["type"], - "friendica_preview_url" => $media["preview"]]; - - Logger::info('Media uploaded', ['return' => $returndata]); - - return ["media" => $returndata]; -} - -api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST); - -/** - * Updates media meta data (picture descriptions) - * - * @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 - * - * @todo Compare the corresponding Twitter function for correct return values - */ -function api_media_metadata_create($type) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - $postdata = Network::postdata(); - - if (empty($postdata)) { - throw new BadRequestException("No post data"); - } - - $data = json_decode($postdata, true); - if (empty($data)) { - throw new BadRequestException("Invalid post data"); - } - - if (empty($data['media_id']) || empty($data['alt_text'])) { - throw new BadRequestException("Missing post data values"); - } - - if (empty($data['alt_text']['text'])) { - throw new BadRequestException("No alt text."); - } - - Logger::info('Updating metadata', ['media_id' => $data['media_id']]); - - $condition = ['id' => $data['media_id'], 'uid' => $uid]; - $photo = DBA::selectFirst('photo', ['resource-id'], $condition); - if (!DBA::isResult($photo)) { - throw new BadRequestException("Metadata not found."); - } - - DBA::update('photo', ['desc' => $data['alt_text']['text']], ['resource-id' => $photo['resource-id']]); -} - -api_register_func('api/media/metadata/create', 'api_media_metadata_create', true, API_METHOD_POST); - -/** - * Returns extended information of a given user, specified by ID or screen name as per the required id parameter. - * 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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - $user_info = DI::twitterUser()->createFromUserId($uid, false)->toArray(); - - // "uid" is only needed for some internal stuff, so remove it from here - unset($user_info['uid']); - - return DI::apiResponse()->formatData('user', $type, ['user' => $user_info]); -} - -api_register_func('api/users/show', 'api_users_show'); -api_register_func('api/externalprofile/show', 'api_users_show'); - -/** - * Search a public user account. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - $userlist = []; - - if (!empty($_GET['q'])) { - $contacts = Contact::selectToArray( - ['id'], - [ - '`uid` = 0 AND (`name` = ? OR `nick` = ? OR `url` = ? OR `addr` = ?)', - $_GET['q'], - $_GET['q'], - $_GET['q'], - $_GET['q'], - ] - ); - - if (DBA::isResult($contacts)) { - $k = 0; - foreach ($contacts as $contact) { - $user_info = DI::twitterUser()->createFromContactId($contact['id'], $uid, false)->toArray(); - - if ($type == 'xml') { - $userlist[$k++ . ':user'] = $user_info; - } else { - $userlist[] = $user_info; - } - } - $userlist = ['users' => $userlist]; - } else { - throw new NotFoundException('User ' . $_GET['q'] . ' not found.'); - } - } else { - throw new BadRequestException('No search term specified.'); - } - - return DI::apiResponse()->formatData('users', $type, $userlist); -} - -api_register_func('api/users/search', 'api_users_search'); - -/** - * Return user objects - * - * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - $users = []; - - if (!empty($_REQUEST['user_id'])) { - foreach (explode(',', $_REQUEST['user_id']) as $cid) { - if (!empty($cid) && is_numeric($cid)) { - $users[] = DI::twitterUser()->createFromContactId((int)$cid, $uid, false)->toArray(); - } - } - } - - if (empty($users)) { - throw new NotFoundException; - } - - return DI::apiResponse()->formatData("users", $type, ['users' => $users]); -} - -api_register_func('api/users/lookup', 'api_users_lookup', true); - -/** - * Returns statuses that match a specified query. - * - * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets - * - * @param string $type Return format: json, xml, atom, rss - * - * @return array|string - * @throws BadRequestException if the "q" parameter is missing. - * @throws ForbiddenException - * @throws ImagickException - * @throws InternalServerErrorException - * @throws UnauthorizedException - */ -function api_search($type) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - if (empty($_REQUEST['q'])) { - throw new BadRequestException('q parameter is required.'); - } - - $searchTerm = trim(rawurldecode($_REQUEST['q'])); - - $data = []; - $data['status'] = []; - $count = 15; - $exclude_replies = !empty($_REQUEST['exclude_replies']); - if (!empty($_REQUEST['rpp'])) { - $count = $_REQUEST['rpp']; - } elseif (!empty($_REQUEST['count'])) { - $count = $_REQUEST['count']; - } - - $since_id = $_REQUEST['since_id'] ?? 0; - $max_id = $_REQUEST['max_id'] ?? 0; - $page = $_REQUEST['page'] ?? 1; - - $start = max(0, ($page - 1) * $count); - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - if (preg_match('/^#(\w+)$/', $searchTerm, $matches) === 1 && isset($matches[1])) { - $searchTerm = $matches[1]; - $condition = ["`iid` > ? AND `name` = ? AND (NOT `private` OR (`private` AND `uid` = ?))", $since_id, $searchTerm, $uid]; - $tags = DBA::select('tag-search-view', ['uri-id'], $condition); - $uriids = []; - while ($tag = DBA::fetch($tags)) { - $uriids[] = $tag['uri-id']; - } - DBA::close($tags); - - if (empty($uriids)) { - return DI::apiResponse()->formatData('statuses', $type, $data); - } - - $condition = ['uri-id' => $uriids]; - if ($exclude_replies) { - $condition['gravity'] = GRAVITY_PARENT; - } - - $params['group_by'] = ['uri-id']; - } else { - $condition = ["`id` > ? - " . ($exclude_replies ? " AND `gravity` = " . GRAVITY_PARENT : ' ') . " - AND (`uid` = 0 OR (`uid` = ? AND NOT `global`)) - AND `body` LIKE CONCAT('%',?,'%')", - $since_id, $uid, $_REQUEST['q']]; - if ($max_id > 0) { - $condition[0] .= ' AND `id` <= ?'; - $condition[] = $max_id; - } - } - - $statuses = []; - - if (parse_url($searchTerm, PHP_URL_SCHEME) != '') { - $id = Item::fetchByLink($searchTerm, $uid); - if (!$id) { - // Public post - $id = Item::fetchByLink($searchTerm); - } - - if (!empty($id)) { - $statuses = Post::select([], ['id' => $id]); - } - } - - $statuses = $statuses ?: Post::selectForUser($uid, [], $condition, $params); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - $data['status'] = $ret; - - return DI::apiResponse()->formatData('statuses', $type, $data); -} - -api_register_func('api/search/tweets', 'api_search', true); -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 - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // get last network messages - - // params - $count = $_REQUEST['count'] ?? 20; - $page = $_REQUEST['page']?? 0; - $since_id = $_REQUEST['since_id'] ?? 0; - $max_id = $_REQUEST['max_id'] ?? 0; - $exclude_replies = !empty($_REQUEST['exclude_replies']); - $conversation_id = $_REQUEST['conversation_id'] ?? 0; - - $start = max(0, ($page - 1) * $count); - - $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ?", - $uid, GRAVITY_PARENT, GRAVITY_COMMENT, $since_id]; - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - if ($exclude_replies) { - $condition[0] .= ' AND `gravity` = ?'; - $condition[] = GRAVITY_PARENT; - } - if ($conversation_id > 0) { - $condition[0] .= " AND `parent` = ?"; - $condition[] = $conversation_id; - } - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, [], $condition, $params); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - $idarray = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - $idarray[] = intval($status['id']); - } - DBA::close($statuses); - - if (!empty($idarray)) { - $unseen = Post::exists(['unseen' => true, 'id' => $idarray]); - if ($unseen) { - Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]); - } - } - - return DI::apiResponse()->formatData("statuses", $type, ['status' => $ret], Contact::getPublicIdByUserId($uid)); -} - - -api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true); -api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true); - -/** - * Returns the most recent statuses from public 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_statuses_public_timeline($type) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // get last network messages - - // params - $count = $_REQUEST['count'] ?? 20; - $page = $_REQUEST['page'] ?? 1; - $since_id = $_REQUEST['since_id'] ?? 0; - $max_id = $_REQUEST['max_id'] ?? 0; - $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0); - $conversation_id = $_REQUEST['conversation_id'] ?? 0; - - $start = max(0, ($page - 1) * $count); - - if ($exclude_replies && !$conversation_id) { - $condition = ["`gravity` = ? AND `id` > ? AND `private` = ? AND `wall` AND NOT `author-hidden`", - GRAVITY_PARENT, $since_id, Item::PUBLIC]; - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, [], $condition, $params); - } else { - $condition = ["`gravity` IN (?, ?) AND `id` > ? AND `private` = ? AND `wall` AND `origin` AND NOT `author-hidden`", - GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC]; - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - if ($conversation_id > 0) { - $condition[0] .= " AND `parent` = ?"; - $condition[] = $conversation_id; - } - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, [], $condition, $params); - } - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - return DI::apiResponse()->formatData("statuses", $type, ['status' => $ret], Contact::getPublicIdByUserId($uid)); -} - -api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true); - -/** - * Returns the most recent statuses posted by users this node knows about. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - $since_id = $_REQUEST['since_id'] ?? 0; - $max_id = $_REQUEST['max_id'] ?? 0; - - // pagination - $count = $_REQUEST['count'] ?? 20; - $page = $_REQUEST['page'] ?? 1; - - $start = max(0, ($page - 1) * $count); - - $condition = ["`uid` = 0 AND `gravity` IN (?, ?) AND `id` > ? AND `private` = ?", - GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, Item::PUBLIC]; - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, Item::DISPLAY_FIELDLIST, $condition, $params); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - return DI::apiResponse()->formatData("statuses", $type, ['status' => $ret], Contact::getPublicIdByUserId($uid)); -} - -api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true); - -/** - * Returns a single status. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // params - $id = intval(DI::args()->getArgv()[3] ?? 0); - - if ($id == 0) { - $id = intval($_REQUEST['id'] ?? 0); - } - - // Hotot workaround - if ($id == 0) { - $id = intval(DI::args()->getArgv()[4] ?? 0); - } - - logger::notice('API: api_statuses_show: ' . $id); - - $conversation = !empty($_REQUEST['conversation']); - - // try to fetch the item for the local user - or the public item, if there is no local one - $uri_item = Post::selectFirst(['uri-id'], ['id' => $id]); - if (!DBA::isResult($uri_item)) { - throw new BadRequestException(sprintf("There is no status with the id %d", $id)); - } - - $item = Post::selectFirst(['id'], ['uri-id' => $uri_item['uri-id'], 'uid' => [0, $uid]], ['order' => ['uid' => true]]); - if (!DBA::isResult($item)) { - throw new BadRequestException(sprintf("There is no status with the uri-id %d for the given user.", $uri_item['uri-id'])); - } - - $id = $item['id']; - - if ($conversation) { - $condition = ['parent' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]]; - $params = ['order' => ['id' => true]]; - } else { - $condition = ['id' => $id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]]; - $params = []; - } - - $statuses = Post::selectForUser($uid, [], $condition, $params); - - /// @TODO How about copying this to above methods which don't check $r ? - if (!DBA::isResult($statuses)) { - throw new BadRequestException(sprintf("There is no status or conversation with the id %d.", $id)); - } - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - if ($conversation) { - $data = ['status' => $ret]; - return DI::apiResponse()->formatData("statuses", $type, $data); - } else { - $data = ['status' => $ret[0]]; - return DI::apiResponse()->formatData("status", $type, $data); - } -} - -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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // params - $id = intval(DI::args()->getArgv()[3] ?? 0); - $since_id = intval($_REQUEST['since_id'] ?? 0); - $max_id = intval($_REQUEST['max_id'] ?? 0); - $count = intval($_REQUEST['count'] ?? 20); - $page = intval($_REQUEST['page'] ?? 1); - - $start = max(0, ($page - 1) * $count); - - if ($id == 0) { - $id = intval($_REQUEST['id'] ?? 0); - } - - // Hotot workaround - if ($id == 0) { - $id = intval(DI::args()->getArgv()[4] ?? 0); - } - - 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 = Post::selectFirst(['parent-uri-id'], ['id' => $id]); - if (!DBA::isResult($item)) { - throw new BadRequestException("There is no status with the id $id."); - } - - $parent = Post::selectFirst(['id'], ['uri-id' => $item['parent-uri-id'], 'uid' => [0, $uid]], ['order' => ['uid' => true]]); - if (!DBA::isResult($parent)) { - throw new BadRequestException("There is no status with this id."); - } - - $id = $parent['id']; - - $condition = ["`parent` = ? AND `uid` IN (0, ?) AND `gravity` IN (?, ?) AND `id` > ?", - $id, $uid, GRAVITY_PARENT, GRAVITY_COMMENT, $since_id]; - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, [], $condition, $params); - - if (!DBA::isResult($statuses)) { - throw new BadRequestException("There is no status with id $id."); - } - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - $data = ['status' => $ret]; - return DI::apiResponse()->formatData("statuses", $type, $data); -} - -api_register_func('api/conversation/show', 'api_conversation_show', true); -api_register_func('api/statusnet/conversation', 'api_conversation_show', true); - -/** - * Repeats a status. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - // params - $id = intval(DI::args()->getArgv()[3] ?? 0); - - if ($id == 0) { - $id = intval($_REQUEST['id'] ?? 0); - } - - // Hotot workaround - if ($id == 0) { - $id = intval(DI::args()->getArgv()[4] ?? 0); - } - - logger::notice('API: api_statuses_repeat: ' . $id); - - $fields = ['uri-id', 'network', 'body', 'title', 'author-name', 'author-link', 'author-avatar', 'guid', 'created', 'plink']; - $item = Post::selectFirst($fields, ['id' => $id, 'private' => [Item::PUBLIC, Item::UNLISTED]]); - - if (DBA::isResult($item) && !empty($item['body'])) { - if (in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::TWITTER])) { - if (!Item::performActivity($id, 'announce', $uid)) { - throw new InternalServerErrorException(); - } - - $item_id = $id; - } else { - if (strpos($item['body'], "[/share]") !== false) { - $pos = strpos($item['body'], "[share"); - $post = substr($item['body'], $pos); - } else { - $post = BBCode::getShareOpeningTag($item['author-name'], $item['author-link'], $item['author-avatar'], $item['plink'], $item['created'], $item['guid']); - - if (!empty($item['title'])) { - $post .= '[h3]' . $item['title'] . "[/h3]\n"; - } - - $post .= $item['body']; - $post .= "[/share]"; - } - $_REQUEST['body'] = $post; - $_REQUEST['profile_uid'] = $uid; - $_REQUEST['api_source'] = true; - - if (empty($_REQUEST['source'])) { - $_REQUEST['source'] = BaseApi::getCurrentApplication()['name'] ?: 'API'; - } - - $item_id = item_post(DI::app()); - } - } else { - throw new ForbiddenException(); - } - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - // output the post that we just posted. - $status_info = DI::twitterStatus()->createFromItemId($item_id, $include_entities)->toArray(); - return DI::apiResponse()->formatData('statuses', $type, ['status' => $status_info]); -} - -api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST); - -/** - * Destroys a specific status. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - // params - $id = intval(DI::args()->getArgv()[3] ?? 0); - - if ($id == 0) { - $id = intval($_REQUEST['id'] ?? 0); - } - - // Hotot workaround - if ($id == 0) { - $id = intval(DI::args()->getArgv()[4] ?? 0); - } - - logger::notice('API: api_statuses_destroy: ' . $id); - - $ret = api_statuses_show($type); - - Item::deleteForUser(['id' => $id], $uid); - - return $ret; -} - -api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE); - -/** - * Returns the most recent mentions. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // get last network messages - - // params - $since_id = intval($_REQUEST['since_id'] ?? 0); - $max_id = intval($_REQUEST['max_id'] ?? 0); - $count = intval($_REQUEST['count'] ?? 20); - $page = intval($_REQUEST['page'] ?? 1); - - $start = max(0, ($page - 1) * $count); - - $query = "`gravity` IN (?, ?) AND `uri-id` IN - (SELECT `uri-id` FROM `post-user-notification` WHERE `uid` = ? AND `notification-type` & ? != 0 ORDER BY `uri-id`) - AND (`uid` = 0 OR (`uid` = ? AND NOT `global`)) AND `id` > ?"; - - $condition = [ - GRAVITY_PARENT, GRAVITY_COMMENT, - $uid, - Post\UserNotification::TYPE_EXPLICIT_TAGGED | Post\UserNotification::TYPE_IMPLICIT_TAGGED | - Post\UserNotification::TYPE_THREAD_COMMENT | Post\UserNotification::TYPE_DIRECT_COMMENT | - Post\UserNotification::TYPE_DIRECT_THREAD_COMMENT, - $uid, $since_id, - ]; - - if ($max_id > 0) { - $query .= " AND `id` <= ?"; - $condition[] = $max_id; - } - - array_unshift($condition, $query); - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, [], $condition, $params); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - return DI::apiResponse()->formatData("statuses", $type, ['status' => $ret], Contact::getPublicIdByUserId($uid)); -} - -api_register_func('api/statuses/mentions', 'api_statuses_mentions', true); -api_register_func('api/statuses/replies', 'api_statuses_mentions', true); - -/** - * Returns the most recent statuses posted by the user. - * - * @param string $type Either "json" or "xml" - * @return string|array - * @throws BadRequestException - * @throws ForbiddenException - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - Logger::info('api_statuses_user_timeline', ['api_user' => $uid, '_REQUEST' => $_REQUEST]); - - $cid = BaseApi::getContactIDForSearchterm($_REQUEST['screen_name'] ?? '', $_REQUEST['user_id'] ?? 0, $uid); - $since_id = $_REQUEST['since_id'] ?? 0; - $max_id = $_REQUEST['max_id'] ?? 0; - $exclude_replies = !empty($_REQUEST['exclude_replies']); - $conversation_id = $_REQUEST['conversation_id'] ?? 0; - - // pagination - $count = $_REQUEST['count'] ?? 20; - $page = $_REQUEST['page'] ?? 1; - - $start = max(0, ($page - 1) * $count); - - $condition = ["(`uid` = ? OR (`uid` = ? AND NOT `global`)) AND `gravity` IN (?, ?) AND `id` > ? AND `author-id` = ?", - 0, $uid, GRAVITY_PARENT, GRAVITY_COMMENT, $since_id, $cid]; - - if ($exclude_replies) { - $condition[0] .= ' AND `gravity` = ?'; - $condition[] = GRAVITY_PARENT; - } - - if ($conversation_id > 0) { - $condition[0] .= " AND `parent` = ?"; - $condition[] = $conversation_id; - } - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, [], $condition, $params); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - return DI::apiResponse()->formatData("statuses", $type, ['status' => $ret], Contact::getPublicIdByUserId($uid)); -} - -api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true); - -/** - * Star/unstar an item. - * param: id : id of the item - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - // for versioned api. - /// @TODO We need a better global soluton - $action_argv_id = 2; - if (count(DI::args()->getArgv()) > 1 && DI::args()->getArgv()[1] == "1.1") { - $action_argv_id = 3; - } - - if (DI::args()->getArgc() <= $action_argv_id) { - throw new BadRequestException("Invalid request."); - } - $action = str_replace("." . $type, "", DI::args()->getArgv()[$action_argv_id]); - if (DI::args()->getArgc() == $action_argv_id + 2) { - $itemid = intval(DI::args()->getArgv()[$action_argv_id + 1] ?? 0); - } else { - $itemid = intval($_REQUEST['id'] ?? 0); - } - - $item = Post::selectFirstForUser($uid, [], ['id' => $itemid, 'uid' => $uid]); - - if (!DBA::isResult($item)) { - throw new BadRequestException("Invalid item."); - } - - switch ($action) { - case "create": - $item['starred'] = 1; - break; - case "destroy": - $item['starred'] = 0; - break; - default: - throw new BadRequestException("Invalid action ".$action); - } - - $r = Item::update(['starred' => $item['starred']], ['id' => $itemid]); - - if ($r === false) { - throw new InternalServerErrorException("DB error"); - } - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = DI::twitterStatus()->createFromUriId($item['uri-id'], $item['uid'], $include_entities)->toArray(); - - return DI::apiResponse()->formatData("status", $type, ['status' => $ret], Contact::getPublicIdByUserId($uid)); -} - -api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST); -api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE); - -/** - * Returns the most recent favorite statuses. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // in friendica starred item are private - // return favorites only for self - Logger::info(API_LOG_PREFIX . 'for {self}', ['module' => 'api', 'action' => 'favorites']); - - // params - $since_id = $_REQUEST['since_id'] ?? 0; - $max_id = $_REQUEST['max_id'] ?? 0; - $count = $_GET['count'] ?? 20; - $page = $_REQUEST['page'] ?? 1; - - $start = max(0, ($page - 1) * $count); - - $condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `id` > ? AND `starred`", - $uid, GRAVITY_PARENT, GRAVITY_COMMENT, $since_id]; - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - - $statuses = Post::selectForUser($uid, [], $condition, $params); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $ret = []; - while ($status = DBA::fetch($statuses)) { - $ret[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - return DI::apiResponse()->formatData("statuses", $type, ['status' => $ret], Contact::getPublicIdByUserId($uid)); -} - -api_register_func('api/favorites', 'api_favorites', true); - -/** - * Returns all lists the user subscribes to. - * - * @param string $type Return type (atom, rss, xml, json) - * - * @return array|string - * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list - */ -function api_lists_list($type) -{ - $ret = []; - /// @TODO $ret is not filled here? - return DI::apiResponse()->formatData('lists', $type, ["lists_list" => $ret]); -} - -api_register_func('api/lists/list', 'api_lists_list', true); -api_register_func('api/lists/subscriptions', 'api_lists_list', true); - -/** - * Returns all groups the user owns. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // params - $user_info = DI::twitterUser()->createFromUserId($uid, true)->toArray(); - - $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]); - - // loop through all groups - $lists = []; - foreach ($groups as $group) { - if ($group['visible']) { - $mode = 'public'; - } else { - $mode = 'private'; - } - $lists[] = [ - 'name' => $group['name'], - 'id' => intval($group['id']), - 'id_str' => (string) $group['id'], - 'user' => $user_info, - 'mode' => $mode - ]; - } - return DI::apiResponse()->formatData("lists", $type, ['lists' => ['lists' => $lists]]); -} - -api_register_func('api/lists/ownerships', 'api_lists_ownerships', true); - -/** - * Returns recent statuses from users in the specified group. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - if (empty($_REQUEST['list_id'])) { - throw new BadRequestException('list_id not specified'); - } - - // params - $count = $_REQUEST['count'] ?? 20; - $page = $_REQUEST['page'] ?? 1; - $since_id = $_REQUEST['since_id'] ?? 0; - $max_id = $_REQUEST['max_id'] ?? 0; - $exclude_replies = (!empty($_REQUEST['exclude_replies']) ? 1 : 0); - $conversation_id = $_REQUEST['conversation_id'] ?? 0; - - $start = max(0, ($page - 1) * $count); - - $groups = DBA::selectToArray('group_member', ['contact-id'], ['gid' => 1]); - $gids = array_column($groups, 'contact-id'); - $condition = ['uid' => $uid, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'group-id' => $gids]; - $condition = DBA::mergeConditions($condition, ["`id` > ?", $since_id]); - - if ($max_id > 0) { - $condition[0] .= " AND `id` <= ?"; - $condition[] = $max_id; - } - if ($exclude_replies > 0) { - $condition[0] .= ' AND `gravity` = ?'; - $condition[] = GRAVITY_PARENT; - } - if ($conversation_id > 0) { - $condition[0] .= " AND `parent` = ?"; - $condition[] = $conversation_id; - } - - $params = ['order' => ['id' => true], 'limit' => [$start, $count]]; - $statuses = Post::selectForUser($uid, [], $condition, $params); - - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - $items = []; - while ($status = DBA::fetch($statuses)) { - $items[] = DI::twitterStatus()->createFromUriId($status['uri-id'], $status['uid'], $include_entities)->toArray(); - } - DBA::close($statuses); - - return DI::apiResponse()->formatData("statuses", $type, ['status' => $items], Contact::getPublicIdByUserId($uid)); -} - -api_register_func('api/lists/statuses', 'api_lists_statuses', true); - -/** - * Returns either the friends of the follower list - * - * Considers friends and followers lists to be private and won't return - * anything if any user_id parameter is passed. - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); - $uid = BaseApi::getCurrentUserID(); - - // pagination - $count = $_GET['count'] ?? 20; - $page = $_GET['page'] ?? 1; - - $start = max(0, ($page - 1) * $count); - - 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 - */ + } - /*$ret=Array(); - return array('$users' => $ret);*/ - return false; + // error message if specified group name already exists + if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => false])) { + throw new BadRequestException('group name already exists'); } - $sql_extra = ''; - if ($qtype == 'friends') { - $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::SHARING), intval(Contact::FRIEND)); - } elseif ($qtype == 'followers') { - $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(Contact::FOLLOWER), intval(Contact::FRIEND)); + // Check if the group needs to be reactivated + if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => true])) { + $reactivate_group = true; } - if ($qtype == 'blocks') { - $sql_filter = 'AND `blocked` AND NOT `pending`'; - } elseif ($qtype == 'incoming') { - $sql_filter = 'AND `pending`'; + // create group + $ret = Group::create($uid, $name); + if ($ret) { + $gid = Group::getIdByName($uid, $name); } else { - $sql_filter = 'AND (NOT `blocked` OR `pending`)'; + throw new BadRequestException('other API error'); } - // @todo This query most likely can be replaced with a Contact::select... - $r = DBA::toArray(DBA::p( - "SELECT `id` - FROM `contact` - WHERE `uid` = ? - AND NOT `self` - $sql_filter - $sql_extra - ORDER BY `nick` - LIMIT ?, ?", - $uid, - $start, - $count - )); - - $ret = []; - foreach ($r as $cid) { - $user = DI::twitterUser()->createFromContactId($cid['id'], $uid, false)->toArray(); - // "uid" is only needed for some internal stuff, so remove it from here - unset($user['uid']); - - if ($user) { - $ret[] = $user; + // add members + $erroraddinguser = false; + $errorusers = []; + foreach ($users as $user) { + $cid = $user['cid']; + if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) { + Group::addMember($gid, $cid); + } else { + $erroraddinguser = true; + $errorusers[] = $cid; } } - return ['user' => $ret]; + // return success message incl. missing users in array + $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok")); + + return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers]; } /** - * 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 + * TWITTER API */ -function api_statuses_friends($type) -{ - $data = api_statuses_f("friends"); - if ($data === false) { - return false; - } - return DI::apiResponse()->formatData("users", $type, $data); -} - -api_register_func('api/statuses/friends', 'api_statuses_friends', true); /** - * Returns the list of followers of the provided user + * Returns all lists the user subscribes to. * - * @deprecated By Twitter API in favor of friends/list + * @param string $type Return type (atom, rss, xml, json) * - * @param string $type Either "json" or "xml" - * @return boolean|string|array - * @throws BadRequestException - * @throws ForbiddenException + * @return array|string + * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list */ -function api_statuses_followers($type) +function api_lists_list($type) { - $data = api_statuses_f("followers"); - if ($data === false) { - return false; - } - return DI::apiResponse()->formatData("users", $type, $data); + BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); + $ret = []; + /// @TODO $ret is not filled here? + return DI::apiResponse()->formatData('lists', $type, ["lists_list" => $ret]); } -api_register_func('api/statuses/followers', 'api_statuses_followers', true); +api_register_func('api/lists/list', 'api_lists_list', true); +api_register_func('api/lists/subscriptions', 'api_lists_list', true); /** - * Returns the list of blocked users - * - * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list + * Returns all groups the user owns. * - * @param string $type Either "json" or "xml" + * @param string $type Return type (atom, rss, xml, json) * - * @return boolean|string|array + * @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_blocks_list($type) +function api_lists_ownerships($type) { - $data = api_statuses_f('blocks'); - if ($data === false) { - return false; - } - return DI::apiResponse()->formatData("users", $type, $data); -} + BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); + $uid = BaseApi::getCurrentUserID(); -api_register_func('api/blocks/list', 'api_blocks_list', true); + // params + $user_info = DI::twitterUser()->createFromUserId($uid, true)->toArray(); -/** - * Returns the list of pending users IDs - * - * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming - * - * @param string $type Either "json" or "xml" - * - * @return boolean|string|array - * @throws BadRequestException - * @throws ForbiddenException - */ -function api_friendships_incoming($type) -{ - $data = api_statuses_f('incoming'); - if ($data === false) { - return false; - } + $groups = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid]); - $ids = []; - foreach ($data['user'] as $user) { - $ids[] = $user['id']; + // loop through all groups + $lists = []; + foreach ($groups as $group) { + if ($group['visible']) { + $mode = 'public'; + } else { + $mode = 'private'; + } + $lists[] = [ + 'name' => $group['name'], + 'id' => intval($group['id']), + 'id_str' => (string) $group['id'], + 'user' => $user_info, + 'mode' => $mode + ]; } - - return DI::apiResponse()->formatData("ids", $type, ['id' => $ids]); + return DI::apiResponse()->formatData("lists", $type, ['lists' => ['lists' => $lists]]); } -api_register_func('api/friendships/incoming', 'api_friendships_incoming', true); +api_register_func('api/lists/ownerships', 'api_lists_ownerships', true); /** * Sends a new direct message. @@ -2322,13 +720,13 @@ function api_direct_messages_new($type) BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); $uid = BaseApi::getCurrentUserID(); - if (empty($_POST["text"]) || empty($_POST['screen_name']) && empty($_POST['user_id'])) { + if (empty($_POST["text"]) || empty($_REQUEST['screen_name']) && empty($_REQUEST['user_id'])) { return; } $sender = DI::twitterUser()->createFromUserId($uid, true)->toArray(); - $cid = BaseApi::getContactIDForSearchterm($_POST['screen_name'] ?? '', $_POST['user_id'] ?? 0, $uid); + $cid = BaseApi::getContactIDForSearchterm($_REQUEST['screen_name'] ?? '', $_REQUEST['profileurl'] ?? '', $_REQUEST['user_id'] ?? 0, 0); if (empty($cid)) { throw new NotFoundException('Recipient not found'); } @@ -2360,7 +758,7 @@ function api_direct_messages_new($type) return DI::apiResponse()->formatData("direct-messages", $type, ['direct_message' => $ret], Contact::getPublicIdByUserId($uid)); } -api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST); +api_register_func('api/direct_messages/new', 'api_direct_messages_new', true); /** * delete a direct_message from mail table through api @@ -2426,84 +824,7 @@ function api_direct_messages_destroy($type) /// @todo return JSON data like Twitter API not yet implemented } -api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE); - -/** - * Unfollow Contact - * - * @param string $type Known types are 'atom', 'rss', 'xml' and 'json' - * @return string|array - * @throws HTTPException\BadRequestException - * @throws HTTPException\ExpectationFailedException - * @throws HTTPException\ForbiddenException - * @throws HTTPException\InternalServerErrorException - * @throws HTTPException\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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - $owner = User::getOwnerDataById($uid); - if (!$owner) { - Logger::notice(API_LOG_PREFIX . 'No owner {uid} found', ['module' => 'api', 'action' => 'friendships_destroy', 'uid' => $uid]); - throw new HTTPException\NotFoundException('Error Processing Request'); - } - - $contact_id = $_REQUEST['user_id'] ?? 0; - - if (empty($contact_id)) { - Logger::notice(API_LOG_PREFIX . 'No user_id specified', ['module' => 'api', 'action' => 'friendships_destroy']); - throw new HTTPException\BadRequestException('no user_id specified'); - } - - // Get Contact by given id - $contact = DBA::selectFirst('contact', ['url'], ['id' => $contact_id, 'uid' => 0, 'self' => false]); - - if(!DBA::isResult($contact)) { - Logger::notice(API_LOG_PREFIX . 'No public contact found for ID {contact}', ['module' => 'api', 'action' => 'friendships_destroy', 'contact' => $contact_id]); - throw new HTTPException\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, Strings::normaliseLink($url), - Strings::normaliseLink($url), $url]; - $contact = DBA::selectFirst('contact', [], $condition); - - if (!DBA::isResult($contact)) { - Logger::notice(API_LOG_PREFIX . 'Not following contact', ['module' => 'api', 'action' => 'friendships_destroy']); - throw new HTTPException\NotFoundException('Not following Contact'); - } - - try { - $result = Contact::terminateFriendship($owner, $contact); - - if ($result === null) { - Logger::notice(API_LOG_PREFIX . 'Not supported for {network}', ['module' => 'api', 'action' => 'friendships_destroy', 'network' => $contact['network']]); - throw new HTTPException\ExpectationFailedException('Unfollowing is currently not supported by this contact\'s network.'); - } - - if ($result === false) { - throw new HTTPException\ServiceUnavailableException('Unable to unfollow this contact, please retry in a few minutes or contact your administrator.'); - } - } catch (Exception $e) { - Logger::error(API_LOG_PREFIX . $e->getMessage(), ['owner' => $owner, 'contact' => $contact]); - throw new HTTPException\InternalServerErrorException('Unable to unfollow this contact, please contact your administrator'); - } - - // "uid" is only needed for some internal stuff, so remove it from here - unset($contact['uid']); - - // Set screen_name since Twidere requests it - $contact['screen_name'] = $contact['nick']; - - return DI::apiResponse()->formatData('friendships-destroy', $type, ['user' => $contact]); -} - -api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST); +api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true); /** * @@ -2605,6 +926,7 @@ function api_direct_messages_box($type, $box, $verbose) */ function api_direct_messages_sentbox($type) { + BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "sentbox", $verbose); } @@ -2623,6 +945,7 @@ api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', tru */ function api_direct_messages_inbox($type) { + BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "inbox", $verbose); } @@ -2639,6 +962,7 @@ api_register_func('api/direct_messages', 'api_direct_messages_inbox', true); */ function api_direct_messages_all($type) { + BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "all", $verbose); } @@ -2655,6 +979,7 @@ api_register_func('api/direct_messages/all', 'api_direct_messages_all', true); */ function api_direct_messages_conversation($type) { + BaseApi::checkAllowedScope(BaseApi::SCOPE_READ); $verbose = !empty($_GET['friendica_verbose']) ? strtolower($_GET['friendica_verbose']) : "false"; return api_direct_messages_box($type, "conversation", $verbose); } @@ -2736,7 +1061,9 @@ function api_fr_photo_create_update($type) $deny_cid = $_REQUEST['deny_cid' ] ?? null; $allow_gid = $_REQUEST['allow_gid'] ?? null; $deny_gid = $_REQUEST['deny_gid' ] ?? null; - $visibility = !$allow_cid && !$deny_cid && !$allow_gid && !$deny_gid; + // Pictures uploaded via API never get posted as a visible status + // See https://github.com/friendica/friendica/issues/10990 + $visibility = false; // do several checks on input parameters // we do not allow calls without album string @@ -2850,8 +1177,8 @@ function api_fr_photo_create_update($type) throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen"); } -api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST); -api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST); +api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true); +api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true); /** * returns the details of a specified photo id, if scale is given, returns the photo data in base 64 @@ -2962,53 +1289,24 @@ function api_account_update_profile_image($type) // output for client if ($data) { - return api_account_verify_credentials($type); - } else { - // SaveMediaToDatabase failed for some reason - throw new InternalServerErrorException("image upload failed"); - } -} - -api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST); + $skip_status = $_REQUEST['skip_status'] ?? false; -/** - * Update user profile - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); + $user_info = DI::twitterUser()->createFromUserId($uid, $skip_status)->toArray(); - $api_user = DI::twitterUser()->createFromUserId($uid, true)->toArray(); + // "verified" isn't used here in the standard + unset($user_info["verified"]); - if (!empty($_POST['name'])) { - DBA::update('profile', ['name' => $_POST['name']], ['uid' => $uid]); - DBA::update('user', ['username' => $_POST['name']], ['uid' => $uid]); - Contact::update(['name' => $_POST['name']], ['uid' => $uid, 'self' => 1]); - Contact::update(['name' => $_POST['name']], ['id' => $api_user['id']]); - } + // "uid" is only needed for some internal stuff, so remove it from here + unset($user_info['uid']); - if (isset($_POST['description'])) { - DBA::update('profile', ['about' => $_POST['description']], ['uid' => $uid]); - Contact::update(['about' => $_POST['description']], ['uid' => $uid, 'self' => 1]); - Contact::update(['about' => $_POST['description']], ['id' => $api_user['id']]); + return DI::apiResponse()->formatData("user", $type, ['user' => $user_info]); + } else { + // SaveMediaToDatabase failed for some reason + throw new InternalServerErrorException("image upload failed"); } - - Profile::publishUpdate($uid); - - return api_account_verify_credentials($type); } -api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST); +api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true); /** * Return all or a specified group of the user with the containing contacts. @@ -3114,7 +1412,7 @@ function api_lists_destroy($type) } } -api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE); +api_register_func('api/lists/destroy', 'api_lists_destroy', true); /** * Create the specified group with the posted array of contacts. @@ -3143,7 +1441,7 @@ function api_friendica_group_create($type) return DI::apiResponse()->formatData("group_create", $type, ['result' => $success]); } -api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST); +api_register_func('api/friendica/group_create', 'api_friendica_group_create', true); /** * Create a new group. @@ -3179,75 +1477,7 @@ function api_lists_create($type) } } -api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST); - -/** - * Update the specified group with the posted array of 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_update($type) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - // params - $gid = $_REQUEST['gid'] ?? 0; - $name = $_REQUEST['name'] ?? ''; - $json = json_decode($_POST['json'], true); - $users = $json['user']; - - // error if no name specified - if ($name == "") { - throw new BadRequestException('group name not specified'); - } - - // error if no gid specified - if ($gid == "") { - throw new BadRequestException('gid not specified'); - } - - // remove members - $members = Contact\Group::getById($gid); - foreach ($members as $member) { - $cid = $member['id']; - foreach ($users as $user) { - $found = ($user['cid'] == $cid ? true : false); - } - if (!isset($found) || !$found) { - $gid = Group::getIdByName($uid, $name); - Group::removeMember($gid, $cid); - } - } - - // add members - $erroraddinguser = false; - $errorusers = []; - foreach ($users as $user) { - $cid = $user['cid']; - - if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) { - Group::addMember($gid, $cid); - } else { - $erroraddinguser = true; - $errorusers[] = $cid; - } - } - - // return success message incl. missing users in array - $status = ($erroraddinguser ? "missing user" : "ok"); - $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers]; - return DI::apiResponse()->formatData("group_update", $type, ['result' => $success]); -} - -api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST); +api_register_func('api/lists/create', 'api_lists_create', true); /** * Update information about a group. @@ -3295,67 +1525,7 @@ function api_lists_update($type) } } -api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST); - -/** - * Set notification as seen and returns associated item (if possible) - * - * POST request with 'id' param as notification id - * - * @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) -{ - BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); - $uid = BaseApi::getCurrentUserID(); - - if (DI::args()->getArgc() !== 4) { - throw new BadRequestException('Invalid argument count'); - } - - $id = intval($_REQUEST['id'] ?? 0); - - try { - $Notify = DI::notify()->selectOneById($id); - if ($Notify->uid !== $uid) { - throw new NotFoundException(); - } - - if ($Notify->uriId) { - DI::notification()->setAllSeenForUser($Notify->uid, ['target-uri-id' => $Notify->uriId]); - } - - $Notify->setSeen(); - DI::notify()->save($Notify); - - if ($Notify->otype === Notification\ObjectType::ITEM) { - $item = Post::selectFirstForUser($uid, [], ['id' => $Notify->iid, 'uid' => $uid]); - if (DBA::isResult($item)) { - $include_entities = strtolower(($_REQUEST['include_entities'] ?? 'false') == 'true'); - - // we found the item, return it to the user - $ret = [DI::twitterStatus()->createFromUriId($item['uri-id'], $item['uid'], $include_entities)->toArray()]; - $data = ['status' => $ret]; - return DI::apiResponse()->formatData('status', $type, $data); - } - // the item can't be found, but we set the notification as seen, so we count this as a success - } - - return DI::apiResponse()->formatData('result', $type, ['result' => 'success']); - } catch (NotFoundException $e) { - throw new BadRequestException('Invalid argument', $e); - } catch (Exception $e) { - throw new InternalServerErrorException('Internal Server exception', $e); - } -} - -api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST); +api_register_func('api/lists/update', 'api_lists_update', true); /** * search for direct_messages containing a searchstring through api