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 printf("match against %s?\n", g_strForbiddenDirs[j]);
319 if(!string_compare_nocase_upper(directory, g_strForbiddenDirs[j])
320 || (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 printf("not matched\n");
324 if(j < g_numForbiddenDirs)
326 printf("Directory %s matched by forbidden dirs, removed\n", directory);
330 if (g_numDirs == VFS_MAXDIRS)
333 strncpy(g_strDirs[g_numDirs], directory, PATH_MAX);
334 g_strDirs[g_numDirs][PATH_MAX] = '\0';
335 FixDOSName (g_strDirs[g_numDirs]);
336 AddSlash (g_strDirs[g_numDirs]);
338 const char* path = g_strDirs[g_numDirs];
343 archive_entry_t entry;
345 entry.archive = OpenArchive(path);
346 entry.is_pakfile = false;
347 g_archives.push_back(entry);
352 GDir* dir = g_dir_open (path, 0, 0);
356 globalOutputStream() << "vfs directory: " << path << "\n";
358 const char* ignore_prefix = "";
359 const char* override_prefix = "";
362 // See if we are in "sp" or "mp" mapping mode
363 const char* gamemode = gamemode_get();
365 if (strcmp (gamemode, "sp") == 0)
367 ignore_prefix = "mp_";
368 override_prefix = "sp_";
370 else if (strcmp (gamemode, "mp") == 0)
372 ignore_prefix = "sp_";
373 override_prefix = "mp_";
378 Archives archivesOverride;
381 const char* name = g_dir_read_name(dir);
385 for(j = 0; j < g_numForbiddenDirs; ++j)
386 if(!string_compare_nocase_upper(name, g_strForbiddenDirs[j]))
388 if(j < g_numForbiddenDirs)
391 const char *ext = strrchr (name, '.');
393 if(ext && !string_compare_nocase_upper(ext, ".pk3dir"))
395 if (g_numDirs == VFS_MAXDIRS)
397 snprintf(g_strDirs[g_numDirs], PATH_MAX, "%s%s/", path, name);
398 g_strDirs[g_numDirs][PATH_MAX] = '\0';
399 FixDOSName (g_strDirs[g_numDirs]);
400 AddSlash (g_strDirs[g_numDirs]);
404 archive_entry_t entry;
405 entry.name = g_strDirs[g_numDirs-1];
406 entry.archive = OpenArchive(g_strDirs[g_numDirs-1]);
407 entry.is_pakfile = false;
408 g_archives.push_back(entry);
412 if ((ext == 0) || *(++ext) == '\0' || GetArchiveTable(archiveModules, ext) == 0)
415 // using the same kludge as in engine to ensure consistency
416 if(!string_empty(ignore_prefix) && strncmp(name, ignore_prefix, strlen(ignore_prefix)) == 0)
420 if(!string_empty(override_prefix) && strncmp(name, override_prefix, strlen(override_prefix)) == 0)
422 archivesOverride.insert(name);
426 archives.insert(name);
431 // add the entries to the vfs
432 for(Archives::iterator i = archivesOverride.begin(); i != archivesOverride.end(); ++i)
434 char filename[PATH_MAX];
435 strcpy(filename, path);
436 strcat(filename, (*i).c_str());
437 InitPakFile(archiveModules, filename);
439 for(Archives::iterator i = archives.begin(); i != archives.end(); ++i)
441 char filename[PATH_MAX];
442 strcpy(filename, path);
443 strcat(filename, (*i).c_str());
444 InitPakFile(archiveModules, filename);
449 globalErrorStream() << "vfs directory not found: " << path << "\n";
454 // frees all memory that we allocated
455 // FIXME TTimo this should be improved so that we can shutdown and restart the VFS without exiting Radiant?
456 // (for instance when modifying the project settings)
459 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
461 (*i).archive->release();
466 g_numForbiddenDirs = 0;
469 #define VFS_SEARCH_PAK 0x1
470 #define VFS_SEARCH_DIR 0x2
472 int GetFileCount (const char *filename, int flag)
475 char fixed[PATH_MAX+1];
477 strncpy(fixed, filename, PATH_MAX);
478 fixed[PATH_MAX] = '\0';
482 flag = VFS_SEARCH_PAK | VFS_SEARCH_DIR;
484 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
486 if((*i).is_pakfile && (flag & VFS_SEARCH_PAK) != 0
487 || !(*i).is_pakfile && (flag & VFS_SEARCH_DIR) != 0)
489 if((*i).archive->containsFile(fixed))
497 ArchiveFile* OpenFile(const char* filename)
499 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
500 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
502 ArchiveFile* file = (*i).archive->openFile(filename);
512 ArchiveTextFile* OpenTextFile(const char* filename)
514 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
515 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
517 ArchiveTextFile* file = (*i).archive->openTextFile(filename);
527 // NOTE: when loading a file, you have to allocate one extra byte and set it to \0
528 std::size_t LoadFile (const char *filename, void **bufferptr, int index)
530 char fixed[PATH_MAX+1];
532 strncpy (fixed, filename, PATH_MAX);
533 fixed[PATH_MAX] = '\0';
536 ArchiveFile* file = OpenFile(fixed);
540 *bufferptr = malloc (file->size()+1);
541 // we need to end the buffer with a 0
542 ((char*) (*bufferptr))[file->size()] = 0;
544 std::size_t length = file->getInputStream().read((InputStream::byte_type*)*bufferptr, file->size());
553 void FreeFile (void *p)
558 GSList* GetFileList (const char *dir, const char *ext, std::size_t depth)
560 return GetListInternal (dir, ext, false, depth);
563 GSList* GetDirList (const char *dir, std::size_t depth)
565 return GetListInternal (dir, 0, true, depth);
568 void ClearFileDirList (GSList **lst)
572 g_free ((*lst)->data);
573 *lst = g_slist_remove (*lst, (*lst)->data);
577 const char* FindFile(const char* relative)
579 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
581 if((*i).archive->containsFile(relative))
583 return (*i).name.c_str();
590 const char* FindPath(const char* absolute)
592 const char *best = "";
593 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
595 if(string_length((*i).name.c_str()) > string_length(best))
596 if(path_equal_n(absolute, (*i).name.c_str(), string_length((*i).name.c_str())))
597 best = (*i).name.c_str();
604 class Quake3FileSystem : public VirtualFileSystem
607 void initDirectory(const char *path)
609 InitDirectory(path, FileSystemQ3API_getArchiveModules());
613 globalOutputStream() << "filesystem initialised\n";
614 g_observers.realise();
618 g_observers.unrealise();
619 globalOutputStream() << "filesystem shutdown\n";
623 int getFileCount(const char *filename, int flags)
625 return GetFileCount(filename, flags);
627 ArchiveFile* openFile(const char* filename)
629 return OpenFile(filename);
631 ArchiveTextFile* openTextFile(const char* filename)
633 return OpenTextFile(filename);
635 std::size_t loadFile(const char *filename, void **buffer)
637 return LoadFile(filename, buffer, 0);
639 void freeFile(void *p)
644 void forEachDirectory(const char* basedir, const FileNameCallback& callback, std::size_t depth)
646 GSList* list = GetDirList(basedir, depth);
648 for(GSList* i = list; i != 0; i = g_slist_next(i))
650 callback(reinterpret_cast<const char*>((*i).data));
653 ClearFileDirList(&list);
655 void forEachFile(const char* basedir, const char* extension, const FileNameCallback& callback, std::size_t depth)
657 GSList* list = GetFileList(basedir, extension, depth);
659 for(GSList* i = list; i != 0; i = g_slist_next(i))
661 const char* name = reinterpret_cast<const char*>((*i).data);
662 if(extension_equal(path_get_extension(name), extension))
668 ClearFileDirList(&list);
670 GSList* getDirList(const char *basedir)
672 return GetDirList(basedir, 1);
674 GSList* getFileList(const char *basedir, const char *extension)
676 return GetFileList(basedir, extension, 1);
678 void clearFileDirList(GSList **lst)
680 ClearFileDirList(lst);
683 const char* findFile(const char *name)
685 return FindFile(name);
687 const char* findRoot(const char *name)
689 return FindPath(name);
692 void attach(ModuleObserver& observer)
694 g_observers.attach(observer);
696 void detach(ModuleObserver& observer)
698 g_observers.detach(observer);
701 Archive* getArchive(const char* archiveName, bool pakonly)
703 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
705 if(pakonly && !(*i).is_pakfile)
708 if(path_equal((*i).name.c_str(), archiveName))
713 void forEachArchive(const ArchiveNameCallback& callback, bool pakonly, bool reverse)
716 g_archives.reverse();
718 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
720 if(pakonly && !(*i).is_pakfile)
723 callback((*i).name.c_str());
727 g_archives.reverse();
731 Quake3FileSystem g_Quake3FileSystem;
733 void FileSystem_Init()
737 void FileSystem_Shutdown()
741 VirtualFileSystem& GetFileSystem()
743 return g_Quake3FileSystem;