NeoMutt  2022-04-29-145-g9b6a0e
Teaching an old dog new tricks
DOXYGEN
query.c File Reference

Notmuch query functions. More...

#include "config.h"
#include <stddef.h>
#include <stdio.h>
#include <string.h>
#include "mutt/lib.h"
#include "query.h"
+ Include dependency graph for query.c:

Go to the source code of this file.

Functions

enum NmQueryType nm_parse_type_from_query (char *buf, enum NmQueryType fallback)
 Parse a query type out of a query. More...
 
const char * nm_query_type_to_string (enum NmQueryType query_type)
 Turn a query type into a string. More...
 
enum NmQueryType nm_string_to_query_type (const char *str)
 Lookup a query type. More...
 
enum NmQueryType nm_string_to_query_type_mapper (const char *str)
 Lookup a query type. More...
 
bool nm_query_window_check_timebase (const char *timebase)
 Checks if a given timebase string is valid. More...
 
enum NmWindowQueryRc nm_windowed_query_from_query (char *buf, size_t buflen, const bool force_enable, const short duration, const short cur_pos, const char *cur_search, const char *timebase, const char *or_terms)
 Windows buf with notmuch date: search term. More...
 

Detailed Description

Notmuch query functions.

Authors
  • Austin Ray

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 query.c.

Function Documentation

◆ nm_parse_type_from_query()

enum NmQueryType nm_parse_type_from_query ( char *  buf,
enum NmQueryType  fallback 
)

Parse a query type out of a query.

Parameters
bufBuffer for URL
fallbackFallback query type if buf doesn't contain a type= statement
Return values
numNotmuch query type, NmQueryType

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 return its corresponding NmQueryType representation.

Definition at line 1 of file query.c.

50 {
51  enum NmQueryType query_type = fallback;
52 
53  if (!buf)
54  return query_type;
55 
56  size_t buf_len = mutt_str_len(buf);
57  const char *message_ptr = mutt_istrn_rfind(buf, buf_len, "type=messages");
58  const char *thread_ptr = mutt_istrn_rfind(buf, buf_len, "type=threads");
59 
60  // No valid type statement found.
61  if (!message_ptr && !thread_ptr)
62  return query_type;
63 
64  // Determine the last valid "type=" statement.
65  if ((!message_ptr && thread_ptr) || (thread_ptr > message_ptr))
66  {
67  query_type = NM_QUERY_TYPE_THREADS;
68  }
69  else
70  {
71  query_type = NM_QUERY_TYPE_MESGS;
72  }
73 
74  // Clean-up any valid "type=" statements.
75  // The six variations of how "type=" could appear.
76  const char *variants[6] = { "&type=threads", "&type=messages",
77  "type=threads&", "type=messages&",
78  "type=threads", "type=messages" };
79  int variants_size = mutt_array_size(variants);
80 
81  for (int i = 0; i < variants_size; i++)
82  {
83  mutt_istr_remall(buf, variants[i]);
84  }
85 
86  return query_type;
87 }
#define mutt_array_size(x)
Definition: memory.h:36
const char * mutt_istrn_rfind(const char *haystack, size_t haystack_length, const char *needle)
Find last instance of a substring, ignoring case.
Definition: string.c:517
int mutt_istr_remall(char *str, const char *target)
Remove all occurrences of substring, ignoring case.
Definition: string.c:950
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:544
NmQueryType
Notmuch Query Types.
Definition: query.h:35
@ NM_QUERY_TYPE_THREADS
Whole threads.
Definition: query.h:37
@ NM_QUERY_TYPE_MESGS
Default: Messages only.
Definition: query.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nm_query_type_to_string()

const char* nm_query_type_to_string ( enum NmQueryType  query_type)

Turn a query type into a string.

Parameters
query_typeQuery type
Return values
ptrString
Note
This is a static string and must not be freed.

Definition at line 96 of file query.c.

97 {
98  if (query_type == NM_QUERY_TYPE_THREADS)
99  return "threads";
100  return "messages";
101 }
+ Here is the caller graph for this function:

◆ nm_string_to_query_type()

enum NmQueryType nm_string_to_query_type ( const char *  str)

Lookup a query type.

Parameters
strString to lookup
Return values
numQuery type, e.g. NM_QUERY_TYPE_MESGS

If there's an unknown query type, default to NM_QUERY_TYPE_MESGS.

Definition at line 96 of file query.c.

111 {
112  enum NmQueryType query_type = nm_string_to_query_type_mapper(str);
113 
114  if (query_type == NM_QUERY_TYPE_UNKNOWN)
115  {
116  mutt_error(_("failed to parse notmuch query type: %s"), NONULL(str));
117  return NM_QUERY_TYPE_MESGS;
118  }
119 
120  return query_type;
121 }
#define mutt_error(...)
Definition: logging.h:87
#define _(a)
Definition: message.h:28
enum NmQueryType nm_string_to_query_type_mapper(const char *str)
Lookup a query type.
Definition: query.c:130
@ NM_QUERY_TYPE_UNKNOWN
Unknown query type. Error in notmuch query.
Definition: query.h:38
#define NONULL(x)
Definition: string2.h:37
+ Here is the caller graph for this function:

◆ nm_string_to_query_type_mapper()

enum NmQueryType nm_string_to_query_type_mapper ( const char *  str)

Lookup a query type.

Parameters
strString to lookup
Return values
numQuery type
NM_QUERY_TYPE_UNKNOWNon error

Definition at line 96 of file query.c.

131 {
132  if (mutt_str_equal(str, "threads"))
133  return NM_QUERY_TYPE_THREADS;
134  if (mutt_str_equal(str, "messages"))
135  return NM_QUERY_TYPE_MESGS;
136 
137  return NM_QUERY_TYPE_UNKNOWN;
138 }
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:784

◆ nm_query_window_check_timebase()

bool nm_query_window_check_timebase ( const char *  timebase)

Checks if a given timebase string is valid.

Parameters
[in]timebasestring containing a time base
Return values
trueThe given time base is valid

This function returns whether a given timebase string is valid or not, which is used to validate the user settable configuration setting:

nm_query_window_timebase

Definition at line 150 of file query.c.

151 {
152  if ((strcmp(timebase, "hour") == 0) || (strcmp(timebase, "day") == 0) ||
153  (strcmp(timebase, "week") == 0) || (strcmp(timebase, "month") == 0) ||
154  (strcmp(timebase, "year") == 0))
155  {
156  return true;
157  }
158  return false;
159 }
+ Here is the caller graph for this function:

◆ nm_windowed_query_from_query()

enum NmWindowQueryRc nm_windowed_query_from_query ( char *  buf,
size_t  buflen,
const bool  force_enable,
const short  duration,
const short  cur_pos,
const char *  cur_search,
const char *  timebase,
const char *  or_terms 
)

Windows buf with notmuch date: search term.

Parameters
[out]bufallocated string buffer to receive the modified search query
[in]buflenallocated maximum size of the buf string buffer
[in]force_enableEnables windowing for duration=0
[in]durationDuration of time between beginning and end for notmuch date search term
[in]cur_posCurrent position of vfolder window
[in]cur_searchCurrent notmuch search
[in]timebaseTimebase for date: search term. Must be: hour, day, week, month, or year
[in]or_termsAdditional notmuch search terms
Return values
NM_WINDOW_QUERY_SUCCESSPrepended buf with date: search term
NM_WINDOW_QUERY_INVALID_DURATIONDuration out-of-range for search term. buf not prepended with date:
NM_WINDOW_QUERY_INVALID_TIMEBASETimebase isn't one of hour, day, week, month, or year

This is where the magic of windowed queries happens. Taking a vfolder search query string as parameter, it will use the following two user settings:

  • duration and
  • timebase

to amend given vfolder search window. Then using a third parameter:

  • cur_pos

it will generate a proper notmuch date: parameter. For example, given a duration of 2, a timebase set to week and a position defaulting to 0, it will prepend to the 'tag:inbox' notmuch search query the following string:

  • query: tag:inbox
  • buf: date:2week..now and tag:inbox

If the position is set to 4, with duration=3 and timebase=month:

  • query: tag:archived
  • buf: date:12month..9month and tag:archived

The window won't be applied:

  • If the duration of the search query is set to 0 this function will be disabled unless a user explicitly enables windowed queries. This returns NM_WINDOW_QUERY_INVALID_DURATION
  • If the timebase is invalid, it will return NM_WINDOW_QUERY_INVALID_TIMEBASE

Definition at line 150 of file query.c.

210 {
211  // if the duration is a non positive integer, disable the window unless the
212  // user explicitly enables windowed queries.
213  if (!force_enable && (duration <= 0))
214  {
216  }
217 
218  int beg = duration * (cur_pos + 1);
219  int end = duration * cur_pos;
220 
221  // If the duration is 0, we want to generate a query spanning a single timebase.
222  // For example, `date:1month..1month` spans the previous month.
223  if ((duration == 0) && (cur_pos != 0))
224  {
225  end = cur_pos;
226  beg = end;
227  }
228 
229  if (!nm_query_window_check_timebase(timebase))
230  {
232  }
233 
234  size_t length = 0;
235  if (end == 0)
236  {
237  // Open-ended date allows mail from the future.
238  // This may occur is the sender's time settings are off.
239  length = snprintf(buf, buflen, "date:%d%s..", beg, timebase);
240  }
241  else
242  {
243  length = snprintf(buf, buflen, "date:%d%s..%d%s", beg, timebase, end, timebase);
244  }
245 
246  if (!mutt_str_equal(or_terms, ""))
247  {
248  char *date_part = mutt_str_dup(buf);
249  length = snprintf(buf, buflen, "(%s or (%s))", date_part, or_terms);
250  FREE(&date_part);
251  }
252 
253  // Add current search to window query.
254  snprintf(buf + length, buflen, " and %s", cur_search);
255 
257 }
#define FREE(x)
Definition: memory.h:43
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:250
bool nm_query_window_check_timebase(const char *timebase)
Checks if a given timebase string is valid.
Definition: query.c:150
@ NM_WINDOW_QUERY_SUCCESS
Query was successful.
Definition: query.h:46
@ NM_WINDOW_QUERY_INVALID_DURATION
Invalid duration.
Definition: query.h:48
@ NM_WINDOW_QUERY_INVALID_TIMEBASE
Invalid timebase.
Definition: query.h:47
+ Here is the caller graph for this function: