Module:Utils

Documentation for this module may be created at ModuleDoc:Utils

local utils = {}

function utils.defaultIfEmpty( val, default )
	if val == nil or val == '' then
		return default
	else
		return val
	end
end

function utils.loadDataIfExists( name )
	local success, data = pcall( mw.loadData, name )
	if success then
		return data
	else
		return nil
	end
end

function generateErrorWikitext( message, type, category, template )
	local debug_str = ''
	if template == nil then
		-- Find the first frame whose title doesn't begin with 'Template:'
		local prevFrame = mw.getCurrentFrame()
		local frame = prevFrame:getParent()
		while frame ~= nil and frame:getTitle() ~= nil and mw.ustring.sub( frame:getTitle(), 1, 9 ) == 'Template:' do
			prevFrame = frame
			frame = prevFrame:getParent()
			debug_str = debug_str .. '>' .. prevFrame:getTitle()
		end
		if frame ~= nil then
			debug_str = debug_str .. '>' .. frame:getTitle()
		end
		-- Use the frame immediately before that as the template that is giving
		-- the error
		if mw.ustring.sub( prevFrame:getTitle(), 1, 9 ) == 'Template:' then
			-- Strip the 'Template:' part out
			template = mw.ustring.sub( prevFrame:getTitle(), 10 )
		end
	end
	
	local wikitext = [[''']]
		.. string.upper( type )
		.. [[:''' ]]
		.. message .. debug_str
	if template ~= nil then
		wikitext = wikitext .. ' (Template: [[Template:'
			.. template
			.. '|'
			.. template
			.. ']])'
	end

	local categorylink = '[[Category:' .. category .. ']]'
	
	return wikitext, categorylink
end

function utils.error( ... )
	-- Collect necessary information to display error
	local message = tostring( utils.defaultIfEmpty( select( 1, ... ), 'There was an error with a template. Are the parameters all correct?' ) )
	local etype = tostring( utils.defaultIfEmpty( select( 2, ... ), 'Template' ) )
	local category = tostring( utils.defaultIfEmpty( select( 3, ... ), 'Pages containing template errors' ) )
	local template = utils.defaultIfEmpty( select( 4, ... ), nil )
	
	-- Generate  data 
	local wikitext, categorylink = generateErrorWikitext( message, etype .. ' error', category, template )
	
	-- Add custom styling
	wikitext = [[<span class="error halopedia-template-error" style="color: red;">]] .. wikitext .. [[</span>]]
	
	-- Add a warning to the edit preview
	mw.addWarning( wikitext )
	
	-- Create and return the text to display on the page itself
	return wikitext .. ' ' .. categorylink
end

function utils.warning( ... )
	-- Collect necessary information to display error
	local message = tostring( utils.defaultIfEmpty( select( 1, ... ), 'This template issued a warning. Are the parameters all correct?' ) )
	local wtype = tostring( utils.defaultIfEmpty( select( 2, ... ), 'Template' ) )
	local category = tostring( utils.defaultIfEmpty( select( 3, ... ), 'Pages containing template warnings' ) )
	local template = utils.defaultIfEmpty( select( 4, ... ), nil )
	
	-- Generate  data 
	local wikitext, categorylink = generateErrorWikitext( message, wtype .. ' warning', category, template )
	
	-- Add custom styling
	wikitext = [[<span class="warning halopedia-template-warning" style="color: orange;">]] .. wikitext .. [[</span>]]
	
	-- Add the warning to the edit preview
	mw.addWarning( wikitext )
	
	-- Create and return the text to add to the page. In this case, we only add
	-- the category - no message, as warnings should be silent to the reader
	return categorylink
end

return utils