1 /* pathchk -- check whether file names are valid or portable
2 Copyright (C) 1991-2017 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include <sys/types.h>
27 /* The official name of this program (e.g., no 'g' prefix). */
28 #define PROGRAM_NAME "pathchk"
31 proper_name ("Paul Eggert"), \
32 proper_name ("David MacKenzie"), \
33 proper_name ("Jim Meyering")
35 #ifndef _POSIX_PATH_MAX
36 # define _POSIX_PATH_MAX 256
38 #ifndef _POSIX_NAME_MAX
39 # define _POSIX_NAME_MAX 14
42 #ifdef _XOPEN_NAME_MAX
43 # define NAME_MAX_MINIMUM _XOPEN_NAME_MAX
45 # define NAME_MAX_MINIMUM _POSIX_NAME_MAX
47 #ifdef _XOPEN_PATH_MAX
48 # define PATH_MAX_MINIMUM _XOPEN_PATH_MAX
50 # define PATH_MAX_MINIMUM _POSIX_PATH_MAX
53 #if ! (HAVE_PATHCONF && defined _PC_NAME_MAX && defined _PC_PATH_MAX)
55 # define _PC_NAME_MAX 0
56 # define _PC_PATH_MAX 1
59 # define pathconf(file, flag) \
60 (flag == _PC_NAME_MAX ? NAME_MAX_MINIMUM : PATH_MAX_MINIMUM)
64 static bool validate_file_name (char *, bool, bool);
66 /* For long options that have no equivalent short option, use a
67 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
70 PORTABILITY_OPTION
= CHAR_MAX
+ 1
73 static struct option
const longopts
[] =
75 {"portability", no_argument
, NULL
, PORTABILITY_OPTION
},
76 {GETOPT_HELP_OPTION_DECL
},
77 {GETOPT_VERSION_OPTION_DECL
},
84 if (status
!= EXIT_SUCCESS
)
88 printf (_("Usage: %s [OPTION]... NAME...\n"), program_name
);
90 Diagnose invalid or unportable file names.\n\
92 -p check for most POSIX systems\n\
93 -P check for empty names and leading \"-\"\n\
94 --portability check for all POSIX systems (equivalent to -p -P)\n\
96 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
97 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
98 emit_ancillary_info (PROGRAM_NAME
);
104 main (int argc
, char **argv
)
107 bool check_basic_portability
= false;
108 bool check_extra_portability
= false;
111 initialize_main (&argc
, &argv
);
112 set_program_name (argv
[0]);
113 setlocale (LC_ALL
, "");
114 bindtextdomain (PACKAGE
, LOCALEDIR
);
115 textdomain (PACKAGE
);
117 atexit (close_stdout
);
119 while ((optc
= getopt_long (argc
, argv
, "+pP", longopts
, NULL
)) != -1)
123 case PORTABILITY_OPTION
:
124 check_basic_portability
= true;
125 check_extra_portability
= true;
129 check_basic_portability
= true;
133 check_extra_portability
= true;
136 case_GETOPT_HELP_CHAR
;
138 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
141 usage (EXIT_FAILURE
);
147 error (0, 0, _("missing operand"));
148 usage (EXIT_FAILURE
);
151 for (; optind
< argc
; ++optind
)
152 ok
&= validate_file_name (argv
[optind
],
153 check_basic_portability
, check_extra_portability
);
155 return ok
? EXIT_SUCCESS
: EXIT_FAILURE
;
158 /* If FILE contains a component with a leading "-", report an error
159 and return false; otherwise, return true. */
162 no_leading_hyphen (char const *file
)
166 for (p
= file
; (p
= strchr (p
, '-')); p
++)
167 if (p
== file
|| p
[-1] == '/')
169 error (0, 0, _("leading '-' in a component of file name %s"),
177 /* If FILE (of length FILELEN) contains only portable characters,
178 return true, else report an error and return false. */
181 portable_chars_only (char const *file
, size_t filelen
)
183 size_t validlen
= strspn (file
,
185 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
186 "abcdefghijklmnopqrstuvwxyz"
188 char const *invalid
= file
+ validlen
;
192 mbstate_t mbstate
= { 0, };
193 size_t charlen
= mbrlen (invalid
, filelen
- validlen
, &mbstate
);
195 _("nonportable character %s in file name %s"),
196 quotearg_n_style_mem (1, locale_quoting_style
, invalid
,
197 (charlen
<= MB_LEN_MAX
? charlen
: 1)),
198 quoteaf_n (0, file
));
205 /* Return the address of the start of the next file name component in F. */
207 static char * _GL_ATTRIBUTE_PURE
208 component_start (char *f
)
215 /* Return the size of the file name component F. F must be nonempty. */
217 static size_t _GL_ATTRIBUTE_PURE
218 component_len (char const *f
)
221 for (len
= 1; f
[len
] != '/' && f
[len
]; len
++)
227 strlen (FILE) <= PATH_MAX
228 && strlen (each-existing-directory-in-FILE) <= NAME_MAX
230 If CHECK_BASIC_PORTABILITY is true, compare against _POSIX_PATH_MAX and
231 _POSIX_NAME_MAX instead, and make sure that FILE contains no
232 characters not in the POSIX portable filename character set, which
233 consists of A-Z, a-z, 0-9, ., _, - (plus / for separators).
235 If CHECK_BASIC_PORTABILITY is false, make sure that all leading directories
236 along FILE that exist are searchable.
238 If CHECK_EXTRA_PORTABILITY is true, check that file name components do not
241 If either CHECK_BASIC_PORTABILITY or CHECK_EXTRA_PORTABILITY is true,
242 check that the file name is not empty.
244 Return true if all of these tests are successful, false if any fail. */
247 validate_file_name (char *file
, bool check_basic_portability
,
248 bool check_extra_portability
)
250 size_t filelen
= strlen (file
);
252 /* Start of file name component being checked. */
255 /* True if component lengths need to be checked. */
256 bool check_component_lengths
;
258 /* True if the file is known to exist. */
259 bool file_exists
= false;
261 if (check_extra_portability
&& ! no_leading_hyphen (file
))
264 if ((check_basic_portability
|| check_extra_portability
)
267 /* Fail, since empty names are not portable. As of
268 2005-01-06 POSIX does not address whether "pathchk -p ''"
269 should (or is allowed to) fail, so this is not a
270 conformance violation. */
271 error (0, 0, _("empty file name"));
275 if (check_basic_portability
)
277 if (! portable_chars_only (file
, filelen
))
282 /* Check whether a file name component is in a directory that
283 is not searchable, or has some other serious problem.
284 POSIX does not allow "" as a file name, but some non-POSIX
285 hosts do (as an alias for "."), so allow "" if lstat does. */
288 if (lstat (file
, &st
) == 0)
290 else if (errno
!= ENOENT
|| filelen
== 0)
292 error (0, errno
, "%s", quotef (file
));
297 if (check_basic_portability
298 || (! file_exists
&& PATH_MAX_MINIMUM
<= filelen
))
302 if (check_basic_portability
)
303 maxsize
= _POSIX_PATH_MAX
;
307 char const *dir
= (*file
== '/' ? "/" : ".");
309 size
= pathconf (dir
, _PC_PATH_MAX
);
310 if (size
< 0 && errno
!= 0)
313 _("%s: unable to determine maximum file name length"),
317 maxsize
= MIN (size
, SSIZE_MAX
);
320 if (maxsize
<= filelen
)
322 unsigned long int len
= filelen
;
323 unsigned long int maxlen
= maxsize
- 1;
324 error (0, 0, _("limit %lu exceeded by length %lu of file name %s"),
325 maxlen
, len
, quoteaf (file
));
330 /* Check whether pathconf (..., _PC_NAME_MAX) can be avoided, i.e.,
331 whether all file name components are so short that they are valid
332 in any file system on this platform. If CHECK_BASIC_PORTABILITY, though,
333 it's more convenient to check component lengths below. */
335 check_component_lengths
= check_basic_portability
;
336 if (! check_component_lengths
&& ! file_exists
)
338 for (start
= file
; *(start
= component_start (start
)); )
340 size_t length
= component_len (start
);
342 if (NAME_MAX_MINIMUM
< length
)
344 check_component_lengths
= true;
352 if (check_component_lengths
)
354 /* The limit on file name components for the current component.
355 This defaults to NAME_MAX_MINIMUM, for the sake of non-POSIX
356 systems (NFS, say?) where pathconf fails on "." or "/" with
358 size_t name_max
= NAME_MAX_MINIMUM
;
360 /* If nonzero, the known limit on file name components. */
361 size_t known_name_max
= (check_basic_portability
? _POSIX_NAME_MAX
: 0);
363 for (start
= file
; *(start
= component_start (start
)); )
368 name_max
= known_name_max
;
372 char const *dir
= (start
== file
? "." : file
);
376 len
= pathconf (dir
, _PC_NAME_MAX
);
379 name_max
= MIN (len
, SSIZE_MAX
);
384 /* There is no limit. */
389 /* DIR does not exist; use its parent's maximum. */
390 known_name_max
= name_max
;
395 error (0, errno
, "%s", quotef (dir
));
401 length
= component_len (start
);
403 if (name_max
< length
)
405 unsigned long int len
= length
;
406 unsigned long int maxlen
= name_max
;
410 _("limit %lu exceeded by length %lu "
411 "of file name component %s"),
412 maxlen
, len
, quote (start
));