Menu
▾
▴
[Webfetch-commits] SF.net SVN: webfetch:[34] branches/v0.11/lib/WebFetch
|
From: <ik...@us...> - 2009-08-25 22:20:03
|
Revision: 34
http://webfetch.svn.sourceforge.net/webfetch/?rev=34&view=rev
Author: ikluft
Date: 2009-08-25 22:19:47 +0000 (Tue, 25 Aug 2009)
Log Message:
-----------
add WebFetch::Input::Atom and WebFetch::Output:TT
Added Paths:
-----------
branches/v0.11/lib/WebFetch/Input/Atom.pm
branches/v0.11/lib/WebFetch/Output/TT.pm
Added: branches/v0.11/lib/WebFetch/Input/Atom.pm
===================================================================
--- branches/v0.11/lib/WebFetch/Input/Atom.pm (rev 0)
+++ branches/v0.11/lib/WebFetch/Input/Atom.pm 2009-08-25 22:19:47 UTC (rev 34)
@@ -0,0 +1,174 @@
+#
+# WebFetch::Input::Atom - get headlines from remote Atom feed
+#
+# Copyright (c) 1998-2009 Ian Kluft. This program is free software; you can
+# redistribute it and/or modify it under the terms of the GNU General Public
+# License Version 3. See http://www.webfetch.org/GPLv3.txt
+
+package WebFetch::Input::Atom;
+
+use strict;
+use base "WebFetch";
+
+use Carp;
+use Scalar::Util qw( blessed );
+use Date::Calc qw(Today Delta_Days Month_to_Text);
+use XML::Atom::Client;
+use LWP::UserAgent;
+
+use Exception::Class (
+);
+
+our @Options = ();
+our $Usage = "";
+
+# configuration parameters
+our $num_links = 5;
+
+# no user-servicable parts beyond this point
+
+# register capabilities with WebFetch
+__PACKAGE__->module_register( "input:atom" );
+
+# called from WebFetch main routine
+sub fetch
+{
+ my ( $self ) = @_;
+
+ # set parameters for WebFetch routines
+ if ( !defined $self->{num_links}) {
+ $self->{num_links} = $WebFetch::Input::Atom::num_links;
+ }
+ if ( !defined $self->{style}) {
+ $self->{style} = {};
+ $self->{style}{para} = 1;
+ }
+
+ # set up Webfetch Embedding API data
+ $self->{data} = {};
+ $self->{actions} = {};
+ $self->{data}{fields} = [ "id", "updated", "title", "author", "link",
+ "summary", "content", "xml" ];
+ # defined which fields match to which "well-known field names"
+ $self->{data}{wk_names} = {
+ "title" => "title",
+ "url" => "link",
+ "date" => "updated",
+ "summary" => "summary",
+ };
+ $self->{data}{records} = [];
+
+ # process the links
+
+ # parse data file
+ $self->parse_input();
+
+ # return and let WebFetch handle the data
+}
+
+# extract a string value from a scalar/ref if possible
+sub extract_value
+{
+ my $thing = shift;
+
+ ( defined $thing ) or return undef;
+ if ( ref $thing ) {
+ if ( !blessed $thing ) {
+ # it's a HASH/ARRAY/etc, not an object
+ return undef;
+ }
+ if ( $thing->can( "as_string" )) {
+ return $thing->as_string;
+ }
+ return undef;
+ } else {
+ $thing =~ s/\s+$//s;
+ length $thing > 0 or return undef;
+ return $thing;
+ }
+}
+
+# parse Atom input
+sub parse_input
+{
+ my $self = shift;
+ my $atom_api = XML::Atom::Client->new;
+ my $atom_feed = $atom_api->getFeed( $self->{source} );
+
+ # parse values from top of structure
+ my ( %feed, @entries, $entry );
+ @entries = $atom_feed->entries;
+ foreach $entry ( @entries ) {
+ # save the data record
+ my $id = extract_value( $entry->id() );
+ my $title = extract_value( $entry->title() );
+ my $author = extract_value( $entry->author() );
+ my $link = extract_value( $entry->link() );
+ my $updated = extract_value( $entry->updated() );
+ my $summary = extract_value( $entry->summary() );
+ my $content = extract_value( $entry->content() );
+ my $xml = $entry->as_xml();
+ push @{$self->{data}{records}},
+ [ $id, $updated, $title, $author, $link, $summary,
+ $content, $xml ];
+ }
+}
+
+1;
+__END__
+# POD docs follow
+
+=head1 NAME
+
+WebFetch::Input::Atom - download and save an Atom feed
+
+=head1 SYNOPSIS
+
+In perl scripts:
+
+C<use WebFetch::Input::Atom;>
+
+From the command line:
+
+C<perl -w -MWebFetch::Input::Atom -e "&fetch_main" -- --dir directory
+ --source atom-feed-url [...WebFetch output options...]>
+
+=head1 DESCRIPTION
+
+This module gets the current headlines from a site-local file.
+
+The I<--input> parameter specifies a file name which contains news to be
+posted. See L<"FILE FORMAT"> below for details on contents to put in the
+file. I<--input> may be specified more than once, allowing a single news
+output to come from more than one input. For example, one file could be
+manually maintained in CVS or RCS and another could be entered from a
+web form.
+
+After this runs, the file C<site_news.html> will be created or replaced.
+If there already was a C<site_news.html> file, it will be moved to
+C<Osite_news.html>.
+
+=head1 Atom FORMAT
+
+Atom is an XML format defined at http://atompub.org/rfc4287.html
+
+WebFetch::Input::Atom uses Perl's XML::Atom::Client to parse Atom feeds.
+
+=head1 AUTHOR
+
+WebFetch was written by Ian Kluft
+Send patches, bug reports, suggestions and questions to
+C<ma...@we...>.
+
+=head1 SEE ALSO
+
+=for html
+<a href="WebFetch.html">WebFetch</a>
+
+=for text
+WebFetch
+
+=for man
+WebFetch
+
+=cut
Added: branches/v0.11/lib/WebFetch/Output/TT.pm
===================================================================
--- branches/v0.11/lib/WebFetch/Output/TT.pm (rev 0)
+++ branches/v0.11/lib/WebFetch/Output/TT.pm 2009-08-25 22:19:47 UTC (rev 34)
@@ -0,0 +1,106 @@
+#
+# WebFetch::Output::TT - save data via the Perl Template Toolkit
+#
+# Copyright (c) 1998-2009 Ian Kluft. This program is free software; you can
+# redistribute it and/or modify it under the terms of the GNU General Public
+# License Version 3. See http://www.webfetch.org/GPLv3.txt
+
+package WebFetch::Output::TT;
+
+use strict;
+use base "WebFetch";
+
+use Carp;
+use Template;
+
+# define exceptions/errors
+use Exception::Class (
+ "WebFetch::Output::TT::Exception::Template" => {
+ isa => "WebFetch::TracedException",
+ alias => "throw_template",
+ description => "error during template processing",
+ },
+
+);
+
+
+# set defaults
+
+our @Options = ( "template=s", "tt_include:s" );
+our $Usage = "--template template-file [--tt_include include-path]";
+
+# no user-servicable parts beyond this point
+
+# register capabilities with WebFetch
+__PACKAGE__->module_register( "cmdline", "output:tt" );
+
+# Perl Template Toolkit format handler
+sub fmt_handler_tt
+{
+ my $self = shift;
+ my $filename = shift;
+ my $output;
+
+ # configure and create template object
+ my %tt_config = (
+ ABSOLUTE => 1,
+ RELATIVE => 1,
+ );
+ if ( exists $self->{tt_include}) {
+ $tt_config{INCLUDE_PATH} = $self->{tt_include}
+ }
+ my $template = Template->new( \%tt_config );
+
+ # process template
+ my $result = $template->process( $self->{template}, $self->{data},
+ \$output );
+
+ $result or throw_template ( $template->error());
+
+ $self->raw_savable( $filename, $output );
+ 1;
+}
+
+1;
+__END__
+# POD docs follow
+
+=head1 NAME
+
+WebFetch::Output::TT - save data via the Perl Template Toolkit
+
+=head1 SYNOPSIS
+
+In perl scripts:
+
+C<use WebFetch::Output::TT;>
+
+From the command line:
+
+C<perl -w -MWebFetch::Output::TT -e "&fetch_main" -- --dir directory
+ --dest_format tt --dest dest-path [...WebFetch output options...]>
+
+=head1 DESCRIPTION
+
+This module saves output via the Perl Template Toolkit.
+
+TODO: add description
+
+=head1 AUTHOR
+
+WebFetch was written by Ian Kluft
+Send patches, bug reports, suggestions and questions to
+C<ma...@we...>.
+
+=head1 SEE ALSO
+
+=for html
+<a href="WebFetch.html">WebFetch</a>
+
+=for text
+WebFetch
+
+=for man
+WebFetch
+
+=cut
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
