mdbtools/src/libmdb/table.c

/* MDB Tools - A library for reading MS Access database file
 * Copyright (C) 2000 Brian Bruns
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include "mdbtools.h"

#ifdef DMALLOC
#include "dmalloc.h"
#endif


static gint mdb_col_comparer(MdbColumn *a, MdbColumn *b)
{
	if (a->col_num > b->col_num)
		return 1;
	else if (a->col_num < b->col_num)
		return -1;
	else
		return 0;
}

unsigned char mdb_col_needs_size(int col_type)
{
	if (col_type == MDB_TEXT) {
		return TRUE;
	} else {
		return FALSE;
	}
}

MdbTableDef *
mdb_read_table(MdbCatalogEntry *entry)
{
	MdbTableDef *table;
	MdbHandle *mdb = entry->mdb;
	MdbFormatConstants *fmt = mdb->fmt;
	int len;
	int rownum, row_start, row_end;
	guint32 pg;

	table = mdb_alloc_tabledef(entry);

	mdb_read_pg(mdb, entry->table_pg);
	if (mdb->pg_buf[0] != 0x02) return NULL; /* not a valid table def page */

	len = mdb_pg_get_int16(mdb,8);

	table->num_rows = mdb_pg_get_int32(mdb, fmt->tab_num_rows_offset);
	table->num_cols = mdb_pg_get_int16(mdb, fmt->tab_num_cols_offset);
	table->num_idxs = mdb_pg_get_int32(mdb, fmt->tab_num_idxs_offset); 
	table->num_real_idxs = mdb_pg_get_int32(mdb, fmt->tab_num_ridxs_offset); 

	/* grab a copy of the usage map */
	rownum = mdb->pg_buf[fmt->tab_usage_map_offset];
	pg = mdb_pg_get_int24(mdb, fmt->tab_usage_map_offset + 1); 
	mdb_read_alt_pg(mdb, pg);
	mdb_swap_pgbuf(mdb);
	row_start = mdb_pg_get_int16(mdb, (fmt->row_count_offset + 2) + (rownum*2));
	row_end = mdb_find_end_of_row(mdb, rownum);
	table->map_sz = row_end - row_start + 1;
	table->usage_map = g_memdup(&mdb->pg_buf[row_start], table->map_sz);
	if (mdb_get_option(MDB_DEBUG_USAGE)) 
		buffer_dump(mdb->pg_buf, row_start, row_end);
	/* swap back */
	mdb_swap_pgbuf(mdb);
	mdb_debug(MDB_DEBUG_USAGE,"usage map found on page %ld rownum %d start %d end %d", mdb_pg_get_int24(mdb, fmt->tab_usage_map_offset + 1), rownum, row_start, row_end);


	/* now grab the free space page map */
#if 1
	//mdb_swap_pgbuf(mdb);
	rownum = mdb->pg_buf[fmt->tab_free_map_offset];
	mdb_read_alt_pg(mdb, mdb_pg_get_int24(mdb, fmt->tab_free_map_offset + 1));
	mdb_swap_pgbuf(mdb);
	row_start = mdb_pg_get_int16(mdb, (fmt->row_count_offset + 2) + (rownum*2));
	row_end = mdb_find_end_of_row(mdb, rownum);
	table->freemap_sz = row_end - row_start + 1;
	table->free_usage_map = g_memdup(&mdb->pg_buf[row_start], table->freemap_sz);
	mdb_swap_pgbuf(mdb);
#endif
	mdb_debug(MDB_DEBUG_USAGE,"free map found on page %ld rownum %d start %d end %d\n", mdb_pg_get_int24(mdb, fmt->tab_free_map_offset + 1), rownum, row_start, row_end);

	table->first_data_pg = mdb_pg_get_int16(mdb, fmt->tab_first_dpg_offset);

	return table;
}

/*
** read the next page if offset is > pg_size
** return true if page was read
*/ 
int 
read_pg_if(MdbHandle *mdb, int *cur_pos, int offset)
{
	if (*cur_pos + offset >= mdb->fmt->pg_size) {
		mdb_read_pg(mdb, mdb_pg_get_int32(mdb,4));
		*cur_pos = 8 - (mdb->fmt->pg_size - (*cur_pos));
		return 1;
	}
	return 0;
}
guint32 
read_pg_if_32(MdbHandle *mdb, int *cur_pos)
{
	unsigned char c[4];
	int i, rc = 0;

	for (i=0;i<4;i++) {
		rc += read_pg_if(mdb, cur_pos, i);
		c[i] = mdb->pg_buf[(*cur_pos) + i];
	}
	return mdb_get_int32(c, 0);
}
guint16 
read_pg_if_16(MdbHandle *mdb, int *cur_pos)
{
	unsigned char low_byte, high_byte;
	int rc = 0;

	rc += read_pg_if(mdb, cur_pos, 0);
	low_byte = mdb->pg_buf[*cur_pos];
	rc += read_pg_if(mdb, cur_pos, 1);
	high_byte = mdb->pg_buf[(*cur_pos) + 1];

	return (high_byte * 256 + low_byte);
}
guint16 
read_pg_if_n(MdbHandle *mdb, unsigned char *buf, int *cur_pos, int len)
{
	if (*cur_pos + len < mdb->fmt->pg_size) {
		memcpy(buf, &mdb->pg_buf[*cur_pos], len);
		return 0;
	} else {
		int half = mdb->fmt->pg_size - *cur_pos;
		memcpy(buf, &mdb->pg_buf[*cur_pos], half);
		mdb_read_pg(mdb, mdb_pg_get_int32(mdb,4));
		memcpy(buf + half, &mdb->pg_buf[8], len - half);
		*cur_pos = 8 - half;
		return 1;
	}
}

GPtrArray *mdb_read_columns(MdbTableDef *table)
{
	MdbHandle *mdb = table->entry->mdb;
	MdbFormatConstants *fmt = mdb->fmt;
	MdbColumn col, *pcol;
	int len, i,j;
	unsigned char low_byte, high_byte;
	int cur_col, cur_name;
	int name_sz;
	GSList	*slist = NULL;
	
	table->columns = g_ptr_array_new();

	cur_col = fmt->tab_cols_start_offset + 
		(table->num_real_idxs * fmt->tab_ridx_entry_size);

	/* new code based on patch submitted by Tim Nelson 2000.09.27 */

	/* 
	** column attributes 
	*/
	for (i=0;i<table->num_cols;i++) {
#ifdef MDB_DEBUG
	/* printf("column %d\n", i);
	buffer_dump(mdb->pg_buf, cur_col ,cur_col + 18); */
#endif
		memset(&col, 0, sizeof(col));

		read_pg_if(mdb, &cur_col, 0);
		col.col_type = mdb->pg_buf[cur_col];

		read_pg_if(mdb, &cur_col, fmt->col_num_offset); // col_num_offset == 1 or 5
		col.col_num = mdb->pg_buf[cur_col + fmt->col_num_offset];

		//fprintf(stdout,"----- column %d -----\n",col.col_num);
		read_pg_if(mdb, &cur_col, fmt->tab_col_offset_var); // col_var == 3 or 7
		low_byte = mdb->pg_buf[cur_col + fmt->tab_col_offset_var];
		read_pg_if(mdb, &cur_col, fmt->tab_col_offset_var + 1); 
		high_byte = mdb->pg_buf[cur_col + fmt->tab_col_offset_var + 1];
		col.var_col_num = high_byte * 256 + low_byte;
		//fprintf(stdout,"var column pos %d\n",col.var_col_num);

		read_pg_if(mdb, &cur_col, fmt->tab_row_col_num_offset); // col_var == 5 or 9
		low_byte = mdb->pg_buf[cur_col + fmt->tab_row_col_num_offset];
		read_pg_if(mdb, &cur_col, fmt->tab_row_col_num_offset + 1); 
		high_byte = mdb->pg_buf[cur_col + fmt->tab_row_col_num_offset + 1];
		col.row_col_num = high_byte * 256 + low_byte;
		//fprintf(stdout,"row column num %d\n",col.row_col_num);

		/* FIXME: can this be right in Jet3 and Jet4? */
		if (col.col_type == MDB_NUMERIC) {
			read_pg_if(mdb, &cur_col, 11);
			col.col_prec = mdb->pg_buf[cur_col + 11];
			read_pg_if(mdb, &cur_col, 12);
			col.col_scale = mdb->pg_buf[cur_col + 12];
		}

		read_pg_if(mdb, &cur_col, fmt->col_fixed_offset); // col_fixed_offset == 13 or 15
		col.is_fixed = mdb->pg_buf[cur_col + fmt->col_fixed_offset] & 
				0x01 ? 1 : 0;

		read_pg_if(mdb, &cur_col, fmt->tab_col_offset_fixed); // col_fixed_offset == 13 or 15
		low_byte = mdb->pg_buf[cur_col + fmt->tab_col_offset_fixed];
		read_pg_if(mdb, &cur_col, fmt->tab_col_offset_fixed + 1); 
		high_byte = mdb->pg_buf[cur_col + fmt->tab_col_offset_fixed + 1];
		col.fixed_offset = high_byte * 256 + low_byte;
		//fprintf(stdout,"fixed column offset %d\n",col.fixed_offset);
		//fprintf(stdout,"col type %s\n",col.is_fixed ? "fixed" : "variable");

		if (col.col_type != MDB_BOOL) {
			read_pg_if(mdb, &cur_col, fmt->col_size_offset); // col_size_offset == 16 or 23
			low_byte = mdb->pg_buf[cur_col + fmt->col_size_offset];
			read_pg_if(mdb, &cur_col, fmt->col_size_offset + 1);
			high_byte = mdb->pg_buf[cur_col + fmt->col_size_offset + 1];
			col.col_size += high_byte * 256 + low_byte;
		} else
			col.col_size=0;
		
		pcol = g_memdup(&col, sizeof(MdbColumn));
		slist = g_slist_insert_sorted(slist,pcol,(GCompareFunc)mdb_col_comparer);
		cur_col += fmt->tab_col_entry_size;
	}

	cur_name = cur_col;
	
	/* 
	** column names 
	*/
	for (i=0;i<table->num_cols;i++) {
		/* fetch the column */
		pcol = g_slist_nth_data (slist, i);

		/* we have reached the end of page */
		read_pg_if(mdb, &cur_name, 0);
		name_sz = mdb->pg_buf[cur_name];
		
		if (IS_JET4(mdb)) {
			/* FIX ME - for now just skip the high order byte */
			cur_name += 2;
			/* determine amount of name on this page */
			len = ((cur_name + name_sz) > fmt->pg_size) ? 
				fmt->pg_size - cur_name :
				name_sz;
	
			/* strip high order (second) byte from unicode string */
			for (j=0;j<len;j+=2) {
				pcol->name[j/2] = mdb->pg_buf[cur_name + j];
			}
			/* name wrapped over page */
			if (len < name_sz) {
				/* read the next pg */
				mdb_read_pg(mdb, mdb_pg_get_int32(mdb,4)); 
				cur_name = 8 - (fmt->pg_size - cur_name);
				/* get the rest of the name */
				for (j=len;j<name_sz;j++) {
					if (!(j%2))
						pcol->name[j/2]	= mdb->pg_buf[cur_name + j];
				}
			}
			pcol->name[name_sz/2]='\0';

			cur_name += name_sz;
		} else if (IS_JET3(mdb)) {
			/* determine amount of name on this page */
			len = ((cur_name + name_sz) > fmt->pg_size) ? 
				fmt->pg_size - cur_name :
				name_sz;
	
			if (len) {
				memcpy(pcol->name, &mdb->pg_buf[cur_name+1], len);
			}
			/* name wrapped over page */
			if (len < name_sz) {
				/* read the next pg */
				mdb_read_pg(mdb, mdb_pg_get_int32(mdb,4)); 
				cur_name = 8 - (fmt->pg_size - cur_name);
				/* get the rest of the name */
				memcpy(&pcol->name[len], &mdb->pg_buf[cur_name], name_sz - len);
			}
			pcol->name[name_sz]='\0';

			cur_name += name_sz + 1;
		} else {
			fprintf(stderr,"Unknown MDB version\n");
		}
	}
	/* turn this list into an array */
	for (i=0;i<table->num_cols;i++) {
		pcol = g_slist_nth_data (slist, i);
		g_ptr_array_add(table->columns, pcol);
	}

	g_slist_free(slist);

	table->index_start = cur_name;
	return table->columns;
}

void mdb_table_dump(MdbCatalogEntry *entry)
{
MdbTableDef *table;
MdbColumn *col;
int coln;
MdbIndex *idx;
MdbHandle *mdb = entry->mdb;
int i,bitn;
guint32 pgnum;

	table = mdb_read_table(entry);
	fprintf(stdout,"definition page     = %lu\n",entry->table_pg);
	fprintf(stdout,"number of datarows  = %d\n",table->num_rows);
	fprintf(stdout,"number of columns   = %d\n",table->num_cols);
	fprintf(stdout,"number of indices   = %d\n",table->num_real_idxs);

	mdb_read_columns(table);
	mdb_read_indices(table);

	for (i=0;i<table->num_cols;i++) {
		col = g_ptr_array_index(table->columns,i);
	
		fprintf(stdout,"column %d Name: %-20s Type: %s(%d)\n",
			i, col->name,
			mdb_get_coltype_string(mdb->default_backend, col->col_type),
			col->col_size);
	}

	for (i=0;i<table->num_idxs;i++) {
		idx = g_ptr_array_index (table->indices, i);
		mdb_index_dump(table, idx);
	}
	if (table->usage_map) {
		printf("pages reserved by this object\n");
		printf("usage map pg %lu\n", table->map_base_pg);
		printf("free map pg %lu\n", table->freemap_base_pg);
		pgnum = mdb_get_int32(table->usage_map,1);
		/* the first 5 bytes of the usage map mean something */
		coln = 0;
		for (i=5;i<table->map_sz;i++) {
			for (bitn=0;bitn<8;bitn++) {
				if (table->usage_map[i] & 1 << bitn) {
					coln++;
					printf("%6lu ",(long unsigned) pgnum);
					if (coln==10) {
						printf("\n");
						coln = 0;
					}
				}
				pgnum++;
			}
		}
		printf("\n");
	}
}