Difference between revisions of "Irssi-otr"

From ArchWiki
Jump to: navigation, search
m (A few additions.)
(Move the About sentence to the introduction)
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Internet and Email (English)]]
+
[[Category:Internet Applications]]
[[Category:HOWTOs (English)]]
+
[[Category:Internet Relay Chat]]
 
+
=About=
+
 
+
 
The [http://irssi-otr.tuxfamily.org/ irssi-otr] module brings
 
The [http://irssi-otr.tuxfamily.org/ irssi-otr] module brings
 
[http://www.cypherpunks.ca/otr/ Off-the-Record Messaging] to your
 
[http://www.cypherpunks.ca/otr/ Off-the-Record Messaging] to your
 
[http://irssi.org/ favorite IRC client].
 
[http://irssi.org/ favorite IRC client].
  
=Installing=
+
==Installing==
  
 
You can install the Irssi OTR module from the
 
You can install the Irssi OTR module from the
[http://aur.archlinux.org/packages.php?ID=19488 AUR].
+
[https://aur.archlinux.org/packages.php?ID=19488 AUR].
 
If you like to test bleeding edge software, there is also a
 
If you like to test bleeding edge software, there is also a
[http://aur.archlinux.org/packages.php?ID=23366 Git version].
+
[https://aur.archlinux.org/packages.php?ID=23366 Git version].
  
=Usage=
+
==Usage==
  
 
See the
 
See the
 
[http://git.tuxfamily.org/irssiotr/irssiotr.git?p=gitroot/irssiotr/irssiotr.git;a=blob_plain;f=README;hb=HEAD README].
 
[http://git.tuxfamily.org/irssiotr/irssiotr.git?p=gitroot/irssiotr/irssiotr.git;a=blob_plain;f=README;hb=HEAD README].
  
=Loading the module on startup=
+
==Loading the module on startup==
  
If you are tired of typing <tt>/LOAD otr</tt> you can put the following
+
If you are tired of typing {{Ic|/LOAD otr}} you can put the following
in your <tt>~/.irssi/startup</tt>:
+
in your {{Ic|~/.irssi/startup}}:
  
 
  LOAD otr
 
  LOAD otr
  
=Finishing OTR conversations on /QUIT=
+
==Stripping HTML==
  
If <tt>otr_finishonunload</tt> is set irssi-otr will finish all your
+
If you are using irssi-otr with [[Bitlbee | BitlBee]] you will notice
OTR conversations when the module is unloaded.  However when you
+
that some clients send you HTML formatted messages.  Normally BitlBee
<tt>/QUIT</tt>, Irssi disconnects from the IRC networks first and
+
unloads its modules afterwards.  Of course this will prevent your OTR
+
conversations form being finished correctly.  To circumvent this you
+
can define the following alias:
+
 
+
/ALIAS quit unload otr; quit
+
 
+
=Stripping HTML=
+
 
+
If you use irssi-otr with [[Bitlbee | BitlBee]] you will notice that
+
some clients send you HTML formatted messages.  Normally BitlBee
+
 
automatically strips the HTML formatting, but since the messages are
 
automatically strips the HTML formatting, but since the messages are
 
encrypted this doesn't work anymore.  Nevertheless you can achieve
 
encrypted this doesn't work anymore.  Nevertheless you can achieve
Line 47: Line 33:
 
[http://wouter.coekaerts.be/site/irssi/trigger Trigger script].  Just make
 
[http://wouter.coekaerts.be/site/irssi/trigger Trigger script].  Just make
 
sure you load the script before the otr module.  You can either do this
 
sure you load the script before the otr module.  You can either do this
manually or again make your <tt>~/.irssi/startup</tt> look like this:
+
manually or again make your {{Ic|~/.irssi/startup}} look like this:
  
 
  SCRIPT LOAD trigger.pl
 
  SCRIPT LOAD trigger.pl
 
  LOAD otr
 
  LOAD otr
  
Also make sure that trigger.pl is not in <tt>~/.irssi/scripts/autorun</tt>
+
Also make sure that {{Ic|trigger.pl}} is not in
since the files from this directory are loaded after
+
{{Ic|~/.irssi/scripts/autorun}} since the files from this directory
<tt>~/.irssi/startup</tt>.
+
are loaded after {{Ic|~/.irssi/startup}}.
  
 
Since it is not possible to perfectly match HTML code with regular
 
Since it is not possible to perfectly match HTML code with regular
Line 61: Line 47:
 
network, where we assume you added you server.
 
network, where we assume you added you server.
  
/TRIGGER ADD -privmsgs -nocase -tags 'BitlBee' -regexp '</?(a|b|body|div|em|font|i|s|u)( +\w+=".*?")*>' -replace ''  
+
You can {{Ic|/TRIGGER add}} the following lines or copy them to
 +
{{Ic|~/.irssi/triggers}}.
 +
 
 +
<pre>
 +
-privmsgs -nocase -tags 'BitlBee' -regexp '</?(a|b|body|div|em|font|i|s|u)( +\w+=".*?")*>' -replace ''  
 +
</pre>
 +
 
 +
You can even make HTML line breaks look like multiple messages:
 +
 
 +
-privmsgs -nocase -tags 'BitlBee' -regexp '(\s*&lt;br&gt;\s*)+' -replace '\n�8/<�g�</$N�8/>�g �e'
 +
 
 +
Where {{Ic|�}} is the non-printable character {{Ic|^D}}.  In vi(m)
 +
you can get it by pressing {{Ic|Ctrl-v Ctrl-d}} in insert mode.
 +
If your are using a theme different than the default one you probably
 +
have to adapt the replacing string to match color and indentation.
 +
 
 +
And finally we convert some escaped HTML characters:
  
And finally convert some escaped HTML characters:
+
-privmsgs -nocase -tags 'BitlBee' -regexp '&amp;amp;' -replace '&'
 +
-privmsgs -nocase -tags 'BitlBee' -regexp '&amp;gt;' -replace '>'
 +
-privmsgs -nocase -tags 'BitlBee' -regexp '&amp;lt;' -replace '<'
 +
-privmsgs -nocase -tags 'BitlBee' -regexp '&amp;quot;' -replace '"'
  
/TRIGGER ADD -privmsgs -nocase -tags 'BitlBee' -regexp '&amp;amp;' -replace '&'
+
These are just some basic replaces, just extend them if you need more.
/TRIGGER ADD -privmsgs -nocase -tags 'BitlBee' -regexp '&amp;gt;' -replace '>'
+
/TRIGGER ADD -privmsgs -nocase -tags 'BitlBee' -regexp '&amp;lt;' -replace '<'
+
/TRIGGER ADD -privmsgs -nocase -tags 'BitlBee' -regexp '&amp;quot;' -replace '"'
+
  
 
<!--
 
<!--
 
vim: filetype=Wikipedia nowrap spell spelllang=en
 
vim: filetype=Wikipedia nowrap spell spelllang=en
 
-->
 
-->

Revision as of 03:06, 30 October 2013

The irssi-otr module brings Off-the-Record Messaging to your favorite IRC client.

Installing

You can install the Irssi OTR module from the AUR. If you like to test bleeding edge software, there is also a Git version.

Usage

See the README.

Loading the module on startup

If you are tired of typing /LOAD otr you can put the following in your ~/.irssi/startup:

LOAD otr

Stripping HTML

If you are using irssi-otr with BitlBee you will notice that some clients send you HTML formatted messages. Normally BitlBee automatically strips the HTML formatting, but since the messages are encrypted this doesn't work anymore. Nevertheless you can achieve the same by stripping the HTML with regular expressions using the Trigger script. Just make sure you load the script before the otr module. You can either do this manually or again make your ~/.irssi/startup look like this:

SCRIPT LOAD trigger.pl
LOAD otr

Also make sure that trigger.pl is not in ~/.irssi/scripts/autorun since the files from this directory are loaded after ~/.irssi/startup.

Since it is not possible to perfectly match HTML code with regular expressions we will take a somewhat conservative approach. We will only strip HTML tags we explicitly specified from PRIVMSGS from the BitlBee network, where we assume you added you server.

You can /TRIGGER add the following lines or copy them to ~/.irssi/triggers.

-privmsgs -nocase -tags 'BitlBee' -regexp '</?(a|b|body|div|em|font|i|s|u)( +\w+=".*?")*>' -replace '' 

You can even make HTML line breaks look like multiple messages:

-privmsgs -nocase -tags 'BitlBee' -regexp '(\s*<br>\s*)+' -replace '\n�8/<�g�</$N�8/>�g �e' 

Where is the non-printable character ^D. In vi(m) you can get it by pressing Ctrl-v Ctrl-d in insert mode. If your are using a theme different than the default one you probably have to adapt the replacing string to match color and indentation.

And finally we convert some escaped HTML characters:

-privmsgs -nocase -tags 'BitlBee' -regexp '&amp;' -replace '&' 
-privmsgs -nocase -tags 'BitlBee' -regexp '&gt;' -replace '>' 
-privmsgs -nocase -tags 'BitlBee' -regexp '&lt;' -replace '<' 
-privmsgs -nocase -tags 'BitlBee' -regexp '&quot;' -replace '"' 

These are just some basic replaces, just extend them if you need more.