BigW Consortium Gitlab

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

gitlabhq committed
3
class Project < ActiveRecord::Base
4
  include Gitlab::ConfigHelper
5
  include Gitlab::ShellAdapter
6
  include Gitlab::VisibilityLevel
7
  include Gitlab::CurrentSettings
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
17
  include ProjectFeaturesCompatibility
18
  include SelectForProjectAuthorization
19
  include Routable
20
  include GroupDescendant
21
  include Gitlab::SQL::Pattern
Robert Speicher committed
22

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

26
  BoardLimitExceeded = Class.new(StandardError)
27

28
  NUMBER_OF_PERMITTED_BOARDS = 1
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
Jared Szechy committed
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
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 }
53
  default_value_for(:shared_runners_enabled) { current_application_settings.shared_runners_enabled }
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 } }
Kamil Trzcinski committed
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
82

83
  attr_accessor :old_path_with_namespace
84
  attr_accessor :template_name
85
  attr_writer :pipeline_status
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
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
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

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
Ciro Santilli committed
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
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

Shinya Maeda committed
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
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'
215

Kamil Trzcinski committed
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, to: :team
Douwe Maan committed
230
  delegate :empty_repo?, to: :repository
231

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

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

268
  mount_uploader :avatar, AvatarUploader
269
  has_many :uploads, as: :model, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
Andrey Kumanyaev committed
270

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

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

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

282
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
283
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
284
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
285
  scope :starred_by, ->(user) { joins(:users_star_projects).where('users_star_projects.user_id': user.id) }
286
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
287
  scope :archived, -> { where(archived: true) }
288
  scope :non_archived, -> { where(archived: false) }
289
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
290 291
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }

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

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

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

320 321 322 323
  # 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
324 325 326 327
      authorized = user
        .project_authorizations
        .select(1)
        .where('project_authorizations.project_id = projects.id')
328 329 330 331 332 333 334 335 336

      levels = Gitlab::VisibilityLevel.levels_for_user(user)

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

337 338 339
  # 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.
340 341 342 343
  #
  # 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.
344
  def self.with_feature_available_for_user(feature, user)
345 346 347 348 349 350 351
    visible = [nil, ProjectFeature::ENABLED]

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

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

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

365 366
  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) }
367

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

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

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

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

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

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

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

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

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

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

      if Gitlab::ImportSources.importer_names.include?(project.import_type) && project.repo_exists?
        project.run_after_commit do
413
          Projects::AfterImportService.new(project).execute
414 415
        end
      end
416
    end
417 418
  end

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

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

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

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

    def reference_pattern
455
      %r{
456 457
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
458
      }x
459
    end
460

461
    def trending
462 463
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
464
    end
465 466 467 468 469 470

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

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

477 478 479 480 481 482 483
  # 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

484
  def lfs_enabled?
485
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
486

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

490
  def auto_devops_enabled?
491
    if auto_devops&.enabled.nil?
Zeger-Jan van de Weg committed
492
      current_application_settings.auto_devops_enabled?
493 494
    else
      auto_devops.enabled?
Zeger-Jan van de Weg committed
495
    end
496 497
  end

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

502
  def repository_storage_path
503
    Gitlab.config.repositories.storages[repository_storage].try(:[], 'path')
504 505
  end

506
  def team
507
    @team ||= ProjectTeam.new(self)
508 509 510
  end

  def repository
511
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
512 513
  end

514 515 516 517
  def reload_repository!
    @repository = nil
  end

518
  def container_registry_url
Kamil Trzcinski committed
519
    if Gitlab.config.registry.enabled
520
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
521
    end
522 523
  end

524
  def has_container_registry_tags?
525 526 527
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
528
      has_root_container_repository_tags?
529 530
  end

531 532
  def commit(ref = 'HEAD')
    repository.commit(ref)
533 534
  end

535 536 537 538
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

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

    if latest_pipeline
      latest_pipeline.builds.latest.with_artifacts
    else
      builds.none
    end
548 549
  end

550
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan committed
551
    sha = repository.merge_base(first_commit_id, second_commit_id)
552
    commit_by(oid: sha) if sha
553 554
  end

555
  def saved?
556
    id && persisted?
557 558
  end

559
  def add_import_job
Douwe Maan committed
560 561
    job_id =
      if forked?
562 563
        RepositoryForkWorker.perform_async(id,
                                           forked_from_project.repository_storage_path,
564
                                           forked_from_project.disk_path)
Douwe Maan committed
565 566 567
      else
        RepositoryImportWorker.perform_async(self.id)
      end
568

569 570 571 572 573 574 575 576
    log_import_activity(job_id)

    job_id
  end

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

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

584 585 586 587 588
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

589
    update(import_error: nil)
590 591 592 593 594
    remove_import_data
  end

  # This method is overriden in EE::Project model
  def remove_import_data
595
    import_data&.destroy
596 597
  end

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

603
  def import_url=(value)
604 605
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

606
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez committed
607
    super(import_url.sanitized_url)
608
    create_or_update_import_data(credentials: import_url.credentials)
609 610 611
  end

  def import_url
612
    if import_data && super.present?
613
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez committed
614 615 616
      import_url.full_url
    else
      super
617 618
    end
  end
619

James Lopez committed
620
  def valid_import_url?
621
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez committed
622 623
  end

624
  def create_or_update_import_data(data: nil, credentials: nil)
625
    return unless import_url.present? && valid_import_url?
626

James Lopez committed
627
    project_import_data = import_data || build_import_data
628 629 630 631
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
632 633 634 635
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
636
  end
637

638
  def import?
639
    external_import? || forked? || gitlab_project_import?
640 641
  end

642 643 644 645
  def no_import?
    import_status == 'none'
  end

646
  def external_import?
647 648 649
    import_url.present?
  end

650
  def imported?
651 652 653 654
    import_finished?
  end

  def import_in_progress?
655 656 657 658
    import_started? || import_scheduled?
  end

  def import_started?
659 660 661
    import? && import_status == 'started'
  end

662 663 664 665
  def import_scheduled?
    import_status == 'scheduled'
  end

666 667 668 669 670 671
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
672 673
  end

674
  def safe_import_url
675
    Gitlab::UrlSanitizer.new(import_url).masked_url
676 677
  end

678 679 680 681
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

682 683 684 685
  def gitea_import?
    import_type == 'gitea'
  end

686
  def check_limit
Douwe Maan committed
687
    unless creator.can_create_project? || namespace.kind == 'group'
688 689 690
      projects_limit = creator.projects_limit

      if projects_limit == 0
691
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
692
      else
693
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
694
      end
695 696
    end
  rescue
697
    self.errors.add(:base, "Can't check your ability to create project")
gitlabhq committed
698 699
  end

700 701 702 703 704 705 706 707 708 709 710 711 712
  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.")
713 714
  end

715 716 717 718 719 720 721 722 723 724
  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

725
  def to_param
726 727 728 729 730
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
731 732
  end

733
  # `from` argument can be a Namespace or Project.
734 735
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
736
      full_path
737 738 739
    elsif cross_project_reference?(from)
      path
    end
740 741
  end

742 743
  def to_human_reference(from = nil)
    if cross_namespace_reference?(from)
744
      name_with_namespace
745
    elsif cross_project_reference?(from)
746 747
      name
    end
748 749
  end

750
  def web_url
751
    Gitlab::Routing.url_helpers.project_url(self)
752 753
  end

754
  def new_issuable_address(author, address_type)
755
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author
756

757 758
    author.ensure_incoming_email_token!

759
    suffix = address_type == 'merge_request' ? '+merge-request' : ''
760
    Gitlab::IncomingEmail.reply_address(
761
      "#{full_path}#{suffix}+#{author.incoming_email_token}")
762 763
  end

764
  def build_commit_note(commit)
765
    notes.new(commit_id: commit.id, noteable_type: 'Commit')
gitlabhq committed
766
  end
Nihad Abbasov committed
767

768
  def last_activity
769
    last_event
gitlabhq committed
770 771 772
  end

  def last_activity_date
773
    last_repository_updated_at || last_activity_at || updated_at
Dmitriy Zaporozhets committed
774
  end
775

776 777 778
  def project_id
    self.id
  end
randx committed
779

780
  def get_issue(issue_id, current_user)
781 782 783 784 785
    issue = IssuesFinder.new(current_user, project_id: id).find_by(iid: issue_id) if issues_enabled?

    if issue
      issue
    elsif external_issue_tracker
786
      ExternalIssue.new(issue_id, self)
787 788 789
    end
  end

790
  def issue_exists?(issue_id)
791
    get_issue(issue_id)
792 793
  end

794
  def default_issue_tracker
795
    gitlab_issue_tracker_service || create_gitlab_issue_tracker_service
796 797 798 799 800 801 802 803 804 805
  end

  def issues_tracker
    if external_issue_tracker
      external_issue_tracker
    else
      default_issue_tracker
    end
  end

806
  def external_issue_reference_pattern
807
    external_issue_tracker.class.reference_pattern(only_long: issues_enabled?)
808 809
  end

810
  def default_issues_tracker?
811
    !external_issue_tracker
812 813 814
  end

  def external_issue_tracker
815 816 817 818 819 820 821 822 823 824 825 826 827 828
    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
829
    update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) if Gitlab::Database.read_write?
830 831
  end

832 833 834 835
  def has_wiki?
    wiki_enabled? || has_external_wiki?
  end

836 837 838 839 840 841 842 843 844 845 846 847 848
  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
849
    update_column(:has_external_wiki, services.external_wikis.any?) if Gitlab::Database.read_write?
850 851
  end

852
  def find_or_initialize_services(exceptions: [])
853 854
    services_templates = Service.where(template: true)

855 856 857
    available_services_names = Service.available_services_names - exceptions

    available_services_names.map do |service_name|
858
      service = find_service(services, service_name)
859

860 861 862
      if service
        service
      else
863 864 865 866
        # We should check if template for the service exists
        template = find_service(services_templates, service_name)

        if template.nil?
867
          # If no template, we should create an instance. Ex `build_gitlab_ci_service`
868
          public_send("build_#{service_name}_service") # rubocop:disable GitlabSecurity/PublicSend
869
        else
870
          Service.build_from_template(id, template)
871 872
        end
      end
873 874 875
    end
  end

876 877 878 879
  def find_or_initialize_service(name)
    find_or_initialize_services.find { |service| service.to_param == name }
  end

880 881
  def create_labels
    Label.templates.each do |label|
882
      params = label.attributes.except('id', 'template', 'created_at', 'updated_at')
883
      Labels::FindOrCreateService.new(nil, self, params).execute(skip_authorization: true)
884 885 886
    end
  end

887 888 889
  def find_service(list, name)
    list.find { |service| service.to_param == name }
  end
890

891
  def ci_services
892
    services.where(category: :ci)
893 894 895
  end

  def ci_service
896
    @ci_service ||= ci_services.reorder(nil).find_by(active: true)
897 898
  end

899 900
  # TODO: This will be extended for multiple enviroment clusters
  def deployment_platform
Shinya Maeda committed
901
    @deployment_platform ||= clusters.find_by(enabled: true)&.platform_kubernetes
902
    @deployment_platform ||= services.where(category: :deployment).reorder(nil).find_by(active: true)
903 904
  end

905 906 907 908 909
  def monitoring_services
    services.where(category: :monitoring)
  end

  def monitoring_service
910
    @monitoring_service ||= monitoring_services.reorder(nil).find_by(active: true)
911 912
  end

Drew Blessing committed
913 914 915 916
  def jira_tracker?
    issues_tracker.to_param == 'jira'
  end

917
  def avatar_type
918 919
    unless self.avatar.image?
      self.errors.add :avatar, 'only images allowed'
920 921 922 923
    end
  end

  def avatar_in_git
924
    repository.avatar
925 926
  end

927 928 929
  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
930
    avatar_path(args) || (Gitlab::Routing.url_helpers.project_avatar_url(self) if avatar_in_git)
931 932
  end

933 934 935 936 937
  # For compatibility with old code
  def code
    path
  end

938
  def items_for(entity)
939 940 941 942 943 944 945
    case entity
    when 'issue' then
      issues
    when 'merge_request' then
      merge_requests
    end
  end
946

947
  def send_move_instructions(old_path_with_namespace)
948 949 950
    # New project path needs to be committed to the DB or notification will
    # retrieve stale information
    run_after_commit { NotificationService.new.project_was_moved(self, old_path_with_namespace) }
951
  end
952 953

  def owner
954 955
    if group
      group
956
    else
957
      namespace.try(:owner)
958 959
    end
  end
Dmitriy Zaporozhets committed
960

961
  def execute_hooks(data, hooks_scope = :push_hooks)
962
    hooks.public_send(hooks_scope).each do |hook| # rubocop:disable GitlabSecurity/PublicSend
963
      hook.async_execute(data, hooks_scope.to_s)
964
    end
Dmitriy Zaporozhets committed
965 966
  end

967 968
  def execute_services(data, hooks_scope = :push_hooks)
    # Call only service hooks that are active for this scope
969
    services.public_send(hooks_scope).each do |service| # rubocop:disable GitlabSecurity/PublicSend
970
      service.async_execute(data)
Dmitriy Zaporozhets committed
971 972 973 974
    end
  end

  def valid_repo?
975
    repository.exists?
Dmitriy Zaporozhets committed
976
  rescue
977
    errors.add(:path, 'Invalid repository path')
Dmitriy Zaporozhets committed
978 979 980 981
    false
  end

  def repo
Jacob Vosmaer committed
982
    repository.rugged
Dmitriy Zaporozhets committed
983 984 985
  end

  def url_to_repo
986
    gitlab_shell.url_to_repo(full_path)
Dmitriy Zaporozhets committed
987 988 989
  end

  def repo_exists?
990
    @repo_exists ||= repository.exists?
Dmitriy Zaporozhets committed
991 992 993 994 995
  rescue
    @repo_exists = false
  end

  def root_ref?(branch)
996
    repository.root_ref == branch
Dmitriy Zaporozhets committed
997 998 999 1000 1001 1002
  end

  def ssh_url_to_repo
    url_to_repo
  end

1003 1004
  def http_url_to_repo
    "#{web_url}.git"
Dmitriy Zaporozhets committed
1005 1006
  end

1007
  def user_can_push_to_empty_repo?(user)
1008
    !ProtectedBranch.default_branch_protected? || team.max_member_access(user.id) > Gitlab::Access::DEVELOPER
1009 1010
  end

1011
  def forked?
1012 1013 1014 1015 1016
    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
1017 1018
    !(forked_project_link.nil? || forked_project_link.forked_from_project.nil?)
  end
1019

1020 1021 1022 1023
  def fork_source
    forked_from_project || fork_network&.root_project
  end

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
  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

1036 1037 1038 1039
  def personal?
    !group
  end

1040 1041 1042 1043 1044 1045
  # 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?
1046
      repo.before_delete
1047 1048 1049
    end

    if wiki.exists?
1050
      wiki.before_delete
1051 1052 1053
    end
  end

1054
  # Check if repository already exists on disk
1055 1056
  def check_repository_path_availability
    return true if skip_disk_validation
1057 1058 1059 1060
    return false unless repository_storage_path

    expires_full_path_cache # we need to clear cache to validate renames correctly

1061 1062 1063
    # 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?
1064 1065 1066 1067 1068
      errors.add(:base, 'There is already a repository with that name on disk')
      return false
    end

    true
1069 1070
  rescue GRPC::Internal # if the path is too long
    false
1071 1072
  end

1073 1074 1075 1076
  def create_repository(force: false)
    # Forked import is handled asynchronously
    return if forked? && !force

1077
    if gitlab_shell.add_repository(repository_storage, disk_path)
1078 1079 1080 1081 1082 1083 1084 1085
      repository.after_create
      true
    else
      errors.add(:base, 'Failed to create repository via gitlab-shell')
      false
    end
  end

1086 1087
  def hook_attrs(backward: true)
    attrs = {
1088
      id: id,
Kirill Zaitsev committed
1089
      name: name,
1090
      description: description,
Kirilll Zaitsev committed
1091
      web_url: web_url,
1092
      avatar_url: avatar_url(only_path: false),
1093 1094
      git_ssh_url: ssh_url_to_repo,
      git_http_url: http_url_to_repo,
Kirill Zaitsev committed
1095
      namespace: namespace.name,
1096
      visibility_level: visibility_level,
1097
      path_with_namespace: full_path,
1098
      default_branch: default_branch,
1099
      ci_config_path: ci_config_path
Kirill Zaitsev committed
1100
    }
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112

    # 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
Kirill Zaitsev committed
1113 1114
  end

1115
  def project_member(user)
1116 1117 1118 1119 1120
    if project_members.loaded?
      project_members.find { |member| member.user_id == user.id }
    else
      project_members.find_by(user_id: user)
    end
1121
  end
1122 1123 1124 1125

  def default_branch
    @default_branch ||= repository.root_ref if repository.exists?
  end
1126 1127 1128 1129 1130

  def reload_default_branch
    @default_branch = nil
    default_branch
  end
1131

1132
  def visibility_level_field
1133
    :visibility_level
1134
  end
1135 1136 1137 1138 1139 1140 1141 1142

  def archive!
    update_attribute(:archived, true)
  end

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

1144
  def change_head(branch)
1145 1146
    if repository.branch_exists?(branch)
      repository.before_change_head
1147
      repository.write_ref('HEAD', "refs/heads/#{branch}")
1148 1149 1150 1151 1152 1153 1154
      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
1155
  end
1156

1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
  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
1170
  end
1171

1172 1173 1174
  def origin_merge_requests
    merge_requests.where(source_project_id: self.id)
  end
1175

1176
  def ensure_repository
1177
    create_repository(force: true) unless repository_exists?
1178 1179
  end

1180 1181 1182 1183
  def repository_exists?
    !!repository.exists?
  end

1184 1185 1186 1187
  def wiki_repository_exists?
    wiki.repository_exists?
  end

1188
  # update visibility_level of forks
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
  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

1200 1201 1202
  def create_wiki
    ProjectWiki.new(self, self.owner).wiki
    true
1203
  rescue ProjectWiki::CouldNotCreateWikiError
1204
    errors.add(:base, 'Failed create wiki')
1205 1206
    false
  end
1207

1208 1209 1210 1211
  def wiki
    @wiki ||= ProjectWiki.new(self, self.owner)
  end

Drew Blessing committed
1212 1213 1214 1215
  def jira_tracker_active?
    jira_tracker? && jira_service.active
  end

1216
  def allowed_to_share_with_group?
1217
    !namespace.share_with_group_lock
1218 1219
  end

1220 1221 1222
  def pipeline_for(ref, sha = nil)
    sha ||= commit(ref).try(:sha)

1223
    return unless sha
1224

1225
    pipelines.order(id: :desc).find_by(sha: sha, ref: ref)
1226 1227
  end

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
  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

1245
  def enable_ci
1246
    project_feature.update_attribute(:builds_access_level, ProjectFeature::ENABLED)
1247
  end
1248

1249 1250 1251 1252 1253
  def shared_runners_available?
    shared_runners_enabled?
  end

  def shared_runners
1254
    @shared_runners ||= shared_runners_available? ? Ci::Runner.shared : Ci::Runner.none
1255 1256
  end

1257 1258
  def active_shared_runners
    @active_shared_runners ||= shared_runners.active
1259
  end
1260 1261

  def any_runners?(&block)
Kamil Trzcinski committed
1262
    active_runners.any?(&block) || active_shared_runners.any?(&block)
1263 1264
  end

1265
  def valid_runners_token?(token)
1266
    self.runners_token && ActiveSupport::SecurityUtils.variable_size_secure_compare(token, self.runners_token)
Kamil Trzcinski committed
1267 1268
  end

1269 1270 1271 1272 1273 1274 1275
  def build_timeout_in_minutes
    build_timeout / 60
  end

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

1277
  def open_issues_count
1278 1279 1280 1281 1282
    Projects::OpenIssuesCountService.new(self).count
  end

  def open_merge_requests_count
    Projects::OpenMergeRequestsCountService.new(self).count
1283
  end
1284

1285
  def visibility_level_allowed_as_fork?(level = self.visibility_level)
Douwe Maan committed
1286
    return true unless forked?
1287

Douwe Maan committed
1288 1289
    # self.forked_from_project will be nil before the project is saved, so
    # we need to go through the relation
1290
    original_project = forked_project_link&.forked_from_project
Douwe Maan committed
1291 1292 1293
    return true unless original_project

    level <= original_project.visibility_level
1294
  end
1295

1296 1297
  def visibility_level_allowed_by_group?(level = self.visibility_level)
    return true unless group
1298

1299
    level <= group.visibility_level
1300
  end
1301

1302 1303
  def visibility_level_allowed?(level = self.visibility_level)
    visibility_level_allowed_as_fork?(level) && visibility_level_allowed_by_group?(level)
Felipe Artur committed
1304 1305
  end

1306 1307 1308
  def runners_token
    ensure_runners_token!
  end
1309

1310 1311 1312
  def pages_deployed?
    Dir.exist?(public_pages_path)
  end
1313

1314
  def pages_url
1315 1316
    subdomain, _, url_path = full_path.partition('/')

1317 1318
    # The hostname always needs to be in downcased
    # All web servers convert hostname to lowercase
1319
    host = "#{subdomain}.#{Settings.pages.host}".downcase
1320 1321

    # The host in URL always needs to be downcased
1322
    url = Gitlab.config.pages.url.sub(/^https?:\/\//) do |prefix|
1323
      "#{prefix}#{subdomain}."
1324
    end.downcase
1325

1326
    # If the project path is the same as host, we serve it as group page
1327 1328 1329 1330
    return url if host == url_path

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

1332 1333
  def pages_subdomain
    full_path.partition('/').first
1334
  end
Kamil Trzcinski committed
1335 1336

  def pages_path
1337 1338
    # TODO: when we migrate Pages to work with new storage types, change here to use disk_path
    File.join(Settings.pages.path, full_path)
Kamil Trzcinski committed
1339 1340 1341 1342 1343 1344
  end

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

1345 1346 1347 1348
  def pages_available?
    Gitlab.config.pages.enabled && !namespace.subgroup?
  end

1349
  def remove_private_deploy_keys
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
    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
1362 1363
  end

1364
  # TODO: what to do here when not using Legacy Storage? Do we still need to rename and delay removal?
Kamil Trzcinski committed
1365
  def remove_pages
1366 1367 1368
    # Projects with a missing namespace cannot have their pages removed
    return unless namespace

1369 1370
    ::Projects::UpdatePagesConfigurationService.new(self).execute

1371 1372 1373
    # 1. We rename pages to temporary directory
    # 2. We wait 5 minutes, due to NFS caching
    # 3. We asynchronously remove pages with force
Kamil Trzcinski committed
1374
    temp_path = "#{path}.#{SecureRandom.hex}.deleted"
1375

1376 1377
    if Gitlab::PagesTransfer.new.rename_project(path, temp_path, namespace.full_path)
      PagesWorker.perform_in(5.minutes, :remove, namespace.full_path, temp_path)
1378
    end
Kamil Trzcinski committed
1379 1380
  end

1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
  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

1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
  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

1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
  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

1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
  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

Josh Frye committed
1456 1457
  def running_or_pending_build_count(force: false)
    Rails.cache.fetch(['projects', id, 'running_or_pending_build_count'], force: force) do
1458 1459 1460
      builds.running_or_pending.count(:all)
    end
  end
1461

1462
  # Lazy loading of the `pipeline_status` attribute
1463
  def pipeline_status
1464
    @pipeline_status ||= Gitlab::Cache::Ci::ProjectPipelineStatus.load_for_project(self)
1465 1466
  end

1467
  def mark_import_as_failed(error_message)
1468 1469 1470
    original_errors = errors.dup
    sanitized_message = Gitlab::UrlSanitizer.sanitize(error_message)

1471
    import_fail
1472 1473 1474 1475 1476
    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
1477
  end
James Lopez committed
1478

1479 1480
  def add_export_job(current_user:)
    job_id = ProjectExportWorker.perform_async(current_user.id, self.id)
1481 1482 1483 1484 1485 1486 1487

    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
James Lopez committed
1488 1489

  def export_path
1490
    File.join(Gitlab::ImportExport.storage_path, disk_path)
James Lopez committed
1491
  end
1492 1493 1494 1495 1496 1497 1498 1499 1500

  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
1501

1502 1503 1504 1505
  def full_path_slug
    Gitlab::Utils.slugify(full_path.to_s)
  end

1506
  def has_ci?
1507
    repository.gitlab_ci_yml || auto_devops_enabled?
1508 1509
  end

1510
  def predefined_variables
1511
    [
1512 1513
      { key: 'CI_PROJECT_ID', value: id.to_s, public: true },
      { key: 'CI_PROJECT_NAME', value: path, public: true },
1514
      { key: 'CI_PROJECT_PATH', value: full_path, public: true },
1515
      { key: 'CI_PROJECT_PATH_SLUG', value: full_path_slug, public: true },
1516
      { key: 'CI_PROJECT_NAMESPACE', value: namespace.full_path, public: true },
1517 1518
      { key: 'CI_PROJECT_URL', value: web_url, public: true },
      { key: 'CI_PROJECT_VISIBILITY', value: Gitlab::VisibilityLevel.string_level(visibility_level), public: true }
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
    ]
  end

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

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

Kamil Trzcinski committed
1529
    if container_registry_enabled?
1530
      variables << { key: 'CI_REGISTRY_IMAGE', value: container_registry_url, public: true }
Kamil Trzcinski committed
1531 1532
    end

1533 1534 1535
    variables
  end

Lin Jen-Shin committed
1536 1537
  def secret_variables_for(ref:, environment: nil)
    # EE would use the environment
1538 1539 1540 1541 1542 1543
    if protected_for?(ref)
      variables
    else
      variables.unprotected
    end
  end
1544

1545 1546 1547
  def protected_for?(ref)
    ProtectedBranch.protected?(self, ref) ||
      ProtectedTag.protected?(self, ref)
1548
  end
1549

1550
  def deployment_variables
1551
    return [] unless deployment_platform
1552

1553
    deployment_platform.predefined_variables
1554 1555
  end

1556 1557 1558 1559 1560 1561
  def auto_devops_variables
    return [] unless auto_devops_enabled?

    auto_devops&.variables || []
  end

1562
  def append_or_update_attribute(name, value)
1563
    old_values = public_send(name.to_s) # rubocop:disable GitlabSecurity/PublicSend
1564 1565 1566 1567 1568 1569

    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
1570 1571 1572

  rescue ActiveRecord::RecordNotSaved => e
    handle_update_attribute_error(e, value)
1573 1574
  end

1575
  def pushes_since_gc
1576
    Gitlab::Redis::SharedState.with { |redis| redis.get(pushes_since_gc_redis_shared_state_key).to_i }
1577 1578 1579
  end

  def increment_pushes_since_gc
1580
    Gitlab::Redis::SharedState.with { |redis| redis.incr(pushes_since_gc_redis_shared_state_key) }
1581 1582 1583
  end

  def reset_pushes_since_gc
1584
    Gitlab::Redis::SharedState.with { |redis| redis.del(pushes_since_gc_redis_shared_state_key) }
1585 1586
  end

Douwe Maan committed
1587
  def route_map_for(commit_sha)
1588 1589
    @route_maps_by_commit ||= Hash.new do |h, sha|
      h[sha] = begin
Douwe Maan committed
1590
        data = repository.route_map_for(sha)
1591 1592
        next unless data

Douwe Maan committed
1593 1594 1595
        Gitlab::RouteMap.new(data)
      rescue Gitlab::RouteMap::FormatError
        nil
1596 1597 1598 1599 1600 1601 1602
      end
    end

    @route_maps_by_commit[commit_sha]
  end

  def public_path_for_source_path(path, commit_sha)
Douwe Maan committed
1603
    map = route_map_for(commit_sha)
1604 1605
    return unless map

Douwe Maan committed
1606
    map.public_path_for_source_path(path)
1607 1608
  end

1609 1610 1611 1612
  def parent_changed?
    namespace_id_changed?
  end

1613 1614 1615 1616 1617 1618 1619 1620
  def default_merge_request_target
    if forked_from_project&.merge_requests_enabled?
      forked_from_project
    else
      self
    end
  end

1621 1622 1623 1624 1625 1626 1627 1628
  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

1629 1630 1631 1632
  def full_path_was
    File.join(namespace.full_path, previous_changes['path'].first)
  end

1633 1634
  alias_method :name_with_namespace, :full_name
  alias_method :human_name, :full_name
1635
  # @deprecated cannot remove yet because it has an index with its name in elasticsearch
1636 1637
  alias_method :path_with_namespace, :full_path

1638 1639 1640 1641
  def forks_count
    Projects::ForksCountService.new(self).count
  end

1642
  def legacy_storage?
1643 1644 1645
    [nil, 0].include?(self.storage_version)
  end

1646 1647 1648 1649
  # 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)
1650 1651 1652
    raise ArgumentError, "Invalid feature" unless HASHED_STORAGE_FEATURES.include?(feature)

    self.storage_version && self.storage_version >= HASHED_STORAGE_FEATURES[feature]
1653 1654
  end

1655 1656 1657 1658
  def renamed?
    persisted? && path_changed?
  end

1659 1660 1661
  def merge_method
    if self.merge_requests_ff_only_enabled
      :ff
1662 1663
    elsif self.merge_requests_rebase_enabled
      :rebase_merge
1664 1665 1666 1667 1668 1669
    else
      :merge
    end
  end

  def merge_method=(method)
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
    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
1681 1682 1683
  end

  def ff_merge_must_be_possible?
1684
    self.merge_requests_ff_only_enabled || self.merge_requests_rebase_enabled
1685 1686
  end

1687
  def migrate_to_hashed_storage!
1688
    return if hashed_storage?(:repository)
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708

    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

1709 1710 1711 1712
  def reference_counter(wiki: false)
    Gitlab::ReferenceCounter.new(gl_repository(is_wiki: wiki))
  end

1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723
  # 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

1724 1725
  private

1726 1727
  def storage
    @storage ||=
1728
      if hashed_storage?(:repository)
1729 1730 1731 1732 1733
        Storage::HashedProject.new(self)
      else
        Storage::LegacyProject.new(self)
      end
  end
1734

1735
  def use_hashed_storage
1736
    if self.new_record? && current_application_settings.hashed_storage_enabled
1737
      self.storage_version = LATEST_STORAGE_VERSION
1738 1739 1740
    end
  end

1741
  def repo_reference_count
1742
    reference_counter.value
1743 1744 1745
  end

  def wiki_reference_count
1746
    reference_counter(wiki: true).value
1747 1748
  end

1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
  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

1762 1763 1764 1765 1766 1767 1768 1769 1770
  # 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

1771
  def cross_namespace_reference?(from)
1772 1773 1774 1775 1776
    case from
    when Project
      namespace != from.namespace
    when Namespace
      namespace != from
1777 1778 1779
    end
  end

1780
  # Check if a reference is being done cross-project
1781 1782 1783 1784
  def cross_project_reference?(from)
    return true if from.is_a?(Namespace)

    from && self != from
1785 1786
  end

1787
  def pushes_since_gc_redis_shared_state_key
1788 1789 1790
    "projects/#{id}/pushes_since_gc"
  end

1791 1792 1793 1794 1795 1796 1797
  # 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.
1798
  def validate_board_limit(board)
1799
    raise BoardLimitExceeded, 'Number of permitted boards exceeded' if boards.size >= NUMBER_OF_PERMITTED_BOARDS
1800
  end
1801

1802 1803 1804 1805
  def update_project_statistics
    stats = statistics || build_statistics
    stats.update(namespace_id: namespace_id)
  end
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820

  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

1821
    Project.pending_delete.find_by_full_path(full_path)
1822
  end
1823 1824 1825 1826 1827 1828 1829 1830 1831

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

1832
    ContainerRepository.build_root_repository(self).has_tags?
1833
  end
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845

  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
gitlabhq committed
1846
end