Chris@909: # encoding: utf-8 Chris@909: # Chris@909: # Redmine - project management software Chris@909: # Copyright (C) 2006-2011 Jean-Philippe Lang Chris@909: # Chris@909: # This program is free software; you can redistribute it and/or Chris@909: # modify it under the terms of the GNU General Public License Chris@909: # as published by the Free Software Foundation; either version 2 Chris@909: # of the License, or (at your option) any later version. Chris@909: # Chris@909: # This program is distributed in the hope that it will be useful, Chris@909: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@909: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@909: # GNU General Public License for more details. Chris@909: # Chris@909: # You should have received a copy of the GNU General Public License Chris@909: # along with this program; if not, write to the Free Software Chris@909: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@909: Chris@909: require 'forwardable' Chris@909: require 'cgi' Chris@909: Chris@909: module ApplicationHelper Chris@909: include Redmine::WikiFormatting::Macros::Definitions Chris@909: include Redmine::I18n Chris@909: include GravatarHelper::PublicMethods Chris@909: Chris@909: extend Forwardable Chris@909: def_delegators :wiki_helper, :wikitoolbar_for, :heads_for_wiki_formatter Chris@909: Chris@909: # Return true if user is authorized for controller/action, otherwise false Chris@909: def authorize_for(controller, action) Chris@909: User.current.allowed_to?({:controller => controller, :action => action}, @project) Chris@909: end Chris@909: Chris@909: # Display a link if user is authorized Chris@909: # Chris@909: # @param [String] name Anchor text (passed to link_to) Chris@909: # @param [Hash] options Hash params. This will checked by authorize_for to see if the user is authorized Chris@909: # @param [optional, Hash] html_options Options passed to link_to Chris@909: # @param [optional, Hash] parameters_for_method_reference Extra parameters for link_to Chris@909: def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference) Chris@909: link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action]) Chris@909: end Chris@909: Chris@909: # Display a link to remote if user is authorized Chris@909: def link_to_remote_if_authorized(name, options = {}, html_options = nil) Chris@909: url = options[:url] || {} Chris@909: link_to_remote(name, options, html_options) if authorize_for(url[:controller] || params[:controller], url[:action]) Chris@909: end Chris@909: Chris@909: # Displays a link to user's account page if active Chris@909: def link_to_user(user, options={}) Chris@909: if user.is_a?(User) Chris@909: name = h(user.name(options[:format])) Chris@909: if user.active? Chris@909: link_to name, :controller => 'users', :action => 'show', :id => user Chris@909: else Chris@909: name Chris@909: end Chris@909: else Chris@909: h(user.to_s) Chris@909: end Chris@909: end Chris@909: Chris@909: # Displays a link to +issue+ with its subject. Chris@909: # Examples: Chris@909: # Chris@909: # link_to_issue(issue) # => Defect #6: This is the subject Chris@909: # link_to_issue(issue, :truncate => 6) # => Defect #6: This i... Chris@909: # link_to_issue(issue, :subject => false) # => Defect #6 Chris@909: # link_to_issue(issue, :project => true) # => Foo - Defect #6 Chris@909: # Chris@909: def link_to_issue(issue, options={}) Chris@909: title = nil Chris@909: subject = nil Chris@909: if options[:subject] == false Chris@909: title = truncate(issue.subject, :length => 60) Chris@909: else Chris@909: subject = issue.subject Chris@909: if options[:truncate] Chris@909: subject = truncate(subject, :length => options[:truncate]) Chris@909: end Chris@909: end Chris@909: s = link_to "#{h(issue.tracker)} ##{issue.id}", {:controller => "issues", :action => "show", :id => issue}, Chris@909: :class => issue.css_classes, Chris@909: :title => title Chris@909: s << ": #{h subject}" if subject Chris@909: s = "#{h issue.project} - " + s if options[:project] Chris@909: s Chris@909: end Chris@909: Chris@909: # Generates a link to an attachment. Chris@909: # Options: Chris@909: # * :text - Link text (default to attachment filename) Chris@909: # * :download - Force download (default: false) Chris@909: def link_to_attachment(attachment, options={}) Chris@909: text = options.delete(:text) || attachment.filename Chris@909: action = options.delete(:download) ? 'download' : 'show' Chris@909: link_to(h(text), Chris@909: {:controller => 'attachments', :action => action, Chris@909: :id => attachment, :filename => attachment.filename }, Chris@909: options) Chris@909: end Chris@909: Chris@909: # Generates a link to a SCM revision Chris@909: # Options: Chris@909: # * :text - Link text (default to the formatted revision) Chris@909: def link_to_revision(revision, project, options={}) Chris@909: text = options.delete(:text) || format_revision(revision) Chris@909: rev = revision.respond_to?(:identifier) ? revision.identifier : revision Chris@909: Chris@909: link_to(h(text), {:controller => 'repositories', :action => 'revision', :id => project, :rev => rev}, Chris@909: :title => l(:label_revision_id, format_revision(revision))) Chris@909: end Chris@909: Chris@909: # Generates a link to a message Chris@909: def link_to_message(message, options={}, html_options = nil) Chris@909: link_to( Chris@909: h(truncate(message.subject, :length => 60)), Chris@909: { :controller => 'messages', :action => 'show', Chris@909: :board_id => message.board_id, Chris@909: :id => message.root, Chris@909: :r => (message.parent_id && message.id), Chris@909: :anchor => (message.parent_id ? "message-#{message.id}" : nil) Chris@909: }.merge(options), Chris@909: html_options Chris@909: ) Chris@909: end Chris@909: Chris@909: # Generates a link to a project if active Chris@909: # Examples: Chris@909: # Chris@909: # link_to_project(project) # => link to the specified project overview Chris@909: # link_to_project(project, :action=>'settings') # => link to project settings Chris@909: # link_to_project(project, {:only_path => false}, :class => "project") # => 3rd arg adds html options Chris@909: # link_to_project(project, {}, :class => "project") # => html options with default url (project overview) Chris@909: # Chris@909: def link_to_project(project, options={}, html_options = nil) Chris@909: if project.active? Chris@909: url = {:controller => 'projects', :action => 'show', :id => project}.merge(options) Chris@909: link_to(h(project), url, html_options) Chris@909: else Chris@909: h(project) Chris@909: end Chris@909: end Chris@909: Chris@909: def toggle_link(name, id, options={}) Chris@909: onclick = "Element.toggle('#{id}'); " Chris@909: onclick << (options[:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ") Chris@909: onclick << "return false;" Chris@909: link_to(name, "#", :onclick => onclick) Chris@909: end Chris@909: Chris@909: def image_to_function(name, function, html_options = {}) Chris@909: html_options.symbolize_keys! Chris@909: tag(:input, html_options.merge({ Chris@909: :type => "image", :src => image_path(name), Chris@909: :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};" Chris@909: })) Chris@909: end Chris@909: Chris@909: def prompt_to_remote(name, text, param, url, html_options = {}) Chris@909: html_options[:onclick] = "promptToRemote('#{text}', '#{param}', '#{url_for(url)}'); return false;" Chris@909: link_to name, {}, html_options Chris@909: end Chris@909: Chris@909: def format_activity_title(text) Chris@909: h(truncate_single_line(text, :length => 100)) Chris@909: end Chris@909: Chris@909: def format_activity_day(date) Chris@909: date == Date.today ? l(:label_today).titleize : format_date(date) Chris@909: end Chris@909: Chris@909: def format_activity_description(text) Chris@909: h(truncate(text.to_s, :length => 120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')).gsub(/[\r\n]+/, "
") Chris@909: end Chris@909: Chris@909: def format_version_name(version) Chris@909: if version.project == @project Chris@909: h(version) Chris@909: else Chris@909: h("#{version.project} - #{version}") Chris@909: end Chris@909: end Chris@909: Chris@909: def due_date_distance_in_words(date) Chris@909: if date Chris@909: l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date)) Chris@909: end Chris@909: end Chris@909: Chris@909: def render_page_hierarchy(pages, node=nil, options={}) Chris@909: content = '' Chris@909: if pages[node] Chris@909: content << "\n" Chris@909: end Chris@909: content.html_safe Chris@909: end Chris@909: Chris@909: # Renders flash messages Chris@909: def render_flash_messages Chris@909: s = '' Chris@909: flash.each do |k,v| Chris@909: s << content_tag('div', v, :class => "flash #{k}") Chris@909: end Chris@909: s.html_safe Chris@909: end Chris@909: Chris@909: # Renders tabs and their content Chris@909: def render_tabs(tabs) Chris@909: if tabs.any? Chris@909: render :partial => 'common/tabs', :locals => {:tabs => tabs} Chris@909: else Chris@909: content_tag 'p', l(:label_no_data), :class => "nodata" Chris@909: end Chris@909: end Chris@909: Chris@909: # Renders the project quick-jump box Chris@909: def render_project_jump_box Chris@909: return unless User.current.logged? Chris@909: projects = User.current.memberships.collect(&:project).compact.uniq Chris@909: if projects.any? Chris@909: s = '' Chris@909: s.html_safe Chris@909: end Chris@909: end Chris@909: Chris@909: def project_tree_options_for_select(projects, options = {}) Chris@909: s = '' Chris@909: project_tree(projects) do |project, level| Chris@909: name_prefix = (level > 0 ? (' ' * 2 * level + '» ') : '') Chris@909: tag_options = {:value => project.id} Chris@909: if project == options[:selected] || (options[:selected].respond_to?(:include?) && options[:selected].include?(project)) Chris@909: tag_options[:selected] = 'selected' Chris@909: else Chris@909: tag_options[:selected] = nil Chris@909: end Chris@909: tag_options.merge!(yield(project)) if block_given? Chris@909: s << content_tag('option', name_prefix + h(project), tag_options) Chris@909: end Chris@909: s.html_safe Chris@909: end Chris@909: Chris@909: # Yields the given block for each project with its level in the tree Chris@909: # Chris@909: # Wrapper for Project#project_tree Chris@909: def project_tree(projects, &block) Chris@909: Project.project_tree(projects, &block) Chris@909: end Chris@909: Chris@909: def project_nested_ul(projects, &block) Chris@909: s = '' Chris@909: if projects.any? Chris@909: ancestors = [] Chris@909: projects.sort_by(&:lft).each do |project| Chris@909: if (ancestors.empty? || project.is_descendant_of?(ancestors.last)) Chris@909: s << "\n" Chris@909: end Chris@909: end Chris@909: s << "
  • " Chris@909: s << yield(project).to_s Chris@909: ancestors << project Chris@909: end Chris@909: s << ("
    • \n" * ancestors.size) Chris@909: end Chris@909: s.html_safe Chris@909: end Chris@909: Chris@909: def principals_check_box_tags(name, principals) Chris@909: s = '' Chris@909: principals.sort.each do |principal| Chris@909: s << "\n" Chris@909: end Chris@909: s.html_safe Chris@909: end Chris@909: Chris@909: # Returns a string for users/groups option tags Chris@909: def principals_options_for_select(collection, selected=nil) Chris@909: s = '' Chris@909: groups = '' Chris@909: collection.sort.each do |element| Chris@909: selected_attribute = ' selected="selected"' if option_value_selected?(element, selected) Chris@909: (element.is_a?(Group) ? groups : s) << %() Chris@909: end Chris@909: unless groups.empty? Chris@909: s << %(#{groups}) Chris@909: end Chris@909: s Chris@909: end Chris@909: Chris@909: # Truncates and returns the string as a single line Chris@909: def truncate_single_line(string, *args) Chris@909: truncate(string.to_s, *args).gsub(%r{[\r\n]+}m, ' ') Chris@909: end Chris@909: Chris@909: # Truncates at line break after 250 characters or options[:length] Chris@909: def truncate_lines(string, options={}) Chris@909: length = options[:length] || 250 Chris@909: if string.to_s =~ /\A(.{#{length}}.*?)$/m Chris@909: "#{$1}..." Chris@909: else Chris@909: string Chris@909: end Chris@909: end Chris@909: Chris@909: def html_hours(text) Chris@909: text.gsub(%r{(\d+)\.(\d+)}, '\1.\2').html_safe Chris@909: end Chris@909: Chris@909: def authoring(created, author, options={}) Chris@909: l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe Chris@909: end Chris@909: Chris@909: def time_tag(time) Chris@909: text = distance_of_time_in_words(Time.now, time) Chris@909: if @project Chris@909: link_to(text, {:controller => 'activities', :action => 'index', :id => @project, :from => time.to_date}, :title => format_time(time)) Chris@909: else Chris@909: content_tag('acronym', text, :title => format_time(time)) Chris@909: end Chris@909: end Chris@909: Chris@909: def syntax_highlight(name, content) Chris@909: Redmine::SyntaxHighlighting.highlight_by_filename(content, name) Chris@909: end Chris@909: Chris@909: def to_path_param(path) Chris@909: path.to_s.split(%r{[/\\]}).select {|p| !p.blank?} Chris@909: end Chris@909: Chris@909: def pagination_links_full(paginator, count=nil, options={}) Chris@909: page_param = options.delete(:page_param) || :page Chris@909: per_page_links = options.delete(:per_page_links) Chris@909: url_param = params.dup Chris@909: Chris@909: html = '' Chris@909: if paginator.current.previous Chris@909: # \xc2\xab(utf-8) = « Chris@909: html << link_to_content_update( Chris@909: "\xc2\xab " + l(:label_previous), Chris@909: url_param.merge(page_param => paginator.current.previous)) + ' ' Chris@909: end Chris@909: Chris@909: html << (pagination_links_each(paginator, options) do |n| Chris@909: link_to_content_update(n.to_s, url_param.merge(page_param => n)) Chris@909: end || '') Chris@909: Chris@909: if paginator.current.next Chris@909: # \xc2\xbb(utf-8) = » Chris@909: html << ' ' + link_to_content_update( Chris@909: (l(:label_next) + " \xc2\xbb"), Chris@909: url_param.merge(page_param => paginator.current.next)) Chris@909: end Chris@909: Chris@909: unless count.nil? Chris@909: html << " (#{paginator.current.first_item}-#{paginator.current.last_item}/#{count})" Chris@909: if per_page_links != false && links = per_page_links(paginator.items_per_page) Chris@909: html << " | #{links}" Chris@909: end Chris@909: end Chris@909: Chris@909: html.html_safe Chris@909: end Chris@909: Chris@909: def per_page_links(selected=nil) Chris@909: links = Setting.per_page_options_array.collect do |n| Chris@909: n == selected ? n : link_to_content_update(n, params.merge(:per_page => n)) Chris@909: end Chris@909: links.size > 1 ? l(:label_display_per_page, links.join(', ')) : nil Chris@909: end Chris@909: Chris@909: def reorder_links(name, url, method = :post) Chris@909: link_to(image_tag('2uparrow.png', :alt => l(:label_sort_highest)), Chris@909: url.merge({"#{name}[move_to]" => 'highest'}), Chris@909: :method => method, :title => l(:label_sort_highest)) + Chris@909: link_to(image_tag('1uparrow.png', :alt => l(:label_sort_higher)), Chris@909: url.merge({"#{name}[move_to]" => 'higher'}), Chris@909: :method => method, :title => l(:label_sort_higher)) + Chris@909: link_to(image_tag('1downarrow.png', :alt => l(:label_sort_lower)), Chris@909: url.merge({"#{name}[move_to]" => 'lower'}), Chris@909: :method => method, :title => l(:label_sort_lower)) + Chris@909: link_to(image_tag('2downarrow.png', :alt => l(:label_sort_lowest)), Chris@909: url.merge({"#{name}[move_to]" => 'lowest'}), Chris@909: :method => method, :title => l(:label_sort_lowest)) Chris@909: end Chris@909: Chris@909: def breadcrumb(*args) Chris@909: elements = args.flatten Chris@909: elements.any? ? content_tag('p', (args.join(" \xc2\xbb ") + " \xc2\xbb ").html_safe, :class => 'breadcrumb') : nil Chris@909: end Chris@909: Chris@909: def other_formats_links(&block) Chris@909: concat('

    '.html_safe + l(:label_export_to)) Chris@909: yield Redmine::Views::OtherFormatsBuilder.new(self) Chris@909: concat('

    '.html_safe) Chris@909: end Chris@909: Chris@909: def page_header_title Chris@909: if @project.nil? || @project.new_record? Chris@909: h(Setting.app_title) Chris@909: else Chris@909: b = [] Chris@909: ancestors = (@project.root? ? [] : @project.ancestors.visible.all) Chris@909: if ancestors.any? Chris@909: root = ancestors.shift Chris@909: b << link_to_project(root, {:jump => current_menu_item}, :class => 'root') Chris@909: if ancestors.size > 2 Chris@909: b << "\xe2\x80\xa6" Chris@909: ancestors = ancestors[-2, 2] Chris@909: end Chris@909: b += ancestors.collect {|p| link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor') } Chris@909: end Chris@909: b << h(@project) Chris@909: b.join(" \xc2\xbb ").html_safe Chris@909: end Chris@909: end Chris@909: Chris@909: def html_title(*args) Chris@909: if args.empty? Chris@909: title = @html_title || [] Chris@909: title << @project.name if @project Chris@909: title << Setting.app_title unless Setting.app_title == title.last Chris@909: title.select {|t| !t.blank? }.join(' - ') Chris@909: else Chris@909: @html_title ||= [] Chris@909: @html_title += args Chris@909: end Chris@909: end Chris@909: Chris@909: # Returns the theme, controller name, and action as css classes for the Chris@909: # HTML body. Chris@909: def body_css_classes Chris@909: css = [] Chris@909: if theme = Redmine::Themes.theme(Setting.ui_theme) Chris@909: css << 'theme-' + theme.name Chris@909: end Chris@909: Chris@909: css << 'controller-' + params[:controller] Chris@909: css << 'action-' + params[:action] Chris@909: css.join(' ') Chris@909: end Chris@909: Chris@909: def accesskey(s) Chris@909: Redmine::AccessKeys.key_for s Chris@909: end Chris@909: Chris@909: # Formats text according to system settings. Chris@909: # 2 ways to call this method: Chris@909: # * with a String: textilizable(text, options) Chris@909: # * with an object and one of its attribute: textilizable(issue, :description, options) Chris@909: def textilizable(*args) Chris@909: options = args.last.is_a?(Hash) ? args.pop : {} Chris@909: case args.size Chris@909: when 1 Chris@909: obj = options[:object] Chris@909: text = args.shift Chris@909: when 2 Chris@909: obj = args.shift Chris@909: attr = args.shift Chris@909: text = obj.send(attr).to_s Chris@909: else Chris@909: raise ArgumentError, 'invalid arguments to textilizable' Chris@909: end Chris@909: return '' if text.blank? Chris@909: project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil) Chris@909: only_path = options.delete(:only_path) == false ? false : true Chris@909: Chris@909: text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text, :object => obj, :attribute => attr) Chris@909: Chris@909: @parsed_headings = [] Chris@909: @current_section = 0 if options[:edit_section_links] Chris@909: text = parse_non_pre_blocks(text) do |text| Chris@909: [:parse_sections, :parse_inline_attachments, :parse_wiki_links, :parse_redmine_links, :parse_macros, :parse_headings].each do |method_name| Chris@909: send method_name, text, project, obj, attr, only_path, options Chris@909: end Chris@909: end Chris@909: Chris@909: if @parsed_headings.any? Chris@909: replace_toc(text, @parsed_headings) Chris@909: end Chris@909: Chris@909: text Chris@909: end Chris@909: Chris@909: def parse_non_pre_blocks(text) Chris@909: s = StringScanner.new(text) Chris@909: tags = [] Chris@909: parsed = '' Chris@909: while !s.eos? Chris@909: s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im) Chris@909: text, full_tag, closing, tag = s[1], s[2], s[3], s[4] Chris@909: if tags.empty? Chris@909: yield text Chris@909: end Chris@909: parsed << text Chris@909: if tag Chris@909: if closing Chris@909: if tags.last == tag.downcase Chris@909: tags.pop Chris@909: end Chris@909: else Chris@909: tags << tag.downcase Chris@909: end Chris@909: parsed << full_tag Chris@909: end Chris@909: end Chris@909: # Close any non closing tags Chris@909: while tag = tags.pop Chris@909: parsed << "" Chris@909: end Chris@909: parsed.html_safe Chris@909: end Chris@909: Chris@909: def parse_inline_attachments(text, project, obj, attr, only_path, options) Chris@909: # when using an image link, try to use an attachment, if possible Chris@909: if options[:attachments] || (obj && obj.respond_to?(:attachments)) Chris@909: attachments = options[:attachments] || obj.attachments Chris@909: text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m| Chris@909: filename, ext, alt, alttext = $1.downcase, $2, $3, $4 Chris@909: # search for the picture in attachments Chris@909: if found = Attachment.latest_attach(attachments, filename) Chris@909: image_url = url_for :only_path => only_path, :controller => 'attachments', Chris@909: :action => 'download', :id => found Chris@909: desc = found.description.to_s.gsub('"', '') Chris@909: if !desc.blank? && alttext.blank? Chris@909: alt = " title=\"#{desc}\" alt=\"#{desc}\"" Chris@909: end Chris@909: "src=\"#{image_url}\"#{alt}".html_safe Chris@909: else Chris@909: m.html_safe Chris@909: end Chris@909: end Chris@909: end Chris@909: end Chris@909: Chris@909: # Wiki links Chris@909: # Chris@909: # Examples: Chris@909: # [[mypage]] Chris@909: # [[mypage|mytext]] Chris@909: # wiki links can refer other project wikis, using project name or identifier: Chris@909: # [[project:]] -> wiki starting page Chris@909: # [[project:|mytext]] Chris@909: # [[project:mypage]] Chris@909: # [[project:mypage|mytext]] Chris@909: def parse_wiki_links(text, project, obj, attr, only_path, options) Chris@909: text.gsub!(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m| Chris@909: link_project = project Chris@909: esc, all, page, title = $1, $2, $3, $5 Chris@909: if esc.nil? Chris@909: if page =~ /^([^\:]+)\:(.*)$/ Chris@909: link_project = Project.find_by_identifier($1) || Project.find_by_name($1) Chris@909: page = $2 Chris@909: title ||= $1 if page.blank? Chris@909: end Chris@909: Chris@909: if link_project && link_project.wiki Chris@909: # extract anchor Chris@909: anchor = nil Chris@909: if page =~ /^(.+?)\#(.+)$/ Chris@909: page, anchor = $1, $2 Chris@909: end Chris@909: anchor = sanitize_anchor_name(anchor) if anchor.present? Chris@909: # check if page exists Chris@909: wiki_page = link_project.wiki.find_page(page) Chris@909: url = if anchor.present? && wiki_page.present? && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)) && obj.page == wiki_page Chris@909: "##{anchor}" Chris@909: else Chris@909: case options[:wiki_links] Chris@909: when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '') Chris@909: when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export Chris@909: else Chris@909: wiki_page_id = page.present? ? Wiki.titleize(page) : nil Chris@909: url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project, :id => wiki_page_id, :anchor => anchor) Chris@909: end Chris@909: end Chris@909: link_to(title.present? ? title.html_safe : h(page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new'))) Chris@909: else Chris@909: # project or wiki doesn't exist Chris@909: all.html_safe Chris@909: end Chris@909: else Chris@909: all.html_safe Chris@909: end Chris@909: end Chris@909: end Chris@909: Chris@909: # Redmine links Chris@909: # Chris@909: # Examples: Chris@909: # Issues: Chris@909: # #52 -> Link to issue #52 Chris@909: # Changesets: Chris@909: # r52 -> Link to revision 52 Chris@909: # commit:a85130f -> Link to scmid starting with a85130f Chris@909: # Documents: Chris@909: # document#17 -> Link to document with id 17 Chris@909: # document:Greetings -> Link to the document with title "Greetings" Chris@909: # document:"Some document" -> Link to the document with title "Some document" Chris@909: # Versions: Chris@909: # version#3 -> Link to version with id 3 Chris@909: # version:1.0.0 -> Link to version named "1.0.0" Chris@909: # version:"1.0 beta 2" -> Link to version named "1.0 beta 2" Chris@909: # Attachments: Chris@909: # attachment:file.zip -> Link to the attachment of the current object named file.zip Chris@909: # Source files: Chris@909: # source:some/file -> Link to the file located at /some/file in the project's repository Chris@909: # source:some/file@52 -> Link to the file's revision 52 Chris@909: # source:some/file#L120 -> Link to line 120 of the file Chris@909: # source:some/file@52#L120 -> Link to line 120 of the file's revision 52 Chris@909: # export:some/file -> Force the download of the file Chris@909: # Forum messages: Chris@909: # message#1218 -> Link to message with id 1218 Chris@909: # Chris@909: # Links can refer other objects from other projects, using project identifier: Chris@909: # identifier:r52 Chris@909: # identifier:document:"Some document" Chris@909: # identifier:version:1.0.0 Chris@909: # identifier:source:some/file Chris@909: def parse_redmine_links(text, project, obj, attr, only_path, options) Chris@909: text.gsub!(%r{([\s\(,\-\[\>]|^)(!)?(([a-z0-9\-]+):)?(attachment|document|version|forum|news|commit|source|export|message|project)?((#|r)(\d+)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]]\W)|,|\s|\]|<|$)}) do |m| Chris@909: leading, esc, project_prefix, project_identifier, prefix, sep, identifier = $1, $2, $3, $4, $5, $7 || $9, $8 || $10 Chris@909: link = nil Chris@909: if project_identifier Chris@909: project = Project.visible.find_by_identifier(project_identifier) Chris@909: end Chris@909: if esc.nil? Chris@909: if prefix.nil? && sep == 'r' Chris@909: # project.changesets.visible raises an SQL error because of a double join on repositories Chris@909: if project && project.repository && (changeset = Changeset.visible.find_by_repository_id_and_revision(project.repository.id, identifier)) Chris@909: link = link_to(h("#{project_prefix}r#{identifier}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.revision}, Chris@909: :class => 'changeset', Chris@909: :title => truncate_single_line(changeset.comments, :length => 100)) Chris@909: end Chris@909: elsif sep == '#' Chris@909: oid = identifier.to_i Chris@909: case prefix Chris@909: when nil Chris@909: if issue = Issue.visible.find_by_id(oid, :include => :status) Chris@909: link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid}, Chris@909: :class => issue.css_classes, Chris@909: :title => "#{truncate(issue.subject, :length => 100)} (#{issue.status.name})") Chris@909: end Chris@909: when 'document' Chris@909: if document = Document.visible.find_by_id(oid) Chris@909: link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document}, Chris@909: :class => 'document' Chris@909: end Chris@909: when 'version' Chris@909: if version = Version.visible.find_by_id(oid) Chris@909: link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version}, Chris@909: :class => 'version' Chris@909: end Chris@909: when 'message' Chris@909: if message = Message.visible.find_by_id(oid, :include => :parent) Chris@909: link = link_to_message(message, {:only_path => only_path}, :class => 'message') Chris@909: end Chris@909: when 'forum' Chris@909: if board = Board.visible.find_by_id(oid) Chris@909: link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project}, Chris@909: :class => 'board' Chris@909: end Chris@909: when 'news' Chris@909: if news = News.visible.find_by_id(oid) Chris@909: link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news}, Chris@909: :class => 'news' Chris@909: end Chris@909: when 'project' Chris@909: if p = Project.visible.find_by_id(oid) Chris@909: link = link_to_project(p, {:only_path => only_path}, :class => 'project') Chris@909: end Chris@909: end Chris@909: elsif sep == ':' Chris@909: # removes the double quotes if any Chris@909: name = identifier.gsub(%r{^"(.*)"$}, "\\1") Chris@909: case prefix Chris@909: when 'document' Chris@909: if project && document = project.documents.visible.find_by_title(name) Chris@909: link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document}, Chris@909: :class => 'document' Chris@909: end Chris@909: when 'version' Chris@909: if project && version = project.versions.visible.find_by_name(name) Chris@909: link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version}, Chris@909: :class => 'version' Chris@909: end Chris@909: when 'forum' Chris@909: if project && board = project.boards.visible.find_by_name(name) Chris@909: link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project}, Chris@909: :class => 'board' Chris@909: end Chris@909: when 'news' Chris@909: if project && news = project.news.visible.find_by_title(name) Chris@909: link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news}, Chris@909: :class => 'news' Chris@909: end Chris@909: when 'commit' Chris@909: if project && project.repository && (changeset = Changeset.visible.find(:first, :conditions => ["repository_id = ? AND scmid LIKE ?", project.repository.id, "#{name}%"])) Chris@909: link = link_to h("#{project_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.identifier}, Chris@909: :class => 'changeset', Chris@909: :title => truncate_single_line(h(changeset.comments), :length => 100) Chris@909: end Chris@909: when 'source', 'export' Chris@909: if project && project.repository && User.current.allowed_to?(:browse_repository, project) Chris@909: name =~ %r{^[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?$} Chris@909: path, rev, anchor = $1, $3, $5 Chris@909: link = link_to h("#{project_prefix}#{prefix}:#{name}"), {:controller => 'repositories', :action => 'entry', :id => project, Chris@909: :path => to_path_param(path), Chris@909: :rev => rev, Chris@909: :anchor => anchor, Chris@909: :format => (prefix == 'export' ? 'raw' : nil)}, Chris@909: :class => (prefix == 'export' ? 'source download' : 'source') Chris@909: end Chris@909: when 'attachment' Chris@909: attachments = options[:attachments] || (obj && obj.respond_to?(:attachments) ? obj.attachments : nil) Chris@909: if attachments && attachment = attachments.detect {|a| a.filename == name } Chris@909: link = link_to h(attachment.filename), {:only_path => only_path, :controller => 'attachments', :action => 'download', :id => attachment}, Chris@909: :class => 'attachment' Chris@909: end Chris@909: when 'project' Chris@909: if p = Project.visible.find(:first, :conditions => ["identifier = :s OR LOWER(name) = :s", {:s => name.downcase}]) Chris@909: link = link_to_project(p, {:only_path => only_path}, :class => 'project') Chris@909: end Chris@909: end Chris@909: end Chris@909: end Chris@909: (leading + (link || "#{project_prefix}#{prefix}#{sep}#{identifier}")).html_safe Chris@909: end Chris@909: end Chris@909: Chris@909: HEADING_RE = /(]+)?>(.+?)<\/h(1|2|3|4)>)/i unless const_defined?(:HEADING_RE) Chris@909: Chris@909: def parse_sections(text, project, obj, attr, only_path, options) Chris@909: return unless options[:edit_section_links] Chris@909: text.gsub!(HEADING_RE) do Chris@909: @current_section += 1 Chris@909: if @current_section > 1 Chris@909: content_tag('div', Chris@909: link_to(image_tag('edit.png'), options[:edit_section_links].merge(:section => @current_section)), Chris@909: :class => 'contextual', Chris@909: :title => l(:button_edit_section)) + $1 Chris@909: else Chris@909: $1 Chris@909: end Chris@909: end Chris@909: end Chris@909: Chris@909: # Headings and TOC Chris@909: # Adds ids and links to headings unless options[:headings] is set to false Chris@909: def parse_headings(text, project, obj, attr, only_path, options) Chris@909: return if options[:headings] == false Chris@909: Chris@909: text.gsub!(HEADING_RE) do Chris@909: level, attrs, content = $2.to_i, $3, $4 Chris@909: item = strip_tags(content).strip Chris@909: anchor = sanitize_anchor_name(item) Chris@909: # used for single-file wiki export Chris@909: anchor = "#{obj.page.title}_#{anchor}" if options[:wiki_links] == :anchor && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)) Chris@909: @parsed_headings << [level, anchor, item] Chris@909: "\n#{content}" Chris@909: end Chris@909: end Chris@909: Chris@909: MACROS_RE = / Chris@909: (!)? # escaping Chris@909: ( Chris@909: \{\{ # opening tag Chris@909: ([\w]+) # macro name Chris@909: (\(([^\}]*)\))? # optional arguments Chris@909: \}\} # closing tag Chris@909: ) Chris@909: /x unless const_defined?(:MACROS_RE) Chris@909: Chris@909: # Macros substitution Chris@909: def parse_macros(text, project, obj, attr, only_path, options) Chris@909: text.gsub!(MACROS_RE) do Chris@909: esc, all, macro = $1, $2, $3.downcase Chris@909: args = ($5 || '').split(',').each(&:strip) Chris@909: if esc.nil? Chris@909: begin Chris@909: exec_macro(macro, obj, args) Chris@909: rescue => e Chris@909: "
    Error executing the #{macro} macro (#{e})
    " Chris@909: end || all Chris@909: else Chris@909: all Chris@909: end Chris@909: end Chris@909: end Chris@909: Chris@909: TOC_RE = /

    \{\{([<>]?)toc\}\}<\/p>/i unless const_defined?(:TOC_RE) Chris@909: Chris@909: # Renders the TOC with given headings Chris@909: def replace_toc(text, headings) Chris@909: text.gsub!(TOC_RE) do Chris@909: if headings.empty? Chris@909: '' Chris@909: else Chris@909: div_class = 'toc' Chris@909: div_class << ' right' if $1 == '>' Chris@909: div_class << ' left' if $1 == '<' Chris@909: out = "

    ' * (current - root) Chris@909: out << '' Chris@909: end Chris@909: end Chris@909: end Chris@909: Chris@909: # Same as Rails' simple_format helper without using paragraphs Chris@909: def simple_format_without_paragraph(text) Chris@909: text.to_s. Chris@909: gsub(/\r\n?/, "\n"). # \r\n and \r -> \n Chris@909: gsub(/\n\n+/, "

    "). # 2+ newline -> 2 br Chris@909: gsub(/([^\n]\n)(?=[^\n])/, '\1
    '). # 1 newline -> br Chris@909: html_safe Chris@909: end Chris@909: Chris@909: def lang_options_for_select(blank=true) Chris@909: (blank ? [["(auto)", ""]] : []) + Chris@909: valid_languages.collect{|lang| [ ll(lang.to_s, :general_lang_name), lang.to_s]}.sort{|x,y| x.last <=> y.last } Chris@909: end Chris@909: Chris@909: def label_tag_for(name, option_tags = nil, options = {}) Chris@909: label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (options.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "") Chris@909: content_tag("label", label_text) Chris@909: end Chris@909: Chris@909: def labelled_tabular_form_for(*args, &proc) Chris@909: args << {} unless args.last.is_a?(Hash) Chris@909: options = args.last Chris@909: options[:html] ||= {} Chris@909: options[:html][:class] = 'tabular' unless options[:html].has_key?(:class) Chris@909: options.merge!({:builder => TabularFormBuilder}) Chris@909: form_for(*args, &proc) Chris@909: end Chris@909: Chris@909: def labelled_form_for(*args, &proc) Chris@909: args << {} unless args.last.is_a?(Hash) Chris@909: options = args.last Chris@909: options.merge!({:builder => TabularFormBuilder}) Chris@909: form_for(*args, &proc) Chris@909: end Chris@909: Chris@909: def back_url_hidden_field_tag Chris@909: back_url = params[:back_url] || request.env['HTTP_REFERER'] Chris@909: back_url = CGI.unescape(back_url.to_s) Chris@909: hidden_field_tag('back_url', CGI.escape(back_url)) unless back_url.blank? Chris@909: end Chris@909: Chris@909: def check_all_links(form_name) Chris@909: link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") + Chris@909: " | ".html_safe + Chris@909: link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)") Chris@909: end Chris@909: Chris@909: def progress_bar(pcts, options={}) Chris@909: pcts = [pcts, pcts] unless pcts.is_a?(Array) Chris@909: pcts = pcts.collect(&:round) Chris@909: pcts[1] = pcts[1] - pcts[0] Chris@909: pcts << (100 - pcts[1] - pcts[0]) Chris@909: width = options[:width] || '100px;' Chris@909: legend = options[:legend] || '' Chris@909: content_tag('table', Chris@909: content_tag('tr', Chris@909: (pcts[0] > 0 ? content_tag('td', '', :style => "width: #{pcts[0]}%;", :class => 'closed') : ''.html_safe) + Chris@909: (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1]}%;", :class => 'done') : ''.html_safe) + Chris@909: (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2]}%;", :class => 'todo') : ''.html_safe) Chris@909: ), :class => 'progress', :style => "width: #{width};").html_safe + Chris@909: content_tag('p', legend, :class => 'pourcent').html_safe Chris@909: end Chris@909: Chris@909: def checked_image(checked=true) Chris@909: if checked Chris@909: image_tag 'toggle_check.png' Chris@909: end Chris@909: end Chris@909: Chris@909: def context_menu(url) Chris@909: unless @context_menu_included Chris@909: content_for :header_tags do Chris@909: javascript_include_tag('context_menu') + Chris@909: stylesheet_link_tag('context_menu') Chris@909: end Chris@909: if l(:direction) == 'rtl' Chris@909: content_for :header_tags do Chris@909: stylesheet_link_tag('context_menu_rtl') Chris@909: end Chris@909: end Chris@909: @context_menu_included = true Chris@909: end Chris@909: javascript_tag "new ContextMenu('#{ url_for(url) }')" Chris@909: end Chris@909: Chris@909: def context_menu_link(name, url, options={}) Chris@909: options[:class] ||= '' Chris@909: if options.delete(:selected) Chris@909: options[:class] << ' icon-checked disabled' Chris@909: options[:disabled] = true Chris@909: end Chris@909: if options.delete(:disabled) Chris@909: options.delete(:method) Chris@909: options.delete(:confirm) Chris@909: options.delete(:onclick) Chris@909: options[:class] << ' disabled' Chris@909: url = '#' Chris@909: end Chris@909: link_to h(name), url, options Chris@909: end Chris@909: Chris@909: def calendar_for(field_id) Chris@909: include_calendar_headers_tags Chris@909: image_tag("calendar.png", {:id => "#{field_id}_trigger",:class => "calendar-trigger"}) + Chris@909: javascript_tag("Calendar.setup({inputField : '#{field_id}', ifFormat : '%Y-%m-%d', button : '#{field_id}_trigger' });") Chris@909: end Chris@909: Chris@909: def include_calendar_headers_tags Chris@909: unless @calendar_headers_tags_included Chris@909: @calendar_headers_tags_included = true Chris@909: content_for :header_tags do Chris@909: start_of_week = case Setting.start_of_week.to_i Chris@909: when 1 Chris@909: 'Calendar._FD = 1;' # Monday Chris@909: when 7 Chris@909: 'Calendar._FD = 0;' # Sunday Chris@909: when 6 Chris@909: 'Calendar._FD = 6;' # Saturday Chris@909: else Chris@909: '' # use language Chris@909: end Chris@909: Chris@909: javascript_include_tag('calendar/calendar') + Chris@909: javascript_include_tag("calendar/lang/calendar-#{current_language.to_s.downcase}.js") + Chris@909: javascript_tag(start_of_week) + Chris@909: javascript_include_tag('calendar/calendar-setup') + Chris@909: stylesheet_link_tag('calendar') Chris@909: end Chris@909: end Chris@909: end Chris@909: Chris@909: def content_for(name, content = nil, &block) Chris@909: @has_content ||= {} Chris@909: @has_content[name] = true Chris@909: super(name, content, &block) Chris@909: end Chris@909: Chris@909: def has_content?(name) Chris@909: (@has_content && @has_content[name]) || false Chris@909: end Chris@909: Chris@909: def email_delivery_enabled? Chris@909: !!ActionMailer::Base.perform_deliveries Chris@909: end Chris@909: Chris@909: # Returns the avatar image tag for the given +user+ if avatars are enabled Chris@909: # +user+ can be a User or a string that will be scanned for an email address (eg. 'joe ') Chris@909: def avatar(user, options = { }) Chris@909: if Setting.gravatar_enabled? Chris@909: options.merge!({:ssl => (defined?(request) && request.ssl?), :default => Setting.gravatar_default}) Chris@909: email = nil Chris@909: if user.respond_to?(:mail) Chris@909: email = user.mail Chris@909: elsif user.to_s =~ %r{<(.+?)>} Chris@909: email = $1 Chris@909: end Chris@909: return gravatar(email.to_s.downcase, options) unless email.blank? rescue nil Chris@909: else Chris@909: '' Chris@909: end Chris@909: end Chris@909: Chris@909: def sanitize_anchor_name(anchor) Chris@909: anchor.gsub(%r{[^\w\s\-]}, '').gsub(%r{\s+(\-+\s*)?}, '-') Chris@909: end Chris@909: Chris@909: # Returns the javascript tags that are included in the html layout head Chris@909: def javascript_heads Chris@909: tags = javascript_include_tag(:defaults) Chris@909: unless User.current.pref.warn_on_leaving_unsaved == '0' Chris@909: tags << "\n".html_safe + javascript_tag("Event.observe(window, 'load', function(){ new WarnLeavingUnsaved('#{escape_javascript( l(:text_warn_on_leaving_unsaved) )}'); });") Chris@909: end Chris@909: tags Chris@909: end Chris@909: Chris@909: def favicon Chris@909: "".html_safe Chris@909: end Chris@909: Chris@909: def robot_exclusion_tag Chris@909: ''.html_safe Chris@909: end Chris@909: Chris@909: # Returns true if arg is expected in the API response Chris@909: def include_in_api_response?(arg) Chris@909: unless @included_in_api_response Chris@909: param = params[:include] Chris@909: @included_in_api_response = param.is_a?(Array) ? param.collect(&:to_s) : param.to_s.split(',') Chris@909: @included_in_api_response.collect!(&:strip) Chris@909: end Chris@909: @included_in_api_response.include?(arg.to_s) Chris@909: end Chris@909: Chris@909: # Returns options or nil if nometa param or X-Redmine-Nometa header Chris@909: # was set in the request Chris@909: def api_meta(options) Chris@909: if params[:nometa].present? || request.headers['X-Redmine-Nometa'] Chris@909: # compatibility mode for activeresource clients that raise Chris@909: # an error when unserializing an array with attributes Chris@909: nil Chris@909: else Chris@909: options Chris@909: end Chris@909: end Chris@909: Chris@909: private Chris@909: Chris@909: def wiki_helper Chris@909: helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting) Chris@909: extend helper Chris@909: return self Chris@909: end Chris@909: Chris@909: def link_to_content_update(text, url_params = {}, html_options = {}) Chris@909: link_to(text, url_params, html_options) Chris@909: end Chris@909: end