project.rb 76.5 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
67
  # TODO: remove once GitLab 12.5 is released
  # https://gitlab.com/gitlab-org/gitlab/issues/34638
68
  ignore_column :merge_requests_require_code_owner_approval, remove_after: '2019-12-01', remove_with: '12.6'
69

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

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

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

88
  before_save :ensure_runners_token
89

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

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

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

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

100
101
102
  after_create :create_container_expiration_policy,
               unless: :container_expiration_policy

103
  after_create :create_pages_metadatum,
104
               unless: :pages_metadatum
105

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

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

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

189
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
190
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
191
  has_one :project_repository, inverse_of: :project
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

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

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

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

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

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

237
238
  has_many :internal_ids

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

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

248
249
  has_many :prometheus_metrics

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

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

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

Nick Thomas's avatar
Nick Thomas committed
290
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
291
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
292

293
  has_many :project_badges, class_name: 'ProjectBadge'
294
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
295

296
  has_many :remote_mirrors, inverse_of: :project
297
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
298

299
300
  has_many :external_pull_requests, inverse_of: :project

301
302
303
  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

304
305
  has_one :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project

306
307
  has_many :import_failures, inverse_of: :project

308
  accepts_nested_attributes_for :variables, allow_destroy: true
309
  accepts_nested_attributes_for :project_feature, update_only: true
310
  accepts_nested_attributes_for :import_data
311
  accepts_nested_attributes_for :auto_devops, update_only: true
312
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
313
  accepts_nested_attributes_for :container_expiration_policy, update_only: true
314

315
316
317
318
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

319
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
320
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
321
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
322

323
324
325
326
327
328
329
330
331
  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
332
  delegate :name, to: :owner, allow_nil: true, prefix: true
333
  delegate :members, to: :team, prefix: true
334
  delegate :add_user, :add_users, to: :team
335
336
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
337
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
338
  delegate :root_ancestor, to: :namespace, allow_nil: true
339
  delegate :last_pipeline, to: :commit, allow_nil: true
340
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
341
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
342

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

604
605
606
607
    def reference_postfix
      '>'
    end

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

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

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

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

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

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

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

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

    super
  end

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

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

684
685
686
687
688
  def preload_protected_branches
    preloader = ActiveRecord::Associations::Preloader.new
    preloader.preload(self, protected_branches: [:push_access_levels, :merge_access_levels])
  end

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

696
697
  alias_method :ancestors, :ancestors_upto

698
699
700
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
701
      super || namespace.emails_disabled?
702
703
704
    end
  end

705
  def lfs_enabled?
706
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
707

708
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
709
710
  end

Cindy Pallares's avatar
Cindy Pallares committed
711
712
  alias_method :lfs_enabled, :lfs_enabled?

713
  def auto_devops_enabled?
714
    if auto_devops&.enabled.nil?
715
      has_auto_devops_implicitly_enabled?
716
717
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
718
    end
719
720
  end

721
  def has_auto_devops_implicitly_enabled?
722
723
724
    auto_devops_config = first_auto_devops_config

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

727
  def has_auto_devops_implicitly_disabled?
728
729
730
731
732
733
734
735
736
    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) }
737
738
  end

Jacopo's avatar
Jacopo committed
739
740
741
742
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

743
744
745
746
  def unlink_forks_upon_visibility_decrease_enabled?
    Feature.enabled?(:unlink_fork_network_upon_visibility_decrease, self)
  end

747
748
749
750
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
751
  def team
752
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
753
754
755
  end

  def repository
756
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
757
758
  end

759
  def cleanup
760
761
762
    @repository = nil
  end

763
764
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
765
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
766
    if Gitlab.config.registry.enabled
767
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
768
    end
769
770
  end

771
  def has_container_registry_tags?
772
773
774
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
775
      has_root_container_repository_tags?
776
777
  end

778
779
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
780
781
  end

782
783
784
785
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

786
787
788
789
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

Matija Čupić's avatar
Matija Čupić committed
790
  # ref can't be HEAD, can only be branch/tag name
791
  def latest_successful_build_for_ref(job_name, ref = default_branch)
Matija Čupić's avatar
Matija Čupić committed
792
793
    return unless ref

794
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
795
    return unless latest_pipeline
796

797
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
798
799
  end

800
  def latest_successful_build_for_sha(job_name, sha)
Matija Čupić's avatar
Matija Čupić committed
801
802
803
    return unless sha

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
804
    return unless latest_pipeline
805

806
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
807
808
  end

809
810
  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}"))
811
812
  end

813
814
815
816
817
818
819
820
821
  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

822
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
823
    sha = repository.merge_base(first_commit_id, second_commit_id)