source: documentViewer/MpdlXmlTextServer.py @ 509:9d05befdd462

elementtree
Last change on this file since 509:9d05befdd462 was 509:9d05befdd462, checked in by casties, 12 years ago

try to get characterNormalization in search result working.
File size: 19.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 base64
10
11from SrvTxtUtils import getInt, getText, getHttpData
12
13def serialize(node):
14    """returns a string containing an XML snippet of node"""
15    s = ET.tostring(node, 'UTF-8')
16    # snip off XML declaration
17    if s.startswith('<?xml'):
18        i = s.find('?>')
19        return s[i+3:]
20
21    return s
22
23
24class MpdlXmlTextServer(SimpleItem):
25    """TextServer implementation for MPDL-XML eXist server"""
26    meta_type="MPDL-XML TextServer"
27
28    manage_options=(
29        {'label':'Config','action':'manage_changeMpdlXmlTextServerForm'},
30       )+SimpleItem.manage_options
31   
32    manage_changeMpdlXmlTextServerForm = PageTemplateFile("zpt/manage_changeMpdlXmlTextServer", globals())
33       
34    def __init__(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/", serverName=None, timeout=40):
35        """constructor"""
36        self.id=id
37        self.title=title
38        self.timeout = timeout
39        if serverName is None:
40            self.serverUrl = serverUrl
41        else:
42            self.serverUrl = "http://%s/mpdl/interface/"%serverName
43       
44    def getHttpData(self, url, data=None):
45        """returns result from url+data HTTP request"""
46        return getHttpData(url,data,timeout=self.timeout)
47   
48    def getServerData(self, method, data=None):
49        """returns result from text server for method+data"""
50        url = self.serverUrl+method
51        return getHttpData(url,data,timeout=self.timeout)
52
53
54    def getPlacesOnPage(self, docinfo=None, pn=None):
55        """Returns list of GIS places of page pn"""
56        docpath = docinfo.get('textURLPath',None)
57        if not docpath:
58            return None
59
60        places=[]
61        text=self.getServerData("xpath.xql", "document=%s&xpath=//place&pn=%s"%(docpath,pn))
62        dom = ET.fromstring(text)
63        result = dom.findall(".//resultPage/place")
64        for l in result:
65            id = l.get("id")
66            name = l.text
67            place = {'id': id, 'name': name}
68            places.append(place)
69
70        return places
71   
72         
73    def processPageInfo(self, dom, docinfo, pageinfo):
74        """processes page info divs from dom and stores in docinfo and pageinfo"""
75        # assume first second level div is pageMeta
76        alldivs = dom.find("div")
77       
78        if alldivs is None or alldivs.get('class', '') != 'pageMeta':
79            logging.error("processPageInfo: pageMeta div not found!")
80            return
81       
82        for div in alldivs:
83            dc = div.get('class')
84           
85            # pageNumberOrig 
86            if dc == 'pageNumberOrig':
87                pageinfo['pageNumberOrig'] = div.text
88               
89            # pageNumberOrigNorm
90            elif dc == 'pageNumberOrigNorm':
91                pageinfo['pageNumberOrigNorm'] = div.text
92               
93            # pageHeaderTitle
94            elif dc == 'pageHeaderTitle':
95                pageinfo['pageHeaderTitle'] = div.text
96               
97            # numFigureEntries
98            elif dc == 'countFigureEntries':
99                docinfo['numFigureEntries'] = getInt(div.text)
100               
101            # numTocEntries
102            elif dc == 'countTocEntries':
103                # WTF: s1 = int(s)/30+1
104                docinfo['numTocEntries'] = getInt(div.text)
105               
106            # numPlaces
107            elif dc == 'countPlaces':
108                docinfo['numPlaces'] = getInt(div.text)
109               
110            # numTextPages
111            elif dc == 'countPages':
112                np = getInt(div.text)                   
113                if np > 0:
114                    docinfo['numTextPages'] = np
115                    if docinfo.get('numPages', 0) == 0:
116                        # seems to be text-only - update page count
117                        docinfo['numPages'] = np
118                        #pageinfo['end'] = min(pageinfo['end'], np)
119                        pageinfo['numgroups'] = int(np / pageinfo['groupsize'])
120                        if np % pageinfo['groupsize'] > 0:
121                            pageinfo['numgroups'] += 1
122       
123        #logging.debug("processPageInfo: pageinfo=%s"%repr(pageinfo))
124        return
125         
126           
127    def getTextPage(self, mode="text", pn=1, docinfo=None, pageinfo=None):
128        """returns single page from fulltext"""
129       
130        logging.debug("getTextPage mode=%s, pn=%s"%(mode,pn))
131        # check for cached text -- but ideally this shouldn't be called twice
132        if pageinfo.has_key('textPage'):
133            logging.debug("getTextPage: using cached text")
134            return pageinfo['textPage']
135       
136        docpath = docinfo['textURLPath']
137        # just checking
138        if pageinfo['current'] != pn:
139            logging.warning("getTextPage: current!=pn!")
140           
141        # stuff for constructing full urls
142        characterNormalization = pageinfo.get('characterNormalization', None)
143        moreTextParam = ''
144        selfurl = docinfo['viewerUrl']
145       
146        if not mode:
147            # default is dict
148            mode = 'text'
149
150        modes = mode.split(',')
151        # check for multiple layers
152        if len(modes) > 1:
153            logging.debug("getTextPage: more than one mode=%s"%mode)
154           
155        # search mode
156        if 'search' in modes:
157            # add highlighting
158            highlightQuery = pageinfo.get('highlightQuery', None)
159            sn = pageinfo.get('sn', None)
160            if highlightQuery and sn:
161                moreTextParam +="&highlightQuery=%s&sn=%s"%(urllib.quote(highlightQuery),sn)
162               
163            # remove mode
164            modes.remove('search')
165                           
166        # other modes don't combine
167        if 'dict' in modes:
168            # dict is called textPollux in the backend
169            textmode = 'textPollux'
170        elif len(modes) == 0:
171            # text is default mode
172            textmode = 'text'
173        else:
174            # just take first mode
175            textmode = modes[0]
176       
177        textParam = "document=%s&mode=%s&pn=%s&characterNormalization=%s"%(docpath,textmode,pn,characterNormalization)
178        textParam += moreTextParam
179       
180        # fetch the page
181        pagexml = self.getServerData("page-fragment.xql",textParam)
182        dom = ET.fromstring(pagexml)
183        # extract additional info
184        self.processPageInfo(dom, docinfo, pageinfo)
185        # page content is in <div class="pageContent">
186        pagediv = None
187        # ElementTree 1.2 in Python 2.6 can't do div[@class='pageContent']
188        # so we look at the second level divs
189        alldivs = dom.findall("div")
190        for div in alldivs:
191            dc = div.get('class')
192            # page content div
193            if dc == 'pageContent':
194                pagediv = div
195                break
196       
197        # plain text mode
198        if textmode == "text":
199            # get full url assuming documentViewer is parent
200            selfurl = self.getLink()
201            if pagediv is not None:
202                links = pagediv.findall(".//a")
203                for l in links:
204                    href = l.get('href')
205                    if href and href.startswith('#note-'):
206                        href = href.replace('#note-',"%s#note-"%selfurl)
207                        l.set('href', href)
208
209                return serialize(pagediv)
210           
211        # text-with-links mode
212        elif textmode == "textPollux":
213            if pagediv is not None:
214                viewerurl = docinfo['viewerUrl']
215                selfurl = self.getLink()
216                # check all a-tags
217                links = pagediv.findall(".//a")
218                for l in links:
219                    href = l.get('href')
220                   
221                    if href:
222                        # is link with href
223                        if href.startswith('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/interface/lt/wordInfo.xql'):
224                            # is dictionary link - change href (keeping parameters)
225                            l.set('href', href.replace('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/interface/lt/wordInfo.xql','%s/template/viewer_wordinfo'%viewerurl))
226                            # add target to open new page
227                            l.set('target', '_blank')
228                                                         
229                        # TODO: is this needed?
230                        if href.startswith('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/lt/lemma.xql'):
231                            selfurl = self.absolute_url()
232                            l.set('href', href.replace('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/lt/lemma.xql','%s/head_main_lemma'%selfurl))
233                            l.set('target', '_blank')
234                            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;")
235                            l.set('ondblclick', 'popupWin.focus();')   
236                   
237                        if href.startswith('#note-'):
238                            # note link
239                            l.set('href', href.replace('#note-',"%s#note-"%selfurl))
240                             
241                return serialize(pagediv)
242           
243        # xml mode
244        elif textmode == "xml":
245            if pagediv is not None:
246                return serialize(pagediv)
247           
248        # pureXml mode
249        elif textmode == "pureXml":
250            if pagediv is not None:
251                return serialize(pagediv)
252                 
253        # gis mode
254        elif textmode == "gis":
255            if pagediv is not None:
256                # check all a-tags
257                links = pagediv.findall(".//a")
258                # add our URL as backlink
259                selfurl = self.getLink()
260                doc = base64.b64encode(selfurl)
261                for l in links:
262                    href = l.get('href')
263                    if href:
264                        if href.startswith('http://mappit.mpiwg-berlin.mpg.de'):
265                            l.set('href', re.sub(r'doc=[\w+/=]+', 'doc=%s'%doc, href))
266                            l.set('target', '_blank')
267                           
268                return serialize(pagediv)
269                   
270        return None
271   
272
273    def getSearchResults(self, mode, query=None, pageinfo=None, docinfo=None):
274        """loads list of search results and stores XML in docinfo"""
275        logging.debug("getSearchResults mode=%s query=%s"%(mode, query))
276        if mode == "none":
277            return docinfo
278             
279        if 'resultSize_%s_%s'%(mode,query) in docinfo:
280            # cached result
281            return docinfo
282       
283        docpath = docinfo['textURLPath']
284       
285        # fetch full results
286        params = {'document': docpath,
287                  'mode': 'text',
288                  'queryType': mode,
289                  'query': query,
290                  'queryResultPageSize': 1000,
291                  'queryResultPN': 1,
292                  'characterNormalization': pageinfo.get('characterNormalization', 'reg')}
293        pagexml = self.getServerData("doc-query.xql",urllib.urlencode(params))
294        #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)))
295        dom = ET.fromstring(pagexml)
296        # page content is in <div class="queryResultPage">
297        pagediv = None
298        # ElementTree 1.2 in Python 2.6 can't do div[@class='queryResultPage']
299        alldivs = dom.findall("div")
300        for div in alldivs:
301            dc = div.get('class')
302            # page content div
303            if dc == 'queryResultPage':
304                pagediv = div
305               
306            elif dc == 'queryResultHits':
307                docinfo['resultSize_%s_%s'%(mode,query)] = getInt(div.text)
308
309        if pagediv:
310            # store XML in docinfo
311            docinfo['resultXML_%s_%s'%(mode,query)] = ET.tostring(pagediv, 'UTF-8')
312
313        logging.debug("getSearchResults: pagediv=%s"%pagediv)
314        return docinfo
315   
316
317    def getResultsPage(self, mode="text", query=None, pn=None, start=None, size=None, pageinfo=None, docinfo=None):
318        """returns single page from the table of contents"""
319        logging.debug("getResultsPage mode=%s, pn=%s"%(mode,pn))
320        # check for cached TOC
321        #TODO: cache only one search
322        if not docinfo.has_key('resultXML_%s_%s'%(mode,query)):
323            self.getSearchResults(mode=mode, query=query, pageinfo=pageinfo, docinfo=docinfo)
324           
325        resultxml = docinfo.get('resultXML_%s_%s'%(mode,query), None)
326        if not resultxml:
327            logging.error("getResultPage: unable to find resultXML")
328            return "Error: no result!"
329       
330        if size is None:
331            size = pageinfo.get('searchResultPageSize', 20)
332           
333        if start is None:
334            start = (pn - 1) * size
335
336        fullresult = ET.fromstring(resultxml)
337       
338        if fullresult:
339            # paginate
340            first = start
341            len = size
342            del fullresult[:first]
343            del fullresult[len:]
344            tocdivs = fullresult
345           
346            # check all a-tags
347            links = tocdivs.findall(".//a")
348            for l in links:
349                href = l.get('href')
350                if href:
351                    # take pn from href
352                    m = re.match(r'page-fragment\.xql.*pn=(\d+)', href)
353                    if m is not None:
354                        # and create new url (assuming parent is documentViewer)
355                        #TODO: add highlighting params
356                        url = self.getLink('pn', m.group(1))
357                        l.set('href', url)
358                    else:
359                        logging.warning("getResultPage: Problem with link=%s"%href)
360                       
361            # fix two-divs-per-row with containing div
362#            newtoc = ET.Element('div', {'class':'queryResultPage'})
363#            for (d1,d2) in zip(tocdivs[::2],tocdivs[1::2]):
364#                e = ET.Element('div',{'class':'tocline'})
365#                e.append(d1)
366#                e.append(d2)
367#                newtoc.append(e)
368               
369            return serialize(tocdivs)
370       
371        return "ERROR: no results!"
372
373
374    def getToc(self, mode="text", docinfo=None):
375        """loads table of contents and stores XML in docinfo"""
376        logging.debug("getToc mode=%s"%mode)
377        if mode == "none":
378            return docinfo
379             
380        if 'tocSize_%s'%mode in docinfo:
381            # cached toc
382            return docinfo
383       
384        docpath = docinfo['textURLPath']
385        # we need to set a result set size
386        pagesize = 1000
387        pn = 1
388        if mode == "text":
389            queryType = "toc"
390        else:
391            queryType = mode
392        # number of entries in toc
393        tocSize = 0
394        tocDiv = None
395        # fetch full toc
396        pagexml = self.getServerData("doc-query.xql","document=%s&queryType=%s&queryResultPageSize=%s&queryResultPN=%s"%(docpath,queryType, pagesize, pn))
397        dom = ET.fromstring(pagexml)
398        # page content is in <div class="queryResultPage">
399        pagediv = None
400        # ElementTree 1.2 in Python 2.6 can't do div[@class='queryResultPage']
401        alldivs = dom.findall("div")
402        for div in alldivs:
403            dc = div.get('class')
404            # page content div
405            if dc == 'queryResultPage':
406                pagediv = div
407               
408            elif dc == 'queryResultHits':
409                docinfo['tocSize_%s'%mode] = getInt(div.text)
410
411        if pagediv:
412            # store XML in docinfo
413            docinfo['tocXML_%s'%mode] = ET.tostring(pagediv, 'UTF-8')
414
415        return docinfo
416   
417    def getTocPage(self, mode="text", pn=None, start=None, size=None, pageinfo=None, docinfo=None):
418        """returns single page from the table of contents"""
419        logging.debug("getTocPage mode=%s, pn=%s"%(mode,pn))
420        if mode == "text":
421            queryType = "toc"
422        else:
423            queryType = mode
424           
425        # check for cached TOC
426        if not docinfo.has_key('tocXML_%s'%mode):
427            self.getToc(mode=mode, docinfo=docinfo)
428           
429        tocxml = docinfo.get('tocXML_%s'%mode, None)
430        if not tocxml:
431            logging.error("getTocPage: unable to find tocXML")
432            return "Error: no table of contents!"
433       
434        if size is None:
435            size = pageinfo.get('tocPageSize', 30)
436           
437        if start is None:
438            start = (pn - 1) * size
439
440        fulltoc = ET.fromstring(tocxml)
441       
442        if fulltoc:
443            # paginate
444            first = (start - 1) * 2
445            len = size * 2
446            del fulltoc[:first]
447            del fulltoc[len:]
448            tocdivs = fulltoc
449           
450            # check all a-tags
451            links = tocdivs.findall(".//a")
452            for l in links:
453                href = l.get('href')
454                if href:
455                    # take pn from href
456                    m = re.match(r'page-fragment\.xql.*pn=(\d+)', href)
457                    if m is not None:
458                        # and create new url (assuming parent is documentViewer)
459                        url = self.getLink('pn', m.group(1))
460                        l.set('href', url)
461                    else:
462                        logging.warning("getTocPage: Problem with link=%s"%href)
463                       
464            # fix two-divs-per-row with containing div
465            newtoc = ET.Element('div', {'class':'queryResultPage'})
466            for (d1,d2) in zip(tocdivs[::2],tocdivs[1::2]):
467                e = ET.Element('div',{'class':'tocline'})
468                e.append(d1)
469                e.append(d2)
470                newtoc.append(e)
471               
472            return serialize(newtoc)
473       
474        return "ERROR: no table of contents!"
475   
476   
477    def manage_changeMpdlXmlTextServer(self,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,RESPONSE=None):
478        """change settings"""
479        self.title=title
480        self.timeout = timeout
481        self.serverUrl = serverUrl
482        if RESPONSE is not None:
483            RESPONSE.redirect('manage_main')
484       
485# management methods
486def manage_addMpdlXmlTextServerForm(self):
487    """Form for adding"""
488    pt = PageTemplateFile("zpt/manage_addMpdlXmlTextServer", globals()).__of__(self)
489    return pt()
490
491def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,RESPONSE=None):
492#def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de:30030/mpdl/interface/",timeout=40,RESPONSE=None):   
493    """add zogiimage"""
494    newObj = MpdlXmlTextServer(id,title,serverUrl,timeout)
495    self.Destination()._setObject(id, newObj)
496    if RESPONSE is not None:
497        RESPONSE.redirect('manage_main')
498       
499       
Note: See TracBrowser for help on using the repository browser.