* Move files to trunk

1 files changed, 233 insertions, 0 deletions

diff --git a/lib/XXV/OUTPUT/NEWS/RSS.pm b/lib/XXV/OUTPUT/NEWS/RSS.pm
new file mode 100644
index 0000000..82cdbd4
--- /dev/null
+++ b/lib/XXV/OUTPUT/NEWS/RSS.pm
@@ -0,0 +1,233 @@
+package XXV::OUTPUT::NEWS::RSS;
+use strict;
+
+use Tools;
+use POSIX qw(locale_h);
+use Locale::gettext;
+
+# News Modules have only three methods
+# init - for intervall or others
+# send - send the informations
+# read - read the news and parse it
+
+# This module method must exist for XXV
+# ------------------
+sub module {
+# ------------------
+    my $obj = shift || return error ('No Object!' );
+    my $args = {
+        Name => 'NEWS::RSS',
+        Prereq => {
+            'XML::RSS' => 'SMTP Protocol module to connect and send emails',
+        },
+        Description => gettext('This NEWS module generate an RSS Newsfeed for your rss reader.'),
+        Version => '0.01',
+        Date => '31.09.2005',
+        Author => 'xpix',
+        Preferences => {
+            active => {
+                description => gettext('Activate this service'),
+                default     => 'y',
+                type        => 'confirm',
+                required    => gettext('This is required!'),
+                check       => sub {
+                    my $value = shift;
+                    my $erg = $obj->init
+                        or return error('Problem to initialize news module')
+                            if($value eq 'y' and not exists $obj->{INITE});
+                    return $value;
+                },
+            },
+            level => {
+                description => gettext('Minimum level of the messages which can be displayed (1 ... 100)'),
+                default     => 1,
+                type        => 'integer',
+                required    => gettext('This is required!'),
+                check       => sub {
+                    my $value = int(shift) || 0;
+                    unless($value >= 1 and $value <= 100) {
+                        return undef, 'Sorry, but the value must be between 1 and 100';
+                    }
+                    return $value;
+                },
+            },
+        },
+    };
+    return $args;
+}
+
+# ------------------
+sub new {
+# ------------------
+	my($class, %attr) = @_;
+	my $self = {};
+	bless($self, $class);
+
+    # paths
+    $self->{paths} = delete $attr{'-paths'};
+
+    # host
+    $self->{host} = delete $attr{'-host'};
+
+	# who am I
+    $self->{MOD} = $self->module;
+
+    # all configvalues to $self without parents (important for ConfigModule)
+    map {
+        $self->{$_} = $attr{'-config'}->{$self->{MOD}->{Name}}->{$_} || $self->{MOD}->{Preferences}->{$_}->{default}
+    } keys %{$self->{MOD}->{Preferences}};
+
+    # Try to use the Requirments
+    map {
+        eval "use $_";
+        return panic("\nCan not load Module: $_\nPlease install this module on your System:\nperl -MCPAN -e 'install $_'") if($@);
+    } keys %{$self->{MOD}->{Prereq}};
+
+    $self->{TYP} = 'application/xhtml+xml';
+
+    # Initiat after load modules ...
+    main::after(sub{
+        # The Initprocess
+        my $erg = $self->init
+            or return error('Problem to initialize News Module');
+    }, "NEWS::RSS: Start initiate the RSS Feed ...")
+        if($self->{active} eq 'y');
+
+
+
+	return $self;
+}
+
+# ------------------
+sub init {
+# ------------------
+    my $obj = shift || return error ('No Object!' );
+    $obj->{INITE} = 1;
+
+    1;
+}
+
+# ------------------
+sub createRSS {
+# ------------------
+    my $obj = shift  || return error ('No Object!' );
+    my $ver  = shift || 1;
+    my $account = sprintf("%s@%s", $ENV{USER}, main::getModule('STATUS')->name);
+    my $url = sprintf("http://%s:%s/", $obj->{host}, main::getModule('HTTPD')->{Port});
+
+    my $rss;
+    if($ver == 1) {
+        $rss = XML::RSS->new(
+            version => '1.0',
+        ) || return error('Problem to create an RSS Object');
+
+
+        $rss->channel(
+            title        => gettext("XXV RSS 1.0"),
+            'link'         => $url,
+            description  => gettext("Important messages from your vdr/xxv"),
+            dc => {
+                date       => datum(time,'int'),
+                subject    => gettext("XXV Messages"),
+                creator    => $account,
+                language   => setlocale(POSIX::LC_MESSAGES),
+            },
+            syn => {
+                updatePeriod     => "hourly",
+                updateFrequency  => "1",
+                updateBase       => datum(time, 'int'),
+            },
+        );
+
+    } elsif($ver == 2) {
+        my $lastbuild = (exists $obj->{lastBuildDate} ? $obj->{lastBuildDate} : time);
+
+        $rss = XML::RSS->new(
+            version => '2.0',
+        ) || return error('Problem to create an RSS Object');
+
+        $rss->channel(
+            title          => gettext("XXV RSS 2.0"),
+            'link'         => $url,
+            description    => gettext("Important messages from your vdr/xxv"),
+            language       => setlocale(POSIX::LC_MESSAGES),
+            pubDate        => datum(time, 'rss'),
+            lastBuildDate  => datum($lastbuild, 'rss'),
+            managingEditor => $account,
+        );
+    }
+    $obj->{lastBuildDate} = time;
+
+    return $rss;
+}
+
+
+# ------------------
+sub send {
+# ------------------
+    my $obj = shift  || return error ('No Object!' );
+    my $vars = shift || return error ('No Vars!' );
+
+    ++$obj->{COUNT};
+
+    push(@{$obj->{STACK}}, [
+        entities($vars->{Title}),
+        entities($vars->{Url}),
+        entities($vars->{Text}),
+        datum($vars->{AddDate},'int'),
+        $vars->{LevelName},
+    ]);
+
+    lg sprintf('News RSS with nr. %d successfully send at %s', $obj->{COUNT}, scalar localtime);
+    1;
+}
+
+# ------------------
+sub read {
+# ------------------
+    my $obj = shift  || return error ('No Object!' );
+    my $vars = shift || return error ('No News!' );
+
+    return undef, lg('This function is deactivated!')
+        if($obj->{active} ne 'y');
+
+
+    $vars->{count} = ++$obj->{NEWSCOUNT};
+    $vars->{host}  = $obj->{host};
+    $vars->{port}  = main::getModule('HTTPD')->{Port};
+
+    $obj->send($vars);
+
+    return 1;
+}
+
+# ------------------
+sub req {
+# ------------------
+    my $obj = shift  || return error ('No Object!' );
+    my $params = shift || {};
+
+    return gettext('The Module NEWS::RSS is not active!')
+        if($obj->{active} ne 'y');
+
+    my $rss = $obj->createRSS($params->{version})
+        || return error('Problem to create a RSS Object!');
+
+    foreach my $entry (@{$obj->{STACK}}) {
+        my ($title, $link, $descr, $adddate, $level) = @{$entry};
+        $rss->add_item(
+            title       => $title,
+            link        => $link,
+            description => $descr,
+    		dc => {
+    				date    => $adddate,
+     				subject => $level
+            },
+        );
+    }
+
+    return $rss->as_string;
+}
+
+
+1;