source: perlwrap.pm @ 2e3b9c2

barnowl_perlaimdebianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 2e3b9c2 was 2e3b9c2, checked in by Nelson Elhage <nelhage@mit.edu>, 14 years ago
Prefer ~/.barnowlconf, if it exists.
  • Property mode set to 100644
File size: 16.6 KB
Line 
1# $Id$
2#
3# This is all linked into the binary and evaluated when perl starts up...
4#
5#####################################################################
6#####################################################################
7# XXX NOTE: This file is sourced before almost any barnowl
8# architecture is loaded. This means, for example, that it cannot
9# execute any owl commands. Any code that needs to do so, should
10# create a function wrapping it and push it onto @onStartSubs
11
12
13use strict;
14use warnings;
15
16package BarnOwl;
17
18
19BEGIN {
20# bootstrap in C bindings and glue
21    *owl:: = \*BarnOwl::;
22    bootstrap BarnOwl 1.2;
23};
24
25use lib(get_data_dir()."/lib");
26use lib($ENV{HOME}."/.owl/lib");
27
28our $configfile;
29
30if(!$configfile && -f $ENV{HOME} . "/.barnowlconf") {
31    $configfile = $ENV{HOME} . "/.barnowlconf";
32}
33$configfile ||= $ENV{HOME}."/.owlconf";
34
35# populate global variable space for legacy owlconf files
36sub _format_msg_legacy_wrap {
37    my ($m) = @_;
38    $m->legacy_populate_global();
39    return &BarnOwl::format_msg($m);
40}
41
42# populate global variable space for legacy owlconf files
43sub _receive_msg_legacy_wrap {
44    my ($m) = @_;
45    $m->legacy_populate_global();
46    return &BarnOwl::Hooks::receive_msg($m);
47}
48
49# make BarnOwl::<command>("foo") be aliases to BarnOwl::command("<command> foo");
50sub AUTOLOAD {
51    our $AUTOLOAD;
52    my $called = $AUTOLOAD;
53    $called =~ s/.*:://;
54    $called =~ s/_/-/g;
55    return &BarnOwl::command("$called ".join(" ",@_));
56}
57
58=head2 new_command NAME FUNC [{ARGS}]
59
60Add a new owl command. When owl executes the command NAME, FUNC will
61be called with the arguments passed to the command, with NAME as the
62first argument.
63
64ARGS should be a hashref containing any or all of C<summary>,
65C<usage>, or C<description> keys.
66
67=cut
68
69sub new_command {
70    my $name = shift;
71    my $func = shift;
72    my $args = shift || {};
73    my %args = (
74        summary     => undef,
75        usage       => undef,
76        description => undef,
77        %{$args}
78    );
79
80    no warnings 'uninitialized';
81    BarnOwl::new_command_internal($name, $func, $args{summary}, $args{usage}, $args{description});
82}
83
84#####################################################################
85#####################################################################
86
87package BarnOwl::Message;
88
89sub new {
90    my $class = shift;
91    my %args = (@_);
92    if($class eq __PACKAGE__ && $args{type}) {
93        $class = "BarnOwl::Message::" . ucfirst $args{type};
94    }
95    return bless {%args}, $class;
96}
97
98sub type        { return shift->{"type"}; }
99sub direction   { return shift->{"direction"}; }
100sub time        { return shift->{"time"}; }
101sub id          { return shift->{"id"}; }
102sub body        { return shift->{"body"}; }
103sub sender      { return shift->{"sender"}; }
104sub recipient   { return shift->{"recipient"}; }
105sub login       { return shift->{"login"}; }
106sub is_private  { return shift->{"private"}; }
107
108sub is_login    { return shift->login eq "login"; }
109sub is_logout   { return shift->login eq "logout"; }
110sub is_loginout { my $m=shift; return ($m->is_login or $m->is_logout); }
111sub is_incoming { return (shift->{"direction"} eq "in"); }
112sub is_outgoing { return (shift->{"direction"} eq "out"); }
113
114sub is_deleted  { return shift->{"deleted"}; }
115
116sub is_admin    { return (shift->{"type"} eq "admin"); }
117sub is_generic  { return (shift->{"type"} eq "generic"); }
118sub is_zephyr   { return (shift->{"type"} eq "zephyr"); }
119sub is_aim      { return (shift->{"type"} eq "AIM"); }
120sub is_jabber   { return (shift->{"type"} eq "jabber"); }
121sub is_icq      { return (shift->{"type"} eq "icq"); }
122sub is_yahoo    { return (shift->{"type"} eq "yahoo"); }
123sub is_msn      { return (shift->{"type"} eq "msn"); }
124sub is_loopback { return (shift->{"type"} eq "loopback"); }
125
126# These are overridden by appropriate message types
127sub is_ping     { return 0; }
128sub is_mail     { return 0; }
129sub is_personal { return shift->is_private; }
130sub class       { return undef; }
131sub instance    { return undef; }
132sub realm       { return undef; }
133sub opcode      { return undef; }
134sub header      { return undef; }
135sub host        { return undef; }
136sub hostname    { return undef; }
137sub auth        { return undef; }
138sub fields      { return undef; }
139sub zsig        { return undef; }
140sub zwriteline  { return undef; }
141sub login_host  { return undef; }
142sub login_tty   { return undef; }
143
144sub pretty_sender    { return shift->sender; }
145sub pretty_recipient { return shift->recipient; }
146
147sub delete {
148    my ($m) = @_;
149    &BarnOwl::command("delete --id ".$m->id);
150}
151
152sub undelete {
153    my ($m) = @_;
154    &BarnOwl::command("undelete --id ".$m->id);
155}
156
157# Serializes the message into something similar to the zwgc->vt format
158sub serialize {
159    my ($this) = @_;
160    my $s;
161    for my $f (keys %$this) {
162        my $val = $this->{$f};
163        if (ref($val) eq "ARRAY") {
164            for my $i (0..@$val-1) {
165                my $aval;
166                $aval = $val->[$i];
167                $aval =~ s/\n/\n$f.$i: /g;
168                $s .= "$f.$i: $aval\n";   
169            }
170        } else {
171            $val =~ s/\n/\n$f: /g;
172            $s .= "$f: $val\n";
173        }
174    }
175    return $s;
176}
177
178# Populate the annoying legacy global variables
179sub legacy_populate_global {
180    my ($m) = @_;
181    $BarnOwl::direction  = $m->direction ;
182    $BarnOwl::type       = $m->type      ;
183    $BarnOwl::id         = $m->id        ;
184    $BarnOwl::class      = $m->class     ;
185    $BarnOwl::instance   = $m->instance  ;
186    $BarnOwl::recipient  = $m->recipient ;
187    $BarnOwl::sender     = $m->sender    ;
188    $BarnOwl::realm      = $m->realm     ;
189    $BarnOwl::opcode     = $m->opcode    ;
190    $BarnOwl::zsig       = $m->zsig      ;
191    $BarnOwl::msg        = $m->body      ;
192    $BarnOwl::time       = $m->time      ;
193    $BarnOwl::host       = $m->host      ;
194    $BarnOwl::login      = $m->login     ;
195    $BarnOwl::auth       = $m->auth      ;
196    if ($m->fields) {
197        @BarnOwl::fields = @{$m->fields};
198        @main::fields = @{$m->fields};
199    } else {
200        @BarnOwl::fields = undef;
201        @main::fields = undef;
202    }
203}
204
205sub smartfilter {
206    die("smartfilter not supported for this message");
207}
208
209# Display fields -- overridden by subclasses when needed
210sub login_type {""}
211sub login_extra {""}
212sub long_sender {""}
213
214# The context in which a non-personal message was sent, e.g. a chat or
215# class
216sub context {""}
217
218# Some indicator of context *within* $self->context. e.g. the zephyr
219# instance
220sub subcontext {""}
221
222#####################################################################
223#####################################################################
224
225package BarnOwl::Message::Admin;
226
227use base qw( BarnOwl::Message );
228
229sub header       { return shift->{"header"}; }
230
231#####################################################################
232#####################################################################
233
234package BarnOwl::Message::Generic;
235
236use base qw( BarnOwl::Message );
237
238#####################################################################
239#####################################################################
240
241package BarnOwl::Message::AIM;
242
243use base qw( BarnOwl::Message );
244
245# all non-loginout AIM messages are personal for now...
246sub is_personal { 
247    return !(shift->is_loginout);
248}
249
250#####################################################################
251#####################################################################
252
253package BarnOwl::Message::Zephyr;
254
255use base qw( BarnOwl::Message );
256
257sub login_type {
258    return (shift->zsig eq "") ? "(PSEUDO)" : "";
259}
260
261sub login_extra {
262    my $m = shift;
263    return undef if (!$m->is_loginout);
264    my $s = lc($m->host);
265    $s .= " " . $m->login_tty if defined $m->login_tty;
266    return $s;
267}
268
269sub long_sender {
270    my $m = shift;
271    return $m->zsig;
272}
273
274sub context {
275    return shift->class;
276}
277
278sub subcontext {
279    return shift->instance;
280}
281
282sub login_tty { 
283    my ($m) = @_;
284    return undef if (!$m->is_loginout);
285    return $m->fields->[2];
286}
287
288sub login_host { 
289    my ($m) = @_;
290    return undef if (!$m->is_loginout);
291    return $m->fields->[0];
292}
293
294sub zwriteline  { return shift->{"zwriteline"}; }
295
296sub is_ping     { return (lc(shift->opcode) eq "ping"); }
297
298sub is_personal { 
299    my ($m) = @_;
300    return ((lc($m->class) eq "message")
301            && (lc($m->instance) eq "personal")
302            && $m->is_private);
303}
304
305sub is_mail { 
306    my ($m) = @_;
307    return ((lc($m->class) eq "mail") && $m->is_private);
308}
309
310sub pretty_sender {
311    my ($m) = @_;
312    my $sender = $m->sender;
313    my $realm = BarnOwl::zephyr_getrealm();
314    $sender =~ s/\@$realm$//;
315    return $sender;
316}
317
318sub pretty_recipient {
319    my ($m) = @_;
320    my $recip = $m->recipient;
321    my $realm = BarnOwl::zephyr_getrealm();
322    $recip =~ s/\@$realm$//;
323    return $recip;
324}
325
326# These are arguably zephyr-specific
327sub class       { return shift->{"class"}; }
328sub instance    { return shift->{"instance"}; }
329sub realm       { return shift->{"realm"}; }
330sub opcode      { return shift->{"opcode"}; }
331sub host        { return shift->{"hostname"}; }
332sub hostname    { return shift->{"hostname"}; }
333sub header      { return shift->{"header"}; }
334sub auth        { return shift->{"auth"}; }
335sub fields      { return shift->{"fields"}; }
336sub zsig        { return shift->{"zsig"}; }
337
338#####################################################################
339#####################################################################
340################################################################################
341package BarnOwl;
342
343################################################################################
344# Mainloop hook
345################################################################################
346
347our $shutdown;
348$shutdown = 0;
349our $reload;
350$reload = 0;
351
352#Run this on start and reload. Adds modules
353sub onStart
354{
355    _load_owlconf();
356    reload_init();
357    loadModules();
358}
359################################################################################
360# Reload Code, taken from /afs/sipb/user/jdaniel/project/owl/perl
361################################################################################
362sub reload_hook (@)
363{
364    BarnOwl::Hooks::startup();
365    return 1;
366}
367
368sub reload
369{
370    # Use $reload to tell modules that we're performing a reload.
371  {
372      local $reload = 1;
373      BarnOwl::mainloop_hook() if *BarnOwl::mainloop_hook{CODE};
374  }
375   
376  @BarnOwl::Hooks::onMainLoop = ();
377  @BarnOwl::Hooks::onStartSubs = ();
378
379  # Do reload
380  package main;
381  if (-r $BarnOwl::configfile) {
382      undef $@;
383      do $BarnOwl::configfile;
384      BarnOwl::error("Error reloading $BarnOwl::configfile: $@") if $@;
385  }
386  BarnOwl::reload_hook(@_);
387  package BarnOwl;
388}
389
390sub reload_init () 
391{
392    BarnOwl::command('alias reload perl BarnOwl::reload()');
393    BarnOwl::command('bindkey global "C-x C-r" command reload');
394}
395
396################################################################################
397# Loads modules from ~/.owl/modules and owl's data directory
398################################################################################
399
400sub loadModules () {
401    my @modules;
402    my $rv;
403    foreach my $dir ( BarnOwl::get_data_dir() . "/modules",
404                      $ENV{HOME} . "/.owl/modules" )
405    {
406        opendir( MODULES, $dir );
407
408        # source ./modules/*.pl
409        @modules = sort grep( /\.pl$/, readdir(MODULES) );
410
411        foreach my $mod (@modules) {
412            unless ($rv = do "$dir/$mod") {
413                BarnOwl::error("Couldn't load $dir/$mod:\n $@") if $@;
414                BarnOwl::error("Couldn't run $dir/$mod:\n $!") unless defined $rv;
415            }
416        }
417        closedir(MODULES);
418    }
419}
420
421sub _load_owlconf {
422    # Only do this the first time
423    return if $BarnOwl::reload;
424    # load the config  file
425    if ( -r $BarnOwl::configfile ) {
426        undef $@;
427        do $BarnOwl::configfile;
428        die $@ if $@;
429    }
430}
431
432package BarnOwl::Hooks;
433
434# Arrays of subrefs to be called at specific times.
435our @onStartSubs = ();
436our @onReceiveMsg = ();
437our @onMainLoop = ();
438our @onGetBuddyList = ();
439
440# Functions to call hook lists
441sub runHook($@)
442{
443    my $hook = shift;
444    my @args = @_;
445    $_->(@args) for (@$hook);
446}
447
448sub runHook_accumulate($@)
449{
450    my $hook = shift;
451    my @args = @_;
452    return join("\n", map {$_->(@args)} @$hook);
453}
454
455################################################################################
456# Startup and Shutdown code
457################################################################################
458sub startup
459{
460    # Modern versions of owl provides a great place to have startup stuff.
461    # Put things in ~/.owl/startup
462
463    #So that the user's .owlconf can have startsubs, we don't clear
464    #onStartSubs; reload does however
465    @onReceiveMsg = ();
466    @onMainLoop = ();
467    @onGetBuddyList = ();
468
469    BarnOwl::onStart();
470
471    runHook(\@onStartSubs);
472
473    BarnOwl::startup() if *BarnOwl::startup{CODE};
474}
475
476sub shutdown
477{
478# Modern versions of owl provides a great place to have shutdown stuff.
479# Put things in ~/.owl/shutdown
480
481    # use $shutdown to tell modules that that's what we're doing.
482    $BarnOwl::shutdown = 1;
483    BarnOwl::mainloop_hook();
484
485    BarnOwl::shutdown() if *BarnOwl::shutdown{CODE};
486}
487
488sub mainloop_hook
489{
490    runHook(\@onMainLoop);
491    BarnOwl::mainloop_hook() if *BarnOwl::mainloop_hook{CODE};
492}
493
494################################################################################
495# Hooks into receive_msg()
496################################################################################
497
498sub receive_msg
499{
500    my $m = shift;
501    runHook(\@onReceiveMsg, $m);
502    BarnOwl::receive_msg($m) if *BarnOwl::receive_msg{CODE};
503}
504
505################################################################################
506# Hooks into get_blist()
507################################################################################
508
509sub get_blist
510{
511    return runHook_accumulate(\@onGetBuddyList);
512}
513
514################################################################################
515# Built-in perl styles
516################################################################################
517package BarnOwl::Style::Default;
518################################################################################
519# Branching point for various formatting functions in this style.
520################################################################################
521sub format_message($)
522{
523    my $m = shift;
524
525    if ( $m->is_loginout) {
526        return format_login($m);
527    } elsif($m->is_ping) {
528        return ( "\@b(PING) from \@b(" . $m->pretty_sender . ")\n" );
529    } elsif($m->is_admin) {
530        return "\@bold(OWL ADMIN)\n" . indentBody($m);
531    } else {
532        return format_chat($m);
533    }
534}
535
536BarnOwl::_create_style("default", "BarnOwl::Style::Default::format_message", "Default style");
537
538################################################################################
539
540sub time_hhmm {
541    my $m = shift;
542    my ($time) = $m->time =~ /(\d\d:\d\d)/;
543    return $time;
544}
545
546sub format_login($) {
547    my $m = shift;
548    return sprintf(
549        '@b<%s%s> for @b(%s) (%s) %s',
550        uc( $m->login ),
551        $m->login_type,
552        $m->pretty_sender,
553        $m->login_extra,
554        time_hhmm($m)
555       );
556}
557
558sub format_chat($) {
559    my $m = shift;
560    my $header;
561    if ( $m->is_personal ) {
562        if ( $m->direction eq "out" ) {
563            $header = ucfirst $m->type . " sent to " . $m->pretty_recipient;
564        } else {
565            $header = ucfirst $m->type . " from " . $m->pretty_sender;
566        }
567    } else {
568        $header = $m->context;
569        if($m->subcontext) {
570            $header .= ' / ' . $m->subcontext;
571        }
572        $header .= ' / @b{' . $m->pretty_sender . '}';
573    }
574
575    $header .= "  " . time_hhmm($m);
576    my $sender = $m->long_sender;
577    $sender =~ s/\n.*$//s;
578    $header .= "\t(" . $sender . ")";
579    my $message = $header . "\n". indentBody($m);
580    if($m->is_private && $m->direction eq "in") {
581        $message = BarnOwl::Style::boldify($message);
582    }
583    return $message;
584}
585
586sub indentBody($)
587{
588    my $m = shift;
589   
590    my $body = $m->body;
591    # replace newline followed by anything with
592    # newline plus four spaces and that thing.
593    $body =~ s/\n(.)/\n    $1/g;
594
595    return "    ".$body;
596}
597
598
599package BarnOwl::Style;
600
601# This takes a zephyr to be displayed and modifies it to be displayed
602# entirely in bold.
603sub boldify($)
604{
605    local $_ = shift;
606    if ( !(/\)/) ) {
607        return '@b(' . $_ . ')';
608    } elsif ( !(/\>/) ) {
609        return '@b<' . $_ . '>';
610    } elsif ( !(/\}/) ) {
611        return '@b{' . $_ . '}';
612    } elsif ( !(/\]/) ) {
613        return '@b[' . $_ . ']';
614    } else {
615        my $txt = "\@b($_";
616        $txt =~ s/\)/\)\@b\[\)\]\@b\(/g;
617        return $txt . ')';
618    }
619}
620
621
622# switch to package main when we're done
623package main;
624# alias the hooks
625{
626    no strict 'refs';
627    foreach my $hook  qw (onStartSubs
628                          onReceiveMsg
629                          onMainLoop
630                          onGetBuddyList ) {
631        *{"main::".$hook} = \*{"BarnOwl::Hooks::".$hook};
632        *{"owl::".$hook} = \*{"BarnOwl::Hooks::".$hook};
633    }
634}
635
6361;
Note: See TracBrowser for help on using the repository browser.