project.rb 62.9 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
27
  include BatchDestroyDependentAssociations
28
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
29

30
  extend Gitlab::ConfigHelper
31

32
  BoardLimitExceeded = Class.new(StandardError)
33

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

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

49
50
  cache_markdown_field :description, pipeline: :description

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

55
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
56

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

70
  add_authentication_token_field :runners_token
71

72
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
73

74
75
  before_save :ensure_runners_token

Markus Koller's avatar
Markus Koller committed
76
  after_save :update_project_statistics, if: :namespace_id_changed?
77
78
79

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

80
  after_create :create_project_feature, unless: :project_feature
81
82
83
84
85

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

86
  after_create :set_last_activity_at
87
  after_create :set_last_repository_updated_at
88
  after_update :update_forks_visibility_level
89

90
  before_destroy :remove_private_deploy_keys
91

92
  use_fast_destroy :build_trace_chunks
93

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

97
98
  after_validation :check_pending_delete

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

105
  acts_as_taggable
106

107
  attr_accessor :old_path_with_namespace
108
  attr_accessor :template_name
109
  attr_writer :pipeline_status
110
  attr_accessor :skip_disk_validation
111

112
113
  alias_attribute :title, :name

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

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

  # Project services
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
  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
150
  has_one :kubernetes_service, inverse_of: :project
151
152
153
154
155
  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
156
  has_one :packagist_service
157

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

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

173
174
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project

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

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

194
  alias_method :members, :project_members
195
196
  has_many :users, through: :project_members

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

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

215
216
  has_many :internal_ids

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

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

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

230
  has_many :commit_statuses
231
  has_many :pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
232
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
233
234
235
236
237

  # 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.
238
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
239
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
240
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
241
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
242
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
243
  has_many :variables, class_name: 'Ci::Variable'
244
245
246
247
  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
248
249
  has_many :project_deploy_tokens
  has_many :deploy_tokens, through: :project_deploy_tokens
250

251
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
252
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
253

254
  has_many :project_badges, class_name: 'ProjectBadge'
255
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
256

257
258
  has_many :remote_mirrors, inverse_of: :project

259
  accepts_nested_attributes_for :variables, allow_destroy: true
260
  accepts_nested_attributes_for :project_feature, update_only: true
261
  accepts_nested_attributes_for :import_data
262
  accepts_nested_attributes_for :auto_devops, update_only: true
263

264
265
266
267
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

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

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

292
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
293
  validates :name, uniqueness: { scope: :namespace_id }
294
295
  validates :import_url, url: { protocols: %w(http https ssh git),
                                allow_localhost: false,
296
                                enforce_user: true,
297
                                ports: VALID_IMPORT_PORTS }, if: [:external_import?, :import_url_changed?]
298
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
299
  validate :check_limit, on: :create
300
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
Douwe Maan's avatar
Douwe Maan committed
301
  validate :visibility_level_allowed_by_group
Douwe Maan's avatar
Douwe Maan committed
302
  validate :visibility_level_allowed_as_fork
303
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
304
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
305
306
307
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
308
  validates :variables, variable_duplicates: { scope: :environment_scope }
309

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
310
  # Scopes
311
  scope :pending_delete, -> { where(pending_delete: true) }
312
  scope :without_deleted, -> { where(pending_delete: false) }
313

314
315
316
  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) }
317

318
319
  # 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") }
320
321
  scope :sorted_by_stars, -> { reorder('projects.star_count DESC') }

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

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

359
360
361
362
363
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

364
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
365

366
  chronic_duration_attr :build_timeout_human_readable, :build_timeout, default: 3600
367
368
369
370
371

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

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

384
385
386
  # 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.
387
388
389
390
  #
  # 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.
391
  def self.with_feature_available_for_user(feature, user)
392
    visible = [nil, ProjectFeature::ENABLED]
393

394
395
396
397
    if user&.admin?
      with_feature_enabled(feature)
    elsif user
      column = ProjectFeature.quoted_access_level_column(feature)
398

399
400
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
401
402
              visible,
              ProjectFeature::PRIVATE,
403
              user.authorizations_for_projects)
404
405
406
    else
      with_feature_access_level(feature, visible)
    end
407
  end
Felipe Artur's avatar
Felipe Artur committed
408

Rémy Coutable's avatar
Rémy Coutable committed
409
410
  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) }
411

412
413
  scope :excluding_project, ->(project) { where.not(id: project) }

414
415
  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'") }
416

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

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

433
434
435
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
436

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

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

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

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

    def group_ids
471
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
472
    end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
473
474
  end

475
476
477
478
479
480
481
  # 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

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

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

488
  def auto_devops_enabled?
489
    if auto_devops&.enabled.nil?
490
      Gitlab::CurrentSettings.auto_devops_enabled?
491
    else
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
492
493
      auto_devops.enabled?
    end
494
495
  end

496
  def has_auto_devops_implicitly_disabled?
497
    auto_devops&.enabled.nil? && !Gitlab::CurrentSettings.auto_devops_enabled?
498
499
  end

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

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
504
  def team
505
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
506
507
508
  end

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

512
513
  def cleanup
    @repository&.cleanup
514
515
516
    @repository = nil
  end

517
518
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
519
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
520
    if Gitlab.config.registry.enabled
521
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
522
    end
523
524
  end

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

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

532
533
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
534
535
  end

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

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

    if latest_pipeline
545
      latest_pipeline.builds.latest.with_artifacts_archive
546
547
548
    else
      builds.none
    end
549
550
  end

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

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
556
  def saved?
557
    id && persisted?
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
558
559
  end

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

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

    job_id
  end

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

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

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

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

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

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

605
  def import_url=(value)
James Lopez's avatar
James Lopez committed
606
607
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

608
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez's avatar
James Lopez committed
609
    super(import_url.sanitized_url)
610
    create_or_update_import_data(credentials: import_url.credentials)
611
612
613
  end

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

James Lopez's avatar
James Lopez committed
622
  def valid_import_url?
623
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
624
625
  end

626
  def create_or_update_import_data(data: nil, credentials: nil)
627
    return if data.nil? && credentials.nil?
628

629
    project_import_data = import_data || build_import_data
James Lopez's avatar
James Lopez committed
630
631
632
633
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
634

635
636
637
638
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
639
640
  end

641
  def import?
James Lopez's avatar
James Lopez committed
642
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
643
644
645
  end

  def external_import?
646
647
648
    import_url.present?
  end

649
  def imported?
650
651
652
653
    import_finished?
  end

  def import_in_progress?
654
655
656
    import_started? || import_scheduled?
  end

657
658
659
660
661
662
663
664
  def import_state_args
    {
      status: self[:import_status],
      jid: self[:import_jid],
      last_error: self[:import_error]
    }
  end

665
666
  def ensure_import_state(force: false)
    return if !force && (self[:import_status] == 'none' || self[:import_status].nil?)
667
668
    return unless import_state.nil?

669
670
    if persisted?
      create_import_state(import_state_args)
671

672
673
674
675
676
677
      update_column(:import_status, 'none')
    else
      build_import_state(import_state_args)

      self[:import_status] = 'none'
    end
678
679
  end

680
681
682
683
684
685
  def human_import_status_name
    ensure_import_state

    import_state.human_status_name
  end

686
  def import_schedule
687
    ensure_import_state(force: true)
688

689
    import_state.schedule
690
691
692
  end

  def force_import_start
693
    ensure_import_state(force: true)
694

695
    import_state.force_start
696
697
698
  end

  def import_start
699
    ensure_import_state(force: true)
700

701
    import_state.start
702
703
704
  end

  def import_fail
705
    ensure_import_state(force: true)
706

707
    import_state.fail_op
708
709
710
  end

  def import_finish
711
    ensure_import_state(force: true)
712

713
    import_state.finish
714
715
716
  end

  def import_jid=(new_jid)
717
    ensure_import_state(force: true)
718

719
    import_state.jid = new_jid
720
721
722
723
724
725
726
727
728
  end

  def import_jid
    ensure_import_state

    import_state&.jid
  end

  def import_error=(new_error)
729
    ensure_import_state(force: true)
730

731
    import_state.last_error = new_error
732
733
734
735
736
737
738
739
740
  end

  def import_error
    ensure_import_state

    import_state&.last_error
  end

  def import_status=(new_status)
741
    ensure_import_state(force: true)
742

743
    import_state.status = new_status
744
745
746
747
748
749
750
751
752
753
754
755
  end

  def import_status
    ensure_import_state

    import_state&.status || 'none'
  end

  def no_import?
    import_status == 'none'
  end

756
  def import_started?
757
758
    # import? does SQL work so only run it if it looks like there's an import running
    import_status == 'started' && import?
759
760
  end

761
762
763
764
  def import_scheduled?
    import_status == 'scheduled'
  end

765
766
767
768
769
770
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
771
772
  end

773
  def safe_import_url
774
    Gitlab::UrlSanitizer.new(import_url).masked_url
775
776
  end

777
778
779
780
  def bare_repository_import?
    import_type == 'bare_repository'
  end

781
782
783
784
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
785
786
787
788
  def gitea_import?
    import_type == 'gitea'
  end

789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
  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

820
  def check_limit
Douwe Maan's avatar
Douwe Maan committed
821
    unless creator.can_create_project? || namespace.kind == 'group'
822
823
824
      projects_limit = creator.projects_limit

      if projects_limit == 0
Phil Hughes's avatar
Phil Hughes committed
825
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
826
      else
Phil Hughes's avatar
Phil Hughes committed
827
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
828
      end
829
830
    end
  rescue
Douwe Maan's avatar
Douwe Maan committed
831
    self.errors.add(:base, "Can't check your ability to create project")
832
833
  end

Douwe Maan's avatar
Douwe Maan committed
834
835
836
837
838
839
840
841
842
843
844
845
846
  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.")
847
848
  end

849
850
851
852
853
854
855
856
857
858
  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
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
  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
879
  def to_param
880
881
882
883
884
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
885
886
  end

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

896
897
  def to_human_reference(from = nil)
    if cross_namespace_reference?(from)
898
      name_with_namespace
899
    elsif cross_project_reference?(from)
900
901
      name
    end
902
903
  end

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

Imre Farkas's avatar
Imre Farkas committed
908
909
910
911
912
913
914
  def readme_url
    readme = repository.readme
    if readme
      Gitlab::Routing.url_helpers.project_blob_url(self, File.join(default_branch, readme.path))
    end
  end

915
  def new_issuable_address(author, address_type)
916
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author
917

918
919
    author.ensure_incoming_email_token!

920
    suffix = address_type == 'merge_request' ? '+merge-request' : ''
921
    Gitlab::IncomingEmail.reply_address(
922
      "#{full_path}#{suffix}+#{author.incoming_email_token}")
923
924
  end

925
  def build_commit_note(commit)
926
    notes.new(commit_id: commit.id, noteable_type: 'Commit')
Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
927
  end
Nihad Abbasov's avatar
Nihad Abbasov committed
928

929
  def last_activity
930
    last_event
gitlabhq's avatar
gitlabhq committed
931
932
933
  end

  def last_activity_date
934
    [last_activity_at, last_repository_updated_at, updated_at].compact.max
gitlabhq's avatar
gitlabhq committed
935
936
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
937
938
939
  def project_id
    self.id
  end
randx's avatar
randx committed
940

941
  def get_issue(issue_id, current_user)
942
943
944
945
946
    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
947
      ExternalIssue.new(issue_id, self)
948
949
950
    end
  end

Robert Speicher's avatar
Robert Speicher committed
951
  def issue_exists?(issue_id)
952
    get_issue(issue_id)
Robert Speicher's avatar
Robert Speicher committed
953
954
  end

955
  def default_issue_tracker
956
    gitlab_issue_tracker_service || create_gitlab_issue_tracker_service
957
958
959
960
961
962
963
964
965
966
  end

  def issues_tracker
    if external_issue_tracker
      external_issue_tracker
    else
      default_issue_tracker
    end
  end

967
  def external_issue_reference_pattern
968
    external_issue_tracker.class.reference_pattern(only_long: issues_enabled?)
969
970
  end

971
  def default_issues_tracker?
972
    !external_issue_tracker
973
974
975
  end

  def external_issue_tracker
976
977
978
979
980
981
982
983
984
985
986
987
988
989
    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
990
    update_column(:has_external_issue_tracker, services.external_issue_trackers.any?) if Gitlab::Database.read_write?
991
992
  end

993
994
995
996
  def has_wiki?
    wiki_enabled? || has_external_wiki?
  end

997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
  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
1010
    update_column(:has_external_wiki, services.external_wikis.any?) if Gitlab::Database.read_write?
1011
1012
  end

1013
  def find_or_initialize_services(exceptions: [])
1014
1015
    services_templates = Service.where(template: true)

1016
1017
    available_services_names = Service.available_services_names - exceptions

Rémy Coutable's avatar