#
# This file is part of Plinth.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

from django import forms
from django.contrib import messages
from django.core import validators
from django.core.urlresolvers import reverse_lazy
from django.template.response import TemplateResponse
from gettext import gettext as _
import logging

from plinth import actions
from plinth import cfg
from plinth import package

LOGGER = logging.getLogger(__name__)
EMPTYSTRING = 'none'

subsubmenu = [{'url': reverse_lazy('dynamicdns:index'),
               'text': _('About')},
              {'url': reverse_lazy('dynamicdns:configure'),
               'text': _('Configure')},
              {'url': reverse_lazy('dynamicdns:statuspage'),
               'text': _('Status')}
              ]


def init():
    """Initialize the dynamicdns module"""
    menu = cfg.main_menu.get('apps:index')
    menu.add_urlname('Dynamic DNS', 'glyphicon-refresh',
                     'dynamicdns:index', 500)


@package.required(['ez-ipupdate'])
def index(request):
    """Serve dynamic DNS  page"""

    return TemplateResponse(request, 'dynamicdns.html',
                            {'title': _('dynamicdns'),
                             'subsubmenu': subsubmenu})


class TrimmedCharField(forms.CharField):
    """Trim the contents of a CharField"""
    def clean(self, value):
        """Clean and validate the field value"""
        if value:
            value = value.strip()

        return super(TrimmedCharField, self).clean(value)


class ConfigureForm(forms.Form):
    """Form to configure the dynamic DNS client"""

    hlp_updt_url = 'The Variables &lt;User&gt;, &lt;Pass&gt;, &lt;Ip&gt;, \
                    &lt;Domain&gt; may be used within the URL. For details\
                    see the update URL templates of the example providers.'

    hlp_services = 'Please choose an update protocol according to your \
                    provider. If your provider does not support the GnudIP \
                    protocol or your provider is not listed you may use \
                    the update URL of your provider.'

    hlp_server = 'Please do not enter a URL here (like "https://example.com/")\
                  but only the hostname of the GnuDIP server (like \
                  "example.com").'

    hlp_domain = 'The public domain name you want use to reach your box.'

    hlp_disable_ssl = 'Use this option if your provider uses self signed \
                       certificates.'

    hlp_http_auth = 'If this option is selected, your username and \
                     password will be used for HTTP basic authentication.'

    hlp_secret = 'Leave this field empty \
                  if you want to keep your previous configured password.'

    hlp_ipurl = 'Optional Value. If your FreedomBox is not connected \
                 directly to the Internet (i.e. connected to a NAT \
                 router) this URL is used to figure out the real Internet \
                 IP. The URL should simply return the IP where the \
                 client comes from. Example: \
                 http://myip.datasystems24.de'

    hlp_user = 'You should have been requested to select a username \
                when you created the account.'

    """ToDo: sync this list with the html template file"""
    provider_choices = (
                       ('GnuDIP', 'GnuDIP'),
                       ('noip', 'noip.com'),
                       ('selfhost', 'selfhost.bz'),
                       ('freedns', 'freedns.afraid.org'),
                       ('other', 'other update URL'))

    enabled = forms.BooleanField(label=_('Enable Dynamic DNS'),
                                 required=False)

    service_type = forms.ChoiceField(label=_('Service type'),
                                     help_text=_(hlp_services),
                                     choices=provider_choices)

    dynamicdns_server = TrimmedCharField(
        label=_('GnudIP Server Address'),
        required=False,
        help_text=_(hlp_server),
        validators=[
            validators.RegexValidator(r'^[\w-]{1,63}(\.[\w-]{1,63})*$',
                                      _('Invalid server name'))])

    dynamicdns_update_url = TrimmedCharField(label=_('Update URL'),
                                             required=False,
                                             help_text=_(hlp_updt_url))

    disable_SSL_cert_check = forms.BooleanField(label=_('accept all SSL \
                                                        certificates'),
                                                help_text=_(hlp_disable_ssl),
                                                required=False)

    use_http_basic_auth = forms.BooleanField(label=_('use HTTP basic \
                                                      authentication'),
                                             help_text=_(hlp_http_auth),
                                             required=False)

    dynamicdns_domain = TrimmedCharField(
        label=_('Domain Name'),
        help_text=_(hlp_domain),
        required=False,
        validators=[
            validators.RegexValidator(r'^[\w-]{1,63}(\.[\w-]{1,63})*$',
                                      _('Invalid domain name'))])

    dynamicdns_user = TrimmedCharField(
        label=_('Username'),
        required=False,
        help_text=_(hlp_user))

    dynamicdns_secret = TrimmedCharField(
        label=_('Password'), widget=forms.PasswordInput(),
        required=False,
        help_text=_(hlp_secret))

    showpw = forms.BooleanField(label=_('show password'),
                                required=False)

    dynamicdns_ipurl = TrimmedCharField(
        label=_('IP check URL'),
        required=False,
        help_text=_(hlp_ipurl),
        validators=[
            validators.URLValidator(schemes=['http', 'https', 'ftp'])])

    def clean(self):
        cleaned_data = super(ConfigureForm, self).clean()
        dynamicdns_secret = cleaned_data.get('dynamicdns_secret')
        dynamicdns_update_url = cleaned_data.get('dynamicdns_update_url')
        dynamicdns_user = cleaned_data.get('dynamicdns_user')
        dynamicdns_domain = cleaned_data.get('dynamicdns_domain')
        dynamicdns_server = cleaned_data.get('dynamicdns_server')
        service_type = cleaned_data.get('service_type')
        old_dynamicdns_secret = self.initial['dynamicdns_secret']

        """clear the fields which are not in use"""
        if service_type == 'GnuDIP':
            dynamicdns_update_url = ""
        else:
            dynamicdns_server = ""

        if cleaned_data.get('enabled'):
            """check if gnudip server or update URL is filled"""
            if not dynamicdns_update_url and not dynamicdns_server:
                raise forms.ValidationError('please give update URL or \
                                             a GnuDIP Server')
                LOGGER.info('no server address given')

            if dynamicdns_server and not dynamicdns_user:
                raise forms.ValidationError('please give GnuDIP username')

            if dynamicdns_server and not dynamicdns_domain:
                raise forms.ValidationError('please give GnuDIP domain')

            """check if a password was set before or a password is set now"""
            if (dynamicdns_server and not dynamicdns_secret
               and not old_dynamicdns_secret):
                raise forms.ValidationError('please give a password')
                LOGGER.info('no password given')


@package.required(['ez-ipupdate'])
def configure(request):
    """Serve the configuration form"""
    status = get_status()
    form = None

    if request.method == 'POST':
        form = ConfigureForm(request.POST, initial=status)
        if form.is_valid():
            _apply_changes(request, status, form.cleaned_data)
            status = get_status()
            form = ConfigureForm(initial=status)
    else:
        form = ConfigureForm(initial=status)

    return TemplateResponse(request, 'dynamicdns_configure.html',
                            {'title': _('Configure dynamicdns Client'),
                             'form': form,
                             'subsubmenu': subsubmenu})


@package.required(['ez-ipupdate'])
def statuspage(request):
    """Serve the status page """
    check_nat = actions.run('dynamicdns', ['get-nat'])
    last_update = actions.run('dynamicdns', ['get-last-success'])

    no_nat = check_nat.strip() == 'no'
    nat_unchecked = check_nat.strip() == 'unknown'
    timer = actions.run('dynamicdns', ['get-timer'])

    if no_nat:
        LOGGER.info('we are not behind a NAT')

    if nat_unchecked:
        LOGGER.info('we did not checked if we are behind a NAT')

    return TemplateResponse(request, 'dynamicdns_status.html',
                            {'title': _('Status of dynamicdns Client'),
                             'no_nat': no_nat,
                             'nat_unchecked': nat_unchecked,
                             'timer': timer,
                             'last_update': last_update,
                             'subsubmenu': subsubmenu})


def get_status():
    """Return the current status"""
    """ToDo: use key/value instead of hard coded value list"""
    status = {}
    output = actions.run('dynamicdns', ['status'])
    details = output.split()
    status['enabled'] = (output.split()[0] == 'enabled')

    if len(details) > 1:
        if details[1] == 'disabled':
            status['dynamicdns_server'] = ''
        else:
            status['dynamicdns_server'] = details[1].replace("'", "")
    else:
        status['dynamicdns_server'] = ''

    if len(details) > 2:
        if details[2] == 'disabled':
            status['dynamicdns_domain'] = ''
        else:
            status['dynamicdns_domain'] = details[2]
            status['dynamicdns_domain'] = details[2].replace("'", "")
    else:
        status['dynamicdns_domain'] = ''

    if len(details) > 3:
        if details[3] == 'disabled':
            status['dynamicdns_user'] = ''
        else:
            status['dynamicdns_user'] = details[3].replace("'", "")
    else:
        status['dynamicdns_user'] = ''

    if len(details) > 4:
        if details[4] == 'disabled':
            status['dynamicdns_secret'] = ''
        else:
            status['dynamicdns_secret'] = details[4].replace("'", "")
    else:
        status['dynamicdns_secret'] = ''

    if len(details) > 5:
        if details[5] == 'disabled':
            status['dynamicdns_ipurl'] = ''
        else:
            status['dynamicdns_ipurl'] = details[5].replace("'", "")
    else:
        status['dynamicdns_ipurl'] = ''

    if len(details) > 6:
        if details[6] == 'disabled':
            status['dynamicdns_update_url'] = ''
        else:
            status['dynamicdns_update_url'] = details[6].replace("'", "")
    else:
        status['dynamicdns_update_url'] = ''

    if len(details) > 7:
        status['disable_SSL_cert_check'] = (output.split()[7] == 'enabled')
    else:
        status['disable_SSL_cert_check'] = False

    if len(details) > 8:
        status['use_http_basic_auth'] = (output.split()[8] == 'enabled')
    else:
        status['use_http_basic_auth'] = False

    if not status['dynamicdns_server'] and not status['dynamicdns_update_url']:
        status['service_type'] = 'GnuDIP'
    elif not status['dynamicdns_server'] and status['dynamicdns_update_url']:
        status['service_type'] = 'other'
    else:
        status['service_type'] = 'GnuDIP'

    return status


def _apply_changes(request, old_status, new_status):
    """Apply the changes to Dynamic DNS client"""
    LOGGER.info('New status is - %s', new_status)
    LOGGER.info('Old status was - %s', old_status)

    if new_status['dynamicdns_secret'] == '':
        new_status['dynamicdns_secret'] = old_status['dynamicdns_secret']

    if new_status['dynamicdns_ipurl'] == '':
        new_status['dynamicdns_ipurl'] = EMPTYSTRING

    if new_status['dynamicdns_update_url'] == '':
        new_status['dynamicdns_update_url'] = EMPTYSTRING

    if new_status['dynamicdns_server'] == '':
        new_status['dynamicdns_server'] = EMPTYSTRING

    if new_status['service_type'] == 'GnuDIP':
        new_status['dynamicdns_update_url'] = EMPTYSTRING
    else:
        new_status['dynamicdns_server'] = EMPTYSTRING

    if old_status != new_status:
        disable_ssl_check = "disabled"
        use_http_basic_auth = "disabled"

        if new_status['disable_SSL_cert_check']:
            disable_ssl_check = "enabled"

        if new_status['use_http_basic_auth']:
            use_http_basic_auth = "enabled"

        _run(['configure', '-s', new_status['dynamicdns_server'],
              '-d', new_status['dynamicdns_domain'],
              '-u', new_status['dynamicdns_user'],
              '-p', new_status['dynamicdns_secret'],
              '-I', new_status['dynamicdns_ipurl'],
              '-U', new_status['dynamicdns_update_url'],
              '-c', disable_ssl_check,
              '-b', use_http_basic_auth])

        if old_status['enabled']:
            _run(['stop'])
        if new_status['enabled']:
            _run(['start'])

        messages.success(request,
                         _('Dynamic DNS configuration is updated!'))
    else:
        LOGGER.info('nothing changed')


def _run(arguments, superuser=False):
    """Run a given command and raise exception if there was an error"""
    command = 'dynamicdns'

    if superuser:
        return actions.superuser_run(command, arguments)
    else:
        return actions.run(command, arguments)