Files
openproject/modules/wikis/lib/open_project/wikis/engine.rb
T
Marcello Rocha d03d22edc8 Implements the GET /work_packages/:id/wiki_page_links endpoint (#22834)
* Introduce the PageLinkQuery
* Update page link query and some copyright
* Adds PageLinkCollectionRepresenter
* Introduces the endpoint /work_packages/id/wiki_page_links
* MetadaService tests, most of it is a work of fiction
* Adds urns for page link type improve some tests
* Removes mentions to view_wiki_page_links permissions
* Adds a test for multiple providers and same identifiers

---

Co-authored-by: Jan Sandbrink <j.sandbrink@openproject.com>
2026-05-08 17:38:52 +02:00

114 lines
4.1 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.
#++
# Prevent load-order problems in case openproject-plugins is listed after a plugin in the Gemfile
# or not at all
require "open_project/plugins"
module OpenProject::Wikis
class Engine < ::Rails::Engine
engine_name :openproject_wikis
include OpenProject::Plugins::ActsAsOpEngine
initializer "openproject_wikis.inflections" do
ActiveSupport::Inflector.inflections(:en) do |inflect|
inflect.acronym "XWiki"
end
OpenProject::Inflector.rule do |basename, abspath|
case basename
when "xwiki"
"XWiki"
when /\Axwiki_(.*)\z/
"XWiki#{default_inflect($1, abspath)}"
end
end
end
config.to_prepare do
API::V3::Configuration::ConfigurationRepresenter.property(
:wikisAvailable,
getter: ->(*) { ::Wikis::Provider.enabled.exists? }
)
OpenProject::TextFormatting::Filters::PatternMatcherFilter.append_matcher ::Wikis::TextFormatting::WikiLinkMatcher
# Registering queries and filters
::Queries::Register.register(::Queries::Wikis::PageLinks::PageLinkQuery) do
filter ::Queries::Wikis::PageLinks::Filter::ProviderFilter
end
end
replace_principal_references "Wikis::PageLink" => %i[author_id]
register "openproject-wikis", author_url: "https://openproject.org" do
project_module :work_package_tracking do
permission :manage_wiki_page_links,
{},
permissible_on: :project,
dependencies: %i[edit_work_packages],
contract_actions: { wiki_page_links: %i[manage] }
end
menu :work_package_split_view,
:wikis,
{ tab: :wikis },
skip_permissions_check: true,
after: :relations,
badge: ->(work_package:, **) { Wikis::PageLinkService.new.count(work_package) },
if: ->(_project) {
Wikis::Provider.enabled.exists? &&
OpenProject::FeatureDecisions.wiki_enhancements_active?
}
menu :admin_menu,
:wiki_providers,
{ controller: "/wikis/admin/wiki_providers", action: :index },
if: ->(_) { OpenProject::FeatureDecisions.wiki_enhancements_active? },
caption: :project_module_wiki_platforms,
icon: "browser"
end
patch_with_namespace :WikiPages, :CreateService
patch_with_namespace :WikiPages, :UpdateService
patch_with_namespace :WorkPackages, :CreateService
patch_with_namespace :WorkPackages, :UpdateService
add_api_path(:wiki_page_link) { |page_link_id| "#{root}/wiki_page_links/#{page_link_id}" }
add_api_path(:wiki_provider) { |provider_id| "#{root}/wiki_providers/#{provider_id}" }
add_api_path(:work_package_page_links) { |work_package_id| "#{work_package(work_package_id)}/wiki_page_links" }
add_api_endpoint "API::V3::WorkPackages::WorkPackagesAPI", :id do
mount ::API::V3::PageLinks::WorkPackageWikiPageLinksAPI
end
end
end