noteapicontroller: migrated use of Nextcloud API to Nextcloud 29+ standards

Signed-off-by: Patrizio Bekerle <[email protected]>

Author: pbek

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## Next
 
 - Migrated to from PHP7 to PHP8 annotations (for [#53](https://github.com/pbek/qownnotesapi/issues/53))
+- Migrated the use of the Nextcloud API to Nextcloud 29+ standards
+  - Increased min-version to Nextcloud 29
 
 ## 25.8.0
 

appinfo/info.xml

@@ -30,6 +30,6 @@ The only purpose of this App is to provide API access to your Nextcloud/ownCloud
     <!-- dependencies -->
     <dependencies>
         <owncloud min-version="8.2" max-version="10" />
-        <nextcloud min-version="22" max-version="32" />
+        <nextcloud min-version="29" max-version="32" />
     </dependencies>
 </info>

lib/Controller/NoteApiController.php

@@ -21,24 +21,46 @@
 use OCA\Files_Trashbin\Helper;
 use OCA\Files_Trashbin\Trashbin;
 use OCA\Files_Versions\Storage;
+use OCP\App\IAppManager;
 use OCP\AppFramework\ApiController;
+use OCP\AppFramework\Http\Attribute\CORS;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
 use OCP\Files\NotFoundException;
+use OCP\Files\NotPermittedException;
+use OCP\IAppConfig;
+use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IUserManager;
+use OCP\Lock\LockedException;
 
 class NoteApiController extends ApiController {
 	protected $user;
+	private IUserManager $userManager;
+	private IAppManager $appManager;
+	private IConfig $config;
+	private IAppConfig $appConfig;
 
 	/**
 	 * @param string $appName
 	 * @param string $userId
 	 */
-	public function __construct($appName,
+	public function __construct(
+		$appName,
 		$userId,
-		IRequest $request) {
+		IRequest $request,
+		IUserManager $userManager,
+		IAppManager $appManager,
+		IConfig $config,
+		IAppConfig $appConfig
+	) {
 		// For some reason $userId is null on ownCloud 10.3+ anymore
 		// https://github.com/pbek/QOwnNotes/issues/1725
 		$this->user = $userId ? $userId : $_SERVER['PHP_AUTH_USER'];
+		$this->userManager = $userManager;
+		$this->appManager = $appManager;
+		$this->config = $config;
+		$this->appConfig = $appConfig;
 		parent::__construct($appName, $request);
 	}
 
@@ -47,8 +69,8 @@ public function __construct($appName,
 	 *
 	 * @return array
 	 *
-	 * @throws \OCP\Lock\LockedException
-	 * @throws \OC\User\NoUserException
+	 * @throws LockedException
+	 * @throws NoUserException
 	 */
 	#[NoAdminRequired]
 	#[NoCSRFRequired]
@@ -94,7 +116,7 @@ public function getAllVersions() {
 					];
 				}
 			}
-		} catch (\OCP\Files\NotFoundException $exception) {
+		} catch (NotFoundException $exception) {
 			// Requested file was not found, silently fail (for now)
 			$errorMessages[] = 'Requested file was not found!';
 		} catch (Exception $exception) {
@@ -117,13 +139,12 @@ public function getAllVersions() {
 	 * @return array
 	 * @throws NoUserException
 	 */
-	protected static function getUidAndFilename($filename) {
+	protected function getUidAndFilename($filename) {
 		$uid = Filesystem::getOwner($filename);
-		$userManager = \OC::$server->get(IUserManager::class);
-		// if the user with the UID doesn't exists, e.g. because the UID points
+		// if the user with the UID doesn't exist, e.g. because the UID points
 		// to a remote user with a federated cloud ID we use the current logged-in
 		// user. We need a valid local user to create the versions
-		if (!$userManager->userExists($uid)) {
+		if (!$this->userManager->userExists($uid)) {
 			$uid = OC_User::getUser();
 		}
 		Filesystem::initMountPoints($uid);
@@ -153,16 +174,15 @@ protected static function getUidAndFilename($filename) {
 	#[NoCSRFRequired]
 	#[CORS]
 	public function getAppInfo() {
-		$appManager = \OC::$server->getAppManager();
-		$versionsAppEnabled = $appManager->isEnabledForUser('files_versions');
-		$trashAppEnabled = $appManager->isEnabledForUser('files_trashbin');
+		$versionsAppEnabled = $this->appManager->isEnabledForUser('files_versions');
+		$trashAppEnabled = $this->appManager->isEnabledForUser('files_trashbin');
 		$notesPathExists = false;
 		$notesPath = $this->request->getParam('notes_path', '');
 
 		// check if notes path exists
 		if ($notesPath !== '') {
 			$notesPath = '/files'.(string) $notesPath;
-			$view = new \OC\Files\View('/'.$this->user);
+			$view = new View('/'.$this->user);
 			$notesPathExists = $view->is_dir($notesPath);
 		}
 
@@ -171,8 +191,8 @@ public function getAppInfo() {
 			'versions_app' => $versionsAppEnabled,
 			'trash_app' => $trashAppEnabled,
 			'versioning' => true,
-			'app_version' => \OC::$server->getConfig()->getAppValue('qownnotesapi', 'installed_version'),
-			'server_version' => \OC::$server->getSystemConfig()->getValue('version'),
+			'app_version' => $this->appConfig->getValueString('qownnotesapi', 'installed_version', ''),
+			'server_version' => $this->config->getSystemValue('version'),
 			'notes_path_exists' => $notesPathExists,
 		];
 	}
@@ -182,7 +202,7 @@ public function getAppInfo() {
 	 *
 	 * @return string|array
 	 *
-	 * @throws \OCP\Lock\LockedException
+	 * @throws LockedException
 	 */
 	#[NoAdminRequired]
 	#[NoCSRFRequired]
@@ -198,18 +218,18 @@ public function getTrashedNotes() {
 		$noteFileExtensions = array_merge(['md', 'txt'], $customFileExtensions);
 
 		// remove leading "/"
-		if (substr($dir, 0, 1) === '/') {
+		if (str_starts_with($dir, '/')) {
 			$dir = substr($dir, 1);
 		}
 
 		// remove trailing "/"
-		if (substr($dir, -1) === '/') {
+		if (str_ends_with($dir, '/')) {
 			$dir = substr($dir, 0, -1);
 		}
 
 		$sortAttribute = $this->request->getParam('sort', 'mtime');
 		$sortDirectionParam = $this->request->getParam('sortdirection', '');
-		$sortDirection = ($sortDirectionParam !== '') ? ($sortDirectionParam === 'desc') : true;
+		$sortDirection = !($sortDirectionParam !== '') || $sortDirectionParam === 'desc';
 		$filesInfo = [];
 
 		// generate the file list
@@ -226,15 +246,17 @@ public function getTrashedNotes() {
 			$extension = $pathParts['extension'] ?? '';
 
 			// if $fileInfo["extraData"] is not set we will have to show the note files from all folders in QOwnNotes
-			$isInDir = isset($fileInfo['extraData']) ?
-				(strpos($fileInfo['extraData'], $dir.'/'.$fileInfo['name']) === 0) : true;
+			$isInDir = !isset($fileInfo['extraData']) || str_starts_with(
+				$fileInfo['extraData'],
+				$dir.'/'.$fileInfo['name']
+			);
 			$isNoteFile = in_array($extension, $noteFileExtensions, true);
 
 			if ($isInDir && $isNoteFile) {
 				$timestamp = (int) ($fileInfo['mtime'] / 1000);
 				$fileName = '/files_trashbin/files/'.$fileInfo['name'].".d$timestamp";
 
-				$view = new \OC\Files\View('/'.$this->user);
+				$view = new View('/'.$this->user);
 				$data = '';
 
 				// load the file data
@@ -272,7 +294,7 @@ public function getTrashedNotes() {
 	 *
 	 * @return string|array
 	 *
-	 * @throws \OCP\Files\NotPermittedException
+	 * @throws NotPermittedException
 	 *
 	 * @see owncloud/core/apps/files_trashbin/ajax/undelete.php
 	 */