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 const char *p = strrchr(directory, '/');
319 p = (p ? (p+1) : path);
320 if(matchpattern(p, g_strForbiddenDirs[j], TRUE))
323 if(j < g_numForbiddenDirs)
325 printf("Directory %s matched by forbidden dirs, removed\n", directory);
329 if (g_numDirs == VFS_MAXDIRS)
332 strncpy(g_strDirs[g_numDirs], directory, PATH_MAX);
333 g_strDirs[g_numDirs][PATH_MAX] = '\0';
334 FixDOSName (g_strDirs[g_numDirs]);
335 AddSlash (g_strDirs[g_numDirs]);
337 const char* path = g_strDirs[g_numDirs];
342 archive_entry_t entry;
344 entry.archive = OpenArchive(path);
345 entry.is_pakfile = false;
346 g_archives.push_back(entry);
351 GDir* dir = g_dir_open (path, 0, 0);
355 globalOutputStream() << "vfs directory: " << path << "\n";
357 const char* ignore_prefix = "";
358 const char* override_prefix = "";
361 // See if we are in "sp" or "mp" mapping mode
362 const char* gamemode = gamemode_get();
364 if (strcmp (gamemode, "sp") == 0)
366 ignore_prefix = "mp_";
367 override_prefix = "sp_";
369 else if (strcmp (gamemode, "mp") == 0)
371 ignore_prefix = "sp_";
372 override_prefix = "mp_";
377 Archives archivesOverride;
380 const char* name = g_dir_read_name(dir);
384 for(j = 0; j < g_numForbiddenDirs; ++j)
385 if(!string_compare_nocase_upper(name, g_strForbiddenDirs[j]))
387 if(j < g_numForbiddenDirs)
390 const char *ext = strrchr (name, '.');
392 if(ext && !string_compare_nocase_upper(ext, ".pk3dir"))
394 if (g_numDirs == VFS_MAXDIRS)
396 snprintf(g_strDirs[g_numDirs], PATH_MAX, "%s%s/", path, name);
397 g_strDirs[g_numDirs][PATH_MAX] = '\0';
398 FixDOSName (g_strDirs[g_numDirs]);
399 AddSlash (g_strDirs[g_numDirs]);
403 archive_entry_t entry;
404 entry.name = g_strDirs[g_numDirs-1];
405 entry.archive = OpenArchive(g_strDirs[g_numDirs-1]);
406 entry.is_pakfile = false;
407 g_archives.push_back(entry);
411 if ((ext == 0) || *(++ext) == '\0' || GetArchiveTable(archiveModules, ext) == 0)
414 // using the same kludge as in engine to ensure consistency
415 if(!string_empty(ignore_prefix) && strncmp(name, ignore_prefix, strlen(ignore_prefix)) == 0)
419 if(!string_empty(override_prefix) && strncmp(name, override_prefix, strlen(override_prefix)) == 0)
421 archivesOverride.insert(name);
425 archives.insert(name);
430 // add the entries to the vfs
431 for(Archives::iterator i = archivesOverride.begin(); i != archivesOverride.end(); ++i)
433 char filename[PATH_MAX];
434 strcpy(filename, path);
435 strcat(filename, (*i).c_str());
436 InitPakFile(archiveModules, filename);
438 for(Archives::iterator i = archives.begin(); i != archives.end(); ++i)
440 char filename[PATH_MAX];
441 strcpy(filename, path);
442 strcat(filename, (*i).c_str());
443 InitPakFile(archiveModules, filename);
448 globalErrorStream() << "vfs directory not found: " << path << "\n";
453 // frees all memory that we allocated
454 // FIXME TTimo this should be improved so that we can shutdown and restart the VFS without exiting Radiant?
455 // (for instance when modifying the project settings)
458 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
460 (*i).archive->release();
465 g_numForbiddenDirs = 0;
468 #define VFS_SEARCH_PAK 0x1
469 #define VFS_SEARCH_DIR 0x2
471 int GetFileCount (const char *filename, int flag)
474 char fixed[PATH_MAX+1];
476 strncpy(fixed, filename, PATH_MAX);
477 fixed[PATH_MAX] = '\0';
481 flag = VFS_SEARCH_PAK | VFS_SEARCH_DIR;
483 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
485 if((*i).is_pakfile && (flag & VFS_SEARCH_PAK) != 0
486 || !(*i).is_pakfile && (flag & VFS_SEARCH_DIR) != 0)
488 if((*i).archive->containsFile(fixed))
496 ArchiveFile* OpenFile(const char* filename)
498 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
499 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
501 ArchiveFile* file = (*i).archive->openFile(filename);
511 ArchiveTextFile* OpenTextFile(const char* filename)
513 ASSERT_MESSAGE(strchr(filename, '\\') == 0, "path contains invalid separator '\\': \"" << filename << "\"");
514 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
516 ArchiveTextFile* file = (*i).archive->openTextFile(filename);
526 // NOTE: when loading a file, you have to allocate one extra byte and set it to \0
527 std::size_t LoadFile (const char *filename, void **bufferptr, int index)
529 char fixed[PATH_MAX+1];
531 strncpy (fixed, filename, PATH_MAX);
532 fixed[PATH_MAX] = '\0';
535 ArchiveFile* file = OpenFile(fixed);
539 *bufferptr = malloc (file->size()+1);
540 // we need to end the buffer with a 0
541 ((char*) (*bufferptr))[file->size()] = 0;
543 std::size_t length = file->getInputStream().read((InputStream::byte_type*)*bufferptr, file->size());
552 void FreeFile (void *p)
557 GSList* GetFileList (const char *dir, const char *ext, std::size_t depth)
559 return GetListInternal (dir, ext, false, depth);
562 GSList* GetDirList (const char *dir, std::size_t depth)
564 return GetListInternal (dir, 0, true, depth);
567 void ClearFileDirList (GSList **lst)
571 g_free ((*lst)->data);
572 *lst = g_slist_remove (*lst, (*lst)->data);
576 const char* FindFile(const char* relative)
578 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
580 if((*i).archive->containsFile(relative))
582 return (*i).name.c_str();
589 const char* FindPath(const char* absolute)
591 const char *best = "";
592 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
594 if(string_length((*i).name.c_str()) > string_length(best))
595 if(path_equal_n(absolute, (*i).name.c_str(), string_length((*i).name.c_str())))
596 best = (*i).name.c_str();
603 class Quake3FileSystem : public VirtualFileSystem
606 void initDirectory(const char *path)
608 InitDirectory(path, FileSystemQ3API_getArchiveModules());
612 globalOutputStream() << "filesystem initialised\n";
613 g_observers.realise();
617 g_observers.unrealise();
618 globalOutputStream() << "filesystem shutdown\n";
622 int getFileCount(const char *filename, int flags)
624 return GetFileCount(filename, flags);
626 ArchiveFile* openFile(const char* filename)
628 return OpenFile(filename);
630 ArchiveTextFile* openTextFile(const char* filename)
632 return OpenTextFile(filename);
634 std::size_t loadFile(const char *filename, void **buffer)
636 return LoadFile(filename, buffer, 0);
638 void freeFile(void *p)
643 void forEachDirectory(const char* basedir, const FileNameCallback& callback, std::size_t depth)
645 GSList* list = GetDirList(basedir, depth);
647 for(GSList* i = list; i != 0; i = g_slist_next(i))
649 callback(reinterpret_cast<const char*>((*i).data));
652 ClearFileDirList(&list);
654 void forEachFile(const char* basedir, const char* extension, const FileNameCallback& callback, std::size_t depth)
656 GSList* list = GetFileList(basedir, extension, depth);
658 for(GSList* i = list; i != 0; i = g_slist_next(i))
660 const char* name = reinterpret_cast<const char*>((*i).data);
661 if(extension_equal(path_get_extension(name), extension))
667 ClearFileDirList(&list);
669 GSList* getDirList(const char *basedir)
671 return GetDirList(basedir, 1);
673 GSList* getFileList(const char *basedir, const char *extension)
675 return GetFileList(basedir, extension, 1);
677 void clearFileDirList(GSList **lst)
679 ClearFileDirList(lst);
682 const char* findFile(const char *name)
684 return FindFile(name);
686 const char* findRoot(const char *name)
688 return FindPath(name);
691 void attach(ModuleObserver& observer)
693 g_observers.attach(observer);
695 void detach(ModuleObserver& observer)
697 g_observers.detach(observer);
700 Archive* getArchive(const char* archiveName, bool pakonly)
702 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
704 if(pakonly && !(*i).is_pakfile)
707 if(path_equal((*i).name.c_str(), archiveName))
712 void forEachArchive(const ArchiveNameCallback& callback, bool pakonly, bool reverse)
715 g_archives.reverse();
717 for(archives_t::iterator i = g_archives.begin(); i != g_archives.end(); ++i)
719 if(pakonly && !(*i).is_pakfile)
722 callback((*i).name.c_str());
726 g_archives.reverse();
730 Quake3FileSystem g_Quake3FileSystem;
732 void FileSystem_Init()
736 void FileSystem_Shutdown()
740 VirtualFileSystem& GetFileSystem()
742 return g_Quake3FileSystem;