project.rb 70.8 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
61
  SORTING_PREFERENCE_FIELD = :projects_sort

62
63
  cache_markdown_field :description, pipeline: :description

64
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
65
           :merge_requests_enabled?, :issues_enabled?, :pages_enabled?, :public_pages?,
66
67
           :merge_requests_access_level, :issues_access_level, :wiki_access_level,
           :snippets_access_level, :builds_access_level, :repository_access_level,
68
           to: :project_feature, allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
69

70
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
71

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

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

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

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

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

94
  before_save :ensure_runners_token
95

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

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

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

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

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

109
  before_destroy :remove_private_deploy_keys
110

111
  use_fast_destroy :build_trace_chunks
112

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

116
117
  after_validation :check_pending_delete

118
  # Storage specific hooks
119
  after_initialize :use_hashed_storage
120
  after_create :check_repository_absence!
121
  after_create :ensure_storage_path_exists
Jasper Maes's avatar
Jasper Maes committed
122
  after_save :ensure_storage_path_exists, if: :saved_change_to_namespace_id?
123

124
  acts_as_ordered_taggable
125

126
  attr_accessor :old_path_with_namespace
127
  attr_accessor :template_name
128
  attr_writer :pipeline_status
129
  attr_accessor :skip_disk_validation
130

131
132
  alias_attribute :title, :name

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

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

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

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

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

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

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

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

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

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

236
237
  has_many :internal_ids

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

Shinya Maeda's avatar
Shinya Maeda committed
242
  has_one :cluster_project, class_name: 'Clusters::Project'
243
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
244
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
245
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
246

247
248
  has_many :prometheus_metrics

249
250
251
  # 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.
252
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
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 :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
276
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
277
  has_many :variables, class_name: 'Ci::Variable'
278
279
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
280
  has_many :deployments, -> { success }
281
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
282
  has_many :project_deploy_tokens
283
  has_many :deploy_tokens, through: :project_deploy_tokens
284

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

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

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

294
295
  has_many :external_pull_requests, inverse_of: :project

296
  accepts_nested_attributes_for :variables, allow_destroy: true
297
  accepts_nested_attributes_for :project_feature, update_only: true
298
  accepts_nested_attributes_for :import_data
299
  accepts_nested_attributes_for :auto_devops, update_only: true
300
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
301

302
303
304
305
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

306
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
307
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
308

309
  delegate :name, to: :owner, allow_nil: true, prefix: true
310
  delegate :members, to: :team, prefix: true
311
  delegate :add_user, :add_users, to: :team
312
313
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
314
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
315
  delegate :root_ancestor, to: :namespace, allow_nil: true
316
  delegate :last_pipeline, to: :commit, allow_nil: true
317
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
318
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
319

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

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

356
  # Scopes
357
  scope :pending_delete, -> { where(pending_delete: true) }
358
  scope :without_deleted, -> { where(pending_delete: false) }
359

360
361
362
  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) }
363

364
  # 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
365
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
366
  scope :sorted_by_stars_desc, -> { reorder(star_count: :desc) }
367
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
368
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
369

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

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
392
393
394
395
    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)
396
397
398
399
400
401
402
403
  }

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

404
405
406
407
408
409
410
411
412
413
  # 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

414
415
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
416
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
417
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
418
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
419
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
420

421
422
423
424
425
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

426
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
427

428
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
429
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
430
431

  validates :build_timeout, allow_nil: true,
432
433
434
                            numericality: { greater_than_or_equal_to: 10.minutes,
                                            less_than: 1.month,
                                            only_integer: true,
435
                                            message: _('needs to be between 10 minutes and 1 month') }
436

437
438
439
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

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

447
448
449
450
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

451
452
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
453
454
455
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

456
457
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
458
            user.authorizations_for_projects(min_access_level: min_access_level),
459
460
461
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
462
463
464
    end
  end

465
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
466
  # they are only available to team members. This scope returns projects where
467
  # the feature is either public, enabled, or internal with permission for the user.
468
469
470
  # 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
  # that checks project authorizations first.
471
472
473
474
  #
  # 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.
475
  def self.with_feature_available_for_user(feature, user)
476
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
477
478
479
480

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
481
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
482
483
      column = ProjectFeature.quoted_access_level_column(feature)

484
      with_project_feature
485
486
487
488
489
490
      .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)
            })
491
    else
492
493
      # This has to be added to include features whose value is nil in the db
      visible << nil
494
495
      with_feature_access_level(feature, visible)
    end
496
  end
Felipe Artur's avatar
Felipe Artur committed
497

Rémy Coutable's avatar
Rémy Coutable committed
498
499
  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) }
500

501
502
  scope :excluding_project, ->(project) { where.not(id: project) }

503
504
  # 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") }
505
  scope :for_group, -> (group) { where(group: group) }
506
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
507

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
508
  class << self
509
510
511
512
513
514
515
    # 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.
516
    def search(query)
517
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
518
    end
519

520
    def search_by_title(query)
521
      non_archived.fuzzy_search(query, [:name])
522
523
    end

524
525
526
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
527

528
    def sort_by_attribute(method)
529
530
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
531
532
533
        # 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')
534
535
536
537
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
538
      when 'stars_desc'
539
        sorted_by_stars_desc
540
541
      when 'stars_asc'
        sorted_by_stars_asc
542
543
      else
        order_by(method)
544
545
      end
    end
546
547

    def reference_pattern
548
      %r{
549
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
550
551
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
552
      }x
553
    end
554

555
556
557
558
    def reference_postfix
      '>'
    end

559
560
561
562
    def reference_postfix_escaped
      '&gt;'
    end

563
    # Pattern used to extract `namespace/project>` project references from text.
564
565
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
566
567
568
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
569
        (#{reference_postfix}|#{reference_postfix_escaped})
570
571
572
      }x
    end

573
    def trending
574
575
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
576
    end
577
578
579
580
581
582

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

    def group_ids
585
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
586
    end
587
588
589
590
591
592
593
594
595
596
597

    # 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
598
599
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
600
  def initialize(attributes = nil)
601
602
603
604
605
606
607
608
609
    # 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
610
611
    attributes ||= {}

612
613
614
615
616
617
618
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

619
620
621
622
623
624
625
626
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

627
628
629
630
631
632
633
634
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

635
636
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
637
  def ancestors_upto(top = nil, hierarchy_order: nil)
638
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
639
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
640
641
  end

642
643
  alias_method :ancestors, :ancestors_upto

644
645
646
647
648
649
650
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
      Feature.enabled?(:emails_disabled, self, default_enabled: true) && (super || namespace.emails_disabled?)
    end
  end

651
  def lfs_enabled?
652
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
653

654
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
655
656
  end

Cindy Pallares's avatar
Cindy Pallares committed
657
658
  alias_method :lfs_enabled, :lfs_enabled?

659
  def auto_devops_enabled?
660
    if auto_devops&.enabled.nil?
661
      has_auto_devops_implicitly_enabled?
662
663
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
664
    end
665
666
  end

667
  def has_auto_devops_implicitly_enabled?
668
669
670
    auto_devops_config = first_auto_devops_config

    auto_devops_config[:scope] != :project && auto_devops_config[:status]
671
672
  end

673
  def has_auto_devops_implicitly_disabled?
674
675
676
677
678
679
680
681
682
    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) }
683
684
  end

Jacopo's avatar
Jacopo committed
685
686
687
688
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

689
690
691
692
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
693
  def team
694
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
695
696
697
  end

  def repository
698
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
699
700
  end

701
  def cleanup
702
703
704
    @repository = nil
  end

705
706
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
707
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
708
    if Gitlab.config.registry.enabled
709
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
710
    end
711
712
  end

713
  def has_container_registry_tags?
714
715
716
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
717
      has_root_container_repository_tags?
718
719
  end

720
721
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
722
723
  end

724
725
726
727
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

728
729
730
731
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

Matija Čupić's avatar
Matija Čupić committed
732
  # ref can't be HEAD, can only be branch/tag name
733
  def latest_successful_build_for_ref(job_name, ref = default_branch)
Matija Čupić's avatar
Matija Čupić committed
734
735
    return unless ref

736
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
737
    return unless latest_pipeline
738

739
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
740
741
  end

742
  def latest_successful_build_for_sha(job_name, sha)
Matija Čupić's avatar
Matija Čupić committed
743
744
745
    return unless sha

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
746
    return unless latest_pipeline
747

748
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
749
750
  end

751
752
  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}"))
753
754
  end

755
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
756
    sha = repository.merge_base(first_commit_id, second_commit_id)
757
    commit_by(oid: sha) if sha
758
759
  end

760
  def saved?
761
    id && persisted?
762
763
  end

764
765
766
767
768
769
770
771
  def import_status
    import_state&.status || 'none'
  end

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

772
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
773
774
    job_id =
      if forked?
775
        RepositoryForkWorker.perform_async(id)
776
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
777
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
778
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
779
780
781
      else
        RepositoryImportWorker.perform_async(self.id)
      end
782

783
784
785
786
787
    log_import_activity(job_id)

    job_id
  end

Mayra Cabrera's avatar
Mayra Cabrera committed
788
  # rubocop:disable Gitlab/RailsLogger
789
790
791
  def log_import_activity(job_id, type: :import)
    job_type = type.to_s.capitalize

792
    if job_id
793
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
794
    else
795
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
796
    end
797
  end
Mayra Cabrera's avatar
Mayra Cabrera committed
798
  # rubocop:enable Gitlab/RailsLogger
799

800
801
802
803
804
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

805
    import_state.update(last_error: nil)
806
807
808
    remove_import_data
  end

809
  # This method is overridden in EE::Project model
810
  def remove_import_data
811
    import_data&.destroy
812
813
  end

814
  def ci_config_path=(value)
815
    # Strip all leading slashes so that //foo -> foo
816
    super(value&.delete("\0"))
817
818
  end

819
  def import_url=(value)
820