summaryrefslogtreecommitdiffstats
path: root/scripts/screen_away.pl
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/screen_away.pl')
-rw-r--r--scripts/screen_away.pl248
1 files changed, 248 insertions, 0 deletions
diff --git a/scripts/screen_away.pl b/scripts/screen_away.pl
new file mode 100644
index 0000000..199fc1a
--- /dev/null
+++ b/scripts/screen_away.pl
@@ -0,0 +1,248 @@
+use Irssi;
+use strict;
+use FileHandle;
+
+use vars qw($VERSION %IRSSI);
+
+$VERSION = "0.9.8.2";
+%IRSSI = (
+ authors => 'Andreas \'ads\' Scherbaum <ads@wars-nicht.de>',
+ name => 'screen_away',
+ description => 'set (un)away, if screen is attached/detached',
+ license => 'GPL v2',
+ url => 'none',
+);
+
+# screen_away irssi module
+#
+# written by Andreas 'ads' Scherbaum <ads@ufp.de>
+#
+# changes:
+# 20.12.2014 fix the bug when screenname is changed during the session
+# 07.02.2004 fix error with away mode
+# thanks to Michael Schiansky for reporting and fixing this one
+# 07.08.2004 new function for changing nick on away
+# 24.08.2004 fixing bug where the away nick was not storedcorrectly
+# thanks for Harald Wurpts for help debugging this one
+# 17.09.2004 rewrote init part to use $ENV{'STY'}
+# 05.12.2004 add patch for remember away state
+# thanks to Jilles Tjoelker <jilles@stack.nl>
+# change "chatnet" to "tag"
+# 18.05.2007 fix '-one' for SILC networks
+#
+#
+# usage:
+#
+# put this script into your autorun directory and/or load it with
+# /SCRIPT LOAD <name>
+#
+# there are 5 settings available:
+#
+# /set screen_away_active ON/OFF/TOGGLE
+# /set screen_away_repeat <integer>
+# /set screen_away_message <string>
+# /set screen_away_window <string>
+# /set screen_away_nick <string>
+#
+# active means, that you will be only set away/unaway, if this
+# flag is set, default is ON
+# repeat is the number of seconds, after the script will check the
+# screen status again, default is 5 seconds
+# message is the away message sent to the server, default: not here ...
+# window is a window number or name, if set, the script will switch
+# to this window, if it sets you away, default is '1'
+# nick is the new nick, if the script goes away
+# will only be used it not empty
+#
+# normal you should be able to rename the script to something other
+# than 'screen_away' (as example, if you dont like the name) by simple
+# changing the 'name' parameter in the %IRSSI hash at the top of this script
+
+
+# variables
+my $timer_name = undef;
+my $away_status = 0;
+my %old_nicks = ();
+my %away = ();
+
+# Register formats
+Irssi::theme_register(
+[
+ 'screen_away_crap',
+ '{line_start}{hilight ' . $IRSSI{'name'} . ':} $0'
+]);
+
+# if we are running
+my $screen_away_used = 0;
+
+# try to find out, if we are running in a screen
+# (see, if $ENV{STY} is set
+if (!defined($ENV{STY})) {
+ # just return, we will never be called again
+ Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'screen_away_crap',
+ "could not open status file for parent process (pid: " . getppid() . "): $!");
+ return;
+}
+
+my ($socket_pid, $socket_name, $socket_path);
+
+# search for socket
+# normal we could search the socket file, ... if we know the path
+# but so we have to call one time the screen executable
+# disable locale
+# the quotes around C force perl 5.005_03 to use the shell
+# thanks to Jilles Tjoelker <jilles@stack.nl> for pointing this out
+my $socket = `LC_ALL="C" screen -ls`;
+
+
+
+my $running_in_screen = 0;
+# locale doesnt seems to be an problem (yet)
+if ($socket !~ /^No Sockets found/s) {
+ # ok, should have only one socket
+ # $STY won't change if sessionname is changed during session
+ # therefore first find the pid and use that to find the actual sessionname
+ $socket_pid = substr($ENV{'STY'}, 0, index($ENV{'STY'}, '.'));
+ $socket_path = $socket;
+ $socket_path =~ s/^.*\d+ Sockets? in ([^\n]+)\..*$/$1/s;
+ $socket_name = $socket;
+ $socket_name =~ s/^.+?($socket_pid\.\S+).+$/$1/s;
+ if (length($socket_path) != length($socket)) {
+ # only activate, if string length is different
+ # (to make sure, we really got a dir name)
+ $screen_away_used = 1;
+ } else {
+ Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'screen_away_crap',
+ "error reading screen informations from:");
+ Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'screen_away_crap',
+ "$socket");
+ return;
+ }
+}
+
+# last check
+if ($screen_away_used == 0) {
+ # we will never be called again
+ return;
+}
+
+# build complete socket name
+$socket = $socket_path . "/" . $socket_name;
+
+# register config variables
+Irssi::settings_add_bool('misc', $IRSSI{'name'} . '_active', 1);
+Irssi::settings_add_int('misc', $IRSSI{'name'} . '_repeat', 5);
+Irssi::settings_add_str('misc', $IRSSI{'name'} . '_message', "not here ...");
+Irssi::settings_add_str('misc', $IRSSI{'name'} . '_window', "1");
+Irssi::settings_add_str('misc', $IRSSI{'name'} . '_nick', "");
+
+# init process
+screen_away();
+
+# screen_away()
+#
+# check, set or reset the away status
+#
+# parameter:
+# none
+# return:
+# 0 (OK)
+sub screen_away {
+ my ($away, @screen, $screen);
+
+ # only run, if activated
+ if (Irssi::settings_get_bool($IRSSI{'name'} . '_active') == 1) {
+ if ($away_status == 0) {
+ # display init message at first time
+ Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'screen_away_crap',
+ "activating $IRSSI{'name'} (interval: " . Irssi::settings_get_int($IRSSI{'name'} . '_repeat') . " seconds)");
+ }
+ # get actual screen status
+ my @screen = stat($socket);
+ # 00100 is the mode for "user has execute permissions", see stat.h
+ if (($screen[2] & 00100) == 0) {
+ # no execute permissions, Detached
+ $away = 1;
+ } else {
+ # execute permissions, Attached
+ $away = 2;
+ }
+
+ # check if status has changed
+ if ($away == 1 and $away_status != 1) {
+ # set away
+ if (length(Irssi::settings_get_str($IRSSI{'name'} . '_window')) > 0) {
+ # if length of window is greater then 0, make this window active
+ Irssi::command('window goto ' . Irssi::settings_get_str($IRSSI{'name'} . '_window'));
+ }
+ Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'screen_away_crap',
+ "Set away");
+ my $message = Irssi::settings_get_str($IRSSI{'name'} . '_message');
+ if (length($message) == 0) {
+ # we have to set a message or we wouldnt go away
+ $message = "not here ...";
+ }
+ my ($server);
+ foreach $server (Irssi::servers()) {
+ if (!$server->{usermode_away}) {
+ # user isnt yet away
+ $away{$server->{'tag'}} = 0;
+ $server->command("AWAY " . (($server->{chat_type} ne 'SILC') ? "-one " : "") . "$message") if (!$server->{usermode_away});
+ if (length(Irssi::settings_get_str($IRSSI{'name'} . '_nick')) > 0) {
+ # only change, if actual nick isnt already the away nick
+ if (Irssi::settings_get_str($IRSSI{'name'} . '_nick') ne $server->{nick}) {
+ # keep old nick
+ $old_nicks{$server->{'tag'}} = $server->{nick};
+ # set new nick
+ $server->command("NICK " . Irssi::settings_get_str($IRSSI{'name'} . '_nick'));
+ }
+ }
+ } else {
+ # user is already away, remember this
+ $away{$server->{'tag'}} = 1;
+ }
+ }
+ $away_status = $away;
+ } elsif ($away == 2 and $away_status != 2) {
+ # unset away
+ Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'screen_away_crap',
+ "Reset away");
+ my ($server);
+ foreach $server (Irssi::servers()) {
+ if ($away{$server->{'tag'}} == 1) {
+ # user was already away, dont reset away
+ $away{$server->{'tag'}} = 0;
+ next;
+ }
+ $server->command("AWAY" . (($server->{chat_type} ne 'SILC') ? " -one" : "")) if ($server->{usermode_away});
+ if (defined($old_nicks{$server->{'tag'}}) and length($old_nicks{$server->{'tag'}}) > 0) {
+ # set old nick
+ $server->command("NICK " . $old_nicks{$server->{'tag'}});
+ $old_nicks{$server->{'tag'}} = "";
+ }
+ }
+ $away_status = $away;
+ }
+ }
+ # but everytimes install a new timer
+ register_screen_away_timer();
+ return 0;
+}
+
+# register_screen_away_timer()
+#
+# remove old timer and install a new one
+#
+# parameter:
+# none
+# return:
+# none
+sub register_screen_away_timer {
+ if (defined($timer_name)) {
+ # remove old timer, if defined
+ Irssi::timeout_remove($timer_name);
+ }
+ # add new timer with new timeout (maybe the timeout has been changed)
+ $timer_name = Irssi::timeout_add(Irssi::settings_get_int($IRSSI{'name'} . '_repeat') * 1000, 'screen_away', '');
+}
+