יחידה:ParamValidator

This module is based on idea and original code of User:IKhitron.
the source of this module is in //he.wikipedia.org/wiki/Module:ParamValidator

This module exports two functions: calculateViolations( frame, subpages ), and validateParams( frame ).

calculateViolations( frame, subpages ) finds templatedata, in template page or in one of its subpages in the list, if provided. it returns a table with the violations. if there are none, the table is empty. otherwise it has the structure

{
	violation1 = { param1 = value1, param2 = value2 },
	violation2 = { ... },
	...
}

violation1, violation2 etc. are one of the names of specific violations, as described below. param1, param2 etc. are either the names of parameter passed to the template, or defined in templatedata. value1, value2 etc. are the values passed to the template, or an empty string if no such parameter was passed.

the different violations are as follow:

• no-templatedata
  no valid tempaltedata was found in tempalte page, or documentation subpage
• undeclared
  named parameters with non-empty value, does not exist in templatedata
• empty-undeclared
  named parameters with empty value, does not exist in templatedata
• undeclared-numeric
  numeric parameters with non-empty value, does not exist in templatedata
• empty-undeclared-numeric
  numeric parameters with empty value, does not exist in templatedata
• deprecated
  parameters with non-empty value, marked as "deprecated" in tempaltedata
• empty-deprecated
  parameters with empty value, marked as "deprecated" in tempaltedata
• empty-required
  missing or empty parameter marked as "required" in tempaltedata
• incompatible
  a non-empty parameter passed to the template, incompatible with the parameter type defined in templatedata

The second function, validateParams( frame ), can be called from the tempalte' using #invoke. it expects a parameter named "options", which contains the definition of the output. typically, it's used by placing something like so:

<includeonly>{{#invoke:ParamValidator | validateParams | options = {{PV default options}} }}</includeonly>

at the top of the template (be mindful not to add extra spaces and newlines to the template).

the options parameter should be a JSON-encoded string, defining the output, and some special behaviors. the example above assumes that a wiki page named Template:PV default options exists, and contains valid JSON string. for each of the violations defined above, "options" may define an output string, so basically, "options" looks like so:

{
	violation1: outputstring1,
	violation2: outputstring2,
	.... ,
	behavior1: some value,
	....
}

not all violations have to be defined. a violation not defined in "options" will be ignored.

when invoked, it extract "subpages" from the options parameter, and calls:

• calculateViolations( frame, subpages )

if the returned table is empty, no violation were found, and an empty string is returned and nothing else happens.

otherwise, for each of the violations, i.e., the keys of the returned table, when "options" contains this key, the corresonding value is appended to the output.

some further processing is done:

1. several tokens are replaced with calculated values. these are described below.
2. some "meta" violations are calculated: when any none-ignored violation occured, the "any" meta-violation is added to the output in the same way, i.e. the string keyed by "any" in the options is appended to output with appropriate substitutions. similarly, "multiple" meta-violation is created when more than one type of non-ignored violations occured.
3. if the output is not empty, a prefix and suffix strings are prepended and appended to it.

these are the tokens and the replacement.

• templatename
  full template name, including namespace.
• tname_naked
  template name without namespace.
• paramname
  comma-separated list of parameters
• paramandvalue
  is replaced by comma-separated list of "name: value" pairs of parameters and values

the first two are applied to the whole output, including the suffux and prefix, and the rest are applied to the individual violations, each with its own list of offending parameters and values.

the rest of the if the value of some keys is null, this error condition will be ignored, and not counted when calculating "any" and "multiple" conditions.

some other optional fields can be passed via options:

• doc-subpage
  can be either a string, or a list (in square bracktes) of strings, indicating subpages of the template that may contain templatedata.
• ignore
  list of patterns. any parameter whose name matches any pattern, will not considered in violation of any of the rules.
• skip-empty-numeric
  if a quoted number, the module will ignore non-declared empty numeric parameters up to this number
• wrapper-prefix
  openning wrapper element of outpot (defaults to <div class = 'paramvalidator-wrapper'>)
• wrapper-suffix
  closing wrapper element of output (defaults to "</div>")

additional option parameters, named options1, options2, etc. can be passed. any entry defined in these options will override the previous value. a typical use may be like so:

typically, this JSON structure will be placed in a separate template, and retrieved for the module-use as shown above.

<includeonly>{{#invoke:ParamValidator | validateParams | options = {{PV default options}} | options1 = {"key":"value"} }}</includeonly>

"key" can override any of the options fields described above.

---

--[=[

This module is based on idea and original code of [[User:IKhitron]].

the source of this module is in //he.wikipedia.org/wiki/Module:ParamValidator



it exports two functions: validateParams(), called from page using {{#invoke: }} and returns a string,
and calculateViolations(), called from another module, and returns a table with a list of violations, keyed on violation type as described below.
both use the metadata in the templatedata object to validate the parameters. the list of detected violations appear below:

	* "no-templatedata": 			no valid tempaltedata was found in tempalte page, or documentation subpage
	* "undeclared": 				named parameters with non-empty value, does not exist in templatedata
	* "empty-undeclared": 			named parameters with empty value, does not exist in templatedata
	* "undeclared-numeric": 		numeric parameters with non-empty value, does not exist in templatedata
	* "empty-undeclared-numeric": 	numeric parameters with empty value, does not exist in templatedata
	* "deprecated":  				parameters with non-empty value, marked as "deprecated" in tempaltedata
	* "empty-deprecated":  			parameters with empty value, marked as "deprecated" in tempaltedata
	* "empty-required": 			missing or empty parameter marked as "required" in tempaltedata

	
calculateViolations() returns a table, keyed on violation type, whose values are tables of parameter name : parameter value	
	
	
	* "any": 						at least one of the above properies has non-empty value, and the corresponding error actually exists.
	* "multiple": 					more than one of the above properies (not including "any") has non-empty value, and the corresponding error actually exists.
	

	
it retrieves the template's templatedata, and uses it to validate the parameters passed to the template.
if any violations found, it returns am appropriate string. this string will typically include some maintenance category, and/or error message.
the operation of the module is controlled by a single parameter passed to it. this string should be valid JSON describing the actions.
the fields of this structure has the following keys, with string or null value:
	
if any of these error-conditions exists, and "options" has non-empty value for the corresponding key, will be appended to the output,
after replacing the follwing tokens:
-- "templatename" is replaced with the actual template name,
-- "tname_naked" is replaced with the naked template name, i.e. without colon and namespace
-- "paramname" is replaced by a comma-separated list of parameters offending the rule.
-- "paramandvalue" is replaced by comma-separated list of "name: value" pairs of parameters and values

if the value of some keys is null, this error condition will be ignored, and not counted when calculating "any" and "multiple" conditions.

some other optional fields can be passed via options:
	* "ignore": list (in square brackets) of parameter names to ignore, both in templatedata and actual parameters. all names should be quoted.
	* "doc-subpage": can be either a string, or a list (in square bracktes) of strings, indicating subpages of the template 
			that may contain templatedata. 
	* "skip-empty-numeric": if a quoted number, the module will ignore empty numeric parameters up to this number
	* "wrapper-prefix": openning wrapper element of outpot (defaults to "<div class = 'paramvalidator-wrapper'>") 
	* "wrapper-suffix": closing wrapper element of output (defaults to "</div>") 
	


typically, this JSON structure will be placed in a special template, and retrieved for the module-use like so:
		<includeonly>{{#invoke:ParamValidatoe | validateParams | options = {{PV Default Values}} }}</includeonly>
this code is to be placed at the very beginning of the page of the template whose uses are to be validated.

several such options pages may exist, so the user can decide which validation regime to use with each template, by invoking it and passing
the appropriate one for the "options" parameter.

]=]

function empty( s ) 
	return not s or type( s ) == 'string' and mw.text.trim( s ) == '' 
end

function extract_options( frame )
	local ok, options = pcall( mw.text.jsonDecode, frame.args.options )
	options = ok and options or {}
	local n, more = 0
	repeat
		n = n + 1
		ok, more = pcall( mw.text.jsonDecode, frame.args['options' .. n] )
		if ok then
			for k, v in pairs( more ) do options[k] = v end
		end
	until not ok
	return options
end

function build_namelist( template_name, sp )
	local res = { template_name }
	if sp then
		if type( sp ) == 'string' then sp = { sp } end
		for _, p in ipairs( sp ) do table.insert( res, template_name .. '/' .. p ) end
	end
	return res
end

-- this is the function to be called by other modules. it expects the frame, and then an optional list of subpages, e.g. { "Documentation" }.
-- if second parameter is nil, only tempalte page will be searched for templatedata.
function calculateViolations( frame, subpages )

	-- this can be made more sophisticated later, e.g. for "wiki page" and such
	function compatible( val, typ )
		if typ == 'number' and not mw.language.getCurrentLanguage():parseNumber( val ) then return false end
		return true
	end
	
	local t_frame = frame:getParent()
	local t_args, template_name = t_frame.args, t_frame:getTitle()
	local td_source = build_namelist( template_name, subpages )
	local templatedata = require( 'Module:ReadTd' ).ReadTemplateData( td_source )
	local td_params = templatedata and templatedata.params
	
	if not td_params then return { ['no-templatedata'] = { [''] = '' } } end
	-- from this point on, we know templatedata is valid.

	local res = {} -- before returning to caller, we'll prune empty tables

	-- handle undeclared and deprecated
	for p_name, value in pairs( t_args ) do
		local tp_param, noval, numeric, table_name = td_params[p_name], empty( value ), tonumber( p_name )
		
		if not tp_param then -- not in TD: this is called undeclared
			-- calculate the relevant table for this undeclared parameter, based on parameter and value types
			table_name = 
				noval and numeric and 'empty-undeclared-numeric' or
				noval and not numeric and 'empty-undeclared' or
				not noval and numeric and 'undeclared-numeric' or
				'undeclared' -- tzvototi nishar.
		else -- in td: test for depracation and mistype. if deprecated, no further tests
			table_name = tp_param.deprecated and not noval and 'deprecated' or
				tp_param.deprecated and noval and 'empty-deprecated' or 
				not compatible( tp_param.type, value ) and 'incompatible'
		end
		-- report it.
		if table_name then 
			res[table_name] = res[table_name] or {}
			res[table_name][p_name] = value 
		end
	end

	-- test for empty/missing paraeters declared "required" 
	for p_name, param in pairs( td_params ) do 
		if param.required and empty( t_args[p_name] ) then 
			res['empty-required'] = res['empty-required'] or {} 
			res['empty-required'][p_name] = '' 
		end
	end
	
	return res
end

-- this is the "user" version, called with {{#invoke:}} returns a string, as defined by the options parameter
function validateParams( frame )
	local options, report, template_name = extract_options( frame ), '', frame:getParent():getTitle()

	local wrap_report = function()
		if empty( report ) then return '' end
		local naked = mw.title.new( template_name )['text'] 
		
		report = ( options['wrapper-prefix'] or "<div class = 'paramvalidator-wrapper'>" )
				.. report
				.. ( options['wrapper-suffix'] or "</div>" )
		
		report = mw.ustring.gsub( report, 'tname_naked', naked )
		report = mw.ustring.gsub( report, 'templatename', template_name )
		return report
	end

	local ignore = function( p_name )
		for _, pattern in ipairs( options['ignore'] or {} ) do
			if string.match( p_name, '^' .. pattern .. '$' ) then return true end
		end
		return false
	end

	local replace_macros = function( s, param_names )
		if s and ( type( param_names ) == 'table' ) then
			local k_ar, kv_ar = {}, {}
			for k, v in pairs( param_names ) do
				table.insert( k_ar, k )
				table.insert( kv_ar, k .. ': ' .. v)
			end
			s = mw.ustring.gsub( s, 'paramname', table.concat( k_ar, ', ' ) )
			s = mw.ustring.gsub( s, 'paramandvalue', table.concat( kv_ar, ', ' ) )
		end
		return s
	end

	local report_params = function( key, param_names )
		local res = replace_macros( options[key], param_names )
		report = report ..  ( res or '' )
		return res
	end
	
	-- assert options is not empty.
	assert( next( options ), 'expecting valid "options" parameter')
	
	-- get the errors.
	local violations = calculateViolations( frame, options['doc-subpage'] )

	-- special request of bora: use skip_empty_numeric
	if violations['empty-undeclared-numeric'] then 
		for i = 1, tonumber( options['skip-empty-numeric'] ) or 0 do 
			violations['empty-undeclared-numeric'][i] = nil 
		end
	end
	
	-- handle ignore list, and prune empty violations - in that order!
	local offenders = 0
	for name, tab in pairs( violations ) do 
		-- remove ignored parameters from all violations
		for pname in pairs( tab ) do if ignore( pname ) then tab[pname] = nil end end
		-- prune empty violations
		if next( tab ) == nil then violations[name] = nil end
	-- WORK IS DONE. report the errors.
	-- if report then count it.
		if violations[name] and report_params( name, tab ) then offenders = offenders + 1 end 
	end

	if offenders > 1 then report_params( 'multiple' ) end
	if offenders ~= 0 then report_params( 'any' ) end -- could have tested for empty( report ), but since we count them anyway...

	return wrap_report()
end

return {
	['validateparams'] = validateParams,
	['calculateViolations'] = calculateViolations
}