namespace.rb 8.43 KB
Newer Older
1
class Namespace < ActiveRecord::Base
2 3
  acts_as_paranoid

4
  include CacheMarkdownField
5
  include Sortable
6
  include Gitlab::ShellAdapter
7
  include Gitlab::CurrentSettings
8
  include Routable
9

10 11 12 13 14
  # Prevent users from creating unreasonably deep level of nesting.
  # The number 20 was taken based on maximum nesting level of
  # Android repo (15) + some extra backup.
  NUMBER_OF_ANCESTORS_ALLOWED = 20

15 16
  cache_markdown_field :description, pipeline: :description

17
  has_many :projects, dependent: :destroy
18
  has_many :project_statistics
19 20
  belongs_to :owner, class_name: "User"

21 22
  belongs_to :parent, class_name: "Namespace"
  has_many :children, class_name: "Namespace", foreign_key: :parent_id
23
  has_one :chat_team, dependent: :destroy
24

25
  validates :owner, presence: true, unless: ->(n) { n.type == "Group" }
26
  validates :name,
27
    presence: true,
28
    uniqueness: { scope: :parent_id },
29 30
    length: { maximum: 255 },
    namespace_name: true
31

32
  validates :description, length: { maximum: 255 }
33
  validates :path,
34
    presence: true,
35
    length: { maximum: 255 },
36
    dynamic_path: true
37

38 39
  validate :nesting_level_allowed

40 41
  delegate :name, to: :owner, allow_nil: true, prefix: true

42
  after_update :move_dir, if: :path_changed?
43
  after_commit :refresh_access_of_projects_invited_groups, on: :update, if: -> { previous_changes.key?('share_with_group_lock') }
44 45

  # Save the storage paths before the projects are destroyed to use them on after destroy
46
  before_destroy(prepend: true) { prepare_for_destroy }
47
  after_destroy :rm_dir
48

49
  scope :root, -> { where('type IS NULL') }
50

51 52 53 54 55 56 57 58
  scope :with_statistics, -> do
    joins('LEFT JOIN project_statistics ps ON ps.namespace_id = namespaces.id')
      .group('namespaces.id')
      .select(
        'namespaces.*',
        'COALESCE(SUM(ps.storage_size), 0) AS storage_size',
        'COALESCE(SUM(ps.repository_size), 0) AS repository_size',
        'COALESCE(SUM(ps.lfs_objects_size), 0) AS lfs_objects_size',
59
        'COALESCE(SUM(ps.build_artifacts_size), 0) AS build_artifacts_size'
60 61 62
      )
  end

63 64
  class << self
    def by_path(path)
Gabriel Mazetto's avatar
Gabriel Mazetto committed
65
      find_by('lower(path) = :value', value: path.downcase)
66 67 68 69 70 71 72
    end

    # Case insensetive search for namespace by path or name
    def find_by_path_or_name(path)
      find_by("lower(path) = :path OR lower(name) = :path", path: path.downcase)
    end

73 74 75 76 77 78 79
    # Searches for namespaces matching the given query.
    #
    # This method uses ILIKE on PostgreSQL and LIKE on MySQL.
    #
    # query - The search query as a String
    #
    # Returns an ActiveRecord::Relation
80
    def search(query)
81 82 83 84
      t = arel_table
      pattern = "%#{query}%"

      where(t[:name].matches(pattern).or(t[:path].matches(pattern)))
85 86 87
    end

    def clean_path(path)
88
      path = path.dup
89
      # Get the email username by removing everything after an `@` sign.
90
      path.gsub!(/@.*\z/,                "")
91
      # Remove everything that's not in the list of allowed characters.
92 93 94 95 96
      path.gsub!(/[^a-zA-Z0-9_\-\.]/,    "")
      # Remove trailing violations ('.atom', '.git', or '.')
      path.gsub!(/(\.atom|\.git|\.)*\z/, "")
      # Remove leading violations ('-')
      path.gsub!(/\A\-+/,                "")
97

98
      # Users with the great usernames of "." or ".." would end up with a blank username.
99
      # Work around that by setting their username to "blank", followed by a counter.
100 101
      path = "blank" if path.blank?

102
      uniquify = Uniquify.new
103
      uniquify.string(path) { |s| Namespace.find_by_path_or_name(s) }
104
    end
105 106
  end

107
  def to_param
108
    full_path
109
  end
110 111 112 113

  def human_name
    owner_name
  end
114

115
  def move_dir
116
    if any_project_has_container_registry_tags?
117
      raise Gitlab::UpdatePathError.new('Namespace cannot be moved, because at least one project has tags in container registry')
118 119
    end

120 121 122
    # Move the namespace directory in all storages paths used by member projects
    repository_storage_paths.each do |repository_storage_path|
      # Ensure old directory exists before moving it
123
      gitlab_shell.add_namespace(repository_storage_path, full_path_was)
124

125 126
      unless gitlab_shell.mv_namespace(repository_storage_path, full_path_was, full_path)
        Rails.logger.error "Exception moving path #{repository_storage_path} from #{full_path_was} to #{full_path}"
127

128 129
        # if we cannot move namespace directory we should rollback
        # db changes in order to prevent out of sync between db and fs
130
        raise Gitlab::UpdatePathError.new('namespace directory cannot be moved')
131
      end
132 133
    end

134 135
    Gitlab::UploadsTransfer.new.rename_namespace(full_path_was, full_path)
    Gitlab::PagesTransfer.new.rename_namespace(full_path_was, full_path)
136

137 138
    remove_exports!

139 140 141 142 143 144 145 146 147 148
    # If repositories moved successfully we need to
    # send update instructions to users.
    # However we cannot allow rollback since we moved namespace dir
    # So we basically we mute exceptions in next actions
    begin
      send_update_instructions
    rescue
      # Returning false does not rollback after_* transaction but gives
      # us information about failing some of tasks
      false
149
    end
150
  end
151

152
  def any_project_has_container_registry_tags?
153
    all_projects.any?(&:has_container_registry_tags?)
154 155
  end

156
  def send_update_instructions
157
    projects.each do |project|
158
      project.send_move_instructions("#{full_path_was}/#{project.path}")
159
    end
160
  end
161 162 163 164

  def kind
    type == 'Group' ? 'group' : 'user'
  end
165 166

  def find_fork_of(project)
Gabriel Mazetto's avatar
Gabriel Mazetto committed
167
    projects.joins(:forked_project_link).find_by('forked_project_links.forked_from_project_id = ?', project.id)
168
  end
169

170 171 172 173 174
  def lfs_enabled?
    # User namespace will always default to the global setting
    Gitlab.config.lfs.enabled
  end

175 176 177 178
  def shared_runners_enabled?
    projects.with_shared_runners.any?
  end

179 180 181
  # Scopes the model on ancestors of the record
  def ancestors
    if parent_id
182
      path = route ? route.path : full_path
183 184 185 186 187 188 189
      paths = []

      until path.blank?
        path = path.rpartition('/').first
        paths << path
      end

190
      self.class.joins(:route).where('routes.path IN (?)', paths).reorder('routes.path ASC')
191 192 193 194 195 196 197
    else
      self.class.none
    end
  end

  # Scopes the model on direct and indirect children of the record
  def descendants
198
    self.class.joins(:route).merge(Route.inside_path(route.path)).reorder('routes.path ASC')
199 200
  end

201 202 203 204
  def user_ids_for_project_authorizations
    [owner_id]
  end

205 206 207 208
  def parent_changed?
    parent_id_changed?
  end

209 210 211 212 213 214 215 216
  def prepare_for_destroy
    old_repository_storage_paths
  end

  def old_repository_storage_paths
    @old_repository_storage_paths ||= repository_storage_paths
  end

217 218 219 220 221 222
  # Includes projects from this namespace and projects from all subgroups
  # that belongs to this namespace
  def all_projects
    Project.inside_path(full_path)
  end

223 224 225 226
  def has_parent?
    parent.present?
  end

227 228 229 230 231 232 233
  private

  def repository_storage_paths
    # We need to get the storage paths for all the projects, even the ones that are
    # pending delete. Unscoping also get rids of the default order, which causes
    # problems with SELECT DISTINCT.
    Project.unscoped do
234
      all_projects.select('distinct(repository_storage)').to_a.map(&:repository_storage_path)
235 236 237 238 239
    end
  end

  def rm_dir
    # Remove the namespace directory in all storages paths used by member projects
240
    old_repository_storage_paths.each do |repository_storage_path|
241 242
      # Move namespace directory into trash.
      # We will remove it later async
243
      new_path = "#{full_path}+#{id}+deleted"
244

245 246
      if gitlab_shell.mv_namespace(repository_storage_path, full_path, new_path)
        message = "Namespace directory \"#{full_path}\" moved to \"#{new_path}\""
247 248 249 250 251 252 253
        Gitlab::AppLogger.info message

        # Remove namespace directroy async with delay so
        # GitLab has time to remove all projects first
        GitlabShellWorker.perform_in(5.minutes, :rm_namespace, repository_storage_path, new_path)
      end
    end
254 255

    remove_exports!
256
  end
257 258 259 260 261 262 263

  def refresh_access_of_projects_invited_groups
    Group.
      joins(project_group_links: :project).
      where(projects: { namespace_id: id }).
      find_each(&:refresh_members_authorized_projects)
  end
264

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
  def remove_exports!
    Gitlab::Popen.popen(%W(find #{export_path} -not -path #{export_path} -delete))
  end

  def export_path
    File.join(Gitlab::ImportExport.storage_path, full_path_was)
  end

  def full_path_was
    if parent
      parent.full_path + '/' + path_was
    else
      path_was
    end
  end
280 281 282 283 284 285

  def nesting_level_allowed
    if ancestors.count > Group::NUMBER_OF_ANCESTORS_ALLOWED
      errors.add(:parent_id, "has too deep level of nesting")
    end
  end
286
end