Jump to content

Module:InfoboxImage/sandbox

Add links
From Wikipedia, the free encyclopedia
< Module:InfoboxImage
This is an old revision of this page, as edited by Hike395 (talk | contribs) at 14:47, 1 October 2025 (more typos). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
-- Inputs:
--    image - Can either be a bare filename (with or without the File:/Image: prefix) or a fully formatted image link
--    page - page to display for multipage images (DjVu)
--    size - size to display the image
--    maxsize - maximum size for image
--    sizedefault - default size to display the image if size param is blank
--    alt - alt text for image
--    title - title text for image
--    border - set to yes if border
--    center - set to yes, if the image has to be centered
--    upright - upright image param
--    suppressplaceholder - if yes then checks to see if image is a placeholder and suppresses it
--    link - page to visit when clicking on image
--    class - HTML classes to add to the image
-- Outputs:
--    Formatted image.
-- More details available at the "Module:InfoboxImage/doc" page

local i = {};

local placeholder_image = {
    "Blue - Replace this image female.svg",
    "Blue - Replace this image male.svg",
    "Flag of None (square).svg",
    "Flag of None.svg",
    "Flag of.svg",
    "Green - Replace this image female.svg",
    "Green - Replace this image male.svg",
    "Image is needed female.svg",
    "Image is needed male.svg",
    "Location map of None.svg",
    "Male no free image yet.png",
    "Missing flag.png",
    "No flag.svg",
    "No free portrait.svg",
    "No portrait (female).svg",
    "No portrait (male).svg",
    "Red - Replace this image female.svg",
    "Red - Replace this image male.svg",
    "Replace this image female.svg",
    "Replace this image male (blue).svg",
    "Replace this image male.svg",
    "Silver - Replace this image female.svg",
    "Silver - Replace this image male.svg",
    "Replace this image.svg",
	"Cricket no pic.png",
	"CarersLogo.gif",
	"Diagram Needed.svg",
	"Example.jpg",
	"Image placeholder.png",
	"No male portrait.svg",
	"Nocover-upload.png",
	"NoDVDcover copy.png",
	"Noribbon.svg",
	"No portrait-BFD-test.svg",
	"Placeholder barnstar ribbon.png",
	"Project Trains no image.png",
	"Image-request.png",
	"Sin bandera.svg",
	"Sin escudo.svg",
	"Replace this image - temple.png",
	"Replace this image butterfly.png",
	"Replace this image.svg",
	"Replace this image1.svg",
	"Resolution angle.png",
	"Image-No portrait-text-BFD-test.svg",
	"Insert image here.svg",
	"No image available.png",
	"NO IMAGE YET square.png",
	"NO IMAGE YET.png",
	"No Photo Available.svg",
	"No Screenshot.svg",
	"No-image-available.jpg",
	"Null.png",
	"PictureNeeded.gif",
	"Place holder.jpg",
	"Unbenannt.JPG",
	"UploadACopyrightFreeImage.svg",
	"UploadAnImage.gif",
	"UploadAnImage.svg",
	"UploadAnImageShort.svg",
	"CarersLogo.gif",
	"Diagram Needed.svg",
	"No male portrait.svg",
	"NoDVDcover copy.png",
	"Placeholder barnstar ribbon.png",
	"Project Trains no image.png",
	"Image-request.png",
	"Noimage.gif",
}

local categories = {
	url_image_links = "[[Category:Pages using infoboxes with URL in image parameter]]",
	thumbnail_images = "[[Category:Pages using infoboxes with thumbnail images]]",
    bad_sizes = "[[Category:Pages using infoboxes with bad image sizes]]",
}

local acceptableUnits = {cm=true,mm=true,["in"]=true,px=true,pt=true,pc=true,
                         em=true,ex=true,ch=true,rem=true,vw=true,vh=true,
                         vmin=true,vmax=true,["%"]=true}

local function trackable()
	local ns = mw.title.getCurrentTitle().nsText:lower()
	return not (ns == 'user' or ns == 'user talk')
end

function i.IsPlaceholder(image)
    -- change underscores to spaces
    image = mw.ustring.gsub(image, "_", " ");
    assert(image ~= nil, 'mw.ustring.gsub(image, "_", " ") must not return nil')
    -- if image starts with [[ then remove that and anything after |
    if mw.ustring.sub(image,1,2) == "[[" then
        image = mw.ustring.sub(image,3);
        image = mw.ustring.gsub(image, "([^|]*)|.*", "%1");
        assert(image ~= nil, 'mw.ustring.gsub(image, "([^|]*)|.*", "%1") must not return nil')
    end
    -- Trim spaces
    image = mw.ustring.gsub(image, '^[ ]*(.-)[ ]*$', '%1');
    assert(image ~= nil, "mw.ustring.gsub(image, '^[ ]*(.-)[ ]*$', '%1') must not return nil")
    -- remove prefix if exists
    local allNames = mw.site.namespaces[6].aliases
    allNames[#allNames + 1] = mw.site.namespaces[6].name
    allNames[#allNames + 1] = mw.site.namespaces[6].canonicalName
    for i, name in ipairs(allNames) do
        if mw.ustring.lower(mw.ustring.sub(image, 1, mw.ustring.len(name) + 1)) == mw.ustring.lower(name .. ":") then
            image = mw.ustring.sub(image, mw.ustring.len(name) + 2);
            break
        end
    end
    -- Trim spaces
    image = mw.ustring.gsub(image, '^[ ]*(.-)[ ]*$', '%1');
    -- capitalise first letter
    image = mw.ustring.upper(mw.ustring.sub(image,1,1)) .. mw.ustring.sub(image,2);

    for i,j in pairs(placeholder_image) do
        if image == j then
            return true
        end
    end
    return false
end

local function isempty(x)
    return (not x) or x == ""
end

local function splitUnit(s)
    local value, unit = string.match(tostring(s),"%s*(%d+)([^%s]*)")
    if not value then
       return nil
    end
    if unit == '' then
       unit = "px"
    end
    if not acceptableUnits[unit] then
       return nil
    end
    return tonumber(value), unit
end

function i.InfoboxImage(frame)
    local image = frame.args["image"];
    
    if isempty(image) then
        return "";
    end
    if image == "&nbsp;" then
        return image;
    end
    if frame.args["suppressplaceholder"] ~= "no" then
        if i.IsPlaceholder(image) == true then
            return "";
        end
    end
    
    if string.find(image, "^%[*https?:") then
		-- Error category.
		return trackable() and categories.url_image_links or ""
	end

    if mw.ustring.sub(image,1,2) == "[[" then
        -- search for thumbnail images and add to tracking cat if found
        local cat = "";
        if mw.title.getCurrentTitle().namespace == 0 and (mw.ustring.find(image, "|%s*thumb%s*[|%]]") or mw.ustring.find(image, "|%s*thumbnail%s*[|%]]")) then
            cat = trackable() and categories.thumbnail_images or ""
        end
        return image .. cat;
    elseif mw.ustring.sub(image,1,2) == "{{" and mw.ustring.sub(image,1,3) ~= "{{{" then
        return image;
    elseif mw.ustring.sub(image,1,1) == "<" then
        return image;
    elseif mw.ustring.sub(image,1,8) == mw.ustring.char(127).."'\"`UNIQ" then
        -- Found strip marker at begining, so pass don't process at all
        return image;
    else
        local result = "";
        local page = frame.args["page"];
        local upright = frame.args["upright"] or ""
        local size = frame.args["size"];
        local maxsize = frame.args["maxsize"];
        local sizedefault = frame.args["sizedefault"];
        local alt = frame.args["alt"];
        local link = frame.args["link"];
        local title = frame.args["title"];
        local border = frame.args["border"];
        local thumbtime = frame.args["thumbtime"] or "";
        local center = frame.args["center"];
        local class = frame.args["class"];
        
        -- remove prefix if exists
        local allNames = mw.site.namespaces[6].aliases
        allNames[#allNames + 1] = mw.site.namespaces[6].name
        allNames[#allNames + 1] = mw.site.namespaces[6].canonicalName
        for i, name in ipairs(allNames) do
            if mw.ustring.lower(mw.ustring.sub(image, 1, mw.ustring.len(name) + 1)) == mw.ustring.lower(name .. ":") then
                image = mw.ustring.sub(image, mw.ustring.len(name) + 2);
                break
            end
        end

        
        -- Analyze size units.
        local sizeValue
        local sizeUnit
        if not isempty(size) then
            sizeValue, sizeUnit = splitUnit(size)
            if not sizeValue then
                return trackable() and categories.bad_sizes or ""
            end
        end
        -- handle corner case of sizedefault=frameless. Editor want some sort of sensible default
        -- Following [[MOS;IMGSIZE]], set a default of upright=1 if neither upright nor size parameters are specified
        if sizedefault == 'frameless' then
            sizedefault = nil
            if isempty(size) and isempty(upright) then
                upright = 1.0
            end
        end
        -- analyze sizedefault units
        local sizedefaultValue
        local sizedefaultUnit
        if not isempty(sizedefault) then
            sizedefaultValue, sizedefaultUnit = splitUnit(sizedefault)
            -- error only if sizeDefault is actually used
        end
        -- Handle maxsize case.
        -- If maxsize units not the same as size units, then error
        if not isempty(maxsize) then
            local maxsizeValue
            local maxsizeUnit
            maxsizeValue, maxsizeUnit = splitUnit(maxsize)
            if not maxsizeValue then
                return trackable() and categories.bad_sizes or ""
            end
            -- if no sizedefault nor upright, then set to maxsize
            if isempty(sizedefault) and isempty(upright) then
                mw.log("sizedefault=maxsize")
                sizedefault = maxsizeValue..maxsizeUnit
                sizedefaultValue = maxsizeValue
                sizedefaultUnit = maxsizeUnit
            end
            -- check to see if size bigger than maxsize
            if not isempty(size) then
                if sizeUnit ~= maxsizeUnit then
                    return trackable() and categories.bad_sizes or ""
                end
                if sizeValue > maxsizeValue and maxsizeValue > 0 then
                   size = maxsizeValue..maxsizeUnit
                   sizeValue = maxsizeValue;  -- units have to match here
                end
            end
            -- check to see if upright bigger than maxsize (at default preferred size)
            -- only enforce this if maxsizeUnit is px
            if not isempty(upright) and maxsizeUnit == "px" then
                local uprightnumber = tonumber(upright) or (upright == "yes" and 0.75) or 0
                if uprightnumber*220 > maxsizeValue and maxsizeValue > 0 then
                    upright = tostring(maxsizeValue/220)
                end
            end
        end
    
        result = "[[File:" .. image;
        if not isempty(page) then
            result = result .. "|page=" .. page;
        end
        if not isempty(size) then
            -- append sizeUnit because it may be px inferred from blank
            result = result .. "|" .. sizeValue .. sizeUnit
        elseif not isempty(sizedefault) and isempty(upright) then
            -- use sizedefault, but check if units are ok
            if not sizedefaultValue then
                return trackable() and categories.bad_sizes or ""
            end
            -- append sizedefaultUnit because it may be px inferred from blank
            result = result .. "|" .. sizedefaultValue .. sizedefaultUnit;
        else
            result = result .. "|frameless";
        end
        if center == "yes" then
            result = result .. "|center"
        end
        if not isempty(alt) then
            result = result .. "|alt=" .. alt;
        end
        if not isempty(link) then
            result = result .. "|link=" .. link;
        end
        if border == "yes" then
            result = result .. "|border";
        end
        if upright == "yes" then
            result = result .. "|upright";
        elseif upright ~= "" then
            result = result .. "|upright=" .. upright;
        end
        if thumbtime ~= "" then
            result = result .. "|thumbtime=" .. thumbtime;
        end
        if not isempty(class) then
            result = result .. "|class=" .. class;
        end
        -- if alt value is a keyword then do not use as a description
        if alt == "thumbnail" or alt == "thumb" or alt == "frameless" or alt == "left" or alt == "center" or alt == "right" or alt == "upright" or alt == "border" or mw.ustring.match(alt or "", '^[0-9]*px$', 1) ~= nil then
            alt = nil;
        end
        if not isempty(title) then
            -- does title param contain any templatestyles? If yes then set to blank.
            if mw.ustring.match(frame:preprocess(title), 'UNIQ%-%-templatestyles', 1) ~= nil then
                title = nil;
            end
        end
        if not isempty(title) then
            result = result .. "|" .. title;
        end
        result = result .. "]]";
        
        return result;
    end
end

return i;
Retrieved from "https://en.wikipedia.org/w/index.php?title=Module:InfoboxImage/sandbox&oldid=1314460901"