Traceback on About page when htdocs directory does not exist

[Ryan J Ollos]

This is a regression from #11548. The following traceback is seen:

File "/srv/trac-hacks.org/pve/lib/python2.6/site-packages/Trac-1.0.3-py2.6.egg/trac/web/main.py", line 513, in _dispatch_request
  dispatcher.dispatch(req)
File "/srv/trac-hacks.org/pve/lib/python2.6/site-packages/Trac-1.0.3-py2.6.egg/trac/web/main.py", line 222, in dispatch
  resp = chosen_handler.process_request(req)
File "/srv/trac-hacks.org/pve/lib/python2.6/site-packages/Trac-1.0.3-py2.6.egg/trac/about.py", line 75, in process_request
  Chrome(self.env).get_interface_customization_files()
File "/srv/trac-hacks.org/pve/lib/python2.6/site-packages/Trac-1.0.3-py2.6.egg/trac/web/chrome.py", line 1132, in get_interface_customization_files
  site_htdocs = sorted(os.listdir(self.env.get_htdocs_dir()))

I need to look more closely at the code, but it appears to result when [trac] htdocs_location is empty or not defined. On trac-hacks.org we have:

[trac]
htdocs_location = 

It appears this is because the webserver is configured to serve these files:

Alias   /chrome/common  /srv/trac-hacks.org/www/htdocs/common
Alias   /chrome/site    /srv/trac-hacks.org/www/htdocs/site

Please correct me if I'm assuming wrong.

The workaround is to simply create the missing htdocs directory.

[Jun Omae]

Replying to rjollos:

I need to look more closely at the code, but it appears to result when [trac] htdocs_location is empty or not define. On trac-hacks.org we have:

Not a defect. Environment.get_htdocs_dir() is to retrieve $ENV/htdocs directory as site htdocs. The directory is created when environment is created at the same time. It generally isn't deleted.

However, we could make it robust.

trac/web/chrome.py

@@ -1117 +1117 @@
         """Returns a dictionary containing the lists of files present in the
         site and shared templates and htdocs directories.
         """
+        def listdir(path, suffix=None):
+            if not os.path.isdir(path):
+                return []
+            return sorted(name for name in os.listdir(path)
+                               if suffix is None or name.endswith(suffix))
+
         files = {}
         # Collect templates list
-        site_templates = sorted(os.listdir(self.env.get_templates_dir()))
-        site_templates = [t for t in site_templates
-                            if t.endswith('.html')]
-        shared_templates = []
-        shared_templates_dir = Chrome(self.env).shared_templates_dir
-        if os.path.exists(shared_templates_dir):
-            shared_templates = sorted(os.listdir(shared_templates_dir))
-            shared_templates = [t for t in shared_templates
-                                  if t.endswith('.html')]
+        site_templates = listdir(self.env.get_templates_dir(), '.html')
+        shared_templates = listdir(Chrome(self.env).shared_templates_dir,
+                                   '.html')
         # Collect static resources list
-        site_htdocs = sorted(os.listdir(self.env.get_htdocs_dir()))
-        shared_htdocs = []
-        shared_htdocs_dir = Chrome(self.env).shared_htdocs_dir
-        if os.path.exists(shared_htdocs_dir):
-            shared_htdocs = sorted(os.listdir(shared_htdocs_dir))
+        site_htdocs = listdir(self.env.get_htdocs_dir())
+        shared_htdocs = listdir(Chrome(self.env).shared_htdocs_dir)
+
         if any((site_templates, shared_templates, site_htdocs, shared_htdocs)):
             files = {
                 'site-templates': site_templates,

[Ryan J Ollos]

Thanks for the patch. Committed to 1.0-stable in [13709], merged to trunk in [13710].