Difference between revisions of "Module:URL"

From iRASPA
Jump to: navigation, search
(Alright, redeploying. I feel this Module is thoroughly tested this time. I even spot-checked it against Portable Document Format right now.)
 
(Per talk page request. I studied the syntax carefully. Looks like it is alright after all. Since two eyes have seen this, I assume it is okay to commit it to the production version.)
Line 6: Line 6:
 
local p = {}
 
local p = {}
 
   
 
   
function trim(s)
+
local function safeUri(s)
    return (mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1"))
 
end
 
 
 
function safeUri(s)
 
 
     local success, uri = pcall(function()
 
     local success, uri = pcall(function()
 
         return mw.uri.new(s)
 
         return mw.uri.new(s)
Line 20: Line 16:
  
 
function p._url(url, text)
 
function p._url(url, text)
     url = trim(url or '')
+
     url = mw.text.trim(url or '')
     text = trim(text or '')
+
     text = mw.text.trim(text or '')
 
      
 
      
 
     if url == '' then
 
     if url == '' then
Line 61: Line 57:
 
              
 
              
 
             text = mw.ustring.lower(uri.host or '') .. port .. (uri.relativePath or '')
 
             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
 
         else -- URL is badly-formed, so just display whatever was passed in
 
             text = url
 
             text = url
Line 66: Line 69:
 
     end
 
     end
  
-- 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")
 
 
 
     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
Line 78: Line 74:
 
function p.url(frame)
 
function p.url(frame)
 
     local templateArgs = frame.args
 
     local templateArgs = frame.args
     local url = templateArgs[1] or ''
+
local parentArgs = frame:getParent().args;
     local text = templateArgs[2] or ''
+
     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)
 
     return p._url(url, text)
 
end
 
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
 
return p

Revision as of 13:44, 23 February 2018

Documentation for this module may be created at Module:URL/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