BigW Consortium Gitlab

application_helper.rb 8.31 KB
Newer Older
gitlabhq committed
1
require 'digest/md5'
2
require 'uri'
3

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 committed
21
  # Check if a particular action is the current one
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

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
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

71
  def avatar_icon(user_or_email = nil, size = nil, scale = 2, only_path: true)
Douwe Maan committed
72 73 74 75 76 77
    user =
      if user_or_email.is_a?(User)
        user_or_email
      else
        User.find_by_any_email(user_or_email.try(:downcase))
      end
78 79

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

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

91
  def default_avatar
92
    'no_avatar.png'
gitlabhq committed
93 94 95
  end

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

105 106
  # Define whenever show last push event
  # with suggestion to create MR
randx committed
107
  def show_last_push_widget?(event)
108 109 110 111 112 113
    # 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
114
    return false unless project && !project.empty_repo? && project.feature_available?(:merge_requests, current_user)
115 116 117 118

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

119
    # Skip if user removed branch right after that
120
    return false unless project.repository.branch_exists?(event.branch_name)
121

122
    true
randx committed
123
  end
124

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

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

133
  def body_data_page
134
    [*controller.controller_path.split('/'), controller.action_name].compact.join(':')
135
  end
136 137 138 139 140 141 142 143 144 145

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

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

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

167
    element = content_tag :time, l(time, format: "%b %d, %Y"),
168
      class: css_classes,
169
      title: l(time.to_time.in_time_zone, format: :timeago_tooltip),
170 171 172 173 174 175
      datetime: time.to_time.getutc.iso8601,
      data: {
        toggle: 'tooltip',
        placement: placement,
        container: 'body'
      }
176 177

    element
178
  end
179

180
  def edited_time_ago_with_tooltip(object, placement: 'top', html_class: 'time_ago', exclude_author: false)
181
    return unless object.edited?
182

183 184 185
    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)
186

187
      if !exclude_author && object.last_edited_by
188 189
        output << content_tag(:span, ' by ')
        output << link_to_member(object.project, object.last_edited_by, avatar: false, author_class: nil)
190 191 192 193 194 195
      end

      output
    end
  end

196 197 198 199 200 201 202
  def promo_host
    'about.gitlab.com'
  end

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

204
  def support_url
205
    Gitlab::CurrentSettings.current_application_settings.help_page_support_url.presence || promo_url + '/getting-help/'
206 207
  end

208 209
  def page_filter_path(options = {})
    without = options.delete(:without)
Arinde Eniola committed
210
    add_label = options.delete(:label)
211

212 213 214
    exist_opts = {
      state: params[:state],
      scope: params[:scope],
215
      milestone_title: params[:milestone_title],
216
      assignee_id: params[:assignee_id],
217
      assignee_username: params[:assignee_username],
218
      author_id: params[:author_id],
219
      author_username: params[:author_username],
barthc committed
220
      search: params[:search],
221
      label_name: params[:label_name]
222 223 224 225
    }

    options = exist_opts.merge(options)

226 227 228 229 230 231
    if without.present?
      without.each do |key|
        options.delete(key)
      end
    end

Phil Hughes committed
232
    params = options.compact
233

234
    params.delete(:label_name) unless add_label
235

236
    "#{request.path}?#{params.to_param}"
237
  end
238 239 240 241

  def outdated_browser?
    browser.ie? && browser.version.to_i < 10
  end
242 243 244 245 246 247 248 249

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

251 252 253
  def truncate_first_line(message, length = 50)
    truncate(message.each_line.first.chomp, length: length) if message
  end
254 255 256 257 258 259 260 261 262 263 264

  # 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 committed
265 266

  def page_class
267 268 269 270 271
    class_names = []
    class_names << 'issue-boards-page' if current_controller?(:boards)
    class_names << 'with-performance-bar' if performance_bar_enabled?

    class_names
Phil Hughes committed
272
  end
Semyon Pupkov committed
273 274 275 276 277 278 279 280 281

  # 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
282

283 284
  def show_callout?(name)
    cookies[name] != 'true'
285
  end
286 287 288

  def linkedin_url(user)
    name = user.linkedin
Tim Zallmann committed
289
    if name =~ %r{\Ahttps?:\/\/(www\.)?linkedin\.com\/in\/}
290 291 292 293 294 295
      name
    else
      "https://www.linkedin.com/in/#{name}"
    end
  end

296
  def twitter_url(user)
297
    name = user.twitter
Tim Zallmann committed
298
    if name =~ %r{\Ahttps?:\/\/(www\.)?twitter\.com\/}
299 300 301 302 303
      name
    else
      "https://www.twitter.com/#{name}"
    end
  end
Phil Hughes committed
304

305 306 307
  def collapsed_sidebar?
    cookies["sidebar_collapsed"] == "true"
  end
308

309
  def show_new_repo?
310
    cookies["new_repo"] == "true" && body_data_page != 'projects:show'
311
  end
312 313 314 315

  def locale_path
    asset_path("locale/#{Gitlab::I18n.locale}/app.js")
  end
gitlabhq committed
316
end