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