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 char g_strForbiddenDirs[VFS_MAXDIRS][PATH_MAX+1];
95 static int g_numForbiddenDirs = 0;
96 static bool g_bUsePak = true;
98 ModuleObservers g_observers;
100 // =============================================================================
103 static void AddSlash (char *str)
105 std::size_t n = strlen (str);
108 if (str[n-1] != '\\' && str[n-1] != '/')
110 globalErrorStream() << "WARNING: directory path does not end with separator: " << str << "\n";
116 static void FixDOSName (char *src)
118 if (src == 0 || strchr(src, '\\') == 0)
121 globalErrorStream() << "WARNING: invalid path separator '\\': " << src << "\n";
133 const _QERArchiveTable* GetArchiveTable(ArchiveModules& archiveModules, const char* ext)
135 StringOutputStream tmp(16);
136 tmp << LowerCase(ext);
137 return archiveModules.findModule(tmp.c_str());
139 static void InitPakFile (ArchiveModules& archiveModules, const char *filename)
141 const _QERArchiveTable* table = GetArchiveTable(archiveModules, path_get_extension(filename));
145 archive_entry_t entry;
146 entry.name = filename;
148 entry.archive = table->m_pfnOpenArchive(filename);
149 entry.is_pakfile = true;
150 g_archives.push_back(entry);
151 globalOutputStream() << " pak file: " << filename << "\n";
155 inline void pathlist_prepend_unique(GSList*& pathlist, char* path)
157 if(g_slist_find_custom(pathlist, path, (GCompareFunc)path_compare) == 0)
159 pathlist = g_slist_prepend(pathlist, path);
167 class DirectoryListVisitor : public Archive::Visitor
170 const char* m_directory;
172 DirectoryListVisitor(GSList*& matches, const char* directory)
173 : m_matches(matches), m_directory(directory)
175 void visit(const char* name)
177 const char* subname = path_make_relative(name, m_directory);
180 if(subname[0] == '/')
182 char* dir = g_strdup(subname);
183 char* last_char = dir + strlen(dir);
184 if(last_char != dir && *(--last_char) == '/')
186 pathlist_prepend_unique(m_matches, dir);
191 class FileListVisitor : public Archive::Visitor
194 const char* m_directory;
195 const char* m_extension;
197 FileListVisitor(GSList*& matches, const char* directory, const char* extension)
198 : m_matches(matches), m_directory(directory), m_extension(extension)
200 void visit(const char* name)
202 const char* subname = path_make_relative(name, m_directory);
205 if(subname[0] == '/')
207 if(m_extension[0] == '*' || extension_equal(path_get_extension(subname), m_extension))
208 pathlist_prepend_unique(m_matches, g_strdup (subname));
213 static GSList* GetListInternal (const char *refdir, const char *ext, bool directories, std::size_t depth)
217 ASSERT_MESSAGE(refdir[strlen(refdir) - 1] == '/', "search path does not end in '/'");
221 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
223 DirectoryListVisitor visitor(files, refdir);
224 (*i).archive->forEachFile(Archive::VisitorFunc(visitor, Archive::eDirectories, depth), refdir);
229 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
231 FileListVisitor visitor(files, refdir, ext);
232 (*i).archive->forEachFile(Archive::VisitorFunc(visitor, Archive::eFiles, depth), refdir);
236 files = g_slist_reverse(files);
241 inline int ascii_to_upper(int c)
243 if (c >= 'a' && c <= 'z')
245 return c - ('a' - 'A');
251 This behaves identically to stricmp(a,b), except that ASCII chars
252 [\]^`_ come AFTER alphabet chars instead of before. This is because
253 it converts all alphabet chars to uppercase before comparison,
254 while stricmp converts them to lowercase.
256 static int string_compare_nocase_upper(const char* a, const char* b)
260 int c1 = ascii_to_upper(*a++);
261 int c2 = ascii_to_upper(*b++);
278 // Arnout: note - sort pakfiles in reverse order. This ensures that
279 // later pakfiles override earlier ones. This because the vfs module
280 // returns a filehandle to the first file it can find (while it should
281 // return the filehandle to the file in the most overriding pakfile, the
282 // last one in the list that is).
284 //!\todo Analyse the code in rtcw/q3 to see which order it sorts pak files.
288 bool operator()(const CopiedString& self, const CopiedString& other) const
290 return string_compare_nocase_upper(self.c_str(), other.c_str()) > 0;
294 typedef std::set<CopiedString, PakLess> Archives;
296 // =============================================================================
299 // reads all pak files from a dir
300 void InitDirectory(const char* directory, ArchiveModules& archiveModules)
304 g_numForbiddenDirs = 0;
305 StringTokeniser st(GlobalRadiant().getGameDescriptionKeyValue("forbidden_paths"), " ");
306 for(j = 0; j < VFS_MAXDIRS; ++j)
308 const char *t = st.getToken();
311 strncpy(g_strForbiddenDirs[g_numForbiddenDirs], t, PATH_MAX);
312 g_strForbiddenDirs[g_numForbiddenDirs][PATH_MAX] = '\0';
313 ++g_numForbiddenDirs;
316 for(j = 0; j < g_numForbiddenDirs; ++j)
318 if(!string_compare_nocase_upper(directory, g_strForbiddenDirs[j])
319 || (string_length(directory) > string_length(g_strForbiddenDirs[j]) && directory[string_length(directory) - string_length(g_strForbiddenDirs[j]) - 1] == '/' && !string_compare_nocase_upper(directory + string_length(directory) - string_length(g_strForbiddenDirs[j]), g_strForbiddenDirs[j])))
322 if(j < g_numForbiddenDirs)
325 if (g_numDirs == VFS_MAXDIRS)
328 strncpy(g_strDirs[g_numDirs], directory, PATH_MAX);
329 g_strDirs[g_numDirs][PATH_MAX] = '\0';
330 FixDOSName (g_strDirs[g_numDirs]);
331 AddSlash (g_strDirs[g_numDirs]);
333 const char* path = g_strDirs[g_numDirs];
338 archive_entry_t entry;
340 entry.archive = OpenArchive(path);
341 entry.is_pakfile = false;
342 g_archives.push_back(entry);
347 GDir* dir = g_dir_open (path, 0, 0);
351 globalOutputStream() << "vfs directory: " << path << "\n";
353 const char* ignore_prefix = "";
354 const char* override_prefix = "";
357 // See if we are in "sp" or "mp" mapping mode
358 const char* gamemode = gamemode_get();
360 if (strcmp (gamemode, "sp") == 0)
362 ignore_prefix = "mp_";
363 override_prefix = "sp_";
365 else if (strcmp (gamemode, "mp") == 0)
367 ignore_prefix = "sp_";
368 override_prefix = "mp_";
373 Archives archivesOverride;
376 const char* name = g_dir_read_name(dir);
380 for(j = 0; j < g_numForbiddenDirs; ++j)
381 if(!string_compare_nocase_upper(name, g_strForbiddenDirs[j]))
383 if(j < g_numForbiddenDirs)
386 const char *ext = strrchr (name, '.');
388 if(ext && !string_compare_nocase_upper(ext, ".pk3dir"))
390 if (g_numDirs == VFS_MAXDIRS)
392 snprintf(g_strDirs[g_numDirs], PATH_MAX, "%s%s/", path, name);
393 g_strDirs[g_numDirs][PATH_MAX] = '\0';
394 FixDOSName (g_strDirs[g_numDirs]);
395 AddSlash (g_strDirs[g_numDirs]);
399 archive_entry_t entry;
400 entry.name = g_strDirs[g_numDirs-1];
401 entry.archive = OpenArchive(g_strDirs[g_numDirs-1]);
402 entry.is_pakfile = false;
403 g_archives.push_back(entry);
407 if ((ext == 0) || *(++ext) == '\0' || GetArchiveTable(archiveModules, ext) == 0)
410 // using the same kludge as in engine to ensure consistency
411 if(!string_empty(ignore_prefix) && strncmp(name, ignore_prefix, strlen(ignore_prefix)) == 0)
415 if(!string_empty(override_prefix) && strncmp(name, override_prefix, strlen(override_prefix)) == 0)
417 archivesOverride.insert(name);
421 archives.insert(name);
426 // add the entries to the vfs
427 for(Archives::iterator i = archivesOverride.begin(); i != archivesOverride.end(); ++i)
429 char filename[PATH_MAX];
430 strcpy(filename, path);
431 strcat(filename, (*i).c_str());
432 InitPakFile(archiveModules, filename);
434 for(Archives::iterator i = archives.begin(); i != archives.end(); ++i)
436 char filename[PATH_MAX];
437 strcpy(filename, path);
438 strcat(filename, (*i).c_str());
439 InitPakFile(archiveModules, filename);
444 globalErrorStream() << "vfs directory not found: " << path << "\n";
449 // frees all memory that we allocated
450 // FIXME TTimo this should be improved so that we can shutdown and restart the VFS without exiting Radiant?
451 // (for instance when modifying the project settings)
454 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
456 (*i).archive->release();
461 g_numForbiddenDirs = 0;
464 #define VFS_SEARCH_PAK 0x1
465 #define VFS_SEARCH_DIR 0x2
467 int GetFileCount (const char *filename, int flag)
470 char fixed[PATH_MAX+1];
472 strncpy(fixed, filename, PATH_MAX);
473 fixed[PATH_MAX] = '\0';
477 flag = VFS_SEARCH_PAK | VFS_SEARCH_DIR;
479 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
481 if((*i).is_pakfile && (flag & VFS_SEARCH_PAK) != 0
482 || !(*i).is_pakfile && (flag & VFS_SEARCH_DIR) != 0)
484 if((*i).archive->containsFile(fixed))
492 ArchiveFile* OpenFile(const char* filename)
494 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
495 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
497 ArchiveFile* file = (*i).archive->openFile(filename);
507 ArchiveTextFile* OpenTextFile(const char* filename)
509 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
510 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
512 ArchiveTextFile* file = (*i).archive->openTextFile(filename);
522 // NOTE: when loading a file, you have to allocate one extra byte and set it to \0
523 std::size_t LoadFile (const char *filename, void **bufferptr, int index)
525 char fixed[PATH_MAX+1];
527 strncpy (fixed, filename, PATH_MAX);
528 fixed[PATH_MAX] = '\0';
531 ArchiveFile* file = OpenFile(fixed);
535 *bufferptr = malloc (file->size()+1);
536 // we need to end the buffer with a 0
537 ((char*) (*bufferptr))[file->size()] = 0;
539 std::size_t length = file->getInputStream().read((InputStream::byte_type*)*bufferptr, file->size());
548 void FreeFile (void *p)
553 GSList* GetFileList (const char *dir, const char *ext, std::size_t depth)
555 return GetListInternal (dir, ext, false, depth);
558 GSList* GetDirList (const char *dir, std::size_t depth)
560 return GetListInternal (dir, 0, true, depth);
563 void ClearFileDirList (GSList **lst)
567 g_free ((*lst)->data);
568 *lst = g_slist_remove (*lst, (*lst)->data);
572 const char* FindFile(const char* relative)
574 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
576 if((*i).archive->containsFile(relative))
578 return (*i).name.c_str();
585 const char* FindPath(const char* absolute)
587 const char *best = "";
588 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
590 if(string_length((*i).name.c_str()) > string_length(best))
591 if(path_equal_n(absolute, (*i).name.c_str(), string_length((*i).name.c_str())))
592 best = (*i).name.c_str();
599 class Quake3FileSystem : public VirtualFileSystem
602 void initDirectory(const char *path)
604 InitDirectory(path, FileSystemQ3API_getArchiveModules());
608 globalOutputStream() << "filesystem initialised\n";
609 g_observers.realise();
613 g_observers.unrealise();
614 globalOutputStream() << "filesystem shutdown\n";
618 int getFileCount(const char *filename, int flags)
620 return GetFileCount(filename, flags);
622 ArchiveFile* openFile(const char* filename)
624 return OpenFile(filename);
626 ArchiveTextFile* openTextFile(const char* filename)
628 return OpenTextFile(filename);
630 std::size_t loadFile(const char *filename, void **buffer)
632 return LoadFile(filename, buffer, 0);
634 void freeFile(void *p)
639 void forEachDirectory(const char* basedir, const FileNameCallback& callback, std::size_t depth)
641 GSList* list = GetDirList(basedir, depth);
643 for(GSList* i = list; i != 0; i = g_slist_next(i))
645 callback(reinterpret_cast<const char*>((*i).data));
648 ClearFileDirList(&list);
650 void forEachFile(const char* basedir, const char* extension, const FileNameCallback& callback, std::size_t depth)
652 GSList* list = GetFileList(basedir, extension, depth);
654 for(GSList* i = list; i != 0; i = g_slist_next(i))
656 const char* name = reinterpret_cast<const char*>((*i).data);
657 if(extension_equal(path_get_extension(name), extension))
663 ClearFileDirList(&list);
665 GSList* getDirList(const char *basedir)
667 return GetDirList(basedir, 1);
669 GSList* getFileList(const char *basedir, const char *extension)
671 return GetFileList(basedir, extension, 1);
673 void clearFileDirList(GSList **lst)
675 ClearFileDirList(lst);
678 const char* findFile(const char *name)
680 return FindFile(name);
682 const char* findRoot(const char *name)
684 return FindPath(name);
687 void attach(ModuleObserver& observer)
689 g_observers.attach(observer);
691 void detach(ModuleObserver& observer)
693 g_observers.detach(observer);
696 Archive* getArchive(const char* archiveName, bool pakonly)
698 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
700 if(pakonly && !(*i).is_pakfile)
703 if(path_equal((*i).name.c_str(), archiveName))
708 void forEachArchive(const ArchiveNameCallback& callback, bool pakonly, bool reverse)
711 g_archives.reverse();
713 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
715 if(pakonly && !(*i).is_pakfile)
718 callback((*i).name.c_str());
722 g_archives.reverse();
726 Quake3FileSystem g_Quake3FileSystem;
728 void FileSystem_Init()
732 void FileSystem_Shutdown()
736 VirtualFileSystem& GetFileSystem()
738 return g_Quake3FileSystem;