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

38
  extend Gitlab::ConfigHelper
39

40
  BoardLimitExceeded = Class.new(StandardError)
41

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

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

60
61
  ACCESS_REQUEST_APPROVERS_TO_BE_NOTIFIED_LIMIT = 10

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

65
66
  cache_markdown_field :description, pipeline: :description

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

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

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

86
  before_save :ensure_runners_token
87

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

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

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

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

98
99
100
  after_create :create_container_expiration_policy,
               unless: :container_expiration_policy

101
  after_create :create_pages_metadatum,
102
               unless: :pages_metadatum
103

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

107
  before_destroy :remove_private_deploy_keys
108

109
  use_fast_destroy :build_trace_chunks
110

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

114
115
  after_validation :check_pending_delete

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

120
  acts_as_ordered_taggable
121

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

127
128
  alias_attribute :title, :name

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

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

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

176
177
178
179
180
  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
181
  has_one :fork_network, through: :fork_network_member
182
183
184
  has_one :forked_from_project, through: :fork_network_member
  has_many :forked_to_members, class_name: 'ForkNetworkMember', foreign_key: 'forked_from_project_id'
  has_many :forks, through: :forked_to_members, source: :project, inverse_of: :forked_from_project
185
  has_many :fork_network_projects, through: :fork_network, source: :projects
186

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

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

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

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

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

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

235
236
  has_many :internal_ids

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

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

246
247
  has_many :prometheus_metrics

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

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

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

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

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

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

297
298
  has_many :external_pull_requests, inverse_of: :project

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

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

304
305
  has_many :import_failures, inverse_of: :project

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

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

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

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

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

360
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
361
  validates :name, uniqueness: { scope: :namespace_id }
362
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
363
364
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
365
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
366
  validate :check_personal_projects_limit, on: :create
367
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
368
369
  validate :visibility_level_allowed_by_group, if: :should_validate_visibility_level?
  validate :visibility_level_allowed_as_fork, if: :should_validate_visibility_level?
370
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
371
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
372
373
374
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
375
  validates :variables, variable_duplicates: { scope: :environment_scope }
376
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
377
  validates :max_artifacts_size, numericality: { only_integer: true, greater_than: 0, allow_nil: true }
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
  # Sometimes queries (e.g. using CTEs) require explicit disambiguation with table name
  scope :projects_order_id_desc, -> { reorder("#{table_name}.id DESC") }
402

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

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
430
431
432
433
    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)
434
435
436
437
438
439
440
441
  }

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

442
443
444
445
446
447
448
449
450
451
  # 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

452
453
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
454
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
455
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
456
457
458
  scope :with_issues_or_mrs_available_for_user, -> (user) do
    with_issues_available_for_user(user).or(with_merge_requests_available_for_user(user))
  end
459
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
460
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
461
  scope :with_limit, -> (maximum) { limit(maximum) }
462

463
464
465
466
467
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

468
469
470
471
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

472
473
474
475
476
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

477
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
478

479
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
480
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
481
482

  validates :build_timeout, allow_nil: true,
483
                            numericality: { greater_than_or_equal_to: 10.minutes,
484
                                            less_than: MAX_BUILD_TIMEOUT,
485
                                            only_integer: true,
486
                                            message: _('needs to be between 10 minutes and 1 month') }
487

488
489
490
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

491
492
493
494
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

495
496
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
497
498
499
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

500
501
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
502
            user.authorizations_for_projects(min_access_level: min_access_level),
503
504
505
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
506
507
508
    end
  end

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

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
525
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
526
527
      column = ProjectFeature.quoted_access_level_column(feature)

528
      with_project_feature
529
530
531
532
533
534
      .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)
            })
535
    else
536
537
      # This has to be added to include features whose value is nil in the db
      visible << nil
538
539
      with_feature_access_level(feature, visible)
    end
540
  end
Felipe Artur's avatar
Felipe Artur committed
541

542
543
  # This scope returns projects where user has access to both the project and the feature.
  def self.filter_by_feature_visibility(feature, user)
544
545
546
547
548
    with_feature_available_for_user(feature, user)
      .public_or_visible_to_user(
        user,
        ProjectFeature.required_minimum_access_level_for_private_project(feature)
      )
549
550
  end

551
552
553
554
555
  def self.wrap_authorized_projects_with_cte(collection)
    cte = Gitlab::SQL::CTE.new(:authorized_projects, collection)
    Project.with(cte.to_arel).from(cte.alias_to(Project.arel_table))
  end

Rémy Coutable's avatar
Rémy Coutable committed
556
557
  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) }
558

559
560
  scope :excluding_project, ->(project) { where.not(id: project) }

561
562
  # 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") }
563
  scope :for_group, -> (group) { where(group: group) }
564
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
565

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
566
  class << self
567
568
569
570
571
572
573
    # 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.
574
    def search(query)
575
576
577
578
579
      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
580
    end
581

582
    def search_by_title(query)
583
      non_archived.fuzzy_search(query, [:name])
584
585
    end

586
587
588
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
589

590
    def sort_by_attribute(method)
591
592
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
593
594
595
        # 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')
596
597
598
599
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
600
      when 'stars_desc'
601
        sorted_by_stars_desc
602
603
      when 'stars_asc'
        sorted_by_stars_asc
604
605
      else
        order_by(method)
606
607
      end
    end
608
609

    def reference_pattern
610
      %r{
611
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
612
613
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
614
      }x
615
    end
616

617
618
619
620
    def reference_postfix
      '>'
    end

621
622
623
624
    def reference_postfix_escaped
      '&gt;'
    end

625
    # Pattern used to extract `namespace/project>` project references from text.
626
627
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
628
629
630
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
631
        (#{reference_postfix}|#{reference_postfix_escaped})
632
633
634
      }x
    end

635
    def trending
636
637
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
638
    end
639
640
641
642
643
644

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

    def group_ids
647
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
648
    end
649

650
    # Returns ids of projects with issuables available for given user
651
    #
652
653
654
    # 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)
655
656
657
658
659
      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
660
661
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
662
  def initialize(attributes = nil)
663
664
665
666
667
668
669
670
671
    # 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
672
673
    attributes ||= {}

674
675
676
677
678
679
680
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

681
682
683
684
685
686
687
688
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

689
690
691
692
693
694
695
696
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

697
698
699
700
701
702
  def autoclose_referenced_issues
    return true if super.nil?

    super
  end

703
704
705
706
707
  def preload_protected_branches
    preloader = ActiveRecord::Associations::Preloader.new
    preloader.preload(self, protected_branches: [:push_access_levels, :merge_access_levels])
  end

708
709
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
710
  def ancestors_upto(top = nil, hierarchy_order: nil)
711
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
712
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
713
714
  end

715
716
  alias_method :ancestors, :ancestors_upto

717
718
719
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
720
      super || namespace.emails_disabled?
721
722
723
    end
  end

724
  def lfs_enabled?
725
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
726

727
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
728
729
  end

Cindy Pallares's avatar
Cindy Pallares committed
730
731
  alias_method :lfs_enabled, :lfs_enabled?

732
  def auto_devops_enabled?
733
    if auto_devops&.enabled.nil?
734
      has_auto_devops_implicitly_enabled?
735
736
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
737
    end
738
739
  end

740
  def has_auto_devops_implicitly_enabled?
741
742
743
    auto_devops_config = first_auto_devops_config

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

746
  def has_auto_devops_implicitly_disabled?
747
748
749
750
751
752
753
754
755
    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) }
756
757
  end

Jacopo's avatar
Jacopo committed
758
759
760
761
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

762
  def unlink_forks_upon_visibility_decrease_enabled?
763
    Feature.enabled?(:unlink_fork_network_upon_visibility_decrease, self, default_enabled: true)
764
765
  end

766
767
768
769
  def context_commits_enabled?
    Feature.enabled?(:context_commits, default_enabled: true)
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
770
  def team
771
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
772
773
774
  end

  def repository
775
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
776
777
  end

778
  def cleanup
779
780
781
    @repository = nil
  end

782
783
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
784
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
785
    if Gitlab.config.registry.enabled
786
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
787
    end
788
789
  end

790
  def has_container_registry_tags?
791
792
793
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
794
      has_root_container_repository_tags?
795
796
  end

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

801
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
802
    return unless latest_pipeline
803

804
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
805
806
  end

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

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
811
    return unless latest_pipeline
812

813
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
814
815
  end

816
817
  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}"))
Steve Azzopardi's avatar