Difference between revisions of "Contribute: Plugins/ExportPluginsZip"

From EPrints Documentation
Jump to: navigation, search
m (→‎Zip.pm)
(→‎In More Detail)
Line 140: Line 140:
  
 
= In More Detail =
 
= In More Detail =
−
== Modules ==
 
−
We need to import a module for creating Zip files.
 
−
<pre>
 
−
use Archive::Any::Create;
 
−
</pre>
 
−
 
 
== Constructor ==
 
== Constructor ==
 
For the sake of simplicity this plugin will only deal with lists of eprints. This avoids some code duplication, and it would be fairly easy to modify the plugin to deal with both individual eprints and lists of eprints sensibly.
 
For the sake of simplicity this plugin will only deal with lists of eprints. This avoids some code duplication, and it would be fairly easy to modify the plugin to deal with both individual eprints and lists of eprints sensibly.
Line 154: Line 148:
 
The file extension and MIME type are set to values appropriate for Zip files.
 
The file extension and MIME type are set to values appropriate for Zip files.
 
<pre>
 
<pre>
−
   $self->{suffix} = ".zip";
+
   $self->{suffix} = '.zip';
−
   $self->{mimetype} = "application/zip";
+
   $self->{mimetype} = 'application/zip';
 +
</pre>
 +
 
 +
We need to import a module that is not included with EPrints for creating zip files. We use the EPrints::Utils::require_if_exists function to check if the module exists, and load it if it does. We then check the value returned from that function, and make the plugin invisible if it failed.
 +
 
 +
<pre>
 +
  my $rc = EPrints::Utils::require_if_exists('Archive::Any::Create');
 +
  unless ($rc)
 +
  {
 +
    $self->{visible} = '';
 +
    $self->{error} = 'Unable to load required module Archive::Any::Create';
 +
  }
 
</pre>
 
</pre>
  
Line 193: Line 198:
 
This time we setup some DOM objects to be added to our index. Each eprint will have it's title printed out followed by a list of documents.
 
This time we setup some DOM objects to be added to our index. Each eprint will have it's title printed out followed by a list of documents.
 
<pre>
 
<pre>
−
     my $div = $session->make_element("div");
+
     my $div = $session->make_element('div');
−
     my $heading = $session->make_element("h2");
+
     my $heading = $session->make_element('h2');
−
     $heading->appendChild($session->make_text($dataobj->get_value("title")));
+
     $heading->appendChild($session->make_text($dataobj->get_value('title')));
 
     $div->appendChild($heading);
 
     $div->appendChild($heading);
  
−
     my $uldoc = $session->make_element("ul");
+
     my $uldoc = $session->make_element('ul');
 
     $div->appendChild($uldoc);
 
     $div->appendChild($uldoc);
 
</pre>
 
</pre>
Line 205: Line 210:
  
 
<pre>
 
<pre>
−
     my $dirpath = "eprints-search/".$dataobj->get_id()."/";
+
     my $dirpath = 'eprints-search/'.$dataobj->get_id().'/';
 
</pre>
 
</pre>
  
Line 219: Line 224:
 
Here we create a list item for the document containing a link to the main file.  
 
Here we create a list item for the document containing a link to the main file.  
 
<pre>
 
<pre>
−
       my $lidoc = $session->make_element("li");
+
       my $lidoc = $session->make_element('li');
 
       $uldoc->appendChild($lidoc);
 
       $uldoc->appendChild($lidoc);
  
−
       my $adoc = $session->make_element("a", href=>$dataobj->get_id."/doc$i/".$doc->get_main);
+
       my $adoc = $session->make_element('a', href=>$dataobj->get_id."/doc$i/".$doc->get_main);
 
       $lidoc->appendChild($adoc);
 
       $lidoc->appendChild($adoc);
 
</pre>
 
</pre>
 
If a description of the main file has been set we use that as the link text, otherwise we use the filename.
 
If a description of the main file has been set we use that as the link text, otherwise we use the filename.
 
<pre>
 
<pre>
−
       if ($doc->exists_and_set("formatdesc"))
+
       if ($doc->exists_and_set('formatdesc'))
 
       {
 
       {
−
         $adoc->appendChild($session->make_text($doc->get_value("formatdesc")));
+
         $adoc->appendChild($session->make_text($doc->get_value('formatdesc')));
 
       }
 
       }
 
       else
 
       else
Line 248: Line 253:
 
       {
 
       {
 
         my $filepath = $subdirpath.$filename;
 
         my $filepath = $subdirpath.$filename;
−
         my $file = $doc->local_path."/".$filename;
+
         my $file = $doc->local_path.'/'.$filename;
 
</pre>
 
</pre>
  
Line 280: Line 285:
 
After finishing off our index file we add it to the zip file.
 
After finishing off our index file we add it to the zip file.
 
<pre>
 
<pre>
−
   $index .= "</body></html>";
+
   $index .= '</body></html>';
−
   $zip->add_file("eprints-search/index.htm",$index);
+
   $zip->add_file('eprints-search/index.htm',$index);
 
</pre>
 
</pre>
  
 
If a file handle has been provided we write to it, otherwise we write to the scalar file handle created earlier. We then return in the usual fashion.
 
If a file handle has been provided we write to it, otherwise we write to the scalar file handle created earlier. We then return in the usual fashion.
 
<pre>
 
<pre>
−
   if (defined $opts{"fh"})
+
   if (defined $opts{fh})
 
   {
 
   {
−
     $zip->write_filehandle($opts{"fh"},"zip");
+
     $zip->write_filehandle($opts{fh},'zip');
 
     return undef;
 
     return undef;
 
   }
 
   }
−
   $zip->write_filehandle($FH,"zip");
+
   $zip->write_filehandle($FH,'zip');
 
   return $archive;
 
   return $archive;
 
</pre>
 
</pre>

Revision as of 11:38, 27 September 2007

Export Plugin Tutorial 5: Zip

In this tutorial we'll look at packaging the results of a search into a Zip file. We'll create a directory for each eprint, and a sub-directory for each document belonging to that eprint. We'll also add an HTML index file to the archive to make it easier to navigate.

To prepare for this tutorial you should install the Archive::Any::Create module. The following command as root, or using sudo should work. 

cpan Archive::Any::Create

Zip.pm

package EPrints::Plugin::Export::MyPlugins::Zip;

@ISA = ('EPrints::Plugin::Export');

use strict;
use Archive::Any::Create;

sub new
{
  my ($class, %opts) = @_;

  my $self = $class->SUPER::new(%opts);

  $self->{name} = 'Zip';
  $self->{accept} = [ 'list/eprint' ];
  $self->{visible} = 'all';
  $self->{suffix} = '.zip';
  $self->{mimetype} = 'application/zip';

  my $rc = EPrints::Utils::require_if_exists('Archive::Any::Create');
  unless ($rc)
  {
    $self->{visible} = '';
    $self->{error} = 'Unable to load required module Archive::Any::Create';
  }

  return $self;
}

sub output_list
{
  my ($plugin, %opts) = @_;

  my $archive = '';
  open (my $FH, '>', \$archive) or
    die("Could not create filehandle: $!");
  my $zip = Archive::Any::Create->new;

  my $index = <<END;
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
      <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
      <title>EPrints Search Results</title>
    </head>
  <body>
END

  my $session = $plugin->{session};

  foreach my $dataobj ($opts{list}->get_records)
  {
    my $div = $session->make_element('div');
    my $heading = $session->make_element('h2');
    $heading->appendChild($session->make_text($dataobj->get_value('title')));
    $div->appendChild($heading);

    my $uldoc = $session->make_element('ul');
    $div->appendChild($uldoc);

    my $dirpath = 'eprints-search/'.$dataobj->get_id().'/';

    my $i = 1;
    foreach my $doc ($dataobj->get_all_documents)
    {
      my $subdirpath = $dirpath."doc$i/";
      my %files = $doc->files;

      my $lidoc = $session->make_element('li');
      $uldoc->appendChild($lidoc);

      my $adoc = $session->make_element('a', href=>$dataobj->get_id."/doc$i/".$doc->get_main);
      $lidoc->appendChild($adoc);

      if ($doc->exists_and_set('formatdesc'))
      {
        $adoc->appendChild($session->make_text($doc->get_value('formatdesc')));
      }
      else
      {
        $adoc->appendChild($session->make_text($doc->get_main));
      }

      foreach my $filename (sort keys %files)
      {
       my $filepath = $subdirpath.$filename;
        my $file = $doc->local_path.'/'.$filename;

        if (-d $file)
        {
          next;
        }

        my $data = '';
        open (my $datafh ,'>', \$data);

        open (INFH, "<$file") or die ("Could not open file $file");
        while (<INFH>)
        {
          print {$datafh} $_;
        }
        close INFH;

        $zip->add_file($filepath, $data);
      }
      $i++;
    }
    $index .= EPrints::XML::to_string($div);
  }

  $index .= '</body></html>';
  $zip->add_file('eprints-search/index.htm',$index);

  if (defined $opts{fh})
  {
    $zip->write_filehandle($opts{fh},'zip');
    return undef;
  }
  $zip->write_filehandle($FH,'zip');
  return $archive;
}

1;

In More Detail

Constructor

For the sake of simplicity this plugin will only deal with lists of eprints. This avoids some code duplication, and it would be fairly easy to modify the plugin to deal with both individual eprints and lists of eprints sensibly. 

  $self->{accept} = [ 'list/eprint' ];

The file extension and MIME type are set to values appropriate for Zip files. 

  $self->{suffix} = '.zip';
  $self->{mimetype} = 'application/zip';

We need to import a module that is not included with EPrints for creating zip files. We use the EPrints::Utils::require_if_exists function to check if the module exists, and load it if it does. We then check the value returned from that function, and make the plugin invisible if it failed. 

  my $rc = EPrints::Utils::require_if_exists('Archive::Any::Create');
  unless ($rc)
  {
    $self->{visible} = '';
    $self->{error} = 'Unable to load required module Archive::Any::Create';
  }

List Handling

Setting Up

Here we setup an in-memory file for the Zip, and create an Archive object. 

  my $archive = '';
  open (my $FH, '>', \$archive) or
    die("Could not create filehandle: $!");
  my $zip = Archive::Any::Create->new;

Navigation

Here we begin to setup the HTML file that we'll add to our archive for navigation. First we setup a header. 

  my $index = <<END;
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
      <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
      <title>EPrints Search Results</title>
    </head>
  <body>
END

Now we get the Session object, we'll be using it to manipulate DOM objects later. 

  my $session = $plugin->{session};

Handling DataObjs

We loop over the DataObjs as we have done before.

This time we setup some DOM objects to be added to our index. Each eprint will have it's title printed out followed by a list of documents. 

    my $div = $session->make_element('div');
    my $heading = $session->make_element('h2');
    $heading->appendChild($session->make_text($dataobj->get_value('title')));
    $div->appendChild($heading);

    my $uldoc = $session->make_element('ul');
    $div->appendChild($uldoc);

We create a directory for each eprint. Note it is not necessary to explicitly create a directory, we simply have to set the appropriate file path. However this means that if you do not add files to a certain directory it will not be created, rather than having an empty directory for a given eprint. 

    my $dirpath = 'eprints-search/'.$dataobj->get_id().'/';

Dealing With Documents

We then loop over all the documents belonging to each DataObj. The get_all_documents method returns an array of Document objects. 

    my $i = 1;
    foreach my $doc ($dataobj->get_all_documents)
    {
      my $subdirpath = $dirpath."doc$i/";

Here we create a list item for the document containing a link to the main file. 

      my $lidoc = $session->make_element('li');
      $uldoc->appendChild($lidoc);

      my $adoc = $session->make_element('a', href=>$dataobj->get_id."/doc$i/".$doc->get_main);
      $lidoc->appendChild($adoc);

If a description of the main file has been set we use that as the link text, otherwise we use the filename. 

      if ($doc->exists_and_set('formatdesc'))
      {
        $adoc->appendChild($session->make_text($doc->get_value('formatdesc')));
      }
      else
      {
        $adoc->appendChild($session->make_text($doc->get_main));
      }

Dealing With Files

The files method of the Document object returns a hash whose keys are file names and values are file sizes. 

      my %files = $doc->files;

We loop over each file belonging to the document, in most cases there will only be one file. 

      foreach my $filename (sort keys %files)
      {
        my $filepath = $subdirpath.$filename;
        my $file = $doc->local_path.'/'.$filename;

We need to read the contents of the file and add it to a file in the zip. First we'll create another in-memory file to hold the contents. 

        my $data = '';
        open (my $datafh ,'>', \$data);

We open our file and print it straight out to our in-memory file. 

        open (INFH, "<$file") or die ("Could not open file $file");
        while (<INFH>)
        {
          print {$datafh} $_;
        }
        close INFH;

Then we add the file data to our file. 

        $zip->add_file($filepath, $data);

Finally we add the DOM object for our eprint to the index. 

    $index .= EPrints::XML::to_string($div);

Finishing Off

After finishing off our index file we add it to the zip file. 

  $index .= '</body></html>';
  $zip->add_file('eprints-search/index.htm',$index);

If a file handle has been provided we write to it, otherwise we write to the scalar file handle created earlier. We then return in the usual fashion. 

  if (defined $opts{fh})
  {
    $zip->write_filehandle($opts{fh},'zip');
    return undef;
  }
  $zip->write_filehandle($FH,'zip');
  return $archive;

Testing Your Plugin

Restart your webserver and test the plugin as in the previous tutorial.

Sample Output

Expzipv2.png

The accompanying HTML index.

Expzip2.png

Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Contribute:_Plugins/ExportPluginsZip&oldid=5688’