project.rb 96 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 HasIntegrations
23
  include CanMoveRepositoryStorage
24
  include Routable
25
  include GroupDescendant
26
  include Gitlab::SQL::Pattern
27
  include DeploymentPlatform
28
  include ::Gitlab::Utils::StrongMemoize
29
  include ChronicDurationAttribute
30
  include FastDestroyAll::Helpers
Jan Provaznik's avatar
Jan Provaznik committed
31
  include WithUploads
32
  include BatchDestroyDependentAssociations
33
  include FeatureGate
34
  include OptionallySearch
35
  include FromUnion
36
  include IgnorableColumns
37
  include Repositories::CanHousekeepRepository
38
  include EachBatch
39
40
  include GitlabRoutingHelper

41
  extend Gitlab::Cache::RequestCache
42
  extend Gitlab::Utils::Override
Robert Speicher's avatar
Robert Speicher committed
43

44
  extend Gitlab::ConfigHelper
45

46
47
  ignore_columns :container_registry_enabled, remove_after: '2021-09-22', remove_with: '14.4'

48
  BoardLimitExceeded = Class.new(StandardError)
49

50
  MERCURIAL_VCS_TYPES = %w[hg hg_git].freeze
51
  VCS_TYPES_WITH_GIT_REPO = %w[hg_git hg git].freeze
52

53
54
55
  ignore_columns :mirror_last_update_at, :mirror_last_successful_update_at, remove_after: '2021-09-22', remove_with: '14.4'
  ignore_columns :pull_mirror_branch_prefix, remove_after: '2021-09-22', remove_with: '14.4'

56
57
  STATISTICS_ATTRIBUTE = 'repositories_count'
  UNKNOWN_IMPORT_URL = 'http://unknown.git'
58
59
  # Hashed Storage versions handle rolling out new storage to project and dependents models:
  # nil: legacy
60
61
62
  # 1: repository
  # 2: attachments
  LATEST_STORAGE_VERSION = 2
63
64
65
66
  HASHED_STORAGE_FEATURES = {
    repository: 1,
    attachments: 2
  }.freeze
Jared Szechy's avatar
Jared Szechy committed
67

68
69
70
71
72
  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
73

George Koltsov's avatar
George Koltsov committed
74
  SORTING_PREFERENCE_FIELD = :projects_sort
75
  MAX_BUILD_TIMEOUT = 1.month
George Koltsov's avatar
George Koltsov committed
76

77
78
  GL_REPOSITORY_TYPES = [Gitlab::GlRepository::PROJECT, Gitlab::GlRepository::WIKI, Gitlab::GlRepository::DESIGN].freeze

79
80
  cache_markdown_field :description, pipeline: :description

81
  default_value_for :packages_enabled, true
82
  default_value_for :archived, false
83
  default_value_for :resolve_outdated_diff_discussions, false
84
  default_value_for(:repository_storage) do
85
    Repository.pick_storage_shard
86
87
  end

88
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
89
90
91
92
93
  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
94
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
95
  default_value_for :remove_source_branch_after_merge, true
96
  default_value_for :autoclose_referenced_issues, true
97
  default_value_for(:ci_config_path) { Gitlab::CurrentSettings.default_ci_config_path }
98

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

101
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
102

103
  before_save :ensure_runners_token
104

Jasper Maes's avatar
Jasper Maes committed
105
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
106
107
108

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

109
  after_create -> { create_or_load_association(:project_feature) }
110

111
  after_create -> { create_or_load_association(:ci_cd_settings) }
112

113
  after_create -> { create_or_load_association(:container_expiration_policy) }
114

115
  after_create -> { create_or_load_association(:pages_metadatum) }
116

Mark Chao's avatar
Mark Chao committed
117
  after_create :set_timestamps_for_create
118
  after_update :update_forks_visibility_level
119

120
  before_destroy :remove_private_deploy_keys
121

122
  use_fast_destroy :build_trace_chunks
123

124
  after_destroy -> { run_after_commit { legacy_remove_pages } }
125
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
126

127
128
  after_validation :check_pending_delete

129
  # Storage specific hooks
130
  after_initialize :use_hashed_storage
131
  after_create :check_repository_absence!
132

133
  acts_as_ordered_taggable_on :topics
134

135
  attr_accessor :old_path_with_namespace
136
  attr_accessor :template_name
137
  attr_writer :pipeline_status
138
  attr_accessor :skip_disk_validation
139

140
141
  alias_attribute :title, :name

142
  # Relations
Nick Thomas's avatar
Nick Thomas committed
143
  belongs_to :pool_repository
144
  belongs_to :creator, class_name: 'User'
145
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
146
  belongs_to :namespace
147
148
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
149

150
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
151
  has_many :boards
Felipe Artur's avatar
Felipe Artur committed
152

153
  def self.integration_association_name(name)
154
    "#{name}_integration"
155
156
  end

157
  # Project integrations
158
159
160
161
162
163
164
165
166
167
168
  has_one :asana_integration, class_name: 'Integrations::Asana'
  has_one :assembla_integration, class_name: 'Integrations::Assembla'
  has_one :bamboo_integration, class_name: 'Integrations::Bamboo'
  has_one :bugzilla_integration, class_name: 'Integrations::Bugzilla'
  has_one :buildkite_integration, class_name: 'Integrations::Buildkite'
  has_one :campfire_integration, class_name: 'Integrations::Campfire'
  has_one :confluence_integration, class_name: 'Integrations::Confluence'
  has_one :custom_issue_tracker_integration, class_name: 'Integrations::CustomIssueTracker'
  has_one :datadog_integration, class_name: 'Integrations::Datadog'
  has_one :discord_integration, class_name: 'Integrations::Discord'
  has_one :drone_ci_integration, class_name: 'Integrations::DroneCi'
169
170
171
172
173
174
  has_one :emails_on_push_integration, class_name: 'Integrations::EmailsOnPush'
  has_one :ewm_integration, class_name: 'Integrations::Ewm'
  has_one :external_wiki_integration, class_name: 'Integrations::ExternalWiki'
  has_one :flowdock_integration, class_name: 'Integrations::Flowdock'
  has_one :hangouts_chat_integration, class_name: 'Integrations::HangoutsChat'
  has_one :irker_integration, class_name: 'Integrations::Irker'
175
176
177
178
179
180
181
182
183
184
185
186
  has_one :jenkins_integration, class_name: 'Integrations::Jenkins'
  has_one :jira_integration, class_name: 'Integrations::Jira'
  has_one :mattermost_integration, class_name: 'Integrations::Mattermost'
  has_one :mattermost_slash_commands_integration, class_name: 'Integrations::MattermostSlashCommands'
  has_one :microsoft_teams_integration, class_name: 'Integrations::MicrosoftTeams'
  has_one :mock_ci_integration, class_name: 'Integrations::MockCi'
  has_one :mock_monitoring_integration, class_name: 'Integrations::MockMonitoring'
  has_one :packagist_integration, class_name: 'Integrations::Packagist'
  has_one :pipelines_email_integration, class_name: 'Integrations::PipelinesEmail'
  has_one :pivotaltracker_integration, class_name: 'Integrations::Pivotaltracker'
  has_one :prometheus_integration, class_name: 'Integrations::Prometheus', inverse_of: :project
  has_one :pushover_integration, class_name: 'Integrations::Pushover'
187
  has_one :readthedocs_integration, class_name: 'Integrations::Readthedocs'
188
189
190
191
192
193
194
  has_one :redmine_integration, class_name: 'Integrations::Redmine'
  has_one :slack_integration, class_name: 'Integrations::Slack'
  has_one :slack_slash_commands_integration, class_name: 'Integrations::SlackSlashCommands'
  has_one :teamcity_integration, class_name: 'Integrations::Teamcity'
  has_one :unify_circuit_integration, class_name: 'Integrations::UnifyCircuit'
  has_one :webex_teams_integration, class_name: 'Integrations::WebexTeams'
  has_one :youtrack_integration, class_name: 'Integrations::Youtrack'
195
196
197
198
199
200
201

  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
202
203
204
  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
205
  has_many :fork_network_projects, through: :fork_network, source: :projects
206

207
208
209
  # Packages
  has_many :packages, class_name: 'Packages::Package'
  has_many :package_files, through: :packages, class_name: 'Packages::PackageFile'
210
  # debian_distributions and associated component_files must be destroyed by ruby code in order to properly remove carrierwave uploads
211
  has_many :debian_distributions, class_name: 'Packages::Debian::ProjectDistribution', dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
212

213
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
214
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
215
  has_many :export_jobs, class_name: 'ProjectExportJob'
216
  has_one :project_repository, inverse_of: :project
217
  has_one :tracing_setting, class_name: 'ProjectTracingSetting'
218
  has_one :incident_management_setting, inverse_of: :project, class_name: 'IncidentManagement::ProjectIncidentManagementSetting'
219
  has_one :error_tracking_setting, inverse_of: :project, class_name: 'ErrorTracking::ProjectErrorTrackingSetting'
220
  has_one :metrics_setting, inverse_of: :project, class_name: 'ProjectMetricsSetting'
221
  has_one :grafana_integration, inverse_of: :project
222
  has_one :project_setting, inverse_of: :project, autosave: true
223
  has_one :alerting_setting, inverse_of: :project, class_name: 'Alerting::ProjectAlertingSetting'
224
  has_one :service_desk_setting, class_name: 'ServiceDeskSetting'
225

226
  # Merge requests for target project should be removed with it
227
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
228
  has_many :merge_request_metrics, foreign_key: 'target_project', class_name: 'MergeRequest::Metrics', inverse_of: :target_project
229
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
230
231
  has_many :issues
  has_many :labels, class_name: 'ProjectLabel'
232
  has_many :integrations
233
234
  has_many :events
  has_many :milestones
235
  has_many :iterations
236
237
238
239
240
241
242
243
244

  # Projects with a very large number of notes may time out destroying them
  # through the foreign key. Additionally, the deprecated attachment uploader
  # for notes requires us to use dependent: :destroy to avoid orphaning uploaded
  # files.
  #
  # https://gitlab.com/gitlab-org/gitlab/-/issues/207222
  has_many :notes, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent

245
246
247
  has_many :snippets, class_name: 'ProjectSnippet'
  has_many :hooks, class_name: 'ProjectHook'
  has_many :protected_branches
248
  has_many :exported_protected_branches
249
  has_many :protected_tags
250
  has_many :repository_languages, -> { order "share DESC" }
251
  has_many :designs, inverse_of: :project, class_name: 'DesignManagement::Design'
252

253
  has_many :project_authorizations
254
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
255
  has_many :project_members, -> { where(requested_at: nil) },
256
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
257

258
  alias_method :members, :project_members
259
260
  has_many :users, through: :project_members

261
  has_many :requesters, -> { where.not(requested_at: nil) },
262
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
263
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
264

265
  has_many :deploy_keys_projects, inverse_of: :project
266
  has_many :deploy_keys, through: :deploy_keys_projects
267
  has_many :users_star_projects
Ciro Santilli's avatar
Ciro Santilli committed
268
  has_many :starrers, through: :users_star_projects, source: :user
269
  has_many :releases
270
  has_many :lfs_objects_projects
271
  has_many :lfs_objects, -> { distinct }, through: :lfs_objects_projects
272
  has_many :lfs_file_locks
273
  has_many :project_group_links
274
  has_many :invited_groups, through: :project_group_links, source: :group
275
  has_many :todos
276
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
277

278
279
  has_many :internal_ids

280
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
281
  has_one :project_feature, inverse_of: :project
282
  has_one :statistics, class_name: 'ProjectStatistics'
283
  has_one :feature_usage, class_name: 'ProjectFeatureUsage'
284

Shinya Maeda's avatar
Shinya Maeda committed
285
  has_one :cluster_project, class_name: 'Clusters::Project'
286
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
287
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
288
  has_many :management_clusters, class_name: 'Clusters::Cluster', foreign_key: :management_project_id, inverse_of: :management_project
289
  has_many :cluster_agents, class_name: 'Clusters::Agent'
290

291
  has_many :prometheus_metrics
292
  has_many :prometheus_alerts, inverse_of: :project
293
294
  has_many :prometheus_alert_events, inverse_of: :project
  has_many :self_managed_prometheus_alert_events, inverse_of: :project
295
296
297
  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
298
  has_many :alert_management_http_integrations, class_name: 'AlertManagement::HttpIntegration', inverse_of: :project
299

300
301
302
  # 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.
303
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
304
  has_one :container_expiration_policy, inverse_of: :project
305

306
  has_many :commit_statuses
307
  # The relation :all_pipelines is intended to be used when we want to get the
308
309
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
310
311
312
  # 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.
313
  has_many :ci_pipelines,
314
          -> { ci_sources },
315
316
          class_name: 'Ci::Pipeline',
          inverse_of: :project
317
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
318
  has_many :ci_refs, class_name: 'Ci::Ref', inverse_of: :project
319
320
321
322
323

  # 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.
324
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
325
  has_many :processables, class_name: 'Ci::Processable', inverse_of: :project
326
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
327
  has_many :build_report_results, class_name: 'Ci::BuildReportResult', inverse_of: :project
328
  has_many :job_artifacts, class_name: 'Ci::JobArtifact'
329
  has_many :pipeline_artifacts, class_name: 'Ci::PipelineArtifact', inverse_of: :project
330
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
331
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
332
  has_many :variables, class_name: 'Ci::Variable'
333
334
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
335
  has_many :environments_for_dashboard, -> { from(with_rank.unfoldered.available, :environments).where('rank <= 3') }, class_name: 'Environment'
336
  has_many :deployments
337
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
338
  has_many :project_deploy_tokens
339
  has_many :deploy_tokens, through: :project_deploy_tokens
340
  has_many :resource_groups, class_name: 'Ci::ResourceGroup', inverse_of: :project
341
  has_many :freeze_periods, class_name: 'Ci::FreezePeriod', inverse_of: :project
342

Nick Thomas's avatar
Nick Thomas committed
343
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
344
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
345

346
  has_many :project_badges, class_name: 'ProjectBadge'
347
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
348

349
  has_many :remote_mirrors, inverse_of: :project
350
351
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage', inverse_of: :project
  has_many :value_streams, class_name: 'Analytics::CycleAnalytics::ProjectValueStream', inverse_of: :project
352

353
354
  has_many :external_pull_requests, inverse_of: :project

355
356
357
  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

358
  has_many :import_failures, inverse_of: :project
359
  has_many :jira_imports, -> { order 'jira_imports.created_at' }, class_name: 'JiraImportState', inverse_of: :project
360

361
362
  has_many :daily_build_group_report_results, class_name: 'Ci::DailyBuildGroupReportResult'

363
  has_many :repository_storage_moves, class_name: 'Projects::RepositoryStorageMove', inverse_of: :container
364

365
366
  has_many :webide_pipelines, -> { webide_source }, class_name: 'Ci::Pipeline', inverse_of: :project
  has_many :reviews, inverse_of: :project
367

368
369
  has_many :terraform_states, class_name: 'Terraform::State', inverse_of: :project

370
371
372
  # GitLab Pages
  has_many :pages_domains
  has_one  :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project
373
374
  # we need to clean up files, not only remove records
  has_many :pages_deployments, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
375

376
377
378
379
  # 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

380
381
382
383
  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'

384
  has_many :error_tracking_errors, inverse_of: :project, class_name: 'ErrorTracking::Error'
385
  has_many :error_tracking_client_keys, inverse_of: :project, class_name: 'ErrorTracking::ClientKey'
386

387
388
  has_many :timelogs

389
  accepts_nested_attributes_for :variables, allow_destroy: true
390
  accepts_nested_attributes_for :project_feature, update_only: true
391
  accepts_nested_attributes_for :project_setting, update_only: true
392
  accepts_nested_attributes_for :import_data
393
  accepts_nested_attributes_for :auto_devops, update_only: true
394
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
395
  accepts_nested_attributes_for :container_expiration_policy, update_only: true
396

397
398
399
400
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

401
  accepts_nested_attributes_for :tracing_setting, update_only: true, allow_destroy: true
402
  accepts_nested_attributes_for :incident_management_setting, update_only: true
403
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
404
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
405
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
406
  accepts_nested_attributes_for :prometheus_integration, update_only: true
407
  accepts_nested_attributes_for :alerting_setting, update_only: true
408

409
410
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
    :merge_requests_enabled?, :forking_enabled?, :issues_enabled?,
411
    :pages_enabled?, :analytics_enabled?, :snippets_enabled?, :public_pages?, :private_pages?,
412
413
    :merge_requests_access_level, :forking_access_level, :issues_access_level,
    :wiki_access_level, :snippets_access_level, :builds_access_level,
414
    :repository_access_level, :pages_access_level, :metrics_dashboard_access_level, :analytics_access_level,
415
    :operations_enabled?, :operations_access_level, :security_and_compliance_access_level,
416
    :container_registry_access_level, :container_registry_enabled?,
417
    to: :project_feature, allow_nil: true
418
  alias_method :container_registry_enabled, :container_registry_enabled?
419
420
421
  delegate :show_default_award_emojis, :show_default_award_emojis=,
    :show_default_award_emojis?,
    to: :project_setting, allow_nil: true
422
423
  delegate :scheduled?, :started?, :in_progress?, :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true
424
  delegate :squash_always?, :squash_never?, :squash_enabled_by_default?, :squash_readonly?, to: :project_setting
425
426
  delegate :squash_option, :squash_option=, to: :project_setting
  delegate :previous_default_branch, :previous_default_branch=, to: :project_setting
427
  delegate :no_import?, to: :import_state, allow_nil: true
428
  delegate :name, to: :owner, allow_nil: true, prefix: true
429
  delegate :members, to: :team, prefix: true
430
  delegate :add_user, :add_users, to: :team
431
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
432
  delegate :group_runners_enabled, :group_runners_enabled=, to: :ci_cd_settings, allow_nil: true
433
  delegate :root_ancestor, to: :namespace, allow_nil: true
434
  delegate :last_pipeline, to: :commit, allow_nil: true
435
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
436
  delegate :dashboard_timezone, to: :metrics_setting, allow_nil: true, prefix: true
437
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci, allow_nil: true
438
439
440
441
  delegate :forward_deployment_enabled, :forward_deployment_enabled=, to: :ci_cd_settings, prefix: :ci, allow_nil: true
  delegate :job_token_scope_enabled, :job_token_scope_enabled=, to: :ci_cd_settings, prefix: :ci, allow_nil: true
  delegate :keep_latest_artifact, :keep_latest_artifact=, to: :ci_cd_settings, allow_nil: true
  delegate :restrict_user_defined_variables, :restrict_user_defined_variables=, to: :ci_cd_settings, allow_nil: true
442
  delegate :actual_limits, :actual_plan_name, to: :namespace, allow_nil: true
443
  delegate :allow_merge_on_skipped_pipeline, :allow_merge_on_skipped_pipeline?,
444
    :allow_merge_on_skipped_pipeline=, :has_confluence?,
445
    to: :project_setting
446
  delegate :active?, to: :prometheus_integration, allow_nil: true, prefix: true
447

448
449
  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
450
  # Validations
451
  validates :creator, presence: true, on: :create
452
  validates :description, length: { maximum: 2000 }, allow_blank: true
453
  validates :ci_config_path,
454
    format: { without: %r{(\.{2}|\A/)},
455
              message: _('cannot include leading slash or directory traversal.') },
456
457
    length: { maximum: 255 },
    allow_blank: true
458
459
  validates :name,
    presence: true,
460
    length: { maximum: 255 },
461
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
462
              message: Gitlab::Regex.project_name_regex_message }
463
464
  validates :path,
    presence: true,
465
    project_path: true,
466
    length: { maximum: 255 }
467

468
469
  validates :project_feature, presence: true

470
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
471
  validates :name, uniqueness: { scope: :namespace_id }
472
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
473
474
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
475
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
476
  validate :check_vcs_type, on: :create
477
  validate :check_personal_projects_limit, on: :create
478
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
479
480
  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
481
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
482
  validate :changing_shared_runners_enabled_is_allowed
483
484
485
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
486
  validates :variables, nested_attributes_duplicates: { scope: :environment_scope }
487
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
488
  validates :max_artifacts_size, numericality: { only_integer: true, greater_than: 0, allow_nil: true }
489

490
  # Scopes
491
  scope :pending_delete, -> { where(pending_delete: true) }
492
  scope :without_deleted, -> { where(pending_delete: false) }
493

494
495
496
497
498
499
500
501
502
503
504
  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
505

506
  # 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
507
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
508
509
  scope :sorted_by_stars_desc, -> { reorder(self.arel_table['star_count'].desc) }
  scope :sorted_by_stars_asc, -> { reorder(self.arel_table['star_count'].asc) }
510
  # Sometimes queries (e.g. using CTEs) require explicit disambiguation with table name
511
  scope :projects_order_id_desc, -> { reorder(self.arel_table['id'].desc) }
512

513
  scope :sorted_by_similarity_desc, -> (search, include_in_select: false) do
514
515
516
517
518
519
    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 }
    ])

520
521
522
523
524
525
526
527
528
529
530
531
532
533
    order = Gitlab::Pagination::Keyset::Order.build([
      Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
        attribute_name: 'similarity',
        column_expression: order_expression,
        order_expression: order_expression.desc,
        order_direction: :desc,
        distinct: false,
        add_to_projections: true
      ),
      Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
        attribute_name: 'id',
        order_expression: Project.arel_table[:id].desc
      )
    ])
534

535
    order.apply_cursor_conditions(reorder(order))
536
537
  end

538
  scope :with_packages, -> { joins(:packages) }
539
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
540
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
541
  scope :joined, ->(user) { where.not(namespace_id: user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
542
  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
543
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
544
  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)) }
545
  scope :archived, -> { where(archived: true) }
546
  scope :non_archived, -> { where(archived: false) }
547
  scope :with_push, -> { joins(:events).merge(Event.pushed_action) }
548
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
549
550
  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)) }
551
  scope :inc_routes, -> { includes(:route, namespace: :route) }
Markus Koller's avatar
Markus Koller committed
552
  scope :with_statistics, -> { includes(:statistics) }
553
554
  scope :with_namespace, -> { includes(:namespace) }
  scope :with_import_state, -> { includes(:import_state) }
555
  scope :include_project_feature, -> { includes(:project_feature) }
556
557
558
  scope :include_integration, -> (integration_association_name) { includes(integration_association_name) }
  scope :with_integration, -> (integration_class) { joins(:integrations).merge(integration_class.all) }
  scope :with_active_integration, -> (integration_class) { with_integration(integration_class).merge(integration_class.active) }
559
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
560
561
562
  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.
563
564
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
565
  end
566
567
568

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
569
570
571
572
    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)
573
574
575
576
577
578
579
580
  }

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

581
582
583
584
585
586
587
588
589
590
  # 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

591
  scope :service_desk_enabled, -> { where(service_desk_enabled: true) }
592
593
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
594
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
595
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
596
597
598
  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
599
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
600
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }) }
601
  scope :with_limit, -> (maximum) { limit(maximum) }
602

603
604
605
606
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end
607

608
609
610
611
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

612
613
614
615
616
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

617
618
  scope :with_api_commit_entity_associations, -> {
    preload(:project_feature, :route, namespace: [:route, :owner])
619
620
  }

621
  scope :imported_from, -> (type) { where(import_type: type) }
622
  scope :with_tracing_enabled, -> { joins(:tracing_setting) }
623
  scope :with_enabled_error_tracking, -> { joins(:error_tracking_setting).where(project_error_tracking_settings: { enabled: true }) }
624

625
626
627
628
629
630
  scope :with_service_desk_key, -> (key) do
    # project_key is not indexed for now
    # see https://gitlab.com/gitlab-org/gitlab/-/merge_requests/24063#note_282435524 for details
    joins(:service_desk_setting).where('service_desk_settings.project_key' => key)
  end

631
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
632

633
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
634
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
635
636

  validates :build_timeout, allow_nil: true,
637
                            numericality: { greater_than_or_equal_to: 10.minutes,
638
                                            less_than: MAX_BUILD_TIMEOUT,
639
                                            only_integer: true,
640
                                            message: _('needs to be between 10 minutes and 1 month') }
641

642
643
644
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

645
  def self.with_api_entity_associations
646
    preload(:project_feature, :route, :topics, :group, :timelogs, namespace: [:route, :owner])
647
648
  end

649
  def self.with_web_entity_associations
650
    preload(:project_feature, :route, :creator, group: :parent, namespace: [:route, :owner])
651
652
  end

653
654
655
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end
656

657
658
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
659
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
660
    min_access_level = nil if user&.can_read_all_resources?
661

662
663
664
    return public_to_user unless user

    if user.is_a?(DeployToken)
665
      user.accessible_projects
666
    else
667
      where('EXISTS (?) OR projects.visibility_level IN (?)',
668
            user.authorizations_for_projects(min_access_level: min_access_level),
669
            Gitlab::VisibilityLevel.levels_for_user(user))
670
671
672
    end
  end

673
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
674
  # they are only available to team members. This scope returns projects where
675
  # the feature is either public, enabled, or internal with permission for the user.
676
677
  # 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
678
  # that checks project authorizations first (e.g. `filter_by_feature_visibility`).
679
680
681
682
  #
  # 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.
683
  def self.with_feature_available_for_user(feature, user)
684
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
685

686
    if user&.can_read_all_resources?
687
688
      with_feature_enabled(feature)
    elsif user
689
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
690
691
      column = ProjectFeature.quoted_access_level_column(feature)

692
      with_project_feature
693
694
695
696
697
698
      .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)
            })
699
    else
700
701
      # This has to be added to include features whose value is nil in the db
      visible << nil
702
703
      with_feature_access_level(feature, visible)
    end
704
  end
Felipe Artur's avatar
Felipe Artur committed
705

706
707
708
709
710
711
712
713
  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

714
715
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
716
717
718
719
720
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
721
722
  end