source: documentViewer/MpdlXmlTextServer.py @ 561:9255acc4518d

Last change on this file since 561:9255acc4518d was 561:9255acc4518d, checked in by casties, 12 years ago

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