project.rb 88.6 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::VisibilityLevel
Rémy Coutable's avatar
Rémy Coutable committed
8
  include AccessRequestable
9
  include Avatarable
10
  include CacheMarkdownField
11
  include Sortable
12
  include AfterCommitQueue
13
  include CaseSensitivity
14
  include TokenAuthenticatable
15
  include ValidAttribute
16
  include ProjectAPICompatibility
Felipe Artur's avatar
Felipe Artur committed
17
  include ProjectFeaturesCompatibility
18
  include SelectForProjectAuthorization
19
  include Presentable
20
  include HasRepository
21
  include HasWiki
22
  include Routable
23
  include GroupDescendant
24
  include Gitlab::SQL::Pattern
25
  include DeploymentPlatform
26
  include ::Gitlab::Utils::StrongMemoize
27
  include ChronicDurationAttribute
28
  include FastDestroyAll::Helpers
Jan Provaznik's avatar
Jan Provaznik committed
29
  include WithUploads
30
  include BatchDestroyDependentAssociations
31
  include FeatureGate
32
  include OptionallySearch
33
  include FromUnion
34
  include IgnorableColumns
35
  include Integration
36
  include EachBatch
37
  extend Gitlab::Cache::RequestCache
38
  extend Gitlab::Utils::Override
Robert Speicher's avatar
Robert Speicher committed
39

40
  extend Gitlab::ConfigHelper
41

42
  BoardLimitExceeded = Class.new(StandardError)
43

44
  MERCURIAL_VCS_TYPES = %w[hg hg_git].freeze
45
  VCS_TYPES_WITH_GIT_REPO = %w[hg_git hg git].freeze
46
47
  STATISTICS_ATTRIBUTE = 'repositories_count'
  UNKNOWN_IMPORT_URL = 'http://unknown.git'
48
49
  # Hashed Storage versions handle rolling out new storage to project and dependents models:
  # nil: legacy
50
51
52
  # 1: repository
  # 2: attachments
  LATEST_STORAGE_VERSION = 2
53
54
55
56
  HASHED_STORAGE_FEATURES = {
    repository: 1,
    attachments: 2
  }.freeze
Jared Szechy's avatar
Jared Szechy committed
57

58
59
60
61
62
  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
63

64
65
  ACCESS_REQUEST_APPROVERS_TO_BE_NOTIFIED_LIMIT = 10

George Koltsov's avatar
George Koltsov committed
66
  SORTING_PREFERENCE_FIELD = :projects_sort
67
  MAX_BUILD_TIMEOUT = 1.month
George Koltsov's avatar
George Koltsov committed
68

69
70
  cache_markdown_field :description, pipeline: :description

71
  default_value_for :packages_enabled, true
72
  default_value_for :archived, false
73
  default_value_for :resolve_outdated_diff_discussions, false
74
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
75
  default_value_for(:repository_storage) do
76
    pick_repository_storage
77
78
  end

79
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
80
81
82
83
84
  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
85
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
86
  default_value_for :remove_source_branch_after_merge, true
87
  default_value_for :autoclose_referenced_issues, true
88
  default_value_for(:ci_config_path) { Gitlab::CurrentSettings.default_ci_config_path }
89

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

92
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
93

94
  before_save :ensure_runners_token
95

Jasper Maes's avatar
Jasper Maes committed
96
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
97
98
99

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

100
  after_create :create_project_feature, unless: :project_feature
101
102

  after_create :create_ci_cd_settings,
103
    unless: :ci_cd_settings
104

105
106
107
  after_create :create_container_expiration_policy,
               unless: :container_expiration_policy

108
  after_create :create_pages_metadatum,
109
               unless: :pages_metadatum
110

Mark Chao's avatar
Mark Chao committed
111
  after_create :set_timestamps_for_create
112
  after_update :update_forks_visibility_level
113

114
  before_destroy :remove_private_deploy_keys
115

116
  use_fast_destroy :build_trace_chunks
117

118
  after_destroy -> { run_after_commit { remove_pages } }
119
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
120

121
122
  after_validation :check_pending_delete

123
  # Storage specific hooks
124
  after_initialize :use_hashed_storage
125
  after_create :check_repository_absence!
126

127
  acts_as_ordered_taggable
128

129
  attr_accessor :old_path_with_namespace
130
  attr_accessor :template_name
131
  attr_writer :pipeline_status
132
  attr_accessor :skip_disk_validation
133

134
135
  alias_attribute :title, :name

136
  # Relations
Nick Thomas's avatar
Nick Thomas committed
137
  belongs_to :pool_repository
138
  belongs_to :creator, class_name: 'User'
139
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
140
  belongs_to :namespace
141
142
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
143

144
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
145
  has_many :boards
Felipe Artur's avatar
Felipe Artur committed
146

147
  # Project services
148
  has_one :alerts_service
149
  has_one :campfire_service
blackst0ne's avatar
blackst0ne committed
150
  has_one :discord_service
151
152
  has_one :drone_ci_service
  has_one :emails_on_push_service
153
  has_one :ewm_service
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
  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
Georges Racinet's avatar
Georges Racinet committed
171
  has_one :readthedocs_service
Yauhen Kotau's avatar
Yauhen Kotau committed
172
  has_one :youtrack_service
173
174
  has_one :custom_issue_tracker_service
  has_one :bugzilla_service
175
  has_one :confluence_service
176
177
178
179
180
181
  has_one :external_wiki_service
  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
182
  has_one :packagist_service
183
  has_one :hangouts_chat_service
184
  has_one :unify_circuit_service
185
  has_one :webex_teams_service
186
187
188
189
190
191
192

  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
  has_one :fork_network, through: :fork_network_member
193
194
195
  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
196
  has_many :fork_network_projects, through: :fork_network, source: :projects
197

198
199
200
201
  # Packages
  has_many :packages, class_name: 'Packages::Package'
  has_many :package_files, through: :packages, class_name: 'Packages::PackageFile'

202
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
203
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
204
  has_many :export_jobs, class_name: 'ProjectExportJob'
205
  has_one :project_repository, inverse_of: :project
206
  has_one :tracing_setting, class_name: 'ProjectTracingSetting'
207
  has_one :incident_management_setting, inverse_of: :project, class_name: 'IncidentManagement::ProjectIncidentManagementSetting'
208
  has_one :error_tracking_setting, inverse_of: :project, class_name: 'ErrorTracking::ProjectErrorTrackingSetting'
209
  has_one :metrics_setting, inverse_of: :project, class_name: 'ProjectMetricsSetting'
210
  has_one :grafana_integration, inverse_of: :project
211
  has_one :project_setting, inverse_of: :project, autosave: true
212
  has_one :alerting_setting, inverse_of: :project, class_name: 'Alerting::ProjectAlertingSetting'
213
  has_one :service_desk_setting, class_name: 'ServiceDeskSetting'
214

215
  # Merge Requests for target project should be removed with it
216
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
217
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
218
219
220
221
222
  has_many :issues
  has_many :labels, class_name: 'ProjectLabel'
  has_many :services
  has_many :events
  has_many :milestones
223
  has_many :iterations
224
225
226
227
228
  has_many :notes
  has_many :snippets, class_name: 'ProjectSnippet'
  has_many :hooks, class_name: 'ProjectHook'
  has_many :protected_branches
  has_many :protected_tags
229
  has_many :repository_languages, -> { order "share DESC" }
230
  has_many :designs, inverse_of: :project, class_name: 'DesignManagement::Design'
231

232
  has_many :project_authorizations
233
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
234
  has_many :project_members, -> { where(requested_at: nil) },
235
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
236

237
  alias_method :members, :project_members
238
239
  has_many :users, through: :project_members

240
  has_many :requesters, -> { where.not(requested_at: nil) },
241
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
242
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
243

244
  has_many :deploy_keys_projects, inverse_of: :project
245
  has_many :deploy_keys, through: :deploy_keys_projects
246
  has_many :users_star_projects
Ciro Santilli's avatar
Ciro Santilli committed
247
  has_many :starrers, through: :users_star_projects, source: :user
248
  has_many :releases
249
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
250
  has_many :lfs_objects, -> { distinct }, through: :lfs_objects_projects
251
  has_many :lfs_file_locks
252
  has_many :project_group_links
253
  has_many :invited_groups, through: :project_group_links, source: :group
254
  has_many :todos
255
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
256

257
258
  has_many :internal_ids

259
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
260
  has_one :project_feature, inverse_of: :project
261
  has_one :statistics, class_name: 'ProjectStatistics'
262
  has_one :feature_usage, class_name: 'ProjectFeatureUsage'
263

Shinya Maeda's avatar
Shinya Maeda committed
264
  has_one :cluster_project, class_name: 'Clusters::Project'
265
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
266
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
267
  has_many :management_clusters, class_name: 'Clusters::Cluster', foreign_key: :management_project_id, inverse_of: :management_project
268
  has_many :cluster_agents, class_name: 'Clusters::Agent'
269

270
  has_many :prometheus_metrics
271
  has_many :prometheus_alerts, inverse_of: :project
272
273
  has_many :prometheus_alert_events, inverse_of: :project
  has_many :self_managed_prometheus_alert_events, inverse_of: :project
274
275
276
  has_many :metrics_users_starred_dashboards, class_name: 'Metrics::UsersStarredDashboard', inverse_of: :project

  has_many :alert_management_alerts, class_name: 'AlertManagement::Alert', inverse_of: :project
277
  has_many :alert_management_http_integrations, class_name: 'AlertManagement::HttpIntegration', inverse_of: :project
278

279
280
281
  # 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.
282
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
283
  has_one :container_expiration_policy, inverse_of: :project
284

285
  has_many :commit_statuses
286
  # The relation :all_pipelines is intended to be used when we want to get the
287
288
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
289
290
291
  # The relation :ci_pipelines includes all those that directly contribute to the
  # latest status of a ref. This does not include dangling pipelines such as those
  # from webide, child pipelines, etc.
292
  has_many :ci_pipelines,
293
          -> { ci_sources },
294
295
          class_name: 'Ci::Pipeline',
          inverse_of: :project
296
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
297
  has_many :ci_refs, class_name: 'Ci::Ref', inverse_of: :project
298
299
300
301
302

  # 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.
303
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
304
  has_many :processables, class_name: 'Ci::Processable', inverse_of: :project
305
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
306
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
307
  has_many :build_report_results, class_name: 'Ci::BuildReportResult', inverse_of: :project
308
  has_many :job_artifacts, class_name: 'Ci::JobArtifact'
309
  has_many :pipeline_artifacts, class_name: 'Ci::PipelineArtifact', inverse_of: :project
310
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
311
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
312
  has_many :variables, class_name: 'Ci::Variable'
313
314
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
315
  has_many :environments_for_dashboard, -> { from(with_rank.unfoldered.available, :environments).where('rank <= 3') }, class_name: 'Environment'
316
  has_many :deployments
317
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
318
  has_many :project_deploy_tokens
319
  has_many :deploy_tokens, through: :project_deploy_tokens
320
  has_many :resource_groups, class_name: 'Ci::ResourceGroup', inverse_of: :project
321
  has_many :freeze_periods, class_name: 'Ci::FreezePeriod', inverse_of: :project
322

Nick Thomas's avatar
Nick Thomas committed
323
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
324
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
325

326
  has_many :project_badges, class_name: 'ProjectBadge'
327
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
328

329
  has_many :remote_mirrors, inverse_of: :project
330
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
331

332
333
  has_many :external_pull_requests, inverse_of: :project

334
335
336
  has_many :sourced_pipelines, class_name: 'Ci::Sources::Pipeline', foreign_key: :source_project_id
  has_many :source_pipelines, class_name: 'Ci::Sources::Pipeline', foreign_key: :project_id

337
  has_many :import_failures, inverse_of: :project
338
  has_many :jira_imports, -> { order 'jira_imports.created_at' }, class_name: 'JiraImportState', inverse_of: :project
339

340
341
342
  has_many :daily_build_group_report_results, class_name: 'Ci::DailyBuildGroupReportResult'

  has_many :repository_storage_moves, class_name: 'ProjectRepositoryStorageMove'
343

344
345
  has_many :webide_pipelines, -> { webide_source }, class_name: 'Ci::Pipeline', inverse_of: :project
  has_many :reviews, inverse_of: :project
346

347
348
  has_many :terraform_states, class_name: 'Terraform::State', inverse_of: :project

349
350
351
352
353
  # GitLab Pages
  has_many :pages_domains
  has_one  :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project
  has_many :pages_deployments

354
355
356
357
  # Can be too many records. We need to implement delete_all in batches.
  # Issue https://gitlab.com/gitlab-org/gitlab/-/issues/228637
  has_many :product_analytics_events, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent

358
359
360
361
  has_many :operations_feature_flags, class_name: 'Operations::FeatureFlag'
  has_one :operations_feature_flags_client, class_name: 'Operations::FeatureFlagsClient'
  has_many :operations_feature_flags_user_lists, class_name: 'Operations::FeatureFlags::UserList'

362
  accepts_nested_attributes_for :variables, allow_destroy: true
363
  accepts_nested_attributes_for :project_feature, update_only: true
364
  accepts_nested_attributes_for :project_setting, update_only: true
365
  accepts_nested_attributes_for :import_data
366
  accepts_nested_attributes_for :auto_devops, update_only: true
367
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
368
  accepts_nested_attributes_for :container_expiration_policy, update_only: true
369

370
371
372
373
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

374
  accepts_nested_attributes_for :tracing_setting, update_only: true, allow_destroy: true
375
  accepts_nested_attributes_for :incident_management_setting, update_only: true
376
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
377
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
378
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
379
  accepts_nested_attributes_for :prometheus_service, update_only: true
380
  accepts_nested_attributes_for :alerting_setting, update_only: true
381

382
383
384
385
386
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
    :merge_requests_enabled?, :forking_enabled?, :issues_enabled?,
    :pages_enabled?, :public_pages?, :private_pages?,
    :merge_requests_access_level, :forking_access_level, :issues_access_level,
    :wiki_access_level, :snippets_access_level, :builds_access_level,
387
    :repository_access_level, :pages_access_level, :metrics_dashboard_access_level,
388
    to: :project_feature, allow_nil: true
389
390
391
  delegate :show_default_award_emojis, :show_default_award_emojis=,
    :show_default_award_emojis?,
    to: :project_setting, allow_nil: true
392
393
  delegate :scheduled?, :started?, :in_progress?, :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true
394
  delegate :squash_always?, :squash_never?, :squash_enabled_by_default?, :squash_readonly?, to: :project_setting
395
  delegate :no_import?, to: :import_state, allow_nil: true
396
  delegate :name, to: :owner, allow_nil: true, prefix: true
397
  delegate :members, to: :team, prefix: true
398
  delegate :add_user, :add_users, to: :team
399
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
400
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
401
  delegate :root_ancestor, to: :namespace, allow_nil: true
402
  delegate :last_pipeline, to: :commit, allow_nil: true
403
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
404
  delegate :dashboard_timezone, to: :metrics_setting, allow_nil: true, prefix: true
405
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
406
  delegate :forward_deployment_enabled, :forward_deployment_enabled=, :forward_deployment_enabled?, to: :ci_cd_settings, prefix: :ci
407
  delegate :actual_limits, :actual_plan_name, to: :namespace, allow_nil: true
408
409
410
411
  delegate :allow_merge_on_skipped_pipeline, :allow_merge_on_skipped_pipeline?,
    :allow_merge_on_skipped_pipeline=, :has_confluence?,
    to: :project_setting
  delegate :active?, to: :prometheus_service, allow_nil: true, prefix: true
412

413
414
  delegate :log_jira_dvcs_integration_usage, :jira_dvcs_server_last_sync_at, :jira_dvcs_cloud_last_sync_at, to: :feature_usage

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
415
  # Validations
416
  validates :creator, presence: true, on: :create
417
  validates :description, length: { maximum: 2000 }, allow_blank: true
418
  validates :ci_config_path,
419
    format: { without: %r{(\.{2}|\A/)},
420
              message: _('cannot include leading slash or directory traversal.') },
421
422
    length: { maximum: 255 },
    allow_blank: true
423
424
  validates :name,
    presence: true,
425
    length: { maximum: 255 },
426
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
427
              message: Gitlab::Regex.project_name_regex_message }
428
429
  validates :path,
    presence: true,
430
    project_path: true,
431
    length: { maximum: 255 }
432

433
434
  validates :project_feature, presence: true

435
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
436
  validates :name, uniqueness: { scope: :namespace_id }
437
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
438
439
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
440
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
441
  validate :check_vcs_type, on: :create
442
  validate :check_personal_projects_limit, on: :create
443
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
444
445
  validate :visibility_level_allowed_by_group, if: :should_validate_visibility_level?
  validate :visibility_level_allowed_as_fork, if: :should_validate_visibility_level?
Rob Watson's avatar
Rob Watson committed
446
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
447
  validate :changing_shared_runners_enabled_is_allowed
448
449
450
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
451
  validates :variables, variable_duplicates: { scope: :environment_scope }
452
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
453
  validates :max_artifacts_size, numericality: { only_integer: true, greater_than: 0, allow_nil: true }
454

455
  # Scopes
456
  scope :pending_delete, -> { where(pending_delete: true) }
457
  scope :without_deleted, -> { where(pending_delete: false) }
458

459
460
461
462
463
464
465
466
467
468
469
  scope :with_storage_feature, ->(feature) do
    where(arel_table[:storage_version].gteq(HASHED_STORAGE_FEATURES[feature]))
  end
  scope :without_storage_feature, ->(feature) do
    where(arel_table[:storage_version].lt(HASHED_STORAGE_FEATURES[feature])
        .or(arel_table[:storage_version].eq(nil)))
  end
  scope :with_unmigrated_storage, -> do
    where(arel_table[:storage_version].lt(LATEST_STORAGE_VERSION)
        .or(arel_table[:storage_version].eq(nil)))
  end
470

471
  # last_activity_at is throttled every minute, but last_repository_updated_at is updated with every push
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
472
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
473
474
  scope :sorted_by_stars_desc, -> { reorder(self.arel_table['star_count'].desc) }
  scope :sorted_by_stars_asc, -> { reorder(self.arel_table['star_count'].asc) }
475
  # Sometimes queries (e.g. using CTEs) require explicit disambiguation with table name
476
  scope :projects_order_id_desc, -> { reorder(self.arel_table['id'].desc) }
477

478
  scope :sorted_by_similarity_desc, -> (search, include_in_select: false) do
479
480
481
482
483
484
    order_expression = Gitlab::Database::SimilarityScore.build_expression(search: search, rules: [
      { column: arel_table["path"], multiplier: 1 },
      { column: arel_table["name"], multiplier: 0.7 },
      { column: arel_table["description"], multiplier: 0.2 }
    ])

485
486
487
488
    query = reorder(order_expression.desc, arel_table['id'].desc)

    query = query.select(*query.arel.projections, order_expression.as('similarity')) if include_in_select
    query
489
490
  end

491
  scope :with_packages, -> { joins(:packages) }
492
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
493
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
494
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
495
  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
496
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
497
  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)) }
498
  scope :archived, -> { where(archived: true) }
499
  scope :non_archived, -> { where(archived: false) }
500
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
501
  scope :with_push, -> { joins(:events).merge(Event.pushed_action) }
502
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
503
504
505
  scope :with_active_jira_services, -> { joins(:services).merge(::JiraService.active) } # rubocop:disable CodeReuse/ServiceClass
  scope :with_jira_dvcs_cloud, -> { joins(:feature_usage).merge(ProjectFeatureUsage.with_jira_dvcs_integration_enabled(cloud: true)) }
  scope :with_jira_dvcs_server, -> { joins(:feature_usage).merge(ProjectFeatureUsage.with_jira_dvcs_integration_enabled(cloud: false)) }
506
  scope :inc_routes, -> { includes(:route, namespace: :route) }
Markus Koller's avatar
Markus Koller committed
507
  scope :with_statistics, -> { includes(:statistics) }
508
509
  scope :with_namespace, -> { includes(:namespace) }
  scope :with_import_state, -> { includes(:import_state) }
510
  scope :include_project_feature, -> { includes(:project_feature) }
511
  scope :with_service, ->(service) { joins(service).eager_load(service) }
512
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
513
  scope :with_container_registry, -> { where(container_registry_enabled: true) }
514
515
516
  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.
517
518
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
519
  end
520
521
522

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
523
524
525
526
    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)
527
528
529
530
531
532
533
534
  }

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

535
536
537
538
539
540
541
542
543
544
  # 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

545
  scope :service_desk_enabled, -> { where(service_desk_enabled: true) }
546
547
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
548
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
549
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
550
551
552
  scope :with_issues_or_mrs_available_for_user, -> (user) do
    with_issues_available_for_user(user).or(with_merge_requests_available_for_user(user))
  end
553
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
554
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
555
  scope :with_limit, -> (maximum) { limit(maximum) }
556

557
558
559
560
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end
561

562
563
564
565
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

566
567
568
569
570
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

571
572
  scope :with_api_commit_entity_associations, -> {
    preload(:project_feature, :route, namespace: [:route, :owner])
573
574
  }

575
  scope :imported_from, -> (type) { where(import_type: type) }
576
  scope :with_tracing_enabled, -> { joins(:tracing_setting) }
577

578
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
579

580
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
581
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
582
583

  validates :build_timeout, allow_nil: true,
584
                            numericality: { greater_than_or_equal_to: 10.minutes,
585
                                            less_than: MAX_BUILD_TIMEOUT,
586
                                            only_integer: true,
587
                                            message: _('needs to be between 10 minutes and 1 month') }
588

589
590
591
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

592
593
594
595
  def self.with_api_entity_associations
    preload(:project_feature, :route, :tags, :group, namespace: [:route, :owner])
  end

596
597
598
599
  def self.with_web_entity_associations
    preload(:project_feature, :route, :creator, :group, namespace: [:route, :owner])
  end

600
601
602
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end
603

604
605
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
606
607
608
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

609
610
611
    return public_to_user unless user

    if user.is_a?(DeployToken)
612
      user.accessible_projects
613
    else
614
      where('EXISTS (?) OR projects.visibility_level IN (?)',
615
            user.authorizations_for_projects(min_access_level: min_access_level),
616
            Gitlab::VisibilityLevel.levels_for_user(user))
617
618
619
    end
  end

620
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
621
  # they are only available to team members. This scope returns projects where
622
  # the feature is either public, enabled, or internal with permission for the user.
623
624
  # Note: this scope doesn't enforce that the user has access to the projects, it just checks
  # that the user has access to the feature. It's important to use this scope with others
625
  # that checks project authorizations first (e.g. `filter_by_feature_visibility`).
626
627
628
629
  #
  # 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.
630
  def self.with_feature_available_for_user(feature, user)
631
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
632
633
634
635

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
636
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
637
638
      column = ProjectFeature.quoted_access_level_column(feature)

639
      with_project_feature
640
641
642
643
644
645
      .where("#{column} IS NULL OR #{column} IN (:public_visible) OR (#{column} = :private_visible AND EXISTS (:authorizations))",
            {
              public_visible: visible,
              private_visible: ProjectFeature::PRIVATE,
              authorizations: user.authorizations_for_projects(min_access_level: min_access_level)
            })
646
    else
647
648
      # This has to be added to include features whose value is nil in the db
      visible << nil
649
650
      with_feature_access_level(feature, visible)
    end
651
  end
Felipe Artur's avatar
Felipe Artur committed
652

653
654
655
656
657
658
659
660
  def self.projects_user_can(projects, user, action)
    projects = where(id: projects)

    DeclarativePolicy.user_scope do
      projects.select { |project| Ability.allowed?(user, action, project) }
    end
  end

661
662
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
663
664
665
666
667
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
668
669
  end

670
671
  def self.wrap_with_cte(collection)
    cte = Gitlab::SQL::CTE.new(:projects_cte, collection)
672
    Project.with(cte.to_arel).from(cte.alias_to(Project.arel_table))
673
674
  end

Rémy Coutable's avatar
Rémy Coutable committed
675
676
  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) }
677

678
  scope :excluding_project, ->(project) { where.not(id: project) }
679

680
681
  # 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") }
682
  scope :for_group, -> (group) { where(group: group) }
683
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
684

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
685
  class << self
686
687
688
    # Searches for a list of projects based on the query given in `query`.
    #
    # On PostgreSQL this method uses "ILIKE" to perform a case-insensitive
689
    # search.
690
691
    #
    # query - The search query as a String.
692
    def search(query, include_namespace: false)
693
      if include_namespace
694
        joins(:route).fuzzy_search(query, [Route.arel_table[:path], Route.arel_table[:name], :description])
695
696
697
      else
        fuzzy_search(query, [:path, :name, :description])
      end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
698
    end
699

700
    def search_by_title(query)
701
      non_archived.fuzzy_search(query, [:name])
702
703
    end

704
705
706
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
707

708
    def sort_by_attribute(method)
709
710
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
711
712
713
        # 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')
714
      when 'latest_activity_desc'
715
        reorder(self.arel_table['last_activity_at'].desc)
716
      when 'latest_activity_asc'
717
        reorder(self.arel_table['last_activity_at'].asc)
718
      when 'stars_desc'
719
        sorted_by_stars_desc
720
721
      when 'stars_asc'
        sorted_by_stars_asc
722
723
      else
        order_by(method)
724
725
      end
    end
726
727

    def reference_pattern
728
      %r{
729
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
730
731
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
732
      }x
733
    end
734

735
736
737
738
    def reference_postfix
      '>'
    end

739
740
741
742
    def reference_postfix_escaped
      '&gt;'
    end

743
    # Pattern used to extract `namespace/project>` project references from text.
744
745
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
746
    def markdown_reference_pattern
747
748
749
750
751
      @markdown_reference_pattern ||=
        %r{
          #{reference_pattern}
          (#{reference_postfix}|#{reference_postfix_escaped})
        }x
752
753
    end

754
    def trending