IkiWiki/Plugin/mailbox.pm

   1 #!/usr/bin/perl
   2 # based on Ikiwiki skeleton plugin.
   3
   4 # Copyright (c) 2008 David Bremner <bremner@unb.ca>
   5 # This file is distributed under the Artistic License/GPL2+
   6
   7 use Email::MIME;
   8 use Email::MIME::Modifier;
   9 package Email::MIMEFolder;
  10 use base 'Email::Folder';
  11 sub bless_message { return  Email::MIME->new($_[1]) };
  12
  13
  14 package IkiWiki::Plugin::mailbox;
  15
  16 use Email::FolderType qw(folder_type);
  17 use IkiWiki 2.00;
  18 use Email::Thread;
  19 use CGI 'escapeHTML';
  20 use File::Temp qw/tempfile/;
  21 use File::MimeInfo::Magic;
  22
  23
  24 my %metaheaders;
  25
  26
  27 sub import { #{{{
  28         hook(type => "preprocess", id => "mailbox", call => \&preprocess);
  29         hook(type => "scan", id => "mailbox", call => \&scan);
  30         hook(type => "pagetemplate", id=>"mailbox", call => \&pagetemplate);
  31         hook(type => "htmlize",id=>"mbox",call => \&mbox_htmlize);
  32         IkiWiki::loadplugin("filecheck");
  33 } # }}}
  34
  35 sub scan(@){
  36         my %params=@_;
  37         my $page=$params{page};
  38
  39         push @{$metaheaders{$page}},
  40                '<link rel="stylesheet" href="mailbox.css" type="text/css"/>'
  41 }
  42
  43 sub preprocess (@) { #{{{
  44         my %params=@_;
  45
  46         my $page=$params{page};
  47         my $type=$params{type} || 'Maildir';
  48
  49         my $path=$params{path} ||  error gettext("missing parameter") . " path";
  50
  51         # hmm, this should probably only be inserted once per page.
  52
  53         my $dir=bestpath($page,$params{path}) ||
  54             error("could not find ".$params{path});
  55
  56         $params{path} = $config{srcdir} ."/" . $dir;
  57         $params{type} = $type;
  58
  59         return  format_mailbox(%params);
  60
  61 } # }}}
  62
  63
  64 ### The guts of the plugin
  65 ### parameters
  66 sub format_mailbox(@){
  67     my %params=@_;
  68     my $path=$params{path} || error gettext("missing parameter "). 'path';
  69     my $type=$params{type} || error gettext("missing paramater ")."type";
  70
  71     debug('type='.$type);
  72     my $folder=Email::MIMEFolder->new($path,reader=>'Email::Folder::'.$type) || error("mailbox could not be opened");
  73     my $threader=new Email::Thread($folder->messages);
  74
  75     $threader->thread();
  76
  77     return join "\n", map { format_thread(%params,thread=>$_) } $threader->rootset;
  78 }
  79
  80 sub format_thread(@){
  81     my %params=@_;
  82
  83     my $thread=$params{thread} || error gettext("missing parameter") . "thread";
  84
  85     my $output="";
  86
  87     if ($thread->message) {
  88         $output .= format_message(%params,message=>$thread->message);
  89     } else {
  90         $output .= sprintf gettext("Message %s not available"), $thread->messageid;
  91     }
  92
  93     if ($thread->child){
  94         $output .= '<div class="emailthreadindent">' .
  95             format_thread(%params,thread=>$thread->child).
  96             '</div>';
  97     }
  98
  99     if ($thread->next){
 100         $output .= format_thread(%params,thread=>$thread->next);
 101     }
 102     return $output;
 103 }
 104
 105 sub make_pair($$){
 106     my $message=shift;
 107     my $name=shift;
 108     my $val=$message->header($_);
 109
 110     $val = escapeHTML($val);
 111
 112     my $hash={'HEADERNAME'=>$name,'VAL'=>$val};
 113     return $hash;
 114 }
 115 sub format_message(@){
 116     my  %params=@_;
 117
 118     my $message=$params{message} ||
 119         error gettext("missing parameter"). "message";
 120
 121
 122     my $dest=$params{destpage} ||
 123         error gettext("missing parameter"). "destpage";
 124
 125     my $keep_headers=$params{headers} || qr/^(subject|from|date)[:]?$/i;
 126
 127     my $template=
 128         template("email.tmpl") || error gettext("missing template");
 129
 130     my $output="";
 131
 132     my @names = grep  {m/$keep_headers/;}  ($message->header_names);
 133     my @headers=map { make_pair($message,$_) } @names;
 134
 135
 136     $template->param(HEADERS=>[@headers]);
 137
 138     my $allowed_attachments=$params{allowed_attachments} ||
 139         "maxsize(100kb) and mimetype(text/plain)";
 140
 141     my @parts=$message->parts;
 142
 143     my $partcount=1;
 144     foreach(@parts){
 145         #this sucks. But someone would need to modify filecheck to
 146         #accept a blob of content. Or maybe hacking with IO::Scalar
 147         my $tmpfile=File::Temp->new();
 148
 149         binmode $tmpfile,':utf8';
 150         print $tmpfile $_->body();
 151
 152         my $allowed=pagespec_match($dest, $allowed_attachments, file=>$tmpfile);
 153
 154         if (!$allowed) {
 155             debug("clobbering attachment $partcount");
 156             $_->content_type_set('text/plain');
 157             $_->body_set("[ omitting part $partcount: $allowed ]");
 158
 159         }
 160         $partcount++;
 161     }
 162     my $body= join("\n", map { $_->body }  @parts);
 163
 164     $template->param(body=>format_body($body));
 165
 166     $output .= $template->output();
 167     return $output;
 168 }
 169
 170 sub format_body($){
 171     my $body=shift;
 172
 173     # it is not completely clear to me the right way to go here.
 174     # passing things straight to markdown is not working all that
 175     # well.
 176     return "<pre>".escapeHTML($body)."</pre>";
 177 }
 178 ### Utilities
 179
 180 # based on bestdir From Arpit Jain
 181 # http://ikiwiki.info/todo/Bestdir_along_with_bestlink_in_IkiWiki.pm/
 182 # need to clarify license
 183 sub bestpath ($$) { #{{{
 184     my $page=shift;
 185        my $link=shift;
 186        my $cwd=$page;
 187
 188        if ($link=~s/^\/+//) {
 189                $cwd="";
 190        }
 191
 192        do {
 193                my $l=$cwd;
 194                $l.="/" if length $l;
 195                $l.=$link;
 196                if (-d "$config{srcdir}/$l" || -f "$config{srcdir}/$l") {
 197                        return $l;
 198                }
 199        } while $cwd=~s!/?[^/]+$!!;
 200
 201        if (length $config{userdir}) {
 202                my $l = "$config{userdir}/".lc($link);
 203
 204                if (-d $l || -f $l) {
 205                        return $l;
 206                }
 207        }
 208
 209        return "";
 210 } #}}}
 211
 212 sub pagetemplate (@) { #{{{
 213         my %params=@_;
 214         my $page=$params{page};
 215         my $destpage=$params{destpage};
 216         my $template=$params{template};
 217
 218         if (exists $metaheaders{$page} && $template->query(name => "meta")) {
 219                 # avoid duplicate meta lines
 220                 my %seen;
 221                 $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$page}}));
 222         }
 223 }
 224
 225
 226
 227 package Email::FolderType::MH;
 228
 229 sub match {
 230     my $folder = shift;
 231     return 0 if (! -d $folder);
 232     opendir DIR,$folder || error("opendir failed");
 233
 234     while (<DIR>){
 235       return 0 if (!m|\.| && !m|\.\.| && !m|\d+|);
 236     }
 237     return 1;
 238 }
 239
 240
 241
 242 1;