Difference between revisions of "Module:URL/sandbox"

From blackwiki
Jump to navigation Jump to search
blackwiki>RexxS
(move suppression of message switch to subroutine; clean up whitespace)
blackwiki>RexxS
(re-sync with main)
Line 7: Line 7:
 
   
 
   
 
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
 
 
 
local function extractUrl(args)
 
for name, val in pairs(args) do
 
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)
+
function p._url(url, text)
url = mw.text.trim(url or '')
+
    url = mw.text.trim(url or '')
text = mw.text.trim(text or '')
+
    text = mw.text.trim(text or '')
local nomsg = msg: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
 +
            return mw.getCurrentFrame():expandTemplate{ title = 'tlx', args = { 'URL', "''example.com''", "''optional display text''" } }
 +
        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')
  
if url == '' then
+
    -- Handle URLs from Wikidata of the format http://
if text == '' then
+
    url = mw.ustring.gsub(url, '^[Hh][Tt][Tt][Pp]([Ss]?)://', 'http%1://')
if nomsg then
+
   
return nil
+
    local uri = safeUri(url)
else
+
   
return mw.getCurrentFrame():expandTemplate{ title = 'tlx', args = { 'URL', "''example.com''", "''optional display text''" } }
+
    -- Handle URL's without a protocol and URL's that are protocol-relative,  
end
+
    -- e.g. www.example.com/foo or www.example.com:8080/foo, and //www.example.com/foo
else
+
    if uri and (not uri.protocol or (uri.protocol and not uri.host)) and url:sub(1, 2) ~= '//' then
return text
+
        url = 'http://' .. url
end
+
        uri = safeUri(url)
end
+
    end
 
+
   
-- If the URL contains any unencoded spaces, encode them, because MediaWiki will otherwise interpret a space as the end of the URL.
+
    if text == '' then
url = mw.ustring.gsub(url, '%s', function(s) return mw.uri.encode(s, 'PATH') end)
+
        if uri then
 
+
            if uri.path == '/' then uri.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, '#$', '')
+
            local port = ''
url = mw.ustring.gsub(url, '%?$', '')
+
            if uri.port then port = ':' .. uri.port end
 
+
           
-- If it's an HTTP[S] URL without the double slash, fix it.
+
            text = mw.ustring.lower(uri.host or '') .. port .. (uri.relativePath or '')
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
 
 
 
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 80: Line 64:
 
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
  
 
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] or ''
local text = templateArgs[2] or parentArgs[2]
+
    local text = templateArgs[2] or parentArgs[2]
local msg = templateArgs.msg or parentArgs.msg or ''
+
    if not text then
if not text then
+
    url = url or extractUrl(templateArgs) or extractUrl(parentArgs);
url = url or extractUrl(templateArgs) or extractUrl(parentArgs)
 
 
end
 
end
 
text = text or ''
 
text = text or ''
return p._url(url, text, msg)
+
    return p._url(url, text)
 +
end
 +
function extractUrl(args)
 +
for name, val in pairs(args) do
 +
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
 
 
return p
 
return p

Revision as of 23:21, 28 January 2019

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

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

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

function p._url(url, text)
    url = mw.text.trim(url or '')
    text = mw.text.trim(text or '')
    
    if url == '' then
        if text == '' then
            return mw.getCurrentFrame():expandTemplate{ title = 'tlx', args = { 'URL', "''example.com''", "''optional display text''" } }
        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

function p.url(frame)
    local templateArgs = frame.args
	local parentArgs = frame:getParent().args;
    local url = templateArgs[1] or parentArgs[1] or ''
    local text = templateArgs[2] or parentArgs[2]
    if not text then
    	url = url or extractUrl(templateArgs) or extractUrl(parentArgs);
	end
	text = text or ''
    return p._url(url, text)
end
function extractUrl(args)
	for name, val in pairs(args) do
		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
return p