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 68.1 KB
Newer Older
1
2
# frozen_string_literal: true

3
4
require 'carrierwave/orm/activerecord'

5
class Project < ApplicationRecord
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
  include IgnorableColumn
34
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
35

36
  extend Gitlab::ConfigHelper
37

38
  BoardLimitExceeded = Class.new(StandardError)
39

40
  STATISTICS_ATTRIBUTE = 'repositories_count'.freeze
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
55
56
  VALID_IMPORT_PORTS = [80, 443].freeze
  VALID_IMPORT_PROTOCOLS = %w(http https git).freeze

  VALID_MIRROR_PORTS = [22, 80, 443].freeze
  VALID_MIRROR_PROTOCOLS = %w(http https ssh git).freeze
57

58
  ignore_column :import_status, :import_jid, :import_error
59
  ignore_column :ci_id
60

61
62
  cache_markdown_field :description, pipeline: :description

63
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
64
65
           :merge_requests_enabled?, :issues_enabled?, :pages_enabled?, :public_pages?,
           to: :project_feature, allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
66

67
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
68

69
70
71
72
73
74
  delegate :scheduled?, :started?, :in_progress?,
    :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true

  delegate :no_import?, to: :import_state, allow_nil: true

75
  default_value_for :archived, false
76
  default_value_for(:visibility_level) { Gitlab::CurrentSettings.default_project_visibility }
77
  default_value_for :resolve_outdated_diff_discussions, false
78
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
79
80
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
81
82
83
84
85
  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
86
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
87

88
  add_authentication_token_field :runners_token, encrypted: -> { Feature.enabled?(:projects_tokens_optional_encryption, default_enabled: true) ? :optional : :required }
89

90
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
91

92
  before_save :ensure_runners_token
93

Jasper Maes's avatar
Jasper Maes committed
94
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
95
96
97

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

98
  after_create :create_project_feature, unless: :project_feature
99
100
101
102
103

  after_create :create_ci_cd_settings,
    unless: :ci_cd_settings,
    if: proc { ProjectCiCdSetting.available? }

Mark Chao's avatar
Mark Chao committed
104
  after_create :set_timestamps_for_create
105
  after_update :update_forks_visibility_level
106

107
  before_destroy :remove_private_deploy_keys
108

109
  use_fast_destroy :build_trace_chunks
110

111
  after_destroy -> { run_after_commit { remove_pages } }
112
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
113

114
115
  after_validation :check_pending_delete

116
  # Storage specific hooks
117
  after_initialize :use_hashed_storage
118
  after_create :check_repository_absence!
119
  after_create :ensure_storage_path_exists
Jasper Maes's avatar
Jasper Maes committed
120
  after_save :ensure_storage_path_exists, if: :saved_change_to_namespace_id?
121

122
  acts_as_ordered_taggable
123

124
  attr_accessor :old_path_with_namespace
125
  attr_accessor :template_name
126
  attr_writer :pipeline_status
127
  attr_accessor :skip_disk_validation
128

129
130
  alias_attribute :title, :name

131
  # Relations
Nick Thomas's avatar
Nick Thomas committed
132
  belongs_to :pool_repository
133
  belongs_to :creator, class_name: 'User'
134
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
135
  belongs_to :namespace
136
137
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
138

139
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
140
  has_many :boards
Felipe Artur's avatar
Felipe Artur committed
141

142
  # Project services
143
  has_one :campfire_service
blackst0ne's avatar
blackst0ne committed
144
  has_one :discord_service
145
146
147
148
149
  has_one :drone_ci_service
  has_one :emails_on_push_service
  has_one :pipelines_email_service
  has_one :irker_service
  has_one :pivotaltracker_service
150
  has_one :hipchat_service
151
152
153
154
155
156
157
158
159
160
161
162
163
  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
Yauhen Kotau's avatar
Yauhen Kotau committed
164
  has_one :youtrack_service
165
166
167
168
169
170
171
172
173
174
  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
175
  has_one :packagist_service
176
  has_one :hangouts_chat_service
177

178
179
180
181
182
  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
183
  has_one :fork_network, through: :fork_network_member
184
185
186
  has_one :forked_from_project, through: :fork_network_member
  has_many :forked_to_members, class_name: 'ForkNetworkMember', foreign_key: 'forked_from_project_id'
  has_many :forks, through: :forked_to_members, source: :project, inverse_of: :forked_from_project
187

188
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
189
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
190
  has_one :project_repository, inverse_of: :project
191
  has_one :error_tracking_setting, inverse_of: :project, class_name: 'ErrorTracking::ProjectErrorTrackingSetting'
192
  has_one :metrics_setting, inverse_of: :project, class_name: 'ProjectMetricsSetting'
193

194
  # Merge Requests for target project should be removed with it
195
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
196
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
197
198
199
200
201
202
203
204
205
206
  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
207
  has_many :repository_languages, -> { order "share DESC" }
208

209
  has_many :project_authorizations
210
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
211
  has_many :project_members, -> { where(requested_at: nil) },
212
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
213

214
  alias_method :members, :project_members
215
  has_many :users, through: :project_members
216

217
  has_many :requesters, -> { where.not(requested_at: nil) },
218
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
219
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
220

221
  has_many :deploy_keys_projects
222
  has_many :deploy_keys, through: :deploy_keys_projects
223
  has_many :users_star_projects
224
  has_many :starrers, through: :users_star_projects, source: :user
225
  has_many :releases
226
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
227
  has_many :lfs_objects, through: :lfs_objects_projects
228
  has_many :lfs_file_locks
229
  has_many :project_group_links
230
  has_many :invited_groups, through: :project_group_links, source: :group
231
232
  has_many :pages_domains
  has_many :todos
233
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
234

235
236
  has_many :internal_ids

237
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
238
  has_one :project_feature, inverse_of: :project
239
  has_one :statistics, class_name: 'ProjectStatistics'
240

Shinya Maeda's avatar
Shinya Maeda committed
241
  has_one :cluster_project, class_name: 'Clusters::Project'
242
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
243
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
244
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
245

246
247
  has_many :prometheus_metrics

248
249
250
  # 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.
251
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
252

253
  has_many :commit_statuses
254
  # The relation :all_pipelines is intended to be used when we want to get the
255
256
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
257
  # The relation :ci_pipelines is intended to be used when we want to get only
258
259
260
261
  # those pipeline which are directly related to CI. There are
  # other pipelines, like webide ones, that we won't retrieve
  # if we use this relation.
  has_many :ci_pipelines,
262
          -> { ci_sources },
263
264
          class_name: 'Ci::Pipeline',
          inverse_of: :project
265
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
266
267
268
269
270

  # 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.
271
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
272
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
273
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
274
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
275
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
276
  has_many :variables, class_name: 'Ci::Variable'
277
278
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
279
  has_many :deployments, -> { success }
280
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
281
  has_many :project_deploy_tokens
282
  has_many :deploy_tokens, through: :project_deploy_tokens
283

284
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
285
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
286

287
  has_many :project_badges, class_name: 'ProjectBadge'
288
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
289

290
291
  has_many :remote_mirrors, inverse_of: :project

292
  accepts_nested_attributes_for :variables, allow_destroy: true
293
  accepts_nested_attributes_for :project_feature, update_only: true
294
  accepts_nested_attributes_for :import_data
295
  accepts_nested_attributes_for :auto_devops, update_only: true
296

297
298
299
300
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

301
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
302
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
303

304
  delegate :name, to: :owner, allow_nil: true, prefix: true
305
  delegate :members, to: :team, prefix: true
306
  delegate :add_user, :add_users, to: :team
307
308
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
309
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
310
311
  delegate :group_clusters_enabled?, to: :group, allow_nil: true
  delegate :root_ancestor, to: :namespace, allow_nil: true
312
  delegate :last_pipeline, to: :commit, allow_nil: true
313

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
314
  # Validations
315
  validates :creator, presence: true, on: :create
316
  validates :description, length: { maximum: 2000 }, allow_blank: true
317
  validates :ci_config_path,
318
    format: { without: %r{(\.{2}|\A/)},
319
              message: _('cannot include leading slash or directory traversal.') },
320
321
    length: { maximum: 255 },
    allow_blank: true
322
323
  validates :name,
    presence: true,
324
    length: { maximum: 255 },
325
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
326
              message: Gitlab::Regex.project_name_regex_message }
327
328
  validates :path,
    presence: true,
329
    project_path: true,
330
    length: { maximum: 255 }
331

332
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
333
  validates :name, uniqueness: { scope: :namespace_id }
334
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
335
336
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
337
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
338
  validate :check_personal_projects_limit, on: :create
339
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
340
341
  validate :visibility_level_allowed_by_group, if: -> { changes.has_key?(:visibility_level) }
  validate :visibility_level_allowed_as_fork, if: -> { changes.has_key?(:visibility_level) }
342
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
343
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
344
345
346
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
347
  validates :variables, variable_duplicates: { scope: :environment_scope }
348
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
349

350
  # Scopes
351
  scope :pending_delete, -> { where(pending_delete: true) }
352
  scope :without_deleted, -> { where(pending_delete: false) }
353

354
355
356
  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) }
357

358
359
  # 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") }
360
  scope :sorted_by_stars, -> { reorder(star_count: :desc) }
361

362
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
363
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
364
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
365
  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
366
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
367
  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)) }
368
  scope :archived, -> { where(archived: true) }
369
  scope :non_archived, -> { where(archived: false) }
370
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
371
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
372
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
373
  scope :with_statistics, -> { includes(:statistics) }
374
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
375
376
377
  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.
378
379
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
380
  end
381
382
383

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
384
385
386
387
    access_level_attribute = ProjectFeature.arel_table[ProjectFeature.access_level_attribute(feature)]
    enabled_feature = access_level_attribute.gt(ProjectFeature::DISABLED).or(access_level_attribute.eq(nil))

    with_project_feature.where(enabled_feature)
388
389
390
391
392
393
394
395
  }

  # 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 })
  }

396
397
398
399
400
401
402
403
404
405
  # Picks projects which use the given programming language
  scope :with_programming_language, ->(language_name) do
    lang_id_query = ProgrammingLanguage
        .with_name_case_insensitive(language_name)
        .select(:id)

    joins(:repository_languages)
        .where(repository_languages: { programming_language_id: lang_id_query })
  end

406
407
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
408
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
409
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
410
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
411

412
413
414
415
416
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

417
418
419
420
421
422
  scope :missing_kubernetes_namespace, -> (kubernetes_namespaces) do
    subquery = kubernetes_namespaces.select('1').where('clusters_kubernetes_namespaces.project_id = projects.id')

    where('NOT EXISTS (?)', subquery)
  end

423
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
424

425
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
426
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
427
428

  validates :build_timeout, allow_nil: true,
429
430
431
                            numericality: { greater_than_or_equal_to: 10.minutes,
                                            less_than: 1.month,
                                            only_integer: true,
432
                                            message: _('needs to be beetween 10 minutes and 1 month') }
433

434
435
436
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

437
438
439
440
441
442
443
  # Returns a project, if it is not about to be removed.
  #
  # id - The ID of the project to retrieve.
  def self.find_without_deleted(id)
    without_deleted.find_by_id(id)
  end

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
  # 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

464
465
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
466
467
468
469
470
471
472
  def self.public_or_visible_to_user(user = nil)
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
            user.authorizations_for_projects,
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
473
474
475
    end
  end

476
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
477
  # they are only available to team members. This scope returns projects where
478
  # the feature is either public, enabled, or internal with permission for the user.
479
480
481
482
  #
  # 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.
483
  def self.with_feature_available_for_user(feature, user)
484
485
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
    min_access_level = ProjectFeature.required_minimum_access_level(feature)
486
487
488
489
490
491

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

492
      with_project_feature
493
494
495
496
497
498
499
500
501
        .where(
          "(projects.visibility_level > :private AND (#{column} IS NULL OR #{column} >= (:public_visible) OR (#{column} = :private_visible AND EXISTS(:authorizations))))"\
          " OR (projects.visibility_level = :private AND (#{column} IS NULL OR #{column} >= :private_visible) AND EXISTS(:authorizations))",
          {
            private: Gitlab::VisibilityLevel::PRIVATE,
            public_visible: ProjectFeature::ENABLED,
            private_visible: ProjectFeature::PRIVATE,
            authorizations: user.authorizations_for_projects(min_access_level: min_access_level)
          })
502
503
504
    else
      with_feature_access_level(feature, visible)
    end
505
  end
Felipe Artur's avatar
Felipe Artur committed
506

Rémy Coutable's avatar
Rémy Coutable committed
507
508
  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) }
509

510
511
  scope :excluding_project, ->(project) { where.not(id: project) }

512
513
  # We require an alias to the project_mirror_data_table in order to use import_state in our queries
  scope :joins_import_state, -> { joins("INNER JOIN project_mirror_data import_state ON import_state.project_id = projects.id") }
514
  scope :for_group, -> (group) { where(group: group) }
515

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
516
  class << self
517
518
519
520
521
522
523
    # 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.
524
    def search(query)
525
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
526
    end
527

528
    def search_by_title(query)
529
      non_archived.fuzzy_search(query, [:name])
530
531
    end

532
533
534
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
535

536
    def sort_by_attribute(method)
537
538
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
539
540
541
        # 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')
542
543
544
545
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
546
547
      when 'stars_desc'
        sorted_by_stars
548
549
      else
        order_by(method)
550
551
      end
    end
552
553

    def reference_pattern
554
      %r{
555
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
556
557
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
558
      }x
559
    end
560

561
562
563
564
    def reference_postfix
      '>'
    end

565
566
567
568
    def reference_postfix_escaped
      '&gt;'
    end

569
    # Pattern used to extract `namespace/project>` project references from text.
570
571
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
572
573
574
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
575
        (#{reference_postfix}|#{reference_postfix_escaped})
576
577
578
      }x
    end

579
    def trending
580
581
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
582
    end
583
584
585
586
587
588

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

    def group_ids
591
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
592
    end
593
594
  end

595
596
597
598
599
600
601
602
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

603
604
605
606
607
608
609
610
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

611
612
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
613
  def ancestors_upto(top = nil, hierarchy_order: nil)
614
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
615
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
616
617
  end

618
619
  alias_method :ancestors, :ancestors_upto

620
  def lfs_enabled?
621
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
622

623
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
624
625
  end

Cindy Pallares's avatar
Cindy Pallares committed
626
627
  alias_method :lfs_enabled, :lfs_enabled?

628
  def auto_devops_enabled?
629
    if auto_devops&.enabled.nil?
630
      has_auto_devops_implicitly_enabled?
631
632
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
633
    end
634
635
  end

636
  def has_auto_devops_implicitly_enabled?
637
638
639
    auto_devops_config = first_auto_devops_config

    auto_devops_config[:scope] != :project && auto_devops_config[:status]
640
641
  end

642
  def has_auto_devops_implicitly_disabled?
643
644
645
646
647
648
649
650
651
    auto_devops_config = first_auto_devops_config

    auto_devops_config[:scope] != :project && !auto_devops_config[:status]
  end

  def first_auto_devops_config
    return namespace.first_auto_devops_config if auto_devops&.enabled.nil?

    { scope: :project, status: auto_devops&.enabled || Feature.enabled?(:force_autodevops_on_by_default, self) }
652
653
  end

654
655
656
657
  def multiple_mr_assignees_enabled?
    Feature.enabled?(:multiple_merge_request_assignees, self)
  end

Jacopo's avatar
Jacopo committed
658
659
660
661
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

662
663
664
665
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
666
  def team
667
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
668
669
670
  end

  def repository
671
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
672
673
  end

674
  def cleanup
675
676
677
    @repository = nil
  end

678
679
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
680
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
681
    if Gitlab.config.registry.enabled
682
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
683
    end
684
685
  end

686
  def has_container_registry_tags?
687
688
689
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
690
      has_root_container_repository_tags?
691
692
  end

693
694
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
695
696
  end

697
698
699
700
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

701
702
703
704
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

705
  # ref can't be HEAD, can only be branch/tag name or SHA
706
  def latest_successful_build_for(job_name, ref = default_branch)
707
    latest_pipeline = ci_pipelines.latest_successful_for(ref)
708
    return unless latest_pipeline
709

710
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
711
712
  end

713
  def latest_successful_build_for!(job_name, ref = default_branch)
714
715
716
    latest_successful_build_for(job_name, ref) || raise(ActiveRecord::RecordNotFound.new("Couldn't find job #{job_name}"))
  end

717
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
718
    sha = repository.merge_base(first_commit_id, second_commit_id)
719
    commit_by(oid: sha) if sha
720
721
  end

722
  def saved?
723
    id && persisted?
724
725
  end

726
727
728
729
730
731
732
733
  def import_status
    import_state&.status || 'none'
  end

  def human_import_status_name
    import_state&.human_status_name || 'none'
  end

734
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
735
736
    job_id =
      if forked?
737
        RepositoryForkWorker.perform_async(id)
738
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
739
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
740
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
741
742
743
      else
        RepositoryImportWorker.perform_async(self.id)
      end
744

745
746
747
748
749
750
751
752
    log_import_activity(job_id)

    job_id
  end

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

753
    if job_id
754
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
755
    else
756
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
757
    end
758
759
  end

760
761
762
763
764
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

765
    import_state.update(last_error: nil)
766
767
768
    remove_import_data
  end

769
  # This method is overridden in EE::Project model
770
  def remove_import_data
771
    import_data&.destroy
772
773
  end

774
  def ci_config_path=(value)
775
    # Strip all leading slashes so that //foo -> foo
776
    super(value&.delete("\0"))
777
778
  end

779
  def import_url=(value)
780
781
782
783
784
785
786
    if Gitlab::UrlSanitizer.valid?(value)
      import_url = Gitlab::UrlSanitizer.new(value)
      super(import_url.sanitized_url)
      create_or_update_import_data(credentials: import_url.credentials)
    else
      super(value)
    end
787
788
789
  end

  def import_url
James Lopez's avatar
James Lopez committed
790
    if import_data && super.present?
791
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
792
793
794
      import_url.full_url
    else
      super
795
    end
796
797
  rescue
    super
798
  end
799

James Lopez's avatar
James Lopez committed
800
  def valid_import_url?
801
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
802
803
  end

804
  def create_or_update_import_data(data: nil, credentials: nil)
805
    return if data.nil? && credentials.nil?
806

James Lopez's avatar
James Lopez committed
807
    project_import_data = import_data || build_import_data
808

809
810
    project_import_data.merge_data(data.to_h)
    project_import_data.merge_credentials(credentials.to_h)
811
812

    project_import_data
813
  end
814

815
  def import?
James Lopez's avatar
James Lopez committed
816
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
817
818
819
  end

  def external_import?
820
821
822
    import_url.present?
  end

823
  def safe_import_url
824
    Gitlab::UrlSanitizer.new(import_url).masked_url
825
826
  end

827
828
829
830
  def bare_repository_import?
    import_type == 'bare_repository'
  end

831
832
833
834
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
835
836
837
838
  def gitea_import?
    import_type == 'gitea'
  end

839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
  def has_remote_mirror?
    remote_mirror_available? && remote_mirrors.enabled.exists?
  end

  def updating_remote_mirror?
    remote_mirrors.enabled.started.exists?
  end

  def update_remote_mirrors