Read about our upcoming Code of Conduct on this issue

projects_helper.rb 13.3 KB
Newer Older
randx's avatar
randx committed
1
module ProjectsHelper
2
  def link_to_project(project)
Josh Frye's avatar
Escape!    
Josh Frye committed
3
    link_to [project.namespace.becomes(Namespace), project], title: h(project.name) do
4
      title = content_tag(:span, project.name, class: 'project-name')
5
6

      if project.namespace
7
        namespace = content_tag(:span, "#{project.namespace.human_name} / ", class: 'namespace-name')
8
9
10
11
12
        title = namespace + title
      end

      title
    end
13
  end
randx's avatar
randx committed
14

Jacob Schatz's avatar
Jacob Schatz committed
15
16
17
  def link_to_member_avatar(author, opts = {})
    default_opts = { avatar: true, name: true, size: 16, author_class: 'author', title: ":name" }
    opts = default_opts.merge(opts)
18
    image_tag(avatar_icon(author, opts[:size]), width: opts[:size], class: "avatar avatar-inline #{"s#{opts[:size]}" if opts[:size]}", alt: '') if opts[:avatar]
Jacob Schatz's avatar
Jacob Schatz committed
19
20
  end

Phil Hughes's avatar
Phil Hughes committed
21
  def link_to_member(project, author, opts = {}, &block)
22
    default_opts = { avatar: true, name: true, size: 16, author_class: 'author', title: ":name", tooltip: false }
23
24
    opts = default_opts.merge(opts)

25
26
    return "(deleted)" unless author

27
    author_html = ""
28

29
    # Build avatar image tag
Luke Bennett's avatar
Luke Bennett committed
30
    author_html << image_tag(avatar_icon(author, opts[:size]), width: opts[:size], class: "avatar avatar-inline #{"s#{opts[:size]}" if opts[:size]} #{opts[:avatar_class] if opts[:avatar_class]}", alt: '') if opts[:avatar]
31

32
    # Build name span tag
33
34
35
    if opts[:by_username]
      author_html << content_tag(:span, sanitize("@#{author.username}"), class: opts[:author_class]) if opts[:name]
    else
36
      tooltip_data = { placement: 'top' }
Phil Hughes's avatar
Phil Hughes committed
37
      author_html << content_tag(:span, sanitize(author.name), class: [opts[:author_class], ('has-tooltip' if opts[:tooltip])], title: (author.to_reference if opts[:tooltip]), data: (tooltip_data if opts[:tooltip])) if opts[:name]
38
    end
39

Phil Hughes's avatar
Phil Hughes committed
40
41
    author_html << capture(&block) if block

42
    author_html = author_html.html_safe
43

44
    if opts[:name]
45
      link_to(author_html, user_path(author), class: "author_link #{"#{opts[:extra_class]}" if opts[:extra_class]} #{"#{opts[:mobile_classes]}" if opts[:mobile_classes]}").html_safe
46
    else
47
      title = opts[:title].sub(":name", sanitize(author.name))
48
      link_to(author_html, user_path(author), class: "author_link has-tooltip", title: title, data: { container: 'body' }).html_safe
49
    end
randx's avatar
randx committed
50
  end
51

52
  def project_title(project)
53
54
    namespace_link =
      if project.group
55
        group_title(project.group)
56
57
58
      else
        owner = project.namespace.owner
        link_to(simple_sanitize(owner.name), user_path(owner))
59
      end
60

Phil Hughes's avatar
Phil Hughes committed
61
    project_link = link_to simple_sanitize(project.name), project_path(project), { class: "project-item-select-holder" }
62

Phil Hughes's avatar
Phil Hughes committed
63
    if current_user
Jacopo's avatar
Jacopo committed
64
      project_link << button_tag(type: 'button', class: 'dropdown-toggle-caret js-projects-dropdown-toggle', aria: { label: 'Toggle switch project dropdown' }, data: { target: '.js-dropdown-menu-projects', toggle: 'dropdown', order_by: 'last_activity_at' }) do
65
66
        icon("chevron-down")
      end
Phil Hughes's avatar
Phil Hughes committed
67
68
    end

69
    "#{namespace_link} / #{project_link}".html_safe
70
  end
71
72
73
74

  def remove_project_message(project)
    "You are going to remove #{project.name_with_namespace}.\n Removed project CANNOT be restored!\n Are you ABSOLUTELY sure?"
  end
75

76
77
78
79
  def transfer_project_message(project)
    "You are going to transfer #{project.name_with_namespace} to another owner. Are you ABSOLUTELY sure?"
  end

80
  def remove_fork_project_message(project)
Douwe Maan's avatar
Douwe Maan committed
81
    "You are going to remove the fork relationship to source project #{@project.forked_from_project.name_with_namespace}.  Are you ABSOLUTELY sure?"
82
83
  end

84
85
86
87
88
89
90
91
  def project_nav_tabs
    @nav_tabs ||= get_project_nav_tabs(@project, current_user)
  end

  def project_nav_tab?(name)
    project_nav_tabs.include? name
  end

Douwe Maan's avatar
Douwe Maan committed
92
  def project_for_deploy_key(deploy_key)
93
    if deploy_key.has_access_to?(@project)
Douwe Maan's avatar
Douwe Maan committed
94
95
      @project
    else
Lin Jen-Shin's avatar
Lin Jen-Shin committed
96
97
98
      deploy_key.projects.find do |project|
        can?(current_user, :read_project, project)
      end
Douwe Maan's avatar
Douwe Maan committed
99
100
101
    end
  end

Valery Sizov's avatar
Valery Sizov committed
102
103
104
105
106
107
108
109
110
111
  def can_change_visibility_level?(project, current_user)
    return false unless can?(current_user, :change_visibility_level, project)

    if project.forked?
      project.forked_from_project.visibility_level > Gitlab::VisibilityLevel::PRIVATE
    else
      true
    end
  end

112
  def license_short_name(project)
113
    return 'LICENSE' if project.repository.license_key.nil?
114
115
116
117
118
119

    license = Licensee::License.new(project.repository.license_key)

    license.nickname || license.name
  end

120
121
122
123
124
125
126
127
128
129
130
  def last_push_event
    return unless current_user

    project_ids = [@project.id]
    if fork = current_user.fork_of(@project)
      project_ids << fork.id
    end

    current_user.recent_push(project_ids)
  end

Felipe Artur's avatar
Felipe Artur committed
131
132
133
134
135
  def project_feature_access_select(field)
    # Don't show option "everyone with access" if project is private
    options = project_feature_options

    if @project.private?
136
      level = @project.project_feature.send(field)
Felipe Artur's avatar
Felipe Artur committed
137
      options.delete('Everyone with access')
138
      highest_available_option = options.values.max if level == ProjectFeature::ENABLED
Felipe Artur's avatar
Felipe Artur committed
139
140
141
    end

    options = options_for_select(options, selected: highest_available_option || @project.project_feature.public_send(field))
142
143
144
145
146
147
148
149
150

    content_tag(
      :select,
      options,
      name: "project[project_feature_attributes][#{field}]",
      id: "project_project_feature_attributes_#{field}",
      class: "pull-right form-control #{repo_children_classes(field)}",
      data: { field: field }
    ).html_safe
Felipe Artur's avatar
Felipe Artur committed
151
152
  end

153
154
155
156
  def link_to_autodeploy_doc
    link_to 'About auto deploy', help_page_path('ci/autodeploy/index'), target: '_blank'
  end

Valery Sizov's avatar
Valery Sizov committed
157
158
159
160
161
  def autodeploy_flash_notice(branch_name)
    "Branch <strong>#{truncate(sanitize(branch_name))}</strong> was created. To set up auto deploy, \
      choose a GitLab CI Yaml template and commit your changes. #{link_to_autodeploy_doc}".html_safe
  end

162
163
164
165
166
167
168
  def project_list_cache_key(project)
    key = [project.namespace.cache_key, project.cache_key, controller.controller_name, controller.action_name, current_application_settings.cache_key, 'v2.3']
    key << pipeline_status_cache_key(project.pipeline_status) if project.pipeline_status.has_status?

    key
  end

169
170
171
172
173
  def load_pipeline_status(projects)
    Gitlab::Cache::Ci::ProjectPipelineStatus.
      load_in_batch_for_projects(projects)
  end

174
175
  private

176
177
178
179
180
181
182
183
184
185
  def repo_children_classes(field)
    needs_repo_check = [:merge_requests_access_level, :builds_access_level]
    return unless needs_repo_check.include?(field)

    classes = "project-repo-select js-repo-select"
    classes << " disabled" unless @project.feature_available?(:repository, current_user)

    classes
  end

186
  def get_project_nav_tabs(project, current_user)
187
    nav_tabs = [:home]
188

189
    if !project.empty_repo? && can?(current_user, :download_code, project)
190
      nav_tabs << [:files, :commits, :network, :graphs, :forks]
191
192
    end

193
    if project.repo_exists? && can?(current_user, :read_merge_request, project)
194
195
196
      nav_tabs << :merge_requests
    end

197
    if Gitlab.config.registry.enabled && can?(current_user, :read_container_image, project)
198
      nav_tabs << :container_registry
Kamil Trzcinski's avatar
Kamil Trzcinski committed
199
200
    end

201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
    tab_ability_map = {
      environments: :read_environment,
      milestones:   :read_milestone,
      pipelines:    :read_pipeline,
      snippets:     :read_project_snippet,
      settings:     :admin_project,
      builds:       :read_build,
      labels:       :read_label,
      issues:       :read_issue,
      team:         :read_project_member,
      wiki:         :read_wiki
    }

    tab_ability_map.each do |tab, ability|
      if can?(current_user, ability, project)
        nav_tabs << tab
      end
218
219
    end

220
221
    nav_tabs.flatten
  end
222

223
224
  def project_lfs_status(project)
    if project.lfs_enabled?
225
      content_tag(:span, class: 'lfs-enabled') do
226
227
228
        'Enabled'
      end
    else
229
      content_tag(:span, class: 'lfs-disabled') do
230
231
232
233
234
        'Disabled'
      end
    end
  end

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
  def git_user_name
    if current_user
      current_user.name
    else
      "Your name"
    end
  end

  def git_user_email
    if current_user
      current_user.email
    else
      "your@email.com"
    end
  end
250

251
  def default_url_to_repo(project = @project)
252
253
    case default_clone_protocol
    when 'ssh'
254
255
      project.ssh_url_to_repo
    else
256
      project.http_url_to_repo(current_user)
257
    end
258
  end
259

260
  def default_clone_protocol
261
262
    if allowed_protocols_present?
      enabled_protocol
263
    else
264
265
266
267
268
      if !current_user || current_user.require_ssh_key?
        gitlab_config.protocol
      else
        'ssh'
      end
269
    end
270
  end
271
272
273

  def project_last_activity(project)
    if project.last_activity_at
274
      time_ago_with_tooltip(project.last_activity_at, placement: 'bottom', html_class: 'last_activity_time_ago')
275
276
277
278
    else
      "Never"
    end
  end
279

Douwe Maan's avatar
Douwe Maan committed
280
  def add_special_file_path(project, file_name:, commit_message: nil, branch_name: nil, context: nil)
281
282
283
284
285
    namespace_project_new_blob_path(
      project.namespace,
      project,
      project.default_branch || 'master',
      file_name:      file_name,
286
      commit_message: commit_message || "Add #{file_name.downcase}",
Douwe Maan's avatar
Douwe Maan committed
287
      branch_name: branch_name,
288
      context: context
289
    )
290
291
  end

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
  def add_koding_stack_path(project)
    namespace_project_new_blob_path(
      project.namespace,
      project,
      project.default_branch || 'master',
      file_name:      '.koding.yml',
      commit_message: "Add Koding stack script",
      content: <<-CONTENT.strip_heredoc
        provider:
          aws:
            access_key: '${var.aws_access_key}'
            secret_key: '${var.aws_secret_key}'
        resource:
          aws_instance:
            #{project.path}-vm:
              instance_type: t2.nano
              user_data: |-

                # Created by GitLab UI for :>

                echo _KD_NOTIFY_@Installing Base packages...@

                apt-get update -y
                apt-get install git -y

                echo _KD_NOTIFY_@Cloning #{project.name}...@

                export KODING_USER=${var.koding_user_username}
                export REPO_URL=#{root_url}${var.koding_queryString_repo}.git
                export BRANCH=${var.koding_queryString_branch}

                sudo -i -u $KODING_USER git clone $REPO_URL -b $BRANCH

                echo _KD_NOTIFY_@#{project.name} cloned.@
      CONTENT
    )
  end

  def koding_project_url(project = nil, branch = nil, sha = nil)
    if project
      import_path = "/Home/Stacks/import"

      repo = project.path_with_namespace
      branch ||= project.default_branch
      sha ||= project.commit.short_id

      path = "#{import_path}?repo=#{repo}&branch=#{branch}&sha=#{sha}"

      return URI.join(current_application_settings.koding_url, path).to_s
    end

    current_application_settings.koding_url
  end

346
  def contribution_guide_path(project)
347
    if project && contribution_guide = project.repository.contribution_guide
Vinnie Okada's avatar
Vinnie Okada committed
348
349
350
351
      namespace_project_blob_path(
        project.namespace,
        project,
        tree_join(project.default_branch,
352
353
354
355
356
                  contribution_guide.name)
      )
    end
  end

357
358
359
360
  def readme_path(project)
    filename_path(project, :readme)
  end

361
  def changelog_path(project)
362
    filename_path(project, :changelog)
363
364
  end

365
  def license_path(project)
366
    filename_path(project, :license_blob)
367
368
  end

369
  def version_path(project)
370
    filename_path(project, :version)
371
  end
372

373
374
375
376
  def ci_configuration_path(project)
    filename_path(project, :gitlab_ci_yml)
  end

377
378
  def project_wiki_path_with_version(proj, page, version, is_newest)
    url_params = is_newest ? {} : { version_id: version }
Vinnie Okada's avatar
Vinnie Okada committed
379
    namespace_project_wiki_path(proj.namespace, proj, page, url_params)
380
  end
381

Valery Sizov's avatar
Valery Sizov committed
382
383
384
385
386
387
388
389
390
391
  def project_status_css_class(status)
    case status
    when "started"
      "active"
    when "failed"
      "danger"
    when "finished"
      "success"
    end
  end
392

393
  def readme_cache_key
394
    sha = @project.commit.try(:sha) || 'nil'
395
    [@project.path_with_namespace, sha, "readme"].join('-')
396
  end
397

398
399
400
  def current_ref
    @ref || @repository.try(:root_ref)
  end
401

402
403
404
  def filename_path(project, filename)
    if project && blob = project.repository.send(filename)
      namespace_project_blob_path(
Gabriel Mazetto's avatar
Gabriel Mazetto committed
405
406
407
        project.namespace,
        project,
        tree_join(project.default_branch, blob.name)
408
409
410
      )
    end
  end
411

412
  def sanitize_repo_path(project, message)
413
414
    return '' unless message.present?

415
416
417
418
    exports_path = File.join(Settings.shared['path'], 'tmp/project_exports')
    filtered_message = message.strip.gsub(exports_path, "[REPO EXPORT PATH]")

    filtered_message.gsub(project.repository_storage_path.chomp('/'), "[REPOS PATH]")
419
  end
Felipe Artur's avatar
Felipe Artur committed
420
421
422
423
424
425
426
427

  def project_feature_options
    {
      'Disabled' => ProjectFeature::DISABLED,
      'Only team members' => ProjectFeature::PRIVATE,
      'Everyone with access' => ProjectFeature::ENABLED
    }
  end
428
429
430
431

  def project_child_container_class(view_path)
    view_path == "projects/issues/issues" ? "prepend-top-default" : "project-show-#{view_path}"
  end
432
433
434
435

  def project_issues(project)
    IssuesFinder.new(current_user, project_id: project.id).execute
  end
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
436
437

  def visibility_select_options(project, selected_level)
438
439
440
441
    level_options = Gitlab::VisibilityLevel.values.each_with_object([]) do |level, level_options|
      next if restricted_levels.include?(level)

      level_options << [
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
442
443
444
445
446
        visibility_level_label(level),
        { data: { description: visibility_level_description(level, project) } },
        level
      ]
    end
447
448
449
450
451
452
453
454

    options_for_select(level_options, selected_level)
  end

  def restricted_levels
    return [] if current_user.admin?

    current_application_settings.restricted_visibility_levels || []
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
455
  end
randx's avatar
randx committed
456
end