Refactored the code that joins the addresses in a single string
[modest] / src / modest-text-utils.h
index 8dedca4..59c0714 100644 (file)
 
 #include <time.h>
 #include <glib.h>
 
 #include <time.h>
 #include <glib.h>
+#include <gdk/gdkcolor.h>
+#include <gtk/gtktextbuffer.h>
+#include <gtk/gtklabel.h>
+
+#define _FM(str) dgettext("hildon-fm",str)
+#define _CS(str) dgettext("hildon-common-strings",str)
+#define _HL(str) dgettext("hildon-libs",str)
+#define _MD(str) dgettext("maemo-af-desktop",str)
+#define _AB(str) dgettext("osso-addressbook",str)
+#define _KR(str) dgettext("ke-recv",str)
+#define _UR(str) dgettext("osso-uri",str)
+
+/* Forbidden char arrays */
+extern const gchar account_title_forbidden_chars[];
+extern const gchar folder_name_forbidden_chars[];
+extern const gchar user_name_forbidden_chars[];
+extern const guint ACCOUNT_TITLE_FORBIDDEN_CHARS_LENGTH;
+extern const guint FOLDER_NAME_FORBIDDEN_CHARS_LENGTH;
+extern const guint USER_NAME_FORBIDDEN_CHARS_LENGTH;
+
+/* It includes a white space as RFC 3676 Section 4.3 about usenet
+   message signatures defines */
+#define MODEST_TEXT_UTILS_SIGNATURE_MARKER "-- "
 
 /**
  * modest_text_utils_derived_subject:
 
 /**
  * modest_text_utils_derived_subject:
@@ -56,7 +79,9 @@ gchar* modest_text_utils_derived_subject (const gchar *subject,
  * @text: a non-NULL string which contains the message to quote
  * @from: a non-NULL  sender of the original message
  * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
  * @text: a non-NULL string which contains the message to quote
  * @from: a non-NULL  sender of the original message
  * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
+ * @signature: NULL or the signature to add
  * @sent_date: sent date/time of the original message
  * @sent_date: sent date/time of the original message
+ * @attachments: a #GList of the attachments
  * @limit: specifies the maximum characters per line in the quoted text
  * 
  * quote an existing message
  * @limit: specifies the maximum characters per line in the quoted text
  * 
  * quote an existing message
@@ -65,8 +90,10 @@ gchar* modest_text_utils_derived_subject (const gchar *subject,
  */
 gchar* modest_text_utils_quote (const gchar *text, 
                                const gchar *content_type,
  */
 gchar* modest_text_utils_quote (const gchar *text, 
                                const gchar *content_type,
+                               const gchar *signature,
                                const gchar *from,
                                const time_t sent_date, 
                                const gchar *from,
                                const time_t sent_date, 
+                               GList *attachments,
                                int limit);
 
 
                                int limit);
 
 
@@ -82,6 +109,7 @@ gchar* modest_text_utils_quote (const gchar *text,
  */
 gchar* modest_text_utils_cite (const gchar *text,
                               const gchar *content_type,
  */
 gchar* modest_text_utils_cite (const gchar *text,
                               const gchar *content_type,
+                              const gchar *signature,
                               const gchar *from,
                               time_t sent_date);
 
                               const gchar *from,
                               time_t sent_date);
 
@@ -100,6 +128,7 @@ gchar* modest_text_utils_cite (const gchar *text,
  */
 gchar*   modest_text_utils_inline (const gchar *text,
                                   const gchar *content_type,
  */
 gchar*   modest_text_utils_inline (const gchar *text,
                                   const gchar *content_type,
+                                  const gchar *signature,
                                   const gchar *from,
                                   time_t sent_date,
                                   const gchar *to,
                                   const gchar *from,
                                   time_t sent_date,
                                   const gchar *to,
@@ -107,11 +136,11 @@ gchar*   modest_text_utils_inline (const gchar *text,
 
 /**
  * modest_text_utils_remove_address
 
 /**
  * modest_text_utils_remove_address
- * @address_list: none-NULL string with a comma-separated list of email addresses
+ * @address_list: non-NULL string with a comma-separated list of email addresses
  * @address: an specific e-mail address 
  *
  * remove a specific address from a list of email addresses; if @address
  * @address: an specific e-mail address 
  *
  * remove a specific address from a list of email addresses; if @address
- * is NULL, returns an unchanged @address_list
+ * is NULL, returns an unchanged (but newly allocated) @address_list
  * 
  * Returns: a newly allocated string containing the new list, or NULL
  * in case of error or the original @address_list was NULL
  * 
  * Returns: a newly allocated string containing the new list, or NULL
  * in case of error or the original @address_list was NULL
@@ -119,9 +148,22 @@ gchar*   modest_text_utils_inline (const gchar *text,
 gchar*   modest_text_utils_remove_address (const gchar *address_list, 
                                           const gchar *address);
 
 gchar*   modest_text_utils_remove_address (const gchar *address_list, 
                                           const gchar *address);
 
+
+/**
+ * modest_text_utils_remove_duplicate_addresses
+ * @address_list: non-NULL string with a comma-separated list of email addresses
+ *
+ * remove duplicate addresses from a list of email addresses
+ * 
+ * Returns: a newly allocated string containing the new list, or NULL
+ * in case of error or the original @address_list was NULL
+ */
+gchar*   modest_text_utils_remove_duplicate_addresses (const gchar *address_list); 
+
+
 /**
  * modest_text_utils_address_range_at_position:
 /**
  * modest_text_utils_address_range_at_position:
- * @address_list: utf8 string containing a list of addresses
+ * @address_list: non-NULL utf8 string containing a list of addresses
  * @position: a gint
  * @start: a gint pointer
  * @end: a gint pointer
  * @position: a gint
  * @start: a gint pointer
  * @end: a gint pointer
@@ -132,10 +174,23 @@ gchar*   modest_text_utils_remove_address (const gchar *address_list,
  * @end
  */
 void     modest_text_utils_address_range_at_position (const gchar *recipients_list,
  * @end
  */
 void     modest_text_utils_address_range_at_position (const gchar *recipients_list,
-                                                     gint position,
-                                                     gint *start,
-                                                     gint *end);
-                                                     
+                                                     guint position,
+                                                     guint *start,
+                                                     guint *end);
+
+/**
+ * modest_text_utils_hyperlinkify_begin:
+ *
+ * begin a linkify block, compiling the caches to be reused. Use it in mainloop.
+ */
+void modest_text_utils_hyperlinkify_begin (void);
+
+/**
+ * modest_text_utils_hyperlinkify_end:
+ *
+ * end a linkify block, freeing the caches to be reused. Use it in mainloop.
+ */
+void modest_text_utils_hyperlinkify_end (void);
 
 /**
  * modest_text_utils_convert_to_html:
 
 /**
  * modest_text_utils_convert_to_html:
@@ -148,16 +203,14 @@ void     modest_text_utils_address_range_at_position (const gchar *recipients_li
 gchar*  modest_text_utils_convert_to_html (const gchar *txt);
 
 /**
 gchar*  modest_text_utils_convert_to_html (const gchar *txt);
 
 /**
- * modest_text_utils_convert_to_pango:
+ * modest_text_utils_convert_to_html_body:
  * @txt: a string
  *
  * @txt: a string
  *
- * convert plain text (utf8) into pango-escaped text
+ * convert plain text (utf8) into html without adding html headers.
  * 
  * Returns: a newly allocated string containing the html
  */
  * 
  * Returns: a newly allocated string containing the html
  */
-gchar*  modest_text_utils_convert_to_pango (const gchar *txt);
-
-
+gchar*  modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gboolean hyperlinkify);
 
 
 /**
 
 
 /**
@@ -174,21 +227,56 @@ gchar*  modest_text_utils_convert_to_pango (const gchar *txt);
  */
 size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t timet);
 
  */
 size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t timet);
 
-
+/**
+ * modest_text_utils_hyperlinkify:
+ * @string_buffer: buffer where we replace uri strings with links
+ *
+ * Replace uri's with links in the buffer. This is required that the document
+ * do not contain linkified links already.
+ */
+void modest_text_utils_hyperlinkify (GString *string_buffer);
 
 /**
 
 /**
- * modest_text_utils_get_display_addres:
+ * modest_text_utils_get_display_address:
  * @address: original address (UTF8 string)
  *
  * make a 'display address' from an address:
  * @address: original address (UTF8 string)
  *
  * make a 'display address' from an address:
- * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
- * ie. removes "<...>" and "(...)" parts
- * the change is in-place; removes leading/trailing whitespace
+ * "Foo Bar &lt;foo@bar.cx&gt;" --&gt; "Foo Bar"
+ * ie. removes "&lt;...&gt;" parts
+ * the change is in-place; removes leading whitespace
+ * 
+ * NOTE: for optimization reasons, this function changes @address
+ * in-place
+ */
+void modest_text_utils_get_display_address (gchar *address);
+
+/**
+ * modest_text_utils_get_display_addresses:
+ * @addresses: a list of comma-separated addresses
+ *
+ * Transforms a list of email addresses in a list of recipients,
+ * replacing each plain email address by the correspondent display
+ * address.
+ *
+ * Returns: a newly allocated string, that must be freed by the caller
+ **/
+gchar *modest_text_utils_get_display_addresses (const gchar *addresses);
+
+
+/**
+ * modest_text_utils_get_email_address:
+ * @full_address: original address (UTF8 string)
+ *
+ * make a 'foo@bar.cx' from an address:
+ * "Foo Bar <foo@bar.cx> (Bla)" --> "foo@bar.cx"
+ * If no "<...>" is found, then it returns the full
+ * strings.
+ * 
+ * Returns: a newly allocated string with the copy.
  * 
  * 
- * Returns: the new address. The string is *not* newly allocated.
- * NULL in case of error
+ * NULL in case of error or if address == NULL
  */
  */
-gchar* modest_text_utils_get_display_address (gchar *address);
+gchar* modest_text_utils_get_email_address (const gchar *email_address);
 
 
 /**
 
 
 /**
@@ -223,10 +311,13 @@ gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean i
  *
  * get a string representation for a date.
  * 
  *
  * get a string representation for a date.
  * 
- * Returns: the new display date, as a newly allocated string;
- * free with g_free
+ * Returns: the new display date, as a *static* string.
+ * This string should not be modified, and will change
+ * upon recalling this function. g_strdup it if you to
+ * do so.
+ * 
  */
  */
-gchar* modest_text_utils_get_display_date (time_t date);
+const gchar* modest_text_utils_get_display_date (time_t date);
 
 
 /**
 
 
 /**
@@ -238,18 +329,62 @@ gchar* modest_text_utils_get_display_date (time_t date);
  * Returns: the newly allocated display string for the
  * size in bytes. must be freed.
  */
  * Returns: the newly allocated display string for the
  * size in bytes. must be freed.
  */
-gchar * modest_text_utils_get_display_size (guint size);
+gchar * modest_text_utils_get_display_size (guint64 size);
+
 
 
 /**
 
 
 /**
+ * modest_text_utils_validate_domain_name:
+ * @email_address: a NULL-terminated string
+ * 
+ * validates the domain name passed as argument
+ * 
+ * Returns: TRUE if the domain name is valid, FALSE otherwise
+ **/
+gboolean modest_text_utils_validate_domain_name (const gchar *domain);
+
+/**
  * modest_text_utils_validate_email_address:
  * @email_address: a string
  * modest_text_utils_validate_email_address:
  * @email_address: a string
+ * @invalid_char_position: pointer to the position of the invalid
+ * character in case validation failed because of this, or %NULL.
  * 
  * validates the email address passed as argument
  * 
  * Returns: TRUE if the address is valid, FALSE otherwise
  **/
  * 
  * validates the email address passed as argument
  * 
  * Returns: TRUE if the address is valid, FALSE otherwise
  **/
-gboolean     modest_text_utils_validate_email_address (const gchar *email_address);
+gboolean     modest_text_utils_validate_email_address (const gchar *email_address, 
+                                                      const gchar **invalid_char_position);
+
+
+/**
+ * modest_text_utils_validate_folder_name:
+ * @folder_name: a string
+ * 
+ * validates the folder name passed as argument. a 'valid folder name'
+ * is a name which should be valid on both Unix and Windows file systems.
+ * of course, this might be stricter than strictly needed in some cases,
+ * but it's better to err on the safe side.
+ * 
+ * Returns: TRUE if the folder name is valid, FALSE otherwise
+ **/
+gboolean modest_text_utils_validate_folder_name (const gchar *folder_name);
+
+/**
+ * modest_text_utils_validate_recipient:
+ * @recipient: a string
+ * @invalid_char_position: pointer to the position of the invalid char,
+ * if validation failed because there's an invalid char there, or %NULL.
+ *
+ * validates @recipient as a valid recipient field for header.
+ * It's different from modest_text_utils_validate_email_address()
+ * as it validates a whole recipient, and not only the part between
+ * the &lt; and &gt; symbols.
+ *
+ * Returns: %TRUE if the recipient is valid, FALSE otherwise
+ **/
+gboolean     modest_text_utils_validate_recipient (const gchar *recipient,
+                                                  const gchar **invalid_char_position);
 
 /**
  * modest_text_utils_split_addresses_list:
 
 /**
  * modest_text_utils_split_addresses_list:
@@ -258,8 +393,172 @@ gboolean     modest_text_utils_validate_email_address (const gchar *email_addres
  * obtains a GSList of addresses from a string of addresses
  * in the format understood by email protocols
  *
  * obtains a GSList of addresses from a string of addresses
  * in the format understood by email protocols
  *
- * Returns: a GSList of strings
+ * Returns: a newly allocated GSList of strings
  **/
 GSList      *modest_text_utils_split_addresses_list (const gchar *addresses);
 
  **/
 GSList      *modest_text_utils_split_addresses_list (const gchar *addresses);
 
+/**
+ * modest_text_utils_join_addresses:
+ * @from: comma separated string of addresses
+ * @to: comma separated string of addresses
+ * @cc: comma separated string of addresses
+ * @bcc: comma separated string of addresses
+ *
+ * joins all the addresses in a single comma-separated string
+ *
+ * Returns: a newly allocated string with a list of addresses
+ **/
+gchar       *modest_text_utils_join_addresses (const gchar *from,
+                                              const gchar *to,
+                                              const gchar *cc,
+                                              const gchar *bcc);
+
+/**
+ * modest_text_utils_get_addresses_indexes:
+ * @addresses: a string
+ * @start_indexes: a #GSList pointer
+ * @end_indexes: a #GSList pointer
+ *
+ * obtains two #GSList of @addresses with the range offsets of the addresses in
+ * the string
+ *
+ * Returns: a GSList of strings
+ **/
+void         modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
+
+/**
+ * modest_text_utils_address_with_standard_length:
+ * @recipients_list: a string
+ *
+ * obtains the list of recipients, but making sure that lines are not longer than 1000 chars
+ *
+ * Returns: a newly allocated string
+ */
+gchar *      modest_text_utils_address_with_standard_length (const gchar *recipients_list);
+
+/**
+ * modest_text_utils_get_color_string:
+ * @color: a #GdkColor
+ *
+ * Obtains a proper markup string for @color, in the format used
+ * by Pango and HTML.
+ *
+ * Returns: a newly allocated string
+ */
+gchar *      modest_text_utils_get_color_string (GdkColor *color);
+
+/**
+ * modest_text_utils_text_buffer_get_text:
+ * @buffer: a #GtkTextBuffer
+ *
+ * Obtains the contents of a @buffer in a string, replacing image
+ * pixbufs with blank spaces.
+ *
+ * Returns: a newly allocated UTF-8 string
+ */
+gchar *      modest_text_utils_text_buffer_get_text (GtkTextBuffer *buffer);
+
+typedef enum {
+       ACCOUNT_TITLE_FORBIDDEN_CHARS,
+       FOLDER_NAME_FORBIDDEN_CHARS,
+       USER_NAME_FORBIDDEN_NAMES,
+} ModestTextUtilsForbiddenCharType;
+
+/**
+ * modest_text_utils_label_get_selection:
+ * @label: a #GtkLabel
+ *
+ * Obtain the current selection of @label
+ *
+ * Returns: a string with current selection, or %NULL if no selection in @label
+ */
+gchar *      modest_text_utils_label_get_selection (GtkLabel *label);
+
+/**
+ * modest_text_utils_is_forbidden_char:
+ * @character: some character
+ * @type: the type of forbidden char (see #ModestTextUtilsForbiddenCharType)
+ * 
+ * check whether the given character is 'forbidden'
+ *
+ * Returns: TRUE if it's forbidden, FALSE otherwise
+ */
+gboolean     modest_text_utils_is_forbidden_char (const gchar character,
+                                                 ModestTextUtilsForbiddenCharType type);
+
+/**
+ * modest_text_utils_buffer_selection_is_valid:
+ * @buffer: a #GtkTextBuffer
+ *
+ * Checks if @buffer contains a valid selection for cut/copy. This means it's
+ * not empty, and no images are in the selection.
+ *
+ * Returns: %TRUE if there's a valid selection, false otherwise.
+ */
+gboolean     modest_text_utils_buffer_selection_is_valid (GtkTextBuffer *buffer);
+
+/**
+ * modest_text_utils_escape_mnemonics:
+ * @text: a string
+ *
+ * obtains the representation of text, but escaping mnemonics (we duplicate _)
+ *
+ * Returns: a newly allocated string
+ */
+gchar *modest_text_utils_escape_mnemonics (const gchar *text);
+
+/**
+ * modest_text_utils_simplify_recipients:
+ * @recipients: a list of recipients
+ *
+ * returns a list of simplified recipients:
+ *   * a@b <a@b> converted to a@b
+ *   * NULL converted to ""
+ *
+ * It's mainly intended for printing in screen addresses, but it can
+ * also be used for reply/forward.
+ */
+gchar *modest_text_utils_simplify_recipients (const gchar *recipient);
+
+/**
+ * modest_text_utils_remove_duplicate_addresses_list
+ * @address_list: non-NULL #GSList of email addresses
+ *
+ * remove duplicate addresses from a list of email addresses
+ *
+ * Returns: a list without the duplicate addresses or NULL in case of
+ * error or the original @address_list was NULL
+ */
+GSList *modest_text_utils_remove_duplicate_addresses_list (GSList *address_list);
+
+/**
+ * modest_text_utils_get_secure_header:
+ * @value: the value of a mail header
+ * @header: the header that we're evaluating
+ *
+ * This function returns the secure value for a header. Basically it
+ * avoids DoS attacks caused by specially malformed headers like for
+ * example. From:From:From...From: some@mail.com
+ *
+ * Returns: returns the secured header
+ **/
+gchar * modest_text_utils_get_secure_header (const gchar *value, const gchar *header);
+
+/**
+ * modest_text_utils_quote_names:
+ * @recipients: a list of valid email addresses separated by ',' or ';'
+ *
+ * This function quotes the name part of an email address if it's not
+ * quoted and if it exists. For example
+ * aaa@bbb.com -> aaa@bbb.com
+ * "my name" <aaa@bbb.com> -> "my name" <aaa@bbb.com>
+ * my name aaa@bbb.com -> "my name" aaa@bbb.com
+ *
+ * It even supports things like
+ * my, name <aaa@bbb.com>, aaa@ccc.com -> "my, name" <aaa@bbb.com>; aaa@ccc.com
+ *
+ * Returns: a newly allocated string with the quoted email addresses
+ **/
+gchar * modest_text_utils_quote_names (const gchar *recipients);
+
 #endif /* __MODEST_TEXT_UTILS_H__ */
 #endif /* __MODEST_TEXT_UTILS_H__ */