[Pkg-awstats-devel] Bug#580692: awstats: Add option to disable nightly generation of static html reports

[Ken Neighbors]

Package: awstats
Version: 6.9.5~dfsg-2
Severity: wishlist
Tags: patch


The script buildstatic.sh is run by cron every night to create static
html reports in /var/cache/awstats.  I would prefer not to have static
reports generated, so I created an option in /etc/default/awstat to
turn off this feature.

With inspiration from /etc/default/rsync and /etc/init.d/rsync, I set up
an option in /etc/default/awstat called AWSTATS_ENABLE_BUILDSTATICPAGES.
If set to "yes" then buildstatic.sh will run every night to build
static pages.  If set to "no" (which I think should be the default, but
feel free to make up your own mind), then buildstatic.sh will not build
static pages.  I placed a short note in README.Debian about it.

-- System Information:
Debian Release: 5.0.4
  APT prefers stable
  APT policy: (500, 'stable'), (50, 'unstable')
Architecture: i386 (i686)

Kernel: Linux 2.6.26-2-686 (SMP w/1 CPU core)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash

Versions of packages awstats depends on:
ii  perl                     5.10.0-19lenny2 Larry Wall's Practical Extraction 

Versions of packages awstats recommends:
ii  libnet-xwhois-perl            0.90-3     Whois Client Interface for Perl5

Versions of packages awstats suggests:
pn  apache2 | httpd            <none>        (no description available)
pn  libgeo-ipfree-perl         <none>        (no description available)
pn  libnet-dns-perl            <none>        (no description available)
pn  libnet-ip-perl             <none>        (no description available)
ii  liburi-perl                1.35.dfsg.1-1 Manipulates and accesses URI strin

-- no debconf information
-------------- next part --------------
>From 3492ee4e32a1dd2cafa982c6603b7f8afe14564d Mon Sep 17 00:00:00 2001
From: Ken Neighbors <ken at nsds.com>
Date: Wed, 28 Apr 2010 22:31:40 -0700
Subject: Add option to disable nightly generation of static html reports.

---
 debian/README.Debian   |    1 +
 debian/buildstatic.sh  |    5 +++++
 debian/default/awstats |    4 ++++
 3 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/debian/README.Debian b/debian/README.Debian
index d5a9a1e..ed8b69f 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -8,6 +8,7 @@ Do the following for a simple setup of a single website with Apache 2.x:
 
   * Edit /etc/logrotate.d/apache2 to permit www-data access to logfiles
   * copy /usr/share/doc/awstats/examples/apache.conf to /etc/apache2/conf.d/
+  * edit /etc/default/awstats to enable nightly build of static html reports
 
 The above is _NOT_ supported or recommended! Please read the rest of this
 document instead...
diff --git a/debian/buildstatic.sh b/debian/buildstatic.sh
index 9f41cbc..ca09cc7 100755
--- a/debian/buildstatic.sh
+++ b/debian/buildstatic.sh
@@ -14,6 +14,11 @@ BUILDSTATICPAGES=/usr/share/awstats/tools/awstats_buildstaticpages.pl
 [ -f $AWSTATS -a -f $BUILDSTATICPAGES ] || exit 1
 [ -r "$DEFAULT" ] && . "$DEFAULT"
 
+ENABLE=${AWSTATS_ENABLE_BUILDSTATICPAGES:-no}
+if [ "$ENABLE" != "yes" ]; then
+  exit 0
+fi
+
 cd /etc/awstats
 
 TMPFILE=`mktemp /tmp/awstats.XXXXXXXXXX`
diff --git a/debian/default/awstats b/debian/default/awstats
index 3785ea3..d8830cc 100644
--- a/debian/default/awstats
+++ b/debian/default/awstats
@@ -1,5 +1,9 @@
 # AWStats configuration options
 
+# This variable controls whether to create static html reports every
+# night in /var/cache/awstats/.  Set to "yes" or "no".
+AWSTATS_ENABLE_BUILDSTATICPAGES="no"
+
 # This variable control the language of all static html reports.  Set
 # one to appropriate two-letter language code (default to en).
 #AWSTATS_LANG=ru
-- 
1.5.6.5

-------------- next part --------------
# AWStats configuration options

# This variable controls whether to create static html reports every
# night in /var/cache/awstats/.  Set to "yes" or "no".
AWSTATS_ENABLE_BUILDSTATICPAGES="no"

# This variable control the language of all static html reports.  Set
# one to appropriate two-letter language code (default to en).
#AWSTATS_LANG=ru
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0004-debian-buildstatic.sh
Type: text/x-shellscript
Size: 999 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/pkg-awstats-devel/attachments/20100507/4bf088b3/attachment-0001.bin>