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

3
4
require 'carrierwave/orm/activerecord'

5
class Project < ApplicationRecord
6
  include Gitlab::ConfigHelper
7
  include Gitlab::ShellAdapter
8
  include Gitlab::VisibilityLevel
Rémy Coutable's avatar
Rémy Coutable committed
9
  include AccessRequestable
10
  include Avatarable
11
  include CacheMarkdownField
12
  include Sortable
13
  include AfterCommitQueue
14
  include CaseSensitivity
15
  include TokenAuthenticatable
16
  include ValidAttribute
17
  include ProjectAPICompatibility
Felipe Artur's avatar
Felipe Artur committed
18
  include ProjectFeaturesCompatibility
19
  include SelectForProjectAuthorization
20
  include Presentable
21
  include HasRepository
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
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
36

37
  extend Gitlab::ConfigHelper
38

39
  BoardLimitExceeded = Class.new(StandardError)
40

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

53
54
55
56
57
  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
58

59
60
  ACCESS_REQUEST_APPROVERS_TO_BE_NOTIFIED_LIMIT = 10

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

64
65
  cache_markdown_field :description, pipeline: :description

66
  default_value_for :archived, false
67
  default_value_for :resolve_outdated_diff_discussions, false
68
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
69
70
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
71
72
73
74
75
  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
76
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
77
  default_value_for :remove_source_branch_after_merge, true
78
  default_value_for :autoclose_referenced_issues, true
79
  default_value_for(:ci_config_path) { Gitlab::CurrentSettings.default_ci_config_path }
80

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

83
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
84

85
  before_save :ensure_runners_token
86

Jasper Maes's avatar
Jasper Maes committed
87
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
88
89
90

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

91
  after_create :create_project_feature, unless: :project_feature
92
93
94
95
96

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

97
98
99
  after_create :create_container_expiration_policy,
               unless: :container_expiration_policy

100
  after_create :create_pages_metadatum,
101
               unless: :pages_metadatum
102

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

106
  before_destroy :remove_private_deploy_keys
107

108
  use_fast_destroy :build_trace_chunks
109

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

113
114
  after_validation :check_pending_delete

115
  # Storage specific hooks
116
  after_initialize :use_hashed_storage
117
  after_create :check_repository_absence!
118

119
  acts_as_ordered_taggable
120

121
  attr_accessor :old_path_with_namespace
122
  attr_accessor :template_name
123
  attr_writer :pipeline_status
124
  attr_accessor :skip_disk_validation
125

126
127
  alias_attribute :title, :name

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

136
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
137
  has_many :boards
Felipe Artur's avatar
Felipe Artur committed
138

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

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

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

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

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

217
  alias_method :members, :project_members
218
  has_many :users, through: :project_members
219

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

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

238
239
  has_many :internal_ids

240
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
241
  has_one :project_feature, inverse_of: :project
242
  has_one :statistics, class_name: 'ProjectStatistics'
243

Shinya Maeda's avatar
Shinya Maeda committed
244
  has_one :cluster_project, class_name: 'Clusters::Project'
245
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
246
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
247
  has_many :management_clusters, class_name: 'Clusters::Cluster', foreign_key: :management_project_id, inverse_of: :management_project
248

249
  has_many :prometheus_metrics
250
  has_many :prometheus_alerts, inverse_of: :project
251

252
253
254
  # 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.
255
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
256
  has_one :container_expiration_policy, inverse_of: :project
257

258
  has_many :commit_statuses
259
  # The relation :all_pipelines is intended to be used when we want to get the
260
261
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
262
  # The relation :ci_pipelines is intended to be used when we want to get only
263
264
265
266
  # 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,
267
          -> { ci_sources },
268
269
          class_name: 'Ci::Pipeline',
          inverse_of: :project
270
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
271
  has_many :ci_refs, class_name: 'Ci::Ref'
272
273
274
275
276

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

Nick Thomas's avatar
Nick Thomas committed
293
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
294
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
295

296
  has_many :project_badges, class_name: 'ProjectBadge'
297
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
298

299
  has_many :remote_mirrors, inverse_of: :project
300
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
301

302
303
  has_many :external_pull_requests, inverse_of: :project

304
305
306
  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

307
308
  has_one :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project

309
310
  has_many :import_failures, inverse_of: :project

311
  accepts_nested_attributes_for :variables, allow_destroy: true
312
  accepts_nested_attributes_for :project_feature, update_only: true
313
  accepts_nested_attributes_for :import_data
314
  accepts_nested_attributes_for :auto_devops, update_only: true
315
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
316
  accepts_nested_attributes_for :container_expiration_policy, update_only: true
317

318
319
320
321
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

322
  accepts_nested_attributes_for :incident_management_setting, update_only: true
323
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
324
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
325
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
326
  accepts_nested_attributes_for :prometheus_service, update_only: true
327

328
329
330
331
332
  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,
333
    :repository_access_level, :pages_access_level,
334
335
336
337
    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
338
  delegate :name, to: :owner, allow_nil: true, prefix: true
339
  delegate :members, to: :team, prefix: true
340
  delegate :add_user, :add_users, to: :team
341
342
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
343
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
344
  delegate :root_ancestor, to: :namespace, allow_nil: true
345
  delegate :last_pipeline, to: :commit, allow_nil: true
346
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
347
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
348
  delegate :forward_deployment_enabled, :forward_deployment_enabled=, :forward_deployment_enabled?, to: :ci_cd_settings
349

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
350
  # Validations
351
  validates :creator, presence: true, on: :create
352
  validates :description, length: { maximum: 2000 }, allow_blank: true
353
  validates :ci_config_path,
354
    format: { without: %r{(\.{2}|\A/)},
355
              message: _('cannot include leading slash or directory traversal.') },
356
357
    length: { maximum: 255 },
    allow_blank: true
358
359
  validates :name,
    presence: true,
360
    length: { maximum: 255 },
361
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
362
              message: Gitlab::Regex.project_name_regex_message }
363
364
  validates :path,
    presence: true,
365
    project_path: true,
366
    length: { maximum: 255 }
367

368
369
  validates :project_feature, presence: true

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

389
  # Scopes
390
  scope :pending_delete, -> { where(pending_delete: true) }
391
  scope :without_deleted, -> { where(pending_delete: false) }
392

393
394
395
396
397
398
399
400
401
402
403
  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
404

405
  # 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
406
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
407
408
  scope :sorted_by_stars_desc, -> { reorder(self.arel_table['star_count'].desc) }
  scope :sorted_by_stars_asc, -> { reorder(self.arel_table['star_count'].asc) }
409
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
410
  # Sometimes queries (e.g. using CTEs) require explicit disambiguation with table name
411
  scope :projects_order_id_desc, -> { reorder(self.arel_table['id'].desc) }
412

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

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
440
441
442
443
    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)
444
445
446
447
448
449
450
451
  }

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

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

462
463
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
464
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
465
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
466
467
468
  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
469
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
470
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
471
  scope :with_limit, -> (maximum) { limit(maximum) }
472

473
474
475
476
477
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

478
479
480
481
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

482
483
484
485
486
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

487
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
488

489
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
490
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
491
492

  validates :build_timeout, allow_nil: true,
493
                            numericality: { greater_than_or_equal_to: 10.minutes,
494
                                            less_than: MAX_BUILD_TIMEOUT,
495
                                            only_integer: true,
496
                                            message: _('needs to be between 10 minutes and 1 month') }
497

498
499
500
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

501
502
503
504
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

505
506
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
507
508
509
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

510
511
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
512
            user.authorizations_for_projects(min_access_level: min_access_level),
513
514
515
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
516
517
518
    end
  end

519
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
520
  # they are only available to team members. This scope returns projects where
521
  # the feature is either public, enabled, or internal with permission for the user.
522
523
  # 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
524
  # that checks project authorizations first (e.g. `filter_by_feature_visibility`).
525
526
527
528
  #
  # 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.
529
  def self.with_feature_available_for_user(feature, user)
530
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
531
532
533
534

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
535
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
536
537
      column = ProjectFeature.quoted_access_level_column(feature)

538
      with_project_feature
539
540
541
542
543
544
      .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)
            })
545
    else
546
547
      # This has to be added to include features whose value is nil in the db
      visible << nil
548
549
      with_feature_access_level(feature, visible)
    end
550
  end
Felipe Artur's avatar
Felipe Artur committed
551

552
553
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
554
555
556
557
558
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
559
560
  end

561
562
  def self.wrap_with_cte(collection)
    cte = Gitlab::SQL::CTE.new(:projects_cte, collection)
563
564
565
    Project.with(cte.to_arel).from(cte.alias_to(Project.arel_table))
  end

Rémy Coutable's avatar
Rémy Coutable committed
566
567
  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) }
568

569
570
  scope :excluding_project, ->(project) { where.not(id: project) }

571
572
  # 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") }
573
  scope :for_group, -> (group) { where(group: group) }
574
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
575

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
576
  class << self
577
578
579
580
581
582
583
    # 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.
584
    def search(query)
585
586
587
588
589
      if Feature.enabled?(:project_search_by_full_path, default_enabled: true)
        joins(:route).fuzzy_search(query, [Route.arel_table[:path], :name, :description])
      else
        fuzzy_search(query, [:path, :name, :description])
      end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
590
    end
591

592
    def search_by_title(query)
593
      non_archived.fuzzy_search(query, [:name])
594
595
    end

596
597
598
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
599

600
    def sort_by_attribute(method)
601
602
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
603
604
605
        # 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')
606
      when 'latest_activity_desc'
607
        reorder(self.arel_table['last_activity_at'].desc)
608
      when 'latest_activity_asc'
609
        reorder(self.arel_table['last_activity_at'].asc)
610
      when 'stars_desc'
611
        sorted_by_stars_desc
612
613
      when 'stars_asc'
        sorted_by_stars_asc
614
615
      else
        order_by(method)
616
617
      end
    end
618
619

    def reference_pattern
620
      %r{
621
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
622
623
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
624
      }x
625
    end
626

627
628
629
630
    def reference_postfix
      '>'
    end

631
632
633
634
    def reference_postfix_escaped
      '&gt;'
    end

635
    # Pattern used to extract `namespace/project>` project references from text.
636
637
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
638
639
640
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
641
        (#{reference_postfix}|#{reference_postfix_escaped})
642
643
644
      }x
    end

645
    def trending
646
647
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
648
    end
649
650
651
652
653
654

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

    def group_ids
657
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
658
    end
659

660
    # Returns ids of projects with issuables available for given user
661
    #
662
663
664
    # 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)
665
666
667
668
669
      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
670
671
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
672
  def initialize(attributes = nil)
673
674
675
676
677
678
679
680
681
    # 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
682
683
    attributes ||= {}

684
685
686
687
688
689
690
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

691
692
693
694
695
696
697
698
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

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

707
708
709
710
711
712
  def autoclose_referenced_issues
    return true if super.nil?

    super
  end

713
714
715
716
717
  def preload_protected_branches
    preloader = ActiveRecord::Associations::Preloader.new
    preloader.preload(self, protected_branches: [:push_access_levels, :merge_access_levels])
  end

718
719
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
720
  def ancestors_upto(top = nil, hierarchy_order: nil)
721
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
722
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
723
724
  end

725
726
  alias_method :ancestors, :ancestors_upto

727
728
729
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
730
      super || namespace.emails_disabled?
731
732
733
    end
  end

734
  def lfs_enabled?
735
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
736

737
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
738
739
  end

Cindy Pallares's avatar
Cindy Pallares committed
740
741
  alias_method :lfs_enabled, :lfs_enabled?

742
  def auto_devops_enabled?
743
    if auto_devops&.enabled.nil?
744
      has_auto_devops_implicitly_enabled?
745
746
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
747
    end
748
749
  end

750
  def has_auto_devops_implicitly_enabled?
751
752
753
    auto_devops_config = first_auto_devops_config

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

756
  def has_auto_devops_implicitly_disabled?
757
758
759
760
761
762
763
764
765
    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) }
766
767
  end

Jacopo's avatar
Jacopo committed
768
769
770
771
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

772
  def unlink_forks_upon_visibility_decrease_enabled?
773
    Feature.enabled?(:unlink_fork_network_upon_visibility_decrease, self, default_enabled: true)
774
775
  end

776
777
778
779
  def context_commits_enabled?
    Feature.enabled?(:context_commits, default_enabled: true)
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
780
  def team
781
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
782
783
784
  end

  def repository
785
    @repository ||= Repository.new(full_path, self, shard: repository_storage, disk_path: disk_path)
786
787
  end

788
  def cleanup
789
790
791
    @repository = nil
  end

792
793
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
794
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
795
    if Gitlab.config.registry.enabled
796
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
797
    end
798
799
  end

800
  def has_container_registry_tags?
801
802
803
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
804
      has_root_container_repository_tags?
805
806
  end

Matija Čupić's avatar
Matija Čupić committed
807
  # ref can't be HEAD, can only be branch/tag name