Setup::File - Setup file (existence, mode, permission, content)
This document describes version 0.22 of Setup::File (from Perl distribution Setup-File), released on 2015-09-04.
Because transactional function needs to store its argument in database (currently in JSON), coderefs are not representable in JSON.
Setup
Setup::File::Dir
Setup::File::Symlink
Set file's permission mode.
Fixed state: path exists and mode is already correct.
path
Fixable state: path exists but mode is not correct.
Unfixable state: path doesn't exist.
This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.
Arguments ('*' denotes required arguments):
follow_symlink => bool (default: 0)
Whether to follow symlink.
mode* => str
Permission mode, either numeric or symbolic (e.g. a+w).
orig_mode => int
If set, confirm if current mode is not the same as this.
path* => str
Path to file/directory.
Special arguments:
-tx_action => str
For more information on transaction, see Rinci::Transaction.
-tx_action_id => str
-tx_recovery => str
-tx_rollback => str
-tx_v => str
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Set file's ownership.
Fixed state: path exists and ownership is already correct.
Fixable state: path exists but ownership is not correct.
group => str
Numeric GID or group.
orig_group => str
If set, confirm if current group is not the same as this.
orig_owner => str
If set, confirm if current owner is not the same as this.
owner => str
Numeric UID or username.
Create directory.
Fixed state: path exists and is a directory.
Fixable state: path doesn't exist.
Unfixable state: path exists and is not a directory.
allow_symlink => str
Whether to regard symlink to a directory as directory.
mode => str
Set mode for the newly created directory.
Path to directory.
Create file (and/or set content).
Fixed state: path exists, is a file, and content is correct.
Fixable state: path doesn't exist. Or path exists, is a file, and content is incorrect. Or orig_path specified and exists.
orig_path
Unfixable state: path exists and is not a file.
Whether to regard symlink to a file as file.
check_content_func => str
Name of function to check content.
If unset, file will not be checked for its content. If set, function will be called whenever file content needs to be checked. Function will be passed the reference to file content and should return a boolean value indicating whether content is acceptable. If it returns a false value, content is deemed unacceptable and needs to be fixed.
Alternatively you can use the simpler content or content_md5 argument.
content
content_md5
content => str
Desired file content.
Alternatively you can also use content_md5, or gen_content_func and check_content_func.
gen_content_func
check_content_func
content_md5 => str
Check content against MD5 hash.
MD5 hash should be expressed in hex (e.g. bed6626e019e5870ef01736b3553e570).
Used when checking content of existing file.
Alternatively you can also use content, or check_content_func.
gen_content_func => str
Name of function to generate content.
If set, whenever a new file content is needed (e.g. when file is created or file content reset), this function will be called to provide it. If unset, empty string will be used instead.
Function will be passed the reference to the current content (or undef) and should return the new content.
Alternatively you can use the simpler content argument.
Path to file.
suffix => str
Delete directory.
Fixed state: path doesn't exist.
Fixable state: path exists and is a directory (or, a symlink to a directory, if allow_symlink option is enabled).
allow_symlink
Unfixable state: path exists but is not a directory.
allow_symlink => bool (default: 0)
delete_nonempty_dir => bool
Whether to delete non-empty directory.
If set to true, will delete non-empty directory.
If set to false, will never delete non-empty directory.
If unset (default), will ask for confirmation first by returning status 331. Caller can confirm by passing special argument -confirm.
-confirm
Delete file.
Fixable state: path exists and is a file (or, a symlink to a file, if allow_symlink option is enabled).
Unfixable state: path exists but is not a file.
orig_content => str
If set, confirm if current content is not the same as this.
Alternatively, you can use orig_content_hash.
orig_content_hash
orig_content_md5 => str
If set, confirm if current content MD5 hash is not the same as this.
Alternatively, you can use orig_content (for shorter content).
orig_content
Use this suffix when trashing.
Setup directory (existence, mode, permission).
On do, will create directory (if it doesn't already exist) and fix its mode/permission.
On undo, will restore old mode/permission (and delete directory if it is empty and was created by this function). If directory was created by this function but is not empty, will return status 331 to ask for confirmation (-confirm). If confirmation is set to true, will delete non-empty directory.
Will not create intermediate directories like "mkdir -p". Create intermediate directories using several setup_dir() invocation.
allow_symlink => bool (default: 1)
Whether symlink is allowed.
If existing dir is a symlink then if allow_symlink is false then it is an unacceptable condition (the symlink will be replaced if replace_symlink is true).
Note: if you want to setup symlink instead, use Setup::Symlink.
Expected group.
Expected permission mode.
Expected owner.
replace_dir => bool (default: 1)
Replace existing dir if it needs to be replaced.
replace_file => bool (default: 1)
Replace existing file if it needs to be replaced.
replace_symlink => bool (default: 1)
Replace existing symlink if it needs to be replaced.
should_exist => bool
Whether dir should exist.
If undef, dir need not exist. If set to 0, dir must not exist and will be deleted if it does. If set to 1, dir must exist and will be created if it doesn't.
Setup file (existence, mode, permission, content).
On do, will create file (if it doesn't already exist) and correct mode/permission as well as content.
On undo, will restore old mode/permission/content, or delete the file again if it was created by this function and its content hasn't changed since (if content/ownership/mode has changed, function will request confirmation).
If existing file is a symlink to a file then if allow_symlink is false then it is an unacceptable condition (the symlink will be replaced if replace_symlink is true).
Alternatively you can also use content_md5, or check_content_func and gen_content_func.
Expected group (either numeric or group name).
Mode is as supported by File::chmod. Either an octal string (e.g. '0755') or a symbolic mode (e.g. 'u+rw').
Expected owner (either numeric or username).
Whether file should exist.
If undef, file need not exist. If set to 0, file must not exist and will be deleted if it does. If set to 1, file must exist and will be created if it doesn't.
Please visit the project's homepage at https://metacpan.org/release/Setup-File.
Source repository is at https://github.com/perlancar/perl-Setup-File.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Setup-File
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Setup::File, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Setup::File
CPAN shell
perl -MCPAN -e shell install Setup::File
For more information on module installation, please visit the detailed CPAN module installation guide.