From: Raphaël Gertz <git@rapsys.eu>
Date: Thu, 14 Nov 2024 07:47:35 +0000 (+0100)
Subject: Add element repository class with findOneByUidIdPathAsArray method
X-Git-Tag: 0.0.8~6
X-Git-Url: https://git.rapsys.eu/treebundle/commitdiff_plain/863d7cd4e4fa5ff8935b8575f219be5cfabc0e98

Add element repository class with findOneByUidIdPathAsArray method
---

diff --git a/Repository/ElementRepository.php b/Repository/ElementRepository.php
new file mode 100644
index 0000000..c341517
--- /dev/null
+++ b/Repository/ElementRepository.php
@@ -0,0 +1,197 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys TreeBundle package.
+ *
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Rapsys\TreeBundle\Repository;
+
+use Doctrine\ORM\Query\ResultSetMapping;
+
+use Rapsys\TreeBundle\Repository;
+
+/**
+ * Element repository
+ */
+class ElementRepository extends Repository {
+	/**
+	 * Find element as array
+	 *
+	 * @param ?integer $uid The user id
+	 * @param integer $id The element id
+	 * @param string $path The element path
+	 * @return ?array The element array
+	 */
+	public function findOneByUidIdPathAsArray(?int $uid, int $id, string $path): ?array {
+		//Set the request
+		$req = <<<SQL
+SELECT
+	e.id,
+	e.path,
+	GREATEST(a.created, e.created) AS created,
+	GREATEST(a.updated, e.updated) AS updated,
+	GREATEST(a.created, e.created, a.updated, e.updated) AS modified,
+	a.id AS a_id,
+	a.path AS a_path,
+	a.slug AS a_slug
+FROM Rapsys\TreeBundle\Entity\Element AS e
+JOIN Rapsys\TreeBundle\Entity\Album AS a ON (a.id = e.album_id)
+WHERE e.id = :id AND e.path = SUBSTR(:path, 1, LENGTH(e.path)) AND e.user_id IN (NULL, :uid)
+SQL;
+
+		//Replace bundle entity name by table name
+		$req = $this->replace($req);
+
+		//Get result set mapping instance
+		$rsm = new ResultSetMapping();
+
+		//Declare all fields
+		//XXX: see vendor/doctrine/dbal/lib/Doctrine/DBAL/Types/Types.php
+		//addScalarResult($sqlColName, $resColName, $type = 'string');
+		$rsm->addScalarResult('id', 'id', 'integer')
+			->addScalarResult('path', 'path', 'string')
+			->addScalarResult('created', 'created', 'datetime')
+			->addScalarResult('updated', 'updated', 'datetime')
+			->addScalarResult('modified', 'modified', 'datetime')
+			->addScalarResult('a_id', 'a_id', 'integer')
+			->addScalarResult('a_path', 'a_path', 'string')
+			->addScalarResult('a_slug', 'a_slug', 'string')
+			->addIndexByScalar('id');
+
+		//Get result
+		$result = $this->_em
+			->createNativeQuery($req, $rsm)
+			->setParameter('uid', $uid)
+			->setParameter('id', $id)
+			->setParameter('path', $path)
+			->getOneOrNullResult();
+
+		//Check result
+		if (
+			//Without result
+			$result === null ||
+			//Without realpath
+			!($realpath = realpath($result['a_path'].($path?DIRECTORY_SEPARATOR.$path:''))) ||
+			//Realpath not matching element path
+			$result['a_path'].($result['path']?DIRECTORY_SEPARATOR.$result['path']:'') !== substr($realpath, 0, strlen($result['a_path'].($result['path']?DIRECTORY_SEPARATOR.$result['path']:'')))
+		) {
+			//Return null
+			return null;
+		}
+
+		//Set breadcrumbs
+		$breadcrumbs = [
+			//Add album
+			[
+				'name' => ucfirst($result['a_slug']),
+				'link' => $alink = $this->router->generate('rapsystree_album', [ 'id' => $result['a_id'], 'path' => '', 'slug' => $result['a_slug'] ])
+			],
+			//Add element
+			[
+				'name' => $name = trim(str_replace('/', ' / ', '/'.$result['path'])),
+				'link' => $link = $this->router->generate('rapsystree_element', [ 'id' => $result['id'], 'path' => $result['path'] ])
+			]
+		];
+
+		//Set base
+		$base = $result['path'];
+
+		//Iterate on intermediate breadcrumbs
+		foreach(array_slice(explode('/', substr($realpath, strlen($result['a_path'].($result['path']?DIRECTORY_SEPARATOR.$result['path']:'')))), 1) as $value) {
+			//Add breadcrumb
+			$breadcrumbs[] = [
+				'name' => ($base == '' ? '' : '/ ').$value,
+				'link' => $this->router->generate('rapsystree_element', [ 'id' => $result['id'], 'path' => ($base .= ($base == '' ? '' : '/').$value) ])
+			];
+		}
+
+		//Set directories
+		$directories = [];
+
+		//Set files
+		$files = [];
+
+		//Set file
+		$file = [];
+
+		//With directory
+		if (is_dir($realpath)) {
+			//Iterate on directory
+			foreach(array_diff(scandir($realpath), ['.', '..']) as $item) {
+				//TODO: exclude .svn, .git, .passwd, .*.un~, etc... (if not already protected by haproxy/apache)
+
+				//Check item
+				if (
+					//Without item realpath
+					!($itempath = realpath($realpath.DIRECTORY_SEPARATOR.$item)) ||
+					//Item realpath not matching element path
+					$result['a_path'].($result['path']?DIRECTORY_SEPARATOR.$result['path']:'') !== substr($itempath, 0, strlen($result['a_path'].($result['path']?DIRECTORY_SEPARATOR.$result['path']:'')))
+				) {
+					//Skip
+					continue;
+				}
+
+				//With directory
+				if (is_dir($itempath)) {
+					//Append directory
+					$directories[$item.'/'] = $this->router->generate('rapsystree_element', [ 'id' => $result['id'], 'path' => $path.'/'.$item ]);
+				//With file
+				} elseif (is_file($itempath)) {
+					//Get file infos
+					$fileinfos = $this->file->infos($itempath);
+
+					//Append file
+					$files[$fileinfos['name']] = [
+						//Set link
+						'link' => $this->router->generate('rapsystree_element', [ 'id' => $result['id'], 'path' => $path.'/'.$item ])
+					]+$fileinfos;
+				//With unknown type
+				} else {
+					//Throw 404
+					throw new \Exception('Unknown element item type');
+				}
+			}
+		//With file
+		} elseif (is_file($realpath)) {
+			//Get file infos
+			$fileinfos = $this->file->infos($realpath);
+
+			//Append file
+			$file = [
+				//Set link
+				'link' => $this->router->generate('rapsystree_element', [ 'id' => $result['id'], 'path' => $path ])
+			]+$fileinfos;
+		//With unknown type
+		} else {
+			//Throw 404
+			throw new \Exception('Unknown element type');
+		}
+
+		//Return element
+		return [
+			'id' => $result['id'],
+			'name' => $name,
+			'path' => $result['path'],
+			'realpath' => $realpath,
+			'link' => $link,
+			'created' => $result['created'],
+			'updated' => $result['updated'],
+			'modified' => $result['modified'],
+			'album' => [
+				'id' => $result['a_id'],
+				'path' => $result['a_path'],
+				'slug' => $result['a_slug'],
+				'link' => $alink
+			],
+			'breadcrumbs' => $breadcrumbs,
+			'directories' => $directories,
+			'files' => $files,
+			'file' => $file
+		];
+	}
+}
diff --git a/config/doctrine/Element.orm.yml b/config/doctrine/Element.orm.yml
index bfd9d7b..208d299 100644
--- a/config/doctrine/Element.orm.yml
+++ b/config/doctrine/Element.orm.yml
@@ -1,6 +1,6 @@
 Rapsys\TreeBundle\Entity\Element:
     type: entity
-    #repositoryClass: Rapsys\TreeBundle\Repository\ElementRepository
+    repositoryClass: Rapsys\TreeBundle\Repository\ElementRepository
     table: elements
     id:
         id: