source: documentViewer/MpdlXmlTextServer.py @ 529:f0e28d31ebc6

Last change on this file since 529:f0e28d31ebc6 was 529:f0e28d31ebc6, checked in by casties, 12 years ago

fixed bug with viewmode xml.
File size: 20.7 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 'xml' in modes:
255            # xml mode
256            textmode = 'xml'
257            textParams['characterNormalization'] = 'orig'
258        else:
259            # text is default mode
260            textmode = 'text'
261       
262        textParams['mode'] = textmode
263       
264        # fetch the page
265        pagexml = self.getServerData("page-fragment.xql",urllib.urlencode(textParams))
266        dom = ET.fromstring(pagexml)
267        # extract additional info
268        self.processPageInfo(dom, docinfo, pageinfo)
269        # page content is in <div class="pageContent">
270        pagediv = None
271        # ElementTree 1.2 in Python 2.6 can't do div[@class='pageContent']
272        # so we look at the second level divs
273        alldivs = dom.findall("div")
274        for div in alldivs:
275            dc = div.get('class')
276            # page content div
277            if dc == 'pageContent':
278                pagediv = div
279                break
280       
281        # plain text mode
282        if textmode == "text":
283            # get full url assuming documentViewer is parent
284            selfurl = self.getLink()
285            if pagediv is not None:
286                links = pagediv.findall(".//a")
287                for l in links:
288                    href = l.get('href')
289                    if href and href.startswith('#note-'):
290                        href = href.replace('#note-',"%s#note-"%selfurl)
291                        l.set('href', href)
292
293                return serialize(pagediv)
294           
295        # text-with-links mode
296        elif textmode == "textPollux":
297            if pagediv is not None:
298                viewerurl = docinfo['viewerUrl']
299                selfurl = self.getLink()
300                # check all a-tags
301                links = pagediv.findall(".//a")
302                for l in links:
303                    href = l.get('href')
304                   
305                    if href:
306                        # is link with href
307                        linkurl = urlparse.urlparse(href)
308                        #logging.debug("getTextPage: linkurl=%s"%repr(linkurl))
309                        if linkurl.path.endswith('GetDictionaryEntries'):
310                            #TODO: replace wordInfo page
311                            # is dictionary link - change href (keeping parameters)
312                            #l.set('href', href.replace('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/interface/lt/wordInfo.xql','%s/template/viewer_wordinfo'%viewerurl))
313                            # add target to open new page
314                            l.set('target', '_blank')
315                                                         
316                        # TODO: is this needed?
317#                        if href.startswith('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/lt/lemma.xql'):
318#                            selfurl = self.absolute_url()
319#                            l.set('href', href.replace('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/lt/lemma.xql','%s/head_main_lemma'%selfurl))
320#                            l.set('target', '_blank')
321#                            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;")
322#                            l.set('ondblclick', 'popupWin.focus();')   
323                   
324                        if href.startswith('#note-'):
325                            # note link
326                            l.set('href', href.replace('#note-',"%s#note-"%selfurl))
327                             
328                return serialize(pagediv)
329           
330        # xml mode
331        elif textmode == "xml":
332            if pagediv is not None:
333                return serialize(pagediv)
334           
335        # pureXml mode
336        elif textmode == "pureXml":
337            if pagediv is not None:
338                return serialize(pagediv)
339                 
340        # gis mode
341        elif textmode == "gis":
342            if pagediv is not None:
343                # check all a-tags
344                links = pagediv.findall(".//a")
345                # add our URL as backlink
346                selfurl = self.getLink()
347                doc = base64.b64encode(selfurl)
348                for l in links:
349                    href = l.get('href')
350                    if href:
351                        if href.startswith('http://mappit.mpiwg-berlin.mpg.de'):
352                            l.set('href', re.sub(r'doc=[\w+/=]+', 'doc=%s'%doc, href))
353                            l.set('target', '_blank')
354                           
355                return serialize(pagediv)
356                   
357        return None
358   
359
360    def getSearchResults(self, mode, query=None, pageinfo=None, docinfo=None):
361        """loads list of search results and stores XML in docinfo"""
362       
363        logging.debug("getSearchResults mode=%s query=%s"%(mode, query))
364        if mode == "none":
365            return docinfo
366             
367        cachedQuery = docinfo.get('cachedQuery', None)
368        if cachedQuery is not None:
369            # cached search result
370            if cachedQuery == '%s_%s'%(mode,query):
371                # same query
372                return docinfo
373           
374            else:
375                # different query
376                del docinfo['resultSize']
377                del docinfo['resultXML']
378       
379        # cache query
380        docinfo['cachedQuery'] = '%s_%s'%(mode,query)
381       
382        # fetch full results
383        docpath = docinfo['textURLPath']
384        params = {'document': docpath,
385                  'mode': 'text',
386                  'queryType': mode,
387                  'query': query,
388                  'queryResultPageSize': 1000,
389                  'queryResultPN': 1,
390                  'characterNormalization': pageinfo.get('characterNormalization', 'reg')}
391        pagexml = self.getServerData("doc-query.xql",urllib.urlencode(params))
392        #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)))
393        dom = ET.fromstring(pagexml)
394        # page content is in <div class="queryResultPage">
395        pagediv = None
396        # ElementTree 1.2 in Python 2.6 can't do div[@class='queryResultPage']
397        alldivs = dom.findall("div")
398        for div in alldivs:
399            dc = div.get('class')
400            # page content div
401            if dc == 'queryResultPage':
402                pagediv = div
403               
404            elif dc == 'queryResultHits':
405                docinfo['resultSize'] = getInt(div.text)
406
407        if pagediv is not None:
408            # store XML in docinfo
409            docinfo['resultXML'] = ET.tostring(pagediv, 'UTF-8')
410
411        return docinfo
412   
413
414    def getResultsPage(self, mode="text", query=None, pn=None, start=None, size=None, pageinfo=None, docinfo=None):
415        """returns single page from the table of contents"""
416        logging.debug("getResultsPage mode=%s, pn=%s"%(mode,pn))
417        # get (cached) result
418        self.getSearchResults(mode=mode, query=query, pageinfo=pageinfo, docinfo=docinfo)
419           
420        resultxml = docinfo.get('resultXML', None)
421        if not resultxml:
422            logging.error("getResultPage: unable to find resultXML")
423            return "Error: no result!"
424       
425        if size is None:
426            size = pageinfo.get('resultPageSize', 10)
427           
428        if start is None:
429            start = (pn - 1) * size
430
431        fullresult = ET.fromstring(resultxml)
432       
433        if fullresult is not None:
434            # paginate
435            first = start-1
436            len = size
437            del fullresult[:first]
438            del fullresult[len:]
439            tocdivs = fullresult
440           
441            # check all a-tags
442            links = tocdivs.findall(".//a")
443            for l in links:
444                href = l.get('href')
445                if href:
446                    # assume all links go to pages
447                    linkUrl = urlparse.urlparse(href)
448                    linkParams = urlparse.parse_qs(linkUrl.query)
449                    # take some parameters
450                    params = {'pn': linkParams['pn'],
451                              'highlightQuery': linkParams.get('highlightQuery',''),
452                              'highlightElement': linkParams.get('highlightElement',''),
453                              'highlightElementPos': linkParams.get('highlightElementPos','')
454                              }
455                    url = self.getLink(params=params)
456                    l.set('href', url)
457                       
458            return serialize(tocdivs)
459       
460        return "ERROR: no results!"
461
462
463    def getToc(self, mode='text', docinfo=None):
464        """returns list of table of contents from docinfo"""
465        logging.debug("getToc mode=%s"%mode)
466        if mode == 'text':
467            queryType = 'toc'
468        else:
469            queryType = mode
470           
471        if not 'full_%s'%queryType in docinfo:
472            # get new toc
473            docinfo = self.getTextInfo(queryType, docinfo)
474           
475        return docinfo.get('full_%s'%queryType, [])
476
477    def getTocPage(self, mode='text', pn=None, start=None, size=None, pageinfo=None, docinfo=None):
478        """returns single page from the table of contents"""
479        logging.debug("getTocPage mode=%s, pn=%s start=%s size=%s"%(mode,repr(pn),repr(start),repr(size)))
480        fulltoc = self.getToc(mode=mode, docinfo=docinfo)
481        if len(fulltoc) < 1:
482            logging.error("getTocPage: unable to find toc!")
483            return "Error: no table of contents!"       
484       
485        if size is None:
486            size = pageinfo.get('tocPageSize', 30)
487           
488        if start is None:
489            start = (pn - 1) * size
490
491        # paginate
492        first = (start - 1)
493        last = first + size
494        tocs = fulltoc[first:last]
495        tp = '<div>'
496        for toc in tocs:
497            pageurl = self.getLink('pn', toc['pn'])
498            tp += '<div class="tocline">'
499            tp += '<div class="toc name">[%s %s]</div>'%(toc['level-string'], toc['content'])
500            tp += '<div class="toc float right page"><a href="%s">Page: %s</a></div>'%(pageurl, toc['pn'])
501            tp += '</div>\n'
502           
503        tp += '</div>\n'
504       
505        return tp
506           
507   
508    def manage_changeMpdlXmlTextServer(self,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,RESPONSE=None):
509        """change settings"""
510        self.title=title
511        self.timeout = timeout
512        self.serverUrl = serverUrl
513        if RESPONSE is not None:
514            RESPONSE.redirect('manage_main')
515       
516# management methods
517def manage_addMpdlXmlTextServerForm(self):
518    """Form for adding"""
519    pt = PageTemplateFile("zpt/manage_addMpdlXmlTextServer", globals()).__of__(self)
520    return pt()
521
522def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,RESPONSE=None):
523#def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de:30030/mpdl/interface/",timeout=40,RESPONSE=None):   
524    """add zogiimage"""
525    newObj = MpdlXmlTextServer(id,title,serverUrl,timeout)
526    self.Destination()._setObject(id, newObj)
527    if RESPONSE is not None:
528        RESPONSE.redirect('manage_main')
529       
530       
Note: See TracBrowser for help on using the repository browser.