Modul:documentation

local export = {}

-- it is either here, or in ], and it is not in ugly hacks.
function export.CONTENTMODEL()
	return mw.title.getCurrentTitle().contentModel
end

local skins = {
	 = "";
	 = "Vector";
	 = "Monobook";
	 = "Cologne Blue";
	 = "Modern";
}

local Array = require "Module:array"

local function compare_pages(page1, page2, text)
	return "[" .. tostring(
		mw.uri.fullUrl("Special:ComparePages", { page1 = page1, page2 = page2 }))
		.. " " .. text .. "]"
end

local function page_exists(title)
	local success, title_obj = pcall(mw.title.new, title)
	return success and title_obj.exists
end

-- Avoid transcluding ] everywhere.
local lang_cache = setmetatable({}, { __index = function (self, k)
	return require "Module:languages/cache"
end })

local function zh_link(word)
	return require("Module:links").full_link{
		lang = lang_cache.zh,
		term = word
	}
end

local function make_Unicode_data_documentation(title, cats)
	local subpage, first_three_of_code_point
		= title.fullText:match("^Modul:Unicode data/(+)/(%x%x%x)$")
	if subpage == "names" or subpage == "images" then
		local low, high =
			tonumber(first_three_of_code_point .. "000", 16),
			tonumber(first_three_of_code_point .. "FFF", 16)
		return string.format(
			"This data module contains the %s of " ..
			"] code points within the range U+%04X to U+%04X.",
			subpage == "images" and "titles of images" or "names",
			low, high)
	end
end

-- This provides categories and documentation for various data modules, so that
-- ] isn’t unnecessarily cluttered.
-- It is a list of tables, each of which have three possible fields:

-- The “regex” field is required. It is a Lua pattern to match the module’s
-- title. If it matches, the data will be used. If the pattern contains one
-- capture, and a category has been specified, the capture will be used as a
-- sortkey.

-- The “doc” field is required. This may be a function or a
-- string. If it is a function, it receives a title and an array (see
-- ]) of categories that will be added to the documentation as
-- its first and second arguments, and may return a string, which will be used
-- as documentation. If it is a string, it is the name of a submodule under
-- “Module:documentation/functions/” which returns a function, of the same type
-- as described above.

-- The “cat” field is optional. It is a category in which the module should be
-- placed. The inner part of the category link is generated as follows:
-- mw.ustring.gsub(full_title, cat_field)
-- So if the “cat” field is present, the “regex” field should match the whole
-- title, and if there is “|%1” at the end of the “cat” field, for a sortkey,
-- there should be one capture in the “regex” field.
local module_regex = {
	{
		regex = "^Modul:languages/.+$",
		cat = "Modules dealing with languages and scripts",
	},
	{
		regex = "^Modul:scripts/.+$",
		cat = "Modules dealing with languages and scripts",
	},
	{
		regex = "^Modul:data tables/data..?.?.?$",
		cat = "Reference module sharded data tables",
	},
	{
		regex = "^Modul:Quotations/...?.?.?.?.?.?$",
		cat = "Quotation data modules",
	},
	{
		regex = "^Modul:zh/data/dial%-pron/.+$",
		cat = "Chinese dialectal pronunciation data modules",
		doc = "zh dial or syn",
	},
	{
		regex = "^Modul:zh/data/dial%-syn/.+$",
		cat = "Chinese dialectal synonyms data modules",
		doc = "zh dial or syn",
	},
	{
		regex = "^Modul:zh/data/glyph%-data/.+$",
		cat = "Chinese historical character forms data modules",
		doc = function(title, cats)
			local character = title.fullText:match("^Modul:zh/data/glyph%-data/(.+)")
			if character then
				return ("This module contains data on historical forms of the Chinese character %s.")
					:format(zh_link(character))
			end
		end,
	},
	{
		regex = "^Modul:zh/data/ltc%-pron/(.+)$",
		cat = "Middle Chinese pronunciation data modules|%1",
		doc = "zh data",
	},
	{
		regex = "^Modul:zh/data/och%-pron%-BS/(.+)$",
		cat = "Old Chinese (Baxter-Sagart) pronunciation data modules|%1",
		doc = "zh data",
	},
	{
		regex = "^Modul:zh/data/och%-pron%-ZS/(.+)$",
		cat = "Old Chinese (Zhengzhang) pronunciation data modules|%1",
		doc = "zh data",
	},
	-- capture rest of zh/data submodules
	{
		regex = "^Modul:zh/data/(.+)$",
		cat = "Chinese data modules|%1",
	},
	{
		regex = "^Modul:mul/guoxue%-data/cjk%-?(.*)$",
		cat = nil,
		doc = "guoxue-data",
	},
	{
		regex = "^Modul:Unicode data/(.+)$",
		cat = "Unicode data modules|%1",
		doc = make_Unicode_data_documentation,
	},
	{
		regex = "^Modul:number list/data/(.+)$",
		cat = nil, -- category added by doc function
		doc = "number list",
	},
	{
		regex = "^Modul:accel/(.+)$",
		cat = nil,
		doc = function(title, cats)
			local lang_code = title.subpageText
			local lang = lang_cache
			if lang then
				cats:insert(lang:getCanonicalName() .. " modules|accel")
				cats:insert(("Accel submodules|%s"):format(lang:getCanonicalName()))
				return ("This module contains new entry creation rules for %s; see ] for an overview, and ] for information on creating new rules.")
					:format(lang:makeCategoryLink())
			end
		end,
	},
	{
		regex = "^Modul:inc%-ash/dial/data/(.+)$",
		cat = "Ashokan Prakrit modules|%1",
		doc = function (title, cats)
			local word = title.fullText:match("^Modul:inc%-ash/dial/data/(.+)$")
			if word then
				local lang = lang_cache
				return ("This module contains data on the pronunciation of %s in dialects of %s.")
					:format(require("Module:links").full_link({ term = word, lang = lang }, "term"),
						lang:makeCategoryLink())
			end
		end,
	},
	{
		regex = "^Modul:+:Dialects$",
		cat = nil,
		doc = function (title, cats)
			local content = title:getContent()
			local has_aliases = content:find("aliases") ~= nil
			return mw.getCurrentFrame():expandTemplate {
				title = "dialectal data module",
				args = {  = has_aliases },
			}
		end,
	},
	{
		regex = "^.+%-translit$",
		cat = nil,
		doc = "translit",
	},
	{
		regex = "^Modul:category tree/poscatboiler/data/(.+)$",
		cat = "Category tree data modules/poscatboiler|%1",
	},
	{
		regex = "^Modul:ja/data/(.+)$",
		cat = "Japanese data modules|%1",
	},
	{
		regex = "^Modul:Swadesh/data/(.+)$",
		cat = "Swadesh modules|%1",
	},
	{
		regex = "^Modul:typing%-aids",
		cat = nil,
		doc = function(title, cats)
			local data_suffix = title.fullText:match("^Modul:typing%-aids/data/(.+)$")
			if data_suffix then
				cats:insert("Data modules")
				if data_suffix:find "^+$" then
					local lang = require "Module:languages".getByCode(data_suffix)
					if lang then
						cats:insert(lang:getCanonicalName() .. " modules")
					end
				elseif data_suffix:find "^%u%l%l%l$" then
					local script = require "Module:scripts".getByCode(data_suffix)
					if script then
						cats:insert(script:getCategoryName())
					end
				end
			end
		end,
	},
	{
		regex = "^Modul:R:(+):(.+)$",
		cat = nil,
		doc = function(title, cats, captures)
			local lang_code, refname = unpack(captures)
			local lang = lang_cache
			if lang then
				cats:insert(lang:getCanonicalName() .. " modules|" .. refname)
				cats:insert(("Reference modules|%s"):format(lang:getCanonicalName()))
				return mw.getCurrentFrame():preprocess("This module implements the reference template {{temp|R:" ..
					lang_code .. ":" .. refname .. "}}.")
			end
		end,
	},
}

function export.show(frame)
	local params = {
		 = {},
		 = {},
		 = {},
		 = { type = "boolean", default = false },
		 = { type = "boolean", default = false },
	}
	
	local args = require("Module:parameters").process(frame.args, params)
	
	local output = Array('\n<div class="documentation" style="display:block; clear:both">\n')
	local cats = Array()
	
	local nodoc = args.nodoc
	
	if (not args.hr) or (args.hr == "above") then
		output:insert("----\n")
	end
	
	local title = ((args ~= "") and args) and mw.title.new(args)
		or mw.title.getCurrentTitle()
	local doc_title = mw.title.new((args ~= "") and args
		or (title.fullText .. '/doc'))
	local contentModel = title.contentModel
	
	local pagetype = mw.getContentLanguage():lcfirst(title.nsText) .. ""
	local preload, fallback_docs, doc_content, doc_content_module,
		old_doc_title, user_name, skin_name, needs_doc
	
	if contentModel == "javascript" then
		pagetype = "parancsfájl"
		if title.nsText == 'MediaWiki' then
			if title.text:find('Gadget-') then
				preload = 'Sablon:documentation/preloadGadget'
			else
				preload = 'Sablon:documentation/preloadMediaWikiJavaScript'
			end
		else
			preload  = 'Sablon:documentation/preloadTemplate' -- XXX
		end
		if title.nsText == 'Felhasználó' then
			user_name = title.rootText
		end
	elseif contentModel == "css" then
		pagetype = "stíluslap"
		preload  = 'Sablon:documentation/preloadTemplate' -- XXX
		if title.nsText == 'Felhasználó' then
			user_name = title.rootText
		end
	elseif contentModel == "Scribunto" then
		pagetype = "modul"
		user_name = title.rootText:match("^elhasználó:(.+)")
		if user_name then
			preload  = 'Sablon:documentation/preloadModuleSandbox'
		else
			preload  = 'Sablon:documentation/preloadModule'
		end
	elseif title.nsText == "Sablon" then
		pagetype = "sablon"
		preload  = 'Sablon:documentation/preloadTemplate'
	elseif title.nsText == "Wikiszótár" then
		pagetype = "projektlap"
		preload  = 'Sablon:documentation/preloadTemplate' -- XXX
	end
	
	if doc_title.isRedirect then
		old_doc_title = doc_title
		doc_title = mw.title.new(string.match(doc_title:getContent(),
			"^#%s*:?%s*%]-)%]%]"))
	end

	output:insert("<dl class=\"plainlinks\" style=\"font-size: smaller;\">")
	if doc_title.exists then
		output:insert(
			"<dd><i style=\"font-size: larger;\">The following " ..
			"] is located at [[" ..
			doc_title.fullText .. "]]. " ..
			"<sup>]</sup> </i></dd>")
	else
		if contentModel == "Scribunto" then
			local automatic_cats = nil
			if user_name then
				fallback_docs = "documentation/fallback/user module"
				automatic_cats = {"User sandbox modules"}
			else
				for _, data in ipairs(module_regex) do
			        local captures = {mw.ustring.match(title.fullText, data.regex)}
			        if #captures > 0 then
						local cat
						local doc_function
						if type(data.doc) == "function" then
							doc_function = data.doc
						elseif type(data.doc) == "string" then
							doc_content_module = "Module:documentation/functions/" .. data.doc
							doc_function = require(doc_content_module)
						end
						
						if doc_function then
							doc_content = doc_function(title, cats, captures)
						end
						cat = data.cat
						
						if cat then
							if type(cat) == "string" then
								cat = {cat}
							end
							for _, c in ipairs(cat) do
								-- gsub() and Lua :gsub() return two arguments, which causes all sorts of problems.
								-- Terrible design, there should have been a separate two-argument function.
								local gsub_sucks = mw.ustring.gsub(title.fullText, data.regex, c)
								table.insert(cats, gsub_sucks)
							end
						end
						break
					end
				end
			end

			if not automatic_cats then
				local success, auto_cats =
					pcall(require("Module:module categorization").categorize, frame, true)
				if success then
					for _, category in ipairs(auto_cats) do
						cats:insert(category)
					end
				end
			end

			if title.subpageText == "templates" then
				cats:insert("Template interface modules")
			end

			if automatic_cats then
				for _, c in ipairs(automatic_cats) do
					cats:insert(c)
				end
			end
			
			-- meaning module is not in user’s sandbox or one of many datamodule boring series
			needs_doc = not (automatic_cats or doc_content or fallback_docs)
		elseif title.nsText == "Sablon" then
			--cats:insert("Uncategorized templates")
			needs_doc = not (fallback_docs or nodoc)
		elseif (contentModel == "css") or (contentModel == "javascript") then
			if user_name then
				skin_name = skins+)%.ss?$")]
				if skin_name then
					fallback_docs = 'documentation/fallback/user ' .. contentModel
				end
			end
		end
		
		if doc_content then
			output:insert(
				"<dd><i style=\"font-size: larger;\">The following " ..
				"] is " ..
				"generated by ]. <sup>[[" ..
				mw.title.new("Module:documentation"):fullUrl { action = 'edit' } ..
				" edit]]</sup> </i></dd>")
		elseif not nodoc then
			output:insert(
				"<dd><i style=\"font-size: larger;\">Ennek a " .. pagetype ..
				"nak nincs ]. " ..
				(fallback_docs and "Dokumentációs allap létrehozása" or "Dokumentációs allap létrehozása") ..
				"[" .. doc_title:fullUrl { action = 'edit', preload = preload }
				.. "létrehozása].</i></dd>\n")
		end
	end
	
	if title.fullText:match("^MediaWiki:Gadget%-") then
		local is_gadget = false
		local gadget_list = mw.title.new("MediaWiki:Gadgets-definition"):getContent()
		
		for line in mw.text.gsplit(gadget_list, "\n") do
			local gadget, opts, items = line:match("^%*%s*(*)%|(.+)$") -- opts is unused
			if not gadget then
				gadget, items = line:match("^%*%s*(*)|(.+)$")
			end
			
			if gadget then
				items = Array(mw.text.split(items, "|"))
				for i, item in ipairs(items) do
					if title.fullText == ("MediaWiki:Gadget-" .. item) then
						is_gadget = true

						output:insert("<dd> ''This script is a part of the <code>")
						output:insert(gadget)
						output:insert("</code> gadget ([")
						output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadgets-definition', 'action=edit')))
						output:insert(" edit definitions])'' <dl>")
						
						output:insert("<dd> ''Description ([")
						output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadget-' .. gadget, 'action=edit')))
						output:insert(" edit])'': ")
						
						local gadget_description = mw.message.new('Gadget-' .. gadget):plain()
						gadget_description = frame:preprocess(gadget_description)
						output:insert(gadget_description)
						output:insert(" </dd>")

						items:remove(i)
						if #items > 0 then
							for j, item in ipairs(items) do
								items = ']'
							end
							output:insert("<dd> ''Other parts'': ")
							output:insert(mw.text.listToText(items))
							output:insert("</dd>")
						end

						output:insert("</dl></dd>")

						break
					end
				end
			end
		end
		
		if not is_gadget then
			output:insert("<dd> ''This script is not a part of any [")
			output:insert(tostring(mw.uri.fullUrl('Special:Gadgets', 'uselang=en')))
			output:insert(' gadget] ([')
			output:insert(tostring(mw.uri.fullUrl('MediaWiki:Gadgets-definition', 'action=edit')))
			output:insert(' edit definitions]).</dd>')
		-- else
			-- cats:insert("Wiktionary gadgets")
		end
	end
	
	if old_doc_title then
		output:insert("<dd> ''Redirected from'' [")
		output:insert(old_doc_title:fullUrl { redirect = 'no' })
		output:insert(" ")
		output:insert(old_doc_title.fullText)
		output:insert("] ([")
		output:insert(old_doc_title:fullUrl { action = 'edit' })
		output:insert(" edit]).</dd>\n")
	end
	
	local links = Array()
	
	if title.isSubpage and not args.notsubpage then
		links:insert("]")
		links:insert("]")
	else
		links:insert("]")
	end
	
	links:insert(
		'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
			'hidetrans=1&hideredirs=1')) .. ' hivatkozások]')

	if contentModel ~= "Scribunto" then
		links:insert(
			'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
			'hidelinks=1&hidetrans=1')) .. ' átirányítások]')
	end

	if (contentModel == "javascript") or (contentModel == "css") then
		if user_name then
			links:insert("]")
		end
	else
		links:insert(
			'[' .. tostring(mw.uri.fullUrl('Special:WhatLinksHere/' .. title.fullText,
				'hidelinks=1&hideredirs=1')) .. ' beillesztve]')
	end
	
	if contentModel == "Scribunto" then
		local is_testcases = title.isSubpage and title.subpageText == "testcases"
		local without_subpage = title.nsText .. ":" .. title.baseText
		if is_testcases then
			links:insert("]")
		else
			links:insert("]")
		end
		
		if user_name then
			links:insert("]")
			links:insert("]")
			links:insert("]")
		else
			-- If sandbox module, add a link to the module that this is a sandbox of.
			-- Exclude user sandbox modules like ].
			if title.text:find("/sandbox%d*%f") then
				cats:insert("Sandbox modules")
				
				-- Sandbox modules don’t really need documentation.
				needs_doc = false
				
				-- Will behave badly if “/sandbox” occurs twice in title!
				local sandbox_of = title.fullText:gsub("/sandbox%d*%f", "")
				
				local diff
				if page_exists(sandbox_of) then
					diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
				else
					require("Module:debug").track("documentation/no sandbox of")
				end
				
				links:insert("]" .. (diff or ""))
			
			-- If not a sandbox module, add link to sandbox module.
			-- Sometimes there are multiple sandboxes for a single module:
			-- ],  ].
			-- Occasionally sandbox modules have their own subpages that are also
			-- sandboxes: ].
			else
				local sandbox_title
				if title.fullText:find("^Modul:grc%-decl/") then
					sandbox_title = title.fullText:gsub("^Modul:grc%-decl/", "Modul:grc-decl/sandbox/")
				elseif is_testcases then
					sandbox_title = title.fullText:gsub("/testcases", "/sandbox/testcases")
				else
					sandbox_title = title.fullText .. "/sandbox"
				end
				local sandbox_link = "]"
				
				local diff
				if page_exists(sandbox_title) then
					diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
				end
				
				links:insert(sandbox_link .. (diff or ""))
			end
		end
	end
	
	if title.nsText == "Sablon" then
		-- Error search: all(any namespace), hastemplate (show pages using the template), insource (show source code), incategory (any/specific error) -- ], ]
		-- apparently same with/without: &profile=advanced&fulltext=1
		local errorq = 'searchengineselect=mediawiki&search=all: hastemplate:\"'..title.rootText..'\" insource:\"'..title.rootText..'\" incategory:'
		local eincategory = "Pages_with_module_errors|ParserFunction_errors|DisplayTitle_errors|Pages_with_ISBN_errors|Pages_with_ISSN_errors|Pages_with_reference_errors|Pages_with_syntax_highlighting_errors|Pages_with_TemplateStyles_errors"
		
		links:insert(
			''
			.. ' (' ..
			''
			.. '/' ..
			''
			.. ')'
		)
		
		if title.isSubpage and title.text:find("/sandbox%d*%f") then -- This is a sandbox template.
			-- At the moment there are no user sandbox templates with subpage
			-- “/sandbox”.
			cats:insert("Sandbox templates")
			
			-- Sandbox templates don’t really need documentation.
			needs_doc = false
			
			-- Will behave badly if “/sandbox” occurs twice in title!
			local sandbox_of = title.fullText:gsub("/sandbox%d*%f", "")
			
			local diff
			if page_exists(sandbox_of) then
				diff = " (" .. compare_pages(title.fullText, sandbox_of, "diff") .. ")"
			else
				require("Module:debug").track("documentation/no sandbox of")
			end
			
			links:insert("]" .. (diff or ""))
		else -- This is a template that can have a sandbox.
			local sandbox_title = title.fullText .. "/sandbox"
			
			local diff
			if page_exists(sandbox_title) then
				diff = " (" .. compare_pages(title.fullText, sandbox_title, "diff") .. ")"
			end
			
			links:insert("]" .. (diff or ""))
		end
	end
	
	if #links > 0 then
		output:insert("<dd> ''Hasznos linkek'': " .. links:concat(" • ") .. "</dd>")
	end
	
	output:insert("</dl>\n")
	
	if doc_title.exists then
		-- Override automatic documentation, if present.
		doc_content = frame:expandTemplate { title = doc_title.fullText }
	elseif not doc_content and fallback_docs then
		doc_content = frame:expandTemplate {
			title = fallback_docs;
			args = {
				 = user_name;
				 = title.fullText;
				 = skin_name;
			}
		}
	end

	if doc_content then
		output:insert(doc_content)
	end

	output:insert(('\n<%s style="clear: both;" />'):format(args.hr == "below" and "hr" or "br"))
	
	if not cats and not doc_content then
		if contentModel == "Scribunto" then
			cats:insert("Uncategorized modules")
		-- elseif title.nsText == "Template" then
			-- cats:insert("Uncategorized templates")
		end
	end
	
	if needs_doc then
		cats:insert("Leírás nélküli sablonok")
	end
	
	for _, cat in ipairs(cats) do
		output:insert("]")
	end
	
	output:insert("</div>\n")

	return output:concat()
end

-- Used by {{translit module documentation}}.
function export.translitModuleLangList(frame)
	local pagename, subpage
	
	if frame.args then
		pagename = frame.args
	else
		local title = mw.title.getCurrentTitle()
		subpage = title.subpageText
		pagename = title.text
		
		if subpage ~= pagename then
			pagename = title.rootText
		end
	end
	
	local translitModule = pagename
	
	local languageObjects = require("Module:languages/byTranslitModule")(translitModule)
	local codeInPagename = pagename:match("^(+)%-.*translit$")
	
	local categories = Array()
	local codeInPagenameInList = false
	if codeInPagename then
		if languageObjects and subpage ~= "documentation" then
			local agreement = languageObjects and "s" or ""
			categories:insert("[[Category:Transliteration modules used by " ..
				#languageObjects .. " language" .. agreement .. "]]")
		end

		if languageObjects and subpage ~= "doc" then
			local agreement = languageObjects and "s" or ""
			categories:insert("[[Category:Transliteration modules used by " ..
				#languageObjects .. " language" .. agreement .. "]]")
		end		


		languageObjects = Array(languageObjects)
			:filter(
				function (lang)
					local result = lang:getCode() ~= codeInPagename
					codeInPagenameInList = codeInPagenameInList or result
					return result
				end)
	end
	
	if subpage ~= "documentation" then
		for script_code in pagename:gmatch("%f%u%l%l%l%f") do
			local script = require "Module:scripts".getByCode(script_code)
			if script then
				categories:insert("]")
			end
		end
	end
	
	if subpage ~= "documentation" and not page_exists("Module:" .. pagename .. "/testcases") then
		categories:insert("]")
	end

	if subpage ~= "doc" then
		for script_code in pagename:gmatch("%f%u%l%l%l%f") do
			local script = require "Module:scripts".getByCode(script_code)
			if script then
				categories:insert("]")
			end
		end
	end
	
	if subpage ~= "doc" and not page_exists("Module:" .. pagename .. "/testcases") then
		categories:insert("]")
	end
	
	if not languageObjects then
		return categories:concat()
	end
	
	local langs = Array(languageObjects)
		:sort(
			function(lang1, lang2)
				return lang1:getCode() < lang2:getCode()
			end)
		-- This will not error because languageObjects is not empty.
		:map(languageObjects.makeCategoryLink)
		:serial_comma_join()
	
	return "It is " .. ( codeInPagenameInList and "also" or "" ) ..
		" used to transliterate " .. langs .. "." .. categories:concat()
end

return export