diplodocus.org Git - nmh/blob - h/prototypes.h

   1 /* prototypes.h -- various prototypes
   2  *
   3  * If you modify functions here, please document their current behavior
   4  * as much as practical.
   5  */
   6
   7 /*
   8  * prototype from config.h
   9  */
  10 char *etcpath(char *) NONNULL(1);
  11
  12 /*
  13  * prototypes from the nmh subroutine library
  14  */
  15
  16 struct msgs_array;
  17
  18 int client(char *, char *, char *, int, int);
  19 void closefds(int);
  20 char *concat (const char *, ...) ENDNULL;
  21 char **copyip (char **, char **, int);
  22 int decode_rfc2047 (char *, char *, size_t);
  23
  24 /*
  25  * Decode two characters into their quoted-printable representation.
  26  *
  27  * Arguments are:
  28  *
  29  * byte1        - First character of Q-P representation
  30  * byte2        - Second character of Q-P representation
  31  *
  32  * Returns the decoded value, -1 if the conversion failed.
  33  */
  34 int decode_qp(unsigned char byte1, unsigned char byte2) CONST;
  35
  36 /*
  37  * Encode a message header using RFC 2047 encoding.  If the message contains
  38  * no non-ASCII characters, then leave the header as-is.
  39  *
  40  * Arguments include:
  41  *
  42  * name         - Message header name
  43  * value        - Message header content; must point to allocated memory
  44  *                (may be changed if encoding is necessary)
  45  * encoding     - Encoding type.  May be one of CE_UNKNOWN (function chooses
  46  *                the encoding), CE_BASE64 or CE_QUOTED
  47  * charset      - Charset used for encoding.  If NULL, obtain from system
  48  *                locale.
  49  *
  50  * Returns 0 on success, any other value on failure.
  51  */
  52
  53 int encode_rfc2047(const char *name, char **value, int encoding,
  54                    const char *charset);
  55
  56 /*
  57  * Print null-terminated PROMPT to and flush standard output.  Read answers from
  58  * standard input until one matches an entry in SWITCHES.  When one matches,
  59  * return its swret field.  Return 0 on EOF.
  60  */
  61 int read_switch(const char *PROMPT, const struct swit *SWITCHES);
  62
  63 /*
  64  * If standard input is not a tty, return 1 without printing anything.  Else,
  65  * print null-terminated PROMPT to and flush standard output.  Read answers from
  66  * standard input until one is "yes" or "no", returning 1 for "yes" and 0 for
  67  * "no".  Also return 0 on EOF.
  68  */
  69 int read_yes_or_no_if_tty(const char *PROMPT);
  70
  71 /*
  72  * Print null-terminated PROMPT to and flush standard output.  Read multi-word
  73  * answers from standard input until a first word matches an entry in SWITCHES.
  74  * When one matches, return a pointer to an array of pointers to the words.
  75  * Return NULL on EOF, interrupt, or other error.
  76  */
  77 char **read_switch_multiword(const char *PROMPT, const struct swit *SWITCHES);
  78
  79 /*
  80  * Same as read_switch_multiword but using readline(3) for input.
  81  */
  82 #ifdef READLINE_SUPPORT
  83 char **read_switch_multiword_via_readline (char *, struct swit *);
  84 #endif /* READLINE_SUPPORT */
  85
  86 char **getarguments (char *, int, char **, int);
  87
  88 m_getfld_state_t m_getfld_state_init(FILE *iob);
  89 void m_getfld_state_reset (m_getfld_state_t *);
  90 void m_getfld_state_destroy (m_getfld_state_t *);
  91 void m_getfld_track_filepos (m_getfld_state_t *, FILE *);
  92 void m_getfld_track_filepos2(m_getfld_state_t *);
  93 int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);
  94 int m_getfld2(m_getfld_state_t *, char[NAMESZ], char *, int *);
  95 int m_gmprot (void) PURE;
  96 char *m_name (int);
  97
  98 void m_unknown(m_getfld_state_t *, FILE *);
  99 void m_unknown2(m_getfld_state_t *);
 100
 101 char *nmh_getpass(const char *);
 102 int pidwait (pid_t, int);
 103 char *r1bindex(char *, int) PURE;
 104 int refile (char **, char *);
 105
 106 /*
 107  * Read our credentials file and (optionally) ask the user for anything
 108  * missing.
 109  *
 110  * Arguments:
 111  *
 112  * host         - Hostname (to scan credentials file)
 113  * aname        - Pointer to filled-in username
 114  * apass        - Pointer to filled-in password
 115  * flags        - One or more of RUSERPASS_NO_PROMPT_USER,
 116  *                RUSERPASS_NO_PROMPT_PASSWORD
 117  */
 118 void ruserpass (const char *host, char **aname, char **apass, int flags);
 119 #define RUSERPASS_NO_PROMPT_USER        0x01
 120 #define RUSERPASS_NO_PROMPT_PASSWORD    0x02
 121
 122 int remdir (char *);
 123 void scan_detect_mbox_style (FILE *);
 124 void scan_finished(void);
 125
 126 /*
 127  * Read the sequence files for the folder referenced in the given
 128  * struct msgs and populate the sequence entries in the struct msgs.
 129  *
 130  * Arguments:
 131  *
 132  * mp           - Folder structure to add sequence entries to
 133  * lockflag     - If true, obtain a write lock on the sequence file.
 134  *                Additionally, the sequence file will remain open
 135  *                and a pointer to the filehandle will be stored in
 136  *                folder structure, where it will later be used by
 137  *                seq_save().
 138  *
 139  * Return values:
 140  *     OK       - successfully read the sequence files, or they don't exist
 141  *     NOTOK    - failed to lock sequence file
 142  */
 143 int seq_read (struct msgs * mp, int lockflag);
 144 void seq_save (struct msgs *);
 145 void seq_setcur (struct msgs *, int);
 146 void seq_setprev (struct msgs *);
 147 void seq_setunseen (struct msgs *, int);
 148 int showfile (char **, char *);
 149 int smatch(const char *, const struct swit *) PURE;
 150
 151 /*
 152  * Convert a set of bit flags to printable format.
 153  *
 154  * Arguments:
 155  *
 156  * buffer       - Buffer to output string to.
 157  * size         - Size of buffer in bytes.  Buffer is always NUL terminated.
 158  * flags        - Binary flags to output
 159  * bitfield     - Textual representation of bits to output.  This string
 160  *                is in the following format:
 161  *
 162  *      Option byte 0x01 STRING1 0x02 STRING2 ....
 163  *
 164  * The first byte is an option byte to snprintb().  Currently the only option
 165  * supported is 0x08, which indicates that the flags should be output in
 166  * octal format; if the option byte is any other value, the flags will be
 167  * output in hexadecimal.
 168  *
 169  * After the option bytes are series of text strings, prefixed by the number
 170  * of the bit they correspond to.  For example, the bitfield string:
 171  *
 172  *      "\020\01FLAG1\02FLAG2\03FLAG3\04FLAG4"
 173  *
 174  * will output the following string if "flags" is set to 0x09:
 175  *
 176  *      0x2<FLAG1,FLAG4>
 177  *
 178  * You don't have to use octal in the bitfield string, that's just the
 179  * convention currently used by the nmh code.  The order of flags in the
 180  * bitfield string is not significant, but again, general convention is
 181  * from least significant bit to most significant.
 182  */
 183 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
 184 int ssequal (const char *, const char *) PURE;
 185 int stringdex (char *, char *) PURE;
 186
 187 /*
 188  * prototypes for some routines in uip
 189  */
 190 int annotate (char *, char *, char *, bool, bool, int, bool);
 191 void annolist(char *, char *, char *, int);
 192 void annopreserve(int);
 193 int mhl(int, char **);
 194 int mhlsbr(int, char **, FILE *(*)(char *));
 195 int distout (char *, char *, char *);
 196 int sendsbr (char **, int, char *, char *, struct stat *, int, const char *);
 197 int what_now (char *, int, int, char *, char *,
 198         int, struct msgs *, char *, int, char *, int);
 199 int WhatNow(int, char **) NORETURN;
 200
 201 /*
 202  * credentials management
 203  */
 204 void init_credentials_file(void);
 205
 206 /*
 207  * Allocate and return a credentials structure.  The credentials structure
 208  * is now opaque; you need to use accessors to get inside of it.  The
 209  * accessors will only prompt the user for missing fields if they are
 210  * needed.
 211  *
 212  * Arguments:
 213  *
 214  * host - Hostname we're connecting to (used to search credentials file)
 215  * user - Username we are logging in as; can be NULL.
 216  *
 217  * Returns NULL on error, otherwise an allocated nmh_creds structure.
 218  */
 219 nmh_creds_t nmh_get_credentials (const char *host, const char *user);
 220
 221 /*
 222  * Retrieve the user from a nmh_creds structure.  May prompt the user
 223  * if one is not defined.
 224  *
 225  * Arguments:
 226  *
 227  * creds        - Structure from previous nmh_get_credentials() call
 228  *
 229  * Returns NULL on error, otherwise a NUL-terminated string containing
 230  * the username.  Points to allocated memory in the credentials structure
 231  * that is free()d by nmh_free_credentials().
 232  */
 233 const char *nmh_cred_get_user(nmh_creds_t creds);
 234
 235 /*
 236  * Retrieve the password from an nmh_creds structure.  Otherwise identical
 237  * to nmh_cred_get_user().
 238  */
 239 const char *nmh_cred_get_password(nmh_creds_t creds);
 240
 241 /*
 242  * Free an allocated nmh_creds structure.
 243  */
 244 void nmh_credentials_free(nmh_creds_t creds);