/* +----------------------------------------------------------------------+ | PHP Version 4 | +----------------------------------------------------------------------+ | Copyright (c) 1997-2002 The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 2.02 of the PHP license, | | that is bundled with this package in the file LICENSE, and is | | available at through the world-wide-web at | | http://www.php.net/license/2_02.txt. | | If you did not receive a copy of the PHP license and are unable to | | obtain it through the world-wide-web, please send a note to | | license@php.net so we can mail you a copy immediately. | +----------------------------------------------------------------------+ | Authors: Rasmus Lerdorf | | Jaakko Hyvätti | | Wez Furlong | +----------------------------------------------------------------------+ */ /* $Id$ */ #include "php.h" #include "reg.h" #include "html.h" #include "php_string.h" #if HAVE_LOCALE_H #include #endif #if HAVE_LANGINFO_H #include #endif /* This must be fixed to handle the input string according to LC_CTYPE. Defaults to ISO-8859-1 for now. */ enum entity_charset { cs_terminator, cs_8859_1, cs_cp1252, cs_8859_15, cs_utf_8, cs_big5, cs_gb2312, cs_big5hkscs, cs_sjis, cs_eucjp}; typedef const char *entity_table_t; /* codepage 1252 is a Windows extension to iso-8859-1. */ static entity_table_t ent_cp_1252[] = { NULL, NULL, "sbquo", "fnof", "bdquo", "hellip", "dagger", "Dagger", "circ", "permil", "Scaron", "lsaquo", "OElig", NULL, NULL, NULL, NULL, "lsquo", "rsquo", "ldquo", "rdquo", "bull", "ndash", "mdash", "tilde", "trade", "scaron", "rsaquo", "oelig", NULL, NULL, "Yuml" }; static entity_table_t ent_iso_8859_1[] = { "nbsp", "iexcl", "cent", "pound", "curren", "yen", "brvbar", "sect", "uml", "copy", "ordf", "laquo", "not", "shy", "reg", "macr", "deg", "plusmn", "sup2", "sup3", "acute", "micro", "para", "middot", "cedil", "sup1", "ordm", "raquo", "frac14", "frac12", "frac34", "iquest", "Agrave", "Aacute", "Acirc", "Atilde", "Auml", "Aring", "AElig", "Ccedil", "Egrave", "Eacute", "Ecirc", "Euml", "Igrave", "Iacute", "Icirc", "Iuml", "ETH", "Ntilde", "Ograve", "Oacute", "Ocirc", "Otilde", "Ouml", "times", "Oslash", "Ugrave", "Uacute", "Ucirc", "Uuml", "Yacute", "THORN", "szlig", "agrave", "aacute", "acirc", "atilde", "auml", "aring", "aelig", "ccedil", "egrave", "eacute", "ecirc", "euml", "igrave", "iacute", "icirc", "iuml", "eth", "ntilde", "ograve", "oacute", "ocirc", "otilde", "ouml", "divide", "oslash", "ugrave", "uacute", "ucirc", "uuml", "yacute", "thorn", "yuml" }; static entity_table_t ent_iso_8859_15[] = { "nbsp", "iexcl", "cent", "pound", "euro", "yen", "Scaron", "sect", "scaron", "copy", "ordf", "laquo", "not", "shy", "reg", "macr", "deg", "plusmn", "sup2", "sup3", NULL, /* Zcaron */ "micro", "para", "middot", NULL, /* zcaron */ "sup1", "ordm", "raquo", "OElig", "oelig", "Yuml", "iquest", "Agrave", "Aacute", "Acirc", "Atilde", "Auml", "Aring", "AElig", "Ccedil", "Egrave", "Eacute", "Ecirc", "Euml", "Igrave", "Iacute", "Icirc", "Iuml", "ETH", "Ntilde", "Ograve", "Oacute", "Ocirc", "Otilde", "Ouml", "times", "Oslash", "Ugrave", "Uacute", "Ucirc", "Uuml", "Yacute", "THORN", "szlig", "agrave", "aacute", "acirc", "atilde", "auml", "aring", "aelig", "ccedil", "egrave", "eacute", "ecirc", "euml", "igrave", "iacute", "icirc", "iuml", "eth", "ntilde", "ograve", "oacute", "ocirc", "otilde", "ouml", "divide", "oslash", "ugrave", "uacute", "ucirc", "uuml", "yacute", "thorn", "yuml" }; struct html_entity_map { enum entity_charset charset; /* charset identifier */ unsigned short basechar; /* char code at start of table */ unsigned short endchar; /* last char code in the table */ entity_table_t *table; /* the table of mappings */ }; static const struct html_entity_map entity_map[] = { { cs_cp1252, 0x80, 0x9f, ent_cp_1252 }, { cs_cp1252, 0xa0, 0xff, ent_iso_8859_1 }, { cs_8859_1, 0xa0, 0xff, ent_iso_8859_1 }, { cs_8859_15, 0xa0, 0xff, ent_iso_8859_15 }, { cs_utf_8, 0xa0, 0xff, ent_iso_8859_1 }, { cs_big5, 0xa0, 0xff, ent_iso_8859_1 }, { cs_gb2312, 0xa0, 0xff, ent_iso_8859_1 }, { cs_big5hkscs, 0xa0, 0xff, ent_iso_8859_1 }, { cs_sjis, 0xa0, 0xff, ent_iso_8859_1 }, { cs_eucjp, 0xa0, 0xff, ent_iso_8859_1 }, { cs_terminator } }; static const struct { const char *codeset; enum entity_charset charset; } charset_map[] = { { "ISO-8859-1", cs_8859_1 }, { "ISO-8859-15", cs_8859_15 }, { "utf-8", cs_utf_8 }, { "cp1252", cs_cp1252 }, { "BIG5", cs_big5 }, { "GB2312", cs_gb2312 }, { "BIG5-HKSCS", cs_big5hkscs }, { "Shift_JIS", cs_sjis }, { "SJIS", cs_sjis }, { "EUCJP", cs_eucjp }, { "EUC-JP", cs_eucjp }, { NULL } }; static const struct { unsigned short charcode; char *entity; int entitylen; int flags; } basic_entities[] = { { '&', "&", 5, 0 }, { '"', """, 6, ENT_HTML_QUOTE_DOUBLE }, { '\'', "'", 6, ENT_HTML_QUOTE_SINGLE }, { '<', "<", 4, 0 }, { '>', ">", 4, 0 }, { 0, NULL, 0, 0 } }; #define MB_RETURN { \ *newpos = pos; \ mbseq[mbpos] = '\0'; \ *mbseqlen = mbpos; \ return this_char; } #define MB_WRITE(mbchar) { \ mbspace--; \ if (mbspace == 0) { \ MB_RETURN; \ } \ mbseq[mbpos++] = (mbchar); } /* {{{ get_next_char */ inline static unsigned short get_next_char(enum entity_charset charset, unsigned char * str, int * newpos, unsigned char * mbseq, int * mbseqlen) { int pos = *newpos; int mbpos = 0; int mbspace = *mbseqlen; unsigned short this_char = str[pos++]; if (mbspace <= 0) { *mbseqlen = 0; return this_char; } MB_WRITE((unsigned char)this_char); switch(charset) { case cs_utf_8: { unsigned long utf = 0; int stat = 0; int more = 1; /* unpack utf-8 encoding into a wide char. * Code stolen from the mbstring extension */ do { if (this_char < 0x80) { more = 0; break; } else if (this_char < 0xc0) { switch(stat) { case 0x10: /* 2, 2nd */ case 0x21: /* 3, 3rd */ case 0x32: /* 4, 4th */ case 0x43: /* 5, 5th */ case 0x54: /* 6, 6th */ /* last byte in sequence */ more = 0; utf |= (this_char & 0x3f); this_char = (unsigned short)utf; break; case 0x20: /* 3, 2nd */ case 0x31: /* 4, 3rd */ case 0x42: /* 5, 4th */ case 0x53: /* 6, 5th */ /* penultimate char */ utf |= ((this_char & 0x3f) << 6); stat++; break; case 0x30: /* 4, 2nd */ case 0x41: /* 5, 3rd */ case 0x52: /* 6, 4th */ utf |= ((this_char & 0x3f) << 12); stat++; break; case 0x40: /* 5, 2nd */ case 0x51: utf |= ((this_char & 0x3f) << 18); stat++; break; case 0x50: /* 6, 2nd */ utf |= ((this_char & 0x3f) << 24); stat++; default: /* invalid */ more = 0; } } /* lead byte */ else if (this_char < 0xe0) { stat = 0x10; /* 2 byte */ utf = (this_char & 0x1f) << 6; } else if (this_char < 0xf0) { stat = 0x20; /* 3 byte */ utf = (this_char & 0xf) << 12; } else if (this_char < 0xf8) { stat = 0x30; /* 4 byte */ utf = (this_char & 0x7) << 18; } else if (this_char < 0xfc) { stat = 0x40; /* 5 byte */ utf = (this_char & 0x3) << 24; } else if (this_char < 0xfe) { stat = 0x50; /* 6 byte */ utf = (this_char & 0x1) << 30; } else { /* invalid; bail */ more = 0; break; } if (more) { this_char = str[pos++]; MB_WRITE((unsigned char)this_char); } } while(more); } break; case cs_big5: case cs_gb2312: case cs_big5hkscs: { /* check if this is the first of a 2-byte sequence */ if (this_char >= 0xa1 && this_char <= 0xf9) { /* peek at the next char */ unsigned char next_char = str[pos]; if ((next_char >= 0x40 && next_char <= 0x73) || (next_char >= 0xa1 && next_char <= 0xfe)) { /* yes, this a wide char */ this_char <<= 8; MB_WRITE(next_char); this_char |= next_char; pos++; } } break; } case cs_sjis: { /* check if this is the first of a 2-byte sequence */ if ( (this_char >= 0x81 && this_char <= 0x9f) || (this_char >= 0xe0 && this_char <= 0xef) ) { /* peek at the next char */ unsigned char next_char = str[pos]; if ((next_char >= 0x40 && next_char <= 0x7e) || (next_char >= 0x80 && next_char <= 0xfc)) { /* yes, this a wide char */ this_char <<= 8; MB_WRITE(next_char); this_char |= next_char; pos++; } } break; } case cs_eucjp: { /* check if this is the first of a multi-byte sequence */ if (this_char >= 0xa1 && this_char <= 0xfe) { /* peek at the next char */ unsigned char next_char = str[pos]; if (next_char >= 0xa1 && next_char <= 0xfe) { /* yes, this a jis kanji char */ this_char <<= 8; MB_WRITE(next_char); this_char |= next_char; pos++; } } else if (this_char == 0x8e) { /* peek at the next char */ unsigned char next_char = str[pos]; if (next_char >= 0xa1 && next_char <= 0xdf) { /* JIS X 0201 kana */ this_char <<= 8; MB_WRITE(next_char); this_char |= next_char; pos++; } } else if (this_char == 0x8f) { /* peek at the next two char */ unsigned char next_char = str[pos]; unsigned char next2_char = str[pos+1]; if ((next_char >= 0xa1 && next_char <= 0xfe) && (next2_char >= 0xa1 && next2_char <= 0xfe)) { /* JIS X 0212 hojo-kanji */ this_char <<= 8; MB_WRITE(next_char); this_char |= next_char; pos++; this_char <<= 8; MB_WRITE(next2_char); this_char |= next2_char; pos++; } } break; } default: { break; } } MB_RETURN; } /* }}} */ /* {{{ entity_charset determine_charset * returns the charset identifier based on current locale or a hint. * defaults to iso-8859-1 */ static enum entity_charset determine_charset(char *charset_hint) { int i; enum entity_charset charset = cs_8859_1; int len; /* Guarantee default behaviour for backwards compatibility */ if (charset_hint == NULL) return cs_8859_1; if (strlen(charset_hint) == 0) { /* try to detect the charset for the locale */ #if HAVE_NL_LANGINFO && HAVE_LOCALE_H && defined(CODESET) charset_hint = nl_langinfo(CODESET); #endif #if HAVE_LOCALE_H if (charset_hint == NULL) { /* try to figure out the charset from the locale */ char *localename; char *dot, *at; /* lang[_territory][.codeset][@modifier] */ localename = setlocale(LC_CTYPE, NULL); dot = strchr(localename, '.'); if (dot) { dot++; /* locale specifies a codeset */ at = strchr(dot, '@'); if (at) len = at - dot; else len = strlen(dot); charset_hint = dot; } else { /* no explicit name; see if the name itself * is the charset */ charset_hint = localename; len = strlen(charset_hint); } } else len = strlen(charset_hint); #else if (charset_hint) len = strlen(charset_hint); #endif } if (charset_hint) { /* now walk the charset map and look for the codeset */ for (i = 0; charset_map[i].codeset; i++) { if (strncasecmp(charset_hint, charset_map[i].codeset, len) == 0) { charset = charset_map[i].charset; break; } } } return charset; } /* }}} */ /* {{{ php_unescape_html_entities */ PHPAPI char *php_unescape_html_entities(unsigned char *old, int oldlen, int *newlen, int all, int quote_style, char *hint_charset) { int retlen; int j, k; char *replaced, *ret; enum entity_charset charset = determine_charset(hint_charset); unsigned char replacement[15]; ret = estrdup(old); retlen = oldlen; if (all) { /* look for a match in the maps for this charset */ for (j=0; entity_map[j].charset != cs_terminator; j++) { if (entity_map[j].charset != charset) continue; for (k = entity_map[j].basechar; k <= entity_map[j].endchar; k++) { unsigned char entity[32]; int entity_length = 0; if (entity_map[j].table[k - entity_map[j].basechar] == NULL) continue; entity[0] = '&'; entity_length = strlen(entity_map[j].table[k - entity_map[j].basechar]); strncpy(&entity[1], entity_map[j].table[k - entity_map[j].basechar], sizeof(entity) - 2); entity[entity_length+1] = ';'; entity[entity_length+2] = '\0'; entity_length += 2; /* When we have MBCS entities in the tables above, this will need to handle it */ if (k > 0xff) zend_error(E_WARNING, "cannot yet handle MBCS in html_entity_decode()!"); replacement[0] = k; replacement[1] = '\0'; replaced = php_str_to_str(ret, retlen, entity, entity_length, replacement, 1, &retlen); efree(ret); ret = replaced; } } } for (j = 0; basic_entities[j].charcode != 0; j++) { if (basic_entities[j].flags && (quote_style & basic_entities[j].flags) == 0) continue; replacement[0] = (unsigned char)basic_entities[j].charcode; replacement[1] = '\0'; replaced = php_str_to_str(ret, retlen, basic_entities[j].entity, basic_entities[j].entitylen, replacement, 1, &retlen); efree(ret); ret = replaced; } *newlen = retlen; return ret; } /* }}} */ /* {{{ php_escape_html_entities */ PHPAPI char *php_escape_html_entities(unsigned char *old, int oldlen, int *newlen, int all, int quote_style, char *hint_charset) { int i, j, maxlen, len; char *replaced; enum entity_charset charset = determine_charset(hint_charset); int matches_map; maxlen = 2 * oldlen; if (maxlen < 128) maxlen = 128; replaced = emalloc (maxlen); len = 0; i = 0; while (i < oldlen) { unsigned char mbsequence[16]; /* allow up to 15 characters in a multibyte sequence */ int mbseqlen = sizeof(mbsequence); unsigned short this_char = get_next_char(charset, old, &i, mbsequence, &mbseqlen); matches_map = 0; if (len + 9 > maxlen) replaced = erealloc (replaced, maxlen += 128); if (all) { /* look for a match in the maps for this charset */ unsigned char *rep; for (j=0; entity_map[j].charset != cs_terminator; j++) { if (entity_map[j].charset == charset && this_char >= entity_map[j].basechar && this_char <= entity_map[j].endchar) { rep = (unsigned char*)entity_map[j].table[this_char - entity_map[j].basechar]; if (rep == NULL) { /* there is no entity for this position; fall through and * just output the character itself */ break; } matches_map = 1; break; } } if (matches_map) { replaced[len++] = '&'; strcpy(replaced + len, rep); len += strlen(rep); replaced[len++] = ';'; } } if (!matches_map) { int is_basic = 0; for (j = 0; basic_entities[j].charcode != 0; j++) { if ((basic_entities[j].charcode != this_char) || (basic_entities[j].flags && (quote_style & basic_entities[j].flags) == 0)) continue; memcpy(replaced + len, basic_entities[j].entity, basic_entities[j].entitylen); len += basic_entities[j].entitylen; is_basic = 1; break; } if (!is_basic) { if (this_char > 0xff) { /* a wide char without a named entity; pass through the original sequence */ memcpy(replaced + len, mbsequence, mbseqlen); len += mbseqlen; } else replaced [len++] = (unsigned char)this_char; } } } replaced [len] = '\0'; *newlen = len; return replaced; } /* }}} */ /* {{{ php_html_entities */ static void php_html_entities(INTERNAL_FUNCTION_PARAMETERS, int all) { char *str, *hint_charset = NULL; int str_len, hint_charset_len, len, quote_style = ENT_COMPAT; char *replaced; if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ls", &str, &str_len, "e_style, &hint_charset, &hint_charset_len) == FAILURE) { return; } replaced = php_escape_html_entities(str, str_len, &len, all, quote_style, hint_charset); RETVAL_STRINGL(replaced, len, 0); } /* }}} */ #define HTML_SPECIALCHARS 0 #define HTML_ENTITIES 1 /* {{{ register_html_constants */ void register_html_constants(INIT_FUNC_ARGS) { REGISTER_LONG_CONSTANT("HTML_SPECIALCHARS", HTML_SPECIALCHARS, CONST_PERSISTENT|CONST_CS); REGISTER_LONG_CONSTANT("HTML_ENTITIES", HTML_ENTITIES, CONST_PERSISTENT|CONST_CS); REGISTER_LONG_CONSTANT("ENT_COMPAT", ENT_COMPAT, CONST_PERSISTENT|CONST_CS); REGISTER_LONG_CONSTANT("ENT_QUOTES", ENT_QUOTES, CONST_PERSISTENT|CONST_CS); REGISTER_LONG_CONSTANT("ENT_NOQUOTES", ENT_NOQUOTES, CONST_PERSISTENT|CONST_CS); } /* }}} */ /* {{{ proto string htmlspecialchars(string string [, int quote_style][, string charset]) Convert special characters to HTML entities */ PHP_FUNCTION(htmlspecialchars) { php_html_entities(INTERNAL_FUNCTION_PARAM_PASSTHRU, 0); } /* }}} */ /* {{{ proto string html_entity_decode(string string [, int quote_style][, string charset]) Convert all applicable characters to HTML entities */ PHP_FUNCTION(html_entity_decode) { char *str, *hint_charset = NULL; int str_len, hint_charset_len, len, quote_style = ENT_COMPAT; char *replaced; if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ls", &str, &str_len, "e_style, &hint_charset, &hint_charset_len) == FAILURE) { return; } replaced = php_unescape_html_entities(str, str_len, &len, 1, quote_style, hint_charset); RETVAL_STRINGL(replaced, len, 0); } /* }}} */ /* {{{ proto string htmlentities(string string [, int quote_style][, string charset]) Convert all applicable characters to HTML entities */ PHP_FUNCTION(htmlentities) { php_html_entities(INTERNAL_FUNCTION_PARAM_PASSTHRU, 1); } /* }}} */ /* {{{ proto array get_html_translation_table([int table [, int quote_style]]) Returns the internal translation table used by htmlspecialchars and htmlentities */ PHP_FUNCTION(get_html_translation_table) { int which = HTML_SPECIALCHARS, quote_style = ENT_COMPAT; int i, j; char ind[2]; enum entity_charset charset = determine_charset(NULL); if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|ll", &which, "e_style) == FAILURE) { return; } array_init(return_value); ind[1] = 0; switch (which) { case HTML_ENTITIES: for (j=0; entity_map[j].charset != cs_terminator; j++) { if (entity_map[j].charset != charset) continue; for (i = 0; i < entity_map[j].endchar - entity_map[j].basechar; i++) { char buffer[16]; if (entity_map[j].table[i] == NULL) continue; /* what about wide chars here ?? */ ind[0] = i + entity_map[j].basechar; sprintf(buffer, "&%s;", entity_map[j].table[i]); add_assoc_string(return_value, ind, buffer, 1); } } /* break thru */ case HTML_SPECIALCHARS: for (j = 0; basic_entities[j].charcode != 0; j++) { if (basic_entities[j].flags && (quote_style & basic_entities[j].flags) == 0) continue; ind[0] = (unsigned char)basic_entities[j].charcode; add_assoc_string(return_value, ind, basic_entities[j].entity, 1); } break; } } /* }}} */ /* * Local variables: * tab-width: 4 * c-basic-offset: 4 * End: * vim600: sw=4 ts=4 fdm=marker * vim<600: sw=4 ts=4 */