project.rb 53.9 KB
Newer Older
1 2
require 'carrierwave/orm/activerecord'

G
gitlabhq 已提交
3
class Project < ActiveRecord::Base
4
  include Gitlab::ConfigHelper
5
  include Gitlab::ShellAdapter
6
  include Gitlab::VisibilityLevel
7
  include Gitlab::CurrentSettings
R
Rémy Coutable 已提交
8
  include AccessRequestable
9
  include Avatarable
10
  include CacheMarkdownField
11 12
  include Referable
  include Sortable
13
  include AfterCommitQueue
14
  include CaseSensitivity
15
  include TokenAuthenticatable
16
  include ValidAttribute
F
Felipe Artur 已提交
17
  include ProjectFeaturesCompatibility
18
  include SelectForProjectAuthorization
19
  include Routable
20
  include GroupDescendant
21
  include Gitlab::SQL::Pattern
R
Robert Speicher 已提交
22

23
  extend Gitlab::ConfigHelper
24
  extend Gitlab::CurrentSettings
25

26
  BoardLimitExceeded = Class.new(StandardError)
27

28
  NUMBER_OF_PERMITTED_BOARDS = 1
D
Douwe Maan 已提交
29
  UNKNOWN_IMPORT_URL = 'http://unknown.git'.freeze
30 31
  # Hashed Storage versions handle rolling out new storage to project and dependents models:
  # nil: legacy
32 33 34
  # 1: repository
  # 2: attachments
  LATEST_STORAGE_VERSION = 2
35 36 37 38
  HASHED_STORAGE_FEATURES = {
    repository: 1,
    attachments: 2
  }.freeze
J
Jared Szechy 已提交
39

40 41
  cache_markdown_field :description, pipeline: :description

42 43
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
           :merge_requests_enabled?, :issues_enabled?, to: :project_feature,
44
                                                       allow_nil: true
F
Felipe Artur 已提交
45

46
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
47

48
  default_value_for :archived, false
49
  default_value_for :visibility_level, gitlab_config_features.visibility_level
50
  default_value_for :resolve_outdated_diff_discussions, false
51
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
52
  default_value_for(:repository_storage) { current_application_settings.pick_repository_storage }
K
Kamil Trzcinski 已提交
53
  default_value_for(:shared_runners_enabled) { current_application_settings.shared_runners_enabled }
F
Felipe Artur 已提交
54 55 56 57 58
  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
59
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
60

61 62
  add_authentication_token_field :runners_token
  before_save :ensure_runners_token
63

64 65
  after_save :update_project_statistics, if: :namespace_id_changed?
  after_create :create_project_feature, unless: :project_feature
66
  after_create :set_last_activity_at
67
  after_create :set_last_repository_updated_at
68
  after_update :update_forks_visibility_level
69

70
  before_destroy :remove_private_deploy_keys
71
  after_destroy -> { run_after_commit { remove_pages } }
K
Kamil Trzcinski 已提交
72

73 74
  after_validation :check_pending_delete

75
  # Storage specific hooks
76
  after_initialize :use_hashed_storage
77
  after_create :check_repository_absence!
78 79
  after_create :ensure_storage_path_exists
  after_save :ensure_storage_path_exists, if: :namespace_id_changed?
80

81
  acts_as_taggable
D
Dmitriy Zaporozhets 已提交
82

83
  attr_accessor :old_path_with_namespace
84
  attr_accessor :template_name
85
  attr_writer :pipeline_status
S
Stan Hu 已提交
86
  attr_accessor :skip_disk_validation
87

88 89
  alias_attribute :title, :name

90
  # Relations
91
  belongs_to :creator, class_name: 'User'
92
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
93
  belongs_to :namespace
94 95
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
96

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

100
  # Project services
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
  has_one :campfire_service
  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 :gemnasium_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 已提交
132
  has_one :packagist_service
133

134
  # TODO: replace these relations with the fork network versions
135
  has_one  :forked_project_link,  foreign_key: "forked_to_project_id"
136 137 138 139
  has_one  :forked_from_project,  through:   :forked_project_link

  has_many :forked_project_links, foreign_key: "forked_from_project_id"
  has_many :forks,                through:     :forked_project_links, source: :forked_to_project
140 141 142 143 144 145 146 147
  # TODO: replace these relations with the fork network versions

  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
  has_one :fork_network, through: :fork_network_member
148

149
  # Merge Requests for target project should be removed with it
150 151 152 153 154 155 156 157 158 159 160
  has_many :merge_requests, foreign_key: 'target_project_id'
  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
161

162
  has_many :project_authorizations
163
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
164
  has_many :project_members, -> { where(requested_at: nil) },
165
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
166

R
Rémy Coutable 已提交
167
  alias_method :members, :project_members
168 169
  has_many :users, through: :project_members

170
  has_many :requesters, -> { where.not(requested_at: nil) },
171
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
172
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
173

174
  has_many :deploy_keys_projects
175
  has_many :deploy_keys, through: :deploy_keys_projects
176
  has_many :users_star_projects
C
Ciro Santilli 已提交
177
  has_many :starrers, through: :users_star_projects, source: :user
178
  has_many :releases
179
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
M
Marin Jankovski 已提交
180
  has_many :lfs_objects, through: :lfs_objects_projects
181
  has_many :project_group_links
182
  has_many :invited_groups, through: :project_group_links, source: :group
183 184
  has_many :pages_domains
  has_many :todos
185
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
186

187
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
188
  has_one :project_feature, inverse_of: :project
189
  has_one :statistics, class_name: 'ProjectStatistics'
190

S
Shinya Maeda 已提交
191
  has_one :cluster_project, class_name: 'Clusters::Project'
192
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
193

194 195 196
  # 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.
197
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
K
Kamil Trzcinski 已提交
198

199 200 201 202 203 204 205
  has_many :commit_statuses
  has_many :pipelines, class_name: 'Ci::Pipeline'

  # 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.
206
  has_many :builds, class_name: 'Ci::Build', dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
207
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
208
  has_many :runner_projects, class_name: 'Ci::RunnerProject'
209
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
210
  has_many :variables, class_name: 'Ci::Variable'
211 212 213 214
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
  has_many :deployments
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
K
Kamil Trzcinski 已提交
215

K
Kamil Trzcinski 已提交
216 217
  has_many :active_runners, -> { active }, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'

218
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
219
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
220

221
  accepts_nested_attributes_for :variables, allow_destroy: true
222
  accepts_nested_attributes_for :project_feature, update_only: true
223
  accepts_nested_attributes_for :import_data
224
  accepts_nested_attributes_for :auto_devops, update_only: true
225

226
  delegate :name, to: :owner, allow_nil: true, prefix: true
227
  delegate :members, to: :team, prefix: true
228
  delegate :add_user, :add_users, to: :team
229
  delegate :add_guest, :add_reporter, :add_developer, :add_master, :add_role, to: :team
230

A
Andrey Kumanyaev 已提交
231
  # Validations
232
  validates :creator, presence: true, on: :create
233
  validates :description, length: { maximum: 2000 }, allow_blank: true
234
  validates :ci_config_path,
235 236
    format: { without: /(\.{2}|\A\/)/,
              message: 'cannot include leading slash or directory traversal.' },
237 238
    length: { maximum: 255 },
    allow_blank: true
239 240
  validates :name,
    presence: true,
241
    length: { maximum: 255 },
242
    format: { with: Gitlab::Regex.project_name_regex,
D
Douwe Maan 已提交
243
              message: Gitlab::Regex.project_name_regex_message }
244 245
  validates :path,
    presence: true,
246
    project_path: true,
247
    length: { maximum: 255 },
248 249
    uniqueness: { scope: :namespace_id }

250
  validates :namespace, presence: true
D
Douwe Maan 已提交
251
  validates :name, uniqueness: { scope: :namespace_id }
J
James Lopez 已提交
252
  validates :import_url, addressable_url: true, if: :external_import?
D
Douwe Maan 已提交
253
  validates :import_url, importable_url: true, if: [:external_import?, :import_url_changed?]
254
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
255
  validate :check_limit, on: :create
256
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
257
  validate :avatar_type,
258
    if: ->(project) { project.avatar.present? && project.avatar_changed? }
259
  validates :avatar, file_size: { maximum: 200.kilobytes.to_i }
D
Douwe Maan 已提交
260
  validate :visibility_level_allowed_by_group
D
Douwe Maan 已提交
261
  validate :visibility_level_allowed_as_fork
262
  validate :check_wiki_path_conflict
263 264 265
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
266

D
Douwe Maan 已提交
267
  mount_uploader :avatar, AvatarUploader
268
  has_many :uploads, as: :model, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
A
Andrey Kumanyaev 已提交
269

270
  # Scopes
271
  scope :pending_delete, -> { where(pending_delete: true) }
272
  scope :without_deleted, -> { where(pending_delete: false) }
273

274 275 276
  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) }
277

278
  scope :sorted_by_activity, -> { reorder(last_activity_at: :desc) }
279 280
  scope :sorted_by_stars, -> { reorder('projects.star_count DESC') }

281
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
D
Dmitriy Zaporozhets 已提交
282
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
283
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
T
Toon Claes 已提交
284
  scope :starred_by, ->(user) { joins(:users_star_projects).where('users_star_projects.user_id': user.id) }
R
Rémy Coutable 已提交
285
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
286
  scope :archived, -> { where(archived: true) }
287
  scope :non_archived, -> { where(archived: false) }
R
Rubén Dávila 已提交
288
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
R
Rémy Coutable 已提交
289 290
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }

291
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
M
Markus Koller 已提交
292
  scope :with_statistics, -> { includes(:statistics) }
293
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
294 295 296
  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.
297 298
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
299
  end
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
    access_level_attribute = ProjectFeature.access_level_attribute(feature)
    with_project_feature.where(project_features: { access_level_attribute => [nil, ProjectFeature::PRIVATE, ProjectFeature::ENABLED] })
  }

  # 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) }
315
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
316

317
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
318

319 320 321 322
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
  def self.public_or_visible_to_user(user = nil)
    if user
323 324 325 326
      authorized = user
        .project_authorizations
        .select(1)
        .where('project_authorizations.project_id = projects.id')
327 328 329 330 331 332 333 334 335

      levels = Gitlab::VisibilityLevel.levels_for_user(user)

      where('EXISTS (?) OR projects.visibility_level IN (?)', authorized, levels)
    else
      public_to_user
    end
  end

336 337 338
  # project features may be "disabled", "internal" or "enabled". If "internal",
  # they are only available to team members. This scope returns projects where
  # the feature is either enabled, or internal with permission for the user.
339 340 341 342
  #
  # 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.
343
  def self.with_feature_available_for_user(feature, user)
344 345 346 347 348 349 350
    visible = [nil, ProjectFeature::ENABLED]

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

351 352
      authorized = user.project_authorizations.select(1)
        .where('project_authorizations.project_id = projects.id')
353

354 355
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
356 357 358 359 360 361
              visible,
              ProjectFeature::PRIVATE,
              authorized)
    else
      with_feature_access_level(feature, visible)
    end
362
  end
F
Felipe Artur 已提交
363

R
Rémy Coutable 已提交
364 365
  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) }
366

367
  scope :excluding_project, ->(project) { where.not(id: project) }
368
  scope :import_started, -> { where(import_status: 'started') }
369

370
  state_machine :import_status, initial: :none do
371 372 373 374 375 376 377 378
    event :import_schedule do
      transition [:none, :finished, :failed] => :scheduled
    end

    event :force_import_start do
      transition [:none, :finished, :failed] => :started
    end

379
    event :import_start do
380
      transition scheduled: :started
381 382 383
    end

    event :import_finish do
384
      transition started: :finished
385 386 387
    end

    event :import_fail do
388
      transition [:scheduled, :started] => :failed
389 390 391
    end

    event :import_retry do
392
      transition failed: :started
393 394
    end

395
    state :scheduled
396 397
    state :started
    state :finished
398 399
    state :failed

400
    after_transition [:none, :finished, :failed] => :scheduled do |project, _|
401 402 403 404
      project.run_after_commit do
        job_id = add_import_job
        update(import_jid: job_id) if job_id
      end
405 406
    end

407 408
    after_transition started: :finished do |project, _|
      project.reset_cache_and_import_attrs
409 410 411

      if Gitlab::ImportSources.importer_names.include?(project.import_type) && project.repo_exists?
        project.run_after_commit do
L
Lin Jen-Shin 已提交
412
          Projects::AfterImportService.new(project).execute
413 414
        end
      end
415
    end
416 417
  end

A
Andrey Kumanyaev 已提交
418
  class << self
419 420 421 422 423 424 425
    # 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.
426
    def search(query)
427
      fuzzy_search(query, [:path, :name, :description])
A
Andrey Kumanyaev 已提交
428
    end
429

430
    def search_by_title(query)
431
      non_archived.fuzzy_search(query, [:name])
432 433
    end

434 435 436
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
437 438

    def sort(method)
439 440
      case method.to_s
      when 'storage_size_desc'
M
Markus Koller 已提交
441 442 443
        # 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')
444 445 446 447
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
448 449
      else
        order_by(method)
450 451
      end
    end
452 453

    def reference_pattern
454
      %r{
455 456
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
457
      }x
458
    end
Y
Yorick Peterse 已提交
459

Y
Yorick Peterse 已提交
460
    def trending
461 462
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
Y
Yorick Peterse 已提交
463
    end
464 465 466 467 468 469

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

    def group_ids
472
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
473
    end
474 475
  end

476 477 478 479 480 481 482
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
  def ancestors_upto(top = nil)
    Gitlab::GroupHierarchy.new(Group.where(id: namespace_id))
      .base_and_ancestors(upto: top)
  end

483
  def lfs_enabled?
484
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
P
Patricio Cano 已提交
485

486
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
487 488
  end

489
  def auto_devops_enabled?
490
    if auto_devops&.enabled.nil?
Z
Zeger-Jan van de Weg 已提交
491
      current_application_settings.auto_devops_enabled?
492 493
    else
      auto_devops.enabled?
Z
Zeger-Jan van de Weg 已提交
494
    end
495 496
  end

497 498 499 500
  def has_auto_devops_implicitly_disabled?
    auto_devops&.enabled.nil? && !current_application_settings.auto_devops_enabled?
  end

501 502 503 504
  def empty_repo?
    repository.empty?
  end

505
  def repository_storage_path
506
    Gitlab.config.repositories.storages[repository_storage].try(:[], 'path')
507 508
  end

D
Dmitriy Zaporozhets 已提交
509
  def team
510
    @team ||= ProjectTeam.new(self)
D
Dmitriy Zaporozhets 已提交
511 512 513
  end

  def repository
514
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
515 516
  end

517 518 519 520
  def reload_repository!
    @repository = nil
  end

A
Andre Guedes 已提交
521
  def container_registry_url
K
Kamil Trzcinski 已提交
522
    if Gitlab.config.registry.enabled
523
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
524
    end
525 526
  end

527
  def has_container_registry_tags?
528 529 530
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
531
      has_root_container_repository_tags?
532 533
  end

534 535
  def commit(ref = 'HEAD')
    repository.commit(ref)
D
Dmitriy Zaporozhets 已提交
536 537
  end

538 539 540 541
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

542
  # ref can't be HEAD, can only be branch/tag name or SHA
543
  def latest_successful_builds_for(ref = default_branch)
544
    latest_pipeline = pipelines.latest_successful_for(ref)
545 546 547 548 549 550

    if latest_pipeline
      latest_pipeline.builds.latest.with_artifacts
    else
      builds.none
    end
551 552
  end

553
  def merge_base_commit(first_commit_id, second_commit_id)
D
Douwe Maan 已提交
554
    sha = repository.merge_base(first_commit_id, second_commit_id)
555
    commit_by(oid: sha) if sha
556 557
  end

558
  def saved?
559
    id && persisted?
560 561
  end

562
  def add_import_job
D
Douwe Maan 已提交
563 564
    job_id =
      if forked?
565 566
        RepositoryForkWorker.perform_async(id,
                                           forked_from_project.repository_storage_path,
567
                                           forked_from_project.disk_path)
D
Douwe Maan 已提交
568 569 570
      else
        RepositoryImportWorker.perform_async(self.id)
      end
571

572 573 574 575 576 577 578 579
    log_import_activity(job_id)

    job_id
  end

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

580
    if job_id
581
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
582
    else
583
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
584
    end
585 586
  end

587 588 589 590 591
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

592
    update(import_error: nil)
593 594 595 596 597
    remove_import_data
  end

  # This method is overriden in EE::Project model
  def remove_import_data
598
    import_data&.destroy
599 600
  end

601
  def ci_config_path=(value)
602
    # Strip all leading slashes so that //foo -> foo
603
    super(value&.delete("\0"))
604 605
  end

J
James Lopez 已提交
606
  def import_url=(value)
J
James Lopez 已提交
607 608
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

609
    import_url = Gitlab::UrlSanitizer.new(value)
J
James Lopez 已提交
610
    super(import_url.sanitized_url)
611
    create_or_update_import_data(credentials: import_url.credentials)
J
James Lopez 已提交
612 613 614
  end

  def import_url
J
James Lopez 已提交
615
    if import_data && super.present?
616
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
J
James Lopez 已提交
617 618 619
      import_url.full_url
    else
      super
J
James Lopez 已提交
620 621
    end
  end
J
James Lopez 已提交
622

J
James Lopez 已提交
623
  def valid_import_url?
624
    valid?(:import_url) || errors.messages[:import_url].nil?
J
James Lopez 已提交
625 626
  end

627
  def create_or_update_import_data(data: nil, credentials: nil)
628
    return unless import_url.present? && valid_import_url?
629

J
James Lopez 已提交
630
    project_import_data = import_data || build_import_data
J
James Lopez 已提交
631 632 633 634
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
635 636 637 638
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
J
James Lopez 已提交
639
  end
J
James Lopez 已提交
640

641
  def import?
J
James Lopez 已提交
642
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
643 644
  end

645 646 647 648
  def no_import?
    import_status == 'none'
  end

649
  def external_import?
650 651 652
    import_url.present?
  end

653
  def imported?
654 655 656 657
    import_finished?
  end

  def import_in_progress?
658 659 660 661
    import_started? || import_scheduled?
  end

  def import_started?
662 663
    # import? does SQL work so only run it if it looks like there's an import running
    import_status == 'started' && import?
664 665
  end

666 667 668 669
  def import_scheduled?
    import_status == 'scheduled'
  end

670 671 672 673 674 675
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
676 677
  end

D
Douwe Maan 已提交
678
  def safe_import_url
679
    Gitlab::UrlSanitizer.new(import_url).masked_url
D
Douwe Maan 已提交
680 681
  end

682 683 684 685
  def bare_repository_import?
    import_type == 'bare_repository'
  end

686 687 688 689
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

R
Rémy Coutable 已提交
690 691 692 693
  def gitea_import?
    import_type == 'gitea'
  end

694
  def check_limit
D
Douwe Maan 已提交
695
    unless creator.can_create_project? || namespace.kind == 'group'
696 697 698
      projects_limit = creator.projects_limit

      if projects_limit == 0
P
Phil Hughes 已提交
699
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
700
      else
P
Phil Hughes 已提交
701
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
702
      end
703 704
    end
  rescue
D
Douwe Maan 已提交
705
    self.errors.add(:base, "Can't check your ability to create project")
G
gitlabhq 已提交
706 707
  end

D
Douwe Maan 已提交
708 709 710 711 712 713 714 715 716 717 718 719 720
  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.")
721 722
  end

723 724 725 726 727 728 729 730 731 732
  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

733
  def to_param
734 735 736 737 738
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
739 740
  end

741
  # `from` argument can be a Namespace or Project.
742 743
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
744
      full_path
745 746 747
    elsif cross_project_reference?(from)
      path
    end
748 749
  end

J
Jarka Kadlecova 已提交
750 751
  def to_human_reference(from = nil)
    if cross_namespace_reference?(from)
752
      name_with_namespace
J
Jarka Kadlecova 已提交
753
    elsif cross_project_reference?(from)
754 755
      name
    end
756 757
  end

758
  def web_url
759
    Gitlab::Routing.url_helpers.project_url(self)
760 761
  end

J
Jan Provaznik 已提交
762
  def new_issuable_address(author, address_type)
763
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author
764

765 766
    author.ensure_incoming_email_token!

J
Jan Provaznik 已提交
767
    suffix = address_type == 'merge_request' ? '+merge-request' : ''
768
    Gitlab::IncomingEmail.reply_address(
J
Jan Provaznik 已提交
769
      "#{full_path}#{suffix}+#{author.incoming_email_token}")
770 771
  end

772
  def build_commit_note(commit)
773
    notes.new(commit_id: commit.id, noteable_type: 'Commit')
G
gitlabhq 已提交
774
  end
N
Nihad Abbasov 已提交
775

N
Nihad Abbasov 已提交
776
  def last_activity
777
    last_event
G
gitlabhq 已提交
778 779 780
  end

  def last_activity_date
781
    last_repository_updated_at || last_activity_at || updated_at
D
Dmitriy Zaporozhets 已提交
782
  end
783

D
Dmitriy Zaporozhets 已提交
784 785 786
  def project_id
    self.id
  end
R
randx 已提交
787

788
  def get_issue(issue_id, current_user)
789 790 791 792 793
    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 已提交
794
      ExternalIssue.new(issue_id, self)
795 796 797
    end
  end

R
Robert Speicher 已提交
798
  def issue_exists?(issue_id)
799
    get_issue(issue_id)
R
Robert Speicher 已提交
800 801
  end

802
  def default_issue_tracker
803
    gitlab_issue_tracker_service || create_gitlab_issue_tracker_service
804 805 806 807 808 809 810 811 812 813
  end

  def issues_tracker
    if external_issue_tracker
      external_issue_tracker
    else
      default_issue_tracker
    end
  end

814
  def external_issue_reference_pattern
815
    external_issue_tracker.class.reference_pattern(only_long: issues_enabled?)
816 817
  end

818
  def default_issues_tracker?
819
    !external_issue_tracker
820 821 822
  end

  def external_issue_tracker
823 824 825 826 827 828 829 830 831 832 833 834 835 836
    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 已提交
837
    update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) if Gitlab::Database.read_write?
838 839
  end

840 841 842 843
  def has_wiki?
    wiki_enabled? || has_external_wiki?
  end

844 845 846 847 848 849 850 851 852 853 854 855 856
  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 已提交
857
    update_column(:has_external_wiki, services.external_wikis.any?) if Gitlab::Database.read_write?
858 859
  end

860
  def find_or_initialize_services(exceptions: [])
M
Marin Jankovski 已提交
861 862
    services_templates = Service.where(template: true)

863 864 865
    available_services_names = Service.available_services_names - exceptions

    available_services_names.map do |service_name|
M
Marin Jankovski 已提交
866
      service = find_service(services, service_name)
867

868 869 870
      if service
        service
      else
M
Marin Jankovski 已提交
871 872 873 874
        # We should check if template for the service exists
        template = find_service(services_templates, service_name)

        if template.nil?
875
          # If no template, we should create an instance. Ex `build_gitlab_ci_service`
876
          public_send("build_#{service_name}_service") # rubocop:disable GitlabSecurity/PublicSend
M
Marin Jankovski 已提交
877
        else
878
          Service.build_from_template(id, template)
M
Marin Jankovski 已提交
879 880
        end
      end
881 882 883
    end
  end

884 885 886 887
  def find_or_initialize_service(name)
    find_or_initialize_services.find { |service| service.to_param == name }
  end

V
Valery Sizov 已提交
888 889
  def create_labels
    Label.templates.each do |label|
890
      params = label.attributes.except('id', 'template', 'created_at', 'updated_at')
891
      Labels::FindOrCreateService.new(nil, self, params).execute(skip_authorization: true)
V
Valery Sizov 已提交
892 893 894
    end
  end

M
Marin Jankovski 已提交
895 896 897
  def find_service(list, name)
    list.find { |service| service.to_param == name }
  end
D
Dmitriy Zaporozhets 已提交
898

899
  def ci_services
Y
Yorick Peterse 已提交
900
    services.where(category: :ci)
901 902 903
  end

  def ci_service
904
    @ci_service ||= ci_services.reorder(nil).find_by(active: true)
905 906
  end

907 908
  # TODO: This will be extended for multiple enviroment clusters
  def deployment_platform
S
Shinya Maeda 已提交
909
    @deployment_platform ||= clusters.find_by(enabled: true)&.platform_kubernetes
910
    @deployment_platform ||= services.where(category: :deployment).reorder(nil).find_by(active: true)
911 912
  end

913 914 915 916 917
  def monitoring_services
    services.where(category: :monitoring)
  end

  def monitoring_service
918
    @monitoring_service ||= monitoring_services.reorder(nil).find_by(active: true)
919 920
  end

D
Drew Blessing 已提交
921 922 923 924
  def jira_tracker?
    issues_tracker.to_param == 'jira'
  end

925
  def avatar_type
926 927
    unless self.avatar.image?
      self.errors.add :avatar, 'only images allowed'
928 929 930 931
    end
  end

  def avatar_in_git
932
    repository.avatar
933 934
  end

935 936 937
  def avatar_url(**args)
    # We use avatar_path instead of overriding avatar_url because of carrierwave.
    # See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/11001/diffs#note_28659864
938
    avatar_path(args) || (Gitlab::Routing.url_helpers.project_avatar_url(self) if avatar_in_git)
S
sue445 已提交
939 940
  end

941 942 943 944 945
  # For compatibility with old code
  def code
    path
  end

946
  def items_for(entity)
D
Dmitriy Zaporozhets 已提交
947 948 949 950 951 952 953
    case entity
    when 'issue' then
      issues
    when 'merge_request' then
      merge_requests
    end
  end
954

955
  def send_move_instructions(old_path_with_namespace)
956 957
    # New project path needs to be committed to the DB or notification will
    # retrieve stale information
958 959 960
    run_after_commit do
      NotificationService.new.project_was_moved(self, old_path_with_namespace)
    end
961
  end
962 963

  def owner
964 965
    if group
      group
966
    else
967
      namespace.try(:owner)
968 969
    end
  end
D
Dmitriy Zaporozhets 已提交
970

971
  def execute_hooks(data, hooks_scope = :push_hooks)
972 973 974 975
    run_after_commit_or_now do
      hooks.public_send(hooks_scope).each do |hook| # rubocop:disable GitlabSecurity/PublicSend
        hook.async_execute(data, hooks_scope.to_s)
      end
976
    end
D
Dmitriy Zaporozhets 已提交
977 978
  end

979 980
  def execute_services(data, hooks_scope = :push_hooks)
    # Call only service hooks that are active for this scope
981 982 983 984
    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 已提交
985 986 987 988
    end
  end

  def valid_repo?
989
    repository.exists?
D
Dmitriy Zaporozhets 已提交
990
  rescue
991
    errors.add(:path, 'Invalid repository path')
D
Dmitriy Zaporozhets 已提交
992 993 994 995
    false
  end

  def repo
J
Jacob Vosmaer 已提交
996
    repository.rugged
D
Dmitriy Zaporozhets 已提交
997 998 999
  end

  def url_to_repo
1000
    gitlab_shell.url_to_repo(full_path)
D
Dmitriy Zaporozhets 已提交
1001 1002 1003
  end

  def repo_exists?
1004
    @repo_exists ||= repository.exists?
D
Dmitriy Zaporozhets 已提交
1005 1006 1007 1008 1009
  rescue
    @repo_exists = false
  end

  def root_ref?(branch)
D
Dmitriy Zaporozhets 已提交
1010
    repository.root_ref == branch
D
Dmitriy Zaporozhets 已提交
1011 1012 1013 1014 1015 1016
  end

  def ssh_url_to_repo
    url_to_repo
  end

1017 1018
  def http_url_to_repo
    "#{web_url}.git"
D
Dmitriy Zaporozhets 已提交
1019 1020
  end

1021
  def user_can_push_to_empty_repo?(user)
1022
    !ProtectedBranch.default_branch_protected? || team.max_member_access(user.id) > Gitlab::Access::DEVELOPER
1023 1024
  end

1025
  def forked?
1026 1027 1028 1029 1030
    return true if fork_network && fork_network.root_project != self

    # TODO: Use only the above conditional using the `fork_network`
    # This is the old conditional that looks at the `forked_project_link`, we
    # fall back to this while we're migrating the new models
1031 1032
    !(forked_project_link.nil? || forked_project_link.forked_from_project.nil?)
  end
D
Dmitriy Zaporozhets 已提交
1033

1034 1035 1036 1037
  def fork_source
    forked_from_project || fork_network&.root_project
  end

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
  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

1050 1051 1052 1053
  def personal?
    !group
  end

1054 1055 1056 1057 1058 1059
  # 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?
1060
      repo.before_delete
1061 1062 1063
    end

    if wiki.exists?
1064
      wiki.before_delete
1065 1066 1067
    end
  end

1068
  # Check if repository already exists on disk
S
Stan Hu 已提交
1069 1070
  def check_repository_path_availability
    return true if skip_disk_validation
1071 1072 1073 1074
    return false unless repository_storage_path

    expires_full_path_cache # we need to clear cache to validate renames correctly

1075 1076 1077
    # 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?
1078 1079 1080 1081 1082
      errors.add(:base, 'There is already a repository with that name on disk')
      return false
    end

    true
1083 1084
  rescue GRPC::Internal # if the path is too long
    false
1085 1086
  end

1087 1088 1089 1090
  def create_repository(force: false)
    # Forked import is handled asynchronously
    return if forked? && !force

J
Jacob Vosmaer 已提交
1091
    if gitlab_shell.add_repository(repository_storage, disk_path)
1092 1093 1094 1095 1096 1097 1098 1099
      repository.after_create
      true
    else
      errors.add(:base, 'Failed to create repository via gitlab-shell')
      false
    end
  end

1100 1101
  def hook_attrs(backward: true)
    attrs = {
J
Jacopo 已提交
1102
      id: id,
K
Kirill Zaitsev 已提交
1103
      name: name,
1104
      description: description,
K
Kirilll Zaitsev 已提交
1105
      web_url: web_url,
1106
      avatar_url: avatar_url(only_path: false),
1107 1108
      git_ssh_url: ssh_url_to_repo,
      git_http_url: http_url_to_repo,
K
Kirill Zaitsev 已提交
1109
      namespace: namespace.name,
1110
      visibility_level: visibility_level,
1111
      path_with_namespace: full_path,
1112
      default_branch: default_branch,
1113
      ci_config_path: ci_config_path
K
Kirill Zaitsev 已提交
1114
    }
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126

    # 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 已提交
1127 1128
  end

1129
  def project_member(user)
1130 1131 1132 1133 1134
    if project_members.loaded?
      project_members.find { |member| member.user_id == user.id }
    else
      project_members.find_by(user_id: user)
    end
1135
  end
1136 1137 1138 1139

  def default_branch
    @default_branch ||= repository.root_ref if repository.exists?
  end
1140 1141 1142 1143 1144

  def reload_default_branch
    @default_branch = nil
    default_branch
  end
1145

1146
  def visibility_level_field
1147
    :visibility_level
1148
  end
1149 1150 1151 1152 1153 1154 1155 1156

  def archive!
    update_attribute(:archived, true)
  end

  def unarchive!
    update_attribute(:archived, false)
  end
1157

1158
  def change_head(branch)
1159 1160
    if repository.branch_exists?(branch)
      repository.before_change_head
1161
      repository.write_ref('HEAD', "refs/heads/#{branch}")
1162 1163 1164 1165 1166 1167 1168
      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
1169
  end
1170

1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
  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
1184
  end
1185

1186 1187 1188
  def origin_merge_requests
    merge_requests.where(source_project_id: self.id)
  end
1189

1190
  def ensure_repository
1191
    create_repository(force: true) unless repository_exists?
1192 1193
  end

1194 1195 1196 1197
  def repository_exists?
    !!repository.exists?
  end

1198 1199 1200 1201
  def wiki_repository_exists?
    wiki.repository_exists?
  end

1202
  # update visibility_level of forks
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
  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

1214 1215 1216
  def create_wiki
    ProjectWiki.new(self, self.owner).wiki
    true
G
Guilherme Garnier 已提交
1217
  rescue ProjectWiki::CouldNotCreateWikiError
1218
    errors.add(:base, 'Failed create wiki')
1219 1220
    false
  end
1221

1222 1223 1224 1225
  def wiki
    @wiki ||= ProjectWiki.new(self, self.owner)
  end

D
Drew Blessing 已提交
1226 1227 1228 1229
  def jira_tracker_active?
    jira_tracker? && jira_service.active
  end

1230
  def allowed_to_share_with_group?
1231
    !namespace.share_with_group_lock
1232 1233
  end

1234 1235 1236
  def pipeline_for(ref, sha = nil)
    sha ||= commit(ref).try(:sha)

1237
    return unless sha
1238

1239
    pipelines.order(id: :desc).find_by(sha: sha, ref: ref)
K
Kamil Trzcinski 已提交
1240 1241
  end

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
  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 =
      pipelines.latest_successful_for(default_branch)
  end

  def latest_successful_pipeline_for(ref = nil)
    if ref && ref != default_branch
      pipelines.latest_successful_for(ref)
    else
      latest_successful_pipeline_for_default_branch
    end
  end

1259
  def enable_ci
F
Felipe Artur 已提交
1260
    project_feature.update_attribute(:builds_access_level, ProjectFeature::ENABLED)
1261
  end
M
Marin Jankovski 已提交
1262

1263 1264 1265 1266 1267
  def shared_runners_available?
    shared_runners_enabled?
  end

  def shared_runners
1268
    @shared_runners ||= shared_runners_available? ? Ci::Runner.shared : Ci::Runner.none
1269 1270
  end

1271 1272
  def active_shared_runners
    @active_shared_runners ||= shared_runners.active
1273
  end
K
Kamil Trzcinski 已提交
1274 1275

  def any_runners?(&block)
K
Kamil Trzcinski 已提交
1276
    active_runners.any?(&block) || active_shared_runners.any?(&block)
K
Kamil Trzcinski 已提交
1277 1278
  end

1279
  def valid_runners_token?(token)
J
James Lopez 已提交
1280
    self.runners_token && ActiveSupport::SecurityUtils.variable_size_secure_compare(token, self.runners_token)
K
Kamil Trzcinski 已提交
1281 1282
  end

K
Kamil Trzcinski 已提交
1283 1284 1285 1286 1287 1288 1289
  def build_timeout_in_minutes
    build_timeout / 60
  end

  def build_timeout_in_minutes=(value)
    self.build_timeout = value.to_i * 60
  end
1290

S
Stan Hu 已提交
1291
  def open_issues_count
1292 1293 1294 1295 1296
    Projects::OpenIssuesCountService.new(self).count
  end

  def open_merge_requests_count
    Projects::OpenMergeRequestsCountService.new(self).count
S
Stan Hu 已提交
1297
  end
1298

D
Douwe Maan 已提交
1299
  def visibility_level_allowed_as_fork?(level = self.visibility_level)
D
Douwe Maan 已提交
1300
    return true unless forked?
D
Douwe Maan 已提交
1301

D
Douwe Maan 已提交
1302 1303
    # self.forked_from_project will be nil before the project is saved, so
    # we need to go through the relation
1304
    original_project = forked_project_link&.forked_from_project
D
Douwe Maan 已提交
1305 1306 1307
    return true unless original_project

    level <= original_project.visibility_level
D
Douwe Maan 已提交
1308
  end
1309

D
Douwe Maan 已提交
1310 1311
  def visibility_level_allowed_by_group?(level = self.visibility_level)
    return true unless group
1312

D
Douwe Maan 已提交
1313
    level <= group.visibility_level
M
Marin Jankovski 已提交
1314
  end
1315

D
Douwe Maan 已提交
1316 1317
  def visibility_level_allowed?(level = self.visibility_level)
    visibility_level_allowed_as_fork?(level) && visibility_level_allowed_by_group?(level)
F
Felipe Artur 已提交
1318 1319
  end

1320 1321 1322
  def runners_token
    ensure_runners_token!
  end
V
Valery Sizov 已提交
1323

1324 1325 1326
  def pages_deployed?
    Dir.exist?(public_pages_path)
  end
1327

1328
  def pages_url
1329 1330
    subdomain, _, url_path = full_path.partition('/')

K
Kamil Trzcinski 已提交
1331 1332
    # The hostname always needs to be in downcased
    # All web servers convert hostname to lowercase
1333
    host = "#{subdomain}.#{Settings.pages.host}".downcase
K
Kamil Trzcinski 已提交
1334 1335

    # The host in URL always needs to be downcased
1336
    url = Gitlab.config.pages.url.sub(/^https?:\/\//) do |prefix|
1337
      "#{prefix}#{subdomain}."
K
Kamil Trzcinski 已提交
1338
    end.downcase
1339

K
Kamil Trzcinski 已提交
1340
    # If the project path is the same as host, we serve it as group page
1341 1342 1343 1344
    return url if host == url_path

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

1346 1347
  def pages_subdomain
    full_path.partition('/').first
1348
  end
K
Kamil Trzcinski 已提交
1349 1350

  def pages_path
1351 1352
    # 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 已提交
1353 1354 1355 1356 1357 1358
  end

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

1359 1360 1361 1362
  def pages_available?
    Gitlab.config.pages.enabled && !namespace.subgroup?
  end

1363
  def remove_private_deploy_keys
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
    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
1376 1377
  end

1378
  # TODO: what to do here when not using Legacy Storage? Do we still need to rename and delay removal?
K
Kamil Trzcinski 已提交
1379
  def remove_pages
1380 1381 1382
    # Projects with a missing namespace cannot have their pages removed
    return unless namespace

1383 1384
    ::Projects::UpdatePagesConfigurationService.new(self).execute

1385 1386 1387
    # 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 已提交
1388
    temp_path = "#{path}.#{SecureRandom.hex}.deleted"
K
Kamil Trzcinski 已提交
1389

1390 1391
    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 已提交
1392
    end
K
Kamil Trzcinski 已提交
1393 1394
  end

1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
  def rename_repo
    new_full_path = build_full_path

    Rails.logger.error "Attempting to rename #{full_path_was} -> #{new_full_path}"

    if has_container_registry_tags?
      Rails.logger.error "Project #{full_path_was} cannot be renamed because container registry tags are present!"

      # we currently doesn't support renaming repository if it contains images in container registry
      raise StandardError.new('Project cannot be renamed, because images are present in its container registry')
    end

    expire_caches_before_rename(full_path_was)

    if storage.rename_repo
      Gitlab::AppLogger.info "Project was renamed: #{full_path_was} -> #{new_full_path}"
      rename_repo_notify!
      after_rename_repo
    else
      Rails.logger.error "Repository could not be renamed: #{full_path_was} -> #{new_full_path}"

      # if we cannot move namespace directory we should rollback
      # db changes in order to prevent out of sync between db and fs
      raise StandardError.new('repository cannot be renamed')
    end
  end

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
  def after_rename_repo
    path_before_change = previous_changes['path'].first

    # We need to check if project had been rolled out to move resource to hashed storage or not and decide
    # if we need execute any take action or no-op.

    unless hashed_storage?(:attachments)
      Gitlab::UploadsTransfer.new.rename_project(path_before_change, self.path, namespace.full_path)
    end

    Gitlab::PagesTransfer.new.rename_project(path_before_change, self.path, namespace.full_path)
  end

1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
  def rename_repo_notify!
    send_move_instructions(full_path_was)
    expires_full_path_cache

    self.old_path_with_namespace = full_path_was
    SystemHooksService.new.execute_hooks_for(self, :rename)

    reload_repository!
  end

1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
  def after_import
    repository.after_import
    import_finish
    remove_import_jid
    update_project_counter_caches
  end

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

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

  def remove_import_jid
    return unless import_jid

    Gitlab::SidekiqStatus.unset(import_jid)
    update_column(:import_jid, nil)
  end

J
Josh Frye 已提交
1470 1471
  def running_or_pending_build_count(force: false)
    Rails.cache.fetch(['projects', id, 'running_or_pending_build_count'], force: force) do
1472 1473 1474
      builds.running_or_pending.count(:all)
    end
  end
J
James Lopez 已提交
1475

1476
  # Lazy loading of the `pipeline_status` attribute
1477
  def pipeline_status
1478
    @pipeline_status ||= Gitlab::Cache::Ci::ProjectPipelineStatus.load_for_project(self)
1479 1480
  end

J
James Lopez 已提交
1481
  def mark_import_as_failed(error_message)
1482 1483 1484
    original_errors = errors.dup
    sanitized_message = Gitlab::UrlSanitizer.sanitize(error_message)

J
James Lopez 已提交
1485
    import_fail
1486 1487 1488 1489 1490
    update_column(:import_error, sanitized_message)
  rescue ActiveRecord::ActiveRecordError => e
    Rails.logger.error("Error setting import status to failed: #{e.message}. Original error: #{sanitized_message}")
  ensure
    @errors = original_errors
J
James Lopez 已提交
1491
  end
J
James Lopez 已提交
1492

1493 1494
  def add_export_job(current_user:)
    job_id = ProjectExportWorker.perform_async(current_user.id, self.id)
1495 1496 1497 1498 1499 1500 1501

    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 已提交
1502 1503

  def export_path
1504
    File.join(Gitlab::ImportExport.storage_path, disk_path)
J
James Lopez 已提交
1505
  end
1506 1507 1508 1509 1510 1511 1512 1513 1514

  def export_project_path
    Dir.glob("#{export_path}/*export.tar.gz").max_by { |f| File.ctime(f) }
  end

  def remove_exports
    _, status = Gitlab::Popen.popen(%W(find #{export_path} -not -path #{export_path} -delete))
    status.zero?
  end
1515

V
vanadium23 已提交
1516 1517 1518 1519
  def full_path_slug
    Gitlab::Utils.slugify(full_path.to_s)
  end

K
Kamil Trzcinski 已提交
1520
  def has_ci?
1521
    repository.gitlab_ci_yml || auto_devops_enabled?
K
Kamil Trzcinski 已提交
1522 1523
  end

1524
  def predefined_variables
1525
    [
1526 1527
      { key: 'CI_PROJECT_ID', value: id.to_s, public: true },
      { key: 'CI_PROJECT_NAME', value: path, public: true },
1528
      { key: 'CI_PROJECT_PATH', value: full_path, public: true },
V
vanadium23 已提交
1529
      { key: 'CI_PROJECT_PATH_SLUG', value: full_path_slug, public: true },
1530
      { key: 'CI_PROJECT_NAMESPACE', value: namespace.full_path, public: true },
1531 1532
      { key: 'CI_PROJECT_URL', value: web_url, public: true },
      { key: 'CI_PROJECT_VISIBILITY', value: Gitlab::VisibilityLevel.string_level(visibility_level), public: true }
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
    ]
  end

  def container_registry_variables
    return [] unless Gitlab.config.registry.enabled

    variables = [
      { key: 'CI_REGISTRY', value: Gitlab.config.registry.host_port, public: true }
    ]

K
Kamil Trzcinski 已提交
1543
    if container_registry_enabled?
A
Andre Guedes 已提交
1544
      variables << { key: 'CI_REGISTRY_IMAGE', value: container_registry_url, public: true }
K
Kamil Trzcinski 已提交
1545 1546
    end

1547 1548 1549
    variables
  end

L
Lin Jen-Shin 已提交
1550 1551
  def secret_variables_for(ref:, environment: nil)
    # EE would use the environment
1552 1553 1554 1555 1556 1557
    if protected_for?(ref)
      variables
    else
      variables.unprotected
    end
  end
1558

1559 1560 1561
  def protected_for?(ref)
    ProtectedBranch.protected?(self, ref) ||
      ProtectedTag.protected?(self, ref)
1562
  end
1563

1564
  def deployment_variables
1565
    return [] unless deployment_platform
1566

1567
    deployment_platform.predefined_variables
1568 1569
  end

1570 1571 1572 1573 1574 1575
  def auto_devops_variables
    return [] unless auto_devops_enabled?

    auto_devops&.variables || []
  end

1576
  def append_or_update_attribute(name, value)
1577
    old_values = public_send(name.to_s) # rubocop:disable GitlabSecurity/PublicSend
1578 1579 1580 1581 1582 1583

    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
1584 1585 1586

  rescue ActiveRecord::RecordNotSaved => e
    handle_update_attribute_error(e, value)
1587 1588
  end

Y
Yorick Peterse 已提交
1589
  def pushes_since_gc
1590
    Gitlab::Redis::SharedState.with { |redis| redis.get(pushes_since_gc_redis_shared_state_key).to_i }
Y
Yorick Peterse 已提交
1591 1592 1593
  end

  def increment_pushes_since_gc
1594
    Gitlab::Redis::SharedState.with { |redis| redis.incr(pushes_since_gc_redis_shared_state_key) }
Y
Yorick Peterse 已提交
1595 1596 1597
  end

  def reset_pushes_since_gc
1598
    Gitlab::Redis::SharedState.with { |redis| redis.del(pushes_since_gc_redis_shared_state_key) }
Y
Yorick Peterse 已提交
1599 1600
  end

D
Douwe Maan 已提交
1601
  def route_map_for(commit_sha)
1602 1603
    @route_maps_by_commit ||= Hash.new do |h, sha|
      h[sha] = begin
D
Douwe Maan 已提交
1604
        data = repository.route_map_for(sha)
1605 1606
        next unless data

D
Douwe Maan 已提交
1607 1608 1609
        Gitlab::RouteMap.new(data)
      rescue Gitlab::RouteMap::FormatError
        nil
1610 1611 1612 1613 1614 1615 1616
      end
    end

    @route_maps_by_commit[commit_sha]
  end

  def public_path_for_source_path(path, commit_sha)
D
Douwe Maan 已提交
1617
    map = route_map_for(commit_sha)
1618 1619
    return unless map

D
Douwe Maan 已提交
1620
    map.public_path_for_source_path(path)
1621 1622
  end

1623 1624 1625 1626
  def parent_changed?
    namespace_id_changed?
  end

1627 1628 1629 1630 1631 1632 1633 1634
  def default_merge_request_target
    if forked_from_project&.merge_requests_enabled?
      forked_from_project
    else
      self
    end
  end

F
Felipe Artur 已提交
1635 1636 1637 1638 1639 1640 1641 1642
  def multiple_issue_boards_available?(user)
    feature_available?(:multiple_issue_boards, user)
  end

  def issue_board_milestone_available?(user = nil)
    feature_available?(:issue_board_milestone, user)
  end

1643 1644 1645 1646
  def full_path_was
    File.join(namespace.full_path, previous_changes['path'].first)
  end

1647 1648
  alias_method :name_with_namespace, :full_name
  alias_method :human_name, :full_name
1649
  # @deprecated cannot remove yet because it has an index with its name in elasticsearch
1650 1651
  alias_method :path_with_namespace, :full_path

1652 1653 1654 1655
  def forks_count
    Projects::ForksCountService.new(self).count
  end

1656
  def legacy_storage?
1657 1658 1659
    [nil, 0].include?(self.storage_version)
  end

1660 1661 1662 1663
  # 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)
1664 1665 1666
    raise ArgumentError, "Invalid feature" unless HASHED_STORAGE_FEATURES.include?(feature)

    self.storage_version && self.storage_version >= HASHED_STORAGE_FEATURES[feature]
1667 1668
  end

1669 1670 1671 1672
  def renamed?
    persisted? && path_changed?
  end

1673 1674 1675
  def merge_method
    if self.merge_requests_ff_only_enabled
      :ff
1676 1677
    elsif self.merge_requests_rebase_enabled
      :rebase_merge
1678 1679 1680 1681 1682 1683
    else
      :merge
    end
  end

  def merge_method=(method)
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
    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
1695 1696 1697
  end

  def ff_merge_must_be_possible?
1698
    self.merge_requests_ff_only_enabled || self.merge_requests_rebase_enabled
1699 1700
  end

1701
  def migrate_to_hashed_storage!
1702
    return if hashed_storage?(:repository)
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722

    update!(repository_read_only: true)

    if repo_reference_count > 0 || wiki_reference_count > 0
      ProjectMigrateHashedStorageWorker.perform_in(Gitlab::ReferenceCounter::REFERENCE_EXPIRE_TIME, id)
    else
      ProjectMigrateHashedStorageWorker.perform_async(id)
    end
  end

  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

1723 1724 1725 1726
  def reference_counter(wiki: false)
    Gitlab::ReferenceCounter.new(gl_repository(is_wiki: wiki))
  end

1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
  # Refreshes the expiration time of the associated import job ID.
  #
  # This method can be used by asynchronous importers to refresh the status,
  # preventing the StuckImportJobsWorker from marking the import as failed.
  def refresh_import_jid_expiration
    return unless import_jid

    Gitlab::SidekiqStatus
      .set(import_jid, StuckImportJobsWorker::IMPORT_JOBS_EXPIRATION)
  end

1738 1739
  private

1740 1741
  def storage
    @storage ||=
1742
      if hashed_storage?(:repository)
1743 1744 1745 1746 1747
        Storage::HashedProject.new(self)
      else
        Storage::LegacyProject.new(self)
      end
  end
1748

1749
  def use_hashed_storage
1750
    if self.new_record? && current_application_settings.hashed_storage_enabled
1751
      self.storage_version = LATEST_STORAGE_VERSION
G
Gabriel Mazetto 已提交
1752 1753 1754
    end
  end

1755
  def repo_reference_count
1756
    reference_counter.value
1757 1758 1759
  end

  def wiki_reference_count
1760
    reference_counter(wiki: true).value
1761 1762
  end

1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
  def check_repository_absence!
    return if skip_disk_validation

    if repository_storage_path.blank? || repository_with_same_path_already_exists?
      errors.add(:base, 'There is already a repository with that name on disk')
      throw :abort
    end
  end

  def repository_with_same_path_already_exists?
    gitlab_shell.exists?(repository_storage_path, "#{disk_path}.git")
  end

1776 1777 1778 1779 1780 1781 1782 1783 1784
  # set last_activity_at to the same as created_at
  def set_last_activity_at
    update_column(:last_activity_at, self.created_at)
  end

  def set_last_repository_updated_at
    update_column(:last_repository_updated_at, self.created_at)
  end

1785
  def cross_namespace_reference?(from)
1786 1787 1788 1789 1790
    case from
    when Project
      namespace != from.namespace
    when Namespace
      namespace != from
1791 1792 1793
    end
  end

1794
  # Check if a reference is being done cross-project
1795 1796 1797 1798
  def cross_project_reference?(from)
    return true if from.is_a?(Namespace)

    from && self != from
1799 1800
  end

1801
  def pushes_since_gc_redis_shared_state_key
Y
Yorick Peterse 已提交
1802 1803 1804
    "projects/#{id}/pushes_since_gc"
  end

1805 1806 1807 1808 1809 1810 1811
  # 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.
1812
  def validate_board_limit(board)
1813
    raise BoardLimitExceeded, 'Number of permitted boards exceeded' if boards.size >= NUMBER_OF_PERMITTED_BOARDS
1814
  end
1815

M
Markus Koller 已提交
1816 1817 1818 1819
  def update_project_statistics
    stats = statistics || build_statistics
    stats.update(namespace_id: namespace_id)
  end
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834

  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

1835
    Project.pending_delete.find_by_full_path(full_path)
1836
  end
1837 1838 1839 1840 1841 1842 1843 1844 1845

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

1846
    ContainerRepository.build_root_repository(self).has_tags?
1847
  end
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859

  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
G
gitlabhq 已提交
1860
end