Add type to store UUIDs as binary (UUID_BINARY)

.github/workflows/ci.yml

@@ -24,33 +24,40 @@ jobs:
                     php-version: '7.4'
                   - symfony-version: '6-max'
                     php-version: '7.4'
+        env:
+            DB_NAME: 'propel_tests'
+            DB_USER: 'propel'
+            DB_PW: 'propel'
         steps:
             - name: Install PostgreSQL latest
-              if: matrix.db-type == 'pgsql' && matrix.php-version != '7.3'
+              if: matrix.db-type == 'pgsql' && matrix.php-version != '7.4'
               uses: CasperWA/[email protected]
               with:
-                  postgresql db: 'propel-tests'
-                  postgresql user: 'postgres'
-                  postgresql password: 'postgres'
+                  postgresql db: $DB_NAME
+                  postgresql user: $DB_USER
+                  postgresql password: $DB_PW
 
             - name: Install PostgreSQL min
-              if: matrix.db-type == 'pgsql' && matrix.php-version == '7.3'
+              if: matrix.db-type == 'pgsql' && matrix.php-version == '7.4'
               uses: CasperWA/[email protected]
               with:
                   postgresql version: 9
-                  postgresql db: 'propel-tests'
-                  postgresql user: 'postgres'
-                  postgresql password: 'postgres'
+                  postgresql db: $DB_NAME
+                  postgresql user: $DB_USER
+                  postgresql password: $DB_PW
 
-            - name: Install MariaDb latest
-              if: matrix.db-type == 'mysql' && matrix.php-version != '7.3'
-              uses: getong/[email protected]
+            - name: Install MySQL latest
+              if: matrix.db-type == 'mysql' && matrix.php-version != '7.4'
+              uses: mirromutth/[email protected]
+              with:
+                  mysql root password: $DB_PW
 
             - name: Install MariaDb min
-              if: matrix.db-type == 'mysql' && matrix.php-version == '7.3'
+              if: matrix.db-type == 'mysql' && matrix.php-version == '7.4'
               uses: getong/[email protected]
               with:
                   mariadb version: '10.2'
+                  mysql root password: $DB_PW
 
             - name: Setup PHP, with composer and extensions
               uses: shivammathur/setup-php@v2
@@ -79,34 +86,39 @@ jobs:
             - name: Composer install (Symfony version ${{ matrix.symfony-version }})
               run: composer install --no-progress --prefer-dist --optimize-autoloader
 
-            - name: Setup Postgresql database for test suite
-              if: matrix.db-type == 'pgsql'
-              run: tests/bin/setup.pgsql.sh
+            - name: Wait for MySQL server to load
+              if: matrix.db-type == 'mysql'
+              run: |
+                bash -c "
+                for i in {1..10}; do
+                  mysqladmin -h 127.0.0.1 -u root status >/dev/null 2>&1 && exit 0 || sleep 6
+                  echo 'trying again'
+                done;
+                echo 'could not establish connection after 10 tries'
+                exit 1
+                "
               env:
-                  DB_NAME: 'propel-tests'
-                  DB_USER: 'postgres'
-                  DB_PW: 'postgres'
+                MYSQL_PWD: ${{ env.DB_PW }}
 
-            - name: Setup the database for test suite
-              if: matrix.db-type != 'agnostic' && matrix.db-type != 'pgsql'
-              run: tests/bin/setup.${{ matrix.db-type }}.sh
-
-            - name: Run PostgreSQL tests
-              if: matrix.db-type == 'pgsql'
-              shell: 'script -q -e -c "bash {0}"'
+            - name: Create MySQL Propel user
+              if: matrix.db-type == 'mysql'
               run: |
-                  if [[ ${{ matrix.php-version }} == '7.4' && ${{ matrix.symfony-version == '5-max' }} ]]; then
-                    export CODECOVERAGE=1 && vendor/bin/phpunit -c tests/pgsql.phpunit.xml --verbose --coverage-clover=tests/coverage.xml
-                  else
-                    vendor/bin/phpunit -c tests/pgsql.phpunit.xml
-                  fi
+                mysql -h 127.0.0.1 -u root -e "
+                  CREATE USER '$DB_USER'@'localhost' IDENTIFIED BY '$DB_PW';
+                  CREATE USER '$DB_USER'@'%' IDENTIFIED BY '$DB_PW';
+                  GRANT ALL PRIVILEGES ON *.* TO '$DB_USER'@'localhost';
+                  GRANT ALL PRIVILEGES ON *.* TO '$DB_USER'@'%';
+                  FLUSH PRIVILEGES;
+                "
               env:
-                  DB_NAME: 'propel-tests'
-                  DB_USER: 'postgres'
-                  DB_PW: 'postgres'
+                MYSQL_PWD: ${{ env.DB_PW }}
+
+            - name: Setup database for test suite
+              if: matrix.db-type != 'agnostic'
+              run: tests/bin/setup.${{ matrix.db-type }}.sh
 
-            - name: Run ${{ matrix.db-type }} tests
-              if: matrix.db-type != 'pgsql'
+            - name: Run database tests
+              if: matrix.db-type != 'agnostic'
               shell: 'script -q -e -c "bash {0}"'
               run: |
                   if [[ ${{ matrix.php-version }} == '7.4' && ${{ matrix.symfony-version == '5-max' }} ]]; then

src/Propel/Generator/Builder/Om/AbstractOMBuilder.php

@@ -18,6 +18,7 @@
 use Propel\Generator\Model\CrossForeignKeys;
 use Propel\Generator\Model\ForeignKey;
 use Propel\Generator\Model\Table;
+use Propel\Generator\Model\VendorInfo;
 
 /**
  * Baseclass for OM-building classes.
@@ -1189,4 +1190,28 @@ abstract protected function addClassBody(string &$script): void;
      * @return void
      */
     abstract protected function addClassClose(string &$script): void;
+
+    /**
+     * Returns the vendor info from the table for the configured platform.
+     *
+     * @return \Propel\Generator\Model\VendorInfo
+     */
+    protected function getVendorInfo(): VendorInfo
+    {
+        $dbVendorId = $this->getPlatform()->getDatabaseType();
+
+        return $this->getTable()->getVendorInfoForType($dbVendorId);
+    }
+
+    /**
+     * @psalm-return 'true'|'false'
+     *
+     * @see \Propel\Generator\Model\VendorInfo::getUuidSwapFlagLiteral()
+     *
+     * @return string
+     */
+    protected function getUuidSwapFlagLiteral(): string
+    {
+        return $this->getVendorInfo()->getUuidSwapFlagLiteral();
+    }
 }

src/Propel/Generator/Builder/Om/ObjectBuilder.php

@@ -323,6 +323,12 @@ protected function addClassBody(string &$script): void
         }
 
         $table = $this->getTable();
+
+        $additionalModelClasses = $table->getAdditionalModelClassImports();
+        if ($additionalModelClasses) {
+            $this->declareClasses(...$additionalModelClasses);
+        }
+
         if (!$table->isAlias()) {
             $this->addConstants($script);
             $this->addAttributes($script);
@@ -1709,6 +1715,13 @@ protected function addLazyLoaderBody(string &$script, Column $column): void
         } elseif ($column->isPhpObjectType()) {
             $script .= "
             \$this->$clo = (\$firstColumn !== null) ? new " . $column->getPhpType() . '($firstColumn) : null;';
+        } elseif ($column->getType() === PropelTypes::UUID_BINARY) {
+            $uuidSwapFlag = $this->getUuidSwapFlagLiteral();
+            $script .= "
+            if (is_resource(\$firstColumn)) {
+                \$firstColumn = stream_get_contents(\$firstColumn);
+            }
+            \$this->$clo = (\$firstColumn) ? UuidConverter::binToUuid(\$firstColumn, $uuidSwapFlag) : null;";
         } else {
             $script .= "
             \$this->$clo = \$firstColumn;";
@@ -2716,6 +2729,13 @@ protected function addHydrateBody(string &$script): void
                     }
                     $script .= "
             \$this->$clo = (null !== \$col) ? PropelDateTime::newInstance(\$col, null, '$dateTimeClass') : null;";
+                } elseif ($col->isUuidBinaryType()) {
+                    $uuidSwapFlag = $this->getUuidSwapFlagLiteral();
+                    $script .= "
+            if (is_resource(\$col)) {
+                \$col = stream_get_contents(\$col);
+            }
+            \$this->$clo = (\$col) ? UuidConverter::binToUuid(\$col, $uuidSwapFlag) : null;";
                 } elseif ($col->isPhpPrimitiveType()) {
                     $script .= "
             \$this->$clo = (null !== \$col) ? (" . $col->getPhpType() . ') $col : null;';
@@ -2745,8 +2765,8 @@ protected function addHydrateBody(string &$script): void
 
         if ($this->getBuildProperty('generator.objectModel.addSaveMethod')) {
             $script .= "
-            \$this->resetModified();
-";
+
+            \$this->resetModified();";
         }
 
         $script .= "
@@ -2950,10 +2970,11 @@ protected function addBuildCriteriaBody(string &$script): void
         \$criteria = new Criteria(" . $this->getTableMapClass() . "::DATABASE_NAME);
 ";
         foreach ($this->getTable()->getColumns() as $col) {
-            $clo = $col->getLowercasedName();
+            $accessValueStatement = $this->getAccessValueStatement($col);
+            $columnConstant = $this->getColumnConstant($col);
             $script .= "
-        if (\$this->isColumnModified(" . $this->getColumnConstant($col) . ")) {
-            \$criteria->add(" . $this->getColumnConstant($col) . ", \$this->$clo);
+        if (\$this->isColumnModified($columnConstant)) {
+            \$criteria->add($columnConstant, $accessValueStatement);
         }";
         }
     }
@@ -6599,12 +6620,15 @@ protected function addDoInsertBodyRaw(): string
             \$stmt = \$con->prepare(\$sql);
             foreach (\$modifiedColumns as \$identifier => \$columnName) {
                 switch (\$columnName) {";
+
+        $tab = '                        ';
         foreach ($table->getColumns() as $column) {
             $columnNameCase = var_export($this->quoteIdentifier($column->getName()), true);
+            $accessValueStatement = $this->getAccessValueStatement($column);
+            $bindValueStatement = $platform->getColumnBindingPHP($column, '$identifier', $accessValueStatement, $tab);
             $script .= "
-                    case $columnNameCase:";
-            $script .= $platform->getColumnBindingPHP($column, '$identifier', '$this->' . $column->getLowercasedName(), '                        ');
-            $script .= "
+                    case $columnNameCase:$bindValueStatement
+
                         break;";
         }
         $script .= "
@@ -6645,6 +6669,30 @@ protected function addDoInsertBodyRaw(): string
         return $script;
     }
 
+    /**
+     * Get the statement how a column value is accessed in the script.
+     *
+     * Note that this is not necessarily just the getter. If the value is
+     * stored on the model in an encoded format, the statement returned by
+     * this method includes the statement to decode the value.
+     *
+     * @param \Propel\Generator\Model\Column $column
+     *
+     * @return string
+     */
+    protected function getAccessValueStatement(Column $column): string
+    {
+        $columnName = $column->getLowercasedName();
+
+        if ($column->isUuidBinaryType()) {
+            $uuidSwapFlag = $this->getUuidSwapFlagLiteral();
+
+            return "(\$this->$columnName) ? UuidConverter::uuidToBin(\$this->$columnName, $uuidSwapFlag) : null";
+        }
+
+        return "\$this->$columnName";
+    }
+
     /**
      * get the doUpdate() method code
      *

src/Propel/Generator/Builder/Om/QueryBuilder.php

@@ -174,6 +174,10 @@ protected function addClassBody(string &$script): void
         );
         $this->declareClassFromBuilder($this->getStubQueryBuilder(), 'Child');
         $this->declareClassFromBuilder($this->getTableMapBuilder());
+        $additionalModelClasses = $table->getAdditionalModelClassImports();
+        if ($additionalModelClasses) {
+            $this->declareClasses(...$additionalModelClasses);
+        }
 
         // apply behaviors
         $this->applyBehaviorModifier('queryAttributes', $script, '    ');
@@ -1147,6 +1151,10 @@ public function filterBy$colPhpName(\$$variableName = null, ?string \$comparison
         if (is_string(\$$variableName)) {
             \$$variableName = in_array(strtolower(\$$variableName), array('false', 'off', '-', 'no', 'n', '0', '')) ? false : true;
         }";
+        } elseif ($col->isUuidBinaryType()) {
+            $uuidSwapFlag = $this->getUuidSwapFlagLiteral();
+            $script .= "
+        \$$variableName = UuidConverter::uuidToBinRecursive(\$$variableName, $uuidSwapFlag);";
         }
         $script .= "
 

src/Propel/Generator/Model/Column.php

@@ -1243,6 +1243,18 @@ public function getType(): string
         return $this->getDomain()->getType();
     }
 
+    /**
+     * Returns the SQL type as a string.
+     *
+     * @see Domain::getSqlType()
+     *
+     * @return string
+     */
+    public function getSqlType(): string
+    {
+        return $this->getDomain()->getSqlType();
+    }
+
     /**
      * Returns the column PDO type integer for this column's mapping type.
      *
@@ -1333,6 +1345,16 @@ public function isUuidType(): bool
         return PropelTypes::isUuidType($this->getType());
     }
 
+    /**
+     * Returns whether this column is a uuid bin type.
+     *
+     * @return bool
+     */
+    public function isUuidBinaryType(): bool
+    {
+        return $this->getType() === PropelTypes::UUID_BINARY;
+    }
+
     /**
      * Returns whether the column is an array column.
      *
@@ -1713,4 +1735,18 @@ public static function generatePhpSingularName(string $phpName): string
     {
         return rtrim($phpName, 's');
     }
+
+    /**
+     * Checks if xml attributes from schema.xml matches expected content declaration.
+     *
+     * @param string $content
+     *
+     * @return bool
+     */
+    public function isContent(string $content): bool
+    {
+        $contentAttribute = $this->getAttribute('content');
+
+        return $contentAttribute && strtoupper($contentAttribute) === strtoupper($contentAttribute);
+    }
 }