path: root/lib/FPanel/Interface.pm

package FPanel::Interface;

use strict;
use warnings;
use utf8;

use lib 'lib';
use base 'FPanel::Login';


# This method is called right before the 'setup' method below. It
# inherits the configuration from the super class.
sub cgiapp_init {
    my $self = shift;

    $self->SUPER::cgiapp_init;

    # Every single Run Mode here is protected
    $self->authen->protected_runmodes( ':all' );
}


# This is the first page seen by authenticated users. It lists the known
# domains.
sub ListDomains : StartRunmode {
    my $self = shift;
    my %CFG = $self->cfg;
    my $suffix = join ',', @{$CFG{ldap_suffix}};

    my ($l,$d) = split /@/, $self->authen->username, 2;
    my $authzDN = "fvu=$l,fvd=$d,". $suffix;
    my $ldap = $self->ldap_from_auth_user($authzDN);

    my $domains = $ldap->search( base => $suffix
                               , scope => 'one'
                               , filter => 'objectClass=FripostVirtualDomain'
                               , deref => 'never'
                               , attrs => [ qw/fvd description
                                               fripostIsStatusActive
                                               fripostCanCreateAlias
                                               fripostCanCreateList
                                               fripostOwner
                                               fripostPostmaster/ ]
                               );
    die $domains->error if $domains->code;
    $ldap->unbind;


    my $template = $self->load_tmpl( 'list-domains.html', cache => 1, utf8 => 1
                                   , loop_context_vars => 1
                                   , global_vars => 1 );
    $template->param( URL => $self->query->url );
    $template->param( USER_LOCALPART => $l, USER_DOMAINPART => $d);
    $template->param( DOMAINS => [
        map { { DOMAIN => $_->get_value('fvd')
              , PERMS => &list_perms_long($_, $authzDN)
              , DESCRIPTION => join ("\n", $_->get_value('description'))
              , ISACTIVE => $_->get_value('fripostIsStatusActive') eq 'TRUE' ?
                                1 : 0
              };
            }
            $domains->sorted('fvd')
    ]);
    return $template->output;
}


# This Run Mode lists the known aliases, users and lists in the current
# domain.
sub ListLocals : Runmode {
    my $self = shift;
    my %CFG = $self->cfg;
    my $suffix = join ',', @{$CFG{ldap_suffix}};

    my ($l,$d) = split /@/, $self->authen->username, 2;
    my $authzDN = "fvu=$l,fvd=$d,". $suffix;
    my $ldap = $self->ldap_from_auth_user($authzDN);

    my $domainname = (split /\//, $ENV{PATH_INFO}, 3)[1];

    # Query *the* matching domain
    my $domains = $ldap->search( base => "fvd=$domainname,$suffix"
                               , scope => 'base'
                               , filter => 'objectClass=FripostVirtualDomain'
                               , deref => 'never'
                               , attrs => [ qw/fvd description
                                               fripostIsStatusActive
                                               fripostOptionalMaildrop
                                               fripostCanCreateAlias
                                               fripostCanCreateList
                                               fripostOwner
                                               fripostPostmaster/ ]
                               );
    die $domains->error if $domains->code;
    die "Error: Domains not found" unless $domains->count;
    die "Error: Multiple domains found" if $domains->count > 1;

    # Query the mailboxes under the given domain
    my $mailboxes = $ldap->search( base => "fvd=$domainname,$suffix"
                                 , scope => 'one'
                                 , filter => 'objectClass=FripostVirtualMailbox'
                                 , deref => 'never'
                                 , attrs => [ qw/fvu description
                                                 fripostIsStatusActive
                                                 fripostOptionalMaildrop
                                                 fripostMailboxQuota/ ]
                                );
    die $mailboxes->error if $mailboxes->code;

    # Query the aliases under the given domain
    my $aliases = $ldap->search( base => "fvd=$domainname,$suffix"
                               , scope => 'one'
                               , filter => 'objectClass=FripostVirtualAlias'
                               , deref => 'never'
                               , attrs => [ qw/fva description
                                               fripostIsStatusActive
                                               fripostOwner
                                               fripostMaildrop/ ]
                               );
    die $aliases->error if $aliases->code;

    # Query the lists under the given domain
    my $lists = $ldap->search( base => "fvd=$domainname,$suffix"
                             , scope => 'one'
                             , filter => 'objectClass=FripostVirtualList'
                             , deref => 'never'
                             , attrs => [ qw/fvl description
                                             fripostIsStatusActive
                                             fripostOwner
                                             fripostListManager/ ]
                             );
    die $lists->error if $lists->code;

    $ldap->unbind;

    my $domain = $domains->entry('0');
    my $perms = &list_perms($domain, $authzDN);

    my $template = $self->load_tmpl( 'list-locals.html', cache => 1, utf8 => 1
                                   , loop_context_vars => 1
                                   , global_vars => 1 );

    $template->param( URL => $self->query->url );
    $template->param( DOMAIN => $domainname );
    $template->param( USER_LOCALPART => $l, USER_DOMAINPART => $d);
    $template->param( DESCRIPTION =>
        join ("\n", $domain->get_value('description')) );
    $template->param( ISACTIVE =>
        $domain->get_value('fripostIsStatusActive') eq 'TRUE' ? 1 : 0 );
    # Can the user edit the domain (change description, toggle
    # activation, modify catchalls?)
    $template->param( CANEDIT => $perms =~ /[op]/ );

    # Can the user add mailboxes?
    $template->param( CANADDMAILBOX => $perms =~ /p/ );
    # Should we list mailboxes?
    $template->param( LISTMAILBOXES => $mailboxes->count || $perms =~ /p/ );
    $template->param( MAILBOXES => [
        map { { USER => $_->get_value('fvu')
              , DESCRIPTION => join ("\n", $_->get_value('description'))
              , ISACTIVE => $_->get_value('fripostIsStatusActive') eq 'TRUE' ?
                                1 : 0
              , FORWARDS => [ map { {FORWARD => $_} }
                                  $_->get_value('fripostOptionalMaildrop') ]
              , QUOTA => $_->get_value('fripostMailboxQuota') // ''
              };
            }
            $mailboxes->sorted('fvu')
    ]);

    # Can the user add aliases?
    $template->param( CANADDALIAS => $perms =~ /[aop]/ );
    # Should we list aliases?
    $template->param( LISTMAILBOXES => $mailboxes->count || $perms =~ /p/ );
    $template->param( LISTALIASES => $aliases->count || $perms =~ /[aop]/ );
    $template->param( ALIASES => [
        map { { ALIAS => $_->get_value('fva')
              , DESCRIPTION => join ("\n", $_->get_value('description'))
              , ISACTIVE => $_->get_value('fripostIsStatusActive') eq 'TRUE' ?
                                1 : 0
              , OWNERS => [ map { {OWNER => &dn2email($_)} }
                                  $_->get_value('fripostOwner') ]
              , DESTINATIONS => [ map { {DESTINATION => $_} }
                                      $_->get_value('fripostMaildrop') ]
              };
            }
            $aliases->sorted('fva')
    ]);
    $template->param( CATCHALLS => [ map { {CATCHALL => $_} }
                                         $domain->get_value('fripostOptionalMaildrop') ]
                    , OWNERS => [ ( map { {OWNER => &dn2email($_)} }
                                        $domain->get_value('fripostOwner') )
                                , ( map { {OWNER => &dn2email($_)} }
                                        $domain->get_value('fripostPostmaster') ) ]
                    , CAODD => $aliases->count % 2 );

    # Can the user add lists?
    $template->param( CANADDLIST => $perms =~ /[lop]/ );
    # Should we list lists?
    $template->param( LISTLISTS => $lists->count || $perms =~ /[lop]/ );
    $template->param( LISTS => [
        map { { LIST => $_->get_value('fvl')
              , DESCRIPTION => join ("\n", $_->get_value('description'))
              , ISACTIVE => $_->get_value('fripostIsStatusActive') eq 'TRUE' ?
                                1 : 0
              , OWNERS => [ map { {OWNER => &dn2email($_)} }
                                $_->get_value('fripostOwner') ]
              , TRANSPORT => $_->get_value('fripostListManager')
              };
            }
            $lists->sorted('fvl')
    ]);
    return $template->output;
}


# This is the page used to edit domains.
sub EditDomain : Runmode {
    my $self = shift;
    my %CFG = $self->cfg;
    my $suffix = join ',', @{$CFG{ldap_suffix}};

    my ($l,$d) = split /@/, $self->authen->username, 2;
    my $authzDN = "fvu=$l,fvd=$d,". $suffix;
    my $ldap = $self->ldap_from_auth_user($authzDN);

    my $domainname = (split /\//, $ENV{PATH_INFO}, 3)[1];

    if (defined $self->query->param('submit') or
        defined $self->query->param('active')) {
        # Changes have been submitted: process them
        my %changes;
        if (defined $self->query->param('active')) {
            $changes{fripostIsStatusActive} = $self->query->param('active');
        }
        if (defined $self->query->param('description')) {
            my @desc;
            foreach my $d (split /\n/, $self->query->param('description')) {
                push @desc, $d;
            }
            $changes{description} = [ @desc ];
        }
        if (defined $self->query->param('maildrop')) {
            my @maildrop;
            foreach my $d (split /\n/, $self->query->param('maildrop')) {
                $d =~ s/\s//g;
                push @maildrop, (lc $d) unless $d =~ /^$/;
            }
            $changes{fripostOptionalMaildrop} = [ @maildrop ];
        }

        my $mesg = $ldap->modify( "fvd=$domainname,$suffix",
                                  replace => \%changes );
        die $mesg->error if $mesg->code;
    }

    my $answer = $ldap->search( base => "fvd=$domainname,$suffix"
                              , scope => 'base'
                              , filter => 'objectClass=FripostVirtualDomain'
                              , deref => 'never'
                              );
    die $answer->error if $answer->code;
    $answer = $answer->entry('0');
    $ldap->unbind;

    my $template = $self->load_tmpl( 'edit-domain.html', cache => 1, utf8 => 1
                                   , loop_context_vars => 1
                                   , global_vars => 1 );
    $template->param( URL => $self->query->url );
    $template->param( USER_LOCALPART => $l, USER_DOMAINPART => $d);
    $template->param( DOMAIN => $domainname );
    $template->param( DESCRIPTION =>
        join ("\n",$answer->get_value('description')) );
    $template->param( MAILDROP =>
        join ("\n",$answer->get_value('fripostOptionalMaildrop')) );
    $template->param( ISACTIVE => $answer->get_value('fripostIsStatusActive') eq 'TRUE' ?
                                      1 : 0 );
    $template->param( NEWCHANGES => defined $self->query->param('submit') );
    return $template->output;
}


# This subroutine displays the access that the given DN has on the entry
# (long version). Possible values are :
# - "can create aliases" (a)
# - "can create lists" (l)
# - "can create aliases & lists" (al)
# - "owner" (o)
# - "postmaster" (p)
sub list_perms_long {
    my $perms = &list_perms(@_);

    if ( $perms =~ /a/) {
      return 'can create aliases & lists' if ( $perms =~ /l/);
      return 'can create aliases';
    }
    elsif ( $perms eq 'l' ) {
      return 'can create lists';
    }
    elsif ( $perms eq 'o' ) {
      return 'owner';
    }
    elsif ( $perms eq 'p' ) {
      return 'postmaster';
    }
}

# This subroutine displays the access that the given DN has on the entry
# (short version).
sub list_perms {
    my ($entry, $dn) = @_;
    my $perms = '';

    $perms .= 'a'
        if grep { $dn eq $_  or  (split /,/,$dn,2)[1] eq $_ }
                $entry->get_value ('fripostCanCreateAlias');

    $perms .= 'l'
        if grep { $dn eq $_  or  (split /,/,$dn,2)[1] eq $_ }
                $entry->get_value ('fripostCanCreateList');

    $perms = 'o'
        if grep { $dn eq $_ } $entry->get_value('fripostOwner');

    $perms = 'p'
        if grep { $dn eq $_ } $entry->get_value('fripostPostmaster');

    return $perms;
}


# This method SASL binds the web application and uses the provided
# authorization DN.
sub ldap_from_auth_user {
    my $self = shift;
    my $authzDN = shift;

    my $ldap = Net::LDAP->new( $self->cfg('ldap_uri'),
                               async => 1, onerror => 'die' );
    my $sasl = Authen::SASL->new(
                   mechanism => 'DIGEST-MD5',
                   callback => { user => $self->cfg('ldap_authcID')
                               , pass => $self->cfg('ldap_authcPW')
                               , authname => "dn:$authzDN" }
               );
    my $mesg = $ldap->bind( sasl => $sasl );
    die $mesg->error if $mesg->code;

    return $ldap;
}

# Converts a DN into an email.
sub dn2email {
  my $dn = shift;
  $dn =~ /^fv[ual]=([^,]+),fvd=([^,]+),/ or return '';
  return "$1\@$2";
}

1;