REL-1198: List value URI definition should work with neo4j RDF storage.

common/class.Utils.php

@@ -57,7 +57,7 @@ class common_Utils
      * @access public
      * @author Joel Bout, <[email protected]>
      * @param  string strarg
-     * @return boolean
+     * @return bool
      */
     public static function isUri($strarg)
     {

common/persistence/Graph/BasicTransactionManager.php

@@ -0,0 +1,107 @@
+<?php
+
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2023 (original work) Open Assessment Technologies SA;
+ *
+ */
+
+namespace oat\generis\persistence\Graph;
+
+use Laudis\Neo4j\Contracts\ClientInterface;
+use Laudis\Neo4j\Contracts\UnmanagedTransactionInterface;
+use Laudis\Neo4j\Databags\Statement;
+use Laudis\Neo4j\Databags\SummarizedResult;
+
+class BasicTransactionManager implements TransactionManagerInterface
+{
+    private ClientInterface $client;
+    private UnmanagedTransactionInterface $transaction;
+
+    public function __construct(ClientInterface $client)
+    {
+        $this->client = $client;
+    }
+
+    public function beginTransaction(): void
+    {
+        try {
+            $this->transaction = $this->client->beginTransaction();
+        } catch (\Throwable $e) {
+            throw new GraphTransactionException('Transaction was not started.', $e);
+        }
+    }
+
+    public function commit(): void
+    {
+        try {
+            if (isset($this->transaction)) {
+                $this->transaction->commit();
+                unset($this->transaction);
+            }
+        } catch (\Throwable $e) {
+            throw new GraphTransactionException('Transaction was not committed.', $e);
+        }
+    }
+
+    public function rollback(): void
+    {
+        try {
+            if (isset($this->transaction)) {
+                $this->transaction->rollback();
+                unset($this->transaction);
+            }
+        } catch (\Throwable $e) {
+            throw new GraphTransactionException('Transaction was not rolled back.', $e);
+        }
+    }
+
+    public function run(string $statement, iterable $parameters = []): SummarizedResult
+    {
+        try {
+            if (isset($this->transaction)) {
+                $result = $this->transaction->run($statement, $parameters);
+            } else {
+                $result = $this->client->run($statement, $parameters);
+            }
+        } catch (\Throwable $e) {
+            throw new GraphTransactionException(
+                sprintf('Exception happen during query run: %s.', $e->getMessage()),
+                $e
+            );
+        }
+
+        return $result;
+    }
+
+    public function runStatement(Statement $statement): SummarizedResult
+    {
+        try {
+            if (isset($this->transaction)) {
+                $result = $this->transaction->runStatement($statement);
+            } else {
+                $result = $this->client->runStatement($statement);
+            }
+        } catch (\Throwable $e) {
+            throw new GraphTransactionException(
+                sprintf('Exception happen during statement run: %s.', $e->getMessage()),
+                $e
+            );
+        }
+
+        return $result;
+    }
+}

common/persistence/Graph/GraphTransactionException.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2023 (original work) Open Assessment Technologies SA;
+ *
+ */
+
+namespace oat\generis\persistence\Graph;
+
+class GraphTransactionException extends \RuntimeException
+{
+    public function __construct($message = "", \Throwable $previous = null)
+    {
+        parent::__construct($message, 0, $previous);
+    }
+}

common/persistence/Graph/NestedTransactionWrapper.php

@@ -0,0 +1,91 @@
+<?php
+
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2023 (original work) Open Assessment Technologies SA;
+ *
+ */
+
+namespace oat\generis\persistence\Graph;
+
+use Laudis\Neo4j\Databags\Statement;
+use Laudis\Neo4j\Databags\SummarizedResult;
+
+class NestedTransactionWrapper implements TransactionManagerInterface
+{
+    private TransactionManagerInterface $nestedTransactionManager;
+    private int $transactionNestingLevel = 0;
+    private bool $isRollbackOnly = false;
+
+    public function __construct(TransactionManagerInterface $nestedManager)
+    {
+        $this->nestedTransactionManager = $nestedManager;
+    }
+
+    public function beginTransaction(): void
+    {
+        $this->transactionNestingLevel++;
+
+        if ($this->transactionNestingLevel === 1) {
+            $this->nestedTransactionManager->beginTransaction();
+        }
+    }
+
+    public function commit(): void
+    {
+        if ($this->transactionNestingLevel === 0) {
+            throw new GraphTransactionException('Transaction should be started first.');
+        }
+
+        if ($this->isRollbackOnly) {
+            throw new GraphTransactionException(
+                'Nested transaction failed, so all data should be rolled back now.'
+            );
+        }
+
+        if ($this->transactionNestingLevel === 1) {
+            $this->nestedTransactionManager->commit();
+        }
+
+        $this->transactionNestingLevel--;
+    }
+
+    public function rollback(): void
+    {
+        if ($this->transactionNestingLevel === 0) {
+            throw new GraphTransactionException('Transaction should be started first.');
+        }
+
+        if ($this->transactionNestingLevel === 1) {
+            $this->nestedTransactionManager->rollBack();
+            $this->isRollbackOnly = false;
+        } else {
+            $this->isRollbackOnly = true;
+        }
+
+        $this->transactionNestingLevel--;
+    }
+
+    public function run(string $statement, iterable $parameters = []): SummarizedResult
+    {
+        return $this->nestedTransactionManager->run($statement, $parameters);
+    }
+
+    public function runStatement(Statement $statement): SummarizedResult
+    {
+        return $this->nestedTransactionManager->runStatement($statement);
+    }
+}

common/persistence/Graph/TransactionManagerInterface.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2023 (original work) Open Assessment Technologies SA;
+ *
+ */
+
+namespace oat\generis\persistence\Graph;
+
+use Laudis\Neo4j\Databags\Statement;
+use Laudis\Neo4j\Databags\SummarizedResult;
+
+interface TransactionManagerInterface
+{
+    /**
+     * @return void
+     *
+     * @throws GraphTransactionException when starting transaction failed.
+     */
+    public function beginTransaction(): void;
+
+    /**
+     * @return void
+     *
+     * @throws GraphTransactionException when transaction commit failed.
+     */
+    public function commit(): void;
+
+    /**
+     * @return void
+     *
+     * @throws GraphTransactionException when transaction was not rolled back.
+     */
+    public function rollback(): void;
+
+    /**
+     * @param string $statement
+     * @param iterable $parameters
+     *
+     * @return SummarizedResult
+     *
+     * @throws GraphTransactionException
+     */
+    public function run(string $statement, iterable $parameters = []): SummarizedResult;
+
+    /**
+     * @param Statement $statement
+     *
+     * @return SummarizedResult
+     *
+     * @throws GraphTransactionException
+     */
+    public function runStatement(Statement $statement): SummarizedResult;
+}

common/persistence/PersistenceManager.php

@@ -27,6 +27,7 @@
 use common_persistence_SqlPersistence;
 use oat\generis\persistence\sql\SchemaProviderInterface;
 use oat\oatbox\service\ServiceNotFoundException;
+use common_persistence_PhpNeo4jDriver;
 
 /**
  * The PersistenceManager is responsible for initializing all persistences
@@ -51,6 +52,7 @@ class PersistenceManager extends ConfigurableService
         'dbal_pdo_sqlite' => 'common_persistence_sql_dbal_Driver',
         'dbal_pdo_pgsql' => 'common_persistence_sql_dbal_Driver',
         'dbal_pdo_ibm' => 'common_persistence_sql_dbal_Driver',
+        'phpneo4j' => 'common_persistence_PhpNeo4jDriver',
         'phpredis' => 'common_persistence_PhpRedisDriver',
         'phpfile' => 'common_persistence_PhpFileDriver',
         'SqlKvWrapper' => 'common_persistence_SqlKvDriver',

common/persistence/class.GraphPersistence.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2023 (original work) Open Assessment Technologies SA ;
+ */
+
+declare(strict_types=1);
+
+use Laudis\Neo4j\Contracts\ClientInterface;
+use Laudis\Neo4j\Databags\Statement;
+use Laudis\Neo4j\Databags\SummarizedResult;
+use oat\generis\persistence\Graph\BasicTransactionManager;
+use oat\generis\persistence\Graph\NestedTransactionWrapper;
+use oat\generis\persistence\Graph\TransactionManagerInterface;
+
+class common_persistence_GraphPersistence extends common_persistence_Persistence implements
+    common_persistence_Transactional
+{
+    private TransactionManagerInterface $transactionManager;
+
+    public function run(string $statement, iterable $parameters = []): SummarizedResult
+    {
+        return $this->getConnection()->run($statement, $parameters);
+    }
+
+    public function runStatement(Statement $statement): SummarizedResult
+    {
+        return $this->getConnection()->runStatement($statement);
+    }
+
+    public function transactional(Closure $func)
+    {
+        $transactionManager = $this->getConnection();
+
+        $transactionManager->beginTransaction();
+        try {
+            $res = $func();
+            $transactionManager->commit();
+
+            return $res;
+        } catch (\Throwable $e) {
+            $transactionManager->rollBack();
+
+            throw $e;
+        }
+    }
+
+    private function getConnection(): TransactionManagerInterface
+    {
+        if (!isset($this->transactionManager)) {
+            /** @var ClientInterface $client */
+            $client = $this->getDriver()->getClient();
+            $this->transactionManager = new NestedTransactionWrapper(
+                new BasicTransactionManager($client)
+            );
+        }
+
+        return $this->transactionManager;
+    }
+}