Merge branch 'newstyles' into userguide
[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 get_default_os(self):
116         try:
117             return self.clientversionsource_set.filter(default=True)[0].os
118         except IndexError:
119             return self.clientversionsource_set.filter()[0].os
120
121     def __unicode__(self):
122         return self.name
123
124
125 class ClientVersionSource(models.Model):
126     """
127     Client version source. source_type choices should map to
128     cloudcms.clients.SOURCE_TYPES.
129     """
130
131     default = models.BooleanField(default=True)
132     source_type = models.CharField(max_length=60,
133             choices=(('link','Link'),
134                      ('direct','Direct'),
135                      ('redmine_files','Redmine files')))
136     os = models.CharField(max_length=255)
137     link = models.CharField(max_length=255)
138     logo = MediaFileForeignKey(MediaFile, blank=True, null=True)
139     architecture = models.CharField(max_length=255, null=True, blank=True,
140             help_text="""Depending the source type this can be left empty and
141             let source type identify the architecture""")
142     client = models.ForeignKey(Client)
143     version_regex = models.CharField(max_length=255, help_text="""Regular expression to
144             match the version of the file based on retrieved source filenames
145             (used in redmine source types)""", null=True, blank=True)
146     file_regex = models.CharField(max_length=255, help_text="""Return only files that
147             match this expression""", null=True, blank=True)
148
149     def __unicode__(self):
150         return "[%s] %s" % (self.get_source_type_display(), self.os)
151
152
153 # hook for feincms configuration, is this appropriate place ??? who knows
154 from cloudcms.cms import *
155
156 class Service(models.Model, translations.TranslatedObjectMixin):
157     """
158     Service.
159     """
160
161     ordering = models.SmallIntegerField(_('ordering'), default=0)
162     image_faq = MediaFileForeignKey(MediaFile, blank=True, null=True, related_name='image_faq')
163     image_userguide = MediaFileForeignKey(MediaFile, blank=True, null=True,related_name='image_userguide')
164     class_name = models.CharField(_('class name'), max_length=100, blank=True)
165     
166     
167     class Meta:
168         verbose_name = _('service')
169         verbose_name_plural = _('services')
170         ordering = ['-ordering',]
171
172     objects = translations.TranslatedObjectManager()
173
174     def get_first_question(self):
175         try:
176             return self.faqs.filter(is_active=True)[0]
177         except:
178             return None
179         
180     def __unicode__(self):
181         trans = translations.TranslatedObjectMixin.__unicode__(self)
182         return trans or _('Unnamed category')
183
184
185 class ServiceTranslation(translations.Translation(Service)):
186     """
187     Service translation
188     """
189     title = models.CharField(_('service title'), max_length=100)
190     slug = models.SlugField(_('slug'), unique=True)
191     description = models.CharField(_('description'), max_length=250, blank=True)
192     cms_page = models.ForeignKey(Page, null=True, blank=True)
193     title_faq = models.CharField(_('service title (faq section)'), max_length=100, blank=True)
194     title_userguide = models.CharField(_('service title (userguide section)'), max_length=100, blank=True)
195     
196     class Meta:
197         verbose_name = _('service translation')
198         verbose_name_plural = _('service translations')
199         ordering = ['title']
200
201     def __unicode__(self):
202         return self.title
203
204     def save(self, *args, **kwargs):
205         if not self.slug:
206             self.slug = slugify(self.title)
207
208         super(ServiceTranslation, self).save(*args, **kwargs)
209