annotate liboctave/oct-passwd.h @ 6469:a848b846cb3a ss-2-9-10

[project @ 2007-03-27 18:42:11 by jwe]
author jwe
date Tue, 27 Mar 2007 18:42:11 +0000
parents 143b556ce725
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
1 /*
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
2
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
4
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
6
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
10 later version.
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
11
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
15 for more details.
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
16
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 3504
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 3504
diff changeset
20 02110-1301, USA.
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
21
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
22 */
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
23
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_passwd_h)
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
25 #define octave_passwd_h 1
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
26
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
27 #include <string>
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
28
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
29 #ifdef HAVE_SYS_TYPES_H
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
30 #include <sys/types.h>
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
31 #endif
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
32
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
33 class
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5307
diff changeset
34 OCTAVE_API
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
35 octave_passwd
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
36 {
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
37 public:
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
38
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
39 octave_passwd (void)
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
40 : pw_name (), pw_passwd (), pw_uid (0), pw_gid (0), pw_gecos (),
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
41 pw_dir (), pw_shell (), valid (false)
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
42 { }
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
43
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
44 octave_passwd (const octave_passwd& pw)
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
45 : pw_name (pw.pw_name), pw_passwd (pw.pw_passwd),
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
46 pw_uid (pw.pw_uid), pw_gid (pw.pw_gid), pw_gecos (pw.pw_gecos),
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
47 pw_dir (pw.pw_dir), pw_shell (pw.pw_shell), valid (pw.valid)
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
48 { }
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
49
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
50 octave_passwd& operator = (const octave_passwd& pw)
2937
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
51 {
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
52 if (this != &pw)
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
53 {
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
54 pw_name = pw.pw_name;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
55 pw_passwd = pw.pw_passwd;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
56 pw_uid = pw.pw_uid;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
57 pw_gid = pw.pw_gid;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
58 pw_gecos = pw.pw_gecos;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
59 pw_dir = pw.pw_dir;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
60 pw_shell = pw.pw_shell;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
61 valid = pw.valid;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
62 }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
63
2937
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
64 return *this;
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
65 }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
66
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
67 ~octave_passwd (void) { }
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
68
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
69 std::string name (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
70
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
71 std::string passwd (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
72
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
73 uid_t uid (void) const;
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
74
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
75 gid_t gid (void) const;
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
76
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
77 std::string gecos (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
78
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
79 std::string dir (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
80
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
81 std::string shell (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
82
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
83 bool ok (void) const { return valid; }
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
84
3145
0d640dc625c7 [project @ 1998-02-05 08:44:59 by jwe]
jwe
parents: 2937
diff changeset
85 operator bool () const { return ok (); }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
86
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
87 static octave_passwd getpwent (void);
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
88 static octave_passwd getpwent (std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
89
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
90 static octave_passwd getpwuid (uid_t uid);
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
91 static octave_passwd getpwuid (uid_t uid, std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
92
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
93 static octave_passwd getpwnam (const std::string& nm);
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
94 static octave_passwd getpwnam (const std::string& nm, std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
95
2937
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
96 static int setpwent (void);
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
97 static int setpwent (std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
98
2937
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
99 static int endpwent (void);
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
100 static int endpwent (std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
101
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
102 private:
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
103
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
104 // User name.
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
105 std::string pw_name;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
106
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
107 // Encrypted password.
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
108 std::string pw_passwd;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
109
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
110 // Numeric user id.
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
111 uid_t pw_uid;
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
112
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
113 // Numeric group id.
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
114 gid_t pw_gid;
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
115
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
116 // Miscellaneous junk.
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
117 std::string pw_gecos;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
118
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
119 // Home directory.
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
120 std::string pw_dir;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
121
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
122 // Login shell.
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
123 std::string pw_shell;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
124
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
125 // Flag that says whether we have been properly initialized.
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
126 bool valid;
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
127
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
128 // This is how we will create an octave_passwd object from a pointer
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
129 // to a struct passwd.
3504
5eef8a2294bd [project @ 2000-02-01 10:06:51 by jwe]
jwe
parents: 3145
diff changeset
130 octave_passwd (void *p, std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
131
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
132 void gripe_invalid (void) const;
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
133 };
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
134
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
135 #endif
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
136
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
137 /*
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
138 ;;; Local Variables: ***
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
139 ;;; mode: C++ ***
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
140 ;;; End: ***
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
141 */