webgui/lib/WebGUI/Session/Id.pm
Colin Kuskie f3a1f0f9f2 GroupText.t: fix number of tests
Session/Id.pm: add a method to validate GUIDs, change s/// to tr/// for efficiency.
Session.pm: change open to use new Id.pm validation method
Scratch.t: Change test from ok to is so that it tells you what the failing ID is.
Id.t: Add validation tests in addition to uniqueness tests.  Fix the uniqueness test so that it works.  Add tests to check the new validation method
2006-07-15 01:54:49 +00:00

123 lines
2.4 KiB
Perl

package WebGUI::Session::Id;
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2006 Plain Black Corporation.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict;
use Digest::MD5;
use Time::HiRes qw( gettimeofday usleep );
=head1 NAME
Package WebGUI::Session::Id;
=head1 DESCRIPTION
This package generates global unique ids, sometimes called GUIDs. A global unique ID is guaranteed to be unique everywhere and at everytime.
B<NOTE:> There is no such thing as perfectly unique ID's, but the chances of a duplicate ID are so minute that they are effectively unique.
=head1 SYNOPSIS
my $id = $session->id->generate;
=head1 METHODS
These methods are available from this class:
=cut
#-------------------------------------------------------------------
=head2 DESTROY ( )
Deconstructor.
=cut
sub DESTROY {
my $self = shift;
undef $self;
}
#-------------------------------------------------------------------
=head2 generate
This function generates a global unique id.
=cut
sub generate {
my $self = shift;
my($s,$us)=gettimeofday();
my($v)=sprintf("%09d%06d%10d%06d%255s",rand(999999999),$us,$s,$$,$self->session->config->getFilename);
my $id = Digest::MD5::md5_base64($v);
$id =~ tr{+/}{_-};
return $id;
}
#-------------------------------------------------------------------
=head2 new ( session )
Constructor.
=head3 session
A reference to the current session.
=cut
sub new {
my $class = shift;
my $session = shift;
srand;
bless {_session=>$session}, $class;
}
#-------------------------------------------------------------------
=head2 session ( )
Returns a reference to the current session.
=cut
sub session {
my $self = shift;
return $self->{_session};
}
#-------------------------------------------------------------------
=head2 valid ( $idString )
Returns true if $idString is a valid WebGUI guid.
=cut
sub valid {
my ($self, $idString) = @_;
return $idString =~ m/^[A-Za-z0-9_-]{22}$/;
}
1;