Make Message-ID string generation less confusing.
[claws.git] / src / common / utils.h
index dedc620edc65c5657bff34177b9781d79e71a837..c90487432f85fe57b198e8203ca8e25e60db5cf4 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-2016 Hiroyuki Yamamoto and the Claws Mail team
  *
  * 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"
+#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 this limit */
+#ifndef PATH_MAX
+  #define PATH_MAX 4196
+#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
+#define pipe(phandles)  _pipe (phandles, 4096, _O_BINARY)
 #endif
-#if !SIZEOF_UNSIGNED_LONG
-  #undef SIZEOF_UNSIGNED_LONG
-  #define SIZEOF_UNSIGNED_LONG 4
+/* Wrappers for C library function that take pathname arguments. */
+#  include <glib/gstdio.h>
+
+/* why is this sometimes undefined !? */
+#ifndef G_MAXOFFSET
+typedef gint64 goffset;
+#define G_MINOFFSET    G_MININT64
+#define G_MAXOFFSET    G_MAXINT64
 #endif
 
 #ifndef HAVE_U32_TYPEDEF
@@ -92,6 +74,19 @@ gint g_chmod (const gchar    *path,
   #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
@@ -119,7 +114,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 +124,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,7 +137,7 @@ 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); \
@@ -160,7 +155,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 +182,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
@@ -217,11 +271,16 @@ gboolean debug_get_mode           (void);
 
 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 slist_free_strings_full   (GSList         *list);
 
 void hash_free_strings         (GHashTable     *table);
 
@@ -231,19 +290,12 @@ 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,
@@ -259,6 +311,9 @@ gchar *strcrchomp   (gchar          *str);
 gint file_strip_crs    (const gchar    *file);
 gchar *strcasestr      (const gchar    *haystack,
                         const gchar    *needle);
+gchar *strncasestr     (const gchar    *haystack,
+                        gint            haystack_len,
+                        const gchar    *needle);
 gpointer my_memmem     (gconstpointer   haystack,
                         size_t          haystacklen,
                         gconstpointer   needle,
@@ -285,6 +340,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,
@@ -343,12 +400,14 @@ 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 +424,13 @@ const gchar *get_tmp_dir          (void);
 const gchar *get_locale_dir            (void);
 gchar *get_tmp_file                    (void);
 const gchar *get_domain_name           (void);
-
+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,
@@ -441,7 +502,8 @@ 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 */
@@ -455,6 +517,8 @@ 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, 
@@ -479,7 +543,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,
@@ -526,6 +589,24 @@ 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);
+
+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