source: documentViewer/MpdlXmlTextServer.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: 23.1 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 MpdlXmlTextServer(SimpleItem):
26    """TextServer implementation for MPDL-XML eXist server"""
27    meta_type="MPDL-XML TextServer"
28
29    manage_options=(
30        {'label':'Config','action':'manage_changeMpdlXmlTextServerForm'},
31       )+SimpleItem.manage_options
32   
33    manage_changeMpdlXmlTextServerForm = PageTemplateFile("zpt/manage_changeMpdlXmlTextServer", globals())
34       
35    def __init__(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/", serverName=None, timeout=40, 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/mpdl/interface/"%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 = '%sgetDoc?doc=%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        docpath = docinfo.get('textURLPath',None)
74        if not docpath:
75            return None
76
77        places=[]
78        text=self.getServerData("xpath.xql", "document=%s&xpath=//place&pn=%s"%(docpath,pn))
79        dom = ET.fromstring(text)
80        result = dom.findall(".//resultPage/place")
81        for l in result:
82            id = l.get("id")
83            name = l.text
84            place = {'id': id, 'name': name}
85            places.append(place)
86
87        return places
88   
89         
90    def getTextInfo(self, mode='', docinfo=None):
91        """reads document info, including page concordance, from text server"""
92        logging.debug("getTextInfo mode=%s"%mode)
93        if mode not in ['toc', 'figures', '']:
94            mode = ''
95        # check cached info
96        if mode:
97            # cached toc-request?
98            if 'full_%s'%mode in docinfo:
99                return docinfo
100           
101        else:
102            # no toc-request
103            if 'numTextPages' in docinfo:
104                return docinfo
105               
106        docpath = docinfo.get('textURLPath', None)
107        if docpath is None:
108            logging.error("getTextInfo: no textURLPath!")
109            return docinfo
110             
111        try:
112            # we need to set a result set size
113            pagesize = 10000
114            pn = 1
115            # fetch docinfo           
116            pagexml = self.getServerData("doc-info.xql","document=%s&info=%s&pageSize=%s&pn=%s"%(docpath,mode,pagesize,pn))
117            dom = ET.fromstring(pagexml)
118            # all info in tag <document>
119            doc = dom.find("document")
120        except Exception, e:
121            logging.error("getTextInfo: Error reading doc info: %s"%e)
122            return docinfo
123           
124        if doc is None:
125            logging.error("getTextInfo: unable to find document-tag!")
126        else:
127            # go through all child elements
128            for tag in doc:
129                name = tag.tag
130                # numTextPages
131                if name == 'countPages':
132                    np = getInt(tag.text)                   
133                    if np > 0:
134                        docinfo['numTextPages'] = np
135                   
136                # numFigureEntries
137                elif name == 'countFigureEntries':
138                    docinfo['numFigureEntries'] = getInt(tag.text)
139                   
140                # numTocEntries
141                elif name == 'countTocEntries':
142                    # WTF: s1 = int(s)/30+1
143                    docinfo['numTocEntries'] = getInt(tag.text)
144                   
145                # numPlaces
146                elif name == 'countPlaces':
147                    docinfo['numPlaces'] = getInt(tag.text)
148                   
149                # pageNumbers
150                elif name == 'pageNumbers':
151                    # contains tags with page numbers
152                    # <pn><n>4</n><no>4</no><non/></pn>
153                    # n=scan number, no=original page no, non=normalized original page no
154                    # pageNumbers is a dict indexed by scan number
155                    pages = {}
156                    for pn in tag:
157                        page = {}
158                        n = 0
159                        for p in pn:
160                            if p.tag == 'n':
161                                n = getInt(p.text)
162                                page['pn'] = n
163                            elif p.tag == 'no':
164                                page['no'] = p.text
165                            elif p.tag == 'non':
166                                page['non'] = p.text
167                               
168                        if n > 0:
169                            pages[n] = page
170                       
171                    docinfo['pageNumbers'] = pages
172                    #logging.debug("got pageNumbers=%s"%repr(pages))
173                               
174                # toc
175                elif name == 'toc':
176                    # contains tags with table of contents/figures
177                    # <toc-entry><page>13</page><level>3</level><content>Chapter I</content><level-string>1.</level-string><real-level>1</real-level></toc-entry>
178                    tocs = []
179                    for te in tag:
180                        toc = {}
181                        for t in te:
182                            if t.tag == 'page':
183                                toc['pn'] = getInt(t.text)
184                            elif t.tag == 'level':
185                                toc['level'] = t.text
186                            elif t.tag == 'content':
187                                toc['content'] = t.text
188                            elif t.tag == 'level-string':
189                                toc['level-string'] = t.text
190                            elif t.tag == 'real-level':
191                                toc['real-level'] = t.text
192                               
193                        tocs.append(toc)
194                   
195                    # save as full_toc/full_figures
196                    docinfo['full_%s'%mode] = tocs
197
198        return docinfo
199       
200         
201    def processPageInfo(self, dom, docinfo, pageinfo):
202        """processes page info divs from dom and stores in docinfo and pageinfo"""
203        # assume first second level div is pageMeta
204        alldivs = dom.find("div")
205       
206        if alldivs is None or alldivs.get('class', '') != 'pageMeta':
207            logging.error("processPageInfo: pageMeta div not found!")
208            return
209       
210        for div in alldivs:
211            dc = div.get('class')
212           
213            # pageNumberOrig 
214            if dc == 'pageNumberOrig':
215                pageinfo['pageNumberOrig'] = div.text
216               
217            # pageNumberOrigNorm
218            elif dc == 'pageNumberOrigNorm':
219                pageinfo['pageNumberOrigNorm'] = div.text
220               
221            # pageHeaderTitle
222            elif dc == 'pageHeaderTitle':
223                pageinfo['pageHeaderTitle'] = div.text
224                       
225        #logging.debug("processPageInfo: pageinfo=%s"%repr(pageinfo))
226        return
227         
228           
229    def getTextPage(self, mode="text", pn=1, docinfo=None, pageinfo=None):
230        """returns single page from fulltext"""
231       
232        logging.debug("getTextPage mode=%s, pn=%s"%(mode,pn))
233        # check for cached text -- but ideally this shouldn't be called twice
234        if pageinfo.has_key('textPage'):
235            logging.debug("getTextPage: using cached text")
236            return pageinfo['textPage']
237       
238        docpath = docinfo.get('textURLPath', None)
239        if not docpath:
240            return None
241       
242        # just checking
243        if pageinfo['current'] != pn:
244            logging.warning("getTextPage: current!=pn!")
245           
246        # stuff for constructing full urls
247        selfurl = docinfo['viewerUrl']
248        textParams = {'document': docpath,
249                      'pn': pn}
250        if 'characterNormalization' in pageinfo:
251            textParams['characterNormalization'] = pageinfo['characterNormalization']
252       
253        if not mode:
254            # default is dict
255            mode = 'text'
256
257        modes = mode.split(',')
258        # check for multiple layers
259        if len(modes) > 1:
260            logging.debug("getTextPage: more than one mode=%s"%mode)
261                       
262        # search mode
263        if 'search' in modes:
264            # add highlighting
265            highlightQuery = pageinfo.get('highlightQuery', None)
266            if highlightQuery:
267                textParams['highlightQuery'] = highlightQuery
268                textParams['highlightElement'] = pageinfo.get('highlightElement', '')
269                textParams['highlightElementPos'] = pageinfo.get('highlightElementPos', '')
270               
271            # ignore mode in the following
272            modes.remove('search')
273                           
274        # pundit mode
275        punditMode = False
276        if 'pundit' in modes:
277            punditMode = True
278            # ignore mode in the following
279            modes.remove('pundit')
280                           
281        # other modes don't combine
282        if 'dict' in modes:
283            # dict is called textPollux in the backend
284            textmode = 'textPollux'
285        elif 'xml' in modes:
286            # xml mode
287            textmode = 'xml'
288            textParams['characterNormalization'] = 'orig'
289        elif 'gis' in modes:
290            textmode = 'gis'
291        else:
292            # text is default mode
293            textmode = 'text'
294       
295        textParams['mode'] = textmode
296       
297        try:
298            # fetch the page
299            pagexml = self.getServerData("page-fragment.xql",urllib.urlencode(textParams))
300            dom = ET.fromstring(pagexml)
301        except Exception, e:
302            logging.error("getTextPage: Error reading page: %s"%e)
303            return None
304           
305        # extract additional info
306        self.processPageInfo(dom, docinfo, pageinfo)
307        # page content is in <div class="pageContent">
308        pagediv = None
309        # ElementTree 1.2 in Python 2.6 can't do div[@class='pageContent']
310        # so we look at the second level divs
311        alldivs = dom.findall('div')
312        for div in alldivs:
313            dc = div.get('class')
314            # page content div
315            if dc == 'pageContent':
316                pagediv = div
317                break
318       
319        # plain text mode
320        if textmode == "text":
321            # get full url assuming documentViewer is parent
322            selfurl = self.getLink()
323            if pagediv is not None:
324                if punditMode:
325                    pagediv = self.addPunditAttributes(pagediv, pageinfo, docinfo)
326                   
327                # fix empty div tags
328                divs = pagediv.findall('.//div')
329                for d in divs:
330                    if len(d) == 0 and not d.text:
331                        # make empty divs non-empty
332                        d.text = ' '
333                   
334                # check all a-tags
335                links = pagediv.findall('.//a')
336                for l in links:
337                    href = l.get('href')
338                    if href and href.startswith('#note-'):
339                        href = href.replace('#note-',"%s#note-"%selfurl)
340                        l.set('href', href)
341
342                return serialize(pagediv)
343           
344        # text-with-links mode
345        elif textmode == "textPollux":
346            if pagediv is not None:
347                viewerurl = docinfo['viewerUrl']
348                selfurl = self.getLink()
349                if punditMode:
350                    pagediv = self.addPunditAttributes(pagediv, pageinfo, docinfo)
351                   
352                # fix empty div tags
353                divs = pagediv.findall('.//div')
354                for d in divs:
355                    if len(d) == 0 and not d.text:
356                        # make empty divs non-empty
357                        d.text = ' '
358                   
359                # check all a-tags
360                links = pagediv.findall(".//a")
361                for l in links:
362                    href = l.get('href')
363                   
364                    if href:
365                        # is link with href
366                        linkurl = urlparse.urlparse(href)
367                        #logging.debug("getTextPage: linkurl=%s"%repr(linkurl))
368                        if linkurl.path.endswith('GetDictionaryEntries'):
369                            #TODO: replace wordInfo page
370                            # is dictionary link - change href (keeping parameters)
371                            #l.set('href', href.replace('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/interface/lt/wordInfo.xql','%s/template/viewer_wordinfo'%viewerurl))
372                            # add target to open new page
373                            l.set('target', '_blank')
374                                                         
375                        if href.startswith('#note-'):
376                            # note link
377                            l.set('href', href.replace('#note-',"%s#note-"%selfurl))
378                             
379                return serialize(pagediv)
380           
381        # xml mode
382        elif textmode == "xml":
383            if pagediv is not None:
384                return serialize(pagediv)
385           
386        # pureXml mode WTF?
387        elif textmode == "pureXml":
388            if pagediv is not None:
389                return serialize(pagediv)
390                 
391        # gis mode
392        elif textmode == "gis":
393            if pagediv is not None:
394                # fix empty div tags
395                divs = pagediv.findall('.//div')
396                for d in divs:
397                    if len(d) == 0 and not d.text:
398                        # make empty divs non-empty
399                        d.text = ' '
400                   
401                # check all a-tags
402                links = pagediv.findall(".//a")
403                # add our URL as backlink
404                selfurl = self.getLink()
405                doc = base64.b64encode(selfurl)
406                for l in links:
407                    href = l.get('href')
408                    if href:
409                        if href.startswith('http://mappit.mpiwg-berlin.mpg.de'):
410                            l.set('href', re.sub(r'doc=[\w+/=]+', 'doc=%s'%doc, href))
411                            l.set('target', '_blank')
412                           
413                return serialize(pagediv)
414                   
415        return None
416   
417    def addPunditAttributes(self, pagediv, pageinfo, docinfo):
418        """add about attributes for pundit annotation tool"""
419        textid = docinfo.get('DRI', "fn=%s"%docinfo.get('documentPath', '???'))
420        pn = pageinfo.get('pn', '1')
421        #  TODO: use pn as well?
422        # check all div-tags
423        divs = pagediv.findall(".//div")
424        for d in divs:
425            id = d.get('id')
426            if id:
427                d.set('about', "http://echo.mpiwg-berlin.mpg.de/%s/pn=%s/#%s"%(textid,pn,id))
428                cls = d.get('class','')
429                cls += ' pundit-content'
430                d.set('class', cls.strip())
431
432        return pagediv
433
434    def getSearchResults(self, mode, query=None, pageinfo=None, docinfo=None):
435        """loads list of search results and stores XML in docinfo"""
436       
437        logging.debug("getSearchResults mode=%s query=%s"%(mode, query))
438        if mode == "none":
439            return docinfo
440             
441        cachedQuery = docinfo.get('cachedQuery', None)
442        if cachedQuery is not None:
443            # cached search result
444            if cachedQuery == '%s_%s'%(mode,query):
445                # same query
446                return docinfo
447           
448            else:
449                # different query
450                del docinfo['resultSize']
451                del docinfo['resultXML']
452       
453        # cache query
454        docinfo['cachedQuery'] = '%s_%s'%(mode,query)
455       
456        # fetch full results
457        docpath = docinfo['textURLPath']
458        params = {'document': docpath,
459                  'mode': 'text',
460                  'queryType': mode,
461                  'query': query,
462                  'queryResultPageSize': 1000,
463                  'queryResultPN': 1,
464                  'characterNormalization': pageinfo.get('characterNormalization', 'reg')}
465        pagexml = self.getServerData("doc-query.xql",urllib.urlencode(params))
466        #pagexml = self.getServerData("doc-query.xql","document=%s&mode=%s&queryType=%s&query=%s&queryResultPageSize=%s&queryResultPN=%s&s=%s&viewMode=%s&characterNormalization=%s&highlightElementPos=%s&highlightElement=%s&highlightQuery=%s"%(docpath, 'text', queryType, urllib.quote(query), pagesize, pn, s, viewMode,characterNormalization, highlightElementPos, highlightElement, urllib.quote(highlightQuery)))
467        dom = ET.fromstring(pagexml)
468        # page content is in <div class="queryResultPage">
469        pagediv = None
470        # ElementTree 1.2 in Python 2.6 can't do div[@class='queryResultPage']
471        alldivs = dom.findall("div")
472        for div in alldivs:
473            dc = div.get('class')
474            # page content div
475            if dc == 'queryResultPage':
476                pagediv = div
477               
478            elif dc == 'queryResultHits':
479                docinfo['resultSize'] = getInt(div.text)
480
481        if pagediv is not None:
482            # store XML in docinfo
483            docinfo['resultXML'] = ET.tostring(pagediv, 'UTF-8')
484
485        return docinfo
486   
487
488    def getResultsPage(self, mode="text", query=None, pn=None, start=None, size=None, pageinfo=None, docinfo=None):
489        """returns single page from the table of contents"""
490        logging.debug("getResultsPage mode=%s, pn=%s"%(mode,pn))
491        # get (cached) result
492        self.getSearchResults(mode=mode, query=query, pageinfo=pageinfo, docinfo=docinfo)
493           
494        resultxml = docinfo.get('resultXML', None)
495        if not resultxml:
496            logging.error("getResultPage: unable to find resultXML")
497            return "Error: no result!"
498       
499        if size is None:
500            size = pageinfo.get('resultPageSize', 10)
501           
502        if start is None:
503            start = (pn - 1) * size
504
505        fullresult = ET.fromstring(resultxml)
506       
507        if fullresult is not None:
508            # paginate
509            first = start-1
510            len = size
511            del fullresult[:first]
512            del fullresult[len:]
513            tocdivs = fullresult
514           
515            # check all a-tags
516            links = tocdivs.findall(".//a")
517            for l in links:
518                href = l.get('href')
519                if href:
520                    # assume all links go to pages
521                    linkUrl = urlparse.urlparse(href)
522                    linkParams = urlparse.parse_qs(linkUrl.query)
523                    # take some parameters
524                    params = {'pn': linkParams['pn'],
525                              'highlightQuery': linkParams.get('highlightQuery',''),
526                              'highlightElement': linkParams.get('highlightElement',''),
527                              'highlightElementPos': linkParams.get('highlightElementPos','')
528                              }
529                    url = self.getLink(params=params)
530                    l.set('href', url)
531                       
532            return serialize(tocdivs)
533       
534        return "ERROR: no results!"
535
536
537    def getToc(self, mode='text', docinfo=None):
538        """returns list of table of contents from docinfo"""
539        logging.debug("getToc mode=%s"%mode)
540        if mode == 'text':
541            queryType = 'toc'
542        else:
543            queryType = mode
544           
545        if not 'full_%s'%queryType in docinfo:
546            # get new toc
547            docinfo = self.getTextInfo(queryType, docinfo)
548           
549        return docinfo.get('full_%s'%queryType, [])
550
551    def getTocPage(self, mode='text', pn=None, start=None, size=None, pageinfo=None, docinfo=None):
552        """returns single page from the table of contents"""
553        logging.debug("getTocPage mode=%s, pn=%s start=%s size=%s"%(mode,repr(pn),repr(start),repr(size)))
554        fulltoc = self.getToc(mode=mode, docinfo=docinfo)
555        if len(fulltoc) < 1:
556            logging.error("getTocPage: unable to find toc!")
557            return "Error: no table of contents!"       
558       
559        if size is None:
560            size = pageinfo.get('tocPageSize', 30)
561           
562        if start is None:
563            start = (pn - 1) * size
564
565        # paginate
566        first = (start - 1)
567        last = first + size
568        tocs = fulltoc[first:last]
569        tp = '<div>'
570        for toc in tocs:
571            pageurl = self.getLink('pn', toc['pn'])
572            tp += '<div class="tocline">'
573            tp += '<div class="toc name">[%s %s]</div>'%(toc['level-string'], toc['content'])
574            tp += '<div class="toc float right page"><a href="%s">Page: %s</a></div>'%(pageurl, toc['pn'])
575            tp += '</div>\n'
576           
577        tp += '</div>\n'
578       
579        return tp
580           
581   
582    def manage_changeMpdlXmlTextServer(self,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,repositoryType=None,RESPONSE=None):
583        """change settings"""
584        self.title=title
585        self.timeout = timeout
586        self.serverUrl = serverUrl
587        if repositoryType:
588            self.repositoryType = repositoryType
589        if RESPONSE is not None:
590            RESPONSE.redirect('manage_main')
591       
592# management methods
593def manage_addMpdlXmlTextServerForm(self):
594    """Form for adding"""
595    pt = PageTemplateFile("zpt/manage_addMpdlXmlTextServer", globals()).__of__(self)
596    return pt()
597
598def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,RESPONSE=None):
599#def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de:30030/mpdl/interface/",timeout=40,RESPONSE=None):   
600    """add zogiimage"""
601    newObj = MpdlXmlTextServer(id,title,serverUrl,timeout)
602    self.Destination()._setObject(id, newObj)
603    if RESPONSE is not None:
604        RESPONSE.redirect('manage_main')
605       
606       
Note: See TracBrowser for help on using the repository browser.