|
|
| Line 7: |
Line 7: |
| | ==NAME== | | ==NAME== |
| | EPrints::Apache::SiteMap | | EPrints::Apache::SiteMap |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| | | | |
| | | | |
| Line 20: |
Line 16: |
| | | | |
| | If the static sitemap XML is a sitemapindex, this handler inserts a new <sitemap> element into the index, which directs crawlers to a "sitemap-sc.xml" URL that contains the semantic web sitemap generated by _insert_semantic_web_extensions. This handler also implements the sitemap-sc.xml URL. | | If the static sitemap XML is a sitemapindex, this handler inserts a new <sitemap> element into the index, which directs crawlers to a "sitemap-sc.xml" URL that contains the semantic web sitemap generated by _insert_semantic_web_extensions. This handler also implements the sitemap-sc.xml URL. |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| | | | |
| | | | |
| Line 30: |
Line 22: |
| | <!-- Pod2Wiki=head_methods --> | | <!-- Pod2Wiki=head_methods --> |
| | ==METHODS== | | ==METHODS== |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| | | | |
| | <!-- Pod2Wiki= --> | | <!-- Pod2Wiki= --> |
| Line 41: |
Line 29: |
| | | | |
| | $rc = EPrints::Apache::SiteMap::handler( $r ) | | $rc = EPrints::Apache::SiteMap::handler( $r ) |
| − | Handler for managing EPrints requests for dynamically generated sitemap.xml or sitemap-sc.xml (or returning static version if that exists). =cut ###################################################################### | + | Handler for managing EPrints requests for dynamically generated sitemap.xml or sitemap-sc.xml (or returning static version if that exists). |
| − | | |
| − | sub handler {
| |
| − | my( $r ) = @_;
| |
| − | | |
| − | my $repository = $EPrints::HANDLE->current_repository;
| |
| − | my $xml = $repository->xml;
| |
| − | my $sitemap;
| |
| − |
| |
| − | if ( $r->uri =~ m! sitemap-sc\.xml$ !x )
| |
| − | {
| |
| − | # this is a direct request for the semantic web extensions
| |
| − | $sitemap = _new_urlset( $repository, $xml );
| |
| − | }
| |
| − | else
| |
| − | {
| |
| − | # get the static sitemap.xml
| |
| − | my $langid = EPrints::Session::get_session_language( $repository, $r );
| |
| − | my @static_dirs = $repository->get_static_dirs( $langid );
| |
| − | foreach my $static_dir ( @static_dirs )
| |
| − | {
| |
| − | my $file = "$static_dir/sitemap.xml";
| |
| − | next if( !-e $file );
| |
| − |
| |
| − | $sitemap = $xml->parse_file($file) || EPrints::abort( "Can't parse $file: $!" );
| |
| − | last;
| |
| − | }
| |
| − |
| |
| − | if( !defined $sitemap )
| |
| − | {
| |
| − | # no static sitemap file - create a new document
| |
| − | $sitemap = _new_urlset( $repository, $xml );
| |
| − | }
| |
| − | elsif( $sitemap->documentElement->localname eq "urlset" )
| |
| − | {
| |
| − | # the static sitemap is a <urlset> - append the semantic web extensions to the end
| |
| − | _insert_semantic_web_extensions($repository, $xml, $sitemap->documentElement);
| |
| − | }
| |
| − | elsif( $sitemap->documentElement->localname eq "sitemapindex" )
| |
| − | {
| |
| − | # the static sitemap is a <sitemapindex> - append a semantic web sitemap to the index
| |
| − | my $sw_sitemap = $sitemap->createElement("sitemap");
| |
| − | $sitemap->documentElement->appendChild($sw_sitemap);
| |
| − |
| |
| − | # append the location of the semantic web sitemap
| |
| − | my $sw_loc = $sitemap->createElement("loc");
| |
| − | $sw_sitemap->appendChild($sw_loc);
| |
| − | $sw_loc->appendChild($sitemap->createTextNode($repository->config('base_url')."/sitemap-sc.xml"));
| |
| − | }
| |
| − | }
| |
| − |
| |
| − | # adds local sitemap URLs
| |
| − | if( $sitemap->documentElement->localname eq "urlset" )
| |
| − | {
| |
| − | $repository->run_trigger( EPrints::Const::EP_TRIGGER_LOCAL_SITEMAP_URLS,
| |
| − | urlset => $sitemap->documentElement,
| |
| − | );
| |
| − | } # TODO: else { call some other trigger, with the sitemapindex element }
| |
| − |
| |
| − | binmode( *STDOUT, ":utf8" );
| |
| − | $repository->send_http_header( "content_type"=>"text/xml; charset=UTF-8" );
| |
| − | print $xml->to_string( $sitemap );
| |
| − | return DONE; }
| |
| − |
| |
| − | # # Creates a new XML document containing a urlset populated # by _insert_semantic_web_extensions #
| |
| − | sub _new_urlset {
| |
| − | my( $repository, $xml ) = @_;
| |
| − | | |
| − | my $document = $xml->make_document();
| |
| − | my $urlset = $xml->create_element(
| |
| − | "urlset",
| |
| − | "xmlns" => "http://www.sitemaps.org/schemas/sitemap/0.9"
| |
| − | );
| |
| − | _insert_semantic_web_extensions( $repository, $xml, $urlset );
| |
| − | $document->appendChild( $urlset );
| |
| − |
| |
| − | return $document; }
| |
| − |
| |
| − | # # Insert the semantic web extensions as children of the element given as the # third argument to the function. This function contains the body of the main # handler shipped with EPrints 3.2.x #
| |
| − | sub _insert_semantic_web_extensions {
| |
| − | my ( $repository, $xml, $urlset ) = @_;
| |
| − | | |
| − | $urlset->setAttribute( "xmlns:sc" , "http://sw.deri.org/2007/07/sitemapextension/scschema.xsd" );
| |
| − |
| |
| − | my $sc_dataset = $xml->create_element( "sc:dataset" );
| |
| − |
| |
| − | $urlset->appendChild( $sc_dataset );
| |
| − | $sc_dataset->appendChild( _create_data( $xml,
| |
| − | "sc:linkedDataPrefix",
| |
| − | $repository->config( 'base_url' )."/id/",
| |
| − | slicing => "subject-object", ));
| |
| − | $sc_dataset->appendChild( _create_data( $xml,
| |
| − | "sc:datasetURI",
| |
| − | $repository->config( 'base_url' )."/id/repository" ));
| |
| − |
| |
| − |
| |
| − | $sc_dataset->appendChild( _create_data( $xml,
| |
| − | "sc:dataDumpLocation",
| |
| − | $repository->config( 'base_url' )."/id/repository" ));
| |
| − | $sc_dataset->appendChild( _create_data( $xml,
| |
| − | "sc:dataDumpLocation",
| |
| − | $repository->config( 'base_url' )."/id/dump" ));
| |
| − |
| |
| − | my $root_subject = $repository->dataset("subject")->dataobj("ROOT");
| |
| − | foreach my $top_subject ( $root_subject->get_children )
| |
| − | {
| |
| − | $sc_dataset->appendChild( _create_data( $xml,
| |
| − | "sc:dataDumpLocation",
| |
| − | $top_subject->uri ) );
| |
| − | } }
| |
| − |
| |
| − | sub _create_data {
| |
| − | my( $xml, $name, $data, %attr ) = @_;
| |
| − | | |
| − | my $node = $xml->create_element( $name, %attr );
| |
| − | $node->appendChild( $xml->create_text_node( $data ));
| |
| − |
| |
| − | return $node; }
| |
| − |
| |
| − | 1;
| |
| − | | |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| | | | |
| | | | |
| Line 171: |
Line 36: |
| | <!-- Pod2Wiki=head_copyright --> | | <!-- Pod2Wiki=head_copyright --> |
| | ==COPYRIGHT== | | ==COPYRIGHT== |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| | | | |
| | <!-- Pod2Wiki= --> | | <!-- Pod2Wiki= --> |
| | </div> | | </div> |
| | <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> | | <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> |
