Contribute: Plugins/ExportPluginsZip - Revision history

Pm705 at 13:51, 8 February 2010

2010-02-08T13:51:09Z

← Older revision		Revision as of 13:51, 8 February 2010
Line 1:		Line 1:
			[[Category:Contribute]]
			[[Category:Plugins]]
	= Export Plugin Tutorial 5: Zip =		= 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.		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.

Tom: /* Handling DataObjs */

2007-09-28T19:01:13Z

Handling DataObjs

← Older revision		Revision as of 19:01, 28 September 2007
Line 197:		Line 197:
	We loop over the DataObjs as we have done before.		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.		This time we setup some [http://en.wikipedia.org/wiki/Document_Object_Model 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');
Line 278:		Line 278:
	</pre>		</pre>

	Finally we add the DOM object for our eprint to the index.		Finally we add the [http://en.wikipedia.org/wiki/Document_Object_Model DOM] object for our eprint to the index.
	<pre>		<pre>
	$index .= EPrints::XML::to_string($div);		$index .= EPrints::XML::to_string($div);

Tom: /* Navigation */

2007-09-28T19:00:43Z

Navigation

← Older revision		Revision as of 19:00, 28 September 2007
Line 189:		Line 189:
	</pre>		</pre>

	Now we get the Session object, we'll be using it to manipulate DOM objects later.		Now we get the Session object, we'll be using it to manipulate [http://en.wikipedia.org/wiki/Document_Object_Model DOM] objects later.
	<pre>		<pre>
	my $session = $plugin->{session};		my $session = $plugin->{session};

Tom: /* Constructor */

2007-09-28T19:00:25Z

Constructor

← Older revision		Revision as of 19:00, 28 September 2007
Line 147:		Line 147:
	</pre>		</pre>

	The file extension and MIME type are set to values appropriate for Zip files.		The file extension and [http://en.wikipedia.org/wiki/MIME MIME] type are set to values appropriate for Zip files.
	<pre>		<pre>
	$self->{suffix} = '.zip';		$self->{suffix} = '.zip';

Tom: /* Zip.pm */

2007-09-28T14:02:10Z

Zip.pm

← Older revision		Revision as of 14:02, 28 September 2007
Line 9:		Line 9:

	= Zip.pm =		= Zip.pm =
			The code in the section below should be placed in a file called Zip.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.

	<pre>		<pre>

Tom: /* Testing Your Plugin */

2007-09-28T10:26:37Z

Testing Your Plugin

← Older revision		Revision as of 10:26, 28 September 2007
Line 301:		Line 301:

	= Testing Your Plugin =		= Testing Your Plugin =
	Restart your webserver and test the plugin as in [[~~User~~:~~Tom~~/~~Export_Plugins/Excel~~ \| ~~the previous tutorial~~]].		Restart your webserver and test the plugin as [[Contribute:_Plugins/ExportPluginsHello\| before]].

	== Sample Output ==		== Sample Output ==

Tom: User:Tom/Export Plugins/Zip moved to Contribute: Plugins/ExportPluginsZip

2007-09-27T20:57:16Z

User:Tom/Export Plugins/Zip moved to Contribute: Plugins/ExportPluginsZip

← Older revision	Revision as of 20:57, 27 September 2007
(No difference)

Tom: /* In More Detail */

2007-09-27T11:38:01Z

In More Detail

← Older revision		Revision as of 11:38, 27 September 2007
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>

Tom: /* Zip.pm */

2007-09-27T11:32:31Z

Zip.pm

← Older revision		Revision as of 11:32, 27 September 2007
Line 13:		Line 13:
	package EPrints::Plugin::Export::MyPlugins::Zip;		package EPrints::Plugin::Export::MyPlugins::Zip;

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

	use strict;		use strict;
Line 24:		Line 24:
	my $self = $class->SUPER::new(%opts);		my $self = $class->SUPER::new(%opts);

	$self->{name} = "Zip";		$self->{name} = 'Zip';
	$self->{accept} = [ 'list/eprint' ];		$self->{accept} = [ 'list/eprint' ];
	$self->{visible} = "all";		$self->{visible} = 'all';
	$self->{suffix} = ".zip";		$self->{suffix} = '.zip';
	$self->{mimetype} = "application/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;		return $self;
Line 55:		Line 62:
	my $session = $plugin->{session};		my $session = $plugin->{session};

	foreach my $dataobj ($opts{"list"}->get_records)		foreach my $dataobj ($opts{list}->get_records)
	{		{
	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);

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

	my $i = 1;		my $i = 1;
Line 73:		Line 80:
	my %files = $doc->files;		my %files = $doc->files;

	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);

	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 91:		Line 98:
	{		{
	my $filepath = $subdirpath.$filename;		my $filepath = $subdirpath.$filename;
	my $file = $doc->local_path."/".$filename;		my $file = $doc->local_path.'/'.$filename;

	if (-d $file)		if (-d $file)
Line 115:		Line 122:
	}		}

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

	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;
	}		}

Tom: /* Sample Output */

2007-09-04T14:41:32Z

Sample Output

← Older revision		Revision as of 14:41, 4 September 2007
Line 292:		Line 292:

	== Sample Output ==		== Sample Output ==
	[[Image:~~Expzip~~.png]]		[[Image:Expzipv2.png]]

	The accompanying HTML index.		The accompanying HTML index.

	[[Image:Expzip2.png]]		[[Image:Expzip2.png]]