project.rb 75.3 KB
Newer Older
1
2
# frozen_string_literal: true

3
4
require 'carrierwave/orm/activerecord'

5
class Project < ApplicationRecord
6
  include Gitlab::ConfigHelper
7
  include Gitlab::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_pages_metadatum,
    unless: :pages_metadatum

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

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

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

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

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

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

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

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

233
234
  has_many :internal_ids

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

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

244
245
  has_many :prometheus_metrics

246
247
248
  # 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.
249
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
250

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

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

Nick Thomas's avatar
Nick Thomas committed
284
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
285
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
286

287
  has_many :project_badges, class_name: 'ProjectBadge'
288
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
289

290
  has_many :remote_mirrors, inverse_of: :project
291
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
292

293
294
  has_many :external_pull_requests, inverse_of: :project

295
296
297
  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

298
299
  has_one :pages_metadatum, class_name: 'ProjectPagesMetadatum', inverse_of: :project

300
301
  has_many :import_failures, inverse_of: :project

302
  accepts_nested_attributes_for :variables, allow_destroy: true
303
  accepts_nested_attributes_for :project_feature, update_only: true
304
  accepts_nested_attributes_for :import_data
305
  accepts_nested_attributes_for :auto_devops, update_only: true
306
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
307

308
309
310
311
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

312
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
313
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
314
  accepts_nested_attributes_for :grafana_integration, update_only: true, allow_destroy: true
315

316
317
318
319
320
321
322
323
324
  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
325
  delegate :name, to: :owner, allow_nil: true, prefix: true
326
  delegate :members, to: :team, prefix: true
327
  delegate :add_user, :add_users, to: :team
328
329
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
330
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
331
  delegate :root_ancestor, to: :namespace, allow_nil: true
332
  delegate :last_pipeline, to: :commit, allow_nil: true
333
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
334
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
335

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

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

372
  # Scopes
373
  scope :pending_delete, -> { where(pending_delete: true) }
374
  scope :without_deleted, -> { where(pending_delete: false) }
375

376
377
378
  scope :with_storage_feature, ->(feature) { where('storage_version >= :version', version: HASHED_STORAGE_FEATURES[feature]) }
  scope :without_storage_feature, ->(feature) { where('storage_version < :version OR storage_version IS NULL', version: HASHED_STORAGE_FEATURES[feature]) }
  scope :with_unmigrated_storage, -> { where('storage_version < :version OR storage_version IS NULL', version: LATEST_STORAGE_VERSION) }
379

380
  # 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
381
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
382
  scope :sorted_by_stars_desc, -> { reorder(star_count: :desc) }
383
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
384
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
385

386
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
387
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
388
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
389
  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
390
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
391
  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)) }
392
  scope :archived, -> { where(archived: true) }
393
  scope :non_archived, -> { where(archived: false) }
394
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
395
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
396
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
397
  scope :with_statistics, -> { includes(:statistics) }
398
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
399
  scope :with_container_registry, -> { where(container_registry_enabled: true) }
400
401
402
  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.
403
404
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
405
  end
406
407
408

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
409
410
411
412
    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)
413
414
415
416
417
418
419
420
  }

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

421
422
423
424
425
426
427
428
429
430
  # 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

431
432
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
433
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
434
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
435
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
436
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
437

438
439
440
441
442
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

443
444
445
446
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

447
448
449
450
451
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

452
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
453

454
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
455
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
456
457

  validates :build_timeout, allow_nil: true,
458
                            numericality: { greater_than_or_equal_to: 10.minutes,
459
                                            less_than: MAX_BUILD_TIMEOUT,
460
                                            only_integer: true,
461
                                            message: _('needs to be between 10 minutes and 1 month') }
462

463
464
465
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

466
467
468
469
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

470
471
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
472
473
474
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

475
476
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
477
            user.authorizations_for_projects(min_access_level: min_access_level),
478
479
480
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
481
482
483
    end
  end

484
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
485
  # they are only available to team members. This scope returns projects where
486
  # the feature is either public, enabled, or internal with permission for the user.
487
488
  # 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
489
  # that checks project authorizations first (e.g. `filter_by_feature_visibility`).
490
491
492
493
  #
  # 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.
494
  def self.with_feature_available_for_user(feature, user)
495
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
496
497
498
499

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
500
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
501
502
      column = ProjectFeature.quoted_access_level_column(feature)

503
      with_project_feature
504
505
506
507
508
509
      .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)
            })
510
    else
511
512
      # This has to be added to include features whose value is nil in the db
      visible << nil
513
514
      with_feature_access_level(feature, visible)
    end
515
  end
Felipe Artur's avatar
Felipe Artur committed
516

517
518
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
519
520
521
522
523
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
524
525
  end

Rémy Coutable's avatar
Rémy Coutable committed
526
527
  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) }
528

529
530
  scope :excluding_project, ->(project) { where.not(id: project) }

531
532
  # 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") }
533
  scope :for_group, -> (group) { where(group: group) }
534
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
535

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
536
  class << self
537
538
539
540
541
542
543
    # 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.
544
    def search(query)
545
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
546
    end
547

548
    def search_by_title(query)
549
      non_archived.fuzzy_search(query, [:name])
550
551
    end

552
553
554
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
555

556
    def sort_by_attribute(method)
557
558
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
559
560
561
        # 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')
562
563
564
565
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
566
      when 'stars_desc'
567
        sorted_by_stars_desc
568
569
      when 'stars_asc'
        sorted_by_stars_asc
570
571
      else
        order_by(method)
572
573
      end
    end
574
575

    def reference_pattern
576
      %r{
577
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
578
579
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
580
      }x
581
    end
582

583
584
585
586
    def reference_postfix
      '>'
    end

587
588
589
590
    def reference_postfix_escaped
      '&gt;'
    end

591
    # Pattern used to extract `namespace/project>` project references from text.
592
593
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
594
595
596
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
597
        (#{reference_postfix}|#{reference_postfix_escaped})
598
599
600
      }x
    end

601
    def trending
602
603
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
604
    end
605
606
607
608
609
610

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

    def group_ids
613
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
614
    end
615

616
    # Returns ids of projects with issuables available for given user
617
    #
618
619
620
    # 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)
621
622
623
624
625
      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
626
627
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
628
  def initialize(attributes = nil)
629
630
631
632
633
634
635
636
637
    # 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
638
639
    attributes ||= {}

640
641
642
643
644
645
646
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

647
648
649
650
651
652
653
654
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

655
656
657
658
659
660
661
662
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

663
664
665
666
667
  def preload_protected_branches
    preloader = ActiveRecord::Associations::Preloader.new
    preloader.preload(self, protected_branches: [:push_access_levels, :merge_access_levels])
  end

668
669
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
670
  def ancestors_upto(top = nil, hierarchy_order: nil)
671
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
672
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
673
674
  end

675
676
  alias_method :ancestors, :ancestors_upto

677
678
679
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
680
      super || namespace.emails_disabled?
681
682
683
    end
  end

684
  def lfs_enabled?
685
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
686

687
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
688
689
  end

Cindy Pallares's avatar
Cindy Pallares committed
690
691
  alias_method :lfs_enabled, :lfs_enabled?

692
  def auto_devops_enabled?
693
    if auto_devops&.enabled.nil?
694
      has_auto_devops_implicitly_enabled?
695
696
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
697
    end
698
699
  end

700
  def has_auto_devops_implicitly_enabled?
701
702
703
    auto_devops_config = first_auto_devops_config

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

706
  def has_auto_devops_implicitly_disabled?
707
708
709
710
711
712
713
714
715
    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) }
716
717
  end

Jacopo's avatar
Jacopo committed
718
719
720
721
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

722
723
724
725
  def unlink_forks_upon_visibility_decrease_enabled?
    Feature.enabled?(:unlink_fork_network_upon_visibility_decrease, self)
  end

726
727
728
729
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
730
  def team
731
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
732
733
734
  end

  def repository
735
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
736
737
  end

738
  def cleanup
739
740
741
    @repository = nil
  end

742
743
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
744
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
745
    if Gitlab.config.registry.enabled
746
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
747
    end
748
749
  end

750
  def has_container_registry_tags?
751
752
753
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
754
      has_root_container_repository_tags?
755
756
  end

757
758
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
759
760
  end

761
762
763
764
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

765
766
767
768
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

Matija Čupić's avatar
Matija Čupić committed
769
  # ref can't be HEAD, can only be branch/tag name
770
  def latest_successful_build_for_ref(job_name, ref = default_branch)
Matija Čupić's avatar
Matija Čupić committed
771
772
    return unless ref

773
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
774
    return unless latest_pipeline
775

776
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
777
778
  end

779
  def latest_successful_build_for_sha(job_name, sha)
Matija Čupić's avatar
Matija Čupić committed
780
781
782
    return unless sha

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
783
    return unless latest_pipeline
784

785
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
786
787
  end

788
789
  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}"))
790
791
  end

792
793
794
795
796
797
798
799
800
  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

801
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
802
    sha = repository.merge_base(first_commit_id, second_commit_id)
803
    commit_by(oid: sha) if sha
804
805
  end

806
  def saved?
807
    id && persisted?
808
809
  end

810
811
812
813
814
815
816
817
  def import_status
    import_state&.status || 'none'
  end

  def human_import_status_name
    import_state&.human_status_name || 'none'
  end

818
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
819
820
    job_id =
      if forked?
821
        RepositoryForkWorker.perform_async(id)
822
      elsif gitlab_project_import?
823
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-foss/issues/26189 is solved.
824
        RepositoryImportWorker.set(retry: false).perform_async(self.id)