Merge branch 'devel'
[videosite.git] / videosite-irssi.pl
diff --git a/videosite-irssi.pl b/videosite-irssi.pl
new file mode 100644 (file)
index 0000000..043cc93
--- /dev/null
@@ -0,0 +1,296 @@
+# shim to connect libvideosite to irssi
+#
+# (c) 2007-2008 by Ralf Ertzinger <ralf@camperquake.de>
+# licensed under GNU GPL v2
+use strict;
+use Irssi 20020324 qw (command_bind command_runsub signal_add_first signal_add_last);
+use vars qw($VERSION %IRSSI);
+use File::Spec;
+use Module::Load;
+use XML::Simple;
+use JSON -support_by_pp;
+use Carp;
+
+$SIG{ __DIE__ } = sub { Carp::confess( @_ ) };
+
+#
+# List of foreground colors. This list is not complete, it just
+# contains the colors needed by videosite.
+#
+# The % are doubled because these are used in sprintf.
+#
+my %foreground_colors = (
+    'magenta'   => '%%m',
+    '*magenta'  => '%%M',
+    '*yellow'   => '%%Y',
+    '*green'    => '%%G',
+    '*red'      => '%%R',
+    'default'   => '%%n',
+);
+
+#
+# This is a canary value used in the config system as the default
+# value. As irssi does not have a way to test if a setting exists
+# this is used instead. A config value is never expected to be set
+# to this value and be valid.
+#
+my $config_canary = "\1";
+
+#
+# Initialize the config subsystem. Called by the core.
+#
+# Due to historic reasons this has to deal with a number of possible config sources:
+# * irssi internal config
+# * JSON config, old format
+# * XML config, old format
+#
+# JSON and XML configs are parsed, converted and moved to the irssi internal
+# format. This happens only once, as the config search stops with the first
+# format found
+#
+sub config_init {
+    my $xmlconffile = File::Spec->catfile(Irssi::get_irssi_dir(), 'videosite.xml');
+    my $conffile = File::Spec->catfile(Irssi::get_irssi_dir(), 'videosite.json');
+    my $conf;
+
+    # Check for irssi internal config. If not found...
+    if (config_has(['config-version'])) {
+        # Configuration in irssi config file. We're done.
+        return;
+    }
+
+    # Try to find old config files and load them.
+    if (-r $conffile) {
+        Irssi::print("Converting configuration from videosite.json. This will happen only once.");
+        eval {
+            local $/;
+            open(CONF, '<', $conffile);
+            $conf = JSON->new->utf8->decode(<CONF>);
+            close(CONF);
+        };
+    } elsif (-r $xmlconffile) {
+        Irssi::print("Converting configuration from videosite.xml. This will happen only once.");
+        $conf = XML::Simple::XMLin($xmlconffile, ForceArray => ['config', 'option', 'connectorlist'], KeepRoot => 1, KeyAttr => {'connector' => '+name', 'config' => 'module', 'option' => 'key'});
+    } else {
+        # No old config files around. Just exit.
+        return;
+    }
+
+    #
+    # Configuration conversion:
+    # Replace this structure:
+    #
+    # key => {
+    #   content => value
+    # }
+    #
+    # with this structure
+    #
+    # key => value
+    #
+    Irssi::print("Converting configuration, stage 1");
+
+    # Only the getter/grabbers have this, so just check that part of the config
+    foreach my $g (keys(%{$conf->{videosite}->{config}})) {
+        foreach (keys(%{$conf->{videosite}->{config}->{$g}->{option}})) {
+            if (exists($conf->{videosite}->{config}->{$g}->{option}->{$_}->{content})) {
+                $conf->{videosite}->{config}->{$g}->{option}->{$_} = $conf->{videosite}->{config}->{$g}->{option}->{$_}->{content};
+            }
+        }
+    }
+
+    #
+    # Walk the configuration hash, creating irssi config entries for
+    # each leaf node.
+    #
+    # Some config values changed, so not the entire config is copied over.
+    # There is a helper function for this in libvideosite that we're using.
+    #
+    Irssi::print("Converting configuration, stage 2");
+
+    # Copy the "basic" settings.
+    foreach (qw(getter mode)) {
+        config_set([$_], $conf->{videosite}->{$_});
+    }
+
+    # Copy the per-getter/setter settings
+    foreach my $g (keys(%{$conf->{videosite}->{config}})) {
+        foreach (keys(%{$conf->{videosite}->{config}->{$g}->{option}})) {
+            config_set(['plugin', $g, $_], $conf->{videosite}->{config}->{$g}->{option}->{$_});
+        }
+    }
+
+    # Copy the connectors. The connectors themselves are copied as-is,
+    # the list of active connectors is copied under a different name,
+    # and a list of all existing connectors is created
+    my @connectors;
+
+    foreach my $c (keys(%{$conf->{videosite}->{connectors}})) {
+        push(@connectors, $c);
+        config_set(['connectors', $c, 'name'], $conf->{videosite}->{connectors}->{$c}->{name});
+        if (exists($conf->{videosite}->{connectors}->{$c}->{_immutable})) {
+            config_set(['connectors', $c, '_immutable'], $conf->{videosite}->{connectors}->{$c}->{_immutable});
+        }
+        foreach (qw(http https)) {
+            if (exists($conf->{videosite}->{connectors}->{$c}->{schemas}->{http})) {
+                config_set(['connectors', $c, 'schemas', $_], $conf->{videosite}->{connectors}->{$c}->{schemas_}->{$_});
+            }
+        }
+    }
+    config_set(['active-connectors'], join(",", @{$conf->{videosite}->{connectorlist}}));
+    config_set(['defined-connectors'], join(",", @connectors));
+    config_set(['config-version'], '2');
+}
+
+#
+# Reading a configuration value. Called by the core
+#
+sub config_get {
+    my $path = shift;
+    my $item = join('.', 'videosite', @{$path});
+    my $val;
+
+
+    Irssi::settings_add_str('videosite', $item, $config_canary);
+    $val = Irssi::settings_get_str($item);
+
+    return ($val ne $config_canary)?$val:undef;
+}
+
+#
+# Returns a true value if the config item exists
+#
+sub config_has {
+    my $path = shift;
+    my $item = join('.', 'videosite', @{$path});
+
+    Irssi::settings_add_str('videosite', $item, $config_canary);
+    return Irssi::settings_get_str($item) ne $config_canary;
+}
+
+#
+# Setting a configuration value. Called by the core
+#
+sub config_set {
+    my $path = shift;
+    my $value = shift;
+    my $item = join('.', 'videosite', @{$path});
+
+    Irssi::settings_add_str('videosite', $item, $config_canary);
+    Irssi::settings_set_str($item, $value);
+}
+
+#
+# Delete a configuration value. Called by the core.
+#
+# Now, according to the configuration Irssi::settings_remove() removes a
+# config settings. This does not work in any irssi version available to me.
+# So just set the key to the canary value.
+#
+sub config_del {
+    my $path = shift;
+
+    config_set($path, $config_canary);
+}
+
+#
+# Return a color code. Called by the core
+#
+# Does not handle background colors yet.
+#
+sub colorpair {
+    my ($fg, $bg) = @_;
+
+    $fg = exists($foreground_colors{$fg})?$foreground_colors{$fg}:'';
+    $bg = '';
+
+    return $fg . $bg;
+}
+
+#
+# Handle commands (/videosite ...)
+#
+sub videosite_hook {
+    my ($cmdline, $server, $witem) = @_;
+    my %event = (
+        message => $cmdline,
+        io => sub { defined($witem)?$witem->print($_[0], MSGLEVEL_CLIENTCRAP):Irssi::print($_[0]) },
+        window => defined($witem)?$witem->{server}->{real_address} . "/" . $witem->{name}:"",
+    );
+
+    libvideosite::handle_command(\%event);
+}
+
+#
+# Handle a received message
+# Create an event structure and hand it off to libvideosite
+#
+sub message_hook {
+    my ($server, $msg, $nick, $userhost, $channel) = @_;
+    my $witem = $server->window_item_find($channel);
+    my %event = (
+        message => $msg,
+        io => sub { defined($witem)?$witem->print($_[0], MSGLEVEL_CLIENTCRAP):Irssi::print($_[0]) },
+        window => defined($witem)?$witem->{server}->{real_address} . "/" . $witem->{name}:"",
+    );
+
+    libvideosite::check_for_link(\%event);
+}
+
+sub videosite_reset {
+    my $libpath;
+
+    # Find out the script directory, and add it to @INC.
+    # This is necessary to find libvideosite.pm
+    $libpath = File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts');
+
+    # If the library is already loaded unload it
+    foreach (keys(%INC)) {
+        if ($INC{$_} eq File::Spec->catfile($libpath, 'libvideosite.pm')) {
+            delete($INC{$_});
+        }
+    }
+
+    push(@INC, $libpath);
+    load 'libvideosite';
+
+    unless(libvideosite::register_api({
+        io => sub { Irssi::print($_[0]) },
+        config_init => \&config_init,
+        config_get =>  \&config_get,
+        config_set => \&config_set,
+        config_has => \&config_has,
+        config_save => sub { 1 },
+        config_del => \&config_del,
+        color => \&colorpair,
+        module_path => sub { return File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts') },
+        quote => sub { s/%/%%/g; return $_ },
+        reload => \&videosite_reset,
+    })) {
+        Irssi::print(sprintf("videosite API register failed: %s", $libvideosite::error));
+        return 0;
+    }
+
+    unless(libvideosite::init()) {
+        Irssi::print(sprintf("videosite init failed: %s", $libvideosite::error));
+        return 0;
+    }
+
+    return 1;
+}
+
+sub videosite_init {
+
+    if (videosite_reset()) {
+        signal_add_last("message public", sub { message_hook(@_) });
+        signal_add_last("message own_public", sub { message_hook($_[0], $_[1], undef, undef, $_[2]) });
+        signal_add_last("message private", sub { message_hook($_[0], $_[1], $_[2], $_[3], $_[2]) });
+        signal_add_last("message own_private", sub { message_hook($_[0], $_[1], undef, undef, $_[2]) });
+        signal_add_last("message irc action", sub { message_hook(@_) });
+        signal_add_last("message irc own_action", sub { message_hook($_[0], $_[1], undef, undef, $_[2]) });
+
+        Irssi::command_bind('videosite', sub { videosite_hook(@_) });
+    }
+}
+
+videosite_init();