Implement install patching

Author: SquidDev

bsrocks/bin/bsrocks.lua

@@ -89,12 +89,4 @@ addCommand({
 -- Default to printing help messages
 local foundCommand = getCommand(... or "help")
 local args = {...}
-xpcall(
-	function()
-		return foundCommand.execute(select(2, unpack(args)))
-	end,
-	function(message)
-		printError(message)
-		print(utils.traceback())
-	end
-)
+return foundCommand.execute(select(2, unpack(args)))

bsrocks/commands/admin/add.lua

@@ -1,16 +1,13 @@
 local download = require "bsrocks.downloaders"
 local fileWrapper = require "bsrocks.lib.files"
+local patchDirectory = require "bsrocks.lib.settings".patchDirectory
 local rockspec = require "bsrocks.rocks.rockspec"
 local serialize = require "bsrocks.lib.serialize"
-local settings = require "bsrocks.lib.settings"
-
-local patchDirectory = settings.patchDirectory
-local servers = settings.servers
 
 local function execute(name, version)
 	if not name then error("Expected name", 0) end
 
-	local server, manifest = rockspec.findRock(servers, name)
+	local server, manifest = rockspec.findRock(name)
 	if not server then
 		error("Cannot find '" .. name .. "'", 0)
 	end

bsrocks/commands/admin/fetch.lua

@@ -4,10 +4,7 @@ local log = require "bsrocks.lib.utils".log
 local patchspec = require "bsrocks.rocks.patchspec"
 local rockspec = require "bsrocks.rocks.rockspec"
 local serialize = require "bsrocks.lib.serialize"
-local settings = require "bsrocks.lib.settings"
-
-local patchDirectory = settings.patchDirectory
-local servers = settings.servers
+local patchDirectory = require "bsrocks.lib.settings".patchDirectory
 
 local function execute(...)
 	local patched, force
@@ -38,7 +35,7 @@ local function execute(...)
 				error("Patchspec" .. name .. " has no version", 0)
 			end
 
-			local server, manifest = rockspec.findRock(servers, name)
+			local server, manifest = rockspec.findRock(name)
 			if not server then
 				error("Cannot find '" .. name .. "'", 0)
 			end

bsrocks/downloaders/github.lua

@@ -1,8 +1,8 @@
 --- A downloader for GitHub repositories
 
-local download = require "bsrocks.downloaders.download"
+local tree = require "bsrocks.downloaders.tree"
 
-return function(source, files, settings)
+return function(source, files)
 	local url = source.url
 	if not url then return end
 
@@ -15,5 +15,5 @@ return function(source, files, settings)
 	end
 
 	print("Downloading " .. repo .. "@" .. branch)
-	return download('https://raw.github.com/'..repo..'/'..branch..'/', files, settings.tries, settings.callback)
+	return tree('https://raw.github.com/'..repo..'/'..branch..'/', files)
 end

bsrocks/downloaders/init.lua

@@ -2,27 +2,9 @@ local downloaders = {
 	require "bsrocks.downloaders.github",
 }
 
-local tries = require "bsrocks.lib.settings".tries
-
-local settings = {
-	tries = tries,
-	callback = function(success, path, count, total)
-		if not success then
-			local x, y = term.getCursorPos()
-			term.setCursorPos(1, y)
-			term.clearLine()
-			printError("Cannot download " .. path)
-		end
-
-		local x, y = term.getCursorPos()
-		term.setCursorPos(1, y)
-		term.clearLine()
-		write(("Downloading: %s/%s (%s%%)"):format(count, total, count / total * 100))
-	end
-}
 return function(source, files)
 	for _, downloader in ipairs(downloaders) do
-		local files = downloader(source, files, settings)
+		local files = downloader(source, files)
 		if files then
 			print()
 			return files

bsrocks/downloaders/download.lua bsrocks/downloaders/tree.lua

@@ -1,9 +1,24 @@
+local function callback(success, path, count, total)
+	if not success then
+		local x, y = term.getCursorPos()
+		term.setCursorPos(1, y)
+		term.clearLine()
+		printError("Cannot download " .. path)
+	end
+
+	local x, y = term.getCursorPos()
+	term.setCursorPos(1, y)
+	term.clearLine()
+	write(("Downloading: %s/%s (%s%%)"):format(count, total, count / total * 100))
+end
+
+local tries = require "bsrocks.lib.settings".tries
+
 --- Download individual files
 -- @tparam string prefix The url prefix to use
 -- @tparam table files The list of files to download
 -- @tparam int tries Number of times to attempt to download
--- @tparam (success:boolean, path:string, count:int, total:int)->nil callback Function to call on download progress
-return function(prefix, files, tries, callback)
+local function tree(prefix, files)
 	local result = {}
 
 	local count = 0
@@ -47,3 +62,5 @@ return function(prefix, files, tries, callback)
 
 	return result
 end
+
+return tree

bsrocks/rocks/dependencies.lua

@@ -109,7 +109,7 @@ local function parseVersion(vstring)
 			-- extract a word
 			token, rest = vstring:match("^(%a+)[%.%-%_]*(.*)")
 			if not token then
-				util.printerr("Warning: version number '"..vstring.."' could not be parsed.")
+				error("Warning: version number '"..vstring.."' could not be parsed.", 0)
 
 				if not version[i] then version[i] = 0 end
 				break

bsrocks/rocks/install.lua

@@ -1,25 +1,36 @@
 local dependencies = require "bsrocks.rocks.dependencies"
 local download = require "bsrocks.downloaders"
 local fileWrapper = require "bsrocks.lib.files"
+local log = require "bsrocks.lib.utils".log
+local patchspec = require "bsrocks.rocks.patchspec"
 local rockspec = require "bsrocks.rocks.rockspec"
 local serialize = require "bsrocks.lib.serialize"
 local settings = require "bsrocks.lib.settings"
-local utils = require "bsrocks.lib.utils"
+local tree = require "bsrocks.downloaders.tree"
 
 local installDirectory = settings.installDirectory
-local servers = settings.servers
-local patchServers = settings.patchServers
 
 local fetched = false
 local installed = {}
 
-local function save(rockS)
-	local files = rockspec.extractFiles(rockS)
+local function save(rockS, patchS)
+	local blacklist = {}
+	if patchspec and patchspec.remove then
+		for _, v in ipairs(patchspec.remove) do blacklist[v] = true end
+	end
 
+	local files = rockspec.extractFiles(rockS, blacklist)
 	local downloaded = download(rockS.source, files)
 
 	if not downloaded then
-		error("Cannot find downloader for " .. rockS.source.url)
+		error("Cannot find downloader for " .. rockS.source.url, 0)
+	end
+
+	if patchS then
+		local patchFiles = rockspec.extractFiles(patchS)
+		local downloadPatch = tree(patchFiles.server .. '/' .. rockS.name, patchFiles)
+
+		files = applyPatches(downloaded, downloadPatch, patchS.patches or {}, patchS.added or {}, patchS.removed or {})
 	end
 
 	rockspec.saveFiles(rockS, downloaded, installDirectory)
@@ -49,21 +60,30 @@ local function getInstalled()
 end
 
 local function install(name, version, constraints)
-	local server, manifest = rockspec.findRock(servers, name)
+	-- Do the cheapest action ASAP
+	local versions = getInstalled()
+	local current = versions[name]
+	if current and (version == nil or current.version == version) then
+		error("Already installed", 0)
+	end
+
+	local server, manifest = rockspec.findRock(name)
+
 	if not server then
-		error("Cannot find '" .. name .. "'")
+		error("Cannot find '" .. name .. "'", 0)
 	end
 
+	local patchspec = patchspec.findPatchspec(name)
 	if not version then
-		version = rockspec.latestVersion(manifest, name, constraints)
+		if patchspec then
+			version = patchspec.version
+		else
+			version = rockspec.latestVersion(manifest, name, constraints)
+		end
 	end
 
-	local versions = getInstalled()
-	local current = versions[name]
-	if current then
-		if current.version == version then
-			error("Already installed")
-		end
+	if current and current.version == version then
+		error("Already installed", 0)
 	end
 
 	local rockspec = rockspec.fetchRockspec(server, name, version)
@@ -77,15 +97,15 @@ local function install(name, version, constraints)
 		if current then
 			local version = dependencies.parseVersion(current.version)
 			if not dependencies.matchConstraints(version, dependency.constraints) then
-				print("Should update " .. dependency.name .. " ( got " .. current.version .. ", need " .. deps .. ")")
+				log("Should update " .. dependency.name .. " ( got " .. current.version .. ", need " .. deps .. ")")
 			end
 		else
-			print("Installing dependency " .. name)
+			log("Installing dependency " .. name)
 			install(name, nil, dependency.constraints)
 		end
 	end
 
-	save(rockspec)
+	save(rockspec, patchspec)
 end
 
 return {

bsrocks/rocks/patchspec.lua

@@ -1,25 +1,32 @@
 local diff = require "bsrocks.lib.diffmatchpatch"
-local unserialize = require "bsrocks.lib.serialize".unserialize
 local fileWrapper = require "bsrocks.lib.files"
-local patchDirectory = require "bsrocks.lib.settings".patchDirectory
+local log = require "bsrocks.lib.utils".log
+local settings = require "bsrocks.lib.settings"
+local unserialize = require "bsrocks.lib.serialize".unserialize
+
+local patchDirectory, servers = settings.patchDirectory, settings.patchServers
 
 local cache = {}
-local function fetchPatchspec(servers, name)
+local function findPatchspec(name)
 	local result = cache[name] or false
 	if result then return result end
 
+	log("Fetching patchspec for " .. name)
+	local patchS = name .. ".patchspec"
+
 	for _, server in ipairs(servers) do
-		local handle = http.get(servers .. name)
+		local handle = http.get(server .. patchS)
 		if handle then
 			local contents = handle.readAll()
 			handle.close()
 
-			result = unserialize(contenets)
+			result = unserialize(contents)
+			result.server = server
 			break
 		end
 	end
 
-	cache[name] = result
+	cache[name] = result or false
 	return result
 end
 
@@ -40,6 +47,26 @@ local function getAll()
 	return installed
 end
 
+local function extractFiles(patch)
+	local files, n = {}, 0
+
+	if patch.added then
+		for _, file in ipairs(patch.added) do
+			n = n + 1
+			files[n] = file
+		end
+	end
+
+	if patch.patches then
+		for _, file in ipairs(patch.patches) do
+			n = n + 1
+			files[n] = file .. ".patch"
+		end
+	end
+
+	return files
+end
+
 local function makePatches(original, changed)
 	local patches, remove = {}, {}
 	local files = {}
@@ -125,8 +152,9 @@ local function applyPatches(original, files, patches, added, removed)
 end
 
 return {
-	fetchPatchspec = fetchPatchspec,
+	findPatchspec = findPatchspec,
 	makePatches = makePatches,
 	applyPatches = applyPatches,
+	extractFiles = extractFiles,
 	getAll = getAll,
 }