Changeset 13192

Timestamp:

2006-10-30T14:05:28+13:00 (18 years ago)

Author:

kjdon

Message:

moved the doctype checking code into a function. implemented metadata_read cos we need to do the doctype check there as well so we don't block files unnecessarily

File:

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

trunk/gsdl/perllib/plugins/XMLPlug.pm

@@ -87 +87 @@
 }
 
+# the inheriting class must implement this method to tell whether to parse this doc type
+sub get_doctype {
+    my $self = shift(@_);
+    die "The inheriting class must implement this method";
+}
+
+
 sub apply_xslt
 {
@@ -152 +159 @@
 }
 
+sub check_doctype {
+    $self = shift (@_);
+    
+    my ($filename) = @_;
+    
+    if (open(XMLIN,"<$filename")) {
+    my $doctype = $self->get_doctype();
+    ## check whether the doctype has the same name as the root element tag
+    while (defined (my $line = <XMLIN>)) {
+        ## find the root element
+        if ($line =~ /<(\w+)[\s>]/){
+        my $root = $1;
+        if ($root !~ $doctype){
+            close(XMLIN);
+            return 0;
+        }
+        else {
+            close(XMLIN); 
+            return 1;
+        }
+        }
+    }
+    close(XMLIN);
+    }
+    
+    return undef; # haven't found a valid line
+    
+}
+
+# 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 ($pluginfo, $base_dir, $file, $metadata, $extrametakeys, $extrametadata, $processor, $maxdocs, $gli) = @_;
+ 
+    my $result = $self->SUPER::metadata_read($pluginfo, $base_dir, $file, $metadata, $extrametakeys, $extrametadata, $processor, $maxdocs, $gli);
+
+    if (defined $result) {
+    # we think we are processing this, but check that we actually are
+    my $filename = &util::filename_cat ($base_dir, $file) if $base_dir =~ /\w/;
+
+    if ($self->check_doctype($filename)) {
+        return $result;
+    }
+    }
+    return undef;
+}
 
 sub read {
@@ -162 +216 @@
     my ($block_status,$filename) = $self->read_block(@_);    
     return $block_status if ((!defined $block_status) || ($block_status==0));
+
+    ## check the doctype to see whether we really want to process the file
+    if (!$self->check_doctype($filename)) {
+    # this file is not for us
+    return undef;
+    }
 
     $file =~ s/^[\/\\]+//; # $file often begins with / so we'll tidy it up
@@ -169 +229 @@
     $self->{'processor'} = $processor;
     $self->{'metadata'} = $metadata;
-
-
-    ##call the inheriting plugin's get_doctype method to decide whether to carry on the parsing
-    if (open(XMLIN,"<$filename")) {
-    my $doctype = $self->get_doctype();
-    ## check whether the doctype have the same name as the root element tag
-    while (defined (my $line = <XMLIN>)) {
-        ## find the root element
-         if ($line =~ /<(\w+)[\s>]/){
-        my $root = $1;
-        if ($root !~ $doctype){
-            close(XMLIN);
-            return undef;
-        }
-        else{
-            close(XMLIN); 
-            last;
-        }
-        }
-    }
-}
-
 
     eval {
@@ -302 +340 @@
     die "XMLPlug Cannot process XML document with DOCTYPE of $name";
 }
-
-# the inheriting class must implement this method to tell whether to parse this doc type
-sub get_doctype {
-    my $self = shift(@_);
-    die "The inheriting class must implement this method";
-}
-