#!/usr/bin/env python
"""
web_lib.py - Yet another library of common Web-related functions.
Exposes:
* Template() - HTML template filling class
* safe_write() - cache-friendly file writing
* make_date_dropdown() - generate a triple box for dates
* process_date_dropdown() - process the result of make_date_dropdown()
* http_header() - generate HTTP headers for CGI
* header() - generic HTML header (with CSS link)
* footer() - generic HTML footer
"""
__license__ = """
Copyright (c) 1999 Mark Nottingham
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Usage:
Use just as you would a xml.sax parser. ContentHandlers can have one extra
method, binary(), which is called when binary content is available. If binary()
is not defined, characters() will be, with the appropriate (encoded) content.
Note that even when you define binary(), you should still allow for such content
to be handled by characters(), in case it isn't binary in the XOP Package.
"""
__version__ = '0.51'
from string import join
import UserList
class Template:
"""
Template-filling class.
Instantised with the name of the template file,
it will substitute all instances of with it's value (attr
must be all uppercase and spaceless in template).
If the attribute is an integer, its truth determines whether the
content between a <--XX--> <--/XX--> tag pair is shown.
"""
def __init__(self, file):
fh = open(file, 'r')
self.__template_html = fh.read()
fh.close()
self.__objlist = [self]
def add_object(self, object):
self.__objlist.append(object)
def __repr__(self):
import string, re
from types import StringType, InstanceType, IntType
tmpl = self.__template_html
for obj in self.__objlist:
for key, value in obj.__dict__.items():
if key[:1] == '__':
continue
key = string.upper(key)
if type(value) == StringType:
tmpl = string.replace(tmpl, "" % (key), value)
elif type(value) == InstanceType:
tmpl = string.replace(tmpl, "" % (key), repr(value))
elif type(value) == IntType:
if not value:
self._pat = re.compile('.*?' % (key, key),
re.DOTALL)
tmpl = self._pat.sub('', tmpl)
return tmpl
class Select(UserList.UserList):
def __init__(self, name, data=[], selected=None):
UserList.UserList.__init__(self, data)
self.name = name
self.selected = selected
def __repr__(self):
r = ["" % (self.name)]
for item in self.data:
if item == self.selected:
selected = ' SELECTED'
else:
selected = ''
r.append(" %s " % (selected, item))
r.append("")
return join(r, '\n')
def safe_write(file, data):
"""
Write the data to the file only if it is different. This makes for
better caching, since it won't change the Last-Modified date unless
necessary.
This function has been superceded by safe_write.py.
"""
try:
fh = open(file, 'r')
cur_data = fh.read()
fh.close()
except IOError:
cur_data = None
if cur_data != data:
fh = open(file, 'w')
fh.write(data)
fh.close()
def make_date_dropdown(date=0, prefix=''):
"""
Given an epoch time, and an optional prefix, return a string to make
a HTML section for the date.
"""
from time import localtime, strftime
(year, month, day, hour, min, sec, weekday, julday, dst) = localtime(date)
d = ''
startyear = 1995
endyear = 2005
SELECTED = ' SELECTED'
d = d + '\n' % (prefix)
for i in range(1, 31):
if i == day: s = SELECTED
else: s = ''
d = d + ' %s\n' % (s, i, i)
d = d + ' \n'
d = d + '\n' % (prefix)
for i in range(1, 12):
if i == month: s = SELECTED
else: s = ''
d = d + ' %s\n' % \
(s, i, strftime("%b", (0,i,0,0,0,0,0,0,0)))
d = d + ' \n'
d = d + '\n' % (prefix)
for i in range(startyear, endyear):
if i == year: s = SELECTED
else: s = ''
d = d + ' %s\n' % (s, i, i)
d = d + ' \n'
return d
def process_date_dropdown(hash, prefix=''):
"""
Given a hash of CGI variables, and an optional prefix for day, month
and year in it, send back a epoch time.
Raises a KeyError (with the offending key) if one is missing, or a
ValueError for invalid input.
"""
from time import mktime
from string import atoi
try:
day = hash[prefix + 'day']
except KeyError:
raise KeyError, 'day'
try:
month = hash[prefix + 'month']
except KeyError:
raise KeyError, 'month'
try:
year = hash[prefix + 'year']
except KeyError:
raise KeyError, 'year'
try:
return mktime(atoi(year), atoi(month), atoi(day), 0, 0, 0, 0, 0, 0)
except OverFlowError:
raise ValueError
def http_header(dict = {}):
h = "Content-type: text/html\n"
for header, value in dict.items():
h = h + "%s: %s\n" % (header, value)
h = h + "\n"
return h
def header(title='', stylesheet=''):
return """\
%s