Fix for bug 127995: shows the size of attachments in the show bug and attachment interfaces.

Patch by Dave Swegen <dswegen@software.plasmon.com>
r=myk
a=myk

webtools/bugzilla/Attachment.pm

@@ -1,106 +0,0 @@
-# -*- 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 Bug Tracking System.
-#
-# The Initial Developer of the Original Code is Netscape Communications
-# Corporation. Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): Terry Weissman <terry@mozilla.org>
-#                 Myk Melez <myk@mozilla.org>
-
-############################################################################
-# Module Initialization
-############################################################################
-
-use strict;
-
-package Attachment;
-
-# This module requires that its caller have said "require CGI.pl" to import
-# relevant functions from that script and its companion globals.pl.
-
-# Use the Flag module to handle flags.
-use Bugzilla::Flag;
-
-############################################################################
-# Functions
-############################################################################
-
-sub new {
-    # Returns a hash of information about the attachment with the given ID.
-
-    my ($invocant, $id) = @_;
-    return undef if !$id;
-    my $self = { 'id' => $id };
-    my $class = ref($invocant) || $invocant;
-    bless($self, $class);
-    
-    &::PushGlobalSQLState();
-    &::SendSQL("SELECT 1, description, bug_id, isprivate FROM attachments " . 
-               "WHERE attach_id = $id");
-    ($self->{'exists'},
-     $self->{'summary'},
-     $self->{'bug_id'},
-     $self->{'isprivate'}) = &::FetchSQLData();
-    &::PopGlobalSQLState();
-
-    return $self;
-}
-
-sub query
-{
-  # Retrieves and returns an array of attachment records for a given bug. 
-  # This data should be given to attachment/list.atml in an
-  # "attachments" variable.
-  my ($bugid) = @_;
-
-  my $in_editbugs = &::UserInGroup("editbugs");
-  &::SendSQL("SELECT product_id
-           FROM bugs 
-           WHERE bug_id = $bugid");
-  my $productid = &::FetchOneColumn();
-  my $caneditproduct = &::CanEditProductId($productid);
-
-  # Retrieve a list of attachments for this bug and write them into an array
-  # of hashes in which each hash represents a single attachment.
-  &::SendSQL("
-              SELECT attach_id, DATE_FORMAT(creation_ts, '%Y.%m.%d %H:%i'),
-              mimetype, description, ispatch, isobsolete, isprivate, submitter_id
-              FROM attachments WHERE bug_id = $bugid ORDER BY attach_id
-            ");
-  my @attachments = ();
-  while (&::MoreSQLData()) {
-    my %a;
-    my $submitter_id;
-    ($a{'attachid'}, $a{'date'}, $a{'contenttype'}, $a{'description'},
-     $a{'ispatch'}, $a{'isobsolete'}, $a{'isprivate'}, $submitter_id) 
-        = &::FetchSQLData();
-
-    # Retrieve a list of flags for this attachment.
-    $a{'flags'} = Bugzilla::Flag::match({ 'attach_id' => $a{'attachid'} });
-    
-    # We will display the edit link if the user can edit the attachment;
-    # ie the are the submitter, or they have canedit.
-    # Also show the link if the user is not logged in - in that cae,
-    # They'll be prompted later
-    $a{'canedit'} = ($::userid == 0 || (($submitter_id == $::userid ||
-                     $in_editbugs) && $caneditproduct));
-    push @attachments, \%a;
-  }
-  
-  return \@attachments;  
-}
-
-1;

webtools/bugzilla/Bugzilla/Attachment.pm

@@ -77,7 +77,8 @@ sub query
   # of hashes in which each hash represents a single attachment.
   &::SendSQL("
               SELECT attach_id, DATE_FORMAT(creation_ts, '%Y.%m.%d %H:%i'),
-              mimetype, description, ispatch, isobsolete, isprivate, submitter_id
+              mimetype, description, ispatch, isobsolete, isprivate, 
+              submitter_id, LENGTH(thedata)
               FROM attachments WHERE bug_id = $bugid ORDER BY attach_id
             ");
   my @attachments = ();
@@ -85,8 +86,8 @@ sub query
     my %a;
     my $submitter_id;
     ($a{'attachid'}, $a{'date'}, $a{'contenttype'}, $a{'description'},
-     $a{'ispatch'}, $a{'isobsolete'}, $a{'isprivate'}, $submitter_id) 
-        = &::FetchSQLData();
+     $a{'ispatch'}, $a{'isobsolete'}, $a{'isprivate'}, $submitter_id, 
+     $a{'datasize'}) = &::FetchSQLData();
 
     # Retrieve a list of flags for this attachment.
     $a{'flags'} = Bugzilla::Flag::match({ 'attach_id' => $a{'attachid'} });

webtools/bugzilla/Bugzilla/Template.pm

@@ -258,6 +258,30 @@ sub create {
                 return $var;
             } ,
 
+            # Format a filesize in bytes to a human readable value
+            unitconvert => sub
+            {
+                my ($data) = @_;
+                my $retval = "";
+                my %units = (
+                    'KB' => 1024,
+                    'MB' => 1024 * 1024,
+                    'GB' => 1024 * 1024 * 1024,
+                );
+
+                if ($data < 1024) {
+                    return "$data bytes";
+                } 
+                else {
+                    my $u;
+                    foreach $u ('GB', 'MB', 'KB') {
+                        if ($data >= $units{$u}) {
+                            return sprintf("%.2f %s", $data/$units{$u}, $u);
+                        }
+                    }
+                }
+            },
+
             # Format a time for display (more info in Bugzilla::Util)
             time => \&Bugzilla::Util::format_time,
 

webtools/bugzilla/attachment.cgi

@@ -746,7 +746,8 @@ sub viewall
         $privacy = "AND isprivate < 1 ";
     }
     SendSQL("SELECT attach_id, DATE_FORMAT(creation_ts, '%Y.%m.%d %H:%i'),
-            mimetype, description, ispatch, isobsolete, isprivate 
+            mimetype, description, ispatch, isobsolete, isprivate, 
+            LENGTH(thedata)
             FROM attachments WHERE bug_id = $::FORM{'bugid'} $privacy 
             ORDER BY attach_id");
   my @attachments; # the attachments array
@@ -754,8 +755,8 @@ sub viewall
   {
     my %a; # the attachment hash
     ($a{'attachid'}, $a{'date'}, $a{'contenttype'}, 
-     $a{'description'}, $a{'ispatch'}, $a{'isobsolete'}, $a{'isprivate'}) 
-                                                               = FetchSQLData();
+     $a{'description'}, $a{'ispatch'}, $a{'isobsolete'}, $a{'isprivate'},
+     $a{'datasize'}) = FetchSQLData();
     $a{'isviewable'} = isViewable($a{'contenttype'});
 
     # Add the hash representing the attachment to the array of attachments.
@@ -943,9 +944,9 @@ sub edit
   # Users cannot edit the content of the attachment itself.
 
   # Retrieve the attachment from the database.
-  SendSQL("SELECT description, mimetype, filename, bug_id, ispatch, isobsolete, isprivate 
+  SendSQL("SELECT description, mimetype, filename, bug_id, ispatch, isobsolete, isprivate, LENGTH(thedata)
            FROM attachments WHERE attach_id = $::FORM{'id'}");
-  my ($description, $contenttype, $filename, $bugid, $ispatch, $isobsolete, $isprivate) = FetchSQLData();
+  my ($description, $contenttype, $filename, $bugid, $ispatch, $isobsolete, $isprivate, $datasize) = FetchSQLData();
 
   my $isviewable = isViewable($contenttype);
 
@@ -980,6 +981,7 @@ sub edit
   $vars->{'ispatch'} = $ispatch; 
   $vars->{'isobsolete'} = $isobsolete; 
   $vars->{'isprivate'} = $isprivate; 
+  $vars->{'datasize'} = $datasize;
   $vars->{'isviewable'} = $isviewable; 
   $vars->{'attachments'} = \@bugattachments; 
   $vars->{'GetBugLink'} = \&GetBugLink;

webtools/bugzilla/checksetup.pl

@@ -1111,6 +1111,7 @@ END
                 quoteUrls => sub { return $_; },
                 bug_link => [ sub { return sub { return $_; } }, 1],
                 csv => sub { return $_; },
+                unitconvert => sub { return $_; },
                 time => sub { return $_; },
                 none => sub { return $_; } ,
                },

webtools/bugzilla/t/004template.t

@@ -101,6 +101,7 @@ foreach my $include_path (@include_paths) {
             quoteUrls => sub { return $_ } ,
             bug_link => [ sub { return sub { return $_; } }, 1] ,
             csv       => sub { return $_ } ,
+            unitconvert => sub { return $_ },
             time      => sub { return $_ } ,
             none      => sub { return $_ } ,
         },

webtools/bugzilla/t/008filter.t

@@ -202,7 +202,8 @@ sub directive_ok {
     # Note: If a single directive prints two things, and only one is 
     # filtered, we may not catch that case.
     return 1 if $directive =~ /FILTER\ (html|csv|js|url_quote|css_class_quote|
-                                        quoteUrls|time|uri|xml|lower|none)/x;
+                                        quoteUrls|time|uri|xml|lower|
+                                        unitconvert|none)/x;
 
     return 0;
 }

webtools/bugzilla/template/en/default/attachment/edit.html.tmpl

@@ -211,6 +211,7 @@
 
         <b>Filename:</b><br>
           <input type="text" size="20" name="filename" value="[% filename FILTER html %]"><br>
+        <b>Size: </b>[% datasize FILTER unitconvert %]<br>
 
         <b>MIME Type:</b><br>
           <input type="text" size="20" name="contenttypeentry" value="[% contenttype FILTER html %]"><br>

webtools/bugzilla/template/en/default/attachment/list.html.tmpl

@@ -25,6 +25,7 @@
     <th bgcolor="#cccccc" align="left">Attachment</th>
     <th bgcolor="#cccccc" align="left">Type</th>
     <th bgcolor="#cccccc" align="left">Created</th>
+    <th bgcolor="#cccccc" align="left">Size</th>
     [% IF show_attachment_flags %]
       <th bgcolor="#cccccc" align="left">Flags</th>
     [% END %]
@@ -47,6 +48,7 @@
       </td>
 
       <td valign="top">[% attachment.date FILTER time %]</td>
+      <td valign="top">[% attachment.datasize FILTER unitconvert %]</td>
 
       [% IF show_attachment_flags %]
         <td valign="top">
@@ -82,7 +84,7 @@
   [% END %]
 
   <tr>
-    <td colspan="[% show_attachment_flags ? 4 : 3 %]">
+    <td colspan="[% show_attachment_flags ? 5 : 4 %]">
       <a href="attachment.cgi?bugid=[% bugid %]&amp;action=enter">Create a New Attachment</a> (proposed patch, testcase, etc.)
     </td>
     [% IF attachments.size %]

webtools/bugzilla/template/en/default/attachment/show-multiple.html.tmpl

@@ -40,7 +40,7 @@
   <div align="center">
   <table class="attachment_info" cellspacing="0" cellpadding="4" border="1" width="75%">
     <tr>
-      <td valign="top" bgcolor="#cccccc" colspan="5">
+      <td valign="top" bgcolor="#cccccc" colspan="6">
         <big><b>Attachment #[% a.attachid %]</b></big>
       </td>
     </tr>
@@ -62,6 +62,7 @@
       </td>
 
       <td valign="top">[% a.date FILTER time %]</td>
+      <td valign="top">[% a.datasize FILTER unitconvert %]</td>
 
       <td valign="top">
         [% IF a.statuses.size == 0 %]