vendor/jackalope/jackalope-doctrine-dbal/src/Jackalope/Transport/DoctrineDBAL/RepositorySchema.php line 34

  1. <?php
  3. namespace Jackalope\Transport\DoctrineDBAL;
  5. use Doctrine\DBAL\Exception;
  6. use Doctrine\DBAL\Schema\Schema;
  7. use Doctrine\DBAL\Connection;
  8. use Doctrine\DBAL\Schema\Table;
  9. use PHPCR\RepositoryException;
  11. /**
  12.  * Class to handle setup the RDBMS tables for the Doctrine DBAL transport.
  13.  *
  14.  * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
  15.  * @license http://opensource.org/licenses/MIT MIT License
  16.  */
  17. class RepositorySchema extends Schema
  18. {
  19.     /**
  20.      * @var Connection
  21.      */
  22.     private $connection;
  24.     /**
  25.      * @var integer
  26.      */
  27.     private $maxIndexLength = -1;
  29.     /**
  30.      * @param array $options The options could be use to make the table
  31.      *                               names configurable.
  32.      * @param Connection $connection
  33.      */
  34.     public function __construct(array $options = [], Connection $connection = null)
  35.     {
  36.         $this->connection = $connection;
  37.         $schemaConfig = null === $connection ? null : $connection->getSchemaManager()->createSchemaConfig();
  39.         parent::__construct([], [], $schemaConfig);
  41.         $this->options = $options;
  43.         $this->addNamespacesTable();
  44.         $this->addWorkspacesTable();
  45.         $nodes = $this->addNodesTable();
  46.         $this->addInternalIndexTypesTable();
  47.         $this->addBinaryDataTable();
  48.         $this->addNodesReferencesTable($nodes);
  49.         $this->addNodesWeakreferencesTable($nodes);
  50.         $this->addTypeNodesTable();
  51.         $this->addTypePropsTable();
  52.         $this->addTypeChildsTable();
  53.     }
  55.     /**
  56.      * Merges Jackalope schema with the given schema.
  57.      *
  58.      * @param Schema $schema
  59.      */
  60.     public function addToSchema(Schema $schema)
  61.     {
  62.         foreach ($this->getTables() as $table) {
  63.             $schema->_addTable($table);
  64.         }
  66.         foreach ($this->getSequences() as $sequence) {
  67.             $schema->_addSequence($sequence);
  68.         }
  69.     }
  71.     protected function addNamespacesTable()
  72.     {
  73.         $namespace = $this->createTable('phpcr_namespaces');
  74.         $namespace->addColumn('prefix', 'string', ['length' => $this->getMaxIndexLength()]);
  75.         $namespace->addColumn('uri', 'string');
  76.         $namespace->setPrimaryKey(['prefix']);
  77.     }
  79.     protected function addWorkspacesTable()
  80.     {
  81.         $workspace = $this->createTable('phpcr_workspaces');
  82.         $workspace->addColumn('name', 'string', ['length' => $this->getMaxIndexLength()]);
  83.         $workspace->setPrimaryKey(['name']);
  84.     }
  86.     /**
  87.      * @return Table
  88.      */
  89.     protected function addNodesTable()
  90.     {
  91.         // TODO increase the size of 'path' and 'parent' but this causes issues on MySQL due to key length
  92.         $nodes = $this->createTable('phpcr_nodes');
  93.         $nodes->addColumn('id', 'integer', ['autoincrement' => true]);
  94.         $nodes->addColumn('path', 'string', ['length' => $this->getMaxIndexLength()]);
  95.         $nodes->addColumn('parent', 'string', ['length' => $this->getMaxIndexLength()]);
  96.         $nodes->addColumn('local_name', 'string', ['length' => $this->getMaxIndexLength()]);
  97.         $nodes->addColumn('namespace', 'string', ['length' => $this->getMaxIndexLength()]);
  98.         $nodes->addColumn('workspace_name', 'string', ['length' => $this->getMaxIndexLength()]);
  99.         $nodes->addColumn('identifier', 'string', ['length' => $this->getMaxIndexLength()]);
  100.         $nodes->addColumn('type', 'string', ['length' => $this->getMaxIndexLength()]);
  101.         $nodes->addColumn('props', 'text');
  102.         $nodes->addColumn('numerical_props', 'text', ['notnull' => false]);
  103.         $nodes->addColumn('depth', 'integer');
  104.         $nodes->addColumn('sort_order', 'integer', ['notnull' => false]);
  105.         $nodes->setPrimaryKey(['id']);
  106.         $nodes->addUniqueIndex(['path', 'workspace_name']);
  107.         $nodes->addUniqueIndex(['identifier', 'workspace_name']);
  108.         $nodes->addIndex(['parent']);
  109.         $nodes->addIndex(['type']);
  110.         $nodes->addIndex(['local_name', 'namespace']);
  112.         return $nodes;
  113.     }
  115.     protected function addInternalIndexTypesTable()
  116.     {
  117.         $indexJcrTypes = $this->createTable('phpcr_internal_index_types');
  118.         $indexJcrTypes->addColumn('type', 'string', ['length' => $this->getMaxIndexLength()]);
  119.         $indexJcrTypes->addColumn('node_id', 'integer', ['length' => $this->getMaxIndexLength()]);
  120.         $indexJcrTypes->setPrimaryKey(['type', 'node_id']);
  121.     }
  123.     protected function addBinaryDataTable()
  124.     {
  125.         $binary = $this->createTable('phpcr_binarydata');
  126.         $binary->addColumn('id', 'integer', ['autoincrement' => true]);
  127.         $binary->addColumn('node_id', 'integer');
  128.         $binary->addColumn('property_name', 'string', ['length' => $this->getMaxIndexLength()]);
  129.         $binary->addColumn('workspace_name', 'string', ['length' => $this->getMaxIndexLength()]);
  130.         $binary->addColumn('idx', 'integer', ['default' => 0]);
  131.         $binary->addColumn('data', 'blob');
  132.         $binary->setPrimaryKey(['id']);
  133.         $binary->addUniqueIndex(['node_id', 'property_name', 'workspace_name', 'idx']);
  134.     }
  136.     protected function addNodesReferencesTable(Table $nodes)
  137.     {
  138.         $references = $this->createTable('phpcr_nodes_references');
  139.         $references->addColumn('source_id', 'integer');
  140.         $references->addColumn('source_property_name', 'string', ['length' => $this->getMaxIndexLength(220)]);
  141.         $references->addColumn('target_id', 'integer');
  142.         $references->setPrimaryKey(['source_id', 'source_property_name', 'target_id']);
  143.         $references->addIndex(['target_id']);
  144.         if (!empty($this->options['disable_fk'])) {
  145.             $references->addForeignKeyConstraint($nodes, ['source_id'], ['id'], ['onDelete' => 'CASCADE']);
  146.             // TODO: this should be reenabled on RDBMS with deferred FK support
  147.             //$references->addForeignKeyConstraint($nodes, array('target_id'), array('id'));
  148.         }
  149.     }
  151.     protected function addNodesWeakreferencesTable(Table $nodes)
  152.     {
  153.         $weakreferences = $this->createTable('phpcr_nodes_weakreferences');
  154.         $weakreferences->addColumn('source_id', 'integer');
  155.         $weakreferences->addColumn('source_property_name', 'string', ['length' => $this->getMaxIndexLength(220)]);
  156.         $weakreferences->addColumn('target_id', 'integer');
  157.         $weakreferences->setPrimaryKey(['source_id', 'source_property_name', 'target_id']);
  158.         $weakreferences->addIndex(['target_id']);
  159.         if (!empty($this->options['disable_fk'])) {
  160.             $weakreferences->addForeignKeyConstraint($nodes, ['source_id'], ['id'], ['onDelete' => 'CASCADE']);
  161.             $weakreferences->addForeignKeyConstraint($nodes, ['target_id'], ['id'], ['onDelete' => 'CASCADE']);
  162.         }
  163.     }
  165.     protected function addTypeNodesTable()
  166.     {
  167.         $types = $this->createTable('phpcr_type_nodes');
  168.         $types->addColumn('node_type_id', 'integer', ['autoincrement' => true]);
  169.         $types->addColumn('name', 'string', ['length' => $this->getMaxIndexLength()]);
  170.         $types->addColumn('supertypes', 'string');
  171.         $types->addColumn('is_abstract', 'boolean');
  172.         $types->addColumn('is_mixin', 'boolean');
  173.         $types->addColumn('queryable', 'boolean');
  174.         $types->addColumn('orderable_child_nodes', 'boolean');
  175.         $types->addColumn('primary_item', 'string', ['notnull' => false]);
  176.         $types->setPrimaryKey(['node_type_id']);
  177.         $types->addUniqueIndex(['name']);
  178.     }
  180.     protected function addTypePropsTable()
  181.     {
  182.         $propTypes = $this->createTable('phpcr_type_props');
  183.         $propTypes->addColumn('node_type_id', 'integer');
  184.         $propTypes->addColumn('name', 'string', ['length' => $this->getMaxIndexLength()]);
  185.         $propTypes->addColumn('protected', 'boolean');
  186.         $propTypes->addColumn('auto_created', 'boolean');
  187.         $propTypes->addColumn('mandatory', 'boolean');
  188.         $propTypes->addColumn('on_parent_version', 'integer');
  189.         $propTypes->addcolumn('multiple', 'boolean');
  190.         $propTypes->addColumn('fulltext_searchable', 'boolean');
  191.         $propTypes->addcolumn('query_orderable', 'boolean');
  192.         $propTypes->addColumn('required_type', 'integer');
  193.         $propTypes->addColumn('query_operators', 'integer'); // BITMASK
  194.         $propTypes->addColumn('default_value', 'string', ['notnull' => false]);
  195.         $propTypes->setPrimaryKey(['node_type_id', 'name']);
  196.     }
  198.     protected function addTypeChildsTable()
  199.     {
  200.         $childTypes = $this->createTable('phpcr_type_childs');
  201.         $childTypes->addColumn('id', 'integer', ['autoincrement' => true]);
  202.         $childTypes->addColumn('node_type_id', 'integer');
  203.         $childTypes->addColumn('name', 'string');
  204.         $childTypes->addColumn('protected', 'boolean');
  205.         $childTypes->addColumn('auto_created', 'boolean');
  206.         $childTypes->addColumn('mandatory', 'boolean');
  207.         $childTypes->addColumn('on_parent_version', 'integer');
  208.         $childTypes->addColumn('primary_types', 'string');
  209.         $childTypes->addColumn('default_type', 'string', ['notnull' => false]);
  210.         $childTypes->setPrimaryKey(['id']);
  211.     }
  213.     public function reset()
  214.     {
  215.         if (null === $this->connection) {
  216.             throw new RepositoryException('Do not use RepositorySchema::reset when not instantiated with a connection');
  217.         }
  219.         foreach ($this->toDropSql($this->connection->getDatabasePlatform()) as $sql) {
  220.             try {
  221.                 $this->connection->executeStatement($sql);
  222.             } catch (Exception $exception) {
  223.                 // do nothing
  224.             }
  225.         }
  227.         foreach ($this->toSql($this->connection->getDatabasePlatform()) as $sql) {
  228.             $this->connection->executeStatement($sql);
  229.         }
  230.     }
  232.     private function getMaxIndexLength($currentMaxLength = null)
  233.     {
  234.         if (-1 === $this->maxIndexLength) {
  235.             $this->maxIndexLength = null;
  237.             if ($this->isConnectionCharsetUtf8mb4()) {
  238.                 $this->maxIndexLength = 191;
  239.             }
  240.         }
  242.         if ($currentMaxLength && (
  243.             null === $this->maxIndexLength
  244.             || $currentMaxLength < $this->maxIndexLength
  245.         )) {
  246.             return $currentMaxLength;
  247.         }
  249.         return $this->maxIndexLength;
  250.     }
  252.     private function isConnectionCharsetUtf8mb4()
  253.     {
  254.         if (!$this->connection) {
  255.             return false;
  256.         }
  258.         $databaseParameters = $this->connection->getParams();
  260.         return isset($databaseParameters['charset']) && 'utf8mb4' === strtolower($databaseParameters['charset']);
  261.     }
  262. }