Mdict4j

https://mdict4j.readthedocs.io/en/latest/
Admin
Mdict4j is a parser library for MDict dictionary format, providing functionality to read and search...
Tokens:6,991
Snippets:124
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Perform Predictive Search on MDX Dictionary

Source: https://mdict4j.readthedocs.io/en/latest/howtouse.html

Use predictive search to find entries that start with a given prefix. This is useful for auto-completion features.

```java
for (Map.Entry<String, String> entry: dictionary.readArticlesPredictive("happ")) {
    System.out.println("<div><span>%s</span>: %s</div>", entry.getKey(), entry.getValue());
}

```

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

### MDD Library Data Header XML

Source: https://mdict4j.readthedocs.io/en/latest/reference/fileformat.html

Example of the XML structure for the header section of an MDD library file. Note the Format attribute is empty.

```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"/>


```

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

### MDX Dictionary Header XML

Source: https://mdict4j.readthedocs.io/en/latest/reference/fileformat.html

Example of the XML structure for the header section of an MDX dictionary file. Note the Encoding attribute is set to UTF8.

```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"/>


```

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

### MDX Dictionary Header XML

Source: https://mdict4j.readthedocs.io/en/latest/_sources/reference/fileformat.md.txt

Example of the XML structure for the header string in an MDX file. This format includes attributes specific to dictionary content.

```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"/>
```

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

### Load MDD Data File and Extract Data

Source: https://mdict4j.readthedocs.io/en/latest/howtouse.html

Load an MDD data file and retrieve specific data entries, such as audio files. The retrieved data can be processed further, for example, to detect its media type.

```java
Path dataPath = Paths.get("foo.mdx");
MDictDictionary dictData = MDictDictionary.loadDictionaryData(dataPath);
if (!dictData.isMDX()) {
    System.out.println("loaded file is .mdd");
}
Map.Entry<String, Object> entry = dictData.getEntries("/audio/test.mp3").get(0);
Object value = entry.getValue();
byte[] buf = dictData.getData((Long) value);  // buf contains mp3 data.
Tika tika = new Tika();
String mediaType = tika.detect(buf);
System.out.println("Media type should be audio/mpeg: %s", mediaType);

```

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

### MDD Library Data Header XML

Source: https://mdict4j.readthedocs.io/en/latest/_sources/reference/fileformat.md.txt

Example of the XML structure for the header string in an MDD file. This format is used for library data and has specific attribute requirements.

```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"/>
```

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

### Load and Inspect an MDX Dictionary File

Source: https://mdict4j.readthedocs.io/en/latest/howtouse.html

Load an MDX dictionary file and check its properties such as format, encoding, and encryption status. This is the first step before querying.

```java
Path dictionaryPath = Paths.get("foo.mdx");
MDictDictionary dictionary = MDictDictionary.loadDictionary(dictionaryPath);

if (dictionary.isMDX()) {
    System.out.println("loaded file is .mdx");
}
if (StandardCharsets.UTF_8.equals(dictionary.getEncoding())) {
    System.out.println("MDX file encoding is UTF-8");
}
if (dictionary.isHeaderEncrypted()) {
    System.out.println("MDX file is encrypted.");
}
if (dictionary.isIndexEncrypted()) {
    System.out.println("MDX file is encrypted.");
}
System.out.printf("MDX version: %d, format: %s", dictionary.getMdxVersion(), dictionary.getFormat());
System.out.println(dictionary.getCreationDate());
System.out.println(dictionary.getTitle());
System.out.println(dictionary.getDescription());

```

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

### Generate mdict4j Javadoc

Source: https://mdict4j.readthedocs.io/en/latest/howtouse.html

Run this Gradle command to generate the Javadoc for the mdict4j library. This is useful for detailed API reference.

```bash
./gradlew javadoc

```

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

### Load and Inspect an MDX Dictionary

Source: https://mdict4j.readthedocs.io/en/latest/_sources/howtouse.rst.txt

Load an MDX dictionary file and check its properties like encryption, encoding, version, and metadata.

```java
Path dictionaryPath = Paths.get("foo.mdx");
MDictDictionary dictionary = MDictDictionary.loadDictionary(dictionaryPath);
```

```java
if (dictionary.isMDX()) {
    System.out.println("loaded file is .mdx");
}
if (StandardCharsets.UTF_8.equals(dictionary.getEncoding())) {
    System.out.println("MDX file encoding is UTF-8");
}
if (dictionary.isHeaderEncrypted()) {
    System.out.println("MDX file is encrypted.");
}
if (dictionary.isIndexEncrypted()) {
    System.out.println("MDX index part is encrypted.");
}
System.out.printf("MDX version: %d, format: %s", dictionary.getMdxVersion(), dictionary.getFormat());
System.out.println(dictionary.getCreationDate());
System.out.println(dictionary.getTitle());
System.out.println(dictionary.getDescription());
```

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

### Salsa20/8 Encryption Pseudo-Python

Source: https://mdict4j.readthedocs.io/en/latest/_sources/reference/fileformat.md.txt

Illustrates the Salsa20/8 encryption process used for keyword headers. Requires a key and specific initialization parameters.

```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)
```

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

### Generate Javadoc

Source: https://mdict4j.readthedocs.io/en/latest/_sources/howtouse.rst.txt

Command to generate Javadoc documentation for the mdict4j library.

```bash
./gradlew javadoc
```

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

### Load and Process MDD Data File

Source: https://mdict4j.readthedocs.io/en/latest/_sources/howtouse.rst.txt

Load an MDD data file and retrieve associated data, such as MP3 files, then detect their media type.

```java
Path dataPath = Paths.get("foo.mdx");
MDictDictionary dictData = MDictDictionary.loadDictionaryData(dataPath);
if (!dictData.isMDX()) {
    System.out.println("loaded file is .mdd");
}
```

```java
Map.Entry<String, Object> entry = dictData.getEntries("/audio/test.mp3").get(0);
Object value = entry.getValue();
byte[] buf = dictData.getData((Long) value);  // buf contains mp3 data.
Tika tika = new Tika();
String mediaType = tika.detect(buf);
System.out.println("Media type should be audio/mpeg: %s", mediaType);
```

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

### Perform Exact Match Search in MDX Dictionary

Source: https://mdict4j.readthedocs.io/en/latest/_sources/howtouse.rst.txt

Search for entries in the dictionary that exactly match the provided term. Results are returned as a map of entries.

```java
for (Map.Entry<String, String> entry: dictionary.readArticles("hello")) {
    System.out.println("<div><span>%s</span>: %s</div>", entry.getKey(), entry.getValue());
}
```

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

### Add mdict4j Dependency to Gradle

Source: https://mdict4j.readthedocs.io/en/latest/howtouse.html

Include this dependency in your build.gradle file to use mdict4j. Ensure you use the correct groupId for the version you need.

```gradle
dependencies {
    implementation 'tokyo.northside:mdict4j:0.4.0'
}

```

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

### Perform Exact Match Search on MDX Dictionary

Source: https://mdict4j.readthedocs.io/en/latest/howtouse.html

Query the loaded MDX dictionary for exact matches of a given term. This method returns entries that precisely match the search query.

```java
for (Map.Entry<String, String> entry: dictionary.readArticles("hello")) {
    System.out.println("<div><span>%s</span>: %s</div>", entry.getKey(), entry.getValue());
}

```

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

### Salsa20/8 Encryption for Keyword Header

Source: https://mdict4j.readthedocs.io/en/latest/reference/fileformat.html

Implements Salsa20/8 encryption for the 40-byte block in the header when the 'Encrypted' parameter has the lowest bit set. Requires a key derived from the dictionary password.

```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))
```

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

### Perform Predictive Search in MDX Dictionary

Source: https://mdict4j.readthedocs.io/en/latest/_sources/howtouse.rst.txt

Perform a predictive search for entries in the dictionary. This is useful for auto-completion features.

```java
for (Map.Entry<String, String> entry: dictionary.readArticlesPredictive("happ")) {
    System.out.println("<div><span>%s</span>: %s</div>", entry.getKey(), entry.getValue());
}
```

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

### Add mdict4j Dependency to Gradle

Source: https://mdict4j.readthedocs.io/en/latest/_sources/howtouse.rst.txt

Include this dependency in your Gradle build file to use mdict4j. Note the groupId change in version 0.4.0.

```gradle
dependencies {
    implementation 'tokyo.northside:mdict4j:0.4.0'
}
```

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

### Keyword Index Encryption Function

Source: https://mdict4j.readthedocs.io/en/latest/reference/fileformat.html

A C function for encrypting the compressed keyword index data. It uses a byte-wise XOR operation with a key and previous byte, followed by a nibble swap.

```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];
	}
}
```

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

### Encryption of Encryption Key

Source: https://mdict4j.readthedocs.io/en/latest/reference/fileformat.html

Encrypts the derived encryption key using a user-specific ID (email or device ID) and Salsa20/8. The resulting 'reg_code' is distributed to the user.

```python
reg_code = encrypt(ripemd128(encryption_key), ripemd128(user_id))
```
Tokens:
Raw