Read about our upcoming Code of Conduct on this issue

application_helper.rb 8.71 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
Steven Thonus's avatar
Steven Thonus committed
80
    else
Jan-Gerd Tenberge's avatar
Jan-Gerd Tenberge committed
81
      gravatar_icon(user_or_email, size, scale)
Steven Thonus's avatar
Steven Thonus committed
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
105
  # Define whenever show last push event
  # with suggestion to create MR
randx's avatar
randx committed
106
  def show_last_push_widget?(event)
107
108
109
110
111
112
    # 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
Felipe Artur's avatar
Felipe Artur committed
113
    return false unless project && !project.empty_repo? && project.feature_available?(:merge_requests, current_user)
114
115
116
117

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

118
    # Skip if user removed branch right after that
Paco Guzman's avatar
Paco Guzman committed
119
    return false unless project.repository.branch_exists?(event.branch_name)
120

121
    true
randx's avatar
randx committed
122
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
123

124
125
126
  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
127

128
  def simple_sanitize(str)
129
130
131
    sanitize(str, tags: %w(a span))
  end

132
  def body_data_page
133
134
135
    path = controller.controller_path.split('/')
    namespace = path.first if path.second

136
    [namespace, controller.controller_name, controller.action_name].compact.join(':')
137
  end
138
139
140
141
142
143
144
145
146
147

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

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

149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
  # 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
166
167
168
169
170
  def time_ago_with_tooltip(time, placement: 'top', html_class: '', skip_js: false, short_format: false)
    css_classes = short_format ? 'js-short-timeago' : 'js-timeago'
    css_classes << " #{html_class}" unless html_class.blank?
    css_classes << ' js-timeago-pending' unless skip_js

171
    element = content_tag :time, time.to_s,
172
      class: css_classes,
173
      datetime: time.to_time.getutc.iso8601,
Alfredo Sumaran's avatar
Alfredo Sumaran committed
174
      title: time.to_time.in_time_zone.to_s(:medium),
175
      data: { toggle: 'tooltip', placement: placement, container: 'body' }
176

177
178
179
180
181
    unless skip_js
      element << javascript_tag(
        "$('.js-timeago-pending').removeClass('js-timeago-pending').timeago()"
      )
    end
182
183

    element
184
  end
185

Phil Hughes's avatar
Phil Hughes committed
186
187
  def edited_time_ago_with_tooltip(object, placement: 'top', html_class: 'time_ago', include_author: false)
    return if object.updated_at == object.created_at
Phil Hughes's avatar
Phil Hughes committed
188
189

    content_tag :small, class: "edited-text" do
Phil Hughes's avatar
Phil Hughes committed
190
191
      output = content_tag(:span, "Edited ")
      output << time_ago_with_tooltip(object.updated_at, placement: placement, html_class: html_class)
Phil Hughes's avatar
Phil Hughes committed
192

Phil Hughes's avatar
Phil Hughes committed
193
194
195
      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)
Phil Hughes's avatar
Phil Hughes committed
196
197
198
199
200
201
      end

      output
    end
  end

202
  def render_markup(file_name, file_content)
203
    if gitlab_markdown?(file_name)
connorshea's avatar
connorshea committed
204
      Hamlit::RailsHelpers.preserve(markdown(file_content))
205
    elsif asciidoc?(file_name)
206
      asciidoc(file_content)
207
208
209
210
    elsif plain?(file_name)
      content_tag :pre, class: 'plain-readme' do
        file_content
      end
211
    else
212
      other_markup(file_name, file_content)
213
    end
214
215
  rescue RuntimeError
    simple_format(file_content)
216
  end
217

218
219
220
221
  def plain?(filename)
    Gitlab::MarkupHelper.plain?(filename)
  end

222
  def markup?(filename)
223
    Gitlab::MarkupHelper.markup?(filename)
224
225
226
  end

  def gitlab_markdown?(filename)
227
    Gitlab::MarkupHelper.gitlab_markdown?(filename)
228
229
  end

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

234
235
236
237
238
239
240
  def promo_host
    'about.gitlab.com'
  end

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

242
243
  def page_filter_path(options = {})
    without = options.delete(:without)
Arinde Eniola's avatar
Arinde Eniola committed
244
    add_label = options.delete(:label)
245

246
247
248
    exist_opts = {
      state: params[:state],
      scope: params[:scope],
249
      milestone_title: params[:milestone_title],
250
251
      assignee_id: params[:assignee_id],
      author_id: params[:author_id],
Phil Hughes's avatar
Phil Hughes committed
252
253
      issue_search: params[:issue_search],
      label_name: params[:label_name]
254
255
256
257
    }

    options = exist_opts.merge(options)

258
259
260
261
262
263
    if without.present?
      without.each do |key|
        options.delete(key)
      end
    end

Phil Hughes's avatar
Phil Hughes committed
264
    params = options.compact
Phil Hughes's avatar
Phil Hughes committed
265

Phil Hughes's avatar
Phil Hughes committed
266
    params.delete(:label_name) unless add_label
Phil Hughes's avatar
Phil Hughes committed
267

Phil Hughes's avatar
Phil Hughes committed
268
    "#{request.path}?#{params.to_param}"
269
  end
270
271
272
273

  def outdated_browser?
    browser.ie? && browser.version.to_i < 10
  end
274
275
276
277
278
279
280
281

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

283
  def state_filters_text_for(entity, project)
284
    titles = {
285
      opened: "Open"
286
    }
287

288
    entity_title = titles[entity] || entity.to_s.humanize
289
290

    count =
291
      if project.nil?
292
        nil
293
      elsif current_controller?(:issues)
294
        project.issues.visible_to_user(current_user).send(entity).count
295
      elsif current_controller?(:merge_requests)
296
        project.merge_requests.send(entity).count
297
      end
298

299
    html = content_tag :span, entity_title
300
301

    if count.present?
302
      html += " "
303
304
305
306
      html += content_tag :span, number_with_delimiter(count), class: 'badge'
    end

    html.html_safe
307
  end
308
309
310
311

  def truncate_first_line(message, length = 50)
    truncate(message.each_line.first.chomp, length: length) if message
  end
312
313
314
315
316
317
318
319
320
321
322

  # While similarly named to Rails's `link_to_if`, this method behaves quite differently.
  # If `condition` is truthy, a link will be returned with the result of the block
  # as its body. If `condition` is falsy, only the result of the block will be returned.
  def conditional_link_to(condition, options, html_options = {}, &block)
    if condition
      link_to options, html_options, &block
    else
      capture(&block)
    end
  end
Phil Hughes's avatar
Phil Hughes committed
323
324
325
326

  def page_class
    "issue-boards-page" if current_controller?(:boards)
  end
gitlabhq's avatar
gitlabhq committed
327
end