Statistics
| Branch: | Tag: | Revision:

root / snf-astakos-app / astakos / im / forms.py @ 3e87075a

History | View | Annotate | Download (40.8 kB)

1
# Copyright 2011-2012 GRNET S.A. All rights reserved.
2
#
3
# Redistribution and use in source and binary forms, with or
4
# without modification, are permitted provided that the following
5
# conditions are met:
6
#
7
#   1. Redistributions of source code must retain the above
8
#      copyright notice, this list of conditions and the following
9
#      disclaimer.
10
#
11
#   2. Redistributions in binary form must reproduce the above
12
#      copyright notice, this list of conditions and the following
13
#      disclaimer in the documentation and/or other materials
14
#      provided with the distribution.
15
#
16
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
# POSSIBILITY OF SUCH DAMAGE.
28
#
29
# The views and conclusions contained in the software and
30
# documentation are those of the authors and should not be
31
# interpreted as representing official policies, either expressed
32
# or implied, of GRNET S.A.
33
from random import random
34
from datetime import datetime
35

    
36
from django import forms
37
from django.utils.translation import ugettext as _
38
from django.contrib.auth.forms import UserCreationForm, AuthenticationForm, \
39
    PasswordResetForm, PasswordChangeForm, SetPasswordForm
40
from django.core.mail import send_mail, get_connection
41
from django.contrib.auth.tokens import default_token_generator
42
from django.core.urlresolvers import reverse
43
from django.utils.safestring import mark_safe
44
from django.utils.encoding import smart_str
45
from django.db import transaction
46
from django.core import validators
47

    
48
from synnefo.util import units
49
from synnefo_branding.utils import render_to_string
50
from synnefo.lib import join_urls
51
from astakos.im.models import AstakosUser, EmailChange, Invitation, Resource, \
52
    PendingThirdPartyUser, get_latest_terms, ProjectApplication, Project
53
from astakos.im import presentation
54
from astakos.im.widgets import DummyWidget, RecaptchaWidget
55
from astakos.im.functions import send_change_email, submit_application, \
56
    accept_membership_project_checks, ProjectError
57

    
58
from astakos.im.util import reserved_verified_email, model_to_dict
59
from astakos.im import auth_providers
60
from astakos.im import settings
61

    
62
import astakos.im.messages as astakos_messages
63

    
64
import logging
65
import hashlib
66
import recaptcha.client.captcha as captcha
67
import re
68

    
69
logger = logging.getLogger(__name__)
70

    
71
DOMAIN_VALUE_REGEX = re.compile(
72
    r'^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,6}$',
73
    re.IGNORECASE)
74

    
75

    
76
class StoreUserMixin(object):
77

    
78
    def store_user(self, user, request=None):
79
        """
80
        WARNING: this should be wrapped inside a transactional view/method.
81
        """
82
        user.save()
83
        self.post_store_user(user, request)
84
        return user
85

    
86
    def post_store_user(self, user, request):
87
        """
88
        Interface method for descendant backends to be able to do stuff within
89
        the transaction enabled by store_user.
90
        """
91
        pass
92

    
93

    
94
class LocalUserCreationForm(UserCreationForm, StoreUserMixin):
95
    """
96
    Extends the built in UserCreationForm in several ways:
97

98
    * Adds email, first_name, last_name, recaptcha_challenge_field,
99
    * recaptcha_response_field field.
100
    * The username field isn't visible and it is assigned a generated id.
101
    * User created is not active.
102
    """
103
    recaptcha_challenge_field = forms.CharField(widget=DummyWidget)
104
    recaptcha_response_field = forms.CharField(
105
        widget=RecaptchaWidget, label='')
106

    
107
    class Meta:
108
        model = AstakosUser
109
        fields = ("email", "first_name", "last_name",
110
                  "has_signed_terms", "has_signed_terms")
111

    
112
    def __init__(self, *args, **kwargs):
113
        """
114
        Changes the order of fields, and removes the username field.
115
        """
116
        request = kwargs.pop('request', None)
117
        provider = kwargs.pop('provider', 'local')
118

    
119
        # we only use LocalUserCreationForm for local provider
120
        if not provider == 'local':
121
            raise Exception('Invalid provider')
122

    
123
        self.ip = None
124
        if request:
125
            self.ip = request.META.get('REMOTE_ADDR',
126
                                       request.META.get('HTTP_X_REAL_IP',
127
                                                        None))
128

    
129
        super(LocalUserCreationForm, self).__init__(*args, **kwargs)
130
        self.fields.keyOrder = ['email', 'first_name', 'last_name',
131
                                'password1', 'password2']
132

    
133
        if settings.RECAPTCHA_ENABLED:
134
            self.fields.keyOrder.extend(['recaptcha_challenge_field',
135
                                         'recaptcha_response_field', ])
136
        if get_latest_terms():
137
            self.fields.keyOrder.append('has_signed_terms')
138

    
139
        if 'has_signed_terms' in self.fields:
140
            # Overriding field label since we need to apply a link
141
            # to the terms within the label
142
            terms_link_html = '<a href="%s" target="_blank">%s</a>' \
143
                % (reverse('latest_terms'), _("the terms"))
144
            self.fields['has_signed_terms'].label = \
145
                mark_safe("I agree with %s" % terms_link_html)
146

    
147
    def clean_email(self):
148
        email = self.cleaned_data['email']
149
        if not email:
150
            raise forms.ValidationError(_(astakos_messages.REQUIRED_FIELD))
151
        if reserved_verified_email(email):
152
            raise forms.ValidationError(_(astakos_messages.EMAIL_USED))
153
        return email
154

    
155
    def clean_has_signed_terms(self):
156
        has_signed_terms = self.cleaned_data['has_signed_terms']
157
        if not has_signed_terms:
158
            raise forms.ValidationError(_(astakos_messages.SIGN_TERMS))
159
        return has_signed_terms
160

    
161
    def clean_recaptcha_response_field(self):
162
        if 'recaptcha_challenge_field' in self.cleaned_data:
163
            self.validate_captcha()
164
        return self.cleaned_data['recaptcha_response_field']
165

    
166
    def clean_recaptcha_challenge_field(self):
167
        if 'recaptcha_response_field' in self.cleaned_data:
168
            self.validate_captcha()
169
        return self.cleaned_data['recaptcha_challenge_field']
170

    
171
    def validate_captcha(self):
172
        rcf = self.cleaned_data['recaptcha_challenge_field']
173
        rrf = self.cleaned_data['recaptcha_response_field']
174
        check = captcha.submit(
175
            rcf, rrf, settings.RECAPTCHA_PRIVATE_KEY, self.ip)
176
        if not check.is_valid:
177
            raise forms.ValidationError(_(
178
                astakos_messages.CAPTCHA_VALIDATION_ERR))
179

    
180
    def post_store_user(self, user, request=None):
181
        """
182
        Interface method for descendant backends to be able to do stuff within
183
        the transaction enabled by store_user.
184
        """
185
        user.add_auth_provider('local', auth_backend='astakos')
186
        user.set_password(self.cleaned_data['password1'])
187

    
188
    def save(self, commit=True):
189
        """
190
        Saves the email, first_name and last_name properties, after the normal
191
        save behavior is complete.
192
        """
193
        user = super(LocalUserCreationForm, self).save(commit=False)
194
        user.date_signed_terms = datetime.now()
195
        user.renew_token()
196
        if commit:
197
            user.save()
198
            logger.info('Created user %s', user.log_display)
199
        return user
200

    
201

    
202
class InvitedLocalUserCreationForm(LocalUserCreationForm):
203
    """
204
    Extends the LocalUserCreationForm: email is readonly.
205
    """
206
    class Meta:
207
        model = AstakosUser
208
        fields = ("email", "first_name", "last_name", "has_signed_terms")
209

    
210
    def __init__(self, *args, **kwargs):
211
        """
212
        Changes the order of fields, and removes the username field.
213
        """
214
        super(InvitedLocalUserCreationForm, self).__init__(*args, **kwargs)
215

    
216
        #set readonly form fields
217
        ro = ('email', 'username',)
218
        for f in ro:
219
            self.fields[f].widget.attrs['readonly'] = True
220

    
221
    def save(self, commit=True):
222
        user = super(InvitedLocalUserCreationForm, self).save(commit=False)
223
        user.set_invitations_level()
224
        user.email_verified = True
225
        if commit:
226
            user.save()
227
        return user
228

    
229

    
230
class ThirdPartyUserCreationForm(forms.ModelForm, StoreUserMixin):
231
    email = forms.EmailField(
232
        label='Contact email',
233
        help_text='This is needed for contact purposes. '
234
        'It doesn&#39;t need to be the same with the one you '
235
        'provided to login previously. '
236
    )
237

    
238
    class Meta:
239
        model = AstakosUser
240
        fields = ['email', 'first_name', 'last_name', 'has_signed_terms']
241

    
242
    def __init__(self, *args, **kwargs):
243
        """
244
        Changes the order of fields, and removes the username field.
245
        """
246

    
247
        self.provider = kwargs.pop('provider', None)
248
        self.request = kwargs.pop('request', None)
249
        if not self.provider or self.provider == 'local':
250
            raise Exception('Invalid provider, %r' % self.provider)
251

    
252
        # ThirdPartyUserCreationForm should always get instantiated with
253
        # a third_party_token value
254
        self.third_party_token = kwargs.pop('third_party_token', None)
255
        if not self.third_party_token:
256
            raise Exception('ThirdPartyUserCreationForm'
257
                            ' requires third_party_token')
258

    
259
        super(ThirdPartyUserCreationForm, self).__init__(*args, **kwargs)
260

    
261
        if not get_latest_terms():
262
            del self.fields['has_signed_terms']
263

    
264
        if 'has_signed_terms' in self.fields:
265
            # Overriding field label since we need to apply a link
266
            # to the terms within the label
267
            terms_link_html = '<a href="%s" target="_blank">%s</a>' \
268
                % (reverse('latest_terms'), _("the terms"))
269
            self.fields['has_signed_terms'].label = \
270
                mark_safe("I agree with %s" % terms_link_html)
271

    
272
    def clean_email(self):
273
        email = self.cleaned_data['email']
274
        if not email:
275
            raise forms.ValidationError(_(astakos_messages.REQUIRED_FIELD))
276
        if reserved_verified_email(email):
277
            provider_id = self.provider
278
            provider = auth_providers.get_provider(provider_id)
279
            extra_message = provider.get_add_to_existing_account_msg
280

    
281
            raise forms.ValidationError(mark_safe(
282
                _(astakos_messages.EMAIL_USED) + ' ' + extra_message))
283
        return email
284

    
285
    def clean_has_signed_terms(self):
286
        has_signed_terms = self.cleaned_data['has_signed_terms']
287
        if not has_signed_terms:
288
            raise forms.ValidationError(_(astakos_messages.SIGN_TERMS))
289
        return has_signed_terms
290

    
291
    def _get_pending_user(self):
292
        return PendingThirdPartyUser.objects.get(token=self.third_party_token)
293

    
294
    def post_store_user(self, user, request=None):
295
        pending = self._get_pending_user()
296
        provider = pending.get_provider(user)
297
        provider.add_to_user()
298
        pending.delete()
299

    
300
    def save(self, commit=True):
301
        user = super(ThirdPartyUserCreationForm, self).save(commit=False)
302
        user.set_unusable_password()
303
        user.renew_token()
304
        user.date_signed_terms = datetime.now()
305
        if commit:
306
            user.save()
307
            logger.info('Created user %s' % user.log_display)
308
        return user
309

    
310

    
311
class InvitedThirdPartyUserCreationForm(ThirdPartyUserCreationForm):
312
    """
313
    Extends the ThirdPartyUserCreationForm: email is readonly.
314
    """
315
    def __init__(self, *args, **kwargs):
316
        """
317
        Changes the order of fields, and removes the username field.
318
        """
319
        super(
320
            InvitedThirdPartyUserCreationForm, self).__init__(*args, **kwargs)
321

    
322
        #set readonly form fields
323
        ro = ('email',)
324
        for f in ro:
325
            self.fields[f].widget.attrs['readonly'] = True
326

    
327
    def save(self, commit=True):
328
        user = super(
329
            InvitedThirdPartyUserCreationForm, self).save(commit=False)
330
        user.set_invitation_level()
331
        user.email_verified = True
332
        if commit:
333
            user.save()
334
        return user
335

    
336

    
337
class ShibbolethUserCreationForm(ThirdPartyUserCreationForm):
338
    additional_email = forms.CharField(
339
        widget=forms.HiddenInput(), label='', required=False)
340

    
341
    def __init__(self, *args, **kwargs):
342
        super(ShibbolethUserCreationForm, self).__init__(*args, **kwargs)
343
        # copy email value to additional_mail in case user will change it
344
        name = 'email'
345
        field = self.fields[name]
346
        self.initial['additional_email'] = self.initial.get(
347
            name, field.initial)
348
        self.initial['email'] = None
349

    
350

    
351
class InvitedShibbolethUserCreationForm(ShibbolethUserCreationForm,
352
                                        InvitedThirdPartyUserCreationForm):
353
    pass
354

    
355

    
356
class LoginForm(AuthenticationForm):
357
    username = forms.EmailField(label=_("Email"))
358
    recaptcha_challenge_field = forms.CharField(widget=DummyWidget)
359
    recaptcha_response_field = forms.CharField(
360
        widget=RecaptchaWidget, label='')
361

    
362
    def __init__(self, *args, **kwargs):
363
        was_limited = kwargs.get('was_limited', False)
364
        request = kwargs.get('request', None)
365
        if request:
366
            self.ip = request.META.get(
367
                'REMOTE_ADDR',
368
                request.META.get('HTTP_X_REAL_IP', None))
369

    
370
        t = ('request', 'was_limited')
371
        for elem in t:
372
            if elem in kwargs.keys():
373
                kwargs.pop(elem)
374
        super(LoginForm, self).__init__(*args, **kwargs)
375

    
376
        self.fields.keyOrder = ['username', 'password']
377
        if was_limited and settings.RECAPTCHA_ENABLED:
378
            self.fields.keyOrder.extend(['recaptcha_challenge_field',
379
                                         'recaptcha_response_field', ])
380

    
381
    def clean_username(self):
382
        return self.cleaned_data['username'].lower()
383

    
384
    def clean_recaptcha_response_field(self):
385
        if 'recaptcha_challenge_field' in self.cleaned_data:
386
            self.validate_captcha()
387
        return self.cleaned_data['recaptcha_response_field']
388

    
389
    def clean_recaptcha_challenge_field(self):
390
        if 'recaptcha_response_field' in self.cleaned_data:
391
            self.validate_captcha()
392
        return self.cleaned_data['recaptcha_challenge_field']
393

    
394
    def validate_captcha(self):
395
        rcf = self.cleaned_data['recaptcha_challenge_field']
396
        rrf = self.cleaned_data['recaptcha_response_field']
397
        check = captcha.submit(
398
            rcf, rrf, settings.RECAPTCHA_PRIVATE_KEY, self.ip)
399
        if not check.is_valid:
400
            raise forms.ValidationError(_(
401
                astakos_messages.CAPTCHA_VALIDATION_ERR))
402

    
403
    def clean(self):
404
        """
405
        Override default behavior in order to check user's activation later
406
        """
407
        username = self.cleaned_data.get('username')
408

    
409
        if username:
410
            try:
411
                user = AstakosUser.objects.get_by_identifier(username)
412
                if not user.has_auth_provider('local'):
413
                    provider = auth_providers.get_provider('local', user)
414
                    msg = provider.get_login_disabled_msg
415
                    raise forms.ValidationError(mark_safe(msg))
416
            except AstakosUser.DoesNotExist:
417
                pass
418

    
419
        try:
420
            super(LoginForm, self).clean()
421
        except forms.ValidationError, e:
422
            if self.user_cache is None:
423
                raise
424
            if not self.user_cache.is_active:
425
                msg = self.user_cache.get_inactive_message('local')
426
                raise forms.ValidationError(msg)
427
            if self.request:
428
                if not self.request.session.test_cookie_worked():
429
                    raise
430
        return self.cleaned_data
431

    
432

    
433
class ProfileForm(forms.ModelForm):
434
    """
435
    Subclass of ``ModelForm`` for permiting user to edit his/her profile.
436
    Most of the fields are readonly since the user is not allowed to change
437
    them.
438

439
    The class defines a save method which sets ``is_verified`` to True so as
440
    the user during the next login will not to be redirected to profile page.
441
    """
442
    email = forms.EmailField(label='E-mail address',
443
                             help_text='E-mail address')
444
    renew = forms.BooleanField(label='Renew token', required=False)
445

    
446
    class Meta:
447
        model = AstakosUser
448
        fields = ('email', 'first_name', 'last_name')
449

    
450
    def __init__(self, *args, **kwargs):
451
        self.session_key = kwargs.pop('session_key', None)
452
        super(ProfileForm, self).__init__(*args, **kwargs)
453
        instance = getattr(self, 'instance', None)
454
        ro_fields = ('email',)
455
        if instance and instance.id:
456
            for field in ro_fields:
457
                self.fields[field].widget.attrs['readonly'] = True
458

    
459
    def clean_email(self):
460
        return self.instance.email
461

    
462
    def save(self, commit=True):
463
        user = super(ProfileForm, self).save(commit=False)
464
        user.is_verified = True
465
        if self.cleaned_data.get('renew'):
466
            user.renew_token(
467
                flush_sessions=True,
468
                current_key=self.session_key
469
            )
470
        if commit:
471
            user.save()
472
        return user
473

    
474

    
475
class FeedbackForm(forms.Form):
476
    """
477
    Form for writing feedback.
478
    """
479
    feedback_msg = forms.CharField(widget=forms.Textarea, label=u'Message')
480
    feedback_data = forms.CharField(widget=forms.HiddenInput(), label='',
481
                                    required=False)
482

    
483

    
484
class SendInvitationForm(forms.Form):
485
    """
486
    Form for sending an invitations
487
    """
488

    
489
    email = forms.EmailField(required=True, label='Email address')
490
    first_name = forms.EmailField(label='First name')
491
    last_name = forms.EmailField(label='Last name')
492

    
493

    
494
class ExtendedPasswordResetForm(PasswordResetForm):
495
    """
496
    Extends PasswordResetForm by overriding
497

498
    save method: to pass a custom from_email in send_mail.
499
    clean_email: to handle local auth provider checks
500
    """
501
    def clean_email(self):
502
        # we override the default django auth clean_email to provide more
503
        # detailed messages in case of inactive users
504
        email = self.cleaned_data['email']
505
        try:
506
            user = AstakosUser.objects.get_by_identifier(email)
507
            self.users_cache = [user]
508
            if not user.is_active:
509
                msg = mark_safe(user.get_inactive_message('local'))
510
                raise forms.ValidationError(msg)
511

    
512
            provider = auth_providers.get_provider('local', user)
513
            if not user.has_usable_password():
514
                msg = provider.get_unusable_password_msg
515
                raise forms.ValidationError(mark_safe(msg))
516

    
517
            if not user.can_change_password():
518
                msg = provider.get_cannot_change_password_msg
519
                raise forms.ValidationError(mark_safe(msg))
520

    
521
        except AstakosUser.DoesNotExist:
522
            raise forms.ValidationError(_(astakos_messages.EMAIL_UNKNOWN))
523
        return email
524

    
525
    def save(self, domain_override=None,
526
             email_template_name='registration/password_reset_email.html',
527
             use_https=False, token_generator=default_token_generator,
528
             request=None):
529
        """
530
        Generates a one-use only link for resetting password and sends to the
531
        user.
532
        """
533
        for user in self.users_cache:
534
            url = user.astakosuser.get_password_reset_url(token_generator)
535
            url = join_urls(settings.BASE_HOST, url)
536
            c = {
537
                'email': user.email,
538
                'url': url,
539
                'site_name': settings.SITENAME,
540
                'user': user,
541
                'baseurl': settings.BASE_URL,
542
                'support': settings.CONTACT_EMAIL
543
            }
544
            message = render_to_string(email_template_name, c)
545
            from_email = settings.SERVER_EMAIL
546
            send_mail(_(astakos_messages.PASSWORD_RESET_EMAIL_SUBJECT),
547
                      message,
548
                      from_email,
549
                      [user.email],
550
                      connection=get_connection())
551

    
552

    
553
class EmailChangeForm(forms.ModelForm):
554

    
555
    class Meta:
556
        model = EmailChange
557
        fields = ('new_email_address',)
558

    
559
    def clean_new_email_address(self):
560
        addr = self.cleaned_data['new_email_address']
561
        if reserved_verified_email(addr):
562
            raise forms.ValidationError(_(astakos_messages.EMAIL_USED))
563
        return addr
564

    
565
    def save(self, request,
566
             email_template_name='registration/email_change_email.txt',
567
             commit=True):
568
        ec = super(EmailChangeForm, self).save(commit=False)
569
        ec.user = request.user
570
        # delete pending email changes
571
        request.user.emailchanges.all().delete()
572

    
573
        activation_key = hashlib.sha1(
574
            str(random()) + smart_str(ec.new_email_address))
575
        ec.activation_key = activation_key.hexdigest()
576
        if commit:
577
            ec.save()
578
        send_change_email(ec, request, email_template_name=email_template_name)
579

    
580

    
581
class SignApprovalTermsForm(forms.ModelForm):
582

    
583
    class Meta:
584
        model = AstakosUser
585
        fields = ("has_signed_terms",)
586

    
587
    def __init__(self, *args, **kwargs):
588
        super(SignApprovalTermsForm, self).__init__(*args, **kwargs)
589

    
590
    def clean_has_signed_terms(self):
591
        has_signed_terms = self.cleaned_data['has_signed_terms']
592
        if not has_signed_terms:
593
            raise forms.ValidationError(_(astakos_messages.SIGN_TERMS))
594
        return has_signed_terms
595

    
596
    def save(self, commit=True):
597
        user = super(SignApprovalTermsForm, self).save(commit)
598
        user.date_signed_terms = datetime.now()
599
        if commit:
600
            user.save()
601
        return user
602

    
603

    
604
class InvitationForm(forms.ModelForm):
605

    
606
    username = forms.EmailField(label=_("Email"))
607

    
608
    def __init__(self, *args, **kwargs):
609
        super(InvitationForm, self).__init__(*args, **kwargs)
610

    
611
    class Meta:
612
        model = Invitation
613
        fields = ('username', 'realname')
614

    
615
    def clean_username(self):
616
        username = self.cleaned_data['username']
617
        try:
618
            Invitation.objects.get(username=username)
619
            raise forms.ValidationError(
620
                _(astakos_messages.INVITATION_EMAIL_EXISTS))
621
        except Invitation.DoesNotExist:
622
            pass
623
        return username
624

    
625

    
626
class ExtendedPasswordChangeForm(PasswordChangeForm):
627
    """
628
    Extends PasswordChangeForm by enabling user
629
    to optionally renew also the token.
630
    """
631
    if not settings.NEWPASSWD_INVALIDATE_TOKEN:
632
        renew = forms.BooleanField(
633
            label='Renew token', required=False,
634
            initial=True,
635
            help_text='Unsetting this may result in security risk.')
636

    
637
    def __init__(self, user, *args, **kwargs):
638
        self.session_key = kwargs.pop('session_key', None)
639
        super(ExtendedPasswordChangeForm, self).__init__(user, *args, **kwargs)
640

    
641
    def save(self, commit=True):
642
        try:
643
            if settings.NEWPASSWD_INVALIDATE_TOKEN or \
644
                    self.cleaned_data.get('renew'):
645
                self.user.renew_token()
646
            self.user.flush_sessions(current_key=self.session_key)
647
        except AttributeError:
648
            # if user model does has not such methods
649
            pass
650
        return super(ExtendedPasswordChangeForm, self).save(commit=commit)
651

    
652

    
653
class ExtendedSetPasswordForm(SetPasswordForm):
654
    """
655
    Extends SetPasswordForm by enabling user
656
    to optionally renew also the token.
657
    """
658
    if not settings.NEWPASSWD_INVALIDATE_TOKEN:
659
        renew = forms.BooleanField(
660
            label='Renew token',
661
            required=False,
662
            initial=True,
663
            help_text='Unsetting this may result in security risk.')
664

    
665
    def __init__(self, user, *args, **kwargs):
666
        super(ExtendedSetPasswordForm, self).__init__(user, *args, **kwargs)
667

    
668
    @transaction.commit_on_success()
669
    def save(self, commit=True):
670
        try:
671
            self.user = AstakosUser.objects.get(id=self.user.id)
672
            if settings.NEWPASSWD_INVALIDATE_TOKEN or \
673
                    self.cleaned_data.get('renew'):
674
                self.user.renew_token()
675

    
676
            provider = auth_providers.get_provider('local', self.user)
677
            if provider.get_add_policy:
678
                provider.add_to_user()
679

    
680
        except BaseException, e:
681
            logger.exception(e)
682
        return super(ExtendedSetPasswordForm, self).save(commit=commit)
683

    
684

    
685
app_name_label = "Project name"
686
app_name_placeholder = _("myproject.mylab.ntua.gr")
687
app_name_validator = validators.RegexValidator(
688
    DOMAIN_VALUE_REGEX,
689
    _(astakos_messages.DOMAIN_VALUE_ERR),
690
    'invalid')
691
app_name_help = _("""
692
        The project's name should be in a domain format.
693
        The domain shouldn't neccessarily exist in the real
694
        world but is helpful to imply a structure.
695
        e.g.: myproject.mylab.ntua.gr or
696
        myservice.myteam.myorganization""")
697
app_name_widget = forms.TextInput(
698
    attrs={'placeholder': app_name_placeholder})
699

    
700

    
701
app_home_label = "Homepage URL"
702
app_home_placeholder = 'myinstitution.org/myproject/'
703
app_home_help = _("""
704
        URL pointing at your project's site.
705
        e.g.: myinstitution.org/myproject/.
706
        Leave blank if there is no website.""")
707
app_home_widget = forms.TextInput(
708
    attrs={'placeholder': app_home_placeholder})
709

    
710
app_desc_label = _("Description")
711
app_desc_help = _("""
712
        Please provide a short but descriptive abstract of your
713
        project, so that anyone searching can quickly understand
714
        what this project is about.""")
715

    
716
app_comment_label = _("Comments for review (private)")
717
app_comment_help = _("""
718
        Write down any comments you may have for the reviewer
719
        of this application (e.g. background and rationale to
720
        support your request).
721
        The comments are strictly for the review process
722
        and will not be made public.""")
723

    
724
app_start_date_label = _("Start date")
725
app_start_date_help = _("""
726
        Provide a date when your need your project to be created,
727
        and members to be able to join and get resources.
728
        This date is only a hint to help prioritize reviews.""")
729

    
730
app_end_date_label = _("Termination date")
731
app_end_date_help = _("""
732
        At this date, the project will be automatically terminated
733
        and its resource grants revoked from all members. If you are
734
        not certain, it is best to start with a conservative estimation.
735
        You can always re-apply for an extension, if you need.""")
736

    
737
join_policy_label = _("Joining policy")
738
app_member_join_policy_help = _("""
739
        Select how new members are accepted into the project.""")
740
leave_policy_label = _("Leaving policy")
741
app_member_leave_policy_help = _("""
742
        Select how new members can leave the project.""")
743

    
744
max_members_label = _("Maximum member count")
745
max_members_help = _("""
746
        Specify the maximum number of members this project may have,
747
        including the owner. Beyond this number, no new members
748
        may join the project and be granted the project resources.
749
        If you are not certain, it is best to start with a conservative
750
        limit. You can always request a raise when you need it.""")
751

    
752
join_policies = presentation.PROJECT_MEMBER_JOIN_POLICIES.items()
753
leave_policies = presentation.PROJECT_MEMBER_LEAVE_POLICIES.items()
754

    
755

    
756
class ProjectApplicationForm(forms.ModelForm):
757

    
758
    name = forms.CharField(
759
        label=app_name_label,
760
        help_text=app_name_help,
761
        widget=app_name_widget,
762
        validators=[app_name_validator])
763

    
764
    homepage = forms.URLField(
765
        label=app_home_label,
766
        help_text=app_home_help,
767
        widget=app_home_widget,
768
        required=False)
769

    
770
    description = forms.CharField(
771
        label=app_desc_label,
772
        help_text=app_desc_help,
773
        widget=forms.Textarea,
774
        required=False)
775

    
776
    comments = forms.CharField(
777
        label=app_comment_label,
778
        help_text=app_comment_help,
779
        widget=forms.Textarea,
780
        required=False)
781

    
782
    start_date = forms.DateTimeField(
783
        label=app_start_date_label,
784
        help_text=app_start_date_help,
785
        required=False)
786

    
787
    end_date = forms.DateTimeField(
788
        label=app_end_date_label,
789
        help_text=app_end_date_help)
790

    
791
    member_join_policy = forms.TypedChoiceField(
792
        label=join_policy_label,
793
        help_text=app_member_join_policy_help,
794
        initial=2,
795
        coerce=int,
796
        choices=join_policies)
797

    
798
    member_leave_policy = forms.TypedChoiceField(
799
        label=leave_policy_label,
800
        help_text=app_member_leave_policy_help,
801
        coerce=int,
802
        choices=leave_policies)
803

    
804
    limit_on_members_number = forms.IntegerField(
805
        label=max_members_label,
806
        help_text=max_members_help,
807
        min_value=0,
808
        required=False)
809

    
810
    class Meta:
811
        model = ProjectApplication
812
        fields = ('name', 'homepage', 'description',
813
                  'start_date', 'end_date', 'comments',
814
                  'member_join_policy', 'member_leave_policy',
815
                  'limit_on_members_number')
816

    
817
    def __init__(self, *args, **kwargs):
818
        instance = kwargs.get('instance')
819
        self.precursor_application = instance
820
        super(ProjectApplicationForm, self).__init__(*args, **kwargs)
821
        # in case of new application remove closed join policy
822
        if not instance:
823
            policies = presentation.PROJECT_MEMBER_JOIN_POLICIES.copy()
824
            policies.pop(3)
825
            self.fields['member_join_policy'].choices = policies.iteritems()
826

    
827
    def clean_start_date(self):
828
        start_date = self.cleaned_data.get('start_date')
829
        if not self.precursor_application:
830
            today = datetime.now()
831
            today = datetime(today.year, today.month, today.day)
832
            if start_date and (start_date - today).days < 0:
833
                raise forms.ValidationError(
834
                    _(astakos_messages.INVALID_PROJECT_START_DATE))
835
        return start_date
836

    
837
    def clean_end_date(self):
838
        start_date = self.cleaned_data.get('start_date')
839
        end_date = self.cleaned_data.get('end_date')
840
        today = datetime.now()
841
        today = datetime(today.year, today.month, today.day)
842
        if end_date and (end_date - today).days < 0:
843
            raise forms.ValidationError(
844
                _(astakos_messages.INVALID_PROJECT_END_DATE))
845
        if start_date and (end_date - start_date).days <= 0:
846
            raise forms.ValidationError(
847
                _(astakos_messages.INCONSISTENT_PROJECT_DATES))
848
        return end_date
849

    
850
    def clean(self):
851
        userid = self.data.get('user', None)
852
        policies = self.resource_policies
853
        self.user = None
854
        if userid:
855
            try:
856
                self.user = AstakosUser.objects.get(id=userid)
857
            except AstakosUser.DoesNotExist:
858
                pass
859
        if not self.user:
860
            raise forms.ValidationError(_(astakos_messages.NO_APPLICANT))
861
        super(ProjectApplicationForm, self).clean()
862
        return self.cleaned_data
863

    
864
    @property
865
    def resource_policies(self):
866
        policies = []
867
        append = policies.append
868
        for name, value in self.data.iteritems():
869
            if not value:
870
                continue
871
            uplimit = value
872
            if name.endswith('_uplimit'):
873
                subs = name.split('_uplimit')
874
                prefix, suffix = subs
875
                try:
876
                    resource = Resource.objects.get(name=prefix)
877
                except Resource.DoesNotExist:
878
                    raise forms.ValidationError("Resource %s does not exist" %
879
                                                resource.name)
880
                # keep only resource limits for selected resource groups
881
                if self.data.get('is_selected_%s' %
882
                                 resource.group, "0") == "1":
883
                    if not resource.allow_in_projects:
884
                        raise forms.ValidationError("Invalid resource %s" %
885
                                                    resource.name)
886
                    d = model_to_dict(resource)
887
                    try:
888
                        uplimit = long(uplimit)
889
                    except ValueError:
890
                        m = "Limit should be an integer"
891
                        raise forms.ValidationError(m)
892
                    display = units.show(uplimit, resource.unit)
893
                    d.update(dict(resource=prefix, uplimit=uplimit,
894
                                  display_uplimit=display))
895
                    append(d)
896

    
897
        ordered_keys = presentation.RESOURCES['resources_order']
898

    
899
        def resource_order(r):
900
            if r['str_repr'] in ordered_keys:
901
                return ordered_keys.index(r['str_repr'])
902
            else:
903
                return -1
904

    
905
        policies = sorted(policies, key=resource_order)
906
        return policies
907

    
908
    def cleaned_resource_policies(self):
909
        policies = {}
910
        for d in self.resource_policies:
911
            policies[d["name"]] = {
912
                "project_capacity": None,
913
                "member_capacity": d["uplimit"]
914
            }
915

    
916
        return policies
917

    
918
    def save(self, commit=True):
919
        data = dict(self.cleaned_data)
920
        is_new = self.instance.id is None
921
        data['project_id'] = self.instance.chain.id if not is_new else None
922
        data['owner'] = self.user if is_new else self.instance.owner
923
        data['resources'] = self.cleaned_resource_policies()
924
        data['request_user'] = self.user
925
        submit_application(**data)
926

    
927

    
928
class ProjectSortForm(forms.Form):
929
    sorting = forms.ChoiceField(
930
        label='Sort by',
931
        choices=(('name', 'Sort by Name'),
932
                 ('issue_date', 'Sort by Issue date'),
933
                 ('start_date', 'Sort by Start Date'),
934
                 ('end_date', 'Sort by End Date'),
935
                 # ('approved_members_num', 'Sort by Participants'),
936
                 ('state', 'Sort by Status'),
937
                 ('member_join_policy__description',
938
                  'Sort by Member Join Policy'),
939
                 ('member_leave_policy__description',
940
                  'Sort by Member Leave Policy'),
941
                 ('-name', 'Sort by Name'),
942
                 ('-issue_date', 'Sort by Issue date'),
943
                 ('-start_date', 'Sort by Start Date'),
944
                 ('-end_date', 'Sort by End Date'),
945
                 # ('-approved_members_num', 'Sort by Participants'),
946
                 ('-state', 'Sort by Status'),
947
                 ('-member_join_policy__description',
948
                  'Sort by Member Join Policy'),
949
                 ('-member_leave_policy__description',
950
                  'Sort by Member Leave Policy')
951
                 ),
952
        required=True
953
    )
954

    
955

    
956
class AddProjectMembersForm(forms.Form):
957
    q = forms.CharField(
958
        widget=forms.Textarea(
959
            attrs={
960
                'placeholder':
961
                astakos_messages.ADD_PROJECT_MEMBERS_Q_PLACEHOLDER}),
962
        label=_('Add members'),
963
        help_text=_(astakos_messages.ADD_PROJECT_MEMBERS_Q_HELP),
964
        required=True,)
965

    
966
    def __init__(self, *args, **kwargs):
967
        chain_id = kwargs.pop('chain_id', None)
968
        if chain_id:
969
            self.project = Project.objects.get(id=chain_id)
970
        self.request_user = kwargs.pop('request_user', None)
971
        super(AddProjectMembersForm, self).__init__(*args, **kwargs)
972

    
973
    def clean(self):
974
        try:
975
            accept_membership_project_checks(self.project, self.request_user)
976
        except ProjectError as e:
977
            raise forms.ValidationError(e)
978

    
979
        q = self.cleaned_data.get('q') or ''
980
        users = q.split(',')
981
        users = list(u.strip() for u in users if u)
982
        db_entries = AstakosUser.objects.verified().filter(email__in=users)
983
        unknown = list(set(users) - set(u.email for u in db_entries))
984
        if unknown:
985
            raise forms.ValidationError(
986
                _(astakos_messages.UNKNOWN_USERS) % ','.join(unknown))
987
        self.valid_users = db_entries
988
        return self.cleaned_data
989

    
990
    def get_valid_users(self):
991
        """Should be called after form cleaning"""
992
        try:
993
            return self.valid_users
994
        except:
995
            return ()
996

    
997

    
998
class ProjectMembersSortForm(forms.Form):
999
    sorting = forms.ChoiceField(
1000
        label='Sort by',
1001
        choices=(('person__email', 'User Id'),
1002
                 ('person__first_name', 'Name'),
1003
                 ('acceptance_date', 'Acceptance date')
1004
                 ),
1005
        required=True
1006
    )
1007

    
1008

    
1009
class ProjectSearchForm(forms.Form):
1010
    q = forms.CharField(max_length=200, label='Search project', required=False)
1011

    
1012

    
1013
class ExtendedProfileForm(ProfileForm):
1014
    """
1015
    Profile form that combines `email change` and `password change` user
1016
    actions by propagating submited data to internal EmailChangeForm
1017
    and ExtendedPasswordChangeForm objects.
1018
    """
1019

    
1020
    password_change_form = None
1021
    email_change_form = None
1022

    
1023
    password_change = False
1024
    email_change = False
1025

    
1026
    extra_forms_fields = {
1027
        'email': ['new_email_address'],
1028
        'password': ['old_password', 'new_password1', 'new_password2']
1029
    }
1030

    
1031
    fields = ('email')
1032
    change_password = forms.BooleanField(initial=False, required=False)
1033
    change_email = forms.BooleanField(initial=False, required=False)
1034

    
1035
    email_changed = False
1036
    password_changed = False
1037

    
1038
    def __init__(self, *args, **kwargs):
1039
        session_key = kwargs.get('session_key', None)
1040
        self.fields_list = [
1041
            'email',
1042
            'new_email_address',
1043
            'first_name',
1044
            'last_name',
1045
            'old_password',
1046
            'new_password1',
1047
            'new_password2',
1048
            'change_email',
1049
            'change_password',
1050
        ]
1051

    
1052
        super(ExtendedProfileForm, self).__init__(*args, **kwargs)
1053
        self.session_key = session_key
1054
        if self.instance.can_change_password():
1055
            self.password_change = True
1056
        else:
1057
            self.fields_list.remove('old_password')
1058
            self.fields_list.remove('new_password1')
1059
            self.fields_list.remove('new_password2')
1060
            self.fields_list.remove('change_password')
1061
            del self.fields['change_password']
1062

    
1063
        if settings.EMAILCHANGE_ENABLED and self.instance.can_change_email():
1064
            self.email_change = True
1065
        else:
1066
            self.fields_list.remove('new_email_address')
1067
            self.fields_list.remove('change_email')
1068
            del self.fields['change_email']
1069

    
1070
        self._init_extra_forms()
1071
        self.save_extra_forms = []
1072
        self.success_messages = []
1073
        self.fields.keyOrder = self.fields_list
1074

    
1075
    def _init_extra_form_fields(self):
1076
        if self.email_change:
1077
            self.fields.update(self.email_change_form.fields)
1078
            self.fields['new_email_address'].required = False
1079
            self.fields['email'].help_text = _(
1080
                'Change the email associated with '
1081
                'your account. This email will '
1082
                'remain active until you verify '
1083
                'your new one.')
1084

    
1085
        if self.password_change:
1086
            self.fields.update(self.password_change_form.fields)
1087
            self.fields['old_password'].required = False
1088
            self.fields['old_password'].label = _('Password')
1089
            self.fields['old_password'].help_text = _('Change your password.')
1090
            self.fields['old_password'].initial = 'password'
1091
            self.fields['new_password1'].required = False
1092
            self.fields['new_password2'].required = False
1093

    
1094
    def _update_extra_form_errors(self):
1095
        if self.cleaned_data.get('change_password'):
1096
            self.errors.update(self.password_change_form.errors)
1097
        if self.cleaned_data.get('change_email'):
1098
            self.errors.update(self.email_change_form.errors)
1099

    
1100
    def _init_extra_forms(self):
1101
        self.email_change_form = EmailChangeForm(self.data)
1102
        self.password_change_form = ExtendedPasswordChangeForm(
1103
            user=self.instance,
1104
            data=self.data, session_key=self.session_key)
1105
        self._init_extra_form_fields()
1106

    
1107
    def is_valid(self):
1108
        password, email = True, True
1109
        profile = super(ExtendedProfileForm, self).is_valid()
1110
        if profile and self.cleaned_data.get('change_password', None):
1111
            self.password_change_form.fields['new_password1'].required = True
1112
            self.password_change_form.fields['new_password2'].required = True
1113
            password = self.password_change_form.is_valid()
1114
            self.save_extra_forms.append('password')
1115
        if profile and self.cleaned_data.get('change_email'):
1116
            self.fields['new_email_address'].required = True
1117
            email = self.email_change_form.is_valid()
1118
            self.save_extra_forms.append('email')
1119

    
1120
        if not password or not email:
1121
            self._update_extra_form_errors()
1122

    
1123
        return all([profile, password, email])
1124

    
1125
    def save(self, request, *args, **kwargs):
1126
        if 'email' in self.save_extra_forms:
1127
            self.email_change_form.save(request, *args, **kwargs)
1128
            self.email_changed = True
1129
        if 'password' in self.save_extra_forms:
1130
            self.password_change_form.save(*args, **kwargs)
1131
            self.password_changed = True
1132
        return super(ExtendedProfileForm, self).save(*args, **kwargs)