File: Managesieve.pm

package info (click to toggle)
ciderwebmail 1.05%2B20240702-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,392 kB
  • sloc: perl: 3,201; xml: 782; javascript: 675; sh: 42; makefile: 29
file content (204 lines) | stat: -rw-r--r-- 7,239 bytes parent folder | download | duplicates (6)
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
package CiderWebmail::Controller::Managesieve;
use Moose;
use namespace::autoclean;

use feature 'switch';

use Carp qw/ confess croak /;

BEGIN { extends 'Catalyst::Controller'; }

=head2 setup

load sieve script list from server

=cut

sub setup : Chained('/') PathPart('managesieve') CaptureArgs(0) {
    my ($self, $c) = @_;

    croak("managesieve support disabled in configuration") unless ($c->config->{managesieve}->{mode} =~ m/(on|vacation)/xmi);

    CiderWebmail::Util::add_foldertree_to_stash($c);

    $c->stash->{uri_add} = $c->uri_for('edit');

    my $sieve = $c->model('Managesieve')->new();

    CiderWebmail::Model::Managesieve->config({
        host => $c->config->{managesieve}->{host},
        port => $c->config->{managesieve}->{port},
    });

    $sieve->login({
        username => $c->session->{'username'},
        password => CiderWebmail::Util::decrypt($c, { string => $c->req->cookie('password')->value }),
    });

    $c->stash->{_managesieve} = $sieve;

    return;
}

sub index :Path :Args(0) {
    my ( $self, $c ) = @_;

    $c->res->redirect($c->uri_for('vacation')) if ($c->config->{managesieve}->{mode} =~ m/vacation/xmi);
    $c->res->redirect($c->uri_for('list'));
}


sub list : Chained('/managesieve/setup') PathPart('list') Args(0) {
    my ($self, $c) = @_;

    $c->res->redirect($c->uri_for('vacation')) if ($c->config->{managesieve}->{mode} =~ m/vacation/xmi);

    $c->stash->{template} = 'managesieve/list.xml';

    my $scripts = $c->stash->{_managesieve}->list_scripts();

    my %sieve_scripts = map {
        $_ => {
            active      => $scripts->{$_},
            uri_edit    => $c->uri_for('edit', { sieve_script_name => $_ }),
            uri_delete  => $c->uri_for('delete', { sieve_script_name => $_ }),
        } } keys %$scripts;
    $c->stash->{sieve_scripts} = \%sieve_scripts;

    return;
}

sub delete : Chained('/managesieve/setup') PathPart('delete') Args() {
    my ($self, $c) = @_;

    my $managesieve = $c->stash->{_managesieve};

    #TODO validate against allowed names per RFC
    $managesieve->delete_script({ name => $c->req->param('sieve_script_name') });

    $c->res->redirect($c->uri_for('list'));
    $c->detach;
}

sub vacation : Chained('/managesieve/setup') PathPart('vacation') Args() {
    my ($self, $c) = @_;

    my $managesieve = $c->stash->{_managesieve};

    $c->stash->{template} = 'managesieve/vacation.xml';
    $c->stash->{uri_save} = $c->uri_for('vacation');

    if ((defined $managesieve->active_script) and ($managesieve->active_script ne 'CiderWebmail-Vacation-Rule')) {
        $c->stash->{error} = 'Another script is currently active: '.$managesieve->active_script.'. It will be disabled once you enable the vacation rule!';
    }

    #TODO better paramenter checking befor detach to save
    if (defined $c->req->param('vacation_rule_save')) {
        $c->stash->{sieve_script_content}   = $managesieve->build_vacation_script({ subject => $c->req->param('vacation_rule_subject'), text => $c->req->param('vacation_rule_body') });
        $c->stash->{sieve_script_status}    = ((defined $c->req->param('vacation_rule_active')) ? 'active' : 'inactive');
        $c->stash->{sieve_script_name}      = 'CiderWebmail-Vacation-Rule';

        $c->detach('save');
    } elsif ($managesieve->script_exists({ name => 'CiderWebmail-Vacation-Rule' })) {
        my $vacation_script = $managesieve->get_script({ name => 'CiderWebmail-Vacation-Rule' });

        if ($vacation_script =~ m/vacation :days 7 :subject "([^"]+?)" "([^"]+?)"/) {
            $c->stash->{vacation_rule_subject}  = $1;
            $c->stash->{vacation_rule_body}     = $2;
        }

        $c->stash->{vacation_rule_active}   = ($managesieve->active_script eq 'CiderWebmail-Vacation-Rule');
    }
}



sub edit : Chained('/managesieve/setup') PathPart('edit') Args() {
    my ($self, $c) = @_;

    #TODO redirect to vacation if CiderWebmail is in vacation-only mode

    my $managesieve = $c->stash->{_managesieve};

    $c->stash->{template} = 'managesieve/edit.xml';
    $c->stash->{uri_save} = $c->uri_for('edit');


    #TODO validate against allowed names per RFC
    $c->stash->{sieve_script_name} = $c->req->param('sieve_script_name');

    #TODO better parameter validation before detach to save
    if (defined $c->req->param('sieve_script_save')) {

        if (defined($c->req->param('sieve_script_original_name')) and ($c->req->param('sieve_script_name') ne $c->req->param('sieve_script_original_name'))) {
            $managesieve->rename_script({ old_name => $c->req->param('sieve_script_original_name'), new_name => $c->req->param('sieve_script_name') });
        }

        #TODO use Net::Sieve::Script to at least parse it here so we can perform basic validation
        $c->stash->{sieve_script_content} = $c->req->param('sieve_script_content');
        $c->stash->{sieve_script_status} = ((defined $c->req->param('sieve_script_active')) ? 'active' : 'inactive');

        $c->detach('save');
    }
    
    if (defined $c->req->param('sieve_script_name')) {
        $c->stash->{sieve_script_content} = $managesieve->get_script({ name => $c->stash->{sieve_script_name} });
        $c->stash->{sieve_script_active} = ($c->stash->{sieve_script_name} eq $managesieve->active_script);

        #this is used to detect if the user requested a rename
        $c->stash->{sieve_script_original_name} = $c->req->param('sieve_script_name');
    }
}

=head2 save

save a managescript save to the server
the following variables need to be set on the stash:

sieve_script_name     => name of the script on the server. if it does not exist it will be created. if it does exist it will be overwritten
sieve_script_content  => sieve script to save
sieve_script_status   => if set to to 'active' the script will be marked as 'active' on the server, this will disable all other scripts.
                         if set to to 'inactive' the script will be marked as 'inactive' on the server.

=cut

sub save : Chained('/managesieve/setup') Args(0) {
    my ($self, $c) = @_;

    my $managesieve = $c->stash->{_managesieve};

    confess("Managesieve::save() called but sieve_script_name not set on the stash") unless defined $c->stash->{sieve_script_name};
    confess("Managesieve::save() called but sieve_script_content not set on the stash") unless defined $c->stash->{sieve_script_content};
    confess("Managesieve::save() called but sieve_script_status not set on the stash") unless defined $c->stash->{sieve_script_status};

    my $name = $c->stash->{sieve_script_name};
    my $content = $c->stash->{sieve_script_content};
    my $status = $c->stash->{sieve_script_status};

    $managesieve->put_script({ name => $name, content => $content });

    if ($status eq 'active') {
        $managesieve->active_script({ name => $name });
    }
    elsif ($status eq 'inactive') {
        $managesieve->disable_script({ name => $name });
    }
    else {
        confess("stash sieve_script_status set to invalid value: " . $status);
    };

    $c->forward('list');

    return;
}

=head1 LICENSE

This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.

=cut

__PACKAGE__->meta->make_immutable;

1;