# $Id$
"""
Copyright (C) 2010, 2011  SPARTA, Inc. dba Cobham Analytic Solutions

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND SPARTA DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS.  IN NO EVENT SHALL SPARTA BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
"""

from django import forms

import rpki.ipaddrs

from rpki.gui.app import models, misc
from rpki.gui.app.asnset import asnset

class AddConfForm(forms.Form):
    handle = forms.CharField(required=True,
            help_text='your handle for your rpki instance')
    run_rpkid = forms.BooleanField(required=False, initial=True,
            label='Run rpkid?',
            help_text='do you want to run your own instance of rpkid?')
    rpkid_server_host = forms.CharField(initial='rpkid.example.org',
            label='rpkid hostname',
            help_text='publicly visible hostname for your rpkid instance')
    rpkid_server_port = forms.IntegerField(initial=4404,
            label='rpkid port')
    run_pubd = forms.BooleanField(required=False, initial=False,
            label='Run pubd?',
            help_text='do you want to run your own instance of pubd?')
    pubd_server_host = forms.CharField(initial='pubd.example.org',
            label='pubd hostname',
            help_text='publicly visible hostname for your pubd instance')
    pubd_server_port = forms.IntegerField(initial=4402, label='pubd port')
    pubd_contact_info = forms.CharField(initial='repo-man@rpki.example.org',
            label='Pubd contact',
            help_text='email address for the operator of your pubd instance')

class ImportForm(forms.Form):
    '''Form used for uploading parent/child identity xml files'''
    handle = forms.CharField(max_length=30, help_text='your name for this entity')
    xml = forms.FileField(help_text='xml filename')

def PrefixSplitForm(parent, *args, **kwargs):
    class _wrapper(forms.Form):
        prefix = forms.CharField(max_length=200, help_text='CIDR or range')

        def clean(self):
            p = self.cleaned_data.get('prefix')
            try:
                r = misc.parse_resource_range(p)
            except ValueError, err:
                print err
                raise forms.ValidationError, 'invalid prefix or range'
            # we get AssertionError is the range is misordered (hi before lo)
            except AssertionError, err:
                print err
                raise forms.ValidationError, 'invalid prefix or range'
            pr = parent.as_resource_range()
            if r.min < pr.min or r.max > pr.max:
                raise forms.ValidationError, \
                        'range is outside parent range'
            if r.min == pr.min and r.max == pr.max:
                raise forms.ValidationError, \
                        'range is equal to parent'
            if parent.allocated:
                raise forms.ValidationError, 'prefix is assigned to child'
            for p in parent.children.all():
                c = p.as_resource_range()
                if c.min <= r.min <= c.max or c.min <= r.max <= c.max:
                    raise forms.ValidationError, \
                            'overlap with another child prefix: %s' % (c,)

            return self.cleaned_data
    return _wrapper(*args, **kwargs)

def PrefixAllocateForm(iv, child_set, *args, **kwargs):
    class _wrapper(forms.Form):
        child = forms.ModelChoiceField(initial=iv, queryset=child_set,
                required=False, empty_label='(Unallocated)')
    return _wrapper(*args, **kwargs)

def PrefixRoaForm(prefix, *args, **kwargs):
    prefix_range = prefix.as_resource_range()

    class _wrapper(forms.Form):
        asns = forms.CharField(max_length=200, required=False,
                help_text='Comma-separated list of ASNs')
        max_length = forms.IntegerField(min_value=prefix_range.prefixlen(),
                max_value=prefix_range.datum_type.bits,
                initial=prefix_range.prefixlen(),
                help_text='must be in range %d-%d' % (prefix_range.prefixlen(), prefix_range.datum_type.bits))

        def clean_asns(self):
            try:
                v = asnset(self.cleaned_data.get('asns'))
                return ','.join(str(x) for x in sorted(v))
            except ValueError:
                raise forms.ValidationError, \
                        'Must be a list of integers separated by commas.'
            return self.cleaned_data['asns']

        def clean(self):
            if not prefix.is_prefix():
                raise forms.ValidationError, \
                        '%s can not be represented as a prefix.' % (prefix,)
            if prefix.allocated:
                raise forms.ValidationError, \
                        'Prefix is allocated to a child.'
            return self.cleaned_data

    return _wrapper(*args, **kwargs)

def PrefixDeleteForm(prefix, *args, **kwargs):
    class _wrapped(forms.Form):

        def clean(self):
            if not prefix.parent:
                raise forms.ValidationError, \
                        'Can not delete prefix received from parent'
            if prefix.allocated:
                raise forms.ValidationError, 'Prefix is allocated to child'
            if prefix.roa_requests.all():
                raise forms.ValidationError, 'Prefix is used in your ROAs'
            if prefix.children.all():
                raise forms.ValidationError, 'Prefix has been split'
            return self.cleaned_data

    return _wrapped(*args, **kwargs)

def GhostbusterForm(parent_qs, conf=None):
    """
    Generate a ModelForm with the subset of parents for the current
    resource handle.

    The 'conf' argument is required when creating a new object, in
    order to specify the value of the 'conf' field in the new
    Ghostbuster object.
    """
    class wrapped(forms.ModelForm):
        # override parent
        parent = forms.ModelMultipleChoiceField(queryset=parent_qs, required=False,
                help_text='use this record for a specific parent, or leave blank for all parents')
        # override full_name.  it is required in the db schema, but we allow the
        # user to skip it and default from family+given name
        full_name = forms.CharField(max_length=40, required=False,
                help_text='automatically generated from family and given names if left blank')

        class Meta:
            model = models.Ghostbuster
            exclude = [ 'conf' ]

        def clean(self):
            family_name = self.cleaned_data.get('family_name')
            given_name = self.cleaned_data.get('given_name')
            if not all([family_name, given_name]):
                raise forms.ValidationError, 'Family and Given names must be specified'

            email = self.cleaned_data.get('email_address')
            postal = self.cleaned_data.get('postal_address')
            telephone = self.cleaned_data.get('telephone')
            if not any([email, postal, telephone]):
                raise forms.ValidationError, 'One of telephone, email or postal address must be specified'

            # if the full name is not specified, default to given+family
            fn = self.cleaned_data.get('full_name')
            if not fn:
                self.cleaned_data['full_name'] = '%s %s' % (given_name, family_name)

            return self.cleaned_data

        def save(self, *args, **kwargs):
            if conf:
                # the generic create_object view doesn't allow us to set
                # the conf field, so wrap the save() method and set it
                # here
                kwargs['commit'] = False
                obj = super(wrapped, self).save(*args, **kwargs)
                obj.conf = conf
                obj.save()
                return obj
            else:
                return super(wrapped, self).save(*args, **kwargs)

    return wrapped

class ChildForm(forms.ModelForm):
    """
    Subclass for editing rpki.gui.app.models.Child objects.
    """

    class Meta:
        model = models.Child
        exclude = [ 'conf', 'handle' ]

def ImportChildForm(parent_conf, *args, **kwargs):
    class wrapped(forms.Form):
        handle = forms.CharField(max_length=30, help_text="Child's RPKI handle")
        xml = forms.FileField(help_text="Child's identity.xml file")

        def clean_handle(self):
            if parent_conf.children.filter(handle=self.cleaned_data['handle']):
                raise forms.ValidationError, "a child with that handle already exists"
            return self.cleaned_data['handle']

    return wrapped(*args, **kwargs)

def ImportParentForm(conf, *args, **kwargs):
    class wrapped(forms.Form):
        handle = forms.CharField(max_length=30, help_text="Parent's RPKI handle", required=True)
        xml = forms.FileField(help_text="XML response from parent", required=True,
                widget=forms.FileInput(attrs={'class': 'xlarge'}))

        def clean_handle(self):
            if conf.parents.filter(handle=self.cleaned_data['handle']):
                raise forms.ValidationError, "a parent with that handle already exists"
            return self.cleaned_data['handle']

    return wrapped(*args, **kwargs)

class ImportRepositoryForm(forms.Form):
    parent_handle = forms.CharField(max_length=30, required=False, help_text='(optional)')
    xml = forms.FileField(help_text='xml file from repository operator')

class ImportPubClientForm(forms.Form):
    xml = forms.FileField(help_text='xml file from publication client')

def ChildWizardForm(parent, *args, **kwargs):
    class wrapped(forms.Form):
        handle = forms.CharField(max_length=30, help_text='handle for new child')
        #create_user = forms.BooleanField(help_text='create a new user account for this handle?')
        #password = forms.CharField(widget=forms.PasswordInput, help_text='password for new user', required=False)
        #password2 = forms.CharField(widget=forms.PasswordInput, help_text='repeat password', required=False)

        def clean_handle(self):
            if parent.children.filter(handle=self.cleaned_data['handle']):
                raise forms.ValidationError, 'a child with that handle already exists'
            return self.cleaned_data['handle']

    return wrapped(*args, **kwargs)

class GenericConfirmationForm(forms.Form):
    """
    stub form used for doing confirmations.
    """
    pass

# vim:sw=4 ts=8 expandtab