Module: ApplicationHelper

Extended by:
Forwardable
Includes:
GravatarHelper::PublicMethods, Redmine::Helpers::URL, Redmine::Hook::Helper, Redmine::I18n, Redmine::Pagination::Helper, Redmine::SudoMode::Helper, Redmine::Themes::Helper, Redmine::WikiFormatting::Macros::Definitions
Included in:
IssuesHelper, QueriesHelper, Redmine::Hook::ViewListener, TimelogHelper
Defined in:
app/helpers/application_helper.rb

Overview

Since:

  • 0.4.0

Constant Summary collapse 

%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+)
          (?<comment_suffix>
            (\#note)?
            -(?<comment_id>\d+)
          )?
        )|
        (
        (?<sep3>:)
        (?<identifier2>[^"\s<>][^\s<>]*?|"[^"]+?")
        )|
        (
        (?<sep4>@)
        (?<identifier3>[a-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

Instance Method Summary collapse

Methods included from Redmine::Helpers::URL

#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

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

Methods included from GravatarHelper::PublicMethods

#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url

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

#exec_macro, #extract_macro_options, #macro_exists?

Instance Method Details

#accesskey(s) ⇒ Object

Since:

  • 0.6.0



620
621
622
623
624
625
626
 
# File 'app/helpers/application_helper.rb', line 620

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

#anchor(text) ⇒ Object

Since:

  • 1.4.0



473
474
475
 
# File 'app/helpers/application_helper.rb', line 473

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

#api_meta(options) ⇒ Object

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

Since:

  • 1.1.0



1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'app/helpers/application_helper.rb', line 1494

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

Since:

  • 0.6.0



481
482
483
 
# File 'app/helpers/application_helper.rb', line 481

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

#avatar(user, options = { }) ⇒ Object

Returns the avatar image tag for the given user if avatars are enabled user can be a User or a string that will be scanned for an email address (eg. 'joe <joe@foo.bar>')

Since:

  • 0.8.0



1415
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 1415

def avatar(user, options = { })
  if Setting.gravatar_enabled?
    options.merge!(:default => Setting.gravatar_default)
    email = nil
    if user.respond_to?(:mail)
      email = user.mail
    elsif user.to_s =~ %r{<(.+?)>}
      email = $1
    end
    if email.present?
      gravatar(email.to_s.downcase, options) rescue nil
    elsif user.is_a?(AnonymousUser)
      options[:size] &&= options[:size].to_s
      image_tag 'anonymous.png',
                GravatarHelper::DEFAULT_OPTIONS
                  .except(:default, :rating, :ssl).merge(options)
    else
      nil
    end
  else
    ''
  end
end

#avatar_edit_link(user, options = {}) ⇒ Object

Returns a link to edit user's avatar if avatars are enabled

Since:

  • 3.1.0



1440
1441
1442
1443
1444
1445
 
# File 'app/helpers/application_helper.rb', line 1440

def avatar_edit_link(user, options={})
  if Setting.gravatar_enabled?
    url = "https://gravatar.com"
    link_to avatar(user, {:title => l(:button_edit)}.merge(options)), url, :target => '_blank'
  end
end

#back_url ⇒ Object

Since:

  • 2.1.0



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'app/helpers/application_helper.rb', line 1247

def back_url
  url = params[:back_url]
  if url.nil? && referer = request.env['HTTP_REFERER']
    url = CGI.unescape(referer.to_s)
    # URLs that contains the utf8=[checkmark] parameter added by Rails are
    # parsed as invalid by URI.parse so the redirect to the back URL would
    # not be accepted (ApplicationController#validate_back_url would return
    # false)
    url.gsub!(/(\?|&)utf8=\u2713&?/, '\1')
  end
  url
end

#back_url_hidden_field_tag ⇒ Object

Since:

  • 0.7.0



1260
1261
1262
1263
 
# File 'app/helpers/application_helper.rb', line 1260

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

#body_css_classes ⇒ Object

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

Since:

  • 1.0.1



605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'app/helpers/application_helper.rb', line 605

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

  css << 'project-' + @project.identifier if @project && @project.identifier.present?
  css << 'controller-' + controller_name
  css << 'action-' + action_name
  if UserPreference::TEXTAREA_FONT_OPTIONS.include?(User.current.pref.textarea_font)
    css << "textarea-#{User.current.pref.textarea_font}"
  end
  css.join(' ')
end

#breadcrumb(*args) ⇒ Object

Since:

  • 0.7.0



536
537
538
539
 
# File 'app/helpers/application_helper.rb', line 536

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

#calendar_for(field_id) ⇒ Object 



1317
1318
1319
1320
 
# File 'app/helpers/application_helper.rb', line 1317

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

#catch_macros(text) ⇒ Object

Extracts macros from text

Since:

  • 2.1.0



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'app/helpers/application_helper.rb', line 1099

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

#check_all_links(form_name) ⇒ Object 



1265
1266
1267
1268
1269
 
# File 'app/helpers/application_helper.rb', line 1265

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

Since:

  • 1.0.0



1295
1296
1297
1298
1299
 
# File 'app/helpers/application_helper.rb', line 1295

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

#context_menu ⇒ Object

Since:

  • 1.0.0



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'app/helpers/application_helper.rb', line 1301

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

#default_search_project_scope ⇒ Object

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

Since:

  • 3.4.0



353
354
355
356
357
 
# File 'app/helpers/application_helper.rb', line 353

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

#delete_link(url, options = {}) ⇒ Object

Since:

  • 2.1.0



1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'app/helpers/application_helper.rb', line 1220

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

  link_to l(:button_delete), url, options
end

#due_date_distance_in_words(date) ⇒ Object

Since:

  • 0.8.0



274
275
276
277
278
 
# File 'app/helpers/application_helper.rb', line 274

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

#email_delivery_enabled? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 1.3.0



1409
1410
1411
 
# File 'app/helpers/application_helper.rb', line 1409

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

#error_messages_for(*objects) ⇒ Object

Render the error messages for the given objects

Since:

  • 1.4.0



1201
1202
1203
1204
1205
 
# File 'app/helpers/application_helper.rb', line 1201

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

#favicon ⇒ Object

Since:

  • 1.0.1



1460
1461
1462
 
# File 'app/helpers/application_helper.rb', line 1460

def favicon
  "<link rel='shortcut icon' href='#{favicon_path}' />".html_safe
end

#favicon_path ⇒ Object

Returns the path to the favicon

Since:

  • 2.5.0



1465
1466
1467
1468
 
# File 'app/helpers/application_helper.rb', line 1465

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

#favicon_url ⇒ Object

Returns the full URL to the favicon

Since:

  • 2.5.0



1471
1472
1473
1474
1475
1476
 
# File 'app/helpers/application_helper.rb', line 1471

def favicon_url
  # TODO: use #image_url introduced in Rails4
  path = favicon_path
  base = url_for(:controller => 'welcome', :action => 'index', :only_path => false)
  base.sub(%r{/+$},'') + '/' + path.sub(%r{^/+},'')
end

#format_activity_day(date) ⇒ Object

Since:

  • 0.8.0



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

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

#format_activity_description(text) ⇒ Object

Since:

  • 0.8.0



256
257
258
259
 
# File 'app/helpers/application_helper.rb', line 256

def format_activity_description(text)
  h(text.to_s.truncate(120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')
     ).gsub(/[\r\n]+/, "<br />").html_safe
end

#format_activity_title(text) ⇒ Object

Used to format item titles on the activity view

Since:

  • 0.8.0



248
249
250
 
# File 'app/helpers/application_helper.rb', line 248

def format_activity_title(text)
  text
end

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

Since:

  • 3.4.0



269
270
271
272
 
# File 'app/helpers/application_helper.rb', line 269

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

#format_object(object, html = true, &block) ⇒ Object

Helper that formats object for html or text rendering

Since:

  • 2.5.0



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'app/helpers/application_helper.rb', line 173

def format_object(object, html=true, &block)
  if block_given?
    object = yield object
  end
  case object.class.name
  when 'Array'
    formatted_objects = object.map {|o| format_object(o, html)}
    html ? safe_join(formatted_objects, ', ') : formatted_objects.join(', ')
  when 'Time'
    format_time(object)
  when 'Date'
    format_date(object)
  when 'Fixnum'
    object.to_s
  when 'Float'
    sprintf "%.2f", object
  when 'User'
    html ? link_to_user(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'
    html ? link_to_attachment(object) : object.filename
  when 'CustomValue', 'CustomFieldValue'
    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, &block)
      end
    else
      object.value.to_s
    end
  else
    html ? h(object) : object.to_s
  end
end

#format_version_name(version) ⇒ Object

Since:

  • 0.9.0



261
262
263
264
265
266
267
 
# File 'app/helpers/application_helper.rb', line 261

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

#generate_csv(&block) ⇒ Object

Since:

  • 3.1.0



1504
1505
1506
1507
 
# File 'app/helpers/application_helper.rb', line 1504

def generate_csv(&block)
  decimal_separator = l(:general_csv_decimal_separator)
  encoding = l(:general_csv_encoding)
end

#html_hours(text) ⇒ Object

Since:

  • 0.7.0



477
478
479
 
# File 'app/helpers/application_helper.rb', line 477

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 and automatically appended Exemples:

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

Since:

  • 0.6.0



591
592
593
594
595
596
597
598
599
600
601
 
# File 'app/helpers/application_helper.rb', line 591

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

Since:

  • 2.0.0



1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'app/helpers/application_helper.rb', line 1373

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

#include_calendar_headers_tags ⇒ Object

Since:

  • 0.7.0



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
 
# File 'app/helpers/application_helper.rb', line 1322

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: '" +
                   path_to_image('/images/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)

Since:

  • 1.1.0



1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'app/helpers/application_helper.rb', line 1483

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) ⇒ Object

Executes and replaces macros in text

Since:

  • 2.1.0



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'app/helpers/application_helper.rb', line 1115

def inject_macros(text, obj, macros, execute=true)
  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) || all)
      else
        h(all)
      end
    elsif orig
      h(orig)
    else
      h(all)
    end
  end
end

#javascript_heads ⇒ Object

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

Since:

  • 1.2.0



1452
1453
1454
1455
1456
1457
1458
 
# File 'app/helpers/application_helper.rb', line 1452

def javascript_heads
  tags = javascript_include_tag('jquery-1.11.1-ui-1.11.0-ujs-3.1.4', 'application', 'responsive')
  unless User.current.pref.warn_on_leaving_unsaved == '0'
    tags << "\n".html_safe + javascript_tag("$(window).load(function(){ warnLeavingUnsaved('#{escape_javascript l(:text_warn_on_leaving_unsaved)}'); });")
  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

Since:

  • 2.0.0



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'app/helpers/application_helper.rb', line 1387

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}/javascripts/#{source}"
      else
        source
      end
    end
  end
  super *sources, options
end

#labelled_fields_for(*args, &proc) ⇒ Object

Since:

  • 1.4.0



1193
1194
1195
1196
1197
1198
 
# File 'app/helpers/application_helper.rb', line 1193

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

#labelled_form_for(*args, &proc) ⇒ Object

Since:

  • 1.3.0



1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'app/helpers/application_helper.rb', line 1183

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

#lang_options_for_select(blank = true) ⇒ Object 



1179
1180
1181
 
# File 'app/helpers/application_helper.rb', line 1179

def lang_options_for_select(blank=true)
  (blank ? [["(auto)", ""]] : []) + languages_options
end

#link_to_attachment(attachment, options = {}) ⇒ Object

Generates a link to an attachment. Options:

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

  • :download - Force download (default: false)

Since:

  • 0.8.0



98
99
100
101
102
103
104
105
 
# File 'app/helpers/application_helper.rb', line 98

def link_to_attachment(attachment, options={})
  text = options.delete(:text) || attachment.filename
  route_method = options.delete(:download) ? :download_named_attachment_url : :named_attachment_url
  html_options = options.slice!(:only_path)
  options[:only_path] = true unless options.key?(:only_path)
  url = send(route_method, attachment, attachment.filename, options)
  link_to text, url, html_options
end

#link_to_function(name, function, html_options = {}) ⇒ Object

Since:

  • 2.1.0



1238
1239
1240
 
# File 'app/helpers/application_helper.rb', line 1238

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

#link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference) ⇒ Object

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
 
# File 'app/helpers/application_helper.rb', line 47

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

#link_to_issue(issue, options = {}) ⇒ Object

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

Since:

  • 0.5.0



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'app/helpers/application_helper.rb', line 74

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

#link_to_message(message, options = {}, html_options = nil) ⇒ Object

Generates a link to a message

Since:

  • 1.2.0



125
126
127
128
129
130
131
132
133
134
135
 
# File 'app/helpers/application_helper.rb', line 125

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

#link_to_project(project, options = {}, html_options = nil) ⇒ Object

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)

Since:

  • 1.0.1



144
145
146
147
148
149
150
151
152
 
# File 'app/helpers/application_helper.rb', line 144

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

#link_to_project_settings(project, options = {}, html_options = nil) ⇒ Object

Generates a link to a project settings if active

Since:

  • 2.3.0



155
156
157
158
159
160
161
162
163
 
# File 'app/helpers/application_helper.rb', line 155

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

#link_to_revision(revision, repository, options = {}) ⇒ Object

Generates a link to a SCM revision Options:

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

Since:

  • 0.9.0



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

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

#link_to_user(user, options = {}) ⇒ Object

Displays a link to user's account page if active



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/helpers/application_helper.rb', line 52

def link_to_user(user, options={})
  if user.is_a?(User)
    name = h(user.name(options[:format]))
    if user.active? || (User.current.admin? && user.logged?)
      link_to name, user_path(user), :class => user.css_classes
    else
      name
    end
  else
    h(user.to_s)
  end
end

#link_to_version(version, options = {}) ⇒ Object

Generates a link to a version

Since:

  • 2.6.0



166
167
168
169
170
 
# File 'app/helpers/application_helper.rb', line 166

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

Since:

  • 2.4.0



455
456
457
 
# File 'app/helpers/application_helper.rb', line 455

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

#other_formats_links {|Redmine::Views::OtherFormatsBuilder.new(self)| ... } ⇒ Object

Yields:

Since:

  • 0.9.0



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

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

#page_header_title ⇒ Object

Since:

  • 0.9.0



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'app/helpers/application_helper.rb', line 547

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 {|p| link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor') }
    end
    b << content_tag(:span, h(@project), class: 'current-project')
    if b.size > 1
      separator = content_tag(:span, ' &raquo; '.html_safe, class: 'separator')
      path = safe_join(b[0..-2], separator) + separator
      b = [content_tag(: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

Since:

  • 1.1.0



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'app/helpers/application_helper.rb', line 1062

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
    anchor = "#{obj.page.title}_#{anchor}" if options[:wiki_links] == :anchor && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version))
    @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

Since:

  • 3.4.0



712
713
714
715
716
717
 
# File 'app/helpers/application_helper.rb', line 712

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

Since:

  • 1.0.0



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'app/helpers/application_helper.rb', line 719

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] || []
  attachments += obj.attachments if obj.respond_to?(:attachments)
  if attachments.present?
    text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m|
      filename, ext, alt, alttext = $1.downcase, $2, $3, $4
      # 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.gsub('"', '')
        if !desc.blank? && alttext.blank?
          alt = " title=\"#{desc}\" alt=\"#{desc}\""
        end
        "src=\"#{image_url}\"#{alt}"
      else
        m
      end
    end
  end
end

#parse_non_pre_blocks(text, obj, macros) ⇒ Object

Since:

  • 1.0.0



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
 
# File 'app/helpers/application_helper.rb', line 678

def parse_non_pre_blocks(text, obj, macros)
  s = StringScanner.new(text)
  tags = []
  parsed = ''
  while !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) if macros.any?
    else
      inject_macros(text, obj, macros, false) 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

#parse_redmine_links(text, default_project, obj, attr, only_path, options) ⇒ Object

Redmine links

Examples:

Issues:
  #52 -> Link to issue #52
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

Since:

  • 1.0.0



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
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
947
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
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
 
# File 'app/helpers/application_helper.rb', line 844

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 == '#'
          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
              link = link_to("##{oid}#{comment_suffix}",
                             issue_url(issue, :only_path => only_path, :anchor => anchor),
                             :class => issue.css_classes,
                             :title => "#{issue.tracker.name}: #{issue.subject.truncate(100)} (#{issue.status.name})")
            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.where(:id => oid, :type => 'User').first
            link = link_to_user(u) 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] || []
            attachments += obj.attachments if obj.respond_to?(:attachments)
            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.where(:login => name, :type => 'User').first
            link = link_to_user(u) if u
          end
        elsif sep == "@"
          name = remove_double_quotes(identifier)
          u = User.visible.where(:login => name, :type => 'User').first
          link = link_to_user(u) 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

Since:

  • 1.3.0



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'app/helpers/application_helper.rb', line 1042

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
      content_tag('div',
        link_to(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

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

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]]

Since:

  • 1.0.0



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'app/helpers/application_helper.rb', line 753

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?
      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?(WikiContent::Version)) && obj.page == wiki_page
          "##{anchor}"
        else
          case options[:wiki_links]
          when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')
          when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export
          else
            wiki_page_id = page.present? ? Wiki.titleize(page) : nil
            parent = wiki_page.nil? && obj.is_a?(WikiContent) && obj.page && project == link_project ? obj.page.title : nil
            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

#preview_link(url, form, target = 'preview', options = {}) ⇒ Object

Deprecated.

Removed at 4.0.0

Since:

  • 2.1.0



1230
1231
1232
1233
1234
1235
1236
 
# File 'app/helpers/application_helper.rb', line 1230

def preview_link(url, form, target='preview', options={})
  content_tag 'a', l(:label_preview), {
      :href => "#",
      :onclick => %|submitPreview("#{escape_javascript url_for(url)}", "#{escape_javascript form}", "#{escape_javascript target}"); return false;|,
      :accesskey => accesskey(:preview)
    }.merge(options)
end

#principals_check_box_tags(name, principals) ⇒ Object

Since:

  • 0.9.0



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

def principals_check_box_tags(name, principals)
  s = ''
  principals.each do |principal|
    s << "<label>#{ check_box_tag name, principal.id, false, :id => nil } #{h principal}</label>\n"
  end
  s.html_safe
end

#principals_options_for_select(collection, selected = nil) ⇒ Object

Returns a string for users/groups option tags

Since:

  • 1.3.0



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

def principals_options_for_select(collection, selected=nil)
  s = ''
  if collection.include?(User.current)
    s << content_tag('option', "<< #{l(:label_me)} >>", :value => User.current.id)
  end
  groups = ''
  collection.sort.each do |element|
    selected_attribute = ' selected="selected"' if option_value_selected?(element, selected) || element.id.to_s == selected
    (element.is_a?(Group) ? groups : s) << %(<option value="#{element.id}"#{selected_attribute}>#{h element.name}</option>)
  end
  unless groups.empty?
    s << %(<optgroup label="#{h(l(:label_group_plural))}">#{groups}</optgroup>)
  end
  s.html_safe
end

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

Since:

  • 0.6.1



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'app/helpers/application_helper.rb', line 1278

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

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

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

Wrapper for Project#project_tree

Since:

  • 0.9.0



426
427
428
 
# File 'app/helpers/application_helper.rb', line 426

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

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

Since:

  • 0.9.0



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'app/helpers/application_helper.rb', line 401

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 << content_tag('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 << content_tag('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

Since:

  • 3.4.0



360
361
362
363
364
365
366
 
# File 'app/helpers/application_helper.rb', line 360

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

Since:

  • 2.1.2



1243
1244
1245
 
# File 'app/helpers/application_helper.rb', line 1243

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

#render_error_messages(errors) ⇒ Object

Renders a list of error messages

Since:

  • 3.3.0



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'app/helpers/application_helper.rb', line 1208

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

#render_flash_messages ⇒ Object

Renders flash messages

Since:

  • 0.8.1



330
331
332
333
334
335
336
 
# File 'app/helpers/application_helper.rb', line 330

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

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

Since:

  • 0.8.0



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'app/helpers/application_helper.rb', line 313

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>"
      content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title, :version => nil},
                         :title => (options[:timestamp] && page.updated_on ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil))
      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_box ⇒ Object

Renders the project quick-jump box

Since:

  • 0.9.0



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'app/helpers/application_helper.rb', line 380

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 = content_tag('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 = content_tag('div',
        content_tag('div', q, :class => 'quick-search') +
        content_tag('div', render_projects_for_jump_box(projects, @project), :class => 'drdn-items projects selection') +
        content_tag('div', all, :class => 'drdn-items all-projects selection'),
      :class => 'drdn-content'
    )

  content_tag('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)

Since:

  • 2.1.0



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
 
# File 'app/helpers/application_helper.rb', line 283

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')
      s << "<li class='#{classes}'><div class='#{classes}'>"
      s << h(block_given? ? 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) ⇒ Object

Since:

  • 3.4.0



368
369
370
371
372
373
374
375
376
377
 
# File 'app/helpers/application_helper.rb', line 368

def render_projects_for_jump_box(projects, selected=nil)
  jump = params[:jump].presence || current_menu_item
  s = ''.html_safe
  project_tree(projects) do |project, level|
    padding = level * 16
    text = content_tag('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
  s
end

#render_tabs(tabs, selected = params[:tab]) ⇒ Object

Renders tabs and their content

Since:

  • 0.9.0



339
340
341
342
343
344
345
346
347
348
349
 
# File 'app/helpers/application_helper.rb', line 339

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
    content_tag 'p', l(:label_no_data), :class => "nodata"
  end
end

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

Since:

  • 3.3.0



525
526
527
528
529
530
531
532
533
534
 
# File 'app/helpers/application_helper.rb', line 525

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

#reorder_links(name, url, method = :post) ⇒ Object

Deprecated.

Removed at 4.0.0

Since:

  • 0.9.0



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'app/helpers/application_helper.rb', line 507

def reorder_links(name, url, method = :post)
  # TODO: remove associated styles from application.css too
  ActiveSupport::Deprecation.warn "Application#reorder_links will be removed in Redmine 4."

  link_to(l(:label_sort_highest),
          url.merge({"#{name}[move_to]" => 'highest'}), :method => method,
          :title => l(:label_sort_highest), :class => 'icon-only icon-move-top') +
  link_to(l(:label_sort_higher),
          url.merge({"#{name}[move_to]" => 'higher'}), :method => method,
          :title => l(:label_sort_higher), :class => 'icon-only icon-move-up') +
  link_to(l(:label_sort_lower),
          url.merge({"#{name}[move_to]" => 'lower'}), :method => method,
          :title => l(:label_sort_lower), :class => 'icon-only icon-move-down') +
  link_to(l(:label_sort_lowest),
          url.merge({"#{name}[move_to]" => 'lowest'}), :method => method,
          :title => l(:label_sort_lowest), :class => 'icon-only icon-move-bottom')
end

#replace_toc(text, headings) ⇒ Object

Renders the TOC with given headings

Since:

  • 1.1.0



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'app/helpers/application_helper.rb', line 1137

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_tag ⇒ Object

Since:

  • 1.2.0



1478
1479
1480
 
# File 'app/helpers/application_helper.rb', line 1478

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

#sanitize_anchor_name(anchor) ⇒ Object

Since:

  • 1.2.2



1447
1448
1449
 
# File 'app/helpers/application_helper.rb', line 1447

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

#sidebar_content? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 2.0.0



1401
1402
1403
 
# File 'app/helpers/application_helper.rb', line 1401

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

Since:

  • 0.5.1



1171
1172
1173
1174
1175
1176
1177
 
# File 'app/helpers/application_helper.rb', line 1171

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

#stylesheet_link_tag(*sources) ⇒ Object

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

Since:

  • 2.0.0



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
 
# File 'app/helpers/application_helper.rb', line 1353

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}/stylesheets/#{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

Since:

  • 0.8.0



498
499
500
 
# File 'app/helpers/application_helper.rb', line 498

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

#syntax_highlight_lines(name, content) ⇒ Object

Since:

  • 1.4.0



494
495
496
 
# File 'app/helpers/application_helper.rb', line 494

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)



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'app/helpers/application_helper.rb', line 632

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) do |text|
    [:parse_inline_attachments, :parse_hires_images, :parse_wiki_links, :parse_redmine_links].each do |method_name|
      send method_name, text, 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

Since:

  • 2.1.0



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'app/helpers/application_helper.rb', line 223

def thumbnail_tag(attachment)
  thumbnail_size = Setting.thumbnails_size.to_i
  link_to(
    image_tag(
      thumbnail_path(attachment),
      :srcset => "#{thumbnail_path(attachment, :size => thumbnail_size * 2)} 2x",
      :style => "max-width: #{thumbnail_size}px; max-height: #{thumbnail_size}px;"
    ),
    named_attachment_path(
      attachment,
      attachment.filename
    ),
    :title => attachment.filename
  )
end

#time_tag(time) ⇒ Object

Since:

  • 0.9.0



485
486
487
488
489
490
491
492
 
# File 'app/helpers/application_helper.rb', line 485

def time_tag(time)
  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
    content_tag('abbr', text, :title => format_time(time))
  end
end

#title(*args) ⇒ Object

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

Since:

  • 2.4.0



573
574
575
576
577
578
579
580
581
582
583
 
# File 'app/helpers/application_helper.rb', line 573

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}
  content_tag('h2', strings.join(' &#187; ').html_safe)
end

#to_path_param(path) ⇒ Object

Since:

  • 0.8.0



502
503
504
505
 
# File 'app/helpers/application_helper.rb', line 502

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

#toggle_checkboxes_link(selector) ⇒ Object

Since:

  • 3.0.0



1271
1272
1273
1274
1275
1276
 
# File 'app/helpers/application_helper.rb', line 1271

def toggle_checkboxes_link(selector)
  link_to_function '',
    "toggleCheckboxesBySelector('#{selector}')",
    :title => "#{l(:button_check_all)} / #{l(:button_uncheck_all)}",
    :class => 'icon icon-checked'
end

#toggle_link(name, id, options = {}) ⇒ Object

Since:

  • 0.5.0



239
240
241
242
243
244
245
 
# File 'app/helpers/application_helper.rb', line 239

def toggle_link(name, id, options={})
  onclick = "$('##{id}').toggle(); "
  onclick << (options[:focus] ? "$('##{options[:focus]}').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

Since:

  • 1.0.0



464
465
466
467
468
469
470
471
 
# File 'app/helpers/application_helper.rb', line 464

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

Since:

  • 2.5.0



459
460
461
 
# File 'app/helpers/application_helper.rb', line 459

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

#view_layouts_base_sidebar_hook_response ⇒ Object

Since:

  • 2.0.0



1405
1406
1407
 
# File 'app/helpers/application_helper.rb', line 1405

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

Since:

  • 2.2.0



219
220
221
 
# File 'app/helpers/application_helper.rb', line 219

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