source: documentViewer/MpdlXmlTextServer.py @ 518:91051b36b9cc

Last change on this file since 518:91051b36b9cc was 518:91051b36b9cc, checked in by casties, 12 years ago

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