application_helper.rb 26.8 KB
Newer Older
1 2 3 4 5 6 7
# redMine - project management software
# Copyright (C) 2006-2007  Jean-Philippe Lang
#
# 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.
8
#
9 10 11 12
# 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.
13
#
14 15 16 17
# 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.

18 19
require 'coderay'
require 'coderay/helpers/file_type'
20
require 'forwardable'
21
require 'cgi'
22

23
module ApplicationHelper
24
  include Redmine::WikiFormatting::Macros::Definitions
25
  include GravatarHelper::PublicMethods
26

27 28 29
  extend Forwardable
  def_delegators :wiki_helper, :wikitoolbar_for, :heads_for_wiki_formatter

jplang's avatar
jplang committed
30 31
  def current_role
    @current_role ||= User.current.role_for_project(@project)
32
  end
33

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

  # Display a link if user is authorized
  def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
jplang's avatar
jplang committed
41
    link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])
42
  end
43

44 45 46 47
  # Display a link to remote if user is authorized
  def link_to_remote_if_authorized(name, options = {}, html_options = nil)
    url = options[:url] || {}
    link_to_remote(name, options, html_options) if authorize_for(url[:controller] || params[:controller], url[:action])
48 49 50
  end

  # Display a link to user's account page
51 52
  def link_to_user(user, options={})
    (user && !user.anonymous?) ? link_to(user.name(options[:format]), :controller => 'account', :action => 'show', :id => user) : 'Anonymous'
53
  end
54

55
  def link_to_issue(issue, options={})
56 57 58
    options[:class] ||= ''
    options[:class] << ' issue'
    options[:class] << ' closed' if issue.closed?
59
    link_to "#{issue.tracker.name} ##{issue.id}", {:controller => "issues", :action => "show", :id => issue}, options
jplang's avatar
jplang committed
60
  end
61

62 63 64 65 66 67 68
  # 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
    action = options.delete(:download) ? 'download' : 'show'
69

70 71
    link_to(h(text), {:controller => 'attachments', :action => action, :id => attachment, :filename => attachment.filename }, options)
  end
72

jplang's avatar
jplang committed
73 74 75 76 77 78
  def toggle_link(name, id, options={})
    onclick = "Element.toggle('#{id}'); "
    onclick << (options[:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ")
    onclick << "return false;"
    link_to(name, "#", :onclick => onclick)
  end
79

80 81
  def image_to_function(name, function, html_options = {})
    html_options.symbolize_keys!
82 83 84
    tag(:input, html_options.merge({
        :type => "image", :src => image_path(name),
        :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};"
85 86
        }))
  end
87

88 89 90 91
  def prompt_to_remote(name, text, param, url, html_options = {})
    html_options[:onclick] = "promptToRemote('#{text}', '#{param}', '#{url_for(url)}'); return false;"
    link_to name, {}, html_options
  end
92

93
  def format_date(date)
94
    return nil unless date
95 96
    # "Setting.date_format.size < 2" is a temporary fix (content of date_format setting changed)
    @date_format ||= (Setting.date_format.blank? || Setting.date_format.size < 2 ? l(:general_fmt_date) : Setting.date_format)
97
    date.strftime(@date_format)
98
  end
99

100
  def format_time(time, include_date = true)
101 102
    return nil unless time
    time = time.to_time if time.is_a?(String)
103
    zone = User.current.time_zone
104
    local = zone ? time.in_time_zone(zone) : (time.utc? ? time.localtime : time)
105 106
    @date_format ||= (Setting.date_format.blank? || Setting.date_format.size < 2 ? l(:general_fmt_date) : Setting.date_format)
    @time_format ||= (Setting.time_format.blank? ? l(:general_fmt_time) : Setting.time_format)
107
    include_date ? local.strftime("#{@date_format} #{@time_format}") : local.strftime(@time_format)
108
  end
109 110 111 112 113 114 115 116 117 118 119 120
  
  def format_activity_title(text)
    h(truncate_single_line(text, 100))
  end
  
  def format_activity_day(date)
    date == Date.today ? l(:label_today).titleize : format_date(date)
  end
  
  def format_activity_description(text)
    h(truncate(text.to_s, 250).gsub(%r{<(pre|code)>.*$}m, '...'))
  end
121

122 123 124 125 126 127
  def distance_of_date_in_words(from_date, to_date = 0)
    from_date = from_date.to_date if from_date.respond_to?(:to_date)
    to_date = to_date.to_date if to_date.respond_to?(:to_date)
    distance_in_days = (to_date - from_date).abs
    lwr(:actionview_datehelper_time_in_words_day, distance_in_days)
  end
128

129 130 131 132 133
  def due_date_distance_in_words(date)
    if date
      l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date))
    end
  end
134

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
  def render_page_hierarchy(pages, node=nil)
    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 => 'index', :id => page.project, :page => page.title},
                           :title => (page.respond_to?(: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) if pages[page.id]
        content << "</li>\n"
      end
      content << "</ul>\n"
    end
    content
  end
150 151 152 153 154 155 156 157 158
  
  # Renders flash messages
  def render_flash_messages
    s = ''
    flash.each do |k,v|
      s << content_tag('div', v, :class => "flash #{k}")
    end
    s
  end
159 160 161 162 163 164 165 166 167 168
  
  # Renders the project quick-jump box
  def render_project_jump_box
    # Retrieve them now to avoid a COUNT query
    projects = User.current.projects.all
    if projects.any?
      s = '<select onchange="if (this.value != \'\') { window.location = this.value; }">' +
            "<option selected='selected'>#{ l(:label_jump_to_a_project) }</option>" +
            '<option disabled="disabled">---</option>'
      s << project_tree_options_for_select(projects) do |p|
169
        { :value => url_for(:controller => 'projects', :action => 'show', :id => p, :jump => current_menu_item) }
170 171 172 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
      end
      s << '</select>'
      s
    end
  end
  
  def project_tree_options_for_select(projects, options = {})
    s = ''
    project_tree(projects) do |project, level|
      name_prefix = (level > 0 ? ('&nbsp;' * 2 * level + '&#187; ') : '')
      tag_options = {:value => project.id, :selected => ((project == options[:selected]) ? 'selected' : nil)}
      tag_options.merge!(yield(project)) if block_given?
      s << content_tag('option', name_prefix + h(project), tag_options)
    end
    s
  end
  
  # Yields the given block for each project with its level in the tree
  def project_tree(projects, &block)
    ancestors = []
    projects.sort_by(&:lft).each do |project|
      while (ancestors.any? && !project.is_descendant_of?(ancestors.last)) 
        ancestors.pop
      end
      yield project, ancestors.size
      ancestors << project
    end
  end
198

199 200 201 202
  # Truncates and returns the string as a single line
  def truncate_single_line(string, *args)
    truncate(string, *args).gsub(%r{[\r\n]+}m, ' ')
  end
203

204 205 206
  def html_hours(text)
    text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>')
  end
207

jplang's avatar
jplang committed
208
  def authoring(created, author, options={})
209 210 211 212
    time_tag = @project.nil? ? content_tag('acronym', distance_of_time_in_words(Time.now, created), :title => format_time(created)) :
                               link_to(distance_of_time_in_words(Time.now, created), 
                                       {:controller => 'projects', :action => 'activity', :id => @project, :from => created.to_date},
                                       :title => format_time(created))
213
    author_tag = (author.is_a?(User) && !author.anonymous?) ? link_to(h(author), :controller => 'account', :action => 'show', :id => author) : h(author || 'Anonymous')
jplang's avatar
jplang committed
214
    l(options[:label] || :label_added_time_by, author_tag, time_tag)
215
  end
216

217 218 219
  def l_or_humanize(s, options={})
    k = "#{options[:prefix]}#{s}".to_sym
    l_has_string?(k) ? l(k) : s.to_s.humanize
220
  end
221

222 223 224
  def day_name(day)
    l(:general_day_names).split(',')[day-1]
  end
225

226 227 228 229
  def month_name(month)
    l(:actionview_datehelper_select_month_names).split(',')[month-1]
  end

230 231 232 233
  def syntax_highlight(name, content)
    type = CodeRay::FileType[name]
    type ? CodeRay.scan(content, type).html : h(content)
  end
234

jplang's avatar
jplang committed
235 236 237 238
  def to_path_param(path)
    path.to_s.split(%r{[/\\]}).select {|p| !p.blank?}
  end

239
  def pagination_links_full(paginator, count=nil, options={})
240
    page_param = options.delete(:page_param) || :page
241
    url_param = params.dup
242 243
    # don't reuse params if filters are present
    url_param.clear if url_param.has_key?(:set_filter)
244 245

    html = ''
246 247 248
    if paginator.current.previous
      html << link_to_remote_content_update('&#171; ' + l(:label_previous), url_param.merge(page_param => paginator.current.previous)) + ' '
    end
249

250
    html << (pagination_links_each(paginator, options) do |n|
251
      link_to_remote_content_update(n.to_s, url_param.merge(page_param => n))
252
    end || '')
253 254 255 256
    
    if paginator.current.next
      html << ' ' + link_to_remote_content_update((l(:label_next) + ' &#187;'), url_param.merge(page_param => paginator.current.next))
    end
257

258
    unless count.nil?
259 260 261 262
      html << [
        " (#{paginator.current.first_item}-#{paginator.current.last_item}/#{count})",
        per_page_links(paginator.items_per_page)
      ].compact.join(' | ')
263
    end
264 265

    html
266
  end
267
  
268
  def per_page_links(selected=nil)
269 270
    url_param = params.dup
    url_param.clear if url_param.has_key?(:set_filter)
271

272
    links = Setting.per_page_options_array.collect do |n|
273 274 275
      n == selected ? n : link_to_remote(n, {:update => "content",
                                             :url => params.dup.merge(:per_page => n),
                                             :method => :get},
276
                                            {:href => url_for(url_param.merge(:per_page => n))})
277 278 279
    end
    links.size > 1 ? l(:label_display_per_page, links.join(', ')) : nil
  end
280

281
  def breadcrumb(*args)
282 283
    elements = args.flatten
    elements.any? ? content_tag('p', args.join(' &#187; ') + ' &#187; ', :class => 'breadcrumb') : nil
284
  end
285

286 287 288 289 290 291 292 293 294 295 296
  def html_title(*args)
    if args.empty?
      title = []
      title << @project.name if @project
      title += @html_title if @html_title
      title << Setting.app_title
      title.compact.join(' - ')
    else
      @html_title ||= []
      @html_title += args
    end
297
  end
jplang's avatar
jplang committed
298 299

  def accesskey(s)
300
    Redmine::AccessKeys.key_for s
jplang's avatar
jplang committed
301 302
  end

303 304 305 306 307 308 309 310
  # 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
311
      obj = options[:object]
jplang's avatar
jplang committed
312
      text = args.shift
313 314
    when 2
      obj = args.shift
jplang's avatar
jplang committed
315
      text = obj.send(args.shift).to_s
316 317 318
    else
      raise ArgumentError, 'invalid arguments to textilizable'
    end
jplang's avatar
jplang committed
319
    return '' if text.blank?
320

jplang's avatar
jplang committed
321
    only_path = options.delete(:only_path) == false ? false : true
322 323

    # when using an image link, try to use an attachment, if possible
jplang's avatar
jplang committed
324
    attachments = options[:attachments] || (obj && obj.respond_to?(:attachments) ? obj.attachments : nil)
325

326
    if attachments
327
      attachments = attachments.sort_by(&:created_on).reverse
328
      text = text.gsub(/!((\<|\=|\>)?(\([^\)]+\))?(\[[^\]]+\])?(\{[^\}]+\})?)(\S+\.(bmp|gif|jpg|jpeg|png))!/i) do |m|
329 330
        style = $1
        filename = $6
331
        rf = Regexp.new(Regexp.escape(filename),  Regexp::IGNORECASE)
332 333
        # search for the picture in attachments
        if found = attachments.detect { |att| att.filename =~ rf }
334 335 336 337
          image_url = url_for :only_path => only_path, :controller => 'attachments', :action => 'download', :id => found
          desc = found.description.to_s.gsub(/^([^\(\)]*).*$/, "\\1")
          alt = desc.blank? ? nil : "(#{desc})"
          "!#{style}#{image_url}#{alt}!"
338
        else
339
          "!#{style}#{filename}!"
340 341 342
        end
      end
    end
343

344
    text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text) { |macro, args| exec_macro(macro, obj, args) }
345

346 347 348 349
    # different methods for formatting wiki links
    case options[:wiki_links]
    when :local
      # used for local links to html files
350
      format_wiki_link = Proc.new {|project, title, anchor| "#{title}.html" }
351 352
    when :anchor
      # used for single-file wiki export
353
      format_wiki_link = Proc.new {|project, title, anchor| "##{title}" }
354
    else
355
      format_wiki_link = Proc.new {|project, title, anchor| url_for(:only_path => only_path, :controller => 'wiki', :action => 'index', :id => project, :page => title, :anchor => anchor) }
356
    end
357

jplang's avatar
jplang committed
358
    project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
359

360
    # Wiki links
361
    #
362
    # Examples:
363 364 365 366
    #   [[mypage]]
    #   [[mypage|mytext]]
    # wiki links can refer other project wikis, using project name or identifier:
    #   [[project:]] -> wiki starting page
367
    #   [[project:|mytext]]
368 369
    #   [[project:mypage]]
    #   [[project:mypage|mytext]]
jplang's avatar
jplang committed
370
    text = text.gsub(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m|
371
      link_project = project
372 373 374 375 376 377 378
      esc, all, page, title = $1, $2, $3, $5
      if esc.nil?
        if page =~ /^([^\:]+)\:(.*)$/
          link_project = Project.find_by_name($1) || Project.find_by_identifier($1)
          page = $2
          title ||= $1 if page.blank?
        end
379

380
        if link_project && link_project.wiki
381 382 383 384 385
          # extract anchor
          anchor = nil
          if page =~ /^(.+?)\#(.+)$/
            page, anchor = $1, $2
          end
386 387
          # check if page exists
          wiki_page = link_project.wiki.find_page(page)
388
          link_to((title || page), format_wiki_link.call(link_project, Wiki.titleize(page), anchor),
389 390 391 392 393
                                   :class => ('wiki-page' + (wiki_page ? '' : ' new')))
        else
          # project or wiki doesn't exist
          title || page
        end
jplang's avatar
jplang committed
394
      else
395
        all
jplang's avatar
jplang committed
396
      end
397
    end
398

399
    # Redmine links
400
    #
401 402 403 404 405
    # Examples:
    #   Issues:
    #     #52 -> Link to issue #52
    #   Changesets:
    #     r52 -> Link to revision 52
406
    #     commit:a85130f -> Link to scmid starting with a85130f
407 408 409 410 411 412 413 414 415 416
    #   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
417 418 419 420 421 422
    #   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
423 424 425
    #  Forum messages:
    #     message#1218 -> Link to message with id 1218
    text = text.gsub(%r{([\s\(,\-\>]|^)(!)?(attachment|document|version|commit|source|export|message)?((#|r)(\d+)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]]\W)|\s|<|$)}) do |m|
426
      leading, esc, prefix, sep, oid = $1, $2, $3, $5 || $7, $6 || $8
427
      link = nil
428 429 430
      if esc.nil?
        if prefix.nil? && sep == 'r'
          if project && (changeset = project.changesets.find_by_revision(oid))
431
            link = link_to("r#{oid}", {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => oid},
jplang's avatar
jplang committed
432
                                      :class => 'changeset',
433
                                      :title => truncate_single_line(changeset.comments, 100))
434 435 436 437 438
          end
        elsif sep == '#'
          oid = oid.to_i
          case prefix
          when nil
439
            if issue = Issue.find_by_id(oid, :include => [:project, :status], :conditions => Project.visible_by(User.current))
jplang's avatar
jplang committed
440
              link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid},
441
                                        :class => (issue.closed? ? 'issue closed' : 'issue'),
442 443 444 445 446
                                        :title => "#{truncate(issue.subject, 100)} (#{issue.status.name})")
              link = content_tag('del', link) if issue.closed?
            end
          when 'document'
            if document = Document.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current))
jplang's avatar
jplang committed
447 448
              link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
                                                :class => 'document'
449 450 451
            end
          when 'version'
            if version = Version.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current))
jplang's avatar
jplang committed
452 453
              link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
                                              :class => 'version'
454
            end
455 456 457 458 459 460 461 462 463 464
          when 'message'
            if message = Message.find_by_id(oid, :include => [:parent, {:board => :project}], :conditions => Project.visible_by(User.current))
              link = link_to h(truncate(message.subject, 60)), {:only_path => only_path,
                                                                :controller => 'messages',
                                                                :action => 'show',
                                                                :board_id => message.board,
                                                                :id => message.root,
                                                                :anchor => (message.parent ? "message-#{message.id}" : nil)},
                                                 :class => 'message'
            end
465 466 467 468 469 470 471
          end
        elsif sep == ':'
          # removes the double quotes if any
          name = oid.gsub(%r{^"(.*)"$}, "\\1")
          case prefix
          when 'document'
            if project && document = project.documents.find_by_title(name)
jplang's avatar
jplang committed
472 473
              link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
                                                :class => 'document'
474 475 476
            end
          when 'version'
            if project && version = project.versions.find_by_name(name)
jplang's avatar
jplang committed
477 478
              link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
                                              :class => 'version'
479
            end
480 481
          when 'commit'
            if project && (changeset = project.changesets.find(:first, :conditions => ["scmid LIKE ?", "#{name}%"]))
482 483 484
              link = link_to h("#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.revision},
                                           :class => 'changeset',
                                           :title => truncate_single_line(changeset.comments, 100)
485 486 487 488 489
            end
          when 'source', 'export'
            if project && project.repository
              name =~ %r{^[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?$}
              path, rev, anchor = $1, $3, $5
jplang's avatar
jplang committed
490 491
              link = link_to h("#{prefix}:#{name}"), {:controller => 'repositories', :action => 'entry', :id => project,
                                                      :path => to_path_param(path),
492 493 494 495
                                                      :rev => rev,
                                                      :anchor => anchor,
                                                      :format => (prefix == 'export' ? 'raw' : nil)},
                                                     :class => (prefix == 'export' ? 'source download' : 'source')
496
            end
497 498
          when 'attachment'
            if attachments && attachment = attachments.detect {|a| a.filename == name }
jplang's avatar
jplang committed
499 500
              link = link_to h(attachment.filename), {:only_path => only_path, :controller => 'attachments', :action => 'download', :id => attachment},
                                                     :class => 'attachment'
501 502
            end
          end
jplang's avatar
jplang committed
503
        end
504
      end
505
      leading + (link || "#{prefix}#{sep}#{oid}")
506
    end
507

508
    text
509
  end
510

jplang's avatar
jplang committed
511 512 513 514 515 516 517
  # Same as Rails' simple_format helper without using paragraphs
  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
  end
518

519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
  def error_messages_for(object_name, options = {})
    options = options.symbolize_keys
    object = instance_variable_get("@#{object_name}")
    if object && !object.errors.empty?
      # build full_messages here with controller current language
      full_messages = []
      object.errors.each do |attr, msg|
        next if msg.nil?
        msg = msg.first if msg.is_a? Array
        if attr == "base"
          full_messages << l(msg)
        else
          full_messages << "&#171; " + (l_has_string?("field_" + attr) ? l("field_" + attr) : object.class.human_attribute_name(attr)) + " &#187; " + l(msg) unless attr == "custom_values"
        end
      end
      # retrieve custom values error messages
      if object.errors[:custom_values]
536
        object.custom_values.each do |v|
537 538 539 540 541 542
          v.errors.each do |attr, msg|
            next if msg.nil?
            msg = msg.first if msg.is_a? Array
            full_messages << "&#171; " + v.custom_field.name + " &#187; " + l(msg)
          end
        end
543
      end
544 545
      content_tag("div",
        content_tag(
546
          options[:header_tag] || "span", lwr(:gui_validation_error, full_messages.length) + ":"
547 548 549 550 551 552 553 554
        ) +
        content_tag("ul", full_messages.collect { |msg| content_tag("li", msg) }),
        "id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation"
      )
    else
      ""
    end
  end
555

556
  def lang_options_for_select(blank=true)
557
    (blank ? [["(auto)", ""]] : []) +
558
      GLoc.valid_languages.collect{|lang| [ ll(lang.to_s, :general_lang_name), lang.to_s]}.sort{|x,y| x.last <=> y.last }
559
  end
560

561 562 563 564
  def label_tag_for(name, option_tags = nil, options = {})
    label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (options.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "")
    content_tag("label", label_text)
  end
565

566 567
  def labelled_tabular_form_for(name, object, options, &proc)
    options[:html] ||= {}
568
    options[:html][:class] = 'tabular' unless options[:html].has_key?(:class)
569 570
    form_for(name, object, options.merge({ :builder => TabularFormBuilder, :lang => current_language}), &proc)
  end
571

572
  def back_url_hidden_field_tag
573
    back_url = params[:back_url] || request.env['HTTP_REFERER']
574
    back_url = CGI.unescape(back_url.to_s)
575
    hidden_field_tag('back_url', CGI.escape(back_url)) unless back_url.blank?
576
  end
577

578 579 580
  def check_all_links(form_name)
    link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
    " | " +
581
    link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)")
582
  end
583

584 585 586 587
  def progress_bar(pcts, options={})
    pcts = [pcts, pcts] unless pcts.is_a?(Array)
    pcts[1] = pcts[1] - pcts[0]
    pcts << (100 - pcts[1] - pcts[0])
588 589 590 591
    width = options[:width] || '100px;'
    legend = options[:legend] || ''
    content_tag('table',
      content_tag('tr',
592 593 594
        (pcts[0] > 0 ? content_tag('td', '', :style => "width: #{pcts[0].floor}%;", :class => 'closed') : '') +
        (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1].floor}%;", :class => 'done') : '') +
        (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2].floor}%;", :class => 'todo') : '')
595 596 597
      ), :class => 'progress', :style => "width: #{width};") +
      content_tag('p', legend, :class => 'pourcent')
  end
598

599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
  def context_menu_link(name, url, options={})
    options[:class] ||= ''
    if options.delete(:selected)
      options[:class] << ' icon-checked disabled'
      options[:disabled] = true
    end
    if options.delete(:disabled)
      options.delete(:method)
      options.delete(:confirm)
      options.delete(:onclick)
      options[:class] << ' disabled'
      url = '#'
    end
    link_to name, url, options
  end
614

615
  def calendar_for(field_id)
616
    include_calendar_headers_tags
617 618 619
    image_tag("calendar.png", {:id => "#{field_id}_trigger",:class => "calendar-trigger"}) +
    javascript_tag("Calendar.setup({inputField : '#{field_id}', ifFormat : '%Y-%m-%d', button : '#{field_id}_trigger' });")
  end
620 621 622 623 624 625 626 627 628 629 630 631

  def include_calendar_headers_tags
    unless @calendar_headers_tags_included
      @calendar_headers_tags_included = true
      content_for :header_tags do
        javascript_include_tag('calendar/calendar') +
        javascript_include_tag("calendar/lang/calendar-#{current_language}.js") +
        javascript_include_tag('calendar/calendar-setup') +
        stylesheet_link_tag('calendar')
      end
    end
  end
632

jplang's avatar
jplang committed
633 634 635 636 637
  def content_for(name, content = nil, &block)
    @has_content ||= {}
    @has_content[name] = true
    super(name, content, &block)
  end
638

jplang's avatar
jplang committed
639 640 641
  def has_content?(name)
    (@has_content && @has_content[name]) || false
  end
642

643 644 645
  # 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>')
  def avatar(user, options = { })
646
    if Setting.gravatar_enabled?
647 648 649 650 651 652 653
      email = nil
      if user.respond_to?(:mail)
        email = user.mail
      elsif user.to_s =~ %r{<(.+?)>}
        email = $1
      end
      return gravatar(email.to_s.downcase, options) unless email.blank? rescue nil
654 655 656
    end
  end

657
  private
658

659 660 661 662 663
  def wiki_helper
    helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)
    extend helper
    return self
  end
664 665 666 667 668 669 670 671
  
  def link_to_remote_content_update(text, url_params)
    link_to_remote(text,
      {:url => url_params, :method => :get, :update => 'content', :complete => 'window.scrollTo(0,0)'},
      {:href => url_for(:params => url_params)}
    )
  end
  
jplang's avatar
jplang committed
672
end