opac/oai.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright Biblibre 2008
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20
  21 use strict;
  22 use warnings;
  23
  24 use CGI qw( :standard -oldstyle_urls -utf8 );
  25 use vars qw( $GZIP );
  26 use C4::Context;
  27
  28
  29 BEGIN {
  30     eval { require PerlIO::gzip };
  31     $GZIP = ($@) ? 0 : 1;
  32 }
  33
  34 unless ( C4::Context->preference('OAI-PMH') ) {
  35     print
  36         header(
  37             -type       => 'text/plain; charset=utf-8',
  38             -charset    => 'utf-8',
  39             -status     => '404 OAI-PMH service is disabled',
  40         ),
  41         "OAI-PMH service is disabled";
  42     exit;
  43 }
  44
  45 my @encodings = http('HTTP_ACCEPT_ENCODING');
  46 if ( $GZIP && grep { defined($_) && $_ eq 'gzip' } @encodings ) {
  47     print header(
  48         -type               => 'text/xml; charset=utf-8',
  49         -charset            => 'utf-8',
  50         -Content-Encoding   => 'gzip',
  51     );
  52     binmode( STDOUT, ":gzip" );
  53 }
  54 else {
  55     print header(
  56         -type       => 'text/xml; charset=utf-8',
  57         -charset    => 'utf-8',
  58     );
  59 }
  60
  61 binmode STDOUT, ':encoding(UTF-8)';
  62 my $repository = C4::OAI::Repository->new();
  63
  64 # __END__ Main Prog
  65
  66
  67 #
  68 # Extends HTTP::OAI::ResumptionToken
  69 # A token is identified by:
  70 # - metadataPrefix
  71 # - from
  72 # - until
  73 # - offset
  74 #
  75 package C4::OAI::ResumptionToken;
  76
  77 use strict;
  78 use warnings;
  79 use HTTP::OAI;
  80
  81 use base ("HTTP::OAI::ResumptionToken");
  82
  83
  84 sub new {
  85     my ($class, %args) = @_;
  86
  87     my $self = $class->SUPER::new(%args);
  88
  89     my ($metadata_prefix, $offset, $from, $until, $set);
  90     if ( $args{ resumptionToken } ) {
  91         ($metadata_prefix, $offset, $from, $until, $set)
  92             = split( '/', $args{resumptionToken} );
  93     }
  94     else {
  95         $metadata_prefix = $args{ metadataPrefix };
  96         $from = $args{ from } || '1970-01-01';
  97         $until = $args{ until };
  98         unless ( $until) {
  99             my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday) = gmtime( time );
 100             $until = sprintf( "%.4d-%.2d-%.2d", $year+1900, $mon+1,$mday );
 101         }
 102         #Add times to the arguments, when necessary, so they correctly match against the DB timestamps
 103         $from .= 'T00:00:00Z' if length($from) == 10;
 104         $until .= 'T23:59:59Z' if length($until) == 10;
 105         $offset = $args{ offset } || 0;
 106         $set = $args{set};
 107     }
 108
 109     $self->{ metadata_prefix } = $metadata_prefix;
 110     $self->{ offset          } = $offset;
 111     $self->{ from            } = $from;
 112     $self->{ until           } = $until;
 113     $self->{ set             } = $set;
 114     $self->{ from_arg        } = _strip_UTC_designators($from);
 115     $self->{ until_arg       } = _strip_UTC_designators($until);
 116
 117     $self->resumptionToken(
 118         join( '/', $metadata_prefix, $offset, $from, $until, $set ) );
 119     $self->cursor( $offset );
 120
 121     return $self;
 122 }
 123
 124 sub _strip_UTC_designators {
 125     my ( $timestamp ) = @_;
 126     $timestamp =~ s/T/ /g;
 127     $timestamp =~ s/Z//g;
 128     return $timestamp;
 129 }
 130
 131 # __END__ C4::OAI::ResumptionToken
 132
 133
 134
 135 package C4::OAI::Identify;
 136
 137 use strict;
 138 use warnings;
 139 use HTTP::OAI;
 140 use C4::Context;
 141
 142 use base ("HTTP::OAI::Identify");
 143
 144 sub new {
 145     my ($class, $repository) = @_;
 146
 147     my ($baseURL) = $repository->self_url() =~ /(.*)\?.*/;
 148     my $self = $class->SUPER::new(
 149         baseURL             => $baseURL,
 150         repositoryName      => C4::Context->preference("LibraryName"),
 151         adminEmail          => C4::Context->preference("KohaAdminEmailAddress"),
 152         MaxCount            => C4::Context->preference("OAI-PMH:MaxCount"),
 153         granularity         => 'YYYY-MM-DD',
 154         earliestDatestamp   => '0001-01-01',
 155         deletedRecord       => C4::Context->preference("OAI-PMH:DeletedRecord") || 'no',
 156     );
 157
 158     # FIXME - alas, the description element is not so simple; to validate
 159     # against the OAI-PMH schema, it cannot contain just a string,
 160     # but one or more elements that validate against another XML schema.
 161     # For now, simply omitting it.
 162     # $self->description( "Koha OAI Repository" );
 163
 164     $self->compression( 'gzip' );
 165
 166     return $self;
 167 }
 168
 169 # __END__ C4::OAI::Identify
 170
 171
 172
 173 package C4::OAI::ListMetadataFormats;
 174
 175 use strict;
 176 use warnings;
 177 use HTTP::OAI;
 178
 179 use base ("HTTP::OAI::ListMetadataFormats");
 180
 181 sub new {
 182     my ($class, $repository) = @_;
 183
 184     my $self = $class->SUPER::new();
 185
 186     if ( $repository->{ conf } ) {
 187         foreach my $name ( @{ $repository->{ koha_metadata_format } } ) {
 188             my $format = $repository->{ conf }->{ format }->{ $name };
 189             $self->metadataFormat( HTTP::OAI::MetadataFormat->new(
 190                 metadataPrefix    => $format->{metadataPrefix},
 191                 schema            => $format->{schema},
 192                 metadataNamespace => $format->{metadataNamespace}, ) );
 193         }
 194     }
 195     else {
 196         $self->metadataFormat( HTTP::OAI::MetadataFormat->new(
 197             metadataPrefix    => 'oai_dc',
 198             schema            => 'http://www.openarchives.org/OAI/2.0/oai_dc.xsd',
 199             metadataNamespace => 'http://www.openarchives.org/OAI/2.0/oai_dc/'
 200         ) );
 201         $self->metadataFormat( HTTP::OAI::MetadataFormat->new(
 202             metadataPrefix    => 'marcxml',
 203             schema            => 'http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd',
 204             metadataNamespace => 'http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim'
 205         ) );
 206     }
 207
 208     return $self;
 209 }
 210
 211 # __END__ C4::OAI::ListMetadataFormats
 212
 213
 214
 215 package C4::OAI::Record;
 216
 217 use strict;
 218 use warnings;
 219 use HTTP::OAI;
 220 use HTTP::OAI::Metadata::OAI_DC;
 221
 222 use base ("HTTP::OAI::Record");
 223
 224 sub new {
 225     my ($class, $repository, $marcxml, $timestamp, $setSpecs, %args) = @_;
 226
 227     my $self = $class->SUPER::new(%args);
 228
 229     $timestamp =~ s/ /T/, $timestamp .= 'Z';
 230     $self->header( new HTTP::OAI::Header(
 231         identifier  => $args{identifier},
 232         datestamp   => $timestamp,
 233     ) );
 234
 235     foreach my $setSpec (@$setSpecs) {
 236         $self->header->setSpec($setSpec);
 237     }
 238
 239     my $parser = XML::LibXML->new();
 240     my $record_dom = $parser->parse_string( $marcxml );
 241     my $format =  $args{metadataPrefix};
 242     if ( $format ne 'marcxml' ) {
 243         my %args = (
 244             OPACBaseURL => "'" . C4::Context->preference('OPACBaseURL') . "'"
 245         );
 246         $record_dom = $repository->stylesheet($format)->transform($record_dom, %args);
 247     }
 248     $self->metadata( HTTP::OAI::Metadata->new( dom => $record_dom ) );
 249
 250     return $self;
 251 }
 252
 253 # __END__ C4::OAI::Record
 254
 255 package C4::OAI::DeletedRecord;
 256
 257 use Modern::Perl;
 258 use HTTP::OAI;
 259 use HTTP::OAI::Metadata::OAI_DC;
 260
 261 use base ("HTTP::OAI::Record");
 262
 263 sub new {
 264     my ($class, $timestamp, $setSpecs, %args) = @_;
 265
 266     my $self = $class->SUPER::new(%args);
 267
 268     $timestamp =~ s/ /T/, $timestamp .= 'Z';
 269     $self->header( new HTTP::OAI::Header(
 270         status      => 'deleted',
 271         identifier  => $args{identifier},
 272         datestamp   => $timestamp,
 273     ) );
 274
 275     foreach my $setSpec (@$setSpecs) {
 276         $self->header->setSpec($setSpec);
 277     }
 278
 279     return $self;
 280 }
 281
 282 # __END__ C4::OAI::DeletedRecord
 283
 284
 285
 286 package C4::OAI::GetRecord;
 287
 288 use strict;
 289 use warnings;
 290 use HTTP::OAI;
 291 use C4::OAI::Sets;
 292
 293 use base ("HTTP::OAI::GetRecord");
 294
 295
 296 sub new {
 297     my ($class, $repository, %args) = @_;
 298
 299     my $self = HTTP::OAI::GetRecord->new(%args);
 300
 301     my $dbh = C4::Context->dbh;
 302     my $prefix = $repository->{koha_identifier} . ':';
 303     my ($biblionumber) = $args{identifier} =~ /^$prefix(.*)/;
 304     my ($marcxml, $timestamp);
 305     my $deleted = 0;
 306     unless ( ($marcxml, $timestamp) = $dbh->selectrow_array(q/
 307         SELECT marcxml, timestamp
 308         FROM   biblioitems
 309         WHERE  biblionumber=? /, undef, $biblionumber)) {
 310
 311       unless ( ($marcxml, $timestamp) = $dbh->selectrow_array(q/
 312           SELECT biblionumber, timestamp
 313           FROM deletedbiblio
 314           WHERE biblionumber=? /, undef, $biblionumber )) {
 315
 316
 317         return HTTP::OAI::Response->new(
 318             requestURL  => $repository->self_url(),
 319             errors      => [ new HTTP::OAI::Error(
 320                 code    => 'idDoesNotExist',
 321                 message => "There is no biblio record with this identifier",
 322                 ) ] ,
 323         );
 324       } else {
 325         $deleted = 1;
 326       }
 327     }
 328     my $oai_sets = GetOAISetsBiblio($biblionumber);
 329     my @setSpecs;
 330     foreach (@$oai_sets) {
 331         push @setSpecs, $_->{spec};
 332     }
 333
 334     #$self->header( HTTP::OAI::Header->new( identifier  => $args{identifier} ) );
 335     ($deleted == 1) ? $self->record( C4::OAI::DeletedRecord->new(
 336         $timestamp, \@setSpecs, %args ) )
 337         : $self->record( C4::OAI::Record->new(
 338         $repository, $marcxml, $timestamp, \@setSpecs, %args ) );
 339     return $self;
 340 }
 341
 342 # __END__ C4::OAI::GetRecord
 343
 344
 345
 346 package C4::OAI::ListIdentifiers;
 347
 348 use strict;
 349 use warnings;
 350 use HTTP::OAI;
 351 use C4::OAI::Sets;
 352
 353 use base ("HTTP::OAI::ListIdentifiers");
 354
 355
 356 sub new {
 357     my ($class, $repository, %args) = @_;
 358
 359     my $self = HTTP::OAI::ListIdentifiers->new(%args);
 360
 361     my $token = new C4::OAI::ResumptionToken( %args );
 362     my $dbh = C4::Context->dbh;
 363     my $set;
 364     if(defined $token->{'set'}) {
 365         $set = GetOAISetBySpec($token->{'set'});
 366     }
 367     my $max = $repository->{koha_max_count};
 368     my $sql = "
 369         (SELECT biblioitems.biblionumber, biblioitems.timestamp
 370         FROM biblioitems
 371     ";
 372     $sql .= " JOIN oai_sets_biblios ON biblioitems.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
 373     $sql .= " WHERE timestamp >= ? AND timestamp <= ? ";
 374     $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
 375     $sql .= ") UNION
 376         (SELECT deletedbiblio.biblionumber, timestamp FROM deletedbiblio";
 377     $sql .= " JOIN oai_sets_biblios ON deletedbiblio.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
 378     $sql .= " WHERE DATE(timestamp) >= ? AND DATE(timestamp) <= ? ";
 379     $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
 380
 381     $sql .= ") ORDER BY biblionumber
 382         LIMIT " . ($max+1) . "
 383         OFFSET $token->{offset}
 384     ";
 385     my $sth = $dbh->prepare( $sql );
 386     my @bind_params = ($token->{'from_arg'}, $token->{'until_arg'});
 387     push @bind_params, $set->{'id'} if defined $set;
 388     push @bind_params, ($token->{'from'}, $token->{'until'});
 389     push @bind_params, $set->{'id'} if defined $set;
 390     $sth->execute( @bind_params );
 391
 392     my $count = 0;
 393     while ( my ($biblionumber, $timestamp) = $sth->fetchrow ) {
 394         $count++;
 395         if ( $count > $max ) {
 396             $self->resumptionToken(
 397                 new C4::OAI::ResumptionToken(
 398                     metadataPrefix  => $token->{metadata_prefix},
 399                     from            => $token->{from},
 400                     until           => $token->{until},
 401                     offset          => $token->{offset} + $max,
 402                     set             => $token->{set}
 403                 )
 404             );
 405             last;
 406         }
 407         $timestamp =~ s/ /T/, $timestamp .= 'Z';
 408         $self->identifier( new HTTP::OAI::Header(
 409             identifier => $repository->{ koha_identifier} . ':' . $biblionumber,
 410             datestamp  => $timestamp,
 411         ) );
 412     }
 413
 414     return $self;
 415 }
 416
 417 # __END__ C4::OAI::ListIdentifiers
 418
 419 package C4::OAI::Description;
 420
 421 use strict;
 422 use warnings;
 423 use HTTP::OAI;
 424 use HTTP::OAI::SAXHandler qw/ :SAX /;
 425
 426 sub new {
 427     my ( $class, %args ) = @_;
 428
 429     my $self = {};
 430
 431     if(my $setDescription = $args{setDescription}) {
 432         $self->{setDescription} = $setDescription;
 433     }
 434     if(my $handler = $args{handler}) {
 435         $self->{handler} = $handler;
 436     }
 437
 438     bless $self, $class;
 439     return $self;
 440 }
 441
 442 sub set_handler {
 443     my ( $self, $handler ) = @_;
 444
 445     $self->{handler} = $handler if $handler;
 446
 447     return $self;
 448 }
 449
 450 sub generate {
 451     my ( $self ) = @_;
 452
 453     g_data_element($self->{handler}, 'http://www.openarchives.org/OAI/2.0/', 'setDescription', {}, $self->{setDescription});
 454
 455     return $self;
 456 }
 457
 458 # __END__ C4::OAI::Description
 459
 460 package C4::OAI::ListSets;
 461
 462 use strict;
 463 use warnings;
 464 use HTTP::OAI;
 465 use C4::OAI::Sets;
 466
 467 use base ("HTTP::OAI::ListSets");
 468
 469 sub new {
 470     my ( $class, $repository, %args ) = @_;
 471
 472     my $self = HTTP::OAI::ListSets->new(%args);
 473
 474     my $token = C4::OAI::ResumptionToken->new(%args);
 475     my $sets = GetOAISets;
 476     my $pos = 0;
 477     foreach my $set (@$sets) {
 478         if ($pos < $token->{offset}) {
 479             $pos++;
 480             next;
 481         }
 482         my @descriptions;
 483         foreach my $desc (@{$set->{'descriptions'}}) {
 484             push @descriptions, C4::OAI::Description->new(
 485                 setDescription => $desc,
 486             );
 487         }
 488         $self->set(
 489             HTTP::OAI::Set->new(
 490                 setSpec => $set->{'spec'},
 491                 setName => $set->{'name'},
 492                 setDescription => \@descriptions,
 493             )
 494         );
 495         $pos++;
 496         last if ($pos + 1 - $token->{offset}) > $repository->{koha_max_count};
 497     }
 498
 499     $self->resumptionToken(
 500         new C4::OAI::ResumptionToken(
 501             metadataPrefix => $token->{metadata_prefix},
 502             offset         => $pos
 503         )
 504     ) if ( $pos > $token->{offset} );
 505
 506     return $self;
 507 }
 508
 509 # __END__ C4::OAI::ListSets;
 510
 511 package C4::OAI::ListRecords;
 512
 513 use strict;
 514 use warnings;
 515 use HTTP::OAI;
 516 use C4::OAI::Sets;
 517
 518 use base ("HTTP::OAI::ListRecords");
 519
 520
 521 sub new {
 522     my ($class, $repository, %args) = @_;
 523
 524     my $self = HTTP::OAI::ListRecords->new(%args);
 525
 526     my $token = new C4::OAI::ResumptionToken( %args );
 527     my $dbh = C4::Context->dbh;
 528     my $set;
 529     if(defined $token->{'set'}) {
 530         $set = GetOAISetBySpec($token->{'set'});
 531     }
 532     my $max = $repository->{koha_max_count};
 533     my $sql = "
 534         (SELECT biblioitems.biblionumber, biblioitems.marcxml, biblioitems.timestamp
 535         FROM biblioitems
 536     ";
 537     $sql .= " JOIN oai_sets_biblios ON biblioitems.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
 538     $sql .= " WHERE timestamp >= ? AND timestamp <= ? ";
 539     $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
 540     $sql .= ") UNION
 541         (SELECT deletedbiblio.biblionumber, null as marcxml, timestamp FROM deletedbiblio";
 542     $sql .= " JOIN oai_sets_biblios ON deletedbiblio.biblionumber = oai_sets_biblios.biblionumber " if defined $set;
 543     $sql .= " WHERE DATE(timestamp) >= ? AND DATE(timestamp) <= ? ";
 544     $sql .= " AND oai_sets_biblios.set_id = ? " if defined $set;
 545
 546     $sql .= ") ORDER BY biblionumber
 547         LIMIT " . ($max + 1) . "
 548         OFFSET $token->{offset}
 549     ";
 550     my $sth = $dbh->prepare( $sql );
 551     my @bind_params = ($token->{'from_arg'}, $token->{'until_arg'});
 552     push @bind_params, $set->{'id'} if defined $set;
 553     push @bind_params, ($token->{'from'}, $token->{'until'});
 554     push @bind_params, $set->{'id'} if defined $set;
 555     $sth->execute( @bind_params );
 556
 557     my $count = 0;
 558     while ( my ($biblionumber, $marcxml, $timestamp) = $sth->fetchrow ) {
 559         $count++;
 560         if ( $count > $max ) {
 561             $self->resumptionToken(
 562                 new C4::OAI::ResumptionToken(
 563                     metadataPrefix  => $token->{metadata_prefix},
 564                     from            => $token->{from},
 565                     until           => $token->{until},
 566                     offset          => $token->{offset} + $max,
 567                     set             => $token->{set}
 568                 )
 569             );
 570             last;
 571         }
 572         my $oai_sets = GetOAISetsBiblio($biblionumber);
 573         my @setSpecs;
 574         foreach (@$oai_sets) {
 575             push @setSpecs, $_->{spec};
 576         }
 577         if ($marcxml) {
 578           $self->record( C4::OAI::Record->new(
 579               $repository, $marcxml, $timestamp, \@setSpecs,
 580               identifier      => $repository->{ koha_identifier } . ':' . $biblionumber,
 581               metadataPrefix  => $token->{metadata_prefix}
 582           ) );
 583         } else {
 584           $self->record( C4::OAI::DeletedRecord->new(
 585           $timestamp, \@setSpecs, identifier => $repository->{ koha_identifier } . ':' . $biblionumber ) );
 586         }
 587     }
 588
 589     return $self;
 590 }
 591
 592 # __END__ C4::OAI::ListRecords
 593
 594
 595
 596 package C4::OAI::Repository;
 597
 598 use base ("HTTP::OAI::Repository");
 599
 600 use strict;
 601 use warnings;
 602
 603 use HTTP::OAI;
 604 use HTTP::OAI::Repository qw/:validate/;
 605
 606 use XML::SAX::Writer;
 607 use XML::LibXML;
 608 use XML::LibXSLT;
 609 use YAML::Syck qw( LoadFile );
 610 use CGI qw/:standard -oldstyle_urls/;
 611
 612 use C4::Context;
 613 use C4::Biblio;
 614
 615
 616 sub new {
 617     my ($class, %args) = @_;
 618     my $self = $class->SUPER::new(%args);
 619
 620     $self->{ koha_identifier      } = C4::Context->preference("OAI-PMH:archiveID");
 621     $self->{ koha_max_count       } = C4::Context->preference("OAI-PMH:MaxCount");
 622     $self->{ koha_metadata_format } = ['oai_dc', 'marcxml'];
 623     $self->{ koha_stylesheet      } = { }; # Build when needed
 624
 625     # Load configuration file if defined in OAI-PMH:ConfFile syspref
 626     if ( my $file = C4::Context->preference("OAI-PMH:ConfFile") ) {
 627         $self->{ conf } = LoadFile( $file );
 628         my @formats = keys %{ $self->{conf}->{format} };
 629         $self->{ koha_metadata_format } =  \@formats;
 630     }
 631
 632     # Check for grammatical errors in the request
 633     my @errs = validate_request( CGI::Vars() );
 634
 635     # Is metadataPrefix supported by the respository?
 636     my $mdp = param('metadataPrefix') || '';
 637     if ( $mdp && !grep { $_ eq $mdp } @{$self->{ koha_metadata_format }} ) {
 638         push @errs, new HTTP::OAI::Error(
 639             code    => 'cannotDisseminateFormat',
 640             message => "Dissemination as '$mdp' is not supported",
 641         );
 642     }
 643
 644     my $response;
 645     if ( @errs ) {
 646         $response = HTTP::OAI::Response->new(
 647             requestURL  => self_url(),
 648             errors      => \@errs,
 649         );
 650     }
 651     else {
 652         my %attr = CGI::Vars();
 653         my $verb = delete( $attr{verb} );
 654         if ( $verb eq 'ListSets' ) {
 655             $response = C4::OAI::ListSets->new($self, %attr);
 656         }
 657         elsif ( $verb eq 'Identify' ) {
 658             $response = C4::OAI::Identify->new( $self );
 659         }
 660         elsif ( $verb eq 'ListMetadataFormats' ) {
 661             $response = C4::OAI::ListMetadataFormats->new( $self );
 662         }
 663         elsif ( $verb eq 'GetRecord' ) {
 664             $response = C4::OAI::GetRecord->new( $self, %attr );
 665         }
 666         elsif ( $verb eq 'ListRecords' ) {
 667             $response = C4::OAI::ListRecords->new( $self, %attr );
 668         }
 669         elsif ( $verb eq 'ListIdentifiers' ) {
 670             $response = C4::OAI::ListIdentifiers->new( $self, %attr );
 671         }
 672     }
 673
 674     $response->set_handler( XML::SAX::Writer->new( Output => *STDOUT ) );
 675     $response->generate;
 676
 677     bless $self, $class;
 678     return $self;
 679 }
 680
 681
 682 sub stylesheet {
 683     my ( $self, $format ) = @_;
 684
 685     my $stylesheet = $self->{ koha_stylesheet }->{ $format };
 686     unless ( $stylesheet ) {
 687         my $xsl_file = $self->{ conf }
 688                        ? $self->{ conf }->{ format }->{ $format }->{ xsl_file }
 689                        : ( C4::Context->config('intrahtdocs') .
 690                          '/prog/en/xslt/' .
 691                          C4::Context->preference('marcflavour') .
 692                          'slim2OAIDC.xsl' );
 693         my $parser = XML::LibXML->new();
 694         my $xslt = XML::LibXSLT->new();
 695         my $style_doc = $parser->parse_file( $xsl_file );
 696         $stylesheet = $xslt->parse_stylesheet( $style_doc );
 697         $self->{ koha_stylesheet }->{ $format } = $stylesheet;
 698     }
 699
 700     return $stylesheet;
 701 }
 702
 703
 704
 705 =head1 NAME
 706
 707 C4::OAI::Repository - Handles OAI-PMH requests for a Koha database.
 708
 709 =head1 SYNOPSIS
 710
 711   use C4::OAI::Repository;
 712
 713   my $repository = C4::OAI::Repository->new();
 714
 715 =head1 DESCRIPTION
 716
 717 This object extend HTTP::OAI::Repository object.
 718 It accepts OAI-PMH HTTP requests and returns result.
 719
 720 This OAI-PMH server can operate in a simple mode and extended one.
 721
 722 In simple mode, repository configuration comes entirely from Koha system
 723 preferences (OAI-PMH:archiveID and OAI-PMH:MaxCount) and the server returns
 724 records in marcxml or dublin core format. Dublin core records are created from
 725 koha marcxml records tranformed with XSLT. Used XSL file is located in
 726 koha-tmpl/intranet-tmpl/prog/en/xslt directory and choosed based on marcflavour,
 727 respecively MARC21slim2OAIDC.xsl for MARC21 and  MARC21slim2OAIDC.xsl for
 728 UNIMARC.
 729
 730 In extende mode, it's possible to parameter other format than marcxml or Dublin
 731 Core. A new syspref OAI-PMH:ConfFile specify a YAML configuration file which
 732 list available metadata formats and XSL file used to create them from marcxml
 733 records. If this syspref isn't set, Koha OAI server works in simple mode. A
 734 configuration file koha-oai.conf can look like that:
 735
 736   ---
 737   format:
 738     vs:
 739       metadataPrefix: vs
 740       metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
 741       schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
 742       xsl_file: /usr/local/koha/xslt/vs.xsl
 743     marcxml:
 744       metadataPrefix: marxml
 745       metadataNamespace: http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim
 746       schema: http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
 747     oai_dc:
 748       metadataPrefix: oai_dc
 749       metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
 750       schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
 751       xsl_file: /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl
 752
 753 =cut
 754
 755
 756