source: documentViewer/MpdlXmlTextServer.py @ 612:a79e4e4b3e37

Last change on this file since 612:a79e4e4b3e37 was 588:e1034c2ca255, checked in by casties, 11 years ago

bug with missing current param.
File size: 23.0 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 getattr(self, 'repositoryType', None)
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 reading doc info: %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        # stuff for constructing full urls
243        selfurl = docinfo['viewerUrl']
244        textParams = {'document': docpath,
245                      'pn': pn}
246        if 'characterNormalization' in pageinfo:
247            textParams['characterNormalization'] = pageinfo['characterNormalization']
248       
249        if not mode:
250            # default is dict
251            mode = 'text'
252
253        modes = mode.split(',')
254        # check for multiple layers
255        if len(modes) > 1:
256            logging.debug("getTextPage: more than one mode=%s"%mode)
257                       
258        # search mode
259        if 'search' in modes:
260            # add highlighting
261            highlightQuery = pageinfo.get('highlightQuery', None)
262            if highlightQuery:
263                textParams['highlightQuery'] = highlightQuery
264                textParams['highlightElement'] = pageinfo.get('highlightElement', '')
265                textParams['highlightElementPos'] = pageinfo.get('highlightElementPos', '')
266               
267            # ignore mode in the following
268            modes.remove('search')
269                           
270        # pundit mode
271        punditMode = False
272        if 'pundit' in modes:
273            punditMode = True
274            # ignore mode in the following
275            modes.remove('pundit')
276                           
277        # other modes don't combine
278        if 'dict' in modes:
279            # dict is called textPollux in the backend
280            textmode = 'textPollux'
281        elif 'xml' in modes:
282            # xml mode
283            textmode = 'xml'
284            textParams['characterNormalization'] = 'orig'
285        elif 'gis' in modes:
286            textmode = 'gis'
287        else:
288            # text is default mode
289            textmode = 'text'
290       
291        textParams['mode'] = textmode
292       
293        try:
294            # fetch the page
295            pagexml = self.getServerData("page-fragment.xql",urllib.urlencode(textParams))
296            dom = ET.fromstring(pagexml)
297        except Exception, e:
298            logging.error("getTextPage: Error reading page: %s"%e)
299            return None
300           
301        # extract additional info
302        self.processPageInfo(dom, docinfo, pageinfo)
303        # page content is in <div class="pageContent">
304        pagediv = None
305        # ElementTree 1.2 in Python 2.6 can't do div[@class='pageContent']
306        # so we look at the second level divs
307        alldivs = dom.findall('div')
308        for div in alldivs:
309            dc = div.get('class')
310            # page content div
311            if dc == 'pageContent':
312                pagediv = div
313                break
314       
315        # plain text mode
316        if textmode == "text":
317            # get full url assuming documentViewer is parent
318            selfurl = self.getLink()
319            if pagediv is not None:
320                if punditMode:
321                    pagediv = self.addPunditAttributes(pagediv, pageinfo, docinfo)
322                   
323                # fix empty div tags
324                divs = pagediv.findall('.//div')
325                for d in divs:
326                    if len(d) == 0 and not d.text:
327                        # make empty divs non-empty
328                        d.text = ' '
329                   
330                # check all a-tags
331                links = pagediv.findall('.//a')
332                for l in links:
333                    href = l.get('href')
334                    if href and href.startswith('#note-'):
335                        href = href.replace('#note-',"%s#note-"%selfurl)
336                        l.set('href', href)
337
338                return serialize(pagediv)
339           
340        # text-with-links mode
341        elif textmode == "textPollux":
342            if pagediv is not None:
343                viewerurl = docinfo['viewerUrl']
344                selfurl = self.getLink()
345                if punditMode:
346                    pagediv = self.addPunditAttributes(pagediv, pageinfo, docinfo)
347                   
348                # fix empty div tags
349                divs = pagediv.findall('.//div')
350                for d in divs:
351                    if len(d) == 0 and not d.text:
352                        # make empty divs non-empty
353                        d.text = ' '
354                   
355                # check all a-tags
356                links = pagediv.findall(".//a")
357                for l in links:
358                    href = l.get('href')
359                   
360                    if href:
361                        # is link with href
362                        linkurl = urlparse.urlparse(href)
363                        #logging.debug("getTextPage: linkurl=%s"%repr(linkurl))
364                        if linkurl.path.endswith('GetDictionaryEntries'):
365                            #TODO: replace wordInfo page
366                            # is dictionary link - change href (keeping parameters)
367                            #l.set('href', href.replace('http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/interface/lt/wordInfo.xql','%s/template/viewer_wordinfo'%viewerurl))
368                            # add target to open new page
369                            l.set('target', '_blank')
370                                                         
371                        if href.startswith('#note-'):
372                            # note link
373                            l.set('href', href.replace('#note-',"%s#note-"%selfurl))
374                             
375                return serialize(pagediv)
376           
377        # xml mode
378        elif textmode == "xml":
379            if pagediv is not None:
380                return serialize(pagediv)
381           
382        # pureXml mode WTF?
383        elif textmode == "pureXml":
384            if pagediv is not None:
385                return serialize(pagediv)
386                 
387        # gis mode
388        elif textmode == "gis":
389            if pagediv is not None:
390                # fix empty div tags
391                divs = pagediv.findall('.//div')
392                for d in divs:
393                    if len(d) == 0 and not d.text:
394                        # make empty divs non-empty
395                        d.text = ' '
396                   
397                # check all a-tags
398                links = pagediv.findall(".//a")
399                # add our URL as backlink
400                selfurl = self.getLink()
401                doc = base64.b64encode(selfurl)
402                for l in links:
403                    href = l.get('href')
404                    if href:
405                        if href.startswith('http://mappit.mpiwg-berlin.mpg.de'):
406                            l.set('href', re.sub(r'doc=[\w+/=]+', 'doc=%s'%doc, href))
407                            l.set('target', '_blank')
408                           
409                return serialize(pagediv)
410                   
411        return None
412   
413    def addPunditAttributes(self, pagediv, pageinfo, docinfo):
414        """add about attributes for pundit annotation tool"""
415        textid = docinfo.get('DRI', "fn=%s"%docinfo.get('documentPath', '???'))
416        pn = pageinfo.get('pn', '1')
417        #  TODO: use pn as well?
418        # check all div-tags
419        divs = pagediv.findall(".//div")
420        for d in divs:
421            id = d.get('id')
422            if id:
423                d.set('about', "http://echo.mpiwg-berlin.mpg.de/%s/pn=%s/#%s"%(textid,pn,id))
424                cls = d.get('class','')
425                cls += ' pundit-content'
426                d.set('class', cls.strip())
427
428        return pagediv
429
430    def getSearchResults(self, mode, query=None, pageinfo=None, docinfo=None):
431        """loads list of search results and stores XML in docinfo"""
432       
433        logging.debug("getSearchResults mode=%s query=%s"%(mode, query))
434        if mode == "none":
435            return docinfo
436             
437        cachedQuery = docinfo.get('cachedQuery', None)
438        if cachedQuery is not None:
439            # cached search result
440            if cachedQuery == '%s_%s'%(mode,query):
441                # same query
442                return docinfo
443           
444            else:
445                # different query
446                del docinfo['resultSize']
447                del docinfo['resultXML']
448       
449        # cache query
450        docinfo['cachedQuery'] = '%s_%s'%(mode,query)
451       
452        # fetch full results
453        docpath = docinfo['textURLPath']
454        params = {'document': docpath,
455                  'mode': 'text',
456                  'queryType': mode,
457                  'query': query,
458                  'queryResultPageSize': 1000,
459                  'queryResultPN': 1,
460                  'characterNormalization': pageinfo.get('characterNormalization', 'reg')}
461        pagexml = self.getServerData("doc-query.xql",urllib.urlencode(params))
462        #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)))
463        dom = ET.fromstring(pagexml)
464        # page content is in <div class="queryResultPage">
465        pagediv = None
466        # ElementTree 1.2 in Python 2.6 can't do div[@class='queryResultPage']
467        alldivs = dom.findall("div")
468        for div in alldivs:
469            dc = div.get('class')
470            # page content div
471            if dc == 'queryResultPage':
472                pagediv = div
473               
474            elif dc == 'queryResultHits':
475                docinfo['resultSize'] = getInt(div.text)
476
477        if pagediv is not None:
478            # store XML in docinfo
479            docinfo['resultXML'] = ET.tostring(pagediv, 'UTF-8')
480
481        return docinfo
482   
483
484    def getResultsPage(self, mode="text", query=None, pn=None, start=None, size=None, pageinfo=None, docinfo=None):
485        """returns single page from the table of contents"""
486        logging.debug("getResultsPage mode=%s, pn=%s"%(mode,pn))
487        # get (cached) result
488        self.getSearchResults(mode=mode, query=query, pageinfo=pageinfo, docinfo=docinfo)
489           
490        resultxml = docinfo.get('resultXML', None)
491        if not resultxml:
492            logging.error("getResultPage: unable to find resultXML")
493            return "Error: no result!"
494       
495        if size is None:
496            size = pageinfo.get('resultPageSize', 10)
497           
498        if start is None:
499            start = (pn - 1) * size
500
501        fullresult = ET.fromstring(resultxml)
502       
503        if fullresult is not None:
504            # paginate
505            first = start-1
506            len = size
507            del fullresult[:first]
508            del fullresult[len:]
509            tocdivs = fullresult
510           
511            # check all a-tags
512            links = tocdivs.findall(".//a")
513            for l in links:
514                href = l.get('href')
515                if href:
516                    # assume all links go to pages
517                    linkUrl = urlparse.urlparse(href)
518                    linkParams = urlparse.parse_qs(linkUrl.query)
519                    # take some parameters
520                    params = {'pn': linkParams['pn'],
521                              'highlightQuery': linkParams.get('highlightQuery',''),
522                              'highlightElement': linkParams.get('highlightElement',''),
523                              'highlightElementPos': linkParams.get('highlightElementPos','')
524                              }
525                    url = self.getLink(params=params)
526                    l.set('href', url)
527                       
528            return serialize(tocdivs)
529       
530        return "ERROR: no results!"
531
532
533    def getToc(self, mode='text', docinfo=None):
534        """returns list of table of contents from docinfo"""
535        logging.debug("getToc mode=%s"%mode)
536        if mode == 'text':
537            queryType = 'toc'
538        else:
539            queryType = mode
540           
541        if not 'full_%s'%queryType in docinfo:
542            # get new toc
543            docinfo = self.getTextInfo(queryType, docinfo)
544           
545        return docinfo.get('full_%s'%queryType, [])
546
547    def getTocPage(self, mode='text', pn=None, start=None, size=None, pageinfo=None, docinfo=None):
548        """returns single page from the table of contents"""
549        logging.debug("getTocPage mode=%s, pn=%s start=%s size=%s"%(mode,repr(pn),repr(start),repr(size)))
550        fulltoc = self.getToc(mode=mode, docinfo=docinfo)
551        if len(fulltoc) < 1:
552            logging.error("getTocPage: unable to find toc!")
553            return "Error: no table of contents!"       
554       
555        if size is None:
556            size = pageinfo.get('tocPageSize', 30)
557           
558        if start is None:
559            start = (pn - 1) * size
560
561        # paginate
562        first = (start - 1)
563        last = first + size
564        tocs = fulltoc[first:last]
565        tp = '<div>'
566        for toc in tocs:
567            pageurl = self.getLink('pn', toc['pn'])
568            tp += '<div class="tocline">'
569            tp += '<div class="toc name">[%s %s]</div>'%(toc['level-string'], toc['content'])
570            tp += '<div class="toc float right page"><a href="%s">Page: %s</a></div>'%(pageurl, toc['pn'])
571            tp += '</div>\n'
572           
573        tp += '</div>\n'
574       
575        return tp
576           
577   
578    def manage_changeMpdlXmlTextServer(self,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,repositoryType=None,RESPONSE=None):
579        """change settings"""
580        self.title=title
581        self.timeout = timeout
582        self.serverUrl = serverUrl
583        if repositoryType:
584            self.repositoryType = repositoryType
585        if RESPONSE is not None:
586            RESPONSE.redirect('manage_main')
587       
588# management methods
589def manage_addMpdlXmlTextServerForm(self):
590    """Form for adding"""
591    pt = PageTemplateFile("zpt/manage_addMpdlXmlTextServer", globals()).__of__(self)
592    return pt()
593
594def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de/mpdl/interface/",timeout=40,RESPONSE=None):
595#def manage_addMpdlXmlTextServer(self,id,title="",serverUrl="http://mpdl-text.mpiwg-berlin.mpg.de:30030/mpdl/interface/",timeout=40,RESPONSE=None):   
596    """add zogiimage"""
597    newObj = MpdlXmlTextServer(id,title,serverUrl,timeout)
598    self.Destination()._setObject(id, newObj)
599    if RESPONSE is not None:
600        RESPONSE.redirect('manage_main')
601       
602       
Note: See TracBrowser for help on using the repository browser.