project.rb 70.3 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
18
  include ProjectAPICompatibility
Felipe Artur's avatar
Felipe Artur committed
19
  include ProjectFeaturesCompatibility
20
  include SelectForProjectAuthorization
21
  include Presentable
22
  include Routable
23
  include GroupDescendant
24
  include Gitlab::SQL::Pattern
25
  include DeploymentPlatform
26
  include ::Gitlab::Utils::StrongMemoize
27
  include ChronicDurationAttribute
28
  include FastDestroyAll::Helpers
Jan Provaznik's avatar
Jan Provaznik committed
29
  include WithUploads
30
  include BatchDestroyDependentAssociations
31
  include FeatureGate
32
  include OptionallySearch
33
  include FromUnion
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
  cache_markdown_field :description, pipeline: :description

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

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

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

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

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

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

86
  before_validation :mark_remote_mirrors_for_removal, if: -> { RemoteMirror.table_exists? }
87

88
  before_save :ensure_runners_token
89

Jasper Maes's avatar
Jasper Maes committed
90
  after_save :update_project_statistics, if: :saved_change_to_namespace_id?
91
92
93

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

94
  after_create :create_project_feature, unless: :project_feature
95
96
97
98
99

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

Mark Chao's avatar
Mark Chao committed
100
  after_create :set_timestamps_for_create
101
  after_update :update_forks_visibility_level
102

103
  before_destroy :remove_private_deploy_keys
104

105
  use_fast_destroy :build_trace_chunks
106

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

110
111
  after_validation :check_pending_delete

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

118
  acts_as_ordered_taggable
119

120
  attr_accessor :old_path_with_namespace
121
  attr_accessor :template_name
122
  attr_writer :pipeline_status
123
  attr_accessor :skip_disk_validation
124

125
126
  alias_attribute :title, :name

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

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

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

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

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

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

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

209
  alias_method :members, :project_members
210
  has_many :users, through: :project_members
211

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

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

230
231
  has_many :internal_ids

232
  has_one :import_data, class_name: 'ProjectImportData', inverse_of: :project, autosave: true
233
  has_one :project_feature, inverse_of: :project
234
  has_one :statistics, class_name: 'ProjectStatistics'
235

Shinya Maeda's avatar
Shinya Maeda committed
236
  has_one :cluster_project, class_name: 'Clusters::Project'
237
  has_many :clusters, through: :cluster_project, class_name: 'Clusters::Cluster'
238
  has_many :cluster_ingresses, through: :clusters, source: :application_ingress, class_name: 'Clusters::Applications::Ingress'
239
  has_many :kubernetes_namespaces, class_name: 'Clusters::KubernetesNamespace'
240

241
242
  has_many :prometheus_metrics

243
244
245
  # 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.
246
  has_many :container_repositories, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
247

248
  has_many :commit_statuses
249
  # The relation :all_pipelines is intended to be used when we want to get the
250
251
  # whole list of pipelines associated to the project
  has_many :all_pipelines, class_name: 'Ci::Pipeline', inverse_of: :project
252
  # The relation :ci_pipelines is intended to be used when we want to get only
253
254
255
256
  # 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,
257
          -> { ci_sources },
258
259
          class_name: 'Ci::Pipeline',
          inverse_of: :project
260
  has_many :stages, class_name: 'Ci::Stage', inverse_of: :project
261
262
263
264
265

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

Nick Thomas's avatar
Nick Thomas committed
279
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
280
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
281

282
  has_many :project_badges, class_name: 'ProjectBadge'
283
  has_one :ci_cd_settings, class_name: 'ProjectCiCdSetting', inverse_of: :project, autosave: true, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
284

285
  has_many :remote_mirrors, inverse_of: :project
286
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
287

288
  accepts_nested_attributes_for :variables, allow_destroy: true
289
  accepts_nested_attributes_for :project_feature, update_only: true
290
  accepts_nested_attributes_for :import_data
291
  accepts_nested_attributes_for :auto_devops, update_only: true
292
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
293

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

298
  accepts_nested_attributes_for :error_tracking_setting, update_only: true
299
  accepts_nested_attributes_for :metrics_setting, update_only: true, allow_destroy: true
300

301
  delegate :name, to: :owner, allow_nil: true, prefix: true
302
  delegate :members, to: :team, prefix: true
303
  delegate :add_user, :add_users, to: :team
304
305
  delegate :add_guest, :add_reporter, :add_developer, :add_maintainer, :add_role, to: :team
  delegate :add_master, to: :team # @deprecated
306
  delegate :group_runners_enabled, :group_runners_enabled=, :group_runners_enabled?, to: :ci_cd_settings
307
  delegate :root_ancestor, to: :namespace, allow_nil: true
308
  delegate :last_pipeline, to: :commit, allow_nil: true
309
  delegate :external_dashboard_url, to: :metrics_setting, allow_nil: true, prefix: true
310
  delegate :default_git_depth, :default_git_depth=, to: :ci_cd_settings, prefix: :ci
311

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

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

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

352
353
354
  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) }
355

356
  # last_activity_at is throttled every minute, but last_repository_updated_at is updated with every push
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
357
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
358
  scope :sorted_by_stars_desc, -> { reorder(star_count: :desc) }
359
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
360
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
361

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

  # "enabled" here means "not disabled". It includes private features!
  scope :with_feature_enabled, ->(feature) {
384
385
386
387
    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)
388
389
390
391
392
393
394
395
  }

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

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

406
407
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
408
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
409
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, 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
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
419

420
  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
421
    default: 3600, error_message: _('Maximum job timeout has a value which could not be accepted')
422
423

  validates :build_timeout, allow_nil: true,
424
425
426
                            numericality: { greater_than_or_equal_to: 10.minutes,
                                            less_than: 1.month,
                                            only_integer: true,
427
                                            message: _('needs to be between 10 minutes and 1 month') }
428

429
430
431
  # Used by Projects::CleanupService to hold a map of rewritten object IDs
  mount_uploader :bfg_object_map, AttachmentUploader

432
433
434
435
436
437
438
  # 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

439
440
441
442
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

443
444
  # Returns a collection of projects that is either public or visible to the
  # logged in user.
445
446
447
  def self.public_or_visible_to_user(user = nil, min_access_level = nil)
    min_access_level = nil if user&.admin?

448
449
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
450
            user.authorizations_for_projects(min_access_level: min_access_level),
451
452
453
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
454
455
456
    end
  end

457
  # project features may be "disabled", "internal", "enabled" or "public". If "internal",
458
  # they are only available to team members. This scope returns projects where
459
  # the feature is either public, enabled, or internal with permission for the user.
460
461
462
  # 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.
463
464
465
466
  #
  # 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.
467
  def self.with_feature_available_for_user(feature, user)
468
    visible = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
469
470
471
472

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
473
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
474
475
      column = ProjectFeature.quoted_access_level_column(feature)

476
      with_project_feature
477
478
479
480
481
482
      .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)
            })
483
    else
484
485
      # This has to be added to include features whose value is nil in the db
      visible << nil
486
487
      with_feature_access_level(feature, visible)
    end
488
  end
Felipe Artur's avatar
Felipe Artur committed
489

Rémy Coutable's avatar
Rémy Coutable committed
490
491
  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) }
492

493
494
  scope :excluding_project, ->(project) { where.not(id: project) }

495
496
  # 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") }
497
  scope :for_group, -> (group) { where(group: group) }
498

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
499
  class << self
500
501
502
503
504
505
506
    # 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.
507
    def search(query)
508
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
509
    end
510

511
    def search_by_title(query)
512
      non_archived.fuzzy_search(query, [:name])
513
514
    end

515
516
517
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
518

519
    def sort_by_attribute(method)
520
521
      case method.to_s
      when 'storage_size_desc'
Markus Koller's avatar
Markus Koller committed
522
523
524
        # 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')
525
526
527
528
      when 'latest_activity_desc'
        reorder(last_activity_at: :desc)
      when 'latest_activity_asc'
        reorder(last_activity_at: :asc)
529
      when 'stars_desc'
530
        sorted_by_stars_desc
531
532
      when 'stars_asc'
        sorted_by_stars_asc
533
534
      else
        order_by(method)
535
536
      end
    end
537
538

    def reference_pattern
539
      %r{
540
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
541
542
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
543
      }x
544
    end
545

546
547
548
549
    def reference_postfix
      '>'
    end

550
551
552
553
    def reference_postfix_escaped
      '&gt;'
    end

554
    # Pattern used to extract `namespace/project>` project references from text.
555
556
    # '>' or its escaped form ('&gt;') are checked for because '>' is sometimes escaped
    # when the reference comes from an external source.
557
558
559
    def markdown_reference_pattern
      %r{
        #{reference_pattern}
560
        (#{reference_postfix}|#{reference_postfix_escaped})
561
562
563
      }x
    end

564
    def trending
565
566
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
567
    end
568
569
570
571
572
573

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

    def group_ids
576
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
577
    end
578
579
580
581
582
583
584
585
586
587
588

    # 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
589
590
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
591
  def initialize(attributes = nil)
592
593
594
595
596
597
598
599
600
    # 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.
Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
601
602
    attributes ||= {}

603
604
605
606
607
608
609
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

610
611
612
613
614
615
616
617
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

618
619
620
621
622
623
624
625
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

626
627
  # returns all ancestor-groups upto but excluding the given namespace
  # when no namespace is given, all ancestors upto the top are returned
628
  def ancestors_upto(top = nil, hierarchy_order: nil)
629
    Gitlab::ObjectHierarchy.new(Group.where(id: namespace_id))
630
      .base_and_ancestors(upto: top, hierarchy_order: hierarchy_order)
631
632
  end

633
634
  alias_method :ancestors, :ancestors_upto

635
636
637
638
639
640
641
  def emails_disabled?
    strong_memoize(:emails_disabled) do
      # disabling in the namespace overrides the project setting
      Feature.enabled?(:emails_disabled, self, default_enabled: true) && (super || namespace.emails_disabled?)
    end
  end

642
  def lfs_enabled?
643
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
644

645
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
646
647
  end

Cindy Pallares's avatar
Cindy Pallares committed
648
649
  alias_method :lfs_enabled, :lfs_enabled?

650
  def auto_devops_enabled?
651
    if auto_devops&.enabled.nil?
652
      has_auto_devops_implicitly_enabled?
653
654
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
655
    end
656
657
  end

658
  def has_auto_devops_implicitly_enabled?
659
660
661
    auto_devops_config = first_auto_devops_config

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

664
  def has_auto_devops_implicitly_disabled?
665
666
667
668
669
670
671
672
673
    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) }
674
675
  end

Jacopo's avatar
Jacopo committed
676
677
678
679
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

680
681
682
683
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
684
  def team
685
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
686
687
688
  end

  def repository
689
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
690
691
  end

692
  def cleanup
693
694
695
    @repository = nil
  end

696
697
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
698
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
699
    if Gitlab.config.registry.enabled
700
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
701
    end
702
703
  end

704
  def has_container_registry_tags?
705
706
707
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
708
      has_root_container_repository_tags?
709
710
  end

711
712
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
713
714
  end

715
716
717
718
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

719
720
721
722
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

Matija Čupić's avatar
Matija Čupić committed
723
  # ref can't be HEAD, can only be branch/tag name
724
  def latest_successful_build_for_ref(job_name, ref = default_branch)
Matija Čupić's avatar
Matija Čupić committed
725
726
    return unless ref

727
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
728
    return unless latest_pipeline
729

730
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
731
732
  end

733
  def latest_successful_build_for_sha(job_name, sha)
Matija Čupić's avatar
Matija Čupić committed
734
735
736
    return unless sha

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
737
    return unless latest_pipeline
738

739
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
740
741
  end

742
743
  def latest_successful_build_for_ref!(job_name, ref = default_branch)
    latest_successful_build_for_ref(job_name, ref) || raise(ActiveRecord::RecordNotFound.new("Couldn't find job #{job_name}"))
744
745
  end

746
  def merge_base_commit(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
747
    sha = repository.merge_base(first_commit_id, second_commit_id)
748
    commit_by(oid: sha) if sha
749
750
  end

751
  def saved?
752
    id && persisted?
753
754
  end

755
756
757
758
759
760
761
762
  def import_status
    import_state&.status || 'none'
  end

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

763
  def add_import_job
Douwe Maan's avatar
Douwe Maan committed
764
765
    job_id =
      if forked?
766
        RepositoryForkWorker.perform_async(id)
767
      elsif gitlab_project_import?
James Lopez's avatar
James Lopez committed
768
        # Do not retry on Import/Export until https://gitlab.com/gitlab-org/gitlab-ce/issues/26189 is solved.
769
        RepositoryImportWorker.set(retry: false).perform_async(self.id)
Douwe Maan's avatar
Douwe Maan committed
770
771
772
      else
        RepositoryImportWorker.perform_async(self.id)
      end
773

774
775
776
777
778
    log_import_activity(job_id)

    job_id
  end

Mayra Cabrera's avatar
Mayra Cabrera committed
779
  # rubocop:disable Gitlab/RailsLogger
780
781
782
  def log_import_activity(job_id, type: :import)
    job_type = type.to_s.capitalize

783
    if job_id
784
      Rails.logger.info("#{job_type} job scheduled for #{full_path} with job ID #{job_id}.")
785
    else
786
      Rails.logger.error("#{job_type} job failed to create for #{full_path}.")
787
    end
788
  end
Mayra Cabrera's avatar
Mayra Cabrera committed
789
  # rubocop:enable Gitlab/RailsLogger
790

791
792
793
794
795
  def reset_cache_and_import_attrs
    run_after_commit do
      ProjectCacheWorker.perform_async(self.id)
    end

796
    import_state.update(last_error: nil)
797
798
799
    remove_import_data
  end

800
  # This method is overridden in EE::Project model
801
  def remove_import_data
802
    import_data&.destroy
803
804
  end

805
  def ci_config_path=(value)
806
    # Strip all leading slashes so that //foo -> foo
807
    super(value&.delete("\0"))
808
809
  end

810
  def import_url=(value)
811
812
813
814
815
816
817
    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
818
819
820
  end

  def import_url
James Lopez's avatar
James Lopez committed
821
    if import_data && super.present?
822
      import_url = Gitlab::UrlSanitizer.new(super, credentials: import_data.credentials)
James Lopez's avatar
James Lopez committed
823
824
825
      import_url.full_url
    else
      super
826
    end
Yorick Peterse's avatar