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 *);
  11
  12 /*
  13  * prototypes from the nmh subroutine library
  14  */
  15
  16 struct msgs_array;
  17
  18 void add_profile_entry (const char *, const char *);
  19 void inform(char *fmt, ...);
  20 void adios (const char *, const char *, ...) NORETURN;
  21 void admonish (char *, char *, ...);
  22 void advertise (const char *, char *, const char *, va_list);
  23 void advise (const char *, const char *, ...);
  24 char **argsplit (char *, char **, int *);
  25 void argsplit_msgarg (struct msgs_array *, char *, char **);
  26 void argsplit_insert (struct msgs_array *, char *, char **);
  27 void arglist_free (char *, char **);
  28 void ambigsw (const char *, const struct swit *);
  29 int atooi(char *);
  30 char **brkstring (char *, char *, char *);
  31
  32 /*
  33  * Check to see if we can display a given character set natively.
  34  * Arguments include:
  35  *
  36  * str  - Name of character set to check against
  37  * len  - Length of "str"
  38  *
  39  * Returns 1 if the specified character set can be displayed natively,
  40  * 0 otherwise.
  41  */
  42
  43 int check_charset (char *, int);
  44 int client(char *, char *, char *, int, int);
  45 void closefds(int);
  46 char *concat (const char *, ...);
  47 int context_del (char *);
  48 char *context_find (const char *);
  49 char *context_find_by_type (const char *, const char *, const char *);
  50 int context_find_prefix(const char *);
  51 int context_foil (char *);
  52 void context_read (void);
  53 void context_replace (char *, char *);
  54 void context_save (void);
  55 char **copyip (char **, char **, int);
  56 void cpydata (int, int, const char *, const char *);
  57 void cpydgst (int, int, char *, char *);
  58 char *cpytrim (const char *);
  59 char *rtrim (char *);
  60 int decode_rfc2047 (char *, char *, size_t);
  61 void discard (FILE *);
  62 char *upcase (const char *);
  63
  64 /*
  65  * Decode two characters into their quoted-printable representation.
  66  *
  67  * Arguments are:
  68  *
  69  * byte1        - First character of Q-P representation
  70  * byte2        - Second character of Q-P representation
  71  *
  72  * Returns the decoded value, -1 if the conversion failed.
  73  */
  74 int decode_qp(unsigned char byte1, unsigned char byte2);
  75
  76 int default_done (int);
  77
  78 /*
  79  * Encode a message header using RFC 2047 encoding.  If the message contains
  80  * no non-ASCII characters, then leave the header as-is.
  81  *
  82  * Arguments include:
  83  *
  84  * name         - Message header name
  85  * value        - Message header content; must point to allocated memory
  86  *                (may be changed if encoding is necessary)
  87  * encoding     - Encoding type.  May be one of CE_UNKNOWN (function chooses
  88  *                the encoding), CE_BASE64 or CE_QUOTED
  89  * charset      - Charset used for encoding.  If NULL, obtain from system
  90  *                locale.
  91  *
  92  * Returns 0 on success, any other value on failure.
  93  */
  94
  95 int encode_rfc2047(const char *name, char **value, int encoding,
  96                    const char *charset);
  97
  98 void escape_display_name (char *, size_t);
  99 void escape_local_part (char *, size_t);
 100 int ext_hook(char *, char *, char *);
 101 int fdcompare (int, int);
 102 int folder_addmsg (struct msgs **, char *, int, int, int, int, char *);
 103 int folder_delmsgs (struct msgs *, int, int);
 104 void folder_free (struct msgs *);
 105 int folder_pack (struct msgs **, int);
 106
 107 /*
 108  * Read a MH folder structure and return an allocated "struct msgs"
 109  * corresponding to the contents of the folder.
 110  *
 111  * Arguments include:
 112  *
 113  * name         - Name of folder
 114  * lockflag     - If true, write-lock (and keep open) metadata files.
 115  *                See comments for seq_read() for more information.
 116  */
 117 struct msgs *folder_read (char *name, int lockflag);
 118
 119 struct msgs *folder_realloc (struct msgs *, int, int);
 120
 121 /*
 122  * Flush standard output, read a line from standard input into a static buffer,
 123  * zero out the newline, and return a pointer to the buffer.
 124  * On error, return NULL.
 125  */
 126 const char *read_line(void);
 127
 128 /*
 129  * Print null-terminated PROMPT to and flush standard output.  Read answers from
 130  * standard input until one matches an entry in SWITCHES.  When one matches,
 131  * return its swret field.  Return 0 on EOF.
 132  */
 133 int read_switch(const char *PROMPT, const struct swit *SWITCHES);
 134
 135 /*
 136  * If standard input is not a tty, return 1 without printing anything.  Else,
 137  * print null-terminated PROMPT to and flush standard output.  Read answers from
 138  * standard input until one is "yes" or "no", returning 1 for "yes" and 0 for
 139  * "no".  Also return 0 on EOF.
 140  */
 141 int read_yes_or_no_if_tty(const char *PROMPT);
 142
 143 /*
 144  * Print null-terminated PROMPT to and flush standard output.  Read multi-word
 145  * answers from standard input until a first word matches an entry in SWITCHES.
 146  * When one matches, return a pointer to an array of pointers to the words.
 147  * Return NULL on EOF, interrupt, or other error.
 148  */
 149 char **read_switch_multiword(const char *PROMPT, const struct swit *SWITCHES);
 150
 151 /*
 152  * Same as read_switch_multiword but using readline(3) for input.
 153  */
 154 #ifdef READLINE_SUPPORT
 155 char **read_switch_multiword_via_readline (char *, struct swit *);
 156 #endif /* READLINE_SUPPORT */
 157
 158 char **getarguments (char *, int, char **, int);
 159
 160 /*
 161  * Returns the MIME character set indicated by the current locale setting.
 162  * Should be used by routines that want to convert to/from the local
 163  * character set, or if you want to check to see if you can display content
 164  * in the local character set.
 165  */
 166 char *get_charset(void);
 167
 168 /* Return malloc'd copy of str, or of "" if NULL, exit on failure. */
 169 char *getcpy(const char *str);
 170
 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  * initialising 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 pidwait (pid_t, int);
 314 int pidstatus (int, FILE *, char *);
 315 char *pluspath(char *);
 316 void print_help (char *, struct swit *, int);
 317 void print_intro (FILE *, 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
 326 /*
 327  * Read our credentials file and (optionally) ask the user for anything
 328  * missing.
 329  *
 330  * Arguments:
 331  *
 332  * host         - Hostname (to scan credentials file)
 333  * aname        - Pointer to filled-in username
 334  * apass        - Pointer to filled-in password
 335  * flags        - One or more of RUSERPASS_NO_PROMPT_USER,
 336  *                RUSERPASS_NO_PROMPT_PASSWORD
 337  */
 338 void ruserpass (const char *host, char **aname, char **apass, int flags);
 339 #define RUSERPASS_NO_PROMPT_USER        0x01
 340 #define RUSERPASS_NO_PROMPT_PASSWORD    0x02
 341
 342 int remdir (char *);
 343 void scan_detect_mbox_style (FILE *);
 344 void scan_finished ();
 345 void scan_reset_m_getfld_state ();
 346 int seq_addmsg (struct msgs *, char *, int, int, int);
 347 int seq_addsel (struct msgs *, char *, int, int);
 348 char *seq_bits (struct msgs *);
 349 int seq_delmsg (struct msgs *, char *, int);
 350 int seq_delsel (struct msgs *, char *, int, int);
 351 int seq_getnum (struct msgs *, char *);
 352 char *seq_list (struct msgs *, char *);
 353 int seq_nameok (char *);
 354 void seq_print (struct msgs *, char *);
 355 void seq_printall (struct msgs *);
 356
 357 /*
 358  * Read the sequence files for the folder referenced in the given
 359  * struct msgs and populate the sequence entries in the struct msgs.
 360  *
 361  * Arguments:
 362  *
 363  * mp           - Folder structure to add sequence entries to
 364  * lockflag     - If true, obtain a write lock on the sequence file.
 365  *                Additionally, the sequence file will remain open
 366  *                and a pointer to the filehandle will be stored in
 367  *                folder structure, where it will later be used by
 368  *                seq_save().
 369  *
 370  * Return values:
 371  *     OK       - successfully read the sequence files, or they don't exist
 372  *     NOTOK    - failed to lock sequence file
 373  */
 374 int seq_read (struct msgs * mp, int lockflag);
 375 void seq_save (struct msgs *);
 376 void seq_setcur (struct msgs *, int);
 377 void seq_setprev (struct msgs *);
 378 void seq_setunseen (struct msgs *, int);
 379 int showfile (char **, char *);
 380 int smatch(const char *, const struct swit *);
 381
 382 /*
 383  * Convert a set of bit flags to printable format.
 384  *
 385  * Arguments:
 386  *
 387  * buffer       - Buffer to output string to.
 388  * size         - Size of buffer in bytes.  Buffer is always NUL terminated.
 389  * flags        - Binary flags to output
 390  * bitfield     - Textual representation of bits to output.  This string
 391  *                is in the following format:
 392  *
 393  *      Option byte 0x01 STRING1 0x02 STRING2 ....
 394  *
 395  * The first byte is an option byte to snprintb().  Currently the only option
 396  * supported is 0x08, which indicates that the flags should be output in
 397  * octal format; if the option byte is any other value, the flags will be
 398  * output in hexadecimal.
 399  *
 400  * After the option bytes are series of text strings, prefixed by the number
 401  * of the bit they correspond to.  For example, the bitfield string:
 402  *
 403  *      "\020\01FLAG1\02FLAG2\03FLAG3\04FLAG4"
 404  *
 405  * will output the following string if "flags" is set to 0x09:
 406  *
 407  *      0x2<FLAG1,FLAG4>
 408  *
 409  * You don't have to use octal in the bitfield string, that's just the
 410  * convention currently used by the nmh code.  The order of flags in the
 411  * bitfield string is not significant, but again, general convention is
 412  * from least significant bit to most significant.
 413  */
 414 char *snprintb (char *buffer, size_t size, unsigned flags, char *bitfield);
 415 int ssequal (const char *, const char *);
 416 int stringdex (char *, char *);
 417 char *trimcpy (char *);
 418 int unputenv (char *);
 419
 420 /*
 421  * Remove quotes and quoted-pair sequences from RFC-5322 atoms.
 422  *
 423  * Currently the actual algorithm is simpler than it technically should
 424  * be: any quotes are simply eaten, unless they're preceded by the escape
 425  * character (\).  This seems to be sufficient for our needs for now.
 426  *
 427  * Arguments:
 428  *
 429  * input        - The input string
 430  * output       - The output string; is assumed to have at least as much
 431  *                room as the input string.  At worst the output string will
 432  *                be the same size as the input string; it might be smaller.
 433  *
 434  */
 435 void unquote_string(const char *input, char *output);
 436 int uprf (const char *, const char *);
 437 int vfgets (FILE *, char **);
 438
 439 /*
 440  * Output the local character set name, but make sure it is suitable for
 441  * 8-bit characters.
 442  */
 443 char *write_charset_8bit (void);
 444
 445
 446 /*
 447  * some prototypes for address parsing system
 448  * (others are in addrsbr.h)
 449  */
 450 char *LocalName(int);
 451 char *SystemName(void);
 452
 453 /*
 454  * prototypes for some routines in uip
 455  */
 456 int annotate (char *, char *, char *, int, int, int, int);
 457 void annolist(char *, char *, char *, int);
 458 void annopreserve(int);
 459 void m_pclose(void);
 460 int make_intermediates(char *);
 461 int mhl(int, char **);
 462 int mhlsbr(int, char **, FILE *(*)(char *));
 463 int distout (char *, char *, char *);
 464 void replout (FILE *, char *, char *, struct msgs *, int,
 465         int, char *, char *, char *, int);
 466 int sc_length(void);
 467 int sc_width(void);
 468 int build_form (char *, char *, int *, char *, char *, char *, char *,
 469                 char *, char *);
 470 int sendsbr (char **, int, char *, char *, struct stat *, int, const char *);
 471 int SOprintf (char *, ...);
 472 int what_now (char *, int, int, char *, char *,
 473         int, struct msgs *, char *, int, char *, int);
 474 int WhatNow(int, char **);
 475
 476 /* Includes trailing NUL */
 477
 478 #define BASE64SIZE(x) ((((x + 2) / 3) * 4) + 1)
 479
 480 /*
 481  * Copy data from one file to another, converting to base64-encoding.
 482  *
 483  * Arguments include:
 484  *
 485  * in           - Input filehandle (unencoded data)
 486  * out          - Output filename (base64-encoded data)
 487  * crlf         - If set, output encoded CRLF for every LF on input.
 488  *
 489  * Returns OK on success, NOTOK otherwise.
 490  */
 491 int writeBase64aux(FILE *in, FILE *out, int crlf);
 492
 493 int writeBase64 (const unsigned char *, size_t, unsigned char *);
 494 int writeBase64raw (const unsigned char *, size_t, unsigned char *);
 495
 496 /*
 497  * encoded      - the string to be decoded
 498  * decoded      - the decoded bytes
 499  * len          - number of decoded bytes
 500  * skip-crs     - non-zero for text content, and for which CR's should be
 501  *                skipped
 502  * digest       - for an MD5 digest, it can be null
 503  */
 504 int decodeBase64 (const char *encoded, unsigned char **decoded, size_t *len,
 505                   int skip_crs, unsigned char *digest);
 506
 507 void hexify (const unsigned char *, size_t, char **);
 508
 509 /*
 510  * credentials management
 511  */
 512 void init_credentials_file ();
 513
 514 /*
 515  * Allocate and return a credentials structure.  The credentials structure
 516  * is now opaque; you need to use accessors to get inside of it.  The
 517  * accessors will only prompt the user for missing fields if they are
 518  * needed.
 519  *
 520  * Arguments:
 521  *
 522  * host - Hostname we're connecting to (used to search credentials file)
 523  * user - Username we are logging in as; can be NULL.
 524  *
 525  * Returns NULL on error, otherwise an allocated nmh_creds structure.
 526  */
 527 nmh_creds_t nmh_get_credentials (const char *host, const char *user);
 528
 529 /*
 530  * Retrieve the user from a nmh_creds structure.  May prompt the user
 531  * if one is not defined.
 532  *
 533  * Arguments:
 534  *
 535  * creds        - Structure from previous nmh_get_credentials() call
 536  *
 537  * Returns NULL on error, otherwise a NUL-terminated string containing
 538  * the username.  Points to allocated memory in the credentials structure
 539  * that is free()d by nmh_free_credentials().
 540  */
 541 const char *nmh_cred_get_user(nmh_creds_t creds);
 542
 543 /*
 544  * Retrieve the password from an nmh_creds structure.  Otherwise identical
 545  * to nmh_cred_get_user().
 546  */
 547 const char *nmh_cred_get_password(nmh_creds_t creds);
 548
 549 /*
 550  * Free an allocated nmh_creds structure.
 551  */
 552 void nmh_credentials_free(nmh_creds_t creds);
 553
 554 /*
 555  * program initialization
 556  *
 557  * argv0        - argv[0], presumably the program name
 558  * read_context - 0: don't read context
 559  *              - 1: read context, check nmh version, and issue warning message
 560  *                   if non-existent or old
 561  *              - 2: read context, don't check nmh version
 562  */
 563 int nmh_init(const char *argv0, int read_context);
 564
 565 /*
 566  * temporary file management
 567  */
 568 int m_unlink(const char *);
 569 void unregister_for_removal(int remove_files);