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

3 4
require 'carrierwave/orm/activerecord'

G
gitlabhq 已提交
5
class Project < ActiveRecord::Base
6
  include Gitlab::ConfigHelper
7
  include Gitlab::ShellAdapter
8
  include Gitlab::VisibilityLevel
R
Rémy Coutable 已提交
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
F
Felipe Artur 已提交
18
  include ProjectFeaturesCompatibility
19
  include SelectForProjectAuthorization
20
  include Presentable
21
  include Routable
22
  include GroupDescendant
23
  include Gitlab::SQL::Pattern
24
  include DeploymentPlatform
25
  include ::Gitlab::Utils::StrongMemoize
26
  include ChronicDurationAttribute
27
  include FastDestroyAll::Helpers
J
Jan Provaznik 已提交
28
  include WithUploads
29
  include BatchDestroyDependentAssociations
30
  include FeatureGate
Y
Yorick Peterse 已提交
31
  include OptionallySearch
32
  include FromUnion
33
  include IgnorableColumn
34
  extend Gitlab::Cache::RequestCache
R
Robert Speicher 已提交
35

36
  extend Gitlab::ConfigHelper
37

38
  BoardLimitExceeded = Class.new(StandardError)
39

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

53 54 55 56 57
  VALID_IMPORT_PORTS = [80, 443].freeze
  VALID_IMPORT_PROTOCOLS = %w(http https git).freeze

  VALID_MIRROR_PORTS = [22, 80, 443].freeze
  VALID_MIRROR_PROTOCOLS = %w(http https ssh git).freeze
58

59 60
  ignore_column :import_status, :import_jid, :import_error

61 62
  cache_markdown_field :description, pipeline: :description

63
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
64 65
           :merge_requests_enabled?, :issues_enabled?, :pages_enabled?, :public_pages?,
           to: :project_feature, allow_nil: true
F
Felipe Artur 已提交
66

67
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
68

69 70 71 72 73 74
  delegate :scheduled?, :started?, :in_progress?,
    :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true

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

75
  default_value_for :archived, false
76
  default_value_for(:visibility_level) { Gitlab::CurrentSettings.default_project_visibility }
77
  default_value_for :resolve_outdated_diff_discussions, false
78
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
79 80
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
F
Felipe Artur 已提交
81 82 83 84 85
  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
86
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
87

88
  add_authentication_token_field :runners_token, encrypted: true, migrating: true
89

90
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
91

92
  before_save :ensure_runners_token
93

94
  after_save :update_project_statistics, if: :namespace_id_changed?
95 96 97

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

98
  after_create :create_project_feature, unless: :project_feature
99 100 101 102 103

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

M
Mark Chao 已提交
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
K
Kamil Trzcinski 已提交
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
  after_create :ensure_storage_path_exists
  after_save :ensure_storage_path_exists, if: :namespace_id_changed?
121

122
  acts_as_ordered_taggable
D
Dmitriy Zaporozhets 已提交
123

124
  attr_accessor :old_path_with_namespace
125
  attr_accessor :template_name
126
  attr_writer :pipeline_status
S
Stan Hu 已提交
127
  attr_accessor :skip_disk_validation
128

129 130
  alias_attribute :title, :name

131
  # Relations
N
Nick Thomas 已提交
132
  belongs_to :pool_repository
133
  belongs_to :creator, class_name: 'User'
134
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
135
  belongs_to :namespace
136 137
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
138

139
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
140
  has_many :boards, before_add: :validate_board_limit
F
Felipe Artur 已提交
141

142
  # Project services
143
  has_one :campfire_service
B
blackst0ne 已提交
144
  has_one :discord_service
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
  has_one :drone_ci_service
  has_one :emails_on_push_service
  has_one :pipelines_email_service
  has_one :irker_service
  has_one :pivotaltracker_service
  has_one :hipchat_service
  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
  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 :kubernetes_service, inverse_of: :project
  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
M
Matt Coleman 已提交
174
  has_one :packagist_service
175
  has_one :hangouts_chat_service
176

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

192
  # Merge Requests for target project should be removed with it
193
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
194
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
195 196 197 198 199 200 201 202 203 204
  has_many :issues
  has_many :labels, class_name: 'ProjectLabel'
  has_many :services
  has_many :events
  has_many :milestones
  has_many :notes
  has_many :snippets, class_name: 'ProjectSnippet'
  has_many :hooks, class_name: 'ProjectHook'
  has_many :protected_branches
  has_many :protected_tags
205
  has_many :repository_languages, -> { order "share DESC" }
206

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

R
Rémy Coutable 已提交
212
  alias_method :members, :project_members
213
  has_many :users, through: :project_members
214

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

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

233 234
  has_many :internal_ids

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

S
Shinya Maeda 已提交
239
  has_one :cluster_project, class_name: 'Clusters::Project'
240
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
241
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
242
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
243

244 245
  has_many :prometheus_metrics

246 247 248
  # Container repositories need to remove data from the container registry,
  # which is not managed by the DB. Hence we're still using dependent: :destroy
  # here.
249
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
K
Kamil Trzcinski 已提交
250

251
  has_many :commit_statuses
252 253 254 255 256 257 258 259
  # The relation :all_pipelines is intented to be used when we want to get the
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
  # The relation :ci_pipelines is intented to be used when we want to get only
  # those pipeline which are directly related to CI. There are
  # other pipelines, like webide ones, that we won't retrieve
  # if we use this relation.
  has_many :ci_pipelines,
260
          -> { ci_sources },
261 262
          class_name: 'Ci::Pipeline',
          inverse_of: :project
263
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
264 265 266 267 268

  # Ci::Build objects store data on the file system such as artifact files and
  # build traces. Currently there's no efficient way of removing this data in
  # bulk that doesn't involve loading the rows into memory. As a result we're
  # still using `dependent: :destroy` here.
269
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
270
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
271
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
K
Kamil Trzciński 已提交
272
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
273
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
274
  has_many :variables, class_name: 'Ci::Variable'
275 276
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
S
Shinya Maeda 已提交
277
  has_many :deployments, -> { success }
278
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
M
Mayra Cabrera 已提交
279
  has_many :project_deploy_tokens
280
  has_many :deploy_tokens, through: :project_deploy_tokens
K
Kamil Trzcinski 已提交
281

282
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
283
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
284

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

288 289
  has_many :remote_mirrors, inverse_of: :project

290
  accepts_nested_attributes_for :variables, allow_destroy: true
291
  accepts_nested_attributes_for :project_feature, update_only: true
292
  accepts_nested_attributes_for :import_data
293
  accepts_nested_attributes_for :auto_devops, update_only: true
294

295 296 297 298
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

299 300
  accepts_nested_attributes_for :error_tracking_setting, update_only: true

301
  delegate :name, to: :owner, allow_nil: true, prefix: true
302
  delegate :members, to: :team, prefix: true
303
  delegate :add_user, :add_users, to: :team
304 305
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
306
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
307 308
  delegate :group_clusters_enabled?, to: :group, allow_nil: true
  delegate :root_ancestor, to: :namespace, allow_nil: true
309

A
Andrey Kumanyaev 已提交
310
  # Validations
311
  validates :creator, presence: true, on: :create
312
  validates :description, length: { maximum: 2000 }, allow_blank: true
313
  validates :ci_config_path,
314
    format: { without: %r{(\.{2}|\A/)},
315
              message: 'cannot include leading slash or directory traversal.' },
316 317
    length: { maximum: 255 },
    allow_blank: true
318 319
  validates :name,
    presence: true,
320
    length: { maximum: 255 },
321
    format: { with: Gitlab::Regex.project_name_regex,
D
Douwe Maan 已提交
322
              message: Gitlab::Regex.project_name_regex_message }
323 324
  validates :path,
    presence: true,
325
    project_path: true,
326
    length: { maximum: 255 }
327

328
  validates :namespace, presence: true
D
Douwe Maan 已提交
329
  validates :name, uniqueness: { scope: :namespace_id }
330 331 332
  validates :import_url, public_url: { protocols: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
333
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
334
  validate :check_personal_projects_limit, on: :create
335
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
336 337
  validate :visibility_level_allowed_by_group, if: -> { changes.has_key?(:visibility_level) }
  validate :visibility_level_allowed_as_fork, if: -> { changes.has_key?(:visibility_level) }
338
  validate :check_wiki_path_conflict
R
Rob Watson 已提交
339
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
340 341 342
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
343
  validates :variables, variable_duplicates: { scope: :environment_scope }
344
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
345

346
  # Scopes
347
  scope :pending_delete, -> { where(pending_delete: true) }
348
  scope :without_deleted, -> { where(pending_delete: false) }
349

350 351 352
  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) }
353

354 355
  # last_activity_at is throttled every minute, but last_repository_updated_at is updated with every push
  scope :sorted_by_activity, -> { reorder("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC") }
356
  scope :sorted_by_stars, -> { reorder(star_count: :desc) }
357

358
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
D
Dmitriy Zaporozhets 已提交
359
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
360
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
T
Toon Claes 已提交
361
  scope :starred_by, ->(user) { joins(:users_star_projects).where('users_star_projects.user_id': user.id) }
R
Rémy Coutable 已提交
362
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
363
  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)) }
364
  scope :archived, -> { where(archived: true) }
365
  scope :non_archived, -> { where(archived: false) }
R
Rubén Dávila 已提交
366
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
R
Rémy Coutable 已提交
367
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
368
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
M
Markus Koller 已提交
369
  scope :with_statistics, -> { includes(:statistics) }
370
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
371 372 373
  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.
374 375
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
376
  end
377 378 379 380

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
    access_level_attribute = ProjectFeature.access_level_attribute(feature)
381
    with_project_feature.where(project_features: { access_level_attribute => [nil, ProjectFeature::PRIVATE, ProjectFeature::ENABLED, ProjectFeature::PUBLIC] })
382 383 384 385 386 387 388 389 390 391
  }

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

  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
392
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
393
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
394
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
395

396 397 398 399 400
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

401 402 403 404 405 406
  scope :missing_kubernetes_namespace, -> (kubernetes_namespaces) do
    subquery = kubernetes_namespaces.select('1').where('clusters_kubernetes_namespaces.project_id = projects.id')

    where('NOT EXISTS (?)', subquery)
  end

407
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
408

409 410
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
    default: 3600, error_message: 'Maximum job timeout has a value which could not be accepted'
411 412

  validates :build_timeout, allow_nil: true,
413 414 415 416
                            numericality: { greater_than_or_equal_to: 10.minutes,
                                            less_than: 1.month,
                                            only_integer: true,
                                            message: 'needs to be beetween 10 minutes and 1 month' }
417

418 419 420
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

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

Y
Yorick Peterse 已提交
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
  # Paginates a collection using a `WHERE id < ?` condition.
  #
  # before - A project ID to use for filtering out projects with an equal or
  #      greater ID. If no ID is given, all projects are included.
  #
  # limit - The maximum number of rows to include.
  def self.paginate_in_descending_order_using_id(
    before: nil,
    limit: Kaminari.config.default_per_page
  )
    relation = order_id_desc.limit(limit)
    relation = relation.where('projects.id < ?', before) if before

    relation
  end

  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

448 449
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
450 451
  def self.public_or_visible_to_user(user = nil)
    if user
452 453 454
      where('EXISTS (?) OR projects.visibility_level IN (?)',
            user.authorizations_for_projects,
            Gitlab::VisibilityLevel.levels_for_user(user))
455
    else
456
      public_to_user
457 458 459
    end
  end

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

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
      column = ProjectFeature.quoted_access_level_column(feature)

475 476
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
477 478
              visible,
              ProjectFeature::PRIVATE,
479
              user.authorizations_for_projects)
480 481 482
    else
      with_feature_access_level(feature, visible)
    end
483
  end
F
Felipe Artur 已提交
484

R
Rémy Coutable 已提交
485 486
  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) }
487

488 489
  scope :excluding_project, ->(project) { where.not(id: project) }

490 491
  # 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") }
492
  scope :for_group, -> (group) { where(group: group) }
493

A
Andrey Kumanyaev 已提交
494
  class << self
495 496 497 498 499 500 501
    # 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.
502
    def search(query)
503
      fuzzy_search(query, [:path, :name, :description])
A
Andrey Kumanyaev 已提交
504
    end
505

506
    def search_by_title(query)
507
      non_archived.fuzzy_search(query, [:name])
508 509
    end

510 511 512
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
513

514
    def sort_by_attribute(method)
515 516
      case method.to_s
      when 'storage_size_desc'
M
Markus Koller 已提交
517 518 519
        # 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')
520 521 522 523
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
524 525
      when 'stars_desc'
        sorted_by_stars
526 527
      else
        order_by(method)
528 529
      end
    end
530 531

    def reference_pattern
532
      %r{
533 534
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
535
      }x
536
    end
Y
Yorick Peterse 已提交
537

538 539 540 541
    def reference_postfix
      '>'
    end

542 543 544 545
    def reference_postfix_escaped
      '&gt;'
    end

546
    # Pattern used to extract `namespace/project>` project references from text.
547 548
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
549 550 551
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
552
        (#{reference_postfix}|#{reference_postfix_escaped})
553 554 555
      }x
    end

Y
Yorick Peterse 已提交
556
    def trending
557 558
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
Y
Yorick Peterse 已提交
559
    end
560 561 562 563 564 565

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

    def group_ids
568
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
569
    end
570 571
  end

572 573
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
574
  def ancestors_upto(top = nil, hierarchy_order: nil)
575
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
576
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
577 578
  end

579 580
  alias_method :ancestors, :ancestors_upto

581
  def lfs_enabled?
582
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
P
Patricio Cano 已提交
583

584
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
585 586
  end

C
Cindy Pallares 已提交
587 588
  alias_method :lfs_enabled, :lfs_enabled?

589
  def auto_devops_enabled?
590
    if auto_devops&.enabled.nil?
591
      has_auto_devops_implicitly_enabled?
592 593
    else
      auto_devops.enabled?
Z
Zeger-Jan van de Weg 已提交
594
    end
595 596
  end

597
  def has_auto_devops_implicitly_enabled?
598 599
    auto_devops&.enabled.nil? &&
      (Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
600 601
  end

602
  def has_auto_devops_implicitly_disabled?
603
    auto_devops&.enabled.nil? && !(Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
604 605
  end

606 607 608 609
  def empty_repo?
    repository.empty?
  end

D
Dmitriy Zaporozhets 已提交
610
  def team
611
    @team ||= ProjectTeam.new(self)
D
Dmitriy Zaporozhets 已提交
612 613 614
  end

  def repository
615
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
616 617
  end

618
  def cleanup
619 620 621
    @repository = nil
  end

622 623
  alias_method :reload_repository!, :cleanup

A
Andre Guedes 已提交
624
  def container_registry_url
K
Kamil Trzcinski 已提交
625
    if Gitlab.config.registry.enabled
626
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
627
    end
628 629
  end

630
  def has_container_registry_tags?
631 632 633
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
634
      has_root_container_repository_tags?
635 636
  end

637 638
  def commit(ref = 'HEAD')
    repository.commit(ref)
D
Dmitriy Zaporozhets 已提交
639 640
  end

641 642 643 644
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

645 646 647 648
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

649
  # ref can't be HEAD, can only be branch/tag name or SHA
650
  def latest_successful_build_for(job_name, ref = default_branch)
651
    latest_pipeline = ci_pipelines.latest_successful_for(ref)
652
    return unless latest_pipeline
653

654
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
655 656
  end

657
  def latest_successful_build_for!(job_name, ref = default_branch)
658 659 660
    latest_successful_build_for(job_name, ref) || raise(ActiveRecord::RecordNotFound.new("Couldn't find job #{job_name}"))
  end

661
  def merge_base_commit(first_commit_id, second_commit_id)
D
Douwe Maan 已提交
662
    sha = repository.merge_base(first_commit_id, second_commit_id)
663
    commit_by(oid: sha) if sha
664 665
  end

666
  def saved?
667
    id && persisted?
668 669
  end

670 671 672 673 674 675 676 677
  def import_status
    import_state&.status || 'none'
  end

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

678
  def add_import_job
D
Douwe Maan 已提交
679 680
    job_id =
      if forked?
681
        RepositoryForkWorker.perform_async(id)
682
      elsif gitlab_project_import?
J
James Lopez 已提交
683
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
684
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
D
Douwe Maan 已提交
685 686 687
      else
        RepositoryImportWorker.perform_async(self.id)
      end
688

689 690 691 692 693 694 695 696
    log_import_activity(job_id)

    job_id
  end

  def log_import_activity(job_id, type: :import)
    job_type = type.to_s.capitalize

697
    if job_id
698
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
699
    else
700
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
701
    end
702 703
  end

704 705 706 707 708
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

709
    import_state.update(last_error: nil)
710 711 712
    remove_import_data
  end

G
George Tsiolis 已提交
713
  # This method is overridden in EE::Project model
714
  def remove_import_data
715
    import_data&.destroy
716 717
  end

718
  def ci_config_path=(value)
719
    # Strip all leading slashes so that //foo -> foo
720
    super(value&.delete("\0"))
721 722
  end

J
James Lopez 已提交
723
  def import_url=(value)
J
James Lopez 已提交
724 725
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

726
    import_url = Gitlab::UrlSanitizer.new(value)
J
James Lopez 已提交
727
    super(import_url.sanitized_url)
728
    create_or_update_import_data(credentials: import_url.credentials)
J
James Lopez 已提交
729 730 731
  end

  def import_url
J
James Lopez 已提交
732
    if import_data && super.present?
733
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
J
James Lopez 已提交
734 735 736
      import_url.full_url
    else
      super
J
James Lopez 已提交
737
    end
738 739
  rescue
    super
J
James Lopez 已提交
740
  end
J
James Lopez 已提交
741

J
James Lopez 已提交
742
  def valid_import_url?
743
    valid?(:import_url) || errors.messages[:import_url].nil?
J
James Lopez 已提交
744 745
  end

746
  def create_or_update_import_data(data: nil, credentials: nil)
747
    return if data.nil? && credentials.nil?
748

J
James Lopez 已提交
749
    project_import_data = import_data || build_import_data
750

751 752
    project_import_data.merge_data(data.to_h)
    project_import_data.merge_credentials(credentials.to_h)
753 754

    project_import_data
J
James Lopez 已提交
755
  end
J
James Lopez 已提交
756

757
  def import?
J
James Lopez 已提交
758
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
759 760 761
  end

  def external_import?
762 763 764
    import_url.present?
  end

D
Douwe Maan 已提交
765
  def safe_import_url
766
    Gitlab::UrlSanitizer.new(import_url).masked_url
D
Douwe Maan 已提交
767 768
  end

769 770 771 772
  def bare_repository_import?
    import_type == 'bare_repository'
  end

773 774 775 776
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

R
Rémy Coutable 已提交
777 778 779 780
  def gitea_import?
    import_type == 'gitea'
  end

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
  def has_remote_mirror?
    remote_mirror_available? && remote_mirrors.enabled.exists?
  end

  def updating_remote_mirror?
    remote_mirrors.enabled.started.exists?
  end

  def update_remote_mirrors
    return unless remote_mirror_available?

    remote_mirrors.enabled.each(&:sync)
  end

  def mark_stuck_remote_mirrors_as_failed!
    remote_mirrors.stuck.update_all(
      update_status: :failed,
      last_error: 'The remote mirror took to long to complete.',
      last_update_at: Time.now
    )
  end

  def mark_remote_mirrors_for_removal
    remote_mirrors.each(&:mark_for_delete_if_blank_url)
  end

  def remote_mirror_available?
    remote_mirror_available_overridden ||
      ::Gitlab::CurrentSettings.mirror_available
  end

812 813 814 815 816 817
  def check_personal_projects_limit
    # Since this method is called as validation hook, `creator` might not be
    # present. Since the validation for that will fail, we can just return
    # early.
    return if !creator || creator.can_create_project? ||
        namespace.kind == 'group'
818

819 820 821 822
    limit = creator.projects_limit
    error =
      if limit.zero?
        _('Personal project creation is not allowed. Please contact your administrator with questions')
823
      else
824
        _('Your project limit is %{limit} projects! Please contact your administrator to increase it')
825
      end
826 827

    self.errors.add(:limit_reached, error % { limit: limit })
G
gitlabhq 已提交
828 829
  end

D
Douwe Maan 已提交
830 831 832 833 834 835 836 837 838 839 840 841 842
  def visibility_level_allowed_by_group
    return if visibility_level_allowed_by_group?

    level_name = Gitlab::VisibilityLevel.level_name(self.visibility_level).downcase
    group_level_name = Gitlab::VisibilityLevel.level_name(self.group.visibility_level).downcase
    self.errors.add(:visibility_level, "#{level_name} is not allowed in a #{group_level_name} group.")
  end

  def visibility_level_allowed_as_fork
    return if visibility_level_allowed_as_fork?

    level_name = Gitlab::VisibilityLevel.level_name(self.visibility_level).downcase
    self.errors.add(:visibility_level, "#{level_name} is not allowed since the fork source project has lower visibility.")
843 844
  end

845 846 847 848 849 850 851 852 853 854
  def check_wiki_path_conflict
    return if path.blank?

    path_to_check = path.ends_with?('.wiki') ? path.chomp('.wiki') : "#{path}.wiki"

    if Project.where(namespace_id: namespace_id, path: path_to_check).exists?
      errors.add(:name, 'has already been taken')
    end
  end

R
Rob Watson 已提交
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
  def pages_https_only
    return false unless Gitlab.config.pages.external_https

    super
  end

  def pages_https_only?
    return false unless Gitlab.config.pages.external_https

    super
  end

  def validate_pages_https_only
    return unless pages_https_only?

    unless pages_domains.all?(&:https?)
      errors.add(:pages_https_only, "cannot be enabled unless all domains have TLS certificates")
    end
  end

875
  def to_param
876 877 878 879 880
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
881 882
  end

883 884 885 886
  def to_reference_with_postfix
    "#{to_reference(full: true)}#{self.class.reference_postfix}"
  end

887
  # `from` argument can be a Namespace or Project.
888 889
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
890
      full_path
891 892 893
    elsif cross_project_reference?(from)
      path
    end
894 895
  end

J
Jarka Kadlecova 已提交
896 897
  def to_human_reference(from = nil)
    if cross_namespace_reference?(from)
898
      name_with_namespace
J
Jarka Kadlecova 已提交
899
    elsif cross_project_reference?(from)
900 901
      name
    end
902 903
  end

904
  def web_url
905
    Gitlab::Routing.url_helpers.project_url(self)
906 907
  end

I
Imre Farkas 已提交
908
  def readme_url
909 910 911
    readme_path = repository.readme_path
    if readme_path
      Gitlab::Routing.url_helpers.project_blob_url(self, File.join(default_branch, readme_path))
I
Imre Farkas 已提交
912 913 914
    end
  end

J
Jan Provaznik 已提交
915
  def new_issuable_address(author, address_type)
916
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author
917

918 919 920
    # check since this can come from a request parameter
    return unless %w(issue merge_request).include?(address_type)

921 922
    author.ensure_incoming_email_token!

923 924 925 926 927
    suffix = address_type.dasherize

    # example: incoming+h5bp-html5-boilerplate-8-1234567890abcdef123456789-issue@localhost.com
    # example: incoming+h5bp-html5-boilerplate-8-1234567890abcdef123456789-merge-request@localhost.com
    Gitlab::IncomingEmail.reply_address("#{full_path_slug}-#{project_id}-#{author.incoming_email_token}-#{suffix}")
928 929
  end

930
  def build_commit_note(commit)
931
    notes.new(commit_id: commit.id, noteable_type: 'Commit')
G
gitlabhq 已提交
932
  end
N
Nihad Abbasov 已提交
933

N
Nihad Abbasov 已提交
934
  def last_activity
935
    last_event
G
gitlabhq 已提交
936 937 938
  end

  def last_activity_date
939
    [last_activity_at, last_repository_updated_at, updated_at].compact.max
D
Dmitriy Zaporozhets 已提交
940
  end
941

D
Dmitriy Zaporozhets 已提交
942 943 944
  def project_id
    self.id
  end
R
randx 已提交
945

946
  def get_issue(issue_id, current_user)
947 948 949 950 951
    issue = IssuesFinder.new(current_user, project_id: id).find_by(iid: issue_id) if issues_enabled?

    if issue
      issue
    elsif external_issue_tracker
R
Robert Speicher 已提交
952
      ExternalIssue.new(issue_id, self)
953 954 955
    end
  end

R
Robert Speicher 已提交
956
  def issue_exists?(issue_id)
957
    get_issue(issue_id)
R
Robert Speicher 已提交
958 959
  end

960
  def default_issue_tracker
961
    gitlab_issue_tracker_service || create_gitlab_issue_tracker_service
962 963 964 965 966 967 968 969 970 971
  end

  def issues_tracker
    if external_issue_tracker
      external_issue_tracker
    else
      default_issue_tracker
    end
  end

972
  def external_issue_reference_pattern
973
    external_issue_tracker.class.reference_pattern(only_long: issues_enabled?)
974 975
  end

976
  def default_issues_tracker?
977
    !external_issue_tracker
978 979 980
  end

  def external_issue_tracker
981 982 983 984 985 986 987 988 989 990 991 992 993 994
    if has_external_issue_tracker.nil? # To populate existing projects
      cache_has_external_issue_tracker
    end

    if has_external_issue_tracker?
      return @external_issue_tracker if defined?(@external_issue_tracker)

      @external_issue_tracker = services.external_issue_trackers.first
    else
      nil
    end
  end

  def cache_has_external_issue_tracker
T
Toon Claes 已提交
995
    update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) if Gitlab::Database.read_write?
996 997
  end

998 999 1000 1001
  def has_wiki?
    wiki_enabled? || has_external_wiki?
  end

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  def external_wiki
    if has_external_wiki.nil?
      cache_has_external_wiki # Populate
    end

    if has_external_wiki
      @external_wiki ||= services.external_wikis.first
    else
      nil
    end
  end

  def cache_has_external_wiki
T
Toon Claes 已提交
1015
    update_column(:has_external_wiki, services.external_wikis.any?) if Gitlab::Database.read_write?
1016 1017
  end

1018 1019 1020
  def find_or_initialize_services(exceptions: [])
    available_services_names = Service.available_services_names - exceptions

1021
    available_services = available_services_names.map do |service_name|
1022
      find_or_initialize_service(service_name)
1023
    end
1024

1025
    available_services.compact
1026 1027 1028 1029
  end

  def disabled_services
    []
1030 1031
  end

1032
  def find_or_initialize_service(name)
1033 1034
    return if disabled_services.include?(name)

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
    service = find_service(services, name)
    return service if service

    # We should check if template for the service exists
    template = find_service(services_templates, name)

    if template
      Service.build_from_template(id, template)
    else
      # If no template, we should create an instance. Ex `build_gitlab_ci_service`
      public_send("build_#{name}_service") # rubocop:disable GitlabSecurity/PublicSend
    end
1047 1048
  end

1049
  # rubocop: disable CodeReuse/ServiceClass
V
Valery Sizov 已提交
1050 1051
  def create_labels
    Label.templates.each do |label|
1052
      params = label.attributes.except('id', 'template', 'created_at', 'updated_at')
1053
      Labels::FindOrCreateService.new(nil, self, params).execute(skip_authorization: true)
V
Valery Sizov 已提交
1054 1055
    end
  end
1056
  # rubocop: enable CodeReuse/ServiceClass
V
Valery Sizov 已提交
1057

M
Marin Jankovski 已提交
1058 1059 1060
  def find_service(list, name)
    list.find { |service| service.to_param == name }
  end
D
Dmitriy Zaporozhets 已提交
1061

1062
  def ci_services
Y
Yorick Peterse 已提交
1063
    services.where(category: :ci)
1064 1065 1066
  end

  def ci_service
1067
    @ci_service ||= ci_services.reorder(nil).find_by(active: true)
1068 1069
  end

1070 1071 1072 1073 1074
  def monitoring_services
    services.where(category: :monitoring)
  end

  def monitoring_service
1075
    @monitoring_service ||= monitoring_services.reorder(nil).find_by(active: true)
1076 1077
  end

D
Drew Blessing 已提交
1078 1079 1080 1081
  def jira_tracker?
    issues_tracker.to_param == 'jira'
  end

1082
  def avatar_in_git
1083
    repository.avatar
1084 1085
  end

1086
  def avatar_url(**args)
1087
    Gitlab::Routing.url_helpers.project_avatar_url(self) if avatar_in_git
S
sue445 已提交
1088 1089
  end

1090 1091 1092 1093 1094
  # For compatibility with old code
  def code
    path
  end

T
Thong Kuah 已提交
1095 1096 1097 1098 1099 1100
  def all_clusters
    group_clusters = Clusters::Cluster.joins(:groups).where(cluster_groups: { group_id: ancestors_upto } )

    Clusters::Cluster.from_union([clusters, group_clusters])
  end

1101
  def items_for(entity)
D
Dmitriy Zaporozhets 已提交
1102 1103 1104 1105 1106 1107 1108
    case entity
    when 'issue' then
      issues
    when 'merge_request' then
      merge_requests
    end
  end
1109

1110
  # rubocop: disable CodeReuse/ServiceClass
1111
  def send_move_instructions(old_path_with_namespace)
1112 1113
    # New project path needs to be committed to the DB or notification will
    # retrieve stale information
1114 1115 1116
    run_after_commit do
      NotificationService.new.project_was_moved(self, old_path_with_namespace)
    end
1117
  end
1118
  # rubocop: enable CodeReuse/ServiceClass
1119 1120

  def owner
1121 1122
    if group
      group
1123
    else
1124
      namespace.try(:owner)
1125 1126
    end
  end
D
Dmitriy Zaporozhets 已提交
1127

1128
  # rubocop: disable CodeReuse/ServiceClass
1129
  def execute_hooks(data, hooks_scope = :push_hooks)
1130
    run_after_commit_or_now do
1131
      hooks.hooks_for(hooks_scope).select_active(hooks_scope, data).each do |hook|
1132 1133
        hook.async_execute(data, hooks_scope.to_s)
      end
1134 1135
      SystemHooksService.new.execute_hooks(data, hooks_scope)
    end
D
Dmitriy Zaporozhets 已提交
1136
  end
1137
  # rubocop: enable CodeReuse/ServiceClass
D
Dmitriy Zaporozhets 已提交
1138

1139 1140
  def execute_services(data, hooks_scope = :push_hooks)
    # Call only service hooks that are active for this scope
1141 1142 1143 1144
    run_after_commit_or_now do
      services.public_send(hooks_scope).each do |service| # rubocop:disable GitlabSecurity/PublicSend
        service.async_execute(data)
      end
D
Dmitriy Zaporozhets 已提交
1145 1146 1147 1148
    end
  end

  def valid_repo?
1149
    repository.exists?
D
Dmitriy Zaporozhets 已提交
1150
  rescue
1151
    errors.add(:path, 'Invalid repository path')
D
Dmitriy Zaporozhets 已提交
1152 1153 1154 1155
    false
  end

  def url_to_repo
1156
    gitlab_shell.url_to_repo(full_path)
D
Dmitriy Zaporozhets 已提交
1157 1158 1159
  end

  def repo_exists?
1160 1161 1162 1163 1164 1165 1166
    strong_memoize(:repo_exists) do
      begin
        repository.exists?
      rescue
        false
      end
    end
D
Dmitriy Zaporozhets 已提交
1167 1168 1169
  end

  def root_ref?(branch)
D
Dmitriy Zaporozhets 已提交
1170
    repository.root_ref == branch
D
Dmitriy Zaporozhets 已提交
1171 1172 1173 1174 1175 1176
  end

  def ssh_url_to_repo
    url_to_repo
  end

1177 1178
  def http_url_to_repo
    "#{web_url}.git"
D
Dmitriy Zaporozhets 已提交
1179 1180
  end

1181 1182 1183 1184 1185
  # Is overriden in EE
  def lfs_http_url_to_repo(_)
    http_url_to_repo
  end

1186
  def forked?
1187
    fork_network && fork_network.root_project != self
1188
  end
D
Dmitriy Zaporozhets 已提交
1189

1190
  def fork_source
1191 1192
    return nil unless forked?

1193 1194 1195
    forked_from_project || fork_network&.root_project
  end

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
  def lfs_storage_project
    @lfs_storage_project ||= begin
      result = self

      # TODO: Make this go to the fork_network root immeadiatly
      # dependant on the discussion in: https://gitlab.com/gitlab-org/gitlab-ce/issues/39769
      result = result.fork_source while result&.forked?

      result || self
    end
  end

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
  # This will return all `lfs_objects` that are accessible to the project.
  # So this might be `self.lfs_objects` if the project is not part of a fork
  # network, or it is the base of the fork network.
  #
  # TODO: refactor this to get the correct lfs objects when implementing
  #       https://gitlab.com/gitlab-org/gitlab-ce/issues/39769
  def all_lfs_objects
    lfs_storage_project.lfs_objects
  end

1218 1219 1220 1221
  def personal?
    !group
  end

1222 1223 1224 1225 1226 1227
  # Expires various caches before a project is renamed.
  def expire_caches_before_rename(old_path)
    repo = Repository.new(old_path, self)
    wiki = Repository.new("#{old_path}.wiki", self)

    if repo.exists?
1228
      repo.before_delete
1229 1230 1231
    end

    if wiki.exists?
1232
      wiki.before_delete
1233 1234 1235
    end
  end

1236
  # Check if repository already exists on disk
S
Stan Hu 已提交
1237 1238
  def check_repository_path_availability
    return true if skip_disk_validation
1239
    return false unless repository_storage
1240

1241 1242 1243
    # Check if repository with same path already exists on disk we can
    # skip this for the hashed storage because the path does not change
    if legacy_storage? && repository_with_same_path_already_exists?
1244 1245 1246 1247 1248
      errors.add(:base, 'There is already a repository with that name on disk')
      return false
    end

    true
1249 1250
  rescue GRPC::Internal # if the path is too long
    false
1251 1252
  end

1253
  def track_project_repository
1254 1255
    repository = project_repository || build_project_repository
    repository.update!(shard_name: repository_storage, disk_path: disk_path)
1256 1257
  end

1258 1259 1260 1261
  def create_repository(force: false)
    # Forked import is handled asynchronously
    return if forked? && !force

1262
    if gitlab_shell.create_repository(repository_storage, disk_path)
1263 1264 1265 1266 1267 1268 1269 1270
      repository.after_create
      true
    else
      errors.add(:base, 'Failed to create repository via gitlab-shell')
      false
    end
  end

1271 1272
  def hook_attrs(backward: true)
    attrs = {
J
Jacopo 已提交
1273
      id: id,
K
Kirill Zaitsev 已提交
1274
      name: name,
1275
      description: description,
K
Kirilll Zaitsev 已提交
1276
      web_url: web_url,
1277
      avatar_url: avatar_url(only_path: false),
1278 1279
      git_ssh_url: ssh_url_to_repo,
      git_http_url: http_url_to_repo,
K
Kirill Zaitsev 已提交
1280
      namespace: namespace.name,
1281
      visibility_level: visibility_level,
1282
      path_with_namespace: full_path,
1283
      default_branch: default_branch,
1284
      ci_config_path: ci_config_path
K
Kirill Zaitsev 已提交
1285
    }
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297

    # Backward compatibility
    if backward
      attrs.merge!({
                    homepage: web_url,
                    url: url_to_repo,
                    ssh_url: ssh_url_to_repo,
                    http_url: http_url_to_repo
                  })
    end

    attrs
K
Kirill Zaitsev 已提交
1298 1299
  end

1300
  def project_member(user)
1301 1302 1303 1304 1305
    if project_members.loaded?
      project_members.find { |member| member.user_id == user.id }
    else
      project_members.find_by(user_id: user)
    end
1306
  end
1307

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
  # Filters `users` to return only authorized users of the project
  def members_among(users)
    if users.is_a?(ActiveRecord::Relation) && !users.loaded?
      authorized_users.merge(users)
    else
      return [] if users.empty?

      user_ids = authorized_users.where(users: { id: users.map(&:id) }).pluck(:id)
      users.select { |user| user_ids.include?(user.id) }
    end
  end

1320 1321 1322
  def default_branch
    @default_branch ||= repository.root_ref if repository.exists?
  end
1323 1324 1325 1326 1327

  def reload_default_branch
    @default_branch = nil
    default_branch
  end
1328

1329
  def visibility_level_field
1330
    :visibility_level
1331
  end
1332

1333
  def change_head(branch)
1334 1335
    if repository.branch_exists?(branch)
      repository.before_change_head
1336
      repository.raw_repository.write_ref('HEAD', "refs/heads/#{branch}")
1337 1338 1339 1340 1341 1342 1343
      repository.copy_gitattributes(branch)
      repository.after_change_head
      reload_default_branch
    else
      errors.add(:base, "Could not change HEAD: branch '#{branch}' does not exist")
      false
    end
1344
  end
1345

1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
  def forked_from?(other_project)
    forked? && forked_from_project == other_project
  end

  def in_fork_network_of?(other_project)
    # TODO: Remove this in a next release when all fork_networks are populated
    # This makes sure all MergeRequests remain valid while the projects don't
    # have a fork_network yet.
    return true if forked_from?(other_project)

    return false if fork_network.nil? || other_project.fork_network.nil?

    fork_network == other_project.fork_network
1359
  end
1360

1361 1362 1363
  def origin_merge_requests
    merge_requests.where(source_project_id: self.id)
  end
1364

1365
  def ensure_repository
1366
    create_repository(force: true) unless repository_exists?
1367 1368
  end

1369 1370 1371 1372
  def repository_exists?
    !!repository.exists?
  end

1373 1374 1375 1376
  def wiki_repository_exists?
    wiki.repository_exists?
  end

1377
  # update visibility_level of forks
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
  def update_forks_visibility_level
    return unless visibility_level < visibility_level_was

    forks.each do |forked_project|
      if forked_project.visibility_level > visibility_level
        forked_project.visibility_level = visibility_level
        forked_project.save!
      end
    end
  end

1389 1390 1391
  def create_wiki
    ProjectWiki.new(self, self.owner).wiki
    true
G
Guilherme Garnier 已提交
1392
  rescue ProjectWiki::CouldNotCreateWikiError
1393
    errors.add(:base, 'Failed create wiki')
1394 1395
    false
  end
1396

1397 1398 1399 1400
  def wiki
    @wiki ||= ProjectWiki.new(self, self.owner)
  end

D
Drew Blessing 已提交
1401 1402 1403 1404
  def jira_tracker_active?
    jira_tracker? && jira_service.active
  end

1405
  def allowed_to_share_with_group?
1406
    !namespace.share_with_group_lock
1407 1408
  end

1409 1410 1411
  def pipeline_for(ref, sha = nil)
    sha ||= commit(ref).try(:sha)

1412
    return unless sha
1413

1414
    ci_pipelines.order(id: :desc).find_by(sha: sha, ref: ref)
K
Kamil Trzcinski 已提交
1415 1416
  end

1417 1418 1419 1420 1421 1422
  def latest_successful_pipeline_for_default_branch
    if defined?(@latest_successful_pipeline_for_default_branch)
      return @latest_successful_pipeline_for_default_branch
    end

    @latest_successful_pipeline_for_default_branch =
1423
      ci_pipelines.latest_successful_for(default_branch)
1424 1425 1426 1427
  end

  def latest_successful_pipeline_for(ref = nil)
    if ref && ref != default_branch
1428
      ci_pipelines.latest_successful_for(ref)
1429 1430 1431 1432 1433
    else
      latest_successful_pipeline_for_default_branch
    end
  end

1434
  def enable_ci
F
Felipe Artur 已提交
1435
    project_feature.update_attribute(:builds_access_level, ProjectFeature::ENABLED)
1436
  end
M
Marin Jankovski 已提交
1437

1438 1439 1440 1441 1442
  def shared_runners_available?
    shared_runners_enabled?
  end

  def shared_runners
1443
    @shared_runners ||= shared_runners_available? ? Ci::Runner.instance_type : Ci::Runner.none
1444 1445
  end

1446
  def group_runners
1447
    @group_runners ||= group_runners_enabled? ? Ci::Runner.belonging_to_parent_group_of_project(self.id) : Ci::Runner.none
1448 1449
  end

1450
  def all_runners
1451
    Ci::Runner.from_union([runners, group_runners, shared_runners])
1452
  end
K
Kamil Trzcinski 已提交
1453

1454 1455 1456 1457 1458
  def active_runners
    strong_memoize(:active_runners) do
      all_runners.active
    end
  end
1459

1460 1461
  def any_runners?(&block)
    active_runners.any?(&block)
K
Kamil Trzcinski 已提交
1462 1463
  end

1464
  def valid_runners_token?(token)
J
James Lopez 已提交
1465
    self.runners_token && ActiveSupport::SecurityUtils.variable_size_secure_compare(token, self.runners_token)
K
Kamil Trzcinski 已提交
1466 1467
  end

1468
  # rubocop: disable CodeReuse/ServiceClass
F
Felipe Artur 已提交
1469 1470
  def open_issues_count(current_user = nil)
    Projects::OpenIssuesCountService.new(self, current_user).count
1471
  end
1472
  # rubocop: enable CodeReuse/ServiceClass
1473

1474
  # rubocop: disable CodeReuse/ServiceClass
1475 1476
  def open_merge_requests_count
    Projects::OpenMergeRequestsCountService.new(self).count
S
Stan Hu 已提交
1477
  end
1478
  # rubocop: enable CodeReuse/ServiceClass
1479

D
Douwe Maan 已提交
1480
  def visibility_level_allowed_as_fork?(level = self.visibility_level)
D
Douwe Maan 已提交
1481
    return true unless forked?
D
Douwe Maan 已提交
1482

1483
    original_project = fork_source
D
Douwe Maan 已提交
1484 1485 1486
    return true unless original_project

    level <= original_project.visibility_level
D
Douwe Maan 已提交
1487
  end
1488

D
Douwe Maan 已提交
1489 1490
  def visibility_level_allowed_by_group?(level = self.visibility_level)
    return true unless group
1491

D
Douwe Maan 已提交
1492
    level <= group.visibility_level
M
Marin Jankovski 已提交
1493
  end
1494

D
Douwe Maan 已提交
1495 1496
  def visibility_level_allowed?(level = self.visibility_level)
    visibility_level_allowed_as_fork?(level) && visibility_level_allowed_by_group?(level)
F
Felipe Artur 已提交
1497 1498
  end

1499 1500 1501
  def runners_token
    ensure_runners_token!
  end
V
Valery Sizov 已提交
1502

1503 1504 1505
  def pages_deployed?
    Dir.exist?(public_pages_path)
  end
1506

1507
  def pages_group_url
K
Kamil Trzcinski 已提交
1508
    # The host in URL always needs to be downcased
1509 1510
    Gitlab.config.pages.url.sub(%r{^https?://}) do |prefix|
      "#{prefix}#{pages_subdomain}."
K
Kamil Trzcinski 已提交
1511
    end.downcase
1512 1513 1514 1515 1516
  end

  def pages_url
    url = pages_group_url
    url_path = full_path.partition('/').last
1517

K
Kamil Trzcinski 已提交
1518
    # If the project path is the same as host, we serve it as group page
1519
    return url if url == "#{Settings.pages.protocol}://#{url_path}"
1520 1521 1522

    "#{url}/#{url_path}"
  end
1523

1524 1525
  def pages_subdomain
    full_path.partition('/').first
1526
  end
K
Kamil Trzcinski 已提交
1527 1528

  def pages_path
1529 1530
    # TODO: when we migrate Pages to work with new storage types, change here to use disk_path
    File.join(Settings.pages.path, full_path)
K
Kamil Trzcinski 已提交
1531 1532 1533 1534 1535 1536
  end

  def public_pages_path
    File.join(pages_path, 'public')
  end

1537
  def pages_available?
1538
    Gitlab.config.pages.enabled
1539 1540
  end

1541
  def remove_private_deploy_keys
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
    exclude_keys_linked_to_other_projects = <<-SQL
      NOT EXISTS (
        SELECT 1
        FROM deploy_keys_projects dkp2
        WHERE dkp2.deploy_key_id = deploy_keys_projects.deploy_key_id
        AND dkp2.project_id != deploy_keys_projects.project_id
      )
    SQL

    deploy_keys.where(public: false)
               .where(exclude_keys_linked_to_other_projects)
               .delete_all
1554 1555
  end

1556
  # TODO: what to do here when not using Legacy Storage? Do we still need to rename and delay removal?
1557
  # rubocop: disable CodeReuse/ServiceClass
K
Kamil Trzcinski 已提交
1558
  def remove_pages
1559 1560 1561
    # Projects with a missing namespace cannot have their pages removed
    return unless namespace

1562 1563
    ::Projects::UpdatePagesConfigurationService.new(self).execute

1564 1565 1566
    # 1. We rename pages to temporary directory
    # 2. We wait 5 minutes, due to NFS caching
    # 3. We asynchronously remove pages with force
K
Kamil Trzcinski 已提交
1567
    temp_path = "#{path}.#{SecureRandom.hex}.deleted"
K
Kamil Trzcinski 已提交
1568

1569 1570
    if Gitlab::PagesTransfer.new.rename_project(path, temp_path, namespace.full_path)
      PagesWorker.perform_in(5.minutes, :remove, namespace.full_path, temp_path)
K
Kamil Trzcinski 已提交
1571
    end
K
Kamil Trzcinski 已提交
1572
  end
1573
  # rubocop: enable CodeReuse/ServiceClass
K
Kamil Trzcinski 已提交
1574

1575 1576 1577 1578
  def write_repository_config(gl_full_path: full_path)
    # We'd need to keep track of project full path otherwise directory tree
    # created with hashed storage enabled cannot be usefully imported using
    # the import rake task.
1579
    repository.raw_repository.write_config(full_path: gl_full_path)
1580
  rescue Gitlab::Git::Repository::NoRepository => e
1581
    Rails.logger.error("Error writing to .git/config for project #{full_path} (#{id}): #{e.message}.")
1582
    nil
1583 1584
  end

1585 1586
  def after_import
    repository.after_import
1587
    wiki.repository.after_import
1588 1589
    import_state.finish
    import_state.remove_jid
1590
    update_project_counter_caches
1591
    after_create_default_branch
1592
    join_pool_repository
1593
    refresh_markdown_cache!
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
  end

  def update_project_counter_caches
    classes = [
      Projects::OpenIssuesCountService,
      Projects::OpenMergeRequestsCountService
    ]

    classes.each do |klass|
      klass.new(self).refresh_cache
    end
  end

1607
  # rubocop: disable CodeReuse/ServiceClass
1608
  def after_create_default_branch
1609
    Projects::ProtectDefaultBranchService.new(self).execute
1610
  end
1611
  # rubocop: enable CodeReuse/ServiceClass
1612

1613
  # Lazy loading of the `pipeline_status` attribute
1614
  def pipeline_status
1615
    @pipeline_status ||= Gitlab::Cache::Ci::ProjectPipelineStatus.load_for_project(self)
1616 1617
  end

1618 1619
  def add_export_job(current_user:, after_export_strategy: nil, params: {})
    job_id = ProjectExportWorker.perform_async(current_user.id, self.id, after_export_strategy, params)
1620 1621 1622 1623 1624 1625 1626

    if job_id
      Rails.logger.info "Export job started for project ID #{self.id} with job ID #{job_id}"
    else
      Rails.logger.error "Export job failed to start for project ID #{self.id}"
    end
  end
J
James Lopez 已提交
1627

1628 1629
  def import_export_shared
    @import_export_shared ||= Gitlab::ImportExport::Shared.new(self)
1630 1631
  end

J
James Lopez 已提交
1632
  def export_path
1633 1634
    return nil unless namespace.present? || hashed_storage?(:repository)

1635
    import_export_shared.archive_path
J
James Lopez 已提交
1636
  end
1637

T
Travis Miller 已提交
1638 1639 1640
  def export_status
    if export_in_progress?
      :started
1641 1642
    elsif after_export_in_progress?
      :after_export_action
J
James Lopez 已提交
1643
    elsif export_file_exists?
T
Travis Miller 已提交
1644 1645 1646 1647 1648 1649 1650
      :finished
    else
      :none
    end
  end

  def export_in_progress?
1651
    import_export_shared.active_export_count > 0
T
Travis Miller 已提交
1652 1653
  end

1654 1655 1656 1657
  def after_export_in_progress?
    import_export_shared.after_export_in_progress?
  end

1658
  def remove_exports
J
James Lopez 已提交
1659
    return unless export_file_exists?
1660

1661
    import_export_upload.remove_export_file!
1662
    import_export_upload.save unless import_export_upload.destroyed?
1663
  end
1664

J
James Lopez 已提交
1665
  def export_file_exists?
J
James Lopez 已提交
1666
    export_file&.file
1667
  end
1668

J
James Lopez 已提交
1669 1670
  def export_file
    import_export_upload&.export_file
1671 1672
  end

V
vanadium23 已提交
1673 1674 1675 1676
  def full_path_slug
    Gitlab::Utils.slugify(full_path.to_s)
  end

K
Kamil Trzcinski 已提交
1677
  def has_ci?
1678
    repository.gitlab_ci_yml || auto_devops_enabled?
K
Kamil Trzcinski 已提交
1679 1680
  end

1681
  def predefined_variables
1682 1683
    visibility = Gitlab::VisibilityLevel.string_level(visibility_level)

1684 1685 1686 1687 1688 1689 1690 1691 1692 1693
    Gitlab::Ci::Variables::Collection.new
      .append(key: 'CI_PROJECT_ID', value: id.to_s)
      .append(key: 'CI_PROJECT_NAME', value: path)
      .append(key: 'CI_PROJECT_PATH', value: full_path)
      .append(key: 'CI_PROJECT_PATH_SLUG', value: full_path_slug)
      .append(key: 'CI_PROJECT_NAMESPACE', value: namespace.full_path)
      .append(key: 'CI_PROJECT_URL', value: web_url)
      .append(key: 'CI_PROJECT_VISIBILITY', value: visibility)
      .concat(container_registry_variables)
      .concat(auto_devops_variables)
1694
      .concat(api_variables)
1695 1696 1697 1698
  end

  def api_variables
    Gitlab::Ci::Variables::Collection.new.tap do |variables|
1699
      variables.append(key: 'CI_API_V4_URL', value: API::Helpers::Version.new('v4').root_url)
1700
    end
1701 1702 1703
  end

  def container_registry_variables
1704
    Gitlab::Ci::Variables::Collection.new.tap do |variables|
1705
      break variables unless Gitlab.config.registry.enabled
1706

1707
      variables.append(key: 'CI_REGISTRY', value: Gitlab.config.registry.host_port)
1708

1709
      if container_registry_enabled?
1710
        variables.append(key: 'CI_REGISTRY_IMAGE', value: container_registry_url)
1711
      end
K
Kamil Trzcinski 已提交
1712
    end
1713 1714
  end

1715 1716 1717 1718 1719 1720 1721 1722 1723
  def default_environment
    production_first = "(CASE WHEN name = 'production' THEN 0 ELSE 1 END), id ASC"

    environments
      .with_state(:available)
      .reorder(production_first)
      .first
  end

1724
  def ci_variables_for(ref:, environment: nil)
L
Lin Jen-Shin 已提交
1725
    # EE would use the environment
1726 1727 1728 1729 1730 1731
    if protected_for?(ref)
      variables
    else
      variables.unprotected
    end
  end
1732

1733
  def protected_for?(ref)
M
Matija Čupić 已提交
1734
    raise Repository::AmbiguousRefError if repository.ambiguous_ref?(ref)
1735

1736
    resolved_ref = repository.expand_ref(ref) || ref
1737 1738
    return false unless Gitlab::Git.tag_ref?(resolved_ref) || Gitlab::Git.branch_ref?(resolved_ref)

1739 1740 1741 1742 1743
    ref_name = if resolved_ref == ref
                 Gitlab::Git.ref_name(resolved_ref)
               else
                 ref
               end
1744 1745 1746 1747 1748

    if Gitlab::Git.branch_ref?(resolved_ref)
      ProtectedBranch.protected?(self, ref_name)
    elsif Gitlab::Git.tag_ref?(resolved_ref)
      ProtectedTag.protected?(self, ref_name)
1749
    end
1750
  end
1751

1752
  def deployment_variables(environment: nil)
1753
    deployment_platform(environment: environment)&.predefined_variables(project: self) || []
1754 1755
  end

1756 1757 1758
  def auto_devops_variables
    return [] unless auto_devops_enabled?

1759
    (auto_devops || build_auto_devops)&.predefined_variables
1760 1761
  end

1762
  def append_or_update_attribute(name, value)
1763
    old_values = public_send(name.to_s) # rubocop:disable GitlabSecurity/PublicSend
1764 1765 1766 1767 1768 1769

    if Project.reflect_on_association(name).try(:macro) == :has_many && old_values.any?
      update_attribute(name, old_values + value)
    else
      update_attribute(name, value)
    end
1770 1771 1772

  rescue ActiveRecord::RecordNotSaved => e
    handle_update_attribute_error(e, value)
1773 1774
  end

1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
  # Tries to set repository as read_only, checking for existing Git transfers in progress beforehand
  #
  # @return [Boolean] true when set to read_only or false when an existing git transfer is in progress
  def set_repository_read_only!
    with_lock do
      break false if git_transfer_in_progress?

      update_column(:repository_read_only, true)
    end
  end

  # Set repository as writable again
  def set_repository_writable!
    with_lock do
      update_column(repository_read_only, false)
    end
  end

Y
Yorick Peterse 已提交
1793
  def pushes_since_gc
1794
    Gitlab::Redis::SharedState.with { |redis| redis.get(pushes_since_gc_redis_shared_state_key).to_i }
Y
Yorick Peterse 已提交
1795 1796 1797
  end

  def increment_pushes_since_gc
1798
    Gitlab::Redis::SharedState.with { |redis| redis.incr(pushes_since_gc_redis_shared_state_key) }
Y
Yorick Peterse 已提交
1799 1800 1801
  end

  def reset_pushes_since_gc
1802
    Gitlab::Redis::SharedState.with { |redis| redis.del(pushes_since_gc_redis_shared_state_key) }
Y
Yorick Peterse 已提交
1803 1804
  end

D
Douwe Maan 已提交
1805
  def route_map_for(commit_sha)
1806 1807
    @route_maps_by_commit ||= Hash.new do |h, sha|
      h[sha] = begin
D
Douwe Maan 已提交
1808
        data = repository.route_map_for(sha)
1809 1810
        next unless data

D
Douwe Maan 已提交
1811 1812 1813
        Gitlab::RouteMap.new(data)
      rescue Gitlab::RouteMap::FormatError
        nil
1814 1815 1816 1817 1818 1819 1820
      end
    end

    @route_maps_by_commit[commit_sha]
  end

  def public_path_for_source_path(path, commit_sha)
D
Douwe Maan 已提交
1821
    map = route_map_for(commit_sha)
1822 1823
    return unless map

D
Douwe Maan 已提交
1824
    map.public_path_for_source_path(path)
1825 1826
  end

1827 1828 1829 1830
  def parent_changed?
    namespace_id_changed?
  end

1831 1832 1833 1834 1835 1836 1837 1838
  def default_merge_request_target
    if forked_from_project&.merge_requests_enabled?
      forked_from_project
    else
      self
    end
  end

F
Felipe Artur 已提交
1839 1840 1841
  # Overridden on EE module
  def multiple_issue_boards_available?
    false
F
Felipe Artur 已提交
1842 1843
  end

1844 1845 1846 1847
  def full_path_was
    File.join(namespace.full_path, previous_changes['path'].first)
  end

1848 1849
  alias_method :name_with_namespace, :full_name
  alias_method :human_name, :full_name
1850
  # @deprecated cannot remove yet because it has an index with its name in elasticsearch
1851 1852
  alias_method :path_with_namespace, :full_path

1853
  # rubocop: disable CodeReuse/ServiceClass
1854 1855 1856
  def forks_count
    Projects::ForksCountService.new(self).count
  end
1857
  # rubocop: enable CodeReuse/ServiceClass
1858

1859
  def legacy_storage?
1860 1861 1862
    [nil, 0].include?(self.storage_version)
  end

1863 1864 1865 1866
  # Check if Hashed Storage is enabled for the project with at least informed feature rolled out
  #
  # @param [Symbol] feature that needs to be rolled out for the project (:repository, :attachments)
  def hashed_storage?(feature)
1867 1868 1869
    raise ArgumentError, "Invalid feature" unless HASHED_STORAGE_FEATURES.include?(feature)

    self.storage_version && self.storage_version >= HASHED_STORAGE_FEATURES[feature]
1870 1871
  end

1872 1873 1874 1875
  def renamed?
    persisted? && path_changed?
  end

1876 1877 1878
  def merge_method
    if self.merge_requests_ff_only_enabled
      :ff
1879 1880
    elsif self.merge_requests_rebase_enabled
      :rebase_merge
1881 1882 1883 1884 1885 1886
    else
      :merge
    end
  end

  def merge_method=(method)
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
    case method.to_s
    when "ff"
      self.merge_requests_ff_only_enabled = true
      self.merge_requests_rebase_enabled = true
    when "rebase_merge"
      self.merge_requests_ff_only_enabled = false
      self.merge_requests_rebase_enabled = true
    when "merge"
      self.merge_requests_ff_only_enabled = false
      self.merge_requests_rebase_enabled = false
    end
1898 1899 1900
  end

  def ff_merge_must_be_possible?
1901
    self.merge_requests_ff_only_enabled || self.merge_requests_rebase_enabled
1902 1903
  end

1904
  def migrate_to_hashed_storage!
1905
    return unless storage_upgradable?
1906

1907
    if git_transfer_in_progress?
1908 1909 1910 1911 1912 1913
      ProjectMigrateHashedStorageWorker.perform_in(Gitlab::ReferenceCounter::REFERENCE_EXPIRE_TIME, id)
    else
      ProjectMigrateHashedStorageWorker.perform_async(id)
    end
  end

1914 1915 1916 1917
  def git_transfer_in_progress?
    repo_reference_count > 0 || wiki_reference_count > 0
  end

1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
  def storage_version=(value)
    super

    @storage = nil if storage_version_changed?
  end

  def gl_repository(is_wiki:)
    Gitlab::GlRepository.gl_repository(self, is_wiki)
  end

1928 1929 1930 1931
  def reference_counter(wiki: false)
    Gitlab::ReferenceCounter.new(gl_repository(is_wiki: wiki))
  end

1932 1933 1934
  def badges
    return project_badges unless group

1935 1936 1937 1938
    Badge.from_union([
      project_badges,
      GroupBadge.where(group: group.self_and_ancestors)
    ])
1939 1940
  end

1941 1942 1943 1944 1945 1946 1947 1948
  def merge_requests_allowing_push_to_user(user)
    return MergeRequest.none unless user

    developer_access_exists = user.project_authorizations
                                .where('access_level >= ? ', Gitlab::Access::DEVELOPER)
                                .where('project_authorizations.project_id = merge_requests.target_project_id')
                                .limit(1)
                                .select(1)
1949 1950 1951 1952
    merge_requests_allowing_collaboration.where('EXISTS (?)', developer_access_exists)
  end

  def any_branch_allows_collaboration?(user)
1953
    fetch_branch_allows_collaboration(user)
1954 1955
  end

1956
  def branch_allows_collaboration?(user, branch_name)
1957
    fetch_branch_allows_collaboration(user, branch_name)
1958 1959
  end

1960 1961 1962 1963
  def licensed_features
    []
  end

1964 1965
  def toggle_ci_cd_settings!(settings_attribute)
    ci_cd_settings.toggle!(settings_attribute)
1966 1967
  end

1968
  def gitlab_deploy_token
1969
    @gitlab_deploy_token ||= deploy_tokens.gitlab_deploy_token
1970 1971
  end

1972 1973 1974 1975 1976
  def any_lfs_file_locks?
    lfs_file_locks.any?
  end
  request_cache(:any_lfs_file_locks?) { self.id }

1977 1978 1979 1980
  def auto_cancel_pending_pipelines?
    auto_cancel_pending_pipelines == 'enabled'
  end

1981 1982
  def storage
    @storage ||=
1983
      if hashed_storage?(:repository)
1984 1985 1986 1987 1988
        Storage::HashedProject.new(self)
      else
        Storage::LegacyProject.new(self)
      end
  end
1989

1990 1991 1992 1993
  def storage_upgradable?
    storage_version != LATEST_STORAGE_VERSION
  end

1994 1995 1996 1997
  def snippets_visible?(user = nil)
    Ability.allowed?(user, :read_project_snippet, self)
  end

1998 1999 2000 2001
  def max_attachment_size
    Gitlab::CurrentSettings.max_attachment_size.megabytes.to_i
  end

2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
  def object_pool_params
    return {} unless !forked? && git_objects_poolable?

    {
      repository_storage: repository_storage,
      pool_repository:    pool_repository || create_new_pool_repository
    }
  end

  # Git objects are only poolable when the project is or has:
  # - Hashed storage -> The object pool will have a remote to its members, using relative paths.
  #                     If the repository path changes we would have to update the remote.
  # - Public         -> User will be able to fetch Git objects that might not exist
  #                     in their own repository.
  # - Repository     -> Else the disk path will be empty, and there's nothing to pool
  def git_objects_poolable?
    hashed_storage?(:repository) &&
      public? &&
      repository_exists? &&
      Gitlab::CurrentSettings.hashed_storage_enabled &&
      Feature.enabled?(:object_pools, self)
  end

2025
  def leave_pool_repository
2026
    pool_repository&.unlink_repository(repository) && update_column(:pool_repository_id, nil)
2027 2028
  end

2029 2030 2031 2032
  def link_pool_repository
    pool_repository&.link_repository(repository)
  end

2033 2034
  private

2035 2036 2037 2038
  def merge_requests_allowing_collaboration(source_branch = nil)
    relation = source_of_merge_requests.opened.where(allow_collaboration: true)
    relation = relation.where(source_branch: source_branch) if source_branch
    relation
2039 2040
  end

2041 2042
  def create_new_pool_repository
    pool = begin
2043
             create_pool_repository!(shard: Shard.by_name(repository_storage), source_project: self)
2044
           rescue ActiveRecord::RecordNotUnique
2045
             pool_repository(true)
2046 2047
           end

2048
    pool.schedule unless pool.scheduled?
2049 2050 2051 2052 2053 2054 2055 2056 2057
    pool
  end

  def join_pool_repository
    return unless pool_repository

    ObjectPool::JoinWorker.perform_async(pool_repository.id, self.id)
  end

2058
  def use_hashed_storage
2059
    if self.new_record? && Gitlab::CurrentSettings.hashed_storage_enabled
2060
      self.storage_version = LATEST_STORAGE_VERSION
G
Gabriel Mazetto 已提交
2061 2062 2063
    end
  end

2064
  def repo_reference_count
2065
    reference_counter.value
2066 2067 2068
  end

  def wiki_reference_count
2069
    reference_counter(wiki: true).value
2070 2071
  end

2072 2073 2074
  def check_repository_absence!
    return if skip_disk_validation

2075
    if repository_storage.blank? || repository_with_same_path_already_exists?
2076 2077 2078 2079 2080 2081
      errors.add(:base, 'There is already a repository with that name on disk')
      throw :abort
    end
  end

  def repository_with_same_path_already_exists?
2082
    gitlab_shell.exists?(repository_storage, "#{disk_path}.git")
2083 2084
  end

M
Mark Chao 已提交
2085 2086
  def set_timestamps_for_create
    update_columns(last_activity_at: self.created_at, last_repository_updated_at: self.created_at)
2087 2088
  end

2089
  def cross_namespace_reference?(from)
2090 2091 2092 2093 2094
    case from
    when Project
      namespace != from.namespace
    when Namespace
      namespace != from
2095 2096 2097
    end
  end

2098
  # Check if a reference is being done cross-project
2099 2100 2101 2102
  def cross_project_reference?(from)
    return true if from.is_a?(Namespace)

    from && self != from
2103 2104
  end

2105
  def pushes_since_gc_redis_shared_state_key
Y
Yorick Peterse 已提交
2106 2107 2108
    "projects/#{id}/pushes_since_gc"
  end

2109 2110 2111 2112 2113 2114 2115
  # Similar to the normal callbacks that hook into the life cycle of an
  # Active Record object, you can also define callbacks that get triggered
  # when you add an object to an association collection. If any of these
  # callbacks throw an exception, the object will not be added to the
  # collection. Before you add a new board to the boards collection if you
  # already have 1, 2, or n it will fail, but it if you have 0 that is lower
  # than the number of permitted boards per project it won't fail.
2116
  def validate_board_limit(board)
2117
    raise BoardLimitExceeded, 'Number of permitted boards exceeded' if boards.size >= NUMBER_OF_PERMITTED_BOARDS
2118
  end
2119

M
Markus Koller 已提交
2120 2121 2122 2123
  def update_project_statistics
    stats = statistics || build_statistics
    stats.update(namespace_id: namespace_id)
  end
2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138

  def check_pending_delete
    return if valid_attribute?(:name) && valid_attribute?(:path)
    return unless pending_delete_twin

    %i[route route.path name path].each do |error|
      errors.delete(error)
    end

    errors.add(:base, "The project is still being deleted. Please try again later.")
  end

  def pending_delete_twin
    return false unless path

2139
    Project.pending_delete.find_by_full_path(full_path)
2140
  end
2141 2142 2143 2144 2145 2146 2147 2148 2149

  ##
  # This method is here because of support for legacy container repository
  # which has exactly the same path like project does, but which might not be
  # persisted in `container_repositories` table.
  #
  def has_root_container_repository_tags?
    return false unless Gitlab.config.registry.enabled

2150
    ContainerRepository.build_root_repository(self).has_tags?
2151
  end
2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163

  def handle_update_attribute_error(ex, value)
    if ex.message.start_with?('Failed to replace')
      if value.respond_to?(:each)
        invalid = value.detect(&:invalid?)

        raise ex, ([ex.message] + invalid.errors.full_messages).join(' ') if invalid
      end
    end

    raise ex
  end
2164

2165
  def fetch_branch_allows_collaboration(user, branch_name = nil)
2166 2167
    return false unless user

2168
    Gitlab::SafeRequestStore.fetch("project-#{id}:branch-#{branch_name}:user-#{user.id}:branch_allows_collaboration") do
2169 2170
      next false if empty_repo?

2171 2172 2173 2174 2175 2176
      # Issue for N+1: https://gitlab.com/gitlab-org/gitlab-ce/issues/49322
      Gitlab::GitalyClient.allow_n_plus_1_calls do
        merge_requests_allowing_collaboration(branch_name).any? do |merge_request|
          merge_request.can_be_merged_by?(user)
        end
      end
2177 2178
    end
  end
2179 2180 2181 2182

  def services_templates
    @services_templates ||= Service.where(template: true)
  end
G
gitlabhq 已提交
2183
end