eb0f6fec8fcc84eda27e5b6b597decdab90c453b
[kopensolaris-gnu/glibc.git] / nss / nss_files / files-XXX.c
1 /* Common code for file-based databases in nss_files module.
2    Copyright (C) 1996, 1997 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #include <stdio.h>
21 #include <ctype.h>
22 #include <assert.h>
23 #include <errno.h>
24 #include <fcntl.h>
25 #include <bits/libc-lock.h>
26 #include "nsswitch.h"
27
28 /* These symbols are defined by the including source file:
29
30    ENTNAME -- database name of the structure and functions (hostent, pwent).
31    STRUCTURE -- struct name, define only if not ENTNAME (passwd, group).
32    DATABASE -- string of the database file's name ("hosts", "passwd").
33
34    NEED_H_ERRNO - defined iff an arg `int *herrnop' is used.
35
36    Also see files-parse.c.
37 */
38
39 #define ENTNAME_r       CONCAT(ENTNAME,_r)
40
41 #define DATAFILE        "/etc/" DATABASE
42
43 #ifdef NEED_H_ERRNO
44 # include <netdb.h>
45 # define H_ERRNO_PROTO  , int *herrnop
46 # define H_ERRNO_ARG    , herrnop
47 # define H_ERRNO_SET(val) (*herrnop = (val))
48 #else
49 # define H_ERRNO_PROTO
50 # define H_ERRNO_ARG
51 # define H_ERRNO_SET(val) ((void) 0)
52 #endif
53
54 /* Locks the static variables in this file.  */
55 __libc_lock_define_initialized (static, lock)
56 \f
57 /* Maintenance of the shared stream open on the database file.  */
58
59 static FILE *stream;
60 static fpos_t position;
61 static enum { none, getent, getby } last_use;
62 static int keep_stream;
63
64 /* Open database file if not already opened.  */
65 static enum nss_status
66 internal_setent (int stayopen)
67 {
68   enum nss_status status = NSS_STATUS_SUCCESS;
69
70   if (stream == NULL)
71     {
72       stream = fopen (DATAFILE, "r");
73
74       if (stream == NULL)
75         status = errno == EAGAIN ? NSS_STATUS_TRYAGAIN : NSS_STATUS_UNAVAIL;
76       else
77         {
78           /* We have to make sure the file is  `closed on exec'.  */
79           int result, flags;
80
81           result = flags = fcntl (fileno (stream), F_GETFD, 0);
82           if (result >= 0)
83             {
84               flags |= FD_CLOEXEC;
85               result = fcntl (fileno (stream), F_SETFD, flags);
86             }
87           if (result < 0)
88             {
89               /* Something went wrong.  Close the stream and return a
90                  failure.  */
91               fclose (stream);
92               stream = NULL;
93               status = NSS_STATUS_UNAVAIL;
94             }
95         }
96     }
97   else
98     rewind (stream);
99
100   /* Remember STAYOPEN flag.  */
101   if (stream != NULL)
102     keep_stream |= stayopen;
103
104   return status;
105 }
106
107
108 /* Thread-safe, exported version of that.  */
109 enum nss_status
110 CONCAT(_nss_files_set,ENTNAME) (int stayopen)
111 {
112   enum nss_status status;
113
114   __libc_lock_lock (lock);
115
116   status = internal_setent (stayopen);
117
118   if (status == NSS_STATUS_SUCCESS && fgetpos (stream, &position) < 0)
119     {
120       fclose (stream);
121       stream = NULL;
122       status = NSS_STATUS_UNAVAIL;
123     }
124
125   last_use = getent;
126
127   __libc_lock_unlock (lock);
128
129   return status;
130 }
131
132
133 /* Close the database file.  */
134 static void
135 internal_endent (void)
136 {
137   if (stream != NULL)
138     {
139       fclose (stream);
140       stream = NULL;
141     }
142 }
143
144
145 /* Thread-safe, exported version of that.  */
146 enum nss_status
147 CONCAT(_nss_files_end,ENTNAME) (void)
148 {
149   __libc_lock_lock (lock);
150
151   internal_endent ();
152
153   /* Reset STAYOPEN flag.  */
154   keep_stream = 0;
155
156   __libc_lock_unlock (lock);
157
158   return NSS_STATUS_SUCCESS;
159 }
160 \f
161 /* Parsing the database file into `struct STRUCTURE' data structures.  */
162
163 static enum nss_status
164 internal_getent (struct STRUCTURE *result,
165                  char *buffer, int buflen H_ERRNO_PROTO)
166 {
167   char *p;
168   struct parser_data *data = (void *) buffer;
169   int linebuflen = buffer + buflen - data->linebuffer;
170   int parse_result;
171
172   if (buflen < (int) sizeof *data + 1)
173     {
174       __set_errno (ERANGE);
175       H_ERRNO_SET (NETDB_INTERNAL);
176       return NSS_STATUS_TRYAGAIN;
177     }
178
179   do
180     {
181       /* Terminate the line so that we can test for overflow.  */
182       data->linebuffer[linebuflen - 1] = '\0';
183
184       p = fgets (data->linebuffer, linebuflen, stream);
185       if (p == NULL)
186         {
187           /* End of file or read error.  */
188           H_ERRNO_SET (HOST_NOT_FOUND);
189           return NSS_STATUS_NOTFOUND;
190         }
191       else if (data->linebuffer[linebuflen - 1] != '\0')
192         {
193           /* The line is too long.  Give the user the opportunity to
194              enlarge the buffer.  */
195           __set_errno (ERANGE);
196           H_ERRNO_SET (NETDB_INTERNAL);
197           return NSS_STATUS_TRYAGAIN;
198         }
199
200       /* Skip leading blanks.  */
201       while (isspace (*p))
202         ++p;
203     }
204   while (*p == '\0' || *p == '#' /* Ignore empty and comment lines.  */
205          /* Parse the line.  If it is invalid, loop to get the next
206             line of the file to parse.  */
207          || ! (parse_result = parse_line (p, result, data, buflen)));
208
209   /* Filled in RESULT with the next entry from the database file.  */
210   return parse_result == -1 ? NSS_STATUS_TRYAGAIN : NSS_STATUS_SUCCESS;
211 }
212
213
214 /* Return the next entry from the database file, doing locking.  */
215 enum nss_status
216 CONCAT(_nss_files_get,ENTNAME_r) (struct STRUCTURE *result,
217                                   char *buffer, size_t buflen H_ERRNO_PROTO)
218 {
219   /* Return next entry in host file.  */
220   enum nss_status status = NSS_STATUS_SUCCESS;
221
222   __libc_lock_lock (lock);
223
224   /* Be prepared that the set*ent function was not called before.  */
225   if (stream == NULL)
226     status = internal_setent (0);
227
228   if (status == NSS_STATUS_SUCCESS)
229     {
230       /* If the last use was not by the getent function we need the
231          position the stream.  */
232       if (last_use != getent)
233         if (fsetpos (stream, &position) < 0)
234           status = NSS_STATUS_UNAVAIL;
235         else
236           last_use = getent;
237
238       if (status == NSS_STATUS_SUCCESS)
239         {
240           status = internal_getent (result, buffer, buflen H_ERRNO_ARG);
241
242           /* Remember this position if we were successful.  If the
243              operation failed we give the user a chance to repeat the
244              operation (perhaps the buffer was too small).  */
245           if (status == NSS_STATUS_SUCCESS)
246             fgetpos (stream, &position);
247           else
248             /* We must make sure we reposition the stream the next call.  */
249             last_use = none;
250         }
251     }
252
253   __libc_lock_unlock (lock);
254
255   return status;
256 }
257 \f
258 /* Macro for defining lookup functions for this file-based database.
259
260    NAME is the name of the lookup; e.g. `hostbyname'.
261
262    KEYSIZE and KEYPATTERN are ignored here but used by ../nss_db/db-XXX.c.
263
264    PROTO describes the arguments for the lookup key;
265    e.g. `const char *hostname'.
266
267    BREAK_IF_MATCH is a block of code which compares `struct STRUCTURE *result'
268    to the lookup key arguments and does `break;' if they match.  */
269
270 #define DB_LOOKUP(name, keysize, keypattern, break_if_match, proto...)        \
271 enum nss_status                                                               \
272 _nss_files_get##name##_r (proto,                                              \
273                           struct STRUCTURE *result,                           \
274                           char *buffer, size_t buflen H_ERRNO_PROTO)          \
275 {                                                                             \
276   enum nss_status status;                                                     \
277                                                                               \
278   __libc_lock_lock (lock);                                                    \
279                                                                               \
280   /* Reset file pointer to beginning or open file.  */                        \
281   status = internal_setent (keep_stream);                                     \
282                                                                               \
283   if (status == NSS_STATUS_SUCCESS)                                           \
284     {                                                                         \
285       /* Tell getent function that we have repositioned the file pointer.  */ \
286       last_use = getby;                                                       \
287                                                                               \
288       while ((status = internal_getent (result, buffer, buflen H_ERRNO_ARG))  \
289              == NSS_STATUS_SUCCESS)                                           \
290         { break_if_match }                                                    \
291                                                                               \
292       if (! keep_stream)                                                      \
293         internal_endent ();                                                   \
294     }                                                                         \
295                                                                               \
296   __libc_lock_unlock (lock);                                                  \
297                                                                               \
298   return status;                                                              \
299 }