writemdict

https://github.com/zhansliu/writemdict
Admin
writemdict is a Python library that generates dictionaries in the .mdx file format used by the MDict...
Tokens:4,362
Snippets:28
Trust Score:5.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### MDX Dictionary XML Header

Source: https://github.com/zhansliu/writemdict/blob/master/fileformat.md

Example of the XML structure for an MDX dictionary file.

```xml
<Dictionary 
GeneratedByEngineVersion="2.0" 
RequiredEngineVersion="2.0" 
Encrypted="2" 
Encoding="UTF8"
Format="Html"
CreationDate="2015-01-01"
Compact="No"
Compat="No"
KeyCaseSensitive="No"
Description="This is a <i>test dictionary</i>."
Title="My dictionary"
DataSourceFormat="106"
StyleSheet=""
RegisterBy="Email"
RegCode="0102030405060708090A0B0C0D0E0F"/>
```

--------------------------------

### Generate an MDict dictionary with MDictWriter

Source: https://github.com/zhansliu/writemdict/blob/master/README.md

A basic example showing how to initialize an MDictWriter with a dictionary object and write it to an .mdx file.

```python
from __future__ import unicode_literals
from writemdict import MDictWriter

dictionary = {"doe": "<b>doe</b> <i>n.</i> a deer, a female deer.",
              "ray": "<b>ray</b> <i>n.</i> a drop of golden sun.",
              "me": "<b>me</b> <i>pron.</i> a name I call myself.",
              "far": "<b>far</b> <i>adv.</i> a long, long way to run."}

writer = MDictWriter(dictionary, title="Example Dictionary", description="This is an example dictionary.")
outfile = open("dictionary.mdx", "wb")
writer.write(outfile)
outfile.close()
```

--------------------------------

### MDD Library Data XML Header

Source: https://github.com/zhansliu/writemdict/blob/master/fileformat.md

Example of the XML structure for an MDD library data file.

```xml
<Library_Data 
GeneratedByEngineVersion="2.0" 
RequiredEngineVersion="2.0" 
Encrypted="2" 
Format=""
CreationDate="2015-01-01"
Compact="No"
Compat="No"
KeyCaseSensitive="No"
Description="This is a <i>test dictionary</i>."
Title="My dictionary"
DataSourceFormat="106"
StyleSheet=""
RegisterBy="Email"
RegCode="0102030405060708090A0B0C0D0E0F"/>
```

--------------------------------

### Salsa20/8 Encryption Pseudo-Python

Source: https://github.com/zhansliu/writemdict/blob/master/fileformat.md

This pseudo-code demonstrates the encryption process for the 40-byte header block using Salsa20/8 with a 128-bit key and a 64-bit zero IV.

```python
def encrypt(message, key):
    salsa20_8_init(key_length = 128, #128 bits
       iv_length = 64, # 64 bits
       ivs = b"\0\0\0\0\0\0\0\0"), #64 bits of zeros)
    return salsa20_8_encrypt(message, key)

encrypted_block = encrypt(unencrypted_block, key=ripemd128(encryption_key))
```

--------------------------------

### Registration Code Derivation

Source: https://github.com/zhansliu/writemdict/blob/master/fileformat.md

This pseudo-code shows how the registration code is generated by encrypting the RIPEMD-128 hash of the dictionary password with the RIPEMD-128 hash of the user ID.

```python
reg_code = encrypt(ripemd128(encryption_key), ripemd128(user_id))
```

--------------------------------

### Keyword index encryption function

Source: https://github.com/zhansliu/writemdict/blob/master/fileformat.md

The C function used to encrypt compressed keyword data. It utilizes a nibble swap macro and XOR operations based on the index, key, and previous byte value.

```c
#define SWAPNIBBLE(byte) (((byte)>>4) | ((byte)<<4))
void encrypt(unsigned char* buf, size_t buflen, unsigned char* key, size_t keylen) {
	unsigned char prev=0x36;
	for(size_t i=0; i < buflen; i++) {
		buf[i] = SWAPNIBBLE(buf[i] ^ ((unsigned char)i) ^ key[i%keylen] ^ previous);
		previous = buf[i];
	}
}
```
Tokens:
Raw