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

Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
3
class Project < ActiveRecord::Base
4
  include Gitlab::ConfigHelper
5
  include Gitlab::ShellAdapter
6
  include Gitlab::VisibilityLevel
Rémy Coutable's avatar
Rémy Coutable committed
7
  include AccessRequestable
8
  include Avatarable
9
  include CacheMarkdownField
10
11
  include Referable
  include Sortable
12
  include AfterCommitQueue
13
  include CaseSensitivity
14
  include TokenAuthenticatable
15
  include ValidAttribute
Felipe Artur's avatar
Felipe Artur committed
16
  include ProjectFeaturesCompatibility
17
  include SelectForProjectAuthorization
18
  include Presentable
19
  include Routable
20
  include GroupDescendant
21
  include Gitlab::SQL::Pattern
22
  include DeploymentPlatform
23
  include ::Gitlab::Utils::StrongMemoize
24
  include ChronicDurationAttribute
25
  include FastDestroyAll::Helpers
Jan Provaznik's avatar
Jan Provaznik committed
26
  include WithUploads
Robert Speicher's avatar
Robert Speicher committed
27

28
  extend Gitlab::ConfigHelper
29

30
  BoardLimitExceeded = Class.new(StandardError)
31

32
  NUMBER_OF_PERMITTED_BOARDS = 1
Douwe Maan's avatar
Douwe Maan committed
33
  UNKNOWN_IMPORT_URL = 'http://unknown.git'.freeze
34
35
  # Hashed Storage versions handle rolling out new storage to project and dependents models:
  # nil: legacy
36
37
38
  # 1: repository
  # 2: attachments
  LATEST_STORAGE_VERSION = 2
39
40
41
42
  HASHED_STORAGE_FEATURES = {
    repository: 1,
    attachments: 2
  }.freeze
Jared Szechy's avatar
Jared Szechy committed
43

44
45
46
  # Valids ports to import from
  VALID_IMPORT_PORTS = [22, 80, 443].freeze

47
48
  cache_markdown_field :description, pipeline: :description

49
50
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
           :merge_requests_enabled?, :issues_enabled?, to: :project_feature,
51
                                                       allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
52

53
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
54

55
  default_value_for :archived, false
56
  default_value_for :visibility_level, gitlab_config_features.visibility_level
57
  default_value_for :resolve_outdated_diff_discussions, false
58
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
59
60
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
61
62
63
64
65
  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
66
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
67

68
  add_authentication_token_field :runners_token
69

70
  before_validation :mark_remote_mirrors_for_removal, if: -> { ActiveRecord::Base.connection.table_exists?(:remote_mirrors) }
71

72
73
  before_save :ensure_runners_token

Markus Koller's avatar
Markus Koller committed
74
  after_save :update_project_statistics, if: :namespace_id_changed?
75
76
77

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

78
  after_create :create_project_feature, unless: :project_feature
79
80
81
82
83

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

84
  after_create :set_last_activity_at
85
  after_create :set_last_repository_updated_at
86
  after_update :update_forks_visibility_level
87

88
  before_destroy :remove_private_deploy_keys
89

90
  use_fast_destroy :build_trace_chunks
91

92
  after_destroy -> { run_after_commit { remove_pages } }
93
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
94

95
96
  after_validation :check_pending_delete

97
  # Storage specific hooks
98
  after_initialize :use_hashed_storage
99
  after_create :check_repository_absence!
100
101
  after_create :ensure_storage_path_exists
  after_save :ensure_storage_path_exists, if: :namespace_id_changed?
102

103
  acts_as_taggable
104

105
  attr_accessor :old_path_with_namespace
106
  attr_accessor :template_name
107
  attr_writer :pipeline_status
108
  attr_accessor :skip_disk_validation
109

110
111
  alias_attribute :title, :name

112
  # Relations
113
  belongs_to :creator, class_name: 'User'
114
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
115
  belongs_to :namespace
116
117
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
118

119
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
120
  has_many :boards, before_add: :validate_board_limit
121
122

  # Project services
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
  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
148
  has_one :kubernetes_service, inverse_of: :project
149
150
151
152
153
  has_one :prometheus_service, inverse_of: :project
  has_one :mock_ci_service
  has_one :mock_deployment_service
  has_one :mock_monitoring_service
  has_one :microsoft_teams_service
Matt Coleman's avatar
Matt Coleman committed
154
  has_one :packagist_service
155

156
  # TODO: replace these relations with the fork network versions
157
  has_one  :forked_project_link,  foreign_key: "forked_to_project_id"
158
  has_one  :forked_from_project,  through:   :forked_project_link
159

160
161
  has_many :forked_project_links, foreign_key: "forked_from_project_id"
  has_many :forks,                through:     :forked_project_links, source: :forked_to_project
162
163
164
165
166
167
168
169
  # 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
170

171
172
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project

173
  # Merge Requests for target project should be removed with it
174
  has_many :merge_requests, foreign_key: 'target_project_id'
175
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
176
177
178
179
180
181
182
183
184
185
  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
186

187
  has_many :project_authorizations
188
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
189
  has_many :project_members, -> { where(requested_at: nil) },
190
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
191

192
  alias_method :members, :project_members
193
194
  has_many :users, through: :project_members

195
  has_many :requesters, -> { where.not(requested_at: nil) },
196
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
197
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
198

199
  has_many :deploy_keys_projects
200
  has_many :deploy_keys, through: :deploy_keys_projects
201
  has_many :users_star_projects
Ciro Santilli's avatar
Ciro Santilli committed
202
  has_many :starrers, through: :users_star_projects, source: :user
203
  has_many :releases
204
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
Marin Jankovski's avatar
Marin Jankovski committed
205
  has_many :lfs_objects, through: :lfs_objects_projects
206
  has_many :lfs_file_locks
207
  has_many :project_group_links
208
  has_many :invited_groups, through: :project_group_links, source: :group
209
210
  has_many :pages_domains
  has_many :todos
211
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
212

213
214
  has_many :internal_ids

215
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
216
  has_one :project_feature, inverse_of: :project
217
  has_one :statistics, class_name: 'ProjectStatistics'
218

Shinya Maeda's avatar
Shinya Maeda committed
219
  has_one :cluster_project, class_name: 'Clusters::Project'
220
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
221
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
222

223
224
225
  # 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.
226
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
227

228
  has_many :commit_statuses
229
  has_many :pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
230
231
232
233
234

  # 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.
235
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
236
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
237
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
238
  has_many :runner_projects, class_name: 'Ci::RunnerProject'
239
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
240
  has_many :variables, class_name: 'Ci::Variable'
241
242
243
244
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
  has_many :deployments
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
245
246
  has_many :project_deploy_tokens
  has_many :deploy_tokens, through: :project_deploy_tokens
247

248
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
249
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
250

251
  has_many :project_badges, class_name: 'ProjectBadge'
252
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
253

254
255
  has_many :remote_mirrors, inverse_of: :project

256
  accepts_nested_attributes_for :variables, allow_destroy: true
257
  accepts_nested_attributes_for :project_feature, update_only: true
258
  accepts_nested_attributes_for :import_data
259
  accepts_nested_attributes_for :auto_devops, update_only: true
260

261
262
263
264
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

265
  delegate :name, to: :owner, allow_nil: true, prefix: true
266
  delegate :members, to: :team, prefix: true
267
  delegate :add_user, :add_users, to: :team
268
  delegate :add_guest, :add_reporter, :add_developer, :add_master, :add_role, to: :team
269
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
270

271
  # Validations
272
  validates :creator, presence: true, on: :create
273
  validates :description, length: { maximum: 2000 }, allow_blank: true
274
  validates :ci_config_path,
275
    format: { without: %r{(\.{2}|\A/)},
276
              message: 'cannot include leading slash or directory traversal.' },
277
278
    length: { maximum: 255 },
    allow_blank: true
279
280
  validates :name,
    presence: true,
281
    length: { maximum: 255 },
282
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
283
              message: Gitlab::Regex.project_name_regex_message }
284
285
  validates :path,
    presence: true,
286
    project_path: true,
287
    length: { maximum: 255 }
288

289
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
290
  validates :name, uniqueness: { scope: :namespace_id }
291
  validates :import_url, addressable_url: true, if: :external_import?
292
  validates :import_url, importable_url: true, if: [:external_import?, :import_url_changed?]
293
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
294
  validate :check_limit, on: :create
295
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
Douwe Maan's avatar
Douwe Maan committed
296
  validate :visibility_level_allowed_by_group
Douwe Maan's avatar
Douwe Maan committed
297
  validate :visibility_level_allowed_as_fork
298
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
299
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
300
301
302
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
303
  validates :variables, variable_duplicates: { scope: :environment_scope }
304

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
305
  # Scopes
306
  scope :pending_delete, -> { where(pending_delete: true) }
307
  scope :without_deleted, -> { where(pending_delete: false) }
308

309
310
311
  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) }
312

313
314
  # last_activity_at is throttled every minute, but last_repository_updated_at is updated with every push
  scope :sorted_by_activity, -> { reorder("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC") }
315
316
  scope :sorted_by_stars, -> { reorder('projects.star_count DESC') }

317
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
318
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
319
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
320
  scope :starred_by, ->(user) { joins(:users_star_projects).where('users_star_projects.user_id': user.id) }
Rémy Coutable's avatar
Rémy Coutable committed
321
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
322
  scope :archived, -> { where(archived: true) }
323
  scope :non_archived, -> { where(archived: false) }
324
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
325
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
326
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
327
  scope :with_statistics, -> { includes(:statistics) }
328
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
329
330
331
  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.
332
333
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
334
  end
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349

  # "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) }
350
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
351
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
352
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
353

354
355
356
357
358
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

359
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
360

361
  chronic_duration_attr :build_timeout_human_readable, :build_timeout, default: 3600
362
363
364
365
366

  validates :build_timeout, allow_nil: true,
                            numericality: { greater_than_or_equal_to: 600,
                                            message: 'needs to be at least 10 minutes' }

367
368
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
369
370
  def self.public_or_visible_to_user(user = nil)
    if user
371
372
373
      where('EXISTS (?) OR projects.visibility_level IN (?)',
            user.authorizations_for_projects,
            Gitlab::VisibilityLevel.levels_for_user(user))
374
    else
375
      public_to_user
376
377
378
    end
  end

379
380
381
  # 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.
382
383
384
385
  #
  # 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.
386
  def self.with_feature_available_for_user(feature, user)
387
    visible = [nil, ProjectFeature::ENABLED]
388

389
390
391
392
    if user&.admin?
      with_feature_enabled(feature)
    elsif user
      column = ProjectFeature.quoted_access_level_column(feature)
393

394
395
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
396
397
              visible,
              ProjectFeature::PRIVATE,
398
              user.authorizations_for_projects)
399
400
401
    else
      with_feature_access_level(feature, visible)
    end
402
  end
Felipe Artur's avatar
Felipe Artur committed
403

Rémy Coutable's avatar
Rémy Coutable committed
404
405
  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) }
406

407
408
  scope :excluding_project, ->(project) { where.not(id: project) }

409
410
  scope :joins_import_state, -> { joins("LEFT JOIN project_mirror_data import_state ON import_state.project_id = projects.id") }
  scope :import_started, -> { joins_import_state.where("import_state.status = 'started' OR projects.import_status = 'started'") }
411

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
412
  class << self
413
414
415
416
417
418
419
    # 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.
420
    def search(query)
421
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
422
423
    end

424
    def search_by_title(query)
425
      non_archived.fuzzy_search(query, [:name])
426
427
    end

428
429
430
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
431

432
    def sort_by_attribute(method)
433
434
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
435
436
437
        # 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')
438
439
440
441
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
442
443
      else
        order_by(method)
444
445
      end
    end
446
447

    def reference_pattern
448
      %r{
449
450
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
451
      }x
452
    end
453

454
    def trending
455
456
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
457
    end
458
459
460
461
462
463

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

    def group_ids
466
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
467
    end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
468
469
  end

470
471
472
473
474
475
476
  # 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

477
  def lfs_enabled?
478
479
480
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?

    self[:lfs_enabled] && Gitlab.config.lfs.enabled
481
482
  end

483
  def auto_devops_enabled?
484
    if auto_devops&.enabled.nil?
485
      Gitlab::CurrentSettings.auto_devops_enabled?
486
    else
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
487
488
      auto_devops.enabled?
    end
489
490
  end

491
  def has_auto_devops_implicitly_disabled?
492
    auto_devops&.enabled.nil? && !Gitlab::CurrentSettings.auto_devops_enabled?
493
494
  end

495
496
497
498
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
499
  def team
500
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
501
502
503
  end

  def repository
504
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
505
506
  end

507
508
  def cleanup
    @repository&.cleanup
509
510
511
    @repository = nil
  end

512
513
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
514
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
515
    if Gitlab.config.registry.enabled
516
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
517
    end
518
519
  end

520
  def has_container_registry_tags?
521
522
523
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
524
      has_root_container_repository_tags?
525
526
  end

527
528
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
529
530
  end

531
532
533
534
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

535
  # ref can't be HEAD, can only be branch/tag name or SHA
536
  def latest_successful_builds_for(ref = default_branch)
537
    latest_pipeline = pipelines.latest_successful_for(ref)
538
539

    if latest_pipeline
540
      latest_pipeline.builds.latest.with_artifacts_archive
541
542
543
    else
      builds.none
    end
544
545
  end

546
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
547
    sha = repository.merge_base(first_commit_id, second_commit_id)
548
    commit_by(oid: sha) if sha
549
550
  end

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
551
  def saved?
552
    id && persisted?
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
553
554
  end

555
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
556
557
    job_id =
      if forked?
558
        RepositoryForkWorker.perform_async(id)
559
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
560
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
561
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
562
563
564
      else
        RepositoryImportWorker.perform_async(self.id)
      end
565

566
567
568
569
570
571
572
573
    log_import_activity(job_id)

    job_id
  end

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

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

581
  def reset_cache_and_import_attrs
582
583
584
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end
585

586
    update(import_error: nil)
587
588
589
590
591
    remove_import_data
  end

  # This method is overriden in EE::Project model
  def remove_import_data
592
    import_data&.destroy
593
594
  end

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

600
  def import_url=(value)
James Lopez's avatar
James Lopez committed
601
602
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

603
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez's avatar
James Lopez committed
604
    super(import_url.sanitized_url)
605
    create_or_update_import_data(credentials: import_url.credentials)
606
607
608
  end

  def import_url
James Lopez's avatar
James Lopez committed
609
    if import_data && super.present?
610
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
611
612
613
      import_url.full_url
    else
      super
614
615
616
    end
  end

James Lopez's avatar
James Lopez committed
617
  def valid_import_url?
618
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
619
620
  end

621
  def create_or_update_import_data(data: nil, credentials: nil)
622
    return if data.nil? && credentials.nil?
623

624
    project_import_data = import_data || build_import_data
James Lopez's avatar
James Lopez committed
625
626
627
628
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
629

630
631
632
633
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
634
635
  end

636
  def import?
James Lopez's avatar
James Lopez committed
637
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
638
639
640
  end

  def external_import?
641
642
643
    import_url.present?
  end

644
  def imported?
645
646
647
648
    import_finished?
  end

  def import_in_progress?
649
650
651
    import_started? || import_scheduled?
  end

652
653
654
655
656
657
658
659
  def import_state_args
    {
      status: self[:import_status],
      jid: self[:import_jid],
      last_error: self[:import_error]
    }
  end

660
661
  def ensure_import_state(force: false)
    return if !force && (self[:import_status] == 'none' || self[:import_status].nil?)
662
663
    return unless import_state.nil?

664
665
    if persisted?
      create_import_state(import_state_args)
666

667
668
669
670
671
672
      update_column(:import_status, 'none')
    else
      build_import_state(import_state_args)

      self[:import_status] = 'none'
    end
673
674
675
  end

  def import_schedule
676
    ensure_import_state(force: true)
677

678
    import_state.schedule
679
680
681
  end

  def force_import_start
682
    ensure_import_state(force: true)
683

684
    import_state.force_start
685
686
687
  end

  def import_start
688
    ensure_import_state(force: true)
689

690
    import_state.start
691
692
693
  end

  def import_fail
694
    ensure_import_state(force: true)
695

696
    import_state.fail_op
697
698
699
  end

  def import_finish
700
    ensure_import_state(force: true)
701

702
    import_state.finish
703
704
705
  end

  def import_jid=(new_jid)
706
    ensure_import_state(force: true)
707

708
    import_state.jid = new_jid
709
710
711
712
713
714
715
716
717
  end

  def import_jid
    ensure_import_state

    import_state&.jid
  end

  def import_error=(new_error)
718
    ensure_import_state(force: true)
719

720
    import_state.last_error = new_error
721
722
723
724
725
726
727
728
729
  end

  def import_error
    ensure_import_state

    import_state&.last_error
  end

  def import_status=(new_status)
730
    ensure_import_state(force: true)
731

732
    import_state.status = new_status
733
734
735
736
737
738
739
740
741
742
743
744
  end

  def import_status
    ensure_import_state

    import_state&.status || 'none'
  end

  def no_import?
    import_status == 'none'
  end

745
  def import_started?
746
747
    # import? does SQL work so only run it if it looks like there's an import running
    import_status == 'started' && import?
748
749
  end

750
751
752
753
  def import_scheduled?
    import_status == 'scheduled'
  end

754
755
756
757
758
759
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
760
761
  end

762
  def safe_import_url
763
    Gitlab::UrlSanitizer.new(import_url).masked_url
764
765
  end

766
767
768
769
  def bare_repository_import?
    import_type == 'bare_repository'
  end

770
771
772
773
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
774
775
776
777
  def gitea_import?
    import_type == 'gitea'
  end

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

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

  def update_remote_mirrors
    return unless remote_mirror_available?

    remote_mirrors.enabled.each(&:sync)
  end

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

  def mark_remote_mirrors_for_removal
    remote_mirrors.each(&:mark_for_delete_if_blank_url)
  end

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

809
  def check_limit
Douwe Maan's avatar
Douwe Maan committed
810
    unless creator.can_create_project? || namespace.kind == 'group'
811
812
813
      projects_limit = creator.projects_limit

      if projects_limit == 0
Phil Hughes's avatar
Phil Hughes committed
814
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
815
      else
Phil Hughes's avatar
Phil Hughes committed
816
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
817
      end
818
819
    end
  rescue
Douwe Maan's avatar
Douwe Maan committed
820
    self.errors.add(:base, "Can't check your ability to create project")
821
822
  end

Douwe Maan's avatar
Douwe Maan committed
823
824
825
826
827
828
829
830
831
832
833
834
835
  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.")
836
837
  end

838
839
840
841
842
843
844
845
846
847
  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

Rob Watson's avatar
Rob Watson committed
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
  def pages_https_only
    return false unless Gitlab.config.pages.external_https

    super
  end

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

    super
  end

  def validate_pages_https_only
    return unless pages_https_only?

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

Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
868
  def to_param
869
870
871
872
873
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
874
875
  end

876
  # `from` argument can be a Namespace or Project.
877
878
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
879
      full_path
880
    elsif cross_project_reference?(from)
881
882
883
884
      path
    end
  end

885
886
  def to_human_reference(from = nil)
    if cross_namespace_reference?(from)
887
      name_with_namespace
888
    elsif cross_project_reference?(from)
889
890
      name
    end
891
892
  end

893
  def web_url
894
    Gitlab::Routing.url_helpers.project_url(self)
895
896
  end

897
  def new_issuable_address(author, address_type)
898
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author
899

900
901
    author.ensure_incoming_email_token!

902
    suffix = address_type == 'merge_request' ? '+merge-request' : ''
903
    Gitlab::IncomingEmail.reply_address(
904
      "#{full_path}#{suffix}+#{author.incoming_email_token}")
905
906
  end

907
  def build_commit_note(commit)
908
    notes.new(commit_id: commit.id, noteable_type: 'Commit')
Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
909
  end
Nihad Abbasov's avatar
Nihad Abbasov committed
910

911
  def last_activity
912
    last_event
gitlabhq's avatar
gitlabhq committed
913
914
915
  end

  def last_activity_date
916
    [last_activity_at, last_repository_updated_at, updated_at].compact.max
gitlabhq's avatar
gitlabhq committed
917
918
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
919
920
921
  def project_id
    self.id
  end
randx's avatar
randx committed
922

923
  def get_issue(issue_id, current_user)
924
925
926
927
928
    issue = IssuesFinder.new(current_user, project_id: id).find_by(iid: issue_id) if issues_enabled?

    if issue
      issue
    elsif external_issue_tracker
Robert Speicher's avatar
Robert Speicher committed
929
      ExternalIssue.new(issue_id, self)
930
931
932
    end
  end

Robert Speicher's avatar
Robert Speicher committed
933
  def issue_exists?(issue_id)
934
    get_issue(issue_id)
Robert Speicher's avatar
Robert Speicher committed
935
936
  end

937
  def default_issue_tracker
938
    gitlab_issue_tracker_service || create_gitlab_issue_tracker_service
939
940
941
942
943
944
945
946
947
948
  end

  def issues_tracker
    if external_issue_tracker
      external_issue_tracker
    else
      default_issue_tracker
    end
  end

949
  def external_issue_reference_pattern
950
    external_issue_tracker.class.reference_pattern(only_long: issues_enabled?)
951
952
  end

953
  def default_issues_tracker?
954
    !external_issue_tracker
955
956
957
  end

  def external_issue_tracker
958
959
960
961
962
963
964
965
966
967
968
969
970
971
    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
Toon Claes's avatar
Toon Claes committed
972
    update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) if Gitlab::Database.read_write?
973
974
  end

975
976
977
978
  def has_wiki?
    wiki_enabled? || has_external_wiki?
  end

979
980
981
982
983
984
985
986
987
988
989
990
991
  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
Toon Claes's avatar
Toon Claes committed
992
    update_column(:has_external_wiki, services.external_wikis.any?) if Gitlab::Database.read_write?
993
994
  end

995
  def find_or_initialize_services(exceptions: [])
996
997
    services_templates = Service.where(template: true)

998
999
    available_services_names = Service.available_services_names - exceptions

1000
    available_services = available_services_names.map do |service_name|
1001
      service = find_service(services, service_name)
1002

1003
1004
1005
      if service
        service
      else
1006
1007
1008
1009
        # We should check if template for the service exists
        template = find_service(services_templates, service_name)

        if template.nil?
1010
          # If no template, we should create an instance. Ex `build_gitlab_ci_service`
1011
          public_send("build_#{service_name}_service") # rubocop:disable GitlabSecurity/PublicSend
1012
        else