Merge pull request GmodStarfall#122 from Xandaros/permissions

Permissions!

Author: awilliamson

lua/entities/starfall_screen/cl_init.lua

@@ -5,7 +5,7 @@ ENT.RenderGroup = RENDERGROUP_OPAQUE
 include( "starfall/SFLib.lua" )
 assert( SF, "Starfall didn't load correctly!" )
 
-local context = SF.CreateContext( nil, nil, nil, nil, SF.Libraries.CreateLocalTbl{ "render" } )
+local context = SF.CreateContext( nil, nil, nil, SF.Libraries.CreateLocalTbl{"render"} )
 
 surface.CreateFont( "Starfall_ErrorFont", {
 	font = "arial",

lua/starfall/compiler.lua

@@ -36,7 +36,6 @@ function SF.Compiler.Compile(code, context, mainfile, player, data, dontpreproce
 	instance.initialized = false
 	instance.context = context
 	instance.mainfile = mainfile
-	instance.permissions = setmetatable({},context.permissions)
 
 	for filename, source in pairs(code) do
 		if not dontpreprocess then
@@ -56,6 +55,5 @@ function SF.Compiler.Compile(code, context, mainfile, player, data, dontpreproce
 		end
 	end
 
-	instance.permissions:assign(instance)
 	return true, instance
 end

lua/starfall/database.lua

@@ -0,0 +1,56 @@
+SF.DB = {}
+
+SF.DB.query = sql.Query
+SF.DB.querySingleValue = sql.QueryValue
+
+function SF.DB.querySingleRow ( query )
+	return sql.QueryRow( query, 0 )
+end
+
+function SF.DB.escape ( str )
+	return sql.SQLStr( str ):sub( 2, -2 )
+end
+
+local function queryMultiple ( statements )
+	local ret = nil
+	for k,v in pairs( statements ) do
+		ret = sql.Query( v )
+		if ret == false then break end
+	end
+	return ret
+end
+
+-- check whether the tables exist and, if not, import the schema
+if sql.TableExists( "starfall_meta" ) then
+	local version = sql.QueryValue(
+			"SELECT value FROM starfall_meta WHERE key='schema_version'" )
+	if not version then
+		error( "starfall tables exists but couldn't get schema version" )
+	elseif "0.1" ~= version then
+		error( "starfall DB schema exists but is wrong version" )
+	end
+else
+	sql.Begin()
+	local result = queryMultiple( {
+	[==[	-- bits of meta-information about Starfall
+		CREATE TABLE starfall_meta (
+			key TEXT NOT NULL PRIMARY KEY,
+			value TEXT NOT NULL
+		)]==],
+
+	[==[	INSERT INTO starfall_meta VALUES ("schema_version", "0.1")]==],
+
+	[==[	-- grants permissions to roles
+		CREATE TABLE starfall_perms_grants (
+			role INTEGER NOT NULL, -- 0 = user, 1 = admin, 2 = superadmin
+			key TEXT NOT NULL,
+			grant INTEGER CHECK (grant IN (0, 1, 2)), -- 0 = NEUTRAL, 1 = ALLOW, 2 = DENY
+			PRIMARY KEY (role, key)
+		)]==]
+	} )
+	sql.Commit()
+
+	if result == false then
+		error( "error importing Starfall schema " .. sql.LastError() )
+	end
+end

lua/starfall/instance.lua

@@ -17,7 +17,6 @@ SF.Instance.__index = SF.Instance
 -- @field hooks Registered hooks
 -- @field scripts The compiled script functions.
 -- @field initialized True if initialized, nil if not.
--- @field permissions Permissions manager
 -- @field error True if instance is errored and should not be executed
 -- @field mainfile The main file
 -- @field player The "owner" of the instance

lua/starfall/libs_cl/entities.lua

@@ -8,13 +8,6 @@ local ents_lib = SF.Entities.Library
 local ents_metatable = SF.Entities.Metatable
 local wrap, unwrap = SF.Entities.Wrap, SF.Entities.Unwrap
 
-SF.Permissions:registerPermission({
-	name = "Modify Entities",
-	desc = "Allow modification of entities clientside",
-	level = 1,
-	value = false,
-})
-
 local isValid = SF.Entities.IsValid
 local getPhysObject = SF.Entities.GetPhysObject
 

lua/starfall/libs_sh/entities.lua

@@ -13,6 +13,12 @@ local wrap, unwrap = SF.CreateWrapper(ents_metamethods,true,true,debug.getregist
 -- @shared
 local ents_lib, _ = SF.Libraries.Register("entities")
 
+-- Register privileges
+do
+	local P = SF.Permissions
+	P.registerPrivilege( "entities.setColor", "Set Color", "Allows the user to change the color of an entity" )
+end
+
 -- ------------------------- Internal functions ------------------------- --
 
 SF.Entities.Wrap = wrap
@@ -94,6 +100,7 @@ function ents_methods:setColor( clr )
 
 	local this = unwrap( self )
 	if IsValid( this ) then
+		if not SF.Permissions.check( SF.instance.player, this, "entities.setColor" ) then return end
 		this:SetColor( clr )
 		this:SetRenderMode( clr.a == 255 and RENDERMODE_NORMAL or RENDERMODE_TRANSALPHA )
 	end

lua/starfall/libs_sh/files.lua

@@ -1,4 +1,4 @@
---- TODO: Permissions System before fixing this.
+--- TODO: fix this.
 --- TODO: Add VON encoding of any table's that are passed, work on 'universal' serializer and deserializer
 -------------------------------------------------------------------------------
 -- File functions
@@ -8,20 +8,13 @@
 -- @shared
 local files_library, _ = SF.Libraries.Register("files")
 
---- Access Files permission
--- @name Access Files Permission
--- @class table
--- @field name "Access Files"
--- @field desc "Allows access to data/starfallscriptdata/"
--- @field level 1
--- @field value True if clientside, false if serverside
-
-SF.Permissions:registerPermission({
-	name = "Access Files",
-	desc = "Allows access to data/starfallscriptdata/",
-	level = 1,
-	value = 1,
-})
+-- Register privileges
+do
+	local P = SF.Permissions
+	P.registerPrivilege( "file.read", "Read files", "Allows the user to read files from data/starfallscript directory" )
+	P.registerPrivilege( "file.write", "Write files", "Allows the user to write files to data/starfallscript directory" )
+	P.registerPrivilege( "file.exists", "efile xistence check", "Allows the user to determine whether a file data/starfallscript exists" )
+end
 
 file.CreateDir("starfallscriptdata/")
 
@@ -30,9 +23,9 @@ file.CreateDir("starfallscriptdata/")
 -- @return Contents, or nil if error
 -- @return Error message if applicable
 function files_library.read(path)
+	if not SF.Permissions.check( SF.instance.player, path, "file.read" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(path, "string")
 	if path:find("..",1,true) then error("path contains '..'") return end
-	if not SF.instance.permissions:checkPermission("Access Files") then error("access denied") return end
 	local contents = file.Read("starfallscriptdata/"..path, "DATA")
 	if contents then return contents else error("file not found") return end
 end
@@ -42,10 +35,10 @@ end
 -- @return True if OK, nil if error
 -- @return Error message if applicable
 function files_library.write(path, data)
+	if not SF.Permissions.check( SF.instance.player, path, "file.write" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(path, "string")
 	SF.CheckType(data, "string")
 	if path:find("..",1,true) then error("path contains '..'") return end
-	if not SF.instance.permissions:checkPermission("Access Files") then error("access denied") return end
 	file.Write("starfallscriptdata/"..path, data)
 	return true
 end
@@ -55,10 +48,10 @@ end
 -- @param data String that will be appended to the file.
 -- @return Error message if applicable
 function files_library.append(path,data)
+	if not SF.Permissions.check( SF.instance.player, path, "file.write" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(path, "string")
 	SF.CheckType(data, "string")
 	if path:find("..",1,true) then error("path contains '..'") return end
-	if not SF.instance.permissions:checkPermission("Access Files") then error("access denied") return end
 	file.Append("starfallscriptdata/"..path, data)
 	return true
 end
@@ -68,9 +61,9 @@ end
 -- @return True if exists, false if not, nil if error
 -- @return Error message if applicable
 function files_library.exists(path)
+	if not SF.Permissions.check( SF.instance.player, path, "file.exists" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(path, "string")
 	if path:find("..",1,true) then error("path contains '..'") return end
-	if not SF.instance.permissions:checkPermission("Access Files") then error("access denied") return end
 	return file.Exists("starfallscriptdata/"..path, "DATA")
 end
 
@@ -79,9 +72,9 @@ end
 -- @return True if successful, nil if error
 -- @return Error message if applicable
 function files_library.delete(path)
+	if not SF.Permissions.check( SF.instance.player, path, "file.write" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(path, "string")
 	if path:find("..",1,true) then error("path contains '..'") return end
-	if not SF.instance.permissions:checkPermission("Access Files") then error("access denied") return end
 	if not file.Exists("starfallscriptdata/"..path, "DATA") then error("doesn't exist") return end
 	file.Delete(path)
 	return true

lua/starfall/libs_sh/find.lua

@@ -6,6 +6,12 @@
 -- @shared
 local find_library, _ = SF.Libraries.Register("find")
 
+-- Register privileges
+do
+	local P = SF.Permissions
+	P.registerPrivilege( "find", "Find", "Allows the user to access the find library" )
+end
+
 local find_cooldown
 if SERVER then
 	find_cooldown = CreateConVar("sf_find_cooldown_sv", "0.01", {FCVAR_REPLICATED, FCVAR_ARCHIVE, FCVAR_DONTRECORD})
@@ -41,6 +47,7 @@ end
 --- Checks if a find function can be performed
 -- @return True if find functions can be used
 function find_library.canFind()
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then return false end
 	local data = SF.instance.data
 	if not data.findcooldown then data.findcooldown = 0 end
 	return data.findcooldown <= CurTime()
@@ -52,6 +59,7 @@ end
 -- @param filter Optional function to filter results
 -- @return An array of found entities
 function find_library.inBox(min, max, filter)
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(min,"Vector")
 	SF.CheckType(max,"Vector")
 	if filter then SF.CheckType(filter,"function") end
@@ -68,6 +76,7 @@ end
 -- @param filter Optional function to filter results
 -- @return An array of found entities
 function find_library.inSphere(center, radius, filter)
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(center,"Vector")
 	SF.CheckType(radius,"number")
 
@@ -85,6 +94,7 @@ end
 -- @param filter Optional function to filter results
 -- @return An array of found entities
 function find_library.inCone(pos, dir, distance, radius, filter)
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(pos,"Vector")
 	SF.CheckType(dir,"Vector")
 	SF.CheckType(distance,"number")
@@ -101,6 +111,7 @@ end
 -- @param filter Optional function to filter results
 -- @return An array of found entities
 function find_library.byClass(class, filter)
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(class,"string")
 
 	local instance = SF.instance
@@ -114,6 +125,7 @@ end
 -- @param filter Optional function to filter results
 -- @return An array of found entities
 function find_library.byModel(model, filter)
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(model,"string")
 
 	local instance = SF.instance
@@ -126,6 +138,7 @@ end
 -- @param filter Optional function to filter results
 -- @return An array of found entities
 function find_library.allPlayers(filter)
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then SF.throw( "Insufficient permissions", 2 ) end
 	local instance = SF.instance
 	if not updateCooldown( instance ) then SF.throw( "You cannot run a find right now; use 'find_library.canFind()'", 2 ) end
 
@@ -136,6 +149,7 @@ end
 -- @param filter Optional function to filter results
 -- @return An array of found entities
 function find_library.all(filter)
+	if not SF.Permissions.check( SF.instance.player, nil, "find" ) then SF.throw( "Insufficient permissions", 2 ) end
 	local instance = SF.instance
 	if not updateCooldown(instance) then SF.throw( "You cannot run a find right now; use 'find_library.canFind()'", 2 ) end
 

lua/starfall/libs_sh/sound.lua

@@ -1,4 +1,3 @@
-
 --- Sound functions. Plays and manipulates sounds, optionally
 -- attaching them to an entity.
 
@@ -8,13 +7,21 @@ local sound_library, _ = SF.Libraries.Register("sounds")
 local sound_methods, sound_metamethods = SF.Typedef("Sound")
 local wrap, unwrap = SF.CreateWrapper(sound_metamethods,true,false)
 
+-- Register privileges
+do
+	local P = SF.Permissions
+	P.registerPrivilege( "sound.create", "Sound", "Allows the user to create sounds" )
+	P.registerPrivilege( "sound.modify", "Sound", "Allows the user to modify sounds" )
+end
+
 --- Creates a sound and attaches it to an entity. You need to do sound:Play() before
 -- the sound will play however.
 -- @param path Filepath to the sound file
 -- @param entity Entity playing the sound
 -- @return The sound object. Keep this around to ensure it isn't GC'd (and thus stopped)
 -- before it is done playing.
 function sound_library.create(entity, path)
+	if not SF.Permissions.check( SF.instance.player, path, "sound.create" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(path, "string")
 	SF.CheckType(entity, SF.Entities.Metatable)
 	if path:match('["?]') then SF.throw( "Invalid sound path: " .. path, 2 ) end
@@ -28,6 +35,7 @@ end
 -- @param amplitude (Optinal) Loudness of the sound, from 0 to 255
 -- @param pitch (Optional) Pitch percent, from 0 to 255
 function sound_library.emitWorld(origin, path, amplitude, pitch)
+	if not SF.Permissions.check( SF.instance.player, path, "sound.create" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(path, "string")
 	SF.CheckType(origin, "Vector")
 	if amplitude then
@@ -48,6 +56,7 @@ end
 -- @param soundlevel (Optional) The sound level. See sound:setLevel() for more info
 -- @param pitch (Optional) Pitch percent, from 0 to 255
 function sound_library.emitEntity(entity, path, soundlevel, pitch)
+	if not SF.Permissions.check( SF.instance.player, path, "sound.create" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(entity, SF.Entities.Metatable)
 	SF.CheckType(path, "string")
 	if soundlevel then
@@ -77,6 +86,7 @@ end
 
 --- Plays the sound.
 function sound_methods:play()
+	if not SF.Permissions.check( SF.instance.player, this, "sound.modify" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(self, sound_metamethods)
 	unwrap(self):Play()
 end
@@ -85,6 +95,7 @@ end
 -- @param pitch The sound pitch as a percent from 0 to 255
 -- @param delta (Optinal) The transition time between the current pitch and the new one
 function sound_methods:setPitch(pitch, delta)
+	if not SF.Permissions.check( SF.instance.player, this, "sound.modify" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(self, sound_metamethods)
 	SF.CheckType(pitch, "number")
 	if delta then
@@ -97,6 +108,7 @@ end
 --- Sets the sound volume
 -- @param vol Volume as a percent between 0 and 1
 function sound_methods:setVolume(vol)
+	if not SF.Permissions.check( SF.instance.player, this, "sound.modify" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(self, sound_metamethods)
 	SF.CheckType(vol, "number")
 	unwrap(self):ChangeVolume(math.Clamp(vol,0,1))
@@ -107,6 +119,7 @@ end
 -- (use decibel value from the 'code' column, not the actual enum or 'value' column).
 -- @param level New level
 function sound_methods:setLevel(level)
+	if not SF.Permissions.check( SF.instance.player, this, "sound.modify" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(self, sound_metamethods)
 	SF.CheckType(level, "number")
 	unwrap(self):SetSoundLevel(math.Clamp(level, 0, 511))
@@ -115,6 +128,7 @@ end
 --- Stops or fades out the sound.
 -- @param fade (Optional) Time, in seconds, to fade out the sound. Not given = stop immediately
 function sound_methods:stop(fade)
+	if not SF.Permissions.check( SF.instance.player, this, "sound.modify" ) then SF.throw( "Insufficient permissions", 2 ) end
 	SF.CheckType(self, sound_metamethods)
 	if fade then
 		SF.CheckType(fade, "number")