application_helper.rb 8.53 KB
Newer Older
gitlabhq's avatar
gitlabhq committed
1
require 'digest/md5'
Sergey Linnik's avatar
Sergey Linnik committed
2
require 'uri'
Robert Speicher's avatar
Robert Speicher committed
3

gitlabhq's avatar
gitlabhq committed
4
module ApplicationHelper
5 6
  # Check if a particular controller is the current one
  #
7 8
  # args - One or more controller names to check
  #
9 10 11
  # Examples
  #
  #   # On TreeController
12 13 14 15
  #   current_controller?(:tree)           # => true
  #   current_controller?(:commits)        # => false
  #   current_controller?(:commits, :tree) # => true
  def current_controller?(*args)
16 17 18
    args.any? do |v|
      v.to_s.downcase == controller.controller_name || v.to_s.downcase == controller.controller_path
    end
19 20
  end

Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
21
  # Check if a particular action is the current one
Robert Speicher's avatar
Robert Speicher committed
22 23 24 25 26 27 28 29 30 31 32 33 34
  #
  # args - One or more action names to check
  #
  # Examples
  #
  #   # On Projects#new
  #   current_action?(:new)           # => true
  #   current_action?(:create)        # => false
  #   current_action?(:new, :create)  # => true
  def current_action?(*args)
    args.any? { |v| v.to_s.downcase == action_name }
  end

35
  def project_icon(project_id, options = {})
36 37
    project =
      if project_id.is_a?(Project)
38
        project_id
39 40 41 42
      else
        Project.find_with_namespace(project_id)
      end

sue445's avatar
sue445 committed
43 44
    if project.avatar_url
      image_tag project.avatar_url, options
45 46 47 48 49 50
    else # generated icon
      project_identicon(project, options)
    end
  end

  def project_identicon(project, options = {})
51 52 53 54 55 56 57 58 59 60
    allowed_colors = {
      red: 'FFEBEE',
      purple: 'F3E5F5',
      indigo: 'E8EAF6',
      blue: 'E3F2FD',
      teal: 'E0F2F1',
      orange: 'FBE9E7',
      gray: 'EEEEEE'
    }

61 62
    options[:class] ||= ''
    options[:class] << ' identicon'
63
    bg_key = project.id % 7
Gabriel Mazetto's avatar
Gabriel Mazetto committed
64
    style = "background-color: ##{allowed_colors.values[bg_key]}; color: #555"
65

66
    content_tag(:div, class: options[:class], style: style) do
67
      project.name[0, 1].upcase
68 69 70
    end
  end

Jan-Gerd Tenberge's avatar
Jan-Gerd Tenberge committed
71
  def avatar_icon(user_or_email = nil, size = nil, scale = 2)
72 73 74
    if user_or_email.is_a?(User)
      user = user_or_email
    else
75
      user = User.find_by_any_email(user_or_email.try(:downcase))
76
    end
77 78 79

    if user
      user.avatar_url(size) || default_avatar
80
    else
Jan-Gerd Tenberge's avatar
Jan-Gerd Tenberge committed
81
      gravatar_icon(user_or_email, size, scale)
82 83 84
    end
  end

85 86
  def gravatar_icon(user_email = '', size = nil, scale = 2)
    GravatarService.new.execute(user_email, size, scale) ||
87 88
      default_avatar
  end
89

90
  def default_avatar
91
    'no_avatar.png'
gitlabhq's avatar
gitlabhq committed
92 93 94
  end

  def last_commit(project)
Nihad Abbasov's avatar
Nihad Abbasov committed
95
    if project.repo_exists?
96
      time_ago_with_tooltip(project.repository.commit.committed_date)
Nihad Abbasov's avatar
Nihad Abbasov committed
97
    else
98
      'Never'
gitlabhq's avatar
gitlabhq committed
99
    end
100
  rescue
101
    'Never'
gitlabhq's avatar
gitlabhq committed
102 103
  end

104
  def grouped_options_refs
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
105 106
    repository = @project.repository

gitlabhq's avatar
gitlabhq committed
107
    options = [
108 109
      ['Branches', repository.branch_names],
      ['Tags', VersionSorter.rsort(repository.tag_names)]
gitlabhq's avatar
gitlabhq committed
110 111
    ]

112
    # If reference is commit id - we should add it to branch/tag selectbox
113
    if @ref && !options.flatten.include?(@ref) && @ref =~ /\A[0-9a-zA-Z]{6,52}\z/
114
      options << ['Commit', [@ref]]
115 116
    end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
117
    grouped_options_for_select(options, @ref || @project.default_branch)
gitlabhq's avatar
gitlabhq committed
118 119
  end

120 121
  # Define whenever show last push event
  # with suggestion to create MR
randx's avatar
randx committed
122
  def show_last_push_widget?(event)
123 124 125 126 127 128 129 130 131 132 133
    # Skip if event is not about added or modified non-master branch
    return false unless event && event.last_push_to_non_root? && !event.rm_ref?

    project = event.project

    # Skip if project repo is empty or MR disabled
    return false unless project && !project.empty_repo? && project.merge_requests_enabled

    # Skip if user already created appropriate MR
    return false if project.merge_requests.where(source_branch: event.branch_name).opened.any?

134 135 136
    # Skip if user removed branch right after that
    return false unless project.repository.branch_names.include?(event.branch_name)

137
    true
randx's avatar
randx committed
138
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
139

140 141 142
  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
143

144
  def simple_sanitize(str)
145 146 147
    sanitize(str, tags: %w(a span))
  end

148
  def body_data_page
149 150 151
    path = controller.controller_path.split('/')
    namespace = path.first if path.second

152
    [namespace, controller.controller_name, controller.action_name].compact.join(':')
153
  end
154 155 156 157 158 159 160 161 162 163

  # shortcut for gitlab config
  def gitlab_config
    Gitlab.config.gitlab
  end

  # shortcut for gitlab extra config
  def extra_config
    Gitlab.config.extra
  end
164

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
  # Render a `time` element with Javascript-based relative date and tooltip
  #
  # time       - Time object
  # placement  - Tooltip placement String (default: "top")
  # html_class - Custom class for `time` element (default: "time_ago")
  # skip_js    - When true, exclude the `script` tag (default: false)
  #
  # By default also includes a `script` element with Javascript necessary to
  # initialize the `timeago` jQuery extension. If this method is called many
  # times, for example rendering hundreds of commits, it's advisable to disable
  # this behavior using the `skip_js` argument and re-initializing `timeago`
  # manually once all of the elements have been rendered.
  #
  # A `js-timeago` class is always added to the element, even when a custom
  # `html_class` argument is provided.
  #
  # Returns an HTML-safe String
  def time_ago_with_tooltip(time, placement: 'top', html_class: 'time_ago', skip_js: false)
    element = content_tag :time, time.to_s,
184
      class: "#{html_class} js-timeago #{"js-timeago-pending" unless skip_js}",
185
      datetime: time.to_time.getutc.iso8601,
186
      title: time.to_time.in_time_zone.to_s(:medium),
187
      data: { toggle: 'tooltip', placement: placement, container: 'body' }
188

189 190 191 192 193
    unless skip_js
      element << javascript_tag(
        "$('.js-timeago-pending').removeClass('js-timeago-pending').timeago()"
      )
    end
194 195

    element
196
  end
197

198 199
  def edited_time_ago_with_tooltip(object, placement: 'top', html_class: 'time_ago', include_author: false)
    return if object.updated_at == object.created_at
200 201

    content_tag :small, class: "edited-text" do
202 203
      output = content_tag(:span, "Edited ")
      output << time_ago_with_tooltip(object.updated_at, placement: placement, html_class: html_class)
204

Phil Hughes's avatar
Phil Hughes committed
205 206 207
      if include_author && object.updated_by && object.updated_by != object.author
        output << content_tag(:span, " by ")
        output << link_to_member(object.project, object.updated_by, avatar: false, author_class: nil)
208 209 210 211 212 213
      end

      output
    end
  end

214
  def render_markup(file_name, file_content)
215 216 217
    if gitlab_markdown?(file_name)
      Haml::Helpers.preserve(markdown(file_content))
    elsif asciidoc?(file_name)
218
      asciidoc(file_content)
219 220 221 222
    elsif plain?(file_name)
      content_tag :pre, class: 'plain-readme' do
        file_content
      end
223
    else
224
      other_markup(file_name, file_content)
225
    end
226 227
  rescue RuntimeError
    simple_format(file_content)
228
  end
229

230 231 232 233
  def plain?(filename)
    Gitlab::MarkupHelper.plain?(filename)
  end

234
  def markup?(filename)
235
    Gitlab::MarkupHelper.markup?(filename)
236 237 238
  end

  def gitlab_markdown?(filename)
239
    Gitlab::MarkupHelper.gitlab_markdown?(filename)
240 241
  end

242
  def asciidoc?(filename)
243
    Gitlab::MarkupHelper.asciidoc?(filename)
244 245
  end

246 247 248 249 250 251 252
  def promo_host
    'about.gitlab.com'
  end

  def promo_url
    'https://' + promo_host
  end
253

254 255
  def page_filter_path(options = {})
    without = options.delete(:without)
Arinde Eniola's avatar
Arinde Eniola committed
256
    add_label = options.delete(:label)
257

258 259 260
    exist_opts = {
      state: params[:state],
      scope: params[:scope],
261
      milestone_title: params[:milestone_title],
262 263 264
      assignee_id: params[:assignee_id],
      author_id: params[:author_id],
      sort: params[:sort],
265 266
      issue_search: params[:issue_search],
      label_name: params[:label_name]
267 268 269 270
    }

    options = exist_opts.merge(options)

271 272 273 274 275 276
    if without.present?
      without.each do |key|
        options.delete(key)
      end
    end

Phil Hughes's avatar
Phil Hughes committed
277
    params = options.compact
278

279
    params.delete(:label_name) unless add_label
280

281
    "#{request.path}?#{params.to_param}"
282
  end
283 284 285 286

  def outdated_browser?
    browser.ie? && browser.version.to_i < 10
  end
287 288 289 290 291 292 293 294

  def path_to_key(key, admin = false)
    if admin
      admin_user_key_path(@user, key)
    else
      profile_key_path(key)
    end
  end
295

296
  def state_filters_text_for(entity, project)
297
    titles = {
298
      opened: "Open"
299
    }
300

301
    entity_title = titles[entity] || entity.to_s.humanize
302 303

    count =
304
      if project.nil?
305
        nil
306
      elsif current_controller?(:issues)
307
        project.issues.visible_to_user(current_user).send(entity).count
308
      elsif current_controller?(:merge_requests)
309
        project.merge_requests.send(entity).count
310
      end
311

312
    html = content_tag :span, entity_title
313 314

    if count.present?
315
      html += " "
316 317 318 319
      html += content_tag :span, number_with_delimiter(count), class: 'badge'
    end

    html.html_safe
320
  end
321 322 323 324

  def truncate_first_line(message, length = 50)
    truncate(message.each_line.first.chomp, length: length) if message
  end
gitlabhq's avatar
gitlabhq committed
325
end