Skip to content

Commit

Permalink
Merge pull request #946 from xexyl/open-dir-file-jparse
Browse files Browse the repository at this point in the history 
Move open_json_dir_file to open_dir_file (util.c)
  • Loading branch information
@lcn2
lcn2 authored Aug 28, 2024
2 parents e9d7877 + 7515d40 commit ee6e7f0
Show file tree
Hide file tree
Showing 6 changed files with 163 additions and 197 deletions.
8 changes: 8 additions & 0 deletions CHANGES.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Major changes to the IOCCC entry toolkit


## Release 1.5.1 2024-08-28

Move `open_json_dir_file()` from `chkentry.c` to `open_dir_file()` in
`jparse/util.c`.

Updated `MKIOCCCENTRY_REPO_VERSION` version to "1.5.1 2024-08-28".


## Release 1.5 2024-08-27

Prep for "**Release 1.5 2024-08-27**".
Expand Down
182 changes: 12 additions & 170 deletions chkentry.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,21 @@
*
* "Because grammar and syntax alone do not make a complete language." :-)
*
* This tool was improved by:
* This tool and the JSON parser were co-developed in 2022-2024 by Cody Boone
* Ferguson and Landon Curt Noll:
*
* @xexyl
* https://xexyl.net Cody Boone Ferguson
* https://ioccc.xexyl.net
* and:
* chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\
*
* "Because sometimes even the IOCCC Judges need some help." :-)
*
* The concept of the JSON semantics tables was developed by Landon Curt Noll.
*
* "Share and Enjoy!"
* -- Sirius Cybernetics Corporation Complaints Division, JSON spec department. :-)
*
* Copyright (c) 2022-2024 by Landon Curt Noll. All Rights Reserved.
*
* Permission to use, copy, modify, and distribute this software and
* its documentation for any purpose and without fee is hereby granted,
* provided that the above copyright, this permission notice and text
* this comment, and the disclaimer below appear in all of the following:
*
* supporting documentation
* source copies
* source works derived from this source
* binaries derived from this source or from derived source
*
* LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
* EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
* USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*
* chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\
*
* Share and enjoy! :-)
*/


Expand All @@ -50,7 +29,6 @@
#include <stdio.h>
#include <unistd.h>
#include <ctype.h>
#include <fcntl.h> /* for open() */

/*
* chkentry - check JSON files in an IOCCC submission
Expand Down Expand Up @@ -105,144 +83,8 @@ static const char * const usage_msg =
/*
* functions
*/
static FILE *open_json_dir_file(char const *dir, char const *file);
static void usage(int exitcode, char const *prog, char const *str) __attribute__((noreturn));


/*
* open_json_dir_file - open a readable JSON file in a given directory
*
* Temporarily chdir to the directory, if non-NULL, try to open the file,
* and then chdir back to the current directory.
*
* If dir == NULL, just try to open the file without a chdir.
*
* given:
* dir directory into which we will temporarily chdir or
* NULL ==> do not chdir
* file path of readable JSON file to open
*
* returns:
* open readable JSON file stream
*
* NOTE: This function does not return if path is NULL,
* if we cannot chdir to a non-NULL dir, if not a readable file,
* or if unable to open file.
*
* NOTE: This function will NOT return NULL.
*/
static FILE *
open_json_dir_file(char const *dir, char const *file)
{
FILE *ret_stream = NULL; /* open file stream to return */
int ret = 0; /* libc function return */
int cwd = -1; /* current working directory */

/*
* firewall
*/
if (file == NULL) {
err(10, __func__, "called with NULL file");
not_reached();
}

/*
* note the current directory so we can restore it later, after the chdir(work_dir) below
*/
errno = 0; /* pre-clear errno for errp() */
cwd = open(".", O_RDONLY|O_DIRECTORY|O_CLOEXEC);
if (cwd < 0) {
errp(11, __func__, "cannot open .");
not_reached();
}

/*
* Temporarily chdir if dir is non-NULL
*/
if (dir != NULL && cwd >= 0) {

/*
* check if we can search / work within the directory
*/
if (!exists(dir)) {
err(12, __func__, "directory does not exist: %s", dir);
not_reached();
}
if (!is_dir(dir)) {
err(13, __func__, "is not a directory: %s", dir);
not_reached();
}
if (!is_exec(dir)) {
err(14, __func__, "directory is not searchable: %s", dir);
not_reached();
}

/*
* chdir to to the directory
*/
errno = 0; /* pre-clear errno for errp() */
ret = chdir(dir);
if (ret < 0) {
errp(15, __func__, "cannot cd %s", dir);
not_reached();
}
}

/*
* must be a readable file
*/
if (!exists(file)) {
err(16, __func__, "file does not exist: %s", file);
not_reached();
}
if (!is_file(file)) {
err(17, __func__, "file is not a regular file: %s", file);
not_reached();
}
if (!is_read(file)) {
err(18, __func__, "file is not a readable file: %s", file);
not_reached();
}

/*
* open the readable JSON file
*/
errno = 0; /* pre-clear errno for errp() */
ret_stream = fopen(file, "r");
if (ret_stream == NULL) {
errp(19, __func__, "cannot open file: %s", file);
not_reached();
}

/*
* if we did a chdir to dir, chdir back to cwd
*/
if (dir != NULL && cwd >= 0) {

/*
* switch back to the previous current directory
*/
errno = 0; /* pre-clear errno for errp() */
ret = fchdir(cwd);
if (ret < 0) {
errp(20, __func__, "cannot fchdir to the previous current directory");
not_reached();
}
errno = 0; /* pre-clear errno for errp() */
ret = close(cwd);
if (ret < 0) {
errp(21, __func__, "close of previous current directory failed");
not_reached();
}
}

/*
* return open stream
*/
return ret_stream;
}


/*
* usage - print usage to stderr
*
Expand Down Expand Up @@ -423,19 +265,19 @@ main(int argc, char *argv[])
* open the .info.json file under submission_dir
*/
info_filename = ".info.json";
info_stream = open_json_dir_file(submission_dir, info_filename);
info_stream = open_dir_file(submission_dir, info_filename);
if (info_stream == NULL) { /* paranoia */
err(22, __func__, "info_stream = open_json_dir_file(%s, %s) returned NULL", submission_dir, info_filename);
err(22, __func__, "info_stream = open_dir_file(%s, %s) returned NULL", submission_dir, info_filename);
not_reached();
}

/*
* open the .auth.json file under submission_dir
*/
auth_filename = ".auth.json";
auth_stream = open_json_dir_file(submission_dir, auth_filename);
auth_stream = open_dir_file(submission_dir, auth_filename);
if (auth_stream == NULL) { /* paranoia */
err(23, __func__, "auth_stream = open_json_dir_file(%s, %s) returned NULL", submission_dir, auth_filename);
err(23, __func__, "auth_stream = open_dir_file(%s, %s) returned NULL", submission_dir, auth_filename);
not_reached();
}

Expand All @@ -448,9 +290,9 @@ main(int argc, char *argv[])
* open the .info.json file unless it is .
*/
if (strcmp(info_filename, ".") != 0) {
info_stream = open_json_dir_file(NULL, info_filename);
info_stream = open_dir_file(NULL, info_filename);
if (info_stream == NULL) { /* paranoia */
err(24, __func__, "open_json_dir_file for returned NULL for .info.json path: %s", info_filename);
err(24, __func__, "open_dir_file returned NULL for .info.json path: %s", info_filename);
not_reached();
}
} else {
Expand All @@ -461,9 +303,9 @@ main(int argc, char *argv[])
* open the .auth.json file unless it is .
*/
if (strcmp(auth_filename, ".") != 0) {
auth_stream = open_json_dir_file(NULL, auth_filename);
auth_stream = open_dir_file(NULL, auth_filename);
if (auth_stream == NULL) { /* paranoia */
err(25, __func__, "open_json_dir_file for returned NULL for .auth.json path: %s", auth_filename);
err(25, __func__, "open_dir_file returned NULL for .auth.json path: %s", auth_filename);
not_reached();
}
} else {
Expand Down
29 changes: 4 additions & 25 deletions chkentry.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,21 @@
*
* "Because grammar and syntax alone do not make a complete language." :-)
*
* This tool was improved by:
* This tool and the JSON parser were co-developed in 2022-2024 by Cody Boone
* Ferguson and Landon Curt Noll:
*
* @xexyl
* https://xexyl.net Cody Boone Ferguson
* https://ioccc.xexyl.net
* and:
* chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\
*
* "Because sometimes even the IOCCC Judges need some help." :-)
*
* The concept of the JSON semantics tables was developed by Landon Curt Noll.
*
* "Share and Enjoy!"
* -- Sirius Cybernetics Corporation Complaints Division, JSON spec department. :-)
*
* Copyright (c) 2022-2024 by Landon Curt Noll. All Rights Reserved.
*
* Permission to use, copy, modify, and distribute this software and
* its documentation for any purpose and without fee is hereby granted,
* provided that the above copyright, this permission notice and text
* this comment, and the disclaimer below appear in all of the following:
*
* supporting documentation
* source copies
* source works derived from this source
* binaries derived from this source or from derived source
*
* LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
* EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
* USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*
* chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\
*
* Share and enjoy! :-)
*/


Expand Down
Loading

0 comments on commit ee6e7f0

Please sign in to comment.