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

   1
   2 /*
   3  * prototypes.h -- various prototypes
   4  *
   5  * If you modify functions here, please document their current behavior
   6  * as much as practical.
   7  */
   8
   9 /*
  10  * prototype from config.h
  11  */
  12 char *etcpath(char *);
  13
  14 /*
  15  * prototypes from the nmh subroutine library
  16  */
  17
  18 struct msgs_array;
  19
  20 void add_profile_entry (const char *, const char *);
  21 void adios (const char *, const char *, ...) NORETURN;
  22 void admonish (char *, char *, ...);
  23 void advertise (const char *, char *, const char *, va_list);
  24 void advise (const char *, const char *, ...);
  25 char **argsplit (char *, char **, int *);
  26 void argsplit_msgarg (struct msgs_array *, char *, char **);
  27 void argsplit_insert (struct msgs_array *, char *, char **);
  28 void arglist_free (char *, char **);
  29 void ambigsw (const char *, const struct swit *);
  30 int atooi(char *);
  31 char **brkstring (char *, char *, char *);
  32
  33 /*
  34  * Check to see if we can display a given character set natively.
  35  * Arguments include:
  36  *
  37  * str  - Name of character set to check against
  38  * len  - Length of "str"
  39  *
  40  * Returns 1 if the specified character set can be displayed natively,
  41  * 0 otherwise.
  42  */
  43
  44 int check_charset (char *, int);
  45 int client(char *, char *, char *, int, int);
  46 void closefds(int);
  47 char *concat (const char *, ...);
  48 int context_del (char *);
  49 char *context_find (const char *);
  50 char *context_find_by_type (const char *, const char *, const char *);
  51 int context_find_prefix(const char *);
  52 int context_foil (char *);
  53 void context_read (void);
  54 void context_replace (char *, char *);
  55 void context_save (void);
  56 char *copy (const char *, char *);
  57 char **copyip (char **, char **, int);
  58 void cpydata (int, int, const char *, const char *);
  59 void cpydgst (int, int, char *, char *);
  60 char *cpytrim (const char *);
  61 char *rtrim (char *);
  62 int decode_rfc2047 (char *, char *, size_t);
  63 void discard (FILE *);
  64 char *upcase (const char *);
  65
  66 /*
  67  * Decode two characters into their quoted-printable representation.
  68  *
  69  * Arguments are:
  70  *
  71  * byte1        - First character of Q-P representation
  72  * byte2        - Second character of Q-P representation
  73  *
  74  * Returns the decoded value, -1 if the conversion failed.
  75  */
  76 int decode_qp(unsigned char byte1, unsigned char byte2);
  77
  78 int default_done (int);
  79
  80 /*
  81  * Encode a message header using RFC 2047 encoding.  If the message contains
  82  * no non-ASCII characters, then leave the header as-is.
  83  *
  84  * Arguments include:
  85  *
  86  * name         - Message header name
  87  * value        - Message header content; must point to allocated memory
  88  *                (may be changed if encoding is necessary)
  89  * encoding     - Encoding type.  May be one of CE_UNKNOWN (function chooses
  90  *                the encoding), CE_BASE64 or CE_QUOTED
  91  * charset      - Charset used for encoding.  If NULL, obtain from system
  92  *                locale.
  93  *
  94  * Returns 0 on success, any other value on failure.
  95  */
  96
  97 int encode_rfc2047(const char *name, char **value, int encoding,
  98                    const char *charset);
  99
 100 void escape_display_name (char *, size_t);
 101 void escape_local_part (char *, size_t);
 102 int ext_hook(char *, char *, char *);
 103 int fdcompare (int, int);
 104 int folder_addmsg (struct msgs **, char *, int, int, int, int, char *);
 105 int folder_delmsgs (struct msgs *, int, int);
 106 void folder_free (struct msgs *);
 107 int folder_pack (struct msgs **, int);
 108
 109 /*
 110  * Read a MH folder structure and return an allocated "struct msgs"
 111  * corresponding to the contents of the folder.
 112  *
 113  * Arguments include:
 114  *
 115  * name         - Name of folder
 116  * lockflag     - If true, write-lock (and keep open) metadata files.
 117  *                See comments for seq_read() for more information.
 118  */
 119 struct msgs *folder_read (char *name, int lockflag);
 120
 121 struct msgs *folder_realloc (struct msgs *, int, int);
 122
 123 /*
 124  * Flush standard output, read a line from standard input into a static buffer,
 125  * zero out the newline, and return a pointer to the buffer.
 126  * On error, return NULL.
 127  */
 128 const char *read_line(void);
 129
 130 /*
 131  * Print null-terminated PROMPT to and flush standard output.  Read answers from
 132  * standard input until one matches an entry in SWITCHES.  When one matches,
 133  * return its swret field.  Return 0 on EOF.
 134  */
 135 int read_switch(const char *PROMPT, const struct swit *SWITCHES);
 136
 137 /*
 138  * If standard input is not a tty, return 1 without printing anything.  Else,
 139  * print null-terminated PROMPT to and flush standard output.  Read answers from
 140  * standard input until one is "yes" or "no", returning 1 for "yes" and 0 for
 141  * "no".  Also return 0 on EOF.
 142  */
 143 int read_yes_or_no_if_tty(const char *PROMPT);
 144
 145 /*
 146  * Print null-terminated PROMPT to and flush standard output.  Read multi-word
 147  * answers from standard input until a first word matches an entry in SWITCHES.
 148  * When one matches, return a pointer to an array of pointers to the words.
 149  * Return NULL on EOF, interrupt, or other error.
 150  */
 151 char **read_switch_multiword(const char *PROMPT, const struct swit *SWITCHES);
 152
 153 /*
 154  * Same as read_switch_multiword but using readline(3) for input.
 155  */
 156 #ifdef READLINE_SUPPORT
 157 char **read_switch_multiword_via_readline (char *, struct swit *);
 158 #endif /* READLINE_SUPPORT */
 159
 160 char **getarguments (char *, int, char **, int);
 161
 162 /*
 163  * Returns the MIME character set indicated by the current locale setting.
 164  * Should be used by routines that want to convert to/from the local
 165  * character set, or if you want to check to see if you can display content
 166  * in the local character set.
 167  */
 168 char *get_charset(void);
 169
 170 char *getcpy (const char *);
 171 char *get_default_editor(void);
 172 char *getfolder(int);
 173
 174 /*
 175  * Get a string from the terminfo database for the current terminal.
 176  *
 177  * Retrieve the specified terminfo capability and return a string that
 178  * can be output to the terminal.  The string returned has already been
 179  * processed by tputs(), so it is safe to output directly.  The return
 180  * value of this function is valid until the next call.
 181  *
 182  * Arguments:
 183  *
 184  * capability   - The name of the terminfo capability (see terminfo(5)).
 185  *
 186  * Returns a tputs-processed string, or NULL if terminal initialization failed
 187  * or the capability wasn't found.
 188  */
 189 char *get_term_stringcap(char *capability);
 190
 191 /*
 192  * Get a parameterized string from the terminfo database for the current
 193  * terminal.
 194  *
 195  * We don't yet have a standardized tparm() that will take a stdarg
 196  * argument.  Right now we don't want many parameters, so we only
 197  * take two.  Everything gets passed to tparm() as-is.  If we need
 198  * a capability with more arguments, we'll just add more later.
 199  *
 200  * Arguments:
 201  *
 202  * capability   - The name of the terminfo capability (see terminfo(5)).
 203  * arg1..argN   - Arguments 1-N.
 204  *
 205  * Returns a tparm and tputs-processed string, or NULL if there was a problem
 206  * initializating the terminal or retrieving the capability.
 207  */
 208 char *get_term_stringparm(char *capability, long arg1, long arg2);
 209
 210 /*
 211  * Get a number from the terminfo database for the current terminal.
 212  *
 213  * Retrieve the specified terminfo capability and return the numeric
 214  * value of that capability from the terminfo database.
 215  *
 216  * Arguments:
 217  *
 218  * capability   - The name of the terminfo capability (see terminfo(5)).
 219  *
 220  * Returns the output of tigetnum() for that capability, or -1 if it was
 221  * unable to initialize the terminfo database.
 222  */
 223 int get_term_numcap(char *capability);
 224
 225 /*
 226  * Lock open/close routines.
 227  *
 228  * The lk[f]opendata() functions are designed to open "data" files (anything
 229  * not a mail spool file) using the locking mechanism configured for data
 230  * files.  The lk[f]openspool() functions are for opening the mail spool
 231  * file, which will use the locking algorithm configured for the mail
 232  * spool.
 233  *
 234  * Files opened for reading are locked with a read lock (if possible by
 235  * the underlying lock mechanism), files opened for writing are locked
 236  * using an exclusive lock.  The int * argument is used to indicate failure
 237  * to acquire a lock.
 238  */
 239 int lkclosedata(int, const char *);
 240 int lkclosespool(int, const char *);
 241 int lkfclosedata(FILE *, const char *);
 242 int lkfclosespool(FILE *, const char *);
 243 FILE *lkfopendata(const char *, const char *, int *);
 244 int lkopendata(const char *, int, mode_t, int *);
 245 FILE *lkfopenspool(const char *, const char *);
 246 int lkopenspool(const char *, int, mode_t, int *);
 247 int m_atoi (char *);
 248 char *m_backup (const char *);
 249 int m_convert (struct msgs *, char *);
 250 char *m_draft (char *, char *, int, int *);
 251 void m_getfld_state_reset (m_getfld_state_t *);
 252 void m_getfld_state_destroy (m_getfld_state_t *);
 253 void m_getfld_track_filepos (m_getfld_state_t *, FILE *);
 254 int m_getfld (m_getfld_state_t *, char[NAMESZ], char *, int *, FILE *);
 255 int m_gmprot (void);
 256 char *m_maildir (char *);
 257 char *m_mailpath (char *);
 258 char *m_name (int);
 259 int m_putenv (char *, char *);
 260 int m_rand (unsigned char *, size_t);
 261 char *m_mktemp(const char *, int *, FILE **);
 262 char *m_mktemp2(const char *, const char *, int *, FILE **);
 263 char *m_mktemps(const char *pfx, const char *suffix, int *, FILE **);
 264 char *get_temp_dir();
 265
 266 /*
 267  * Create a subprocess and redirect our standard output to it.
 268  *
 269  * Arguments are:
 270  *
 271  * name         - Name of process to create
 272  * savestdout   - If true, will save the current stdout file descriptor and
 273  *                m_pclose() will close it at the appropriate time.
 274  */
 275 void m_popen(char *name, int savestdout);
 276
 277 /*
 278  * Wait for the last process opened by m_popen().
 279  */
 280 void m_pclose(void);
 281
 282 void m_unknown(m_getfld_state_t *, FILE *);
 283 int makedir (const char *);
 284 char *message_id (time_t, int);
 285
 286 /*
 287  * Return a MIME content-type string for the specified file.
 288  *
 289  * If the system supports it, will use the "file" command to determine
 290  * the appropriate content-type.  Otherwise it will try to determine the
 291  * content-type from the suffix.  If that fails, the file will be scanned
 292  * and either assigned a MIME type of text/plain or application/octet-stream
 293  * depending if binary content is present.
 294  *
 295  * Arguments:
 296  *
 297  * filename     - The name of the file to determine the MIME type of.
 298  *
 299  * Returns a pointer to a content-type string (which may include MIME
 300  * parameters, such as charset).  Returns a NULL if it cannot determine
 301  * the MIME type of the file.  Returns allocated storage that must be
 302  * free'd.
 303  */
 304 char *mime_type(const char *filename);
 305
 306 /*
 307  * Clear the screen, using the appropriate entry from the terminfo database
 308  */
 309 void nmh_clear_screen(void);
 310 char *nmh_getpass(const char *);
 311 char *new_fs (char *, char *, char *);
 312 char *path(char *, int);
 313 int peekc(FILE *ib);
 314 int pidwait (pid_t, int);
 315 int pidstatus (int, FILE *, char *);
 316 char *pluspath(char *);
 317 void print_help (char *, struct swit *, int);
 318 void print_sw (const char *, const struct swit *, char *, FILE *);
 319 void print_version (char *);
 320 void push (void);
 321 char *pwd (void);
 322 char *r1bindex(char *, int);
 323 void readconfig (struct node **, FILE *, const char *, int);
 324 int refile (char **, char *);
 325 void ruserpass (char *, char **, char **);
 326 int remdir (char *);
 327 void scan_detect_mbox_style (FILE *);
 328 void scan_finished ();
 329 void scan_reset_m_getfld_state ();
 330 int seq_addmsg (struct msgs *, char *, int, int, int);
 331 int seq_addsel (struct msgs *, char *, int, int);
 332 char *seq_bits (struct msgs *);
 333 int seq_delmsg (struct msgs *, char *, int);
 334 int seq_delsel (struct msgs *, char *, int, int);
 335 int seq_getnum (struct msgs *, char *);
 336 char *seq_list (struct msgs *, char *);
 337 int seq_nameok (char *);
 338 void seq_print (struct msgs *, char *);
 339 void seq_printall (struct msgs *);
 340
 341 /*
 342  * Read the sequence files for the folder referenced in the given
 343  * struct msgs and populate the sequence entries in the struct msgs.
 344  *
 345  * Arguments:
 346  *
 347  * mp           - Folder structure to add sequence entries to
 348  * lockflag     - If true, obtain a write lock on the sequence file.
 349  *                Additionally, the sequence file will remain open
 350  *                and a pointer to the filehandle will be stored in
 351  *                folder structure, where it will later be used by
 352  *                seq_save().
 353  *
 354  * Return values:
 355  *     OK       - successfully read the sequence files, or they don't exist
 356  *     NOTOK    - failed to lock sequence file
 357  */
 358 int seq_read (struct msgs * mp, int lockflag);
 359 void seq_save (struct msgs *);
 360 void seq_setcur (struct msgs *, int);
 361 void seq_setprev (struct msgs *);
 362 void seq_setunseen (struct msgs *, int);
 363 int showfile (char **, char *);
 364 int smatch(const char *, const struct swit *);
 365
 366 /*
 367  * Convert a set of bit flags to printable format.
 368  *
 369  * Arguments:
 370  *
 371  * buffer       - Buffer to output string to.
 372  * size         - Size of buffer in bytes.  Buffer is always NUL terminated.
 373  * flags        - Binary flags to output
 374  * bitfield     - Textual representation of bits to output.  This string
 375  *                is in the following format:
 376  *
 377  *      Option byte 0x01 STRING1 0x02 STRING2 ....
 378  *
 379  * The first byte is an option byte to snprintb().  Currently the only option
 380  * supported is 0x08, which indicates that the flags should be output in
 381  * octal format; if the option byte is any other value, the flags will be
 382  * output in hexadecimal.
 383  *
 384  * After the option bytes are series of text strings, prefixed by the number
 385  * of the bit they correspond to.  For example, the bitfield string:
 386  *
 387  *      "\020\01FLAG1\02FLAG2\03FLAG3\04FLAG4"
 388  *
 389  * will output the following string if "flags" is set to 0x09:
 390  *
 391  *      0x2<FLAG1,FLAG4>
 392  *
 393  * You don't have to use octal in the bitfield string, that's just the
 394  * convention currently used by the nmh code.  The order of flags in the
 395  * bitfield string is not significant, but again, general convention is
 396  * from least significant bit to most significant.
 397  */
 398 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
 399 int ssequal (const char *, const char *);
 400 int stringdex (char *, char *);
 401 char *trimcpy (char *);
 402 int unputenv (char *);
 403
 404 /*
 405  * Remove quotes and quoted-pair sequences from RFC-5322 atoms.
 406  *
 407  * Currently the actual algorithm is simpler than it technically should
 408  * be: any quotes are simply eaten, unless they're preceded by the escape
 409  * character (\).  This seems to be sufficient for our needs for now.
 410  *
 411  * Arguments:
 412  *
 413  * input        - The input string
 414  * output       - The output string; is assumed to have at least as much
 415  *                room as the input string.  At worst the output string will
 416  *                be the same size as the input string; it might be smaller.
 417  *
 418  */
 419 void unquote_string(const char *input, char *output);
 420 int uprf (const char *, const char *);
 421 int vfgets (FILE *, char **);
 422
 423 /*
 424  * Output the local character set name, but make sure it is suitable for
 425  * 8-bit characters.
 426  */
 427 char *write_charset_8bit (void);
 428
 429
 430 /*
 431  * some prototypes for address parsing system
 432  * (others are in addrsbr.h)
 433  */
 434 char *LocalName(int);
 435 char *SystemName(void);
 436
 437 /*
 438  * prototypes for some routines in uip
 439  */
 440 int annotate (char *, char *, char *, int, int, int, int);
 441 void annolist(char *, char *, char *, int);
 442 void annopreserve(int);
 443 void m_pclose(void);
 444 int make_intermediates(char *);
 445 int mhl(int, char **);
 446 int mhlsbr(int, char **, FILE *(*)(char *));
 447 int distout (char *, char *, char *);
 448 void replout (FILE *, char *, char *, struct msgs *, int,
 449         int, char *, char *, char *, int);
 450 int sc_length(void);
 451 int sc_width(void);
 452 int build_form (char *, char *, int *, char *, char *, char *, char *,
 453                 char *, char *);
 454 int sendsbr (char **, int, char *, char *, struct stat *, int, const char *);
 455 int SOprintf (char *, ...);
 456 int what_now (char *, int, int, char *, char *,
 457         int, struct msgs *, char *, int, char *, int);
 458 int WhatNow(int, char **);
 459
 460 /*
 461  * Copy data from one file to another, converting to base64-encoding.
 462  *
 463  * Arguments include:
 464  *
 465  * in           - Input filehandle (unencoded data)
 466  * out          - Output filename (base64-encoded data)
 467  * crlf         - If set, output encoded CRLF for every LF on input.
 468  *
 469  * Returns OK on success, NOTOK otherwise.
 470  */
 471 int writeBase64aux(FILE *in, FILE *out, int crlf);
 472
 473 int writeBase64 (unsigned char *, size_t, unsigned char *);
 474 int writeBase64raw (unsigned char *, size_t, unsigned char *);
 475
 476 /*
 477  * first argument:  the string to be decoded
 478  * second argument:  the decoded bytes
 479  * third argument:  number of decoded bytes
 480  * fourth argument:   non-zero for text content, and for which CR's should be skipped
 481  * fifth argument:  for an MD5 digest, it can be null
 482  */
 483 int decodeBase64 (const char *, const char **, size_t *, int, unsigned char *);
 484
 485 void hexify (const unsigned char *, size_t, char **);
 486
 487 /*
 488  * credentials management
 489  */
 490 void init_credentials_file ();
 491 int nmh_get_credentials (char *, char *, int, nmh_creds_t);
 492
 493 /*
 494  * temporary file management
 495  */
 496 int nmh_init(const char *argv0, int read_context);
 497 int m_unlink(const char *);
 498 void unregister_for_removal(int remove_files);