--- documentViewer/documentViewer.py 2005/12/18 12:35:02 1.1 +++ documentViewer/documentViewer.py 2011/08/10 19:18:03 1.175.2.23 @@ -1,293 +1,850 @@ - -genericDigilib="http://nausikaa2.rz-berlin.mpg.de/digitallibrary/" - from OFS.Folder import Folder from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate -from Products.PageTemplates.PageTemplateFile import PageTemplateFile +from Products.PageTemplates.PageTemplateFile import PageTemplateFile from AccessControl import ClassSecurityInfo +from AccessControl import getSecurityManager from Globals import package_home -from Ft.Xml.Domlette import NonvalidatingReader -from Ft.Xml.Domlette import PrettyPrint, Print -from Ft.Xml import EMPTY_NAMESPACE +#from Ft.Xml import EMPTY_NAMESPACE, Parse +#import Ft.Xml.Domlette -import Ft.Xml.XPath +import xml.etree.ElementTree as ET import os.path -import cgi +import sys import urllib - -def getTextFromNode(nodename): - nodelist=nodename.childNodes - rc = "" - for node in nodelist: - if node.nodeType == node.TEXT_NODE: - rc = rc + node.data - return rc - -import socket - -def urlopen(url): - """urlopen mit timeout""" - socket.setdefaulttimeout(2) - ret=urllib.urlopen(url) - socket.setdefaulttimeout(5) - return ret +import logging +import math +import urlparse +import re +import string + +from SrvTxtUtils import getInt, getText, getHttpData + +def logger(txt,method,txt2): + """logging""" + logging.info(txt+ txt2) + + +def serializeNode(node, encoding="utf-8"): + """returns a string containing node as XML""" + s = ET.tostring(node) + + # 4Suite: + # stream = cStringIO.StringIO() + # Ft.Xml.Domlette.Print(node, stream=stream, encoding=encoding) + # s = stream.getvalue() + # stream.close() + return s + +def browserCheck(self): + """check the browsers request to find out the browser type""" + bt = {} + ua = self.REQUEST.get_header("HTTP_USER_AGENT") + bt['ua'] = ua + bt['isIE'] = False + bt['isN4'] = False + bt['versFirefox']="" + bt['versIE']="" + bt['versSafariChrome']="" + bt['versOpera']="" -def getParamFromDigilib(path,param): - """gibt param von dlInfo aus""" - imageUrl=genericDigilib+"/dlInfo-xml.jsp?fn="+path - + if string.find(ua, 'MSIE') > -1: + bt['isIE'] = True + else: + bt['isN4'] = (string.find(ua, 'Mozilla/4.') > -1) + # Safari oder Chrome identification try: - dom = NonvalidatingReader.parseUri(imageUrl) - except: - return None - - - params=dom.xpath("//document-parameters/parameter[@name='%s']/@value"%param) - - if params: - return params[0].value - -def parseUrlTextTool(url): - """parse index meta""" - - try: - dom = NonvalidatingReader.parseUri(url) - except: - zLOG.LOG("documentViewer (parseUrlTexttool)", zLOG.INFO,"%s (%s)"%sys.exc_info()[0:2]) - return (None,None,None) - - archivePaths=dom.xpath("//resource/archive-path") - - if archivePaths and (len(archivePaths)>0): - archivePath=getTextFromNode(archivePaths[0]) - else: - archivePath=None - - - images=dom.xpath("//texttool/image") - - if images and (len(images)>0): - image=getTextFromNode(images[0]) - else: - image=None - - if image and archivePath: - image=os.path.join(archivePath,image) - image=image.replace("/mpiwg/online",'') - pt=getParamFromDigilib(image,'pt') - - else: - image=None - - viewerUrls=dom.xpath("//texttool/digiliburlprefix") - - if viewerUrls and (len(viewerUrls)>0): - viewerUrl=getTextFromNode(viewerUrls[0]) - else: - viewerUrl=None - - - textUrls=dom.xpath("//texttool/text") - - if textUrls and (len(textUrls)>0): - textUrl=getTextFromNode(textUrls[0]) - else: - textUrl=None - return viewerUrl,(image,pt),textUrl - - -class documentViewer(ZopePageTemplate): + nav = ua[string.find(ua, '('):] + nav1=ua[string.find(ua,')'):] + nav2=nav1[string.find(nav1,'('):] + nav3=nav2[string.find(nav2,')'):] + ie = string.split(nav, "; ")[1] + ie1 =string.split(nav1, " ")[2] + ie2 =string.split(nav3, " ")[1] + ie3 =string.split(nav3, " ")[2] + if string.find(ie3, "Safari") >-1: + bt['versSafariChrome']=string.split(ie2, "/")[1] + except: pass + # IE identification + try: + nav = ua[string.find(ua, '('):] + ie = string.split(nav, "; ")[1] + if string.find(ie, "MSIE") > -1: + bt['versIE'] = string.split(ie, " ")[1] + except:pass + # Firefox identification + try: + nav = ua[string.find(ua, '('):] + nav1=ua[string.find(ua,')'):] + if string.find(ie1, "Firefox") >-1: + nav5= string.split(ie1, "/")[1] + logging.debug("FIREFOX: %s"%(nav5)) + bt['versFirefox']=nav5[0:3] + except:pass + #Opera identification + try: + if string.find(ua,"Opera") >-1: + nav = ua[string.find(ua, '('):] + nav1=nav[string.find(nav,')'):] + bt['versOpera']=string.split(nav1,"/")[2] + except:pass + + bt['isMac'] = string.find(ua, 'Macintosh') > -1 + bt['isWin'] = string.find(ua, 'Windows') > -1 + bt['isIEWin'] = bt['isIE'] and bt['isWin'] + bt['isIEMac'] = bt['isIE'] and bt['isMac'] + bt['staticHTML'] = False + + return bt + +def getParentPath(path, cnt=1): + """returns pathname shortened by cnt""" + # make sure path doesn't end with / + path = path.rstrip('/') + # split by /, shorten, and reassemble + return '/'.join(path.split('/')[0:-cnt]) + + +## +## documentViewer class +## +class documentViewer(Folder): """document viewer""" - meta_type="Document viewer" security=ClassSecurityInfo() - manage_options=ZopePageTemplate.manage_options+( + manage_options=Folder.manage_options+( {'label':'main config','action':'changeDocumentViewerForm'}, ) + + metadataService = None + """MetaDataFolder instance""" + + # templates and forms + viewer_main = PageTemplateFile('zpt/viewer_main', globals()) + toc_thumbs = PageTemplateFile('zpt/toc_thumbs', globals()) + toc_text = PageTemplateFile('zpt/toc_text', globals()) + toc_figures = PageTemplateFile('zpt/toc_figures', globals()) + page_main_images = PageTemplateFile('zpt/page_main_images', globals()) + page_main_double = PageTemplateFile('zpt/page_main_double', globals()) + page_main_text = PageTemplateFile('zpt/page_main_text', globals()) + page_main_text_dict = PageTemplateFile('zpt/page_main_text_dict', globals()) + page_main_gis =PageTemplateFile ('zpt/page_main_gis', globals()) + page_main_xml = PageTemplateFile('zpt/page_main_xml', globals()) + page_main_pureXml = PageTemplateFile('zpt/page_main_pureXml', globals()) + head_main = PageTemplateFile('zpt/head_main', globals()) + docuviewer_css = PageTemplateFile('css/docuviewer.css', globals()) + info_xml = PageTemplateFile('zpt/info_xml', globals()) + + + thumbs_main_rss = PageTemplateFile('zpt/thumbs_main_rss', globals()) - _default_content_fn = os.path.join(package_home(globals()),'zpt','documentViewer_template.zpt') - def __init__(self,id,imageViewerUrl,title=""): + def __init__(self,id,imageScalerUrl=None,textServerName=None,title="",digilibBaseUrl=None,thumbcols=2,thumbrows=5,authgroups="mpiwg"): """init document viewer""" self.id=id self.title=title - self.imageViewerUrl=imageViewerUrl - - security.declareProtected('View management screens','changeDocumentViewerForm') - def changeDocumentViewerForm(self): - """change it""" - pt=PageTemplateFile(os.path.join(package_home(globals()),'zpt','changeDocumentViewer.zpt')).__of__(self) - return pt() - - - def changeDocumentViewer(self,imageViewerUrl,title="",RESPONSE=None): - """init document viewer""" - self.title=title - self.imageViewerUrl=imageViewerUrl + self.thumbcols = thumbcols + self.thumbrows = thumbrows + # authgroups is list of authorized groups (delimited by ,) + self.authgroups = [s.strip().lower() for s in authgroups.split(',')] + # create template folder so we can always use template.something + + templateFolder = Folder('template') + #self['template'] = templateFolder # Zope-2.12 style + self._setObject('template',templateFolder) # old style + try: + import MpdlXmlTextServer + textServer = MpdlXmlTextServer.MpdlXmlTextServer(id='fulltextclient',serverName=textServerName) + #templateFolder['fulltextclient'] = xmlRpcClient + templateFolder._setObject('fulltextclient',textServer) + except Exception, e: + logging.error("Unable to create MpdlXmlTextServer for fulltextclient: "+str(e)) + + try: + from Products.zogiLib.zogiLib import zogiLib + zogilib = zogiLib(id="zogilib", title="zogilib for docuviewer", dlServerURL=imageScalerUrl, layout="book") + #templateFolder['zogilib'] = zogilib + templateFolder._setObject('zogilib',zogilib) + except Exception, e: + logging.error("Unable to create zogiLib for zogilib: "+str(e)) + + try: + # assume MetaDataFolder instance is called metadata + self.metadataService = getattr(self, 'metadata') + except Exception, e: + logging.error("Unable to find MetaDataFolder 'metadata': "+str(e)) + + if digilibBaseUrl is not None: + self.digilibBaseUrl = digilibBaseUrl + - if RESPONSE is not None: - RESPONSE.redirect('manage_main') - + # proxy text server methods to fulltextclient + def getTextPage(self, **args): + """get page""" + return self.template.fulltextclient.getTextPage(**args) + + def getOrigPages(self, **args): + """get page""" + return self.template.fulltextclient.getOrigPages(**args) + + def getOrigPagesNorm(self, **args): + """get page""" + return self.template.fulltextclient.getOrigPagesNorm(**args) + + def getQuery(self, **args): + """get query in search""" + return self.template.fulltextclient.getQuery(**args) + + def getSearch(self, **args): + """get search""" + return self.template.fulltextclient.getSearch(**args) + + def getGisPlaces(self, **args): + """get gis places""" + return self.template.fulltextclient.getGisPlaces(**args) + + def getAllGisPlaces(self, **args): + """get all gis places """ + return self.template.fulltextclient.getAllGisPlaces(**args) + + def getTranslate(self, **args): + """get translate""" + return self.template.fulltextclient.getTranslate(**args) + + def getLemma(self, **args): + """get lemma""" + return self.template.fulltextclient.getLemma(**args) + + def getLemmaQuery(self, **args): + """get query""" + return self.template.fulltextclient.getLemmaQuery(**args) + + def getLex(self, **args): + """get lex""" + return self.template.fulltextclient.getLex(**args) + + def getToc(self, **args): + """get toc""" + return self.template.fulltextclient.getToc(**args) + + def getTocPage(self, **args): + """get tocpage""" + return self.template.fulltextclient.getTocPage(**args) + - def imageLink(self,nr): - """link hinter den images""" - paramsTmp=cgi.parse_qs(self.REQUEST['QUERY_STRING']) - params={} - for x in paramsTmp.iteritems(): - params[x[0]]=x[1][0] - - params['pn']=nr - newUrl=self.REQUEST['URL']+"?"+urllib.urlencode(params) - return newUrl + security.declareProtected('View','thumbs_rss') + def thumbs_rss(self,mode,url,viewMode="auto",start=None,pn=1): + ''' + view it + @param mode: defines how to access the document behind url + @param url: url which contains display information + @param viewMode: if images display images, if text display text, default is images (text,images or auto) + ''' + logging.debug("HHHHHHHHHHHHHH:load the rss") + logging.debug("documentViewer (index) mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn)) - def thumbruler(self,cols,rows,start,maximum): - """ruler for thumbs""" - ret="" - paramsTmp=cgi.parse_qs(self.REQUEST['QUERY_STRING']) - params={} - for x in paramsTmp.iteritems(): - - if not x[0]=="start": - params[x[0]]=x[1][0] - - newUrlSelect=self.REQUEST['URL']+"?"+urllib.urlencode(params) - if start>0: - newStart=max(start-cols*rows,0) - params['start']=newStart - newUrl=self.REQUEST['URL']+"?"+urllib.urlencode(params) - ret+="""prev"""%newUrl - - - ret+="""" - - if startnext"""%newUrl + viewMode="images" + + return pt(docinfo=docinfo,pageinfo=pageinfo,viewMode=viewMode) + + + security.declareProtected('View','index_html') + def index_html(self,url,mode="texttool",viewMode="auto",viewType=None,tocMode="thumbs",start=1,pn=1): + """ + view page + @param url: url which contains display information + @param mode: defines how to access the document behind url + @param viewMode: 'images': display images, 'text': display text, default is 'auto' + @param viewType: sub-type of viewMode, e.g. 'dict' for viewMode='text' + @param tocMode: type of 'table of contents' for navigation (thumbs, text, figures, none) + """ - return ret + logging.debug("documentViewer(index_html) mode=%s url=%s viewMode=%s viewType=%s start=%s pn=%s"%(mode,url,viewMode,viewType,start,pn)) - def textToolThumb(self,url,start=0): - """understands the texttool format - @param url: url to index.meta with texttool tag - """ - (viewerUrl,imagepath,textpath)=parseUrlTextTool(url) + if not hasattr(self, 'template'): + # this won't work + logging.error("template folder missing!") + return "ERROR: template folder missing!" + + if not getattr(self, 'digilibBaseUrl', None): + self.digilibBaseUrl = self.findDigilibUrl() or "http://digilib.mpiwg-berlin.mpg.de/digitallibrary" + + docinfo = self.getDocinfo(mode=mode,url=url) - imageUrl=genericDigilib+"/servlet/Scaler?fn=%s"%imagepath[0] + if tocMode != "thumbs": + # get table of contents + docinfo = self.getToc(mode=tocMode, docinfo=docinfo) + + # auto viewMode: text if there is a text else images + if viewMode=="auto": + if docinfo.get('textURL', None) or docinfo.get('textURLPath', None): + viewMode = "text" + viewType = "dict" + else: + viewMode = "images" + + elif viewMode == "text_dict": + # legacy fix + viewMode = "text" + viewType = "dict" + + # stringify viewType + if isinstance(viewType, list): + viewType = ','.join([t for t in viewType if t]) + + pageinfo = self.getPageinfo(start=start, current=pn, docinfo=docinfo, viewMode=viewMode, viewType=viewType, tocMode=tocMode) + + # get template /template/viewer_$viewMode + pt = getattr(self.template, 'viewer_%s'%viewMode, None) + if pt is None: + logging.error("No template for viewMode=%s!"%viewMode) + # TODO: error page? + return "No template for viewMode=%s!"%viewMode - pt=PageTemplateFile(os.path.join(package_home(globals()),'zpt','thumbs.zpt')).__of__(self) - return pt(imageUrl=imageUrl,pt=imagepath[1],start=start) + # and execute with parameters + return pt(docinfo=docinfo, pageinfo=pageinfo) + + def generateMarks(self,mk): + ret="" + if mk is None: + return "" + if not isinstance(mk, list): + mk=[mk] + for m in mk: + ret+="mk=%s"%m + return ret - def text(self,mode,url,pn): - """give text""" - if mode=="texttool": #index.meta with texttool information - (viewerUrl,imagepath,textpath)=parseUrlTextTool(url) - - print textpath - try: - dom = NonvalidatingReader.parseUri(textpath) - except: - return None - list=[] - nodes=dom.xpath("//pb") + def getBrowser(self): + """getBrowser the version of browser """ + bt = browserCheck(self) + logging.debug("BROWSER VERSION: %s"%(bt)) + return bt + + def findDigilibUrl(self): + """try to get the digilib URL from zogilib""" + url = self.template.zogilib.getDLBaseUrl() + return url + + def getDocumentViewerURL(self): + """returns the URL of this instance""" + return self.absolute_url() + + def getStyle(self, idx, selected, style=""): + """returns a string with the given style and append 'sel' if path == selected.""" + #logger("documentViewer (getstyle)", logging.INFO, "idx: %s selected: %s style: %s"%(idx,selected,style)) + if idx == selected: + return style + 'sel' + else: + return style + + def getParams(self, param=None, val=None, params=None): + """returns dict with URL parameters. + + Takes URL parameters and additionally param=val or dict params. + Deletes key if value is None.""" + # copy existing request params + newParams=self.REQUEST.form.copy() + # change single param + if param is not None: + if val is None: + if newParams.has_key(param): + del newParams[param] + else: + newParams[param] = str(val) + + # change more params + if params is not None: + for k in params.keys(): + v = params[k] + if v is None: + # val=None removes param + if newParams.has_key(k): + del newParams[k] + + else: + newParams[k] = v + + return newParams + + def getLink(self, param=None, val=None, params=None, baseUrl=None, paramSep='&'): + """returns URL to documentviewer with parameter param set to val or from dict params""" + urlParams = self.getParams(param=param, val=val, params=params) + # quote values and assemble into query string (not escaping '/') + ps = paramSep.join(["%s=%s"%(k,urllib.quote_plus(unicode(v),'/')) for (k, v) in urlParams.items()]) + if baseUrl is None: + baseUrl = self.getDocumentViewerURL() + + url = "%s?%s"%(baseUrl, ps) + return url - node=nodes[int(pn)-1] - - p=node - - while p.tagName!="p": - p=p.parentNode - - - endNode=nodes[int(pn)] - - - e=endNode - - while e.tagName!="p": - e=e.parentNode - - - next=node.parentNode - - #sammle s - while next and (next!=endNode.parentNode): - list.append(next) - next=next.nextSibling - list.append(endNode.parentNode) - - if p==e:# beide im selben paragraphen - - else: - next=p - while next!=e: - print next,e - list.append(next) - next=next.nextSibling - - for x in list: - PrettyPrint(x) - - return list - - def image(self,mode,url,pn): - """give image out""" - if mode=="texttool": #index.meta with texttool information - (viewerUrl,imagepath,textpath)=parseUrlTextTool(url) - url=viewerUrl+"pn=%s&fn=%s"%(pn,imagepath[0]) - ret="""