mws/trunk/MWS.pm

#!/usr/bin/perl -w

package MWS;

use strict;
use warnings;
use Carp;

use Mail::Box::Manager;
use Config::IniFiles;
use POSIX qw(strftime);
use Text::Autoformat;
use Text::Iconv;

#use MWS_plucene;
use MWS_swish;

require Exporter;

our @ISA = qw(Exporter);

our %EXPORT_TAGS = ();
our @EXPORT_OK;
our @EXPORT;

our $VERSION = '1.00';

my $folder;     # placeholder for folders

my $debug = 2;

sub new {
        my $class = shift;
        my $self = {};
        bless($self, $class);

        my $config_file = shift || die "need index file";

        $self->{config} = new Config::IniFiles( -file => $config_file );

        my $index_file = $self->{config}->val('global', 'index') || croak "can't find [index] section in config file with path of index";

        $self->{mgr} = Mail::Box::Manager->new(access => 'r');
        $self->{index_file} = $index_file;

        # placeholder for opened folders
        $self->{folder} = {};

        $self->{wrap_margin} = $self->{config}->val('global', 'wrap_margin');

        return $self;
}

sub mbox_name2path {
        my $self = shift;

        my $mbox = shift || croak "folder_name2path needs mbox name";

        return $self->{config}->val('folders', $mbox) || croak "comeone removed folder $mbox from config?";
}

sub open_folder {
        my $self = shift;

        my $mbox = shift || croak "open_folder needs mbox name";

        if (! $self->{folder}->{$mbox}) {
                my $mbox_path = $self->mbox_name2path($mbox);

                print STDERR "about to open_folder($mbox)\n" if ($debug == 2);

                $self->{folder}->{$mbox} = $self->{mgr}->open($mbox_path) || croak "can't open folder $mbox at '$mbox_path': $!";

                print STDERR "open_folder($mbox) ok\n" if ($debug);
        }

        $self->{fetch_count} = 0;

        return $self->{folder}->{$mbox};

}

sub close_folder {
        my $self = shift;

        my $mbox = shift || croak "open_folder needs mbox name";

        $self->{folder}->{$mbox}->close(write => 'NEVER') || croak "can't close folder $mbox";

        # XXX this is rather agressive!!!
        $self->{folder} = {};
        return 
}

sub fetch_message {
        my $self = shift;

        my $mbox_id = shift || die "need mbox_id!";
        my ($mbox,$id) = split(/ /,$mbox_id);

        # return message with ID
        print STDERR "fetch $id from $mbox\n" if ($debug);

        if ($self->{fetch_count}++ > 100) {
                $self->close_folder($mbox);
                print STDERR "close_folder($mbox) forced on ",$self->{fetch_count},"iteration\n";
        }
        
        return $self->open_folder($mbox)->find($id) ||
                print STDERR "can't find message $id in $mbox. Time to re-index?\n";
}


sub search {
        my $self = shift;

        my $s = shift || carp "search called without argument!";

        print STDERR "search_index($s)\n" if ($debug == 2);
        my @index_ids = $self->search_index($s);

        $self->{'index_ids'} = \@index_ids;

        my $results = $#index_ids + 1;
        $self->{'results'} = $results;

        $self->{'curr_result'} = 0;

        print STDERR "$results results\n" if ($debug == 2);

        return $results || 'error';
}

sub decode_qp($) {
        my $self = shift;

        my $tmp = shift || return;

        sub decode($$) {
                my ($cp,$qp) = @_;
                my $iconv = Text::Iconv->new($cp,'ISO-8859-2');
        print STDERR "decode($cp,$qp) -> " if ($debug == 2);
                $qp =~ s/=([a-f0-9][a-f0-9])/chr(hex($1))/ieg;
                $qp =~ s/_/ /g;
        print STDERR "$qp\n" if ($debug == 2);
                return $iconv->convert($qp);
        }

        $tmp =~ s/=\?([^\?]+)\?Q\?(.+)\?=/decode($1,$2)/ex;
        return $tmp;
}

sub unroll($$$) {
        my $self = shift;

        my ($message,$part,$sub) = @_;

        my @arr;

        foreach my $from ($message->$part) {
                my $tmp = $from->$sub || next;

                $tmp = $self->decode_qp($tmp);
                $tmp =~ s/^\s*["'](.*)["']\s*$/$1/;
                push @arr, $tmp;
        }

        return @arr;
}

sub fetch_all_results {
        my $self = shift;

        croak "results called before search!" if (! $self->{'index_ids'});

        print STDERR "fetch_all_results [",scalar @{$self->{'index_ids'}},"]\n" if ($debug == 2);

        my @arr;

        foreach my $id (@{$self->{'index_ids'}}) {
                push @arr, $self->fetch_result_by_id($id);
        }

        return @arr;
}

sub fetch_result {
        my $self = shift;

        my $args = {@_};

        croak "results called before search!" if (! $self->{'index_ids'});

        my $curr = $self->{'curr_result'}++;

        my $id = $self->{'index_ids'}->[$curr];
        
        print STDERR "fetch_result: $curr = $id\n" if ($debug == 2);

        return $self->fetch_result_by_id($id);
}

sub plain_text_body {
        my $self = shift;
        my $message = shift || croak "plain_text_body needs message!";

        my $body;

        if (! $message->isMultipart) {
                $body = $message->decoded->string;
        } else {
                foreach my $part ($message->parts) {
                        if ($part->body->mimeType eq 'text/plain') {
                                $body = $part->decoded->string;
                                last;
                        }
                }
        }

        # reformat with Text::Autoformat
        my $wrap = $self->{wrap_margin};
        if ($wrap && $body && $body =~ m/^.{$wrap}..*$/m) {
                $body =~ s/[\r\n]/\n/gs;
                $body = autoformat($body, {right=>$wrap});
                $body .="\n[reformated using autoformat, margin at $wrap]" if ($debug == 2);
        }

        return $body;
}


sub fetch_result_by_id {
        my $self = shift;

        my $id = shift || return;

        my $row = $self->{cache}->{$id};

        if (! $row) {

                print STDERR "fetch_result_by_id($id) not in cache, hitting disk\n" if ($debug == 2);

                my $message = $self->fetch_message($id) || print STDERR "can't fetch message '$id'";

                $row->{'id'} = $id;
                @{$row->{'from'}} = $self->unroll($message,'from','phrase');
                @{$row->{'to'}} = $self->unroll($message,'to','phrase');
                @{$row->{'cc'}} = $self->unroll($message,'cc','phrase');
                $row->{'subject'} = $self->decode_qp($message->subject);
                $row->{'body'} = $self->plain_text_body($message);
                $row->{'date'} = $message->date;

                # XXX store in cache?
                $self->{cache}->{$id} = $row;
                print STDERR "$id stored in cache\n" if ($debug == 2);
        } else {
                print STDERR "fetch_result_by_id($id) in cache\n" if ($debug == 2);
        }

        return $row;
        
}
1	dpavlin	2	#!/usr/bin/perl -w
2
3			package MWS;
4
5			use strict;
6			use warnings;
7			use Carp;
8
9	dpavlin	3	use Mail::Box::Manager;
10	dpavlin	4	use Config::IniFiles;
11	dpavlin	13	use POSIX qw(strftime);
12	dpavlin	14	use Text::Autoformat;
13	dpavlin	16	use Text::Iconv;
14	dpavlin	14
15	dpavlin	12	#use MWS_plucene;
16			use MWS_swish;
17	dpavlin	3
18	dpavlin	2	require Exporter;
19
20			our @ISA = qw(Exporter);
21
22			our %EXPORT_TAGS = ();
23			our @EXPORT_OK;
24			our @EXPORT;
25
26			our $VERSION = '1.00';
27
28			my $folder; # placeholder for folders
29
30	dpavlin	13	my $debug = 2;
31	dpavlin	2
32			sub new {
33			my $class = shift;
34			my $self = {};
35			bless($self, $class);
36
37	dpavlin	4	my $config_file = shift \|\| die "need index file";
38	dpavlin	2
39	dpavlin	4	$self->{config} = new Config::IniFiles( -file => $config_file );
40	dpavlin	2
41	dpavlin	4	my $index_file = $self->{config}->val('global', 'index') \|\| croak "can't find [index] section in config file with path of index";
42
43	dpavlin	12	$self->{mgr} = Mail::Box::Manager->new(access => 'r');
44			$self->{index_file} = $index_file;
45	dpavlin	4
46	dpavlin	2	# placeholder for opened folders
47			$self->{folder} = {};
48
49	dpavlin	14	$self->{wrap_margin} = $self->{config}->val('global', 'wrap_margin');
50
51	dpavlin	2	return $self;
52			}
53
54	dpavlin	14	sub mbox_name2path {
55			my $self = shift;
56
57			my $mbox = shift \|\| croak "folder_name2path needs mbox name";
58
59			return $self->{config}->val('folders', $mbox) \|\| croak "comeone removed folder $mbox from config?";
60			}
61
62	dpavlin	7	sub open_folder {
63	dpavlin	2	my $self = shift;
64
65	dpavlin	7	my $mbox = shift \|\| croak "open_folder needs mbox name";
66	dpavlin	2
67			if (! $self->{folder}->{$mbox}) {
68	dpavlin	14	my $mbox_path = $self->mbox_name2path($mbox);
69
70	dpavlin	13	print STDERR "about to open_folder($mbox)\n" if ($debug == 2);
71	dpavlin	14
72	dpavlin	4	$self->{folder}->{$mbox} = $self->{mgr}->open($mbox_path) \|\| croak "can't open folder $mbox at '$mbox_path': $!";
73	dpavlin	14
74			print STDERR "open_folder($mbox) ok\n" if ($debug);
75	dpavlin	2	}
76
77	dpavlin	16	$self->{fetch_count} = 0;
78
79	dpavlin	7	return $self->{folder}->{$mbox};
80
81			}
82
83	dpavlin	14	sub close_folder {
84			my $self = shift;
85
86			my $mbox = shift \|\| croak "open_folder needs mbox name";
87
88	dpavlin	16	$self->{folder}->{$mbox}->close(write => 'NEVER') \|\| croak "can't close folder $mbox";
89
90			# XXX this is rather agressive!!!
91			$self->{folder} = {};
92			return
93	dpavlin	14	}
94
95	dpavlin	7	sub fetch_message {
96			my $self = shift;
97
98			my $mbox_id = shift \|\| die "need mbox_id!";
99			my ($mbox,$id) = split(/ /,$mbox_id);
100
101			# return message with ID
102	dpavlin	13	print STDERR "fetch $id from $mbox\n" if ($debug);
103	dpavlin	16
104			if ($self->{fetch_count}++ > 100) {
105			$self->close_folder($mbox);
106			print STDERR "close_folder($mbox) forced on ",$self->{fetch_count},"iteration\n";
107			}
108
109	dpavlin	7	return $self->open_folder($mbox)->find($id) \|\|
110	dpavlin	2	print STDERR "can't find message $id in $mbox. Time to re-index?\n";
111			}
112
113
114			sub search {
115			my $self = shift;
116
117			my $s = shift \|\| carp "search called without argument!";
118
119	dpavlin	13	print STDERR "search_index($s)\n" if ($debug == 2);
120	dpavlin	9	my @index_ids = $self->search_index($s);
121	dpavlin	2
122			$self->{'index_ids'} = \@index_ids;
123
124			my $results = $#index_ids + 1;
125			$self->{'results'} = $results;
126
127			$self->{'curr_result'} = 0;
128
129	dpavlin	13	print STDERR "$results results\n" if ($debug == 2);
130
131	dpavlin	2	return $results \|\| 'error';
132			}
133
134	dpavlin	16	sub decode_qp($) {
135			my $self = shift;
136
137			my $tmp = shift \|\| return;
138
139			sub decode($$) {
140			my ($cp,$qp) = @_;
141			my $iconv = Text::Iconv->new($cp,'ISO-8859-2');
142			print STDERR "decode($cp,$qp) -> " if ($debug == 2);
143			$qp =~ s/=([a-f0-9][a-f0-9])/chr(hex($1))/ieg;
144			$qp =~ s/_/ /g;
145			print STDERR "$qp\n" if ($debug == 2);
146			return $iconv->convert($qp);
147			}
148
149			$tmp =~ s/=\?([^\?]+)\?Q\?(.+)\?=/decode($1,$2)/ex;
150			return $tmp;
151			}
152
153	dpavlin	2	sub unroll($$$) {
154	dpavlin	13	my $self = shift;
155
156	dpavlin	2	my ($message,$part,$sub) = @_;
157
158			my @arr;
159
160			foreach my $from ($message->$part) {
161	dpavlin	16	my $tmp = $from->$sub \|\| next;
162
163			$tmp = $self->decode_qp($tmp);
164			$tmp =~ s/^\s["'](.)["']\s*$/$1/;
165			push @arr, $tmp;
166	dpavlin	2	}
167	dpavlin	14
168			return @arr;
169	dpavlin	2	}
170	dpavlin	4
171			sub fetch_all_results {
172			my $self = shift;
173
174			croak "results called before search!" if (! $self->{'index_ids'});
175
176	dpavlin	14	print STDERR "fetch_all_results [",scalar @{$self->{'index_ids'}},"]\n" if ($debug == 2);
177	dpavlin	13
178	dpavlin	4	my @arr;
179
180			foreach my $id (@{$self->{'index_ids'}}) {
181			push @arr, $self->fetch_result_by_id($id);
182			}
183
184			return @arr;
185			}
186
187	dpavlin	2	sub fetch_result {
188			my $self = shift;
189
190	dpavlin	3	my $args = {@_};
191
192	dpavlin	2	croak "results called before search!" if (! $self->{'index_ids'});
193
194			my $curr = $self->{'curr_result'}++;
195
196			my $id = $self->{'index_ids'}->[$curr];
197	dpavlin	14
198			print STDERR "fetch_result: $curr = $id\n" if ($debug == 2);
199	dpavlin	2
200	dpavlin	4	return $self->fetch_result_by_id($id);
201			}
202	dpavlin	2
203	dpavlin	7	sub plain_text_body {
204			my $self = shift;
205			my $message = shift \|\| croak "plain_text_body needs message!";
206
207	dpavlin	14	my $body;
208
209	dpavlin	7	if (! $message->isMultipart) {
210	dpavlin	14	$body = $message->decoded->string;
211	dpavlin	7	} else {
212			foreach my $part ($message->parts) {
213			if ($part->body->mimeType eq 'text/plain') {
214	dpavlin	14	$body = $part->decoded->string;
215			last;
216	dpavlin	7	}
217			}
218			}
219	dpavlin	14
220			# reformat with Text::Autoformat
221			my $wrap = $self->{wrap_margin};
222			if ($wrap && $body && $body =~ m/^.{$wrap}..*$/m) {
223	dpavlin	16	$body =~ s/[\r\n]/\n/gs;
224			$body = autoformat($body, {right=>$wrap});
225	dpavlin	14	$body .="\n[reformated using autoformat, margin at $wrap]" if ($debug == 2);
226			}
227
228			return $body;
229	dpavlin	7	}
230
231
232	dpavlin	4	sub fetch_result_by_id {
233			my $self = shift;
234
235			my $id = shift \|\| return;
236
237	dpavlin	13	my $row = $self->{cache}->{$id};
238	dpavlin	2
239	dpavlin	13	if (! $row) {
240	dpavlin	2
241	dpavlin	13	print STDERR "fetch_result_by_id($id) not in cache, hitting disk\n" if ($debug == 2);
242	dpavlin	2
243	dpavlin	13	my $message = $self->fetch_message($id) \|\| print STDERR "can't fetch message '$id'";
244
245			$row->{'id'} = $id;
246	dpavlin	14	@{$row->{'from'}} = $self->unroll($message,'from','phrase');
247			@{$row->{'to'}} = $self->unroll($message,'to','phrase');
248			@{$row->{'cc'}} = $self->unroll($message,'cc','phrase');
249	dpavlin	16	$row->{'subject'} = $self->decode_qp($message->subject);
250	dpavlin	13	$row->{'body'} = $self->plain_text_body($message);
251			$row->{'date'} = $message->date;
252
253			# XXX store in cache?
254			$self->{cache}->{$id} = $row;
255			print STDERR "$id stored in cache\n" if ($debug == 2);
256			} else {
257			print STDERR "fetch_result_by_id($id) in cache\n" if ($debug == 2);
258			}
259
260	dpavlin	2	return $row;
261
262			}