project.rb 69.7 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
59
  ignore_column :import_status, :import_jid, :import_error

60
61
  cache_markdown_field :description, pipeline: :description

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

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

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

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

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

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

88
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
89

90
  before_save :ensure_runners_token
91

Jasper Maes's avatar
Jasper Maes committed
92
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
93
94
95

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

96
  after_create :create_project_feature, unless: :project_feature
97
98
99
100
101

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

Mark Chao's avatar
Mark Chao committed
102
  after_create :set_timestamps_for_create
103
  after_update :update_forks_visibility_level
104

105
  before_destroy :remove_private_deploy_keys
106

107
  use_fast_destroy :build_trace_chunks
108

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

112
113
  after_validation :check_pending_delete

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

120
  acts_as_ordered_taggable
121

122
  attr_accessor :old_path_with_namespace
123
  attr_accessor :template_name
124
  attr_writer :pipeline_status
125
  attr_accessor :skip_disk_validation
126

127
128
  alias_attribute :title, :name

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

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

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

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

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

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

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

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

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

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

233
234
  has_many :internal_ids

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

Shinya Maeda's avatar
Shinya Maeda committed
239
  has_one :cluster_project, class_name: 'Clusters::Project'
240
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
241
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
242
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
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
  # The relation :all_pipelines is intended to be used when we want to get the
253
254
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
255
  # The relation :ci_pipelines is intended to be used when we want to get only
256
257
258
259
  # 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,
260
          -> { ci_sources },
261
262
          class_name: 'Ci::Pipeline',
          inverse_of: :project
263
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
264
265
266
267
268

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

282
  has_one :auto_devops, class_name: 'ProjectAutoDevops'
283
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
284

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

288
289
  has_many :remote_mirrors, inverse_of: :project

290
  accepts_nested_attributes_for :variables, allow_destroy: true
291
  accepts_nested_attributes_for :project_feature, update_only: true
292
  accepts_nested_attributes_for :import_data
293
  accepts_nested_attributes_for :auto_devops, update_only: true
294
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
295

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

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

303
  delegate :name, to: :owner, allow_nil: true, prefix: true
304
  delegate :members, to: :team, prefix: true
305
  delegate :add_user, :add_users, to: :team
306
307
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
308
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
309
  delegate :root_ancestor, to: :namespace, allow_nil: true
310
  delegate :last_pipeline, to: :commit, allow_nil: true
311
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
312
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
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: :should_validate_visibility_level?
  validate :visibility_level_allowed_as_fork, if: :should_validate_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_desc, -> { 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_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
411
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
412
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
413

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

419
420
421
422
423
424
  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

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

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

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

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

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

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

466
467
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
468
469
470
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

471
472
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
473
            user.authorizations_for_projects(min_access_level: min_access_level),
474
475
476
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
477
478
479
    end
  end

480
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
481
  # they are only available to team members. This scope returns projects where
482
  # the feature is either public, enabled, or internal with permission for the user.
483
484
485
  # Note: this scope doesn't enforce that the user has access to the projects, it just checks
  # that the user has access to the feature. It's important to use this scope with others
  # that checks project authorizations first.
486
487
488
489
  #
  # 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.
490
  def self.with_feature_available_for_user(feature, user)
491
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
492
493
494
495

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
496
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
497
498
      column = ProjectFeature.quoted_access_level_column(feature)

499
      with_project_feature
500
501
502
503
504
505
      .where("#{column} IS NULL OR #{column} IN (:public_visible) OR (#{column} = :private_visible AND EXISTS (:authorizations))",
            {
              public_visible: visible,
              private_visible: ProjectFeature::PRIVATE,
              authorizations: user.authorizations_for_projects(min_access_level: min_access_level)
            })
506
    else
507
508
      # This has to be added to include features whose value is nil in the db
      visible << nil
509
510
      with_feature_access_level(feature, visible)
    end
511
  end
Felipe Artur's avatar
Felipe Artur committed
512

Rémy Coutable's avatar
Rémy Coutable committed
513
514
  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) }
515

516
517
  scope :excluding_project, ->(project) { where.not(id: project) }

518
519
  # 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") }
520
  scope :for_group, -> (group) { where(group: group) }
521

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
522
  class << self
523
524
525
526
527
528
529
    # 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.
530
    def search(query)
531
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
532
    end
533

534
    def search_by_title(query)
535
      non_archived.fuzzy_search(query, [:name])
536
537
    end

538
539
540
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
541

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

    def reference_pattern
562
      %r{
563
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
564
565
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
566
      }x
567
    end
568

569
570
571
572
    def reference_postfix
      '>'
    end

573
574
575
576
    def reference_postfix_escaped
      '&gt;'
    end

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

587
    def trending
588
589
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
590
    end
591
592
593
594
595
596

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

    def group_ids
599
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
600
    end
601
602
603
604
605
606
607
608
609
610
611

    # Returns ids of projects with milestones available for given user
    #
    # Used on queries to find milestones which user can see
    # For example: Milestone.where(project_id: ids_with_milestone_available_for(user))
    def ids_with_milestone_available_for(user)
      with_issues_enabled = with_issues_available_for_user(user).select(:id)
      with_merge_requests_enabled = with_merge_requests_available_for_user(user).select(:id)

      from_union([with_issues_enabled, with_merge_requests_enabled]).select(:id)
    end
612
613
  end

614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
  def initialize(attributes = {})
    # We can't use default_value_for because the database has a default
    # value of 0 for visibility_level. If someone attempts to create a
    # private project, default_value_for will assume that the
    # visibility_level hasn't changed and will use the application
    # setting default, which could be internal or public. For projects
    # inside a private group, those levels are invalid.
    #
    # To fix the problem, we assign the actual default in the application if
    # no explicit visibility has been initialized.
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

631
632
633
634
635
636
637
638
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

639
640
641
642
643
644
645
646
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

647
648
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
649
  def ancestors_upto(top = nil, hierarchy_order: nil)
650
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
651
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
652
653
  end

654
655
  alias_method :ancestors, :ancestors_upto

656
  def lfs_enabled?
657
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
658

659
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
660
661
  end

Cindy Pallares's avatar
Cindy Pallares committed
662
663
  alias_method :lfs_enabled, :lfs_enabled?

664
  def auto_devops_enabled?
665
    if auto_devops&.enabled.nil?
666
      has_auto_devops_implicitly_enabled?
667
668
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
669
    end
670
671
  end

672
  def has_auto_devops_implicitly_enabled?
673
674
675
    auto_devops_config = first_auto_devops_config

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

678
  def has_auto_devops_implicitly_disabled?
679
680
681
682
683
684
685
686
687
    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) }
688
689
  end

690
691
692
693
  def multiple_mr_assignees_enabled?
    Feature.enabled?(:multiple_merge_request_assignees, self)
  end

Jacopo's avatar
Jacopo committed
694
695
696
697
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

698
699
700
701
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
702
  def team
703
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
704
705
706
  end

  def repository
707
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
708
709
  end

710
  def cleanup
711
712
713
    @repository = nil
  end

714
715
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
716
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
717
    if Gitlab.config.registry.enabled
718
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
719
    end
720
721
  end

722
  def has_container_registry_tags?
723
724
725
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
726
      has_root_container_repository_tags?
727
728
  end

729
730
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
731
732
  end

733
734
735
736
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

737
738
739
740
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

741
  # ref can't be HEAD, can only be branch/tag name or SHA
742
  def latest_successful_build_for(job_name, ref = default_branch)
743
    latest_pipeline = ci_pipelines.latest_successful_for(ref)
744
    return unless latest_pipeline
745

746
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
747
748
  end

749
  def latest_successful_build_for!(job_name, ref = default_branch)
750
751
752
    latest_successful_build_for(job_name, ref) || raise(ActiveRecord::RecordNotFound.new("Couldn't find job #{job_name}"))
  end

753
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
754
    sha = repository.merge_base(first_commit_id, second_commit_id)
755
    commit_by(oid: sha) if sha
756
757
  end

758
  def saved?
759
    id && persisted?
760
761
  end

762
763
764
765
766
767
768
769
  def import_status
    import_state&.status || 'none'
  end

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

770
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
771
772
    job_id =
      if forked?
773
        RepositoryForkWorker.perform_async(id)
774
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
775
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
776
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
777
778
779
      else
        RepositoryImportWorker.perform_async(self.id)
      end
780

781
782
783
784
785
786
787
788
    log_import_activity(job_id)

    job_id
  end

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

789
    if job_id
790
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
791
    else
792
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
793
    end
794
795
  end

796
797
798
799
800
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

801
    import_state.update(last_error: nil)
802
803
804
    remove_import_data
  end

805
  # This method is overridden in EE::Project model
806
  def remove_import_data
807
    import_data&.destroy
808
809
  end

810
  def ci_config_path=(value)
811
    # Strip all leading slashes so that //foo -> foo
812
    super(value&.delete("\0"))
813
814
  end

815
  def import_url=(value)
816
817
818
819
820
821
822
    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
823
824
825
  end

  def import_url
James Lopez's avatar
James Lopez committed
826
    if import_data && super.present?
827
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
828
829
830
      import_url.full_url
    else
      super
831
    end
832
833
  rescue
    super
834
  end
835

James Lopez's avatar
James Lopez committed
836
  def valid_import_url?
837
    valid?(:import_url) || errors.messages[:import_url].nil?
James Lopez's avatar
James Lopez committed
838
839
  end

840
  def create_or_update_import_data(data: nil, credentials: nil)
841
    return if data.nil? && credentials.nil?
842

James Lopez's avatar
James Lopez committed
843
    project_import_data = import_data || build_import_data
844

845
846
    project_import_data.merge_data(data.to_h)
    project_import_data.merge_credentials(credentials.to_h)