private.h File Reference

Notmuch private types. More...

#include <notmuch.h>
#include <stdbool.h>
#include <time.h>

Include dependency graph for private.h:

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

Go to the source code of this file.

Macros
#define	HAVE_NOTMUCH_DATABASE_INDEX_FILE   0
#define	HAVE_NOTMUCH_DATABASE_OPEN_WITH_CONFIG   0
#define	LIBNOTMUCH_CHECK_VERSION(major, minor, micro)

Functions
notmuch_database_t *	nm_db_do_open (const char *filename, bool writable, bool verbose)
	Open a Notmuch database.
void	nm_db_free (notmuch_database_t *db)
	Decoupled way to close a Notmuch database.
const char *	nm_db_get_filename (struct Mailbox *m)
	Get the filename of the Notmuch database.
int	nm_db_get_mtime (struct Mailbox *m, time_t *mtime)
	Get the database modification time.
notmuch_database_t *	nm_db_get (struct Mailbox *m, bool writable)
	Get the Notmuch database.
bool	nm_db_is_longrun (struct Mailbox *m)
	Is Notmuch in the middle of a long-running transaction.
int	nm_db_release (struct Mailbox *m)
	Close the Notmuch database.
int	nm_db_trans_begin (struct Mailbox *m)
	Start a Notmuch database transaction.
int	nm_db_trans_end (struct Mailbox *m)
	End a database transaction.

Variables
const char	NmUrlProtocol []
	Protocol string for Notmuch URLs.
const int	NmUrlProtocolLen
	Length of NmUrlProtocol string.

Detailed Description

Notmuch private types.

Authors

• Richard Russon
• Austin Ray

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

Macro Definition Documentation

HAVE_NOTMUCH_DATABASE_INDEX_FILE

#define HAVE_NOTMUCH_DATABASE_INDEX_FILE   0

Definition at line 38 of file private.h.

HAVE_NOTMUCH_DATABASE_OPEN_WITH_CONFIG

#define HAVE_NOTMUCH_DATABASE_OPEN_WITH_CONFIG   0

Definition at line 42 of file private.h.

LIBNOTMUCH_CHECK_VERSION

#define LIBNOTMUCH_CHECK_VERSION	(		major,
			minor,
			micro )

Value:

  (major == 5 && minor == 4 && HAVE_NOTMUCH_DATABASE_OPEN_WITH_CONFIG)          || \
  (major == 5 && minor == 1 && HAVE_NOTMUCH_DATABASE_INDEX_FILE)                || \
  ((LIBNOTMUCH_MAJOR_VERSION > (major) ||                                          \
   (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor))  || \
   (LIBNOTMUCH_MAJOR_VERSION == (major) &&                                         \
    LIBNOTMUCH_MINOR_VERSION == (minor) && LIBNOTMUCH_MICRO_VERSION >= (micro))))

Definition at line 52 of file private.h.

#define LIBNOTMUCH_CHECK_VERSION(major, minor, micro)                              \
  (major == 5 && minor == 4 && HAVE_NOTMUCH_DATABASE_OPEN_WITH_CONFIG)          || \
  (major == 5 && minor == 1 && HAVE_NOTMUCH_DATABASE_INDEX_FILE)                || \
  ((LIBNOTMUCH_MAJOR_VERSION > (major) ||                                          \
   (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor))  || \
   (LIBNOTMUCH_MAJOR_VERSION == (major) &&                                         \
    LIBNOTMUCH_MINOR_VERSION == (minor) && LIBNOTMUCH_MICRO_VERSION >= (micro))))

Function Documentation

nm_db_do_open()

notmuch_database_t * nm_db_do_open	(	const char *	filename,
		bool	writable,
		bool	verbose )

Open a Notmuch database.

Parameters

filename	Database filename
writable	Read/write?
verbose	Show errors on failure?

Return values

ptr	Notmuch database

Definition at line 116 of file db.c.

{
  notmuch_database_t *db = NULL;
  int ct = 0;
  notmuch_status_t st = NOTMUCH_STATUS_SUCCESS;
  char *msg = NULL;
 
  const short c_nm_open_timeout = cs_subset_number(NeoMutt->sub, "nm_open_timeout");
  mutt_debug(LL_DEBUG1, "nm: db open '%s' %s (timeout %d)\n", filename ? filename : "(auto)",
             writable ? "[WRITE]" : "[READ]", c_nm_open_timeout);
 
  const notmuch_database_mode_t mode = writable ? NOTMUCH_DATABASE_MODE_READ_WRITE :
                                                  NOTMUCH_DATABASE_MODE_READ_ONLY;
 
  do
  {
#if LIBNOTMUCH_CHECK_VERSION(5, 4, 0)
    // notmuch 0.32-0.32.2 didn't bump libnotmuch version to 5.4.
    const char *config_file = get_nm_config_file();
    const char *const c_nm_config_profile = cs_subset_string(NeoMutt->sub, "nm_config_profile");
 
    FREE(&msg);
    st = notmuch_database_open_with_config(filename, mode, config_file,
                                           c_nm_config_profile, &db, &msg);
 
    // Attempt opening database without configuration file. Don't if the user specified no config.
    if ((st == NOTMUCH_STATUS_NO_CONFIG) && !mutt_str_equal(config_file, ""))
    {
      mutt_debug(LL_DEBUG1, "nm: Could not find notmuch configuration file: %s\n", config_file);
      mutt_debug(LL_DEBUG1, "nm: Attempting to open notmuch db without configuration file\n");
 
      FREE(&msg);
 
      st = notmuch_database_open_with_config(filename, mode, "", NULL, &db, &msg);
    }
    else if ((st == NOTMUCH_STATUS_NO_CONFIG) && !config_file)
    {
      FREE(&msg);
    }
#elif LIBNOTMUCH_CHECK_VERSION(4, 2, 0)
    st = notmuch_database_open_verbose(filename, mode, &db, &msg);
#elif defined(NOTMUCH_API_3)
    st = notmuch_database_open(filename, mode, &db);
#else
    db = notmuch_database_open(filename, mode);
#endif
    if ((st == NOTMUCH_STATUS_FILE_ERROR) || db || !c_nm_open_timeout ||
        ((ct / 2) > c_nm_open_timeout))
    {
      break;
    }
 
    if (verbose && ct && ((ct % 2) == 0))
      mutt_error(_("Waiting for notmuch DB... (%d sec)"), ct / 2);
    mutt_date_sleep_ms(500); /* Half a second */
    ct++;
  } while (true);
 
  if (st != NOTMUCH_STATUS_SUCCESS)
  {
    db = NULL;
  }
 
  if (verbose)
  {
    if (!db)
    {
      if (msg)
      {
        mutt_error("%s", msg);
      }
      else
      {
        mutt_error(_("Can't open notmuch database: %s: %s"), filename,
                   st ? notmuch_status_to_string(st) : _("unknown reason"));
      }
    }
    else if (ct > 1)
    {
      mutt_clear_error();
    }
  }
 
  FREE(&msg);
 
  return db;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_free()

void nm_db_free

(

notmuch_database_t *

db

)

Decoupled way to close a Notmuch database.

Parameters

db	Notmuch database

Definition at line 262 of file db.c.

{
#ifdef NOTMUCH_API_3
  notmuch_database_destroy(db);
#else
  notmuch_database_close(db);
#endif
}

Here is the caller graph for this function:

nm_db_get_filename()

const char * nm_db_get_filename

(

struct Mailbox *

m

)

Get the filename of the Notmuch database.

Parameters

m

Mailbox

Return values

ptr	Filename
NULL	No notmuch-specific database path configured

Returns the database path from the mailbox URL or $nm_default_url. On libnotmuch >= 5.4, a NULL return allows notmuch to resolve the database path from its own configuration file or environment variables.

Note

The return value is a pointer into the $nm_default_url global variable. If that variable changes, the result will be invalid. It must not be freed.

Definition at line 63 of file db.c.

{
  struct NmMboxData *mdata = nm_mdata_get(m);
  const char *db_filename = NULL;
 
  const char *const c_nm_default_url = cs_subset_string(NeoMutt->sub, "nm_default_url");
  if (mdata && mdata->db_url && mdata->db_url->path)
    db_filename = mdata->db_url->path;
  else
    db_filename = c_nm_default_url;
 
  if (!db_filename)
    return NULL;
 
  if (nm_path_probe(db_filename, NULL) == MUTT_NOTMUCH)
    db_filename += NmUrlProtocolLen;
 
  mutt_debug(LL_DEBUG2, "nm: db filename '%s'\n", db_filename);
  return db_filename;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_get_mtime()

int nm_db_get_mtime	(	struct Mailbox *	m,
		time_t *	mtime )

Get the database modification time.

Parameters

[in]	m	Mailbox
[out]	mtime	Save the modification time

Return values

0	Success (result in mtime)
-1	Error

Get the "mtime" (modification time) of the database file. This is the time of the last update.

Definition at line 327 of file db.c.

{
  if (!m || !mtime)
    return -1;
 
  struct stat st = { 0 };
  char path[PATH_MAX] = { 0 };
  const char *db_filename = nm_db_get_filename(m);
  if (!db_filename)
    return -1;
 
  mutt_debug(LL_DEBUG2, "nm: checking database mtime '%s'\n", db_filename);
 
  // See if the path we were given has a Xapian directory.
  // After notmuch 0.32, a .notmuch folder isn't guaranteed.
  snprintf(path, sizeof(path), "%s/xapian", db_filename);
  if (stat(path, &st) == 0)
  {
    *mtime = st.st_mtime;
    return 0;
  }
 
  // Otherwise, check for a .notmuch directory.
  snprintf(path, sizeof(path), "%s/.notmuch/xapian", db_filename);
 
  if (stat(path, &st) != 0)
    return -1;
 
  *mtime = st.st_mtime;
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_get()

notmuch_database_t * nm_db_get	(	struct Mailbox *	m,
		bool	writable )

Get the Notmuch database.

Parameters

m	Mailbox
writable	Read/write?

Return values

ptr	Notmuch database

Definition at line 210 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);
 
  if (!adata)
    return NULL;
 
  // Use an existing open db if we have one.
  if (adata->db)
    return adata->db;
 
  const char *db_filename = nm_db_get_filename(m);
#if LIBNOTMUCH_CHECK_VERSION(5, 4, 0)
  // On libnotmuch >= 5.4, NULL db_filename lets notmuch resolve the
  // database path from its config file or environment variables.
  adata->db = nm_db_do_open(db_filename, writable, true);
#else
  if (!db_filename)
  {
    const char *const c_folder = cs_subset_string(NeoMutt->sub, "folder");
    db_filename = c_folder;
  }
  if (db_filename)
    adata->db = nm_db_do_open(db_filename, writable, true);
#endif
 
  return adata->db;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_is_longrun()

bool nm_db_is_longrun

(

struct Mailbox *

m

)

Is Notmuch in the middle of a long-running transaction.

Parameters

m

Mailbox

Return values

true	Notmuch is in the middle of a long-running transaction

Definition at line 364 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);
  if (!adata)
    return false;
 
  return adata->longrun;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_release()

int nm_db_release

(

struct Mailbox *

m

)

Close the Notmuch database.

Parameters

m

Mailbox

Return values

0	Success
-1	Failure

Definition at line 245 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);
  if (!adata || !adata->db || nm_db_is_longrun(m))
    return -1;
 
  mutt_debug(LL_DEBUG1, "nm: db close\n");
  nm_db_free(adata->db);
  adata->db = NULL;
  adata->longrun = false;
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_trans_begin()

int nm_db_trans_begin

(

struct Mailbox *

m

)

Start a Notmuch database transaction.

Parameters

m

Mailbox

Return values

<0	error
1	new transaction started
0	already within transaction

Definition at line 278 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);
  if (!adata || !adata->db)
    return -1;
 
  if (adata->trans)
    return 0;
 
  mutt_debug(LL_DEBUG2, "nm: db trans start\n");
  if (notmuch_database_begin_atomic(adata->db))
    return -1;
  adata->trans = true;
  return 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_db_trans_end()

int nm_db_trans_end

(

struct Mailbox *

m

)

End a database transaction.

Parameters

m

Mailbox

Return values

0	Success
-1	Failure

Definition at line 300 of file db.c.

{
  struct NmAccountData *adata = nm_adata_get(m);
  if (!adata || !adata->db)
    return -1;
 
  if (!adata->trans)
    return 0;
 
  mutt_debug(LL_DEBUG2, "nm: db trans end\n");
  adata->trans = false;
  if (notmuch_database_end_atomic(adata->db))
    return -1;
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

NmUrlProtocol

const char NmUrlProtocol[]

extern

Protocol string for Notmuch URLs.

Definition at line 102 of file notmuch.c.

NmUrlProtocolLen

const int NmUrlProtocolLen

extern

Length of NmUrlProtocol string.

Definition at line 104 of file notmuch.c.