/usr/share/perl5/RDF/LinkedData.pm is in librdf-linkeddata-perl 0.74-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 | package RDF::LinkedData;
use strict;
use warnings;
use Moo;
use namespace::autoclean;
use Types::Standard qw(InstanceOf Str Bool Maybe Int HashRef);
use RDF::Trine qw[iri literal blank statement variable];
use RDF::Trine::Serializer;
use RDF::Trine::Namespace;
use Log::Log4perl qw(:easy);
use Plack::Response;
use RDF::Helper::Properties;
use URI::NamespaceMap;
use URI;
use HTTP::Headers;
use Module::Load::Conditional qw[can_load];
use Encode;
use RDF::RDFa::Generator 0.102;
use HTML::HTML5::Writer qw(DOCTYPE_XHTML_RDFA);
use Data::Dumper;
use Digest::MD5 ('md5_base64');
use Carp;
use Try::Tiny;
use List::Util qw(any);
use Log::Log4perl;
use Log::Log4perl ':easy';
use Log::Contextual qw( :log ), -package_logger => Log::Log4perl->get_logger;
BEGIN {
if ($ENV{TEST_VERBOSE}) {
Log::Log4perl->easy_init( { level => $TRACE,
category => 'RDF.LinkedData'
} );
} else {
Log::Log4perl->easy_init( { level => $FATAL,
category => 'RDF.LinkedData'
} );
}
use Log::Contextual -logger => Log::Log4perl->get_logger;
}
=head1 NAME
RDF::LinkedData - A Linked Data server implementation
=head1 VERSION
Version 0.74
=cut
our $VERSION = '0.74';
=head1 SYNOPSIS
For just setting this up and get it to run, you would just use the
C<linked_data.psgi> script in this distribution. The usage of that is
documented in L<Plack::App::RDF::LinkedData>, with the README is a
quick start guide. If you want to try and use this directly, you'd do
stuff like:
my $ld = RDF::LinkedData->new(store => $config->{store},
endpoint_config => $config->{endpoint},
base_uri => $config->{base_uri}
);
$ld->namespaces($config->{namespaces}) if ($config->{namespaces});
$ld->request($req);
return $ld->response($uri)->finalize;
See L<Plack::App::RDF::LinkedData> for a complete example.
=head1 DESCRIPTION
This module is used to create a Linked Data server that can
serve RDF data out of an L<RDF::Trine::Model>. It will look up URIs in
the model and do the right thing (known as the 303 dance) and mint
URLs for that, as well as content negotiation. Thus, you can
concentrate on URIs for your things, you need not be concerned about
minting URLs for the pages to serve it. In addition, optional modules
can provide other important functionalities: Cross-origin resource
sharing, VoID description, cache headers, SPARQL Endpoint, Triple
Pattern Fragments, etc. As such, it encompasses a fair share of
Semantic Web best practices, but possibly not in a very flexible Big
Data manner.
=head1 METHODS
=over
=item C<< new ( store => $store, model => $model, base_uri => $base_uri,
hypermedia => 1, namespaces_as_vocabularies => 1,
request => $request, endpoint_config => $endpoint_config,
void_config => $void_config ) >>
Creates a new handler object based on named parameters, given a store
config (recommended usage is to pass a hashref of the type that can be
passed to L<RDF::Trine::Store>->new_with_config, but a simple string
can also be used) or model and a base URI. Optionally, you may pass a
L<Plack::Request> object (must be passed before you call C<content>)
and an C<endpoint_config> hashref if you want to have a SPARQL
Endpoint running using the recommended module L<RDF::Endpoint>.
This module can also provide additional triples to turn the response
into a hypermedia type. If you don't want this, set the C<hypermedia>
argument to false. Currently this entails setting the SPARQL endpoint
and vocabularies used using the L<VoID vocabulary|http://vocab.deri.ie/void>.
Finally, it can provide experimental L<Triple Pattern
Fragments|http://www.hydra-cg.com/spec/latest/triple-pattern-fragments/>
support.
=item C<< BUILD >>
Called by Moo to initialize an object.
=cut
sub BUILD {
my $self = shift;
# A model will be passed or built by the _build_model, so we can check directly if we have one
unless ($self->model->isa('RDF::Trine::Model')) {
throw Error -text => "No valid RDF::Trine::Model, need either a store config hashref or a model.";
}
if ($self->has_endpoint_config) {
log_debug {'Endpoint config found with parameters: ' . Dumper($self->endpoint_config) };
unless (can_load( modules => { 'RDF::Endpoint' => 0.03 })) {
throw Error -text => "RDF::Endpoint not installed. Please install or remove its configuration.";
}
unless (defined($self->endpoint_config->{endpoint_path})) {
$self->endpoint_config->{endpoint_path} = '/sparql';
}
$self->endpoint(RDF::Endpoint->new($self->model, $self->endpoint_config));
} else {
log_info {'No endpoint config found'};
}
if ($self->has_void_config) {
log_debug {'VoID config found with parameters: ' . Dumper($self->void_config) };
unless (can_load( modules => { 'RDF::Generator::Void' => 0.04 })) {
throw Error -text => "RDF::Generator::Void not installed. Please install or remove its configuration.";
}
my $dataset_uri = (defined($self->void_config->{dataset_uri}))
? $self->void_config->{dataset_uri}
: URI->new($self->base_uri . '#dataset-0')->canonical;
$self->_last_extvoid_mtime(0);
$self->void(RDF::Generator::Void->new(inmodel => $self->model,
dataset_uri => $dataset_uri,
namespaces_as_vocabularies => $self->void_config->{namespaces_as_vocabularies}));
if ($self->has_fragments) {
log_debug {'Triple Pattern Fragments config found with parameters: ' . Dumper($self->fragments_config) };
}
} else {
log_info {'No VoID config found'};
}
}
=item C<< BUILDARGS >>
Called by Moo to ensure that some attributes can be left unset.
=cut
around BUILDARGS => sub
{
my ($next, $self) = (shift, shift);
my $args = $self->$next(@_);
for (keys %$args) {
delete $args->{$_} if not defined $args->{$_};
}
return $args;
};
has store => (is => 'rw', isa => HashRef | Str );
=item C<< model >>
Returns the RDF::Trine::Model object.
=cut
has model => (is => 'ro', isa => InstanceOf['RDF::Trine::Model'], lazy => 1, builder => '_build_model',
handles => { current_etag => 'etag' });
sub _build_model {
my $self = shift;
return $self->_load_model($self->store);
}
sub _load_model {
my ($self, $store_config) = @_;
# First, set the base if none is configured
my $i = 0;
if (ref($store_config) eq 'HASH') {
foreach my $source (@{$store_config->{sources}}) {
unless ($source->{base_uri}) {
${$store_config->{sources}}[$i]->{base_uri} = $self->base_uri;
}
$i++;
}
}
my $store = RDF::Trine::Store->new( $store_config );
return RDF::Trine::Model->new( $store );
}
=item C<< base_uri >>
Returns or sets the base URI for this handler.
=cut
has base_uri => (is => 'rw', isa => Str, default => '' );
has hypermedia => (is => 'ro', isa => Bool, default => 1);
has namespaces_as_vocabularies => (is => 'ro', isa => Bool, default => 1);
has endpoint_config => (is => 'rw', isa=>Maybe[HashRef], predicate => 'has_endpoint_config');
has void_config => (is => 'rw', isa=>Maybe[HashRef], predicate => 'has_void_config');
has fragments_config => (is => 'rw', isa=>Maybe[HashRef], predicate => 'has_fragments');
=item C<< request ( [ $request ] ) >>
Returns the L<Plack::Request> object if it exists or sets it if a L<Plack::Request> object is given as parameter.
=cut
has request => ( is => 'rw', isa => InstanceOf['Plack::Request']);
=item C<< current_etag >>
Returns the current Etag of the model suitable for use in a HTTP header. This is a read-only attribute.
=item C<< last_etag >>, C<< has_last_etag >>
Returns or sets the last Etag of so that changes to the model can be detected.
=cut
has last_etag => ( is => 'rw', isa => Str, predicate => 'has_last_etag');
=item namespaces ( { skos => 'http://www.w3.org/2004/02/skos/core#', dct => 'http://purl.org/dc/terms/' } )
Gets or sets the namespaces that some serializers use for pretty-printing.
=cut
has 'namespaces' => (is => 'rw',
isa => InstanceOf['URI::NamespaceMap'],
builder => '_build_namespaces',
lazy => 1,
handles => {
'add_namespace_mapping' => 'add_mapping',
'list_namespaces' => 'list_namespaces'
});
sub _build_namespaces {
my ($self, $ns_hash) = @_;
return $ns_hash || URI::NamespaceMap->new({ rdf => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' });
}
# Just a temporary compatibility hack
sub _namespace_hashref {
my $self = shift;
my %hash;
foreach my $prefix ($self->namespaces->list_prefixes) {
$hash{$prefix} = $self->namespaces->namespace_uri($prefix)->as_string;
}
return \%hash;
}
=item C<< response ( $uri ) >>
Will look up what to do with the given URI object and populate the
response object.
=cut
sub response {
my $self = shift;
my $uri = URI->new(shift);
my $response = Plack::Response->new;
my $headers_in = $self->request->headers;
my $server = "RDF::LinkedData/$VERSION";
$server .= " " . $response->headers->header('Server') if defined($response->headers->header('Server'));
$response->headers->header('Server' => $server);
my $endpoint_path;
if ($self->has_endpoint) {
$endpoint_path = $self->endpoint_config->{endpoint_path};
if ($uri->path eq $endpoint_path) {
return $self->endpoint->run( $self->request );
}
}
if ($self->has_fragments && ($uri->path eq $self->fragments_config->{fragments_path})) {
croak 'A VoID description is needed when using Triple Pattern Fragments' unless ($self->has_void);
# First compute the selectors from the query parameters
my %params = $uri->query_form;
my %statement = (subject => undef,
predicate => undef,
object => undef);
foreach my $term (keys(%statement)) {
my $value = $params{$term};
next unless $value;
return _client_error($response, "$term is invalid") if ref($value); # E.g. an array would be invalid
if ($value =~ m/^\?(\S+)$/) { # Regexp matching variable
$statement{$term} = variable($1);
} elsif (($term eq 'object') && ($value =~ m/^\"(.+)\"((\@|\^\^)(\S+))?$/)) { # regexp matching literal
my $string = $1;
my $lang_or_datatype = $3;
my $rest = $4;
if (defined($lang_or_datatype) && ($lang_or_datatype eq '@')) {
$statement{$term} = literal($string, $rest);
} else {
$statement{$term} = literal($string, undef, $rest);
}
} else { # Now, it may be an IRI
try {
$statement{$term} = iri($value);
} catch {
return _client_error($response, 'Was not able to parse subject as a IRI');
}
}
}
log_debug {'Getting fragment with this selector ' . Dumper(\%statement) };
return _client_error($response, 'Returning the whole database not allowed')
unless $self->fragments_config->{allow_dump_dataset} || any { defined } values(%statement);
my $output_model = $self->_common_fragments_control;
my $iterator = $self->model->get_statements($statement{subject}, $statement{predicate}, $statement{object});
$output_model->begin_bulk_ops;
my $counter = 0;
while (my $st = $iterator->next) {
$counter++;
# TODO: Paging goes here
$output_model->add_statement($st);
}
$self->add_namespace_mapping(void => 'http://rdfs.org/ns/void#');
$self->add_namespace_mapping(hydra => 'http://www.w3.org/ns/hydra/core#');
my $cl = literal($counter, undef, 'http://www.w3.org/2001/XMLSchema#integer');
my $void = RDF::Trine::Namespace->new('http://rdfs.org/ns/void#');
$output_model->add_statement(statement(iri($uri),
$void->triples,
$cl));
$output_model->add_statement(statement(iri($uri),
iri('http://www.w3.org/ns/hydra/core#totalItems'),
$cl));
$output_model->add_statement(statement(iri($uri),
iri('http://www.w3.org/1999/02/22-rdf-syntax-ns#type'),
$void->Dataset));
$output_model->add_statement(statement($self->void->dataset_uri,
$void->subset,
iri($uri)));
$output_model->add_statement(statement(iri($uri),
iri('http://purl.org/dc/terms/source'),
$self->void->dataset_uri
));
$output_model->end_bulk_ops;
my ($ct, $s);
try {
($ct, $s) = RDF::Trine::Serializer->negotiate('request_headers' => $headers_in,
base_uri => $self->base_uri,
namespaces => $self->_namespace_hashref);
} catch {
$response->status(406);
$response->headers->content_type('text/plain');
$response->body('HTTP 406: No serialization available any specified content type');
return $response;
};
$response->status(200);
$response->headers->header('Vary' => join(", ", qw(Accept)));
if ($self->has_last_etag) {
$response->headers->header('ETag' => '"' . md5_base64($self->last_etag . $ct) . '"');
}
my $body = $s->serialize_model_to_string($output_model);
log_trace { "Fragment message body is $body" };
$response->headers->content_type($ct);
$response->body(encode_utf8($body));
return $response;
}
if ($self->has_void) {
my $void_resp = $self->_void_content($uri, $endpoint_path);
return $void_resp if (defined($void_resp));
}
my $type = $self->type;
$self->type('');
my $node = $self->my_node($uri);
log_info{"Try rendering '$type' page for subject node: " . $node->as_string};
if ($self->count($node) > 0) {
if ($type) {
my $preds = $self->helper_properties;
my $page = $preds->page($node);
if (($type eq 'page') && ($page ne $node->uri_value . '/page')) {
# Then, we have a foaf:page set that we should redirect to
$response->status(301);
$response->headers->header('Location' => $page);
return $response;
}
log_debug {"Will render '$type' page " };
if ($headers_in->can('header') && $headers_in->header('Accept')) {
log_debug {'Found Accept header: ' . $headers_in->header('Accept') };
} else {
$headers_in->header('Accept' => 'application/rdf+xml');
if ($headers_in->header('Accept')) {
log_warn { 'Setting Accept header: ' . $headers_in->header('Accept') };
} else {
log_warn { 'No content type header can be set' };
}
}
$response->status(200);
my $content = $self->_content($node, $type, $endpoint_path);
$response->headers->header('Vary' => join(", ", qw(Accept)));
if (defined($self->current_etag)) {
$response->headers->header('ETag' => '"' . md5_base64($self->current_etag . $content->{content_type}) . '"');
}
$response->headers->content_type($content->{content_type});
$response->body(encode_utf8($content->{body}));
} else {
$response->status(303);
my ($ct, $s) = $self->_negotiate($headers_in);
return $ct if ($ct->isa('Plack::Response')); # A hack to allow for the failed conneg case
my $newurl = $uri . '/data';
unless ($s->isa('RDF::Trine::Serializer')) {
my $preds = $self->helper_properties;
$newurl = $preds->page($node);
}
log_debug {'Will do a 303 redirect to ' . $newurl };
$response->headers->header('Location' => $newurl);
$response->headers->header('Vary' => join(", ", qw(Accept)));
}
return $response;
} else {
$response->status(404);
$response->headers->content_type('text/plain');
$response->body('HTTP 404: Unknown resource');
return $response;
}
# We should never get here.
$response->status(500);
$response->headers->content_type('text/plain');
$response->body('HTTP 500: No such functionality.');
return $response;
}
sub _client_error {
my ($response, $msg) = @_;
$response->status(400);
$response->headers->content_type('text/plain');
$response->body("HTTP 400: $msg");
return $response;
}
=item C<< helper_properties ( ) >>
Returns the L<RDF::Helper::Properties> object if it exists or sets
it if a L<RDF::Helper::Properties> object is given as parameter.
=cut
has helper_properties => ( is => 'rw', isa => InstanceOf['RDF::Helper::Properties'], lazy => 1, builder => '_build_helper_properties');
sub _build_helper_properties {
my $self = shift;
return RDF::Helper::Properties->new(model => $self->model);
}
=item C<< type >>
Returns or sets the type of result to return, i.e. C<page>, in the case of a human-intended page or C<data> for machine consumption, or an empty string if it is an actual resource URI that should be redirected.
=cut
has 'type' => (is => 'rw', isa => Str, default => '');
=item C<< my_node >>
A node for the requested URI. This node is typically used as the
subject to find which statements to return as data. This expects to
get a URI object containing the full URI of the node.
=cut
sub my_node {
my ($self, $iri) = @_;
log_info { "Subject URI to be used: $iri" };
return RDF::Trine::Node::Resource->new( $iri );
}
=item C<< count ( $node) >>
Returns the number of statements that has the $node as subject, or all if $node is undef.
=cut
sub count {
my $self = shift;
my $node = shift;
return $self->model->count_statements( $node, undef, undef );
}
# =item C<< _content ( $node, $type, $endpoint_path) >>
#
# Private method to return the a hashref with content for this URI,
# based on the $node subject, and the type of node, which may be either
# C<data> or C<page>. In the first case, an RDF document serialized to a
# format set by content negotiation. In the latter, a simple HTML
# document will be returned. Finally, you may pass the endpoint path if
# it is available. The returned hashref has two keys: C<content_type>
# and C<body>. The former is self-explanatory, the latter contains the
# actual content.
sub _content {
my ($self, $node, $type, $endpoint_path) = @_;
my $model = $self->model;
my $iter = $model->bounded_description($node);
my %output;
if ($type eq 'data') {
$self->{_type} = 'data';
my ($ctype, $s) = RDF::Trine::Serializer->negotiate('request_headers' => $self->request->headers,
base => $self->base_uri,
namespaces => $self->_namespace_hashref);
$output{content_type} = $ctype;
if ($self->hypermedia) {
my $data_iri = iri($node->uri_value . '/data');
my $hmmodel = RDF::Trine::Model->temporary_model;
if($self->has_void) {
$hmmodel->add_statement(statement($data_iri,
iri('http://rdfs.org/ns/void#inDataset'),
$self->void->dataset_uri));
} else {
if($self->has_endpoint) {
$hmmodel->add_statement(statement($data_iri,
iri('http://rdfs.org/ns/void#inDataset'),
blank('void')));
$hmmodel->add_statement(statement(blank('void'),
iri('http://rdfs.org/ns/void#sparqlEndpoint'),
iri($self->base_uri . $endpoint_path)));
}
if($self->namespaces_as_vocabularies) {
$hmmodel->add_statement(statement($data_iri,
iri('http://rdfs.org/ns/void#inDataset'),
blank('void')));
foreach my $nsuri ($self->list_namespaces) {
$hmmodel->add_statement(statement(blank('void'),
iri('http://rdfs.org/ns/void#vocabulary'),
iri($nsuri->uri)));
}
}
}
$iter = $iter->concat($hmmodel->as_stream);
}
$output{body} = $s->serialize_iterator_to_string ( $iter );
log_trace { "Message body is $output{body}" };
} else {
$self->{_type} = 'page';
my $returnmodel = RDF::Trine::Model->temporary_model;
while (my $st = $iter->next) {
$returnmodel->add_statement($st);
}
my $preds = $self->helper_properties;
my $gen = RDF::RDFa::Generator->new( style => 'HTML::Pretty',
title => $preds->title( $node ),
base => $self->base_uri,
namespaces => $self->_namespace_hashref);
my $writer = HTML::HTML5::Writer->new( charset => 'ascii', markup => 'html' );
$output{body} = $writer->document($gen->create_document($returnmodel));
$output{content_type} = 'text/html';
}
return \%output;
}
=item C<< endpoint ( [ $endpoint ] ) >>
Returns the L<RDF::Endpoint> object if it exists or sets it if a
L<RDF::Endpoint> object is given as parameter. In most cases, it will
be created for you if you pass a C<endpoint_config> hashref to the
constructor, so you would most likely not use this method.
=cut
has endpoint => (is => 'rw', isa => InstanceOf['RDF::Endpoint'], predicate => 'has_endpoint');
=item C<< void ( [ $voidg ] ) >>
Returns the L<RDF::Generator::Void> object if it exists or sets it if
a L<RDF::Generator::Void> object is given as parameter. Like
C<endpoint>, it will be created for you if you pass a C<void_config>
hashref to the constructor, so you would most likely not use this
method.
=cut
has void => (is => 'rw', isa => InstanceOf['RDF::Generator::Void'], predicate => 'has_void');
sub _negotiate {
my ($self, $headers_in) = @_;
my ($ct, $s);
eval {
($ct, $s) = RDF::Trine::Serializer->negotiate('request_headers' => $headers_in,
base_uri => $self->base_uri,
namespaces => $self->_namespace_hashref,
extend => {
'text/html' => 'html',
'application/xhtml+xml' => 'xhtml'
}
);
log_debug { "Got $ct content type" };
1;
} or do {
my $response = Plack::Response->new;
$response->status(406);
$response->headers->content_type('text/plain');
$response->body('HTTP 406: No serialization available any specified content type');
return $response;
};
return ($ct, $s)
}
sub _void_content {
my ($self, $uri, $endpoint_path) = @_;
my $generator = $self->void;
my $dataset_uri = URI->new($generator->dataset_uri);
my $fragment = $dataset_uri->fragment;
$dataset_uri =~ s/(\#$fragment)$//;
if ($uri->eq($dataset_uri)) {
# First check if the model has changed, the etag will have
# changed, and we will have to regenerate at some point. If
# there is no current etag, we clear anyway
if ((! defined($self->current_etag)) || ($self->has_last_etag && ($self->last_etag ne $self->current_etag))) {
$self->_clear_voidmodel;
}
# First see if we should read some static stuff from file
my $file_model = undef;
if ($self->void_config->{add_void}) {
$self->_current_extvoid_mtime((stat($self->void_config->{add_void}->{file}))[9]);
if ($self->_current_extvoid_mtime != $self->_last_extvoid_mtime) {
$self->_clear_voidmodel;
$file_model = RDF::Trine::Model->temporary_model;
my $parser = RDF::Trine::Parser->new($self->void_config->{add_void}->{syntax});
$parser->parse_file_into_model($self->base_uri, $self->void_config->{add_void}->{file}, $file_model);
$self->_last_extvoid_mtime((stat($self->void_config->{add_void}->{file}))[9]);
}
}
# Now really regenerate if there is no model now
unless ($self->_has_voidmodel) {
# Use the methods of the generator to add stuff from config, etc
if ($self->void_config->{urispace}) {
$generator->urispace($self->void_config->{urispace});
} else {
$generator->urispace($self->base_uri);
}
if ($self->namespaces_as_vocabularies) {
foreach my $nsuri ($self->list_namespaces) {
$generator->add_vocabularies($nsuri->as_string); # TODO: Should be fixed in RDF::Generator::Void, but we fix it here for now
}
}
if ($self->has_endpoint) {
$generator->add_endpoints($self->base_uri . $endpoint_path);
}
if ($self->void_config->{licenses}) {
$generator->add_licenses($self->void_config->{licenses});
}
foreach my $title (@{$self->void_config->{titles}}) {
$generator->add_titles(literal(@{$title}));
}
if ($self->void_config->{endpoints}) {
$generator->add_endpoints($self->void_config->{endpoints});
}
if ($self->void_config->{vocabularies}) {
$generator->add_vocabularies($self->void_config->{vocabularies});
}
# Do the stats and statements
$self->_voidmodel($generator->generate($file_model));
$self->last_etag($self->current_etag);
}
if ($self->has_fragments) {
$self->add_namespace_mapping(hydra => 'http://www.w3.org/ns/hydra/core#');
$self->_common_fragments_control($self->_voidmodel);
}
# Now start serializing.
my ($ct, $s) = $self->_negotiate($self->request->headers);
return $ct if ($ct->isa('Plack::Response')); # A hack to allow for the failed conneg case
my $body;
if ($s->isa('RDF::Trine::Serializer')) { # Then we just serialize since we have a serializer.
$body = $s->serialize_model_to_string($self->_voidmodel);
} else {
# For (X)HTML, we need to do extra work
my $gen = RDF::RDFa::Generator->new( style => 'HTML::Pretty',
title => $self->void_config->{pagetitle} || 'VoID Description',
base => $self->base_uri,
namespaces => $self->_namespace_hashref);
my $markup = ($ct eq 'application/xhtml+xml') ? 'xhtml' : 'html';
my $writer = HTML::HTML5::Writer->new( charset => 'ascii', markup => $markup );
$body = $writer->document($gen->create_document($self->_voidmodel));
}
my $response = Plack::Response->new;
$response->status(200);
$response->headers->header('Vary' => join(", ", qw(Accept)));
my $etag;
$etag = $self->_last_extvoid_mtime if ($self->void_config->{add_void});
$etag .= $self->last_etag if (defined($self->last_etag));
if ($etag) {
$response->headers->header('ETag' => '"' . md5_base64($etag . $ct) . '"');
}
$response->headers->content_type($ct);
$response->body(encode_utf8($body));
return $response;
} else {
return;
}
}
has _voidmodel => (is => 'rw', isa => InstanceOf['RDF::Trine::Model'], predicate => '_has_voidmodel', clearer => '_clear_voidmodel');
has _current_extvoid_mtime => (is => 'rw', isa => Int);
has _last_extvoid_mtime => (is => 'rw', isa => Int);
sub _common_fragments_control {
my $self = shift;
my $model = shift || RDF::Trine::Model->temporary_model;
my $void = RDF::Trine::Namespace->new('http://rdfs.org/ns/void#');
my $xsd = RDF::Trine::Namespace->new('http://www.w3.org/2001/XMLSchema#');
my $hydra = RDF::Trine::Namespace->new('http://www.w3.org/ns/hydra/core#');
my $rdf = RDF::Trine::Namespace->new('http://www.w3.org/1999/02/22-rdf-syntax-ns#');
$model->begin_bulk_ops;
my $void_subject = $self->void->dataset_uri;
$model->add_statement(statement($void_subject,
$rdf->type,
$hydra->Collection));
$model->add_statement(statement($void_subject,
$rdf->type,
$void->Dataset));
$model->add_statement(statement($void_subject,
$hydra->search,
blank('template')));
$model->add_statement(statement($void_subject,
$void->uriLookupEndpoint,
literal($self->base_uri . $self->fragments_config->{fragments_path}
. '{?subject,predicate,object}')));
$model->add_statement(statement(blank('template'),
$hydra->template,
literal($self->base_uri . $self->fragments_config->{fragments_path}
. '{?subject,predicate,object}')));
$model->add_statement(statement(blank('template'),
$hydra->mapping,
blank('subject')));
$model->add_statement(statement(blank('template'),
$hydra->mapping,
blank('predicate')));
$model->add_statement(statement(blank('template'),
$hydra->mapping,
blank('object')));
$model->add_statement(statement(blank('subject'),
$hydra->property,
$rdf->subject));
$model->add_statement(statement(blank('subject'),
$hydra->variable,
literal('subject')));
$model->add_statement(statement(blank('predicate'),
$hydra->property,
$rdf->predicate));
$model->add_statement(statement(blank('predicate'),
$hydra->variable,
literal('predicate')));
$model->add_statement(statement(blank('object'),
$hydra->property,
$rdf->object));
$model->add_statement(statement(blank('object'),
$hydra->variable,
literal('object')));
$model->end_bulk_ops;
return $model;
}
=back
=head1 AUTHOR
Kjetil Kjernsmo, C<< <kjetilk@cpan.org> >>
=head1 CONTRIBUTORS
Toby Inkster
=head1 BUGS
Please report any bugs using L<github|https://github.com/kjetilk/RDF-LinkedData/issues>
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc RDF::LinkedData
The perlrdf mailing list is the right place to seek help and discuss this module:
L<http://lists.perlrdf.org/listinfo/dev>
=head1 TODO
=over
=item * Use L<IO::Handle> streams when they become available from the serializers.
=item * Figure out what needs to be done to use this code in other frameworks, such as Magpie.
=item * Make it read-write hypermedia.
=item * Make the result graph configurable.
=back
=head1 ACKNOWLEDGEMENTS
This module was started by Gregory Todd Williams C<<
<gwilliams@cpan.org> >> for L<RDF::LinkedData::Apache>, but has been
almost totally rewritten.
=head1 COPYRIGHT & LICENSE
Copyright 2010 Gregory Todd Williams
Copyright 2010 ABC Startsiden AS
Copyright 2010, 2011, 2012, 2013, 2014, 2015 Kjetil Kjernsmo
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1;
|