build.bika.lims.controlpanel.auditlog.AuditLogView.folderitem() - Code Metrics - Inspection of "Audit log (#1324)" - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 804f45...1fa2c0 )

by Jordi

created 2019-04-22 21:47 UTC

AuditLogView.folderitem() A

↳ Parent: build.bika.lims.controlpanel.auditlog

Complexity

Conditions

Size

Total Lines	73
Code Lines	36

Duplication

Lines	11
Ratio	15.07 %

Importance

Changes

Metric	Value
eloc	36
dl	11
loc	73
rs	9.016
c	0
b	0
f	0
cc	3
nop	4

How to fix Long Method

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE.
#
# SENAITE.CORE 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, version 2.
#
# 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., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright 2018-2019 by it's authors.
# Some rights reserved, see README and LICENSE.

import collections

from bika.lims import api
from bika.lims import bikaMessageFactory as _
from bika.lims.api.snapshot import compare_snapshots
from bika.lims.api.snapshot import get_last_snapshot
from bika.lims.api.snapshot import get_snapshot_by_version
from bika.lims.api.snapshot import get_snapshot_metadata
from bika.lims.api.snapshot import get_snapshot_version
from bika.lims.browser.bika_listing import BikaListingView
from bika.lims.config import PROJECTNAME
from bika.lims.interfaces import IAuditLog
from bika.lims.utils import get_link
from plone.app.folder.folder import ATFolder
from plone.app.folder.folder import ATFolderSchema
from Products.Archetypes import atapi
from Products.ATContentTypes.content import schemata
from zope.interface.declarations import implements


class AuditLogView(BikaListingView):

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

        self.catalog = "auditlog_catalog"

        self.contentFilter = {
            "sort_on": "snapshot_created",
            "sort_order": "desscending",
        }

        self.context_actions = {}

        self.title = self.context.translate(_("Audit Log"))
        self.icon = "{}/{}".format(
            self.portal_url,
            "/++resource++bika.lims.images/auditlog_big.png"
        )

        self.show_select_column = False
        self.pagesize = 25

        self.columns = collections.OrderedDict((
            ("title", {
                "title": _("Title"),
                "index": "title"}),
            ("version", {
                "title": _("Version"),
                "index": "snapshot_version",
                "sortable": True}),
            ("modified", {
                "title": _("Date Modified"),
                "index": "modified",
                "sortable": True}),
            ("actor", {
                "title": _("Actor"),
                "index": "actor",
                "sortable": True}),
            ("fullname", {
                "title": _("Fullname"),
                "index": "fullname",
                "sortable": True}),
            ("roles", {
                "title": _("Roles"),
                "sortable": False,
                "toggle": False}),
            ("remote_address", {
                "title": _("Remote IP"),
                "sortable": True}),
            ("action", {
                "title": _("Action"),
                "index": "action",
                "sortable": True}),
            ("review_state", {
                "title": _("Workflow State"),
                "index": "review_state",
                "sortable": True}),
            ("diff", {
                "title": _("Changes"),
                "sortable": False}),
        ))

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

    def before_render(self):
        """Before template render hook
        """
        # Don't allow any context actions
        self.request.set("disable_border", 1)

    def folderitem(self, obj, item, index):
        """Service triggered each time an item is iterated in folderitems.
        The use of this service prevents the extra-loops in child objects.
        :obj: the instance of the class to be foldered
        :item: dict containing the properties of the object to be used by
            the template
        :index: current index of the item
        """

        # We are using the existing logic from the auditview
        logview = api.get_view("auditlog", context=obj, request=self.request)

        # get the last snapshot
        snapshot = get_last_snapshot(obj)
        # get the metadata of the last snapshot
        metadata = get_snapshot_metadata(snapshot)

        title = obj.Title()
        url = obj.absolute_url()
        auditlog_url = "{}/@@auditlog".format(url)

        # Title
        item["title"] = title
        # Link the title to the auditlog of the object
        item["replace"]["title"] = get_link(auditlog_url, value=title)

        # Version
        version = get_snapshot_version(obj, snapshot)
        item["version"] = version

        # Modification Date
        m_date = metadata.get("modified")
        item["modified"] = logview.to_localized_time(m_date)

        # Actor
        actor = metadata.get("actor")
        item["actor"] = actor

        # Fullname
        properties = api.get_user_properties(actor)
        item["fullname"] = properties.get("fullname", actor)

        # Roles
        roles = metadata.get("roles", [])
        item["roles"] = ", ".join(roles)

        # Remote Address
        remote_address = metadata.get("remote_address")
        item["remote_address"] = remote_address

        # Action
        action = metadata.get("action")
        item["action"] = logview.translate_state(action)

        # Review State
        review_state = metadata.get("review_state")
        item["review_state"] = logview.translate_state(review_state)

        # get the previous snapshot
        prev_snapshot = get_snapshot_by_version(obj, version-1)
        if prev_snapshot:

            prev_metadata = get_snapshot_metadata(prev_snapshot)
            prev_review_state = prev_metadata.get("review_state")
            if prev_review_state != review_state:
                item["replace"]["review_state"] = "{} &rarr; {}".format(
                    logview.translate_state(prev_review_state),
                    logview.translate_state(review_state))

            # Rendered Diff
            diff = compare_snapshots(snapshot, prev_snapshot)
            item["diff"] = logview.render_diff(diff)

        return item


schema = ATFolderSchema.copy()


class AuditLog(ATFolder):
    implements(IAuditLog)
    displayContentsTab = False
    schema = schema



schemata.finalizeATCTSchema(schema, folderish=True, moveDiscussion=False)
atapi.registerType(AuditLog, PROJECTNAME)


1		# -- coding: utf-8 --
2		#
3		# This file is part of SENAITE.CORE.
4		#
5		# SENAITE.CORE is free software: you can redistribute it and/or modify it under
6		# the terms of the GNU General Public License as published by the Free Software
7		# Foundation, version 2.
8		#
9		# This program is distributed in the hope that it will be useful, but WITHOUT
10		# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11		# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12		# details.
13		#
14		# You should have received a copy of the GNU General Public License along with
15		# this program; if not, write to the Free Software Foundation, Inc., 51
16		# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17		#
18		# Copyright 2018-2019 by it's authors.
19		# Some rights reserved, see README and LICENSE.
20
21		import collections
22
23		from bika.lims import api
24		from bika.lims import bikaMessageFactory as _
25		from bika.lims.api.snapshot import compare_snapshots
26		from bika.lims.api.snapshot import get_last_snapshot
27		from bika.lims.api.snapshot import get_snapshot_by_version
28		from bika.lims.api.snapshot import get_snapshot_metadata
29		from bika.lims.api.snapshot import get_snapshot_version
30		from bika.lims.browser.bika_listing import BikaListingView
31		from bika.lims.config import PROJECTNAME
32		from bika.lims.interfaces import IAuditLog
33		from bika.lims.utils import get_link
34		from plone.app.folder.folder import ATFolder
35		from plone.app.folder.folder import ATFolderSchema
36		from Products.Archetypes import atapi
37		from Products.ATContentTypes.content import schemata
38		from zope.interface.declarations import implements
39
40
41		class AuditLogView(BikaListingView):
42
43		def __init__(self, context, request):
44		super(AuditLogView, self).__init__(context, request)
45
46		self.catalog = "auditlog_catalog"
47
48		self.contentFilter = {
49		"sort_on": "snapshot_created",
50		"sort_order": "desscending",
51		}
52
53		self.context_actions = {}
54
55		self.title = self.context.translate(_("Audit Log"))
56		self.icon = "{}/{}".format(
57		self.portal_url,
58		"/++resource++bika.lims.images/auditlog_big.png"
59		)
60
61		self.show_select_column = False
62		self.pagesize = 25
63
64		self.columns = collections.OrderedDict((
65		("title", {
66		"title": _("Title"),
67		"index": "title"}),
68		("version", {
69		"title": _("Version"),
70		"index": "snapshot_version",
71		"sortable": True}),
72		("modified", {
73		"title": _("Date Modified"),
74		"index": "modified",
75		"sortable": True}),
76		("actor", {
77		"title": _("Actor"),
78		"index": "actor",
79		"sortable": True}),
80		("fullname", {
81		"title": _("Fullname"),
82		"index": "fullname",
83		"sortable": True}),
84		("roles", {
85		"title": _("Roles"),
86		"sortable": False,
87		"toggle": False}),
88		("remote_address", {
89		"title": _("Remote IP"),
90		"sortable": True}),
91		("action", {
92		"title": _("Action"),
93		"index": "action",
94		"sortable": True}),
95		("review_state", {
96		"title": _("Workflow State"),
97		"index": "review_state",
98		"sortable": True}),
99		("diff", {
100		"title": _("Changes"),
101		"sortable": False}),
102		))
103
104		self.review_states = [
105		{
106		"id": "default",
107		"title": _("Active"),
108		"contentFilter": {},
109		"columns": self.columns.keys(),
110		}
111		]
112
113		def before_render(self):
114		"""Before template render hook
115		"""
116		# Don't allow any context actions
117		self.request.set("disable_border", 1)
118
119		def folderitem(self, obj, item, index):
120		"""Service triggered each time an item is iterated in folderitems.
121		The use of this service prevents the extra-loops in child objects.
122		:obj: the instance of the class to be foldered
123		:item: dict containing the properties of the object to be used by
124		the template
125		:index: current index of the item
126		"""
127
128		# We are using the existing logic from the auditview
129		logview = api.get_view("auditlog", context=obj, request=self.request)
130
131		# get the last snapshot
132		snapshot = get_last_snapshot(obj)
133		# get the metadata of the last snapshot
134		metadata = get_snapshot_metadata(snapshot)
135
136		title = obj.Title()
137		url = obj.absolute_url()
138		auditlog_url = "{}/@@auditlog".format(url)
139
140		# Title
141		item["title"] = title
142		# Link the title to the auditlog of the object
143		item["replace"]["title"] = get_link(auditlog_url, value=title)
144
145		# Version
146		version = get_snapshot_version(obj, snapshot)
147		item["version"] = version
148
149		# Modification Date
150		m_date = metadata.get("modified")
151		item["modified"] = logview.to_localized_time(m_date)
152
153		# Actor
154		actor = metadata.get("actor")
155		item["actor"] = actor
156
157		# Fullname
158		properties = api.get_user_properties(actor)
159		item["fullname"] = properties.get("fullname", actor)
160
161		# Roles
162		roles = metadata.get("roles", [])
163		item["roles"] = ", ".join(roles)
164
165		# Remote Address
166		remote_address = metadata.get("remote_address")
167		item["remote_address"] = remote_address
168
169		# Action
170		action = metadata.get("action")
171		item["action"] = logview.translate_state(action)
172
173		# Review State
174		review_state = metadata.get("review_state")
175		item["review_state"] = logview.translate_state(review_state)
176
177		# get the previous snapshot
178		prev_snapshot = get_snapshot_by_version(obj, version-1)
179	View Code Duplication	if prev_snapshot:
		0 ignored issues – show Duplication introduced 2019-04-15 21:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
180		prev_metadata = get_snapshot_metadata(prev_snapshot)
181		prev_review_state = prev_metadata.get("review_state")
182		if prev_review_state != review_state:
183		item["replace"]["review_state"] = "{} → {}".format(
184		logview.translate_state(prev_review_state),
185		logview.translate_state(review_state))
186
187		# Rendered Diff
188		diff = compare_snapshots(snapshot, prev_snapshot)
189		item["diff"] = logview.render_diff(diff)
190
191		return item
192
193
194		schema = ATFolderSchema.copy()
195
196
197		class AuditLog(ATFolder):
198		implements(IAuditLog)
199		displayContentsTab = False
200		schema = schema
		0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-25 08:58 UTC by Report Bug Copy Issue Report The variable `schema` does not seem to be defined. Loading history...
201
202
203		schemata.finalizeATCTSchema(schema, folderish=True, moveDiscussion=False)
204		atapi.registerType(AuditLog, PROJECTNAME)
205

senaite / senaite.core

Push — master ( 804f45...1fa2c0 )

AuditLogView.folderitem() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like