Module: ApplicationHelper

Constant Summary collapse

{
  'CustomValue' => lambda {|custom_value| link_to_record(custom_value.customized)},
  'Document'    => lambda {|document| link_to(document.title, document_path(document))},
  'Group'       => lambda {|group|    link_to(group.name, group_path(group))},
  'Issue'       => lambda {|issue|    link_to_issue(issue, :subject => false)},
  'Message'     => lambda {|message|  link_to_message(message)},
  'News'        => lambda {|news|     link_to(news.title, news_path(news))},
  'Project'     => lambda {|project|  link_to_project(project)},
  'User'        => lambda {|user|     link_to_user(user)},
  'Version'     => lambda {|version|  link_to_version(version)},
  'WikiPage'    =>
    lambda do |wiki_page|
      link_to(
        wiki_page.pretty_title,
        project_wiki_page_path(wiki_page.project, wiki_page.title)
      )
    end
}
{
  # Custom list, since project/version attachments are listed in the files
  # view and not in the project/milestone view
  'Project' =>
     lambda {|project| link_to(l(:project_module_files), project_files_path(project))},
  'Version' =>
     lambda {|version| link_to(l(:project_module_files), project_files_path(version.project))},
}
%r{
        <a( [^>]+?)?>(?<tag_content>.*?)</a>|
        (?<leading>[\s\(,\-\[\>]|^)
        (?<esc>!)?
        (?<project_prefix>(?<project_identifier>[a-z0-9\-_]+):)?
        (?<prefix>attachment|document|version|forum|news|message|project|commit|source|export|user)?
        (
          (
            (?<sep1>\#\#?)|
            (
              (?<repo_prefix>(?<repo_identifier>[a-z0-9\-_]+)\|)?
              (?<sep2>r)
            )
          )
          (
            (?<identifier1>((\d)+|(note)))
            (?<comment_suffix>
              (\#note)?
              -(?<comment_id>\d+)
            )?
          )|
          (
          (?<sep3>:)
          (?<identifier2>[^"\s<>][^\s<>]*?|"[^"]+?")
          )|
          (
          (?<sep4>@)
          (?<identifier3>[A-Za-z0-9_\-@\.]*?)
          )
        )
        (?=
          (?=[[:punct:]][^A-Za-z0-9_/])|
          ,|
          \s|
          \]|
          <|
          $)
}x
HEADING_RE =
/(<h(\d)( [^>]+)?>(.+?)<\/h(\d)>)/i
MACROS_RE =
/(
 (!)?                        # escaping
 (
 \{\{                        # opening tag
 ([\w]+)                     # macro name
 (\(([^\n\r]*?)\))?          # optional arguments
 ([\n\r].*?[\n\r])?          # optional block of text
 \}\}                        # closing tag
 )
)/mx
MACRO_SUB_RE =
/(
\{\{
macro\((\d+)\)
\}\}
)/x
TOC_RE =
/<p>\{\{((<|&lt;)|(>|&gt;))?toc\}\}<\/p>/i

Constants included from IconsHelper

IconsHelper::DEFAULT_ICON_SIZE, IconsHelper::DEFAULT_SPRITE

Instance Method Summary collapse

Methods included from IconsHelper

#activity_event_type_icon, #file_icon, #notice_icon, #principal_icon, #scm_change_icon, #sprite_icon

Methods included from Redmine::Helpers::URL

#uri_with_link_safe_scheme?, #uri_with_safe_scheme?

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Themes::Helper

#current_theme, #heads_for_theme

Methods included from Redmine::SudoMode::Helper

#hash_to_hidden_fields

Methods included from Redmine::Pagination::Helper

#pagination_links_each, #pagination_links_full, #per_page_links, #per_page_options

Methods included from Redmine::I18n

#abbr_day_name, #current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, included, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #normalize_float, #set_language_if_valid, #valid_languages

Methods included from Redmine::WikiFormatting::Macros::Definitions

#exec_macro, #extract_macro_options, #macro_exists?

Instance Method Details

#accesskey(s) ⇒ Object



888
889
890
891
892
893
894
895
# File 'app/helpers/application_helper.rb', line 888

def accesskey(s)
  @used_accesskeys ||= []
  key = Redmine::AccessKeys.key_for(s)
  return nil if @used_accesskeys.include?(key)

  @used_accesskeys << key
  key
end

#actions_dropdownObject



856
857
858
859
860
861
862
863
864
865
866
867
# File 'app/helpers/application_helper.rb', line 856

def actions_dropdown(&)
  content = capture(&)
  if content.present?
    trigger =
      ('span', sprite_icon('3-bullets', l(:button_actions)), :class => 'icon-only icon-actions',
                  :title => l(:button_actions))
    trigger = ('span', trigger, :class => 'drdn-trigger')
    content = ('div', content, :class => 'drdn-items')
    content = ('div', content, :class => 'drdn-content')
    ('span', trigger + content, :class => 'drdn')
  end
end

#anchor(text) ⇒ Object



734
735
736
# File 'app/helpers/application_helper.rb', line 734

def anchor(text)
  text.to_s.tr(' ', '_')
end

#api_meta(options) ⇒ Object

Returns options or nil if nometa param or X-Redmine-Nometa header was set in the request



1851
1852
1853
1854
1855
1856
1857
1858
1859
# File 'app/helpers/application_helper.rb', line 1851

def api_meta(options)
  if params[:nometa].present? || request.headers['X-Redmine-Nometa']
    # compatibility mode for activeresource clients that raise
    # an error when deserializing an array with attributes
    nil
  else
    options
  end
end

#authoring(created, author, options = {}) ⇒ Object



745
746
747
# File 'app/helpers/application_helper.rb', line 745

def authoring(created, author, options={})
  l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe
end

#authorize_for(controller, action) ⇒ Object

Return true if user is authorized for controller/action, otherwise false



37
38
39
# File 'app/helpers/application_helper.rb', line 37

def authorize_for(controller, action)
  User.current.allowed_to?({:controller => controller, :action => action}, @project)
end

#back_url_hidden_field_tagObject



1613
1614
1615
1616
# File 'app/helpers/application_helper.rb', line 1613

def back_url_hidden_field_tag
  url = validate_back_url(back_url)
  hidden_field_tag('back_url', url, :id => nil) unless url.blank?
end

#body_css_classesObject

Returns the theme, controller name, and action as css classes for the HTML body.



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
# File 'app/helpers/application_helper.rb', line 871

def body_css_classes
  css = []
  if theme = Redmine::Themes.theme(Setting.ui_theme)
    css << 'theme-' + theme.name.tr(' ', '_')
  end

  css << 'project-' + @project.identifier if @project && @project.identifier.present?
  css << 'has-main-menu' if display_main_menu?(@project)
  css << 'controller-' + controller_name
  css << 'action-' + action_name
  css << 'avatars-' + (Setting.gravatar_enabled? ? 'on' : 'off')
  if UserPreference::TEXTAREA_FONT_OPTIONS.include?(User.current.pref.textarea_font)
    css << "textarea-#{User.current.pref.textarea_font}"
  end
  css.join(' ')
end


786
787
788
789
# File 'app/helpers/application_helper.rb', line 786

def breadcrumb(*args)
  elements = args.flatten
  elements.any? ? ('p', (args.join(" \xc2\xbb ") + " \xc2\xbb ").html_safe, :class => 'breadcrumb') : nil
end

#bulk_edit_error_messages(items) ⇒ Object

Returns an array of error messages for bulk edited items (issues, time entries)



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
# File 'app/helpers/application_helper.rb', line 1893

def bulk_edit_error_messages(items)
  messages = {}
  items.each do |item|
    item.errors.full_messages.each do |message|
      messages[message] ||= []
      messages[message] << item
    end
  end
  messages.map do |message, items|
    "#{message}: " + items.map {|i| "##{i.id}"}.join(', ')
  end
end

#calendar_for(field_id) ⇒ Object



1694
1695
1696
1697
1698
1699
# File 'app/helpers/application_helper.rb', line 1694

def calendar_for(field_id)
  include_calendar_headers_tags
  javascript_tag(
    "$(function() { $('##{field_id}').addClass('date').datepickerFallback(datepickerOptions); });"
  )
end

#cancel_button_tag(fallback_url) ⇒ Object



1618
1619
1620
1621
# File 'app/helpers/application_helper.rb', line 1618

def cancel_button_tag(fallback_url)
  url = validate_back_url(back_url) || fallback_url
  link_to l(:button_cancel), url
end

#catch_macros(text) ⇒ Object

Extracts macros from text



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
# File 'app/helpers/application_helper.rb', line 1460

def catch_macros(text)
  macros = {}
  text.gsub!(MACROS_RE) do
    all, macro = $1, $4.downcase
    if macro_exists?(macro) || all =~ MACRO_SUB_RE
      index = macros.size
      macros[index] = all
      "{{macro(#{index})}}"
    else
      all
    end
  end
  macros
end


1623
1624
1625
1626
1627
# File 'app/helpers/application_helper.rb', line 1623

def check_all_links(form_name)
  link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
  " | ".html_safe +
  link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)")
end

#checked_image(checked = true) ⇒ Object



1672
1673
1674
1675
1676
# File 'app/helpers/application_helper.rb', line 1672

def checked_image(checked=true)
  if checked
    @checked_image_tag ||= (:span, sprite_icon("checked"), :class => 'icon-only icon-checked')
  end
end

#context_menuObject



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
# File 'app/helpers/application_helper.rb', line 1678

def context_menu
  unless @context_menu_included
    content_for :header_tags do
      javascript_include_tag('context_menu') +
        stylesheet_link_tag('context_menu')
    end
    if l(:direction) == 'rtl'
      content_for :header_tags do
        stylesheet_link_tag('context_menu_rtl')
      end
    end
    @context_menu_included = true
  end
  nil
end


1943
1944
1945
1946
1947
1948
1949
# File 'app/helpers/application_helper.rb', line 1943

def copy_object_url_link(url)
  link_to_function(
    sprite_icon('copy-link', l(:button_copy_link)), 'copyDataClipboardTextToClipboard(this);',
    class: 'icon icon-copy-link',
    data: {'clipboard-text' => url}
  )
end

#default_search_project_scopeObject

Returns the default scope for the quick search form Could be ‘all’, ‘my_projects’, ‘subprojects’ or nil (current project)



552
553
554
555
556
# File 'app/helpers/application_helper.rb', line 552

def default_search_project_scope
  if @project && !@project.leaf?
    'subprojects'
  end
end


1590
1591
1592
1593
1594
1595
1596
1597
1598
# File 'app/helpers/application_helper.rb', line 1590

def delete_link(url, options={}, button_name=l(:button_delete))
  options = {
    :method => :delete,
    :data => {:confirm => l(:text_are_you_sure)},
    :class => 'icon icon-del'
  }.merge(options)

  link_to sprite_icon('del', button_name), url, options
end

#due_date_distance_in_words(date) ⇒ Object



442
443
444
445
446
447
448
449
450
451
# File 'app/helpers/application_helper.rb', line 442

def due_date_distance_in_words(date)
  if date
    l((if date < User.current.today
         :label_roadmap_overdue
       else
         :label_roadmap_due_in
       end),
      distance_of_date_in_words(User.current.today, date))
  end
end

#email_delivery_enabled?Boolean

Returns:

  • (Boolean)


1790
1791
1792
# File 'app/helpers/application_helper.rb', line 1790

def email_delivery_enabled?
  !!ActionMailer::Base.perform_deliveries
end

#error_messages_for(*objects) ⇒ Object

Render the error messages for the given objects



1569
1570
1571
1572
1573
# File 'app/helpers/application_helper.rb', line 1569

def error_messages_for(*objects)
  objects = objects.filter_map {|o| o.is_a?(String) ? instance_variable_get(:"@#{o}") : o}
  errors = objects.map {|o| o.errors.full_messages}.flatten
  render_error_messages(errors)
end

#export_csv_encoding_select_tagObject



1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
# File 'app/helpers/application_helper.rb', line 1861

def export_csv_encoding_select_tag
  return if l(:general_csv_encoding).casecmp('UTF-8') == 0

  options = ['UTF-8', l(:general_csv_encoding)]
  (:p) do
    concat(
      (:label) do
        concat "#{l(:label_encoding)} "
        concat select_tag('encoding', options_for_select(options, 'UTF-8'))
      end
    )
  end
end

#export_csv_separator_select_tagObject



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
# File 'app/helpers/application_helper.rb', line 1875

def export_csv_separator_select_tag
  options = [[l(:label_comma_char), ','], [l(:label_semi_colon_char), ';']]
  # Add the separator from translations if it is missing
  general_csv_separator = l(:general_csv_separator)
  unless options.index { |option| option.last == general_csv_separator }
    options << Array.new(2, general_csv_separator)
  end
  (:p) do
    concat(
      (:label) do
        concat l(:label_fields_separator) + ' '
        concat select_tag('field_separator', options_for_select(options, general_csv_separator))
      end
    )
  end
end

#faviconObject



1820
1821
1822
# File 'app/helpers/application_helper.rb', line 1820

def favicon
  favicon_link_tag(favicon_path, rel: "shortcut icon")
end

#favicon_pathObject

Returns the path to the favicon



1825
1826
1827
1828
# File 'app/helpers/application_helper.rb', line 1825

def favicon_path
  icon = (current_theme && current_theme.favicon?) ? current_theme.favicon_path : 'favicon.ico'
  image_path(icon)
end

#favicon_urlObject

Returns the full URL to the favicon



1831
1832
1833
# File 'app/helpers/application_helper.rb', line 1831

def favicon_url
  image_url(favicon_path)
end

#form_tag_html(html_options) ⇒ Object



1561
1562
1563
1564
1565
1566
# File 'app/helpers/application_helper.rb', line 1561

def form_tag_html(html_options)
  # Set a randomized name attribute on all form fields by default
  # as a workaround to https://bugzilla.mozilla.org/show_bug.cgi?id=1279253
  html_options['name'] ||= "#{html_options['id'] || 'form'}-#{SecureRandom.hex(4)}"
  super
end

#format_activity_day(date) ⇒ Object



412
413
414
# File 'app/helpers/application_helper.rb', line 412

def format_activity_day(date)
  date == User.current.today ? l(:label_today).titleize : format_date(date)
end

#format_activity_description(text) ⇒ Object



416
417
418
419
420
421
422
423
424
425
426
427
# File 'app/helpers/application_helper.rb', line 416

def format_activity_description(text)
  h(
    # Limit input to avoid regex performance issues
    text.to_s.slice(0, 10240)
    # Abbreviate consecutive quoted lines as '> ...', keeping the first line
    .gsub(%r{(^>.*?(?:\r?\n))(?:>.*?(?:\r?\n)+)+}m, "\\1> ...\n")
    # Remove all content following the first <pre> or <code> tag
    .sub(%r{[\r\n]*<(pre|code)>.*$}m, '')
    # Truncate the description to a specified length and append '...'
    .truncate(240)
  ).gsub(/[\r\n]+/, "<br>").html_safe
end

#format_activity_title(text) ⇒ Object

Used to format item titles on the activity view



408
409
410
# File 'app/helpers/application_helper.rb', line 408

def format_activity_title(text)
  text
end

#format_changeset_comments(changeset, options = {}) ⇒ Object



437
438
439
440
# File 'app/helpers/application_helper.rb', line 437

def format_changeset_comments(changeset, options={})
  method = options[:short] ? :short_comments : :comments
  textilizable changeset, method, project: changeset.project, formatting: Setting.commit_logs_formatting?
end

#format_object(object, *args, &block) ⇒ Object

Helper that formats object for html or text rendering Options:

  • :html - If true, format the object as HTML (default: true)

  • :thousands_delimiter - If true, format the numeric object with thousands delimiter (default: false)



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'app/helpers/application_helper.rb', line 263

def format_object(object, *args, &block)
  options =
    if args.first.is_a?(Hash)
      args.first
    elsif !args.empty?
      # Support the old syntax `format_object(object, html_flag)`
      # TODO: Display a deprecation warning in a future version, then remove this
      {:html => args.first}
    else
      {}
    end

  html = options.fetch(:html, true)
  thousands_delimiter = options.fetch(:thousands_delimiter, false)
  delimiter_char = thousands_delimiter ? ::I18n.t('number.format.delimiter') : nil

  if block
    object = yield object
  end
  case object
  when Array
    formatted_objects = object.map do |o|
      format_object(o, html: html, thousands_delimiter: thousands_delimiter)
    end
    html ? safe_join(formatted_objects, ', ') : formatted_objects.join(', ')
  when Time, ActiveSupport::TimeWithZone
    format_time(object)
  when Date
    format_date(object)
  when Integer
    number_with_delimiter(object, delimiter: delimiter_char)
  when Float
    number_with_delimiter(sprintf('%.2f', object), delimiter: delimiter_char)
  when User, Group
    html ? link_to_principal(object) : object.to_s
  when Project
    html ? link_to_project(object) : object.to_s
  when Version
    html ? link_to_version(object) : object.to_s
  when TrueClass
    l(:general_text_Yes)
  when FalseClass
    l(:general_text_No)
  when Issue
    object.visible? && html ? link_to_issue(object) : "##{object.id}"
  when Attachment
    if html
      (
        :span,
        link_to_attachment(object) +
        link_to_attachment(
          object,
          :class => ['icon-only', 'icon-download'],
          :title => l(:button_download),
          :download => true
        )
      )
    else
      object.filename
    end
  when CustomValue, CustomFieldValue
    return "" unless object.customized&.visible?

    if object.custom_field
      f = object.custom_field.format.formatted_custom_value(self, object, html)
      if f.nil? || f.is_a?(String)
        f
      else
        format_object(f, html: html, thousands_delimiter: object.custom_field.thousands_delimiter?, &block)
      end
    else
      object.value.to_s
    end
  else
    html ? h(object) : object.to_s
  end
end

#format_version_name(version) ⇒ Object



429
430
431
432
433
434
435
# File 'app/helpers/application_helper.rb', line 429

def format_version_name(version)
  if version.project == @project
    h(version)
  else
    h("#{version.project} - #{version}")
  end
end

#get_tab_action(tab) ⇒ Object

Returns the tab action depending on the tab properties



540
541
542
543
544
545
546
547
548
# File 'app/helpers/application_helper.rb', line 540

def get_tab_action(tab)
  if tab[:onclick]
    return tab[:onclick]
  elsif tab[:partial]
    return "showTab('#{tab[:name]}', this.href)"
  else
    return nil
  end
end

#heads_for_auto_complete(project) ⇒ Object



1928
1929
1930
1931
1932
1933
1934
1935
# File 'app/helpers/application_helper.rb', line 1928

def heads_for_auto_complete(project)
  data_sources = autocomplete_data_sources(project)
  javascript_tag(
    "rm = window.rm || {};" \
    "rm.AutoComplete = rm.AutoComplete || {};" \
    "rm.AutoComplete.dataSources = JSON.parse('#{data_sources.to_json}');"
  )
end

#heads_for_i18nObject



1920
1921
1922
1923
1924
1925
1926
# File 'app/helpers/application_helper.rb', line 1920

def heads_for_i18n
  javascript_tag(
    "rm = window.rm || {};" \
    "rm.I18n = rm.I18n || {};" \
    "rm.I18n = Object.freeze({buttonCopy: '#{l(:button_copy)}'});"
  )
end

#html_hours(text) ⇒ Object



738
739
740
741
742
743
# File 'app/helpers/application_helper.rb', line 738

def html_hours(text)
  text.gsub(
    %r{(\d+)([\.,:])(\d+)},
    '<span class="hours hours-int">\1</span><span class="hours hours-dec">\2\3</span>'
  ).html_safe
end

#html_title(*args) ⇒ Object

Sets the html title Returns the html title when called without arguments Current project name and app_title are automatically appended Exemples:

html_title 'Foo', 'Bar'
html_title # => 'Foo - Bar - My Project - Redmine'


844
845
846
847
848
849
850
851
852
853
854
# File 'app/helpers/application_helper.rb', line 844

def html_title(*args)
  if args.empty?
    title = @html_title || []
    title << @project.name if @project
    title << Setting.app_title unless Setting.app_title == title.last
    title.reject(&:blank?).join(' - ')
  else
    @html_title ||= []
    @html_title += args
  end
end

#image_tag(source, options = {}) ⇒ Object

Overrides Rails’ image_tag with themes and plugins support. Examples:

image_tag('image.png') # => picks image.png from the current theme or defaults
image_tag('image.png', :plugin => 'foo) # => picks image.png from plugin's assets


1754
1755
1756
1757
1758
1759
1760
1761
# File 'app/helpers/application_helper.rb', line 1754

def image_tag(source, options={})
  if plugin = options.delete(:plugin)
    source = "plugin_assets/#{plugin}/#{source}"
  elsif current_theme && current_theme.images.include?(source)
    source = current_theme.image_path(source)
  end
  super
end

#include_calendar_headers_tagsObject



1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
# File 'app/helpers/application_helper.rb', line 1701

def include_calendar_headers_tags
  unless @calendar_headers_tags_included
    tags = ''.html_safe
    @calendar_headers_tags_included = true
    content_for :header_tags do
      start_of_week = Setting.start_of_week
      start_of_week = l(:general_first_day_of_week, :default => '1') if start_of_week.blank?
      # Redmine uses 1..7 (monday..sunday) in settings and locales
      # JQuery uses 0..6 (sunday..saturday), 7 needs to be changed to 0
      start_of_week = start_of_week.to_i % 7
      tags <<
        javascript_tag(
          "var datepickerOptions={dateFormat: 'yy-mm-dd', firstDay: #{start_of_week}, " \
            "showOn: 'button', buttonImageOnly: true, buttonImage: '" +
          asset_path('calendar.png') +
            "', showButtonPanel: true, showWeek: true, showOtherMonths: true, " \
            "selectOtherMonths: true, changeMonth: true, changeYear: true, " \
            "beforeShow: beforeShowDatePicker};"
        )
      jquery_locale = l('jquery.locale', :default => current_language.to_s)
      unless jquery_locale == 'en'
        tags << javascript_include_tag("i18n/datepicker-#{jquery_locale}.js")
      end
      tags
    end
  end
end

#include_in_api_response?(arg) ⇒ Boolean

Returns true if arg is expected in the API response

Returns:

  • (Boolean)


1840
1841
1842
1843
1844
1845
1846
1847
# File 'app/helpers/application_helper.rb', line 1840

def include_in_api_response?(arg)
  unless @included_in_api_response
    param = params[:include]
    @included_in_api_response = param.is_a?(Array) ? param.collect(&:to_s) : param.to_s.split(',')
    @included_in_api_response.collect!(&:strip)
  end
  @included_in_api_response.include?(arg.to_s)
end

#inject_macros(text, obj, macros, execute = true, options = {}) ⇒ Object

Executes and replaces macros in text



1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
# File 'app/helpers/application_helper.rb', line 1476

def inject_macros(text, obj, macros, execute=true, options={})
  text.gsub!(MACRO_SUB_RE) do
    all, index = $1, $2.to_i
    orig = macros.delete(index)
    if execute && orig && orig =~ MACROS_RE
      esc, all, macro, args, block = $2, $3, $4.downcase, $6.to_s, $7.try(:strip)
      if esc.nil?
        h(exec_macro(macro, obj, args, block, options) || all)
      else
        h(all)
      end
    elsif orig
      h(orig)
    else
      h(all)
    end
  end
end

#javascript_headsObject

Returns the javascript tags that are included in the html layout head



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
# File 'app/helpers/application_helper.rb', line 1799

def javascript_heads
  tags = javascript_include_tag(
    'jquery-3.7.1-ui-1.13.3',
    'rails-ujs',
    'tribute-5.1.3.min'
  )
  if Setting.wiki_tablesort_enabled?
    tags << javascript_include_tag('tablesort-5.2.1.min.js', 'tablesort-5.2.1.number.min.js')
  end
  tags << javascript_include_tag('application-legacy', 'responsive')
  unless User.current.pref.warn_on_leaving_unsaved == '0'
    warn_text = escape_javascript(l(:text_warn_on_leaving_unsaved))
    tags <<
      "\n".html_safe +
        javascript_tag(
          "$(window).on('load', function(){ warnLeavingUnsaved('#{warn_text}'); });"
        )
  end
  tags
end

#javascript_include_tag(*sources) ⇒ Object

Overrides Rails’ javascript_include_tag with plugins support Examples:

javascript_include_tag('scripts') # => picks scripts.js from defaults
javascript_include_tag('scripts', :plugin => 'foo) # => picks scripts.js from plugin's assets


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
# File 'app/helpers/application_helper.rb', line 1768

def javascript_include_tag(*sources)
  options = sources.last.is_a?(Hash) ? sources.pop : {}
  if plugin = options.delete(:plugin)
    sources = sources.map do |source|
      if plugin
        "plugin_assets/#{plugin}/#{source}"
      else
        source
      end
    end
  end
  super(*sources, options)
end

#labelled_fields_for(*args) ⇒ Object



1554
1555
1556
1557
1558
1559
# File 'app/helpers/application_helper.rb', line 1554

def labelled_fields_for(*args, &)
  args << {} unless args.last.is_a?(Hash)
  options = args.last
  options[:builder] = Redmine::Views::LabelledFormBuilder
  fields_for(*args, &)
end

#labelled_form_for(*args) ⇒ Object



1544
1545
1546
1547
1548
1549
1550
1551
1552
# File 'app/helpers/application_helper.rb', line 1544

def labelled_form_for(*args, &)
  args << {} unless args.last.is_a?(Hash)
  options = args.last
  if args.first.is_a?(Symbol)
    options[:as] = args.shift
  end
  options[:builder] = Redmine::Views::LabelledFormBuilder
  form_for(*args, &)
end

#lang_options_for_select(blank = true) ⇒ Object



1540
1541
1542
# File 'app/helpers/application_helper.rb', line 1540

def lang_options_for_select(blank=true)
  (blank ? [["(#{l('label_option_auto_lang')})", ""]] : []) + languages_options
end

Generates a link to an attachment. Options:

  • :text - Link text (default to attachment filename)

  • :download - Force download (default: false)



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'app/helpers/application_helper.rb', line 129

def link_to_attachment(attachment, options={})
  text = options.delete(:text) || attachment.filename
  icon = options.fetch(:icon, false)

  if options.delete(:download)
    route_method = :download_named_attachment_url
    options[:filename] = attachment.filename
  else
    route_method = :attachment_url
    # make sure we don't have an extraneous :filename in the options
    options.delete(:filename)
  end
  html_options = options.slice!(:only_path, :filename)

  options[:only_path] = true unless options.key?(:only_path)
  url = send(route_method, attachment, options)

  label = icon ? sprite_icon(icon, text) : text
  link_to label, url, html_options
end


252
253
254
255
256
257
# File 'app/helpers/application_helper.rb', line 252

def link_to_attachment_container(attachment_container)
  if link = ATTACHMENT_CONTAINER_LINK[attachment_container.class.name] ||
            RECORD_LINK[attachment_container.class.name]
    self.instance_exec(attachment_container, &link)
  end
end


1604
1605
1606
# File 'app/helpers/application_helper.rb', line 1604

def link_to_context_menu
  link_to sprite_icon('3-bullets', l(:button_actions)), '#', title: l(:button_actions), class: 'icon-only icon-actions js-contextmenu '
end


1600
1601
1602
# File 'app/helpers/application_helper.rb', line 1600

def link_to_function(name, function, html_options={})
  (:a, name, {:href => '#', :onclick => "#{function}; return false;"}.merge(html_options))
end

Displays a link to edit group page if current user is admin Otherwise display only the group name



84
85
86
87
88
89
90
91
92
93
94
# File 'app/helpers/application_helper.rb', line 84

def link_to_group(group, options={})
  if group.is_a?(Group)
    name = h(group.name)
    if User.current.admin?
      only_path = options[:only_path].nil? ? true : options[:only_path]
      link_to name, edit_group_path(group, :only_path => only_path)
    else
      name
    end
  end
end

Display a link if user is authorized

Parameters:

  • name (String)

    Anchor text (passed to link_to)

  • options (Hash) (defaults to: {})

    Hash params. This will checked by authorize_for to see if the user is authorized

  • html_options (optional, Hash) (defaults to: nil)

    Options passed to link_to

  • parameters_for_method_reference (optional, Hash)

    Extra parameters for link_to



47
48
49
50
51
# File 'app/helpers/application_helper.rb', line 47

def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
  if authorize_for(options[:controller] || params[:controller], options[:action])
    link_to(name, options, html_options, *parameters_for_method_reference)
  end
end

Displays a link to issue with its subject. Examples:

link_to_issue(issue)                        # => Defect #6: This is the subject
link_to_issue(issue, :truncate => 6)        # => Defect #6: This i...
link_to_issue(issue, :subject => false)     # => Defect #6
link_to_issue(issue, :project => true)      # => Foo - Defect #6
link_to_issue(issue, :subject => false, :tracker => false)     # => #6


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'app/helpers/application_helper.rb', line 105

def link_to_issue(issue, options={})
  title = nil
  subject = nil
  text = options[:tracker] == false ? "##{issue.id}" : "#{issue.tracker} ##{issue.id}"
  if options[:subject] == false
    title = issue.subject.truncate(60)
  else
    subject = issue.subject
    if truncate_length = options[:truncate]
      subject = subject.truncate(truncate_length)
    end
  end
  only_path = options[:only_path].nil? ? true : options[:only_path]
  s = link_to(text, issue_url(issue, :only_path => only_path),
              :class => issue.css_classes, :title => title)
  s << h(": #{subject}") if subject
  s = h("#{issue.project} - ") + s if options[:project]
  s
end

Generates a link to a message



170
171
172
173
174
175
176
177
178
179
180
# File 'app/helpers/application_helper.rb', line 170

def link_to_message(message, options={}, html_options = nil)
  link_to(
    message.subject.truncate(60),
    board_message_url(message.board_id, message.parent_id || message.id, {
      :r => (message.parent_id && message.id),
      :anchor => (message.parent_id ? "message-#{message.id}" : nil),
      :only_path => true
    }.merge(options)),
    html_options
  )
end


403
404
405
# File 'app/helpers/application_helper.rb', line 403

def link_to_month(link_name, year, month, options={})
  link_to(link_name, {:params => request.query_parameters.merge(:year => year, :month => month)}, options)
end


387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
# File 'app/helpers/application_helper.rb', line 387

def link_to_next_month(year, month, options={})
  target_year, target_month = if month == 12
                                [year + 1, 1]
                              else
                                [year, month + 1]
                              end

  name = if target_month == 1
           "#{month_name(target_month)} #{target_year}"
         else
           month_name(target_month)
         end

  link_to_month((name + " »"), target_year, target_month, options)
end


371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'app/helpers/application_helper.rb', line 371

def link_to_previous_month(year, month, options={})
  target_year, target_month = if month == 1
                                [year - 1, 12]
                              else
                                [year, month - 1]
                              end

  name = if target_month == 12
           "#{month_name(target_month)} #{target_year}"
         else
           month_name(target_month)
         end

  link_to_month(("« " + name), target_year, target_month, options)
end

Displays a link to user’s account page or group page



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'app/helpers/application_helper.rb', line 59

def link_to_principal(principal, options={})
  only_path = options[:only_path].nil? ? true : options[:only_path]
  case principal
  when User
    name = principal.name(options[:format])
    name = "@#{name}" if options[:mention]
    css_classes = ''
    if principal.active? || (User.current.admin? && principal.logged?)
      url = user_url(principal, :only_path => only_path)
      css_classes += principal.css_classes
    end
  when Group
    name = principal.to_s
    url = group_url(principal, :only_path => only_path)
    css_classes = principal.css_classes
  else
    name = principal.to_s
  end

  css_classes += " #{options[:class]}" if css_classes && options[:class].present?
  url ? link_to(principal_icon(principal).to_s + name, url, :class => css_classes) : h(name)
end

Generates a link to a project if active Examples:

link_to_project(project)                          # => link to the specified project overview
link_to_project(project, {:only_path => false}, :class => "project") # => 3rd arg adds html options
link_to_project(project, {}, :class => "project") # => html options with default url (project overview)


189
190
191
192
193
194
195
196
197
# File 'app/helpers/application_helper.rb', line 189

def link_to_project(project, options={}, html_options = nil)
  if project.archived?
    h(project.name)
  else
    link_to project.name,
            project_url(project, {:only_path => true}.merge(options)),
            html_options
  end
end

Generates a link to a project settings if active



200
201
202
203
204
205
206
207
208
# File 'app/helpers/application_helper.rb', line 200

def link_to_project_settings(project, options={}, html_options=nil)
  if project.active?
    link_to project.name, settings_project_path(project, options), html_options
  elsif project.archived?
    h(project.name)
  else
    link_to project.name, project_path(project, options), html_options
  end
end


237
238
239
240
241
# File 'app/helpers/application_helper.rb', line 237

def link_to_record(record)
  if link = RECORD_LINK[record.class.name]
    self.instance_exec(record, &link)
  end
end

Generates a link to a SCM revision Options:

  • :text - Link text (default to the formatted revision)



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'app/helpers/application_helper.rb', line 153

def link_to_revision(revision, repository, options={})
  if repository.is_a?(Project)
    repository = repository.repository
  end
  text = options.delete(:text) || format_revision(revision)
  rev = revision.respond_to?(:identifier) ? revision.identifier : revision
  link_to(
    h(text),
    {:controller => 'repositories', :action => 'revision',
     :id => repository.project,
     :repository_id => repository.identifier_param, :rev => rev},
    :title => l(:label_revision_id, format_revision(revision)),
    :accesskey => options[:accesskey]
  )
end

Displays a link to user’s account page if active



54
55
56
# File 'app/helpers/application_helper.rb', line 54

def link_to_user(user, options={})
  user.is_a?(User) ? link_to_principal(user, options) : h(user.to_s)
end

Generates a link to a version



211
212
213
214
215
216
# File 'app/helpers/application_helper.rb', line 211

def link_to_version(version, options = {})
  return '' unless version && version.is_a?(Version)

  options = {:title => format_date(version.effective_date)}.merge(options)
  link_to_if version.visible?, format_version_name(version), version_path(version), options
end

#option_tag(name, text, value, selected = nil, options = {}) ⇒ Object



716
717
718
# File 'app/helpers/application_helper.rb', line 716

def option_tag(name, text, value, selected=nil, options={})
   'option', value, options.merge(:value => value, :selected => (value == selected))
end


791
792
793
794
795
# File 'app/helpers/application_helper.rb', line 791

def other_formats_links(&)
  concat('<p class="other-formats">'.html_safe + l(:label_export_to))
  yield Redmine::Views::OtherFormatsBuilder.new(self)
  concat('</p>'.html_safe)
end

#page_header_titleObject



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'app/helpers/application_helper.rb', line 797

def page_header_title
  if @project.nil? || @project.new_record?
    h(Setting.app_title)
  else
    b = []
    ancestors = (@project.root? ? [] : @project.ancestors.visible.to_a)
    if ancestors.any?
      root = ancestors.shift
      b << link_to_project(root, {:jump => current_menu_item}, :class => 'root')
      if ancestors.size > 2
        b << "\xe2\x80\xa6"
        ancestors = ancestors[-2, 2]
      end
      b +=
        ancestors.collect do |p|
          link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor')
        end
    end
    b << (:span, h(@project), class: 'current-project')
    if b.size > 1
      separator = (:span, ' &raquo; '.html_safe, class: 'separator')
      path = safe_join(b[0..-2], separator) + separator
      b = [(:span, path.html_safe, class: 'breadcrumbs'), b[-1]]
    end
    safe_join b
  end
end

#parse_headings(text, project, obj, attr, only_path, options) ⇒ Object

Headings and TOC Adds ids and links to headings unless options is set to false



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'app/helpers/application_helper.rb', line 1416

def parse_headings(text, project, obj, attr, only_path, options)
  return if options[:headings] == false

  text.gsub!(HEADING_RE) do
    level, attrs, content = $2.to_i, $3, $4
    item = strip_tags(content).strip
    anchor = sanitize_anchor_name(item)
    # used for single-file wiki export
    if options[:wiki_links] == :anchor && (obj.is_a?(WikiContent) ||
         obj.is_a?(WikiContentVersion))
      anchor = "#{obj.page.title}_#{anchor}"
    end
    @heading_anchors[anchor] ||= 0
    idx = (@heading_anchors[anchor] += 1)
    if idx > 1
      anchor = "#{anchor}-#{idx}"
    end
    @parsed_headings << [level, anchor, item]
    "<a name=\"#{anchor}\"></a>\n<h#{level} #{attrs}>#{content}" \
      "<a href=\"##{anchor}\" class=\"wiki-anchor\">&para;</a></h#{level}>"
  end
end

#parse_hires_images(text, project, obj, attr, only_path, options) ⇒ Object

add srcset attribute to img tags if filename includes @2x, @3x, etc. to support hires displays



982
983
984
985
986
987
# File 'app/helpers/application_helper.rb', line 982

def parse_hires_images(text, project, obj, attr, only_path, options)
  text.gsub!(/src="([^"]+@(\dx)\.(bmp|gif|jpg|jpe|jpeg|png))"/i) do |m|
    filename, dpr = $1, $2
    m + " srcset=\"#{filename} #{dpr}\""
  end
end

#parse_inline_attachments(text, project, obj, attr, only_path, options) ⇒ Object



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
# File 'app/helpers/application_helper.rb', line 989

def parse_inline_attachments(text, project, obj, attr, only_path, options)
  return if options[:inline_attachments] == false

  # when using an image link, try to use an attachment, if possible
  attachments = options[:attachments] || []
  if obj.is_a?(Journal)
    attachments += obj.journalized.attachments if obj.journalized.respond_to?(:attachments)
  else
    attachments += obj.attachments if obj.respond_to?(:attachments)
  end
  if attachments.present?
    title_and_alt_re = /\s+(title|alt)="([^"]*)"/i

    text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png|webp))"([^>]*)/i) do |m|
      filename, ext, other_attrs = $1, $2, $3

      # search for the picture in attachments
      if found = Attachment.latest_attach(attachments, CGI.unescape(filename))
        image_url = download_named_attachment_url(found, found.filename, :only_path => only_path)
        desc = found.description.to_s.delete('"')

        # remove title and alt attributes after extracting them
        title_and_alt = other_attrs.scan(title_and_alt_re).to_h
        other_attrs.gsub!(title_and_alt_re, '')

        title_and_alt_attrs = if !desc.blank? && title_and_alt['alt'].blank?
                                " title=\"#{desc}\" alt=\"#{desc}\""
                              else
                                # restore original title and alt attributes
                                " #{title_and_alt.map { |k, v| %[#{k}="#{v}"] }.join(' ')}"
                              end
        "src=\"#{image_url}\"#{title_and_alt_attrs} loading=\"lazy\"#{other_attrs}"
      else
        m
      end
    end
  end
end

#parse_non_pre_blocks(text, obj, macros, options = {}) ⇒ Object



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
# File 'app/helpers/application_helper.rb', line 948

def parse_non_pre_blocks(text, obj, macros, options={})
  s = StringScanner.new(text)
  tags = []
  parsed = +''
  until s.eos?
    s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im)
    text, full_tag, closing, tag = s[1], s[2], s[3], s[4]
    if tags.empty?
      yield text
      inject_macros(text, obj, macros, true, options) if macros.any?
    else
      inject_macros(text, obj, macros, false, options) if macros.any?
    end
    parsed << text
    if tag
      if closing
        if tags.last && tags.last.casecmp(tag) == 0
          tags.pop
        end
      else
        tags << tag.downcase
      end
      parsed << full_tag
    end
  end
  # Close any non closing tags
  while tag = tags.pop
    parsed << "</#{tag}>"
  end
  parsed
end

Redmine links

Examples:

Issues:
  #52 -> Link to issue #52
  ##52 -> Link to issue #52, including the issue's subject
Changesets:
  r52 -> Link to revision 52
  commit:a85130f -> Link to scmid starting with a85130f
Documents:
  document#17 -> Link to document with id 17
  document:Greetings -> Link to the document with title "Greetings"
  document:"Some document" -> Link to the document with title "Some document"
Versions:
  version#3 -> Link to version with id 3
  version:1.0.0 -> Link to version named "1.0.0"
  version:"1.0 beta 2" -> Link to version named "1.0 beta 2"
Attachments:
  attachment:file.zip -> Link to the attachment of the current object named file.zip
Source files:
  source:some/file -> Link to the file located at /some/file in the project's repository
  source:some/file@52 -> Link to the file's revision 52
  source:some/file#L120 -> Link to line 120 of the file
  source:some/file@52#L120 -> Link to line 120 of the file's revision 52
  export:some/file -> Force the download of the file
Forums:
  forum#1 -> Link to forum with id 1
  forum:Support -> Link to forum named "Support"
  forum:"Technical Support" -> Link to forum named "Technical Support"
Forum messages:
  message#1218 -> Link to message with id 1218
Projects:
  project:someproject -> Link to project named "someproject"
  project#3 -> Link to project with id 3
News:
  news#2 -> Link to news item with id 1
  news:Greetings -> Link to news item named "Greetings"
  news:"First Release" -> Link to news item named "First Release"
Users:
  user:jsmith -> Link to user with login jsmith
  @jsmith -> Link to user with login jsmith
  user#2 -> Link to user with id 2

Links can refer other objects from other projects, using project identifier:
  identifier:r52
  identifier:document:"Some document"
  identifier:version:1.0.0
  identifier:source:some/file


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'app/helpers/application_helper.rb', line 1152

def parse_redmine_links(text, default_project, obj, attr, only_path, options)
  text.gsub!(LINKS_RE) do |_|
    tag_content = $~[:tag_content]
    leading = $~[:leading]
    esc = $~[:esc]
    project_prefix = $~[:project_prefix]
    project_identifier = $~[:project_identifier]
    prefix = $~[:prefix]
    repo_prefix = $~[:repo_prefix]
    repo_identifier = $~[:repo_identifier]
    sep = $~[:sep1] || $~[:sep2] || $~[:sep3] || $~[:sep4]
    identifier = $~[:identifier1] || $~[:identifier2] || $~[:identifier3]
    comment_suffix = $~[:comment_suffix]
    comment_id = $~[:comment_id]

    if tag_content
      $&
    else
      link = nil
      project = default_project
      if project_identifier
        project = Project.visible.find_by_identifier(project_identifier)
      end
      if esc.nil?
        if prefix.nil? && sep == 'r'
          if project
            repository = nil
            if repo_identifier
              repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
            else
              repository = project.repository
            end
            # project.changesets.visible raises an SQL error because of a double join on repositories
            if repository &&
                 (changeset = Changeset.visible.
                                  find_by_repository_id_and_revision(repository.id, identifier))
              link = link_to(h("#{project_prefix}#{repo_prefix}r#{identifier}"),
                             {:only_path => only_path, :controller => 'repositories',
                              :action => 'revision', :id => project,
                              :repository_id => repository.identifier_param,
                              :rev => changeset.revision},
                             :class => 'changeset',
                             :title => truncate_single_line_raw(changeset.comments, 100))
            end
          end
        elsif sep == '#' || sep == '##'
          oid = identifier.to_i
          case prefix
          when nil
            if oid.to_s == identifier &&
              issue = Issue.visible.find_by_id(oid)
              anchor = comment_id ? "note-#{comment_id}" : nil
              url = issue_url(issue, :only_path => only_path, :anchor => anchor)
              link =
                if sep == '##'
                  link_to("#{issue.tracker.name} ##{oid}#{comment_suffix}: #{issue.subject}",
                          url,
                          :class => issue.css_classes,
                          :title => "#{l(:field_status)}: #{issue.status.name}")
                else
                  link_to("##{oid}#{comment_suffix}",
                          url,
                          :class => issue.css_classes,
                          :title => "#{issue.tracker.name}: #{issue.subject.truncate(100)} (#{issue.status.name})")
                end
            elsif identifier == 'note'
              link = link_to("#note-#{comment_id}", "#note-#{comment_id}")
            end
          when 'document'
            if document = Document.visible.find_by_id(oid)
              link = link_to(document.title,
                             document_url(document, :only_path => only_path),
                             :class => 'document')
            end
          when 'version'
            if version = Version.visible.find_by_id(oid)
              link = link_to(version.name, version_url(version, :only_path => only_path), :class => 'version')
            end
          when 'message'
            if message = Message.visible.find_by_id(oid)
              link = link_to_message(message, {:only_path => only_path}, :class => 'message')
            end
          when 'forum'
            if board = Board.visible.find_by_id(oid)
              link = link_to(board.name,
                             project_board_url(board.project, board, :only_path => only_path),
                             :class => 'board')
            end
          when 'news'
            if news = News.visible.find_by_id(oid)
              link = link_to(news.title, news_url(news, :only_path => only_path), :class => 'news')
            end
          when 'project'
            if p = Project.visible.find_by_id(oid)
              link = link_to_project(p, {:only_path => only_path}, :class => 'project')
            end
          when 'user'
            u = User.visible.find_by(:id => oid, :type => 'User')
            link = link_to_user(u, :only_path => only_path) if u
          end
        elsif sep == ':'
          name = remove_double_quotes(identifier)
          case prefix
          when 'document'
            if project && document = project.documents.visible.find_by_title(name)
              link = link_to(document.title,
                             document_url(document, :only_path => only_path),
                             :class => 'document')
            end
          when 'version'
            if project && version = project.versions.visible.find_by_name(name)
              link = link_to(version.name, version_url(version, :only_path => only_path), :class => 'version')
            end
          when 'forum'
            if project && board = project.boards.visible.find_by_name(name)
              link = link_to(board.name,
                             project_board_url(board.project, board, :only_path => only_path),
                             :class => 'board')
            end
          when 'news'
            if project && news = project.news.visible.find_by_title(name)
              link = link_to(news.title, news_url(news, :only_path => only_path), :class => 'news')
            end
          when 'commit', 'source', 'export'
            if project
              repository = nil
              if name =~ %r{^(([a-z0-9\-_]+)\|)(.+)$}
                repo_prefix, repo_identifier, name = $1, $2, $3
                repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
              else
                repository = project.repository
              end
              if prefix == 'commit'
                if repository &&
                     (changeset =
                        Changeset.visible.
                          where(
                            "repository_id = ? AND scmid LIKE ?",
                            repository.id, "#{name}%"
                          ).first)
                  link =
                    link_to(
                      h("#{project_prefix}#{repo_prefix}#{name}"),
                      {:only_path => only_path, :controller => 'repositories',
                       :action => 'revision', :id => project,
                       :repository_id => repository.identifier_param,
                      :rev => changeset.identifier},
                      :class => 'changeset',
                      :title => truncate_single_line_raw(changeset.comments, 100)
                    )
                end
              else
                if repository && User.current.allowed_to?(:browse_repository, project)
                  name =~ %r{^[/\\]*(.*?)(@([^/\\@]+?))?(#(L\d+))?$}
                  path, rev, anchor = $1, $3, $5
                  link =
                    link_to(
                      h("#{project_prefix}#{prefix}:#{repo_prefix}#{name}"),
                      {:only_path => only_path, :controller => 'repositories',
                       :action => (prefix == 'export' ? 'raw' : 'entry'),
                       :id => project, :repository_id => repository.identifier_param,
                       :path => to_path_param(path),
                       :rev => rev,
                       :anchor => anchor},
                      :class => (prefix == 'export' ? 'source download' : 'source'))
                end
              end
              repo_prefix = nil
            end
          when 'attachment'
            attachments = options[:attachments] || []
            if obj.is_a?(Journal)
              attachments += obj.journalized.attachments if obj.journalized.respond_to?(:attachments)
            else
              attachments += obj.attachments if obj.respond_to?(:attachments)
            end
            if attachments && attachment = Attachment.latest_attach(attachments, name)
              link = link_to_attachment(attachment, :only_path => only_path, :class => 'attachment')
            end
          when 'project'
            if p = Project.visible.where("identifier = :s OR LOWER(name) = :s", :s => name.downcase).first
              link = link_to_project(p, {:only_path => only_path}, :class => 'project')
            end
          when 'user'
            u = User.visible.find_by("LOWER(login) = :s AND type = 'User'", :s => name.downcase)
            link = link_to_user(u, :only_path => only_path) if u
          end
        elsif sep == "@"
          name = remove_double_quotes(identifier)
          u = User.visible.find_by("LOWER(login) = :s AND type = 'User'", :s => name.downcase)
          link = link_to_user(u, :only_path => only_path, :class => 'user-mention', :mention => true) if u
        end
      end
      (leading + (link || "#{project_prefix}#{prefix}#{repo_prefix}#{sep}#{identifier}#{comment_suffix}"))
    end
  end
end

#parse_sections(text, project, obj, attr, only_path, options) ⇒ Object



1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'app/helpers/application_helper.rb', line 1391

def parse_sections(text, project, obj, attr, only_path, options)
  return unless options[:edit_section_links]

  text.gsub!(HEADING_RE) do
    heading, level = $1, $2
    @current_section += 1
    if @current_section > 1
      (
        'div',
        link_to(
          sprite_icon('edit', l(:button_edit_section)),
          options[:edit_section_links].merge(
            :section => @current_section),
          :class => 'icon-only icon-edit'),
        :class => "contextual heading-#{level}",
        :title => l(:button_edit_section),
        :id => "section-#{@current_section}") + heading.html_safe
    else
      heading
    end
  end
end

Wiki links

Examples:

[[mypage]]
[[mypage|mytext]]

wiki links can refer other project wikis, using project name or identifier:

[[project:]] -> wiki starting page
[[project:|mytext]]
[[project:mypage]]
[[project:mypage|mytext]]


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'app/helpers/application_helper.rb', line 1038

def parse_wiki_links(text, project, obj, attr, only_path, options)
  text.gsub!(/(!)?(\[\[([^\n\|]+?)(\|([^\n\|]+?))?\]\])/) do |m|
    link_project = project
    esc, all, page, title = $1, $2, $3, $5
    if esc.nil?
      page = CGI.unescapeHTML(page)
      if page =~ /^\#(.+)$/
        anchor = sanitize_anchor_name($1)
        url = "##{anchor}"
        next link_to(title.present? ? title.html_safe : h(page), url, :class => 'wiki-page')
      end

      if page =~ /^([^\:]+)\:(.*)$/
        identifier, page = $1, $2
        link_project = Project.find_by_identifier(identifier) || Project.find_by_name(identifier)
        title ||= identifier if page.blank?
      end

      if link_project && link_project.wiki && User.current.allowed_to?(:view_wiki_pages, link_project)
        # extract anchor
        anchor = nil
        if page =~ /^(.+?)\#(.+)$/
          page, anchor = $1, $2
        end
        anchor = sanitize_anchor_name(anchor) if anchor.present?
        # check if page exists
        wiki_page = link_project.wiki.find_page(page)
        url =
          if anchor.present? && wiki_page.present? &&
               (obj.is_a?(WikiContent) || obj.is_a?(WikiContentVersion)) &&
               obj.page == wiki_page
            "##{anchor}"
          else
            case options[:wiki_links]
            when :local
              "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')
            when :anchor
              # used for single-file wiki export
              "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '')
            else
              wiki_page_id = page.present? ? Wiki.titleize(page) : nil
              parent =
                if wiki_page.nil? && obj.is_a?(WikiContent) &&
                     obj.page && project == link_project
                  obj.page.title
                else
                  nil
                end
              url_for(:only_path => only_path, :controller => 'wiki',
                      :action => 'show', :project_id => link_project,
                      :id => wiki_page_id, :version => nil, :anchor => anchor,
                      :parent => parent)
            end
          end
        link_to(title.present? ? title.html_safe : h(page),
                url, :class => ('wiki-page' + (wiki_page ? '' : ' new')))
      else
        # project or wiki doesn't exist
        all
      end
    else
      all
    end
  end
end

#principals_check_box_tags(name, principals) ⇒ Object



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
# File 'app/helpers/application_helper.rb', line 659

def principals_check_box_tags(name, principals)
  s = +''
  principals.each do |principal|
    s <<
      (
        'label',
        check_box_tag(name, principal.id, false, :id => nil) +
          ((avatar(principal, :size => 16).presence if principal.is_a?(User)) ||
             (
               'span', principal_icon(principal),
               :class => "name icon icon-#{principal.class.name.downcase}"
             )
          ) + principal.to_s
      )
  end
  s.html_safe
end

#principals_options_for_select(collection, selected = nil) ⇒ Object

Returns a string for users/groups option tags



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
# File 'app/helpers/application_helper.rb', line 678

def principals_options_for_select(collection, selected=nil)
  s = +''
  if collection.include?(User.current)
    s << ('option', "<< #{l(:label_me)} >>", :value => User.current.id)
  end

  involved_principals_html = +''
  # This optgroup is displayed only when editing a single issue
  if @issue.present? && !@issue.new_record?
    involved_principals = [@issue.author, @issue.prior_assigned_to].uniq.compact
    involved_principals_html = involved_principals.map do |p|
      ('option', p.name, value: p.id, disabled: !collection.include?(p))
    end.join
  end

  users_html = +''
  groups_html = +''
  collection.sort.each do |element|
    if option_value_selected?(element, selected) || element.id.to_s == selected
      selected_attribute = ' selected="selected"'
    end
    (element.is_a?(Group) ? groups_html : users_html) <<
      %(<option value="#{element.id}"#{selected_attribute}>#{h element.name}</option>)
  end
  if involved_principals_html.blank? && groups_html.blank?
    s << users_html
  else
    [
      [l(:label_involved_principals), involved_principals_html],
      [l(:label_user_plural), users_html],
      [l(:label_group_plural), groups_html]
    ].each do |label, options_html|
      s << %(<optgroup label="#{h(label)}">#{options_html}</optgroup>) if options_html.present?
    end
  end
  s.html_safe
end

#progress_bar(pcts, options = {}) ⇒ Object



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
# File 'app/helpers/application_helper.rb', line 1638

def progress_bar(pcts, options={})
  pcts = [pcts, pcts] unless pcts.is_a?(Array)
  pcts = pcts.collect(&:floor)
  pcts[1] = pcts[1] - pcts[0]
  pcts << (100 - pcts[1] - pcts[0])
  titles = options[:titles].to_a
  titles[0] = "#{pcts[0]}%" if titles[0].blank?
  legend = options[:legend] || ''
  (
    'table',
    (
      'tr',
      (if pcts[0] > 0
         ('td', '', :style => "width: #{pcts[0]}%;",
                     :class => 'closed', :title => titles[0])
       else
         ''.html_safe
       end) +
      (if pcts[1] > 0
         ('td', '', :style => "width: #{pcts[1]}%;",
                    :class => 'done', :title => titles[1])
       else
         ''.html_safe
       end) +
      (if pcts[2] > 0
         ('td', '', :style => "width: #{pcts[2]}%;",
                                 :class => 'todo', :title => titles[2])
       else
         ''.html_safe
       end)
    ), :class => "progress progress-#{pcts[0]}").html_safe +
    ('p', legend, :class => 'percent').html_safe
end

#project_tree(projects, options = {}) ⇒ Object

Yields the given block for each project with its level in the tree

Wrapper for Project#project_tree



655
656
657
# File 'app/helpers/application_helper.rb', line 655

def project_tree(projects, options={}, &)
  Project.project_tree(projects, options, &)
end

#project_tree_options_for_select(projects, options = {}) ⇒ Object



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
# File 'app/helpers/application_helper.rb', line 629

def project_tree_options_for_select(projects, options = {})
  s = ''.html_safe
  if blank_text = options[:include_blank]
    if blank_text == true
      blank_text = '&nbsp;'.html_safe
    end
    s << ('option', blank_text, :value => '')
  end
  project_tree(projects) do |project, level|
    name_prefix = (level > 0 ? '&nbsp;' * 2 * level + '&#187; ' : '').html_safe
    tag_options = {:value => project.id}
    if project == options[:selected] || (options[:selected].respond_to?(:include?) &&
         options[:selected].include?(project))
      tag_options[:selected] = 'selected'
    else
      tag_options[:selected] = nil
    end
    tag_options.merge!(yield(project)) if block_given?
    s << ('option', name_prefix + h(project), tag_options)
  end
  s.html_safe
end

#projects_for_jump_box(user = User.current) ⇒ Object

Returns an array of projects that are displayed in the quick-jump box



559
560
561
562
563
564
565
# File 'app/helpers/application_helper.rb', line 559

def projects_for_jump_box(user=User.current)
  if user.logged?
    user.projects.active.select(:id, :name, :identifier, :lft, :rgt).to_a
  else
    []
  end
end

#raw_json(arg) ⇒ Object

Helper to render JSON in views



1609
1610
1611
# File 'app/helpers/application_helper.rb', line 1609

def raw_json(arg)
  arg.to_json.gsub('/', '\/').html_safe
end

#render_error_messages(errors) ⇒ Object

Renders a list of error messages



1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
# File 'app/helpers/application_helper.rb', line 1576

def render_error_messages(errors)
  html = +""
  if errors.present?
    html << "<div id='errorExplanation'>\n"
    html << notice_icon('error')
    html << "<ul>\n"
    errors.each do |error|
      html << "<li>#{h error}</li>\n"
    end
    html << "</ul></div>\n"
  end
  html.html_safe
end

#render_flash_messagesObject

Renders flash messages



518
519
520
521
522
523
524
# File 'app/helpers/application_helper.rb', line 518

def render_flash_messages
  s = +''
  flash.each do |k, v|
    s << ('div', notice_icon(k) + v.html_safe, :class => "flash #{k}", :id => "flash_#{k}")
  end
  s.html_safe
end

#render_if_exist(options = {}, locals = {}) ⇒ Object



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
# File 'app/helpers/application_helper.rb', line 1906

def render_if_exist(options = {}, locals = {}, &)
  # Remove test_render_if_exist_should_be_render_partial and test_render_if_exist_should_be_render_nil
  # along with this method in Redmine 7.0
  Rails.application.deprecators[:redmine].warn 'ApplicationHelper#render_if_exist is deprecated and will be removed in Redmine 7.0.'

  if options[:partial]
    if lookup_context.exists?(options[:partial], lookup_context.prefixes, true)
      render(options, locals, &)
    end
  else
    render(options, locals, &)
  end
end

#render_page_hierarchy(pages, node = nil, options = {}) ⇒ Object



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
# File 'app/helpers/application_helper.rb', line 487

def render_page_hierarchy(pages, node=nil, options={})
  content = +''
  if pages[node]
    content << "<ul class=\"pages-hierarchy\">\n"
    pages[node].each do |page|
      content << "<li>"
      if controller.controller_name == 'wiki' && controller.action_name == 'export'
        href = "##{page.title}"
      else
        href = {:controller => 'wiki', :action => 'show',
                :project_id => page.project, :id => page.title, :version => nil}
      end
      content <<
        link_to(
          h(page.pretty_title),
          href,
          :title => (if options[:timestamp] && page.updated_on
                       l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on))
                     else
                       nil
                     end)
        )
      content << "\n" + render_page_hierarchy(pages, page.id, options) if pages[page.id]
      content << "</li>\n"
    end
    content << "</ul>\n"
  end
  content.html_safe
end

#render_project_jump_boxObject

Renders the project quick-jump box



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
# File 'app/helpers/application_helper.rb', line 605

def render_project_jump_box
  projects = projects_for_jump_box(User.current)
  if @project && @project.persisted?
    text = @project.name_was
  end
  text ||= l(:label_jump_to_a_project)
  url = autocomplete_projects_path(:format => 'js', :jump => current_menu_item)
  trigger = ('span', text, :class => 'drdn-trigger')
  q = text_field_tag('q', '', :id => 'projects-quick-search',
                     :class => 'autocomplete',
                     :data => {:automcomplete_url => url},
                     :autocomplete => 'off')
  all = link_to(l(:label_project_all), projects_path(:jump => current_menu_item),
                :class => (@project.nil? && controller.class.main_menu ? 'selected' : nil))
  content =
    ('div',
                ('div', sprite_icon('search', icon_only: true, size: 18) + q, :class => 'quick-search') +
                  ('div', render_projects_for_jump_box(projects, selected: @project),
                              :class => 'drdn-items projects selection') +
                  ('div', all, :class => 'drdn-items all-projects selection'),
                :class => 'drdn-content')
  ('div', trigger + content, :id => "project-jump", :class => "drdn")
end

#render_project_nested_lists(projects, &block) ⇒ Object

Renders a tree of projects as a nested set of unordered lists The given collection may be a subset of the whole project tree (eg. some intermediate nodes are private and can not be seen)



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'app/helpers/application_helper.rb', line 456

def render_project_nested_lists(projects, &block)
  s = +''
  if projects.any?
    ancestors = []
    original_project = @project
    projects.sort_by(&:lft).each do |project|
      # set the project environment to please macros.
      @project = project
      if ancestors.empty? || project.is_descendant_of?(ancestors.last)
        s << "<ul class='projects #{ancestors.empty? ? 'root' : nil}'>\n"
      else
        ancestors.pop
        s << "</li>"
        while ancestors.any? && !project.is_descendant_of?(ancestors.last)
          ancestors.pop
          s << "</ul></li>\n"
        end
      end
      classes = (ancestors.empty? ? 'root' : 'child')
      classes += ' archived' if project.archived?
      s << "<li class='#{classes}'><div class='#{classes}'>"
      s << h(block ? capture(project, &block) : project.name)
      s << "</div>\n"
      ancestors << project
    end
    s << ("</li></ul>\n" * ancestors.size)
    @project = original_project
  end
  s.html_safe
end

#render_projects_for_jump_box(projects, selected: nil, query: nil) ⇒ Object



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
# File 'app/helpers/application_helper.rb', line 567

def render_projects_for_jump_box(projects, selected: nil, query: nil)
  if query.blank?
    jump_box = Redmine::ProjectJumpBox.new User.current
    bookmarked = jump_box.bookmarked_projects
    recents = jump_box.recently_used_projects
    projects_label = :label_project_all
  else
    projects_label = :label_result_plural
  end
  jump = params[:jump].presence || current_menu_item
  s = (+'').html_safe
  build_project_link = lambda do |project, level = 0|
    padding = level * 16
    text = ('span', project.name, :style => "padding-left:#{padding}px;")
    s << link_to(text, project_path(project, :jump => jump),
                 :title => project.name,
                 :class => (project == selected ? 'selected' : nil))
  end
  [
    [bookmarked, :label_optgroup_bookmarks, true],
    [recents,   :label_optgroup_recents,    false],
    [projects,  projects_label,             true]
  ].each do |projects, label, is_tree|
    next if projects.blank?

    s << (:strong, l(label))
    if is_tree
      project_tree(projects, &build_project_link)
    else
      # we do not want to render recently used projects as a tree, but in the
      # order they were used (most recent first)
      projects.each(&build_project_link)
    end
  end
  s
end

#render_tabs(tabs, selected = ) ⇒ Object

Renders tabs and their content



527
528
529
530
531
532
533
534
535
536
537
# File 'app/helpers/application_helper.rb', line 527

def render_tabs(tabs, selected=params[:tab])
  if tabs.any?
    unless tabs.detect {|tab| tab[:name] == selected}
      selected = nil
    end
    selected ||= tabs.first[:name]
    render :partial => 'common/tabs', :locals => {:tabs => tabs, :selected_tab => selected}
  else
     'p', l(:label_no_data), :class => "nodata"
  end
end

#reorder_handle(object, options = {}) ⇒ Object



775
776
777
778
779
780
781
782
783
784
# File 'app/helpers/application_helper.rb', line 775

def reorder_handle(object, options={})
  data = {
    :reorder_url => options[:url] || url_for(object),
    :reorder_param => options[:param] || object.class.name.underscore
  }
  ('span', sprite_icon('reorder', ''),
              :class => "icon-only icon-sort-handle sort-handle",
              :data => data,
              :title => l(:button_sort))
end

#replace_toc(text, headings) ⇒ Object

Renders the TOC with given headings



1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'app/helpers/application_helper.rb', line 1498

def replace_toc(text, headings)
  text.gsub!(TOC_RE) do
    left_align, right_align = $2, $3
    # Keep only the 4 first levels
    headings = headings.select{|level, anchor, item| level <= 4}
    if headings.empty?
      ''
    else
      div_class = +'toc'
      div_class << ' right' if right_align
      div_class << ' left' if left_align
      out = "<ul class=\"#{div_class}\"><li><strong>#{l :label_table_of_contents}</strong></li><li>"
      root = headings.map(&:first).min
      current = root
      started = false
      headings.each do |level, anchor, item|
        if level > current
          out << '<ul><li>' * (level - current)
        elsif level < current
          out << "</li></ul>\n" * (current - level) + "</li><li>"
        elsif started
          out << '</li><li>'
        end
        out << "<a href=\"##{anchor}\">#{item}</a>"
        current = level
        started = true
      end
      out << '</li></ul>' * (current - root)
      out << '</li></ul>'
    end
  end
end

#robot_exclusion_tagObject



1835
1836
1837
# File 'app/helpers/application_helper.rb', line 1835

def robot_exclusion_tag
  '<meta name="robots" content="noindex,follow,noarchive" />'.html_safe
end

#sanitize_anchor_name(anchor) ⇒ Object



1794
1795
1796
# File 'app/helpers/application_helper.rb', line 1794

def sanitize_anchor_name(anchor)
  anchor.gsub(%r{[^\s\-\p{Word}]}, '').gsub(%r{\s+(\-+\s*)?}, '-')
end

Returns:

  • (Boolean)


1782
1783
1784
# File 'app/helpers/application_helper.rb', line 1782

def sidebar_content?
  content_for?(:sidebar) || view_layouts_base_sidebar_hook_response.present?
end

#simple_format_without_paragraph(text) ⇒ Object

Same as Rails’ simple_format helper without using paragraphs



1532
1533
1534
1535
1536
1537
1538
# File 'app/helpers/application_helper.rb', line 1532

def simple_format_without_paragraph(text)
  text.to_s.
    gsub(/\r\n?/, "\n").                    # \r\n and \r -> \n
    gsub(/\n\n+/, "<br /><br />").          # 2+ newline  -> 2 br
    gsub(/([^\n]\n)(?=[^\n])/, '\1<br />'). # 1 newline   -> br
    html_safe
end

Overrides Rails’ stylesheet_link_tag with themes and plugins support. Examples:

stylesheet_link_tag('styles') # => picks styles.css from the current theme or defaults
stylesheet_link_tag('styles', :plugin => 'foo) # => picks styles.css from plugin's assets


1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
# File 'app/helpers/application_helper.rb', line 1734

def stylesheet_link_tag(*sources)
  options = sources.last.is_a?(Hash) ? sources.pop : {}
  plugin = options.delete(:plugin)
  sources = sources.map do |source|
    if plugin
      "plugin_assets/#{plugin}/#{source}"
    elsif current_theme && current_theme.stylesheets.include?(source)
      current_theme.stylesheet_path(source)
    else
      source
    end
  end
  super(*sources, options)
end

#syntax_highlight(name, content) ⇒ Object



766
767
768
# File 'app/helpers/application_helper.rb', line 766

def syntax_highlight(name, content)
  Redmine::SyntaxHighlighting.highlight_by_filename(content, name)
end

#syntax_highlight_lines(name, content) ⇒ Object



762
763
764
# File 'app/helpers/application_helper.rb', line 762

def syntax_highlight_lines(name, content)
  syntax_highlight(name, content).each_line.to_a
end

#textilizable(*args) ⇒ Object

Formats text according to system settings. 2 ways to call this method:

  • with a String: textilizable(text, options)

  • with an object and one of its attribute: textilizable(issue, :description, options)



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
# File 'app/helpers/application_helper.rb', line 901

def textilizable(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  case args.size
  when 1
    obj = options[:object]
    text = args.shift
  when 2
    obj = args.shift
    attr = args.shift
    text = obj.send(attr).to_s
  else
    raise ArgumentError, 'invalid arguments to textilizable'
  end
  return '' if text.blank?

  project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
  @only_path = only_path = options.delete(:only_path) == false ? false : true

  text = text.dup
  macros = catch_macros(text)

  if options[:formatting] == false
    text = h(text)
  else
    formatting = Setting.text_formatting
    text = Redmine::WikiFormatting.to_html(formatting, text, :object => obj, :attribute => attr)
  end

  @parsed_headings = []
  @heading_anchors = {}
  @current_section = 0 if options[:edit_section_links]

  parse_sections(text, project, obj, attr, only_path, options)
  text = parse_non_pre_blocks(text, obj, macros, options) do |txt|
    [:parse_inline_attachments, :parse_hires_images, :parse_wiki_links, :parse_redmine_links].each do |method_name|
      send method_name, txt, project, obj, attr, only_path, options
    end
  end
  parse_headings(text, project, obj, attr, only_path, options)

  if @parsed_headings.any?
    replace_toc(text, @parsed_headings)
  end

  text.html_safe
end

#thumbnail_tag(attachment) ⇒ Object



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'app/helpers/application_helper.rb', line 346

def thumbnail_tag(attachment)
  thumbnail_size = Setting.thumbnails_size.to_i
  thumbnail_path = thumbnail_path(attachment, :size => thumbnail_size * 2)
  tag.div class: 'thumbnail', title: attachment.filename do
    link_to(
      image_tag(
        thumbnail_path,
        :srcset => "#{thumbnail_path} 2x",
        :style => "max-width: #{thumbnail_size}px; max-height: #{thumbnail_size}px;",
        :alt => attachment.filename,
        :loading => "lazy"
      ),
      attachment_path(attachment)
    )
  end
end

#time_tag(time) ⇒ Object



749
750
751
752
753
754
755
756
757
758
759
760
# File 'app/helpers/application_helper.rb', line 749

def time_tag(time)
  return if time.nil?

  text = distance_of_time_in_words(Time.now, time)
  if @project
    link_to(text,
            project_activity_path(@project, :from => User.current.time_to_date(time)),
            :title => format_time(time))
  else
    ('abbr', text, :title => format_time(time))
  end
end

#title(*args) ⇒ Object

Returns a h2 tag and sets the html title with the given arguments



826
827
828
829
830
831
832
833
834
835
836
# File 'app/helpers/application_helper.rb', line 826

def title(*args)
  strings = args.map do |arg|
    if arg.is_a?(Array) && arg.size >= 2
      link_to(*arg)
    else
      h(arg.to_s)
    end
  end
  html_title args.reverse.map {|s| (s.is_a?(Array) ? s.first : s).to_s}
  ('h2', strings.join(' &#187; ').html_safe)
end

#to_path_param(path) ⇒ Object



770
771
772
773
# File 'app/helpers/application_helper.rb', line 770

def to_path_param(path)
  str = path.to_s.split(%r{[/\\]}).select{|p| !p.blank?}.join("/")
  str.blank? ? nil : str
end


1629
1630
1631
1632
1633
1634
1635
1636
# File 'app/helpers/application_helper.rb', line 1629

def toggle_checkboxes_link(selector, options={})
  css_classes = 'icon icon-checked'
  css_classes += ' ' + options[:class] if options[:class]
  link_to_function sprite_icon('checked', ''),
                   "toggleCheckboxesBySelector('#{selector}')",
                   :title => "#{l(:button_check_all)} / #{l(:button_uncheck_all)}",
                   :class => css_classes
end


363
364
365
366
367
368
369
# File 'app/helpers/application_helper.rb', line 363

def toggle_link(name, id, options={})
  onclick = "$('##{id}').toggle(); "
  onclick << (options[:focus] ? "$('##{options[:focus]}:visible').focus(); " : "this.blur(); ")
  onclick << "$(window).scrollTop($('##{options[:focus]}').position().top); " if options[:scroll]
  onclick << "return false;"
  link_to(name, "#", :onclick => onclick)
end

#truncate_lines(string, options = {}) ⇒ Object

Truncates at line break after 250 characters or options



725
726
727
728
729
730
731
732
# File 'app/helpers/application_helper.rb', line 725

def truncate_lines(string, options={})
  length = options[:length] || 250
  if string.to_s =~ /\A(.{#{length}}.*?)$/m
    "#{$1}..."
  else
    string
  end
end

#truncate_single_line_raw(string, length) ⇒ Object



720
721
722
# File 'app/helpers/application_helper.rb', line 720

def truncate_single_line_raw(string, length)
  string.to_s.truncate(length).gsub(%r{[\r\n]+}m, ' ')
end

#update_data_sources_for_auto_complete(data_sources) ⇒ Object



1937
1938
1939
1940
1941
# File 'app/helpers/application_helper.rb', line 1937

def update_data_sources_for_auto_complete(data_sources)
  javascript_tag(
    "rm.AutoComplete.dataSources = Object.assign(rm.AutoComplete.dataSources, JSON.parse('#{data_sources.to_json}'));"
  )
end

#view_layouts_base_sidebar_hook_responseObject



1786
1787
1788
# File 'app/helpers/application_helper.rb', line 1786

def view_layouts_base_sidebar_hook_response
  @view_layouts_base_sidebar_hook_response ||= call_hook(:view_layouts_base_sidebar)
end

#wiki_page_path(page, options = {}) ⇒ Object



341
342
343
344
# File 'app/helpers/application_helper.rb', line 341

def wiki_page_path(page, options={})
  url_for({:controller => 'wiki', :action => 'show', :project_id => page.project,
           :id => page.title}.merge(options))
end