モジュール:Episode list

local p = {}
-- This module requires the use of the following modules:
local colorContrastModule = require('Module:Color contrast')
local htmlColor = mw.loadData('Module:Color contrast/colors')
local delinkModule = require('Module:Delink')
local langModule = require("Module:Lang")
local mathModule = require('Module:Math')
local tableEmptyCellModule = require('Module:Table empty cell')
local yesNoModule = require('Module:Yesno')
-- mw.html object for the generated row.
local row
-- Variable that will decide the colspan= of the Short Summary cell.
local nonNilParams = 0
-- Variable that will keep track if a TBA value was entered.
local cellValueTBA = false
-- Variable that handles the assigned tracking categories.
local trackingCategories = ""
-- List of tracking categories.
local trackingCategoryList = {
	"air_dates" = "",
	"alt_air_dates" = "",
	"faulty_line_colors" = "",
	"non_compliant_line_colors" = "",
	"default_line_colors" = "",
	"row_deviations" = "",
	"invalid_top_colors" = "",
	"tba_values" = "",
	"nonmatching_numbered_parameters" = "",
	"raw_unformatted_storyteleplay" = ""
}
-- List of parameter names in this order.
local cellNameList = {
	'Aux1',
	'DirectedBy',
	'WrittenBy',
	'Aux2',
	'Aux3',
	'OriginalAirDate',
	'AltDate',
	'Guests',
	'MusicalGuests',
	'ProdCode',
	'Viewers',
	'Aux4'
}
-- List of pairs which cannot be used together
local excludeList = {
	'Guests' = 'Aux1',
	'MusicalGuests' = 'Aux2'
}
-- List of cells that have parameter groups
local parameterGroupCells = {}
local firstParameterGroupCell
-- List of title parameter names in this order.
-- List used for multi title lists.
local titleList = {
	'Title',
	'RTitle',
	'AltTitle',
	'RAltTitle',
	'NativeTitle',
	'TranslitTitle',
}
-- Local function which is used to retrieve the episode number or production code number,
-- without any additional text.
local function idTrim(val, search)
	local valFind = string.find(val, search)
	if (valFind == nil) then
		return val
	else
		return string.sub(val, 0, valFind-1)
	end
end
-- Local function which is used to validate that a parameter has an actual value.
local function hasValue(param)
	if (param ~= nil and param ~= "") then
		return true
	else
		return false
	end
end
-- Local function which is used to create a table data cell.
local function createTableData(text, rowSpan, textAlign)
	if (rowSpan ~= nil and tonumber(rowSpan) > 1) then
		row:tag('td')
			:attr('rowspan', rowSpan)
			:wikitext(text)
	else
		row:tag('td')
			:css('text-align', textAlign)
			:wikitext(text)
	end
end
-- Local function which is used to add a tracking category to the page.
local function addTrackingCategory(category)
	trackingCategories = trackingCategories .. category
end
-- Local function which is used to create a Short Summary row.
local function createShortSummaryRow(args, lineColor)
	-- fix for lists in the Short Summary
	local shortSummaryText = args.ShortSummary
	if (shortSummaryText:match('^*:;#') or shortSummaryText:match('^
		shortSummaryText = '\n' .. shortSummaryText
	end
	if (shortSummaryText:match('\n*:;#')) then
		shortSummaryText = shortSummaryText .. '\n'
	end
	local shortSummaryCell = mw.html.create('td')
				:addClass('description')
				:css('border-bottom', 'solid 3px ' .. lineColor)
				:attr('colspan', nonNilParams)
				:newline()
				:wikitext(shortSummaryText)
	return mw.html.create('tr')
					:addClass('expand-child')
					:node(shortSummaryCell)
end
-- Local function which is used to add tracking categories for Top Color issues.
local function addTopColorTrackingCategories(args)
	if (hasValue(args.TopColor)) then
		addTrackingCategory(trackingCategoryList"row_deviations")
		-- Track top colors that have a color contrast rating below AAA with
		-- respect to text color, link color, or visited link color. See
		-- WP:COLOR for more about color contrast requirements.
		local textContrastRatio = colorContrastModule._ratio{args.TopColor, 'black', 'error' = 0}
		local linkContrastRatio = colorContrastModule._ratio{args.TopColor, '#0B0080', 'error' = 0}
		local visitedLinkContrastRatio = colorContrastModule._ratio{args.TopColor, '#0645AD', 'error' = 0}
		if (textContrastRatio = 60 * 60 * 24 * 7 * 4) then
			return tableEmptyCellModule._main({alt_text = "N/A"})
		else
			return tableEmptyCellModule._main({alt_text = "TBD"})
		end
	end
end
-- Local function which is used to create an empty cell.
local function createEmptyCell(args, v, unsetParameterGroup)
	if (unsetParameterGroup) then
		argsv = tableEmptyCellModule._main({alt_text = "N/A"})
	elseif (v == 'Viewers' and hasValue(args.OriginalAirDate)) then
		argsv = setTBDStatus(args)
	else
		argsv = tableEmptyCellModule._main({})
	end
end
-- Air dates that don't use 
local function checkUsageOfDateTemplates(args, v, onInitialPage, title)
	if (v == 'OriginalAirDate'
		and argsv ~= 
		and string.match(argsv, '%d%d%d%d') ~= nil
		and string.match(argsv, '2C2C2C') == nil
		and string.find(argsv, 'dtstart') == nil
		and onInitialPage
		and title.namespace == 0)
	then
		addTrackingCategory(trackingCategoryList"air_dates")
	end
	-- Alternate air dates that do use 
	if (v == 'AltDate' and argsv ~=  and string.find(argsv, 'dtstart') ~= nil and onInitialPage and title.namespace == 0) then
		addTrackingCategory(trackingCategoryList"alt_air_dates")
	end
end
-- Local function which is used to create a Production Code cell.
local function createProductionCodeCell(args, v)
	if (hasValue(args.ProdCode) and string.find(args.ProdCode, 'TBA') == nil) then
		row:tag('td')
			:attr('id', 'pc' .. idTrim(idTrim(args.ProdCode, ' ----'), ' 1) then
				-- argsv = removeWikilinks(args, v)
			-- end
			local thisRowspan
			if (firstParameterGroupCell and k  1 and k >= (firstParameterGroupCell or 0))) then
				createTableData(argsv, thisRowspan, textAlign)
			end
			nonNilParams = nonNilParams + 1
			checkUsageOfDateTemplates(args, v, onInitialPage, title)
		end
		if (argsv == "TBA") then
			cellValueTBA = true
		end
	end
end
--
Local function which is used to create the Title cell text.
The title text will be handled in the following way:
	Line 1:  (with no space between)
	Line 2:  (with no space between) OR
	Line 2: Transcription:  (: ) (with space between first two parameters)
	If  or  are empty,
	then the values of line 2 will be placed on line 1 instead.
--
local function createTitleText(args)
	local titleString = 
	local isCellPresent = false
	local useSecondLine = false
	local lineBreakUsed = false
	-- Surround the Title with quotes; No quotes if empty.
	if (args.Title ~= nil) then
		if (args.Title == "") then
			isCellPresent = true
		else
			titleString = '"' .. args.Title .. '"'
			useSecondLine = true
			isCellPresent = true
		end
	end
	if (args.RTitle ~= nil) then
		if (args.RTitle == "") then
			isCellPresent = true
		else
			titleString = titleString .. args.RTitle
			useSecondLine = true
			isCellPresent = true
		end
	end
	-- Surround the AltTitle/TranslitTitle with quotes; No quotes if empty.
	if (args.AltTitle or args.TranslitTitle) then
		isCellPresent = true
		if (useSecondLine) then
			titleString = titleString .. ""
			lineBreakUsed = true
		end
		if (hasValue(args.AltTitle)) then
			titleString = titleString .. '"' .. args.AltTitle .. '"'
		elseif (hasValue(args.TranslitTitle)) then
			if (hasValue(args.NativeTitleLangCode)) then
				titleString = titleString .. 'Transcription: "' .. langModule._transl({args.NativeTitleLangCode, args.TranslitTitle, italic = 'no'})  .. '"'
			else
				titleString = titleString .. 'Transcription: "' .. args.TranslitTitle .. '"'
			end
		end
	end
	if (args.NativeTitle ~= nil) then
		if (args.NativeTitle == "") then
			isCellPresent = true
		else
			isCellPresent = true
			if (useSecondLine and lineBreakUsed == false) then
				titleString = titleString .. ""
			end
			if (hasValue(args.NativeTitleLangCode)) then
				local languageCode = "Lang-" .. args.NativeTitleLangCode
				titleString = titleString .. " (" .. langModule._lang_xx_inherit({code = args.NativeTitleLangCode, args.NativeTitle}) .. ")"
			else
				titleString = titleString .. " (" .. args.NativeTitle .. ")"
			end
		end
	end
	if (args.RAltTitle ~= nil) then
		if (args.RAltTitle == "") then
			isCellPresent = true
		else
			isCellPresent = true
			if (useSecondLine and lineBreakUsed == false) then
				titleString = titleString .. ""
			end
			titleString = titleString .. args.RAltTitle
		end
	end
	return titleString, isCellPresent
end
--
Local function which is used to extract data
from the numbered title parameters (Title1, RTitle2, etc.), and then convert them to
use the non-numbered prameter names (Title, RTitle).
The function returns two results:
	-- The args parameter table.
	-- A boolean indicating if the title group has data.
--
local function extractDataFromNumberedTitleArgs(args, i)
	local nextGroupValid = false
	for _, v in ipairs(titleList) do
		local parameter = v
		local numberedParameter = v .. "_" .. i
		argsparameter = argsnumberedParameter
		if (nextGroupValid == false and hasValue(argsnumberedParameter)) then
			nextGroupValid = true
		end
	end
	return args, nextGroupValid
end
-- Local function which is used to process the multi title list.
local function processMultiTitleList(args, numberOfParameterGroups)
	local nativeTitleLangCode = args.NativeTitleLangCode
	local titleText = ""
	local isCellPresent = false
	local isFirstTitleGroup = true -- Making sure that the title cell is created at least once and isn't created again if other #N titles are empty.
	for i = 1, numberOfParameterGroups do
		local args, nextGroupValid = extractDataFromNumberedTitleArgs(args, i)
		if (nextGroupValid) then
			if (isFirstTitleGroup == false) then
				titleText = titleText .. ""
			end
			local titleTextRow
			titleTextRow = createTitleText(args)
			titleText = titleText .. titleTextRow
			isFirstTitleGroup = false
		else
			if (isFirstTitleGroup) then
				titleText, isCellPresent = createTitleText(args)
			end
			-- Valid titles have to be in succession (#1, #2, #3 and not #1, #4 #5), so exit for loop if next group is empty.
			return titleText, isCellPresent
		end
	end
	return titleText
end
-- Local function which is used to create a Title cell.
local function createTitleCell(args, numberOfParameterGroups, multiTitleListEnabled, isSerial)
	local titleText
	local isCellPresent
	if (multiTitleListEnabled) then
		titleText, isCellPresent = processMultiTitleList(args, numberOfParameterGroups)
	else
		titleText, isCellPresent = createTitleText(args)
	end
	if (isCellPresent == false) then
		return nil
	end
	local textAlign = "left"
	-- If Title is blank, then set Raw Title to TBA
	if (hasValue(titleText) == false) then
		titleText = tableEmptyCellModule._main({})
		textAlign = "left"
	end
	-- If title is the first cell, create it with a !scope="row"
	if (nonNilParams == 0) then
		if (isSerial) then
			row:tag('th')
				:addClass('summary')
				:attr('scope', 'row')
				:attr('rowspan', numberOfParameterGroups)
				:css('text-align', textAlign)
				:wikitext(titleText)
		else
			row:tag('th')
				:addClass('summary')
				:attr('scope', 'row')
				:css('text-align', textAlign)
				:wikitext(titleText)
		end
	else
		if (isSerial) then
			row:tag('td')
				:addClass('summary')
				:attr('rowspan', numberOfParameterGroups)
				:css('text-align', textAlign)
				:wikitext(titleText)
		else
			row:tag('td')
				:addClass('summary')
				:css('text-align', textAlign)
				:wikitext(titleText)
		end
	end
	nonNilParams = nonNilParams + 1
end
-- Local function which is used to create a table row header for either the
-- EpisodeNumber or EpisodeNumber2 column cells.
local function createTableRowEpisodeNumberHeader(episodeNumber, numberOfParameterGroups, episodeText)
		local epID = string.match(episodeNumber, "^%w+")
		row:tag('th')
			:attr('scope', 'row')
			:attr('rowspan', numberOfParameterGroups)
			:attr('id', epID and 'ep' .. epID or )
			:css('text-align', 'center')
			:wikitext(episodeText)
end
--
Local function which is used to extract the text from the EpisodeNumber or EpisodeNumber2
parameters and format them into a correct MoS compliant version.
Styles supported:
	-- A number range of two numbers, indicating the start and end of the range,
	seperated by an en-dash (–) with no spaces in between.
		Example: "1 - 2" -> "1–2"; "1-2-3" -> "1–3".
	-- An alphanumeric or letter range, similar to the above.
		Example: "A - B" -> "A–B"; "A-B-C" -> "A–C".
		Example: "A1 - B1" -> "A1–B1"; "A1-B1-C1" -> "A1–C1".
	-- A number range of two numbers, indicating the start and end of the range,
	seperated by a visual  (divider line).
	-- An alphanumeric or letter range, similar to the above.
--
local function getEpisodeText(episodeNumber)
	if (episodeNumber == ) then
		return tableEmptyCellModule._main({})
	else
		local episodeNumber1
		local episodeNumber2
		-- Used for double episodes that need a visual "–"" or """ added.
		local divider
		episodeNumber = episodeNumber:gsub('%s*%s*', )
		if (episodeNumber:match('^(%w+)%s*%s*(%w+)$')) then
			episodeNumber1, episodeNumber2 = episodeNumber:match('^(%w+)%s*%s*(%w+)$')
			divider = ""
		elseif (episodeNumber:match('^(%w+)%s*.-%s*(%w+)$')) then  -- 3 or more elements
			episodeNumber1, episodeNumber2 = episodeNumber:match('^(%w+)%s*.-%s*(%w+)$')
			divider = ""
		elseif (mw.ustring.match(episodeNumber, '^(%w+)%s*%s%-–/&%s*(%w+)$')) then
			episodeNumber1, episodeNumber2 = mw.ustring.match(episodeNumber, '^(%w+)%s*%s%-–/&%s*(%w+)$')
			divider = "–"
		else
			episodeNumber1, episodeNumber2 = mw.ustring.match(episodeNumber, '^(%w+)%s*%s%-–/&.-%s%-–/&%s*(%w+)$')  -- 3 or more elements
			divider = "–"
		end
		if (not episodeNumber1) then
			return episodeNumber
		elseif (not episodeNumber2) then
			return string.match(episodeNumber, '%w+')
		else
			return episodeNumber1 .. divider .. episodeNumber2
		end
	end
end
-- Local function which is used to create EpisodeNumber2 and EpisodeNumber3 cells.
local function _createEpisodeNumberCellSecondary(episodeValue, numberOfParameterGroups)
	if (episodeValue) then
		local episodeText = getEpisodeText(episodeValue)
		if (nonNilParams == 0) then
			createTableRowEpisodeNumberHeader(episodeValue, numberOfParameterGroups, episodeText)
		else
			createTableData(episodeText, numberOfParameterGroups, "center")
		end
		nonNilParams = nonNilParams + 1
	end
end
-- Local function which is used to create seconday episode number cells.
local function createEpisodeNumberCellSecondary(args, numberOfParameterGroups)
	_createEpisodeNumberCellSecondary(args.EpisodeNumber2, numberOfParameterGroups)
	_createEpisodeNumberCellSecondary(args.EpisodeNumber3, numberOfParameterGroups)
end
-- Local function which is used to create an EpisodeNumber cell.
local function createEpisodeNumberCell(args, numberOfParameterGroups)
	if (args.EpisodeNumber) then
		local episodeText = getEpisodeText(args.EpisodeNumber)
		createTableRowEpisodeNumberHeader(args.EpisodeNumber, numberOfParameterGroups, episodeText)
		nonNilParams = nonNilParams + 1
	end
end
-- Local function which is used to create a single row of cells.
-- This is the standard function called.
local function createSingleRowCells(args, numberOfParameterGroups, multiTitleListEnabled, onInitialPage, title)
	createEpisodeNumberCell(args, 1)
	createEpisodeNumberCellSecondary(args, 1)
	createTitleCell(args, numberOfParameterGroups, multiTitleListEnabled, false)
	createCells(args, false, 1, onInitialPage, title, numberOfParameterGroups)
end
-- Local function which is used to create a multiple row of cells.
-- This function is called when part of the row is rowspaned.
-- Current use is for Doctor Who serials.
local function createMultiRowCells(args, numberOfParameterGroups, onInitialPage, title, topColor)
	createEpisodeNumberCell(args, numberOfParameterGroups)
	createEpisodeNumberCellSecondary(args, numberOfParameterGroups)
	createTitleCell(args, numberOfParameterGroups, false, true)
	for i = 1, numberOfParameterGroups do
		args = extractDataFromNumberedSerialArgs(args, i, numberOfParameterGroups, title)
		createCells(args, true, i, onInitialPage, title, numberOfParameterGroups)
		if (i ~= numberOfParameterGroups) then
			row = row:done()  -- Use done() to close the 'tr' tag in rowspaned rows.
				:tag('tr')
				:css('background', topColor)
		end
	end
end
-- Local function which is used to retrieve the NumParts value.
local function getnumberOfParameterGroups(args)
	for k, v in ipairs(cellNameList) do
		local numberedParameter = v .. "_" .. 1
		if (argsnumberedParameter) then
			parameterGroupCellsv = true
			if not firstParameterGroupCell then
				firstParameterGroupCell = k
			end
		end
	end
	if (hasValue(args.NumParts)) then
		return args.NumParts, true
	else
		return 1, false
	end
end
-- Local function which is used to retrieve the Top Color value.
local function getTopColor(args, rowColorEnabled, onInitialPage)
	local episodeNumber = mathModule._cleanNumber(args.EpisodeNumber) or 1
	if (args.TopColor) then
		if (string.find(args.TopColor, "#")) then
			return args.TopColor
		else
			return '#' .. args.TopColor
		end
	elseif (rowColorEnabled and onInitialPage and mathModule._mod(episodeNumber, 2) == 0) then
		return '#E9E9E9'
	elseif (onInitialPage and args.ShortSummary) then
		return '#F2F2F2'
	else
		return 'inherit'
	end
end
-- Local function which is used to retrieve the Row Color value.
local function isRowColorEnabled(args)
	local rowColorEnabled = yesNoModule(args.RowColor, false)
	if (args.RowColor and string.lower(args.RowColor) == 'on') then
		rowColorEnabled = true
	end
	return rowColorEnabled
end
-- Local function which is used to retrieve the Line Color value.
local function getLineColor(args)
	-- Default color to light blue
	local lineColor = args.LineColor or 'CCCCFF'
	-- Add # to color if necessary, and set to default color if invalid
	if (htmlColorlineColor == nil) then
		lineColor = '#' .. (mw.ustring.match(lineColor, '^%s#*(a-fA-F0-9*)%s*$') or )
		if (lineColor == '#') then
			lineColor = '#CCCCFF'
		end
	end
	return lineColor
end
-- Local function which is used to check if the table is located on the page
-- currently viewed, or on a transcluded page instead.
-- If it is on a transcluded page, the episode summary should not be shown.
local function isOnInitialPage(args, sublist, pageTitle, initiallistTitle)
	-- This should be the only check needed, however, it was previously implemented with two templates
	-- with one of them not requiring an article name, so for backward compatability, the whole sequence is kept.
	local onInitialPage
	-- Only sublist had anything about hiding, so only it needs to even check
	if (sublist) then
		onInitialPage = mw.uri.anchorEncode(pageTitle) == mw.uri.anchorEncode(initiallistTitle)
		-- avoid processing ghost references
		if (not onInitialPage) then
			args.ShortSummary = nil
		end
	else
		if (initiallistTitle == "") then
			onInitialPage = true
		else
			onInitialPage = mw.uri.anchorEncode(pageTitle) == mw.uri.anchorEncode(initiallistTitle)
		end
	end
	return onInitialPage
end
-- Local function which does the actual main process.
local function _main(args, sublist)
	local title = mw.title.getCurrentTitle()
	local pageTitle = title.text
	local initiallistTitle = args'1' or 
	-- Is this list on the same page as the page directly calling the template?
	local onInitialPage = isOnInitialPage(args, sublist, pageTitle, initiallistTitle)
	-- Need just this parameter removed if blank, no others
	if (hasValue(args.ShortSummary) == false) then
		args.ShortSummary = nil
	end
	local lineColor = getLineColor(args)
	local rowColorEnabled = isRowColorEnabled(args)
	local topColor = getTopColor(args, rowColorEnabled, onInitialPage)
	local root = mw.html.create()							-- Create the root mw.html object to return
	row = root:tag('tr')									-- Create the table row and store it globally
				:addClass('vevent')
				:css('text-align', 'center')
				:css('background', topColor)
	local numberOfParameterGroups, multiTitleListEnabled = getnumberOfParameterGroups(args)
	if (multiTitleListEnabled and not args.Title_2) then
		createMultiRowCells(args, numberOfParameterGroups, onInitialPage, title, topColor)
	else
		createSingleRowCells(args, numberOfParameterGroups, multiTitleListEnabled, onInitialPage, title)
	end
	-- add these categories only in the mainspace and only if they are on the page where the template is used
	if (onInitialPage and title.namespace == 0) then
		addLineColorTrackingCategories(args)
		addTopColorTrackingCategories(args)
	end
	if (cellValueTBA == true and title.namespace == 0) then
		addTrackingCategory(trackingCategoryList"tba_values")
	end
	-- Do not show the summary if this is being transcluded on the initial list page
	-- Do include it on all other lists
	if (onInitialPage and args.ShortSummary) then
		local bottomWrapper = createShortSummaryRow(args, lineColor)
		return tostring(root) .. tostring(bottomWrapper) .. trackingCategories
	else
		return tostring(root) .. trackingCategories
	end
end
-- Local function which handles both module entry points.
local function main(frame, sublist)
	local getArgs = require('Module:Arguments').getArgs
	local args
	-- Most parameters should still display when blank, so don't remove blanks
	if (sublist) then
		args = getArgs(frame, {removeBlanks = false, wrappers = 'Template:Episode list/sublist'})
	else
		args = getArgs(frame, {removeBlanks = false, wrappers = 'Template:Episode list'})
	end
	-- args'1' = mw.getCurrentFrame():getParent():getTitle()
	return _main(args, sublist, frame)
end
--RowColor=			— optional; Switch parameter that must only be defined when the EpisodeNumber= entry is not a regular number
											(e.g. "12–13" for two episodes described in one table entry).
											If the first episode number is even, define pass "on". If the first episode number is odd, pass "off".
--
function p.sublist(frame)
	return main(frame, true)
end
--
Public function which is used to create an Episode row
for an Episode Table used for lists of episodes where all tables are on the same page.
For tables which are on different pages see p.sublist().
For complete parameter documentation, see the documentation at p.sublist().
--
function p.list(frame)
	return main(frame, false)
end
return p