Module:URL: Difference between revisions

From Brunswick MD History
Jump to navigation Jump to search
m (1 revision imported)
m (1 revision imported)
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
-- This module implements {{URL}}
-- This module implements {{URL}}
--
--
-- See unit tests at [[Module:URL/tests]]
-- See unit tests at [[Module:URL/testcases]]


local p = {}
local p = {}
   
   
local function safeUri(s)
local function safeUri(s)
    local success, uri = pcall(function()
local success, uri = pcall(function()
        return mw.uri.new(s)
return mw.uri.new(s)
    end)
end)
    if success then
if success then
        return uri
return uri
    end
end
end
end


function p._url(url, text)
local function extractUrl(args)
    url = mw.text.trim(url or '')
for name, val in pairs(args) do
    text = mw.text.trim(text or '')
if name ~= 2 and name ~= "msg" then
   
local url = name .. "=" .. val;
    if url == '' then
url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?):(/?)([^/])', 'http%1://%3')
        if text == '' then
local uri = safeUri(url);
            return mw.getCurrentFrame():expandTemplate{ title = 'tlx', args = { 'URL', "''example.com''", "''optional display text''" } }
if uri and uri.host then
        else
return url
            return text
end
        end
end
    end
end
   
end
    -- If the URL contains any unencoded spaces, encode them, because MediaWiki will otherwise interpret a space as the end of the URL.
 
    url = mw.ustring.gsub(url, '%s', function(s) return mw.uri.encode(s, 'PATH') end)
function p._url(url, text, msg)
   
url = mw.text.trim(url or '')
    -- If there is an empty query string or fragment id, remove it as it will cause mw.uri.new to throw an error
text = mw.text.trim(text or '')
    url = mw.ustring.gsub(url, '#$', '')
local nomsg = (msg or ''):sub(1,1):lower() == "n" or msg == 'false' -- boolean: true if msg is "false" or starts with n or N
    url = mw.ustring.gsub(url, '%?$', '')
 
   
if url == '' then
    -- If it's an HTTP[S] URL without the double slash, fix it.
if text == '' then
    url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?):(/?)([^/])', 'http%1://%3')
if nomsg then
return nil
else
return mw.getCurrentFrame():expandTemplate{ title = 'tlx', args = { 'URL', "''example.com''", "''optional display text''" } }
end
else
return text
end
end
 
-- If the URL contains any unencoded spaces, encode them, because MediaWiki will otherwise interpret a space as the end of the URL.
url = mw.ustring.gsub(url, '%s', function(s) return mw.uri.encode(s, 'PATH') end)
 
-- If there is an empty query string or fragment id, remove it as it will cause mw.uri.new to throw an error
url = mw.ustring.gsub(url, '#$', '')
url = mw.ustring.gsub(url, '%?$', '')
 
-- If it's an HTTP[S] URL without the double slash, fix it.
url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?):(/?)([^/])', 'http%1://%3')
 
-- Handle URLs from Wikidata of the format http://
url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?)://', 'http%1://')
 
local uri = safeUri(url)
 
-- Handle URL's without a protocol and URL's that are protocol-relative,
-- e.g. www.example.com/foo or www.example.com:8080/foo, and //www.example.com/foo
if uri and (not uri.protocol or (uri.protocol and not uri.host)) and url:sub(1, 2) ~= '//' then
url = 'http://' .. url
uri = safeUri(url)
end
 
if text == '' then
if uri then
if uri.path == '/' then uri.path = '' end


    -- Handle URLs from Wikidata of the format http://
local port = ''
    url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?)://', 'http%1://')
if uri.port then port = ':' .. uri.port end
   
 
    local uri = safeUri(url)
text = mw.ustring.lower(uri.host or '') .. port .. (uri.relativePath or '')
   
    -- Handle URL's without a protocol and URL's that are protocol-relative,
    -- e.g. www.example.com/foo or www.example.com:8080/foo, and //www.example.com/foo
    if uri and (not uri.protocol or (uri.protocol and not uri.host)) and url:sub(1, 2) ~= '//' then
        url = 'http://' .. url
        uri = safeUri(url)
    end
   
    if text == '' then
        if uri then
            if uri.path == '/' then uri.path = '' end
           
            local port = ''
            if uri.port then port = ':' .. uri.port end
           
            text = mw.ustring.lower(uri.host or '') .. port .. (uri.relativePath or '')


-- Add <wbr> before _/.-# sequences
-- Add <wbr> before _/.-# sequences
Line 64: Line 82:
text = mw.ustring.gsub(text,"(%#+)","<wbr/>%1")
text = mw.ustring.gsub(text,"(%#+)","<wbr/>%1")
text = mw.ustring.gsub(text,"(_+)","<wbr/>%1")
text = mw.ustring.gsub(text,"(_+)","<wbr/>%1")
        else -- URL is badly-formed, so just display whatever was passed in
else -- URL is badly-formed, so just display whatever was passed in
            text = url
text = url
        end
end
    end
end


    return mw.ustring.format('<span class="url">[%s %s]</span>', url, text)
return mw.ustring.format('<span class="url">[%s %s]</span>', url, text)
end
end


--[[
The main entry point for calling from Template:URL.
--]]
function p.url(frame)
function p.url(frame)
    local templateArgs = frame.args
local templateArgs = frame.args
local parentArgs = frame:getParent().args;
local parentArgs = frame:getParent().args
    local url = templateArgs[1] or parentArgs[1] or ''
local url = templateArgs[1] or parentArgs[1]
    local text = templateArgs[2] or parentArgs[2]
local text = templateArgs[2] or parentArgs[2] or ''
    if not text then
local msg = templateArgs.msg or parentArgs.msg or ''
    url = url or extractUrl(templateArgs) or extractUrl(parentArgs);
url = url or extractUrl(templateArgs) or extractUrl(parentArgs) or ''
end
return p._url(url, text, msg)
text = text or ''
    return p._url(url, text)
end
end
function extractUrl(args)
 
for name, val in pairs(args) do
--[[
local url = name .. "=" .. val;
The entry point for calling from the forked Template:URL2.
url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?):(/?)([^/])', 'http%1://%3')
This function returns no message by default.
local uri = safeUri(url);
It strips out wiki-link markup, html tags, and everything after a space.
if uri and uri.host then
--]]
return url
function p.url2(frame)
end
local templateArgs = frame.args
end
local parentArgs = frame:getParent().args
local url = templateArgs[1] or parentArgs[1]
local text = templateArgs[2] or parentArgs[2] or ''
-- default to no message
local msg = templateArgs.msg or parentArgs.msg or 'no'
url = url or extractUrl(templateArgs) or extractUrl(parentArgs) or ''
-- strip out html tags and [ ] from url
url = (url or ''):gsub("<[^>]*>", ""):gsub("[%[%]]", "")
-- truncate anything after a space
url = url:gsub("%%20", " "):gsub(" .*", "")
return p._url(url, text, msg)
end
end
return p
return p

Latest revision as of 09:31, 26 May 2020

Documentation for this module may be created at Module:URL/doc

--
-- This module implements {{URL}}
--
-- See unit tests at [[Module:URL/testcases]]

local p = {}
 
local function safeUri(s)
	local success, uri = pcall(function()
		return mw.uri.new(s)
	end)
	if success then
		return uri
	end
end

local function extractUrl(args)
	for name, val in pairs(args) do
		if name ~= 2 and name ~= "msg" then
			local url = name .. "=" .. val;
			url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?):(/?)([^/])', 'http%1://%3')
			local uri = safeUri(url);
			if uri and uri.host then
				return url
			end
		end
	end
end

function p._url(url, text, msg)
	url = mw.text.trim(url or '')
	text = mw.text.trim(text or '')
	local nomsg = (msg or ''):sub(1,1):lower() == "n" or msg == 'false' -- boolean: true if msg is "false" or starts with n or N

	if url == '' then
		if text == '' then
			if nomsg then
				return nil
			else
				return mw.getCurrentFrame():expandTemplate{ title = 'tlx', args = { 'URL', "''example.com''", "''optional display text''" } }
			end
		else
			return text
		end
	end

	-- If the URL contains any unencoded spaces, encode them, because MediaWiki will otherwise interpret a space as the end of the URL.
	url = mw.ustring.gsub(url, '%s', function(s) return mw.uri.encode(s, 'PATH') end)

	-- If there is an empty query string or fragment id, remove it as it will cause mw.uri.new to throw an error
	url = mw.ustring.gsub(url, '#$', '')
	url = mw.ustring.gsub(url, '%?$', '')

	-- If it's an HTTP[S] URL without the double slash, fix it.
	url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?):(/?)([^/])', 'http%1://%3')

	-- Handle URLs from Wikidata of the format http&#58;//
	url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?)&#58;//', 'http%1://')

	local uri = safeUri(url)

	-- Handle URL's without a protocol and URL's that are protocol-relative, 
	-- e.g. www.example.com/foo or www.example.com:8080/foo, and //www.example.com/foo
	if uri and (not uri.protocol or (uri.protocol and not uri.host)) and url:sub(1, 2) ~= '//' then
		url = 'http://' .. url
		uri = safeUri(url)
	end

	if text == '' then
		if uri then
			if uri.path == '/' then uri.path = '' end

			local port = ''
			if uri.port then port = ':' .. uri.port end

			text = mw.ustring.lower(uri.host or '') .. port .. (uri.relativePath or '')

			-- Add <wbr> before _/.-# sequences
			text = mw.ustring.gsub(text,"(/+)","<wbr/>%1")      -- This entry MUST be the first. "<wbr/>" has a "/" in it, you know.
			text = mw.ustring.gsub(text,"(%.+)","<wbr/>%1")
			-- text = mw.ustring.gsub(text,"(%-+)","<wbr/>%1") 	-- DISABLED for now
			text = mw.ustring.gsub(text,"(%#+)","<wbr/>%1")
			text = mw.ustring.gsub(text,"(_+)","<wbr/>%1")
		else -- URL is badly-formed, so just display whatever was passed in
			text = url
		end
	end

	return mw.ustring.format('<span class="url">[%s %s]</span>', url, text)
end

--[[
The main entry point for calling from Template:URL.
--]]
function p.url(frame)
	local templateArgs = frame.args
	local parentArgs = frame:getParent().args
	local url = templateArgs[1] or parentArgs[1]
	local text = templateArgs[2] or parentArgs[2] or ''
	local msg = templateArgs.msg or parentArgs.msg or ''
	url = url or extractUrl(templateArgs) or extractUrl(parentArgs) or ''
	return p._url(url, text, msg)
end

--[[
The entry point for calling from the forked Template:URL2.
This function returns no message by default.
It strips out wiki-link markup, html tags, and everything after a space.
--]]
function p.url2(frame)
	local templateArgs = frame.args
	local parentArgs = frame:getParent().args
	local url = templateArgs[1] or parentArgs[1]
	local text = templateArgs[2] or parentArgs[2] or ''
	-- default to no message
	local msg = templateArgs.msg or parentArgs.msg or 'no'
	url = url or extractUrl(templateArgs) or extractUrl(parentArgs) or ''
	-- strip out html tags and [ ] from url
	url = (url or ''):gsub("<[^>]*>", ""):gsub("[%[%]]", "")
	-- truncate anything after a space
	url = url:gsub("%%20", " "):gsub(" .*", "")
	return p._url(url, text, msg)
end

return p