Add a config setting LogDir used for all log files

Also, allow specifying a different locations of the application config.

Author: Cito

.pylintrc

@@ -62,7 +62,7 @@ indent-after-paren = 4
 
 [DESIGN]
 
-max-attributes = 35
+max-attributes = 40
 max-args = 10
 max-branches = 40
 max-line-length = 79

docs/appdev.rst

@@ -281,7 +281,7 @@ Activity Log
 Three options let you control:
 
 * Whether or not to log activity (``LogActivity``, defaults to 0, i.e. off)
-* The name of the file to store the log (``ActivityLogFilename``, defaults to ``Logs/Activity.csv``)
+* The name of the file to store the log (``ActivityLogFilename``, defaults to ``Activity.csv``)
 * The fields to store in the log (``ActivityLogColumns``) </ul>
 
 See the chapter on :ref:`configuration` for more information.
@@ -314,7 +314,7 @@ The most common technique is the infamous ``print`` statement which has been rep
 
 For convenient debugging, the default ``Application.config`` file already uses the following conditional setting::
 
-    AppLogFilename = None if Development else 'Logs/Application.log'
+    AppLogFilename = None if Development else 'Application.log'
 
 This will prevent standard output and error from being redirected to the log file in development mode, which makes it easier to find debugging output, and also makes it possible to use ``pdb`` (see below).
 

docs/config.rst

@@ -158,7 +158,7 @@ Errors
 ``UserErrorMessage``:
     This is the error message that is displayed to the user when an uncaught exception escapes a servlet. Default: ``"The site is having technical difficulties with this page. An error has been logged, and the problem will be fixed as soon as possible. Sorry!"``
 ``ErrorLogFilename``:
-    The name of the file where exceptions are logged. Each entry contains the date and time, filename, pathname, exception name and data, and the HTML error message filename (assuming there is one). Default: ``Logs/Errors.csv``.
+    The name of the file where exceptions are logged. Each entry contains the date and time, filename, pathname, exception name and data, and the HTML error message filename (assuming there is one). Default: ``Errors.csv``.
 ``SaveErrorMessages``:
     If True, then errors (e.g., uncaught exceptions) will produce an HTML file with both the user message and debugging information. Developers/administrators can view these files after the fact, to see the details of what went wrong. These error messages can take a surprising amount of space. Default: ``True`` (do save).
 ``ErrorMessagesDir``:
@@ -209,11 +209,13 @@ Logging
 ``LogActivity``:
     If True, then the execution of each servlet is logged with useful information such as time, duration and whether or not an error occurred. Default: ``True``.
 ``ActivityLogFilenames``:
-    This is the name of the file that servlet executions are logged to. This setting has no effect if ``LogActivity`` is False. The path can be relative to the Webware location, or an absolute path. Default: ``"Logs/Activity.csv"``.
+    This is the name of the file that servlet executions are logged to. This setting has no effect if ``LogActivity`` is False. The path can be relative to the Webware location, or an absolute path. Default: ``"Activity.csv"``.
 ``ActivityLogColumns``:
     Specifies the columns that will be stored in the activity log. Each column can refer to an object from the set [application, transaction, request, response, servlet, session] and then refer to its attributes using "dot notation". The attributes can be methods or instance attributes and can be qualified arbitrarily deep. Default: ``['request.remoteAddress', 'request.method', 'request.uri', 'response.size', 'servlet.name', 'request.timeStamp', 'transaction.duration', 'transaction.errorOccurred']``.
 ``AppLogFilename``:
-    The Application redirects standard output and error to this file, if this is set in production mode. Default: ``'Logs/Application.log'``.
+    The Application redirects standard output and error to this file, if this is set in production mode. Default: ``'Application.log'``.
+```LogDir``:
+    The directory where log files should be stored. All log files without an explicit path will be put here.
 ``Verbose``:
     If True, then additional messages are printed while the Application runs, most notably information about each request such as size and response time. Default: ``True``.
 ``SilentURIs``:

webware/Admin/AdminPage.py

@@ -23,21 +23,21 @@ def writeAdminMenu(self):
         self.menuHeading('Admin')
         self.menuItem('Home', 'Main')
         self.menuItem(
-            'Activity log', 'Access', self.fileSize('ActivityLogFilename'))
+            'Activity log', 'Access', self.fileSize('ActivityLog'))
         self.menuItem(
-            'Error log', 'Errors', self.fileSize('ErrorLogFilename'))
+            'Error log', 'Errors', self.fileSize('ErrorLog'))
         self.menuItem('Config', 'Config')
         self.menuItem('Plug-ins', 'PlugIns')
         self.menuItem('Servlet Cache', 'ServletCache')
         self.menuItem('Application Control', 'AppControl')
         self.menuItem('Logout', 'Main?logout=yes')
 
-    def fileSize(self, filename):
-        """Utility method for writeMenu() to get the size of a config file.
+    def fileSize(self, log):
+        """Utility method for writeMenu() to get the size of a log file.
 
         Returns an HTML string.
         """
-        filename = self.application().setting(filename)
+        filename = self.application().setting(log + 'Filename')
         if os.path.exists(filename):
             size = '{:0.0f} KB'.format(os.path.getsize(filename) / 1024)
         else:

webware/Application.py

@@ -40,7 +40,7 @@
 debug = False
 
 defaultConfig = dict(
-    ActivityLogFilename='Logs/Activity.csv',
+    ActivityLogFilename='Activity.csv',
     ActivityLogColumns=[
         'request.remoteAddress', 'request.method',
         'request.uri', 'response.size',
@@ -49,7 +49,7 @@
         'transaction.errorOccurred'
     ],
     AlwaysSaveSessions=True,
-    AppLogFilename='Logs/Application.log',
+    AppLogFilename='Application.log',
     CacheDir='Cache',
     CacheServletClasses=True,
     CacheServletInstances=True,
@@ -75,7 +75,7 @@
         'Content-Type': 'text/html',
         'Subject': 'Error'
     },
-    ErrorLogFilename='Logs/Errors.csv',
+    ErrorLogFilename='Errors.csv',
     ErrorMessagesDir='ErrorMsgs',
     ErrorPage=None,
     ExtensionCascadeOrder=['.py', '.psp', '.html'],
@@ -95,6 +95,7 @@
     IncludeEditLink=True,
     IncludeFancyTraceback=False,
     LogActivity=True,
+    LogDir='Logs',
     LogErrors=True,
     MaxValueLengthInExceptionReport=500,
     OutputEncoding='utf-8',
@@ -164,12 +165,17 @@ def __init__(self, path=None, settings=None, development=None):
         You can specify the path of the application working directory,
         a dictionary of settings to override in the configuration,
         and whether the application should run in development mode.
+
+        In the setting 'ApplicationConfigFilename' you can also specify
+        a different location of the application configuration file.
         """
         ConfigurableForServerSidePath.__init__(self)
         if path is None:
             path = os.getcwd()
         self._serverSidePath = os.path.abspath(path)
         self._webwarePath = os.path.abspath(os.path.dirname(__file__))
+        self._configFilename = settings.get(
+            'ApplicationConfigFilename', 'Configs/Application.config')
 
         if not os.path.isfile(self.configFilename()):
             print("ERROR: The application cannot be started:")
@@ -206,9 +212,12 @@ def __init__(self, path=None, settings=None, development=None):
         if self.setting('CheckInterval') is not None:
             sys.setswitchinterval(self.setting('CheckInterval'))
 
-        logFilename = self.setting('AppLogFilename')
-        if logFilename:
-            sys.stderr = sys.stdout = open(logFilename, 'a', buffering=1)
+        self.makeDirs()
+        filename = self.setting('AppLogFilename')
+        if filename:
+            if '/' not in filename:
+                filename = os.path.join(self._logDir, filename)
+            sys.stderr = sys.stdout = open(filename, 'a', buffering=1)
 
         self.initErrorPage()
         self.printStartUpMessage()
@@ -226,7 +235,6 @@ def __init__(self, path=None, settings=None, development=None):
         # sessions, in case the loading of the sessions causes an exception.
         self._exceptionHandlerClass = ExceptionHandler
 
-        self.makeDirs()
         self.initSessions()
 
         URLParser.initApp(self)
@@ -324,9 +332,11 @@ def makeDirs(self):
             setting('CacheDir') or 'Cache')
         self._errorMessagesDir = self.serverSidePath(
             setting('ErrorMessagesDir') or 'ErrorMsgs')
+        self._logDir = self.serverSidePath(
+            self.setting('LogDir') or 'Logs')
         self._sessionDir = self.serverSidePath(
             setting('SessionStoreDir') or 'Sessions')
-        for path in (self.serverSidePath('Logs'), self._cacheDir,
+        for path in (self._logDir, self._cacheDir,
                      self._errorMessagesDir, self._sessionDir):
             if path and not os.path.exists(path):
                 os.makedirs(path)
@@ -418,7 +428,7 @@ def defaultConfig(self):
 
     def configFilename(self):
         """The configuration file path."""
-        return self.serverSidePath('Configs/Application.config')
+        return self.serverSidePath(self._configFilename)
 
     def configReplacementValues(self):
         """Get config values that need to be escaped."""
@@ -591,8 +601,10 @@ def writeActivityLog(self, trans):
         Writes an entry to the script log file. Uses settings
         ``ActivityLogFilename`` and ``ActivityLogColumns``.
         """
-        filename = self.serverSidePath(
-            self.setting('ActivityLogFilename'))
+        filename = self.setting('ActivityLogFilename')
+        if '/' not in filename:
+            filename = os.path.join(self._logDir, filename)
+        filename = self.serverSidePath(filename)
         if os.path.exists(filename):
             f = open(filename, 'a')
         else:

webware/Configs/Application.config

@@ -28,10 +28,10 @@ FilesToHide = {
 # If specified, only files matching these patterns will be served:
 FilesToServe = []  # no limitation
 
-AppLogFilename = None if Development else 'Logs/Application.log'
+AppLogFilename = None if Development else 'Application.log'
 
 LogActivity = False
-ActivityLogFilename = 'Logs/Activity.csv'
+ActivityLogFilename = 'Activity.csv'
 ActivityLogColumns = [
     'request.remoteAddress', 'request.method', 'request.uri',
     'response.size', 'servlet.name', 'request.timeStamp',
@@ -92,7 +92,7 @@ The site is having technical difficulties with this page. An error has
 been logged, and the problem will be fixed as soon as possible. Sorry!
 '''
 LogErrors = True
-ErrorLogFilename = 'Logs/Errors.csv'
+ErrorLogFilename = 'Errors.csv'
 SaveErrorMessages = True
 ErrorMessagesDir = 'ErrorMsgs'
 # Enable Error-Emails:

webware/ConfigurableForServerSidePath.py

@@ -1,3 +1,5 @@
+import os.path
+
 from MiscUtils.Configurable import Configurable, NoDefault
 
 
@@ -28,5 +30,8 @@ def setting(self, name, default=NoDefault):
         value = Configurable.setting(self, name, default)
         if name.endswith(('Dir', 'Filename')) and (
                 value or name.endswith('Dir')):
+            if name.endswith('LogFilename') and '/' not in value:
+                value = os.path.join(
+                    Configurable.setting(self, 'LogDir'), value)
             value = self.serverSidePath(value)  # pylint: disable=no-member
         return value

webware/ExceptionHandler.py

@@ -469,7 +469,7 @@ def fixElement(element):
             return element
 
         logLine = ','.join(map(fixElement, logLine)) + '\n'
-        filename = self._app.serverSidePath(self.setting('ErrorLogFilename'))
+        filename = self._app.setting('ErrorLogFilename')
         try:
             if os.path.exists(filename):
                 with open(filename, 'a') as f: