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

3
4
require 'carrierwave/orm/activerecord'

Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets 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
  extend Gitlab::Cache::RequestCache
Robert Speicher's avatar
Robert Speicher committed
34

35
  extend Gitlab::ConfigHelper
36

37
  BoardLimitExceeded = Class.new(StandardError)
38

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

52
53
54
55
56
  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
57

58
59
  cache_markdown_field :description, pipeline: :description

60
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
61
62
           :merge_requests_enabled?, :issues_enabled?, :pages_enabled?, :public_pages?,
           to: :project_feature, allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
63

64
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
65

66
  default_value_for :archived, false
67
  default_value_for :visibility_level, gitlab_config_features.visibility_level
68
  default_value_for :resolve_outdated_diff_discussions, false
69
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
70
71
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
72
73
74
75
76
  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
77
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
78

79
  add_authentication_token_field :runners_token
80

81
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
82

83
84
  before_save :ensure_runners_token

Markus Koller's avatar
Markus Koller committed
85
  after_save :update_project_statistics, if: :namespace_id_changed?
86
87
88

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

89
  after_create :create_project_feature, unless: :project_feature
90

91
  after_create -> { SiteStatistic.track(STATISTICS_ATTRIBUTE) }
92
  before_destroy -> { SiteStatistic.untrack(STATISTICS_ATTRIBUTE) }
93

94
95
96
97
  after_create :create_ci_cd_settings,
    unless: :ci_cd_settings,
    if: proc { ProjectCiCdSetting.available? }

Mark Chao's avatar
Mark Chao committed
98
  after_create :set_timestamps_for_create
99
  after_update :update_forks_visibility_level
100

101
  before_destroy :remove_private_deploy_keys
102

103
  use_fast_destroy :build_trace_chunks
104

105
  after_destroy -> { run_after_commit { remove_pages } }
106
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
107

108
109
  after_validation :check_pending_delete

110
  # Storage specific hooks
111
  after_initialize :use_hashed_storage
112
  after_create :check_repository_absence!
113
114
  after_create :ensure_storage_path_exists
  after_save :ensure_storage_path_exists, if: :namespace_id_changed?
115

116
  acts_as_ordered_taggable
117

118
  attr_accessor :old_path_with_namespace
119
  attr_accessor :template_name
120
  attr_writer :pipeline_status
121
  attr_accessor :skip_disk_validation
122

123
124
  alias_attribute :title, :name

125
  # Relations
Nick Thomas's avatar
Nick Thomas committed
126
  belongs_to :pool_repository
127
  belongs_to :creator, class_name: 'User'
128
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
129
  belongs_to :namespace
130
131
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
132

133
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
134
  has_many :boards, before_add: :validate_board_limit
135
136

  # Project services
137
  has_one :campfire_service
blackst0ne's avatar
blackst0ne committed
138
  has_one :discord_service
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
  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
162
  has_one :kubernetes_service, inverse_of: :project
163
164
165
166
167
  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
168
  has_one :packagist_service
169
  has_one :hangouts_chat_service
170

171
172
173
174
175
176
  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
177
178
179
  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
180

181
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
182
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
183

184
  # Merge Requests for target project should be removed with it
185
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
186
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
187
188
189
190
191
192
193
194
195
196
  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
197
  has_many :repository_languages, -> { order "share DESC" }
198

199
  has_many :project_authorizations
200
  has_many :authorized_users, through: :project_authorizations, source: :user, class_name: 'User'
201
  has_many :project_members, -> { where(requested_at: nil) },
202
    as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
203

204
  alias_method :members, :project_members
205
206
  has_many :users, through: :project_members

207
  has_many :requesters, -> { where.not(requested_at: nil) },
208
    as: :source, class_name: 'ProjectMember', dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
209
  has_many :members_and_requesters, as: :source, class_name: 'ProjectMember'
210

211
  has_many :deploy_keys_projects
212
  has_many :deploy_keys, through: :deploy_keys_projects
213
  has_many :users_star_projects
Ciro Santilli's avatar
Ciro Santilli committed
214
  has_many :starrers, through: :users_star_projects, source: :user
215
  has_many :releases
216
  has_many :lfs_objects_projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
Marin Jankovski's avatar
Marin Jankovski committed
217
  has_many :lfs_objects, through: :lfs_objects_projects
218
  has_many :lfs_file_locks
219
  has_many :project_group_links
220
  has_many :invited_groups, through: :project_group_links, source: :group
221
222
  has_many :pages_domains
  has_many :todos
223
  has_many :notification_settings, as: :source, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
224

225
226
  has_many :internal_ids

227
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
228
  has_one :project_feature, inverse_of: :project
229
  has_one :statistics, class_name: 'ProjectStatistics'
230

Shinya Maeda's avatar
Shinya Maeda committed
231
  has_one :cluster_project, class_name: 'Clusters::Project'
232
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
233
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
234

235
236
  has_many :prometheus_metrics

237
238
239
  # 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.
240
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
241

242
  has_many :commit_statuses
243
  has_many :pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
244
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
245
246
247
248
249

  # 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.
250
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
251
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
252
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
253
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
254
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
255
  has_many :variables, class_name: 'Ci::Variable'
256
257
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
258
  has_many :deployments, -> { success }
259
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
260
261
  has_many :project_deploy_tokens
  has_many :deploy_tokens, through: :project_deploy_tokens
262

263
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
264
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
265

266
  has_many :project_badges, class_name: 'ProjectBadge'
267
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
268

269
270
  has_many :remote_mirrors, inverse_of: :project

271
  accepts_nested_attributes_for :variables, allow_destroy: true
272
  accepts_nested_attributes_for :project_feature, update_only: true
273
  accepts_nested_attributes_for :import_data
274
  accepts_nested_attributes_for :auto_devops, update_only: true
275

276
277
278
279
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

280
  delegate :name, to: :owner, allow_nil: true, prefix: true
281
  delegate :members, to: :team, prefix: true
282
  delegate :add_user, :add_users, to: :team
283
284
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
285
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
286

287
  # Validations
288
  validates :creator, presence: true, on: :create
289
  validates :description, length: { maximum: 2000 }, allow_blank: true
290
  validates :ci_config_path,
291
    format: { without: %r{(\.{2}|\A/)},
292
              message: 'cannot include leading slash or directory traversal.' },
293
294
    length: { maximum: 255 },
    allow_blank: true
295
296
  validates :name,
    presence: true,
297
    length: { maximum: 255 },
298
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
299
              message: Gitlab::Regex.project_name_regex_message }
300
301
  validates :path,
    presence: true,
302
    project_path: true,
303
    length: { maximum: 255 }
304

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

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
323
  # Scopes
324
  scope :pending_delete, -> { where(pending_delete: true) }
325
  scope :without_deleted, -> { where(pending_delete: false) }
326

327
328
329
  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) }
330

331
332
  # 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") }
333
  scope :sorted_by_stars, -> { reorder(star_count: :desc) }
334

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

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
    access_level_attribute = ProjectFeature.access_level_attribute(feature)
358
    with_project_feature.where(project_features: { access_level_attribute => [nil, ProjectFeature::PRIVATE, ProjectFeature::ENABLED, ProjectFeature::PUBLIC] })
359
360
361
362
363
364
365
366
367
368
  }

  # 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) }
369
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
370
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
371
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
372

373
374
375
376
377
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

378
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
379

380
  chronic_duration_attr :build_timeout_human_readable, :build_timeout, default: 3600
381
382

  validates :build_timeout, allow_nil: true,
383
384
385
386
                            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' }
387

388
389
390
391
392
393
394
  # 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

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
  # 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

415
416
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
417
418
  def self.public_or_visible_to_user(user = nil)
    if user
419
420
421
      where('EXISTS (?) OR projects.visibility_level IN (?)',
            user.authorizations_for_projects,
            Gitlab::VisibilityLevel.levels_for_user(user))
422
    else
423
      public_to_user
424
425
426
    end
  end

427
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
428
  # they are only available to team members. This scope returns projects where
429
  # the feature is either public, enabled, or internal with permission for the user.
430
431
432
433
  #
  # 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.
434
  def self.with_feature_available_for_user(feature, user)
435
    visible = [nil, ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
436

437
438
439
440
    if user&.admin?
      with_feature_enabled(feature)
    elsif user
      column = ProjectFeature.quoted_access_level_column(feature)
441

442
443
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
444
445
              visible,
              ProjectFeature::PRIVATE,
446
              user.authorizations_for_projects)
447
448
449
    else
      with_feature_access_level(feature, visible)
    end
450
  end
Felipe Artur's avatar
Felipe Artur committed
451

Rémy Coutable's avatar
Rémy Coutable committed
452
453
  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) }
454

455
456
  scope :excluding_project, ->(project) { where.not(id: project) }

457
458
  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'") }
459
  scope :for_group, -> (group) { where(group: group) }
460

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
461
  class << self
462
463
464
465
466
467
468
    # 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.
469
    def search(query)
470
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
471
472
    end

473
    def search_by_title(query)
474
      non_archived.fuzzy_search(query, [:name])
475
476
    end

477
478
479
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
480

481
    def sort_by_attribute(method)
482
483
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
484
485
486
        # 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')
487
488
489
490
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
491
492
      when 'stars_desc'
        sorted_by_stars
493
494
      else
        order_by(method)
495
496
      end
    end
497
498

    def reference_pattern
499
      %r{
500
501
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
502
      }x
503
    end
504

505
506
507
508
    def reference_postfix
      '>'
    end

509
510
511
512
    def reference_postfix_escaped
      '&gt;'
    end

513
    # Pattern used to extract `namespace/project>` project references from text.
514
515
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
516
517
518
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
519
        (#{reference_postfix}|#{reference_postfix_escaped})
520
521
522
      }x
    end

523
    def trending
524
525
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
526
    end
527
528
529
530
531
532

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

    def group_ids
535
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
536
    end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
537
538
  end

539
540
541
542
543
544
545
  # 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

546
  def lfs_enabled?
547
548
549
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?

    self[:lfs_enabled] && Gitlab.config.lfs.enabled
550
551
  end

Cindy Pallares's avatar
Cindy Pallares committed
552
553
  alias_method :lfs_enabled, :lfs_enabled?

554
  def auto_devops_enabled?
555
    if auto_devops&.enabled.nil?
556
      has_auto_devops_implicitly_enabled?
557
    else
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
558
559
      auto_devops.enabled?
    end
560
561
  end

562
  def has_auto_devops_implicitly_enabled?
563
564
    auto_devops&.enabled.nil? &&
      (Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
565
566
  end

567
  def has_auto_devops_implicitly_disabled?
568
    auto_devops&.enabled.nil? && !(Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
569
570
  end

571
572
573
574
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
575
  def team
576
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
577
578
579
  end

  def repository
580
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
581
582
  end

583
  def cleanup
584
585
586
    @repository = nil
  end

587
588
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
589
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
590
    if Gitlab.config.registry.enabled
591
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
592
    end
593
594
  end

595
  def has_container_registry_tags?
596
597
598
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
599
      has_root_container_repository_tags?
600
601
  end

602
603
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
604
605
  end

606
607
608
609
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

610
611
612
613
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

614
  # ref can't be HEAD, can only be branch/tag name or SHA
615
  def latest_successful_builds_for(ref = default_branch)
616
    latest_pipeline = pipelines.latest_successful_for(ref)
617
618

    if latest_pipeline
619
      latest_pipeline.builds.latest.with_artifacts_archive
620
621
622
    else
      builds.none
    end
623
624
  end

625
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
626
    sha = repository.merge_base(first_commit_id, second_commit_id)
627
    commit_by(oid: sha) if sha
628
629
  end

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
630
  def saved?
631
    id && persisted?
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
632
633
  end

634
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
635
636
    job_id =
      if forked?
637
        RepositoryForkWorker.perform_async(id)
638
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
639
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
640
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
641
642
643
      else
        RepositoryImportWorker.perform_async(self.id)
      end
644

645
646
647
648
649
650
651
652
    log_import_activity(job_id)

    job_id
  end

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

653
    if job_id
654
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
655
    else
656
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
657
    end
658
659
  end

660
  def reset_cache_and_import_attrs
661
662
663
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end
664

665
    update(import_error: nil)
666
667
668
    remove_import_data
  end

669
  # This method is overridden in EE::Project model
670
  def remove_import_data
671
    import_data&.destroy
672
673
  end

674
  def ci_config_path=(value)
675
    # Strip all leading slashes so that //foo -> foo
676
    super(value&.delete("\0"))
677
678
  end

679
  def import_url=(value)
James Lopez's avatar
James Lopez committed
680
681
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

682
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez's avatar
James Lopez committed
683
    super(import_url.sanitized_url)
684
    create_or_update_import_data(credentials: import_url.credentials)
685
686
687
  end

  def import_url
James Lopez's avatar
James Lopez committed
688
    if import_data && super.present?
689
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
690
691
692
      import_url.full_url
    else
      super
693
    end
694
695
  rescue
    super
696
697
  end

James Lopez's avatar
James Lopez committed
698
  def valid_import_url?
699
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
700
701
  end

702
  def create_or_update_import_data(data: nil, credentials: nil)
703
    return if data.nil? && credentials.nil?
704

705
    project_import_data = import_data || build_import_data
James Lopez's avatar
James Lopez committed
706
707
708
709
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
710

711
712
713
714
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
715
716

    project_import_data
717
718
  end

719
  def import?
James Lopez's avatar
James Lopez committed
720
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
721
722
723
  end

  def external_import?
724
725
726
    import_url.present?
  end

727
  def imported?
728
729
730
731
    import_finished?
  end

  def import_in_progress?
732
733
734
    import_started? || import_scheduled?
  end

735
736
737
738
739
740
741
742
  def import_state_args
    {
      status: self[:import_status],
      jid: self[:import_jid],
      last_error: self[:import_error]
    }
  end

743
744
  def ensure_import_state(force: false)
    return if !force && (self[:import_status] == 'none' || self[:import_status].nil?)
745
746
    return unless import_state.nil?

747
748
    if persisted?
      create_import_state(import_state_args)
749

750
751
752
753
754
755
      update_column(:import_status, 'none')
    else
      build_import_state(import_state_args)

      self[:import_status] = 'none'
    end
756
757
  end

758
759
760
761
762
763
  def human_import_status_name
    ensure_import_state

    import_state.human_status_name
  end

764
  def import_schedule
765
    ensure_import_state(force: true)
766

767
    import_state.schedule
768
769
770
  end

  def force_import_start
771
    ensure_import_state(force: true)
772

773
    import_state.force_start
774
775
776
  end

  def import_start
777
    ensure_import_state(force: true)
778

779
    import_state.start
780
781
782
  end

  def import_fail
783
    ensure_import_state(force: true)
784

785
    import_state.fail_op
786
787
788
  end

  def import_finish
789
    ensure_import_state(force: true)
790

791
    import_state.finish
792
793
794
  end

  def import_jid=(new_jid)
795
    ensure_import_state(force: true)
796

797
    import_state.jid = new_jid
798
799
800
801
802
803
804
805
806
  end

  def import_jid
    ensure_import_state

    import_state&.jid
  end

  def import_error=(new_error)
807
    ensure_import_state(force: true)
808

809
    import_state.last_error = new_error
810
811
812
813
814
815
816
817
818
  end

  def import_error
    ensure_import_state

    import_state&.last_error
  end

  def import_status=(new_status)
819
    ensure_import_state(force: true)
820

821
    import_state.status = new_status
822
823
824
825
826
827
828
829
830
831
832
833
  end

  def import_status
    ensure_import_state

    import_state&.status || 'none'
  end

  def no_import?
    import_status == 'none'
  end

834
  def import_started?
835
836
    # import? does SQL work so only run it if it looks like there's an import running
    import_status == 'started' && import?
837
838
  end

839
840
841
842
  def import_scheduled?
    import_status == 'scheduled'
  end

843
844
845
846
847
848
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
849
850
  end

851
  def safe_import_url
852
    Gitlab::UrlSanitizer.new(import_url).masked_url
853
854
  end

855
856
857
858
  def bare_repository_import?
    import_type == 'bare_repository'
  end

859
860
861
862
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
863
864
865
866
  def gitea_import?
    import_type == 'gitea'
  end

867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
  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

898
  def check_limit
Douwe Maan's avatar
Douwe Maan committed
899
    unless creator.can_create_project? || namespace.kind == 'group'
900
901
902
      projects_limit = creator.projects_limit

      if projects_limit == 0
Phil Hughes's avatar
Phil Hughes committed
903
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
904
      else
Phil Hughes's avatar
Phil Hughes committed
905
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
906
      end
907
908
    end
  rescue
Douwe Maan's avatar
Douwe Maan committed
909
    self.errors.add(:base, "Can't check your ability to create project")
910
911
  end

Douwe Maan's avatar
Douwe Maan committed
912
913
914
915
916
917
918
919
920
921
922
923
924
  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.")
925
926
  end

927
928
929
930
931
932
933
934
935
936
  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
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
  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
957
  def to_param
958
959
960
961
962
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
963
964
  end

965
966
967
968
  def to_reference_with_postfix
    "#{to_reference(full: true)}#{self.class.reference_postfix}"
  end

969
  # `from` argument can be a Namespace or Project.
970
971
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
972
      full_path
973
    elsif cross_project_reference?(from)
974
975
976
977
      path
    end
  end

978
979
  def to_human_reference(from = nil)
    if cross_namespace_reference?(from)
980
      name_with_namespace
981
    elsif cross_project_reference?(from)
982
983
      name
    end
984
985
  end

986
  def web_url
987
    Gitlab::Routing.url_helpers.project_url(self)
988
989
  end

Imre Farkas's avatar
Imre Farkas committed
990
991
992
993
994
995
996
  def readme_url
    readme = repository.readme
    if readme
      Gitlab::Routing.url_helpers.project_blob_url(self, File.join(default_branch, readme.path))
    end
  end

997
  def new_issuable_address(author, address_type)
998
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author