+/*
+ * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 2002 by the Sylpheed Claws Team and Hiroyuki Yamamoto
+ *
+ * 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 2 of the License, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
#include <ctype.h>
#include <string.h>
#include <stdlib.h>
#include "matcher.h"
#include "intl.h"
#include "matcher_parser.h"
-#include "prefs.h"
+#include "prefs_gtk.h"
+/*!
+ *\brief Keyword lookup element
+ */
struct _MatchParser {
- gint id;
- gchar * str;
+ gint id; /*!< keyword id */
+ gchar *str; /*!< keyword */
};
-
typedef struct _MatchParser MatchParser;
-static MatchParser matchparser_tab[] = {
+/*!
+ *\brief Table with strings and ids used by the lexer and
+ * the parser. New keywords can be added here.
+ */
+static const MatchParser matchparser_tab[] = {
/* msginfo flags */
{MATCHCRITERIA_ALL, "all"},
{MATCHCRITERIA_UNREAD, "unread"},
{MATCHCRITERIA_NOT_REPLIED, "~replied"},
{MATCHCRITERIA_FORWARDED, "forwarded"},
{MATCHCRITERIA_NOT_FORWARDED, "~forwarded"},
+ {MATCHCRITERIA_LOCKED, "locked"},
+ {MATCHCRITERIA_NOT_LOCKED, "~locked"},
+ {MATCHCRITERIA_COLORLABEL, "colorlabel"},
+ {MATCHCRITERIA_NOT_COLORLABEL, "~colorlabel"},
+ {MATCHCRITERIA_IGNORE_THREAD, "ignore_thread"},
+ {MATCHCRITERIA_NOT_IGNORE_THREAD, "~ignore_thread"},
/* msginfo headers */
{MATCHCRITERIA_SUBJECT, "subject"},
{MATCHACTION_EXECUTE, "execute"},
{MATCHACTION_COLOR, "color"},
{MATCHACTION_REDIRECT, "redirect"},
- {MATCHACTION_DELETE_ON_SERVER, "delete_on_server"}
+ {MATCHACTION_CHANGE_SCORE, "change_score"}
};
-/* get_matchparser_tab_str() - used by filtering.c to translate
- * actions to debug strings */
-gchar * get_matchparser_tab_str(gint id)
+/*!
+ *\brief Look up table with keywords defined in \sa matchparser_tab
+ */
+static GHashTable *matchparser_hashtab;
+
+/*!
+ *\brief Translate keyword id to keyword string
+ *
+ *\param id Id of keyword
+ *
+ *\return const gchar * Keyword
+ */
+const gchar *get_matchparser_tab_str(gint id)
{
gint i;
- for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
- i++) {
+ for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
if (matchparser_tab[i].id == id)
return matchparser_tab[i].str;
}
return NULL;
}
-/* matcher_escape_str() - escapes a string returns newly allocated escaped string */
+/*!
+ *\brief Create keyword lookup table
+ */
+static void create_matchparser_hashtab(void)
+{
+ int i;
+
+ if (matchparser_hashtab) return;
+ matchparser_hashtab = g_hash_table_new(g_str_hash, g_str_equal);
+ for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++)
+ g_hash_table_insert(matchparser_hashtab,
+ matchparser_tab[i].str,
+ (gpointer) &matchparser_tab[i]);
+}
+
+/*!
+ *\brief Return a keyword id from a keyword string
+ *
+ *\param str Keyword string
+ *
+ *\return gint Keyword id
+ */
+gint get_matchparser_tab_id(const gchar *str)
+{
+ MatchParser *res;
+
+ if (NULL != (res = g_hash_table_lookup(matchparser_hashtab, str))) {
+ return res->id;
+ } else
+ return -1;
+}
+
+/*!
+ *\brief Escape characters in a string by inserting '\' characters
+ *
+ *\param str String with characters to be escaped
+ *
+ *\return gchar * Newly allocated string with escaped characters
+ */
gchar *matcher_escape_str(const gchar *str)
{
register const gchar *walk;
return NULL;
for (escape = 0, walk = str; *walk; walk++)
- if (*walk == '\'' || *walk == '\"')
+ if (*walk == '\\' || *walk == '\'' || *walk == '\"')
escape++;
if (!escape)
reswalk = res = g_new0(gchar, (walk - str) + escape + 1);
for (walk = str; *walk; walk++, reswalk++) {
- if (*walk == '\'' || *walk == '\"')
+ if (*walk == '\\' || *walk == '\'' || *walk == '\"')
*reswalk++ = '\\';
*reswalk = *walk;
}
return res;
}
-/* matcher_unescape_str() - assumes that unescaping frees up room
- * in the string, so it returns the unescaped string in the
- * source */
+/*!
+ *\brief Unescape string by replacing escaped char sequences
+ * (\b, \n, etc) by their actual char. Note that this
+ * function changes the contents of the buffer pointed
+ * to by \a str.
+ *
+ *\param str Buffer containing string that needs to be escaped.
+ * Note that this function changes the contents of the
+ * buffer
+ *
+ *\return gchar * Pointer to changed buffer
+ */
gchar *matcher_unescape_str(gchar *str)
{
gchar *tmp = alloca(strlen(str) + 1);
*dst++ = *src;
else {
src++;
- if (*src == '\\')
- *dst++ = '\\'; /* insert backslash */
- else if (*src == 'n') /* insert control characters */
+ if (*src == 'n') /* insert control characters */
*dst++ = '\n';
else if (*src == 'r')
*dst++ = '\r';
*dst++ = '\b';
else if (*src == 'f')
*dst++ = '\f';
- else if (*src == '\'' || *src == '\"') /* insert \' or \" */
+ else if (*src == '\\' || *src == '\'' || *src == '\"')
+ /* insert \\, \' or \" */
*dst++ = *src;
else {
/* FIXME: should perhaps escape character... */
/* **************** data structure allocation **************** */
-/* matcherprop_new() - allocates a structure for one condition
+/*!
+ *\brief Allocate a structure for a filtering / scoring
+ * "condition" (a matcher structure)
+ *
+ *\param criteria Criteria ID (MATCHCRITERIA_XXXX)
+ *\param header Header string (if criteria is MATCHCRITERIA_HEADER)
+ *\param matchtype Type of action (MATCHTYPE_XXX)
+ *\param expr String value or expression to check
+ *\param value Integer value to check
+ *
+ *\return MatcherProp * Pointer to newly allocated structure
*/
-MatcherProp * matcherprop_new(gint criteria, gchar * header,
- gint matchtype, gchar * expr,
+MatcherProp *matcherprop_new(gint criteria, const gchar *header,
+ gint matchtype, const gchar *expr,
int value)
{
- MatcherProp * prop;
+ MatcherProp *prop;
prop = g_new0(MatcherProp, 1);
prop->criteria = criteria;
- if (header != NULL) {
- prop->header = g_strdup(header);
- prop->unesc_header = matcher_unescape_str(g_strdup(header));
- }
- else {
- prop->header = NULL;
- prop->unesc_header = NULL;
- }
- if (expr != NULL) {
- prop->expr = g_strdup(expr);
- prop->unesc_expr = matcher_unescape_str(g_strdup(expr));
- }
- else {
- prop->expr = NULL;
- prop->unesc_expr = NULL;
- }
+ prop->header = header != NULL ? g_strdup(header) : NULL;
+ prop->expr = expr != NULL ? g_strdup(expr) : NULL;
prop->matchtype = matchtype;
prop->preg = NULL;
prop->value = value;
return prop;
}
-/* matcherprop_free()
+/*!
+ *\brief Free a matcher structure
+ *
+ *\param prop Pointer to matcher structure allocated with
+ * #matcherprop_new
*/
-void matcherprop_free(MatcherProp * prop)
+void matcherprop_free(MatcherProp *prop)
{
if (prop->expr)
g_free(prop->expr);
- if (prop->unesc_expr)
- g_free(prop->unesc_expr);
if (prop->header)
g_free(prop->header);
- if (prop->unesc_header)
- g_free(prop->unesc_header);
if (prop->preg != NULL) {
regfree(prop->preg);
g_free(prop->preg);
g_free(prop);
}
+/*!
+ *\brief Copy a matcher structure
+ *
+ *\param src Matcher structure to copy
+ *
+ *\return MatcherProp * Pointer to newly allocated matcher structure
+ */
+MatcherProp *matcherprop_copy(const MatcherProp *src)
+{
+ MatcherProp *prop = g_new0(MatcherProp, 1);
+
+ prop->criteria = src->criteria;
+ prop->header = src->header ? g_strdup(src->header) : NULL;
+ prop->expr = src->expr ? g_strdup(src->expr) : NULL;
+ prop->matchtype = src->matchtype;
+
+ prop->preg = NULL; /* will be re-evaluated */
+ prop->value = src->value;
+ prop->error = src->error;
+ return prop;
+}
-/* ************** match ******************************/
+/* ****************** wrapper for file reading ************** */
+
+/*!
+ *\brief Allocate a matcher structure where all strings
+ * are unescaped ("unquoted")
+ *
+ *\param criteria One of the MATCHCRITERIA_XXX constants
+ *\param header A header string
+ *\param matchtype Type of matcher (MATCHTYPE_XXX)
+ *\param expr Matcher string expression
+ *\param value Matcher integer value
+ *
+ *\return MatcherProp * Pointer to newly allocated matcher
+ * structure
+ */
+MatcherProp *matcherprop_unquote_new(gint criteria, const gchar *header,
+ gint matchtype, const gchar *expr,
+ int value)
+{
+ MatcherProp *prop;
+
+ if (expr != NULL)
+ expr = matcher_unescape_str(g_strdup(expr));
+
+ if (header != NULL)
+ header = matcher_unescape_str(g_strdup(header));
+
+ prop = matcherprop_new(criteria, header, matchtype, expr, value);
+
+ g_free((gpointer) header);
+ g_free((gpointer) expr);
+
+ return prop;
+}
-/* matcherprop_string_match() - finds out if a string matches
- * with a criterium */
-static gboolean matcherprop_string_match(MatcherProp * prop, gchar * str)
+/* ************** match ******************************/
+
+/*!
+ *\brief Find out if a string matches a condition
+ *
+ *\param prop Matcher structure
+ *\param str String to check
+ *
+ *\return gboolean TRUE if str matches the condition in the
+ * matcher structure
+ */
+static gboolean matcherprop_string_match(MatcherProp *prop, const gchar *str)
{
- gchar * str1;
- gchar * str2;
+ gchar *str1;
+ gchar *str2;
if (str == NULL)
return FALSE;
- switch(prop->matchtype) {
+ switch (prop->matchtype) {
case MATCHTYPE_REGEXPCASE:
case MATCHTYPE_REGEXP:
if (!prop->preg && (prop->error == 0)) {
? REG_ICASE : 0)) != 0) {
prop->error = 1;
g_free(prop->preg);
+ prop->preg = NULL;
}
}
if (prop->preg == NULL)
return FALSE;
case MATCHTYPE_MATCH:
- return (strstr(str, prop->unesc_expr) != NULL);
+ return (strstr(str, prop->expr) != NULL);
/* FIXME: put upper in unesc_str */
case MATCHTYPE_MATCHCASE:
- str2 = alloca(strlen(prop->unesc_expr) + 1);
- strcpy(str2, prop->unesc_expr);
+ str2 = alloca(strlen(prop->expr) + 1);
+ strcpy(str2, prop->expr);
g_strup(str2);
str1 = alloca(strlen(str) + 1);
strcpy(str1, str);
}
}
-gboolean matcherprop_match_execute(MatcherProp * prop, MsgInfo * info)
+/*!
+ *\brief Execute a command defined in the matcher structure
+ *
+ *\param prop Pointer to matcher structure
+ *\param info Pointer to message info structure
+ *
+ *\return gboolean TRUE if command was executed succesfully
+ */
+static gboolean matcherprop_match_execute(const MatcherProp *prop,
+ MsgInfo *info)
{
- gchar * file;
- gchar * cmd;
+ gchar *file;
+ gchar *cmd;
gint retval;
file = procmsg_get_message_file(info);
if (file == NULL)
return FALSE;
+ g_free(file);
- cmd = matching_build_command(prop->unesc_expr, info);
+ cmd = matching_build_command(prop->expr, info);
if (cmd == NULL)
return FALSE;
retval = system(cmd);
- debug_print(_("Command exit code: %d\n"), retval);
+ debug_print("Command exit code: %d\n", retval);
+ g_free(cmd);
return (retval == 0);
}
-/* match a message and his headers, hlist can be NULL if you don't
- want to use headers */
-
-gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info)
+/*!
+ *\brief Check if a message matches the condition in a matcher
+ * structure.
+ *
+ *\param prop Pointer to matcher structure
+ *\param info Pointer to message info
+ *
+ *\return gboolean TRUE if a match
+ */
+gboolean matcherprop_match(MatcherProp *prop,
+ MsgInfo *info)
{
time_t t;
return MSG_IS_FORWARDED(info->flags);
case MATCHCRITERIA_NOT_FORWARDED:
return !MSG_IS_FORWARDED(info->flags);
+ case MATCHCRITERIA_LOCKED:
+ return MSG_IS_LOCKED(info->flags);
+ case MATCHCRITERIA_NOT_LOCKED:
+ return !MSG_IS_LOCKED(info->flags);
+ case MATCHCRITERIA_COLORLABEL:
+ return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value;
+ case MATCHCRITERIA_NOT_COLORLABEL:
+ return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value;
+ case MATCHCRITERIA_IGNORE_THREAD:
+ return MSG_IS_IGNORE_THREAD(info->flags);
+ case MATCHCRITERIA_NOT_IGNORE_THREAD:
+ return !MSG_IS_IGNORE_THREAD(info->flags);
case MATCHCRITERIA_SUBJECT:
return matcherprop_string_match(prop, info->subject);
case MATCHCRITERIA_NOT_SUBJECT:
/* ********************* MatcherList *************************** */
-
-MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and)
+/*!
+ *\brief Create a new list of matchers
+ *
+ *\param matchers List of matcher structures
+ *\param bool_and Operator
+ *
+ *\return MatcherList * New list
+ */
+MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
{
- MatcherList * cond;
+ MatcherList *cond;
cond = g_new0(MatcherList, 1);
return cond;
}
-void matcherlist_free(MatcherList * cond)
+/*!
+ *\brief Frees a list of matchers
+ *
+ *\param cond List of matchers
+ */
+void matcherlist_free(MatcherList *cond)
{
- GSList * l;
+ GSList *l;
- for(l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
+ for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
matcherprop_free((MatcherProp *) l->data);
}
g_free(cond);
}
-/*
- skip the headers
+/*!
+ *\brief Skip all headers in a message file
+ *
+ *\param fp Message file
*/
-
static void matcherlist_skip_headers(FILE *fp)
{
gchar buf[BUFFSIZE];
- while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1) {
- }
+ while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
+ ;
}
-/*
- matcherprop_match_one_header
- returns TRUE if buf matchs the MatchersProp criteria
+/*!
+ *\brief Check if a header matches a matcher condition
+ *
+ *\param matcher Matcher structure to check header for
+ *\param buf Header name
+ *
+ *\return boolean TRUE if matching header
*/
-
-static gboolean matcherprop_match_one_header(MatcherProp * matcher,
- gchar * buf)
+static gboolean matcherprop_match_one_header(MatcherProp *matcher,
+ gchar *buf)
{
gboolean result;
Header *header;
- switch(matcher->criteria) {
+ switch (matcher->criteria) {
case MATCHCRITERIA_HEADER:
case MATCHCRITERIA_NOT_HEADER:
header = procheader_parse_header(buf);
return FALSE;
}
-/*
- matcherprop_criteria_header
- returns TRUE if the headers must be matched
+/*!
+ *\brief Check if the matcher structure wants headers to
+ * be matched
+ *
+ *\param matcher Matcher structure
+ *
+ *\return gboolean TRUE if the matcher structure describes
+ * a header match condition
*/
-
-static gboolean matcherprop_criteria_headers(MatcherProp * matcher)
+static gboolean matcherprop_criteria_headers(const MatcherProp *matcher)
{
- switch(matcher->criteria) {
+ switch (matcher->criteria) {
case MATCHCRITERIA_HEADER:
case MATCHCRITERIA_NOT_HEADER:
case MATCHCRITERIA_HEADERS_PART:
}
}
-static gboolean matcherprop_criteria_message(MatcherProp * matcher)
+/*!
+ *\brief Check if the matcher structure wants the message
+ * to be matched (just perform an action on any
+ * message)
+ *
+ *\param matcher Matcher structure
+ *
+ *\return gboolean TRUE if matcher condition should match
+ * a message
+ */
+static gboolean matcherprop_criteria_message(MatcherProp *matcher)
{
- switch(matcher->criteria) {
+ switch (matcher->criteria) {
case MATCHCRITERIA_MESSAGE:
case MATCHCRITERIA_NOT_MESSAGE:
return TRUE;
}
}
-/*
- matcherlist_match_one_header
- returns TRUE if match should stop
+/*!
+ *\brief Check if a list of conditions match a header
+ *
+ *\param matchers One set of conditions
+ *\param buf Name of header
+ *
+ *\return gboolean TRUE if matching should stop
*/
-
-static gboolean matcherlist_match_one_header(MatcherList * matchers,
- gchar * buf)
+static gboolean matcherlist_match_one_header(MatcherList *matchers,
+ gchar *buf)
{
- GSList * l;
-
- for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
- MatcherProp * matcher = (MatcherProp *) l->data;
+ GSList *l;
+ for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
+ MatcherProp *matcher = (MatcherProp *) l->data;
+
+ /* see if a single condition matches */
if (matcherprop_criteria_headers(matcher) ||
matcherprop_criteria_message(matcher)) {
if (matcherprop_match_one_header(matcher, buf)) {
return FALSE;
}
-/*
- matcherlist_match_headers
- returns TRUE if one of the headers matchs the MatcherList criteria
+/*!
+ *\brief Check if a list of conditions matches one header in
+ * a message file.
+ *
+ *\param matchers List of conditions
+ *\param fp Message file
+ *
+ *\return gboolean TRUE if one of the headers is matched by
+ * the list of conditions.
*/
-
-static gboolean matcherlist_match_headers(MatcherList * matchers, FILE * fp)
+static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
{
gchar buf[BUFFSIZE];
return FALSE;
}
-/*
- matcherprop_criteria_body
- returns TRUE if the body must be matched
+/*!
+ *\brief Check if a matcher wants to check the message body
+ *
+ *\param matcher Matcher structure
+ *
+ *\return gboolean TRUE if body must be matched.
*/
-
-static gboolean matcherprop_criteria_body(MatcherProp * matcher)
+static gboolean matcherprop_criteria_body(const MatcherProp *matcher)
{
- switch(matcher->criteria) {
+ switch (matcher->criteria) {
case MATCHCRITERIA_BODY_PART:
case MATCHCRITERIA_NOT_BODY_PART:
return TRUE;
}
}
-/*
- matcherprop_match_line
- returns TRUE if the string matchs the MatcherProp criteria
+/*!
+ *\brief Check if a (line) string matches the criteria
+ * described by a matcher structure
+ *
+ *\param matcher Matcher structure
+ *\param line String
+ *
+ *\return gboolean TRUE if string matches criteria
*/
-
-static gboolean matcherprop_match_line(MatcherProp * matcher, gchar * line)
+static gboolean matcherprop_match_line(MatcherProp *matcher, const gchar *line)
{
- switch(matcher->criteria) {
+ switch (matcher->criteria) {
case MATCHCRITERIA_BODY_PART:
case MATCHCRITERIA_MESSAGE:
return matcherprop_string_match(matcher, line);
return FALSE;
}
-/*
- matcherlist_match_line
- returns TRUE if the string matchs the MatcherList criteria
+/*!
+ *\brief Check if a list of conditions matches a (line) string
+ *
+ *\param matchers List of matchers
+ *\param line String to match
+ *
+ *\return gboolean TRUE if string matches list of criteria
*/
-
-static gboolean matcherlist_match_line(MatcherList * matchers, gchar * line)
+static gboolean matcherlist_match_line(MatcherList *matchers, const gchar *line)
{
- GSList * l;
+ GSList *l;
- for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
- MatcherProp * matcher = (MatcherProp *) l->data;
+ for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
+ MatcherProp *matcher = (MatcherProp *) l->data;
if (matcherprop_criteria_body(matcher) ||
matcherprop_criteria_message(matcher)) {
return FALSE;
}
-/*
- matcherlist_match_body
- returns TRUE if one line of the body matchs the MatcherList criteria
+/*!
+ *\brief Check if a line in a message file's body matches
+ * the criteria
+ *
+ *\param matchers List of conditions
+ *\param fp Message file
+ *
+ *\return gboolean TRUE if succesful match
*/
-
-static gboolean matcherlist_match_body(MatcherList * matchers, FILE * fp)
+static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
{
gchar buf[BUFFSIZE];
return FALSE;
}
-gboolean matcherlist_match_file(MatcherList * matchers, MsgInfo * info,
+/*!
+ *\brief Check if a message file matches criteria
+ *
+ *\param matchers Criteria
+ *\param info Message info
+ *\param result Default result
+ *
+ *\return gboolean TRUE if matched
+ */
+gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
gboolean result)
{
gboolean read_headers;
gboolean read_body;
- GSList * l;
- FILE * fp;
- gchar * file;
+ GSList *l;
+ FILE *fp;
+ gchar *file;
/* file need to be read ? */
read_headers = FALSE;
read_body = FALSE;
- for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
- MatcherProp * matcher = (MatcherProp *) l->data;
+ for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
+ MatcherProp *matcher = (MatcherProp *) l->data;
if (matcherprop_criteria_headers(matcher))
read_headers = TRUE;
matcherlist_match_body(matchers, fp);
}
- for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
- MatcherProp * matcher = (MatcherProp *) l->data;
+ for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
+ MatcherProp *matcher = (MatcherProp *) l->data;
if (matcherprop_criteria_headers(matcher) ||
matcherprop_criteria_body(matcher) ||
return result;
}
-/* test a list of condition */
-
-gboolean matcherlist_match(MatcherList * matchers, MsgInfo * info)
+/*!
+ *\brief Test list of conditions on a message.
+ *
+ *\param matchers List of conditions
+ *\param info Message info
+ *
+ *\return gboolean TRUE if matched
+ */
+gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
{
- GSList * l;
+ GSList *l;
gboolean result;
if (matchers->bool_and)
/* test the cached elements */
- for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
- MatcherProp * matcher = (MatcherProp *) l->data;
+ for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
+ MatcherProp *matcher = (MatcherProp *) l->data;
switch(matcher->criteria) {
case MATCHCRITERIA_ALL:
case MATCHCRITERIA_NOT_REPLIED:
case MATCHCRITERIA_FORWARDED:
case MATCHCRITERIA_NOT_FORWARDED:
+ case MATCHCRITERIA_LOCKED:
+ case MATCHCRITERIA_NOT_LOCKED:
+ case MATCHCRITERIA_COLORLABEL:
+ case MATCHCRITERIA_NOT_COLORLABEL:
+ case MATCHCRITERIA_IGNORE_THREAD:
+ case MATCHCRITERIA_NOT_IGNORE_THREAD:
case MATCHCRITERIA_SUBJECT:
case MATCHCRITERIA_NOT_SUBJECT:
case MATCHCRITERIA_FROM:
return result;
}
-
-gchar * matcherprop_to_string(MatcherProp * matcher)
+/*!
+ *\brief Convert a matcher structure to a string
+ *
+ *\param matcher Matcher structure
+ *
+ *\return gchar * Newly allocated string
+ */
+gchar *matcherprop_to_string(MatcherProp *matcher)
{
- gchar * matcher_str = NULL;
- gchar * criteria_str;
- gchar * matchtype_str;
+ gchar *matcher_str = NULL;
+ const gchar *criteria_str;
+ const gchar *matchtype_str;
int i;
- gchar * p;
- gint count;
- gchar * expr_str;
- gchar * out;
+ gchar *expr;
criteria_str = NULL;
- for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
- i++) {
+ for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
if (matchparser_tab[i].id == matcher->criteria)
criteria_str = matchparser_tab[i].str;
}
if (criteria_str == NULL)
return NULL;
- switch(matcher->criteria) {
+ switch (matcher->criteria) {
case MATCHCRITERIA_AGE_GREATER:
case MATCHCRITERIA_AGE_LOWER:
case MATCHCRITERIA_SCORE_GREATER:
case MATCHCRITERIA_SIZE_GREATER:
case MATCHCRITERIA_SIZE_SMALLER:
case MATCHCRITERIA_SIZE_EQUAL:
+ case MATCHCRITERIA_COLORLABEL:
+ case MATCHCRITERIA_NOT_COLORLABEL:
return g_strdup_printf("%s %i", criteria_str, matcher->value);
case MATCHCRITERIA_ALL:
case MATCHCRITERIA_UNREAD:
case MATCHCRITERIA_NOT_REPLIED:
case MATCHCRITERIA_FORWARDED:
case MATCHCRITERIA_NOT_FORWARDED:
+ case MATCHCRITERIA_LOCKED:
+ case MATCHCRITERIA_NOT_LOCKED:
+ case MATCHCRITERIA_IGNORE_THREAD:
+ case MATCHCRITERIA_NOT_IGNORE_THREAD:
return g_strdup(criteria_str);
case MATCHCRITERIA_EXECUTE:
case MATCHCRITERIA_NOT_EXECUTE:
- return g_strdup_printf("%s \"%s\"", criteria_str, matcher->expr);
+ expr = matcher_escape_str(matcher->expr);
+ matcher_str = g_strdup_printf("%s \"%s\"", criteria_str, expr);
+ g_free((gpointer) expr);
+ return matcher_str;
}
matchtype_str = NULL;
- for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
- i++) {
+ for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
if (matchparser_tab[i].id == matcher->matchtype)
matchtype_str = matchparser_tab[i].str;
}
case MATCHTYPE_MATCHCASE:
case MATCHTYPE_REGEXP:
case MATCHTYPE_REGEXPCASE:
+ expr = matcher_escape_str(matcher->expr);
if (matcher->header)
- matcher_str =
- g_strdup_printf("%s \"%s\" %s \"%s\"",
- criteria_str, matcher->header,
- matchtype_str, matcher->expr);
+ matcher_str = g_strdup_printf
+ ("%s \"%s\" %s \"%s\"",
+ criteria_str, matcher->header,
+ matchtype_str, expr);
else
- matcher_str =
- g_strdup_printf("%s %s \"%s\"", criteria_str,
- matchtype_str, matcher->expr);
+ matcher_str = g_strdup_printf
+ ("%s %s \"%s\"", criteria_str,
+ matchtype_str, expr);
+ g_free((gpointer) expr);
break;
}
return matcher_str;
}
-gchar * matcherlist_to_string(MatcherList * matchers)
+/*!
+ *\brief Convert a list of conditions to a string
+ *
+ *\param matchers List of conditions
+ *
+ *\return gchar * Newly allocated string
+ */
+gchar *matcherlist_to_string(const MatcherList *matchers)
{
gint count;
- gchar ** vstr;
- GSList * l;
- gchar ** cur_str;
- gchar * result;
+ gchar **vstr;
+ GSList *l;
+ gchar **cur_str;
+ gchar *result = NULL;
count = g_slist_length(matchers->matchers);
vstr = g_new(gchar *, count + 1);
- for (l = matchers->matchers, cur_str = vstr ; l != NULL ;
+ for (l = matchers->matchers, cur_str = vstr; l != NULL;
l = g_slist_next(l), cur_str ++) {
*cur_str = matcherprop_to_string((MatcherProp *) l->data);
if (*cur_str == NULL)
else
result = g_strjoinv(" | ", vstr);
- for(cur_str = vstr ; *cur_str != NULL ; cur_str ++)
+ for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
g_free(*cur_str);
g_free(vstr);
#define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
#define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
/* matching_build_command() - preferably cmd should be unescaped */
-gchar * matching_build_command(gchar * cmd, MsgInfo * info)
+/*!
+ *\brief Build the command line to execute
+ *
+ *\param cmd String with command line specifiers
+ *\param info Message info to use for command
+ *
+ *\return gchar * Newly allocated string
+ *
+ *\warning The \a cmd string should have been unescaped using
+ * #matcher_unescape_str.
+ */
+gchar *matching_build_command(const gchar *cmd, MsgInfo *info)
{
- gchar * s = cmd;
- gchar * filename = NULL;
- gchar * processed_cmd;
- gchar * p;
+ const gchar *s = cmd;
+ gchar *filename = NULL;
+ gchar *processed_cmd;
+ gchar *p;
gint size;
const gchar *const no_subject = _("(none)") ;
info->msgnum);
if (filename == NULL) {
- g_warning(_("filename is not set"));
+ g_warning("filename is not set");
return NULL;
}
else
else s++;
}
-
processed_cmd = g_new0(gchar, size);
s = cmd;
p = processed_cmd;
case 'F': /* file */
strcpy(p, filename);
p += strlen(p);
+ g_free(filename);
break;
default:
*p = '%';
}
}
- debug_print("*** exec string \"%s\"\n", processed_cmd);
return processed_cmd;
}
#undef STRLEN_DEFAULT
/* ************************************************************ */
-static void prefs_scoring_write(FILE * fp, GSList * prefs_scoring)
+/*!
+ *\brief Write scoring list to file
+ *
+ *\param fp File
+ *\param prefs_scoring List of scoring conditions
+ */
+static void prefs_scoring_write(FILE *fp, GSList *prefs_scoring)
{
- GSList * cur;
+ GSList *cur;
for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
gchar *scoring_str;
- ScoringProp * prop;
+ ScoringProp *prop;
prop = (ScoringProp *) cur->data;
scoring_str = scoringprop_to_string(prop);
}
}
-static void prefs_filtering_write(FILE * fp, GSList * prefs_scoring)
+/*!
+ *\brief Write filtering list to file
+ *
+ *\param fp File
+ *\param prefs_filtering List of filtering conditions
+ */
+static void prefs_filtering_write(FILE *fp, GSList *prefs_filtering)
{
- GSList * cur;
+ GSList *cur;
- for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
+ for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
gchar *filtering_str;
- FilteringProp * prop;
+ FilteringProp *prop;
if (NULL == (prop = (FilteringProp *) cur->data))
continue;
}
}
+/*!
+ *\brief Write matchers from a folder item
+ *
+ *\param node Node with folder info
+ *\param data File pointer
+ *
+ *\return gboolean FALSE
+ */
static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
{
FolderItem *item;
- FILE * fp = data;
- gchar * id;
- GSList * prefs_scoring;
- GSList * prefs_filtering;
+ FILE *fp = data;
+ gchar *id;
+ GSList *prefs_scoring;
+ GSList *prefs_filtering;
if (node != NULL) {
item = node->data;
- /* prevent from the warning */
+ /* prevent warning */
if (item->path == NULL)
return FALSE;
id = folder_item_get_identifier(item);
return FALSE;
}
-static void prefs_matcher_save(FILE * fp)
+/*!
+ *\brief Save matchers from folder items
+ *
+ *\param fp File
+ */
+static void prefs_matcher_save(FILE *fp)
{
- GList * cur;
+ GList *cur;
for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
Folder *folder;
prefs_matcher_write_func(NULL, fp);
}
-
+/*!
+ *\brief Write filtering / matcher configuration file
+ */
void prefs_matcher_write_config(void)
{
gchar *rcpath;
PrefFile *pfile;
- GSList *cur;
- ScoringProp * prop;
- debug_print(_("Writing matcher configuration...\n"));
+ debug_print("Writing matcher configuration...\n");
rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
MATCHER_RC, NULL);
if ((pfile = prefs_write_open(rcpath)) == NULL) {
- g_warning(_("failed to write configuration to file\n"));
+ g_warning("failed to write configuration to file\n");
g_free(rcpath);
return;
}
g_free(rcpath);
- if (prefs_write_close(pfile) < 0) {
- g_warning(_("failed to write configuration to file\n"));
+ if (prefs_file_close(pfile) < 0) {
+ g_warning("failed to write configuration to file\n");
return;
}
}
/* ******************************************************************* */
+/*!
+ *\brief Read matcher configuration
+ */
void prefs_matcher_read_config(void)
{
- gchar * rcpath;
- FILE * f;
+ gchar *rcpath;
+ FILE *f;
+ create_matchparser_hashtab();
prefs_scoring_clear();
prefs_filtering_clear();
projects / claws.git / blobdiff