#
# copyright (c) 2002 greg landrum and rational discovery llc
#
""" General functionality used by the RDOnline Web Interfaces
"""
import sys,cgi,os,time,exceptions,types
import Cookie
from utils import GUIDs
def _FormGet(self,key,default=''):
if self.has_key(key):
v = self[key]
if hasattr(v,'value'):
return v.value
else:
if type(v) in (types.ListType,types.TupleType):
v = [x.value for x in v]
return v
else:
return default
cgi.FieldStorage.get=_FormGet
class TrappedError(exceptions.Exception):
""" exception class for trapping web errors
"""
def __init__(self,args=None):
self.args=args
cookieName = 'RD-Online-Client-ID'
_version = "0.1.0"
cmpdsPerPage = 10
def GetIDCookie():
""" returns the value of the current ID cookie, _None_ if it's not set
"""
c = Cookie.SimpleCookie()
try:
envCookie = os.environ['HTTP_COOKIE']
except:
return None
c.load(envCookie)
if c.has_key(cookieName):
v = c[cookieName].value
return v
else:
return None
def ClearIDCookie(req):
""" clears the current ID Cookie and updates the headers
"""
c = Cookie.SimpleCookie()
c[cookieName]=None
if req is not None:
cOut = c.output(header='',sep='')
try:
h = req.headers_out['Set-Cookie']
except KeyError:
req.headers_out['Set-Cookie'] = cOut
else:
req.headers_out['Set-Cookie'] = '%s %s'%(h,cOut)
else:
print c
def SetIDCookie(req):
""" sets the value of the ID cookie
"""
c = Cookie.SimpleCookie()
c[cookieName]=GUIDs.getGUID()
if req is not None:
cOut = c.output(header='',sep='')
try:
h = req.headers_out['Set-Cookie']
except KeyError:
req.headers_out['Set-Cookie'] = cOut
else:
req.headers_out['Set-Cookie'] = '%s %s'%(h,cOut)
else:
print c
return c[cookieName].value
defaultHtmlHeader="""
%(title)s
%(extras)s
%(title)s
"""
def ConstructHtmlHeader(title='',extraHeadBits=''):
""" returns an HTML header for our templated pages
"""
argD = {'title':title,'extras':extraHeadBits}
res = defaultHtmlHeader%argD
return res
defaultHtmlFooter="""
%(restart)s
%(logout)s
Version: %(version)s
Copyright (C) 2004 Rational Discovery LLC
"""
defaultLogoutText="""Logout"""
defaultRestartText="""Start Over"""
def ConstructHtmlFooter(includeRestart=1,logoutText=None,restartText=None):
""" returns an HTML footer for our templated pages
"""
if logoutText is None:
logoutText=defaultLogoutText
if restartText is None:
restartText=defaultRestartText
argD={'version':str(_version),'restart':'','logout':logoutText}
if includeRestart:
argD['restart'] = restartText
res = defaultHtmlFooter%argD
return res
def ConstructCookieErrorPage(startPage="Init.py"):
""" returns the text for a cookie error page
*(duh)*
"""
page = ConstructHtmlHeader('Error')
args = { 'startPage':startPage }
msg = """
Cookie Error
The tool did not find an appropriate cookie set in your browser.
This could be due to a number of reasons:
You have logged out and tried to resume a previous session.
The tool needs to be able to set a cookie in order to be able to keep track
of you whilst you use it. This cookie is set when you visit the
start page, which is where you must
start each session.
"""%args
page = page + msg
page = page + ConstructHtmlFooter(includeRestart=0)
return page
def PostHtml(req,page):
""" posts (by printing) the html passed in. also sets the content type
"""
if req is not None:
req.content_type = 'text/html'
req.send_http_header()
req.write(page)
else:
print 'Content-type: text/html'
print ''
print page
def PostError(msg):
""" creates an error page
"""
page = ConstructHtmlHeader('Error')
page = page + str(msg)
page = page + ConstructHtmlFooter(includeRestart=0)
PostHtml(None,page)
def FormFromReq(req):
""" returns the _cgi.FieldStorage()_
"""
return cgi.FieldStorage()
def StatusOutput(line):
""" used to do status output when updating web pages...
output is dumped to _sys.stdout_ and then flushed to attempt to disable
buffering.
"""
sys.stdout.write(line)
sys.stdout.flush()
