bika.lims.browser.log

Complexity

Total Complexity

18

Size/Duplication

Total Lines	157
Duplicated Lines	8.92 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	LogView.get_entry_date()	0	5	1
A	LogView.update()	0	5	1
A	LogView.get_entry_action()	0	12	2
A	LogView.get_entry_version()	0	5	1
A	LogView.get_entry_actor()	0	10	3
A	LogView.folderitems()	0	9	2
A	LogView.get_review_history()	0	4	1
A	LogView.get_full_history()	0	7	3
A	LogView.make_log_entry()	0	11	1
A	LogView.make_empty_item()	14	14	1
A	LogView.__init__()	0	32	1
A	LogView.get_revision_history()	0	5	1

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE
#
# Copyright 2018 by it's authors.
# Some rights reserved. See LICENSE.rst, CONTRIBUTORS.rst.

import collections

from bika.lims import api
from bika.lims import bikaMessageFactory as _
from bika.lims.browser.bika_listing import BikaListingView
from plone.memoize import view
from DateTime import DateTime
from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
from plone.app.layout.viewlets.content import ContentHistoryView


class LogView(BikaListingView):
    """Review/Revision log view
    """

    template = ViewPageTemplateFile("templates/log.pt")

    def __init__(self, context, request):
        super(LogView, self).__init__(context, request)

        self.show_select_column = False
        self.pagesize = 999999
        self.show_search = False

        self.icon = "{}/{}/{}".format(
            self.portal_url,
            "++resource++bika.lims.images",
            "%s_big.png" % context.portal_type.lower(),
        )

        self.title = "{} Log".format(api.get_title(context))

        self.columns = collections.OrderedDict((
            ("Version", {
                "title": _("Version"), "sortable": False}),
            ("Date", {
                "title": _("Date"), "sortable": False}),
            ("Actor", {
                "title": _("Actor"), "sortable": False}),
            ("Action", {
                "title": _("Action"), "sortable": False}),
        ))

        self.review_states = [
            {
                "id": "default",
                "title": "All",
                "contentFilter": {},
                "columns": self.columns.keys(),
            }
        ]

    def update(self):
        """Update hook
        """
        super(LogView, self).update()
        self.total = len(self.get_full_history())

    def get_revision_history(self):
        """Return the revision history of the current context
        """
        chv = ContentHistoryView(self.context, self.request)
        return chv.revisionHistory()

    def get_review_history(self):
        """Return the review history of the current context
        """
        return api.get_review_history(self.context)

    @view.memoize
    def get_full_history(self):
        history = self.get_revision_history() + self.get_review_history()
        if len(history) == 0:
            return []
        history.sort(key=lambda x: x["time"], reverse=True)
        return history

    def get_entry_version(self, entry, default=0):
        """Return the version of the entry
        """
        version = entry.get("version_id", default) or default
        return version

    def get_entry_date(self, entry):
        """Return the action date
        """
        date = DateTime(entry.get("time"))
        return self.ulocalized_time(date, long_format=1),

    def get_entry_actor(self, entry):
        """Return the fullname of the actor
        """
        actor = entry.get("actor")
        if isinstance(actor, basestring):
            actor = api.get_user_properties(actor) or dict(actorid=actor)
        fullname = actor.get("fullname")
        if not fullname:
            return actor.get("actorid")
        return actor.get("fullname")

    def get_entry_action(self, entry):
        """Return the action
        """
        # revision entries have a transition_title
        transition_title = entry.get("transition_title")
        if transition_title:
            return transition_title
        # review history items have only an action
        action = entry.get("action") or "Created"
        # make the action human readable
        action = action.capitalize().replace("_", " ")
        return _(action)

    def make_empty_item(self, **kw):

This code seems to be duplicated in your project.

        """Create a new empty item
        """
        item = {
            "uid": None,
            "before": {},
            "after": {},
            "replace": {},
            "allow_edit": [],
            "disabled": False,
            "state_class": "state-active",
        }
        item.update(**kw)
        return item

    def make_log_entry(self, entry, index):
        """Create a log entry
        """
        item = self.make_empty_item(**entry)

        item["Version"] = self.get_entry_version(entry)
        item["Date"] = self.get_entry_date(entry)
        item["Actor"] = self.get_entry_actor(entry)
        item["Action"] = self.get_entry_action(entry)

        return item

    def folderitems(self):
        """Generate folderitems for each review history item
        """
        items = []

        history = self.get_full_history()
        for num, entry in enumerate(history):
            items.append(self.make_log_entry(entry, num))
        return items