application_helper.rb 7.96 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 38 39 40 41 42
    project =
      if project_id.is_a?(Project)
        project = project_id
      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
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_email = '', size = nil)
skv's avatar
skv committed
72
    user = User.find_by(email: user_email)
73 74 75

    if user
      user.avatar_url(size) || default_avatar
76 77 78 79 80
    else
      gravatar_icon(user_email, size)
    end
  end

81
  def gravatar_icon(user_email = '', size = nil)
82 83 84
    GravatarService.new.execute(user_email, size) ||
      default_avatar
  end
85

86
  def default_avatar
87
    'no_avatar.png'
gitlabhq's avatar
gitlabhq committed
88 89 90
  end

  def last_commit(project)
Nihad Abbasov's avatar
Nihad Abbasov committed
91
    if project.repo_exists?
92
      time_ago_with_tooltip(project.repository.commit.committed_date)
Nihad Abbasov's avatar
Nihad Abbasov committed
93
    else
94
      'Never'
gitlabhq's avatar
gitlabhq committed
95
    end
96
  rescue
97
    'Never'
gitlabhq's avatar
gitlabhq committed
98 99
  end

100
  def grouped_options_refs
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
101 102
    repository = @project.repository

gitlabhq's avatar
gitlabhq committed
103
    options = [
104 105
      ['Branches', repository.branch_names],
      ['Tags', VersionSorter.rsort(repository.tag_names)]
gitlabhq's avatar
gitlabhq committed
106 107
    ]

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

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
114
    grouped_options_for_select(options, @ref || @project.default_branch)
gitlabhq's avatar
gitlabhq committed
115 116
  end

117 118 119
  def emoji_autocomplete_source
    # should be an array of strings
    # so to_s can be called, because it is sufficient and to_json is too slow
Riyad Preukschas's avatar
Riyad Preukschas committed
120
    Emoji.names.to_s
121 122
  end

123 124
  # Define whenever show last push event
  # with suggestion to create MR
randx's avatar
randx committed
125
  def show_last_push_widget?(event)
126 127 128 129 130 131 132 133 134 135 136
    # 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?

137 138 139
    # Skip if user removed branch right after that
    return false unless project.repository.branch_names.include?(event.branch_name)

140
    true
randx's avatar
randx committed
141
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
142

143 144 145
  def hexdigest(string)
    Digest::SHA1.hexdigest string
  end
146

147
  def simple_sanitize(str)
148 149 150
    sanitize(str, tags: %w(a span))
  end

151
  def body_data_page
152 153 154
    path = controller.controller_path.split('/')
    namespace = path.first if path.second

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

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

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

168 169
  def search_placeholder
    if @project && @project.persisted?
170
      'Search in this project'
171
    elsif @snippet || @snippets || @show_snippets
172
      'Search snippets'
173
    elsif @group && @group.persisted?
174
      'Search in this group'
175
    else
176
      'Search'
177
    end
178
  end
179 180 181 182

  def broadcast_message
    BroadcastMessage.current
  end
183

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  # 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,
      class: "#{html_class} js-timeago",
      datetime: time.getutc.iso8601,
      title: time.in_time_zone.stamp('Aug 21, 2011 9:23pm'),
206
      data: { toggle: 'tooltip', placement: placement, container: 'body' }
207 208 209 210

    element += javascript_tag "$('.js-timeago').timeago()" unless skip_js

    element
211
  end
212 213

  def render_markup(file_name, file_content)
214 215 216
    if gitlab_markdown?(file_name)
      Haml::Helpers.preserve(markdown(file_content))
    elsif asciidoc?(file_name)
217
      asciidoc(file_content)
218 219 220 221
    elsif plain?(file_name)
      content_tag :pre, class: 'plain-readme' do
        file_content
      end
222 223 224 225
    else
      GitHub::Markup.render(file_name, file_content).
        force_encoding(file_content.encoding).html_safe
    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 256
  def page_filter_path(options = {})
    without = options.delete(:without)

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

    options = exist_opts.merge(options)

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

275 276 277 278
    path = request.path
    path << "?#{options.to_param}"
    path
  end
279 280 281 282

  def outdated_browser?
    browser.ie? && browser.version.to_i < 10
  end
283 284 285 286 287 288 289 290

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

  def state_filters_text_for(entity, project)
293
    titles = {
294
      opened: "Open"
295
    }
296

297
    entity_title = titles[entity] || entity.to_s.humanize
298 299

    count =
300
      if project.nil?
301
        nil
302
      elsif current_controller?(:issues)
303
        project.issues.send(entity).count
304
      elsif current_controller?(:merge_requests)
305
        project.merge_requests.send(entity).count
306
      end
307

308
    html = content_tag :span, entity_title
309 310

    if count.present?
311
      html += " "
312 313 314 315
      html += content_tag :span, number_with_delimiter(count), class: 'badge'
    end

    html.html_safe
316
  end
gitlabhq's avatar
gitlabhq committed
317
end