models.py 13.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Copyright 2014 Budapest University of Technology and Economics (BME IK)
#
# This file is part of CIRCLE Cloud.
#
# CIRCLE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# CIRCLE is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along
# with CIRCLE.  If not, see <http://www.gnu.org/licenses/>.

Őry Máté committed
18
from collections import deque
19
from contextlib import contextmanager
20
from hashlib import sha224
21
from itertools import chain, imap
22
from logging import getLogger
23
from time import time
24
from warnings import warn
25

26
from django.contrib.auth.models import User
27
from django.core.cache import cache
Dudás Ádám committed
28 29 30
from django.db.models import (
    CharField, DateTimeField, ForeignKey, NullBooleanField
)
31
from django.utils import timezone
32 33
from django.utils.translation import ugettext_lazy as _, ugettext_noop
from jsonfield import JSONField
34

35 36
from model_utils.models import TimeStampedModel

37 38
logger = getLogger(__name__)

39

40 41 42 43
class WorkerNotFound(Exception):
    pass


44
def activitycontextimpl(act, on_abort=None, on_commit=None):
45 46
    try:
        yield act
47 48 49
    except BaseException as e:
        # BaseException is the common parent of Exception and
        # system-exiting exceptions, e.g. KeyboardInterrupt
50
        handler = None if on_abort is None else lambda a: on_abort(a, e)
51 52 53 54 55
        result = create_readable(ugettext_noop("Failure."),
                                 ugettext_noop("Unhandled exception: "
                                               "%(error)s"),
                                 error=unicode(e))
        act.finish(succeeded=False, result=result, event_handler=handler)
56 57
        raise e
    else:
58
        act.finish(succeeded=True, event_handler=on_commit)
59 60


61 62 63
activity_context = contextmanager(activitycontextimpl)


64 65 66
activity_code_separator = '.'


67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
def has_prefix(activity_code, *prefixes):
    """Determine whether the activity code has the specified prefix.

    E.g.: has_prefix('foo.bar.buz', 'foo.bar') == True
          has_prefix('foo.bar.buz', 'foo', 'bar') == True
          has_prefix('foo.bar.buz', 'foo.bar', 'buz') == True
          has_prefix('foo.bar.buz', 'foo', 'bar', 'buz') == True
          has_prefix('foo.bar.buz', 'foo', 'buz') == False
    """
    equal = lambda a, b: a == b
    act_code_parts = split_activity_code(activity_code)
    prefixes = chain(*imap(split_activity_code, prefixes))
    return all(imap(equal, act_code_parts, prefixes))


def has_suffix(activity_code, *suffixes):
    """Determine whether the activity code has the specified suffix.

    E.g.: has_suffix('foo.bar.buz', 'bar.buz') == True
          has_suffix('foo.bar.buz', 'bar', 'buz') == True
          has_suffix('foo.bar.buz', 'foo.bar', 'buz') == True
          has_suffix('foo.bar.buz', 'foo', 'bar', 'buz') == True
          has_suffix('foo.bar.buz', 'foo', 'buz') == False
    """
    equal = lambda a, b: a == b
    act_code_parts = split_activity_code(activity_code)
93
    suffixes = list(chain(*imap(split_activity_code, suffixes)))
94 95 96
    return all(imap(equal, reversed(act_code_parts), reversed(suffixes)))


97 98
def join_activity_code(*args):
    """Join the specified parts into an activity code.
99 100

    :returns: Activity code string.
101 102 103 104
    """
    return activity_code_separator.join(args)


105 106 107 108 109 110 111 112
def split_activity_code(activity_code):
    """Split the specified activity code into its parts.

    :returns: A list of activity code parts.
    """
    return activity_code.split(activity_code_separator)


113 114
class ActivityModel(TimeStampedModel):
    activity_code = CharField(max_length=100, verbose_name=_('activity code'))
115 116 117 118
    readable_name_data = JSONField(blank=True, null=True,
                                   verbose_name=_('human readable name'),
                                   help_text=_('Human readable name of '
                                               'activity.'))
119
    parent = ForeignKey('self', blank=True, null=True, related_name='children')
120 121 122 123 124 125 126 127 128 129 130
    task_uuid = CharField(blank=True, max_length=50, null=True, unique=True,
                          help_text=_('Celery task unique identifier.'),
                          verbose_name=_('task_uuid'))
    user = ForeignKey(User, blank=True, null=True, verbose_name=_('user'),
                      help_text=_('The person who started this activity.'))
    started = DateTimeField(verbose_name=_('started at'),
                            blank=True, null=True,
                            help_text=_('Time of activity initiation.'))
    finished = DateTimeField(verbose_name=_('finished at'),
                             blank=True, null=True,
                             help_text=_('Time of activity finalization.'))
131 132 133
    succeeded = NullBooleanField(blank=True, null=True,
                                 help_text=_('True, if the activity has '
                                             'finished successfully.'))
134 135
    result_data = JSONField(verbose_name=_('result'), blank=True, null=True,
                            help_text=_('Human readable result of activity.'))
136

137 138 139 140 141 142
    def __unicode__(self):
        if self.parent:
            return self.parent.activity_code + "->" + self.activity_code
        else:
            return self.activity_code

143 144 145
    class Meta:
        abstract = True

146
    def finish(self, succeeded, result=None, event_handler=None):
147 148
        if not self.finished:
            self.finished = timezone.now()
149
            self.succeeded = succeeded
150 151
            if result is not None:
                self.result = result
152 153
            if event_handler is not None:
                event_handler(self)
154
            self.save()
155

156 157 158 159 160 161 162 163
    @property
    def has_succeeded(self):
        return self.finished and self.succeeded

    @property
    def has_failed(self):
        return self.finished and not self.succeeded

164
    @property
165 166 167 168
    def readable_name(self):
        return HumanReadableObject.from_dict(self.readable_name_data)

    @readable_name.setter
Dudás Ádám committed
169
    def readable_name(self, value):
170 171 172
        self.readable_name_data = None if value is None else value.to_dict()

    @property
173 174 175 176
    def result(self):
        return HumanReadableObject.from_dict(self.result_data)

    @result.setter
Dudás Ádám committed
177
    def result(self, value):
178 179
        if isinstance(value, basestring):
            warn("Using string as result value is deprecated. Use "
180 181
                 "HumanReadableObject instead.",
                 DeprecationWarning, stacklevel=2)
182 183 184
            value = create_readable(user_text_template="",
                                    admin_text_template=value)

185 186
        self.result_data = None if value is None else value.to_dict()

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

def method_cache(memcached_seconds=60, instance_seconds=5):  # noqa
    """Cache return value of decorated method to memcached and memory.

    :param memcached_seconds: Invalidate memcached results after this time.
    :param instance_seconds: Invalidate results cached to static memory after
    this time.

    If a result is cached on instance, return that first.  If that fails, check
    memcached. If all else fails, run the method and cache on instance and in
    memcached.

    Do not use for methods with side effects.
    Instances are hashed by their id attribute, args by their unicode
    representation.

    ** NOTE: Methods that return None are always "recached".
    Based on https://djangosnippets.org/snippets/2477/
    """

    def inner_cache(method):

        def get_key(instance, *args, **kwargs):
            return sha224(unicode(method.__module__) +
                          unicode(method.__name__) +
                          unicode(instance.id) +
                          unicode(args) +
                          unicode(kwargs)).hexdigest()

        def x(instance, *args, **kwargs):
            invalidate = kwargs.pop('invalidate_cache', False)
            now = time()
            key = get_key(instance, *args, **kwargs)

            result = None
            try:
                vals = getattr(instance, key)
            except AttributeError:
                pass
            else:
                if vals['time'] + instance_seconds > now:
                    # has valid on class cache, return that
                    result = vals['value']

            if result is None:
                result = cache.get(key)

            if invalidate or (result is None):
                # all caches failed, call the actual method
                result = method(instance, *args, **kwargs)
                # save to memcache and class attr
                cache.set(key, result, memcached_seconds)
                setattr(instance, key, {'time': now, 'value': result})
240 241 242
                logger.debug('Value of <%s>.%s(%s)=<%s> saved to cache.',
                             unicode(instance), method.__name__,
                             unicode(args), unicode(result))
243 244 245 246 247

            return result
        return x

    return inner_cache
Őry Máté committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281


class HumanSortField(CharField):
    """
    A CharField that monitors another field on the same model and sets itself
    to a normalized value, which can be used for sensible lexicographycal
    sorting for fields containing numerals. (Avoiding technically correct
    orderings like [a1, a10, a2], which can be annoying for file or host
    names.)

    Apart from CharField's default arguments, an argument is requered:
        - monitor   sets the base field, whose value is normalized.
        - maximum_number_length    can also be provided, and defaults to 4. If
        you have to sort values containing numbers greater than 9999, you
        should increase it.

    Code is based on carljm's django-model-utils.
    """
    def __init__(self, *args, **kwargs):
        logger.debug('Initing HumanSortField(%s %s)',
                     unicode(args), unicode(kwargs))
        kwargs.setdefault('default', "")
        self.maximum_number_length = kwargs.pop('maximum_number_length', 4)
        monitor = kwargs.pop('monitor', None)
        if not monitor:
            raise TypeError(
                '%s requires a "monitor" argument' % self.__class__.__name__)
        self.monitor = monitor
        kwargs['blank'] = True
        super(HumanSortField, self).__init__(*args, **kwargs)

    def get_monitored_value(self, instance):
        return getattr(instance, self.monitor)

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
    @staticmethod
    def _partition(s, pred):
        """Partition a deque of chars to a tuple of a
           - string of the longest prefix matching pred,
           - string of the longest prefix after the former one not matching,
           - deque of the remaining characters.

           >>> HumanSortField._partition(deque("1234abc567"),
           ...                           lambda s: s.isdigit())
           ('1234', 'abc', deque(['5', '6', '7']))
           >>> HumanSortField._partition(deque("12ab"), lambda s: s.isalpha())
           ('', '12', deque(['a', 'b']))
        """
        match, notmatch = deque(), deque()
        while s and pred(s[0]):
            match.append(s.popleft())
        while s and not pred(s[0]):
            notmatch.append(s.popleft())
        return (''.join(match), ''.join(notmatch), s)
Őry Máté committed
301

302
    def get_normalized_value(self, val):
Őry Máté committed
303 304 305 306
        logger.debug('Normalizing value: %s', val)
        norm = ""
        val = deque(val)
        while val:
307 308 309 310
            numbers, letters, val = self._partition(val,
                                                    lambda s: s[0].isdigit())
            if numbers:
                norm += numbers.rjust(self.maximum_number_length, '0')
Őry Máté committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
            norm += letters
        logger.debug('Normalized value: %s', norm)
        return norm

    def pre_save(self, model_instance, add):
        logger.debug('Pre-saving %s.%s. %s',
                     model_instance, self.attname, add)
        value = self.get_normalized_value(
            self.get_monitored_value(model_instance))
        setattr(model_instance, self.attname, value[:self.max_length])
        return super(HumanSortField, self).pre_save(model_instance, add)

# allow South to handle these fields smoothly
try:
    from south.modelsinspector import add_introspection_rules
    add_introspection_rules(rules=[
        (
            (HumanSortField,),
            [],
            {'monitor': ('monitor', {}),
             'maximum_number_length': ('maximum_number_length', {}), }
        ),
    ], patterns=['common\.models\.'])
except ImportError:
    pass
336 337 338 339 340 341 342 343 344


class HumanReadableObject(object):
    def __init__(self, user_text_template, admin_text_template, params):
        self.user_text_template = user_text_template
        self.admin_text_template = admin_text_template
        self.params = params

    @classmethod
345 346 347
    def create(cls, user_text_template, admin_text_template=None, **params):
        return cls(user_text_template,
                   admin_text_template or user_text_template, params)
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364

    @classmethod
    def from_dict(cls, d):
        return None if d is None else cls(**d)

    def get_admin_text(self):
        return _(self.admin_text_template) % self.params

    def get_user_text(self):
        return _(self.user_text_template) % self.params

    def to_dict(self):
        return {"user_text_template": self.user_text_template,
                "admin_text_template": self.admin_text_template,
                "params": self.params}

create_readable = HumanReadableObject.create