/*
 * Copyright (c) 1983, 1993
 *      The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of the University 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 REGENTS 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 REGENTS 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.
 *
 * @(#)dirs.c   8.7 (Berkeley) 5/1/95
 * $FreeBSD: src/sbin/restore/dirs.c,v 1.14.2.5 2001/10/15 13:44:45 dd Exp $
 */

#include <sys/param.h>
#include <sys/stat.h>
#include <sys/time.h>

#include <vfs/ufs/dinode.h>
#include <vfs/ufs/dir.h>
#include <protocols/dumprestore.h>

#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <paths.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "restore.h"
#include "extern.h"

/*
 * Symbol table of directories read from tape.
 */
#define HASHSIZE        1000
#define INOHASH(val) (val % HASHSIZE)
struct inotab {
        struct  inotab *t_next;
        ufs1_ino_t      t_ino;
        int32_t t_seekpt;
        int32_t t_size;
};
static struct inotab *inotab[HASHSIZE];

/*
 * Information retained about directories.
 */
struct modeinfo {
        ufs1_ino_t ino;
        struct timeval timep[2];
        mode_t mode;
        uid_t uid;
        gid_t gid;
        int flags;
};

/*
 * Definitions for library routines operating on directories.
 */
#undef DIRBLKSIZ
#define DIRBLKSIZ 1024
struct rstdirdesc {
        int     dd_fd;
        int32_t dd_loc;
        int32_t dd_size;
        char    dd_buf[DIRBLKSIZ];
};

/*
 * Global variables for this file.
 */
static long     seekptg;
static FILE     *df, *mfg;
static RST_DIR  *dirpg;
static char     dirfile[MAXPATHLEN] = "#";      /* No file */
static char     modefile[MAXPATHLEN] = "#";     /* No file */
static char     dot[2] = ".";                   /* So it can be modified */

/*
 * Format of old style directories.
 */
#define ODIRSIZ 14
struct odirect {
        u_short d_ino;
        char    d_name[ODIRSIZ];
};

static struct inotab    *allocinotab(ufs1_ino_t, struct ufs1_dinode *, long);
static void              dcvt(struct odirect *, struct direct *);
static void              flushent(void);
static struct inotab    *inotablookup(ufs1_ino_t);
static RST_DIR          *opendirfile(const char *);
static void              putdir(char *, size_t);
static void              putent(struct direct *);
static void              rst_seekdir(RST_DIR *, long, long);
static long              rst_telldir(RST_DIR *);
static struct direct    *searchdir(ufs1_ino_t, char *);

/*
 *      Extract directory contents, building up a directory structure
 *      on disk for extraction by name.
 *      If genmode is requested, save mode, owner, and times for all
 *      directories on the tape.
 */
void
extractdirs(int genmode)
{
        int i;
        struct ufs1_dinode *ip;
        struct inotab *itp;
        struct direct nulldir;
        int fd;
        const char *tmpdir;

        vprintf(stdout, "Extract directories from tape\n");
        if ((tmpdir = getenv("TMPDIR")) == NULL || tmpdir[0] == '\0')
                tmpdir = _PATH_TMP;
        sprintf(dirfile, "%s/rstdir%ld", tmpdir, (long)dumpdate);
        if (command != 'r' && command != 'R') {
                strcat(dirfile, "-XXXXXX");
                fd = mkstemp(dirfile);
        } else
                fd = open(dirfile, O_RDWR|O_CREAT|O_EXCL, 0666);
        if (fd == -1 || (df = fdopen(fd, "w")) == NULL) {
                if (fd != -1)
                        close(fd);
                warn("%s - cannot create directory temporary\nfopen", dirfile);
                done(1);
        }
        if (genmode != 0) {
                sprintf(modefile, "%s/rstmode%ld", tmpdir, (long)dumpdate);
                if (command != 'r' && command != 'R') {
                        strcat(modefile, "-XXXXXX");
                        fd = mkstemp(modefile);
                } else
                        fd = open(modefile, O_RDWR|O_CREAT|O_EXCL, 0666);
                if (fd == -1 || (mfg = fdopen(fd, "w")) == NULL) {
                        if (fd != -1)
                                close(fd);
                        warn("%s - cannot create modefile\nfopen", modefile);
                        done(1);
                }
        }
        nulldir.d_ino = 0;
        nulldir.d_type = DT_DIR;
        nulldir.d_namlen = 1;
        strcpy(nulldir.d_name, "/");
        nulldir.d_reclen = DIRSIZ(0, &nulldir);
        for (;;) {
                curfile.name = "<directory file - name unknown>";
                curfile.action = USING;
                ip = curfile.dip;
                if (ip == NULL || (ip->di_mode & IFMT) != IFDIR) {
                        fclose(df);
                        dirpg = opendirfile(dirfile);
                        if (dirpg == NULL)
                                fprintf(stderr, "opendirfile: %s\n",
                                    strerror(errno));
                        if (mfg != NULL)
                                fclose(mfg);
                        i = dirlookup(dot);
                        if (i == 0)
                                panic("Root directory is not on tape\n");
                        return;
                }
                itp = allocinotab(curfile.ino, ip, seekptg);
                getfile(putdir, xtrnull);
                putent(&nulldir);
                flushent();
                itp->t_size = seekptg - itp->t_seekpt;
        }
}

/*
 * skip over all the directories on the tape
 */
void
skipdirs(void)
{

        while (curfile.dip && (curfile.dip->di_mode & IFMT) == IFDIR) {
                skipfile();
        }
}

/*
 *      Recursively find names and inumbers of all files in subtree
 *      pname and pass them off to be processed.
 */
void
treescan(char *pname, ufs1_ino_t ino, long (*todo)(char *, ufs1_ino_t, int))
{
        struct inotab *itp;
        struct direct *dp;
        int namelen;
        long bpt;
        char locname[MAXPATHLEN + 1];

        itp = inotablookup(ino);
        if (itp == NULL) {
                /*
                 * Pname is name of a simple file or an unchanged directory.
                 */
                (*todo)(pname, ino, LEAF);
                return;
        }
        /*
         * Pname is a dumped directory name.
         */
        if ((*todo)(pname, ino, NODE) == FAIL)
                return;
        /*
         * begin search through the directory
         * skipping over "." and ".."
         */
        strncpy(locname, pname, sizeof(locname) - 1);
        locname[sizeof(locname) - 1] = '\0';
        strncat(locname, "/", sizeof(locname) - strlen(locname));
        namelen = strlen(locname);
        rst_seekdir(dirpg, itp->t_seekpt, itp->t_seekpt);
        dp = rst_readdir(dirpg); /* "." */
        if (dp != NULL && strcmp(dp->d_name, ".") == 0)
                dp = rst_readdir(dirpg); /* ".." */
        else
                fprintf(stderr, "Warning: `.' missing from directory %s\n",
                        pname);
        if (dp != NULL && strcmp(dp->d_name, "..") == 0)
                dp = rst_readdir(dirpg); /* first real entry */
        else
                fprintf(stderr, "Warning: `..' missing from directory %s\n",
                        pname);
        bpt = rst_telldir(dirpg);
        /*
         * a zero inode signals end of directory
         */
        while (dp != NULL) {
                locname[namelen] = '\0';
                if ((size_t)(namelen + dp->d_namlen) >= sizeof(locname)) {
                        fprintf(stderr, "%s%s: name exceeds %zu char\n",
                                locname, dp->d_name, sizeof(locname) - 1);
                } else {
                        strncat(locname, dp->d_name, (int)dp->d_namlen);
                        treescan(locname, dp->d_ino, todo);
                        rst_seekdir(dirpg, bpt, itp->t_seekpt);
                }
                dp = rst_readdir(dirpg);
                bpt = rst_telldir(dirpg);
        }
}

/*
 * Lookup a pathname which is always assumed to start from the UFS_ROOTINO.
 */
struct direct *
pathsearch(const char *pathname)
{
        ufs1_ino_t ino;
        struct direct *dp;
        char *path, *name, buffer[MAXPATHLEN];

        strcpy(buffer, pathname);
        path = buffer;
        ino = UFS_ROOTINO;
        while (*path == '/')
                path++;
        dp = NULL;
        while ((name = strsep(&path, "/")) != NULL && *name != '\0') {
                if ((dp = searchdir(ino, name)) == NULL)
                        return (NULL);
                ino = dp->d_ino;
        }
        return (dp);
}

/*
 * Lookup the requested name in directory inum.
 * Return its inode number if found, zero if it does not exist.
 */
static struct direct *
searchdir(ufs1_ino_t inum, char *name)
{
        struct direct *dp;
        struct inotab *itp;
        int len;

        itp = inotablookup(inum);
        if (itp == NULL)
                return (NULL);
        rst_seekdir(dirpg, itp->t_seekpt, itp->t_seekpt);
        len = strlen(name);
        do {
                dp = rst_readdir(dirpg);
                if (dp == NULL)
                        return (NULL);
        } while (dp->d_namlen != len || strncmp(dp->d_name, name, len) != 0);
        return (dp);
}

/*
 * Put the directory entries in the directory file
 */
static void
putdir(char *buf, size_t size)
{
        struct direct cvtbuf;
        struct odirect *odp;
        struct odirect *eodp;
        struct direct *dp;
        size_t loc, i;

        if (cvtflag) {
                eodp = (struct odirect *)&buf[size];
                for (odp = (struct odirect *)buf; odp < eodp; odp++)
                        if (odp->d_ino != 0) {
                                dcvt(odp, &cvtbuf);
                                putent(&cvtbuf);
                        }
        } else {
                for (loc = 0; loc < size; ) {
                        dp = (struct direct *)(buf + loc);
                        if (Bcvt)
                                swabst("ls", (u_char *) dp);
                        if (oldinofmt && dp->d_ino != 0) {
#                               if BYTE_ORDER == BIG_ENDIAN
                                        if (Bcvt)
                                                dp->d_namlen = dp->d_type;
#                               else
                                        if (!Bcvt)
                                                dp->d_namlen = dp->d_type;
#                               endif
                                dp->d_type = DT_UNKNOWN;
                        }
                        i = DIRBLKSIZ - (loc & (DIRBLKSIZ - 1));
                        if ((dp->d_reclen & 0x3) != 0 ||
                            dp->d_reclen > i ||
                            dp->d_reclen < DIRSIZ(0, dp)
#if NAME_MAX < 255
                            || dp->d_namlen > NAME_MAX
#endif
                            ) {
                                vprintf(stdout, "Mangled directory: ");
                                if ((dp->d_reclen & 0x3) != 0)
                                        vprintf(stdout,
                                           "reclen not multiple of 4 ");
                                if (dp->d_reclen < DIRSIZ(0, dp))
                                        vprintf(stdout,
                                           "reclen less than DIRSIZ (%u < %zu) ",
                                           dp->d_reclen, DIRSIZ(0, dp));
#if NAME_MAX < 255
                                if (dp->d_namlen > NAME_MAX)
                                        vprintf(stdout,
                                           "reclen name too big (%u > %u) ",
                                           dp->d_namlen, NAME_MAX);
#endif
                                vprintf(stdout, "\n");
                                loc += i;
                                continue;
                        }
                        loc += dp->d_reclen;
                        if (dp->d_ino != 0) {
                                putent(dp);
                        }
                }
        }
}

/*
 * These variables are "local" to the following two functions.
 */
char dirbuf[DIRBLKSIZ];
long dirloc = 0;
long prev = 0;

/*
 * add a new directory entry to a file.
 */
static void
putent(struct direct *dp)
{
        dp->d_reclen = DIRSIZ(0, dp);
        if (dirloc + dp->d_reclen > DIRBLKSIZ) {
                ((struct direct *)(dirbuf + prev))->d_reclen =
                    DIRBLKSIZ - prev;
                fwrite(dirbuf, 1, DIRBLKSIZ, df);
                dirloc = 0;
        }
        memmove(dirbuf + dirloc, dp, (long)dp->d_reclen);
        prev = dirloc;
        dirloc += dp->d_reclen;
}

/*
 * flush out a directory that is finished.
 */
static void
flushent(void)
{
        ((struct direct *)(dirbuf + prev))->d_reclen = DIRBLKSIZ - prev;
        fwrite(dirbuf, (int)dirloc, 1, df);
        seekptg = ftell(df);
        dirloc = 0;
}

static void
dcvt(struct odirect *odp, struct direct *ndp)
{

        memset(ndp, 0, (long)(sizeof *ndp));
        ndp->d_ino =  odp->d_ino;
        ndp->d_type = DT_UNKNOWN;
        strncpy(ndp->d_name, odp->d_name, ODIRSIZ);
        ndp->d_namlen = strlen(ndp->d_name);
        ndp->d_reclen = DIRSIZ(0, ndp);
}

/*
 * Seek to an entry in a directory.
 * Only values returned by rst_telldir should be passed to rst_seekdir.
 * This routine handles many directories in a single file.
 * It takes the base of the directory in the file, plus
 * the desired seek offset into it.
 */
static void
rst_seekdir(RST_DIR *dirpl, long loc, long base)
{

        if (loc == rst_telldir(dirpl))
                return;
        loc -= base;
        if (loc < 0)
                fprintf(stderr, "bad seek pointer to rst_seekdir %ld\n", loc);
        lseek(dirpl->dd_fd, base + rounddown2(loc, DIRBLKSIZ), SEEK_SET);
        dirpl->dd_loc = loc & (DIRBLKSIZ - 1);
        if (dirpl->dd_loc != 0)
                dirpl->dd_size = read(dirpl->dd_fd, dirpl->dd_buf, DIRBLKSIZ);
}

/*
 * get next entry in a directory.
 */
struct direct *
rst_readdir(RST_DIR *dirpl)
{
        struct direct *dp;

        for (;;) {
                if (dirpl->dd_loc == 0) {
                        dirpl->dd_size = read(dirpl->dd_fd, dirpl->dd_buf,
                            DIRBLKSIZ);
                        if (dirpl->dd_size <= 0) {
                                dprintf(stderr, "error reading directory\n");
                                return (NULL);
                        }
                }
                if (dirpl->dd_loc >= dirpl->dd_size) {
                        dirpl->dd_loc = 0;
                        continue;
                }
                dp = (struct direct *)(dirpl->dd_buf + dirpl->dd_loc);
                if (dp->d_reclen == 0 ||
                    dp->d_reclen > DIRBLKSIZ + 1 - dirpl->dd_loc) {
                        dprintf(stderr, "corrupted directory: bad reclen %d\n",
                                dp->d_reclen);
                        return (NULL);
                }
                dirpl->dd_loc += dp->d_reclen;
                if (dp->d_ino == 0 && strcmp(dp->d_name, "/") == 0)
                        return (NULL);
                if (dp->d_ino >= maxino) {
                        dprintf(stderr, "corrupted directory: bad inum %d\n",
                                dp->d_ino);
                        continue;
                }
                return (dp);
        }
}

/*
 * Simulate the opening of a directory
 */
RST_DIR *
rst_opendir(const char *name)
{
        struct inotab *itp;
        RST_DIR *dirpl;
        ufs1_ino_t ino;

        if ((ino = dirlookup(name)) > 0 &&
            (itp = inotablookup(ino)) != NULL) {
                dirpl = opendirfile(dirfile);
                rst_seekdir(dirpl, itp->t_seekpt, itp->t_seekpt);
                return (dirpl);
        }
        return (NULL);
}

/*
 * In our case, there is nothing to do when closing a directory.
 */
void
rst_closedir(RST_DIR *dirpl)
{

        close(dirpl->dd_fd);
        free(dirpl);
        return;
}

/*
 * Simulate finding the current offset in the directory.
 */
static long
rst_telldir(RST_DIR *dirpl)
{
        return ((long)lseek(dirpl->dd_fd,
            (off_t)0, SEEK_CUR) - dirpl->dd_size + dirpl->dd_loc);
}

/*
 * Open a directory file.
 */
static RST_DIR *
opendirfile(const char *name)
{
        RST_DIR *dirpl;
        int fd;

        if ((fd = open(name, O_RDONLY)) == -1)
                return (NULL);
        if ((dirpl = malloc(sizeof(RST_DIR))) == NULL) {
                close(fd);
                return (NULL);
        }
        dirpl->dd_fd = fd;
        dirpl->dd_loc = 0;
        return (dirpl);
}

/*
 * Set the mode, owner, and times for all new or changed directories
 */
void
setdirmodes(int flags)
{
        FILE *mfl;
        struct modeinfo node;
        struct entry *ep;
        char *cp;
        const char *tmpdir;

        vprintf(stdout, "Set directory mode, owner, and times.\n");
        if ((tmpdir = getenv("TMPDIR")) == NULL || tmpdir[0] == '\0')
                tmpdir = _PATH_TMP;
        if (command == 'r' || command == 'R')
                sprintf(modefile, "%s/rstmode%ld", tmpdir, (long)dumpdate);
        if (modefile[0] == '#') {
                panic("modefile not defined\n");
                fprintf(stderr, "directory mode, owner, and times not set\n");
                return;
        }
        mfl = fopen(modefile, "r");
        if (mfl == NULL) {
                fprintf(stderr, "fopen: %s\n", strerror(errno));
                fprintf(stderr, "cannot open mode file %s\n", modefile);
                fprintf(stderr, "directory mode, owner, and times not set\n");
                return;
        }
        clearerr(mfl);
        for (;;) {
                fread((char *)&node, 1, sizeof(struct modeinfo), mfl);
                if (feof(mfl))
                        break;
                ep = lookupino(node.ino);
                if (command == 'i' || command == 'x') {
                        if (ep == NULL)
                                continue;
                        if ((flags & FORCE) == 0 && ep->e_flags & EXISTED) {
                                ep->e_flags &= ~NEW;
                                continue;
                        }
                        if (node.ino == UFS_ROOTINO &&
                            reply("set owner/mode for '.'") == FAIL)
                                continue;
                }
                if (ep == NULL) {
                        panic("cannot find directory inode %d\n", node.ino);
                } else {
                        cp = myname(ep);
                        if (!Nflag) {
                                chown(cp, node.uid, node.gid);
                                chmod(cp, node.mode);
                                utimes(cp, node.timep);
                                chflags(cp, node.flags);
                        }
                        ep->e_flags &= ~NEW;
                }
        }
        if (ferror(mfl))
                panic("error setting directory modes\n");
        fclose(mfl);
}

/*
 * Generate a literal copy of a directory.
 */
int
genliteraldir(char *name, ufs1_ino_t ino)
{
        struct inotab *itp;
        int ofile, dp, i, size;
        char buf[BUFSIZ];

        itp = inotablookup(ino);
        if (itp == NULL)
                panic("Cannot find directory inode %d named %s\n", ino, name);
        if ((ofile = open(name, O_WRONLY | O_CREAT | O_TRUNC, 0666)) < 0) {
                fprintf(stderr, "%s: ", name);
                fflush(stderr);
                fprintf(stderr, "cannot create file: %s\n", strerror(errno));
                return (FAIL);
        }
        rst_seekdir(dirpg, itp->t_seekpt, itp->t_seekpt);
        dp = dup(dirpg->dd_fd);
        for (i = itp->t_size; i > 0; i -= BUFSIZ) {
                size = i < BUFSIZ ? i : BUFSIZ;
                if (read(dp, buf, (int) size) == -1) {
                        fprintf(stderr,
                                "write error extracting inode %d, name %s\n",
                                curfile.ino, curfile.name);
                        fprintf(stderr, "read: %s\n", strerror(errno));
                        done(1);
                }
                if (!Nflag && write(ofile, buf, (int) size) == -1) {
                        fprintf(stderr,
                                "write error extracting inode %d, name %s\n",
                                curfile.ino, curfile.name);
                        fprintf(stderr, "write: %s\n", strerror(errno));
                        done(1);
                }
        }
        close(dp);
        close(ofile);
        return (GOOD);
}

/*
 * Determine the type of an inode
 */
int
inodetype(ufs1_ino_t ino)
{
        struct inotab *itp;

        itp = inotablookup(ino);
        if (itp == NULL)
                return (LEAF);
        return (NODE);
}

/*
 * Allocate and initialize a directory inode entry.
 * If requested, save its pertinent mode, owner, and time info.
 */
static struct inotab *
allocinotab(ufs1_ino_t ino, struct ufs1_dinode *dip, long seekptl)
{
        struct inotab   *itp;
        struct modeinfo node;

        itp = calloc(1, sizeof(struct inotab));
        if (itp == NULL)
                panic("no memory directory table\n");
        itp->t_next = inotab[INOHASH(ino)];
        inotab[INOHASH(ino)] = itp;
        itp->t_ino = ino;
        itp->t_seekpt = seekptl;
        if (mfg == NULL)
                return (itp);
        node.ino = ino;
        node.timep[0].tv_sec = dip->di_atime;
        node.timep[0].tv_usec = dip->di_atimensec / 1000;
        node.timep[1].tv_sec = dip->di_mtime;
        node.timep[1].tv_usec = dip->di_mtimensec / 1000;
        node.mode = dip->di_mode;
        node.flags = dip->di_flags;
        node.uid = dip->di_uid;
        node.gid = dip->di_gid;
        fwrite((char *)&node, 1, sizeof(struct modeinfo), mfg);
        return (itp);
}

/*
 * Look up an inode in the table of directories
 */
static struct inotab *
inotablookup(ufs1_ino_t ino)
{
        struct inotab *itp;

        for (itp = inotab[INOHASH(ino)]; itp != NULL; itp = itp->t_next)
                if (itp->t_ino == ino)
                        return (itp);
        return (NULL);
}

/*
 * Clean up and exit
 */
void
done(int exitcode)
{

        closemt();
        if (modefile[0] != '#')
                unlink(modefile);
        if (dirfile[0] != '#')
                unlink(dirfile);
        exit(exitcode);
}