Refresh design, refactoring code for much easy templating and code reading

docs/awstats_config.html

@@ -53,6 +53,7 @@
 </li><li><a href="#DirData">DirData</a>
 </li><li><a href="#DirCgi">DirCgi</a>
 </li><li><a href="#DirIcons">DirIcons</a>
+</li><li><a href="#DirImgs">DirImgs</a>
 </li><li><a href="#SiteDomain">SiteDomain</a>
 </li><li><a href="#HostAliases">HostAliases</a>
 </li><li><a href="#AllowToUpdateStatsFromBrowser">AllowToUpdateStatsFromBrowser</a>
@@ -468,6 +469,19 @@
 
 <br><br><hr>
 
+<a name="DirImgs"><b>DirImgs</b></a><br>
+<b>Version : </b>1.0+<br>
+<br># Relative or absolute web URL of your awstats images directory.
+<br># If you build static reports ("... -output &gt; outputpath/output.html"), enter
+<br># path of images directory relative to the output directory 'outputpath'.
+<br># Example: "/awstatsimgs"
+<br># Example: "../img"
+<br># Default: "/img" (means you must copy images directories in "/mywwwroot/img")
+<br>#
+<br>DirIcons="/img"
+
+<br><br><hr>
+
 <a name="SiteDomain"><b>SiteDomain</b></a><br>
 <b>Version : </b>3.2+<br>
 <br># "SiteDomain" must contain the main domain name or the main intranet web
@@ -1430,8 +1444,8 @@
 <br>
 <br># Show domains/country chart
 <br># Context: Web, Streaming, Mail, Ftp
-<br># Default: PHB, Possible column codes: PHB
-<br>ShowDomainsStats=PHB
+<br># Default: UVPHB, Possible column codes: UVPHB
+<br>ShowDomainsStats=UVPHB
 <br>
 <br># Show hosts chart
 <br># Context: Web, Streaming, Mail, Ftp

docs/awstats_contrib.html

@@ -227,6 +227,7 @@
 <br>Note: You must choose between using this plugin&nbsp;or the
 GeoIPfree plugin&nbsp;(need Perl Geo::IPfree module, database is free
 but not up to date).
+<br>Free databases can be found here : <a href = "https://mailfud.org/geoip-legacy/">https://mailfud.org/geoip-legacy/</a>
 <br>Example <span style="font-style: italic;">LoadPlugin="geoip GEOIP_STANDARD /usr/local/geoip.dat /usr/local/geoip_override.txt"
 
 </span><br>Plugin provided with AWStats (5.2+)
@@ -236,7 +237,9 @@
 <br><span style="font-style: italic;">Parameters:</span> [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPCity.dat] &lt;/pathto/override.txt&gt;<br><span style="font-style: italic;">Description: </span>This plugin adds a chart of hits by cities (with country and regions&nbsp;informations for major countries).
 <br>
 By enabling this plugin, you will see a new link called 'Cities' on 
-reports menu.<br>Example <span style="font-style: italic;">LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /usr/local/geoip.dat /usr/local/GeoIPCity_override.txt"
+reports menu.
+<br>Free databases can be found here : <a href = "https://mailfud.org/geoip-legacy/">https://mailfud.org/geoip-legacy/</a>
+<br>Example <span style="font-style: italic;">LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /usr/local/geoip.dat /usr/local/GeoIPCity_override.txt"
 
 </span><br>Plugin provided with AWStats (6.2+)
 
@@ -247,7 +250,9 @@
 the database. You can also provide a link that will be used to lookup
 additional registration data. Put the link at the end of the parameter
 string and the report page will include the link with the full AS
-number at the end.<br>Example <span style="font-style: italic;">LoadPlugin="geoip_asn_maxmind
+number at the end.
+<br>Free databases can be found here : <a href = "https://mailfud.org/geoip-legacy/">https://mailfud.org/geoip-legacy/</a>
+<br>Example <span style="font-style: italic;">LoadPlugin="geoip_asn_maxmind
 GEOIP_STANDARD /usr/local/geoip.dat /usr/local/GeoIPASN_override.txt
 http://enc.com.au/itools/aut-num.php?autnum="
 </span><br>Plugin provided with AWStats (6.9+)
@@ -268,6 +273,7 @@
 <br>By enabling this plugin, you will see a new link called 'ISP' on reports menu. For
 the moment this link works only when AWStats reports are build as CGI (static built not yet
 supported).
+<br>Free databases can be found here : <a href = "https://mailfud.org/geoip-legacy/">https://mailfud.org/geoip-legacy/</a>
 <br>Example <span style="font-style: italic;">LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /usr/local/GeoIPISP.dat </span><span style="font-style: italic;">/usr/local/geoip_override.txt"</span><br>Plugin provided with AWStats (6.3+)
 
 <br><br><span style="font-weight: bold;">GeoIP_Org_Maxmind
@@ -276,6 +282,7 @@
 <br>By enabling this plugin, you will see a new link called 'Organizations' on reports menu. For
 the moment this link works only when AWStats reports are build as CGI (static built not yet
 supported).
+<br>Free databases can be found here : <a href = "https://mailfud.org/geoip-legacy/">https://mailfud.org/geoip-legacy/</a>
 <br>Example <span style="font-style: italic;">LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /usr/local/GeoIPOrg.dat </span><span style="font-style: italic;">/usr/local/geoip_override.txt"</span><br>Plugin provided with AWStats (6.3+)
 
 <br><br>

docs/awstats_setup.html

@@ -115,6 +115,7 @@ <h2 style=""><u>I. Setup: Installation and configuration using
 Alias /awstatsclasses "/usr/local/awstats/wwwroot/classes/" <br>
 Alias /awstatscss "/usr/local/awstats/wwwroot/css/" <br>
 Alias /awstatsicons "/usr/local/awstats/wwwroot/icon/" <br>
+Alias /awstatsimgs "/usr/local/awstats/wwwroot/img/" <br>
 ScriptAlias /awstats/ "/usr/local/awstats/wwwroot/cgi-bin/" <br>
 # <br>
 # This is to permit URL access to scripts/files in AWStats directory. <br>
@@ -252,6 +253,9 @@ <h2 style=""><u>I. Setup: Installation and configuration using
 Move AWStats <b>icon sub-directories</b> and its content into a
 directory readable by your
 web server, for example C:\yourwwwroot\icon.<br>
+Move AWStats <b>img sub-directories</b> and its content into a
+directory readable by your
+web server, for example C:\yourwwwroot\img.<br>
 <br>
 <font style="color: rgb(17, 17, 85);"><b>* Step 4</b>:</font><br>
 <br>
@@ -282,6 +286,8 @@ <h2 style=""><u>I. Setup: Installation and configuration using
 cs-uri-query sc-status sc-bytes cs-version cs(User-Agent) cs(Referer)"</i><br>
 - Change the <a href="awstats_config.html#DirIcons">DirIcons</a>
 parameter to reflect relative path of icon directory.<br>
+- Change the <a href="awstats_config.html#DirImgs">DirImgs</a>
+parameter to reflect relative path of img directory.<br>
 - Set the <a href="awstats_config.html#SiteDomain">SiteDomain</a>
 parameter to the main domain name or the intranet
 web server name used to reach the web site being analyzed (Example:

make/rpm/awstats.spec

@@ -124,6 +124,7 @@ mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/icon/flags
 mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/icon/mime
 mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/icon/os
 mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/icon/other
+mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/img
 mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/js
 mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/cgi-bin/lang
 mkdir -p $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/cgi-bin/lang/tooltips_f
@@ -163,6 +164,7 @@ install -m 444 wwwroot/icon/flags/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/ic
 install -m 444 wwwroot/icon/mime/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/icon/mime
 install -m 444 wwwroot/icon/os/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/icon/os
 install -m 444 wwwroot/icon/other/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/icon/other
+install -m 444 wwwroot/img/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/img
 install -m 444 wwwroot/js/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/js
 install -m 444 wwwroot/cgi-bin/lang/tooltips_f/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/cgi-bin/lang/tooltips_f
 install -m 444 wwwroot/cgi-bin/lang/tooltips_m/* $RPM_BUILD_ROOT/usr/local/awstats/wwwroot/cgi-bin/lang/tooltips_m

tools/awstats_configure.pl

@@ -21,6 +21,7 @@
 use vars qw/
 $AWSTATS_PATH
 $AWSTATS_ICON_PATH
+$AWSTATS_IMG_PATH
 $AWSTATS_CSS_PATH
 $AWSTATS_CLASSES_PATH
 $AWSTATS_CGI_PATH
@@ -29,6 +30,7 @@
 /;
 $AWSTATS_PATH='';
 $AWSTATS_ICON_PATH='/usr/local/awstats/wwwroot/icon';
+$AWSTATS_IMG_PATH='/usr/local/awstats/wwwroot/img';
 $AWSTATS_CSS_PATH='/usr/local/awstats/wwwroot/css';
 $AWSTATS_CLASSES_PATH='/usr/local/awstats/wwwroot/classes';
 $AWSTATS_CGI_PATH='/usr/local/awstats/wwwroot/cgi-bin';
@@ -324,6 +326,7 @@ sub update_awstats_config
 			exit 1;
 		}
 		$AWSTATS_ICON_PATH="$AWSTATS_PATH/wwwroot/icon";
+		$AWSTATS_IMG_PATH="$AWSTATS_PATH/wwwroot/img"
 		$AWSTATS_CSS_PATH="$AWSTATS_PATH/wwwroot/css";
 		$AWSTATS_CLASSES_PATH="$AWSTATS_PATH/wwwroot/classes";
 		$AWSTATS_CGI_PATH="$AWSTATS_PATH/wwwroot/cgi-bin";
@@ -349,6 +352,7 @@ sub update_awstats_config
 			exit 1;
 		}
 		$AWSTATS_ICON_PATH="$AWSTATS_PATH/wwwroot/icon";
+		$AWSTATS_IMG_PATH="$AWSTATS_PATH/wwwroot/img";
 		$AWSTATS_CSS_PATH="$AWSTATS_PATH/wwwroot/css";
 		$AWSTATS_CLASSES_PATH="$AWSTATS_PATH/wwwroot/classes";
 		$AWSTATS_CGI_PATH="$AWSTATS_PATH/wwwroot/cgi-bin";
@@ -358,6 +362,7 @@ sub update_awstats_config
 	# We do not use default values for awstats directives
 	# but thoose defined from AWSTATS_PATH
 	$AWSTATS_ICON_PATH="$AWSTATS_PATH/wwwroot/icon";
+	$AWSTATS_IMG_PATH="$AWSTATS_PATH/wwwroot/img";
 	$AWSTATS_CSS_PATH="$AWSTATS_PATH/wwwroot/css";
 	$AWSTATS_CLASSES_PATH="$AWSTATS_PATH/wwwroot/classes";
 	$AWSTATS_CGI_PATH="$AWSTATS_PATH/wwwroot/cgi-bin";
@@ -457,6 +462,7 @@ sub update_awstats_config
 	my $awstatsclassesfound=0;
 	my $awstatscssfound=0;
 	my $awstatsiconsfound=0;
+	my $awstatsimgsfound=0;
 	my $awstatscgifound=0;
 	my $awstatsdirectoryfound=0;
 	while(<CONF>)
@@ -480,13 +486,14 @@ sub update_awstats_config
 		if ($_ =~ /Alias \/awstatsclasses/) 		{ $awstatsclassesfound=1; }
 		if ($_ =~ /Alias \/awstatscss/) 			{ $awstatscssfound=1; }
 		if ($_ =~ /Alias \/awstatsicons/) 			{ $awstatsiconsfound=1; }
+		if ($_ =~ /Alias \/awstatsimgs/) 			{ $awstatsimgsfound=1; }
 		if ($_ =~ /ScriptAlias \/awstats\//)		{ $awstatscgifound=1; }
 		my $awstats_path_quoted=quotemeta($AWSTATS_PATH);
 		if ($_ =~ /Directory "$awstats_path_quoted\/wwwroot"/)	{ $awstatsdirectoryfound=1; }
     }	
 	close CONF;
 
-	if ($awstatsclassesfound && $awstatscssfound && $awstatsiconsfound && $awstatscgifound && $awstatsdirectoryfound)
+	if ($awstatsclassesfound && $awstatscssfound && $awstatsiconsfound && $awstatsimgsfound && $awstatscgifound && $awstatsdirectoryfound)
 	{
 		$UseAlias=1;
 		if ($commonchangedtocombined) { print "  Common log files changed to combined.\n"; }
@@ -497,7 +504,7 @@ sub update_awstats_config
 	# Add awstats directives
 	open(CONF,">>$key") || error("Failed to open config file '$key' for adding AWStats directives");
 	binmode CONF;
-	if (! $awstatsclassesfound || ! $awstatscssfound || ! $awstatsiconsfound || ! $awstatscgifound) {
+	if (! $awstatsclassesfound || ! $awstatscssfound || ! $awstatsiconsfound || ! $awstatsimgsfound || ! $awstatscgifound) {
 		print CONF "$CR\n";
 		print CONF "#$CR\n";
 		print CONF "# Directives to allow use of AWStats as a CGI$CR\n";
@@ -515,6 +522,12 @@ sub update_awstats_config
 		print "  Add 'Alias \/awstatsicons \"$AWSTATS_ICON_PATH\/\"'\n";
 		print CONF "Alias \/awstatsicons \"$AWSTATS_ICON_PATH\/\"$CR\n";
 	}
+
+	if (! $awstatsimgsfound) {
+		print "  Add 'Alias \/awstatsimgs \"$AWSTATS_IMG_PATH\/\"'\n";
+		print CONF "Alias \/awstatsimgs \"$AWSTATS_IMG_PATH\/\"$CR\n";
+	}
+
 	if (! $awstatscgifound) {
 		print "  Add 'ScriptAlias \/awstats\/ \"$AWSTATS_CGI_PATH\/\"'\n";
 		print CONF "ScriptAlias \/awstats\/ \"$AWSTATS_CGI_PATH\/\"$CR\n";
@@ -570,6 +583,7 @@ sub update_awstats_config
 	if ($UseAlias) {
 		$ConfToChange{'DirCgi'}='/awstats';
 		$ConfToChange{'DirIcons'}='/awstatsicons';
+		$ConfToChange{'DirImgs'}='/awstatsimgs';
 	}
 	update_awstats_config("$modelfile");
 	print "  File awstats.model.conf updated.\n";
@@ -639,6 +653,7 @@ sub update_awstats_config
 		if ($UseAlias) {
 			$ConfToChange{'DirCgi'}='/awstats';
 			$ConfToChange{'DirIcons'}='/awstatsicons';
+			$ConfToChange{'DirImgs'}='/awstatsimgs';
 		}
 		$ConfToChange{'SiteDomain'}="$site";
 		my $sitewithoutwww=lc($site); $sitewithoutwww =~ s/^www\.//i;

wwwroot/cgi-bin/awstats.model.conf

@@ -990,6 +990,11 @@ ShowMonthStats=UVPHB
 # Default: VPHB, Possible column codes: VPHB
 ShowDaysOfMonthStats=VPHB
 
+# Show ratios chart
+# Context: Web
+# Default: UVPH, Possible column codes: UVPH
+ShowRatiosStats=UVPH
+
 # Show days of week chart
 # Context: Web, Streaming, Mail, Ftp
 # Default: PHB, Possible column codes: PHB
@@ -1002,8 +1007,8 @@ ShowHoursStats=PHB
 
 # Show domains/country chart
 # Context: Web, Streaming, Mail, Ftp
-# Default: PHB, Possible column codes: UVPHB
-ShowDomainsStats=PHB
+# Default: UVPHB, Possible column codes: UVPHB
+ShowDomainsStats=UVPHB
 
 # Show hosts chart
 # Context: Web, Streaming, Mail, Ftp
@@ -1210,6 +1215,18 @@ FirstDayOfWeek=1
 #
 ShowFlagLinks=""
 
+# Wether country flags are image or utf8 based
+# Possible values: "image" or "utf8"
+# Default: "image"
+#
+FlagsType="image"
+
+# Choose if you want to show the world map
+# Possible values: 0 or 1
+# Default: 1
+#
+ShowMap=1
+
 
 # Each URL, shown in stats report views, are links you can click.
 # Possible values: 0 or 1
@@ -1266,11 +1283,10 @@ Logo="awstats_logo6.png"
 LogoLink="https://www.awstats.org"
 
 
-# Value of maximum bar width/height for horizontal/vertical HTML graphics bars.
-# Default: 260/90
+# Value of maximum bar width for horizontal HTML graphics bars.
+# Default: 260
 #
 BarWidth   = 260
-BarHeight  = 90
 
 
 # You can ask AWStats to use a particular CSS (Cascading Style Sheet) to
@@ -1282,6 +1298,15 @@ BarHeight  = 90
 #
 StyleSheet=""
 
+# When using a particular CSS (Cascading Style Sheet),
+# you can choose one of the two modes available
+#
+# "herited" : you keep the awstats built-in css base and you override it in your stylesheet
+# "standalone" : the built-in css will not be considered
+#
+# Default: "herited"
+#
+StylesheetMode="herited"
 
 # Those color parameters can be used (if StyleSheet parameter is not used)
 # to change AWStats look.
@@ -1302,7 +1327,7 @@ color_link="0011BB"				# Color of HTML links (Default = "0011BB")
 color_hover="605040"			# Color of HTML on-mouseover links (Default = "605040")
 color_u="FFAA66"				# Background color for number of unique visitors (Default = "FFAA66")
 color_v="F4F090"				# Background color for number of visites (Default = "F4F090")
-color_p="4477DD"				# Background color for number of pages (Default = "4477DD")
+color_p="74A2FD"				# Background color for number of pages (Default = "74A2FD")
 color_h="66DDEE"				# Background color for number of hits (Default = "66DDEE")
 color_k="2EA495"				# Background color for number of bytes (Default = "2EA495")
 color_s="8888DD"				# Background color for number of search (Default = "8888DD")
@@ -1463,6 +1488,7 @@ color_x="C1B2E2"				# Background color for number of exit pages (Default = "C1B2
 # DESCRIPTION: Builds a country chart and adds an entry to the hosts
 # table with country name
 # Replace spaces in the path of geoip data file with string "%20".
+# Free databases can be found here: https://mailfud.org/geoip-legacy/
 #
 #LoadPlugin="geoip GEOIP_STANDARD /pathto/GeoIP.dat"
 
@@ -1483,6 +1509,7 @@ color_x="C1B2E2"				# Background color for number of exit pages (Default = "C1B2
 # table with country name
 # works with IPv4 and also IPv6 addresses
 # Replace spaces in the path of geoip data file with string "%20".
+# Free databases can be found here: https://mailfud.org/geoip-legacy/
 #
 #LoadPlugin="geoip6 GEOIP_STANDARD /pathto/GeoIPv6.dat"
 
@@ -1492,6 +1519,7 @@ color_x="C1B2E2"				# Background color for number of exit pages (Default = "C1B2
 # DESCRIPTION: This plugin adds a column under the hosts field and tracks the pageviews
 # and hits by city including regions.
 # Replace spaces in the path of geoip data file with string "%20".
+# Free databases can be found here: https://mailfud.org/geoip-legacy/
 #
 #LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /pathto/GeoIPCity.dat"
 
@@ -1512,6 +1540,7 @@ color_x="C1B2E2"				# Background color for number of exit pages (Default = "C1B2
 # a link that will be used to lookup additional registration data. Put the link at the end of
 # the parameter string and the report page will include the link with the full AS number at the end.
 # Replace spaces in the path of geoip data file with string "%20".
+# Free databases can be found here: https://mailfud.org/geoip-legacy/
 #
 #LoadPlugin="geoip_asn_maxmind GEOIP_STANDARD /usr/local/geoip.dat+http://enc.com.au/itools/autnum.php?asn="
 
@@ -1529,6 +1558,7 @@ color_x="C1B2E2"				# Background color for number of exit pages (Default = "C1B2
 # PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPISP.dat[+/pathto/override.txt]]
 # DESCRIPTION: This plugin adds a chart of hits by ISP.
 # Replace spaces in the path of geoip data file with string "%20".
+# Free databases can be found here: https://mailfud.org/geoip-legacy/
 #
 #LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /pathto/GeoIPISP.dat"
 
@@ -1537,6 +1567,7 @@ color_x="C1B2E2"				# Background color for number of exit pages (Default = "C1B2
 # PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPOrg.dat[+/pathto/override.txt]]
 # DESCRIPTION: This plugin add a chart of hits by Organization name
 # Replace spaces in the path of geoip data file with string "%20".
+# Free databases can be found here: https://mailfud.org/geoip-legacy/
 #
 #LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /pathto/GeoIPOrg.dat"