Jump to content
Toggle search
Toggle menu
  • 3 articles
  • 75 files
  • 7 users
  • 37.9K edits
Neodyland Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Module:File: Difference between revisions

From Neodyland Wiki
More actions
← Older edit

commons>TheDJ

adding tests, woExtension
Add webp to list of supported file types
 
(31 intermediate revisions by 8 users not shown)
Line 1: Line 1:
-- Module for handling Media files (Origin: Wikimedia Commons)
-- Module for handling Media files (Origin: Wikimedia Commons)
local File = function(title)
 
local funcs = {}
require('strict')
-- =p.File("Foo.bar.svg").extension()
 
-- @return "svg"
-- ==================================================
funcs.extension = function()
-- === helper Lookup table ==========================
local parts = mw.text.split( title, '.', true )
-- ==================================================
return parts[#parts]
 
local extensionMap = {
-- File types with full support in Commons (See [[c:Commons:File types]]).
DJVU = 'image/vnd.djvu',
FLAC = 'audio/x-flac',
GIF  = 'image/gif',
JPEG = 'image/jpeg',
JPG  = 'image/jpeg',
MID  = 'audio/midi',
MP3  = 'audio/mpeg',
OGA  = 'audio/ogg',
OGG  = 'audio/ogg',
OGV  = 'video/ogg',
PDF  = 'application/pdf',
PNG  = 'image/png',
SVG  = 'image/svg+xml',
TIF  = 'image/tiff',
TIFF = 'image/tiff',
WEBM = 'video/webm',
WEBP = 'image/webp',
WAV  = 'audio/x-wav',
XCF  = 'image/xcf',
 
-- Other file types with restrictions (not accepted in standard uploads on Commons but in 'User:' namespace).
-- They could be supported in Wiki pages by embedding their content in an <pre> or <source> elements.
CSS  = 'text/css',
CSV  = 'text/csv',
JS  = 'application/javascript',
JSON = 'application/json',
TXT  = 'text/plain',
XML  = 'application/xml',
 
-- Only generated by MediaWiki on output of some queries, restricted in all uploads.
GZ  = 'application/gzip', -- delivered only only for some wiki results
ZIP  = 'application/zip', -- delivered only for some wiki data exports
 
-- Other file types not supported and to convert (a few of them may be in special administration namespaces).
DOC  = 'application/msword', -- please convert to PDF, DJVU, or Wiki
F4V  = 'video/mpeg', -- (deprecated, replaced by MP4) please convert to OGV or WEBM
FLV  = 'video/x-flv', -- (deprecated, replaced by MP4) please convert to OGV or WEBM
ICO  = 'image/vnd.microsoft.icon', -- used in MediaWiki resources for 'website icons'
MP4  = 'video/mp4',
QT  = 'video/quicktime', -- (deprecated, replaced by MP4) please convert to OGV or WEBM
RA  = 'audio/vnd.rn-realaudio', -- (deprecated, replaced by MP3) please convert to OGA
SWF  = 'video/x-flv', -- (deprecated, replaced by MP4) please convert to OGV or WEBM
WMA  = 'audio/x-ms-wma', -- please convert to OGA
WMV  = 'video/x-ms-wmv', -- please convert to OGV or WEBM
XLS  = 'application/vnd.ms-excel', -- please convert to PDF, DJVU, or Wiki
}
 
-- ==================================================
-- === Local functions ==============================
-- ==================================================
 
local function filename(frame)
return frame.args[1] or frame.args["file"] or frame.args["title"]
end
 
local function getMetadata(frame)
local fname = filename(frame)
local title
if fname then
        title = mw.title.new(fname, 6)
else
        title = mw.title.getCurrentTitle()
end
end
-- =p.File("Foo.bar.svg").woExtension()
if title then
-- Original author: Bawolff at [[Module:FileName]]
return title.file
-- @return "Foo.bar"
else
funcs.woExtension = function()
return {exists=false}
local parts = mw.text.split( title , '.', true )
local upTo = #parts - 1
if upTo == 0 then upTo = 1 end
return table.concat( parts, '.', 1, upTo )
end
end
-- mapping file extensions to MIME-types
end
funcs.extensionMap = {
 
PNG  = "image/png",
-- ==================================================
GIF  = "image/gif",
-- === External functions ===========================
SVG  = "image/svg+xml",
-- ==================================================
TIFF = "image/tiff",
local p = {}
TIF  = "image/tiff",
 
JPEG = "image/jpeg",
-- p.csExtension("Foo.bar.svg")
JPG  = "image/jpeg"
-- @return "svg"
}
function p.csExtension(frame)
-- =p.File("Foo.bar.svg").mime()
local fname = filename(frame) or mw.title.getCurrentTitle().text
funcs.mime = function()
local parts = mw.text.split(fname, '.', true)
local extension = funcs.extension():upper()
if #parts>1 then
return funcs.extensionMap[extension] or "unknown"
return parts[#parts]
else
return ''
end
end
-- =p.File("Foo.bar.tiff").maxthumb()
end
funcs.maxthumb = function()
 
local mime = funcs.mime()
function p.extension(frame)
if mime == "image/png" then
return p.csExtension(frame):lower()
return mw.getCurrentFrame():preprocess( '{{LargePNG/limit}}' )
end
elseif mime == "image/tiff" or mime == "image/gif" then
 
return mw.getCurrentFrame():preprocess( '{{LargeTIFF/limit}}' )
function p.extensionUpper(frame)
else
return p.csExtension(frame):upper()
return 'unknown @Module:File'
end
end
 
-- p.woExtension("Foo.bar.svg")
-- @return "Foo.bar"
-- Original author: Bawolff at [[Module:FileName]]
function p.woExtension(frame)
local fname = filename(frame) or mw.title.getCurrentTitle().text
local parts = mw.text.split(fname , '.', true)
local upTo = #parts - 1
if upTo == 0 then upTo = 1 end
return table.concat(parts, '.', 1, upTo)
end
 
function p.mime(frame)
local meta  = getMetadata(frame)
if meta.exists then
return meta.mimeType
else
return extensionMap[p.extensionUpper(frame)] or 'unknown'
end
end
return funcs
end
 
function p.mimeType(frame)
return getMetadata(frame).mimeType
end
end


-- Helpers
function p.fileExists(frame)
local h = {}
return getMetadata(frame).exists or ''
h.getArg = function(f)
return f.args[1] or f.args["file"] or f.args["title"]
end
end


-- @exports
-- This one won't throw errors at you
local p = {}
function p.fileExistsRelaxed(frame)
p.File = File
local ok, metadata = pcall(getMetadata(frame))
p.extension = function(frame)
if ok then
    return File( h.getArg(frame) ).extension():lower()
return metadata.exists or ''
else
return ''
end
end
 
function p.maxthumb(frame)
-- Limits in megapixels are currently stored in Commons templates, they could be in this module.
-- There may be more limits for other supported mime types (djvu, flac, ogv, pdf, svg, webm, xcf).
local maxthumbMap = {
['image/gif']  = 1000,
['image/png' ] = 2500, -- see Template:LargePNG/limit
['image/tiff'] = 1000, -- see Template:LargeTIFF/limit
}
local mime = p.mime(frame)
return maxthumbMap[mime] or 'unknown @Module:File'
end
end
p.extensionUpper = function(frame)
 
    return File( h.getArg(frame) ).extension():upper()
function p.dateWorkCreated(frame)
return '' -- no longer supported
end
end
p.woExtension = function(frame)
 
return File( h.getArg(frame) ).woExtension()
function p.width(frame)
return getMetadata(frame).width
end
end
p.mime = function(frame)
 
    return File( h.getArg(frame) ).mime()
function p.height(frame)
return getMetadata(frame).height
end
end
p.maxthumb = function(frame)
 
    return File( h.getArg(frame) ).maxthumb()
function p.dimensions(frame)
local d = getMetadata(frame)
if d.exists then
return d.width .. ' × ' .. d.height 
else
return ''
end
end
end


function p.size(frame)
return getMetadata(frame).size
end


p.runTests = function()
function p.pageCount(frame)
local toTest = require('Module:File/tests/all')
local pages = getMetadata(frame).pages or {1}
for i, t in ipairs(toTest) do
return #pages
local f = File(t.fileName)
local stringResult = ''
local ret = true
local results = {
extension = (t.extension == f.extension():lower()),
extensionUpper = (t.extensionUpper == f.extension():upper()),
woExtension = (t.woExtension == f.woExtension()),
mime = (t.mime == f.mime()),
maxthumb = (not (tonumber(f.maxthumb()) == nil) == t.maxthumbIsNumber)
}
for k, v in pairs(results) do
stringResult = stringResult .. k .. ': ' .. (v and 'ok    ' or 'failed') .. ' '
ret = ret and v
end
mw.log(i, ret and 'passed' or 'FAILED', t.typeOfFileName, (not ret) and ('\n >>' .. stringResult .. '\n    >> ' .. t.fileName) or '')
end
end
end


return p
return p
Retrieved from "https://wiki.neody.land/wiki/Module:File"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information