Annotation of documentViewer/documentViewer.py, revision 1.175.2.25

1.1       dwinter     1: from OFS.Folder import Folder
                      2: from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate
1.22      dwinter     3: from Products.PageTemplates.PageTemplateFile import PageTemplateFile 
1.1       dwinter     4: from AccessControl import ClassSecurityInfo
1.8       casties     5: from AccessControl import getSecurityManager
1.1       dwinter     6: from Globals import package_home
                      7: 
1.175.2.1  casties     8: #from Ft.Xml import EMPTY_NAMESPACE, Parse 
                      9: #import Ft.Xml.Domlette
                     10: 
                     11: import xml.etree.ElementTree as ET
                     12: 
1.1       dwinter    13: import os.path
1.7       casties    14: import sys
1.1       dwinter    15: import urllib
1.20      dwinter    16: import logging
1.28      casties    17: import math
1.18      dwinter    18: import urlparse 
1.99      dwinter    19: import re
1.149     abukhman   20: import string
1.117     abukhman   21: 
1.175.2.5  casties    22: from SrvTxtUtils import getInt, getText, getHttpData
                     23: 
1.22      dwinter    24: def logger(txt,method,txt2):
                     25:     """logging"""
                     26:     logging.info(txt+ txt2)
                     27:     
                     28:     
1.170     abukhman   29: def serializeNode(node, encoding="utf-8"):
1.43      casties    30:     """returns a string containing node as XML"""
1.175.2.1  casties    31:     s = ET.tostring(node)
                     32:     
                     33:     # 4Suite:
                     34:     #    stream = cStringIO.StringIO()
                     35:     #    Ft.Xml.Domlette.Print(node, stream=stream, encoding=encoding)
                     36:     #    s = stream.getvalue()
                     37:     #    stream.close()
1.43      casties    38:     return s
                     39: 
1.148     abukhman   40: def browserCheck(self):
                     41:     """check the browsers request to find out the browser type"""
                     42:     bt = {}
                     43:     ua = self.REQUEST.get_header("HTTP_USER_AGENT")
                     44:     bt['ua'] = ua
                     45:     bt['isIE'] = False
                     46:     bt['isN4'] = False
1.165     abukhman   47:     bt['versFirefox']=""
                     48:     bt['versIE']=""
                     49:     bt['versSafariChrome']=""
                     50:     bt['versOpera']=""
                     51:     
1.148     abukhman   52:     if string.find(ua, 'MSIE') > -1:
                     53:         bt['isIE'] = True
                     54:     else:
                     55:         bt['isN4'] = (string.find(ua, 'Mozilla/4.') > -1)
1.165     abukhman   56:     # Safari oder Chrome identification    
                     57:     try:
                     58:         nav = ua[string.find(ua, '('):]
                     59:         nav1=ua[string.find(ua,')'):]
                     60:         nav2=nav1[string.find(nav1,'('):]
                     61:         nav3=nav2[string.find(nav2,')'):]
                     62:         ie = string.split(nav, "; ")[1]
                     63:         ie1 =string.split(nav1, " ")[2]
                     64:         ie2 =string.split(nav3, " ")[1]
                     65:         ie3 =string.split(nav3, " ")[2]
                     66:         if string.find(ie3, "Safari") >-1:
                     67:             bt['versSafariChrome']=string.split(ie2, "/")[1]
                     68:     except: pass
                     69:     # IE identification
1.148     abukhman   70:     try:
                     71:         nav = ua[string.find(ua, '('):]
                     72:         ie = string.split(nav, "; ")[1]
                     73:         if string.find(ie, "MSIE") > -1:
                     74:             bt['versIE'] = string.split(ie, " ")[1]
1.165     abukhman   75:     except:pass
                     76:     # Firefox identification
                     77:     try:
                     78:         nav = ua[string.find(ua, '('):]
                     79:         nav1=ua[string.find(ua,')'):]
                     80:         if string.find(ie1, "Firefox") >-1:
                     81:             nav5= string.split(ie1, "/")[1]
                     82:             logging.debug("FIREFOX: %s"%(nav5))
1.166     abukhman   83:             bt['versFirefox']=nav5[0:3]                   
1.165     abukhman   84:     except:pass
                     85:     #Opera identification
                     86:     try:
                     87:         if string.find(ua,"Opera") >-1:
                     88:             nav = ua[string.find(ua, '('):]
                     89:             nav1=nav[string.find(nav,')'):]
                     90:             bt['versOpera']=string.split(nav1,"/")[2]
                     91:     except:pass
1.148     abukhman   92:     
                     93:     bt['isMac'] = string.find(ua, 'Macintosh') > -1
                     94:     bt['isWin'] = string.find(ua, 'Windows') > -1
                     95:     bt['isIEWin'] = bt['isIE'] and bt['isWin']
                     96:     bt['isIEMac'] = bt['isIE'] and bt['isMac']
                     97:     bt['staticHTML'] = False
                     98: 
                     99:     return bt
1.118     abukhman  100: 
1.175.2.11  casties   101: def getParentPath(path, cnt=1):
                    102:     """returns pathname shortened by cnt"""
                    103:     # make sure path doesn't end with /
                    104:     path = path.rstrip('/')
                    105:     # split by /, shorten, and reassemble
                    106:     return '/'.join(path.split('/')[0:-cnt])
                    107: 
1.175.2.8  casties   108: 
1.3       casties   109: ##
                    110: ## documentViewer class
                    111: ##
                    112: class documentViewer(Folder):
1.1       dwinter   113:     """document viewer"""
                    114:     meta_type="Document viewer"
                    115:     
                    116:     security=ClassSecurityInfo()
1.3       casties   117:     manage_options=Folder.manage_options+(
1.1       dwinter   118:         {'label':'main config','action':'changeDocumentViewerForm'},
                    119:         )
1.175.2.10  casties   120:     
                    121:     metadataService = None
                    122:     """MetaDataFolder instance"""
1.1       dwinter   123: 
1.3       casties   124:     # templates and forms
1.175.2.25! casties   125:     viewer_text = PageTemplateFile('zpt/viewer_text', globals())
1.3       casties   126:     viewer_main = PageTemplateFile('zpt/viewer_main', globals())
1.44      casties   127:     toc_thumbs = PageTemplateFile('zpt/toc_thumbs', globals())
                    128:     toc_text = PageTemplateFile('zpt/toc_text', globals())
                    129:     toc_figures = PageTemplateFile('zpt/toc_figures', globals())
1.43      casties   130:     page_main_images = PageTemplateFile('zpt/page_main_images', globals())
1.161     abukhman  131:     page_main_double = PageTemplateFile('zpt/page_main_double', globals())
1.43      casties   132:     page_main_text = PageTemplateFile('zpt/page_main_text', globals())
1.44      casties   133:     page_main_text_dict = PageTemplateFile('zpt/page_main_text_dict', globals())
1.77      abukhman  134:     page_main_gis =PageTemplateFile ('zpt/page_main_gis', globals())
1.48      abukhman  135:     page_main_xml = PageTemplateFile('zpt/page_main_xml', globals())
1.157     abukhman  136:     page_main_pureXml = PageTemplateFile('zpt/page_main_pureXml', globals())
1.3       casties   137:     head_main = PageTemplateFile('zpt/head_main', globals())
                    138:     docuviewer_css = PageTemplateFile('css/docuviewer.css', globals())
1.26      casties   139:     info_xml = PageTemplateFile('zpt/info_xml', globals())
1.70      casties   140:     
                    141:     
1.32      dwinter   142:     thumbs_main_rss = PageTemplateFile('zpt/thumbs_main_rss', globals())
1.3       casties   143: 
1.1       dwinter   144:     
1.45      abukhman  145:     def __init__(self,id,imageScalerUrl=None,textServerName=None,title="",digilibBaseUrl=None,thumbcols=2,thumbrows=5,authgroups="mpiwg"):
1.1       dwinter   146:         """init document viewer"""
                    147:         self.id=id
                    148:         self.title=title
1.4       casties   149:         self.thumbcols = thumbcols
                    150:         self.thumbrows = thumbrows
1.8       casties   151:         # authgroups is list of authorized groups (delimited by ,)
                    152:         self.authgroups = [s.strip().lower() for s in authgroups.split(',')]
1.43      casties   153:         # create template folder so we can always use template.something
                    154:         
                    155:         templateFolder = Folder('template')
                    156:         #self['template'] = templateFolder # Zope-2.12 style
                    157:         self._setObject('template',templateFolder) # old style
                    158:         try:
1.70      casties   159:             import MpdlXmlTextServer
1.71      casties   160:             textServer = MpdlXmlTextServer.MpdlXmlTextServer(id='fulltextclient',serverName=textServerName)
1.43      casties   161:             #templateFolder['fulltextclient'] = xmlRpcClient
1.70      casties   162:             templateFolder._setObject('fulltextclient',textServer)
1.43      casties   163:         except Exception, e:
1.70      casties   164:             logging.error("Unable to create MpdlXmlTextServer for fulltextclient: "+str(e))
1.175.2.10  casties   165:             
1.43      casties   166:         try:
                    167:             from Products.zogiLib.zogiLib import zogiLib
                    168:             zogilib = zogiLib(id="zogilib", title="zogilib for docuviewer", dlServerURL=imageScalerUrl, layout="book")
                    169:             #templateFolder['zogilib'] = zogilib
                    170:             templateFolder._setObject('zogilib',zogilib)
                    171:         except Exception, e:
                    172:             logging.error("Unable to create zogiLib for zogilib: "+str(e))
1.175.2.10  casties   173:             
                    174:         try:
                    175:             # assume MetaDataFolder instance is called metadata 
                    176:             self.metadataService = getattr(self, 'metadata')
                    177:         except Exception, e:
                    178:             logging.error("Unable to find MetaDataFolder 'metadata': "+str(e))
                    179:             
1.175.2.23  casties   180:         if digilibBaseUrl is not None:
                    181:             self.digilibBaseUrl = digilibBaseUrl
                    182:             
1.70      casties   183:         
                    184:     # proxy text server methods to fulltextclient
                    185:     def getTextPage(self, **args):
                    186:         """get page"""
                    187:         return self.template.fulltextclient.getTextPage(**args)
1.171     abukhman  188: 
                    189:     def getOrigPages(self, **args):
                    190:         """get page"""
                    191:         return self.template.fulltextclient.getOrigPages(**args)
1.167     abukhman  192:     
1.171     abukhman  193:     def getOrigPagesNorm(self, **args):
                    194:         """get page"""
                    195:         return self.template.fulltextclient.getOrigPagesNorm(**args)
                    196: 
1.70      casties   197:     def getQuery(self, **args):
1.163     abukhman  198:         """get query in search"""
1.70      casties   199:         return self.template.fulltextclient.getQuery(**args)
1.163     abukhman  200:      
1.70      casties   201:     def getSearch(self, **args):
                    202:         """get search"""
                    203:         return self.template.fulltextclient.getSearch(**args)
1.120     abukhman  204:     
                    205:     def getGisPlaces(self, **args):
1.121     abukhman  206:         """get gis places"""
1.120     abukhman  207:         return self.template.fulltextclient.getGisPlaces(**args)
1.121     abukhman  208:  
                    209:     def getAllGisPlaces(self, **args):
1.122     abukhman  210:         """get all gis places """
                    211:         return self.template.fulltextclient.getAllGisPlaces(**args)
1.163     abukhman  212:        
1.175.2.24  casties   213:     def getWordInfo(self, **args):
1.70      casties   214:         """get translate"""
1.175.2.24  casties   215:         return self.template.fulltextclient.getWordInfo(**args)
1.70      casties   216: 
                    217:     def getLemma(self, **args):
                    218:         """get lemma"""
                    219:         return self.template.fulltextclient.getLemma(**args)
                    220: 
1.173     abukhman  221:     def getLemmaQuery(self, **args):
                    222:         """get query"""
                    223:         return self.template.fulltextclient.getLemmaQuery(**args)
                    224: 
                    225:     def getLex(self, **args):
                    226:         """get lex"""
                    227:         return self.template.fulltextclient.getLex(**args)
                    228: 
1.70      casties   229:     def getToc(self, **args):
                    230:         """get toc"""
                    231:         return self.template.fulltextclient.getToc(**args)
                    232: 
                    233:     def getTocPage(self, **args):
                    234:         """get tocpage"""
                    235:         return self.template.fulltextclient.getTocPage(**args)
1.3       casties   236: 
1.70      casties   237:     
1.32      dwinter   238:     security.declareProtected('View','thumbs_rss')
                    239:     def thumbs_rss(self,mode,url,viewMode="auto",start=None,pn=1):
                    240:         '''
                    241:         view it
                    242:         @param mode: defines how to access the document behind url 
                    243:         @param url: url which contains display information
                    244:         @param viewMode: if images display images, if text display text, default is images (text,images or auto)
                    245:         
                    246:         '''
1.95      abukhman  247:         logging.debug("HHHHHHHHHHHHHH:load the rss")
1.175.2.5  casties   248:         logging.debug("documentViewer (index) mode: %s url:%s start:%s pn:%s"%(mode,url,start,pn))
1.32      dwinter   249:         
                    250:         if not hasattr(self, 'template'):
                    251:             # create template folder if it doesn't exist
                    252:             self.manage_addFolder('template')
                    253:             
                    254:         if not self.digilibBaseUrl:
                    255:             self.digilibBaseUrl = self.findDigilibUrl() or "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary"
                    256:             
                    257:         docinfo = self.getDocinfo(mode=mode,url=url)
1.132     abukhman  258:         #pageinfo = self.getPageinfo(start=start,current=pn,docinfo=docinfo)
1.138     abukhman  259:         pageinfo = self.getPageinfo(start=start,current=pn, docinfo=docinfo)
1.126     abukhman  260:         ''' ZDES '''
1.32      dwinter   261:         pt = getattr(self.template, 'thumbs_main_rss')
                    262:         
                    263:         if viewMode=="auto": # automodus gewaehlt
1.159     casties   264:             if docinfo.has_key("textURL") or docinfo.get('textURLPath',None): #texturl gesetzt und textViewer konfiguriert
1.32      dwinter   265:                 viewMode="text"
                    266:             else:
                    267:                 viewMode="images"
                    268:                
                    269:         return pt(docinfo=docinfo,pageinfo=pageinfo,viewMode=viewMode)
1.175.2.12  casties   270: 
1.32      dwinter   271:   
1.3       casties   272:     security.declareProtected('View','index_html')
1.175.2.18  casties   273:     def index_html(self,url,mode="texttool",viewMode="auto",viewType=None,tocMode="thumbs",start=1,pn=1):
1.175.2.11  casties   274:         """
1.175.2.17  casties   275:         view page
1.3       casties   276:         @param url: url which contains display information
1.175.2.17  casties   277:         @param mode: defines how to access the document behind url 
                    278:         @param viewMode: 'images': display images, 'text': display text, default is 'auto'
                    279:         @param viewType: sub-type of viewMode, e.g. 'dict' for viewMode='text'
1.48      abukhman  280:         @param tocMode: type of 'table of contents' for navigation (thumbs, text, figures, none)
1.175.2.11  casties   281:         """
1.3       casties   282:         
1.175.2.21  casties   283:         logging.debug("documentViewer(index_html) mode=%s url=%s viewMode=%s viewType=%s start=%s pn=%s"%(mode,url,viewMode,viewType,start,pn))
1.1       dwinter   284:         
1.3       casties   285:         if not hasattr(self, 'template'):
1.43      casties   286:             # this won't work
                    287:             logging.error("template folder missing!")
                    288:             return "ERROR: template folder missing!"
1.3       casties   289:             
1.43      casties   290:         if not getattr(self, 'digilibBaseUrl', None):
1.71      casties   291:             self.digilibBaseUrl = self.findDigilibUrl() or "http://digilib.mpiwg-berlin.mpg.de/digitallibrary"
1.3       casties   292:             
1.4       casties   293:         docinfo = self.getDocinfo(mode=mode,url=url)
1.47      abukhman  294:         
1.44      casties   295:         if tocMode != "thumbs":
                    296:             # get table of contents
                    297:             docinfo = self.getToc(mode=tocMode, docinfo=docinfo)
1.175.2.3  casties   298: 
1.175.2.17  casties   299:         # auto viewMode: text if there is a text else images
1.175.2.3  casties   300:         if viewMode=="auto": 
                    301:             if docinfo.get('textURL', None) or docinfo.get('textURLPath', None): 
1.175.2.17  casties   302:                 viewMode = "text"
                    303:                 viewType = "dict"
1.21      dwinter   304:             else:
1.175.2.17  casties   305:                 viewMode = "images"
1.44      casties   306:                 
1.175.2.20  casties   307:         elif viewMode == "text_dict":
                    308:             # legacy fix
                    309:             viewMode = "text"
                    310:             viewType = "dict"
                    311:             
1.175.2.21  casties   312:         # stringify viewType
                    313:         if isinstance(viewType, list):
1.175.2.24  casties   314:             logging.debug("index_html: viewType is list:%s"%viewType)
1.175.2.21  casties   315:             viewType = ','.join([t for t in viewType if t])
                    316:                         
1.175.2.18  casties   317:         pageinfo = self.getPageinfo(start=start, current=pn, docinfo=docinfo, viewMode=viewMode, viewType=viewType, tocMode=tocMode)
1.175.2.16  casties   318:                     
1.175.2.21  casties   319:         # get template /template/viewer_$viewMode
                    320:         pt = getattr(self.template, 'viewer_%s'%viewMode, None)
                    321:         if pt is None:
                    322:             logging.error("No template for viewMode=%s!"%viewMode)
                    323:             # TODO: error page?
                    324:             return "No template for viewMode=%s!"%viewMode
                    325:         
1.175.2.3  casties   326:         # and execute with parameters
1.175.2.17  casties   327:         return pt(docinfo=docinfo, pageinfo=pageinfo)
1.1       dwinter   328:   
1.36      dwinter   329:     def generateMarks(self,mk):
                    330:         ret=""
1.44      casties   331:         if mk is None:
                    332:             return ""
1.73      casties   333:         if not isinstance(mk, list):
1.71      casties   334:             mk=[mk]
1.36      dwinter   335:         for m in mk:
1.37      dwinter   336:             ret+="mk=%s"%m
1.36      dwinter   337:         return ret
1.149     abukhman  338:     
                    339:     
1.148     abukhman  340:     def getBrowser(self):
                    341:         """getBrowser the version of browser """
1.162     casties   342:         bt = browserCheck(self)
1.164     abukhman  343:         logging.debug("BROWSER VERSION: %s"%(bt))
1.162     casties   344:         return bt
1.148     abukhman  345:         
1.43      casties   346:     def findDigilibUrl(self):
                    347:         """try to get the digilib URL from zogilib"""
                    348:         url = self.template.zogilib.getDLBaseUrl()
                    349:         return url
1.67      casties   350: 
                    351:     def getDocumentViewerURL(self):
                    352:         """returns the URL of this instance"""
                    353:         return self.absolute_url()
1.43      casties   354:     
                    355:     def getStyle(self, idx, selected, style=""):
                    356:         """returns a string with the given style and append 'sel' if path == selected."""
                    357:         #logger("documentViewer (getstyle)", logging.INFO, "idx: %s selected: %s style: %s"%(idx,selected,style))
                    358:         if idx == selected:
                    359:             return style + 'sel'
                    360:         else:
                    361:             return style
1.36      dwinter   362:     
1.175.2.24  casties   363:     def getParams(self, param=None, val=None, params=None, duplicates=None):
1.175.2.16  casties   364:         """returns dict with URL parameters.
                    365:         
                    366:         Takes URL parameters and additionally param=val or dict params.
                    367:         Deletes key if value is None."""
1.162     casties   368:         # copy existing request params
1.175.2.16  casties   369:         newParams=self.REQUEST.form.copy()
1.162     casties   370:         # change single param
1.4       casties   371:         if param is not None:
1.7       casties   372:             if val is None:
1.175.2.16  casties   373:                 if newParams.has_key(param):
                    374:                     del newParams[param]
1.4       casties   375:             else:
1.175.2.16  casties   376:                 newParams[param] = str(val)
1.43      casties   377:                 
1.162     casties   378:         # change more params
                    379:         if params is not None:
1.175.2.24  casties   380:             for (k, v) in params.items():
1.162     casties   381:                 if v is None:
                    382:                     # val=None removes param
1.175.2.16  casties   383:                     if newParams.has_key(k):
                    384:                         del newParams[k]
1.162     casties   385:                         
                    386:                 else:
1.175.2.16  casties   387:                     newParams[k] = v
1.175.2.24  casties   388: 
                    389:         if duplicates:
                    390:             # eliminate lists (coming from duplicate keys)
                    391:             for (k,v) in newParams.items():
                    392:                 if isinstance(v, list):
                    393:                     if duplicates == 'comma':
                    394:                         # make comma-separated list of non-empty entries
                    395:                         newParams[k] = ','.join([t for t in v if t])
                    396:                     elif duplicates == 'first':
                    397:                         # take first non-empty entry
                    398:                         newParams[k] = [t for t in v if t][0]
                    399:         
1.175.2.16  casties   400:         return newParams
                    401:     
1.175.2.24  casties   402:     def getLink(self, param=None, val=None, params=None, baseUrl=None, paramSep='&', duplicates='comma'):
1.175.2.16  casties   403:         """returns URL to documentviewer with parameter param set to val or from dict params"""
1.175.2.24  casties   404:         urlParams = self.getParams(param=param, val=val, params=params, duplicates=duplicates)
1.162     casties   405:         # quote values and assemble into query string (not escaping '/')
1.175.2.21  casties   406:         ps = paramSep.join(["%s=%s"%(k,urllib.quote_plus(unicode(v),'/')) for (k, v) in urlParams.items()])
1.162     casties   407:         if baseUrl is None:
1.175.2.16  casties   408:             baseUrl = self.getDocumentViewerURL()
1.162     casties   409:             
                    410:         url = "%s?%s"%(baseUrl, ps)
1.4       casties   411:         return url
                    412: 
1.175.2.24  casties   413:     def getLinkAmp(self, param=None, val=None, params=None, baseUrl=None, duplicates='comma'):
1.32      dwinter   414:         """link to documentviewer with parameter param set to val"""
1.175.2.24  casties   415:         return self.getLink(param=param, val=val, params=params, baseUrl=baseUrl, paramSep='&', duplicates=duplicates)
1.40      casties   416:     
1.175.2.16  casties   417:     
1.26      casties   418:     def getInfo_xml(self,url,mode):
                    419:         """returns info about the document as XML"""
                    420:         if not self.digilibBaseUrl:
                    421:             self.digilibBaseUrl = self.findDigilibUrl() or "http://nausikaa.mpiwg-berlin.mpg.de/digitallibrary"
                    422:         
                    423:         docinfo = self.getDocinfo(mode=mode,url=url)
                    424:         pt = getattr(self.template, 'info_xml')
                    425:         return pt(docinfo=docinfo)
                    426: 
1.9       casties   427:     def isAccessible(self, docinfo):
1.8       casties   428:         """returns if access to the resource is granted"""
                    429:         access = docinfo.get('accessType', None)
1.95      abukhman  430:         logging.debug("documentViewer (accessOK) access type %s"%access)
1.175.2.12  casties   431:         if access == 'free':
1.95      abukhman  432:             logging.debug("documentViewer (accessOK) access is free")
1.8       casties   433:             return True
1.175.2.12  casties   434:         
1.17      casties   435:         elif access is None or access in self.authgroups:
1.9       casties   436:             # only local access -- only logged in users
                    437:             user = getSecurityManager().getUser()
1.95      abukhman  438:             logging.debug("documentViewer (accessOK) user=%s ip=%s"%(user,self.REQUEST.getClientAddr()))
1.9       casties   439:             if user is not None:
                    440:                 #print "user: ", user
                    441:                 return (user.getUserName() != "Anonymous User")
                    442:             else:
                    443:                 return False
1.8       casties   444:         
1.95      abukhman  445:         logging.error("documentViewer (accessOK) unknown access type %s"%access)
1.8       casties   446:         return False
1.9       casties   447:     
1.175.2.11  casties   448: 
                    449: 
                    450:     def getDocinfo(self, mode, url):
                    451:         """returns docinfo depending on mode"""
                    452:         logging.debug("getDocinfo: mode=%s, url=%s"%(mode,url))
                    453:         # look for cached docinfo in session
                    454:         if self.REQUEST.SESSION.has_key('docinfo'):
                    455:             docinfo = self.REQUEST.SESSION['docinfo']
                    456:             # check if its still current
                    457:             if docinfo is not None and docinfo.get('mode', None) == mode and docinfo.get('url', None) == url:
                    458:                 logging.debug("getDocinfo: docinfo in session. keys=%s"%docinfo.keys())
                    459:                 return docinfo
                    460:             
                    461:         # new docinfo
                    462:         docinfo = {'mode': mode, 'url': url}
                    463:         # add self url
                    464:         docinfo['viewerUrl'] = self.getDocumentViewerURL()
1.175.2.23  casties   465:         docinfo['digilibBaseUrl'] = self.digilibBaseUrl
1.175.2.11  casties   466:         # get index.meta DOM
                    467:         docUrl = None
                    468:         metaDom = None
                    469:         if mode=="texttool": 
                    470:             # url points to document dir or index.meta
                    471:             metaDom = self.metadataService.getDomFromPathOrUrl(url)
                    472:             docUrl = url.replace('/index.meta', '')
                    473:             if metaDom is None:
                    474:                 raise IOError("Unable to find index.meta for mode=texttool!")
                    475: 
                    476:         elif mode=="imagepath":
                    477:             # url points to folder with images, index.meta optional
                    478:             # asssume index.meta in parent dir
                    479:             docUrl = getParentPath(url)
                    480:             metaDom = self.metadataService.getDomFromPathOrUrl(docUrl)
                    481: 
                    482:         elif mode=="filepath":
                    483:             # url points to image file, index.meta optional
                    484:             # asssume index.meta is two path segments up
                    485:             docUrl = getParentPath(url, 2)
                    486:             metaDom = self.metadataService.getDomFromPathOrUrl(docUrl)
                    487: 
                    488:         else:
                    489:             logging.error("documentViewer (getdocinfo) unknown mode: %s!"%mode)
                    490:             raise ValueError("Unknown mode %s! Has to be one of 'texttool','imagepath','filepath'."%(mode))
                    491:         
                    492:         docinfo['documentUrl'] = docUrl
                    493:         # process index.meta contents
1.175.2.19  casties   494:         if metaDom is not None and metaDom.tag == 'resource':
1.175.2.11  casties   495:             # document directory name and path
                    496:             resource = self.metadataService.getResourceData(dom=metaDom)
                    497:             if resource:
                    498:                 docinfo = self.getDocinfoFromResource(docinfo, resource)
                    499: 
                    500:             # texttool info
                    501:             texttool = self.metadataService.getTexttoolData(dom=metaDom)
                    502:             if texttool:
                    503:                 docinfo = self.getDocinfoFromTexttool(docinfo, texttool)
                    504:             
                    505:             # bib info
                    506:             bib = self.metadataService.getBibData(dom=metaDom)
                    507:             if bib:
                    508:                 docinfo = self.getDocinfoFromBib(docinfo, bib)
1.175.2.12  casties   509:             else:
                    510:                 # no bib - try info.xml
                    511:                 docinfo = self.getDocinfoFromPresentationInfoXml(docinfo)
1.175.2.11  casties   512:                 
                    513:             # auth info
                    514:             access = self.metadataService.getAccessData(dom=metaDom)
                    515:             if access:
                    516:                 docinfo = self.getDocinfoFromAccess(docinfo, access)
                    517: 
1.175.2.13  casties   518:             # attribution info
                    519:             attribution = self.metadataService.getAttributionData(dom=metaDom)
                    520:             if attribution:
                    521:                 logging.debug("getDocinfo: attribution=%s"%repr(attribution))
                    522:                 docinfo['attribution'] = attribution
                    523:                 #docinfo = self.getDocinfoFromAccess(docinfo, access)
                    524: 
                    525:             # copyright info
                    526:             copyright = self.metadataService.getCopyrightData(dom=metaDom)
                    527:             if copyright:
                    528:                 logging.debug("getDocinfo: copyright=%s"%repr(copyright))
                    529:                 docinfo['copyright'] = copyright
                    530:                 #docinfo = self.getDocinfoFromAccess(docinfo, access)
                    531: 
1.175.2.11  casties   532:         # image path
                    533:         if mode != 'texttool':
1.175.2.23  casties   534:             # override image path from texttool with url
1.175.2.12  casties   535:             docinfo['imagePath'] = url.replace('/mpiwg/online/', '', 1)
1.175.2.11  casties   536: 
1.175.2.23  casties   537:             
                    538: 
1.175.2.11  casties   539:         # number of images from digilib
                    540:         if docinfo.get('imagePath', None):
                    541:             docinfo['imageURL'] = self.digilibBaseUrl + "/servlet/Scaler?fn=" + docinfo['imagePath']
                    542:             docinfo = self.getDocinfoFromDigilib(docinfo, docinfo['imagePath'])
                    543: 
                    544:         logging.debug("documentViewer (getdocinfo) docinfo: keys=%s"%docinfo.keys())
                    545:         #logging.debug("documentViewer (getdocinfo) docinfo: %s"%docinfo)
                    546:         # store in session
                    547:         self.REQUEST.SESSION['docinfo'] = docinfo
                    548:         return docinfo
                    549: 
                    550:     def getDocinfoFromResource(self, docinfo, resource):
                    551:         """reads contents of resource element into docinfo"""
                    552:         docName = resource.get('name', None)
                    553:         docinfo['documentName'] = docName
                    554:         docPath = resource.get('archive-path', None)
                    555:         if docPath:
                    556:             # clean up document path
                    557:             if docPath[0] != '/':
                    558:                 docPath = '/' + docPath
                    559:                 
                    560:             if docName and (not docPath.endswith(docName)):
                    561:                 docPath += "/" + docName
                    562:             
                    563:         else:
                    564:             # use docUrl as docPath
                    565:             docUrl = docinfo['documentURL']
                    566:             if not docUrl.startswith('http:'):
                    567:                 docPath = docUrl
1.175.2.12  casties   568:         if docPath:
                    569:             # fix URLs starting with /mpiwg/online
                    570:             docPath = docPath.replace('/mpiwg/online', '', 1)
                    571: 
1.175.2.11  casties   572:         docinfo['documentPath'] = docPath
                    573:         return docinfo
                    574: 
                    575:     def getDocinfoFromTexttool(self, docinfo, texttool):
                    576:         """reads contents of texttool element into docinfo"""
                    577:         # image dir
                    578:         imageDir = texttool.get('image', None)
                    579:         docPath = docinfo.get('documentPath', None)
                    580:         if imageDir and docPath:
                    581:             #print "image: ", imageDir, " archivepath: ", archivePath
                    582:             imageDir = os.path.join(docPath, imageDir)
                    583:             imageDir = imageDir.replace('/mpiwg/online', '', 1)
                    584:             docinfo['imagePath'] = imageDir
                    585:         
                    586:         # old style text URL
                    587:         textUrl = texttool.get('text', None)
                    588:         if textUrl and docPath:
                    589:             if urlparse.urlparse(textUrl)[0] == "": #keine url
                    590:                 textUrl = os.path.join(docPath, textUrl) 
                    591:             
                    592:             docinfo['textURL'] = textUrl
                    593:     
                    594:         # new style text-url-path
                    595:         textUrl = texttool.get('text-url-path', None)
                    596:         if textUrl:
                    597:             docinfo['textURLPath'] = textUrl
1.175.2.15  casties   598:             
                    599:         # page flow
                    600:         docinfo['pageFlow'] = texttool.get('page-flow', 'ltr')
                    601:             
                    602:         # odd pages are left
1.175.2.22  casties   603:         docinfo['oddPage'] = texttool.get('odd-scan-position', 'left')
1.175.2.15  casties   604:             
1.175.2.16  casties   605:         # number of title page (0: not defined)
1.175.2.15  casties   606:         docinfo['titlePage'] = texttool.get('title-scan-no', 0)
1.175.2.11  casties   607:             
                    608:         # old presentation stuff
                    609:         presentation = texttool.get('presentation', None)
                    610:         if presentation and docPath:
1.175.2.12  casties   611:             if presentation.startswith('http:'):
                    612:                 docinfo['presentationUrl'] = presentation
                    613:             else:
                    614:                 docinfo['presentationUrl'] = os.path.join(docPath, presentation)
1.175.2.11  casties   615:             
1.175.2.15  casties   616:         
1.175.2.11  casties   617:         return docinfo
                    618: 
                    619:     def getDocinfoFromBib(self, docinfo, bib):
                    620:         """reads contents of bib element into docinfo"""
1.175.2.12  casties   621:         logging.debug("getDocinfoFromBib bib=%s"%repr(bib))
1.175.2.11  casties   622:         # put all raw bib fields in dict "bib"
                    623:         docinfo['bib'] = bib
                    624:         bibtype = bib.get('@type', None)
                    625:         docinfo['bibType'] = bibtype
                    626:         # also store DC metadata for convenience
                    627:         dc = self.metadataService.getDCMappedData(bib)
                    628:         docinfo['creator'] = dc.get('creator',None)
                    629:         docinfo['title'] = dc.get('title',None)
                    630:         docinfo['date'] = dc.get('date',None)
                    631:         return docinfo
                    632:             
                    633:     def getDocinfoFromAccess(self, docinfo, acc):
                    634:         """reads contents of access element into docinfo"""
                    635:         #TODO: also read resource type
1.175.2.12  casties   636:         logging.debug("getDocinfoFromAccess acc=%s"%repr(acc))
1.175.2.11  casties   637:         try:
1.175.2.12  casties   638:             acctype = acc['@attr']['type']
1.175.2.11  casties   639:             if acctype:
                    640:                 access=acctype
                    641:                 if access in ['group', 'institution']:
                    642:                     access = acc['name'].lower()
                    643:                 
                    644:                 docinfo['accessType'] = access
                    645: 
                    646:         except:
                    647:             pass
                    648:         
                    649:         return docinfo
                    650: 
                    651:     def getDocinfoFromDigilib(self, docinfo, path):
                    652:         infoUrl=self.digilibBaseUrl+"/dirInfo-xml.jsp?mo=dir&fn="+path
                    653:         # fetch data
                    654:         txt = getHttpData(infoUrl)
                    655:         if not txt:
                    656:             logging.error("Unable to get dir-info from %s"%(infoUrl))
                    657:             return docinfo
                    658: 
                    659:         dom = ET.fromstring(txt)
                    660:         size = getText(dom.find("size"))
                    661:         logging.debug("getDocinfoFromDigilib: size=%s"%size)
                    662:         if size:
                    663:             docinfo['numPages'] = int(size)
                    664:         else:
                    665:             docinfo['numPages'] = 0
                    666:             
                    667:         # TODO: produce and keep list of image names and numbers
                    668:         return docinfo
                    669:             
                    670:             
1.175.2.12  casties   671:     def getDocinfoFromPresentationInfoXml(self,docinfo):
                    672:         """gets DC-like bibliographical information from the presentation entry in texttools"""
                    673:         url = docinfo.get('presentationUrl', None)
                    674:         if not url:
                    675:             logging.error("getDocinfoFromPresentation: no URL!")
                    676:             return docinfo
                    677:         
                    678:         dom = None
                    679:         metaUrl = None
                    680:         if url.startswith("http://"):
                    681:             # real URL
                    682:             metaUrl = url
                    683:         else:
                    684:             # online path
                    685:             
                    686:             server=self.digilibBaseUrl+"/servlet/Texter?fn="
                    687:             metaUrl=server+url
                    688:         
                    689:         txt=getHttpData(metaUrl)
                    690:         if txt is None:
                    691:             logging.error("Unable to read info.xml from %s"%(url))
                    692:             return docinfo
                    693:             
                    694:         dom = ET.fromstring(txt)
                    695:         docinfo['creator']=getText(dom.find(".//author"))
                    696:         docinfo['title']=getText(dom.find(".//title"))
                    697:         docinfo['date']=getText(dom.find(".//date"))
                    698:         return docinfo
                    699:     
                    700: 
1.175.2.24  casties   701:     def getPageinfo(self, current=None, start=None, rows=None, cols=None, docinfo=None, viewMode=None, viewType=None, tocMode=None):
1.3       casties   702:         """returns pageinfo with the given parameters"""
1.175.2.24  casties   703:         logging.debug("getPageInfo(current=%s, start=%s, rows=%s, cols=%s, viewMode=%s, viewType=%s, tocMode=%s)"%(current,start,rows,cols,viewMode,viewType,tocMode))
1.3       casties   704:         pageinfo = {}
1.175.2.17  casties   705:         pageinfo['viewMode'] = viewMode
                    706:         pageinfo['viewType'] = viewType
                    707:         pageinfo['tocMode'] = tocMode
                    708: 
1.4       casties   709:         current = getInt(current)
                    710:         pageinfo['current'] = current
                    711:         rows = int(rows or self.thumbrows)
                    712:         pageinfo['rows'] = rows
                    713:         cols = int(cols or self.thumbcols)
                    714:         pageinfo['cols'] = cols
                    715:         grpsize = cols * rows
                    716:         pageinfo['groupsize'] = grpsize
1.175.2.22  casties   717:         # is start is empty use one around current
1.28      casties   718:         start = getInt(start, default=(math.ceil(float(current)/float(grpsize))*grpsize-(grpsize-1)))
                    719:         # int(current / grpsize) * grpsize +1))
1.3       casties   720:         pageinfo['start'] = start
1.175.2.16  casties   721:         pn = self.REQUEST.get('pn','1')
                    722:         pageinfo['pn'] = pn
                    723:         np = int(docinfo.get('numPages', 0))
                    724:         if np == 0:
                    725:             # numPages unknown - maybe we can get it from text page
                    726:             if docinfo.get('textURLPath', None):
                    727:                 # cache text page as well
1.175.2.17  casties   728:                 pageinfo['textPage'] = self.getTextPage(mode=viewType, pn=pn, docinfo=docinfo, pageinfo=pageinfo)
1.175.2.16  casties   729:                 np = int(docinfo.get('numPages', 0))
                    730:                 
                    731:         pageinfo['numgroups'] = int(np / grpsize)
                    732:         if np % grpsize > 0:
                    733:             pageinfo['numgroups'] += 1
1.175.2.22  casties   734: 
                    735:         pageFlowLtr = docinfo.get('pageFlow', 'ltr') != 'rtl'
                    736:         oddScanLeft = docinfo.get('oddPage', 'left') != 'right'
                    737:         # add zeroth page for two columns
                    738:         pageZero = (cols == 2 and (pageFlowLtr != oddScanLeft))
                    739:         pageinfo['pageZero'] = pageZero
                    740:         pageinfo['pageList'] = self.getPageList(start=start, rows=rows, cols=cols, pageFlowLtr=pageFlowLtr, pageZero=pageZero, minIdx=1, maxIdx=np)
1.175.2.7  casties   741:                 
1.161     abukhman  742:         pageinfo['characterNormalization'] = self.REQUEST.get('characterNormalization','reg')
1.156     abukhman  743:         pageinfo['query'] = self.REQUEST.get('query','') 
1.146     abukhman  744:         pageinfo['queryType'] = self.REQUEST.get('queryType','')
1.45      abukhman  745:         pageinfo['querySearch'] =self.REQUEST.get('querySearch', 'fulltext')
1.146     abukhman  746:         pageinfo['highlightQuery'] = self.REQUEST.get('highlightQuery','')
1.175.2.22  casties   747:         pageinfo['tocPageSize'] = getInt(self.REQUEST.get('tocPageSize', 30))
                    748:         pageinfo['queryPageSize'] = getInt(self.REQUEST.get('queryPageSize', 10))
                    749:         pageinfo['tocPN'] = getInt(self.REQUEST.get('tocPN', '1'))
                    750:         pageinfo['searchPN'] = getInt(self.REQUEST.get('searchPN','1'))
1.90      abukhman  751:         
1.175.2.22  casties   752:         # limit tocPN
1.48      abukhman  753:         if 'tocSize_%s'%tocMode in docinfo:
1.175.2.22  casties   754:             tocSize = docinfo['tocSize_%s'%tocMode]
                    755:             tocPageSize = pageinfo['tocPageSize']
1.69      abukhman  756:             # cached toc           
1.48      abukhman  757:             if tocSize%tocPageSize>0:
                    758:                 tocPages=tocSize/tocPageSize+1
                    759:             else:
                    760:                 tocPages=tocSize/tocPageSize
1.175.2.7  casties   761:                 
1.175.2.22  casties   762:             pageinfo['tocPN'] = min(tocPages,pageinfo['tocPN'])
1.175.2.7  casties   763:             
1.3       casties   764:         return pageinfo
1.175.2.7  casties   765: 
1.175.2.10  casties   766: 
1.175.2.22  casties   767:     def getPageList(self, start=None, rows=None, cols=None, pageFlowLtr=True, pageZero=False, minIdx=1, maxIdx=0):
                    768:         """returns array of page informations for one screenfull of thumbnails"""
                    769:         if maxIdx == 0:
                    770:             maxIdx = start + rows * cols
                    771: 
                    772:         pages = []
                    773:         if pageZero and start == 1:
                    774:             # correct beginning
                    775:             idx = 0
                    776:         else:
                    777:             idx = start
                    778:             
                    779:         for r in range(rows):
                    780:             row = []
                    781:             for c in range(cols):
                    782:                 if idx < minIdx or idx > maxIdx:
                    783:                     page = {'idx':None}
                    784:                 else:
                    785:                     page = {'idx':idx}
                    786:                     
                    787:                 idx += 1
                    788:                 if pageFlowLtr:
                    789:                     row.append(page)
                    790:                 else:
                    791:                     row.insert(0, page) 
                    792:                 
                    793:             pages.append(row)
                    794:             
                    795:         logging.debug("getPageList returns=%s"%(pages))
                    796:         return pages
                    797:         
                    798: 
1.175.2.10  casties   799:     security.declareProtected('View management screens','changeDocumentViewerForm')    
                    800:     changeDocumentViewerForm = PageTemplateFile('zpt/changeDocumentViewer', globals())
1.3       casties   801:     
1.175.2.7  casties   802:     def changeDocumentViewer(self,title="",digilibBaseUrl=None,thumbrows=2,thumbcols=5,authgroups='mpiwg',RESPONSE=None):
1.3       casties   803:         """init document viewer"""
                    804:         self.title=title
                    805:         self.digilibBaseUrl = digilibBaseUrl
1.4       casties   806:         self.thumbrows = thumbrows
                    807:         self.thumbcols = thumbcols
1.8       casties   808:         self.authgroups = [s.strip().lower() for s in authgroups.split(',')]
1.175.2.10  casties   809:         try:
                    810:             # assume MetaDataFolder instance is called metadata 
                    811:             self.metadataService = getattr(self, 'metadata')
                    812:         except Exception, e:
                    813:             logging.error("Unable to find MetaDataFolder 'metadata': "+str(e))
                    814: 
1.3       casties   815:         if RESPONSE is not None:
                    816:             RESPONSE.redirect('manage_main')
1.1       dwinter   817:         
                    818: def manage_AddDocumentViewerForm(self):
                    819:     """add the viewer form"""
1.3       casties   820:     pt=PageTemplateFile('zpt/addDocumentViewer', globals()).__of__(self)
1.1       dwinter   821:     return pt()
                    822:   
1.43      casties   823: def manage_AddDocumentViewer(self,id,imageScalerUrl="",textServerName="",title="",RESPONSE=None):
1.1       dwinter   824:     """add the viewer"""
1.43      casties   825:     newObj=documentViewer(id,imageScalerUrl=imageScalerUrl,title=title,textServerName=textServerName)
1.1       dwinter   826:     self._setObject(id,newObj)
                    827:     
                    828:     if RESPONSE is not None:
                    829:         RESPONSE.redirect('manage_main')
1.3       casties   830: 
                    831: ## DocumentViewerTemplate class
                    832: class DocumentViewerTemplate(ZopePageTemplate):
                    833:     """Template for document viewer"""
                    834:     meta_type="DocumentViewer Template"
                    835: 
                    836: 
                    837: def manage_addDocumentViewerTemplateForm(self):
                    838:     """Form for adding"""
                    839:     pt=PageTemplateFile('zpt/addDocumentViewerTemplate', globals()).__of__(self)
                    840:     return pt()
                    841: 
                    842: def manage_addDocumentViewerTemplate(self, id='viewer_main', title=None, text=None,
                    843:                            REQUEST=None, submit=None):
                    844:     "Add a Page Template with optional file content."
                    845: 
                    846:     self._setObject(id, DocumentViewerTemplate(id))
                    847:     ob = getattr(self, id)
1.23      dwinter   848:     txt=file(os.path.join(package_home(globals()),'zpt/viewer_main.zpt'),'r').read()
1.95      abukhman  849:     logging.info("txt %s:"%txt)
1.23      dwinter   850:     ob.pt_edit(txt,"text/html")
1.3       casties   851:     if title:
                    852:         ob.pt_setTitle(title)
                    853:     try:
                    854:         u = self.DestinationURL()
                    855:     except AttributeError:
                    856:         u = REQUEST['URL1']
                    857:         
                    858:     u = "%s/%s" % (u, urllib.quote(id))
                    859:     REQUEST.RESPONSE.redirect(u+'/manage_main')
                    860:     return ''
                    861: 
                    862: 
1.14      casties   863:     

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>