Sebastian Fritz Lühnsdorf

ZopeScanner is a tool that provides valuable assistance with maintenance, troubleshooting, development, research and much more. It allows you to take a detailed look inside all parts of the Zope server via an easy to use web interface. The ZopeScanner works seamlessly with all versions of Zope and Python.

Usage

ZopeScanner is a tool for development, administration, forensics, troubleshooting, research and much more, which provides insights into the inner workings of the Zope server. It is extremely easy to use. Various entry points are provided, such as the directory tree or the server configuration. Links on these web forms allow you to access deeper-level objects. Each object is analysed in detail and the results presented in a structured manner.

The software poses certain risks, as it allows access to otherwise hidden parts of the server. For this reason, great care is taken to ensure that it can only ever perform read-only access. Access is also restricted to the “Manager” role, i.e. the main administrator of the Zope server. ZopeScanner reports the administrator’s existence in the Zope server's log file.

Setup

ZopeScanner is released as a Product – a standard extension for Zope – and installs itself automatically into the Control Panel. It can also be removed without leaving any traces. For security reasons, ZopeScanner logs its presence in the log file. Furthermore, all access is explicitly restricted to the ‘Manager’ role – the main administrator of the Zope server – and cannot be modified.

The ZopeScanner works seamlessly with all versions of Zope and Python. Where possible, newer features are incorporated, whilst traditional programming techniques ensure that the programme remains reliably available for all versions. The original compatibility with very early versions of Zope running on Python 1.5.2 on 32-bit operating systems is currently being reviewed. ZopeScanner only depends one the standard Python library and Zope components.

• 
  Zope 6.1.0 (2026-04-22)
  Python 3.14.6
• 
  Zope 5.14.2 (2026-03-07)
  Python 3.14.6
• 
  Zope 4.8.11 (2023-10-04)
  Python 3.7.17
• 
  Zope 4.8.11 (2023-10-04)
  Python 2.7.18
• 
  Zope 2.13.30 (2020-02-14)
  Python 2.7.18
• 
  Zope 2.6.4 (2004-02-11)
  Python 2.2.3

Development

ZopeScanner is currently being revised and modernised to take full account of the latest developments in Zope and Python. The current version is therefore not yet an official release, but a preview. It is an alpha version, which means that bugs and unfinished features are to be expected. An official release on the Python Package Index is also pending.

Although the original version of the software worked almost seamlessly with the latest versions of Python and Zope, its age was evident in all sorts of ways. Revamping the outdated programming techniques and user interface required a great deal of care and insight in order to continue supporting older versions of Zope and Python.

logo_github Github

The Scanners

The ZopeScanner provides six different entry points from which users can descend deeper into the details of the Zope server. These six entry points are “System”, “Products”, “Objects”, “Modules”, “Sources”, and “Log Files”. From there links lead to other layers of the systems, primarily utilizing the Object Scanner.

• System Scanner

  System information encompasses all global settings of Zope, Python, the OS (operating system), and the host machine itself.

  

  

• Product Scanner

  “Product” software packages are plugins, that may register “Base Classes”, which can be added through Zope's OFS in the object database (ZODB). This includes basic content types, such as Folders and Documents (web pages), functional types, such as user portals, as well as custom built applications.

  

  

• Object Scanner

  The object scanner provides comprehensive reports on any object, identified by path. It recognizes OFS object and extends the report with respective information. It starts at the root of Zope's OFS directory tree, allowing users to browse the OFS objects stored within.

  

  

• Module Scanner

  Directory for all imported modules, including the Python standard library, the Zope server, and any other installed package. Packages may consist of a single module or contain any number of sub-modules.

  

  

• Source Scanner

  Web based file browser of the Zope server and the Python programming language. Access to files outside these rootpaths is impossible. The detail view of a file adapts to the type of file.

  

  

• Log File Scanner

  The Log File Scanner detects all log files managed by Zope and allows them to be displayed in real time. ZopeScanner supports all versions of the modules used, Python’s logging and Zope’s zLOG.