Use AWFFull names for stats files rather than Webalizer

CHANGELOG

 CHANGELOG
 ---------
 
+2022-04-06
+  sympl-web
+    * Use AWFFull names for stats files rather than Webalizer
+
 2022-03-23
   sympl-core
     * Replace tempfile with mktemp in sympl-generate-dhparams

web/apache.d/webalizer.conf.erb → web/apache.d/awffull.conf.erb

@@ -2,7 +2,7 @@
 ##
 #
 #  This file is automatically generated from the template located at
-#  /etc/sympl/apache.d/webalizer.conf.erb
+#  /etc/sympl/apache.d/awffull.conf.erb
 #
 #  Feel free to make changes to this file.  If changes are made, then this file
 #  will not be updated automatically when the template changes.
@@ -17,7 +17,7 @@
 #
 # LogFile
 
-# LogType defines the log type being processed.  Normally, the Webalizer
+# LogType defines the log type being processed.  Normally, the awffull
 # expects a CLF or Combined web server log as input.  Using this option,
 # you can process ftp logs as well (xferlog as produced by wu-ftp and
 # others), or Squid native logs.  Values can be 'clf', 'ftp' or 'squid',
@@ -33,9 +33,9 @@ OutputDir    <%= domain.stats_dir %>
 
 
 # HistoryName allows you to specify the name of the history file produced
-# by the Webalizer.  The history file keeps the data for up to 12 months
+# by the awffull.  The history file keeps the data for up to 12 months
 # worth of logs, used for generating the main HTML page (index.html).
-# The default is a file named "webalizer.hist", stored in the specified
+# The default is a file named "awffull.hist", stored in the specified
 # output directory.  If you specify just the filename (without a path),
 # it will be kept in the specified output directory.  Otherwise, the path
 # is relative to the output directory, unless absolute (leading /).
@@ -45,13 +45,13 @@ HistoryName  <%= history_name %>
 
 # Incremental processing allows multiple partial log files to be used
 # instead of one huge one.  Useful for large sites that have to rotate
-# their log files more than once a month.  The Webalizer will save its
+# their log files more than once a month.  AWFFull will save its
 # internal state before exiting, and restore it the next time run, in
 # order to continue processing where it left off.  This mode also causes
-# The Webalizer to scan for and ignore duplicate records (records already
+# AWFFull to scan for and ignore duplicate records (records already
 # processed by a previous run).  See the README file for additional
 # information.  The value may be 'yes' or 'no', with a default of 'no'.
-# The file 'webalizer.current' is used to store the current state data,
+# The file 'awffull.current' is used to store the current state data,
 # and is located in the output directory of the program (unless changed
 # with the IncrementalName option below).  Please read at least the section
 # on Incremental processing in the README file before you enable this option.
@@ -61,7 +61,7 @@ Incremental	yes
 # IncrementalName allows you to specify the filename for saving the
 # incremental data in.  It is similar to the HistoryName option where the
 # name is relative to the specified output directory, unless an absolute
-# filename is specified.  The default is a file named "webalizer.current"
+# filename is specified.  The default is a file named "awffull.current"
 # kept in the normal output directory.  If you don't specify "Incremental"
 # as 'yes' then this option has no meaning.
 
@@ -80,7 +80,7 @@ ReportTitle    Usage Statistics for
 # clicking on URL's in the report to go to the proper location in
 # the event you are running the report on a 'virtual' web server,
 # or for a server different than the one the report resides on.
-# If not specified here, or on the command line, webalizer will
+# If not specified here, or on the command line, awffull will
 # try to get the hostname via a uname system call.  If that fails,
 # it will default to "localhost".
 
@@ -93,7 +93,7 @@ HostName       <%= domain %>
 
 #HTMLExtension  html
 
-# PageType lets you tell the Webalizer what types of URL's you
+# PageType lets you tell AWFFull what types of URL's you
 # consider a 'page'.  Most people consider html and cgi documents
 # as pages, while not images and audio files.  If no types are
 # specified, defaults will be used ('htm*', 'cgi' and HTMLExtension
@@ -132,7 +132,7 @@ PageType	php
 # DNSChildren allows you to specify how many "children" processes are
 # run to perform DNS lookups to create or update the DNS cache file.
 # If a number is specified, the DNS cache file will be created/updated
-# each time the Webalizer is run, immediately prior to normal processing,
+# each time AWFFull is run, immediately prior to normal processing,
 # by running the specified number of "children" processes to perform
 # DNS lookups.  If used, the DNS cache filename MUST be specified as
 # well.  The default value is zero (0), which disables DNS cache file
@@ -153,7 +153,7 @@ PageType	php
 # block, immediately after the <TITLE> line.  Maximum line length
 # is 80 characters, so use multiple lines if needed.
 
-#HTMLHead <META NAME="author" CONTENT="The Webalizer">
+#HTMLHead <META NAME="author" CONTENT="AWFFull">
 
 # HTMLBody defined the HTML code to be inserted, starting with the
 # <BODY> tag.  If not specified, the default is shown below.  If
@@ -220,7 +220,7 @@ PageType	php
 #GMTTime		no
 
 # Debug prints additional information for error messages.  This
-# will cause webalizer to dump bad records/fields instead of just
+# will cause awffull to dump bad records/fields instead of just
 # telling you it found a bad one.   As usual, the value can be
 # either "yes" or "no".  The default is "no".  It shouldn't be
 # needed unless you start getting a lot of Warning or Error
@@ -229,7 +229,7 @@ PageType	php
 
 #Debug		no
 
-# FoldSeqErr forces the Webalizer to ignore sequence errors.
+# FoldSeqErr forces AWFFull to ignore sequence errors.
 # This is useful for Netscape and other web servers that cache
 # the writing of log records and do not guarentee that they
 # will be in chronological order.  The use of the FoldSeqErr
@@ -336,12 +336,12 @@ PageType	php
 #AllSearchStr	no
 #AllUsers       no
 
-# The Webalizer normally strips the string 'index.' off the end of
+# AWFFull normally strips the string 'index.' off the end of
 # URL's in order to consolidate URL totals.  For example, the URL
 # /somedir/index.html is turned into /somedir/ which is really the
 # same URL.  This option allows you to specify additional strings
 # to treat in the same way.  You don't need to specify 'index.' as
-# it is always scanned for by The Webalizer, this option is just to
+# it is always scanned for by AWFFull, this option is just to
 # specify _additional_ strings if needed.  If you don't need any,
 # don't specify any as each string will be scanned for in EVERY
 # log record... A bunch of them will degrade performance.  Also,
@@ -354,7 +354,7 @@ PageType	php
 
 # The Hide*, Group* and Ignore* and Include* keywords allow you to
 # change the way Sites, URL's, Referrers, User Agents and Usernames
-# are manipulated.  The Ignore* keywords will cause The Webalizer to
+# are manipulated.  The Ignore* keywords will cause AWFFull to
 # completely ignore records as if they didn't exist (and thus not
 # counted in the main site totals).  The Hide* keywords will prevent
 # things from being displayed in the 'Top' tables, but will still be
@@ -471,7 +471,7 @@ GroupURL	/cgi-bin/*	CGI Scripts
 
 # The Ignore* keywords allow you to completely ignore log records based
 # on hostname, URL, user agent, referrer or username.  I hessitated in
-# adding these, since the Webalizer was designed to generate _accurate_
+# adding these, since AWFFull was designed to generate _accurate_
 # statistics about a web servers performance.  By choosing to ignore
 # records, the accuracy of reports become skewed, negating why I wrote
 # this program in the first place.  However, due to popular demand, here
@@ -501,7 +501,7 @@ IgnoreReferrer	localhost
 #IgnoreUser     *
 #IncludeUser    someuser
 
-# The MangleAgents allows you to specify how much, if any, The Webalizer
+# The MangleAgents allows you to specify how much, if any, AWFFull
 # should mangle user agent names.  This allows several levels of detail
 # to be produced when reporting user agent statistics.  There are six
 # levels that can be specified, which define different levels of detail
@@ -582,7 +582,7 @@ SearchEngine	google.be	q=
 #DumpUsers	no
 #DumpSearchStr  no
 
-# If you compiled Webalizer with GeoIP library, it becomes enabled
+# If you compiled Awffull with GeoIP library, it becomes enabled
 # by default. But if you wish to disable it, just set GeoIP to 'no'.
 # You may also want to specify database file path manually, if you
 # don't have one installed on system (in case of static build).
@@ -592,7 +592,7 @@ SearchEngine	google.be	q=
 
 # The custom  bar graph Colors are defined here. Declare them 
 # in the standard hexadecimal way (as HTML, without the '#') 
-# If none are given, you will get the standard webalizer colors.
+# If none are given, you will get the standard awffull colors.
 
 #ColorHit	00805c
 #ColorFile	0000ff

web/debian/changelog

+sympl-web (11.20220406.0) stable; urgency=low
+
+  * Use 'awffull' config file names rather than 'webalizer' for stats.
+
+ -- Paul Cammish <sympl@kelduum.net>  Wed, 06 Apr 2022 12:48:00 +0100
+
 sympl-web (11.20220322.1) stable; urgency=low
 
   * Update references from sympl.host to sympl.io

web/lib/symbiosis/config_files/webalizer.rb

@@ -23,7 +23,7 @@ module Symbiosis
       end
 
       #
-      # This method returns the location of the Webalizer "history" file, used
+      # This method returns the location of the AWFFull "history" file, used
       # to keep the last 12 months-worth of stats, for use in the HistoryName
       # directive.
       #
@@ -37,17 +37,17 @@ module Symbiosis
         #
         # This is the old place.
         #
-        old_location = File.join(domain.stats_dir, "webalizer.hist")
+        old_location = File.join(domain.stats_dir, "awffull.hist")
         return old_location if File.exist?(old_location)
 
         #
         # OK, just use the new one.
         #
-        return File.join(domain.config_dir, ".webalizer.hist")
+        return File.join(domain.config_dir, ".awffull.hist")
       end
 
       #
-      # This method returns the location of the Webalizer "current" file, used
+      # This method returns the location of the AWFFull "current" file, used
       # for incremental stats, for use in the IncrementalName directive.
       #
       # Older machines will have it at public/htdocs/stats/webalizer.current,
@@ -60,13 +60,13 @@ module Symbiosis
         #
         # This is the old place.
         #
-        old_location = File.join(domain.stats_dir, "webalizer.current")
+        old_location = File.join(domain.stats_dir, "awffull.current")
         return old_location if File.exist?(old_location)
 
         #
         # OK, just use the new one.
         #
-        return File.join(domain.config_dir, ".webalizer.current")
+        return File.join(domain.config_dir, ".awffull.current")
       end
 
     end

web/sbin/sympl-web-generate-stats

@@ -13,7 +13,7 @@
 # OPTIONS
 #
 #  -t, --template <file>   Set the awffull config template file. Defaults to
-#                          /etc/sympl/apache.d/webalizer.conf.erb.
+#                          /etc/sympl/apache.d/awffull.conf.erb.
 #
 #  -f, --force             Force regeneration of the awffull configuration
 #                          snippet for all domains.
@@ -49,7 +49,7 @@ require 'getoptlong'
 #
 #  The options set by the command line.
 #
-template     = '/etc/sympl/apache.d/webalizer.conf.erb'
+template     = '/etc/sympl/apache.d/awffull.conf.erb'
 help         = false
 manual       = false
 $VERBOSELOCAL     = false
@@ -159,7 +159,7 @@ Symbiosis::Domains.each(prefix) do |domain|
   #
   # Create a configuration file, if one wasn't found.
   #
-  webalizer_conf = File.join( domain.config_dir, "webalizer.conf" )
+  webalizer_conf = File.join( domain.config_dir, "awffull.conf" )
 
   config          = Symbiosis::ConfigFiles::Webalizer.new(webalizer_conf, "#")
   config.template = template
@@ -232,7 +232,7 @@ Symbiosis::Domains.each(prefix) do |domain|
   # Read webalizer config to find where the history file is kept, so we can see when
   #
   output_dir   = domain.config_dir
-  history_name = "webalizer.hist"
+  history_name = "awffull.hist"
 
   File.open(config.filename) do |fh|
     while line = fh.gets