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

gitlabhq's avatar
gitlabhq committed
3
class Project < ActiveRecord::Base
4
  include Gitlab::ConfigHelper
5
  include Gitlab::ShellAdapter
6
  include Gitlab::VisibilityLevel
7
  include Gitlab::CurrentSettings
Rémy Coutable's avatar
Rémy Coutable committed
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
Felipe Artur's avatar
Felipe Artur committed
17
  include ProjectFeaturesCompatibility
18
  include SelectForProjectAuthorization
19
  include Routable
20
  include GroupDescendant
Robert Speicher's avatar
Robert Speicher committed
21

22
  extend Gitlab::ConfigHelper
23
  extend Gitlab::CurrentSettings
24

25
  BoardLimitExceeded = Class.new(StandardError)
26

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

39
40
  cache_markdown_field :description, pipeline: :description

41
42
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
           :merge_requests_enabled?, :issues_enabled?, to: :project_feature,
43
                                                       allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
44

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

47
  default_value_for :archived, false
48
  default_value_for :visibility_level, gitlab_config_features.visibility_level
49
  default_value_for :resolve_outdated_diff_discussions, false
50
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
51
  default_value_for(:repository_storage) { current_application_settings.pick_repository_storage }
52
  default_value_for(:shared_runners_enabled) { current_application_settings.shared_runners_enabled }
53
54
55
56
57
  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
58
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
59

60
61
  add_authentication_token_field :runners_token
  before_save :ensure_runners_token
62

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

69
  before_destroy :remove_private_deploy_keys
70
  after_destroy -> { run_after_commit { remove_pages } }
Kamil Trzcinski's avatar
Kamil Trzcinski committed
71

72
73
  after_validation :check_pending_delete

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

80
  acts_as_taggable
81

82
  attr_accessor :old_path_with_namespace
83
  attr_accessor :template_name
84
  attr_writer :pipeline_status
85
  attr_accessor :skip_disk_validation
86

87
88
  alias_attribute :title, :name

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

96
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
97
  has_many :boards, before_add: :validate_board_limit
Felipe Artur's avatar
Felipe Artur committed
98

99
  # Project services
100
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
  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
Matt Coleman's avatar
Matt Coleman committed
131
  has_one :packagist_service
132

133
  # TODO: replace these relations with the fork network versions
134
  has_one  :forked_project_link,  foreign_key: "forked_to_project_id"
135
136
137
138
  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
139
140
141
142
143
144
145
146
  # 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
147

148
  # Merge Requests for target project should be removed with it
149
150
151
152
153
154
155
156
157
158
159
  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
160

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

166
  alias_method :members, :project_members
167
168
  has_many :users, through: :project_members

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

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

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

Shinya Maeda's avatar
Shinya Maeda committed
190
191
  has_one :cluster_project, class_name: 'Clusters::Project'
  has_one :cluster, through: :cluster_project, class_name: 'Clusters::Cluster'
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's avatar
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's avatar
Douwe Maan committed
230
  delegate :empty_repo?, to: :repository
231

Andrey Kumanyaev's avatar
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
    format: { without: /\.{2}/,
237
              message: 'cannot include 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,
Douwe Maan's avatar
Douwe Maan committed
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's avatar
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 }
Douwe Maan's avatar
Douwe Maan committed
261
  validate :visibility_level_allowed_by_group
Douwe Maan's avatar
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

Douwe Maan's avatar
Douwe Maan committed
268
  mount_uploader :avatar, AvatarUploader
269
  has_many :uploads, as: :model, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
Andrey Kumanyaev's avatar
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_hashed_storage, -> { where('storage_version >= 1') }
  scope :with_legacy_storage, -> { where(storage_version: [nil, 0]) }

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

281
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
282
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
283
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
284
  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
285
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
286
  scope :archived, -> { where(archived: true) }
287
  scope :non_archived, -> { where(archived: false) }
288
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
289
290
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }

291
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
292
  scope :with_statistics, -> { includes(:statistics) }
293
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
294
295
296
  scope :inside_path, ->(path) do
    # We need routes alias rs for JOIN so it does not conflict with
    # includes(:route) which we use in ProjectsFinder.
297
298
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
299
  end
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

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

  # Picks a feature where the level is exactly that given.
  scope :with_feature_access_level, ->(feature, level) {
    access_level_attribute = ProjectFeature.access_level_attribute(feature)
    with_project_feature.where(project_features: { access_level_attribute => level })
  }

  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
315
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
316

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

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

      levels = Gitlab::VisibilityLevel.levels_for_user(user)

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

336
337
338
  # project features may be "disabled", "internal" or "enabled". If "internal",
  # they are only available to team members. This scope returns projects where
  # the feature is either enabled, or internal with permission for the user.
339
340
341
342
  #
  # This method uses an optimised version of `with_feature_access_level` for
  # logged in users to more efficiently get private projects with the given
  # feature.
343
  def self.with_feature_available_for_user(feature, user)
344
345
346
347
348
349
350
    visible = [nil, ProjectFeature::ENABLED]

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

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

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

Rémy Coutable's avatar
Rémy Coutable committed
364
365
  scope :active, -> { joins(:issues, :notes, :merge_requests).order('issues.created_at, notes.created_at, merge_requests.created_at DESC') }
  scope :abandoned, -> { where('projects.last_activity_at < ?', 6.months.ago) }
366

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

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

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

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

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

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

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

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

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

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

      if Gitlab::ImportSources.importer_names.include?(project.import_type) && project.repo_exists?
        project.run_after_commit do
Lin Jen-Shin's avatar
Lin Jen-Shin committed
412
          Projects::AfterImportService.new(project).execute
413
414
        end
      end
415
    end
416
417
  end

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
418
  class << self
419
420
421
422
423
424
425
    # Searches for a list of projects based on the query given in `query`.
    #
    # On PostgreSQL this method uses "ILIKE" to perform a case-insensitive
    # search. On MySQL a regular "LIKE" is used as it's already
    # case-insensitive.
    #
    # query - The search query as a String.
426
    def search(query)
427
      ptable  = arel_table
428
429
430
      ntable  = Namespace.arel_table
      pattern = "%#{query}%"

431
432
433
      # unscoping unnecessary conditions that'll be applied
      # when executing `where("projects.id IN (#{union.to_sql})")`
      projects = unscoped.select(:id).where(
434
435
436
        ptable[:path].matches(pattern)
          .or(ptable[:name].matches(pattern))
          .or(ptable[:description].matches(pattern))
437
438
      )

439
440
441
      namespaces = unscoped.select(:id)
        .joins(:namespace)
        .where(ntable[:name].matches(pattern))
442
443
444

      union = Gitlab::SQL::Union.new([projects, namespaces])

445
      where("projects.id IN (#{union.to_sql})") # rubocop:disable GitlabSecurity/SqlInjection
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
446
    end
447

448
    def search_by_title(query)
449
450
451
452
      pattern = "%#{query}%"
      table   = Project.arel_table

      non_archived.where(table[:name].matches(pattern))
453
454
    end

455
456
457
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
458
459

    def sort(method)
460
461
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
462
463
464
        # 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')
465
466
467
468
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
469
470
      else
        order_by(method)
471
472
      end
    end
473
474

    def reference_pattern
475
      %r{
476
477
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
478
      }x
479
    end
480

481
    def trending
482
483
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
484
    end
485
486
487
488
489
490

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

    def group_ids
493
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
494
    end
495
496
  end

497
498
499
500
501
502
503
  # 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

504
  def lfs_enabled?
505
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
506

507
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
508
509
  end

510
  def auto_devops_enabled?
511
    if auto_devops&.enabled.nil?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
512
      current_application_settings.auto_devops_enabled?
513
514
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
515
    end
516
517
  end

518
519
520
521
  def has_auto_devops_implicitly_disabled?
    auto_devops&.enabled.nil? && !current_application_settings.auto_devops_enabled?
  end

522
  def repository_storage_path
523
    Gitlab.config.repositories.storages[repository_storage].try(:[], 'path')
524
525
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
526
  def team
527
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
528
529
530
  end

  def repository
531
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
532
533
  end

534
535
536
537
  def reload_repository!
    @repository = nil
  end

Andre Guedes's avatar
Andre Guedes committed
538
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
539
    if Gitlab.config.registry.enabled
540
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
541
    end
542
543
  end

544
  def has_container_registry_tags?
545
546
547
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
548
      has_root_container_repository_tags?
549
550
  end

551
552
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
553
554
  end

555
556
557
558
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

559
  # ref can't be HEAD, can only be branch/tag name or SHA
560
  def latest_successful_builds_for(ref = default_branch)
561
    latest_pipeline = pipelines.latest_successful_for(ref)
562
563
564
565
566
567

    if latest_pipeline
      latest_pipeline.builds.latest.with_artifacts
    else
      builds.none
    end
568
569
  end

570
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
571
    sha = repository.merge_base(first_commit_id, second_commit_id)
572
    commit_by(oid: sha) if sha
573
574
  end

575
  def saved?
576
    id && persisted?
577
578
  end

579
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
580
581
    job_id =
      if forked?
582
583
584
585
        RepositoryForkWorker.perform_async(id,
                                           forked_from_project.repository_storage_path,
                                           forked_from_project.full_path,
                                           self.namespace.full_path)
Douwe Maan's avatar
Douwe Maan committed
586
587
588
      else
        RepositoryImportWorker.perform_async(self.id)
      end
589

590
591
592
593
594
595
596
597
    log_import_activity(job_id)

    job_id
  end

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

598
    if job_id
599
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
600
    else
601
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
602
    end
603
604
  end

605
606
607
608
609
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

610
    update(import_error: nil)
611
612
613
614
615
    remove_import_data
  end

  # This method is overriden in EE::Project model
  def remove_import_data
616
    import_data&.destroy
617
618
  end

619
  def ci_config_path=(value)
620
    # Strip all leading slashes so that //foo -> foo
Lin Jen-Shin's avatar
Lin Jen-Shin committed
621
    super(value&.sub(%r{\A/+}, '')&.delete("\0"))
622
623
  end

624
  def import_url=(value)
James Lopez's avatar
James Lopez committed
625
626
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

627
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez's avatar
James Lopez committed
628
    super(import_url.sanitized_url)
629
    create_or_update_import_data(credentials: import_url.credentials)
630
631
632
  end

  def import_url
James Lopez's avatar
James Lopez committed
633
    if import_data && super.present?
634
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
635
636
637
      import_url.full_url
    else
      super
638
639
    end
  end
640

James Lopez's avatar
James Lopez committed
641
  def valid_import_url?
642
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
643
644
  end

645
  def create_or_update_import_data(data: nil, credentials: nil)
646
    return unless import_url.present? && valid_import_url?
647

James Lopez's avatar
James Lopez committed
648
    project_import_data = import_data || build_import_data
James Lopez's avatar
James Lopez committed
649
650
651
652
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
653
654
655
656
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
657
  end
658

659
  def import?
660
    external_import? || forked? || gitlab_project_import?
661
662
  end

663
664
665
666
  def no_import?
    import_status == 'none'
  end

667
  def external_import?
668
669
670
    import_url.present?
  end

671
  def imported?
672
673
674
675
    import_finished?
  end

  def import_in_progress?
676
677
678
679
    import_started? || import_scheduled?
  end

  def import_started?
680
681
682
    import? && import_status == 'started'
  end

683
684
685
686
  def import_scheduled?
    import_status == 'scheduled'
  end

687
688
689
690
691
692
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
693
694
  end

695
  def safe_import_url
696
    Gitlab::UrlSanitizer.new(import_url).masked_url
697
698
  end

699
700
701
702
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
703
704
705
706
  def gitea_import?
    import_type == 'gitea'
  end

707
708
709
710
  def github_import?
    import_type == 'github'
  end

711
  def check_limit
Douwe Maan's avatar
Douwe Maan committed
712
    unless creator.can_create_project? || namespace.kind == 'group'
713
714
715
      projects_limit = creator.projects_limit

      if projects_limit == 0
Phil Hughes's avatar
Phil Hughes committed
716
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
717
      else
Phil Hughes's avatar
Phil Hughes committed
718
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
719
      end
720
721
    end
  rescue
Douwe Maan's avatar
Douwe Maan committed
722
    self.errors.add(:base, "Can't check your ability to create project")
gitlabhq's avatar
gitlabhq committed
723
724
  end

Douwe Maan's avatar
Douwe Maan committed
725
726
727
728
729
730
731
732
733
734
735
736
737
  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.")
738
739
  end

740
741
742
743
744
745
746
747
748
749
  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

750
  def to_param
751
752
753
754
755
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
756
757
  end

758
  # `from` argument can be a Namespace or Project.
759
760
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
761
      full_path
762
763
764
    elsif cross_project_reference?(from)
      path
    end
765
766
767
768
769
770
771
772
  end

  def to_human_reference(from_project = nil)
    if cross_namespace_reference?(from_project)
      name_with_namespace
    elsif cross_project_reference?(from_project)
      name
    end
773
774
  end

775
  def web_url
776
    Gitlab::Routing.url_helpers.project_url(self)
777
778
  end

779
  def new_issue_address(author)
780
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author
781

782
783
784
    author.ensure_incoming_email_token!

    Gitlab::IncomingEmail.reply_address(
785
      "#{full_path}+#{author.incoming_email_token}")
786
787
  end

788
  def build_commit_note(commit)
789
    notes.new(commit_id: commit.id, noteable_type: 'Commit')
gitlabhq's avatar
gitlabhq committed
790
  end
Nihad Abbasov's avatar
Nihad Abbasov committed
791

792
  def last_activity
793
    last_event
gitlabhq's avatar
gitlabhq committed
794
795
796
  end

  def last_activity_date
797
    last_repository_updated_at || last_activity_at || updated_at
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
798
  end
799

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
800
801
802
  def project_id
    self.id
  end
randx's avatar
randx committed
803

804
  def get_issue(issue_id, current_user)
805
806
807
808
809
    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
810
      ExternalIssue.new(issue_id, self)
811
812
813
    end
  end

Robert Speicher's avatar
Robert Speicher committed
814
  def issue_exists?(issue_id)
815
    get_issue(issue_id)
Robert Speicher's avatar
Robert Speicher committed
816
817
  end

818
  def default_issue_tracker
819
    gitlab_issue_tracker_service || create_gitlab_issue_tracker_service
820
821
822
823
824
825
826
827
828
829
  end

  def issues_tracker
    if external_issue_tracker
      external_issue_tracker
    else
      default_issue_tracker
    end
  end

830
  def external_issue_reference_pattern
831
    external_issue_tracker.class.reference_pattern(only_long: issues_enabled?)
832
833
  end

834
  def default_issues_tracker?
835
    !external_issue_tracker
836
837
838
  end

  def external_issue_tracker
839
840
841
842
843
844
845
846
847
848
849
850
851
852
    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
853
    update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) if Gitlab::Database.read_write?
854
855
  end

856
857
858
859
  def has_wiki?
    wiki_enabled? || has_external_wiki?
  end

860
861
862
863
864
865
866
867
868
869
870
871
872
  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
873
    update_column(:has_external_wiki, services.external_wikis.any?) if Gitlab::Database.read_write?
874
875
  end

876
  def find_or_initialize_services(exceptions: [])
877
878
    services_templates = Service.where(template: true)

879
880
881
    available_services_names = Service.available_services_names - exceptions

    available_services_names.map do |service_name|
882
      service = find_service(services, service_name)
883

884
885
886
      if service
        service
      else
887
888
889
890
        # We should check if template for the service exists
        template = find_service(services_templates, service_name)

        if template.nil?
891
          # If no template, we should create an instance. Ex `build_gitlab_ci_service`
892
          public_send("build_#{service_name}_service") # rubocop:disable GitlabSecurity/PublicSend
893
        else
894
          Service.build_from_template(id, template)
895
896
        end
      end
897
898
899
    end
  end

900
901
902
903
  def find_or_initialize_service(name)
    find_or_initialize_services.find { |service| service.to_param == name }
  end

Valery Sizov's avatar
Valery Sizov committed
904
905
  def create_labels
    Label.templates.each do |label|