NC app base

lib/AppInfo/Application.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\AppInfo;
+
+use OCP\AppFramework\App;
+
+class Application extends App {
+	public const APP_ID = 'nezd';
+
+	public function __construct() {
+		parent::__construct(self::APP_ID);
+	}
+}

lib/Controller/Errors.php

@@ -0,0 +1,24 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Controller;
+
+use Closure;
+
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataResponse;
+
+use OCA\Nezd\Service\NoteNotFound;
+
+trait Errors {
+	protected function handleNotFound(Closure $callback): DataResponse {
+		try {
+			return new DataResponse($callback());
+		} catch (NoteNotFound $e) {
+			$message = ['message' => $e->getMessage()];
+			return new DataResponse($message, Http::STATUS_NOT_FOUND);
+		}
+	}
+}

lib/Controller/NoteApiController.php

@@ -0,0 +1,80 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Controller;
+
+use OCA\Nezd\AppInfo\Application;
+use OCA\Nezd\Service\NoteService;
+use OCP\AppFramework\ApiController;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\IRequest;
+
+class NoteApiController extends ApiController {
+	private NoteService $service;
+	private ?string $userId;
+
+	use Errors;
+
+	public function __construct(IRequest $request,
+								NoteService $service,
+								?string $userId) {
+		parent::__construct(Application::APP_ID, $request);
+		$this->service = $service;
+		$this->userId = $userId;
+	}
+
+	/**
+	 * @CORS
+	 * @NoCSRFRequired
+	 * @NoAdminRequired
+	 */
+	public function index(): DataResponse {
+		return new DataResponse($this->service->findAll($this->userId));
+	}
+
+	/**
+	 * @CORS
+	 * @NoCSRFRequired
+	 * @NoAdminRequired
+	 */
+	public function show(int $id): DataResponse {
+		return $this->handleNotFound(function () use ($id) {
+			return $this->service->find($id, $this->userId);
+		});
+	}
+
+	/**
+	 * @CORS
+	 * @NoCSRFRequired
+	 * @NoAdminRequired
+	 */
+	public function create(string $title, string $content): DataResponse {
+		return new DataResponse($this->service->create($title, $content,
+			$this->userId));
+	}
+
+	/**
+	 * @CORS
+	 * @NoCSRFRequired
+	 * @NoAdminRequired
+	 */
+	public function update(int $id, string $title,
+						   string $content): DataResponse {
+		return $this->handleNotFound(function () use ($id, $title, $content) {
+			return $this->service->update($id, $title, $content, $this->userId);
+		});
+	}
+
+	/**
+	 * @CORS
+	 * @NoCSRFRequired
+	 * @NoAdminRequired
+	 */
+	public function destroy(int $id): DataResponse {
+		return $this->handleNotFound(function () use ($id) {
+			return $this->service->delete($id, $this->userId);
+		});
+	}
+}

lib/Controller/NoteController.php

@@ -0,0 +1,70 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Controller;
+
+use OCA\Nezd\AppInfo\Application;
+use OCA\Nezd\Service\NoteService;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\IRequest;
+
+class NoteController extends Controller {
+	private NoteService $service;
+	private ?string $userId;
+
+	use Errors;
+
+	public function __construct(IRequest $request,
+								NoteService $service,
+								?string $userId) {
+		parent::__construct(Application::APP_ID, $request);
+		$this->service = $service;
+		$this->userId = $userId;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function index(): DataResponse {
+		return new DataResponse($this->service->findAll($this->userId));
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function show(int $id): DataResponse {
+		return $this->handleNotFound(function () use ($id) {
+			return $this->service->find($id, $this->userId);
+		});
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function create(string $title, string $content): DataResponse {
+		return new DataResponse($this->service->create($title, $content,
+			$this->userId));
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function update(int $id, string $title,
+						   string $content): DataResponse {
+		return $this->handleNotFound(function () use ($id, $title, $content) {
+			return $this->service->update($id, $title, $content, $this->userId);
+		});
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function destroy(int $id): DataResponse {
+		return $this->handleNotFound(function () use ($id) {
+			return $this->service->delete($id, $this->userId);
+		});
+	}
+}

lib/Controller/PageController.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Controller;
+
+use OCA\Nezd\AppInfo\Application;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\IRequest;
+use OCP\Util;
+
+class PageController extends Controller {
+	public function __construct(IRequest $request) {
+		parent::__construct(Application::APP_ID, $request);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 */
+	public function index(): TemplateResponse {
+		Util::addScript(Application::APP_ID, 'nezd-main');
+
+		return new TemplateResponse(Application::APP_ID, 'main');
+	}
+}

lib/Db/Note.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Db;
+
+use JsonSerializable;
+
+use OCP\AppFramework\Db\Entity;
+
+/**
+ * @method getId(): int
+ * @method getTitle(): string
+ * @method setTitle(string $title): void
+ * @method getContent(): string
+ * @method setContent(string $content): void
+ * @method getUserId(): string
+ * @method setUserId(string $userId): void
+ */
+class Note extends Entity implements JsonSerializable {
+	protected string $title = '';
+	protected string $content = '';
+	protected string $userId = '';
+
+	public function jsonSerialize(): array {
+		return [
+			'id' => $this->id,
+			'title' => $this->title,
+			'content' => $this->content
+		];
+	}
+}

lib/Db/NoteMapper.php

@@ -0,0 +1,48 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Db;
+
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Db\Entity;
+use OCP\AppFramework\Db\QBMapper;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\IDBConnection;
+
+/**
+ * @template-extends QBMapper<Note>
+ */
+class NoteMapper extends QBMapper {
+	public function __construct(IDBConnection $db) {
+		parent::__construct($db, 'nezd', Note::class);
+	}
+
+	/**
+	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
+	 * @throws DoesNotExistException
+	 */
+	public function find(int $id, string $userId): Note {
+		/* @var $qb IQueryBuilder */
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from('nezd')
+			->where($qb->expr()->eq('id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)));
+		return $this->findEntity($qb);
+	}
+
+	/**
+	 * @param string $userId
+	 * @return array
+	 */
+	public function findAll(string $userId): array {
+		/* @var $qb IQueryBuilder */
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from('nezd')
+			->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)));
+		return $this->findEntities($qb);
+	}
+}

lib/Migration/Version000000Date20181013124731.php

@@ -0,0 +1,49 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\Migration\SimpleMigrationStep;
+use OCP\Migration\IOutput;
+
+class Version000000Date20181013124731 extends SimpleMigrationStep {
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options) {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('nezd')) {
+			$table = $schema->createTable('nezd');
+			$table->addColumn('id', 'integer', [
+				'autoincrement' => true,
+				'notnull' => true,
+			]);
+			$table->addColumn('title', 'string', [
+				'notnull' => true,
+				'length' => 200
+			]);
+			$table->addColumn('user_id', 'string', [
+				'notnull' => true,
+				'length' => 200,
+			]);
+			$table->addColumn('content', 'text', [
+				'notnull' => true,
+				'default' => ''
+			]);
+
+			$table->setPrimaryKey(['id']);
+			$table->addIndex(['user_id'], 'nezd_user_id_index');
+		}
+		return $schema;
+	}
+}

lib/Service/NoteNotFound.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Service;
+
+class NoteNotFound extends \Exception {
+}

lib/Service/NoteService.php

@@ -0,0 +1,83 @@
+<?php
+declare(strict_types=1);
+// SPDX-FileCopyrightText: Szabó Dávid <daevidt@gmail.com>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Nezd\Service;
+
+use Exception;
+
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Db\MultipleObjectsReturnedException;
+
+use OCA\Nezd\Db\Note;
+use OCA\Nezd\Db\NoteMapper;
+
+class NoteService {
+	private NoteMapper $mapper;
+
+	public function __construct(NoteMapper $mapper) {
+		$this->mapper = $mapper;
+	}
+
+	/**
+	 * @return list<Note>
+	 */
+	public function findAll(string $userId): array {
+		return $this->mapper->findAll($userId);
+	}
+
+	/**
+	 * @return never
+	 */
+	private function handleException(Exception $e) {
+		if ($e instanceof DoesNotExistException ||
+			$e instanceof MultipleObjectsReturnedException) {
+			throw new NoteNotFound($e->getMessage());
+		} else {
+			throw $e;
+		}
+	}
+
+	public function find(int $id, string $userId): Note {
+		try {
+			return $this->mapper->find($id, $userId);
+
+			// in order to be able to plug in different storage backends like files
+		// for instance it is a good idea to turn storage related exceptions
+		// into service related exceptions so controllers and service users
+		// have to deal with only one type of exception
+		} catch (Exception $e) {
+			$this->handleException($e);
+		}
+	}
+
+	public function create(string $title, string $content, string $userId): Note {
+		$note = new Note();
+		$note->setTitle($title);
+		$note->setContent($content);
+		$note->setUserId($userId);
+		return $this->mapper->insert($note);
+	}
+
+	public function update(int $id, string $title, string $content, string $userId): Note {
+		try {
+			$note = $this->mapper->find($id, $userId);
+			$note->setTitle($title);
+			$note->setContent($content);
+			return $this->mapper->update($note);
+		} catch (Exception $e) {
+			$this->handleException($e);
+		}
+	}
+
+	public function delete(int $id, string $userId): Note {
+		try {
+			$note = $this->mapper->find($id, $userId);
+			$this->mapper->delete($note);
+			return $note;
+		} catch (Exception $e) {
+			$this->handleException($e);
+		}
+	}
+}