Merge branch 'release/17.5' into dev

Author: openprojectci

app/assets/images/17_4_features.png

@@ -0,0 +1,43 @@
+# 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.
+#++
+
+# Pin the external rendering channel so mailer templates never have to
+# remember the `render_mode:` / `only_path:` / `static_html:` combination.
+# Matching the `.html.erb` / `.text.erb` extension to the helper name keeps
+# caller intent visible.
+module MailFormattingHelper
+  def format_mail_html(*, **)
+    format_text(*, render_mode: :external_html, **)
+  end
+
+  def format_mail_text(*, **)
+    format_text(*, render_mode: :external_text, **)
+  end
+end

app/assets/images/17_5_features.png

@@ -34,6 +34,7 @@ class ApplicationMailer < ActionMailer::Base
   helper :application, # for format_text
          :work_packages, # for css classes
          :custom_fields, # for show_value
+         :mail_formatting, # for format_mail_html / format_mail_text
          :mail_layout # for layouting
 
   include OpenProject::LocaleHelper

app/helpers/mail_formatting_helper.rb

@@ -121,6 +121,13 @@ def self.numeric_id?(value)
     end
   end
 
+  # Returns formatted value for inline UI display.
+  #   * Semantic mode: "PROJ-42" (no prefix — self-describing)
+  #   * Classic mode: "#42" (hash-prefixed)
+  def self.format_display_id(display_id)
+    display_id.is_a?(String) && display_id.match?(/[A-Za-z]/) ? display_id : "##{display_id}"
+  end
+
   # Returns the user-facing identifier for this work package.
   # In semantic mode: the project-based identifier (e.g. "PROJ-42")
   # In classic mode: the numeric database ID
@@ -134,8 +141,7 @@ def display_id
   # Semantic mode: "PROJ-42" (no prefix — self-describing)
   # Classic mode: "#42" (hash-prefixed)
   def formatted_id
-    did = display_id
-    did.is_a?(String) && did.match?(/[A-Za-z]/) ? did : "##{did}"
+    WorkPackage::SemanticIdentifier.format_display_id(display_id)
   end
 
   # Override ActiveRecord's default `to_param` so Rails URL helpers

app/mailers/application_mailer.rb

@@ -29,9 +29,20 @@
 # See COPYRIGHT and LICENSE files for more details.
 module EnvData
   class LdapSeeder < Seeder
+    KNOWN_CONNECTION_KEYS = %w[
+      host port security tls_verify tls_certificate sync_users
+      filter basedn binduser bindpassword
+      login_mapping firstname_mapping lastname_mapping mail_mapping admin_mapping
+      groupfilter
+    ].freeze
+
+    KNOWN_FILTER_KEYS = %w[base filter sync_users group_attribute].freeze
+
     def seed_data!
       print_status "    ↳ Creating LDAP connection" do
         Setting.seed_ldap.each do |name, options|
+          validate_options!(name, options)
+
           ldap = LdapAuthSource.find_or_initialize_by(name:)
 
           print_ldap_status(ldap)
@@ -51,6 +62,34 @@ def applicable?
 
     private
 
+    def validate_options!(name, options)
+      check_unknown_keys!(options, KNOWN_CONNECTION_KEYS,
+                          scope: "LDAP connection '#{name}'")
+
+      filters = options["groupfilter"]
+      return if filters.blank?
+
+      filters.each do |filter_name, filter_options|
+        check_unknown_keys!(filter_options, KNOWN_FILTER_KEYS,
+                            scope: "LDAP group filter '#{filter_name}' (connection '#{name}')")
+      end
+    end
+
+    def check_unknown_keys!(options, known_keys, scope:)
+      unknown = options.keys - known_keys
+      return if unknown.empty?
+
+      raise <<~MSG.strip
+        #{scope}: unknown configuration key(s): #{unknown.map { |k| env_form(k) }.join(', ')}.
+        Accepted keys: #{known_keys.map { |k| env_form(k) }.join(', ')}.
+        Note: in environment variable names, single underscores split path segments and double underscores encode a literal underscore (e.g. LOGIN__MAPPING, not LOGIN_MAPPING).
+      MSG
+    end
+
+    def env_form(key)
+      key.gsub("_", "__").upcase
+    end
+
     # rubocop:disable Metrics/AbcSize
     def upsert_settings(ldap, options)
       ldap.host = options["host"]

app/models/work_package/semantic_identifier.rb

@@ -123,7 +123,8 @@ def derive_attributes(work_package, loader, attributes)
 
   def set_journal_note(work_packages)
     work_packages.each do |wp|
-      wp.journal_notes = I18n.t("work_package.updated_automatically_by_child_changes", child: "##{initiator_work_package.id}")
+      wp.journal_notes = I18n.t("work_package.updated_automatically_by_child_changes",
+                                child: "##{initiator_work_package.id}")
     end
   end
 

app/seeders/env_data/ldap_seeder.rb

@@ -47,4 +47,4 @@ See COPYRIGHT and LICENSE files for more details.
   <% end %>
 </ul>
 
-<%= format_text(work_package, :description, only_path: false) %>
+<%= format_mail_html(work_package, :description) %>

app/services/work_packages/update_ancestors_service.rb

@@ -26,7 +26,7 @@
         <table <%= placeholder_table_styles(width: "100%", style: "width:100%;") %>>
           <tr>
             <td style="<%= placeholder_text_styles %>">
-              <%= format_text @journal.notes, only_path: false %>
+              <%= format_mail_html @journal.notes %>
             </td>
           </tr>
         </table>

app/views/work_package_mailer/_work_package_details.html.erb

@@ -8,6 +8,10 @@
 <%= "=" * ((@work_package.formatted_id + " " + @work_package.subject).length + 4) %>
 
 <%= I18n.t(:label_comment_added) %>:
-<%= strip_tags @journal.notes %>
+<%= format_mail_text(
+      @journal.notes,
+      object: @work_package,
+      project: @work_package.project
+    ) %>
 
 <%= "-" * 100 %>