Integrate automatic discovery of client versions
[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.core.cache import cache
40 from django.utils import simplejson
41
42 from feincms.module.medialibrary.fields import MediaFileForeignKey
43 from feincms.module.medialibrary.models import MediaFile
44
45
46 class Application(models.Model):
47     """
48     Application object refers to the application each cms is deployed for.
49
50     Each cms deployment should contain at least one application object linked
51     to the site object the cms is deployed for.
52
53     Enabling cloudcms.context_processors.application in CONTEXT_PROCESSROS setting
54     let you can access the application object throughout the html templates.
55     """
56     code = models.CharField('Identifier', max_length=100, null=False, blank=False,
57             help_text="Just a codename of the application, to be used in "\
58                     "several places where no free text is allowed"\
59                     "(e.g. urls, paths, etc)")
60     title = models.CharField(max_length=255, null=False, blank=False,
61             help_text="The title of the application")
62
63     logo = MediaFileForeignKey(MediaFile, blank=True, null=True)
64     favicon = MediaFileForeignKey(MediaFile, blank=True, null=True,
65             related_name="as_favicon")
66     site = models.ForeignKey(sites_models.Site)
67     app_url = models.URLField(help_text="The url of the application UI (not "\
68             "the cms", verify_exists=False, blank=True, null=True)
69     index_url = models.CharField(max_length=255, default="/", blank=False,
70             null=False)
71     linked_in_username = models.CharField(max_length=255, blank=True)
72     twitter_username = models.CharField(max_length=255, blank=True)
73     facebook_username = models.CharField(max_length=255, blank=True)
74
75     show_twitter_feed_on_top = models.BooleanField(default=False)
76     extra_styles = models.TextField(default="", blank=True)
77
78     footer_top = models.TextField(default="", blank=True)
79     footer_bottom = models.TextField(default="", blank=True)
80
81     @classmethod
82     def current(cls):
83         return cls.objects.get(site__pk=settings.SITE_ID)
84
85     def __unicode__(self):
86         return self.title
87
88
89 # http://stackoverflow.com/a/2680060/114435
90 dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime.datetime) else None
91
92 class Client(models.Model):
93     """
94     Model which refers to a service/application client. Client model contains
95     multiple ClientVersionSource to identify it's version downloads.
96     """
97     uid = models.CharField(max_length=255)
98     name = models.CharField(max_length=255)
99
100     def get_sources(self):
101         sources = {}
102         from cloudcms.clients import ClientVersions
103         for s in self.clientversionsource_set.all():
104             sources[s.os] = {'type': s.source_type,
105                              'args': [s.link]}
106
107         return ClientVersions(sources, cache_backend=cache)
108
109     def to_json(self):
110         return simplejson.dumps(list(self.get_sources().get_latest_versions()),
111                 default=dthandler)
112
113     def __unicode__(self):
114         return self.name
115
116
117 class ClientVersionSource(models.Model):
118     """
119     Client version source. source_type choices should map to
120     cloudcms.clients.SOURCE_TYPES.
121     """
122     source_type = models.CharField(max_length=60,
123             choices=(('link','Link'),
124                      ('direct','Direct'),
125                      ('redmine_files','Redmine files')))
126     os = models.CharField(max_length=255)
127     link = models.CharField(max_length=255)
128     logo = MediaFileForeignKey(MediaFile, blank=True, null=True)
129     architecture = models.CharField(max_length=255, null=True, blank=True,
130             help_text="""Depending the source type this can be left empty and
131             let source type identify the architecture""")
132     client = models.ForeignKey(Client)
133     version_regex = models.CharField(max_length=255, help_text="""Regular expression to
134             match the version of the file based on retrieved source filenames
135             (used in redmine source types)""", null=True, blank=True)
136     file_regex = models.CharField(max_length=255, help_text="""Return only files that
137             match this expression""", null=True, blank=True)
138
139     def __unicode__(self):
140         return "[%s] %s" % (self.get_source_type_display(), self.os)
141
142
143 # hook for feincms configuration, is this appropriate place ??? who knows
144 from cloudcms.cms import *
145