Statistics
| Branch: | Tag: | Revision:

root / snf-astakos-app / astakos / im / models.py @ 5aac5dc4

History | View | Annotate | Download (78.2 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

    
34
import hashlib
35
import uuid
36
import logging
37
import json
38
import math
39

    
40
from time import asctime, sleep
41
from datetime import datetime, timedelta
42
from base64 import b64encode
43
from urlparse import urlparse
44
from urllib import quote
45
from random import randint
46
from collections import defaultdict, namedtuple
47

    
48
from django.db import models, IntegrityError, transaction, connection
49
from django.contrib.auth.models import User, UserManager, Group, Permission
50
from django.utils.translation import ugettext as _
51
from django.db import transaction
52
from django.core.exceptions import ValidationError
53
from django.db.models.signals import (
54
    pre_save, post_save, post_syncdb, post_delete)
55
from django.contrib.contenttypes.models import ContentType
56

    
57
from django.dispatch import Signal
58
from django.db.models import Q
59
from django.core.urlresolvers import reverse
60
from django.utils.http import int_to_base36
61
from django.contrib.auth.tokens import default_token_generator
62
from django.conf import settings
63
from django.utils.importlib import import_module
64
from django.utils.safestring import mark_safe
65
from django.core.validators import email_re
66
from django.core.exceptions import PermissionDenied, ObjectDoesNotExist
67

    
68
from astakos.im.settings import (
69
    DEFAULT_USER_LEVEL, INVITATIONS_PER_LEVEL,
70
    AUTH_TOKEN_DURATION, EMAILCHANGE_ACTIVATION_DAYS, LOGGING_LEVEL,
71
    SITENAME, SERVICES, MODERATION_ENABLED, RESOURCES_PRESENTATION_DATA,
72
    PROJECT_MEMBER_JOIN_POLICIES, PROJECT_MEMBER_LEAVE_POLICIES)
73
from astakos.im import settings as astakos_settings
74
from astakos.im.endpoints.qh import (
75
    register_users, send_quotas, qh_check_users, qh_get_quota_limits,
76
    register_services, register_resources, qh_add_quota, QuotaLimits,
77
    qh_query_serials, qh_ack_serials,
78
    QuotaValues, add_quota_values)
79
from astakos.im import auth_providers
80

    
81
import astakos.im.messages as astakos_messages
82
from .managers import ForUpdateManager
83

    
84
from synnefo.lib.quotaholder.api import QH_PRACTICALLY_INFINITE
85
from synnefo.lib.db.intdecimalfield import intDecimalField
86

    
87
logger = logging.getLogger(__name__)
88

    
89
DEFAULT_CONTENT_TYPE = None
90
_content_type = None
91

    
92
def get_content_type():
93
    global _content_type
94
    if _content_type is not None:
95
        return _content_type
96

    
97
    try:
98
        content_type = ContentType.objects.get(app_label='im', model='astakosuser')
99
    except:
100
        content_type = DEFAULT_CONTENT_TYPE
101
    _content_type = content_type
102
    return content_type
103

    
104
RESOURCE_SEPARATOR = '.'
105

    
106
inf = float('inf')
107

    
108
class Service(models.Model):
109
    name = models.CharField(_('Name'), max_length=255, unique=True, db_index=True)
110
    url = models.FilePathField()
111
    icon = models.FilePathField(blank=True)
112
    auth_token = models.CharField(_('Authentication Token'), max_length=32,
113
                                  null=True, blank=True)
114
    auth_token_created = models.DateTimeField(_('Token creation date'), null=True)
115
    auth_token_expires = models.DateTimeField(
116
        _('Token expiration date'), null=True)
117
    order = models.PositiveIntegerField(default=0)
118

    
119
    class Meta:
120
        ordering = ('order', )
121

    
122
    def renew_token(self, expiration_date=None):
123
        md5 = hashlib.md5()
124
        md5.update(self.name.encode('ascii', 'ignore'))
125
        md5.update(self.url.encode('ascii', 'ignore'))
126
        md5.update(asctime())
127

    
128
        self.auth_token = b64encode(md5.digest())
129
        self.auth_token_created = datetime.now()
130
        if expiration_date:
131
            self.auth_token_expires = expiration_date
132
        else:
133
            self.auth_token_expires = None
134

    
135
    def __str__(self):
136
        return self.name
137

    
138
    @property
139
    def resources(self):
140
        return self.resource_set.all()
141

    
142
    @resources.setter
143
    def resources(self, resources):
144
        for s in resources:
145
            self.resource_set.create(**s)
146

    
147

    
148
class ResourceMetadata(models.Model):
149
    key = models.CharField(_('Name'), max_length=255, unique=True, db_index=True)
150
    value = models.CharField(_('Value'), max_length=255)
151

    
152
_presentation_data = {}
153
def get_presentation(resource):
154
    global _presentation_data
155
    presentation = _presentation_data.get(resource, {})
156
    if not presentation:
157
        resource_presentation = RESOURCES_PRESENTATION_DATA.get('resources', {})
158
        presentation = resource_presentation.get(resource, {})
159
        _presentation_data[resource] = presentation
160
    return presentation
161

    
162
class Resource(models.Model):
163
    name = models.CharField(_('Name'), max_length=255)
164
    meta = models.ManyToManyField(ResourceMetadata)
165
    service = models.ForeignKey(Service)
166
    desc = models.TextField(_('Description'), null=True)
167
    unit = models.CharField(_('Name'), null=True, max_length=255)
168
    group = models.CharField(_('Group'), null=True, max_length=255)
169
    uplimit = intDecimalField(default=0)
170

    
171
    class Meta:
172
        unique_together = ("service", "name")
173

    
174
    def __str__(self):
175
        return '%s%s%s' % (self.service, RESOURCE_SEPARATOR, self.name)
176

    
177
    def full_name(self):
178
        return str(self)
179

    
180
    @property
181
    def help_text(self):
182
        return get_presentation(str(self)).get('help_text', '')
183

    
184
    @property
185
    def help_text_input_each(self):
186
        return get_presentation(str(self)).get('help_text_input_each', '')
187

    
188
    @property
189
    def is_abbreviation(self):
190
        return get_presentation(str(self)).get('is_abbreviation', False)
191

    
192
    @property
193
    def report_desc(self):
194
        return get_presentation(str(self)).get('report_desc', '')
195

    
196
    @property
197
    def placeholder(self):
198
        return get_presentation(str(self)).get('placeholder', '')
199

    
200
    @property
201
    def verbose_name(self):
202
        return get_presentation(str(self)).get('verbose_name', '')
203

    
204
    @property
205
    def display_name(self):
206
        name = self.verbose_name
207
        if self.is_abbreviation:
208
            name = name.upper()
209
        return name
210

    
211
    @property
212
    def pluralized_display_name(self):
213
        if not self.unit:
214
            return '%ss' % self.display_name
215
        return self.display_name
216

    
217

    
218
def load_service_resources():
219
    ss = []
220
    rs = []
221
    for service_name, data in SERVICES.iteritems():
222
        url = data.get('url')
223
        resources = data.get('resources') or ()
224
        service, created = Service.objects.get_or_create(
225
            name=service_name,
226
            defaults={'url': url}
227
        )
228
        ss.append(service)
229

    
230
        for resource in resources:
231
            try:
232
                resource_name = resource.pop('name', '')
233
                r, created = Resource.objects.get_or_create(
234
                    service=service,
235
                    name=resource_name,
236
                    defaults=resource)
237
                rs.append(r)
238

    
239
            except Exception, e:
240
                print "Cannot create resource ", resource_name
241
                continue
242
    register_services(ss)
243
    register_resources(rs)
244

    
245
def _quota_values(capacity):
246
    return QuotaValues(
247
        quantity = 0,
248
        capacity = capacity,
249
        import_limit = QH_PRACTICALLY_INFINITE,
250
        export_limit = QH_PRACTICALLY_INFINITE)
251

    
252
def get_default_quota():
253
    _DEFAULT_QUOTA = {}
254
    resources = Resource.objects.all()
255
    for resource in resources:
256
        capacity = resource.uplimit
257
        limits = _quota_values(capacity)
258
        _DEFAULT_QUOTA[resource.full_name()] = limits
259

    
260
    return _DEFAULT_QUOTA
261

    
262
def get_resource_names():
263
    _RESOURCE_NAMES = []
264
    resources = Resource.objects.all()
265
    _RESOURCE_NAMES = [resource.full_name() for resource in resources]
266
    return _RESOURCE_NAMES
267

    
268

    
269
class AstakosUserManager(UserManager):
270

    
271
    def get_auth_provider_user(self, provider, **kwargs):
272
        """
273
        Retrieve AstakosUser instance associated with the specified third party
274
        id.
275
        """
276
        kwargs = dict(map(lambda x: ('auth_providers__%s' % x[0], x[1]),
277
                          kwargs.iteritems()))
278
        return self.get(auth_providers__module=provider, **kwargs)
279

    
280
    def get_by_email(self, email):
281
        return self.get(email=email)
282

    
283
    def get_by_identifier(self, email_or_username, **kwargs):
284
        try:
285
            return self.get(email__iexact=email_or_username, **kwargs)
286
        except AstakosUser.DoesNotExist:
287
            return self.get(username__iexact=email_or_username, **kwargs)
288

    
289
    def user_exists(self, email_or_username, **kwargs):
290
        qemail = Q(email__iexact=email_or_username)
291
        qusername = Q(username__iexact=email_or_username)
292
        qextra = Q(**kwargs)
293
        return self.filter((qemail | qusername) & qextra).exists()
294

    
295
    def verified_user_exists(self, email_or_username):
296
        return self.user_exists(email_or_username, email_verified=True)
297

    
298
    def verified(self):
299
        return self.filter(email_verified=True)
300

    
301
    def verified(self):
302
        return self.filter(email_verified=True)
303

    
304

    
305
class AstakosUser(User):
306
    """
307
    Extends ``django.contrib.auth.models.User`` by defining additional fields.
308
    """
309
    affiliation = models.CharField(_('Affiliation'), max_length=255, blank=True,
310
                                   null=True)
311

    
312
    # DEPRECATED FIELDS: provider, third_party_identifier moved in
313
    #                    AstakosUserProvider model.
314
    provider = models.CharField(_('Provider'), max_length=255, blank=True,
315
                                null=True)
316
    # ex. screen_name for twitter, eppn for shibboleth
317
    third_party_identifier = models.CharField(_('Third-party identifier'),
318
                                              max_length=255, null=True,
319
                                              blank=True)
320

    
321

    
322
    #for invitations
323
    user_level = DEFAULT_USER_LEVEL
324
    level = models.IntegerField(_('Inviter level'), default=user_level)
325
    invitations = models.IntegerField(
326
        _('Invitations left'), default=INVITATIONS_PER_LEVEL.get(user_level, 0))
327

    
328
    auth_token = models.CharField(_('Authentication Token'), max_length=32,
329
                                  null=True, blank=True, help_text = _( 'test' ))
330
    auth_token_created = models.DateTimeField(_('Token creation date'), null=True)
331
    auth_token_expires = models.DateTimeField(
332
        _('Token expiration date'), null=True)
333

    
334
    updated = models.DateTimeField(_('Update date'))
335
    is_verified = models.BooleanField(_('Is verified?'), default=False)
336

    
337
    email_verified = models.BooleanField(_('Email verified?'), default=False)
338

    
339
    has_credits = models.BooleanField(_('Has credits?'), default=False)
340
    has_signed_terms = models.BooleanField(
341
        _('I agree with the terms'), default=False)
342
    date_signed_terms = models.DateTimeField(
343
        _('Signed terms date'), null=True, blank=True)
344

    
345
    activation_sent = models.DateTimeField(
346
        _('Activation sent data'), null=True, blank=True)
347

    
348
    policy = models.ManyToManyField(
349
        Resource, null=True, through='AstakosUserQuota')
350

    
351
    uuid = models.CharField(max_length=255, null=True, blank=False, unique=True)
352

    
353
    __has_signed_terms = False
354
    disturbed_quota = models.BooleanField(_('Needs quotaholder syncing'),
355
                                           default=False, db_index=True)
356

    
357
    objects = AstakosUserManager()
358

    
359
    def __init__(self, *args, **kwargs):
360
        super(AstakosUser, self).__init__(*args, **kwargs)
361
        self.__has_signed_terms = self.has_signed_terms
362
        if not self.id:
363
            self.is_active = False
364

    
365
    @property
366
    def realname(self):
367
        return '%s %s' % (self.first_name, self.last_name)
368

    
369
    @realname.setter
370
    def realname(self, value):
371
        parts = value.split(' ')
372
        if len(parts) == 2:
373
            self.first_name = parts[0]
374
            self.last_name = parts[1]
375
        else:
376
            self.last_name = parts[0]
377

    
378
    def add_permission(self, pname):
379
        if self.has_perm(pname):
380
            return
381
        p, created = Permission.objects.get_or_create(
382
                                    codename=pname,
383
                                    name=pname.capitalize(),
384
                                    content_type=get_content_type())
385
        self.user_permissions.add(p)
386

    
387
    def remove_permission(self, pname):
388
        if self.has_perm(pname):
389
            return
390
        p = Permission.objects.get(codename=pname,
391
                                   content_type=get_content_type())
392
        self.user_permissions.remove(p)
393

    
394
    @property
395
    def invitation(self):
396
        try:
397
            return Invitation.objects.get(username=self.email)
398
        except Invitation.DoesNotExist:
399
            return None
400

    
401
    def initial_quotas(self):
402
        quotas = dict(get_default_quota())
403
        for user_quota in self.policies:
404
            resource = user_quota.resource.full_name()
405
            quotas[resource] = user_quota.quota_values()
406
        return quotas
407

    
408
    def all_quotas(self):
409
        quotas = self.initial_quotas()
410

    
411
        objects = self.projectmembership_set.select_related()
412
        memberships = objects.filter(is_active=True)
413
        for membership in memberships:
414
            application = membership.application
415
            if application is None:
416
                m = _("missing application for active membership %s"
417
                      % (membership,))
418
                raise AssertionError(m)
419

    
420
            grants = application.projectresourcegrant_set.all()
421
            for grant in grants:
422
                resource = grant.resource.full_name()
423
                prev = quotas.get(resource, 0)
424
                new = add_quota_values(prev, grant.member_quota_values())
425
                quotas[resource] = new
426
        return quotas
427

    
428
    @property
429
    def policies(self):
430
        return self.astakosuserquota_set.select_related().all()
431

    
432
    @policies.setter
433
    def policies(self, policies):
434
        for p in policies:
435
            p.setdefault('resource', '')
436
            p.setdefault('capacity', 0)
437
            p.setdefault('quantity', 0)
438
            p.setdefault('import_limit', 0)
439
            p.setdefault('export_limit', 0)
440
            p.setdefault('update', True)
441
            self.add_resource_policy(**p)
442

    
443
    def add_resource_policy(
444
            self, resource, capacity, quantity, import_limit,
445
            export_limit, update=True):
446
        """Raises ObjectDoesNotExist, IntegrityError"""
447
        s, sep, r = resource.partition(RESOURCE_SEPARATOR)
448
        resource = Resource.objects.get(service__name=s, name=r)
449
        if update:
450
            AstakosUserQuota.objects.update_or_create(
451
                user=self, resource=resource, defaults={
452
                    'capacity':capacity,
453
                    'quantity': quantity,
454
                    'import_limit':import_limit,
455
                    'export_limit':export_limit})
456
        else:
457
            q = self.astakosuserquota_set
458
            q.create(
459
                resource=resource, capacity=capacity, quanity=quantity,
460
                import_limit=import_limit, export_limit=export_limit)
461

    
462
    def remove_resource_policy(self, service, resource):
463
        """Raises ObjectDoesNotExist, IntegrityError"""
464
        resource = Resource.objects.get(service__name=service, name=resource)
465
        q = self.policies.get(resource=resource).delete()
466

    
467
    def update_uuid(self):
468
        while not self.uuid:
469
            uuid_val =  str(uuid.uuid4())
470
            try:
471
                AstakosUser.objects.get(uuid=uuid_val)
472
            except AstakosUser.DoesNotExist, e:
473
                self.uuid = uuid_val
474
        return self.uuid
475

    
476
    def save(self, update_timestamps=True, **kwargs):
477
        if update_timestamps:
478
            if not self.id:
479
                self.date_joined = datetime.now()
480
            self.updated = datetime.now()
481

    
482
        # update date_signed_terms if necessary
483
        if self.__has_signed_terms != self.has_signed_terms:
484
            self.date_signed_terms = datetime.now()
485

    
486
        self.update_uuid()
487

    
488
        if self.username != self.email.lower():
489
            # set username
490
            self.username = self.email.lower()
491

    
492
        super(AstakosUser, self).save(**kwargs)
493

    
494
    def renew_token(self, flush_sessions=False, current_key=None):
495
        md5 = hashlib.md5()
496
        md5.update(settings.SECRET_KEY)
497
        md5.update(self.username)
498
        md5.update(self.realname.encode('ascii', 'ignore'))
499
        md5.update(asctime())
500

    
501
        self.auth_token = b64encode(md5.digest())
502
        self.auth_token_created = datetime.now()
503
        self.auth_token_expires = self.auth_token_created + \
504
                                  timedelta(hours=AUTH_TOKEN_DURATION)
505
        if flush_sessions:
506
            self.flush_sessions(current_key)
507
        msg = 'Token renewed for %s' % self.email
508
        logger.log(LOGGING_LEVEL, msg)
509

    
510
    def flush_sessions(self, current_key=None):
511
        q = self.sessions
512
        if current_key:
513
            q = q.exclude(session_key=current_key)
514

    
515
        keys = q.values_list('session_key', flat=True)
516
        if keys:
517
            msg = 'Flushing sessions: %s' % ','.join(keys)
518
            logger.log(LOGGING_LEVEL, msg, [])
519
        engine = import_module(settings.SESSION_ENGINE)
520
        for k in keys:
521
            s = engine.SessionStore(k)
522
            s.flush()
523

    
524
    def __unicode__(self):
525
        return '%s (%s)' % (self.realname, self.email)
526

    
527
    def conflicting_email(self):
528
        q = AstakosUser.objects.exclude(username=self.username)
529
        q = q.filter(email__iexact=self.email)
530
        if q.count() != 0:
531
            return True
532
        return False
533

    
534
    def email_change_is_pending(self):
535
        return self.emailchanges.count() > 0
536

    
537
    def email_change_is_pending(self):
538
        return self.emailchanges.count() > 0
539

    
540
    @property
541
    def signed_terms(self):
542
        term = get_latest_terms()
543
        if not term:
544
            return True
545
        if not self.has_signed_terms:
546
            return False
547
        if not self.date_signed_terms:
548
            return False
549
        if self.date_signed_terms < term.date:
550
            self.has_signed_terms = False
551
            self.date_signed_terms = None
552
            self.save()
553
            return False
554
        return True
555

    
556
    def set_invitations_level(self):
557
        """
558
        Update user invitation level
559
        """
560
        level = self.invitation.inviter.level + 1
561
        self.level = level
562
        self.invitations = INVITATIONS_PER_LEVEL.get(level, 0)
563

    
564
    def can_login_with_auth_provider(self, provider):
565
        if not self.has_auth_provider(provider):
566
            return False
567
        else:
568
            return auth_providers.get_provider(provider).is_available_for_login()
569

    
570
    def can_add_auth_provider(self, provider, include_unverified=False, **kwargs):
571
        provider_settings = auth_providers.get_provider(provider)
572

    
573
        if not provider_settings.is_available_for_add():
574
            return False
575

    
576
        if self.has_auth_provider(provider) and \
577
           provider_settings.one_per_user:
578
            return False
579

    
580
        if 'provider_info' in kwargs:
581
            kwargs.pop('provider_info')
582

    
583
        if 'identifier' in kwargs:
584
            try:
585
                # provider with specified params already exist
586
                if not include_unverified:
587
                    kwargs['user__email_verified'] = True
588
                existing_user = AstakosUser.objects.get_auth_provider_user(provider,
589
                                                                   **kwargs)
590
            except AstakosUser.DoesNotExist:
591
                return True
592
            else:
593
                return False
594

    
595
        return True
596

    
597
    def can_remove_auth_provider(self, module):
598
        provider = auth_providers.get_provider(module)
599
        existing = self.get_active_auth_providers()
600
        existing_for_provider = self.get_active_auth_providers(module=module)
601

    
602
        if len(existing) <= 1:
603
            return False
604

    
605
        if len(existing_for_provider) == 1 and provider.is_required():
606
            return False
607

    
608
        return True
609

    
610
    def can_change_password(self):
611
        return self.has_auth_provider('local', auth_backend='astakos')
612

    
613
    def can_change_email(self):
614
        non_astakos_local = self.get_auth_providers().filter(module='local')
615
        non_astakos_local = non_astakos_local.exclude(auth_backend='astakos')
616
        return non_astakos_local.count() == 0
617

    
618
    def has_required_auth_providers(self):
619
        required = auth_providers.REQUIRED_PROVIDERS
620
        for provider in required:
621
            if not self.has_auth_provider(provider):
622
                return False
623
        return True
624

    
625
    def has_auth_provider(self, provider, **kwargs):
626
        return bool(self.get_auth_providers().filter(module=provider,
627
                                               **kwargs).count())
628

    
629
    def add_auth_provider(self, provider, **kwargs):
630
        info_data = ''
631
        if 'provider_info' in kwargs:
632
            info_data = kwargs.pop('provider_info')
633
            if isinstance(info_data, dict):
634
                info_data = json.dumps(info_data)
635

    
636
        if self.can_add_auth_provider(provider, **kwargs):
637
            if 'identifier' in kwargs:
638
                # clean up third party pending for activation users of the same
639
                # identifier
640
                AstakosUserAuthProvider.objects.remove_unverified_providers(provider,
641
                                                                **kwargs)
642
            self.auth_providers.create(module=provider, active=True,
643
                                       info_data=info_data,
644
                                       **kwargs)
645
        else:
646
            raise Exception('Cannot add provider')
647

    
648
    def add_pending_auth_provider(self, pending):
649
        """
650
        Convert PendingThirdPartyUser object to AstakosUserAuthProvider entry for
651
        the current user.
652
        """
653
        if not isinstance(pending, PendingThirdPartyUser):
654
            pending = PendingThirdPartyUser.objects.get(token=pending)
655

    
656
        provider = self.add_auth_provider(pending.provider,
657
                               identifier=pending.third_party_identifier,
658
                                affiliation=pending.affiliation,
659
                                          provider_info=pending.info)
660

    
661
        if email_re.match(pending.email or '') and pending.email != self.email:
662
            self.additionalmail_set.get_or_create(email=pending.email)
663

    
664
        pending.delete()
665
        return provider
666

    
667
    def remove_auth_provider(self, provider, **kwargs):
668
        self.get_auth_providers().get(module=provider, **kwargs).delete()
669

    
670
    # user urls
671
    def get_resend_activation_url(self):
672
        return reverse('send_activation', kwargs={'user_id': self.pk})
673

    
674
    def get_provider_remove_url(self, module, **kwargs):
675
        return reverse('remove_auth_provider', kwargs={
676
            'pk': self.get_auth_providers().get(module=module, **kwargs).pk})
677

    
678
    def get_activation_url(self, nxt=False):
679
        url = "%s?auth=%s" % (reverse('astakos.im.views.activate'),
680
                                 quote(self.auth_token))
681
        if nxt:
682
            url += "&next=%s" % quote(nxt)
683
        return url
684

    
685
    def get_password_reset_url(self, token_generator=default_token_generator):
686
        return reverse('django.contrib.auth.views.password_reset_confirm',
687
                          kwargs={'uidb36':int_to_base36(self.id),
688
                                  'token':token_generator.make_token(self)})
689

    
690
    def get_auth_providers(self):
691
        return self.auth_providers
692

    
693
    def get_available_auth_providers(self):
694
        """
695
        Returns a list of providers available for user to connect to.
696
        """
697
        providers = []
698
        for module, provider_settings in auth_providers.PROVIDERS.iteritems():
699
            if self.can_add_auth_provider(module):
700
                providers.append(provider_settings(self))
701

    
702
        return providers
703

    
704
    def get_active_auth_providers(self, **filters):
705
        providers = []
706
        for provider in self.get_auth_providers().active(**filters):
707
            if auth_providers.get_provider(provider.module).is_available_for_login():
708
                providers.append(provider)
709
        return providers
710

    
711
    @property
712
    def auth_providers_display(self):
713
        return ",".join(map(lambda x:unicode(x), self.get_auth_providers().active()))
714

    
715
    def get_inactive_message(self):
716
        msg_extra = ''
717
        message = ''
718
        if self.activation_sent:
719
            if self.email_verified:
720
                message = _(astakos_messages.ACCOUNT_INACTIVE)
721
            else:
722
                message = _(astakos_messages.ACCOUNT_PENDING_ACTIVATION)
723
                if astakos_settings.MODERATION_ENABLED:
724
                    msg_extra = _(astakos_messages.ACCOUNT_PENDING_ACTIVATION_HELP)
725
                else:
726
                    url = self.get_resend_activation_url()
727
                    msg_extra = mark_safe(_(astakos_messages.ACCOUNT_PENDING_ACTIVATION_HELP) + \
728
                                u' ' + \
729
                                _('<a href="%s">%s?</a>') % (url,
730
                                _(astakos_messages.ACCOUNT_RESEND_ACTIVATION_PROMPT)))
731
        else:
732
            if astakos_settings.MODERATION_ENABLED:
733
                message = _(astakos_messages.ACCOUNT_PENDING_MODERATION)
734
            else:
735
                message = astakos_messages.ACCOUNT_PENDING_ACTIVATION
736
                url = self.get_resend_activation_url()
737
                msg_extra = mark_safe(_('<a href="%s">%s?</a>') % (url,
738
                            _(astakos_messages.ACCOUNT_RESEND_ACTIVATION_PROMPT)))
739

    
740
        return mark_safe(message + u' '+ msg_extra)
741

    
742
    def owns_project(self, project):
743
        return project.owner == self
744

    
745
    def is_project_member(self, project_or_application):
746
        return self.get_status_in_project(project_or_application) in \
747
                                        ProjectMembership.ASSOCIATED_STATES
748

    
749
    def is_project_accepted_member(self, project_or_application):
750
        return self.get_status_in_project(project_or_application) in \
751
                                            ProjectMembership.ACCEPTED_STATES
752

    
753
    def get_status_in_project(self, project_or_application):
754
        application = project_or_application
755
        if isinstance(project_or_application, Project):
756
            application = project_or_application.project
757
        return application.user_status(self)
758

    
759

    
760
class AstakosUserAuthProviderManager(models.Manager):
761

    
762
    def active(self, **filters):
763
        return self.filter(active=True, **filters)
764

    
765
    def remove_unverified_providers(self, provider, **filters):
766
        try:
767
            existing = self.filter(module=provider, user__email_verified=False, **filters)
768
            for p in existing:
769
                p.user.delete()
770
        except:
771
            pass
772

    
773

    
774

    
775
class AstakosUserAuthProvider(models.Model):
776
    """
777
    Available user authentication methods.
778
    """
779
    affiliation = models.CharField(_('Affiliation'), max_length=255, blank=True,
780
                                   null=True, default=None)
781
    user = models.ForeignKey(AstakosUser, related_name='auth_providers')
782
    module = models.CharField(_('Provider'), max_length=255, blank=False,
783
                                default='local')
784
    identifier = models.CharField(_('Third-party identifier'),
785
                                              max_length=255, null=True,
786
                                              blank=True)
787
    active = models.BooleanField(default=True)
788
    auth_backend = models.CharField(_('Backend'), max_length=255, blank=False,
789
                                   default='astakos')
790
    info_data = models.TextField(default="", null=True, blank=True)
791
    created = models.DateTimeField('Creation date', auto_now_add=True)
792

    
793
    objects = AstakosUserAuthProviderManager()
794

    
795
    class Meta:
796
        unique_together = (('identifier', 'module', 'user'), )
797
        ordering = ('module', 'created')
798

    
799
    def __init__(self, *args, **kwargs):
800
        super(AstakosUserAuthProvider, self).__init__(*args, **kwargs)
801
        try:
802
            self.info = json.loads(self.info_data)
803
            if not self.info:
804
                self.info = {}
805
        except Exception, e:
806
            self.info = {}
807

    
808
        for key,value in self.info.iteritems():
809
            setattr(self, 'info_%s' % key, value)
810

    
811

    
812
    @property
813
    def settings(self):
814
        return auth_providers.get_provider(self.module)
815

    
816
    @property
817
    def details_display(self):
818
        try:
819
          return self.settings.get_details_tpl_display % self.__dict__
820
        except:
821
          return ''
822

    
823
    @property
824
    def title_display(self):
825
        title_tpl = self.settings.get_title_display
826
        try:
827
            if self.settings.get_user_title_display:
828
                title_tpl = self.settings.get_user_title_display
829
        except Exception, e:
830
            pass
831
        try:
832
          return title_tpl % self.__dict__
833
        except:
834
          return self.settings.get_title_display % self.__dict__
835

    
836
    def can_remove(self):
837
        return self.user.can_remove_auth_provider(self.module)
838

    
839
    def delete(self, *args, **kwargs):
840
        ret = super(AstakosUserAuthProvider, self).delete(*args, **kwargs)
841
        if self.module == 'local':
842
            self.user.set_unusable_password()
843
            self.user.save()
844
        return ret
845

    
846
    def __repr__(self):
847
        return '<AstakosUserAuthProvider %s:%s>' % (self.module, self.identifier)
848

    
849
    def __unicode__(self):
850
        if self.identifier:
851
            return "%s:%s" % (self.module, self.identifier)
852
        if self.auth_backend:
853
            return "%s:%s" % (self.module, self.auth_backend)
854
        return self.module
855

    
856
    def save(self, *args, **kwargs):
857
        self.info_data = json.dumps(self.info)
858
        return super(AstakosUserAuthProvider, self).save(*args, **kwargs)
859

    
860

    
861
class ExtendedManager(models.Manager):
862
    def _update_or_create(self, **kwargs):
863
        assert kwargs, \
864
            'update_or_create() must be passed at least one keyword argument'
865
        obj, created = self.get_or_create(**kwargs)
866
        defaults = kwargs.pop('defaults', {})
867
        if created:
868
            return obj, True, False
869
        else:
870
            try:
871
                params = dict(
872
                    [(k, v) for k, v in kwargs.items() if '__' not in k])
873
                params.update(defaults)
874
                for attr, val in params.items():
875
                    if hasattr(obj, attr):
876
                        setattr(obj, attr, val)
877
                sid = transaction.savepoint()
878
                obj.save(force_update=True)
879
                transaction.savepoint_commit(sid)
880
                return obj, False, True
881
            except IntegrityError, e:
882
                transaction.savepoint_rollback(sid)
883
                try:
884
                    return self.get(**kwargs), False, False
885
                except self.model.DoesNotExist:
886
                    raise e
887

    
888
    update_or_create = _update_or_create
889

    
890

    
891
class AstakosUserQuota(models.Model):
892
    objects = ExtendedManager()
893
    capacity = intDecimalField()
894
    quantity = intDecimalField(default=0)
895
    export_limit = intDecimalField(default=QH_PRACTICALLY_INFINITE)
896
    import_limit = intDecimalField(default=QH_PRACTICALLY_INFINITE)
897
    resource = models.ForeignKey(Resource)
898
    user = models.ForeignKey(AstakosUser)
899

    
900
    class Meta:
901
        unique_together = ("resource", "user")
902

    
903
    def quota_values(self):
904
        return QuotaValues(
905
            quantity = self.quantity,
906
            capacity = self.capacity,
907
            import_limit = self.import_limit,
908
            export_limit = self.export_limit)
909

    
910

    
911
class ApprovalTerms(models.Model):
912
    """
913
    Model for approval terms
914
    """
915

    
916
    date = models.DateTimeField(
917
        _('Issue date'), db_index=True, auto_now_add=True)
918
    location = models.CharField(_('Terms location'), max_length=255)
919

    
920

    
921
class Invitation(models.Model):
922
    """
923
    Model for registring invitations
924
    """
925
    inviter = models.ForeignKey(AstakosUser, related_name='invitations_sent',
926
                                null=True)
927
    realname = models.CharField(_('Real name'), max_length=255)
928
    username = models.CharField(_('Unique ID'), max_length=255, unique=True)
929
    code = models.BigIntegerField(_('Invitation code'), db_index=True)
930
    is_consumed = models.BooleanField(_('Consumed?'), default=False)
931
    created = models.DateTimeField(_('Creation date'), auto_now_add=True)
932
    consumed = models.DateTimeField(_('Consumption date'), null=True, blank=True)
933

    
934
    def __init__(self, *args, **kwargs):
935
        super(Invitation, self).__init__(*args, **kwargs)
936
        if not self.id:
937
            self.code = _generate_invitation_code()
938

    
939
    def consume(self):
940
        self.is_consumed = True
941
        self.consumed = datetime.now()
942
        self.save()
943

    
944
    def __unicode__(self):
945
        return '%s -> %s [%d]' % (self.inviter, self.username, self.code)
946

    
947

    
948
class EmailChangeManager(models.Manager):
949

    
950
    @transaction.commit_on_success
951
    def change_email(self, activation_key):
952
        """
953
        Validate an activation key and change the corresponding
954
        ``User`` if valid.
955

956
        If the key is valid and has not expired, return the ``User``
957
        after activating.
958

959
        If the key is not valid or has expired, return ``None``.
960

961
        If the key is valid but the ``User`` is already active,
962
        return ``None``.
963

964
        After successful email change the activation record is deleted.
965

966
        Throws ValueError if there is already
967
        """
968
        try:
969
            email_change = self.model.objects.get(
970
                activation_key=activation_key)
971
            if email_change.activation_key_expired():
972
                email_change.delete()
973
                raise EmailChange.DoesNotExist
974
            # is there an active user with this address?
975
            try:
976
                AstakosUser.objects.get(email__iexact=email_change.new_email_address)
977
            except AstakosUser.DoesNotExist:
978
                pass
979
            else:
980
                raise ValueError(_('The new email address is reserved.'))
981
            # update user
982
            user = AstakosUser.objects.get(pk=email_change.user_id)
983
            old_email = user.email
984
            user.email = email_change.new_email_address
985
            user.save()
986
            email_change.delete()
987
            msg = "User %d changed email from %s to %s" % (user.pk, old_email,
988
                                                          user.email)
989
            logger.log(LOGGING_LEVEL, msg)
990
            return user
991
        except EmailChange.DoesNotExist:
992
            raise ValueError(_('Invalid activation key.'))
993

    
994

    
995
class EmailChange(models.Model):
996
    new_email_address = models.EmailField(
997
        _(u'new e-mail address'),
998
        help_text=_('Your old email address will be used until you verify your new one.'))
999
    user = models.ForeignKey(
1000
        AstakosUser, unique=True, related_name='emailchanges')
1001
    requested_at = models.DateTimeField(auto_now_add=True)
1002
    activation_key = models.CharField(
1003
        max_length=40, unique=True, db_index=True)
1004

    
1005
    objects = EmailChangeManager()
1006

    
1007
    def get_url(self):
1008
        return reverse('email_change_confirm',
1009
                      kwargs={'activation_key': self.activation_key})
1010

    
1011
    def activation_key_expired(self):
1012
        expiration_date = timedelta(days=EMAILCHANGE_ACTIVATION_DAYS)
1013
        return self.requested_at + expiration_date < datetime.now()
1014

    
1015

    
1016
class AdditionalMail(models.Model):
1017
    """
1018
    Model for registring invitations
1019
    """
1020
    owner = models.ForeignKey(AstakosUser)
1021
    email = models.EmailField()
1022

    
1023

    
1024
def _generate_invitation_code():
1025
    while True:
1026
        code = randint(1, 2L ** 63 - 1)
1027
        try:
1028
            Invitation.objects.get(code=code)
1029
            # An invitation with this code already exists, try again
1030
        except Invitation.DoesNotExist:
1031
            return code
1032

    
1033

    
1034
def get_latest_terms():
1035
    try:
1036
        term = ApprovalTerms.objects.order_by('-id')[0]
1037
        return term
1038
    except IndexError:
1039
        pass
1040
    return None
1041

    
1042
class PendingThirdPartyUser(models.Model):
1043
    """
1044
    Model for registring successful third party user authentications
1045
    """
1046
    third_party_identifier = models.CharField(_('Third-party identifier'), max_length=255, null=True, blank=True)
1047
    provider = models.CharField(_('Provider'), max_length=255, blank=True)
1048
    email = models.EmailField(_('e-mail address'), blank=True, null=True)
1049
    first_name = models.CharField(_('first name'), max_length=30, blank=True,
1050
                                  null=True)
1051
    last_name = models.CharField(_('last name'), max_length=30, blank=True,
1052
                                 null=True)
1053
    affiliation = models.CharField('Affiliation', max_length=255, blank=True,
1054
                                   null=True)
1055
    username = models.CharField(_('username'), max_length=30, unique=True, help_text=_("Required. 30 characters or fewer. Letters, numbers and @/./+/-/_ characters"))
1056
    token = models.CharField(_('Token'), max_length=255, null=True, blank=True)
1057
    created = models.DateTimeField(auto_now_add=True, null=True, blank=True)
1058
    info = models.TextField(default="", null=True, blank=True)
1059

    
1060
    class Meta:
1061
        unique_together = ("provider", "third_party_identifier")
1062

    
1063
    def get_user_instance(self):
1064
        d = self.__dict__
1065
        d.pop('_state', None)
1066
        d.pop('id', None)
1067
        d.pop('token', None)
1068
        d.pop('created', None)
1069
        d.pop('info', None)
1070
        user = AstakosUser(**d)
1071

    
1072
        return user
1073

    
1074
    @property
1075
    def realname(self):
1076
        return '%s %s' %(self.first_name, self.last_name)
1077

    
1078
    @realname.setter
1079
    def realname(self, value):
1080
        parts = value.split(' ')
1081
        if len(parts) == 2:
1082
            self.first_name = parts[0]
1083
            self.last_name = parts[1]
1084
        else:
1085
            self.last_name = parts[0]
1086

    
1087
    def save(self, **kwargs):
1088
        if not self.id:
1089
            # set username
1090
            while not self.username:
1091
                username =  uuid.uuid4().hex[:30]
1092
                try:
1093
                    AstakosUser.objects.get(username = username)
1094
                except AstakosUser.DoesNotExist, e:
1095
                    self.username = username
1096
        super(PendingThirdPartyUser, self).save(**kwargs)
1097

    
1098
    def generate_token(self):
1099
        self.password = self.third_party_identifier
1100
        self.last_login = datetime.now()
1101
        self.token = default_token_generator.make_token(self)
1102

    
1103
class SessionCatalog(models.Model):
1104
    session_key = models.CharField(_('session key'), max_length=40)
1105
    user = models.ForeignKey(AstakosUser, related_name='sessions', null=True)
1106

    
1107

    
1108
### PROJECTS ###
1109
################
1110

    
1111
def synced_model_metaclass(class_name, class_parents, class_attributes):
1112

    
1113
    new_attributes = {}
1114
    sync_attributes = {}
1115

    
1116
    for name, value in class_attributes.iteritems():
1117
        sync, underscore, rest = name.partition('_')
1118
        if sync == 'sync' and underscore == '_':
1119
            sync_attributes[rest] = value
1120
        else:
1121
            new_attributes[name] = value
1122

    
1123
    if 'prefix' not in sync_attributes:
1124
        m = ("you did not specify a 'sync_prefix' attribute "
1125
             "in class '%s'" % (class_name,))
1126
        raise ValueError(m)
1127

    
1128
    prefix = sync_attributes.pop('prefix')
1129
    class_name = sync_attributes.pop('classname', prefix + '_model')
1130

    
1131
    for name, value in sync_attributes.iteritems():
1132
        newname = prefix + '_' + name
1133
        if newname in new_attributes:
1134
            m = ("class '%s' was specified with prefix '%s' "
1135
                 "but it already has an attribute named '%s'"
1136
                 % (class_name, prefix, newname))
1137
            raise ValueError(m)
1138

    
1139
        new_attributes[newname] = value
1140

    
1141
    newclass = type(class_name, class_parents, new_attributes)
1142
    return newclass
1143

    
1144

    
1145
def make_synced(prefix='sync', name='SyncedState'):
1146

    
1147
    the_name = name
1148
    the_prefix = prefix
1149

    
1150
    class SyncedState(models.Model):
1151

    
1152
        sync_classname      = the_name
1153
        sync_prefix         = the_prefix
1154
        __metaclass__       = synced_model_metaclass
1155

    
1156
        sync_new_state      = models.BigIntegerField(null=True)
1157
        sync_synced_state   = models.BigIntegerField(null=True)
1158
        STATUS_SYNCED       = 0
1159
        STATUS_PENDING      = 1
1160
        sync_status         = models.IntegerField(db_index=True)
1161

    
1162
        class Meta:
1163
            abstract = True
1164

    
1165
        class NotSynced(Exception):
1166
            pass
1167

    
1168
        def sync_init_state(self, state):
1169
            self.sync_synced_state = state
1170
            self.sync_new_state = state
1171
            self.sync_status = self.STATUS_SYNCED
1172

    
1173
        def sync_get_status(self):
1174
            return self.sync_status
1175

    
1176
        def sync_set_status(self):
1177
            if self.sync_new_state != self.sync_synced_state:
1178
                self.sync_status = self.STATUS_PENDING
1179
            else:
1180
                self.sync_status = self.STATUS_SYNCED
1181

    
1182
        def sync_set_synced(self):
1183
            self.sync_synced_state = self.sync_new_state
1184
            self.sync_status = self.STATUS_SYNCED
1185

    
1186
        def sync_get_synced_state(self):
1187
            return self.sync_synced_state
1188

    
1189
        def sync_set_new_state(self, new_state):
1190
            self.sync_new_state = new_state
1191
            self.sync_set_status()
1192

    
1193
        def sync_get_new_state(self):
1194
            return self.sync_new_state
1195

    
1196
        def sync_set_synced_state(self, synced_state):
1197
            self.sync_synced_state = synced_state
1198
            self.sync_set_status()
1199

    
1200
        def sync_get_pending_objects(self):
1201
            kw = dict((the_prefix + '_status', self.STATUS_PENDING))
1202
            return self.objects.filter(**kw)
1203

    
1204
        def sync_get_synced_objects(self):
1205
            kw = dict((the_prefix + '_status', self.STATUS_SYNCED))
1206
            return self.objects.filter(**kw)
1207

    
1208
        def sync_verify_get_synced_state(self):
1209
            status = self.sync_get_status()
1210
            state = self.sync_get_synced_state()
1211
            verified = (status == self.STATUS_SYNCED)
1212
            return state, verified
1213

    
1214
        def sync_is_synced(self):
1215
            state, verified = self.sync_verify_get_synced_state()
1216
            return verified
1217

    
1218
    return SyncedState
1219

    
1220
SyncedState = make_synced(prefix='sync', name='SyncedState')
1221

    
1222

    
1223
class ProjectApplicationManager(ForUpdateManager):
1224

    
1225
    def user_visible_projects(self, *filters, **kw_filters):
1226
        model = self.model
1227
        return self.filter(model.Q_PENDING | model.Q_APPROVED)
1228

    
1229
    def user_visible_by_chain(self, *filters, **kw_filters):
1230
        model = self.model
1231
        pending = self.filter(model.Q_PENDING).values_list('chain')
1232
        approved = self.filter(model.Q_APPROVED).values_list('chain')
1233
        by_chain = dict(pending.annotate(models.Max('id')))
1234
        by_chain.update(approved.annotate(models.Max('id')))
1235
        return self.filter(id__in=by_chain.values())
1236

    
1237
    def user_accessible_projects(self, user):
1238
        """
1239
        Return projects accessed by specified user.
1240
        """
1241
        participates_filters = Q(owner=user) | Q(applicant=user) | \
1242
                               Q(project__projectmembership__person=user)
1243

    
1244
        return self.user_visible_by_chain(participates_filters).order_by('issue_date').distinct()
1245

    
1246
    def search_by_name(self, *search_strings):
1247
        q = Q()
1248
        for s in search_strings:
1249
            q = q | Q(name__icontains=s)
1250
        return self.filter(q)
1251

    
1252

    
1253
USER_STATUS_DISPLAY = {
1254
      0: _('Join requested'),
1255
      1: _('Accepted member'),
1256
     10: _('Suspended'),
1257
    100: _('Terminated'),
1258
    200: _('Removed'),
1259
     -1: _('Not a member'),
1260
}
1261

    
1262

    
1263
class Chain(models.Model):
1264
    chain  =   models.AutoField(primary_key=True)
1265

    
1266
def new_chain():
1267
    c = Chain.objects.create()
1268
    chain = c.chain
1269
    c.delete()
1270
    return chain
1271

    
1272

    
1273
class ProjectApplication(models.Model):
1274
    applicant               =   models.ForeignKey(
1275
                                    AstakosUser,
1276
                                    related_name='projects_applied',
1277
                                    db_index=True)
1278

    
1279
    PENDING     =    0
1280
    APPROVED    =    1
1281
    REPLACED    =    2
1282
    DENIED      =    3
1283
    DISMISSED   =    4
1284
    CANCELLED   =    5
1285

    
1286
    state                   =   models.IntegerField(default=PENDING,
1287
                                                    db_index=True)
1288

    
1289
    owner                   =   models.ForeignKey(
1290
                                    AstakosUser,
1291
                                    related_name='projects_owned',
1292
                                    db_index=True)
1293

    
1294
    chain                   =   models.IntegerField()
1295
    precursor_application   =   models.ForeignKey('ProjectApplication',
1296
                                                  null=True,
1297
                                                  blank=True)
1298

    
1299
    name                    =   models.CharField(max_length=80)
1300
    homepage                =   models.URLField(max_length=255, null=True)
1301
    description             =   models.TextField(null=True, blank=True)
1302
    start_date              =   models.DateTimeField(null=True, blank=True)
1303
    end_date                =   models.DateTimeField()
1304
    member_join_policy      =   models.IntegerField()
1305
    member_leave_policy     =   models.IntegerField()
1306
    limit_on_members_number =   models.PositiveIntegerField(null=True)
1307
    resource_grants         =   models.ManyToManyField(
1308
                                    Resource,
1309
                                    null=True,
1310
                                    blank=True,
1311
                                    through='ProjectResourceGrant')
1312
    comments                =   models.TextField(null=True, blank=True)
1313
    issue_date              =   models.DateTimeField(auto_now_add=True)
1314
    response_date           =   models.DateTimeField(null=True, blank=True)
1315

    
1316
    objects                 =   ProjectApplicationManager()
1317

    
1318
    # Compiled queries
1319
    Q_PENDING  = Q(state=PENDING)
1320
    Q_APPROVED = Q(state=APPROVED)
1321

    
1322
    class Meta:
1323
        unique_together = ("chain", "id")
1324

    
1325
    def __unicode__(self):
1326
        return "%s applied by %s" % (self.name, self.applicant)
1327

    
1328
    # TODO: Move to a more suitable place
1329
    APPLICATION_STATE_DISPLAY = {
1330
        PENDING  : _('Pending review'),
1331
        APPROVED : _('Active'),
1332
        REPLACED : _('Replaced'),
1333
        DENIED   : _('Denied'),
1334
        DISMISSED: _('Dismissed'),
1335
        CANCELLED: _('Cancelled')
1336
    }
1337

    
1338
    def get_project(self):
1339
        try:
1340
            project = Project.objects.get(id=self.chain, state=Project.APPROVED)
1341
            return Project
1342
        except Project.DoesNotExist, e:
1343
            return None
1344

    
1345
    def state_display(self):
1346
        return self.APPLICATION_STATE_DISPLAY.get(self.state, _('Unknown'))
1347

    
1348
    def add_resource_policy(self, service, resource, uplimit):
1349
        """Raises ObjectDoesNotExist, IntegrityError"""
1350
        q = self.projectresourcegrant_set
1351
        resource = Resource.objects.get(service__name=service, name=resource)
1352
        q.create(resource=resource, member_capacity=uplimit)
1353

    
1354
    def user_status(self, user):
1355
        try:
1356
            project = self.get_project()
1357
            if not project:
1358
                return -1
1359
            membership = project.projectmembership_set
1360
            membership = membership.exclude(state=ProjectMembership.REMOVED)
1361
            membership = membership.get(person=user)
1362
            status = membership.state
1363
        except ProjectMembership.DoesNotExist:
1364
            return -1
1365

    
1366
        return status
1367

    
1368
    def user_status_display(self, user):
1369
        return USER_STATUS_DISPLAY.get(self.user_status(user), _('Unknown'))
1370

    
1371
    def members_count(self):
1372
        return self.project.approved_memberships.count()
1373

    
1374
    @property
1375
    def grants(self):
1376
        return self.projectresourcegrant_set.values(
1377
            'member_capacity', 'resource__name', 'resource__service__name')
1378

    
1379
    @property
1380
    def resource_policies(self):
1381
        return [str(rp) for rp in self.projectresourcegrant_set.all()]
1382

    
1383
    @resource_policies.setter
1384
    def resource_policies(self, policies):
1385
        for p in policies:
1386
            service = p.get('service', None)
1387
            resource = p.get('resource', None)
1388
            uplimit = p.get('uplimit', 0)
1389
            self.add_resource_policy(service, resource, uplimit)
1390

    
1391
    @property
1392
    def follower(self):
1393
        try:
1394
            return ProjectApplication.objects.get(precursor_application=self)
1395
        except ProjectApplication.DoesNotExist:
1396
            return
1397

    
1398
    def followers(self):
1399
        followers = self.chained_applications()
1400
        followers = followers.exclude(id=self.pk).filter(state=self.PENDING)
1401
        followers = followers.order_by('id')
1402
        return followers
1403

    
1404
    def last_follower(self):
1405
        try:
1406
            return self.followers().order_by('-id')[0]
1407
        except IndexError:
1408
            return None
1409

    
1410
    def is_modification(self):
1411
        parents = self.chained_applications().filter(id__lt=self.id)
1412
        parents = parents.filter(state__in=[self.APPROVED])
1413
        return parents.count() > 0
1414

    
1415
    def chained_applications(self):
1416
        return ProjectApplication.objects.filter(chain=self.chain)
1417

    
1418
    def has_pending_modifications(self):
1419
        return bool(self.last_follower())
1420

    
1421
    def get_project(self):
1422
        try:
1423
            return Project.objects.get(id=self.chain)
1424
        except Project.DoesNotExist:
1425
            return None
1426

    
1427
    def _get_project_for_update(self):
1428
        try:
1429
            objects = Project.objects.select_for_update()
1430
            project = objects.get(id=self.chain)
1431
            return project
1432
        except Project.DoesNotExist:
1433
            return None
1434

    
1435
    def cancel(self):
1436
        if self.state != self.PENDING:
1437
            m = _("cannot cancel: application '%s' in state '%s'") % (
1438
                    self.id, self.state)
1439
            raise AssertionError(m)
1440

    
1441
        self.state = self.CANCELLED
1442
        self.save()
1443

    
1444
    def dismiss(self):
1445
        if self.state != self.DENIED:
1446
            m = _("cannot dismiss: application '%s' in state '%s'") % (
1447
                    self.id, self.state)
1448
            raise AssertionError(m)
1449

    
1450
        self.state = self.DISMISSED
1451
        self.save()
1452

    
1453
    def deny(self):
1454
        if self.state != self.PENDING:
1455
            m = _("cannot deny: application '%s' in state '%s'") % (
1456
                    self.id, self.state)
1457
            raise AssertionError(m)
1458

    
1459
        self.state = self.DENIED
1460
        self.response_date = datetime.now()
1461
        self.save()
1462

    
1463
    def approve(self, approval_user=None):
1464
        """
1465
        If approval_user then during owner membership acceptance
1466
        it is checked whether the request_user is eligible.
1467

1468
        Raises:
1469
            PermissionDenied
1470
        """
1471

    
1472
        if not transaction.is_managed():
1473
            raise AssertionError("NOPE")
1474

    
1475
        new_project_name = self.name
1476
        if self.state != self.PENDING:
1477
            m = _("cannot approve: project '%s' in state '%s'") % (
1478
                    new_project_name, self.state)
1479
            raise PermissionDenied(m) # invalid argument
1480

    
1481
        now = datetime.now()
1482
        project = self._get_project_for_update()
1483

    
1484
        try:
1485
            q = Q(name=new_project_name) & ~Q(state=Project.TERMINATED)
1486
            conflicting_project = Project.objects.get(q)
1487
            if (conflicting_project != project):
1488
                m = (_("cannot approve: project with name '%s' "
1489
                       "already exists (serial: %s)") % (
1490
                        new_project_name, conflicting_project.id))
1491
                raise PermissionDenied(m) # invalid argument
1492
        except Project.DoesNotExist:
1493
            pass
1494

    
1495
        new_project = False
1496
        if project is None:
1497
            new_project = True
1498
            project = Project(id=self.chain)
1499

    
1500
        project.name = new_project_name
1501
        project.application = self
1502
        project.last_approval_date = now
1503
        if not new_project:
1504
            project.is_modified = True
1505

    
1506
        project.save()
1507

    
1508
        self.state = self.APPROVED
1509
        self.response_date = now
1510
        self.save()
1511

    
1512
    @property
1513
    def member_join_policy_display(self):
1514
        return PROJECT_MEMBER_JOIN_POLICIES.get(str(self.member_join_policy))
1515

    
1516
    @property
1517
    def member_leave_policy_display(self):
1518
        return PROJECT_MEMBER_LEAVE_POLICIES.get(str(self.member_leave_policy))
1519

    
1520
def submit_application(**kw):
1521

    
1522
    resource_policies = kw.pop('resource_policies', None)
1523
    application = ProjectApplication(**kw)
1524

    
1525
    precursor = kw['precursor_application']
1526

    
1527
    if precursor is None:
1528
        application.chain = new_chain()
1529
    else:
1530
        application.chain = precursor.chain
1531
        if precursor.state == ProjectApplication.PENDING:
1532
            precursor.state = ProjectApplication.REPLACED
1533
            precursor.save()
1534

    
1535
    application.save()
1536
    application.resource_policies = resource_policies
1537
    return application
1538

    
1539
class ProjectResourceGrant(models.Model):
1540

    
1541
    resource                =   models.ForeignKey(Resource)
1542
    project_application     =   models.ForeignKey(ProjectApplication,
1543
                                                  null=True)
1544
    project_capacity        =   intDecimalField(default=QH_PRACTICALLY_INFINITE)
1545
    project_import_limit    =   intDecimalField(default=QH_PRACTICALLY_INFINITE)
1546
    project_export_limit    =   intDecimalField(default=QH_PRACTICALLY_INFINITE)
1547
    member_capacity         =   intDecimalField(default=QH_PRACTICALLY_INFINITE)
1548
    member_import_limit     =   intDecimalField(default=QH_PRACTICALLY_INFINITE)
1549
    member_export_limit     =   intDecimalField(default=QH_PRACTICALLY_INFINITE)
1550

    
1551
    objects = ExtendedManager()
1552

    
1553
    class Meta:
1554
        unique_together = ("resource", "project_application")
1555

    
1556
    def member_quota_values(self):
1557
        return QuotaValues(
1558
            quantity = 0,
1559
            capacity = self.member_capacity,
1560
            import_limit = self.member_import_limit,
1561
            export_limit = self.member_export_limit)
1562

    
1563
    def display_member_capacity(self):
1564
        if self.member_capacity:
1565
            if self.resource.unit:
1566
                return ProjectResourceGrant.display_filesize(
1567
                    self.member_capacity)
1568
            else:
1569
                if math.isinf(self.member_capacity):
1570
                    return 'Unlimited'
1571
                else:
1572
                    return self.member_capacity
1573
        else:
1574
            return 'Unlimited'
1575

    
1576
    def __str__(self):
1577
        return 'Max %s per user: %s' % (self.resource.pluralized_display_name,
1578
                                        self.display_member_capacity())
1579

    
1580
    @classmethod
1581
    def display_filesize(cls, value):
1582
        try:
1583
            value = float(value)
1584
        except:
1585
            return
1586
        else:
1587
            if math.isinf(value):
1588
                return 'Unlimited'
1589
            if value > 1:
1590
                unit_list = zip(['bytes', 'kB', 'MB', 'GB', 'TB', 'PB'],
1591
                                [0, 0, 0, 0, 0, 0])
1592
                exponent = min(int(math.log(value, 1024)), len(unit_list) - 1)
1593
                quotient = float(value) / 1024**exponent
1594
                unit, value_decimals = unit_list[exponent]
1595
                format_string = '{0:.%sf} {1}' % (value_decimals)
1596
                return format_string.format(quotient, unit)
1597
            if value == 0:
1598
                return '0 bytes'
1599
            if value == 1:
1600
                return '1 byte'
1601
            else:
1602
               return '0'
1603

    
1604

    
1605
class ProjectManager(ForUpdateManager):
1606

    
1607
    def terminated_projects(self):
1608
        q = self.model.Q_TERMINATED
1609
        return self.filter(q)
1610

    
1611
    def not_terminated_projects(self):
1612
        q = ~self.model.Q_TERMINATED
1613
        return self.filter(q)
1614

    
1615
    def terminating_projects(self):
1616
        q = self.model.Q_TERMINATED & Q(is_active=True)
1617
        return self.filter(q)
1618

    
1619
    def deactivated_projects(self):
1620
        q = self.model.Q_DEACTIVATED
1621
        return self.filter(q)
1622

    
1623
    def deactivating_projects(self):
1624
        q = self.model.Q_DEACTIVATED & Q(is_active=True)
1625
        return self.filter(q)
1626

    
1627
    def modified_projects(self):
1628
        return self.filter(is_modified=True)
1629

    
1630
    def reactivating_projects(self):
1631
        return self.filter(state=Project.APPROVED, is_active=False)
1632

    
1633
    def expired_projects(self):
1634
        q = (~Q(state=Project.TERMINATED) &
1635
              Q(application__end_date__lt=datetime.now()))
1636
        return self.filter(q)
1637

    
1638

    
1639
class Project(models.Model):
1640

    
1641
    application                 =   models.OneToOneField(
1642
                                            ProjectApplication,
1643
                                            related_name='project')
1644
    last_approval_date          =   models.DateTimeField(null=True)
1645

    
1646
    members                     =   models.ManyToManyField(
1647
                                            AstakosUser,
1648
                                            through='ProjectMembership')
1649

    
1650
    deactivation_reason         =   models.CharField(max_length=255, null=True)
1651
    deactivation_date           =   models.DateTimeField(null=True)
1652

    
1653
    creation_date               =   models.DateTimeField(auto_now_add=True)
1654
    name                        =   models.CharField(
1655
                                            max_length=80,
1656
                                            db_index=True,
1657
                                            unique=True)
1658

    
1659
    APPROVED    = 1
1660
    SUSPENDED   = 10
1661
    TERMINATED  = 100
1662

    
1663
    is_modified                 =   models.BooleanField(default=False,
1664
                                                        db_index=True)
1665
    is_active                   =   models.BooleanField(default=True,
1666
                                                        db_index=True)
1667
    state                       =   models.IntegerField(default=APPROVED,
1668
                                                        db_index=True)
1669

    
1670
    objects     =   ProjectManager()
1671

    
1672
    # Compiled queries
1673
    Q_TERMINATED  = Q(state=TERMINATED)
1674
    Q_SUSPENDED   = Q(state=SUSPENDED)
1675
    Q_DEACTIVATED = Q_TERMINATED | Q_SUSPENDED
1676

    
1677
    def __str__(self):
1678
        return _("<project %s '%s'>") % (self.id, self.application.name)
1679

    
1680
    __repr__ = __str__
1681

    
1682
    STATE_DISPLAY = {
1683
        APPROVED   : 'APPROVED',
1684
        SUSPENDED  : 'SUSPENDED',
1685
        TERMINATED : 'TERMINATED'
1686
        }
1687

    
1688
    def state_display(self):
1689
        return self.STATE_DISPLAY.get(self.state, _('Unknown'))
1690

    
1691
    def expiration_info(self):
1692
        return (str(self.id), self.name, self.state_display(),
1693
                str(self.application.end_date))
1694

    
1695
    def is_deactivated(self, reason=None):
1696
        if reason is not None:
1697
            return self.state == reason
1698

    
1699
        return self.state != self.APPROVED
1700

    
1701
    def is_deactivating(self, reason=None):
1702
        if not self.is_active:
1703
            return False
1704

    
1705
        return self.is_deactivated(reason)
1706

    
1707
    def is_deactivated_strict(self, reason=None):
1708
        if self.is_active:
1709
            return False
1710

    
1711
        return self.is_deactivated(reason)
1712

    
1713
    ### Deactivation calls
1714

    
1715
    def deactivate(self):
1716
        self.deactivation_date = datetime.now()
1717
        self.is_active = False
1718

    
1719
    def reactivate(self):
1720
        self.deactivation_date = None
1721
        self.is_active = True
1722

    
1723
    def terminate(self):
1724
        self.deactivation_reason = 'TERMINATED'
1725
        self.state = self.TERMINATED
1726
        self.save()
1727

    
1728
    def suspend(self):
1729
        self.deactivation_reason = 'SUSPENDED'
1730
        self.state = self.SUSPENDED
1731
        self.save()
1732

    
1733
    def resume(self):
1734
        self.deactivation_reason = None
1735
        self.state = self.APPROVED
1736
        self.save()
1737

    
1738
    ### Logical checks
1739

    
1740
    def is_inconsistent(self):
1741
        now = datetime.now()
1742
        dates = [self.creation_date,
1743
                 self.last_approval_date,
1744
                 self.deactivation_date]
1745
        return any([date > now for date in dates])
1746

    
1747
    def is_active_strict(self):
1748
        return self.is_active and self.state == self.APPROVED
1749

    
1750
    def is_approved(self):
1751
        return self.state == self.APPROVED
1752

    
1753
    @property
1754
    def is_alive(self):
1755
        return not self.is_terminated
1756

    
1757
    @property
1758
    def is_terminated(self):
1759
        return self.is_deactivated(self.TERMINATED)
1760

    
1761
    @property
1762
    def is_suspended(self):
1763
        return self.is_deactivated(self.SUSPENDED)
1764

    
1765
    def violates_resource_grants(self):
1766
        return False
1767

    
1768
    def violates_members_limit(self, adding=0):
1769
        application = self.application
1770
        limit = application.limit_on_members_number
1771
        if limit is None:
1772
            return False
1773
        return (len(self.approved_members) + adding > limit)
1774

    
1775

    
1776
    ### Other
1777

    
1778
    def count_pending_memberships(self):
1779
        memb_set = self.projectmembership_set
1780
        memb_count = memb_set.filter(state=ProjectMembership.REQUESTED).count()
1781
        return memb_count
1782

    
1783
    @property
1784
    def approved_memberships(self):
1785
        query = ProjectMembership.Q_ACCEPTED_STATES
1786
        return self.projectmembership_set.filter(query)
1787

    
1788
    @property
1789
    def approved_members(self):
1790
        return [m.person for m in self.approved_memberships]
1791

    
1792
    def add_member(self, user):
1793
        """
1794
        Raises:
1795
            django.exceptions.PermissionDenied
1796
            astakos.im.models.AstakosUser.DoesNotExist
1797
        """
1798
        if isinstance(user, int):
1799
            user = AstakosUser.objects.get(user=user)
1800

    
1801
        m, created = ProjectMembership.objects.get_or_create(
1802
            person=user, project=self
1803
        )
1804
        m.accept()
1805

    
1806
    def remove_member(self, user):
1807
        """
1808
        Raises:
1809
            django.exceptions.PermissionDenied
1810
            astakos.im.models.AstakosUser.DoesNotExist
1811
            astakos.im.models.ProjectMembership.DoesNotExist
1812
        """
1813
        if isinstance(user, int):
1814
            user = AstakosUser.objects.get(user=user)
1815

    
1816
        m = ProjectMembership.objects.get(person=user, project=self)
1817
        m.remove()
1818

    
1819

    
1820
class PendingMembershipError(Exception):
1821
    pass
1822

    
1823

    
1824
class ProjectMembershipManager(ForUpdateManager):
1825
    pass
1826

    
1827
class ProjectMembership(models.Model):
1828

    
1829
    person              =   models.ForeignKey(AstakosUser)
1830
    request_date        =   models.DateField(auto_now_add=True)
1831
    project             =   models.ForeignKey(Project)
1832

    
1833
    REQUESTED           =   0
1834
    ACCEPTED            =   1
1835
    # User deactivation
1836
    USER_SUSPENDED      =   10
1837
    # Project deactivation
1838
    PROJECT_DEACTIVATED =   100
1839

    
1840
    REMOVED             =   200
1841

    
1842
    ASSOCIATED_STATES   =   set([REQUESTED,
1843
                                 ACCEPTED,
1844
                                 USER_SUSPENDED,
1845
                                 PROJECT_DEACTIVATED])
1846

    
1847
    ACCEPTED_STATES     =   set([ACCEPTED,
1848
                                 USER_SUSPENDED,
1849
                                 PROJECT_DEACTIVATED])
1850

    
1851
    state               =   models.IntegerField(default=REQUESTED,
1852
                                                db_index=True)
1853
    is_pending          =   models.BooleanField(default=False, db_index=True)
1854
    is_active           =   models.BooleanField(default=False, db_index=True)
1855
    application         =   models.ForeignKey(
1856
                                ProjectApplication,
1857
                                null=True,
1858
                                related_name='memberships')
1859
    pending_application =   models.ForeignKey(
1860
                                ProjectApplication,
1861
                                null=True,
1862
                                related_name='pending_memberships')
1863
    pending_serial      =   models.BigIntegerField(null=True, db_index=True)
1864

    
1865
    acceptance_date     =   models.DateField(null=True, db_index=True)
1866
    leave_request_date  =   models.DateField(null=True)
1867

    
1868
    objects     =   ProjectMembershipManager()
1869

    
1870
    # Compiled queries
1871
    Q_ACCEPTED_STATES = ~Q(state=REQUESTED) & ~Q(state=REMOVED)
1872

    
1873
    def get_combined_state(self):
1874
        return self.state, self.is_active, self.is_pending
1875

    
1876
    class Meta:
1877
        unique_together = ("person", "project")
1878
        #index_together = [["project", "state"]]
1879

    
1880
    def __str__(self):
1881
        return _("<'%s' membership in '%s'>") % (
1882
                self.person.username, self.project)
1883

    
1884
    __repr__ = __str__
1885

    
1886
    def __init__(self, *args, **kwargs):
1887
        self.state = self.REQUESTED
1888
        super(ProjectMembership, self).__init__(*args, **kwargs)
1889

    
1890
    def _set_history_item(self, reason, date=None):
1891
        if isinstance(reason, basestring):
1892
            reason = ProjectMembershipHistory.reasons.get(reason, -1)
1893

    
1894
        history_item = ProjectMembershipHistory(
1895
                            serial=self.id,
1896
                            person=self.person_id,
1897
                            project=self.project_id,
1898
                            date=date or datetime.now(),
1899
                            reason=reason)
1900
        history_item.save()
1901
        serial = history_item.id
1902

    
1903
    def accept(self):
1904
        if self.is_pending:
1905
            m = _("%s: attempt to accept while is pending") % (self,)
1906
            raise AssertionError(m)
1907

    
1908
        state = self.state
1909
        if state != self.REQUESTED:
1910
            m = _("%s: attempt to accept in state '%s'") % (self, state)
1911
            raise AssertionError(m)
1912

    
1913
        now = datetime.now()
1914
        self.acceptance_date = now
1915
        self._set_history_item(reason='ACCEPT', date=now)
1916
        if self.project.is_approved():
1917
            self.state = self.ACCEPTED
1918
            self.is_pending = True
1919
        else:
1920
            self.state = self.PROJECT_DEACTIVATED
1921

    
1922
        self.save()
1923

    
1924
    def remove(self):
1925
        if self.is_pending:
1926
            m = _("%s: attempt to remove while is pending") % (self,)
1927
            raise AssertionError(m)
1928

    
1929
        state = self.state
1930
        if state not in self.ACCEPTED_STATES:
1931
            m = _("%s: attempt to remove in state '%s'") % (self, state)
1932
            raise AssertionError(m)
1933

    
1934
        self._set_history_item(reason='REMOVE')
1935
        self.state = self.REMOVED
1936
        self.is_pending = True
1937
        self.save()
1938

    
1939
    def reject(self):
1940
        if self.is_pending:
1941
            m = _("%s: attempt to reject while is pending") % (self,)
1942
            raise AssertionError(m)
1943

    
1944
        state = self.state
1945
        if state != self.REQUESTED:
1946
            m = _("%s: attempt to reject in state '%s'") % (self, state)
1947
            raise AssertionError(m)
1948

    
1949
        # rejected requests don't need sync,
1950
        # because they were never effected
1951
        self._set_history_item(reason='REJECT')
1952
        self.delete()
1953

    
1954
    def get_diff_quotas(self, sub_list=None, add_list=None):
1955
        if sub_list is None:
1956
            sub_list = []
1957

    
1958
        if add_list is None:
1959
            add_list = []
1960

    
1961
        sub_append = sub_list.append
1962
        add_append = add_list.append
1963
        holder = self.person.uuid
1964

    
1965
        synced_application = self.application
1966
        if synced_application is not None:
1967
            cur_grants = synced_application.projectresourcegrant_set.all()
1968
            for grant in cur_grants:
1969
                sub_append(QuotaLimits(
1970
                               holder       = holder,
1971
                               resource     = str(grant.resource),
1972
                               capacity     = grant.member_capacity,
1973
                               import_limit = grant.member_import_limit,
1974
                               export_limit = grant.member_export_limit))
1975

    
1976
        pending_application = self.pending_application
1977
        if pending_application is not None:
1978
            new_grants = pending_application.projectresourcegrant_set.all()
1979
            for new_grant in new_grants:
1980
                add_append(QuotaLimits(
1981
                               holder       = holder,
1982
                               resource     = str(new_grant.resource),
1983
                               capacity     = new_grant.member_capacity,
1984
                               import_limit = new_grant.member_import_limit,
1985
                               export_limit = new_grant.member_export_limit))
1986

    
1987
        return (sub_list, add_list)
1988

    
1989
    def set_sync(self):
1990
        if not self.is_pending:
1991
            m = _("%s: attempt to sync a non pending membership") % (self,)
1992
            raise AssertionError(m)
1993

    
1994
        state = self.state
1995
        if state == self.ACCEPTED:
1996
            pending_application = self.pending_application
1997
            if pending_application is None:
1998
                m = _("%s: attempt to sync an empty pending application") % (
1999
                    self,)
2000
                raise AssertionError(m)
2001

    
2002
            self.application = pending_application
2003
            self.is_active = True
2004

    
2005
            self.pending_application = None
2006
            self.pending_serial = None
2007

    
2008
            # project.application may have changed in the meantime,
2009
            # in which case we stay PENDING;
2010
            # we are safe to check due to select_for_update
2011
            if self.application == self.project.application:
2012
                self.is_pending = False
2013
            self.save()
2014

    
2015
        elif state == self.PROJECT_DEACTIVATED:
2016
            if self.pending_application:
2017
                m = _("%s: attempt to sync in state '%s' "
2018
                      "with a pending application") % (self, state)
2019
                raise AssertionError(m)
2020

    
2021
            self.application = None
2022
            self.is_active = False
2023
            self.pending_serial = None
2024
            self.is_pending = False
2025
            self.save()
2026

    
2027
        elif state == self.REMOVED:
2028
            self.delete()
2029

    
2030
        else:
2031
            m = _("%s: attempt to sync in state '%s'") % (self, state)
2032
            raise AssertionError(m)
2033

    
2034
    def reset_sync(self):
2035
        if not self.is_pending:
2036
            m = _("%s: attempt to reset a non pending membership") % (self,)
2037
            raise AssertionError(m)
2038

    
2039
        state = self.state
2040
        if state in [self.ACCEPTED, self.PROJECT_DEACTIVATED, self.REMOVED]:
2041
            self.pending_application = None
2042
            self.pending_serial = None
2043
            self.save()
2044
        else:
2045
            m = _("%s: attempt to reset sync in state '%s'") % (self, state)
2046
            raise AssertionError(m)
2047

    
2048
class Serial(models.Model):
2049
    serial  =   models.AutoField(primary_key=True)
2050

    
2051
def new_serial():
2052
    s = Serial.objects.create()
2053
    serial = s.serial
2054
    s.delete()
2055
    return serial
2056

    
2057
def sync_finish_serials(serials_to_ack=None):
2058
    if serials_to_ack is None:
2059
        serials_to_ack = qh_query_serials([])
2060

    
2061
    serials_to_ack = set(serials_to_ack)
2062
    sfu = ProjectMembership.objects.select_for_update()
2063
    memberships = list(sfu.filter(pending_serial__isnull=False))
2064

    
2065
    if memberships:
2066
        for membership in memberships:
2067
            serial = membership.pending_serial
2068
            if serial in serials_to_ack:
2069
                membership.set_sync()
2070
            else:
2071
                membership.reset_sync()
2072

    
2073
        transaction.commit()
2074

    
2075
    qh_ack_serials(list(serials_to_ack))
2076
    return len(memberships)
2077

    
2078
def pre_sync_projects(sync=True):
2079
    ACCEPTED = ProjectMembership.ACCEPTED
2080
    PROJECT_DEACTIVATED = ProjectMembership.PROJECT_DEACTIVATED
2081
    psfu = Project.objects.select_for_update()
2082

    
2083
    modified = list(psfu.modified_projects())
2084
    if sync:
2085
        for project in modified:
2086
            objects = project.projectmembership_set.select_for_update()
2087

    
2088
            memberships = objects.filter(state=ACCEPTED)
2089
            for membership in memberships:
2090
                membership.is_pending = True
2091
                membership.save()
2092

    
2093
    reactivating = list(psfu.reactivating_projects())
2094
    if sync:
2095
        for project in reactivating:
2096
            objects = project.projectmembership_set.select_for_update()
2097

    
2098
            memberships = objects.filter(state=PROJECT_DEACTIVATED)
2099
            for membership in memberships:
2100
                membership.is_pending = True
2101
                membership.state = ACCEPTED
2102
                membership.save()
2103

    
2104
    deactivating = list(psfu.deactivating_projects())
2105
    if sync:
2106
        for project in deactivating:
2107
            objects = project.projectmembership_set.select_for_update()
2108

    
2109
            # Note: we keep a user-level deactivation
2110
            # (e.g. USER_SUSPENDED) intact
2111
            memberships = objects.filter(state=ACCEPTED)
2112
            for membership in memberships:
2113
                membership.is_pending = True
2114
                membership.state = PROJECT_DEACTIVATED
2115
                membership.save()
2116

    
2117
    return (modified, reactivating, deactivating)
2118

    
2119
def do_sync_projects():
2120

    
2121
    ACCEPTED = ProjectMembership.ACCEPTED
2122
    objects = ProjectMembership.objects.select_for_update()
2123

    
2124
    sub_quota, add_quota = [], []
2125

    
2126
    serial = new_serial()
2127

    
2128
    pending = objects.filter(is_pending=True)
2129
    for membership in pending:
2130

    
2131
        if membership.pending_application:
2132
            m = "%s: impossible: pending_application is not None (%s)" % (
2133
                membership, membership.pending_application)
2134
            raise AssertionError(m)
2135
        if membership.pending_serial:
2136
            m = "%s: impossible: pending_serial is not None (%s)" % (
2137
                membership, membership.pending_serial)
2138
            raise AssertionError(m)
2139

    
2140
        if membership.state == ACCEPTED:
2141
            membership.pending_application = membership.project.application
2142

    
2143
        membership.pending_serial = serial
2144
        membership.get_diff_quotas(sub_quota, add_quota)
2145
        membership.save()
2146

    
2147
    transaction.commit()
2148
    # ProjectApplication.approve() unblocks here
2149
    # and can set PENDING an already PENDING membership
2150
    # which has been scheduled to sync with the old project.application
2151
    # Need to check in ProjectMembership.set_sync()
2152

    
2153
    r = qh_add_quota(serial, sub_quota, add_quota)
2154
    if r:
2155
        m = "cannot sync serial: %d" % serial
2156
        raise RuntimeError(m)
2157

    
2158
    return serial
2159

    
2160
def post_sync_projects():
2161
    ACCEPTED = ProjectMembership.ACCEPTED
2162
    PROJECT_DEACTIVATED = ProjectMembership.PROJECT_DEACTIVATED
2163
    psfu = Project.objects.select_for_update()
2164

    
2165
    modified = psfu.modified_projects()
2166
    for project in modified:
2167
        objects = project.projectmembership_set.select_for_update()
2168

    
2169
        memberships = list(objects.filter(state=ACCEPTED, is_pending=True))
2170
        if not memberships:
2171
            project.is_modified = False
2172
            project.save()
2173

    
2174
    reactivating = psfu.reactivating_projects()
2175
    for project in reactivating:
2176
        objects = project.projectmembership_set.select_for_update()
2177
        memberships = list(objects.filter(Q(state=PROJECT_DEACTIVATED) |
2178
                                          Q(is_pending=True)))
2179
        if not memberships:
2180
            project.reactivate()
2181
            project.save()
2182

    
2183
    deactivating = psfu.deactivating_projects()
2184
    for project in deactivating:
2185
        objects = project.projectmembership_set.select_for_update()
2186

    
2187
        memberships = list(objects.filter(Q(state=ACCEPTED) |
2188
                                          Q(is_pending=True)))
2189
        if not memberships:
2190
            project.deactivate()
2191
            project.save()
2192

    
2193
    transaction.commit()
2194

    
2195
def _sync_projects(sync):
2196
    sync_finish_serials()
2197
    # Informative only -- no select_for_update()
2198
    pending = ProjectMembership.objects.filter(is_pending=True)
2199

    
2200
    projects_log = pre_sync_projects(sync)
2201
    if sync:
2202
        serial = do_sync_projects()
2203
        sync_finish_serials([serial])
2204
        post_sync_projects()
2205

    
2206
    return (pending, projects_log)
2207

    
2208
def sync_projects(sync=True, retries=3, retry_wait=1.0):
2209
    return lock_sync(_sync_projects,
2210
                     args=[sync],
2211
                     retries=retries,
2212
                     retry_wait=retry_wait)
2213

    
2214

    
2215
def all_users_quotas(users):
2216
    quotas = {}
2217
    for user in users:
2218
        quotas[user.uuid] = user.all_quotas()
2219
    return quotas
2220

    
2221
def _sync_users(users, sync):
2222
    sync_finish_serials()
2223

    
2224
    existing, nonexisting = qh_check_users(users)
2225
    resources = get_resource_names()
2226
    registered_quotas = qh_get_quota_limits(existing, resources)
2227
    astakos_quotas = all_users_quotas(users)
2228

    
2229
    if sync:
2230
        r = register_users(nonexisting)
2231
        r = send_quotas(astakos_quotas)
2232

    
2233
    return (existing, nonexisting, registered_quotas, astakos_quotas)
2234

    
2235
def sync_users(users, sync=True, retries=3, retry_wait=1.0):
2236
    return lock_sync(_sync_users,
2237
                     args=[users, sync],
2238
                     retries=retries,
2239
                     retry_wait=retry_wait)
2240

    
2241
def sync_all_users(sync=True, retries=3, retry_wait=1.0):
2242
    users = AstakosUser.objects.all()
2243
    return sync_users(users, sync, retries=retries, retry_wait=retry_wait)
2244

    
2245
def lock_sync(func, args=[], kwargs={}, retries=3, retry_wait=1.0):
2246
    transaction.commit()
2247

    
2248
    cursor = connection.cursor()
2249
    locked = True
2250
    try:
2251
        while 1:
2252
            cursor.execute("SELECT pg_try_advisory_lock(1)")
2253
            r = cursor.fetchone()
2254
            if r is None:
2255
                m = "Impossible"
2256
                raise AssertionError(m)
2257
            locked = r[0]
2258
            if locked:
2259
                break
2260

    
2261
            retries -= 1
2262
            if retries <= 0:
2263
                return False
2264
            sleep(retry_wait)
2265

    
2266
        return func(*args, **kwargs)
2267

    
2268
    finally:
2269
        if locked:
2270
            cursor.execute("SELECT pg_advisory_unlock(1)")
2271
            cursor.fetchall()
2272

    
2273

    
2274
class ProjectMembershipHistory(models.Model):
2275
    reasons_list    =   ['ACCEPT', 'REJECT', 'REMOVE']
2276
    reasons         =   dict((k, v) for v, k in enumerate(reasons_list))
2277

    
2278
    person  =   models.BigIntegerField()
2279
    project =   models.BigIntegerField()
2280
    date    =   models.DateField(auto_now_add=True)
2281
    reason  =   models.IntegerField()
2282
    serial  =   models.BigIntegerField()
2283

    
2284
### SIGNALS ###
2285
################
2286

    
2287
def create_astakos_user(u):
2288
    try:
2289
        AstakosUser.objects.get(user_ptr=u.pk)
2290
    except AstakosUser.DoesNotExist:
2291
        extended_user = AstakosUser(user_ptr_id=u.pk)
2292
        extended_user.__dict__.update(u.__dict__)
2293
        extended_user.save()
2294
        if not extended_user.has_auth_provider('local'):
2295
            extended_user.add_auth_provider('local')
2296
    except BaseException, e:
2297
        logger.exception(e)
2298

    
2299

    
2300
def fix_superusers(sender, **kwargs):
2301
    # Associate superusers with AstakosUser
2302
    admins = User.objects.filter(is_superuser=True)
2303
    for u in admins:
2304
        create_astakos_user(u)
2305
post_syncdb.connect(fix_superusers)
2306

    
2307

    
2308
def user_post_save(sender, instance, created, **kwargs):
2309
    if not created:
2310
        return
2311
    create_astakos_user(instance)
2312
post_save.connect(user_post_save, sender=User)
2313

    
2314
def astakosuser_post_save(sender, instance, created, **kwargs):
2315
    pass
2316

    
2317
post_save.connect(astakosuser_post_save, sender=AstakosUser)
2318

    
2319
def resource_post_save(sender, instance, created, **kwargs):
2320
    pass
2321

    
2322
post_save.connect(resource_post_save, sender=Resource)
2323

    
2324
def renew_token(sender, instance, **kwargs):
2325
    if not instance.auth_token:
2326
        instance.renew_token()
2327
pre_save.connect(renew_token, sender=AstakosUser)
2328
pre_save.connect(renew_token, sender=Service)
2329