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