--- documentViewer/documentViewer.py 2008/11/04 22:03:56 1.37 +++ documentViewer/documentViewer.py 2011/08/02 10:35:05 1.175.2.14 @@ -1,5 +1,3 @@ - - from OFS.Folder import Folder from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate from Products.PageTemplates.PageTemplateFile import PageTemplateFile @@ -7,58 +5,105 @@ from AccessControl import ClassSecurityI 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, Parse +#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 sys -import cgi import urllib import logging import math - import urlparse -from types import * +import re +import string + +from SrvTxtUtils import getInt, getText, getHttpData + def logger(txt,method,txt2): """logging""" logging.info(txt+ txt2) -def getInt(number, default=0): - """returns always an int (0 in case of problems)""" +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']="" + + if string.find(ua, 'MSIE') > -1: + bt['isIE'] = True + else: + bt['isN4'] = (string.find(ua, 'Mozilla/4.') > -1) + # Safari oder Chrome identification try: - return int(number) - except: - return int(default) - -def getTextFromNode(nodename): - """get the cdata content of a node""" - if nodename is None: - return "" - nodelist=nodename.childNodes - rc = "" - for node in nodelist: - if node.nodeType == node.TEXT_NODE: - rc = rc + node.data - return rc - - -def getParentDir(path): - """returns pathname shortened by one""" - return '/'.join(path.split('/')[0:-1]) - - -import socket - -def urlopen(url,timeout=2): - """urlopen mit timeout""" - socket.setdefaulttimeout(timeout) - ret=urllib.urlopen(url) - socket.setdefaulttimeout(5) - return ret + 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]) ## @@ -66,47 +111,126 @@ def urlopen(url,timeout=2): ## class documentViewer(Folder): """document viewer""" - #textViewerUrl="http://127.0.0.1:8080/HFQP/testXSLT/getPage?" - meta_type="Document viewer" security=ClassSecurityInfo() manage_options=Folder.manage_options+( {'label':'main config','action':'changeDocumentViewerForm'}, ) + + metadataService = None + """MetaDataFolder instance""" # templates and forms viewer_main = PageTemplateFile('zpt/viewer_main', globals()) - thumbs_main = PageTemplateFile('zpt/thumbs_main', globals()) - image_main = PageTemplateFile('zpt/image_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()) - security.declareProtected('View management screens','changeDocumentViewerForm') - changeDocumentViewerForm = PageTemplateFile('zpt/changeDocumentViewer', globals()) - def __init__(self,id,imageViewerUrl,textViewerUrl=None,title="",digilibBaseUrl=None,thumbcols=2,thumbrows=10,authgroups="mpiwg"): + 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 - self.textViewerUrl=textViewerUrl - - if not digilibBaseUrl: - self.digilibBaseUrl = self.findDigilibUrl() - else: - self.digilibBaseUrl = digilibBaseUrl self.thumbcols = thumbcols self.thumbrows = thumbrows # authgroups is list of authorized groups (delimited by ,) self.authgroups = [s.strip().lower() for s in authgroups.split(',')] - # add template folder so we can always use template.something - self.manage_addFolder('template') - + # 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)) + + + # 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) + security.declareProtected('View','thumbs_rss') def thumbs_rss(self,mode,url,viewMode="auto",start=None,pn=1): ''' @@ -116,8 +240,8 @@ class documentViewer(Folder): @param viewMode: if images display images, if text display text, default is images (text,images or auto) ''' - logging.info("HHHHHHHHHHHHHH:load the rss") - logger("documentViewer (index)", logging.INFO, "mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn)) + logging.debug("HHHHHHHHHHHHHH:load the rss") + logging.debug("documentViewer (index) mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn)) if not hasattr(self, 'template'): # create template folder if it doesn't exist @@ -127,92 +251,144 @@ class documentViewer(Folder): self.digilibBaseUrl = self.findDigilibUrl() or "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary" docinfo = self.getDocinfo(mode=mode,url=url) - pageinfo = self.getPageinfo(start=start,current=pn,docinfo=docinfo) + #pageinfo = self.getPageinfo(start=start,current=pn,docinfo=docinfo) + pageinfo = self.getPageinfo(start=start,current=pn, docinfo=docinfo) + ''' ZDES ''' pt = getattr(self.template, 'thumbs_main_rss') if viewMode=="auto": # automodus gewaehlt - if docinfo.get("textURL",'') and self.textViewerUrl: #texturl gesetzt und textViewer konfiguriert + if docinfo.has_key("textURL") or docinfo.get('textURLPath',None): #texturl gesetzt und textViewer konfiguriert viewMode="text" else: viewMode="images" return pt(docinfo=docinfo,pageinfo=pageinfo,viewMode=viewMode) + security.declareProtected('View','index_html') - def index_html(self,mode,url,viewMode="auto",start=None,pn=1,mk=None): - ''' + def index_html(self,url,mode="texttool",viewMode="auto",tocMode="thumbs",start=None,pn=1,mk=None): + """ 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) - - ''' + @param viewMode: if images display images, if text display text, default is auto (text,images or auto) + @param tocMode: type of 'table of contents' for navigation (thumbs, text, figures, none) + """ - logger("documentViewer (index)", logging.INFO, "mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn)) + logging.debug("documentViewer (index) mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn)) if not hasattr(self, 'template'): - # create template folder if it doesn't exist - self.manage_addFolder('template') + # this won't work + logging.error("template folder missing!") + return "ERROR: template folder missing!" - if not self.digilibBaseUrl: - self.digilibBaseUrl = self.findDigilibUrl() or "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary" + 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) - pageinfo = self.getPageinfo(start=start,current=pn,docinfo=docinfo) - pt = getattr(self.template, 'viewer_main') - if viewMode=="auto": # automodus gewaehlt - if docinfo.get("textURL",'') and self.textViewerUrl: #texturl gesetzt und textViewer konfiguriert - viewMode="text" + if tocMode != "thumbs": + # get table of contents + docinfo = self.getToc(mode=tocMode, docinfo=docinfo) + + # auto viewMode: text_dict if text else images + if viewMode=="auto": + if docinfo.get('textURL', None) or docinfo.get('textURLPath', None): + viewMode="text_dict" else: viewMode="images" - - return pt(docinfo=docinfo,pageinfo=pageinfo,viewMode=viewMode,mk=self.generateMarks(mk)) + + pageinfo = self.getPageinfo(start=start, current=pn, docinfo=docinfo, viewMode=viewMode, tocMode=tocMode) + + if viewMode != 'images' and docinfo.get('textURLPath', None): + # get full text page + page = self.getTextPage(mode=viewMode, pn=pn, docinfo=docinfo, pageinfo=pageinfo) + pageinfo['textPage'] = page + + # get template /template/viewer_main + pt = getattr(self.template, 'viewer_main') + # and execute with parameters + return pt(docinfo=docinfo, pageinfo=pageinfo, viewMode=viewMode, mk=self.generateMarks(mk)) def generateMarks(self,mk): ret="" - if mk is None: - return "" - - if type(mk) is not ListType: - mk=[mk] + if mk is None: + return "" + if not isinstance(mk, list): + mk=[mk] for m in mk: ret+="mk=%s"%m return ret - def getLink(self,param=None,val=None): - """link to documentviewer with parameter param set to val""" - params=self.REQUEST.form.copy() - if param is not None: - if val is None: - if params.has_key(param): - del params[param] - else: - params[param] = str(val) - - # quote values and assemble into query string - ps = "&".join(["%s=%s"%(k,urllib.quote(v)) for (k, v) in params.items()]) - url=self.REQUEST['URL1']+"?"+ps + + 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 getLinkAmp(self,param=None,val=None): - """link to documentviewer with parameter param set to val""" - params=self.REQUEST.form.copy() + 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 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""" + # copy existing request params + urlParams=self.REQUEST.form.copy() + # change single param if param is not None: if val is None: - if params.has_key(param): - del params[param] + if urlParams.has_key(param): + del urlParams[param] else: - params[param] = str(val) + urlParams[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 urlParams.has_key(k): + del urlParams[k] + + else: + urlParams[k] = v + + # FIXME: does this belong here? + if urlParams.get("mode", None) == "filepath": #wenn beim erst Aufruf filepath gesetzt wurde aendere das nun zu imagepath + urlParams["mode"] = "imagepath" + urlParams["url"] = getParentPath(urlParams["url"]) - # quote values and assemble into query string - logging.info("XYXXXXX: %s"%repr(params.items())) - ps = "&".join(["%s=%s"%(k,urllib.quote(v)) for (k, v) in params.items()]) - url=self.REQUEST['URL1']+"?"+ps + # quote values and assemble into query string (not escaping '/') + ps = paramSep.join(["%s=%s"%(k,urllib.quote_plus(v,'/')) for (k, v) in urlParams.items()]) + #ps = urllib.urlencode(urlParams) + if baseUrl is None: + baseUrl = self.REQUEST['URL1'] + + url = "%s?%s"%(baseUrl, ps) return url + + + def getLinkAmp(self, param=None, val=None, params=None, baseUrl=None): + """link to documentviewer with parameter param set to val""" + return self.getLink(param, val, params, baseUrl, '&') + def getInfo_xml(self,url,mode): """returns info about the document as XML""" - if not self.digilibBaseUrl: self.digilibBaseUrl = self.findDigilibUrl() or "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary" @@ -220,357 +396,276 @@ class documentViewer(Folder): pt = getattr(self.template, 'info_xml') return pt(docinfo=docinfo) - - 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 isAccessible(self, docinfo): """returns if access to the resource is granted""" access = docinfo.get('accessType', None) - logger("documentViewer (accessOK)", logging.INFO, "access type %s"%access) - if access is not None and access == 'free': - logger("documentViewer (accessOK)", logging.INFO, "access is free") + logging.debug("documentViewer (accessOK) access type %s"%access) + if access == 'free': + logging.debug("documentViewer (accessOK) access is free") return True + elif access is None or access in self.authgroups: # only local access -- only logged in users user = getSecurityManager().getUser() + logging.debug("documentViewer (accessOK) user=%s ip=%s"%(user,self.REQUEST.getClientAddr())) if user is not None: #print "user: ", user return (user.getUserName() != "Anonymous User") else: return False - logger("documentViewer (accessOK)", logging.INFO, "unknown access type %s"%access) + logging.error("documentViewer (accessOK) unknown access type %s"%access) return False - - def getDirinfoFromDigilib(self,path,docinfo=None,cut=0): - """gibt param von dlInfo aus""" - num_retries = 3 - if docinfo is None: - docinfo = {} - - for x in range(cut): - path=getParentDir(path) - infoUrl=self.digilibBaseUrl+"/dirInfo-xml.jsp?mo=dir&fn="+path - - logger("documentViewer (getparamfromdigilib)", logging.INFO, "dirInfo from %s"%(infoUrl)) - - for cnt in range(num_retries): - try: - # dom = NonvalidatingReader.parseUri(imageUrl) - txt=urllib.urlopen(infoUrl).read() - dom = Parse(txt) - break - except: - logger("documentViewer (getdirinfofromdigilib)", logging.ERROR, "error reading %s (try %d)"%(infoUrl,cnt)) + + + def getDocinfo(self, mode, url): + """returns docinfo depending on mode""" + logging.debug("getDocinfo: mode=%s, url=%s"%(mode,url)) + # look for cached docinfo in session + if self.REQUEST.SESSION.has_key('docinfo'): + docinfo = self.REQUEST.SESSION['docinfo'] + # check if its still current + if docinfo is not None and docinfo.get('mode', None) == mode and docinfo.get('url', None) == url: + logging.debug("getDocinfo: docinfo in session. keys=%s"%docinfo.keys()) + return docinfo + + # new docinfo + docinfo = {'mode': mode, 'url': url} + # add self url + docinfo['viewerUrl'] = self.getDocumentViewerURL() + # get index.meta DOM + docUrl = None + metaDom = None + if mode=="texttool": + # url points to document dir or index.meta + metaDom = self.metadataService.getDomFromPathOrUrl(url) + docUrl = url.replace('/index.meta', '') + if metaDom is None: + raise IOError("Unable to find index.meta for mode=texttool!") + + elif mode=="imagepath": + # url points to folder with images, index.meta optional + # asssume index.meta in parent dir + docUrl = getParentPath(url) + metaDom = self.metadataService.getDomFromPathOrUrl(docUrl) + + elif mode=="filepath": + # url points to image file, index.meta optional + # asssume index.meta is two path segments up + docUrl = getParentPath(url, 2) + metaDom = self.metadataService.getDomFromPathOrUrl(docUrl) + else: - raise IOError("Unable to get dir-info from %s"%(infoUrl)) + logging.error("documentViewer (getdocinfo) unknown mode: %s!"%mode) + raise ValueError("Unknown mode %s! Has to be one of 'texttool','imagepath','filepath'."%(mode)) - sizes=dom.xpath("//dir/size") - logger("documentViewer (getparamfromdigilib)", logging.INFO, "dirInfo:size"%sizes) - - if sizes: - docinfo['numPages'] = int(getTextFromNode(sizes[0])) - else: - docinfo['numPages'] = 0 - - return docinfo - + docinfo['documentUrl'] = docUrl + # process index.meta contents + if metaDom is not None: + # document directory name and path + logging.debug("RESOURCE: %s"%repr(self.metadataService.resource.getData(dom=metaDom,recursive=1))) + resource = self.metadataService.getResourceData(dom=metaDom) + if resource: + docinfo = self.getDocinfoFromResource(docinfo, resource) + + # texttool info + texttool = self.metadataService.getTexttoolData(dom=metaDom) + if texttool: + docinfo = self.getDocinfoFromTexttool(docinfo, texttool) - def getIndexMeta(self, url): - """returns dom of index.meta document at url""" - num_retries = 3 - dom = None - metaUrl = None - if url.startswith("http://"): - # real URL - metaUrl = url - else: - # online path - server=self.digilibBaseUrl+"/servlet/Texter?fn=" - metaUrl=server+url.replace("/mpiwg/online","") - if not metaUrl.endswith("index.meta"): - metaUrl += "/index.meta" - logging.debug("METAURL: %s"%metaUrl) - for cnt in range(num_retries): - try: - # patch dirk encoding fehler treten dann nicht mehr auf - # dom = NonvalidatingReader.parseUri(metaUrl) - txt=urllib.urlopen(metaUrl).read() - dom = Parse(txt) - break - except: - logger("ERROR documentViewer (getIndexMata)", logging.INFO,"%s (%s)"%sys.exc_info()[0:2]) + # bib info + bib = self.metadataService.getBibData(dom=metaDom) + if bib: + docinfo = self.getDocinfoFromBib(docinfo, bib) + else: + # no bib - try info.xml + docinfo = self.getDocinfoFromPresentationInfoXml(docinfo) - if dom is None: - raise IOError("Unable to read index meta from %s"%(url)) - - return dom - - def getPresentationInfoXML(self, url): - """returns dom of info.xml document at url""" - num_retries = 3 - dom = None - metaUrl = None - if url.startswith("http://"): - # real URL - metaUrl = url - else: - # online path - server=self.digilibBaseUrl+"/servlet/Texter?fn=" - metaUrl=server+url.replace("/mpiwg/online","") - - - for cnt in range(num_retries): - try: - # patch dirk encoding fehler treten dann nicht mehr auf - # dom = NonvalidatingReader.parseUri(metaUrl) - txt=urllib.urlopen(metaUrl).read() - dom = Parse(txt) - break - except: - logger("ERROR documentViewer (getPresentationInfoXML)", logging.INFO,"%s (%s)"%sys.exc_info()[0:2]) + # auth info + access = self.metadataService.getAccessData(dom=metaDom) + if access: + docinfo = self.getDocinfoFromAccess(docinfo, access) + + # attribution info + attribution = self.metadataService.getAttributionData(dom=metaDom) + if attribution: + logging.debug("getDocinfo: attribution=%s"%repr(attribution)) + docinfo['attribution'] = attribution + #docinfo = self.getDocinfoFromAccess(docinfo, access) + + # copyright info + copyright = self.metadataService.getCopyrightData(dom=metaDom) + if copyright: + logging.debug("getDocinfo: copyright=%s"%repr(copyright)) + docinfo['copyright'] = copyright + #docinfo = self.getDocinfoFromAccess(docinfo, access) + + # image path + if mode != 'texttool': + # override image path from texttool + docinfo['imagePath'] = url.replace('/mpiwg/online/', '', 1) + + # number of images from digilib + if docinfo.get('imagePath', None): + docinfo['imageURL'] = self.digilibBaseUrl + "/servlet/Scaler?fn=" + docinfo['imagePath'] + docinfo = self.getDocinfoFromDigilib(docinfo, docinfo['imagePath']) + + logging.debug("documentViewer (getdocinfo) docinfo: keys=%s"%docinfo.keys()) + #logging.debug("documentViewer (getdocinfo) docinfo: %s"%docinfo) + # store in session + self.REQUEST.SESSION['docinfo'] = docinfo + return docinfo + + def getDocinfoFromResource(self, docinfo, resource): + """reads contents of resource element into docinfo""" + docName = resource.get('name', None) + docinfo['documentName'] = docName + docPath = resource.get('archive-path', None) + if docPath: + # clean up document path + if docPath[0] != '/': + docPath = '/' + docPath - if dom is None: - raise IOError("Unable to read infoXMLfrom %s"%(url)) - - return dom - - - def getAuthinfoFromIndexMeta(self,path,docinfo=None,dom=None,cut=0): - """gets authorization info from the index.meta file at path or given by dom""" - logger("documentViewer (getauthinfofromindexmeta)", logging.INFO,"path: %s"%(path)) - - access = None - - if docinfo is None: - docinfo = {} - - if dom is None: - for x in range(cut+1): - path=getParentDir(path) - dom = self.getIndexMeta(path) - - acctype = dom.xpath("//access-conditions/access/@type") - if acctype and (len(acctype)>0): - access=acctype[0].value - if access in ['group', 'institution']: - access = getTextFromNode(dom.xpath("//access-conditions/access/name")[0]).lower() + if docName and (not docPath.endswith(docName)): + docPath += "/" + docName - docinfo['accessType'] = access - return docinfo - - - def getBibinfoFromIndexMeta(self,path,docinfo=None,dom=None,cut=0): - """gets bibliographical info from the index.meta file at path or given by dom""" - logging.debug("documentViewer (getbibinfofromindexmeta) path: %s"%(path)) - - if docinfo is None: - docinfo = {} - - if dom is None: - for x in range(cut+1): - path=getParentDir(path) - dom = self.getIndexMeta(path) - - # put in all raw bib fields as dict "bib" - bib = dom.xpath("//bib/*") - if bib and len(bib)>0: - bibinfo = {} - for e in bib: - bibinfo[e.localName] = getTextFromNode(e) - docinfo['bib'] = bibinfo - - # extract some fields (author, title, year) according to their mapping - metaData=self.metadata.main.meta.bib - bibtype=dom.xpath("//bib/@type") - if bibtype and (len(bibtype)>0): - bibtype=bibtype[0].value else: - bibtype="generic" - - bibtype=bibtype.replace("-"," ") # wrong typesiin index meta "-" instead of " " (not wrong! ROC) - docinfo['bib_type'] = bibtype - bibmap=metaData.generateMappingForType(bibtype) - # if there is no mapping bibmap is empty (mapping sometimes has empty fields) - if len(bibmap) > 0 and len(bibmap['author'][0]) > 0: - try: - docinfo['author']=getTextFromNode(dom.xpath("//bib/%s"%bibmap['author'][0])[0]) - except: pass - try: - docinfo['title']=getTextFromNode(dom.xpath("//bib/%s"%bibmap['title'][0])[0]) - except: pass - try: - docinfo['year']=getTextFromNode(dom.xpath("//bib/%s"%bibmap['year'][0])[0]) - except: pass - logging.debug("documentViewer (getbibinfofromindexmeta) using mapping for %s"%bibtype) - try: - docinfo['lang']=getTextFromNode(dom.xpath("//bib/lang")[0]) - except: - docinfo['lang']='' + # use docUrl as docPath + docUrl = docinfo['documentURL'] + if not docUrl.startswith('http:'): + docPath = docUrl + if docPath: + # fix URLs starting with /mpiwg/online + docPath = docPath.replace('/mpiwg/online', '', 1) + docinfo['documentPath'] = docPath return docinfo - - def getDocinfoFromTextTool(self,url,dom=None,docinfo=None): - """parse texttool tag in index meta""" - logger("documentViewer (getdocinfofromtexttool)", logging.INFO,"url: %s"%(url)) - if docinfo is None: - docinfo = {} - - if docinfo.get('lang',None) is None: - docinfo['lang']='' # default keine Sprache gesetzt - if dom is None: - dom = self.getIndexMeta(url) - - archivePath = None - archiveName = None - - archiveNames=dom.xpath("//resource/name") - if archiveNames and (len(archiveNames)>0): - archiveName=getTextFromNode(archiveNames[0]) - else: - logger("documentViewer (getdocinfofromtexttool)", logging.WARNING,"resource/name missing in: %s"%(url)) - - archivePaths=dom.xpath("//resource/archive-path") - if archivePaths and (len(archivePaths)>0): - archivePath=getTextFromNode(archivePaths[0]) - # clean up archive path - if archivePath[0] != '/': - archivePath = '/' + archivePath - if archiveName and (not archivePath.endswith(archiveName)): - archivePath += "/" + archiveName - else: - # try to get archive-path from url - logger("documentViewer (getdocinfofromtexttool)", logging.WARNING,"resource/archive-path missing in: %s"%(url)) - if (not url.startswith('http')): - archivePath = url.replace('index.meta', '') - - if archivePath is None: - # we balk without archive-path - raise IOError("Missing archive-path (for text-tool) in %s"%(url)) - - imageDirs=dom.xpath("//texttool/image") - if imageDirs and (len(imageDirs)>0): - imageDir=getTextFromNode(imageDirs[0]) - else: - # we balk with no image tag / not necessary anymore because textmode is now standard - #raise IOError("No text-tool info in %s"%(url)) - imageDir="" - docinfo['numPages']=1 # im moment einfach auf eins setzen, navigation ueber die thumbs geht natuerlich nicht - - docinfo['imagePath'] = "" # keine Bilder - docinfo['imageURL'] = "" + def getDocinfoFromTexttool(self, docinfo, texttool): + """reads contents of texttool element into docinfo""" + # image dir + imageDir = texttool.get('image', None) + docPath = docinfo.get('documentPath', None) + if imageDir and docPath: + #print "image: ", imageDir, " archivepath: ", archivePath + imageDir = os.path.join(docPath, imageDir) + imageDir = imageDir.replace('/mpiwg/online', '', 1) + docinfo['imagePath'] = imageDir + + # old style text URL + textUrl = texttool.get('text', None) + if textUrl and docPath: + if urlparse.urlparse(textUrl)[0] == "": #keine url + textUrl = os.path.join(docPath, textUrl) + + docinfo['textURL'] = textUrl + + # new style text-url-path + textUrl = texttool.get('text-url-path', None) + if textUrl: + docinfo['textURLPath'] = textUrl + #TODO: ugly: + #textUrlkurz = string.split(textUrl, ".")[0] + #docinfo['textURLPathkurz'] = textUrlkurz + + # old presentation stuff + presentation = texttool.get('presentation', None) + if presentation and docPath: + if presentation.startswith('http:'): + docinfo['presentationUrl'] = presentation + else: + docinfo['presentationUrl'] = os.path.join(docPath, presentation) + + return docinfo - if imageDir and archivePath: - #print "image: ", imageDir, " archivepath: ", archivePath - imageDir=os.path.join(archivePath,imageDir) - imageDir=imageDir.replace("/mpiwg/online",'') - docinfo=self.getDirinfoFromDigilib(imageDir,docinfo=docinfo) - docinfo['imagePath'] = imageDir - docinfo['imageURL'] = self.digilibBaseUrl+"/servlet/Scaler?fn="+imageDir - - viewerUrls=dom.xpath("//texttool/digiliburlprefix") - if viewerUrls and (len(viewerUrls)>0): - viewerUrl=getTextFromNode(viewerUrls[0]) - docinfo['viewerURL'] = viewerUrl - - textUrls=dom.xpath("//texttool/text") - if textUrls and (len(textUrls)>0): - textUrl=getTextFromNode(textUrls[0]) - if urlparse.urlparse(textUrl)[0]=="": #keine url - textUrl=os.path.join(archivePath,textUrl) - # fix URLs starting with /mpiwg/online - if textUrl.startswith("/mpiwg/online"): - textUrl = textUrl.replace("/mpiwg/online",'',1) - - docinfo['textURL'] = textUrl - - presentationUrls=dom.xpath("//texttool/presentation") - docinfo = self.getBibinfoFromIndexMeta(url,docinfo=docinfo,dom=dom) # get info von bib tag - - if presentationUrls and (len(presentationUrls)>0): # ueberschreibe diese durch presentation informationen - # presentation url ergiebt sich ersetzen von index.meta in der url der fuer die Metadaten - # durch den relativen Pfad auf die presentation infos - presentationUrl=url.replace('index.meta',getTextFromNode(presentationUrls[0])) - docinfo = self.getBibinfoFromTextToolPresentation(presentationUrl,docinfo=docinfo,dom=dom) - - docinfo = self.getAuthinfoFromIndexMeta(url,docinfo=docinfo,dom=dom) # get access info - return docinfo - - - def getBibinfoFromTextToolPresentation(self,url,docinfo=None,dom=None): - """gets the bibliographical information from the preseantion entry in texttools - """ - dom=self.getPresentationInfoXML(url) - try: - docinfo['author']=getTextFromNode(dom.xpath("//author")[0]) - except: - pass - try: - docinfo['title']=getTextFromNode(dom.xpath("//title")[0]) - except: - pass + def getDocinfoFromBib(self, docinfo, bib): + """reads contents of bib element into docinfo""" + logging.debug("getDocinfoFromBib bib=%s"%repr(bib)) + # put all raw bib fields in dict "bib" + docinfo['bib'] = bib + bibtype = bib.get('@type', None) + docinfo['bibType'] = bibtype + # also store DC metadata for convenience + dc = self.metadataService.getDCMappedData(bib) + docinfo['creator'] = dc.get('creator',None) + docinfo['title'] = dc.get('title',None) + docinfo['date'] = dc.get('date',None) + return docinfo + + def getDocinfoFromAccess(self, docinfo, acc): + """reads contents of access element into docinfo""" + #TODO: also read resource type + logging.debug("getDocinfoFromAccess acc=%s"%repr(acc)) try: - docinfo['year']=getTextFromNode(dom.xpath("//date")[0]) + acctype = acc['@attr']['type'] + if acctype: + access=acctype + if access in ['group', 'institution']: + access = acc['name'].lower() + + docinfo['accessType'] = access + except: pass - return docinfo - - def getDocinfoFromImagePath(self,path,docinfo=None,cut=0): - """path ist the path to the images it assumes that the index.meta file is one level higher.""" - logger("documentViewer (getdocinfofromimagepath)", logging.INFO,"path: %s"%(path)) - if docinfo is None: - docinfo = {} - path=path.replace("/mpiwg/online","") - docinfo['imagePath'] = path - docinfo=self.getDirinfoFromDigilib(path,docinfo=docinfo,cut=cut) - imageUrl=self.digilibBaseUrl+"/servlet/Scaler?fn="+path - docinfo['imageURL'] = imageUrl - docinfo = self.getBibinfoFromIndexMeta(path,docinfo=docinfo,cut=cut) - docinfo = self.getAuthinfoFromIndexMeta(path,docinfo=docinfo,cut=cut) return docinfo - - - def getDocinfo(self, mode, url): - """returns docinfo depending on mode""" - logger("documentViewer (getdocinfo)", logging.INFO,"mode: %s, url: %s"%(mode,url)) - # look for cached docinfo in session - if self.REQUEST.SESSION.has_key('docinfo'): - docinfo = self.REQUEST.SESSION['docinfo'] - # check if its still current - if docinfo is not None and docinfo.get('mode') == mode and docinfo.get('url') == url: - logger("documentViewer (getdocinfo)", logging.INFO,"docinfo in session: %s"%docinfo) - return docinfo - # new docinfo - docinfo = {'mode': mode, 'url': url} - if mode=="texttool": #index.meta with texttool information - docinfo = self.getDocinfoFromTextTool(url, docinfo=docinfo) - elif mode=="imagepath": - docinfo = self.getDocinfoFromImagePath(url, docinfo=docinfo) - elif mode=="filepath": - docinfo = self.getDocinfoFromImagePath(url, docinfo=docinfo,cut=1) + + def getDocinfoFromDigilib(self, docinfo, path): + infoUrl=self.digilibBaseUrl+"/dirInfo-xml.jsp?mo=dir&fn="+path + # fetch data + txt = getHttpData(infoUrl) + if not txt: + logging.error("Unable to get dir-info from %s"%(infoUrl)) + return docinfo + + dom = ET.fromstring(txt) + size = getText(dom.find("size")) + logging.debug("getDocinfoFromDigilib: size=%s"%size) + if size: + docinfo['numPages'] = int(size) else: - logger("documentViewer (getdocinfo)", logging.ERROR,"unknown mode!") - raise ValueError("Unknown mode %s"%(mode)) - - logger("documentViewer (getdocinfo)", logging.INFO,"docinfo: %s"%docinfo) - self.REQUEST.SESSION['docinfo'] = docinfo + docinfo['numPages'] = 0 + + # TODO: produce and keep list of image names and numbers return docinfo + + + def getDocinfoFromPresentationInfoXml(self,docinfo): + """gets DC-like bibliographical information from the presentation entry in texttools""" + url = docinfo.get('presentationUrl', None) + if not url: + logging.error("getDocinfoFromPresentation: no URL!") + return docinfo + dom = None + metaUrl = None + if url.startswith("http://"): + # real URL + metaUrl = url + else: + # online path + + server=self.digilibBaseUrl+"/servlet/Texter?fn=" + metaUrl=server+url - def getPageinfo(self, current, start=None, rows=None, cols=None, docinfo=None): + txt=getHttpData(metaUrl) + if txt is None: + logging.error("Unable to read info.xml from %s"%(url)) + return docinfo + + dom = ET.fromstring(txt) + docinfo['creator']=getText(dom.find(".//author")) + docinfo['title']=getText(dom.find(".//title")) + docinfo['date']=getText(dom.find(".//date")) + return docinfo + + + def getPageinfo(self, current, start=None, rows=None, cols=None, docinfo=None, viewMode=None, tocMode=None): """returns pageinfo with the given parameters""" pageinfo = {} current = getInt(current) + pageinfo['current'] = current rows = int(rows or self.thumbrows) pageinfo['rows'] = rows @@ -578,124 +673,84 @@ class documentViewer(Folder): pageinfo['cols'] = cols grpsize = cols * rows pageinfo['groupsize'] = grpsize + # what does this do? start = getInt(start, default=(math.ceil(float(current)/float(grpsize))*grpsize-(grpsize-1))) # int(current / grpsize) * grpsize +1)) pageinfo['start'] = start pageinfo['end'] = start + grpsize - if docinfo is not None: + if (docinfo is not None) and ('numPages' in docinfo): np = int(docinfo['numPages']) pageinfo['end'] = min(pageinfo['end'], np) pageinfo['numgroups'] = int(np / grpsize) if np % grpsize > 0: pageinfo['numgroups'] += 1 - logging.debug("getPageInfo: %s"%repr(pageinfo)) - return pageinfo - 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") + pageinfo['viewMode'] = viewMode + pageinfo['tocMode'] = tocMode + pageinfo['characterNormalization'] = self.REQUEST.get('characterNormalization','reg') + #pageinfo['optionToggle'] = self.REQUEST.get('optionToggle','1') + pageinfo['query'] = self.REQUEST.get('query','') + pageinfo['queryType'] = self.REQUEST.get('queryType','') + pageinfo['querySearch'] =self.REQUEST.get('querySearch', 'fulltext') + pageinfo['textPN'] = self.REQUEST.get('textPN','1') + pageinfo['highlightQuery'] = self.REQUEST.get('highlightQuery','') + pageinfo['tocPageSize'] = self.REQUEST.get('tocPageSize', '30') + pageinfo['queryPageSize'] =self.REQUEST.get('queryPageSize', '10') + pageinfo['tocPN'] = self.REQUEST.get('tocPN', '1') + # WTF?: + toc = int(pageinfo['tocPN']) + pageinfo['textPages'] =int(toc) + + # What does this do? + if 'tocSize_%s'%tocMode in docinfo: + tocSize = int(docinfo['tocSize_%s'%tocMode]) + tocPageSize = int(pageinfo['tocPageSize']) + # cached toc + if tocSize%tocPageSize>0: + tocPages=tocSize/tocPageSize+1 + else: + tocPages=tocSize/tocPageSize + + pageinfo['tocPN'] = min(tocPages,toc) + + pageinfo['searchPN'] =self.REQUEST.get('searchPN','1') + pageinfo['sn'] =self.REQUEST.get('sn','') + return pageinfo - 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 - pass -# else: -# next=p -# while next!=e: -# print next,e -# list.append(next) -# next=next.nextSibling -# -# for x in list: -# PrettyPrint(x) -# -# return list -# - def findDigilibUrl(self): - """try to get the digilib URL from zogilib""" - url = self.imageViewerUrl[:-1] + "/getScalerUrl" - #print urlparse.urlparse(url)[0] - #print urlparse.urljoin(self.absolute_url(),url) - logging.info("finddigiliburl: %s"%urlparse.urlparse(url)[0]) - logging.info("finddigiliburl: %s"%urlparse.urljoin(self.absolute_url(),url)) - - try: - if urlparse.urlparse(url)[0]=='': #relative path - url=urlparse.urljoin(self.absolute_url()+"/",url) - - scaler = urlopen(url).read() - return scaler.replace("/servlet/Scaler?", "") - except: - return None + security.declareProtected('View management screens','changeDocumentViewerForm') + changeDocumentViewerForm = PageTemplateFile('zpt/changeDocumentViewer', globals()) - def changeDocumentViewer(self,imageViewerUrl,textViewerUrl,title="",digilibBaseUrl=None,thumbrows=2,thumbcols=10,authgroups='mpiwg',RESPONSE=None): + def changeDocumentViewer(self,title="",digilibBaseUrl=None,thumbrows=2,thumbcols=5,authgroups='mpiwg',RESPONSE=None): """init document viewer""" self.title=title - self.imageViewerUrl=imageViewerUrl - self.textViewerUrl=textViewerUrl self.digilibBaseUrl = digilibBaseUrl self.thumbrows = thumbrows self.thumbcols = thumbcols self.authgroups = [s.strip().lower() for s in authgroups.split(',')] + 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 RESPONSE is not None: RESPONSE.redirect('manage_main') - - - -# security.declareProtected('View management screens','renameImageForm') - def manage_AddDocumentViewerForm(self): """add the viewer form""" pt=PageTemplateFile('zpt/addDocumentViewer', globals()).__of__(self) return pt() -def manage_AddDocumentViewer(self,id,imageViewerUrl="",textViewerUrl="",title="",RESPONSE=None): +def manage_AddDocumentViewer(self,id,imageScalerUrl="",textServerName="",title="",RESPONSE=None): """add the viewer""" - newObj=documentViewer(id,imageViewerUrl,title=title,textViewerUrl=textViewerUrl) + newObj=documentViewer(id,imageScalerUrl=imageScalerUrl,title=title,textServerName=textServerName) self._setObject(id,newObj) if RESPONSE is not None: RESPONSE.redirect('manage_main') - -## ## DocumentViewerTemplate class -## class DocumentViewerTemplate(ZopePageTemplate): """Template for document viewer""" meta_type="DocumentViewer Template"