application_helper.rb 54.2 KB
Newer Older
1 2
# encoding: utf-8
#
3
# Redmine - project management software
jplang's avatar
jplang committed
4
# Copyright (C) 2006-2017  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.

jplang's avatar
jplang committed
20
require 'forwardable'
jplang's avatar
jplang committed
21
require 'cgi'
jplang's avatar
jplang committed
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

jplang's avatar
jplang committed
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

jplang's avatar
jplang committed
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)
jplang's avatar
jplang committed
54
      name = h(user.name(options[:format]))
55
      if user.active? || (User.current.admin? && user.logged?)
56 57
        only_path = options[:only_path].nil? ? true : options[:only_path]
        link_to name, user_url(user, :only_path => only_path), :class => user.css_classes
jplang's avatar
jplang committed
58 59 60
      else
        name
      end
jplang's avatar
jplang committed
61
    else
jplang's avatar
jplang committed
62
      h(user.to_s)
jplang's avatar
jplang committed
63
    end
64
  end
65

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

95 96 97 98 99 100
  # 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
101
    route_method = options.delete(:download) ? :download_named_attachment_url : :named_attachment_url
102
    html_options = options.slice!(:only_path)
jplang's avatar
jplang committed
103
    options[:only_path] = true unless options.key?(:only_path)
104 105
    url = send(route_method, attachment, attachment.filename, options)
    link_to text, url, html_options
106
  end
107

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

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

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

166 167 168 169 170 171 172
  # 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

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

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

224
  def thumbnail_tag(attachment)
225
    thumbnail_size = Setting.thumbnails_size.to_i
226 227 228
    link_to(
      image_tag(
        thumbnail_path(attachment),
229 230
        :srcset => "#{thumbnail_path(attachment, :size => thumbnail_size * 2)} 2x",
        :style => "max-width: #{thumbnail_size}px; max-height: #{thumbnail_size}px;"
231 232 233 234 235
      ),
      named_attachment_path(
        attachment,
        attachment.filename
      ),
236
      :title => attachment.filename
237
    )
238 239
  end

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

248
  # Used to format item titles on the activity view
249
  def format_activity_title(text)
250
    text
251
  end
252

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

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

262
  def format_version_name(version)
263
    if version.project == @project
264
      h(version)
265 266 267 268
    else
      h("#{version.project} - #{version}")
    end
  end
269

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

275 276
  def due_date_distance_in_words(date)
    if date
277
      l((date < User.current.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(User.current.today, date))
278 279
    end
  end
280

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

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

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

jplang's avatar
jplang committed
339
  # Renders tabs and their content
340
  def render_tabs(tabs, selected=params[:tab])
jplang's avatar
jplang committed
341
    if tabs.any?
342 343 344 345 346
      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
347 348 349 350
    else
      content_tag 'p', l(:label_no_data), :class => "nodata"
    end
  end
351

352 353 354 355 356 357 358 359
  # Returns the default scope for the quick search form
  # Could be 'all', 'my_projects', 'subprojects' or nil (current project)
  def default_search_project_scope
    if @project && !@project.leaf?
      'subprojects'
    end
  end

360 361 362 363 364 365 366 367 368 369
  # 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)
370
    jump = params[:jump].presence || current_menu_item
371 372 373 374
    s = ''.html_safe
    project_tree(projects) do |project, level|
      padding = level * 16
      text = content_tag('span', project.name, :style => "padding-left:#{padding}px;")
375
      s << link_to(text, project_path(project, :jump => jump), :title => project.name, :class => (project == selected ? 'selected' : nil))
376 377 378
    end
    s
  end
379

380 381
  # Renders the project quick-jump box
  def render_project_jump_box
382
    projects = projects_for_jump_box(User.current)
383 384 385 386
    if @project && @project.persisted?
      text = @project.name_was
    end
    text ||= l(:label_jump_to_a_project)
387 388
    url = autocomplete_projects_path(:format => 'js', :jump => current_menu_item)

389
    trigger = content_tag('span', text, :class => 'drdn-trigger')
390
    q = text_field_tag('q', '', :id => 'projects-quick-search', :class => 'autocomplete', :data => {:automcomplete_url => url}, :autocomplete => 'off')
391 392 393 394 395 396 397
    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
398

399
    content_tag('div', trigger + content, :id => "project-jump", :class => "drdn")
400
  end
401

402
  def project_tree_options_for_select(projects, options = {})
403
    s = ''.html_safe
404 405 406 407 408
    if blank_text = options[:include_blank]
      if blank_text == true
        blank_text = '&nbsp;'.html_safe
      end
      s << content_tag('option', blank_text, :value => '')
409
    end
410
    project_tree(projects) do |project, level|
emassip's avatar
emassip committed
411
      name_prefix = (level > 0 ? '&nbsp;' * 2 * level + '&#187; ' : '').html_safe
412 413 414 415 416 417
      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
418 419 420
      tag_options.merge!(yield(project)) if block_given?
      s << content_tag('option', name_prefix + h(project), tag_options)
    end
421
    s.html_safe
422
  end
423

424
  # Yields the given block for each project with its level in the tree
425 426
  #
  # Wrapper for Project#project_tree
427 428
  def project_tree(projects, options={}, &block)
    Project.project_tree(projects, options, &block)
429
  end
430

jplang's avatar
jplang committed
431 432
  def principals_check_box_tags(name, principals)
    s = ''
433
    principals.each do |principal|
jplang's avatar
jplang committed
434
      s << "<label>#{ check_box_tag name, principal.id, false, :id => nil } #{h principal}</label>\n"
jplang's avatar
jplang committed
435
    end
436
    s.html_safe
jplang's avatar
jplang committed
437
  end
438

439 440 441
  # Returns a string for users/groups option tags
  def principals_options_for_select(collection, selected=nil)
    s = ''
442
    if collection.include?(User.current)
jplang's avatar
jplang committed
443
      s << content_tag('option', "<< #{l(:label_me)} >>", :value => User.current.id)
444
    end
445 446
    groups = ''
    collection.sort.each do |element|
447
      selected_attribute = ' selected="selected"' if option_value_selected?(element, selected) || element.id.to_s == selected
448 449 450 451 452
      (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
453
    s.html_safe
454
  end
455

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

460
  def truncate_single_line_raw(string, length)
jplang's avatar
jplang committed
461
    string.to_s.truncate(length).gsub(%r{[\r\n]+}m, ' ')
462 463
  end

464 465 466 467 468 469 470 471 472
  # 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
473

jplang's avatar
jplang committed
474 475 476 477
  def anchor(text)
    text.to_s.gsub(' ', '_')
  end

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

jplang's avatar
jplang committed
482
  def authoring(created, author, options={})
483
    l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe
484
  end
485

486 487 488
  def time_tag(time)
    text = distance_of_time_in_words(Time.now, time)
    if @project
jplang's avatar
jplang committed
489
      link_to(text, project_activity_path(@project, :from => User.current.time_to_date(time)), :title => format_time(time))
490
    else
491
      content_tag('abbr', text, :title => format_time(time))
492
    end
493 494
  end

495
  def syntax_highlight_lines(name, content)
496
    syntax_highlight(name, content).each_line.to_a
497 498
  end

jplang's avatar
jplang committed
499
  def syntax_highlight(name, content)
500
    Redmine::SyntaxHighlighting.highlight_by_filename(content, name)
jplang's avatar
jplang committed
501
  end
502

jplang's avatar
jplang committed
503
  def to_path_param(path)
504 505
    str = path.to_s.split(%r{[/\\]}).select{|p| !p.blank?}.join("/")
    str.blank? ? nil : str
jplang's avatar
jplang committed
506 507
  end

508 509 510 511 512 513
  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
514
      :class => "sort-handle",
515 516
      :data => data,
      :title => l(:button_sort))
517 518
  end

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

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

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

555
  # Returns a h2 tag and sets the html title with the given arguments
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 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

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

586 587 588 589 590 591 592 593
  # 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

594
    css << 'project-' + @project.identifier if @project && @project.identifier.present?
595
    css << 'has-main-menu' if display_main_menu?(@project)
596 597
    css << 'controller-' + controller_name
    css << 'action-' + action_name
598
    css << 'avatars-' + (Setting.gravatar_enabled? ? 'on' : 'off')
599 600 601
    if UserPreference::TEXTAREA_FONT_OPTIONS.include?(User.current.pref.textarea_font)
      css << "textarea-#{User.current.pref.textarea_font}"
    end
602 603 604
    css.join(' ')
  end

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

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

634 635
    text = text.dup
    macros = catch_macros(text)
636 637 638 639

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

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

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

656 657 658
    if @parsed_headings.any?
      replace_toc(text, @parsed_headings)
    end
659

jplang's avatar
jplang committed
660
    text.html_safe
661
  end
662

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

695 696 697 698 699 700 701 702 703
  # 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

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

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

728 729 730 731 732 733 734 735 736 737 738 739
  # 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|
740
      link_project = project
741 742 743
      esc, all, page, title = $1, $2, $3, $5
      if esc.nil?
        if page =~ /^([^\:]+)\:(.*)$/
744 745 746
          identifier, page = $1, $2
          link_project = Project.find_by_identifier(identifier) || Project.find_by_name(identifier)
          title ||= identifier if page.blank?
747
        end
748

749
        if link_project && link_project.wiki && User.current.allowed_to?(:view_wiki_pages, link_project)
750 751 752 753 754
          # extract anchor
          anchor = nil
          if page =~ /^(.+?)\#(.+)$/
            page, anchor = $1, $2
          end
755
          anchor = sanitize_anchor_name(anchor) if anchor.present?
756 757
          # check if page exists
          wiki_page = link_project.wiki.find_page(page)
758 759 760 761
          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]
762
            when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')
763
            when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export
764
            else
765
              wiki_page_id = page.present? ? Wiki.titleize(page) : nil
766
              parent = wiki_page.nil? && obj.is_a?(WikiContent) && obj.page && project == link_project ? obj.page.title : nil
767
              url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project,
jplang's avatar
jplang committed