* Fixes NB#87165, do not allow folder names like LTP* or COM*
[modest] / src / modest-local-folder-info.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include <glib/gi18n.h>
31 #include <string.h> /* strcmp */
32 #include <modest-local-folder-info.h>
33 #include <stdio.h>
34
35 typedef struct {
36         TnyFolderType   type;
37         const gchar     *name;
38         const gchar     *display_name;
39 } ModestLocalFolder;
40
41 const ModestLocalFolder ModestLocalFolderMap[] = {
42         { TNY_FOLDER_TYPE_UNKNOWN,  "<unknown>",  N_("<Unknown>")},
43         { TNY_FOLDER_TYPE_NORMAL,   "<normal>",   N_("<Normal>")},
44         { TNY_FOLDER_TYPE_OUTBOX,   "outbox",     N_("mcen_me_folder_outbox")},
45         { TNY_FOLDER_TYPE_TRASH,    "trash",      N_("Trash")},
46         { TNY_FOLDER_TYPE_JUNK,     "junk",       N_("Junk")},
47         { TNY_FOLDER_TYPE_SENT,     "sent",       N_("mcen_me_folder_sent")},
48         { TNY_FOLDER_TYPE_ROOT,     "<root>",     N_("<root>")},
49         { TNY_FOLDER_TYPE_NOTES,    "notes",      N_("Notes")},
50         { TNY_FOLDER_TYPE_DRAFTS,   "drafts",     N_("mcen_me_folder_drafts")},
51         { TNY_FOLDER_TYPE_ARCHIVE,  "archive",    N_("mcen_me_folder_archive")}
52 };
53
54
55 TnyFolderType
56 modest_local_folder_info_get_type (const gchar *name)
57 {
58         int i;
59         g_return_val_if_fail (name, TNY_FOLDER_TYPE_UNKNOWN);
60
61         for (i = 0; i != G_N_ELEMENTS(ModestLocalFolderMap); ++i) {
62                 if (strcmp (ModestLocalFolderMap[i].name, name) == 0)
63                         return ModestLocalFolderMap[i].type;
64         }
65         return TNY_FOLDER_TYPE_UNKNOWN;
66 }
67
68
69 const gchar*
70 modest_local_folder_info_get_type_name (TnyFolderType type)
71 {
72         int i = 0;
73         g_return_val_if_fail (type >= TNY_FOLDER_TYPE_UNKNOWN &&
74                               type <  TNY_FOLDER_TYPE_NUM, NULL);
75         
76         for (i = 0; i != G_N_ELEMENTS(ModestLocalFolderMap); ++i) {
77                 if (ModestLocalFolderMap[i].type == type)
78                         return ModestLocalFolderMap[i].name;
79         }
80         return NULL;    
81 }
82
83 const gchar*
84 modest_local_folder_info_get_type_display_name (TnyFolderType type)
85 {
86         int i = 0;
87         g_return_val_if_fail (type >= TNY_FOLDER_TYPE_UNKNOWN &&
88                               type <  TNY_FOLDER_TYPE_NUM, NULL);
89         
90         /* Note that we call _() to get the localized name.
91          * This works because we used N_() on the static string when we initialized the array,
92          * to mark the string for translation.
93          */
94         for (i = 0; i != G_N_ELEMENTS(ModestLocalFolderMap); ++i) {
95                 if (ModestLocalFolderMap[i].type == type)
96                         return _(ModestLocalFolderMap[i].display_name);
97         }
98         return NULL;    
99 }
100
101
102 gchar *
103 modest_local_folder_info_get_maildir_path (const gchar* location_filepath)
104 {
105         return g_build_filename (location_filepath ? location_filepath : g_get_home_dir(),
106                                  MODEST_DIR,
107                                  MODEST_LOCAL_FOLDERS_MAILDIR, 
108                                  NULL);
109 }
110
111 gchar*
112 modest_per_account_local_outbox_folder_info_get_maildir_path (const gchar* account_name)
113 {
114         /* This directory should contain an "outbox" child directory: */
115         return g_build_filename (g_get_home_dir(),
116                                  MODEST_DIR,
117                                  MODEST_PER_ACCOUNT_LOCAL_OUTBOX_FOLDERS_MAILDIR, 
118                                  account_name,
119                                  NULL);
120 }
121
122 gchar*
123 modest_per_account_local_outbox_folder_info_get_maildir_path_to_outbox_folder (const gchar* account_name)
124 {
125         gchar *path_to_account_folder = 
126                 modest_per_account_local_outbox_folder_info_get_maildir_path(account_name);
127         if (!path_to_account_folder)
128                 return NULL;
129
130         gchar *path = g_build_filename (path_to_account_folder, "outbox", NULL);
131
132         g_free (path_to_account_folder);
133
134         return path;
135 }
136
137
138