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
286
  has_many :remote_mirrors, inverse_of: :project

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

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

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

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

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

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

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

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

355
  # 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
356
  scope :sorted_by_activity, -> { reorder(Arel.sql("GREATEST(COALESCE(last_activity_at, '1970-01-01'), COALESCE(last_repository_updated_at, '1970-01-01')) DESC")) }
357
  scope :sorted_by_stars_desc, -> { reorder(star_count: :desc) }
358
  scope :sorted_by_stars_asc, -> { reorder(star_count: :asc) }
359
  scope :sorted_by_name_asc_limited, ->(limit) { reorder(name: :asc).limit(limit) }
360

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

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

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

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

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

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

417
  enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
418

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

545
546
547
548
    def reference_postfix
      '>'
    end

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

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

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

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

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

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

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

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

    super
  end

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

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

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

632
633
  alias_method :ancestors, :ancestors_upto

634
635
636
637
638
639
640
  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

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

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

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

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

657
  def has_auto_devops_implicitly_enabled?
658
659
660
    auto_devops_config = first_auto_devops_config

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

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

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

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

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

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

691
  def cleanup
692
693
694
    @repository = nil
  end

695
696
  alias_method :reload_repository!, :cleanup

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

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

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

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

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

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

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

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

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

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

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

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

741
742
  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}"))
743
744
  end

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

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

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

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

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

773
774
775
776
777
    log_import_activity(job_id)

    job_id
  end

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

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

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

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

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

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

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

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