Attachment 'VisualSiteMap_1.3.py'

Download

   1 """
   2     MoinMoin - VisualSiteMap action
   3 
   4     Idea is based on the webdot.py action.
   5     
   6     More or less redid it from scratch. Differs from the webdot action in several ways:
   7     * Uses the dot executable, not webdot, since webdot is not available on windows.
   8     * All links up to the search depth are displayed.
   9     * There's no maximal limit to the displayed nodes.
  10     * Nodes are marked during depth first visit, so each node is visited only once.
  11     * The visit method in class LocalSiteMap gets the whole tree as parameter.
  12       That way additional treenode information may be shown in the graph.
  13     * All edges between nodes contained in the graph are displayed, even if MAX_DEPTH is exceeded that way.
  14     * Optional depth controls
  15     * Nodes linked more then STRONG_LINK_NR times are highlighted using the STRONG_COLOR.
  16     * Search depth is configurable.
  17     
  18     Add this to your stylesheet:
  19     img.sitemap
  20     {
  21       border-width: 1;
  22       border-color: #000000;
  23     }
  24 
  25     07.10.2004
  26     * Maximum image size can be configured
  27     * Output image format is configurable
  28     * David Linke changed the output code (print() -> request.write())
  29     * Changed link counting algorithm to get the depth controls right.
  30 
  31     08.10.2004
  32     * IE caching problem with depth controls resolved. Now the current search depth is part of the file names.
  33     * Problems with pagenames containing non ASCII characters fixed.
  34     
  35     14.03.2005
  36     * cleanup & adapted to moin 1.3.4 -- ThomasWaldmann
  37     * Fixed for utf-8 and sub pages
  38 
  39     16.3.2005
  40     * included patch from David Linke for Windows compatibility
  41     * FONTNAME and FONTSIZE
  42     * removed invalid print debug statements
  43     * use config.charset
  44     
  45 """
  46 
  47 ##################################################################
  48 # Be warned that calculating large graphs may block your server! #   
  49 # So be careful with the parameter settings.                     #
  50 ##################################################################
  51 
  52 # This should be a public path on your web server. The dot files, images and map files are created in this directory and
  53 # served from there.
  54 #CACHE_DIR  = "C:/DocumentRoot/cache"
  55 #CACHE_URL  = "http://my-server/cache"
  56 CACHE_DIR  = "/org/de.wikiwikiweb.moinmaster/htdocs/cache"
  57 CACHE_URL  = "http://moinmaster.wikiwikiweb.de/wiki/cache"
  58 
  59 # Absolute location of the dot (or neato) executable.
  60 #DOT_EXE    = "C:/Programme/ATT/GraphViz/bin/dot.exe"
  61 #DOT_EXE    = "/usr/bin/dot"
  62 DOT_EXE    = "/usr/bin/neato"
  63 
  64 # Categories are filtered in some way.
  65 CATEGORY_STRING = "^Kategorie"
  66 
  67 # Graph controls.
  68 DEFAULT_DEPTH = 2
  69 STRONG_LINK_NR = 4
  70 
  71 # Optional controls for interactive modification of the search depth.
  72 DEPTH_CONTROL = False
  73 MAX_DEPTH  = 4
  74 
  75 # Desired image format (eg. png, jpg, gif - see the dot documentation)
  76 OUTPUT_FORMAT = "png"
  77 
  78 # Maximum output size in inches. Set to None to disable size limitation,
  79 # then the graph is made as big as needed (best for readability).
  80 # OUTPUT_SIZE="8,12" sets maximum width to 8, maximum height to 12 inches.
  81 OUTPUT_SIZE = None
  82 
  83 # Name and Size of the font use
  84 # Times, Helvetica, Courier, Symbol are supported on any platform.
  85 # Others may NOT be supported.
  86 # When selecting a font, make sure it support unicode chars (at least the
  87 # ones you use, e.g. german umlauts or french accented chars).
  88 FONTNAME = "Times"
  89 FONTSIZE = "10"
  90 
  91 # Colors of boxes and edges.
  92 BOX_COLOR = "#E0F0FF"
  93 ROOT_COLOR = "#FFE0E0"
  94 STRONG_COLOR = "#E0FFE0"
  95 EDGE_COLOR = "#888888"
  96 
  97 import re, os
  98 from MoinMoin import config, wikiutil
  99 from MoinMoin.Page import Page
 100 
 101 class LocalSiteMap:
 102     def __init__(self, name, maxdepth):
 103         self.name = name
 104         self.maxdepth = maxdepth
 105         self.result = []
 106 
 107     def output(self, request):
 108         pagebuilder = GraphBuilder(request, self.maxdepth)
 109         root = pagebuilder.build_graph(self.name)
 110         # count links
 111         for edge in pagebuilder.all_edges:
 112             edge[0].linkedfrom += 1
 113             edge[1].linkedto += 1
 114         # write nodes
 115         for node in pagebuilder.all_nodes:
 116             self.append('  "%s"'% node.name)
 117             if node.depth > 0:
 118                 if node.linkedto >= STRONG_LINK_NR:
 119                     self.append('  [label="%s",color="%s"];\n' % (node.name, STRONG_COLOR))
 120                 else:
 121                     self.append('  [label="%s"];\n' % (node.name))
 122             else:
 123                 self.append('[label="%s",shape=box,style=filled,color="%s"];\n' % (node.name, ROOT_COLOR))
 124         # write edges
 125         for edge in pagebuilder.all_edges:
 126             self.append('  "%s"->"%s";\n' % (edge[0].name, edge[1].name))
 127             
 128         return ''.join(self.result)
 129 
 130     def append(self, text):
 131         self.result.append(text)
 132 
 133 
 134 class GraphBuilder:
 135     def __init__(self, request, maxdepth):
 136         self.request = request
 137         self.maxdepth = maxdepth
 138         self.all_nodes = []
 139         self.all_edges = []
 140         
 141     def is_ok(self, child):
 142         if not self.request.user.may.read(child):
 143             return 0
 144         if Page(self.request, child).exists() and not re.search(r'%s' % CATEGORY_STRING, child):
 145             return 1
 146         return 0
 147 
 148     def build_graph(self, name):
 149         # Reuse generated trees
 150         nodesMap = {}
 151         root = Node(name)
 152         nodesMap[name] = root
 153         root.visited = 1
 154         self.all_nodes.append(root)
 155         self.recurse_build([root], 1, nodesMap)
 156         return root
 157 
 158     def recurse_build(self, nodes, depth, nodesMap):
 159         # collect all nodes of the current search depth here for the next recursion step
 160         child_nodes = []
 161         # iterate over the nodes
 162         for node in nodes:
 163             for child in Page(self.request, node.name).getPageLinks(self.request):            
 164                 if self.is_ok(child):
 165                     # Create the node with the given name
 166                     if not nodesMap.has_key(child):
 167                         # create the new node and store it
 168                         newNode = Node(child)
 169                         newNode.depth = depth
 170                     else:
 171                         newNode = nodesMap[child]
 172                     # If the current depth doesn't exceed the maximum depth, add newNode to recursion step
 173                     if depth <= self.maxdepth:
 174                         # The node is appended to the nodes list for the next recursion step.
 175                         nodesMap[child] = newNode
 176                         self.all_nodes.append(newNode)
 177                         child_nodes.append(newNode)
 178                         node.append(newNode)
 179                         # Draw an edge.
 180                         edge = (node, newNode)
 181                         if not edge in self.all_edges:
 182                             self.all_edges.append(edge)
 183         # recurse, if the current recursion step yields children
 184         if len(child_nodes):
 185             self.recurse_build(child_nodes, depth+1, nodesMap)
 186 
 187 class Node:
 188     def __init__(self, name):
 189         self.name = name
 190         self.children = []
 191         self.visited = 0
 192         self.linkedfrom = 0
 193         self.linkedto = 0
 194         self.depth = 0
 195         
 196     def append(self, node):
 197         self.children.append(node)
 198 
 199 def execute(pagename, request):
 200     _ = request.getText
 201     
 202     maxdepth = DEFAULT_DEPTH
 203     if DEPTH_CONTROL and request.form.has_key('depth'):
 204         maxdepth = int(request.form['depth'][0])
 205     
 206     if maxdepth > MAX_DEPTH:
 207         maxdepth = MAX_DEPTH
 208       
 209     request.http_headers()
 210     wikiutil.send_title(request, _('Visual Map of %s') % pagename, pagename=pagename)
 211 
 212     baseurl = request.getBaseURL()
 213 
 214     wikinamefs = wikiutil.quoteWikinameFS(pagename)
 215     wikinameurl = wikiutil.quoteWikinameURL(pagename)
 216     fnprefix = os.path.join(CACHE_DIR, '%s_%s' % (wikinamefs, maxdepth))
 217     dotfilename = '%s.%s' % (fnprefix, 'dot')
 218     imagefilename = '%s.%s' % (fnprefix, OUTPUT_FORMAT)
 219     mapfilename = '%s.%s' % (fnprefix, 'cmap')
 220     imageurl = '%s/%s_%s.%s' % (CACHE_URL, wikinameurl, maxdepth, OUTPUT_FORMAT)
 221 
 222     lsm = LocalSiteMap(pagename, maxdepth).output(request).encode(config.charset)
 223     
 224     dotfile = file(dotfilename, 'w')
 225     dotfile.write('digraph G {\n')
 226     if OUTPUT_SIZE:
 227         dotfile.write('  size="%s"\n' % OUTPUT_SIZE)
 228         dotfile.write('  ratio=compress;\n')
 229     dotfile.write('  URL="%s";\n' % wikinameurl)
 230     dotfile.write('  overlap=false;\n')
 231     dotfile.write('  concentrate=true;\n')
 232     dotfile.write('  edge [color="%s"];\n' % EDGE_COLOR)
 233     dotfile.write('  node [URL="%s/\N", ' % baseurl)
 234     dotfile.write('fontcolor=black, fontname="%s", fontsize=%s, style=filled, color="%s"]\n' % (FONTNAME, FONTSIZE, BOX_COLOR))
 235     dotfile.write(lsm)
 236     dotfile.write('}\n')
 237     dotfile.close()
 238     
 239     os.system('%s -T%s -o"%s" "%s"' % (DOT_EXE, OUTPUT_FORMAT, imagefilename, dotfilename))
 240     os.system('%s -Tcmap -o"%s" "%s"' % (DOT_EXE, mapfilename, dotfilename))
 241    
 242     request.write('<center><img class="sitemap" border="1" src="%s" usemap="#map1"></center>' % (imageurl,))
 243     request.write('<map name="map1">')
 244     mapfile = file(mapfilename, 'r')
 245     for row in mapfile:
 246         request.write(row)
 247     mapfile.close()
 248     request.write('</map>')
 249     
 250     if DEPTH_CONTROL:
 251         linkname = wikiutil.quoteWikinameURL(pagename)
 252         request.write('<p align="center">')
 253         if maxdepth > 1:
 254             request.write('<a href="%s/%s?action=VisualSiteMap&depth=%s">Less</a>' % (baseurl, linkname, maxdepth-1))
 255         else:
 256             request.write('Less')
 257         request.write(' | ')
 258 
 259         if maxdepth < MAX_DEPTH:
 260             request.write('<a href="%s/%s?action=VisualSiteMap&depth=%s">More</a>' % (baseurl, linkname, maxdepth+1))
 261         else:
 262             request.write('More')
 263         request.write('</p>')
 264       
 265     request.write('<p align="center"><small>Search depth is %s. Nodes linked more than %s times are highlighted.</small></p>' % (maxdepth, STRONG_LINK_NR))
 266 
 267     wikiutil.send_footer(request, pagename)

Attached Files

To refer to attachments on a page, use attachment:filename, as shown below in the list of files. Do NOT use the URL of the [get] link, since this is subject to change and can break easily.
  • [get | view] (2011-04-14 07:28:03, 4.7 KB) [[attachment:CreateNewPage.py]]
  • [get | view] (2011-04-14 07:26:24, 4.2 KB) [[attachment:CreateNewPage1.6.py]]
  • [get | view] (2006-09-10 21:29:29, 40.4 KB) [[attachment:CreatePdfDocument2_0_3.py]]
  • [get | view] (2006-09-12 06:05:06, 40.5 KB) [[attachment:CreatePdfDocument2_0_4.py]]
  • [get | view] (2006-09-12 12:00:09, 40.6 KB) [[attachment:CreatePdfDocument2_0_5.py]]
  • [get | view] (2006-11-14 21:56:11, 43.5 KB) [[attachment:CreatePdfDocument2_0_6.py]]
  • [get | view] (2006-11-15 17:00:47, 43.8 KB) [[attachment:CreatePdfDocument2_0_7.py]]
  • [get | view] (2006-11-16 22:06:18, 43.8 KB) [[attachment:CreatePdfDocument2_0_8.py]]
  • [get | view] (2006-12-17 15:54:21, 43.6 KB) [[attachment:CreatePdfDocument2_0_9.py]]
  • [get | view] (2007-08-20 09:10:23, 67.2 KB) [[attachment:CreatePdfDocument2_1_0.py]]
  • [get | view] (2007-08-21 07:39:49, 67.1 KB) [[attachment:CreatePdfDocument2_1_1.py]]
  • [get | view] (2007-09-11 19:16:37, 67.3 KB) [[attachment:CreatePdfDocument2_1_2.py]]
  • [get | view] (2007-09-18 20:17:58, 68.1 KB) [[attachment:CreatePdfDocument2_1_3.py]]
  • [get | view] (2007-09-21 13:32:54, 71.1 KB) [[attachment:CreatePdfDocument2_1_4.py]]
  • [get | view] (2007-09-23 20:56:30, 73.4 KB) [[attachment:CreatePdfDocument2_1_5.py]]
  • [get | view] (2007-09-25 20:54:48, 74.5 KB) [[attachment:CreatePdfDocument2_2_0.py]]
  • [get | view] (2008-06-23 21:08:49, 77.0 KB) [[attachment:CreatePdfDocument2_3_0.py]]
  • [get | view] (2008-06-26 19:25:07, 81.0 KB) [[attachment:CreatePdfDocument2_3_1.py]]
  • [get | view] (2008-07-06 05:50:38, 83.1 KB) [[attachment:CreatePdfDocument2_3_2.py]]
  • [get | view] (2008-07-09 17:42:02, 83.3 KB) [[attachment:CreatePdfDocument2_3_3.py]]
  • [get | view] (2008-09-07 11:11:01, 83.5 KB) [[attachment:CreatePdfDocument2_3_4.py]]
  • [get | view] (2009-01-11 15:53:09, 84.3 KB) [[attachment:CreatePdfDocument2_3_5.py]]
  • [get | view] (2009-02-16 06:52:06, 84.2 KB) [[attachment:CreatePdfDocument2_3_6.py]]
  • [get | view] (2010-01-29 11:53:21, 82.8 KB) [[attachment:CreatePdfDocument2_4_0.py]]
  • [get | view] (2010-01-31 14:10:03, 84.6 KB) [[attachment:CreatePdfDocument2_4_1.py]]
  • [get | view] (2010-09-18 16:23:23, 85.6 KB) [[attachment:CreatePdfDocument2_4_2.py]]
  • [get | view] (2006-06-16 20:56:53, 4.9 KB) [[attachment:FlashManager.py-1.5.3-1]]
  • [get | view] (2003-12-07 18:15:53, 3.9 KB) [[attachment:HTML2MoinMoin.py]]
  • [get | view] (2005-10-16 08:24:35, 4.9 KB) [[attachment:HelpOn-1.3.5-4.py]]
  • [get | view] (2006-02-03 19:21:04, 4.9 KB) [[attachment:HelpOn-1.5.1-5.py]]
  • [get | view] (2006-07-04 10:45:22, 4.8 KB) [[attachment:HelpOn-1.5.4-6.py]]
  • [get | view] (2006-07-04 22:39:14, 4.8 KB) [[attachment:HelpOn-1.6.0-7.py]]
  • [get | view] (2006-07-06 13:50:17, 4.0 KB) [[attachment:HelpOn-1.6.0-8.py]]
  • [get | view] (2008-01-10 17:43:24, 4.8 KB) [[attachment:HelpOn-1.6.0-9.py]]
  • [get | view] (2008-08-19 14:44:54, 5.0 KB) [[attachment:HelpOn-1.7.1-10.py]]
  • [get | view] (2005-02-20 18:28:34, 10.8 KB) [[attachment:IRSS.py]]
  • [get | view] (2005-03-09 22:46:23, 2.9 KB) [[attachment:ImportHtml-1.2.py]]
  • [get | view] (2003-12-07 18:15:53, 2.8 KB) [[attachment:ImportHtml.py]]
  • [get | view] (2003-12-07 18:15:53, 1.8 KB) [[attachment:IrcChat.py]]
  • [get | view] (2008-06-09 11:27:20, 4.4 KB) [[attachment:MoinCrypt.py]]
  • [get | view] (2010-11-29 12:08:27, 7.5 KB) [[attachment:PageActions.py]]
  • [get | view] (2006-08-07 15:12:19, 0.5 KB) [[attachment:PermanentLink.py]]
  • [get | view] (2003-12-07 18:15:53, 6.3 KB) [[attachment:PhoneDial.py]]
  • [get | view] (2005-04-17 14:21:47, 3.6 KB) [[attachment:RecommendPage-1.3.4-1.py]]
  • [get | view] (2005-04-19 18:21:52, 5.5 KB) [[attachment:RecommendPage-1.3.4-2.py]]
  • [get | view] (2005-05-02 19:53:09, 5.6 KB) [[attachment:RecommendPage-1.3.4-3.py]]
  • [get | view] (2005-09-03 07:33:35, 6.3 KB) [[attachment:RecommendPage-1.3.4-4.py]]
  • [get | view] (2005-09-05 17:44:03, 6.9 KB) [[attachment:RecommendPage-1.3.5-5.py]]
  • [get | view] (2005-09-07 16:42:26, 7.5 KB) [[attachment:RecommendPage-1.3.5-6.py]]
  • [get | view] (2005-09-08 16:06:28, 7.7 KB) [[attachment:RecommendPage-1.3.5-7.py]]
  • [get | view] (2005-11-01 11:31:51, 9.0 KB) [[attachment:RecommendPage-1.3.5-8.py]]
  • [get | view] (2006-02-03 19:40:51, 8.3 KB) [[attachment:RecommendPage-1.5.1-9.py]]
  • [get | view] (2008-01-11 09:14:35, 6.8 KB) [[attachment:RecommendPage-1.6.0-10.py]]
  • [get | view] (2008-08-19 14:44:59, 6.9 KB) [[attachment:RecommendPage-1.7.1-11.py]]
  • [get | view] (2008-06-09 11:27:40, 1.7 KB) [[attachment:ShowActions.py]]
  • [get | view] (2008-06-09 10:34:02, 5.3 KB) [[attachment:ShowDecrypted.py]]
  • [get | view] (2005-03-30 21:17:28, 7.7 KB) [[attachment:Slideshow.py]]
  • [get | view] (2004-02-02 20:48:31, 2.0 KB) [[attachment:SubscribeUser.py]]
  • [get | view] (2007-01-26 17:08:30, 2.2 KB) [[attachment:Subscribers-1.6.0.py]]
  • [get | view] (2003-12-07 18:15:53, 1.8 KB) [[attachment:Subscribers.py]]
  • [get | view] (2006-03-18 23:16:51, 0.8 KB) [[attachment:UserPreferences.py]]
  • [get | view] (2004-01-05 09:56:25, 8.1 KB) [[attachment:VisualSiteMap.py]]
  • [get | view] (2015-08-30 21:04:23, 11.1 KB) [[attachment:VisualSiteMap_1.10.py]]
  • [get | view] (2004-10-08 10:59:16, 9.3 KB) [[attachment:VisualSiteMap_1.2.py]]
  • [get | view] (2005-03-16 01:30:09, 9.8 KB) [[attachment:VisualSiteMap_1.3.py]]
  • [get | view] (2014-08-19 01:34:10, 10.8 KB) [[attachment:VisualSiteMap_1.9.py]]
  • [get | view] (2007-08-18 18:52:55, 1.0 KB) [[attachment:backlink.py]]
  • [get | view] (2007-03-15 05:53:49, 23.5 KB) [[attachment:findandreplace0.1Beta.py]]
  • [get | view] (2005-03-27 20:32:10, 3.6 KB) [[attachment:gallery2image-1.3.3-1.py]]
  • [get | view] (2005-08-03 20:14:56, 4.0 KB) [[attachment:gallery2image-1.3.3-2.py]]
  • [get | view] (2005-11-13 18:10:26, 20.7 KB) [[attachment:gallery2image-1.3.5-10.py]]
  • [get | view] (2005-11-25 22:03:50, 20.8 KB) [[attachment:gallery2image-1.3.5-11.py]]
  • [get | view] (2005-08-08 17:23:43, 8.4 KB) [[attachment:gallery2image-1.3.5-4.py]]
  • [get | view] (2005-08-13 15:15:45, 13.7 KB) [[attachment:gallery2image-1.3.5-5.py]]
  • [get | view] (2005-08-31 22:05:22, 15.5 KB) [[attachment:gallery2image-1.3.5-6.py]]
  • [get | view] (2005-10-29 20:23:50, 15.9 KB) [[attachment:gallery2image-1.3.5-8.py]]
  • [get | view] (2005-11-01 11:31:24, 17.6 KB) [[attachment:gallery2image-1.3.5-9.py]]
  • [get | view] (2006-01-27 20:52:32, 20.9 KB) [[attachment:gallery2image-1.5.1-12.py]]
  • [get | view] (2006-08-06 09:01:01, 22.1 KB) [[attachment:gallery2image-1.5.4-13.py]]
  • [get | view] (2006-08-11 18:21:40, 22.2 KB) [[attachment:gallery2image-1.5.4-14.py]]
  • [get | view] (2006-11-16 20:23:27, 22.6 KB) [[attachment:gallery2image-1.5.6-16.py]]
  • [get | view] (2006-08-11 18:30:22, 22.2 KB) [[attachment:gallery2image-1.6.0-15.py]]
  • [get | view] (2008-02-06 10:13:45, 22.3 KB) [[attachment:gallery2image-1.6.0-16.py]]
  • [get | view] (2008-05-20 15:51:09, 22.4 KB) [[attachment:gallery2image-1.6.3-17.py]]
  • [get | view] (2006-09-06 06:19:48, 1.3 KB) [[attachment:getmmap.py]]
  • [get | view] (2004-07-18 09:48:00, 1.5 KB) [[attachment:localnames.py]]
  • [get | view] (2005-03-25 15:02:31, 2.6 KB) [[attachment:newpageonly.py]]
  • [get | view] (2005-03-30 09:02:00, 3.5 KB) [[attachment:newpageonly_20050330.py]]
  • [get | view] (2006-06-06 19:12:27, 9.7 KB) [[attachment:pdf.py]]
  • [get | view] (2006-08-30 10:51:51, 36.0 KB) [[attachment:pdf2_0_0.py]]
  • [get | view] (2006-08-30 13:57:36, 36.5 KB) [[attachment:pdf2_0_1.py]]
  • [get | view] (2006-02-04 04:25:29, 1.0 KB) [[attachment:sisterindex.py]]
  • [get | view] (2004-10-28 07:33:10, 0.7 KB) [[attachment:xml.py]]
 All files | Selected Files: delete move to page copy to page

You are not allowed to attach a file to this page.