Merge branch 'finder' of https://github.com/django-cms/django-filer into finder

Author: jrief

README-Finder.md

@@ -50,13 +50,16 @@ while preserving the possibility to perform queries across all tables. This allo
 models inheriting from the `AbstractFileModel` without the need of **django-polymorphic**, and thus
 a join between two or more tables for each query.
 
-The Admin interface has also been completely rewritten and allows multi-tenant usage out of the box.
-For instance, there is no more list view for the `FolderModel` and the `FileModel` (or any
-specialized implementation). Instead, there are only details views for each of those models. This is
-much nearer to what a user would expect from a file system. Therefore, if a user wants to access the
-list view of a folder, he is redirected immediately to the detail view of the root folder of the
-given tenant. From there, he can traverse the folder tree in the same manner he's used to from his
-operating system.
+Each root folder is associated with a *realm*. A realm is a named area inside the file system, which
+can be used to separate files and folders of different tenants. Each realm has its own root folder.
+By using realms, it is possible to use **django-filer** in a multi-tenant environment.
+
+The Admin interface has also been completely rewritten. For instance, there is no more list view for
+the `FolderModel` and the `FileModel` (or any specialized implementation). Instead, there are only
+details views for each of those models. This is much nearer to what a user would expect from a file
+system. Therefore, if a user wants to access the list view of a folder, he is redirected immediately
+to the detail view of the root folder of the given tenant. From there, he can traverse the folder
+tree in the same manner he's used to from his operating system.
 
 
 ## New User Interface
@@ -95,8 +98,8 @@ ancestors. This allows to easily move files between those folders.
 ### Multiple Favrourite Folders
 
 Each user can have multiple favourite folders. This allows him to quickly access those folders from
-the navigation bar. It also it pssoble to drag a file from the current view into one of the tabs for
-of the favorite folders.
+the navigation bar. It is also possible to drag a file from the current view into one of the tabs
+for of the favorite folders.
 
 
 ### Implementation Details
@@ -142,7 +145,56 @@ If you use:
 * `finder.contrib.audio` or `finder.contrib.video`, assure that `ffmpeg-python` is installed.
 * `finder.contrib.image.pil`, assure that `Pillow` is installed.
 * `finder.contrib.image.svg`, assure that `reportlab` and `svglib` are installed.
-* Postgres as database, install `psycopg2` or `psycopg2-binary` if available for your platform.
+* Postgres as a database, install `psycopg2` or `psycopg2-binary` if available for your platform.
+
+Each realm requires two storage backends. One for the public files and one for their thumbnails
+and/or samples. Add these storage backends to the `STORAGES` setting in your `settings.py`:
+
+```python
+STORAGES = {
+    'default': {
+        'BACKEND': 'django.core.files.storage.FileSystemStorage',
+    },
+    'staticfiles': {
+        'BACKEND': 'django.contrib.staticfiles.storage.StaticFilesStorage',
+    },
+    'finder_public': {
+        'BACKEND': 'finder.storage.FinderSystemStorage',
+        'OPTIONS': {
+            'location': '/path/to/your/media/filer_public',
+            'base_url': '/media/filer_public/',
+            'allow_overwrite': True,
+        },
+    },
+    'finder_public_samples': {
+        'BACKEND': 'finder.storage.FinderSystemStorage',
+        'OPTIONS': {
+            'location': '/path/to/your/media/filer_public_thumbnails',
+            'base_url': '/media/filer_public_thumbnails/',
+            'allow_overwrite': True,
+        },
+    },
+}
+```
+
+If instead of using the local file system you want to use another storage backend, such as Amazon S3
+or Google Cloud Storage, configure the corresponding storage backend in the `STORAGES` setting as:
+
+```python
+STORAGES = {
+    ...
+    'finder_public': {
+        'BACKEND': 'storages.backends.s3.S3Storage',
+        'OPTIONS': {...},
+    },
+    'finder_public_samples': {
+        'BACKEND': 'storages.backends.s3.S3Storage',
+        'OPTIONS': {...},
+    },
+}
+```
+
+Note that multiple realms can share the same storage location or bucket.
 
 Run the migrations for app `finder`:
 

client/browser/FileSelectDialog.tsx

@@ -71,12 +71,12 @@ function ScrollSpy(props) {
 
 
 const FilesList = memo((props: any) => {
-	const {structure, setDirty, selectFile, selectedFileId, webAudio} = props;
+	const {structure, setDirty, isDirty, selectFile, selectedFileId, webAudio} = props;
 
 	return (
 		<ul className="files-browser">{
 		structure.files.length === 0 ?
-			<li className="status">{gettext("Empty folder")}</li> : (
+			(!isDirty && <li className="status">{gettext("Empty folder")}</li>) : (
 			<>{structure.files.map(file => (
 			<li key={file.id} onClick={() => selectFile(file)}>
 				<Figure {...file} webAudio={webAudio} isSelected={file.id === selectedFileId} />
@@ -197,6 +197,13 @@ const FileSelectDialog = forwardRef((props: any, forwardedRef) => {
 		const response = await fetch(`${baseUrl}structure/${realm}${params.size === 0 ? '' : `?${params.toString()}`}`);
 		if (response.ok) {
 			setStructure(await response.json());
+			window.setTimeout(() => {
+				// first show the structure from the root for orientation, then scroll to the current folder
+				const currentListItem = ref.current.querySelector('ul[role="navigation"] li:has(>[aria-current="true"]');
+				if (currentListItem) {
+					currentListItem.scrollIntoView({behavior: 'smooth', block: 'center'});
+				}
+			}, 999);
 		} else {
 			console.error(response);
 		}
@@ -324,17 +331,20 @@ const FileSelectDialog = forwardRef((props: any, forwardedRef) => {
 						handleUpload={handleUpload}
 						ref={uploaderRef}
 						settings={{csrf_token: csrfToken, base_url: baseUrl}}
-					>{
-						structure.files === null ?
-						<div className="status">{gettext("Loading files…")}</div> :
+					>{Array.isArray(structure.files) ?
 						<FilesList
 							structure={structure}
 							setDirty={setDirty}
+							isDirty={isDirty}
 							selectFile={selectFile}
 							selectedFileId={props.selectedFileId}
 							webAudio={webAudio}
 						/>
-					}</FileUploader>
+						:
+						<div className="status">{gettext("Loading structure…")}</div>
+					}
+					{isDirty && <div className="status">{gettext("Loading files…")}</div>}
+					</FileUploader>
 				</div>
 			</>}
 		</div>

client/scss/finder-browser.scss

@@ -84,7 +84,7 @@ dialog {
 	box-shadow: 0 0 0.5rem #c8c8c8;
 	width: 80%;
 	height: 80%;
-	max-width: 900px;
+	max-width: 1200px;
 	padding: 2rem;
 
 	.wrapper {

finder/browser/views.py

@@ -30,7 +30,7 @@ class BrowserView(View):
     The view for web component <finder-browser>.
     """
     action = None
-    limit = 50
+    limit = 100
 
     def dispatch(self, request, *args, **kwargs):
         if self.action is None:

finder/management/commands/filer_to_finder.py

@@ -24,7 +24,7 @@ def handle(self, verbosity, *args, **options):
 
     def forward(self):
         site = Site.objects.get(id=settings.SITE_ID)
-        owner = FilerFolder.objects.filter(parent__isnull=True, owner__isnull=False).first().owner
+        owner = FilerFolder.objects.filter(parent__isnull=True).first().owner
         try:
             realm = FinderRealmModel.objects.get(site=site, slug=admin_site.name)
         except FinderRealmModel.DoesNotExist:
@@ -35,16 +35,17 @@ def forward(self):
             self.migrate_folder(filer_folder, realm.root_folder)
 
     def migrate_folder(self, filer_folder, finder_parent):
-        finder_folder = finder_parent.listdir(name=filer_folder.name, is_folder=True).first()
-        if finder_folder is None:
+        if finder_folder := finder_parent.listdir(name=filer_folder.name, is_folder=True).first():
+            finder_folder = FinderFolder.objects.get(id=finder_folder['id'])
+        else:
             finder_folder = FinderFolder.objects.create(
                 name=filer_folder.name,
                 parent=finder_parent,
                 created_at=filer_folder.created_at,
                 last_modified_at=filer_folder.modified_at,
                 owner_id=filer_folder.owner_id,
             )
-            self.stdout.write(f"Create folder {finder_folder} in {finder_parent}")
+            self.stdout.write(f"Create folder “{finder_folder}” in “{finder_parent}”.")
 
         allowed_image_types = ['image/gif', 'image/jpeg', 'image/png', 'image/webp', 'image/svg+xml']
         for filer_file in filer_folder.files.all():
@@ -60,8 +61,11 @@ def migrate_file(self, filer_file, finder_parent):
         path = Path(filer_file.file.name)
         inode_id = path.parent.stem
         try:
-            finder_file = FinderFile.objects.get_inode(id=inode_id)
+            finder_file = FinderFile.objects.get(id=inode_id)
         except FinderFile.DoesNotExist:
+            if not filer_file._file_size:
+                self.stderr.write(f"File {filer_file} has no file size.")
+                return
             FinderFile.objects.create(
                 id=inode_id,
                 name=filer_file.name if filer_file.name else filer_file.original_filename,
@@ -91,15 +95,19 @@ def migrate_image(self, filer_image, finder_parent):
         meta_data = {'alt_text': getattr(filer_image, 'default_alt_text', '')}
         try:
             center_x, center_y = map(float, filer_image.subject_location.split(','))
-            # since Filer does not store the area of interest, we assume it is 10px
-            meta_data['crop_x'] = center_x - 5
-            meta_data['crop_y'] = center_y - 5
-            meta_data['crop_size'] = 10
+            # since Filer does not store the area of interest, we assume it's 20% of its width or height
+            crop_size = int(round(max(filer_image.width, filer_image.height) * 0.2))
+            meta_data['crop_x'] = center_x - crop_size / 2
+            meta_data['crop_y'] = center_y - crop_size / 2
+            meta_data['crop_size'] = crop_size
         except ValueError:
             pass
         try:
-            finder_image = FinderImage.objects.get_inode(id=inode_id)
-        except FinderFile.DoesNotExist:
+            finder_image = FinderImage.objects.get(id=inode_id)
+        except FinderImage.DoesNotExist:
+            if not filer_image._file_size:
+                self.stderr.write(f"Image {filer_image} has no file size.")
+                return
             FinderImage.objects.create(
                 id=inode_id,
                 name=filer_image.name if filer_image.name else filer_image.original_filename,

finder/management/commands/finder.py

@@ -20,8 +20,6 @@ def handle(self, verbosity, subcommand, *args, **options):
                 self.reorganize()
             elif subcmd == 'reorder':
                 self.reorder()
-            elif subcmd == 'migrate-filer':
-                call_command('filer_to_finder', verbosity=verbosity)
             else:
                 self.stderr.write(f"Unknown subcommand ‘{subcmd}’")
 

finder/models/inode.py

@@ -4,7 +4,7 @@
 from operator import and_, or_
 
 from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured, ValidationError
+from django.core.exceptions import ImproperlyConfigured, ValidationError, ObjectDoesNotExist
 from django.db import connections, models
 from django.db.models.aggregates import Aggregate
 from django.db.models.expressions import F, Value, Q
@@ -166,10 +166,13 @@ def get_inode(self, **lookup):
             folder_qs = FolderModel.objects.none()
         elif (folder_qs := FolderModel.objects.filter(**lookup)).exists():
             return folder_qs.get()
-        values = folder_qs.values('id', mime_type=Value(None, output_field=models.CharField())).union(*[
-            model.objects.values('id', 'mime_type').filter(self.get_query(model, lookup))
-            for model in FileModel.get_models()
-        ]).get()
+        try:
+            values = folder_qs.values('id', mime_type=Value(None, output_field=models.CharField())).union(*[
+                model.objects.values('id', 'mime_type').filter(self.get_query(model, lookup))
+                for model in FileModel.get_models()
+            ]).get()
+        except FolderModel.DoesNotExist:
+            raise self.model.DoesNotExist(f"No inode found matching the given lookup: {lookup}.")
         return FileModel.objects.get_model_for(values['mime_type']).objects.get(id=values['id'])
 
     @classmethod