Clouseau

Clouseau is an Ajax based Zope/Python prompt. Think of it as a replacement for zopectl debug. A Python prompt that allows you to interact with your Zope site. It does this with an Ajax interface, so you can do this right from Plone.

Project Description

Clouseau

Authors:

Andy McKay

Credits and Thanks:

Lots of great work on this at the initial Vancouver sprint:

  • Leonardo Rochael Almeida
  • Richard Amerman

Others

  • Enfold Systems, space for Vancouver sprint and developer time
  • Blue Fountain, for developer time
  • 7TechNW, developer time

Testing and feedback

  • Wichert Akkerman
  • Volodymyr Cherepanyak
  • Johannes Ammon

Bristol sprint:

  • Eric Bréhault

License:

GPL, see License.GPL

What is it?

It's a Ajax based Zope/Python prompt. Think of it is a replacement for zopectl debug.

Dependencies

Recent browser tested on Safari, Firefox 1.5

Zope 2.9 +

Plone 2.5

May work in others, but this is what it was tested on.

Warning not tested on: IE since 0.1 release. I don't own a Windows computer (and don't want to). Any help or debugging from users of IE appreciated. Unfortunately, just telling me it does not work on IE is not enough, I need patches.

It's a what?

A Python prompt that allows you to interact with your Zope site. It does this with an Ajax interface, so you can do this right from the ui.

How do I use it?

If you're using buildout, just add "Products.Clouseau" to the eggs section of buildout.cfg; run buildout and restart Zope.

For a traditional product install, download the product package, unpack it and drop the Clouseau directory into your Products directory. Just like any other product. Restart Zope.

In Plone go to site setup > add/remove products. Install Clouseau.

Then go to site setup > Zope Inspector.

Click "create a new session".

Play.

--- or

Go to a content item.

Click on the little magnifying glass.

Play.

Is it secure?

Probably not. All the methods that interact with the application are protected by Zope security. So if you trust that code, you'll be happy. However chances are if you know Plone and Zope you might be screaming at this point.

It does fly in the face of the traditional security model a bit, although essentially you are allowing anyone who has Manager to do anything to your site. Running this on a production site is crazy. From the page template in Clouseau...

Warning: this tool allows users to interact with your Zope at its most basic level. It will allow a user to add, edit, delete any data in the site ignoring all security. This tool should only be used on development sites. If you are at all unsure, stop, back away and uninstall this product immediately and go and read the documentation in the source.

First, how can I protect my installation?

There are two variables enabled and enabled_only_in_debug_mode. Both of these are defined in config.py. If you would like to turn Clouseau off, then set enabled = False. If you'd like clouseau to work only when Zope is in debug-mode then leave enabled_only_in_debug_mode = True.

Note: by default Clouseau is set to enabled = True and enabled_only_in_debug_mode = True. If you are running in production mode, restart your server in debug-mode.

Next, will this work?

Probably. It's got quite a way to go yet. See to do.

Why browser based?

1) Ease of end users, this has NO dependencies (compare to PloneShell or zopectl)

2) Collaborative debugging, multiple people can join a session and see the same data

3) Lots of features we haven't gotten too yet.

4) Ease of development, no hacking down in wxPython or Zope sources.

To do list:

  • Auto complete
  • Variable tree

Current Release
Clouseau 1.0

Released May 05, 2011 — tested with Plone 4, Plone 3

Improve compliancy with some Plone 4 skins.
More about this release…

Download file Get Clouseau for all platforms
Pypi egg
If you are using Plone 3.2 or higher, you probably want to install this product with buildout. See our tutorial on installing add-on products with buildout for more information.

All Releases

Version Released Description Compatibility Licenses Status
1.0 May 05, 2011 Improve compliancy with some Plone 4 skins. More about this release…
Plone 4
Plone 3
GPL final
0.9 Oct 30, 2010 Plone 4 compliancy More about this release…
Plone 4
Plone 3
GPL final
0.8.4 Dec 05, 2008 Fix for issue 14 More about this release… GPL final
0.8.3 Nov 14, 2008 Fixes issues when used from buildout More about this release…
Plone 3
GPL final
0.8.1 Sep 30, 2007 Some minor fixes for Safari users More about this release…
Plone 3
GPL final
0.8 Aug 21, 2007 Compatability with Plone 3.0 More about this release…
Plone 3
GPL final
0.7.1 Jan 24, 2007 Added large result truncation More about this release… GPL final
0.6 Nov 07, 2006 Added auto-complete More about this release…
Plone 2.5.1
GPL final
0.5 Oct 26, 2006 Save and load of local or remote sessions More about this release…
Plone 2.5.1
Plone 2.5
GPL final
0.4.1 Oct 15, 2006 Bug fix release, that move down every prompt didn't work too well. More about this release…
Plone 2.5.1
GPL final
0.4 Oct 06, 2006 Some user interface improvements, some help and really improved tool tips, especially if you have DocFinderTab installed. More about this release…
Plone 2.5
GPL final
0.3 Sep 21, 2006 New context sensitive Python prompt provides easy object introspection. More about this release…
Plone 2.5
GPL final
0.1 Sep 01, 2006 First release of Clouseau More about this release…
Plone 2.5
GPL final