[bugzilla-gnome-org-extensions] 4.4 migration: Move some code to Ops

[Krzesimir Nowak <krnowak src gnome org>]

commit 0c912dc7f667e5f10d5d43344992090f84012841
Author: Krzesimir Nowak <qdlacz gmail com>
Date:   Mon Nov 17 23:13:16 2014 +0100

    4.4 migration: Move some code to Ops
    
    Ops are the only user of the code, so it does not need to be exported.

 lib/Ops.pm          |  100 +++++++++++++++++++++++++++++++++++++++++++++++++--
 lib/SplinterUtil.pm |   91 +---------------------------------------------
 2 files changed, 98 insertions(+), 93 deletions(-)
---
diff --git a/lib/Ops.pm b/lib/Ops.pm
index bd5f417..431fe2c 100644
--- a/lib/Ops.pm
+++ b/lib/Ops.pm
@@ -28,12 +28,51 @@ use base qw(Exporter);
 our @EXPORT = qw(
     format_the_comment
     add_panel
+    add_review_links_to_email
     maybe_get_statuses
     add_dispatch
 );
 
 use Bugzilla::Extension::Splinter::SplinterUtil;
 
+sub _attachment_id_is_patch {
+    my ($attach_id) = @_;
+    my $attachment = Bugzilla::Attachment->new($attach_id);
+
+    # The check on attachment_is_visible here is to prevent a tiny
+    # information leak where someone could check if a private
+    # attachment was a patch by creating text that would get linkified
+    # differently. Likely excess paranoia
+    return (defined($attachment) &&
+            attachment_is_visible($attachment) &&
+            $attachment->ispatch());
+}
+
+sub _get_review_url {
+    my ($bug, $attach_id, $absolute) = @_;
+    my $base = Bugzilla->params()->{'splinter_base'};
+    my $bug_id = $bug->id();
+
+    if ($absolute) {
+       my $urlbase = correct_urlbase();
+
+       $urlbase =~ s!/$!! if $base =~ "^/";
+       $base = $urlbase . $base;
+    }
+
+    if ($base =~ /\?/) {
+        return "$base&bug=$bug_id&attachment=$attach_id";
+    } else {
+        return "$base?bug=$bug_id&attachment=$attach_id";
+    }
+}
+
+sub _get_review_link {
+    my ($bug, $attach_id, $link_text) = @_;
+
+    return "<a href='" . html_quote(_get_review_url($bug, $attach_id)) . "'>$link_text</a>";
+}
+
 sub format_the_comment {
     my ($bug, $regexes, $text) = @_;
     # TODO: This is probably used in more places. Avoid redundancy.
@@ -48,8 +87,8 @@ sub format_the_comment {
     # regular expression we return from the hook.
     ${$text} =~ s~((?:^Created\ |\b)attachment\s+(\d+)(\s\[details\])?)
                  ~(push(@$regexes, { match => qr/__REVIEW__$2/,
-                                     replace => get_review_link($bug, "$2", "[review]") })) &&
-                  (attachment_id_is_patch($2) ? "$1 __REVIEW__$2" : $1)
+                                     replace => _get_review_link($bug, "$2", "[review]") })) &&
+                  (_attachment_id_is_patch($2) ? "$1 __REVIEW__$2" : $1)
                  ~egmx;
 
     # And linkify "Review of attachment", this is less of a workaround since
@@ -58,7 +97,7 @@ sub format_the_comment {
     # get the same link.
     if (${$text} =~ $REVIEW_RE) {
         my $attachment_id = $1;
-        my $review_link = get_review_link($bug, $attachment_id, "Review");
+        my $review_link = _get_review_link($bug, $attachment_id, "Review");
         my $attach_link = Bugzilla::Template::get_attachment_link($attachment_id, "attachment 
$attachment_id");
 
         push(@$regexes, { 'match' => $REVIEW_RE,
@@ -72,6 +111,59 @@ sub add_panel {
     $modules->{'Splinter'} = "Bugzilla::Extension::Splinter::Params";
 }
 
+sub _munge_create_attachment {
+    my ($bug, $intro_text, $attach_id, $view_link) = @_;
+
+    if (_attachment_id_is_patch ($attach_id)) {
+       return ("$intro_text" .
+                " View: $view_link\015\012" .
+                " Review: " . _get_review_url($bug, $attach_id, 1) . "\015\012");
+    } else {
+       return ("$intro_text" .
+                " --> ($view_link)");
+    }
+}
+
+# This adds review links into a bug mail before we send it out.  Since
+# this is happening after newlines have been converted into RFC-2822
+# style \r\n, we need handle line ends carefully.  (\015 and \012 are
+# used because Perl \n is platform-dependent)
+sub add_review_links_to_email {
+    my ($email) = @_;
+    my $body = $email->body();
+    my $new_body = undef;
+    my $bug = undef;
+
+    if ($email->header('Subject') =~ /^\[Bug\s+(\d+)\]/)
+    {
+        my $bug_id = $1;
+
+        if (Bugzilla->user()->can_see_bug($bug_id)) {
+            $bug = Bugzilla::Bug->new($bug_id);
+        }
+    }
+
+    return unless defined($bug);
+
+    if ($body =~ /Review\s+of\s+attachment\s+\d+\s*:/) {
+        $body =~ s~(Review\s+of\s+attachment\s+(\d+)\s*:)
+                  ~"$1\015\012 --> (" . _get_review_url($bug, $2, 1) . ")"
+                  ~egx;
+        $new_body = 1;
+    }
+
+    # TODO: Figure out the email format.
+    if ($body =~ /Created attachment [0-9]+\015\012 --> /) {
+        $body =~ s~(Created\ attachment\ ([0-9]+)\015\012)
+                   \ -->\ \(([^\015\012]*)\)[^\015\012]*
+                  ~_munge_create_attachment($bug, $1, $2, $3)
+                  ~egx;
+        $new_body = 1;
+    }
+
+    $email->body_set($body) if $new_body;
+}
+
 sub maybe_get_statuses {
     my ($page, $vars) = @_;
 
@@ -94,3 +186,5 @@ sub add_dispatch {
 
     $dispatches->{'Splinter'} = "Bugzilla::Extension::Splinter::WebService";
 }
+
+1;
diff --git a/lib/SplinterUtil.pm b/lib/SplinterUtil.pm
index 313f64e..56fdd9d 100644
--- a/lib/SplinterUtil.pm
+++ b/lib/SplinterUtil.pm
@@ -25,9 +25,7 @@ use Bugzilla;
 use Bugzilla::Util;
 
 use base qw(Exporter);
- extensions::splinter::lib::SplinterUtil::EXPORT = qw(attachment_is_visible attachment_id_is_patch
-                                                      get_review_url get_review_link
-                                                      add_review_links_to_email);
+ extensions::splinter::lib::SplinterUtil::EXPORT = qw(attachment_is_visible);
 
 # Checks if the current user can see an attachment
 # Based on code from attachment.cgi
@@ -39,90 +37,3 @@ sub attachment_is_visible {
              Bugzilla->user->id == $attachment->attacher->id ||
              Bugzilla->user->is_insider));
 }
-
-sub attachment_id_is_patch {
-    my $attach_id = shift;
-
-    my $attachment = new Bugzilla::Attachment($attach_id);
-
-    # The check on attachment_is_visible here is to prevent a tiny
-    # information leak where someone could check if a private
-    # attachment was a patch by creating text that would get linkified
-    # differently. Likely excess paranoia
-    return (defined $attachment &&
-            attachment_is_visible ($attachment) &&
-            $attachment->ispatch);
-}
-
-sub get_review_url {
-    my ($bug, $attach_id, $absolute) = @_;
-    my $base = Bugzilla->params->{'splinter_base'};
-    my $bug_id = $bug->id;
-
-    if (defined $absolute && $absolute) {
-       my $urlbase = correct_urlbase();
-       $urlbase =~ s!/$!! if $base =~ "^/";
-       $base = $urlbase . $base;
-    }
-
-    if ($base =~ /\?/) {
-        return "$base&bug=$bug_id&attachment=$attach_id";
-    } else {
-        return "$base?bug=$bug_id&attachment=$attach_id";
-    }
-}
-
-sub get_review_link {
-    my ($bug, $attach_id, $link_text) = @_;
-    return "<a href='" . html_quote(get_review_url($bug, $attach_id)) . "'>$link_text</a>";
-}
-
-sub munge_create_attachment {
-    my ($bug, $intro_text, $attach_id, $view_link) = @_;
-
-    if (attachment_id_is_patch ($attach_id)) {
-       return ("$intro_text" .
-                " View: $view_link\015\012" .
-                " Review: " . get_review_url($bug, $attach_id, 1) . "\015\012");
-    } else {
-       return ("$intro_text" .
-                " --> ($view_link)");
-    }
-}
-
-# This adds review links into a bug mail before we send it out.
-# Since this is happening after newlines have been converted into
-# RFC-2822 style \r\n, we need handle line ends carefully.
-# (\015 and \012 are used because Perl \n is platform-dependent)
-sub add_review_links_to_email {
-    my $email = shift;
-
-    my $body = $email->body;
-    my $new_body = 0;
-
-    my $bug;
-    if ($email->header('Subject') =~ /^\[Bug\s+(\d+)\]/ &&
-        Bugzilla->user->can_see_bug($1))
-    {
-       $bug = new Bugzilla::Bug($1);
-    }
-
-    return unless defined $bug;
-
-    if ($body =~ /Review\s+of\s+attachment\s+\d+\s*:/) {
-       $body =~ s~(Review\s+of\s+attachment\s+(\d+)\s*:)
-                  ~"$1\015\012 --> (" . get_review_url($bug, $2, 1) . ")"
-                  ~egx;
-       $new_body = 1;
-    }
-
-    if ($body =~ /Created an attachment \(id=[0-9]+\)\015\012 --> /) {
-       $body =~ s~(Created\ an\ attachment\ \(id=([0-9]+)\)\015\012)
-                   \ -->\ \(([^\015\012]*)\)[^\015\012]*
-                  ~munge_create_attachment($bug, $1, $2, $3)
-                  ~egx;
-       $new_body = 1;
-    }
-
-    $email->body_set($body) if $new_body;
-}