project.rb 66.2 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
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
33

34
  extend Gitlab::ConfigHelper
35

36
  BoardLimitExceeded = Class.new(StandardError)
37

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

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

54
55
  cache_markdown_field :description, pipeline: :description

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

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

62
  default_value_for :archived, false
63
  default_value_for :visibility_level, gitlab_config_features.visibility_level
64
  default_value_for :resolve_outdated_diff_discussions, false
65
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
66
67
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
68
69
70
71
72
  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
73
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
74

75
  add_authentication_token_field :runners_token
76

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

79
  before_save :ensure_runners_token
80

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

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

85
  after_create :create_project_feature, unless: :project_feature
86

87
  after_create -> { SiteStatistic.track(STATISTICS_ATTRIBUTE) }
88
89
  before_destroy ->(project) { project.project_feature } # keep reference so we can untrack later
  after_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
238
  # 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.
239
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
240

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

  # 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.
249
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
250
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
251
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
252
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
253
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
254
  has_many :variables, class_name: 'Ci::Variable'
255
256
257
258
  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
259
  has_many :project_deploy_tokens
260
  has_many :deploy_tokens, through: :project_deploy_tokens
261

262
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
263
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
264

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

268
269
  has_many :remote_mirrors, inverse_of: :project

270
  accepts_nested_attributes_for :variables, allow_destroy: true
271
  accepts_nested_attributes_for :project_feature, update_only: true
272
  accepts_nested_attributes_for :import_data
273
  accepts_nested_attributes_for :auto_devops, update_only: true
274

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

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

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

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

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

326
327
328
  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) }
329

330
331
  # 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") }
332
333
  scope :sorted_by_stars, -> { reorder('projects.star_count DESC') }

334
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
335
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
336
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
337
  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
338
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
339
  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)) }
340
  scope :archived, -> { where(archived: true) }
341
  scope :non_archived, -> { where(archived: false) }
342
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
343
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
344
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
345
  scope :with_statistics, -> { includes(:statistics) }
346
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
347
348
349
  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.
350
351
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
352
  end
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367

  # "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) }
368
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
369
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
370
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
371

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

377
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
378

379
  chronic_duration_attr :build_timeout_human_readable, :build_timeout, default: 3600
380
381

  validates :build_timeout, allow_nil: true,
382
383
384
385
                            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' }
386

387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
  # 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

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

419
420
421
  # 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.
422
423
424
425
  #
  # 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.
426
  def self.with_feature_available_for_user(feature, user)
427
428
429
430
431
432
433
    visible = [nil, ProjectFeature::ENABLED]

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

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

Rémy Coutable's avatar
Rémy Coutable committed
444
445
  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) }
446

447
448
  scope :excluding_project, ->(project) { where.not(id: project) }

449
450
  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'") }
451

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
452
  class << self
453
454
455
456
457
458
459
    # 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.
460
    def search(query)
461
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
462
    end
463

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

468
469
470
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
471

472
    def sort_by_attribute(method)
473
474
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
475
476
477
        # 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')
478
479
480
481
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
482
483
      else
        order_by(method)
484
485
      end
    end
486
487

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

494
495
496
497
    def reference_postfix
      '>'
    end

498
499
500
501
    def reference_postfix_escaped
      '&gt;'
    end

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

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

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

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

528
529
530
531
532
533
534
  # 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

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

538
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
539
540
  end

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

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

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

558
559
560
561
  def empty_repo?
    repository.empty?
  end

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

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

570
571
  def cleanup
    @repository&.cleanup
572
573
574
    @repository = nil
  end

575
576
  alias_method :reload_repository!, :cleanup

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

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

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

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

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

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

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

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

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

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

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

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

    job_id
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

    project_import_data
703
  end
704

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

  def external_import?
710
711
712
    import_url.present?
  end

713
  def imported?
714
715
716
717
    import_finished?
  end

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

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

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

733
734
    if persisted?
      create_import_state(import_state_args)
735

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

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

744
745
746
747
748
749
  def human_import_status_name
    ensure_import_state

    import_state.human_status_name
  end

750
  def import_schedule
751
    ensure_import_state(force: true)
752

753
    import_state.schedule
754
755
756
  end

  def force_import_start
757
    ensure_import_state(force: true)
758

759
    import_state.force_start
760
761
762
  end

  def import_start
763
    ensure_import_state(force: true)
764

765
    import_state.start
766
767
768
  end

  def import_fail
769
    ensure_import_state(force: true)
770

771
    import_state.fail_op
772
773
774
  end

  def import_finish
775
    ensure_import_state(force: true)
776

777
    import_state.finish
778
779
780
  end

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

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

  def import_jid
    ensure_import_state

    import_state&.jid
  end

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

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

  def import_error
    ensure_import_state

    import_state&.last_error
  end

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

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

  def import_status
    ensure_import_state

    import_state&.status || 'none'
  end

  def no_import?
    import_status == 'none'
  end

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

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

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

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

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

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

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

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