<%= content_tag(:label, "#{l(:label_act_as_attachable)}:") %> <%= select_tag 'act_as_attachable', diff --git a/app/views/hooks/redmine_dmsf/_view_my_account.html.erb b/app/views/hooks/redmine_dmsf/_view_my_account.html.erb index e15939dd..a11ac9d4 100644 --- a/app/views/hooks/redmine_dmsf/_view_my_account.html.erb +++ b/app/views/hooks/redmine_dmsf/_view_my_account.html.erb @@ -28,7 +28,7 @@
<%= pref_fields.check_box :receive_download_notification %>
<%= l(:label_dmsf_webdav_digest) %> <% token = Token.find_by(user_id: @user.id, action: 'dmsf_webdav_digest') %> diff --git a/extra/xapian_indexer.rb b/extra/xapian_indexer.rb index 2b05f26f..901a3bc5 100644 --- a/extra/xapian_indexer.rb +++ b/extra/xapian_indexer.rb @@ -141,7 +141,7 @@ begin # Indexing documents stem_langs.each do |lang| - filespath = Setting.plugin_redmine_dmsf['dmsf_storage_directory'] || File.join(REDMINE_ROOT, FILES) + filespath = RedmineDmsf.dmsf_storage_directory unless File.directory?(filespath) warn "'#{filespath}' doesn't exist." exit 1 diff --git a/init.rb b/init.rb index a2cb52d4..0602e313 100644 --- a/init.rb +++ b/init.rb @@ -56,7 +56,7 @@ Redmine::Plugin.register :redmine_dmsf do 'dmsf_webdav_use_project_names' => use_project_names, 'dmsf_webdav_ignore_1b_file_for_authentication' => '1', 'dmsf_projects_as_subfolders' => nil, - 'only_approval_zero_minor_version' => '0', + 'only_approval_zero_minor_version' => nil, 'dmsf_max_notification_receivers_info' => 10, 'office_bin' => 'libreoffice', 'dmsf_global_menu_disabled' => nil, diff --git a/lib/redmine_dmsf.rb b/lib/redmine_dmsf.rb index 4527f734..a2ecd8d5 100644 --- a/lib/redmine_dmsf.rb +++ b/lib/redmine_dmsf.rb @@ -18,6 +18,180 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +# Main module +module RedmineDmsf + # Settings + class << self + def dmsf_max_file_download + Setting.plugin_redmine_dmsf['dmsf_max_file_download'].to_i + end + + def dmsf_max_email_filesize + Setting.plugin_redmine_dmsf['dmsf_max_email_filesize'].to_i + end + + def dmsf_storage_directory + Setting.plugin_redmine_dmsf['dmsf_storage_directory'].presence || 'files/dmsf' + end + + def dmsf_index_database + Setting.plugin_redmine_dmsf['dmsf_index_database'].presence || File.expand_path('dmsf_index', Rails.root) + end + + def dmsf_stemming_lang + Setting.plugin_redmine_dmsf['dmsf_stemming_lang'].presence || 'english' + end + + def dmsf_stemming_strategy + Setting.plugin_redmine_dmsf['dmsf_stemming_strategy'].presence || 'STEM_NONE' + end + + def dmsf_webdav? + if Setting.plugin_redmine_dmsf['dmsf_webdav'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_webdav'] + else + Setting.plugin_redmine_dmsf['dmsf_webdav'].to_i.positive? + end + end + + def dmsf_display_notified_recipients? + if Setting.plugin_redmine_dmsf['dmsf_display_notified_recipients'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_display_notified_recipients'] + else + Setting.plugin_redmine_dmsf['dmsf_display_notified_recipients'].to_i.positive? + end + end + + def dmsf_global_title_format + Setting.plugin_redmine_dmsf['dmsf_global_title_format'].presence || '' + end + + def dmsf_columns + Setting.plugin_redmine_dmsf['dmsf_columns'].presence || DmsfFolder::DEFAULT_COLUMNS + end + + def dmsf_webdav_ignore + Setting.plugin_redmine_dmsf['dmsf_webdav_ignore'].presence || '^(\._|\.DS_Store$|Thumbs.db$)' + end + + def dmsf_webdav_disable_versioning + Setting.plugin_redmine_dmsf['dmsf_webdav_disable_versioning'].presence || '^\~\$|\.tmp$' + end + + def dmsf_keep_documents_locked? + if Setting.plugin_redmine_dmsf['dmsf_keep_documents_locked'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_keep_documents_locked'] + else + Setting.plugin_redmine_dmsf['dmsf_keep_documents_locked'].to_i.positive? + end + end + + def dmsf_act_as_attachable? + if Setting.plugin_redmine_dmsf['dmsf_act_as_attachable?'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_act_as_attachable?'] + else + Setting.plugin_redmine_dmsf['dmsf_act_as_attachable?'].to_i.positive? + end + end + + def dmsf_documents_email_from + Setting.plugin_redmine_dmsf['dmsf_documents_email_from'].presence || "#{User.current.name} <#{User.current.mail}>" + end + + def dmsf_documents_email_reply_to + Setting.plugin_redmine_dmsf['dmsf_documents_email_reply_to'].presence || '' + end + + def dmsf_documents_email_links_only? + if Setting.plugin_redmine_dmsf['dmsf_documents_email_links_only'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_documents_email_links_only'] + else + Setting.plugin_redmine_dmsf['dmsf_documents_email_links_only'].to_i.positive? + end + end + + def dmsf_enable_cjk_ngrams? + if Setting.plugin_redmine_dmsf['dmsf_enable_cjk_ngrams'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_enable_cjk_ngrams'] + else + Setting.plugin_redmine_dmsf['dmsf_enable_cjk_ngrams'].to_i.positive? + end + end + + def dmsf_webdav_use_project_names? + if Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'] + else + Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'].to_i.positive? + end + end + + def dmsf_webdav_ignore_1b_file_for_authentication? + if Setting.plugin_redmine_dmsf['dmsf_webdav_ignore_1b_file_for_authentication'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_webdav_ignore_1b_file_for_authentication'] + else + Setting.plugin_redmine_dmsf['dmsf_webdav_ignore_1b_file_for_authentication'].to_i.positive? + end + end + + def dmsf_projects_as_subfolders? + if Setting.plugin_redmine_dmsf['dmsf_projects_as_subfolders'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_projects_as_subfolders'] + else + Setting.plugin_redmine_dmsf['dmsf_projects_as_subfolders'].to_i.positive? + end + end + + def only_approval_zero_minor_version? + if Setting.plugin_redmine_dmsf['only_approval_zero_minor_version'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['only_approval_zero_minor_version'] + else + Setting.plugin_redmine_dmsf['only_approval_zero_minor_version'].to_i.positive? + end + end + + def dmsf_max_notification_receivers_info + Setting.plugin_redmine_dmsf['dmsf_max_notification_receivers_info'].positive? + end + + def office_bin + Setting.plugin_redmine_dmsf['office_bin'].presence || '' + end + + def dmsf_global_menu_disabled? + if Setting.plugin_redmine_dmsf['dmsf_global_menu_disabled'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['dmsf_global_menu_disabled'] + else + Setting.plugin_redmine_dmsf['dmsf_global_menu_disabled'].to_i.positive? + end + end + + def dmsf_default_query + Setting.plugin_redmine_dmsf['dmsf_default_query'].presence || '' + end + + def empty_minor_version_by_default? + if Setting.plugin_redmine_dmsf['empty_minor_version_by_default'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['empty_minor_version_by_default'] + else + Setting.plugin_redmine_dmsf['empty_minor_version_by_default'].to_i.positive? + end + end + + def remove_original_documents_module? + if Setting.plugin_redmine_dmsf['remove_original_documents_module'].is_a?(TrueClass) + Setting.plugin_redmine_dmsf['remove_original_documents_module'] + else + Setting.plugin_redmine_dmsf['remove_original_documents_module'].to_i.positive? + end + end + + def dmsf_webdav_authentication + Setting.plugin_redmine_dmsf['dmsf_webdav_authentication'].presence || 'Basic' + end + end +end + # DMSF libraries # Validators diff --git a/lib/redmine_dmsf/errors/dmsf_email_max_file_size_error.rb b/lib/redmine_dmsf/errors/dmsf_email_max_file_size_error.rb index 1e232d15..3224199a 100644 --- a/lib/redmine_dmsf/errors/dmsf_email_max_file_size_error.rb +++ b/lib/redmine_dmsf/errors/dmsf_email_max_file_size_error.rb @@ -28,7 +28,7 @@ module RedmineDmsf if message.present? super else - super(l(:error_max_email_filesize_exceeded, number: Setting.plugin_redmine_dmsf['dmsf_max_email_filesize'])) + super(l(:error_max_email_filesize_exceeded, number: RedmineDmsf.dmsf_max_email_filesize)) end end end diff --git a/lib/redmine_dmsf/errors/dmsf_zip_max_files_error.rb b/lib/redmine_dmsf/errors/dmsf_zip_max_files_error.rb index f076492e..b715097a 100644 --- a/lib/redmine_dmsf/errors/dmsf_zip_max_files_error.rb +++ b/lib/redmine_dmsf/errors/dmsf_zip_max_files_error.rb @@ -28,7 +28,7 @@ module RedmineDmsf if message.present? super else - super(l(:error_max_files_exceeded, number: Setting.plugin_redmine_dmsf['dmsf_max_file_download'])) + super(l(:error_max_files_exceeded, number: RedmineDmsf.dmsf_max_file_download)) end end end diff --git a/lib/redmine_dmsf/hooks/controllers/account_controller_hooks.rb b/lib/redmine_dmsf/hooks/controllers/account_controller_hooks.rb index 61bd8e36..a4c12a02 100644 --- a/lib/redmine_dmsf/hooks/controllers/account_controller_hooks.rb +++ b/lib/redmine_dmsf/hooks/controllers/account_controller_hooks.rb @@ -32,7 +32,7 @@ module RedmineDmsf user = context[:user] return unless user - return unless Setting.plugin_redmine_dmsf['dmsf_webdav_authentication'] == 'Digest' + return unless RedmineDmsf.dmsf_webdav_authentication == 'Digest' # Updates user's DMSF WebDAV digest if controller.params[:password].present? diff --git a/lib/redmine_dmsf/hooks/views/issue_view_hooks.rb b/lib/redmine_dmsf/hooks/views/issue_view_hooks.rb index eb90059f..3bbdd6fb 100644 --- a/lib/redmine_dmsf/hooks/views/issue_view_hooks.rb +++ b/lib/redmine_dmsf/hooks/views/issue_view_hooks.rb @@ -114,7 +114,7 @@ module RedmineDmsf def allowed_to_attach_documents(container) container.respond_to?(:saved_dmsf_attachments) && container.project && User.current.allowed_to?(:file_manipulation, container.project) && - Setting.plugin_redmine_dmsf['dmsf_act_as_attachable'] && + RedmineDmsf.dmsf_act_as_attachable? && (container.project&.dmsf_act_as_attachable == Project::ATTACHABLE_DMS_AND_ATTACHMENTS) end @@ -128,7 +128,7 @@ module RedmineDmsf links = [] if defined?(container.dmsf_files) && User.current.allowed_to?(:view_dmsf_files, container.project) && - Setting.plugin_redmine_dmsf['dmsf_act_as_attachable'] && + RedmineDmsf.dmsf_act_as_attachable? && container.project.dmsf_act_as_attachable == Project::ATTACHABLE_DMS_AND_ATTACHMENTS container.dmsf_files.each do |dmsf_file| links << [dmsf_file, nil, dmsf_file.created_at] if dmsf_file.last_revision diff --git a/lib/redmine_dmsf/patches/access_control_patch.rb b/lib/redmine_dmsf/patches/access_control_patch.rb index 9012bf94..5eb019bb 100644 --- a/lib/redmine_dmsf/patches/access_control_patch.rb +++ b/lib/redmine_dmsf/patches/access_control_patch.rb @@ -34,7 +34,7 @@ module RedmineDmsf module ClassMethods def available_project_modules # Removes the original Documents from project's modules (replaced with DMSF) - if Setting.plugin_redmine_dmsf['remove_original_documents_module'] + if RedmineDmsf.remove_original_documents_module? super.reject { |m| m == :documents } else super diff --git a/lib/redmine_dmsf/patches/search_patch.rb b/lib/redmine_dmsf/patches/search_patch.rb index 987d2386..7ed0daa7 100644 --- a/lib/redmine_dmsf/patches/search_patch.rb +++ b/lib/redmine_dmsf/patches/search_patch.rb @@ -34,7 +34,7 @@ module RedmineDmsf module ClassMethods def available_search_types # Removes the original Documents from searching (replaced with DMSF) - if Setting.plugin_redmine_dmsf['remove_original_documents_module'] + if RedmineDmsf.remove_original_documents_module? super.reject { |t| t == 'documents' } else super diff --git a/lib/redmine_dmsf/webdav/base_resource.rb b/lib/redmine_dmsf/webdav/base_resource.rb index bca65725..35a9823b 100644 --- a/lib/redmine_dmsf/webdav/base_resource.rb +++ b/lib/redmine_dmsf/webdav/base_resource.rb @@ -39,7 +39,7 @@ module RedmineDmsf ) def initialize(path, request, response, options) - raise NotFound if Setting.plugin_redmine_dmsf['dmsf_webdav'].blank? + raise NotFound unless RedmineDmsf.dmsf_webdav? @project = nil @public_path = "#{options[:root_uri_path]}#{path}" @@ -162,7 +162,7 @@ module RedmineDmsf def get_project(scope, name, parent_project) prj = nil scope = scope.where(parent_id: parent_project.id) if parent_project - if Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'] + if RedmineDmsf.dmsf_webdav_use_project_names? if name =~ /^\[?.+ (\d+)\]?$/ prj = scope.find_by(id: Regexp.last_match(1)) # Check again whether it's really the project and not a folder with a number as a suffix diff --git a/lib/redmine_dmsf/webdav/dmsf_controller.rb b/lib/redmine_dmsf/webdav/dmsf_controller.rb index bd82aec7..45d09bbc 100644 --- a/lib/redmine_dmsf/webdav/dmsf_controller.rb +++ b/lib/redmine_dmsf/webdav/dmsf_controller.rb @@ -33,7 +33,7 @@ module RedmineDmsf end def process - return super unless Setting.plugin_redmine_dmsf['dmsf_webdav_authentication'] == 'Digest' + return super unless RedmineDmsf.dmsf_webdav_authentication == 'Digest' status = skip_authorization? || authenticate ? process_action || OK : Dav4rack::HttpStatus::Unauthorized rescue Dav4rack::HttpStatus::Status => e @@ -52,7 +52,7 @@ module RedmineDmsf end def authenticate - return super unless Setting.plugin_redmine_dmsf['dmsf_webdav_authentication'] == 'Digest' + return super unless RedmineDmsf.dmsf_webdav_authentication == 'Digest' auth_header = request.authorization.to_s scheme = auth_header.split(' ', 2).first&.downcase diff --git a/lib/redmine_dmsf/webdav/dmsf_resource.rb b/lib/redmine_dmsf/webdav/dmsf_resource.rb index 4064dd9e..eb42ddf3 100644 --- a/lib/redmine_dmsf/webdav/dmsf_resource.rb +++ b/lib/redmine_dmsf/webdav/dmsf_resource.rb @@ -199,11 +199,11 @@ module RedmineDmsf end raise Locked if file.locked_for_user? - pattern = Setting.plugin_redmine_dmsf['dmsf_webdav_disable_versioning'] + pattern = RedmineDmsf.dmsf_webdav_disable_versioning # Files that are not versioned should be destroyed # Zero-sized files should be destroyed b = !file.last_revision || file.last_revision.size.zero? - destroy = (pattern.present? && basename.match(pattern)) || b + destroy = basename.match(pattern) || b if file.delete(commit: destroy) DmsfMailer.deliver_files_deleted project, [file] NoContent @@ -551,8 +551,7 @@ module RedmineDmsf if exist? # We're over-writing something, so ultimately a new revision f = file # Disable versioning for file name patterns given in the plugin settings. - pattern = Setting.plugin_redmine_dmsf['dmsf_webdav_disable_versioning'] - if pattern.present? && basename.match(pattern) + if basename.match(RedmineDmsf.dmsf_webdav_disable_versioning) Rails.logger.info "Versioning disabled for #{basename}" reuse_revision = true end @@ -611,8 +610,7 @@ module RedmineDmsf end # Ignore 1b files sent for authentication - if Setting.plugin_redmine_dmsf['dmsf_webdav_ignore_1b_file_for_authentication'].present? && - new_revision.size == 1 + if RedmineDmsf.dmsf_webdav_ignore_1b_file_for_authentication? && new_revision.size == 1 Rails.logger.warn "1b file '#{basename}' sent for authentication ignored" return NoContent end @@ -797,9 +795,7 @@ module RedmineDmsf def ignore? # Ignore file name patterns given in the plugin settings - pattern = Setting.plugin_redmine_dmsf['dmsf_webdav_ignore'] - pattern = /^(\._|\.DS_Store$|Thumbs.db$)/ if pattern.blank? - if basename.match(pattern) + if basename.match(RedmineDmsf.dmsf_webdav_ignore) Rails.logger.info "#{basename} ignored" return true end diff --git a/lib/redmine_dmsf/webdav/project_resource.rb b/lib/redmine_dmsf/webdav/project_resource.rb index 0d1d1435..55e87683 100644 --- a/lib/redmine_dmsf/webdav/project_resource.rb +++ b/lib/redmine_dmsf/webdav/project_resource.rb @@ -31,7 +31,7 @@ module RedmineDmsf return @children unless project # Sub-projects - load_projects(project.children) if Setting.plugin_redmine_dmsf['dmsf_projects_as_subfolders'] + load_projects(project.children) if RedmineDmsf.dmsf_projects_as_subfolders? return @children unless project.module_enabled?(:dmsf) # Folders @@ -118,7 +118,7 @@ module RedmineDmsf def self.create_project_name(prj) return unless prj - if Setting.plugin_redmine_dmsf['dmsf_webdav_use_project_names'] + if RedmineDmsf.dmsf_webdav_use_project_names? "[#{DmsfFolder.get_valid_title(prj.name)} #{prj.id}]" else "[#{prj.identifier}]" diff --git a/lib/redmine_dmsf/webdav/resource_proxy.rb b/lib/redmine_dmsf/webdav/resource_proxy.rb index 79224adf..17ccc2e7 100644 --- a/lib/redmine_dmsf/webdav/resource_proxy.rb +++ b/lib/redmine_dmsf/webdav/resource_proxy.rb @@ -32,7 +32,7 @@ module RedmineDmsf # Check the settings cache for each request Setting.check_cache # Return 404 - NotFound if WebDAV is not enabled - raise NotFound unless Setting.plugin_redmine_dmsf['dmsf_webdav'] + raise NotFound unless RedmineDmsf.dmsf_webdav? super rc = get_resource_class(path) diff --git a/test/functional/dmsf_controller_test.rb b/test/functional/dmsf_controller_test.rb index a25ac74a..096fe18b 100644 --- a/test/functional/dmsf_controller_test.rb +++ b/test/functional/dmsf_controller_test.rb @@ -344,7 +344,7 @@ class DmsfControllerTest < RedmineDmsf::Test::TestCase with_settings plugin_redmine_dmsf: { 'dmsf_documents_email_from' => 'karel.picman@kontron.com' } do post "/projects/#{@project1.id}/dmsf/entries", params: { email_entries: true, ids: ["file-#{@file1.id}"] } assert_response :success - assert_select "input:match('value', ?)", Setting.plugin_redmine_dmsf['dmsf_documents_email_from'] + assert_select "input:match('value', ?)", RedmineDmsf.dmsf_documents_email_from end end @@ -353,7 +353,7 @@ class DmsfControllerTest < RedmineDmsf::Test::TestCase with_settings plugin_redmine_dmsf: { 'dmsf_documents_email_reply_to' => 'karel.picman@kontron.com' } do post "/projects/#{@project1.id}/dmsf/entries", params: { email_entries: true, ids: ["file-#{@file1.id}"] } assert_response :success - assert_select "input:match('value', ?)", Setting.plugin_redmine_dmsf['dmsf_documents_email_reply_to'] + assert_select "input:match('value', ?)", RedmineDmsf.dmsf_documents_email_reply_to end end