Annotation of documentViewer/documentViewer.py, revision 1.147

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

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