package mimetype
import "github.com/gabriel-vasile/mimetype"
Package mimetype uses magic number signatures to detect the MIME type of a file.
mimetype stores the list of MIME types in a tree structure with
"application/octet-stream" at the root of the hierarchy. The hierarchy
approach minimizes the number of checks that need to be done on the input
and allows for more precise results once the base type of file has been
identified.
To check if some bytes/reader/file has a specific MIME type, first perform
a detect on the input and then test against the MIME.
Is method can also be called with MIME aliases.
Code:play
Output: To find the MIME type of some input, perform a detect.
In addition to the basic Detect,
there are shortcuts for detecting from a reader:
or from a file:
Code:play
Output: To check if some bytes/reader/file has a base MIME type, first perform
a detect on the input and then navigate the parents until the base MIME type
is found.
Considering JAR files are just ZIPs containing some metadata files,
if, for example, you need to tell if the input can be unzipped, go up the
hierarchy until zip is found or the root is reached.
Code:play
Output: Considering the definition of a binary file as "a computer file that is not
a text file", they can differentiated by searching for the text/plain MIME
in it's MIME hierarchy.
Code:play
Output:Example (Check)¶
package main
import (
"fmt"
"github.com/gabriel-vasile/mimetype"
)
func main() {
mime, err := mimetype.DetectFile("testdata/zip.zip")
// application/x-zip is an alias of application/zip,
// therefore Is returns true both times.
fmt.Println(mime.Is("application/zip"), mime.Is("application/x-zip"), err)
}
true true <nil>
Example (Detect)¶
mimetype.Detect([]byte) *MIME
mimetype.DetectReader(io.Reader) (*MIME, error)
mimetype.DetectFile(string) (*MIME, error)
package main
import (
"fmt"
"io/ioutil"
"os"
"github.com/gabriel-vasile/mimetype"
)
func main() {
file := "testdata/pdf.pdf"
reader, _ := os.Open(file) // ignoring error for brevity's sake
data, _ := ioutil.ReadFile(file) // ignoring error for brevity's sake
dmime := mimetype.Detect(data)
rmime, rerr := mimetype.DetectReader(reader)
fmime, ferr := mimetype.DetectFile(file)
fmt.Println(dmime, rmime, fmime)
fmt.Println(rerr, ferr)
}
application/pdf application/pdf application/pdf
<nil> <nil>
Example (Parent)¶
package main
import (
"fmt"
"github.com/gabriel-vasile/mimetype"
)
func main() {
detectedMIME, err := mimetype.DetectFile("testdata/jar.jar")
zip := false
for mime := detectedMIME; mime != nil; mime = mime.Parent() {
if mime.Is("application/zip") {
zip = true
}
}
// zip is true, even if the detected MIME was application/jar.
fmt.Println(zip, detectedMIME, err)
}
true application/jar <nil>
Example (TextVsBinary)¶
package main
import (
"fmt"
"github.com/gabriel-vasile/mimetype"
)
func main() {
detectedMIME, err := mimetype.DetectFile("testdata/xml.xml")
isBinary := true
for mime := detectedMIME; mime != nil; mime = mime.Parent() {
if mime.Is("text/plain") {
isBinary = false
}
}
fmt.Println(isBinary, detectedMIME, err)
}
false text/xml; charset=utf-8 <nil>
Index ¶
Examples ¶
- package (Check)
- package (Detect)
- package (Parent)
- package (TextVsBinary)
- Detect
- DetectFile
- DetectReader
- MIME.Is
Types ¶
type MIME ¶
type MIME struct {
// contains filtered or unexported fields
}
MIME represents a file format in the tree structure of formats.
func Detect ¶
Detect returns the MIME type found from the provided byte slice.
Failure to identify the format results in application/octet-stream being returned.
func DetectFile ¶
DetectFile returns the MIME type of the provided file.
The result is always a valid MIME type, with application/octet-stream returned when identification failed with or without an error. Any error returned is related to the opening and reading from the input file.
func DetectReader ¶
DetectReader returns the MIME type of the provided reader.
The result is always a valid MIME type, with application/octet-stream returned when identification failed with or without an error. Any error returned is related to the reading from the input reader.
DetectReader assumes the reader offset is at the start. If the input is a ReadSeeker you read from before, it should be rewinded before detection:
reader.Seek(0, io.SeekStart)
Example¶
Code:play
package main import ( "fmt" "os" "github.com/gabriel-vasile/mimetype" ) func main() { data, oerr := os.Open("testdata/zip.zip") mime, merr := mimetype.DetectReader(data) fmt.Println(mime, oerr, merr) }
Output:
application/zip <nil> <nil>
func (*MIME) Extension ¶
Extension returns the file extension associated with the MIME type. It includes the leading dot, as in ".html". When the file format does not have an extension, the empty string is returned.
func (*MIME) Is ¶
Is checks whether this MIME type, or any of its aliases, is equal to the
expected MIME type. MIME type equality test is done on the "type/subtype"
sections, ignores any optional MIME parameters, ignores any leading and
trailing whitespace, and is case insensitive.
Code:play
Output:Example¶
package main
import (
"fmt"
"github.com/gabriel-vasile/mimetype"
)
func main() {
mime, err := mimetype.DetectFile("testdata/pdf.pdf")
pdf := mime.Is("application/pdf")
xpdf := mime.Is("application/x-pdf")
txt := mime.Is("text/plain")
fmt.Println(pdf, xpdf, txt, err)
}
true true false <nil>
func (*MIME) Parent ¶
Parent returns the parent MIME type from the tree structure. Each MIME type has a non-nil parent, except for the root MIME type.
func (*MIME) String ¶
String returns the string representation of the MIME type, e.g., "application/zip".
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
internal |
- Version
- v1.0.1
- Published
- Dec 23, 2019
- Platform
- darwin/amd64
- Imports
- 4 packages
- Last checked
- 2 hours ago –
Tools for package owners.