project.rb 81.8 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 Routable
22
  include GroupDescendant
23
  include Gitlab::SQL::Pattern
24
  include DeploymentPlatform
25
  include ::Gitlab::Utils::StrongMemoize
26
  include ChronicDurationAttribute
27
  include FastDestroyAll::Helpers
Jan Provaznik's avatar
Jan Provaznik committed
28
  include WithUploads
29
  include BatchDestroyDependentAssociations
30
  include FeatureGate
31
  include OptionallySearch
32
  include FromUnion
33
  include IgnorableColumns
34
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
35

36
  extend Gitlab::ConfigHelper
37

38
  BoardLimitExceeded = Class.new(StandardError)
39

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

52
53
54
55
56
  VALID_IMPORT_PORTS = [80, 443].freeze
  VALID_IMPORT_PROTOCOLS = %w(http https git).freeze

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

58
59
  ACCESS_REQUEST_APPROVERS_TO_BE_NOTIFIED_LIMIT = 10

George Koltsov's avatar
George Koltsov committed
60
  SORTING_PREFERENCE_FIELD = :projects_sort
61
  MAX_BUILD_TIMEOUT = 1.month
George Koltsov's avatar
George Koltsov committed
62

63
64
  cache_markdown_field :description, pipeline: :description

65
  default_value_for :archived, false
66
  default_value_for :resolve_outdated_diff_discussions, false
67
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
68
  default_value_for(:repository_storage) do
69
    pick_repository_storage
70
71
  end

72
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
73
74
75
76
77
  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
78
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
79
  default_value_for :remove_source_branch_after_merge, true
80
  default_value_for :autoclose_referenced_issues, true
81
  default_value_for(:ci_config_path) { Gitlab::CurrentSettings.default_ci_config_path }
82

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

85
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
86

87
  before_save :ensure_runners_token
88

Jasper Maes's avatar
Jasper Maes committed
89
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
90
91
92

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

93
  after_create :create_project_feature, unless: :project_feature
94
95
96
97
98

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

99
100
101
  after_create :create_container_expiration_policy,
               unless: :container_expiration_policy

102
  after_create :create_pages_metadatum,
103
               unless: :pages_metadatum
104

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

108
  before_destroy :remove_private_deploy_keys
109
  before_destroy :cleanup_chat_names
110

111
  use_fast_destroy :build_trace_chunks
112

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

116
117
  after_validation :check_pending_delete

118
  # Storage specific hooks
119
  after_initialize :use_hashed_storage
120
  after_create :check_repository_absence!
121

122
  acts_as_ordered_taggable
123

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

129
130
  alias_attribute :title, :name

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

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

142
  # Project services
143
  has_one :alerts_service
144
  has_one :campfire_service
blackst0ne's avatar
blackst0ne committed
145
  has_one :discord_service
146
147
148
149
150
  has_one :drone_ci_service
  has_one :emails_on_push_service
  has_one :pipelines_email_service
  has_one :irker_service
  has_one :pivotaltracker_service
151
  has_one :hipchat_service
152
153
154
155
156
157
158
159
160
161
162
163
164
  has_one :flowdock_service
  has_one :assembla_service
  has_one :asana_service
  has_one :mattermost_slash_commands_service
  has_one :mattermost_service
  has_one :slack_slash_commands_service
  has_one :slack_service
  has_one :buildkite_service
  has_one :bamboo_service
  has_one :teamcity_service
  has_one :pushover_service
  has_one :jira_service
  has_one :redmine_service
Yauhen Kotau's avatar
Yauhen Kotau committed
165
  has_one :youtrack_service
166
167
168
169
170
171
172
173
174
  has_one :custom_issue_tracker_service
  has_one :bugzilla_service
  has_one :gitlab_issue_tracker_service, inverse_of: :project
  has_one :external_wiki_service
  has_one :prometheus_service, inverse_of: :project
  has_one :mock_ci_service
  has_one :mock_deployment_service
  has_one :mock_monitoring_service
  has_one :microsoft_teams_service
Matt Coleman's avatar
Matt Coleman committed
175
  has_one :packagist_service
176
  has_one :hangouts_chat_service
177
  has_one :unify_circuit_service
178

179
180
181
182
183
  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
184
  has_one :fork_network, through: :fork_network_member
185
186
187
  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
188
  has_many :fork_network_projects, through: :fork_network, source: :projects
189

190
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
191
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
192
  has_many :export_jobs, class_name: 'ProjectExportJob'
193
  has_one :project_repository, inverse_of: :project
194
  has_one :incident_management_setting, inverse_of: :project, class_name: 'IncidentManagement::ProjectIncidentManagementSetting'
195
  has_one :error_tracking_setting, inverse_of: :project, class_name: 'ErrorTracking::ProjectErrorTrackingSetting'
196
  has_one :metrics_setting, inverse_of: :project, class_name: 'ProjectMetricsSetting'
197
  has_one :grafana_integration, inverse_of: :project
198
  has_one :project_setting, ->(project) { where_or_create_by(project: project) }, inverse_of: :project
199
  has_one :alerting_setting, inverse_of: :project, class_name: 'Alerting::ProjectAlertingSetting'
200

201
  # Merge Requests for target project should be removed with it
202
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
203
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
204
205
206
207
208
209
210
211
212
213
  has_many :issues
  has_many :labels, class_name: 'ProjectLabel'
  has_many :services
  has_many :events
  has_many :milestones
  has_many :notes
  has_many :snippets, class_name: 'ProjectSnippet'
  has_many :hooks, class_name: 'ProjectHook'
  has_many :protected_branches
  has_many :protected_tags
214
  has_many :repository_languages, -> { order "share DESC" }
215

216
  has_many :project_authorizations
217
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
218
  has_many :project_members, -> { where(requested_at: nil) },
219
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
220

221
  alias_method :members, :project_members
222
  has_many :users, through: :project_members
223

224
  has_many :requesters, -> { where.not(requested_at: nil) },
225
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
226
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
227

228
  has_many :deploy_keys_projects, inverse_of: :project
229
  has_many :deploy_keys, through: :deploy_keys_projects
230
  has_many :users_star_projects
231
  has_many :starrers, through: :users_star_projects, source: :user
232
  has_many :releases
233
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
234
  has_many :lfs_objects, -> { distinct }, through: :lfs_objects_projects
235
  has_many :lfs_file_locks
236
  has_many :project_group_links
237
  has_many :invited_groups, through: :project_group_links, source: :group
238
239
  has_many :pages_domains
  has_many :todos
240
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
241

242
243
  has_many :internal_ids

244
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
245
  has_one :project_feature, inverse_of: :project
246
  has_one :statistics, class_name: 'ProjectStatistics'
247

Shinya Maeda's avatar
Shinya Maeda committed
248
  has_one :cluster_project, class_name: 'Clusters::Project'
249
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
250
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
251
  has_many :management_clusters, class_name: 'Clusters::Cluster', foreign_key: :management_project_id, inverse_of: :management_project
252

253
  has_many :prometheus_metrics
254
  has_many :prometheus_alerts, inverse_of: :project
255
256
  has_many :prometheus_alert_events, inverse_of: :project
  has_many :self_managed_prometheus_alert_events, inverse_of: :project
257

258
259
260
  # 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.
261
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
262
  has_one :container_expiration_policy, inverse_of: :project
263

264
  has_many :commit_statuses
265
  # The relation :all_pipelines is intended to be used when we want to get the
266
267
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
268
  # The relation :ci_pipelines is intended to be used when we want to get only
269
270
271
272
  # those pipeline which are directly related to CI. There are
  # other pipelines, like webide ones, that we won't retrieve
  # if we use this relation.
  has_many :ci_pipelines,
273
          -> { ci_sources },
274
275
          class_name: 'Ci::Pipeline',
          inverse_of: :project
276
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
277
  has_many :ci_refs, class_name: 'Ci::Ref'
278
279
280
281
282

  # 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.
283
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
284
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
285
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
286
  has_many :job_artifacts, class_name: 'Ci::JobArtifact'
287
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
288
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
289
  has_many :variables, class_name: 'Ci::Variable'
290
291
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
292
  has_many :environments_for_dashboard, -> { from(with_rank.unfoldered.available, :environments).where('rank <= 3') }, class_name: 'Environment'
293
  has_many :deployments
294
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
295
  has_many :project_deploy_tokens
296
  has_many :deploy_tokens, through: :project_deploy_tokens
297
  has_many :resource_groups, class_name: 'Ci::ResourceGroup', inverse_of: :project
298

Nick Thomas's avatar
Nick Thomas committed
299
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
300
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
301

302
  has_many :project_badges, class_name: 'ProjectBadge'
303
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
304

305
  has_many :remote_mirrors, inverse_of: :project
306
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
307

308
309
  has_many :external_pull_requests, inverse_of: :project

310
311
312
  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

313
314
  has_one :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project

315
  has_many :import_failures, inverse_of: :project
316
  has_many :jira_imports, -> { order 'jira_imports.created_at' }, class_name: 'JiraImportState', inverse_of: :project
317

318
319
  has_many :daily_report_results, class_name: 'Ci::DailyReportResult'

320
  accepts_nested_attributes_for :variables, allow_destroy: true
321
  accepts_nested_attributes_for :project_feature, update_only: true
322
  accepts_nested_attributes_for :import_data
323
  accepts_nested_attributes_for :auto_devops, update_only: true
324
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
325
  accepts_nested_attributes_for :container_expiration_policy, update_only: true
326

327
328
329
330
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

331
  accepts_nested_attributes_for :incident_management_setting, update_only: true
332
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
333
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
334
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
335
  accepts_nested_attributes_for :prometheus_service, update_only: true
336
  accepts_nested_attributes_for :alerting_setting, update_only: true
337

338
339
340
341
342
  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,
343
    :repository_access_level, :pages_access_level,
344
345
346
347
    to: :project_feature, allow_nil: true
  delegate :scheduled?, :started?, :in_progress?, :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true
  delegate :no_import?, to: :import_state, allow_nil: true
348
  delegate :name, to: :owner, allow_nil: true, prefix: true
349
  delegate :members, to: :team, prefix: true
350
  delegate :add_user, :add_users, to: :team
351
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
352
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
353
  delegate :root_ancestor, to: :namespace, allow_nil: true
354
  delegate :last_pipeline, to: :commit, allow_nil: true
355
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
356
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
357
  delegate :forward_deployment_enabled, :forward_deployment_enabled=, :forward_deployment_enabled?, to: :ci_cd_settings
358

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
359
  # Validations
360
  validates :creator, presence: true, on: :create
361
  validates :description, length: { maximum: 2000 }, allow_blank: true
362
  validates :ci_config_path,
363
    format: { without: %r{(\.{2}|\A/)},
364
              message: _('cannot include leading slash or directory traversal.') },
365
366
    length: { maximum: 255 },
    allow_blank: true
367
368
  validates :name,
    presence: true,
369
    length: { maximum: 255 },
370
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
371
              message: Gitlab::Regex.project_name_regex_message }
372
373
  validates :path,
    presence: true,
374
    project_path: true,
375
    length: { maximum: 255 }
376

377
378
  validates :project_feature, presence: true

379
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
380
  validates :name, uniqueness: { scope: :namespace_id }
381
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
382
383
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
384
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
385
  validate :check_personal_projects_limit, on: :create
386
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
387
388
  validate :visibility_level_allowed_by_group, if: :should_validate_visibility_level?
  validate :visibility_level_allowed_as_fork, if: :should_validate_visibility_level?
389
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
390
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
391
392
393
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
394
  validates :variables, variable_duplicates: { scope: :environment_scope }
395
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
396
  validates :max_artifacts_size, numericality: { only_integer: true, greater_than: 0, allow_nil: true }
397

398
  # Scopes
399
  scope :pending_delete, -> { where(pending_delete: true) }
400
  scope :without_deleted, -> { where(pending_delete: false) }
401

402
403
404
405
406
407
408
409
410
411
412
  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
413

414
  # 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
415
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
416
417
  scope :sorted_by_stars_desc, -> { reorder(self.arel_table['star_count'].desc) }
  scope :sorted_by_stars_asc, -> { reorder(self.arel_table['star_count'].asc) }
418
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
419
  # Sometimes queries (e.g. using CTEs) require explicit disambiguation with table name
420
  scope :projects_order_id_desc, -> { reorder(self.arel_table['id'].desc) }
421

422
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
423
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
424
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
425
  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
426
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
427
  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)) }
428
  scope :archived, -> { where(archived: true) }
429
  scope :non_archived, -> { where(archived: false) }
430
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
431
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
432
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
433
  scope :inc_routes, -> { includes(:route, namespace: :route) }
Markus Koller's avatar
Markus Koller committed
434
  scope :with_statistics, -> { includes(:statistics) }
435
436
  scope :with_namespace, -> { includes(:namespace) }
  scope :with_import_state, -> { includes(:import_state) }
437
  scope :with_service, ->(service) { joins(service).eager_load(service) }
438
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
439
  scope :with_container_registry, -> { where(container_registry_enabled: true) }
440
441
442
  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.
443
444
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
445
  end
446
447
448

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
449
450
451
452
    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)
453
454
455
456
457
458
459
460
  }

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

461
462
463
464
465
466
467
468
469
470
  # 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

471
472
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
473
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
474
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
475
476
477
  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
478
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
479
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
480
  scope :with_limit, -> (maximum) { limit(maximum) }
481

482
483
484
485
486
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

487
488
489
490
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

491
492
493
494
495
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

496
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
497

498
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
499
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
500
501

  validates :build_timeout, allow_nil: true,
502
                            numericality: { greater_than_or_equal_to: 10.minutes,
503
                                            less_than: MAX_BUILD_TIMEOUT,
504
                                            only_integer: true,
505
                                            message: _('needs to be between 10 minutes and 1 month') }
506

507
508
509
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

510
511
512
513
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

514
515
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
516
517
518
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

519
520
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
521
            user.authorizations_for_projects(min_access_level: min_access_level),
522
523
524
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
525
526
527
    end
  end

528
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
529
  # they are only available to team members. This scope returns projects where
530
  # the feature is either public, enabled, or internal with permission for the user.
531
532
  # 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
533
  # that checks project authorizations first (e.g. `filter_by_feature_visibility`).
534
535
536
537
  #
  # 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.
538
  def self.with_feature_available_for_user(feature, user)
539
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
540
541
542
543

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
544
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
545
546
      column = ProjectFeature.quoted_access_level_column(feature)

547
      with_project_feature
548
549
550
551
552
553
      .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)
            })
554
    else
555
556
      # This has to be added to include features whose value is nil in the db
      visible << nil
557
558
      with_feature_access_level(feature, visible)
    end
559
  end
Felipe Artur's avatar
Felipe Artur committed
560

561
562
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
563
564
565
566
567
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
568
569
  end

570
571
  def self.wrap_with_cte(collection)
    cte = Gitlab::SQL::CTE.new(:projects_cte, collection)
572
573
574
    Project.with(cte.to_arel).from(cte.alias_to(Project.arel_table))
  end

Rémy Coutable's avatar
Rémy Coutable committed
575
576
  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) }
577

578
579
  scope :excluding_project, ->(project) { where.not(id: project) }

580
581
  # 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") }
582
  scope :for_group, -> (group) { where(group: group) }
583
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
584

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
585
  class << self
586
587
588
589
590
591
592
    # Searches for a list of projects based on the query given in `query`.
    #
    # On PostgreSQL this method uses "ILIKE" to perform a case-insensitive
    # search. On MySQL a regular "LIKE" is used as it's already
    # case-insensitive.
    #
    # query - The search query as a String.
593
594
595
    def search(query, include_namespace: false)
      if include_namespace && Feature.enabled?(:project_search_by_full_path, default_enabled: true)
        joins(:route).fuzzy_search(query, [Route.arel_table[:path], Route.arel_table[:name], :description])
596
597
598
      else
        fuzzy_search(query, [:path, :name, :description])
      end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
599
    end
600

601
    def search_by_title(query)
602
      non_archived.fuzzy_search(query, [:name])
603
604
    end

605
606
607
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
608

609
    def sort_by_attribute(method)
610
611
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
612
613
614
        # 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')
615
      when 'latest_activity_desc'
616
        reorder(self.arel_table['last_activity_at'].desc)
617
      when 'latest_activity_asc'
618
        reorder(self.arel_table['last_activity_at'].asc)
619
      when 'stars_desc'
620
        sorted_by_stars_desc
621
622
      when 'stars_asc'
        sorted_by_stars_asc
623
624
      else
        order_by(method)
625
626
      end
    end
627
628

    def reference_pattern
629
      %r{
630
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
631
632
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
633
      }x
634
    end
635

636
637
638
639
    def reference_postfix
      '>'
    end

640
641
642
643
    def reference_postfix_escaped
      '&gt;'
    end

644
    # Pattern used to extract `namespace/project>` project references from text.
645
646
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
647
648
649
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
650
        (#{reference_postfix}|#{reference_postfix_escaped})
651
652
653
      }x
    end

654
    def trending
655
656
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
657
    end
658
659
660
661
662
663

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

    def group_ids
666
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
667
    end
668

669
    # Returns ids of projects with issuables available for given user
670
    #
671
672
673
    # Used on queries to find milestones or labels which user can see
    # For example: Milestone.where(project_id: ids_with_issuables_available_for(user))
    def ids_with_issuables_available_for(user)
674
675
676
677
678
      with_issues_enabled = with_issues_available_for_user(user).select(:id)
      with_merge_requests_enabled = with_merge_requests_available_for_user(user).select(:id)

      from_union([with_issues_enabled, with_merge_requests_enabled]).select(:id)
    end
679
680
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
681
  def initialize(attributes = nil)
682
683
684
685
686
687
688
689
690
    # We can't use default_value_for because the database has a default
    # value of 0 for visibility_level. If someone attempts to create a
    # private project, default_value_for will assume that the
    # visibility_level hasn't changed and will use the application
    # setting default, which could be internal or public. For projects
    # inside a private group, those levels are invalid.
    #
    # To fix the problem, we assign the actual default in the application if
    # no explicit visibility has been initialized.
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
691
692
    attributes ||= {}

693
694
695
696
697
698
699
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

700
701
702
703
704
705
706
707
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

708
709
710
711
712
713
714
715
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

716
717
718
719
720
721
  def autoclose_referenced_issues
    return true if super.nil?

    super
  end

722
723
724
725
726
  def preload_protected_branches
    preloader = ActiveRecord::Associations::Preloader.new
    preloader.preload(self, protected_branches: [:push_access_levels, :merge_access_levels])
  end

727
728
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
729
  def ancestors_upto(top = nil, hierarchy_order: nil)
730
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
731
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
732
733
  end

734
735
  alias_method :ancestors, :ancestors_upto

736
737
738
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
739
      super || namespace.emails_disabled?
740
741
742
    end
  end

743
  def lfs_enabled?
744
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
745

746
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
747
748
  end

Cindy Pallares's avatar
Cindy Pallares committed
749
750
  alias_method :lfs_enabled, :lfs_enabled?

751
  def auto_devops_enabled?
752
    if auto_devops&.enabled.nil?
753
      has_auto_devops_implicitly_enabled?
754
755
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
756
    end
757
758
  end

759
  def has_auto_devops_implicitly_enabled?
760
761
762
    auto_devops_config = first_auto_devops_config

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

765
  def has_auto_devops_implicitly_disabled?
766
767
768
769
770
771
772
773
774
    auto_devops_config = first_auto_devops_config

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

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

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

Jacopo's avatar
Jacopo committed
777
778
779
780
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

781
  def unlink_forks_upon_visibility_decrease_enabled?
782
    Feature.enabled?(:unlink_fork_network_upon_visibility_decrease, self, default_enabled: true)
783
784
  end

785
786
787
788
  def context_commits_enabled?
    Feature.enabled?(:context_commits, default_enabled: true)
  end

789
790
791
792
  def jira_issues_import_feature_flag_enabled?
    Feature.enabled?(:jira_issue_import, self)
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
793
  def team
794
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
795
796
797
  end

  def repository
798
    @repository ||= Repository.new(full_path, self, shard: repository_storage, disk_path: disk_path)
799
800
  end

801
  def cleanup
802
803
804
    @repository = nil
  end