Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

198 lines (157 sloc) 5.926 kb
# -*- coding: utf-8 -*-
#
# Cherokee-admin
#
# Authors:
# Taher Shihadeh <taher@octality.com>
# Alvaro Lopez Ortega <alvaro@alobbs.com>
#
# Copyright (C) 2010 Alvaro Lopez Ortega
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of version 2 of the GNU General Public
# License as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
import re
import os
import CTK
import Page
import configured
from CTK.consts import *
URL_BASE = '/help'
TOC_TITLE = N_('Table of Contents')
BODY_REGEX = r'.*<div class="sectionbody">(.+?)</div>\s*<div id="footer">'
LINK_REGEX = r'<a href="(.+?)">(.+?)</a>' #link, title
class Parser:
"""Simple documentation parser"""
def __init__ (self, filename):
self.filename = filename
self.sections = None
filepath = os.path.join (configured.DOCDIR, filename)
self.html = open(filepath).read()
# Extract the body
self.body_raw = self._parse (BODY_REGEX, self.html)[0]
self.body = self.body_raw.replace ('%', '%%')
def get_header (self):
# Find the header preceding the body
p = self.html.find (self.body_raw)
h1 = self.html.rfind ('<h2', 0, p)
h2 = self.html.rfind ('</h2>', 0, p) + 5
return self.html[h1:h2]
def _parse (self, regex, txt):
return re.findall (regex, txt, re.DOTALL)
def get_sections (self):
if self.sections:
return self.sections
self._build_tree()
self.sections = self._build_section (self.filename, _(TOC_TITLE))
return self.sections
def _build_section (self, link, text):
"""
entry = { 'link': link, 'text': title, 'children': [entry ...]}
"""
entry = { 'link': link, 'text': text }
children = []
childlinks = self.tree.get(link)
if childlinks:
for lnk,txt in self.links:
if lnk in childlinks:
children.append (self._build_section (lnk, txt))
entry['children'] = children
return entry
def _build_tree (self):
def branch_sorter (x, y):
return len(y) - len(x)
def is_covered (val):
for key,vals in self.tree.items():
if val in vals:
return True
return False
def tree_len ():
tmp = []
for vals in self.tree.values():
tmp.extend(vals)
return len(tmp)
self.links = self._parse (LINK_REGEX, self.body)
self.files = [x[0] for x in self.links]
self.tree = {'index.html': [f for f in self.files if len(f.split('_'))==1]}
delta = 1
while tree_len() < len(self.links):
mess = [(f, f.split('.html')[0].split('_')) for f in
self.files if not is_covered(f)]
mess.sort (branch_sorter)
self._build_helper (mess, delta)
delta += 1
def _build_helper (self, mess, delta):
for elem in mess:
x = elem[1]
name, idx = None, len(x)-delta
if idx >= 0:
name = '%s.html' %('_'.join(x[:idx]))
if name in self.files:
self.tree[name] = self.tree.get(name, [])
childname = '%s.html' %('_'.join(x))
self.tree[name].append(childname)
class IndexBox (CTK.Box):
def __init__ (self, link, **kwargs):
CTK.Box.__init__ (self, {'class': 'help_toc'}, **kwargs)
self.link = link
parser = Parser ('index.html')
self.sections = parser.get_sections()
# Widget content (the index)
self += self._process_entry (self.sections)
def _process_entry (self, entry):
props = {}
if entry['link'] == self.link:
props['class'] = 'help_selected'
block = CTK.Box (props)
block += CTK.RawHTML (LINK_HREF %(entry['link'],entry['text']))
spawn = entry.get('children')
if spawn:
children = CTK.Container()
for child in spawn:
children += self._process_entry (child)
block += CTK.Indenter (children)
return block
class HelpBox (CTK.Box):
def __init__ (self, filename):
CTK.Box.__init__ (self, {'class': 'help_content'})
parser = Parser (filename)
header = parser.get_header()
self += CTK.RawHTML (header)
self += CTK.RawHTML (parser.body)
class Page (CTK.Page):
def __init__ (self):
# Look for the theme file
srcdir = os.path.dirname (os.path.realpath (__file__))
theme_file = os.path.join (srcdir, 'help.html')
# Set up the template
template = CTK.Template (filename = theme_file)
template['title'] = _("Documentation")
template['body_props'] = ' id="body-help"'
# headers
headers = ['<link rel="stylesheet" type="text/css" href="/static/css/cherokee-admin.css" />']
# Parent's constructor
CTK.Page.__init__ (self, template, headers)
class Render:
def __call__ (self):
# Content
filename = CTK.request.url.split('/')[-1]
left = IndexBox(filename)
right = HelpBox (filename)
# Build the page
page = Page ()
page += left
page += right
return page.Render()
CTK.publish ('^%s/.+\.html'%(URL_BASE), Render)
Jump to Line
Something went wrong with that request. Please try again.