This instance will be upgraded to Heptapod 0.26.0rc1 on 2021-10-26 at 14:30 UTC+2 (a few minutes of down time)

project.rb 66.9 KB
Newer Older
1
2
# frozen_string_literal: true

3
4
require 'carrierwave/orm/activerecord'

gitlabhq's avatar
gitlabhq committed
5
class Project < ActiveRecord::Base
6
  include Gitlab::ConfigHelper
7
  include Gitlab::ShellAdapter
8
  include Gitlab::VisibilityLevel
Rémy Coutable's avatar
Rémy Coutable committed
9
  include AccessRequestable
10
  include Avatarable
11
  include CacheMarkdownField
12
13
  include Referable
  include Sortable
14
  include AfterCommitQueue
15
  include CaseSensitivity
16
  include TokenAuthenticatable
17
  include ValidAttribute
Felipe Artur's avatar
Felipe Artur committed
18
  include ProjectFeaturesCompatibility
19
  include SelectForProjectAuthorization
20
  include Presentable
21
  include Routable
22
  include GroupDescendant
23
  include Gitlab::SQL::Pattern
24
  include DeploymentPlatform
25
  include ::Gitlab::Utils::StrongMemoize
26
  include ChronicDurationAttribute
27
  include FastDestroyAll::Helpers
Jan Provaznik's avatar
Jan Provaznik committed
28
  include WithUploads
29
  include BatchDestroyDependentAssociations
30
  include FeatureGate
31
  include OptionallySearch
32
  include FromUnion
33
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
34

35
  extend Gitlab::ConfigHelper
36

37
  BoardLimitExceeded = Class.new(StandardError)
38

39
  STATISTICS_ATTRIBUTE = 'repositories_count'.freeze
40
  NUMBER_OF_PERMITTED_BOARDS = 1
Douwe Maan's avatar
Douwe Maan committed
41
  UNKNOWN_IMPORT_URL = 'http://unknown.git'.freeze
42
43
  # Hashed Storage versions handle rolling out new storage to project and dependents models:
  # nil: legacy
44
45
46
  # 1: repository
  # 2: attachments
  LATEST_STORAGE_VERSION = 2
47
48
49
50
  HASHED_STORAGE_FEATURES = {
    repository: 1,
    attachments: 2
  }.freeze
Jared Szechy's avatar
Jared Szechy committed
51

52
53
54
  # Valids ports to import from
  VALID_IMPORT_PORTS = [22, 80, 443].freeze

55
56
  cache_markdown_field :description, pipeline: :description

57
58
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
           :merge_requests_enabled?, :issues_enabled?, to: :project_feature,
59
                                                       allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
60

61
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
62

63
  default_value_for :archived, false
64
  default_value_for :visibility_level, gitlab_config_features.visibility_level
65
  default_value_for :resolve_outdated_diff_discussions, false
66
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
67
68
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
69
70
71
72
73
  default_value_for :issues_enabled, gitlab_config_features.issues
  default_value_for :merge_requests_enabled, gitlab_config_features.merge_requests
  default_value_for :builds_enabled, gitlab_config_features.builds
  default_value_for :wiki_enabled, gitlab_config_features.wiki
  default_value_for :snippets_enabled, gitlab_config_features.snippets
74
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
75

76
  add_authentication_token_field :runners_token
77

78
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
79

80
  before_save :ensure_runners_token
81

82
  after_save :update_project_statistics, if: :namespace_id_changed?
83
84
85

  after_save :create_import_state, if: ->(project) { project.import? && project.import_state.nil? }

86
  after_create :create_project_feature, unless: :project_feature
87

88
  after_create -> { SiteStatistic.track(STATISTICS_ATTRIBUTE) }
89
  before_destroy :untrack_site_statistics
90

91
92
93
94
  after_create :create_ci_cd_settings,
    unless: :ci_cd_settings,
    if: proc { ProjectCiCdSetting.available? }

95
  after_create :set_last_activity_at
96
  after_create :set_last_repository_updated_at
97
  after_update :update_forks_visibility_level
98

99
  before_destroy :remove_private_deploy_keys
100

101
  use_fast_destroy :build_trace_chunks
102

103
  after_destroy -> { run_after_commit { remove_pages } }
104
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
105

106
107
  after_validation :check_pending_delete

108
  # Storage specific hooks
109
  after_initialize :use_hashed_storage
110
  after_create :check_repository_absence!
111
112
  after_create :ensure_storage_path_exists
  after_save :ensure_storage_path_exists, if: :namespace_id_changed?
113

114
  acts_as_taggable
115

116
  attr_accessor :old_path_with_namespace
117
  attr_accessor :template_name
118
  attr_writer :pipeline_status
119
  attr_accessor :skip_disk_validation
120

121
122
  alias_attribute :title, :name

123
  # Relations
124
  belongs_to :creator, class_name: 'User'
125
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
126
  belongs_to :namespace
127
128
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
129

130
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
131
  has_many :boards, before_add: :validate_board_limit
Felipe Artur's avatar
Felipe Artur committed
132

133
  # Project services
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
  has_one :campfire_service
  has_one :drone_ci_service
  has_one :emails_on_push_service
  has_one :pipelines_email_service
  has_one :irker_service
  has_one :pivotaltracker_service
  has_one :hipchat_service
  has_one :flowdock_service
  has_one :assembla_service
  has_one :asana_service
  has_one :mattermost_slash_commands_service
  has_one :mattermost_service
  has_one :slack_slash_commands_service
  has_one :slack_service
  has_one :buildkite_service
  has_one :bamboo_service
  has_one :teamcity_service
  has_one :pushover_service
  has_one :jira_service
  has_one :redmine_service
  has_one :custom_issue_tracker_service
  has_one :bugzilla_service
  has_one :gitlab_issue_tracker_service, inverse_of: :project
  has_one :external_wiki_service
  has_one :kubernetes_service, inverse_of: :project
  has_one :prometheus_service, inverse_of: :project
  has_one :mock_ci_service
  has_one :mock_deployment_service
  has_one :mock_monitoring_service
  has_one :microsoft_teams_service
Matt Coleman's avatar
Matt Coleman committed
164
  has_one :packagist_service
165
  has_one :hangouts_chat_service
166

167
  # TODO: replace these relations with the fork network versions
168
169
  has_one  :forked_project_link,  foreign_key: "forked_to_project_id"
  has_one  :forked_from_project,  through:   :forked_project_link
170
171

  has_many :forked_project_links, foreign_key: "forked_from_project_id"
172
  has_many :forks,                through:     :forked_project_links, source: :forked_to_project
173
174
175
176
177
178
179
  # TODO: replace these relations with the fork network versions

  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
180
  has_one :fork_network, through: :fork_network_member
181

182
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
183
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
184

185
  # Merge Requests for target project should be removed with it
186
  has_many :merge_requests, foreign_key: 'target_project_id'
187
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
188
189
190
191
192
193
194
195
196
197
  has_many :issues
  has_many :labels, class_name: 'ProjectLabel'
  has_many :services
  has_many :events
  has_many :milestones
  has_many :notes
  has_many :snippets, class_name: 'ProjectSnippet'
  has_many :hooks, class_name: 'ProjectHook'
  has_many :protected_branches
  has_many :protected_tags
198
  has_many :repository_languages, -> { order "share DESC" }
199

200
  has_many :project_authorizations
201
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
202
  has_many :project_members, -> { where(requested_at: nil) },
203
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
204

205
  alias_method :members, :project_members
206
  has_many :users, through: :project_members
207

208
  has_many :requesters, -> { where.not(requested_at: nil) },
209
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
210
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
211

212
  has_many :deploy_keys_projects
213
  has_many :deploy_keys, through: :deploy_keys_projects
214
  has_many :users_star_projects
215
  has_many :starrers, through: :users_star_projects, source: :user
216
  has_many :releases
217
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
218
  has_many :lfs_objects, through: :lfs_objects_projects
219
  has_many :lfs_file_locks
220
  has_many :project_group_links
221
  has_many :invited_groups, through: :project_group_links, source: :group
222
223
  has_many :pages_domains
  has_many :todos
224
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
225

226
227
  has_many :internal_ids

228
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
229
  has_one :project_feature, inverse_of: :project
230
  has_one :statistics, class_name: 'ProjectStatistics'
231

Shinya Maeda's avatar
Shinya Maeda committed
232
  has_one :cluster_project, class_name: 'Clusters::Project'
233
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
234
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
235

236
237
  has_many :prometheus_metrics

238
239
240
  # Container repositories need to remove data from the container registry,
  # which is not managed by the DB. Hence we're still using dependent: :destroy
  # here.
241
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
242

243
  has_many :commit_statuses
244
  has_many :pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
245
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
246
247
248
249
250

  # Ci::Build objects store data on the file system such as artifact files and
  # build traces. Currently there's no efficient way of removing this data in
  # bulk that doesn't involve loading the rows into memory. As a result we're
  # still using `dependent: :destroy` here.
251
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
252
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
253
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
254
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
255
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
256
  has_many :variables, class_name: 'Ci::Variable'
257
258
259
260
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
  has_many :deployments
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
261
  has_many :project_deploy_tokens
262
  has_many :deploy_tokens, through: :project_deploy_tokens
263

264
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
265
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
266

267
  has_many :project_badges, class_name: 'ProjectBadge'
268
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
269

270
271
  has_many :remote_mirrors, inverse_of: :project

272
  accepts_nested_attributes_for :variables, allow_destroy: true
273
  accepts_nested_attributes_for :project_feature, update_only: true
274
  accepts_nested_attributes_for :import_data
275
  accepts_nested_attributes_for :auto_devops, update_only: true
276

277
278
279
280
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

281
  delegate :name, to: :owner, allow_nil: true, prefix: true
282
  delegate :members, to: :team, prefix: true
283
  delegate :add_user, :add_users, to: :team
284
285
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
286
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
287

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
288
  # Validations
289
  validates :creator, presence: true, on: :create
290
  validates :description, length: { maximum: 2000 }, allow_blank: true
291
  validates :ci_config_path,
292
    format: { without: %r{(\.{2}|\A/)},
293
              message: 'cannot include leading slash or directory traversal.' },
294
295
    length: { maximum: 255 },
    allow_blank: true
296
297
  validates :name,
    presence: true,
298
    length: { maximum: 255 },
299
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
300
              message: Gitlab::Regex.project_name_regex_message }
301
302
  validates :path,
    presence: true,
303
    project_path: true,
304
    length: { maximum: 255 }
305

306
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
307
  validates :name, uniqueness: { scope: :namespace_id }
308
309
  validates :import_url, url: { protocols: %w(http https ssh git),
                                allow_localhost: false,
310
                                enforce_user: true,
311
                                ports: VALID_IMPORT_PORTS }, if: [:external_import?, :import_url_changed?]
312
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
313
  validate :check_limit, on: :create
314
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
Douwe Maan's avatar
Douwe Maan committed
315
  validate :visibility_level_allowed_by_group
Douwe Maan's avatar
Douwe Maan committed
316
  validate :visibility_level_allowed_as_fork
317
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
318
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
319
320
321
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
322
  validates :variables, variable_duplicates: { scope: :environment_scope }
323

324
  # Scopes
325
  scope :pending_delete, -> { where(pending_delete: true) }
326
  scope :without_deleted, -> { where(pending_delete: false) }
327

328
329
330
  scope :with_storage_feature, ->(feature) { where('storage_version >= :version', version: HASHED_STORAGE_FEATURES[feature]) }
  scope :without_storage_feature, ->(feature) { where('storage_version < :version OR storage_version IS NULL', version: HASHED_STORAGE_FEATURES[feature]) }
  scope :with_unmigrated_storage, -> { where('storage_version < :version OR storage_version IS NULL', version: LATEST_STORAGE_VERSION) }
331

332
333
  # last_activity_at is throttled every minute, but last_repository_updated_at is updated with every push
  scope :sorted_by_activity, -> { reorder("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC") }
334
335
  scope :sorted_by_stars, -> { reorder('projects.star_count DESC') }

336
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
337
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
338
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
339
  scope :starred_by, ->(user) { joins(:users_star_projects).where('users_star_projects.user_id': user.id) }
Rémy Coutable's avatar
Rémy Coutable committed
340
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
341
  scope :visible_to_user_and_access_level, ->(user, access_level) { where(id: user.authorized_projects.where('project_authorizations.access_level >= ?', access_level).select(:id).reorder(nil)) }
342
  scope :archived, -> { where(archived: true) }
343
  scope :non_archived, -> { where(archived: false) }
344
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
345
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
346
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
347
  scope :with_statistics, -> { includes(:statistics) }
348
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
349
350
351
  scope :inside_path, ->(path) do
    # We need routes alias rs for JOIN so it does not conflict with
    # includes(:route) which we use in ProjectsFinder.
352
353
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
354
  end
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
    access_level_attribute = ProjectFeature.access_level_attribute(feature)
    with_project_feature.where(project_features: { access_level_attribute => [nil, ProjectFeature::PRIVATE, ProjectFeature::ENABLED] })
  }

  # Picks a feature where the level is exactly that given.
  scope :with_feature_access_level, ->(feature, level) {
    access_level_attribute = ProjectFeature.access_level_attribute(feature)
    with_project_feature.where(project_features: { access_level_attribute => level })
  }

  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
370
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
371
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
372
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
373

374
375
376
377
378
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

379
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
380

381
  chronic_duration_attr :build_timeout_human_readable, :build_timeout, default: 3600
382
383

  validates :build_timeout, allow_nil: true,
384
385
386
387
                            numericality: { greater_than_or_equal_to: 10.minutes,
                                            less_than: 1.month,
                                            only_integer: true,
                                            message: 'needs to be beetween 10 minutes and 1 month' }
388

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
  # Paginates a collection using a `WHERE id < ?` condition.
  #
  # before - A project ID to use for filtering out projects with an equal or
  #      greater ID. If no ID is given, all projects are included.
  #
  # limit - The maximum number of rows to include.
  def self.paginate_in_descending_order_using_id(
    before: nil,
    limit: Kaminari.config.default_per_page
  )
    relation = order_id_desc.limit(limit)
    relation = relation.where('projects.id < ?', before) if before

    relation
  end

  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

409
410
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
411
412
  def self.public_or_visible_to_user(user = nil)
    if user
413
414
415
      where('EXISTS (?) OR projects.visibility_level IN (?)',
            user.authorizations_for_projects,
            Gitlab::VisibilityLevel.levels_for_user(user))
416
    else
417
      public_to_user
418
419
420
    end
  end

421
422
423
  # project features may be "disabled", "internal" or "enabled". If "internal",
  # they are only available to team members. This scope returns projects where
  # the feature is either enabled, or internal with permission for the user.
424
425
426
427
  #
  # This method uses an optimised version of `with_feature_access_level` for
  # logged in users to more efficiently get private projects with the given
  # feature.
428
  def self.with_feature_available_for_user(feature, user)
429
430
431
432
433
434
435
    visible = [nil, ProjectFeature::ENABLED]

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
      column = ProjectFeature.quoted_access_level_column(feature)

436
437
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
438
439
              visible,
              ProjectFeature::PRIVATE,
440
              user.authorizations_for_projects)
441
442
443
    else
      with_feature_access_level(feature, visible)
    end
444
  end
Felipe Artur's avatar
Felipe Artur committed
445

Rémy Coutable's avatar
Rémy Coutable committed
446
447
  scope :active, -> { joins(:issues, :notes, :merge_requests).order('issues.created_at, notes.created_at, merge_requests.created_at DESC') }
  scope :abandoned, -> { where('projects.last_activity_at < ?', 6.months.ago) }
448

449
450
  scope :excluding_project, ->(project) { where.not(id: project) }

451
452
  scope :joins_import_state, -> { joins("LEFT JOIN project_mirror_data import_state ON import_state.project_id = projects.id") }
  scope :import_started, -> { joins_import_state.where("import_state.status = 'started' OR projects.import_status = 'started'") }
453

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
454
  class << self
455
456
457
458
459
460
461
    # Searches for a list of projects based on the query given in `query`.
    #
    # On PostgreSQL this method uses "ILIKE" to perform a case-insensitive
    # search. On MySQL a regular "LIKE" is used as it's already
    # case-insensitive.
    #
    # query - The search query as a String.
462
    def search(query)
463
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
464
    end
465

466
    def search_by_title(query)
467
      non_archived.fuzzy_search(query, [:name])
468
469
    end

470
471
472
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
473

474
    def sort_by_attribute(method)
475
476
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
477
478
479
        # storage_size is a joined column so we need to
        # pass a string to avoid AR adding the table name
        reorder('project_statistics.storage_size DESC, projects.id DESC')
480
481
482
483
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
484
485
      else
        order_by(method)
486
487
      end
    end
488
489

    def reference_pattern
490
      %r{
491
492
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
493
      }x
494
    end
495

496
497
498
499
    def reference_postfix
      '>'
    end

500
501
502
503
    def reference_postfix_escaped
      '&gt;'
    end

504
    # Pattern used to extract `namespace/project>` project references from text.
505
506
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
507
508
509
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
510
        (#{reference_postfix}|#{reference_postfix_escaped})
511
512
513
      }x
    end

514
    def trending
515
516
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
517
    end
518
519
520
521
522
523

    def cached_count
      Rails.cache.fetch('total_project_count', expires_in: 5.minutes) do
        Project.count
      end
    end
524
525

    def group_ids
526
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
527
    end
528
529
  end

530
531
532
533
534
535
536
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
  def ancestors_upto(top = nil)
    Gitlab::GroupHierarchy.new(Group.where(id: namespace_id))
      .base_and_ancestors(upto: top)
  end

537
  def lfs_enabled?
538
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
539

540
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
541
542
  end

543
  def auto_devops_enabled?
544
    if auto_devops&.enabled.nil?
545
      has_auto_devops_implicitly_enabled?
546
547
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
548
    end
549
550
  end

551
  def has_auto_devops_implicitly_enabled?
552
553
    auto_devops&.enabled.nil? &&
      (Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
554
555
  end

556
  def has_auto_devops_implicitly_disabled?
557
    auto_devops&.enabled.nil? && !(Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
558
559
  end

560
561
562
563
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
564
  def team
565
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
566
567
568
  end

  def repository
569
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
570
571
  end

572
  def cleanup
573
574
575
    @repository = nil
  end

576
577
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
578
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
579
    if Gitlab.config.registry.enabled
580
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
581
    end
582
583
  end

584
  def has_container_registry_tags?
585
586
587
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
588
      has_root_container_repository_tags?
589
590
  end

591
592
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
593
594
  end

595
596
597
598
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

599
600
601
602
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

603
  # ref can't be HEAD, can only be branch/tag name or SHA
604
  def latest_successful_builds_for(ref = default_branch)
605
    latest_pipeline = pipelines.latest_successful_for(ref)
606
607

    if latest_pipeline
608
      latest_pipeline.builds.latest.with_artifacts_archive
609
610
611
    else
      builds.none
    end
612
613
  end

614
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
615
    sha = repository.merge_base(first_commit_id, second_commit_id)
616
    commit_by(oid: sha) if sha
617
618
  end

619
  def saved?
620
    id && persisted?
621
622
  end

623
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
624
625
    job_id =
      if forked?
626
        RepositoryForkWorker.perform_async(id)
627
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
628
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
629
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
630
631
632
      else
        RepositoryImportWorker.perform_async(self.id)
      end
633

634
635
636
637
638
639
640
641
    log_import_activity(job_id)

    job_id
  end

  def log_import_activity(job_id, type: :import)
    job_type = type.to_s.capitalize

642
    if job_id
643
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
644
    else
645
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
646
    end
647
648
  end

649
650
651
652
653
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

654
    update(import_error: nil)
655
656
657
658
659
    remove_import_data
  end

  # This method is overriden in EE::Project model
  def remove_import_data
660
    import_data&.destroy
661
662
  end

663
  def ci_config_path=(value)
664
    # Strip all leading slashes so that //foo -> foo
665
    super(value&.delete("\0"))
666
667
  end

668
  def import_url=(value)
James Lopez's avatar
James Lopez committed
669
670
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

671
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez's avatar
James Lopez committed
672
    super(import_url.sanitized_url)
673
    create_or_update_import_data(credentials: import_url.credentials)
674
675
676
  end

  def import_url
James Lopez's avatar
James Lopez committed
677
    if import_data && super.present?
678
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
679
680
681
      import_url.full_url
    else
      super
682
683
    end
  end
684

James Lopez's avatar
James Lopez committed
685
  def valid_import_url?
686
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
687
688
  end

689
  def create_or_update_import_data(data: nil, credentials: nil)
690
    return if data.nil? && credentials.nil?
691

James Lopez's avatar
James Lopez committed
692
    project_import_data = import_data || build_import_data
James Lopez's avatar
James Lopez committed
693
694
695
696
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
697

698
699
700
701
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
702
703

    project_import_data
704
  end
705

706
  def import?
James Lopez's avatar
James Lopez committed
707
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
708
709
710
  end

  def external_import?
711
712
713
    import_url.present?
  end

714
  def imported?
715
716
717
718
    import_finished?
  end

  def import_in_progress?
719
720
721
    import_started? || import_scheduled?
  end

722
723
724
725
726
727
728
729
  def import_state_args
    {
      status: self[:import_status],
      jid: self[:import_jid],
      last_error: self[:import_error]
    }
  end

730
731
  def ensure_import_state(force: false)
    return if !force && (self[:import_status] == 'none' || self[:import_status].nil?)
732
733
    return unless import_state.nil?

734
735
    if persisted?
      create_import_state(import_state_args)
736

737
738
739
740
741
742
      update_column(:import_status, 'none')
    else
      build_import_state(import_state_args)

      self[:import_status] = 'none'
    end
743
744
  end

745
746
747
748
749
750
  def human_import_status_name
    ensure_import_state

    import_state.human_status_name
  end

751
  def import_schedule
752
    ensure_import_state(force: true)
753

754
    import_state.schedule
755
756
757
  end

  def force_import_start
758
    ensure_import_state(force: true)
759

760
    import_state.force_start
761
762
763
  end

  def import_start
764
    ensure_import_state(force: true)
765

766
    import_state.start
767
768
769
  end

  def import_fail
770
    ensure_import_state(force: true)
771

772
    import_state.fail_op
773
774
775
  end

  def import_finish
776
    ensure_import_state(force: true)
777

778
    import_state.finish
779
780
781
  end

  def import_jid=(new_jid)
782
    ensure_import_state(force: true)
783

784
    import_state.jid = new_jid
785
786
787
788
789
790
791
792
793
  end

  def import_jid
    ensure_import_state

    import_state&.jid
  end

  def import_error=(new_error)
794
    ensure_import_state(force: true)
795

796
    import_state.last_error = new_error
797
798
799
800
801
802
803
804
805
  end

  def import_error
    ensure_import_state

    import_state&.last_error
  end

  def import_status=(new_status)
806
    ensure_import_state(force: true)
807

808
    import_state.status = new_status
809
810
811
812
813
814
815
816
817
818
819
820
  end

  def import_status
    ensure_import_state

    import_state&.status || 'none'
  end

  def no_import?
    import_status == 'none'
  end

821
  def import_started?
822
823
    # import? does SQL work so only run it if it looks like there's an import running
    import_status == 'started' && import?
824
825
  end

826
827
828
829
  def import_scheduled?
    import_status == 'scheduled'
  end

830
831
832
833
834
835
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
836
837
  end

838
  def safe_import_url
839
    Gitlab::UrlSanitizer.new(import_url).masked_url
840
841
  end

842
843
844
845
  def bare_repository_import?
    import_type == 'bare_repository'
  end

846
847
848
849
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
850
851
852
853
  def gitea_import?
    import_type == 'gitea'
  end