/usr/share/perl5/EBox/DHCP/Model/ThinClientOptions.pm

# Copyright (C) 2008-2012 eBox Technologies S.L.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2, as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

# Class: EBox::DHCP::Model::ThinClientOptions
#
# This class is the model to configurate thin client options for the dhcp
# server on a static interface. The fields are the following:
#
#     - next server, which tells dhcp client where to search the
#     terminal server
#
#     - filename, which indicates the firmware to load when the DHCP
#     client loads
#

package EBox::DHCP::Model::ThinClientOptions;

# TODO: Restore this when more than one config per interface is possible
#use base 'EBox::Model::DataTable';
use base 'EBox::Model::DataForm';

use strict;
use warnings;

use feature 'switch';

use EBox::DHCP;
use EBox::DHCP::Types::Group;
use EBox::Exceptions::DataNotFound;
use EBox::Exceptions::External;
use EBox::Exceptions::InvalidData;
use EBox::Exceptions::MissingArgument;
use EBox::Gettext;
use EBox::Global;
use EBox::NetWrappers;
use EBox::Types::File;
use EBox::Types::Union;
use EBox::Types::Union::Text;
use EBox::Types::Host;
use EBox::Types::Select;
use EBox::Types::Boolean;
use EBox::Validate;
use EBox::View::Customizer;

# Group: Public methods

# Constructor: new
#
#     Create the thin client options to the dhcp server
#
# Overrides:
#
#     <EBox::Model::DataForm::new>
#
# Returns:
#
#     <EBox::DHCP::Model::ThinClientOptions>
#
# Exceptions:
#
#     <EBox::Exceptions::MissingArgument> - thrown if any compulsory
#     argument is missing
#
sub new
{
    my $class = shift;
    my %opts = @_;
    my $self = $class->SUPER::new(@_);
    bless ($self, $class);

    return $self;
}

# Method: notifyForeignModelAction
#
#     Remove rows when a range or fixed address is removed from the
#     same interface and applies to this model and object.
#
#     Do this because of framework limitation.
#
# Overrides:
#
#     <EBox::Model::DataTable::notifyForeignModelAction>
#
# TODO: Restore this when more than one config per interface is possible
# sub notifyForeignModelAction
# {
#     my ($self, $model, $action, $row) = @_;
#
#     if ( $action eq 'del' ) {
#         my $idToRemove;
#         given ( $model ) {
#             when ( 'FixedAddressTable' ) {
#                 $idToRemove = $row->valueByName('object');
#             }
#             when ( 'RangeTable' ) {
#                 $idToRemove = $row->valueByName('name');
#             }
#             default { return ""; }
#         }
#         my $matchedRow = $self->findValue(hosts => $idToRemove);
#         if ( $matchedRow ) {
#             $self->removeRow($matchedRow->id(), 1);
#             return __x('Remove thin client options from {model}{br}',
#                        model => $self->printableContextName(),
#                        br    => '<br>');
#         }
#     }
#     return "";
#
# }

# Method: nextServerIsZentyal
#
#     Finds out whether the next server the next server is Zentyal or not
#
# Parameters:
#
#     id - String the row identifier
#
# Returns:
#
#     Boolean - if Zentyal is the next server for the given row
#
# Exceptions:
#
#     <EBox::Exceptions::DataNotFound> - thrown if the given id is not
#     from this model
#
sub nextServerIsZentyal
{
    my ($self, $id) = @_;

# TODO: Restore this when more than one config per interface is possible
#    my $row = $self->row($id);
    my $row = $self->row();

    unless ( defined($row) ) {
        throw EBox::Exceptions::DataNotFound(data => 'id', value => $id);
    }

    return ( $row->valueByName('nextServer') eq 'nextServerEBox' );

}

# Method: nextServer
#
#     Get the next server (name or IP address) in an string form to
#     tell the DHCP clients which is the next server to ask for
#     terminal
#
# Parameters:
#
#     id - String the row identifier
#
# Returns:
#
#     String - a name or an IP address
#
# Exceptions:
#
#     <EBox::Exceptions::DataNotFound> - thrown if the given id is not
#     from this model
#
sub nextServer
{
    my ($self, $id) = @_;

# TODO: Restore this when more than one config per interface is possible
#    my $row = $self->row($id);
    my $row = $self->row();

    unless ( defined($row) ) {
        throw EBox::Exceptions::DataNotFound(data => 'id', value => $id);
    }

    return $row->valueByName('nextServerHost');
}

# Method: remoteFilename
#
#   Get the remote filename in an string form to tell the DHCP clients which
#   is the file to ask for to the server
#
# Parameters:
#
#     id - String the row identifier
#
# Returns:
#
#     String - a filename
#
# Exceptions:
#
#     <EBox::Exceptions::DataNotFound> - thrown if the given id is not
#     from this model
#
sub remoteFilename
{
    my ($self, $id) = @_;

# TODO: Restore this when more than one config per interface is possible
#    my $row = $self->row($id);
    my $row = $self->row();

    unless ( defined($row) ) {
        throw EBox::Exceptions::DataNotFound(data => 'id', value => $id);
    }

    my $nextServerType = $row->valueByName('nextServer');
    given ( $nextServerType ) {
        when ('nextServerHost' ) {
            return $row->valueByName('remoteFilename');
        }
        default {
            return '';
        }
    }
}

# Method: architecture
#
#     Get the architecture in an string form to tell the DHCP clients which is
#     the architecture of the thin clients
#
# Parameters:
#
#     id - String the row identifier
#
# Returns:
#
#     String - architecture
#
# Exceptions:
#
#     <EBox::Exceptions::DataNotFound> - thrown if the given id is not
#     from this model
#
sub architecture
{
    my ($self, $id) = @_;

# TODO: Restore this when more than one config per interface is possible
#    my $row = $self->row($id);
    my $row = $self->row();

    unless ( defined($row) ) {
        throw EBox::Exceptions::DataNotFound(data => 'id', value => $id);
    }

    return $row->valueByName('architecture');
}

# Method: fat
#
#     Return true if the image is a fat image
#
# Parameters:
#
#     id - String the row identifier
#
# Returns:
#
#     Boolean - True if the image is fat
#
# Exceptions:
#
#     <EBox::Exceptions::DataNotFound> - thrown if the given id is not
#     from this model
#
sub fat
{
    my ($self, $id) = @_;

# TODO: Restore this when more than one config per interface is possible
#    my $row = $self->row($id);
    my $row = $self->row();

    unless ( defined($row) ) {
        throw EBox::Exceptions::DataNotFound(data => 'id', value => $id);
    }

    return $row->valueByName('fat');
}

# Group: Protected methods

#
#   Callback function to fill out the values that can
#   be picked from the <EBox::Types::Select> field module
#
# Returns:
#
#   Array ref of hash refs containing the 'value' and the 'printableValue' for
#   each select option
#
sub _select_options
{
# TODO: Restore this when more than one config per interface is possible
#    my @ltspSubtypes;
    my @ltspSubtypes = ({
                            value => 'none',
                            printableValue => __('None'),
                       },);

    my $gl = EBox::Global->getInstance();
    if ( $gl->modExists('ltsp') ) {
        push(@ltspSubtypes,
            {
                value => 'nextServerEBox',
                printableValue => __('Zentyal LTSP'),
            }
        );
    }

    push(@ltspSubtypes,
        {
            value => 'nextServerHost',
            printableValue => __('Host'),
        },
    );

    return \@ltspSubtypes;
}

#
#   Callback function to fill out the values that can
#   be picked from the <EBox::Types::Select> field module
#
# Returns:
#
#   Array ref of hash refs containing the 'value' and the 'printableValue' for
#   each select option
#
sub _select_architecture
{
    my $gl = EBox::Global->getInstance();

    if ( $gl->modExists('ltsp') ) {
        return [
        {
            value => 'i386',
            printableValue => __('32 bits'),
        },
        {
            value => 'amd64',
            printableValue => __('64 bits'),
        },
    ];
    } else {
        return [];
    }
}

# Method: _table
#
# Overrides:
#
#     <EBox::Model::DataForm::_table>
#
sub _table
{
    my ($self) = @_;

    my @tableDesc = (
        new EBox::Types::Select(
                              fieldName     => 'nextServer',
                              printableName => __('Next server'),
                              populate      => \&_select_options,
                              editable      => 1,
                              help          => __('If "Zentyal LTSP" is present and selected, '
                                                  . 'Zentyal will be the LTSP server.'
                                                  . ' You will need to enable and configure the LTSP module.'),),
        new EBox::Types::Host(fieldName     => 'nextServerHost',
                              printableName => __('Host'),
                              editable      => 1,
                              optional      => 1,
                              help          => __('Thin Client server as seen by the clients.'),
                             ),
        new EBox::Types::Text(
                             fieldName     => 'remoteFilename',
                             printableName => __('File path'),
                             editable      => 1,
                             optional      => 1,
                             help          => __('Thin client file path'),
                            ),
# TODO: Restore this when more than one config per interface is possible
#         new EBox::Types::Union(
#                               fieldName      => 'hosts',
#                               printableName  => __('Clients'),
#                               editable       => 1,
#                               subtypes       => [
#                                   new EBox::DHCP::Types::Group(
#                                       fieldName        => 'object',
#                                       printableName    => __('Object'),
#                                       index            => $self->index(),
#                                       foreignModelName => 'FixedAddressTable',
#                                       foreignField     => 'object',
#                                       unique           => 1,
#                                       editable         => 1
#                                      ),
#                                   new EBox::DHCP::Types::Group(
#                                       fieldName        => 'range',
#                                       printableName    => __('Range'),
#                                       index            => $self->index(),
#                                       foreignModelName => 'RangeTable',
#                                       foreignField     => 'name',
#                                       unique           => 1,
#                                       editable         => 1)
#                                     ]),
        new EBox::Types::Select(
                            fieldName       => 'architecture',
                            printableName   => __('Architecture'),
                            populate        => \&_select_architecture,
                            editable        => 1,
                            hiddenOnViewer  => 1,
                            help            => __('Architecture of the LTSP clients. The LTSP image for that architecture must exist in order to boot the clients.'),),
        new EBox::Types::Boolean(
                            fieldName       => 'fat',
                            printableName   => __('Fat Client'),
                            defaultValue    => 0,
                            editable        => 1,
                            hiddenOnViewer  => 1,
                            help            => __('Whether the clients are fat clients or not.'),),
    );

    # FIXME: parentRow() is undefined when _table is called
    #my $interface = $self->parentRow()->valueByName('iface');
    my $interface = 'eth0';

    my $dataTable = {
                    tableName          => 'ThinClientOptions',
                    printableTableName => __('Thin client'),
                    modelDomain        => 'DHCP',
                    defaultActions     => [ 'add', 'del', 'editField', 'changeView' ],
                    tableDescription   => \@tableDesc,
                    class              => 'dataTable',
                    help               => __x('You may want to customise your thin client options.'
                                             . 'To do so, you may include all the files you require '
                                             . 'under {path} directory',
                                             path => EBox::DHCP->PluginConfDir($interface)),
                    sortedBy           => 'hosts',
                    printableRowName   => __('thin client option'),
                   };

    return $dataTable;
}

# Method: viewCustomizer
#
# Overrides:
#
#       <EBox::Model::DataTable::viewCustomizer>
#
sub viewCustomizer
{
    my ($self) = @_;

    my $customizer = new EBox::View::Customizer();
    $customizer->setModel($self);

    my %actions = (
        'nextServer' => {
            # TODO: Remove this when more than one config per interface is possible
            'none' => {
                show => [],
                hide => ['nextServerHost', 'architecture','remoteFilename','fat'],
            },
            'nextServerEBox' => {
# TODO: Restore this when more than one config per interface is possible
#                show => ['hosts', 'nextServerHost', 'architecture', 'fat'],
                show => ['nextServerHost', 'architecture', 'fat'],
                hide => ['remoteFilename'],
            },
            'nextServerHost' => {
# TODO: Restore this when more than one config per interface is possible
#                show => ['remoteFilename', 'nextServerHost', 'hosts'],
                show => ['remoteFilename', 'nextServerHost'],
                hide => ['architecture', 'fat'],
            },
        },
    );

    $customizer->setOnChangeActions( \%actions );

    $customizer->setHTMLTitle([]);

    return $customizer;
}

1;
zentyal-dhcp 2.3.8+quantal1 / usr / share / perl5 / EBox / DHCP / Model / ThinClientOptions.pm
