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

3
4
require 'carrierwave/orm/activerecord'

5
class Project < ApplicationRecord
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
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
  ignore_column :import_status, :import_jid, :import_error
59
  ignore_column :ci_id
60

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::CurrentSettings.default_project_visibility }
77
  default_value_for :resolve_outdated_diff_discussions, false
78
  default_value_for :container_registry_enabled, gitlab_config_features.container_registry
79
80
  default_value_for(:repository_storage) { Gitlab::CurrentSettings.pick_repository_storage }
  default_value_for(:shared_runners_enabled) { Gitlab::CurrentSettings.shared_runners_enabled }
81
82
83
84
85
  default_value_for :issues_enabled, gitlab_config_features.issues
  default_value_for :merge_requests_enabled, gitlab_config_features.merge_requests
  default_value_for :builds_enabled, gitlab_config_features.builds
  default_value_for :wiki_enabled, gitlab_config_features.wiki
  default_value_for :snippets_enabled, gitlab_config_features.snippets
86
  default_value_for :only_allow_merge_if_all_discussions_are_resolved, false
87

88
  add_authentication_token_field :runners_token, encrypted: -> { Feature.enabled?(:projects_tokens_optional_encryption, default_enabled: true) ? :optional : :required }
89

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

92
  before_save :ensure_runners_token
93

Jasper Maes's avatar
Jasper Maes committed
94
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
95
96
97

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

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

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

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

107
  before_destroy :remove_private_deploy_keys
108

109
  use_fast_destroy :build_trace_chunks
110

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

114
115
  after_validation :check_pending_delete

116
  # Storage specific hooks
117
  after_initialize :use_hashed_storage
118
  after_create :check_repository_absence!
119
  after_create :ensure_storage_path_exists
Jasper Maes's avatar
Jasper Maes committed
120
  after_save :ensure_storage_path_exists, if: :saved_change_to_namespace_id?
121

122
  acts_as_ordered_taggable
123

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

129
130
  alias_attribute :title, :name

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

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

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

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

188
  has_one :import_state, autosave: true, class_name: 'ProjectImportState', inverse_of: :project
189
  has_one :import_export_upload, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
190
  has_one :project_repository, inverse_of: :project
191
  has_one :error_tracking_setting, inverse_of: :project, class_name: 'ErrorTracking::ProjectErrorTrackingSetting'
192
  has_one :metrics_setting, inverse_of: :project, class_name: 'ProjectMetricsSetting'
193

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

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

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

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

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

235
236
  has_many :internal_ids

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

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

246
247
  has_many :prometheus_metrics

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

253
  has_many :commit_statuses
254
  # The relation :all_pipelines is intended to be used when we want to get the
255
256
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
257
  # The relation :ci_pipelines is intended to be used when we want to get only
258
259
260
261
  # those pipeline which are directly related to CI. There are
  # other pipelines, like webide ones, that we won't retrieve
  # if we use this relation.
  has_many :ci_pipelines,
262
          -> { ci_sources },
263
264
          class_name: 'Ci::Pipeline',
          inverse_of: :project
265
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
266
267
268
269
270

  # 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.
271
  has_many :builds, class_name: 'Ci::Build', inverse_of: :project, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
272
  has_many :build_trace_section_names, class_name: 'Ci::BuildTraceSectionName'
273
  has_many :build_trace_chunks, class_name: 'Ci::BuildTraceChunk', through: :builds, source: :trace_chunks
274
  has_many :runner_projects, class_name: 'Ci::RunnerProject', inverse_of: :project
275
  has_many :runners, through: :runner_projects, source: :runner, class_name: 'Ci::Runner'
276
  has_many :variables, class_name: 'Ci::Variable'
277
278
  has_many :triggers, class_name: 'Ci::Trigger'
  has_many :environments
279
  has_many :deployments, -> { success }
280
  has_many :pipeline_schedules, class_name: 'Ci::PipelineSchedule'
Mayra Cabrera's avatar
Mayra Cabrera committed
281
  has_many :project_deploy_tokens
282
  has_many :deploy_tokens, through: :project_deploy_tokens
283

284
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
285
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
286

287
  has_many :project_badges, class_name: 'ProjectBadge'
288
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
289

290
291
  has_many :remote_mirrors, inverse_of: :project

292
  accepts_nested_attributes_for :variables, allow_destroy: true
293
  accepts_nested_attributes_for :project_feature, update_only: true
294
  accepts_nested_attributes_for :import_data
295
  accepts_nested_attributes_for :auto_devops, update_only: true
296

297
298
299
300
  accepts_nested_attributes_for :remote_mirrors,
                                allow_destroy: true,
                                reject_if: ->(attrs) { attrs[:id].blank? && attrs[:url].blank? }

301
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
302
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
303

304
  delegate :name, to: :owner, allow_nil: true, prefix: true
305
  delegate :members, to: :team, prefix: true
306
  delegate :add_user, :add_users, to: :team
307
308
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
309
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
310
311
  delegate :group_clusters_enabled?, to: :group, allow_nil: true
  delegate :root_ancestor, to: :namespace, allow_nil: true
312
  delegate :last_pipeline, to: :commit, allow_nil: true
313

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
314
  # Validations
315
  validates :creator, presence: true, on: :create
316
  validates :description, length: { maximum: 2000 }, allow_blank: true
317
  validates :ci_config_path,
318
    format: { without: %r{(\.{2}|\A/)},
319
              message: _('cannot include leading slash or directory traversal.') },
320
321
    length: { maximum: 255 },
    allow_blank: true
322
323
  validates :name,
    presence: true,
324
    length: { maximum: 255 },
325
    format: { with: Gitlab::Regex.project_name_regex,
Douwe Maan's avatar
Douwe Maan committed
326
              message: Gitlab::Regex.project_name_regex_message }
327
328
  validates :path,
    presence: true,
329
    project_path: true,
330
    length: { maximum: 255 }
331

332
  validates :namespace, presence: true
Douwe Maan's avatar
Douwe Maan committed
333
  validates :name, uniqueness: { scope: :namespace_id }
334
  validates :import_url, public_url: { schemes: ->(project) { project.persisted? ? VALID_MIRROR_PROTOCOLS : VALID_IMPORT_PROTOCOLS },
335
336
                                       ports: ->(project) { project.persisted? ? VALID_MIRROR_PORTS : VALID_IMPORT_PORTS },
                                       enforce_user: true }, if: [:external_import?, :import_url_changed?]
337
  validates :star_count, numericality: { greater_than_or_equal_to: 0 }
338
  validate :check_personal_projects_limit, on: :create
339
  validate :check_repository_path_availability, on: :update, if: ->(project) { project.renamed? }
340
341
  validate :visibility_level_allowed_by_group, if: -> { changes.has_key?(:visibility_level) }
  validate :visibility_level_allowed_as_fork, if: -> { changes.has_key?(:visibility_level) }
342
  validate :check_wiki_path_conflict
Rob Watson's avatar
Rob Watson committed
343
  validate :validate_pages_https_only, if: -> { changes.has_key?(:pages_https_only) }
344
345
346
  validates :repository_storage,
    presence: true,
    inclusion: { in: ->(_object) { Gitlab.config.repositories.storages.keys } }
347
  validates :variables, variable_duplicates: { scope: :environment_scope }
348
  validates :bfg_object_map, file_size: { maximum: :max_attachment_size }
349

350
  # Scopes
351
  scope :pending_delete, -> { where(pending_delete: true) }
352
  scope :without_deleted, -> { where(pending_delete: false) }
353

354
355
356
  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) }
357

358
359
  # 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") }
360
  scope :sorted_by_stars, -> { reorder(star_count: :desc) }
361
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
362

363
  scope :in_namespace, ->(namespace_ids) { where(namespace_id: namespace_ids) }
364
  scope :personal, ->(user) { where(namespace_id: user.namespace_id) }
365
  scope :joined, ->(user) { where('namespace_id != ?', user.namespace_id) }
Toon Claes's avatar
Toon Claes committed
366
  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
367
  scope :visible_to_user, ->(user) { where(id: user.authorized_projects.select(:id).reorder(nil)) }
368
  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)) }
369
  scope :archived, -> { where(archived: true) }
370
  scope :non_archived, -> { where(archived: false) }
371
  scope :for_milestones, ->(ids) { joins(:milestones).where('milestones.id' => ids).distinct }
Rémy Coutable's avatar
Rémy Coutable committed
372
  scope :with_push, -> { joins(:events).where('events.action = ?', Event::PUSHED) }
373
  scope :with_project_feature, -> { joins('LEFT JOIN project_features ON projects.id = project_features.project_id') }
Markus Koller's avatar
Markus Koller committed
374
  scope :with_statistics, -> { includes(:statistics) }
375
  scope :with_shared_runners, -> { where(shared_runners_enabled: true) }
376
377
378
  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.
379
380
    joins("INNER JOIN routes rs ON rs.source_id = projects.id AND rs.source_type = 'Project'")
      .where('rs.path LIKE ?', "#{sanitize_sql_like(path)}/%")
381
  end
382
383
384

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
385
386
387
388
    access_level_attribute = ProjectFeature.arel_table[ProjectFeature.access_level_attribute(feature)]
    enabled_feature = access_level_attribute.gt(ProjectFeature::DISABLED).or(access_level_attribute.eq(nil))

    with_project_feature.where(enabled_feature)
389
390
391
392
393
394
395
396
  }

  # 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 })
  }

397
398
399
400
401
402
403
404
405
406
  # Picks projects which use the given programming language
  scope :with_programming_language, ->(language_name) do
    lang_id_query = ProgrammingLanguage
        .with_name_case_insensitive(language_name)
        .select(:id)

    joins(:repository_languages)
        .where(repository_languages: { programming_language_id: lang_id_query })
  end

407
408
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
409
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
410
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
411
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
412

413
414
415
416
417
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

418
419
420
421
422
423
  scope :missing_kubernetes_namespace, -> (kubernetes_namespaces) do
    subquery = kubernetes_namespaces.select('1').where('clusters_kubernetes_namespaces.project_id = projects.id')

    where('NOT EXISTS (?)', subquery)
  end

424
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
425

426
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
427
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
428
429

  validates :build_timeout, allow_nil: true,
430
431
432
                            numericality: { greater_than_or_equal_to: 10.minutes,
                                            less_than: 1.month,
                                            only_integer: true,
433
                                            message: _('needs to be beetween 10 minutes and 1 month') }
434

435
436
437
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

438
439
440
441
442
443
444
  # 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

445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
  # 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

465
466
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
467
468
469
470
471
472
473
  def self.public_or_visible_to_user(user = nil)
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
            user.authorizations_for_projects,
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
474
475
476
    end
  end

477
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
478
  # they are only available to team members. This scope returns projects where
479
  # the feature is either public, enabled, or internal with permission for the user.
480
481
482
483
  #
  # 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.
484
  def self.with_feature_available_for_user(feature, user)
485
486
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
    min_access_level = ProjectFeature.required_minimum_access_level(feature)
487
488
489
490
491
492

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

493
      with_project_feature
494
495
496
497
498
499
500
501
502
        .where(
          "(projects.visibility_level > :private AND (#{column} IS NULL OR #{column} >= (:public_visible) OR (#{column} = :private_visible AND EXISTS(:authorizations))))"\
          " OR (projects.visibility_level = :private AND (#{column} IS NULL OR #{column} >= :private_visible) AND EXISTS(:authorizations))",
          {
            private: Gitlab::VisibilityLevel::PRIVATE,
            public_visible: ProjectFeature::ENABLED,
            private_visible: ProjectFeature::PRIVATE,
            authorizations: user.authorizations_for_projects(min_access_level: min_access_level)
          })
503
504
505
    else
      with_feature_access_level(feature, visible)
    end
506
  end
Felipe Artur's avatar
Felipe Artur committed
507

Rémy Coutable's avatar
Rémy Coutable committed
508
509
  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) }
510

511
512
  scope :excluding_project, ->(project) { where.not(id: project) }

513
514
  # 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") }
515
  scope :for_group, -> (group) { where(group: group) }
516

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
517
  class << self
518
519
520
521
522
523
524
    # 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.
525
    def search(query)
526
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
527
    end
528

529
    def search_by_title(query)
530
      non_archived.fuzzy_search(query, [:name])
531
532
    end

533
534
535
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
536

537
    def sort_by_attribute(method)
538
539
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
540
541
542
        # 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')
543
544
545
546
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
547
548
      when 'stars_desc'
        sorted_by_stars
549
550
      when 'stars_asc'
        sorted_by_stars_asc
551
552
      else
        order_by(method)
553
554
      end
    end
555
556

    def reference_pattern
557
      %r{
558
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
559
560
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
561
      }x
562
    end
563

564
565
566
567
    def reference_postfix
      '>'
    end

568
569
570
571
    def reference_postfix_escaped
      '&gt;'
    end

572
    # Pattern used to extract `namespace/project>` project references from text.
573
574
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
575
576
577
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
578
        (#{reference_postfix}|#{reference_postfix_escaped})
579
580
581
      }x
    end

582
    def trending
583
584
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
585
    end
586
587
588
589
590
591

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

    def group_ids
594
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
595
    end
596
597
  end

598
599
600
601
602
603
604
605
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

606
607
608
609
610
611
612
613
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

614
615
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
616
  def ancestors_upto(top = nil, hierarchy_order: nil)
617
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
618
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
619
620
  end

621
622
  alias_method :ancestors, :ancestors_upto

623
  def lfs_enabled?
624
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
625

626
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
627
628
  end

Cindy Pallares's avatar
Cindy Pallares committed
629
630
  alias_method :lfs_enabled, :lfs_enabled?

631
  def auto_devops_enabled?
632
    if auto_devops&.enabled.nil?
633
      has_auto_devops_implicitly_enabled?
634
635
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
636
    end
637
638
  end

639
  def has_auto_devops_implicitly_enabled?
640
641
642
    auto_devops_config = first_auto_devops_config

    auto_devops_config[:scope] != :project && auto_devops_config[:status]
643
644
  end

645
  def has_auto_devops_implicitly_disabled?
646
647
648
649
650
651
652
653
654
    auto_devops_config = first_auto_devops_config

    auto_devops_config[:scope] != :project && !auto_devops_config[:status]
  end

  def first_auto_devops_config
    return namespace.first_auto_devops_config if auto_devops&.enabled.nil?

    { scope: :project, status: auto_devops&.enabled || Feature.enabled?(:force_autodevops_on_by_default, self) }
655
656
  end

657
658
659
660
  def multiple_mr_assignees_enabled?
    Feature.enabled?(:multiple_merge_request_assignees, self)
  end

Jacopo's avatar
Jacopo committed
661
662
663
664
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

665
666
667
668
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
669
  def team
670
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
671
672
673
  end

  def repository
674
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
675
676
  end

677
  def cleanup
678
679
680
    @repository = nil
  end

681
682
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
683
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
684
    if Gitlab.config.registry.enabled
685
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
686
    end
687
688
  end

689
  def has_container_registry_tags?
690
691
692
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
693
      has_root_container_repository_tags?
694
695
  end

696
697
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
698
699
  end

700
701
702
703
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

704
705
706
707
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

708
  # ref can't be HEAD, can only be branch/tag name or SHA
709
  def latest_successful_build_for(job_name, ref = default_branch)
710
    latest_pipeline = ci_pipelines.latest_successful_for(ref)
711
    return unless latest_pipeline
712

713
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
714
715
  end

716
  def latest_successful_build_for!(job_name, ref = default_branch)
717
718
719
    latest_successful_build_for(job_name, ref) || raise(ActiveRecord::RecordNotFound.new("Couldn't find job #{job_name}"))
  end

720
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
721
    sha = repository.merge_base(first_commit_id, second_commit_id)
722
    commit_by(oid: sha) if sha
723
724
  end

725
  def saved?
726
    id && persisted?
727
728
  end

729
730
731
732
733
734
735
736
  def import_status
    import_state&.status || 'none'
  end

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

737
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
738
739
    job_id =
      if forked?
740
        RepositoryForkWorker.perform_async(id)
741
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
742
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
743
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
744
745
746
      else
        RepositoryImportWorker.perform_async(self.id)
      end
747

748
749
750
751
752
753
754
755
    log_import_activity(job_id)

    job_id
  end

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

756
    if job_id
757
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
758
    else
759
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
760
    end
761
762
  end

763
764
765
766
767
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

768
    import_state.update(last_error: nil)
769
770
771
    remove_import_data
  end

772
  # This method is overridden in EE::Project model
773
  def remove_import_data
774
    import_data&.destroy
775
776
  end

777
  def ci_config_path=(value)
778
    # Strip all leading slashes so that //foo -> foo
779
    super(value&.delete("\0"))
780
781
  end

782
  def import_url=(value)
783
784
785
786
787
788
789
    if Gitlab::UrlSanitizer.valid?(value)
      import_url = Gitlab::UrlSanitizer.new(value)
      super(import_url.sanitized_url)
      create_or_update_import_data(credentials: import_url.credentials)
    else
      super(value)
    end
790
791
792
  end

  def import_url
James Lopez's avatar
James Lopez committed
793
    if import_data && super.present?
794
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
795
796
797
      import_url.full_url
    else
      super
798
    end
799
800
  rescue
    super
801
  end
802

James Lopez's avatar
James Lopez committed
803
  def valid_import_url?
804
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
805
806
  end

807
  def create_or_update_import_data(data: nil, credentials: nil)
808
    return if data.nil? && credentials.nil?
809

James Lopez's avatar
James Lopez committed
810
    project_import_data = import_data || build_import_data
811

812
813
    project_import_data.merge_data(data.to_h)
    project_import_data.merge_credentials(credentials.to_h)
814
815

    project_import_data
816
  end
817

818
  def import?
James Lopez's avatar
James Lopez committed
819
    external_import? || forked? || gitlab_project_import? || bare_repository_import?
820
821
822
  end

  def external_import?
823
824
825
    import_url.present?
  end

826
  def safe_import_url
827
    Gitlab::UrlSanitizer.new(import_url).masked_url
828
829
  end

830
831
832
833
  def bare_repository_import?
    import_type == 'bare_repository'
  end

834
835
836
837
  def gitlab_project_import?
    import_type == 'gitlab_project'
  end

Rémy Coutable's avatar
Rémy Coutable committed
838
839
840
841
  def gitea_import?
    import_type == 'gitea'
  end

842
843
844
845