Module:URL

From MediaWiki.org
Jump to navigation Jump to search
Module documentation

All tests passed.

test_formatUrl:

Text Expected Actual
Yes {{#invoke:URL | formatUrl | }}
Yes {{#invoke:URL | formatUrl | EXAMPLE.com }} example.com example.com
Yes {{#invoke:URL | formatUrl | example.com }} example.com example.com
Yes {{#invoke:URL | formatUrl | www.example.com }} example.com example.com
Yes {{#invoke:URL | formatUrl | http://www.example.com }} example.com example.com
Yes {{#invoke:URL | formatUrl | http://пример.рф }} пример.рф пример.рф
Yes {{#invoke:URL | formatUrl | https://www.example.com }} example.com example.com
Yes {{#invoke:URL | formatUrl | ftp://www.example.com }} example.com example.com
Yes {{#invoke:URL | formatUrl | ftp://ftp.example.com }} ftp.example.com ftp.example.com
Yes {{#invoke:URL | formatUrl | http://www.example.com/ }} example.com example.com
Yes {{#invoke:URL | formatUrl | //ftp.example.com }} ftp.example.com ftp.example.com
Yes {{#invoke:URL | formatUrl | //www.example.com/ }} example.com example.com
Yes {{#invoke:URL | formatUrl | www.example.com/foo }} example.com/foo example.com/foo
Yes {{#invoke:URL | formatUrl | http://www.example.com/foo }} example.com/foo example.com/foo
Yes {{#invoke:URL | formatUrl | http://sub.example.com/foo/bar }} sub.example.com/foo/bar sub.example.com/foo/bar
Yes {{#invoke:URL | formatUrl | example.com?a }} example.com?a example.com?a
Yes {{#invoke:URL | formatUrl | http://sub.example.com/foo/bar?a }} sub.example.com/foo/bar?a sub.example.com/foo/bar?a
Yes {{#invoke:URL | formatUrl | example.com | title }} title title
Yes {{#invoke:URL | formatUrl | example.com?a | title }} title title
Yes {{#invoke:URL | formatUrl | http://sub.example.com/foo/bar | title }} title title
Yes {{#invoke:URL | formatUrl | http://sub.example.com/foo/bar?a | title }} title title
Yes {{#invoke:URL | formatUrl | [http://example.com] }} example.com example.com
Yes {{#invoke:URL | formatUrl | [http://example.com title] }} title title
Yes {{#invoke:URL | formatUrl | [http://пример.рф пример] }} пример пример
Yes {{#invoke:URL | formatUrl | [http://example.com old title] | title }} title title
Yes {{#invoke:URL | formatUrl | email@example.com }} email@example.com email@example.com
Yes {{#invoke:URL | formatUrl | mailto:email@example.com }} email@example.com email@example.com
Yes {{#invoke:URL | formatUrl | [http://example.com title] {{ok}} }} title  OK title  OK
Yes {{#invoke:URL | formatUrl | http://example.com/very/long/path/index.html | length = 25 }} example.com/very/long/pa… example.com/very/long/pa…
Yes {{#invoke:URL | formatUrl | http://very.long.domain.example.com/index.html | length = 25 }} very.long.domain.example.com/… very.long.domain.example.com/…

p = {}

function startsWith( source, substring )
	if mw.ustring.len( substring ) > mw.ustring.len( source ) then
		return false
	end
	return mw.ustring.sub( source, 1, mw.ustring.len( substring ) ) == substring
end

function formatUrlImpl( source, title, length )
	local scheme, host, path
	local postfix = ''
	local arg1, arg2 = source, title
	source = mw.text.trim( source, "%[%] " )
	local titleDelimeterPosition = mw.ustring.find( source, " ", 1 )
	if titleDelimeterPosition then
		if not title or title == "" then
			title = mw.ustring.sub( source, titleDelimeterPosition + 1 )
			local postfixDelimeterPosition = mw.ustring.find( title, "%]", 1 )
			if postfixDelimeterPosition then
				postfix = mw.ustring.sub( title, postfixDelimeterPosition + 1 )
				title = mw.ustring.sub( title, 1, postfixDelimeterPosition - 1 )
			end
		end
		source = mw.ustring.sub( source, 1, titleDelimeterPosition - 1 )
	end
	
	local hostStartPosition
	local schemeDelimeterPosition = mw.ustring.find( source, "://", 1, true )
	if schemeDelimeterPosition then
		scheme = mw.ustring.sub( source, 1, schemeDelimeterPosition + 2)
		hostStartPosition = schemeDelimeterPosition + 3
	elseif mw.ustring.find( source, "^//", 1 ) then
		scheme = "//"
		hostStartPosition = 3
	elseif mw.ustring.find( source, "^mailto:", 1 ) then
		scheme = "mailto:"
		hostStartPosition = 8
	elseif mw.ustring.find( source, "@", 1 ) then
		scheme = "mailto:"
		source = scheme .. source
		hostStartPosition = 8
	else
		scheme = "http://"
		source = scheme .. source
		hostStartPosition = 8
	end

	if title then
		local finds = mw.ustring.find( arg1, "[", 1, true )
		if titleDelimeterPosition and finds and finds > titleDelimeterPosition + 1 then
			return arg1
		end
		return '[' .. source .. ' ' .. title .. ']' .. postfix
	end

	local hostDelimeterPosition = mw.ustring.find( source, "/", hostStartPosition, true )
	if hostDelimeterPosition then
		host = mw.ustring.sub( source, hostStartPosition, hostDelimeterPosition - 1 )
		if hostDelimeterPosition == mw.ustring.len( source ) then
			path = nil
		else
			path = mw.ustring.sub( source, hostDelimeterPosition + 1 )
		end
	else
		host = mw.ustring.sub( source, hostStartPosition )
	end

	-- post-split format options
	if startsWith( host, 'www.' ) then
		host = mw.ustring.sub( host, 5 )
	end
	host = mw.language.new( 'en' ):lc( host )

	if path and path ~= '' and path ~= '/' then
		local title = host .. '/' .. path
		if length and #title > length then
			title = host .. '/' .. mw.ustring.sub( path, 1, length - #title - 2 ) .. '…'
		end
		return '[' .. source .. ' ' .. title .. ']' .. postfix
	else
		return '[' .. source .. ' ' .. host .. ']' .. postfix
	end
end

function p.formatUrl( frame )
	local url = frame.args[1] or ''
	local title = frame.args[2] or ''
	local length = frame.args['length'] and tonumber( frame.args['length'] )

	url = mw.text.trim( url )
	title = mw.text.trim( title )

	if url == '' then
		return nil
	end
	if title == '' then
		title = nil
	end
	return formatUrlImpl( url, title, length )
end

function p.formatUrlSingle( context, options, url )
	url = mw.text.trim( url )
	if url == '' then
		return nil
	end
	local title = nil
	if ( options['text'] and options['text'] ~= '' ) then
		title = options['text']
	end
	local length = options['length'] and tonumber( options['length'] )

	return formatUrlImpl( url, title, length )
end

return p