Files
openproject/modules/documents/lib/open_project/documents/engine.rb
T
2025-11-19 14:31:07 +01:00

112 lines
3.7 KiB
Ruby

# frozen_string_literal: true
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# 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.
#
# See COPYRIGHT and LICENSE files for more details.
#++
module OpenProject::Documents
class Engine < ::Rails::Engine
engine_name :openproject_documents
include OpenProject::Plugins::ActsAsOpEngine
register "openproject-documents",
author_url: "http://www.openproject.org",
bundled: true do
::Redmine::MenuManager.map(:project_menu) do |menu|
menu.push :documents,
{ controller: "/documents", action: "index" },
caption: :label_document_plural,
before: :members,
icon: "note"
menu.push :documents_sub_menu,
{ controller: "/documents", action: "index" },
parent: :documents,
partial: "documents/menus/menu",
caption: :label_document_plural
end
project_module :documents do |_map|
permission :view_documents,
{ documents: %i[index search show download render_avatars],
"documents/menus": %i[show] },
permissible_on: :project
permission :manage_documents,
{
documents: %i[
new create edit edit_title cancel_title_edit update update_title update_type delete_dialog destroy
]
},
permissible_on: :project,
require: :loggedin
end
menu :admin_menu,
:document_categories,
{ controller: "/admin/settings/document_categories", action: :index },
if: ->(_) { User.current.admin? },
caption: :"documents.label_categories",
parent: :files
Redmine::Search.register :documents
end
activity_provider :documents, class_name: "Activities::DocumentActivityProvider", default: false
patches %i[Project]
add_api_path :documents do
"#{root}/documents"
end
add_api_path :document do |id|
"#{root}/documents/#{id}"
end
add_api_path :attachments_by_document do |id|
"#{document(id)}/attachments"
end
add_api_path :prepare_attachments_by_document do |id|
"#{document(id)}/attachments/prepare"
end
add_api_endpoint "API::V3::Root" do
mount ::API::V3::Documents::DocumentsAPI
end
# Add documents to allowed search params
additional_permitted_attributes search: %i(documents)
config.to_prepare do
# Load Enumeration descendants due to STI
DocumentCategory
end
end
end