User contributions for Danilo

03:2703:27, 19 January 2022 diff hist +1,429‎ N Modules/FileSystem/file/read ‎ Created page with "__NOTOC__ This function attempts to read the specified amount of bytes from the file. The actual amount of bytes read equals to the length of the Lua string. ==Syntax== <syntaxhighlight lang="lua"> string file:read ( int readCount ) </syntaxhighlight> ==Arguments== *'''readCount:''' the amount of bytes to read from the file ==Returns== This function returns a string that contains the bytes that have been read from the file. ==Example== <section name="Client" class="c..."
03:2303:23, 19 January 2022 diff hist 0‎ Modules/FileSystem ‎No edit summary
03:2203:22, 19 January 2022 diff hist −1‎ Modules/FileSystem/functions ‎No edit summary
03:1903:19, 19 January 2022 diff hist +1,221‎ N Modules/FileSystem/translator/functions ‎ Created page with "==FileSystem Translator Functions== *open *exists *createDir *chdir *delete *copy *rename *size *Modules/FileSystem/translator..."
03:1103:11, 19 January 2022 diff hist +262‎ N Modules/FileSystem/functions ‎ Created page with "==FileSystem Library Functions== *createFilesystemInterface {{:Modules/FileSystem/namespace/functions}} {{:Modules/FileSystem/translator/functions}} {{:Modules/FileSystem/file/functions}}"
03:0903:09, 19 January 2022 diff hist +61‎ MTA:Eir/FileSystem/functions ‎ Undo revision 73642 by Danilo (talk) current Tag: Undo
03:0803:08, 19 January 2022 diff hist −61‎ MTA:Eir/FileSystem/functions ‎ →‎FileSystem Library Functions
03:0403:04, 19 January 2022 diff hist +470‎ N Modules/FileSystem/translator/getPathProcessingMode ‎ Created page with "__NOTOC__ This function gets the path-processing-mode for the given file translator. ==Syntax== <syntaxhighlight lang="lua"> string translator:getPathProcessingMode () </syntaxhighlight> ==Returns== This function returns a string describing the current path-processing-mode of the translator. ===Possible Return Values=== *distinguished *ambivalent_file ==Example== <syntaxhighlight lang="lua"> -- TODO </syntaxhighlight> {{:Modules/FileSystem/translator/functions}}"
03:0403:04, 19 January 2022 diff hist +583‎ N Modules/FileSystem/translator/setPathProcessingMode ‎ Created page with "__NOTOC__ This function sets the path-processing-mode for the file translator. The path-processing-mode describes how paths are handled in detail during file-path consuming function calls. ==Syntax== <syntaxhighlight lang="lua"> void translator:setPathProcessingMode( string mode ) </syntaxhighlight> ==Arguments== *'''mode:''' value for the translator path-processing-mode (either '''distinguished''' or '''ambivalent_file''') ==Returns== This function returns nil. ==Ex..."
03:0303:03, 19 January 2022 diff hist +589‎ N Modules/FileSystem/translator/getOutbreakEnabled ‎ Created page with "__NOTOC__ This function gets the outbreak-policy of a file translator. If outbreak is enabled then file path requests outside of the translator root are allowed. Otherwise the user can only access files that are accessible from inside the translator root directory. ==Syntax== <syntaxhighlight lang="lua"> bool translator:setOutbreakEnabled () </syntaxhighlight> ==Returns== This function returns true if the outbreak-policy is enabled for this translator, false otherwise...."
03:0203:02, 19 January 2022 diff hist +603‎ N Modules/FileSystem/translator/setOutbreakEnabled ‎ Created page with "__NOTOC__ This function sets the outbreak-policy of a file translator. If outbreak is enabled then file path requests outside of the translator root are allowed. Otherwise the user can only access files that are accessible from inside the translator root directory. ==Syntax== <syntaxhighlight lang="lua"> void translator:setOutbreakEnabled ( bool enabled ) </syntaxhighlight> ==Arguments== *'''enabled:''' value for the translator outbreak-policy ==Returns== This functio..."
03:0203:02, 19 January 2022 diff hist +1,762‎ N Modules/FileSystem/translator/getFiles ‎ Created page with "__NOTOC__ This function returns a list of all files that are found under the wild-card and directory parameters. It is similar to scanDir but returns files only. ==Syntax== <syntaxhighlight lang="lua"> table translator:getFiles ( string dirPath, string wildcard, bool recursive ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to the directory the scan shall take place or start in *'''wildcard:''' glob-style wild-card fo..."
03:0103:01, 19 January 2022 diff hist +1,626‎ N Modules/FileSystem/translator/getDirs ‎ Created page with "__NOTOC__ This function returns a list of all directories that are found under the directory path. It is similar to scanDir but returns directories only. ==Syntax== <syntaxhighlight lang="lua"> table translator:getDirs ( string dirPath, bool recursive ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to the directory the scan shall take place or start in *'''recursive:''' a boolean that specifies whether the whole direc..."
03:0003:00, 19 January 2022 diff hist +3,387‎ N Modules/FileSystem/translator/scanDirEx ‎ Created page with "__NOTOC__ This function loops through all translator filesystem entries that are captured by the wildcard and the directory specifier. The wildcard is glob-style and supports '''*''' and '''?''' modifiers. The scan can be made recursive to enter every directory it finds, so that files and folders of a whole directory tree are captured. This function is used to process filesystem objects inside of directories without having to add the filenames into a configuration file...."
02:5902:59, 19 January 2022 diff hist +2,914‎ N Modules/FileSystem/translator/scanDir ‎ Created page with "__NOTOC__ This function loops through all translator filesystem entries that are captured by the wildcard and the directory specifier. The wildcard is glob-style and supports '''*''' and '''?''' modifiers. The scan can be made recursive to enter every directory it finds, so that files and folders of a whole directory tree are captured. This function is used to process filesystem objects inside of directories without having to add the filenames into a configuration file...."
02:5802:58, 19 January 2022 diff hist +1,410‎ N Modules/FileSystem/translator/absPathRoot ‎ Created page with "__NOTOC__ This function resolves a specified path into its absolute version. The path is resolved from the translator root. This function can be used to get a unique version of a path (without scripting symbols such as '..'). ==Syntax== <syntaxhighlight lang="lua"> string translator:absPathRoot ( string path ) </syntaxhighlight> ==Arguments== *'''path:''' the path that should be resolved into an absolute path; can be nil to return the absolute location of the translato..."
02:5702:57, 19 January 2022 diff hist +1,053‎ N Modules/FileSystem/translator/absPath ‎ Created page with "__NOTOC__ This function resolves a specified path into its absolute version. This function can be used to get a unique version of a path (without scripting symbols such as '..'). ==Syntax== <syntaxhighlight lang="lua"> string translator:absPath ( string path ) </syntaxhighlight> ==Arguments== *'''path:''' the path that should be resolved into an absolute path; can be nil to return the absolute location of the current directory. ==Returns== This function returns the ab..."
02:5702:57, 19 January 2022 diff hist +1,488‎ N Modules/FileSystem/translator/relPathRoot ‎ Created page with "__NOTOC__ This function transform a path that is passed to it into a path that is relative to the translators root directory. The path must be accessible from the translator. The path can either be absolute or relative. ==Syntax== <syntaxhighlight lang="lua"> string translator:relPathRoot ( string path ) </syntaxhighlight> ==Arguments== *'''path:''' the path that should be transformed into a relative path; can be nil to return the '''null path''' ==Returns== This func..."
02:5602:56, 19 January 2022 diff hist +1,252‎ N Modules/FileSystem/translator/relPath ‎ Created page with "__NOTOC__ This function transform a path that is passed to it into a path that is relative to the translators current directory. The path must be accessible from the translator. The path can either be absolute or relative. ==Syntax== <syntaxhighlight lang="lua"> string translator:relPath ( string path ) </syntaxhighlight> ==Arguments== *'''path:''' the path that should be transformed into a relative path; can be nil if the current directory should be returned ==Return..."
02:5502:55, 19 January 2022 diff hist +1,434‎ N Modules/FileSystem/translator/stat ‎ Created page with "__NOTOC__ This function queries common information about a filesystem object and returns it as a dictionary. Example of its return value: <syntaxhighlight lang="lua"> { accessTime = 1390997951, -- OS specific time information creationTime = 1381999749, -- OS specific time information modTime = 1381872826, -- OS specific time information size = 1441280, -- size of the filesystem object in bytes }; </syntaxhighlight> ==Syntax== <syntaxhighlight lang="lua">..."
02:5402:54, 19 January 2022 diff hist +1,375‎ N Modules/FileSystem/translator/size ‎ Created page with "__NOTOC__ This function queries the size of a filesystem object. The size of a filesystem object is the count of bytes that it logically fills on the storage media. ==Syntax== <syntaxhighlight lang="lua"> int translator:size ( string filePath ) </syntaxhighlight> ==Arguments== *'''filePath:''' the path to the filesystem object that you want to get the size of ==Returns== This function returns the count of bytes that the filesystem object is logically taking on the sto..."
02:5302:53, 19 January 2022 diff hist +1,048‎ N Modules/FileSystem/translator/rename ‎ Created page with "__NOTOC__ This function moves a file from a source location to a destination location inside of a filesystem. This function is the fastest way to move data from one location to another. ==Syntax== <syntaxhighlight lang="lua"> bool translator:rename ( string srcPath, string dstPath ) </syntaxhighlight> ==Arguments== *'''srcPath:''' a path to the source file *'''dstPath:''' the path to the destination location where the source file should be moved to ==Returns== This fu..."
02:5302:53, 19 January 2022 diff hist +1,163‎ N Modules/FileSystem/translator/copy ‎ Created page with "__NOTOC__ This function copies a file from a source location to a file at the destination. The contents of the source file are copied, so that source and destination have the same content. Since the transactions happen through kernel-calls, this function is faster than performing the copying yourself through Lua strings. ==Syntax== <syntaxhighlight lang="lua"> bool translator:copy ( string srcPath, string dstPath ) </syntaxhighlight> ==Arguments== *'''srcPath:''' a pat..."
02:5202:52, 19 January 2022 diff hist +1,004‎ N Modules/FileSystem/translator/delete ‎ Created page with "__NOTOC__ This function deletes an entry on the translator filesystem. If the path points at a directory, the whole content of it is recursively deleted. A typical reason when deletion may fail is when the file is opened in another OS handle. Proper clean-up of file classes can prevent this issue. ==Syntax== <syntaxhighlight lang="lua"> bool translator:delete ( string path ) </syntaxhighlight> ==Arguments== *'''path:''' a path to a filesystem object that should be wipe..."
02:5102:51, 19 January 2022 diff hist +1,704‎ N Modules/FileSystem/translator/chdir ‎ Created page with "__NOTOC__ This function changes the current directory pointer of the translator. All operations on the FileSystem translator are executed relative to the current directory. The translator, if possible, is asked to prevent deletion of the current directory. ==Syntax== <syntaxhighlight lang="lua"> bool translator:chdir ( string dirPath ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to a directory that should be made current directory ==Returns== This functio..."
02:5002:50, 19 January 2022 diff hist +1,186‎ N Modules/FileSystem/translator/createDir ‎ Created page with "__NOTOC__ This function creates a directory inside of a translator directory hierarchy. ==Syntax== <syntaxhighlight lang="lua"> bool translator:createDir ( string dirPath ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to a directory that should be created ==Returns== This function returns '''true''' if the given path is a valid directory path relative to the translator, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> T..."
02:4902:49, 19 January 2022 diff hist +1,164‎ N Modules/FileSystem/translator/exists ‎ Created page with "__NOTOC__ This function checks whether a specified file exists on a MTA:Eir FileSystem translator. ==Syntax== <syntaxhighlight lang="lua"> bool translator:exists ( string filePath ) </syntaxhighlight> ==Arguments== *'''filePath:''' the path to the file that should exist ==Returns== This function returns '''true''' if the given path points to a valid file instance on a FileSystem, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> T..."
02:4702:47, 19 January 2022 diff hist +3,620‎ N Modules/FileSystem/translator/open ‎ Created page with "__NOTOC__ This function opens a link to a file instance on a given MTA:Eir FileSystem translator. Using a file link, you can write and/or receive data from filesystems. ==Syntax== <syntaxhighlight lang="lua"> file, string translator:open ( string filePath, string fileMode ) </syntaxhighlight> ==Arguments== *'''filePath:''' the path to the file that should be opened *'''fileMode:''' an ANSI file mode descriptor (can be 'w', 'r' or 'a', with 'b' and/or '+' appended) ==R..."
02:4202:42, 19 January 2022 diff hist +1,753‎ N Modules/FileSystem/createFilesystemInterface ‎ Created page with "__NOTOC__ This function creates a FileSystem access point. An access point is your personal instance of the Eir FileSystem. The table returned by this function is the module namespace. There are no limits as to how many access points can be live at a time. '''When using the fileSystem module, it is highly suggested to restrict access to this function to priviledged resources!''' ==Syntax== <syntaxhighlight lang="lua"> table createFilesystemInterface () </syntaxhighligh..." current
00:0300:03, 19 January 2022 diff hist +738‎ N Modules/FileSystem/namespace/functions ‎ Created page with " ==FileSystem Namespace Functions== *createTranslator *createRAMDisk *createMemoryFile *createFileIterative *copyFile *copyStream *copyStreamCount *Modules/FileSystem/pathToFilename|pat..."

23:5923:59, 18 January 2022 diff hist +404‎ N Modules/FileSystem/getDoBufferAllRaw ‎ Created page with "__NOTOC__ This function returns the value of the buffering-policy for newly created raw-file handles. ==Syntax== <syntaxhighlight lang="lua"> bool fsnamespace.getDoBufferAllRaw() </syntaxhighlight> ==Returns== This function returns true if the buffering-policy is enabled, false otherwise. ==Example== <syntaxhighlight lang="lua"> -- TODO </syntaxhighlight> {{:Modules/FileSystem/namespace/functions}}"
23:5823:58, 18 January 2022 diff hist +661‎ N Modules/FileSystem/setDoBufferAllRaw ‎ Created page with "__NOTOC__ This function changes the raw-file buffering policy of newly created file streams. If the buffering-policy is enabled then each newly created file stream is wrapped inside of a custom FileSystem buffering handle. File stream modifications that are close to each other are batched together for optimizational purposes. ==Syntax== <syntaxhighlight lang="lua"> void fsnamespace.setDoBufferAllRaw( bool enabled ) </syntaxhighlight> ==Arguments== *'''enabled''': new v..."
23:5723:57, 18 January 2022 diff hist +576‎ N Modules/FileSystem/type ‎ Created page with "__NOTOC__ This function returns the type of the given Eir FileSystem object. ==Syntax== <syntaxhighlight lang="lua"> string fsnamespace.type( userdata obj ) </syntaxhighlight> ==Arguments== *'''obj''': the Eir FileSystem object to retrieve the type from ==Returns== This function returns the type string of the queried object, false if not successful. For destroyed objects the return value is always false. ===Possible Return Values=== *file *file-translator ==Example=..."
23:5423:54, 18 January 2022 diff hist +559‎ N Modules/FileSystem/topointer ‎ Created page with "__NOTOC__ This function returns the light-userdata representation of the object. This is the direct pointer into the Eir FileSystem module handle. ==Syntax== <syntaxhighlight lang="lua"> light-userdata fsnamespace.topointer( userdata obj ) </syntaxhighlight> ==Arguments== *'''obj''': the userdata of the Eir FileSystem Lua environment ==Returns== This function returns the light-userdata value of the internal object, false if not successful. ==Example== <syntaxhighligh..."
23:5323:53, 18 January 2022 diff hist +731‎ N Modules/FileSystem/streamCompare ‎ Created page with "__NOTOC__ This function compares the bytes of two streams for equality. The comparison starts from the current file seek and finishes at the end of the respective file stream. If the read count of either stream does not match the other, then this function fails. ==Syntax== <syntaxhighlight lang="lua"> bool fsnamespace.streamCompare( file left, file right ) </syntaxhighlight> ==Arguments== *'''left''': first file for equality comparison *'''right''': second file for equ..."
23:5123:51, 18 January 2022 diff hist +641‎ N Modules/FileSystem/pathToFilename ‎ Created page with "__NOTOC__ This function returns the filename and the direction portions of a filepath, seperated into two strings. ==Syntax== <syntaxhighlight lang="lua"> string, string fsnamespace.pathToFilename( string path, bool includeExtention ) </syntaxhighlight> ==Arguments== *'''path''': the file path to extract from *'''includeExtention''': if true then the filename extention is included in the result ==Returns== This function returns the filename and directory of the provid..."
23:5023:50, 18 January 2022 diff hist +977‎ N Modules/FileSystem/copyStreamCount ‎ Created page with "__NOTOC__ This function copies data starting from a source file stream into a specified destination stream. The copy of data is performed starting from the source file seek. The copy is only performed up to a specified count of bytes. Read operations on the file streams advance the seek pointers. Thus the seek pointers stay changed after the function has completed. ==Syntax== <syntaxhighlight lang="lua"> bool fsnamespace.copyStreamCount( file src, file dst, int count )..."
23:4923:49, 18 January 2022 diff hist +838‎ N Modules/FileSystem/copyStream ‎ Created page with "__NOTOC__ This function copies data starting from a source file stream into a specified destination stream. The copy of data is performed starting from the source file seek. Read operations on the file streams advance the seek pointers. Thus the seek pointers stay changed after the function has completed. ==Syntax== <syntaxhighlight lang="lua"> bool fsnamespace.copyStream( file src, file dst ) </syntaxhighlight> ==Arguments== *'''src''': source of the copy operation,..."
23:4823:48, 18 January 2022 diff hist +710‎ N Modules/FileSystem/copyFile ‎ Created page with "__NOTOC__ This function copies files between two translators. ==Syntax== <syntaxhighlight lang="lua"> bool fsnamespace.copyFile( translator srcTrans, string srcPath, translator dstTrans, string dstPath ) </syntaxhighlight> ==Arguments== *'''srcTrans:''' source translator for the file of origin *'''srcPath:''' path into the source translator *'''dstTrans:''' target translator *'''dstPath:''' path into the target translator ==Returns== This function returns true if the..."
23:4623:46, 18 January 2022 diff hist +1,041‎ N Modules/FileSystem/createFileIterative ‎ Created page with "__NOTOC__ This function attempts to create a file with numeric iteration for filename collision avoidance. If a specific filename is taken then an the algorithm will try to create the next file with increased numeric insert. ==Syntax== <syntaxhighlight lang="lua"> file fsnamespace.createFileIterative( translator target, string prefix, string suffix, int maxIterations ) </syntaxhighlight> ==Arguments== *'''target''': the file translator based on which to create the file..."
23:4423:44, 18 January 2022 diff hist +424‎ N Modules/FileSystem/createMemoryFile ‎ Created page with "__NOTOC__ This function creates a single file that is resident entirely in system memory. ==Syntax== <syntaxhighlight lang="lua"> file fsnamespace.createMemoryFile( ) </syntaxhighlight> ==Returns== This function returns a new file object if successful, false otherwise. ==Example== <syntaxhighlight lang="lua"> -- TODO </syntaxhighlight> {{:Modules/FileSystem/namespace/functions}} {{:Modules/FileSystem/file/functions}}"
23:4023:40, 18 January 2022 diff hist +3,225‎ N Modules/FileSystem/createTranslator ‎ Created page with "__NOTOC__ This function creates a FileSystem translator. A FileSystem translator represents a directory on a real or virtual filesystem. Through translators you get access to the files that reside in their directory trees. The translator returned by this function usually represents an OS filesystem directory. ==Syntax== <syntaxhighlight lang="lua"> translator fsnamespace.createTranslator( string rootPath ) </syntaxhighlight> ==Arguments== *'''rootPath:''' the absolute..."
23:3223:32, 18 January 2022 diff hist +771‎ N Modules/FileSystem/createRAMDisk ‎ Created page with "__NOTOC__ This function creates a FileSystem translator which is located entirely inside of MTA application memory, also known as RAM. ==Syntax== <syntaxhighlight lang="lua"> translator fsnamespace.createRAMDisk( bool caseSensitive ) </syntaxhighlight> ==Arguments== *'''caseSensitive:''' if true then all namespaces are compared case sensitively in path operations, otherwise strict character equality comparison is performed ==Returns== This function returns a new '''Fi..."