ISPconfig 3 - awstats

[Mouton]

I quickly wrote this small plugin to create awstats config file automatically (base on the ISPconfig 2 plugin)
It really needs improvement and automation but that's a start for whoever has time to write more about it...
Do not hesitate to improve or fix it....

PS: congrats for the 3.0.1 version !


Just paste the following code in a awstats_plugin.inc.php file in the plugins-available directory.

<?php

class awstats_plugin {

        var $plugin_name = 'awstats_plugin';
        var $class_name  = 'awstats_plugin';

        //* This function is called during ispconfig installation to determine
        //  if a symlink shall be created for this plugin.
        function onInstall() {
                global $conf;

                if(@$conf['services']['awstats'] == true) {
                        return true;
                } else {
                        return false;
                }

        }


        /*
                This function is called when the plugin is loaded
        */

        function onLoad() {
                global $app;

                /*
                Register for the events
                */

                //* Mail Domains
                $app->plugins->registerEvent('web_domain_insert',$this->plugin_name,'domain_insert');
                $app->plugins->registerEvent('web_domain_update',$this->plugin_name,'domain_update');
                $app->plugins->registerEvent('web_domain_delete',$this->plugin_name,'domain_delete');
        }


        function user_insert($event_name,$data) {
                // TODO: handle users for awstats access
        }

        function user_update($event_name,$data) {
                // TODO: handle users for awstats access
        }

        function user_delete($event_name,$data) {
                // TODO: handle users for awstats access
        }

        function domain_update($event_name,$data) {
                global $app, $conf;

                $this->domain_insert($event_name, $data);
        }

        function domain_insert($event_name,$data) {
                global $app, $conf;

                if(!@is_file("/etc/awstats/awstats.".$data["new"]["domain"].".conf") || ($data["old"]["domain"] != '' && $data["new"]["domain"] != $data["old"]["domain"])) {
                        if ( @is_file("/etc/awstats/awstats.".$data["old"]["domain"].".conf") )
                                 exec("rm -f /etc/awstats/awstats.".$data["old"]["domain"].".conf");

                        exec( "echo 'Include \"/etc/awstats/awstats.conf\"' > /etc/awstats/awstats.".$data["new"]["domain"].".conf" );
                        exec( "echo 'LogFile=\"/var/log/ispconfig/httpd/".$data["new"]["domain"]."/access.log\"' >> /etc/awstats/awstats.".$data["new"]["domain"].".conf" );
                        exec( "echo 'SiteDomain=\"".$data["new"]["domain"]."\"' >> /etc/awstats/awstats.".$data["new"]["domain"].".conf");
                        // exec( "echo 'AllowAccessFromWebToFollowingAuthenticatedUsers=\"".$ht_user_list."\"' >> /etc/awstats/awstats.".$data["new"]["domain"].".conf");
                }

        }

        function domain_delete($event_name,$data) {
                global $app, $conf;

                if($data["old"]["domain"] != '' ) {
                        if ( @is_file("/etc/awstats/awstats.".$data["old"]["domain"].".conf") )
                                 exec("rm -f /etc/awstats/awstats.".$data["old"]["domain"].".conf");
                }
        }




} // end class
?>

[andypl]

Ok i put this scripts in the plugins folder and how its works ?
I dont see any options on ISPConfig panel for awstats.

[till]

To enable the script you will have to create a symlink in the plugins-enabled folder to the plugin in the plugins-available folder like it is done for the other plugins. Afterwards you edit the file /usr/local/ispconfig/server/lib/config.inc.php and add the line:

$conf['services']['awstats'] = true;

Then the plugin should work. The author of the plugin may correct me if I missed an additional step as I did not tested the plugin yet. An of xourse the awstats package from your linux distribution has to be installed.

[Mouton]

Indeed, you'll need to install awstats first. Sadly, I do not have to to make any tutorial yet. I'll try but.

This plugin is only - for the moment -for generating awstats config for each ISPconfig 3 domain.

I'll work on the user htaccess restriction as soon as possible.

[archerjd]

Originally Posted by Mouton

I'll work on the user htaccess restriction as soon as possible.

Hi Mounton,
It seems to me that the .htaccess file even though has been used for decades , is a little messy. Would mod-auth-mysql be a cleaner/better solution?

One thing we have to keep in mind is if a user account gets disabled for some oddball reason. The .htaccess file will have to be modified and then again when the account is re-enabled. I believe if my memory serves me right, mod-auth-mysql has a variable just for things like that and it gives you the ability to use the same user accounts within the dbispconfig database.

There are some conns to this. mod-auth-mysql requires basic authentication (plain text).
Also, you would have to add something like this to the vhost.conf.master file.

<tmpl_if name='awstats' op='==' value='y'
  <Directory <tmpl_var name='web_document_root_www'>/stats
    AuthBasicAuthoritative Off
    AuthUserFile /dev/null
    AuthMySQL On
    AuthName "AWstats Service"
    AuthType Basic
    Auth_MySQL_Host localhost
    Auth_MySQL_User ispconfig
    Auth_MySQL_Password <tmpl_var name='db_password'>
    AuthMySQL_DB dbispconfig
    AuthMySQL_Password_Table ftp_user
    Auth_MySQL_Username_Field username
    Auth_MySQL_Password_Field password
    Auth_MySQL_Group_Table ftp_user
    Auth_MySQL_Group_Field gid
    Auth_MySQL_Encryption_Types Crypt
    Auth_MySQL_Empty_Passwords Off
    Auth_MySQL_Authoritative On
    Auth_MySQL_Password_Clause " AND enabled=1"
    require group <tmpl_var name='system_group'>
  </Directory>
</tmpl_if>

[Mouton]

Good idea.

I'm not sure, but mod-auth-mysql seems to have recent security issues as well as compatibility problems with apache 2.2 (not tested).
Maybe would it be better not to use a third party module but the mod_authn_dbd module ?

[letezo]

I've just installed the plugin. It creates the awstats config files for the domains, but it is far from working in its current state. Things need to do:

• Cron task to update the statistics for each domain. The default cron script installed by the system uses only the awstats.conf file and hardwired to build stats from /var/log/apache/access.log only, so that is clearly not enough in our case.
  
• Support for running awstats.pl without generally enabling CGI support for those domains. It can be protected by the same password as the Webalizer statistics. We have to provide a separate path for awstats. There should be a link from the Webalizer statistics to jump to awstats to help users.
  
• New option for the Stats tab of the site in ISPConfig to enable/disable awstats for the domain.
  
• Testing this on all the supported platforms.

[letezo]

I suggest moving the domain specific configuration files into a new directory like /etc/awstats/ispconfig or somewhere else. This directory should be created by the awstats plugin on installation or first use.

The Ubuntu 8.04 LTS distribution contains a script:
/usr/share/doc/awstats/awstats_updateall.pl

It can be configured (see the beginning of this file) to update the statistics for all the ISPConfig managed domains then.

Related topic, both for Webalizer and AWStats: We can enable GeoIP for them if we install the geoip-bin package and take care of downloading the free GeoIP Country database from MaxMind. I haven't tested this yet, however.

[letezo]

We have to place those config files directly under /etc/awstats, unfortunately. AWStats tries to load the config files for the virtual hosts from there.

[letezo]

We have to avoid the following bug on Ubuntu 8.04 LTS:
http://www.mail-archive.com/debian-b...msg385558.html

Due to the above bug awstats.conf.local cannot be included from awstats.conf, since that would be a "nested" (three level deep) include. We can comment out the Include "/etc/awstats/awstats.conf.local" line at the end of awstats.conf and include that from each domain specific awstats config file. Or we can change awstats.conf directly, but that would be bad practice and might be nor so resilent to upgrades as we would want.