project.rb 61.9 KB
Newer Older
1
2
# frozen_string_literal: true

3
4
require 'carrierwave/orm/activerecord'

gitlabhq's avatar
gitlabhq committed
5
class Project < ActiveRecord::Base
6
  include Gitlab::ConfigHelper
7
  include Gitlab::ShellAdapter
8
  include Gitlab::VisibilityLevel
Rémy Coutable's avatar
Rémy Coutable committed
9
  include AccessRequestable
10
  include Avatarable
11
  include CacheMarkdownField
12
13
  include Referable
  include Sortable
14
  include AfterCommitQueue
15
  include CaseSensitivity
16
  include TokenAuthenticatable
17
  include ValidAttribute
Felipe Artur's avatar
Felipe Artur committed
18
  include ProjectFeaturesCompatibility
19
  include SelectForProjectAuthorization
20
  include Presentable
21
  include Routable
22
  include GroupDescendant
23
  include Gitlab::SQL::Pattern
24
  include DeploymentPlatform
25
  include ::Gitlab::Utils::StrongMemoize
26
  include ChronicDurationAttribute
27
  include FastDestroyAll::Helpers
Jan Provaznik's avatar
Jan Provaznik committed
28
  include WithUploads
29
  include BatchDestroyDependentAssociations
30
  include FeatureGate
31
  include OptionallySearch
32
  include FromUnion
33
  include IgnorableColumn
34
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
35

36
  extend Gitlab::ConfigHelper
37

38
  BoardLimitExceeded = Class.new(StandardError)
39

40
  STATISTICS_ATTRIBUTE = 'repositories_count'.freeze
41
  NUMBER_OF_PERMITTED_BOARDS = 1
Douwe Maan's avatar
Douwe Maan committed
42
  UNKNOWN_IMPORT_URL = 'http://unknown.git'.freeze
43
44
  # Hashed Storage versions handle rolling out new storage to project and dependents models:
  # nil: legacy
45
46
47
  # 1: repository
  # 2: attachments
  LATEST_STORAGE_VERSION = 2
48
49
50
51
  HASHED_STORAGE_FEATURES = {
    repository: 1,
    attachments: 2
  }.freeze
Jared Szechy's avatar
Jared Szechy committed
52

53
54
55
56
57
  VALID_IMPORT_PORTS = [80, 443].freeze
  VALID_IMPORT_PROTOCOLS = %w(http https git).freeze

  VALID_MIRROR_PORTS = [22, 80, 443].freeze
  VALID_MIRROR_PROTOCOLS = %w(http https ssh git).freeze
58

59
60
  ignore_column :import_status, :import_jid, :import_error

61
62
  cache_markdown_field :description, pipeline: :description

63
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
64
65
           :merge_requests_enabled?, :issues_enabled?, :pages_enabled?, :public_pages?,
           to: :project_feature, allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
66

67
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
68

69
70
71
72
73
74
  delegate :scheduled?, :started?, :in_progress?,
    :failed?, :finished?,
    prefix: :import, to: :import_state, allow_nil: true

  delegate :no_import?, to: :import_state, allow_nil: true

75
  default_value_for :archived, false
76
  default_value_for :visibility_level, gitlab_config_features.visibility_level
77
  default_value_for :resolve_outdated_diff_discussions, false
78
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
79
80
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
81
82
83
84
85
  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
86
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
87

88
  add_authentication_token_field :runners_token, encrypted: true, migrating: true
89

90
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
91

92
  before_save :ensure_runners_token
93

94
  after_save :update_project_statistics, if: :namespace_id_changed?
95
96
97

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

98
  after_create :create_project_feature, unless: :project_feature
99
100
101
102
103

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

Mark Chao's avatar
Mark Chao committed
104
  after_create :set_timestamps_for_create
105
  after_update :update_forks_visibility_level
106

107
  before_destroy :remove_private_deploy_keys
108

109
  use_fast_destroy :build_trace_chunks
110

111
  after_destroy -> { run_after_commit { remove_pages } }
112
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
113

114
115
  after_validation :check_pending_delete

116
  # Storage specific hooks
117
  after_initialize :use_hashed_storage
118
  after_create :check_repository_absence!
119
120
  after_create :ensure_storage_path_exists
  after_save :ensure_storage_path_exists, if: :namespace_id_changed?
121

122
  acts_as_ordered_taggable
123

124
  attr_accessor :old_path_with_namespace
125
  attr_accessor :template_name
126
  attr_writer :pipeline_status
127
  attr_accessor :skip_disk_validation
128

129
130
  alias_attribute :title, :name

131
  # Relations
Nick Thomas's avatar
Nick Thomas committed
132
  belongs_to :pool_repository
133
  belongs_to :creator, class_name: 'User'
134
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
135
  belongs_to :namespace
136
137
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
138

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

142
  # Project services
143
  has_one :campfire_service
blackst0ne's avatar
blackst0ne committed
144
  has_one :discord_service
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
  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 :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
174
  has_one :packagist_service
175
  has_one :hangouts_chat_service
176

177
178
179
180
181
  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
182
  has_one :fork_network, through: :fork_network_member
183
184
185
  has_one :forked_from_project, through: :fork_network_member
  has_many :forked_to_members, class_name: 'ForkNetworkMember', foreign_key: 'forked_from_project_id'
  has_many :forks, through: :forked_to_members, source: :project, inverse_of: :forked_from_project
186

187
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
188
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
189
  has_one :project_repository, inverse_of: :project
190

191
  # Merge Requests for target project should be removed with it
192
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
193
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
194
195
196
197
198
199
200
201
202
203
  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
204
  has_many :repository_languages, -> { order "share DESC" }
205

206
  has_many :project_authorizations
207
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
208
  has_many :project_members, -> { where(requested_at: nil) },
209
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
210

211
  alias_method :members, :project_members
212
  has_many :users, through: :project_members
213

214
  has_many :requesters, -> { where.not(requested_at: nil) },
215
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
216
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
217

218
  has_many :deploy_keys_projects
219
  has_many :deploy_keys, through: :deploy_keys_projects
220
  has_many :users_star_projects
221
  has_many :starrers, through: :users_star_projects, source: :user
222
  has_many :releases
223
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
224
  has_many :lfs_objects, through: :lfs_objects_projects
225
  has_many :lfs_file_locks
226
  has_many :project_group_links
227
  has_many :invited_groups, through: :project_group_links, source: :group
228
229
  has_many :pages_domains
  has_many :todos
230
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
231

232
233
  has_many :internal_ids

234
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
235
  has_one :project_feature, inverse_of: :project
236
  has_one :statistics, class_name: 'ProjectStatistics'
237

Shinya Maeda's avatar
Shinya Maeda committed
238
  has_one :cluster_project, class_name: 'Clusters::Project'
239
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
240
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
241
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
242

243
244
  has_many :prometheus_metrics

245
246
247
  # 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.
248
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
249

250
  has_many :commit_statuses
251
  has_many :pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
252
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
253
254
255
256
257

  # 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.
258
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
259
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
260
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
261
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
262
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
263
  has_many :variables, class_name: 'Ci::Variable'
264
265
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
266
  has_many :deployments, -> { success }
267
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
268
  has_many :project_deploy_tokens
269
  has_many :deploy_tokens, through: :project_deploy_tokens
270

271
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
272
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
273

274
  has_many :project_badges, class_name: 'ProjectBadge'
275
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
276

277
278
  has_many :remote_mirrors, inverse_of: :project

279
  accepts_nested_attributes_for :variables, allow_destroy: true
280
  accepts_nested_attributes_for :project_feature, update_only: true
281
  accepts_nested_attributes_for :import_data
282
  accepts_nested_attributes_for :auto_devops, update_only: true
283

284
285
286
287
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

288
  delegate :name, to: :owner, allow_nil: true, prefix: true
289
  delegate :members, to: :team, prefix: true
290
  delegate :add_user, :add_users, to: :team
291
292
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
293
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
294

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
295
  # Validations
296
  validates :creator, presence: true, on: :create
297
  validates :description, length: { maximum: 2000 }, allow_blank: true
298
  validates :ci_config_path,
299
    format: { without: %r{(\.{2}|\A/)},
300
              message: 'cannot include leading slash or directory traversal.' },
301
302
    length: { maximum: 255 },
    allow_blank: true
303
304
  validates :name,
    presence: true,
305
    length: { maximum: 255 },
306
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
307
              message: Gitlab::Regex.project_name_regex_message }
308
309
  validates :path,
    presence: true,
310
    project_path: true,
311
    length: { maximum: 255 }
312

313
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
314
  validates :name, uniqueness: { scope: :namespace_id }
315
316
  validates :import_url, url: { protocols: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
                                ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
317
                                allow_localhost: false,
318
                                enforce_user: true }, if: [:external_import?, :import_url_changed?]
319
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
320
  validate :check_limit, on: :create
321
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
Douwe Maan's avatar
Douwe Maan committed
322
  validate :visibility_level_allowed_by_group
Douwe Maan's avatar
Douwe Maan committed
323
  validate :visibility_level_allowed_as_fork
324
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
325
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
326
327
328
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
329
  validates :variables, variable_duplicates: { scope: :environment_scope }
330

331
  # Scopes
332
  scope :pending_delete, -> { where(pending_delete: true) }
333
  scope :without_deleted, -> { where(pending_delete: false) }
334

335
336
337
  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) }
338

339
340
  # 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") }
341
  scope :sorted_by_stars, -> { reorder(star_count: :desc) }
342

343
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
344
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
345
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
346
  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
347
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
348
  scope :visible_to_user_and_access_level, ->(user, access_level) { where(id: user.authorized_projects.where('project_authorizations.access_level >= ?', access_level).select(:id).reorder(nil)) }
349
  scope :archived, -> { where(archived: true) }
350
  scope :non_archived, -> { where(archived: false) }
351
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
352
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
353
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
354
  scope :with_statistics, -> { includes(:statistics) }
355
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
356
357
358
  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.
359
360
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
361
  end
362
363
364
365

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
    access_level_attribute = ProjectFeature.access_level_attribute(feature)
366
    with_project_feature.where(project_features: { access_level_attribute => [nil, ProjectFeature::PRIVATE, ProjectFeature::ENABLED, ProjectFeature::PUBLIC] })
367
368
369
370
371
372
373
374
375
376
  }

  # 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) }
377
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
378
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
379
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
380

381
382
383
384
385
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

386
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
387

388
  chronic_duration_attr :build_timeout_human_readable, :build_timeout, default: 3600
389
390

  validates :build_timeout, allow_nil: true,
391
392
393
394
                            numericality: { greater_than_or_equal_to: 10.minutes,
                                            less_than: 1.month,
                                            only_integer: true,
                                            message: 'needs to be beetween 10 minutes and 1 month' }
395

396
397
398
399
400
401
402
  # Returns a project, if it is not about to be removed.
  #
  # id - The ID of the project to retrieve.
  def self.find_without_deleted(id)
    without_deleted.find_by_id(id)
  end

403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
  # Paginates a collection using a `WHERE id < ?` condition.
  #
  # before - A project ID to use for filtering out projects with an equal or
  #      greater ID. If no ID is given, all projects are included.
  #
  # limit - The maximum number of rows to include.
  def self.paginate_in_descending_order_using_id(
    before: nil,
    limit: Kaminari.config.default_per_page
  )
    relation = order_id_desc.limit(limit)
    relation = relation.where('projects.id < ?', before) if before

    relation
  end

  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

423
424
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
425
426
  def self.public_or_visible_to_user(user = nil)
    if user
427
428
429
      where('EXISTS (?) OR projects.visibility_level IN (?)',
            user.authorizations_for_projects,
            Gitlab::VisibilityLevel.levels_for_user(user))
430
    else
431
      public_to_user
432
433
434
    end
  end

435
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
436
  # they are only available to team members. This scope returns projects where
437
  # the feature is either public, enabled, or internal with permission for the user.
438
439
440
441
  #
  # 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.
442
  def self.with_feature_available_for_user(feature, user)
443
    visible = [nil, ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
444
445
446
447
448
449

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

450
451
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
452
453
              visible,
              ProjectFeature::PRIVATE,
454
              user.authorizations_for_projects)
455
456
457
    else
      with_feature_access_level(feature, visible)
    end
458
  end
Felipe Artur's avatar
Felipe Artur committed
459

Rémy Coutable's avatar
Rémy Coutable committed
460
461
  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) }
462

463
464
  scope :excluding_project, ->(project) { where.not(id: project) }

465
466
  # We require an alias to the project_mirror_data_table in order to use import_state in our queries
  scope :joins_import_state, -> { joins("INNER JOIN project_mirror_data import_state ON import_state.project_id = projects.id") }
467
  scope :for_group, -> (group) { where(group: group) }
468

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
469
  class << self
470
471
472
473
474
475
476
    # 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.
477
    def search(query)
478
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
479
    end
480

481
    def search_by_title(query)
482
      non_archived.fuzzy_search(query, [:name])
483
484
    end

485
486
487
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
488

489
    def sort_by_attribute(method)
490
491
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
492
493
494
        # 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')
495
496
497
498
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
499
500
      when 'stars_desc'
        sorted_by_stars
501
502
      else
        order_by(method)
503
504
      end
    end
505
506

    def reference_pattern
507
      %r{
508
509
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
510
      }x
511
    end
512

513
514
515
516
    def reference_postfix
      '>'
    end

517
518
519
520
    def reference_postfix_escaped
      '&gt;'
    end

521
    # Pattern used to extract `namespace/project>` project references from text.
522
523
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
524
525
526
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
527
        (#{reference_postfix}|#{reference_postfix_escaped})
528
529
530
      }x
    end

531
    def trending
532
533
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
534
    end
535
536
537
538
539
540

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

    def group_ids
543
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
544
    end
545
546
  end

547
548
549
550
551
552
553
  # 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

554
  def lfs_enabled?
555
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
556

557
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
558
559
  end

Cindy Pallares's avatar
Cindy Pallares committed
560
561
  alias_method :lfs_enabled, :lfs_enabled?

562
  def auto_devops_enabled?
563
    if auto_devops&.enabled.nil?
564
      has_auto_devops_implicitly_enabled?
565
566
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
567
    end
568
569
  end

570
  def has_auto_devops_implicitly_enabled?
571
572
    auto_devops&.enabled.nil? &&
      (Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
573
574
  end

575
  def has_auto_devops_implicitly_disabled?
576
    auto_devops&.enabled.nil? && !(Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
577
578
  end

579
580
581
582
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
583
  def team
584
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
585
586
587
  end

  def repository
588
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
589
590
  end

591
  def cleanup
592
593
594
    @repository = nil
  end

595
596
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
597
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
598
    if Gitlab.config.registry.enabled
599
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
600
    end
601
602
  end

603
  def has_container_registry_tags?
604
605
606
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
607
      has_root_container_repository_tags?
608
609
  end

610
611
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
612
613
  end

614
615
616
617
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

618
619
620
621
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

622
  # ref can't be HEAD, can only be branch/tag name or SHA
623
  def latest_successful_builds_for(ref = default_branch)
624
    latest_pipeline = pipelines.latest_successful_for(ref)
625
626

    if latest_pipeline
627
      latest_pipeline.builds.latest.with_artifacts_archive
628
629
630
    else
      builds.none
    end
631
632
  end

633
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
634
    sha = repository.merge_base(first_commit_id, second_commit_id)
635
    commit_by(oid: sha) if sha
636
637
  end

638
  def saved?
639
    id && persisted?
640
641
  end

642
643
644
645
646
647
648
649
  def import_status
    import_state&.status || 'none'
  end

  def human_import_status_name
    import_state&.human_status_name || 'none'
  end

650
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
651
652
    job_id =
      if forked?
653
        RepositoryForkWorker.perform_async(id)
654
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
655
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
656
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
657
658
659
      else
        RepositoryImportWorker.perform_async(self.id)
      end
660

661
662
663
664
665
666
667
668
    log_import_activity(job_id)

    job_id
  end

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

669
    if job_id
670
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
671
    else
672
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
673
    end
674
675
  end

676
677
678
679
680
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

681
    import_state.update(last_error: nil)
682
683
684
    remove_import_data
  end

685
  # This method is overridden in EE::Project model
686
  def remove_import_data
687
    import_data&.destroy
688
689
  end

690
  def ci_config_path=(value)
691
    # Strip all leading slashes so that //foo -> foo
692
    super(value&.delete("\0"))
693
694
  end

695
  def import_url=(value)
James Lopez's avatar
James Lopez committed
696
697
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

698
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez's avatar
James Lopez committed
699
    super(import_url.sanitized_url)
700
    create_or_update_import_data(credentials: import_url.credentials)
701
702
703
  end

  def import_url
James Lopez's avatar
James Lopez committed
704
    if import_data && super.present?
705
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
706
707
708
      import_url.full_url
    else
      super
709
    end
710
711
  rescue
    super
712
  end
713

James Lopez's avatar
James Lopez committed
714
  def valid_import_url?
715
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
716
717
  end

718
  def create_or_update_import_data(data: nil, credentials: nil)
719
    return if data.nil? && credentials.nil?
720

James Lopez's avatar
James Lopez committed
721
    project_import_data = import_data || build_import_data
James Lopez's avatar
James Lopez committed
722
723
724
725
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
726

727
728
729
730
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
731
732

    project_import_data
733
  end
734

735
  def import?
James Lopez's avatar
James Lopez committed
736
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
737
738
739
  end

  def external_import?
740
741
742
    import_url.present?
  end

743
  def safe_import_url
744
    Gitlab::UrlSanitizer.new(import_url).masked_url
745
746
  end

747
748
749
750
  def bare_repository_import?
    import_type == 'bare_repository'
  end

751
752
753
754
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
755
756
757
758
  def gitea_import?
    import_type == 'gitea'
  end

759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
  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

790
  def check_limit
Douwe Maan's avatar
Douwe Maan committed
791
    unless creator.can_create_project? || namespace.kind == 'group'
792
793
794
      projects_limit = creator.projects_limit

      if projects_limit == 0
Phil Hughes's avatar
Phil Hughes committed
795
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
796
      else
Phil Hughes's avatar
Phil Hughes committed
797
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
798
      end
799
800
    end
  rescue
Douwe Maan's avatar
Douwe Maan committed
801
    self.errors.add(:base, "Can't check your ability to create project")
gitlabhq's avatar
gitlabhq committed
802
803
  end

Douwe Maan's avatar
Douwe Maan committed
804
805
806
807
808
809
810
811
812
813
814
815
816
  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.")
817
818
  end

819
820
821
822
823
824
825
826
827
828
  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
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
  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

849
  def to_param
850
851
852
853
854
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
855
856
  end

857
858
859
860
  def to_reference_with_postfix
    "#{to_reference(full: true)}#{self.class.reference_postfix}"
  end

861
  # `from` argument can be a Namespace or Project.
862
863
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
864
      full_path
865
866
867
    elsif cross_project_reference?(from)
      path
    end
868
869
  end