annotate examples/trac/wiki-default/checkwiki.py @ 39:93b4dcbafd7b trunk

Copy Trac to main branch.
author cmlenz
date Mon, 03 Jul 2006 18:53:27 +0000
parents
children
rev   line source
39
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
1 #!/usr/bin/python
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
2 #
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
3 # Check/update default wiki pages from the Trac project website.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
4 #
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
5 # Note: This is a development tool used in Trac packaging/QA, not something
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
6 # particularly useful for end-users.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
7 #
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
8 # Author: Daniel Lundin <daniel@edgewall.com>
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
9
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
10 import httplib
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
11 import re
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
12 import sys
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
13 import getopt
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
14
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
15 # Pages to include in distribution
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
16 wiki_pages = [
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
17 "CamelCase",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
18 "InterMapTxt",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
19 "InterTrac",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
20 "InterWiki",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
21 "RecentChanges",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
22 "TitleIndex",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
23 "TracAccessibility",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
24 "TracAdmin",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
25 "TracBackup",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
26 "TracBrowser",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
27 "TracCgi",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
28 "TracChangeset",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
29 "TracEnvironment",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
30 "TracFastCgi",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
31 "TracGuide",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
32 "TracImport",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
33 "TracIni",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
34 "TracInstall",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
35 "TracInterfaceCustomization",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
36 "TracLinks",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
37 "TracLogging",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
38 "TracModPython",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
39 "TracNotification",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
40 "TracPermissions",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
41 "TracPlugins",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
42 "TracQuery",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
43 "TracReports",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
44 "TracRevisionLog",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
45 "TracRoadmap",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
46 "TracRss",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
47 "TracSearch",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
48 "TracStandalone",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
49 "TracSupport",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
50 "TracSyntaxColoring",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
51 "TracTickets",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
52 "TracTicketsCustomFields",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
53 "TracTimeline",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
54 "TracUnicode",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
55 "TracUpgrade",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
56 "TracWiki",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
57 "WikiDeletePage",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
58 "WikiFormatting",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
59 "WikiHtml",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
60 "WikiMacros",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
61 "WikiNewPage",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
62 "WikiPageNames",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
63 "WikiProcessors",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
64 "WikiRestructuredText",
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
65 "WikiRestructuredTextLinks"
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
66 ]
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
67
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
68 def get_page_from_file (pname):
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
69 d = ''
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
70 try:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
71 f = open(pname ,'r')
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
72 d = f.read()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
73 f.close()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
74 except:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
75 print "Missing page: %s" % pname
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
76 return d
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
77
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
78 def get_page_from_web (pname):
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
79 host = "projects.edgewall.com"
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
80 rfile = "/trac/wiki/%s?format=txt" % pname
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
81 c = httplib.HTTPConnection(host)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
82 c.request("GET", rfile)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
83 r = c.getresponse()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
84 d = r.read()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
85 if r.status != 200 or d == ("describe %s here\n" % pname):
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
86 c.close()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
87 print "Missing page: %s" % pname
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
88 c.close()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
89 f = open(pname, 'w+')
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
90 f.write(d)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
91 f.close()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
92 return d
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
93
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
94 def check_links (data):
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
95 def get_refs(t, refs=[]):
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
96 r = "(?P<wikilink>(^|(?<=[^A-Za-z]))[!]?[A-Z][a-z/]+(?:[A-Z][a-z/]+)+)"
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
97 m = re.search (r, t)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
98 if not m:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
99 refs.sort()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
100 result = []
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
101 orf = None
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
102 for rf in refs:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
103 if rf != orf:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
104 result.append(rf)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
105 orf = rf
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
106 return result
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
107 refs.append(m.group())
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
108 return get_refs( t[m.end():], refs)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
109 for p in data.keys():
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
110 links = get_refs(data[p], [])
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
111 for l in links:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
112 if l not in data.keys():
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
113 print "Broken link: %s -> %s" % (p, l)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
114
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
115 if __name__ == '__main__':
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
116 try:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
117 opts, args = getopt.getopt(sys.argv[1:], "ds")
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
118 except getopt.GetoptError:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
119 # print help information and exit:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
120 print "%s [-d]" % sys.argv[0]
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
121 print "\t-d -- Download pages from the main project wiki."
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
122 sys.exit()
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
123 get_page = get_page_from_file
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
124 for o,a in opts:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
125 if o == '-d':
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
126 get_page = get_page_from_web
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
127 data = {}
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
128 for p in wiki_pages:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
129 data[p] = get_page (p)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
130 check_links(data)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
131
Copyright (C) 2012-2017 Edgewall Software