X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-text-utils.h;h=59c0714ef2d50744c5b87bd21c6dbd420c7231b2;hp=3f5bb686c297b8836fdad88082e3a9b50c4e0f6d;hb=a31e3b7e2d3779420c9e0b62fc0ffba214137f0e;hpb=4c17eac51757809148b84e229bede6323aac270a diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index 3f5bb68..59c0714 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -34,37 +34,531 @@ #define __MODEST_TEXT_UTILS_H__ #include +#include +#include +#include +#include + +#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: + * @subject: a string which contains the original subject + * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'), + * must not be NULL + * + * create a 'derived' subject line for eg. replies and forwards + * + * Returns: a newly allocated string containing the resulting subject + * subject == NULL, then @prefix " " will be returned + */ +gchar* modest_text_utils_derived_subject (const gchar *subject, + const gchar* prefix); -/* public */ /** * modest_text_utils_quote: - * @buf: a string which contains the message to quote - * @from: the sender of the original message + * @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 + * @attachments: a #GList of the attachments * @limit: specifies the maximum characters per line in the quoted text * - * Returns: a string containing the quoted message + * quote an existing message + * + * Returns: a newly allocated string containing the quoted message + */ +gchar* modest_text_utils_quote (const gchar *text, + const gchar *content_type, + const gchar *signature, + const gchar *from, + const time_t sent_date, + GList *attachments, + int limit); + + +/** + * modest_text_utils_cited_text: + * @from: sender of the message + * @sent_date: the sent date of the original message + * @text: the text of the original message + * + * cite the text in a message + * + * Returns: a newly allocated string containing the cited text + */ +gchar* modest_text_utils_cite (const gchar *text, + const gchar *content_type, + const gchar *signature, + const gchar *from, + time_t sent_date); + +/** + * modest_text_utils_inlined_text + * @from: the non-NULL sender of the original message + * @sent_date: sent date/time of the original message + * @to: + * @subject: + * @text: + * + * creates a new string with the "Original message" text prepended to + * the text passed as argument and some data of the header + * + * Returns: a newly allocated string containing the quoted message + */ +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 *subject); + +/** + * modest_text_utils_remove_address + * @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 + * 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 + */ +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: + * @address_list: non-NULL utf8 string containing a list of addresses + * @position: a gint + * @start: a gint pointer + * @end: a gint pointer + * + * Finds the start and end positions of the address at @position, + * in @recipients_list, a list of addresses in the format of a + * recipient list in email. It stores the results in @start and + * @end */ -gchar* modest_text_utils_quote(const gchar *buf, - const gchar *from, - const time_t sent_date, - const int limit); +void modest_text_utils_address_range_at_position (const gchar *recipients_list, + guint position, + guint *start, + guint *end); -gchar* modest_text_utils_create_reply_subject (const gchar *subject); +/** + * 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); -gchar* modest_text_utils_create_forward_subject (const gchar *subject); +/** + * 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); -gchar* modest_text_utils_create_cited_text (const gchar *from, - time_t sent_date, - const gchar *text); +/** + * modest_text_utils_convert_to_html: + * @txt: a string + * + * convert plain text (utf8) into html + * + * Returns: a newly allocated string containing the html + */ +gchar* modest_text_utils_convert_to_html (const gchar *txt); -gchar* modest_text_utils_create_inlined_text (const gchar *from, - time_t sent_date, - const gchar *to, - const gchar *subject, - const gchar *text); +/** + * modest_text_utils_convert_to_html_body: + * @txt: a string + * + * convert plain text (utf8) into html without adding html headers. + * + * Returns: a newly allocated string containing the html + */ +gchar* modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gboolean hyperlinkify); + + +/** + * modest_text_utils_strftime: + * @s: + * @max: + * @fmt: + * @timet: + * + * this is just an alias for strftime(3), so we can use that without + * getting warning from gcc + * + * Returns: a formatted string of max length @max in @s + */ +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_address: + * @address: original address (UTF8 string) + * + * make a 'display address' from an address: + * "Foo Bar <foo@bar.cx>" --> "Foo Bar" + * ie. removes "<...>" 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 (Bla)" --> "foo@bar.cx" + * If no "<...>" is found, then it returns the full + * strings. + * + * Returns: a newly allocated string with the copy. + * + * NULL in case of error or if address == NULL + */ +gchar* modest_text_utils_get_email_address (const gchar *email_address); + + +/** + * modest_text_utils_get_subject_prefix_len: + * @subject: original subject (UTF8 string) + * + * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address + * + * Returns: the length of the prefix, or 0 if there is none + */ +gint modest_text_utils_get_subject_prefix_len (const gchar *subject); + + +/** + * modest_text_utils_utf8_strcmp: + * @s1: the first string + * @s2: the second string + * @insensitive: should the comparison be case-insensitive? + * + * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison + * + * Returns: an integer less than, equal to, or greater than zero if s1 is found, + * respectively, to be less than, to match, or be greater than s2. + */ +gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive); + + + +/** + * modest_text_utils_get_display_date: + * @date: the date to display + * + * get a string representation for a date. + * + * 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. + * + */ +const gchar* modest_text_utils_get_display_date (time_t date); + + +/** + * modest_text_utils_get_display_size: + * @size: size in bytes + * + * get a string representation for a size in bytes. + * + * Returns: the newly allocated display string for the + * size in bytes. must be freed. + */ +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 + * @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 + **/ +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 < and > 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: + * @addresses: a string + * + * obtains a GSList of addresses from a string of addresses + * in the format understood by email protocols + * + * Returns: a newly allocated GSList of strings + **/ +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 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" -> "my name" + * my name aaa@bbb.com -> "my name" aaa@bbb.com + * + * It even supports things like + * my, name , aaa@ccc.com -> "my, name" ; aaa@ccc.com + * + * Returns: a newly allocated string with the quoted email addresses + **/ +gchar * modest_text_utils_quote_names (const gchar *recipients); -gchar* modest_text_utils_remove_mail_from_mail_list (const gchar *emails, - const gchar *email); #endif /* __MODEST_TEXT_UTILS_H__ */