Module: ApplicationHelper
- Extended by:
- Forwardable
- Includes:
- GravatarHelper::PublicMethods, Redmine::I18n, Redmine::WikiFormatting::Macros::Definitions
- Included in:
- IssuesHelper, Redmine::Hook::ViewListener, TimelogHelper
- Defined in:
- lib/redmine/themes.rb,
app/helpers/application_helper.rb
Constant Summary collapse
- HEADING_RE =
/<h(1|2|3|4)( [^>]+)?>(.+?)<\/h(1|2|3|4)>/i
- TOC_RE =
/<p>\{\{([<>]?)toc\}\}<\/p>/i
Instance Method Summary collapse
- #accesskey(s) ⇒ Object
-
#api_meta(options) ⇒ Object
Returns options or nil if nometa param or X-Redmine-Nometa header was set in the request.
- #authoring(created, author, options = {}) ⇒ Object
-
#authorize_for(controller, action) ⇒ Object
Return true if user is authorized for controller/action, otherwise false.
-
#avatar(user, options = { }) ⇒ Object
Returns the avatar image tag for the given
user
if avatars are enableduser
can be a User or a string that will be scanned for an email address (eg. ‘joe <[email protected]>’). - #back_url_hidden_field_tag ⇒ Object
-
#body_css_classes ⇒ Object
Returns the theme, controller name, and action as css classes for the HTML body.
- #breadcrumb(*args) ⇒ Object
- #calendar_for(field_id) ⇒ Object
- #check_all_links(form_name) ⇒ Object
- #checked_image(checked = true) ⇒ Object
- #content_for(name, content = nil, &block) ⇒ Object
- #context_menu(url) ⇒ Object
- #context_menu_link(name, url, options = {}) ⇒ Object
- #current_theme ⇒ Object
- #due_date_distance_in_words(date) ⇒ Object
- #favicon ⇒ Object
- #format_activity_day(date) ⇒ Object
- #format_activity_description(text) ⇒ Object
- #format_activity_title(text) ⇒ Object
- #format_version_name(version) ⇒ Object
- #has_content?(name) ⇒ Boolean
-
#heads_for_theme ⇒ Object
Returns the header tags for the current theme.
- #html_hours(text) ⇒ Object
- #html_title(*args) ⇒ Object
- #image_to_function(name, function, html_options = {}) ⇒ Object
- #include_calendar_headers_tags ⇒ Object
-
#include_in_api_response?(arg) ⇒ Boolean
Returns true if arg is expected in the API response.
-
#javascript_heads ⇒ Object
Returns the javascript tags that are included in the html layout head.
- #label_tag_for(name, option_tags = nil, options = {}) ⇒ Object
- #labelled_tabular_form_for(name, object, options, &proc) ⇒ Object
- #lang_options_for_select(blank = true) ⇒ Object
-
#link_to_attachment(attachment, options = {}) ⇒ Object
Generates a link to an attachment.
-
#link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference) ⇒ Object
Display a link if user is authorized.
-
#link_to_issue(issue, options = {}) ⇒ Object
Displays a link to
issue
with its subject. -
#link_to_message(message, options = {}, html_options = nil) ⇒ Object
Generates a link to a message.
-
#link_to_project(project, options = {}, html_options = nil) ⇒ Object
Generates a link to a project if active Examples:.
-
#link_to_remote_if_authorized(name, options = {}, html_options = nil) ⇒ Object
Display a link to remote if user is authorized.
-
#link_to_revision(revision, project, options = {}) ⇒ Object
Generates a link to a SCM revision Options: * :text - Link text (default to the formatted revision).
-
#link_to_user(user, options = {}) ⇒ Object
Displays a link to user’s account page if active.
- #other_formats_links {|Redmine::Views::OtherFormatsBuilder.new(self)| ... } ⇒ Object
- #page_header_title ⇒ Object
- #pagination_links_full(paginator, count = nil, options = {}) ⇒ Object
-
#parse_headings(text, project, obj, attr, only_path, options) ⇒ Object
Headings and TOC Adds ids and links to headings unless options is set to false.
- #parse_inline_attachments(text, project, obj, attr, only_path, options) ⇒ Object
- #parse_non_pre_blocks(text) ⇒ Object
-
#parse_redmine_links(text, project, obj, attr, only_path, options) ⇒ Object
Redmine links.
-
#parse_wiki_links(text, project, obj, attr, only_path, options) ⇒ Object
Wiki links.
- #path_to_stylesheet(source) ⇒ Object
- #per_page_links(selected = nil) ⇒ Object
- #principals_check_box_tags(name, principals) ⇒ Object
- #progress_bar(pcts, options = {}) ⇒ Object
- #project_nested_ul(projects, &block) ⇒ Object
-
#project_tree(projects, &block) ⇒ Object
Yields the given block for each project with its level in the tree.
- #project_tree_options_for_select(projects, options = {}) ⇒ Object
- #prompt_to_remote(name, text, param, url, html_options = {}) ⇒ Object
-
#render_flash_messages ⇒ Object
Renders flash messages.
- #render_page_hierarchy(pages, node = nil, options = {}) ⇒ Object
-
#render_project_jump_box ⇒ Object
Renders the project quick-jump box.
-
#render_tabs(tabs) ⇒ Object
Renders tabs and their content.
- #reorder_links(name, url) ⇒ Object
-
#replace_toc(text, headings) ⇒ Object
Renders the TOC with given headings.
-
#simple_format_without_paragraph(text) ⇒ Object
Same as Rails’ simple_format helper without using paragraphs.
- #stylesheet_path(source) ⇒ Object
- #syntax_highlight(name, content) ⇒ Object
-
#textilizable(*args) ⇒ Object
Formats text according to system settings.
- #time_tag(time) ⇒ Object
- #to_path_param(path) ⇒ Object
- #toggle_link(name, id, options = {}) ⇒ Object
-
#truncate_lines(string, options = {}) ⇒ Object
Truncates at line break after 250 characters or options.
-
#truncate_single_line(string, *args) ⇒ Object
Truncates and returns the string as a single line.
Methods included from Redmine::I18n
#current_language, #day_name, #find_language, #format_date, #format_time, included, #l, #l_hours, #l_or_humanize, #ll, #month_name, #set_language_if_valid, #valid_languages
Methods included from Redmine::WikiFormatting::Macros::Definitions
#exec_macro, #extract_macro_options
Instance Method Details
#accesskey(s) ⇒ Object
441 442 443 |
# File 'app/helpers/application_helper.rb', line 441 def accesskey(s) Redmine::AccessKeys.key_for s end |
#api_meta(options) ⇒ Object
Returns options or nil if nometa param or X-Redmine-Nometa header was set in the request
924 925 926 927 928 929 930 931 932 |
# File 'app/helpers/application_helper.rb', line 924 def () if params[:nometa].present? || request.headers['X-Redmine-Nometa'] # compatibility mode for activeresource clients that raise # an error when unserializing an array with attributes nil else end end |
#authoring(created, author, options = {}) ⇒ Object
313 314 315 |
# File 'app/helpers/application_helper.rb', line 313 def (created, , ={}) l([:label] || :label_added_time_by, :author => link_to_user(), :age => time_tag(created)) end |
#authorize_for(controller, action) ⇒ Object
Return true if user is authorized for controller/action, otherwise false
30 31 32 |
# File 'app/helpers/application_helper.rb', line 30 def (controller, action) User.current.allowed_to?({:controller => controller, :action => action}, @project) end |
#avatar(user, options = { }) ⇒ Object
Returns the avatar image tag for the given user
if avatars are enabled user
can be a User or a string that will be scanned for an email address (eg. ‘joe <[email protected]>’)
884 885 886 887 888 889 890 891 892 893 894 895 896 897 |
# File 'app/helpers/application_helper.rb', line 884 def avatar(user, = { }) if Setting.gravatar_enabled? .merge!({:ssl => (defined?(request) && request.ssl?), :default => Setting.gravatar_default}) email = nil if user.respond_to?(:mail) email = user.mail elsif user.to_s =~ %r{<(.+?)>} email = $1 end return gravatar(email.to_s.downcase, ) unless email.blank? rescue nil else '' end end |
#back_url_hidden_field_tag ⇒ Object
776 777 778 779 780 |
# File 'app/helpers/application_helper.rb', line 776 def back_url_hidden_field_tag back_url = params[:back_url] || request.env['HTTP_REFERER'] back_url = CGI.unescape(back_url.to_s) hidden_field_tag('back_url', CGI.escape(back_url)) unless back_url.blank? end |
#body_css_classes ⇒ Object
Returns the theme, controller name, and action as css classes for the HTML body.
430 431 432 433 434 435 436 437 438 439 |
# File 'app/helpers/application_helper.rb', line 430 def body_css_classes css = [] if theme = Redmine::Themes.theme(Setting.ui_theme) css << 'theme-' + theme.name end css << 'controller-' + params[:controller] css << 'action-' + params[:action] css.join(' ') end |
#breadcrumb(*args) ⇒ Object
384 385 386 387 |
# File 'app/helpers/application_helper.rb', line 384 def (*args) elements = args.flatten elements.any? ? content_tag('p', args.join(' » ') + ' » ', :class => 'breadcrumb') : nil end |
#calendar_for(field_id) ⇒ Object
842 843 844 845 846 |
# File 'app/helpers/application_helper.rb', line 842 def calendar_for(field_id) image_tag("calendar.png", {:id => "#{field_id}_trigger",:class => "calendar-trigger"}) + javascript_tag("Calendar.setup({inputField : '#{field_id}', ifFormat : '%Y-%m-%d', button : '#{field_id}_trigger' });") end |
#check_all_links(form_name) ⇒ Object
782 783 784 785 786 |
# File 'app/helpers/application_helper.rb', line 782 def check_all_links(form_name) link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") + " | " + link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)") end |
#checked_image(checked = true) ⇒ Object
804 805 806 807 808 |
# File 'app/helpers/application_helper.rb', line 804 def checked_image(checked=true) if checked image_tag 'toggle_check.png' end end |
#content_for(name, content = nil, &block) ⇒ Object
872 873 874 875 876 |
# File 'app/helpers/application_helper.rb', line 872 def content_for(name, content = nil, &block) @has_content ||= {} @has_content[name] = true super(name, content, &block) end |
#context_menu(url) ⇒ Object
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 |
# File 'app/helpers/application_helper.rb', line 810 def (url) unless @context_menu_included content_for :header_tags do javascript_include_tag('context_menu') + stylesheet_link_tag('context_menu') end if l(:direction) == 'rtl' content_for :header_tags do stylesheet_link_tag('context_menu_rtl') end end @context_menu_included = true end javascript_tag "new ContextMenu('#{ url_for(url) }')" end |
#context_menu_link(name, url, options = {}) ⇒ Object
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'app/helpers/application_helper.rb', line 826 def (name, url, ={}) [:class] ||= '' if .delete(:selected) [:class] << ' icon-checked disabled' [:disabled] = true end if .delete(:disabled) .delete(:method) .delete(:confirm) .delete(:onclick) [:class] << ' disabled' url = '#' end link_to name, url, end |
#current_theme ⇒ Object
102 103 104 105 106 107 |
# File 'lib/redmine/themes.rb', line 102 def current_theme unless instance_variable_defined?(:@current_theme) @current_theme = Redmine::Themes.theme(Setting.ui_theme) end @current_theme end |
#due_date_distance_in_words(date) ⇒ Object
184 185 186 187 188 |
# File 'app/helpers/application_helper.rb', line 184 def due_date_distance_in_words(date) if date l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date)) end end |
#favicon ⇒ Object
908 909 910 |
# File 'app/helpers/application_helper.rb', line 908 def favicon "<link rel='shortcut icon' href='#{image_path('/favicon.ico')}' />" end |
#format_activity_day(date) ⇒ Object
168 169 170 |
# File 'app/helpers/application_helper.rb', line 168 def format_activity_day(date) date == Date.today ? l(:label_today).titleize : format_date(date) end |
#format_activity_description(text) ⇒ Object
172 173 174 |
# File 'app/helpers/application_helper.rb', line 172 def format_activity_description(text) h(truncate(text.to_s, :length => 120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')).gsub(/[\r\n]+/, "<br />") end |
#format_activity_title(text) ⇒ Object
164 165 166 |
# File 'app/helpers/application_helper.rb', line 164 def format_activity_title(text) h(truncate_single_line(text, :length => 100)) end |
#format_version_name(version) ⇒ Object
176 177 178 179 180 181 182 |
# File 'app/helpers/application_helper.rb', line 176 def format_version_name(version) if version.project == @project h(version) else h("#{version.project} - #{version}") end end |
#has_content?(name) ⇒ Boolean
878 879 880 |
# File 'app/helpers/application_helper.rb', line 878 def has_content?(name) (@has_content && @has_content[name]) || false end |
#heads_for_theme ⇒ Object
Returns the header tags for the current theme
122 123 124 125 126 |
# File 'lib/redmine/themes.rb', line 122 def heads_for_theme if current_theme && current_theme.javascripts.include?('theme') javascript_include_tag current_theme.javascript_path('theme') end end |
#html_hours(text) ⇒ Object
309 310 311 |
# File 'app/helpers/application_helper.rb', line 309 def html_hours(text) text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>') end |
#html_title(*args) ⇒ Object
415 416 417 418 419 420 421 422 423 424 425 426 |
# File 'app/helpers/application_helper.rb', line 415 def html_title(*args) if args.empty? title = [] title << @project.name if @project title += @html_title if @html_title title << Setting.app_title title.select {|t| !t.blank? }.join(' - ') else @html_title ||= [] @html_title += args end end |
#image_to_function(name, function, html_options = {}) ⇒ Object
151 152 153 154 155 156 157 |
# File 'app/helpers/application_helper.rb', line 151 def image_to_function(name, function, = {}) .symbolize_keys! tag(:input, .merge({ :type => "image", :src => image_path(name), :onclick => ([:onclick] ? "#{[:onclick]}; " : "") + "#{function};" })) end |
#include_calendar_headers_tags ⇒ Object
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 |
# File 'app/helpers/application_helper.rb', line 848 def unless @calendar_headers_tags_included @calendar_headers_tags_included = true content_for :header_tags do start_of_week = case Setting.start_of_week.to_i when 1 'Calendar._FD = 1;' # Monday when 7 'Calendar._FD = 0;' # Sunday when 6 'Calendar._FD = 6;' # Saturday else '' # use language end javascript_include_tag('calendar/calendar') + javascript_include_tag("calendar/lang/calendar-#{current_language.to_s.downcase}.js") + javascript_tag(start_of_week) + javascript_include_tag('calendar/calendar-setup') + stylesheet_link_tag('calendar') end end end |
#include_in_api_response?(arg) ⇒ Boolean
Returns true if arg is expected in the API response
913 914 915 916 917 918 919 920 |
# File 'app/helpers/application_helper.rb', line 913 def include_in_api_response?(arg) unless @included_in_api_response param = params[:include] @included_in_api_response = param.is_a?(Array) ? param.collect(&:to_s) : param.to_s.split(',') @included_in_api_response.collect!(&:strip) end @included_in_api_response.include?(arg.to_s) end |
#javascript_heads ⇒ Object
Returns the javascript tags that are included in the html layout head
900 901 902 903 904 905 906 |
# File 'app/helpers/application_helper.rb', line 900 def javascript_heads = javascript_include_tag(:defaults) unless User.current.pref.warn_on_leaving_unsaved == '0' << "\n" + javascript_tag("Event.observe(window, 'load', function(){ new WarnLeavingUnsaved('#{escape_javascript( l(:text_warn_on_leaving_unsaved) )}'); });") end end |
#label_tag_for(name, option_tags = nil, options = {}) ⇒ Object
765 766 767 768 |
# File 'app/helpers/application_helper.rb', line 765 def label_tag_for(name, = nil, = {}) label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "") content_tag("label", label_text) end |
#labelled_tabular_form_for(name, object, options, &proc) ⇒ Object
770 771 772 773 774 |
# File 'app/helpers/application_helper.rb', line 770 def labelled_tabular_form_for(name, object, , &proc) [:html] ||= {} [:html][:class] = 'tabular' unless [:html].has_key?(:class) form_for(name, object, .merge({ :builder => TabularFormBuilder, :lang => current_language}), &proc) end |
#lang_options_for_select(blank = true) ⇒ Object
760 761 762 763 |
# File 'app/helpers/application_helper.rb', line 760 def (blank=true) (blank ? [["(auto)", ""]] : []) + valid_languages.collect{|lang| [ ll(lang.to_s, :general_lang_name), lang.to_s]}.sort{|x,y| x.last <=> y.last } end |
#link_to_attachment(attachment, options = {}) ⇒ Object
Generates a link to an attachment. Options:
-
:text - Link text (default to attachment filename)
-
:download - Force download (default: false)
95 96 97 98 99 100 |
# File 'app/helpers/application_helper.rb', line 95 def (, ={}) text = .delete(:text) || .filename action = .delete(:download) ? 'download' : 'show' link_to(h(text), {:controller => 'attachments', :action => action, :id => , :filename => .filename }, ) end |
#link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference) ⇒ Object
Display a link if user is authorized
40 41 42 |
# File 'app/helpers/application_helper.rb', line 40 def (name, = {}, = nil, *parameters_for_method_reference) link_to(name, , , *parameters_for_method_reference) if ([:controller] || params[:controller], [:action]) end |
#link_to_issue(issue, options = {}) ⇒ Object
Displays a link to issue
with its subject. Examples:
link_to_issue(issue) # => Defect #6: This is the subject
link_to_issue(issue, :truncate => 6) # => Defect #6: This i...
link_to_issue(issue, :subject => false) # => Defect #6
link_to_issue(issue, :project => true) # => Foo - Defect #6
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'app/helpers/application_helper.rb', line 72 def link_to_issue(issue, ={}) title = nil subject = nil if [:subject] == false title = truncate(issue.subject, :length => 60) else subject = issue.subject if [:truncate] subject = truncate(subject, :length => [:truncate]) end end s = link_to "#{issue.tracker} ##{issue.id}", {:controller => "issues", :action => "show", :id => issue}, :class => issue.css_classes, :title => title s << ": #{h subject}" if subject s = "#{h issue.project} - " + s if [:project] s end |
#link_to_message(message, options = {}, html_options = nil) ⇒ Object
Generates a link to a message
114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'app/helpers/application_helper.rb', line 114 def (, ={}, = nil) link_to( h(truncate(.subject, :length => 60)), { :controller => 'messages', :action => 'show', :board_id => .board_id, :id => .root, :r => (.parent_id && .id), :anchor => (.parent_id ? "message-#{.id}" : nil) }.merge(), ) end |
#link_to_project(project, options = {}, html_options = nil) ⇒ Object
Generates a link to a project if active Examples:
link_to_project(project) # => link to the specified project overview
link_to_project(project, :action=>'settings') # => link to project settings
link_to_project(project, {:only_path => false}, :class => "project") # => 3rd arg adds html options
link_to_project(project, {}, :class => "project") # => html options with default url (project overview)
135 136 137 138 139 140 141 142 |
# File 'app/helpers/application_helper.rb', line 135 def link_to_project(project, ={}, = nil) if project.active? url = {:controller => 'projects', :action => 'show', :id => project}.merge() link_to(h(project), url, ) else h(project) end end |
#link_to_remote_if_authorized(name, options = {}, html_options = nil) ⇒ Object
Display a link to remote if user is authorized
45 46 47 48 |
# File 'app/helpers/application_helper.rb', line 45 def (name, = {}, = nil) url = [:url] || {} link_to_remote(name, , ) if (url[:controller] || params[:controller], url[:action]) end |
#link_to_revision(revision, project, options = {}) ⇒ Object
Generates a link to a SCM revision Options:
-
:text - Link text (default to the formatted revision)
105 106 107 108 109 110 111 |
# File 'app/helpers/application_helper.rb', line 105 def link_to_revision(revision, project, ={}) text = .delete(:text) || format_revision(revision) rev = revision.respond_to?(:identifier) ? revision.identifier : revision link_to(text, {:controller => 'repositories', :action => 'revision', :id => project, :rev => rev}, :title => l(:label_revision_id, format_revision(revision))) end |
#link_to_user(user, options = {}) ⇒ Object
Displays a link to user’s account page if active
51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'app/helpers/application_helper.rb', line 51 def link_to_user(user, ={}) if user.is_a?(User) name = h(user.name([:format])) if user.active? link_to name, :controller => 'users', :action => 'show', :id => user else name end else h(user.to_s) end end |
#other_formats_links {|Redmine::Views::OtherFormatsBuilder.new(self)| ... } ⇒ Object
389 390 391 392 393 |
# File 'app/helpers/application_helper.rb', line 389 def other_formats_links(&block) concat('<p class="other-formats">' + l(:label_export_to)) yield Redmine::Views::OtherFormatsBuilder.new(self) concat('</p>') end |
#page_header_title ⇒ Object
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'app/helpers/application_helper.rb', line 395 def page_header_title if @project.nil? || @project.new_record? h(Setting.app_title) else b = [] ancestors = (@project.root? ? [] : @project.ancestors.visible) if ancestors.any? root = ancestors.shift b << link_to_project(root, {:jump => }, :class => 'root') if ancestors.size > 2 b << '…' ancestors = ancestors[-2, 2] end b += ancestors.collect {|p| link_to_project(p, {:jump => }, :class => 'ancestor') } end b << h(@project) b.join(' » ') end end |
#pagination_links_full(paginator, count = nil, options = {}) ⇒ Object
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'app/helpers/application_helper.rb', line 334 def pagination_links_full(paginator, count=nil, ={}) page_param = .delete(:page_param) || :page per_page_links = .delete(:per_page_links) url_param = params.dup # don't reuse query params if filters are present url_param.merge!(:fields => nil, :values => nil, :operators => nil) if url_param.delete(:set_filter) html = '' if paginator.current.previous html << link_to_remote_content_update('« ' + l(:label_previous), url_param.merge(page_param => paginator.current.previous)) + ' ' end html << (pagination_links_each(paginator, ) do |n| link_to_remote_content_update(n.to_s, url_param.merge(page_param => n)) end || '') if paginator.current.next html << ' ' + link_to_remote_content_update((l(:label_next) + ' »'), url_param.merge(page_param => paginator.current.next)) end unless count.nil? html << " (#{paginator.current.first_item}-#{paginator.current.last_item}/#{count})" if per_page_links != false && links = per_page_links(paginator.items_per_page) html << " | #{links}" end end html end |
#parse_headings(text, project, obj, attr, only_path, options) ⇒ Object
Headings and TOC Adds ids and links to headings unless options is set to false
707 708 709 710 711 712 713 714 715 716 717 |
# File 'app/helpers/application_helper.rb', line 707 def parse_headings(text, project, obj, attr, only_path, ) return if [:headings] == false text.gsub!(HEADING_RE) do level, attrs, content = $1.to_i, $2, $3 item = (content).strip anchor = item.gsub(%r{[^\w\s\-]}, '').gsub(%r{\s+(\-+\s*)?}, '-') @parsed_headings << [level, anchor, item] "<a name=\"#{anchor}\"></a>\n<h#{level} #{attrs}>#{content}<a href=\"##{anchor}\" class=\"wiki-anchor\">¶</a></h#{level}>" end end |
#parse_inline_attachments(text, project, obj, attr, only_path, options) ⇒ Object
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 |
# File 'app/helpers/application_helper.rb', line 511 def (text, project, obj, attr, only_path, ) # when using an image link, try to use an attachment, if possible if [:attachments] || (obj && obj.respond_to?(:attachments)) = nil text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m| filename, ext, alt, alttext = $1.downcase, $2, $3, $4 ||= ([:attachments] || obj.).sort_by(&:created_on).reverse # search for the picture in attachments if found = .detect { |att| att.filename.downcase == filename } image_url = url_for :only_path => only_path, :controller => 'attachments', :action => 'download', :id => found desc = found.description.to_s.gsub('"', '') if !desc.blank? && alttext.blank? alt = " title=\"#{desc}\" alt=\"#{desc}\"" end "src=\"#{image_url}\"#{alt}" else m end end end end |
#parse_non_pre_blocks(text) ⇒ Object
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'app/helpers/application_helper.rb', line 482 def parse_non_pre_blocks(text) s = StringScanner.new(text) = [] parsed = '' while !s.eos? s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im) text, full_tag, closing, tag = s[1], s[2], s[3], s[4] if .empty? yield text end parsed << text if tag if closing if .last == tag.downcase .pop end else << tag.downcase end parsed << full_tag end end # Close any non closing tags while tag = .pop parsed << "</#{tag}>" end parsed end |
#parse_redmine_links(text, project, obj, attr, only_path, options) ⇒ Object
Redmine links
Examples:
Issues:
#52 -> Link to issue #52
Changesets:
r52 -> Link to revision 52
commit:a85130f -> Link to scmid starting with a85130f
Documents:
document#17 -> Link to document with id 17
document:Greetings -> Link to the document with title "Greetings"
document:"Some document" -> Link to the document with title "Some document"
Versions:
version#3 -> Link to version with id 3
version:1.0.0 -> Link to version named "1.0.0"
version:"1.0 beta 2" -> Link to version named "1.0 beta 2"
Attachments:
attachment:file.zip -> Link to the attachment of the current object named file.zip
Source files:
source:some/file -> Link to the file located at /some/file in the project's repository
source:some/file@52 -> Link to the file's revision 52
source:some/file#L120 -> Link to line 120 of the file
source:some/file@52#L120 -> Link to line 120 of the file's revision 52
export:some/file -> Force the download of the file
Forum messages:
message#1218 -> Link to message with id 1218
Links can refer other objects from other projects, using project identifier:
identifier:r52
identifier:document:"Some document"
identifier:version:1.0.0
identifier:source:some/file
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
# File 'app/helpers/application_helper.rb', line 612 def parse_redmine_links(text, project, obj, attr, only_path, ) text.gsub!(%r{([\s\(,\-\[\>]|^)(!)?(([a-z0-9\-]+):)?(attachment|document|version|commit|source|export|message|project)?((#|r)(\d+)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]]\W)|,|\s|\]|<|$)}) do |m| leading, esc, project_prefix, project_identifier, prefix, sep, identifier = $1, $2, $3, $4, $5, $7 || $9, $8 || $10 link = nil if project_identifier project = Project.visible.find_by_identifier(project_identifier) end if esc.nil? if prefix.nil? && sep == 'r' # project.changesets.visible raises an SQL error because of a double join on repositories if project && project.repository && (changeset = Changeset.visible.find_by_repository_id_and_revision(project.repository.id, identifier)) link = link_to("#{project_prefix}r#{identifier}", {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.revision}, :class => 'changeset', :title => truncate_single_line(changeset.comments, :length => 100)) end elsif sep == '#' oid = identifier.to_i case prefix when nil if issue = Issue.visible.find_by_id(oid, :include => :status) link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid}, :class => issue.css_classes, :title => "#{truncate(issue.subject, :length => 100)} (#{issue.status.name})") end when 'document' if document = Document.visible.find_by_id(oid) link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document}, :class => 'document' end when 'version' if version = Version.visible.find_by_id(oid) link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version}, :class => 'version' end when 'message' if = Message.visible.find_by_id(oid, :include => :parent) link = (, {:only_path => only_path}, :class => 'message') end when 'project' if p = Project.visible.find_by_id(oid) link = link_to_project(p, {:only_path => only_path}, :class => 'project') end end elsif sep == ':' # removes the double quotes if any name = identifier.gsub(%r{^"(.*)"$}, "\\1") case prefix when 'document' if project && document = project.documents.visible.find_by_title(name) link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document}, :class => 'document' end when 'version' if project && version = project.versions.visible.find_by_name(name) link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version}, :class => 'version' end when 'commit' if project && project.repository && (changeset = Changeset.visible.find(:first, :conditions => ["repository_id = ? AND scmid LIKE ?", project.repository.id, "#{name}%"])) link = link_to h("#{project_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.identifier}, :class => 'changeset', :title => truncate_single_line(changeset.comments, :length => 100) end when 'source', 'export' if project && project.repository && User.current.allowed_to?(:browse_repository, project) name =~ %r{^[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?$} path, rev, anchor = $1, $3, $5 link = link_to h("#{project_prefix}#{prefix}:#{name}"), {:controller => 'repositories', :action => 'entry', :id => project, :path => to_path_param(path), :rev => rev, :anchor => anchor, :format => (prefix == 'export' ? 'raw' : nil)}, :class => (prefix == 'export' ? 'source download' : 'source') end when 'attachment' = [:attachments] || (obj && obj.respond_to?(:attachments) ? obj. : nil) if && = .detect {|a| a.filename == name } link = link_to h(.filename), {:only_path => only_path, :controller => 'attachments', :action => 'download', :id => }, :class => 'attachment' end when 'project' if p = Project.visible.find(:first, :conditions => ["identifier = :s OR LOWER(name) = :s", {:s => name.downcase}]) link = link_to_project(p, {:only_path => only_path}, :class => 'project') end end end end leading + (link || "#{project_prefix}#{prefix}#{sep}#{identifier}") end end |
#parse_wiki_links(text, project, obj, attr, only_path, options) ⇒ Object
Wiki links
Examples:
[[mypage]]
[[mypage|mytext]]
wiki links can refer other project wikis, using project name or identifier:
[[project:]] -> wiki starting page
[[project:|mytext]]
[[project:mypage]]
[[project:mypage|mytext]]
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 |
# File 'app/helpers/application_helper.rb', line 543 def parse_wiki_links(text, project, obj, attr, only_path, ) text.gsub!(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m| link_project = project esc, all, page, title = $1, $2, $3, $5 if esc.nil? if page =~ /^([^\:]+)\:(.*)$/ link_project = Project.find_by_identifier($1) || Project.find_by_name($1) page = $2 title ||= $1 if page.blank? end if link_project && link_project.wiki # extract anchor anchor = nil if page =~ /^(.+?)\#(.+)$/ page, anchor = $1, $2 end # check if page exists wiki_page = link_project.wiki.find_page(page) url = case [:wiki_links] when :local; "#{title}.html" when :anchor; "##{title}" # used for single-file wiki export else wiki_page_id = page.present? ? Wiki.titleize(page) : nil url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project, :id => wiki_page_id, :anchor => anchor) end link_to((title || page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new'))) else # project or wiki doesn't exist all end else all end end end |
#path_to_stylesheet(source) ⇒ Object
117 118 119 |
# File 'lib/redmine/themes.rb', line 117 def path_to_stylesheet(source) stylesheet_path source end |
#per_page_links(selected = nil) ⇒ Object
364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'app/helpers/application_helper.rb', line 364 def per_page_links(selected=nil) url_param = params.dup url_param.clear if url_param.has_key?(:set_filter) links = Setting..collect do |n| n == selected ? n : link_to_remote(n, {:update => "content", :url => params.dup.merge(:per_page => n), :method => :get}, {:href => url_for(url_param.merge(:per_page => n))}) end links.size > 1 ? l(:label_display_per_page, links.join(', ')) : nil end |
#principals_check_box_tags(name, principals) ⇒ Object
286 287 288 289 290 291 292 |
# File 'app/helpers/application_helper.rb', line 286 def (name, principals) s = '' principals.sort.each do |principal| s << "<label>#{ check_box_tag name, principal.id, false } #{h principal}</label>\n" end s end |
#progress_bar(pcts, options = {}) ⇒ Object
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 |
# File 'app/helpers/application_helper.rb', line 788 def (pcts, ={}) pcts = [pcts, pcts] unless pcts.is_a?(Array) pcts = pcts.collect(&:round) pcts[1] = pcts[1] - pcts[0] pcts << (100 - pcts[1] - pcts[0]) width = [:width] || '100px;' legend = [:legend] || '' content_tag('table', content_tag('tr', (pcts[0] > 0 ? content_tag('td', '', :style => "width: #{pcts[0]}%;", :class => 'closed') : '') + (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1]}%;", :class => 'done') : '') + (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2]}%;", :class => 'todo') : '') ), :class => 'progress', :style => "width: #{width};") + content_tag('p', legend, :class => 'pourcent') end |
#project_nested_ul(projects, &block) ⇒ Object
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'app/helpers/application_helper.rb', line 262 def project_nested_ul(projects, &block) s = '' if projects.any? ancestors = [] projects.sort_by(&:lft).each do |project| if (ancestors.empty? || project.is_descendant_of?(ancestors.last)) s << "<ul>\n" else ancestors.pop s << "</li>" while (ancestors.any? && !project.is_descendant_of?(ancestors.last)) ancestors.pop s << "</ul></li>\n" end end s << "<li>" s << yield(project).to_s ancestors << project end s << ("</li></ul>\n" * ancestors.size) end s end |
#project_tree(projects, &block) ⇒ Object
Yields the given block for each project with its level in the tree
Wrapper for Project#project_tree
258 259 260 |
# File 'app/helpers/application_helper.rb', line 258 def project_tree(projects, &block) Project.project_tree(projects, &block) end |
#project_tree_options_for_select(projects, options = {}) ⇒ Object
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'app/helpers/application_helper.rb', line 239 def (projects, = {}) s = '' project_tree(projects) do |project, level| name_prefix = (level > 0 ? (' ' * 2 * level + '» ') : '') = {:value => project.id} if project == [:selected] || ([:selected].respond_to?(:include?) && [:selected].include?(project)) [:selected] = 'selected' else [:selected] = nil end .merge!(yield(project)) if block_given? s << content_tag('option', name_prefix + h(project), ) end s end |
#prompt_to_remote(name, text, param, url, html_options = {}) ⇒ Object
159 160 161 162 |
# File 'app/helpers/application_helper.rb', line 159 def prompt_to_remote(name, text, param, url, = {}) [:onclick] = "promptToRemote('#{text}', '#{param}', '#{url_for(url)}'); return false;" link_to name, {}, end |
#render_flash_messages ⇒ Object
Renders flash messages
207 208 209 210 211 212 213 |
# File 'app/helpers/application_helper.rb', line 207 def s = '' flash.each do |k,v| s << content_tag('div', v, :class => "flash #{k}") end s end |
#render_page_hierarchy(pages, node = nil, options = {}) ⇒ Object
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'app/helpers/application_helper.rb', line 190 def render_page_hierarchy(pages, node=nil, ={}) content = '' if pages[node] content << "<ul class=\"pages-hierarchy\">\n" pages[node].each do |page| content << "<li>" content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title}, :title => ([:timestamp] && page.updated_on ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil)) content << "\n" + render_page_hierarchy(pages, page.id, ) if pages[page.id] content << "</li>\n" end content << "</ul>\n" end content end |
#render_project_jump_box ⇒ Object
Renders the project quick-jump box
225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'app/helpers/application_helper.rb', line 225 def render_project_jump_box projects = User.current.memberships.collect(&:project).compact.uniq if projects.any? s = '<select onchange="if (this.value != \'\') { window.location = this.value; }">' + "<option value=''>#{ l(:label_jump_to_a_project) }</option>" + '<option value="" disabled="disabled">---</option>' s << (projects, :selected => @project) do |p| { :value => url_for(:controller => 'projects', :action => 'show', :id => p, :jump => ) } end s << '</select>' s end end |
#render_tabs(tabs) ⇒ Object
Renders tabs and their content
216 217 218 219 220 221 222 |
# File 'app/helpers/application_helper.rb', line 216 def render_tabs(tabs) if tabs.any? render :partial => 'common/tabs', :locals => {:tabs => tabs} else content_tag 'p', l(:label_no_data), :class => "nodata" end end |
#reorder_links(name, url) ⇒ Object
377 378 379 380 381 382 |
# File 'app/helpers/application_helper.rb', line 377 def reorder_links(name, url) link_to(image_tag('2uparrow.png', :alt => l(:label_sort_highest)), url.merge({"#{name}[move_to]" => 'highest'}), :method => :post, :title => l(:label_sort_highest)) + link_to(image_tag('1uparrow.png', :alt => l(:label_sort_higher)), url.merge({"#{name}[move_to]" => 'higher'}), :method => :post, :title => l(:label_sort_higher)) + link_to(image_tag('1downarrow.png', :alt => l(:label_sort_lower)), url.merge({"#{name}[move_to]" => 'lower'}), :method => :post, :title => l(:label_sort_lower)) + link_to(image_tag('2downarrow.png', :alt => l(:label_sort_lowest)), url.merge({"#{name}[move_to]" => 'lowest'}), :method => :post, :title => l(:label_sort_lowest)) end |
#replace_toc(text, headings) ⇒ Object
Renders the TOC with given headings
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 |
# File 'app/helpers/application_helper.rb', line 722 def replace_toc(text, headings) text.gsub!(TOC_RE) do if headings.empty? '' else div_class = 'toc' div_class << ' right' if $1 == '>' div_class << ' left' if $1 == '<' out = "<ul class=\"#{div_class}\"><li>" root = headings.map(&:first).min current = root started = false headings.each do |level, anchor, item| if level > current out << '<ul><li>' * (level - current) elsif level < current out << "</li></ul>\n" * (current - level) + "</li><li>" elsif started out << '</li><li>' end out << "<a href=\"##{anchor}\">#{item}</a>" current = level started = true end out << '</li></ul>' * (current - root) out << '</li></ul>' end end end |
#simple_format_without_paragraph(text) ⇒ Object
Same as Rails’ simple_format helper without using paragraphs
753 754 755 756 757 758 |
# File 'app/helpers/application_helper.rb', line 753 def simple_format_without_paragraph(text) text.to_s. gsub(/\r\n?/, "\n"). # \r\n and \r -> \n gsub(/\n\n+/, "<br /><br />"). # 2+ newline -> 2 br gsub(/([^\n]\n)(?=[^\n])/, '\1<br />') # 1 newline -> br end |
#stylesheet_path(source) ⇒ Object
109 110 111 112 113 114 115 |
# File 'lib/redmine/themes.rb', line 109 def stylesheet_path(source) if current_theme && current_theme.stylesheets.include?(source) super current_theme.stylesheet_path(source) else super end end |
#syntax_highlight(name, content) ⇒ Object
326 327 328 |
# File 'app/helpers/application_helper.rb', line 326 def syntax_highlight(name, content) Redmine::SyntaxHighlighting.highlight_by_filename(content, name) end |
#textilizable(*args) ⇒ Object
Formats text according to system settings. 2 ways to call this method:
-
with a String: textilizable(text, options)
-
with an object and one of its attribute: textilizable(issue, :description, options)
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
# File 'app/helpers/application_helper.rb', line 449 def textilizable(*args) = args.last.is_a?(Hash) ? args.pop : {} case args.size when 1 obj = [:object] text = args.shift when 2 obj = args.shift attr = args.shift text = obj.send(attr).to_s else raise ArgumentError, 'invalid arguments to textilizable' end return '' if text.blank? project = [:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil) only_path = .delete(:only_path) == false ? false : true text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text, :object => obj, :attribute => attr) { |macro, args| exec_macro(macro, obj, args) } @parsed_headings = [] text = parse_non_pre_blocks(text) do |text| [:parse_inline_attachments, :parse_wiki_links, :parse_redmine_links, :parse_headings].each do |method_name| send method_name, text, project, obj, attr, only_path, end end if @parsed_headings.any? replace_toc(text, @parsed_headings) end text end |
#time_tag(time) ⇒ Object
317 318 319 320 321 322 323 324 |
# File 'app/helpers/application_helper.rb', line 317 def time_tag(time) text = distance_of_time_in_words(Time.now, time) if @project link_to(text, {:controller => 'activities', :action => 'index', :id => @project, :from => time.to_date}, :title => format_time(time)) else content_tag('acronym', text, :title => format_time(time)) end end |
#to_path_param(path) ⇒ Object
330 331 332 |
# File 'app/helpers/application_helper.rb', line 330 def to_path_param(path) path.to_s.split(%r{[/\\]}).select {|p| !p.blank?} end |
#toggle_link(name, id, options = {}) ⇒ Object
144 145 146 147 148 149 |
# File 'app/helpers/application_helper.rb', line 144 def toggle_link(name, id, ={}) onclick = "Element.toggle('#{id}'); " onclick << ([:focus] ? "Form.Element.focus('#{[:focus]}'); " : "this.blur(); ") onclick << "return false;" link_to(name, "#", :onclick => onclick) end |
#truncate_lines(string, options = {}) ⇒ Object
Truncates at line break after 250 characters or options
300 301 302 303 304 305 306 307 |
# File 'app/helpers/application_helper.rb', line 300 def truncate_lines(string, ={}) length = [:length] || 250 if string.to_s =~ /\A(.{#{length}}.*?)$/m "#{$1}..." else string end end |
#truncate_single_line(string, *args) ⇒ Object
Truncates and returns the string as a single line
295 296 297 |
# File 'app/helpers/application_helper.rb', line 295 def truncate_single_line(string, *args) truncate(string.to_s, *args).gsub(%r{[\r\n]+}m, ' ') end |