2 Copyright (c) 2001, Loki software, inc.
5 Redistribution and use in source and binary forms, with or without modification,
6 are permitted provided that the following conditions are met:
8 Redistributions of source code must retain the above copyright notice, this list
9 of conditions and the following disclaimer.
11 Redistributions in binary form must reproduce the above copyright notice, this
12 list of conditions and the following disclaimer in the documentation and/or
13 other materials provided with the distribution.
15 Neither the name of Loki software nor the names of its contributors may be used
16 to endorse or promote products derived from this software without specific prior
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
23 DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 // - Directories should be searched in the following order: ~/.q3a/baseq3,
35 // install dir (/usr/local/games/quake3/baseq3) and cd_path (/mnt/cdrom/baseq3).
37 // - Pak files are searched first inside the directories.
38 // - Case insensitive.
39 // - Unix-style slashes (/) (windows is backwards .. everyone knows that)
41 // Leonardo Zide (leo@lokigames.com)
48 #include <glib/gslist.h>
49 #include <glib/gdir.h>
50 #include <glib/gstrfuncs.h>
52 #include "qerplugin.h"
53 #include "idatastream.h"
55 ArchiveModules& FileSystemQ3API_getArchiveModules();
56 #include "ifilesystem.h"
58 #include "generic/callback.h"
59 #include "string/string.h"
60 #include "stream/stringstream.h"
62 #include "moduleobservers.h"
65 #define VFS_MAXDIRS 64
71 #define gamemode_get GlobalRadiant().getGameMode
75 // =============================================================================
78 Archive* OpenArchive(const char* name);
80 struct archive_entry_t
89 typedef std::list<archive_entry_t> archives_t;
91 static archives_t g_archives;
92 static char g_strDirs[VFS_MAXDIRS][PATH_MAX+1];
94 static bool g_bUsePak = true;
96 ModuleObservers g_observers;
98 // =============================================================================
101 static void AddSlash (char *str)
103 std::size_t n = strlen (str);
106 if (str[n-1] != '\\' && str[n-1] != '/')
108 globalErrorStream() << "WARNING: directory path does not end with separator: " << str << "\n";
114 static void FixDOSName (char *src)
116 if (src == 0 || strchr(src, '\\') == 0)
119 globalErrorStream() << "WARNING: invalid path separator '\\': " << src << "\n";
131 const _QERArchiveTable* GetArchiveTable(ArchiveModules& archiveModules, const char* ext)
133 StringOutputStream tmp(16);
134 tmp << LowerCase(ext);
135 return archiveModules.findModule(tmp.c_str());
137 static void InitPakFile (ArchiveModules& archiveModules, const char *filename)
139 const _QERArchiveTable* table = GetArchiveTable(archiveModules, path_get_extension(filename));
143 archive_entry_t entry;
144 entry.name = filename;
146 entry.archive = table->m_pfnOpenArchive(filename);
147 entry.is_pakfile = true;
148 g_archives.push_back(entry);
149 globalOutputStream() << " pak file: " << filename << "\n";
153 inline void pathlist_prepend_unique(GSList*& pathlist, char* path)
155 if(g_slist_find_custom(pathlist, path, (GCompareFunc)path_compare) == 0)
157 pathlist = g_slist_prepend(pathlist, path);
165 class DirectoryListVisitor : public Archive::Visitor
168 const char* m_directory;
170 DirectoryListVisitor(GSList*& matches, const char* directory)
171 : m_matches(matches), m_directory(directory)
173 void visit(const char* name)
175 const char* subname = path_make_relative(name, m_directory);
178 if(subname[0] == '/')
180 char* dir = g_strdup(subname);
181 char* last_char = dir + strlen(dir);
182 if(last_char != dir && *(--last_char) == '/')
184 pathlist_prepend_unique(m_matches, dir);
189 class FileListVisitor : public Archive::Visitor
192 const char* m_directory;
193 const char* m_extension;
195 FileListVisitor(GSList*& matches, const char* directory, const char* extension)
196 : m_matches(matches), m_directory(directory), m_extension(extension)
198 void visit(const char* name)
200 const char* subname = path_make_relative(name, m_directory);
203 if(subname[0] == '/')
205 if(m_extension[0] == '*' || extension_equal(path_get_extension(subname), m_extension))
206 pathlist_prepend_unique(m_matches, g_strdup (subname));
211 static GSList* GetListInternal (const char *refdir, const char *ext, bool directories, std::size_t depth)
215 ASSERT_MESSAGE(refdir[strlen(refdir) - 1] == '/', "search path does not end in '/'");
219 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
221 DirectoryListVisitor visitor(files, refdir);
222 (*i).archive->forEachFile(Archive::VisitorFunc(visitor, Archive::eDirectories, depth), refdir);
227 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
229 FileListVisitor visitor(files, refdir, ext);
230 (*i).archive->forEachFile(Archive::VisitorFunc(visitor, Archive::eFiles, depth), refdir);
234 files = g_slist_reverse(files);
239 inline int ascii_to_upper(int c)
241 if (c >= 'a' && c <= 'z')
243 return c - ('a' - 'A');
249 This behaves identically to stricmp(a,b), except that ASCII chars
250 [\]^`_ come AFTER alphabet chars instead of before. This is because
251 it converts all alphabet chars to uppercase before comparison,
252 while stricmp converts them to lowercase.
254 static int string_compare_nocase_upper(const char* a, const char* b)
258 int c1 = ascii_to_upper(*a++);
259 int c2 = ascii_to_upper(*b++);
276 // Arnout: note - sort pakfiles in reverse order. This ensures that
277 // later pakfiles override earlier ones. This because the vfs module
278 // returns a filehandle to the first file it can find (while it should
279 // return the filehandle to the file in the most overriding pakfile, the
280 // last one in the list that is).
282 //!\todo Analyse the code in rtcw/q3 to see which order it sorts pak files.
286 bool operator()(const CopiedString& self, const CopiedString& other) const
288 return string_compare_nocase_upper(self.c_str(), other.c_str()) > 0;
292 typedef std::set<CopiedString, PakLess> Archives;
294 // =============================================================================
297 // reads all pak files from a dir
298 void InitDirectory(const char* directory, ArchiveModules& archiveModules)
300 if (g_numDirs == VFS_MAXDIRS)
303 strncpy(g_strDirs[g_numDirs], directory, PATH_MAX);
304 g_strDirs[g_numDirs][PATH_MAX] = '\0';
305 FixDOSName (g_strDirs[g_numDirs]);
306 AddSlash (g_strDirs[g_numDirs]);
308 const char* path = g_strDirs[g_numDirs];
313 archive_entry_t entry;
315 entry.archive = OpenArchive(path);
316 entry.is_pakfile = false;
317 g_archives.push_back(entry);
322 GDir* dir = g_dir_open (path, 0, 0);
326 globalOutputStream() << "vfs directory: " << path << "\n";
328 const char* ignore_prefix = "";
329 const char* override_prefix = "";
332 // See if we are in "sp" or "mp" mapping mode
333 const char* gamemode = gamemode_get();
335 if (strcmp (gamemode, "sp") == 0)
337 ignore_prefix = "mp_";
338 override_prefix = "sp_";
340 else if (strcmp (gamemode, "mp") == 0)
342 ignore_prefix = "sp_";
343 override_prefix = "mp_";
348 Archives archivesOverride;
351 const char* name = g_dir_read_name(dir);
355 const char *ext = strrchr (name, '.');
357 if(ext && !string_compare_nocase_upper(ext, ".pk3dir"))
359 if (g_numDirs == VFS_MAXDIRS)
361 snprintf(g_strDirs[g_numDirs], PATH_MAX, "%s%s/", path, name);
362 g_strDirs[g_numDirs][PATH_MAX] = '\0';
363 FixDOSName (g_strDirs[g_numDirs]);
364 AddSlash (g_strDirs[g_numDirs]);
368 archive_entry_t entry;
369 entry.name = g_strDirs[g_numDirs-1];
370 entry.archive = OpenArchive(g_strDirs[g_numDirs-1]);
371 entry.is_pakfile = false;
372 g_archives.push_back(entry);
376 if ((ext == 0) || *(++ext) == '\0' || GetArchiveTable(archiveModules, ext) == 0)
379 // using the same kludge as in engine to ensure consistency
380 if(!string_empty(ignore_prefix) && strncmp(name, ignore_prefix, strlen(ignore_prefix)) == 0)
384 if(!string_empty(override_prefix) && strncmp(name, override_prefix, strlen(override_prefix)) == 0)
386 archivesOverride.insert(name);
390 archives.insert(name);
395 // add the entries to the vfs
396 for(Archives::iterator i = archivesOverride.begin(); i != archivesOverride.end(); ++i)
398 char filename[PATH_MAX];
399 strcpy(filename, path);
400 strcat(filename, (*i).c_str());
401 InitPakFile(archiveModules, filename);
403 for(Archives::iterator i = archives.begin(); i != archives.end(); ++i)
405 char filename[PATH_MAX];
406 strcpy(filename, path);
407 strcat(filename, (*i).c_str());
408 InitPakFile(archiveModules, filename);
413 globalErrorStream() << "vfs directory not found: " << path << "\n";
418 // frees all memory that we allocated
419 // FIXME TTimo this should be improved so that we can shutdown and restart the VFS without exiting Radiant?
420 // (for instance when modifying the project settings)
423 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
425 (*i).archive->release();
432 #define VFS_SEARCH_PAK 0x1
433 #define VFS_SEARCH_DIR 0x2
435 int GetFileCount (const char *filename, int flag)
438 char fixed[PATH_MAX+1];
440 strncpy(fixed, filename, PATH_MAX);
441 fixed[PATH_MAX] = '\0';
445 flag = VFS_SEARCH_PAK | VFS_SEARCH_DIR;
447 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
449 if((*i).is_pakfile && (flag & VFS_SEARCH_PAK) != 0
450 || !(*i).is_pakfile && (flag & VFS_SEARCH_DIR) != 0)
452 if((*i).archive->containsFile(fixed))
460 ArchiveFile* OpenFile(const char* filename)
462 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
463 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
465 ArchiveFile* file = (*i).archive->openFile(filename);
475 ArchiveTextFile* OpenTextFile(const char* filename)
477 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
478 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
480 ArchiveTextFile* file = (*i).archive->openTextFile(filename);
490 // NOTE: when loading a file, you have to allocate one extra byte and set it to \0
491 std::size_t LoadFile (const char *filename, void **bufferptr, int index)
493 char fixed[PATH_MAX+1];
495 strncpy (fixed, filename, PATH_MAX);
496 fixed[PATH_MAX] = '\0';
499 ArchiveFile* file = OpenFile(fixed);
503 *bufferptr = malloc (file->size()+1);
504 // we need to end the buffer with a 0
505 ((char*) (*bufferptr))[file->size()] = 0;
507 std::size_t length = file->getInputStream().read((InputStream::byte_type*)*bufferptr, file->size());
516 void FreeFile (void *p)
521 GSList* GetFileList (const char *dir, const char *ext, std::size_t depth)
523 return GetListInternal (dir, ext, false, depth);
526 GSList* GetDirList (const char *dir, std::size_t depth)
528 return GetListInternal (dir, 0, true, depth);
531 void ClearFileDirList (GSList **lst)
535 g_free ((*lst)->data);
536 *lst = g_slist_remove (*lst, (*lst)->data);
540 const char* FindFile(const char* relative)
542 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
544 if((*i).archive->containsFile(relative))
546 return (*i).name.c_str();
553 const char* FindPath(const char* absolute)
555 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
557 if(path_equal_n(absolute, (*i).name.c_str(), string_length((*i).name.c_str())))
559 return (*i).name.c_str();
567 class Quake3FileSystem : public VirtualFileSystem
570 void initDirectory(const char *path)
572 InitDirectory(path, FileSystemQ3API_getArchiveModules());
576 globalOutputStream() << "filesystem initialised\n";
577 g_observers.realise();
581 g_observers.unrealise();
582 globalOutputStream() << "filesystem shutdown\n";
586 int getFileCount(const char *filename, int flags)
588 return GetFileCount(filename, flags);
590 ArchiveFile* openFile(const char* filename)
592 return OpenFile(filename);
594 ArchiveTextFile* openTextFile(const char* filename)
596 return OpenTextFile(filename);
598 std::size_t loadFile(const char *filename, void **buffer)
600 return LoadFile(filename, buffer, 0);
602 void freeFile(void *p)
607 void forEachDirectory(const char* basedir, const FileNameCallback& callback, std::size_t depth)
609 GSList* list = GetDirList(basedir, depth);
611 for(GSList* i = list; i != 0; i = g_slist_next(i))
613 callback(reinterpret_cast<const char*>((*i).data));
616 ClearFileDirList(&list);
618 void forEachFile(const char* basedir, const char* extension, const FileNameCallback& callback, std::size_t depth)
620 GSList* list = GetFileList(basedir, extension, depth);
622 for(GSList* i = list; i != 0; i = g_slist_next(i))
624 const char* name = reinterpret_cast<const char*>((*i).data);
625 if(extension_equal(path_get_extension(name), extension))
631 ClearFileDirList(&list);
633 GSList* getDirList(const char *basedir)
635 return GetDirList(basedir, 1);
637 GSList* getFileList(const char *basedir, const char *extension)
639 return GetFileList(basedir, extension, 1);
641 void clearFileDirList(GSList **lst)
643 ClearFileDirList(lst);
646 const char* findFile(const char *name)
648 return FindFile(name);
650 const char* findRoot(const char *name)
652 return FindPath(name);
655 void attach(ModuleObserver& observer)
657 g_observers.attach(observer);
659 void detach(ModuleObserver& observer)
661 g_observers.detach(observer);
664 Archive* getArchive(const char* archiveName, bool pakonly)
666 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
668 if(pakonly && !(*i).is_pakfile)
671 if(path_equal((*i).name.c_str(), archiveName))
676 void forEachArchive(const ArchiveNameCallback& callback, bool pakonly, bool reverse)
679 g_archives.reverse();
681 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
683 if(pakonly && !(*i).is_pakfile)
686 callback((*i).name.c_str());
690 g_archives.reverse();
694 Quake3FileSystem g_Quake3FileSystem;
696 void FileSystem_Init()
700 void FileSystem_Shutdown()
704 VirtualFileSystem& GetFileSystem()
706 return g_Quake3FileSystem;