contrib: pick: Do not indent messages in the message pane
[notmuch] / notmuch.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  * Copyright © 2009 Keith Packard
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see http://www.gnu.org/licenses/ .
18  *
19  * Authors: Carl Worth <cworth@cworth.org>
20  *          Keith Packard <keithp@keithp.com>
21  */
22
23 #include "notmuch-client.h"
24
25 typedef int (*command_function_t) (void *ctx, int argc, char *argv[]);
26
27 typedef struct command {
28     const char *name;
29     command_function_t function;
30     const char *arguments;
31     const char *summary;
32 } command_t;
33
34 #define MAX_ALIAS_SUBSTITUTIONS 3
35
36 typedef struct alias {
37     const char *name;
38     const char *substitutions[MAX_ALIAS_SUBSTITUTIONS];
39 } alias_t;
40
41 alias_t aliases[] = {
42     { "part", { "show", "--format=raw"}},
43     { "search-tags", {"search", "--output=tags", "*"}}
44 };
45
46 static int
47 notmuch_help_command (void *ctx, int argc, char *argv[]);
48
49 static command_t commands[] = {
50     { "setup", notmuch_setup_command,
51       NULL,
52       "Interactively setup notmuch for first use." },
53     { "new", notmuch_new_command,
54       "[options...]",
55       "Find and import new messages to the notmuch database." },
56     { "search", notmuch_search_command,
57       "[options...] <search-terms> [...]",
58       "Search for messages matching the given search terms." },
59     { "show", notmuch_show_command,
60       "<search-terms> [...]",
61       "Show all messages matching the search terms." },
62     { "count", notmuch_count_command,
63       "[options...] <search-terms> [...]",
64       "Count messages matching the search terms." },
65     { "reply", notmuch_reply_command,
66       "[options...] <search-terms> [...]",
67       "Construct a reply template for a set of messages." },
68     { "tag", notmuch_tag_command,
69       "+<tag>|-<tag> [...] [--] <search-terms> [...]" ,
70       "Add/remove tags for all messages matching the search terms." },
71     { "dump", notmuch_dump_command,
72       "[<filename>] [--] [<search-terms>]",
73       "Create a plain-text dump of the tags for each message." },
74     { "restore", notmuch_restore_command,
75       "[--accumulate] [<filename>]",
76       "Restore the tags from the given dump file (see 'dump')." },
77     { "config", notmuch_config_command,
78       "[get|set] <section>.<item> [value ...]",
79       "Get or set settings in the notmuch configuration file." },
80     { "help", notmuch_help_command,
81       "[<command>]",
82       "This message, or more detailed help for the named command." }
83 };
84
85 int notmuch_format_version;
86
87 static void
88 usage (FILE *out)
89 {
90     command_t *command;
91     unsigned int i;
92
93     fprintf (out,
94              "Usage: notmuch --help\n"
95              "       notmuch --version\n"
96              "       notmuch <command> [args...]\n");
97     fprintf (out, "\n");
98     fprintf (out, "The available commands are as follows:\n");
99     fprintf (out, "\n");
100
101     for (i = 0; i < ARRAY_SIZE (commands); i++) {
102         command = &commands[i];
103
104         fprintf (out, "  %-11s  %s\n",
105                  command->name, command->summary);
106     }
107
108     fprintf (out, "\n");
109     fprintf (out,
110     "Use \"notmuch help <command>\" for more details on each command\n"
111     "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n");
112 }
113
114 void
115 notmuch_exit_if_unsupported_format (void)
116 {
117     if (notmuch_format_version > NOTMUCH_FORMAT_CUR) {
118         fprintf (stderr, "\
119 A caller requested output format version %d, but the installed notmuch\n\
120 CLI only supports up to format version %d.  You may need to upgrade your\n\
121 notmuch CLI.\n",
122                  notmuch_format_version, NOTMUCH_FORMAT_CUR);
123         exit (NOTMUCH_EXIT_FORMAT_TOO_NEW);
124     } else if (notmuch_format_version < NOTMUCH_FORMAT_MIN) {
125         fprintf (stderr, "\
126 A caller requested output format version %d, which is no longer supported\n\
127 by the notmuch CLI (it requires at least version %d).  You may need to\n\
128 upgrade your notmuch front-end.\n",
129                  notmuch_format_version, NOTMUCH_FORMAT_MIN);
130         exit (NOTMUCH_EXIT_FORMAT_TOO_OLD);
131     } else if (notmuch_format_version != NOTMUCH_FORMAT_CUR) {
132         /* Warn about old version requests so compatibility issues are
133          * less likely when we drop support for a deprecated format
134          * versions. */
135         fprintf (stderr, "\
136 A caller requested deprecated output format version %d, which may not\n\
137 be supported in the future.\n", notmuch_format_version);
138     }
139 }
140
141 static void
142 exec_man (const char *page)
143 {
144     if (execlp ("man", "man", page, (char *) NULL)) {
145         perror ("exec man");
146         exit (1);
147     }
148 }
149
150 static int
151 notmuch_help_command (void *ctx, int argc, char *argv[])
152 {
153     command_t *command;
154     unsigned int i;
155
156     argc--; argv++; /* Ignore "help" */
157
158     if (argc == 0) {
159         printf ("The notmuch mail system.\n\n");
160         usage (stdout);
161         return 0;
162     }
163
164     if (strcmp (argv[0], "help") == 0) {
165         printf ("The notmuch help system.\n\n"
166                 "\tNotmuch uses the man command to display help. In case\n"
167                 "\tof difficulties check that MANPATH includes the pages\n"
168                 "\tinstalled by notmuch.\n\n"
169                 "\tTry \"notmuch help\" for a list of topics.\n");
170         return 0;
171     }
172
173     for (i = 0; i < ARRAY_SIZE (commands); i++) {
174         command = &commands[i];
175
176         if (strcmp (argv[0], command->name) == 0) {
177             char *page = talloc_asprintf (ctx, "notmuch-%s", command->name);
178             exec_man (page);
179         }
180     }
181
182     if (strcmp (argv[0], "search-terms") == 0) {
183         exec_man ("notmuch-search-terms");
184     } else if (strcmp (argv[0], "hooks") == 0) {
185         exec_man ("notmuch-hooks");
186     }
187
188     fprintf (stderr,
189              "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
190              argv[0]);
191     return 1;
192 }
193
194 /* Handle the case of "notmuch" being invoked with no command
195  * argument. For now we just call notmuch_setup_command, but we plan
196  * to be more clever about this in the future.
197  */
198 static int
199 notmuch (void *ctx)
200 {
201     notmuch_config_t *config;
202     notmuch_bool_t is_new;
203     char *db_path;
204     struct stat st;
205
206     config = notmuch_config_open (ctx, NULL, &is_new);
207
208     /* If the user has never configured notmuch, then run
209      * notmuch_setup_command which will give a nice welcome message,
210      * and interactively guide the user through the configuration. */
211     if (is_new) {
212         notmuch_config_close (config);
213         return notmuch_setup_command (ctx, 0, NULL);
214     }
215
216     /* Notmuch is already configured, but is there a database? */
217     db_path = talloc_asprintf (ctx, "%s/%s",
218                                notmuch_config_get_database_path (config),
219                                ".notmuch");
220     if (stat (db_path, &st)) {
221         notmuch_config_close (config);
222         if (errno != ENOENT) {
223             fprintf (stderr, "Error looking for notmuch database at %s: %s\n",
224                      db_path, strerror (errno));
225             return 1;
226         }
227         printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n",
228                 db_path);
229         printf ("You probably want to run \"notmuch new\" now to create that database.\n\n"
230                 "Note that the first run of \"notmuch new\" can take a very long time\n"
231                 "and that the resulting database will use roughly the same amount of\n"
232                 "storage space as the email being indexed.\n\n");
233         return 0;
234     }
235
236     printf ("Notmuch is configured and appears to have a database. Excellent!\n\n"
237             "At this point you can start exploring the functionality of notmuch by\n"
238             "using commands such as:\n\n"
239             "\tnotmuch search tag:inbox\n\n"
240             "\tnotmuch search to:\"%s\"\n\n"
241             "\tnotmuch search from:\"%s\"\n\n"
242             "\tnotmuch search subject:\"my favorite things\"\n\n"
243             "See \"notmuch help search\" for more details.\n\n"
244             "You can also use \"notmuch show\" with any of the thread IDs resulting\n"
245             "from a search. Finally, you may want to explore using a more sophisticated\n"
246             "interface to notmuch such as the emacs interface implemented in notmuch.el\n"
247             "or any other interface described at http://notmuchmail.org\n\n"
248             "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n"
249             "Have fun, and may your inbox never have much mail.\n\n",
250             notmuch_config_get_user_name (config),
251             notmuch_config_get_user_primary_email (config));
252
253     notmuch_config_close (config);
254
255     return 0;
256 }
257
258 int
259 main (int argc, char *argv[])
260 {
261     void *local;
262     command_t *command;
263     alias_t *alias;
264     unsigned int i, j;
265     const char **argv_local;
266
267     talloc_enable_null_tracking ();
268
269     local = talloc_new (NULL);
270
271     g_mime_init (0);
272     g_type_init ();
273
274     /* Globally default to the current output format version. */
275     notmuch_format_version = NOTMUCH_FORMAT_CUR;
276
277     if (argc == 1)
278         return notmuch (local);
279
280     if (strcmp (argv[1], "--help") == 0)
281         return notmuch_help_command (NULL, argc - 1, &argv[1]);
282
283     if (strcmp (argv[1], "--version") == 0) {
284         printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
285         return 0;
286     }
287
288     for (i = 0; i < ARRAY_SIZE (aliases); i++) {
289         alias = &aliases[i];
290
291         if (strcmp (argv[1], alias->name) == 0)
292         {
293             int substitutions;
294
295             argv_local = talloc_size (local, sizeof (char *) *
296                                       (argc + MAX_ALIAS_SUBSTITUTIONS - 1));
297             if (argv_local == NULL) {
298                 fprintf (stderr, "Out of memory.\n");
299                 return 1;
300             }
301
302             /* Copy all substution arguments from the alias. */
303             argv_local[0] = argv[0];
304             for (j = 0; j < MAX_ALIAS_SUBSTITUTIONS; j++) {
305                 if (alias->substitutions[j] == NULL)
306                     break;
307                 argv_local[j+1] = alias->substitutions[j];
308             }
309             substitutions = j;
310
311             /* And copy all original arguments (skipping the argument
312              * that matched the alias of course. */
313             for (j = 2; j < (unsigned) argc; j++) {
314                 argv_local[substitutions+j-1] = argv[j];
315             }
316
317             argc += substitutions - 1;
318             argv = (char **) argv_local;
319         }
320     }
321
322     for (i = 0; i < ARRAY_SIZE (commands); i++) {
323         command = &commands[i];
324
325         if (strcmp (argv[1], command->name) == 0)
326             return (command->function) (local, argc - 1, &argv[1]);
327     }
328
329     fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
330              argv[1]);
331
332     talloc_free (local);
333
334     return 1;
335 }