rxunixsys.cpp

Go to the documentation of this file.

/*----------------------------------------------------------------------------*/
/*                                                                            */
/* Copyright (c) 2009-2021 Rexx Language Association. All rights reserved.    */
/*                                                                            */
/* This program and the accompanying materials are made available under       */
/* the terms of the Common Public License v1.0 which accompanies this         */
/* distribution. A copy is also available at the following address:           */
/* https://www.oorexx.org/license.html                                        */
/*                                                                            */
/* Redistribution and use in source and binary forms, with or                 */
/* without modification, are permitted provided that the following            */
/* conditions are met:                                                        */
/*                                                                            */
/* Redistributions of source code must retain the above copyright             */
/* notice, this list of conditions and the following disclaimer.              */
/* Redistributions in binary form must reproduce the above copyright          */
/* notice, this list of conditions and the following disclaimer in            */
/* the documentation and/or other materials provided with the distribution.   */
/*                                                                            */
/* Neither the name of Rexx Language Association nor the names                */
/* of its contributors may be used to endorse or promote products             */
/* derived from this software without specific prior written permission.      */
/*                                                                            */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS        */
/* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT          */
/* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS          */
/* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
/* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,      */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED   */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,        */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY     */
/* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING    */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS         */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.               */
/*                                                                            */
/*----------------------------------------------------------------------------*/
 
 
#include "rxunixsys.h"
 
 
/**
 * Function:      SysSignal
 *
 * Change a signal behavior.
 *
 * @param signum  The signal number.
 *
 * @param sigact  The new signal action.
 *
 * @return        Function return code
 */
RexxRoutine2(int,
             SysSignal,
             int, signum,
             CSTRING, sigact)
{
 
    if (strlen(sigact) == 0) {
        context->InvalidRoutine();
        return 0;
    }
    // According to POSIX we should only allow the following values for this function
    else if (*sigact == 'D' || *sigact == 'd') {
        signal(signum, SIG_DFL);
        return 0;
    }
    else if (*sigact == 'I' || *sigact == 'i') {
        signal(signum, SIG_IGN);
        return 0;
    }
    context->InvalidRoutine();
    return 0;
}
 
 
/**
 * Method:        SysUname
 *
 * Return the uname information.
 *
 * @param ichar   The option string.
 *
 * @return        Option information
 */
RexxRoutine1(RexxObjectPtr,
             SysUname,
             OPTIONAL_CSTRING, ichar)
{
    struct utsname name;
 
    uname(&name);
    if (ichar == NULL || *ichar == 'S' || *ichar == 's') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(name.sysname);
    }
    else if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(name.nodename);
    }
    else if (*ichar == 'R' || *ichar == 'r') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(name.release);
    }
    else if (*ichar == 'V' || *ichar == 'v') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(name.version);
    }
    else if (*ichar == 'M' || *ichar == 'm') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(name.machine);
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysSetsid
 *
 * Set the Session id.
 *
 * @return        Process id
 */
RexxRoutine0(RexxObjectPtr,
             SysSetsid)
{
    pid_t pid;
 
    pid = setsid();
    return context->WholeNumberToObject((wholenumber_t)pid);
}
 
 
/**
 * Method:        SysGetsid
 *
 * Get the Session id.
 *
 * @param pid     The pid.
 *
 * @return        Session id
 */
RexxRoutine1(RexxObjectPtr,
             SysGetsid,
             int, pid)
{
    pid = getsid((pid_t)pid);
    return context->WholeNumberToObject((wholenumber_t)pid);
}
 
 
/**
 * Method:        SysSetuid
 *
 * Set the userid.
 *
 * @param uid     The userid.
 *
 * @return        0 or -1
 */
RexxRoutine1(RexxObjectPtr,
             SysSetuid,
             int, uid)
{
    setgroups(0, NULL);
    return context->WholeNumberToObject((wholenumber_t)setuid((uid_t)uid));
}
 
 
/**
 * Method:        SysGetuid
 *
 * Get the userid.
 *
 * @return        uid
 */
RexxRoutine0(RexxObjectPtr,
             SysGetuid)
{
 
    return context->WholeNumberToObject((wholenumber_t)getuid());
}
 
 
/**
 * Method:        SysSeteuid
 *
 * Set the effective userid.
 *
 * @param uid     The userid.
 *
 * @return        0 or -1
 */
RexxRoutine1(RexxObjectPtr,
             SysSeteuid,
             int, uid)
{
 
    return context->WholeNumberToObject((wholenumber_t)seteuid((uid_t)uid));
}
 
 
/**
 * Method:        SysGeteuid
 *
 * Get the effective userid.
 *
 * @return        uid
 */
RexxRoutine0(RexxObjectPtr,
             SysGeteuid)
{
 
    return context->WholeNumberToObject((wholenumber_t)geteuid());
}
 
 
/**
 * Method:        SysSetgid
 *
 * Set the groupid.
 *
 * @param gid     The groupid.
 *
 * @return        0 or -1
 */
RexxRoutine1(RexxObjectPtr,
             SysSetgid,
             int, gid)
{
 
    return context->WholeNumberToObject((wholenumber_t)setgid((gid_t)gid));
}
 
 
/**
 * Method:        SysGetgid
 *
 * Get the groupid.
 *
 * @return        0 or -1
 */
RexxRoutine0(RexxObjectPtr,
             SysGetgid)
{
 
    return context->WholeNumberToObject((wholenumber_t)getgid());
}
 
 
/**
 * Method:        SysSetegid
 *
 * Set the effective groupid.
 *
 * @param gid     The groupid.
 *
 * @return        0 or -1
 */
RexxRoutine1(RexxObjectPtr,
             SysSetegid,
             int, gid)
{
    return context->WholeNumberToObject((wholenumber_t)setegid((gid_t)gid));
}
 
 
/**
 * Method:        SysGetegid
 *
 * Get the effective groupid.
 *
 * @return        0 or -1
 */
RexxRoutine0(RexxObjectPtr,
             SysGetegid)
{
 
    return context->WholeNumberToObject((wholenumber_t)getegid());
}
 
 
/**
 * Method:        SysSetpgrp
 *
 * Set the pgrp.
 *
 * @return        0 or -1
 */
RexxRoutine0(RexxObjectPtr,
             SysSetpgrp)
{
#if defined(OPENBSD) || defined(OPSYS_NETBSD) || defined(OPSYS_FREEBSD)
    return context->WholeNumberToObject((wholenumber_t)setpgrp(0, 0));
#else
    return context->WholeNumberToObject((wholenumber_t)setpgrp());
#endif
}
 
 
/**
 * Method:        SysGetpgrp
 *
 * Get the pgrp.
 *
 * @return        0 or -1
 */
RexxRoutine0(RexxObjectPtr,
             SysGetpgrp)
{
 
    return context->WholeNumberToObject((wholenumber_t)getpgrp());
}
 
 
/**
 * Method:        SysSetpgid
 *
 * Set the pgid.
 *
 * @param pid1    The pid to set.
 *
 * @param pid2    The new pid.
 *
 * @return        0 or -1
 */
RexxRoutine2(RexxObjectPtr,
             SysSetpgid,
             int, pid1,
             int, pid2)
{
 
    return context->WholeNumberToObject((wholenumber_t)setpgid((pid_t)pid1, (pid_t)pid2));
}
 
 
/**
 * Method:        SysGetpgid
 *
 * Get the pgid.
 *
 * @param pid1    The pid to query.
 *
 * @return        The pid.
 */
RexxRoutine1(RexxObjectPtr,
             SysGetpgid,
             int, pid)
{
 
    return context->WholeNumberToObject((wholenumber_t)getpgid((pid_t)pid));
}
 
 
/**
 * Method:        SysGetpid
 *
 * Get the pid.
 *
 * @return        pid
 */
RexxRoutine0(RexxObjectPtr,
             SysGetpid)
{
    pid_t pid = getpid();
    return context->WholeNumberToObject((wholenumber_t)pid);
}
 
 
/**
 * Method:        SysGetppid
 *
 * Get the ppid.
 *
 * @return        pid
 */
RexxRoutine0(RexxObjectPtr,
             SysGetppid)
{
    pid_t pid = getppid();
    return context->WholeNumberToObject((wholenumber_t)pid);
}
 
 
/**
 * Method:        SysGettid
 *
 * Get the tid.
 *
 * @return        tid
 */
RexxRoutine0(RexxObjectPtr,
             SysGettid)
{
    pthread_t tid = pthread_self();
    return context->UnsignedInt64ToObject((uint64_t)tid);
}
 
 
/**
 * Method:        SysKill
 *
 * Kill a process.
 *
 * @param pid1    The pid to kill.
 *
 * @param sig1    The signal to send.
 *
 * @return        return code
 */
RexxRoutine2(int,
             SysKill,
             int, pid1,
             int, sig1)
{
    return kill((pid_t)pid1, sig1);
}
 
 
/**
 * Method:        SysSymlink
 *
 * Create a symbolic link.
 *
 * @param path1   The source path.
 *
 * @param path2   The target path.
 *
 * @return        int error code
 */
RexxRoutine2(int,
             SysSymlink,
             CSTRING, path1,
             CSTRING, path2)
{
    return symlink(path1, path2);
}
 
 
/**
 * Method:        SysLink
 *
 * Create a hard link.
 *
 * @param path1   The source path.
 *
 * @param path2   The target path.
 *
 * @return        int error code
 */
RexxRoutine2(int,
             SysLink,
             CSTRING, path1,
             CSTRING, path2)
{
    return link(path1, path2);
}
 
 
/**
 * Method:        SysUnlink
 *
 * Remove a hard or soft link.
 *
 * @param path1   The source path.
 *
 * @return        int error code
 */
RexxRoutine1(int,
             SysUnlink,
             CSTRING, path1)
{
    return unlink(path1);
}
 
 
/**
 * Method:        SysChown
 *
 * Change the owner and group of a file.
 *
 * @param path1   The file path.
 *
 * @param uid     The new userid.
 *
 * @param gid     The new groupid.
 *
 * @return        int error code
 */
RexxRoutine3(int,
             SysChown,
             CSTRING, path1,
             int, uid,
             int, gid)
{
    return chown(path1, (uid_t)uid, (gid_t)gid);
}
 
 
/**
 * Method:        SysLchown
 *
 * Change the owner and group of a file.
 *
 * @param path1   The file path.
 *
 * @param uid     The new userid.
 *
 * @param gid     The new groupid.
 *
 * @return        int error code
 */
RexxRoutine3(int,
             SysLchown,
             CSTRING, path1,
             int, uid,
             int, gid)
{
    return lchown(path1, (uid_t)uid, (gid_t)gid);
}
 
 
/**
 * Method:        SysChroot
 *
 * Changes the root directory of the calling process.
 *
 * @param path1   The new root path.
 *
 * @return        int error code
 */
RexxRoutine1(int,
             SysChroot,
             CSTRING, path1)
{
    int ignore; // avoid warning: ignoring return value of 'int chdir(const char*)'
 
    ignore = chdir("/");
    return chroot(path1);
}
 
 
/**
 * Method:        SysUmask
 *
 * Sets the calling process umask.
 *
 * @param nmask   The new umask.
 *
 * @return        the old umansk value
 */
RexxRoutine1(int,
             SysUmask,
             int, nmask)
{
    return umask((mode_t)nmask);
}
 
 
/**
 * Method:        SysClose
 *
 * Close a file handle.
 *
 * @param nmask   The file handle to close.
 *
 * @return        the return code from the C close function
 */
RexxRoutine1(int,
             SysClose,
             int, fh)
{
    return close(fh);
}
 
 
/**
 * Method:        SysGetpwnam
 *
 * Return user name information from the passwd file.
 *
 * @param user    The user name.
 *
 * @param ichar   The option string.
 *
 * @return        Option information
 */
RexxRoutine2(RexxObjectPtr,
             SysGetpwnam,
             CSTRING, user,
             CSTRING, ichar)
{
    if (strlen(user) == 0 || strlen(ichar) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    struct passwd *pw = getpwnam(user);
    if (pw == NULL) {
        return context->NullString();
    }
    else if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_name);
    }
    else if (*ichar == 'U' || *ichar == 'u') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)pw->pw_uid);
    }
    else if (*ichar == 'G' || *ichar == 'g') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)pw->pw_gid);
    }
    else if (*ichar == 'R' || *ichar == 'r') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_gecos);
    }
    else if (*ichar == 'D' || *ichar == 'd') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_dir);
    }
    else if (*ichar == 'S' || *ichar == 's') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_shell);
    }
    else if (*ichar == 'P' || *ichar == 'p') {
        return context->NullString();
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysGetpwuid
 *
 * Return user name information from the passwd file.
 *
 * @param user    The uid.
 *
 * @param ichar   The option string.
 *
 * @return        Option information
 */
RexxRoutine2(RexxObjectPtr,
             SysGetpwuid,
             int, uid,
             CSTRING, ichar)
{
    if (strlen(ichar) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    struct passwd *pw = getpwuid((uid_t)uid);
    if (pw == NULL) {
        return context->NullString();
    }
    else if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_name);
    }
    else if (*ichar == 'U' || *ichar == 'u') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)pw->pw_uid);
    }
    else if (*ichar == 'G' || *ichar == 'g') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)pw->pw_gid);
    }
    else if (*ichar == 'R' || *ichar == 'r') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_gecos);
    }
    else if (*ichar == 'D' || *ichar == 'd') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_dir);
    }
    else if (*ichar == 'S' || *ichar == 's') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(pw->pw_shell);
    }
    else if (*ichar == 'P' || *ichar == 'p') {
        return context->NullString();
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysGetgrnam
 *
 * Return group name information from the group file.
 *
 * @param user    The group name.
 *
 * @param ichar   The option string.
 *
 * @return        Option information
 */
RexxRoutine2(RexxObjectPtr,
             SysGetgrnam,
             CSTRING, grpname,
             CSTRING, ichar)
{
    if (strlen(grpname) == 0 || strlen(ichar) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    struct group *gr = getgrnam(grpname);
    if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(gr->gr_name);
    }
    else if (*ichar == 'P' || *ichar == 'p') {
        return context->NullString();
    }
    else if (*ichar == 'G' || *ichar == 'g') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)gr->gr_gid);
    }
    else if (*ichar == 'M' || *ichar == 'm') {
        RexxArrayObject arr = context->NewArray(1);
        char **members = gr->gr_mem;
        while (*members != NULL) {
           context->ArrayAppendString(arr, *members, strlen(*members));
           members++;
        }
        return (RexxObjectPtr)arr;
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysGetgrgid
 *
 * Return group name information from the group file.
 *
 * @param user    The gid.
 *
 * @param ichar   The option string.
 *
 * @return        Option information
 */
RexxRoutine2(RexxObjectPtr,
             SysGetgrgid,
             int, gid,
             CSTRING, ichar)
{
    if (strlen(ichar) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    struct group *gr = getgrgid(gid);
    if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(gr->gr_name);
    }
    else if (*ichar == 'P' || *ichar == 'p') {
        return context->NullString();
    }
    else if (*ichar == 'G' || *ichar == 'g') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)gr->gr_gid);
    }
    else if (*ichar == 'M' || *ichar == 'm') {
        RexxArrayObject arr = context->NewArray(1);
        char **members = gr->gr_mem;
        while (*members != NULL) {
           context->ArrayAppendString(arr, *members, strlen(*members));
           members++;
        }
        return (RexxObjectPtr)arr;
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysStat
 *
 * Return information from the stat API.
 *
 * @param user    The file name.
 *
 * @param ichar   The option string.
 *
 * @return        Option information
 */
RexxRoutine2(RexxObjectPtr,
             SysStat,
             CSTRING, fname,
             CSTRING, ichar)
{
    struct tm *ftime;
    struct stat64 st;
    char buf[32];  // used for both the file times and the permissions
 
    if (strlen(fname) == 0 || strlen(ichar) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    int retc = stat64(fname, &st);
    if (retc != 0) {
        return context->NullString();
    }
    else if (*ichar == 'D' || *ichar == 'd') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)st.st_dev);
    }
    else if (*ichar == 'I' || *ichar == 'i') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)st.st_ino);
    }
    else if (*ichar == 'P' || *ichar == 'p') {
        // 1- file type
        if      (S_ISREG(st.st_mode))  strcpy(buf, "-");
        else if (S_ISDIR(st.st_mode))  strcpy(buf, "d");
        else if (S_ISLNK(st.st_mode))  strcpy(buf, "l");
        else if (S_ISSOCK(st.st_mode)) strcpy(buf, "s");
        else if (S_ISCHR(st.st_mode))  strcpy(buf, "c");
        else if (S_ISBLK(st.st_mode))  strcpy(buf, "b");
        else if (S_ISFIFO(st.st_mode)) strcpy(buf, "p");
 
        // 2 - user read
        strcat(buf, S_IRUSR & st.st_mode ? "r" : "-");
 
        // 3 - user write
        strcat(buf, S_IWUSR & st.st_mode ? "w" : "-");
 
        // 4 - user execute
        // SUID       If set, then replaces "x" in the owner permissions to "s",
        // if owner has execute permissions, or to "S" otherwise. Examples:
        // -rws------ both owner execute and SUID are set
        // -r-S------ SUID is set, but owner execute is not set
        strcat(buf, S_ISUID & st.st_mode ? (S_IXUSR & st.st_mode ? "s" : "S") : (S_IXUSR & st.st_mode ? "x" : "-"));
 
        // 5 -group read
        strcat(buf, S_IRGRP & st.st_mode ? "r" : "-");
 
        // 6 - group write
        strcat(buf, S_IWGRP & st.st_mode ? "w" : "-");
 
        // 7 - group execute
        // SGID       If set, then replaces "x" in the group permissions to "s",
        // if group has execute permissions, or to "S" otherwise. Examples:
        // -rwxrws--- both group execute and SGID are set
        // -rwxr-S--- SGID is set, but group execute is not set
        strcat(buf, S_ISGID & st.st_mode ? (S_IXGRP & st.st_mode ? "s" : "S") : (S_IXGRP & st.st_mode ? "x" : "-"));
 
        // 8 - other read
        strcat(buf, S_IROTH & st.st_mode ? "r" : "-");
 
        // 9 - other write
        strcat(buf, S_IWOTH & st.st_mode ? "w" : "-");
 
        // 10 - other execute
        // Sticky  If set, then replaces "x" in the others permissions to "t",
        // if others have execute permissions, or to "T" otherwise. Examples:
        // -rwxrwxrwt both others execute and sticky bit are set
        // -rwxrwxr-T sticky bit is set, but others execute is not set
        strcat(buf, S_ISVTX & st.st_mode ? (S_IXOTH & st.st_mode ? "t" : "T") : (S_IXOTH & st.st_mode ? "x" : "-"));
 
        return (RexxObjectPtr)context->NewStringFromAsciiz(buf);
    }
    else if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)st.st_nlink);
    }
    else if (*ichar == 'U' || *ichar == 'u') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)st.st_uid);
    }
    else if (*ichar == 'G' || *ichar == 'g') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)st.st_gid);
    }
    else if (*ichar == 'R' || *ichar == 'r') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)st.st_rdev);
    }
    else if (*ichar == 'S' || *ichar == 's') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)st.st_size);
    }
    else if (*ichar == 'A' || *ichar == 'a') {
        ftime = localtime(&st.st_atime);
        strftime(buf, sizeof(buf), "%F %T", ftime);
        return (RexxObjectPtr)context->NewStringFromAsciiz(buf);
    }
    else if (*ichar == 'M' || *ichar == 'm') {
        ftime = localtime(&st.st_mtime);
        strftime(buf, sizeof(buf), "%F %T", ftime);
        return (RexxObjectPtr)context->NewStringFromAsciiz(buf);
    }
    else if (*ichar == 'C' || *ichar == 'c') {
        ftime = localtime(&st.st_ctime);
        strftime(buf, sizeof(buf), "%F %T", ftime);
        return (RexxObjectPtr)context->NewStringFromAsciiz(buf);
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysAccess
 *
 * Return access information.
 *
 * @param file    The file specification.
 *
 * @param ichar   The integer option.
 *
 * @return        0 = access allowed.
 */
RexxRoutine2(int,
             SysAccess,
             CSTRING, file,
             int, option)
{
 
    return access(file, option);
}
 
 
#if defined (HAVE_EUIDACCESS)
/**
 * Method:        SysEuidaccess
 *
 * Return access information using the effective userid.
 *
 * @param file    The file specification.
 *
 * @param ichar   The integer option.
 *
 * @return        0 = access allowed.
 */
RexxRoutine2(int,
             SysEuidaccess,
             CSTRING, file,
             int, option)
{
 
    return euidaccess(file, option);
}
#endif
 
/**
 * Method:        SysGetservbyname
 *
 * Return service information from the services file.
 *
 * @param name    The service name.
 *
 * @param proto   The service protocol.
 *
 * @param option  The option string.
 *
 * @return        Option information
 */
RexxRoutine3(RexxObjectPtr,
             SysGetservbyname,
             CSTRING, name,
             CSTRING, proto,
             CSTRING, ichar)
{
    if (strlen(name) == 0 || strlen(proto) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    struct servent *se = getservbyname(name, proto);
    if (se == NULL) {
        return context->NullString();
    }
    if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(se->s_name);
    }
    else if (*ichar == 'P' || *ichar == 'p') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)ntohs(se->s_port));
    }
    else if (*ichar == 'A' || *ichar == 'a') {
        RexxArrayObject arr = context->NewArray(1);
        char **members = se->s_aliases;
        while (*members != NULL) {
           context->ArrayAppendString(arr, *members, strlen(*members));
           members++;
        }
        return (RexxObjectPtr)arr;
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysGetservbyport
 *
 * Return service information from the services file.
 *
 * @param port    The service port.
 *
 * @param proto   The service protocol.
 *
 * @param option  The option string.
 *
 * @return        Option information
 */
RexxRoutine3(RexxObjectPtr,
             SysGetservbyport,
             int, port,
             CSTRING, proto,
             CSTRING, ichar)
{
    if (port <= 0 || port >= 65535 || strlen(proto) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    struct servent *se = getservbyport(htons(port), proto);
    if (se == NULL) {
        return context->NullString();
    }
    else if (*ichar == 'N' || *ichar == 'n') {
        return (RexxObjectPtr)context->NewStringFromAsciiz(se->s_name);
    }
    else if (*ichar == 'P' || *ichar == 'p') {
        return (RexxObjectPtr)context->WholeNumberToObject((wholenumber_t)ntohs(se->s_port));
    }
    else if (*ichar == 'A' || *ichar == 'a') {
        RexxArrayObject arr = context->NewArray(1);
        char **members = se->s_aliases;
        while (*members != NULL) {
           context->ArrayAppendString(arr, *members, strlen(*members));
           members++;
        }
        return (RexxObjectPtr)arr;
    }
    context->InvalidRoutine();
    return context->NullString();
}
 
 
/**
 * Method:        SysWordexp
 *
 * Return an array of files matching the input expression.
 *
 * @param inexp   The input expression.
 *
 * @return        Array of file names.
 */
#if !defined(OPENBSD)
RexxRoutine1(RexxObjectPtr,
             SysWordexp,
             CSTRING, inexp)
{
    wordexp_t p;
    char **w;
    if (strlen(inexp) == 0) {
        context->InvalidRoutine();
        return context->NullString();
    }
    RexxArrayObject arr = context->NewArray(1);
 
    wordexp(inexp, &p, 0);
 
    w = p.we_wordv;
    for (int i = 0; i < p.we_wordc; i++) {
       context->ArrayAppendString(arr, w[i], strlen(w[i]));
    }
    wordfree(&p);
    return (RexxObjectPtr)arr;
}
#endif
 
 
#ifdef HAVE_XATTR
/**
 * Method:        SysSetxattr
 *
 * Set a file extended attribute.
 *
 * @param fname   The file name.
 *
 * @param name    The extended attribute name.
 *
 * @param val     The extended attribute value.
 *
 * @return        0 or -1.
 */
RexxRoutine3(int,
             SysSetxattr,
             CSTRING, fname,
             CSTRING, name,
             CSTRING, val)
{
    return SetXattr(fname, name, val, strlen(val) + 1, 0);
}
 
 
/**
 * Method:        SysGetxattr
 *
 * Get a file extended attribute.
 *
 * @param fname   The file name.
 *
 * @param name    The extended attribute name.
 *
 * @return        0 or -1.
 */
RexxRoutine2(RexxObjectPtr,
             SysGetxattr,
             CSTRING, fname,
             CSTRING, name)
{
    ssize_t sz;
    char *buf;
 
    sz = GetXattr(fname, name, NULL, 0);
    if (sz == -1) {
        return context->NullString();
    }
    buf = (char *)alloca(sz);
    GetXattr(fname, name, buf, sz);
 
    return (RexxObjectPtr)context->NewStringFromAsciiz(buf);
}
 
 
/**
 * Method:        SysListxattr
 *
 * List a file's extended attribute(s).
 *
 * @param fname   The file name.
 *
 * @return        0 or -1.
 */
RexxRoutine1(RexxObjectPtr,
             SysListxattr,
             CSTRING, fname)
{
    ssize_t sz;
    char *buf, *name;
 
    sz = ListXattr(fname, NULL, 0);
    if (sz == -1) {
        return context->NullString();
    }
    buf = (char *)alloca(sz);
    ListXattr(fname, buf, sz);
 
    // create a Rexx array of the xattr names
    RexxArrayObject arr = context->NewArray(1);
    while (sz > 0) {
        context->ArrayAppendString(arr, buf, strlen(buf));
        sz -= strlen(buf) + 1;
        buf += strlen(buf) + 1;
    }
 
    return (RexxObjectPtr)arr;
}
 
 
/**
 * Method:        SysRemovexattr
 *
 * Remove an extended attribute.
 *
 * @param fname   The file name.
 *
 * @param name    The extended attribute name.
 *
 * @return        0 or -1.
 */
RexxRoutine2(int,
             SysRemovexattr,
             CSTRING, fname,
             CSTRING, name)
{
 
 
    return RemoveXattr(fname, name);
}
#endif
 
 
/**
 * Method:        SysGetsizeofptr
 *
 * Get the size of the ooRexx application pointers (in bits).
 *
 * @return        32 or 64.
 */
RexxRoutine0(int,
             SysGetsizeofptr)
{
 
 
    return sizeof(void *) * 8;
}
 
 
/**
 * Method:        SysGethostname
 *
 * Get the machine hostname.
 *
 * @return        hostname.
 */
RexxRoutine0(RexxObjectPtr,
             SysGethostname)
{
    char hostname[HOST_NAME_MAX];
 
    gethostname(hostname, HOST_NAME_MAX);
    return (RexxObjectPtr)context->NewStringFromAsciiz(hostname);
}
 
 
/**
 * Method:        SysChmod
 *
 * Change the file permissions.
 *
 * @param usr     The user permissions.
 *
 * @param grp     The group permissions.
 *
 * @param oth     The other permissions.
 *
 * @return        Return code from chmod().
 */
RexxRoutine2(int,
             SysChmod,
             CSTRING, file,
             CSTRING, mode)
{
    mode_t perm = 0;
 
    // make sure the mode is the correct size
    if (strlen(mode) != 9) {
        context->InvalidRoutine();
        return -1;
    }
 
    // set usr bits
    if (mode[0] == 'r') {
        perm |= S_IRUSR;
    }
    else if (mode[0] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
    if (mode[1] == 'w') {
        perm |= S_IWUSR;
    }
    else if (mode[1] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
    if (mode[2] == 'x') {
        perm |= S_IXUSR;
    }
    else if (mode[2] == 'S') {
        perm |= S_ISUID;
    }
    else if (mode[2] == 's') {
        perm |= S_IXUSR;
        perm |= S_ISUID;
    }
    else if (mode[2] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
 
    // set grp bits
    if (mode[3] == 'r') {
        perm |= S_IRGRP;
    }
    else if (mode[3] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
    if (mode[4] == 'w') {
        perm |= S_IWGRP;
    }
    else if (mode[4] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
    if (mode[5] == 'x') {
        perm |= S_IXGRP;
    }
    else if (mode[5] == 'S') {
        perm |= S_ISGID;
    }
    else if (mode[5] == 's') {
        perm |= S_IXGRP;
        perm |= S_ISGID;
    }
    else if (mode[5] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
 
    // set oth bits
    if (mode[6] == 'r') {
        perm |= S_IROTH;
    }
    else if (mode[6] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
    if (mode[7] == 'w') {
        perm |= S_IWOTH;
    }
    else if (mode[7] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
    if (mode[8] == 'x') {
        perm |= S_IXOTH;
    }
    else if (mode[8] == 'T') {
        perm |= S_ISVTX;
    }
    else if (mode[8] == 't') {
        perm |= S_IXOTH;
        perm |= S_ISVTX;
    }
    else if (mode[8] == '-') {
    }
    else {
        context->InvalidRoutine();
        return -1;
    }
 
    return chmod(file, perm);
}
 
 
/**
 * Method:        SysGeterrno
 *
 * Get the errno value.
 *
 * @return        errno.
 */
RexxRoutine0(int,
             SysGeterrno)
{
 
    return errno;
}
 
 
/**
 * Method:        SysGeterrnomsg
 *
 * Get the string definition of an error number.
 *
 * @return        string.
 */
RexxRoutine1(RexxObjectPtr,
             SysGeterrnomsg,
             int, en)
{
    static const char *msgs[] = {
        "Ok",
        "Operation not permitted",
        "No such file or directory",
        "No such process",
        "Interrupted system call",
        "I/O error",
        "No such device or address",
        "Argument list too long",
        "Exec format error",
        "Bad file number",
        "No child processes",
        "Try again",
        "Out of memory",
        "Permission denied",
        "Bad address",
        "Block device required",
        "Device or resource busy",
        "File exists",
        "Cross-device link",
        "No such device",
        "Not a directory",
        "Is a directory",
        "Invalid argument",
        "File table overflow",
        "Too many open files",
        "Not a typewriter",
        "Text file busy",
        "File too large",
        "No space left on device",
        "Illegal seek",
        "Read-only file system",
        "Too many links",
        "Broken pipe",
        "Math argument out of domain of func",
        "Math result not representable",
        "Resource deadlock would occur",
        "File name too long",
        "No record locks available",
        "Function not implemented",
        "Directory not empty",
        "Too many symbolic links encountered",
        "Operation would block",
        "No message of desired type",
        "Identifier removed",
        "Channel number out of range",
        "Level 2 not synchronized",
        "Level 3 halted",
        "Level 3 reset",
        "Link number out of range",
        "Protocol driver not attached",
        "No CSI structure available",
        "Level 2 halted",
        "Invalid exchange",
        "Invalid request descriptor",
        "Exchange full",
        "No anode",
        "Invalid request code",
        "Invalid slot",
        "Deadlock",
        "Bad font file format",
        "Device not a stream",
        "No data available",
        "Timer expired",
        "Out of streams resources",
        "Machine is not on the network",
        "Package not installed",
        "Object is remote",
        "Link has been severed",
        "Advertise error",
        "Srmount error",
        "Communication error on send",
        "Protocol error",
        "Multihop attempted",
        "RFS specific error",
        "Not a data message",
        "Value too large for defined data type",
        "Name not unique on network",
        "File descriptor in bad state",
        "Remote address changed",
        "Can not access a needed shared library",
        "Accessing a corrupted shared library",
        ".lib section in a.out corrupted",
        "Attempting to link in too many shared libraries",
        "Cannot exec a shared library directly",
        "Illegal byte sequence",
        "Interrupted system call should be restarted",
        "Streams pipe error",
        "Too many users",
        "Socket operation on non-socket",
        "Destination address required",
        "Message too long",
        "Protocol wrong type for socket",
        "Protocol not available",
        "Protocol not supported",
        "Socket type not supported",
        "Operation not supported on transport endpoint",
        "Protocol family not supported",
        "Address family not supported by protocol",
        "Address already in use",
        "Cannot assign requested address",
        "Network is down",
        "Network is unreachable",
        "Network dropped connection because of reset",
        "Software caused connection abort",
        "Connection reset by peer",
        "No buffer space available",
        "Transport endpoint is already connected",
        "Transport endpoint is not connected",
        "Cannot send after transport endpoint shutdown",
        "Too many references: cannot splice",
        "Connection timed out",
        "Connection refused",
        "Host is down",
        "No route to host",
        "Operation already in progress",
        "Operation now in progress",
        "Stale NFS file handle",
        "Structure needs cleaning",
        "Not a XENIX named type file",
        "No XENIX semaphores available",
        "Is a named type file",
        "Remote I/O error",
        "Quota exceeded",
        "No medium found",
        "Wrong medium type",
        "Operation Canceled",
        "Required key not available",
        "Key has expired",
        "Key has been revoked",
        "Key was rejected by service",
        "Owner died",
        "State not recoverable",
        "Operation not possible due to RF-kill",
    };
 
    if (en >= sizeof(msgs) / sizeof(char *)) {
        return (RexxObjectPtr)context->NewStringFromAsciiz("Unknown");
    }
    return (RexxObjectPtr)context->NewStringFromAsciiz(msgs[en]);
}
 
 
/**
 * Method:        SysCrypt
 *
 * Encrypt a string.
 *
 * @param str     The string to encrypt.
 *
 * @param salt    The salt: two characters for the default DES encryption,
 *                other salt lengths may be available depending on the Unix platform
 *                for other encryption algorithms (MD5, Blowfish, SHA-256, SHA-512)
 *
 * @return        Encrypted string.
 */
RexxRoutine2(RexxObjectPtr,
             SysCrypt,
             CSTRING, str,
             CSTRING, salt)
{
    char *es;
 
    if (strlen(str) == 0)
    {
        context->RaiseException2(Rexx_Error_Incorrect_call_null,
          context->String("SYSCRYPT"), context->String("1"));
        return context->NullString();
    }
    if (strlen(salt) == 0)
    {
        context->RaiseException2(Rexx_Error_Incorrect_call_null,
          context->String("SYSCRYPT"), context->String("2"));
        return context->NullString();
    }
 
    es = crypt(str, salt);
    if (es == NULL) {
        return context->NullString();
    }
    return (RexxObjectPtr)context->NewStringFromAsciiz(es);
}
 
 
/**
 * Method:        SysMkdir
 *
 * Create a subdirectory.
 *
 * @param dir     The subdirectory to create.
 *
 * @param mode    The mode for the new subdirectory.
 *
 * @return        0 or -1.
 */
RexxRoutine2(int,
             SysMkdir,
             CSTRING, dir,
             int, mode)
{
    return mkdir(dir, mode);
}
 
 
/**
 * Method:        SysRmdir
 *
 * Remove a subdirectory.
 *
 * @param dir     The subdirectory to remove.
 *
 * @return        0 or -1.
 */
RexxRoutine1(int,
             SysRmdir,
             CSTRING, dir)
{
    return rmdir(dir);
}
 
 
/**
 * Method:        SysGetdirlist
 *
 * Return the list of files in a subdirectory.
 *
 * @param dir     The subdirectory to use.
 *
 * @return        RexxArrayObject.
 */
RexxRoutine1(RexxObjectPtr,
             SysGetdirlist,
             CSTRING, dir)
{
    RexxArrayObject arr = context->NewArray(5);
    DIR *dirptr;
    struct dirent *direntry;
 
    dirptr = opendir(dir);
    if (dirptr != NULL) {
        direntry = readdir(dirptr);
        while (direntry != NULL) {
            context->ArrayAppendString(arr, direntry->d_name, strlen(direntry->d_name));
            direntry = readdir(dirptr);
        }
        closedir(dirptr);
    }
    return (RexxObjectPtr)arr;
}
 
 
/**
 * Method:        SysGettzname1
 *
 * Return the timezone name.
 *
 * @return        RexxStringObject.
 */
RexxRoutine0(RexxObjectPtr,
             SysGettzname1)
{
 
    tzset();
    return (RexxObjectPtr)context->NewStringFromAsciiz(tzname[0]);
}
 
 
/**
 * Method:        SysGettzname2
 *
 * Return the altername timezone name.
 *
 * @return        RexxStringObject.
 */
RexxRoutine0(RexxObjectPtr,
             SysGettzname2)
{
 
    tzset();
    return (RexxObjectPtr)context->NewStringFromAsciiz(tzname[1]);
}
 
 
// initialize the libvirt library
static void orxnixclib_loader(RexxThreadContext *context) {
   }
 
 
// build the actual entry list
RexxRoutineEntry orxnixclib_routines[] = {
    REXX_TYPED_ROUTINE(SysSignal, SysSignal),
    REXX_TYPED_ROUTINE(SysUname, SysUname),
    REXX_TYPED_ROUTINE(SysSetsid, SysSetsid),
    REXX_TYPED_ROUTINE(SysGetsid, SysGetsid),
    REXX_TYPED_ROUTINE(SysSetuid, SysSetuid),
    REXX_TYPED_ROUTINE(SysGetuid, SysGetuid),
    REXX_TYPED_ROUTINE(SysSeteuid, SysSeteuid),
    REXX_TYPED_ROUTINE(SysGeteuid, SysGeteuid),
    REXX_TYPED_ROUTINE(SysSetgid, SysSetgid),
    REXX_TYPED_ROUTINE(SysGetgid, SysGetgid),
    REXX_TYPED_ROUTINE(SysSetegid, SysSetegid),
    REXX_TYPED_ROUTINE(SysGetegid, SysGetegid),
    REXX_TYPED_ROUTINE(SysSetpgrp, SysSetpgrp),
    REXX_TYPED_ROUTINE(SysGetpgrp, SysGetpgrp),
    REXX_TYPED_ROUTINE(SysSetpgid, SysSetpgid),
    REXX_TYPED_ROUTINE(SysGetpgid, SysGetpgid),
    REXX_TYPED_ROUTINE(SysGetpid, SysGetpid),
    REXX_TYPED_ROUTINE(SysGetppid, SysGetppid),
    REXX_TYPED_ROUTINE(SysGettid, SysGettid),
    REXX_TYPED_ROUTINE(SysKill, SysKill),
    REXX_TYPED_ROUTINE(SysSymlink, SysSymlink),
    REXX_TYPED_ROUTINE(SysLink, SysLink),
    REXX_TYPED_ROUTINE(SysUnlink, SysUnlink),
    REXX_TYPED_ROUTINE(SysChown, SysChown),
    REXX_TYPED_ROUTINE(SysLchown, SysLchown),
    REXX_TYPED_ROUTINE(SysChroot, SysChroot),
    REXX_TYPED_ROUTINE(SysUmask, SysUmask),
    REXX_TYPED_ROUTINE(SysClose, SysClose),
    REXX_TYPED_ROUTINE(SysGetpwnam, SysGetpwnam),
    REXX_TYPED_ROUTINE(SysGetpwuid, SysGetpwuid),
    REXX_TYPED_ROUTINE(SysGetgrnam, SysGetgrnam),
    REXX_TYPED_ROUTINE(SysGetgrgid, SysGetgrgid),
    REXX_TYPED_ROUTINE(SysStat, SysStat),
    REXX_TYPED_ROUTINE(SysAccess, SysAccess),
#if defined (HAVE_EUIDACCESS)
    REXX_TYPED_ROUTINE(SysEuidaccess, SysEuidaccess),
#endif
    REXX_TYPED_ROUTINE(SysGetservbyname, SysGetservbyname),
    REXX_TYPED_ROUTINE(SysGetservbyport, SysGetservbyport),
#ifdef HAVE_WORDEXP
    REXX_TYPED_ROUTINE(SysWordexp, SysWordexp),
#endif
#ifdef HAVE_XATTR
    REXX_TYPED_ROUTINE(SysSetxattr, SysSetxattr),
    REXX_TYPED_ROUTINE(SysGetxattr, SysGetxattr),
    REXX_TYPED_ROUTINE(SysListxattr, SysListxattr),
    REXX_TYPED_ROUTINE(SysRemovexattr, SysRemovexattr),
#endif
    REXX_TYPED_ROUTINE(SysGetsizeofptr, SysGetsizeofptr),
    REXX_TYPED_ROUTINE(SysGethostname, SysGethostname),
    REXX_TYPED_ROUTINE(SysChmod, SysChmod),
    REXX_TYPED_ROUTINE(SysGeterrno, SysGeterrno),
    REXX_TYPED_ROUTINE(SysGeterrnomsg, SysGeterrnomsg),
    REXX_TYPED_ROUTINE(SysCrypt, SysCrypt),
    REXX_TYPED_ROUTINE(SysMkdirUnix, SysMkdir),
    REXX_TYPED_ROUTINE(SysRmdirUnix, SysRmdir),
    REXX_TYPED_ROUTINE(SysGetdirlist, SysGetdirlist),
    REXX_TYPED_ROUTINE(SysGettzname1, SysGettzname1),
    REXX_TYPED_ROUTINE(SysGettzname2, SysGettzname2),
    REXX_LAST_ROUTINE()
};
 
 
// build the actual entry list
RexxMethodEntry orxnixclib_methods[] = {
    REXX_LAST_METHOD()
};
 
 
RexxPackageEntry orxnixclib_package_entry = {
    STANDARD_PACKAGE_HEADER
    REXX_INTERPRETER_4_0_0,              // anything after 4.0.0 will work
    "rxunixsys",                        // name of the package
    "1.0.0",                             // package information
    orxnixclib_loader,                   // load function
    NULL,                                // unload function
    orxnixclib_routines,                 // the exported routines
    orxnixclib_methods                   // the exported methods
};
 
// package loading stub.
OOREXX_GET_PACKAGE(orxnixclib);