Remove unused includes
[claws.git] / src / common / utils.h
index 0a38d34ab81e27982a2a1a784a22e1b1db8d32c5..e107805e3bef48d8b0fd7678b3515872f11a64d2 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2014 Hiroyuki Yamamoto and the Claws Mail team
+ * Claws Mail -- a GTK based, lightweight, and fast e-mail client
+ * Copyright (C) 1999-2024 The Claws Mail Team and Hiroyuki Yamamoto
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,7 +18,6 @@
  * The code of the g_utf8_substring function below is owned by
  * Matthias Clasen <matthiasc@src.gnome.org>/<mclasen@redhat.com>
  * and is got from GLIB 2.30
- *
  */
 
 #ifndef __UTILS_H__
@@ -39,7 +38,6 @@
 #include <stdlib.h>
 #include <unistd.h>
 #include <sys/types.h>
-#include <dirent.h>
 #include <time.h>
 #if HAVE_ALLOCA_H
 #  include <alloca.h>
 #  include <wchar.h>
 #endif
 
-/* The Hurd doesn't have this limit */
+/* The Hurd doesn't have these limits */
 #ifndef PATH_MAX
   #define PATH_MAX 4196
 #endif
+#ifndef HOST_NAME_MAX
+  #define HOST_NAME_MAX 256
+#endif
+
+/* Handling Base64 content in procmime and prefs_customheader */
+#define B64_LINE_SIZE 57
 
 #ifdef G_OS_WIN32
 
@@ -69,25 +73,6 @@ typedef gint64 goffset;
 #define G_MAXOFFSET    G_MAXINT64
 #endif
 
-#ifndef HAVE_U32_TYPEDEF
-  #undef u32       /* maybe there is a macro with this name */
-  typedef guint32 u32;
-  #define HAVE_U32_TYPEDEF
-#endif
-
-#if !GLIB_CHECK_VERSION(2, 26, 0)
-#define g_base64_decode(t,l)   g_base64_decode_wa((t),(l))
-guchar *g_base64_decode_wa(const gchar *text, gsize *out_len);
-#endif
-
-#if !GLIB_CHECK_VERSION(2, 25, 0)
-# ifdef G_OS_WIN32
-       typedef _g_stat_struct GStatBuf;
-# else
-       typedef struct stat GStatBuf;
-# endif
-#endif
-
 #ifndef BIG_ENDIAN_HOST
   #if (G_BYTE_ORDER == G_BIG_ENDIAN)
     #define BIG_ENDIAN_HOST 1
@@ -112,10 +97,18 @@ guchar *g_base64_decode_wa(const gchar *text, gsize *out_len);
        } \
 }
 
+#define MAX_ALLOCA_MEM_SIZE 102400
+
 #define Xalloca(ptr, size, iffail) \
 { \
-       if ((ptr = alloca(size)) == NULL) { \
-               g_warning("can't allocate memory\n"); \
+       size_t __size = size; \
+ \
+       if (__size > MAX_ALLOCA_MEM_SIZE) { \
+               g_warning("%" G_GSIZE_FORMAT " bytes exceeds max alloca size '%d'", __size, MAX_ALLOCA_MEM_SIZE); \
+               iffail; \
+       } \
+       if ((ptr = alloca(__size)) == NULL) { \
+               g_warning("can't allocate memory"); \
                iffail; \
        } \
 }
@@ -123,9 +116,14 @@ guchar *g_base64_decode_wa(const gchar *text, gsize *out_len);
 #define Xstrdup_a(ptr, str, iffail) \
 { \
        gchar *__tmp; \
+       size_t __size = strlen(str); \
  \
-       if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
-               g_warning("can't allocate memory\n"); \
+       if (__size > MAX_ALLOCA_MEM_SIZE) { \
+               g_warning("%" G_GSIZE_FORMAT " bytes exceeds max alloca size '%d'", __size, MAX_ALLOCA_MEM_SIZE); \
+               iffail; \
+       } \
+       if ((__tmp = alloca(__size + 1)) == NULL) { \
+               g_warning("can't allocate memory"); \
                iffail; \
        } else \
                strcpy(__tmp, str); \
@@ -136,13 +134,18 @@ guchar *g_base64_decode_wa(const gchar *text, gsize *out_len);
 #define Xstrndup_a(ptr, str, len, iffail) \
 { \
        gchar *__tmp; \
+       size_t __size = len; \
  \
-       if ((__tmp = alloca(len + 1)) == NULL) { \
-               g_warning("can't allocate memory\n"); \
+       if (__size > MAX_ALLOCA_MEM_SIZE) { \
+               g_warning("%" G_GSIZE_FORMAT "bytes exceeds max alloca size '%d'", __size, MAX_ALLOCA_MEM_SIZE); \
+               iffail; \
+       } \
+       if ((__tmp = alloca(__size + 1)) == NULL) { \
+               g_warning("can't allocate memory"); \
                iffail; \
        } else { \
-               strncpy(__tmp, str, len); \
-               __tmp[len] = '\0'; \
+               memcpy(__tmp, str, __size); \
+               __tmp[__size] = '\0'; \
        } \
  \
        ptr = __tmp; \
@@ -151,12 +154,16 @@ guchar *g_base64_decode_wa(const gchar *text, gsize *out_len);
 #define Xstrcat_a(ptr, str1, str2, iffail) \
 { \
        gchar *__tmp; \
-       gint len1, len2; \
+       size_t len1, len2; \
  \
        len1 = strlen(str1); \
        len2 = strlen(str2); \
+       if (len1 + len2 > MAX_ALLOCA_MEM_SIZE) { \
+               g_warning("%" G_GSIZE_FORMAT " bytes exceeds max alloca size '%d'", len1 + len2, MAX_ALLOCA_MEM_SIZE); \
+               iffail; \
+       } \
        if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
-               g_warning("can't allocate memory\n"); \
+               g_warning("can't allocate memory"); \
                iffail; \
        } else { \
                memcpy(__tmp, str1, len1); \
@@ -252,14 +259,11 @@ typedef gpointer (*GNodeMapFunc)  (gpointer nodedata, gpointer data);
 void debug_set_mode            (gboolean mode);
 gboolean debug_get_mode                (void);
 
-#ifndef __CYGWIN__
-#define debug_print \
-       debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
-       debug_print_real
+#ifdef HAVE_VA_OPT
+#define debug_print(format, ...) debug_print_real(__FILE__, __LINE__, format __VA_OPT__(,) __VA_ARGS__)
 #else
-  /* FIXME: cygwin: why debug_srcname couldn't be resolved in library? */
 #define debug_print \
-       debug_print_real("%s:%d:", __FILE__, __LINE__), \
+       debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
        debug_print_real
 #endif
 
@@ -267,20 +271,9 @@ gboolean debug_get_mode            (void);
 #define Str(x) #x
 #define Xstr(x)        Str(x)
 
-
-/* System related stuff.  */
-
-gboolean superuser_p (void);
-
-/* List utilities. */
-
-GSList *slist_copy_deep                (GSList         *list,
-                                GCopyFunc       func);
-
 /* String utilities.  */
 
-void list_free_strings         (GList          *list);
-void slist_free_strings                (GSList         *list);
+void list_free_strings_full            (GList          *list);
 void slist_free_strings_full   (GSList         *list);
 
 void hash_free_strings         (GHashTable     *table);
@@ -289,8 +282,6 @@ gint str_case_equal         (gconstpointer   v,
                                 gconstpointer   v2);
 guint str_case_hash            (gconstpointer   key);
 
-void ptr_array_free_strings    (GPtrArray      *array);
-
 /* number-string conversion */
 gint to_number                 (const gchar *nstr);
 gchar *itos_buf                        (gchar       *nstr,
@@ -299,19 +290,17 @@ gchar *itos                       (gint         n);
 gchar *to_human_readable       (goffset      size);
 
 /* alternative string functions */
-gint strcmp2           (const gchar    *s1,
-                        const gchar    *s2);
-gchar *strstr2         (const gchar    *s1,
-                        const gchar    *s2);
 gint path_cmp          (const gchar    *s1,
                         const gchar    *s2);
 gchar *strretchomp     (gchar          *str);
 gchar *strtailchomp    (gchar          *str,
                         gchar           tail_char);
 gchar *strcrchomp      (gchar          *str);
-gint file_strip_crs    (const gchar    *file);
+gchar *strcrlftrunc    (gchar *str);
+#ifndef HAVE_STRCASESTR
 gchar *strcasestr      (const gchar    *haystack,
                         const gchar    *needle);
+#endif /* HAVE_STRCASESTR */
 gchar *strncasestr     (const gchar    *haystack,
                         gint            haystack_len,
                         const gchar    *needle);
@@ -370,8 +359,8 @@ void unfold_line                    (gchar          *str);
 void subst_char                                (gchar          *str,
                                         gchar           orig,
                                         gchar           subst);
-void subst_chars                       (gchar          *str,   
-                                        gchar          *orig, 
+void subst_chars                       (gchar          *str,
+                                        gchar          *orig,
                                         gchar          subst);
 void subst_for_filename                        (gchar          *str);
 void subst_for_shellsafe_filename      (gchar          *str);
@@ -397,8 +386,8 @@ gchar *get_uri_path                 (const gchar    *uri);
 gint get_uri_len                       (const gchar    *str);
 void decode_uri                                (gchar          *decoded_uri,
                                         const gchar    *encoded_uri);
-void decode_uri_with_plus              (gchar          *decoded_uri, 
-                                        const gchar    *encoded_uri, 
+void decode_uri_with_plus              (gchar          *decoded_uri,
+                                        const gchar    *encoded_uri,
                                         gboolean        with_plus);
 gint scan_mailto_url                   (const gchar    *mailto,
                                         gchar         **from,
@@ -425,15 +414,14 @@ const gchar *get_tmp_dir          (void);
 const gchar *get_locale_dir            (void);
 gchar *get_tmp_file                    (void);
 const gchar *get_domain_name           (void);
+gboolean is_numeric_host_address       (const gchar *hostaddress);
 const gchar *get_desktop_file(void);
 #ifdef G_OS_WIN32
-const gchar *get_themes_dir             (void);
-const gchar *get_cert_file             (void);
+const gchar *w32_get_themes_dir    (void);
+const gchar *w32_get_cert_file         (void);
 #endif
 /* file / directory handling */
 off_t get_file_size            (const gchar    *file);
-off_t get_file_size_as_crlf    (const gchar    *file);
-
 time_t get_file_mtime          (const gchar *file);
 
 gboolean file_exist            (const gchar    *file,
@@ -441,7 +429,7 @@ gboolean file_exist         (const gchar    *file,
 gboolean is_relative_filename   (const gchar *file);
 gboolean is_dir_exist          (const gchar    *dir);
 gboolean is_file_entry_exist   (const gchar    *file);
-gboolean dirent_is_regular_file        (struct dirent  *d);
+gboolean is_file_entry_regular(const gchar *file);
 
 #define is_file_exist(file)            file_exist(file, FALSE)
 #define is_file_or_fifo_exist(file)    file_exist(file, TRUE)
@@ -457,56 +445,19 @@ gint remove_numbered_files_not_in_list(const gchar *dir,
                                       GSList *numberlist);
 gint remove_all_numbered_files (const gchar    *dir);
 gint remove_dir_recursive      (const gchar    *dir);
-gint append_file               (const gchar    *src,
-                                const gchar    *dest,
-                                gboolean        keep_backup);
-gint rename_force              (const gchar    *oldpath,
-                                const gchar    *newpath);
-gint copy_file                 (const gchar    *src,
-                                const gchar    *dest,
-                                gboolean        keep_backup);
-gint move_file                 (const gchar    *src,
-                                const gchar    *dest,
-                                gboolean        overwrite);
-gint copy_dir                  (const gchar    *src,
-                                const gchar    *dest);
-gint copy_file_part_to_fp      (FILE           *fp,
-                                off_t           offset,
-                                size_t          length,
-                                FILE           *dest_fp);
-gint copy_file_part            (FILE           *fp,
-                                off_t           offset,
-                                size_t          length,
-                                const gchar    *dest);
-
 gchar *canonicalize_str                (const gchar    *str);
-gint canonicalize_file         (const gchar    *src,
-                                const gchar    *dest);
-gint canonicalize_file_replace (const gchar    *file);
-
 gchar *normalize_newlines      (const gchar    *str);
 
 gchar *get_outgoing_rfc2822_str        (FILE           *fp);
 
-gint change_file_mode_rw       (FILE           *fp,
-                                const gchar    *file);
-FILE *my_tmpfile               (void);
-FILE *get_tmpfile_in_dir       (const gchar    *dir,
-                                gchar         **filename);
-FILE *str_open_as_stream       (const gchar    *str);
-gint str_write_to_file         (const gchar    *str,
-                                const gchar    *file);
-gchar *file_read_to_str                (const gchar    *file);
-gchar *file_read_stream_to_str (FILE           *fp);
-gchar *file_read_to_str_no_recode(const gchar *file);
-gchar *file_read_stream_to_str_no_recode(FILE *fp);
-
 char *fgets_crlf(char *buf, int size, FILE *stream);
 
 /* process execution */
 gint execute_command_line      (const gchar    *cmdline,
-                                gboolean        async);
+                                gboolean        async,
+                                const gchar    *working_directory);
 gchar *get_command_output      (const gchar    *cmdline);
+FILE *get_command_output_stream        (const gchar    *cmdline);
 
 /* open URI with external browser */
 gint open_uri(const gchar *uri, const gchar *cmdline);
@@ -519,14 +470,20 @@ time_t tzoffset_sec               (time_t         *now);
 gchar *tzoffset                        (time_t         *now);
 void get_rfc822_date           (gchar          *buf,
                                 gint            len);
+void get_rfc822_date_hide_tz   (gchar          *buf,
+                                gint            len);
 
-size_t fast_strftime           (gchar                  *buf, 
-                                gint                    buflen, 
-                                const gchar            *format, 
+size_t fast_strftime           (gchar                  *buf,
+                                gint                    buflen,
+                                const gchar            *format,
                                 struct tm              *lt);
 
 /* debugging */
-void debug_print_real  (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
+#ifdef HAVE_VA_OPT
+void debug_print_real (const char *file, int line, const gchar *format, ...) G_GNUC_PRINTF(3, 4);
+#else
+void debug_print_real (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
+#endif
 const char * debug_srcname (const char *file);
 
 /* subject threading */
@@ -543,7 +500,6 @@ const gchar * line_has_quote_char   (const gchar *str,
 
 gint g_int_compare     (gconstpointer a, gconstpointer b);
 
-gchar *generate_msgid          (gchar *buf, gint len, gchar *user_addr);
 gchar *generate_mime_boundary  (const gchar *prefix);
 
 gint quote_cmd_argument(gchar * result, guint size,
@@ -559,12 +515,11 @@ void get_hex_str(gchar *out, guchar ch);
 typedef struct AutoPointer     GAuto;
 GType g_auto_pointer_register          (void);
 GAuto *g_auto_pointer_new              (gpointer pointer);
-GAuto *g_auto_pointer_new_with_free    (gpointer p, 
+GAuto *g_auto_pointer_new_with_free    (gpointer p,
                                         GFreeFunc free);
 gpointer g_auto_pointer_get_ptr                (GAuto *auto_ptr);
 GAuto *g_auto_pointer_copy             (GAuto *auto_ptr);
 void g_auto_pointer_free               (GAuto *auto_ptr);
-void replace_returns                   (gchar *str);
 gboolean get_uri_part  (const gchar *start,
                         const gchar *scanpos,
                         const gchar **bp,
@@ -572,9 +527,9 @@ gboolean get_uri_part       (const gchar *start,
                         gboolean hdr);
 gchar *make_uri_string (const gchar *bp,
                         const gchar *ep);
-gboolean get_email_part        (const gchar *start, 
+gboolean get_email_part        (const gchar *start,
                         const gchar *scanpos,
-                        const gchar **bp, 
+                        const gchar **bp,
                         const gchar **ep,
                         gboolean hdr);
 gchar *make_email_string(const gchar *bp,
@@ -582,7 +537,7 @@ gchar *make_email_string(const gchar *bp,
 gchar *make_http_string (const gchar *bp,
                         const gchar *ep);
 
-gchar *mailcap_get_command_for_type(const gchar *type, 
+gchar *mailcap_get_command_for_type(const gchar *type,
                                    const gchar *file_to_open);
 void mailcap_update_default       (const gchar *type,
                                    const gchar *command);
@@ -591,23 +546,20 @@ gboolean file_is_email(const gchar *filename);
 gboolean sc_g_list_bigger(GList *list, gint max);
 gboolean sc_g_slist_bigger(GSList *list, gint max);
 
-int claws_unlink(const gchar *filename);
-
-GMutex *cm_mutex_new(void);
-void cm_mutex_free(GMutex *mutex);
-
 int cm_canonicalize_filename(const gchar *filename, gchar **canonical_name);
 
 guchar *g_base64_decode_zero(const gchar *text, gsize *out_len);
 
-#if !GLIB_CHECK_VERSION(2, 30, 0)
-gchar   *g_utf8_substring         (const gchar *p,
-                                   glong        start_pos,
-                                   glong        end_pos) G_GNUC_MALLOC;
-#endif
+gboolean get_random_bytes(void *buf, size_t count);
 
 #ifdef __cplusplus
 }
 #endif
 
+gboolean get_serverportfp_from_filename(const gchar *str, gchar **server, gchar **port, gchar **fp);
+
+#ifdef G_OS_WIN32
+gchar *win32_debug_log_path(void);
+#endif
+
 #endif /* __UTILS_H__ */