From aef9ce78eca5f7a0dae98d67af8fb72ebd1fafb7 Mon Sep 17 00:00:00 2001
From: "mkanat%bugzilla.org" <>
Date: Wed, 30 Sep 2009 23:42:49 +0000
Subject: Bug 364254: Add hook to Bugzilla::Template::quoteUrls Patch by Max
 Kanat-Alexander <mkanat@bugzilla.org> r=dkl, a=mkanat

---
 extensions/example/code/bug-format_comment.pl  | 45 ++++++++++++++++++++++++++
 extensions/example/lib/Bugzilla/ExampleHook.pm | 43 ++++++++++++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 extensions/example/code/bug-format_comment.pl
 create mode 100644 extensions/example/lib/Bugzilla/ExampleHook.pm

(limited to 'extensions')

diff --git a/extensions/example/code/bug-format_comment.pl b/extensions/example/code/bug-format_comment.pl
new file mode 100644
index 000000000..c11e8cac2
--- /dev/null
+++ b/extensions/example/code/bug-format_comment.pl
@@ -0,0 +1,45 @@
+# -*- Mode: perl; indent-tabs-mode: nil -*-
+#
+# The contents of this file are subject to the Mozilla Public
+# License Version 1.1 (the "License"); you may not use this file
+# except in compliance with the License. You may obtain a copy of
+# the License at http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS
+# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# rights and limitations under the License.
+#
+# The Original Code is the Bugzilla Example Plugin.
+#
+# The Initial Developer of the Original Code is Canonical Ltd.
+# Portions created by Canonical Ltd. are Copyright (C) 2009
+# Canonical Ltd. All Rights Reserved.
+#
+# Contributor(s):
+#   Max Kanat-Alexander <mkanat@bugzilla.org>
+
+
+use strict;
+use warnings;
+use Bugzilla;
+use Bugzilla::ExampleHook qw(replace_bar);
+
+# This replaces every occurrence of the word "foo" with the word
+# "bar"
+
+my $regexes = Bugzilla->hook_args->{'regexes'};
+push(@$regexes, { match => qr/\bfoo\b/, replace => 'bar' });
+
+# And this links every occurrence of the word "bar" to example.com,
+# but it won't affect "foo"s that have already been turned into "bar"
+# above (because each regex is run in order, and later regexes don't modify
+# earlier matches, due to some cleverness in Bugzilla's internals).
+#
+# For example, the phrase "foo bar" would become:
+# bar <a href="http://example.com/bar">bar</a>
+#
+# See lib/Bugzilla/ExampleHook.pm in this extension for the code of 
+# "replace_bar".
+my $bar_match = qr/\b(bar)\b/;
+push(@$regexes, { match => $bar_match, replace => \&replace_bar });
diff --git a/extensions/example/lib/Bugzilla/ExampleHook.pm b/extensions/example/lib/Bugzilla/ExampleHook.pm
new file mode 100644
index 000000000..6452e8fef
--- /dev/null
+++ b/extensions/example/lib/Bugzilla/ExampleHook.pm
@@ -0,0 +1,43 @@
+# -*- Mode: perl; indent-tabs-mode: nil -*-
+#
+# The contents of this file are subject to the Mozilla Public
+# License Version 1.1 (the "License"); you may not use this file
+# except in compliance with the License. You may obtain a copy of
+# the License at http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS
+# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# rights and limitations under the License.
+#
+# The Original Code is the Bugzilla Example Plugin.
+#
+# The Initial Developer of the Original Code is Everything Solved, Inc.
+# Portions created by the Initial Developer are Copyright (C) 2009 the
+# Initial Developer. All Rights Reserved.
+#
+# Contributor(s): 
+#   Max Kanat-Alexander <mkanat@bugzilla.org>
+
+package Bugzilla::ExampleHook;
+use strict;
+use base qw(Exporter);
+our @EXPORT_OK = qw(
+    replace_bar
+);
+
+use Bugzilla::Util qw(html_quote);
+
+# Used by bug-format_comment--see its code for an explanation.
+sub replace_bar {
+    my $params = shift;
+    # $match is the first parentheses match in the $bar_match regex 
+    # in bug-format_comment.pl. We get up to 10 regex matches as 
+    # arguments to this function.
+    my $match = $params->{matches}->[0];
+    # Remember, you have to HTML-escape any data that you are returning!
+    $match = html_quote($match);
+    return qq{<a href="http://example.com/">$match</a>};
+};
+
+1;
-- 
cgit v1.2.3-24-g4f1b