2007-05-15 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-protocol-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-protocol-info.h>
33 #include <modest-pair.h>
34
35
36 typedef struct {
37         gint   proto;
38         const gchar*     name;
39         const gchar*     display_name;
40 } ProtocolInfo;
41
42 static const ProtocolInfo TransportStoreProtocolMap[] = {
43         { MODEST_PROTOCOL_TRANSPORT_SENDMAIL, "sendmail", N_("Sendmail") },
44         { MODEST_PROTOCOL_TRANSPORT_SMTP,     "smtp",     N_("SMTP Server") },
45         
46         { MODEST_PROTOCOL_STORE_POP,          "pop",      N_("POP3") },
47         { MODEST_PROTOCOL_STORE_IMAP,         "imap",     N_("IMAPv4") },
48         { MODEST_PROTOCOL_STORE_MAILDIR,      "maildir",  N_("Maildir") },
49         { MODEST_PROTOCOL_STORE_MBOX,         "mbox",     N_("MBox") }
50 };
51
52 static const ProtocolInfo ConnectionProtocolMap[] = {
53         { MODEST_PROTOCOL_CONNECTION_NORMAL,    "none",     N_("None") },   
54         { MODEST_PROTOCOL_CONNECTION_SSL,       "ssl",      N_("SSL") },   
55         { MODEST_PROTOCOL_CONNECTION_TLS,       "tls",      N_("TLS") },
56         { MODEST_PROTOCOL_CONNECTION_TLS_OP,    "tls-op",   N_("TLS when possible") }
57         /* op stands for optional */
58 };
59 static const ProtocolInfo AuthProtocolMap[] = {
60         { MODEST_PROTOCOL_AUTH_NONE,          "none",     N_("None") },
61         { MODEST_PROTOCOL_AUTH_PASSWORD,      "password", N_("Password") },
62         { MODEST_PROTOCOL_AUTH_CRAMMD5,       "cram-md5", N_("Cram MD5") }
63 };
64
65
66 static ModestPairList*
67 get_protocol_pair_list (const ProtocolInfo* map, guint size)
68 {
69         g_return_val_if_fail (map, NULL);
70
71         ModestPairList *proto_list = NULL;      
72         int i;
73         for (i = 0; i != size; ++i) {
74                 const ProtocolInfo info = map[i];
75                 proto_list = g_slist_append (proto_list,
76                                              (gpointer)modest_pair_new(
77                                                      (gpointer)info.name,
78                                                      (gpointer)info.display_name,
79                                                      FALSE));                   
80         }
81         return proto_list;
82 }
83
84
85 ModestPairList*
86 modest_protocol_info_get_transport_store_protocol_pair_list ()
87 {
88         return get_protocol_pair_list (TransportStoreProtocolMap,
89                 G_N_ELEMENTS(TransportStoreProtocolMap));
90 }
91
92 ModestPairList*
93 modest_protocol_info_get_auth_protocol_pair_list ()
94 {
95         return get_protocol_pair_list (AuthProtocolMap,
96                 G_N_ELEMENTS(AuthProtocolMap));
97 }
98
99 ModestPairList*
100 modest_protocol_info_get_connection_protocol_pair_list ()
101 {
102         return get_protocol_pair_list (ConnectionProtocolMap,
103                 G_N_ELEMENTS(ConnectionProtocolMap));
104 }
105         
106
107 ModestTransportStoreProtocol
108 modest_protocol_info_get_transport_store_protocol (const gchar* name)
109 {
110         const ProtocolInfo *map = TransportStoreProtocolMap;
111         const guint size = G_N_ELEMENTS(TransportStoreProtocolMap);
112         int i;
113         
114         g_return_val_if_fail (name, MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN);
115         
116         g_return_val_if_fail (map, MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN);
117
118         for (i = 0; i != size; ++i) {
119                 const ProtocolInfo info = map[i];
120                 if (strcmp(name, info.name) == 0)
121                         return info.proto;
122         }
123         
124         return MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN;
125 }
126
127
128
129 /* get either the name or the display_name for the protocol */
130 static const gchar*
131 get_protocol_string (gint proto, const ProtocolInfo* map, guint size, gboolean get_name)
132 {
133         g_return_val_if_fail (map, NULL);
134         
135         int i;
136         for (i = 0; i != size; ++i) {
137                 ProtocolInfo info = map[i];
138                 if (info.proto == proto)
139                         return get_name ? info.name : info.display_name;        
140         }
141         g_return_val_if_reached (NULL);
142 }
143
144 const gchar*
145 modest_protocol_info_get_transport_store_protocol_name (ModestTransportStoreProtocol proto)
146 {
147         return get_protocol_string (proto, TransportStoreProtocolMap,
148                 G_N_ELEMENTS(TransportStoreProtocolMap), TRUE);
149 }
150
151 const gchar*
152 modest_protocol_info_get_auth_protocol_name (ModestAuthProtocol proto)
153 {
154         return get_protocol_string (proto, AuthProtocolMap,
155                 G_N_ELEMENTS(AuthProtocolMap), TRUE);
156 }
157
158 const gchar*
159 modest_protocol_info_get_connection_protocol_name (ModestAuthProtocol proto)
160 {
161         return get_protocol_string (proto, ConnectionProtocolMap,
162                 G_N_ELEMENTS(ConnectionProtocolMap), TRUE);
163 }
164
165
166 gboolean
167 modest_protocol_info_protocol_is_local_store (ModestTransportStoreProtocol proto)
168 {
169         return proto == MODEST_PROTOCOL_STORE_MBOX || proto == MODEST_PROTOCOL_STORE_MAILDIR;
170 }
171
172
173
174 gboolean
175 modest_protocol_info_protocol_is_store (ModestTransportStoreProtocol proto)
176 {
177         return proto == MODEST_PROTOCOL_STORE_MBOX || proto == MODEST_PROTOCOL_STORE_MAILDIR ||
178                 proto == MODEST_PROTOCOL_STORE_POP || proto == MODEST_PROTOCOL_STORE_IMAP;
179 }
180
181