amcms_filemanager 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b9335c2a48570995936b16c7fc56963c24b2c569fc4fd803f65259dfb1795c9
+  data.tar.gz: e8e10a7e5abf00a38235ff32aa34b3679d35226cb3fc5265cae0dc4f45e7aba5
+SHA512:
+  metadata.gz: e5a34dc63b0f4d87771d39e61bd872c1b5cb577e412f3569658d101ae4a5695f9da294469fa86dedcab03dfd486e50d037d4cbcac2afc7a7187fe1fd1615fffc
+  data.tar.gz: 811ba3c49aff61bcccb6b9738d492572e5216702625771f229fa31aa9d3f3d1fe56aba48a226327b51a5aa842e5643c1318f82d673131a9c3435fbffc9c3df8a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Andrew Maughan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# AmcmsFilemanager
+Filemanager for tinymce.  Allows uploading of files to a remote server via the file picker plugin in Tinymce.
+
+## Full Feature List
+- Browse directory
+- Mutli File Upload
+- Rename File
+- Copy File
+- Delete File
+- Make Directory
+- Resize Image
+- Authentication hooks
+- Allowed file types
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amcms_filemanager'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install amcms_filemanager
+```
+
+Mount the filemanger routes in `config/routes.rb`
+
+```ruby
+mount AmcmsFilemanager::Engine => '/', as: :amcms_filemanager
+```
+
+Create an initialiser in your project
+
+`config/initialisers/amcms_filemanager.rb`
+
+
+```ruby
+AmcmsFilemanager::configure do |config|
+  config.root_path = 'images'
+  config.authentication = {
+    model: :user
+  }
+end
+```
+
+In your project where TinyMCE is located add this to initialise the filemanager:
+```js
+const amcmsFileManager = (type, callback) => tinymce.activeEditor.windowManager.openUrl({
+  title: 'AMCMS Filemanager',
+  url: `http://localhost:3000/filemanager?type=${type}`,
+  onMessage: function(instance, event) {
+    callback(event.data.location);
+    tinymce.activeEditor.windowManager.close();
+  },
+  width: window.innerWidth - 50,
+  height: window.innerHeight - 50,
+});
+```
+
+Next add a callback to the filepicker to trigger the filemanager for image, link and media dialogs:
+
+```js
+tinymce.init({
+  ...
+  file_picker_callback: (callback, value, meta) => {
+    amcmsFileManager(meta.filetype, callback);
+  }
+});
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/amcms_filemanager_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/amcms_filemanager .css

data/app/assets/stylesheets/amcms_filemanager/application.css

@@ -0,0 +1,34 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+.item-name {
+    overflow: hidden;
+}
+
+.fm-file-panel {
+    padding-top: 80px;
+}
+
+.fm-image-thumbnail {
+    width: 200px;
+    height: 200px;
+    object-fit: scale-down;
+    margin: 10px 0;
+}
+
+#image-preview-panel {
+    overflow-x:auto;
+}

data/app/assets/stylesheets/amcms_filemanager/filemanager.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/amcms_filemanager/application_controller.rb

@@ -0,0 +1,11 @@
+module AmcmsFilemanager
+  class ApplicationController < ActionController::Base
+    before_action :authenticate
+
+    def authenticate
+      return unless AmcmsFilemanager.config.try(:authentication).present?
+
+      send("authenticate_#{AmcmsFilemanager.config.authentication[:model]}!")
+    end
+  end
+end

data/app/controllers/amcms_filemanager/filemanager_controller.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module AmcmsFilemanager
+  class FilemanagerController < ApplicationController
+    before_action :item_exists?, only: %i[mkdir rename]
+
+    def index
+      @config = {
+        routes: {
+          cd_path: filemanager_change_directory_path,
+          mkdir_path: filemanager_mkdir_path,
+          rm_path: filemanager_destroy_path,
+          rename_path: filemanager_rename_path,
+          copy_path: filemanager_copy_path,
+          image_info_path: imagemanager_path(':id'),
+        },
+        type: params.fetch(:type, 'all')
+      }
+    end
+
+    def change_directory
+      @files = AmcmsFilemanager::Filemanager.list(params[:cd], params[:type])
+
+      render json: {
+        files: @files,
+        pwd: pwd,
+        pwd_name: pwd.split('/').last,
+        root_directory: AmcmsFilemanager.config.root_path,
+        parent_directory: AmcmsFilemanager::Filemanager.parent_dir(params[:cd])
+      }
+    end
+
+    def copy
+      if AmcmsFilemanager::Filemanager.copy(params[:item_name])
+        render json: { success: true }, status: 200
+      else
+        render json: { success: false }, status: 400
+      end
+    end
+
+    def mkdir
+      if AmcmsFilemanager::Filemanager.mkdir(params[:pwd], params[:item_name])
+        render json: { success: true }, status: 200
+      else
+        render json: { success: false }, status: 400
+      end
+    end
+
+    def rename
+      if AmcmsFilemanager::Filemanager.rename(params[:pwd], params[:original_filename], params[:item_name])
+        render json: { success: true }, status: 200
+      else
+        render json: { success: false }, status: 400
+      end
+    end
+
+    def destroy
+      if AmcmsFilemanager::Filemanager.delete(params[:file])
+        render json: { success: true }, status: 200
+      else
+        render json: { success: false }, status: 400
+      end
+    end
+
+    def upload
+      if AmcmsFilemanager::Filemanager::upload(params[:dir], params[:file], params[:type])
+        render json: { success: true }, status: 200
+      else
+        render json: { success: false }, status: 400
+      end
+    rescue CarrierWave::IntegrityError => e
+      render json: { error: e.message }, status: 400
+    end
+
+    private
+
+    def item_exists?
+      return true unless AmcmsFilemanager::Filemanager.exists?(params[:pwd], params[:item_name])
+
+      message = {
+        title: 'Error',
+        body: 'Item already exists. Please try a different name',
+        status: 'danger'
+      }
+      render json: { success: false, message: message }, status: 400
+      false
+    end
+
+    def pwd
+      @pwd ||= params[:cd].blank? ? AmcmsFilemanager.config.root_path : params[:cd].gsub(%r{^/}, '')
+    end
+  end
+end

data/app/controllers/amcms_filemanager/imagemanager_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AmcmsFilemanager
+  class ImagemanagerController < ApplicationController
+    def update
+      uploader = AmcmsFilemanager::FilemanagerUploader.new
+      uploader.retrieve_from_store!(source_file)
+      uploader.resize_to_fit(params[:width], params[:height])
+      render json: { success: true }
+    rescue StandardError => e
+      render json: { success: false, message: e.message }, status: 400
+    end 
+
+    def show
+      if AmcmsFilemanager::Filemanager.image?(source_file)
+        uploader = AmcmsFilemanager::FilemanagerUploader.new
+        uploader.retrieve_from_store!(source_file)
+        render json: { success: true, filepath: filepath, width: uploader.width, height: uploader.height, size: uploader.size }
+      else
+        render json: { success: false, error: 'File is not an image' }, status: 400
+      end
+    end
+
+    private
+
+    def source_file
+      @source_file ||= params[:copy] ? AmcmsFilemanager::Filemanager.copy(filepath) : Rails.root.join('public', filepath)
+    end
+
+    def filepath
+      "#{params[:id]}.#{params[:format]}".gsub(%r{^/}, '')
+    end
+  end
+end

data/app/helpers/amcms_filemanager/application_helper.rb

@@ -0,0 +1,4 @@
+module AmcmsFilemanager
+  module ApplicationHelper
+  end
+end

data/app/helpers/amcms_filemanager/filemanager_helper.rb

@@ -0,0 +1,4 @@
+module AmcmsFilemanager
+  module FilemanagerHelper
+  end
+end

data/app/jobs/amcms_filemanager/application_job.rb

@@ -0,0 +1,4 @@
+module AmcmsFilemanager
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/lib/amcms_filemanager/filemanager.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+# Filemanager class for handling all things file related
+class AmcmsFilemanager::Filemanager
+  class << self
+    # Make a copy of file in it's current directory
+    # @param [String | nil] dir
+    # @return [Sttring]
+    def copy(filename)
+      source_file = Rails.root.join('public', filename.gsub(/^\//, ''))
+
+      return false if File.directory?(source_file)
+
+      destination_dir = File.dirname(source_file)
+      base_name = File.basename(source_file)
+
+      destination_path = File.join(destination_dir, base_name)
+
+      if File.exist?(destination_path)
+        i = 1
+        while File.exist?(destination_path)
+          unique_name = "#{File.basename(source_file, '.*')}_#{i}#{File.extname(source_file)}"
+          destination_path = File.join(destination_dir, unique_name)
+          i += 1
+        end
+      end
+
+      FileUtils.cp(source_file, destination_path)
+      destination_path
+    end
+
+    def directory?(filename)
+      source_file = Rails.root.join('public', filename.gsub(/^\//, ''))
+
+      File.directory?(source_file)
+    end
+
+    # List all files in a given directory
+    # @param [String | nil] dir
+    # @param [String] type
+    # @return [Array]
+    def list(dir = nil, type = 'image')
+      dir = AmcmsFilemanager.config.root_path unless dir.present?
+      file_filter = AmcmsFilemanager.config.extension_allowlist.present? ? "*.{#{AmcmsFilemanager.config.extension_allowlist[type.to_sym].join(',')}}" : '*'
+      entries = Dir.glob(Rails.root.join('public', dir.gsub(%r{^/}, ''), file_filter))
+      entries.map! { |entry| file_details(entry) }
+
+      folders = entries.select { |entry| entry if entry[:directory] }.sort_by { |entry| entry[:filename] }.compact
+      files = entries.reject { |entry| entry if entry[:directory] }.sort_by { |entry| entry[:filename] }.compact
+
+      folders + files
+    end
+
+    # Return the parent directory
+    # @param [String | nil] dir
+    # @return [String]
+    def parent_dir(dir = nil)
+      dir = AmcmsFilemanager.config.root_path if !dir.present? || dir.blank?
+      return dir if dir == AmcmsFilemanager.config.root_path
+
+      File.dirname(dir).gsub(%r{^/}, '')
+    end
+
+    # Make a new directory
+    # @param [String] dir
+    # @param [String] directory_name
+    # @return [Integer]
+    def mkdir(dir, directory_name)
+      dir = AmcmsFilemanager.config.root_path unless dir.present?
+      Dir.mkdir(File.join(Rails.root.join('public', dir.gsub(%r{^/}, '')), directory_name), 0o775)
+    end
+
+    # Check to see if the directory exists
+    # @param [String] dir
+    # @param [String] filename
+    # @return [TrueClass, FalseClass]
+    def exists?(dir, filename)
+      dir = AmcmsFilemanager.config.root_path unless dir.present?
+      File.exist?(File.join(Rails.root.join('public', dir.gsub(%r{^/}, '')), filename))
+    end
+
+    # Delete a file or folder
+    # @param [String] file
+    # @return [Integer]
+    def delete(file)
+      filepath = Rails.root.join('public', file.gsub(%r{^/}, ''))
+
+      return File.delete(filepath) unless File.directory?(filepath)
+
+      FileUtils.remove_dir(filepath)
+    end
+
+    # Renames a file or directory
+    # @param [String] dir
+    # @param [String] original_filename
+    # @param [String] new_filename
+    # @return [Integer]
+    def rename(dir, original_filename, new_filename)
+      original_filepath = filepath(dir, original_filename)
+      new_filepath = filepath(dir, new_filename)
+
+      File.rename(original_filepath, new_filepath)
+    end
+
+    # Upload a file to the given directory
+    # @param [String] dir
+    # @param [ActionDispatch::Http::UploadedFile] file
+    # @param [String] type
+    def upload(dir, file, type = 'image')
+      uploader = AmcmsFilemanager::FilemanagerUploader.new
+      uploader.define_singleton_method(:store_dir) do
+        AmcmsFilemanager::Filemanager.filepath(dir, '')
+      end
+      uploader.store!(file)
+    end
+
+    # Create the filepath
+    # @param [String] dir
+    # @param [String] filename
+    # @return [String]
+    def filepath(dir, filename)
+      dir = "#{AmcmsFilemanager.config.root_path}/#{dir}" unless dir.include? AmcmsFilemanager.config.root_path
+      Rails.root.join('public', dir.gsub(%r{^/}, ''), filename)
+    end
+
+    # Detect if the file is an image
+    # @param [File] file
+    # @return [TrueClass, FalseClass]
+    def image?(file)
+      return false if File.directory?(file)
+
+      web_safe_images = [
+        'image/apng',
+        'image/avif',
+        'image/gif',
+        'image/jpeg',
+        'image/jpg',
+        'image/png',
+        'image/webp'
+      ].freeze
+
+      web_safe_images.include?(mimetype(file))
+    end
+
+    private
+
+    # Present a hash of the file attributes
+    # @param [String] file
+    # @return [Hash{Symbol->TrueClass | FalseClass}]
+    def file_details(file)
+      {
+        filename: File.basename(file),
+        filepath: file.gsub(Rails.root.join('public').to_s, ''),
+        directory: File.directory?(file),
+        size: filesize(file),
+        mimetype: mimetype(file),
+        image: image?(file),
+        date_modified: File.mtime(file).strftime('%d/%m/%Y %H:%M')
+      }
+    end
+
+    # Get the mimetype of the file
+    # @param [File] file
+    # @return [String]
+    def mimetype(file)
+      return '' if File.directory?(file)
+
+      Marcel::MimeType.for Pathname.new(file)
+    end
+
+    # Calculate the size of the file, returning the units of measure with the value
+    # @param [String] file
+    # @return [String (frozen)]
+    def filesize(file)
+      size = File.size(file) / 1000
+      return "#{size} kb" if size < 1000
+
+      "#{size / 1000} mb"
+    end
+  end
+end

data/app/lib/amcms_filemanager/imagemanager.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AmcmsFilemanager::Imagemanager
+
+end

data/app/mailers/amcms_filemanager/application_mailer.rb

@@ -0,0 +1,6 @@
+module AmcmsFilemanager
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/amcms_filemanager/application_record.rb

@@ -0,0 +1,5 @@
+module AmcmsFilemanager
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/uploaders/amcms_filemanager/filemanager_uploader.rb

@@ -0,0 +1,56 @@
+require 'carrierwave'
+
+class AmcmsFilemanager::FilemanagerUploader < CarrierWave::Uploader::Base
+  # Include RMagick or MiniMagick support:
+  # include CarrierWave::RMagick
+  include CarrierWave::MiniMagick
+
+  def initialize(type = 'image')
+    @file_type = type
+    super
+  end
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+  # storage :fog
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url(*args)
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process scale: [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  # version :thumb do
+  #   process resize_to_fit: [50, 50]
+  # end
+
+  # Add an allowlist of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  def extension_allowlist
+    return %w[jpg jpeg gif] unless AmcmsFilemanager.config.try(:extension_allowlist).present?
+
+    AmcmsFilemanager.config.extension_allowlist[@file_type.to_sym]
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+end