# Module of TWiki Enterprise Collaboration Platform, http://TWiki.org/
#
# Copyright (C) 2000-2018 Peter Thoeny, peter[at]thoeny.org
# and TWiki Contributors. All Rights Reserved. TWiki Contributors
# are listed in the AUTHORS file in the root of this distribution.
# NOTE: Please extend that file, not this notice.
#
# Additional copyrights apply to some or all of the code in this
# file as follows:
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version. For
# more details read LICENSE in the root of this distribution.
#
# 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.
#
# As per the GPL, removal of this notice is prohibited.

package TWiki::Configure::UIs::Value;

use strict;
use base 'TWiki::Configure::UI';

# Generates the appropriate HTML for getting a value to configure the
# entry. The actual input field is decided by the type.
sub open_html {
    my ($this, $value, $valuer, $expert) = @_;

    my $type = $value->getType();
    return '' if $value->{hidden};

    my $info = '';
    my $isExpert = 0; # true if this is an EXPERT setting
    if ($value->isExpertsOnly()) {
        $isExpert = 1;
        $info = CGI::h6('EXPERT') . $info;
    }
    $info .= $value->{desc};
    my $keys = $value->getKeys();

    my $checker = TWiki::Configure::UI::loadChecker($keys, $value);
    my $isUnused = 0;
    my $isBroken = 0;
    if ($checker) {
        my $check = $checker->check($value);
        if ($check) {
            # something wrong
            $info .= $check;
            $isBroken = 1;
        }
        if ($check && $check eq 'NOT USED IN THIS CONFIGURATION') {
            $isUnused = 1;
        }
    }

	# Hide rows if this is an EXPERT setting in non-experts mode, or
    # this is a hidden or unused value
	my $hiddenClass = '';
    if ($isUnused ||
          !$isBroken && ($isExpert && !$expert || $value->{hidden})) {
        $hiddenClass = ' twikiHidden';
    }

    # Generate the documentation row
	my $hiddenInput = $this->hidden( 'TYPEOF:'.$keys, $value->{typename} );
    my $row1 = $hiddenInput.$info;

    # Generate col1 of the prompter row
    my $row2col1 = $keys;
    $row2col1 = CGI::span({class=>'mandatory'}, $row2col1)
      if $value->{mandatory};
    if ($value->needsSaving($valuer)) {
        my $v = $valuer->defaultValue($value);
        $v = '(empty)' if( !defined $v || $v eq '');
        $row2col1 .= CGI::span({title => 'Default: '.$v,
                                class => 'twikiAlert'}, 'δ');
    }

    # Generate col2 of the prompter row
    my $row2col2;
    if (!$isUnused && ($isBroken || !$isExpert || $expert)) {
        # Generate a prompter for the value.
        my $class = $value->{typename};
        $class .= ' mandatory' if ($value->{mandatory});
        $row2col2 = CGI::span(
            { class=>$class },
            $type->prompt(
                $keys, $value->{opts}, $valuer->currentValue($value)));
    } else {
        # Non-expert - just pass the value through a hidden
        $row2col2 = CGI::hidden($keys, $valuer->currentValue($value));
    }

    return CGI::Tr(
        { class => $hiddenClass },
        CGI::td( { colspan => 2, class=>'docdata info' }, $row1))."\n"
        . CGI::Tr(
            { class => $hiddenClass },
            CGI::td({class=>'firstCol'}, $row2col1)."\n"
                . CGI::td({class=>'secondCol'}, $row2col2))."\n";
}

sub close_html {
    my $this = shift;
    return '';
}

1;