]> icculus.org git repositories - taylor/freespace2.git/blob - src/cfile/cfile.cpp
remove cf_attrib()
[taylor/freespace2.git] / src / cfile / cfile.cpp
1 /*
2  * Copyright (C) Volition, Inc. 1999.  All rights reserved.
3  *
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
6  * the source.
7  */
8
9 /*
10  * $Logfile: /Freespace2/code/CFile/cfile.cpp $
11  * $Revision$
12  * $Date$
13  * $Author$
14  *
15  * Utilities for operating on files
16  *
17  * $Log$
18  * Revision 1.14  2006/04/26 19:36:57  taylor
19  * address an error handling bug in cfwrite()
20  *
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
27  *
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
30  *
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
33  *
34  * Revision 1.10  2004/06/11 00:28:39  tigital
35  * byte-swapping changes for bigendian systems
36  *
37  * Revision 1.9  2003/05/25 02:30:42  taylor
38  * Freespace 1 support
39  *
40  * Revision 1.8  2003/02/20 17:41:07  theoddone33
41  * Userdir patch from Taylor Richards
42  *
43  * Revision 1.7  2002/12/30 03:23:29  relnev
44  * disable root dir check
45  *
46  * Revision 1.6  2002/06/17 06:33:08  relnev
47  * ryan's struct patch for gcc 2.95
48  *
49  * Revision 1.5  2002/06/09 04:41:15  relnev
50  * added copyright header
51  *
52  * Revision 1.4  2002/06/05 08:05:28  relnev
53  * stub/warning removal.
54  *
55  * reworked the sound code.
56  *
57  * Revision 1.3  2002/05/28 08:52:03  relnev
58  * implemented two assembly stubs.
59  *
60  * cleaned up a few warnings.
61  *
62  * added a little demo hackery to make it progress a little farther.
63  *
64  * Revision 1.2  2002/05/28 06:28:20  theoddone33
65  * Filesystem mods, actually reads some data files now
66  *
67  * Revision 1.1.1.1  2002/05/03 03:28:08  root
68  * Initial import.
69  *
70  * 
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.
74  * 
75  * 19    9/08/99 12:03a Dave
76  * Make squad logos render properly in D3D all the time. Added intel anim
77  * directory.
78  * 
79  * 18    9/06/99 2:35p Dave
80  * Rename briefing and debriefing voice direcrory paths properly.
81  * 
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
86  * main hall.
87  * 
88  * 16    8/31/99 9:46a Dave
89  * Support for new cfile cbanims directory.
90  * 
91  * 15    8/06/99 11:20a Johns
92  * Don't call game_cd_changed() in a demo or multiplayer beta build.
93  * 
94  * 14    6/08/99 2:33p Dave
95  * Fixed release build warning. Put in hud config stuff.
96  * 
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.
100  * 
101  * 12    4/30/99 12:18p Dave
102  * Several minor bug fixes.
103  * 
104  * 11    4/07/99 5:54p Dave
105  * Fixes for encryption in updatelauncher.
106  * 
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 :)
110  * 
111  * 9     2/22/99 10:31p Andsager
112  * Get rid of unneeded includes.
113  * 
114  * 8     1/12/99 3:15a Dave
115  * Barracks screen support for selecting squad logos. We need real artwork
116  * :)
117  * 
118  * 7     11/30/98 1:07p Dave
119  * 16 bit conversion, first run.
120  * 
121  * 6     10/29/98 10:41a Dave
122  * Change the way cfile initializes exe directory.
123  * 
124  * 5     10/13/98 9:19a Andsager
125  * Add localization support to cfile.  Optional parameter with cfopen that
126  * looks for localized files.
127  * 
128  * 4     10/12/98 9:54a Dave
129  * Fixed a few file organization things.
130  * 
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
134  * directory.
135  * 
136  * 2     10/07/98 10:52a Dave
137  * Initial checkin.
138  * 
139  * 1     10/07/98 10:48a Dave
140  * 
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
146  * .fsm file).
147  * 
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.
151  * 
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.
155  * 
156  * 107   9/04/98 3:51p Dave
157  * Put in validated mission updating and application during stats
158  * updating.
159  * 
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.
163  * 
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.
167  * 
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.
171  * 
172  * 103   6/17/98 9:30a Allender
173  * fixed red alert replay stats clearing problem
174  * 
175  * 102   6/05/98 9:46a Lawrance
176  * check for CD change on cfopen()
177  * 
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
181  * missions folder)
182  * 
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.
187  * 
188  * 99    5/11/98 10:59a John
189  * Moved the low-level file reading code into cfilearchive.cpp.
190  * 
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
195  * problems.
196  * 
197  * 97    5/03/98 11:53a John
198  * Fixed filename case mangling.
199  * 
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.  
203  * 
204  * 95    5/02/98 11:05p Allender
205  * fix cfilelength for pack files
206  * 
207  *
208  * $NoKeywords: $
209  */
210 #define _CFILE_INTERNAL 
211
212 #include <stdlib.h>
213 #include <string.h>
214 #include <stdio.h>
215 #include <errno.h>
216 #ifndef PLAT_UNIX
217 #include <io.h>
218 #include <direct.h>
219 #include <windows.h>
220 #include <winbase.h>            /* needed for memory mapping of file functions */
221 #else
222 #include <unistd.h>
223 #include <sys/stat.h>
224 #include <sys/types.h>
225 #endif
226
227 #include "pstypes.h"
228 #include "cfile.h"
229 #include "encrypt.h"
230 //#include "outwnd.h"
231 //#include "vecmat.h"
232 //#include "timer.h"
233 #include "cfilesystem.h"
234 #include "cfilearchive.h"
235 #include "osapi.h"
236 #include "osregistry.h"
237
238 char Cfile_root_dir[CFILE_ROOT_DIRECTORY_LEN] = "";
239 char Cfile_user_dir[CFILE_ROOT_DIRECTORY_LEN] = "";
240
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.
244 //
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    },
251         { CF_TYPE_MAPS,                                 "Data" DIR_SEPARATOR_STR "Maps",                                                        ".pcx .ani .tga",                       CF_TYPE_DATA    },
252         { CF_TYPE_TEXT,                                 "Data" DIR_SEPARATOR_STR "Text",                                                        ".txt .net",                            CF_TYPE_DATA    },
253 #ifdef MAKE_FS1
254         { CF_TYPE_MISSIONS,                             "Data" DIR_SEPARATOR_STR "Missions",                                            ".fsm .fsc .ntl .ssv",  CF_TYPE_DATA    },
255 #else
256         { CF_TYPE_MISSIONS,                             "Data" DIR_SEPARATOR_STR "Missions",                                            ".fs2 .fc2 .ntl .ssv",  CF_TYPE_DATA    },
257 #endif
258         { CF_TYPE_MODELS,                                       "Data" DIR_SEPARATOR_STR "Models",                                              ".pof",                                         CF_TYPE_DATA    },
259         { CF_TYPE_TABLES,                                       "Data" DIR_SEPARATOR_STR "Tables",                                              ".tbl",                                         CF_TYPE_DATA    },
260         { CF_TYPE_SOUNDS,                                       "Data" DIR_SEPARATOR_STR "Sounds",                                              ".wav",                                         CF_TYPE_DATA    },
261         { CF_TYPE_SOUNDS_8B22K,                 "Data" DIR_SEPARATOR_STR "Sounds" DIR_SEPARATOR_STR "8b22k",                            ".wav",                                         CF_TYPE_SOUNDS  },
262         { CF_TYPE_SOUNDS_16B11K,                "Data" DIR_SEPARATOR_STR "Sounds" DIR_SEPARATOR_STR "16b11k",                           ".wav",                                         CF_TYPE_SOUNDS  },
263         { CF_TYPE_VOICE,                                        "Data" DIR_SEPARATOR_STR "Voice",                                                       "",                                                     CF_TYPE_DATA    },
264 #ifdef MAKE_FS1
265         { CF_TYPE_VOICE_BRIEFINGS,              "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Briefings",                 ".wav",                                         CF_TYPE_VOICE   },
266 #else
267         { CF_TYPE_VOICE_BRIEFINGS,              "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Briefing",                  ".wav",                                         CF_TYPE_VOICE   },
268 #endif
269         { CF_TYPE_VOICE_CMD_BRIEF,              "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Command_briefings",".wav",                                          CF_TYPE_VOICE   },
270 #ifdef MAKE_FS1
271         { CF_TYPE_VOICE_DEBRIEFINGS,    "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Debriefings",                       ".wav",                                         CF_TYPE_VOICE   },
272 #else
273         { CF_TYPE_VOICE_DEBRIEFINGS,    "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Debriefing",                        ".wav",                                         CF_TYPE_VOICE   },
274 #endif
275         { CF_TYPE_VOICE_PERSONAS,               "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Personas",                  ".wav",                                         CF_TYPE_VOICE   },
276         { CF_TYPE_VOICE_SPECIAL,                "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Special",                           ".wav",                                         CF_TYPE_VOICE   },
277         { CF_TYPE_VOICE_TRAINING,               "Data" DIR_SEPARATOR_STR "Voice" DIR_SEPARATOR_STR "Training",                  ".wav",                                         CF_TYPE_VOICE   },
278         { CF_TYPE_MUSIC,                                        "Data" DIR_SEPARATOR_STR "Music",                                                       ".wav",                                         CF_TYPE_VOICE   },
279         { CF_TYPE_MOVIES,                                       "Data" DIR_SEPARATOR_STR "Movies",                                              ".mve .msb",                            CF_TYPE_DATA    },
280         { CF_TYPE_INTERFACE,                            "Data" DIR_SEPARATOR_STR "Interface",                                   ".pcx .ani .tga",                       CF_TYPE_DATA    },
281         { CF_TYPE_FONT,                                 "Data" DIR_SEPARATOR_STR "Fonts",                                                       ".vf",                                          CF_TYPE_DATA    },
282         { CF_TYPE_EFFECTS,                              "Data" DIR_SEPARATOR_STR "Effects",                                             ".ani .pcx .neb .tga",  CF_TYPE_DATA    },
283         { CF_TYPE_HUD,                                          "Data" DIR_SEPARATOR_STR "Hud",                                                 ".ani .pcx .tga",                       CF_TYPE_DATA    },
284         { CF_TYPE_PLAYER_MAIN,                  "Data" DIR_SEPARATOR_STR "Players",                                             "",                                                     CF_TYPE_DATA    },
285         { CF_TYPE_PLAYER_IMAGES_MAIN,   "Data" DIR_SEPARATOR_STR "Players" DIR_SEPARATOR_STR "Images",                  ".pcx",                                         CF_TYPE_PLAYER_MAIN     },
286         { CF_TYPE_CACHE,                                        "Data" DIR_SEPARATOR_STR "Cache",                                                       ".clr .tmp",                            CF_TYPE_DATA    },      //clr=cached color
287         { CF_TYPE_PLAYERS,                              "Data" DIR_SEPARATOR_STR "Players",                                             ".hcf",                                         CF_TYPE_DATA    },
288         { CF_TYPE_SINGLE_PLAYERS,               "Data" DIR_SEPARATOR_STR "Players" DIR_SEPARATOR_STR "Single",                  ".plr .csg .css",                       CF_TYPE_PLAYERS },
289         { CF_TYPE_MULTI_PLAYERS,                "Data" DIR_SEPARATOR_STR "Players" DIR_SEPARATOR_STR "Multi",                           ".plr",                                         CF_TYPE_DATA    },
290         { CF_TYPE_MULTI_CACHE,                  "Data" DIR_SEPARATOR_STR "MultiData",                                   ".pcx .fs2",                            CF_TYPE_DATA    },
291         { CF_TYPE_CONFIG,                                       "Data" DIR_SEPARATOR_STR "Config",                                              ".cfg",                                         CF_TYPE_DATA    },
292         { CF_TYPE_SQUAD_IMAGES_MAIN,    "Data" DIR_SEPARATOR_STR "Players" DIR_SEPARATOR_STR "Squads",                  ".pcx",                                         CF_TYPE_DATA    },
293         { CF_TYPE_DEMOS,                                        "Data" DIR_SEPARATOR_STR "Demos",                                                       ".fsd",                                         CF_TYPE_DATA    },
294         { CF_TYPE_CBANIMS,                              "Data" DIR_SEPARATOR_STR "CBAnims",                                             ".ani",                                         CF_TYPE_DATA    },
295         { CF_TYPE_INTEL_ANIMS,                  "Data" DIR_SEPARATOR_STR "IntelAnims",                                  ".ani",                                         CF_TYPE_DATA    },
296 };
297
298
299 #define CFILE_STACK_MAX 8
300
301 int cfile_inited = 0;
302 int Cfile_stack_pos = 0;
303
304 char Cfile_stack[128][CFILE_STACK_MAX];
305
306 Cfile_block Cfile_block_list[MAX_CFILE_BLOCKS];
307 CFILE Cfile_list[MAX_CFILE_BLOCKS];
308
309 //
310 // Function prototypes for internally-called functions
311 //
312 int cfget_cfile_block();
313 CFILE *cf_open_fill_cfblock(FILE * fp, int type);
314 CFILE *cf_open_packed_cfblock(FILE *fp, int type, int offset, int size);
315 CFILE *cf_open_mapped_fill_cfblock(HANDLE hFile, int type);
316 void cf_chksum_long_init();
317
318 void cfile_close()
319 {
320         cf_free_secondary_filelist();
321 }
322
323 // determine if the given path is in a root directory (c:\  or  c:\freespace2.exe  or  c:\fred2.exe   etc)
324 int cfile_in_root_dir(char *exe_path)
325 {
326         int token_count = 0;
327         char path_copy[2048] = "";
328         char *tok;
329
330         // bogus
331         if(exe_path == NULL){
332                 return 1;
333         }
334
335         // copy the path
336         memset(path_copy, 0, 2048);
337         strncpy(path_copy, exe_path, 2047);
338
339         // count how many slashes there are in the path
340         tok = strtok(path_copy, DIR_SEPARATOR_STR);
341         if(tok == NULL){
342                 return 1;
343         }       
344         do {
345                 token_count++;
346                 tok = strtok(NULL, DIR_SEPARATOR_STR);
347         } while(tok != NULL);
348                 
349         // root directory if we have <= 1 slash
350         if(token_count <= 2){
351                 return 1;
352         }
353
354         // not-root directory
355         return 0;
356 }
357
358 // cfile_init() initializes the cfile system.  Called once at application start.
359 //
360 //      returns:  success ==> 0
361 //           error   ==> non-zero
362 //
363 int cfile_init(const char *extras_dir)
364 {
365         int i;
366
367         // initialize encryption
368         encrypt_init(); 
369
370         if ( !cfile_inited ) {
371                 // initialize root and user paths (may have been done already)
372                 if ( cfile_init_paths() ) {
373                         return 1;
374                 }
375
376                 cfile_inited = 1;
377
378                 for ( i = 0; i < MAX_CFILE_BLOCKS; i++ ) {
379                         Cfile_block_list[i].type = CFILE_BLOCK_UNUSED;
380                 }
381
382                 const char *extras_dir = os_config_read_string(NULL, "ExtrasPath", NULL);
383
384                 if ( extras_dir && (strlen(extras_dir) >= MAX_PATH_LEN) ) {
385                         extras_dir = NULL;
386                 }
387
388                 cf_build_secondary_filelist(extras_dir);
389
390                 // 32 bit CRC table init
391                 cf_chksum_long_init();
392
393
394
395                 atexit( cfile_close );
396         }
397
398         return 0;
399 }
400
401
402 // Changes to a drive if valid.. 1=A, 2=B, etc
403 // If flag, then changes to it.
404 // Returns 0 if not-valid, 1 if valid.
405 int cfile_chdrive( int DriveNum, int flag )
406 {
407 #ifdef PLAT_UNIX
408         STUB_FUNCTION;
409         return 0;
410 #else
411         int n, org;
412         int Valid = 0;
413
414         org = -1;
415         if (!flag)
416                 org = _getdrive();
417
418         _chdrive( DriveNum );
419         n = _getdrive();
420
421
422         if (n == DriveNum )
423                 Valid = 1;
424
425         if ( (!flag) && (n != org) )
426                 _chdrive( org );
427         return Valid;
428 #endif
429 }
430
431 // push current directory on a 'stack' (so we can restore it) and change the directory
432 int cfile_push_chdir(int type)
433 {
434         int e;
435         char dir[128];
436         char OriginalDirectory[128];
437         char *Path;
438         char NoDir[] = "\\.";
439
440         _getcwd(OriginalDirectory, 127);
441         SDL_assert(Cfile_stack_pos < CFILE_STACK_MAX);
442         strcpy(Cfile_stack[Cfile_stack_pos++], OriginalDirectory);
443
444         cf_create_default_path_string( dir, type, NULL );
445         SDL_strlwr(dir);
446 #ifndef PLAT_UNIX
447         char *Drive = strchr(dir, ':');
448
449         if (Drive) {
450                 if (!cfile_chdrive( *(Drive - 1) - 'a' + 1, 1))
451                         return 1;
452
453                 Path = Drive+1;
454
455         } else 
456 #endif
457         {
458                 Path = dir;
459         }
460
461         if (!(*Path)) {
462                 Path = NoDir;
463         }
464
465         // This chdir might get a critical error!
466         e = _chdir( Path );
467         if (e) {
468                 cfile_chdrive( OriginalDirectory[0] - 'a' + 1, 1 );
469                 return 2;
470         }
471
472         return 0;
473 }
474
475
476 int cfile_chdir(char *dir)
477 {
478         int e;
479         char OriginalDirectory[128];
480         char *Path;
481         char NoDir[] = "\\.";
482
483         _getcwd(OriginalDirectory, 127);
484         SDL_strlwr(dir);
485
486 #ifndef PLAT_UNIX
487         char *Drive = strchr(dir, ':');
488         if (Drive)      {
489                 if (!cfile_chdrive( *(Drive - 1) - 'a' + 1, 1))
490                         return 1;
491
492                 Path = Drive+1;
493
494         } else 
495 #endif
496         {
497                 Path = dir;
498         }
499
500         if (!(*Path)) {
501                 Path = NoDir;
502         }
503
504         // This chdir might get a critical error!
505         e = _chdir( Path );
506         if (e) {
507                 cfile_chdrive( OriginalDirectory[0] - 'a' + 1, 1 );
508                 return 2;
509         }
510
511         return 0;
512 }
513
514 int cfile_pop_dir()
515 {
516         SDL_assert(Cfile_stack_pos);
517         Cfile_stack_pos--;
518         return cfile_chdir(Cfile_stack[Cfile_stack_pos]);
519 }
520
521 // flush (delete all files in) the passed directory (by type), return the # of files deleted
522 // NOTE : WILL NOT DELETE READ-ONLY FILES
523 int cfile_flush_dir(int dir_type)
524 {
525 #ifdef PLAT_UNIX
526         STUB_FUNCTION;
527         return 0;
528 #else
529         int find_handle;
530         int del_count;
531         _finddata_t find;
532
533         SDL_assert( CF_TYPE_SPECIFIED(dir_type) );
534
535         // attempt to change the directory to the passed type
536         if(cfile_push_chdir(dir_type)){
537                 return 0;
538         }
539
540         // proceed to delete the files
541         find_handle = _findfirst( "*", &find );
542         del_count = 0;
543         if (find_handle != -1) {
544                 do {                    
545                         if (!(find.attrib & _A_SUBDIR) && !(find.attrib & _A_RDONLY)) {
546                                 // delete the file
547                                 cf_delete(find.name,dir_type);                          
548
549                                 // increment the deleted count
550                                 del_count++;
551                         }
552                 } while (!_findnext(find_handle, &find));
553                 _findclose( find_handle );
554         }
555
556         // pop the directory back
557         cfile_pop_dir();
558
559         // return the # of files deleted
560         return del_count;
561 #endif
562 }
563
564
565 // add the given extention to a filename (or filepath) if it doesn't already have this
566 // extension.
567 //    filename = name of filename or filepath to process
568 //    ext = extension to add.  Must start with the period
569 //    Returns: new filename or filepath with extension.
570 char *cf_add_ext(const char *filename, const char *ext)
571 {
572         int flen, elen;
573         static char path[MAX_PATH_LEN];
574
575         flen = strlen(filename);
576         elen = strlen(ext);
577         SDL_assert(flen < MAX_PATH_LEN);
578         strcpy(path, filename);
579         if ((flen < 4) || SDL_strcasecmp(path + flen - elen, ext)) {
580                 SDL_assert(flen + elen < MAX_PATH_LEN);
581                 strcat(path, ext);
582         }
583
584         return path;
585 }
586
587 // Deletes a file.
588 void cf_delete( const char *filename, int dir_type )
589 {
590         char longname[MAX_PATH_LEN];
591
592         SDL_assert( CF_TYPE_SPECIFIED(dir_type) );
593
594         cf_create_default_path_string( longname, dir_type, filename );
595
596         FILE *fp = fopen(longname, "rb");
597         if (fp) {
598                 // delete the file
599                 fclose(fp);
600                 _unlink(longname);
601         }
602
603 }
604
605
606 // Same as _access function to read a file's access bits
607 int cf_access( const char *filename, int dir_type, int mode )
608 {
609         char longname[MAX_PATH_LEN];
610
611         SDL_assert( CF_TYPE_SPECIFIED(dir_type) );
612
613         cf_create_default_path_string( longname, dir_type, filename );
614
615         return access(longname,mode);
616 }
617
618
619 // Returns 1 if file exists, 0 if not.
620 int cf_exist( const char *filename, int dir_type )
621 {
622         char longname[MAX_PATH_LEN];
623
624         SDL_assert( CF_TYPE_SPECIFIED(dir_type) );
625
626         cf_create_default_path_string( longname, dir_type, filename );
627
628         FILE *fp = fopen(longname, "rb");
629         if (fp) {
630                 return 1;
631                 fclose(fp);
632         }
633
634         return 0;
635 }
636
637 int cf_rename(const char *old_name, const char *name, int dir_type)
638 {
639         SDL_assert( CF_TYPE_SPECIFIED(dir_type) );
640
641         int ret_code;
642         char old_longname[_MAX_PATH];
643         char new_longname[_MAX_PATH];
644         
645         cf_create_default_path_string( old_longname, dir_type, old_name );
646         cf_create_default_path_string( new_longname, dir_type, name );
647
648         ret_code = rename(old_longname, new_longname );         
649         if(ret_code != 0){
650                 switch(errno){
651                 case EACCES :
652                         return CF_RENAME_FAIL_ACCESS;
653                 case ENOENT :
654                 default:
655                         return CF_RENAME_FAIL_EXIST;
656                 }
657         }
658
659         return CF_RENAME_SUCCESS;
660         
661
662 }
663
664 // Creates the directory path if it doesn't exist. Even creates all its
665 // parent paths.
666 void cf_create_directory( int dir_type )
667 {
668         int num_dirs = 0;
669         int dir_tree[CF_MAX_PATH_TYPES];
670         char longname[MAX_PATH_LEN];
671
672         SDL_assert( CF_TYPE_SPECIFIED(dir_type) );
673
674         int current_dir = dir_type;
675
676         do {
677                 SDL_assert( num_dirs < CF_MAX_PATH_TYPES );             // Invalid Pathtypes data?
678
679                 dir_tree[num_dirs++] = current_dir;
680                 current_dir = Pathtypes[current_dir].parent_index;
681
682         } while( current_dir != CF_TYPE_ROOT );
683
684         
685         int i;
686
687         for (i=num_dirs-1; i>=0; i-- )  {
688                 cf_create_default_path_string( longname, dir_tree[i], NULL );
689
690                 if ( _mkdir(longname)==0 )      {
691                         mprintf(( "CFILE: Created new directory '%s'\n", longname ));
692                 }
693         }
694
695
696 }
697
698
699 // cfopen()
700 //
701 // parameters:  *filepath ==> name of file to open (may be path+name)
702 //              *mode     ==> specifies how file should be opened (eg "rb" for read binary)
703 //                            passing NULL to mode deletes the file if it exists and returns NULL
704 //               type     ==> one of:    CFILE_NORMAL
705 //                                       CFILE_MEMORY_MAPPED
706 //                                        dir_type      =>      override extension check, value is one of CF_TYPE* #defines
707 //
708 //               NOTE: type parameter is an optional parameter.  The default value is CFILE_NORMAL
709 //
710 //
711 // returns:             success ==> address of CFILE structure
712 //                                      error   ==> NULL
713 //
714
715 CFILE *cfopen(const char *file_path, const char *mode, int type, int dir_type, bool localize)
716 {
717         char longname[_MAX_PATH];
718
719 //      nprintf(("CFILE", "CFILE -- trying to open %s\n", file_path ));
720 // #if !defined(MULTIPLAYER_BETA_BUILD) && !defined(FS2_DEMO)
721
722         //================================================
723         // Check that all the parameters make sense
724         SDL_assert(file_path && strlen(file_path));
725         SDL_assert( mode != NULL );
726         
727         // Can only open read-only binary files in memory mapped mode.
728         if ( (type & CFILE_MEMORY_MAPPED) && strcmp(mode,"rb") ) {
729                 Int3();                         
730                 return NULL;
731         }
732
733         //===========================================================
734         // If in write mode, just try to open the file straight off
735         // the harddisk.  No fancy packfile stuff here!
736         
737         if ( strchr(mode,'w') ) {
738                 // For write-only files, require a full path or a path type
739 #ifdef PLAT_UNIX
740                 if ( strpbrk(file_path, "/") ) {
741 #else
742                 if ( strpbrk(file_path,"/\\:")  ) {  
743 #endif
744                         // Full path given?
745                         strcpy(longname, file_path );
746                 } else {
747                         // Path type given?
748                         SDL_assert( dir_type != CF_TYPE_ANY );
749
750                         // Create the directory if necessary
751                         cf_create_directory( dir_type );
752
753                         cf_create_default_path_string( longname, dir_type, file_path );
754                 }
755                 SDL_assert( !(type & CFILE_MEMORY_MAPPED) );
756
757                 // JOHN: TODO, you should create the path if it doesn't exist.
758                                 
759                 FILE *fp = fopen(longname, mode);
760                 if (fp) {
761                         return cf_open_fill_cfblock(fp, dir_type);
762                 }
763                 return NULL;
764         } 
765
766
767         //================================================
768         // Search for file on disk, on cdrom, or in a packfile
769
770         int offset, size;
771         char copy_file_path[MAX_PATH_LEN];  // FIX change in memory from cf_find_file_location
772         strcpy(copy_file_path, file_path);
773
774
775         if ( cf_find_file_location( copy_file_path, dir_type, longname, &size, &offset, localize ) )    {
776
777                 // Fount it, now create a cfile out of it
778                 
779                 if ( type & CFILE_MEMORY_MAPPED ) {
780                 
781                         // Can't open memory mapped files out of pack files
782                         if ( offset == 0 )      {
783 #ifdef PLAT_UNIX
784                                 STUB_FUNCTION;
785 #else
786                                 HANDLE hFile;
787
788                                 hFile = CreateFile(longname, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
789
790                                 if (hFile != INVALID_HANDLE_VALUE)      {
791                                         return cf_open_mapped_fill_cfblock(hFile, dir_type);
792                                 }
793 #endif
794                         } 
795
796                 } else {
797
798                         FILE *fp = fopen( longname, "rb" );
799
800                         if ( fp )       {
801                                 if ( offset )   {
802                                         // Found it in a pack file
803                                         return cf_open_packed_cfblock(fp, dir_type, offset, size );
804                                 } else {
805                                         // Found it in a normal file
806                                         return cf_open_fill_cfblock(fp, dir_type);
807                                 } 
808                         }
809                 }
810
811         }
812
813         return NULL;
814 }
815
816
817 // ------------------------------------------------------------------------
818 // ctmpfile() 
819 //
820 // Open up a temporary file.  A unique name is automatically generated.  The
821 // file will be automatically deleted when file is closed.
822 //
823 // return:              NULL                                    =>              tmp file could not be opened
824 //                                      pointer to CFILE        =>              tmp file successfully opened
825 //
826 CFILE *ctmpfile()
827 {
828         FILE    *fp;
829         fp = tmpfile();
830         if ( fp )
831                 return cf_open_fill_cfblock(fp, 0);
832         else
833                 return NULL;
834 }
835
836
837
838 // cfget_cfile_block() will try to find an empty Cfile_block structure in the
839 //      Cfile_block_list[] array and return the index.
840 //
841 // returns:   success ==> index in Cfile_block_list[] array
842 //            failure ==> -1
843 //
844 int cfget_cfile_block()
845 {       
846         int i;
847         Cfile_block *cb;
848
849         for ( i = 0; i < MAX_CFILE_BLOCKS; i++ ) {
850                 cb = &Cfile_block_list[i];
851                 if ( cb->type == CFILE_BLOCK_UNUSED ) {
852                         cb->data = NULL;
853                         cb->fp = NULL;
854                         cb->type = CFILE_BLOCK_USED;
855                         return i;
856                 }
857         }
858
859         // If we've reached this point, a free Cfile_block could not be found
860         nprintf(("Warning","A free Cfile_block could not be found.\n"));
861         SDL_assert(0);  // out of free cfile blocks
862         return -1;                      
863 }
864
865
866 // cfclose() closes the file
867 //
868 // returns:   success ==> 0
869 //                                failure ==> EOF
870 //
871 int cfclose( CFILE * cfile )
872 {
873         int result;
874
875         SDL_assert(cfile != NULL);
876         Cfile_block *cb;
877         SDL_assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
878         cb = &Cfile_block_list[cfile->id];      
879
880         result = 0;
881         if ( cb->data ) {
882                 // close memory mapped file
883 #ifdef PLAT_UNIX
884                 STUB_FUNCTION;
885 #else
886                 result = UnmapViewOfFile((void*)cb->data);
887                 SDL_assert(result);
888                 result = CloseHandle(cb->hInFile);              
889                 SDL_assert(result);     // Ensure file handle is closed properly
890                 result = CloseHandle(cb->hMapFile);             
891                 SDL_assert(result);     // Ensure file handle is closed properly
892 #endif
893                 result = 0;
894
895         } else if ( cb->fp != NULL )    {
896                 SDL_assert(cb->fp != NULL);
897                 result = fclose(cb->fp);
898         } else {
899                 // VP  do nothing
900         }
901
902         cb->type = CFILE_BLOCK_UNUSED;
903         return result;
904 }
905
906
907
908
909 // cf_open_fill_cfblock() will fill up a Cfile_block element in the Cfile_block_list[] array
910 // for the case of a file being opened by cf_open();
911 //
912 // returns:   success ==> ptr to CFILE structure.  
913 //            error   ==> NULL
914 //
915 CFILE *cf_open_fill_cfblock(FILE *fp, int type)
916 {
917         int cfile_block_index;
918
919         cfile_block_index = cfget_cfile_block();
920         if ( cfile_block_index == -1 ) {
921                 return NULL;
922         } else {
923                 CFILE *cfp;
924                 Cfile_block *cfbp;
925                 cfbp = &Cfile_block_list[cfile_block_index];
926                 cfp = &Cfile_list[cfile_block_index];;
927                 cfp->id = cfile_block_index;
928                 cfp->version = 0;
929                 cfbp->data = NULL;
930                 cfbp->fp = fp;
931                 cfbp->dir_type = type;
932                 
933                 cf_init_lowlevel_read_code(cfp,0,filelength(fileno(fp)) );
934
935                 return cfp;
936         }
937 }
938
939
940 // cf_open_packed_cfblock() will fill up a Cfile_block element in the Cfile_block_list[] array
941 // for the case of a file being opened by cf_open();
942 //
943 // returns:   success ==> ptr to CFILE structure.  
944 //            error   ==> NULL
945 //
946 CFILE *cf_open_packed_cfblock(FILE *fp, int type, int offset, int size)
947 {
948         // Found it in a pack file
949         int cfile_block_index;
950         
951         cfile_block_index = cfget_cfile_block();
952         if ( cfile_block_index == -1 ) {
953                 return NULL;
954         } else {
955                 CFILE *cfp;
956                 Cfile_block *cfbp;
957                 cfbp = &Cfile_block_list[cfile_block_index];
958         
959                 cfp = &Cfile_list[cfile_block_index];
960                 cfp->id = cfile_block_index;
961                 cfp->version = 0;
962                 cfbp->data = NULL;
963                 cfbp->fp = fp;
964                 cfbp->dir_type = type;
965
966                 cf_init_lowlevel_read_code(cfp,offset, size );
967
968                 return cfp;
969         }
970
971 }
972
973
974
975 // cf_open_mapped_fill_cfblock() will fill up a Cfile_block element in the Cfile_block_list[] array
976 // for the case of a file being opened by cf_open_mapped();
977 //
978 // returns:   ptr CFILE structure.  
979 //
980 CFILE *cf_open_mapped_fill_cfblock(HANDLE hFile, int type)
981 {
982         int cfile_block_index;
983
984         cfile_block_index = cfget_cfile_block();
985         if ( cfile_block_index == -1 ) {
986                 return NULL;
987         }
988         else {
989                 CFILE *cfp;
990                 Cfile_block *cfbp;
991                 cfbp = &Cfile_block_list[cfile_block_index];
992
993                 cfp = &Cfile_list[cfile_block_index];
994                 cfp->id = cfile_block_index;
995                 cfbp->fp = NULL;
996                 cfbp->hInFile = hFile;
997                 cfbp->dir_type = type;
998
999                 cf_init_lowlevel_read_code(cfp,0 , 0 );
1000
1001 #ifdef PLAT_UNIX
1002                 STUB_FUNCTION;
1003 #else
1004                 cfbp->hMapFile = CreateFileMapping(cfbp->hInFile, NULL, PAGE_READONLY, 0, 0, NULL);
1005                 if (cfbp->hMapFile == NULL) { 
1006                         nprintf(("Error", "Could not create file-mapping object.\n")); 
1007                         return NULL;
1008                 } 
1009         
1010                 cfbp->data = (ubyte*)MapViewOfFile(cfbp->hMapFile, FILE_MAP_READ, 0, 0, 0);
1011                 SDL_assert( cfbp->data != NULL );               
1012 #endif
1013                 return cfp;
1014         }
1015 }
1016
1017 int cf_get_dir_type(CFILE *cfile)
1018 {
1019         return Cfile_block_list[cfile->id].dir_type;
1020 }
1021
1022 // cf_returndata() returns the data pointer for a memory-mapped file that is associated
1023 // with the CFILE structure passed as a parameter
1024 //
1025 // 
1026
1027 void *cf_returndata(CFILE *cfile)
1028 {
1029         SDL_assert(cfile != NULL);
1030         Cfile_block *cb;
1031         SDL_assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1032         cb = &Cfile_block_list[cfile->id];      
1033         SDL_assert(cb->data != NULL);
1034         return cb->data;
1035 }
1036
1037
1038
1039 // version number of opened file.  Will be 0 unless you put something else here after you
1040 // open a file.  Once set, you can use minimum version numbers with the read functions.
1041 void cf_set_version( CFILE * cfile, int version )
1042 {
1043         SDL_assert(cfile != NULL);
1044
1045         cfile->version = version;
1046 }
1047
1048 // routines to read basic data types from CFILE's.  Put here to
1049 // simplify mac/pc reading from cfiles.
1050 #ifdef __APPLE__
1051 #include <stddef.h>
1052 #endif
1053
1054 float cfread_float(CFILE *file, int ver, float deflt)
1055 {
1056         float f;
1057
1058         if (file->version < ver)
1059                 return deflt;
1060
1061         if (cfread( &f, sizeof(f), 1, file) != 1)
1062                 return deflt;
1063
1064     f = INTEL_FLOAT(f);
1065         return f;
1066 }
1067
1068 int cfread_int(CFILE *file, int ver, int deflt)
1069 {
1070         int i;
1071
1072         if (file->version < ver)
1073                 return deflt;
1074
1075         if (cfread( &i, sizeof(i), 1, file) != 1)
1076                 return deflt;
1077
1078         i = INTEL_INT(i);
1079         return i;
1080 }
1081
1082 uint cfread_uint(CFILE *file, int ver, uint deflt)
1083 {
1084         uint i;
1085
1086         if (file->version < ver)
1087                 return deflt;
1088
1089         if (cfread( &i, sizeof(i), 1, file) != 1)
1090                 return deflt;
1091
1092         i = INTEL_INT(i);
1093         return i;
1094 }
1095
1096 short cfread_short(CFILE *file, int ver, short deflt)
1097 {
1098         short s;
1099
1100         if (file->version < ver)
1101                 return deflt;
1102
1103         if (cfread( &s, sizeof(s), 1, file) != 1)
1104                 return deflt;
1105
1106         s = INTEL_SHORT(s);
1107         return s;
1108 }
1109
1110 ushort cfread_ushort(CFILE *file, int ver, ushort deflt)
1111 {
1112         ushort s;
1113
1114         if (file->version < ver)
1115                 return deflt;
1116
1117         if (cfread( &s, sizeof(s), 1, file) != 1)
1118                 return deflt;
1119
1120         s = INTEL_SHORT(s);
1121         return s;
1122 }
1123
1124 ubyte cfread_ubyte(CFILE *file, int ver, ubyte deflt)
1125 {
1126         ubyte b;
1127
1128         if (file->version < ver)
1129                 return deflt;
1130
1131         if (cfread( &b, sizeof(b), 1, file) != 1)
1132                 return deflt;
1133
1134         return b;
1135 }
1136
1137 void cfread_vector(vector *vec, CFILE *file, int ver, vector *deflt)
1138 {
1139         if (file->version < ver) {
1140                 if (deflt)
1141                         *vec = *deflt;
1142                 else
1143                         vec->xyz.x = vec->xyz.y = vec->xyz.z = 0.0f;
1144
1145                 return;
1146         }
1147
1148         vec->xyz.x = cfread_float(file, ver, deflt ? deflt->xyz.x : 0.0f);
1149         vec->xyz.y = cfread_float(file, ver, deflt ? deflt->xyz.y : 0.0f);
1150         vec->xyz.z = cfread_float(file, ver, deflt ? deflt->xyz.z : 0.0f);
1151 }
1152         
1153 void cfread_angles(angles *ang, CFILE *file, int ver, angles *deflt)
1154 {
1155         if (file->version < ver) {
1156                 if (deflt)
1157                         *ang = *deflt;
1158                 else
1159                         ang->p = ang->b = ang->h = 0.0f;
1160
1161                 return;
1162         }
1163
1164         ang->p = cfread_float(file, ver, deflt ? deflt->p : 0.0f);
1165         ang->b = cfread_float(file, ver, deflt ? deflt->b : 0.0f);
1166         ang->h = cfread_float(file, ver, deflt ? deflt->h : 0.0f);
1167 }
1168
1169 char cfread_char(CFILE *file, int ver, char deflt)
1170 {
1171         char b;
1172
1173         if (file->version < ver)
1174                 return deflt;
1175
1176         if (cfread( &b, sizeof(b), 1, file) != 1)
1177                 return deflt;
1178
1179         return b;
1180 }
1181
1182 void cfread_string(char *buf, int n, CFILE *file)
1183 {
1184         char c;
1185
1186         do {
1187                 c = cfread_char(file);
1188                 if ( n > 0 )    {
1189                         *buf++ = c;
1190                         n--;
1191                 }
1192         } while (c != 0 );
1193 }
1194
1195 void cfread_string_len(char *buf,int n, CFILE *file)
1196 {
1197         int len;
1198         len = cfread_int(file);
1199         SDL_assert( len < n );
1200         if (len)
1201                 cfread(buf, len, 1, file);
1202
1203         buf[len] = 0;
1204 }
1205
1206 // equivalent write functions of above read functions follow
1207
1208 int cfwrite_float(float f, CFILE *file)
1209 {
1210     f = INTEL_FLOAT(f);
1211         return cfwrite(&f, sizeof(f), 1, file);
1212 }
1213
1214 int cfwrite_int(int i, CFILE *file)
1215 {
1216         i = INTEL_INT(i);
1217         return cfwrite(&i, sizeof(i), 1, file);
1218 }
1219
1220 int cfwrite_uint(uint i, CFILE *file)
1221 {
1222         i = INTEL_INT(i);
1223         return cfwrite(&i, sizeof(i), 1, file);
1224 }
1225
1226 int cfwrite_short(short s, CFILE *file)
1227 {
1228         s = INTEL_SHORT(s);
1229         return cfwrite(&s, sizeof(s), 1, file);
1230 }
1231
1232 int cfwrite_ushort(ushort s, CFILE *file)
1233 {
1234         s = INTEL_SHORT(s);
1235         return cfwrite(&s, sizeof(s), 1, file);
1236 }
1237
1238 int cfwrite_ubyte(ubyte b, CFILE *file)
1239 {
1240         return cfwrite(&b, sizeof(b), 1, file);
1241 }
1242
1243 int cfwrite_vector(vector *vec, CFILE *file)
1244 {
1245         if(!cfwrite_float(vec->xyz.x, file)){
1246                 return 0;
1247         }
1248         if(!cfwrite_float(vec->xyz.y, file)){
1249                 return 0;
1250         }
1251         return cfwrite_float(vec->xyz.z, file);
1252 }
1253
1254 int cfwrite_angles(angles *ang, CFILE *file)
1255 {
1256         if(!cfwrite_float(ang->p, file)){
1257                 return 0;
1258         }
1259         if(!cfwrite_float(ang->b, file)){
1260                 return 0;
1261         }
1262         return cfwrite_float(ang->h, file);
1263 }
1264
1265 int cfwrite_char(char b, CFILE *file)
1266 {
1267         return cfwrite( &b, sizeof(b), 1, file);
1268 }
1269
1270 int cfwrite_string(const char *buf, CFILE *file)
1271 {
1272         if ( (!buf) || (buf && !buf[0]) ) {
1273                 return cfwrite_char(0, file);
1274         } 
1275         int len = strlen(buf);
1276         if(!cfwrite(buf, len, 1, file)){
1277                 return 0;
1278         }
1279         return cfwrite_char(0, file);                   // write out NULL termination                   
1280 }
1281
1282 int cfwrite_string_len(const char *buf, CFILE *file)
1283 {
1284         int len = strlen(buf);
1285
1286         if(!cfwrite_int(len, file)){
1287                 return 0;
1288         }
1289         if (len){
1290                 return cfwrite(buf,len,1,file);
1291         } 
1292
1293         return 1;
1294 }
1295
1296 // Get the filelength
1297 int cfilelength( CFILE * cfile )
1298 {
1299         SDL_assert(cfile != NULL);
1300         Cfile_block *cb;
1301         SDL_assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1302         cb = &Cfile_block_list[cfile->id];      
1303
1304         // TODO: return length of memory mapped file
1305         SDL_assert( !cb->data );
1306
1307         SDL_assert(cb->fp != NULL);
1308
1309         // cb->size gets set at cfopen
1310         return cb->size;
1311 }
1312
1313 // cfwrite() writes to the file
1314 //
1315 // returns:   number of full elements actually written
1316 //            
1317 //
1318 int cfwrite(const void *buf, int elsize, int nelem, CFILE *cfile)
1319 {
1320         SDL_assert(cfile != NULL);
1321         SDL_assert(buf != NULL);
1322         SDL_assert(elsize > 0);
1323         SDL_assert(nelem > 0);
1324
1325         Cfile_block *cb;
1326         SDL_assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1327         cb = &Cfile_block_list[cfile->id];      
1328
1329         int size = elsize * nelem;
1330
1331         // cfwrite() not supported for memory-mapped files
1332         SDL_assert( !cb->data );
1333
1334         SDL_assert(cb->fp != NULL);
1335         SDL_assert(cb->lib_offset == 0 );
1336         int bytes_written = fwrite( buf, 1, size, cb->fp );
1337
1338         if (bytes_written > 0) {
1339                 cb->raw_position += bytes_written;
1340         }
1341
1342         #if defined(CHECK_POSITION) && !defined(NDEBUG)
1343                 int tmp_offset = ftell(cb->fp) - cb->lib_offset;
1344                 SDL_assert(tmp_offset == cb->raw_position);
1345         #endif
1346
1347         return bytes_written / elsize;
1348 }
1349
1350
1351 // cfputc() writes a character to a file
1352 //
1353 // returns:   success ==> returns character written
1354 //                                error   ==> EOF
1355 //
1356 int cfputc(int c, CFILE *cfile)
1357 {
1358         int result = 0;
1359
1360         SDL_assert(cfile != NULL);
1361         Cfile_block *cb;
1362         SDL_assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1363         cb = &Cfile_block_list[cfile->id];      
1364
1365         // cfputc() not supported for memory-mapped files
1366         SDL_assert( !cb->data );
1367
1368         SDL_assert(cb->fp != NULL);
1369         result = fputc(c, cb->fp);
1370
1371         return result;  
1372 }
1373
1374
1375 // cfgetc() reads a character from a file
1376 //
1377 // returns:   success ==> returns character read
1378 //                                error   ==> EOF
1379 //
1380 int cfgetc(CFILE *cfile)
1381 {
1382         SDL_assert(cfile != NULL);
1383         
1384         char tmp;
1385
1386         int result = cfread(&tmp, 1, 1, cfile );
1387         if ( result == 1 )      {
1388                 result = char(tmp);
1389         } else {
1390                 result = CF_EOF;
1391         }
1392
1393         return result;  
1394 }
1395
1396
1397
1398
1399
1400 // cfgets() reads a string from a file
1401 //
1402 // returns:   success ==> returns pointer to string
1403 //                                error   ==> NULL
1404 //
1405 char *cfgets(char *buf, int n, CFILE *cfile)
1406 {
1407         SDL_assert(cfile != NULL);
1408         SDL_assert(buf != NULL);
1409         SDL_assert(n > 0 );
1410
1411         char * t = buf;
1412         int i, c;
1413
1414         for (i=0; i<n-1; i++ )  {
1415                 do {
1416                         char tmp_c;
1417
1418                         int ret = cfread( &tmp_c, 1, 1, cfile );
1419                         if ( ret != 1 ) {
1420                                 *buf = 0;
1421                                 if ( buf > t )  {               
1422                                         return t;
1423                                 } else {
1424                                         return NULL;
1425                                 }
1426                         }
1427                         c = int(tmp_c);
1428                 } while ( c == 13 );
1429                 *buf++ = char(c);
1430                 if ( c=='\n' ) break;
1431         }
1432         *buf++ = 0;
1433
1434         return  t;
1435 }
1436
1437 // cfputs() writes a string to a file
1438 //
1439 // returns:   success ==> non-negative value
1440 //                                error   ==> EOF
1441 //
1442 int cfputs(const char *str, CFILE *cfile)
1443 {
1444         SDL_assert(cfile != NULL);
1445         SDL_assert(str != NULL);
1446
1447         Cfile_block *cb;
1448         SDL_assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1449         cb = &Cfile_block_list[cfile->id];      
1450
1451         int result = 0;
1452
1453         // cfputs() not supported for memory-mapped files
1454         SDL_assert( !cb->data );
1455         SDL_assert(cb->fp != NULL);
1456         result = fputs(str, cb->fp);
1457
1458         return result;  
1459 }
1460
1461
1462 // 16 and 32 bit checksum stuff ----------------------------------------------------------
1463
1464 // CRC code for mission validation.  given to us by Kevin Bentley on 7/20/98.   Some sort of
1465 // checksumming code that he wrote a while ago.  
1466 #define CRC32_POLYNOMIAL                                        0xEDB88320L
1467 unsigned long CRCTable[256];
1468
1469 #define CF_CHKSUM_SAMPLE_SIZE                           512
1470
1471 // update cur_chksum with the chksum of the new_data of size new_data_size
1472 ushort cf_add_chksum_short(ushort seed, const char *buffer, int size)
1473 {
1474         const ubyte * ptr = (const ubyte *)buffer;
1475         unsigned int sum1,sum2;
1476
1477         sum1 = sum2 = (int)(seed);
1478
1479         while(size--)   {
1480                 sum1 += *ptr++;
1481                 if (sum1 >= 255 ) sum1 -= 255;
1482                 sum2 += sum1;
1483         }
1484         sum2 %= 255;
1485         
1486         return (unsigned short)((sum1<<8)+ sum2);
1487 }
1488
1489 // update cur_chksum with the chksum of the new_data of size new_data_size
1490 unsigned long cf_add_chksum_long(unsigned long seed, const char *buffer, int size)
1491 {
1492         unsigned long crc;
1493         unsigned const char *p;
1494         unsigned long temp1;
1495         unsigned long temp2;
1496
1497         p = (unsigned const char*)buffer;
1498         crc = seed;     
1499
1500         while (size--!=0){
1501           temp1 = (crc>>8)&0x00FFFFFFL;
1502           temp2 = CRCTable[((int)crc^*p++)&0xff];
1503           crc = temp1^temp2;
1504         }       
1505         
1506         return crc;
1507 }
1508
1509 void cf_chksum_long_init()
1510 {
1511         int i,j;
1512         unsigned long crc;      
1513
1514         for( i=0;i<=255;i++) {
1515                 crc=i;
1516                 for(j=8;j>0;j--) {
1517                         if(crc&1)
1518                                  crc=(crc>>1)^CRC32_POLYNOMIAL;
1519                         else
1520                                  crc>>=1;
1521                 }
1522                 CRCTable[i]=crc;
1523         }       
1524 }
1525
1526 // single function convenient to use for both short and long checksums
1527 // NOTE : only one of chk_short or chk_long must be non-NULL (indicating which checksum to perform)
1528 int cf_chksum_do(CFILE *cfile, ushort *chk_short, uint *chk_long, int max_size)
1529 {
1530         char cf_buffer[CF_CHKSUM_SAMPLE_SIZE];
1531         int is_long;
1532         int cf_len = 0;
1533         int cf_total;
1534         int read_size;
1535
1536         // determine whether we're doing a short or long checksum
1537         is_long = 0;
1538         if(chk_short){
1539                 SDL_assert(!chk_long);          
1540                 *chk_short = 0;
1541         } else {
1542                 SDL_assert(chk_long);
1543                 is_long = 1;
1544                 *chk_long = 0;
1545         }
1546
1547         // if max_size is -1, set it to be the size of the file
1548         if(max_size < 0){
1549                 cfseek(cfile, 0, SEEK_SET);
1550                 max_size = cfilelength(cfile);
1551         }
1552         
1553         cf_total = 0;
1554         do {
1555                 // determine how much we want to read
1556                 if((max_size - cf_total) >= CF_CHKSUM_SAMPLE_SIZE){
1557                         read_size = CF_CHKSUM_SAMPLE_SIZE;
1558                 } else {
1559                         read_size = max_size - cf_total;
1560                 }
1561
1562                 // read in some buffer
1563                 cf_len = cfread(cf_buffer, 1, read_size, cfile);
1564
1565                 // total we've read so far
1566                 cf_total += cf_len;
1567
1568                 // add the checksum
1569                 if(cf_len > 0){
1570                         // do the proper short or long checksum
1571                         if(is_long){
1572                                 *chk_long = cf_add_chksum_long(*chk_long, cf_buffer, cf_len);
1573                         } else {
1574                                 *chk_short = cf_add_chksum_short(*chk_short, cf_buffer, cf_len);
1575                         }
1576                 }
1577         } while((cf_len > 0) && (cf_total < max_size));
1578
1579         return 1;
1580 }
1581
1582 // get the 2 byte checksum of the passed filename - return 0 if operation failed, 1 if succeeded
1583 int cf_chksum_short(const char *filename, ushort *chksum, int max_size, int cf_type)
1584 {
1585         int ret_val;
1586         CFILE *cfile = NULL;            
1587         
1588         // zero the checksum
1589         *chksum = 0;
1590
1591         // attempt to open the file
1592         cfile = cfopen(filename,"rt",CFILE_NORMAL,cf_type);
1593         if(cfile == NULL){              
1594                 return 0;
1595         }
1596         
1597         // call the overloaded cf_chksum function()
1598         ret_val = cf_chksum_do(cfile, chksum, NULL, max_size);
1599
1600         // close the file down
1601         cfclose(cfile);
1602         cfile = NULL;
1603
1604         // return the result
1605         return ret_val;
1606 }
1607
1608 // get the 2 byte checksum of the passed file - return 0 if operation failed, 1 if succeeded
1609 // NOTE : preserves current file position
1610 int cf_chksum_short(CFILE *file, ushort *chksum, int max_size)
1611 {
1612         int ret_code;
1613         int start_pos;
1614         
1615         // Returns current position of file.
1616         start_pos = cftell(file);
1617         if(start_pos == -1){
1618                 return 0;
1619         }
1620         
1621         // move to the beginning of the file
1622         if(cfseek(file, 0, CF_SEEK_SET)){
1623                 return 0;
1624         }
1625         ret_code = cf_chksum_do(file, chksum, NULL, max_size);
1626         // move back to the start position
1627         cfseek(file, start_pos, CF_SEEK_SET);
1628
1629         return ret_code;
1630 }
1631
1632 // get the 32 bit CRC checksum of the passed filename - return 0 if operation failed, 1 if succeeded
1633 int cf_chksum_long(const char *filename, uint *chksum, int max_size, int cf_type)
1634 {
1635         int ret_val;
1636         CFILE *cfile = NULL;            
1637         
1638         // zero the checksum
1639         *chksum = 0;
1640
1641         // attempt to open the file
1642         cfile = cfopen(filename,"rt",CFILE_NORMAL,cf_type);
1643         if(cfile == NULL){              
1644                 return 0;
1645         }
1646         
1647         // call the overloaded cf_chksum function()
1648         ret_val = cf_chksum_do(cfile, NULL, chksum, max_size);
1649
1650         // close the file down
1651         cfclose(cfile);
1652         cfile = NULL;
1653
1654         // return the result
1655         return ret_val; 
1656 }
1657
1658 // get the 32 bit CRC checksum of the passed file - return 0 if operation failed, 1 if succeeded
1659 // NOTE : preserves current file position
1660 int cf_chksum_long(CFILE *file, uint *chksum, int max_size)
1661 {
1662         int ret_code;
1663         int start_pos;
1664         
1665         // Returns current position of file.
1666         start_pos = cftell(file);
1667         if(start_pos == -1){
1668                 return 0;
1669         }
1670         
1671         // move to the beginning of the file
1672         if(cfseek(file, 0, CF_SEEK_SET)){
1673                 return 0;
1674         }
1675         ret_code = cf_chksum_do(file, NULL, chksum, max_size);
1676         // move back to the start position
1677         cfseek(file, start_pos, CF_SEEK_SET);
1678
1679         return ret_code;
1680 }
1681
1682
1683 // Flush the open file buffer
1684 //
1685 // exit: 0 - success
1686 //                      1 - failure
1687 int cflush(CFILE *cfile)
1688 {
1689         SDL_assert(cfile != NULL);
1690         Cfile_block *cb;
1691         SDL_assert(cfile->id >= 0 && cfile->id < MAX_CFILE_BLOCKS);
1692         cb = &Cfile_block_list[cfile->id];      
1693
1694         // not supported for memory mapped files
1695         SDL_assert( !cb->data );
1696
1697         SDL_assert(cb->fp != NULL);
1698         return fflush(cb->fp);
1699 }
1700
1701 // fill in Cfile_root_dir[] and Cfile_user_dir[]
1702 // this can be called at any time, even before cfile_init()
1703 //  returns: non-zero on error
1704 int cfile_init_paths()
1705 {
1706         if ( strlen(Cfile_root_dir) && strlen(Cfile_user_dir) ) {
1707                 return 0;
1708         }
1709
1710         char *t_path = SDL_GetBasePath();
1711
1712         // make sure we have something
1713         if (t_path == NULL) {
1714                 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Error trying to determine executable directory!", NULL);
1715                 return 1;
1716         }
1717
1718         // size check
1719         if ( strlen(t_path) >= CFILE_ROOT_DIRECTORY_LEN ) {
1720                 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Executable path is too long!", NULL);
1721                 return 1;
1722         }
1723
1724         // set root directory
1725         strcpy(Cfile_root_dir, t_path);
1726         // free SDL copy
1727         SDL_free(t_path);
1728         t_path = NULL;
1729
1730         // are we in a root directory?
1731         if ( cfile_in_root_dir(Cfile_root_dir) ) {
1732                 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Freespace2/Fred2 cannot be run from a drive root directory!", NULL);
1733                 return 1;
1734         }
1735
1736         // now for the user/pref directory, the writable location
1737         char *u_path = SDL_GetPrefPath(Osreg_company_name, Osreg_title);
1738
1739         // make sure we have something
1740         if (u_path == NULL) {
1741                 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Error trying to determine preferences directory!", NULL);
1742                 return 1;
1743         }
1744
1745         // size check
1746         if ( strlen(u_path) >= CFILE_ROOT_DIRECTORY_LEN ) {
1747                 SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", "Preferences path is too long!", NULL);
1748                 return 1;
1749         }
1750
1751         // set user/pref directory
1752         strcpy(Cfile_user_dir, u_path);
1753         // free SDL copy
1754         SDL_free(u_path);
1755         u_path = NULL;
1756
1757         return 0;
1758 }