#!/usr/bin/perl
+# Copyright Biblibre 2008
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
+
+
use strict;
use warnings;
-use diagnostics;
-use CGI qw/:standard -oldstyle_urls/;
+use CGI qw( :standard -oldstyle_urls -utf8 );
use vars qw( $GZIP );
use C4::Context;
);
}
-binmode( STDOUT, ":utf8" );
+binmode STDOUT, ':encoding(UTF-8)';
my $repository = C4::OAI::Repository->new();
+
+
+
# __END__ Main Prog
# - from
# - until
# - offset
-#
+#
package C4::OAI::ResumptionToken;
use strict;
use warnings;
-use diagnostics;
use HTTP::OAI;
use base ("HTTP::OAI::ResumptionToken");
my $self = $class->SUPER::new(%args);
- my ($metadata_prefix, $offset, $from, $until);
+ my ($metadata_prefix, $offset, $from, $until, $set);
if ( $args{ resumptionToken } ) {
- ($metadata_prefix, $offset, $from, $until)
- = split( ':', $args{resumptionToken} );
+ ($metadata_prefix, $offset, $from, $until, $set)
+ = split( '/', $args{resumptionToken} );
}
else {
$metadata_prefix = $args{ metadataPrefix };
my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday) = gmtime( time );
$until = sprintf( "%.4d-%.2d-%.2d", $year+1900, $mon+1,$mday );
}
+ #Add times to the arguments, when necessary, so they correctly match against the DB timestamps
+ $from .= 'T00:00:00Z' if length($from) == 10;
+ $until .= 'T23:59:59Z' if length($until) == 10;
$offset = $args{ offset } || 0;
+ $set = $args{set} || '';
}
$self->{ metadata_prefix } = $metadata_prefix;
$self->{ offset } = $offset;
$self->{ from } = $from;
$self->{ until } = $until;
+ $self->{ set } = $set;
+ $self->{ from_arg } = _strip_UTC_designators($from);
+ $self->{ until_arg } = _strip_UTC_designators($until);
$self->resumptionToken(
- join( ':', $metadata_prefix, $offset, $from, $until ) );
+ join( '/', $metadata_prefix, $offset, $from, $until, $set ) );
$self->cursor( $offset );
return $self;
}
+sub _strip_UTC_designators {
+ my ( $timestamp ) = @_;
+ $timestamp =~ s/T/ /g;
+ $timestamp =~ s/Z//g;
+ return $timestamp;
+}
+
# __END__ C4::OAI::ResumptionToken
use strict;
use warnings;
-use diagnostics;
use HTTP::OAI;
use C4::Context;
MaxCount => C4::Context->preference("OAI-PMH:MaxCount"),
granularity => 'YYYY-MM-DD',
earliestDatestamp => '0001-01-01',
- deletedRecord => 'no',
+ deletedRecord => C4::Context->preference("OAI-PMH:DeletedRecord") || 'no',
);
# FIXME - alas, the description element is not so simple; to validate
use strict;
use warnings;
-use diagnostics;
use HTTP::OAI;
use base ("HTTP::OAI::ListMetadataFormats");
use strict;
use warnings;
-use diagnostics;
use HTTP::OAI;
use HTTP::OAI::Metadata::OAI_DC;
use base ("HTTP::OAI::Record");
sub new {
- my ($class, $repository, $marcxml, $timestamp, %args) = @_;
+ my ($class, $repository, $marcxml, $timestamp, $setSpecs, %args) = @_;
my $self = $class->SUPER::new(%args);
datestamp => $timestamp,
) );
+ foreach my $setSpec (@$setSpecs) {
+ $self->header->setSpec($setSpec);
+ }
+
my $parser = XML::LibXML->new();
my $record_dom = $parser->parse_string( $marcxml );
my $format = $args{metadataPrefix};
if ( $format ne 'marcxml' ) {
- $record_dom = $repository->stylesheet($format)->transform( $record_dom );
+ my %args = (
+ OPACBaseURL => "'" . C4::Context->preference('OPACBaseURL') . "'"
+ );
+ $record_dom = $repository->stylesheet($format)->transform($record_dom, %args);
}
$self->metadata( HTTP::OAI::Metadata->new( dom => $record_dom ) );
# __END__ C4::OAI::Record
+package C4::OAI::DeletedRecord;
+
+use Modern::Perl;
+use HTTP::OAI;
+use HTTP::OAI::Metadata::OAI_DC;
+
+use base ("HTTP::OAI::Record");
+
+sub new {
+ my ($class, $timestamp, $setSpecs, %args) = @_;
+
+ my $self = $class->SUPER::new(%args);
+
+ $timestamp =~ s/ /T/, $timestamp .= 'Z';
+ $self->header( new HTTP::OAI::Header(
+ status => 'deleted',
+ identifier => $args{identifier},
+ datestamp => $timestamp,
+ ) );
+
+ foreach my $setSpec (@$setSpecs) {
+ $self->header->setSpec($setSpec);
+ }
+
+ return $self;
+}
+
+# __END__ C4::OAI::DeletedRecord
+
package C4::OAI::GetRecord;
use strict;
use warnings;
-use diagnostics;
use HTTP::OAI;
+use C4::Biblio;
+use C4::OAI::Sets;
+use MARC::File::XML;
use base ("HTTP::OAI::GetRecord");
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("
- SELECT marcxml, timestamp
+ SELECT timestamp
FROM biblioitems
WHERE biblionumber=? " );
my $prefix = $repository->{koha_identifier} . ':';
my ($biblionumber) = $args{identifier} =~ /^$prefix(.*)/;
$sth->execute( $biblionumber );
- my ($marcxml, $timestamp);
- unless ( ($marcxml, $timestamp) = $sth->fetchrow ) {
- return HTTP::OAI::Response->new(
- requestURL => $repository->self_url(),
- errors => [ new HTTP::OAI::Error(
+ my ($timestamp, $deleted);
+ unless ( ($timestamp) = $sth->fetchrow ) {
+ unless ( ($timestamp) = $dbh->selectrow_array(q/
+ SELECT timestamp
+ FROM deletedbiblio
+ WHERE biblionumber=? /, undef, $biblionumber ))
+ {
+ return HTTP::OAI::Response->new(
+ requestURL => $repository->self_url(),
+ errors => [ new HTTP::OAI::Error(
code => 'idDoesNotExist',
message => "There is no biblio record with this identifier",
- ) ] ,
- );
+ ) ],
+ );
+ }
+ else {
+ $deleted = 1;
+ }
}
- #$self->header( HTTP::OAI::Header->new( identifier => $args{identifier} ) );
- $self->record( C4::OAI::Record->new(
- $repository, $marcxml, $timestamp, %args ) );
+ # We fetch it using this method, rather than the database directly,
+ # so it'll include the item data
+ my $marcxml;
+ $marcxml = $repository->get_biblio_marcxml($biblionumber, $args{metadataPrefix})
+ unless $deleted;
+ my $oai_sets = GetOAISetsBiblio($biblionumber);
+ my @setSpecs;
+ foreach (@$oai_sets) {
+ push @setSpecs, $_->{spec};
+ }
+ #$self->header( HTTP::OAI::Header->new( identifier => $args{identifier} ) );
+ $self->record(
+ $deleted
+ ? C4::OAI::DeletedRecord->new($timestamp, \@setSpecs, %args)
+ : C4::OAI::Record->new($repository, $marcxml, $timestamp, \@setSpecs, %args)
+ );
return $self;
}
use strict;
use warnings;
-use diagnostics;
use HTTP::OAI;
+use C4::OAI::Sets;
use base ("HTTP::OAI::ListIdentifiers");
my $token = new C4::OAI::ResumptionToken( %args );
my $dbh = C4::Context->dbh;
- my $sql = "SELECT biblionumber, timestamp
- FROM biblioitems
- WHERE timestamp >= ? AND timestamp <= ?
- LIMIT " . $repository->{koha_max_count} . "
- OFFSET " . $token->{offset};
+ my $set;
+ if(defined $token->{'set'}) {
+ $set = GetOAISetBySpec($token->{'set'});
+ }
+ my $max = $repository->{koha_max_count};
+ my $sql = "
+ (SELECT biblioitems.biblionumber, biblioitems.timestamp
+ FROM biblioitems
+ ";
+ $sql .= " JOIN oai_sets_biblios ON biblioitems.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
+ $sql .= " WHERE timestamp >= ? AND timestamp <= ? ";
+ $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
+ $sql .= ") UNION
+ (SELECT deletedbiblio.biblionumber, timestamp FROM deletedbiblio";
+ $sql .= " JOIN oai_sets_biblios ON deletedbiblio.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
+ $sql .= " WHERE DATE(timestamp) >= ? AND DATE(timestamp) <= ? ";
+ $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
+
+ $sql .= ") ORDER BY biblionumber
+ LIMIT " . ($max+1) . "
+ OFFSET $token->{offset}
+ ";
my $sth = $dbh->prepare( $sql );
- $sth->execute( $token->{from}, $token->{until} );
-
- my $pos = $token->{offset};
- while ( my ($biblionumber, $timestamp) = $sth->fetchrow ) {
- $timestamp =~ s/ /T/, $timestamp .= 'Z';
+ my @bind_params = ($token->{'from_arg'}, $token->{'until_arg'});
+ push @bind_params, $set->{'id'} if defined $set;
+ push @bind_params, ($token->{'from'}, $token->{'until'});
+ push @bind_params, $set->{'id'} if defined $set;
+ $sth->execute( @bind_params );
+
+ my $count = 0;
+ while ( my ($biblionumber, $timestamp) = $sth->fetchrow ) {
+ $count++;
+ if ( $count > $max ) {
+ $self->resumptionToken(
+ new C4::OAI::ResumptionToken(
+ metadataPrefix => $token->{metadata_prefix},
+ from => $token->{from},
+ until => $token->{until},
+ offset => $token->{offset} + $max,
+ set => $token->{set}
+ )
+ );
+ last;
+ }
+ $timestamp =~ s/ /T/, $timestamp .= 'Z';
$self->identifier( new HTTP::OAI::Header(
identifier => $repository->{ koha_identifier} . ':' . $biblionumber,
datestamp => $timestamp,
) );
- $pos++;
- }
- $self->resumptionToken( new C4::OAI::ResumptionToken(
- metadataPrefix => $token->{metadata_prefix},
- from => $token->{from},
- until => $token->{until},
- offset => $pos ) ) if ($pos > $token->{offset});
+ }
+
+ # Return error if no results
+ unless ($count) {
+ return HTTP::OAI::Response->new(
+ requestURL => $repository->self_url(),
+ errors => [ new HTTP::OAI::Error( code => 'noRecordsMatch' ) ],
+ );
+ }
return $self;
}
# __END__ C4::OAI::ListIdentifiers
+package C4::OAI::Description;
+
+use strict;
+use warnings;
+use HTTP::OAI;
+use HTTP::OAI::SAXHandler qw/ :SAX /;
+
+sub new {
+ my ( $class, %args ) = @_;
+
+ my $self = {};
+
+ if(my $setDescription = $args{setDescription}) {
+ $self->{setDescription} = $setDescription;
+ }
+ if(my $handler = $args{handler}) {
+ $self->{handler} = $handler;
+ }
+
+ bless $self, $class;
+ return $self;
+}
+
+sub set_handler {
+ my ( $self, $handler ) = @_;
+
+ $self->{handler} = $handler if $handler;
+
+ return $self;
+}
+sub generate {
+ my ( $self ) = @_;
+
+ g_data_element($self->{handler}, 'http://www.openarchives.org/OAI/2.0/', 'setDescription', {}, $self->{setDescription});
+
+ return $self;
+}
+
+# __END__ C4::OAI::Description
+
+package C4::OAI::ListSets;
+
+use strict;
+use warnings;
+use HTTP::OAI;
+use C4::OAI::Sets;
+
+use base ("HTTP::OAI::ListSets");
+
+sub new {
+ my ( $class, $repository, %args ) = @_;
+
+ my $self = HTTP::OAI::ListSets->new(%args);
+
+ my $token = C4::OAI::ResumptionToken->new(%args);
+ my $sets = GetOAISets;
+ my $pos = 0;
+ foreach my $set (@$sets) {
+ if ($pos < $token->{offset}) {
+ $pos++;
+ next;
+ }
+ my @descriptions;
+ foreach my $desc (@{$set->{'descriptions'}}) {
+ push @descriptions, C4::OAI::Description->new(
+ setDescription => $desc,
+ );
+ }
+ $self->set(
+ HTTP::OAI::Set->new(
+ setSpec => $set->{'spec'},
+ setName => $set->{'name'},
+ setDescription => \@descriptions,
+ )
+ );
+ $pos++;
+ last if ($pos + 1 - $token->{offset}) > $repository->{koha_max_count};
+ }
+
+ $self->resumptionToken(
+ new C4::OAI::ResumptionToken(
+ metadataPrefix => $token->{metadata_prefix},
+ offset => $pos
+ )
+ ) if ( $pos > $token->{offset} );
+
+ return $self;
+}
+
+# __END__ C4::OAI::ListSets;
package C4::OAI::ListRecords;
use strict;
use warnings;
-use diagnostics;
+use C4::Biblio;
use HTTP::OAI;
+use C4::OAI::Sets;
+use MARC::File::XML;
use base ("HTTP::OAI::ListRecords");
my $token = new C4::OAI::ResumptionToken( %args );
my $dbh = C4::Context->dbh;
- my $sql = "SELECT biblionumber, marcxml, timestamp
- FROM biblioitems
- WHERE timestamp >= ? AND timestamp <= ?
- LIMIT " . $repository->{koha_max_count} . "
- OFFSET " . $token->{offset};
+ my $set;
+ if(defined $token->{'set'}) {
+ $set = GetOAISetBySpec($token->{'set'});
+ }
+ my $max = $repository->{koha_max_count};
+ my $sql = "
+ (SELECT biblioitems.biblionumber, biblioitems.timestamp, marcxml
+ FROM biblioitems
+ ";
+ $sql .= " JOIN oai_sets_biblios ON biblioitems.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
+ $sql .= " WHERE timestamp >= ? AND timestamp <= ? ";
+ $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
+ $sql .= ") UNION
+ (SELECT deletedbiblio.biblionumber, null as marcxml, timestamp FROM deletedbiblio";
+ $sql .= " JOIN oai_sets_biblios ON deletedbiblio.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
+ $sql .= " WHERE DATE(timestamp) >= ? AND DATE(timestamp) <= ? ";
+ $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
+
+ $sql .= ") ORDER BY biblionumber
+ LIMIT " . ($max + 1) . "
+ OFFSET $token->{offset}
+ ";
my $sth = $dbh->prepare( $sql );
- $sth->execute( $token->{from}, $token->{until} );
-
- my $pos = $token->{offset};
- while ( my ($biblionumber, $marcxml, $timestamp) = $sth->fetchrow ) {
- $self->record( C4::OAI::Record->new(
- $repository, $marcxml, $timestamp,
- identifier => $repository->{ koha_identifier } . ':' . $biblionumber,
- metadataPrefix => $token->{metadata_prefix}
- ) );
- $pos++;
- }
- $self->resumptionToken( new C4::OAI::ResumptionToken(
- metadataPrefix => $token->{metadata_prefix},
- from => $token->{from},
- until => $token->{until},
- offset => $pos ) ) if ($pos > $token->{offset});
+ my @bind_params = ($token->{'from_arg'}, $token->{'until_arg'});
+ push @bind_params, $set->{'id'} if defined $set;
+ push @bind_params, ($token->{'from'}, $token->{'until'});
+ push @bind_params, $set->{'id'} if defined $set;
+ $sth->execute( @bind_params );
+
+ my $count = 0;
+ my $format = $args{metadataPrefix} || $token->{metadata_prefix};
+ while ( my ($biblionumber, $timestamp) = $sth->fetchrow ) {
+ $count++;
+ if ( $count > $max ) {
+ $self->resumptionToken(
+ new C4::OAI::ResumptionToken(
+ metadataPrefix => $token->{metadata_prefix},
+ from => $token->{from},
+ until => $token->{until},
+ offset => $token->{offset} + $max,
+ set => $token->{set}
+ )
+ );
+ last;
+ }
+ my $marcxml = $repository->get_biblio_marcxml($biblionumber, $format);
+ my $oai_sets = GetOAISetsBiblio($biblionumber);
+ my @setSpecs;
+ foreach (@$oai_sets) {
+ push @setSpecs, $_->{spec};
+ }
+ if ($marcxml) {
+ $self->record( C4::OAI::Record->new(
+ $repository, $marcxml, $timestamp, \@setSpecs,
+ identifier => $repository->{ koha_identifier } . ':' . $biblionumber,
+ metadataPrefix => $token->{metadata_prefix}
+ ) );
+ } else {
+ $self->record( C4::OAI::DeletedRecord->new(
+ $timestamp, \@setSpecs, identifier => $repository->{ koha_identifier } . ':' . $biblionumber ) );
+ }
+ }
+
+ # Return error if no results
+ unless ($count) {
+ return HTTP::OAI::Response->new(
+ requestURL => $repository->self_url(),
+ errors => [ new HTTP::OAI::Error( code => 'noRecordsMatch' ) ],
+ );
+ }
return $self;
}
use strict;
use warnings;
-use diagnostics;
use HTTP::OAI;
use HTTP::OAI::Repository qw/:validate/;
else {
my %attr = CGI::Vars();
my $verb = delete( $attr{verb} );
- if ( grep { $_ eq $verb } qw( ListSets ) ) {
- $response = HTTP::OAI::Response->new(
- requestURL => $self->self_url(),
- errors => [ new HTTP::OAI::Error(
- code => 'noSetHierarchy',
- message => "Koha repository doesn't have sets",
- ) ] ,
- );
+ if ( $verb eq 'ListSets' ) {
+ $response = C4::OAI::ListSets->new($self, %attr);
}
elsif ( $verb eq 'Identify' ) {
$response = C4::OAI::Identify->new( $self );
}
+sub get_biblio_marcxml {
+ my ($self, $biblionumber, $format) = @_;
+ my $with_items = 0;
+ if ( my $conf = $self->{conf} ) {
+ $with_items = $conf->{format}->{$format}->{include_items};
+ }
+ my $record = GetMarcBiblio($biblionumber, $with_items, 1);
+ $record ? $record->as_xml() : undef;
+}
+
+
sub stylesheet {
my ( $self, $format ) = @_;
This object extend HTTP::OAI::Repository object.
It accepts OAI-PMH HTTP requests and returns result.
-This OAI-PMH server can operate in a simple mode and extended one.
+This OAI-PMH server can operate in a simple mode and extended one.
In simple mode, repository configuration comes entirely from Koha system
preferences (OAI-PMH:archiveID and OAI-PMH:MaxCount) and the server returns
projects / koha.git / blobdiff