summaryrefslogtreecommitdiff
path: root/fml/lib/FML/Sys/User.pm
blob: fb1cbbd92907e49fd9240bad1f2d33e72e5cbe10 (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
#-*- perl -*-
#
#  Copyright (C) 2003,2004,2005,2006 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: User.pm,v 1.6 2006/11/26 09:11:23 fukachan Exp $
#

package FML::Sys::User;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use Config;


=head1 NAME

FML::Sys::User - get user information on this system.

=head1 SYNOPSIS

use FML::Sys::User;
my $sys  = new FML::Sys::User $curproc;
my $list = $sys->get_user_list();

=head1 DESCRIPTION

This module provides methods to handle user information on this system.

=head1 METHODS

=head2 new()

constructor.

=cut


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


=head2 get_user_list()

return user list as HASH_REF.

=cut


# Descriptions: return user list as HASH_REF.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: HASH_REF
sub get_user_list
{
    my ($self) = @_;

    # XXX-TODO: how do we do on Windows NT ???
    return $self-> _get_user_list_on_unix();
}


# Descriptions: return user list as HASH_REF.
#               we assume all unix system has /etc/passwd.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: HASH_REF
sub _get_user_list_on_unix
{
    my ($self) = @_;
    my $users  = {};

    if (-f "/etc/passwd") {
	use FileHandle;
	my $fh = new FileHandle "/etc/passwd";
	if (defined $fh) {
	    my ($user, $buf);
	  LINE:
	    while ($buf = <$fh>) {
		($user) = split(/:/, $buf);
		$users->{ $user } = $user;
	    }

	    $fh->close();
	}
    }

    return $users;
}


#
# DEBUG
#
if ($0 eq __FILE__) {
    my $sys  = new FML::Sys::User;
    my $list = $sys->get_user_list();

    my ($k, $v);
    for my $k (sort keys %$list) {
	printf "%-20s => %s\n", $k, $list->{ $k };
    }
}


=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) 2003,2004,2005,2006 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::Sys::User appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.

=cut


1;