Extract SSH Key identifier generator into a class

Author: root

Diff for: app/controllers/gitolite_public_keys_controller.rb

@@ -18,6 +18,7 @@ def index
   def create
     if params[:create_button]
       @gitolite_public_key = @user.gitolite_public_keys.new(params[:gitolite_public_key])
+      @gitolite_public_key.identifier = GeneratePublicKeyIdentifier.new(@gitolite_public_key, @user).call
       if @gitolite_public_key.save
         create_ssh_key(@gitolite_public_key)
         flash[:notice] = l(:notice_public_key_created, title: view_context.keylabel(@gitolite_public_key))

Diff for: app/models/gitolite_public_key.rb

@@ -6,8 +6,6 @@ class GitolitePublicKey < ActiveRecord::Base
   KEY_TYPE_USER   = 0
   KEY_TYPE_DEPLOY = 1
 
-  DEPLOY_PSEUDO_USER = 'deploy_key'
-
   ## Attributes
   attr_accessible :title, :key, :key_type, :delete_when_unused
 
@@ -39,7 +37,6 @@ class GitolitePublicKey < ActiveRecord::Base
   before_validation :strip_whitespace
   before_validation :remove_control_characters
 
-  before_validation :set_identifier
   before_validation :set_fingerprint
 
 
@@ -91,12 +88,12 @@ def gitolite_path
 
   # Make sure that current identifier is consistent with current user login.
   # This method explicitly overrides the static nature of the identifier
-  def reset_identifiers
+  def reset_identifiers(opts = {})
     # Fix identifier
     self.identifier = nil
     self.fingerprint = nil
 
-    set_identifier
+    self.identifier = GeneratePublicKeyIdentifier.new(self, user, opts).call
     set_fingerprint
 
     # Need to override the "never change identifier" constraint
@@ -147,53 +144,6 @@ def remove_control_characters
     end
 
 
-    # Returns the unique identifier for this key based on the key_type
-    #
-    # For user public keys, this simply is the user's gitolite_identifier.
-    # For deployment keys, we use an incrementing number.
-    #
-    def set_identifier
-      return nil if user_id.nil?
-      if user_key?
-        set_identifier_for_user_key
-      elsif deploy_key?
-        set_identifier_for_deploy_key
-      end
-    end
-
-
-    def set_identifier_for_user_key
-      tag = self.title.gsub(/[^0-9a-zA-Z]/, '_')
-      self.identifier ||= [ user.gitolite_identifier, '@', 'redmine_', tag ].join
-    end
-
-
-    def set_identifier_for_deploy_key
-      self.identifier ||= deploy_key_identifier
-    end
-
-
-    # Fix https://github.com/jbox-web/redmine_git_hosting/issues/288
-    # Getting user deployment keys count is not sufficient to assure uniqueness of
-    # deployment key identifier. So we need an 'external' counter to increment the global count
-    # while a key with this identifier exists.
-    #
-    def deploy_key_identifier
-      count = 0
-      begin
-        key_id = generate_deploy_key_identifier(count)
-        count += 1
-      end while user.gitolite_public_keys.deploy_key.map(&:owner).include?(key_id.split('@')[0])
-      key_id
-    end
-
-
-    def generate_deploy_key_identifier(count)
-      key_count = user.gitolite_public_keys.deploy_key.length + 1 + count
-      [ user.gitolite_identifier, '_', DEPLOY_PSEUDO_USER, '_', key_count, '@', 'redmine_', DEPLOY_PSEUDO_USER, '_', key_count ].join
-    end
-
-
     def set_fingerprint
       begin
         self.fingerprint = RedmineGitHosting::Utils.ssh_fingerprint(key)

Diff for: app/use_cases/generate_public_key_identifier.rb

@@ -0,0 +1,62 @@
+class GeneratePublicKeyIdentifier
+  unloadable
+
+  DEPLOY_PSEUDO_USER = 'deploy_key'
+
+  attr_reader :public_key
+  attr_reader :user
+  attr_reader :skip_auto_increment
+
+
+  def initialize(public_key, user, opts = {})
+    @public_key          = public_key
+    @user                = user
+    @skip_auto_increment = opts.delete(:skip_auto_increment){ false }
+  end
+
+
+  # Returns the unique identifier for this key based on the key_type
+  #
+  # For user public keys, this simply is the user's gitolite_identifier.
+  # For deployment keys, we use an incrementing number.
+  #
+  def call
+    if public_key.user_key?
+      set_identifier_for_user_key
+    elsif public_key.deploy_key?
+      set_identifier_for_deploy_key
+    end
+  end
+
+
+  private
+
+
+    def set_identifier_for_user_key
+      tag = public_key.title.gsub(/[^0-9a-zA-Z]/, '_')
+      [ user.gitolite_identifier, '@', 'redmine_', tag ].join
+    end
+
+
+    # Fix https://github.com/jbox-web/redmine_git_hosting/issues/288
+    # Getting user deployment keys count is not sufficient to assure uniqueness of
+    # deployment key identifier. So we need an 'external' counter to increment the global count
+    # while a key with this identifier exists.
+    #
+    def set_identifier_for_deploy_key
+      count = 0
+      begin
+        key_id = generate_deploy_key_identifier(count)
+        count += 1
+      end while user.gitolite_public_keys.deploy_key.map(&:owner).include?(key_id.split('@')[0])
+      key_id
+    end
+
+
+    def generate_deploy_key_identifier(count)
+      key_count = 1 + count
+      key_count += user.gitolite_public_keys.deploy_key.length unless skip_auto_increment
+      [ user.gitolite_identifier, '_', DEPLOY_PSEUDO_USER, '_', key_count, '@', 'redmine_', DEPLOY_PSEUDO_USER, '_', key_count ].join
+    end
+
+end

Diff for: app/use_cases/regenerate_ssh_keys.rb

@@ -12,7 +12,7 @@ def initialize(opts = {})
   def call
     GitolitePublicKey.all.each do |ssh_key|
       GitoliteAccessor.destroy_ssh_key(ssh_key, bypass_sidekiq: bypass_sidekiq)
-      ssh_key.reset_identifiers
+      ssh_key.reset_identifiers(skip_auto_increment: true)
       GitoliteAccessor.create_ssh_key(ssh_key, bypass_sidekiq: bypass_sidekiq)
     end
   end