getExperimentFilesService is the class that allows remote access to the getExperimentFiles.py script.

Like all my python cgi scripts, getExperimentFilesService has the following structure: the entire cgi is contained in one class, with a main function at the end which serves simply to call the __init__ function of the class. This __init__ function is responsible for calling all other class methods. It is made up of a single try block, with the purpose of reporting all exceptions in well-formatted text to both the user and the administrator. The __init__ function first makes sure the pythonlib can be found. It then calls setScriptState to validate the the cgi arguments, which are simply the arguments for the isprint command.

If any uncaught exception is thrown, its caught by the __init__ try block. If its an MadrigalError, additional information is available. The catch blocks attempt to display the error message on the screen by backing out of of large number of possible tags, which might prevent its display (in any case, the error message will always be available in the page source. The formatted error message is also sent to the email address given in the siteTab.txt metadata file.

This script calls madrigal.ui.web.ui.isTrusted() to determine if user is trusted and should see private files.

This script is not meant to be used directly by a user, and thus is named Service. It is meant to be used by scripting languages such as Matlab that want to call getExperimentFiles via the web

Input cgi arguments:

1. id (int) - experiment id

Returns comma-delimited data, one line for each experiment file, with the following fields:

1. file.name (string) Example /opt/mdarigal/blah/mlh980120g.001

2. file.kindat (int) Kindat code. Example: 3001

3. file.kindat desc (string) Kindat description: Example Basic Derived Parameters

4. file.category (int) (1=default, 2=variant, 3=history, 4=real-time)

5. file.status (string)(preliminary, final, or any other description)

6. file.permission (int) 0 for public, 1 for private. For now will not return private files.

Calls script getExperimentFiles.py.

If error, returns error description.

Change history:

Written by Bill Rideout Dec. 16, 2003

$Id: getExperimentFilesService_getExperimentFilesService.py.html 3304 2011-01-17 15:25:59Z brideout $

__init__ ( self )

createObjects ( self )

getExperimentFiles ( self )

setScriptState ( self )