code.grnet.gr Git - snf-cloudcms/blob - 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
  59     MESSAGE_TYPE_CHOICES = (
  60         ('NM','No Message'),
  61         ('success','Success'),
  62         ('error','Error'),
  63         ('warning','Warning'),
  64         ('info','Info'),
  65     )
  66
  67
  68     code = models.CharField('Identifier', max_length=100, null=False, blank=False,
  69             help_text="Just a codename of the application, to be used in "\
  70                     "several places where no free text is allowed"\
  71                     "(e.g. urls, paths, etc)")
  72     title = models.CharField(max_length=255, null=False, blank=False,
  73             help_text="The title of the application")
  74
  75     logo = MediaFileForeignKey(MediaFile, blank=True, null=True)
  76     favicon = MediaFileForeignKey(MediaFile, blank=True, null=True,
  77             related_name="as_favicon")
  78     site = models.ForeignKey(sites_models.Site)
  79     app_url = models.URLField(help_text="The url of the application UI (not "\
  80             "the cms)", verify_exists=False, blank=True, null=True)
  81     accounts_url = models.CharField(max_length=255, default="/", blank=True,
  82             null=True, help_text="Tha accounts login page")
  83     index_url = models.CharField(max_length=255, default="/", blank=False,
  84             null=False)
  85     linked_in_username = models.CharField(max_length=255, blank=True)
  86     twitter_username = models.CharField(max_length=255, blank=True)
  87     facebook_username = models.CharField(max_length=255, blank=True)
  88
  89     show_twitter_feed_on_top = models.BooleanField(default=False)
  90     extra_styles = models.TextField(default="", blank=True)
  91
  92     footer_top = models.TextField(default="", blank=True)
  93     footer_bottom = models.TextField(default="", blank=True)
  94
  95     message_type = models.CharField(max_length=20,
  96                                     choices= MESSAGE_TYPE_CHOICES,
  97                                     default = 'NM' )
  98     custom_message = models.TextField(default="", blank=True)
  99
 100     @classmethod
 101     def current(cls):
 102         return cls.objects.get(site__pk=settings.SITE_ID)
 103
 104     def __unicode__(self):
 105         return self.title
 106
 107
 108 # http://stackoverflow.com/a/2680060/114435
 109 dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime.datetime) else None
 110
 111 class Client(models.Model):
 112     """
 113     Model which refers to a service/application client. Client model contains
 114     multiple ClientVersionSource to identify it's version downloads.
 115     """
 116     uid = models.CharField(max_length=255)
 117     name = models.CharField(max_length=255)
 118
 119     def get_sources(self):
 120         sources = {}
 121         from cloudcms.clients import ClientVersions
 122         for s in self.clientversionsource_set.all():
 123             sources[s.os] = {'type': s.source_type,
 124                              'args': [s.link]}
 125
 126         return ClientVersions(sources, cache_backend=cache)
 127
 128     def to_json(self):
 129         return simplejson.dumps(list(self.get_sources().get_latest_versions()),
 130                 default=dthandler)
 131
 132     def get_default_os(self):
 133         try:
 134             return self.clientversionsource_set.filter(default=True)[0].os
 135         except IndexError:
 136             return self.clientversionsource_set.filter()[0].os
 137
 138     def __unicode__(self):
 139         return self.name
 140
 141
 142 class ClientVersionSource(models.Model):
 143     """
 144     Client version source. source_type choices should map to
 145     cloudcms.clients.SOURCE_TYPES.
 146     """
 147
 148     default = models.BooleanField(default=True)
 149     source_type = models.CharField(max_length=60,
 150             choices=(('link','Link'),
 151                      ('direct','Direct'),
 152                      ('pithos_xml','Pithos XML'),
 153                      ('redmine_files','Redmine files')))
 154     os = models.CharField(max_length=255)
 155     link = models.CharField(max_length=255)
 156     logo = MediaFileForeignKey(MediaFile, blank=True, null=True)
 157     architecture = models.CharField(max_length=255, null=True, blank=True,
 158             help_text="""Depending the source type this can be left empty and
 159             let source type identify the architecture""")
 160     client = models.ForeignKey(Client)
 161     version_regex = models.CharField(max_length=255, help_text="""Regular expression to
 162             match the version of the file based on retrieved source filenames
 163             (used in redmine source types)""", null=True, blank=True)
 164     file_regex = models.CharField(max_length=255, help_text="""Return only files that
 165             match this expression""", null=True, blank=True)
 166
 167     def __unicode__(self):
 168         return "[%s] %s" % (self.get_source_type_display(), self.os)
 169
 170
 171 # hook for feincms configuration, is this appropriate place ??? who knows
 172 from cloudcms.cms import *
 173
 174 class Service(models.Model, translations.TranslatedObjectMixin):
 175     """
 176     Service.
 177     """
 178
 179     ordering = models.SmallIntegerField(_('ordering'), default=0)
 180     image_faq = MediaFileForeignKey(MediaFile, blank=True, null=True, related_name='image_faq')
 181     image_userguide = MediaFileForeignKey(MediaFile, blank=True, null=True,related_name='image_userguide')
 182     class_name = models.CharField(_('class name'), max_length=100, blank=True)
 183
 184
 185     class Meta:
 186         verbose_name = _('service')
 187         verbose_name_plural = _('services')
 188         ordering = ['-ordering',]
 189
 190     objects = translations.TranslatedObjectManager()
 191
 192     def get_first_question(self):
 193         try:
 194             return self.faqs.filter(is_active=True)[0]
 195         except:
 196             return None
 197
 198     def get_first_entry(self):
 199         try:
 200             return self.userguideentries.filter(is_active=True)[0]
 201         except:
 202             return None
 203
 204     def __unicode__(self):
 205         trans = translations.TranslatedObjectMixin.__unicode__(self)
 206         return trans or _('Unnamed category')
 207
 208
 209 class ServiceTranslation(translations.Translation(Service)):
 210     """
 211     Service translation
 212     """
 213     title = models.CharField(_('service title'), max_length=100)
 214     slug = models.SlugField(_('slug'), unique=True)
 215     description = models.CharField(_('description'), max_length=250, blank=True)
 216     cms_page = models.ForeignKey(Page, null=True, blank=True)
 217     title_faq = models.CharField(_('service title (faq section)'), max_length=100, blank=True)
 218     title_userguide = models.CharField(_('service title (userguide section)'), max_length=100, blank=True)
 219
 220     class Meta:
 221         verbose_name = _('service translation')
 222         verbose_name_plural = _('service translations')
 223         ordering = ['title']
 224
 225     def __unicode__(self):
 226         return self.title
 227
 228     def save(self, *args, **kwargs):
 229         if not self.slug:
 230             self.slug = slugify(self.title)
 231
 232         super(ServiceTranslation, self).save(*args, **kwargs)
 233