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 76.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
13
  include Referable
  include Sortable
14
  include AfterCommitQueue
15
  include CaseSensitivity
16
  include TokenAuthenticatable
17
  include ValidAttribute
18
  include ProjectAPICompatibility
Felipe Artur's avatar
Felipe Artur committed
19
  include ProjectFeaturesCompatibility
20
  include SelectForProjectAuthorization
21
  include Presentable
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 :campfire_service
blackst0ne's avatar
blackst0ne committed
141
  has_one :discord_service
142
143
144
145
146
  has_one :drone_ci_service
  has_one :emails_on_push_service
  has_one :pipelines_email_service
  has_one :irker_service
  has_one :pivotaltracker_service
147
  has_one :hipchat_service
148
149
150
151
152
153
154
155
156
157
158
159
160
  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
161
  has_one :youtrack_service
162
163
164
165
166
167
168
169
170
  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
171
  has_one :packagist_service
172
  has_one :hangouts_chat_service
173
  has_one :unify_circuit_service
174

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

186
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
187
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
188
  has_one :project_repository, inverse_of: :project
189
  has_one :error_tracking_setting, inverse_of: :project, class_name: 'ErrorTracking::ProjectErrorTrackingSetting'
190
  has_one :metrics_setting, inverse_of: :project, class_name: 'ProjectMetricsSetting'
191
  has_one :grafana_integration, inverse_of: :project
192

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

208
  has_many :project_authorizations
209
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
210
  has_many :project_members, -> { where(requested_at: nil) },
211
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
212

213
  alias_method :members, :project_members
214
  has_many :users, through: :project_members
215

216
  has_many :requesters, -> { where.not(requested_at: nil) },
217
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
218
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
219

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

234
235
  has_many :internal_ids

236
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
237
  has_one :project_feature, inverse_of: :project
238
  has_one :statistics, class_name: 'ProjectStatistics'
239

Shinya Maeda's avatar
Shinya Maeda committed
240
  has_one :cluster_project, class_name: 'Clusters::Project'
241
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
242
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
243
  has_many :management_clusters, class_name: 'Clusters::Cluster', foreign_key: :management_project_id, inverse_of: :management_project
244

245
246
  has_many :prometheus_metrics

247
248
249
  # 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.
250
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
251
  has_one :container_expiration_policy, inverse_of: :project
252

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

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

Nick Thomas's avatar
Nick Thomas committed
287
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
288
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
289

290
  has_many :project_badges, class_name: 'ProjectBadge'
291
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
292

293
  has_many :remote_mirrors, inverse_of: :project
294
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
295

296
297
  has_many :external_pull_requests, inverse_of: :project

298
299
300
  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

301
302
  has_one :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project

303
304
  has_many :import_failures, inverse_of: :project

305
  accepts_nested_attributes_for :variables, allow_destroy: true
306
  accepts_nested_attributes_for :project_feature, update_only: true
307
  accepts_nested_attributes_for :import_data
308
  accepts_nested_attributes_for :auto_devops, update_only: true
309
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
310
  accepts_nested_attributes_for :container_expiration_policy, update_only: true
311

312
313
314
315
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

316
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
317
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
318
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
319

320
321
322
323
324
325
326
327
328
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?, :merge_requests_enabled?,
    :issues_enabled?, :pages_enabled?, :public_pages?, :private_pages?,
    :merge_requests_access_level, :issues_access_level, :wiki_access_level,
    :snippets_access_level, :builds_access_level, :repository_access_level,
    to: :project_feature, allow_nil: true
  delegate :scheduled?, :started?, :in_progress?, :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true
  delegate :base_dir, :disk_path, to: :storage
  delegate :no_import?, to: :import_state, allow_nil: true
329
  delegate :name, to: :owner, allow_nil: true, prefix: true
330
  delegate :members, to: :team, prefix: true
331
  delegate :add_user, :add_users, to: :team
332
333
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
334
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
335
  delegate :root_ancestor, to: :namespace, allow_nil: true
336
  delegate :last_pipeline, to: :commit, allow_nil: true
337
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
338
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
339

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
340
  # Validations
341
  validates :creator, presence: true, on: :create
342
  validates :description, length: { maximum: 2000 }, allow_blank: true
343
  validates :ci_config_path,
344
    format: { without: %r{(\.{2}|\A/)},
345
              message: _('cannot include leading slash or directory traversal.') },
346
347
    length: { maximum: 255 },
    allow_blank: true
348
349
  validates :name,
    presence: true,
350
    length: { maximum: 255 },
351
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
352
              message: Gitlab::Regex.project_name_regex_message }
353
354
  validates :path,
    presence: true,
355
    project_path: true,
356
    length: { maximum: 255 }
357

358
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
359
  validates :name, uniqueness: { scope: :namespace_id }
360
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
361
362
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
363
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
364
  validate :check_personal_projects_limit, on: :create
365
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
366
367
  validate :visibility_level_allowed_by_group, if: :should_validate_visibility_level?
  validate :visibility_level_allowed_as_fork, if: :should_validate_visibility_level?
368
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
369
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
370
371
372
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
373
  validates :variables, variable_duplicates: { scope: :environment_scope }
374
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
375
  validates :max_artifacts_size, numericality: { only_integer: true, greater_than: 0, allow_nil: true }
376

377
  # Scopes
378
  scope :pending_delete, -> { where(pending_delete: true) }
379
  scope :without_deleted, -> { where(pending_delete: false) }
380

381
382
383
384
385
386
387
388
389
390
391
  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
392

393
  # 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
394
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
395
  scope :sorted_by_stars_desc, -> { reorder(star_count: :desc) }
396
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
397
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
398

399
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
400
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
401
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
402
  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
403
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
404
  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)) }
405
  scope :archived, -> { where(archived: true) }
406
  scope :non_archived, -> { where(archived: false) }
407
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
408
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
409
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
410
  scope :inc_routes, -> { includes(:route, namespace: :route) }
Markus Koller's avatar
Markus Koller committed
411
  scope :with_statistics, -> { includes(:statistics) }
412
  scope :with_service, ->(service) { joins(service).eager_load(service) }
413
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
414
  scope :with_container_registry, -> { where(container_registry_enabled: true) }
415
416
417
  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.
418
419
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
420
  end
421
422
423

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
424
425
426
427
    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)
428
429
430
431
432
433
434
435
  }

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

436
437
438
439
440
441
442
443
444
445
  # 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

446
447
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
448
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
449
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
450
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
451
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
452
  scope :with_limit, -> (maximum) { limit(maximum) }
453

454
455
456
457
458
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

459
460
461
462
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

463
464
465
466
467
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

468
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
469

470
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
471
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
472
473

  validates :build_timeout, allow_nil: true,
474
                            numericality: { greater_than_or_equal_to: 10.minutes,
475
                                            less_than: MAX_BUILD_TIMEOUT,
476
                                            only_integer: true,
477
                                            message: _('needs to be between 10 minutes and 1 month') }
478

479
480
481
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

482
483
484
485
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

486
487
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
488
489
490
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

491
492
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
493
            user.authorizations_for_projects(min_access_level: min_access_level),
494
495
496
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
497
498
499
    end
  end

500
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
501
  # they are only available to team members. This scope returns projects where
502
  # the feature is either public, enabled, or internal with permission for the user.
503
504
  # 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
505
  # that checks project authorizations first (e.g. `filter_by_feature_visibility`).
506
507
508
509
  #
  # 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.
510
  def self.with_feature_available_for_user(feature, user)
511
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
512
513
514
515

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
516
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
517
518
      column = ProjectFeature.quoted_access_level_column(feature)

519
      with_project_feature
520
521
522
523
524
525
      .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)
            })
526
    else
527
528
      # This has to be added to include features whose value is nil in the db
      visible << nil
529
530
      with_feature_access_level(feature, visible)
    end
531
  end
Felipe Artur's avatar
Felipe Artur committed
532

533
534
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
535
536
537
538
539
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
540
541
  end

Rémy Coutable's avatar
Rémy Coutable committed
542
543
  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) }
544

545
546
  scope :excluding_project, ->(project) { where.not(id: project) }

547
548
  # 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") }
549
  scope :for_group, -> (group) { where(group: group) }
550
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
551

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
552
  class << self
553
554
555
556
557
558
559
    # 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.
560
    def search(query)
561
562
563
564
565
      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
566
    end
567

568
    def search_by_title(query)
569
      non_archived.fuzzy_search(query, [:name])
570
571
    end

572
573
574
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
575

576
    def sort_by_attribute(method)
577
578
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
579
580
581
        # 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')
582
583
584
585
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
586
      when 'stars_desc'
587
        sorted_by_stars_desc
588
589
      when 'stars_asc'
        sorted_by_stars_asc
590
591
      else
        order_by(method)
592
593
      end
    end
594
595

    def reference_pattern
596
      %r{
597
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
598
599
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
600
      }x
601
    end
602

603
604
605
606
    def reference_postfix
      '>'
    end

607
608
609
610
    def reference_postfix_escaped
      '&gt;'
    end

611
    # Pattern used to extract `namespace/project>` project references from text.
612
613
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
614
615
616
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
617
        (#{reference_postfix}|#{reference_postfix_escaped})
618
619
620
      }x
    end

621
    def trending
622
623
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
624
    end
625
626
627
628
629
630

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

    def group_ids
633
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
634
    end
635

636
    # Returns ids of projects with issuables available for given user
637
    #
638
639
640
    # 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)
641
642
643
644
645
      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
646
647
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
648
  def initialize(attributes = nil)
649
650
651
652
653
654
655
656
657
    # 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
658
659
    attributes ||= {}

660
661
662
663
664
665
666
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

667
668
669
670
671
672
673
674
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

675
676
677
678
679
680
681
682
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

683
684
685
686
687
688
  def autoclose_referenced_issues
    return true if super.nil?

    super
  end

689
690
691
692
693
  def preload_protected_branches
    preloader = ActiveRecord::Associations::Preloader.new
    preloader.preload(self, protected_branches: [:push_access_levels, :merge_access_levels])
  end

694
695
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
696
  def ancestors_upto(top = nil, hierarchy_order: nil)
697
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
698
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
699
700
  end

701
702
  alias_method :ancestors, :ancestors_upto

703
704
705
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
706
      super || namespace.emails_disabled?
707
708
709
    end
  end

710
  def lfs_enabled?
711
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
712

713
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
714
715
  end

Cindy Pallares's avatar
Cindy Pallares committed
716
717
  alias_method :lfs_enabled, :lfs_enabled?

718
  def auto_devops_enabled?
719
    if auto_devops&.enabled.nil?
720
      has_auto_devops_implicitly_enabled?
721
722
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
723
    end
724
725
  end

726
  def has_auto_devops_implicitly_enabled?
727
728
729
    auto_devops_config = first_auto_devops_config

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

732
  def has_auto_devops_implicitly_disabled?
733
734
735
736
737
738
739
740
741
    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) }
742
743
  end

Jacopo's avatar
Jacopo committed
744
745
746
747
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

748
  def unlink_forks_upon_visibility_decrease_enabled?
749
    Feature.enabled?(:unlink_fork_network_upon_visibility_decrease, self, default_enabled: true)
750
751
  end

752
753
754
755
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
756
  def team
757
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
758
759
760
  end

  def repository
761
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
762
763
  end

764
  def cleanup
765
766
767
    @repository = nil
  end

768
769
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
770
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
771
    if Gitlab.config.registry.enabled
772
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
773
    end
774
775
  end

776
  def has_container_registry_tags?
777
778
779
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
780
      has_root_container_repository_tags?
781
782
  end

783
784
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
785
786
  end

787
788
789
790
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

791
792
793
794
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

Matija Čupić's avatar
Matija Čupić committed
795
  # ref can't be HEAD, can only be branch/tag name
796
  def latest_successful_build_for_ref(job_name, ref = default_branch)
Matija Čupić's avatar
Matija Čupić committed
797
798
    return unless ref

799
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
800
    return unless latest_pipeline
801

802
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
803
804
  end

805
  def latest_successful_build_for_sha(job_name, sha)
Matija Čupić's avatar
Matija Čupić committed
806
807
808
    return unless sha

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
809
    return unless latest_pipeline
810

811
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
812
813
  end

814
815
  def latest_successful_build_for_ref!(job_name, ref = default_branch)
    latest_successful_build_for_ref(job_name, ref) || raise(ActiveRecord::RecordNotFound.new("Couldn't find job #{job_name}"))
816
817
  end

818
819
820
821
822
823
824
825
826
  def latest_pipeline_for_ref(ref = default_branch)
    ref = ref.presence || default_branch
    sha = commit(ref)&.sha

    return unless sha

    ci_pipelines.newest_first(ref: ref, sha: sha).first
  end