source: products/quintagroup.analytics/trunk/quintagroup/analytics/browser/views.py @ 3666

from Acquisition import aq_base
from zope.component import getUtility, getMultiAdapter, queryMultiAdapter

from OFS.interfaces import IPropertyManager
from Products.Five.browser import BrowserView
from Products.CMFCore.utils import getToolByName
from Products.CMFCore.interfaces import IFolderish
from Products.Archetypes.interfaces import IBaseFolder
try:
    from plone.portlets.interfaces import IPortletManager
    from plone.portlets.interfaces import IPortletAssignmentMapping
    from plone.portlets.interfaces import ILocalPortletAssignmentManager
    IPortletManager  # pyflakes
    IPortletAssignmentMapping  # pyflakes
    ILocalPortletAssignmentManager  # pyflakes
except ImportError:
    IPortletManager = lambda assignment: {}
    IPortletAssignmentMapping = lambda assignment: {}
    ILocalPortletAssignmentManager = lambda assignment: {}
try:
    from plone.portlets.interfaces import IPortletAssignmentSettings
    IPortletAssignmentSettings  # pyflakes
except ImportError:
    # Before plon4 we don't have an annotation storage for settings.
    IPortletAssignmentSettings = lambda assignment: {}

from GChartWrapper import VerticalBarStack
from quintagroup.analytics.config import COLORS, OTHER_TYPES, NO_WF_BIND
from quintagroup.analytics import QuintagroupAnalyticsMessageFactory as _

MENUEITEMS = [{'href': 'qa_overview', 'content': _('Overview')},
              {'href': 'ownership_by_type', 'content': _('Ownership by type')},
              {'href': 'ownership_by_state', 'content': _(
                  'Ownership by state')},
              {'href': 'type_by_state', 'content': _('Types by state')},
              {'href': 'portlets_stats', 'content': _('Portlets stats')},
              {'href': 'legacy_portlets', 'content': _('Legacy portlets')},
              {'href': 'properties_stats', 'content': _('Properties stats')}]


class AnalyticsBaseView(BrowserView):
    def analiticsNavigation(self):
        return MENUEITEMS


class OwnershipByType(AnalyticsBaseView):
    MAX = 10

    def __init__(self, context, request):
        self.context = context
        self.request = request
        self.cat = getToolByName(self.context, 'portal_catalog')
        self.users = None
        self.total = None
        self.types = None
        self.data = {}

    def getUsers(self):
        if self.users is None:
            index = self.cat._catalog.getIndex('Creator')
            data = {}
            for k in index._index.keys():
                haslen = hasattr(index._index[k], '__len__')
                if haslen:
                    data[k] = len(index._index[k])
                else:
                    data[k] = 1
            data = data.items()
            data.sort(lambda a, b: a[1] - b[1])
            data.reverse()
            data = data[:self.MAX]
            self.users = [i[0] for i in data]
            self.total = [i[1] for i in data]
        return self.users

    def getTypes(self, all=False):
        if self.types is None:
            index = self.cat._catalog.getIndex('portal_type')
            data = {}
            for k in index._index.keys():
                if not k:
                    continue
                haslen = hasattr(index._index[k], '__len__')
                if haslen:
                    data[k] = len(index._index[k])
                else:
                    data[k] = 1
            data = data.items()
            data.sort(lambda a, b: a[1] - b[1])
            data.reverse()
            self.types = [i[0] for i in data]
        return all and self.types or self.types[:self.MAX]

    def getContent(self, type_):
        if type_ not in self.data:
            data = self.data[type_] = []
            for user in self.getUsers():
                res = self.cat(portal_type=type_, Creator=user)
                l = len(res)
                if l == 0:
                    data.append(0)
                else:
                    data.append(l)
        return self.data[type_]

    def getTotal(self):
        return self.total

    def getChart(self):
        data = []
        types = self.getTypes()
        for type_ in types:
            data.append(self.getContent(type_))
        other = [self.getContent(t) for t in self.getTypes(
            all=True)[self.MAX:]]
        if other:
            data.append([sum(l) for l in zip(*other)])
        max_value = max(self.getTotal())
        chart = VerticalBarStack(data, encoding='text')
        types = other and types + OTHER_TYPES or types
        chart.title(_('Content ownership by type')).legend(*(types))
        chart.bar('a', 10, 0).legend_pos("b")
        chart.color(*COLORS)
        chart.size(800, 375).scale(0, max_value).axes('xy').label(*self.users)
        chart.axes.type("y")
        chart.axes.range(0, 0, max_value)
        return chart.img()


class OwnershipByState(AnalyticsBaseView):
    MAX = 10

    def __init__(self, context, request):
        self.context = context
        self.request = request
        self.cat = getToolByName(self.context, 'portal_catalog')
        self.users = None
        self.states = None
        self.total = None
        self.data = {}

    def getUsers(self):
        if self.users is None:
            index = self.cat._catalog.getIndex('Creator')
            data = {}
            for k in index._index.keys():
                haslen = hasattr(index._index[k], '__len__')
                if haslen:
                    data[k] = len(index._index[k])
                else:
                    data[k] = 1
            data = data.items()
            data.sort(lambda a, b: a[1] - b[1])
            data.reverse()
            data = data[:self.MAX]
            self.users = [i[0] for i in data]
            self.total = [i[1] for i in data]
        return self.users

    def getStates(self):
        if self.states is None:
            index = self.cat._catalog.getIndex('review_state')
            data = {}
            for k in index._index.keys():
                haslen = hasattr(index._index[k], '__len__')
                if haslen:
                    data[k] = len(index._index[k])

                else:
                    data[k] = 1

            data = data.items()
            data.sort(lambda a, b: a[1] - b[1])
            data.reverse()
            self.states = [i[0] for i in data]
        return self.states

    def getContent(self, type_):
        if type_ not in self.data:
            if NO_WF_BIND not in self.data:
                self.data[NO_WF_BIND] = self.getTotal()
            data = self.data[type_] = []
            for user in self.getUsers():
                res = self.cat(review_state=type_, Creator=user)
                l = len(res)
                if l == 0:
                    data.append(0)
                else:
                    data.append(l)
            if len(data) > 0:
                self.data[NO_WF_BIND] = map(lambda t, d: t - d,
                                            self.data[NO_WF_BIND], data)
        return self.data[type_]

    def getNoWFContentTitle(self):
        return NO_WF_BIND

    def getNoWFContent(self):
        return self.getContent(NO_WF_BIND)

    def getTotal(self):
        if self.total is None:
            self.getUsers()
        return self.total

    def getChart(self):
        data = []
        for state in self.getStates():
            data.append(self.getContent(state))
        data.append(self.getNoWFContent())
        max_value = max(self.getTotal())
        chart = VerticalBarStack(data, encoding='text')
        title = _('Content ownership by state')
        chart.title(title).legend(*self.states + [NO_WF_BIND])
        chart.bar('a', 10, 0).legend_pos("b")
        chart.color(*COLORS)
        chart.size(800, 375).scale(0, max_value).axes('xy').label(*self.users)
        chart.axes.type("y")
        chart.axes.range(0, 0, max_value)
        return chart.img()


class TypeByState(AnalyticsBaseView):
    MAX = 10

    def __init__(self, context, request):
        self.context = context
        self.request = request
        self.cat = getToolByName(self.context, 'portal_catalog')
        self.types = None
        self.states = None
        self.total = None
        self.data = {}

    def getTypes(self):
        if self.types is None:
            index = self.cat._catalog.getIndex('portal_type')
            data = {}
            for k in index._index.keys():
                if not k:
                    continue
                haslen = hasattr(index._index[k], '__len__')
                if haslen:
                    data[k] = len(index._index[k])
                else:
                    data[k] = 1
            data = data.items()
            data.sort(lambda a, b: a[1] - b[1])
            data.reverse()
            self.types = [i[0] for i in data[:self.MAX]]
            self.total = [i[1] for i in data[:self.MAX]]
        return self.types

    def getStates(self):
        if self.states is None:
            index = self.cat._catalog.getIndex('review_state')
            data = {}
            for k in index._index.keys():
                haslen = hasattr(index._index[k], '__len__')
                if haslen:
                    data[k] = len(index._index[k])
                else:
                    data[k] = 1
            data = data.items()
            data.sort(lambda a, b: a[1] - b[1])
            data.reverse()
            self.states = [i[0] for i in data]
        return self.states

    def getContent(self, state):
        if state not in self.data:
            if NO_WF_BIND not in self.data:
                self.data[NO_WF_BIND] = self.getTotal()
            data = self.data[state] = []
            for type_ in self.getTypes():
                res = self.cat(portal_type=type_, review_state=state)
                l = len(res)
                if l == 0:
                    data.append(0)
                else:
                    data.append(l)
            if len(data) > 0:
                self.data[NO_WF_BIND] = map(lambda t, d: t - d,
                                            self.data[NO_WF_BIND], data)
        return self.data[state]

    def getTotal(self):
        if self.total is None:
            self.getTypes()
        return self.total

    def getNoWFContentTitle(self):
        return NO_WF_BIND

    def getNoWFContent(self):
        return self.getContent(NO_WF_BIND)

    def getChart(self):
        data = []
        for state in self.getStates():
            data.append(self.getContent(state))
        data.append(self.getContent(NO_WF_BIND))
        max_value = max(self.getTotal())
        chart = VerticalBarStack(data, encoding='text')
        chart.title(_('Content type by state')).legend(
            *self.states + [NO_WF_BIND])
        chart.bar('a', 10, 0).legend_pos("b")
        chart.color(*COLORS)
        chart.size(800, 375).scale(0, max_value).axes('xy').label(*self.types)
        chart.axes.type("y")
        chart.axes.range(0, 0, max_value)
        return chart.img()


class LegacyPortlets(AnalyticsBaseView):
    def __init__(self, context, request):
        self.context = context
        self.request = request
        self.total = None
        self.DEBUG = False
        self.expressions = set()

    def _getInfo(self, obj):
        href = obj.absolute_url()
        path = '/'.join(obj.getPhysicalPath())
        info = {
            'path': path,
            'href': href,
            'left_slots': None,
            'right_slots': None,
        }
        if IPropertyManager.providedBy(obj):
            obj = aq_base(obj)
            if obj.hasProperty('left_slots'):
                info['left_slots'] = obj.getProperty('left_slots')
                self.expressions = self.expressions.union(
                    set(info['left_slots']))
            if obj.hasProperty('right_slots'):
                info['right_slots'] = obj.getProperty('right_slots')
                self.expressions = self.expressions.union(
                    set(info['right_slots']))
        return info

    def _walk(self, obj, level=-1):
        yield self._getInfo(obj)
        if level != 0 and (IFolderish.providedBy(obj)
                           or IBaseFolder.providedBy(obj)):
            for v in obj.contentValues():
                for i in self._walk(v, level - 1):
                    yield i

    def getPortlets(self):
        level = self.request.form.get('level', 1)
        try:
            level = level and int(level) or 1
        except ValueError:
            level = 1
        infos = []
        for i in self._walk(self.context, level):
            if self.DEBUG or i['left_slots'] is not None \
                    or i['right_slots'] is not None:
                infos.append(i)
        self.total = len(infos)
        return infos

    def getTotal(self):
        return self.total

    def getAllPortletExpressions(self):
        exprs = []
        for name in self.expressions:
            name = name.split('|')[0]
            if not '/macros/' in name:
                name = name.split('/')[-1]
            name = name.strip()
            if name not in exprs:
                exprs.append(name)
        exprs.sort()
        return exprs


class PropertiesStats(AnalyticsBaseView):
    def __init__(self, context, request):
        self.context = context
        self.request = request
        self.total = None
        self.DEBUG = False
        self.expressions = set()
        self.proplist = []
        self.propname = self.request.form.get('propname') or ""

    def _getInfo(self, obj):

        href = obj.absolute_url()
        path = '/'.join(obj.getPhysicalPath())
        info = {
            'path': path,
            'href': href,
            'slots': None,
        }
        if IPropertyManager.providedBy(obj):
            obj = aq_base(obj)
            self.proplist.extend(
                [i for i in obj.propertyIds() if i not in self.proplist])
            if obj.hasProperty(self.propname):
                info['slots'] = obj.getProperty(self.propname)
                if isinstance(info['slots'], int):
                    info['slots'] = str(info['slots'])
                if not isinstance(info['slots'], basestring):
                    self.expressions = self.expressions.union(
                        set(info['slots']))
                else:
                    self.expressions = self.expressions.union(
                        set([info['slots']]))
        return info

    def _walk(self, obj, level=-1):
        yield self._getInfo(obj)
        if level != 0 and (IFolderish.providedBy(obj)
                           or IBaseFolder.providedBy(obj)):
            for v in obj.contentValues():
                for i in self._walk(v, level - 1):
                    yield i

    def getPropsList(self):
        level = self.request.form.get('level', 1)
        try:
            level = level and int(level) or 1
        except ValueError:
            level = 1
        infos = []
        for i in self._walk(self.context, level):
            if self.DEBUG or i['slots'] is not None:
                infos.append(i)
        self.total = len(infos)
        return infos

    def getTotal(self):
        return self.total

    def getAllPortletExpressions(self):
        exprs = []
        for name in self.expressions:
            name = name.strip()
            if name not in exprs:
                exprs.append(name)
        # exprs.sort()
        return exprs


class PortletsStats(AnalyticsBaseView):
    def __init__(self, context, request):
        self.context = context
        self.request = request
        self.total = None
        self.DEBUG = False
        self.expressions = set()
        self.proplist = []
        self.propname = self.request.form.get('propname') or ""

    def getAssignmentMappingUrl(self, context, manager):
        baseUrl = str(getMultiAdapter((context, self.request),
                                      name='absolute_url'))
        return '%s/++contextportlets++%s' % (baseUrl, manager.__name__)

    def getAssignmentsForManager(self, context, manager):
        assignments = getMultiAdapter((context, manager),
                                      IPortletAssignmentMapping)
        return assignments.values()

    def getPortletsMapping(self, context):
        leftcolumn = getUtility(IPortletManager, name=u'plone.leftcolumn',
                                context=context)
        rightcolumn = getUtility(IPortletManager, name=u'plone.rightcolumn',
                                 context=context)
        leftmapping = getMultiAdapter((context, leftcolumn,),
                                      IPortletAssignmentMapping)
        rightmapping = getMultiAdapter((context, rightcolumn,),
                                       IPortletAssignmentMapping)
        return (leftmapping, rightmapping)

    def getLocalPortletsManager(self, context):
        leftcolumn = getUtility(IPortletManager, name='plone.leftcolumn',
                                context=context)
        rightcolumn = getUtility(IPortletManager, name='plone.rightcolumn',
                                 context=context)
        leftmanager = getMultiAdapter((context, leftcolumn,),
                                      ILocalPortletAssignmentManager)
        rightmanager = getMultiAdapter((context, rightcolumn,),
                                       ILocalPortletAssignmentManager)
        return (leftmanager, rightmanager)

    def getPortletsManager(self, context):
        left = getUtility(IPortletManager, name='plone.leftcolumn',
                          context=context)
        right = getUtility(IPortletManager, name='plone.rightcolumn',
                           context=context)
        return (left, right)

    def portlets_for_assignments(self, assignments, manager, base_url):
        data = []
        for idx in range(len(assignments)):
            name = assignments[idx].__name__

            editview = queryMultiAdapter(
                (assignments[idx], self.request), name='edit', default=None)

            if editview is None:
                editviewName = ''
            else:
                editviewName = '%s/%s/edit' % (base_url, name)

            settings = IPortletAssignmentSettings(assignments[idx])

            data.append({
                'title': assignments[idx].title,
                'editview': editviewName,
                'visible': settings.get('visible', True),
            })
        return data

    def getPortlets(self, context, mapping, manager):
        # import pdb; pdb.set_trace()
        return mapping.keys()

    def _getInfo(self, obj):
        href = obj.absolute_url()
        path = '/'.join(obj.getPhysicalPath())
        info = {
            'path': path,
            'href': href,
            'left_slots': None,
            'right_slots': None,
        }
        left, right = self.getPortletsManager(obj)
        # leftmapping, rightmapping = self.getPortletsMapping(obj)
        # leftmanager, rightmanager = self.getLocalPortletsManager(obj)
        # info['left_slots'] = self.getPortlets(obj, leftmapping, leftmanager)
        # info['right_slots'] = self.getPortlets(obj,
        # rightmapping,rightmanager)
        lass = self.getAssignmentsForManager(obj, left)
        rass = self.getAssignmentsForManager(obj, right)
        lurl = self.getAssignmentMappingUrl(obj, left)
        rurl = self.getAssignmentMappingUrl(obj, right)
        plass = self.portlets_for_assignments(lass, left, lurl)
        prass = self.portlets_for_assignments(rass, right, rurl)
        # print obj, plass, prass
        info['left_slots'] = plass  # [i['title'] for i in plass]
        info['right_slots'] = prass  # [i['title'] for i in prass]
        return info

    def _walk(self, obj, level=-1):
        try:
            yield self._getInfo(obj)
        except:
            pass
        if level != 0 and (IFolderish.providedBy(obj)
                           or IBaseFolder.providedBy(obj)):
            for v in obj.contentValues():
                for i in self._walk(v, level - 1):
                    yield i

    def getPropsList(self):
        level = self.request.form.get('level', 1)
        try:
            level = level and int(level) or 1
        except ValueError:
            level = 1
        infos = []
        for i in self._walk(self.context, level):
            if self.DEBUG or i['left_slots'] is not None \
                    or i['right_slots'] is not None:
                infos.append(i)
        self.total = len(infos)
        return infos

    def getTotal(self):
        return self.total

    def getAllPortletExpressions(self):
        exprs = []
        for name in self.expressions:
            name = name.strip()
            if name not in exprs:
                exprs.append(name)
        # exprs.sort()
        return exprs