Nebula
Loading...
Searching...
No Matches
ioserver.h
Go to the documentation of this file.
1#pragma once
2//------------------------------------------------------------------------------
19#include "core/refcounted.h"
20#include "core/singleton.h"
21#include "util/array.h"
22#include "util/string.h"
23#include "io/filetime.h"
24#include "io/schemeregistry.h"
27
28namespace Http
29{
31};
32
33//------------------------------------------------------------------------------
34namespace IO
35{
36class ArchiveFileSystem;
37class FileWatcher;
38class Stream;
39class URI;
40class AssignRegistry;
41
43{
46public:
48 IoServer();
50 virtual ~IoServer();
51
53 bool MountArchive(const URI& uri);
55 bool MountEmbeddedArchive(const URI& uri);
57 void UnmountArchive(const URI& uri);
59 bool IsArchiveMounted(const URI& uri) const;
61 void SetArchiveFileSystemEnabled(bool b);
63 bool IsArchiveFileSystemEnabled() const;
68
70 Ptr<Stream> CreateStream(const URI& uri) const;
72 bool CreateDirectory(const URI& uri) const;
74 bool EnsureDirectoriesForFile(const URI& uri) const;
76 bool DeleteDirectory(const URI& path) const;
78 bool DirectoryExists(const URI& path) const;
79
81 bool CopyFile(const URI& from, const URI& to) const;
83 bool RenameFile(const URI& from, const URI& to) const;
85 bool DeleteFile(const URI& path) const;
87 bool FileExists(const URI& path) const;
89 bool IsLocked(const URI& path) const;
91 void SetReadOnly(const URI& path, bool b) const;
93 bool IsReadOnly(const URI& path) const;
95 unsigned int ComputeFileCrc(const URI& path) const;
97 void SetFileWriteTime(const URI& path, FileTime fileTime);
99 FileTime GetFileWriteTime(const URI& path) const;
101 static bool ReadFile(const URI& path, Util::String & contents);
103 static Util::String NativePath(const Util::String& path);
104
106 bool GetIOInfo(const URI& uri, IOStat& outInfo, bool prioritizeArchive) const;
107
109 Util::Array<Util::String> ListFiles(const URI& dir, const Util::String& pattern, bool asFullPath=false) const;
111 Util::Array<Util::String> ListDirectories(const URI& dir, const Util::String& pattern, bool asFullPath=false, bool prioritizeArchive=true) const;
112
113 using FileMapFunc = void(const Util::String& file, const Util::String& folder);
115 void IterateFolders(const URI& dir, const Util::String& pattern, FileMapFunc iter);
116
118 URI CreateTemporaryFilename(const URI& path) const;
119
120private:
123
126 static Threading::CriticalSection archiveCriticalSection;
128
134 static Threading::CriticalSection assignCriticalSection;
135 static Threading::CriticalSection schemeCriticalSection;
136 static Threading::CriticalSection watcherCriticalSection;
137};
138
139//------------------------------------------------------------------------------
142inline Ptr<IO::Stream>
144{
145 return IoServer::Instance()->CreateStream(uri);
146}
147
148//------------------------------------------------------------------------------
151inline bool
153{
154 return IoServer::Instance()->CreateDirectory(uri);
155}
156
157//------------------------------------------------------------------------------
160inline bool
162{
163 return IoServer::Instance()->FileExists(uri);
164}
165
166//------------------------------------------------------------------------------
170ListFiles(const IO::URI& dir, const Util::String& pattern = "*", bool asFullPath = false)
171{
172 return IoServer::Instance()->ListFiles(dir, pattern, asFullPath);
173}
174
175//------------------------------------------------------------------------------
179ListDirectories(const IO::URI& dir, const Util::String& pattern = "*", bool asFullPath = false)
180{
181 return IoServer::Instance()->ListDirectories(dir, pattern, asFullPath);
182}
183
184//------------------------------------------------------------------------------
187inline bool
189{
190 return IoServer::Instance()->DirectoryExists(uri);
191}
192
193//------------------------------------------------------------------------------
196inline bool
198{
199 return IoServer::Instance()->DeleteFile(uri);
200}
201
202//------------------------------------------------------------------------------
205inline bool
206CopyFile(const IO::URI& from, const IO::URI& to)
207{
208 return IoServer::Instance()->CopyFile(from, to);
209}
210
211//------------------------------------------------------------------------------
214inline bool
215RenameFile(const IO::URI& from, const IO::URI& to)
216{
217 return IoServer::Instance()->RenameFile(from, to);
218}
219
220//------------------------------------------------------------------------------
223inline bool
225{
226 return IoServer::Instance()->DeleteDirectory(uri);
227}
228
229//------------------------------------------------------------------------------
232inline void
237
238//------------------------------------------------------------------------------
244inline bool
246{
247 return this->archiveFileSystemEnabled && ArchiveFileSystem::Instance()->HasArchives();
248}
249
250} // namespace IO
251//------------------------------------------------------------------------------
The common base class of Nebula.
Definition refcounted.h:45
The HttpClientRegistry provides a way to re-use existing connections to HTTP servers instead of setti...
Definition httpclientregistry.h:26
Central registry for path assigns.
Definition assignregistry.h:25
Defines a file-access timestamp.
For registering callbacks for file modification events.
Definition filewatcher.h:75
static Threading::CriticalSection assignCriticalSection
Definition ioserver.h:134
Util::Array< Util::String > AddPathPrefixToArray(const Util::String &prefix, const Util::Array< Util::String > &filenames) const
helper function to add path prefix to file or dir names in array
Definition ioserver.cc:664
Ptr< AssignRegistry > assignRegistry
Definition ioserver.h:130
void SetFileWriteTime(const URI &path, FileTime fileTime)
set the write-time of a file
Definition ioserver.cc:548
bool IsArchiveMounted(const URI &uri) const
return true if a archive is mounted (without archive file extension!)
Definition ioserver.cc:199
static Threading::CriticalSection archiveCriticalSection
Definition ioserver.h:126
void SetReadOnly(const URI &path, bool b) const
set the readonly status of a file
Definition ioserver.cc:511
void(const Util::String &file, const Util::String &folder) FileMapFunc
Definition ioserver.h:113
bool IsArchiveFileSystemEnabled() const
return true if transparent archive filesystem is enabled
Definition ioserver.h:245
bool FileExists(const URI &path) const
return true if file exists
Definition ioserver.cc:464
static Threading::CriticalSection watcherCriticalSection
Definition ioserver.h:136
Ptr< Stream > CreateStream(const URI &uri) const
create a stream object for the given uri
Definition ioserver.cc:130
URI CreateTemporaryFilename(const URI &path) const
create a temporary file name
Definition ioserver.cc:726
Util::Array< Util::String > ListDirectories(const URI &dir, const Util::String &pattern, bool asFullPath=false, bool prioritizeArchive=true) const
list all subdirectories matching a pattern in a directory
Definition ioserver.cc:630
bool DeleteFile(const URI &path) const
delete a file
Definition ioserver.cc:440
bool MountEmbeddedArchive(const URI &uri)
mount an embedded file archive
Definition ioserver.cc:179
Ptr< FileWatcher > watcher
Definition ioserver.h:132
void SetArchiveFileSystemEnabled(bool b)
enable/disable transparent archive filesystem layering (default is yes)
Definition ioserver.h:233
void MountStandardArchives()
mount standard archives (e.g. home:export.zip and home:export_$(platform).zip)
Definition ioserver.cc:208
static bool ReadFile(const URI &path, Util::String &contents)
read contents of file and return as string
Definition ioserver.cc:686
static Threading::CriticalSection schemeCriticalSection
Definition ioserver.h:135
bool IsReadOnly(const URI &path) const
return read only status of a file
Definition ioserver.cc:523
bool IsLocked(const URI &path) const
return if file is locked
Definition ioserver.cc:713
bool GetIOInfo(const URI &uri, IOStat &outInfo, bool prioritizeArchive) const
get file/folder information (size, access time, modified time, creation time) via stat calls
Definition ioserver.cc:757
void UnmountArchive(const URI &uri)
unmount a file archive (without archive file extension!)
Definition ioserver.cc:190
bool RenameFile(const URI &from, const URI &to) const
rename a file or a directory. The target must not exist as the exact name, so a rename never replaces
Definition ioserver.cc:408
void UnmountStandardArchives()
unmount standard archives
Definition ioserver.cc:234
Ptr< ArchiveFileSystem > archiveFileSystem
Definition ioserver.h:125
void IterateFolders(const URI &dir, const Util::String &pattern, FileMapFunc iter)
iterate through all files in hierarchy and call provided function
Definition ioserver.cc:780
bool DeleteDirectory(const URI &path) const
delete an empty directory
Definition ioserver.cc:452
bool EnsureDirectoriesForFile(const URI &uri) const
create all missing directories
Definition ioserver.cc:297
Ptr< SchemeRegistry > schemeRegistry
Definition ioserver.h:131
bool MountArchive(const URI &uri)
mount a file archive (without archive file extension!)
Definition ioserver.cc:169
Ptr< Http::HttpClientRegistry > httpClientRegistry
Definition ioserver.h:129
bool CopyFile(const URI &from, const URI &to) const
copy a file
Definition ioserver.cc:311
__DeclareClass(IoServer)
static Util::String NativePath(const Util::String &path)
return native path
Definition ioserver.cc:743
static bool StandardArchivesMounted
Definition ioserver.h:127
FileTime GetFileWriteTime(const URI &path) const
return the last write-time of a file
Definition ioserver.cc:560
bool CreateDirectory(const URI &uri) const
create all missing directories in the path
Definition ioserver.cc:256
Ptr< StreamCache > streamCache
Definition ioserver.h:133
bool DirectoryExists(const URI &path) const
return true if directory exists
Definition ioserver.cc:486
unsigned int ComputeFileCrc(const URI &path) const
get the CRC checksum of a file
Definition ioserver.cc:370
IoServer()
constructor
Definition ioserver.cc:39
__DeclareSingleton(IoServer)
Util::Array< Util::String > ListFiles(const URI &dir, const Util::String &pattern, bool asFullPath=false) const
list all files matching a pattern in a directory
Definition ioserver.cc:572
bool archiveFileSystemEnabled
Definition ioserver.h:124
Offers an abstract interface for read/write access to a sequence of bytes.
Definition stream.h:28
An URI object can split a Uniform Resource Identifier string into its components or build a string fr...
Definition uri.h:67
Nebula's smart pointer class which manages the life time of RefCounted objects.
Definition ptr.h:38
Nebula's dynamic array class.
Definition array.h:61
Nebula's universal string class.
Definition string.h:50
This file was generated with Nebula Trifid's idlc compiler tool.
Definition defaulthttprequesthandler.cc:15
Instances of wrapped stream classes.
Definition multiplayerfeatureunit.cc:324
bool RenameFile(const IO::URI &from, const IO::URI &to)
Definition ioserver.h:215
Util::Array< Util::String > ListDirectories(const IO::URI &dir, const Util::String &pattern="*", bool asFullPath=false)
Definition ioserver.h:179
bool DirectoryExists(const IO::URI &uri)
Definition ioserver.h:188
Ptr< IO::Stream > CreateStream(const IO::URI &uri)
Definition ioserver.h:143
Util::Array< Util::String > ListFiles(const IO::URI &dir, const Util::String &pattern="*", bool asFullPath=false)
Definition ioserver.h:170
bool DeleteDirectory(const IO::URI &uri)
Definition ioserver.h:224
bool DeleteFile(const IO::URI &uri)
Definition ioserver.h:197
bool FileExists(const IO::URI &uri)
Definition ioserver.h:161
bool CreateDirectory(const IO::URI &uri)
Definition ioserver.h:152
bool CopyFile(const IO::URI &from, const IO::URI &to)
Definition ioserver.h:206
Definition filetime.h:41