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 87.3 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
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
37

38
  extend Gitlab::ConfigHelper
39

40
  BoardLimitExceeded = Class.new(StandardError)
41

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

56
57
58
59
60
  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
61

62
63
  ACCESS_REQUEST_APPROVERS_TO_BE_NOTIFIED_LIMIT = 10

George Koltsov's avatar
George Koltsov committed
64
  SORTING_PREFERENCE_FIELD = :projects_sort
65
  MAX_BUILD_TIMEOUT = 1.month
George Koltsov's avatar
George Koltsov committed
66

67
68
  cache_markdown_field :description, pipeline: :description

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

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

  after_create :create_ci_cd_settings,
101
    unless: :ci_cd_settings
102

103
104
105
  after_create :create_container_expiration_policy,
               unless: :container_expiration_policy

106
  after_create :create_pages_metadatum,
107
               unless: :pages_metadatum
108

Mark Chao's avatar
Mark Chao committed
109
  after_create :set_timestamps_for_create
110
  after_update :update_forks_visibility_level
111

112
  before_destroy :remove_private_deploy_keys
113

114
  use_fast_destroy :build_trace_chunks
115

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

119
120
  after_validation :check_pending_delete

121
  # Storage specific hooks
122
  after_initialize :use_hashed_storage
123
  after_create :check_repository_absence!
124

125
  acts_as_ordered_taggable
126

127
  attr_accessor :old_path_with_namespace
128
  attr_accessor :template_name
129
  attr_writer :pipeline_status
130
  attr_accessor :skip_disk_validation
131

132
133
  alias_attribute :title, :name

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

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

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

  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
191
192
193
  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
194
  has_many :fork_network_projects, through: :fork_network, source: :projects
195

196
197
198
199
  # Packages
  has_many :packages, class_name: 'Packages::Package'
  has_many :package_files, through: :packages, class_name: 'Packages::PackageFile'

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

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

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

234
  alias_method :members, :project_members
235
236
  has_many :users, through: :project_members

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

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

254
255
  has_many :internal_ids

256
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
257
  has_one :project_feature, inverse_of: :project
258
  has_one :statistics, class_name: 'ProjectStatistics'
259
  has_one :feature_usage, class_name: 'ProjectFeatureUsage'
260

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

267
  has_many :prometheus_metrics
268
  has_many :prometheus_alerts, inverse_of: :project
269
270
  has_many :prometheus_alert_events, inverse_of: :project
  has_many :self_managed_prometheus_alert_events, inverse_of: :project
271
272
273
  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
274

275
276
277
  # 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.
278
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
279
  has_one :container_expiration_policy, inverse_of: :project
280

281
  has_many :commit_statuses
282
  # The relation :all_pipelines is intended to be used when we want to get the
283
284
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
285
286
287
  # 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.
288
  has_many :ci_pipelines,
289
          -> { ci_sources },
290
291
          class_name: 'Ci::Pipeline',
          inverse_of: :project
292
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
293
  has_many :ci_refs, class_name: 'Ci::Ref', inverse_of: :project
294
295
296
297
298

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

Nick Thomas's avatar
Nick Thomas committed
318
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
319
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
320

321
  has_many :project_badges, class_name: 'ProjectBadge'
322
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
323

324
  has_many :remote_mirrors, inverse_of: :project
325
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
326

327
328
  has_many :external_pull_requests, inverse_of: :project

329
330
331
  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

332
  has_many :import_failures, inverse_of: :project
333
  has_many :jira_imports, -> { order 'jira_imports.created_at' }, class_name: 'JiraImportState', inverse_of: :project
334

335
336
337
  has_many :daily_build_group_report_results, class_name: 'Ci::DailyBuildGroupReportResult'

  has_many :repository_storage_moves, class_name: 'ProjectRepositoryStorageMove'
338

339
340
  has_many :webide_pipelines, -> { webide_source }, class_name: 'Ci::Pipeline', inverse_of: :project
  has_many :reviews, inverse_of: :project
341

342
343
344
345
346
  # GitLab Pages
  has_many :pages_domains
  has_one  :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project
  has_many :pages_deployments

347
348
349
350
  # 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

351
352
353
354
  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'

355
  accepts_nested_attributes_for :variables, allow_destroy: true
356
  accepts_nested_attributes_for :project_feature, update_only: true
357
  accepts_nested_attributes_for :project_setting, update_only: true
358
  accepts_nested_attributes_for :import_data
359
  accepts_nested_attributes_for :auto_devops, update_only: true
360
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
361
  accepts_nested_attributes_for :container_expiration_policy, update_only: true
362

363
364
365
366
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

367
  accepts_nested_attributes_for :incident_management_setting, update_only: true
368
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
369
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
370
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
371
  accepts_nested_attributes_for :prometheus_service, update_only: true
372
  accepts_nested_attributes_for :alerting_setting, update_only: true
373

374
375
376
377
378
  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,
379
    :repository_access_level, :pages_access_level, :metrics_dashboard_access_level,
380
    to: :project_feature, allow_nil: true
381
382
383
  delegate :show_default_award_emojis, :show_default_award_emojis=,
    :show_default_award_emojis?,
    to: :project_setting, allow_nil: true
384
385
  delegate :scheduled?, :started?, :in_progress?, :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true
386
  delegate :squash_always?, :squash_never?, :squash_enabled_by_default?, :squash_readonly?, to: :project_setting
387
  delegate :no_import?, to: :import_state, allow_nil: true
388
  delegate :name, to: :owner, allow_nil: true, prefix: true
389
  delegate :members, to: :team, prefix: true
390
  delegate :add_user, :add_users, to: :team
391
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
392
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
393
  delegate :root_ancestor, to: :namespace, allow_nil: true
394
  delegate :last_pipeline, to: :commit, allow_nil: true
395
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
396
  delegate :dashboard_timezone, to: :metrics_setting, allow_nil: true, prefix: true
397
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
398
  delegate :forward_deployment_enabled, :forward_deployment_enabled=, :forward_deployment_enabled?, to: :ci_cd_settings
399
  delegate :actual_limits, :actual_plan_name, to: :namespace, allow_nil: true
400
401
402
403
  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
404

405
406
  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
407
  # Validations
408
  validates :creator, presence: true, on: :create
409
  validates :description, length: { maximum: 2000 }, allow_blank: true
410
  validates :ci_config_path,
411
    format: { without: %r{(\.{2}|\A/)},
412
              message: _('cannot include leading slash or directory traversal.') },
413
414
    length: { maximum: 255 },
    allow_blank: true
415
416
  validates :name,
    presence: true,
417
    length: { maximum: 255 },
418
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
419
              message: Gitlab::Regex.project_name_regex_message }
420
421
  validates :path,
    presence: true,
422
    project_path: true,
423
    length: { maximum: 255 }
424

425
426
  validates :project_feature, presence: true

427
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
428
  validates :name, uniqueness: { scope: :namespace_id }
429
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
430
431
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
432
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
433
  validate :check_vcs_type, on: :create
434
  validate :check_personal_projects_limit, on: :create
435
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
436
437
  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
438
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
439
440
441
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
442
  validates :variables, variable_duplicates: { scope: :environment_scope }
443
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
444
  validates :max_artifacts_size, numericality: { only_integer: true, greater_than: 0, allow_nil: true }
445

446
  # Scopes
447
  scope :pending_delete, -> { where(pending_delete: true) }
448
  scope :without_deleted, -> { where(pending_delete: false) }
449

450
451
452
453
454
455
456
457
458
459
460
  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
461

462
  # 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
463
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
464
465
  scope :sorted_by_stars_desc, -> { reorder(self.arel_table['star_count'].desc) }
  scope :sorted_by_stars_asc, -> { reorder(self.arel_table['star_count'].asc) }
466
  # Sometimes queries (e.g. using CTEs) require explicit disambiguation with table name
467
  scope :projects_order_id_desc, -> { reorder(self.arel_table['id'].desc) }
468

469
  scope :sorted_by_similarity_desc, -> (search, include_in_select: false) do
470
471
472
473
474
475
    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 }
    ])

476
477
478
479
    query = reorder(order_expression.desc, arel_table['id'].desc)

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

482
  scope :with_packages, -> { joins(:packages) }
483
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
484
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
485
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
486
  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
487
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
488
  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)) }
489
  scope :archived, -> { where(archived: true) }
490
  scope :non_archived, -> { where(archived: false) }
491
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
492
  scope :with_push, -> { joins(:events).merge(Event.pushed_action) }
493
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
494
495
496
  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)) }
497
  scope :inc_routes, -> { includes(:route, namespace: :route) }
Markus Koller's avatar
Markus Koller committed
498
  scope :with_statistics, -> { includes(:statistics) }
499
500
  scope :with_namespace, -> { includes(:namespace) }
  scope :with_import_state, -> { includes(:import_state) }
501
  scope :include_project_feature, -> { includes(:project_feature) }
502
  scope :with_service, ->(service) { joins(service).eager_load(service) }
503
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
504
  scope :with_container_registry, -> { where(container_registry_enabled: true) }
505
506
507
  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.
508
509
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
510
  end
511
512
513

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
514
515
516
517
    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)
518
519
520
521
522
523
524
525
  }

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

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

536
  scope :service_desk_enabled, -> { where(service_desk_enabled: true) }
537
538
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
539
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
540
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
541
542
543
  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
544
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
545
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
546
  scope :with_limit, -> (maximum) { limit(maximum) }
547

548
549
550
551
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end
552

553
554
555
556
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

557
558
559
560
561
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

562
563
  scope :with_api_commit_entity_associations, -> {
    preload(:project_feature, :route, namespace: [:route, :owner])
564
565
  }

566
567
  scope :imported_from, -> (type) { where(import_type: type) }

568
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
569

570
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
571
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
572
573

  validates :build_timeout, allow_nil: true,
574
                            numericality: { greater_than_or_equal_to: 10.minutes,
575
                                            less_than: MAX_BUILD_TIMEOUT,
576
                                            only_integer: true,
577
                                            message: _('needs to be between 10 minutes and 1 month') }
578

579
580
581
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

582
583
584
585
  def self.with_api_entity_associations
    preload(:project_feature, :route, :tags, :group, namespace: [:route, :owner])
  end

586
587
588
589
  def self.with_web_entity_associations
    preload(:project_feature, :route, :creator, :group, namespace: [:route, :owner])
  end

590
591
592
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end
593

594
595
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
596
597
598
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

599
600
601
602
603
    return public_to_user unless user

    if user.is_a?(DeployToken)
      user.projects
    else
604
      where('EXISTS (?) OR projects.visibility_level IN (?)',
605
            user.authorizations_for_projects(min_access_level: min_access_level),
606
            Gitlab::VisibilityLevel.levels_for_user(user))
607
608
609
    end
  end

610
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
611
  # they are only available to team members. This scope returns projects where
612
  # the feature is either public, enabled, or internal with permission for the user.
613
614
  # 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
615
  # that checks project authorizations first (e.g. `filter_by_feature_visibility`).
616
617
618
619
  #
  # 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.
620
  def self.with_feature_available_for_user(feature, user)
621
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
622
623
624
625

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
626
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
627
628
      column = ProjectFeature.quoted_access_level_column(feature)

629
      with_project_feature
630
631
632
633
634
635
      .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)
            })
636
    else
637
638
      # This has to be added to include features whose value is nil in the db
      visible << nil
639
640
      with_feature_access_level(feature, visible)
    end
641
  end
Felipe Artur's avatar
Felipe Artur committed
642

643
644
645
646
647
648
649
650
  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

651
652
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
653
654
655
656
657
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
658
659
  end

660
661
  def self.wrap_with_cte(collection)
    cte = Gitlab::SQL::CTE.new(:projects_cte, collection)
662
    Project.with(cte.to_arel).from(cte.alias_to(Project.arel_table))
663
664
  end

Rémy Coutable's avatar
Rémy Coutable committed
665
666
  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) }
667

668
  scope :excluding_project, ->(project) { where.not(id: project) }
669

670
671
  # 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") }
672
  scope :for_group, -> (group) { where(group: group) }
673
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
674
675
  scope :for_repository_storage, -> (repository_storage) { where(repository_storage: repository_storage) }
  scope :excluding_repository_storage, -> (repository_storage) { where.not(repository_storage: repository_storage) }
676

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

692
    def search_by_title(query)
693
      non_archived.fuzzy_search(query, [:name])
694
695
    end

696
697
698
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
699

700
    def sort_by_attribute(method)
701
702
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
703
704
705
        # 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')
706
      when 'latest_activity_desc'
707
        reorder(self.arel_table['last_activity_at'].desc)
708
      when 'latest_activity_asc'
709
        reorder(self.arel_table['last_activity_at'].asc)
710
      when 'stars_desc'
711
        sorted_by_stars_desc
712
713
      when 'stars_asc'
        sorted_by_stars_asc
714
715
      else
        order_by(method)
716
717
      end
    end
718
719

    def reference_pattern
720
      %r{
721
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
722
723
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
724
      }x
725
    end
726

727
728
729
730
    def reference_postfix
      '>'
    end

731
732
733
734
    def reference_postfix_escaped
      '&gt;'
    end

735
    # Pattern used to extract `namespace/project>` project references from text.
736
737
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
738
    def markdown_reference_pattern
739
740
741
742
743
      @markdown_reference_pattern ||=
        %r{
          #{reference_pattern}
          (#{reference_postfix}|#{reference_postfix_escaped})
        }x
744
745
    end

746
    def trending
747
748
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
749
    end
750
751
752
753
754
755

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

    def group_ids
758
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
759
    end
760

761
    # Returns ids of projects with issuables available for given user
762
    #
763