application_helper.rb 8.39 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
      else
40
        Project.find_by_full_path(project_id)
41 42
      end

sue445's avatar
sue445 committed
43
    if project.avatar_url
44 45 46 47 48 49
      if project.private?
        options[:use_original_source] = true
        image_tag project.avatar_url(use_asset_path: false), options
      else
        image_tag project.avatar_url, options
      end
50 51 52 53 54 55
    else # generated icon
      project_identicon(project, options)
    end
  end

  def project_identicon(project, options = {})
56 57 58 59 60 61 62 63 64 65
    allowed_colors = {
      red: 'FFEBEE',
      purple: 'F3E5F5',
      indigo: 'E8EAF6',
      blue: 'E3F2FD',
      teal: 'E0F2F1',
      orange: 'FBE9E7',
      gray: 'EEEEEE'
    }

66 67
    options[:class] ||= ''
    options[:class] << ' identicon'
68
    bg_key = project.id % 7
Gabriel Mazetto's avatar
Gabriel Mazetto committed
69
    style = "background-color: ##{allowed_colors.values[bg_key]}; color: #555"
70

71
    content_tag(:div, class: options[:class], style: style) do
72
      project.name[0, 1].upcase
73 74 75
    end
  end

76
  def avatar_icon(user_or_email = nil, size = nil, scale = 2, only_path: true)
Douwe Maan's avatar
Douwe Maan committed
77 78 79 80 81 82
    user =
      if user_or_email.is_a?(User)
        user_or_email
      else
        User.find_by_any_email(user_or_email.try(:downcase))
      end
83 84

    if user
85
      user.avatar_url(size: size, only_path: only_path) || default_avatar
86
    else
Jan-Gerd Tenberge's avatar
Jan-Gerd Tenberge committed
87
      gravatar_icon(user_or_email, size, scale)
88 89 90
    end
  end

91 92
  def gravatar_icon(user_email = '', size = nil, scale = 2)
    GravatarService.new.execute(user_email, size, scale) ||
93 94
      default_avatar
  end
95

96
  def default_avatar
97
    'no_avatar.png'
gitlabhq's avatar
gitlabhq committed
98 99 100
  end

  def last_commit(project)
Nihad Abbasov's avatar
Nihad Abbasov committed
101
    if project.repo_exists?
102
      time_ago_with_tooltip(project.repository.commit.committed_date)
Nihad Abbasov's avatar
Nihad Abbasov committed
103
    else
104
      'Never'
gitlabhq's avatar
gitlabhq committed
105
    end
106
  rescue
107
    'Never'
gitlabhq's avatar
gitlabhq committed
108 109
  end

110 111
  # Define whenever show last push event
  # with suggestion to create MR
randx's avatar
randx committed
112
  def show_last_push_widget?(event)
113 114 115 116 117 118
    # 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
119
    return false unless project && !project.empty_repo? && project.feature_available?(:merge_requests, current_user)
120 121 122 123

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

124
    # Skip if user removed branch right after that
125
    return false unless project.repository.branch_exists?(event.branch_name)
126

127
    true
randx's avatar
randx committed
128
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
129

130 131 132
  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
133

134
  def simple_sanitize(str)
135 136 137
    sanitize(str, tags: %w(a span))
  end

138
  def body_data_page
139
    [*controller.controller_path.split('/'), controller.action_name].compact.join(':')
140
  end
141 142 143 144 145 146 147 148 149 150

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

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

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

Bob Van Landuyt's avatar
Bob Van Landuyt committed
172
    element = content_tag :time, l(time, format: "%b %d, %Y"),
173
      class: css_classes,
174
      title: l(time.to_time.in_time_zone, format: :timeago_tooltip),
175 176 177 178 179 180
      datetime: time.to_time.getutc.iso8601,
      data: {
        toggle: 'tooltip',
        placement: placement,
        container: 'body'
      }
181 182

    element
183
  end
184

blackst0ne's avatar
blackst0ne committed
185
  def edited_time_ago_with_tooltip(object, placement: 'top', html_class: 'time_ago', exclude_author: false)
186
    return unless object.edited?
187

188 189 190
    content_tag :small, class: 'edited-text' do
      output = content_tag(:span, 'Edited ')
      output << time_ago_with_tooltip(object.last_edited_at, placement: placement, html_class: html_class)
191

blackst0ne's avatar
blackst0ne committed
192
      if !exclude_author && object.last_edited_by
193 194
        output << content_tag(:span, ' by ')
        output << link_to_member(object.project, object.last_edited_by, avatar: false, author_class: nil)
195 196 197 198 199 200
      end

      output
    end
  end

201 202 203 204 205 206 207
  def promo_host
    'about.gitlab.com'
  end

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

209
  def support_url
210
    Gitlab::CurrentSettings.current_application_settings.help_page_support_url.presence || promo_url + '/getting-help/'
211 212
  end

213 214
  def page_filter_path(options = {})
    without = options.delete(:without)
Arinde Eniola's avatar
Arinde Eniola committed
215
    add_label = options.delete(:label)
216

217 218 219
    exist_opts = {
      state: params[:state],
      scope: params[:scope],
220
      milestone_title: params[:milestone_title],
221
      assignee_id: params[:assignee_id],
222
      assignee_username: params[:assignee_username],
223
      author_id: params[:author_id],
224
      author_username: params[:author_username],
barthc's avatar
barthc committed
225
      search: params[:search],
226
      label_name: params[:label_name]
227 228 229 230
    }

    options = exist_opts.merge(options)

231 232 233 234 235 236
    if without.present?
      without.each do |key|
        options.delete(key)
      end
    end

Phil Hughes's avatar
Phil Hughes committed
237
    params = options.compact
238

239
    params.delete(:label_name) unless add_label
240

241
    "#{request.path}?#{params.to_param}"
242
  end
243 244 245 246

  def outdated_browser?
    browser.ie? && browser.version.to_i < 10
  end
247 248 249 250 251 252 253 254

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

256 257 258
  def truncate_first_line(message, length = 50)
    truncate(message.each_line.first.chomp, length: length) if message
  end
259 260 261 262 263 264 265 266 267 268 269

  # 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
270 271

  def page_class
272 273 274 275 276
    class_names = []
    class_names << 'issue-boards-page' if current_controller?(:boards)
    class_names << 'with-performance-bar' if performance_bar_enabled?

    class_names
Phil Hughes's avatar
Phil Hughes committed
277
  end
Semyon Pupkov's avatar
Semyon Pupkov committed
278 279 280 281 282 283 284 285 286

  # Returns active css class when condition returns true
  # otherwise returns nil.
  #
  # Example:
  #   %li{ class: active_when(params[:filter] == '1') }
  def active_when(condition)
    'active' if condition
  end
287

288 289
  def show_callout?(name)
    cookies[name] != 'true'
290
  end
291 292 293

  def linkedin_url(user)
    name = user.linkedin
Tim Zallmann's avatar
Tim Zallmann committed
294
    if name =~ %r{\Ahttps?:\/\/(www\.)?linkedin\.com\/in\/}
295 296 297 298 299 300
      name
    else
      "https://www.linkedin.com/in/#{name}"
    end
  end

301
  def twitter_url(user)
302
    name = user.twitter
Tim Zallmann's avatar
Tim Zallmann committed
303
    if name =~ %r{\Ahttps?:\/\/(www\.)?twitter\.com\/}
304 305 306 307 308
      name
    else
      "https://www.twitter.com/#{name}"
    end
  end
Phil Hughes's avatar
Phil Hughes committed
309

310 311 312
  def collapsed_sidebar?
    cookies["sidebar_collapsed"] == "true"
  end
313

314
  def show_new_repo?
315
    cookies["new_repo"] == "true" && body_data_page != 'projects:show'
316
  end
gitlabhq's avatar
gitlabhq committed
317
end