/* $Id: iso9660.h,v 1.71 2005/02/21 09:00:53 rocky Exp $ Copyright (C) 2000 Herbert Valerio Riedel Copyright (C) 2003, 2004, 2005 Rocky Bernstein See also iso9660.h by Eric Youngdale (1993). Copyright 1993 Yggdrasil Computing, Incorporated Copyright (c) 1999,2000 J. Schilling This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program 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 General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /*! * \file iso9660.h * * \brief The top-level interface eader for libiso9660: the ISO-9660 * filesystem library; applications include this. * * See also the ISO-9660 specification. The freely available European * equivalant standard is called ECMA-119. */ #ifndef __CDIO_ISO9660_H__ #define __CDIO_ISO9660_H__ #include #include #include /** \brief ISO 9660 Integer and Character types These are described in the section 7 of the ISO 9660 (or ECMA 119) specification. */ typedef uint8_t iso711_t; /*! See section 7.1.1 */ typedef uint16_t iso721_t; /*! See section 7.2.1 */ typedef uint16_t iso722_t; /*! See section 7.2.2 */ typedef uint32_t iso723_t; /*! See section 7.2.3 */ typedef uint32_t iso731_t; /*! See section 7.3.1 */ typedef uint32_t iso732_t; /*! See section 7.3.2 */ typedef uint64_t iso733_t; /*! See section 7.3.3 */ typedef char achar_t; /*! See section 7.4.1 */ typedef char dchar_t; /*! See section 7.4.1 */ #ifndef EMPTY_ARRAY_SIZE #define EMPTY_ARRAY_SIZE 0 #endif #include #include #define _delta(from, to) ((to) - (from) + 1) #define MIN_TRACK_SIZE 4*75 #define MIN_ISO_SIZE MIN_TRACK_SIZE /*! An enumeration for some of the ISO_* #defines below. This isn't really an enumeration one would really use in a program it is here to be helpful in debuggers where wants just to refer to the ISO_*_ names and get something. */ extern enum iso_enums1 { ISO_PVD_SECTOR = 16, /**< Sector of Primary Volume Descriptor */ ISO_EVD_SECTOR = 17, /**< Sector of End Volume Descriptor */ LEN_ISONAME = 31, /**< size in bytes of the filename portion + null byte */ ISO_MAX_SYSTEM_ID = 32, /**< Maximum number of characters in a system id. */ MAX_ISONAME = 37, /**< size in bytes of the filename portion + null byte */ ISO_MAX_PREPARER_ID = 128, /**< Maximum number of characters in a preparer id. */ MAX_ISOPATHNAME = 255, ISO_BLOCKSIZE = 2048 } iso_enums1; /*! An enumeration for some of the ISO_* #defines below. This isn't really an enumeration one would really use in a program it is here to be helpful in debuggers where wants just to refer to the ISO_*_ names and get something. */ extern enum iso_flag_enums { ISO_FILE = 0, /**< Not really a flag... */ ISO_EXISTENCE = 1, /**< Do not make existence known (hidden) */ ISO_DIRECTORY = 2, /**< This file is a directory */ ISO_ASSOCIATED = 4, /**< This file is an associated file */ ISO_RECORD = 8, /**< Record format in extended attr. != 0 */ ISO_PROECTION = 16, /**< No read/execute perm. in ext. attr. */ ISO_DRESERVED1 = 32, /**<, Reserved bit 5 */ ISO_DRESERVED2 = 64, /**<, Reserved bit 6 */ ISO_MULTIEXTENT = 128, /**< Not final entry of a mult. ext. file */ } iso_flag_enums; extern enum iso_vd_enums { ISO_VD_BOOT_RECORD = 0, /**< CD is bootable */ ISO_VD_PRIMARY = 1, /**< Is in any ISO-9660 */ ISO_VD_SUPPLEMENARY = 2, /**< Used by Joliet, for example */ ISO_VD_PARITION = 3, /**< Indicates a partition of a CD */ ISO_VD_END = 255 } iso_vd_enums; /*! An ISO filename is: "abcde.eee;1" -> '.' ';' For ISO-9660 Level 1, the maximum needed string length is: @code 30 chars (filename + ext) + 2 chars ('.' + ';') + 5 chars (strlen("32767")) + 1 null byte ================================ = 38 chars @endcode */ /*! \brief size in bytes of the filename portion + null byte */ #define LEN_ISONAME 31 /*! \brief Maximum number of characters in the entire ISO 9660 filename. */ #define MAX_ISONAME 37 /*! \brief Maximum number of characters in the entire ISO 9660 filename. */ #define MAX_ISOPATHNAME 255 /*! \brief Maximum number of characters in a preparer id. */ #define ISO_MAX_PREPARER_ID 128 /*! \brief Maximum number of characters in a publisher id. */ #define ISO_MAX_PUBLISHER_ID 128 /*! \brief Maximum number of characters in an application id. */ #define ISO_MAX_APPLICATION_ID 128 /*! \brief Maximum number of characters in a system id. */ #define ISO_MAX_SYSTEM_ID 32 /*! \brief Maximum number of characters in a volume id. */ #define ISO_MAX_VOLUME_ID 32 /*! \brief Maximum number of characters in a volume-set id. */ #define ISO_MAX_VOLUMESET_ID 128 /**! ISO 9660 directory flags. */ #define ISO_FILE 0 /**< Not really a flag... */ #define ISO_EXISTENCE 1 /**< Do not make existence known (hidden) */ #define ISO_DIRECTORY 2 /**< This file is a directory */ #define ISO_ASSOCIATED 4 /**< This file is an associated file */ #define ISO_RECORD 8 /**< Record format in extended attr. != 0 */ #define ISO_PROTECTION 16 /**< No read/execute perm. in ext. attr. */ #define ISO_DRESERVED1 32 /**< Reserved bit 5 */ #define ISO_DRESERVED2 64 /**< Reserved bit 6 */ #define ISO_MULTIEXTENT 128 /**< Not final entry of a mult. ext. file */ /**! Volume descriptor types */ #define ISO_VD_BOOT_RECORD 0 /**< CD is bootable */ #define ISO_VD_PRIMARY 1 /**< Is in any ISO-9660 */ #define ISO_VD_SUPPLEMENTARY 2 /**< Used by Joliet, for example */ #define ISO_VD_PARITION 3 /**< Indicates a partition of a CD */ #define ISO_VD_END 255 /*! Sector of Primary Volume Descriptor */ #define ISO_PVD_SECTOR 16 /*! Sector of End Volume Descriptor */ #define ISO_EVD_SECTOR 17 /*! String inside frame which identifies an ISO 9660 filesystem. This string is the "id" field of an iso9660_pvd_t or an iso9660_svd_t. */ extern const char ISO_STANDARD_ID[sizeof("CD001")-1]; #define ISO_STANDARD_ID "CD001" /*! Number of bytes in an ISO 9660 block */ #define ISO_BLOCKSIZE 2048 #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ typedef enum strncpy_pad_check { ISO9660_NOCHECK = 0, ISO9660_7BIT, ISO9660_ACHARS, ISO9660_DCHARS } strncpy_pad_check_t; PRAGMA_BEGIN_PACKED /*! \brief ISO-9660 shorter-format time structure. @see iso9660_dtime */ struct iso9660_dtime_s { uint8_t dt_year; uint8_t dt_month; /**< Has value in range 1..12. Note starts at 1, not 0 like a tm struct. */ uint8_t dt_day; uint8_t dt_hour; uint8_t dt_minute; uint8_t dt_second; int8_t dt_gmtoff; /**< GMT values -48 .. + 52 in 15 minute intervals */ } GNUC_PACKED; typedef struct iso9660_dtime_s iso9660_dtime_t; /*! \brief ISO-9660 longer-format time structure. Section 8.4.26.1 of ECMA 119 @see iso9660_ltime */ struct iso9660_ltime_s { char lt_year [_delta( 1, 4)]; /**< Add 1900 to value for the Julian year */ char lt_month [_delta( 5, 6)]; /**< Has value in range 1..12. Note starts at 1, not 0 like a tm struct. */ char lt_day [_delta( 7, 8)]; char lt_hour [_delta( 9, 10)]; char lt_minute [_delta( 11, 12)]; char lt_second [_delta( 13, 14)]; char lt_hsecond [_delta( 15, 16)]; /** /*! \brief Format of an ISO-9660 directory record Section 9.1 of ECMA 119. This structure may have an odd length depending on how many characters there are in the filename! Some compilers (e.g. on Sun3/mc68020) pad the structures to an even length. For this reason, we cannot use sizeof (struct iso_path_table) or sizeof (struct iso_directory_record) to compute on disk sizes. Instead, we use offsetof(..., name) and add the name size. See mkisofs.h of the cdrtools package. @see iso9660_stat */ struct iso9660_dir_s { iso711_t length; /*! Length of Directory record (9.1.1) */ iso711_t xa_length; /*! XA length if XA is used. Otherwise zero. (9.1.2) */ iso733_t extent; /*! LBA of first local block allocated to the extent */ iso733_t size; /*! data length of File Section. This does not include the length of any XA Records. (9.1.2) */ iso9660_dtime_t recording_time; /*! Recording date and time (9.1.3) */ uint8_t file_flags; /*! If no XA then zero. If a directory, then bits 2,3 and 7 are zero. (9.1.6) */ iso711_t file_unit_size; /*! File Unit size for the File Section if the File Section is recorded in interleaved mode. Otherwise zero. (9.1.7) */ iso711_t interleave_gap; /*! Interleave Gap size for the File Section if the File Section is interleaved. Otherwise zero. (9.1.8) */ iso723_t volume_sequence_number; /*! Ordinal number of the volume in the Volume Set on which the Extent described by this Directory Record is recorded. (9.1.9) */ iso711_t filename_len; /*! number of bytes in filename field */ char filename[EMPTY_ARRAY_SIZE]; } GNUC_PACKED; /*! \brief ISO-9660 Primary Volume Descriptor. */ struct iso9660_pvd_s { iso711_t type; /**< ISO_VD_PRIMARY - 1 */ char id[5]; /**< ISO_STANDARD_ID "CD001" */ iso711_t version; /**< value 1 for ECMA 119 */ char unused1[1]; /**< unused - value 0 */ achar_t system_id[ISO_MAX_SYSTEM_ID]; /**< each char is an achar */ dchar_t volume_id[ISO_MAX_VOLUME_ID]; /**< each char is a dchar */ uint8_t unused2[8]; /**< unused - value 0 */ iso733_t volume_space_size; /**< total number of sectors */ uint8_t unused3[32]; /**< unused - value 0 */ iso723_t volume_set_size; /**< often 1 */ iso723_t volume_sequence_number; /**< often 1 */ iso723_t logical_block_size; /**< sector size, e.g. 2048 */ iso733_t path_table_size; /**< bytes in path table */ iso731_t type_l_path_table; /**< first sector of L Path Table */ iso731_t opt_type_l_path_table; /**< first sector of optional L Path Table */ iso732_t type_m_path_table; /**< first sector of M Path table */ iso732_t opt_type_m_path_table; /**< first sector of optional M Path table */ iso9660_dir_t root_directory_record; /**< See section 9.1 of ISO 9660 spec. */ char root_directory_filename; /**< Is '\\0' */ dchar_t volume_set_id[ISO_MAX_VOLUMESET_ID]; /**< Volume Set of which the volume is a member. See section 8.4.19 */ achar_t publisher_id[ISO_MAX_PUBLISHER_ID]; /**< Publisher of volume. If the first character is '_' 0x5F, the remaining bytes specify a file containing the user. If all bytes are " " (0x20) no publisher is specified. See section 8.4.20 of ECMA 119 */ achar_t preparer_id[ISO_MAX_PREPARER_ID]; /**< preparer of volume. If the first character is '_' 0x5F, the remaining bytes specify a file containing the user. If all bytes are " " (0x20) no preparer is specified. See section 8.4.21 of ECMA 119 */ achar_t application_id[ISO_MAX_APPLICATION_ID]; /**< application use to create the volume. If the first character is '_' 0x5F, the remaining bytes specify a file containing the user. If all bytes are " " (0x20) no application is specified. See section of 8.4.22 of ECMA 119 */ dchar_t copyright_file_id[37]; /**< Name of file for copyright info. If all bytes are " " (0x20), then no file is identified. See section 8.4.23 of ECMA 119 9660 spec. */ dchar_t abstract_file_id[37]; /**< See section 8.4.24 of ECMA 119. */ dchar_t bibliographic_file_id[37]; /**< See section 7.5 of ISO 9660 spec. */ iso9660_ltime_t creation_date; /**< date and time of volume creation. See section 8.4.26.1 of the ISO 9660 spec. */ iso9660_ltime_t modification_date; /**< date and time of the most recent modification. See section 8.4.27 of the ISO 9660 spec. */ iso9660_ltime_t expiration_date; /**< date and time when volume expires. See section 8.4.28 of the ISO 9660 spec. */ iso9660_ltime_t effective_date; /**< date and time when volume is effective. See section 8.4.29 of the ISO 9660 spec. */ iso711_t file_structure_version; /**< value 1 for ECMA 119 */ uint8_t unused4[1]; /**< unused - value 0 */ char application_data[512]; /**< Application can put whatever it wants here. */ uint8_t unused5[653]; /**< Unused - value 0 */ } GNUC_PACKED; typedef struct iso9660_pvd_s iso9660_pvd_t; /*! \brief ISO-9660 Supplementary Volume Descriptor. This is used for Joliet Extentions and is almost the same as the the primary descriptor but two unused fields, "unused1" and "unused3 become "flags and "escape_sequences" respectively. */ struct iso9660_svd_s { iso711_t type; /**< ISO_VD_SUPPLEMENTARY - 2 */ char id[5]; /**< ISO_STANDARD_ID "CD001" */ iso711_t version; /**< value 1 */ char flags; /**< Section 8.5.3 */ achar_t system_id[ISO_MAX_SYSTEM_ID]; /**< each char is an achar */ dchar_t volume_id[ISO_MAX_VOLUME_ID]; /**< each char is a dchar */ char unused2[8]; iso733_t volume_space_size; /**< total number of sectors */ char escape_sequences[32]; /**< Section 8.5.6 */ iso723_t volume_set_size; /**< often 1 */ iso723_t volume_sequence_number; /**< often 1 */ iso723_t logical_block_size; /**< sector size, e.g. 2048 */ iso733_t path_table_size; /**< bytes in path table */ iso731_t type_l_path_table; /**< first sector of little- endian path table */ iso731_t opt_type_l_path_table; /**< first sector of optional little-endian path table */ iso732_t type_m_path_table; /**< first sector of big- endian path table */ iso732_t opt_type_m_path_table; /**< first sector of optional big-endian path table */ iso9660_dir_t root_directory_record; /**< See section 9.1 of ISO 9660 spec. */ dchar_t volume_set_id[ISO_MAX_VOLUMESET_ID]; /**< dchars */ achar_t publisher_id[ISO_MAX_PUBLISHER_ID]; /**< Publisher of volume. If the first character is '_' 0x5F, the remaining bytes specify a file containing the user. If all bytes are " " (0x20) no publisher is specified. See section 8.4.20 of ECMA 119 */ achar_t preparer_id[ISO_MAX_PREPARER_ID]; /**< preparer of volume. If the first character is '_' 0x5F, the remaining bytes specify a file containing the user. If all bytes are " " (0x20) no preparer is specified. See section 8.4.21 of ECMA 119 */ achar_t application_id[ISO_MAX_APPLICATION_ID]; /**< application use to create the volume. If the first character is '_' 0x5F, the remaining bytes specify a file containing the user. If all bytes are " " (0x20) no application is specified. See section of 8.4.22 of ECMA 119 */ dchar_t copyright_file_id[37]; /**< Name of file for copyright info. If all bytes are " " (0x20), then no file is identified. See section 8.4.23 of ECMA 119 9660 spec. */ dchar_t abstract_file_id[37]; /**< See section 8.4.24 of ECMA 119. */ dchar_t bibliographic_file_id[37]; /**< See section 7.5 of ISO 9660 spec. */ iso9660_ltime_t creation_date; /**< date and time of volume creation. See section 8.4.26.1 of the ECMA 119 spec. */ iso9660_ltime_t modification_date; /**< date and time of the most recent modification. See section 8.4.27 of the ECMA 119 spec. */ iso9660_ltime_t expiration_date; /**< date and time when volume expires. See section 8.4.28 of the ECMA 119 spec. */ iso9660_ltime_t effective_date; /**< date and time when volume is effective. See section 8.4.29 of the ECMA 119 spec. */ iso711_t file_structure_version; /**< value 1 for ECMA 119 */ uint8_t unused4[1]; /**< unused - value 0 */ char application_data[512]; /**< Application can put whatever it wants here. */ uint8_t unused5[653]; /**< Unused - value 0 */ } GNUC_PACKED; typedef struct iso9660_svd_s iso9660_svd_t; PRAGMA_END_PACKED /*! \brief Unix stat-like version of iso9660_dir The iso9660_stat structure is not part of the ISO-9660 specification. We use it for our to communicate information in a C-library friendly way, e.g struct tm time structures and a C-style filename string. @see iso9660_dir */ struct iso9660_stat_s { /* big endian!! */ iso_rock_statbuf_t rr; /**< Rock Ridge-specific fields */ struct tm tm; /**< time on entry - FIXME merge with one of entries above, like ctime? */ lsn_t lsn; /**< start logical sector number */ uint32_t size; /**< total size in bytes */ uint32_t secsize; /**< number of sectors allocated */ iso9660_xa_t xa; /**< XA attributes */ enum { _STAT_FILE = 1, _STAT_DIR = 2 } type; char filename[EMPTY_ARRAY_SIZE]; /**< filename */ }; /** A mask used in iso9660_ifs_read_vd which allows what kinds of extensions we allow, eg. Joliet, Rock Ridge, etc. */ typedef uint8_t iso_extension_mask_t; /*! An enumeration for some of the ISO_EXTENSION_* #defines below. This isn't really an enumeration one would really use in a program it is here to be helpful in debuggers where wants just to refer to the ISO_EXTENSION_*_ names and get something. */ extern enum iso_extension_enums { ISO_EXTENSION_JOLIET_LEVEL1 = 0x01, ISO_EXTENSION_JOLIET_LEVEL2 = 0x02, ISO_EXTENSION_JOLIET_LEVEL3 = 0x04, ISO_EXTENSION_ROCK_RIDGE = 0x08, ISO_EXTENSION_HIGH_SIERRA = 0x10 } iso_extension_enums; #define ISO_EXTENSION_JOLIET_LEVEL1 0x01 #define ISO_EXTENSION_JOLIET_LEVEL2 0x02 #define ISO_EXTENSION_JOLIET_LEVEL3 0x04 #define ISO_EXTENSION_ROCK_RIDGE 0x08 #define ISO_EXTENSION_HIGH_SIERRA 0x10 #define ISO_EXTENSION_ALL 0xFF #define ISO_EXTENSION_NONE 0x00 #define ISO_EXTENSION_JOLIET \ (ISO_EXTENSION_JOLIET_LEVEL1 | \ ISO_EXTENSION_JOLIET_LEVEL2 | \ ISO_EXTENSION_JOLIET_LEVEL3 ) /** This is an opaque structure. */ typedef struct _iso9660_s iso9660_t; /*! Open an ISO 9660 image for reading. Maybe in the future we will have a mode. NULL is returned on error. */ iso9660_t *iso9660_open (const char *psz_path /*flags, mode */); /*! Open an ISO 9660 image for reading allowing various ISO 9660 extensions. Maybe in the future we will have a mode. NULL is returned on error. */ iso9660_t *iso9660_open_ext (const char *psz_path, iso_extension_mask_t iso_extension_mask); /*! Open an ISO 9660 image for reading with some tolerence for positioning of the ISO9660 image. Here we will scan for ISO_STANDARD_ID and set that position as the Maybe in the future we will have a mode. NULL is returned on error. @see iso9660_open */ iso9660_t *iso9660_open_fuzzy (const char *psz_path /*flags, mode */, uint16_t i_fuzz); /*! Open an ISO 9660 image for reading with some tolerence for positioning of the ISO9660 image. Here we will scan for ISO_STANDARD_ID and set that position as the Maybe in the future we will have a mode. NULL is returned on error. @see iso9660_open */ iso9660_t *iso9660_open_fuzzy_ext (const char *psz_path, iso_extension_mask_t iso_extension_mask, uint16_t i_fuzz /*flags, mode */); /*! Read the Super block of an ISO 9660 image but determine framesize and datastart and a possible additional offset. Generally here we are not reading an ISO 9660 image but a CD-Image which contains an ISO 9660 filesystem. */ bool iso9660_ifs_fuzzy_read_superblock (iso9660_t *p_iso, iso_extension_mask_t iso_extension_mask, uint16_t i_fuzz); /*! Close previously opened ISO 9660 image. True is unconditionally returned. If there was an error false would be returned. */ bool iso9660_close (iso9660_t * p_iso); /*! Seek to a position and then read n bytes. Size read is returned. */ long int iso9660_iso_seek_read (const iso9660_t *p_iso, void *ptr, lsn_t start, long int i_size); /*! Read the Primary Volume Descriptor for a CD. True is returned if read, and false if there was an error. */ bool iso9660_fs_read_pvd ( const CdIo_t *p_cdio, /*out*/ iso9660_pvd_t *p_pvd ); /*! Read the Primary Volume Descriptor for an ISO 9660 image. True is returned if read, and false if there was an error. */ bool iso9660_ifs_read_pvd (const iso9660_t *p_iso, /*out*/ iso9660_pvd_t *p_pvd); /*! Read the Super block of an ISO 9660 image. This is the Primary Volume Descriptor (PVD) and perhaps a Supplemental Volume Descriptor if (Joliet) extensions are acceptable. */ bool iso9660_fs_read_superblock (CdIo_t *p_cdio, iso_extension_mask_t iso_extension_mask); /*! Read the Supper block of an ISO 9660 image. This is the Primary Volume Descriptor (PVD) and perhaps a Supplemental Volume Descriptor if (Joliet) extensions are acceptable. */ bool iso9660_ifs_read_superblock (iso9660_t *p_iso, iso_extension_mask_t iso_extension_mask); /*==================================================== Time conversion ====================================================*/ /*! Set time in format used in ISO 9660 directory index record from a Unix time structure. */ void iso9660_set_dtime (const struct tm *tm, /*out*/ iso9660_dtime_t *idr_date); /*! Set "long" time in format used in ISO 9660 primary volume descriptor from a Unix time structure. */ void iso9660_set_ltime (const struct tm *_tm, /*out*/ iso9660_ltime_t *p_pvd_date); /*! Get Unix time structure from format use in an ISO 9660 directory index record. Even though tm_wday and tm_yday fields are not explicitly in idr_date, they are calculated from the other fields. If tm is to reflect the localtime, set "use_localtime" true, otherwise tm will reported in GMT. */ void iso9660_get_dtime (const iso9660_dtime_t *idr_date, bool use_localtime, /*out*/ struct tm *tm); /*==================================================== Characters used in file and directory and manipulation ====================================================*/ /*! Return true if c is a DCHAR - a character that can appear in an an ISO-9600 level 1 directory name. These are the ASCII capital letters A-Z, the digits 0-9 and an underscore. */ bool iso9660_isdchar (int c); /*! Return true if c is an ACHAR - These are the DCHAR's plus some ASCII symbols including the space symbol. */ bool iso9660_isachar (int c); /*! Convert ISO-9660 file name that stored in a directory entry into what's usually listed as the file name in a listing. Lowercase name, and remove trailing ;1's or .;1's and turn the other ;'s into version numbers. The length of the translated string is returned. */ int iso9660_name_translate(const char *psz_oldname, char *psz_newname); /*! Convert ISO-9660 file name that stored in a directory entry into what's usually listed as the file name in a listing. Lowercase name if not using Joliet extension. Remove trailing ;1's or .;1's and turn the other ;'s into version numbers. The length of the translated string is returned. */ int iso9660_name_translate_ext(const char *psz_old, char *psz_new, uint8_t i_joliet_level); /*! Pad string src with spaces to size len and copy this to dst. If len is less than the length of src, dst will be truncated to the first len characters of src. src can also be scanned to see if it contains only ACHARs, DCHARs, 7-bit ASCII chars depending on the enumeration _check. In addition to getting changed, dst is the return value. Note: this string might not be NULL terminated. */ char *iso9660_strncpy_pad(char dst[], const char src[], size_t len, enum strncpy_pad_check _check); /*===================================================================== file/dirname's ======================================================================*/ /*! Check that psz_path is a valid ISO-9660 directory name. A valid directory name should not start out with a slash (/), dot (.) or null byte, should be less than 37 characters long, have no more than 8 characters in a directory component which is separated by a /, and consist of only DCHARs. True is returned if psz_path is valid. */ bool iso9660_dirname_valid_p (const char psz_path[]); /*! Take psz_path and a version number and turn that into a ISO-9660 pathname. (That's just the pathname followd by ";" and the version number. For example, mydir/file.ext -> MYDIR/FILE.EXT;1 for version 1. The resulting ISO-9660 pathname is returned. */ char *iso9660_pathname_isofy (const char psz_path[], uint16_t i_version); /*! Check that psz_path is a valid ISO-9660 pathname. A valid pathname contains a valid directory name, if one appears and the filename portion should be no more than 8 characters for the file prefix and 3 characters in the extension (or portion after a dot). There should be exactly one dot somewhere in the filename portion and the filename should be composed of only DCHARs. True is returned if psz_path is valid. */ bool iso9660_pathname_valid_p (const char psz_path[]); /*===================================================================== directory tree ======================================================================*/ void iso9660_dir_init_new (void *dir, uint32_t self, uint32_t ssize, uint32_t parent, uint32_t psize, const time_t *dir_time); void iso9660_dir_init_new_su (void *dir, uint32_t self, uint32_t ssize, const void *ssu_data, unsigned int ssu_size, uint32_t parent, uint32_t psize, const void *psu_data, unsigned int psu_size, const time_t *dir_time); void iso9660_dir_add_entry_su (void *dir, const char filename[], uint32_t extent, uint32_t size, uint8_t file_flags, const void *su_data, unsigned int su_size, const time_t *entry_time); unsigned int iso9660_dir_calc_record_size (unsigned int namelen, unsigned int su_len); /*! Given a directory pointer, find the filesystem entry that contains lsn and return information about it. Returns stat_t of entry if we found lsn, or NULL otherwise. */ iso9660_stat_t *iso9660_find_fs_lsn(CdIo_t *p_cdio, lsn_t i_lsn); /*! Given a directory pointer, find the filesystem entry that contains lsn and return information about it. Returns stat_t of entry if we found lsn, or NULL otherwise. */ iso9660_stat_t *iso9660_find_ifs_lsn(const iso9660_t *p_iso, lsn_t i_lsn); /*! Return file status for psz_path. NULL is returned on error. */ iso9660_stat_t *iso9660_fs_stat (CdIo_t *p_cdio, const char psz_path[]); /*! Return file status for path name psz_path. NULL is returned on error. pathname version numbers in the ISO 9660 name are dropped, i.e. ;1 is removed and if level 1 ISO-9660 names are lowercased. */ iso9660_stat_t *iso9660_fs_stat_translate (CdIo_t *p_cdio, const char psz_path[], bool b_mode2); /*! Return file status for pathname. NULL is returned on error. */ iso9660_stat_t *iso9660_ifs_stat (iso9660_t *p_iso, const char psz_path[]); /*! Return file status for path name psz_path. NULL is returned on error. pathname version numbers in the ISO 9660 name are dropped, i.e. ;1 is removed and if level 1 ISO-9660 names are lowercased. */ iso9660_stat_t *iso9660_ifs_stat_translate (iso9660_t *p_iso, const char psz_path[]); /*! Read psz_path (a directory) and return a list of iso9660_stat_t pointers for the files inside that directory. The caller must free the returned result. */ CdioList_t * iso9660_fs_readdir (CdIo_t *p_cdio, const char psz_path[], bool b_mode2); /*! Read psz_path (a directory) and return a list of iso9660_stat_t pointers for the files inside that directory. The caller must free the returned result. */ CdioList_t * iso9660_ifs_readdir (iso9660_t *p_iso, const char psz_path[]); /*! Return the PVD's application ID. NULL is returned if there is some problem in getting this. */ char * iso9660_get_application_id(iso9660_pvd_t *p_pvd); /*! Get the application ID. psz_app_id is set to NULL if there is some problem in getting this and false is returned. */ bool iso9660_ifs_get_application_id(iso9660_t *p_iso, /*out*/ char **p_psz_app_id); /*! Return the Joliet level recognized for p_iso. */ uint8_t iso9660_ifs_get_joliet_level(iso9660_t *p_iso); uint8_t iso9660_get_dir_len(const iso9660_dir_t *p_idr); #if FIXME uint8_t iso9660_get_dir_size(const iso9660_dir_t *p_idr); lsn_t iso9660_get_dir_extent(const iso9660_dir_t *p_idr); #endif /*! Return the directory name stored in the iso9660_dir_t A string is allocated: the caller must deallocate. */ char * iso9660_dir_to_name (const iso9660_dir_t *p_iso9660_dir); /*! Return a string containing the preparer id with trailing blanks removed. */ char *iso9660_get_preparer_id(const iso9660_pvd_t *p_pvd); /*! Get the preparer ID. psz_preparer_id is set to NULL if there is some problem in getting this and false is returned. */ bool iso9660_ifs_get_preparer_id(iso9660_t *p_iso, /*out*/ char **p_psz_preparer_id); /*! Return a string containing the PVD's publisher id with trailing blanks removed. */ char *iso9660_get_publisher_id(const iso9660_pvd_t *p_pvd); /*! Get the publisher ID. psz_publisher_id is set to NULL if there is some problem in getting this and false is returned. */ bool iso9660_ifs_get_publisher_id(iso9660_t *p_iso, /*out*/ char **p_psz_publisher_id); uint8_t iso9660_get_pvd_type(const iso9660_pvd_t *p_pvd); const char * iso9660_get_pvd_id(const iso9660_pvd_t *p_pvd); int iso9660_get_pvd_space_size(const iso9660_pvd_t *p_pvd); int iso9660_get_pvd_block_size(const iso9660_pvd_t *p_pvd) ; /*! Return the primary volume id version number (of pvd). If there is an error 0 is returned. */ int iso9660_get_pvd_version(const iso9660_pvd_t *pvd) ; /*! Return a string containing the PVD's system id with trailing blanks removed. */ char *iso9660_get_system_id(const iso9660_pvd_t *p_pvd); /*! Get the system ID. psz_system_id is set to NULL if there is some problem in getting this and false is returned. */ bool iso9660_ifs_get_system_id(iso9660_t *p_iso, /*out*/ char **p_psz_system_id); /*! Return the LSN of the root directory for pvd. If there is an error CDIO_INVALID_LSN is returned. */ lsn_t iso9660_get_root_lsn(const iso9660_pvd_t *p_pvd); /*! Return the PVD's volume ID. */ char *iso9660_get_volume_id(const iso9660_pvd_t *p_pvd); /*! Get the system ID. psz_system_id is set to NULL if there is some problem in getting this and false is returned. */ bool iso9660_ifs_get_volume_id(iso9660_t *p_iso, /*out*/ char **p_psz_volume_id); /*! Return the PVD's volumeset ID. NULL is returned if there is some problem in getting this. */ char *iso9660_get_volumeset_id(const iso9660_pvd_t *p_pvd); /*! Get the systemset ID. psz_systemset_id is set to NULL if there is some problem in getting this and false is returned. */ bool iso9660_ifs_get_volumeset_id(iso9660_t *p_iso, /*out*/ char **p_psz_volumeset_id); /* pathtable */ /*! Zero's out pathable. Do this first. */ void iso9660_pathtable_init (void *pt); unsigned int iso9660_pathtable_get_size (const void *pt); uint16_t iso9660_pathtable_l_add_entry (void *pt, const char name[], uint32_t extent, uint16_t parent); uint16_t iso9660_pathtable_m_add_entry (void *pt, const char name[], uint32_t extent, uint16_t parent); /**===================================================================== Volume Descriptors ======================================================================*/ void iso9660_set_pvd (void *pd, const char volume_id[], const char application_id[], const char publisher_id[], const char preparer_id[], uint32_t iso_size, const void *root_dir, uint32_t path_table_l_extent, uint32_t path_table_m_extent, uint32_t path_table_size, const time_t *pvd_time); void iso9660_set_evd (void *pd); /*! Return true if ISO 9660 image has extended attrributes (XA). */ bool iso9660_ifs_is_xa (const iso9660_t * p_iso); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* __CDIO_ISO9660_H__ */ /* * Local variables: * c-file-style: "gnu" * tab-width: 8 * indent-tabs-mode: nil * End: */