# -*- coding: utf-8 -*- ############################################################################## # # Copyright (c) 2006 Nexedi SARL and Contributors. All Rights Reserved. # Ivan Tyagov <ivan@nexedi.com> # # WARNING: This program as such is intended to be used by professional # programmers who take the whole responsability of assessing all potential # consequences resulting from its eventual inadequacies and bugs # End users who are looking for a ready-to-use solution with commercial # garantees and support are strongly adviced to contract a Free Software # Service Company # # 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. # ############################################################################## import os import tempfile from AccessControl import ClassSecurityInfo from Products.ERP5Type.Globals import InitializeClass, DTMLFile from Products.CMFCore.utils import getToolByName from Products.ERP5Type.Tool.BaseTool import BaseTool from Products.ERP5Type import Permissions from AccessControl.SecurityManagement import setSecurityManager from Products.ERP5 import _dtmldir from Products.ERP5.Tool.LogMixin import LogMixin from Products.ERP5Type.Utils import _setSuperSecurityManager from App.config import getConfiguration from AccessControl import Unauthorized from Products.ERP5Type.Cache import CachingMethod from Products.ERP5Type import tarfile from cgi import escape import logging _MARKER = [] event_log = logging.getLogger() access_log = logging.getLogger("access") class IntrospectionTool(LogMixin, BaseTool): """ This tool provides both local and remote introspection. """ id = 'portal_introspections' title = 'Introspection Tool' meta_type = 'ERP5 Introspection Tool' portal_type = 'Introspection Tool' security = ClassSecurityInfo() security.declareProtected(Permissions.ManagePortal, 'manage_overview') manage_overview = DTMLFile('explainIntrospectionTool', _dtmldir ) # # Remote menu management # security.declareProtected(Permissions.AccessContentsInformation, 'getFilteredActionDict') def getFilteredActionDict(self, user_name=_MARKER): """ Returns menu items for a given user """ portal = self.getPortalObject() is_portal_manager = portal.portal_membership.checkPermission(\ Permissions.ManagePortal, self) downgrade_authenticated_user = user_name is not _MARKER and is_portal_manager if downgrade_authenticated_user: # downgrade to desired user original_security_manager = _setSuperSecurityManager(self, user_name) # call the method implementing it erp5_menu_dict = portal.portal_actions.listFilteredActionsFor(portal) if downgrade_authenticated_user: # restore original Security Manager setSecurityManager(original_security_manager) # Unlazyfy URLs and other lazy values so that it can be marshalled result = {} for key, action_list in erp5_menu_dict.items(): result[key] = map(lambda action:dict(action), action_list) return result security.declareProtected(Permissions.AccessContentsInformation, 'getModuleItemList') def getModuleItemList(self, user_name=_MARKER): """ Returns module items for a given user """ portal = self.getPortalObject() is_portal_manager = portal.portal_membership.checkPermission( Permissions.ManagePortal, self) downgrade_authenticated_user = user_name is not _MARKER and is_portal_manager if downgrade_authenticated_user: # downgrade to desired user original_security_manager = _setSuperSecurityManager(self, user_name) # call the method implementing it erp5_module_list = portal.ERP5Site_getModuleItemList() if downgrade_authenticated_user: # restore original Security Manager setSecurityManager(original_security_manager) return erp5_module_list # # Local file access # def _getLocalFile(self, REQUEST, RESPONSE, file_path, tmp_file_path='/tmp/', compressed=1): """ It should return the local file compacted or not as tar.gz. """ if file_path.startswith('/'): raise IOError, 'The file path must be relative not absolute' instance_home = getConfiguration().instancehome file_path = os.path.join(instance_home, file_path) if not os.path.exists(file_path): raise IOError, 'The file: %s does not exist.' % file_path if compressed: tmp_file_path = tempfile.mktemp(dir=tmp_file_path) tmp_file = tarfile.open(tmp_file_path,"w:gz") tmp_file.add(file_path) tmp_file.close() RESPONSE.setHeader('Content-type', 'application/x-tar') RESPONSE.setHeader('Content-Disposition', \ 'attachment;filename="%s.tar.gz"' % file_path.split('/')[-1]) else: RESPONSE.setHeader('Content-type', 'application/txt') RESPONSE.setHeader('Content-Disposition', \ 'attachment;filename="%s.txt"' % file_path.split('/')[-1]) tmp_file_path = file_path f = open(tmp_file_path) try: RESPONSE.setHeader('Content-Length', os.stat(tmp_file_path).st_size) for data in f: RESPONSE.write(data) finally: f.close() if compressed: os.remove(tmp_file_path) return '' def __getEventLogPath(self): """ Get the Event Log. """ return event_log.handlers[0].baseFilename def __getAccessLogPath(self): """ Get the Event Log. """ return access_log.handlers[0].baseFilename def _tailFile(self, file_name, line_number=10): """ Do a 'tail -f -n line_number filename' """ log_file = os.path.join(getConfiguration().instancehome, file_name) if not os.path.exists(log_file): raise IOError, 'The file: %s does not exist.' % log_file char_per_line = 75 tailed_file = open(log_file,'r') while 1: try: tailed_file.seek(-1 * char_per_line * line_number, 2) except IOError: tailed_file.seek(0) if tailed_file.tell() == 0: at_start = 1 else: at_start = 0 lines = tailed_file.read().split("\n") if (len(lines) > (line_number + 1)) or at_start: break # The lines are bigger than we thought char_per_line = char_per_line * 1.3 # Inc for retry tailed_file.close() if len(lines) > line_number: start = len(lines) - line_number - 1 else: start = 0 return "\n".join(lines[start:len(lines)]) security.declareProtected(Permissions.ManagePortal, 'tailEventLog') def tailEventLog(self): """ Tail the Event Log. """ return escape(self._tailFile(self.__getEventLogPath(), 50)) security.declareProtected(Permissions.ManagePortal, 'tailAccessLog') def tailAccessLog(self): """ Tail the Event Log. """ return escape(self._tailFile(self.__getAccessLogPath(), 50)) security.declareProtected(Permissions.ManagePortal, 'getAccessLog') def getAccessLog(self, compressed=1, REQUEST=None): """ Get the Access Log. """ if REQUEST is not None: response = REQUEST.RESPONSE else: return "FAILED" return self._getLocalFile(REQUEST, response, file_path=self.__getAccessLogPath(), compressed=compressed) security.declareProtected(Permissions.ManagePortal, 'getEventLog') def getEventLog(self, compressed=1, REQUEST=None): """ Get the Event Log. """ if REQUEST is not None: response = REQUEST.RESPONSE else: return "FAILED" return self._getLocalFile(REQUEST, response, file_path=self.__getEventLogPath(), compressed=compressed) security.declareProtected(Permissions.ManagePortal, 'getDataFs') def getDataFs(self, compressed=1, REQUEST=None): """ Get the Data.fs. """ if REQUEST is not None: response = REQUEST.RESPONSE else: return "FAILED" return self._getLocalFile(REQUEST, response, file_path='var/Data.fs', compressed=compressed) # # Instance variable definition access # security.declareProtected(Permissions.ManagePortal, '_loadExternalConfig') def _loadExternalConfig(self): """ Load configuration from one external file, this configuration should be set for security reasons to prevent people access forbidden areas in the system. """ def cached_loadExternalConfig(): import ConfigParser config = ConfigParser.ConfigParser() config.readfp(open('/etc/erp5.cfg')) return config cached_loadExternalConfig = CachingMethod(cached_loadExternalConfig, id='IntrospectionTool__loadExternalConfig', cache_factory='erp5_content_long') return cached_loadExternalConfig() security.declareProtected(Permissions.ManagePortal, '_getSoftwareHome') def _getSoftwareHome(self): """ Get the value of SOFTWARE_HOME for zopectl startup script or from zope.conf (whichever is most relevant) """ return getConfiguration().softwarehome security.declareProtected(Permissions.ManagePortal, '_getPythonExecutable') def _getPythonExecutable(self): """ Get the value of PYTHON for zopectl startup script or from zope.conf (whichever is most relevant) """ config_file = self._getZopeConfigurationFile("bin/zopectl") new_file_list = [] for line in config_file: if line.startswith("PYTHON="): return line.replace("PYTHON=","") # Not possible get configuration from the zopecl return None security.declareProtected(Permissions.ManagePortal, '_getProductPathList') def _getProductPathList(self): """ Get the value of SOFTWARE_HOME for zopectl startup script or from zope.conf (whichever is most relevant) """ return getConfiguration().products # # Library signature # # XXX this function can be cached to prevent disk access. security.declareProtected(Permissions.ManagePortal, 'getSystemSignatureDict') def getSystemSignatureDict(self): """ Returns a dictionnary with all versions of installed libraries { 'python': '2.4.3' , 'pysvn': '1.2.3' , 'ERP5' : "5.4.3" } NOTE: consider using autoconf / automake tools ? """ def tuple_to_format_str(t): return '.'.join([str(i) for i in t]) from Products import ERP5 as erp5_product erp5_product_path = erp5_product.__file__.split("/")[:-1] try: erp5_v = open("/".join((erp5_product_path) + ["VERSION.txt"])).read().strip() erp5_version = erp5_v.replace("ERP5 ", "") except: erp5_version = None from App import version_txt zope_version = tuple_to_format_str(version_txt.getZopeVersion()[:3]) from sys import version_info # Get only x.x.x numbers. py_version = tuple_to_format_str(version_info[:3]) try: import pysvn # Convert tuple to x.x.x format pysvn_version = tuple_to_format_str(pysvn.version) except: pysvn_version = None return { "python" : py_version , "pysvn" : pysvn_version , "erp5" : erp5_version, "zope" : zope_version } security.declareProtected(Permissions.ManagePortal, '_getActivityDict') def _getActivityDict(self): """ Return a Dictionary with the snapshot with the status of activities. failures (-2 and -3) and running. """ activity_dict = {} # XXX Maybe this is not so efficient check. Performance Optimization # should be consider. activity_dict['failure'] = len(self.portal_activities.getMessageList(processing_node=-2)) activity_dict['total'] = len(self.portal_activities.getMessageList()) return activity_dict InitializeClass(IntrospectionTool)