diff --git a/.env b/.env index 322ecb0fa1..63c856cd8d 100644 --- a/.env +++ b/.env @@ -142,6 +142,8 @@ _APP_MIGRATION_HOST=appwrite _APP_MIGRATIONS_FIREBASE_CLIENT_ID= _APP_MIGRATIONS_FIREBASE_CLIENT_SECRET= _APP_PROJECT_REGIONS=default +_APP_GEO_SECRET=your-secret-key +_APP_GEO_ENDPOINT=http://appwrite-geo/v1 _APP_VCS_GITHUB_APP_ID= _APP_VCS_GITHUB_APP_NAME= _APP_VCS_GITHUB_CLIENT_ID= diff --git a/app/assets/dbip/dbip-country-lite-2026-06.mmdb b/app/assets/dbip/dbip-country-lite-2026-06.mmdb deleted file mode 100644 index df09a565b3..0000000000 Binary files a/app/assets/dbip/dbip-country-lite-2026-06.mmdb and /dev/null differ diff --git a/app/config/collections/common.php b/app/config/collections/common.php index 70b0730077..c5dc187ba4 100644 --- a/app/config/collections/common.php +++ b/app/config/collections/common.php @@ -892,6 +892,138 @@ return [ 'array' => false, 'filters' => [], ], + [ + '$id' => ID::custom('continentCode'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 2, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('latitude'), + 'type' => Database::VAR_FLOAT, + 'format' => '', + 'size' => 8, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('longitude'), + 'type' => Database::VAR_FLOAT, + 'format' => '', + 'size' => 8, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('timeZone'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('weatherCode'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('postalCode'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('autonomousSystemNumber'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('autonomousSystemOrganization'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('connectionType'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('connectionUsageType'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('connectionOrganization'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], + [ + '$id' => ID::custom('isp'), + 'type' => Database::VAR_STRING, + 'format' => '', + 'size' => 255, + 'signed' => true, + 'required' => false, + 'default' => null, + 'array' => false, + 'filters' => [], + ], [ '$id' => ID::custom('osCode'), 'type' => Database::VAR_STRING, diff --git a/app/config/variables.php b/app/config/variables.php index 6c23af5c5e..2082868183 100644 --- a/app/config/variables.php +++ b/app/config/variables.php @@ -357,6 +357,24 @@ return [ 'required' => false, 'question' => '', 'filter' => '' + ], + [ + 'name' => '_APP_GEO_ENDPOINT', + 'description' => 'Internal endpoint of the geo service used to resolve IP geolocation for locale and session enrichment. Leave empty to disable geolocation lookups. Defaults to the bundled `appwrite-geo` container.', + 'introduction' => 'TBD', + 'default' => 'http://appwrite-geo/v1', + 'required' => false, + 'question' => '', + 'filter' => '' + ], + [ + 'name' => '_APP_GEO_SECRET', + 'description' => 'Bearer token used to authenticate requests from the Appwrite server to the geo service. Must match the `GEO_SECRET` configured on the `appwrite-geo` container. Change it from the default value before running in production.', + 'introduction' => 'TBD', + 'default' => 'your-secret-key', + 'required' => false, + 'question' => '', + 'filter' => 'token' ] ], ], diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index 9e78ce5b69..bde3ff427b 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -21,6 +21,7 @@ use Appwrite\Event\Publisher\Mail as MailPublisher; use Appwrite\Event\Publisher\Messaging as MessagingPublisher; use Appwrite\Extend\Exception; use Appwrite\Hooks\Hooks; +use Appwrite\Locale\GeoRecord; use Appwrite\Network\Validator\Redirect; use Appwrite\OpenSSL\OpenSSL; use Appwrite\SDK\AuthType; @@ -40,7 +41,6 @@ use Appwrite\Utopia\Request; use Appwrite\Utopia\Response; use libphonenumber\NumberParseException; use libphonenumber\PhoneNumberUtil; -use MaxMind\Db\Reader; use Utopia\Auth\Hashes\Sha; use Utopia\Auth\Proofs\Code as ProofsCode; use Utopia\Auth\Proofs\Password as ProofsPassword; @@ -80,8 +80,7 @@ use Utopia\Validator\WhiteList; $oauthDefaultSuccess = '/console/auth/oauth2/success'; $oauthDefaultFailure = '/console/auth/oauth2/failure'; - -$createSession = function (string $userId, string $secret, Request $request, Response $response, User $user, Database $dbForProject, Document $project, array $platform, Locale $locale, Reader $geodb, Event $queueForEvents, Bus $bus, Store $store, ProofsToken $proofForToken, ProofsCode $proofForCode, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) { +$createSession = function (string $userId, string $secret, Request $request, Response $response, User $user, Database $dbForProject, Document $project, array $platform, Locale $locale, GeoRecord $geoRecord, Event $queueForEvents, Bus $bus, Store $store, ProofsToken $proofForToken, ProofsCode $proofForCode, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) { // Attempt to decode secret as a JWT (used by OAuth2 token flow to carry provider info) $oauthProvider = null; @@ -123,7 +122,6 @@ $createSession = function (string $userId, string $secret, Request $request, Res $duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG; $detector = new Detector($request->getUserAgent('UNKNOWN')); - $record = $geodb->get($request->getIP()); $sessionSecret = $proofForToken->generate(); $factor = (match ($verifiedToken->getAttribute('type')) { @@ -171,7 +169,19 @@ $createSession = function (string $userId, string $secret, Request $request, Res 'userAgent' => $request->getUserAgent('UNKNOWN'), 'ip' => $request->getIP(), 'factors' => [$factor], - 'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--', + 'countryCode' => \strtolower($geoRecord->getCountryCode()), + 'continentCode' => $geoRecord->getContinentCode() === '--' ? null : $geoRecord->getContinentCode(), + 'latitude' => $geoRecord->getLatitude(), + 'longitude' => $geoRecord->getLongitude(), + 'timeZone' => $geoRecord->getTimeZone(), + 'weatherCode' => $geoRecord->getWeatherCode(), + 'postalCode' => $geoRecord->getPostalCode(), + 'autonomousSystemNumber' => $geoRecord->getAutonomousSystemNumber(), + 'autonomousSystemOrganization' => $geoRecord->getAutonomousSystemOrganization(), + 'connectionType' => $geoRecord->getConnectionType(), + 'connectionUsageType' => $geoRecord->getConnectionUsageType(), + 'connectionOrganization' => $geoRecord->getConnectionOrganization(), + 'isp' => $geoRecord->getIsp(), 'expire' => DateTime::addSeconds(new \DateTime(), $duration) ], $providerCredentials, @@ -319,7 +329,8 @@ Http::post('/v1/account') Query::equal('providerEmail', [$email]), ]); if (!$identityWithMatchingEmail->isEmpty()) { - throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */ + throw new Exception(Exception::GENERAL_BAD_REQUEST); + /** Return a generic bad request to prevent exposing existing accounts */ } if ($project->getAttribute('auths', [])['personalDataCheck'] ?? false) { @@ -566,7 +577,8 @@ Http::get('/v1/account/sessions') $sessions = $user->getAttribute('sessions', []); $current = $user->sessionVerify($store->getProperty('secret', ''), $proofForToken); - foreach ($sessions as $key => $session) {/** @var Document $session */ + foreach ($sessions as $key => $session) { + /** @var Document $session */ $countryName = $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown')); $session->setAttribute('countryName', $countryName); @@ -621,7 +633,8 @@ Http::delete('/v1/account/sessions') $sessions = $user->getAttribute('sessions', []); $currentSession = null; - foreach ($sessions as $session) {/** @var Document $session */ + foreach ($sessions as $session) { + /** @var Document $session */ $dbForProject->deleteDocument('sessions', $session->getId()); if (!$domainVerification) { @@ -695,7 +708,8 @@ Http::get('/v1/account/sessions/:sessionId') ? $user->sessionVerify($store->getProperty('secret', ''), $proofForToken) : $sessionId; - foreach ($sessions as $session) {/** @var Document $session */ + foreach ($sessions as $session) { + /** @var Document $session */ if ($sessionId === $session->getId()) { $countryName = $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown')); @@ -928,7 +942,7 @@ Http::post('/v1/account/sessions/email') ->inject('project') ->inject('platform') ->inject('locale') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('bus') ->inject('hooks') @@ -938,7 +952,7 @@ Http::post('/v1/account/sessions/email') ->inject('domainVerification') ->inject('cookieDomain') ->inject('authorization') - ->action(function (string $email, string $password, Request $request, Response $response, User $user, Database $dbForProject, Document $project, array $platform, Locale $locale, Reader $geodb, Event $queueForEvents, Bus $bus, Hooks $hooks, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) { + ->action(function (string $email, string $password, Request $request, Response $response, User $user, Database $dbForProject, Document $project, array $platform, Locale $locale, GeoRecord $geoRecord, Event $queueForEvents, Bus $bus, Hooks $hooks, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) { $email = \strtolower($email); $protocol = $request->getProtocol(); @@ -962,7 +976,6 @@ Http::post('/v1/account/sessions/email') $duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG; $detector = new Detector($request->getUserAgent('UNKNOWN')); - $record = $geodb->get($request->getIP()); $secret = $proofForToken->generate(); $session = new Document(array_merge( [ @@ -975,7 +988,19 @@ Http::post('/v1/account/sessions/email') 'userAgent' => $request->getUserAgent('UNKNOWN'), 'ip' => $request->getIP(), 'factors' => ['password'], - 'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--', + 'countryCode' => \strtolower($geoRecord->getCountryCode()), + 'continentCode' => $geoRecord->getContinentCode() === '--' ? null : $geoRecord->getContinentCode(), + 'latitude' => $geoRecord->getLatitude(), + 'longitude' => $geoRecord->getLongitude(), + 'timeZone' => $geoRecord->getTimeZone(), + 'weatherCode' => $geoRecord->getWeatherCode(), + 'postalCode' => $geoRecord->getPostalCode(), + 'autonomousSystemNumber' => $geoRecord->getAutonomousSystemNumber(), + 'autonomousSystemOrganization' => $geoRecord->getAutonomousSystemOrganization(), + 'connectionType' => $geoRecord->getConnectionType(), + 'connectionUsageType' => $geoRecord->getConnectionUsageType(), + 'connectionOrganization' => $geoRecord->getConnectionOrganization(), + 'isp' => $geoRecord->getIsp(), 'expire' => DateTime::addSeconds(new \DateTime(), $duration) ], $detector->getOS(), @@ -1078,7 +1103,7 @@ Http::post('/v1/account/sessions/anonymous') ->inject('user') ->inject('project') ->inject('dbForProject') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('store') ->inject('proofForPassword') @@ -1086,7 +1111,7 @@ Http::post('/v1/account/sessions/anonymous') ->inject('domainVerification') ->inject('cookieDomain') ->inject('authorization') - ->action(function (Request $request, Response $response, Locale $locale, User $user, Document $project, Database $dbForProject, Reader $geodb, Event $queueForEvents, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) { + ->action(function (Request $request, Response $response, Locale $locale, User $user, Document $project, Database $dbForProject, GeoRecord $geoRecord, Event $queueForEvents, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) { $protocol = $request->getProtocol(); if ('console' === $project->getId()) { @@ -1136,7 +1161,6 @@ Http::post('/v1/account/sessions/anonymous') // Create session token $duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG; $detector = new Detector($request->getUserAgent('UNKNOWN')); - $record = $geodb->get($request->getIP()); $secret = $proofForToken->generate(); $session = new Document(array_merge( @@ -1149,7 +1173,19 @@ Http::post('/v1/account/sessions/anonymous') 'userAgent' => $request->getUserAgent('UNKNOWN'), 'ip' => $request->getIP(), 'factors' => ['anonymous'], - 'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--', + 'countryCode' => \strtolower($geoRecord->getCountryCode()), + 'continentCode' => $geoRecord->getContinentCode() === '--' ? null : $geoRecord->getContinentCode(), + 'latitude' => $geoRecord->getLatitude(), + 'longitude' => $geoRecord->getLongitude(), + 'timeZone' => $geoRecord->getTimeZone(), + 'weatherCode' => $geoRecord->getWeatherCode(), + 'postalCode' => $geoRecord->getPostalCode(), + 'autonomousSystemNumber' => $geoRecord->getAutonomousSystemNumber(), + 'autonomousSystemOrganization' => $geoRecord->getAutonomousSystemOrganization(), + 'connectionType' => $geoRecord->getConnectionType(), + 'connectionUsageType' => $geoRecord->getConnectionUsageType(), + 'connectionOrganization' => $geoRecord->getConnectionOrganization(), + 'isp' => $geoRecord->getIsp(), 'expire' => DateTime::addSeconds(new \DateTime(), $duration) ], $detector->getOS(), @@ -1234,7 +1270,7 @@ Http::post('/v1/account/sessions/token') ->inject('project') ->inject('platform') ->inject('locale') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('bus') ->inject('store') @@ -1434,8 +1470,8 @@ Http::get('/v1/account/sessions/oauth2/:provider/redirect') ->inject('devKey') ->inject('user') ->inject('dbForProject') + ->inject('geoRecord') ->inject('dbForPlatform') - ->inject('geodb') ->inject('queueForEvents') ->inject('store') ->inject('proofForPassword') @@ -1444,7 +1480,7 @@ Http::get('/v1/account/sessions/oauth2/:provider/redirect') ->inject('domainVerification') ->inject('cookieDomain') ->inject('authorization') - ->action(function (string $provider, string $code, string $state, string $error, string $error_description, Request $request, Response $response, Document $project, Validator $redirectValidator, Document $devKey, User $user, Database $dbForProject, Database $dbForPlatform, Reader $geodb, Event $queueForEvents, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, array $plan, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) use ($oauthDefaultSuccess) { + ->action(function (string $provider, string $code, string $state, string $error, string $error_description, Request $request, Response $response, Document $project, Validator $redirectValidator, Document $devKey, User $user, Database $dbForProject, GeoRecord $geoRecord, Database $dbForPlatform, Event $queueForEvents, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, array $plan, bool $domainVerification, ?string $cookieDomain, Authorization $authorization) use ($oauthDefaultSuccess) { $protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https'; $port = $request->getPort(); $callbackBase = $protocol . '://' . $request->getHostname(); @@ -1798,7 +1834,8 @@ Http::get('/v1/account/sessions/oauth2/:provider/redirect') Query::notEqual('userInternalId', $user->getSequence()), ]); if (!empty($identitiesWithMatchingEmail)) { - $failureRedirect(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */ + $failureRedirect(Exception::GENERAL_BAD_REQUEST); + /** Return a generic bad request to prevent exposing existing accounts */ } $dbForProject->createDocument('identities', new Document([ @@ -1935,7 +1972,6 @@ Http::get('/v1/account/sessions/oauth2/:provider/redirect') // If the `token` param is not set, we persist the session in a cookie } else { $detector = new Detector($request->getUserAgent('UNKNOWN')); - $record = $geodb->get($request->getIP()); $secret = $proofForToken->generate(); $session = new Document(array_merge([ @@ -1951,7 +1987,19 @@ Http::get('/v1/account/sessions/oauth2/:provider/redirect') 'userAgent' => $request->getUserAgent('UNKNOWN'), 'ip' => $request->getIP(), 'factors' => [TYPE::EMAIL, 'oauth2'], // include a special oauth2 factor to bypass MFA checks - 'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--', + 'countryCode' => \strtolower($geoRecord->getCountryCode()), + 'continentCode' => $geoRecord->getContinentCode() === '--' ? null : $geoRecord->getContinentCode(), + 'latitude' => $geoRecord->getLatitude(), + 'longitude' => $geoRecord->getLongitude(), + 'timeZone' => $geoRecord->getTimeZone(), + 'weatherCode' => $geoRecord->getWeatherCode(), + 'postalCode' => $geoRecord->getPostalCode(), + 'autonomousSystemNumber' => $geoRecord->getAutonomousSystemNumber(), + 'autonomousSystemOrganization' => $geoRecord->getAutonomousSystemOrganization(), + 'connectionType' => $geoRecord->getConnectionType(), + 'connectionUsageType' => $geoRecord->getConnectionUsageType(), + 'connectionOrganization' => $geoRecord->getConnectionOrganization(), + 'isp' => $geoRecord->getIsp(), 'expire' => DateTime::addSeconds(new \DateTime(), $duration) ], $detector->getOS(), $detector->getClient(), $detector->getDevice())); @@ -2513,7 +2561,8 @@ Http::post('/v1/account/tokens/email') Query::equal('providerEmail', [$email]), ]); if (!$identityWithMatchingEmail->isEmpty()) { - throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */ + throw new Exception(Exception::GENERAL_BAD_REQUEST); + /** Return a generic bad request to prevent exposing existing accounts */ } $userId = $userId === 'unique()' ? ID::unique() : $userId; @@ -2831,7 +2880,7 @@ Http::put('/v1/account/sessions/magic-url') ->inject('project') ->inject('platform') ->inject('locale') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('bus') ->inject('store') @@ -2839,10 +2888,10 @@ Http::put('/v1/account/sessions/magic-url') ->inject('domainVerification') ->inject('cookieDomain') ->inject('authorization') - ->action(function ($userId, $secret, $request, $response, $user, $dbForProject, $project, $platform, $locale, $geodb, $queueForEvents, $bus, $store, $proofForCode, $domainVerification, $cookieDomain, $authorization) use ($createSession) { + ->action(function ($userId, $secret, $request, $response, $user, $dbForProject, $project, $platform, $locale, $geoRecord, $queueForEvents, $bus, $store, $proofForCode, $domainVerification, $cookieDomain, $authorization) use ($createSession) { $proofForToken = new ProofsToken(TOKEN_LENGTH_MAGIC_URL); $proofForToken->setHash(new Sha()); - $createSession($userId, $secret, $request, $response, $user, $dbForProject, $project, $platform, $locale, $geodb, $queueForEvents, $bus, $store, $proofForToken, $proofForCode, $domainVerification, $cookieDomain, $authorization); + $createSession($userId, $secret, $request, $response, $user, $dbForProject, $project, $platform, $locale, $geoRecord, $queueForEvents, $bus, $store, $proofForToken, $proofForCode, $domainVerification, $cookieDomain, $authorization); }); Http::put('/v1/account/sessions/phone') @@ -2882,7 +2931,7 @@ Http::put('/v1/account/sessions/phone') ->inject('project') ->inject('platform') ->inject('locale') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('bus') ->inject('store') @@ -3370,7 +3419,8 @@ Http::patch('/v1/account/email') Query::notEqual('userInternalId', $user->getSequence()), ]); if (!$identityWithMatchingEmail->isEmpty()) { - throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */ + throw new Exception(Exception::GENERAL_BAD_REQUEST); + /** Return a generic bad request to prevent exposing existing accounts */ } $emailMetadata = [ @@ -3446,7 +3496,8 @@ Http::patch('/v1/account/email') } $dbForProject->purgeCachedDocument('users', $user->getId()); } catch (Duplicate) { - throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */ + throw new Exception(Exception::GENERAL_BAD_REQUEST); + /** Return a generic bad request to prevent exposing existing accounts */ } $queueForEvents->setParam('userId', $user->getId()); diff --git a/app/controllers/api/locale.php b/app/controllers/api/locale.php index c70102a6f1..2ae2acb5c9 100644 --- a/app/controllers/api/locale.php +++ b/app/controllers/api/locale.php @@ -1,11 +1,11 @@ inject('request') ->inject('response') ->inject('locale') - ->inject('geodb') - ->action(function (Request $request, Response $response, Locale $locale, Reader $geodb) { - $eu = Config::getParam('locale-eu'); - $currencies = Config::getParam('locale-currencies'); - $output = []; - $ip = $request->getIP(); - - $output['ip'] = $ip; - - $currency = null; - - $record = $geodb->get($ip); - - if ($record) { - $output['countryCode'] = $record['country']['iso_code']; - $output['country'] = $locale->getText('countries.' . strtolower($record['country']['iso_code']), $locale->getText('locale.country.unknown')); - $output['continent'] = $locale->getText('continents.' . strtolower($record['continent']['code']), $locale->getText('locale.country.unknown')); - $output['continentCode'] = $record['continent']['code']; - $output['eu'] = (\in_array($record['country']['iso_code'], $eu)) ? true : false; - - foreach ($currencies as $code => $element) { - if (isset($element['locations']) && isset($element['code']) && \in_array($record['country']['iso_code'], $element['locations'])) { - $currency = $element['code']; - } - } - - $output['currency'] = $currency; - } else { - $output['countryCode'] = '--'; - $output['country'] = $locale->getText('locale.country.unknown'); - $output['continent'] = $locale->getText('locale.country.unknown'); - $output['continentCode'] = '--'; - $output['eu'] = false; - $output['currency'] = $currency; - } - - $response->dynamic(new Document($output), Response::MODEL_LOCALE); + ->inject('geoRecord') + ->action(function (Request $request, Response $response, Locale $locale, GeoRecord $geoRecord) { + $response->dynamic(new Document([ + 'ip' => $geoRecord->getIp(), + 'countryCode' => $geoRecord->getCountryCode(), + 'country' => $geoRecord->getCountryName(), + 'continentCode' => $geoRecord->getContinentCode(), + 'continent' => $geoRecord->getContinent(), + 'eu' => $geoRecord->isEu(), + 'currency' => $geoRecord->getCurrency() ?? '', + ]), Response::MODEL_LOCALE); }); Http::get('/v1/locale/codes') diff --git a/app/controllers/api/users.php b/app/controllers/api/users.php index 816b965f4a..f61f0b6e4f 100644 --- a/app/controllers/api/users.php +++ b/app/controllers/api/users.php @@ -17,6 +17,7 @@ use Appwrite\Event\Message\Delete as DeleteMessage; use Appwrite\Event\Publisher\Delete as DeletePublisher; use Appwrite\Extend\Exception; use Appwrite\Hooks\Hooks; +use Appwrite\Locale\GeoRecord; use Appwrite\SDK\AuthType; use Appwrite\SDK\ContentType; use Appwrite\SDK\Deprecated; @@ -30,7 +31,6 @@ use Appwrite\Utopia\Database\Validator\Queries\Targets; use Appwrite\Utopia\Database\Validator\Queries\Users; use Appwrite\Utopia\Request; use Appwrite\Utopia\Response; -use MaxMind\Db\Reader; use Utopia\Auth\Hash; use Utopia\Auth\Hashes\Argon2; use Utopia\Auth\Hashes\Bcrypt; @@ -2289,11 +2289,11 @@ Http::post('/v1/users/:userId/sessions') ->inject('dbForProject') ->inject('project') ->inject('locale') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('store') ->inject('proofForToken') - ->action(function (string $userId, Request $request, Response $response, Database $dbForProject, Document $project, Locale $locale, Reader $geodb, Event $queueForEvents, Store $store, Token $proofForToken) { + ->action(function (string $userId, Request $request, Response $response, Database $dbForProject, Document $project, Locale $locale, GeoRecord $geoRecord, Event $queueForEvents, Store $store, Token $proofForToken) { $user = $dbForProject->getDocument('users', $userId); if ($user->isEmpty()) { throw new Exception(Exception::USER_NOT_FOUND); @@ -2301,8 +2301,6 @@ Http::post('/v1/users/:userId/sessions') $secret = $proofForToken->generate(); $detector = new Detector($request->getUserAgent('UNKNOWN')); - $record = $geodb->get($request->getIP()); - $duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG; $expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), $duration)); @@ -2316,7 +2314,7 @@ Http::post('/v1/users/:userId/sessions') 'userAgent' => $request->getUserAgent('UNKNOWN'), 'factors' => ['server'], 'ip' => $request->getIP(), - 'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--', + 'countryCode' => \strtolower($geoRecord->getCountryCode()), 'expire' => $expire, ], $detector->getOS(), diff --git a/app/controllers/general.php b/app/controllers/general.php index 5d4684591a..acf8d3e23f 100644 --- a/app/controllers/general.php +++ b/app/controllers/general.php @@ -12,6 +12,7 @@ use Appwrite\Event\Message\Delete as DeleteMessage; use Appwrite\Event\Publisher\Certificate; use Appwrite\Event\Publisher\Delete as DeletePublisher; use Appwrite\Extend\Exception as AppwriteException; +use Appwrite\Locale\GeoRecord; use Appwrite\Locking\Lock; use Appwrite\Network\Cors; use Appwrite\Platform\Appwrite; @@ -48,7 +49,6 @@ use Appwrite\Utopia\Response\Filters\V26 as ResponseV26; use Appwrite\Utopia\View; use Executor\Exception\Timeout as ExecutorTimeout; use Executor\Executor; -use MaxMind\Db\Reader; use Swoole\Http\Request as SwooleRequest; use Swoole\Table; use Utopia\Bus\Bus; @@ -77,7 +77,7 @@ use Utopia\Validator\Text; Config::setParam('cookieSamesite', Response::COOKIE_SAMESITE_NONE); -function router(Http $utopia, Database $dbForPlatform, callable $getProjectDB, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Event $queueForEvents, Bus $bus, Executor $executor, Reader $geodb, callable $isResourceBlocked, array $platform, string $previewHostname, Authorization $authorization, ?Key $apiKey, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) +function router(Http $utopia, Database $dbForPlatform, callable $getProjectDB, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Event $queueForEvents, Bus $bus, Executor $executor, GeoRecord $geoRecord, callable $isResourceBlocked, array $platform, string $previewHostname, Authorization $authorization, ?Key $apiKey, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) { $host = $request->getHostname(); if (!empty($previewHostname)) { @@ -399,16 +399,10 @@ function router(Http $utopia, Database $dbForPlatform, callable $getProjectDB, S $headers['x-appwrite-trigger'] = 'http'; $headers['x-appwrite-user-jwt'] = ''; - if (!empty($ip)) { - $record = $geodb->get($ip); - - if ($record) { - $eu = Config::getParam('locale-eu'); - - $headers['x-appwrite-country-code'] = $record['country']['iso_code'] ?? ''; - $headers['x-appwrite-continent-code'] = $record['continent']['code'] ?? ''; - $headers['x-appwrite-continent-eu'] = (\in_array($record['country']['iso_code'], $eu)) ? 'true' : 'false'; - } + if (!empty($ip) && !$geoRecord->isEmpty()) { + $headers['x-appwrite-country-code'] = $geoRecord->getCountryCode(); + $headers['x-appwrite-continent-code'] = $geoRecord->getContinentCode(); + $headers['x-appwrite-continent-eu'] = $geoRecord->isEu() ? 'true' : 'false'; } $headersFiltered = []; @@ -836,7 +830,7 @@ Http::init() ->inject('getProjectDB') ->inject('locale') ->inject('localeCodes') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('bus') ->inject('executor') @@ -851,7 +845,7 @@ Http::init() ->inject('executionsRetentionCount') ->inject('lock') ->inject('params') - ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Document $project, Database $dbForPlatform, callable $getProjectDB, Locale $locale, array $localeCodes, Reader $geodb, Event $queueForEvents, Bus $bus, Executor $executor, array $platform, callable $isResourceBlocked, string $previewHostname, Document $devKey, ?Key $apiKey, Cors $cors, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock, array $params) { + ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Document $project, Database $dbForPlatform, callable $getProjectDB, Locale $locale, array $localeCodes, GeoRecord $geoRecord, Event $queueForEvents, Bus $bus, Executor $executor, array $platform, callable $isResourceBlocked, string $previewHostname, Document $devKey, ?Key $apiKey, Cors $cors, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock, array $params) { /* * Appwrite Router */ @@ -859,7 +853,7 @@ Http::init() $platformHostnames = $platform['hostnames'] ?? []; // Only run Router when external domain if (!\in_array($hostname, $platformHostnames) || !empty($previewHostname)) { - if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geodb, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { + if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geoRecord, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { $utopia->match($request)?->route->label('router', true); } } @@ -1151,7 +1145,7 @@ Http::options() ->inject('queueForEvents') ->inject('bus') ->inject('executor') - ->inject('geodb') + ->inject('geoRecord') ->inject('isResourceBlocked') ->inject('platform') ->inject('previewHostname') @@ -1163,14 +1157,14 @@ Http::options() ->inject('publisherForDeletes') ->inject('executionsRetentionCount') ->inject('lock') - ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Database $dbForPlatform, callable $getProjectDB, Event $queueForEvents, Bus $bus, Executor $executor, Reader $geodb, callable $isResourceBlocked, array $platform, string $previewHostname, Document $project, Document $devKey, ?Key $apiKey, Cors $cors, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) { + ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Database $dbForPlatform, callable $getProjectDB, Event $queueForEvents, Bus $bus, Executor $executor, GeoRecord $geoRecord, callable $isResourceBlocked, array $platform, string $previewHostname, Document $project, Document $devKey, ?Key $apiKey, Cors $cors, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) { /* * Appwrite Router */ $platformHostnames = $platform['hostnames'] ?? []; // Only run Router when external domain if (!in_array($request->getHostname(), $platformHostnames) || !empty($previewHostname)) { - if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geodb, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { + if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geoRecord, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { $utopia->match($request)?->route->label('router', true); } } @@ -1557,7 +1551,7 @@ Http::get('/robots.txt') ->inject('queueForEvents') ->inject('bus') ->inject('executor') - ->inject('geodb') + ->inject('geoRecord') ->inject('isResourceBlocked') ->inject('platform') ->inject('previewHostname') @@ -1566,13 +1560,13 @@ Http::get('/robots.txt') ->inject('publisherForDeletes') ->inject('executionsRetentionCount') ->inject('lock') - ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Database $dbForPlatform, callable $getProjectDB, Event $queueForEvents, Bus $bus, Executor $executor, Reader $geodb, callable $isResourceBlocked, array $platform, string $previewHostname, ?Key $apiKey, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) { + ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Database $dbForPlatform, callable $getProjectDB, Event $queueForEvents, Bus $bus, Executor $executor, GeoRecord $geoRecord, callable $isResourceBlocked, array $platform, string $previewHostname, ?Key $apiKey, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) { $platformHostnames = $platform['hostnames'] ?? []; if (in_array($request->getHostname(), $platformHostnames) || !empty($previewHostname)) { $template = new View(__DIR__ . '/../views/general/robots.phtml'); $response->text($template->render(false)); } else { - if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geodb, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { + if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geoRecord, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { $utopia->match($request)?->route->label('router', true); } } @@ -1592,7 +1586,7 @@ Http::get('/humans.txt') ->inject('queueForEvents') ->inject('bus') ->inject('executor') - ->inject('geodb') + ->inject('geoRecord') ->inject('isResourceBlocked') ->inject('platform') ->inject('previewHostname') @@ -1601,13 +1595,13 @@ Http::get('/humans.txt') ->inject('publisherForDeletes') ->inject('executionsRetentionCount') ->inject('lock') - ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Database $dbForPlatform, callable $getProjectDB, Event $queueForEvents, Bus $bus, Executor $executor, Reader $geodb, callable $isResourceBlocked, array $platform, string $previewHostname, ?Key $apiKey, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) { + ->action(function (Http $utopia, SwooleRequest $swooleRequest, Request $request, Response $response, Log $log, Database $dbForPlatform, callable $getProjectDB, Event $queueForEvents, Bus $bus, Executor $executor, GeoRecord $geoRecord, callable $isResourceBlocked, array $platform, string $previewHostname, ?Key $apiKey, Authorization $authorization, DeletePublisher $publisherForDeletes, int $executionsRetentionCount, Lock $lock) { $platformHostnames = $platform['hostnames'] ?? []; if (in_array($request->getHostname(), $platformHostnames) || !empty($previewHostname)) { $template = new View(__DIR__ . '/../views/general/humans.phtml'); $response->text($template->render(false)); } else { - if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geodb, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { + if (router($utopia, $dbForPlatform, $getProjectDB, $swooleRequest, $request, $response, $log, $queueForEvents, $bus, $executor, $geoRecord, $isResourceBlocked, $platform, $previewHostname, $authorization, $apiKey, $publisherForDeletes, $executionsRetentionCount, $lock)) { $utopia->match($request)?->route->label('router', true); } } diff --git a/app/controllers/shared/api/auth.php b/app/controllers/shared/api/auth.php index dfb384f893..676b15f30e 100644 --- a/app/controllers/shared/api/auth.php +++ b/app/controllers/shared/api/auth.php @@ -1,9 +1,9 @@ inject('route') ->inject('request') ->inject('project') - ->inject('geodb') + ->inject('geoRecord') ->inject('user') ->inject('authorization') - ->action(function (Route $route, Request $request, Document $project, Reader $geodb, User $user, Authorization $authorization) { + ->action(function (Route $route, Request $request, Document $project, GeoRecord $geoRecord, User $user, Authorization $authorization) { $denylist = System::getEnv('_APP_CONSOLE_COUNTRIES_DENYLIST', ''); - if (!empty($denylist && $project->getId() === 'console')) { - $countries = explode(',', $denylist); - $record = $geodb->get($request->getIP()) ?? []; - $country = $record['country']['iso_code'] ?? ''; - if (in_array($country, $countries)) { + if (!empty($denylist) && $project->getId() === 'console') { + // A missing or unknown geo lookup ("--") is treated as allowed and falls + // through to the membership check below, matching the pre-geo-service behavior. + $countries = \array_map('strtoupper', \array_map('trim', explode(',', $denylist))); + $country = \strtoupper($geoRecord->getCountryCode()); + if (in_array($country, $countries, true)) { throw new Exception(Exception::GENERAL_REGION_ACCESS_DENIED); } } diff --git a/app/init/registers.php b/app/init/registers.php index 43ae64bc53..d188a0b614 100644 --- a/app/init/registers.php +++ b/app/init/registers.php @@ -5,7 +5,6 @@ use Appwrite\GraphQL\Promises\Adapter\Swoole; use Appwrite\Hooks\Hooks; use Appwrite\PubSub\Adapter\Redis as PubSub; use Appwrite\URL\URL as AppwriteURL; -use MaxMind\Db\Reader; use Utopia\Cache\Adapter\Redis as RedisCache; use Utopia\Config\Config; use Utopia\Console; @@ -449,9 +448,6 @@ $register->set('smtp', function () { timelimit: 30, ); }); -$register->set('geodb', function () { - return new Reader(__DIR__ . '/../assets/dbip/dbip-country-lite-2026-06.mmdb'); -}); $register->set('passwordsDictionary', function () { $content = \file_get_contents(__DIR__ . '/../assets/security/10k-common-passwords'); $content = explode("\n", $content); diff --git a/app/init/resources.php b/app/init/resources.php index 51d0b25f8a..019bdf1e34 100644 --- a/app/init/resources.php +++ b/app/init/resources.php @@ -333,8 +333,6 @@ function getDevice(string $root, string $connection = ''): Device } } -$container->set('geodb', fn ($register) => $register->get('geodb'), ['register']); - $container->set('passwordsDictionary', fn ($register) => $register->get('passwordsDictionary'), ['register']); $container->set('servers', function () { diff --git a/app/init/resources/request.php b/app/init/resources/request.php index 461c6311b1..4e4fdea46d 100644 --- a/app/init/resources/request.php +++ b/app/init/resources/request.php @@ -14,6 +14,7 @@ use Appwrite\Event\Webhook; use Appwrite\Extend\Exception; use Appwrite\Functions\EventProcessor; use Appwrite\GraphQL\Schema; +use Appwrite\Locale\GeoRecord; use Appwrite\Locking\Lock; use Appwrite\Network\Cors; use Appwrite\Network\Platform; @@ -35,6 +36,7 @@ use Utopia\Auth\Proofs\Token; use Utopia\Auth\Store; use Utopia\Cache\Cache; use Utopia\Config\Config; +use Utopia\Console; use Utopia\Database\Database; use Utopia\Database\DateTime as DatabaseDateTime; use Utopia\Database\Document; @@ -42,6 +44,7 @@ use Utopia\Database\Query; use Utopia\Database\Validator\Authorization; use Utopia\DI\Container; use Utopia\Domains\Domain; +use Utopia\Fetch\Client; use Utopia\Http\Http; use Utopia\Locale\Locale; use Utopia\Lock\Distributed as DistributedLock; @@ -1333,4 +1336,79 @@ return function (Container $context): void { $adapter->setTimeout((int) System::getEnv('_APP_EMBEDDING_TIMEOUT', '30000')); return new Agent($adapter); }, ['register']); + + $context->set('geoRecord', function ($request, Locale $locale, callable $getGeoForIp) { + $ip = $request->getIp(); + + if (!filter_var($ip, FILTER_VALIDATE_IP)) { + Console::warning("Invalid IP address: {$ip}"); + $ip = '0.0.0.0'; + } + + return $getGeoForIp($locale, $ip); + }, ['request', 'locale', 'getGeoForIp']); + + $context->set('getGeoForIp', function () { + return function (Locale $locale, string $ip): GeoRecord { + $record = null; + $geoEndpoint = System::getEnv('_APP_GEO_ENDPOINT', ''); + $geoSecret = System::getEnv('_APP_GEO_SECRET', ''); + + if (!empty($geoEndpoint) && !empty($geoSecret) && filter_var($ip, FILTER_VALIDATE_IP)) { + try { + $client = new Client(); + $client->addHeader('Authorization', 'Bearer ' . $geoSecret); + $client->setTimeout(3000); + + $response = $client->fetch(\rtrim($geoEndpoint, '/') . "/ips/{$ip}", Client::METHOD_GET); + if ($response->getStatusCode() === 200) { + $body = $response->json(); + if (\is_array($body)) { + $record = $body; + } + } + } catch (\Throwable $th) { + Console::warning('Geo service unavailable: ' . $th->getMessage()); + } + } + + $countryCode = \strtoupper($record['countryCode'] ?? '--'); + $continentCode = \strtoupper($record['continentCode'] ?? '--'); + + $eu = \array_map('strtoupper', Config::getParam('locale-eu')); + $currencies = Config::getParam('locale-currencies'); + $currency = null; + + if ($countryCode !== '--') { + foreach ($currencies as $element) { + if (isset($element['locations'], $element['code']) && \in_array($countryCode, $element['locations'], true)) { + $currency = $element['code']; + break; + } + } + } + + $autonomousSystemNumber = $record['autonomousSystemNumber'] ?? null; + + return (new GeoRecord([ + 'ip' => $ip, + 'countryCode' => $countryCode, + 'continentCode' => $continentCode, + 'eu' => $countryCode !== '--' && \in_array($countryCode, $eu, true), + 'currency' => $currency, + 'latitude' => $record['latitude'] ?? null, + 'longitude' => $record['longitude'] ?? null, + 'timeZone' => $record['timeZone'] ?? null, + 'weatherCode' => $record['weatherCode'] ?? null, + 'postalCode' => $record['postalCode'] ?? null, + 'autonomousSystemNumber' => $autonomousSystemNumber === null ? null : (string) $autonomousSystemNumber, + 'autonomousSystemOrganization' => $record['autonomousSystemOrganization'] ?? null, + 'connectionType' => $record['connection'] ?? null, + 'connectionUsageType' => $record['user'] ?? $record['type'] ?? null, + 'connectionOrganization' => $record['organization'] ?? null, + 'isp' => $record['isp'] ?? null, + ])) + ->setLocale($locale); + }; + }, []); }; diff --git a/docker-compose.yml b/docker-compose.yml index 29b24f3790..1b5163e1e5 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -76,6 +76,7 @@ services: - redis - ${_APP_DB_HOST:-mongodb} - appwrite-embedding + - appwrite-geo environment: - _APP_ENV - _APP_EDITION @@ -203,6 +204,8 @@ services: - _APP_CUSTOM_DOMAIN_DENY_LIST - _APP_TRUSTED_HEADERS - _APP_MIGRATION_HOST + - _APP_GEO_SECRET + - _APP_GEO_ENDPOINT appwrite-console: logging: driver: json-file @@ -1097,6 +1100,27 @@ services: image: appwrite/browser:0.3.2 networks: - appwrite + + appwrite-geo: + container_name: appwrite-geo + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m + image: appwrite/geo:0.3.0 + restart: unless-stopped + networks: + - appwrite + environment: + - GEO_SECRET=$_APP_GEO_SECRET + healthcheck: + test: 'php -r "exit(json_decode(file_get_contents(''http://localhost/v1/health''))->status === ''ok'' ? 0 : 1);"' + interval: 10s + timeout: 5s + retries: 3 + start_period: 5s + openruntimes-executor: container_name: exc1 hostname: exc1 diff --git a/docs/references/health/get-geo.md b/docs/references/health/get-geo.md new file mode 100644 index 0000000000..891027653d --- /dev/null +++ b/docs/references/health/get-geo.md @@ -0,0 +1 @@ +Check the Appwrite geo service is up and connection is successful. \ No newline at end of file diff --git a/src/Appwrite/Locale/GeoRecord.php b/src/Appwrite/Locale/GeoRecord.php new file mode 100644 index 0000000000..a6aed647eb --- /dev/null +++ b/src/Appwrite/Locale/GeoRecord.php @@ -0,0 +1,141 @@ +locale = $locale; + + return $this; + } + + public function isEmpty(): bool + { + return $this->getAttribute('countryCode', '--') === '--'; + } + + public function getIp(): string + { + return $this->getAttribute('ip', ''); + } + + public function getCountryCode(): string + { + $code = $this->getAttribute('countryCode', '--'); + + return $code === '--' ? '--' : \strtoupper($code); + } + + public function getCountryName(): string + { + if ($this->locale === null) { + return ''; + } + + $unknown = $this->locale->getText('locale.country.unknown'); + $code = $this->getAttribute('countryCode', '--'); + + if ($code === '--') { + return $unknown; + } + + return $this->locale->getText('countries.' . \strtolower($code), $unknown); + } + + public function getContinent(): string + { + if ($this->locale === null) { + return ''; + } + + $unknown = $this->locale->getText('locale.country.unknown'); + $code = $this->getAttribute('continentCode', '--'); + + if ($code === '--') { + return $unknown; + } + + return $this->locale->getText('continents.' . \strtolower($code), $unknown); + } + + public function getContinentCode(): string + { + return $this->getAttribute('continentCode', '--'); + } + + public function isEu(): bool + { + return $this->getAttribute('eu', false); + } + + public function getCurrency(): ?string + { + return $this->getAttribute('currency'); + } + + public function getTimeZone(): ?string + { + return $this->getAttribute('timeZone'); + } + + public function getWeatherCode(): ?string + { + return $this->getAttribute('weatherCode'); + } + + public function getPostalCode(): ?string + { + return $this->getAttribute('postalCode'); + } + + public function getLatitude(): ?float + { + $value = $this->getAttribute('latitude'); + + return $value === null ? null : (float) $value; + } + + public function getLongitude(): ?float + { + $value = $this->getAttribute('longitude'); + + return $value === null ? null : (float) $value; + } + + public function getIsp(): ?string + { + return $this->getAttribute('isp'); + } + + public function getAutonomousSystemNumber(): ?string + { + return $this->getAttribute('autonomousSystemNumber'); + } + + public function getAutonomousSystemOrganization(): ?string + { + return $this->getAttribute('autonomousSystemOrganization'); + } + + public function getConnectionType(): ?string + { + return $this->getAttribute('connectionType'); + } + + public function getConnectionUsageType(): ?string + { + return $this->getAttribute('connectionUsageType'); + } + + public function getConnectionOrganization(): ?string + { + return $this->getAttribute('connectionOrganization'); + } +} diff --git a/src/Appwrite/Platform/Modules/Functions/Http/Executions/Create.php b/src/Appwrite/Platform/Modules/Functions/Http/Executions/Create.php index 303bf1484b..bee8bba380 100644 --- a/src/Appwrite/Platform/Modules/Functions/Http/Executions/Create.php +++ b/src/Appwrite/Platform/Modules/Functions/Http/Executions/Create.php @@ -11,6 +11,7 @@ use Appwrite\Event\Publisher\Func as FunctionPublisher; use Appwrite\Extend\Exception; use Appwrite\Extend\Exception as AppwriteException; use Appwrite\Functions\Validator\Headers; +use Appwrite\Locale\GeoRecord; use Appwrite\Platform\Modules\Compute\Base; use Appwrite\SDK\AuthType; use Appwrite\SDK\Method; @@ -20,7 +21,6 @@ use Appwrite\Utopia\Database\Documents\User; use Appwrite\Utopia\Response; use Executor\Exception\Timeout as ExecutorTimeout; use Executor\Executor; -use MaxMind\Db\Reader; use Utopia\Auth\Proofs\Token; use Utopia\Auth\Store; use Utopia\Config\Config; @@ -98,7 +98,7 @@ class Create extends Base ->inject('queueForEvents') ->inject('usage') ->inject('publisherForFunctions') - ->inject('geodb') + ->inject('geoRecord') ->inject('store') ->inject('proofForToken') ->inject('executor') @@ -126,7 +126,7 @@ class Create extends Base Event $queueForEvents, Context $usage, FunctionPublisher $publisherForFunctions, - Reader $geodb, + GeoRecord $geoRecord, Store $store, Token $proofForToken, Executor $executor, @@ -241,16 +241,10 @@ class Create extends Base $ip = $request->getIP(); $headers['x-appwrite-client-ip'] = $ip; - if (!empty($ip)) { - $record = $geodb->get($ip); - - if ($record) { - $eu = Config::getParam('locale-eu'); - - $headers['x-appwrite-country-code'] = $record['country']['iso_code'] ?? ''; - $headers['x-appwrite-continent-code'] = $record['continent']['code'] ?? ''; - $headers['x-appwrite-continent-eu'] = (\in_array($record['country']['iso_code'], $eu)) ? 'true' : 'false'; - } + if (!empty($ip) && !$geoRecord->isEmpty()) { + $headers['x-appwrite-country-code'] = $geoRecord->getCountryCode(); + $headers['x-appwrite-continent-code'] = $geoRecord->getContinentCode(); + $headers['x-appwrite-continent-eu'] = $geoRecord->isEu() ? 'true' : 'false'; } $headersFiltered = []; @@ -260,8 +254,6 @@ class Create extends Base } } - - $status = $async ? 'waiting' : 'processing'; if (!is_null($scheduledAt)) { diff --git a/src/Appwrite/Platform/Modules/Health/Http/Health/Geo/Get.php b/src/Appwrite/Platform/Modules/Health/Http/Health/Geo/Get.php new file mode 100644 index 0000000000..94583a75e0 --- /dev/null +++ b/src/Appwrite/Platform/Modules/Health/Http/Health/Geo/Get.php @@ -0,0 +1,83 @@ +setHttpMethod(Action::HTTP_REQUEST_METHOD_GET) + ->setHttpPath('/v1/health/geo') + ->desc('Get geo') + ->groups(['api', 'health']) + ->label('scope', 'health.read') + ->label('sdk', new Method( + namespace: 'health', + group: 'health', + name: 'getGeo', + description: '/docs/references/health/get-geo.md', + auth: [AuthType::ADMIN, AuthType::KEY], + responses: [ + new SDKResponse( + code: Response::STATUS_CODE_OK, + model: Response::MODEL_HEALTH_STATUS, + ) + ], + contentType: ContentType::JSON + )) + ->inject('response') + ->callback($this->action(...)); + } + + public function action(Response $response): void + { + $geoEndpoint = System::getEnv('_APP_GEO_ENDPOINT', ''); + + if (empty($geoEndpoint)) { + throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Geo service is not configured'); + } + + $checkStart = \microtime(true); + + try { + $client = new Client(); + $client->setTimeout(3000); + + $result = $client->fetch(\rtrim($geoEndpoint, '/') . '/health', Client::METHOD_GET); + + if ($result->getStatusCode() !== 200) { + throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Geo service returned status ' . $result->getStatusCode()); + } + } catch (Exception $e) { + throw $e; + } catch (\Throwable $th) { + throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Geo service is unreachable: ' . $th->getMessage()); + } + + $response->dynamic(new Document([ + 'name' => 'geo', + 'status' => 'pass', + 'ping' => \round((\microtime(true) - $checkStart) * 1000), + ]), Response::MODEL_HEALTH_STATUS); + } +} diff --git a/src/Appwrite/Platform/Modules/Health/Services/Http.php b/src/Appwrite/Platform/Modules/Health/Services/Http.php index 9f933c7f13..16b7a8fca8 100644 --- a/src/Appwrite/Platform/Modules/Health/Services/Http.php +++ b/src/Appwrite/Platform/Modules/Health/Services/Http.php @@ -6,6 +6,7 @@ use Appwrite\Platform\Modules\Health\Http\Health\AntiVirus\Get as GetAntivirus; use Appwrite\Platform\Modules\Health\Http\Health\Cache\Get as GetCache; use Appwrite\Platform\Modules\Health\Http\Health\Certificate\Get as GetCertificate; use Appwrite\Platform\Modules\Health\Http\Health\DB\Get as GetDB; +use Appwrite\Platform\Modules\Health\Http\Health\Geo\Get as GetGeo; use Appwrite\Platform\Modules\Health\Http\Health\Get as GetHealth; use Appwrite\Platform\Modules\Health\Http\Health\PubSub\Get as GetPubSub; use Appwrite\Platform\Modules\Health\Http\Health\Queue\Audits\Get as GetQueueAudits; @@ -45,6 +46,7 @@ class Http extends Service $this->addAction(GetStorageLocal::getName(), new GetStorageLocal()); $this->addAction(GetStorage::getName(), new GetStorage()); $this->addAction(GetAntivirus::getName(), new GetAntivirus()); + $this->addAction(GetGeo::getName(), new GetGeo()); $this->addAction(GetQueueAudits::getName(), new GetQueueAudits()); $this->addAction(GetQueueWebhooks::getName(), new GetQueueWebhooks()); diff --git a/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php b/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php index 35297710af..28be0ca958 100644 --- a/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php +++ b/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php @@ -5,13 +5,13 @@ namespace Appwrite\Platform\Modules\Teams\Http\Memberships\Status; use Appwrite\Detector\Detector; use Appwrite\Event\Event; use Appwrite\Extend\Exception; +use Appwrite\Locale\GeoRecord; use Appwrite\Platform\Action; use Appwrite\SDK\AuthType; use Appwrite\SDK\Method; use Appwrite\SDK\Response as SDKResponse; use Appwrite\Utopia\Request; use Appwrite\Utopia\Response; -use MaxMind\Db\Reader; use Utopia\Auth\Proofs\Token; use Utopia\Auth\Store; use Utopia\Config\Config; @@ -70,7 +70,7 @@ class Update extends Action ->inject('dbForProject') ->inject('authorization') ->inject('project') - ->inject('geodb') + ->inject('geoRecord') ->inject('queueForEvents') ->inject('store') ->inject('proofForToken') @@ -79,7 +79,7 @@ class Update extends Action ->callback($this->action(...)); } - public function action(string $teamId, string $membershipId, string $userId, string $secret, Request $request, Response $response, Document $targetUser, Database $dbForProject, Authorization $authorization, $project, Reader $geodb, Event $queueForEvents, Store $store, Token $proofForToken, bool $domainVerification, ?string $cookieDomain) + public function action(string $teamId, string $membershipId, string $userId, string $secret, Request $request, Response $response, Document $targetUser, Database $dbForProject, Authorization $authorization, $project, GeoRecord $geoRecord, Event $queueForEvents, Store $store, Token $proofForToken, bool $domainVerification, ?string $cookieDomain) { $protocol = $request->getProtocol(); @@ -133,7 +133,6 @@ class Update extends Action $authorization->addRole(Role::user($targetUser->getId())->toString()); $detector = new Detector($request->getUserAgent('UNKNOWN')); - $record = $geodb->get($request->getIP()); $authDuration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG; $expire = DateTime::addSeconds(new \DateTime(), $authDuration); $secret = $proofForToken->generate(); @@ -152,7 +151,7 @@ class Update extends Action 'userAgent' => $request->getUserAgent('UNKNOWN'), 'ip' => $request->getIP(), 'factors' => ['email'], - 'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--', + 'countryCode' => \strtolower($geoRecord->getCountryCode()), 'expire' => DateTime::addSeconds(new \DateTime(), $authDuration) ], $detector->getOS(), $detector->getClient(), $detector->getDevice()));