/*

* ISO9660 support routines for PhysicsFS.

*

* Please see the file LICENSE.txt in the source's root directory.

*

* This file written by Christoph Nelles.

*/

/* !!! FIXME: this file needs Ryanification. */

/*

* Handles CD-ROM disk images (and raw CD-ROM devices).

*

* Not supported:

* - RockRidge

* - Non 2048 Sectors

* - UDF

*

* Deviations from the standard

* - Ignores mandatory sort order

* - Allows various invalid file names

*

* Problems

* - Ambiguities in the standard

*/

#define __PHYSICSFS_INTERNAL__

#include "physfs_internal.h"

#if PHYSFS_SUPPORTS_ISO9660

#include <time.h>

/* cache files smaller than this completely in memory */

#define ISO9660_FULLCACHEMAXSIZE 2048

/* !!! FIXME: this is going to cause trouble. */

#pragma pack(push) /* push current alignment to stack */

#pragma pack(1) /* set alignment to 1 byte boundary */

/* This is the format as defined by the standard

typedef struct

{

PHYSFS_uint32 lsb;

PHYSFS_uint32 msb;

} ISOBB32bit; // 32byte Both Byte type, means the value first in LSB then in MSB

typedef struct

{

PHYSFS_uint16 lsb;

PHYSFS_uint16 msb;

} ISOBB16bit; // 16byte Both Byte type, means the value first in LSB then in MSB

*/

/* define better ones to simplify coding (less if's) */

#if PHYSFS_BYTEORDER == PHYSFS_LIL_ENDIAN

#define ISOBB32bit(name) PHYSFS_uint32 name; PHYSFS_uint32 __dummy_##name;

#define ISOBB16bit(name) PHYSFS_uint16 name; PHYSFS_uint16 __dummy_##name;

#else

#define ISOBB32bit(name) PHYSFS_uint32 __dummy_##name; PHYSFS_uint32 name;

#define ISOBB16bit(name) PHYSFS_uint16 __dummy_##name; PHYSFS_uint16 name;

#endif

typedef struct

{

char year[4];

char month[2];

char day[2];

char hour[2];

char minute[2];

char second[2];

char centisec[2];

PHYSFS_sint8 offset; /* in 15min from GMT */

} ISO9660VolumeTimestamp;

typedef struct

{

PHYSFS_uint8 year;

PHYSFS_uint8 month;

PHYSFS_uint8 day;

PHYSFS_uint8 hour;

PHYSFS_uint8 minute;

PHYSFS_uint8 second;

PHYSFS_sint8 offset;

} ISO9660FileTimestamp;

typedef struct

{

unsigned existence:1;

unsigned directory:1;

unsigned associated_file:1;

unsigned record:1;

unsigned protection:1;

unsigned reserved:2;

unsigned multiextent:1;

} ISO9660FileFlags;

typedef struct

{

PHYSFS_uint8 length;

PHYSFS_uint8 attribute_length;

ISOBB32bit(extent_location)

ISOBB32bit(data_length)

ISO9660FileTimestamp timestamp;

ISO9660FileFlags file_flags;

PHYSFS_uint8 file_unit_size;

PHYSFS_uint8 gap_size;

ISOBB16bit(vol_seq_no)

PHYSFS_uint8 len_fi;

char unused;

} ISO9660RootDirectoryRecord;

/* this structure is combined for all Volume descriptor types */

typedef struct

{

PHYSFS_uint8 type;

char identifier[5];

PHYSFS_uint8 version;

PHYSFS_uint8 flags;

char system_identifier[32];

char volume_identifier[32];

char unused2[8];

ISOBB32bit(space_size)

PHYSFS_uint8 escape_sequences[32];

ISOBB16bit(vol_set_size)

ISOBB16bit(vol_seq_no)

ISOBB16bit(block_size)

ISOBB32bit(path_table_size)

/* PHYSFS_uint32 path_table_start_lsb; // why didn't they use both byte type?

PHYSFS_uint32 opt_path_table_start_lsb;

PHYSFS_uint32 path_table_start_msb;

PHYSFS_uint32 opt_path_table_start_msb;*/

#if PHYSFS_BYTEORDER == PHYSFS_LIL_ENDIAN

PHYSFS_uint32 path_table_start;

PHYSFS_uint32 opt_path_table_start;

PHYSFS_uint32 unused6;

PHYSFS_uint32 unused7;

#else

PHYSFS_uint32 unused6;

PHYSFS_uint32 unused7;

PHYSFS_uint32 path_table_start;

PHYSFS_uint32 opt_path_table_start;

#endif

ISO9660RootDirectoryRecord rootdirectory;

char set_identifier[128];

char publisher_identifier[128];

char preparer_identifer[128];

char application_identifier[128];

char copyright_file_identifier[37];

char abstract_file_identifier[37];

char bibliographic_file_identifier[37];

ISO9660VolumeTimestamp creation_timestamp;

ISO9660VolumeTimestamp modification_timestamp;

ISO9660VolumeTimestamp expiration_timestamp;

ISO9660VolumeTimestamp effective_timestamp;

PHYSFS_uint8 file_structure_version;

char unused4;

char application_use[512];

char unused5[653];

} ISO9660VolumeDescriptor;

typedef struct

{

PHYSFS_uint8 recordlen;

PHYSFS_uint8 extattributelen;

ISOBB32bit(extentpos)

ISOBB32bit(datalen)

ISO9660FileTimestamp recordtime;

ISO9660FileFlags flags;

PHYSFS_uint8 file_unit_size;

PHYSFS_uint8 interleave_gap;

ISOBB16bit(volseqno)

PHYSFS_uint8 filenamelen;

char filename[222]; /* This is not exact, but makes reading easier */

} ISO9660FileDescriptor;

typedef struct

{

ISOBB16bit(owner)

ISOBB16bit(group)

PHYSFS_uint16 flags; /* not implemented*/

ISO9660VolumeTimestamp create_time; /* yes, not file timestamp */

ISO9660VolumeTimestamp mod_time;

ISO9660VolumeTimestamp expire_time;

ISO9660VolumeTimestamp effective_time;

PHYSFS_uint8 record_format;

PHYSFS_uint8 record_attributes;

ISOBB16bit(record_len)

char system_identifier[32];

char system_use[64];

PHYSFS_uint8 version;

ISOBB16bit(escape_len)

char reserved[64];

/** further fields not implemented */

} ISO9660ExtAttributeRec;

#pragma pack(pop) /* restore original alignment from stack */

typedef struct

{

PHYSFS_uint32 rootdirstart;

PHYSFS_uint32 rootdirsize;

PHYSFS_uint64 currpos;

int isjoliet;

char *path;

void *mutex;

} ISO9660Handle;

typedef struct __ISO9660FileHandle

{

PHYSFS_sint64 filesize;

PHYSFS_uint64 currpos;

PHYSFS_uint64 startblock;

ISO9660Handle *isohandle;

PHYSFS_uint32 (*read) (struct __ISO9660FileHandle *filehandle, void *buffer,

/* !!! FIXME: anonymouse union is going to cause problems. */

union

{

};

} ISO9660FileHandle;

/*******************************************************************************

* Time conversion functions

******************************************************************************/

static PHYSFS_sint64 iso_mktime(ISO9660FileTimestamp *timestamp)

{

struct tm tm;

tm.tm_year = timestamp->year;

tm.tm_mon = timestamp->month - 1;

tm.tm_mday = timestamp->day;

tm.tm_hour = timestamp->hour;

tm.tm_min = timestamp->minute;

tm.tm_sec = timestamp->second;

/* Ignore GMT offset for now... */

return mktime(&tm);

} /* iso_mktime */

static int iso_atoi2(char *text)

{

return ((text[0] - 40) * 10) + (text[1] - 40);

} /* iso_atoi2 */

static int iso_atoi4(char *text)

{

return ((text[0] - 40) * 1000) + ((text[1] - 40) * 100) +

((text[2] - 40) * 10) + (text[3] - 40);

} /* iso_atoi4 */

static PHYSFS_sint64 iso_volume_mktime(ISO9660VolumeTimestamp *timestamp)

{

PHYSFS_sint64 value;

struct tm tm;

tm.tm_year = iso_atoi4(timestamp->year);

tm.tm_mon = iso_atoi2(timestamp->month) - 1;

tm.tm_mday = iso_atoi2(timestamp->day);

tm.tm_hour = iso_atoi2(timestamp->hour);

tm.tm_min = iso_atoi2(timestamp->minute);

tm.tm_sec = iso_atoi2(timestamp->second);

/* this allows values outside the range of a unix timestamp... sanitize them */

return value == -1 ? 0 : value;

} /* iso_volume_mktime */

/*******************************************************************************

* Filename extraction

******************************************************************************/

static int iso_extractfilenameISO(ISO9660FileDescriptor *descriptor,

char *filename, int *version)

{

*filename = '\0';

if (descriptor->flags.directory)

{

strncpy(filename, descriptor->filename, descriptor->filenamelen);

filename[descriptor->filenamelen] = '\0';

*version = 0;

} /* if */

else

{

/* find last SEPARATOR2 */

int pos = 0;

int lastfound = -1;

for(;pos < descriptor->filenamelen; pos++)

if (descriptor->filename[pos] == ';')

lastfound = pos;

BAIL_IF(lastfound < 1, PHYSFS_ERR_NOT_FOUND /* !!! FIXME: PHYSFS_ERR_BAD_FILENAME */, -1);

BAIL_IF(lastfound == (descriptor->filenamelen -1), PHYSFS_ERR_NOT_FOUND /* !!! PHYSFS_ERR_BAD_FILENAME */, -1);

strncpy(filename, descriptor->filename, lastfound);

if (filename[lastfound - 1] == '.')

filename[lastfound - 1] = '\0'; /* consume trailing ., as done in all implementations */

else

filename[lastfound] = '\0';

*version = atoi(descriptor->filename + lastfound);

} /* else */

return 0;

} /* iso_extractfilenameISO */

static int iso_extractfilenameUCS2(ISO9660FileDescriptor *descriptor,

char *filename, int *version)

{

PHYSFS_uint16 tmp[128];

PHYSFS_uint16 *src;

int len;

*filename = '\0';

*version = 1; /* Joliet does not have versions.. at least not on my images */

src = (PHYSFS_uint16*) descriptor->filename;

len = descriptor->filenamelen / 2;

tmp[len] = 0;

while(len--)

tmp[len] = PHYSFS_swapUBE16(src[len]);

PHYSFS_utf8FromUcs2(tmp, filename, 255);

return 0;

} /* iso_extractfilenameUCS2 */

static int iso_extractfilename(ISO9660Handle *handle,

ISO9660FileDescriptor *descriptor, char *filename,int *version)

{

if (handle->isjoliet)

return iso_extractfilenameUCS2(descriptor, filename, version);

else

return iso_extractfilenameISO(descriptor, filename, version);

} /* iso_extractfilename */

/*******************************************************************************

* Basic image read functions

******************************************************************************/

static int iso_readimage(ISO9660Handle *handle, PHYSFS_uint64 where,

{

int rc = -1;

if (rc == -1)

{

handle->currpos = (PHYSFS_uint64) -1;

unlockme:

__PHYSFS_platformReleaseMutex(handle->mutex);

return rc;

} /* iso_readimage */

static PHYSFS_sint64 iso_readfiledescriptor(ISO9660Handle *handle,

PHYSFS_uint64 where,

ISO9660FileDescriptor *descriptor)

{

PHYSFS_sint64 rc = iso_readimage(handle, where, descriptor,

BAIL_IF_ERRPASS(rc == -1, -1);

BAIL_IF(rc != 1, PHYSFS_ERR_CORRUPT, -1);

if (descriptor->recordlen == 0)

return 0; /* fill bytes at the end of a sector */

rc = iso_readimage(handle, where + 1, &descriptor->extattributelen,

BAIL_IF_ERRPASS(rc == -1, -1);

BAIL_IF(rc != 1, PHYSFS_ERR_CORRUPT, -1);

return 0;

} /* iso_readfiledescriptor */

static void iso_extractsubpath(char *path, char **subpath)

{

*subpath = strchr(path,'/');

if (*subpath != 0)

{

**subpath = 0;

*subpath +=1;

} /* if */

} /* iso_extractsubpath */

/*

* Don't use path tables, they are not necessarily faster, but more complicated

* to implement as they store only directories and not files, so searching for

* a file needs to branch to the directory extent sooner or later.

*/

static int iso_find_dir_entry(ISO9660Handle *handle,const char *path,

{

char *subpath = 0;

PHYSFS_uint64 readpos, end_of_dir;

char filename[255];

char pathcopy[256];

char *mypath;

int version = 0;

strcpy(pathcopy, path);

mypath = pathcopy;

readpos = handle->rootdirstart;

end_of_dir = handle->rootdirstart + handle->rootdirsize;

iso_extractsubpath(mypath, &subpath);

while (1)

{

/* recordlen = 0 -> no more entries or fill entry */

if (!descriptor->recordlen)

{

/* if we are in the last sector of the directory & it's 0 -> end */

if ((end_of_dir - 2048) <= (readpos -1))

break; /* finished */

/* else skip to the next sector & continue; */

readpos = (((readpos - 1) / 2048) + 1) * 2048;

continue;

} /* if */

readpos += descriptor->recordlen;

if (descriptor->filenamelen == 1 && (descriptor->filename[0] == 0

|| descriptor->filename[0] == 1))

continue; /* special ones, ignore */

if (strcmp(filename, mypath) == 0)

{

if ( (subpath == 0) || (subpath[0] == 0) )

return 0; /* no subpaths left and we found the entry */

if (descriptor->flags.directory)

{

/* shorten the path to the subpath */

mypath = subpath;

iso_extractsubpath(mypath, &subpath);

/* gosub to the new directory extent */

readpos = descriptor->extentpos * 2048;

end_of_dir = readpos + descriptor->datalen;

} /* if */

else

{

/* we're at a file but have a remaining subpath -> no match */

return 0;

} /* else */

} /* if */

} /* while */

return 0;

} /* iso_find_dir_entry */

static int iso_read_ext_attributes(ISO9660Handle *handle, int block,

ISO9660ExtAttributeRec *attributes)

{

return iso_readimage(handle, block * 2048, attributes,

} /* iso_read_ext_attributes */

static void ISO9660_destroy(PHYSFS_Io *io)

{

ISO9660FileHandle *fhandle = (ISO9660FileHandle*) io->opaque;

fhandle->close(fhandle);

allocator.Free(io);

} /* ISO9660_destroy */

static PHYSFS_sint64 ISO9660_read(PHYSFS_Io *io, void *buf, PHYSFS_uint64 len)

{

ISO9660FileHandle *fhandle = (ISO9660FileHandle*) io->opaque;

return fhandle->read(fhandle, buf, len);

} /* ISO9660_read */

static PHYSFS_sint64 ISO9660_write(PHYSFS_Io *io, const void *b, PHYSFS_uint64 l)

{

} /* ISO9660_write */

static PHYSFS_sint64 ISO9660_tell(PHYSFS_Io *io)

{

return ((ISO9660FileHandle*) io->opaque)->currpos;

} /* ISO9660_tell */

static int ISO9660_seek(PHYSFS_Io *io, PHYSFS_uint64 offset)

{

ISO9660FileHandle *fhandle = (ISO9660FileHandle*) io->opaque;

return fhandle->seek(fhandle, offset);

} /* ISO9660_seek */

static PHYSFS_sint64 ISO9660_length(PHYSFS_Io *io)

{

return ((ISO9660FileHandle*) io->opaque)->filesize;

} /* ISO9660_length */

static const PHYSFS_Io ISO9660_Io =

{

ISO9660_read,

ISO9660_write,

ISO9660_seek,

ISO9660_tell,

ISO9660_length,

ISO9660_duplicate,

ISO9660_flush,

};

/*******************************************************************************

* Archive management functions

******************************************************************************/

ISO9660Handle *handle;

int founddescriptor = 0;

int foundjoliet = 0;

assert(io != NULL); /* shouldn't ever happen. */

/* Skip system area to magic number in Volume descriptor */

BAIL_IF_ERRPASS(!io->seek(io, 32769), NULL);

BAIL_IF_ERRPASS(io->read(io, magicnumber, 5) != 5, NULL);

handle = allocator.Malloc(sizeof(ISO9660Handle));

handle->path = 0;

handle->mutex= 0;

handle->path = allocator.Malloc(strlen(filename) + 1);

strcpy(handle->path, filename);

handle->mutex = __PHYSFS_platformCreateMutex();

/* seek Primary Volume Descriptor */

while (1)

{

ISO9660VolumeDescriptor descriptor;

GOTO_IF_ERRPASS(io->read(io, &descriptor, sizeof(ISO9660VolumeDescriptor)) != sizeof(ISO9660VolumeDescriptor), errorcleanup);

GOTO_IF(strncmp(descriptor.identifier, "CD001", 5) != 0, PHYSFS_ERR_UNSUPPORTED, errorcleanup);

if (descriptor.type == 255)

{

/* type 255 terminates the volume descriptor list */

if (founddescriptor)

return handle; /* ok, we've found one volume descriptor */

else

} /* if */

if (descriptor.type == 1 && !founddescriptor)

{

handle->rootdirstart =

descriptor.rootdirectory.extent_location * 2048;

handle->rootdirsize =

descriptor.rootdirectory.data_length;

handle->isjoliet = 0;

founddescriptor = 1; /* continue search for joliet */

} /* if */

if (descriptor.type == 2 && !foundjoliet)

{

/* check if is joliet */

PHYSFS_uint8 *s = descriptor.escape_sequences;

int joliet = !(descriptor.flags & 1)

&& (s[0] == 0x25)

&& (s[1] == 0x2F)

&& ((s[2] == 0x40) || (s[2] == 0x43) || (s[2] == 0x45));

if (!joliet)

continue;

handle->rootdirstart =

descriptor.rootdirectory.extent_location * 2048;

handle->rootdirsize =

descriptor.rootdirectory.data_length;

handle->isjoliet = 1;

founddescriptor = 1;

foundjoliet = 1;

} /* if */

} /* while */

errorcleanup:

if (handle)

{

if (handle->path)

allocator.Free(handle->path);

if (handle->mutex)

__PHYSFS_platformDestroyMutex(handle->mutex);

} /* if */

return NULL;

} /* ISO9660_openArchive */

{

ISO9660Handle *handle = (ISO9660Handle*) opaque;

__PHYSFS_platformDestroyMutex(handle->mutex);

allocator.Free(handle->path);

allocator.Free(handle);

/*******************************************************************************

* Read functions

******************************************************************************/

static PHYSFS_uint32 iso_file_read_mem(ISO9660FileHandle *filehandle,

{

/* check remaining bytes & max obj which can be fetched */

const PHYSFS_sint64 bytesleft = filehandle->filesize - filehandle->currpos;

if (bytesleft < len)

len = bytesleft;

return 0;

memcpy(buffer, filehandle->cacheddata + filehandle->currpos, (size_t) len);

filehandle->currpos += len;

return (PHYSFS_uint32) len;

} /* iso_file_read_mem */

static int iso_file_seek_mem(ISO9660FileHandle *fhandle, PHYSFS_sint64 offset)

{

BAIL_IF(offset < 0, PHYSFS_ERR_INVALID_ARGUMENT, 0);

BAIL_IF(offset >= fhandle->filesize, PHYSFS_ERR_PAST_EOF, 0);

fhandle->currpos = offset;

return 0;

} /* iso_file_seek_mem */

{

allocator.Free(fhandle->cacheddata);

allocator.Free(fhandle);

static PHYSFS_uint32 iso_file_read_foreign(ISO9660FileHandle *filehandle,

PHYSFS_sint64 rc;

const PHYSFS_sint64 bytesleft = filehandle->filesize - filehandle->currpos;

if (bytesleft < len)

len = bytesleft;

return rc;

} /* iso_file_read_foreign */

static int iso_file_seek_foreign(ISO9660FileHandle *fhandle,

PHYSFS_sint64 offset)

{

PHYSFS_sint64 pos;

BAIL_IF(offset < 0, PHYSFS_ERR_INVALID_ARGUMENT, 0);

BAIL_IF(offset >= fhandle->filesize, PHYSFS_ERR_PAST_EOF, 0);

fhandle->currpos = offset;

return 0;

} /* iso_file_seek_foreign */

allocator.Free(fhandle);

} /* iso_file_close_foreign */

static int iso_file_open_mem(ISO9660Handle *handle, ISO9660FileHandle *fhandle)

{

int rc;

GOTO_IF_ERRPASS(rc < 0, freemem);

GOTO_IF(rc == 0, PHYSFS_ERR_CORRUPT, freemem);

fhandle->read = iso_file_read_mem;

fhandle->seek = iso_file_seek_mem;

fhandle->close = iso_file_close_mem;

return 0;

freemem:

allocator.Free(fhandle->cacheddata);

return -1;

} /* iso_file_open_mem */

static int iso_file_open_foreign(ISO9660Handle *handle,

ISO9660FileHandle *fhandle)

{

BAIL_IF_ERRPASS(!fhandle->io, -1);

if (!fhandle->io->seek(fhandle->io, fhandle->startblock * 2048))

{

fhandle->io->destroy(fhandle->io);

return -1;

} /* if */

fhandle->read = iso_file_read_foreign;

fhandle->seek = iso_file_seek_foreign;

fhandle->close = iso_file_close_foreign;

return 0;

} /* iso_file_open_foreign */

ISO9660Handle *handle = (ISO9660Handle*) opaque;

ISO9660FileHandle *fhandle;

ISO9660FileDescriptor descriptor;

int rc;

fhandle = allocator.Malloc(sizeof(ISO9660FileHandle));

fhandle->cacheddata = 0;

fhandle->startblock = descriptor.extentpos + descriptor.extattributelen;

fhandle->filesize = descriptor.datalen;

fhandle->currpos = 0;

fhandle->isohandle = handle;

fhandle->cacheddata = NULL;

if (descriptor.datalen <= ISO9660_FULLCACHEMAXSIZE)

rc = iso_file_open_mem(handle, fhandle);

else

rc = iso_file_open_foreign(handle, fhandle);

memcpy(retval, &ISO9660_Io, sizeof (PHYSFS_Io));

retval->opaque = fhandle;

return retval;

errorhandling:

if (retval) allocator.Free(retval);

if (fhandle) allocator.Free(fhandle);

return NULL;

} /* ISO9660_openRead */

/*******************************************************************************

* Information gathering functions

******************************************************************************/

PHYSFS_EnumFilesCallback cb,

const char *origdir, void *callbackdata)

{

ISO9660Handle *handle = (ISO9660Handle*) opaque;

ISO9660FileDescriptor descriptor;

PHYSFS_uint64 readpos;

PHYSFS_uint64 end_of_dir;

char filename[130]; /* ISO allows 31, Joliet 128 -> 128 + 2 eol bytes */

int version = 0;

if (*dname == '\0')

{

readpos = handle->rootdirstart;

end_of_dir = readpos + handle->rootdirsize;

} /* if */

else

{

printf("pfad %s\n",dname);

BAIL_IF_ERRPASS(iso_find_dir_entry(handle,dname, &descriptor),);

BAIL_IF_ERRPASS(!descriptor.flags.directory,);

readpos = descriptor.extentpos * 2048;

end_of_dir = readpos + descriptor.datalen;

} /* else */

while (1)

{

/* recordlen = 0 -> no more entries or fill entry */

if (!descriptor.recordlen)

{

/* if we are in the last sector of the directory & it's 0 -> end */

if ((end_of_dir - 2048) <= (readpos -1))

break; /* finished */

/* else skip to the next sector & continue; */

readpos = (((readpos - 1) / 2048) + 1) * 2048;

continue;

} /* if */

readpos += descriptor.recordlen;

if (descriptor.filenamelen == 1 && (descriptor.filename[0] == 0

|| descriptor.filename[0] == 1))

continue; /* special ones, ignore */

strncpy(filename,descriptor.filename,descriptor.filenamelen);

iso_extractfilename(handle, &descriptor, filename, &version);

cb(callbackdata, origdir,filename);

} /* while */

} /* ISO9660_enumerateFiles */

{

ISO9660Handle *handle = (ISO9660Handle*) opaque;

ISO9660FileDescriptor descriptor;

ISO9660ExtAttributeRec extattr;

stat->readonly = 1;

/* try to get extended info */

if (descriptor.extattributelen)

{