fix bugs 4373, 'attach mailto URI double free' and 4374, ' insert mailto URI misses...
[claws.git] / src / common / utils.h
index 7e0094d011eef51e8dd749e480cbf64c9cf4f06a..9816c4efcac9c400985cef6ebba9f48e75b0e74b 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail team
+ * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 1999-2020 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
  *
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
- * 
+ *
+ * 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__
 #define __UTILS_H__
 
 #ifdef HAVE_CONFIG_H
-#  include "config.h"
+#include "claws-features.h"
+#include "config.h"
+#endif
+
+#ifdef HAVE_BACKTRACE
+#include <execinfo.h>
 #endif
 
 #include <glib.h>
 #  include <wchar.h>
 #endif
 
-/* Wrappers for C library function that take pathname arguments. */
-#if GLIB_CHECK_VERSION(2, 6, 0)
-#  include <glib/gstdio.h>
-#else
-
-#define g_open         open
-#define g_rename       rename
-#define g_mkdir                mkdir
-#define g_stat         stat
-#define g_lstat                lstat
-#define g_unlink       unlink
-#define g_remove       remove
-#define g_rmdir                rmdir
-#define g_fopen                fopen
-#define g_freopen      freopen
+/* 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
 
-#endif /* GLIB_CHECK_VERSION */
+#ifdef G_OS_WIN32
 
-#if !GLIB_CHECK_VERSION(2, 7, 0)
+#define fsync _commit
 
-#ifdef G_OS_UNIX
-#define g_chdir                chdir
-#define g_chmod                chmod
-#else
-gint g_chdir   (const gchar    *path);
-gint g_chmod   (const gchar    *path,
-                gint            mode);
-#endif /* G_OS_UNIX */
-
-#endif /* !GLIB_CHECK_VERSION */
-
-/* The AC_CHECK_SIZEOF() in configure fails for some machines.
- * we provide some fallback values here */
-#if !SIZEOF_UNSIGNED_SHORT
-  #undef SIZEOF_UNSIGNED_SHORT
-  #define SIZEOF_UNSIGNED_SHORT 2
-#endif
-#if !SIZEOF_UNSIGNED_INT
-  #undef SIZEOF_UNSIGNED_INT
-  #define SIZEOF_UNSIGNED_INT 4
-#endif
-#if !SIZEOF_UNSIGNED_LONG
-  #undef SIZEOF_UNSIGNED_LONG
-  #define SIZEOF_UNSIGNED_LONG 4
+#define pipe(phandles)  _pipe (phandles, 4096, _O_BINARY)
 #endif
+/* Wrappers for C library function that take pathname arguments. */
+#  include <glib/gstdio.h>
 
-#ifndef HAVE_U32_TYPEDEF
-  #undef u32       /* maybe there is a macro with this name */
-  typedef guint32 u32;
-  #define HAVE_U32_TYPEDEF
+/* why is this sometimes undefined !? */
+#ifndef G_MAXOFFSET
+typedef gint64 goffset;
+#define G_MINOFFSET    G_MININT64
+#define G_MAXOFFSET    G_MAXINT64
 #endif
 
 #ifndef BIG_ENDIAN_HOST
@@ -119,7 +99,7 @@ gint g_chmod (const gchar    *path,
 #define Xalloca(ptr, size, iffail) \
 { \
        if ((ptr = alloca(size)) == NULL) { \
-               g_warning("can't allocate memory\n"); \
+               g_warning("can't allocate memory"); \
                iffail; \
        } \
 }
@@ -129,7 +109,7 @@ gint g_chmod        (const gchar    *path,
        gchar *__tmp; \
  \
        if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
-               g_warning("can't allocate memory\n"); \
+               g_warning("can't allocate memory"); \
                iffail; \
        } else \
                strcpy(__tmp, str); \
@@ -142,10 +122,10 @@ gint g_chmod      (const gchar    *path,
        gchar *__tmp; \
  \
        if ((__tmp = alloca(len + 1)) == NULL) { \
-               g_warning("can't allocate memory\n"); \
+               g_warning("can't allocate memory"); \
                iffail; \
        } else { \
-               strncpy(__tmp, str, len); \
+               memcpy(__tmp, str, len); \
                __tmp[len] = '\0'; \
        } \
  \
@@ -160,7 +140,7 @@ gint g_chmod        (const gchar    *path,
        len1 = strlen(str1); \
        len2 = strlen(str2); \
        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); \
@@ -187,6 +167,65 @@ gint g_chmod       (const gchar    *path,
 
 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
 
+/* from NetworkManager */
+#if (defined(HAVE_BACKTRACE) && !defined(__FreeBSD__))
+#define print_backtrace()                                              \
+G_STMT_START                                                           \
+{                                                                      \
+       void *_call_stack[512];                                         \
+       int  _call_stack_size;                                          \
+       char **_symbols;                                                \
+       _call_stack_size = backtrace (_call_stack,                      \
+                                     G_N_ELEMENTS (_call_stack));      \
+       _symbols = backtrace_symbols (_call_stack, _call_stack_size);   \
+       if (_symbols != NULL)                                           \
+       {                                                               \
+               int _i;                                                 \
+               _i = 0;                                                 \
+               g_print ("traceback:\n");                               \
+               while (_i < _call_stack_size)                           \
+               {                                                       \
+                       g_print ("%d:\t%s\n", _i, _symbols[_i]);        \
+                       _i++;                                           \
+               }                                                       \
+               free (_symbols);                                        \
+       }                                                               \
+}                                                                      \
+G_STMT_END
+#else
+#define print_backtrace()                                              \
+G_STMT_START                                                           \
+{                                                                      \
+}                                                                      \
+G_STMT_END
+#endif
+
+
+#define cm_return_val_if_fail(expr,val) G_STMT_START {                 \
+       if (!(expr)) {                                                  \
+               g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
+               print_backtrace();                                      \
+               g_print("\n");                                          \
+               return val;                                             \
+       }                                                               \
+} G_STMT_END
+
+#define cm_return_if_fail(expr) G_STMT_START {                         \
+       if (!(expr)) {                                                  \
+               g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
+               print_backtrace();                                      \
+               g_print("\n");                                          \
+               return;                                                 \
+       }                                                               \
+} G_STMT_END
+
+#ifndef MIN
+       #define MIN(a, b) ((a) < (b) ? (a) : (b))
+#endif
+#ifndef MAX
+       #define MAX(a, b) ((a) > (b) ? (a) : (b))
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -212,16 +251,15 @@ gboolean debug_get_mode           (void);
 #define Str(x) #x
 #define Xstr(x)        Str(x)
 
+/* List utilities. */
 
-/* System related stuff.  */
-
-gboolean superuser_p (void);
-
+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);
 
@@ -229,36 +267,27 @@ gint str_case_equal               (gconstpointer   v,
                                 gconstpointer   v2);
 guint str_case_hash            (gconstpointer   key);
 
-void ptr_array_free_strings    (GPtrArray      *array);
-
-typedef gboolean (*StrFindFunc) (const gchar   *haystack,
-                                const gchar    *needle);
-
-gboolean str_find              (const gchar    *haystack,
-                                const gchar    *needle);
-gboolean str_case_find         (const gchar    *haystack,
-                                const gchar    *needle);
 /* number-string conversion */
 gint to_number                 (const gchar *nstr);
 gchar *itos_buf                        (gchar       *nstr,
                                 gint         n);
 gchar *itos                    (gint         n);
-gchar *to_human_readable       (off_t        size);
+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);
+#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);
 gpointer my_memmem     (gconstpointer   haystack,
                         size_t          haystacklen,
                         gconstpointer   needle,
@@ -285,6 +314,8 @@ void extract_parenthesis            (gchar          *str,
 
 void extract_quote                     (gchar          *str,
                                         gchar           quote_chr);
+gchar *escape_internal_quotes          (gchar          *str,
+                                        gchar           quote_chr);
 void eliminate_address_comment         (gchar          *str);
 gchar *strchr_with_skip_quote          (const gchar    *str,
                                         gint            quote_chr,
@@ -312,8 +343,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);
@@ -339,16 +370,18 @@ 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,
                                         gchar         **to,
                                         gchar         **cc,
                                         gchar         **bcc,
                                         gchar         **subject,
                                         gchar         **body,
-                                        gchar         ***attach);
+                                        gchar         ***attach,
+                                        gchar         **inreplyto);
 
 /* return static strings */
 const gchar *get_home_dir              (void);
@@ -365,11 +398,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 *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,
@@ -377,6 +413,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 is_file_entry_regular(const gchar *file);
 gboolean dirent_is_regular_file        (struct dirent  *d);
 
 #define is_file_exist(file)            file_exist(file, FALSE)
@@ -393,53 +430,17 @@ 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);
-
 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);
 
 /* open URI with external browser */
@@ -453,10 +454,12 @@ 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 */
@@ -468,6 +471,7 @@ void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
 void subject_table_insert(GHashTable *subject_table, gchar * subject,
                          void * data);
 void subject_table_remove(GHashTable *subject_table, gchar * subject);
+void utils_free_regex(void);
 gint subject_get_prefix_length (const gchar *subject);
 
 /* quoting recognition */
@@ -476,7 +480,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 *generate_mime_boundary  (const gchar *prefix);
 
 gint quote_cmd_argument(gchar * result, guint size,
@@ -492,7 +495,7 @@ 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);
@@ -505,9 +508,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,
@@ -515,7 +518,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);
@@ -523,8 +526,30 @@ void mailcap_update_default           (const gchar *type,
 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);
+
+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__ */