IntrospectionTool.py 15.8 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
33
import json
34
import tarfile
Ivan Tyagov's avatar
Ivan Tyagov committed
35
from AccessControl import ClassSecurityInfo
36
from Products.ERP5Type.Globals import InitializeClass, DTMLFile
Ivan Tyagov's avatar
Ivan Tyagov committed
37 38 39
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
from AccessControl.SecurityManagement import setSecurityManager
Ivan Tyagov's avatar
Ivan Tyagov committed
40
from Products.ERP5 import _dtmldir
Rafael Monnerat's avatar
Rafael Monnerat committed
41
from Products.ERP5.Tool.LogMixin import LogMixin
42
from Products.ERP5Type.Utils import _setSuperSecurityManager
43
from App.config import getConfiguration
44 45
from AccessControl import Unauthorized
from Products.ERP5Type.Cache import CachingMethod
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
    """
    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")
144 145 146 147
      try:
        tmp_file.add(file_path)
      finally:
        tmp_file.close()
148
      RESPONSE.setHeader('Content-type', 'application/x-tar')
Aurel's avatar
Aurel committed
149 150
      RESPONSE.setHeader('Content-Disposition', \
                 'attachment;filename="%s.tar.gz"' % file_path.split('/')[-1])
151
    else:
Aurel's avatar
Aurel committed
152 153 154 155
      RESPONSE.setHeader('Content-type', 'application/txt')
      RESPONSE.setHeader('Content-Disposition', \
                 'attachment;filename="%s.txt"' % file_path.split('/')[-1])

156 157
      tmp_file_path = file_path

Aurel's avatar
Aurel committed
158

159
    with open(tmp_file_path) as f:
160 161 162 163 164 165 166 167 168
      RESPONSE.setHeader('Content-Length', os.stat(tmp_file_path).st_size)
      for data in f:
        RESPONSE.write(data)

    if compressed:
      os.remove(tmp_file_path)

    return ''

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


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

  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

190
    char_per_line = 75
191

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    with open(log_file,'r') as tailed_file:
      while 1:
        try:
          tailed_file.seek(-1 * char_per_line * line_number, 2)
        except IOError:
          tailed_file.seek(0)
        pos = tailed_file.tell()

        lines = tailed_file.read().split("\n")
        if len(lines) > (line_number + 1) or not pos:
          break
        # The lines are bigger than we thought
        char_per_line *= 1.3  # Inc for retry

    start = max(len(lines) - line_number - 1, 0)
207 208 209 210 211 212 213
    return "\n".join(lines[start:len(lines)])

  security.declareProtected(Permissions.ManagePortal, 'tailEventLog')
  def tailEventLog(self):
    """
    Tail the Event Log.
    """
214
    return escape(self._tailFile(self.__getEventLogPath(), 50))
215

216 217 218 219 220 221
  security.declareProtected(Permissions.ManagePortal, 'tailAccessLog')
  def tailAccessLog(self):
    """
    Tail the Event Log.
    """
    return escape(self._tailFile(self.__getAccessLogPath(), 50))
222

223
  security.declareProtected(Permissions.ManagePortal, 'getAccessLog')
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
  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')
252
  def getDataFs(self, compressed=1, REQUEST=None):
253
    """
Aurel's avatar
Aurel committed
254
      Get the Data.fs.
255 256 257 258 259 260 261 262
    """
    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
263
                               compressed=compressed)
264

265 266 267
  #
  #   Instance variable definition access
  #
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  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
286 287
  security.declareProtected(Permissions.ManagePortal, '_getSoftwareHome')
  def _getSoftwareHome(self):
288
    """
289 290 291
      Get the value of SOFTWARE_HOME for zopectl startup script
      or from zope.conf (whichever is most relevant)
    """
292
    return getConfiguration().softwarehome
293

Rafael Monnerat's avatar
Rafael Monnerat committed
294 295
  security.declareProtected(Permissions.ManagePortal, '_getPythonExecutable')
  def _getPythonExecutable(self):
296 297 298 299
    """
      Get the value of PYTHON for zopectl startup script
      or from zope.conf (whichever is most relevant)
    """
300
    return sys.executable
301

Rafael Monnerat's avatar
Rafael Monnerat committed
302 303
  security.declareProtected(Permissions.ManagePortal, '_getProductPathList')
  def _getProductPathList(self):
304 305 306 307
    """
      Get the value of SOFTWARE_HOME for zopectl startup script
      or from zope.conf (whichever is most relevant)
    """
308
    return getConfiguration().products
309

310 311
  security.declareProtected(Permissions.ManagePortal, '_getSystemVersionDict')
  def _getSystemVersionDict(self):
312 313 314 315 316
    """
      Returns a dictionnary with all versions of installed libraries
      {
         'python': '2.4.3'
       , 'pysvn': '1.2.3'
317
       , 'ERP5' : "5.4.3"       
318
      }
319 320
      NOTE: consider using autoconf / automake tools ?
    """
321 322 323 324 325 326 327
    def cached_getSystemVersionDict():
      import pkg_resources
      version_dict = {}
      for dist in pkg_resources.working_set:
        version_dict[dist.key] = dist.version

      from Products import ERP5 as erp5_product
328
      erp5_product_path = os.path.dirname(erp5_product.__file__)
329
      try:
330 331 332 333
        with open(os.path.join(erp5_product_path, "VERSION.txt")) as f:
          erp5_version = f.read().strip().replace("ERP5 ", "")
      except Exception:
        erp5_version = None
334 335 336 337 338 339 340 341 342 343

      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()
344

345
  security.declareProtected(Permissions.ManagePortal,
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
      '_getExternalConnectionDict')
  def _getExternalConnectionDict(self):
    """ Return a dictionary with all connections from ERP5 to an External
        Service, this may include MySQL, Memcached, Kumofs, Ldap or any other.

        The standard format is:
	  {'relative_url/method_or_property_id' : method_value_output,}.
    """
    connection_dict = {}
    portal = self.getPortalObject()

    def collect_information_by_method(document, method_id):
      method_object = getattr(document, method_id, None)
      key = "%s/%s" % (document.getRelativeUrl(), method_id)
      connection_dict[key] = method_object()

    portal = self.getPortalObject()

    # Collect information from portal memcached
    for plugin in portal.portal_memcached.objectValues():
      collect_information_by_method(plugin, "getUrlString")

    system_preference = \
       portal.portal_preferences.getActiveSystemPreference()

    if system_preference is not None:
      # Conversion Server information
      collect_information_by_method(system_preference, 
                         'getPreferredOoodocServerAddress')
      collect_information_by_method(system_preference,
                         'getPreferredOoodocServerPortNumber')

    def collect_information_by_property(document, property_id):
      key = "%s/%s" % (document.getId(), property_id)
      connection_dict[key] = str(getattr(document, property_id, None))

    # Collect information related to Mail Server.
    collect_information_by_property(self.MailHost,'smtp_host')
    collect_information_by_property(self.MailHost,'smtp_port')

    # Collect information related to Databases. ie.: MySQL, LDap?
    for conn in self.objectValues(["CMFActivity Database Connection", 
                                   "Z MySQL Database Connection", 
                                   "Z MySQL Deferred Database Connection"]):

      collect_information_by_property(conn,'connection_string')

393 394 395 396 397 398
    # collect information from certificate authority
    certificate_authority = getattr(portal, 'portal_certificate_authority',
      None)
    if certificate_authority is not None:
      collect_information_by_property(certificate_authority,
        'certificate_authority_path')
399 400
    return connection_dict

401 402 403 404 405 406 407 408 409 410
  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

411 412 413 414 415 416 417 418 419 420 421 422
  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
423

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
  security.declareProtected(Permissions.ManagePortal, 'getSystemSignatureDict')
  def getSystemSignatureDict(self):
    """ Returns a dictionary with all informations related to the instance.
    This information can report what resources (memcache, mysql, zope,
    python, libraries) the instance is using. Also, what business templates are
    installed.

    Such information is usefull to detect changes in the system, into upgrader, 
    slapos and/or to build Introspection Reports.
    """
    business_template_repository_list = self.portal_templates.getRepositoryList()
    return dict(
           activity_dict=self._getActivityDict(),
           version_dict=self._getSystemVersionDict(), 
           external_connection_dict=self._getExternalConnectionDict(), 
           business_template_dict=self._getBusinessTemplateRevisionDict(), 
           business_template_repository_list=business_template_repository_list)
441 442 443 444 445 446 447 448 449 450 451 452 453

  security.declareProtected(Permissions.ManagePortal, 'getSystemSignatureAsJSON')
  def getSystemSignatureAsJSON(self, REQUEST=None):
    """
      Returns the information as JSON. 

      THIS merhod could be a decorator or use a some other clever way to convert
      the getSystemSignatureDict
    """
    if REQUEST is not None:
      REQUEST.set("Content-Type", "application/json")
    return json.dumps(self.getSystemSignatureDict())

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