loops/expert/browser/report.py

#
#  Copyright (c) 2011 Helmut Merz helmutm@cy55.de
#
#  This program 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 2 of the License, or
#  (at your option) any later version.
#
#  This program 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 this program; if not, write to the Free Software
#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#

"""
View classes for reporting.
"""

from urllib import urlencode
from zope import interface, component
from zope.app.pagetemplate import ViewPageTemplateFile
from zope.cachedescriptors.property import Lazy
from zope.traversing.api import getName, getParent

from cybertools.browser.form import FormController
from loops.browser.concept import ConceptView
from loops.browser.node import NodeView
from loops.common import adapted, AdapterBase
from loops.expert.report import IReportInstance
from loops.organize.personal.browser.filter import FilterView
from loops.security.common import canWriteObject, checkPermission
from loops import util
from loops.util import _


report_template = ViewPageTemplateFile('report.pt')
results_template = ViewPageTemplateFile('results.pt')


class ReportView(ConceptView):
    """ A view for defining (editing) a report.
    """

    @Lazy
    def report_macros(self):
        return self.controller.getTemplateMacros('report', report_template)

    @Lazy
    def macro(self):
        return self.report_macros['main']

    @Lazy
    def dynamicParams(self):
        return self.request.form


class ResultsView(NodeView):

    @Lazy
    def result_macros(self):
        return self.controller.getTemplateMacros('results', results_template)

    @Lazy
    def macro(self):
        return self.result_macros['main']

    @Lazy
    def item(self):
        return self

    @Lazy
    def params(self):
        params = dict(self.request.form)
        params = self.parseParams(params)
        return params

    def parseParams(self, params):
        params.pop('report_execute', None)
        if 'limits' in params:
            params['limits'] = self.parseLimitsParam(params['limits'])
        return params

    def parseLimitsParam(self, value):
        if not value:
            return None
        if isinstance(value, basestring):
            limits = value.split(',')
        else:
            limits = value
        if len(limits) < 2:
            limits.append(None)
        result = []
        for p in limits[:2]:
            if not p:
                result.append(None)
            else:
                result.append(int(p))
        return result

    @Lazy
    def report(self):
        return adapted(self.virtualTargetObject)

    @Lazy
    def reportInstance(self):
        instance = component.getAdapter(self.report, IReportInstance,
                                        name=self.report.reportType)
        instance.view = self
        return instance

    #@Lazy
    def results(self):
        return self.reportInstance.getResults(self.params)

    @Lazy
    def resultsRenderer(self):
        return self.reportInstance.getResultsRenderer('results', self.result_macros)

    @Lazy
    def reportUrl(self):
        url = self.virtualTargetUrl
        return '?'.join((url, urlencode(self.params)))

    @Lazy
    def displayedColumns(self):
        return self.reportInstance.getActiveOutputFields()

    def getColumnRenderer(self, col):
        return self.result_macros[col.renderer]


class ResultsConceptView(ConceptView):
    """ View on a concept using the results of a report.
    """

    reportName = None   # define in subclass if applicable
    reportType = None   # set for using special report instance adapter

    def __init__(self, context, request):
        super(ResultsConceptView, self).__init__(context, request)
        self.resultSets = {}    # storage for result sets from reports

    @Lazy
    def result_macros(self):
        return self.controller.getTemplateMacros('results', results_template)

    @Lazy
    def resultsRenderer(self):
        return self.reportInstance.getResultsRenderer(
                                        'results', self.result_macros)

    @Lazy
    def macro(self):
        return self.result_macros['content']

    @Lazy
    def hasReportPredicate(self):
        return self.conceptManager['hasreport']

    @Lazy
    def report(self):
        if self.reportName:
            return adapted(self.conceptManager[self.reportName])
        type = self.context.conceptType
        reports = type.getParents([self.hasReportPredicate])
        return adapted(reports[0])

    @Lazy
    def reportInstance(self):
        reportType = self.reportType or self.report.reportType
        ri = component.getAdapter(self.report, IReportInstance,
                                  name=reportType)
        ri.view = self
        return ri

    def results(self):
        res = self.reportInstance.getResults()
        self.resultSets[res.context.name] = res
        return res

    @Lazy
    def displayedColumns(self):
        return self.reportInstance.getActiveOutputFields()

    def getColumnRenderer(self, col):
        return self.result_macros[col.renderer]


class ReportConceptView(ResultsConceptView, ReportView):
    """ View on a concept using a report.
    """

    def setupController(self):
        super(ReportConceptView, self).setupController()
        self.registerDojoDateWidget()

    @Lazy
    def macro(self):
        return self.report_macros['main']

    @Lazy
    def queryFields(self):
        ri = self.reportInstance
        qf = ri.getAllQueryFields()
        if ri.userSettings:
            return [f for f in qf if f in ri.userSettings]
        return qf