Merge pull request #919 from nextcloud/register-mimetypes

Register mimetypes

README.md

@@ -19,7 +19,7 @@ Future plans:
 ## User Documentation
 ### My Maps
 Custom maps are stored by default in the "/Maps" folder. This folder can be found in the
-files app. Other folders turned into map by placing a ".maps" file into it.
+files app. Other folders turned into map by placing a ".index.maps" file into it.
 Content can therefore be added via:
  - Webdav (Desktop and Mobile clients)
  - Files app
@@ -56,7 +56,7 @@ They can be added from files
 or from maps
 ![](screenshots/addPhotosFromMap.gif)
 Existing photo albums can be viewed
-on the map by placing a ".maps" file into it.
+on the map by placing a ".index.maps" file into it.
 ![](screenshots/photoAlbumOnMap.gif)
 
 Scanning photos take time. Therefore photos are scanned in the background.

appinfo/info.xml

@@ -39,7 +39,14 @@
     <repair-steps>
         <install>
             <step>OCA\Maps\Migration\InstallScan</step>
+			<step>OCA\Maps\Migration\RegisterMimeType</step>
         </install>
+		<post-migrate>
+			<step>OCA\Maps\Migration\RegisterMimeType</step>
+		</post-migrate>
+		<uninstall>
+			<step>OCA\Maps\Migration\UnregisterMimeType</step>
+		</uninstall>
     </repair-steps>
     <commands>
         <command>OCA\Maps\Command\RescanPhotos</command>

appinfo/routes.php

@@ -27,6 +27,7 @@
         ['name' => 'photos#getNonLocalizedPhotosFromDb', 'url' => '/photos/nonlocalized', 'verb' => 'GET'],
         ['name' => 'photos#placePhotos', 'url' => '/photos', 'verb' => 'POST'],
         ['name' => 'photos#resetPhotosCoords', 'url' => '/photos', 'verb' => 'DELETE'],
+		['name' => 'photos#clearCache', 'url' => '/photos/clearCache', 'verb' => 'GET'],
 
         // contacts
         ['name' => 'contacts#getContacts', 'url' => '/contacts', 'verb' => 'GET'],

lib/Controller/PhotosController.php

@@ -143,4 +143,17 @@ public function resetPhotosCoords($paths, $myMapId=null): DataResponse {
         return new DataResponse($result);
     }
 
+	/**
+	 * @NoAdminRequired
+	 * @return DataResponse
+	 */
+	public function clearCache(): DataResponse {
+		$result = $this->geophotoService->clearCache();
+		if ($result) {
+			return new DataResponse("Cache cleared");
+		} else {
+			return new DataResponse("Failed to clear Cache", 400);
+		}
+	}
+
 }

lib/Controller/UtilsController.php

@@ -84,9 +84,9 @@ public function saveOptionValue($options, $myMapId=null): DataResponse  {
             $folders = $userFolder->getById($myMapId);
             $folder = array_shift($folders);
             try {
-                $file=$folder->get(".maps");
+                $file=$folder->get(".index.maps");
             } catch (NotFoundException $e) {
-                $file=$folder->newFile(".maps", $content = "{}");
+                $file=$folder->newFile(".index.maps", $content = "{}");
             }
             try {
                 $ov = json_decode($file->getContent(),true, 512);
@@ -127,13 +127,13 @@ public function getOptionsValues($myMapId=null): DataResponse {
             $folders = $userFolder->getById($myMapId);
             $folder = array_shift($folders);
             try {
-                $file=$folder->get(".maps");
+                $file=$folder->get(".index.maps");
             } catch (NotFoundException $e) {
-                $file=$folder->newFile(".maps", $content = "{}");
+                $file=$folder->newFile(".index.maps", $content = "{}");
             }
             $ov = json_decode($file->getContent(),true, 512);
 			$ov['isCreatable'] = $folder->isCreatable();
-			//We can delete the map by deleting the folder or the .maps file
+			//We can delete the map by deleting the folder or the .index.maps file
 			$ov['isDeletable'] = $folder->isDeletable() || $file->isDeletable();
 			// Maps content can be read mostly from the folder
 			$ov['isReadable'] = $folder->isReadable();

lib/Listener/LoadAdditionalScriptsListener.php

@@ -40,7 +40,7 @@ public function handle(Event $event): void {
 			return;
 		}
 
-		Util::addScript('maps', 'filetypes');
+		Util::addScript('maps', 'maps-filetypes');
 		Util::addStyle('maps', 'filetypes');
 	}
 }

lib/Migration/RegisterMimeType.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace OCA\Maps\Migration;
+
+use OCP\Files\IMimeTypeLoader;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+
+class RegisterMimeType implements IRepairStep
+{
+	const CUSTOM_MIMETYPEMAPPING = 'mimetypemapping.json';
+
+	protected IMimeTypeLoader $mimeTypeLoader;
+
+	public function __construct(IMimeTypeLoader $mimeTypeLoader)
+	{
+		$this->mimeTypeLoader = $mimeTypeLoader;
+	}
+
+	public function getName()
+	{
+		return 'Register Maps MIME types"';
+	}
+
+	private function registerForExistingFiles()
+	{
+		$mimeTypeId = $this->mimeTypeLoader->getId('application/x-nextcloud-maps');
+		$this->mimeTypeLoader->updateFilecache('maps', $mimeTypeId);
+
+		$mimeTypeId = $this->mimeTypeLoader->getId('application/x-nextcloud-noindex');
+		$this->mimeTypeLoader->updateFilecache('noindex', $mimeTypeId);
+
+		$mimeTypeId = $this->mimeTypeLoader->getId('application/x-nextcloud-nomedia');
+		$this->mimeTypeLoader->updateFilecache('nomedia', $mimeTypeId);
+
+		$mimeTypeId = $this->mimeTypeLoader->getId('application/x-nextcloud-noimage');
+		$this->mimeTypeLoader->updateFilecache('noimage', $mimeTypeId);
+
+		$mimeTypeId = $this->mimeTypeLoader->getId('application/x-nextcloud-maps-notrack');
+		$this->mimeTypeLoader->updateFilecache('notrack', $mimeTypeId);
+	}
+
+	private function registerForNewFiles()
+	{
+		$mapping = [
+			'maps' => ['application/x-nextcloud-maps'],
+			'noindex' => ['application/x-nextcloud-noindex'],
+			'nomedia' => ['application/x-nextcloud-nomedia'],
+			'noimage' => ['application/x-nextcloud-noimage'],
+			'notrack' => ['application/x-nextcloud-maps-notrack'],
+			];
+		$mappingFile = \OC::$configDir . self::CUSTOM_MIMETYPEMAPPING;
+
+		if (file_exists($mappingFile)) {
+			$existingMapping = json_decode(file_get_contents($mappingFile), true);
+			if (json_last_error() === JSON_ERROR_NONE && is_array($existingMapping)) {
+				$mapping = array_merge($existingMapping, $mapping);
+			}
+		}
+
+		file_put_contents($mappingFile, json_encode($mapping, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));
+	}
+
+	public function run(IOutput $output)
+	{
+		$output->info('Registering the mimetype...');
+
+		// Register the mime type for existing files
+		$this->registerForExistingFiles();
+
+		// Register the mime type for new files
+		$this->registerForNewFiles();
+
+		$output->info('The mimetype was successfully registered.');
+	}
+}

lib/Migration/UnregisterMimType.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace OCA\Maps\Migration;
+
+use OCP\Files\IMimeTypeLoader;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+
+class UnregisterMimeType implements IRepairStep
+{
+	const CUSTOM_MIMETYPEMAPPING = 'mimetypemapping.json';
+
+	protected IMimeTypeLoader $mimeTypeLoader;
+
+	public function __construct(IMimeTypeLoader $mimeTypeLoader)
+	{
+		$this->mimeTypeLoader = $mimeTypeLoader;
+	}
+
+	public function getName()
+	{
+		return 'Register Maps MIME types"';
+	}
+
+	private function unregisterForExistingFiles()
+	{
+		$mimeTypeId = $this->mimeTypeLoader->getId('application/octet-stream');
+		$this->mimeTypeLoader->updateFilecache('maps', $mimeTypeId);
+		$this->mimeTypeLoader->updateFilecache('noindex', $mimeTypeId);
+		$this->mimeTypeLoader->updateFilecache('nomedia', $mimeTypeId);
+		$this->mimeTypeLoader->updateFilecache('noimage', $mimeTypeId);
+		$this->mimeTypeLoader->updateFilecache('notrack', $mimeTypeId);
+	}
+
+	private function unregisterForNewFiles()
+	{
+		$mappingFile = \OC::$configDir . self::CUSTOM_MIMETYPEMAPPING;
+
+		if (file_exists($mappingFile)) {
+			$mapping = json_decode(file_get_contents($mappingFile), true);
+			if (json_last_error() === JSON_ERROR_NONE && is_array($mapping)) {
+				unset($mapping['maps']);
+				unset($mapping['noindex']);
+				unset($mapping['nomedia']);
+				unset($mapping['noimage']);
+				unset($mapping['notrack']);
+			} else {
+				$mapping = [];
+			}
+			file_put_contents($mappingFile, json_encode($mapping, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));
+		}
+	}
+
+	public function run(IOutput $output)
+	{
+		$output->info('Unregistering the mimetype...');
+
+		// Register the mime type for existing files
+		$this->unregisterForExistingFiles();
+
+		// Register the mime type for new files
+		$this->unregisterForNewFiles();
+
+		$output->info('The mimetype was successfully unregistered.');
+	}
+}
+

lib/Service/GeophotoService.php

@@ -74,11 +74,12 @@ public function __construct (ILogger $logger,
 
 	/**
 	 * @param string $userId
-	 * @return void
+	 * @return bool
 	 */
-	public function clearCache(string $userId=''): void {
-		$this->photosCache->clear($userId);
-		$this->nonLocalizedPhotosCache->clear($userId);
+	public function clearCache(string $userId=''): bool {
+		 $a = $this->photosCache->clear($userId);
+		 $b = $this->nonLocalizedPhotosCache->clear($userId);
+		 return $a and $b;
 	}
 
 	/**
@@ -258,25 +259,22 @@ private function getIgnoredPaths($userId, $folder=null, $hideImagesOnCustomMaps=
 		if (is_null($folder)) {
 			$folder = $userFolder;
 		}
-		$ignoreMarkerFiles = [
-			'.nomedia',
-			'.noimage',
-			'.noindex',
+		$ignoreFileMimetypes = [
+			'application/x-nextcloud-noindex',
+			'application/x-nextcloud-nomedia',
+			'application/x-nextcloud-noimage',
 		];
 		if ($hideImagesOnCustomMaps) {
-			$ignoreMarkerFiles[] = '.maps';
+			$ignoreFileMimetypes[] = 'application/x-nextcloud-maps';
 		}
 		$func = function(string $i): SearchComparison {
-			return new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'name', $i);
+			return new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mimetype', $i);
 		};
 		$excludedNodes = $folder->search(new SearchQuery(
-			new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_AND, [
-				new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mimetype', 'application/octet-stream'),
 				new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_OR, array_map(
 					$func,
-					$ignoreMarkerFiles)
+					$ignoreFileMimetypes)
 				),
-			]),
 			0,
 			0,
 			[]