summaryrefslogtreecommitdiff
path: root/fml/lib/FML/String/Random.pm
blob: 972fe1623c27141a63ef27ac13f4a3bb7bbc11b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
#-*- perl -*-
#
#  Copyright (C) 2008 Ken'ichi Fukamachi
#   All rights reserved. This program is free software; you can
#   redistribute it and/or modify it under the same terms as Perl itself.
#
# $FML: @template.pm,v 1.12 2008/08/24 08:28:36 fukachan Exp $
#

package FML::String::Random;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;

=head1 NAME

FML::String::Random - create a random string.

=head1 SYNOPSIS

    my $random = new FML::String::Random;
    my $magic = $random->magic_string();
    my $id    = $random->identifier($magic);

=head1 DESCRIPTION

This class generates a magic string and the identifier used for the
session ID.

=head1 METHODS

=head2 new()

constructor.

=cut


# Descriptions: constructor.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: OBJ
sub new
{
    my ($self) = @_;
    my ($type) = ref($self) || $self;
    my $me     = {};
    return bless $me, $type;
}


=head2 magic_string()

generate a random magic string.

Currently, the string is a combination of

    qw(a b c d e f g h k m n p r s t x y z 2 3 4 5 6 8);

letters.

=cut


# Descriptions: generate a random magic string.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: STR
sub magic_string
{
    my ($self) = @_;

    # XXX Crypt::RandPasswd may be too slow sometimes.

    my (@string) = qw(a b c d e f g h k m n p r s t x y z 2 3 4 5 6 8);
    my ($strlen) = $#string;
    my (@result) = ();

    srand(time|$$);
    for (my $i = 0; $i < 8; $i++) {
	my $j = int(rand($strlen));
	$result[ $i ] = $string[ $j ];
    }

    return join("", @result);
}


=head2 identifier($buf)

generate an identifier from $buf. It is used for the session ID.

=cut


# Descriptions: generate an identifier from $buf.
#    Arguments: OBJ($self) STR($buf)
# Side Effects: none
# Return Value: STR
sub identifier
{
    my ($self, $buf) = @_;

    my ($id_01) = sprintf("%s %s %s", rand(time), $$, $buf);
    my ($id_02) = sprintf("%s %s %s", $$, $buf, rand(time));

    use Mail::Message::Checksum;
    my $cksum  = new Mail::Message::Checksum;
    my $sum    = $cksum->md5( \$id_01 );
    my $sum_ya = $cksum->md5( \$id_02 );
    my $pebot  = int(rand(32));
    my $sum_l  = substr($sum, 0, $pebot -1);
    my $sum_r  = substr($sum, $pebot + 1, 32 - $pebot);
    return sprintf("%s%s%s", $sum_r, $sum_ya, $sum_l);
}


#
# DEBUG
#
if ($0 eq __FILE__) {
    my $random = new FML::String::Random;
    my $magic = $random->magic_string();
    my $id    = $random->identifier($magic);
    printf("magic string = %s\n", $magic);
    printf("identifier   = %s\n", $id);
}


=head1 CODING STYLE

See C<http://www.fml.org/software/FNF/> on fml coding style guide.

=head1 AUTHOR

Ken'ichi Fukamachi

=head1 COPYRIGHT

Copyright (C) 2008 Ken'ichi Fukamachi

All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.

=head1 HISTORY

FML::String::Random appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.

=cut


1;