2007-05-25 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-tny-send-queue.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
31 #include <modest-tny-send-queue.h>
32 #include <tny-simple-list.h>
33 #include <tny-iterator.h>
34 #include <tny-folder.h>
35 #include <tny-camel-msg.h>
36 #include <modest-tny-account.h>
37
38 /* 'private'/'protected' functions */
39 static void modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass);
40 static void modest_tny_send_queue_finalize   (GObject *obj);
41 static void modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class);
42
43 /* list my signals  */
44 enum {
45         /* MY_SIGNAL_1, */
46         /* MY_SIGNAL_2, */
47         LAST_SIGNAL
48 };
49
50 typedef struct _ModestTnySendQueuePrivate ModestTnySendQueuePrivate;
51 struct _ModestTnySendQueuePrivate {
52         /* empty */
53 };
54 #define MODEST_TNY_SEND_QUEUE_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
55                                                    MODEST_TYPE_TNY_SEND_QUEUE, \
56                                                    ModestTnySendQueuePrivate))
57 /* globals */
58 static TnyCamelSendQueueClass *parent_class = NULL;
59
60 /* uncomment the following if you have defined any signals */
61 /* static guint signals[LAST_SIGNAL] = {0}; */
62
63 /*
64  * this thread actually tries to send all the mails in the outbox
65  */
66
67
68 static void
69 modest_tny_send_queue_cancel (TnySendQueue *self, gboolean remove, GError **err)
70 {       
71         TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->cancel_func (self, remove, err); /* FIXME */
72 }
73
74 static void
75 modest_tny_send_queue_add (TnySendQueue *self, TnyMsg *msg, GError **err)
76 {
77         ModestTnySendQueuePrivate *priv; 
78         
79         g_return_if_fail (TNY_IS_SEND_QUEUE(self));
80         g_return_if_fail (TNY_IS_CAMEL_MSG(msg));
81         
82         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE (self);
83
84         /* FIXME: do something smart here... */
85         
86         TNY_CAMEL_SEND_QUEUE_CLASS(parent_class)->add_func (self, msg, err); /* FIXME */
87 }
88
89 static TnyFolder*
90 modest_tny_send_queue_get_sentbox (TnySendQueue *self)
91 {
92         TnyFolder *folder;
93         TnyCamelTransportAccount *account;
94
95         g_return_val_if_fail (self, NULL);
96
97         account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
98         if (!account) {
99                 g_printerr ("modest: no account for send queue\n");
100                 return NULL;
101         }
102         folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
103                                                          TNY_FOLDER_TYPE_SENT);
104         g_object_unref (G_OBJECT(account));
105
106         return folder;
107 }
108
109
110 static TnyFolder*
111 modest_tny_send_queue_get_outbox (TnySendQueue *self)
112 {
113         TnyFolder *folder;
114         TnyCamelTransportAccount *account;
115
116         g_return_val_if_fail (self, NULL);
117
118         account = tny_camel_send_queue_get_transport_account (TNY_CAMEL_SEND_QUEUE(self));
119         if (!account) {
120                 g_printerr ("modest: no account for send queue\n");
121                 return NULL;
122         }
123         folder  = modest_tny_account_get_special_folder (TNY_ACCOUNT(account),
124                                                          TNY_FOLDER_TYPE_OUTBOX);
125         g_object_unref (G_OBJECT(account));
126
127         return folder;
128 }
129
130
131 GType
132 modest_tny_send_queue_get_type (void)
133 {
134         static GType my_type = 0;
135
136         if (my_type == 0) {
137                 static const GTypeInfo my_info = {
138                         sizeof(ModestTnySendQueueClass),
139                         NULL,           /* base init */
140                         NULL,           /* base finalize */
141                         (GClassInitFunc) modest_tny_send_queue_class_init,
142                         NULL,           /* class finalize */
143                         NULL,           /* class data */
144                         sizeof(ModestTnySendQueue),
145                         0,              /* n_preallocs */
146                         (GInstanceInitFunc) modest_tny_send_queue_instance_init,
147                         NULL
148                 };
149                 my_type = g_type_register_static (TNY_TYPE_CAMEL_SEND_QUEUE,
150                                                   "ModestTnySendQueue",
151                                                   &my_info, 0);
152         }
153         return my_type;
154 }
155
156
157 static void
158 modest_tny_send_queue_class_init (ModestTnySendQueueClass *klass)
159 {
160         GObjectClass *gobject_class;
161
162         gobject_class = (GObjectClass*) klass;
163         
164         parent_class            = g_type_class_peek_parent (klass);
165         gobject_class->finalize = modest_tny_send_queue_finalize;
166
167         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->add_func         = modest_tny_send_queue_add;
168         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_outbox_func  = modest_tny_send_queue_get_outbox;
169         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->get_sentbox_func = modest_tny_send_queue_get_sentbox;
170         TNY_CAMEL_SEND_QUEUE_CLASS(klass)->cancel_func      = modest_tny_send_queue_cancel;
171
172         g_type_class_add_private (gobject_class, sizeof(ModestTnySendQueuePrivate));
173 }
174
175 static void
176 modest_tny_send_queue_instance_init (GTypeInstance *instance, gpointer g_class)
177 {
178    
179 }
180
181 static void
182 modest_tny_send_queue_finalize (GObject *obj)
183 {
184         G_OBJECT_CLASS(parent_class)->finalize (obj);
185 }
186
187 ModestTnySendQueue*
188 modest_tny_send_queue_new (TnyCamelTransportAccount *account)
189 {
190         ModestTnySendQueue *self;
191         ModestTnySendQueuePrivate *priv;
192         
193         g_return_val_if_fail (TNY_IS_CAMEL_TRANSPORT_ACCOUNT(account), NULL);
194         
195         self = MODEST_TNY_SEND_QUEUE(g_object_new(MODEST_TYPE_TNY_SEND_QUEUE, NULL));
196         priv = MODEST_TNY_SEND_QUEUE_GET_PRIVATE(self);
197         
198         tny_camel_send_queue_set_transport_account (TNY_CAMEL_SEND_QUEUE(self),
199                                                     account); 
200         return self;
201 }
202
203
204
205 void
206 modest_tny_send_queue_try_to_send (ModestTnySendQueue* self)
207 {
208         /* TODO: Rename this to tny_camel_send_queue_try_to_send() in tinymail 
209         and check that it works, without creating a second worker. */
210 /*      tny_camel_send_queue_flush (TNY_CAMEL_SEND_QUEUE(self)); */
211 }