-
Notifications
You must be signed in to change notification settings - Fork 271
/
imap-client.c
1525 lines (1309 loc) · 43.3 KB
/
imap-client.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright (c) 2002-2018 Dovecot authors, see the included COPYING file */
#include "imap-common.h"
#include "ioloop.h"
#include "llist.h"
#include "str.h"
#include "hostpid.h"
#include "net.h"
#include "iostream.h"
#include "iostream-rawlog.h"
#include "istream.h"
#include "ostream.h"
#include "time-util.h"
#include "var-expand.h"
#include "master-service.h"
#include "imap-resp-code.h"
#include "imap-util.h"
#include "imap-urlauth.h"
#include "mail-error.h"
#include "mail-namespace.h"
#include "mail-storage-service.h"
#include "mail-autoexpunge.h"
#include "imap-state.h"
#include "imap-search.h"
#include "imap-notify.h"
#include "imap-commands.h"
#include <unistd.h>
/* If the last command took longer than this to run, log statistics on
where the time was spent. */
#define IMAP_CLIENT_DISCONNECT_LOG_STATS_CMD_MIN_RUNNING_MSECS 1000
extern struct mail_storage_callbacks mail_storage_callbacks;
extern struct imap_client_vfuncs imap_client_vfuncs;
struct imap_module_register imap_module_register = { 0 };
struct client *imap_clients = NULL;
unsigned int imap_client_count = 0;
static const char *client_command_state_names[CLIENT_COMMAND_STATE_DONE+1] = {
"wait-input",
"wait-output",
"wait-external",
"wait-unambiguity",
"wait-sync",
"done"
};
static void client_idle_timeout(struct client *client)
{
if (client->output_cmd_lock == NULL)
client_send_line(client, "* BYE Disconnected for inactivity.");
client_destroy(client, "Disconnected for inactivity");
}
static void client_init_urlauth(struct client *client)
{
struct imap_urlauth_config config;
i_zero(&config);
config.url_host = client->set->imap_urlauth_host;
config.url_port = client->set->imap_urlauth_port;
config.socket_path = t_strconcat(client->user->set->base_dir,
"/"IMAP_URLAUTH_SOCKET_NAME, NULL);
config.session_id = client->session_id;
config.access_user = client->user->username;
config.access_service = "imap";
config.access_anonymous = client->user->anonymous;
client->urlauth_ctx = imap_urlauth_init(client->user, &config);
}
static bool user_has_special_use_mailboxes(struct mail_user *user)
{
struct mail_namespace_settings *const *ns_set;
/*
* We have to iterate over namespace and mailbox *settings* since
* the namespaces haven't been set up yet. The namespaces haven't
* been set up so that we don't hold up the OK response to LOGIN
* when using slow lib-storage backends.
*/
/* no namespaces => no special use flags */
if (!array_is_created(&user->set->namespaces))
return FALSE;
array_foreach(&user->set->namespaces, ns_set) {
struct mailbox_settings *const *box_set;
/* no mailboxes => no special use flags */
if (!array_is_created(&(*ns_set)->mailboxes))
continue;
array_foreach(&(*ns_set)->mailboxes, box_set) {
if ((*box_set)->special_use != NULL)
return TRUE;
}
}
return FALSE;
}
struct client *client_create(int fd_in, int fd_out, const char *session_id,
struct event *event, struct mail_user *user,
struct mail_storage_service_user *service_user,
const struct imap_settings *set,
const struct smtp_submit_settings *smtp_set)
{
const struct mail_storage_settings *mail_set;
struct client *client;
const char *ident;
pool_t pool;
/* always use nonblocking I/O */
net_set_nonblock(fd_in, TRUE);
net_set_nonblock(fd_out, TRUE);
pool = pool_alloconly_create("imap client", 2048);
client = p_new(pool, struct client, 1);
client->pool = pool;
client->v = imap_client_vfuncs;
client->event = event;
event_ref(client->event);
client->set = set;
client->smtp_set = smtp_set;
client->service_user = service_user;
client->session_id = p_strdup(pool, session_id);
client->fd_in = fd_in;
client->fd_out = fd_out;
client->input = i_stream_create_fd(fd_in,
set->imap_max_line_length);
client->output = o_stream_create_fd(fd_out, (size_t)-1);
o_stream_set_no_error_handling(client->output, TRUE);
i_stream_set_name(client->input, "<imap client>");
o_stream_set_name(client->output, "<imap client>");
o_stream_set_flush_callback(client->output, client_output, client);
p_array_init(&client->module_contexts, client->pool, 5);
client->io = io_add_istream(client->input, client_input, client);
client->last_input = ioloop_time;
client->to_idle = timeout_add(CLIENT_IDLE_TIMEOUT_MSECS,
client_idle_timeout, client);
client->command_pool =
pool_alloconly_create(MEMPOOL_GROWING"client command", 1024*2);
client->user = user;
client->notify_count_changes = TRUE;
client->notify_flag_changes = TRUE;
if (set->rawlog_dir[0] != '\0') {
(void)iostream_rawlog_create(set->rawlog_dir, &client->input,
&client->output);
}
client->capability_string =
str_new(client->pool, sizeof(CAPABILITY_STRING)+64);
if (*set->imap_capability == '\0')
str_append(client->capability_string, CAPABILITY_STRING);
else if (*set->imap_capability != '+') {
str_append(client->capability_string, set->imap_capability);
} else {
str_append(client->capability_string, CAPABILITY_STRING);
str_append_c(client->capability_string, ' ');
str_append(client->capability_string, set->imap_capability + 1);
}
if (client->set->imap_literal_minus)
client_add_capability(client, "LITERAL-");
else
client_add_capability(client, "LITERAL+");
if (user->fuzzy_search) {
/* Enable FUZZY capability only when it actually has
a chance of working */
client_add_capability(client, "SEARCH=FUZZY");
}
mail_set = mail_user_set_get_storage_set(user);
if (mail_set->mailbox_list_index) {
/* NOTIFY is enabled only when mailbox list indexes are
enabled, although even that doesn't necessarily guarantee
it always */
client_add_capability(client, "NOTIFY");
}
if (*set->imap_urlauth_host != '\0' &&
*mail_set->mail_attribute_dict != '\0') {
/* Enable URLAUTH capability only when dict is
configured correctly */
client_init_urlauth(client);
client_add_capability(client, "URLAUTH");
client_add_capability(client, "URLAUTH=BINARY");
}
if (set->imap_metadata && *mail_set->mail_attribute_dict != '\0') {
client->imap_metadata_enabled = TRUE;
client_add_capability(client, "METADATA");
}
if (user_has_special_use_mailboxes(user)) {
/* Advertise SPECIAL-USE only if there are actually some
SPECIAL-USE flags in mailbox configuration. */
client_add_capability(client, "SPECIAL-USE");
}
ident = mail_user_get_anvil_userip_ident(client->user);
if (ident != NULL) {
master_service_anvil_send(master_service, t_strconcat(
"CONNECT\t", my_pid, "\timap/", ident, "\n", NULL));
client->anvil_sent = TRUE;
}
imap_client_count++;
DLLIST_PREPEND(&imap_clients, client);
if (hook_client_created != NULL)
hook_client_created(&client);
imap_refresh_proctitle();
return client;
}
int client_create_finish(struct client *client, const char **error_r)
{
if (mail_namespaces_init(client->user, error_r) < 0)
return -1;
mail_namespaces_set_storage_callbacks(client->user->namespaces,
&mail_storage_callbacks, client);
return 0;
}
void client_command_cancel(struct client_command_context **_cmd)
{
struct client_command_context *cmd = *_cmd;
bool cmd_ret;
switch (cmd->state) {
case CLIENT_COMMAND_STATE_WAIT_INPUT:
/* a bit kludgy check: cancel command only if it has context
set. currently only append command matches this check. all
other commands haven't even started the processing yet. */
if (cmd->context == NULL)
break;
/* fall through */
case CLIENT_COMMAND_STATE_WAIT_EXTERNAL:
case CLIENT_COMMAND_STATE_WAIT_OUTPUT:
cmd->cancel = TRUE;
break;
case CLIENT_COMMAND_STATE_WAIT_UNAMBIGUITY:
case CLIENT_COMMAND_STATE_WAIT_SYNC:
/* commands haven't started yet */
break;
case CLIENT_COMMAND_STATE_DONE:
i_unreached();
}
cmd_ret = !cmd->cancel || cmd->func == NULL ? TRUE :
command_exec(cmd);
if (!cmd_ret) {
if (cmd->client->output->closed)
i_panic("command didn't cancel itself: %s", cmd->name);
} else {
client_command_free(*_cmd != NULL ? _cmd : &cmd);
}
}
const char *client_stats(struct client *client)
{
const struct var_expand_table logout_tab[] = {
{ 'i', dec2str(i_stream_get_absolute_offset(client->input)), "input" },
{ 'o', dec2str(client->output->offset), "output" },
{ '\0', client->session_id, "session" },
{ '\0', dec2str(client->fetch_hdr_count), "fetch_hdr_count" },
{ '\0', dec2str(client->fetch_hdr_bytes), "fetch_hdr_bytes" },
{ '\0', dec2str(client->fetch_body_count), "fetch_body_count" },
{ '\0', dec2str(client->fetch_body_bytes), "fetch_body_bytes" },
{ '\0', dec2str(client->deleted_count), "deleted" },
{ '\0', dec2str(client->expunged_count), "expunged" },
{ '\0', dec2str(client->trashed_count), "trashed" },
{ '\0', dec2str(client->autoexpunged_count), "autoexpunged" },
{ '\0', dec2str(client->append_count), "appended" },
{ '\0', NULL, NULL }
};
const struct var_expand_table *user_tab =
mail_user_var_expand_table(client->user);
const struct var_expand_table *tab =
t_var_expand_merge_tables(logout_tab, user_tab);
string_t *str;
const char *error;
str = t_str_new(128);
if (var_expand_with_funcs(str, client->set->imap_logout_format,
tab, mail_user_var_expand_func_table,
client->user, &error) < 0) {
i_error("Failed to expand imap_logout_format=%s: %s",
client->set->imap_logout_format, error);
}
return str_c(str);
}
void client_destroy(struct client *client, const char *reason)
{
client->v.destroy(client, reason);
}
static void
client_command_stats_append(string_t *str,
const struct client_command_stats *stats,
const char *wait_condition,
size_t buffered_size)
{
uint64_t ioloop_wait_usecs;
unsigned int msecs_in_ioloop;
ioloop_wait_usecs = io_loop_get_wait_usecs(current_ioloop);
msecs_in_ioloop = (ioloop_wait_usecs -
stats->start_ioloop_wait_usecs + 999) / 1000;
str_printfa(str, "running for %d.%03d + waiting ",
(int)((stats->running_usecs+999)/1000 / 1000),
(int)((stats->running_usecs+999)/1000 % 1000));
if (wait_condition[0] != '\0')
str_printfa(str, "%s ", wait_condition);
str_printfa(str, "for %d.%03d secs",
msecs_in_ioloop / 1000, msecs_in_ioloop % 1000);
if (stats->lock_wait_usecs > 0) {
int lock_wait_msecs = (stats->lock_wait_usecs+999)/1000;
str_printfa(str, ", %d.%03d in locks",
lock_wait_msecs/1000, lock_wait_msecs%1000);
}
str_printfa(str, ", %"PRIu64" B in + %"PRIu64,
stats->bytes_in, stats->bytes_out);
if (buffered_size > 0)
str_printfa(str, "+%"PRIuSIZE_T, buffered_size);
str_append(str, " B out");
}
static const char *client_get_last_command_status(struct client *client)
{
if (client->logged_out)
return "";
if (client->last_cmd_name == NULL)
return " (No commands sent)";
/* client disconnected without sending LOGOUT. if the last command
took over 1 second to run, log it. */
const struct client_command_stats *stats = &client->last_cmd_stats;
string_t *str = t_str_new(128);
int last_run_secs = timeval_diff_msecs(&ioloop_timeval,
&stats->last_run_timeval);
str_printfa(str, " (%s finished %d.%03d secs ago",
client->last_cmd_name, last_run_secs/1000,
last_run_secs%1000);
if (timeval_diff_msecs(&stats->last_run_timeval, &stats->start_time) >=
IMAP_CLIENT_DISCONNECT_LOG_STATS_CMD_MIN_RUNNING_MSECS) {
str_append(str, " - ");
client_command_stats_append(str, stats, "", 0);
}
str_append_c(str, ')');
return str_c(str);
}
static const char *client_get_commands_status(struct client *client)
{
struct client_command_context *cmd, *last_cmd = NULL;
struct client_command_stats all_stats;
string_t *str;
enum io_condition cond;
const char *cond_str;
if (client->command_queue == NULL)
return client_get_last_command_status(client);
i_zero(&all_stats);
str = t_str_new(128);
str_append(str, " (");
for (cmd = client->command_queue; cmd != NULL; cmd = cmd->next) {
if (cmd->name == NULL) {
/* (parts of a) tag were received, but not yet
the command name */
continue;
}
str_append(str, cmd->name);
if (cmd->next != NULL)
str_append_c(str, ',');
all_stats.running_usecs += cmd->stats.running_usecs;
all_stats.lock_wait_usecs += cmd->stats.lock_wait_usecs;
all_stats.bytes_in += cmd->stats.bytes_in;
all_stats.bytes_out += cmd->stats.bytes_out;
last_cmd = cmd;
}
if (last_cmd == NULL)
return client_get_last_command_status(client);
cond = io_loop_find_fd_conditions(current_ioloop, client->fd_out);
if ((cond & (IO_READ | IO_WRITE)) == (IO_READ | IO_WRITE))
cond_str = "input/output";
else if ((cond & IO_READ) != 0)
cond_str = "input";
else if ((cond & IO_WRITE) != 0)
cond_str = "output";
else
cond_str = "nothing";
all_stats.start_ioloop_wait_usecs =
last_cmd->stats.start_ioloop_wait_usecs;
str_append_c(str, ' ');
client_command_stats_append(str, &all_stats, cond_str,
o_stream_get_buffer_used_size(client->output));
str_printfa(str, ", state=%s)",
client_command_state_names[last_cmd->state]);
return str_c(str);
}
static void client_log_disconnect(struct client *client, const char *reason)
{
i_info("%s %s", reason, client_stats(client));
}
static void client_default_destroy(struct client *client, const char *reason)
{
struct client_command_context *cmd;
i_assert(!client->destroyed);
client->destroyed = TRUE;
client->disconnected = TRUE;
if (client->disconnect_reason != NULL)
reason = client->disconnect_reason;
if (reason == NULL)
reason = t_strconcat(
io_stream_get_disconnect_reason(client->input,
client->output),
client_get_commands_status(client), NULL);
i_stream_close(client->input);
o_stream_close(client->output);
/* finish off all the queued commands. */
if (client->output_cmd_lock != NULL)
client_command_cancel(&client->output_cmd_lock);
while (client->command_queue != NULL) {
cmd = client->command_queue;
client_command_cancel(&cmd);
}
/* handle the input_lock command last. it might have been waiting on
other queued commands (although we probably should just drop the
command at that point since it hasn't started running. but this may
change in future). */
if (client->input_lock != NULL)
client_command_cancel(&client->input_lock);
if (client->mailbox != NULL)
imap_client_close_mailbox(client);
if (client->notify_ctx != NULL)
imap_notify_deinit(&client->notify_ctx);
if (client->urlauth_ctx != NULL)
imap_urlauth_deinit(&client->urlauth_ctx);
if (client->anvil_sent) {
master_service_anvil_send(master_service, t_strconcat(
"DISCONNECT\t", my_pid, "\timap/",
mail_user_get_anvil_userip_ident(client->user),
"\n", NULL));
}
if (client->free_parser != NULL)
imap_parser_unref(&client->free_parser);
io_remove(&client->io);
timeout_remove(&client->to_idle_output);
timeout_remove(&client->to_delayed_input);
timeout_remove(&client->to_idle);
/* i/ostreams are already closed at this stage, so fd can be closed */
fd_close_maybe_stdio(&client->fd_in, &client->fd_out);
/* Autoexpunging might run for a long time. Disconnect the client
before it starts, and refresh proctitle so it's clear that it's
doing autoexpunging. We've also sent DISCONNECT to anvil already,
because this is background work and shouldn't really be counted
as an active IMAP session for the user.
Don't autoexpunge if the client is hibernated - it shouldn't be any
different from the non-hibernating IDLE case. For frequent
hibernations it could also be doing unnecessarily much work. */
imap_refresh_proctitle();
if (!client->hibernated) {
client->autoexpunged_count = mail_user_autoexpunge(client->user);
client_log_disconnect(client, reason);
}
mail_user_unref(&client->user);
/* free the i/ostreams after mail_user_unref(), which could trigger
mail_storage_callbacks notifications that write to the ostream. */
i_stream_destroy(&client->input);
o_stream_destroy(&client->output);
if (array_is_created(&client->search_saved_uidset))
array_free(&client->search_saved_uidset);
if (array_is_created(&client->search_updates))
array_free(&client->search_updates);
pool_unref(&client->command_pool);
mail_storage_service_user_unref(&client->service_user);
imap_client_count--;
DLLIST_REMOVE(&imap_clients, client);
event_unref(&client->event);
i_free(client->last_cmd_name);
pool_unref(&client->pool);
master_service_client_connection_destroyed(master_service);
imap_refresh_proctitle();
}
static void client_destroy_timeout(struct client *client)
{
client_destroy(client, NULL);
}
void client_disconnect(struct client *client, const char *reason)
{
if (client->disconnected)
return;
client->disconnected = TRUE;
client->disconnect_reason = p_strdup(client->pool, reason);
/* Finish the ostream. With IMAP COMPRESS this sends the EOF marker. */
(void)o_stream_finish(client->output);
o_stream_uncork(client->output);
i_stream_close(client->input);
o_stream_close(client->output);
timeout_remove(&client->to_idle);
client->to_idle = timeout_add(0, client_destroy_timeout, client);
}
void client_disconnect_with_error(struct client *client, const char *msg)
{
client_send_line(client, t_strconcat("* BYE ", msg, NULL));
client_disconnect(client, msg);
}
void client_add_capability(struct client *client, const char *capability)
{
/* require a single capability at a time (feels cleaner) */
i_assert(strchr(capability, ' ') == NULL);
if (client->set->imap_capability[0] != '\0' &&
client->set->imap_capability[0] != '+') {
/* explicit capability - don't change it */
return;
}
str_append_c(client->capability_string, ' ');
str_append(client->capability_string, capability);
}
void client_send_line(struct client *client, const char *data)
{
(void)client_send_line_next(client, data);
}
int client_send_line_next(struct client *client, const char *data)
{
struct const_iovec iov[2];
if (client->output->closed)
return -1;
iov[0].iov_base = data;
iov[0].iov_len = strlen(data);
iov[1].iov_base = "\r\n";
iov[1].iov_len = 2;
if (o_stream_sendv(client->output, iov, 2) < 0)
return -1;
client->last_output = ioloop_time;
if (o_stream_get_buffer_used_size(client->output) >=
CLIENT_OUTPUT_OPTIMAL_SIZE) {
/* buffer full, try flushing */
return o_stream_flush(client->output);
}
return 1;
}
static void
client_cmd_append_timing_stats(struct client_command_context *cmd,
string_t *str)
{
unsigned int msecs_in_cmd, msecs_in_ioloop;
uint64_t ioloop_wait_usecs;
unsigned int msecs_since_cmd;
if (cmd->stats.start_time.tv_sec == 0)
return;
command_stats_flush(cmd);
ioloop_wait_usecs = io_loop_get_wait_usecs(current_ioloop);
msecs_in_cmd = (cmd->stats.running_usecs + 999) / 1000;
msecs_in_ioloop = (ioloop_wait_usecs -
cmd->stats.start_ioloop_wait_usecs + 999) / 1000;
msecs_since_cmd = timeval_diff_msecs(&ioloop_timeval,
&cmd->stats.last_run_timeval);
if (str_data(str)[str_len(str)-1] == '.')
str_truncate(str, str_len(str)-1);
str_printfa(str, " (%d.%03d + %d.%03d ",
msecs_in_cmd / 1000, msecs_in_cmd % 1000,
msecs_in_ioloop / 1000, msecs_in_ioloop % 1000);
if (msecs_since_cmd > 0) {
str_printfa(str, "+ %d.%03d ",
msecs_since_cmd / 1000, msecs_since_cmd % 1000);
}
str_append(str, "secs).");
}
void client_send_tagline(struct client_command_context *cmd, const char *data)
{
cmd->client->v.send_tagline(cmd, data);
}
static void
client_default_send_tagline(struct client_command_context *cmd, const char *data)
{
struct client *client = cmd->client;
const char *tag = cmd->tag;
if (client->output->closed || cmd->cancel)
return;
i_assert(!cmd->tagline_sent);
cmd->tagline_sent = TRUE;
cmd->tagline_reply = p_strdup(cmd->pool, data);
if (tag == NULL || *tag == '\0')
tag = "*";
T_BEGIN {
string_t *str = t_str_new(256);
str_printfa(str, "%s %s", tag, data);
client_cmd_append_timing_stats(cmd, str);
str_append(str, "\r\n");
o_stream_nsend(client->output, str_data(str), str_len(str));
} T_END;
client->last_output = ioloop_time;
}
static int
client_default_sync_notify_more(struct imap_sync_context *ctx ATTR_UNUSED)
{
return 1;
}
void client_send_command_error(struct client_command_context *cmd,
const char *msg)
{
struct client *client = cmd->client;
const char *error, *cmd_name;
enum imap_parser_error parse_error;
if (msg == NULL) {
msg = imap_parser_get_error(cmd->parser, &parse_error);
switch (parse_error) {
case IMAP_PARSE_ERROR_NONE:
i_unreached();
case IMAP_PARSE_ERROR_LITERAL_TOO_BIG:
client_disconnect_with_error(client, msg);
return;
default:
break;
}
}
if (cmd->tag == NULL)
error = t_strconcat("BAD Error in IMAP tag: ", msg, NULL);
else if (cmd->name == NULL)
error = t_strconcat("BAD Error in IMAP command: ", msg, NULL);
else {
cmd_name = t_str_ucase(cmd->name);
error = t_strconcat("BAD Error in IMAP command ",
cmd_name, ": ", msg, NULL);
}
client_send_tagline(cmd, error);
if (++client->bad_counter >= CLIENT_MAX_BAD_COMMANDS) {
client_disconnect_with_error(client,
"Too many invalid IMAP commands.");
}
cmd->param_error = TRUE;
/* client_read_args() failures rely on this being set, so that the
command processing is stopped even while command function returns
FALSE. */
cmd->state = CLIENT_COMMAND_STATE_DONE;
}
void client_send_internal_error(struct client_command_context *cmd)
{
client_send_tagline(cmd,
t_strflocaltime("NO "MAIL_ERRSTR_CRITICAL_MSG_STAMP, ioloop_time));
}
bool client_read_args(struct client_command_context *cmd, unsigned int count,
unsigned int flags, const struct imap_arg **args_r)
{
string_t *str;
int ret;
i_assert(count <= INT_MAX);
ret = imap_parser_read_args(cmd->parser, count, flags, args_r);
if (ret >= (int)count) {
/* all parameters read successfully */
i_assert(cmd->client->input_lock == NULL ||
cmd->client->input_lock == cmd);
str = t_str_new(256);
imap_write_args(str, *args_r);
cmd->args = p_strdup(cmd->pool, str_c(str));
str_truncate(str, 0);
imap_write_args_for_human(str, *args_r);
cmd->human_args = p_strdup(cmd->pool, str_c(str));
cmd->client->input_lock = NULL;
return TRUE;
} else if (ret == -2) {
/* need more data */
if (cmd->client->input->closed) {
/* disconnected */
cmd->state = CLIENT_COMMAND_STATE_DONE;
}
return FALSE;
} else {
/* error, or missing arguments */
client_send_command_error(cmd, ret < 0 ? NULL :
"Missing arguments");
return FALSE;
}
}
bool client_read_string_args(struct client_command_context *cmd,
unsigned int count, ...)
{
const struct imap_arg *imap_args;
va_list va;
const char *str;
unsigned int i;
if (!client_read_args(cmd, count, 0, &imap_args))
return FALSE;
va_start(va, count);
for (i = 0; i < count; i++) {
const char **ret = va_arg(va, const char **);
if (IMAP_ARG_IS_EOL(&imap_args[i])) {
client_send_command_error(cmd, "Missing arguments.");
break;
}
if (!imap_arg_get_astring(&imap_args[i], &str)) {
client_send_command_error(cmd, "Invalid arguments.");
break;
}
if (ret != NULL)
*ret = str;
}
va_end(va);
return i == count;
}
static struct client_command_context *
client_command_find_with_flags(struct client_command_context *new_cmd,
enum command_flags flags,
enum client_command_state max_state)
{
struct client_command_context *cmd;
cmd = new_cmd->client->command_queue;
for (; cmd != NULL; cmd = cmd->next) {
/* The tagline_sent check is a bit kludgy here. Plugins may
hook into sync_notify_more() and send the tagline before
finishing the command. During this stage the state was been
dropped from _WAIT_SYNC to _WAIT_OUTPUT, so the <= max_state
check doesn't work correctly here. (Perhaps we should add
a new _WAIT_SYNC_OUTPUT?) */
if (cmd->state <= max_state && !cmd->tagline_sent &&
cmd != new_cmd && (cmd->cmd_flags & flags) != 0)
return cmd;
}
return NULL;
}
static bool client_command_is_ambiguous(struct client_command_context *cmd)
{
enum command_flags flags;
enum client_command_state max_state =
CLIENT_COMMAND_STATE_WAIT_UNAMBIGUITY;
bool broken_client = FALSE;
if ((cmd->cmd_flags & COMMAND_FLAG_REQUIRES_SYNC) != 0 &&
!imap_sync_is_allowed(cmd->client))
return TRUE;
if (cmd->search_save_result_used) {
/* if there are pending commands that update the search
save result, wait */
struct client_command_context *old_cmd = cmd->next;
for (; old_cmd != NULL; old_cmd = old_cmd->next) {
if (old_cmd->search_save_result)
return TRUE;
}
}
if ((cmd->cmd_flags & COMMAND_FLAG_BREAKS_MAILBOX) ==
COMMAND_FLAG_BREAKS_MAILBOX) {
/* there must be no other command running that uses the
selected mailbox */
flags = COMMAND_FLAG_USES_MAILBOX;
max_state = CLIENT_COMMAND_STATE_DONE;
} else if ((cmd->cmd_flags & COMMAND_FLAG_USES_SEQS) != 0) {
/* no existing command must be breaking sequences */
flags = COMMAND_FLAG_BREAKS_SEQS;
broken_client = TRUE;
} else if ((cmd->cmd_flags & COMMAND_FLAG_BREAKS_SEQS) != 0) {
/* if existing command uses sequences, we'll have to block */
flags = COMMAND_FLAG_USES_SEQS;
} else {
return FALSE;
}
if (client_command_find_with_flags(cmd, flags, max_state) == NULL) {
if (cmd->client->syncing) {
/* don't do anything until syncing is finished */
return TRUE;
}
if (cmd->client->mailbox_change_lock != NULL &&
cmd->client->mailbox_change_lock != cmd) {
/* don't do anything until mailbox is fully
opened/closed */
return TRUE;
}
return FALSE;
}
if (broken_client) {
client_send_line(cmd->client,
"* BAD ["IMAP_RESP_CODE_CLIENTBUG"] "
"Command pipelining results in ambiguity.");
}
return TRUE;
}
struct client_command_context *client_command_alloc(struct client *client)
{
struct client_command_context *cmd;
cmd = p_new(client->command_pool, struct client_command_context, 1);
cmd->client = client;
cmd->pool = client->command_pool;
cmd->event = event_create(client->event);
cmd->stats.start_time = ioloop_timeval;
cmd->stats.last_run_timeval = ioloop_timeval;
cmd->stats.start_ioloop_wait_usecs =
io_loop_get_wait_usecs(current_ioloop);
p_array_init(&cmd->module_contexts, cmd->pool, 5);
DLLIST_PREPEND(&client->command_queue, cmd);
client->command_queue_size++;
imap_client_notify_command_allocated(client);
return cmd;
}
void client_command_init_finished(struct client_command_context *cmd)
{
event_add_str(cmd->event, "tag", cmd->tag);
event_add_str(cmd->event, "name", t_str_ucase(cmd->name));
if (cmd->args != NULL)
event_add_str(cmd->event, "args", cmd->args);
if (cmd->human_args != NULL)
event_add_str(cmd->event, "human_args", cmd->human_args);
}
static struct client_command_context *
client_command_new(struct client *client)
{
struct client_command_context *cmd;
cmd = client_command_alloc(client);
if (client->free_parser != NULL) {
cmd->parser = client->free_parser;
client->free_parser = NULL;
} else {
cmd->parser =
imap_parser_create(client->input, client->output,
client->set->imap_max_line_length);
if (client->set->imap_literal_minus)
imap_parser_enable_literal_minus(cmd->parser);
}
return cmd;
}
void client_add_missing_io(struct client *client)
{
if (client->io == NULL && !client->disconnected)
client->io = io_add_istream(client->input, client_input, client);
}
void client_command_free(struct client_command_context **_cmd)
{
struct client_command_context *cmd = *_cmd;
struct client *client = cmd->client;
enum client_command_state state = cmd->state;
*_cmd = NULL;
i_assert(!cmd->executing);
i_assert(client->output_cmd_lock == NULL);
/* reset input idle time because command output might have taken a
long time and we don't want to disconnect client immediately then */
client->last_input = ioloop_time;
timeout_reset(client->to_idle);
if (cmd->cancel) {
cmd->cancel = FALSE;
client_send_tagline(cmd, "NO Command cancelled.");
}
i_free(client->last_cmd_name);
client->last_cmd_name = i_strdup(cmd->name);
client->last_cmd_stats = cmd->stats;
if (!cmd->param_error)
client->bad_counter = 0;
if (client->input_lock == cmd)
client->input_lock = NULL;
if (client->mailbox_change_lock == cmd)
client->mailbox_change_lock = NULL;
event_set_name(cmd->event, "imap_command_finished");
if (cmd->tagline_reply != NULL) {
event_add_str(cmd->event, "tagged_reply_state",
t_strcut(cmd->tagline_reply, ' '));
event_add_str(cmd->event, "tagged_reply", cmd->tagline_reply);
}
event_add_timeval(cmd->event, "last_run_time",
&cmd->stats.last_run_timeval);
event_add_int(cmd->event, "running_usecs", cmd->stats.running_usecs);
event_add_int(cmd->event, "lock_wait_usecs", cmd->stats.lock_wait_usecs);
event_add_int(cmd->event, "bytes_in", cmd->stats.bytes_in);
event_add_int(cmd->event, "bytes_out", cmd->stats.bytes_out);
e_debug(cmd->event, "Command finished: %s %s", cmd->name,
cmd->human_args != NULL ? cmd->human_args : "");
event_unref(&cmd->event);
if (cmd->parser != NULL) {
if (client->free_parser == NULL) {
imap_parser_reset(cmd->parser);
client->free_parser = cmd->parser;
} else {
imap_parser_unref(&cmd->parser);
}
}
client->command_queue_size--;
DLLIST_REMOVE(&client->command_queue, cmd);
cmd = NULL;
if (client->command_queue == NULL) {
/* no commands left in the queue, we can clear the pool */
p_clear(client->command_pool);
timeout_remove(&client->to_idle_output);
}
imap_client_notify_command_freed(client);
imap_refresh_proctitle();
/* if command finished from external event, check input for more
unhandled commands since we may not be executing from client_input
or client_output. */
if (state == CLIENT_COMMAND_STATE_WAIT_EXTERNAL &&
!client->disconnected) {
client_add_missing_io(client);
if (client->to_delayed_input == NULL) {
client->to_delayed_input =
timeout_add(0, client_input, client);
}
}