Module:ugly hacks

Definition from Wiktionary, the free dictionary
Jump to: navigation, search

This module provides templates with functions which cannot be accessed any other way. When a function is not used, it should be removed.

Avoid using this module. If you find yourself writing a template which needs it, consider re-writing the template in Lua.

This module tracks templates in which its functions are used, using the tracking template mechanism; the tracking templates' names are of the form Template:tracking/ugly hacks/function_name and Template:tracking/ugly hacks/function_name/from template_name. To prevent it from becoming ineffective, wrappers around functions in this module should not be created; the {{#invoke:}} should be put directly where it is needed.

To further discourage their use, functions in this module are intentionally undocumented. To discover their usage purpose and syntax, please refer to mw:Extension:Scribunto/Lua reference manual.

Questions about this module and its possible replacements may be raised at Wiktionary:Grease pit.


local export = {}

function export.explode(frame)
	local wanted_index = tonumber(frame.args[3])
 
	local count = 1
	for item in mw.text.gsplit(frame.args[1], frame.args[2], true) do
		if count == wanted_index then
			return item
		end
		count = count + 1	
	end
	
	return ""
end

function export.substr(frame)
	return mw.ustring.sub(frame.args[1] or "", tonumber(frame.args[2]) or 1, tonumber(frame.args[3]) or -1)
end

function export.find(frame)
	return mw.ustring.find(frame.args[1] or "", frame.args[2] or "", 1, true) or ""
end

function export.find_pattern(frame)
	return mw.ustring.find(frame.args[1] or "", frame.args[2] or "", 1, false) or ""
end

function export.replace(frame)
	return (mw.ustring.gsub(frame.args[1] or "", frame.args[2] or "", frame.args[3] or ""))
end

function export.match(frame)
	return (mw.ustring.match(frame.args[1] or "", frame.args[2] or ""))
end

function export.escape_wiki(frame)
	return mw.text.nowiki(frame.args[1] or "")
end

function export.escape_html(frame)
	return mw.text.encode(frame.args[1] or "")
end

function export.resolve_redirect(frame)
	local title = mw.title.new(frame.args[1])
	if title.isRedirect then
		return string.match(title:getContent(), "^#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]]-)%]%]")
	else
		return frame.args[1]
	end
end

function export.is_valid_page_name(frame)
	local res = mw.title.new(frame.args[1])
	if res then
		return "valid"
	else
		return ""
	end
end

function export.check_for_extra_args(frame)
	local allowed = {}
	for k, v in ipairs(frame.args) do
		allowed[v] = true
	end
	for k, v in pairs(frame:getParent().args) do
		if not allowed[tostring(k)] then
			return "[[Category:" .. (frame.args["cat"] or "Templates needing attention") .. "]]"
		end
	end
	return ""
end

return setmetatable({ }, {
	__index = function(self, key)
		local m_debug = require('Module:debug')
		local frame = mw.getCurrentFrame()
		local pframe = frame:getParent()
		local tname = pframe and pframe:getTitle()

		m_debug.track('ugly hacks/' .. key)
		if pframe then
			m_debug.track('ugly hacks/' .. key .. '/from ' .. tname)
		else
			mw.log(debug.traceback('ugly hacks: parent frame not available'))
		end
		return export[key]	
	end
})