[openguides-commits] r653 - trunk/lib/OpenGuides

Author: earle Date: 2005-06-15 13:23:52 +0100 (Wed, 15 Jun 2005) New Revision: 653

Modified: trunk/lib/OpenGuides/RDF.pm Log: RSS timestamp

Modified: trunk/lib/OpenGuides/RDF.pm =================================================================== --- trunk/lib/OpenGuides/RDF.pm 2005-06-15 11:57:30 UTC (rev 652) +++ trunk/lib/OpenGuides/RDF.pm 2005-06-15 12:23:52 UTC (rev 653) @@ -10,226 +10,221 @@ use URI::Escape; use Carp 'croak';

-sub new -{ - my ($class, @args) = @_; - my $self = {}; - bless $self, $class; - $self->_init(@args); +sub new { + my ($class, @args) = @_; + my $self = {}; + bless $self, $class; + $self->_init(@args); }

-sub _init -{ - my ($self, %args) = @_; +sub _init { + my ($self, %args) = @_;

- my $wiki = $args{wiki}; - - unless ($wiki && UNIVERSAL::isa($wiki, "CGI::Wiki")) - { - croak "No CGI::Wiki object supplied."; - } - $self->{wiki} = $wiki; + my $wiki = $args{wiki}; + + unless ($wiki && UNIVERSAL::isa($wiki, "CGI::Wiki")) + { + croak "No CGI::Wiki object supplied."; + } + $self->{wiki} = $wiki;

- my $config = $args{config}; - unless ($config && UNIVERSAL::isa($config, "OpenGuides::Config")) - { - croak "No OpenGuides::Config object supplied."; - } - $self->{config} = $config; - - $self->{make_node_url} = - sub + my $config = $args{config}; + unless ($config && UNIVERSAL::isa($config, "OpenGuides::Config")) { - my ($node_name, $version) = @_; + croak "No OpenGuides::Config object supplied."; + } + $self->{config} = $config;

- my $config = $self->{config}; - - my $node_url = $config->script_url . uri_escape($config->script_name) . '?'; - $node_url .= 'id=' if defined $version; - $node_url .= uri_escape($self->{wiki}->formatter->node_name_to_node_param($node_name)); - $node_url .= '&version=' . uri_escape($version) if defined $version; + $self->{make_node_url} = + sub + { + my ($node_name, $version) = @_;

- $node_url; - }; - $self->{site_name} = $config->site_name; - $self->{default_city} = $config->default_city || ""; - $self->{default_country} = $config->default_country || ""; - $self->{site_description} = $config->site_desc || ""; + my $config = $self->{config}; + + my $node_url = $config->script_url . uri_escape($config->script_name) . '?'; + $node_url .= 'id=' if defined $version; + $node_url .= uri_escape($self->{wiki}->formatter->node_name_to_node_param($node_name)); + $node_url .= '&version=' . uri_escape($version) if defined $version;

- $self; + $node_url; + }; + $self->{site_name} = $config->site_name; + $self->{default_city} = $config->default_city || ""; + $self->{default_country} = $config->default_country || ""; + $self->{site_description} = $config->site_desc || ""; + + $self; }

-sub emit_rdfxml -{ - my ($self, %args) = @_; +sub emit_rdfxml { + my ($self, %args) = @_;

- my $node_name = $args{node}; - my $wiki = $self->{wiki}; + my $node_name = $args{node}; + my $wiki = $self->{wiki};

- my %node_data = $wiki->retrieve_node( $node_name ); - my $phone = $node_data{metadata}{phone}[0] || ''; - my $fax = $node_data{metadata}{fax}[0] || ''; - my $website = $node_data{metadata}{website}[0] || ''; - my $opening_hours_text = $node_data{metadata}{opening_hours_text}[0] || ''; - my $postcode = $node_data{metadata}{postcode}[0] || ''; - my $city = $node_data{metadata}{city}[0] || $self->{default_city}; - my $country = $node_data{metadata}{country}[0] || $self->{default_country}; - my $latitude = $node_data{metadata}{latitude}[0] || ''; - my $longitude = $node_data{metadata}{longitude}[0] || ''; - my $version = $node_data{version}; - my $username = $node_data{metadata}{username}[0] || ''; - my $os_x = $node_data{metadata}{os_x}[0] || ''; - my $os_y = $node_data{metadata}{os_y}[0] || ''; - my $catrefs = $node_data{metadata}{category}; - my @locales = @{ $node_data{metadata}{locale} || [] }; + my %node_data = $wiki->retrieve_node($node_name); + my $phone = $node_data{metadata}{phone}[0] || ''; + my $fax = $node_data{metadata}{fax}[0] || ''; + my $website = $node_data{metadata}{website}[0] || ''; + my $opening_hours_text = $node_data{metadata}{opening_hours_text}[0] || ''; + my $postcode = $node_data{metadata}{postcode}[0] || ''; + my $city = $node_data{metadata}{city}[0] || $self->{default_city}; + my $country = $node_data{metadata}{country}[0] || $self->{default_country}; + my $latitude = $node_data{metadata}{latitude}[0] || ''; + my $longitude = $node_data{metadata}{longitude}[0] || ''; + my $version = $node_data{version}; + my $username = $node_data{metadata}{username}[0] || ''; + my $os_x = $node_data{metadata}{os_x}[0] || ''; + my $os_y = $node_data{metadata}{os_y}[0] || ''; + my $catrefs = $node_data{metadata}{category}; + my @locales = @{ $node_data{metadata}{locale} || [] };

- # replace any errant characters in data to prevent illegal XML - foreach ($phone, $fax, $website, $opening_hours_text, $postcode, $city, $country, - $latitude, $longitude, $version, $os_x, $os_y, $catrefs, @locales) - { - if ($_) + # replace any errant characters in data to prevent illegal XML + foreach ($phone, $fax, $website, $opening_hours_text, $postcode, $city, $country, + $latitude, $longitude, $version, $os_x, $os_y, $catrefs, @locales) { - $_ =~ s/&/&amp;/g; - $_ =~ s/</&lt;/g; - $_ =~ s/>/&gt;/g; + if ($_) + { + $_ =~ s/&/&amp;/g; + $_ =~ s/</&lt;/g; + $_ =~ s/>/&gt;/g; + } } - } - - my ($is_geospatial, $objType); + + my ($is_geospatial, $objType);

- if ($latitude || $longitude || $postcode || @locales) - { - $is_geospatial = 1; - $objType = 'geo:SpatialThing'; - } - else - { - $objType = 'rdf:Description'; - } + if ($latitude || $longitude || $postcode || @locales) + { + $is_geospatial = 1; + $objType = 'geo:SpatialThing'; + } + else + { + $objType = 'rdf:Description'; + }

- my $timestamp = $node_data{last_modified}; - # Make a Time::Piece object. - my $timestamp_fmt = $CGI::Wiki::Store::Database::timestamp_fmt; + my $timestamp = $node_data{last_modified}; + + # Make a Time::Piece object. + my $timestamp_fmt = $CGI::Wiki::Store::Database::timestamp_fmt;

- if ($timestamp) - { - my $time = Time::Piece->strptime( $timestamp, $timestamp_fmt ); - $timestamp = $time->strftime( "%Y-%m-%dT%H:%M:%S" ); - } + if ($timestamp) + { + my $time = Time::Piece->strptime($timestamp, $timestamp_fmt); + $timestamp = $time->strftime("%Y-%m-%dT%H:%M:%S"); + }

- my $url = $self->{make_node_url}->($node_name, $version); - my $version_indpt_url = $self->{make_node_url}->($node_name); + my $url = $self->{make_node_url}->($node_name, $version); + my $version_indpt_url = $self->{make_node_url}->($node_name);

- my $rdf = qq{<?xml version="1.0"?> - <rdf:RDF - xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" - xmlns:dc="http://purl.org/dc/elements/1.1/" - xmlns:dcterms="http://purl.org/dc/terms/" - xmlns:foaf="http://xmlns.com/foaf/0.1/" - xmlns:wiki="http://purl.org/rss/1.0/modules/wiki/" - xmlns:chefmoz="http://chefmoz.org/rdf/elements/1.0/" - xmlns:wn="http://xmlns.com/wordnet/1.6/" - xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" - xmlns:os="http://downlode.org/rdf/os/0.1/" - xmlns:owl="http://www.w3.org/2002/07/owl#" - xmlns="http://www.w3.org/2000/10/swap/pim/contact#" - > + my $rdf = qq{<?xml version="1.0"?> + <rdf:RDF + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:dcterms="http://purl.org/dc/terms/" + xmlns:foaf="http://xmlns.com/foaf/0.1/" + xmlns:wiki="http://purl.org/rss/1.0/modules/wiki/" + xmlns:chefmoz="http://chefmoz.org/rdf/elements/1.0/" + xmlns:wn="http://xmlns.com/wordnet/1.6/" + xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" + xmlns:os="http://downlode.org/rdf/os/0.1/" + xmlns:owl="http://www.w3.org/2002/07/owl#" + xmlns="http://www.w3.org/2000/10/swap/pim/contact#" + >

- <rdf:Description rdf:about=""> - dc:title} . $self->{site_name} . qq{: $node_name</dc:title> - dc:date$timestamp</dc:date> - dcterms:modified$timestamp</dcterms:modified> - dc:contributor$username</dc:contributor> - <dc:source rdf:resource="$version_indpt_url" /> - wiki:version$version</wiki:version> - <foaf:topic rdf:resource="#obj" /> - </rdf:Description> + <rdf:Description rdf:about=""> + dc:title} . $self->{site_name} . qq{: $node_name</dc:title> + dc:date$timestamp</dc:date> + dcterms:modified$timestamp</dcterms:modified> + dc:contributor$username</dc:contributor> + <dc:source rdf:resource="$version_indpt_url" /> + wiki:version$version</wiki:version> + <foaf:topic rdf:resource="#obj" /> + </rdf:Description>

- <$objType rdf:ID="obj" dc:title="$node_name"> + <$objType rdf:ID="obj" dc:title="$node_name"> }; - $rdf .= "\n <!-- categories -->\n\n" if $catrefs; - $rdf .= " dc:subject$_</dc:subject>\n" foreach @{$catrefs}; - $rdf .= "\n <!-- address and geospatial data -->\n\n" if $is_geospatial; - $rdf .= " <city>$city</city>\n" if $city && $is_geospatial; - $rdf .= " <postalCode>$postcode</postalCode>\n" if $postcode && $is_geospatial; - $rdf .= " <country>$country</country>\n" if $country && $is_geospatial; + $rdf .= "\n <!-- categories -->\n\n" if $catrefs; + $rdf .= " dc:subject$_</dc:subject>\n" foreach @{$catrefs}; + $rdf .= "\n <!-- address and geospatial data -->\n\n" if $is_geospatial; + $rdf .= " <city>$city</city>\n" if $city && $is_geospatial; + $rdf .= " <postalCode>$postcode</postalCode>\n" if $postcode && $is_geospatial; + $rdf .= " <country>$country</country>\n" if $country && $is_geospatial;

- $rdf .= qq{ - foaf:based_near - wn:Neighborhood - foaf:name$_</foaf:name> - </wn:Neighborhood> - </foaf:based_near>\n} foreach @locales; - - if ($latitude && $longitude) - { $rdf .= qq{ - geo:lat$latitude</geo:lat> - geo:long$longitude</geo:long>\n}; - } + foaf:based_near + wn:Neighborhood + foaf:name$_</foaf:name> + </wn:Neighborhood> + </foaf:based_near>\n} foreach @locales;

- if ($os_x && $os_y) - { - $rdf .= qq{ - os:x$os_x</os:x> - os:y$os_y</os:y>}; - } + if ($latitude && $longitude) + { + $rdf .= qq{ + geo:lat$latitude</geo:lat> + geo:long$longitude</geo:long>\n}; + }

- $rdf .= "\n\n <!-- contact information -->\n\n" if ($phone || $fax || $website || $opening_hours_text); - $rdf .= " <phone>$phone</phone>\n" if $phone; - $rdf .= " <fax>$fax</fax>\n" if $fax; - $rdf .= " <foaf:homepage rdf:resource="$website" />\n" if $website; - $rdf .= " chefmoz:Hours$opening_hours_text</chefmoz:Hours>\n" if $opening_hours_text; + if ($os_x && $os_y) + { + $rdf .= qq{ + os:x$os_x</os:x> + os:y$os_y</os:y>}; + }

- if ($node_data{content} =~ /^#REDIRECT [[(.*?)]]$/) - { - my $redirect = $1; + $rdf .= "\n\n <!-- contact information -->\n\n" if ($phone || $fax || $website || $opening_hours_text); + $rdf .= " <phone>$phone</phone>\n" if $phone; + $rdf .= " <fax>$fax</fax>\n" if $fax; + $rdf .= " <foaf:homepage rdf:resource="$website" />\n" if $website; + $rdf .= " chefmoz:Hours$opening_hours_text</chefmoz:Hours>\n" if $opening_hours_text; + + if ($node_data{content} =~ /^#REDIRECT [[(.*?)]]$/) + { + my $redirect = $1; + + $rdf .= qq{ <owl:sameAs rdf:resource="} . $self->{config}->script_url + . uri_escape($self->{config}->script_name) . '?id=' + . uri_escape($wiki->formatter->node_name_to_node_param($redirect)) + . ';format=rdf#obj'; + $rdf .= qq{" />\n}; + }

- $rdf .= qq{ <owl:sameAs rdf:resource="} . $self->{config}->script_url - . uri_escape($self->{config}->script_name) . '?id=' - . uri_escape($wiki->formatter->node_name_to_node_param($redirect)) - . ';format=rdf#obj'; - $rdf .= qq{" />\n}; - } - - $rdf .= qq{ </$objType> + $rdf .= qq{ </$objType> </rdf:RDF>

};

- return $rdf; + return $rdf; }

-sub rss_maker -{ - my $self = shift; +sub rss_maker { + my $self = shift;

- unless ($self->{rss_maker}) # OAOO, please. - { - $self->{rss_maker} = CGI::Wiki::Plugin::RSS::ModWiki->new( - wiki => $self->{wiki}, - site_name => $self->{site_name}, - site_description => $self->{site_description}, - make_node_url => $self->{make_node_url}, - recent_changes_link => $self->{config}->script_url . uri_escape($self->{config}->script_name) . "?RecentChanges" - ); - } - - $self->{rss_maker}; + unless ($self->{rss_maker}) # OAOO, please. + { + $self->{rss_maker} = CGI::Wiki::Plugin::RSS::ModWiki->new( + wiki => $self->{wiki}, + site_name => $self->{site_name}, + site_description => $self->{site_description}, + make_node_url => $self->{make_node_url}, + recent_changes_link => $self->{config}->script_url . uri_escape($self->{config}->script_name) . "?RecentChanges" + ); + } + + $self->{rss_maker}; }

-sub make_recentchanges_rss -{ - my ($self, %args) = @_; +sub make_recentchanges_rss { + my ($self, %args) = @_;

- $self->rss_maker->recent_changes(%args); + $self->rss_maker->recent_changes(%args); }

-sub rss_timestamp -{ - my ($self, %args) = @_; - - $self->rss_maker->rss_timestamp(%args); +sub rss_timestamp { + my ($self, %args) = @_; + + $self->rss_maker->rss_timestamp(%args); }

=head1 NAME @@ -245,23 +240,23 @@

=head1 SYNOPSIS

- use CGI::Wiki; - use OpenGuides::Config; - use OpenGuides::RDF; + use CGI::Wiki; + use OpenGuides::Config; + use OpenGuides::RDF;

- my $wiki = CGI::Wiki->new( ... ); - my $config = OpenGuides::Config->new( file => "wiki.conf" ); - my $rdf_writer = OpenGuides::RDF->new( wiki => $wiki, - config => $config ); + my $wiki = CGI::Wiki->new( ... ); + my $config = OpenGuides::Config->new( file => "wiki.conf" ); + my $rdf_writer = OpenGuides::RDF->new( wiki => $wiki, + config => $config );

- # RDF version of a node. - print "Content-Type: text/plain\n\n"; - print $rdf_writer->emit_rdfxml( node => "Masala Zone, N1 0NU" ); + # RDF version of a node. + print "Content-Type: text/plain\n\n"; + print $rdf_writer->emit_rdfxml( node => "Masala Zone, N1 0NU" );

- # Ten most recent changes. - print "Content-Type: text/plain\n"; - print "Last-Modified: " . $self->rss_timestamp( items => 10 ) . "\n\n"; - print $rdf_writer->make_recentchanges_rss( items => 10 ); + # Ten most recent changes. + print "Content-Type: text/plain\n"; + print "Last-Modified: " . $self->rss_timestamp( items => 10 ) . "\n\n"; + print $rdf_writer->make_recentchanges_rss( items => 10 );

=head1 METHODS

@@ -269,8 +264,8 @@

=item B<new>

- my $rdf_writer = OpenGuides::RDF->new( wiki => $wiki, - config => $config ); + my $rdf_writer = OpenGuides::RDF->new( wiki => $wiki, + config => $config );

C<wiki> must be a LCGI::Wiki object and C<config> must be an LOpenGuides::Config object. Both arguments mandatory. @@ -278,16 +273,16 @@

=item B<emit_rdfxml>

- $wiki->write_node( "Masala Zone, N1 0NU", + $wiki->write_node( "Masala Zone, N1 0NU", "Quick and tasty Indian food", $checksum, { comment => "New page", username => "Kake", locale => "Islington" } - ); + );

- print "Content-Type: text/plain\n\n"; - print $rdf_writer->emit_rdfxml( node => "Masala Zone, N1 0NU" ); + print "Content-Type: text/plain\n\n"; + print $rdf_writer->emit_rdfxml( node => "Masala Zone, N1 0NU" );

BNote: Some of the fields emitted by the RDF/XML generator are taken from the node metadata. The form of this metadata is I<not> mandated @@ -321,26 +316,26 @@

=item B<make_recentchanges_rss>

- # Ten most recent changes. - print "Content-Type: text/plain\n"; - print "Last-Modified: " . $rdf_writer->rss_timestamp( items => 10 ) . "\n\n"; - print $rdf_writer->make_recentchanges_rss( items => 10 ); + # Ten most recent changes. + print "Content-Type: text/plain\n"; + print "Last-Modified: " . $rdf_writer->rss_timestamp( items => 10 ) . "\n\n"; + print $rdf_writer->make_recentchanges_rss( items => 10 );

- # All the changes made by bob in the past week, ignoring minor edits. + # All the changes made by bob in the past week, ignoring minor edits.

- my %args = ( - days => 7, - ignore_minor_edits => 1, - filter_on_metadata => { username => "bob" }, - ); + my %args = ( + days => 7, + ignore_minor_edits => 1, + filter_on_metadata => { username => "bob" }, + );

- print "Content-Type: text/plain\n"; - print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n"; - print $rdf_writer->make_recentchanges_rss( %args ); + print "Content-Type: text/plain\n"; + print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n"; + print $rdf_writer->make_recentchanges_rss( %args );

=item B<rss_timestamp>

- print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n"; + print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n";

Returns the timestamp of the RSS feed in POSIX::strftime style ("Tue, 29 Feb 2000 12:34:56 GMT"), which is equivalent to the timestamp of the most recent item