/* ** Copyright (C) 2008-2013 Dirk-Jan C. Binnema ** ** This program is free software; you can redistribute it and/or modify it ** under the terms of the GNU General Public License as published by the ** Free Software Foundation; either version 3, or (at your option) any ** later version. ** ** This program is distributed in the hope that it will be useful, ** but WITHOUT ANY WARRANTY; without even the implied warranty of ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ** GNU General Public License for more details. ** ** You should have received a copy of the GNU General Public License ** along with this program; if not, write to the Free Software Foundation, ** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. ** */ #if HAVE_CONFIG_H #include "config.h" #endif /*HAVE_CONFIG_H*/ #include #include #include #include #include #include #include "mu-msg.h" #include "mu-str.h" #include "mu-date.h" #include "mu-maildir.h" #include "mu-index.h" #include "mu-query.h" #include "mu-msg-iter.h" #include "mu-bookmarks.h" #include "mu-runtime.h" #include "mu-util.h" #include "mu-cmd.h" #include "mu-threader.h" #ifdef HAVE_JSON_GLIB #include #endif /*HAVE_JSON_GLIB*/ typedef gboolean (OutputFunc) (MuMsg *msg, MuMsgIter *iter, MuConfig *opts, GError **err); static gboolean print_internal (MuQuery *query, const gchar *expr, gboolean xapian, gboolean warn, GError **err) { char *str; if (xapian) str = mu_query_internal_xapian (query, expr, err); else str = mu_query_internal (query, expr, warn, err); if (str) { g_print ("%s\n", str); g_free (str); } return str != NULL; } /* returns MU_MSG_FIELD_ID_NONE if there is an error */ static MuMsgFieldId sort_field_from_string (const char* fieldstr, GError **err) { MuMsgFieldId mfid; mfid = mu_msg_field_id_from_name (fieldstr, FALSE); /* not found? try a shortcut */ if (mfid == MU_MSG_FIELD_ID_NONE && strlen(fieldstr) == 1) mfid = mu_msg_field_id_from_shortcut(fieldstr[0], FALSE); if (mfid == MU_MSG_FIELD_ID_NONE) g_set_error (err, MU_ERROR_DOMAIN, MU_ERROR_IN_PARAMETERS, "not a valid sort field: '%s'\n", fieldstr); return mfid; } static MuMsg* get_message (MuMsgIter *iter, time_t after) { MuMsg *msg; if (mu_msg_iter_is_done (iter)) return NULL; msg = mu_msg_iter_get_msg_floating (iter); if (!msg) return NULL; /* error */ if (!mu_msg_is_readable (msg)) { mu_msg_iter_next (iter); return get_message (iter, after); } if (after != 0 && after > mu_msg_get_timestamp (msg)) { mu_msg_iter_next (iter); return get_message (iter, after); } return msg; } static MuMsgIter* run_query (MuQuery *xapian, const gchar *query, MuConfig *opts, GError **err) { MuMsgIter *iter; MuMsgFieldId sortid; MuQueryFlags qflags; sortid = MU_MSG_FIELD_ID_NONE; if (opts->sortfield) { sortid = sort_field_from_string (opts->sortfield, err); if (sortid == MU_MSG_FIELD_ID_NONE) /* error occurred? */ return FALSE; } qflags = MU_QUERY_FLAG_NONE; if (opts->reverse) qflags |= MU_QUERY_FLAG_DESCENDING; if (opts->skip_dups) qflags |= MU_QUERY_FLAG_SKIP_DUPS; if (opts->include_related) qflags |= MU_QUERY_FLAG_INCLUDE_RELATED; if (opts->threads) qflags |= MU_QUERY_FLAG_THREADS; iter = mu_query_run (xapian, query, sortid, opts->maxnum, qflags, err); return iter; } static gboolean exec_cmd (MuMsg *msg, MuMsgIter *iter, MuConfig *opts, GError **err) { gint status; char *cmdline, *escpath; gboolean rv; escpath = g_shell_quote (mu_msg_get_path (msg)); cmdline = g_strdup_printf ("%s %s", opts->exec, escpath); rv = g_spawn_command_line_sync (cmdline, NULL, NULL, &status, err); g_free (cmdline); g_free (escpath); return rv; } static gchar* resolve_bookmark (MuConfig *opts, GError **err) { MuBookmarks *bm; char* val; const gchar *bmfile; bmfile = mu_runtime_path (MU_RUNTIME_PATH_BOOKMARKS); bm = mu_bookmarks_new (bmfile); if (!bm) { g_set_error (err, MU_ERROR_DOMAIN, MU_ERROR_FILE_CANNOT_OPEN, "failed to open bookmarks file '%s'", bmfile); return FALSE; } val = (gchar*)mu_bookmarks_lookup (bm, opts->bookmark); if (!val) g_set_error (err, MU_ERROR_DOMAIN, MU_ERROR_NO_MATCHES, "bookmark '%s' not found", opts->bookmark); else val = g_strdup (val); mu_bookmarks_destroy (bm); return val; } static gchar* get_query (MuConfig *opts, GError **err) { gchar *query, *bookmarkval; /* params[0] is 'find', actual search params start with [1] */ if (!opts->bookmark && !opts->params[1]) { g_set_error (err, MU_ERROR_DOMAIN, MU_ERROR_IN_PARAMETERS, "error in parameters"); return NULL; } bookmarkval = NULL; if (opts->bookmark) { bookmarkval = resolve_bookmark (opts, err); if (!bookmarkval) return NULL; } query = g_strjoinv (" ", &opts->params[1]); if (bookmarkval) { gchar *tmp; tmp = g_strdup_printf ("%s %s", bookmarkval, query); g_free (query); query = tmp; } g_free (bookmarkval); return query; } static MuQuery* get_query_obj (MuStore *store, GError **err) { MuQuery *mquery; unsigned count; count = mu_store_count (store, err); if (count == (unsigned)-1) return NULL; if (count == 0) { g_set_error (err, MU_ERROR_DOMAIN, MU_ERROR_XAPIAN_NEEDS_REINDEX, "the database is empty"); return NULL; } mquery = mu_query_new (store, err); if (!mquery) return NULL; return mquery; } static gboolean prepare_links (MuConfig *opts, GError **err) { /* note, mu_maildir_mkdir simply ignores whatever part of the * mail dir already exists */ if (!mu_maildir_mkdir (opts->linksdir, 0700, TRUE, err)) { mu_util_g_set_error (err, MU_ERROR_FILE_CANNOT_MKDIR, "error creating %s", opts->linksdir); return FALSE; } if (opts->clearlinks && !mu_maildir_clear_links (opts->linksdir, err)) { mu_util_g_set_error (err, MU_ERROR_FILE, "error clearing links under %s", opts->linksdir); return FALSE; } return TRUE; } static gboolean output_link (MuMsg *msg, MuMsgIter *iter, MuConfig *opts, GError **err) { if (mu_msg_iter_is_first (iter) && !prepare_links (opts, err)) return FALSE; return mu_maildir_link (mu_msg_get_path (msg), opts->linksdir, err); } static void ansi_color_maybe (MuMsgFieldId mfid, gboolean color) { const char* ansi; if (!color) return; /* nothing to do */ switch (mfid) { case MU_MSG_FIELD_ID_FROM: ansi = MU_COLOR_CYAN; break; case MU_MSG_FIELD_ID_TO: case MU_MSG_FIELD_ID_CC: case MU_MSG_FIELD_ID_BCC: ansi = MU_COLOR_BLUE; break; case MU_MSG_FIELD_ID_SUBJECT: ansi = MU_COLOR_GREEN; break; case MU_MSG_FIELD_ID_DATE: ansi = MU_COLOR_MAGENTA; break; default: if (mu_msg_field_type(mfid) == MU_MSG_FIELD_TYPE_STRING) ansi = MU_COLOR_YELLOW; else ansi = MU_COLOR_RED; } fputs (ansi, stdout); } static void ansi_reset_maybe (MuMsgFieldId mfid, gboolean color) { if (!color) return; /* nothing to do */ fputs (MU_COLOR_DEFAULT, stdout); } static const char* field_string_list (MuMsg *msg, MuMsgFieldId mfid) { char *str; const GSList *lst; static char buf[80]; lst = mu_msg_get_field_string_list (msg, mfid); if (!lst) return NULL; str = mu_str_from_list (lst, ','); if (str) { strncpy (buf, str, sizeof(buf)-1); buf[sizeof(buf)-1]='\0'; g_free (str); return buf; } return NULL; } static const char* display_field (MuMsg *msg, MuMsgFieldId mfid) { gint64 val; switch (mu_msg_field_type(mfid)) { case MU_MSG_FIELD_TYPE_STRING: { const gchar *str; str = mu_msg_get_field_string (msg, mfid); return str ? str : ""; } case MU_MSG_FIELD_TYPE_INT: if (mfid == MU_MSG_FIELD_ID_PRIO) { val = mu_msg_get_field_numeric (msg, mfid); return mu_msg_prio_name ((MuMsgPrio)val); } else if (mfid == MU_MSG_FIELD_ID_FLAGS) { val = mu_msg_get_field_numeric (msg, mfid); return mu_str_flags_s ((MuFlags)val); } else /* as string */ return mu_msg_get_field_string (msg, mfid); case MU_MSG_FIELD_TYPE_TIME_T: val = mu_msg_get_field_numeric (msg, mfid); return mu_date_str_s ("%c", (time_t)val); case MU_MSG_FIELD_TYPE_BYTESIZE: val = mu_msg_get_field_numeric (msg, mfid); return mu_str_size_s ((unsigned)val); case MU_MSG_FIELD_TYPE_STRING_LIST: { const char *str; str = field_string_list (msg, mfid); return str ? str : ""; } default: g_return_val_if_reached (NULL); } } static void print_summary (MuMsg *msg, MuConfig *opts) { const char* body; char *summ; MuMsgOptions msgopts; msgopts = mu_config_get_msg_options (opts); body = mu_msg_get_body_text(msg, msgopts); if (body) summ = mu_str_summarize (body, (unsigned)opts->summary_len); else summ = NULL; g_print ("Summary: "); mu_util_fputs_encoded (summ ? summ : "", stdout); g_print ("\n"); g_free (summ); } static void thread_indent (MuMsgIter *iter) { const MuMsgIterThreadInfo *ti; const char* threadpath; int i; gboolean is_root, first_child, empty_parent, is_dup; ti = mu_msg_iter_get_thread_info (iter); if (!ti) { g_warning ("cannot get thread-info for message %u", mu_msg_iter_get_docid (iter)); return; } threadpath = ti->threadpath; /* fputs (threadpath, stdout); */ /* fputs (" ", stdout); */ is_root = ti->prop & MU_MSG_ITER_THREAD_PROP_ROOT; first_child = ti->prop & MU_MSG_ITER_THREAD_PROP_FIRST_CHILD; empty_parent = ti->prop & MU_MSG_ITER_THREAD_PROP_EMPTY_PARENT; is_dup = ti->prop & MU_MSG_ITER_THREAD_PROP_DUP; /* FIXME: count the colons... */ for (i = 0; *threadpath; ++threadpath) i += (*threadpath == ':') ? 1 : 0; /* indent */ while (i --> 0) fputs (" ", stdout); if (!is_root) { fputs (first_child ? "`" : "|", stdout); fputs (empty_parent ? "*> " : is_dup ? "=> " : "-> ", stdout); } } static void output_plain_fields (MuMsg *msg, const char *fields, gboolean color, gboolean threads) { const char* myfields; int nonempty; g_return_if_fail (fields); for (myfields = fields, nonempty = 0; *myfields; ++myfields) { MuMsgFieldId mfid; mfid = mu_msg_field_id_from_shortcut (*myfields, FALSE); if (mfid == MU_MSG_FIELD_ID_NONE || (!mu_msg_field_xapian_value (mfid) && !mu_msg_field_xapian_contact (mfid))) nonempty += printf ("%c", *myfields); else { ansi_color_maybe (mfid, color); nonempty += mu_util_fputs_encoded (display_field (msg, mfid), stdout); ansi_reset_maybe (mfid, color); } } if (nonempty) fputs ("\n", stdout); } static gboolean output_plain (MuMsg *msg, MuMsgIter *iter, MuConfig *opts, GError **err) { /* we reuse the color (whatever that may be) * for message-priority for threads, too */ ansi_color_maybe (MU_MSG_FIELD_ID_PRIO, !opts->nocolor); if (opts->threads) thread_indent (iter); output_plain_fields (msg, opts->fields, !opts->nocolor, opts->threads); if (opts->summary_len > 0) print_summary (msg, opts); return TRUE; } static gboolean output_sexp (MuMsg *msg, MuMsgIter *iter, MuConfig *opts, GError **err) { char *sexp; const MuMsgIterThreadInfo *ti; ti = opts->threads ? mu_msg_iter_get_thread_info (iter) : NULL; sexp = mu_msg_to_sexp (msg, mu_msg_iter_get_docid (iter), ti, MU_MSG_OPTION_HEADERS_ONLY); fputs (sexp, stdout); g_free (sexp); return TRUE; } static gboolean output_json (MuMsg *msg, MuMsgIter *iter, MuConfig *opts, GError **err) { #ifdef HAVE_JSON_GLIB JsonNode *node; const MuMsgIterThreadInfo *ti; char *s; if (mu_msg_iter_is_first(iter)) g_print ("[\n"); ti = opts->threads ? mu_msg_iter_get_thread_info (iter) : NULL; node = mu_msg_to_json (msg, mu_msg_iter_get_docid (iter), ti, MU_MSG_OPTION_HEADERS_ONLY); s = json_to_string (node, TRUE); json_node_free (node); fputs (s, stdout); g_free (s); if (mu_msg_iter_is_last(iter)) fputs("]\n", stdout); else fputs (",\n", stdout); return TRUE; #else g_set_error (err, MU_ERROR_DOMAIN, MU_ERROR_IN_PARAMETERS, "this mu was built without json support"); return FALSE; #endif /*HAVE_JSON_GLIB*/ } static void print_attr_xml (const char* elm, const char *str) { gchar *esc; if (mu_str_is_empty(str)) return; /* empty: don't include */ esc = g_markup_escape_text (str, -1); g_print ("\t\t<%s>%s\n", elm, esc, elm); g_free (esc); } static gboolean output_xml (MuMsg *msg, MuMsgIter *iter, MuConfig *opts, GError **err) { if (mu_msg_iter_is_first(iter)) { g_print ("\n"); g_print ("\n"); } g_print ("\t\n"); print_attr_xml ("from", mu_msg_get_from (msg)); print_attr_xml ("to", mu_msg_get_to (msg)); print_attr_xml ("cc", mu_msg_get_cc (msg)); print_attr_xml ("subject", mu_msg_get_subject (msg)); g_print ("\t\t%u\n", (unsigned)mu_msg_get_date (msg)); g_print ("\t\t%u\n", (unsigned)mu_msg_get_size (msg)); print_attr_xml ("msgid", mu_msg_get_msgid (msg)); print_attr_xml ("path", mu_msg_get_path (msg)); print_attr_xml ("maildir", mu_msg_get_maildir (msg)); g_print ("\t\n"); if (mu_msg_iter_is_last(iter)) g_print ("\n"); return TRUE; } static OutputFunc* get_output_func (MuConfig *opts, GError **err) { switch (opts->format) { case MU_CONFIG_FORMAT_LINKS: return output_link; case MU_CONFIG_FORMAT_EXEC: return exec_cmd; case MU_CONFIG_FORMAT_PLAIN: return output_plain; case MU_CONFIG_FORMAT_XML: return output_xml; case MU_CONFIG_FORMAT_SEXP: return output_sexp; case MU_CONFIG_FORMAT_JSON: return output_json; default: g_return_val_if_reached (NULL); return NULL; } } static gboolean output_query_results (MuMsgIter *iter, MuConfig *opts, GError **err) { int count; gboolean rv; OutputFunc *output_func; output_func = get_output_func (opts, err); if (!output_func) return FALSE; for (count = 0, rv = TRUE; !mu_msg_iter_is_done(iter); mu_msg_iter_next (iter)) { MuMsg *msg; if (count == opts->maxnum) break; msg = get_message (iter, opts->after); if (!msg) break; /* { */ /* const char* thread_id; */ /* thread_id = mu_msg_iter_get_thread_id (iter); */ /* g_print ("%s ", thread_id ? thread_id : ""); */ /* } */ rv = output_func (msg, iter, opts, err); if (!rv) break; else ++count; } if (rv && count == 0) { mu_util_g_set_error (err, MU_ERROR_NO_MATCHES, "no matches for search expression"); return FALSE; } return rv; } static gboolean process_query (MuQuery *xapian, const gchar *query, MuConfig *opts, GError **err) { MuMsgIter *iter; gboolean rv; iter = run_query (xapian, query, opts, err); if (!iter) return FALSE; rv = output_query_results (iter, opts, err); mu_msg_iter_destroy (iter); return rv; } static gboolean execute_find (MuStore *store, MuConfig *opts, GError **err) { char *query_str; MuQuery *oracle; gboolean rv; oracle = get_query_obj (store, err); if (!oracle) return FALSE; query_str = get_query (opts, err); if (!query_str) { mu_query_destroy (oracle); return FALSE; } if (opts->format == MU_CONFIG_FORMAT_XQUERY) rv = print_internal (oracle, query_str, TRUE, FALSE, err); else if (opts->format == MU_CONFIG_FORMAT_MQUERY) rv = print_internal (oracle, query_str, FALSE, opts->verbose, err); else rv = process_query (oracle, query_str, opts, err); mu_query_destroy (oracle); g_free (query_str); return rv; } static gboolean format_params_valid (MuConfig *opts, GError **err) { switch (opts->format) { case MU_CONFIG_FORMAT_EXEC: break; case MU_CONFIG_FORMAT_PLAIN: case MU_CONFIG_FORMAT_SEXP: case MU_CONFIG_FORMAT_JSON: case MU_CONFIG_FORMAT_LINKS: case MU_CONFIG_FORMAT_XML: case MU_CONFIG_FORMAT_XQUERY: case MU_CONFIG_FORMAT_MQUERY: if (opts->exec) { mu_util_g_set_error (err, MU_ERROR_IN_PARAMETERS, "--exec and --format cannot be combined"); return FALSE; } break; default: mu_util_g_set_error (err, MU_ERROR_IN_PARAMETERS, "invalid output format %s", opts->formatstr ? opts->formatstr : ""); return FALSE; } if (opts->format == MU_CONFIG_FORMAT_LINKS && !opts->linksdir) { mu_util_g_set_error (err, MU_ERROR_IN_PARAMETERS, "missing --linksdir argument"); return FALSE; } if (opts->linksdir && opts->format != MU_CONFIG_FORMAT_LINKS) { mu_util_g_set_error (err, MU_ERROR_IN_PARAMETERS, "--linksdir is only valid with --format=links"); return FALSE; } return TRUE; } static gboolean query_params_valid (MuConfig *opts, GError **err) { const gchar *xpath; if (!opts->params[1]) { mu_util_g_set_error (err, MU_ERROR_IN_PARAMETERS, "missing query"); return FALSE; } xpath = mu_runtime_path (MU_RUNTIME_PATH_XAPIANDB); if (mu_util_check_dir (xpath, TRUE, FALSE)) return TRUE; mu_util_g_set_error (err, MU_ERROR_FILE_CANNOT_READ, "'%s' is not a readable Xapian directory", xpath); return FALSE; } MuError mu_cmd_find (MuStore *store, MuConfig *opts, GError **err) { g_return_val_if_fail (opts, MU_ERROR_INTERNAL); g_return_val_if_fail (opts->cmd == MU_CONFIG_CMD_FIND, MU_ERROR_INTERNAL); if (opts->exec) opts->format = MU_CONFIG_FORMAT_EXEC; /* pseudo format */ if (!query_params_valid (opts, err) || !format_params_valid(opts, err)) return MU_G_ERROR_CODE (err); if (!execute_find (store, opts, err)) return MU_G_ERROR_CODE(err); else return MU_OK; }