NeoMutt  2021-02-05-666-ge300cd
Teaching an old dog new tricks
DOXYGEN
lib.h File Reference

Compressed mbox local mailbox type. More...

#include <stdbool.h>
#include <stdio.h>
#include "core/lib.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.

Data Structures

struct  CompressInfo
 Private data for compress. More...
 

Functions

void mutt_comp_init (void)
 Setup feature commands. More...
 
bool mutt_comp_can_append (struct Mailbox *m)
 Can we append to this path? More...
 
bool mutt_comp_can_read (const char *path)
 Can we read from this file? More...
 
int mutt_comp_valid_command (const char *cmd)
 Is this command string allowed? More...
 

Variables

struct MxOps MxCompOps
 Compressed Mailbox - Implements MxOps -Compress only uses open, close and check. More...
 

Detailed Description

Compressed mbox local mailbox type.

Authors
  • Alain Penders
  • Richard Russon

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

◆ mutt_comp_init()

void mutt_comp_init ( void  )

Setup feature commands.

Definition at line 69 of file compress.c.

70 {
72 }
#define COMMANDS_REGISTER(cmds)
Definition: mutt_commands.h:82
static const struct Command comp_commands[]
Definition: compress.c:58
+ Here is the caller graph for this function:

◆ mutt_comp_can_append()

bool mutt_comp_can_append ( struct Mailbox m)

Can we append to this path?

Parameters
mMailbox
Return values
trueYes, we can append to the file
falseNo, appending isn't possible

To append to a file we can either use an 'append-hook' or a combination of 'open-hook' and 'close-hook'.

A match means it's our responsibility to append to the file.

Definition at line 359 of file compress.c.

360 {
361  if (!m)
362  return false;
363 
364  /* If this succeeds, we know there's an open-hook */
365  struct CompressInfo *ci = set_compress_info(m);
366  if (!ci)
367  return false;
368 
369  /* We have an open-hook, so to append we need an append-hook,
370  * or a close-hook. */
371  if (ci->cmd_append || ci->cmd_close)
372  return true;
373 
374  mutt_error(_("Can't append without an append-hook or close-hook : %s"), mailbox_path(m));
375  return false;
376 }
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox&#39;s path string.
Definition: mailbox.h:215
const char * cmd_append
append-hook command
Definition: lib.h:48
#define mutt_error(...)
Definition: logging.h:88
#define _(a)
Definition: message.h:28
const char * cmd_close
close-hook command
Definition: lib.h:49
static struct CompressInfo * set_compress_info(struct Mailbox *m)
Find the compress hooks for a mailbox.
Definition: compress.c:196
Private data for compress.
Definition: lib.h:46
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_comp_can_read()

bool mutt_comp_can_read ( const char *  path)

Can we read from this file?

Parameters
pathPathname of file to be tested
Return values
trueYes, we can read the file
falseNo, we can't read the file

Search for an 'open-hook' with a regex that matches the path.

A match means it's our responsibility to open the file.

Definition at line 388 of file compress.c.

389 {
390  if (!path)
391  return false;
392 
393  if (mutt_find_hook(MUTT_OPEN_HOOK, path))
394  return true;
395 
396  return false;
397 }
char * mutt_find_hook(HookFlags type, const char *pat)
Find a matching hook.
Definition: hook.c:577
#define MUTT_OPEN_HOOK
open-hook: to read a compressed mailbox
Definition: hook.h:52
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_comp_valid_command()

int mutt_comp_valid_command ( const char *  cmd)

Is this command string allowed?

Parameters
cmdCommand string
Return values
1Valid command
0"%f" and/or "%t" is missing

A valid command string must have both "%f" (from file) and "%t" (to file). We don't check if we can actually run the command.

Definition at line 408 of file compress.c.

409 {
410  if (!cmd)
411  return 0;
412 
413  return strstr(cmd, "%f") && strstr(cmd, "%t");
414 }
+ Here is the caller graph for this function: