application_helper.rb 53 KB
Newer Older
1 2
# encoding: utf-8
#
3
# Redmine - project management software
jplang's avatar
jplang committed
4
# Copyright (C) 2006-2016  Jean-Philippe Lang
5 6 7 8 9
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
10
#
11 12 13 14
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
15
#
16 17 18 19
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

20
require 'forwardable'
21
require 'cgi'
22

23
module ApplicationHelper
24
  include Redmine::WikiFormatting::Macros::Definitions
25
  include Redmine::I18n
26
  include GravatarHelper::PublicMethods
27
  include Redmine::Pagination::Helper
28
  include Redmine::SudoMode::Helper
29
  include Redmine::Themes::Helper
30
  include Redmine::Hook::Helper
31
  include Redmine::Helpers::URL
32

33 34 35
  extend Forwardable
  def_delegators :wiki_helper, :wikitoolbar_for, :heads_for_wiki_formatter

36
  # Return true if user is authorized for controller/action, otherwise false
jplang's avatar
jplang committed
37 38
  def authorize_for(controller, action)
    User.current.allowed_to?({:controller => controller, :action => action}, @project)
39 40 41
  end

  # Display a link if user is authorized
42 43
  #
  # @param [String] name Anchor text (passed to link_to)
edavis10's avatar
edavis10 committed
44
  # @param [Hash] options Hash params. This will checked by authorize_for to see if the user is authorized
45 46
  # @param [optional, Hash] html_options Options passed to link_to
  # @param [optional, Hash] parameters_for_method_reference Extra parameters for link_to
47
  def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
edavis10's avatar
edavis10 committed
48
    link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])
49
  end
50

51
  # Displays a link to user's account page if active
52
  def link_to_user(user, options={})
jplang's avatar
jplang committed
53
    if user.is_a?(User)
54
      name = h(user.name(options[:format]))
55
      if user.active? || (User.current.admin? && user.logged?)
jplang's avatar
jplang committed
56
        link_to name, user_path(user), :class => user.css_classes
57 58 59
      else
        name
      end
jplang's avatar
jplang committed
60
    else
61
      h(user.to_s)
jplang's avatar
jplang committed
62
    end
63
  end
64

65 66
  # Displays a link to +issue+ with its subject.
  # Examples:
67
  #
68 69 70
  #   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
71
  #   link_to_issue(issue, :project => true)      # => Foo - Defect #6
72
  #   link_to_issue(issue, :subject => false, :tracker => false)     # => #6
73
  #
74
  def link_to_issue(issue, options={})
75 76
    title = nil
    subject = nil
77
    text = options[:tracker] == false ? "##{issue.id}" : "#{issue.tracker} ##{issue.id}"
78
    if options[:subject] == false
79
      title = issue.subject.truncate(60)
80 81
    else
      subject = issue.subject
82 83
      if truncate_length = options[:truncate]
        subject = subject.truncate(truncate_length)
84 85
      end
    end
86
    only_path = options[:only_path].nil? ? true : options[:only_path]
jplang's avatar
jplang committed
87
    s = link_to(text, issue_url(issue, :only_path => only_path),
88
                :class => issue.css_classes, :title => title)
jplang's avatar
jplang committed
89 90
    s << h(": #{subject}") if subject
    s = h("#{issue.project} - ") + s if options[:project]
91
    s
jplang's avatar
jplang committed
92
  end
93

94 95 96 97 98 99
  # Generates a link to an attachment.
  # Options:
  # * :text - Link text (default to attachment filename)
  # * :download - Force download (default: false)
  def link_to_attachment(attachment, options={})
    text = options.delete(:text) || attachment.filename
jplang's avatar
jplang committed
100
    route_method = options.delete(:download) ? :download_named_attachment_url : :named_attachment_url
101
    html_options = options.slice!(:only_path)
jplang's avatar
jplang committed
102
    options[:only_path] = true unless options.key?(:only_path)
103 104
    url = send(route_method, attachment, attachment.filename, options)
    link_to text, url, html_options
105
  end
106

107 108 109
  # Generates a link to a SCM revision
  # Options:
  # * :text - Link text (default to the formatted revision)
110 111 112 113
  def link_to_revision(revision, repository, options={})
    if repository.is_a?(Project)
      repository = repository.repository
    end
114
    text = options.delete(:text) || format_revision(revision)
115
    rev = revision.respond_to?(:identifier) ? revision.identifier : revision
116 117
    link_to(
        h(text),
118
        {:controller => 'repositories', :action => 'revision', :id => repository.project, :repository_id => repository.identifier_param, :rev => rev},
119 120
        :title => l(:label_revision_id, format_revision(revision)),
        :accesskey => options[:accesskey]
121
      )
122
  end
123

124 125 126
  # Generates a link to a message
  def link_to_message(message, options={}, html_options = nil)
    link_to(
127
      message.subject.truncate(60),
jplang's avatar
jplang committed
128
      board_message_url(message.board_id, message.parent_id || message.id, {
129
        :r => (message.parent_id && message.id),
jplang's avatar
jplang committed
130 131
        :anchor => (message.parent_id ? "message-#{message.id}" : nil),
        :only_path => true
132
      }.merge(options)),
133 134 135
      html_options
    )
  end
136

137 138
  # Generates a link to a project if active
  # Examples:
139
  #
140 141 142 143 144
  #   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)
  #
  def link_to_project(project, options={}, html_options = nil)
145
    if project.archived?
146 147
      h(project.name)
    else
jplang's avatar
jplang committed
148 149 150
      link_to project.name,
        project_url(project, {:only_path => true}.merge(options)),
        html_options
151 152 153 154 155 156 157 158 159 160 161
    end
  end

  # Generates a link to a project settings if active
  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
162 163 164
    end
  end

165 166 167 168 169 170 171
  # Generates a link to a version
  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

172
  # Helper that formats object for html or text rendering
173 174 175 176
  def format_object(object, html=true, &block)
    if block_given?
      object = yield object
    end
177
    case object.class.name
178 179
    when 'Array'
      object.map {|o| format_object(o, html)}.join(', ').html_safe
180 181 182 183 184 185 186 187 188 189 190 191 192
    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'
193
      html ? link_to_version(object) : object.to_s
194 195 196 197 198 199
    when 'TrueClass'
      l(:general_text_Yes)
    when 'FalseClass'
      l(:general_text_No)
    when 'Issue'
      object.visible? && html ? link_to_issue(object) : "##{object.id}"
200 201
    when 'Attachment'
      html ? link_to_attachment(object, :download => true) : object.filename
202 203 204 205 206 207
    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
208
          format_object(f, html, &block)
209 210 211 212
        end
      else
        object.value.to_s
      end
213 214 215 216 217
    else
      html ? h(object) : object.to_s
    end
  end

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

222
  def thumbnail_tag(attachment)
223 224 225
    link_to(
      image_tag(
        thumbnail_path(attachment),
226 227
        :srcset => "#{thumbnail_path(attachment, :size => Setting.thumbnails_size.to_i * 2)} 2x",
        :width => Setting.thumbnails_size 
228 229 230 231 232
      ),
      named_attachment_path(
        attachment,
        attachment.filename
      ),
233
      :title => attachment.filename
234
    )
235 236
  end

jplang's avatar
jplang committed
237
  def toggle_link(name, id, options={})
238 239
    onclick = "$('##{id}').toggle(); "
    onclick << (options[:focus] ? "$('##{options[:focus]}').focus(); " : "this.blur(); ")
240
    onclick << "$(window).scrollTop($('##{options[:focus]}').position().top); " if options[:scroll]
jplang's avatar
jplang committed
241 242 243
    onclick << "return false;"
    link_to(name, "#", :onclick => onclick)
  end
244

245
  # Used to format item titles on the activity view
246
  def format_activity_title(text)
247
    text
248
  end
249

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

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

259
  def format_version_name(version)
260
    if version.project == @project
261
      h(version)
262 263 264 265
    else
      h("#{version.project} - #{version}")
    end
  end
266

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

272 273
  def due_date_distance_in_words(date)
    if date
274
      l((date < User.current.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(User.current.today, date))
275 276
    end
  end
277

278 279 280
  # 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)
281
  def render_project_nested_lists(projects, &block)
282 283 284 285
    s = ''
    if projects.any?
      ancestors = []
      original_project = @project
jplang's avatar
jplang committed
286
      projects.sort_by(&:lft).each do |project|
287 288 289 290 291 292 293 294 295 296 297 298 299 300
        # 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}'>"
301
        s << h(block_given? ? capture(project, &block) : project.name)
302 303 304 305 306 307 308 309 310
        s << "</div>\n"
        ancestors << project
      end
      s << ("</li></ul>\n" * ancestors.size)
      @project = original_project
    end
    s.html_safe
  end

311
  def render_page_hierarchy(pages, node=nil, options={})
312 313 314 315 316
    content = ''
    if pages[node]
      content << "<ul class=\"pages-hierarchy\">\n"
      pages[node].each do |page|
        content << "<li>"
jplang's avatar
jplang committed
317
        content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title, :version => nil},
318 319
                           :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]
320 321 322 323
        content << "</li>\n"
      end
      content << "</ul>\n"
    end
324
    content.html_safe
325
  end
326

327 328 329 330
  # Renders flash messages
  def render_flash_messages
    s = ''
    flash.each do |k,v|
331
      s << content_tag('div', v.html_safe, :class => "flash #{k}", :id => "flash_#{k}")
332
    end
333
    s.html_safe
334
  end
335

jplang's avatar
jplang committed
336
  # Renders tabs and their content
337
  def render_tabs(tabs, selected=params[:tab])
jplang's avatar
jplang committed
338
    if tabs.any?
339 340 341 342 343
      unless tabs.detect {|tab| tab[:name] == selected}
        selected = nil
      end
      selected ||= tabs.first[:name]
      render :partial => 'common/tabs', :locals => {:tabs => tabs, :selected_tab => selected}
jplang's avatar
jplang committed
344 345 346 347
    else
      content_tag 'p', l(:label_no_data), :class => "nodata"
    end
  end
348

349 350 351 352 353 354 355 356 357 358
  # Returns an array of projects that are displayed in the quick-jump box
  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

  def render_projects_for_jump_box(projects, selected=nil)
359
    jump = params[:jump].presence || current_menu_item
360 361 362 363
    s = ''.html_safe
    project_tree(projects) do |project, level|
      padding = level * 16
      text = content_tag('span', project.name, :style => "padding-left:#{padding}px;")
364
      s << link_to(text, project_path(project, :jump => jump), :title => project.name, :class => (project == selected ? 'selected' : nil))
365 366 367
    end
    s
  end
368

369 370
  # Renders the project quick-jump box
  def render_project_jump_box
371
    projects = projects_for_jump_box(User.current)
372
    text = @project.try(:name) || l(:label_jump_to_a_project)
373 374
    url = autocomplete_projects_path(:format => 'js', :jump => current_menu_item)

375
    trigger = content_tag('span', text, :class => 'drdn-trigger')
376
    q = text_field_tag('q', '', :id => 'projects-quick-search', :class => 'autocomplete', :data => {:automcomplete_url => url}, :autocomplete => 'off')
377 378 379 380 381 382 383
    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'
      )
emassip's avatar
emassip committed
384

385
    content_tag('div', trigger + content, :id => "project-jump", :class => "drdn")
386
  end
387

388
  def project_tree_options_for_select(projects, options = {})
389
    s = ''.html_safe
390 391 392 393 394
    if blank_text = options[:include_blank]
      if blank_text == true
        blank_text = '&nbsp;'.html_safe
      end
      s << content_tag('option', blank_text, :value => '')
395
    end
396
    project_tree(projects) do |project, level|
emassip's avatar
emassip committed
397
      name_prefix = (level > 0 ? '&nbsp;' * 2 * level + '&#187; ' : '').html_safe
398 399 400 401 402 403
      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
404 405 406
      tag_options.merge!(yield(project)) if block_given?
      s << content_tag('option', name_prefix + h(project), tag_options)
    end
407
    s.html_safe
408
  end
409

410
  # Yields the given block for each project with its level in the tree
411 412
  #
  # Wrapper for Project#project_tree
413 414
  def project_tree(projects, options={}, &block)
    Project.project_tree(projects, options, &block)
415
  end
416

jplang's avatar
jplang committed
417 418
  def principals_check_box_tags(name, principals)
    s = ''
419
    principals.each do |principal|
jplang's avatar
jplang committed
420
      s << "<label>#{ check_box_tag name, principal.id, false, :id => nil } #{h principal}</label>\n"
jplang's avatar
jplang committed
421
    end
422
    s.html_safe
jplang's avatar
jplang committed
423
  end
424

425 426 427
  # Returns a string for users/groups option tags
  def principals_options_for_select(collection, selected=nil)
    s = ''
428
    if collection.include?(User.current)
jplang's avatar
jplang committed
429
      s << content_tag('option', "<< #{l(:label_me)} >>", :value => User.current.id)
430
    end
431 432
    groups = ''
    collection.sort.each do |element|
433
      selected_attribute = ' selected="selected"' if option_value_selected?(element, selected) || element.id.to_s == selected
434 435 436 437 438
      (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
439
    s.html_safe
440
  end
441

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

446
  def truncate_single_line_raw(string, length)
jplang's avatar
jplang committed
447
    string.to_s.truncate(length).gsub(%r{[\r\n]+}m, ' ')
448 449
  end

450 451 452 453 454 455 456 457 458
  # Truncates at line break after 250 characters or options[:length]
  def truncate_lines(string, options={})
    length = options[:length] || 250
    if string.to_s =~ /\A(.{#{length}}.*?)$/m
      "#{$1}..."
    else
      string
    end
  end
459

jplang's avatar
jplang committed
460 461 462 463
  def anchor(text)
    text.to_s.gsub(' ', '_')
  end

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

jplang's avatar
jplang committed
468
  def authoring(created, author, options={})
469
    l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe
470
  end
471

472 473 474
  def time_tag(time)
    text = distance_of_time_in_words(Time.now, time)
    if @project
jplang's avatar
jplang committed
475
      link_to(text, project_activity_path(@project, :from => User.current.time_to_date(time)), :title => format_time(time))
476
    else
477
      content_tag('abbr', text, :title => format_time(time))
478
    end
479 480
  end

481
  def syntax_highlight_lines(name, content)
482
    syntax_highlight(name, content).each_line.to_a
483 484
  end

485
  def syntax_highlight(name, content)
486
    Redmine::SyntaxHighlighting.highlight_by_filename(content, name)
487
  end
488

jplang's avatar
jplang committed
489
  def to_path_param(path)
490 491
    str = path.to_s.split(%r{[/\\]}).select{|p| !p.blank?}.join("/")
    str.blank? ? nil : str
jplang's avatar
jplang committed
492 493
  end

jplang's avatar
jplang committed
494
  def reorder_links(name, url, method = :post)
jplang's avatar
jplang committed
495 496 497
    # TODO: remove associated styles from application.css too
    ActiveSupport::Deprecation.warn "Application#reorder_links will be removed in Redmine 4."

498
    link_to(l(:label_sort_highest),
499 500
            url.merge({"#{name}[move_to]" => 'highest'}), :method => method,
            :title => l(:label_sort_highest), :class => 'icon-only icon-move-top') +
501
    link_to(l(:label_sort_higher),
502 503
            url.merge({"#{name}[move_to]" => 'higher'}), :method => method,
            :title => l(:label_sort_higher), :class => 'icon-only icon-move-up') +
504
    link_to(l(:label_sort_lower),
505 506
            url.merge({"#{name}[move_to]" => 'lower'}), :method => method,
            :title => l(:label_sort_lower), :class => 'icon-only icon-move-down') +
507
    link_to(l(:label_sort_lowest),
508 509
            url.merge({"#{name}[move_to]" => 'lowest'}), :method => method,
            :title => l(:label_sort_lowest), :class => 'icon-only icon-move-bottom')
jplang's avatar
jplang committed
510
  end
511

512 513 514 515 516 517
  def reorder_handle(object, options={})
    data = {
      :reorder_url => options[:url] || url_for(object),
      :reorder_param => options[:param] || object.class.name.underscore
    }
    content_tag('span', '',
jplang's avatar
jplang committed
518
      :class => "sort-handle",
519 520
      :data => data,
      :title => l(:button_sort))
521 522
  end

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

528
  def other_formats_links(&block)
jplang's avatar
jplang committed
529
    concat('<p class="other-formats">'.html_safe + l(:label_export_to))
530
    yield Redmine::Views::OtherFormatsBuilder.new(self)
jplang's avatar
jplang committed
531
    concat('</p>'.html_safe)
532
  end
533

534 535 536 537 538
  def page_header_title
    if @project.nil? || @project.new_record?
      h(Setting.app_title)
    else
      b = []
jplang's avatar
jplang committed
539
      ancestors = (@project.root? ? [] : @project.ancestors.visible.to_a)
540 541
      if ancestors.any?
        root = ancestors.shift
542
        b << link_to_project(root, {:jump => current_menu_item}, :class => 'root')
543
        if ancestors.size > 2
544
          b << "\xe2\x80\xa6"
545 546
          ancestors = ancestors[-2, 2]
        end
547
        b += ancestors.collect {|p| link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor') }
548
      end
549 550 551 552 553 554 555
      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
556 557
    end
  end
558

559
  # Returns a h2 tag and sets the html title with the given arguments
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
  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

  # 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'
578 579
  def html_title(*args)
    if args.empty?
580
      title = @html_title || []
tmaruyama's avatar
tmaruyama committed
581
      title << @project.name if @project
582
      title << Setting.app_title unless Setting.app_title == title.last
583
      title.reject(&:blank?).join(' - ')
584 585 586 587
    else
      @html_title ||= []
      @html_title += args
    end
588
  end
jplang's avatar
jplang committed
589

590 591 592 593 594 595 596 597
  # Returns the theme, controller name, and action as css classes for the
  # HTML body.
  def body_css_classes
    css = []
    if theme = Redmine::Themes.theme(Setting.ui_theme)
      css << 'theme-' + theme.name
    end

598
    css << 'project-' + @project.identifier if @project && @project.identifier.present?
599 600
    css << 'controller-' + controller_name
    css << 'action-' + action_name
601 602 603
    if UserPreference::TEXTAREA_FONT_OPTIONS.include?(User.current.pref.textarea_font)
      css << "textarea-#{User.current.pref.textarea_font}"
    end
604 605 606
    css.join(' ')
  end

jplang's avatar
jplang committed
607
  def accesskey(s)
608 609 610 611 612
    @used_accesskeys ||= []
    key = Redmine::AccessKeys.key_for(s)
    return nil if @used_accesskeys.include?(key)
    @used_accesskeys << key
    key
jplang's avatar
jplang committed
613 614
  end

615 616 617 618 619 620 621 622
  # 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)
  def textilizable(*args)
    options = args.last.is_a?(Hash) ? args.pop : {}
    case args.size
    when 1
623
      obj = options[:object]
jplang's avatar
jplang committed
624
      text = args.shift
625 626
    when 2
      obj = args.shift
627 628
      attr = args.shift
      text = obj.send(attr).to_s
629 630 631
    else
      raise ArgumentError, 'invalid arguments to textilizable'
    end
jplang's avatar
jplang committed
632
    return '' if text.blank?
633
    project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
634
    @only_path = only_path = options.delete(:only_path) == false ? false : true
635

636 637
    text = text.dup
    macros = catch_macros(text)
638 639 640 641 642 643 644

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

646
    @parsed_headings = []
647
    @heading_anchors = {}
648
    @current_section = 0 if options[:edit_section_links]
649 650

    parse_sections(text, project, obj, attr, only_path, options)
651
    text = parse_non_pre_blocks(text, obj, macros) do |text|
652
      [:parse_inline_attachments, :parse_hires_images, :parse_wiki_links, :parse_redmine_links].each do |method_name|
653 654
        send method_name, text, project, obj, attr, only_path, options
      end
655
    end
656
    parse_headings(text, project, obj, attr, only_path, options)
657

658 659 660
    if @parsed_headings.any?
      replace_toc(text, @parsed_headings)
    end
661

jplang's avatar
jplang committed
662
    text.html_safe
663
  end
664

665
  def parse_non_pre_blocks(text, obj, macros)
666 667 668 669 670 671 672 673
    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
674 675 676
        inject_macros(text, obj, macros) if macros.any?
      else
        inject_macros(text, obj, macros, false) if macros.any?
677 678 679 680
      end
      parsed << text
      if tag
        if closing
681
          if tags.last && tags.last.casecmp(tag) == 0
682 683 684 685 686 687 688 689
            tags.pop
          end
        else
          tags << tag.downcase
        end
        parsed << full_tag
      end
    end
690 691 692 693
    # Close any non closing tags
    while tag = tags.pop
      parsed << "</#{tag}>"
    end
694
    parsed
695
  end
696

697 698 699 700 701 702 703 704 705
  # add srcset attribute to img tags if filename includes @2x, @3x, etc.
  # to support hires displays
  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

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

709
    # when using an image link, try to use an attachment, if possible
jplang's avatar
jplang committed
710 711 712
    attachments = options[:attachments] || []
    attachments += obj.attachments if obj.respond_to?(:attachments)
    if attachments.present?
713
      text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m|
714
        filename, ext, alt, alttext = $1.downcase, $2, $3, $4
715
        # search for the picture in attachments
716
        if found = Attachment.latest_attach(attachments, CGI.unescape(filename))
jplang's avatar
jplang committed
717
          image_url = download_named_attachment_url(found, found.filename, :only_path => only_path)
718 719 720 721
          desc = found.description.to_s.gsub('"', '')
          if !desc.blank? && alttext.blank?
            alt = " title=\"#{desc}\" alt=\"#{desc}\""
          end
722
          "src=\"#{image_url}\"#{alt}"
723
        else
724
          m
725 726 727
        end
      end
    end
728
  end
729

730 731 732 733 734 735 736 737 738 739 740 741
  # 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]]
  def parse_wiki_links(text, project, obj, attr, only_path, options)
    text.gsub!(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m|
742
      link_project = project
743 744 745
      esc, all, page, title = $1, $2, $3, $5
      if esc.nil?
        if page =~ /^([^\:]+)\:(.*)$/
746 747 748
          identifier, page = $1, $2
          link_project = Project.find_by_identifier(identifier) || Project.find_by_name(identifier)
          title ||= identifier if page.blank?
749
        end
750

751
        if link_project && link_project.wiki && User.current.allowed_to?(:view_wiki_pages, link_project)
752 753 754 755 756
          # extract anchor
          anchor = nil
          if page =~ /^(.+?)\#(.+)$/
            page, anchor = $1, $2
          end
757
          anchor = sanitize_anchor_name(anchor) if anchor.present?
758 759
          # check if page exists
          wiki_page = link_project.wiki.find_page(page)
760 761 762 763
          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]
764
            when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')
765
            when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export
766
            else
767
              wiki_page_id = page.present? ? Wiki.titleize(page) : nil
768
              parent = wiki_page.nil? && obj.is_a?(WikiContent) && obj.page && project == link_project ? obj.page.title : nil
769
              url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project,
jplang's avatar
jplang committed
770
               :id => wiki_page_id, :version => nil, :anchor => anchor, :parent => parent)
771
            end
772
          end
emassip's avatar
emassip committed
773
          link_to(title.present? ? title.html_safe : h(page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new')))
774 775
        else
          # project or wiki doesn't exist
776
          all
777
        end
jplang's avatar
jplang committed
778
      else
779
        all
jplang's avatar
jplang committed
780
      end
781
    end
782
  end
783

784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
  # 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
808
  #   Forum messages:
809
  #     message#1218 -> Link to message with id 1218
810 811 812
  #  Projects:
  #     project:someproject -> Link to project named "someproject"
  #     project#3 -> Link to project with id 3
813 814 815 816 817 818
  #
  #   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
819
  def parse_redmine_links(text, default_project, obj, attr, only_path, options)
820 821 822 823 824 825 826 827 828 829 830 831 832 833
    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]
      identifier = $~[:identifier1] || $~[:identifier2]
      comment_suffix = $~[:comment_suffix]
      comment_id = $~[:comment_id]

834 835 836 837 838 839 840 841 842 843
      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'
844 845
            if project
              repository = nil
846
              if repo_identifier
847 848 849 850
                repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
              else
                repository = project.repository
              end
851 852 853 854 855 856 857 858 859 860 861
              # 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))
862
              end
863
            end
864 865 866 867 868
          elsif sep == '#'
            oid = identifier.to_i
            case prefix
            when nil
              if oid.to_s == identifier &&
jplang's avatar
jplang committed
869
                issue = Issue.visible.find_by_id(oid)
870
                anchor = comment_id ? "note-#{comment_id}" : nil
jplang's avatar
jplang committed
871
                link = link_to("##{oid}#{comment_suffix}",
jplang's avatar
jplang committed
872
                               issue_url(issue, :only_path => only_path, :anchor => anchor),
873
                               :class => issue.css_classes,
874
                               :title => "#{issue.tracker.name}: #{issue.subject.truncate(100)} (#{issue.status.name})")
875 876 877
              end
            when 'document'
              if document = Document.visible.find_by_id(oid)
jplang's avatar
jplang committed
878
                link = link_to(document.title, document_url(document, :only_path => only_path), :class => 'document')
879 880 881
              end
            when 'version'
              if version = Version.visible.find_by_id(oid)
jplang's avatar
jplang committed
882
                link = link_to(version.name, version_url(version, :only_path => only_path), :class => 'version')
883 884
              end
            when 'message'
jplang's avatar
jplang committed
885
              if message = Message.visible.find_by_id(oid)
886 887 888 889
                link = link_to_message(message, {:only_path => only_path}, :class => 'message')
              end
            when 'forum'
              if board = Board.visible.find_by_id(oid)
jplang's avatar
jplang committed
890
                link = link_to(board.name, project_board_url(board.project, board, :only_path => only_path), :class => 'board')
891 892 893
              end
            when 'news'
              if news = News.visible.find_by_id(oid)
jplang's avatar
jplang committed
894
                link = link_to(news.title, news_url(news, :only_path => only_path), :class => 'news')
895 896 897 898 899
              end
            when 'project'
              if p = Project.visible.find_by_id(oid)
                link = link_to_project(p, {:only_path => only_path}, :class => 'project')
              end
900
            end
901 902 903 904 905 906 907
          elsif sep == ':'
            # removes the double quotes if any
            name = identifier.gsub(%r{^"(.*)"$}, "\\1")
            name = CGI.unescapeHTML(name)
            case prefix
            when 'document'
              if project && document = project.documents.visible.find_by_title(name)
jplang's avatar
jplang committed
908
                link = link_to(document.title, document_url(document, :only_path => only_path), :class => 'document')
909 910 911
              end
            when 'version'
              if project && version = project.versions.visible.find_by_name(name)
jplang's avatar
jplang committed
912
                link = link_to(version.name, version_url(version, :only_path => only_path), :class => 'version')
913 914 915
              end
            when 'forum'
              if project && board = project.boards.visible.find_by_name(name)
jplang's avatar
jplang committed
916
                link = link_to(board.name, project_board_url(board.project, board, :only_path => only_path), :class => 'board')
917 918 919
              end
            when 'news'
              if project && news = project.news.visible.find_by_title(name)
jplang's avatar
jplang committed
920
                link = link_to(news.title, news_url(news, :only_path => only_path), :class => 'news')
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
              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<