Cloudcms Service model
[snf-cloudcms] / cloudcms / models.py
1 # Copyright 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 datetime
35
36 from django.db import models
37 from django.conf import settings
38 from django.contrib.sites import models as sites_models
39 from django.utils.translation import ugettext_lazy as _, ugettext, ungettext
40 from django.core.cache import cache
41 from django.utils import simplejson
42
43 from feincms import translations
44 from feincms.module.medialibrary.fields import MediaFileForeignKey
45 from feincms.module.medialibrary.models import MediaFile
46
47
48 class Application(models.Model):
49     """
50     Application object refers to the application each cms is deployed for.
51
52     Each cms deployment should contain at least one application object linked
53     to the site object the cms is deployed for.
54
55     Enabling cloudcms.context_processors.application in CONTEXT_PROCESSROS setting
56     let you can access the application object throughout the html templates.
57     """
58     code = models.CharField('Identifier', max_length=100, null=False, blank=False,
59             help_text="Just a codename of the application, to be used in "\
60                     "several places where no free text is allowed"\
61                     "(e.g. urls, paths, etc)")
62     title = models.CharField(max_length=255, null=False, blank=False,
63             help_text="The title of the application")
64
65     logo = MediaFileForeignKey(MediaFile, blank=True, null=True)
66     favicon = MediaFileForeignKey(MediaFile, blank=True, null=True,
67             related_name="as_favicon")
68     site = models.ForeignKey(sites_models.Site)
69     app_url = models.URLField(help_text="The url of the application UI (not "\
70             "the cms", verify_exists=False, blank=True, null=True)
71     index_url = models.CharField(max_length=255, default="/", blank=False,
72             null=False)
73     linked_in_username = models.CharField(max_length=255, blank=True)
74     twitter_username = models.CharField(max_length=255, blank=True)
75     facebook_username = models.CharField(max_length=255, blank=True)
76
77     show_twitter_feed_on_top = models.BooleanField(default=False)
78     extra_styles = models.TextField(default="", blank=True)
79
80     footer_top = models.TextField(default="", blank=True)
81     footer_bottom = models.TextField(default="", blank=True)
82
83     @classmethod
84     def current(cls):
85         return cls.objects.get(site__pk=settings.SITE_ID)
86
87     def __unicode__(self):
88         return self.title
89
90
91 # http://stackoverflow.com/a/2680060/114435
92 dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime.datetime) else None
93
94 class Client(models.Model):
95     """
96     Model which refers to a service/application client. Client model contains
97     multiple ClientVersionSource to identify it's version downloads.
98     """
99     uid = models.CharField(max_length=255)
100     name = models.CharField(max_length=255)
101
102     def get_sources(self):
103         sources = {}
104         from cloudcms.clients import ClientVersions
105         for s in self.clientversionsource_set.all():
106             sources[s.os] = {'type': s.source_type,
107                              'args': [s.link]}
108
109         return ClientVersions(sources, cache_backend=cache)
110
111     def to_json(self):
112         return simplejson.dumps(list(self.get_sources().get_latest_versions()),
113                 default=dthandler)
114
115     def __unicode__(self):
116         return self.name
117
118
119 class ClientVersionSource(models.Model):
120     """
121     Client version source. source_type choices should map to
122     cloudcms.clients.SOURCE_TYPES.
123     """
124     source_type = models.CharField(max_length=60,
125             choices=(('link','Link'),
126                      ('direct','Direct'),
127                      ('redmine_files','Redmine files')))
128     os = models.CharField(max_length=255)
129     link = models.CharField(max_length=255)
130     logo = MediaFileForeignKey(MediaFile, blank=True, null=True)
131     architecture = models.CharField(max_length=255, null=True, blank=True,
132             help_text="""Depending the source type this can be left empty and
133             let source type identify the architecture""")
134     client = models.ForeignKey(Client)
135     version_regex = models.CharField(max_length=255, help_text="""Regular expression to
136             match the version of the file based on retrieved source filenames
137             (used in redmine source types)""", null=True, blank=True)
138     file_regex = models.CharField(max_length=255, help_text="""Return only files that
139             match this expression""", null=True, blank=True)
140
141     def __unicode__(self):
142         return "[%s] %s" % (self.get_source_type_display(), self.os)
143
144
145 # hook for feincms configuration, is this appropriate place ??? who knows
146 from cloudcms.cms import *
147
148 class Service(models.Model, translations.TranslatedObjectMixin):
149     """
150     Service.
151     """
152
153     ordering = models.SmallIntegerField(_('ordering'), default=0)
154
155     class Meta:
156         verbose_name = _('service')
157         verbose_name_plural = _('services')
158         ordering = ['-ordering',]
159
160     objects = translations.TranslatedObjectManager()
161
162     def __unicode__(self):
163         trans = translations.TranslatedObjectMixin.__unicode__(self)
164         return trans or _('Unnamed category')
165
166
167 class ServiceTranslation(translations.Translation(Service)):
168     """
169     Service translation
170     """
171     title = models.CharField(_('service title'), max_length=100)
172     slug = models.SlugField(_('slug'), unique=True)
173     description = models.CharField(_('description'), max_length=250, blank=True)
174     cms_page = models.ForeignKey(Page, null=True, blank=True)
175
176     class Meta:
177         verbose_name = _('service translation')
178         verbose_name_plural = _('service translations')
179         ordering = ['title']
180
181     def __unicode__(self):
182         return self.title
183
184     def save(self, *args, **kwargs):
185         if not self.slug:
186             self.slug = slugify(self.title)
187
188         super(ServiceTranslation, self).save(*args, **kwargs)
189