# frozen_string_literal: true # Redmine plugin for Document Management System "Features" # # Copyright © 2011 Vít Jonáš # Copyright © 2011-23 Karel Pičman # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. require "#{File.dirname(__FILE__)}/../../lib/redmine_dmsf/lockable" require 'English' # File class DmsfFile < ApplicationRecord include RedmineDmsf::Lockable belongs_to :project belongs_to :dmsf_folder belongs_to :deleted_by_user, class_name: 'User' has_many :dmsf_file_revisions, -> { order(created_at: :desc, id: :desc) }, dependent: :destroy, inverse_of: :dmsf_file has_many :locks, -> { where(entity_type: 0).order(updated_at: :desc) }, class_name: 'DmsfLock', foreign_key: 'entity_id', dependent: :destroy, inverse_of: :dmsf_file has_many :referenced_links, -> { where target_type: DmsfFile.model_name.to_s }, class_name: 'DmsfLink', foreign_key: 'target_id', dependent: :destroy, inverse_of: false has_many :dmsf_public_urls, dependent: :destroy STATUS_DELETED = 1 STATUS_ACTIVE = 0 scope :visible, -> { where(deleted: STATUS_ACTIVE) } scope :deleted, -> { where(deleted: STATUS_DELETED) } validates :name, dmsf_file_name: true validates :name, uniqueness: { scope: %i[dmsf_folder_id project_id deleted], conditions: -> { where(deleted: STATUS_ACTIVE) }, case_sensitive: true } acts_as_event title: proc { |o| o.name }, description: proc { |o| desc = Redmine::Search.cache_store.fetch("DmsfFile-#{o.id}") if desc Redmine::Search.cache_store.delete("DmsfFile-#{o.id}") else # Set desc to an empty string if o.description is nil desc = o.description.nil? ? +'' : +o.description desc += ' / ' if o.description.present? && o.last_revision.comment.present? desc += o.last_revision.comment if o.last_revision.comment.present? end desc }, url: proc { |o| { controller: 'dmsf_files', action: 'view', id: o } }, datetime: proc { |o| o.updated_at }, author: proc { |o| o.last_revision.user } acts_as_watchable acts_as_searchable( columns: [ "#{table_name}.name", "#{DmsfFileRevision.table_name}.title", "#{DmsfFileRevision.table_name}.description", "#{DmsfFileRevision.table_name}.comment" ], project_key: 'project_id', date_column: "#{table_name}.updated_at" ) before_create :default_values before_destroy :delete_system_folder_before after_destroy :delete_system_folder_after attr_writer :last_revision def self.previews_storage_path Rails.root.join 'tmp/dmsf_previews' end def default_values return unless Setting.plugin_redmine_dmsf['dmsf_default_notifications'].present? && (!dmsf_folder || !dmsf_folder.system) self.notification = true end def initialize(*args) super self.watcher_user_ids = [] if new_record? end def self.storage_path path = Setting.plugin_redmine_dmsf['dmsf_storage_directory'].try(:strip) if path.blank? path = Pathname.new('files').join('dmsf').to_s else pn = Pathname.new(path) return pn if pn.absolute? end Rails.root.join path end def self.find_file_by_name(project, folder, name) findn_file_by_name project&.id, folder, name end def self.findn_file_by_name(project_id, folder, name) visible.find_by project_id: project_id, dmsf_folder_id: folder&.id, name: name end def approval_allowed_zero_minor last_revision.minor_version.zero? if Setting.plugin_redmine_dmsf['only_approval_zero_minor_version'] true end def last_revision unless defined?(@last_revision) @last_revision = deleted? ? dmsf_file_revisions.first : dmsf_file_revisions.visible.first end @last_revision end def deleted? deleted == STATUS_DELETED end def locked_by if lock && lock.reverse[0] user = lock.reverse[0].user return user == User.current ? l(:label_me) : user.name if user end '' end def delete(commit: false) if locked_for_user? && !User.current.allowed_to?(:force_file_unlock, project) Rails.logger.info l(:error_file_is_locked) if lock.reverse[0].user errors.add(:base, l(:title_locked_by_user, user: lock.reverse[0].user)) else errors.add(:base, l(:error_file_is_locked)) end return false end begin # Revisions and links of a deleted file SHOULD be deleted too dmsf_file_revisions.each { |r| r.delete(commit: commit, force: true) } if commit destroy else self.deleted = STATUS_DELETED self.deleted_by_user = User.current save end rescue StandardError => e Rails.logger.error e.message errors.add :base, e.message false end end def restore if dmsf_folder_id && (dmsf_folder.nil? || dmsf_folder.deleted?) errors.add(:base, l(:error_parent_folder)) return false end dmsf_file_revisions.each(&:restore) self.deleted = STATUS_ACTIVE self.deleted_by_user = nil save end def title last_revision ? last_revision.title : name end def description last_revision ? last_revision.description : '' end def version last_revision ? last_revision.version : '0' end def workflow last_revision&.workflow end def size last_revision ? last_revision.size : 0 end def dmsf_path path = dmsf_folder ? dmsf_folder.dmsf_path : [] path.push self path end def dmsf_path_str dmsf_path.map(&:title).join('/') end def notify? notification || dmsf_folder&.notify? || (!dmsf_folder && project.dmsf_notification) end def get_all_watchers(watchers) watchers.concat notified_watchers if dmsf_folder watchers.concat dmsf_folder.notified_watchers else watchers.concat project.notified_watchers end end def notify_deactivate self.notification = nil save! end def notify_activate self.notification = true save! end # Returns an array of projects that current user can copy file to def self.allowed_target_projects_on_copy projects = [] if User.current.admin? projects = Project.visible.has_module('dmsf').all elsif User.current.logged? User.current.memberships.each do |m| projects << m.project if m.project.module_enabled?('dmsf') && m.roles.detect { |r| r.allowed_to?(:file_manipulation) } end end projects end def move_to(project, folder) unless last_revision errors.add :base, l(:error_at_least_one_revision_must_be_present) Rails.logger.error l(:error_at_least_one_revision_must_be_present) return false end source = "#{self.project.identifier}:#{dmsf_path_str}" self.project = project self.dmsf_folder = folder new_revision = last_revision.clone new_revision.user_id = last_revision.user_id new_revision.workflow = nil new_revision.dmsf_workflow_id = nil new_revision.dmsf_workflow_assigned_by_user_id = nil new_revision.dmsf_workflow_assigned_at = nil new_revision.dmsf_workflow_started_by_user_id = nil new_revision.dmsf_workflow_started_at = nil new_revision.dmsf_file = self new_revision.comment = l(:comment_moved_from, source: source) new_revision.custom_values = [] last_revision.custom_values.each do |cv| new_revision.custom_values << CustomValue.new({ custom_field: cv.custom_field, value: cv.value }) end self.last_revision = new_revision save && new_revision.save end def copy_to(project, folder = nil) copy_to_filename project, folder, name end def copy_to_filename(project, folder, filename) file = DmsfFile.new file.dmsf_folder_id = folder.id if folder file.project_id = project.id if DmsfFile.exists?(project_id: file.project_id, dmsf_folder_id: file.dmsf_folder_id, name: filename) 1.step do |i| gen_filename = " #{filename} #{l(:dmsf_copy, n: i)}" unless DmsfFile.exists?(project_id: file.project_id, dmsf_folder_id: file.dmsf_folder_id, name: gen_filename) filename = gen_filename break end end end file.name = filename file.notification = Setting.plugin_redmine_dmsf['dmsf_default_notifications'].present? if file.save && last_revision new_revision = last_revision.clone new_revision.dmsf_file = file new_revision.disk_filename = new_revision.new_storage_filename # Assign the same workflow if it's a global one or we are in the same project new_revision.workflow = nil new_revision.dmsf_workflow_id = nil new_revision.dmsf_workflow_assigned_by_user_id = nil new_revision.dmsf_workflow_assigned_at = nil new_revision.dmsf_workflow_started_by_user_id = nil new_revision.dmsf_workflow_started_at = nil wf = last_revision.dmsf_workflow if wf && (wf.project.nil? || (wf.project.id == project.id)) new_revision.set_workflow wf.id, nil new_revision.assign_workflow wf.id end if File.exist? last_revision.disk_file FileUtils.cp last_revision.disk_file, new_revision.disk_file(search_if_not_exists: false) end new_revision.comment = l(:comment_copied_from, source: "#{self.project.identifier}:#{dmsf_path_str}") new_revision.custom_values = [] last_revision.custom_values.each do |cv| v = CustomValue.new v.custom_field = cv.custom_field v.value = cv.value new_revision.custom_values << v end if new_revision.save file.last_revision = new_revision else errors.add :base, new_revision.errors.full_messages.to_sentence Rails.logger.error new_revision.errors.full_messages.to_sentence file.delete commit: true file = nil end else Rails.logger.error file.errors.full_messages.to_sentence file.delete commit: true file = nil end file end # To fulfill searchable module expectations def self.search(tokens, projects = nil, options = {}, user = User.current) tokens = [] << tokens unless tokens.is_a?(Array) projects = [] << projects if projects.is_a?(Project) project_ids = projects.collect(&:id) if projects limit_options = ["dmsf_files.updated_at #{options[:before] ? '<' : '>'} ?", options[:offset]] if options[:offset] columns = if options[:titles_only] [searchable_options[:columns][1]] else searchable_options[:columns] end token_clauses = columns.collect { |column| "(LOWER(#{column}) LIKE ?)" } sql = (["(#{token_clauses.join(' OR ')})"] * tokens.size).join(options[:all_words] ? ' AND ' : ' OR ') find_options = [sql, * (tokens.collect { |w| "%#{w.downcase}%" } * token_clauses.size).sort] project_conditions = [] project_conditions << Project.allowed_to_condition(user, :view_dmsf_files) project_conditions << "#{Project.table_name}.id IN (#{project_ids.join(',')})" if project_ids.present? scope = visible .joins('JOIN dmsf_file_revisions ON dmsf_file_revisions.dmsf_file_id = dmsf_files.id') .joins(:project) scope = scope.limit(options[:limit]) if options[:limit].present? scope = scope.where(limit_options) if limit_options.present? scope = scope.where(project_conditions.join(' AND ')) results = scope.where(find_options).uniq.to_a results.delete_if { |x| !DmsfFolder.permissions?(x.dmsf_folder) } if !options[:titles_only] && RedmineDmsf::Plugin.xapian_available? database = nil begin unless Setting.plugin_redmine_dmsf['dmsf_stemming_lang'] raise StandardError, "'dmsf_stemming_lang' option is not set" end lang = Setting.plugin_redmine_dmsf['dmsf_stemming_lang'].strip unless Setting.plugin_redmine_dmsf['dmsf_index_database'] raise StandardError, "'dmsf_index_database' option is not set" end databasepath = File.join(Setting.plugin_redmine_dmsf['dmsf_index_database'].strip, lang) database = Xapian::Database.new(databasepath) rescue StandardError => e Rails.logger.error "REDMINE_XAPIAN ERROR: Xapian database is not properly set, initiated or it's corrupted." Rails.logger.error e.message end if database enquire = Xapian::Enquire.new(database) # Combine the rest of the command line arguments with spaces between # them, so that simple queries don't have to be quoted at the shell # level. query_string = tokens.map { |x| x[-1, 1].eql?('*') ? x : "#{x}*" }.join(' ') qp = Xapian::QueryParser.new stemmer = Xapian::Stem.new(lang) qp.stemmer = stemmer qp.database = database case Setting.plugin_redmine_dmsf['dmsf_stemming_strategy'].strip when 'STEM_NONE' qp.stemming_strategy = Xapian::QueryParser::STEM_NONE when 'STEM_SOME' qp.stemming_strategy = Xapian::QueryParser::STEM_SOME when 'STEM_ALL' qp.stemming_strategy = Xapian::QueryParser::STEM_ALL end qp.default_op = if options[:all_words] Xapian::Query::OP_AND else Xapian::Query::OP_OR end flags = Xapian::QueryParser::FLAG_WILDCARD flags |= Xapian::QueryParser::FLAG_CJK_NGRAM if Setting.plugin_redmine_dmsf['dmsf_enable_cjk_ngrams'] query = qp.parse_query(query_string, flags) enquire.query = query matchset = enquire.mset(0, 1000) matchset&.matches&.each do |m| docdata = m.document.data { url } dochash = Hash[*docdata.scan(%r{(url|sample|modtime|author|type|size)=/?([^\n\]]+)}).flatten] filename = dochash['url'] next unless filename dmsf_attrs = filename.scan(%r{^([^/]+/[^_]+)_(\d+)_(.*)$}) id_attribute = 0 id_attribute = dmsf_attrs[0][1] if dmsf_attrs.length.positive? next if dmsf_attrs.empty? || id_attribute.to_i.zero? next unless results.none? { |f| f.id.to_s == id_attribute } dmsf_file = DmsfFile.visible.where(limit_options).find_by(id: id_attribute) next unless dmsf_file && DmsfFolder.permissions?(dmsf_file.dmsf_folder) && user.allowed_to?(:view_dmsf_files, dmsf_file.project) && (project_ids.blank? || project_ids.include?(dmsf_file.project_id)) if dochash['sample'] Redmine::Search.cache_store.write("DmsfFile-#{dmsf_file.id}", dochash['sample'].force_encoding('UTF-8')) end break if options[:limit].present? && results.count >= options[:limit] results << dmsf_file end end end [results, results.count] end def self.search_result_ranks_and_ids(tokens, user = User.current, projects = nil, options = {}) r = search(tokens, projects, options, user)[0] r.map { |f| [f.updated_at.to_i, f.id] } end def display_name member = Member.find_by(user_id: User.current.id, project_id: project_id) fname = formatted_name(member) return "#{fname[0, 25]}...#{fname[-25, 25]}" if fname.length > 50 fname end def text? Redmine::MimeType.is_type?('text', last_revision&.disk_filename) end def image? Redmine::MimeType.is_type?('image', last_revision&.disk_filename) end def pdf? Redmine::MimeType.of(last_revision&.disk_filename) == 'application/pdf' end def video? Redmine::MimeType.is_type?('video', last_revision&.disk_filename) end def html? Redmine::MimeType.of(last_revision&.disk_filename) == 'text/html' end def office_doc? case File.extname(last_revision&.disk_filename) when '.odt', '.ods', '.odp', '.odg', # LibreOffice '.doc', '.docx', '.docm', '.xls', '.xlsx', '.xlsm', '.ppt', '.pptx', '.pptm', # MS Office '.rtf' # Universal true else false end end def disposition image? || pdf? || video? || html? ? 'inline' : 'attachment' end def thumbnailable? image? && Redmine::Thumbnail.convert_available? end def previewable? office_doc? && RedmineDmsf::Preview.office_available? end # Deletes all previews def self.clear_previews Dir.glob(File.join(DmsfFile.previews_storage_path, '*.pdf')).each do |file| File.delete file end end def pdf_preview return '' unless previewable? target = File.join(DmsfFile.previews_storage_path, "#{File.basename(last_revision&.disk_file.to_s, '.*')}.pdf") begin RedmineDmsf::Preview.generate last_revision&.disk_file.to_s, target rescue StandardError => e Rails.logger.error do %(An error occurred while generating preview for #{last_revision&.disk_file} to #{target}\n Exception was: #{e.message}) end '' end end def text_preview(limit) result = +'No preview available' if text? begin f = File.new(last_revision.disk_file) f.each_line do |line| case f.lineno when 1 result = line when limit.to_i + 1 break else result << line end end rescue StandardError => e result = e.message end end result end def formatted_name(member) if last_revision last_revision.formatted_name(member) else name end end def owner?(user) last_revision&.user == user end def involved?(user) dmsf_file_revisions.each do |file_revision| return true if file_revision.user == user end false end def assigned?(user) if last_revision&.dmsf_workflow last_revision.dmsf_workflow.next_assignments(last_revision.id).each do |assignment| return true if assignment.user == user end end false end def custom_value(custom_field) last_revision.custom_field_values.each do |cv| return cv if cv.custom_field == custom_field end nil end def extension File.extname(last_revision.disk_filename).strip.downcase[1..] if last_revision end def thumbnail(options = {}) return unless image? size = options[:size].to_i if size.positive? # Limit the number of thumbnails per image size = (size / 50) * 50 # Maximum thumbnail size size = 800 if size > 800 else size = Setting.thumbnails_size.to_i end size = 100 unless size.positive? target = File.join(Attachment.thumbnails_storage_path, "#{id}_#{last_revision.digest}_#{size}.thumb") begin Redmine::Thumbnail.generate last_revision.disk_file.to_s, target, size rescue StandardError => e Rails.logger.error do %(An error occured while generating thumbnail for #{last_revision.disk_file} to #{target}\n Exception was: #{e.message}) end nil end end def locked_title if locked_for_user? return l(:title_locked_by_user, user: lock.reverse[0].user) if lock.reverse[0].user return l(:notice_account_unknown_email) end l(:title_unlock_file) end def container return unless dmsf_folder&.system && dmsf_folder.title&.match(/(^\d+)/) issue_id = Regexp.last_match(1) parent = dmsf_folder.dmsf_folder Regexp.last_match(1).constantize.visible.find_by(id: issue_id) if parent&.title&.match(/^\.(.+)s/) end if defined?(EasyExtensions) include Redmine::Utils::Shell def sheet? case File.extname(last_revision&.disk_filename) when '.ods', # LibreOffice '.xls', '.xlsx', '.xlsm' # MS Office true else false end end def content if File.exist?(last_revision.disk_file) if File.size?(last_revision.disk_file) < 5.megabytes tmp = Rails.root.join('tmp') if sheet? cmd = "#{shell_quote(RedmineDmsf::Preview::OFFICE_BIN)} --convert-to 'csv' \ --outdir #{shell_quote(tmp.to_s)} #{shell_quote(last_revision.disk_file)}" text_file = tmp.join(last_revision.disk_filename).sub_ext('.csv') elsif office_doc? cmd = "#{shell_quote(RedmineDmsf::Preview::OFFICE_BIN)} --convert-to 'txt:Text (encoded):UTF8' \ --outdir #{shell_quote(tmp.to_s)} #{shell_quote(last_revision.disk_file)}" text_file = tmp.join(last_revision.disk_filename).sub_ext('.txt') elsif pdf? text_file = tmp.join(last_revision.disk_filename).sub_ext('.txt') cmd = "pdftotext -q #{shell_quote(last_revision.disk_file)} #{shell_quote(text_file.to_s)}" elsif text? return File.read(last_revision.disk_file) end if cmd if system(cmd) && File.exist?(text_file) text = File.read(text_file) FileUtils.rm_f text_file return text else Rails.logger.error "Conversion to text failed (#{$CHILD_STATUS}):\nCommand: #{cmd}" end end else Rails.logger.warn "File #{last_revision.disk_file} is to big to be indexed (>5MB)" end end description rescue StandardError => e Rails.logger.warn e.message '' ensure FileUtils.rm_f(text_file) if text_file.present? end end def to_s name end def delete_system_folder_before @parent_folder = dmsf_folder end def delete_system_folder_after return unless @parent_folder&.system && @parent_folder.dmsf_files.empty? && @parent_folder.dmsf_links.empty? @parent_folder&.destroy end end