From db32a5fcfc852644c4d6facfbf1a77bdefcd8ee5 Mon Sep 17 00:00:00 2001
From: Hugo Sales <hugo@fc.up.pt>
Date: Sun, 26 Jul 2020 00:18:15 +0000
Subject: [PATCH] [DATABASE][TOOLS] Update local_user, SchemaDefDriver and
 bin/generate_entity_fields to use the phone_number type (which maps to a
 varchar 35 and does validation)

---
 bin/generate_entity_fields      | 23 ++++++++++++-----------
 src/Core/DB/SchemaDefDriver.php | 23 ++++++++++++-----------
 src/Entity/LocalUser.php        | 14 +++++++-------
 3 files changed, 31 insertions(+), 29 deletions(-)

diff --git a/bin/generate_entity_fields b/bin/generate_entity_fields
index d450472296..26213da734 100755
--- a/bin/generate_entity_fields
+++ b/bin/generate_entity_fields
@@ -9,17 +9,18 @@ define('ROOT', dirname(__DIR__));
 require ROOT . '/vendor/autoload.php';
 
 const types = [
-    'blob'      => '',
-    'bool'      => 'bool',
-    'char'      => 'string',
-    'datetime'  => '\DateTimeInterface',
-    'timestamp' => '\DateTimeInterface',
-    'html'      => 'string',
-    'int'       => 'int',
-    'numeric'   => 'float',
-    'serial'    => 'int',
-    'text'      => 'string',
-    'varchar'   => 'string',
+    'blob'         => '',
+    'bool'         => 'bool',
+    'char'         => 'string',
+    'datetime'     => '\DateTimeInterface',
+    'timestamp'    => '\DateTimeInterface',
+    'html'         => 'string',
+    'int'          => 'int',
+    'numeric'      => 'float',
+    'serial'       => 'int',
+    'text'         => 'string',
+    'varchar'      => 'string',
+    'phone_number' => 'PhoneNumberType',
 ];
 
 $path = Yaml::parseFile(ROOT . '/config/services.yaml')['services']['app.core.schemadef_driver']['arguments'][0];
diff --git a/src/Core/DB/SchemaDefDriver.php b/src/Core/DB/SchemaDefDriver.php
index b26ba1d188..8af09be152 100644
--- a/src/Core/DB/SchemaDefDriver.php
+++ b/src/Core/DB/SchemaDefDriver.php
@@ -40,17 +40,18 @@ class SchemaDefDriver extends StaticPHPDriver
      * V2 DB type => Doctrine type
      */
     private const types = [
-        'varchar'   => 'string',
-        'char'      => 'string', // char is a fixed witdh varchar
-        'int'       => 'integer',
-        'serial'    => 'integer',
-        'tinyint'   => 'smallint', // no portable tinyint
-        'bigint'    => 'bigint',
-        'bool'      => 'boolean',
-        'numeric'   => 'decimal',
-        'text'      => 'text',
-        'datetime'  => 'datetime',
-        'timestamp' => 'datetime',
+        'varchar'      => 'string',
+        'char'         => 'string', // char is a fixed witdh varchar
+        'int'          => 'integer',
+        'serial'       => 'integer',
+        'tinyint'      => 'smallint', // no portable tinyint
+        'bigint'       => 'bigint',
+        'bool'         => 'boolean',
+        'numeric'      => 'decimal',
+        'text'         => 'text',
+        'datetime'     => 'datetime',
+        'timestamp'    => 'datetime',
+        'phone_number' => 'phone_number',
         // Unused in V2, but might start being used
         'date'        => 'date',
         'time'        => 'time',
diff --git a/src/Entity/LocalUser.php b/src/Entity/LocalUser.php
index 5722484229..b9ea25dd69 100644
--- a/src/Entity/LocalUser.php
+++ b/src/Entity/LocalUser.php
@@ -52,7 +52,7 @@ class LocalUser implements UserInterface
     private ?bool $is_email_verified;
     private ?string $language;
     private ?string $timezone;
-    private ?string $sms_phone_number;
+    private ?PhoneNumberType $phone_number;
     private ?int $sms_carrier;
     private ?string $sms_email;
     private ?string $uri;
@@ -132,14 +132,14 @@ class LocalUser implements UserInterface
         return $this->timezone;
     }
 
-    public function setSmsPhoneNumber(?string $sms_phone_number): self
+    public function setPhoneNumber(?PhoneNumberType $phone_number): self
     {
-        $this->sms_phone_number = $sms_phone_number;
+        $this->phone_number = $phone_number;
         return $this;
     }
-    public function getSmsPhoneNumber(): ?string
+    public function getPhoneNumber(): ?PhoneNumberType
     {
-        return $this->sms_phone_number;
+        return $this->phone_number;
     }
 
     public function setSmsCarrier(?int $sms_carrier): self
@@ -248,7 +248,7 @@ class LocalUser implements UserInterface
                 'is_email_verified' => ['type' => 'bool', 'default' => false, 'description' => 'Whether the user opened the comfirmation email'],
                 'language'          => ['type' => 'varchar', 'length' => 50,  'description' => 'preferred language'],
                 'timezone'          => ['type' => 'varchar', 'length' => 50,  'description' => 'timezone'],
-                'sms_phone_number'  => ['type' => 'varchar', 'length' => 64,  'description' => 'sms phone number'],
+                'phone_number'      => ['type' => 'phone_number', 'description' => 'phone number'],
                 'sms_carrier'       => ['type' => 'int', 'description' => 'foreign key to sms_carrier'],
                 'sms_email'         => ['type' => 'varchar', 'length' => 191, 'description' => 'built from sms and carrier (see sms_carrier)'],
                 'uri'               => ['type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier, usually a tag URI'],
@@ -262,7 +262,7 @@ class LocalUser implements UserInterface
             'unique keys' => [
                 'user_outgoing_email_key' => ['outgoing_email'],
                 'user_incoming_email_key' => ['incoming_email'],
-                'user_sms_key'            => ['sms_phone_number'],
+                'user_phone_number_key'   => ['phone_number'],
                 'user_uri_key'            => ['uri'],
             ],
             'foreign keys' => [