models.py

# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is l10n django site.
#
# The Initial Developer of the Original Code is
# Mozilla Foundation.
# Portions created by the Initial Developer are Copyright (C) 2010
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
#
# Alternatively, the contents of this file may be used under the terms of
# either the GNU General Public License Version 2 or later (the "GPL"), or
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
#
# ***** END LICENSE BLOCK *****

'''Models for compare-locales statistics.
'''

from django.db import models
from life.models import Locale, Tree, Changeset
from mbdb.models import Build


class ModuleCount(models.Model):
    """Abstraction of untranslated strings per module.

    Module is usually something like 'browser' or 'security/manager'
    """
    name = models.CharField(max_length=50)
    count = models.IntegerField()

    def __unicode__(self):
        return self.name + '(%d)' % self.count

'''
class Revision(models.Model):
    repository = models.ForeignKey(Repository, related_name='revisions',
                                   db_index=True)
    ident = models.CharField(max_length=40, db_index=True)
    class Meta:
        unique_together = (('repository', 'ident'),)
'''


class Run(models.Model):
    """Abstraction for a inspect-locales run.
    """
    cleanupUnchanged = True

    locale = models.ForeignKey(Locale, db_index=True)
    tree = models.ForeignKey(Tree, db_index=True)
    build = models.OneToOneField(Build, null=True, blank=True)
    srctime = models.DateTimeField(db_index=True, null=True, blank=True)
    unchangedmodules = models.ManyToManyField(ModuleCount, related_name='runs')
    revisions = models.ManyToManyField(Changeset)
    missing = models.IntegerField(default=0)
    missingInFiles = models.IntegerField(default=0)
    obsolete = models.IntegerField(default=0)
    total = models.IntegerField(default=0)
    changed = models.IntegerField(default=0)
    unchanged = models.IntegerField(default=0)
    keys = models.IntegerField(default=0)
    errors = models.IntegerField(default=0)
    report = models.IntegerField(default=0)
    warnings = models.IntegerField(default=0)
    completion = models.SmallIntegerField(default=0)

    @property
    def allmissing(self):
        """property adding missing and missingInFiles to be used in templates
        etc.

        We keep track of missing strings in existing files and in new files
        separetely, add the two for the most stats here.
        """
        return self.missing + self.missingInFiles

    def activate(self):
        previous = Active.objects.filter(run__tree=self.tree,
                                         run__locale=self.locale)
        previousl = list(previous)
        if len(previousl) == 1:
            previousl[0].run = self
            previousl[0].save()
        else:
            if previousl:
                previous.delete()
            Active.objects.create(run=self)
        if self.cleanupUnchanged:
            (UnchangedInFile.objects.filter(run__active__isnull=True)
             .distinct().delete())

    # fields and class method to convert a query over runs to a brief text
    dfields = ['errors', 'missing', 'missingInFiles',
               'obsolete',
               'completion']

    @classmethod
    def to_class_string(cls, iterable, prefix=''):
        """Convert an iterable list of dictionaries to brief output, and
        result.

        The input can be a values() query ending up on Run objects, and needs
        all the fields in dfields. The given prefix can be used if the
        Runs are not the primary manager.

        Yields triples of the input dictionary, the short text, and a
        classification, any of "error", "warnings", or "success".
        """
        for d in iterable:
            cmp_segs = []
            cls = None
            if d[prefix + 'errors']:
                cmp_segs.append('%d error(s)' % d[prefix + 'errors'])
                cls = 'failure'
            missing = d[prefix + 'missing'] + d[prefix + 'missingInFiles']
            if missing:
                cmp_segs.append('%d missing' % missing)
                cls = 'failure'
            if d[prefix + 'obsolete']:
                cmp_segs.append('%d obsolete' % d[prefix + 'obsolete'])
                cls = cls is None and 'warnings' or cls
            if cmp_segs:
                compare = ', '.join(cmp_segs)
            else:
                compare = 'green (%d%%)' % d[prefix + 'completion']
                cls = 'success'
            yield (d, cls, compare)


class Run_Revisions(models.Model):
    """Helper model for queries on run.revisions.

    The model doesn't alter the schema and is set up such that it
    can be used to create rich queries on Run/Changeset mappings.
    """
    run = models.ForeignKey(Run)
    changeset = models.ForeignKey(Changeset)

    class Meta:
        unique_together = (('run', 'changeset'),)
        managed = False


class UnchangedInFile(models.Model):
    """Abstraction for untranslated count per file.
    """
    module = models.CharField(max_length=50, db_index=True)
    file = models.CharField(max_length=400, db_index=True)
    count = models.IntegerField(db_index=True)
    run = models.ForeignKey(Run)

    def __unicode__(self):
        return "%s/%s: %d" % (self.module, self.file, self.count)


class Active(models.Model):
    """Keep track of the currently active Runs.
    """
    run = models.OneToOneField(Run)