1a626153a59876ec19558d67953fc0cda1ad02d1
[claws.git] / src / plugins / perl / perl_plugin.c
1 /* Perl plugin -- Perl Support for Claws Mail
2  *
3  * Copyright (C) 2004-2007 Holger Berndt
4  *
5  * Sylpheed and Claws-Mail are GTK+ based, lightweight, and fast e-mail clients
6  * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail Team
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #  include "config.h"
24 #include "claws-features.h"
25 #endif
26
27 #include "common/version.h"
28 #include "common/defs.h"
29 #include "common/utils.h"
30 #include "common/claws.h"
31 #include "common/prefs.h"
32 #include "procmsg.h"
33 #include "procheader.h"
34 #include "folder.h"
35 #include "account.h"
36 #include "compose.h"
37 #include "addrindex.h"
38 #include "addritem.h"
39 #include "addr_compl.h"
40 #include "statusbar.h"
41 #include "alertpanel.h"
42 #include "common/hooks.h"
43 #include "prefs_common.h"
44 #include "prefs_gtk.h"
45 #include "common/log.h"
46 #include "common/plugin.h"
47 #include "common/tags.h"
48
49 #include <EXTERN.h>
50 #include <perl.h>
51 #include <XSUB.h>
52
53 #ifdef _
54 # undef _
55 #endif
56
57 #include <glib.h>
58 #include <glib/gi18n.h>
59
60 #include <string.h>
61 #include <sys/types.h>
62 #include <sys/stat.h>
63 #include <sys/wait.h>
64 #include <unistd.h>
65
66 #include "perl_plugin.h"
67 #include "perl_gtk.h"
68
69
70 /* XSRETURN_UV was introduced in Perl 5.8.1,
71    this fixes things for 5.8.0. */
72 #ifndef XSRETURN_UV
73 #  ifndef XST_mUV
74 #    define XST_mUV(i,v)  (ST(i) = sv_2mortal(newSVuv(v))  )
75 #  endif /* XST_mUV */
76 #  define XSRETURN_UV(v) STMT_START { XST_mUV(0,v);  XSRETURN(1); } STMT_END
77 #endif /* XSRETURN_UV */
78
79 /* set this to "1" to recompile the Perl script for every mail,
80    even if it hasn't changed */
81 #define DO_CLEAN "0"
82
83 /* distinguish between automatic and manual filtering */
84 #define AUTO_FILTER 0
85 #define MANU_FILTER 1
86
87 /* embedded Perl stuff */
88 static PerlInterpreter *my_perl = NULL;
89 EXTERN_C void xs_init(pTHX);
90 EXTERN_C void boot_DynaLoader (pTHX_ CV* cv);
91
92 /* plugin stuff */
93 static guint             filtering_hook_id;
94 static guint             manual_filtering_hook_id;
95 static MailFilteringData *mail_filtering_data  = NULL;
96 static MsgInfo           *msginfo              = NULL;
97 static gboolean          stop_filtering        = FALSE;
98 static gboolean          manual_filtering      = FALSE;
99 static gboolean          wrote_filter_log_head = FALSE;
100 static gint              filter_log_verbosity;
101 static FILE              *message_file         = NULL;
102 static gchar             *attribute_key        = NULL;
103
104 /* configuration */
105 static PerlPluginConfig config;
106
107 static PrefParam param[] = {
108   {"filter_log_verbosity", "2", &config.filter_log_verbosity,
109    P_INT, NULL, NULL, NULL},
110   {NULL, NULL, NULL, P_OTHER, NULL, NULL, NULL}
111 };
112
113
114 /* Utility functions */
115
116 /* fire and forget */
117 gint execute_detached(gchar **cmdline)
118 {
119   pid_t pid;
120   
121   if((pid = fork()) < 0) { /* fork error */
122     perror("fork");
123     return 0;
124   }
125   else if(pid > 0) {       /* parent */
126     waitpid(pid, NULL, 0);
127     return 1;
128   }
129   else {                   /* child */
130     if((pid = fork()) < 0) { /* fork error */
131       perror("fork");
132       return 0;
133     }
134     else if(pid > 0) {     /* child */
135       /* make grand child an orphan */
136       _exit(0);
137     }
138     else {                 /* grand child */
139       execvp(cmdline[0], cmdline);
140       perror("execvp");
141       _exit(1);
142     }
143   }
144   return 0;
145 }
146
147
148 /* filter logfile */
149 #define LOG_MANUAL 1
150 #define LOG_ACTION 2
151 #define LOG_MATCH  3
152
153 static void filter_log_write(gint type, gchar *text) {
154   if(filter_log_verbosity >= type) {
155     if(!wrote_filter_log_head) {
156       log_message(LOG_PROTOCOL, "From: %s || Subject: %s || Message-ID: %s\n",
157         msginfo->from    ? msginfo->from    : "<no From header>",
158         msginfo->subject ? msginfo->subject : "<no Subject header>",
159         msginfo->msgid   ? msginfo->msgid   : "<no message id>");
160       wrote_filter_log_head = TRUE;
161     }
162     switch(type) {
163     case LOG_MANUAL:
164       log_message(LOG_PROTOCOL, "    MANUAL: %s\n", text?text:"<no text specified>");
165       break;
166     case LOG_ACTION:
167       log_message(LOG_PROTOCOL, "    ACTION: %s\n", text?text:"<no text specified>");
168       break;
169     case LOG_MATCH:
170       log_message(LOG_PROTOCOL, "    MATCH:  %s\n", text?text:"<no text specified>");
171       break;
172     default:
173       g_warning("Perl Plugin: Wrong use of filter_log_write");
174       break;
175     }
176   }
177 }
178
179 /* Addressbook interface */
180
181 static PerlPluginTimedSList *email_slist = NULL;
182 static GHashTable *attribute_hash        = NULL;
183
184 /* addressbook email collector callback */
185 static gint add_to_email_slist(ItemPerson *person, const gchar *bookname)
186 {
187   PerlPluginEmailEntry *ee;
188   GList *nodeM;
189
190   /* Process each E-Mail address */
191   nodeM = person->listEMail;
192   while(nodeM) {
193     ItemEMail *email = nodeM->data;
194     ee = g_new0(PerlPluginEmailEntry,1);
195     g_return_val_if_fail(ee != NULL, -1);
196
197     if(email->address != NULL) ee->address  = g_strdup(email->address);
198     else                       ee->address  = NULL;
199     if(bookname != NULL)       ee->bookname = g_strdup(bookname);
200     else                       ee->bookname = NULL;
201
202     email_slist->g_slist = g_slist_prepend(email_slist->g_slist,ee);
203     nodeM = g_list_next(nodeM);
204   }
205   return 0;
206 }
207
208 /* free a GSList of PerlPluginEmailEntry's. */
209 static void free_PerlPluginEmailEntry_slist(GSList *slist)
210 {
211   GSList *walk;
212
213   if(slist == NULL)
214     return;
215
216   walk = slist;
217   for(; walk != NULL; walk = g_slist_next(walk)) {
218     PerlPluginEmailEntry *ee = (PerlPluginEmailEntry *) walk->data;
219     if(ee != NULL) {
220       if(ee->address  != NULL) g_free(ee->address);
221       if(ee->bookname != NULL) g_free(ee->bookname);
222       g_free(ee);
223       ee = NULL;
224     }
225   }
226   g_slist_free(slist);
227
228   debug_print("PerlPluginEmailEntry slist freed\n");
229 }
230
231 /* free email_slist */
232 static void free_email_slist(void)
233 {
234   if(email_slist == NULL)
235     return;
236
237   free_PerlPluginEmailEntry_slist(email_slist->g_slist);
238   email_slist->g_slist = NULL;
239
240   g_free(email_slist);
241   email_slist = NULL;
242
243   debug_print("email_slist freed\n");
244 }
245
246 /* check if tl->g_slist exists and is recent enough */
247 static gboolean update_PerlPluginTimedSList(PerlPluginTimedSList *tl)
248 {
249   gboolean retVal;
250   gchar *indexfile;
251   GStatBuf filestat;
252
253   if(tl->g_slist == NULL)
254     return TRUE;
255
256   indexfile = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, ADDRESSBOOK_INDEX_FILE, NULL);
257   if((g_stat(indexfile,&filestat) == 0) && filestat.st_mtime <= tl->mtime)
258      retVal = FALSE;
259   else
260     retVal = TRUE;
261
262   g_free(indexfile);
263   return retVal;
264 }
265
266 /* (re)initialize email slist */
267 static void init_email_slist(void)
268 {
269   gchar *indexfile;
270   GStatBuf filestat;
271
272   if(email_slist->g_slist != NULL) {
273     free_PerlPluginEmailEntry_slist(email_slist->g_slist);
274     email_slist->g_slist = NULL;
275   }
276
277   addrindex_load_person_attribute(NULL,add_to_email_slist);
278
279   indexfile = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, ADDRESSBOOK_INDEX_FILE, NULL);
280   if(g_stat(indexfile,&filestat) == 0)
281     email_slist->mtime = filestat.st_mtime;
282   g_free(indexfile);
283   debug_print("Initialisation of email slist completed\n");
284 }
285
286 /* check if given address is in given addressbook */
287 static gboolean addr_in_addressbook(gchar *addr, gchar *bookname)
288 {
289   /* If no book is given, check the address completion list
290    * (there may be other addresses that are not in the address book,
291    * added by other plugins). */
292   if(bookname == NULL) {
293     gboolean found;
294     start_address_completion(NULL);
295     found = (complete_matches_found(addr) > 0);
296     end_address_completion();
297     return found;
298   }
299   else {
300     GSList *walk;
301
302     /* check if email_list exists */
303     if(email_slist == NULL) {
304       email_slist = g_new0(PerlPluginTimedSList,1);
305       email_slist->g_slist = NULL;
306       debug_print("email_slist created\n");
307     }
308
309     if(update_PerlPluginTimedSList(email_slist))
310       init_email_slist();
311
312     walk = email_slist->g_slist;
313     for(; walk != NULL; walk = g_slist_next(walk)) {
314       PerlPluginEmailEntry *ee = (PerlPluginEmailEntry *) walk->data;
315       gchar *a = g_utf8_casefold(ee->address, -1);
316       gchar *b = g_utf8_casefold(addr, -1);
317       if((!g_utf8_collate(a,b)) &&
318          ((bookname == NULL) || (!strcmp(ee->bookname,bookname)))) {
319         g_free(a);
320         g_free(b);
321         return TRUE;
322       }
323       g_free(a);
324       g_free(b);
325     }
326   }
327
328   return FALSE;
329 }
330
331 /* attribute hash collector callback */
332 static gint add_to_attribute_hash(ItemPerson *person, const gchar *bookname)
333 {
334   PerlPluginTimedSList *tl;
335   PerlPluginAttributeEntry *ae;
336   GList *nodeA;
337   GList *nodeM;
338
339   nodeA = person->listAttrib;
340   /* Process each User Attribute */
341   while(nodeA) {
342     UserAttribute *attrib = nodeA->data;
343     if(attrib->name && !strcmp(attrib->name,attribute_key) ) {
344       /* Process each E-Mail address */
345       nodeM = person->listEMail;
346       while(nodeM) {
347   ItemEMail *email = nodeM->data;
348
349   ae = g_new0(PerlPluginAttributeEntry,1);
350   g_return_val_if_fail(ae != NULL, -1);
351
352   if(email->address != NULL) ae->address  = g_strdup(email->address);
353   else                       ae->address  = NULL;
354   if(attrib->value  != NULL) ae->value    = g_strdup(attrib->value);
355   else                       ae->value    = NULL;
356   if(bookname != NULL)       ae->bookname = g_strdup(bookname);
357   else                       ae->bookname = NULL;
358
359   tl = (PerlPluginTimedSList *) g_hash_table_lookup(attribute_hash,attribute_key);
360   tl->g_slist = g_slist_prepend(tl->g_slist,ae);
361
362   nodeM = g_list_next(nodeM);
363       }
364     }
365     nodeA = g_list_next(nodeA);
366   }
367   
368   return 0;
369 }
370
371 /* free a key of the attribute hash */
372 static gboolean free_attribute_hash_key(gpointer key, gpointer value, gpointer user_data)
373 {
374   GSList *walk;
375   PerlPluginTimedSList *tl;
376
377   debug_print("Freeing key `%s' from attribute_hash\n",key?(char*)key:"");
378
379   tl = (PerlPluginTimedSList *) value;
380
381   if(tl != NULL) {
382     if(tl->g_slist != NULL) {
383       walk = tl->g_slist;
384       for(; walk != NULL; walk = g_slist_next(walk)) {
385   PerlPluginAttributeEntry *ae = (PerlPluginAttributeEntry *) walk->data;
386   if(ae != NULL) {
387     if(ae->address  != NULL) g_free(ae->address);
388     if(ae->value    != NULL) g_free(ae->value);
389     if(ae->bookname != NULL) g_free(ae->bookname);
390     g_free(ae);
391     ae = NULL;
392   }
393       }
394       g_slist_free(tl->g_slist);
395       tl->g_slist = NULL;
396     }
397     g_free(tl);
398     tl = NULL;
399   }
400
401   if(key != NULL) {
402     g_free(key);
403     key = NULL;
404   }
405
406   return TRUE;
407 }
408
409 /* free whole attribute hash */
410 static void free_attribute_hash(void)
411 {
412   if(attribute_hash == NULL)
413     return;
414
415   g_hash_table_foreach_remove(attribute_hash,free_attribute_hash_key,NULL);
416   g_hash_table_destroy(attribute_hash);
417   attribute_hash = NULL;
418
419   debug_print("attribute_hash freed\n");
420 }
421
422 /* Free the key if it exists. Insert the new key. */
423 static void insert_attribute_hash(gchar *attr)
424 {
425   PerlPluginTimedSList *tl;
426   gchar *indexfile;
427   GStatBuf filestat;
428
429   /* Check if key exists. Free it if it does. */
430   if((tl = g_hash_table_lookup(attribute_hash,attr)) != NULL) {
431     gpointer origkey;
432     gpointer value;
433     g_hash_table_lookup_extended(attribute_hash,attr,&origkey,&value);
434     g_hash_table_remove(attribute_hash,origkey);
435     free_attribute_hash_key(origkey,value,NULL);
436     debug_print("Existing key `%s' freed.\n",attr);
437   }
438
439   tl = g_new0(PerlPluginTimedSList,1);
440   tl->g_slist = NULL;
441
442   attribute_key = g_strdup(attr);
443   g_hash_table_insert(attribute_hash,attribute_key,tl);  
444
445   addrindex_load_person_attribute(attribute_key,add_to_attribute_hash);
446
447   indexfile = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, ADDRESSBOOK_INDEX_FILE, NULL);
448   if(g_stat(indexfile,&filestat) == 0)
449     tl->mtime = filestat.st_mtime;
450   g_free(indexfile);
451
452   debug_print("added key `%s' to attribute_hash\n",attribute_key?attribute_key:"");
453 }
454
455 /* check if an update of the attribute hash entry is necessary */
456 static gboolean update_attribute_hash(const gchar *attr)
457 {
458   PerlPluginTimedSList *tl;
459
460   /* check if key attr exists in the attribute hash */
461   if((tl = (PerlPluginTimedSList*) g_hash_table_lookup(attribute_hash,attr)) == NULL)
462     return TRUE;
463
464   /* check if entry is recent enough */
465   return update_PerlPluginTimedSList(tl);
466 }
467
468 /* given an email address, return attribute value of specific book */
469 static gchar* get_attribute_value(gchar *email, gchar *attr, gchar *bookname)
470 {
471   GSList *walk;
472   PerlPluginTimedSList *tl;
473
474   /* check if attribute hash exists */
475   if(attribute_hash == NULL) {
476     attribute_hash = g_hash_table_new(g_str_hash,g_str_equal);
477     debug_print("attribute_hash created\n");
478   }
479
480   if(update_attribute_hash(attr)) {
481     debug_print("Initialisation of attribute hash entry `%s' is necessary\n",attr);
482     insert_attribute_hash(attr);
483   }
484   
485   if((tl = (PerlPluginTimedSList*) g_hash_table_lookup(attribute_hash,attr)) == NULL)
486     return NULL;  
487
488   walk = tl->g_slist;
489   for(; walk != NULL; walk = g_slist_next(walk)) {
490     PerlPluginAttributeEntry *ae = (PerlPluginAttributeEntry *) walk->data;
491     gchar *a, *b;
492     a = g_utf8_strdown(ae->address, -1);
493     b = g_utf8_strdown(email, -1);
494     if(!g_utf8_collate(a, b)) {
495       if((bookname == NULL) ||
496    ((ae->bookname != NULL) && !strcmp(bookname,ae->bookname))) {
497         g_free(a); g_free(b);
498   return ae->value;
499       }
500     }
501     g_free(a); g_free(b);
502   }
503   return NULL;
504 }
505
506 /* free up all memory allocated with lists */
507 static void free_all_lists(void)
508 {
509   /* email list */
510   free_email_slist();
511
512   /* attribute hash */
513   free_attribute_hash();
514 }
515
516
517
518 /* ClawsMail::C module */
519
520 /* Initialization */
521
522 /* ClawsMail::C::filter_init(int) */
523 static XS(XS_ClawsMail_filter_init)
524 {
525   int flag;
526   /* flags:
527    *
528    *    msginfo
529    *          1 size
530    *          2 date
531    *          3 from
532    *          4 to
533    *          5 cc
534    *          6 newsgroups
535    *          7 subject
536    *          8 msgid
537    *          9 inreplyto
538    *         10 xref
539    *         11 xface
540    *         12 dispositionnotificationto
541    *         13 returnreceiptto
542    *         14 references
543    *         15 score
544    *         16 not used anymore
545    *         17 not used anymore
546    *         18 not used anymore
547    *         19 hidden
548    *         20 message file path
549    *         21 partial_recv
550    *         22 total_size
551    *         23 account_server
552    *         24 account_login
553    *         25 planned_download
554    *
555    *    general
556    *        100 manual
557    */
558   char *charp;
559   gchar buf[BUFFSIZE];
560   GSList *walk;
561   int ii;
562   gchar *xface;
563
564   dXSARGS;
565   if(items != 1) {
566     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::init");
567     XSRETURN_UNDEF;
568   }
569   flag = SvIV(ST(0));
570   switch(flag) {
571
572     /* msginfo */
573   case  1:
574     msginfo->size       ? XSRETURN_UV(msginfo->size)       : XSRETURN_UNDEF;
575   case  2:
576     msginfo->date       ? XSRETURN_PV(msginfo->date)       : XSRETURN_UNDEF;
577   case  3:
578     msginfo->from       ? XSRETURN_PV(msginfo->from)       : XSRETURN_UNDEF;
579   case  4:
580     msginfo->to         ? XSRETURN_PV(msginfo->to)         : XSRETURN_UNDEF;
581   case  5:
582     msginfo->cc         ? XSRETURN_PV(msginfo->cc)         : XSRETURN_UNDEF;
583   case  6:
584     msginfo->newsgroups ? XSRETURN_PV(msginfo->newsgroups) : XSRETURN_UNDEF;
585   case  7:
586     msginfo->subject    ? XSRETURN_PV(msginfo->subject)    : XSRETURN_UNDEF;
587   case  8:
588     msginfo->msgid      ? XSRETURN_PV(msginfo->msgid)      : XSRETURN_UNDEF;
589   case  9:
590     msginfo->inreplyto  ? XSRETURN_PV(msginfo->inreplyto)  : XSRETURN_UNDEF;
591   case 10:
592     msginfo->xref       ? XSRETURN_PV(msginfo->xref)       : XSRETURN_UNDEF;
593   case 11:
594     xface = procmsg_msginfo_get_avatar(msginfo, AVATAR_XFACE);
595     xface               ? XSRETURN_PV(xface)               : XSRETURN_UNDEF;
596   case 12:
597     (msginfo->extradata && msginfo->extradata->dispositionnotificationto) ?
598       XSRETURN_PV(msginfo->extradata->dispositionnotificationto) : XSRETURN_UNDEF;
599   case 13:
600     (msginfo->extradata && msginfo->extradata->returnreceiptto) ?
601       XSRETURN_PV(msginfo->extradata->returnreceiptto)     : XSRETURN_UNDEF;
602   case 14:
603     EXTEND(SP, g_slist_length(msginfo->references));
604     ii = 0;
605     for(walk = msginfo->references; walk != NULL; walk = g_slist_next(walk))
606       XST_mPV(ii++,walk->data ? (gchar*) walk->data: "");
607     ii ? XSRETURN(ii) : XSRETURN_UNDEF;
608   case 15:
609     msginfo->score      ? XSRETURN_IV(msginfo->score)      : XSRETURN_UNDEF;
610   case 19:
611     msginfo->hidden     ? XSRETURN_IV(msginfo->hidden)     : XSRETURN_UNDEF;
612   case 20:
613     if((charp = procmsg_get_message_file_path(msginfo)) != NULL) {
614       strncpy2(buf,charp,sizeof(buf));
615       g_free(charp);
616       XSRETURN_PV(buf);
617     }
618     else
619       XSRETURN_UNDEF;
620   case 21:
621     (msginfo->extradata && msginfo->extradata->partial_recv) ?
622       XSRETURN_PV(msginfo->extradata->partial_recv)        : XSRETURN_UNDEF;
623   case 22:
624     msginfo->total_size ? XSRETURN_IV(msginfo->total_size) : XSRETURN_UNDEF;
625   case 23:
626     (msginfo->extradata && msginfo->extradata->account_server) ?
627       XSRETURN_PV(msginfo->extradata->account_server)      : XSRETURN_UNDEF;
628   case 24:
629     (msginfo->extradata && msginfo->extradata->account_login) ?
630       XSRETURN_PV(msginfo->extradata->account_login)       : XSRETURN_UNDEF;
631   case 25:
632     msginfo->planned_download ?
633       XSRETURN_IV(msginfo->planned_download)               : XSRETURN_UNDEF;
634
635     /* general */
636   case 100:
637     if(manual_filtering)
638       XSRETURN_YES;
639     else
640       XSRETURN_NO;
641   default:
642     g_warning("Perl Plugin: Wrong argument to ClawsMail::C::init");
643     XSRETURN_UNDEF;    
644   }
645 }
646
647 /* ClawsMail::C::open_mail_file */
648 static XS(XS_ClawsMail_open_mail_file)
649 {
650   char *file;
651   gchar buf[BUFFSIZE];
652
653   dXSARGS;
654   if(items != 0) {
655     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::open_mail_file");
656     XSRETURN_UNDEF;
657   }
658   file = procmsg_get_message_file_path(msginfo);
659   if(!file)
660     XSRETURN_UNDEF;
661   strncpy2(buf,file,sizeof(buf));
662   g_free(file);
663   if((message_file = fopen(buf, "rb")) == NULL) {
664     FILE_OP_ERROR(buf, "fopen");
665     g_warning("Perl Plugin: File open error in ClawsMail::C::open_mail_file");
666     XSRETURN_UNDEF;
667   }
668 }
669
670 /* ClawsMail::C::close_mail_file */
671 static XS(XS_ClawsMail_close_mail_file)
672 {
673   dXSARGS;
674   if(items != 0) {
675     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::close_mail_file");
676     XSRETURN_UNDEF;
677   }
678   if(message_file != NULL)
679     fclose(message_file);
680   XSRETURN_YES;
681 }
682
683 /* ClawsMail::C::get_next_header */
684 static XS(XS_ClawsMail_get_next_header)
685 {
686   gchar buf[BUFFSIZE];
687   Header *header;
688
689   dXSARGS;
690   if(items != 0) {
691     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::get_next_header");
692     XSRETURN_EMPTY;
693   }
694   if(message_file == NULL) {
695     g_warning("Perl Plugin: Message file not open. Use ClawsMail::C::open_message_file first.");
696     XSRETURN_EMPTY;
697   }
698   if(procheader_get_one_field(buf, sizeof(buf), message_file, NULL) != -1) {
699     header = procheader_parse_header(buf);
700     EXTEND(SP, 2);
701     if(header) {
702       XST_mPV(0,header->name);
703       XST_mPV(1,header->body);
704       procheader_header_free(header);
705     }
706     else {
707       XST_mPV(0,"");
708       XST_mPV(1,"");
709     }
710     XSRETURN(2);
711   }
712   else
713     XSRETURN_EMPTY;
714 }
715
716 /* ClawsMail::C::get_next_body_line */
717 static XS(XS_ClawsMail_get_next_body_line)
718 {
719   gchar buf[BUFFSIZE];
720
721   dXSARGS;
722   if(items != 0) {
723     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::get_next_body_line");
724     XSRETURN_UNDEF;
725   }
726   if(message_file == NULL) {
727     g_warning("Perl Plugin: Message file not open. Use ClawsMail::C::open_message_file first.");
728     XSRETURN_UNDEF;
729   }
730   if(fgets(buf, sizeof(buf), message_file) != NULL)
731     XSRETURN_PV(buf);
732   else
733     XSRETURN_UNDEF;
734 }
735
736
737 /* Filter matchers */
738
739 /* ClawsMail::C::check_flag(int) */
740 static XS(XS_ClawsMail_check_flag)
741 {
742   int flag;
743   /* flags:  1 marked
744    *         2 unread
745    *         3 deleted
746    *       4 new
747    *       5 replied
748    *       6 forwarded
749    *       7 locked
750    *         8 ignore thread
751    */
752
753   dXSARGS;
754   if(items != 1) {
755     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::check_flag");
756     XSRETURN_UNDEF;
757   }
758   flag = SvIV(ST(0));
759
760   switch(flag) {
761   case 1:
762     if(MSG_IS_MARKED(msginfo->flags)) {
763       filter_log_write(LOG_MATCH,"marked");
764       XSRETURN_YES;
765     }
766     else
767       XSRETURN_NO;
768   case 2:
769     if(MSG_IS_UNREAD(msginfo->flags)) {
770       filter_log_write(LOG_MATCH,"unread");
771       XSRETURN_YES;
772     }
773     else
774       XSRETURN_NO;
775   case 3:
776     if(MSG_IS_DELETED(msginfo->flags)) {
777       filter_log_write(LOG_MATCH,"deleted");
778       XSRETURN_YES;
779     }
780     else
781       XSRETURN_NO;
782   case 4:
783     if(MSG_IS_NEW(msginfo->flags)) {
784       filter_log_write(LOG_MATCH,"new");
785       XSRETURN_YES;
786     }
787     else
788       XSRETURN_NO;
789   case 5:
790     if(MSG_IS_REPLIED(msginfo->flags)) {
791       filter_log_write(LOG_MATCH,"replied");
792       XSRETURN_YES;
793     }
794     else
795       XSRETURN_NO;
796   case 6:
797     if(MSG_IS_FORWARDED(msginfo->flags)) {
798       filter_log_write(LOG_MATCH,"forwarded");
799       XSRETURN_YES;
800     }
801     else
802       XSRETURN_NO;
803   case 7:
804     if(MSG_IS_LOCKED(msginfo->flags)) {
805       filter_log_write(LOG_MATCH,"locked");
806       XSRETURN_YES;
807     }
808     else
809       XSRETURN_NO;
810   case 8:
811     if(MSG_IS_IGNORE_THREAD(msginfo->flags)) {
812       filter_log_write(LOG_MATCH,"ignore_thread");
813       XSRETURN_YES;
814     }
815     else
816       XSRETURN_NO;
817   default:
818     g_warning("Perl Plugin: Unknown argument to ClawsMail::C::check_flag");
819     XSRETURN_UNDEF;
820   }
821 }
822
823 /* ClawsMail::C::colorlabel(int) */
824 static XS(XS_ClawsMail_colorlabel)
825 {
826   int color;
827
828   dXSARGS;
829   if(items != 1) {
830     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::colorlabel");
831     XSRETURN_UNDEF;
832   }
833   color = SvIV(ST(0));
834
835   if((MSG_GET_COLORLABEL_VALUE(msginfo->flags) == (guint32)color)) {
836     filter_log_write(LOG_MATCH,"colorlabel");
837     XSRETURN_YES;
838   }
839   else
840     XSRETURN_NO;
841 }
842
843 /* ClawsMail::C::age_greater(int) */
844 static XS(XS_ClawsMail_age_greater)
845 {
846   int age;
847   time_t t;
848
849   dXSARGS;
850   if(items != 1) {
851     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::age_greater");
852     XSRETURN_UNDEF;
853   }
854   age = SvIV(ST(0));
855   t = time(NULL);
856   if(((t - msginfo->date_t) / 86400) >= age) {
857     filter_log_write(LOG_MATCH,"age_greater");
858     XSRETURN_YES;
859   }
860   else
861     XSRETURN_NO;
862 }
863
864 /* ClawsMail::C::age_lower(int) */
865 static XS(XS_ClawsMail_age_lower)
866 {
867   int age;
868   time_t t;
869
870   dXSARGS;
871   if(items != 1) {
872     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::age_lower");
873     XSRETURN_UNDEF;
874   }
875   age = SvIV(ST(0));
876   t = time(NULL);
877   if(((t - msginfo->date_t) / 86400) <= age) {
878     filter_log_write(LOG_MATCH,"age_lower");
879     XSRETURN_YES;
880   }
881   else
882     XSRETURN_NO;
883 }
884
885 /* ClawsMail::C::tagged() */
886 static XS(XS_ClawsMail_tagged)
887 {
888   dXSARGS;
889   if(items != 0) {
890     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::tagged");
891     XSRETURN_UNDEF;
892   }
893
894   return msginfo->tags ? XSRETURN_YES : XSRETURN_NO;
895 }
896
897 /* ClawsMail::C::get_tags() */
898 static XS(XS_ClawsMail_get_tags)
899 {
900   guint iTag;
901   guint num_tags;
902   GSList *walk;
903
904   dXSARGS;
905   if(items != 0) {
906     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::get_tags");
907     XSRETURN_UNDEF;
908   }
909
910   num_tags = g_slist_length(msginfo->tags);
911
912   EXTEND(SP, num_tags);
913   iTag = 0;
914   for(walk = msginfo->tags; walk != NULL; walk = g_slist_next(walk)) {
915     const char *tag_str;
916     tag_str = tags_get_tag(GPOINTER_TO_INT(walk->data));
917     XST_mPV(iTag++, tag_str ? tag_str: "");
918   }
919
920   XSRETURN(num_tags);
921 }
922
923
924
925 /* ClawsMail::C::set_tag(char*) */
926 static XS(XS_ClawsMail_set_tag)
927 {
928   gchar *tag_str;
929   gint tag_id;
930
931   dXSARGS;
932   if(items != 1) {
933     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::set_tag");
934     XSRETURN_UNDEF;
935   }
936
937   tag_str = SvPV_nolen(ST(0));
938   tag_id = tags_get_id_for_str(tag_str);
939   if(tag_id == -1) {
940     g_warning("Perl Plugin: set_tag requested setting of a non-existing tag");
941     XSRETURN_UNDEF;
942   }
943
944   procmsg_msginfo_update_tags(msginfo, TRUE, tag_id);
945
946   XSRETURN_YES;
947 }
948
949 /* ClawsMail::C::unset_tag(char*) */
950 static XS(XS_ClawsMail_unset_tag)
951 {
952   gchar *tag_str;
953   gint tag_id;
954
955   dXSARGS;
956   if(items != 1) {
957     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::unset_tag");
958     XSRETURN_UNDEF;
959   }
960
961   tag_str = SvPV_nolen(ST(0));
962   tag_id = tags_get_id_for_str(tag_str);
963   if(tag_id == -1) {
964     g_warning("Perl Plugin: unset_tag requested setting of a non-existing tag");
965     XSRETURN_UNDEF;
966   }
967
968   procmsg_msginfo_update_tags(msginfo, FALSE, tag_id);
969
970   XSRETURN_YES;
971 }
972
973 /* ClawsMail::C::clear_tags() */
974 static XS(XS_ClawsMail_clear_tags)
975 {
976   dXSARGS;
977   if(items != 0) {
978     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::clear_tags");
979     XSRETURN_UNDEF;
980   }
981
982   procmsg_msginfo_clear_tags(msginfo);
983   XSRETURN_YES;
984 }
985
986
987 /* ClawsMail::C::make_sure_tag_exists(char*) */
988 static XS(XS_ClawsMail_make_sure_tag_exists)
989 {
990   gchar *tag_str;
991
992   dXSARGS;
993   if(items != 1) {
994     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::make_sure_tag_exists");
995     XSRETURN_UNDEF;
996   }
997
998   tag_str = SvPV_nolen(ST(0));
999
1000   if(IS_NOT_RESERVED_TAG(tag_str) == FALSE) {
1001     g_warning("Perl Plugin: Trying to create a tag with a reserved name: %s", tag_str);
1002     XSRETURN_UNDEF;
1003   }
1004
1005   tags_add_tag(tag_str);
1006
1007   XSRETURN_YES;
1008 }
1009
1010
1011
1012 /* ClawsMail::C::make_sure_folder_exists(char*) */
1013 static XS(XS_ClawsMail_make_sure_folder_exists)
1014 {
1015   gchar *identifier;
1016   FolderItem *item;
1017
1018   dXSARGS;
1019   if(items != 1) {
1020     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::make_sure_folder_exists");
1021     XSRETURN_UNDEF;
1022   }
1023
1024   identifier = SvPV_nolen(ST(0));
1025   item = folder_get_item_from_identifier(identifier);
1026   if(item)
1027     XSRETURN_YES;
1028   else
1029     XSRETURN_NO;
1030 }
1031
1032
1033 /* ClawsMail::C::addr_in_addressbook(char* [, char*]) */
1034 static XS(XS_ClawsMail_addr_in_addressbook)
1035 {
1036   gchar *addr;
1037   gchar *bookname;
1038   gboolean found;
1039
1040   dXSARGS;
1041   if(items != 1 && items != 2) {
1042     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::addr_in_addressbook");
1043     XSRETURN_UNDEF;
1044   }
1045
1046   addr = SvPV_nolen(ST(0));
1047
1048   if(items == 1) {
1049     found = addr_in_addressbook(addr,NULL);
1050   }
1051   else {
1052     bookname = SvPV_nolen(ST(1));
1053     found = addr_in_addressbook(addr,bookname);
1054   }
1055
1056   if(found) {
1057     filter_log_write(LOG_MATCH,"addr_in_addressbook");
1058     XSRETURN_YES;
1059   }
1060   else
1061     XSRETURN_NO;
1062 }
1063
1064
1065 /* Filter actions */
1066
1067 /* ClawsMail::C::set_flag(int) */
1068 static XS(XS_ClawsMail_set_flag)
1069 {
1070   int flag;
1071   /* flags:  1 mark
1072    *         2 mark as unread
1073    *         7 lock
1074    */
1075
1076   dXSARGS;
1077   if(items != 1) {
1078     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::set_flag");
1079     XSRETURN_UNDEF;
1080   }
1081   flag = SvIV(ST(0));
1082
1083   switch(flag) {
1084   case 1:
1085     MSG_SET_PERM_FLAGS(msginfo->flags, MSG_MARKED);
1086     procmsg_msginfo_set_flags(msginfo, MSG_MARKED,0);
1087     filter_log_write(LOG_ACTION,"mark");
1088     XSRETURN_YES;
1089   case 2:
1090     MSG_SET_PERM_FLAGS(msginfo->flags, MSG_UNREAD);
1091     procmsg_msginfo_set_flags(msginfo, MSG_UNREAD,0);
1092     filter_log_write(LOG_ACTION,"mark_as_unread");
1093     XSRETURN_YES;
1094   case 7:
1095     MSG_SET_PERM_FLAGS(msginfo->flags, MSG_LOCKED);
1096     procmsg_msginfo_set_flags(msginfo, MSG_LOCKED,0);
1097     filter_log_write(LOG_ACTION,"lock");
1098     XSRETURN_YES;
1099   default:
1100     g_warning("Perl Plugin: Unknown argument to ClawsMail::C::set_flag");
1101     XSRETURN_UNDEF;
1102   }
1103 }
1104
1105 /* ClawsMail::C::unset_flag(int) */
1106 static XS(XS_ClawsMail_unset_flag)
1107 {
1108   int flag;
1109   /*
1110    * flags:  1 unmark
1111    *         2 mark as read
1112    *         7 unlock
1113    */
1114
1115   dXSARGS;
1116   if(items != 1) {
1117     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::unset_flag");
1118     XSRETURN_UNDEF;
1119   }
1120   flag = SvIV(ST(0));
1121
1122   switch(flag) {
1123   case 1:
1124     MSG_UNSET_PERM_FLAGS(msginfo->flags, MSG_MARKED);
1125     procmsg_msginfo_unset_flags(msginfo, MSG_MARKED,0);
1126     filter_log_write(LOG_ACTION,"unmark");
1127     XSRETURN_YES;
1128   case 2:
1129     MSG_UNSET_PERM_FLAGS(msginfo->flags, MSG_UNREAD | MSG_NEW);
1130     procmsg_msginfo_unset_flags(msginfo, MSG_UNREAD | MSG_NEW,0);
1131     filter_log_write(LOG_ACTION,"mark_as_read");
1132     XSRETURN_YES;
1133   case 7:
1134     MSG_UNSET_PERM_FLAGS(msginfo->flags, MSG_LOCKED);
1135     procmsg_msginfo_unset_flags(msginfo, MSG_LOCKED,0);
1136     filter_log_write(LOG_ACTION,"unlock");
1137     XSRETURN_YES;
1138   default:
1139     g_warning("Perl Plugin: Unknown argument to ClawsMail::C::unset_flag");
1140     XSRETURN_UNDEF;
1141   }
1142 }
1143
1144 /* ClawsMail::C::move(char*) */
1145 static XS(XS_ClawsMail_move)
1146 {
1147   gchar *targetfolder;
1148   gchar *logtext;
1149   FolderItem *dest_folder;
1150
1151   dXSARGS;
1152   if(items != 1) {
1153     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::move");
1154     XSRETURN_UNDEF;
1155   }
1156
1157   targetfolder = SvPV_nolen(ST(0));
1158   dest_folder = folder_find_item_from_identifier(targetfolder);
1159
1160   if (!dest_folder) {
1161     g_warning("Perl Plugin: move: folder not found '%s'",
1162       targetfolder ? targetfolder :"");
1163     XSRETURN_UNDEF;
1164   }
1165   if (folder_item_move_msg(dest_folder, msginfo) == -1) {
1166     g_warning("Perl Plugin: move:  could not move message");
1167     XSRETURN_UNDEF;
1168   }
1169   stop_filtering = TRUE;
1170   logtext = g_strconcat("move to ", targetfolder, NULL);
1171   filter_log_write(LOG_ACTION, logtext);
1172   g_free(logtext);
1173   XSRETURN_YES;
1174 }
1175
1176 /* ClawsMail::C::copy(char*) */
1177 static XS(XS_ClawsMail_copy)
1178 {
1179   char *targetfolder;
1180   gchar *logtext;
1181   FolderItem *dest_folder;
1182
1183   dXSARGS;
1184   if(items != 1) {
1185     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::copy");
1186     XSRETURN_UNDEF;
1187   }
1188   targetfolder = SvPV_nolen(ST(0));
1189   dest_folder = folder_find_item_from_identifier(targetfolder);
1190
1191   if (!dest_folder) {
1192     g_warning("Perl Plugin: copy: folder not found '%s'",
1193       targetfolder ? targetfolder :"");
1194     XSRETURN_UNDEF;
1195   }
1196   if (folder_item_copy_msg(dest_folder, msginfo) == -1) {
1197     g_warning("Perl Plugin: copy: could not copy message");
1198     XSRETURN_UNDEF;
1199   }
1200   logtext = g_strconcat("copy to ", targetfolder, NULL);
1201   filter_log_write(LOG_ACTION, logtext);
1202   g_free(logtext);
1203   XSRETURN_YES;
1204 }
1205
1206 /* ClawsMail::C::delete */
1207 static XS(XS_ClawsMail_delete)
1208 {
1209   dXSARGS;
1210   if(items != 0) {
1211     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::delete");
1212     XSRETURN_UNDEF;
1213   }
1214   folder_item_remove_msg(msginfo->folder, msginfo->msgnum);
1215   stop_filtering = TRUE;
1216   filter_log_write(LOG_ACTION, "delete");
1217   XSRETURN_YES;
1218 }
1219
1220 /* ClawsMail::C::hide */
1221 static XS(XS_ClawsMail_hide)
1222 {
1223   dXSARGS;
1224   if(items != 0) {
1225     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::hide");
1226     XSRETURN_UNDEF;
1227   }
1228   msginfo->hidden = TRUE;
1229   filter_log_write(LOG_ACTION, "hide");
1230   XSRETURN_YES;
1231 }
1232
1233
1234 /* ClawsMail::C::color(int) */
1235 static XS(XS_ClawsMail_color)
1236 {
1237   int color;
1238   gchar *logtext;
1239
1240   dXSARGS;
1241   if(items != 1) {
1242     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::color");
1243     XSRETURN_UNDEF;
1244   }
1245   color = SvIV(ST(0));
1246   procmsg_msginfo_unset_flags(msginfo, MSG_CLABEL_FLAG_MASK, 0); 
1247   procmsg_msginfo_set_flags(msginfo, MSG_COLORLABEL_TO_FLAGS(color), 0);
1248   MSG_SET_COLORLABEL_VALUE(msginfo->flags,color);
1249
1250   logtext = g_strdup_printf("color: %d", color);
1251   filter_log_write(LOG_ACTION, logtext);
1252   g_free(logtext);
1253
1254   XSRETURN_YES;
1255 }
1256
1257 /* ClawsMail::C::change_score(int) */
1258 static XS(XS_ClawsMail_change_score)
1259 {
1260   int score;
1261   gchar *logtext;
1262
1263   dXSARGS;
1264   if(items != 1) {
1265     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::change_score");
1266     XSRETURN_UNDEF;
1267   }
1268   score = SvIV(ST(0));
1269   msginfo->score += score;
1270
1271   logtext = g_strdup_printf("change score: %+d", score);
1272   filter_log_write(LOG_ACTION, logtext);
1273   g_free(logtext);
1274
1275   XSRETURN_IV(msginfo->score);
1276 }
1277
1278 /* ClawsMail::C::set_score(int) */
1279 static XS(XS_ClawsMail_set_score)
1280 {
1281   int score;
1282   gchar *logtext;
1283
1284   dXSARGS;
1285   if(items != 1) {
1286     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::set_score");
1287     XSRETURN_UNDEF;
1288   }
1289   score = SvIV(ST(0));
1290   msginfo->score = score;
1291
1292   logtext = g_strdup_printf("set score: %d", score);
1293   filter_log_write(LOG_ACTION, logtext);
1294   g_free(logtext);
1295
1296   XSRETURN_IV(msginfo->score);
1297 }
1298
1299 /* ClawsMail::C::forward(int,int,char*) */
1300 static XS(XS_ClawsMail_forward)
1301 {
1302   int flag;
1303   /* flags:  1 forward
1304    *         2 forward as attachment
1305    */
1306   int account_id,val;
1307   char *dest;
1308   gchar *logtext;
1309   PrefsAccount *account;
1310   Compose *compose;
1311
1312   dXSARGS;
1313   if(items != 3) {
1314     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::forward");
1315     XSRETURN_UNDEF;
1316   }
1317
1318   flag = SvIV(ST(0));
1319   account_id = SvIV(ST(1));
1320   dest = SvPV_nolen(ST(2));
1321
1322   account = account_find_from_id(account_id);
1323   compose = compose_forward(account, msginfo,
1324           flag == 1 ? FALSE : TRUE,
1325           NULL, TRUE, TRUE);
1326   compose_entry_append(compose, dest,
1327            compose->account->protocol == A_NNTP ?
1328            COMPOSE_NEWSGROUPS : COMPOSE_TO, PREF_NONE);
1329
1330   val = compose_send(compose);
1331
1332   if(val == 0) {
1333
1334     logtext = g_strdup_printf("forward%s to %s",
1335             flag==2 ? " as attachment" : "",
1336             dest    ? dest : "<unknown destination>");
1337     filter_log_write(LOG_ACTION, logtext);
1338     g_free(logtext);
1339
1340     XSRETURN_YES;
1341   }
1342   else
1343     XSRETURN_UNDEF;
1344 }
1345
1346 /* ClawsMail::C::redirect(int,char*) */
1347 static XS(XS_ClawsMail_redirect)
1348 {
1349   int account_id,val;
1350   char *dest;
1351   gchar *logtext;
1352   PrefsAccount *account;
1353   Compose *compose;
1354
1355   dXSARGS;
1356   if(items != 2) {
1357     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::redirect");
1358     XSRETURN_UNDEF;
1359   }
1360
1361   account_id = SvIV(ST(0));
1362   dest = SvPV_nolen(ST(1));
1363
1364   account = account_find_from_id(account_id);
1365   compose = compose_redirect(account, msginfo, TRUE);
1366   
1367   if (compose->account->protocol == A_NNTP)
1368     XSRETURN_UNDEF;
1369   else
1370     compose_entry_append(compose, dest, COMPOSE_TO, PREF_NONE);
1371
1372   val = compose_send(compose);
1373   
1374   if(val == 0) {
1375     
1376     logtext = g_strdup_printf("redirect to %s",
1377             dest ? dest : "<unknown destination>");
1378     filter_log_write(LOG_ACTION, logtext);
1379     g_free(logtext);
1380
1381     XSRETURN_YES;
1382   }
1383   else
1384     XSRETURN_UNDEF;
1385 }
1386
1387
1388 /* Utilities */
1389
1390 /* ClawsMail::C::move_to_trash */
1391 static XS(XS_ClawsMail_move_to_trash)
1392 {
1393   FolderItem *dest_folder;
1394   
1395   dXSARGS;
1396   if(items != 0) {
1397     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::move_to_trash");
1398     XSRETURN_UNDEF;
1399   }
1400   dest_folder = folder_get_default_trash();
1401   if (!dest_folder) {
1402     g_warning("Perl Plugin: move_to_trash: Trash folder not found");
1403     XSRETURN_UNDEF;
1404   }
1405   if (folder_item_move_msg(dest_folder, msginfo) == -1) {
1406     g_warning("Perl Plugin: move_to_trash: could not move message to trash");
1407     XSRETURN_UNDEF;
1408   }
1409   stop_filtering = TRUE;
1410   filter_log_write(LOG_ACTION, "move_to_trash");
1411   XSRETURN_YES;
1412 }
1413
1414 /* ClawsMail::C::abort */
1415 static XS(XS_ClawsMail_abort)
1416 {
1417   FolderItem *inbox_folder;
1418
1419   dXSARGS;
1420   if(items != 0) {
1421     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::abort");
1422     XSRETURN_UNDEF;
1423   }
1424   if(!manual_filtering) {
1425     inbox_folder = folder_get_default_inbox();
1426     if (!inbox_folder) {
1427       g_warning("Perl Plugin: abort: Inbox folder not found");
1428       XSRETURN_UNDEF;
1429     }
1430     if (folder_item_move_msg(inbox_folder, msginfo) == -1) {
1431       g_warning("Perl Plugin: abort: Could not move message to default inbox");
1432       XSRETURN_UNDEF;
1433     }
1434     filter_log_write(LOG_ACTION, "abort -- message moved to default inbox");
1435   }
1436   else
1437     filter_log_write(LOG_ACTION, "abort");
1438
1439   stop_filtering = TRUE;
1440   XSRETURN_YES;
1441 }
1442
1443 /* ClawsMail::C::get_attribute_value(char*,char*[,char*]) */
1444 static XS(XS_ClawsMail_get_attribute_value)
1445 {
1446   char *addr;
1447   char *attr;
1448   char *attribute_value;
1449   char *bookname;
1450
1451   dXSARGS;
1452   if(items != 2 && items != 3) {
1453     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::get_attribute_value");
1454     XSRETURN_UNDEF;
1455   }
1456   addr = SvPV_nolen(ST(0));
1457   attr = SvPV_nolen(ST(1));
1458
1459   if(items == 2)
1460     attribute_value = get_attribute_value(addr,attr,NULL);
1461   else {
1462     bookname = SvPV_nolen(ST(2));
1463     attribute_value = get_attribute_value(addr,attr,bookname);
1464   }
1465
1466   if(attribute_value)
1467     XSRETURN_PV(attribute_value);
1468   XSRETURN_PV("");
1469 }
1470
1471 /* ClawsMail::C::filter_log(char*,char*) */
1472 static XS(XS_ClawsMail_filter_log)
1473 {
1474   char *text;
1475   char *type;
1476   
1477   dXSARGS;
1478   if(items != 2) {
1479     g_warning("Perl Plugin: Wrong number of arguments to ClawsMail::C::filter_log");
1480     XSRETURN_UNDEF;
1481   }
1482   type = SvPV_nolen(ST(0));
1483   text = SvPV_nolen(ST(1));
1484   if(!strcmp(type, "LOG_ACTION"))
1485     filter_log_write(LOG_ACTION, text);
1486   else if(!strcmp(type, "LOG_MANUAL"))
1487     filter_log_write(LOG_MANUAL, text);
1488   else if(!strcmp(type, "LOG_MATCH"))
1489     filter_log_write(LOG_MATCH, text);
1490   else {
1491     g_warning("Perl Plugin: ClawsMail::C::filter_log -- wrong first argument");
1492     XSRETURN_UNDEF;
1493   }  
1494   XSRETURN_YES;
1495 }
1496
1497 /* ClawsMail::C::filter_log_verbosity(int) */
1498 static XS(XS_ClawsMail_filter_log_verbosity)
1499 {
1500   int retval;
1501
1502   dXSARGS;
1503   if(items != 1 && items != 0) {
1504     g_warning("Perl Plugin: Wrong number of arguments to "
1505     "ClawsMail::C::filter_log_verbosity");
1506     XSRETURN_UNDEF;
1507   }
1508   retval = filter_log_verbosity;
1509
1510   if(items == 1)
1511     filter_log_verbosity = SvIV(ST(0));
1512
1513   XSRETURN_IV(retval);
1514 }
1515
1516 /* register extensions */ 
1517 EXTERN_C void xs_init(pTHX)
1518 {
1519   char *file = __FILE__;
1520   dXSUB_SYS;
1521   newXS("DynaLoader::boot_DynaLoader",    boot_DynaLoader,               file);
1522   newXS("ClawsMail::C::filter_init",  XS_ClawsMail_filter_init,  "ClawsMail::C");
1523   newXS("ClawsMail::C::check_flag",   XS_ClawsMail_check_flag,   "ClawsMail::C");
1524   newXS("ClawsMail::C::age_greater",  XS_ClawsMail_age_greater,  "ClawsMail::C");
1525   newXS("ClawsMail::C::age_lower",    XS_ClawsMail_age_lower,    "ClawsMail::C");
1526   newXS("ClawsMail::C::tagged",       XS_ClawsMail_tagged,       "ClawsMail::C");
1527   newXS("ClawsMail::C::set_flag",     XS_ClawsMail_set_flag,     "ClawsMail::C");
1528   newXS("ClawsMail::C::unset_flag",   XS_ClawsMail_unset_flag,   "ClawsMail::C");
1529   newXS("ClawsMail::C::delete",       XS_ClawsMail_delete,       "ClawsMail::C");
1530   newXS("ClawsMail::C::move",         XS_ClawsMail_move,         "ClawsMail::C");
1531   newXS("ClawsMail::C::copy",         XS_ClawsMail_copy,         "ClawsMail::C");
1532   newXS("ClawsMail::C::color",        XS_ClawsMail_color,        "ClawsMail::C");
1533   newXS("ClawsMail::C::colorlabel",   XS_ClawsMail_colorlabel,   "ClawsMail::C");
1534   newXS("ClawsMail::C::change_score", XS_ClawsMail_change_score, "ClawsMail::C");
1535   newXS("ClawsMail::C::set_score",    XS_ClawsMail_set_score,    "ClawsMail::C");
1536   newXS("ClawsMail::C::hide",         XS_ClawsMail_hide,         "ClawsMail::C");
1537   newXS("ClawsMail::C::forward",      XS_ClawsMail_forward,      "ClawsMail::C");
1538   newXS("ClawsMail::C::redirect",     XS_ClawsMail_redirect,     "ClawsMail::C");
1539   newXS("ClawsMail::C::set_tag",      XS_ClawsMail_set_tag,      "ClawsMail::C");
1540   newXS("ClawsMail::C::unset_tag",    XS_ClawsMail_unset_tag,    "ClawsMail::C");
1541   newXS("ClawsMail::C::clear_tags",   XS_ClawsMail_clear_tags,   "ClawsMail::C");
1542   newXS("ClawsMail::C::make_sure_folder_exists",
1543   XS_ClawsMail_make_sure_folder_exists,"ClawsMail::C");
1544   newXS("ClawsMail::C::make_sure_tag_exists", XS_ClawsMail_make_sure_tag_exists,"ClawsMail::C");
1545   newXS("ClawsMail::C::get_tags", XS_ClawsMail_get_tags,"ClawsMail::C");
1546   newXS("ClawsMail::C::addr_in_addressbook",
1547   XS_ClawsMail_addr_in_addressbook,"ClawsMail::C");
1548   newXS("ClawsMail::C::open_mail_file",
1549   XS_ClawsMail_open_mail_file,"ClawsMail::C");
1550   newXS("ClawsMail::C::close_mail_file",
1551   XS_ClawsMail_close_mail_file,"ClawsMail::C");
1552   newXS("ClawsMail::C::get_next_header",
1553   XS_ClawsMail_get_next_header,"ClawsMail::C");
1554   newXS("ClawsMail::C::get_next_body_line",
1555   XS_ClawsMail_get_next_body_line,"ClawsMail::C");
1556   newXS("ClawsMail::C::move_to_trash",XS_ClawsMail_move_to_trash,"ClawsMail::C");
1557   newXS("ClawsMail::C::abort",        XS_ClawsMail_abort,        "ClawsMail::C");
1558   newXS("ClawsMail::C::get_attribute_value",
1559   XS_ClawsMail_get_attribute_value,"ClawsMail::C");
1560   newXS("ClawsMail::C::filter_log",   XS_ClawsMail_filter_log,   "ClawsMail::C");
1561   newXS("ClawsMail::C::filter_log_verbosity",
1562   XS_ClawsMail_filter_log_verbosity, "ClawsMail::C");
1563 }
1564
1565 /*
1566  * The workhorse.
1567  * Returns: 0 on success
1568  *          1 error in scriptfile or invocation of external
1569  *            editor              -> retry
1570  *          2 error in scriptfile -> abort
1571  * (Yes, I know..)
1572  */
1573 static int perl_load_file(void)
1574 {
1575   gchar *args[] = {"", DO_CLEAN, NULL};
1576   gchar *noargs[] = { NULL };
1577   gchar *perlfilter;
1578   gchar **cmdline;
1579   gchar buf[1024];
1580   gchar *pp;
1581   STRLEN n_a;
1582
1583   call_argv("ClawsMail::Filter::Matcher::filter_init_",
1584       G_DISCARD | G_EVAL | G_NOARGS,noargs);
1585   /* check $@ */
1586   if(SvTRUE(ERRSV)) {
1587     debug_print("%s", SvPV(ERRSV,n_a));
1588     return 1; 
1589   }
1590   perlfilter = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, PERLFILTER, NULL);
1591   args[0] = perlfilter;
1592   call_argv("ClawsMail::Persistent::eval_file",
1593       G_DISCARD | G_EVAL, args);
1594   g_free(perlfilter);
1595   if(SvTRUE(ERRSV)) {
1596     AlertValue val;
1597     gchar *message;
1598
1599     if(strstr(SvPV(ERRSV,n_a),"intended"))
1600       return 0;
1601
1602     debug_print("%s", SvPV(ERRSV,n_a));
1603     message = g_strdup_printf("Error processing Perl script file: "
1604             "(line numbers may not be valid)\n%s",
1605             SvPV(ERRSV,n_a));
1606     val = alertpanel("Perl Plugin error",message,"Retry","Abort","Edit");
1607     g_free(message);
1608
1609     if(val == G_ALERTOTHER) {
1610       /* Open PERLFILTER in an external editor */
1611       perlfilter = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, PERLFILTER, NULL);
1612       if (prefs_common_get_ext_editor_cmd() &&
1613     (pp = strchr(prefs_common_get_ext_editor_cmd(), '%')) &&
1614     *(pp + 1) == 's' && !strchr(pp + 2, '%')) {
1615   g_snprintf(buf, sizeof(buf), prefs_common_get_ext_editor_cmd(), perlfilter);
1616       }
1617       else {
1618   if (prefs_common_get_ext_editor_cmd())
1619     g_warning("Perl Plugin: External editor command-line is invalid: `%s'",
1620         prefs_common_get_ext_editor_cmd());
1621   g_snprintf(buf, sizeof(buf), "emacs %s", perlfilter);
1622       }
1623       g_free(perlfilter);
1624       cmdline = strsplit_with_quote(buf, " ", 1024);
1625       execute_detached(cmdline);
1626       g_strfreev(cmdline);
1627       return 1;
1628     }
1629     else if(val == G_ALERTDEFAULT)
1630       return 1;
1631     else
1632       return 2;
1633   }
1634
1635   return 0;
1636 }
1637
1638
1639 /* let there be magic */
1640 static int perl_init(void)
1641 {
1642   int exitstatus;
1643   char *initialize[] = { "", "-w", "-e", "1;"};
1644   /* The `persistent' module is taken from the Perl documentation
1645      and has only slightly been modified. */
1646   const char perl_persistent[] = {
1647 "package ClawsMail::Persistent;\n"
1648 "\n"
1649 "use strict;\n"
1650 "our %Cache;\n"
1651 "use Symbol qw(delete_package);\n"
1652 "\n"
1653 "sub valid_package_name {\n"
1654 "    my($string) = @_;\n"
1655 "    $string =~ s/([^A-Za-z0-9\\/])/sprintf(\"_%2x\",unpack(\"C\",$1))/eg;\n"
1656 "    # second pass only for words starting with a digit\n"
1657 "    $string =~ s|/(\\d)|sprintf(\"/_%2x\",unpack(\"C\",$1))|eg;\n"
1658 "    \n"
1659 "    # Dress it up as a real package name\n"
1660 "    $string =~ s|/|::|g;\n"
1661 "    return \"ClawsMail\" . $string;\n"
1662 "}\n"
1663 "\n"
1664 "sub eval_file {\n"
1665 "    my($file, $delete) = @_;\n"
1666 "    my $package = valid_package_name($file);\n"
1667 "    my $mtime = -M $file;\n"
1668 "    if(!(defined $Cache{$package}{mtime} &&\n"
1669 "   $Cache{$package}{mtime} <= $mtime)) {\n"
1670 "      delete_package($package) if defined $Cache{$package}{mtime};\n"
1671 "  local *FH;\n"
1672 "  open FH, $file or die \"Failed to open '$file': $!\";\n"
1673 "  local($/) = undef;\n"
1674 "  my $sub = <FH>;\n"
1675 "  close FH;\n"
1676 "  #wrap the code into a subroutine inside our unique package\n"
1677 "  my $eval = qq{package $package;\n"
1678 "          use ClawsMail::Filter::Matcher;\n"
1679 "          use ClawsMail::Filter::Action;\n"
1680 "          use ClawsMail::Utils;\n"
1681 "          sub handler { $sub; }};\n"
1682 "  {\n"
1683 "      # hide our variables within this block\n"
1684 "      my($file,$mtime,$package,$sub);\n"
1685 "      eval $eval;\n"
1686 "  }\n"
1687 "  die $@ if $@;\n"
1688 "  #cache it unless we're cleaning out each time\n"
1689 "  $Cache{$package}{mtime} = $mtime unless $delete;\n"
1690 "    }\n"
1691 "    eval {$package->handler;};\n"
1692 "    die $@ if $@;\n"
1693 "    delete_package($package) if $delete;\n"
1694 "}\n"
1695   };
1696   const char perl_filter_matcher[] = {
1697 "BEGIN {$INC{'ClawsMail/Filter/Matcher.pm'} = 1;}\n"
1698 "package ClawsMail::Filter::Matcher;\n"
1699 "use locale;\n"
1700 "use base qw(Exporter);\n"
1701 "use strict;\n"
1702 "our @EXPORT =   (qw(header body filepath manual),\n"
1703 "     qw(filter_log_verbosity filter_log),\n"
1704 "     qw(all marked unread deleted new replied),\n"
1705 "     qw(forwarded locked colorlabel match matchcase),\n"
1706 "     qw(regexp regexpcase test),\n"
1707 "     qw(to cc subject from to_or_cc newsgroups inreplyto),\n"
1708 "     qw(references body_part headers_part headers_cont message),\n"
1709 "     qw(size_greater size_smaller size_equal),\n"
1710 "     qw(score_greater score_lower score_equal),\n"
1711 "     qw(age_greater age_lower partial tagged $permanent));\n"
1712 "# Global Variables\n"
1713 "our(%header,$body,%msginfo,$mail_done,$manual);\n"
1714 "our %colors = ('none'     =>  0,'orange'   =>  1,'red'  =>  2,\n"
1715 "            'pink'     =>  3,'sky blue' =>  4,'blue' =>  5,\n"
1716 "             'green'    =>  6,'brown'    =>  7);\n"
1717 "# For convenience\n"
1718 "sub lc2_ {\n"
1719 "    my $arg = shift;\n"
1720 "    if(defined $arg) {\n"
1721 "        return lc $arg;\n"
1722 "    }\n"
1723 "    else {\n"
1724 "        return \"\";\n"
1725 "    }\n"
1726 "}\n"
1727 "sub to           { return \"to\";            }\n"
1728 "sub cc           { return \"cc\";            }\n"
1729 "sub from         { return \"from\";          }\n"
1730 "sub subject      { return \"subject\";       }\n"
1731 "sub to_or_cc     { return \"to_or_cc\";      }\n"
1732 "sub newsgroups   { return \"newsgroups\";    }\n"
1733 "sub inreplyto    { return \"in-reply-to\";   }\n"
1734 "sub references   { return \"references\";    }\n"
1735 "sub body_part    { return \"body_part\";     }\n"
1736 "sub headers_part { return \"headers_part\";  }\n"
1737 "sub headers_cont { return \"headers_cont\";  }\n"
1738 "sub message      { return \"message\";       }\n"
1739 "# access the mail directly\n"
1740 "sub header {\n"
1741 "    my $key = shift;\n"
1742 "    if(not defined $key) {\n"
1743 "  init_();\n"
1744 "  return keys %header;\n"
1745 "    }\n"
1746 "    $key = lc2_ $key; $key =~ s/:$//;\n"
1747 "    init_() unless exists $header{$key};\n"
1748 "    if(exists $header{$key}) {\n"
1749 "  wantarray ? return @{$header{$key}} : return $header{$key}->[-1];\n"
1750 "    }\n"
1751 "    return undef;\n"
1752 "}\n"
1753 "sub body {init_();return $body;}\n"
1754 "sub filepath {return $msginfo{\"filepath\"};}\n"
1755 "sub manual {\n"
1756 "    ClawsMail::C::filter_log(\"LOG_MATCH\",\"manual\") if $manual;\n"
1757 "    return $manual;\n"
1758 "}\n"
1759 "sub filter_log {\n"
1760 "    my $arg1 = shift;\n"
1761 "    my $arg2 = shift;\n"
1762 "    return ClawsMail::C::filter_log($arg1,$arg2)\n"
1763 "  if defined($arg2);\n"
1764 "    return ClawsMail::C::filter_log(\"LOG_MANUAL\",$arg1);\n"
1765 "}\n"
1766 "sub filter_log_verbosity {\n"
1767 "    $_ = shift;\n"
1768 "    return ClawsMail::C::filter_log_verbosity($_)\n"
1769 "  if defined($_);\n"
1770 "    return ClawsMail::C::filter_log_verbosity();\n"
1771 "}\n"
1772 "# Public Matcher Tests\n"
1773 "sub all { ClawsMail::C::filter_log(\"LOG_MATCH\",\"all\");return 1; }\n"
1774 "sub marked        { return ClawsMail::C::check_flag(1);}\n"
1775 "sub unread        { return ClawsMail::C::check_flag(2);}\n"
1776 "sub deleted       { return ClawsMail::C::check_flag(3);}\n"
1777 "sub new           { return ClawsMail::C::check_flag(4);}\n"
1778 "sub replied       { return ClawsMail::C::check_flag(5);}\n"
1779 "sub forwarded     { return ClawsMail::C::check_flag(6);}\n"
1780 "sub locked        { return ClawsMail::C::check_flag(7);}\n"
1781 "sub ignore_thread { return ClawsMail::C::check_flag(8);}\n"
1782 "sub age_greater  {return ClawsMail::C::age_greater(@_);}\n"
1783 "sub age_lower    {return ClawsMail::C::age_lower(@_);  }\n"
1784 "sub tagged       {return ClawsMail::C::tagged(@_);  }\n"
1785 "sub score_equal {\n"
1786 "    my $my_score = shift;\n"
1787 "    return 0 unless (defined($msginfo{\"score\"}) and defined($my_score));\n"
1788 "    if($my_score == $msginfo{\"score\"}) {\n"
1789 "  ClawsMail::C::filter_log(\"LOG_MATCH\",\"score_equal\");\n"
1790 "  return 1;\n"
1791 "    }else{return 0;}\n"
1792 "}\n"
1793 "sub score_greater {\n"
1794 "    my $my_score = shift;\n"
1795 "    return 0 unless (defined($msginfo{\"score\"}) and defined($my_score));\n"
1796 "    if($msginfo{\"score\"} > $my_score) {\n"
1797 "  ClawsMail::C::filter_log(\"LOG_MATCH\",\"score_greater\");\n"
1798 "  return 1;\n"
1799 "    }else{return 0;}\n"
1800 "}\n"
1801 "sub score_lower {\n"
1802 "    my $my_score = shift;\n"
1803 "    return 0 unless (defined($msginfo{\"score\"}) and defined($my_score));\n"
1804 "    if($msginfo{\"score\"} < $my_score) {\n"
1805 "  ClawsMail::C::filter_log(\"LOG_MATCH\",\"score_lower\");\n"
1806 "  return 1;\n"
1807 "    }else{return 0;}\n"
1808 "}\n"
1809 "sub colorlabel {\n"
1810 "    my $color = shift;\n"
1811 "    $color = lc2_ $color;\n"
1812 "    $color = $colors{$color} if exists $colors{$color};\n"
1813 "    $color = 0 if $color =~ m/\\D/;\n"
1814 "    return ClawsMail::C::colorlabel($color);\n"
1815 "}\n"
1816 "sub size_greater {\n"
1817 "    my $my_size = shift;\n"
1818 "    return 0 unless (defined($msginfo{\"size\"}) and defined($my_size));\n"
1819 "    if($msginfo{\"size\"} > $my_size) {\n"
1820 "  ClawsMail::C::filter_log(\"LOG_MATCH\",\"size_greater\");\n"
1821 "  return 1;\n"
1822 "    }else{return 0;}\n"
1823 "}\n"
1824 "sub size_smaller {\n"
1825 "    my $my_size = shift;\n"
1826 "    return 0 unless (defined($msginfo{\"size\"}) and defined($my_size));\n"
1827 "    if($msginfo{\"size\"} < $my_size) {\n"
1828 "  ClawsMail::C::filter_log(\"LOG_MATCH\",\"size_smaller\");\n"
1829 "  return 1;\n"
1830 "    }else{return 0;}\n"
1831 "}\n"
1832 "sub size_equal {\n"
1833 "    my $my_size = shift;\n"
1834 "    return 0 unless (defined($msginfo{\"size\"}) and defined($my_size));\n"
1835 "    if($msginfo{\"size\"} == $my_size) {\n"
1836 "  ClawsMail::C::filter_log(\"LOG_MATCH\",\"size_equal\");\n"
1837 "  return 1;\n"
1838 "    }else{return 0;}\n"
1839 "}\n"
1840 "sub partial {\n"
1841 "    return 0 unless defined($msginfo{\"total_size\"})\n"
1842 "  and defined($msginfo{\"size\"});\n"
1843 "    if($msginfo{\"total_size\"} != 0\n"
1844 "       && $msginfo{\"size\"} != $msginfo{\"total_size\"}) {\n"
1845 "  ClawsMail::C::filter_log(\"LOG_MATCH\",\"partial\");\n"
1846 "  return 1;\n"
1847 "    }else{return 0;}\n"
1848 "}\n"
1849 "sub test {\n"
1850 "   $_ = shift; my $command = \"\"; my $hl=\"\"; my $re=\"\"; my $retval;\n"
1851 "   my $cmdline = $_;\n"
1852 "   s/\\\"/\"/g; #fool stupid emacs perl mode\";\n"
1853 "   s/([^%]*)//; $command .= $1;\n"
1854 "   while($_) {\n"
1855 "       if   (/^%%/){s/^%%([^%]*)//;$command .= \"\\\\%\".$1; next;}\n"
1856 "       elsif(/^%s/){s/^%s([^%]*)//;$hl=header(\"subject\");$re=$1;}\n"
1857 "       elsif(/^%f/){s/^%f([^%]*)//;$hl=header(\"from\");$re=$1;}\n"
1858 "       elsif(/^%t/){s/^%t([^%]*)//;$hl=header(\"to\");$re=$1;}\n"
1859 "       elsif(/^%c/){s/^%c([^%]*)//;$hl=header(\"cc\");$re=$1;}\n"
1860 "       elsif(/^%d/){s/^%d([^%]*)//;$hl=header(\"date\");$re=$1;}\n"
1861 "       elsif(/^%i/){s/^%i([^%]*)//;$hl=header(\"message-id\");$re=$1;}\n"
1862 "       elsif(/^%n/){s/^%n([^%]*)//;$hl=header(\"newsgroups\");$re=$1;}\n"
1863 "       elsif(/^%r/){s/^%r([^%]*)//;$hl=header(\"references\");$re=$1;}\n"
1864 "       elsif(/^%F/){s/^%F([^%]*)//;$hl=filepath();$re=$1;}\n"
1865 "       else        {s/^(%[^%]*)//; $command .= $1;}\n"
1866 "       $command .= \"\\Q$hl\\E\" if defined $hl;$hl=\"\";\n"
1867 "       $command .= $re;$re=\"\";\n"
1868 "   }\n"
1869 "   $retval = !(system($command)>>8);\n"
1870 "   ClawsMail::C::filter_log(\"LOG_MATCH\",\"test: $cmdline\")\n"
1871 "       if $retval;\n"
1872 "   return $retval;\n"
1873 "}\n"
1874 "sub matchcase {\n"
1875 "    my $retval;\n"
1876 "    $retval = match_(@_,\"i\");\n"
1877 "    ClawsMail::C::filter_log(\"LOG_MATCH\",\"matchcase: $_[0], $_[1]\")\n"
1878 "  if $retval;\n"
1879 "    return $retval;\n"
1880 "}\n"
1881 "sub match {\n"
1882 "    my $retval;\n"
1883 "    $retval = match_(@_);\n"
1884 "    ClawsMail::C::filter_log(\"LOG_MATCH\",\"match: $_[0], $_[1]\")\n"
1885 "  if $retval;\n"
1886 "    return $retval;\n"
1887 "}\n"
1888 "sub regexpcase {\n"
1889 "    my $retval;\n"
1890 "    $retval = match_(@_,\"ri\");\n"
1891 "    ClawsMail::C::filter_log(\"LOG_MATCH\",\"regexpcase: $_[0], $_[1]\")\n"
1892 "  if $retval;\n"
1893 "    return $retval;\n"
1894 "}\n"
1895 "sub regexp {\n"
1896 "    my $retval;\n"
1897 "    $retval = match_(@_,\"r\");\n"
1898 "    ClawsMail::C::filter_log(\"LOG_MATCH\",\"regexp: $_[0], $_[1]\")\n"
1899 "  if $retval;\n"
1900 "    return $retval;\n"
1901 "}\n"
1902 "# Internals\n"
1903 "sub add_header_entries_ {\n"
1904 "    my($key,@values) = @_; $key = lc2_ $key; $key =~ s/:$//;\n"
1905 "    $header{$key} = [] unless exists $header{$key};\n"
1906 "    push @{$header{$key}},@values;\n"
1907 "}\n"
1908 "# read whole mail\n"
1909 "sub init_ {\n"
1910 "    return 0 if $mail_done;\n"
1911 "    ClawsMail::C::open_mail_file();\n"
1912 "    read_headers_();\n"
1913 "    read_body_();\n"
1914 "    ClawsMail::C::close_mail_file();\n"
1915 "    $mail_done = 1;\n"
1916 "}\n"
1917 "sub filter_init_ {\n"
1918 "    %header = (); %msginfo = (); undef $body; $mail_done = 0;\n"
1919 "    $manual                        = ClawsMail::C::filter_init(100);\n"
1920 "    $msginfo{\"size\"}               = ClawsMail::C::filter_init( 1) ;\n"
1921 "    add_header_entries_(\"date\",      ClawsMail::C::filter_init( 2));\n"
1922 "    add_header_entries_(\"from\",      ClawsMail::C::filter_init( 3));\n"
1923 "    add_header_entries_(\"to\",        ClawsMail::C::filter_init( 4));\n"
1924 "    add_header_entries_(\"cc\",        ClawsMail::C::filter_init( 5));\n"
1925 "    add_header_entries_(\"newsgroups\",ClawsMail::C::filter_init( 6));\n"
1926 "    add_header_entries_(\"subject\",   ClawsMail::C::filter_init( 7));\n"
1927 "    add_header_entries_(\"msgid\",     ClawsMail::C::filter_init( 8));\n"
1928 "    add_header_entries_(\"inreplyto\", ClawsMail::C::filter_init( 9));\n"
1929 "    add_header_entries_(\"xref\",      ClawsMail::C::filter_init(10));\n"
1930 "    add_header_entries_(\"xface\",     ClawsMail::C::filter_init(11));\n"
1931 "    add_header_entries_(\"dispositionnotificationto\",\n"
1932 "                   ClawsMail::C::filter_init(12));\n"
1933 "    add_header_entries_(\"returnreceiptto\",\n"
1934 "                   ClawsMail::C::filter_init(13));\n"
1935 "    add_header_entries_(\"references\",ClawsMail::C::filter_init(14));\n"
1936 "    $msginfo{\"score\"}              = ClawsMail::C::filter_init(15);\n"
1937 "    $msginfo{\"hidden\"}             = ClawsMail::C::filter_init(19);\n"
1938 "    $msginfo{\"filepath\"}           = ClawsMail::C::filter_init(20);\n"
1939 "    $msginfo{\"partial_recv\"}       = ClawsMail::C::filter_init(21);\n"
1940 "    $msginfo{\"total_size\"}         = ClawsMail::C::filter_init(22);\n"
1941 "    $msginfo{\"account_server\"}     = ClawsMail::C::filter_init(23);\n"
1942 "    $msginfo{\"account_login\"}      = ClawsMail::C::filter_init(24);\n"
1943 "    $msginfo{\"planned_download\"}   = ClawsMail::C::filter_init(25);\n"
1944 "} \n"
1945 "sub read_headers_ {\n"
1946 "    my($key,$value);\n"
1947 "    %header = ();\n"
1948 "    while(($key,$value) = ClawsMail::C::get_next_header()) {\n"
1949 "  next unless $key =~ /:$/;\n"
1950 "  add_header_entries_($key,$value);\n"
1951 "    }\n"
1952 "}\n"
1953 "sub read_body_ {\n"
1954 "    my $line;\n"
1955 "    while(defined($line = ClawsMail::C::get_next_body_line())) {\n"
1956 "  $body .= $line;\n"
1957 "    }    \n"
1958 "}\n"
1959 "sub match_ {\n"
1960 "  my ($where,$what,$modi) = @_; $modi ||= \"\";\n"
1961 "  my $nocase=\"\"; $nocase = \"1\" if (index($modi,\"i\") != -1);\n"
1962 "  my $regexp=\"\"; $regexp = \"1\" if (index($modi,\"r\") != -1);\n"
1963 "  if($where eq \"to_or_cc\") {\n"
1964 "    if(not $regexp) { \n"
1965 "      return ((index(header(\"to\"),$what) != -1) or\n"
1966 "        (index(header(\"cc\"),$what) != -1)) unless $nocase;\n"
1967 "      return ((index(lc2_(header(\"to\")),lc2_($what)) != -1) or\n"
1968 "        (index(lc2_(header(\"cc\")),lc2_($what)) != -1))\n"
1969 "    } else {\n"
1970 "      return ((header(\"to\") =~ m/$what/) or\n"
1971 "        (header(\"cc\") =~ m/$what/)) unless $nocase;\n"
1972 "      return ((header(\"to\") =~ m/$what/i) or\n"
1973 "        (header(\"cc\") =~ m/$what/i));\n"
1974 "    }\n"
1975 "  } elsif($where eq \"body_part\") {\n"
1976 "    my $mybody = body(); $mybody =~ s/\\s+/ /g;\n"
1977 "    if(not $regexp) {\n"
1978 "      return (index($mybody,$what) != -1) unless $nocase;\n"
1979 "      return (index(lc2_($mybody),lc2_($what)) != -1);\n"
1980 "    } else {\n"
1981 "      return ($body =~ m/$what/) unless $nocase;\n"
1982 "      return ($body =~ m/$what/i);\n"
1983 "    }\n"
1984 "  } elsif($where eq \"headers_part\") {\n"
1985 "    my $myheader = header_as_string_();\n"
1986 "    if(not $regexp) {\n"
1987 "      $myheader =~ s/\\s+/ /g;\n"
1988 "      return (index($myheader,$what) != -1) unless $nocase;\n"
1989 "      return (index(lc2_($myheader),lc2_($what)) != -1);\n"
1990 "    } else {\n"
1991 "      return ($myheader =~ m/$what/) unless $nocase;\n"
1992 "      return ($myheader =~ m/$what/i);\n"
1993 "    }\n"
1994 "  } elsif($where eq \"headers_cont\") {\n"
1995 "    (my $myheader = header_as_string_()) =~ s{^\\S+:\\s*}{};\n"
1996 "    if(not $regexp) {\n"
1997 "      $myheader =~ s/\\s+/ /g;\n"
1998 "      return (index($myheader,$what) != -1) unless $nocase;\n"
1999 "      return (index(lc2_($myheader),lc2_($what)) != -1);\n"
2000 "    } else {\n"
2001 "      return ($myheader =~ m/$what/) unless $nocase;\n"
2002 "      return ($myheader =~ m/$what/i);\n"
2003 "    }\n"
2004 "  } elsif($where eq \"message\") {\n"
2005 "    my $message = header_as_string_();\n"
2006 "    $message .= \"\\n\".body();\n"
2007 "    if(not $regexp) {\n"
2008 "      $message =~ s/\\s+/ /g;\n"
2009 "      return (index($message,$what) != -1) unless $nocase;\n"
2010 "      return (index(lc2_($message),lc2_($what)) != -1);\n"
2011 "    } else {\n"
2012 "      return ($message =~ m/$what/) unless $nocase;\n"
2013 "      return ($message =~ m/$what/i);\n"
2014 "    }\n"
2015 "  } elsif($where eq \"tag\") {\n"
2016 "    my $found = 0;\n"
2017 "    sub ClawsMail::Utils::get_tags;"
2018 "    foreach my $tag (ClawsMail::Utils::get_tags) {\n"
2019 "      if(not $regexp) {\n"
2020 "        if($nocase) {\n"
2021 "          $found = (index(lc2_($tag),lc2_($what)) != -1);\n"
2022 "        } else {\n"
2023 "          $found = (index($tag,$what) != -1);\n"
2024 "        }\n"
2025 "      } else {\n"
2026 "        if ($nocase) {\n"
2027 "          $found = ($tag =~ m/$what/i);\n"
2028 "        } else {\n"
2029 "          $found = ($tag =~ m/$what/);\n"
2030 "        }\n"
2031 "      }\n"
2032 "      last if $found;\n"
2033 "    }\n"
2034 "    return $found;"
2035 "  } else {\n"
2036 "    $where = lc2_ $where;\n"
2037 "    my $myheader = header(lc2_ $where); $myheader ||= \"\";\n"
2038 "    return 0 unless $myheader;\n"
2039 "    if(not $regexp) {    \n"
2040 "      return (index(header($where),$what) != -1) unless $nocase;\n"
2041 "      return (index(lc2_(header($where)),lc2_($what)) != -1);\n"
2042 "    } else {\n"
2043 "      return (header($where) =~ m/$what/) unless $nocase;\n"
2044 "      return (header($where) =~ m/$what/i);\n"
2045 "    } \n"
2046 "  }\n"
2047 "}\n"
2048 "sub header_as_string_ {\n"
2049 "    my $headerstring=\"\";\n"
2050 "    my @headerkeys = header(); my(@fields,$field);\n"
2051 "    foreach $field (@headerkeys) {\n"
2052 "  @fields = header($field);\n"
2053 "  foreach (@fields) {\n"
2054 "      $headerstring .= $field.\": \".$_.\"\\n\";\n"
2055 "  }\n"
2056 "    }\n"
2057 "    return $headerstring;\n"
2058 "}\n"
2059 "our $permanent = \"\";\n"
2060 "1;\n"
2061   };
2062   const char perl_filter_action[] = {
2063 "BEGIN {$INC{'ClawsMail/Filter/Action.pm'} = 1;}\n"
2064 "package ClawsMail::Filter::Action;\n"
2065 "use base qw(Exporter);\n"
2066 "our @EXPORT = (qw(mark unmark dele mark_as_unread mark_as_read),\n"
2067 "         qw(lock unlock move copy color execute),\n"
2068 "         qw(hide set_score change_score stop exit),\n"
2069 "         qw(forward forward_as_attachment redirect),\n"
2070 "        qw(set_tag unset_tag clear_tags),\n"
2071 "         );\n"
2072 "our %colors = ('none'     =>  0,'orange' =>  1,\n"
2073 "             'red'      =>  2,'pink'   =>  3,\n"
2074 "             'sky blue' =>  4,'blue'   =>  5,\n"
2075 "             'green'    =>  6,'brown'  =>  7);\n"
2076 "sub mark           { ClawsMail::C::set_flag  (1);}\n"
2077 "sub unmark         { ClawsMail::C::unset_flag(1);}\n"
2078 "sub mark_as_unread { ClawsMail::C::set_flag  (2);}\n"
2079 "sub mark_as_read   { ClawsMail::C::unset_flag(2);}\n"
2080 "sub lock           { ClawsMail::C::set_flag  (7);}\n"
2081 "sub unlock         { ClawsMail::C::unset_flag(7);}\n"
2082 "sub copy           { ClawsMail::C::copy     (@_);}\n"
2083 "sub forward        { ClawsMail::C::forward(1,@_);}\n"
2084 "sub forward_as_attachment {ClawsMail::C::forward(2,@_);}\n"
2085 "sub redirect       { ClawsMail::C::redirect(@_); }\n"
2086 "sub hide           { ClawsMail::C::hide();       }\n"
2087 "sub exit {\n"
2088 "    ClawsMail::C::filter_log(\"LOG_ACTION\",\"exit\");\n"
2089 "    stop(1);\n"
2090 "}\n"
2091 "sub stop {\n"
2092 "    my $nolog = shift;\n"
2093 "    ClawsMail::C::filter_log(\"LOG_ACTION\", \"stop\")\n"
2094 "  unless defined($nolog);\n"
2095 "    die 'intended';\n"
2096 "}\n"
2097 "sub set_score {\n"
2098 "    $ClawsMail::Filter::Matcher::msginfo{\"score\"} =\n"
2099 "  ClawsMail::C::set_score(@_);\n"
2100 "}\n"
2101 "sub change_score {\n"
2102 "    $ClawsMail::Filter::Matcher::msginfo{\"score\"} =\n"
2103 "  ClawsMail::C::change_score(@_);\n"
2104 "}\n"
2105 "sub execute {\n"
2106 "    my $flv; my $cmd = shift; return 0 unless defined($cmd);\n"
2107 "    $flv = ClawsMail::C::filter_log_verbosity(0);\n"
2108 "    ClawsMail::Filter::Matcher::test($cmd);\n"
2109 "    ClawsMail::C::filter_log_verbosity($flv);\n"
2110 "    ClawsMail::C::filter_log(\"LOG_ACTION\", \"execute: $cmd\");\n"
2111 "    1;\n"
2112 "}\n"
2113 "sub move { ClawsMail::C::move(@_); stop(1);}\n"
2114 "sub dele { ClawsMail::C::delete(); stop(1);}\n"
2115 "sub color {\n"
2116 "    ($color) = @_;$color = lc2_ $color;\n"
2117 "    $color = $colors{$color} if exists $colors{$color};\n"
2118 "    $color = 0 if $color =~ m/\\D/;\n"
2119 "    ClawsMail::C::color($color);\n"
2120 "}\n"
2121 "sub set_tag { ClawsMail::C::set_tag(@_);}\n"
2122 "sub unset_tag { ClawsMail::C::unset_tag(@_);}\n"
2123 "sub clear_tags { ClawsMail::C::clear_tags(@_);}\n"
2124 "1;\n"
2125   };
2126   const char perl_utils[] = {
2127 "BEGIN {$INC{'ClawsMail/Utils.pm'} = 1;}\n"
2128 "package ClawsMail::Utils;\n"
2129 "use base qw(Exporter);\n"
2130 "our @EXPORT = (\n"
2131 "             qw(SA_is_spam extract_addresses move_to_trash abort),\n"
2132 "             qw(addr_in_addressbook from_in_addressbook),\n"
2133 "             qw(get_attribute_value make_sure_folder_exists),\n"
2134 "            qw(make_sure_tag_exists get_tags),\n"
2135 "             );\n"
2136 "# Spam\n"
2137 "sub SA_is_spam {\n"
2138 "    my $retval;\n"
2139 "    $retval = not ClawsMail::Filter::Matcher::test('spamc -c < %F > /dev/null');\n"
2140 "    ClawsMail::C::filter_log(\"LOG_MATCH\",\"SA_is_spam\") if $retval;\n"
2141 "    return $retval;\n"
2142 "}\n"
2143 "# simple extract email addresses from a header field\n"
2144 "sub extract_addresses {\n"
2145 "  my $hf = shift; return undef unless defined($hf);\n"
2146 "  my @addr = ();\n"
2147 "  while($hf =~ m/[-.+\\w]+\\@[-.+\\w]+/) {\n"
2148 "    $hf =~ s/^.*?([-.+\\w]+\\@[-.+\\w]+)//;\n"
2149 "    push @addr,$1;\n"
2150 "  }\n"
2151 "  push @addr,\"\" unless @addr;\n"
2152 "  return @addr;\n"
2153 "}\n"
2154 "# move to trash\n"
2155 "sub move_to_trash {\n"
2156 "    ClawsMail::C::move_to_trash();\n"
2157 "    ClawsMail::Filter::Action::stop(1);\n"
2158 "}\n"
2159 "# make sure a folder with a given id exists\n"
2160 "sub make_sure_folder_exists {\n"
2161 "    ClawsMail::C::make_sure_folder_exists(@_);\n"
2162 "}\n"
2163 "sub make_sure_tag_exists {\n"
2164 "    ClawsMail::C::make_sure_tag_exists(@_);\n"
2165 "}\n"
2166 "sub get_tags {\n"
2167 "    ClawsMail::C::get_tags(@_);\n"
2168 "}\n"
2169 "# abort: stop() and do not continue with built-in filtering\n"
2170 "sub abort {\n"
2171 "    ClawsMail::C::abort();\n"
2172 "    ClawsMail::Filter::Action::stop(1);\n"
2173 "}\n"
2174 "# addressbook query\n"
2175 "sub addr_in_addressbook {\n"
2176 "    return ClawsMail::C::addr_in_addressbook(@_) if @_;\n"
2177 "    return 0;\n"
2178 "}\n"
2179 "sub from_in_addressbook {\n"
2180 "    my ($from) = extract_addresses(ClawsMail::Filter::Matcher::header(\"from\"));\n"
2181 "    return 0 unless $from;\n"
2182 "    return addr_in_addressbook($from,@_);\n"
2183 "}\n"
2184 "sub get_attribute_value {\n"
2185 "    my $email = shift; my $key = shift;\n"
2186 "    return \"\" unless ($email and $key);\n"
2187 "    return ClawsMail::C::get_attribute_value($email,$key,@_);\n"
2188 "}\n"
2189 "1;\n"
2190   };
2191
2192   if((my_perl = perl_alloc()) == NULL) {
2193     g_warning("Perl Plugin: Not enough memory to allocate Perl interpreter");
2194     return -1;
2195   }
2196   PL_perl_destruct_level = 1;
2197   perl_construct(my_perl);
2198
2199   exitstatus = perl_parse(my_perl, xs_init, 4, initialize, NULL);
2200   PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
2201   eval_pv(perl_filter_matcher,TRUE);
2202   eval_pv(perl_filter_action,TRUE);
2203   eval_pv(perl_persistent,TRUE);
2204   eval_pv(perl_utils,TRUE);
2205   return exitstatus;
2206 }
2207
2208 static gboolean my_filtering_hook(gpointer source, gpointer data)
2209 {
2210   int retry;
2211
2212   g_return_val_if_fail(source != NULL, FALSE);
2213
2214   mail_filtering_data = (MailFilteringData *) source;
2215   msginfo = mail_filtering_data->msginfo;
2216   if (!msginfo)
2217     return FALSE;
2218   stop_filtering = FALSE;
2219   wrote_filter_log_head = FALSE;
2220   filter_log_verbosity = config.filter_log_verbosity;
2221   if(GPOINTER_TO_UINT(data) == AUTO_FILTER)
2222     manual_filtering = FALSE;
2223   else if(GPOINTER_TO_UINT(data) == MANU_FILTER)
2224     manual_filtering = TRUE;
2225   else
2226     debug_print("Invalid user data ignored.\n");
2227
2228   if(!manual_filtering)
2229     statusbar_print_all("Perl Plugin: filtering message...");
2230
2231   /* Process Skript File */
2232   retry = perl_load_file();
2233   while(retry == 1) {
2234     debug_print("Error processing Perl script file. Retrying..\n");
2235     retry = perl_load_file();
2236   }
2237   if(retry == 2) {
2238     debug_print("Error processing Perl script file. Aborting..\n");
2239     stop_filtering = FALSE;
2240   }
2241   return stop_filtering;
2242 }
2243
2244 static void perl_plugin_save_config(void)
2245 {
2246   PrefFile *pfile;
2247   gchar *rcpath;
2248
2249   debug_print("Saving Perl Plugin Configuration\n");
2250
2251   rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
2252   pfile = prefs_write_open(rcpath);
2253   g_free(rcpath);
2254   if (!pfile || (prefs_set_block_label(pfile, "PerlPlugin") < 0))
2255     return;
2256   
2257   if (prefs_write_param(param, pfile->fp) < 0) {
2258     g_warning("Perl Plugin: Failed to write Perl Plugin configuration to file");
2259     prefs_file_close_revert(pfile);
2260     return;
2261   }
2262         if (fprintf(pfile->fp, "\n") < 0) {
2263     FILE_OP_ERROR(rcpath, "fprintf");
2264     prefs_file_close_revert(pfile);
2265   } else
2266           prefs_file_close(pfile);
2267 }
2268
2269 gint plugin_init(gchar **error)
2270 {
2271   int argc;
2272   char **argv;
2273   char **env;
2274   int status = 0;
2275   FILE *fp;
2276   gchar *perlfilter;
2277   gchar *rcpath;
2278
2279   /* version check */
2280   if(!check_plugin_version(MAKE_NUMERIC_VERSION(3,7,4,6),
2281         VERSION_NUMERIC, "Perl", error))
2282     return -1;
2283
2284   /* register hook for automatic and manual filtering */
2285   filtering_hook_id = hooks_register_hook(MAIL_FILTERING_HOOKLIST,
2286             my_filtering_hook,
2287             GUINT_TO_POINTER(AUTO_FILTER));
2288   if(filtering_hook_id == (guint) -1) {
2289     *error = g_strdup("Failed to register mail filtering hook");
2290     return -1;
2291   }
2292   manual_filtering_hook_id = hooks_register_hook(MAIL_MANUAL_FILTERING_HOOKLIST,
2293              my_filtering_hook,
2294              GUINT_TO_POINTER(MANU_FILTER));
2295   if(manual_filtering_hook_id == (guint) -1) {
2296     hooks_unregister_hook(MAIL_FILTERING_HOOKLIST, filtering_hook_id);
2297     *error = g_strdup("Failed to register manual mail filtering hook");
2298     return -1;
2299   }
2300
2301   rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
2302   prefs_read_config(param, "PerlPlugin", rcpath, NULL);
2303   g_free(rcpath);
2304
2305   /* make sure we have at least an empty scriptfile */
2306   perlfilter = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, PERLFILTER, NULL);
2307   if((fp = fopen(perlfilter, "a")) == NULL) {
2308     *error = g_strdup("Failed to create blank scriptfile");
2309     g_free(perlfilter);
2310     hooks_unregister_hook(MAIL_FILTERING_HOOKLIST,
2311         filtering_hook_id);
2312     hooks_unregister_hook(MAIL_MANUAL_FILTERING_HOOKLIST,
2313         manual_filtering_hook_id);
2314     return -1;
2315   }
2316   /* chmod for security */
2317   if (change_file_mode_rw(fp, perlfilter) < 0) {
2318     FILE_OP_ERROR(perlfilter, "chmod");
2319     g_warning("Perl Plugin: Can't change file mode");
2320   }
2321   fclose(fp);
2322   g_free(perlfilter);
2323
2324   argc = 1;
2325   argv = g_new0(char*, 1);
2326   argv[0] = NULL;
2327   env = g_new0(char*, 1);
2328   env[0] = NULL;
2329
2330
2331   /* Initialize Perl Interpreter */
2332   PERL_SYS_INIT3(&argc, &argv, &env);
2333   g_free(argv);
2334   g_free(env);
2335   if(my_perl == NULL)
2336     status = perl_init();
2337   if(status) {
2338     *error = g_strdup("Failed to load Perl Interpreter\n");
2339     hooks_unregister_hook(MAIL_FILTERING_HOOKLIST,
2340         filtering_hook_id);
2341     hooks_unregister_hook(MAIL_MANUAL_FILTERING_HOOKLIST,
2342         manual_filtering_hook_id);
2343     return -1;
2344   }
2345
2346   perl_gtk_init();
2347   debug_print("Perl Plugin loaded\n");
2348   return 0;
2349 }
2350
2351 gboolean plugin_done(void)
2352 {
2353   hooks_unregister_hook(MAIL_FILTERING_HOOKLIST,
2354       filtering_hook_id);
2355   hooks_unregister_hook(MAIL_MANUAL_FILTERING_HOOKLIST,
2356       manual_filtering_hook_id);
2357   
2358   free_all_lists();
2359
2360   if(my_perl != NULL) {
2361     PL_perl_destruct_level = 1;
2362     perl_destruct(my_perl);
2363     perl_free(my_perl);
2364   }
2365   PERL_SYS_TERM();
2366
2367   perl_plugin_save_config();
2368
2369   perl_gtk_done();
2370   debug_print("Perl Plugin unloaded\n");
2371   return TRUE;
2372 }
2373
2374 const gchar *plugin_name(void)
2375 {
2376   return "Perl";
2377 }
2378
2379 const gchar *plugin_desc(void)
2380 {
2381   return "This plugin provides a Perl scripting "
2382     "interface for mail filters.\nFeedback "
2383     "to <berndth@gmx.de> is welcome.";
2384 }
2385
2386 const gchar *plugin_type(void)
2387 {
2388   return "GTK2";
2389 }
2390
2391 const gchar *plugin_licence(void)
2392 {
2393   return "GPL3+";
2394 }
2395
2396 const gchar *plugin_version(void)
2397 {
2398   return VERSION;
2399 }
2400
2401 struct PluginFeature *plugin_provides(void)
2402 {
2403   static struct PluginFeature features[] =
2404     { {PLUGIN_FILTERING, N_("Perl integration")},
2405       {PLUGIN_NOTHING, NULL}};
2406   return features;
2407 }