Merge pull request #40620 from nextcloud/feat/noid/ocp-for-phonenumber-util

feat(phonenumber): Add OCP wrapper for PhoneNumber utils library

6 files changed, 130 insertions, 10 deletions

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 8c4d8229422..6e5bf85efcf 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -485,6 +485,7 @@ return array(
     'OCP\\IMemcache' => $baseDir . '/lib/public/IMemcache.php',
     'OCP\\IMemcacheTTL' => $baseDir . '/lib/public/IMemcacheTTL.php',
     'OCP\\INavigationManager' => $baseDir . '/lib/public/INavigationManager.php',
+    'OCP\\IPhoneNumberUtil' => $baseDir . '/lib/public/IPhoneNumberUtil.php',
     'OCP\\IPreview' => $baseDir . '/lib/public/IPreview.php',
     'OCP\\IRequest' => $baseDir . '/lib/public/IRequest.php',
     'OCP\\IRequestId' => $baseDir . '/lib/public/IRequestId.php',
@@ -1480,6 +1481,7 @@ return array(
     'OC\\OCS\\Exception' => $baseDir . '/lib/private/OCS/Exception.php',
     'OC\\OCS\\Provider' => $baseDir . '/lib/private/OCS/Provider.php',
     'OC\\OCS\\Result' => $baseDir . '/lib/private/OCS/Result.php',
+    'OC\\PhoneNumberUtil' => $baseDir . '/lib/private/PhoneNumberUtil.php',
     'OC\\PreviewManager' => $baseDir . '/lib/private/PreviewManager.php',
     'OC\\PreviewNotAvailableException' => $baseDir . '/lib/private/PreviewNotAvailableException.php',
     'OC\\Preview\\BMP' => $baseDir . '/lib/private/Preview/BMP.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 6ed91a7d67f..ef88bcd2a9b 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -518,6 +518,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\IMemcache' => __DIR__ . '/../../..' . '/lib/public/IMemcache.php',
         'OCP\\IMemcacheTTL' => __DIR__ . '/../../..' . '/lib/public/IMemcacheTTL.php',
         'OCP\\INavigationManager' => __DIR__ . '/../../..' . '/lib/public/INavigationManager.php',
+        'OCP\\IPhoneNumberUtil' => __DIR__ . '/../../..' . '/lib/public/IPhoneNumberUtil.php',
         'OCP\\IPreview' => __DIR__ . '/../../..' . '/lib/public/IPreview.php',
         'OCP\\IRequest' => __DIR__ . '/../../..' . '/lib/public/IRequest.php',
         'OCP\\IRequestId' => __DIR__ . '/../../..' . '/lib/public/IRequestId.php',
@@ -1513,6 +1514,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\OCS\\Exception' => __DIR__ . '/../../..' . '/lib/private/OCS/Exception.php',
         'OC\\OCS\\Provider' => __DIR__ . '/../../..' . '/lib/private/OCS/Provider.php',
         'OC\\OCS\\Result' => __DIR__ . '/../../..' . '/lib/private/OCS/Result.php',
+        'OC\\PhoneNumberUtil' => __DIR__ . '/../../..' . '/lib/private/PhoneNumberUtil.php',
         'OC\\PreviewManager' => __DIR__ . '/../../..' . '/lib/private/PreviewManager.php',
         'OC\\PreviewNotAvailableException' => __DIR__ . '/../../..' . '/lib/private/PreviewNotAvailableException.php',
         'OC\\Preview\\BMP' => __DIR__ . '/../../..' . '/lib/private/Preview/BMP.php',
diff --git a/lib/private/Accounts/AccountManager.php b/lib/private/Accounts/AccountManager.php
index 9865438161b..3e33e783635 100644
--- a/lib/private/Accounts/AccountManager.php
+++ b/lib/private/Accounts/AccountManager.php
@@ -37,9 +37,6 @@ namespace OC\Accounts;
 
 use Exception;
 use InvalidArgumentException;
-use libphonenumber\NumberParseException;
-use libphonenumber\PhoneNumberFormat;
-use libphonenumber\PhoneNumberUtil;
 use OC\Profile\TProfileHelper;
 use OCP\Accounts\UserUpdatedEvent;
 use OCP\Cache\CappedMemoryCache;
@@ -56,6 +53,7 @@ use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IConfig;
 use OCP\IDBConnection;
 use OCP\IL10N;
+use OCP\IPhoneNumberUtil;
 use OCP\IURLGenerator;
 use OCP\IUser;
 use OCP\L10N\IFactory;
@@ -119,6 +117,7 @@ class AccountManager implements IAccountManager {
 		private IFactory $l10nFactory,
 		private IURLGenerator $urlGenerator,
 		private ICrypto $crypto,
+		private IPhoneNumberUtil $phoneNumberUtil,
 	) {
 		$this->internalCache = new CappedMemoryCache();
 	}
@@ -139,13 +138,9 @@ class AccountManager implements IAccountManager {
 			$defaultRegion = 'EN';
 		}
 
-		$phoneUtil = PhoneNumberUtil::getInstance();
-		try {
-			$phoneNumber = $phoneUtil->parse($input, $defaultRegion);
-			if ($phoneUtil->isValidNumber($phoneNumber)) {
-				return $phoneUtil->format($phoneNumber, PhoneNumberFormat::E164);
-			}
-		} catch (NumberParseException $e) {
+		$phoneNumber = $this->phoneNumberUtil->convertToStandardFormat($input, $defaultRegion);
+		if ($phoneNumber !== null) {
+			return $phoneNumber;
 		}
 
 		throw new InvalidArgumentException(self::PROPERTY_PHONE);
diff --git a/lib/private/PhoneNumberUtil.php b/lib/private/PhoneNumberUtil.php
new file mode 100644
index 00000000000..a1eb2f13233
--- /dev/null
+++ b/lib/private/PhoneNumberUtil.php
@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+/**
+ *
+ * @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC;
+
+use libphonenumber\NumberParseException;
+use libphonenumber\PhoneNumberFormat;
+use OCP\IPhoneNumberUtil;
+
+/**
+ * @since 28.0.0
+ */
+class PhoneNumberUtil implements IPhoneNumberUtil {
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getCountryCodeForRegion(string $regionCode): ?int {
+		$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();
+		$countryCode = $phoneUtil->getCountryCodeForRegion($regionCode);
+		return $countryCode === 0 ? null : $countryCode;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function convertToStandardFormat(string $input, ?string $defaultRegion = null): ?string {
+		$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();
+		try {
+			$phoneNumber = $phoneUtil->parse($input, $defaultRegion);
+			if ($phoneUtil->isValidNumber($phoneNumber)) {
+				return $phoneUtil->format($phoneNumber, PhoneNumberFormat::E164);
+			}
+		} catch (NumberParseException) {
+		}
+
+		return null;
+	}
+}
diff --git a/lib/private/Server.php b/lib/private/Server.php
index 7ab57478f44..d2a1d890ccd 100644
--- a/lib/private/Server.php
+++ b/lib/private/Server.php
@@ -212,6 +212,7 @@ use OCP\IInitialStateService;
 use OCP\IL10N;
 use OCP\ILogger;
 use OCP\INavigationManager;
+use OCP\IPhoneNumberUtil;
 use OCP\IPreview;
 use OCP\IRequest;
 use OCP\IRequestId;
@@ -1423,6 +1424,8 @@ class Server extends ServerContainer implements IServerContainer {
 
 		$this->registerAlias(ILimiter::class, Limiter::class);
 
+		$this->registerAlias(IPhoneNumberUtil::class, PhoneNumberUtil::class);
+
 		$this->connectDispatcher();
 	}
 
diff --git a/lib/public/IPhoneNumberUtil.php b/lib/public/IPhoneNumberUtil.php
new file mode 100644
index 00000000000..733de0e35a6
--- /dev/null
+++ b/lib/public/IPhoneNumberUtil.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+/**
+ *
+ * @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP;
+
+/**
+ * @since 28.0.0
+ */
+interface IPhoneNumberUtil {
+	/**
+	 * Returns the country code for a specific region
+	 *
+	 * For example, this would be `41` for Switzerland and `49` for Germany.
+	 * Returns null when the region is invalid.
+	 *
+	 * @param string $regionCode Two-letter region code of ISO 3166-1
+	 * @return int|null Null when invalid/unsupported, the phone country code otherwise
+	 * @since 28.0.0
+	 */
+	public function getCountryCodeForRegion(string $regionCode): ?int;
+
+	/**
+	 * Converts a given input into an E164 formatted phone number
+	 *
+	 * E164 is the international format without any formatting characters or spaces.
+	 * E.g. +41446681800 where +41 is the region code.
+	 *
+	 * @param string $input Input phone number can contain formatting spaces, slashes and dashes
+	 * @param string|null $defaultRegion Two-letter region code of ISO 3166-1
+	 * @return string|null Null when the input is invalid for the given region or requires a region.
+	 * @since 28.0.0
+	 */
+	public function convertToStandardFormat(string $input, ?string $defaultRegion = null): ?string;
+}