1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
|
package CiderWebmail::Util;
use warnings;
use strict;
use Exporter;
use base qw(Exporter);
our @EXPORT = qw(decode_mime_words);
use Text::Iconv;
use MIME::Words qw/ decode_mimewords /;
use DateTime;
use DateTime::Format::Mail;
use Crypt::Util;
use Crypt::Random::Source qw/get_weak/;
use MIME::Base64;
use Carp qw/ carp croak /;
use FindBin qw($Bin);
use feature qw/ switch /;
=head1 FUNCTIONS
=head2 add_foldertree_uris($c, {folders => $folder_tree, path => 'folder/path', uris => [{action => 'view', uri => 'view_folder'}, ...]})
Adds some URIs to a folder tree.
=cut
sub add_foldertree_uris {
my $c = shift;
my $o = shift;
croak unless defined $o->{folders};
my $separator = $c->model('IMAPClient')->separator();
foreach my $folder ( @{$o->{folders}} ) {
my $path = (defined($o->{path}) ? join($separator, $o->{path}, $folder->{name}) : $folder->{name});
my $uri_path = uri_mask_folder_path($path);
foreach (@{ $o->{uris} }) {
$folder->{"uri_$_->{action}"} = $c->uri_for("/mailbox/$uri_path/$_->{uri}");
}
if (defined($folder->{folders})) { #if we have any subfolders
add_foldertree_uris($c, {
path => $path,
folders => $folder->{folders},
uris => $o->{uris},
});
}
}
return;
}
=head2 add_foldertree_icons($c, {folders => $folder_tree})
Adds some icons to a folder tree.
=cut
sub add_foldertree_icons {
my $c = shift;
my $o = shift;
croak unless defined $o->{folders};
foreach my $folder ( @{$o->{folders}} ) {
my $folder_name = lc $folder->{name};
if ($folder_name eq 'inbox') {
$folder->{icon} = 'inbox.png';
$folder->{class} = 'inbox';
}
elsif ($folder_name eq 'sent') {
$folder->{icon} = 'sent.png';
$folder->{class} = 'sent';
}
elsif ($folder_name eq 'trash') {
$folder->{icon} = 'trash.png';
$folder->{class} = 'trash';
}
else {
$folder->{icon} = 'folder.png';
$folder->{class} = 'folder';
}
if (defined($folder->{folders})) { #if we have any subfolders
add_foldertree_icons($c, {
folders => $folder->{folders},
});
}
}
return;
}
=head2 uri_mask_folder_path($path)
Mask all slashes in folder path for use in URIs.
=cut
sub uri_mask_folder_path {
my ($path) = @_;
$path =~ s!;!;;!gxm;
$path =~ s!/!;!gxm;
return $path;
}
=head2 add_foldertree_to_stash($c)
Gets a folder tree and folders hash from the model, adds 'view' uris and puts them on the stash.
=cut
sub add_foldertree_to_stash {
my ($c) = @_;
return if defined($c->stash->{folder_tree});
my ($tree, $folders_hash) = $c->model('IMAPClient')->folder_tree();
CiderWebmail::Util::add_foldertree_uris($c, { path => undef, folders => $tree->{folders}, uris => [{action => 'view', uri => ''}] });
CiderWebmail::Util::add_foldertree_icons($c, { folders => $tree->{folders} });
$folders_hash->{$c->stash->{folder}}{selected} = 'selected' if $c->stash->{folder};
$tree->{folders} = sort_foldertree($tree->{folders});
$c->stash({
folder_tree => $tree,
folders_hash => $folders_hash,
});
return;
}
sub sort_foldertree {
my ($subtree) = @_;
@{$subtree} = sort {
return -1 if ($a->{name} =~ m/^(inbox)$/i);
return 1 if ($b->{name} =~ m/^(inbox)$/i);
return 1 if ($a->{name} =~ m/^(trash)$/i);
return -1 if ($b->{name} =~ m/^(trash)$/i);
return (lc($a->{name}) cmp lc($b->{name}));
} @{$subtree};
foreach(@{$subtree}) {
if (defined $_->{folders}) {
$_->{folders} = sort_foldertree($_->{folders});
}
}
return $subtree;
}
=head2 send_foldertree_update($c)
Common function to reply to a request with a new folder tree. Used in AJAX commands.
=cut
sub send_foldertree_update {
my ($c) = @_;
CiderWebmail::Util::add_foldertree_to_stash($c); # update folder display
$c->stash->{folder_data} = $c->stash->{folders_hash}{$c->stash->{folder}};
$c->stash->{folder_data}{selected} = 'selected';
$c->stash->{template} = 'folder_tree.xml';
return;
}
=head2 filter_unusable_addresses(@addresses)
Filters a list of addresses (string or Email::Address::XS) to get rid of stuff like 'undisclosed-recipients:'
=cut
sub filter_unusable_addresses {
my @addresses = @_;
return grep {(ref $_ ? $_->address : $_) !~ /\A \s* undisclosed [-\s]* recipients:? \s* \z/ixm} @addresses;
}
=head2 message_group_name
formats a date/subject/address for message-grouping
for examples it removes (re:|fwd:) from subjects
=cut
sub message_group_name {
my ($message, $sort) = @_;
my $name;
if ($sort eq 'date') {
$name = $message->{head}->{date}->ymd;
}
if ($sort =~ m/(from|to)/xm) {
my $address = $message->{head}->{$1}->[0];
$name = $address ? ($address->name ? $address->address . ': ' . $address->name : $address->address) : 'Unknown';
}
if ($sort eq 'subject') {
$name = $message->{head}->{subject};
$name =~ s/\A \s+//xm;
$name =~ s/\A (re: | fwd?:) \s*//ixm;
$name =~ s/\s+ \z//xm;
}
return $name;
}
=head2 encrypt({ string => $string })
encrypt a string
=cut
sub encrypt {
my ($c, $o) = @_;
croak("empty string passed to CiderWebmail::Util::encrypt") unless defined($o->{string});
croak("cannot encrypt without active session") unless $c->sessionid;
my $util = Crypt::Util->new;
my $key = CiderWebmail::Util::get_key($c);
croak("invalid key passed to CiderWebmail::Util::crypt") unless (defined($key) && (length($key) == 48));
$util->default_mode('CBC');
$util->default_key($key);
return $util->encode_string_uri_base64( $util->encrypt_string($o->{string}) );
}
=head2 decrypt({ string => $string })
decrypt a string
=cut
sub decrypt {
my ($c, $o) = @_;
croak("empty string passed to CiderWebmail::Util::decrypt") unless defined($o->{string});
croak("cannot decrypt without active session") unless $c->sessionid;
my $util = Crypt::Util->new;
my $key = CiderWebmail::Util::get_key($c);
croak("invalid key passed to CiderWebmail::Util::crypt") unless (defined($key) && (length($key) == 48));
$util->default_mode('CBC');
$util->default_key($key);
return $util->decrypt_string( $util->decode_string_uri_base64( $o->{string} ) );
}
=head2 get_key()
gets the server-side encryption key
if no key exists one will be created
=cut
sub get_key {
my ($c, $o) = @_;
croak("cannot fetch encryption key without active session") unless $c->sessionid;
if (defined($c->session->{encryption_key}) && (length($c->session->{encryption_key}) == 48)) {
return $c->session->{encryption_key};
} else {
$c->session->{encryption_key} = encode_base64(get_weak(35));
chomp($c->session->{encryption_key});
return $c->session->{encryption_key};
}
}
sub parse_message_id {
my ($message_id) = @_;
croak('parse_message_id($message_id) called without $message_id') unless defined $message_id;
#message id's are in the format <message uid on IMAP server>/<CiderWebmail::Part id in @CiderWebmail::Message::parts>
if ($message_id =~ m|^(\d+)/([a-z0-9\.]+)$|ixm) {
return ($1, $2);
} else {
croak("Unable to parse in_reply_to: $message_id");
}
}
sub decode_mime_words {
my ($o) = @_;
return '' unless defined $o->{data};
my $string;
foreach ( decode_mimewords( $o->{data} ) ) {
if ( @$_ > 1 ) {
unless (eval {
my $converter = Text::Iconv->new($_->[1], "utf-8");
my $part = $converter->convert( $_->[0] );
utf8::decode($part);
$string .= $part if defined $part;
}) {
carp("unable to convert $_->[1] to utf-8 using Text::Iconv: $!");
utf8::decode($_->[0]);
$string .= $_->[0];
}
} else {
utf8::decode($_->[0]);
$string .= $_->[0];
}
}
return $string;
}
1;
|