util.h 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  1. /** \file lib/util.h
  2. * \brief Header: various utilities
  3. */
  4. #ifndef MC_UTIL_H
  5. #define MC_UTIL_H
  6. #include <sys/types.h>
  7. #include <sys/stat.h>
  8. #include <inttypes.h> /* uintmax_t */
  9. #include <unistd.h>
  10. #include "lib/global.h" /* include <glib.h> */
  11. #include "lib/vfs/vfs.h"
  12. /*** typedefs(not structures) and defined constants **********************************************/
  13. #ifndef MAXSYMLINKS
  14. #define MAXSYMLINKS 32
  15. #endif
  16. #define MAX_SAVED_BOOKMARKS 10
  17. #define MC_PTR_FREE(ptr) do { g_free (ptr); (ptr) = NULL; } while (0)
  18. #define mc_return_if_error(mcerror) do { if (mcerror != NULL && *mcerror != NULL) return; } while (0)
  19. #define mc_return_val_if_error(mcerror, mcvalue) do { if (mcerror != NULL && *mcerror != NULL) return mcvalue; } while (0)
  20. #define whitespace(c) ((c) == ' ' || (c) == '\t')
  21. #define whiteness(c) (whitespace (c) || (c) == '\n')
  22. #define MC_PIPE_BUFSIZE BUF_8K
  23. #define MC_PIPE_STREAM_EOF 0
  24. #define MC_PIPE_STREAM_UNREAD -1
  25. #define MC_PIPE_ERROR_CREATE_PIPE -2
  26. #define MC_PIPE_ERROR_PARSE_COMMAND -3
  27. #define MC_PIPE_ERROR_CREATE_PIPE_STREAM -4
  28. #define MC_PIPE_ERROR_READ -5
  29. /*** enums ***************************************************************************************/
  30. /* Pathname canonicalization */
  31. typedef enum
  32. {
  33. CANON_PATH_JOINSLASHES = 1L << 0, /* Multiple '/'s are collapsed to a single '/'. */
  34. CANON_PATH_REMSLASHDOTS = 1L << 1, /* Leading './'s, '/'s and trailing '/.'s are removed. */
  35. CANON_PATH_REMDOUBLEDOTS = 1L << 3, /* Non-leading '../'s and trailing '..'s are handled by removing */
  36. CANON_PATH_GUARDUNC = 1L << 4, /* Detect and preserve UNC paths: //server/... */
  37. CANON_PATH_ALL = CANON_PATH_JOINSLASHES
  38. | CANON_PATH_REMSLASHDOTS | CANON_PATH_REMDOUBLEDOTS | CANON_PATH_GUARDUNC
  39. } CANON_PATH_FLAGS;
  40. enum compression_type
  41. {
  42. COMPRESSION_NONE,
  43. COMPRESSION_GZIP,
  44. COMPRESSION_BZIP,
  45. COMPRESSION_BZIP2,
  46. COMPRESSION_LZIP,
  47. COMPRESSION_LZ4,
  48. COMPRESSION_LZMA,
  49. COMPRESSION_XZ
  50. };
  51. /* stdout or stderr stream of child process */
  52. typedef struct
  53. {
  54. /* file descriptor */
  55. int fd;
  56. /* data read from fd */
  57. char buf[MC_PIPE_BUFSIZE];
  58. /* positive: length of data in buf as before read as after;
  59. * zero or negative before read: do not read drom fd;
  60. * MC_PIPE_STREAM_EOF after read: EOF of fd;
  61. * MC_PIPE_STREAM_UNREAD after read: there was not read from fd;
  62. * MC_PIPE_ERROR_READ after read: reading error from fd.
  63. */
  64. ssize_t len;
  65. /* whether buf is null-terminated or not */
  66. gboolean null_term;
  67. /* error code in case of len == MC_PIPE_ERROR_READ */
  68. int error;
  69. } mc_pipe_stream_t;
  70. /* Pipe descriptor for child process */
  71. typedef struct
  72. {
  73. /* PID of child process */
  74. GPid child_pid;
  75. /* stdout of child process */
  76. mc_pipe_stream_t out;
  77. /* stderr of child process */
  78. mc_pipe_stream_t err;
  79. } mc_pipe_t;
  80. /*** structures declarations (and typedefs of structures)*****************************************/
  81. /* keys are set only during sorting */
  82. typedef struct
  83. {
  84. /* File attributes */
  85. size_t fnamelen;
  86. char *fname;
  87. struct stat st;
  88. /* key used for comparing names */
  89. char *sort_key;
  90. /* key used for comparing extensions */
  91. char *second_sort_key;
  92. /* Flags */
  93. struct
  94. {
  95. unsigned int marked:1; /* File marked in pane window */
  96. unsigned int link_to_dir:1; /* If this is a link, does it point to directory? */
  97. unsigned int stale_link:1; /* If this is a symlink and points to Charon's land */
  98. unsigned int dir_size_computed:1; /* Size of directory was computed with dirsizes_cmd */
  99. } f;
  100. } file_entry_t;
  101. /*** global variables defined in .c file *********************************************************/
  102. extern struct sigaction startup_handler;
  103. /*** declarations of public functions ************************************************************/
  104. int is_printable (int c);
  105. /* Quote the filename for the purpose of inserting it into the command
  106. * line. If quote_percent is 1, replace "%" with "%%" - the percent is
  107. * processed by the mc command line. */
  108. char *name_quote (const char *c, gboolean quote_percent);
  109. /* returns a duplicate of c. */
  110. char *fake_name_quote (const char *c, gboolean quote_percent);
  111. /* path_trunc() is the same as str_trunc() but
  112. * it deletes possible password from path for security
  113. * reasons. */
  114. const char *path_trunc (const char *path, size_t trunc_len);
  115. /* return a static string representing size, appending "K" or "M" for
  116. * big sizes.
  117. * NOTE: uses the same static buffer as size_trunc_sep. */
  118. const char *size_trunc (uintmax_t size, gboolean use_si);
  119. /* return a static string representing size, appending "K" or "M" for
  120. * big sizes. Separates every three digits by ",".
  121. * NOTE: uses the same static buffer as size_trunc. */
  122. const char *size_trunc_sep (uintmax_t size, gboolean use_si);
  123. /* Print file SIZE to BUFFER, but don't exceed LEN characters,
  124. * not including trailing 0. BUFFER should be at least LEN+1 long.
  125. *
  126. * Units: size units (0=bytes, 1=Kbytes, 2=Mbytes, etc.) */
  127. void size_trunc_len (char *buffer, unsigned int len, uintmax_t size, int units, gboolean use_si);
  128. const char *string_perm (mode_t mode_bits);
  129. const char *extension (const char *);
  130. const char *unix_error_string (int error_num);
  131. const char *skip_separators (const char *s);
  132. const char *skip_numbers (const char *s);
  133. char *strip_ctrl_codes (char *s);
  134. /* Replaces "\\E" and "\\e" with "\033". Replaces "^" + [a-z] with
  135. * ((char) 1 + (c - 'a')). The same goes for "^" + [A-Z].
  136. * Returns a newly allocated string. */
  137. char *convert_controls (const char *s);
  138. /* overwrites passwd with '\0's and frees it. */
  139. void wipe_password (char *passwd);
  140. char *diff_two_paths (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
  141. /* Returns the basename of fname. The result is a pointer into fname. */
  142. const char *x_basename (const char *fname);
  143. char *load_mc_home_file (const char *from, const char *filename, char **allocated_filename,
  144. size_t * length);
  145. /* uid/gid managing */
  146. void init_groups (void);
  147. void destroy_groups (void);
  148. int get_user_permissions (struct stat *buf);
  149. void init_uid_gid_cache (void);
  150. const char *get_group (gid_t gid);
  151. const char *get_owner (uid_t uid);
  152. /* Returns a copy of *s until a \n is found and is below top */
  153. const char *extract_line (const char *s, const char *top);
  154. /* Error pipes */
  155. void open_error_pipe (void);
  156. void check_error_pipe (void);
  157. int close_error_pipe (int error, const char *text);
  158. /* Process spawning */
  159. int my_system (int flags, const char *shell, const char *command);
  160. int my_systeml (int flags, const char *shell, ...);
  161. int my_systemv (const char *command, char *const argv[]);
  162. int my_systemv_flags (int flags, const char *command, char *const argv[]);
  163. mc_pipe_t *mc_popen (const char *command, GError ** error);
  164. void mc_pread (mc_pipe_t * p, GError ** error);
  165. void mc_pclose (mc_pipe_t * p, GError ** error);
  166. void my_exit (int status);
  167. void save_stop_handler (void);
  168. /* Tilde expansion */
  169. char *tilde_expand (const char *);
  170. void custom_canonicalize_pathname (char *, CANON_PATH_FLAGS);
  171. void canonicalize_pathname (char *);
  172. #ifdef HAVE_REALPATH
  173. #define mc_realpath realpath
  174. #else
  175. char *mc_realpath (const char *path, char *resolved_path);
  176. #endif
  177. /* Looks for "magic" bytes at the start of the VFS file to guess the
  178. * compression type. Side effect: modifies the file position. */
  179. enum compression_type get_compression_type (int fd, const char *);
  180. const char *decompress_extension (int type);
  181. GList *list_append_unique (GList * list, char *text);
  182. /* Position saving and restoring */
  183. /* Load position for the given filename */
  184. void load_file_position (const vfs_path_t * filename_vpath, long *line, long *column,
  185. off_t * offset, GArray ** bookmarks);
  186. /* Save position for the given filename */
  187. void save_file_position (const vfs_path_t * filename_vpath, long line, long column, off_t offset,
  188. GArray * bookmarks);
  189. /* if ch is in [A-Za-z], returns the corresponding control character,
  190. * else returns the argument. */
  191. extern int ascii_alpha_to_cntrl (int ch);
  192. #undef Q_
  193. const char *Q_ (const char *s);
  194. gboolean mc_util_make_backup_if_possible (const char *, const char *);
  195. gboolean mc_util_restore_from_backup_if_possible (const char *, const char *);
  196. gboolean mc_util_unlink_backup_if_possible (const char *, const char *);
  197. char *guess_message_value (void);
  198. char *mc_build_filename (const char *first_element, ...);
  199. char *mc_build_filenamev (const char *first_element, va_list args);
  200. const char *mc_get_profile_root (void);
  201. /* *INDENT-OFF* */
  202. void mc_propagate_error (GError ** dest, int code, const char *format, ...) G_GNUC_PRINTF (3, 4);
  203. void mc_replace_error (GError ** dest, int code, const char *format, ...) G_GNUC_PRINTF (3, 4);
  204. /* *INDENT-ON* */
  205. gboolean mc_time_elapsed (guint64 * timestamp, guint64 delay);
  206. /*** inline functions **************************************************/
  207. static inline gboolean
  208. exist_file (const char *name)
  209. {
  210. return (access (name, R_OK) == 0);
  211. }
  212. static inline gboolean
  213. is_exe (mode_t mode)
  214. {
  215. return (gboolean) ((S_IXUSR & mode) || (S_IXGRP & mode) || (S_IXOTH & mode));
  216. }
  217. #endif /* MC_UTIL_H */