]> BookStack Code Mirror - bookstack/commitdiff
Started custom dropzone implementation
authorDan Brown <redacted>
Mon, 24 Apr 2023 15:19:20 +0000 (16:19 +0100)
committerDan Brown <redacted>
Mon, 24 Apr 2023 15:19:20 +0000 (16:19 +0100)
app/Http/Controllers/Images/GalleryImageController.php
resources/js/components/dropzone.js
resources/js/components/image-manager.js
resources/js/services/clipboard.js

index 3f2f5626583dc328b72b084517bb4b8bfcb24b93..99226e5e9178d1e5a2d7554b449206b1cc563e17 100644 (file)
@@ -42,9 +42,15 @@ class GalleryImageController extends Controller
     public function create(Request $request)
     {
         $this->checkPermission('image-create-all');
-        $this->validate($request, [
-            'file' => $this->getImageValidationRules(),
-        ]);
+
+        try {
+            $this->validate($request, [
+                'file' => $this->getImageValidationRules(),
+            ]);
+        } catch (ValidationException $exception) {
+            // TODO - Check potential other upload locations?
+            return $this->jsonError(implode("\n", $exception->errors()['file']));
+        }
 
         try {
             $imageUpload = $request->file('file');
index e7aae769e6b1ec3934ce94f9a69c97f63633443d..7faa5489f8c62d7226d175bf1e3c5f35e5c7e987 100644 (file)
@@ -1,6 +1,5 @@
-import DropZoneLib from 'dropzone';
-import {fadeOut} from '../services/animations';
 import {Component} from './component';
+import {Clipboard} from '../services/clipboard';
 
 export class Dropzone extends Component {
 
@@ -9,66 +8,119 @@ export class Dropzone extends Component {
         this.url = this.$opts.url;
         this.successMessage = this.$opts.successMessage;
         this.removeMessage = this.$opts.removeMessage;
-        this.uploadLimit = Number(this.$opts.uploadLimit);
-        this.uploadLimitMessage = this.$opts.uploadLimitMessage;
-        this.timeoutMessage = this.$opts.timeoutMessage;
-
-        const component = this;
-        this.dz = new DropZoneLib(this.container, {
-            addRemoveLinks: true,
-            dictRemoveFile: this.removeMessage,
-            timeout: Number(window.uploadTimeout) || 60000,
-            maxFilesize: this.uploadLimit,
-            url: this.url,
-            withCredentials: true,
-            init() {
-                this.dz = this;
-                this.dz.on('sending', component.onSending.bind(component));
-                this.dz.on('success', component.onSuccess.bind(component));
-                this.dz.on('error', component.onError.bind(component));
-            },
-        });
+        this.uploadLimit = Number(this.$opts.uploadLimit); // TODO - Use
+        this.uploadLimitMessage = this.$opts.uploadLimitMessage; // TODO - Use
+        this.timeoutMessage = this.$opts.timeoutMessage; // TODO - Use
+        // window.uploadTimeout // TODO - Use
+        // TODO - Click-to-upload buttons/areas
+        // TODO - Drop zone highlighting of existing element
+        //   (Add overlay via additional temp element).
+
+        this.setupListeners();
     }
 
-    onSending(file, xhr, data) {
-        const token = window.document.querySelector('meta[name=token]').getAttribute('content');
-        data.append('_token', token);
+    setupListeners() {
+        this.container.addEventListener('dragenter', event => {
+            this.container.style.border = '1px dotted tomato';
+            event.preventDefault();
+        });
+
+        this.container.addEventListener('dragover', event => {
+            event.preventDefault();
+        });
 
-        xhr.ontimeout = () => {
-            this.dz.emit('complete', file);
-            this.dz.emit('error', file, this.timeoutMessage);
+        const reset = () => {
+            this.container.style.border = null;
         };
-    }
 
-    onSuccess(file, data) {
-        this.$emit('success', {file, data});
+        this.container.addEventListener('dragend', event => {
+            reset();
+        });
 
-        if (this.successMessage) {
-            window.$events.emit('success', this.successMessage);
-        }
+        this.container.addEventListener('dragleave', event => {
+            reset();
+        });
 
-        fadeOut(file.previewElement, 800, () => {
-            this.dz.removeFile(file);
+        this.container.addEventListener('drop', event => {
+            event.preventDefault();
+            const clipboard = new Clipboard(event.dataTransfer);
+            const files = clipboard.getFiles();
+            for (const file of files) {
+                this.createUploadFromFile(file);
+            }
         });
     }
 
-    onError(file, errorMessage, xhr) {
-        this.$emit('error', {file, errorMessage, xhr});
+    /**
+     * @param {File} file
+     * @return {Upload}
+     */
+    createUploadFromFile(file) {
+        const {dom, status} = this.createDomForFile(file);
+        this.container.append(dom);
+
+        const formData = new FormData();
+        formData.append('file', file, file.name);
+
+        // TODO - Change to XMLHTTPRequest so we can track progress.
+        const uploadPromise = window.$http.post(this.url, formData);
 
-        const setMessage = message => {
-            const messsageEl = file.previewElement.querySelector('[data-dz-errormessage]');
-            messsageEl.textContent = message;
+        const upload = {
+            file,
+            dom,
+            markError(message) {
+                status.setAttribute('data-status', 'error');
+                status.textContent = message;
+            },
+            markSuccess(message) {
+                status.setAttribute('data-status', 'success');
+                status.textContent = message;
+            },
         };
 
-        if (xhr && xhr.status === 413) {
-            setMessage(this.uploadLimitMessage);
-        } else if (errorMessage.file) {
-            setMessage(errorMessage.file);
-        }
+        uploadPromise.then(returnData => {
+            upload.markSuccess(returnData.statusText);
+        }).catch(err => {
+            upload.markError(err?.data?.message || err.message);
+        });
+
+        return upload;
     }
 
-    removeAll() {
-        this.dz.removeAllFiles(true);
+    /**
+     * @param {File} file
+     * @return {{image: Element, dom: Element, progress: Element, label: Element, status: Element}}
+     */
+    createDomForFile(file) {
+        const dom = document.createElement('div');
+        const label = document.createElement('div');
+        const status = document.createElement('div');
+        const progress = document.createElement('div');
+        const image = document.createElement('img');
+
+        dom.classList.add('dropzone-file-item');
+        status.classList.add('dropzone-file-item-status');
+        progress.classList.add('dropzone-file-item-progress');
+
+        image.src = ''; // TODO - file icon
+        label.innerText = file.name;
+
+        if (file.type.startsWith('image/')) {
+            image.src = URL.createObjectURL(file);
+        }
+
+        dom.append(image, label, progress, status);
+        return {
+            dom, label, image, progress, status,
+        };
     }
 
 }
+
+/**
+ * @typedef Upload
+ * @property {File} file
+ * @property {Element} dom
+ * @property {function(String)} markError
+ * @property {function(String)} markSuccess
+ */
index 3cb99f0e208413290b7dff9565151adec76296d6..bb21bd5ecc7be110cfd1f845917c8ec9be2535d6 100644 (file)
@@ -34,6 +34,11 @@ export class ImageManager extends Component {
         this.resetState();
 
         this.setupListeners();
+
+        window.setTimeout(() => {
+            this.show(() => {
+            }, 'gallery');
+        }, 500);
     }
 
     setupListeners() {
index 02db29be00aa98869c9bf1eb17df8a590a8a1370..5f73c3020cf932685c1369cbe40070405079b19e 100644 (file)
@@ -30,7 +30,6 @@ export class Clipboard {
      */
     getImages() {
         const {types} = this.data;
-        const {files} = this.data;
         const images = [];
 
         for (const type of types) {
@@ -40,15 +39,21 @@ export class Clipboard {
             }
         }
 
-        for (const file of files) {
-            if (file.type.includes('image')) {
-                images.push(file);
-            }
-        }
+        const imageFiles = this.getFiles().filter(f => f.type.includes('image'));
+        images.push(...imageFiles);
 
         return images;
     }
 
+    /**
+     * Get the files included in the clipboard data.
+     * @return {File[]}
+     */
+    getFiles() {
+        const {files} = this.data;
+        return [...files];
+    }
+
 }
 
 export async function copyTextToClipboard(text) {