search.c File Reference

IMAP search routines. More...

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include "private.h"
#include "mutt/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "pattern/lib.h"
#include "adata.h"
#include "mdata.h"

Include dependency graph for search.c:

Go to the source code of this file.

Functions
static int	check_pattern_list (const struct PatternList *patterns)
	Check how many patterns in a list can be searched server-side.
static bool	compile_search (const struct ImapAccountData *adata, const struct Pattern *pat, struct Buffer *buf)
	Convert NeoMutt pattern to IMAP search.
static bool	check_pattern (const struct Pattern *pat)
	Check whether a pattern can be searched server-side.
static bool	compile_search_children (const struct ImapAccountData *adata, const struct Pattern *pat, struct Buffer *buf)
	Compile a search command for a pattern's children.
static bool	compile_search_self (const struct ImapAccountData *adata, const struct Pattern *pat, struct Buffer *buf)
	Compile a search command for a pattern.
bool	imap_search (struct Mailbox *m, const struct PatternList *pat)
	Find messages in mailbox matching a pattern.
void	cmd_parse_search (struct ImapAccountData *adata, const char *s)
	Store SEARCH response for later use.

Detailed Description

IMAP search routines.

Authors

• Pietro Cerutti
• Richard Russon

Copyright

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, see http://www.gnu.org/licenses/.

Definition in file search.c.

Function Documentation

check_pattern_list()

static int check_pattern_list ( const struct PatternList * patterns )

static

Check how many patterns in a list can be searched server-side.

Parameters

patterns

List of patterns to match

Return values

num	Number of patterns search that can be searched server-side

Definition at line 81 of file search.c.

{
  int positives = 0;
 
  const struct Pattern *pat = NULL;
  SLIST_FOREACH(pat, patterns, entries)
  {
    positives += check_pattern(pat);
  }
 
  return positives;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compile_search()

static bool compile_search ( const struct ImapAccountData * adata, const struct Pattern * pat, struct Buffer * buf )

static

Convert NeoMutt pattern to IMAP search.

Parameters

adata	Imap Account data
pat	Pattern to convert
buf	Buffer for result

Return values

true	Success
false	Failure

Convert neomutt Pattern to IMAP SEARCH command containing only elements that require full-text search (neomutt already has what it needs for most match types, and does a better job (eg server doesn't support regexes).

Definition at line 207 of file search.c.

{
  if (!check_pattern(pat))
    return true;
 
  if (pat->pat_not)
    buf_addstr(buf, "NOT ");
 
  return pat->child ? compile_search_children(adata, pat, buf) :
                      compile_search_self(adata, pat, buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

check_pattern()

static bool check_pattern ( const struct Pattern * pat )

static

Check whether a pattern can be searched server-side.

Parameters

pat	Pattern to check

Return values

true	Pattern can be searched server-side
false	Pattern cannot be searched server-side

Definition at line 55 of file search.c.

{
  switch (pat->op)
  {
    case MUTT_PAT_BODY:
    case MUTT_PAT_HEADER:
    case MUTT_PAT_WHOLE_MSG:
      if (pat->string_match)
        return true;
      break;
    case MUTT_PAT_SERVERSEARCH:
      return true;
      break;
    default:
      if (pat->child && check_pattern_list(pat->child))
        return true;
      break;
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compile_search_children()

static bool compile_search_children ( const struct ImapAccountData * adata, const struct Pattern * pat, struct Buffer * buf )

static

Compile a search command for a pattern's children.

Parameters

adata	Imap Account data
pat	Parent pattern
buf	Buffer for the resulting command

Return values

true	Success
false	Failure

Definition at line 102 of file search.c.

{
  int clauses = check_pattern_list(pat->child);
  if (clauses == 0)
    return true;
 
  buf_addch(buf, '(');
 
  struct Pattern *c;
  SLIST_FOREACH(c, pat->child, entries)
  {
    if (!check_pattern(c))
      continue;
 
    if ((pat->op == MUTT_PAT_OR) && (clauses > 1))
      buf_addstr(buf, "OR ");
 
    if (!compile_search(adata, c, buf))
      return false;
 
    if (clauses > 1)
      buf_addch(buf, ' ');
 
    clauses--;
  }
 
  buf_addch(buf, ')');
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compile_search_self()

static bool compile_search_self ( const struct ImapAccountData * adata, const struct Pattern * pat, struct Buffer * buf )

static

Compile a search command for a pattern.

Parameters

adata	Imap Account data
pat	Pattern
buf	Buffer for the resulting command

Return values

true	Success
false	Failure

Definition at line 141 of file search.c.

{
  char term[256] = { 0 };
  char *delim = NULL;
 
  switch (pat->op)
  {
    case MUTT_PAT_HEADER:
      buf_addstr(buf, "HEADER ");
 
      /* extract header name */
      delim = strchr(pat->p.str, ':');
      if (!delim)
      {
        mutt_error(_("Header search without header name: %s"), pat->p.str);
        return false;
      }
      *delim = '\0';
      imap_quote_string(term, sizeof(term), pat->p.str, false);
      buf_addstr(buf, term);
      buf_addch(buf, ' ');
 
      /* and field */
      *delim = ':';
      delim++;
      SKIPWS(delim);
      imap_quote_string(term, sizeof(term), delim, false);
      buf_addstr(buf, term);
      break;
    case MUTT_PAT_BODY:
      buf_addstr(buf, "BODY ");
      imap_quote_string(term, sizeof(term), pat->p.str, false);
      buf_addstr(buf, term);
      break;
    case MUTT_PAT_WHOLE_MSG:
      buf_addstr(buf, "TEXT ");
      imap_quote_string(term, sizeof(term), pat->p.str, false);
      buf_addstr(buf, term);
      break;
    case MUTT_PAT_SERVERSEARCH:
      if (!(adata->capabilities & IMAP_CAP_X_GM_EXT_1))
      {
        mutt_error(_("Server-side custom search not supported: %s"), pat->p.str);
        return false;
      }
      buf_addstr(buf, "X-GM-RAW ");
      imap_quote_string(term, sizeof(term), pat->p.str, false);
      buf_addstr(buf, term);
      break;
  }
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

imap_search()

bool imap_search	(	struct Mailbox *	m,
		const struct PatternList *	pat )

Find messages in mailbox matching a pattern.

Parameters

m	Mailbox
pat	Pattern to match

Return values

true	Success
false	Failure

Definition at line 227 of file search.c.

{
  for (int i = 0; i < m->msg_count; i++)
  {
    struct Email *e = m->emails[i];
    if (!e)
      break;
    e->matched = false;
  }
 
  if (check_pattern_list(pat) == 0)
    return true;
 
  struct Buffer *buf = buf_pool_get();
  buf_addstr(buf, "UID SEARCH ");
 
  struct ImapAccountData *adata = imap_adata_get(m);
  const bool ok = compile_search(adata, SLIST_FIRST(pat), buf) &&
                  (imap_exec(adata, buf_string(buf), IMAP_CMD_NO_FLAGS) == IMAP_EXEC_SUCCESS);
 
  buf_pool_release(&buf);
  return ok;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cmd_parse_search()

void cmd_parse_search	(	struct ImapAccountData *	adata,
		const char *	s )

Store SEARCH response for later use.

Parameters

adata	Imap Account data
s	Command string with search results

Definition at line 256 of file search.c.

{
  unsigned int uid;
  struct Email *e = NULL;
  struct ImapMboxData *mdata = adata->mailbox->mdata;
 
  mutt_debug(LL_DEBUG2, "Handling SEARCH\n");
 
  while ((s = imap_next_word((char *) s)) && (*s != '\0'))
  {
    if (!mutt_str_atoui(s, &uid))
      continue;
    e = mutt_hash_int_find(mdata->uid_hash, uid);
    if (e)
      e->matched = true;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function: