Module:Discussion ping

Module documentation[view] [edit] [history] [purge]

This module implements {{discussion ping}}.

Usage

{{#invoke:discussion ping|main|}}

Example

{{#invoke:discussion ping|main|1=[[User:Example]] [[User:Example2|Example]]}} yields @Example2 @Example

{{#invoke:discussion ping|main|title=User:Awesome Aasim/Example discussion#Some_discussion}} yields @Example2 @Example4 @Example3 @Example

{{#invoke:discussion ping|main|title=User:Awesome Aasim/Example discussion}} yields @Example2 @Example4 @Example3 @Example

Note: For really large pages, this template or module falls apart.

The above documentation is transcluded from Module:Discussion ping/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

--- This module extracts all the users in either a marked LST or in wikitext and
-- generates links reflecting a courtesy ping.
-- 
-- @module Courtesy ping
-- @require Module:Arguments
-- @release alpha

local p = {}
local getArgs = require("Module:Arguments").getArgs

--- Makes a user link
-- @param {table} userTitle the title for the user object
-- @return {string} the formatted user link in the form of a ping
function makeUserLink( userTitle )
	return mw.ustring.format( '@[[%s|%s]]', userTitle.prefixedText, userTitle.text )
end

--- Entry point for module
-- @param {table} frame processing frame
-- @return {string} wikitext
function p.main( frame )
	local args = getArgs( frame )
	return p._main( args, frame )
end

function p._main( args, frame )
	frame = frame or mw.getCurrentFrame()
	if not mw.isSubsting() and not args['__demo'] then
		error( "[[Module:Courtesy ping]] must be substituted" )
	end
	local links = {}
	local noPing = {}
	local i = 1
	while args["noping" .. i] do
		noPing[ args[ "noping" .. i ] ] = true
		i = i + 1	
	end
	local wikitext = args['wikitext'] or args[1] or nil
	local pageToInclude = args['title'] or ''
	local lstTitle = mw.title.new( pageToInclude )
	if not wikitext and lstTitle then
		if lstTitle.fragment and lstTitle.fragment ~= ''  then
			wikitext = frame:callParserFunction('#lsth', { lstTitle.prefixedText, lstTitle.fragment })
		else
			wikitext = frame:preprocess(lstTitle:getContent())
		end
	elseif not wikitext then
		error( "Wikitext or a page title with section must be specified!" )
	end
	mw.log( wikitext )
	
	-- Thanks ChatGPT
	for link, display in mw.ustring.gmatch(wikitext, "%[%[([^%[%]|]+)%|?([^%[%]]*)%]%]") do
		mw.logObject({link, display})
	    if display == "" then
	        display = link  -- No display text, so use the link itself
	    end
		if not links[ link ] then links[ link ] = mw.title.new( link ) end
	end
	-- local wikitextArray = mw.text.split( wikitext, '' )
	-- local inWikiLink = false
	-- local inPipedLink = false
	-- local trimmed = false
	-- local toProcess = ''
	-- for k,v in ipairs( wikitextArray ) do
	-- 	if k ~= 1 then
	-- 		if inWikiLink then
	-- 			toProcess = toProcess .. v
	-- 			if wikitextArray[ k ] == '|' then
	-- 				toProcess = mw.ustring.sub( toProcess, 0,
	-- 					mw.ustring.len( toProcess ) - 1 )
	-- 				trimmed = true
	-- 				inPipedLink = true
	-- 				inWikiLink = false
	-- 			end
	-- 		end
	-- 		if not inWikiLink and not inPipedLink then
	-- 			trimmed = false
	-- 			if wikitextArray[ k ] == '[' and wikitextArray[ k - 1 ] == '['
	-- 				then
	-- 				toProcess = ''
	-- 				inWikiLink = true
	-- 			end
	-- 		else
	-- 			if wikitextArray[ k ] == ']' and wikitextArray[ k - 1 ] == ']'
	-- 				then
	-- 				if not trimmed then
	-- 					toProcess = mw.ustring.sub( toProcess, 0,
	-- 						mw.ustring.len( toProcess ) - 2 )
	-- 					trimmed = true
	-- 				end
	-- 				links[ toProcess ] = mw.title.new( toProcess )
	-- 				toProcess = ''
	-- 				inWikiLink = false
	-- 				inPipedLink = false
	-- 			end
	-- 		end
	-- 	end
	-- end
	
	mw.logObject( links )
	
	local out = {}
	
	for k,v in pairs(links) do
		mw.logObject( v )
		if v ~= nil then
			if v.namespace == 2 and not v.isSubpage and not noPing[ v.text ] then
				table.insert( out, makeUserLink( v ) )
			end
		end
	end
	
	return '<!-- Begin [[Module:Courtesy ping]] -->' .. mw.text.trim( table.concat( out, ' ' ) )
		.. '<!-- End [[Module:Courtesy ping]] -->'	
end

return p