Blog. Just Blog

Подсветка синтаксиса MySQL-запросов

Версия для печати Добавить в Избранное Отправить на E-Mail 07.04.2012 | Категория: Web-мастеру и не только | Автор: ManHunter
При выводе диагностики в своих рабочих проектах я использую вот такую функцию для подсветки синтаксиса MySQL-запросов. Она преобразует текст запроса, делая все служебные слова языка заглавными буквами и подсвечивает их цветом, а также выделяет различными цветами числовые значения и скобки. Такая подсветка позволяет сразу же увидеть синтаксические ошибки, да и вообще повышает наглядность сообщений при отладке скриптов.
Code (PHP) : Убрать нумерацию
  1. //-------------------------------------------------------------------
  2. // Функция подсветки синтаксиса MySQL-запроса
  3. // (C) ManHunter / PCL
  4. // http://www.manhunter.ru
  5. //-------------------------------------------------------------------
  6. function mysql_debug($query) {
  7.     $tmp=htmlspecialchars($query);
  8.     $tmp=str_replace("\r",'',$tmp);
  9.     $tmp=trim(str_replace("\n","\r\n",$tmp))."\r\n";
  10.  
  11.     $quote_list_text=array();
  12.     $quote_list_symbols=array();
  13.  
  14.     $k=0;
  15.     $quotes=Array();
  16.     // Обработать экранированные кавычки
  17.     preg_match_all("/\\\'|\\\"/is", $tmp, $quotes);
  18.     array_unique($quotes);
  19.     if (count($quotes)) {
  20.         foreach($quotes[0] as $i) {
  21.             $k++;
  22.             $quote_list_symbols[$k]=$i;
  23.             $tmp=str_replace($i, '<symbol'.$k.'>', $tmp);
  24.         }
  25.     }
  26.  
  27.     $matches=Array(
  28.         "/(&quot;|'|`)(.*?)(\\1)/is", // текст в кавычках
  29.         "/\/\*.*?\*\//s",             // текст комментария
  30.         "/ \-\-.*\x0D\x0A/",          // текст ' --' комментария
  31.         "/ #.*\x0D\x0A/",             // текст ' #' комментария
  32.     );
  33.  
  34.     // Обработать текст
  35.     foreach($matches as $match) {
  36.         // Обработать текст
  37.         $found=array();
  38.         preg_match_all($match, $tmp, $found);
  39.         $quotes=(array)$found[0];
  40.         array_unique($quotes);
  41.         if (count($quotes)) {
  42.             foreach($quotes as $i) {
  43.                 $k++;
  44.                 $quote_list_text[$k]=$i;
  45.                 $tmp=str_replace($i, '<text'.$k.'>', $tmp);
  46.             }
  47.         }
  48.     }    
  49.  
  50.     // Служебные слова MySQL
  51.     $keywords=Array(
  52.         "avg", "as", "auto_increment", "and", "analyze", "alter",
  53.         "asc", "all", "after", "add", "action", "against",
  54.         "aes_encrypt", "aes_decrypt", "ascii", "abs", "acos",
  55.         "asin", "atan", "authors", "between", "btree", "backup",
  56.         "by", "binary", "before", "binlog", "benchmark", "blob",
  57.         "bigint", "bit_count", "bit_or", "bit_and", "bin",
  58.         "bit_length", "both", "create", "count", "comment",
  59.         "check", "char", "concat", "cipher", "changed", "column",
  60.         "columns", "change", "constraint", "cascade", "checksum",
  61.         "cross", "close", "concurrent", "commit", "curdate",
  62.         "current_date", "curtime", "current_time",
  63.         "current_timestamp", "cast", "convert", "connection_id",
  64.         "coalesce", "case", "conv", "concat_ws", "char_length",
  65.         "character_length", "ceiling", "cos", "cot", "crc32",
  66.         "compress", "delete", "drop", "default", "distinct",
  67.         "decimal", "date", "describe", "data", "desc",
  68.         "dayofmonth", "date_add", "database", "databases",
  69.         "double", "duplicate", "disable", "datetime", "dumpfile",
  70.         "distinctrow", "delayed", "dayofweek", "dayofyear",
  71.         "dayname", "day_minute", "date_format", "date_sub", 
  72.         "decode", "des_encrypt", "des_decrypt", "degrees",
  73.         "decompress", "dec", "engine", "explain", "enum",
  74.         "escaped", "execute", "extended", "errors", "exists",
  75.         "enable", "enclosed", "extract", "encrypt", "encode",
  76.         "elt", "export_set", "escape", "exp", "end", "from",
  77.         "float", "flush", "fields", "file", "for", "fast", "full",
  78.         "fulltext", "first", "foreign", "force", "from_days", 
  79.         "from_unixtime", "format", "found_rows", "floor", "field",
  80.         "find_in_set", "group", "grant", "grants", "global", 
  81.         "get_lock", "greatest", "having", "high_priority", 
  82.         "handler", "hour", "hex", "insert", "into", "inner", 
  83.         "int", "ifnull", "if", "isnull", "in", "infile", "is", 
  84.         "interval", "ignore", "identified", "index", "issuer", 
  85.         "integer", "is_free_lock", "inet_ntoa", "inet_aton", 
  86.         "instr", "join", "kill", "key", "keys", "left", "load", 
  87.         "local", "limit", "like", "lock", "lpad", "last_insert_id", 
  88.         "logs", "length", "longblob", "longtext", "last", "lines", 
  89.         "low_priority", "locate", "ltrim", "leading", "lcase", 
  90.         "lower", "load_file", "ln", "log", "least", "month", "mod", 
  91.         "max", "min", "mediumint", "medium", "master", "modify", 
  92.         "mediumblob", "mediumtext", "match", "mode", "monthname", 
  93.         "mid", "minute", "master_pos_wait", "make_set", "null", 
  94.         "not", "now", "none", "new", "numeric", "no", "natural", 
  95.         "next", "nullif", "national", "nchar", "on", "or", 
  96.         "optimize", "order", "optionally", "option", "outfile", 
  97.         "open", "offset", "outer", "old_password", "ord", "oct", 
  98.         "octet_length", "primary", "password", "privileges", 
  99.         "process", "processlist", "purge", "partial", "procedure",
  100.         "prev", "period_add", "period_diff", "position", "pow", 
  101.         "power", "pi", "quick", "quarter", "quote", "right", 
  102.         "repair", "restore", "reset", "regexp", "references", 
  103.         "replace", "revoke", "reload", "require", "replication", 
  104.         "read", "rand", "rename", "real", "restrict", 
  105.         "release_lock", "rpad", "rtrim", "repeat", "reverse", 
  106.         "rlike", "round", "radians", "rollup", "select", "sum", 
  107.         "set", "show", "substring", "smallint", "super", "subject", 
  108.         "status", "slave", "session", "start", "share", 
  109.         "straight_join", "sql_small_result", "sql_big_result", 
  110.         "sql_buffer_result", "sql_cache", "sql_no_cache", 
  111.         "sql_calc_found_rows", "second", "sysdate", "sec_to_time", 
  112.         "system_user", "session_user", "substring_index", "std", 
  113.         "stddev", "soundex", "space", "strcmp", "sign", "sqrt", 
  114.         "sin", "straight", "sleep", "text", "truncate", "table", 
  115.         "tinyint", "tables", "to_days", "temporary", "terminated", 
  116.         "to", "types", "time", "timestamp", "tinytext", 
  117.         "tinyblob", "transaction", "time_format", "time_to_sec", 
  118.         "trim", "trailing", "tan", "then", "update", "union", 
  119.         "using", "unsigned", "unlock", "usage", "use_frm", 
  120.         "unix_timestamp", "unique", "use", "user", "ucase", 
  121.         "upper", "uuid", "values", "varchar", "variables", 
  122.         "version", "variance", "varying", "where", "with", 
  123.         "warnings", "write", "weekday", "week", "when", "xor", 
  124.         "year", "yearweek", "year_month", "zerofill");
  125.     $replace=Array();
  126.     foreach($keywords as $keyword) {
  127.         $replace[]='/\b'.$keyword.'\b/ie';
  128.     }
  129.  
  130.     // Выделить служебные слова в тексте запроса
  131.     $tmp=preg_replace($replace,
  132.         '"<b style=\"color:#0000FF\">".strtoupper("$0")."</b>"',$tmp);
  133.  
  134.     // Выделить числовые значения в тексте запроса
  135.     $tmp=preg_replace('/\b([\.0-9]+)\b/',
  136.         '<b style="color:#008000">\1</b>',$tmp);
  137.  
  138.     // Выделить скобки в тексте запроса
  139.     $tmp=preg_replace('/([\(\)])/',
  140.         '<b style="color:#FF0000">\1</b>',$tmp);
  141.  
  142.     // Вернуть обратно строки в кавычках
  143.     if (count($quote_list_text)) {
  144.         $quote_list_text=array_reverse($quote_list_text, true);
  145.         foreach($quote_list_text as $k=>$i) {
  146.             $tmp=str_replace('<text'.$k.'>',
  147.                 '<span style="color:#777;">'.$i.'</span>', $tmp);
  148.         }
  149.     }
  150.     // Вернуть обратно экранированные символы
  151.     if (count($quote_list_symbols)) {
  152.         $quote_list_symbols=array_reverse($quote_list_symbols, true);
  153.         foreach($quote_list_symbols as $k=>$i) {
  154.             $tmp=str_replace('<symbol'.$k.'>', $i, $tmp);
  155.         }
  156.     }
  157.  
  158.     // Вернуть подсвеченный текст запроса
  159.     // Если не надо расставлять переносы, то уберите nl2br
  160.     return nl2br(trim($tmp));
  161. }
Единственный параметр функции $query - текст исходного запроса. На выходе подсвеченная строка запроса в формате HTML. Цвета подсветки захардкодены в исходнике, если надо, то поменяйте их на свои или вообще замените на определения стилей CSS.

Функция может вернуть неправильный результат, если в комментариях запроса содержатся несогласованные кавычки или апострофы, в остальном при тестировании я никаких проблем не нашел. Вот несколько примеров работы скрипта:

CREATE TABLE `orders` (
`o_id` INT(11) NOT NULL AUTO_INCREMENT,
`o_date` INT(11) NOT NULL,
`o_client` INT(11) NOT NULL COMMENT 'пользователь создавший заказ',
`o_status` INT(11) NOT NULL COMMENT 'статус заказа',
`o_sum` INT(11) NOT NULL COMMENT 'стоимость размещения',
`o_nds` DECIMAL(15,2) NOT NULL DEFAULT '0.00',
`o_comment` VARCHAR(1024) NOT NULL COMMENT 'Комментарии к заказу',
PRIMARY KEY (`o_id`)
) ENGINE=MyISAM /*!40101 DEFAULT CHARSET=utf8 */;

SELECT SQL_CACHE `regions`.*,
COUNT(`o_id`) AS `o_num`,
SUM(IF(`o_map` != 0, 1, 0)) AS `sum_map`,
SUM(IF(`o_list` != 0, 1, 0)) AS `sum_list`,
SUM(IF(`p_price`>0),1,0) AS `sum_free`,
FROM `regions`, `orders`
LEFT JOIN `prices` ON `p_o_id`=`o_id` AND `p_year`=2012
WHERE `o_region`=`r_id` AND `o_deleted`=0 AND `o_type`=0
GROUP BY `r_id`
HAVING (`sum_free`>50)
ORDER BY `r_order` DESC, `r_name`

Функция предназначена только для подсветки синтаксиса MySQL, но ее можно легко адаптировать под любой другой диалект SQL. Достаточно просто добавить или убрать служебные слова в соответствующем массиве.

Поделиться ссылкой ВКонтакте
Просмотров: 4834 | Комментариев: 7

Метки: PHP, MySQL
Внимание! Статья опубликована больше года назад, информация могла устареть!

Комментарии

Отзывы посетителей сайта о статье
ManHunter (10.04.2012 в 12:06):
Заменить пробелы на '&nbsp;' или выводить запрос в <pre> ... </pre>
Onix (10.04.2012 в 12:05):
А как сделать чтобы табуляция в запросе сохранялась ?
Rush (08.04.2012 в 02:17):
Тут самое интересное в запросах к MySQL.
ManHunter (07.04.2012 в 20:10):
Не пойму только смысл генерации HTML-кода на ассемблере. Все равно никогда не понадобится.
Rush (07.04.2012 в 17:23):
Интереснее было бы сделать, тоже самое на FASM. Хотелось было бы увидеть примерчик запросов на асме в MySQL.
ManHunter (06.04.2012 в 12:41):
Вся проблема в том, что PHP делали много людей, каждый со своим понимаем и логикой. Меня тоже вымораживает разнобой в наименованиях и вольность в параметрах, особенно для строковых функций. Нет-нет и приходится заглядывать в документацию. Хорошо хоть автокомплит в редакторе есть.
DV (06.04.2012 в 12:36):
Хороший скрипт. Но при виде PHP-шных конструкций "foreach($keywords as $keyword)" во мне каждый раз поднимается раздражение. Какой больной ум придумал нездоровый синтаксис "foreach(array as item)" вместо интуитивно понятного "foreach(item in array)"? При чём тут "as" - мы что, приводим массив к элементу этого массива?

Добавить комментарий

Заполните форму для добавления комментария
Имя*:
Текст комментария (не более 2000 символов)*:

*Все поля обязательны для заполнения.
Комментарии, содержащие рекламу, ненормативную лексику, оскорбления и т.п., а также флуд и сообщения не по теме, будут удаляться. Нарушителям может быть заблокирован доступ к сайту.
Это я :-)
Если программист в девять утра уже на работе, значит он там же и ночевал
Главная страница Web-мастеру и не только Образ мышления: Assembler Мои программы Software Темная сторона Силы Обзоры техники А еще я туда ем! Жизнь в оффлайне Всякая всячина
Карта сайта Ссылки Обратная связь Правила сайта Настройки сайта RSS-канал
Ограничение по возрасту 16+ Материалы, опубликованные на этом сайте, не рекомендуются к просмотру лицам в возрасте до 16 лет без присутствия взрослых.
Метки статей
.NET (32), AJAX (5), Assembler (372), COM (42), CSS (44), Exif (15), FASM (8), Firefox (7), HDD (17), Hello Teddy (9), HTML (53), iconBIT (4), JavaScript (76), MySQL (13), Nikon (19), PDF (10), PHP (122), Samsung (6), SEO (12), Sublime Text (9), TintonLife (4), UGREEN (4), Windows 7 (67), аккумуляторы (23), аксессуары (12), анализаторы файлов (8), архиваторы (6), аттракционы (7), безопасность (55), браузеры (16), бытовая техника (20), варенье (19), ВВЦ (9), ВДНХ (14), видео (20), Воробьевы горы (9), вторые блюда (126), выпечка (30), выставки (120), генератор ПСЧ (10), графика (122), десерты (31), Египет (9), заготовки на зиму (47), закуска (22), закуска к пиву (25), зарядные устройства (24), защита (15), зоопарки (10), игры (36), иконки (22), интерфейс (26), исследование защиты (322), каша (4), клавиатура (7), Коломенское (37), консоль (7), концерты (52), Кузьминки (4), куклы (27), ледяные скульптуры (6), мои программы (69), мониторы (6), музеи (78), мультимедиа (82), мясо (62), напитки (14), ноутбуки (8), обфускация (7), окна (71), оформление сайта (51), парки Москвы (7), песчаные скульптуры (13), плееры (10), подводная съемка (4), поздравления (131), полезные функции (42), прохождения (4), процессы (25), птица (22), путешествия (26), распаковка (22), реверсинг (52), регулярные выражения (5), рыба (35), салаты (19), сброс триала (4), сеть (37), система (179), Сокольники (8), соусы (16), супы (14), телефоны (10), Тунис (6), умный дом (14), файлы справки (6), фаст-фуд (18), фестиваль цветов (5), флешки (5), фото (23), хеши (17), числа (8), юмор (12), яйца (19), Яндекс (11)
Вам помог этот сайт?
Сказать спасибо! Поблагодарили 35,693 раза
<< 2024 - ДЕКАБРЬ >>
Пн Вт Ср Чт Пт Сб Вс
            1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31          
День памяти крымчаков и евреев Крыма – жертв нацизма
Международный день танго
Нашли на сайте орфографическую ошибку? Выделите ее мышкой и нажмите
Ctrl
+
Enter
Буду очень благодарен, если размеcтите мою кнопочку:
Личный блог ManHunter'а
Valid CSS Valid XHTML 1.0 Transitional Valid mobileOK Basic Valid RSS
Яндекс тИЦ: {YANDEX_TIC} Яндекс ИКС: 360
Сейчас я слушаю
---
Имя:

Сообщение:

Осталось символов: 200

   
-
Наверх
Powered by PCL's Speckled Band Engine 0.2 RC3
© ManHunter / PCL, 2008-2024
При использовании материалов ссылка на сайт обязательна
Время генерации: 0.08 сек. / MySQL: 2 (0.0049 сек.) / Память: 4.5 Mb
Наверх