IntrospectionTool.py 12.5 KB
Newer Older
1
# -*- coding: utf-8 -*-
Ivan Tyagov's avatar
Ivan Tyagov committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
##############################################################################
#
# 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.
#
##############################################################################

30
import os
31
import sys
32
import tempfile
Ivan Tyagov's avatar
Ivan Tyagov committed
33
from AccessControl import ClassSecurityInfo
34
from Products.ERP5Type.Globals import InitializeClass, DTMLFile
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from Products.CMFCore.utils import getToolByName
Ivan Tyagov's avatar
Ivan Tyagov committed
36 37 38
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
from AccessControl.SecurityManagement import setSecurityManager
Ivan Tyagov's avatar
Ivan Tyagov committed
39
from Products.ERP5 import _dtmldir
Rafael Monnerat's avatar
Rafael Monnerat committed
40
from Products.ERP5.Tool.LogMixin import LogMixin
41
from Products.ERP5Type.Utils import _setSuperSecurityManager
42
from App.config import getConfiguration
43 44
from AccessControl import Unauthorized
from Products.ERP5Type.Cache import CachingMethod
45
from Products.ERP5Type import tarfile
46
from cgi import escape
Ivan Tyagov's avatar
Ivan Tyagov committed
47

48 49
import logging

Jean-Paul Smets's avatar
Jean-Paul Smets committed
50 51
_MARKER = []

52 53 54
event_log = logging.getLogger()
access_log = logging.getLogger("access")

Rafael Monnerat's avatar
Rafael Monnerat committed
55
class IntrospectionTool(LogMixin, BaseTool):
Ivan Tyagov's avatar
Ivan Tyagov committed
56
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57
    This tool provides both local and remote introspection.
Ivan Tyagov's avatar
Ivan Tyagov committed
58 59 60 61 62 63 64 65 66 67 68 69
  """

  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 )

70 71 72
  #
  #   Remote menu management
  #
Jérome Perrin's avatar
Jérome Perrin committed
73 74
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getFilteredActionDict')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75
  def getFilteredActionDict(self, user_name=_MARKER):
Ivan Tyagov's avatar
Ivan Tyagov committed
76 77 78 79
    """
      Returns menu items for a given user
    """
    portal = self.getPortalObject()
Rafael Monnerat's avatar
Rafael Monnerat committed
80 81 82
    is_portal_manager = portal.portal_membership.checkPermission(\
      Permissions.ManagePortal, self)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
83
    downgrade_authenticated_user = user_name is not _MARKER and is_portal_manager
Ivan Tyagov's avatar
Ivan Tyagov committed
84 85
    if downgrade_authenticated_user:
      # downgrade to desired user
86
      original_security_manager = _setSuperSecurityManager(self, user_name)
Ivan Tyagov's avatar
Ivan Tyagov committed
87 88

    # call the method implementing it
Rafael Monnerat's avatar
Rafael Monnerat committed
89
    erp5_menu_dict = portal.portal_actions.listFilteredActionsFor(portal)
Ivan Tyagov's avatar
Ivan Tyagov committed
90 91 92 93 94

    if downgrade_authenticated_user:
      # restore original Security Manager
      setSecurityManager(original_security_manager)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
95 96 97 98 99 100
    # 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
Ivan Tyagov's avatar
Ivan Tyagov committed
101

Jérome Perrin's avatar
Jérome Perrin committed
102 103
  security.declareProtected(Permissions.AccessContentsInformation,
                           'getModuleItemList')
104 105
  def getModuleItemList(self, user_name=_MARKER):
    """
106
      Returns module items for a given user
107 108
    """
    portal = self.getPortalObject()
Rafael Monnerat's avatar
Rafael Monnerat committed
109 110 111
    is_portal_manager = portal.portal_membership.checkPermission(
      Permissions.ManagePortal, self)

112 113 114
    downgrade_authenticated_user = user_name is not _MARKER and is_portal_manager
    if downgrade_authenticated_user:
      # downgrade to desired user
115
      original_security_manager = _setSuperSecurityManager(self, user_name)
116 117 118 119 120 121 122 123 124 125

    # 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

126 127 128
  #
  #   Local file access
  #
129 130 131
  def _getLocalFile(self, REQUEST, RESPONSE, file_path, 
                         tmp_file_path='/tmp/', compressed=1):
    """
Aurel's avatar
Aurel committed
132
      It should return the local file compacted or not as tar.gz.
133 134 135 136 137 138 139 140 141 142 143 144 145 146
    """
    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')
Aurel's avatar
Aurel committed
147 148
      RESPONSE.setHeader('Content-Disposition', \
                 'attachment;filename="%s.tar.gz"' % file_path.split('/')[-1])
149
    else:
Aurel's avatar
Aurel committed
150 151 152 153
      RESPONSE.setHeader('Content-type', 'application/txt')
      RESPONSE.setHeader('Content-Disposition', \
                 'attachment;filename="%s.txt"' % file_path.split('/')[-1])

154 155
      tmp_file_path = file_path

Aurel's avatar
Aurel committed
156

157 158 159 160 161 162 163 164 165 166 167 168 169
    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 ''

170
  def __getEventLogPath(self):
171
    """
172
      Get the Event Log.
173
    """
174
    return event_log.handlers[0].baseFilename
175 176


177
  def __getAccessLogPath(self):
178
    """
Aurel's avatar
Aurel committed
179
      Get the Event Log.
180
    """
181
    return access_log.handlers[0].baseFilename
182 183 184 185 186 187 188 189 190

  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

191
    char_per_line = 75
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207

    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
208
      char_per_line = char_per_line * 1.3  # Inc for retry
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

    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.
    """
224
    return escape(self._tailFile(self.__getEventLogPath(), 50))
225

226 227 228 229 230 231
  security.declareProtected(Permissions.ManagePortal, 'tailAccessLog')
  def tailAccessLog(self):
    """
    Tail the Event Log.
    """
    return escape(self._tailFile(self.__getAccessLogPath(), 50))
232

233
  security.declareProtected(Permissions.ManagePortal, 'getAccessLog')
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
  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')
262
  def getDataFs(self, compressed=1, REQUEST=None):
263
    """
Aurel's avatar
Aurel committed
264
      Get the Data.fs.
265 266 267 268 269 270 271 272
    """
    if REQUEST is not None:
      response = REQUEST.RESPONSE
    else:
      return "FAILED"

    return self._getLocalFile(REQUEST, response,
                               file_path='var/Data.fs',
Aurel's avatar
Aurel committed
273
                               compressed=compressed)
274

275 276 277
  #
  #   Instance variable definition access
  #
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
  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()

Rafael Monnerat's avatar
Rafael Monnerat committed
296 297
  security.declareProtected(Permissions.ManagePortal, '_getSoftwareHome')
  def _getSoftwareHome(self):
298
    """
299 300 301
      Get the value of SOFTWARE_HOME for zopectl startup script
      or from zope.conf (whichever is most relevant)
    """
302
    return getConfiguration().softwarehome
303 304


Rafael Monnerat's avatar
Rafael Monnerat committed
305 306
  security.declareProtected(Permissions.ManagePortal, '_getPythonExecutable')
  def _getPythonExecutable(self):
307 308 309 310
    """
      Get the value of PYTHON for zopectl startup script
      or from zope.conf (whichever is most relevant)
    """
311
    return sys.executable
312

Rafael Monnerat's avatar
Rafael Monnerat committed
313 314
  security.declareProtected(Permissions.ManagePortal, '_getProductPathList')
  def _getProductPathList(self):
315 316 317 318
    """
      Get the value of SOFTWARE_HOME for zopectl startup script
      or from zope.conf (whichever is most relevant)
    """
319
    return getConfiguration().products
320

321 322
  security.declareProtected(Permissions.ManagePortal, '_getSystemVersionDict')
  def _getSystemVersionDict(self):
323 324 325 326 327
    """
      Returns a dictionnary with all versions of installed libraries
      {
         'python': '2.4.3'
       , 'pysvn': '1.2.3'
328
       , 'ERP5' : "5.4.3"       
329
      }
330 331
      NOTE: consider using autoconf / automake tools ?
    """
332 333 334 335
    def cached_getSystemVersionDict():
      import pkg_resources
      def tuple_to_format_str(t):
         return '.'.join([str(i) for i in t])
336

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
      version_dict = {}
      for dist in pkg_resources.working_set:
        version_dict[dist.key] = dist.version

      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

      version_dict["ProductS.ERP5"] = erp5_version
      return version_dict

    get_system_version_dict = CachingMethod(
                  cached_getSystemVersionDict,
                  id='IntrospectionTool__getSystemVersionDict',
                  cache_factory='erp5_content_long')

    return get_system_version_dict()
358

359 360 361 362 363 364 365 366 367 368 369
  security.declareProtected(Permissions.ManagePortal,
  security.declareProtected(Permissions.ManagePortal, 
      '_getBusinessTemplateRevisionDict')
  def _getBusinessTemplateRevisionDict(self):
    """ Return a Dictionary of installed business templates and their revisions
    """
    business_template_dict = {}
    for installed in self.portal_templates.getInstalledBusinessTemplateList():
       business_template_dict[installed.getTitle()] = installed.getRevision()
    return business_template_dict

370 371 372 373 374 375 376 377 378 379 380 381
  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
382

Ivan Tyagov's avatar
Ivan Tyagov committed
383
InitializeClass(IntrospectionTool)