ipott.co.uk: web display current netware logins

Article

PERL - Web-display of Current NetWare Logins

About this article:

Using PERL to generates a HTML output of currently logged-in users on a Novell Netware system.
The PERL script runs on a regular PC logged in to the Novell server. This PC may also be running Apache webserver to serve the HTML file, which is the case here.

Script Language:
Perl

Name:
currentlogins.pl

Platform:
Win32 (for running script). Tested on NetWare 4.11, 5.0 & 6.0

Author:
Dr. Duncan J. Potter, 2005.

Requirements:

The Script utilises Novell's NLIST function which requires a Win32 PC login with the Novell NetWare Client.
The login under which the script runs also requires sufficient NDS/eDirectory permissions to read usernames & fullnames.

Features:

Periodically scan several named NDS/eDirectory containers for logged-in users.
Output results in HTML format with hyperlinks to an external staff directory for each user display.
Optionally exclude specified users from display.

The Script

#!c:/perl/bin/perl.exe
#######################################################################################
#
# Name:  currentlogins.pl
#
# Description:
# Produces list of usernames and matching full names from Novell's NLIST function
# with each username/fullname pair on a new line.
#
# Author:	Dr. Duncan J. Potter ( http://www.ipott.co.uk)
# Version 	7.0
# Date:	April 2005
# Last Modified: November 2007
#
#######################################################################################
# Output of command:
#   nlist user where "name" = acc* show "full name" /a /c 
#
#	Object Class: User
#	Current context: mycontext.myOU.myORG
#	User: SomAdmin
#		Network Address: 
#			IPX/SPX Network Address
#			Network: 89C3505B
#			Node: 6097D49A9E
#			Socket: 4318
#		Full Name: SOM Admin
#	User: ACCMAK
#		Network Address: 
#			IPX/SPX Network Address
#			Network: 89C3505B
#			Node: 6097C825C3
#			Socket: 4030
#		Full Name: Mike Kerrison
#	User: checrjs1
#		Network Address: 
#			IPX/SPX Network Address
#			Network: 89C3AC6B
#			Node: 1
#			Socket: 45E9
#		Network Address: 
#			IPX/SPX Network Address
#			Network: 89C3AC6B
#			Node: 1
#			Socket: 45E3
#		Full Name: Mr Christopher R J Sharpe
#	User: chellc
#		Network Address: 
#			IPX/SPX Network Address
#			Network: 89C3BF00
#			Node: B0D08ACAC0
#			Socket: 44F8
#		Full Name: Mr Luk L Chan#
#
#######################################################################################
#
# Problems:
# Multiple logins with same username generate multiple nodes, but always
# preceeded by a 'user:' and followed by an 'Full Name:' line.
#
#######################################################################################

#--------------- User defined variables --------------------------------

# Required:
# Decide whether to loop at 3 minute (180 second) intervals, set to '0' if no repeat.
$scan_interval = 0;

# Optional:
# Define the HTML output file. If commented out, no HTML output will be generated.
# $htmlfile ='c:/temp/userlist.html'; 	
$htmlfile ='users.shtml';

#--- Specify folder to output HTML files
$html_doc_root ='c:/apache2/htdocs';

#--- Specify web location of above folder
$html_web_root='http://www.mycompany.com';

# Optional - see below:
#$NDSroot = '.myORG';

# Optional:
# Define the file holding OUs to be searched for active users
# If this is commented out, the root context MUST be supplied and
# all subcontexts will be searched:
$contextsfile = 'c:\perl\stafflogins\contexts.txt';

# Optional
# Names of excluded users (hide from view)
$excludefile ='c:\perl\stafflogins\exclude.txt';

#--------------- end of user defined variables --------------------------
# Clear output screen:
system(cls);

# Assign an interrupt handler:
$SIG{'INT'} = 'INT_handler';

# Determine list of NDS contexts to scan for active user.
&get_contexts_list;

# Scan these contexts:
&scan_contexts;

# Get excluded users
&get_excluded_users;

# Display results 
&display_results($htmlfile);

# Check if looping is required

if ($scan_interval > 0)  { 
   $scancount=1;
   &scan_loop;
}
 
#--- end of main code -----------------------------------------

################### subroutines ########################################

sub scan_loop {
     print "\n";
     print "Starting Autoscan at $scan_interval seconds.\n";
     sleep($scan_interval);

while(1) {
        $scancount++;
	&scan_contexts;
        &display_results($htmlfile);

print "\n \n";
 	print "SML Staff Logins - Perl Script by Duncan Potter\n";
	print "----- Press CTRL + BREAK to end cycle -----\n\n";
        print "Autoscan number: $scancount\n";
        print "    Scan interval: $scan_interval seconds\n";
	print "    NDS Containers Scanned: $num_of_contexts \n";
	print "    Excluded Users: $num_excluded\n";
	print "    People Logged In: $#people_sorted\n\n";

sleep($scan_interval);
    }
}

#------------------
sub get_excluded_users {
# Called Just Once
# Cycles through names $excluded_users
  open EXCLUDE_FILE, $excludefile or die "Cannot open $excludefile for read :$!";
  while (<EXCLUDE_FILE>) {
       s/^\s+//;	#Trim leading/trailing whitespace and newlines.
       s/\s+$//;
       if (length($_) >=2) {
         push (@excludedusers, $_);
       }	
  }
  close EXCLUDE_FILE;

#Determine the number of people to exclude, important if it happens to be zero for some reason.
  $num_excluded = $#excludedusers;

} # end of subroutine

# --------------------
sub get_contexts_list{
# Called Just Once
# If $contextsfile is specified, read list of containers from that file
#   else
# set context to be $NDSroot variable (just one context then, the '\s' in NLIST 
# takes care of looking for active users in the tree).
#

# Test if $NDSroot variable is set and if so, don't look for $contextsfile:
if (length($NDSroot) >1 ){
  $containers[0] = $NDSroot;
  $num_of_contexts =1;
}

# Execute this code if $NDSroot isn't define:
if (length($NDSroot) < 1 ){
  open CONTEXTSFILE, $contextsfile or die "Cannot open $contextsfile for read :$!";
  $num_of_contexts =0;
  while (<CONTEXTSFILE>) {
       s/^\s+//;	#Trim leading/trailing whitespace and newlines.
       s/\s+$//;
       if (length($_) >=2) {
         push (@containers, $_);
	 $num_of_contexts++;		# Increment number of contexts.
       }	
  }
  close CONTEXTSFILE;
}
} # end of subroutine

#------------------
sub scan_contexts {
# Main Subroutine, called each iteration.
# Cycles through contexts in @containers, read from $contextsfile.
# Scans each contexts for active users.
#
$count = 0;
print"Use CTRL + BREAK to halt execution:\n \n";

foreach (@containers) {
  # Cycle through containers, looking for active users in each:
  $count++;
  $context = $_;	
  print "Scanning active users in container $context ... ($count / $num_of_contexts)"; 
  &activeusers;
  }

# Clear arrays:
$#people_sorted = -1;

# Sort the results from &activeusers
@people_sorted = sort @people;

# And clear the 'people' array so it's empty for next scan cycle.
$#people = -1;

print "NDS Context scanning complete. Processing, please wait ...";
}

#---------------
sub activeusers {
# Called every iteration by &scan_contexts.
# Get active users in context (variable) with node (hardware) address:

# Open the results file for writing
# open(OUTPUTFILE,">$outputfile");

# Use Novells NLIST command to generate a list of username and fullnames for specified 
# context. Use of '\s' allows $context to be given as the tree root when NLIST will
# scan every subcontainer; with a list of contexts the '\s' switch is mostly irrelevant.
# @users = `nlist user where "name" = acc* show "full name", "network address" /a /c /co ".mycontext.myOU.myORG"`;

$#users= -1;
@users = `nlist user show "full name" /a /c /s /co "$context"`;

# Cycle through each line of $users array. Create a hash key list for each user with the
# key pairs $username and a composite variable of '$username $fullname $node'.
# The hash key list is called %userdata and by default has no values.
# Note if a person is logged in more than once there will be more than one
# node address for that person and on a separate line.

# Clear arrays and counters:
$#line = -1;
$usercount =0;
foreach(@users) {
    @line = split /:/, $_; 	#Split current line at colon into variable name and value.

foreach (@line) {		#Trim leading/trailing whitespace and newlines.
        s/^\s+//;
        s/\s+$//;
     }

#     if ($line[0] eq 'User') {
#         $usercount = $usercount +1;
#         $username = lc($line[1]);
#     }

if ($line[0] eq 'Full Name') {
        $fullname = $line[1];
        push (@people, $fullname);
        # $outstring = $outstring . '<br>' .$fullname ;
        # print OUTPUTFILE "$username, $fullname \n";
     }

}

#close OUTPUTFILE;

# Simple sorted printout of the hash table:
# print "Userdata Hash Key for users in context $context: \n";
# foreach (sort keys %userdata) {
#    print "The key $_ contains $userdata{$_}\n";
# }

} #of subroutine

#------------------
sub display_results {

#--- Reminder of variables
#--- $html_doc_root ='c:/apache2/htdocs';
#--- $html_web_root='http://www.mycompany.com';

#--- Get name of html file to write.
my $htmlfile= @_[0];

system(cls);
$datetime = scalar(localtime);

# If HTML file is required, open it.
if (length($htmlfile) >4) {
   open HTMLFILE, ">$html_doc_root$htmlfile" or die "Cannot open $html_doc_root$htmlfile for write :$!";
   print HTMLFILE <<PRT;   
<html>
<head>
<title>IT Section</title>
<link href="dropdown.css" rel="stylesheet" media="screen">
<link rel="shortcut icon" href="/favicon.ico" />
<link rel="icon" href="/favicon.ico" />
<script type="text/javascript" src="menu.js"></script>
PRT

print HTMLFILE "<META HTTP-EQUIV=Refresh CONTENT=\"60; URL=$html_web_root$htmlfile\">\n ";
print HTMLFILE <<PRT; 
</head>
<body>
<div id="container">
<div class="smlheader"></div>
<p id="smurf">Welcome to the IT Section</p>
 
<div id="content"><p>
<P>
PRT

print HTMLFILE "<H2>Current NetWare Logins</h2><h3>$datetime</h3><P>Click on any name below to show People Finder results.<P>\n";
print HTMLFILE "<div style=\"margin-left:3em;\"><div class=\"stafflist\"> \n";
PRT
}

# Work out the number of people logged in
$num_logins = $#people_sorted;

# Specify the number of columns
$num_cols=3;

# Count Number of Columns written
$column=0;

# Work out the number of people per column:
$column_limit = int($num_logins/$num_cols)+1;

#Initialise a counter for number of people displayed
$peoplecount=0;

#Initialise a counter for dividing into columns
$people_in_column=0;
foreach (@people_sorted){

# Check if the person's name happens to be on the excluded list
   $name_of_user = $_;
	
   # Set a flag on whether we exclude a user or not
   $exclude=0;
   foreach (@excludedusers){
	if (/($name_of_user)/i){
	   $exclude=1;
	}
   }

#From fullname, identify surname to be used in LDAP search:
	&lookup_name($_);
			
   # Print person's name if *not* excluded
   if ($exclude==0){
     $people_in_column++;
     $peoplecount++;
	 
		# Handle the end-of-columns condition
		if ($people_in_column==$column_limit) {
			# Reset the people-per-column counter
			$people_in_column=0;
			
			# Increment the current column number
			$column++;
			
			# Close preceding DIV, if we're on DIV 2 or 3:
			if ($column>=1) {
					#  columns are 0,1 & 2. For columns 1 & 2, need to close the preceding DIV. 
					print HTMLFILE "</div> \n";
			} 
			
			# And start a new DIV:
			print HTMLFILE "<div class=\"stafflist\">\n<a href=\"http://www.mycompany.com/home/contact_results?surname=$fullname_lookup&search_type=staff\">$_</a><br>\n";
		} else {
			# Print in current column of existing DIV:
			print HTMLFILE "<a  href=\"http://www.mycompany.com/home/contact_results?surname=$fullname_lookup&search_type=staff\">$_</a><br>\n";
		}
   }

} # end of foreach(@people_sorted)

# Finish the table holding logged-in users

if (length($htmlfile) >4) {
   print HTMLFILE <<PRT; 
</div>
</div>
<div style="clear:both;"> </div>
<P>Script author: <a href="http://www.ipott.co.uk">Dr. Duncan J. Potter</a> (<a href="http://www.ipott.co.uk/novell_currentlogins.html">source code</a>)<br>
NDS Containers Scanned: $num_of_contexts    
Raw NLIST Lines: $#users     
People Identified: $#people_sorted    
 "
PRT

# Error handling code:
	if ($peoplecount==0){
  	   print HTMLFILE "<br>Script exits after zero people were displayed as being logged in.</font>";
	   close HTMLFILE;		
           exit(0);
	}

close HTMLFILE;
}
  
} #end of subroutine

#----------------
sub INT_handler {
    # close all files.
    # send error message to log file.
    print "Closing ...\n";
    exit(0);
}

sub lookup_name {
		# Splits the $fullname string and identifies the surname, used for hyperlink to HW email lookup.
		# Can have fullnames of:
		#	Type 1. James Jones
		# 	Type2. James E. Jones
		#	Type3. James Jones (PhD Stud)

my $fullname= @_[0];
		# $` returns everything before the matched string. $' returns everything after the matched string
		if ( $fullname =~ m/\(/) {
			# Student name found with a '('
			# Trim down text to that before the matchd character:
			$fullname_trim = $`;
			#Split the name by spaces
			@names = split/\s/, $fullname_trim;
			#Surname will be the last item in the array - which has index $#names
			$fullname_lookup = $names[$#names]; 
			return $fullname_lookup;
		} 
		
		@names = split/\s/, $fullname;
		$fullname_lookup = $names[$#names];
		
		return $fullname_lookup;
}

Using the Script Yourself

The above script may be freely copied and modified for use on your own site, only please retain the author information.
It is provided as is without warranty or support in the interests of sharing helpful information. The script is hard coded to refer to paths in use at this site but shouldn't be difficult to adapt to your own environment.

The contexts.txt file simply lists the NDS/eDirectory contexts to be scanned, one per line, e.g.

.mycontext.myOU.myORG
.myOthercontext.myOU.myORG

and the exclude.txt is simply a list of full names not to be displayed (not usernames, but the full name) e.g.

Dave Smith
Boris Kharlof

Running the Script Periodically

A variety of mechanisms may be used to call the script periodically. The one used here is to emply the (free) Sinc32 utility to call the Perl script every minute from a DOS batch file (this proved the easiest way). The format of the sinctab.stf file in which one specifies the items to be run is as follows:

# From left to right the time fields are:
#- minute
#- hour
#- day of month
#- month
#- day of week
#  Process to run
#
# Execute the Staff Logins batch file every minute.
* * * * * C:\stafflogins\stafflogins.bat

Good luck! :-)

ipott.co.uk

Links

PERL - Web-display of Current NetWare Logins

The Script

Using the Script Yourself

Running the Script Periodically