Annotation of documentViewer/documentViewer.py, revision 1.175.2.23

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

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