source: documentViewer/MpiwgXmlTextServer.py @ 570:61d53ccbdd70

Last change on this file since 570:61d53ccbdd70 was 570:61d53ccbdd70, checked in by casties, 12 years ago

more resilience to server errors.
File size: 22.3 KB
Line 
1from OFS.SimpleItem import SimpleItem
2from Products.PageTemplates.PageTemplateFile import PageTemplateFile
3
4import xml.etree.ElementTree as ET
5
6import re
7import logging
8import urllib
9import urlparse
10import base64
11
12from SrvTxtUtils import getInt, getText, getHttpData
13
14def serialize(node):
15    """returns a string containing an XML snippet of node"""
16    s = ET.tostring(node, 'UTF-8')
17    # snip off XML declaration
18    if s.startswith('<?xml'):
19        i = s.find('?>')
20        return s[i+3:]
21
22    return s
23
24
25class MpiwgXmlTextServer(SimpleItem):
26    """TextServer implementation for MPIWG-XML server"""
27    meta_type="MPIWG-XML TextServer"
28
29    manage_options=(
30        {'label':'Config','action':'manage_changeMpiwgXmlTextServerForm'},
31       )+SimpleItem.manage_options
32   
33    manage_changeMpiwgXmlTextServerForm = PageTemplateFile("zpt/manage_changeMpiwgXmlTextServer", globals())
34       
35    def __init__(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpiwg-mpdl-cms-web/", timeout=40, serverName=None, repositoryType='production'):
36        """constructor"""
37        self.id=id
38        self.title=title
39        self.timeout = timeout
40        self.repositoryType = repositoryType
41        if serverName is None:
42            self.serverUrl = serverUrl
43        else:
44            self.serverUrl = "http://%s/mpiwg-mpdl-cms-web/"%serverName
45       
46    def getHttpData(self, url, data=None):
47        """returns result from url+data HTTP request"""
48        return getHttpData(url,data,timeout=self.timeout)
49   
50    def getServerData(self, method, data=None):
51        """returns result from text server for method+data"""
52        url = self.serverUrl+method
53        return getHttpData(url,data,timeout=self.timeout)
54
55
56    def getRepositoryType(self):
57        """returns the repository type, e.g. 'production'"""
58        return self.repositoryType
59
60    def getTextDownloadUrl(self, type='xml', docinfo=None):
61        """returns a URL to download the current text"""
62        docpath = docinfo.get('textURLPath', None)
63        if not docpath:
64            return None
65
66        docpath = docpath.replace('.xml','.'+type)
67        url = '%sdoc/GetDocument?id=%s'%(self.serverUrl.replace('interface/',''), docpath)
68        return url
69
70
71    def getPlacesOnPage(self, docinfo=None, pn=None):
72        """Returns list of GIS places of page pn"""
73        #FIXME!
74        docpath = docinfo.get('textURLPath',None)
75        if not docpath:
76            return None
77
78        places=[]
79        text=self.getServerData("xpath.xql", "document=%s&xpath=//place&pn=%s"%(docpath,pn))
80        dom = ET.fromstring(text)
81        result = dom.findall(".//resultPage/place")
82        for l in result:
83            id = l.get("id")
84            name = l.text
85            place = {'id': id, 'name': name}
86            places.append(place)
87
88        return places
89   
90         
91    def getTextInfo(self, mode=None, docinfo=None):
92        """reads document info, including page concordance, from text server"""
93        logging.debug("getTextInfo mode=%s"%mode)
94       
95        field = ''
96        if mode in ['pages', 'toc', 'figures', 'handwritten']:
97            # translate mode to field param
98            field = '&field=%s'%mode
99        else:
100            mode = None
101
102        # check cached info
103        if mode:
104            # cached toc-request?
105            if 'full_%s'%mode in docinfo:
106                return docinfo
107           
108        else:
109            # cached but no toc-request?
110            if 'numTextPages' in docinfo:
111                return docinfo
112               
113        docpath = docinfo.get('textURLPath', None)
114        if docpath is None:
115            logging.error("getTextInfo: no textURLPath!")
116            return docinfo
117               
118        # fetch docinfo           
119        pagexml = self.getServerData("query/GetDocInfo","docId=%s%s"%(docpath,field))
120        dom = ET.fromstring(pagexml)
121        # all info in tag <doc>
122        doc = dom
123        if doc is None:
124            logging.error("getTextInfo: unable to find document-tag!")
125        else:
126            if mode is None:
127                # get general info from system-tag
128                sys = doc.find('system')
129                if sys is not None:
130                    docinfo['numTextPages'] = getInt(getText(sys.find('countPages'))) 
131                    docinfo['numFigureEntries'] = getInt(getText(sys.find('countFigures'))) 
132                    docinfo['numHandwritten'] = getInt(getText(sys.find('countHandwritten'))) 
133                    docinfo['numTocEntries'] = getInt(getText(sys.find('countTocEntries'))) 
134                   
135            else:
136                # result is in list-tag
137                l = doc.find('list')
138                if l is not None:
139                    lt = l.get('type')
140                    # pageNumbers
141                    if lt == 'pages':
142                        # contains tags with page numbers
143                        # <item n="14" o="2" o-norm="2" file="0014"/>
144                        # n=scan number, o=original page no, on=normalized original page no
145                        # pageNumbers is a dict indexed by scan number
146                        pages = {}
147                        for i in l:
148                            page = {}
149                            pn = getInt(i.get('n'))
150                            page['pn'] = pn
151                            no = i.get('o')
152                            page['no'] = no
153                            non = i.get('o-norm')
154                            page['non'] = non
155                                   
156                            if pn > 0:
157                                pages[pn] = page
158                           
159                        docinfo['pageNumbers'] = pages
160                        logging.debug("got pageNumbers=%s"%repr(pages))
161                                   
162                    # toc
163                    elif lt == 'toc' or lt == 'figures' or lt == 'handwritten':
164                        # contains tags with table of contents/figures
165                        # <item n="2.1." lv="2">CAP.I. <ref o="119">132</ref></item>
166                        tocs = []
167                        for te in l:
168                            if te.tag == 'item':
169                                toc = {}
170                                toc['level-string'] = te.get('n')
171                                toc['level'] = te.get('lv')
172                                toc['content'] = te.text.strip()
173                                ref = te.find('ref')
174                                toc['pn'] = getInt(ref.text)
175                                toc['no'] = ref.get('o')
176                                toc['non'] = ref.get('o-norm')
177                                tocs.append(toc)
178                       
179                        # save as full_toc/full_figures
180                        docinfo['full_%s'%mode] = tocs
181
182        return docinfo
183       
184         
185    def getTextPage(self, mode="text", pn=1, docinfo=None, pageinfo=None):
186        """returns single page from fulltext"""
187       
188        logging.debug("getTextPage mode=%s, pn=%s"%(mode,pn))
189        # check for cached text -- but ideally this shouldn't be called twice
190        if pageinfo.has_key('textPage'):
191            logging.debug("getTextPage: using cached text")
192            return pageinfo['textPage']
193       
194        docpath = docinfo.get('textURLPath', None)
195        if not docpath:
196            return None
197       
198        # just checking
199        if pageinfo['current'] != pn:
200            logging.warning("getTextPage: current!=pn!")
201           
202        # stuff for constructing full urls
203        selfurl = docinfo['viewerUrl']
204        textParams = {'docId': docpath,
205                      'page': pn}
206       
207        if 'characterNormalization' in pageinfo:
208            cn = pageinfo['characterNormalization']
209            # TODO: change values in form
210            if cn == 'regPlusNorm':
211                cn = 'norm'
212               
213            textParams['normalization'] = cn
214       
215        if not mode:
216            # default is dict
217            mode = 'text'
218
219        modes = mode.split(',')
220        # check for multiple layers
221        if len(modes) > 1:
222            logging.debug("getTextPage: more than one mode=%s"%mode)
223                       
224        # search mode
225        if 'search' in modes:
226            # add highlighting
227            highlightQuery = pageinfo.get('highlightQuery', None)
228            if highlightQuery:
229                textParams['highlightQuery'] = highlightQuery
230                textParams['highlightElem'] = pageinfo.get('highlightElement', '')
231                textParams['highlightElemPos'] = pageinfo.get('highlightElementPos', '')
232               
233            # ignore mode in the following
234            modes.remove('search')
235                           
236        # pundit mode
237        punditMode = False
238        if 'pundit' in modes:
239            punditMode = True
240            # ignore mode in the following
241            modes.remove('pundit')
242                           
243        # other modes don't combine
244        if 'dict' in modes:
245            textmode = 'dict'
246            textParams['mode'] = 'tokenized'
247            textParams['outputFormat'] = 'html'
248        elif 'xml' in modes:
249            textmode = 'xml'
250            textParams['mode'] = 'untokenized'
251            textParams['outputFormat'] = 'xmlDisplay'
252            textParams['normalization'] = 'orig'
253        elif 'gis' in modes:
254            #FIXME!
255            textmode = 'gis'
256        else:
257            # text is default mode
258            textmode = 'text'
259            textParams['mode'] = 'untokenized'
260            textParams['outputFormat'] = 'html'
261       
262        try:
263            # fetch the page
264            pagexml = self.getServerData("query/GetPage",urllib.urlencode(textParams))
265            dom = ET.fromstring(pagexml)
266        except Exception, e:
267            logging.error("Error reading page: %s"%e)
268            return None
269       
270        pagediv = None
271        body = dom.find('.//body')
272        if body is None:
273            logging.error("getTextPage: no body!")
274            return None
275       
276        # the text is in div@class=text
277        pagediv = body.find(".//div[@class='text']")
278        logging.debug("pagediv: %s"%repr(pagediv))
279       
280        # plain text or text-with-links mode
281        if textmode == "text" or textmode == "dict":
282            if pagediv is not None:
283                #self._processPbTag(pagediv, pageinfo)
284                self._processFigures(pagediv, docinfo)
285                #self._fixEmptyDivs(pagediv)
286                # get full url assuming documentViewer is parent
287                selfurl = self.getLink()
288                # check all a-tags
289                links = pagediv.findall('.//a')
290                for l in links:
291                    href = l.get('href')
292                    if href:
293                        # is link with href
294                        linkurl = urlparse.urlparse(href)
295                        if linkurl.path.endswith('GetDictionaryEntries'):
296                            #TODO: replace wordInfo page
297                            # is dictionary link - change href (keeping parameters)
298                            #l.set('href', href.replace('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/interface/lt/wordInfo.xql','%s/template/viewer_wordinfo'%viewerurl))
299                            # add target to open new page
300                            l.set('target', '_blank')
301                                                         
302                        elif href.startswith('#note-'):
303                            # note link FIXME!
304                            l.set('href', href.replace('#note-',"%s#note-"%selfurl))
305                       
306                if punditMode:
307                    self._addPunditAttributes(pagediv, pageinfo, docinfo)
308                   
309                return serialize(pagediv)
310           
311        # xml mode
312        elif textmode == "xml":
313            if pagediv is not None:
314                return serialize(pagediv)
315           
316        # pureXml mode WTF?
317        elif textmode == "pureXml":
318            if pagediv is not None:
319                return serialize(pagediv)
320                 
321        # gis mode FIXME!
322        elif textmode == "gis":
323            if pagediv is not None:
324                # fix empty div tags
325                self._fixEmptyDivs(pagediv)
326                # check all a-tags
327                links = pagediv.findall(".//a")
328                # add our URL as backlink
329                selfurl = self.getLink()
330                doc = base64.b64encode(selfurl)
331                for l in links:
332                    href = l.get('href')
333                    if href:
334                        if href.startswith('http://mappit.mpiwg-berlin.mpg.de'):
335                            l.set('href', re.sub(r'doc=[\w+/=]+', 'doc=%s'%doc, href))
336                            l.set('target', '_blank')
337                           
338                return serialize(pagediv)
339                   
340        return None
341
342    def _processPbTag(self, pagediv, pageinfo):
343        """extracts information from pb-tag and removes it from pagediv"""
344        pbdiv = pagediv.find(".//span[@class='pb']")
345        if pbdiv is None:
346            logging.warning("getTextPage: no pb-span!")
347            return pagediv
348       
349        # extract running head
350        rh = pbdiv.find(".//span[@class='rhead']")
351        if rh is not None:
352            pageinfo['pageHeaderTitle'] = getText(rh)
353           
354        # remove pb-div from parent
355        ppdiv = pagediv.find(".//span[@class='pb']/..")
356        ppdiv.remove(pbdiv)       
357        return pagediv
358   
359    def _addPunditAttributes(self, pagediv, pageinfo, docinfo):
360        """add about attributes for pundit annotation tool"""
361        textid = docinfo.get('DRI', "fn=%s"%docinfo.get('documentPath', '???'))
362        pn = pageinfo.get('pn', '1')
363        #  TODO: use pn as well?
364        # check all div-tags
365        divs = pagediv.findall(".//div")
366        for d in divs:
367            id = d.get('id')
368            if id:
369                # TODO: check path (cf RFC2396)
370                d.set('about', "http://echo.mpiwg-berlin.mpg.de/%s/pn=%s/#%s"%(textid,pn,id))
371                cls = d.get('class','')
372                cls += ' pundit-content'
373                d.set('class', cls.strip())
374
375        return pagediv
376
377    def _processFigures(self, pagediv, docinfo):
378        """processes figure-tags"""
379        divs = pagediv.findall(".//span[@class='figure']")
380        scalerUrl = docinfo['digilibScalerUrl']
381        viewerUrl = docinfo['digilibViewerUrl']
382        for d in divs:
383            try:
384                a = d.find('a')
385                img = a.find('img')
386                imgsrc = img.get('src')
387                imgurl = urlparse.urlparse(imgsrc)
388                imgq = imgurl.query
389                imgparams = urlparse.parse_qs(imgq)
390                fn = imgparams.get('fn', None)
391                if fn is not None:
392                    # parse_qs puts parameters in lists
393                    fn = fn[0]
394                    # TODO: check valid path
395                    # fix img@src
396                    newsrc = '%s?fn=%s&dw=200&dh=200'%(scalerUrl,fn)
397                    img.set('src', newsrc)
398                    # fix a@href
399                    newlink = '%s?fn=%s'%(viewerUrl,fn)
400                    a.set('href', newlink)
401                    a.set('target', '_blank')
402                   
403            except:
404                logging.warn("processFigures: strange figure!")
405               
406   
407    def _fixEmptyDivs(self, pagediv):
408        """fixes empty div-tags by inserting a space"""
409        divs = pagediv.findall('.//div')
410        for d in divs:
411            if len(d) == 0 and not d.text:
412                # make empty divs non-empty
413                d.text = ' '
414 
415        return pagediv
416
417
418    def getSearchResults(self, mode, query=None, pageinfo=None, docinfo=None):
419        """loads list of search results and stores XML in docinfo"""
420       
421        logging.debug("getSearchResults mode=%s query=%s"%(mode, query))
422        if mode == "none":
423            return docinfo
424             
425        #TODO: put mode into query
426       
427        cachedQuery = docinfo.get('cachedQuery', None)
428        if cachedQuery is not None:
429            # cached search result
430            if cachedQuery == '%s_%s'%(mode,query):
431                # same query
432                return docinfo
433           
434            else:
435                # different query
436                del docinfo['resultSize']
437                del docinfo['results']
438       
439        # cache query
440        docinfo['cachedQuery'] = '%s_%s'%(mode,query)
441       
442        # fetch full results
443        docpath = docinfo['textURLPath']
444        params = {'docId': docpath,
445                  'query': query,
446                  'pageSize': 1000,
447                  'page': 1,
448                  'outputFormat': 'html'}
449        pagexml = self.getServerData("query/QueryDocument",urllib.urlencode(params))
450        results = []
451        try:
452            dom = ET.fromstring(pagexml)
453            # page content is currently in multiple <td align=left>
454            alldivs = dom.findall(".//td[@align='left']")
455            for div in alldivs:
456                # TODO: can we put etree in the session?
457                results.append(div)
458       
459        except Exception, e:
460            logging.error("GetSearchResults: Error parsing search result: %s"%e)
461               
462        # store results in docinfo
463        docinfo['resultSize'] = len(results)
464        docinfo['results'] = results
465
466        return docinfo
467   
468
469    def getResultsPage(self, mode="text", query=None, pn=None, start=None, size=None, pageinfo=None, docinfo=None):
470        """returns single page from the table of contents"""
471        logging.debug("getResultsPage mode=%s, pn=%s"%(mode,pn))
472        # get (cached) result
473        self.getSearchResults(mode=mode, query=query, pageinfo=pageinfo, docinfo=docinfo)
474           
475        resultxml = docinfo.get('results', None)
476        if not resultxml:
477            logging.error("getResultPage: unable to find results")
478            return "Error: no result!"
479       
480        if size is None:
481            size = pageinfo.get('resultPageSize', 10)
482           
483        if start is None:
484            start = (pn - 1) * size
485
486        fullresult = ET.fromstring(resultxml)
487       
488        if fullresult is not None:
489            # paginate
490            first = start-1
491            len = size
492            del fullresult[:first]
493            del fullresult[len:]
494            tocdivs = fullresult
495           
496            # check all a-tags
497            links = tocdivs.findall(".//a")
498            for l in links:
499                href = l.get('href')
500                if href:
501                    # assume all links go to pages
502                    linkUrl = urlparse.urlparse(href)
503                    linkParams = urlparse.parse_qs(linkUrl.query)
504                    # take some parameters
505                    params = {'pn': linkParams['pn'],
506                              'highlightQuery': linkParams.get('highlightQuery',''),
507                              'highlightElement': linkParams.get('highlightElement',''),
508                              'highlightElementPos': linkParams.get('highlightElementPos','')
509                              }
510                    url = self.getLink(params=params)
511                    l.set('href', url)
512                       
513            return serialize(tocdivs)
514       
515        return "ERROR: no results!"
516
517
518    def getToc(self, mode='text', docinfo=None):
519        """returns list of table of contents from docinfo"""
520        logging.debug("getToc mode=%s"%mode)
521        if mode == 'text':
522            queryType = 'toc'
523        else:
524            queryType = mode
525           
526        if not 'full_%s'%queryType in docinfo:
527            # get new toc
528            docinfo = self.getTextInfo(queryType, docinfo)
529           
530        return docinfo.get('full_%s'%queryType, [])
531
532
533    def getTocPage(self, mode='text', pn=None, start=None, size=None, pageinfo=None, docinfo=None):
534        """returns single page from the table of contents"""
535        logging.debug("getTocPage mode=%s, pn=%s start=%s size=%s"%(mode,repr(pn),repr(start),repr(size)))
536        fulltoc = self.getToc(mode=mode, docinfo=docinfo)
537        if len(fulltoc) < 1:
538            logging.error("getTocPage: unable to find toc!")
539            return "Error: no table of contents!"       
540       
541        if size is None:
542            size = pageinfo.get('tocPageSize', 30)
543           
544        if start is None:
545            start = (pn - 1) * size
546
547        # paginate
548        first = (start - 1)
549        last = first + size
550        tocs = fulltoc[first:last]
551        tp = '<div>'
552        for toc in tocs:
553            pageurl = self.getLink('pn', toc['pn'])
554            tp += '<div class="tocline">'
555            content = toc['content']
556            if content:
557                tp += '<div class="toc name">[%s] %s</div>'%(toc['level-string'], toc['content'])
558            else:
559                tp += '<div class="toc name">[Figure %s]</div>'%(toc['level-string'])
560           
561            if toc.get('no', None):
562                tp += '<div class="toc page"><a href="%s">Page: %s (%s)</a></div>'%(pageurl, toc['pn'], toc['no'])
563            else:
564                tp += '<div class="toc page"><a href="%s">Page: %s</a></div>'%(pageurl, toc['pn'])
565               
566            tp += '</div>\n'
567           
568        tp += '</div>\n'
569       
570        return tp
571           
572   
573    def manage_changeMpiwgXmlTextServer(self,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,repositoryType=None,RESPONSE=None):
574        """change settings"""
575        self.title=title
576        self.timeout = timeout
577        self.serverUrl = serverUrl
578        if repositoryType:
579            self.repositoryType = repositoryType
580        if RESPONSE is not None:
581            RESPONSE.redirect('manage_main')
582       
583# management methods
584def manage_addMpiwgXmlTextServerForm(self):
585    """Form for adding"""
586    pt = PageTemplateFile("zpt/manage_addMpiwgXmlTextServer", globals()).__of__(self)
587    return pt()
588
589def manage_addMpiwgXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,RESPONSE=None):
590#def manage_addMpiwgXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de:30030/mpdl/interface/",timeout=40,RESPONSE=None):   
591    """add zogiimage"""
592    newObj = MpiwgXmlTextServer(id=id,title=title,serverUrl=serverUrl,timeout=timeout)
593    self.Destination()._setObject(id, newObj)
594    if RESPONSE is not None:
595        RESPONSE.redirect('manage_main')
596       
597       
Note: See TracBrowser for help on using the repository browser.