IntrospectionTool.py 6.67 KB
Newer Older
Ivan Tyagov's avatar
Ivan Tyagov committed
1 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
##############################################################################
#
# 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.
#
##############################################################################

29 30
import os
import tempfile
Ivan Tyagov's avatar
Ivan Tyagov committed
31 32
from AccessControl import ClassSecurityInfo
from Globals import InitializeClass, DTMLFile
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33
from Products.CMFCore.utils import getToolByName
Ivan Tyagov's avatar
Ivan Tyagov committed
34 35 36
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
from AccessControl.SecurityManagement import setSecurityManager
Ivan Tyagov's avatar
Ivan Tyagov committed
37
from Products.ERP5 import _dtmldir
38
from Products.ERP5Type.Utils import _setSuperSecurityManager
39 40
from App.config import getConfiguration
import tarfile
Ivan Tyagov's avatar
Ivan Tyagov committed
41

Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43
_MARKER = []

Ivan Tyagov's avatar
Ivan Tyagov committed
44 45
class IntrospectionTool(BaseTool):
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46
    This tool provides both local and remote introspection.
Ivan Tyagov's avatar
Ivan Tyagov committed
47 48 49 50 51 52
  """

  id = 'portal_introspections'
  title = 'Introspection Tool'
  meta_type = 'ERP5 Introspection Tool'
  portal_type = 'Introspection Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53
  allowed_content_types = ('Anonymized Introspection Report', 'User Introspection Report',) # XXX User Portal Type please
Ivan Tyagov's avatar
Ivan Tyagov committed
54 55 56 57 58 59

  security = ClassSecurityInfo()

  security.declareProtected(Permissions.ManagePortal, 'manage_overview')
  manage_overview = DTMLFile('explainIntrospectionTool', _dtmldir )

Jérome Perrin's avatar
Jérome Perrin committed
60 61
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getFilteredActionDict')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62
  def getFilteredActionDict(self, user_name=_MARKER):
Ivan Tyagov's avatar
Ivan Tyagov committed
63 64 65 66
    """
      Returns menu items for a given user
    """
    portal = self.getPortalObject()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67 68 69
    is_portal_manager = getToolByName(portal, 
      'portal_membership').checkPermission(Permissions.ManagePortal, self)
    downgrade_authenticated_user = user_name is not _MARKER and is_portal_manager
Ivan Tyagov's avatar
Ivan Tyagov committed
70 71
    if downgrade_authenticated_user:
      # downgrade to desired user
72
      original_security_manager = _setSuperSecurityManager(self, user_name)
Ivan Tyagov's avatar
Ivan Tyagov committed
73 74

    # call the method implementing it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75
    erp5_menu_dict = getToolByName(portal, 'portal_actions').listFilteredActionsFor(portal)
Ivan Tyagov's avatar
Ivan Tyagov committed
76 77 78 79 80

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
81 82 83 84 85 86
    # 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
87

Jérome Perrin's avatar
Jérome Perrin committed
88 89
  security.declareProtected(Permissions.AccessContentsInformation,
                           'getModuleItemList')
90 91 92 93 94 95 96 97 98 99
  def getModuleItemList(self, user_name=_MARKER):
    """
      Returns menu items for a given user
    """
    portal = self.getPortalObject()
    is_portal_manager = getToolByName(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
100
      original_security_manager = _setSuperSecurityManager(self, user_name)
101 102 103 104 105 106 107 108 109 110

    # 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

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
  def _getLocalFile(self, REQUEST, RESPONSE, file_path, 
                         tmp_file_path='/tmp/', compressed=1):
    """
      It should return the local file compacted 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')
    else:
      tmp_file_path = file_path

    f = open(tmp_file_path)
    try:
      RESPONSE.setHeader('Content-Length', os.stat(tmp_file_path).st_size)
      RESPONSE.setHeader('Content-Disposition', \
                 'attachment;filename="%s.tar.gz"' % file_path.split('/')[-1])
      for data in f:
        RESPONSE.write(data)
    finally:
      f.close()

    if compressed:
      os.remove(tmp_file_path)

    return ''

  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='log/Z2.log', 
                               compressed=1) 

  security.declareProtected(Permissions.ManagePortal, 'getAccessLog')
  def getEventLog(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='log/event.log',
                               compressed=1)

  security.declareProtected(Permissions.ManagePortal, 'getAccessLog')
  def getDataFs(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='var/Data.fs',
                               compressed=1)

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