--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/web/views/wdoc.py Wed Nov 05 15:52:50 2008 +0100
@@ -0,0 +1,238 @@
+"""inline help system, using ReST file in products `wdoc` directory
+
+:organization: Logilab
+:copyright: 2008 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
+"""
+__docformat__ = "restructuredtext en"
+
+from itertools import chain
+from os.path import join
+from bisect import bisect_right
+
+from mx.DateTime import strptime, today
+
+from logilab.common.changelog import ChangeLog
+from logilab.mtconverter import CHARSET_DECL_RGX
+
+from cubicweb.common.selectors import req_form_params_selector
+from cubicweb.common.view import StartupView
+from cubicweb.common.uilib import rest_publish
+from cubicweb.web import NotFound
+
+_ = unicode
+
+# table of content management #################################################
+
+try:
+ from xml.etree.ElementTree import parse
+except ImportError:
+ from elementtree.ElementTree import parse
+
+def build_toc_index(node, index):
+ try:
+ nodeidx = node.attrib['resource']
+ assert not nodeidx in index, nodeidx
+ index[nodeidx] = node
+ except KeyError:
+ pass
+ for child in node:
+ build_toc_index(child, index)
+ child.parent = node
+
+def get_insertion_point(section, index):
+ if section.attrib.get('insertafter'):
+ snode = index[section.attrib['insertafter']]
+ node = snode.parent
+ idx = node.getchildren().index(snode) + 1
+ elif section.attrib.get('insertbefore'):
+ snode = index[section.attrib['insertbefore']]
+ node = snode.parent
+ idx = node.getchildren().index(snode)
+ else:
+ node = index[section.attrib['appendto']]
+ idx = None
+ return node, idx
+
+def build_toc(config):
+ alltocfiles = reversed(tuple(config.locate_all_files('toc.xml')))
+ maintoc = parse(alltocfiles.next()).getroot()
+ maintoc.parent = None
+ index = {}
+ build_toc_index(maintoc, index)
+ # insert component documentation into the tree according to their toc.xml
+ # file
+ for fpath in alltocfiles:
+ toc = parse(fpath).getroot()
+ for section in toc:
+ node, idx = get_insertion_point(section, index)
+ if idx is None:
+ node.append(section)
+ else:
+ node.insert(idx, section)
+ section.parent = node
+ build_toc_index(section, index)
+ return index
+
+def title(node, lang):
+ for title in node.findall('title'):
+ if title.attrib['{http://www.w3.org/XML/1998/namespace}lang'] == lang:
+ return unicode(title.text)
+
+def subsections(node):
+ return [child for child in node if child.tag == 'section']
+
+# help views ##################################################################
+
+class InlineHelpView(StartupView):
+ __selectors__ = (req_form_params_selector,)
+ form_params = ('fid',)
+ id = 'wdoc'
+ title = _('site documentation')
+
+ def call(self):
+ fid = self.req.form['fid']
+ for lang in chain((self.req.lang, self.vreg.property_value('ui.language')),
+ self.config.available_languages()):
+ rid = '%s_%s.rst' % (fid, lang)
+ resourcedir = self.config.locate_doc_file(rid)
+ if resourcedir:
+ break
+ else:
+ raise NotFound
+ self.tocindex = build_toc(self.config)
+ try:
+ node = self.tocindex[fid]
+ except KeyError:
+ node = None
+ else:
+ self.navigation_links(node)
+ self.w(u'<div class="hr"></div>')
+ self.w(u'<h1>%s</h1>' % (title(node, self.req.lang)))
+ data = open(join(resourcedir, rid)).read()
+ self.w(rest_publish(self, data))
+ if node is not None:
+ self.subsections_links(node)
+ self.w(u'<div class="hr"></div>')
+ self.navigation_links(node)
+
+ def navigation_links(self, node):
+ req = self.req
+ parent = node.parent
+ if parent is None:
+ return
+ brothers = subsections(parent)
+ self.w(u'<div class="docnav">\n')
+ previousidx = brothers.index(node) - 1
+ if previousidx >= 0:
+ self.navsection(brothers[previousidx], 'prev')
+ self.navsection(parent, 'up')
+ nextidx = brothers.index(node) + 1
+ if nextidx < len(brothers):
+ self.navsection(brothers[nextidx], 'next')
+ self.w(u'</div>\n')
+
+ navinfo = {'prev': ('', 'data/previous.png', _('i18nprevnext_previous')),
+ 'next': ('', 'data/next.png', _('i18nprevnext_next')),
+ 'up': ('', 'data/up.png', _('i18nprevnext_up'))}
+
+ def navsection(self, node, navtype):
+ htmlclass, imgpath, msgid = self.navinfo[navtype]
+ self.w(u'<span class="%s">' % htmlclass)
+ self.w(u'%s : ' % self.req._(msgid))
+ self.w(u'<a href="%s">%s</a>' % (
+ self.req.build_url('doc/'+node.attrib['resource']),
+ title(node, self.req.lang)))
+ self.w(u'</span>\n')
+
+ def subsections_links(self, node, first=True):
+ sub = subsections(node)
+ if not sub:
+ return
+ if first:
+ self.w(u'<div class="hr"></div>')
+ self.w(u'<ul class="docsum">')
+ for child in sub:
+ self.w(u'<li><a href="%s">%s</a>' % (
+ self.req.build_url('doc/'+child.attrib['resource']),
+ title(child, self.req.lang)))
+ self.subsections_links(child, False)
+ self.w(u'</li>')
+ self.w(u'</ul>\n')
+
+
+
+class InlineHelpImageView(StartupView):
+ __selectors__ = (req_form_params_selector,)
+ form_params = ('fid',)
+ id = 'wdocimages'
+ binary = True
+ templatable = False
+ content_type = 'image/png'
+
+ def call(self):
+ fid = self.req.form['fid']
+ for lang in chain((self.req.lang, self.vreg.property_value('ui.language')),
+ self.config.available_languages()):
+ rid = join('images', '%s_%s.png' % (fid, lang))
+ resourcedir = self.config.locate_doc_file(rid)
+ if resourcedir:
+ break
+ else:
+ raise NotFound
+ self.w(open(join(resourcedir, rid)).read())
+
+
+class ChangeLogView(StartupView):
+ id = 'changelog'
+ title = _('What\'s new?')
+ maxentries = 25
+
+ def call(self):
+ rid = 'ChangeLog_%s' % (self.req.lang)
+ allentries = []
+ title = self.req._(self.title)
+ restdata = ['.. -*- coding: utf-8 -*-', '', title, '='*len(title), '']
+ w = restdata.append
+ for fpath in self.config.locate_all_files(rid):
+ cl = ChangeLog(fpath)
+ encoding = 'utf-8'
+ # additional content may be found in title
+ for line in (cl.title + cl.additional_content).splitlines():
+ m = CHARSET_DECL_RGX.search(line)
+ if m is not None:
+ encoding = m.group(1)
+ continue
+ elif line.startswith('.. '):
+ w(unicode(line, encoding))
+ for entry in cl.entries:
+ if entry.date:
+ date = strptime(entry.date, '%Y-%m-%d')
+ else:
+ date = today()
+ messages = []
+ for msglines, submsgs in entry.messages:
+ msgstr = unicode(' '.join(l.strip() for l in msglines), encoding)
+ msgstr += u'\n\n'
+ for submsglines in submsgs:
+ msgstr += ' - ' + unicode(' '.join(l.strip() for l in submsglines), encoding)
+ msgstr += u'\n'
+ messages.append(msgstr)
+ entry = (date, messages)
+ allentries.insert(bisect_right(allentries, entry), entry)
+ latestdate = None
+ i = 0
+ for date, messages in reversed(allentries):
+ if latestdate != date:
+ fdate = self.format_date(date)
+ w(u'\n%s' % fdate)
+ w('~'*len(fdate))
+ latestdate = date
+ for msg in messages:
+ w(u'* %s' % msg)
+ i += 1
+ if i > self.maxentries:
+ break
+ w('') # blank line
+ self.w(rest_publish(self, '\n'.join(restdata)))
+