Notifikace pro irssi

22.3.2012 01:00 | Přečteno: 1121×

Máte nějaké upozornění na nové zprávy ? Já už ano.

Už je tomu pár let, kdy ke komunikaci používám protokol IRC. Po většinu času jsem k tomuto účelu používal program XChat, ale během posledního půl roku jsem přešel ke konzolové aplikaci irssi. Ta se mi okamžitě zalíbila, ale hrozně mi vadila jedna věc. Nemohl jsem přijít na to, jakým způsobem vyřešit upozornění na nové zprávy.

Abych věci uvedl na pravou míru. Většině z nás statusbar v irssi zobrazuje čísla oken rozlišená barvičkami. Podle toho lze poznat, zda se v okně něco stalo, někdo napsal, nebo nám zde došla soukromá zpráva. Zdálo by se tedy, že nic dalšího nebude potřeba, jenže tohle přece není jediná aplikace, kterou používáme. Pokud tedy nemáme dostatečně velký monitor na to, abychom mohli mít irssi neustále zobrazené (jakože na notebooku máme asi smůlu), statusbar neuvidíme a co teď ? Mě osobně irssi běží ve screenu, ke kterému často ani není žádný emulátor terminálu připojen. O nových zprávách bych samozřejmě rád věděl co nejdříve a křišťálovou kouli nemám, takže jsem se musel zamyslet nad možným řešením.

Co jsem zkoušel a vyloučil

Nejprimitivnějším způsobem upozornění je zřejmě notify-send. Je to taková bublinka s textem, která vám vyskočí obvykle někde v rohu obrazovky. Každý ji určitě někdy viděl, ale pokud nevíte o čem mluvím, zkuste si příkaz notify-send Ahoj a hned vám bude vše jasné. Podle výsledků googlu toho využívá většina lidí, ale podle mě je to absolutně nepoužitelné. Při práci to musí děsně rušit a pokud vám dojde více zpráv za sebou, máte najednou skrytou půlku obrazovky. Další problém je, že okýnko po pár sekundách zmizí a pokud nejste u počítače v okamžik, kdy zpráva přijde, stejně máte smůlu. Podobně je na tom notifikace přehráním zvukového signálu. Podle mě nesmysl. Nevím jak vy, ale mě buďto hraje hudba, nebo mám mute. Dále jsem našel upozornění pro dzen2, ale to se mi taky nezdálo příliš vyhovující. Nejedná se totiž o upozornění jako takové, ale pouze o log, ve kterém se mohu dozvědět, kdo mi napsal naposled a co. Někomu vyhovuje, někomu ne, rozhodně to nikomu neberu. Podařilo se mi najít pár dalších návodů / skriptů, které měli podobný výsledek jako zmíněné varianty, ale ty jsem si ani neukládal.

Mé řešení

Divil jsem se, že nic z toho co jsem našel nesplňovalo mou představu. Přitom jsem neměl téměř žádná kritéria. Chtěl jsem vlastně jedinou věc a to kdykoliv se podívám do svého statusbaru (mám všechny důležité informace vypsané v okýnku dzen2, které je vždy vidět), budu jednoznačně vidět informaci ANO mám nepřečtenou zprávu, nebo NE nemám nepřečtenou zprávu. Připadá vám, že jsem toho chtěl zas tak moc?

Jsem sice děsný bastlič, ale rozhodl jsem se spíchnout si skriptík, který to obstará. Jedná se o plugin pro irssi, jež ukládá do textového souboru seznam kanálů, na které vám přišla soukromá zpráva. Po přesunutí do takového kanálu, bude ze se seznamu odstraněn. Můžete si tedy nechat vypisovat seznam kanálů, celkový počet kanálů, hodnotu 1, nebo 0 do vašich statusbarů. Navíc je při nové zprávě oknu s irssi přidělena určitá „důležitost“ (v xmonadu se tomu tuším říká urgency). Tady záleží na tom, co používáte za window manager, případně taskbar. U mě v openboxu začne lehce blikat rámeček okna a vykreslí se červený rámeček kolem ikonky v tint2. Koukal jsem ve virtuálce na KDE4 a tam se to chová obdobně. Ostatní prostředí není v mých silách vyzkoušet a proto se můžete podělit, jak se to chová u vás.

V TODO listu mám jedinou věc, ale zatím bohužel nevím jak se s ní vypořádat. Kdyby někdo tuto funkcičku dopsal, nebo mě nějak popostrčil, budu jedině rád. Problém je, pokud privátní zpráva dojde do aktuálně zobrazeného okna v irssi, ale terminál s irssi přitom není aktivní okno ve window manageru. V tomto případě se název kanálu se zprávou nezapíše do výstupního souboru. Je samozřejmě jednoduché jej zapsat, jenže absolutně nevím na jakou událost jej z výstupního souboru vymazat.

Pokud se někdo rozhodnete vyzkoušet, pište prosím poznámky, připomínky, případně chyby na které narazíte. Po dokončení bych rád skriptík uveřejnil mezi ostatními na http://scripts.irssi.org/ .

#!/usr/bin/perl
#
## Description
#   This script makes notifications for your irssi. It writes names of
#   highlighted channels (somebody said your name, query, ..) to
#   pipe file. Easily you can display name of this channels or count
#   of them in your dzen, conky or other notification bars.
#
## Usage
#   Move this file into ~/.irssi/scripts
#   Set variables $irssi_xwindow and $pipe_file
#   Create file located in $pipe_file
#   Install wmctrl tool (homepage http://tomas.styblo.name/wmctrl/)
#   Load this script into irssi by /script load notify.pl
#
## License
#   This program is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#

$VERSION = "0.1";

%IRSSI =
(
	authors     => 'FrostyX [Jakub Kadlčík]',
	contact     => 'frostyx@email.cz',
	name        => 'notify.pl',
	license     => 'GNU General Public License'
);

# Name of terminal emulator window with irssi
# You can find this name using command xprop and click on window
my $irssi_xwindow = 'irssi';

# In this file will be located names of highlighted channels
# There is separator \n (newline) between names
my $pipe_file = '/tmp/irssi_pipe';

# Use packages
use strict;
use Irssi;
use POSIX;
use vars qw($VERSION %IRSSI);

# Hooks
Irssi::signal_add('print text', 'notify');
Irssi::signal_add('window changed', 'read');

# This function captures all highlighted messages
# @return void
# @args WINDOW_REC, char *, char *
sub notify()
{
	my ($dest, $text, $stripped) = @_;
	my $server = $dest->{server};
	my $window = Irssi::active_win()->{active}; # Active window

	# Return if message isn't highlighted or query
	return if (!(($dest->{level} & MSGLEVEL_HILIGHT) || ($dest->{level} & MSGLEVEL_MSGS)));

	setWindowUrgency();

	# Return if message is on active irssi window
	return if (lc $window->{name} eq lc $dest->{target});

	# Write highlighted channel to pipe
	writeWindow($dest->{target}.'@'.$dest->{server}->{address});
}

# When we display channel with highlighted message, function will remove
#    this channel from pipe
# @return void
sub read()
{
	my $window = Irssi::active_win()->{active}; # Active window
	if($window->{data_level} == 3) # If window is highlighted
	{
		# Remove "dehighlighted" channel from pipe
		removeWindow($window->{name}.'@'.$window->{server}->{address});
	}
}

# Function will remove name of channel from pipe
# @return void
# @args string
sub removeWindow()
{
	my ($window) = @_;
	my @chans = getHighlightedWindows(); # All names of channels in pipe
	my $newString = '';

	# Generate new string of channels without channel from argument
	foreach(@chans)
	{
		if($_ ne $window) # If it isn't channel from argument
		{
			$newString .= $_."\n"; # \n is separator between names
		}
	}
	open FILE, ">", $pipe_file; # Write instead of current text in file
	print FILE $newString;
	close(FILE);
}

# Function will write name of channel to pipe
# @return void
# @args string
sub writeWindow()
{
	my ($window) = @_;
	my @chans = getHighlightedWindows(); # All names of channels in pipe

	foreach(@chans)
	{
		# Return if we already have message on given channel
		return if($_ eq $window);
	}
	open FILE, ">>", $pipe_file; # Write on end of file
	print FILE $window."\n"; # \n is separator between names
	close(FILE);
}

# Function will return array of channels found in pipe
# @return string[]
sub getHighlightedWindows()
{
	open FILE, $pipe_file;
	my $strchans = '';

	# Save all file into string
	while (my $result = <FILE>) {
		#chomp($result); # Remove newline character
		$strchans .= $result;
	}
	close(FILE);

	# Split string into array
	my @chans = split("\n", $strchans);
	return @chans;
}

# Returns name of active window in X11
# @return string
sub getActiveXWindow()
{
	my $win = `echo -n \$(wmctrl -l | grep -E '^0x0*'\$(xprop -root | grep "_NET_ACTIVE_WINDOW(WINDOW)"  | awk -F ' window id # 0x' '{print \$2}') | awk '{for (i=4;i<=NF;i++) {printf "%s%s",sep,\$i;sep=" "}}')`;
	return $win;
}

# Return true if terminal emulator with irssi is active window
# @return bool
sub isIrssiXActive()
{
	return getActiveXWindow() eq $irssi_xwindow ? 1 : 0;
}

# Sets urgency (attention) to terminal emulator with irssi
# If you do not want notification via urgency, just type return 0;
#    above the system call
# @return void
sub setWindowUrgency()
{
	system("wmctrl -r $irssi_xwindow -b add,demands_attention");
}

# EOF

Jak pracovat s výstupním souborem

Cestu k souboru si změňte dle libosti

Počet kanálů, kde mě shánějí

cat /tmp/irssi_pipe | wc -l |tr -d '\n'

Informace zda mám novou zprávu, aneb ANO/NE

[ -s /tmp/irssi_pipe ] && echo 1 || echo 0

       

Komentáře