source: documentViewer/MpdlXmlTextServer.py @ 569:be21250420be

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

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