mirror of
https://github.com/kristoferssolo/solorice.git
synced 2026-02-04 06:32:03 +00:00
Update: 2024-11-21
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
@@ -7,17 +7,15 @@
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
@@ -72,7 +60,7 @@ modification follow.
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
@@ -472,5 +472,5 @@ you can take a look at
|
||||
|
||||
## Licence
|
||||
|
||||
This plugin is licenced under the GNU GPL v3 licence.
|
||||
This plugin is licenced under the GNU AGPL v3 licence.
|
||||
You can view the full licence in the `LICENSE` file.
|
||||
|
||||
@@ -343,16 +343,80 @@ local function parse_args(args)
|
||||
return parsed_arguments
|
||||
end
|
||||
|
||||
-- Function to initialise the configuration
|
||||
---@param state any
|
||||
---@param opts Configuration
|
||||
---@return Configuration
|
||||
local initialise_config = ya.sync(function(state, opts)
|
||||
-- Function to merge the given configuration table with the default one
|
||||
---@param config Configuration|nil The configuration table to merge
|
||||
---@return Configuration merged_config The merged configuration table
|
||||
local function merge_configuration(config)
|
||||
--
|
||||
|
||||
-- Merge the default configuration with the given one
|
||||
-- If the configuration isn't given, then use the default one
|
||||
if config == nil then return DEFAULT_CONFIG end
|
||||
|
||||
-- Initialise the list of invalid configuration options
|
||||
local invalid_configuration_options = {}
|
||||
|
||||
-- Initialise the merged configuration
|
||||
local merged_config = {}
|
||||
|
||||
-- Iterate over the default configuration table
|
||||
for key, value in pairs(DEFAULT_CONFIG) do
|
||||
--
|
||||
|
||||
-- Add the default configuration to the merged configuration
|
||||
merged_config[key] = value
|
||||
end
|
||||
|
||||
-- Iterate over the given configuration table
|
||||
for key, value in pairs(config) do
|
||||
--
|
||||
|
||||
-- If the key is not in the merged configuration
|
||||
if merged_config[key] == nil then
|
||||
--
|
||||
|
||||
-- Add the key to the list of invalid configuration options
|
||||
table.insert(invalid_configuration_options, key)
|
||||
|
||||
-- Continue the loop
|
||||
goto continue
|
||||
end
|
||||
|
||||
-- Otherwise, overwrite the value in the merged configuration
|
||||
merged_config[key] = value
|
||||
|
||||
-- The label to continue the loop
|
||||
::continue::
|
||||
end
|
||||
|
||||
-- If there are no invalid configuration options,
|
||||
-- then return the merged configuration
|
||||
if #invalid_configuration_options <= 0 then return merged_config end
|
||||
|
||||
-- Otherwise, notify the user of the invalid configuration options
|
||||
ya.notify(merge_tables(DEFAULT_NOTIFICATION_OPTIONS, {
|
||||
content = "Invalid configuration options: "
|
||||
.. table.concat(invalid_configuration_options, ", "),
|
||||
level = "warn",
|
||||
}))
|
||||
|
||||
-- Return the merged configuration
|
||||
return merged_config
|
||||
end
|
||||
|
||||
-- Function to initialise the configuration
|
||||
---@param state any
|
||||
---@param user_config Configuration|nil
|
||||
---@param additional_data any
|
||||
---@return Configuration
|
||||
local initialise_config = ya.sync(function(state, user_config, additional_data)
|
||||
--
|
||||
|
||||
-- Merge the default configuration with the user given one,
|
||||
-- as well as the additional data given,
|
||||
-- and set it to the state.
|
||||
state.config = merge_tables(DEFAULT_CONFIG, opts)
|
||||
state.config = merge_tables(
|
||||
merge_configuration(user_config), additional_data
|
||||
)
|
||||
|
||||
-- Return the configuration object for async functions
|
||||
return state.config
|
||||
@@ -424,9 +488,9 @@ local function initialise_plugin(opts)
|
||||
end
|
||||
|
||||
-- Initialise the configuration object
|
||||
local config = initialise_config(merge_tables({
|
||||
local config = initialise_config(opts, {
|
||||
extractor_command = extractor_command,
|
||||
}, opts))
|
||||
}, opts)
|
||||
|
||||
-- Return the configuration object
|
||||
return config
|
||||
@@ -787,33 +851,6 @@ local function archive_is_encrypted(command_error_string)
|
||||
end
|
||||
end
|
||||
|
||||
-- The function to test the password on the archive
|
||||
-- without actually extracting the archive
|
||||
---@param archive_path string
|
||||
---@param config Configuration
|
||||
---@param password string
|
||||
---@return CommandOutput, integer
|
||||
local function test_archive_password(archive_path, config, password)
|
||||
--
|
||||
|
||||
-- Return the command to test the password on the archive
|
||||
return Command(config.extractor_command)
|
||||
:args({
|
||||
|
||||
-- Test the archive
|
||||
"t",
|
||||
|
||||
-- Pass the password to the command
|
||||
"-p" .. password,
|
||||
|
||||
-- The archive file to test
|
||||
archive_path,
|
||||
})
|
||||
:stdout(Command.PIPED)
|
||||
:stderr(Command.PIPED)
|
||||
:output()
|
||||
end
|
||||
|
||||
-- The function to handle retrying the extractor command
|
||||
--
|
||||
-- The extractor command is a function that takes
|
||||
@@ -828,7 +865,6 @@ end
|
||||
---@param extractor_command function A function that extracts the archive
|
||||
---@param config Configuration The configuration object
|
||||
---@param initial_password string|nil The initial password to try
|
||||
---@param test_encryption boolean|nil Whether to test the encryption or not
|
||||
---@param archive_path string|nil The path to the archive file
|
||||
---@return boolean successful Whether the extraction was successful
|
||||
---@return string|nil error_message An error message for unsuccessful extracts
|
||||
@@ -838,7 +874,6 @@ local function retry_extractor(
|
||||
extractor_command,
|
||||
config,
|
||||
initial_password,
|
||||
test_encryption,
|
||||
archive_path
|
||||
)
|
||||
--
|
||||
@@ -847,19 +882,10 @@ local function retry_extractor(
|
||||
-- or an empty string if it's not given
|
||||
local password = initial_password or ""
|
||||
|
||||
-- Initialise the test encryption flag to false if it is not given
|
||||
test_encryption = test_encryption or false
|
||||
|
||||
-- Initialise the archive path to the given archive path
|
||||
-- or an empty string if it's not given
|
||||
archive_path = archive_path or ""
|
||||
|
||||
-- If the archive path is empty,
|
||||
-- set the test encryption flag to false
|
||||
if string.len(string_trim(archive_path)) < 1 then
|
||||
test_encryption = false
|
||||
end
|
||||
|
||||
-- Initialise the error message from the archive extractor
|
||||
local error_message = ""
|
||||
|
||||
@@ -871,37 +897,14 @@ local function retry_extractor(
|
||||
for tries = 0, total_number_of_tries do
|
||||
--
|
||||
|
||||
-- Initialise the output and error to nil
|
||||
local output, err = nil, nil
|
||||
|
||||
-- If the test encryption flag is true
|
||||
if test_encryption then
|
||||
--
|
||||
|
||||
-- Call the function to test the encryption of the archive
|
||||
output, err = test_archive_password(archive_path, config, password)
|
||||
|
||||
-- Otherwise, execute the extractor command
|
||||
else
|
||||
--
|
||||
|
||||
-- Execute the extractor command
|
||||
output, err = extractor_command(password, config)
|
||||
end
|
||||
-- Execute the extractor command
|
||||
local output, err = extractor_command(password, config)
|
||||
|
||||
-- If there is no output
|
||||
-- then return false, the error code as a string,
|
||||
-- nil for the output, and nil for the password
|
||||
if not output then return false, tostring(err), nil, nil end
|
||||
|
||||
-- If the test encryption flag is true and the output status code is 0
|
||||
if test_encryption and output.status.code == 0 then
|
||||
--
|
||||
|
||||
-- Actually execute the extractor command
|
||||
output, err = extractor_command(password, config)
|
||||
end
|
||||
|
||||
-- If the output was 0, which means the extractor command was successful
|
||||
if output.status.code == 0 then
|
||||
--
|
||||
@@ -1529,26 +1532,6 @@ local function extract_archive(archive_path, config)
|
||||
return successful, "Archive file name is empty", extracted_items_path
|
||||
end
|
||||
|
||||
-- Initialise the extract behaviour to rename
|
||||
local extract_behaviour = ExtractBehaviour.Rename
|
||||
|
||||
-- Initialise the test archive boolean to true
|
||||
local test_archive = true
|
||||
|
||||
-- Get the size of the archive
|
||||
local archive_size = fs.cha(archive_url).length
|
||||
|
||||
-- If the size of the archive is greater than 50 MiB
|
||||
if archive_size > 50 * 1024 * 1024 then
|
||||
--
|
||||
|
||||
-- Set the extract behaviour to overwrite
|
||||
extract_behaviour = ExtractBehaviour.Overwrite
|
||||
|
||||
-- Set the test archive boolean to false
|
||||
test_archive = false
|
||||
end
|
||||
|
||||
-- Create the extractor command
|
||||
local function extractor_command(password, configuration)
|
||||
return extract_command(
|
||||
@@ -1557,7 +1540,7 @@ local function extract_archive(archive_path, config)
|
||||
configuration,
|
||||
password,
|
||||
extract_files_only,
|
||||
extract_behaviour
|
||||
ExtractBehaviour.Overwrite
|
||||
)
|
||||
end
|
||||
|
||||
@@ -1566,7 +1549,6 @@ local function extract_archive(archive_path, config)
|
||||
extractor_command,
|
||||
config,
|
||||
correct_password,
|
||||
test_archive,
|
||||
archive_path
|
||||
)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user