5 * Routines for converting between UTF-8 and OSTA Compressed Unicode.
6 * Also handles filename mangling
9 * OSTA Compressed Unicode is explained in the OSTA UDF specification.
10 * http://www.osta.org/
11 * UTF-8 is explained in the IETF RFC XXXX.
12 * ftp://ftp.internic.net/rfc/rfcxxxx.txt
15 * This file is distributed under the terms of the GNU General Public
16 * License (GPL). Copies of the GPL can be obtained from:
17 * ftp://prep.ai.mit.edu/pub/gnu/GPL
18 * Each contributing author retains all rights to their own work.
23 #include <linux/kernel.h>
24 #include <linux/string.h> /* for memset */
25 #include <linux/nls.h>
29 static int udf_translate_to_linux(uint8_t *, uint8_t *, int, uint8_t *, int);
31 static int udf_char_to_ustr(struct ustr *dest, const uint8_t *src, int strlen)
33 if ((!dest) || (!src) || (!strlen) || (strlen > UDF_NAME_LEN - 2))
36 memset(dest, 0, sizeof(struct ustr));
37 memcpy(dest->u_name, src, strlen);
47 int udf_build_ustr(struct ustr *dest, dstring *ptr, int size)
51 if ((!dest) || (!ptr) || (!size))
54 memset(dest, 0, sizeof(struct ustr));
55 usesize = (size > UDF_NAME_LEN) ? UDF_NAME_LEN : size;
56 dest->u_cmpID = ptr[0];
57 dest->u_len = ptr[size - 1];
58 memcpy(dest->u_name, ptr + 1, usesize - 1);
64 * udf_build_ustr_exact
66 static int udf_build_ustr_exact(struct ustr *dest, dstring *ptr, int exactsize)
68 if ((!dest) || (!ptr) || (!exactsize))
71 memset(dest, 0, sizeof(struct ustr));
72 dest->u_cmpID = ptr[0];
73 dest->u_len = exactsize - 1;
74 memcpy(dest->u_name, ptr + 1, exactsize - 1);
83 * Convert OSTA Compressed Unicode to the UTF-8 equivalent.
86 * utf Pointer to UTF-8 output buffer.
87 * ocu Pointer to OSTA Compressed Unicode input buffer
88 * of size UDF_NAME_LEN bytes.
89 * both of type "struct ustr *"
92 * <return> Zero on success.
95 * November 12, 1997 - Andrew E. Mileski
96 * Written, tested, and released.
98 int udf_CS0toUTF8(struct ustr *utf_o, const struct ustr *ocu_i)
101 uint8_t cmp_id, ocu_len;
104 ocu_len = ocu_i->u_len;
106 memset(utf_o, 0, sizeof(struct ustr));
110 cmp_id = ocu_i->u_cmpID;
111 if (cmp_id != 8 && cmp_id != 16) {
112 memset(utf_o, 0, sizeof(struct ustr));
113 printk(KERN_ERR "udf: unknown compression code (%d) stri=%s\n",
114 cmp_id, ocu_i->u_name);
120 for (i = 0; (i < ocu_len) && (utf_o->u_len <= (UDF_NAME_LEN - 3));) {
122 /* Expand OSTA compressed Unicode to Unicode */
123 uint32_t c = ocu[i++];
125 c = (c << 8) | ocu[i++];
127 /* Compress Unicode to UTF-8 */
129 utf_o->u_name[utf_o->u_len++] = (uint8_t)c;
130 else if (c < 0x800U) {
131 utf_o->u_name[utf_o->u_len++] =
132 (uint8_t)(0xc0 | (c >> 6));
133 utf_o->u_name[utf_o->u_len++] =
134 (uint8_t)(0x80 | (c & 0x3f));
136 utf_o->u_name[utf_o->u_len++] =
137 (uint8_t)(0xe0 | (c >> 12));
138 utf_o->u_name[utf_o->u_len++] =
141 utf_o->u_name[utf_o->u_len++] =
142 (uint8_t)(0x80 | (c & 0x3f));
155 * Convert UTF-8 to the OSTA Compressed Unicode equivalent.
158 * This routine is only called by udf_lookup().
161 * ocu Pointer to OSTA Compressed Unicode output
162 * buffer of size UDF_NAME_LEN bytes.
163 * utf Pointer to UTF-8 input buffer.
164 * utf_len Length of UTF-8 input buffer in bytes.
167 * <return> Zero on success.
170 * November 12, 1997 - Andrew E. Mileski
171 * Written, tested, and released.
173 static int udf_UTF8toCS0(dstring *ocu, struct ustr *utf, int length)
175 unsigned c, i, max_val, utf_char;
178 memset(ocu, 0, sizeof(dstring) * length);
186 for (i = 0U; i < utf->u_len; i++) {
187 c = (uint8_t)utf->u_name[i];
189 /* Complete a multi-byte UTF-8 character */
191 utf_char = (utf_char << 6) | (c & 0x3fU);
195 /* Check for a multi-byte UTF-8 character */
197 /* Start a multi-byte UTF-8 character */
198 if ((c & 0xe0U) == 0xc0U) {
199 utf_char = c & 0x1fU;
201 } else if ((c & 0xf0U) == 0xe0U) {
202 utf_char = c & 0x0fU;
204 } else if ((c & 0xf8U) == 0xf0U) {
205 utf_char = c & 0x07U;
207 } else if ((c & 0xfcU) == 0xf8U) {
208 utf_char = c & 0x03U;
210 } else if ((c & 0xfeU) == 0xfcU) {
211 utf_char = c & 0x01U;
218 /* Single byte UTF-8 character (most common) */
223 /* Choose no compression if necessary */
224 if (utf_char > max_val) {
225 if (max_val == 0xffU) {
227 ocu[0] = (uint8_t)0x10U;
233 if (max_val == 0xffffU)
234 ocu[++u_len] = (uint8_t)(utf_char >> 8);
235 ocu[++u_len] = (uint8_t)(utf_char & 0xffU);
241 printk(KERN_DEBUG "udf: bad UTF-8 character\n");
244 ocu[length - 1] = (uint8_t)u_len + 1;
249 static int udf_CS0toNLS(struct nls_table *nls, struct ustr *utf_o,
254 uint8_t cmp_id, ocu_len;
259 ocu_len = ocu_i->u_len;
260 cmp_id = ocu_i->u_cmpID;
264 memset(utf_o, 0, sizeof(struct ustr));
270 if ((cmp_id != 8) && (cmp_id != 16)) {
271 printk(KERN_ERR "udf: unknown compression code (%d) stri=%s\n",
272 cmp_id, ocu_i->u_name);
276 for (i = 0; (i < ocu_len) && (utf_o->u_len <= (UDF_NAME_LEN - 3));) {
277 /* Expand OSTA compressed Unicode to Unicode */
280 c = (c << 8) | ocu[i++];
282 utf_o->u_len += nls->uni2char(c, &utf_o->u_name[utf_o->u_len],
283 UDF_NAME_LEN - utf_o->u_len);
290 static int udf_NLStoCS0(struct nls_table *nls, dstring *ocu, struct ustr *uni,
293 unsigned len, i, max_val;
297 memset(ocu, 0, sizeof(dstring) * length);
303 for (i = 0U; i < uni->u_len; i++) {
304 len = nls->char2uni(&uni->u_name[i], uni->u_len - i, &uni_char);
308 if (uni_char > max_val) {
310 ocu[0] = (uint8_t)0x10U;
314 if (max_val == 0xffffU)
315 ocu[++u_len] = (uint8_t)(uni_char >> 8);
316 ocu[++u_len] = (uint8_t)(uni_char & 0xffU);
320 ocu[length - 1] = (uint8_t)u_len + 1;
324 int udf_get_filename(struct super_block *sb, uint8_t *sname, uint8_t *dname,
327 struct ustr filename, unifilename;
330 if (udf_build_ustr_exact(&unifilename, sname, flen))
333 if (UDF_QUERY_FLAG(sb, UDF_FLAG_UTF8)) {
334 if (!udf_CS0toUTF8(&filename, &unifilename)) {
335 udf_debug("Failed in udf_get_filename: sname = %s\n",
339 } else if (UDF_QUERY_FLAG(sb, UDF_FLAG_NLS_MAP)) {
340 if (!udf_CS0toNLS(UDF_SB(sb)->s_nls_map, &filename,
342 udf_debug("Failed in udf_get_filename: sname = %s\n",
349 len = udf_translate_to_linux(dname, filename.u_name, filename.u_len,
350 unifilename.u_name, unifilename.u_len);
357 int udf_put_filename(struct super_block *sb, const uint8_t *sname,
358 uint8_t *dname, int flen)
360 struct ustr unifilename;
363 if (!udf_char_to_ustr(&unifilename, sname, flen))
366 if (UDF_QUERY_FLAG(sb, UDF_FLAG_UTF8)) {
367 namelen = udf_UTF8toCS0(dname, &unifilename, UDF_NAME_LEN);
370 } else if (UDF_QUERY_FLAG(sb, UDF_FLAG_NLS_MAP)) {
371 namelen = udf_NLStoCS0(UDF_SB(sb)->s_nls_map, dname,
372 &unifilename, UDF_NAME_LEN);
381 #define ILLEGAL_CHAR_MARK '_'
386 static int udf_translate_to_linux(uint8_t *newName, uint8_t *udfName,
387 int udfLen, uint8_t *fidName,
390 int index, newIndex = 0, needsCRC = 0;
391 int extIndex = 0, newExtIndex = 0, hasExt = 0;
392 unsigned short valueCRC;
394 const uint8_t hexChar[] = "0123456789ABCDEF";
396 if (udfName[0] == '.' &&
397 (udfLen == 1 || (udfLen == 2 && udfName[1] == '.'))) {
400 memcpy(newName, udfName, udfLen);
402 for (index = 0; index < udfLen; index++) {
403 curr = udfName[index];
404 if (curr == '/' || curr == 0) {
406 curr = ILLEGAL_CHAR_MARK;
407 while (index + 1 < udfLen &&
408 (udfName[index + 1] == '/' ||
409 udfName[index + 1] == 0))
412 if (curr == EXT_MARK &&
413 (udfLen - index - 1) <= EXT_SIZE) {
414 if (udfLen == index + 1)
419 newExtIndex = newIndex;
423 newName[newIndex++] = curr;
429 uint8_t ext[EXT_SIZE];
430 int localExtIndex = 0;
435 index < EXT_SIZE && extIndex + index + 1 < udfLen;
437 curr = udfName[extIndex + index + 1];
439 if (curr == '/' || curr == 0) {
441 curr = ILLEGAL_CHAR_MARK;
442 while (extIndex + index + 2 < udfLen &&
443 (index + 1 < EXT_SIZE &&
444 (udfName[extIndex + index + 2] == '/' ||
445 udfName[extIndex + index + 2] == 0)))
448 ext[localExtIndex++] = curr;
450 maxFilenameLen = 250 - localExtIndex;
451 if (newIndex > maxFilenameLen)
452 newIndex = maxFilenameLen;
454 newIndex = newExtIndex;
455 } else if (newIndex > 250)
457 newName[newIndex++] = CRC_MARK;
458 valueCRC = udf_crc(fidName, fidNameLen, 0);
459 newName[newIndex++] = hexChar[(valueCRC & 0xf000) >> 12];
460 newName[newIndex++] = hexChar[(valueCRC & 0x0f00) >> 8];
461 newName[newIndex++] = hexChar[(valueCRC & 0x00f0) >> 4];
462 newName[newIndex++] = hexChar[(valueCRC & 0x000f)];
465 newName[newIndex++] = EXT_MARK;
466 for (index = 0; index < localExtIndex; index++)
467 newName[newIndex++] = ext[index];