A file that contains a set of files. More...
#include "multifile.h"
Public Member Functions | |
| Multifile (const Multifile ©)=delete | |
| std::string | add_subfile (const std::string &subfile_name, const Filename &filename, int compression_level) |
| Adds a file on disk as a subfile to the Multifile. More... | |
| std::string | add_subfile (const std::string &subfile_name, std::istream *subfile_data, int compression_level) |
| Adds a file from a stream as a subfile to the Multifile. More... | |
| void | close () |
| Closes the Multifile if it is open. More... | |
| bool | compare_subfile (int index, const Filename &filename) |
| Performs a byte-for-byte comparison of the indicated file on disk with the nth subfile. More... | |
| bool | extract_subfile (int index, const Filename &filename) |
| Extracts the nth subfile into a file with the given name. More... | |
| bool | extract_subfile_to (int index, std::ostream &out) |
| Extracts the nth subfile to the indicated ostream. More... | |
| int | find_subfile (const std::string &subfile_name) const |
| Returns the index of the subfile with the indicated name, or -1 if the named subfile is not within the Multifile. More... | |
| bool | flush () |
| Writes all contents of the Multifile to disk. More... | |
| const std::string & | get_encryption_algorithm () const |
| Returns the encryption algorithm that was specified by set_encryption_algorithm(). More... | |
| bool | get_encryption_flag () const |
| Returns the flag indicating whether subsequently-added subfiles should be encrypted before writing them to the multifile. More... | |
| int | get_encryption_iteration_count () const |
| Returns the value that was specified by set_encryption_iteration_count(). More... | |
| int | get_encryption_key_length () const |
| Returns the encryption key length, in bits, that was specified by set_encryption_key_length(). More... | |
| const std::string & | get_encryption_password () const |
| Returns the password that will be used to encrypt subfiles subsequently added to the multifile. More... | |
| const std::string & | get_header_prefix () const |
| Returns the string that preceded the Multifile header on the file, if any. More... | |
| std::streampos | get_index_end () const |
| Returns the first byte that is guaranteed to follow any index byte already written to disk in the Multifile. More... | |
| const Filename & | get_multifile_name () const |
| Returns the filename of the Multifile, if it is available. More... | |
| int | get_num_subfiles () const |
| bool | get_record_timestamp () const |
| Returns the flag indicating whether timestamps should be recorded within the Multifile or not. More... | |
| size_t | get_scale_factor () const |
| Returns the internal scale factor for this Multifile. More... | |
| size_t | get_subfile_internal_length (int index) const |
| Returns the number of bytes the indicated subfile consumes within the archive. More... | |
| std::streampos | get_subfile_internal_start (int index) const |
| Returns the starting byte position within the Multifile at which the indicated subfile begins. More... | |
| size_t | get_subfile_length (int index) const |
| Returns the uncompressed data length of the nth subfile. More... | |
| const std::string & | get_subfile_name (int index) const |
| time_t | get_subfile_timestamp (int index) const |
| Returns the modification time of the nth subfile. More... | |
| time_t | get_timestamp () const |
| Returns the modification timestamp of the overall Multifile. More... | |
| bool | has_directory (const std::string &subfile_name) const |
| Returns true if the indicated subfile name is the directory prefix to one or more files within the Multifile. More... | |
| bool | is_read_valid () const |
| Returns true if the Multifile has been opened for read mode and there have been no errors, and individual Subfile contents may be extracted. More... | |
| bool | is_subfile_compressed (int index) const |
| Returns true if the indicated subfile has been compressed when stored within the archive, false otherwise. More... | |
| bool | is_subfile_encrypted (int index) const |
| Returns true if the indicated subfile has been encrypted when stored within the archive, false otherwise. More... | |
| bool | is_subfile_text (int index) const |
| Returns true if the indicated subfile represents text data, or false if it represents binary data. More... | |
| bool | is_write_valid () const |
| Returns true if the Multifile has been opened for write mode and there have been no errors, and Subfiles may be added or removed from the Multifile. More... | |
| void | ls (std::ostream &out=std::cout) const |
| Shows a list of all subfiles within the Multifile. More... | |
| bool | needs_repack () const |
| Returns true if the Multifile index is suboptimal and should be repacked. More... | |
| bool | open_read (const Filename &multifile_name, const std::streampos &offset=0) |
| bool | open_read (IStreamWrapper *multifile_stream, bool owns_pointer=false, const std::streampos &offset=0) |
| std::istream * | open_read_subfile (int index) |
| Returns an istream that may be used to read the indicated subfile. More... | |
| bool | open_read_write (const Filename &multifile_name) |
| Opens the named Multifile on disk for reading and writing. More... | |
| bool | open_read_write (std::iostream *multifile_stream, bool owns_pointer=false) |
| Opens an anonymous Multifile for reading and writing using an iostream. More... | |
| bool | open_write (const Filename &multifile_name) |
| Opens the named Multifile on disk for writing. More... | |
| bool | open_write (std::ostream *multifile_stream, bool owns_pointer=false) |
| Opens an anonymous Multifile for writing using an ostream. More... | |
| Multifile & | operator= (const Multifile ©)=delete |
| void | output (std::ostream &out) const |
| vector_uchar | read_subfile (int index) |
| Returns a vector_uchar that contains the entire contents of the indicated subfile. More... | |
| bool | read_subfile (int index, std::string &result) |
| Fills a string with the entire contents of the indicated subfile. More... | |
| bool | read_subfile (int index, vector_uchar &result) |
| Fills a pvector with the entire contents of the indicated subfile. More... | |
| void | remove_subfile (int index) |
| Removes the nth subfile from the Multifile. More... | |
| bool | remove_subfile (const std::string &subfile_name) |
| Removes the named subfile from the Multifile, if it exists; returns true if successfully removed, or false if it did not exist in the first place. More... | |
| bool | repack () |
| Forces a complete rewrite of the Multifile and all of its contents, so that its index will appear at the beginning of the file with all of the subfiles listed in alphabetical order. More... | |
| bool | scan_directory (vector_string &contents, const std::string &subfile_name) const |
| Considers subfile_name to be the name of a subdirectory within the Multifile, but not a file itself; fills the given vector up with the sorted list of subdirectories or files within the named directory. More... | |
| void | set_encryption_algorithm (const std::string &encryption_algorithm) |
| Specifies the encryption algorithm that should be used for future calls to add_subfile(). More... | |
| void | set_encryption_flag (bool flag) |
| Sets the flag indicating whether subsequently-added subfiles should be encrypted before writing them to the multifile. More... | |
| void | set_encryption_iteration_count (int encryption_iteration_count) |
| Specifies the number of times to repeatedly hash the key before writing it to the stream in future calls to add_subfile(). More... | |
| void | set_encryption_key_length (int encryption_key_length) |
| Specifies the length of the key, in bits, that should be used to encrypt the stream in future calls to add_subfile(). More... | |
| void | set_encryption_password (const std::string &encryption_password) |
| Specifies the password that will be used to encrypt subfiles subsequently added to the multifile, if the encryption flag is also set true (see set_encryption_flag()). More... | |
| void | set_header_prefix (const std::string &header_prefix) |
| Sets the string which is written to the Multifile before the Multifile header. More... | |
| void | set_multifile_name (const Filename &multifile_name) |
| Replaces the filename of the Multifile. More... | |
| void | set_record_timestamp (bool record_timestamp) |
| Sets the flag indicating whether timestamps should be recorded within the Multifile or not. More... | |
| void | set_scale_factor (size_t scale_factor) |
| Changes the internal scale factor for this Multifile. More... | |
| std::string | update_subfile (const std::string &subfile_name, const Filename &filename, int compression_level) |
| Adds a file on disk to the subfile. More... | |
 Public Member Functions inherited from ReferenceCount | |
| int | get_ref_count () const |
| WeakReferenceList * | get_weak_list () const |
| Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
| bool | has_weak_list () const |
| Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
| void | local_object () |
| This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
| void | ref () const |
| Explicitly increments the reference count. More... | |
| bool | ref_if_nonzero () const |
| Atomically increases the reference count of this object if it is not zero. More... | |
| bool | test_ref_count_integrity () const |
| Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
| bool | test_ref_count_nonzero () const |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
| virtual bool | unref () const |
| Explicitly decrements the reference count. More... | |
| WeakReferenceList * | weak_ref () |
| Adds the indicated PointerToVoid as a weak reference to this object. More... | |
| void | weak_unref () |
| Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
| static void | close_read_subfile (std::istream *stream) |
| Closes a file opened by a previous call to open_read_subfile(). More... | |
| static std::string | get_magic_number () |
| Static Public Member Functions inherited from ReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
Public Attributes | |
| get_magic_number | |
| Returns a string with the first n bytes written to a Multifile, to identify it as a Multifile. More... | |
| get_num_subfiles | |
| Returns the number of subfiles within the Multifile. More... | |
| get_subfile_name | |
| Returns the name of the nth subfile. More... | |
| Public Attributes inherited from ReferenceCount | |
| get_ref_count | |
| Returns the current reference count. More... | |
Friends | |
| class | Subfile |
Detailed Description
A file that contains a set of files.
Definition at line 37 of file multifile.h.
Member Function Documentation
◆ add_subfile() [1/2]
| string Multifile::add_subfile | ( | const std::string & | subfile_name, |
| const Filename & | filename, | ||
| int | compression_level | ||
| ) |
Adds a file on disk as a subfile to the Multifile.
The file named by filename will be read and added to the Multifile at the next call to flush(). If there already exists a subfile with the indicated name, it is replaced without examining its contents (but see also update_subfile).
Either Filename:::set_binary() or set_text() must have been called previously to specify the nature of the source file. If set_text() was called, the text flag will be set on the subfile.
Returns the subfile name on success (it might have been modified slightly), or empty string on failure.
Definition at line 417 of file multifile.cxx.
◆ add_subfile() [2/2]
| string Multifile::add_subfile | ( | const std::string & | subfile_name, |
| std::istream * | subfile_data, | ||
| int | compression_level | ||
| ) |
Adds a file from a stream as a subfile to the Multifile.
The indicated istream will be read and its contents added to the Multifile at the next call to flush(). The file will be added as a binary subfile.
Note that the istream must remain untouched and unused by any other code until flush() is called. At that time, the Multifile will read the entire contents of the istream from the current file position to the end of the file. Subsequently, the Multifile will *not* close or delete the istream. It is the caller's responsibility to ensure that the istream pointer does not destruct during the lifetime of the Multifile.
Returns the subfile name on success (it might have been modified slightly), or empty string on failure.
Definition at line 465 of file multifile.cxx.
◆ close()
| void Multifile::close | ( | ) |
Closes the Multifile if it is open.
All changes are flushed to disk, and the file becomes invalid for further operations until the next call to open().
Definition at line 324 of file multifile.cxx.
References flush(), repack(), and StreamWrapperBase::unref().
Referenced by open_read_write(), and open_write().
◆ close_read_subfile()
|
static |
Closes a file opened by a previous call to open_read_subfile().
This really just deletes the istream pointer, but it is recommended to use this interface instead of deleting it explicitly, to help work around compiler issues.
Definition at line 1628 of file multifile.cxx.
Referenced by Extractor::reset().
◆ compare_subfile()
| bool Multifile::compare_subfile | ( | int | index, |
| const Filename & | filename | ||
| ) |
Performs a byte-for-byte comparison of the indicated file on disk with the nth subfile.
Returns true if the files are equivalent, or false if they are different (or the file is missing).
If Filename::set_binary() or set_text() has already been called, it specifies the nature of the source file. If this is different from the text flag of the subfile, the comparison will always return false. If this has not been specified, it will be set from the text flag of the subfile.
Definition at line 1718 of file multifile.cxx.
◆ extract_subfile()
| bool Multifile::extract_subfile | ( | int | index, |
| const Filename & | filename | ||
| ) |
Extracts the nth subfile into a file with the given name.
Definition at line 1647 of file multifile.cxx.
◆ extract_subfile_to()
| bool Multifile::extract_subfile_to | ( | int | index, |
| std::ostream & | out | ||
| ) |
Extracts the nth subfile to the indicated ostream.
Definition at line 1680 of file multifile.cxx.
◆ find_subfile()
| int Multifile::find_subfile | ( | const std::string & | subfile_name | ) | const |
Returns the index of the subfile with the indicated name, or -1 if the named subfile is not within the Multifile.
Definition at line 1367 of file multifile.cxx.
References ordered_vector< Key, Compare, Vector >::begin(), and ordered_vector< Key, Compare, Vector >::end().
Referenced by has_directory(), remove_subfile(), and scan_directory().
◆ flush()
| bool Multifile::flush | ( | void | ) |
Writes all contents of the Multifile to disk.
Until flush() is called, add_subfile() and remove_subfile() do not actually do anything to disk. At this point, all of the recently-added subfiles are read and their contents are added to the end of the Multifile, and the recently-removed subfiles are marked gone from the Multifile.
This may result in a suboptimal index. To guarantee that the index is written at the beginning of the file, call repack() instead of flush().
It is not necessary to call flush() explicitly unless you are concerned about reading the recently-added subfiles immediately.
Returns true on success, false on failure.
Definition at line 1127 of file multifile.cxx.
References is_write_valid(), and repack().
Referenced by close(), repack(), set_encryption_algorithm(), set_encryption_iteration_count(), set_encryption_key_length(), and set_encryption_password().
◆ get_encryption_algorithm()
|
inline |
Returns the encryption algorithm that was specified by set_encryption_algorithm().
Definition at line 193 of file multifile.I.
◆ get_encryption_flag()
|
inline |
Returns the flag indicating whether subsequently-added subfiles should be encrypted before writing them to the multifile.
Definition at line 132 of file multifile.I.
◆ get_encryption_iteration_count()
|
inline |
Returns the value that was specified by set_encryption_iteration_count().
Definition at line 256 of file multifile.I.
◆ get_encryption_key_length()
|
inline |
Returns the encryption key length, in bits, that was specified by set_encryption_key_length().
Definition at line 225 of file multifile.I.
◆ get_encryption_password()
|
inline |
Returns the password that will be used to encrypt subfiles subsequently added to the multifile.
See set_encryption_password().
Definition at line 160 of file multifile.I.
◆ get_header_prefix()
|
inline |
Returns the string that preceded the Multifile header on the file, if any.
See set_header_prefix().
Definition at line 305 of file multifile.I.
◆ get_index_end()
| streampos Multifile::get_index_end | ( | ) | const |
Returns the first byte that is guaranteed to follow any index byte already written to disk in the Multifile.
This number is largely meaningless in many cases, but if needs_repack() is false, and the file is flushed, this will indicate the number of bytes in the header + index. Everything at this byte position and later will be actual data.
Definition at line 1555 of file multifile.cxx.
◆ get_multifile_name()
|
inline |
Returns the filename of the Multifile, if it is available.
Definition at line 18 of file multifile.I.
◆ get_record_timestamp()
|
inline |
Returns the flag indicating whether timestamps should be recorded within the Multifile or not.
Definition at line 93 of file multifile.I.
◆ get_scale_factor()
|
inline |
Returns the internal scale factor for this Multifile.
See set_scale_factor().
Definition at line 102 of file multifile.I.
◆ get_subfile_internal_length()
| size_t Multifile::get_subfile_internal_length | ( | int | index | ) | const |
Returns the number of bytes the indicated subfile consumes within the archive.
For compressed subfiles, this will generally be smaller than get_subfile_length(); for encrypted (but noncompressed) subfiles, it may be slightly different, for noncompressed and nonencrypted subfiles, it will be equal.
Definition at line 1580 of file multifile.cxx.
◆ get_subfile_internal_start()
| streampos Multifile::get_subfile_internal_start | ( | int | index | ) | const |
Returns the starting byte position within the Multifile at which the indicated subfile begins.
This may be used, with get_subfile_internal_length(), for low-level access to the subfile, but usually it is better to use open_read_subfile() instead (which automatically decrypts and/or uncompresses the subfile data).
Definition at line 1567 of file multifile.cxx.
◆ get_subfile_length()
| size_t Multifile::get_subfile_length | ( | int | index | ) | const |
Returns the uncompressed data length of the nth subfile.
This might return 0 if the subfile has recently been added and flush() has not yet been called.
Definition at line 1491 of file multifile.cxx.
◆ get_subfile_timestamp()
| time_t Multifile::get_subfile_timestamp | ( | int | index | ) | const |
Returns the modification time of the nth subfile.
If this is called on an older .mf file, which did not store individual timestamps in the file (or if get_record_timestamp() is false), this will return the modification time of the overall multifile.
Definition at line 1503 of file multifile.cxx.
◆ get_timestamp()
|
inline |
Returns the modification timestamp of the overall Multifile.
This indicates the most recent date at which subfiles were added or removed from the Multifile. Note that it is logically possible for an individual subfile to have a more recent timestamp than the overall timestamp.
Definition at line 66 of file multifile.I.
◆ has_directory()
| bool Multifile::has_directory | ( | const std::string & | subfile_name | ) | const |
Returns true if the indicated subfile name is the directory prefix to one or more files within the Multifile.
That is, the Multifile contains at least one file named "subfile_name/...".
Definition at line 1385 of file multifile.cxx.
References ordered_vector< Key, Compare, Vector >::end(), and find_subfile().
◆ is_read_valid()
|
inline |
Returns true if the Multifile has been opened for read mode and there have been no errors, and individual Subfile contents may be extracted.
Definition at line 37 of file multifile.I.
◆ is_subfile_compressed()
| bool Multifile::is_subfile_compressed | ( | int | index | ) | const |
Returns true if the indicated subfile has been compressed when stored within the archive, false otherwise.
Definition at line 1517 of file multifile.cxx.
◆ is_subfile_encrypted()
| bool Multifile::is_subfile_encrypted | ( | int | index | ) | const |
Returns true if the indicated subfile has been encrypted when stored within the archive, false otherwise.
Definition at line 1527 of file multifile.cxx.
◆ is_subfile_text()
| bool Multifile::is_subfile_text | ( | int | index | ) | const |
Returns true if the indicated subfile represents text data, or false if it represents binary data.
If the file is text data, it may have been processed by end-of-line conversion when it was added. (But the actual bits in the multifile will represent the standard Unix end-of-line convention, e.g.
instead of \r
.)
Definition at line 1540 of file multifile.cxx.
◆ is_write_valid()
|
inline |
Returns true if the Multifile has been opened for write mode and there have been no errors, and Subfiles may be added or removed from the Multifile.
Definition at line 46 of file multifile.I.
Referenced by flush().
◆ ls()
| void Multifile::ls | ( | std::ostream & | out = std::cout | ) | const |
Shows a list of all subfiles within the Multifile.
Definition at line 1818 of file multifile.cxx.
References get_num_subfiles.
◆ needs_repack()
|
inline |
Returns true if the Multifile index is suboptimal and should be repacked.
Call repack() to achieve this.
Definition at line 55 of file multifile.I.
◆ open_read_subfile()
| istream * Multifile::open_read_subfile | ( | int | index | ) |
Returns an istream that may be used to read the indicated subfile.
You may seek() within this istream to your heart's content; even though it will be a reference to the already-opened pfstream of the Multifile itself, byte 0 appears to be the beginning of the subfile and EOF appears to be the end of the subfile.
The returned istream will have been allocated via new; you should pass the pointer to close_read_subfile() when you are finished with it to delete it and release its resources.
Any future calls to repack() or close() (or the Multifile destructor) will invalidate all currently open subfile pointers.
The return value will be NULL if the stream cannot be opened for some reason.
Definition at line 1603 of file multifile.cxx.
◆ open_read_write() [1/2]
| bool Multifile::open_read_write | ( | const Filename & | multifile_name | ) |
Opens the named Multifile on disk for reading and writing.
If there already exists a file by that name, its index is read. Subfiles may be added or removed, and the resulting changes will be written to the named file.
Also see the version of open_read_write() which accepts an iostream. Returns true on success, false on failure.
Definition at line 258 of file multifile.cxx.
◆ open_read_write() [2/2]
| bool Multifile::open_read_write | ( | std::iostream * | multifile_stream, |
| bool | owns_pointer = false |
||
| ) |
Opens an anonymous Multifile for reading and writing using an iostream.
There must be seek functionality via seekg()/seekp() and tellg()/tellp() on the iostream.
If owns_pointer is true, then the Multifile assumes ownership of the stream pointer and will delete it when the multifile is closed, including if this function returns false.
Definition at line 293 of file multifile.cxx.
References close().
◆ open_write() [1/2]
| bool Multifile::open_write | ( | const Filename & | multifile_name | ) |
Opens the named Multifile on disk for writing.
If there already exists a file by that name, it is truncated. The Multifile is then prepared for accepting a brand new set of subfiles, which will be written to the indicated filename. Individual subfiles may not be extracted or read.
Also see the version of open_write() which accepts an ostream. Returns true on success, false on failure.
Definition at line 215 of file multifile.cxx.
◆ open_write() [2/2]
| bool Multifile::open_write | ( | std::ostream * | multifile_stream, |
| bool | owns_pointer = false |
||
| ) |
Opens an anonymous Multifile for writing using an ostream.
There must be seek functionality via seekp() and tellp() on the pstream.
If owns_pointer is true, then the Multifile assumes ownership of the stream pointer and will delete it when the multifile is closed, including if this function returns false.
Definition at line 238 of file multifile.cxx.
References close().
◆ read_subfile() [1/3]
|
inline |
Returns a vector_uchar that contains the entire contents of the indicated subfile.
Definition at line 285 of file multifile.I.
Referenced by read_subfile().
◆ read_subfile() [2/3]
| bool Multifile::read_subfile | ( | int | index, |
| std::string & | result | ||
| ) |
Fills a string with the entire contents of the indicated subfile.
Definition at line 1875 of file multifile.cxx.
References read_subfile().
◆ read_subfile() [3/3]
| bool Multifile::read_subfile | ( | int | index, |
| vector_uchar & | result | ||
| ) |
Fills a pvector with the entire contents of the indicated subfile.
Definition at line 1897 of file multifile.cxx.
◆ remove_subfile() [1/2]
| void Multifile::remove_subfile | ( | int | index | ) |
Removes the nth subfile from the Multifile.
This will cause all subsequent index numbers to decrease by one. The file will not actually be removed from the disk until the next call to flush().
Note that this does not actually remove the data from the indicated subfile; it simply removes it from the index. The Multifile will not be reduced in size after this operation, until the next call to repack().
Definition at line 1459 of file multifile.cxx.
Referenced by remove_subfile().
◆ remove_subfile() [2/2]
|
inline |
Removes the named subfile from the Multifile, if it exists; returns true if successfully removed, or false if it did not exist in the first place.
The file will not actually be removed from the disk until the next call to flush().
Note that this does not actually remove the data from the indicated subfile; it simply removes it from the index. The Multifile will not be reduced in size after this operation, until the next call to repack().
Definition at line 271 of file multifile.I.
References find_subfile(), and remove_subfile().
◆ repack()
| bool Multifile::repack | ( | ) |
Forces a complete rewrite of the Multifile and all of its contents, so that its index will appear at the beginning of the file with all of the subfiles listed in alphabetical order.
This is considered optimal for reading, and is the standard configuration; but it is not essential to do this.
It is only valid to call this if the Multifile was opened using open_read_write() and an explicit filename, rather than an iostream. Also, we must have write permission to the directory containing the Multifile.
Returns true on success, false on failure.
Definition at line 1281 of file multifile.cxx.
References flush().
◆ scan_directory()
| bool Multifile::scan_directory | ( | vector_string & | contents, |
| const std::string & | subfile_name | ||
| ) | const |
Considers subfile_name to be the name of a subdirectory within the Multifile, but not a file itself; fills the given vector up with the sorted list of subdirectories or files within the named directory.
Note that directories do not exist explicitly within a Multifile; this just checks for the existence of files with the given initial prefix.
Returns true if successful, false otherwise.
Definition at line 1417 of file multifile.cxx.
References ordered_vector< Key, Compare, Vector >::end(), and find_subfile().
◆ set_encryption_algorithm()
|
inline |
Specifies the encryption algorithm that should be used for future calls to add_subfile().
The default is whatever is specified by the encryption- algorithm config variable. The complete set of available algorithms is defined by the current version of OpenSSL.
If an invalid algorithm is specified, there is no immediate error return code, but flush() will fail and the file will be invalid.
It is possible to apply a different encryption algorithm to different files, and unlike the password, this does not interfere with mounting the multifile via VFS. Changing this value may cause an implicit call to flush().
Definition at line 179 of file multifile.I.
References flush().
◆ set_encryption_flag()
|
inline |
Sets the flag indicating whether subsequently-added subfiles should be encrypted before writing them to the multifile.
If true, subfiles will be encrypted; if false (the default), they will be written without encryption.
When true, subfiles will be encrypted with the password specified by set_encryption_password(). It is possible to apply a different password to different files, but the resulting file can't be mounted via VFS.
Definition at line 116 of file multifile.I.
◆ set_encryption_iteration_count()
|
inline |
Specifies the number of times to repeatedly hash the key before writing it to the stream in future calls to add_subfile().
Its purpose is to make it computationally more expensive for an attacker to search the key space exhaustively. This should be a multiple of 1,000 and should not exceed about 65 million; the value 0 indicates just one application of the hashing algorithm.
The default is whatever is specified by the multifile-encryption-iteration- count config variable.
It is possible to apply a different iteration count to different files, and unlike the password, this does not interfere with mounting the multifile via VFS. Changing this value causes an implicit call to flush().
Definition at line 245 of file multifile.I.
References flush().
◆ set_encryption_key_length()
|
inline |
Specifies the length of the key, in bits, that should be used to encrypt the stream in future calls to add_subfile().
The default is whatever is specified by the encryption-key-length config variable.
If an invalid key_length for the chosen algorithm is specified, there is no immediate error return code, but flush() will fail and the file will be invalid.
It is possible to apply a different key length to different files, and unlike the password, this does not interfere with mounting the multifile via VFS. Changing this value may cause an implicit call to flush().
Definition at line 211 of file multifile.I.
References flush().
◆ set_encryption_password()
|
inline |
Specifies the password that will be used to encrypt subfiles subsequently added to the multifile, if the encryption flag is also set true (see set_encryption_flag()).
It is possible to apply a different password to different files, but the resulting file can't be mounted via VFS. Changing this value may cause an implicit call to flush().
Definition at line 146 of file multifile.I.
References flush().
◆ set_header_prefix()
| void Multifile::set_header_prefix | ( | const std::string & | header_prefix | ) |
Sets the string which is written to the Multifile before the Multifile header.
This string must begin with a hash mark and end with a newline character; and if it includes embedded newline characters, each one must be followed by a hash mark. If these conditions are not initially true, the string will be modified as necessary to make it so.
This is primarily useful as a simple hack to allow p3d applications to be run directly from the command line on Unix-like systems.
The return value is true if successful, or false on failure (for instance, because the header prefix violates the above rules).
Definition at line 1840 of file multifile.cxx.
◆ set_multifile_name()
|
inline |
Replaces the filename of the Multifile.
This is primarily used for documentation purposes only; changing this name does not open the indicated file. See open_read() or open_write() for that.
Definition at line 28 of file multifile.I.
◆ set_record_timestamp()
|
inline |
Sets the flag indicating whether timestamps should be recorded within the Multifile or not.
The default is true, indicating the Multifile will record timestamps for the overall file and also for each subfile.
If this is false, the Multifile will not record timestamps internally. In this case, the return value from get_timestamp() or get_subfile_timestamp() will be estimations.
You may want to set this false to minimize the bitwise difference between independently-generated Multifiles.
Definition at line 83 of file multifile.I.
◆ set_scale_factor()
| void Multifile::set_scale_factor | ( | size_t | scale_factor | ) |
Changes the internal scale factor for this Multifile.
This is normally 1, but it may be set to any arbitrary value (greater than zero) to support Multifile archives that exceed 4GB, if necessary. (Individual subfiles may still not exceed 4GB.)
All addresses within the file are rounded up to the next multiple of _scale_factor, and zeros are written to the file to fill the resulting gaps. Then the address is divided by _scale_factor and written out as a 32-bit integer. Thus, setting a scale factor of 2 supports up to 8GB files, 3 supports 12GB files, etc.
Calling this function on an already-existing Multifile will have no immediate effect until a future call to repack() or close() (or until the Multifile is destructed).
Definition at line 386 of file multifile.cxx.
◆ update_subfile()
| string Multifile::update_subfile | ( | const std::string & | subfile_name, |
| const Filename & | filename, | ||
| int | compression_level | ||
| ) |
Adds a file on disk to the subfile.
If a subfile already exists with the same name, its contents are compared byte-for-byte to the disk file, and it is replaced only if it is different; otherwise, the multifile is left unchanged.
Either Filename:::set_binary() or set_text() must have been called previously to specify the nature of the source file. If set_text() was called, the text flag will be set on the subfile.
Definition at line 491 of file multifile.cxx.
Member Data Documentation
◆ get_magic_number
|
inline |
Returns a string with the first n bytes written to a Multifile, to identify it as a Multifile.
Definition at line 139 of file multifile.h.
◆ get_num_subfiles
| int Multifile::get_num_subfiles |
Returns the number of subfiles within the Multifile.
The subfiles may be accessed in alphabetical order by iterating through [0 .. get_num_subfiles()).
Definition at line 117 of file multifile.h.
Referenced by ls().
◆ get_subfile_name
| const string & Multifile::get_subfile_name |
Returns the name of the nth subfile.
Definition at line 117 of file multifile.h.
The documentation for this class was generated from the following files:
- panda/src/express/multifile.h
- panda/src/express/multifile.cxx
- panda/src/express/multifile.I
