Changeset 14103 for trunk/gsdl/perllib/plugins/XMLPlug.pm

Timestamp:

2007-05-28T13:35:30+12:00 (17 years ago)

Author:

sjboddie

Message:

Fixed up the way XMLPlug is implemented, so it no longer relies on $self
being a global variable. This change should not make any functional
difference, but will allow inheritance to work properly.

File:

• trunk/gsdl/perllib/plugins/XMLPlug.pm (modified) (10 diffs)

trunk/gsdl/perllib/plugins/XMLPlug.pm

@@ -56 +56 @@
         'args'     => $arguments };
 
-
-our ($self);
 sub new {
     my ($class) = shift (@_);
@@ -67 +65 @@
     
     # $self is global for use within subroutines called by XML::Parser
-    $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
+    my $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
 
     if ($self->{'info_only'}) {
@@ -75 +73 @@
 
     my $parser = new XML::Parser('Style' => 'Stream',
+                                 'Pkg' => 'XMLPlug',
+                                 'PluginObj' => $self,
                  'Handlers' => {'Char' => \&Char,
                         'XMLDecl' => \&XMLDecl,
@@ -80 +80 @@
                         'Doctype' => \&Doctype,
                         'Default' => \&Default,
-                        });  
+                                 });
 
     $self->{'parser'} = $parser;
@@ -160 +160 @@
 
 sub check_doctype {
-    $self = shift (@_);
+    my $self = shift (@_);
     
     my ($filename) = @_;
-    
+
     if (open(XMLIN,"<$filename")) {
     my $doctype = $self->get_doctype();
@@ -190 +190 @@
 # because we are not just using process_exp to determine whether to process or not, we need to implement this too, so that a file can be passed down if we are not actually processing it
 sub metadata_read {
-    $self = shift (@_);
+    my $self = shift (@_);
     
     my ($pluginfo, $base_dir, $file, $metadata, $extrametakeys, $extrametadata, $processor, $maxdocs, $gli) = @_;
@@ -208 +208 @@
 
 sub read {
-    # $self must be global to work with XML callback routines.
-    $self = shift (@_);  
+    my $self = shift (@_);  
   
     my ($pluginfo, $base_dir, $file, $metadata, $processor, $maxdocs, $total_count, $gli) = @_;
@@ -275 +274 @@
 # plugin that inherits from this. it seems that you can't call the parse 
 # methods directly. WHY???
+#
+# [Stefan 27/5/07] These two methods may not be necessary any more as I've
+# fixed XMLPlug so $self is no longer required to be a global variable
+# (that was why inheritance wasn't working quite right with XMLPlug I
+# think). I don't really know what other plugins rely on these methods
+# though so have left them here for now.
 sub parse_file {
-    $self = shift (@_); 
+    my $self = shift (@_); 
     my ($filename) = @_;
     $self->{'parser'}->parsefile($filename);
@@ -282 +287 @@
 
 sub parse_string {
-    $self = shift (@_); 
+    my $self = shift (@_); 
     my ($xml_string) = @_;
     $self->{'parser'}->parse($xml_string);
@@ -293 +298 @@
 }
 
-sub StartDocument {$self->xml_start_document(@_);}
-sub XMLDecl {$self->xml_xmldecl(@_);}
-sub Entity {$self->xml_entity(@_);}
-sub Doctype {$self->xml_doctype(@_);}
-sub StartTag {$self->xml_start_tag(@_);}
-sub EndTag {$self->xml_end_tag(@_);}
-sub Text {$self->xml_text(@_);}
-sub PI {$self->xml_pi(@_);}
-sub EndDocument {$self->xml_end_document(@_);}
-sub Default {$self->xml_default(@_);}
+sub StartDocument {$_[0]->{'PluginObj'}->xml_start_document(@_);}
+sub XMLDecl {$_[0]->{'PluginObj'}->xml_xmldecl(@_);}
+sub Entity {$_[0]->{'PluginObj'}->xml_entity(@_);}
+sub Doctype {$_[0]->{'PluginObj'}->xml_doctype(@_);}
+sub StartTag {$_[0]->{'PluginObj'}->xml_start_tag(@_);}
+sub EndTag {$_[0]->{'PluginObj'}->xml_end_tag(@_);}
+sub Text {$_[0]->{'PluginObj'}->xml_text(@_);}
+sub PI {$_[0]->{'PluginObj'}->xml_pi(@_);}
+sub EndDocument {$_[0]->{'PluginObj'}->xml_end_document(@_);}
+sub Default {$_[0]->{'PluginObj'}->xml_default(@_);}
 
 # This Char function overrides the one in XML::Parser::Stream to overcome a