Changeset 4366

Timestamp:

Oct 1, 2008, 10:47:15 PM (16 years ago)

Author:

osimons

Message:

TocMacro: Fixed a serious bug whereby the 0.11 version of the macro would keep a database connection open after execution.

This innocent-looking line...

self.formatter = formatter

... essentially attaches the transient formatter and its formatter.db connection to the instantiated plugin/component that lives for the lifetime of the environment (that in most setups gets cached for the duration of the process or until event like config change forces reload). Next time the macro executes it will free the old connection, and replace it with the new.

The problem continually ties up 1 connection of a process-wide default maximum number of 10. Many projects using the macro can get to the point where it locks the process due to no database connections being available - failing with TimeoutError. Particularly dangerous with embedded interpreter on Apache for Windows as it serves all requests using just a single process.

Code is changed to not persist the formatter, but instead pass it around as needed.

To all users of 0.11 version: Please upgrade!

File:

• tocmacro/0.11/tractoc/macro.py (modified) (4 diffs)

tocmacro/0.11/tractoc/macro.py

@@ -104 +104 @@
     
     def expand_macro(self, formatter, name, args):
-        self.formatter = formatter
-        self.context = formatter.context
-        self.resource = formatter.context.resource
+        context = formatter.context
+        resource = formatter.context.resource
         
         # Bail out if we are in a no-float zone
@@ -113 +112 @@
             return ''
         
-        current_page = self.resource.id
+        current_page = resource.id
          
         # Split the args
@@ -185 +184 @@
         active = len(pagenames) > 1
         for pagename in pagenames:
-            page_resource = self.resource(id=pagename)
-            if not 'WIKI_VIEW' in self.context.perm(page_resource):
+            page_resource = resource(id=pagename)
+            if not 'WIKI_VIEW' in context.perm(page_resource):
                 # Not access to the page, so should not be included
                 continue
             if 'title_index' in params:
-                self._render_title_index(ol, page_resource, active and \
-                            pagename == current_page,
+                self._render_title_index(formatter, ol, page_resource,
+                            active and pagename == current_page,
                             params['min_depth'] < 2)
             else:
-                self._render_page_outline(ol, page_resource, active, params)
+                self._render_page_outline(formatter, ol, page_resource,
+                                                        active, params)
         return base
 
-    def get_page_text(self, page_resource):
+    def get_page_text(self, formatter, page_resource):
         """Return a tuple of `(text, exists)` for the given page (resource)."""
-        if page_resource.id == self.resource.id:
-            return (self.formatter.source, True)
+        if page_resource.id == formatter.context.resource.id:
+            return (formatter.source, True)
         else:
             page = WikiPage(self.env, page_resource)
             return (page.text, page.exists)
 
-    def _render_title_index(self, ol, page_resource, active, show_title):
-        page_text, page_exists = self.get_page_text(page_resource)
+    def _render_title_index(self, formatter, ol, page_resource, active, show_title):
+        page_text, page_exists = self.get_page_text(formatter, page_resource)
         if not page_exists:
             ol.append(system_message('Error: No page matching %s found' %
                                      page_resource.id))
             return
-        ctx = self.context(page_resource)
+        ctx = formatter.context(page_resource)
         fmt = OutlineFormatter(self.env, ctx)
         fmt.format(page_text, NullOut())
@@ -222 +222 @@
                       class_= active and 'active' or None)))
 
-    def _render_page_outline(self, ol, page_resource, active, params):
+    def _render_page_outline(self, formatter, ol, page_resource, active, params):
         page = params.get('root', '') + page_resource.id
-        page_text, page_exists = self.get_page_text(page_resource)
+        page_text, page_exists = self.get_page_text(formatter, page_resource)
         if page_exists:
-            ctx = self.context(page_resource)
+            ctx = formatter.context(page_resource)
             fmt = OutlineFormatter(self.env, ctx)
             fmt.format(page_text, NullOut())
             outline_tree(self.env, ol, fmt.outline, ctx,
-                         active and page_resource.id == self.resource.id,
-                         params['min_depth'], params['max_depth'])
+                    active and page_resource.id == formatter.context.resource.id,
+                    params['min_depth'], params['max_depth'])
         else:
             ol.append(system_message('Error: Page %s does not exist' %