Улучшаем Redgate SQL Search: некоторые моменты разработки

Трепетно люблю и пользую при работе в SQL Server Management Studio утилиты от Redgate ^[1], в том числе и бесплатный Redgate SQL Search ^[2].
Все бы хорошо, но еще мечталось о вменяемом инструменте, который бы позволял в дереве объектов создавать собственные папки и раскладывать в них таблички/процедурки.
В один прекрасный момент таковой появился — SQLTreeO ^[3], но тут же наткнулся на проблему — SQLSearch не ищет в созданных им папках.

Собственно, с этого и начался маленький addin для addin'а — SQLSearch Extender ^[4]. Дальше — больше, раз пошла такая пьянка, то почему бы не добавить по мере сил функционала, так как Redgate не торопится реализовывать пожелания пользователей ^[5].
Что добавлено к функционалу SQLSearch'а (настройки в меню Tools -> SQL Search Extender):

• Поиск в папках, созданных SQLTreeO
• Regexp ^[6] поиск
• Подсветка кода и нумерация строк, навигация по вхождениям
• Показывает скрипты таблиц и CLR UDF
• Фильтр для исключения из поиска по имени объектов (например, sp_MS%, %__temp, etc.)
• … всяческие дополнительные фишки ^[7]

Собственно, заметки по разработке.
API для SSMS Microsoft не афиширует, на старте очень помогли следующие статьи —
The Black Art of Writing a SQL Server Management Studio 2005 Add In ^[8] и SQL 2008r2 breaks ssms addins ^[9]

Практически все, что надо для счастья, в этих статьях рассказано, отмечу несколько моментов

Момент 1. Ловим окно SQLSearch.

Так как информации изначально у нас практически нет, то вешаем обработчик на Connect.OnCmdUIContextChanged и вспоминаем WinAPI EnumChildWindows. С глубоким внутренним удовлетворением обнаруживаем, что внутре нужного окна лежит наследник от UserControl, далее по типу и имени (Hawkeye ^[10] в помощь) находим нужные нам элементы. Дальше делаем с интерфейсом все, что нам угодно.

Момент 2. Поиск в папках SQLTreeO

Идея проста — после того, как отработает поиск SQLSearch'а, смотрим на выделенный в Object Explorer'е элемент и, если его имя не совпадает с нужным, то поднимаемся до уровня узла сервера и пробегаемся по папкам.

Момент 3. Подсветка синтаксиса.

Скрипты SQLSearch выводит в стандартный RichEdit. Очень хотелось накрыть его сверху редактором от самой студии (случайная ссылка ^[11] для ключевых слов), практически получилось, но не хватило терпения расследовать и устранять всяческие мелкие неурядицы.
В итоге пошел по пути наименьшего сопротивления, спрятав его за своим RichEdit'ом и вспомнив о существовании Microsoft.SqlServer.SqlParser.Parser и, для скорости, формируя RTF ^[12] ручками.

Момент 4. Хочу красивую иконку в меню Tools!

Как это ни смешно, но если в выпадающих контекстных меню это делается без проблем, то в данном случае информации не нашел, пришлось повозиться — обратиться к System.Windows.Forms.AxHost, IPictureDisp и колдовать с масками.

Момент 5. Хочу поиск regexp'ами!

Поначалу опечалился, так как не видел способа сделать это без модификации самого SQLSearch'а, но потом нашлось решение.
SQLSearch для кэширования данных использует SQLite и .NET обертку для него System.Data.SQLite ^[13], загрузка библиотеки фактически происходит в момент, когда мы начинаем поиск. Но так как мы находимся в одном домене и отлавливаем окно еще до начала поиска, то можем быстренько загрузить свою библиотеку SQLite. Скачиваем исходники System.Data.SQLite, убеждаемся в соответствии номера версии и ключа тому, что использует сам SQLSearch, и модифицируем System.Data.SQLite.SQLiteCommand, отлавливая sql запросы и изменяя нужные.
Реализация самого поиска regexp'ами оказалась проста — достаточно в своей библиотеке реализовать класс, пометив его атрибутом SQLiteFunction — SQLite REGEXP function ^[14], после чего можем писать всякие штуки вроде select * from table where text REGEXP '.*GOODZ'

Момент 6. Получение скриптов объектов.

Все просто — выручает Microsoft.SqlServer.Management.Smo

В планах, just4fun, хочется декомпилировать и показывать исходники CLR UDF, используя родственный .NET Reflector ^[15], но пока с этим проблемы, связанные с тем, что

• сам addin должен использовать версию .NET Framework не старше, чем 3.5 (требование SSMS), а .NET Reflector нонеча под 4.0. (обходим через COM...)
• нельзя из .NET вызывать COM объект, писанный под .NET-ом (обходится...)
• и после того, как все это было побеждено и работало в тестовой версии, при запуске из SSMS падает с COM error 8004003.

Писалось под MS Visual Studio 2010, .NET framework 3.5 и тестировалось под Microsoft SQL Server Management Studio 10.0.1600.22 (SQL Server 2008R2)

Сами исходники пока не выкладываю, но библиотечка ничем не закрыта, объем кода небольшой и, при наличии рефлектора, любой желающий реализацию может посмотреть.

Ссылки:

Скачать ^[16]
Страничка SQLSearchExtender ^[4] на лицокнига
«Обсуждение» на форуме SQLTreeO ^[17]

Автор: yar229