This instance will be upgraded to Heptapod 0.26.0rc1 on 2021-10-26 at 14:30 UTC+2 (a few minutes of down time)

project.rb 73.2 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
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
35

36
  extend Gitlab::ConfigHelper
37

38
  BoardLimitExceeded = Class.new(StandardError)
39

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

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

58
59
  ACCESS_REQUEST_APPROVERS_TO_BE_NOTIFIED_LIMIT = 10

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

63
64
  cache_markdown_field :description, pipeline: :description

65
66
67
68
69
  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
Felipe Artur's avatar
Felipe Artur committed
70

71
  delegate :base_dir, :disk_path, to: :storage
72

73
74
75
76
77
78
  delegate :scheduled?, :started?, :in_progress?,
    :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true

  delegate :no_import?, to: :import_state, allow_nil: true

79
  default_value_for :archived, false
80
  default_value_for :resolve_outdated_diff_discussions, false
81
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
82
83
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
84
85
86
87
88
  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
89
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
90

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

93
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
94

95
  before_save :ensure_runners_token
96

Jasper Maes's avatar
Jasper Maes committed
97
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
98
99
100

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

101
  after_create :create_project_feature, unless: :project_feature
102
103
104
105
106

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

107
108
109
  after_create :create_pages_metadatum,
    unless: :pages_metadatum

Mark Chao's avatar
Mark Chao committed
110
  after_create :set_timestamps_for_create
111
  after_update :update_forks_visibility_level
112

113
  before_destroy :remove_private_deploy_keys
114

115
  use_fast_destroy :build_trace_chunks
116

117
  after_destroy -> { run_after_commit { remove_pages } }
118
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
119

120
121
  after_validation :check_pending_delete

122
  # Storage specific hooks
123
  after_initialize :use_hashed_storage
124
  after_create :check_repository_absence!
125

126
  acts_as_ordered_taggable
127

128
  attr_accessor :old_path_with_namespace
129
  attr_accessor :template_name
130
  attr_writer :pipeline_status
131
  attr_accessor :skip_disk_validation
132

133
134
  alias_attribute :title, :name

135
  # Relations
Nick Thomas's avatar
Nick Thomas committed
136
  belongs_to :pool_repository
137
  belongs_to :creator, class_name: 'User'
138
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
139
  belongs_to :namespace
140
141
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
142

143
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
144
  has_many :boards
Felipe Artur's avatar
Felipe Artur committed
145

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

181
182
183
184
185
  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
186
  has_one :fork_network, through: :fork_network_member
187
188
189
  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
190

191
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
192
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
193
  has_one :project_repository, inverse_of: :project
194
  has_one :error_tracking_setting, inverse_of: :project, class_name: 'ErrorTracking::ProjectErrorTrackingSetting'
195
  has_one :metrics_setting, inverse_of: :project, class_name: 'ProjectMetricsSetting'
196
  has_one :grafana_integration, inverse_of: :project
197

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

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

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

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

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

239
240
  has_many :internal_ids

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

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

250
251
  has_many :prometheus_metrics

252
253
254
  # Container repositories need to remove data from the container registry,
  # which is not managed by the DB. Hence we're still using dependent: :destroy
  # here.
255
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
256

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

  # 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.
275
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
276
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
277
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
278
  has_many :job_artifacts, class_name: 'Ci::JobArtifact'
279
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
280
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
281
  has_many :variables, class_name: 'Ci::Variable'
282
283
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
284
  has_many :deployments, -> { success }
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

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

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

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

298
299
  has_many :external_pull_requests, inverse_of: :project

300
301
  has_one :pages_metadatum, class_name: 'ProjectPagesMetadatum', 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
  delegate :name, to: :owner, allow_nil: true, prefix: true
317
  delegate :members, to: :team, prefix: true
318
  delegate :add_user, :add_users, to: :team
319
320
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
321
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
322
  delegate :root_ancestor, to: :namespace, allow_nil: true
323
  delegate :last_pipeline, to: :commit, allow_nil: true
324
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
325
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
326

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
327
  # Validations
328
  validates :creator, presence: true, on: :create
329
  validates :description, length: { maximum: 2000 }, allow_blank: true
330
  validates :ci_config_path,
331
    format: { without: %r{(\.{2}|\A/)},
332
              message: _('cannot include leading slash or directory traversal.') },
333
334
    length: { maximum: 255 },
    allow_blank: true
335
336
  validates :name,
    presence: true,
337
    length: { maximum: 255 },
338
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
339
              message: Gitlab::Regex.project_name_regex_message }
340
341
  validates :path,
    presence: true,
342
    project_path: true,
343
    length: { maximum: 255 }
344

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

363
  # Scopes
364
  scope :pending_delete, -> { where(pending_delete: true) }
365
  scope :without_deleted, -> { where(pending_delete: false) }
366

367
368
369
  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) }
370

371
  # 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
372
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
373
  scope :sorted_by_stars_desc, -> { reorder(star_count: :desc) }
374
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
375
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
376

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

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
399
400
401
402
    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)
403
404
405
406
407
408
409
410
  }

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

411
412
413
414
415
416
417
418
419
420
  # 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

421
422
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
423
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
424
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
425
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
426
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
427

428
429
430
431
432
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

433
434
435
436
  scope :with_pages_deployed, -> do
    joins(:pages_metadatum).merge(ProjectPagesMetadatum.deployed)
  end

437
438
439
440
441
  scope :pages_metadata_not_migrated, -> do
    left_outer_joins(:pages_metadatum)
      .where(project_pages_metadata: { project_id: nil })
  end

442
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
443

444
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
445
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
446
447

  validates :build_timeout, allow_nil: true,
448
                            numericality: { greater_than_or_equal_to: 10.minutes,
449
                                            less_than: MAX_BUILD_TIMEOUT,
450
                                            only_integer: true,
451
                                            message: _('needs to be between 10 minutes and 1 month') }
452

453
454
455
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

456
457
458
459
460
461
462
  # Returns a project, if it is not about to be removed.
  #
  # id - The ID of the project to retrieve.
  def self.find_without_deleted(id)
    without_deleted.find_by_id(id)
  end

463
464
465
466
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

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

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

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

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
497
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
498
499
      column = ProjectFeature.quoted_access_level_column(feature)

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

514
515
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)
    with_feature_available_for_user(feature, user).public_or_visible_to_user(user)
  end

Rémy Coutable's avatar
Rémy Coutable committed
519
520
  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) }
521

522
523
  scope :excluding_project, ->(project) { where.not(id: project) }

524
525
  # 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") }
526
  scope :for_group, -> (group) { where(group: group) }
527
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
528

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
529
  class << self
530
531
532
533
534
535
536
    # 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.
537
    def search(query)
538
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
539
    end
540

541
    def search_by_title(query)
542
      non_archived.fuzzy_search(query, [:name])
543
544
    end

545
546
547
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
548

549
    def sort_by_attribute(method)
550
551
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
552
553
554
        # 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')
555
556
557
558
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
559
      when 'stars_desc'
560
        sorted_by_stars_desc
561
562
      when 'stars_asc'
        sorted_by_stars_asc
563
564
      else
        order_by(method)
565
566
      end
    end
567
568

    def reference_pattern
569
      %r{
570
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
571
572
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
573
      }x
574
    end
575

576
577
578
579
    def reference_postfix
      '>'
    end

580
581
582
583
    def reference_postfix_escaped
      '&gt;'
    end

584
    # Pattern used to extract `namespace/project>` project references from text.
585
586
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
587
588
589
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
590
        (#{reference_postfix}|#{reference_postfix_escaped})
591
592
593
      }x
    end

594
    def trending
595
596
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
597
    end
598
599
600
601
602
603

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

    def group_ids
606
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
607
    end
608
609
610
611
612
613
614
615
616
617
618

    # Returns ids of projects with milestones available for given user
    #
    # Used on queries to find milestones which user can see
    # For example: Milestone.where(project_id: ids_with_milestone_available_for(user))
    def ids_with_milestone_available_for(user)
      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
619
620
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
621
  def initialize(attributes = nil)
622
623
624
625
626
627
628
629
630
    # 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
631
632
    attributes ||= {}

633
634
635
636
637
638
639
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

640
641
642
643
644
645
646
647
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

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

656
657
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
658
  def ancestors_upto(top = nil, hierarchy_order: nil)
659
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
660
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
661
662
  end

663
664
  alias_method :ancestors, :ancestors_upto

665
666
667
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
668
      super || namespace.emails_disabled?
669
670
671
    end
  end

672
  def lfs_enabled?
673
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
674

675
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
676
677
  end

Cindy Pallares's avatar
Cindy Pallares committed
678
679
  alias_method :lfs_enabled, :lfs_enabled?

680
  def auto_devops_enabled?
681
    if auto_devops&.enabled.nil?
682
      has_auto_devops_implicitly_enabled?
683
684
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
685
    end
686
687
  end

688
  def has_auto_devops_implicitly_enabled?
689
690
691
    auto_devops_config = first_auto_devops_config

    auto_devops_config[:scope] != :project && auto_devops_config[:status]
692
693
  end

694
  def has_auto_devops_implicitly_disabled?
695
696
697
698
699
700
701
702
703
    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) }
704
705
  end

Jacopo's avatar
Jacopo committed
706
707
708
709
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

710
711
712
713
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
714
  def team
715
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
716
717
718
  end

  def repository
719
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
720
721
  end

722
  def cleanup
723
724
725
    @repository = nil
  end

726
727
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
728
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
729
    if Gitlab.config.registry.enabled
730
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
731
    end
732
733
  end

734
  def has_container_registry_tags?
735
736
737
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
738
      has_root_container_repository_tags?
739
740
  end

741
742
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
743
744
  end

745
746
747
748
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

749
750
751
752
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

Matija Čupić's avatar
Matija Čupić committed
753
  # ref can't be HEAD, can only be branch/tag name
754
  def latest_successful_build_for_ref(job_name, ref = default_branch)
Matija Čupić's avatar
Matija Čupić committed
755
756
    return unless ref

757
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
758
    return unless latest_pipeline
759

760
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
761
762
  end

763
  def latest_successful_build_for_sha(job_name, sha)
Matija Čupić's avatar
Matija Čupić committed
764
765
766
    return unless sha

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
767
    return unless latest_pipeline
768

769
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
770
771
  end

772
773
  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}"))
774
775
  end

776
777
778
779
780
781
782
783
784
  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

785
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
786
    sha = repository.merge_base(first_commit_id, second_commit_id)
787
    commit_by(oid: sha) if sha
788
789
  end

790
  def saved?
791
    id && persisted?
792
793
  end

794
795
796
797
798
799
800
801
  def import_status
    import_state&.status || 'none'
  end

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

802
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
803
804
    job_id =
      if forked?
805
        RepositoryForkWorker.perform_async(id)
806
      elsif gitlab_project_import?
807
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-foss/issues/26189 is solved.
808
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
809
810
811
      else
        RepositoryImportWorker.perform_async(self.id)
      end
812

813
814
815
816
817
    log_import_activity(job_id)

    job_id
  end

Mayra Cabrera's avatar
Mayra Cabrera committed
818
  # rubocop:disable Gitlab/RailsLogger
819
820
821
  def log_import_activity(job_id, type: :import)
    job_type = type.to_s.capitalize

822
    if job_id
823
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
824
    else
825
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
826
    end
827
  end
Mayra Cabrera's avatar
Mayra Cabrera committed
828
  # rubocop:enable Gitlab/RailsLogger
829