5bbdf73b7f2934310155f834f017167f55dd2c81
[claws.git] / src / plugins / newmail / newmail.c
1 /*
2  * newmail - A plugin for Claws Mail
3  *
4  * Copyright (C) 2005-2015 H.Merijn Brand and the Claws Mail Team
5  *
6  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
7  * Copyright (C) 1999-2015 the Claws Mail Team
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <http://www.gnu.org/licenses/>.
21  */
22
23 #include <errno.h>
24
25 #include <glib.h>
26 #include <glib/gi18n.h>
27
28 #include "version.h"
29 #include "claws.h"
30 #include "plugin.h"
31 #include "utils.h"
32 #include "hooks.h"
33 #include "procmsg.h"
34
35 #include <inttypes.h>
36
37 #include "plugin.h"
38
39 #define LOG_NAME        "NewLog"
40 #define DEFAULT_DIR     "Mail"
41 #define BUFSIZE         2048
42
43 static guint hook_id;
44
45 static FILE *NewLog   = NULL;
46 static char *LogName  = NULL;
47 static int   truncLog = 1;
48 static char *pluginDesc = NULL;
49
50 static gchar *defstr (gchar *s)
51 {
52         return s ? s : "(null)";
53 } /* defstr */
54
55 gboolean newmail_hook (gpointer source, gpointer data)
56 {
57         auto MsgInfo    *msginfo = (MsgInfo *)source;
58         auto FolderItem *tof;
59
60         if (!msginfo) return FALSE;
61         if (!NewLog) return FALSE;
62
63         tof = msginfo->folder;
64         (void)fprintf (NewLog, "---\n"
65                 "Date:\t%s\n"
66                 "Subject:\t%s\n"
67                 "From:\t%s\n"
68                 "To:\t%s\n"
69                 "Cc:\t%s\n"
70                 "Size:\t%jd\n"
71                 "Path:\t%s\n"
72                 "Message:\t%d\n"
73                 "Folder:\t%s\n",
74                 defstr (msginfo->date),
75                 defstr (msginfo->subject),
76                 defstr (msginfo->from),
77                 defstr (msginfo->to),
78                 defstr (msginfo->cc),
79                 (intmax_t) msginfo->size,
80                 defstr (procmsg_get_message_file_path (msginfo)),
81                 msginfo->msgnum,
82                 tof ? defstr (tof->name) : "(null)");
83
84         return (FALSE);
85 } /* newmail_hook */
86
87 gboolean plugin_done (void)
88 {
89         if (NewLog) {
90                 (void)fclose (NewLog);
91                 NewLog  = NULL;
92         }
93         if (LogName) {
94                 g_free(LogName);
95                 LogName = NULL;
96         }
97         if (pluginDesc) {
98                 g_free(pluginDesc);
99                 pluginDesc = NULL;
100         }
101         hooks_unregister_hook (MAIL_POSTFILTERING_HOOKLIST, hook_id);
102
103         debug_print ("Newmail plugin unloaded\n");
104         return TRUE;
105 } /* plugin_done */
106
107 gint plugin_init (gchar **error)
108 {
109         if (!check_plugin_version(MAKE_NUMERIC_VERSION(2,9,2,72),
110                                 VERSION_NUMERIC, _("NewMail"), error))
111                 return -1;
112
113         hook_id = hooks_register_hook (MAIL_POSTFILTERING_HOOKLIST, newmail_hook, NULL);
114         if (hook_id == -1) {
115                 *error = g_strdup (_("Failed to register newmail hook"));
116                 return (-1);
117         }
118
119         if (!NewLog) {
120                 auto char *mode = truncLog ? "w" : "a";
121                 if (!LogName) {
122                         LogName = g_strconcat(getenv ("HOME"), G_DIR_SEPARATOR_S, DEFAULT_DIR,
123                                         G_DIR_SEPARATOR_S, LOG_NAME, NULL);
124                 }
125                 if (!(NewLog = fopen (LogName, mode))) {
126                         debug_print ("Failed to open default log %s\n", LogName);
127                         /* try fallback location */
128                         g_free(LogName);
129                         LogName = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, LOG_NAME, NULL);
130                         if (!(NewLog = fopen (LogName, mode))) {
131                                 debug_print ("Failed to open fallback log %s\n", LogName);
132                                 *error = g_strdup_printf(_("Could not open log file %s: %s\n"),
133                                                 LogName, g_strerror(errno));
134                                 plugin_done ();
135                                 return (-1);
136                         }
137                 }
138                 setbuf (NewLog, NULL);
139         }
140
141         debug_print ("Newmail plugin loaded\n"
142               "Message header summaries written to %s\n", LogName);
143         if (pluginDesc == NULL)
144                 pluginDesc = g_strdup_printf(
145                         _("This plugin writes a header summary to a log file for each "
146                         "mail received after sorting.\n\n"
147                         "Default is ~/Mail/NewLog\n\nCurrent log is %s"), LogName);
148         return (0);
149 } /* plugin_init */
150
151 const gchar *plugin_name (void)
152 {
153     return _("NewMail");
154 } /* plugin_name */
155
156 const gchar *plugin_desc (void)
157 {
158     return pluginDesc;
159 } /* plugin_desc */
160
161 const gchar *plugin_type (void)
162 {
163     return ("Common");
164 } /* plugin_type */
165
166 const gchar *plugin_licence (void)
167 {
168     return ("GPL3+");
169 } /* plugin_licence */
170
171 const gchar *plugin_version (void)
172 {
173     return (VERSION);
174 } /* plugin_version */
175
176 struct PluginFeature *plugin_provides(void)
177 {
178         static struct PluginFeature features[] = 
179                 { {PLUGIN_NOTIFIER, N_("Log file")},
180                   {PLUGIN_NOTHING, NULL}};
181         return features;
182 }