Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stellarbear/mimemagicsharp
Detects MIME type based on file content or file extension
https://github.com/stellarbear/mimemagicsharp
csharp detection json magic mime mime-database mime-detector mime-parser mime-type net
Last synced: 2 months ago
JSON representation
Detects MIME type based on file content or file extension
- Host: GitHub
- URL: https://github.com/stellarbear/mimemagicsharp
- Owner: stellarbear
- License: mit
- Created: 2018-04-26T11:54:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T01:05:03.000Z (about 2 years ago)
- Last Synced: 2024-10-02T11:11:18.543Z (3 months ago)
- Topics: csharp, detection, json, magic, mime, mime-database, mime-detector, mime-parser, mime-type, net
- Language: C#
- Size: 651 KB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MimeMagicSharp
Detects MIME type based on file content or file extension. [Nuget package](https://www.nuget.org/packages/MimeMagicSharp/) is available. Sample files are included.
## Description
This project was originally based on parsing **/usr/share/mime/magic** (Kali Linux) file (**mime database**). Location may differ. More information about this file structure could be found [here](https://developer.gnome.org/shared-mime-info-spec/) ("the magic files" section).
This file contains mime type definitions with several rule sets, which are applied iteratively to the given file's content to guess mime type(s).
Original file's format (**old**) is hard to modify according to your needs. I decided to move on to json file format (**new**) with similary capabilities and some new features. New format could be easily modified and updated with new rule sets and mime type definitions.
Both database formats are supported. Conversion from the old to the new database format is supported. Detection by extension can be used only with new file format. Template original and json files **will be** included soon.
## Structure
Each MIME definition contains a list of rule sets. Each rule set contains an hierarchical list of rules. Rule set pseudocode:
```C#
// Level 0 rules: Rule 0
// Level 1 rules: Rule 1, Rule 2, Rule 3
// Level 2 rules: Rule 4
// Level 3 rules: Rule 5, Rule 6
// ...
```
When this ruleset is applied, result will be calculated in the following manner:
```C#
// Result (boolean) = 0 && (1 || 2 || 3) && 4 && (5 || 6)...
```
Rule example:
```C#
"Name": "application/x-deb",
"Description": "Debian package",
"Extensions": ["deb"],
"RuleSet": [
{
"Rule": [
{
"Level": 0,
"Offset": 0,
"Range": 0,
"Data": "213C617263683E",
"DataUTF8": "!"
},
{
"Level": 1,
"Offset": 8,
"Range": 0,
"Data": "64656269616E",
"DataUTF8": "debian"
}
]
}, "Rule":[...
]...
```
- **Level**. Explained earlier.
- **Offset**. Seek start position
- **Range**. Seek interval (0 means fixed position)
- **Data**. Data to seek in hex format
- **Description** and **DataUTF8** are for visual purposes only.
## Usage
```C#
// Database File (new or old)
string MagicFile = Path.Combine(Environment.CurrentDirectory, "magic");
using (MimeMagicSharp.MimeMagicSharp ms = new MimeMagicSharp.MimeMagicSharp(MimeMagicSharp.EMagicFileType.Json, MagicFile))
{
try
{
foreach (MimeTypeGuess mimeTypeGuess in ms.AssumeMimeType(EMimeTypeBy.Content,
Path.Combine(Environment.CurrentDirectory, "Newtonsoft.Json.xml")))
{
// Iterate over results
}
}
catch (Exception Ex)
{
// Handle errors
}
}
```
Convertion from original (old) format to json (new) is supported
```C#
MimeMagicSharp.MimeMagicSharp.ConvertFromOriginalToJson("magic_original", "magic_json_convert_test", out string ConvertError);
```
## Limitations
Only first 4096 bytes of file are read during mime detection procedure. You can extend this limit in source code easily.
## Other
Build in vs 2017
You can use or modify the sources however you want