1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
# docutils.py
# This module contains all kinds of utility functions that can be used
# throughout Doc-Central.
# Import all system packages we need
import os, string, sys, cgi, re, urllib
# Import all our own packages
import docinfo, docconfig
# Some globals that are used throughout doc-central
documents = []
sections = []
def processdir(dir):
'''Read all doc-base entries in a directory and update the globals
documents and sections to reflect this.'''
try:
for entry in os.listdir(dir):
if os.path.isfile(dir+"/"+entry):
newdoc=docinfo.DocumentationInfo(dir+"/"+entry)
if not newdoc.section in sections:
sections.append(newdoc.section)
documents.append(newdoc)
except OSError, err:
pass
def processdirs(dirs=docconfig.docbasedirs):
'''Read all doc-base entries in a list of directories. If no list of
directories is given default to the globally defined list of directories'''
for dir in dirs:
processdir(dir)
def cleanupsections():
'''Clean up the sections global.
This means that we make sure that all intermediate sections are also
in the list, and that the list is sorter alphabetically.'''
for sect in sections:
lst=string.split(sect,'/')
subsect=lst[0]
while len(lst)>1:
if not subsect in sections:
sections.append(subsect)
del lst[0]
subsect=subsect+"/"+lst[0]
sections.sort()
def sectiondepth(sect):
'''Calculate the depth of a section. The depth of the top level
is defined as 0'''
if (len(sect)):
return string.count(sect, "/")+1
else:
return 0
def stripsection(sect, count=1, start=0):
"Strip a number of sections from either the front or back of a section-index."
if start==0:
for i in range(count):
sect=sect[string.find(sect,"/")+1:]
else:
for i in range(count):
j=string.rfind(sect,"/")
if j==-1:
sect=""
else:
sect=sect[0:string.rfind(sect,"/")]
return sect
def makesectionlink(sect):
'''Create a URL to the section-index. We assume that the current
script is already the browser'''
# Note: the function is never called since it's overriden at the bottom
if os.environ.has_key("SCRIPT_NAME"):
base=os.environ["SCRIPT_NAME"]
else:
base="browse.cgi"
return base+"?section="+urllib.quote(sect)
def makedoclink(doc, format=None):
'''Create a URL to a specific document. If the document is available in
multiple formats you can specify the format manually, or otherwise we
will use the first format from the globally defined FormatList that is
available'''
if not len(doc.docs):
return ''
if not format:
for frm in docconfig.FormatOrder:
if doc.docs.has_key(frm):
format=frm
break
if not format:
format = doc.docs.keys()[0]
if format == "info":
m = re.match("/usr(/share)?/info/(.+)\.info", doc.docs[format])
if m:
return "/cgi-bin/info2www?(%s)" % m.group(2)
else:
return None
else:
return doc.docs[format].replace ('/usr/share/doc/', '/doc/')
def checkextralink(package, filename):
'''Check if documentation file "filename" exists and return a full
link to it. Only intended to be called by makeextralinks'''
docpath = '/usr/share/doc/' + package.lower() + '/' + filename
if os.path.isfile(docpath):
return '<A HREF="%s">%s</A>, ' % (docpath[10:], filename)
else:
return ''
def makeextralinks(package):
'''Check for existance of changelog, README, NEWS (also .Debian
and gzipped equivalents) on /usr/share/doc/package through
checkextralink and return the links to all of them'''
buf = ""
files = ['changelog', 'NEWS', 'README']
for filename in files:
buf = buf + checkextralink(package, filename)
buf = buf + checkextralink(package, filename+'.gz')
buf = buf + checkextralink(package, filename+'.Debian')
buf = buf + checkextralink(package, filename+'.Debian.gz')
return buf[:-2]
def makedoclinks(doc):
'''Build a HTML-string with a list of URLs too all available versions
of a document.'''
buf=""
count=0
for frm in docconfig.FormatOrder:
if doc.docs.has_key(frm):
buf=buf + '<A HREF="%s">[%s]</A>' % (makedoclink(doc,frm),frm)
count=count+1
if count>1:
return buf
else:
return ""
def extractcookies(prefix="doc-central_"):
'''Extract all http cookies that the browser passed to use and
merge them in docconfig.Options.'''
if os.environ.has_key("HTTP_COOKIE"):
for cookie in string.split(os.environ.get("HTTP_COOKIE", ''),';'):
(key,value)=string.split(string.strip(cookie),"=",2)
m=re.match("%s(.*)", key)
docconfig.Options[key]=value
def extractcgiparams():
'''Extract all CGI parameters that the browser passed to use and
merge them in docconfig.Options.'''
form=cgi.FieldStorage()
for frm in form.keys():
docconfig.Options[frm]=form[frm].value
def scriptname(script):
'''Return a link to another script in the same directory.'''
if os.environ.has_key("SCRIPT_NAME"):
base=os.path.dirname(os.environ["SCRIPT_NAME"])+"/"
else:
base=""
return base+script
def makesectionlink(sect):
'''Turn a section-name into an URL to the right section-page using
browse.cgi'''
return scriptname("browse.cgi") + "?section=%s" % urllib.quote(sect)
|
