summaryrefslogtreecommitdiffstats
path: root/lib/App/ImapNotify/ImapClient.pm
blob: c57204f74b8b5394778e2aed2a005d148fe3936c (plain)
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
package App::ImapNotify::ImapClient;
use v5.24;
use strict;
use warnings;

use App::ImapNotify::Socket::SSL;

use autodie;
use Carp;
use Data::Dumper;
use Function::Parameters;
use Log::Any qw($log);
use Time::HiRes;
use Time::Out qw(timeout);

=head1 NAME

App::ImapNotify::ImapClient - ShortDesc

=head1 SYNOPSIS

  use App::ImapNotify::ImapClient;

  # synopsis...

=head1 DESCRIPTION

# longer description...


=head1 INTERFACE


=head1 DEPENDENCIES


=head1 SEE ALSO

L<App::ImapNotify>

=cut

method new($class: $config, $deps = {}) {
	$deps->{sock} //= App::ImapNotify::Socket::SSL->new($config->@{qw(host port)});
	$config->{keepalive_timeout} //= 300;
	return $class->new_no_defaults($config, $deps);
}

method new_no_defaults($class: $config, $deps = {}) {
	my $self = {};
	bless $self, $class;
	$self->{log_id} = $config->{log_id};
	$self->{keepalive_timeout} = $config->{keepalive_timeout};
	$self->{line_buffer} = [];
	$self->{deps} = $deps;
	$self->{config} = $config;
	return $self;
}

method reconnect() {
	$self->{command_counter} = 0;
	$self->{deps}->{sock}->reconnect();
	my $response = $self->readline_block();
	croak("Lost connection while waiting for server greeting") if not defined $response;

	if ($response !~ m/^\* OK (.*)/) {
		confess "Invalid server greeting. Got reply: '$response'";
	}

	$self->{capabilities} = $1;

	$self->_login();
}

method _login() {
	if ($self->{capabilities} !~ m/\bAUTH=PLAIN\b/) {
		croak "Server doesn't support AUTH=PLAIN";
	}

	my $response = $self->send_command("login $self->{config}->{username} $self->{config}->{password}", "login $self->{config}->{username} [...]");
	return if not defined $response;

	confess "No capabilities found in response: '".$response->[0]."'" unless $response->[0] =~ m/^OK \[(.*)\].*$/;
	$self->{capabilities} = $1;

	if ($self->{capabilities} !~ m/\bNOTIFY\b/) {
		croak "Server doesn't support NOTIFY";
	}
}

method select($mailbox) {
	# TODO: seems like select is needed to be able to access newly added UIDs. maybe find a better fix than removing this optimization or look in the standard what's going on here?
	#if ($self->{current_mailbox} ne $mailbox) {
		$self->send_command("select $mailbox");
	#	$self->{current_mailbox} = $mailbox;
	#}
}


method send_command($command, $log_command = undef) {
	my $id = "CMD-".$self->{command_counter}++;

	chomp($command);

	$log_command = $command if !defined $log_command;

	$self->writeline("$id $command\r\n", "$id $log_command");

	my @lines;

	while (my $line = $self->readline_block()) {
		# TODO: this is probably not correct, but seems to be enough for now. a correct way should probably check that the fetch reply actually corresponds to the fetch command. probably best to check if the UID is the same.
		if ($command =~ /^uid fetch /i and $line =~ /^(\* \d+ FETCH .*\r\n)/) {
			push @lines, $self->handle_fetch($1)->@*;
			next;
		} elsif ($line =~/^(\* \d+ FETCH .*\r\n)/) {
			push @lines, $line, $self->handle_fetch($1)->@*;
			next;
		}

		if ($line =~ m/^$id (OK .*\r\n)$/) {
			push @lines, $1;
			return \@lines;
		} elsif ($line =~ /^$id /) {
			croak "Command '$command' failed. Got reply: $line";
		}

		if ($line =~ /^(.*\r\n)$/) {
			push @lines, $1;
		}
	}

	croak("Lost connection while waiting for reply to command '$command'");
	return;
}

method get_uids($mailbox) {
	$self->select($mailbox);
	my $response = $self->send_command("UID FETCH 1:* (UID)");
	pop @$response;

	@$response = map {s/^.* FETCH \(UID ([0-9]+)\)$/$1/r} @$response;
	return $response;
}

method handle_fetch($first_line) {
	if ($first_line =~ m/^\* \d+ FETCH \(.* \{(?<bytes>\d+)\}\r\n$/) {
		my $bytes = $+{bytes};
		my $read = 0;
		my @lines = ();
		while ($read < $bytes) {
			my $line = $self->readline_block();
			$read += length($line);
			push @lines, $line;

			#print "Got total of $read bytes. data = --'$data'--";
		}
		my $line = $self->readline_block();
		if ($line ne ")\r\n") {
			confess "Expected closing brace after data. Got: '$line'";
		}
		push @lines, $line;
		return \@lines;
	} else {
		confess "First line doesn't match FETCH pattern. Line is: '$first_line'";
	}
}

method writeline($line, $log_line) {
	$log->tracef("%s   >> %s", $self->{log_id}, $log_line);
	return $self->{deps}->{sock}->writeline($line);
}

method readline_block() {
	if ($self->{line_buffer}->@* > 0) {
		return $self->_readline_buffer();
	}

	my $response = $self->{deps}->{sock}->readline();
	if (defined $response) {
		$log->tracef("%s <<   %s", $self->{log_id}, $response =~ s/\r\n$//r);
	} else {
		$log->tracef("%s input stream closed (read undef)", $self->{log_id});
	}
	return $response;
}

method readline_timeout() {
	my $timeout = $self->{keepalive_timeout};

	while (1) {
		my $ret = timeout $timeout => sub {
			return $self->readline_block();
		};
		if ($@) {
			$log->debug("Keepalive timeout reached. Sending noop");
			my @noop_reply = $self->send_command("noop")->@*;
			#print Dumper(\@noop_reply);
			if (@noop_reply > 1) {
				# last line is the reply to NOOP (send_command checks for
				# that). anything else is data that likely got in between the
				# timeout expiring and noop reply. it should likely be passed
				# back up to our caller
				pop @noop_reply;
				push $self->{line_buffer}->@*, @noop_reply;
				return $self->_readline_buffer();
			}
		} else {
			return $ret;
		}
	}
}

method _readline_buffer() {
	return shift $self->{line_buffer}->@*;
}
1;

__END__