Read about our upcoming Code of Conduct on this issue

project.rb 61.4 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
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
  after_create -> { SiteStatistic.track(STATISTICS_ATTRIBUTE) }
101
  before_destroy -> { SiteStatistic.untrack(STATISTICS_ATTRIBUTE) }
102

103
104
105
106
  after_create :create_ci_cd_settings,
    unless: :ci_cd_settings,
    if: proc { ProjectCiCdSetting.available? }

Mark Chao's avatar
Mark Chao committed
107
  after_create :set_timestamps_for_create
108
  after_update :update_forks_visibility_level
109

110
  before_destroy :remove_private_deploy_keys
111

112
  use_fast_destroy :build_trace_chunks
113

114
  after_destroy -> { run_after_commit { remove_pages } }
115
  after_destroy :remove_exports
Kamil Trzcinski's avatar
Kamil Trzcinski committed
116

117
118
  after_validation :check_pending_delete

119
  # Storage specific hooks
120
  after_initialize :use_hashed_storage
121
  after_create :check_repository_absence!
122
123
  after_create :ensure_storage_path_exists
  after_save :ensure_storage_path_exists, if: :namespace_id_changed?
124

125
  acts_as_ordered_taggable
126

127
  attr_accessor :old_path_with_namespace
128
  attr_accessor :template_name
129
  attr_writer :pipeline_status
130
  attr_accessor :skip_disk_validation
131

132
133
  alias_attribute :title, :name

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

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

145
  # Project services
146
  has_one :campfire_service
blackst0ne's avatar
blackst0ne committed
147
  has_one :discord_service
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
174
175
176
  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
177
  has_one :packagist_service
178
  has_one :hangouts_chat_service
179

180
181
182
183
184
  has_one :root_of_fork_network,
          foreign_key: 'root_project_id',
          inverse_of: :root_project,
          class_name: 'ForkNetwork'
  has_one :fork_network_member
185
  has_one :fork_network, through: :fork_network_member
186
187
188
  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
189

190
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
191
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
192

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

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

213
  alias_method :members, :project_members
214
  has_many :users, through: :project_members
215

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

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

234
235
  has_many :internal_ids

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

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

244
245
  has_many :prometheus_metrics

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

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

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

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

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

278
279
  has_many :remote_mirrors, inverse_of: :project

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  validates :build_timeout, allow_nil: true,
392
393
394
395
                            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' }
396

397
398
399
400
401
402
403
  # 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

404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
  # 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

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

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

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

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

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

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

466
467
  # 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") }
468
  scope :for_group, -> (group) { where(group: group) }
469

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

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

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

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

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

514
515
516
517
    def reference_postfix
      '>'
    end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

592
  def cleanup
593
594
595
    @repository = nil
  end

596
597
  alias_method :reload_repository!, :cleanup

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    job_id
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

    project_import_data
734
  end
735

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

  def external_import?
741
742
743
    import_url.present?
  end

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

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

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

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

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
790
  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

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

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

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

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

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

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

862
  # `from` argument can be a Namespace or Project.
863
864
  def to_reference(from = nil, full: false)
    if full || cross_namespace_reference?(from)
865
      full_path
Oswaldo Ferreira's avatar