lib.h File Reference

Notmuch virtual mailbox type. More...

#include <stddef.h>
#include <stdbool.h>
#include "core/lib.h"
#include "mx.h"

Include dependency graph for lib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	nm_db_debug_check (struct Mailbox *m)
	Check if the database is open. More...
void	nm_db_longrun_done (struct Mailbox *m)
	Finish a long transaction. More...
void	nm_db_longrun_init (struct Mailbox *m, bool writable)
	Start a long transaction. More...
char *	nm_email_get_folder (struct Email *e)
	Get the folder for a Email. More...
int	nm_get_all_tags (struct Mailbox *m, char **tag_list, int *tag_count)
	Fill a list with all notmuch tags. More...
bool	nm_message_is_still_queried (struct Mailbox *m, struct Email *e)
	Is a message still visible in the query? More...
void	nm_parse_type_from_query (struct NmMboxData *mdata, char *buf)
	Parse a query type out of a query. More...
enum MailboxType	nm_path_probe (const char *path, const struct stat *st)
	Is this a Notmuch Mailbox? - Implements MxOps::path_probe() More...
void	nm_query_window_backward (void)
	Function to move the current search window backward in time. More...
void	nm_query_window_forward (void)
	Function to move the current search window forward in time. More...
int	nm_read_entire_thread (struct Mailbox *m, struct Email *e)
	Get the entire thread of an email. More...
int	nm_record_message (struct Mailbox *m, char *path, struct Email *e)
	Add a message to the Notmuch database. More...
int	nm_update_filename (struct Mailbox *m, const char *old_file, const char *new_file, struct Email *e)
	Change the filename. More...
char *	nm_url_from_query (struct Mailbox *m, char *buf, size_t buflen)
	Turn a query into a URL. More...
bool	config_init_notmuch (struct ConfigSet *cs)
	Register notmuch config variables - Implements module_init_config_t. More...

Variables
struct MxOps	MxNotmuchOps
	Notmuch Mailbox - Implements MxOps. More...
char *	C_NmQueryWindowCurrentSearch
	Config: (notmuch) Current search parameters. More...
int	C_NmQueryWindowDuration
	Config: (notmuch) Time duration of the current search window. More...
char *	C_VfolderFormat
	Config: (notmuch) printf-like format string for the browser's display of virtual folders. More...
bool	C_VirtualSpoolfile
	Config: (notmuch) Use the first virtual mailbox as a spool file. More...

Detailed Description

Notmuch virtual mailbox type.

Authors

• Karel Zak

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 lib.h.

Function Documentation

nm_db_debug_check()

void nm_db_debug_check

(

struct Mailbox *

m

)

Check if the database is open.

Parameters

m

Mailbox

Definition at line 322 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);
  if (!adata || !adata->db)
    return;

  mutt_debug(LL_DEBUG1, "nm: ERROR: db is open, closing\n");
  nm_db_release(m);
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_longrun_done()

void nm_db_longrun_done

(

struct Mailbox *

m

)

Finish a long transaction.

Parameters

m

Mailbox

Definition at line 304 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);

  if (adata)
  {
    adata->longrun = false; /* to force nm_db_release() released DB */
    if (nm_db_release(m) == 0)
      mutt_debug(LL_DEBUG2, "nm: long run deinitialized\n");
    else
      adata->longrun = true;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_longrun_init()

void nm_db_longrun_init	(	struct Mailbox *	m,
		bool	writable
	)

Start a long transaction.

Parameters

m	Mailbox
writable	Read/write?

Definition at line 289 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);

  if (!(adata && nm_db_get(m, writable)))
    return;

  adata->longrun = true;
  mutt_debug(LL_DEBUG2, "nm: long run initialized\n");
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_email_get_folder()

char* nm_email_get_folder

(

struct Email *

e

)

Get the folder for a Email.

Parameters

e

Email

Return values

ptr	Folder containing email
NULL	Error

Definition at line 1652 of file notmuch.c.

{
  struct NmEmailData *edata = nm_edata_get(e);
  if (!edata)
    return NULL;

  return edata->folder;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_get_all_tags()

int nm_get_all_tags	(	struct Mailbox *	m,
		char **	tag_list,
		int *	tag_count
	)

Fill a list with all notmuch tags.

Parameters

[in]	m	Mailbox
[out]	tag_list	List of tags
[out]	tag_count	Number of tags

Return values

0	Success
-1	Failure

If tag_list is NULL, just count the tags.

Definition at line 2101 of file notmuch.c.

{
  struct NmMboxData *mdata = nm_mdata_get(m);
  if (!mdata)
    return -1;

  notmuch_database_t *db = NULL;
  notmuch_tags_t *tags = NULL;
  const char *tag = NULL;
  int rc = -1;

  if (!(db = nm_db_get(m, false)) || !(tags = notmuch_database_get_all_tags(db)))
    goto done;

  *tag_count = 0;
  mutt_debug(LL_DEBUG1, "nm: get all tags\n");

  while (notmuch_tags_valid(tags))
  {
    tag = notmuch_tags_get(tags);
    /* Skip empty string */
    if (*tag)
    {
      if (tag_list)
        tag_list[*tag_count] = mutt_str_dup(tag);
      (*tag_count)++;
    }
    notmuch_tags_move_to_next(tags);
  }

  rc = 0;
done:
  if (tags)
    notmuch_tags_destroy(tags);

  nm_db_release(m);

  mutt_debug(LL_DEBUG1, "nm: get all tags done [rc=%d tag_count=%u]\n", rc, *tag_count);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_message_is_still_queried()

bool nm_message_is_still_queried	(	struct Mailbox *	m,
		struct Email *	e
	)

Is a message still visible in the query?

Parameters

m	Mailbox
e	Email

Return values

true	Message is still in query

Definition at line 1856 of file notmuch.c.

{
  struct NmMboxData *mdata = nm_mdata_get(m);
  notmuch_database_t *db = nm_db_get(m, false);
  char *orig_str = get_query_string(mdata, true);

  if (!db || !orig_str)
    return false;

  char *new_str = NULL;
  bool rc = false;
  if (mutt_str_asprintf(&new_str, "id:%s and (%s)", email_get_id(e), orig_str) < 0)
    return false;

  mutt_debug(LL_DEBUG2, "nm: checking if message is still queried: %s\n", new_str);

  notmuch_query_t *q = notmuch_query_create(db, new_str);

  switch (mdata->query_type)
  {
    case NM_QUERY_TYPE_MESGS:
    {
      notmuch_messages_t *messages = get_messages(q);

      if (!messages)
        return false;

      rc = notmuch_messages_valid(messages);
      notmuch_messages_destroy(messages);
      break;
    }
    case NM_QUERY_TYPE_THREADS:
    {
      notmuch_threads_t *threads = get_threads(q);

      if (!threads)
        return false;

      rc = notmuch_threads_valid(threads);
      notmuch_threads_destroy(threads);
      break;
    }
  }

  notmuch_query_destroy(q);

  mutt_debug(LL_DEBUG2, "nm: checking if message is still queried: %s = %s\n",
             new_str, rc ? "true" : "false");

  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_parse_type_from_query()

void nm_parse_type_from_query	(	struct NmMboxData *	mdata,
		char *	buf
	)

Parse a query type out of a query.

Parameters

mdata	Mailbox, used for the query_type
buf	Buffer for URL

If a user writes a query for a vfolder and includes a type= statement, that type= will be encoded, which Notmuch will treat as part of the query= statement. This method will remove the type= and set it within the Mailbox struct.

Definition at line 1736 of file notmuch.c.

{
  if (!buf)
    return;

  // The six variations of how type= could appear.
  const char *variants[6] = { "&type=threads", "&type=messages",
                              "type=threads&", "type=messages&",
                              "type=threads",  "type=messages" };

  int variants_size = mutt_array_size(variants);
  for (int i = 0; i < variants_size; i++)
  {
    if (strcasestr(buf, variants[i]) != NULL)
    {
      // variants[] is setup such that type can be determined via modulo 2.
      mdata->query_type = ((i % 2) == 0) ? NM_QUERY_TYPE_THREADS : NM_QUERY_TYPE_MESGS;

      mutt_istr_remall(buf, variants[i]);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_path_probe()

enum MailboxType nm_path_probe	(	const char *	path,
		const struct stat *	st
	)

Is this a Notmuch Mailbox? - Implements MxOps::path_probe()

Definition at line 2594 of file notmuch.c.

{
  if (!path || !mutt_istr_startswith(path, NmUrlProtocol))
    return MUTT_UNKNOWN;

  return MUTT_NOTMUCH;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_query_window_backward()

void nm_query_window_backward

(

void

)

Function to move the current search window backward in time.

Updates nm_query_window_current_position by incrementing it by 1

The higher the value of nm_query_window_current_position is, the less recent the result will be.

Definition at line 1844 of file notmuch.c.

{
  C_NmQueryWindowCurrentPosition++;
  mutt_debug(LL_DEBUG2, "(%d)\n", C_NmQueryWindowCurrentPosition);
}

Here is the caller graph for this function:

nm_query_window_forward()

void nm_query_window_forward

(

void

)

Function to move the current search window forward in time.

Updates nm_query_window_current_position by decrementing it by 1, or does nothing if the current window already is set to 0.

The lower the value of nm_query_window_current_position is, the more recent the result will be.

Definition at line 1828 of file notmuch.c.

{
  if (C_NmQueryWindowCurrentPosition != 0)
    C_NmQueryWindowCurrentPosition--;

  mutt_debug(LL_DEBUG2, "(%d)\n", C_NmQueryWindowCurrentPosition);
}

Here is the caller graph for this function:

nm_read_entire_thread()

int nm_read_entire_thread	(	struct Mailbox *	m,
		struct Email *	e
	)

Get the entire thread of an email.

Parameters

m	Mailbox
e	Email

Return values

0	Success
-1	Failure

Definition at line 1668 of file notmuch.c.

{
  if (!m)
    return -1;

  struct NmMboxData *mdata = nm_mdata_get(m);
  if (!mdata)
    return -1;

  notmuch_query_t *q = NULL;
  notmuch_database_t *db = NULL;
  notmuch_message_t *msg = NULL;
  int rc = -1;

  if (!(db = nm_db_get(m, false)) || !(msg = get_nm_message(db, e)))
    goto done;

  mutt_debug(LL_DEBUG1, "nm: reading entire-thread messages...[current count=%d]\n",
             m->msg_count);

  progress_reset(m);
  const char *id = notmuch_message_get_thread_id(msg);
  if (!id)
    goto done;

  char *qstr = NULL;
  mutt_str_append_item(&qstr, "thread:", '\0');
  mutt_str_append_item(&qstr, id, '\0');

  q = notmuch_query_create(db, qstr);
  FREE(&qstr);
  if (!q)
    goto done;
  apply_exclude_tags(q);
  notmuch_query_set_sort(q, NOTMUCH_SORT_NEWEST_FIRST);

  read_threads_query(m, q, true, 0);
  m->mtime.tv_sec = mutt_date_epoch();
  m->mtime.tv_nsec = 0;
  rc = 0;

  if (m->msg_count > mdata->oldmsgcount)
    mailbox_changed(m, NT_MAILBOX_INVALID);
done:
  if (q)
    notmuch_query_destroy(q);

  nm_db_release(m);

  if (m->msg_count == mdata->oldmsgcount)
    mutt_message(_("No more messages in the thread"));

  mdata->oldmsgcount = 0;
  mutt_debug(LL_DEBUG1, "nm: reading entire-thread messages... done [rc=%d, count=%d]\n",
             rc, m->msg_count);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_record_message()

int nm_record_message	(	struct Mailbox *	m,
		char *	path,
		struct Email *	e
	)

Add a message to the Notmuch database.

Parameters

m	Mailbox
path	Path of the email
e	Email

Return values

0	Success
-1	Failure

Definition at line 2036 of file notmuch.c.

{
  notmuch_database_t *db = NULL;
  notmuch_status_t st;
  notmuch_message_t *msg = NULL;
  int rc = -1;
  struct NmMboxData *mdata = nm_mdata_get(m);

  if (!path || !mdata || (access(path, F_OK) != 0))
    return 0;
  db = nm_db_get(m, true);
  if (!db)
    return -1;

  mutt_debug(LL_DEBUG1, "nm: record message: %s\n", path);
  int trans = nm_db_trans_begin(m);
  if (trans < 0)
    goto done;

#ifdef HAVE_NOTMUCH_DATABASE_INDEX_FILE
  st = notmuch_database_index_file(db, path, NULL, &msg);
#else
  st = notmuch_database_add_message(db, path, &msg);
#endif

  if ((st != NOTMUCH_STATUS_SUCCESS) && (st != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID))
  {
    mutt_debug(LL_DEBUG1, "nm: failed to add '%s' [st=%d]\n", path, (int) st);
    goto done;
  }

  if ((st == NOTMUCH_STATUS_SUCCESS) && msg)
  {
    notmuch_message_maildir_flags_to_tags(msg);
    if (e)
    {
      char *tags = driver_tags_get(&e->tags);
      update_tags(msg, tags);
      FREE(&tags);
    }
    if (C_NmRecordTags)
      update_tags(msg, C_NmRecordTags);
  }

  rc = 0;
done:
  if (msg)
    notmuch_message_destroy(msg);
  if (trans == 1)
    nm_db_trans_end(m);

  nm_db_release(m);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_update_filename()

int nm_update_filename	(	struct Mailbox *	m,
		const char *	old_file,
		const char *	new_file,
		struct Email *	e
	)

Change the filename.

Parameters

m	Mailbox
old_file	Old filename
new_file	New filename
e	Email

Return values

0	Success
-1	Failure

Definition at line 1917 of file notmuch.c.

{
  char buf[PATH_MAX];
  struct NmMboxData *mdata = nm_mdata_get(m);
  if (!mdata || !new_file)
    return -1;

  if (!old_file && nm_edata_get(e))
  {
    email_get_fullpath(e, buf, sizeof(buf));
    old_file = buf;
  }

  int rc = rename_filename(m, old_file, new_file, e);

  nm_db_release(m);
  m->mtime.tv_sec = mutt_date_epoch();
  m->mtime.tv_nsec = 0;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_url_from_query()

char* nm_url_from_query	(	struct Mailbox *	m,
		char *	buf,
		size_t	buflen
	)

Turn a query into a URL.

Parameters

m	Mailbox
buf	Buffer for URL
buflen	Length of buffer

Return values

ptr	Query as a URL
NULL	Error

Definition at line 1767 of file notmuch.c.

{
  mutt_debug(LL_DEBUG2, "(%s)\n", buf);
  struct NmMboxData *mdata = nm_mdata_get(m);
  char url[PATH_MAX + 1024 + 32]; /* path to DB + query + URL "decoration" */
  int added;
  bool using_default_data = false;

  // No existing data. Try to get a default NmMboxData.
  if (!mdata)
  {
    mdata = nm_get_default_data();

    // Failed to get default data.
    if (!mdata)
      return NULL;

    using_default_data = true;
  }

  nm_parse_type_from_query(mdata, buf);

  if (get_limit(mdata) == C_NmDbLimit)
  {
    added = snprintf(url, sizeof(url), "%s%s?type=%s&query=", NmUrlProtocol,
                     nm_db_get_filename(m), query_type_to_string(mdata->query_type));
  }
  else
  {
    added = snprintf(url, sizeof(url), "%s%s?type=%s&limit=%d&query=", NmUrlProtocol,
                     nm_db_get_filename(m),
                     query_type_to_string(mdata->query_type), get_limit(mdata));
  }

  if (added >= sizeof(url))
  {
    // snprintf output was truncated, so can't create URL
    return NULL;
  }

  url_pct_encode(&url[added], sizeof(url) - added, buf);

  mutt_str_copy(buf, url, buflen);
  buf[buflen - 1] = '\0';

  if (using_default_data)
    nm_mdata_free((void **) &mdata);

  mutt_debug(LL_DEBUG1, "nm: url from query '%s'\n", buf);
  return buf;
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_init_notmuch()

bool config_init_notmuch

(

struct ConfigSet *

cs

)

Register notmuch config variables - Implements module_init_config_t.

Definition at line 110 of file config.c.

{
  return cs_register_variables(cs, NotmuchVars, 0);
}

Here is the call graph for this function:

Variable Documentation

MxNotmuchOps

struct MxOps MxNotmuchOps

Notmuch Mailbox - Implements MxOps.

Definition at line 2635 of file notmuch.c.

C_NmQueryWindowCurrentSearch

char* C_NmQueryWindowCurrentSearch

Config: (notmuch) Current search parameters.

Definition at line 44 of file config.c.

C_NmQueryWindowDuration

int C_NmQueryWindowDuration

Config: (notmuch) Time duration of the current search window.

Definition at line 45 of file config.c.

C_VfolderFormat

char* C_VfolderFormat

Config: (notmuch) printf-like format string for the browser's display of virtual folders.

Definition at line 50 of file config.c.

C_VirtualSpoolfile

bool C_VirtualSpoolfile

Config: (notmuch) Use the first virtual mailbox as a spool file.

Definition at line 51 of file config.c.