Read about our upcoming Code of Conduct on this issue

This instance will be upgraded to Heptapod 0.28.1 on 2022-01-26 at 16:00 UTC+1 (a few minutes of down time)

projects_helper.rb 20 KB
Newer Older
1
2
# frozen_string_literal: true

randx's avatar
randx committed
3
module ProjectsHelper
4
5
  prepend_if_ee('::EE::ProjectsHelper') # rubocop: disable Cop/InjectEnterpriseEditionModule

6
  def link_to_project(project)
7
    link_to namespace_project_path(namespace_id: project.namespace, id: project), title: h(project.name) do
8
      title = content_tag(:span, project.name, class: 'project-name')
9
10

      if project.namespace
11
        namespace = content_tag(:span, "#{project.namespace.human_name} / ", class: 'namespace-name')
12
13
14
15
16
        title = namespace + title
      end

      title
    end
17
  end
randx's avatar
randx committed
18

Jacob Schatz's avatar
Jacob Schatz committed
19
  def link_to_member_avatar(author, opts = {})
20
    default_opts = { size: 16, lazy_load: false }
Jacob Schatz's avatar
Jacob Schatz committed
21
    opts = default_opts.merge(opts)
22
23

    classes = %W[avatar avatar-inline s#{opts[:size]}]
Maxim Rydkin's avatar
Maxim Rydkin committed
24
25
    classes << opts[:avatar_class] if opts[:avatar_class]

26
    avatar = avatar_icon_for_user(author, opts[:size])
27
28
29
    src = opts[:lazy_load] ? nil : avatar

    image_tag(src, width: opts[:size], class: classes, alt: '', "data-src" => avatar)
Jacob Schatz's avatar
Jacob Schatz committed
30
31
  end

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
  def author_content_tag(author, opts = {})
    default_opts = { author_class: 'author', tooltip: false, by_username: false }
    opts = default_opts.merge(opts)

    has_tooltip = !opts[:by_username] && opts[:tooltip]

    username = opts[:by_username] ? author.to_reference : author.name
    name_tag_options = { class: [opts[:author_class]] }

    if has_tooltip
      name_tag_options[:title] = author.to_reference
      name_tag_options[:data] = { placement: 'top' }
      name_tag_options[:class] << 'has-tooltip'
    end

47
48
    # NOTE: ActionView::Helpers::TagHelper#content_tag HTML escapes username
    content_tag(:span, username, name_tag_options)
49
50
  end

Phil Hughes's avatar
Phil Hughes committed
51
  def link_to_member(project, author, opts = {}, &block)
52
    default_opts = { avatar: true, name: true, title: ":name" }
53
54
    opts = default_opts.merge(opts)

55
56
57
58
59
60
    data_attrs = {
      user_id: author.id,
      username: author.username,
      name: author.name
    }

61
62
    return "(deleted)" unless author

63
    author_html = []
64

65
    # Build avatar image tag
66
    author_html << link_to_member_avatar(author, opts) if opts[:avatar]
67

68
    # Build name span tag
69
    author_html << author_content_tag(author, opts) if opts[:name]
70

Phil Hughes's avatar
Phil Hughes committed
71
72
    author_html << capture(&block) if block

73
    author_html = author_html.join.html_safe
74

75
    if opts[:name]
76
      link_to(author_html, user_path(author), class: "author-link js-user-link #{"#{opts[:extra_class]}" if opts[:extra_class]} #{"#{opts[:mobile_classes]}" if opts[:mobile_classes]}", data: data_attrs).html_safe
77
    else
78
      title = opts[:title].sub(":name", sanitize(author.name))
79
      link_to(author_html, user_path(author), class: "author-link has-tooltip", title: title, data: { container: 'body', qa_selector: 'assignee_link' }).html_safe
80
    end
randx's avatar
randx committed
81
  end
82

83
  def project_title(project)
84
85
    namespace_link =
      if project.group
Phil Hughes's avatar
Phil Hughes committed
86
        group_title(project.group, nil, nil)
87
88
89
      else
        owner = project.namespace.owner
        link_to(simple_sanitize(owner.name), user_path(owner))
90
      end
91

Phil Hughes's avatar
Phil Hughes committed
92
    project_link = link_to project_path(project) do
93
94
      icon = project_icon(project, alt: project.name, class: 'avatar-tile', width: 15, height: 15) if project.avatar_url && !Rails.env.test?
      [icon, content_tag("span", simple_sanitize(project.name), class: "breadcrumb-item-text js-breadcrumb-item-text")].join.html_safe
Phil Hughes's avatar
Phil Hughes committed
95
    end
96

Phil Hughes's avatar
Phil Hughes committed
97
98
    namespace_link = breadcrumb_list_item(namespace_link) unless project.group
    project_link = breadcrumb_list_item project_link
Phil Hughes's avatar
Phil Hughes committed
99

Phil Hughes's avatar
Phil Hughes committed
100
    "#{namespace_link} #{project_link}".html_safe
101
  end
102
103

  def remove_project_message(project)
104
105
    _("You are going to remove %{project_full_name}. Removed project CANNOT be restored! Are you ABSOLUTELY sure?") %
      { project_full_name: project.full_name }
106
  end
107

108
  def transfer_project_message(project)
109
110
    _("You are going to transfer %{project_full_name} to another owner. Are you ABSOLUTELY sure?") %
      { project_full_name: project.full_name }
111
112
  end

113
  def remove_fork_project_message(project)
114
    _("You are going to remove the fork relationship to source project %{forked_from_project}. Are you ABSOLUTELY sure?") %
115
116
117
118
119
120
121
122
123
      { forked_from_project: fork_source_name(project) }
  end

  def fork_source_name(project)
    if @project.fork_source
      @project.fork_source.full_name
    else
      @project.fork_network&.deleted_root_project_name
    end
124
125
  end

126
127
128
129
  def project_nav_tabs
    @nav_tabs ||= get_project_nav_tabs(@project, current_user)
  end

130
131
132
133
134
135
  def project_search_tabs?(tab)
    abilities = Array(search_tab_ability_map[tab])

    abilities.any? { |ability| can?(current_user, ability, @project) }
  end

136
137
138
139
  def project_nav_tab?(name)
    project_nav_tabs.include? name
  end

Douwe Maan's avatar
Douwe Maan committed
140
  def project_for_deploy_key(deploy_key)
141
    if deploy_key.has_access_to?(@project)
Douwe Maan's avatar
Douwe Maan committed
142
143
      @project
    else
Lin Jen-Shin's avatar
Lin Jen-Shin committed
144
145
146
      deploy_key.projects.find do |project|
        can?(current_user, :read_project, project)
      end
Douwe Maan's avatar
Douwe Maan committed
147
148
149
    end
  end

Valery Sizov's avatar
Valery Sizov committed
150
151
152
  def can_change_visibility_level?(project, current_user)
    return false unless can?(current_user, :change_visibility_level, project)

153
154
    if project.fork_source
      project.fork_source.visibility_level > Gitlab::VisibilityLevel::PRIVATE
Valery Sizov's avatar
Valery Sizov committed
155
156
157
158
159
    else
      true
    end
  end

160
161
162
  def can_disable_emails?(project, current_user)
    return false if project.group&.emails_disabled?

163
    can?(current_user, :set_emails_disabled, project)
164
165
  end

166
  def last_push_event
167
    current_user&.recent_push(@project)
168
169
  end

170
  def link_to_autodeploy_doc
171
    link_to _('About auto deploy'), help_page_path('ci/autodeploy/index'), target: '_blank'
172
173
  end

Valery Sizov's avatar
Valery Sizov committed
174
  def autodeploy_flash_notice(branch_name)
175
176
177
    translation = _("Branch <strong>%{branch_name}</strong> was created. To set up auto deploy, choose a GitLab CI Yaml template and commit your changes. %{link_to_autodeploy_doc}") %
      { branch_name: truncate(sanitize(branch_name)), link_to_autodeploy_doc: link_to_autodeploy_doc }
    translation.html_safe
Valery Sizov's avatar
Valery Sizov committed
178
179
  end

180
  def project_list_cache_key(project, pipeline_status: true)
181
    key = [
182
      project.route.cache_key,
183
      project.cache_key,
184
      project.last_activity_date,
185
186
      controller.controller_name,
      controller.action_name,
187
      Gitlab::CurrentSettings.cache_key,
188
      "cross-project:#{can?(current_user, :read_cross_project)}",
189
      max_project_member_access_cache_key(project),
190
      pipeline_status,
Mark Chao's avatar
Mark Chao committed
191
      'v2.6'
192
193
    ]

194
    key << pipeline_status_cache_key(project.pipeline_status) if pipeline_status && project.pipeline_status.has_status?
195
196
197
198

    key
  end

199
  def load_pipeline_status(projects)
200
201
    Gitlab::Cache::Ci::ProjectPipelineStatus
      .load_in_batch_for_projects(projects)
202
203
  end

204
  def show_no_ssh_key_message?
205
206
207
208
    Gitlab::CurrentSettings.user_show_add_ssh_key_message? &&
      cookies[:hide_no_ssh_message].blank? &&
      !current_user.hide_no_ssh_key &&
      current_user.require_ssh_key?
209
210
211
212
  end

  def show_no_password_message?
    cookies[:hide_no_password_message].blank? && !current_user.hide_no_password &&
213
      current_user.require_extra_setup_for_git_auth?
214
215
  end

216
217
  def show_auto_devops_implicitly_enabled_banner?(project, user)
    return false unless user_can_see_auto_devops_implicitly_enabled_banner?(project, user)
218

219
    cookies["hide_auto_devops_implicitly_enabled_banner_#{project.id}".to_sym].blank?
220
221
  end

222
  def link_to_set_password
223
    if current_user.require_password_creation_for_git?
224
225
226
227
228
229
      link_to s_('SetPasswordToCloneLink|set a password'), edit_profile_password_path
    else
      link_to s_('CreateTokenToCloneLink|create a personal access token'), profile_personal_access_tokens_path
    end
  end

230
231
232
233
234
235
236
237
238
  # Returns true if any projects are present.
  #
  # If the relation has a LIMIT applied we'll cast the relation to an Array
  # since repeated any? checks would otherwise result in multiple COUNT queries
  # being executed.
  #
  # If no limit is applied we'll just issue a COUNT since the result set could
  # be too large to load into memory.
  def any_projects?(projects)
239
240
    return projects.any? if projects.is_a?(Array)

241
242
243
244
245
246
247
    if projects.limit_value
      projects.to_a.any?
    else
      projects.except(:offset).any?
    end
  end

248
  # TODO: Remove this method when removing the feature flag
249
  # https://gitlab.com/gitlab-org/gitlab/merge_requests/11209#note_162234863
250
  # make sure to remove from the EE specific controller as well: ee/app/controllers/ee/dashboard/projects_controller.rb
251
  def show_projects?(projects, params)
252
    Feature.enabled?(:project_list_filter_bar) || !!(params[:personal] || params[:name] || any_projects?(projects))
253
254
  end

255
256
257
258
259
260
261
262
263
264
265
  def push_to_create_project_command(user = current_user)
    repository_url =
      if Gitlab::CurrentSettings.current_application_settings.enabled_git_access_protocol == 'http'
        user_url(user)
      else
        Gitlab.config.gitlab_shell.ssh_path_prefix + user.username
      end

    "git push --set-upstream #{repository_url}/$(git rev-parse --show-toplevel | xargs basename).git $(git rev-parse --abbrev-ref HEAD)"
  end

266
267
268
269
270
271
272
273
  def show_xcode_link?(project = @project)
    browser.platform.mac? && project.repository.xcode_project?
  end

  def xcode_uri_to_repo(project = @project)
    "xcode://clone?repo=#{CGI.escape(default_url_to_repo(project))}"
  end

274
275
276
277
  def link_to_bfg
    link_to 'BFG', 'https://rtyley.github.io/bfg-repo-cleaner/', target: '_blank', rel: 'noopener noreferrer'
  end

278
279
280
281
282
283
284
285
286
287
288
289
290
291
  def explore_projects_tab?
    current_page?(explore_projects_path) ||
      current_page?(trending_explore_projects_path) ||
      current_page?(starred_explore_projects_path)
  end

  def show_merge_request_count?(disabled: false, compact_mode: false)
    !disabled && !compact_mode && Feature.enabled?(:project_list_show_mr_count, default_enabled: true)
  end

  def show_issue_count?(disabled: false, compact_mode: false)
    !disabled && !compact_mode && Feature.enabled?(:project_list_show_issue_count, default_enabled: true)
  end

292
293
  # overridden in EE
  def settings_operations_available?
294
    can?(current_user, :read_environment, @project)
295
296
  end

Reuben Pereira's avatar
Reuben Pereira committed
297
298
299
300
301
302
303
304
305
306
307
308
309
310
  def error_tracking_setting_project_json
    setting = @project.error_tracking_setting

    return if setting.blank? || setting.project_slug.blank? ||
        setting.organization_slug.blank?

    {
      name: setting.project_name,
      organization_name: setting.organization_name,
      organization_slug: setting.organization_slug,
      slug: setting.project_slug
    }.to_json
  end

311
312
313
314
  def directory?
    @path.present?
  end

315
316
317
318
319
320
321
322
323
324
  def external_classification_label_help_message
    default_label = ::Gitlab::CurrentSettings.current_application_settings
                      .external_authorization_service_default_label

    s_(
      "ExternalAuthorizationService|When no classification label is set the "\
        "default label `%{default_label}` will be used."
    ) % { default_label: default_label }
  end

325
326
327
328
  def can_import_members?
    Ability.allowed?(current_user, :admin_project_member, @project)
  end

329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
  def project_can_be_shared?
    !membership_locked? || @project.allowed_to_share_with_group?
  end

  def membership_locked?
    false
  end

  def share_project_description(project)
    share_with_group   = project.allowed_to_share_with_group?
    share_with_members = !membership_locked?

    description =
      if share_with_group && share_with_members
        _("You can invite a new member to <strong>%{project_name}</strong> or invite another group.")
      elsif share_with_group
        _("You can invite another group to <strong>%{project_name}</strong>.")
      elsif share_with_members
        _("You can invite a new member to <strong>%{project_name}</strong>.")
      end

    description.html_safe % { project_name: project.name }
  end

353
354
355
356
  def metrics_external_dashboard_url
    @project.metrics_setting_external_dashboard_url
  end

357
358
359
360
361
362
363
364
  def grafana_integration_url
    @project.grafana_integration&.grafana_url
  end

  def grafana_integration_token
    @project.grafana_integration&.token
  end

365
366
367
  private

  def get_project_nav_tabs(project, current_user)
368
    nav_tabs = [:home]
369

370
371
372
    unless project.empty_repo?
      nav_tabs << [:files, :commits, :network, :graphs, :forks] if can?(current_user, :download_code, project)
      nav_tabs << :releases if can?(current_user, :read_release, project)
373
374
    end

375
    if project.repo_exists? && can?(current_user, :read_merge_request, project)
376
377
378
      nav_tabs << :merge_requests
    end

379
    if Gitlab.config.registry.enabled && can?(current_user, :read_container_image, project)
380
      nav_tabs << :container_registry
Kamil Trzcinski's avatar
Kamil Trzcinski committed
381
382
    end

383
384
    # Pipelines feature is tied to presence of builds
    if can?(current_user, :read_build, project)
385
      nav_tabs << :pipelines
386
387
388
    end

    if can?(current_user, :read_environment, project) || can?(current_user, :read_cluster, project)
389
      nav_tabs << :operations
390
391
    end

392
393
394
395
396
397
    tab_ability_map.each do |tab, ability|
      if can?(current_user, ability, project)
        nav_tabs << tab
      end
    end

398
399
    nav_tabs << external_nav_tabs(project)

400
401
402
    nav_tabs.flatten
  end

403
404
405
  def external_nav_tabs(project)
    [].tap do |tabs|
      tabs << :external_issue_tracker if project.external_issue_tracker
406
      tabs << :external_wiki if project.external_wiki
407
408
409
    end
  end

410
411
  def tab_ability_map
    {
412
413
414
415
416
      environments:     :read_environment,
      milestones:       :read_milestone,
      snippets:         :read_project_snippet,
      settings:         :admin_project,
      builds:           :read_build,
417
      clusters:         :read_cluster,
418
      serverless:       :read_cluster,
419
      error_tracking:   :read_sentry_issue,
420
421
422
423
      labels:           :read_label,
      issues:           :read_issue,
      project_members:  :read_project_member,
      wiki:             :read_wiki
424
    }
425
  end
426

427
428
429
430
431
  def search_tab_ability_map
    @search_tab_ability_map ||= tab_ability_map.merge(
      blobs:          :download_code,
      commits:        :download_code,
      merge_requests: :read_merge_request,
432
433
      notes:          [:read_merge_request, :download_code, :read_issue, :read_project_snippet],
      members:        :read_project_member
434
    )
435
  end
436

437
438
  def project_lfs_status(project)
    if project.lfs_enabled?
439
      content_tag(:span, class: 'lfs-enabled') do
440
        s_('LFSStatus|Enabled')
441
442
      end
    else
443
      content_tag(:span, class: 'lfs-disabled') do
444
        s_('LFSStatus|Disabled')
445
446
447
448
      end
    end
  end

449
450
  def git_user_name
    if current_user
451
      current_user.name.gsub('"', '\"')
452
    else
453
      _("Your name")
454
455
456
457
458
    end
  end

  def git_user_email
    if current_user
459
      current_user.commit_email
460
461
462
463
    else
      "your@email.com"
    end
  end
464

465
  def default_url_to_repo(project = @project)
466
467
    case default_clone_protocol
    when 'ssh'
468
469
      project.ssh_url_to_repo
    else
470
      project.http_url_to_repo
471
    end
472
  end
473

474
475
476
477
  def default_clone_label
    _("Copy %{protocol} clone URL") % { protocol: default_clone_protocol.upcase }
  end

478
  def default_clone_protocol
479
480
    if allowed_protocols_present?
      enabled_protocol
481
    else
482
483
484
485
486
487
488
489
490
      extra_default_clone_protocol
    end
  end

  def extra_default_clone_protocol
    if !current_user || current_user.require_ssh_key?
      gitlab_config.protocol
    else
      'ssh'
491
    end
492
  end
493

Matija Čupić's avatar
Matija Čupić committed
494
495
496
497
  def sidebar_operations_link_path(project = @project)
    metrics_project_environments_path(project) if can?(current_user, :read_environment, project)
  end

498
499
  def project_last_activity(project)
    if project.last_activity_at
500
      time_ago_with_tooltip(project.last_activity_at, placement: 'bottom', html_class: 'last_activity_time_ago')
501
    else
502
      s_("ProjectLastActivity|Never")
503
504
    end
  end
505

506
507
  def project_wiki_path_with_version(proj, page, version, is_newest)
    url_params = is_newest ? {} : { version_id: version }
508
    project_wiki_path(proj, page, url_params)
509
  end
510

Valery Sizov's avatar
Valery Sizov committed
511
512
513
  def project_status_css_class(status)
    case status
    when "started"
514
      "table-active"
Valery Sizov's avatar
Valery Sizov committed
515
    when "failed"
516
      "table-danger"
Valery Sizov's avatar
Valery Sizov committed
517
    when "finished"
518
      "table-success"
Valery Sizov's avatar
Valery Sizov committed
519
520
    end
  end
521

522
  def readme_cache_key
523
    sha = @project.commit.try(:sha) || 'nil'
524
    [@project.full_path, sha, "readme"].join('-')
525
  end
526

527
528
529
  def current_ref
    @ref || @repository.try(:root_ref)
  end
530

531
532
533
  def project_child_container_class(view_path)
    view_path == "projects/issues/issues" ? "prepend-top-default" : "project-show-#{view_path}"
  end
534
535
536
537

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

539
540
541
  def restricted_levels
    return [] if current_user.admin?

542
    Gitlab::CurrentSettings.restricted_visibility_levels || []
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
543
  end
544

545
546
547
548
549
550
551
552
553
554
555
  def project_permissions_settings(project)
    feature = project.project_feature
    {
      visibilityLevel: project.visibility_level,
      requestAccessEnabled: !!project.request_access_enabled,
      issuesAccessLevel: feature.issues_access_level,
      repositoryAccessLevel: feature.repository_access_level,
      mergeRequestsAccessLevel: feature.merge_requests_access_level,
      buildsAccessLevel: feature.builds_access_level,
      wikiAccessLevel: feature.wiki_access_level,
      snippetsAccessLevel: feature.snippets_access_level,
556
      pagesAccessLevel: feature.pages_access_level,
557
      containerRegistryEnabled: !!project.container_registry_enabled,
558
559
      lfsEnabled: !!project.lfs_enabled,
      emailsDisabled: project.emails_disabled?
560
561
562
563
    }
  end

  def project_permissions_panel_data(project)
564
    {
565
      currentSettings: project_permissions_settings(project),
566
      canDisableEmails: can_disable_emails?(project, current_user),
567
568
569
570
      canChangeVisibilityLevel: can_change_visibility_level?(project, current_user),
      allowedVisibilityOptions: project_allowed_visibility_levels(project),
      visibilityHelpPath: help_page_path('public_access/public_access'),
      registryAvailable: Gitlab.config.registry.enabled,
571
      registryHelpPath: help_page_path('user/packages/container_registry/index'),
572
      lfsAvailable: Gitlab.config.lfs.enabled,
573
574
575
      lfsHelpPath: help_page_path('workflow/lfs/manage_large_binaries_with_git_lfs'),
      pagesAvailable: Gitlab.config.pages.enabled,
      pagesAccessControlEnabled: Gitlab.config.pages.access_control,
576
      pagesHelpPath: help_page_path('user/project/pages/introduction', anchor: 'gitlab-pages-access-control-core-only')
577
    }
578
  end
579

580
581
  def project_permissions_panel_data_json(project)
    project_permissions_panel_data(project).to_json.html_safe
582
583
584
585
586
587
588
589
  end

  def project_allowed_visibility_levels(project)
    Gitlab::VisibilityLevel.values.select do |level|
      project.visibility_level_allowed?(level) && !restricted_levels.include?(level)
    end
  end

590
591
592
593
594
595
596
  def find_file_path
    return unless @project && !@project.empty_repo?

    ref = @ref || @project.repository.root_ref

    project_find_file_path(@project, ref)
  end
597
598
599
600

  def can_show_last_commit_in_list?(project)
    can?(current_user, :read_cross_project) && project.commit
  end
Rob Watson's avatar
Rob Watson committed
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618

  def pages_https_only_disabled?
    !@project.pages_domains.all?(&:https?)
  end

  def pages_https_only_title
    return unless pages_https_only_disabled?

    "You must enable HTTPS for all your domains first"
  end

  def pages_https_only_label_class
    if pages_https_only_disabled?
      "list-label disabled"
    else
      "list-label"
    end
  end
619

620
621
622
623
624
  def filter_starrer_path(options = {})
    options = params.slice(:sort).merge(options).permit!
    "#{request.path}?#{options.to_param}"
  end

625
626
627
628
  def sidebar_projects_paths
    %w[
      projects#show
      projects#activity
Filipa Lacerda's avatar
Filipa Lacerda committed
629
      releases#index
630
631
632
633
      cycle_analytics#show
    ]
  end

634
635
636
637
638
639
640
641
  def sidebar_settings_paths
    %w[
      projects#edit
      project_members#index
      integrations#show
      services#edit
      repository#show
      ci_cd#show
642
      operations#show
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
      badges#index
      pages#show
    ]
  end

  def sidebar_repository_paths
    %w[
      tree
      blob
      blame
      edit_tree
      new_tree
      find_file
      commit
      commits
      compare
      projects/repositories
      tags
      branches
      graphs
      network
    ]
  end
666
667
668
669
670

  def sidebar_operations_paths
    %w[
      environments
      clusters
671
      functions
672
      error_tracking
673
674
675
676
      user
      gcp
    ]
  end
677
678
679
680
681
682
683

  def user_can_see_auto_devops_implicitly_enabled_banner?(project, user)
    Ability.allowed?(user, :admin_project, project) &&
      project.has_auto_devops_implicitly_enabled? &&
      project.builds_enabled? &&
      !project.repository.gitlab_ci_yml
  end
684
685

  def vue_file_list_enabled?
686
    Feature.enabled?(:vue_file_list, @project)
687
  end
randx's avatar
randx committed
688
end