--- zogiLib/zogiLib.py 2005/10/11 20:06:05 1.58 +++ zogiLib/zogiLib.py 2005/11/08 18:10:10 1.60 @@ -1,22 +1,24 @@ +from AccessControl import ClassSecurityInfo +from Globals import package_home +from OFS.Folder import Folder +from OFS.Image import Image +from OFS.Image import File from OFS.SimpleItem import SimpleItem -from Products.PageTemplates.PageTemplateFile import PageTemplateFile from Products.PageTemplates.PageTemplate import PageTemplate +from Products.PageTemplates.PageTemplateFile import PageTemplateFile from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate -from OFS.Image import Image -from AccessControl import ClassSecurityInfo -import xml.dom.minidom -from OFS.Folder import Folder +from types import * +from Globals import package_home, ImageFile from xml_helpers import getUniqueElementText,getText +import cgi import os +import random import re import string import urllib -from types import * -import random -import cgi -from Globals import package_home +import xml.dom.minidom -ZOGIVERSION = "0.9.15b DW:22.2.2005" +ZOGIVERSION = "0.10.1b ROC 8.11.2005" def cropf(f): """returns a float with reduced precision""" @@ -174,6 +176,46 @@ class zogiLib(Folder): self.dlToolbarBaseURL = dlToolbarBaseURL else: self.dlToolbarBaseURL = dlServerURL + "/digimage.jsp?" + + self.manage_addFolder('template') + + +# form templates + main_book = PageTemplateFile('zpt/main_book', globals()) + main_image = PageTemplateFile('zpt/main_image', globals()) + main_metaData = PageTemplateFile('zpt/main_metadata', globals()) + main_static = PageTemplateFile('zpt/main_static', globals()) + options = PageTemplateFile('zpt/options', globals()) + changeForm = PageTemplateFile('zpt/changeForm', globals()) + +# display templates + aux_divs = PageTemplateFile('zpt/aux_divs', globals()) + aux_divsN4 = PageTemplateFile('zpt/aux_divsN4', globals()) + img_div = PageTemplateFile('zpt/img_div', globals()) + +# javascripts + head_js = PageTemplateFile('zpt/head_js', globals()) + jslib_js = PageTemplateFile('js/baselib.js', globals()) + dllib_js = PageTemplateFile('js/dllib.js', globals()) + +# graphic files + arr_right = ImageFile('images/right.gif', globals()) + arr_left = ImageFile('images/left.gif', globals()) + arr_up = ImageFile('images/up.gif', globals()) + arr_down = ImageFile('images/down.gif', globals()) + mark1 = ImageFile('images/mark1.gif', globals()) + mark2 = ImageFile('images/mark2.gif', globals()) + mark3 = ImageFile('images/mark3.gif', globals()) + mark4 = ImageFile('images/mark4.gif', globals()) + mark5 = ImageFile('images/mark5.gif', globals()) + mark6 = ImageFile('images/mark6.gif', globals()) + mark7 = ImageFile('images/mark7.gif', globals()) + mark8 = ImageFile('images/mark8.gif', globals()) + corner1 = ImageFile('images/olinks.gif', globals()) + corner2 = ImageFile('images/orechts.gif', globals()) + corner3 = ImageFile('images/ulinks.gif', globals()) + corner4 = ImageFile('images/urechts.gif', globals()) + security.declareProtected('View','getLayout') def getLayout(self): @@ -233,7 +275,7 @@ class zogiLib(Folder): sets=xml.dom.minidom.parse(urllib.urlopen(url)).getElementsByTagName('dataset') ret="" - print label + #print label if label: ret+="""%s"""%(viewUrl,label) for set in sets: @@ -300,9 +342,10 @@ class zogiLib(Folder): def getDLInfo(self): """get DLInfo from digilib server""" paramH={} - baseUrl=self.dlServerURL+"/dlInfo-xml.jsp" + baseUrl=self.getDLBaseUrl()+"/dlInfo-xml.jsp" + print "getdlinfo: ", baseUrl try: - url=urllib.urlopen(baseUrl+'?'+self.REQUEST['QUERY_STRING']) + url=urllib.urlopen(baseUrl+'?'+self.getAllDLParams()) dom=xml.dom.minidom.parse(url) params=dom.getElementsByTagName('parameter') for param in params: @@ -312,33 +355,49 @@ class zogiLib(Folder): return {} - def createHeadJS(self): - """generate all javascript tags for head""" - self.checkQuery() - bt = self.REQUEST.SESSION.get('browserType', {}) - if bt['staticHTML']: - return - - pt=PageTemplateFile(os.path.join(package_home(globals()), 'zpt/zogilib_head_js')).__of__(self) - return pt() - - def createParamJS(self): - """generate javascript for parameters only""" - self.checkQuery() - bt = self.REQUEST.SESSION['browserType'] - if bt['staticHTML']: - return + def zogilibPath(self, otherbase=None): + """returns an URL to the zogiLib instance""" + url = self.REQUEST['URL1'] + # should end with "/" + if len(url) > 0 and url[-1] != '/': + url += '/' + if type(otherbase) is str: + url += otherbase + else: + url += self.basePath + # should end with "/" + if len(url) > 0 and url[-1] != '/': + url += '/' + return url - pt=PageTemplateFile(os.path.join(package_home(globals()), 'zpt/zogilib_param_js')).__of__(self) - return pt() + def zogilibAction(self, action, otherbase=None): + """returns a URL with zogilib path and action""" + url = self.zogilibPath(otherbase) + url += action + url += '?' + self.getAllDLParams(); + return url + + def getDLBaseUrl(self): + """returns digilib base URL (sans servlet path)""" + if self.dlServerURL[-1] == '?': + # full Servlet URL -- remove last part + si = self.dlServerURL.rindex('/servlet/') + if si > 0: + return self.dlServerURL[:si] + else: + # no servlet part :-( + return "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary" + else: + return self.dlServerURL - def getScalerUrl(self,requestString=None): + def getScalerUrl(self,requestString=""): """send scaler url""" - if requestString: - return self.dlServerURL+'/servlet/Scaler?'+requestString + if self.dlServerURL[-1] == '?': + # full Servlet URL + return self.dlServerURL + requestString else: - return self.dlServerURL+'/servlet/Scaler?' + return self.dlServerURL+'/servlet/Scaler?'+requestString def scaledImage(self,requestString=None): """scaled Image""" @@ -361,7 +420,7 @@ class zogiLib(Folder): # if not explicitly defined take normal request if not requestString: requestString = self.getAllDLParams() - url = self.dlServerURL+'/servlet/Scaler?'+requestString + url = self.getScalerUrl(requestString=requestString) # construct bottom and side insets b_par = "" s_par = "" @@ -401,236 +460,84 @@ class zogiLib(Folder): pt=PageTemplateFile(os.path.join(package_home(globals()),'zpt/zogilib_img_div')).__of__(self) return pt() - def createAuxDiv(self): - """generate other divs""" - self.checkQuery() - bt = self.REQUEST.SESSION['browserType'] - if bt['staticHTML']: - return - if bt['isN4']: - f = 'zpt/zogilib_divsN4.zpt' - else: - f = 'zpt/zogiLib_divs.zpt' - pt=PageTemplateFile(os.path.join(package_home(globals()),f)).__of__(self) - return pt() - - - def option_js(self): - """javascript""" - return sendFile(self, 'js/option.js', 'text/plain') - - def dl_lib_js(self): - """javascript""" - return sendFile(self, 'js/dllib.js', 'text/plain') - - def js_lib_js(self): - """javascript""" - return sendFile(self, 'js/baselib.js', 'text/plain') - - def optionwindow(self): - """showoptions""" - self.checkQuery() - bt = self.REQUEST.SESSION['browserType'] - if bt['staticHTML']: - pt=PageTemplateFile(os.path.join(package_home(globals()), 'zpt/optionwindow_static.zpt')).__of__(self) - else: - tp = "viewingTools.zpt" - if hasattr(self, tp): - pt = getattr(self, tp) - else: - pt=PageTemplateFile(os.path.join(package_home(globals()), 'zpt/optionwindow.zpt')).__of__(self) - - return pt() - - def mark1(self): - """mark image""" - return sendFile(self, 'images/mark1.gif', 'image/gif') - - def mark2(self): - """mark image""" - return sendFile(self, 'images/mark2.gif', 'image/gif') - - def mark3(self): - """mark image""" - return sendFile(self, 'images/mark3.gif', 'image/gif') - - def mark4(self): - """mark image""" - return sendFile(self, 'images/mark4.gif', 'image/gif') - - def mark5(self): - """mark image""" - return sendFile(self, 'images/mark5.gif', 'image/gif') - - def mark6(self): - """mark image""" - return sendFile(self, 'images/mark6.gif', 'image/gif') - - def mark7(self): - """mark image""" - return sendFile(self, 'images/mark7.gif', 'image/gif') - - def mark8(self): - """mark image""" - return sendFile(self, 'images/mark8.gif', 'image/gif') - - def corner1(self): - """mark image""" - return sendFile(self, 'images/olinks.gif', 'image/gif') - - def corner2(self): - """mark image""" - return sendFile(self, 'images/orechts.gif', 'image/gif') - - def corner3(self): - """mark image""" - return sendFile(self, 'images/ulinks.gif', 'image/gif') - - def corner4(self): - """mark image""" - return sendFile(self, 'images/urechts.gif', 'image/gif') - - def up_img(self): - """mark image""" - return sendFile(self, 'images/up.gif', 'image/gif') - - def down_img(self): - """mark image""" - return sendFile(self, 'images/down.gif', 'image/gif') - - def left_img(self): - """mark image""" - return sendFile(self, 'images/left.gif', 'image/gif') - - def right_img(self): - """mark image""" - return sendFile(self, 'images/right.gif', 'image/gif') - - - def index_html(self): """main action""" self.checkQuery() - bt = self.REQUEST.SESSION['browserType'] - tp = "zogiLibMainTemplate" + tp = "main_template" + tpt = self.layout - if hasattr(self, tp): - pt = getattr(self, tp) - else: - tpt = self.layout - - if bt['staticHTML']: - tpt = "static" - - pt=PageTemplateFile(os.path.join(package_home(globals()), 'zpt/zogiLibMain_%s'%tpt)).__of__(self) + if not hasattr(self, 'template'): + # create template folder if it doesn't exist + print "no template folder" + self.manage_addFolder('template') + print "template!" + pt = getattr(self.template, 'main_'+tpt) return pt() + def checkQuery(self): + """make shure that the query has been saved""" + if not self.REQUEST.has_key('dlParams'): + self.storeQuery() + if not self.REQUEST.SESSION.has_key('browserType'): + bt = browserCheck(self) + self.REQUEST.SESSION.set('browserType', bt) - def storeQuery(self, more = None): - """storeQuery in session""" - dlParams = {} + def storeQuery(self, more=None, withpt=False): + """parse query parameters into a hash in REQUEST""" + params = {} for fm in self.REQUEST.form.keys(): - dlParams[fm] = self.REQUEST.form[fm] + params[fm] = self.REQUEST.form[fm] # look for more if more: for fm in more.split('&'): try: pv = fm.split('=') - dlParams[pv[0]] = pv[1] + params[pv[0]] = pv[1] except: pass # parse digilib mode parameter - if 'mo' in dlParams: - if len(dlParams['mo']) > 0: - modes=dlParams['mo'].split(',') - else: - modes=[] - - wid = self.getWID() - self.REQUEST.set('wid', wid) - self.setSubSession('dlQuery', dlParams) - self.setSubSession('dlModes', modes) - self.setSubSession('dlInfo', self.getDLInfo()) - if not self.REQUEST.SESSION.has_key('browserType'): - self.REQUEST.SESSION['browserType'] = browserCheck(self) - - return - - def checkQuery(self): - """check if the query has been stored""" - if not (self.REQUEST.SESSION and self.getSubSession('dlQuery')) : - print "ZOGILIB: have to store query!!" - self.storeQuery() - return - - def zogilibPath(self, otherbase=None): - """returns an URL to the zogiLib instance""" - url = self.REQUEST['URL1'] - # should end with "/" - if len(url) > 0 and url[-1] != '/': - url += '/' - if type(otherbase) is str: - url += otherbase - else: - url += self.basePath - # should end with "/" - if len(url) > 0 and url[-1] != '/': - url += '/' - return url - - def zogilibAction(self, action, otherbase=None, wid=None): - """returns a URL with zogilib path, action and wid""" - url = self.zogilibPath(otherbase) - url += action - if wid: - url += '?wid=' + wid + if 'mo' in params: + if len(params['mo']) > 0: + modes=params['mo'].split(',') else: - url += '?wid=' + self.getWID() - return url + modes = []; - def getSubSession(self, key, default=None): - """returns an element from a session with a wid""" - wid = self.getWID() - return self.REQUEST.SESSION.get(key+'_'+wid, default) - - def setSubSession(self, key, value): - """puts an element in a session with a wid""" - wid = self.getWID() - self.REQUEST.SESSION.set(key+'_'+wid, value) - return - - def getWID(self): - """returns a (new) window id""" - wid = self.REQUEST.get('wid') - if not wid: - wid = 'digi_'+str(int(random.random()*10000)) - print "new WID:", wid - return wid + self.REQUEST.set('dlParams', params) + self.REQUEST.set('dlModes', modes) + # trigger get pt (from dlInfo) if requested + if withpt: + pt = self.getPT() + + return params + + def getDLParam(self, param, default=None): """returns parameter or default""" + self.checkQuery() + dlParams = self.REQUEST.get('dlParams') try: - return self.getSubSession('dlQuery').get(param, default) + return dlParams[param] except: return default def setDLParam(self, param, value): """sets parameter""" - dlParams = self.getSubSession('dlQuery') - #try: + self.checkQuery() + dlParams = self.REQUEST.get('dlParams') dlParams[param] = value - #except: - # self.setSubSession('dlQuery', {param: value}) return def getAllDLParams(self): """parameter string for digilib""" - dlParams = self.getSubSession('dlQuery') + self.checkQuery() + dlParams = self.REQUEST.get('dlParams') # save modes - modes = self.getSubSession('dlModes') - dlParams['mo'] = string.join(modes, ',') + modes = self.REQUEST.get('dlModes') + if modes: + dlParams['mo'] = string.join(modes, ',') # assemble query string ret = "" for param in dlParams.keys(): @@ -641,7 +548,6 @@ class zogiLib(Folder): # omit trailing "&" return ret.rstrip('&') - def setDLParams(self,pn=None,ws=None,rot=None,brgt=None,cont=None): """setze Parameter""" @@ -661,10 +567,6 @@ class zogiLib(Folder): def display(self): """(re)display page""" - if not self.getDLParam('wid'): - wid = self.getWID() - self.setDLParam('wid', wid) - params = self.getAllDLParams() if self.basePath: @@ -694,53 +596,28 @@ class zogiLib(Folder): # s += "_" + self.getDLParam('pn') return s - def setStaticHTML(self, static=True): - """sets the preference to static HTML""" - self.checkQuery() - self.REQUEST.SESSION['browserType']['staticHTML'] = static - return - - def isStaticHTML(self): - """returns if the page is using static HTML only""" - self.checkQuery() - return self.REQUEST.SESSION['browserType']['staticHTML'] - + def getPN(self): + """pagenums""" + pn = int(self.getDLParam('pn', 1)) + return pn + def getPT(self): """pagenums""" - di = self.getSubSession('dlInfo') - if di: - return int(di['pt']) - else: - return 1 + pt = self.getDLParam('pt', None) + if pt is None: + # get pt from dlInfo + if self.REQUEST.has_key('dlInfo'): + info = self.REQUEST.get('dlInfo') + else: + info = self.getDLInfo() + self.REQUEST.set('dlInfo', info) + pt = int(info.get('pt', 1)) + self.setDLParam('pt', pt) + return int(pt) - def getPN(self): - """Pagenum""" - pn = self.getDLParam('pn') - try: - return int(pn) - except: - return 1 - - def getBiggerWS(self): - """ws+1""" - ws = self.getDLParam('ws') - try: - return float(ws)+0.5 - except: - return 1.5 - - def getSmallerWS(self): - """ws-1""" - ws=self.getDLParam('ws') - try: - return max(float(ws)-0.5, 1) - except: - return 1 - def hasMode(self, mode): """returns if mode is in the diglib mo parameter""" - wid = self.getWID() - return (mode in self.REQUEST.SESSION['dlModes_'+wid]) + return (mode in self.REQUEST.get('dlModes')) def hasNextPage(self): """returns if there is a next page""" @@ -911,16 +788,6 @@ class zogiLib(Folder): self.setDLParam('mk', None) return self.display() - def dl_Unmark(self): - """action to remove last mark""" - mk = self.getDLParam('mk') - if mk: - marks = mk.split(',') - marks.pop() - mk = string.join(marks, ',') - self.setDLParam('mk', mk) - return self.display() - def dl_db(self,db): """set db""" self.setDLParam('db',db)