Module: TreeHelper

Includes:
BlobHelper, WebIdeButtonHelper
Included in:
BlobPresenter, DiffFileBaseEntity, Gitlab::BlamePresenter, MergeRequestCurrentUserEntity, MergeRequestPresenter, ProjectPresenter, Projects::FindFileController, Projects::RefsController, RapidDiffs::DiffFileComponent, RapidDiffs::Viewers::ImageViewComponent
Defined in:
app/helpers/tree_helper.rb

Instance Method Summary collapse

Methods included from WebIdeButtonHelper

#can_collaborate?, #can_create_mr_from_fork?, #edit_url, #fork?, #gitpod_url, #needs_to_fork?, #project_fork, #project_to_use, #readable_blob?, #show_edit_button?, #show_gitpod_button?, #show_pipeline_editor_button?, #show_web_ide_button?, #web_ide_url

Methods included from BlobHelper

#blob_editor_paths, #blob_icon, #blob_raw_path, #blob_raw_url, #blob_render_error_options, #blob_render_error_reason, #can_modify_blob?, #can_modify_blob_with_web_ide?, #contribution_options, #copy_blob_source_button, #copy_file_path_button, #dockerfile_names, #download_blob_button, #edit_blob_app_data, #edit_blob_button, #edit_blob_fork_params, #edit_blob_path, #edit_button_tag, #edit_disabled_button_tag, #edit_fork_button_tag, #edit_link_tag, #editing_preview_title, #encode_ide_path, #fork_and_edit_path, #fork_path_for_current_user, #gitignore_names, #gitlab_ci_ymls, #ide_edit_path, #ide_fork_and_edit_path, #ide_merge_request_path, #licenses_for_select, #open_raw_blob_button, #parent_dir_raw_path, #readable_blob, #ref_project, #sanitize_svg_data, #vue_blob_app_data, #vue_blob_header_app_data

Instance Method Details



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'app/helpers/tree_helper.rb', line 89

def breadcrumb_data_attributes
  attrs = {
    selected_branch: selected_branch,
    can_push_code: can?(current_user, :push_code, @project).to_s,
    can_push_to_branch: user_access(@project).can_push_to_branch?(@ref).to_s,
    can_collaborate: can_collaborate_with_project?(@project).to_s,
    new_blob_path: project_new_blob_path(@project, @ref),
    upload_path: project_create_blob_path(@project, @ref),
    new_dir_path: project_create_dir_path(@project, @ref),
    new_branch_path: new_project_branch_path(@project),
    new_tag_path: new_project_tag_path(@project),
    can_edit_tree: can_edit_tree?.to_s
  }

  if can?(current_user, :fork_project, @project) && can?(current_user, :create_merge_request_in, @project)
    continue_param = {
      to: project_new_blob_path(@project, @id),
      notice: edit_in_new_fork_notice,
      notice_now: edit_in_new_fork_notice_now
    }

    attrs.merge!(
      fork_new_blob_path: project_forks_path(
        @project,
        namespace_key: current_user.namespace.id,
        continue: continue_param
      ),
      fork_new_directory_path: project_forks_path(
        @project,
        namespace_key: current_user.namespace.id,
        continue: continue_param.merge({
          to: request.fullpath,
          notice: _("%{edit_in_new_fork_notice} Try to create a new directory again.") % {
            edit_in_new_fork_notice: edit_in_new_fork_notice
          }
        })
      ),
      fork_upload_blob_path: project_forks_path(
        @project,
        namespace_key: current_user.namespace.id,
        continue: continue_param.merge({
          to: request.fullpath,
          notice: _("%{edit_in_new_fork_notice} Try to upload a file again.") % {
            edit_in_new_fork_notice: edit_in_new_fork_notice
          }
        })
      )
    )
  end

  attrs
end

#can_edit_tree?(project = nil, ref = nil) ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
28
29
30
31
32
 
# File 'app/helpers/tree_helper.rb', line 25

def can_edit_tree?(project = nil, ref = nil)
  project ||= @project
  ref ||= @ref

  return false unless on_top_of_branch?(project, ref)

  can_collaborate_with_project?(project, ref: ref)
end

#code_dropdown_ide_data ⇒ Object 



223
224
225
226
227
228
229
230
231
 
# File 'app/helpers/tree_helper.rb', line 223

def code_dropdown_ide_data
  {
    gitpod_enabled: current_user&.gitpod_enabled || false,
    show_web_ide_button: show_web_ide_button?,
    show_gitpod_button: show_gitpod_button?,
    web_ide_url: web_ide_url,
    gitpod_url: gitpod_url
  }
end

#compact_code_dropdown_data(project, ref, ref_type) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
 
# File 'app/helpers/tree_helper.rb', line 253

def compact_code_dropdown_data(project, ref, ref_type)
  archive_prefix = ref ? "#{project.path}-#{ref.tr('/', '-')}" : ''
  download_links = !project.empty_repo? ? download_links(project, ref, archive_prefix, ref_type).to_json : []
  {
    ssh_url: ssh_enabled? ? ssh_clone_url_to_repo(project) : '',
    http_url: http_enabled? ? http_clone_url_to_repo(project) : '',
    xcode_url: show_xcode_link?(project) ? xcode_uri_to_repo(project) : '',
    ide_data: current_user&.namespace ? code_dropdown_ide_data.to_json : '',
    directory_download_links: download_links
  }
end

#compare_path(project, repository, ref) ⇒ Object 



142
143
144
145
146
 
# File 'app/helpers/tree_helper.rb', line 142

def compare_path(project, repository, ref)
  return if ref.blank? || repository.root_ref == ref

  project_compare_index_path(project, from: repository.root_ref, to: ref)
end

#directory_download_links(project, ref, archive_prefix) ⇒ Object 



244
245
246
247
248
249
250
251
 
# File 'app/helpers/tree_helper.rb', line 244

def directory_download_links(project, ref, archive_prefix)
  Gitlab::Workhorse::ARCHIVE_FORMATS.map do |fmt|
    {
      text: fmt,
      path: project_archive_path(project, id: tree_join(ref, archive_prefix), format: fmt)
    }
  end
end

#download_links(project, ref, archive_prefix, ref_type) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
 
# File 'app/helpers/tree_helper.rb', line 233

def download_links(project, ref, archive_prefix, ref_type)
  Gitlab::Workhorse::ARCHIVE_FORMATS.map do |fmt|
    {
      text: fmt,
      path: external_storage_url_or_path(
        project_archive_path(project, id: tree_join(ref, archive_prefix), format: fmt, ref_type: ref_type)
      )
    }
  end
end

#edit_in_new_fork_notice ⇒ Object 



58
59
60
61
 
# File 'app/helpers/tree_helper.rb', line 58

def edit_in_new_fork_notice
  _("You're not allowed to make changes to this project directly. "\
    "A fork of this project has been created that you can make changes in, so you can submit a merge request.")
end

#edit_in_new_fork_notice_now ⇒ Object 



53
54
55
56
 
# File 'app/helpers/tree_helper.rb', line 53

def edit_in_new_fork_notice_now
  _("You're not allowed to make changes to this project directly. "\
    "A fork of this project is being created that you can make changes in, so you can submit a merge request.")
end

#fork_modal_options(project, blob) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'app/helpers/tree_helper.rb', line 185

def fork_modal_options(project, blob)
  if show_edit_button?({ blob: blob })
    fork_modal_id = "modal-confirm-fork-edit"
  elsif show_web_ide_button?
    fork_modal_id = "modal-confirm-fork-webide"
  end

  {
    fork_path: new_namespace_project_fork_path(project_id: project.path, namespace_id: project.namespace.full_path),
    fork_modal_id: fork_modal_id
  }
end

#on_top_of_branch?(project = @project, ref = @ref) ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'app/helpers/tree_helper.rb', line 21

def on_top_of_branch?(project = @project, ref = @ref)
  project.repository.branch_exists?(ref)
end

#patch_branch_name(ref) ⇒ Object

Generate a patch branch name that should look like: ‘username-branchname-patch-epoch` where `epoch` is the last 5 digits of the time since epoch (in milliseconds)



44
45
46
47
48
49
50
51
 
# File 'app/helpers/tree_helper.rb', line 44

def patch_branch_name(ref)
  return unless current_user

  username = current_user.username
  epoch = time_in_milliseconds.to_s.last(5)

  "#{username}-#{ref}-patch-#{epoch}"
end

#path_breadcrumbs(max_links = 6) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'app/helpers/tree_helper.rb', line 63

def path_breadcrumbs(max_links = 6)
  if @path.present?
    part_path = ""
    parts = @path.split('/')

    yield('..', File.join(*parts.first(parts.count - 2))) if parts.count > max_links

    parts.each do |part|
      part_path = File.join(part_path, part) unless part_path.empty?
      part_path = part if part_path.empty?

      next if parts.count > max_links && parts.last(2).exclude?(part)

      yield(part, part_path)
    end
  end
end

#relative_url_root ⇒ Object 



85
86
87
 
# File 'app/helpers/tree_helper.rb', line 85

def relative_url_root
  Gitlab.config.gitlab.relative_url_root.presence || '/'
end

#selected_branch ⇒ Object 



81
82
83
 
# File 'app/helpers/tree_helper.rb', line 81

def selected_branch
  @branch_name || tree_edit_branch
end

#tree_edit_branch(project = @project, ref = @ref) ⇒ Object 



34
35
36
37
38
 
# File 'app/helpers/tree_helper.rb', line 34

def tree_edit_branch(project = @project, ref = @ref)
  return unless can_edit_tree?(project, ref)

  patch_branch_name(ref)
end

#tree_icon(type, mode, name) ⇒ Object

Return an image icon depending on the file type and mode

type - String type of the tree item; either ‘folder’ or ‘file’ mode - File unix mode name - File name



12
13
14
 
# File 'app/helpers/tree_helper.rb', line 12

def tree_icon(type, mode, name)
  sprite_icon(file_type_icon_class(type, mode, name))
end

#tree_join ⇒ Object

Simple shortcut to File.join



17
18
19
 
# File 'app/helpers/tree_helper.rb', line 17

def tree_join(...)
  File.join(...)
end

#vue_file_list_data(project, ref) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'app/helpers/tree_helper.rb', line 172

def vue_file_list_data(project, ref)
  {
    project_path: project.full_path,
    project_short_path: project.path,
    target_branch: selected_branch,
    ref: ref,
    escaped_ref: ActionDispatch::Journey::Router::Utils.escape_path(ref),
    full_name: project.name_with_namespace,
    ref_type: @ref_type,
    has_revs_file: (!project.repository.ignore_revs_file_blob.nil?).to_s
  }
end

#vue_tree_header_app_data(project, repository, ref, pipeline, ref_type) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'app/helpers/tree_helper.rb', line 148

def vue_tree_header_app_data(project, repository, ref, pipeline, ref_type)
  archive_prefix = ref ? "#{project.path}-#{ref.tr('/', '-')}" : ''

  {
    project_id: project.id,
    ref: ref,
    ref_type: @ref_type.to_s,
    root_ref: repository.root_ref,
    breadcrumbs: breadcrumb_data_attributes,
    project_root_path: project_path(project),
    project_path: project.full_path,
    compare_path: compare_path(project, repository, ref),
    web_ide_button_options: web_ide_button_data({ blob: nil }).merge(fork_modal_options(project, nil)).to_json,
    web_ide_button_default_branch: project.default_branch_or_main,
    ssh_url: ssh_enabled? ? ssh_clone_url_to_repo(project) : '',
    http_url: http_enabled? ? http_clone_url_to_repo(project) : '',
    xcode_url: show_xcode_link?(project) ? xcode_uri_to_repo(project) : '',
    download_links: !project.empty_repo? ? download_links(project, ref, archive_prefix, ref_type).to_json : [],
    download_artifacts: pipeline &&
      (previous_artifacts(project, ref, pipeline.latest_builds_with_artifacts).to_json || []),
    escaped_ref: ActionDispatch::Journey::Router::Utils.escape_path(ref)
  }
end

#web_ide_button_data(options = {}) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'app/helpers/tree_helper.rb', line 198

def web_ide_button_data(options = {})
  {
    project_path: project_to_use.full_path,
    ref: @ref,

    is_fork: fork?,
    needs_to_fork: needs_to_fork?,
    gitpod_enabled: !current_user.nil? && current_user.gitpod_enabled,
    is_blob: !options[:blob].nil?,

    show_edit_button: show_edit_button?(options),
    show_web_ide_button: show_web_ide_button?,
    show_gitpod_button: show_gitpod_button?,
    show_pipeline_editor_button: show_pipeline_editor_button?(@project, @path),

    web_ide_url: web_ide_url,
    edit_url: edit_url(options),
    pipeline_editor_url: project_ci_pipeline_editor_path(@project, branch_name: @ref),

    gitpod_url: gitpod_url,
    user_preferences_gitpod_path: profile_preferences_path(anchor: 'user_gitpod_enabled'),
    user_profile_enable_gitpod_path: (user: { gitpod_enabled: true })
  }
end