Subversion Repositories LCARS

Compare Revisions

Last modification

Ignore whitespace Rev 13 → Rev 12

/trunk/tools/network/news/newsstat/ChangeLog
1,64 → 1,30
Changelog
==========
 
2011-10-04 PE
- Added diagnostics (just in case)
- Use `binmode STDOUT' instead of `use encoding' (compat.)
- Documentation update, moved changelog and TODO to files
- `##' for leading comments to handle dev artifacts better
- Sorted supported newsreaders alphabetically
- Added support for Microsoft Windows Mail (OE successor)
- Use uniform sub identifiers (words delimited with `_')
- Use ISO/IEC units of data storage (KiB, MiB) uniformly
- Space after header field's `:' are optional now,
see RFC 5536, section 2.2 ("MAY")
- Convert old `From' format to new one, collapse whitespace,
remove outer ("protocol") quotes
- Seconds are optional in `Date' header field values now,
see grammar in RFC 5322, section 3.3 (ref. by RFC 5536, 2.2)
- commify() adapted to perlfaq5
- clean(): Simplified whitespace stripping
- write_data(): writes XDATA using UTF-8, removed bogus print()
- Fixed all Perl::Critic-ized code except nested get_agent()
 
2011-10-03 PE
- Use more compatible shebang
- Fixed some Perl::Critic-ized code
- Fixed wrong indent for non-ASCII names
- Formatted source code
 
2011-07-03 PE
- Use Encode to decode/encode MIME encodings
- Use warnings, utf8 (just in case)
- Documentation update
N/A NN
- Take newsgroup name as argument
 
2004-06-19 NN
- newsgroup name is $ARGV[0]
- Allow command line flags for subtracting
output if not pertinent for a group
2002-11-09 NN
- Put Garry's writedata() function back in.
- added "rn" to my list of UA's
- Started using %distinct_agent for both User agent
sections
- named it newsstat.pl version 0.3
2002-11-06 NN
- Fixed the earliest/latest file problem by using
mtime rather than ctime, and simplifying the logic
2002-11-05 NN
- moved user configurations to the top
- fixed the cross-posting section
- introduced the $newsgroup_name variable which
later becomes $news$group
- changed $name to $agent_name in countagents()
 
Contributors
-------------
NN Nomen nominandum (name to be determined later)
PE Thomas 'PointedEars' Lahn <startrek@PointedEars.de>
############################################################################
# RECENT CHANGES #
# 2011-10-03 PE - Use more compatible shebang
# - Fixed some Perl::Critic-ized code
# - Fixed wrong indent for non-ASCII names
# - Formatted source code
# 2011-07-03 PE - Use Encode to decode/encode MIME encodings
# - Use warnings, utf8 (just in case)
# - Documentation update
# N/A NN - Take newsgroup name as argument
# 2004-06-19 NN - newsgroup name is $ARGV[0]
# - Allow command line flags for subtracting
# output if not pertinent for a group
# 2002-11-09 NN - Put Garry's writedata() function back in.
# - added "rn" to my list of UA's
# - Started using %distinct_agent for both User agent
# sections
# - named it newsstat.pl version 0.3
# 2002-11-06 NN - Fixed the earliest/latest file problem by using
# mtime rather than ctime, and simplifying the logic
# 2002-11-05 NN - moved user configurations to the top
# - fixed the cross-posting section
# - introduced the $newsgroup_name variable which
# later becomes $news$group
# - changed $name to $agent_name in countagents()
#
# Contributors
# -------------
# NN Nomen nominandum (name to be determined later)
# PE Thomas 'PointedEars' Lahn <startrek@PointedEars.de>
/trunk/tools/network/news/newsstat/newsstat.pl
1,35 → 1,80
#!/usr/bin/env perl
use strict;
use warnings;
use diagnostics;
use utf8;
use encoding 'utf-8';
use Encode;
 
## Print out all text to STDOUT UTF-8 encoded
binmode STDOUT, ':encoding(UTF-8)';
###########################
# newsstat.pl version 0.4.2
 
############################
## newsstat.pl version 0.4.3
############################################################################
# Collect statistics about a newsgroup (specified by first argument) in
# the local news spool. Check all articles in the last 30-day period.
# Rank posters by number of posts and by volume of posts, report on top and
# bottom 20 posters. Show their name, number of posts, size of posts,
# percentage of quoted lines. Rank user-agents used, by poster rather than
# by post. Rank top 20 threads. Rank top 10 cross-posted groups.
#
# (Numbers and paths can be configured below. -- PE)
############################################################################
 
###########################################################################
## Collect statistics about a newsgroup (specified by first argument)
## in the local news spool. Check all articles in the last 30-day period.
## Rank posters by number of posts and by volume of posts, report on top
## and bottom 20 posters. Show their name, number of posts, size of posts,
## percentage of quoted lines. Rank user-agents used, by poster rather
## than by post. Rank top 20 threads. Rank top 10 cross-posted groups.
##
## Numbers and paths can be configured below. See ChangeLog and TODO
## for more. -- PE
###########################################################################
############################################################################
# RECENT CHANGES #
# 2011-10-03 PE - Use more compatible shebang
# - Fixed some Perl::Critic-ized code
# - Fixed wrong indent for non-ASCII names
# - Formatted source code
# 2011-07-03 PE - Use Encode to decode/encode MIME encodings
# - Use warnings, utf8 (just in case)
# - Documentation update
# N/A NN - Take newsgroup name as argument
# 2004-06-19 NN - newsgroup name is $ARGV[0]
# - Allow command line flags for subtracting
# output if not pertinent for a group
# 2002-11-09 NN - Put Garry's writedata() function back in.
# - added "rn" to my list of UA's
# - Started using %distinct_agent for both User agent
# sections
# - named it newsstat.pl version 0.3
# 2002-11-06 NN - Fixed the earliest/latest file problem by using
# mtime rather than ctime, and simplifying the logic
# 2002-11-05 NN - moved user configurations to the top
# - fixed the cross-posting section
# - introduced the $newsgroup_name variable which
# later becomes $news$group
# - changed $name to $agent_name in countagents()
#
# Contributors
# -------------
# NN Nomen nominandum (name to be determined later)
# PE Thomas 'PointedEars' Lahn <startrek@PointedEars.de>
 
########### TODO #############
# Commas in bottom section of report
# Show date the figures were compiled
# No. of HTML articles (Content-Type: text/html)
# No. of quoted sigs (/>\s*-- /)
# Per cent of top-posted articles
# Top 10 cross-posters
# Top 20 news posting hosts (from Path)
# Count of certain subject words: newbie, kde, burner, sendmail, etc.
# Count *all* User Agents that each poster uses
# What do we do about Bill Unruh's ] quote style?
# Change the way dates/times are checked
# include % share in posters by no. of arts
# include % share in posters by size
# Total, orig & quoted lines by user agent with per cent
# Take more arguments
#######################################################
 
###################### USER CONFIGURATIONS ############################
 
## The name of the group to do stats for
# The name of the group to do stats for
my $newsgroup_name = $ARGV[0];
$newsgroup_name or &usage;
 
## Check for removal flags
# Check for removal flags
my $ix;
my $j;
my %skipSec;
52,25 → 97,25
$skipSec{$_} = 1;
}
 
## Leafnode users will want /var/spool/news for this variable.
# Leafnode users will want /var/spool/news for this variable.
my $news = "/var/spool/news/";
 
## How many days are we doing statistics for?
# How many days are we doing statistics for?
my $numdays = 30;
 
## Number of agents we list
# no. of agents we list
my $topagents = 10;
 
## Number of threads we want to know about
# no. of threads we want to know about
my $topthreads = 20;
 
## Number of top or bottom posters to show
# no. of top or bottom posters to show
my $topposters = 20;
 
## Number of cross-posted threads to show
# no. of cross-posted threads to show
my $topcrossposts = 10;
 
## Number of time zones to show
# no. of time zones to show
my $toptz = 10;
 
###################### DATA STRUCTURES ######################
100,32 → 145,30
my $replies = 0; # total no. of replies
my $i; # general purpose
my %distinct_agent;
 
## Used to hold counts of User Agents used
my %agents = (
"Compuserver" => 0,
"Foorum" => 0,
my %agents = # used to hold counts of User Agents used
(
"KNode" => 0,
"Pan" => 0,
"Mozilla" => 0,
"Sylpheed" => 0,
"Gnus" => 0,
"Forte Agent" => 0,
"Forte Free Agent" => 0,
"Gnus" => 0,
"KNode" => 0,
"MacSOUP" => 0,
"MT-NewsWatcher" => 0,
"MicroPlanet Gravity" => 0,
"Microsoft Outlook Express" => 0,
"Microsoft Windows Mail" => 0,
"Mozilla" => 0,
"News Rover" => 0,
"NN" => 0,
"Pan" => 0,
"rn" => 0,
"Xnews" => 0,
"slrn" => 0,
"Sylpheed" => 0,
"tin" => 0,
"VSoup" => 0,
"rn" => 0,
"NN" => 0,
"MacSOUP" => 0,
"Foorum" => 0,
"MT-NewsWatcher" => 0,
"News Rover" => 0,
"WebTV" => 0,
"Xnews" => 0
);
"Compuserver" => 0,
"VSoup" => 0
);
 
######################## MAIN CODE ########################
$! = 1;
135,22 → 178,22
while ( defined( $filename = readdir(DIR) ) )
{
%lcheader = ();
next unless -f $filename; # only want real files
next if ( $filename eq ".overview" ); # real articles only
next if ( -M $filename > $numdays ); # only want articles <= a certain age
next unless -f $filename; # only want real files
next if ( $filename eq ".overview" ); # real articles only
next if ( -M $filename > $numdays ); # only want articles <= a certain age
$earliest = ( stat $filename )[9] unless defined($earliest);
$latest = ( stat $filename )[9] unless defined($latest);
&get_article($filename); # read in the article
&get_data; # grab the data from the article
$totalposts++; # bump count of articles considered
&getarticle($filename); # read in the article
&getdata; # grab the data from the article
$totalposts++; # bump count of articles considered
}
closedir(DIR); # finished with the directory
closedir(DIR); # finished with the directory
 
## Post-processing
&count_agents; # count agents, collapsing versions
&fix_percent; # check percentages orig/total for posters
# post-processing
&countagents; # count agents, collapsing versions
&fixpercent; # check percentages orig/total for posters
 
&write_data;
&writedata;
 
#################### DISPLAY RESULTS #####################
print "=" x 76, "\n";
165,15 → 208,15
printf "Latest article: %s\n", scalar localtime($latest);
printf "Original articles: %s, replies: %s\n", commify($origposts),
commify($replies);
printf "Total size of posts: %s bytes (%s KiB) (%.2f MiB)\n", commify($totsize),
printf "Total size of posts: %s bytes (%sK) (%.2fM)\n", commify($totsize),
commify( int( $totsize / 1024 ) ), $totsize / 1048576; #
printf "Average %s articles per day, %.2f MiB per day, %s bytes per article\n",
printf "Average %s articles per day, %.2f MB per day, %s bytes per article\n",
commify( int( $totalposts / $numdays ) ), $totsize / $numdays / 1048576,
commify( int( $totsize / $totalposts ) );
my $count = keys %data;
printf "Total headers: %s KiB bodies: %s KiB\n",
printf "Total headers: %s KB bodies: %s KB\n",
commify( int( $totheader / 1024 ) ), commify( int( $totbody / 1024 ) );
printf "Body text - quoted: %s KiB, original: %s KiB = %02.2f%%, sigs: %s KiB\n",
printf "Body text - quoted: %s KB, original: %s KB = %02.2f%%, sigs: %s KB\n",
commify( int( $totquoted / 1024 ) ), commify( int( $totorig / 1024 ) ),
( $totorig * 100 ) / ( $totorig + $totquoted ),
commify( int( $totsig / 1024 ) );
182,12 → 225,12
$count = keys %threads;
printf "Total number of threads: %s, average %s bytes per thread\n",
commify($count), commify( int( $totsize / $count ) ); #/
printf "Total number of user agents: %d\n", scalar keys %agents;
printf "Total number of User-Agents: %d\n", scalar keys %agents;
print "\n", "=" x 76, "\n";
 
########################################
## Show posters by article count Sec 1;
########################################
###############################
# show posters by article count Sec 1;
###############################
unless ( $skipSec{1} )
{
if ( keys %data < $topposters )
212,9 → 255,9
print "\n", "=" x 76, "\n";
}
 
######################################
## Show posters by size in KiB Sec 2;
######################################
################################
# show posters by size in Kbytes Sec 2;
################################
unless ( $skipSec{2} )
{
if ( keys %data < $topposters )
225,7 → 268,7
{
$count = $topposters;
}
printf "%s\n", &centred( "Top $count posters by article size in KiB", 76 );
printf "%s\n", &centred( "Top $count posters by article size in Kbytes", 76 );
print "=" x 76, "\n";
$i = 0;
foreach my $poster ( sort { $data{$b}{size} <=> $data{$a}{size} } keys %data )
238,9 → 281,9
print "\n", "=" x 76, "\n";
}
 
#####################################
## Show top posters for original text
#####################################
####################################
# show top posters for original text
####################################
unless ( $skipSec{3} )
{
if ( keys %data < $topposters )
270,9 → 313,9
print "\n", "=" x 76, "\n";
}
 
########################################
## Show bottom posters for original text
########################################
#######################################
# show bottom posters for original text
#######################################
unless ( $skipSec{4} )
{
if ( keys %data < $topposters )
302,9 → 345,9
print "\n", "=" x 76, "\n";
}
 
#####################################
## Show threads by number of articles
#####################################
####################################
# show threads by number of articles
####################################
unless ( $skipSec{5} )
{
if ( keys %threads < $topthreads )
330,10 → 373,9
}
print "\n", "=" x 76, "\n";
}
 
##############################
## Show threads by size in KiB
##############################
################################
# show threads by size in Kbytes
################################
unless ( $skipSec{6} )
{
if ( keys %threads < $topthreads )
344,7 → 386,7
{
$count = $topthreads;
}
printf "%s\n", &centred( "Top $count threads by size in KiB", 76 );
printf "%s\n", &centred( "Top $count threads by size in KB", 76 );
print "=" x 76, "\n";
$i = 0;
foreach my $thread (
360,9 → 402,9
print "\n", "=" x 76, "\n";
}
 
##################################
## Show top 10 cross-posted groups
##################################
#################################
# show top 10 cross-posted groups
#################################
unless ( $skipSec{7} )
{
delete $crossposts{"$newsgroup_name"}; # don't include ours
386,10 → 428,9
}
print "\n", "=" x 76, "\n";
}
 
#########################
## Show agents and counts
#########################
#######################
#show agents and counts
#######################
unless ( $skipSec{8} )
{
if ( keys %agents < $topagents )
413,7 → 454,7
}
 
#######################
## Show distinct agents
#show distinct agents
#######################
unless ( $skipSec{9} )
{
441,9 → 482,9
print "\n", "=" x 76, "\n";
}
 
############################
## Show timezones and counts
############################
##########################
#show timezones and counts
##########################
unless ( $skipSec{10} )
{
if ( keys %tz < $toptz )
467,15 → 508,15
 
################################ SUBROUTINES ################################
 
########################################
## Get current article's header and body
########################################
sub get_article
#######################################
# get current article's header and body
#######################################
sub getarticle
{
%headers = (); # dump old headers
my $filename = shift; # get the name of the file
 
## get stats about the file itself
# get stats about the file itself
$filesize = -s $filename; # get total size of file
$totsize += $filesize; # bump total sizes of all files
 
489,13 → 530,13
$latest = $mtime;
}
 
## now read the file
open( my $FILE, '<', $filename ) or die "Can't open $filename: $!\n";
# now read the file
open( my $FILE, $filename ) or die "Can't open $filename: $!\n";
while (<$FILE>)
{
$totheader += length($_); # bump total header size
last if (/^\s*$/); # end of header?
if (/^([^:\s]*):\s*(.*)/)
if (/^([^:\s]*):\s+(.*)/)
{
my ( $key, $val ) = ( $1, $2 );
$headers{$key} = decode( 'MIME-Header', $val );
504,29 → 545,19
}
@body = <$FILE>; # slurp up body
close($FILE);
} # get_article
} # getarticle
 
####################################
## Get data from the current article
####################################
sub get_data
###################################
# get data from the current article
###################################
sub getdata
{
#### First, analyse header fields ####
 
## Set up this poster if not defined, get counts, sizes
# Set up this poster if not defined, get counts, sizes
my $poster = $headers{From}; # get the poster's name
# Convert old to new format
$poster =~ s/^\s*(.+?\@.+?)\s*\((.+?)\)\s*$/$2 <$1>/;
# Collapse whitespace
$poster =~ s/\s+/ /;
# Remove outer quotes
$poster =~ s/^["'](.+?)["']\s+(.*)/$1 $2/;
if ( !defined( $data{$poster} ) )
{ # seen this one before?
{ # seen this one before?
$data{$poster}{agent} = 'Unknown'; # comes after For: field
$data{$poster}{orig} = 0;
$data{$poster}{quoted} = 0;
534,8 → 565,8
$data{$poster}{count}++; # bump count for this poster
$data{$poster}{size} += $filesize; # total size of file
 
## The User-Agent and/or X-Newsreader fields
## for User-Agent by poster
# The User-Agent and/or X-Newsreader fields
# for User-Agent by poster
if ( defined $lcheader{"user-agent"} )
{
$data{$poster}{agent} = $lcheader{"user-agent"};
545,7 → 576,7
$data{$poster}{agent} = $lcheader{"x-newsreader"};
}
 
## The User Agent for User-Agent by number of posts
# The User Agent for User-Agent by number of posts
my $UA = "unknown";
foreach my $keys ( keys %lcheader )
{
596,14 → 627,11
if ( $raw =~ /^microsoft/i ) { $raw =~ s/-/ /g; }
 
## Pick out the popular agents
if (
$raw =~ /(outlook express)/i
|| $raw =~ /(windows mail)/i
|| $raw =~ /(microplanet gravity)/i
|| $raw =~ /(news rover)/i
|| $raw =~ /(forte agent)/i
|| $raw =~ /(forte free agent)/i
)
if ( $raw =~ /(outlook express)/i
|| $raw =~ /(microplanet gravity)/i
|| $raw =~ /(news rover)/i
|| $raw =~ /(forte agent)/i
|| $raw =~ /(forte free agent)/i )
{
$agent = $1;
}
658,13 → 686,13
return $agent;
}
 
## Get all cross-posted newsgroups
# Get all cross-posted newsgroups
for ( split /,/, $headers{"Newsgroups"} )
{
$crossposts{$_}++; # bump count for each
}
 
## Get threads
# Get threads
my $thread = $headers{"Subject"};
$thread =~ s/^re: //i; # Remove Re: or re: at start
$thread =~ s/\s+/ /g; # collapse whitespace
671,7 → 699,7
$threads{$thread}{count} += 1; # bump count of this subject
$threads{$thread}{size} += $filesize; # bump bytes for this thread
 
## Is this an original post or a reply?
# Is this an original post or a reply?
if ( defined $headers{"References"} )
{
$replies++;
681,9 → 709,9
$origposts++;
}
 
## Get the time zone
# Get the time zone
$_ = $headers{"Date"};
my ($tz) = /\d\d:\d\d(?::\d\d)?\s+(.*)/;
my ($tz) = /\d\d:\d\d:\d\d\s+(.*)/;
if ( ( $tz =~ /UTC/ ) or ( $tz =~ /GMT/ ) or ( $tz =~ /0000/ ) )
{
$tz = "UTC";
700,7 → 728,7
{
$totsig += length($_); # bump total sig size
 
## Bill Unruh uses ] quotes, and another poster uses ::
# Bill Unruh uses ] quotes, and another poster uses ::
}
elsif ( /^\s*[>\]]/ or /^\s*::/ )
{ # are we in a quote line?
714,19 → 742,19
else
{
 
## We must be processing an original line
# we must be processing an original line
$data{$poster}{orig} += length($_); # bump count of original chrs
$totorig += length($_);
}
} # end for (@body)
 
} # get_data
} # getdata
 
#########################################
## Count the User-Agents used, collapsing
## different versions into one per agent.
#########################################
sub count_agents
########################################
# Count the User-Agents used, collapsing
# different versions into one per agent.
########################################
sub countagents
{
POSTER:
foreach my $poster ( keys %data )
741,12 → 769,12
}
$agents{ $data{$poster}{agent} }++;
}
} # count_agents
} # countagents
 
#############################################
## Set orig/total percentages for all posters
#############################################
sub fix_percent
############################################
# set orig/total percentages for all posters
############################################
sub fixpercent
{
foreach my $poster ( keys %data )
{
765,16 → 793,16
}
}
 
###############################
## Right pad a string with '.'s
###############################
##############################
# right pad a string with '.'s
##############################
sub rpad
{
## Get text to pad, length to pad, pad chr
# get text to pad, length to pad, pad chr
my ( $text, $pad_len, $pad_chr ) = @_;
 
## DEBUG
#printf "|%s| = %d\n", $text, length($text);
### DEBUG
# printf "|%s| = %d\n", $text, length($text);
 
if ( length($text) > $pad_len )
{
784,9 → 812,9
return $padded;
}
 
##################
## Centre a string
##################
#################
# centre a string
#################
sub centred
{
my ( $text, $width ) = @_; # text to centre, size of field to centre in
795,24 → 823,25
return $centred;
}
 
###########################
## Put commas into a number
###########################
##########################
# put commas into a number
##########################
sub commify
{
local $_ = shift;
1 while s/^([-+]?\d+)(\d{3})/$1,$2/;
$_ = shift;
1 while s/^(-?\d+)(\d{3})/$1,$2/;
return $_;
}
 
################################################################
## Returns a string with leading and trailing whitespace removed
################################################################
#########################
# clean
#########################
sub clean
{
my $dirty = shift;
my $clean = $dirty;
$clean =~ s/^\s*|\s*$//g;
$clean =~ s/^\s*//;
$clean =~ s/\s*$//;
 
return $clean;
}
819,18 → 848,18
 
sub usage
{
 
print "usage: newstat.pl newsgroupname\n";
exit 1;
}
 
##################################
## Write data structures to a file
##################################
sub write_data
###################################
# Write data structures to a file #
###################################
sub writedata
{
open my $OUTF, ">:encoding(UTF-8)", "/tmp/XDATA"
or die "Can't create XDATA: $!\n";
print $OUTF "Data collected from $newsgroup_name\n\n";
open my $OUTF, ">/tmp/XDATA" or die "Can't create XDATA: $!\n";
print $OUTF "Data collected from alt.os.linux.mandrake\n\n";
print $OUTF
"Poster Data\nname : agent : count : size: orig : quoted : per cent\n";
foreach my $name ( keys %data )
857,7 → 886,7
{
print $OUTF "$name : $crossposts{$name}\n";
}
print $OUTF
print $OUTF print $OUTF
"============================================================================\n";
print $OUTF "User agents\n";
print $OUTF
876,4 → 905,4
print $OUTF "$name : $tz{$name}\n";
}
close $OUTF;
} # write_data
} # writedata