experimental: Not part of normal bugzilla distibution. Bug.pm creates a bug object and provides methods for getting and setting attributes and for printing out the bug as xml. xml.cgi prompts for a list of bugs and displays the list as html. xml.cgi replaces export_bug.cgi

1 files changed, 369 insertions, 0 deletions

diff --git a/Bug.pm b/Bug.pm
new file mode 100755
index 000000000..248857441
--- /dev/null
+++ b/Bug.pm
@@ -0,0 +1,369 @@
+#!/usr/bonsaitools/bin/perl -w
+# -*- 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): Dawn Endico    <endico@mozilla.org>
+#                 Terry Weissman <terry@mozilla.org>
+
+use diagnostics;
+use strict;
+
+use DBI;
+use RelationSet;
+require "globals.pl";
+require "CGI.pl";
+package Bug;
+use CGI::Carp qw(fatalsToBrowser);
+my %bug;
+my %ok_field;
+
+for my $key (qw (bug_id product version rep_platform op_sys bug_status 
+                resolution priority bug_severity component assigned_to
+                reporter bug_file_loc short_desc target_milestone 
+                qa_contact status_whiteboard creation_ts groupset 
+                delta_ts votes) ){
+    $ok_field{$key}++;
+    }
+
+# create a new empty bug
+#
+sub new {
+  my $type = shift();
+
+  # create a ref to an empty hash and bless it
+  #
+  my $self = {%bug};
+  bless $self, $type;
+
+  # construct from a hash containing a bug's info
+  #
+  if ($#_ == 1) {
+    $self->initBug(@_);
+  } else {
+    confess("invalid number of arguments \($#_\)($_)");
+  }
+
+  # bless as a Bug
+  #
+  return $self;
+}
+
+
+
+# dump info about bug into hash unless user doesn't have permission
+# user_id 0 is used when person is not logged in.
+#
+sub initBug  {
+  my $self = shift();
+  my ($bug_id, $user_id) = (@_);
+
+
+  if ( (! defined $bug_id) || (!$bug_id) ) {
+    # no bug number given
+    return {};
+  }
+
+  if (! defined $user_id) {
+    $user_id = 0;
+  }
+
+  &::ConnectToDatabase();
+  &::GetVersionTable();
+
+  # this verification should already have been done by caller
+  # my $loginok = quietly_check_login();
+  my $usergroupset = "0";
+  if (defined $::usergroupset) {
+    $usergroupset = $::usergroupset;
+  }
+
+  my $query = "
+    select
+      bugs.bug_id, product, version, rep_platform, op_sys, bug_status,
+      resolution, priority, bug_severity, component, assigned_to, reporter,
+      bug_file_loc, short_desc, target_milestone, qa_contact,
+      status_whiteboard, date_format(creation_ts,'%Y-%m-%d %H:%i'),
+      groupset, delta_ts, sum(votes.count)
+    from bugs left join votes using(bug_id)
+    where bugs.bug_id = $bug_id
+    and bugs.groupset & $usergroupset = bugs.groupset
+    group by bugs.bug_id";
+
+  &::SendSQL($query);
+  my @row;
+
+  if (@row = &::FetchSQLData()) {
+    my $count = 0;
+    my %fields;
+    foreach my $field ("bug_id", "product", "version", "rep_platform",
+                       "op_sys", "bug_status", "resolution", "priority",
+                       "bug_severity", "component", "assigned_to", "reporter",
+                       "bug_file_loc", "short_desc", "target_milestone",
+                       "qa_contact", "status_whiteboard", "creation_ts",
+                       "groupset", "delta_ts", "votes") {
+	$fields{$field} = shift @row;
+	if ($fields{$field}) {
+	    $bug{$field} = $fields{$field};
+	}
+	$count++;
+    }
+  } else {
+    &::SendSQL("select groupset from bugs where bug_id = $bug_id");
+    if (@row = &::FetchSQLData()) {
+      $bug{'bug_id'} = $bug_id;
+      $bug{'error'} = "NotPermitted";
+      return $self;
+    } else {
+      $bug{'bug_id'} = $bug_id;
+      $bug{'error'} = "NotFound";
+      return $self;
+    }
+  }
+
+  if ($bug{'short_desc'}) {
+    $bug{'short_desc'} = QuoteXMLChars( $bug{'short_desc'} );
+  }
+
+  if (defined $bug{'status_whiteboard'}) {
+    $bug{'status_whiteboard'} = QuoteXMLChars($bug{'status_whiteboard'});
+  }
+
+  $bug{'assigned_to'} = &::DBID_to_real_or_loginname($bug{'assigned_to'});
+  $bug{'reporter'} = &::DBID_to_real_or_loginname($bug{'reporter'});
+
+  my $ccSet = new RelationSet;
+  $ccSet->mergeFromDB("select who from cc where bug_id=$bug_id");
+  my @cc = $ccSet->toArrayOfStrings();
+  if (@cc) {
+    $bug{'cc'} = \@cc;
+  }
+
+  if (&::Param("useqacontact") && (defined $bug{'qa_contact'}) ) {
+    my $name = $bug{'qa_contact'} > 0 ? &::DBID_to_name($bug{'qa_contact'}) :"";
+    if ($name) {
+      $bug{'qa_contact'} = $name;
+    }
+  }
+
+  if (@::legal_keywords) {
+    &::SendSQL("SELECT keyworddefs.name 
+              FROM keyworddefs, keywords
+             WHERE keywords.bug_id = $bug_id 
+               AND keyworddefs.id = keywords.keywordid
+          ORDER BY keyworddefs.name");
+    my @list;
+    while (&::MoreSQLData()) {
+        push(@list, &::FetchOneColumn());
+    }
+    if (@list) {
+      $bug{'keywords'} = &::html_quote(join(', ', @list));
+    }
+  }
+
+  &::SendSQL("select attach_id, creation_ts, description 
+           from attachments 
+           where bug_id = $bug_id");
+  my @attachments;
+  while (&::MoreSQLData()) {
+    my ($attachid, $date, $desc) = (&::FetchSQLData());
+    if ($date =~ /^(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/) {
+        $date = "$3/$4/$2 $5:$6";
+      my %attach;
+      $attach{'attachid'} = $attachid;
+      $attach{'date'} = $date;
+      $attach{'desc'} = &::html_quote($desc);
+      push @attachments, \%attach;
+    }
+  }
+  if (@attachments) {
+    $bug{'attachments'} = \@attachments;
+  }
+
+  &::SendSQL("select bug_id, who, bug_when, thetext 
+           from longdescs 
+           where bug_id = $bug_id");
+  my @longdescs;
+  while (&::MoreSQLData()) {
+    my ($bug_id, $who, $bug_when, $thetext) = (&::FetchSQLData());
+    my %longdesc;
+    $longdesc{'who'} = $who;
+    $longdesc{'bug_when'} = $bug_when;
+    $longdesc{'thetext'} = &::html_quote($thetext);
+    push @longdescs, \%longdesc;
+  }
+  if (@longdescs) {
+    $bug{'longdescs'} = \@longdescs;
+  }
+
+  if (&::Param("usedependencies")) {
+    my @depends = EmitDependList("blocked", "dependson", $bug_id);
+    if ( @depends ) {
+      $bug{'dependson'} = \@depends;
+    }
+    my @blocks = EmitDependList("dependson", "blocked", $bug_id);
+    if ( @blocks ) {
+      $bug{'blocks'} = \@blocks;
+    }
+  }
+  return $self;
+}
+
+
+
+# given a bug hash, emit xml for it. with file header provided by caller
+#
+sub emitXML {
+  ( $#_ == 0 ) || confess("invalid number of arguments");
+  my $self = shift();
+  my $xml;
+
+
+  if (exists $bug{'error'}) {
+    $xml .= "<bug error=\"$bug{'error'}\">\n";
+    $xml .= "  <bug_id>$bug{'bug_id'}</bug_id>\n";
+    $xml .= "</bug>\n";
+    return $xml;
+  }
+
+  $xml .= "<bug>\n";
+
+  foreach my $field ("bug_id", "urlbase", "bug_status", "product",
+      "priority", "version", "rep_platform", "assigned_to", "delta_ts", 
+      "component", "reporter", "target_milestone", "bug_severity", 
+      "creation_ts", "qa_contact", "op_sys", "resolution", "bug_file_loc",
+      "short_desc", "keywords", "status_whiteboard") {
+    if ($bug{$field}) {
+      $xml .= "  <$field>" . $bug{$field} . "</$field>\n";
+    }
+  }
+
+  foreach my $field ("dependson", "blocks", "cc") {
+    if (defined $bug{$field}) {
+      for (my $i=0 ; $i < @{$bug{$field}} ; $i++) {
+        $xml .= "  <$field>" . $bug{$field}[$i] . "</$field>\n";
+      }
+    }
+  }
+
+  if (defined $bug{'longdescs'}) {
+    for (my $i=0 ; $i < @{$bug{'longdescs'}} ; $i++) {
+      $xml .= "  <long_desc>\n"; 
+      $xml .= "   <who>" . &::DBID_to_name($bug{'longdescs'}[$i]->{'who'}) 
+                         . "</who>\n"; 
+      $xml .= "   <bug_when>" . $bug{'longdescs'}[$i]->{'bug_when'} 
+                              . "</bug_when>\n"; 
+      $xml .= "   <thetext>" . QuoteXMLChars($bug{'longdescs'}[$i]->{'thetext'})
+                             . "</thetext>\n"; 
+      $xml .= "  </long_desc>\n"; 
+    }
+  }
+
+  if (defined $bug{'attachments'}) {
+    for (my $i=0 ; $i < @{$bug{'attachments'}} ; $i++) {
+      $xml .= "  <attachment>\n"; 
+      $xml .= "    <attachid>" . $bug{'attachments'}[$i]->{'attachid'}
+                              . "</attachid>\n"; 
+      $xml .= "    <date>" . $bug{'attachments'}[$i]->{'date'} . "</date>\n"; 
+      $xml .= "    <desc>" . $bug{'attachments'}[$i]->{'desc'} . "</desc>\n"; 
+    # $xml .= "    <type>" . $bug{'attachments'}[$i]->{'type'} . "</type>\n"; 
+    # $xml .= "    <data>" . $bug{'attachments'}[$i]->{'data'} . "</data>\n"; 
+      $xml .= "  </attachment>\n"; 
+    }
+  }
+
+  $xml .= "</bug>\n";
+  return $xml;
+}
+
+
+
+sub EmitDependList {
+  my ($myfield, $targetfield, $bug_id) = (@_);
+  my @list;
+  &::SendSQL("select dependencies.$targetfield, bugs.bug_status
+           from dependencies, bugs
+           where dependencies.$myfield = $bug_id
+             and bugs.bug_id = dependencies.$targetfield
+           order by dependencies.$targetfield");
+  while (&::MoreSQLData()) {
+    my ($i, $stat) = (&::FetchSQLData());
+    push @list, $i;
+  }
+  return @list;
+}
+
+
+
+sub QuoteXMLChars {
+  $_[0] =~ s/</&lt;/g;
+  $_[0] =~ s/>/&gt;/g;
+  $_[0] =~ s/'/&apos;/g;
+  $_[0] =~ s/"/&quot;/g;
+  $_[0] =~ s/&/&amp;/g;
+# $_[0] =~ s/([\x80-\xFF])/&XmlUtf8Encode(ord($1))/ge;
+  return($_[0]);
+}
+
+
+sub XML_Header {
+  my ($urlbase, $version, $maintainer, $exporter) = (@_);
+
+  my $xml;
+  $xml = "<?xml version=\"1.0\" standalone=\"no\"?>\n";
+  $xml .= "<!DOCTYPE bugzilla SYSTEM \"$urlbase";
+  if (! ($urlbase =~ /.+\/$/)) {
+    $xml .= "/";
+  }
+  $xml .= "bugzilla.dtd\">\n";
+  $xml .= "<bugzilla";
+  if (defined $exporter) {
+    $xml .= " exporter=\"$exporter\"";
+  }
+  $xml .= " version=\"$version\"";
+  $xml .= " urlbase=\"$urlbase\"";
+  $xml .= " maintainer=\"$maintainer\">\n";
+  return ($xml);
+}
+
+
+sub XML_Footer {
+  return ("</bugzilla>\n");
+}
+
+sub AUTOLOAD {
+  use vars qw($AUTOLOAD);
+  my $self = shift;
+  my $type = ref($self) || $self;
+  my $attr = $AUTOLOAD;
+
+  $attr =~ s/.*:://;
+  return unless $attr=~ /[^A-Z]/;
+  if (@_) {
+    $bug{$attr} = shift;
+    return;
+  }
+  confess "invalid bug attribute $attr" unless $ok_field{$attr};
+  if (defined $bug{$attr}) {
+    return $bug{$attr};
+  } else {
+    return '';
+  }
+}
+
+1;