annotate .svn/pristine/fb/fb44c6e118ba1da9fa2fdfb5c015150a0c9a67d4.svn-base @ 1298:4f746d8966dd redmine_2.3_integration

Merge from redmine-2.3 branch to create new branch redmine-2.3-integration
author Chris Cannam
date Fri, 14 Jun 2013 09:28:30 +0100
parents 622f24f53b42
children
rev   line source
Chris@1295 1 # encoding: utf-8
Chris@1295 2 #
Chris@1295 3 # Redmine - project management software
Chris@1295 4 # Copyright (C) 2006-2013 Jean-Philippe Lang
Chris@1295 5 #
Chris@1295 6 # This program is free software; you can redistribute it and/or
Chris@1295 7 # modify it under the terms of the GNU General Public License
Chris@1295 8 # as published by the Free Software Foundation; either version 2
Chris@1295 9 # of the License, or (at your option) any later version.
Chris@1295 10 #
Chris@1295 11 # This program is distributed in the hope that it will be useful,
Chris@1295 12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1295 13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@1295 14 # GNU General Public License for more details.
Chris@1295 15 #
Chris@1295 16 # You should have received a copy of the GNU General Public License
Chris@1295 17 # along with this program; if not, write to the Free Software
Chris@1295 18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@1295 19
Chris@1295 20 require 'forwardable'
Chris@1295 21 require 'cgi'
Chris@1295 22
Chris@1295 23 module ApplicationHelper
Chris@1295 24 include Redmine::WikiFormatting::Macros::Definitions
Chris@1295 25 include Redmine::I18n
Chris@1295 26 include GravatarHelper::PublicMethods
Chris@1295 27 include Redmine::Pagination::Helper
Chris@1295 28
Chris@1295 29 extend Forwardable
Chris@1295 30 def_delegators :wiki_helper, :wikitoolbar_for, :heads_for_wiki_formatter
Chris@1295 31
Chris@1295 32 # Return true if user is authorized for controller/action, otherwise false
Chris@1295 33 def authorize_for(controller, action)
Chris@1295 34 User.current.allowed_to?({:controller => controller, :action => action}, @project)
Chris@1295 35 end
Chris@1295 36
Chris@1295 37 # Display a link if user is authorized
Chris@1295 38 #
Chris@1295 39 # @param [String] name Anchor text (passed to link_to)
Chris@1295 40 # @param [Hash] options Hash params. This will checked by authorize_for to see if the user is authorized
Chris@1295 41 # @param [optional, Hash] html_options Options passed to link_to
Chris@1295 42 # @param [optional, Hash] parameters_for_method_reference Extra parameters for link_to
Chris@1295 43 def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
Chris@1295 44 link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])
Chris@1295 45 end
Chris@1295 46
Chris@1295 47 # Displays a link to user's account page if active
Chris@1295 48 def link_to_user(user, options={})
Chris@1295 49 if user.is_a?(User)
Chris@1295 50 name = h(user.name(options[:format]))
Chris@1295 51 if user.active? || (User.current.admin? && user.logged?)
Chris@1295 52 link_to name, user_path(user), :class => user.css_classes
Chris@1295 53 else
Chris@1295 54 name
Chris@1295 55 end
Chris@1295 56 else
Chris@1295 57 h(user.to_s)
Chris@1295 58 end
Chris@1295 59 end
Chris@1295 60
Chris@1295 61 # Displays a link to +issue+ with its subject.
Chris@1295 62 # Examples:
Chris@1295 63 #
Chris@1295 64 # link_to_issue(issue) # => Defect #6: This is the subject
Chris@1295 65 # link_to_issue(issue, :truncate => 6) # => Defect #6: This i...
Chris@1295 66 # link_to_issue(issue, :subject => false) # => Defect #6
Chris@1295 67 # link_to_issue(issue, :project => true) # => Foo - Defect #6
Chris@1295 68 # link_to_issue(issue, :subject => false, :tracker => false) # => #6
Chris@1295 69 #
Chris@1295 70 def link_to_issue(issue, options={})
Chris@1295 71 title = nil
Chris@1295 72 subject = nil
Chris@1295 73 text = options[:tracker] == false ? "##{issue.id}" : "#{issue.tracker} ##{issue.id}"
Chris@1295 74 if options[:subject] == false
Chris@1295 75 title = truncate(issue.subject, :length => 60)
Chris@1295 76 else
Chris@1295 77 subject = issue.subject
Chris@1295 78 if options[:truncate]
Chris@1295 79 subject = truncate(subject, :length => options[:truncate])
Chris@1295 80 end
Chris@1295 81 end
Chris@1295 82 s = link_to text, issue_path(issue), :class => issue.css_classes, :title => title
Chris@1295 83 s << h(": #{subject}") if subject
Chris@1295 84 s = h("#{issue.project} - ") + s if options[:project]
Chris@1295 85 s
Chris@1295 86 end
Chris@1295 87
Chris@1295 88 # Generates a link to an attachment.
Chris@1295 89 # Options:
Chris@1295 90 # * :text - Link text (default to attachment filename)
Chris@1295 91 # * :download - Force download (default: false)
Chris@1295 92 def link_to_attachment(attachment, options={})
Chris@1295 93 text = options.delete(:text) || attachment.filename
Chris@1295 94 route_method = options.delete(:download) ? :download_named_attachment_path : :named_attachment_path
Chris@1295 95 html_options = options.slice!(:only_path)
Chris@1295 96 url = send(route_method, attachment, attachment.filename, options)
Chris@1295 97 link_to text, url, html_options
Chris@1295 98 end
Chris@1295 99
Chris@1295 100 # Generates a link to a SCM revision
Chris@1295 101 # Options:
Chris@1295 102 # * :text - Link text (default to the formatted revision)
Chris@1295 103 def link_to_revision(revision, repository, options={})
Chris@1295 104 if repository.is_a?(Project)
Chris@1295 105 repository = repository.repository
Chris@1295 106 end
Chris@1295 107 text = options.delete(:text) || format_revision(revision)
Chris@1295 108 rev = revision.respond_to?(:identifier) ? revision.identifier : revision
Chris@1295 109 link_to(
Chris@1295 110 h(text),
Chris@1295 111 {:controller => 'repositories', :action => 'revision', :id => repository.project, :repository_id => repository.identifier_param, :rev => rev},
Chris@1295 112 :title => l(:label_revision_id, format_revision(revision))
Chris@1295 113 )
Chris@1295 114 end
Chris@1295 115
Chris@1295 116 # Generates a link to a message
Chris@1295 117 def link_to_message(message, options={}, html_options = nil)
Chris@1295 118 link_to(
Chris@1295 119 truncate(message.subject, :length => 60),
Chris@1295 120 board_message_path(message.board_id, message.parent_id || message.id, {
Chris@1295 121 :r => (message.parent_id && message.id),
Chris@1295 122 :anchor => (message.parent_id ? "message-#{message.id}" : nil)
Chris@1295 123 }.merge(options)),
Chris@1295 124 html_options
Chris@1295 125 )
Chris@1295 126 end
Chris@1295 127
Chris@1295 128 # Generates a link to a project if active
Chris@1295 129 # Examples:
Chris@1295 130 #
Chris@1295 131 # link_to_project(project) # => link to the specified project overview
Chris@1295 132 # link_to_project(project, {:only_path => false}, :class => "project") # => 3rd arg adds html options
Chris@1295 133 # link_to_project(project, {}, :class => "project") # => html options with default url (project overview)
Chris@1295 134 #
Chris@1295 135 def link_to_project(project, options={}, html_options = nil)
Chris@1295 136 if project.archived?
Chris@1295 137 h(project.name)
Chris@1295 138 elsif options.key?(:action)
Chris@1295 139 ActiveSupport::Deprecation.warn "#link_to_project with :action option is deprecated and will be removed in Redmine 3.0."
Chris@1295 140 url = {:controller => 'projects', :action => 'show', :id => project}.merge(options)
Chris@1295 141 link_to project.name, url, html_options
Chris@1295 142 else
Chris@1295 143 link_to project.name, project_path(project, options), html_options
Chris@1295 144 end
Chris@1295 145 end
Chris@1295 146
Chris@1295 147 # Generates a link to a project settings if active
Chris@1295 148 def link_to_project_settings(project, options={}, html_options=nil)
Chris@1295 149 if project.active?
Chris@1295 150 link_to project.name, settings_project_path(project, options), html_options
Chris@1295 151 elsif project.archived?
Chris@1295 152 h(project.name)
Chris@1295 153 else
Chris@1295 154 link_to project.name, project_path(project, options), html_options
Chris@1295 155 end
Chris@1295 156 end
Chris@1295 157
Chris@1295 158 def wiki_page_path(page, options={})
Chris@1295 159 url_for({:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title}.merge(options))
Chris@1295 160 end
Chris@1295 161
Chris@1295 162 def thumbnail_tag(attachment)
Chris@1295 163 link_to image_tag(thumbnail_path(attachment)),
Chris@1295 164 named_attachment_path(attachment, attachment.filename),
Chris@1295 165 :title => attachment.filename
Chris@1295 166 end
Chris@1295 167
Chris@1295 168 def toggle_link(name, id, options={})
Chris@1295 169 onclick = "$('##{id}').toggle(); "
Chris@1295 170 onclick << (options[:focus] ? "$('##{options[:focus]}').focus(); " : "this.blur(); ")
Chris@1295 171 onclick << "return false;"
Chris@1295 172 link_to(name, "#", :onclick => onclick)
Chris@1295 173 end
Chris@1295 174
Chris@1295 175 def image_to_function(name, function, html_options = {})
Chris@1295 176 html_options.symbolize_keys!
Chris@1295 177 tag(:input, html_options.merge({
Chris@1295 178 :type => "image", :src => image_path(name),
Chris@1295 179 :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};"
Chris@1295 180 }))
Chris@1295 181 end
Chris@1295 182
Chris@1295 183 def format_activity_title(text)
Chris@1295 184 h(truncate_single_line(text, :length => 100))
Chris@1295 185 end
Chris@1295 186
Chris@1295 187 def format_activity_day(date)
Chris@1295 188 date == User.current.today ? l(:label_today).titleize : format_date(date)
Chris@1295 189 end
Chris@1295 190
Chris@1295 191 def format_activity_description(text)
Chris@1295 192 h(truncate(text.to_s, :length => 120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')
Chris@1295 193 ).gsub(/[\r\n]+/, "<br />").html_safe
Chris@1295 194 end
Chris@1295 195
Chris@1295 196 def format_version_name(version)
Chris@1295 197 if version.project == @project
Chris@1295 198 h(version)
Chris@1295 199 else
Chris@1295 200 h("#{version.project} - #{version}")
Chris@1295 201 end
Chris@1295 202 end
Chris@1295 203
Chris@1295 204 def due_date_distance_in_words(date)
Chris@1295 205 if date
Chris@1295 206 l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date))
Chris@1295 207 end
Chris@1295 208 end
Chris@1295 209
Chris@1295 210 # Renders a tree of projects as a nested set of unordered lists
Chris@1295 211 # The given collection may be a subset of the whole project tree
Chris@1295 212 # (eg. some intermediate nodes are private and can not be seen)
Chris@1295 213 def render_project_nested_lists(projects)
Chris@1295 214 s = ''
Chris@1295 215 if projects.any?
Chris@1295 216 ancestors = []
Chris@1295 217 original_project = @project
Chris@1295 218 projects.sort_by(&:lft).each do |project|
Chris@1295 219 # set the project environment to please macros.
Chris@1295 220 @project = project
Chris@1295 221 if (ancestors.empty? || project.is_descendant_of?(ancestors.last))
Chris@1295 222 s << "<ul class='projects #{ ancestors.empty? ? 'root' : nil}'>\n"
Chris@1295 223 else
Chris@1295 224 ancestors.pop
Chris@1295 225 s << "</li>"
Chris@1295 226 while (ancestors.any? && !project.is_descendant_of?(ancestors.last))
Chris@1295 227 ancestors.pop
Chris@1295 228 s << "</ul></li>\n"
Chris@1295 229 end
Chris@1295 230 end
Chris@1295 231 classes = (ancestors.empty? ? 'root' : 'child')
Chris@1295 232 s << "<li class='#{classes}'><div class='#{classes}'>"
Chris@1295 233 s << h(block_given? ? yield(project) : project.name)
Chris@1295 234 s << "</div>\n"
Chris@1295 235 ancestors << project
Chris@1295 236 end
Chris@1295 237 s << ("</li></ul>\n" * ancestors.size)
Chris@1295 238 @project = original_project
Chris@1295 239 end
Chris@1295 240 s.html_safe
Chris@1295 241 end
Chris@1295 242
Chris@1295 243 def render_page_hierarchy(pages, node=nil, options={})
Chris@1295 244 content = ''
Chris@1295 245 if pages[node]
Chris@1295 246 content << "<ul class=\"pages-hierarchy\">\n"
Chris@1295 247 pages[node].each do |page|
Chris@1295 248 content << "<li>"
Chris@1295 249 content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title, :version => nil},
Chris@1295 250 :title => (options[:timestamp] && page.updated_on ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil))
Chris@1295 251 content << "\n" + render_page_hierarchy(pages, page.id, options) if pages[page.id]
Chris@1295 252 content << "</li>\n"
Chris@1295 253 end
Chris@1295 254 content << "</ul>\n"
Chris@1295 255 end
Chris@1295 256 content.html_safe
Chris@1295 257 end
Chris@1295 258
Chris@1295 259 # Renders flash messages
Chris@1295 260 def render_flash_messages
Chris@1295 261 s = ''
Chris@1295 262 flash.each do |k,v|
Chris@1295 263 s << content_tag('div', v.html_safe, :class => "flash #{k}", :id => "flash_#{k}")
Chris@1295 264 end
Chris@1295 265 s.html_safe
Chris@1295 266 end
Chris@1295 267
Chris@1295 268 # Renders tabs and their content
Chris@1295 269 def render_tabs(tabs)
Chris@1295 270 if tabs.any?
Chris@1295 271 render :partial => 'common/tabs', :locals => {:tabs => tabs}
Chris@1295 272 else
Chris@1295 273 content_tag 'p', l(:label_no_data), :class => "nodata"
Chris@1295 274 end
Chris@1295 275 end
Chris@1295 276
Chris@1295 277 # Renders the project quick-jump box
Chris@1295 278 def render_project_jump_box
Chris@1295 279 return unless User.current.logged?
Chris@1295 280 projects = User.current.memberships.collect(&:project).compact.select(&:active?).uniq
Chris@1295 281 if projects.any?
Chris@1295 282 options =
Chris@1295 283 ("<option value=''>#{ l(:label_jump_to_a_project) }</option>" +
Chris@1295 284 '<option value="" disabled="disabled">---</option>').html_safe
Chris@1295 285
Chris@1295 286 options << project_tree_options_for_select(projects, :selected => @project) do |p|
Chris@1295 287 { :value => project_path(:id => p, :jump => current_menu_item) }
Chris@1295 288 end
Chris@1295 289
Chris@1295 290 select_tag('project_quick_jump_box', options, :onchange => 'if (this.value != \'\') { window.location = this.value; }')
Chris@1295 291 end
Chris@1295 292 end
Chris@1295 293
Chris@1295 294 def project_tree_options_for_select(projects, options = {})
Chris@1295 295 s = ''
Chris@1295 296 project_tree(projects) do |project, level|
Chris@1295 297 name_prefix = (level > 0 ? '&nbsp;' * 2 * level + '&#187; ' : '').html_safe
Chris@1295 298 tag_options = {:value => project.id}
Chris@1295 299 if project == options[:selected] || (options[:selected].respond_to?(:include?) && options[:selected].include?(project))
Chris@1295 300 tag_options[:selected] = 'selected'
Chris@1295 301 else
Chris@1295 302 tag_options[:selected] = nil
Chris@1295 303 end
Chris@1295 304 tag_options.merge!(yield(project)) if block_given?
Chris@1295 305 s << content_tag('option', name_prefix + h(project), tag_options)
Chris@1295 306 end
Chris@1295 307 s.html_safe
Chris@1295 308 end
Chris@1295 309
Chris@1295 310 # Yields the given block for each project with its level in the tree
Chris@1295 311 #
Chris@1295 312 # Wrapper for Project#project_tree
Chris@1295 313 def project_tree(projects, &block)
Chris@1295 314 Project.project_tree(projects, &block)
Chris@1295 315 end
Chris@1295 316
Chris@1295 317 def principals_check_box_tags(name, principals)
Chris@1295 318 s = ''
Chris@1295 319 principals.each do |principal|
Chris@1295 320 s << "<label>#{ check_box_tag name, principal.id, false, :id => nil } #{h principal}</label>\n"
Chris@1295 321 end
Chris@1295 322 s.html_safe
Chris@1295 323 end
Chris@1295 324
Chris@1295 325 # Returns a string for users/groups option tags
Chris@1295 326 def principals_options_for_select(collection, selected=nil)
Chris@1295 327 s = ''
Chris@1295 328 if collection.include?(User.current)
Chris@1295 329 s << content_tag('option', "<< #{l(:label_me)} >>", :value => User.current.id)
Chris@1295 330 end
Chris@1295 331 groups = ''
Chris@1295 332 collection.sort.each do |element|
Chris@1295 333 selected_attribute = ' selected="selected"' if option_value_selected?(element, selected)
Chris@1295 334 (element.is_a?(Group) ? groups : s) << %(<option value="#{element.id}"#{selected_attribute}>#{h element.name}</option>)
Chris@1295 335 end
Chris@1295 336 unless groups.empty?
Chris@1295 337 s << %(<optgroup label="#{h(l(:label_group_plural))}">#{groups}</optgroup>)
Chris@1295 338 end
Chris@1295 339 s.html_safe
Chris@1295 340 end
Chris@1295 341
Chris@1295 342 # Options for the new membership projects combo-box
Chris@1295 343 def options_for_membership_project_select(principal, projects)
Chris@1295 344 options = content_tag('option', "--- #{l(:actionview_instancetag_blank_option)} ---")
Chris@1295 345 options << project_tree_options_for_select(projects) do |p|
Chris@1295 346 {:disabled => principal.projects.to_a.include?(p)}
Chris@1295 347 end
Chris@1295 348 options
Chris@1295 349 end
Chris@1295 350
Chris@1295 351 # Truncates and returns the string as a single line
Chris@1295 352 def truncate_single_line(string, *args)
Chris@1295 353 truncate(string.to_s, *args).gsub(%r{[\r\n]+}m, ' ')
Chris@1295 354 end
Chris@1295 355
Chris@1295 356 # Truncates at line break after 250 characters or options[:length]
Chris@1295 357 def truncate_lines(string, options={})
Chris@1295 358 length = options[:length] || 250
Chris@1295 359 if string.to_s =~ /\A(.{#{length}}.*?)$/m
Chris@1295 360 "#{$1}..."
Chris@1295 361 else
Chris@1295 362 string
Chris@1295 363 end
Chris@1295 364 end
Chris@1295 365
Chris@1295 366 def anchor(text)
Chris@1295 367 text.to_s.gsub(' ', '_')
Chris@1295 368 end
Chris@1295 369
Chris@1295 370 def html_hours(text)
Chris@1295 371 text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>').html_safe
Chris@1295 372 end
Chris@1295 373
Chris@1295 374 def authoring(created, author, options={})
Chris@1295 375 l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe
Chris@1295 376 end
Chris@1295 377
Chris@1295 378 def time_tag(time)
Chris@1295 379 text = distance_of_time_in_words(Time.now, time)
Chris@1295 380 if @project
Chris@1295 381 link_to(text, {:controller => 'activities', :action => 'index', :id => @project, :from => User.current.time_to_date(time)}, :title => format_time(time))
Chris@1295 382 else
Chris@1295 383 content_tag('acronym', text, :title => format_time(time))
Chris@1295 384 end
Chris@1295 385 end
Chris@1295 386
Chris@1295 387 def syntax_highlight_lines(name, content)
Chris@1295 388 lines = []
Chris@1295 389 syntax_highlight(name, content).each_line { |line| lines << line }
Chris@1295 390 lines
Chris@1295 391 end
Chris@1295 392
Chris@1295 393 def syntax_highlight(name, content)
Chris@1295 394 Redmine::SyntaxHighlighting.highlight_by_filename(content, name)
Chris@1295 395 end
Chris@1295 396
Chris@1295 397 def to_path_param(path)
Chris@1295 398 str = path.to_s.split(%r{[/\\]}).select{|p| !p.blank?}.join("/")
Chris@1295 399 str.blank? ? nil : str
Chris@1295 400 end
Chris@1295 401
Chris@1295 402 def reorder_links(name, url, method = :post)
Chris@1295 403 link_to(image_tag('2uparrow.png', :alt => l(:label_sort_highest)),
Chris@1295 404 url.merge({"#{name}[move_to]" => 'highest'}),
Chris@1295 405 :method => method, :title => l(:label_sort_highest)) +
Chris@1295 406 link_to(image_tag('1uparrow.png', :alt => l(:label_sort_higher)),
Chris@1295 407 url.merge({"#{name}[move_to]" => 'higher'}),
Chris@1295 408 :method => method, :title => l(:label_sort_higher)) +
Chris@1295 409 link_to(image_tag('1downarrow.png', :alt => l(:label_sort_lower)),
Chris@1295 410 url.merge({"#{name}[move_to]" => 'lower'}),
Chris@1295 411 :method => method, :title => l(:label_sort_lower)) +
Chris@1295 412 link_to(image_tag('2downarrow.png', :alt => l(:label_sort_lowest)),
Chris@1295 413 url.merge({"#{name}[move_to]" => 'lowest'}),
Chris@1295 414 :method => method, :title => l(:label_sort_lowest))
Chris@1295 415 end
Chris@1295 416
Chris@1295 417 def breadcrumb(*args)
Chris@1295 418 elements = args.flatten
Chris@1295 419 elements.any? ? content_tag('p', (args.join(" \xc2\xbb ") + " \xc2\xbb ").html_safe, :class => 'breadcrumb') : nil
Chris@1295 420 end
Chris@1295 421
Chris@1295 422 def other_formats_links(&block)
Chris@1295 423 concat('<p class="other-formats">'.html_safe + l(:label_export_to))
Chris@1295 424 yield Redmine::Views::OtherFormatsBuilder.new(self)
Chris@1295 425 concat('</p>'.html_safe)
Chris@1295 426 end
Chris@1295 427
Chris@1295 428 def page_header_title
Chris@1295 429 if @project.nil? || @project.new_record?
Chris@1295 430 h(Setting.app_title)
Chris@1295 431 else
Chris@1295 432 b = []
Chris@1295 433 ancestors = (@project.root? ? [] : @project.ancestors.visible.all)
Chris@1295 434 if ancestors.any?
Chris@1295 435 root = ancestors.shift
Chris@1295 436 b << link_to_project(root, {:jump => current_menu_item}, :class => 'root')
Chris@1295 437 if ancestors.size > 2
Chris@1295 438 b << "\xe2\x80\xa6"
Chris@1295 439 ancestors = ancestors[-2, 2]
Chris@1295 440 end
Chris@1295 441 b += ancestors.collect {|p| link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor') }
Chris@1295 442 end
Chris@1295 443 b << h(@project)
Chris@1295 444 b.join(" \xc2\xbb ").html_safe
Chris@1295 445 end
Chris@1295 446 end
Chris@1295 447
Chris@1295 448 def html_title(*args)
Chris@1295 449 if args.empty?
Chris@1295 450 title = @html_title || []
Chris@1295 451 title << @project.name if @project
Chris@1295 452 title << Setting.app_title unless Setting.app_title == title.last
Chris@1295 453 title.select {|t| !t.blank? }.join(' - ')
Chris@1295 454 else
Chris@1295 455 @html_title ||= []
Chris@1295 456 @html_title += args
Chris@1295 457 end
Chris@1295 458 end
Chris@1295 459
Chris@1295 460 # Returns the theme, controller name, and action as css classes for the
Chris@1295 461 # HTML body.
Chris@1295 462 def body_css_classes
Chris@1295 463 css = []
Chris@1295 464 if theme = Redmine::Themes.theme(Setting.ui_theme)
Chris@1295 465 css << 'theme-' + theme.name
Chris@1295 466 end
Chris@1295 467
Chris@1295 468 css << 'controller-' + controller_name
Chris@1295 469 css << 'action-' + action_name
Chris@1295 470 css.join(' ')
Chris@1295 471 end
Chris@1295 472
Chris@1295 473 def accesskey(s)
Chris@1295 474 @used_accesskeys ||= []
Chris@1295 475 key = Redmine::AccessKeys.key_for(s)
Chris@1295 476 return nil if @used_accesskeys.include?(key)
Chris@1295 477 @used_accesskeys << key
Chris@1295 478 key
Chris@1295 479 end
Chris@1295 480
Chris@1295 481 # Formats text according to system settings.
Chris@1295 482 # 2 ways to call this method:
Chris@1295 483 # * with a String: textilizable(text, options)
Chris@1295 484 # * with an object and one of its attribute: textilizable(issue, :description, options)
Chris@1295 485 def textilizable(*args)
Chris@1295 486 options = args.last.is_a?(Hash) ? args.pop : {}
Chris@1295 487 case args.size
Chris@1295 488 when 1
Chris@1295 489 obj = options[:object]
Chris@1295 490 text = args.shift
Chris@1295 491 when 2
Chris@1295 492 obj = args.shift
Chris@1295 493 attr = args.shift
Chris@1295 494 text = obj.send(attr).to_s
Chris@1295 495 else
Chris@1295 496 raise ArgumentError, 'invalid arguments to textilizable'
Chris@1295 497 end
Chris@1295 498 return '' if text.blank?
Chris@1295 499 project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)
Chris@1295 500 only_path = options.delete(:only_path) == false ? false : true
Chris@1295 501
Chris@1295 502 text = text.dup
Chris@1295 503 macros = catch_macros(text)
Chris@1295 504 text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text, :object => obj, :attribute => attr)
Chris@1295 505
Chris@1295 506 @parsed_headings = []
Chris@1295 507 @heading_anchors = {}
Chris@1295 508 @current_section = 0 if options[:edit_section_links]
Chris@1295 509
Chris@1295 510 parse_sections(text, project, obj, attr, only_path, options)
Chris@1295 511 text = parse_non_pre_blocks(text, obj, macros) do |text|
Chris@1295 512 [:parse_inline_attachments, :parse_wiki_links, :parse_redmine_links].each do |method_name|
Chris@1295 513 send method_name, text, project, obj, attr, only_path, options
Chris@1295 514 end
Chris@1295 515 end
Chris@1295 516 parse_headings(text, project, obj, attr, only_path, options)
Chris@1295 517
Chris@1295 518 if @parsed_headings.any?
Chris@1295 519 replace_toc(text, @parsed_headings)
Chris@1295 520 end
Chris@1295 521
Chris@1295 522 text.html_safe
Chris@1295 523 end
Chris@1295 524
Chris@1295 525 def parse_non_pre_blocks(text, obj, macros)
Chris@1295 526 s = StringScanner.new(text)
Chris@1295 527 tags = []
Chris@1295 528 parsed = ''
Chris@1295 529 while !s.eos?
Chris@1295 530 s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im)
Chris@1295 531 text, full_tag, closing, tag = s[1], s[2], s[3], s[4]
Chris@1295 532 if tags.empty?
Chris@1295 533 yield text
Chris@1295 534 inject_macros(text, obj, macros) if macros.any?
Chris@1295 535 else
Chris@1295 536 inject_macros(text, obj, macros, false) if macros.any?
Chris@1295 537 end
Chris@1295 538 parsed << text
Chris@1295 539 if tag
Chris@1295 540 if closing
Chris@1295 541 if tags.last == tag.downcase
Chris@1295 542 tags.pop
Chris@1295 543 end
Chris@1295 544 else
Chris@1295 545 tags << tag.downcase
Chris@1295 546 end
Chris@1295 547 parsed << full_tag
Chris@1295 548 end
Chris@1295 549 end
Chris@1295 550 # Close any non closing tags
Chris@1295 551 while tag = tags.pop
Chris@1295 552 parsed << "</#{tag}>"
Chris@1295 553 end
Chris@1295 554 parsed
Chris@1295 555 end
Chris@1295 556
Chris@1295 557 def parse_inline_attachments(text, project, obj, attr, only_path, options)
Chris@1295 558 # when using an image link, try to use an attachment, if possible
Chris@1295 559 attachments = options[:attachments] || []
Chris@1295 560 attachments += obj.attachments if obj.respond_to?(:attachments)
Chris@1295 561 if attachments.present?
Chris@1295 562 text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m|
Chris@1295 563 filename, ext, alt, alttext = $1.downcase, $2, $3, $4
Chris@1295 564 # search for the picture in attachments
Chris@1295 565 if found = Attachment.latest_attach(attachments, filename)
Chris@1295 566 image_url = download_named_attachment_path(found, found.filename, :only_path => only_path)
Chris@1295 567 desc = found.description.to_s.gsub('"', '')
Chris@1295 568 if !desc.blank? && alttext.blank?
Chris@1295 569 alt = " title=\"#{desc}\" alt=\"#{desc}\""
Chris@1295 570 end
Chris@1295 571 "src=\"#{image_url}\"#{alt}"
Chris@1295 572 else
Chris@1295 573 m
Chris@1295 574 end
Chris@1295 575 end
Chris@1295 576 end
Chris@1295 577 end
Chris@1295 578
Chris@1295 579 # Wiki links
Chris@1295 580 #
Chris@1295 581 # Examples:
Chris@1295 582 # [[mypage]]
Chris@1295 583 # [[mypage|mytext]]
Chris@1295 584 # wiki links can refer other project wikis, using project name or identifier:
Chris@1295 585 # [[project:]] -> wiki starting page
Chris@1295 586 # [[project:|mytext]]
Chris@1295 587 # [[project:mypage]]
Chris@1295 588 # [[project:mypage|mytext]]
Chris@1295 589 def parse_wiki_links(text, project, obj, attr, only_path, options)
Chris@1295 590 text.gsub!(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m|
Chris@1295 591 link_project = project
Chris@1295 592 esc, all, page, title = $1, $2, $3, $5
Chris@1295 593 if esc.nil?
Chris@1295 594 if page =~ /^([^\:]+)\:(.*)$/
Chris@1295 595 identifier, page = $1, $2
Chris@1295 596 link_project = Project.find_by_identifier(identifier) || Project.find_by_name(identifier)
Chris@1295 597 title ||= identifier if page.blank?
Chris@1295 598 end
Chris@1295 599
Chris@1295 600 if link_project && link_project.wiki
Chris@1295 601 # extract anchor
Chris@1295 602 anchor = nil
Chris@1295 603 if page =~ /^(.+?)\#(.+)$/
Chris@1295 604 page, anchor = $1, $2
Chris@1295 605 end
Chris@1295 606 anchor = sanitize_anchor_name(anchor) if anchor.present?
Chris@1295 607 # check if page exists
Chris@1295 608 wiki_page = link_project.wiki.find_page(page)
Chris@1295 609 url = if anchor.present? && wiki_page.present? && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)) && obj.page == wiki_page
Chris@1295 610 "##{anchor}"
Chris@1295 611 else
Chris@1295 612 case options[:wiki_links]
Chris@1295 613 when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')
Chris@1295 614 when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export
Chris@1295 615 else
Chris@1295 616 wiki_page_id = page.present? ? Wiki.titleize(page) : nil
Chris@1295 617 parent = wiki_page.nil? && obj.is_a?(WikiContent) && obj.page && project == link_project ? obj.page.title : nil
Chris@1295 618 url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project,
Chris@1295 619 :id => wiki_page_id, :version => nil, :anchor => anchor, :parent => parent)
Chris@1295 620 end
Chris@1295 621 end
Chris@1295 622 link_to(title.present? ? title.html_safe : h(page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new')))
Chris@1295 623 else
Chris@1295 624 # project or wiki doesn't exist
Chris@1295 625 all
Chris@1295 626 end
Chris@1295 627 else
Chris@1295 628 all
Chris@1295 629 end
Chris@1295 630 end
Chris@1295 631 end
Chris@1295 632
Chris@1295 633 # Redmine links
Chris@1295 634 #
Chris@1295 635 # Examples:
Chris@1295 636 # Issues:
Chris@1295 637 # #52 -> Link to issue #52
Chris@1295 638 # Changesets:
Chris@1295 639 # r52 -> Link to revision 52
Chris@1295 640 # commit:a85130f -> Link to scmid starting with a85130f
Chris@1295 641 # Documents:
Chris@1295 642 # document#17 -> Link to document with id 17
Chris@1295 643 # document:Greetings -> Link to the document with title "Greetings"
Chris@1295 644 # document:"Some document" -> Link to the document with title "Some document"
Chris@1295 645 # Versions:
Chris@1295 646 # version#3 -> Link to version with id 3
Chris@1295 647 # version:1.0.0 -> Link to version named "1.0.0"
Chris@1295 648 # version:"1.0 beta 2" -> Link to version named "1.0 beta 2"
Chris@1295 649 # Attachments:
Chris@1295 650 # attachment:file.zip -> Link to the attachment of the current object named file.zip
Chris@1295 651 # Source files:
Chris@1295 652 # source:some/file -> Link to the file located at /some/file in the project's repository
Chris@1295 653 # source:some/file@52 -> Link to the file's revision 52
Chris@1295 654 # source:some/file#L120 -> Link to line 120 of the file
Chris@1295 655 # source:some/file@52#L120 -> Link to line 120 of the file's revision 52
Chris@1295 656 # export:some/file -> Force the download of the file
Chris@1295 657 # Forum messages:
Chris@1295 658 # message#1218 -> Link to message with id 1218
Chris@1295 659 #
Chris@1295 660 # Links can refer other objects from other projects, using project identifier:
Chris@1295 661 # identifier:r52
Chris@1295 662 # identifier:document:"Some document"
Chris@1295 663 # identifier:version:1.0.0
Chris@1295 664 # identifier:source:some/file
Chris@1295 665 def parse_redmine_links(text, default_project, obj, attr, only_path, options)
Chris@1295 666 text.gsub!(%r{([\s\(,\-\[\>]|^)(!)?(([a-z0-9\-_]+):)?(attachment|document|version|forum|news|message|project|commit|source|export)?(((#)|((([a-z0-9\-_]+)\|)?(r)))((\d+)((#note)?-(\d+))?)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]][^A-Za-z0-9_/])|,|\s|\]|<|$)}) do |m|
Chris@1295 667 leading, esc, project_prefix, project_identifier, prefix, repo_prefix, repo_identifier, sep, identifier, comment_suffix, comment_id = $1, $2, $3, $4, $5, $10, $11, $8 || $12 || $18, $14 || $19, $15, $17
Chris@1295 668 link = nil
Chris@1295 669 project = default_project
Chris@1295 670 if project_identifier
Chris@1295 671 project = Project.visible.find_by_identifier(project_identifier)
Chris@1295 672 end
Chris@1295 673 if esc.nil?
Chris@1295 674 if prefix.nil? && sep == 'r'
Chris@1295 675 if project
Chris@1295 676 repository = nil
Chris@1295 677 if repo_identifier
Chris@1295 678 repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
Chris@1295 679 else
Chris@1295 680 repository = project.repository
Chris@1295 681 end
Chris@1295 682 # project.changesets.visible raises an SQL error because of a double join on repositories
Chris@1295 683 if repository && (changeset = Changeset.visible.find_by_repository_id_and_revision(repository.id, identifier))
Chris@1295 684 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},
Chris@1295 685 :class => 'changeset',
Chris@1295 686 :title => truncate_single_line(changeset.comments, :length => 100))
Chris@1295 687 end
Chris@1295 688 end
Chris@1295 689 elsif sep == '#'
Chris@1295 690 oid = identifier.to_i
Chris@1295 691 case prefix
Chris@1295 692 when nil
Chris@1295 693 if oid.to_s == identifier && issue = Issue.visible.find_by_id(oid, :include => :status)
Chris@1295 694 anchor = comment_id ? "note-#{comment_id}" : nil
Chris@1295 695 link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid, :anchor => anchor},
Chris@1295 696 :class => issue.css_classes,
Chris@1295 697 :title => "#{truncate(issue.subject, :length => 100)} (#{issue.status.name})")
Chris@1295 698 end
Chris@1295 699 when 'document'
Chris@1295 700 if document = Document.visible.find_by_id(oid)
Chris@1295 701 link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
Chris@1295 702 :class => 'document'
Chris@1295 703 end
Chris@1295 704 when 'version'
Chris@1295 705 if version = Version.visible.find_by_id(oid)
Chris@1295 706 link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
Chris@1295 707 :class => 'version'
Chris@1295 708 end
Chris@1295 709 when 'message'
Chris@1295 710 if message = Message.visible.find_by_id(oid, :include => :parent)
Chris@1295 711 link = link_to_message(message, {:only_path => only_path}, :class => 'message')
Chris@1295 712 end
Chris@1295 713 when 'forum'
Chris@1295 714 if board = Board.visible.find_by_id(oid)
Chris@1295 715 link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project},
Chris@1295 716 :class => 'board'
Chris@1295 717 end
Chris@1295 718 when 'news'
Chris@1295 719 if news = News.visible.find_by_id(oid)
Chris@1295 720 link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news},
Chris@1295 721 :class => 'news'
Chris@1295 722 end
Chris@1295 723 when 'project'
Chris@1295 724 if p = Project.visible.find_by_id(oid)
Chris@1295 725 link = link_to_project(p, {:only_path => only_path}, :class => 'project')
Chris@1295 726 end
Chris@1295 727 end
Chris@1295 728 elsif sep == ':'
Chris@1295 729 # removes the double quotes if any
Chris@1295 730 name = identifier.gsub(%r{^"(.*)"$}, "\\1")
Chris@1295 731 case prefix
Chris@1295 732 when 'document'
Chris@1295 733 if project && document = project.documents.visible.find_by_title(name)
Chris@1295 734 link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},
Chris@1295 735 :class => 'document'
Chris@1295 736 end
Chris@1295 737 when 'version'
Chris@1295 738 if project && version = project.versions.visible.find_by_name(name)
Chris@1295 739 link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},
Chris@1295 740 :class => 'version'
Chris@1295 741 end
Chris@1295 742 when 'forum'
Chris@1295 743 if project && board = project.boards.visible.find_by_name(name)
Chris@1295 744 link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project},
Chris@1295 745 :class => 'board'
Chris@1295 746 end
Chris@1295 747 when 'news'
Chris@1295 748 if project && news = project.news.visible.find_by_title(name)
Chris@1295 749 link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news},
Chris@1295 750 :class => 'news'
Chris@1295 751 end
Chris@1295 752 when 'commit', 'source', 'export'
Chris@1295 753 if project
Chris@1295 754 repository = nil
Chris@1295 755 if name =~ %r{^(([a-z0-9\-_]+)\|)(.+)$}
Chris@1295 756 repo_prefix, repo_identifier, name = $1, $2, $3
Chris@1295 757 repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}
Chris@1295 758 else
Chris@1295 759 repository = project.repository
Chris@1295 760 end
Chris@1295 761 if prefix == 'commit'
Chris@1295 762 if repository && (changeset = Changeset.visible.where("repository_id = ? AND scmid LIKE ?", repository.id, "#{name}%").first)
Chris@1295 763 link = link_to h("#{project_prefix}#{repo_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :repository_id => repository.identifier_param, :rev => changeset.identifier},
Chris@1295 764 :class => 'changeset',
Chris@1295 765 :title => truncate_single_line(changeset.comments, :length => 100)
Chris@1295 766 end
Chris@1295 767 else
Chris@1295 768 if repository && User.current.allowed_to?(:browse_repository, project)
Chris@1295 769 name =~ %r{^[/\\]*(.*?)(@([^/\\@]+?))?(#(L\d+))?$}
Chris@1295 770 path, rev, anchor = $1, $3, $5
Chris@1295 771 link = link_to h("#{project_prefix}#{prefix}:#{repo_prefix}#{name}"), {:controller => 'repositories', :action => (prefix == 'export' ? 'raw' : 'entry'), :id => project, :repository_id => repository.identifier_param,
Chris@1295 772 :path => to_path_param(path),
Chris@1295 773 :rev => rev,
Chris@1295 774 :anchor => anchor},
Chris@1295 775 :class => (prefix == 'export' ? 'source download' : 'source')
Chris@1295 776 end
Chris@1295 777 end
Chris@1295 778 repo_prefix = nil
Chris@1295 779 end
Chris@1295 780 when 'attachment'
Chris@1295 781 attachments = options[:attachments] || (obj && obj.respond_to?(:attachments) ? obj.attachments : nil)
Chris@1295 782 if attachments && attachment = Attachment.latest_attach(attachments, name)
Chris@1295 783 link = link_to_attachment(attachment, :only_path => only_path, :download => true, :class => 'attachment')
Chris@1295 784 end
Chris@1295 785 when 'project'
Chris@1295 786 if p = Project.visible.where("identifier = :s OR LOWER(name) = :s", :s => name.downcase).first
Chris@1295 787 link = link_to_project(p, {:only_path => only_path}, :class => 'project')
Chris@1295 788 end
Chris@1295 789 end
Chris@1295 790 end
Chris@1295 791 end
Chris@1295 792 (leading + (link || "#{project_prefix}#{prefix}#{repo_prefix}#{sep}#{identifier}#{comment_suffix}"))
Chris@1295 793 end
Chris@1295 794 end
Chris@1295 795
Chris@1295 796 HEADING_RE = /(<h(\d)( [^>]+)?>(.+?)<\/h(\d)>)/i unless const_defined?(:HEADING_RE)
Chris@1295 797
Chris@1295 798 def parse_sections(text, project, obj, attr, only_path, options)
Chris@1295 799 return unless options[:edit_section_links]
Chris@1295 800 text.gsub!(HEADING_RE) do
Chris@1295 801 heading = $1
Chris@1295 802 @current_section += 1
Chris@1295 803 if @current_section > 1
Chris@1295 804 content_tag('div',
Chris@1295 805 link_to(image_tag('edit.png'), options[:edit_section_links].merge(:section => @current_section)),
Chris@1295 806 :class => 'contextual',
Chris@1295 807 :title => l(:button_edit_section)) + heading.html_safe
Chris@1295 808 else
Chris@1295 809 heading
Chris@1295 810 end
Chris@1295 811 end
Chris@1295 812 end
Chris@1295 813
Chris@1295 814 # Headings and TOC
Chris@1295 815 # Adds ids and links to headings unless options[:headings] is set to false
Chris@1295 816 def parse_headings(text, project, obj, attr, only_path, options)
Chris@1295 817 return if options[:headings] == false
Chris@1295 818
Chris@1295 819 text.gsub!(HEADING_RE) do
Chris@1295 820 level, attrs, content = $2.to_i, $3, $4
Chris@1295 821 item = strip_tags(content).strip
Chris@1295 822 anchor = sanitize_anchor_name(item)
Chris@1295 823 # used for single-file wiki export
Chris@1295 824 anchor = "#{obj.page.title}_#{anchor}" if options[:wiki_links] == :anchor && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version))
Chris@1295 825 @heading_anchors[anchor] ||= 0
Chris@1295 826 idx = (@heading_anchors[anchor] += 1)
Chris@1295 827 if idx > 1
Chris@1295 828 anchor = "#{anchor}-#{idx}"
Chris@1295 829 end
Chris@1295 830 @parsed_headings << [level, anchor, item]
Chris@1295 831 "<a name=\"#{anchor}\"></a>\n<h#{level} #{attrs}>#{content}<a href=\"##{anchor}\" class=\"wiki-anchor\">&para;</a></h#{level}>"
Chris@1295 832 end
Chris@1295 833 end
Chris@1295 834
Chris@1295 835 MACROS_RE = /(
Chris@1295 836 (!)? # escaping
Chris@1295 837 (
Chris@1295 838 \{\{ # opening tag
Chris@1295 839 ([\w]+) # macro name
Chris@1295 840 (\(([^\n\r]*?)\))? # optional arguments
Chris@1295 841 ([\n\r].*?[\n\r])? # optional block of text
Chris@1295 842 \}\} # closing tag
Chris@1295 843 )
Chris@1295 844 )/mx unless const_defined?(:MACROS_RE)
Chris@1295 845
Chris@1295 846 MACRO_SUB_RE = /(
Chris@1295 847 \{\{
Chris@1295 848 macro\((\d+)\)
Chris@1295 849 \}\}
Chris@1295 850 )/x unless const_defined?(:MACRO_SUB_RE)
Chris@1295 851
Chris@1295 852 # Extracts macros from text
Chris@1295 853 def catch_macros(text)
Chris@1295 854 macros = {}
Chris@1295 855 text.gsub!(MACROS_RE) do
Chris@1295 856 all, macro = $1, $4.downcase
Chris@1295 857 if macro_exists?(macro) || all =~ MACRO_SUB_RE
Chris@1295 858 index = macros.size
Chris@1295 859 macros[index] = all
Chris@1295 860 "{{macro(#{index})}}"
Chris@1295 861 else
Chris@1295 862 all
Chris@1295 863 end
Chris@1295 864 end
Chris@1295 865 macros
Chris@1295 866 end
Chris@1295 867
Chris@1295 868 # Executes and replaces macros in text
Chris@1295 869 def inject_macros(text, obj, macros, execute=true)
Chris@1295 870 text.gsub!(MACRO_SUB_RE) do
Chris@1295 871 all, index = $1, $2.to_i
Chris@1295 872 orig = macros.delete(index)
Chris@1295 873 if execute && orig && orig =~ MACROS_RE
Chris@1295 874 esc, all, macro, args, block = $2, $3, $4.downcase, $6.to_s, $7.try(:strip)
Chris@1295 875 if esc.nil?
Chris@1295 876 h(exec_macro(macro, obj, args, block) || all)
Chris@1295 877 else
Chris@1295 878 h(all)
Chris@1295 879 end
Chris@1295 880 elsif orig
Chris@1295 881 h(orig)
Chris@1295 882 else
Chris@1295 883 h(all)
Chris@1295 884 end
Chris@1295 885 end
Chris@1295 886 end
Chris@1295 887
Chris@1295 888 TOC_RE = /<p>\{\{([<>]?)toc\}\}<\/p>/i unless const_defined?(:TOC_RE)
Chris@1295 889
Chris@1295 890 # Renders the TOC with given headings
Chris@1295 891 def replace_toc(text, headings)
Chris@1295 892 text.gsub!(TOC_RE) do
Chris@1295 893 # Keep only the 4 first levels
Chris@1295 894 headings = headings.select{|level, anchor, item| level <= 4}
Chris@1295 895 if headings.empty?
Chris@1295 896 ''
Chris@1295 897 else
Chris@1295 898 div_class = 'toc'
Chris@1295 899 div_class << ' right' if $1 == '>'
Chris@1295 900 div_class << ' left' if $1 == '<'
Chris@1295 901 out = "<ul class=\"#{div_class}\"><li>"
Chris@1295 902 root = headings.map(&:first).min
Chris@1295 903 current = root
Chris@1295 904 started = false
Chris@1295 905 headings.each do |level, anchor, item|
Chris@1295 906 if level > current
Chris@1295 907 out << '<ul><li>' * (level - current)
Chris@1295 908 elsif level < current
Chris@1295 909 out << "</li></ul>\n" * (current - level) + "</li><li>"
Chris@1295 910 elsif started
Chris@1295 911 out << '</li><li>'
Chris@1295 912 end
Chris@1295 913 out << "<a href=\"##{anchor}\">#{item}</a>"
Chris@1295 914 current = level
Chris@1295 915 started = true
Chris@1295 916 end
Chris@1295 917 out << '</li></ul>' * (current - root)
Chris@1295 918 out << '</li></ul>'
Chris@1295 919 end
Chris@1295 920 end
Chris@1295 921 end
Chris@1295 922
Chris@1295 923 # Same as Rails' simple_format helper without using paragraphs
Chris@1295 924 def simple_format_without_paragraph(text)
Chris@1295 925 text.to_s.
Chris@1295 926 gsub(/\r\n?/, "\n"). # \r\n and \r -> \n
Chris@1295 927 gsub(/\n\n+/, "<br /><br />"). # 2+ newline -> 2 br
Chris@1295 928 gsub(/([^\n]\n)(?=[^\n])/, '\1<br />'). # 1 newline -> br
Chris@1295 929 html_safe
Chris@1295 930 end
Chris@1295 931
Chris@1295 932 def lang_options_for_select(blank=true)
Chris@1295 933 (blank ? [["(auto)", ""]] : []) + languages_options
Chris@1295 934 end
Chris@1295 935
Chris@1295 936 def label_tag_for(name, option_tags = nil, options = {})
Chris@1295 937 label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (options.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "")
Chris@1295 938 content_tag("label", label_text)
Chris@1295 939 end
Chris@1295 940
Chris@1295 941 def labelled_form_for(*args, &proc)
Chris@1295 942 args << {} unless args.last.is_a?(Hash)
Chris@1295 943 options = args.last
Chris@1295 944 if args.first.is_a?(Symbol)
Chris@1295 945 options.merge!(:as => args.shift)
Chris@1295 946 end
Chris@1295 947 options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
Chris@1295 948 form_for(*args, &proc)
Chris@1295 949 end
Chris@1295 950
Chris@1295 951 def labelled_fields_for(*args, &proc)
Chris@1295 952 args << {} unless args.last.is_a?(Hash)
Chris@1295 953 options = args.last
Chris@1295 954 options.merge!({:builder => Redmine::Views::LabelledFormBuilder})
Chris@1295 955 fields_for(*args, &proc)
Chris@1295 956 end
Chris@1295 957
Chris@1295 958 def labelled_remote_form_for(*args, &proc)
Chris@1295 959 ActiveSupport::Deprecation.warn "ApplicationHelper#labelled_remote_form_for is deprecated and will be removed in Redmine 2.2."
Chris@1295 960 args << {} unless args.last.is_a?(Hash)
Chris@1295 961 options = args.last
Chris@1295 962 options.merge!({:builder => Redmine::Views::LabelledFormBuilder, :remote => true})
Chris@1295 963 form_for(*args, &proc)
Chris@1295 964 end
Chris@1295 965
Chris@1295 966 def error_messages_for(*objects)
Chris@1295 967 html = ""
Chris@1295 968 objects = objects.map {|o| o.is_a?(String) ? instance_variable_get("@#{o}") : o}.compact
Chris@1295 969 errors = objects.map {|o| o.errors.full_messages}.flatten
Chris@1295 970 if errors.any?
Chris@1295 971 html << "<div id='errorExplanation'><ul>\n"
Chris@1295 972 errors.each do |error|
Chris@1295 973 html << "<li>#{h error}</li>\n"
Chris@1295 974 end
Chris@1295 975 html << "</ul></div>\n"
Chris@1295 976 end
Chris@1295 977 html.html_safe
Chris@1295 978 end
Chris@1295 979
Chris@1295 980 def delete_link(url, options={})
Chris@1295 981 options = {
Chris@1295 982 :method => :delete,
Chris@1295 983 :data => {:confirm => l(:text_are_you_sure)},
Chris@1295 984 :class => 'icon icon-del'
Chris@1295 985 }.merge(options)
Chris@1295 986
Chris@1295 987 link_to l(:button_delete), url, options
Chris@1295 988 end
Chris@1295 989
Chris@1295 990 def preview_link(url, form, target='preview', options={})
Chris@1295 991 content_tag 'a', l(:label_preview), {
Chris@1295 992 :href => "#",
Chris@1295 993 :onclick => %|submitPreview("#{escape_javascript url_for(url)}", "#{escape_javascript form}", "#{escape_javascript target}"); return false;|,
Chris@1295 994 :accesskey => accesskey(:preview)
Chris@1295 995 }.merge(options)
Chris@1295 996 end
Chris@1295 997
Chris@1295 998 def link_to_function(name, function, html_options={})
Chris@1295 999 content_tag(:a, name, {:href => '#', :onclick => "#{function}; return false;"}.merge(html_options))
Chris@1295 1000 end
Chris@1295 1001
Chris@1295 1002 # Helper to render JSON in views
Chris@1295 1003 def raw_json(arg)
Chris@1295 1004 arg.to_json.to_s.gsub('/', '\/').html_safe
Chris@1295 1005 end
Chris@1295 1006
Chris@1295 1007 def back_url
Chris@1295 1008 url = params[:back_url]
Chris@1295 1009 if url.nil? && referer = request.env['HTTP_REFERER']
Chris@1295 1010 url = CGI.unescape(referer.to_s)
Chris@1295 1011 end
Chris@1295 1012 url
Chris@1295 1013 end
Chris@1295 1014
Chris@1295 1015 def back_url_hidden_field_tag
Chris@1295 1016 url = back_url
Chris@1295 1017 hidden_field_tag('back_url', url, :id => nil) unless url.blank?
Chris@1295 1018 end
Chris@1295 1019
Chris@1295 1020 def check_all_links(form_name)
Chris@1295 1021 link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") +
Chris@1295 1022 " | ".html_safe +
Chris@1295 1023 link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)")
Chris@1295 1024 end
Chris@1295 1025
Chris@1295 1026 def progress_bar(pcts, options={})
Chris@1295 1027 pcts = [pcts, pcts] unless pcts.is_a?(Array)
Chris@1295 1028 pcts = pcts.collect(&:round)
Chris@1295 1029 pcts[1] = pcts[1] - pcts[0]
Chris@1295 1030 pcts << (100 - pcts[1] - pcts[0])
Chris@1295 1031 width = options[:width] || '100px;'
Chris@1295 1032 legend = options[:legend] || ''
Chris@1295 1033 content_tag('table',
Chris@1295 1034 content_tag('tr',
Chris@1295 1035 (pcts[0] > 0 ? content_tag('td', '', :style => "width: #{pcts[0]}%;", :class => 'closed') : ''.html_safe) +
Chris@1295 1036 (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1]}%;", :class => 'done') : ''.html_safe) +
Chris@1295 1037 (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2]}%;", :class => 'todo') : ''.html_safe)
Chris@1295 1038 ), :class => 'progress', :style => "width: #{width};").html_safe +
Chris@1295 1039 content_tag('p', legend, :class => 'percent').html_safe
Chris@1295 1040 end
Chris@1295 1041
Chris@1295 1042 def checked_image(checked=true)
Chris@1295 1043 if checked
Chris@1295 1044 image_tag 'toggle_check.png'
Chris@1295 1045 end
Chris@1295 1046 end
Chris@1295 1047
Chris@1295 1048 def context_menu(url)
Chris@1295 1049 unless @context_menu_included
Chris@1295 1050 content_for :header_tags do
Chris@1295 1051 javascript_include_tag('context_menu') +
Chris@1295 1052 stylesheet_link_tag('context_menu')
Chris@1295 1053 end
Chris@1295 1054 if l(:direction) == 'rtl'
Chris@1295 1055 content_for :header_tags do
Chris@1295 1056 stylesheet_link_tag('context_menu_rtl')
Chris@1295 1057 end
Chris@1295 1058 end
Chris@1295 1059 @context_menu_included = true
Chris@1295 1060 end
Chris@1295 1061 javascript_tag "contextMenuInit('#{ url_for(url) }')"
Chris@1295 1062 end
Chris@1295 1063
Chris@1295 1064 def calendar_for(field_id)
Chris@1295 1065 include_calendar_headers_tags
Chris@1295 1066 javascript_tag("$(function() { $('##{field_id}').datepicker(datepickerOptions); });")
Chris@1295 1067 end
Chris@1295 1068
Chris@1295 1069 def include_calendar_headers_tags
Chris@1295 1070 unless @calendar_headers_tags_included
Chris@1295 1071 @calendar_headers_tags_included = true
Chris@1295 1072 content_for :header_tags do
Chris@1295 1073 start_of_week = Setting.start_of_week
Chris@1295 1074 start_of_week = l(:general_first_day_of_week, :default => '1') if start_of_week.blank?
Chris@1295 1075 # Redmine uses 1..7 (monday..sunday) in settings and locales
Chris@1295 1076 # JQuery uses 0..6 (sunday..saturday), 7 needs to be changed to 0
Chris@1295 1077 start_of_week = start_of_week.to_i % 7
Chris@1295 1078
Chris@1295 1079 tags = javascript_tag(
Chris@1295 1080 "var datepickerOptions={dateFormat: 'yy-mm-dd', firstDay: #{start_of_week}, " +
Chris@1295 1081 "showOn: 'button', buttonImageOnly: true, buttonImage: '" +
Chris@1295 1082 path_to_image('/images/calendar.png') +
Chris@1295 1083 "', showButtonPanel: true, showWeek: true, showOtherMonths: true, selectOtherMonths: true};")
Chris@1295 1084 jquery_locale = l('jquery.locale', :default => current_language.to_s)
Chris@1295 1085 unless jquery_locale == 'en'
Chris@1295 1086 tags << javascript_include_tag("i18n/jquery.ui.datepicker-#{jquery_locale}.js")
Chris@1295 1087 end
Chris@1295 1088 tags
Chris@1295 1089 end
Chris@1295 1090 end
Chris@1295 1091 end
Chris@1295 1092
Chris@1295 1093 # Overrides Rails' stylesheet_link_tag with themes and plugins support.
Chris@1295 1094 # Examples:
Chris@1295 1095 # stylesheet_link_tag('styles') # => picks styles.css from the current theme or defaults
Chris@1295 1096 # stylesheet_link_tag('styles', :plugin => 'foo) # => picks styles.css from plugin's assets
Chris@1295 1097 #
Chris@1295 1098 def stylesheet_link_tag(*sources)
Chris@1295 1099 options = sources.last.is_a?(Hash) ? sources.pop : {}
Chris@1295 1100 plugin = options.delete(:plugin)
Chris@1295 1101 sources = sources.map do |source|
Chris@1295 1102 if plugin
Chris@1295 1103 "/plugin_assets/#{plugin}/stylesheets/#{source}"
Chris@1295 1104 elsif current_theme && current_theme.stylesheets.include?(source)
Chris@1295 1105 current_theme.stylesheet_path(source)
Chris@1295 1106 else
Chris@1295 1107 source
Chris@1295 1108 end
Chris@1295 1109 end
Chris@1295 1110 super sources, options
Chris@1295 1111 end
Chris@1295 1112
Chris@1295 1113 # Overrides Rails' image_tag with themes and plugins support.
Chris@1295 1114 # Examples:
Chris@1295 1115 # image_tag('image.png') # => picks image.png from the current theme or defaults
Chris@1295 1116 # image_tag('image.png', :plugin => 'foo) # => picks image.png from plugin's assets
Chris@1295 1117 #
Chris@1295 1118 def image_tag(source, options={})
Chris@1295 1119 if plugin = options.delete(:plugin)
Chris@1295 1120 source = "/plugin_assets/#{plugin}/images/#{source}"
Chris@1295 1121 elsif current_theme && current_theme.images.include?(source)
Chris@1295 1122 source = current_theme.image_path(source)
Chris@1295 1123 end
Chris@1295 1124 super source, options
Chris@1295 1125 end
Chris@1295 1126
Chris@1295 1127 # Overrides Rails' javascript_include_tag with plugins support
Chris@1295 1128 # Examples:
Chris@1295 1129 # javascript_include_tag('scripts') # => picks scripts.js from defaults
Chris@1295 1130 # javascript_include_tag('scripts', :plugin => 'foo) # => picks scripts.js from plugin's assets
Chris@1295 1131 #
Chris@1295 1132 def javascript_include_tag(*sources)
Chris@1295 1133 options = sources.last.is_a?(Hash) ? sources.pop : {}
Chris@1295 1134 if plugin = options.delete(:plugin)
Chris@1295 1135 sources = sources.map do |source|
Chris@1295 1136 if plugin
Chris@1295 1137 "/plugin_assets/#{plugin}/javascripts/#{source}"
Chris@1295 1138 else
Chris@1295 1139 source
Chris@1295 1140 end
Chris@1295 1141 end
Chris@1295 1142 end
Chris@1295 1143 super sources, options
Chris@1295 1144 end
Chris@1295 1145
Chris@1295 1146 def content_for(name, content = nil, &block)
Chris@1295 1147 @has_content ||= {}
Chris@1295 1148 @has_content[name] = true
Chris@1295 1149 super(name, content, &block)
Chris@1295 1150 end
Chris@1295 1151
Chris@1295 1152 def has_content?(name)
Chris@1295 1153 (@has_content && @has_content[name]) || false
Chris@1295 1154 end
Chris@1295 1155
Chris@1295 1156 def sidebar_content?
Chris@1295 1157 has_content?(:sidebar) || view_layouts_base_sidebar_hook_response.present?
Chris@1295 1158 end
Chris@1295 1159
Chris@1295 1160 def view_layouts_base_sidebar_hook_response
Chris@1295 1161 @view_layouts_base_sidebar_hook_response ||= call_hook(:view_layouts_base_sidebar)
Chris@1295 1162 end
Chris@1295 1163
Chris@1295 1164 def email_delivery_enabled?
Chris@1295 1165 !!ActionMailer::Base.perform_deliveries
Chris@1295 1166 end
Chris@1295 1167
Chris@1295 1168 # Returns the avatar image tag for the given +user+ if avatars are enabled
Chris@1295 1169 # +user+ can be a User or a string that will be scanned for an email address (eg. 'joe <joe@foo.bar>')
Chris@1295 1170 def avatar(user, options = { })
Chris@1295 1171 if Setting.gravatar_enabled?
Chris@1295 1172 options.merge!({:ssl => (request && request.ssl?), :default => Setting.gravatar_default})
Chris@1295 1173 email = nil
Chris@1295 1174 if user.respond_to?(:mail)
Chris@1295 1175 email = user.mail
Chris@1295 1176 elsif user.to_s =~ %r{<(.+?)>}
Chris@1295 1177 email = $1
Chris@1295 1178 end
Chris@1295 1179 return gravatar(email.to_s.downcase, options) unless email.blank? rescue nil
Chris@1295 1180 else
Chris@1295 1181 ''
Chris@1295 1182 end
Chris@1295 1183 end
Chris@1295 1184
Chris@1295 1185 def sanitize_anchor_name(anchor)
Chris@1295 1186 if ''.respond_to?(:encoding) || RUBY_PLATFORM == 'java'
Chris@1295 1187 anchor.gsub(%r{[^\s\-\p{Word}]}, '').gsub(%r{\s+(\-+\s*)?}, '-')
Chris@1295 1188 else
Chris@1295 1189 # TODO: remove when ruby1.8 is no longer supported
Chris@1295 1190 anchor.gsub(%r{[^\w\s\-]}, '').gsub(%r{\s+(\-+\s*)?}, '-')
Chris@1295 1191 end
Chris@1295 1192 end
Chris@1295 1193
Chris@1295 1194 # Returns the javascript tags that are included in the html layout head
Chris@1295 1195 def javascript_heads
Chris@1295 1196 tags = javascript_include_tag('jquery-1.8.3-ui-1.9.2-ujs-2.0.3', 'application')
Chris@1295 1197 unless User.current.pref.warn_on_leaving_unsaved == '0'
Chris@1295 1198 tags << "\n".html_safe + javascript_tag("$(window).load(function(){ warnLeavingUnsaved('#{escape_javascript l(:text_warn_on_leaving_unsaved)}'); });")
Chris@1295 1199 end
Chris@1295 1200 tags
Chris@1295 1201 end
Chris@1295 1202
Chris@1295 1203 def favicon
Chris@1295 1204 "<link rel='shortcut icon' href='#{image_path('/favicon.ico')}' />".html_safe
Chris@1295 1205 end
Chris@1295 1206
Chris@1295 1207 def robot_exclusion_tag
Chris@1295 1208 '<meta name="robots" content="noindex,follow,noarchive" />'.html_safe
Chris@1295 1209 end
Chris@1295 1210
Chris@1295 1211 # Returns true if arg is expected in the API response
Chris@1295 1212 def include_in_api_response?(arg)
Chris@1295 1213 unless @included_in_api_response
Chris@1295 1214 param = params[:include]
Chris@1295 1215 @included_in_api_response = param.is_a?(Array) ? param.collect(&:to_s) : param.to_s.split(',')
Chris@1295 1216 @included_in_api_response.collect!(&:strip)
Chris@1295 1217 end
Chris@1295 1218 @included_in_api_response.include?(arg.to_s)
Chris@1295 1219 end
Chris@1295 1220
Chris@1295 1221 # Returns options or nil if nometa param or X-Redmine-Nometa header
Chris@1295 1222 # was set in the request
Chris@1295 1223 def api_meta(options)
Chris@1295 1224 if params[:nometa].present? || request.headers['X-Redmine-Nometa']
Chris@1295 1225 # compatibility mode for activeresource clients that raise
Chris@1295 1226 # an error when unserializing an array with attributes
Chris@1295 1227 nil
Chris@1295 1228 else
Chris@1295 1229 options
Chris@1295 1230 end
Chris@1295 1231 end
Chris@1295 1232
Chris@1295 1233 private
Chris@1295 1234
Chris@1295 1235 def wiki_helper
Chris@1295 1236 helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)
Chris@1295 1237 extend helper
Chris@1295 1238 return self
Chris@1295 1239 end
Chris@1295 1240
Chris@1295 1241 def link_to_content_update(text, url_params = {}, html_options = {})
Chris@1295 1242 link_to(text, url_params, html_options)
Chris@1295 1243 end
Chris@1295 1244 end