project.rb 66.9 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
  # Valids ports to import from
  VALID_IMPORT_PORTS = [22, 80, 443].freeze

55
56
  cache_markdown_field :description, pipeline: :description

57
58
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
           :merge_requests_enabled?, :issues_enabled?, to: :project_feature,
59
                                                       allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
60

61
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
62

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

76
  add_authentication_token_field :runners_token
77

78
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
79

80
81
  before_save :ensure_runners_token

Markus Koller's avatar
Markus Koller committed
82
  after_save :update_project_statistics, if: :namespace_id_changed?
83
84
85

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

86
  after_create :create_project_feature, unless: :project_feature
87

88
  after_create -> { SiteStatistic.track(STATISTICS_ATTRIBUTE) }
89
  before_destroy -> { SiteStatistic.untrack(STATISTICS_ATTRIBUTE) }
90

91
92
93
94
  after_create :create_ci_cd_settings,
    unless: :ci_cd_settings,
    if: proc { ProjectCiCdSetting.available? }

95
  after_create :set_last_activity_at
96
  after_create :set_last_repository_updated_at
97
  after_update :update_forks_visibility_level
98

99
  before_destroy :remove_private_deploy_keys
100

101
  use_fast_destroy :build_trace_chunks
102

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

106
107
  after_validation :check_pending_delete

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

114
  acts_as_ordered_taggable
115

116
  attr_accessor :old_path_with_namespace
117
  attr_accessor :template_name
118
  attr_writer :pipeline_status
119
  attr_accessor :skip_disk_validation
120

121
122
  alias_attribute :title, :name

123
  # Relations
124
  belongs_to :creator, class_name: 'User'
125
  belongs_to :group, -> { where(type: 'Group') }, foreign_key: 'namespace_id'
126
  belongs_to :namespace
127
128
  alias_method :parent, :namespace
  alias_attribute :parent_id, :namespace_id
129

130
  has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
131
  has_many :boards, before_add: :validate_board_limit
132
133

  # Project services
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
  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 :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
158
  has_one :kubernetes_service, inverse_of: :project
159
160
161
162
163
  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
164
  has_one :packagist_service
165
  has_one :hangouts_chat_service
166

167
  # TODO: replace these relations with the fork network versions
168
  has_one  :forked_project_link,  foreign_key: "forked_to_project_id"
169
  has_one  :forked_from_project,  through:   :forked_project_link
170

171
172
  has_many :forked_project_links, foreign_key: "forked_from_project_id"
  has_many :forks,                through:     :forked_project_links, source: :forked_to_project
173
174
175
176
177
178
179
180
  # 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
181

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

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

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

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

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

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

226
227
  has_many :internal_ids

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

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

236
237
  has_many :prometheus_metrics

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

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

  # 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.
251
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
252
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
253
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
254
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
255
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
256
  has_many :variables, class_name: 'Ci::Variable'
257
258
259
260
  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
261
262
  has_many :project_deploy_tokens
  has_many :deploy_tokens, through: :project_deploy_tokens
263

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

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

270
271
  has_many :remote_mirrors, inverse_of: :project

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

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

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

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

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

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

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

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

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

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

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

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

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

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

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
  # 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

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

421
422
423
  # 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.
424
425
426
427
  #
  # 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.
428
  def self.with_feature_available_for_user(feature, user)
429
    visible = [nil, ProjectFeature::ENABLED]
430

431
432
433
434
    if user&.admin?
      with_feature_enabled(feature)
    elsif user
      column = ProjectFeature.quoted_access_level_column(feature)
435

436
437
      with_project_feature
        .where("#{column} IN (?) OR (#{column} = ? AND EXISTS (?))",
438
439
              visible,
              ProjectFeature::PRIVATE,
440
              user.authorizations_for_projects)
441
442
443
    else
      with_feature_access_level(feature, visible)
    end
444
  end
Felipe Artur's avatar
Felipe Artur committed
445

Rémy Coutable's avatar
Rémy Coutable committed
446
447
  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) }
448

449
450
  scope :excluding_project, ->(project) { where.not(id: project) }

451
452
  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'") }
453

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
454
  class << self
455
456
457
458
459
460
461
    # 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.
462
    def search(query)
463
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
464
465
    end

466
    def search_by_title(query)
467
      non_archived.fuzzy_search(query, [:name])
468
469
    end

470
471
472
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
473

474
    def sort_by_attribute(method)
475
476
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
477
478
479
        # 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')
480
481
482
483
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
484
485
      when 'stars_desc'
        sorted_by_stars
486
487
      else
        order_by(method)
488
489
      end
    end
490
491

    def reference_pattern
492
      %r{
493
494
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
495
      }x
496
    end
497

498
499
500
501
    def reference_postfix
      '>'
    end

502
503
504
505
    def reference_postfix_escaped
      '&gt;'
    end

506
    # Pattern used to extract `namespace/project>` project references from text.
507
508
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
509
510
511
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
512
        (#{reference_postfix}|#{reference_postfix_escaped})
513
514
515
      }x
    end

516
    def trending
517
518
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
519
    end
520
521
522
523
524
525

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

    def group_ids
528
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
529
    end
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
530
531
  end

532
533
534
535
536
537
538
  # 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

539
  def lfs_enabled?
540
541
542
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?

    self[:lfs_enabled] && Gitlab.config.lfs.enabled
543
544
  end

545
  def auto_devops_enabled?
546
    if auto_devops&.enabled.nil?
547
      has_auto_devops_implicitly_enabled?
548
    else
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
549
550
      auto_devops.enabled?
    end
551
552
  end

553
  def has_auto_devops_implicitly_enabled?
554
555
    auto_devops&.enabled.nil? &&
      (Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
556
557
  end

558
  def has_auto_devops_implicitly_disabled?
559
    auto_devops&.enabled.nil? && !(Gitlab::CurrentSettings.auto_devops_enabled? || Feature.enabled?(:force_autodevops_on_by_default, self))
560
561
  end

562
563
564
565
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
566
  def team
567
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
568
569
570
  end

  def repository
571
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
572
573
  end

574
  def cleanup
575
576
577
    @repository = nil
  end

578
579
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
580
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
581
    if Gitlab.config.registry.enabled
582
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
583
    end
584
585
  end

586
  def has_container_registry_tags?
587
588
589
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
590
      has_root_container_repository_tags?
591
592
  end

593
594
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
595
596
  end

597
598
599
600
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

601
602
603
604
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

605
  # ref can't be HEAD, can only be branch/tag name or SHA
606
  def latest_successful_builds_for(ref = default_branch)
607
    latest_pipeline = pipelines.latest_successful_for(ref)
608
609

    if latest_pipeline
610
      latest_pipeline.builds.latest.with_artifacts_archive
611
612
613
    else
      builds.none
    end
614
615
  end

616
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
617
    sha = repository.merge_base(first_commit_id, second_commit_id)
618
    commit_by(oid: sha) if sha
619
620
  end

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
621
  def saved?
622
    id && persisted?
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
623
624
  end

625
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
626
627
    job_id =
      if forked?
628
        RepositoryForkWorker.perform_async(id)
629
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
630
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
631
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
632
633
634
      else
        RepositoryImportWorker.perform_async(self.id)
      end
635

636
637
638
639
640
641
642
643
    log_import_activity(job_id)

    job_id
  end

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

644
    if job_id
645
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
646
    else
647
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
648
    end
649
650
  end

651
  def reset_cache_and_import_attrs
652
653
654
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end
655

656
    update(import_error: nil)
657
658
659
660
661
    remove_import_data
  end

  # This method is overriden in EE::Project model
  def remove_import_data
662
    import_data&.destroy
663
664
  end

665
  def ci_config_path=(value)
666
    # Strip all leading slashes so that //foo -> foo
667
    super(value&.delete("\0"))
668
669
  end

670
  def import_url=(value)
James Lopez's avatar
James Lopez committed
671
672
    return super(value) unless Gitlab::UrlSanitizer.valid?(value)

673
    import_url = Gitlab::UrlSanitizer.new(value)
James Lopez's avatar
James Lopez committed
674
    super(import_url.sanitized_url)
675
    create_or_update_import_data(credentials: import_url.credentials)
676
677
678
  end

  def import_url
James Lopez's avatar
James Lopez committed
679
    if import_data && super.present?
680
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
681
682
683
      import_url.full_url
    else
      super
684
685
686
    end
  end

James Lopez's avatar
James Lopez committed
687
  def valid_import_url?
688
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
689
690
  end

691
  def create_or_update_import_data(data: nil, credentials: nil)
692
    return if data.nil? && credentials.nil?
693

694
    project_import_data = import_data || build_import_data
James Lopez's avatar
James Lopez committed
695
696
697
698
    if data
      project_import_data.data ||= {}
      project_import_data.data = project_import_data.data.merge(data)
    end
699

700
701
702
703
    if credentials
      project_import_data.credentials ||= {}
      project_import_data.credentials = project_import_data.credentials.merge(credentials)
    end
704
705

    project_import_data
706
707
  end

708
  def import?
James Lopez's avatar
James Lopez committed
709
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
710
711
712
  end

  def external_import?
713
714
715
    import_url.present?
  end

716
  def imported?
717
718
719
720
    import_finished?
  end

  def import_in_progress?
721
722
723
    import_started? || import_scheduled?
  end

724
725
726
727
728
729
730
731
  def import_state_args
    {
      status: self[:import_status],
      jid: self[:import_jid],
      last_error: self[:import_error]
    }
  end

732
733
  def ensure_import_state(force: false)
    return if !force && (self[:import_status] == 'none' || self[:import_status].nil?)
734
735
    return unless import_state.nil?

736
737
    if persisted?
      create_import_state(import_state_args)
738

739
740
741
742
743
744
      update_column(:import_status, 'none')
    else
      build_import_state(import_state_args)

      self[:import_status] = 'none'
    end
745
746
  end

747
748
749
750
751
752
  def human_import_status_name
    ensure_import_state

    import_state.human_status_name
  end

753
  def import_schedule
754
    ensure_import_state(force: true)
755

756
    import_state.schedule
757
758
759
  end

  def force_import_start
760
    ensure_import_state(force: true)
761

762
    import_state.force_start
763
764
765
  end

  def import_start
766
    ensure_import_state(force: true)
767

768
    import_state.start
769
770
771
  end

  def import_fail
772
    ensure_import_state(force: true)
773

774
    import_state.fail_op
775
776
777
  end

  def import_finish
778
    ensure_import_state(force: true)
779

780
    import_state.finish
781
782
783
  end

  def import_jid=(new_jid)
784
    ensure_import_state(force: true)
785

786
    import_state.jid = new_jid
787
788
789
790
791
792
793
794
795
  end

  def import_jid
    ensure_import_state

    import_state&.jid
  end

  def import_error=(new_error)
796
    ensure_import_state(force: true)
797

798
    import_state.last_error = new_error
799
800
801
802
803
804
805
806
807
  end

  def import_error
    ensure_import_state

    import_state&.last_error
  end

  def import_status=(new_status)
808
    ensure_import_state(force: true)
809

810
    import_state.status = new_status
811
812
813
814
815
816
817
818
819
820
821
822
  end

  def import_status
    ensure_import_state

    import_state&.status || 'none'
  end

  def no_import?
    import_status == 'none'
  end

823
  def import_started?
824
825
    # import? does SQL work so only run it if it looks like there's an import running
    import_status == 'started' && import?
826
827
  end

828
829
830
831
  def import_scheduled?
    import_status == 'scheduled'
  end

832
833
834
835
836
837
  def import_failed?
    import_status == 'failed'
  end

  def import_finished?
    import_status == 'finished'
838
839
  end

840
  def safe_import_url
841
    Gitlab::UrlSanitizer.new(import_url).masked_url
842
843
  end

844
845
846
847
  def bare_repository_import?
    import_type == 'bare_repository'
  end

848
849
850
851
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
852
853
854
855
  def gitea_import?
    import_type == 'gitea'
  end

856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
  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

887
  def check_limit
Douwe Maan's avatar
Douwe Maan committed
888
    unless creator.can_create_project? || namespace.kind == 'group'
889
890
891
      projects_limit = creator.projects_limit

      if projects_limit == 0
Phil Hughes's avatar
Phil Hughes committed
892
        self.errors.add(:limit_reached, "Personal project creation is not allowed. Please contact your administrator with questions")
893
      else
Phil Hughes's avatar
Phil Hughes committed
894
        self.errors.add(:limit_reached, "Your project limit is #{projects_limit} projects! Please contact your administrator to increase it")
895
      end
896
897
    end
  rescue
Douwe Maan's avatar
Douwe Maan committed
898
    self.errors.add(:base, "Can't check your ability to create project")
899
900
  end

Douwe Maan's avatar
Douwe Maan committed
901
902
903
904
905
906
907
908
909
910
911
912
913
  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.")
914
915
  end

916
917
918
919
920
921
922
923
924
925
  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
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
  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
946
  def to_param
947
948
949
950
951
    if persisted? && errors.include?(:path)
      path_was
    else
      path
    end
Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
952
953
  end

954
955
956
957
  def to_reference_with_postfix
    "#{to_reference(full: true)}#{self.class.reference_postfix}"
  end

958
  # `from` argument can be a Namespace or Project.
959
960
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
961
      full_path
962
    elsif cross_project_reference?(from)
963
964
965
966
      path
    end
  end

967
968
  def to_human_reference(from = nil)
    if cross_namespace_reference?(from)
969
      name_with_namespace
970
    elsif cross_project_reference?(from)
971
972
      name
    end
973
974
  end

975
  def web_url
976
    Gitlab::Routing.url_helpers.project_url(self)
977
978
  end

Imre Farkas's avatar
Imre Farkas committed
979
980
981
982
983
984
985
  def readme_url
    readme = repository.readme
    if readme
      Gitlab::Routing.url_helpers.project_blob_url(self, File.join(default_branch, readme.path))
    end
  end

986
  def new_issuable_address(author, address_type)
987
    return unless Gitlab::IncomingEmail.supports_issue_creation? && author
988

989
990
    author.ensure_incoming_email_token!

991
    suffix = address_type == 'merge_request' ? '+merge-request' : ''
992
    Gitlab::IncomingEmail.reply_address(
993
      "#{full_path}#{suffix}+#{author.incoming_email_token}")
994
995
  end

996
  def build_commit_note(commit)
997
    notes.new(commit_id: commit.id, noteable_type: 'Commit')
Dmitriy Zaporozhets's avatar
v1.0  
Dmitriy Zaporozhets committed
998
  end
Nihad Abbasov's avatar
Nihad Abbasov committed
999

1000
  def last_activity
1001
    last_event