project.rb 70.6 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

George Koltsov's avatar
George Koltsov committed
58
59
  SORTING_PREFERENCE_FIELD = :projects_sort

60
61
  cache_markdown_field :description, pipeline: :description

62
  delegate :feature_available?, :builds_enabled?, :wiki_enabled?,
63
           :merge_requests_enabled?, :issues_enabled?, :pages_enabled?, :public_pages?,
64
65
           :merge_requests_access_level, :issues_access_level, :wiki_access_level,
           :snippets_access_level, :builds_access_level, :repository_access_level,
66
           to: :project_feature, allow_nil: true
Felipe Artur's avatar
Felipe Artur committed
67

68
  delegate :base_dir, :disk_path, :ensure_storage_path_exists, to: :storage
69

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

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

76
  default_value_for :archived, false
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
  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
174
  has_one :packagist_service
175
  has_one :hangouts_chat_service
176

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

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

193
  # Merge Requests for target project should be removed with it
194
  has_many :merge_requests, foreign_key: 'target_project_id', inverse_of: :target_project
195
  has_many :source_of_merge_requests, foreign_key: 'source_project_id', class_name: 'MergeRequest'
196
197
198
199
200
201
202
203
204
205
  has_many :issues
  has_many :labels, class_name: 'ProjectLabel'
  has_many :services
  has_many :events
  has_many :milestones
  has_many :notes
  has_many :snippets, class_name: 'ProjectSnippet'
  has_many :hooks, class_name: 'ProjectHook'
  has_many :protected_branches
  has_many :protected_tags
206
  has_many :repository_languages, -> { order "share DESC" }
207

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

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

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

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

234
235
  has_many :internal_ids

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

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

245
246
  has_many :prometheus_metrics

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

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

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

Nick Thomas's avatar
Nick Thomas committed
283
  has_one :auto_devops, class_name: 'ProjectAutoDevops', inverse_of: :project, autosave: true
284
  has_many :custom_attributes, class_name: 'ProjectCustomAttribute'
285

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

289
  has_many :remote_mirrors, inverse_of: :project
290
  has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::ProjectStage'
291

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
  accepts_nested_attributes_for :ci_cd_settings, update_only: true
297

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

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

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

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

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

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

356
357
358
  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) }
359

360
  # 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
361
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
362
  scope :sorted_by_stars_desc, -> { reorder(star_count: :desc) }
363
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
364
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
365

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

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

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

400
401
402
403
404
405
406
407
408
409
  # 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

410
411
  scope :with_builds_enabled, -> { with_feature_enabled(:builds) }
  scope :with_issues_enabled, -> { with_feature_enabled(:issues) }
412
  scope :with_issues_available_for_user, ->(current_user) { with_feature_available_for_user(:issues, current_user) }
413
  scope :with_merge_requests_available_for_user, ->(current_user) { with_feature_available_for_user(:merge_requests, current_user) }
414
  scope :with_merge_requests_enabled, -> { with_feature_enabled(:merge_requests) }
415
  scope :with_remote_mirrors, -> { joins(:remote_mirrors).where(remote_mirrors: { enabled: true }).distinct }
416

417
418
419
420
421
  scope :with_group_runners_enabled, -> do
    joins(:ci_cd_settings)
    .where(project_ci_cd_settings: { group_runners_enabled: true })
  end

422
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
423

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

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

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

436
437
438
439
440
441
442
  # 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

443
444
445
446
  def self.eager_load_namespace_and_owner
    includes(namespace: :owner)
  end

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

452
453
    if user
      where('EXISTS (?) OR projects.visibility_level IN (?)',
454
            user.authorizations_for_projects(min_access_level: min_access_level),
455
456
457
            Gitlab::VisibilityLevel.levels_for_user(user))
    else
      public_to_user
458
459
460
    end
  end

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

    if user&.admin?
      with_feature_enabled(feature)
    elsif user
477
      min_access_level = ProjectFeature.required_minimum_access_level(feature)
478
479
      column = ProjectFeature.quoted_access_level_column(feature)

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

Rémy Coutable's avatar
Rémy Coutable committed
494
495
  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) }
496

497
498
  scope :excluding_project, ->(project) { where.not(id: project) }

499
500
  # 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") }
501
  scope :for_group, -> (group) { where(group: group) }
502
  scope :for_group_and_its_subgroups, ->(group) { where(namespace_id: group.self_and_descendants.select(:id)) }
503

Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
504
  class << self
505
506
507
508
509
510
511
    # 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.
512
    def search(query)
513
      fuzzy_search(query, [:path, :name, :description])
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
514
    end
515

516
    def search_by_title(query)
517
      non_archived.fuzzy_search(query, [:name])
518
519
    end

520
521
522
    def visibility_levels
      Gitlab::VisibilityLevel.options
    end
523

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

    def reference_pattern
544
      %r{
545
        (?<!#{Gitlab::PathRegex::PATH_START_CHAR})
546
547
        ((?<namespace>#{Gitlab::PathRegex::FULL_NAMESPACE_FORMAT_REGEX})\/)?
        (?<project>#{Gitlab::PathRegex::PROJECT_PATH_FORMAT_REGEX})
548
      }x
549
    end
550

551
552
553
554
    def reference_postfix
      '>'
    end

555
556
557
558
    def reference_postfix_escaped
      '&gt;'
    end

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

569
    def trending
570
571
      joins('INNER JOIN trending_projects ON projects.id = trending_projects.project_id')
        .reorder('trending_projects.id ASC')
572
    end
573
574
575
576
577
578

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

    def group_ids
581
      joins(:namespace).where(namespaces: { type: 'Group' }).select(:namespace_id)
582
    end
583
584
585
586
587
588
589
590
591
592
593

    # 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
594
595
  end

Heinrich Lee Yu's avatar
Heinrich Lee Yu committed
596
  def initialize(attributes = nil)
597
598
599
600
601
602
603
604
605
    # 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
606
607
    attributes ||= {}

608
609
610
611
612
613
614
    unless visibility_attribute_present?(attributes)
      attributes[:visibility_level] = Gitlab::CurrentSettings.default_project_visibility
    end

    super
  end

615
616
617
618
619
620
621
622
  def all_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

623
624
625
626
627
628
629
630
  def ci_pipelines
    if builds_enabled?
      super
    else
      super.external
    end
  end

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

638
639
  alias_method :ancestors, :ancestors_upto

640
641
642
643
644
645
646
  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

647
  def lfs_enabled?
648
    return namespace.lfs_enabled? if self[:lfs_enabled].nil?
Patricio Cano's avatar
Patricio Cano committed
649

650
    self[:lfs_enabled] && Gitlab.config.lfs.enabled
651
652
  end

Cindy Pallares's avatar
Cindy Pallares committed
653
654
  alias_method :lfs_enabled, :lfs_enabled?

655
  def auto_devops_enabled?
656
    if auto_devops&.enabled.nil?
657
      has_auto_devops_implicitly_enabled?
658
659
    else
      auto_devops.enabled?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
660
    end
661
662
  end

663
  def has_auto_devops_implicitly_enabled?
664
665
666
    auto_devops_config = first_auto_devops_config

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

669
  def has_auto_devops_implicitly_disabled?
670
671
672
673
674
675
676
677
678
    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) }
679
680
  end

Jacopo's avatar
Jacopo committed
681
682
683
684
  def daily_statistics_enabled?
    Feature.enabled?(:project_daily_statistics, self, default_enabled: true)
  end

685
686
687
688
  def empty_repo?
    repository.empty?
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
689
  def team
690
    @team ||= ProjectTeam.new(self)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
691
692
693
  end

  def repository
694
    @repository ||= Repository.new(full_path, self, disk_path: disk_path)
695
696
  end

697
  def cleanup
698
699
700
    @repository = nil
  end

701
702
  alias_method :reload_repository!, :cleanup

Andre Guedes's avatar
Andre Guedes committed
703
  def container_registry_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
704
    if Gitlab.config.registry.enabled
705
      "#{Gitlab.config.registry.host_port}/#{full_path.downcase}"
706
    end
707
708
  end

709
  def has_container_registry_tags?
710
711
712
    return @images if defined?(@images)

    @images = container_repositories.to_a.any?(&:has_tags?) ||
713
      has_root_container_repository_tags?
714
715
  end

716
717
  def commit(ref = 'HEAD')
    repository.commit(ref)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
718
719
  end

720
721
722
723
  def commit_by(oid:)
    repository.commit_by(oid: oid)
  end

724
725
726
727
  def commits_by(oids:)
    repository.commits_by(oids: oids)
  end

Matija Čupić's avatar
Matija Čupić committed
728
  # ref can't be HEAD, can only be branch/tag name
729
  def latest_successful_build_for_ref(job_name, ref = default_branch)
Matija Čupić's avatar
Matija Čupić committed
730
731
    return unless ref

732
    latest_pipeline = ci_pipelines.latest_successful_for_ref(ref)
733
    return unless latest_pipeline
734

735
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
736
737
  end

738
  def latest_successful_build_for_sha(job_name, sha)
Matija Čupić's avatar
Matija Čupić committed
739
740
741
    return unless sha

    latest_pipeline = ci_pipelines.latest_successful_for_sha(sha)
742
    return unless latest_pipeline
743

744
    latest_pipeline.builds.latest.with_artifacts_archive.find_by(name: job_name)
745
746
  end

747
748
  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}"))
749
750
  end

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

756
  def saved?
757
    id && persisted?
758
759
  end

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

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

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

779
780
781
782
783
    log_import_activity(job_id)

    job_id
  end

Mayra Cabrera's avatar
Mayra Cabrera committed
784
  # rubocop:disable Gitlab/RailsLogger
785
786
787
  def log_import_activity(job_id, type: :import)
    job_type = type.to_s.capitalize

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

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