/*	$OpenBSD: restore.c,v 1.17 2013/04/24 13:46:29 deraadt Exp $	*/

/*	$NetBSD: restore.c,v 1.9 1997/06/18 07:10:16 lukem Exp $	*/

/*

 * Copyright (c) 1983, 1993

 *	The Regents of the University of California.  All rights reserved.

 *

 * 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.

 */

#include <sys/types.h>

#include <sys/stat.h>

#include <ufs/ufs/dinode.h>

#include <stdio.h>

#include <string.h>

#include "restore.h"

#include "extern.h"

static char *keyval(int);

/*

 * This implements the 't' option.

 * List entries on the tape.

 */

long

listfile(char *name, ino_t ino, int type)

{

}

/*

 * This implements the 'x' option.

 * Request that new entries be extracted.

 */

long

addfile(char *name, ino_t ino, int type)

{

	struct entry *ep;

	}

		    (unsigned long long)ino);

		name = buf;

		}

	}

		}

	}

}

/*

 * This is used by the 'i' option to undo previous requests made by addfile.

 * Delete entries from the request queue.

 */

/* ARGSUSED */

long

deletefile(char *name, ino_t ino, int type)

{

	struct entry *ep;

	}

}

/*

 * The following four routines implement the incremental

 * restore algorithm. The first removes old entries, the second

 * does renames and calculates the extraction list, the third

 * cleans up link names missed by the first two, and the final

 * one deletes old directories.

 *

 * Directories cannot be immediately deleted, as they may have

 * other files in them which need to be moved out first. As

 * directories to be deleted are found, they are put on the

 * following deletion list. After all deletions and renames

 * are done, this list is actually deleted.

 */

static struct entry *removelist;

/*

 *	Remove unneeded leaves from the old tree.

 *	Remove directories from the lookup chains.

 */

void

removeoldleaves(void)

{

	struct entry *ep;

	ino_t i;

			continue;

			continue;

			}

		}

	}

}

/*

 *	For each directory entry on the incremental tape, determine which

 *	category it falls into as follows:

 *	KEEP - entries that are to be left alone.

 *	NEW - new entries to be added.

 *	EXTRACT - files that must be updated with new contents.

 *	LINK - new links to be added.

 *	Renames are done at the same time.

 */

long

nodeupdates(char *name, ino_t ino, int type)

{

	struct entry *ep, *np, *ip;

	long descend = GOOD;

	int lookuptype = 0;

	int key = 0;

		/* key values */

#		define ONTAPE	0x1	/* inode is on the tape */

#		define INOFND	0x2	/* inode already exists */

#		define NAMEFND	0x4	/* name already exists */

#		define MODECHG	0x8	/* mode of inode changed */

	/*

	 * This routine is called once for each element in the

	 * directory hierarchy, with a full path name.

	 * The "type" value is incorrectly specified as LEAF for

	 * directories that are not on the dump tape.

	 *

	 * Check to see if the file is on the tape.

	 */

	/*

	 * Check to see if the name exists, and if the name is a link.

	 */

	}

	/*

	 * Check to see if the inode exists, and if one of its links

	 * corresponds to the name (if one was found).

	 */

				ip = ep;

			}

		}

	}

	/*

	 * If both a name and an inode are found, but they do not

	 * correspond to the same file, then both the inode that has

	 * been found and the inode corresponding to the name that

	 * has been found need to be renamed. The current pathname

	 * is the new name for the inode that has been found. Since

	 * all files to be deleted have already been removed, the

	 * named file is either a now unneeded link, or it must live

	 * under a new name in this dump level. If it is a link, it

	 * can be removed. If it is not a link, it is given a

	 * temporary name in anticipation that it will be renamed

	 * when it is later found by inode number.

	 */

		}

		np = NULL;

	}

	/*

	 * Decide on the disposition of the file based on its flags.

	 * Note that we have already handled the case in which

	 * a name and inode are found that correspond to different files.

	 * Thus if both NAMEFND and INOFND are set then ip == np.

	 */

	/*

	 * A previously existing file has been found.

	 * Mark it as KEEP so that other links to the inode can be

	 * detected, and so that it will not be reclaimed by the search

	 * for unreferenced names.

	 */

	case INOFND|NAMEFND:

		break;

	/*

	 * A file on the tape has a name which is the same as a name

	 * corresponding to a different file in the previous dump.

	 * Since all files to be deleted have already been removed,

	 * this file is either a now unneeded link, or it must live

	 * under a new name in this dump level. If it is a link, it

	 * can simply be removed. If it is not a link, it is given a

	 * temporary name in anticipation that it will be renamed

	 * when it is later found by inode number (see INOFND case

	 * below). The entry is then treated as a new file.

	 */

	case ONTAPE|NAMEFND:

	case ONTAPE|NAMEFND|MODECHG:

		}

		/* fall through */

	/*

	 * A previously non-existent file.

	 * Add it to the file system, and request its extraction.

	 * If it is a directory, create it immediately.

	 * (Since the name is unused there can be no conflict)

	 */

	case ONTAPE:

		break;

	/*

	 * A file with the same inode number, but a different

	 * name has been found. If the other name has not already

	 * been found (indicated by the KEEP flag, see above) then

	 * this must be a new name for the file, and it is renamed.

	 * If the other name has been found then this must be a

	 * link to the file. Hard links to directories are not

	 * permitted, and are either deleted or converted to

	 * symbolic links. Finally, if the file is on the tape,

	 * a request is made to extract it.

	 */

	case ONTAPE|INOFND:

		/* fall through */

	case INOFND:

			break;

		}

			descend = FAIL;

				"deleted hard link %s to directory %s\n",

		}

		break;

	/*

	 * A previously known file which is to be updated. If it is a link,

	 * then all names referring to the previous file must be removed

	 * so that the subset of them that remain can be recreated.

	 */

	case ONTAPE|INOFND|NAMEFND:

			break;

		}

		break;

	/*

	 * An inode is being reused in a completely different way.

	 * Normally an extract can simply do an "unlink" followed

	 * by a "creat". Here we must do effectively the same

	 * thing. The complications arise because we cannot really

	 * delete a directory since it may still contain files

	 * that we need to rename, so we delete it from the symbol

	 * table, and put it on the list to be deleted eventually.

	 * Conversely if a directory is to be created, it must be

	 * done immediately, rather than waiting until the

	 * extraction phase.

	 */

	case ONTAPE|INOFND|MODECHG:

	case ONTAPE|INOFND|NAMEFND|MODECHG:

		}

			/* changing from leaf to node */

					   "NODE and LEAF links to same inode");

			}

			/* changing from node to leaf */

		}

		break;

	/*

	 * A hard link to a diirectory that has been removed.

	 * Ignore it.

	 */

	case NAMEFND:

			name);

		descend = FAIL;

	/*

	 * If we find a directory entry for a file that is not on

	 * the tape, then we must have found a file that was created

	 * while the dump was in progress. Since we have no contents

	 * for it, we discard the name knowing that it will be on the

	 * next incremental tape.

	 */

	case 0:

			name, (unsigned long long)ino);

	/*

	 * If any of these arise, something is grievously wrong with

	 * the current state of the symbol table.

	 */

	case INOFND|NAMEFND|MODECHG:

	case NAMEFND|MODECHG:

	case INOFND|MODECHG:

			name);

	/*

	 * These states "cannot" arise for any state of the symbol table.

	 */

	case ONTAPE|MODECHG:

	case MODECHG:

	default:

	}

}

/*

 * Calculate the active flags in a key.

 */

static char *

keyval(int key)

{

	static char keybuf[32];

}

/*

 * Find unreferenced link names.

 */

void

findunreflinks(void)

{

	struct entry *ep, *np;

	ino_t i;

			continue;

				    "%s: remove unreferenced name\n",

			}

		}

	}

	/*

	 * Any leaves remaining in removed directories is unreferenced.

	 */

				    "%s: remove unreferenced name\n",

			}

		}

	}

}

/*

 * Remove old nodes (directories).

 * Note that this routine runs in O(N*D) where:

 *	N is the number of directory entries to be removed.

 *	D is the maximum depth of the tree.

 * If N == D this can be quite slow. If the list were

 * topologically sorted, the deletion could be done in

 * time O(N).

 */

void

removeoldnodes(void)

{

	struct entry *ep, **prev;

	long change;

	do	{

		change = 0;

		prev = &removelist;

				prev = &ep->e_next;

			}

		}

}

/*

 * This is the routine used to extract files for the 'r' command.

 * Extract new leaves.

 */

void

createleaves(char *symtabfile)

{

	struct entry *ep;

	ino_t first;

	long curvol;

	} else {

	}

		/*

		 * If the next available file is not the one which we

		 * expect then we have missed one or more files. Since

		 * we do not request files that were not on the tape,

		 * the lost files must have been due to a tape read error,

		 * or a file that was removed while the dump was in progress.

		 */

			    (unsigned long long)first);

		}

		/*

		 * If we find files on the tape that have no corresponding

		 * directory entries, then we must have found a file that

		 * was created while the dump was in progress. Since we have

		 * no name for it, we discard it knowing that it will be

		 * on the next incremental tape.

		 */

			    (unsigned long long)first,

			    (unsigned long long)curfile.ino);

		}

		/*

		 * If the file is to be extracted, then the old file must

		 * be removed since its type may change from one leaf type

		 * to another (eg "file" to "character special").

		 */

		}

		/*

		 * We checkpoint the restore after every tape reel, so

		 * as to simplify the amount of work re quired by the

		 * 'R' command.

		 */

	next:

		}

	}

}

/*

 * This is the routine used to extract files for the 'x' and 'i' commands.

 * Efficiently extract a subset of the files on a tape.

 */

void

createfiles(void)

{

	ino_t first, next, last;

	struct entry *ep;

	long curvol;

		/*

		 * Check to see if any files remain to be extracted

		 */

			return;

		/*

		 * Reject any volumes with inodes greater

		 * than the last one needed

		 */

		}

		/*

		 * Decide on the next inode needed.

		 * Skip across the inodes until it is found

		 * or an out of order volume change is encountered

		 */

		/*

		 * If volume change out of order occurred the

		 * current state must be recalculated

		 */

			continue;

		/*

		 * If the current inode is greater than the one we were

		 * looking for then we missed the one we were looking for.

		 * Since we only attempt to extract files listed in the

		 * dump map, the lost files must have been due to a tape

		 * read error, or a file that was removed while the dump

		 * was in progress. Thus we report all requested files

		 * between the one we were looking for, and the one we

		 * found as missing, and delete their request flags.

		 */

		}

		/*

		 * The current inode is the one that we are looking for,

		 * so extract it per its requested name.

		 */

		}

	}

}

/*

 * Add links.

 */

void

createlinks(void)

{

	struct entry *np, *ep;

	ino_t i;

			continue;

				continue;

			}

		}

	}

}

/*

 * Check the symbol table.

 * We do this to insure that all the requested work was done, and

 * that no temporary names remain.

 */

void

checkrestore(void)

{

	struct entry *ep;

	ino_t i;

		}

	}

}

/*

 * Compare with the directory structure on the tape

 * A paranoid check that things are as they should be.

 */

long

verifyfile(char *name, ino_t ino, int type)

{

	struct entry *np, *ep;

	long descend = GOOD;

	}

			break;

}