#add hotpatch to master

lib/scenarios/Hotpatch/control.lua

@@ -0,0 +1,63 @@
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+-- Hotpatchable control.lua for scenarios
+-- Supports multiple simultaneously loaded softmods
+-- This is a WIP
+-- Version 1.1 alpha
+-- probably some performance improvements to be made
+
+_ENV.debug_settings = {
+    level = 'info',
+    log_to_console_only = false,
+    log_to_RCON = false,
+    log_on_tick = false,
+}
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+require 'hotpatch.remote-interface'
+require 'hotpatch.commands'
+require 'hotpatch.gui'
+
+-- mod code goes here
+
+-- Single-file test
+--[[
+hotpatch_tools.static_mod('test', '1.0.0', [===[
+    script.on_init(function()
+        log('test')
+    end)
+]===])
+--]]
+
+-- Multi-file test
+--[[
+local files = {}
+
+files['testfolder.anothertest.test'] = [===[
+    script.on_event(defines.events.on_player_changed_position, function(e) game.print('position changed') end)
+]===]
+
+files['testfolder.test'] = [===[
+    require 'anothertest.test'
+]===]
+
+files['test'] = [===[
+    require 'testfolder.test' 
+]===]
+
+hotpatch_tools.static_mod('require-test', '1.0.0', [===[
+    require 'test'
+]===], files)
+--]]
+
+-- end of mod code

lib/scenarios/Hotpatch/hotpatch/commands.lua

@@ -0,0 +1,135 @@
+local hotpatch_tools = require 'hotpatch.mod-tools'
+hotpatch_tools.static_mod('hotpatch-commands', '1.0.1', [===[
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+
+--load private API
+-- mod installation/uninstallation support functions
+-- These take a mod NAME as a first argument
+local install_mod = hotpatch_tools.install_mod
+local find_installed_mod = hotpatch_tools.find_installed_mod
+local install_mod_file = hotpatch_tools.install_mod_file
+local uninstall_mod = hotpatch_tools.uninstall_mod
+
+-- mod interaction functions
+-- These take a LOADED INDEX as a first argument, except load_mod, which takes an INSTALLED INDEX
+local load_mod = hotpatch_tools.load_mod
+local find_loaded_mod = hotpatch_tools.find_loaded_mod
+local run_mod = hotpatch_tools.run_mod
+local reset_mod = hotpatch_tools.reset_mod
+local reset_mod_events = hotpatch_tools.reset_mod_events
+local register_mod_events = hotpatch_tools.register_mod_events
+local unload_mod = hotpatch_tools.unload_mod
+
+-- internal callbacks when a mod registers events
+local register_event = hotpatch_tools.register_event
+local register_nth_tick = hotpatch_tools.register_nth_tick
+local register_on_tick = hotpatch_tools.register_on_tick
+
+-- mod bootstrap functions
+-- These take a LOADED INDEX as a first argument
+local mod_on_init = hotpatch_tools.mod_on_init
+local mod_on_load = hotpatch_tools.mod_on_load
+local mod_on_configuration_changed = hotpatch_tools.mod_on_configuration_changed
+
+local static_mods = hotpatch_tools.static_mods
+local console = hotpatch_tools.console
+local debug_log = hotpatch_tools.debug_log
+local loaded_mods = hotpatch_tools.loaded_mods
+local installed_mods = hotpatch_tools.installed_mods
+
+local help_commands = {
+    help = '/hotpatch help\nYou got this far, you probably know all you need to know',
+    list = '/hotpatch list [type]\nLists \'installed\', \'loaded\' or \'running\' mods',
+}
+
+local sub_commands
+sub_commands = {
+    help = function(player_index, param)
+        local caller = (player_index and game.players[player_index]) or console
+        if (not param) or (param == '') then
+            caller.print('Usage: /hotpatch [command] [parameters]')
+            caller.print('Available commands:')
+            for k, v in pairs(sub_commands) do caller.print(k) end
+            caller.print('Use /hotpatch help [command] for help on a particular command')
+        else
+            local text = help_commands[param]
+            if text then 
+                caller.print(text)
+            end
+        end
+    end,
+    list = function(player_index, param)
+        local caller = (player_index and game.players[player_index]) or console
+        if not param or (param == '') then
+            caller.print('Installed mods:')
+            for k, v in pairs(installed_mods) do
+                caller.print(table.concat{'[', k, '] ', v.name, ' ', v.version})
+            end
+            caller.print('Loaded/Running mods:')
+            for k, v in pairs(loaded_mods) do
+                caller.print(table.concat{'[', k, '] ', v.name, ' ', v.version, ' ', (v.loaded and 'loaded') or 'not loaded', ' ', (v.running and 'running') or 'not running'})
+            end
+        else
+        
+        end
+    end,
+}
+
+local admin_commands = {
+    reinstall = function(player_index, param)
+        local caller = (player_index and game.players[player_index]) or console
+        local mod
+        local installed_index
+        local loaded_index
+        for i = 1, #static_mods do
+            mod = static_mods[i]
+            if mod.name:match('^hotpatch%-.*$') then
+                loaded_index = find_loaded_mod(mod.name)
+                if loaded_index then
+                    unload_mod(loaded_index)
+                end
+                install_mod(mod.name, mod.version, mod.code, mod.files)
+                installed_index = find_installed_mod(mod.name)
+                load_mod(installed_index)
+                loaded_index = find_loaded_mod(mod.name)
+                run_mod(loaded_index)
+                mod_on_init(loaded_index)
+            end
+        end
+    end,
+}
+
+_ENV.commands.add_command('hotpatch', 'Commands for hotpatch. Run /hotpatch help for details.', function(e)
+    local caller = (e.player_index and game.players[e.player_index]) or console
+    if (not e.parameter) or (e.parameter == '') then 
+        sub_commands['help'](e.player_index)
+        return
+    end
+    local sub_command, rest = e.parameter:match('(.-)%s(.*)')
+    if not sub_command then
+        sub_command = e.parameter
+    end
+
+    local f = sub_commands[sub_command]
+    if f then f(e.player_index, rest) end
+    if caller.admin then
+        f = admin_commands[sub_command]
+        if f then f(e.player_index, rest) end
+    end
+end)
+
+]===])
+
+return true

lib/scenarios/Hotpatch/hotpatch/gui.lua

@@ -0,0 +1,375 @@
+local hotpatch_tools = require 'hotpatch.mod-tools'
+hotpatch_tools.static_mod('hotpatch-gui', '1.0.3', [===[
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+local mod_gui = require 'mod-gui'
+
+--load private API
+-- mod installation/uninstallation support functions
+-- These take a mod NAME as a first argument
+local install_mod = hotpatch_tools.install_mod
+local find_installed_mod = hotpatch_tools.find_installed_mod
+local install_mod_file = hotpatch_tools.install_mod_file
+local uninstall_mod = hotpatch_tools.uninstall_mod
+
+-- mod interaction functions
+-- These take a LOADED INDEX as a first argument, except load_mod, which takes an INSTALLED INDEX
+local load_mod = hotpatch_tools.load_mod
+local find_loaded_mod = hotpatch_tools.find_loaded_mod
+local run_mod = hotpatch_tools.run_mod
+local reset_mod = hotpatch_tools.reset_mod
+local reset_mod_events = hotpatch_tools.reset_mod_events
+local register_mod_events = hotpatch_tools.register_mod_events
+local unload_mod = hotpatch_tools.unload_mod
+
+-- internal callbacks when a mod registers events
+local register_event = hotpatch_tools.register_event
+local register_nth_tick = hotpatch_tools.register_nth_tick
+local register_on_tick = hotpatch_tools.register_on_tick
+
+-- mod bootstrap functions
+-- These take a LOADED INDEX as a first argument
+local mod_on_init = hotpatch_tools.mod_on_init
+local mod_on_load = hotpatch_tools.mod_on_load
+local mod_on_configuration_changed = hotpatch_tools.mod_on_configuration_changed
+
+local static_mods = hotpatch_tools.static_mods
+local console = hotpatch_tools.console
+local debug_log = hotpatch_tools.debug_log
+local loaded_mods = hotpatch_tools.loaded_mods
+local installed_mods = hotpatch_tools.installed_mods
+
+script.on_event(defines.events.on_player_joined_game, function(e)
+    local player = game.players[e.player_index]
+    local top = mod_gui.get_button_flow(player)
+    local left = mod_gui.get_frame_flow(player)
+    local center = player.gui.center
+    
+    local button = top['hotpatch-button']
+    if button then
+        button.destroy()
+    end
+    local menu = left['hotpatch-menu']
+    if menu then 
+        menu.destroy()
+    end
+    
+    local IDE = center['hotpatch-IDE']
+    if IDE then 
+        IDE.destroy()
+    end
+    
+    local main = center['hotpatch-main']
+    if main then 
+        main.destroy()
+    end
+    
+    button = top.add{type = 'sprite-button', name = 'hotpatch-button', sprite='utility/heat_exchange_indication', tooltip = 'Hotpatch'}
+end)
+
+local on_gui_click_handlers
+local on_gui_selection_state_changed_handlers
+
+on_gui_click_handlers = {
+    ['hotpatch-button'] = function(e)
+        --on_gui_click_handlers['hotpatch-menu.IDE'](e)
+        --do return end
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+        
+        local menu = left['hotpatch-menu']
+        if not menu then
+            menu = left.add{type = 'frame', name = 'hotpatch-menu', direction = 'vertical'}
+            menu.add{type = 'button', name = 'hotpatch-menu.IDE', caption = 'Mod IDE', tooltip = 'Open debugging GUI'}
+            menu.add{type = 'button', name = 'hotpatch-menu.console', caption = 'Mod Console', tooltip = 'Open debugging console'}
+            menu.style.visible = true
+            return
+        end
+        menu.style.visible = not menu.style.visible
+    end,
+    ['hotpatch-menu'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+        
+        local menu = left['hotpatch-menu']
+        menu.style.visible = not menu.style.visible
+        
+        on_gui_click_handlers[e.element.name](e)
+    end,
+    ['hotpatch-menu.IDE'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+        
+        local IDE = center['hotpatch-IDE']
+        if not IDE then
+            IDE = center.add{type = 'frame', name = 'hotpatch-IDE', direction = 'vertical', caption = 'Hotpatch IDE'}
+            local top_flow = IDE.add{type = 'flow', name = 'hotpatch-IDE-top', direction = 'horizontal'}
+            top_flow.add{type = 'label', name = 'hotpatch-IDE-mod-label', caption = 'Mod: '}
+            local IDE_dropdown = top_flow.add{type = 'drop-down', name = 'hotpatch-IDE-mod-selector'}
+            top_flow.add{type = 'label', name = 'hotpatch-IDE-mod-version', caption = 'Version: No mod selected'}
+            local IDE_table = IDE.add{type = 'table', name = 'hotpatch-IDE-table', column_count = 2}
+            local files = IDE_table.add{type = 'scroll-pane', name = 'hotpatch-IDE-files', direction='vertical'}
+            files.style.height = 600
+            files.vertical_scroll_policy = 'always'
+            files = files.add{type = 'table', name = 'hotpatch-IDE-files-table', column_count = 1}
+            local code = IDE_table.add{type = 'text-box', name = 'hotpatch-IDE-code'}
+            code.word_wrap = true
+            files.style.width = 400
+            files.style.cell_spacing = 0
+            files.style.top_padding = 0
+            files.style.bottom_padding = 0
+            code.style.width = 600
+            code.style.height = 600
+            IDE.style.visible = false
+        end
+        
+        local IDE_dropdown = IDE['hotpatch-IDE-top']['hotpatch-IDE-mod-selector']
+        IDE_dropdown.clear_items()
+        for k, v in ipairs(installed_mods) do
+            IDE_dropdown.add_item(v.name)
+        end
+            
+        IDE.style.visible = not IDE.style.visible
+        if IDE.style.visible then
+            player.opened = IDE
+        else
+            player.opened = nil
+        end
+    end,
+    ['hotpatch-menu.console'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+        
+        local console = center['hotpatch-console']
+        if not console then
+            console = center.add{type = 'frame', name = 'hotpatch-console', direction = 'vertical', caption = 'Hotpatch Console'}
+            local top_flow = console.add{type = 'flow', name = 'hotpatch-console-top', direction = 'horizontal'}
+            top_flow.add{type = 'label', name = 'hotpatch-console-mod-label', caption = 'Mod: '}
+            local console_dropdown = top_flow.add{type = 'drop-down', name = 'hotpatch-console-mod-selector'}
+            top_flow.add{type = 'label', name = 'hotpatch-console-mod-version', caption = 'Version: No mod selected'}
+            local bottom_flow = console.add{type = 'flow', name = 'hotpatch-console-bottom', direction = 'vertical'}
+            local output = bottom_flow.add{type = 'text-box', name = 'hotpatch-console-output'}
+            local bottom_input_flow = bottom_flow.add{type = 'flow', name = 'hotpatch-console-bottom-input', direction = 'horizontal'}
+            local input = bottom_input_flow.add{type = 'textfield', name = 'hotpatch-console-input'}
+            bottom_input_flow.add{type = 'button', name = 'hotpatch-console-run', caption = 'Run', tooltip = 'Run Lua Code'}
+            output.style.width = 800
+            output.style.height = 600
+            input.style.width = 600
+        end
+        
+        local console_dropdown = console['hotpatch-console-top']['hotpatch-console-mod-selector']
+        console_dropdown.clear_items()
+        for k, v in ipairs(loaded_mods) do
+            console_dropdown.add_item(v.name)
+        end
+        
+        console.style.visible = not console.style.visible
+        if console.style.visible then
+            player.opened = console
+        else
+            player.opened = nil
+        end
+    end,
+    ['hotpatch-console-run'] = function(e)
+        local player = game.players[e.player_index]
+        
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+        
+        local console = center['hotpatch-console']
+        local output = console['hotpatch-console-bottom']['hotpatch-console-output']
+        local input = console['hotpatch-console-bottom']['hotpatch-console-bottom-input']['hotpatch-console-input']
+        local console_dropdown = console['hotpatch-console-top']['hotpatch-console-mod-selector']
+        
+        if not player.admin then
+            output.text = table.concat{output.text, '\n', 'Only admins!'}
+            return
+        end
+        
+        if not (console_dropdown.selected_index > 0) then
+            output.text = table.concat{output.text, '\n', 'Select a mod!'}
+            return
+        end
+        
+        local mod_name = console_dropdown.items[console_dropdown.selected_index]
+        local loaded_index = find_loaded_mod(mod_name)
+        local env = loaded_mods[loaded_index].env
+        local old_print = env.print
+        local old_log = env.log
+        
+        
+        
+        
+        
+        env.print = function(...)
+            --local count = select('#', ...)
+            local t = table.pack(...)
+            for k, v in pairs(t) do
+                t[k] = tostring(v)
+            end
+            local text = table.concat(t, '\t')
+            output.text = table.concat{output.text, '\n', text}
+        end
+        
+        env.log = function(text)
+            output.text = table.concat{output.text, '\n', text}
+        end
+        
+        local code, err = load(input.text, input.text, 't', env)
+        if code then 
+            local success, err = pcall(code)
+            if not success then
+                output.text = table.concat{output.text, '\n', err}
+            end
+        else
+            output.text = table.concat{output.text, '\n', err}
+        end
+        
+        env.print = old_print
+        env.log = old_log
+    end,
+    ['hotpatch-IDE-file'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+    
+        local element = e.element
+        local previous
+        for k, v in pairs(center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-files']['hotpatch-IDE-files-table'].children) do
+            if table.compare(v.style.font_color or {}, {r=1.0, g=1.0, b=0.0, a=1.0}) then
+                previous = v
+                break
+            end
+        end
+        if previous then
+            previous.style.font_color = {r=1.0, g=1.0, b=1.0, a=1.0}
+        end
+        element.style.font_color = {r=1.0, g=1.0, b=0.0, a=1.0}
+        local file = element.name:match('.-%.(.*)')
+        local selected = center['hotpatch-IDE']['hotpatch-IDE-top']['hotpatch-IDE-mod-selector']
+        local mod_name = selected.items[selected.selected_index]
+        local code = center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-code']
+        local index = find_installed_mod(mod_name)
+        if index then
+            local mod = installed_mods[index]
+            if file == 'control' then
+                code.text = mod.code
+            else
+                code.text = mod.files[file]
+            end
+        end
+    end,
+}
+
+script.on_event(defines.events.on_gui_click, function(e)
+    local element = e.element
+    if element.valid then
+        local name = element.name:match('([^%.]*)%.?.-')
+        local handler = on_gui_click_handlers[name]
+        if handler then handler(e) end
+    end
+end)
+
+on_gui_selection_state_changed_handlers = {
+    ['hotpatch-console-mod-selector'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+        
+        local element = e.element
+        local name = element.items[element.selected_index]
+        if name then
+            local index = find_loaded_mod(name)
+            if index then
+                local mod = loaded_mods[index]
+                local version_label = center['hotpatch-console']['hotpatch-console-top']['hotpatch-console-mod-version']
+                version_label.caption = 'Version: ' .. mod.version
+                local console = center['hotpatch-console']
+                local output = console['hotpatch-console-bottom']['hotpatch-console-output']
+                output.text = ''
+            end
+        end
+    end,
+    ['hotpatch-IDE-mod-selector'] = function(e)
+        local player = game.players[e.player_index]
+        local top = mod_gui.get_button_flow(player)
+        local left = mod_gui.get_frame_flow(player)
+        local center = player.gui.center
+        
+        local element = e.element
+        
+        local name = element.items[element.selected_index]
+        if name then
+            local index = find_installed_mod(name)
+            if index then
+                local mod = installed_mods[index]
+                local version_label = center['hotpatch-IDE']['hotpatch-IDE-top']['hotpatch-IDE-mod-version']
+                version_label.caption = 'Version: ' .. mod.version
+                local list = center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-files']['hotpatch-IDE-files-table']
+                list.clear()
+                local file = list.add{type = 'label', style = 'hoverable_bold_label', caption = 'control', name = 'hotpatch-IDE-file.control'}
+                file.style.bottom_padding = 0
+                file.style.top_padding = 0
+                for k, v in pairs(mod.files) do
+                    file = list.add{type = 'label', style = 'hoverable_bold_label', caption = k, name = 'hotpatch-IDE-file.' .. k}
+                    file.style.bottom_padding = 0
+                    file.style.top_padding = 0
+                end
+                local code = center['hotpatch-IDE']['hotpatch-IDE-table']['hotpatch-IDE-code']
+                code.text = ''
+            end
+        end
+    end,
+}
+
+script.on_event(defines.events.on_gui_selection_state_changed, function(e)
+    local element = e.element
+    local handler = on_gui_selection_state_changed_handlers[element.name]
+    if handler then handler(e) end
+end)
+
+script.on_event(defines.events.on_gui_closed, function(e)
+    local player = game.players[e.player_index]
+    local element = e.element
+    if e.gui_type == defines.gui_type.custom then
+        if element and element.valid then
+            if element.name == 'hotpatch-IDE' then
+                if element.style.visible then
+                    player.play_sound{path = "utility/gui_click"}
+                end
+                element.style.visible = false
+            elseif element.name == 'hotpatch-console' then
+                if element.style.visible then
+                    player.play_sound{path = "utility/gui_click"}
+                end
+                element.style.visible = false
+            end
+        end
+    end
+end)
+
+]===])
+
+return true

lib/scenarios/Hotpatch/hotpatch/remote-interface.lua

@@ -0,0 +1,266 @@
+local hotpatch_tools = require 'hotpatch.mod-tools'
+hotpatch_tools.static_mod('hotpatch-remote-interface', '1.0.1', [===[
+--[[
+
+Copyright 2018 Chrisgbk
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]]
+-- MIT License, https://opensource.org/licenses/MIT
+
+local hotpatch_tools = require 'hotpatch.mod-tools'
+
+--load private API
+-- mod installation/uninstallation support functions
+-- These take a mod NAME as a first argument
+local install_mod = hotpatch_tools.install_mod
+local find_installed_mod = hotpatch_tools.find_installed_mod
+local install_mod_file = hotpatch_tools.install_mod_file
+local uninstall_mod = hotpatch_tools.uninstall_mod
+
+-- mod interaction functions
+-- These take a LOADED INDEX as a first argument, except load_mod, which takes an INSTALLED INDEX
+local load_mod = hotpatch_tools.load_mod
+local find_loaded_mod = hotpatch_tools.find_loaded_mod
+local run_mod = hotpatch_tools.run_mod
+local reset_mod = hotpatch_tools.reset_mod
+local reset_mod_events = hotpatch_tools.reset_mod_events
+local register_mod_events = hotpatch_tools.register_mod_events
+local unload_mod = hotpatch_tools.unload_mod
+
+-- internal callbacks when a mod registers events
+local register_event = hotpatch_tools.register_event
+local register_nth_tick = hotpatch_tools.register_nth_tick
+local register_on_tick = hotpatch_tools.register_on_tick
+
+-- mod bootstrap functions
+-- These take a LOADED INDEX as a first argument
+local mod_on_init = hotpatch_tools.mod_on_init
+local mod_on_load = hotpatch_tools.mod_on_load
+local mod_on_configuration_changed = hotpatch_tools.mod_on_configuration_changed
+
+local static_mods = hotpatch_tools.static_mods
+local console = hotpatch_tools.console
+local debug_log = hotpatch_tools.debug_log
+local loaded_mods = hotpatch_tools.loaded_mods
+local installed_mods = hotpatch_tools.installed_mods
+
+local remote_interface = {}
+
+--IMPORTANT: WHEN COPY PASTING CODE TO CONSOLE THE CODE MUST HAVE SINGLE LINE COMMENTS REMOVED
+-- FACTORIO CONSOLE STRIPS LINEFEEDS WHICH MAKES ALL THE CODE BECOME COMMENTED OUT
+--TODO: gate these behind admin permissions; if (game.player and game.player.admin) should work for console commands?
+
+debug_log({'hotpatch-info.remote-installing'})
+
+remote_interface['install'] = function(mod_name, mod_version, mod_code, mod_files, only_install)
+    -- this installs a new mod and runs on_init, then registers events
+    -- Note that mods may expect that certain events haven't been called yet when their on_init is ran
+    -- This may prevent them from functioning properly, without manually calling the events they expect
+    -- examples: on_player_created
+    local caller = game.player or console
+    if caller.admin then
+        local installed_index = find_installed_mod(mod_name)
+        local loaded_index = find_loaded_mod(mod_name)
+        if installed_index then
+            local old_version = installed_mods[installed_index].version
+            if old_version then
+                debug_log('WARNING: mod already exists: ' .. mod_name .. ' ' .. old_version)
+                debug_log('WARNING: reinstalling mod in-place: ' .. mod_name .. ' ' .. mod_version)
+            end
+            if loaded_index then
+                unload_mod(loaded_index)
+            end
+        end
+        
+        install_mod(mod_name, mod_version, mod_code, mod_files)
+        if not only_install then
+            installed_index = find_installed_mod(mod_name)
+            if installed_index then
+                if not load_mod(installed_index) then
+                    caller.print('compilation failed for mod ' .. mod_name)
+                    return
+                end
+                loaded_index = find_loaded_mod(mod_name)
+                if loaded_index then
+                    if not run_mod(loaded_index) then
+                        caller.print('execution failed for mod ' .. mod_name)
+                        return
+                    end
+                    if not mod_on_init(loaded_index) then
+                        caller.print('on_init failed for mod ' .. mod_name)
+                        return
+                    end
+                    -- TODO: notify all mods
+                    -- TODO: determine vanilla behaviour and replicate it
+                    if not mod_on_configuration_changed(loaded_index, {mod_changes = {mod_name={new_version=version}}}) then
+                        caller.print('on_configuration_changed failed for mod ' .. mod_name)
+                        return
+                    end
+                else
+                end
+            else
+            end
+        end
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['run'] = function(mod_name)
+    -- this runs on_init, then registers events
+    -- Note that mods may expect that certain events haven't been called yet when their on_init is ran
+    -- This may prevent them from functioning properly, without manually calling the events they expect
+    -- examples: on_player_created
+    local caller = game.player or console
+    if caller.admin then
+        local installed_index = find_installed_mod(mod_name)
+        local loaded_index = find_loaded_mod(mod_name)
+        if installed_index and not loaded_index then
+            if not load_mod(installed_index) then
+                caller.print('compilation failed for mod ' .. mod_name)
+                return
+            end
+            loaded_index = find_loaded_mod(mod_name)
+        else
+            if loaded_index then
+                local mod = loaded_mods[loaded_index]
+                local version = mod.version
+                debug_log('WARNING: mod already loaded: ' .. mod_name .. ' ' .. version)
+                debug_log('WARNING: reinitializing: ' .. mod_name .. ' ' .. version)
+            end
+        end
+        
+        if loaded_index then
+            if not run_mod(loaded_index) then
+                caller.print('execution failed for mod ' .. mod_name)
+                return
+            end
+            if not mod_on_init(loaded_index) then
+                caller.print('on_init failed for mod ' .. mod_name)
+                return
+            end
+            -- TODO: notify all mods
+            -- TODO: determine vanilla behaviour and replicate it
+            if not mod_on_configuration_changed(loaded_index, {mod_changes = {mod_name={new_version=version}}}) then
+                caller.print('on_configuration_changed failed for mod ' .. mod_name)
+                return
+            end
+        end    
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['update'] = function(mod_name, mod_version, mod_code, mod_files)
+    -- this updates an existing mod
+    -- the current mods events are de-registered, the new code is installed, on_load is triggered, and then events are registered
+    -- finally, the mod is informed of the update, so it can run migrations from the previous version
+    -- TODO: validation
+    local caller = game.player or console
+    if caller.admin then
+        local installed_index = find_installed_mod(mod_name)
+        local loaded_index = find_loaded_mod(mod_name)
+        local old_version
+        if loaded_index then
+            old_version = loaded_mods[loaded_index].version
+            unload_mod(loaded_index)
+        end
+        install_mod(mod_name, mod_version, mod_code, mod_files)
+        installed_index = find_installed_mod(mod_name)
+        if not load_mod(installed_index) then
+            caller.print('compilation failed for mod ' .. mod_name)
+            return
+        end
+        loaded_index = find_loaded_mod(mod_name)
+        if not run_mod(loaded_index) then
+            caller.print('execution failed for mod ' .. mod_name)
+            return
+        end
+        if old_version then
+            if not mod_on_load(installed_index) then
+                caller.print('on_load failed for mod ' .. mod_name)
+                return
+            end
+            -- The mod must do any migrations here
+            -- TODO: notify all mods
+            if not mod_on_configuration_changed(installed_index, {mod_changes = {mod_name={old_version=old_version, new_version=mod_version}}}) then
+                caller.print('on_configuration_changed failed for mod ' .. mod_name)
+                return
+            end
+        else
+            -- first time install
+            if not mod_on_init(installed_index) then
+                caller.print('on_init failed for mod ' .. mod_name)
+                return
+            end
+            -- TODO: notify all mods
+            if not mod_on_configuration_changed(installed_index, {mod_changes = {mod_name={new_version=mod_version}}}) then
+                caller.print('on_configuration_changed failed for mod ' .. mod_name)
+                return
+            end
+        end
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['install_mod_file'] = function(mod_name, mod_file, mod_file_code)
+    local caller = game.player or console
+    if caller.admin then
+        install_mod_file(mod_name, mod_file, mod_file_code)
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+--TODO: most of this function
+remote_interface['clean'] = function(mod_name)
+    -- Removes ALL mod data and reinitializes
+    -- doesn't remove things a mod may add like surfaces, etc
+    local caller = game.player or console
+    if caller.admin then
+        mod_reset(mod_name)
+        run_mod(mod_name)
+        mod_on_init(mod_name)
+        mod_on_configuration_changed(mod_name, {mod_changes = {mod_name={new_version=mod_version}}})
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote_interface['uninstall'] = function(mod_name)
+    -- Uninstalls a mod
+    local caller = game.player or console
+    if caller.admin then
+        uninstall_mod(mod_name)
+    else
+        caller.print('You must be an admin to run this command.')
+    end
+end
+
+remote.add_interface('hotpatch', remote_interface)
+
+debug_log({'hotpatch-info.complete', {'hotpatch-info.remote-installing'}})
+
+]===])
+
+--[[
+
+remote.call('hotpatch, 'install', 'test', '1.0.0', [===[ 
+script.on_event(defines.events.on_player_changed_position, function(e) 
+    game.print('changed position') 
+end
+]===]
+
+local updated_code = ....
+remote.call('hotpatch', 'update', 'test', '1.0.1', updated_code)
+
+
+]]
+
+return true

lib/scenarios/Hotpatch/locale/en/hotpatch.cfg

@@ -0,0 +1,77 @@
+[hotpatch]
+log=@__1__:__2__] __3__
+log-mod=@__1__:__2__][__4__] __3__
+severe=SEVERE ERROR: __1__
+error=ERROR: __1__
+warning=WARNING: __1__
+info=INFO: __1__
+verbose=INFO: __1__
+trace=TRACE: __1__
+
+[hotpatch-info]
+logging-enabled=Logging enabled
+metatable-installed=_ENV metatable installed
+complete=__1__ Complete!
+on-init=initializing...
+on-load=loading...
+on-configuration-changed=mod configuration changed...
+installing-included-mods=installing included mods...
+loading-installed-mods=loading installed mods...
+loading-libs=loading Factorio.data.core.lualib...
+loading-library=loading library: __1__
+uninstalling=Uninstalling mod...
+installing=Installing version __1__...
+installing-file=Installing file __1__...
+script-shim=setting up mod script shim...
+setting-env=setting up mod _ENV...
+loading=loading...
+unloading=unloading...
+running=running...
+must-be-admin=You must be an admin to run this command
+remote-installing=installing remote interface
+
+[hotpatch-trace]
+nil-var-access=_ENV nil variable access: __1__
+nil-var-assignment=_ENV variable assignment: __1__
+event-registering=registering events...
+on-tick-event-registered=registered on_tick event...
+on-event-registered=registered event __1__...
+on-nth-tick-event-registered=registered nth_tick event __1__...
+event-running=running event __1__...
+nth-tick-event-running=running nth_event __1__...
+mod-on-init=running on_init...
+mod-on-load=running on_load...
+mod-on-configuration-changed=running on_configuration_changed...
+adding-event=adding event __1__
+adding-nth-tick-event=adding nth_tick event __1__
+caching-event=caching event: __1__...
+caching-nth-tick-event=caching nth_tick event: __1__...
+event-processing=processing event __1__...
+nth-tick-event-processing=processing nth_tick event __1__...
+nth-tick-handler-added=added nth_tick handler: __1__
+nth-tick-handler-removed=removed nth_tick handler: __1__
+on-tick-handler-added=added on_tick handler
+on-tick-handler-removed=removed on_tick handler
+on-event-handler-added=added event handler: __1__
+on-event-handler-removed=removed event handler: __1__
+cached-load-require=loading cached require'd file: __1__...
+load-require=loading require'd file: __1__...
+load-core-lib=loading from Factorio.data.core.lualib: __1__...
+
+[hotpatch-warning]
+contains-comments=mod code contains comments!
+contains-comments-no-lf=mod contains comments and no linefeed!
+contains-comments-console=comments from console will comment out the entire code!
+reset-events-not-running=tried to reset events for mod that isn't running!
+remote-interface-exists=remote interface __1__ already exists, removing...
+command-exists=command __1__ already exists, removing...
+already-loaded=mod already loaded
+reinitializing=reinitializing...
+already-exists=mod already exists
+reinstalling=reinstalling mod in-place
+
+[hotpatch-error]
+invalid-API-access=Invalid API access: __1__
+not-installed=mod not installed, cannot install file for mod that does not exist
+compilation-failed=compilation failed for mod
+execution-failed=execution failed for mod