Filter project hooks by branch

Allow specificying a branch filter for a project hook and only trigger
a project hook if either the branch filter is blank or the branch matches.
Only supported for push_events for now.

2 files changed, 39 insertions, 0 deletions

diff --git a/app/models/hooks/active_hook_filter.rb b/app/models/hooks/active_hook_filter.rb
new file mode 100644
index 00000000000..611af971163
--- /dev/null
+++ b/app/models/hooks/active_hook_filter.rb
@@ -0,0 +1,38 @@
+class ActiveHookFilter
+  def initialize(hook)
+    @hook = hook
+  end
+
+  def matches?(hooks_scope, data)
+    return true if hooks_scope != :push_hooks
+    return true if @hook.push_events_branch_filter.blank?
+
+    branch_name = Gitlab::Git.branch_name(data[:ref])
+    exact_match?(branch_name) || wildcard_match?(branch_name)
+  end
+
+  private
+
+  def exact_match?(branch_name)
+    @hook.push_events_branch_filter == branch_name
+  end
+
+  def wildcard_match?(branch_name)
+    return false unless wildcard?
+
+    wildcard_regex === branch_name
+  end
+
+  def wildcard_regex
+    @wildcard_regex ||= begin
+      name = @hook.push_events_branch_filter.gsub('*', 'STAR_DONT_ESCAPE')
+      quoted_name = Regexp.quote(name)
+      regex_string = quoted_name.gsub('STAR_DONT_ESCAPE', '.*?')
+      /\A#{regex_string}\z/
+    end
+  end
+
+  def wildcard?
+    @hook.push_events_branch_filter && @hook.push_events_branch_filter.include?('*')
+  end
+end
diff --git a/app/models/hooks/web_hook.rb b/app/models/hooks/web_hook.rb
index f18aadefa5c..20f15c15277 100644
--- a/app/models/hooks/web_hook.rb
+++ b/app/models/hooks/web_hook.rb
@@ -9,6 +9,7 @@ class WebHook < ActiveRecord::Base
                                                 allow_local_network: lambda(&:allow_local_requests?) }
 
   validates :token, format: { without: /\n/ }
+  validates :push_events_branch_filter, branch_filter: true
 
   def execute(data, hook_name)
     WebHookService.new(self, data, hook_name).execute