Annotation of documentViewer/documentViewer.py, revision 1.175.2.4
1.18 dwinter 1:
1.1 dwinter 2: from OFS.Folder import Folder
3: from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate
1.22 dwinter 4: from Products.PageTemplates.PageTemplateFile import PageTemplateFile
1.1 dwinter 5: from AccessControl import ClassSecurityInfo
1.8 casties 6: from AccessControl import getSecurityManager
1.1 dwinter 7: from Globals import package_home
1.119 abukhman 8: from Products.zogiLib.zogiLib import browserCheck
1.1 dwinter 9:
1.175.2.1 casties 10: #from Ft.Xml import EMPTY_NAMESPACE, Parse
11: #import Ft.Xml.Domlette
12:
13: import xml.etree.ElementTree as ET
14:
1.1 dwinter 15: import os.path
1.7 casties 16: import sys
1.1 dwinter 17: import urllib
1.70 casties 18: import urllib2
1.20 dwinter 19: import logging
1.28 casties 20: import math
1.18 dwinter 21: import urlparse
1.99 dwinter 22: import re
1.149 abukhman 23: import string
1.117 abukhman 24:
1.22 dwinter 25: def logger(txt,method,txt2):
26: """logging"""
27: logging.info(txt+ txt2)
28:
29:
1.4 casties 30: def getInt(number, default=0):
31: """returns always an int (0 in case of problems)"""
32: try:
33: return int(number)
34: except:
1.29 casties 35: return int(default)
1.4 casties 36:
1.175.2.1 casties 37: def getText(node):
1.18 dwinter 38: """get the cdata content of a node"""
1.175.2.1 casties 39: if node is None:
1.8 casties 40: return ""
1.175.2.1 casties 41: # ET:
42: text = node.text or ""
43: for e in node:
44: text += gettext(e)
45: if e.tail:
46: text += e.tail
47:
48: # 4Suite:
49: #nodelist=node.childNodes
50: #text = ""
51: #for n in nodelist:
52: # if n.nodeType == node.TEXT_NODE:
53: # text = text + n.data
54:
55: return text
56:
57: getTextFromNode = getText
1.1 dwinter 58:
1.170 abukhman 59: def serializeNode(node, encoding="utf-8"):
1.43 casties 60: """returns a string containing node as XML"""
1.175.2.1 casties 61: s = ET.tostring(node)
62:
63: # 4Suite:
64: # stream = cStringIO.StringIO()
65: # Ft.Xml.Domlette.Print(node, stream=stream, encoding=encoding)
66: # s = stream.getvalue()
67: # stream.close()
1.43 casties 68: return s
69:
1.148 abukhman 70: def browserCheck(self):
71: """check the browsers request to find out the browser type"""
72: bt = {}
73: ua = self.REQUEST.get_header("HTTP_USER_AGENT")
74: bt['ua'] = ua
75: bt['isIE'] = False
76: bt['isN4'] = False
1.165 abukhman 77: bt['versFirefox']=""
78: bt['versIE']=""
79: bt['versSafariChrome']=""
80: bt['versOpera']=""
81:
1.148 abukhman 82: if string.find(ua, 'MSIE') > -1:
83: bt['isIE'] = True
84: else:
85: bt['isN4'] = (string.find(ua, 'Mozilla/4.') > -1)
1.165 abukhman 86: # Safari oder Chrome identification
87: try:
88: nav = ua[string.find(ua, '('):]
89: nav1=ua[string.find(ua,')'):]
90: nav2=nav1[string.find(nav1,'('):]
91: nav3=nav2[string.find(nav2,')'):]
92: ie = string.split(nav, "; ")[1]
93: ie1 =string.split(nav1, " ")[2]
94: ie2 =string.split(nav3, " ")[1]
95: ie3 =string.split(nav3, " ")[2]
96: if string.find(ie3, "Safari") >-1:
97: bt['versSafariChrome']=string.split(ie2, "/")[1]
98: except: pass
99: # IE identification
1.148 abukhman 100: try:
101: nav = ua[string.find(ua, '('):]
102: ie = string.split(nav, "; ")[1]
103: if string.find(ie, "MSIE") > -1:
104: bt['versIE'] = string.split(ie, " ")[1]
1.165 abukhman 105: except:pass
106: # Firefox identification
107: try:
108: nav = ua[string.find(ua, '('):]
109: nav1=ua[string.find(ua,')'):]
110: if string.find(ie1, "Firefox") >-1:
111: nav5= string.split(ie1, "/")[1]
112: logging.debug("FIREFOX: %s"%(nav5))
1.166 abukhman 113: bt['versFirefox']=nav5[0:3]
1.165 abukhman 114: except:pass
115: #Opera identification
116: try:
117: if string.find(ua,"Opera") >-1:
118: nav = ua[string.find(ua, '('):]
119: nav1=nav[string.find(nav,')'):]
120: bt['versOpera']=string.split(nav1,"/")[2]
121: except:pass
1.148 abukhman 122:
123: bt['isMac'] = string.find(ua, 'Macintosh') > -1
124: bt['isWin'] = string.find(ua, 'Windows') > -1
125: bt['isIEWin'] = bt['isIE'] and bt['isWin']
126: bt['isIEMac'] = bt['isIE'] and bt['isMac']
127: bt['staticHTML'] = False
128:
129: return bt
1.118 abukhman 130:
131:
1.9 casties 132: def getParentDir(path):
133: """returns pathname shortened by one"""
134: return '/'.join(path.split('/')[0:-1])
135:
136:
1.70 casties 137: def getHttpData(url, data=None, num_tries=3, timeout=10):
138: """returns result from url+data HTTP request"""
139: # we do GET (by appending data to url)
140: if isinstance(data, str) or isinstance(data, unicode):
141: # if data is string then append
142: url = "%s?%s"%(url,data)
143: elif isinstance(data, dict) or isinstance(data, list) or isinstance(data, tuple):
144: # urlencode
145: url = "%s?%s"%(url,urllib.urlencode(data))
146:
147: response = None
148: errmsg = None
149: for cnt in range(num_tries):
150: try:
1.95 abukhman 151: logging.debug("getHttpData(#%s %ss) url=%s"%(cnt+1,timeout,url))
1.70 casties 152: if sys.version_info < (2, 6):
153: # set timeout on socket -- ugly :-(
154: import socket
155: socket.setdefaulttimeout(float(timeout))
156: response = urllib2.urlopen(url)
157: else:
158: response = urllib2.urlopen(url,timeout=float(timeout))
159: # check result?
160: break
161: except urllib2.HTTPError, e:
1.95 abukhman 162: logging.error("getHttpData: HTTP error(%s): %s"%(e.code,e))
1.70 casties 163: errmsg = str(e)
164: # stop trying
165: break
166: except urllib2.URLError, e:
1.95 abukhman 167: logging.error("getHttpData: URLLIB error(%s): %s"%(e.reason,e))
1.70 casties 168: errmsg = str(e)
169: # stop trying
170: #break
171:
172: if response is not None:
173: data = response.read()
174: response.close()
175: return data
176:
177: raise IOError("ERROR fetching HTTP data from %s: %s"%(url,errmsg))
178: #return None
1.1 dwinter 179:
1.3 casties 180: ##
181: ## documentViewer class
182: ##
183: class documentViewer(Folder):
1.1 dwinter 184: """document viewer"""
185: meta_type="Document viewer"
186:
187: security=ClassSecurityInfo()
1.3 casties 188: manage_options=Folder.manage_options+(
1.1 dwinter 189: {'label':'main config','action':'changeDocumentViewerForm'},
190: )
191:
1.3 casties 192: # templates and forms
193: viewer_main = PageTemplateFile('zpt/viewer_main', globals())
1.44 casties 194: toc_thumbs = PageTemplateFile('zpt/toc_thumbs', globals())
195: toc_text = PageTemplateFile('zpt/toc_text', globals())
196: toc_figures = PageTemplateFile('zpt/toc_figures', globals())
1.43 casties 197: page_main_images = PageTemplateFile('zpt/page_main_images', globals())
1.161 abukhman 198: page_main_double = PageTemplateFile('zpt/page_main_double', globals())
1.43 casties 199: page_main_text = PageTemplateFile('zpt/page_main_text', globals())
1.44 casties 200: page_main_text_dict = PageTemplateFile('zpt/page_main_text_dict', globals())
1.77 abukhman 201: page_main_gis =PageTemplateFile ('zpt/page_main_gis', globals())
1.48 abukhman 202: page_main_xml = PageTemplateFile('zpt/page_main_xml', globals())
1.157 abukhman 203: page_main_pureXml = PageTemplateFile('zpt/page_main_pureXml', globals())
1.3 casties 204: head_main = PageTemplateFile('zpt/head_main', globals())
205: docuviewer_css = PageTemplateFile('css/docuviewer.css', globals())
1.26 casties 206: info_xml = PageTemplateFile('zpt/info_xml', globals())
1.70 casties 207:
208:
1.32 dwinter 209: thumbs_main_rss = PageTemplateFile('zpt/thumbs_main_rss', globals())
1.3 casties 210: security.declareProtected('View management screens','changeDocumentViewerForm')
211: changeDocumentViewerForm = PageTemplateFile('zpt/changeDocumentViewer', globals())
212:
1.1 dwinter 213:
1.45 abukhman 214: def __init__(self,id,imageScalerUrl=None,textServerName=None,title="",digilibBaseUrl=None,thumbcols=2,thumbrows=5,authgroups="mpiwg"):
1.1 dwinter 215: """init document viewer"""
216: self.id=id
217: self.title=title
1.4 casties 218: self.thumbcols = thumbcols
219: self.thumbrows = thumbrows
1.8 casties 220: # authgroups is list of authorized groups (delimited by ,)
221: self.authgroups = [s.strip().lower() for s in authgroups.split(',')]
1.43 casties 222: # create template folder so we can always use template.something
223:
224: templateFolder = Folder('template')
225: #self['template'] = templateFolder # Zope-2.12 style
226: self._setObject('template',templateFolder) # old style
227: try:
1.70 casties 228: import MpdlXmlTextServer
1.71 casties 229: textServer = MpdlXmlTextServer.MpdlXmlTextServer(id='fulltextclient',serverName=textServerName)
1.43 casties 230: #templateFolder['fulltextclient'] = xmlRpcClient
1.70 casties 231: templateFolder._setObject('fulltextclient',textServer)
1.43 casties 232: except Exception, e:
1.70 casties 233: logging.error("Unable to create MpdlXmlTextServer for fulltextclient: "+str(e))
1.43 casties 234: try:
235: from Products.zogiLib.zogiLib import zogiLib
236: zogilib = zogiLib(id="zogilib", title="zogilib for docuviewer", dlServerURL=imageScalerUrl, layout="book")
237: #templateFolder['zogilib'] = zogilib
238: templateFolder._setObject('zogilib',zogilib)
239: except Exception, e:
240: logging.error("Unable to create zogiLib for zogilib: "+str(e))
241:
1.70 casties 242:
243: # proxy text server methods to fulltextclient
244: def getTextPage(self, **args):
245: """get page"""
246: return self.template.fulltextclient.getTextPage(**args)
1.171 abukhman 247:
248: def getOrigPages(self, **args):
249: """get page"""
250: return self.template.fulltextclient.getOrigPages(**args)
1.167 abukhman 251:
1.171 abukhman 252: def getOrigPagesNorm(self, **args):
253: """get page"""
254: return self.template.fulltextclient.getOrigPagesNorm(**args)
255:
1.70 casties 256: def getQuery(self, **args):
1.163 abukhman 257: """get query in search"""
1.70 casties 258: return self.template.fulltextclient.getQuery(**args)
1.163 abukhman 259:
1.70 casties 260: def getSearch(self, **args):
261: """get search"""
262: return self.template.fulltextclient.getSearch(**args)
1.120 abukhman 263:
264: def getGisPlaces(self, **args):
1.121 abukhman 265: """get gis places"""
1.120 abukhman 266: return self.template.fulltextclient.getGisPlaces(**args)
1.121 abukhman 267:
268: def getAllGisPlaces(self, **args):
1.122 abukhman 269: """get all gis places """
270: return self.template.fulltextclient.getAllGisPlaces(**args)
1.163 abukhman 271:
1.70 casties 272: def getTranslate(self, **args):
273: """get translate"""
274: return self.template.fulltextclient.getTranslate(**args)
275:
276: def getLemma(self, **args):
277: """get lemma"""
278: return self.template.fulltextclient.getLemma(**args)
279:
1.173 abukhman 280: def getLemmaQuery(self, **args):
281: """get query"""
282: return self.template.fulltextclient.getLemmaQuery(**args)
283:
284: def getLex(self, **args):
285: """get lex"""
286: return self.template.fulltextclient.getLex(**args)
287:
1.70 casties 288: def getToc(self, **args):
289: """get toc"""
290: return self.template.fulltextclient.getToc(**args)
291:
292: def getTocPage(self, **args):
293: """get tocpage"""
294: return self.template.fulltextclient.getTocPage(**args)
1.3 casties 295:
1.70 casties 296:
1.32 dwinter 297: security.declareProtected('View','thumbs_rss')
298: def thumbs_rss(self,mode,url,viewMode="auto",start=None,pn=1):
299: '''
300: view it
301: @param mode: defines how to access the document behind url
302: @param url: url which contains display information
303: @param viewMode: if images display images, if text display text, default is images (text,images or auto)
304:
305: '''
1.95 abukhman 306: logging.debug("HHHHHHHHHHHHHH:load the rss")
307: logger("documentViewer (index)", logging.INFO, "mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn))
1.32 dwinter 308:
309: if not hasattr(self, 'template'):
310: # create template folder if it doesn't exist
311: self.manage_addFolder('template')
312:
313: if not self.digilibBaseUrl:
314: self.digilibBaseUrl = self.findDigilibUrl() or "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary"
315:
316: docinfo = self.getDocinfo(mode=mode,url=url)
1.132 abukhman 317: #pageinfo = self.getPageinfo(start=start,current=pn,docinfo=docinfo)
1.138 abukhman 318: pageinfo = self.getPageinfo(start=start,current=pn, docinfo=docinfo)
1.126 abukhman 319: ''' ZDES '''
1.32 dwinter 320: pt = getattr(self.template, 'thumbs_main_rss')
321:
322: if viewMode=="auto": # automodus gewaehlt
1.159 casties 323: if docinfo.has_key("textURL") or docinfo.get('textURLPath',None): #texturl gesetzt und textViewer konfiguriert
1.32 dwinter 324: viewMode="text"
325: else:
326: viewMode="images"
327:
328: return pt(docinfo=docinfo,pageinfo=pageinfo,viewMode=viewMode)
329:
1.3 casties 330: security.declareProtected('View','index_html')
1.158 casties 331: def index_html(self,url,mode="texttool",viewMode="auto",tocMode="thumbs",start=None,pn=1,mk=None):
1.3 casties 332: '''
333: view it
1.26 casties 334: @param mode: defines how to access the document behind url
1.3 casties 335: @param url: url which contains display information
1.44 casties 336: @param viewMode: if images display images, if text display text, default is auto (text,images or auto)
1.48 abukhman 337: @param tocMode: type of 'table of contents' for navigation (thumbs, text, figures, none)
1.78 abukhman 338: @param characterNormalization type of text display (reg, norm, none)
1.49 abukhman 339: @param querySearch: type of different search modes (fulltext, fulltextMorph, xpath, xquery, ftIndex, ftIndexMorph, fulltextMorphLemma)
1.3 casties 340: '''
341:
1.138 abukhman 342: logging.debug("documentViewer (index) mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn))
1.1 dwinter 343:
1.3 casties 344: if not hasattr(self, 'template'):
1.43 casties 345: # this won't work
346: logging.error("template folder missing!")
347: return "ERROR: template folder missing!"
1.3 casties 348:
1.43 casties 349: if not getattr(self, 'digilibBaseUrl', None):
1.71 casties 350: self.digilibBaseUrl = self.findDigilibUrl() or "http://digilib.mpiwg-berlin.mpg.de/digitallibrary"
1.3 casties 351:
1.4 casties 352: docinfo = self.getDocinfo(mode=mode,url=url)
1.47 abukhman 353:
1.44 casties 354: if tocMode != "thumbs":
355: # get table of contents
356: docinfo = self.getToc(mode=tocMode, docinfo=docinfo)
1.175.2.3 casties 357:
358: # auto viewMode: text_dict if text else images
359: if viewMode=="auto":
360: if docinfo.get('textURL', None) or docinfo.get('textURLPath', None):
361: #texturl gesetzt und textViewer konfiguriert
1.68 casties 362: viewMode="text_dict"
1.21 dwinter 363: else:
364: viewMode="images"
1.44 casties 365:
1.175.2.3 casties 366: pageinfo = self.getPageinfo(start=start, current=pn, docinfo=docinfo, viewMode=viewMode, tocMode=tocMode)
1.68 casties 367:
1.175.2.3 casties 368: if viewMode != 'images' and docinfo.get('textURLPath', None):
369: # get full text page
370: page = self.getTextPage(mode=viewMode, pn=pn, docinfo=docinfo, pageinfo=pageinfo)
1.163 abukhman 371: pageinfo['textPage'] = page
1.175.2.3 casties 372:
373: # get template /template/viewer_main
374: pt = getattr(self.template, 'viewer_main')
375: # and execute with parameters
376: return pt(docinfo=docinfo, pageinfo=pageinfo, viewMode=viewMode, mk=self.generateMarks(mk))
1.1 dwinter 377:
1.36 dwinter 378: def generateMarks(self,mk):
379: ret=""
1.44 casties 380: if mk is None:
381: return ""
1.73 casties 382: if not isinstance(mk, list):
1.71 casties 383: mk=[mk]
1.36 dwinter 384: for m in mk:
1.37 dwinter 385: ret+="mk=%s"%m
1.36 dwinter 386: return ret
1.149 abukhman 387:
388:
1.148 abukhman 389: def getBrowser(self):
390: """getBrowser the version of browser """
1.162 casties 391: bt = browserCheck(self)
1.164 abukhman 392: logging.debug("BROWSER VERSION: %s"%(bt))
1.162 casties 393: return bt
1.148 abukhman 394:
1.43 casties 395: def findDigilibUrl(self):
396: """try to get the digilib URL from zogilib"""
397: url = self.template.zogilib.getDLBaseUrl()
398: return url
1.67 casties 399:
400: def getDocumentViewerURL(self):
401: """returns the URL of this instance"""
402: return self.absolute_url()
1.43 casties 403:
404: def getStyle(self, idx, selected, style=""):
405: """returns a string with the given style and append 'sel' if path == selected."""
406: #logger("documentViewer (getstyle)", logging.INFO, "idx: %s selected: %s style: %s"%(idx,selected,style))
407: if idx == selected:
408: return style + 'sel'
409: else:
410: return style
1.36 dwinter 411:
1.162 casties 412: def getLink(self, param=None, val=None, params=None, baseUrl=None, paramSep='&'):
413: """returns URL to documentviewer with parameter param set to val or from dict params"""
414: # copy existing request params
415: urlParams=self.REQUEST.form.copy()
416: # change single param
1.4 casties 417: if param is not None:
1.7 casties 418: if val is None:
1.162 casties 419: if urlParams.has_key(param):
420: del urlParams[param]
1.4 casties 421: else:
1.162 casties 422: urlParams[param] = str(val)
1.43 casties 423:
1.162 casties 424: # change more params
425: if params is not None:
426: for k in params.keys():
427: v = params[k]
428: if v is None:
429: # val=None removes param
430: if urlParams.has_key(k):
431: del urlParams[k]
432:
433: else:
434: urlParams[k] = v
435:
436: # FIXME: does this belong here?
437: if urlParams.get("mode", None) == "filepath": #wenn beim erst Aufruf filepath gesetzt wurde aendere das nun zu imagepath
438: urlParams["mode"] = "imagepath"
439: urlParams["url"] = getParentDir(urlParams["url"])
1.7 casties 440:
1.162 casties 441: # quote values and assemble into query string (not escaping '/')
442: ps = paramSep.join(["%s=%s"%(k,urllib.quote_plus(v,'/')) for (k, v) in urlParams.items()])
443: #ps = urllib.urlencode(urlParams)
444: if baseUrl is None:
445: baseUrl = self.REQUEST['URL1']
446:
447: url = "%s?%s"%(baseUrl, ps)
1.4 casties 448: return url
449:
1.162 casties 450:
451: def getLinkAmp(self, param=None, val=None, params=None, baseUrl=None):
1.32 dwinter 452: """link to documentviewer with parameter param set to val"""
1.162 casties 453: return self.getLink(param, val, params, baseUrl, '&')
1.40 casties 454:
1.26 casties 455: def getInfo_xml(self,url,mode):
456: """returns info about the document as XML"""
457:
458: if not self.digilibBaseUrl:
459: self.digilibBaseUrl = self.findDigilibUrl() or "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary"
460:
461: docinfo = self.getDocinfo(mode=mode,url=url)
462: pt = getattr(self.template, 'info_xml')
463: return pt(docinfo=docinfo)
464:
1.153 casties 465: def getOptionToggle(self, newState=None, optionName='text_options_open', initialState=True):
466: """returns new option state"""
1.155 casties 467: if not self.REQUEST.SESSION.has_key(optionName):
1.153 casties 468: # not in session -- initial
469: opt = {'lastState': newState, 'state': initialState}
470: else:
1.155 casties 471: opt = self.REQUEST.SESSION.get(optionName)
1.153 casties 472: if opt['lastState'] != newState:
473: # state in session has changed -- toggle
474: opt['state'] = not opt['state']
475: opt['lastState'] = newState
476:
477: self.REQUEST.SESSION[optionName] = opt
478: return opt['state']
1.4 casties 479:
1.9 casties 480: def isAccessible(self, docinfo):
1.8 casties 481: """returns if access to the resource is granted"""
482: access = docinfo.get('accessType', None)
1.95 abukhman 483: logging.debug("documentViewer (accessOK) access type %s"%access)
1.17 casties 484: if access is not None and access == 'free':
1.95 abukhman 485: logging.debug("documentViewer (accessOK) access is free")
1.8 casties 486: return True
1.17 casties 487: elif access is None or access in self.authgroups:
1.9 casties 488: # only local access -- only logged in users
489: user = getSecurityManager().getUser()
1.95 abukhman 490: logging.debug("documentViewer (accessOK) user=%s ip=%s"%(user,self.REQUEST.getClientAddr()))
1.9 casties 491: if user is not None:
492: #print "user: ", user
493: return (user.getUserName() != "Anonymous User")
494: else:
495: return False
1.8 casties 496:
1.95 abukhman 497: logging.error("documentViewer (accessOK) unknown access type %s"%access)
1.8 casties 498: return False
1.9 casties 499:
1.8 casties 500:
1.35 dwinter 501: def getDirinfoFromDigilib(self,path,docinfo=None,cut=0):
1.6 casties 502: """gibt param von dlInfo aus"""
1.7 casties 503: if docinfo is None:
504: docinfo = {}
1.35 dwinter 505:
506: for x in range(cut):
1.175.2.2 casties 507: path=getParentDir(path)
1.38 dwinter 508:
1.13 casties 509: infoUrl=self.digilibBaseUrl+"/dirInfo-xml.jsp?mo=dir&fn="+path
1.6 casties 510:
1.95 abukhman 511: logging.debug("documentViewer (getparamfromdigilib) dirInfo from %s"%(infoUrl))
1.6 casties 512:
1.70 casties 513: txt = getHttpData(infoUrl)
514: if txt is None:
1.13 casties 515: raise IOError("Unable to get dir-info from %s"%(infoUrl))
1.70 casties 516:
1.175.2.1 casties 517: dom = ET.fromstring(txt)
518: #dom = Parse(txt)
519: size=getText(dom.find("size"))
520: #sizes=dom.xpath("//dir/size")
521: logging.debug("documentViewer (getparamfromdigilib) dirInfo:size=%s"%size)
1.6 casties 522:
1.175.2.1 casties 523: if size:
524: docinfo['numPages'] = int(size)
1.7 casties 525: else:
526: docinfo['numPages'] = 0
1.43 casties 527:
528: # TODO: produce and keep list of image names and numbers
1.7 casties 529:
530: return docinfo
1.8 casties 531:
1.99 dwinter 532: def getIndexMetaPath(self,url):
533: """gib nur den Pfad zurueck"""
534: regexp = re.compile(r".*(experimental|permanent)/(.*)")
535: regpath = regexp.match(url)
536: if (regpath==None):
537: return ""
1.110 abukhman 538: logging.debug("(getDomFromIndexMeta): URLXAXA: %s"%regpath.group(2))
1.99 dwinter 539: return ("/mpiwg/online/"+regpath.group(1)+"/"+regpath.group(2))
540:
1.111 abukhman 541:
542:
1.99 dwinter 543: def getIndexMetaUrl(self,url):
544: """returns utr of index.meta document at url"""
545:
1.12 casties 546: metaUrl = None
1.9 casties 547: if url.startswith("http://"):
548: # real URL
1.12 casties 549: metaUrl = url
1.9 casties 550: else:
551: # online path
552: server=self.digilibBaseUrl+"/servlet/Texter?fn="
1.13 casties 553: metaUrl=server+url.replace("/mpiwg/online","")
1.9 casties 554: if not metaUrl.endswith("index.meta"):
555: metaUrl += "/index.meta"
1.99 dwinter 556:
557: return metaUrl
558:
559: def getDomFromIndexMeta(self, url):
560: """get dom from index meta"""
561: dom = None
562: metaUrl = self.getIndexMetaUrl(url)
1.12 casties 563:
1.99 dwinter 564: logging.debug("(getDomFromIndexMeta): METAURL: %s"%metaUrl)
1.70 casties 565: txt=getHttpData(metaUrl)
566: if txt is None:
1.12 casties 567: raise IOError("Unable to read index meta from %s"%(url))
1.70 casties 568:
1.175.2.1 casties 569: dom = ET.fromstring(txt)
570: #dom = Parse(txt)
1.9 casties 571: return dom
1.20 dwinter 572:
573: def getPresentationInfoXML(self, url):
574: """returns dom of info.xml document at url"""
575: dom = None
576: metaUrl = None
577: if url.startswith("http://"):
578: # real URL
579: metaUrl = url
580: else:
581: # online path
582: server=self.digilibBaseUrl+"/servlet/Texter?fn="
583: metaUrl=server+url.replace("/mpiwg/online","")
584:
1.70 casties 585: txt=getHttpData(metaUrl)
586: if txt is None:
1.20 dwinter 587: raise IOError("Unable to read infoXMLfrom %s"%(url))
1.70 casties 588:
1.175.2.1 casties 589: dom = ET.fromstring(txt)
590: #dom = Parse(txt)
1.20 dwinter 591: return dom
1.9 casties 592:
593:
1.33 dwinter 594: def getAuthinfoFromIndexMeta(self,path,docinfo=None,dom=None,cut=0):
1.9 casties 595: """gets authorization info from the index.meta file at path or given by dom"""
1.95 abukhman 596: logging.debug("documentViewer (getauthinfofromindexmeta) path: %s"%(path))
1.8 casties 597:
598: access = None
599:
600: if docinfo is None:
601: docinfo = {}
602:
603: if dom is None:
1.38 dwinter 604: for x in range(cut):
1.33 dwinter 605: path=getParentDir(path)
1.99 dwinter 606: dom = self.getDomFromIndexMeta(path)
1.18 dwinter 607:
1.175.2.1 casties 608: acc = dom.find(".//access-conditions/access")
609: if acc is not None:
610: acctype = acc.get('type')
611: #acctype = dom.xpath("//access-conditions/access/@type")
612: if acctype:
613: access=acctype
614: if access in ['group', 'institution']:
615: access = dom.find(".//access-conditions/access/name").text.lower()
1.8 casties 616:
617: docinfo['accessType'] = access
618: return docinfo
1.6 casties 619:
1.8 casties 620:
1.33 dwinter 621: def getBibinfoFromIndexMeta(self,path,docinfo=None,dom=None,cut=0):
1.9 casties 622: """gets bibliographical info from the index.meta file at path or given by dom"""
1.95 abukhman 623: logging.debug("documentViewer (getbibinfofromindexmeta) path: %s"%(path))
1.2 dwinter 624:
1.3 casties 625: if docinfo is None:
626: docinfo = {}
1.38 dwinter 627:
1.3 casties 628: if dom is None:
1.38 dwinter 629: for x in range(cut):
1.33 dwinter 630: path=getParentDir(path)
1.99 dwinter 631: dom = self.getDomFromIndexMeta(path)
632:
633: docinfo['indexMetaPath']=self.getIndexMetaPath(path);
1.39 dwinter 634:
1.95 abukhman 635: logging.debug("documentViewer (getbibinfofromindexmeta cutted) path: %s"%(path))
1.27 casties 636: # put in all raw bib fields as dict "bib"
1.175.2.2 casties 637: bib = dom.find(".//bib")
1.175.2.1 casties 638: #bib = dom.xpath("//bib/*")
1.175.2.2 casties 639: if bib is not None:
1.27 casties 640: bibinfo = {}
641: for e in bib:
1.175.2.2 casties 642: bibinfo[e.tag] = getText(e)
643:
1.27 casties 644: docinfo['bib'] = bibinfo
645:
646: # extract some fields (author, title, year) according to their mapping
1.4 casties 647: metaData=self.metadata.main.meta.bib
1.175.2.1 casties 648: bibtype=bib.get("type")
649: #bibtype=dom.xpath("//bib/@type")
650: if not bibtype:
1.4 casties 651: bibtype="generic"
1.27 casties 652:
1.4 casties 653: bibtype=bibtype.replace("-"," ") # wrong typesiin index meta "-" instead of " " (not wrong! ROC)
1.27 casties 654: docinfo['bib_type'] = bibtype
1.4 casties 655: bibmap=metaData.generateMappingForType(bibtype)
1.99 dwinter 656: logging.debug("documentViewer (getbibinfofromindexmeta) bibmap:"+repr(bibmap))
657: logging.debug("documentViewer (getbibinfofromindexmeta) bibtype:"+repr(bibtype))
1.8 casties 658: # if there is no mapping bibmap is empty (mapping sometimes has empty fields)
1.175.2.4! casties 659: logging.debug("bibmap: %s"%repr(bibmap))
! 660: if len(bibmap) > 0 and bibmap.get('author',None) or bibmap.get('title',None):
1.30 casties 661: try:
1.175.2.1 casties 662: docinfo['author']=getText(bib.find(bibmap['author'][0]))
1.30 casties 663: except: pass
664: try:
1.175.2.1 casties 665: docinfo['title']=getText(bib.find(bibmap['title'][0]))
1.30 casties 666: except: pass
667: try:
1.175.2.1 casties 668: docinfo['year']=getText(bib.find(bibmap['year'][0]))
1.30 casties 669: except: pass
1.175.2.1 casties 670:
671: # ROC: why is this here?
672: # logging.debug("documentViewer (getbibinfofromindexmeta) using mapping for %s"%bibtype)
673: # try:
674: # docinfo['lang']=getTextFromNode(dom.find(".//bib/lang")[0])
675: # except:
676: # docinfo['lang']=''
677: # try:
678: # docinfo['city']=getTextFromNode(dom.find(".//bib/city")[0])
679: # except:
680: # docinfo['city']=''
681: # try:
682: # docinfo['number_of_pages']=getTextFromNode(dom.find(".//bib/number_of_pages")[0])
683: # except:
684: # docinfo['number_of_pages']=''
685: # try:
686: # docinfo['series_volume']=getTextFromNode(dom.find(".//bib/series_volume")[0])
687: # except:
688: # docinfo['series_volume']=''
689: # try:
690: # docinfo['number_of_volumes']=getTextFromNode(dom.find(".//bib/number_of_volumes")[0])
691: # except:
692: # docinfo['number_of_volumes']=''
693: # try:
694: # docinfo['translator']=getTextFromNode(dom.find(".//bib/translator")[0])
695: # except:
696: # docinfo['translator']=''
697: # try:
698: # docinfo['edition']=getTextFromNode(dom.find(".//bib/edition")[0])
699: # except:
700: # docinfo['edition']=''
701: # try:
702: # docinfo['series_author']=getTextFromNode(dom.find(".//bib/series_author")[0])
703: # except:
704: # docinfo['series_author']=''
705: # try:
706: # docinfo['publisher']=getTextFromNode(dom.find(".//bib/publisher")[0])
707: # except:
708: # docinfo['publisher']=''
709: # try:
710: # docinfo['series_title']=getTextFromNode(dom.find(".//bib/series_title")[0])
711: # except:
712: # docinfo['series_title']=''
713: # try:
714: # docinfo['isbn_issn']=getTextFromNode(dom.find(".//bib/isbn_issn")[0])
715: # except:
716: # docinfo['isbn_issn']=''
1.3 casties 717: return docinfo
1.42 abukhman 718:
1.175.2.2 casties 719:
720: # TODO: is this needed?
1.104 abukhman 721: def getNameFromIndexMeta(self,path,docinfo=None,dom=None,cut=0):
722: """gets name info from the index.meta file at path or given by dom"""
723: if docinfo is None:
724: docinfo = {}
725:
726: if dom is None:
727: for x in range(cut):
728: path=getParentDir(path)
729: dom = self.getDomFromIndexMeta(path)
1.125 abukhman 730:
1.175.2.1 casties 731: docinfo['name']=getText(dom.find("name"))
1.116 abukhman 732: logging.debug("documentViewer docinfo[name] %s"%docinfo['name'])
1.104 abukhman 733: return docinfo
1.42 abukhman 734:
1.43 casties 735: def getDocinfoFromTextTool(self, url, dom=None, docinfo=None):
736: """parse texttool tag in index meta"""
1.95 abukhman 737: logging.debug("documentViewer (getdocinfofromtexttool) url: %s" % (url))
1.43 casties 738: if docinfo is None:
739: docinfo = {}
740: if docinfo.get('lang', None) is None:
741: docinfo['lang'] = '' # default keine Sprache gesetzt
742: if dom is None:
1.99 dwinter 743: dom = self.getDomFromIndexMeta(url)
1.43 casties 744:
745: archivePath = None
746: archiveName = None
747:
1.175.2.2 casties 748: archiveName = getText(dom.find("name"))
1.175.2.1 casties 749: if not archiveName:
1.70 casties 750: logging.warning("documentViewer (getdocinfofromtexttool) resource/name missing in: %s" % (url))
1.43 casties 751:
1.175.2.2 casties 752: archivePath = getText(dom.find("archive-path"))
1.175.2.1 casties 753: if archivePath:
1.43 casties 754: # clean up archive path
755: if archivePath[0] != '/':
756: archivePath = '/' + archivePath
757: if archiveName and (not archivePath.endswith(archiveName)):
758: archivePath += "/" + archiveName
759: else:
760: # try to get archive-path from url
1.95 abukhman 761: logging.warning("documentViewer (getdocinfofromtexttool) resource/archive-path missing in: %s" % (url))
1.43 casties 762: if (not url.startswith('http')):
763: archivePath = url.replace('index.meta', '')
764:
765: if archivePath is None:
766: # we balk without archive-path
767: raise IOError("Missing archive-path (for text-tool) in %s" % (url))
768:
1.175.2.1 casties 769: imageDir = getText(dom.find(".//texttool/image"))
1.43 casties 770:
1.175.2.1 casties 771: if not imageDir:
1.43 casties 772: # we balk with no image tag / not necessary anymore because textmode is now standard
773: #raise IOError("No text-tool info in %s"%(url))
774: imageDir = ""
775: #xquery="//pb"
776: docinfo['imagePath'] = "" # keine Bilder
777: docinfo['imageURL'] = ""
778:
779: if imageDir and archivePath:
780: #print "image: ", imageDir, " archivepath: ", archivePath
781: imageDir = os.path.join(archivePath, imageDir)
782: imageDir = imageDir.replace("/mpiwg/online", '')
783: docinfo = self.getDirinfoFromDigilib(imageDir, docinfo=docinfo)
784: docinfo['imagePath'] = imageDir
785:
786: docinfo['imageURL'] = self.digilibBaseUrl + "/servlet/Scaler?fn=" + imageDir
787:
1.175.2.1 casties 788: viewerUrl = getText(dom.find(".//texttool/digiliburlprefix"))
789: if viewerUrl:
1.43 casties 790: docinfo['viewerURL'] = viewerUrl
1.70 casties 791:
792: # old style text URL
1.175.2.1 casties 793: textUrl = getText(dom.find(".//texttool/text"))
794: if textUrl:
1.43 casties 795: if urlparse.urlparse(textUrl)[0] == "": #keine url
796: textUrl = os.path.join(archivePath, textUrl)
797: # fix URLs starting with /mpiwg/online
798: if textUrl.startswith("/mpiwg/online"):
799: textUrl = textUrl.replace("/mpiwg/online", '', 1)
800:
801: docinfo['textURL'] = textUrl
802:
1.70 casties 803: # new style text-url-path
1.175.2.1 casties 804: textUrl = getText(dom.find(".//texttool/text-url-path"))
805: if textUrl:
1.51 casties 806: docinfo['textURLPath'] = textUrl
1.169 abukhman 807: textUrlkurz = string.split(textUrl, ".")[0]
808: docinfo['textURLPathkurz'] = textUrlkurz
1.163 abukhman 809: #if not docinfo['imagePath']:
1.51 casties 810: # text-only, no page images
1.163 abukhman 811: #docinfo = self.getNumTextPages(docinfo)
812:
1.43 casties 813:
1.175.2.1 casties 814: presentationUrl = getText(dom.find(".//texttool/presentation"))
1.43 casties 815: docinfo = self.getBibinfoFromIndexMeta(url, docinfo=docinfo, dom=dom) # get info von bib tag
1.175.2.2 casties 816: # TODO: is this needed here?
1.114 abukhman 817: docinfo = self.getNameFromIndexMeta(url, docinfo=docinfo, dom=dom)
1.147 abukhman 818:
1.43 casties 819:
1.175.2.1 casties 820: if presentationUrl: # ueberschreibe diese durch presentation informationen
1.43 casties 821: # presentation url ergiebt sich ersetzen von index.meta in der url der fuer die Metadaten
822: # durch den relativen Pfad auf die presentation infos
1.175.2.1 casties 823: presentationPath = presentationUrl
1.43 casties 824: if url.endswith("index.meta"):
825: presentationUrl = url.replace('index.meta', presentationPath)
826: else:
827: presentationUrl = url + "/" + presentationPath
1.51 casties 828:
1.43 casties 829: docinfo = self.getBibinfoFromTextToolPresentation(presentationUrl, docinfo=docinfo, dom=dom)
830:
831: docinfo = self.getAuthinfoFromIndexMeta(url, docinfo=docinfo, dom=dom) # get access info
1.3 casties 832:
1.43 casties 833: return docinfo
1.3 casties 834:
1.20 dwinter 835:
836: def getBibinfoFromTextToolPresentation(self,url,docinfo=None,dom=None):
837: """gets the bibliographical information from the preseantion entry in texttools
838: """
839: dom=self.getPresentationInfoXML(url)
1.175.2.2 casties 840: docinfo['author']=getText(dom.find(".//author"))
841: docinfo['title']=getText(dom.find(".//title"))
842: docinfo['year']=getText(dom.find(".//date"))
1.20 dwinter 843: return docinfo
844:
1.33 dwinter 845: def getDocinfoFromImagePath(self,path,docinfo=None,cut=0):
1.3 casties 846: """path ist the path to the images it assumes that the index.meta file is one level higher."""
1.95 abukhman 847: logging.debug("documentViewer (getdocinfofromimagepath) path: %s"%(path))
1.3 casties 848: if docinfo is None:
849: docinfo = {}
1.6 casties 850: path=path.replace("/mpiwg/online","")
1.3 casties 851: docinfo['imagePath'] = path
1.35 dwinter 852: docinfo=self.getDirinfoFromDigilib(path,docinfo=docinfo,cut=cut)
1.38 dwinter 853:
1.39 dwinter 854: pathorig=path
1.38 dwinter 855: for x in range(cut):
856: path=getParentDir(path)
1.95 abukhman 857: logging.debug("documentViewer (getdocinfofromimagepath) PATH:"+path)
1.7 casties 858: imageUrl=self.digilibBaseUrl+"/servlet/Scaler?fn="+path
1.3 casties 859: docinfo['imageURL'] = imageUrl
860:
1.39 dwinter 861: #path ist the path to the images it assumes that the index.meta file is one level higher.
862: docinfo = self.getBibinfoFromIndexMeta(pathorig,docinfo=docinfo,cut=cut+1)
863: docinfo = self.getAuthinfoFromIndexMeta(pathorig,docinfo=docinfo,cut=cut+1)
1.3 casties 864: return docinfo
865:
1.2 dwinter 866:
1.3 casties 867: def getDocinfo(self, mode, url):
868: """returns docinfo depending on mode"""
1.95 abukhman 869: logging.debug("documentViewer (getdocinfo) mode: %s, url: %s"%(mode,url))
1.3 casties 870: # look for cached docinfo in session
1.21 dwinter 871: if self.REQUEST.SESSION.has_key('docinfo'):
1.3 casties 872: docinfo = self.REQUEST.SESSION['docinfo']
873: # check if its still current
874: if docinfo is not None and docinfo.get('mode') == mode and docinfo.get('url') == url:
1.175.2.3 casties 875: logging.debug("documentViewer (getdocinfo) docinfo in session. keys=%s"%docinfo.keys())
1.3 casties 876: return docinfo
1.175.2.3 casties 877:
1.3 casties 878: # new docinfo
879: docinfo = {'mode': mode, 'url': url}
1.175.2.3 casties 880: # add self url
881: docinfo['viewerUrl'] = self.getDocumentViewerURL()
882: if mode=="texttool":
883: # index.meta with texttool information
1.3 casties 884: docinfo = self.getDocinfoFromTextTool(url, docinfo=docinfo)
885: elif mode=="imagepath":
1.175.2.3 casties 886: # folder with images, index.meta optional
1.3 casties 887: docinfo = self.getDocinfoFromImagePath(url, docinfo=docinfo)
1.33 dwinter 888: elif mode=="filepath":
1.175.2.3 casties 889: # filename
1.37 dwinter 890: docinfo = self.getDocinfoFromImagePath(url, docinfo=docinfo,cut=1)
1.3 casties 891: else:
1.95 abukhman 892: logging.error("documentViewer (getdocinfo) unknown mode: %s!"%mode)
1.44 casties 893: raise ValueError("Unknown mode %s! Has to be one of 'texttool','imagepath','filepath'."%(mode))
1.159 casties 894:
895: # FIXME: fake texturlpath
896: if not docinfo.has_key('textURLPath'):
897: docinfo['textURLPath'] = None
898:
1.95 abukhman 899: logging.debug("documentViewer (getdocinfo) docinfo: %s"%docinfo)
1.142 abukhman 900: #logging.debug("documentViewer (getdocinfo) docinfo: %s"%)
1.3 casties 901: self.REQUEST.SESSION['docinfo'] = docinfo
902: return docinfo
1.69 abukhman 903:
1.158 casties 904: def getPageinfo(self, current, start=None, rows=None, cols=None, docinfo=None, viewMode=None, tocMode=None):
1.3 casties 905: """returns pageinfo with the given parameters"""
906: pageinfo = {}
1.4 casties 907: current = getInt(current)
1.132 abukhman 908:
1.4 casties 909: pageinfo['current'] = current
910: rows = int(rows or self.thumbrows)
911: pageinfo['rows'] = rows
912: cols = int(cols or self.thumbcols)
913: pageinfo['cols'] = cols
914: grpsize = cols * rows
915: pageinfo['groupsize'] = grpsize
1.28 casties 916: start = getInt(start, default=(math.ceil(float(current)/float(grpsize))*grpsize-(grpsize-1)))
917: # int(current / grpsize) * grpsize +1))
1.3 casties 918: pageinfo['start'] = start
1.4 casties 919: pageinfo['end'] = start + grpsize
1.44 casties 920: if (docinfo is not None) and ('numPages' in docinfo):
1.4 casties 921: np = int(docinfo['numPages'])
922: pageinfo['end'] = min(pageinfo['end'], np)
923: pageinfo['numgroups'] = int(np / grpsize)
924: if np % grpsize > 0:
1.69 abukhman 925: pageinfo['numgroups'] += 1
1.44 casties 926: pageinfo['viewMode'] = viewMode
927: pageinfo['tocMode'] = tocMode
1.161 abukhman 928: pageinfo['characterNormalization'] = self.REQUEST.get('characterNormalization','reg')
1.174 abukhman 929: #pageinfo['optionToggle'] = self.REQUEST.get('optionToggle','1')
1.156 abukhman 930: pageinfo['query'] = self.REQUEST.get('query','')
1.146 abukhman 931: pageinfo['queryType'] = self.REQUEST.get('queryType','')
1.45 abukhman 932: pageinfo['querySearch'] =self.REQUEST.get('querySearch', 'fulltext')
1.48 abukhman 933: pageinfo['textPN'] = self.REQUEST.get('textPN','1')
1.146 abukhman 934: pageinfo['highlightQuery'] = self.REQUEST.get('highlightQuery','')
1.45 abukhman 935: pageinfo['tocPageSize'] = self.REQUEST.get('tocPageSize', '30')
1.54 abukhman 936: pageinfo['queryPageSize'] =self.REQUEST.get('queryPageSize', '10')
1.170 abukhman 937: pageinfo['tocPN'] = self.REQUEST.get('tocPN', '1')
1.48 abukhman 938: toc = int (pageinfo['tocPN'])
939: pageinfo['textPages'] =int (toc)
1.90 abukhman 940:
1.48 abukhman 941: if 'tocSize_%s'%tocMode in docinfo:
942: tocSize = int(docinfo['tocSize_%s'%tocMode])
943: tocPageSize = int(pageinfo['tocPageSize'])
1.69 abukhman 944: # cached toc
1.48 abukhman 945: if tocSize%tocPageSize>0:
946: tocPages=tocSize/tocPageSize+1
947: else:
948: tocPages=tocSize/tocPageSize
1.69 abukhman 949: pageinfo['tocPN'] = min (tocPages,toc)
1.45 abukhman 950: pageinfo['searchPN'] =self.REQUEST.get('searchPN','1')
1.59 abukhman 951: pageinfo['sn'] =self.REQUEST.get('sn','')
1.3 casties 952: return pageinfo
953:
1.69 abukhman 954: def changeDocumentViewer(self,title="",digilibBaseUrl=None,thumbrows=2,thumbcols=5,authgroups='mpiwg',RESPONSE=None):
1.3 casties 955: """init document viewer"""
956: self.title=title
957: self.digilibBaseUrl = digilibBaseUrl
1.4 casties 958: self.thumbrows = thumbrows
959: self.thumbcols = thumbcols
1.8 casties 960: self.authgroups = [s.strip().lower() for s in authgroups.split(',')]
1.3 casties 961: if RESPONSE is not None:
962: RESPONSE.redirect('manage_main')
1.1 dwinter 963:
964: def manage_AddDocumentViewerForm(self):
965: """add the viewer form"""
1.3 casties 966: pt=PageTemplateFile('zpt/addDocumentViewer', globals()).__of__(self)
1.1 dwinter 967: return pt()
968:
1.43 casties 969: def manage_AddDocumentViewer(self,id,imageScalerUrl="",textServerName="",title="",RESPONSE=None):
1.1 dwinter 970: """add the viewer"""
1.43 casties 971: newObj=documentViewer(id,imageScalerUrl=imageScalerUrl,title=title,textServerName=textServerName)
1.1 dwinter 972: self._setObject(id,newObj)
973:
974: if RESPONSE is not None:
975: RESPONSE.redirect('manage_main')
1.3 casties 976:
977: ## DocumentViewerTemplate class
978: class DocumentViewerTemplate(ZopePageTemplate):
979: """Template for document viewer"""
980: meta_type="DocumentViewer Template"
981:
982:
983: def manage_addDocumentViewerTemplateForm(self):
984: """Form for adding"""
985: pt=PageTemplateFile('zpt/addDocumentViewerTemplate', globals()).__of__(self)
986: return pt()
987:
988: def manage_addDocumentViewerTemplate(self, id='viewer_main', title=None, text=None,
989: REQUEST=None, submit=None):
990: "Add a Page Template with optional file content."
991:
992: self._setObject(id, DocumentViewerTemplate(id))
993: ob = getattr(self, id)
1.23 dwinter 994: txt=file(os.path.join(package_home(globals()),'zpt/viewer_main.zpt'),'r').read()
1.95 abukhman 995: logging.info("txt %s:"%txt)
1.23 dwinter 996: ob.pt_edit(txt,"text/html")
1.3 casties 997: if title:
998: ob.pt_setTitle(title)
999: try:
1000: u = self.DestinationURL()
1001: except AttributeError:
1002: u = REQUEST['URL1']
1003:
1004: u = "%s/%s" % (u, urllib.quote(id))
1005: REQUEST.RESPONSE.redirect(u+'/manage_main')
1006: return ''
1007:
1008:
1.14 casties 1009:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>