1package mimetype
2
3import (
4	"sync"
5
6	"github.com/gabriel-vasile/mimetype/internal/magic"
7)
8
9// mimetype stores the list of MIME types in a tree structure with
10// "application/octet-stream" at the root of the hierarchy. The hierarchy
11// approach minimizes the number of checks that need to be done on the input
12// and allows for more precise results once the base type of file has been
13// identified.
14//
15// root is a detector which passes for any slice of bytes.
16// When a detector passes the check, the children detectors
17// are tried in order to find a more accurate MIME type.
18var root = newMIME("application/octet-stream", "",
19	func([]byte, uint32) bool { return true },
20	xpm, sevenZ, zip, pdf, fdf, ole, ps, psd, p7s, ogg, png, jpg, jxl, jp2, jpx,
21	jpm, gif, webp, exe, elf, ar, tar, xar, bz2, fits, tiff, bmp, ico, mp3, flac,
22	midi, ape, musePack, amr, wav, aiff, au, mpeg, quickTime, mqv, mp4, webM,
23	threeGP, threeG2, avi, flv, mkv, asf, aac, voc, aMp4, m4a, m3u, m4v, rmvb,
24	gzip, class, swf, crx, ttf, woff, woff2, otf, eot, wasm, shx, dbf, dcm, rar,
25	djvu, mobi, lit, bpg, sqlite3, dwg, nes, lnk, macho, qcp, icns, heic,
26	heicSeq, heif, heifSeq, hdr, mrc, mdb, accdb, zstd, cab, rpm, xz, lzip,
27	torrent, cpio, tzif, xcf, pat, gbr, glb,
28	// Keep text last because it is the slowest check
29	text,
30)
31
32// errMIME is returned from Detect functions when err is not nil.
33// Detect could return root for erroneous cases, but it needs to lock mu in order to do so.
34// errMIME is same as root but it does not require locking.
35var errMIME = newMIME("application/octet-stream", "", func([]byte, uint32) bool { return false })
36
37// mu guards access to the root MIME tree. Access to root must be synchonized with this lock.
38var mu = &sync.RWMutex{}
39
40// The list of nodes appended to the root node.
41var (
42	xz   = newMIME("application/x-xz", ".xz", magic.Xz)
43	gzip = newMIME("application/gzip", ".gz", magic.Gzip).alias(
44		"application/x-gzip", "application/x-gunzip", "application/gzipped",
45		"application/gzip-compressed", "application/x-gzip-compressed",
46		"gzip/document")
47	sevenZ = newMIME("application/x-7z-compressed", ".7z", magic.SevenZ)
48	zip    = newMIME("application/zip", ".zip", magic.Zip, xlsx, docx, pptx, epub, jar, odt, ods, odp, odg, odf, odc, sxc).
49		alias("application/x-zip", "application/x-zip-compressed")
50	tar = newMIME("application/x-tar", ".tar", magic.Tar)
51	xar = newMIME("application/x-xar", ".xar", magic.Xar)
52	bz2 = newMIME("application/x-bzip2", ".bz2", magic.Bz2)
53	pdf = newMIME("application/pdf", ".pdf", magic.Pdf).
54		alias("application/x-pdf")
55	fdf  = newMIME("application/vnd.fdf", ".fdf", magic.Fdf)
56	xlsx = newMIME("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", ".xlsx", magic.Xlsx)
57	docx = newMIME("application/vnd.openxmlformats-officedocument.wordprocessingml.document", ".docx", magic.Docx)
58	pptx = newMIME("application/vnd.openxmlformats-officedocument.presentationml.presentation", ".pptx", magic.Pptx)
59	epub = newMIME("application/epub+zip", ".epub", magic.Epub)
60	jar  = newMIME("application/jar", ".jar", magic.Jar)
61	ole  = newMIME("application/x-ole-storage", "", magic.Ole, msi, aaf, msg, xls, pub, ppt, doc)
62	msi  = newMIME("application/x-ms-installer", ".msi", magic.Msi).
63		alias("application/x-windows-installer", "application/x-msi")
64	aaf = newMIME("application/octet-stream", ".aaf", magic.Aaf)
65	doc = newMIME("application/msword", ".doc", magic.Doc).
66		alias("application/vnd.ms-word")
67	ppt = newMIME("application/vnd.ms-powerpoint", ".ppt", magic.Ppt).
68		alias("application/mspowerpoint")
69	pub = newMIME("application/vnd.ms-publisher", ".pub", magic.Pub)
70	xls = newMIME("application/vnd.ms-excel", ".xls", magic.Xls).
71		alias("application/msexcel")
72	msg  = newMIME("application/vnd.ms-outlook", ".msg", magic.Msg)
73	ps   = newMIME("application/postscript", ".ps", magic.Ps)
74	fits = newMIME("application/fits", ".fits", magic.Fits)
75	ogg  = newMIME("application/ogg", ".ogg", magic.Ogg, oggAudio, oggVideo).
76		alias("application/x-ogg")
77	oggAudio = newMIME("audio/ogg", ".oga", magic.OggAudio)
78	oggVideo = newMIME("video/ogg", ".ogv", magic.OggVideo)
79	text     = newMIME("text/plain", ".txt", magic.Text, html, svg, xml, php, js, lua, perl, python, json, ndJSON, rtf, tcl, csv, tsv, vCard, iCalendar, warc)
80	xml      = newMIME("text/xml", ".xml", magic.Xml, rss, atom, x3d, kml, xliff, collada, gml, gpx, tcx, amf, threemf, xfdf, owl2)
81	json     = newMIME("application/json", ".json", magic.JSON, geoJSON, har)
82	har      = newMIME("application/json", ".har", magic.HAR)
83	csv      = newMIME("text/csv", ".csv", magic.Csv)
84	tsv      = newMIME("text/tab-separated-values", ".tsv", magic.Tsv)
85	geoJSON  = newMIME("application/geo+json", ".geojson", magic.GeoJSON)
86	ndJSON   = newMIME("application/x-ndjson", ".ndjson", magic.NdJSON)
87	html     = newMIME("text/html", ".html", magic.Html)
88	php      = newMIME("text/x-php", ".php", magic.Php)
89	rtf      = newMIME("text/rtf", ".rtf", magic.Rtf)
90	js       = newMIME("application/javascript", ".js", magic.Js).
91			alias("application/x-javascript", "text/javascript")
92	lua    = newMIME("text/x-lua", ".lua", magic.Lua)
93	perl   = newMIME("text/x-perl", ".pl", magic.Perl)
94	python = newMIME("application/x-python", ".py", magic.Python)
95	tcl    = newMIME("text/x-tcl", ".tcl", magic.Tcl).
96		alias("application/x-tcl")
97	vCard     = newMIME("text/vcard", ".vcf", magic.VCard)
98	iCalendar = newMIME("text/calendar", ".ics", magic.ICalendar)
99	svg       = newMIME("image/svg+xml", ".svg", magic.Svg)
100	rss       = newMIME("application/rss+xml", ".rss", magic.Rss).
101			alias("text/rss")
102	owl2    = newMIME("application/owl+xml", ".owl", magic.Owl2)
103	atom    = newMIME("application/atom+xml", ".atom", magic.Atom)
104	x3d     = newMIME("model/x3d+xml", ".x3d", magic.X3d)
105	kml     = newMIME("application/vnd.google-earth.kml+xml", ".kml", magic.Kml)
106	xliff   = newMIME("application/x-xliff+xml", ".xlf", magic.Xliff)
107	collada = newMIME("model/vnd.collada+xml", ".dae", magic.Collada)
108	gml     = newMIME("application/gml+xml", ".gml", magic.Gml)
109	gpx     = newMIME("application/gpx+xml", ".gpx", magic.Gpx)
110	tcx     = newMIME("application/vnd.garmin.tcx+xml", ".tcx", magic.Tcx)
111	amf     = newMIME("application/x-amf", ".amf", magic.Amf)
112	threemf = newMIME("application/vnd.ms-package.3dmanufacturing-3dmodel+xml", ".3mf", magic.Threemf)
113	png     = newMIME("image/png", ".png", magic.Png)
114	jpg     = newMIME("image/jpeg", ".jpg", magic.Jpg)
115	jxl     = newMIME("image/jxl", ".jxl", magic.Jxl)
116	jp2     = newMIME("image/jp2", ".jp2", magic.Jp2)
117	jpx     = newMIME("image/jpx", ".jpf", magic.Jpx)
118	jpm     = newMIME("image/jpm", ".jpm", magic.Jpm).
119		alias("video/jpm")
120	xpm  = newMIME("image/x-xpixmap", ".xpm", magic.Xpm)
121	bpg  = newMIME("image/bpg", ".bpg", magic.Bpg)
122	gif  = newMIME("image/gif", ".gif", magic.Gif)
123	webp = newMIME("image/webp", ".webp", magic.Webp)
124	tiff = newMIME("image/tiff", ".tiff", magic.Tiff)
125	bmp  = newMIME("image/bmp", ".bmp", magic.Bmp).
126		alias("image/x-bmp", "image/x-ms-bmp")
127	ico  = newMIME("image/x-icon", ".ico", magic.Ico)
128	icns = newMIME("image/x-icns", ".icns", magic.Icns)
129	psd  = newMIME("image/vnd.adobe.photoshop", ".psd", magic.Psd).
130		alias("image/x-psd", "application/photoshop")
131	heic    = newMIME("image/heic", ".heic", magic.Heic)
132	heicSeq = newMIME("image/heic-sequence", ".heic", magic.HeicSequence)
133	heif    = newMIME("image/heif", ".heif", magic.Heif)
134	heifSeq = newMIME("image/heif-sequence", ".heif", magic.HeifSequence)
135	hdr     = newMIME("image/vnd.radiance", ".hdr", magic.Hdr)
136	mp3     = newMIME("audio/mpeg", ".mp3", magic.Mp3).
137		alias("audio/x-mpeg", "audio/mp3")
138	flac = newMIME("audio/flac", ".flac", magic.Flac)
139	midi = newMIME("audio/midi", ".midi", magic.Midi).
140		alias("audio/mid", "audio/sp-midi", "audio/x-mid", "audio/x-midi")
141	ape      = newMIME("audio/ape", ".ape", magic.Ape)
142	musePack = newMIME("audio/musepack", ".mpc", magic.MusePack)
143	wav      = newMIME("audio/wav", ".wav", magic.Wav).
144			alias("audio/x-wav", "audio/vnd.wave", "audio/wave")
145	aiff = newMIME("audio/aiff", ".aiff", magic.Aiff)
146	au   = newMIME("audio/basic", ".au", magic.Au)
147	amr  = newMIME("audio/amr", ".amr", magic.Amr).
148		alias("audio/amr-nb")
149	aac  = newMIME("audio/aac", ".aac", magic.Aac)
150	voc  = newMIME("audio/x-unknown", ".voc", magic.Voc)
151	aMp4 = newMIME("audio/mp4", ".mp4", magic.AMp4).
152		alias("audio/x-m4a", "audio/x-mp4a")
153	m4a = newMIME("audio/x-m4a", ".m4a", magic.M4a)
154	m3u = newMIME("application/vnd.apple.mpegurl", ".m3u", magic.M3u).
155		alias("audio/mpegurl")
156	m4v  = newMIME("video/x-m4v", ".m4v", magic.M4v)
157	mp4  = newMIME("video/mp4", ".mp4", magic.Mp4)
158	webM = newMIME("video/webm", ".webm", magic.WebM).
159		alias("audio/webm")
160	mpeg      = newMIME("video/mpeg", ".mpeg", magic.Mpeg)
161	quickTime = newMIME("video/quicktime", ".mov", magic.QuickTime)
162	mqv       = newMIME("video/quicktime", ".mqv", magic.Mqv)
163	threeGP   = newMIME("video/3gpp", ".3gp", magic.ThreeGP).
164			alias("video/3gp", "audio/3gpp")
165	threeG2 = newMIME("video/3gpp2", ".3g2", magic.ThreeG2).
166		alias("video/3g2", "audio/3gpp2")
167	avi = newMIME("video/x-msvideo", ".avi", magic.Avi).
168		alias("video/avi", "video/msvideo")
169	flv = newMIME("video/x-flv", ".flv", magic.Flv)
170	mkv = newMIME("video/x-matroska", ".mkv", magic.Mkv)
171	asf = newMIME("video/x-ms-asf", ".asf", magic.Asf).
172		alias("video/asf", "video/x-ms-wmv")
173	rmvb  = newMIME("application/vnd.rn-realmedia-vbr", ".rmvb", magic.Rmvb)
174	class = newMIME("application/x-java-applet", ".class", magic.Class)
175	swf   = newMIME("application/x-shockwave-flash", ".swf", magic.Swf)
176	crx   = newMIME("application/x-chrome-extension", ".crx", magic.Crx)
177	ttf   = newMIME("font/ttf", ".ttf", magic.Ttf).
178		alias("font/sfnt", "application/x-font-ttf", "application/font-sfnt")
179	woff    = newMIME("font/woff", ".woff", magic.Woff)
180	woff2   = newMIME("font/woff2", ".woff2", magic.Woff2)
181	otf     = newMIME("font/otf", ".otf", magic.Otf)
182	eot     = newMIME("application/vnd.ms-fontobject", ".eot", magic.Eot)
183	wasm    = newMIME("application/wasm", ".wasm", magic.Wasm)
184	shp     = newMIME("application/octet-stream", ".shp", magic.Shp)
185	shx     = newMIME("application/octet-stream", ".shx", magic.Shx, shp)
186	dbf     = newMIME("application/x-dbf", ".dbf", magic.Dbf)
187	exe     = newMIME("application/vnd.microsoft.portable-executable", ".exe", magic.Exe)
188	elf     = newMIME("application/x-elf", "", magic.Elf, elfObj, elfExe, elfLib, elfDump)
189	elfObj  = newMIME("application/x-object", "", magic.ElfObj)
190	elfExe  = newMIME("application/x-executable", "", magic.ElfExe)
191	elfLib  = newMIME("application/x-sharedlib", ".so", magic.ElfLib)
192	elfDump = newMIME("application/x-coredump", "", magic.ElfDump)
193	ar      = newMIME("application/x-archive", ".a", magic.Ar, deb).
194		alias("application/x-unix-archive")
195	deb = newMIME("application/vnd.debian.binary-package", ".deb", magic.Deb)
196	rpm = newMIME("application/x-rpm", ".rpm", magic.Rpm)
197	dcm = newMIME("application/dicom", ".dcm", magic.Dcm)
198	odt = newMIME("application/vnd.oasis.opendocument.text", ".odt", magic.Odt, ott).
199		alias("application/x-vnd.oasis.opendocument.text")
200	ott = newMIME("application/vnd.oasis.opendocument.text-template", ".ott", magic.Ott).
201		alias("application/x-vnd.oasis.opendocument.text-template")
202	ods = newMIME("application/vnd.oasis.opendocument.spreadsheet", ".ods", magic.Ods, ots).
203		alias("application/x-vnd.oasis.opendocument.spreadsheet")
204	ots = newMIME("application/vnd.oasis.opendocument.spreadsheet-template", ".ots", magic.Ots).
205		alias("application/x-vnd.oasis.opendocument.spreadsheet-template")
206	odp = newMIME("application/vnd.oasis.opendocument.presentation", ".odp", magic.Odp, otp).
207		alias("application/x-vnd.oasis.opendocument.presentation")
208	otp = newMIME("application/vnd.oasis.opendocument.presentation-template", ".otp", magic.Otp).
209		alias("application/x-vnd.oasis.opendocument.presentation-template")
210	odg = newMIME("application/vnd.oasis.opendocument.graphics", ".odg", magic.Odg, otg).
211		alias("application/x-vnd.oasis.opendocument.graphics")
212	otg = newMIME("application/vnd.oasis.opendocument.graphics-template", ".otg", magic.Otg).
213		alias("application/x-vnd.oasis.opendocument.graphics-template")
214	odf = newMIME("application/vnd.oasis.opendocument.formula", ".odf", magic.Odf).
215		alias("application/x-vnd.oasis.opendocument.formula")
216	odc = newMIME("application/vnd.oasis.opendocument.chart", ".odc", magic.Odc).
217		alias("application/x-vnd.oasis.opendocument.chart")
218	sxc = newMIME("application/vnd.sun.xml.calc", ".sxc", magic.Sxc)
219	rar = newMIME("application/x-rar-compressed", ".rar", magic.Rar).
220		alias("application/x-rar")
221	djvu    = newMIME("image/vnd.djvu", ".djvu", magic.DjVu)
222	mobi    = newMIME("application/x-mobipocket-ebook", ".mobi", magic.Mobi)
223	lit     = newMIME("application/x-ms-reader", ".lit", magic.Lit)
224	sqlite3 = newMIME("application/vnd.sqlite3", ".sqlite", magic.Sqlite).
225		alias("application/x-sqlite3")
226	dwg = newMIME("image/vnd.dwg", ".dwg", magic.Dwg).
227		alias("image/x-dwg", "application/acad", "application/x-acad",
228			"application/autocad_dwg", "application/dwg", "application/x-dwg",
229			"application/x-autocad", "drawing/dwg")
230	warc    = newMIME("application/warc", ".warc", magic.Warc)
231	nes     = newMIME("application/vnd.nintendo.snes.rom", ".nes", magic.Nes)
232	lnk     = newMIME("application/x-ms-shortcut", ".lnk", magic.Lnk)
233	macho   = newMIME("application/x-mach-binary", ".macho", magic.MachO)
234	qcp     = newMIME("audio/qcelp", ".qcp", magic.Qcp)
235	mrc     = newMIME("application/marc", ".mrc", magic.Marc)
236	mdb     = newMIME("application/x-msaccess", ".mdb", magic.MsAccessMdb)
237	accdb   = newMIME("application/x-msaccess", ".accdb", magic.MsAccessAce)
238	zstd    = newMIME("application/zstd", ".zst", magic.Zstd)
239	cab     = newMIME("application/vnd.ms-cab-compressed", ".cab", magic.Cab)
240	lzip    = newMIME("application/lzip", ".lz", magic.Lzip)
241	torrent = newMIME("application/x-bittorrent", ".torrent", magic.Torrent)
242	cpio    = newMIME("application/x-cpio", ".cpio", magic.Cpio)
243	tzif    = newMIME("application/tzif", "", magic.TzIf)
244	p7s     = newMIME("application/pkcs7-signature", ".p7s", magic.P7s)
245	xcf     = newMIME("image/x-xcf", ".xcf", magic.Xcf)
246	pat     = newMIME("image/x-gimp-pat", ".pat", magic.Pat)
247	gbr     = newMIME("image/x-gimp-gbr", ".gbr", magic.Gbr)
248	xfdf    = newMIME("application/vnd.adobe.xfdf", ".xfdf", magic.Xfdf)
249	glb     = newMIME("model/gltf-binary", ".glb", magic.Glb)
250)
251