2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/CFile/cfile.cpp $
15 * Utilities for operating on files
18 * Revision 1.14 2006/04/26 19:36:57 taylor
19 * address an error handling bug in cfwrite()
21 * Revision 1.13 2005/10/01 22:04:58 taylor
22 * fix FS1 (de)briefing voices, the directory names are different in FS1
23 * hard code the table values so that the fs1.vp file isn't needed
24 * hard code a mission fix for sm2-08a since a have no idea how to fix it otherwise
25 * generally cleanup some FS1 code
26 * fix volume sliders in the options screen that never went all the way up
28 * Revision 1.12 2005/08/12 08:50:09 taylor
29 * recursively create directories (hurt more on OSX) and update all _mkdir() calls accordingly
31 * Revision 1.11 2004/07/04 11:27:29 taylor
32 * cleanup CFILE code a little, warning fixes, remove redundant dir checks, amd64 support
34 * Revision 1.10 2004/06/11 00:28:39 tigital
35 * byte-swapping changes for bigendian systems
37 * Revision 1.9 2003/05/25 02:30:42 taylor
40 * Revision 1.8 2003/02/20 17:41:07 theoddone33
41 * Userdir patch from Taylor Richards
43 * Revision 1.7 2002/12/30 03:23:29 relnev
44 * disable root dir check
46 * Revision 1.6 2002/06/17 06:33:08 relnev
47 * ryan's struct patch for gcc 2.95
49 * Revision 1.5 2002/06/09 04:41:15 relnev
50 * added copyright header
52 * Revision 1.4 2002/06/05 08:05:28 relnev
53 * stub/warning removal.
55 * reworked the sound code.
57 * Revision 1.3 2002/05/28 08:52:03 relnev
58 * implemented two assembly stubs.
60 * cleaned up a few warnings.
62 * added a little demo hackery to make it progress a little farther.
64 * Revision 1.2 2002/05/28 06:28:20 theoddone33
65 * Filesystem mods, actually reads some data files now
67 * Revision 1.1.1.1 2002/05/03 03:28:08 root
71 * 20 9/08/99 10:01p Dave
72 * Make sure game won't run in a drive's root directory. Make sure
73 * standalone routes suqad war messages properly to the host.
75 * 19 9/08/99 12:03a Dave
76 * Make squad logos render properly in D3D all the time. Added intel anim
79 * 18 9/06/99 2:35p Dave
80 * Rename briefing and debriefing voice direcrory paths properly.
82 * 17 9/03/99 1:31a Dave
83 * CD checking by act. Added support to play 2 cutscenes in a row
84 * seamlessly. Fixed super low level cfile bug related to files in the
85 * root directory of a CD. Added cheat code to set campaign mission # in
88 * 16 8/31/99 9:46a Dave
89 * Support for new cfile cbanims directory.
91 * 15 8/06/99 11:20a Johns
92 * Don't call game_cd_changed() in a demo or multiplayer beta build.
94 * 14 6/08/99 2:33p Dave
95 * Fixed release build warning. Put in hud config stuff.
97 * 13 5/19/99 4:07p Dave
98 * Moved versioning code into a nice isolated common place. Fixed up
99 * updating code on the pxo screen. Fixed several stub problems.
101 * 12 4/30/99 12:18p Dave
102 * Several minor bug fixes.
104 * 11 4/07/99 5:54p Dave
105 * Fixes for encryption in updatelauncher.
107 * 10 3/28/99 5:58p Dave
108 * Added early demo code. Make objects move. Nice and framerate
109 * independant, but not much else. Don't use yet unless you're me :)
111 * 9 2/22/99 10:31p Andsager
112 * Get rid of unneeded includes.
114 * 8 1/12/99 3:15a Dave
115 * Barracks screen support for selecting squad logos. We need real artwork
118 * 7 11/30/98 1:07p Dave
119 * 16 bit conversion, first run.
121 * 6 10/29/98 10:41a Dave
122 * Change the way cfile initializes exe directory.
124 * 5 10/13/98 9:19a Andsager
125 * Add localization support to cfile. Optional parameter with cfopen that
126 * looks for localized files.
128 * 4 10/12/98 9:54a Dave
129 * Fixed a few file organization things.
131 * 3 10/07/98 6:27p Dave
132 * Globalized mission and campaign file extensions. Removed Silent Threat
133 * special code. Moved \cache \players and \multidata into the \data
136 * 2 10/07/98 10:52a Dave
139 * 1 10/07/98 10:48a Dave
141 * 110 9/17/98 10:31a Hoffoss
142 * Changed code to use location of executable as root rather than relying
143 * on the cwd being set correctly. This is most helpful in the case of
144 * Fred launching due to the user double-clicking on an .fsm file in
145 * explorer or something (where the cwd is probably the location of the
148 * 109 9/11/98 4:14p Dave
149 * Fixed file checksumming of < file_size. Put in more verbose kicking and
150 * PXO stats store reporting.
152 * 108 9/09/98 5:53p Dave
153 * Put in new tracker packets in API. Change cfile to be able to checksum
154 * portions of a file.
156 * 107 9/04/98 3:51p Dave
157 * Put in validated mission updating and application during stats
160 * 106 8/31/98 2:06p Dave
161 * Make cfile sort the ordering or vp files. Added support/checks for
162 * recognizing "mission disk" players.
164 * 105 8/20/98 5:30p Dave
165 * Put in handy multiplayer logfile system. Now need to put in useful
166 * applications of it all over the code.
168 * 104 8/12/98 4:53p Dave
169 * Put in 32 bit checksumming for PXO missions. No validation on the
170 * actual tracker yet, though.
172 * 103 6/17/98 9:30a Allender
173 * fixed red alert replay stats clearing problem
175 * 102 6/05/98 9:46a Lawrance
176 * check for CD change on cfopen()
178 * 101 5/19/98 1:19p Allender
179 * new low level reliable socket reading code. Make all missions/campaign
180 * load/save to data missions folder (i.e. we are rid of the player
183 * 100 5/13/98 10:22p John
184 * Added cfile functions to read/write rle compressed blocks of data.
185 * Made palman use it for .clr files. Made alphacolors calculate on the
186 * fly rather than caching to/from disk.
188 * 99 5/11/98 10:59a John
189 * Moved the low-level file reading code into cfilearchive.cpp.
191 * 98 5/06/98 5:30p John
192 * Removed unused cfilearchiver. Removed/replaced some unused/little used
193 * graphics functions, namely gradient_h and _v and pixel_sp. Put in new
194 * DirectX header files and libs that fixed the Direct3D alpha blending
197 * 97 5/03/98 11:53a John
198 * Fixed filename case mangling.
200 * 96 5/03/98 8:33a John
201 * Made sure there weren't any more broken function lurking around like
202 * the one Allender fixed.
204 * 95 5/02/98 11:05p Allender
205 * fix cfilelength for pack files
210 #define _CFILE_INTERNAL
220 #include <winbase.h> /* needed for memory mapping of file functions */
223 #include <sys/stat.h>
224 #include <sys/types.h>
230 //#include "outwnd.h"
231 //#include "vecmat.h"
233 #include "cfilesystem.h"
234 #include "cfilearchive.h"
236 #include "osregistry.h"
238 char Cfile_root_dir[CFILE_ROOT_DIRECTORY_LEN] = "";
239 char Cfile_user_dir[CFILE_ROOT_DIRECTORY_LEN] = "";
241 // During cfile_init, verify that Pathtypes[n].index == n for each item
242 // Each path must have a valid parent that can be tracable all the way back to the root
243 // so that we can create directories when we need to.
245 cf_pathtype Pathtypes[CF_MAX_PATH_TYPES] = {
246 // What type this is Path Extensions Parent type
247 { CF_TYPE_INVALID, NULL, NULL, CF_TYPE_INVALID },
248 // Root must be index 1!!
249 { CF_TYPE_ROOT, "", ".mve", CF_TYPE_ROOT },
250 { CF_TYPE_DATA, "Data", ".cfg .log .txt", CF_TYPE_ROOT },
252 { CF_TYPE_MAPS, "Data/Maps", ".pcx .ani .tga", CF_TYPE_DATA },
253 { CF_TYPE_TEXT, "Data/Text", ".txt .net", CF_TYPE_DATA },
255 { CF_TYPE_MISSIONS, "Data/Missions", ".fsm .fsc .ntl .ssv", CF_TYPE_DATA },
257 { CF_TYPE_MISSIONS, "Data/Missions", ".fs2 .fc2 .ntl .ssv", CF_TYPE_DATA },
259 { CF_TYPE_MODELS, "Data/Models", ".pof", CF_TYPE_DATA },
260 { CF_TYPE_TABLES, "Data/Tables", ".tbl", CF_TYPE_DATA },
261 { CF_TYPE_SOUNDS, "Data/Sounds", ".wav", CF_TYPE_DATA },
262 { CF_TYPE_SOUNDS_8B22K, "Data/Sounds/8b22k", ".wav", CF_TYPE_SOUNDS },
263 { CF_TYPE_SOUNDS_16B11K, "Data/Sounds/16b11k", ".wav", CF_TYPE_SOUNDS },
264 { CF_TYPE_VOICE, "Data/Voice", "", CF_TYPE_DATA },
266 { CF_TYPE_VOICE_BRIEFINGS, "Data/Voice/Briefings", ".wav", CF_TYPE_VOICE },
268 { CF_TYPE_VOICE_BRIEFINGS, "Data/Voice/Briefing", ".wav", CF_TYPE_VOICE },
270 { CF_TYPE_VOICE_CMD_BRIEF, "Data/Voice/Command_briefings",".wav", CF_TYPE_VOICE },
272 { CF_TYPE_VOICE_DEBRIEFINGS, "Data/Voice/Debriefings", ".wav", CF_TYPE_VOICE },
274 { CF_TYPE_VOICE_DEBRIEFINGS, "Data/Voice/Debriefing", ".wav", CF_TYPE_VOICE },
276 { CF_TYPE_VOICE_PERSONAS, "Data/Voice/Personas", ".wav", CF_TYPE_VOICE },
277 { CF_TYPE_VOICE_SPECIAL, "Data/Voice/Special", ".wav", CF_TYPE_VOICE },
278 { CF_TYPE_VOICE_TRAINING, "Data/Voice/Training", ".wav", CF_TYPE_VOICE },
279 { CF_TYPE_MUSIC, "Data/Music", ".wav", CF_TYPE_VOICE },
280 { CF_TYPE_MOVIES, "Data/Movies", ".mve .msb", CF_TYPE_DATA },
281 { CF_TYPE_INTERFACE, "Data/Interface", ".pcx .ani .tga", CF_TYPE_DATA },
282 { CF_TYPE_FONT, "Data/Fonts", ".vf", CF_TYPE_DATA },
283 { CF_TYPE_EFFECTS, "Data/Effects", ".ani .pcx .neb .tga", CF_TYPE_DATA },
284 { CF_TYPE_HUD, "Data/Hud", ".ani .pcx .tga", CF_TYPE_DATA },
285 { CF_TYPE_PLAYER_MAIN, "Data/Players", "", CF_TYPE_DATA },
286 { CF_TYPE_PLAYER_IMAGES_MAIN, "Data/Players/Images", ".pcx", CF_TYPE_PLAYER_MAIN },
287 { CF_TYPE_CACHE, "Data/Cache", ".clr .tmp", CF_TYPE_DATA }, //clr=cached color
288 { CF_TYPE_PLAYERS, "Data/Players", ".hcf", CF_TYPE_DATA },
289 { CF_TYPE_SINGLE_PLAYERS, "Data/Players/Single", ".plr .csg .css", CF_TYPE_PLAYERS },
290 { CF_TYPE_MULTI_PLAYERS, "Data/Players/Multi", ".plr", CF_TYPE_DATA },
291 { CF_TYPE_MULTI_CACHE, "Data/MultiData", ".pcx .fs2", CF_TYPE_DATA },
292 { CF_TYPE_CONFIG, "Data/Config", ".cfg", CF_TYPE_DATA },
293 { CF_TYPE_SQUAD_IMAGES_MAIN, "Data/Players/Squads", ".pcx", CF_TYPE_DATA },
294 { CF_TYPE_DEMOS, "Data/Demos", ".fsd", CF_TYPE_DATA },
295 { CF_TYPE_CBANIMS, "Data/CBAnims", ".ani", CF_TYPE_DATA },
296 { CF_TYPE_INTEL_ANIMS, "Data/IntelAnims", ".ani", CF_TYPE_DATA },
298 { CF_TYPE_MAPS, "Data\\Maps", ".pcx .ani .tga", CF_TYPE_DATA },
299 { CF_TYPE_TEXT, "Data\\Text", ".txt .net", CF_TYPE_DATA },
300 { CF_TYPE_MISSIONS, "Data\\Missions", ".fs2 .fc2 .ntl .ssv", CF_TYPE_DATA },
301 { CF_TYPE_MODELS, "Data\\Models", ".pof", CF_TYPE_DATA },
302 { CF_TYPE_TABLES, "Data\\Tables", ".tbl", CF_TYPE_DATA },
303 { CF_TYPE_SOUNDS, "Data\\Sounds", ".wav", CF_TYPE_DATA },
304 { CF_TYPE_SOUNDS_8B22K, "Data\\Sounds\\8b22k", ".wav", CF_TYPE_SOUNDS },
305 { CF_TYPE_SOUNDS_16B11K, "Data\\Sounds\\16b11k", ".wav", CF_TYPE_SOUNDS },
306 { CF_TYPE_VOICE, "Data\\Voice", "", CF_TYPE_DATA },
307 { CF_TYPE_VOICE_BRIEFINGS, "Data\\Voice\\Briefing", ".wav", CF_TYPE_VOICE },
308 { CF_TYPE_VOICE_CMD_BRIEF, "Data\\Voice\\Command_briefings",".wav", CF_TYPE_VOICE },
309 { CF_TYPE_VOICE_DEBRIEFINGS, "Data\\Voice\\Debriefing", ".wav", CF_TYPE_VOICE },
310 { CF_TYPE_VOICE_PERSONAS, "Data\\Voice\\Personas", ".wav", CF_TYPE_VOICE },
311 { CF_TYPE_VOICE_SPECIAL, "Data\\Voice\\Special", ".wav", CF_TYPE_VOICE },
312 { CF_TYPE_VOICE_TRAINING, "Data\\Voice\\Training", ".wav", CF_TYPE_VOICE },
313 { CF_TYPE_MUSIC, "Data\\Music", ".wav", CF_TYPE_VOICE },
314 { CF_TYPE_MOVIES, "Data\\Movies", ".mve .msb", CF_TYPE_DATA },
315 { CF_TYPE_INTERFACE, "Data\\Interface", ".pcx .ani .tga", CF_TYPE_DATA },
316 { CF_TYPE_FONT, "Data\\Fonts", ".vf", CF_TYPE_DATA },
317 { CF_TYPE_EFFECTS, "Data\\Effects", ".ani .pcx .neb .tga", CF_TYPE_DATA },
318 { CF_TYPE_HUD, "Data\\Hud", ".ani .pcx .tga", CF_TYPE_DATA },
319 { CF_TYPE_PLAYER_MAIN, "Data\\Players", "", CF_TYPE_DATA },
320 { CF_TYPE_PLAYER_IMAGES_MAIN, "Data\\Players\\Images", ".pcx", CF_TYPE_PLAYER_MAIN },
321 { CF_TYPE_CACHE, "Data\\Cache", ".clr .tmp", CF_TYPE_DATA }, //clr=cached color
322 { CF_TYPE_PLAYERS, "Data\\Players", ".hcf", CF_TYPE_DATA },
323 { CF_TYPE_SINGLE_PLAYERS, "Data\\Players\\Single", ".plr .csg .css", CF_TYPE_PLAYERS },
324 { CF_TYPE_MULTI_PLAYERS, "Data\\Players\\Multi", ".plr", CF_TYPE_DATA },
325 { CF_TYPE_MULTI_CACHE, "Data\\MultiData", ".pcx .fs2", CF_TYPE_DATA },
326 { CF_TYPE_CONFIG, "Data\\Config", ".cfg", CF_TYPE_DATA },
327 { CF_TYPE_SQUAD_IMAGES_MAIN, "Data\\Players\\Squads", ".pcx", CF_TYPE_DATA },
328 { CF_TYPE_DEMOS, "Data\\Demos", ".fsd", CF_TYPE_DATA },
329 { CF_TYPE_CBANIMS, "Data\\CBAnims", ".ani", CF_TYPE_DATA },
330 { CF_TYPE_INTEL_ANIMS, "Data\\IntelAnims", ".ani", CF_TYPE_DATA },
335 #define CFILE_STACK_MAX 8
337 int cfile_inited = 0;
338 int Cfile_stack_pos = 0;
340 char Cfile_stack[128][CFILE_STACK_MAX];
342 Cfile_block Cfile_block_list[MAX_CFILE_BLOCKS];
343 CFILE Cfile_list[MAX_CFILE_BLOCKS];
345 char *Cfile_cdrom_dir = NULL;
348 // Function prototypes for internally-called functions
350 int cfget_cfile_block();
351 CFILE *cf_open_fill_cfblock(FILE * fp, int type);
352 CFILE *cf_open_packed_cfblock(FILE *fp, int type, int offset, int size);
353 CFILE *cf_open_mapped_fill_cfblock(HANDLE hFile, int type);
354 void cf_chksum_long_init();
358 cf_free_secondary_filelist();
361 // determine if the given path is in a root directory (c:\ or c:\freespace2.exe or c:\fred2.exe etc)
362 int cfile_in_root_dir(char *exe_path)
365 char path_copy[2048] = "";
369 if(exe_path == NULL){
374 memset(path_copy, 0, 2048);
375 strncpy(path_copy, exe_path, 2047);
377 // count how many slashes there are in the path
378 tok = strtok(path_copy, DIR_SEPARATOR_STR);
384 tok = strtok(NULL, DIR_SEPARATOR_STR);
385 } while(tok != NULL);
387 // root directory if we have <= 1 slash
388 if(token_count <= 2){
392 // not-root directory
396 // cfile_init() initializes the cfile system. Called once at application start.
398 // returns: success ==> 0
399 // error ==> non-zero
401 int cfile_init(const char *cdrom_dir)
405 // initialize encryption
408 if ( !cfile_inited ) {
409 // initialize root and user paths (may have been done already)
410 if ( cfile_init_paths() ) {
416 for ( i = 0; i < MAX_CFILE_BLOCKS; i++ ) {
417 Cfile_block_list[i].type = CFILE_BLOCK_UNUSED;
420 Cfile_cdrom_dir = (char *)cdrom_dir;
422 cf_build_secondary_filelist(Cfile_cdrom_dir);
424 // 32 bit CRC table init
425 cf_chksum_long_init();
429 atexit( cfile_close );
435 // Call this if pack files got added or removed or the
436 // cdrom changed. This will refresh the list of filenames
437 // stored in packfiles and on the cdrom.
440 cf_build_secondary_filelist(Cfile_cdrom_dir);
444 // Changes to a drive if valid.. 1=A, 2=B, etc
445 // If flag, then changes to it.
446 // Returns 0 if not-valid, 1 if valid.
447 int cfile_chdrive( int DriveNum, int flag )
460 _chdrive( DriveNum );
467 if ( (!flag) && (n != org) )
473 // push current directory on a 'stack' (so we can restore it) and change the directory
474 int cfile_push_chdir(int type)
478 char OriginalDirectory[128];
480 char NoDir[] = "\\.";
482 _getcwd(OriginalDirectory, 127);
483 Assert(Cfile_stack_pos < CFILE_STACK_MAX);
484 strcpy(Cfile_stack[Cfile_stack_pos++], OriginalDirectory);
486 cf_create_default_path_string( dir, type, NULL );
489 char *Drive = strchr(dir, ':');
492 if (!cfile_chdrive( *(Drive - 1) - 'a' + 1, 1))
507 // This chdir might get a critical error!
510 cfile_chdrive( OriginalDirectory[0] - 'a' + 1, 1 );
518 int cfile_chdir(char *dir)
521 char OriginalDirectory[128];
523 char NoDir[] = "\\.";
525 _getcwd(OriginalDirectory, 127);
529 char *Drive = strchr(dir, ':');
531 if (!cfile_chdrive( *(Drive - 1) - 'a' + 1, 1))
546 // This chdir might get a critical error!
549 cfile_chdrive( OriginalDirectory[0] - 'a' + 1, 1 );
558 Assert(Cfile_stack_pos);
560 return cfile_chdir(Cfile_stack[Cfile_stack_pos]);
563 // flush (delete all files in) the passed directory (by type), return the # of files deleted
564 // NOTE : WILL NOT DELETE READ-ONLY FILES
565 int cfile_flush_dir(int dir_type)
575 Assert( CF_TYPE_SPECIFIED(dir_type) );
577 // attempt to change the directory to the passed type
578 if(cfile_push_chdir(dir_type)){
582 // proceed to delete the files
583 find_handle = _findfirst( "*", &find );
585 if (find_handle != -1) {
587 if (!(find.attrib & _A_SUBDIR) && !(find.attrib & _A_RDONLY)) {
589 cf_delete(find.name,dir_type);
591 // increment the deleted count
594 } while (!_findnext(find_handle, &find));
595 _findclose( find_handle );
598 // pop the directory back
601 // return the # of files deleted
607 // add the given extention to a filename (or filepath) if it doesn't already have this
609 // filename = name of filename or filepath to process
610 // ext = extension to add. Must start with the period
611 // Returns: new filename or filepath with extension.
612 char *cf_add_ext(const char *filename, const char *ext)
615 static char path[MAX_PATH_LEN];
617 flen = strlen(filename);
619 Assert(flen < MAX_PATH_LEN);
620 strcpy(path, filename);
621 if ((flen < 4) || stricmp(path + flen - elen, ext)) {
622 Assert(flen + elen < MAX_PATH_LEN);
630 void cf_delete( const char *filename, int dir_type )
632 char longname[MAX_PATH_LEN];
634 Assert( CF_TYPE_SPECIFIED(dir_type) );
636 cf_create_default_path_string( longname, dir_type, filename );
638 FILE *fp = fopen(longname, "rb");
648 // Same as _access function to read a file's access bits
649 int cf_access( const char *filename, int dir_type, int mode )
651 char longname[MAX_PATH_LEN];
653 Assert( CF_TYPE_SPECIFIED(dir_type) );
655 cf_create_default_path_string( longname, dir_type, filename );
657 return access(longname,mode);
661 // Returns 1 if file exists, 0 if not.
662 int cf_exist( const char *filename, int dir_type )
664 char longname[MAX_PATH_LEN];
666 Assert( CF_TYPE_SPECIFIED(dir_type) );
668 cf_create_default_path_string( longname, dir_type, filename );
670 FILE *fp = fopen(longname, "rb");
679 void cf_attrib(const char *filename, int set, int clear, int dir_type)
681 char longname[MAX_PATH_LEN];
683 Assert( CF_TYPE_SPECIFIED(dir_type) );
685 cf_create_default_path_string( longname, dir_type, filename );
687 FILE *fp = fopen(longname, "rb");
694 DWORD z = GetFileAttributes(longname);
695 SetFileAttributes(longname, z | set & ~clear);
701 int cf_rename(const char *old_name, const char *name, int dir_type)
703 Assert( CF_TYPE_SPECIFIED(dir_type) );
706 char old_longname[_MAX_PATH];
707 char new_longname[_MAX_PATH];
709 cf_create_default_path_string( old_longname, dir_type, old_name );
710 cf_create_default_path_string( new_longname, dir_type, name );
712 ret_code = rename(old_longname, new_longname );
716 return CF_RENAME_FAIL_ACCESS;
719 return CF_RENAME_FAIL_EXIST;
723 return CF_RENAME_SUCCESS;
728 // Creates the directory path if it doesn't exist. Even creates all its
730 void cf_create_directory( int dir_type )
733 int dir_tree[CF_MAX_PATH_TYPES];
734 char longname[MAX_PATH_LEN];
736 Assert( CF_TYPE_SPECIFIED(dir_type) );
738 int current_dir = dir_type;
741 Assert( num_dirs < CF_MAX_PATH_TYPES ); // Invalid Pathtypes data?
743 dir_tree[num_dirs++] = current_dir;
744 current_dir = Pathtypes[current_dir].parent_index;
746 } while( current_dir != CF_TYPE_ROOT );
751 for (i=num_dirs-1; i>=0; i-- ) {
752 cf_create_default_path_string( longname, dir_tree[i], NULL );
754 if ( _mkdir(longname)==0 ) {
755 mprintf(( "CFILE: Created new directory '%s'\n", longname ));
763 extern int game_cd_changed();
767 // parameters: *filepath ==> name of file to open (may be path+name)
768 // *mode ==> specifies how file should be opened (eg "rb" for read binary)
769 // passing NULL to mode deletes the file if it exists and returns NULL
770 // type ==> one of: CFILE_NORMAL
771 // CFILE_MEMORY_MAPPED
772 // dir_type => override extension check, value is one of CF_TYPE* #defines
774 // NOTE: type parameter is an optional parameter. The default value is CFILE_NORMAL
777 // returns: success ==> address of CFILE structure
781 CFILE *cfopen(const char *file_path, const char *mode, int type, int dir_type, bool localize)
783 char longname[_MAX_PATH];
785 // nprintf(("CFILE", "CFILE -- trying to open %s\n", file_path ));
786 // #if !defined(MULTIPLAYER_BETA_BUILD) && !defined(FS2_DEMO)
788 // we no longer need to do this, and on machines with crappy-ass drivers it can slow things down horribly.
790 if ( game_cd_changed() ) {
795 //================================================
796 // Check that all the parameters make sense
797 Assert(file_path && strlen(file_path));
798 Assert( mode != NULL );
800 // Can only open read-only binary files in memory mapped mode.
801 if ( (type & CFILE_MEMORY_MAPPED) && strcmp(mode,"rb") ) {
806 //===========================================================
807 // If in write mode, just try to open the file straight off
808 // the harddisk. No fancy packfile stuff here!
810 if ( strchr(mode,'w') ) {
811 // For write-only files, require a full path or a path type
813 if ( strpbrk(file_path, "/") ) {
815 if ( strpbrk(file_path,"/\\:") ) {
818 strcpy(longname, file_path );
821 Assert( dir_type != CF_TYPE_ANY );
823 // Create the directory if necessary
824 cf_create_directory( dir_type );
826 cf_create_default_path_string( longname, dir_type, file_path );
828 Assert( !(type & CFILE_MEMORY_MAPPED) );
830 // JOHN: TODO, you should create the path if it doesn't exist.
832 FILE *fp = fopen(longname, mode);
834 return cf_open_fill_cfblock(fp, dir_type);
840 //================================================
841 // Search for file on disk, on cdrom, or in a packfile
844 char copy_file_path[MAX_PATH_LEN]; // FIX change in memory from cf_find_file_location
845 strcpy(copy_file_path, file_path);
848 if ( cf_find_file_location( copy_file_path, dir_type, longname, &size, &offset, localize ) ) {
850 // Fount it, now create a cfile out of it
852 if ( type & CFILE_MEMORY_MAPPED ) {
854 // Can't open memory mapped files out of pack files
861 hFile = CreateFile(longname, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
863 if (hFile != INVALID_HANDLE_VALUE) {
864 return cf_open_mapped_fill_cfblock(hFile, dir_type);
871 FILE *fp = fopen( longname, "rb" );
875 // Found it in a pack file
876 return cf_open_packed_cfblock(fp, dir_type, offset, size );
878 // Found it in a normal file
879 return cf_open_fill_cfblock(fp, dir_type);
890 // ------------------------------------------------------------------------
893 // Open up a temporary file. A unique name is automatically generated. The
894 // file will be automatically deleted when file is closed.
896 // return: NULL => tmp file could not be opened
897 // pointer to CFILE => tmp file successfully opened
904 return cf_open_fill_cfblock(fp, 0);
911 // cfget_cfile_block() will try to find an empty Cfile_block structure in the
912 // Cfile_block_list[] array and return the index.
914 // returns: success ==> index in Cfile_block_list[] array
917 int cfget_cfile_block()
922 for ( i = 0; i < MAX_CFILE_BLOCKS; i++ ) {
923 cb = &Cfile_block_list[i];
924 if ( cb->type == CFILE_BLOCK_UNUSED ) {
927 cb->type = CFILE_BLOCK_USED;
932 // If we've reached this point, a free Cfile_block could not be found
933 nprintf(("Warning","A free Cfile_block could not be found.\n"));
934 Assert(0); // out of free cfile blocks
939 // cfclose() closes the file
941 // returns: success ==> 0
944 int cfclose( CFILE * cfile )
948 Assert(cfile != NULL);
950 Assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
951 cb = &Cfile_block_list[cfile->id];
955 // close memory mapped file
959 result = UnmapViewOfFile((void*)cb->data);
961 result = CloseHandle(cb->hInFile);
962 Assert(result); // Ensure file handle is closed properly
963 result = CloseHandle(cb->hMapFile);
964 Assert(result); // Ensure file handle is closed properly
968 } else if ( cb->fp != NULL ) {
969 Assert(cb->fp != NULL);
970 result = fclose(cb->fp);
975 cb->type = CFILE_BLOCK_UNUSED;
982 // cf_open_fill_cfblock() will fill up a Cfile_block element in the Cfile_block_list[] array
983 // for the case of a file being opened by cf_open();
985 // returns: success ==> ptr to CFILE structure.
988 CFILE *cf_open_fill_cfblock(FILE *fp, int type)
990 int cfile_block_index;
992 cfile_block_index = cfget_cfile_block();
993 if ( cfile_block_index == -1 ) {
998 cfbp = &Cfile_block_list[cfile_block_index];
999 cfp = &Cfile_list[cfile_block_index];;
1000 cfp->id = cfile_block_index;
1004 cfbp->dir_type = type;
1006 cf_init_lowlevel_read_code(cfp,0,filelength(fileno(fp)) );
1013 // cf_open_packed_cfblock() will fill up a Cfile_block element in the Cfile_block_list[] array
1014 // for the case of a file being opened by cf_open();
1016 // returns: success ==> ptr to CFILE structure.
1019 CFILE *cf_open_packed_cfblock(FILE *fp, int type, int offset, int size)
1021 // Found it in a pack file
1022 int cfile_block_index;
1024 cfile_block_index = cfget_cfile_block();
1025 if ( cfile_block_index == -1 ) {
1030 cfbp = &Cfile_block_list[cfile_block_index];
1032 cfp = &Cfile_list[cfile_block_index];
1033 cfp->id = cfile_block_index;
1037 cfbp->dir_type = type;
1039 cf_init_lowlevel_read_code(cfp,offset, size );
1048 // cf_open_mapped_fill_cfblock() will fill up a Cfile_block element in the Cfile_block_list[] array
1049 // for the case of a file being opened by cf_open_mapped();
1051 // returns: ptr CFILE structure.
1053 CFILE *cf_open_mapped_fill_cfblock(HANDLE hFile, int type)
1055 int cfile_block_index;
1057 cfile_block_index = cfget_cfile_block();
1058 if ( cfile_block_index == -1 ) {
1064 cfbp = &Cfile_block_list[cfile_block_index];
1066 cfp = &Cfile_list[cfile_block_index];
1067 cfp->id = cfile_block_index;
1069 cfbp->hInFile = hFile;
1070 cfbp->dir_type = type;
1072 cf_init_lowlevel_read_code(cfp,0 , 0 );
1077 cfbp->hMapFile = CreateFileMapping(cfbp->hInFile, NULL, PAGE_READONLY, 0, 0, NULL);
1078 if (cfbp->hMapFile == NULL) {
1079 nprintf(("Error", "Could not create file-mapping object.\n"));
1083 cfbp->data = (ubyte*)MapViewOfFile(cfbp->hMapFile, FILE_MAP_READ, 0, 0, 0);
1084 Assert( cfbp->data != NULL );
1090 int cf_get_dir_type(CFILE *cfile)
1092 return Cfile_block_list[cfile->id].dir_type;
1095 // cf_returndata() returns the data pointer for a memory-mapped file that is associated
1096 // with the CFILE structure passed as a parameter
1100 void *cf_returndata(CFILE *cfile)
1102 Assert(cfile != NULL);
1104 Assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1105 cb = &Cfile_block_list[cfile->id];
1106 Assert(cb->data != NULL);
1112 // version number of opened file. Will be 0 unless you put something else here after you
1113 // open a file. Once set, you can use minimum version numbers with the read functions.
1114 void cf_set_version( CFILE * cfile, int version )
1116 Assert(cfile != NULL);
1118 cfile->version = version;
1121 // routines to read basic data types from CFILE's. Put here to
1122 // simplify mac/pc reading from cfiles.
1127 float cfread_float(CFILE *file, int ver, float deflt)
1131 if (file->version < ver)
1134 if (cfread( &f, sizeof(f), 1, file) != 1)
1137 f = INTEL_FLOAT(&f);
1141 int cfread_int(CFILE *file, int ver, int deflt)
1145 if (file->version < ver)
1148 if (cfread( &i, sizeof(i), 1, file) != 1)
1155 uint cfread_uint(CFILE *file, int ver, uint deflt)
1159 if (file->version < ver)
1162 if (cfread( &i, sizeof(i), 1, file) != 1)
1169 short cfread_short(CFILE *file, int ver, short deflt)
1173 if (file->version < ver)
1176 if (cfread( &s, sizeof(s), 1, file) != 1)
1183 ushort cfread_ushort(CFILE *file, int ver, ushort deflt)
1187 if (file->version < ver)
1190 if (cfread( &s, sizeof(s), 1, file) != 1)
1197 ubyte cfread_ubyte(CFILE *file, int ver, ubyte deflt)
1201 if (file->version < ver)
1204 if (cfread( &b, sizeof(b), 1, file) != 1)
1210 void cfread_vector(vector *vec, CFILE *file, int ver, vector *deflt)
1212 if (file->version < ver) {
1216 vec->xyz.x = vec->xyz.y = vec->xyz.z = 0.0f;
1221 vec->xyz.x = cfread_float(file, ver, deflt ? deflt->xyz.x : 0.0f);
1222 vec->xyz.y = cfread_float(file, ver, deflt ? deflt->xyz.y : 0.0f);
1223 vec->xyz.z = cfread_float(file, ver, deflt ? deflt->xyz.z : 0.0f);
1226 void cfread_angles(angles *ang, CFILE *file, int ver, angles *deflt)
1228 if (file->version < ver) {
1232 ang->p = ang->b = ang->h = 0.0f;
1237 ang->p = cfread_float(file, ver, deflt ? deflt->p : 0.0f);
1238 ang->b = cfread_float(file, ver, deflt ? deflt->b : 0.0f);
1239 ang->h = cfread_float(file, ver, deflt ? deflt->h : 0.0f);
1242 char cfread_char(CFILE *file, int ver, char deflt)
1246 if (file->version < ver)
1249 if (cfread( &b, sizeof(b), 1, file) != 1)
1255 void cfread_string(char *buf, int n, CFILE *file)
1260 c = cfread_char(file);
1268 void cfread_string_len(char *buf,int n, CFILE *file)
1271 len = cfread_int(file);
1274 cfread(buf, len, 1, file);
1279 // equivalent write functions of above read functions follow
1281 int cfwrite_float(float f, CFILE *file)
1283 f = INTEL_FLOAT(&f);
1284 return cfwrite(&f, sizeof(f), 1, file);
1287 int cfwrite_int(int i, CFILE *file)
1290 return cfwrite(&i, sizeof(i), 1, file);
1293 int cfwrite_uint(uint i, CFILE *file)
1296 return cfwrite(&i, sizeof(i), 1, file);
1299 int cfwrite_short(short s, CFILE *file)
1302 return cfwrite(&s, sizeof(s), 1, file);
1305 int cfwrite_ushort(ushort s, CFILE *file)
1308 return cfwrite(&s, sizeof(s), 1, file);
1311 int cfwrite_ubyte(ubyte b, CFILE *file)
1313 return cfwrite(&b, sizeof(b), 1, file);
1316 int cfwrite_vector(vector *vec, CFILE *file)
1318 if(!cfwrite_float(vec->xyz.x, file)){
1321 if(!cfwrite_float(vec->xyz.y, file)){
1324 return cfwrite_float(vec->xyz.z, file);
1327 int cfwrite_angles(angles *ang, CFILE *file)
1329 if(!cfwrite_float(ang->p, file)){
1332 if(!cfwrite_float(ang->b, file)){
1335 return cfwrite_float(ang->h, file);
1338 int cfwrite_char(char b, CFILE *file)
1340 return cfwrite( &b, sizeof(b), 1, file);
1343 int cfwrite_string(const char *buf, CFILE *file)
1345 if ( (!buf) || (buf && !buf[0]) ) {
1346 return cfwrite_char(0, file);
1348 int len = strlen(buf);
1349 if(!cfwrite(buf, len, 1, file)){
1352 return cfwrite_char(0, file); // write out NULL termination
1355 int cfwrite_string_len(const char *buf, CFILE *file)
1357 int len = strlen(buf);
1359 if(!cfwrite_int(len, file)){
1363 return cfwrite(buf,len,1,file);
1369 // Get the filelength
1370 int cfilelength( CFILE * cfile )
1372 Assert(cfile != NULL);
1374 Assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1375 cb = &Cfile_block_list[cfile->id];
1377 // TODO: return length of memory mapped file
1378 Assert( !cb->data );
1380 Assert(cb->fp != NULL);
1382 // cb->size gets set at cfopen
1386 // cfwrite() writes to the file
1388 // returns: number of full elements actually written
1391 int cfwrite(const void *buf, int elsize, int nelem, CFILE *cfile)
1393 Assert(cfile != NULL);
1394 Assert(buf != NULL);
1399 Assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1400 cb = &Cfile_block_list[cfile->id];
1402 int size = elsize * nelem;
1404 // cfwrite() not supported for memory-mapped files
1405 Assert( !cb->data );
1407 Assert(cb->fp != NULL);
1408 Assert(cb->lib_offset == 0 );
1409 int bytes_written = fwrite( buf, 1, size, cb->fp );
1411 if (bytes_written > 0) {
1412 cb->raw_position += bytes_written;
1415 #if defined(CHECK_POSITION) && !defined(NDEBUG)
1416 int tmp_offset = ftell(cb->fp) - cb->lib_offset;
1417 Assert(tmp_offset == cb->raw_position);
1420 return bytes_written / elsize;
1424 // cfputc() writes a character to a file
1426 // returns: success ==> returns character written
1429 int cfputc(int c, CFILE *cfile)
1433 Assert(cfile != NULL);
1435 Assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1436 cb = &Cfile_block_list[cfile->id];
1439 // cfputc() not supported for memory-mapped files
1440 Assert( !cb->data );
1442 Assert(cb->fp != NULL);
1443 result = fputc(c, cb->fp);
1449 // cfgetc() reads a character from a file
1451 // returns: success ==> returns character read
1454 int cfgetc(CFILE *cfile)
1456 Assert(cfile != NULL);
1460 int result = cfread(&tmp, 1, 1, cfile );
1461 if ( result == 1 ) {
1474 // cfgets() reads a string from a file
1476 // returns: success ==> returns pointer to string
1479 char *cfgets(char *buf, int n, CFILE *cfile)
1481 Assert(cfile != NULL);
1482 Assert(buf != NULL);
1488 for (i=0; i<n-1; i++ ) {
1492 int ret = cfread( &tmp_c, 1, 1, cfile );
1502 } while ( c == 13 );
1504 if ( c=='\n' ) break;
1511 // cfputs() writes a string to a file
1513 // returns: success ==> non-negative value
1516 int cfputs(const char *str, CFILE *cfile)
1518 Assert(cfile != NULL);
1519 Assert(str != NULL);
1522 Assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1523 cb = &Cfile_block_list[cfile->id];
1528 // cfputs() not supported for memory-mapped files
1529 Assert( !cb->data );
1530 Assert(cb->fp != NULL);
1531 result = fputs(str, cb->fp);
1537 // 16 and 32 bit checksum stuff ----------------------------------------------------------
1539 // CRC code for mission validation. given to us by Kevin Bentley on 7/20/98. Some sort of
1540 // checksumming code that he wrote a while ago.
1541 #define CRC32_POLYNOMIAL 0xEDB88320L
1542 unsigned long CRCTable[256];
1544 #define CF_CHKSUM_SAMPLE_SIZE 512
1546 // update cur_chksum with the chksum of the new_data of size new_data_size
1547 ushort cf_add_chksum_short(ushort seed, const char *buffer, int size)
1549 const ubyte * ptr = (const ubyte *)buffer;
1550 unsigned int sum1,sum2;
1552 sum1 = sum2 = (int)(seed);
1556 if (sum1 >= 255 ) sum1 -= 255;
1561 return (unsigned short)((sum1<<8)+ sum2);
1564 // update cur_chksum with the chksum of the new_data of size new_data_size
1565 unsigned long cf_add_chksum_long(unsigned long seed, const char *buffer, int size)
1568 unsigned const char *p;
1569 unsigned long temp1;
1570 unsigned long temp2;
1572 p = (unsigned const char*)buffer;
1576 temp1 = (crc>>8)&0x00FFFFFFL;
1577 temp2 = CRCTable[((int)crc^*p++)&0xff];
1584 void cf_chksum_long_init()
1589 for( i=0;i<=255;i++) {
1593 crc=(crc>>1)^CRC32_POLYNOMIAL;
1601 // single function convenient to use for both short and long checksums
1602 // NOTE : only one of chk_short or chk_long must be non-NULL (indicating which checksum to perform)
1603 int cf_chksum_do(CFILE *cfile, ushort *chk_short, uint *chk_long, int max_size)
1605 char cf_buffer[CF_CHKSUM_SAMPLE_SIZE];
1611 // determine whether we're doing a short or long checksum
1622 // if max_size is -1, set it to be the size of the file
1624 cfseek(cfile, 0, SEEK_SET);
1625 max_size = cfilelength(cfile);
1630 // determine how much we want to read
1631 if((max_size - cf_total) >= CF_CHKSUM_SAMPLE_SIZE){
1632 read_size = CF_CHKSUM_SAMPLE_SIZE;
1634 read_size = max_size - cf_total;
1637 // read in some buffer
1638 cf_len = cfread(cf_buffer, 1, read_size, cfile);
1640 // total we've read so far
1645 // do the proper short or long checksum
1647 *chk_long = cf_add_chksum_long(*chk_long, cf_buffer, cf_len);
1649 *chk_short = cf_add_chksum_short(*chk_short, cf_buffer, cf_len);
1652 } while((cf_len > 0) && (cf_total < max_size));
1657 // get the 2 byte checksum of the passed filename - return 0 if operation failed, 1 if succeeded
1658 int cf_chksum_short(const char *filename, ushort *chksum, int max_size, int cf_type)
1661 CFILE *cfile = NULL;
1663 // zero the checksum
1666 // attempt to open the file
1667 cfile = cfopen(filename,"rt",CFILE_NORMAL,cf_type);
1672 // call the overloaded cf_chksum function()
1673 ret_val = cf_chksum_do(cfile, chksum, NULL, max_size);
1675 // close the file down
1679 // return the result
1683 // get the 2 byte checksum of the passed file - return 0 if operation failed, 1 if succeeded
1684 // NOTE : preserves current file position
1685 int cf_chksum_short(CFILE *file, ushort *chksum, int max_size)
1690 // Returns current position of file.
1691 start_pos = cftell(file);
1692 if(start_pos == -1){
1696 // move to the beginning of the file
1697 if(cfseek(file, 0, CF_SEEK_SET)){
1700 ret_code = cf_chksum_do(file, chksum, NULL, max_size);
1701 // move back to the start position
1702 cfseek(file, start_pos, CF_SEEK_SET);
1707 // get the 32 bit CRC checksum of the passed filename - return 0 if operation failed, 1 if succeeded
1708 int cf_chksum_long(const char *filename, uint *chksum, int max_size, int cf_type)
1711 CFILE *cfile = NULL;
1713 // zero the checksum
1716 // attempt to open the file
1717 cfile = cfopen(filename,"rt",CFILE_NORMAL,cf_type);
1722 // call the overloaded cf_chksum function()
1723 ret_val = cf_chksum_do(cfile, NULL, chksum, max_size);
1725 // close the file down
1729 // return the result
1733 // get the 32 bit CRC checksum of the passed file - return 0 if operation failed, 1 if succeeded
1734 // NOTE : preserves current file position
1735 int cf_chksum_long(CFILE *file, uint *chksum, int max_size)
1740 // Returns current position of file.
1741 start_pos = cftell(file);
1742 if(start_pos == -1){
1746 // move to the beginning of the file
1747 if(cfseek(file, 0, CF_SEEK_SET)){
1750 ret_code = cf_chksum_do(file, NULL, chksum, max_size);
1751 // move back to the start position
1752 cfseek(file, start_pos, CF_SEEK_SET);
1758 // Flush the open file buffer
1760 // exit: 0 - success
1762 int cflush(CFILE *cfile)
1764 Assert(cfile != NULL);
1766 Assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1767 cb = &Cfile_block_list[cfile->id];
1769 // not supported for memory mapped files
1770 Assert( !cb->data );
1772 Assert(cb->fp != NULL);
1773 return fflush(cb->fp);
1776 // fill in Cfile_root_dir[] and Cfile_user_dir[]
1777 // this can be called at any time, even before cfile_init()
1778 // returns: non-zero on error
1779 int cfile_init_paths()
1781 if ( strlen(Cfile_root_dir) && strlen(Cfile_user_dir) ) {
1785 char *t_path = SDL_GetBasePath();
1787 // make sure we have something
1788 if (t_path == NULL) {
1789 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Error trying to determine executable directory!", NULL);
1794 if ( strlen(t_path) >= CFILE_ROOT_DIRECTORY_LEN ) {
1795 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Executable path is too long!", NULL);
1799 // set root directory
1800 strcpy(Cfile_root_dir, t_path);
1805 // are we in a root directory?
1806 if ( cfile_in_root_dir(Cfile_root_dir) ) {
1807 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Freespace2/Fred2 cannot be run from a drive root directory!", NULL);
1811 // now for the user/pref directory, the writable location
1812 char *u_path = SDL_GetPrefPath(Osreg_company_name, Osreg_title);
1814 // make sure we have something
1815 if (u_path == NULL) {
1816 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Error trying to determine preferences directory!", NULL);
1821 if ( strlen(u_path) >= CFILE_ROOT_DIRECTORY_LEN ) {
1822 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Preferences path is too long!", NULL);
1826 // set user/pref directory
1827 strcpy(Cfile_user_dir, u_path);