Merge branch 'master' of ssh://git.planet-lab.org/git/plstackapi into observer3.0
[plstackapi.git] / planetstack / core / models / site.py
1 import os
2 from django.db import models
3 from core.models import PlCoreBase
4 from core.models import Tag
5 from django.contrib.contenttypes import generic
6 from geoposition.fields import GeopositionField
7 from core.acl import AccessControlList
8
9 class Site(PlCoreBase):
10     """
11         A logical grouping of Nodes that are co-located at the same geographic location, which also typically corresponds to the Nodes' location in the physical network.
12     """
13     name = models.CharField(max_length=200, help_text="Name for this Site")
14     site_url = models.URLField(null=True, blank=True, max_length=512, help_text="Site's Home URL Page")
15     enabled = models.BooleanField(default=True, help_text="Status for this Site")
16     location = GeopositionField()
17     longitude = models.FloatField(null=True, blank=True)
18     latitude = models.FloatField(null=True, blank=True)
19     login_base = models.CharField(max_length=50, unique=True, help_text="Prefix for Slices associated with this Site")
20     is_public = models.BooleanField(default=True, help_text="Indicates the visibility of this site to other members")
21     abbreviated_name = models.CharField(max_length=80)
22
23     #deployments = models.ManyToManyField('Deployment', blank=True, related_name='sites')
24     deployments = models.ManyToManyField('Deployment', through='SiteDeployments', blank=True, help_text="Select which sites are allowed to host nodes in this deployment", related_name='sites')
25     tags = generic.GenericRelation(Tag)
26
27     def __unicode__(self):  return u'%s' % (self.name)
28
29     def can_update(self, user):
30         if user.is_readonly:
31             return False
32         if user.is_admin:
33             return True
34         site_privs = SitePrivilege.objects.filter(user=user, site=self)
35         for site_priv in site_privs:
36             if site_priv.role.role == 'pi':
37                 return True
38         return False 
39
40     @staticmethod
41     def select_by_user(user):
42         if user.is_admin:
43             qs = Site.objects.all()
44         else:
45             site_ids = [sp.site.id for sp in SitePrivilege.objects.filter(user=user)]
46             site_ids.append(user.site.id)
47             qs = Site.objects.filter(id__in=site_ids)
48         return qs
49
50
51 class SiteRole(PlCoreBase):
52
53     ROLE_CHOICES = (('admin','Admin'),('pi','PI'),('tech','Tech'),('billing','Billing'))
54     role = models.CharField(choices=ROLE_CHOICES, unique=True, max_length=30)
55
56     def __unicode__(self):  return u'%s' % (self.role)
57
58 class SitePrivilege(PlCoreBase):
59
60     user = models.ForeignKey('User', related_name='site_privileges')
61     site = models.ForeignKey('Site', related_name='site_privileges')
62     role = models.ForeignKey('SiteRole')
63
64     def __unicode__(self):  return u'%s %s %s' % (self.site, self.user, self.role)
65
66     def save(self, *args, **kwds):
67         super(SitePrivilege, self).save(*args, **kwds)
68
69     def delete(self, *args, **kwds):
70         super(SitePrivilege, self).delete(*args, **kwds)
71
72     def can_update(self, user):
73         return self.site.can_update(user)
74
75     @staticmethod
76     def select_by_user(user):
77         if user.is_admin:
78             qs = SitePrivilege.objects.all()
79         else:
80             sp_ids = [sp.id for sp in SitePrivilege.objects.filter(user=user)]
81             qs = SitePrivilege.objects.filter(id__in=sp_ids)
82         return qs
83
84 class Deployment(PlCoreBase):
85     name = models.CharField(max_length=200, unique=True, help_text="Name of the Deployment")
86     admin_user = models.CharField(max_length=200, null=True, blank=True, help_text="Username of an admin user at this deployment")
87     admin_password = models.CharField(max_length=200, null=True, blank=True, help_text="Password of theadmin user at this deployment")\r
88     admin_tenant = models.CharField(max_length=200, null=True, blank=True, help_text="Name of the tenant the admin user belongs to")\r
89     auth_url = models.CharField(max_length=200, null=True, blank=True, help_text="Auth url for the deployment")
90
91     # smbaker: the default of 'allow all' is intended for evolutions of existing
92     #    deployments. When new deployments are created via the GUI, they are
93     #    given a default of 'allow site <site_of_creator>'
94     accessControl = models.TextField(max_length=200, blank=False, null=False, default="allow all",
95                                      help_text="Access control list that specifies which sites/users may use nodes in this deployment")
96
97     def get_acl(self):
98         return AccessControlList(self.accessControl)
99
100     def test_acl(self, slice=None, user=None):
101         potential_users=[]
102
103         if user:
104             potential_users.append(user)
105
106         if slice:
107             potential_users.append(slice.creator)
108             for priv in slice.slice_privileges.all():
109                 if priv.user not in potential_users:
110                     potential_users.append(priv.user)
111
112         acl = self.get_acl()
113         for user in potential_users:
114             if acl.test(user) == "allow":
115                 return True
116
117         return False
118
119     @staticmethod
120     def select_by_acl(user):
121         ids = []
122         for deployment in Deployment.objects.all():
123             acl = deployment.get_acl()
124             if acl.test(user) == "allow":
125                 ids.append(deployment.id)
126
127         return Deployment.objects.filter(id__in=ids)
128
129     def __unicode__(self):  return u'%s' % (self.name)
130
131     @staticmethod
132     def select_by_user(user):
133         return Deployment.objects.all()
134
135 class DeploymentRole(PlCoreBase):
136
137     ROLE_CHOICES = (('admin','Admin'),)
138     role = models.CharField(choices=ROLE_CHOICES, unique=True, max_length=30)
139
140     def __unicode__(self):  return u'%s' % (self.role)
141
142 class DeploymentPrivilege(PlCoreBase):
143
144     user = models.ForeignKey('User', related_name='deployment_privileges')
145     deployment = models.ForeignKey('Deployment', related_name='deployment_privileges')
146     role = models.ForeignKey('DeploymentRole')
147
148     def __unicode__(self):  return u'%s %s %s' % (self.deployment, self.user, self.role)
149
150     def can_update(self, user):
151         if user.is_readonly:
152             return False
153         if user.is_admin:
154             return True
155         dprivs = DeploymentPrivilege.objects.filter(user=user)
156         for dpriv in dprivs:
157             if dpriv.role.role == 'admin':
158                 return True
159         return False
160
161     @staticmethod
162     def select_by_user(user):
163         if user.is_admin:
164             qs = DeploymentPrivilege.objects.all()
165         else:
166             dpriv_ids = [dp.id for dp in DeploymentPrivilege.objects.filter(user=user)]
167             qs = DeploymentPrivilege.objects.filter(id__in=dpriv_ids)
168         return qs 
169
170 class SiteDeployments(PlCoreBase):
171     site = models.ForeignKey(Site)
172     deployment = models.ForeignKey(Deployment)
173     tenant_id = models.CharField(null=True, blank=True, max_length=200, help_text="Keystone tenant id")    
174
175     @staticmethod
176     def select_by_user(user):
177         return SiteDeployments.objects.all()
178
179     #class Meta:
180     #    db_table = 'core_site_deployments'
181     #    #auto_created = Site
182