#!/usr/bin/perl #----------------------------------------------------------------------------- # UrlAlias AWStats plugin # This plugin allow you to report all URL links with a text title instead of # URL value. # You must create a file called urlalias.cnfigvalue.txt and store it in # plugin directory that contains 2 columns separated by a tab char. # First column is URL value and second column is text title to use instead of. #----------------------------------------------------------------------------- # Perl Required Modules: None #----------------------------------------------------------------------------- # $Revision: 1.1.1.1 $ - $Author: rocaelh $ - $Date: 2005/03/01 17:35:41 $ # <----- # ENTER HERE THE USE COMMAND FOR ALL REQUIRED PERL MODULES #if (!eval ('require "TheModule.pm";')) { return $@?"Error: $@":"Error: Need Perl module TheModule"; } # -----> use strict;no strict "refs"; #----------------------------------------------------------------------------- # PLUGIN VARIABLES #----------------------------------------------------------------------------- # <----- # ENTER HERE THE MINIMUM AWSTATS VERSION REQUIRED BY YOUR PLUGIN # AND THE NAME OF ALL FUNCTIONS THE PLUGIN MANAGE. my $PluginNeedAWStatsVersion="5.5"; my $PluginHooksFunctions="ShowInfoURL"; # -----> # <----- # IF YOUR PLUGIN NEED GLOBAL VARIABLES, THEY MUST BE DECLARED HERE. use vars qw/ $urlinfoloaded %UrlAlias @UrlMatch /; # -----> #----------------------------------------------------------------------------- # PLUGIN FUNCTION: Init_pluginname #----------------------------------------------------------------------------- sub Init_urlalias { my $InitParams=shift; my $checkversion=&Check_Plugin_Version($PluginNeedAWStatsVersion); # <----- # ENTER HERE CODE TO DO INIT PLUGIN ACTIONS debug(" Plugin urlalias: InitParams=$InitParams",1); $urlinfoloaded=0; %UrlAlias=(); @UrlMatch=(); # -----> return ($checkversion?$checkversion:"$PluginHooksFunctions"); } #----------------------------------------------------------------------------- # PLUGIN FUNCTION: ShowInfoURL_pluginname # UNIQUE: NO (Several plugins using this function can be loaded) # Function called to add additionnal information for URLs in URLs' report. # This function is called after writing the URL value in the URL cell of the # Top Pages-URL report. # Parameters: URL #----------------------------------------------------------------------------- sub ShowInfoURL_urlalias { my $param="$_[0]"; # <----- my $found = 0; # flag for testing for whether a match occurs. unused at present my $filetoload=''; my $filetoload2=''; if ($param && ! $urlinfoloaded) { # Load urlalias and match files if ($SiteConfig && open(URLALIASFILE,"$DirData/urlalias.$SiteConfig.txt")) { $filetoload2="$DirData/urlalias.$SiteConfig.txt"; } elsif (open(URLALIASFILE,"$DirData/urlalias.txt")) { $filetoload2="$DirData/urlalias.txt"; } else { error("Couldn't open UrlAlias file \"$DirData/urlalias.txt\": $!"); } if ($SiteConfig && open(URLMATCHFILE,"$DirData/urlmatch.$SiteConfig.txt")) { $filetoload="$DirData/urlmatch.$SiteConfig.txt"; } elsif (open(URLMATCHFILE,"$DirData/urlmatch.txt")) { $filetoload="$DirData/urlmatch.txt"; } # Load UrlAlias %UrlAlias = map(/^([^\t]+)\t+([^\t]+)/o,); # Load UrlMatch my $iter = 0; foreach my $key () { $key =~ /^([^\t]+)\t+([^\t]+)/o; $UrlMatch[$iter][0] = $1; $UrlMatch[$iter][1] = $2; $iter++; } close URLALIASFILE; close URLMATCHFILE; debug(" Plugin urlalias: UrlAlias file loaded: ".(scalar keys %UrlAlias)." entries found."); debug(" Plugin urlalias: UrlMatch file loaded: ".(scalar @UrlMatch)." entries found."); $urlinfoloaded=1; } if ($param) { if ($UrlAlias{$param}) { print "$UrlAlias{$param}
"; $found=1; } else { foreach my $iter (0..@UrlMatch-1) { my $key = $UrlMatch[$iter][0]; if ( $param =~ /$key/ ) { print "$UrlMatch[$iter][1]
"; $found = 1; # $UrlAlias{$param} = $UrlMatch[$iter][1]; # if ($SiteConfig && open(URLALIASFILE,">> $DirData/urlalias.$SiteConfig.txt")) { # $filetoload="$DirData/urlalias.$SiteConfig.txt"; # } # elsif (open(URLALIASFILE,">> $DirData/urlalias.txt")) { # $filetoload="$DirData/urlalias.txt"; # } # else { # error("Couldn't open UrlAlias file \"$DirData/urlalias.txt\": $!"); # } # print URLALIASFILE "$param\t$UrlAlias{$param}"; # close URLALIASFILE; last; } } } if (!$found) { # does nothing right now print ""; } } else { print ""; } # Url info title return 1; # -----> } 1; # Do not remove this line