/kern_oII/fs/udf/unicode.c

http://omnia2droid.googlecode.com/ · C · 492 lines · 355 code · 60 blank · 77 comment · 120 complexity · 82bda5533def843273eeff689ee66cd4 MD5 · raw file

  1. /*
  2. * unicode.c
  3. *
  4. * PURPOSE
  5. * Routines for converting between UTF-8 and OSTA Compressed Unicode.
  6. * Also handles filename mangling
  7. *
  8. * DESCRIPTION
  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
  13. *
  14. * COPYRIGHT
  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.
  19. */
  20. #include "udfdecl.h"
  21. #include <linux/kernel.h>
  22. #include <linux/string.h> /* for memset */
  23. #include <linux/nls.h>
  24. #include <linux/crc-itu-t.h>
  25. #include "udf_sb.h"
  26. static int udf_translate_to_linux(uint8_t *, uint8_t *, int, uint8_t *, int);
  27. static int udf_char_to_ustr(struct ustr *dest, const uint8_t *src, int strlen)
  28. {
  29. if ((!dest) || (!src) || (!strlen) || (strlen > UDF_NAME_LEN - 2))
  30. return 0;
  31. memset(dest, 0, sizeof(struct ustr));
  32. memcpy(dest->u_name, src, strlen);
  33. dest->u_cmpID = 0x08;
  34. dest->u_len = strlen;
  35. return strlen;
  36. }
  37. /*
  38. * udf_build_ustr
  39. */
  40. int udf_build_ustr(struct ustr *dest, dstring *ptr, int size)
  41. {
  42. int usesize;
  43. if (!dest || !ptr || !size)
  44. return -1;
  45. BUG_ON(size < 2);
  46. usesize = min_t(size_t, ptr[size - 1], sizeof(dest->u_name));
  47. usesize = min(usesize, size - 2);
  48. dest->u_cmpID = ptr[0];
  49. dest->u_len = usesize;
  50. memcpy(dest->u_name, ptr + 1, usesize);
  51. memset(dest->u_name + usesize, 0, sizeof(dest->u_name) - usesize);
  52. return 0;
  53. }
  54. /*
  55. * udf_build_ustr_exact
  56. */
  57. static int udf_build_ustr_exact(struct ustr *dest, dstring *ptr, int exactsize)
  58. {
  59. if ((!dest) || (!ptr) || (!exactsize))
  60. return -1;
  61. memset(dest, 0, sizeof(struct ustr));
  62. dest->u_cmpID = ptr[0];
  63. dest->u_len = exactsize - 1;
  64. memcpy(dest->u_name, ptr + 1, exactsize - 1);
  65. return 0;
  66. }
  67. /*
  68. * udf_ocu_to_utf8
  69. *
  70. * PURPOSE
  71. * Convert OSTA Compressed Unicode to the UTF-8 equivalent.
  72. *
  73. * PRE-CONDITIONS
  74. * utf Pointer to UTF-8 output buffer.
  75. * ocu Pointer to OSTA Compressed Unicode input buffer
  76. * of size UDF_NAME_LEN bytes.
  77. * both of type "struct ustr *"
  78. *
  79. * POST-CONDITIONS
  80. * <return> Zero on success.
  81. *
  82. * HISTORY
  83. * November 12, 1997 - Andrew E. Mileski
  84. * Written, tested, and released.
  85. */
  86. int udf_CS0toUTF8(struct ustr *utf_o, const struct ustr *ocu_i)
  87. {
  88. const uint8_t *ocu;
  89. uint8_t cmp_id, ocu_len;
  90. int i;
  91. ocu_len = ocu_i->u_len;
  92. if (ocu_len == 0) {
  93. memset(utf_o, 0, sizeof(struct ustr));
  94. return 0;
  95. }
  96. cmp_id = ocu_i->u_cmpID;
  97. if (cmp_id != 8 && cmp_id != 16) {
  98. memset(utf_o, 0, sizeof(struct ustr));
  99. printk(KERN_ERR "udf: unknown compression code (%d) stri=%s\n",
  100. cmp_id, ocu_i->u_name);
  101. return 0;
  102. }
  103. ocu = ocu_i->u_name;
  104. utf_o->u_len = 0;
  105. for (i = 0; (i < ocu_len) && (utf_o->u_len <= (UDF_NAME_LEN - 3));) {
  106. /* Expand OSTA compressed Unicode to Unicode */
  107. uint32_t c = ocu[i++];
  108. if (cmp_id == 16)
  109. c = (c << 8) | ocu[i++];
  110. /* Compress Unicode to UTF-8 */
  111. if (c < 0x80U)
  112. utf_o->u_name[utf_o->u_len++] = (uint8_t)c;
  113. else if (c < 0x800U) {
  114. utf_o->u_name[utf_o->u_len++] =
  115. (uint8_t)(0xc0 | (c >> 6));
  116. utf_o->u_name[utf_o->u_len++] =
  117. (uint8_t)(0x80 | (c & 0x3f));
  118. } else {
  119. utf_o->u_name[utf_o->u_len++] =
  120. (uint8_t)(0xe0 | (c >> 12));
  121. utf_o->u_name[utf_o->u_len++] =
  122. (uint8_t)(0x80 |
  123. ((c >> 6) & 0x3f));
  124. utf_o->u_name[utf_o->u_len++] =
  125. (uint8_t)(0x80 | (c & 0x3f));
  126. }
  127. }
  128. utf_o->u_cmpID = 8;
  129. return utf_o->u_len;
  130. }
  131. /*
  132. *
  133. * udf_utf8_to_ocu
  134. *
  135. * PURPOSE
  136. * Convert UTF-8 to the OSTA Compressed Unicode equivalent.
  137. *
  138. * DESCRIPTION
  139. * This routine is only called by udf_lookup().
  140. *
  141. * PRE-CONDITIONS
  142. * ocu Pointer to OSTA Compressed Unicode output
  143. * buffer of size UDF_NAME_LEN bytes.
  144. * utf Pointer to UTF-8 input buffer.
  145. * utf_len Length of UTF-8 input buffer in bytes.
  146. *
  147. * POST-CONDITIONS
  148. * <return> Zero on success.
  149. *
  150. * HISTORY
  151. * November 12, 1997 - Andrew E. Mileski
  152. * Written, tested, and released.
  153. */
  154. static int udf_UTF8toCS0(dstring *ocu, struct ustr *utf, int length)
  155. {
  156. unsigned c, i, max_val, utf_char;
  157. int utf_cnt, u_len;
  158. memset(ocu, 0, sizeof(dstring) * length);
  159. ocu[0] = 8;
  160. max_val = 0xffU;
  161. try_again:
  162. u_len = 0U;
  163. utf_char = 0U;
  164. utf_cnt = 0U;
  165. for (i = 0U; i < utf->u_len; i++) {
  166. c = (uint8_t)utf->u_name[i];
  167. /* Complete a multi-byte UTF-8 character */
  168. if (utf_cnt) {
  169. utf_char = (utf_char << 6) | (c & 0x3fU);
  170. if (--utf_cnt)
  171. continue;
  172. } else {
  173. /* Check for a multi-byte UTF-8 character */
  174. if (c & 0x80U) {
  175. /* Start a multi-byte UTF-8 character */
  176. if ((c & 0xe0U) == 0xc0U) {
  177. utf_char = c & 0x1fU;
  178. utf_cnt = 1;
  179. } else if ((c & 0xf0U) == 0xe0U) {
  180. utf_char = c & 0x0fU;
  181. utf_cnt = 2;
  182. } else if ((c & 0xf8U) == 0xf0U) {
  183. utf_char = c & 0x07U;
  184. utf_cnt = 3;
  185. } else if ((c & 0xfcU) == 0xf8U) {
  186. utf_char = c & 0x03U;
  187. utf_cnt = 4;
  188. } else if ((c & 0xfeU) == 0xfcU) {
  189. utf_char = c & 0x01U;
  190. utf_cnt = 5;
  191. } else {
  192. goto error_out;
  193. }
  194. continue;
  195. } else {
  196. /* Single byte UTF-8 character (most common) */
  197. utf_char = c;
  198. }
  199. }
  200. /* Choose no compression if necessary */
  201. if (utf_char > max_val) {
  202. if (max_val == 0xffU) {
  203. max_val = 0xffffU;
  204. ocu[0] = (uint8_t)0x10U;
  205. goto try_again;
  206. }
  207. goto error_out;
  208. }
  209. if (max_val == 0xffffU)
  210. ocu[++u_len] = (uint8_t)(utf_char >> 8);
  211. ocu[++u_len] = (uint8_t)(utf_char & 0xffU);
  212. }
  213. if (utf_cnt) {
  214. error_out:
  215. ocu[++u_len] = '?';
  216. printk(KERN_DEBUG "udf: bad UTF-8 character\n");
  217. }
  218. ocu[length - 1] = (uint8_t)u_len + 1;
  219. return u_len + 1;
  220. }
  221. static int udf_CS0toNLS(struct nls_table *nls, struct ustr *utf_o,
  222. const struct ustr *ocu_i)
  223. {
  224. const uint8_t *ocu;
  225. uint8_t cmp_id, ocu_len;
  226. int i, len;
  227. ocu_len = ocu_i->u_len;
  228. if (ocu_len == 0) {
  229. memset(utf_o, 0, sizeof(struct ustr));
  230. return 0;
  231. }
  232. cmp_id = ocu_i->u_cmpID;
  233. if (cmp_id != 8 && cmp_id != 16) {
  234. memset(utf_o, 0, sizeof(struct ustr));
  235. printk(KERN_ERR "udf: unknown compression code (%d) stri=%s\n",
  236. cmp_id, ocu_i->u_name);
  237. return 0;
  238. }
  239. ocu = ocu_i->u_name;
  240. utf_o->u_len = 0;
  241. for (i = 0; (i < ocu_len) && (utf_o->u_len <= (UDF_NAME_LEN - 3));) {
  242. /* Expand OSTA compressed Unicode to Unicode */
  243. uint32_t c = ocu[i++];
  244. if (cmp_id == 16)
  245. c = (c << 8) | ocu[i++];
  246. len = nls->uni2char(c, &utf_o->u_name[utf_o->u_len],
  247. UDF_NAME_LEN - utf_o->u_len);
  248. /* Valid character? */
  249. if (len >= 0)
  250. utf_o->u_len += len;
  251. else
  252. utf_o->u_name[utf_o->u_len++] = '?';
  253. }
  254. utf_o->u_cmpID = 8;
  255. return utf_o->u_len;
  256. }
  257. static int udf_NLStoCS0(struct nls_table *nls, dstring *ocu, struct ustr *uni,
  258. int length)
  259. {
  260. int len;
  261. unsigned i, max_val;
  262. uint16_t uni_char;
  263. int u_len;
  264. memset(ocu, 0, sizeof(dstring) * length);
  265. ocu[0] = 8;
  266. max_val = 0xffU;
  267. try_again:
  268. u_len = 0U;
  269. for (i = 0U; i < uni->u_len; i++) {
  270. len = nls->char2uni(&uni->u_name[i], uni->u_len - i, &uni_char);
  271. if (!len)
  272. continue;
  273. /* Invalid character, deal with it */
  274. if (len < 0) {
  275. len = 1;
  276. uni_char = '?';
  277. }
  278. if (uni_char > max_val) {
  279. max_val = 0xffffU;
  280. ocu[0] = (uint8_t)0x10U;
  281. goto try_again;
  282. }
  283. if (max_val == 0xffffU)
  284. ocu[++u_len] = (uint8_t)(uni_char >> 8);
  285. ocu[++u_len] = (uint8_t)(uni_char & 0xffU);
  286. i += len - 1;
  287. }
  288. ocu[length - 1] = (uint8_t)u_len + 1;
  289. return u_len + 1;
  290. }
  291. int udf_get_filename(struct super_block *sb, uint8_t *sname, uint8_t *dname,
  292. int flen)
  293. {
  294. struct ustr *filename, *unifilename;
  295. int len = 0;
  296. filename = kmalloc(sizeof(struct ustr), GFP_NOFS);
  297. if (!filename)
  298. return 0;
  299. unifilename = kmalloc(sizeof(struct ustr), GFP_NOFS);
  300. if (!unifilename)
  301. goto out1;
  302. if (udf_build_ustr_exact(unifilename, sname, flen))
  303. goto out2;
  304. if (UDF_QUERY_FLAG(sb, UDF_FLAG_UTF8)) {
  305. if (!udf_CS0toUTF8(filename, unifilename)) {
  306. udf_debug("Failed in udf_get_filename: sname = %s\n",
  307. sname);
  308. goto out2;
  309. }
  310. } else if (UDF_QUERY_FLAG(sb, UDF_FLAG_NLS_MAP)) {
  311. if (!udf_CS0toNLS(UDF_SB(sb)->s_nls_map, filename,
  312. unifilename)) {
  313. udf_debug("Failed in udf_get_filename: sname = %s\n",
  314. sname);
  315. goto out2;
  316. }
  317. } else
  318. goto out2;
  319. len = udf_translate_to_linux(dname, filename->u_name, filename->u_len,
  320. unifilename->u_name, unifilename->u_len);
  321. out2:
  322. kfree(unifilename);
  323. out1:
  324. kfree(filename);
  325. return len;
  326. }
  327. int udf_put_filename(struct super_block *sb, const uint8_t *sname,
  328. uint8_t *dname, int flen)
  329. {
  330. struct ustr unifilename;
  331. int namelen;
  332. if (!udf_char_to_ustr(&unifilename, sname, flen))
  333. return 0;
  334. if (UDF_QUERY_FLAG(sb, UDF_FLAG_UTF8)) {
  335. namelen = udf_UTF8toCS0(dname, &unifilename, UDF_NAME_LEN);
  336. if (!namelen)
  337. return 0;
  338. } else if (UDF_QUERY_FLAG(sb, UDF_FLAG_NLS_MAP)) {
  339. namelen = udf_NLStoCS0(UDF_SB(sb)->s_nls_map, dname,
  340. &unifilename, UDF_NAME_LEN);
  341. if (!namelen)
  342. return 0;
  343. } else
  344. return 0;
  345. return namelen;
  346. }
  347. #define ILLEGAL_CHAR_MARK '_'
  348. #define EXT_MARK '.'
  349. #define CRC_MARK '#'
  350. #define EXT_SIZE 5
  351. static int udf_translate_to_linux(uint8_t *newName, uint8_t *udfName,
  352. int udfLen, uint8_t *fidName,
  353. int fidNameLen)
  354. {
  355. int index, newIndex = 0, needsCRC = 0;
  356. int extIndex = 0, newExtIndex = 0, hasExt = 0;
  357. unsigned short valueCRC;
  358. uint8_t curr;
  359. const uint8_t hexChar[] = "0123456789ABCDEF";
  360. if (udfName[0] == '.' &&
  361. (udfLen == 1 || (udfLen == 2 && udfName[1] == '.'))) {
  362. needsCRC = 1;
  363. newIndex = udfLen;
  364. memcpy(newName, udfName, udfLen);
  365. } else {
  366. for (index = 0; index < udfLen; index++) {
  367. curr = udfName[index];
  368. if (curr == '/' || curr == 0) {
  369. needsCRC = 1;
  370. curr = ILLEGAL_CHAR_MARK;
  371. while (index + 1 < udfLen &&
  372. (udfName[index + 1] == '/' ||
  373. udfName[index + 1] == 0))
  374. index++;
  375. }
  376. if (curr == EXT_MARK &&
  377. (udfLen - index - 1) <= EXT_SIZE) {
  378. if (udfLen == index + 1)
  379. hasExt = 0;
  380. else {
  381. hasExt = 1;
  382. extIndex = index;
  383. newExtIndex = newIndex;
  384. }
  385. }
  386. if (newIndex < 256)
  387. newName[newIndex++] = curr;
  388. else
  389. needsCRC = 1;
  390. }
  391. }
  392. if (needsCRC) {
  393. uint8_t ext[EXT_SIZE];
  394. int localExtIndex = 0;
  395. if (hasExt) {
  396. int maxFilenameLen;
  397. for (index = 0;
  398. index < EXT_SIZE && extIndex + index + 1 < udfLen;
  399. index++) {
  400. curr = udfName[extIndex + index + 1];
  401. if (curr == '/' || curr == 0) {
  402. needsCRC = 1;
  403. curr = ILLEGAL_CHAR_MARK;
  404. while (extIndex + index + 2 < udfLen &&
  405. (index + 1 < EXT_SIZE &&
  406. (udfName[extIndex + index + 2] == '/' ||
  407. udfName[extIndex + index + 2] == 0)))
  408. index++;
  409. }
  410. ext[localExtIndex++] = curr;
  411. }
  412. maxFilenameLen = 250 - localExtIndex;
  413. if (newIndex > maxFilenameLen)
  414. newIndex = maxFilenameLen;
  415. else
  416. newIndex = newExtIndex;
  417. } else if (newIndex > 250)
  418. newIndex = 250;
  419. newName[newIndex++] = CRC_MARK;
  420. valueCRC = crc_itu_t(0, fidName, fidNameLen);
  421. newName[newIndex++] = hexChar[(valueCRC & 0xf000) >> 12];
  422. newName[newIndex++] = hexChar[(valueCRC & 0x0f00) >> 8];
  423. newName[newIndex++] = hexChar[(valueCRC & 0x00f0) >> 4];
  424. newName[newIndex++] = hexChar[(valueCRC & 0x000f)];
  425. if (hasExt) {
  426. newName[newIndex++] = EXT_MARK;
  427. for (index = 0; index < localExtIndex; index++)
  428. newName[newIndex++] = ext[index];
  429. }
  430. }
  431. return newIndex;
  432. }