openguides-commits

openguides-commits@lists.openguides.org

873 discussions

r1234 - trunk
by svnadmin＠urchin.earth.li 19 Oct '08

19 Oct '08

Author: dom Date: 2008-10-19 15:15:15 +0100 (Sun, 19 Oct 2008) New Revision: 1234 Modified: trunk/Build.PL Log: update dependency on Wiki::Toolkit for new metadata list stuff Modified: trunk/Build.PL =================================================================== --- trunk/Build.PL 2008-10-19 13:06:48 UTC (rev 1233) +++ trunk/Build.PL 2008-10-19 14:15:15 UTC (rev 1234) @@ -282,7 +282,7 @@ 'CGI' => '2.92', # avoid escapeHTML bug 'CGI::Carp' => 0, 'CGI::Cookie' => 0, - 'Wiki::Toolkit' => '0.74', # for dbport + 'Wiki::Toolkit' => '0.77', 'Wiki::Toolkit::Feed::Atom' => 0, 'Wiki::Toolkit::Feed::RSS' => 0, 'Wiki::Toolkit::Formatter::UseMod' => 0,

1 0

r1233 - in trunk: . lib/OpenGuides
by svnadmin＠urchin.earth.li 19 Oct '08

19 Oct '08

Author: dom Date: 2008-10-19 14:06:48 +0100 (Sun, 19 Oct 2008) New Revision: 1233 Modified: trunk/Changes trunk/lib/OpenGuides/Config.pm Log: change default database type to sqlite (#241) Modified: trunk/Changes =================================================================== --- trunk/Changes 2008-10-19 12:58:16 UTC (rev 1232) +++ trunk/Changes 2008-10-19 13:06:48 UTC (rev 1233) @@ -10,6 +10,7 @@ JSON support for node details and metatdata discovery Correctly validate web site URLs during edit and display, and truncate URLs that are too long (#21) + Change default database type to sqlite (#241) Set content charset correctly in RDF (#260) 0.63 16 August 2008 Modified: trunk/lib/OpenGuides/Config.pm =================================================================== --- trunk/lib/OpenGuides/Config.pm 2008-10-19 12:58:16 UTC (rev 1232) +++ trunk/lib/OpenGuides/Config.pm 2008-10-19 13:06:48 UTC (rev 1233) @@ -73,7 +73,7 @@ # Here are the defaults for the variable values. # Don't forget to add to INSTALL when changing these. my %defaults = ( - dbtype => "postgres", + dbtype => "sqlite", script_name => "wiki.cgi", install_directory => "/usr/lib/cgi-bin/openguides/", use_plucene => 1,

1 0

r1232 - in trunk: . lib/OpenGuides t templates
by svnadmin＠urchin.earth.li 19 Oct '08

19 Oct '08

Author: dom Date: 2008-10-19 13:58:16 +0100 (Sun, 19 Oct 2008) New Revision: 1232 Modified: trunk/Changes trunk/lib/OpenGuides/RDF.pm trunk/t/21_rdf.t trunk/templates/node_rdf.tt trunk/templates/rdf_index.tt Log: Fix RDF encoding (fixes #260); thanks Inigo Modified: trunk/Changes =================================================================== --- trunk/Changes 2008-10-18 18:19:22 UTC (rev 1231) +++ trunk/Changes 2008-10-19 12:58:16 UTC (rev 1232) @@ -10,6 +10,7 @@ JSON support for node details and metatdata discovery Correctly validate web site URLs during edit and display, and truncate URLs that are too long (#21) + Set content charset correctly in RDF (#260) 0.63 16 August 2008 Major overhaul of RDF output. Modified: trunk/lib/OpenGuides/RDF.pm =================================================================== --- trunk/lib/OpenGuides/RDF.pm 2008-10-18 18:19:22 UTC (rev 1231) +++ trunk/lib/OpenGuides/RDF.pm 2008-10-19 12:58:16 UTC (rev 1232) @@ -74,6 +74,7 @@ site_name => $self->{site_name}, site_desc => $self->{site_description}, og_version => $self->{og_version}, + config => $config, ); my %defaults = ( Modified: trunk/t/21_rdf.t =================================================================== --- trunk/t/21_rdf.t 2008-10-18 18:19:22 UTC (rev 1231) +++ trunk/t/21_rdf.t 2008-10-19 12:58:16 UTC (rev 1232) @@ -15,7 +15,7 @@ plan skip_all => "DBD::SQLite could not be used - no database to test with. ($error)"; } -plan tests => 29; +plan tests => 30; Wiki::Toolkit::Setup::SQLite::setup( { dbname => "t/node.db" } ); my $config = OpenGuides::Test->make_basic_config; @@ -80,7 +80,11 @@ my $rdfxml = $rdf_writer->emit_rdfxml( node => "Calthorpe Arms" ); -like( $rdfxml, qr|<\?xml version="1.0"\?>|, "RDF is encoding-neutral" ); +like( $rdfxml, qr|<\?xml version="1.0" \?>|, "RDF uses no encoding when none set" ); +$config->http_charset( "UTF-8" ); +$guide = OpenGuides->new( config => $config ); +$rdfxml = $rdf_writer->emit_rdfxml( node => "Calthorpe Arms" ); +like( $rdfxml, qr|<\?xml version="1.0" encoding="UTF-8"\?>|, "RDF uses declared encoding" ); like( $rdfxml, qr|<foaf:depiction rdf:resource="http://example.com/calthorpe.jpg" />|, "Node image"); Modified: trunk/templates/node_rdf.tt =================================================================== --- trunk/templates/node_rdf.tt 2008-10-18 18:19:22 UTC (rev 1231) +++ trunk/templates/node_rdf.tt 2008-10-19 12:58:16 UTC (rev 1232) @@ -1,4 +1,4 @@ -<?xml version="1.0"?> +<?xml version="1.0" [%- IF config.http_charset %]encoding="[% config.http_charset %]"[%- END %]?> <rdf:RDF xmlns:dc = "http://purl.org/dc/elements/1.1/" xmlns:dcterms = "http://purl.org/dc/terms/" Modified: trunk/templates/rdf_index.tt =================================================================== --- trunk/templates/rdf_index.tt 2008-10-18 18:19:22 UTC (rev 1231) +++ trunk/templates/rdf_index.tt 2008-10-19 12:58:16 UTC (rev 1232) @@ -1,5 +1,5 @@ [%- USE CGI -%] -<?xml version="1.0"?> +<?xml version="1.0" [%- IF config.http_charset %]encoding="[% config.http_charset %]"[%- END %]?> <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"

1 0

r1231 - in trunk: . lib/OpenGuides t
by svnadmin＠urchin.earth.li 18 Oct '08

18 Oct '08

Author: dom Date: 2008-10-18 19:19:22 +0100 (Sat, 18 Oct 2008) New Revision: 1231 Modified: trunk/Build.PL trunk/Changes trunk/lib/OpenGuides/Config.pm trunk/lib/OpenGuides/Template.pm trunk/lib/OpenGuides/Utils.pm trunk/t/21_rdf.t trunk/t/68_bug_website_displayed.t Log: Correctly validate web site URLs during edit and display, and truncate URLs that are too long (fixes #21) Modified: trunk/Build.PL =================================================================== --- trunk/Build.PL 2008-10-18 15:35:27 UTC (rev 1230) +++ trunk/Build.PL 2008-10-18 18:19:22 UTC (rev 1231) @@ -266,10 +266,6 @@ } close FILE or die "Can't close wiki.conf: $!"; -##### -##### When updating the prereqs PLEASE REMEMBER to update PREREQUISITES. -##### - # We currently only support Plucene for new installs, but may support # others in future my $search_module = $use_plucene ? "Plucene" : "Search::InvertedIndex"; @@ -313,6 +309,7 @@ 'Time::Piece' => 0, 'URI::Escape' => 0, 'XML::RSS' => 0, + 'Data::Validate::URI' => 0, }, build_requires => { 'Module::Build' => '0.26', # API change for accessing config data @@ -321,8 +318,8 @@ 'Data::Dumper' => 0, }, recommends => { - 'DBD::SQLite' => 0, # for testing - 'Test::HTML::Content' => 0, # for testing, oddly enough + 'DBD::SQLite' => 0, # for testing + 'Test::HTML::Content' => 0, # for testing, oddly enough 'Wiki::Toolkit::Plugin::Ping' => 0, # for pinging external services 'Geo::HelmertTransform' => 0, # for correct WGS84 lat/long # when using grid systems Modified: trunk/Changes =================================================================== --- trunk/Changes 2008-10-18 15:35:27 UTC (rev 1230) +++ trunk/Changes 2008-10-18 18:19:22 UTC (rev 1231) @@ -8,6 +8,8 @@ Fix some broken POD (#246) Metadata discovery features (action=metadata) JSON support for node details and metatdata discovery + Correctly validate web site URLs during edit and display, + and truncate URLs that are too long (#21) 0.63 16 August 2008 Major overhaul of RDF output. Modified: trunk/lib/OpenGuides/Config.pm =================================================================== --- trunk/lib/OpenGuides/Config.pm 2008-10-18 15:35:27 UTC (rev 1230) +++ trunk/lib/OpenGuides/Config.pm 2008-10-18 18:19:22 UTC (rev 1231) @@ -25,7 +25,7 @@ licence_name licence_url licence_info_url moderation_requires_password enable_node_image enable_common_categories enable_common_locales spam_detector_module host_checker_module static_path static_url - send_moderation_notifications + send_moderation_notifications website_link_max_chars ); my @questions = map { $_ . "__qu" } @variables; OpenGuides::Config->mk_accessors( @variables ); @@ -114,7 +114,8 @@ spam_detector_module => "", host_checker_module => "", static_path => "/usr/local/share/openguides/static", - send_moderation_notifications => 1 + send_moderation_notifications => 1, + website_link_max_chars => 20, ); # See if we already have some config variables set. @@ -199,7 +200,8 @@ host_checker_module => "What module would you like to use to run an IP blacklist? (optional)", static_path => "What directory should we install static content (CSS, images, javascript) to?", static_url => "What is the URL corresponding to the static content?", - send_moderation_notifications => "Should we send email notifications when a moderated node is edited?" + send_moderation_notifications => "Should we send email notifications when a moderated node is edited?", + website_link_max_chars => "How many characters of the URL of node websites should be displayed?", ); foreach my $var ( keys %questions ) { @@ -334,6 +336,8 @@ =item * send_moderation_notifications +=item * website_link_max_chars (default: C<20>) + =back =head1 AUTHOR Modified: trunk/lib/OpenGuides/Template.pm =================================================================== --- trunk/lib/OpenGuides/Template.pm 2008-10-18 15:35:27 UTC (rev 1230) +++ trunk/lib/OpenGuides/Template.pm 2008-10-18 18:19:22 UTC (rev 1231) @@ -12,6 +12,7 @@ use OpenGuides::CGI; use Template; use URI::Escape; +use Data::Validate::URI qw( is_web_uri ); =head1 NAME @@ -347,16 +348,15 @@ }; } @loclist; - # The 'website' attribute might contain a URL so we wiki-format it here - # rather than just CGI::escapeHTMLing it all in the template. my $website = $args{metadata} ? $metadata{website}[0] : $q->param("website"); my $formatted_website_text = ""; - if ( $website && $website ne "http://" ) { - $formatted_website_text = $class->format_website_text( - formatter => $formatter, - text => $website - ); + if ( $website && $website ne "http://" && is_web_uri( $website ) ) { + my $trunc_website = substr( $website, 0, $config->website_link_max_chars ); + unless ($website eq $trunc_website ) { + $trunc_website .= '...'; + } + $formatted_website_text = '<a href="' . $website . '">' . $trunc_website . '</a>'; } my $hours_text = $args{metadata} ? $metadata{opening_hours_text}[0] @@ -582,20 +582,6 @@ return %vars; } -sub format_website_text { - my ($class, %args) = @_; - my ($formatter, $text) = @args{ qw( formatter text ) }; - my $formatted = $formatter->format($text); - - # Strip out paragraph markers put in by formatter since we want this - # to be a single string to put in a <ul>. - $formatted =~ s/<p>//g; - $formatted =~ s/<\/p>//g; - - return $formatted; -} - - =back =head1 AUTHOR @@ -604,7 +590,7 @@ =head1 COPYRIGHT - Copyright (C) 2003-2007 The OpenGuides Project. All Rights Reserved. + Copyright (C) 2003-2008 The OpenGuides Project. All Rights Reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. Modified: trunk/lib/OpenGuides/Utils.pm =================================================================== --- trunk/lib/OpenGuides/Utils.pm 2008-10-18 15:35:27 UTC (rev 1230) +++ trunk/lib/OpenGuides/Utils.pm 2008-10-18 18:19:22 UTC (rev 1231) @@ -10,6 +10,7 @@ use Wiki::Toolkit::Plugin::RSS::Reader; use URI::Escape; use MIME::Lite; +use Data::Validate::URI qw( is_web_uri ); =head1 NAME @@ -376,7 +377,6 @@ return \@fails if @fails; # Now do our real validation - # Numeric tests foreach my $var (qw(os_x os_y)) { if ($q->param($var) and $q->param($var) !~ /^-?\d+$/) { push @fails, "$var must be integer, was: " . $q->param($var); @@ -389,6 +389,12 @@ } } + if ( $q->param('website') and $q->param('website') ne 'http://' ) { + unless ( is_web_uri( $q->param('website') ) ) { + push @fails, $q->param('website') . ' is not a valid web URI'; + } + } + return \@fails; }; Modified: trunk/t/21_rdf.t =================================================================== --- trunk/t/21_rdf.t 2008-10-18 15:35:27 UTC (rev 1230) +++ trunk/t/21_rdf.t 2008-10-18 18:19:22 UTC (rev 1231) @@ -54,7 +54,7 @@ postcode => "WC1X 8JR", locales => "Bloomsbury\r\nSt Pancras", phone => "test phone number", - website => "test website", + website => "http://example.com", hours_text => "test hours", latitude => "51.524193", longitude => "-0.114436", @@ -70,7 +70,7 @@ postcode => "WC1X 8JR", locales => "Bloomsbury\r\nSt Pancras", phone => "test phone number", - website => "test website", + website => "http://example.com", hours_text => "test hours", latitude => "51.524193", longitude => "-0.114436", @@ -95,7 +95,7 @@ like( $rdfxml, qr|<dc:available>test hours</dc:available>|, "picks up opening hours text" ); -like( $rdfxml, qr|<foaf:homepage rdf:resource="test website" />|, "picks up website" ); +like( $rdfxml, qr|<foaf:homepage rdf:resource="http://example.com" />|, "picks up website" ); like( $rdfxml, qr|<dc:title>Wiki::Toolkit Test Site: Calthorpe Arms</dc:title>|, Modified: trunk/t/68_bug_website_displayed.t =================================================================== --- trunk/t/68_bug_website_displayed.t 2008-10-18 15:35:27 UTC (rev 1230) +++ trunk/t/68_bug_website_displayed.t 2008-10-18 18:19:22 UTC (rev 1231) @@ -10,18 +10,25 @@ plan skip_all => "DBD::SQLite could not be used - no database to test with ($error)"; } -plan tests => 1; +plan tests => 2; Wiki::Toolkit::Setup::SQLite::cleardb( { dbname => "t/node.db" } ); Wiki::Toolkit::Setup::SQLite::setup( { dbname => "t/node.db" } ); my $config = OpenGuides::Test->make_basic_config; my $guide = OpenGuides->new( config => $config ); -$guide->wiki->write_node( "South Croydon Station", "A sleepy main-line station in what is arguably the nicest part of Croydon.", undef, { website => "http://www.example.com/" } ) or die "Couldn't write node"; +$guide->wiki->write_node( "South Croydon Station", "A sleepy main-line station in what is arguably the nicest part of Croydon.", undef, { website => "http://example.com/" } ) or die "Couldn't write node"; +$guide->wiki->write_node( "North Croydon Station", "A busy main-line station in what is arguably the furthest North part of Croydon.", undef, { website => "http://longer.example.com/asdfasdf" } ) or die "Couldn't write node"; my $output = $guide->display_node( id => "South Croydon Station", return_output => 1, ); -like( $output, qr#Website:</span> <span class="url"><a href="http://www.example.com/">http://www.example.com/</a>#, "website correctly displayed" ); +like( $output, qr#Website:</span> <span class="url"><a href="http://example.com/">http://example.com/</a>#, "website correctly displayed" ); +$output = $guide->display_node( + id => "North Croydon Station", + return_output => 1, + ); + +like( $output, qr#Website:</span> <span class="url"><a href="http://longer.example.com/asdfasdf">http://longer.exampl...</a>#, "website correctly truncated" );

1 0

r1230 - trunk
by svnadmin＠urchin.earth.li 18 Oct '08

18 Oct '08

Author: dom Date: 2008-10-18 16:35:27 +0100 (Sat, 18 Oct 2008) New Revision: 1230 Removed: trunk/PREREQUISITES Modified: trunk/MANIFEST Log: delete this file; it's always going to be out of date and gives us no more information than META.yml Modified: trunk/MANIFEST =================================================================== --- trunk/MANIFEST 2008-10-18 15:34:04 UTC (rev 1229) +++ trunk/MANIFEST 2008-10-18 15:35:27 UTC (rev 1230) @@ -5,7 +5,6 @@ MANIFEST Makefile.PL META.yml -PREREQUISITES README README.CSS README.GMAPS Deleted: trunk/PREREQUISITES =================================================================== --- trunk/PREREQUISITES 2008-10-18 15:34:04 UTC (rev 1229) +++ trunk/PREREQUISITES 2008-10-18 15:35:27 UTC (rev 1230) @@ -1,51 +0,0 @@ -Modules required by OpenGuides 0.59 -=================================== - -Algorithm::Diff (version 0.13 or later. Note that the latest version uses - .zip rather than .tar.gz and breaks some automated installs) -CGI (version 2.92 or later) -CGI::Carp -CGI::Cookie -Wiki::Toolkit (version 0.74 or later) -Wiki::Toolkit::Feed::Atom -Wiki::Toolkit::Feed::RSS -Wiki::Toolkit::Formatter::UseMod -Wiki::Toolkit::Plugin::Categoriser -Wiki::Toolkit::Plugin::Diff -Wiki::Toolkit::Plugin::Locator::Grid -Wiki::Toolkit::Plugin::RSS::Reader -Class::Accessor -Config::Tiny -Data::Dumper -( - DBD::Pg - -- or -- - DBD::mysql - -- or -- - DBD::SQLite -) -File::Spec::Functions -File::Temp -( - Geography::NationalGrid::GB - -- or -- - Geography::NationalGrid::IE - -- or -- - Geo::Coordinates::UTM -) -HTML::Entities -LWP::Simple -MIME::Lite -Module::Build (version 0.26 or later) -Parse::RecDescent -Plucene -POSIX -Template -Time::Piece -URI::Escape -XML::RSS - -Optional prerequisites (OpenGuides will work without these, but not -all functionality will be available) -Wiki::Toolkit::Plugin::Ping -Geo::HelmertTransform

1 0

r1229 - trunk/templates
by svnadmin＠urchin.earth.li 18 Oct '08

18 Oct '08

Author: nick Date: 2008-10-18 16:34:04 +0100 (Sat, 18 Oct 2008) New Revision: 1229 Modified: trunk/templates/edit_form.tt Log: Make a start on JS to help you pick locales and categories, but not quite finished yet Modified: trunk/templates/edit_form.tt =================================================================== --- trunk/templates/edit_form.tt 2008-10-18 14:51:09 UTC (rev 1228) +++ trunk/templates/edit_form.tt 2008-10-18 15:34:04 UTC (rev 1229) @@ -94,6 +94,7 @@ Current locales: [% ELSE %] Locales (one per line): + <span id="pick_locale"></span> [% END %] </label> <div class="edit_box"> @@ -118,6 +119,7 @@ Current categories: [% ELSE %] Categories (one per line): + <span id="pick_category"></span> [% END %] </label> <div class="edit_box"> @@ -136,6 +138,42 @@ [% END %] </div> + <script type="text/javascript"> + function pick(metadata_type, textbox_id) { + var textbox = document.getElementById(textbox_id); + + // For adding the new metadata to the textarea + var add_md = function(picked) { + var last = textbox.value.substring(textbox.value.length - 1); + if(last == "\r" || last == "\n") { + // Already has new line + } else { + textbox.value = textbox.value + "\r\n"; + } + + textbox.value = textbox.value + picked; + }; + + // Fetch the data + $.getJSON("[% cgi_url %]?action=metadata;format=json;type=" + metadata_type, function(data) { +// alert(data[metadata_type][0]); +// add_md(data[metadata_type][1]); + }); + } + + function pick_locale() { + pick("locale", "locales"); + } + function pick_category() { + pick("category", "categories"); + } + + $(document).ready(function() { + $("#pick_locale").html("<a href='javascript:pick_locale()'>pick Locale</a>"); + $("#pick_category").html("<a href='javascript:pick_category()'>pick Category</a>"); + }); + </script> + <div class="edit_form_group" id="summary_group"> [% IF conflict %] <label for="summary_input">Current summary:</label>

1 0

r1228 - in trunk: . lib templates
by svnadmin＠urchin.earth.li 18 Oct '08

18 Oct '08

Author: nick Date: 2008-10-18 15:51:09 +0100 (Sat, 18 Oct 2008) New Revision: 1228 Added: trunk/templates/metadata.tt Modified: trunk/Changes trunk/lib/OpenGuides.pm trunk/templates/node.tt Log: Finish off the metadata discovery things Modified: trunk/Changes =================================================================== --- trunk/Changes 2008-10-18 14:37:04 UTC (rev 1227) +++ trunk/Changes 2008-10-18 14:51:09 UTC (rev 1228) @@ -6,6 +6,8 @@ 0.64 Correctly specify all build_requires (#245) Fix some broken POD (#246) + Metadata discovery features (action=metadata) + JSON support for node details and metatdata discovery 0.63 16 August 2008 Major overhaul of RDF output. Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2008-10-18 14:37:04 UTC (rev 1227) +++ trunk/lib/OpenGuides.pm 2008-10-18 14:51:09 UTC (rev 1228) @@ -1023,15 +1023,18 @@ my @values; my $type; - if($args{"type"}) { + my $may_descend = 0; + if($args{"type"} && $args{"type"} ne "metadata_type") { $type = $args{"type"}; @values = $wiki->store->list_metadata_by_type($args{"type"}); } else { + $may_descend = 1; $type = "metadata_type"; @values = $wiki->store->list_metadata_names; } my %tt_vars = ( type => $type, + may_descend => $may_descend, metadata => \@values, num_results => scalar @values, not_deletable => 1, Added: trunk/templates/metadata.tt =================================================================== --- trunk/templates/metadata.tt (rev 0) +++ trunk/templates/metadata.tt 2008-10-18 14:51:09 UTC (rev 1228) @@ -0,0 +1,24 @@ +[% INCLUDE header.tt + page_title = "Metadata of type $type - $site_name" + feed_base = "$cgi_url?action=metadata;type=$type" +%] +[% INCLUDE banner.tt %] +<div id="content"> +[% INCLUDE navbar.tt %] +<div id="maincontent"> +<h2>Metadata Listing - Things of type [% type %]</h2> +<ol> + [% FOREACH md = metadata %] + <li> + [% IF may_descend %]<a href="[% cgi_url %]?action=metadata;type=[% md %]">[% END %][% md %][% IF may_descend %]</a>[% END %] + </li> + [% END %] +</ol> +</div> + +<p> + This list is available as + <a href="[% cgi_url %]?action=metadata;type=[% type %];format=json">json</a>. +</p> + +[% INCLUDE footer.tt %] Modified: trunk/templates/node.tt =================================================================== --- trunk/templates/node.tt 2008-10-18 14:37:04 UTC (rev 1227) +++ trunk/templates/node.tt 2008-10-18 14:51:09 UTC (rev 1228) @@ -123,6 +123,8 @@ <div id="rdf_link"> <a href="[% cgi_url %]?id=[% node_param %];format=rdf">RDF/XML for this node</a> + <a href="[% cgi_url %]?id=[% node_param %];format=json">JSON for this + node</a> [% IF rss_locale_url %] / <a href="[% rss_locale_url %]">RSS feed for this locale</a> [% END %]

1 0

r1227 - in trunk: . lib lib/OpenGuides
by svnadmin＠urchin.earth.li 18 Oct '08

18 Oct '08

Author: nick Date: 2008-10-18 15:37:04 +0100 (Sat, 18 Oct 2008) New Revision: 1227 Modified: trunk/lib/ trunk/lib/OpenGuides.pm trunk/lib/OpenGuides/ trunk/lib/OpenGuides/JSON.pm trunk/wiki.cgi Log: Start to support metadata discovery stuff Property changes on: trunk/lib ___________________________________________________________________ Name: svn:ignore + *.swp .vimrc Property changes on: trunk/lib/OpenGuides ___________________________________________________________________ Name: svn:ignore + *.swp .vimrc Modified: trunk/lib/OpenGuides/JSON.pm =================================================================== --- trunk/lib/OpenGuides/JSON.pm 2008-10-18 13:56:37 UTC (rev 1226) +++ trunk/lib/OpenGuides/JSON.pm 2008-10-18 14:37:04 UTC (rev 1227) @@ -60,6 +60,9 @@ $self; } +=item B<emit_json> +Renders the given node as JSON +=cut sub emit_json { my ( $self, %args ) = @_; @@ -103,6 +106,14 @@ return $self->json_maker->make_json($data); } +=item B<output_as_json> +Renders the given arbitary data as JSON +=cut +sub output_as_json { + my ( $self, %args ) = @_; + return $self->json_maker->make_json(\%args); +} + sub json_maker { my $self = shift; Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2008-10-18 13:56:37 UTC (rev 1226) +++ trunk/lib/OpenGuides.pm 2008-10-18 14:37:04 UTC (rev 1227) @@ -1002,6 +1002,72 @@ print $output; } +=item B<show_metadata> + + $guide->show_metadata(); + $guide->show_metadata(type => "category"); + $guide->show_metadata(type => "category", format => "json"); + +Lists all metadata types, or all metadata values of a given +type. Useful for programatically discovering a guide. + +As with other methods, parameters C<return_tt_vars> and +C<return_output> can be used to return these things instead of +printing the output to STDOUT. + +=cut +sub show_metadata { + my ($self, %args) = @_; + my $wiki = $self->wiki; + my $formatter = $wiki->formatter; + + my @values; + my $type; + if($args{"type"}) { + $type = $args{"type"}; + @values = $wiki->store->list_metadata_by_type($args{"type"}); + } else { + $type = "metadata_type"; + @values = $wiki->store->list_metadata_names; + } + + my %tt_vars = ( type => $type, + metadata => \@values, + num_results => scalar @values, + not_deletable => 1, + deter_robots => 1, + not_editable => 1 ); + return %tt_vars if $args{return_tt_vars}; + + my $output; + my $content_type; + + if($args{"format"}) { + if($args{"format"} eq "json") { + $content_type = "text/javascript"; + my $json = OpenGuides::JSON->new( wiki => $wiki, + config => $self->config ); + $output = $json->output_as_json( + $type => \@values + ); + } + } + unless($output) { + $output = OpenGuides::Template->output( + wiki => $wiki, + config => $self->config, + template=>"metadata.tt", + vars => \%tt_vars, + ); + } + return $output if $args{return_output}; + + if($content_type) { + print "Content-type: $content_type\n\n"; + } + print $output; +} + =item B<list_all_versions> $guide->list_all_versions ( id => "Home Page" ); Modified: trunk/wiki.cgi =================================================================== --- trunk/wiki.cgi 2008-10-18 13:56:37 UTC (rev 1226) +++ trunk/wiki.cgi 2008-10-18 14:37:04 UTC (rev 1227) @@ -188,9 +188,9 @@ print $q->redirect( $redir_target ); } elsif ($action eq 'about') { $guide->display_about(format => $format); - } elsif ($action eq 'metadata' && $q->param("type")) { + } elsif ($action eq 'metadata') { $guide->show_metadata( - type => $q->param("type"), + type => $q->param("type") || "", format => $format, ); } elsif ($action eq 'display') {

1 0

r1226 - in trunk: . lib
by svnadmin＠urchin.earth.li 18 Oct '08

18 Oct '08

Author: dom Date: 2008-10-18 14:56:37 +0100 (Sat, 18 Oct 2008) New Revision: 1226 Modified: trunk/Changes trunk/lib/OpenGuides.pm Log: Broken pod fix from oliver (closes #246) Modified: trunk/Changes =================================================================== --- trunk/Changes 2008-10-18 13:53:43 UTC (rev 1225) +++ trunk/Changes 2008-10-18 13:56:37 UTC (rev 1226) @@ -5,6 +5,7 @@ 0.64 Correctly specify all build_requires (#245) + Fix some broken POD (#246) 0.63 16 August 2008 Major overhaul of RDF output. Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2008-10-18 13:53:43 UTC (rev 1225) +++ trunk/lib/OpenGuides.pm 2008-10-18 13:56:37 UTC (rev 1226) @@ -2223,11 +2223,11 @@ =over 4 -=item * L<http://london.openguides.org/|The Open Guide to London>, the first and biggest OpenGuides site. +=item * The Open Guide to London, at L<http://london.openguides.org/>, is the first and biggest OpenGuides site. -=item * L<http://openguides.org/|The OpenGuides website>, with a list of all live OpenGuides installs. +=item * A list of live OpenGuides installs is available at L<http://openguides.org/>. -=item * L<Wiki::Toolkit>, the Wiki toolkit which does the heavy lifting for OpenGuides +=item * L<Wiki::Toolkit>, the Wiki toolkit which does the heavy lifting for OpenGuides. =back

1 0

r1225 - trunk/lib/OpenGuides
by svnadmin＠urchin.earth.li 18 Oct '08

18 Oct '08

Author: nick Date: 2008-10-18 14:53:43 +0100 (Sat, 18 Oct 2008) New Revision: 1225 Modified: trunk/lib/OpenGuides/JSON.pm Log: Rename functions in json module to be more appropriate Modified: trunk/lib/OpenGuides/JSON.pm =================================================================== --- trunk/lib/OpenGuides/JSON.pm 2008-10-18 13:42:42 UTC (rev 1224) +++ trunk/lib/OpenGuides/JSON.pm 2008-10-18 13:53:43 UTC (rev 1225) @@ -124,15 +124,16 @@ return $self->{json_maker}; } -sub make_recentchanges_rss { +sub make_recentchanges_json { my ( $self, %args ) = @_; $self->json_maker->recent_changes(%args); } -sub rss_timestamp { +sub json_timestamp { my ( $self, %args ) = @_; + # RSS and JSON timestamps are close, I think... $self->json_maker->rss_timestamp(%args); } @@ -155,17 +156,17 @@ my $wiki = Wiki::Toolkit->new( ... ); my $config = OpenGuides::Config->new( file => "wiki.conf" ); - my $rdf_writer = OpenGuides::JSON->new( wiki => $wiki, + my $json_writer = OpenGuides::JSON->new( wiki => $wiki, config => $config ); # JSON version of a node. - print "Content-Type: application/rdf+xml\n\n"; - print $rdf_writer->emit_rdfxml( node => "Masala Zone, N1 0NU" ); + print "Content-Type: application/javascript\n\n"; + print $json_writer->emit_json( node => "Masala Zone, N1 0NU" ); # Ten most recent changes. - print "Content-Type: application/rdf+xml\n"; - print "Last-Modified: " . $self->rss_timestamp( items => 10 ) . "\n\n"; - print $rdf_writer->make_recentchanges_rss( items => 10 ); + print "Content-Type: application/javascript\n"; + print "Last-Modified: " . $self->json_timestamp( items => 10 ) . "\n\n"; + print $json_writer->make_recentchanges_json( items => 10 ); =head1 METHODS @@ -173,14 +174,14 @@ =item B<new> - my $rdf_writer = OpenGuides::JSON->new( wiki => $wiki, + my $json_writer = OpenGuides::JSON->new( wiki => $wiki, config => $config ); C<wiki> must be a L<Wiki::Toolkit> object and C<config> must be an L<OpenGuides::Config> object. Both arguments mandatory. -=item B<emit_rdfxml> +=item B<emit_json> $wiki->write_node( "Masala Zone, N1 0NU", "Quick and tasty Indian food", @@ -190,8 +191,8 @@ locale => "Islington" } ); - print "Content-Type: application/rdf+xml\n\n"; - print $rdf_writer->emit_rdfxml( node => "Masala Zone, N1 0NU" ); + print "Content-Type: application/javascript\n\n"; + print $json_writer->emit_json( node => "Masala Zone, N1 0NU" ); B<Note:> Some of the fields emitted by the JSON generator are taken from the node metadata. The form of this metadata is I<not> mandated @@ -223,12 +224,12 @@ Returns a raw L<Wiki::Toolkit::Plugin::JSON> object created with the values you invoked this module with. -=item B<make_recentchanges_rss> +=item B<make_recentchanges_json> # Ten most recent changes. - print "Content-Type: application/rdf+xml\n"; - print "Last-Modified: " . $rdf_writer->rss_timestamp( items => 10 ) . "\n\n"; - print $rdf_writer->make_recentchanges_rss( items => 10 ); + print "Content-Type: application/javascript\n"; + print "Last-Modified: " . $json_writer->json_timestamp( items => 10 ) . "\n\n"; + print $json_writer->make_recentchanges_json( items => 10 ); # All the changes made by bob in the past week, ignoring minor edits. @@ -238,17 +239,17 @@ filter_on_metadata => { username => "bob" }, ); - print "Content-Type: application/rdf+xml\n"; - print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n"; - print $rdf_writer->make_recentchanges_rss( %args ); + print "Content-Type: application/javascript\n"; + print "Last-Modified: " . $json_writer->json_timestamp( %args ) . "\n\n"; + print $json_writer->make_recentchanges_json( %args ); -=item B<rss_timestamp> +=item B<json_timestamp> - print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n"; + print "Last-Modified: " . $json_writer->json_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 -in the feed. Takes the same arguments as make_recentchanges_rss(). You will most +in the feed. Takes the same arguments as make_recentchanges_json(). You will most likely need this to print a Last-Modified HTTP header so user-agents can determine whether they need to reload the feed or not.

1 0

← Newer
1
...
43
44
45
46
47
48
49
...
88
Older →

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

openguides-commits