Как обнаружить ошибки форматирования строк в коде Delphi и Pascal с помощью статического анализа.

Delphi , Синтаксис , Текст и Строки

В разработке программного обеспечения на Delphi и Pascal нередко приходится сталкиваться с форматированием строк. Использование функций Format, Exception.CreateFmt и подобных позволяет динамически создавать строки, подставляя в них значения переменных. Однако, неправильное использование этих функций может привести к ошибкам во время выполнения программы, особенно если строка формата формируется динамически и содержит нежелательные символы форматирования.

Проблема:

Как отмечает David Heffernan, распространенной ошибкой является использование динамически формируемой строки в качестве строки формата, особенно когда эта строка содержит символы, которые могут быть интерпретированы как placeholders для форматирования.

msg := Format('%s' + foo, [bar]); // Опасно, если foo содержит '%s', '%20' и т.д.

В данном примере, если переменная foo содержит символы форматирования (например, %s, %d), функция Format попытается интерпретировать их, что приведет к исключению, если количество и типы аргументов не соответствуют.

Решение:

David Heffernan предлагает искать инструмент статического анализа, который бы обнаруживал вызовы функций Format (и подобных), где строка формата не является литералом. Он подчеркивает, что не ищет инструмент, который "компилирует" код и вычисляет содержимое переменной foo, а именно инструмент статического анализа, который обнаруживает не-литеральные аргументы.

Альтернативные подходы и их ограничения:

• Regex (Регулярные выражения): Rollo62 предлагает использовать регулярные выражения для поиска потенциально проблемных мест. Это может быть полезным быстрым решением, но оно имеет ряд ограничений:

  • Сложность синтаксиса Pascal: Регулярные выражения могут быть сложными для написания и поддержки, особенно если необходимо учитывать особенности синтаксиса Pascal, такие как многострочные выражения, комментарии и т.д.
  • Ложные срабатывания: Регулярные выражения могут выдавать ложные срабатывания, если строка, похожая на вызов Format, встречается в комментарии или строковом литерале.
  • Неполный анализ: Регулярные выражения не могут выполнить полноценный семантический анализ кода, поэтому они не смогут определить, действительно ли переменная, используемая в качестве строки формата, может содержать символы форматирования.

• Простой текстовый поиск (пример Kryvich): Пример кода, предложенный Kryvich, демонстрирует базовый подход к поиску строк, содержащих Format( и ]) с проверкой наличия символа + перед запятой. Этот подход крайне примитивен и имеет множество недостатков:

  • Не обрабатывает многострочный код: Как справедливо заметил David Heffernan, код не обрабатывает случаи, когда вызов Format разбит на несколько строк.
  • Не учитывает вложенность: Не учитывает вложенные вызовы функций или использование Format внутри других строковых операций.
  • Высокая вероятность ложных срабатываний: Очень высокая вероятность ложных срабатываний, так как ищется просто наличие определенных символов в строке.

• Замена/Мокирование Format: Rollo62 также предлагает заменить или мокировать функцию Format для перехвата и логирования ошибок. Это может быть полезно для обнаружения проблем во время выполнения программы, но не решает проблему статического анализа.

• Copilot (AI-помощник): Kryvich предлагает использовать Copilot для решения задачи. Хотя AI-помощники могут быть полезны, они не гарантируют 100% точности и требуют тщательной проверки результатов.

Решение на основе парсера Pascal:

Наиболее надежным и точным решением является использование полноценного парсера Pascal. Парсер позволит выполнить синтаксический и семантический анализ кода, что позволит точно определить места, где функция Format вызывается с не-литеральной строкой формата.

Пример реализации (концепция):

К сожалению, создание полноценного парсера Pascal выходит за рамки данной статьи. Однако, можно описать концепцию реализации подобного инструмента:

1. Использование существующего парсера: Существуют библиотеки и инструменты для парсинга кода Pascal, например, основанные на компиляторе Delphi.
2. Поиск вызовов Format и подобных: После парсинга кода необходимо найти все вызовы функций Format, Exception.CreateFmt и других, использующих строку формата и массив аргументов.

3. Анализ аргумента строки формата: Для каждого найденного вызова необходимо проверить, является ли аргумент, представляющий строку формата, литералом. Это можно сделать, проверив, является ли аргумент:

   • Строковым литералом (например, 'Hello, %s!').
   • Константой, содержащей строковый литерал.

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

Пример кода (псевдокод):

// Псевдокод, демонстрирующий концепцию
procedure AnalyzeCode(Code: string);
var
  ParsedCode: TParsedPascalCode;
  CallNodes: TList<TCallNode>;
  CallNode: TCallNode;
  FormatStringArgument: TExpressionNode;
begin
  // 1. Парсинг кода
  ParsedCode := ParsePascalCode(Code);

  // 2. Поиск вызовов Format и подобных
  CallNodes := FindFunctionCalls(ParsedCode, ['Format', 'Exception.CreateFmt']);

  // 3. Анализ аргумента строки формата
  for CallNode in CallNodes do
  begin
    FormatStringArgument := GetFormatStringArgument(CallNode);

    if not IsLiteralString(FormatStringArgument) then
    begin
      // 4. Выдача предупреждения
      ReportWarning('Потенциальная ошибка форматирования строки в ' + CallNode.Location);
    end;
  end;
end;

Альтернативное решение на основе Source Code Analyzer (SCA):

В Delphi есть встроенные инструменты для анализа исходного кода, такие как Source Code Analyzer (SCA). SCA позволяет создавать собственные правила для поиска определенных шаблонов в коде. Можно создать правило SCA, которое будет искать вызовы Format и проверять, является ли первый аргумент литералом.

Пример правила SCA (псевдокод):

<Rule Name="NonLiteralFormatString" Severity="Warning">
  <Description>Обнаружен вызов Format с не-литеральной строкой формата</Description>
  <Match>
    <FunctionCall Name="Format">
      <Argument Index="0" IsLiteral="false"/>
    </FunctionCall>
  </Match>
</Rule>

Заключение:

Обнаружение ошибок форматирования строк в Delphi и Pascal требует тщательного анализа кода. Хотя простые методы, такие как регулярные выражения, могут быть полезны для быстрого поиска, наиболее надежным решением является использование полноценного парсера Pascal или Source Code Analyzer (SCA). Эти инструменты позволяют выполнить синтаксический и семантический анализ кода, что позволяет точно определить места, где функция Format вызывается с не-литеральной строкой формата, и предотвратить потенциальные ошибки во время выполнения программы. Выбор конкретного метода зависит от сложности проекта и требований к точности анализа.

Создано по материалам из источника по ссылке.

Статья описывает проблему обнаружения ошибок форматирования строк в коде Delphi и Pascal с использованием статического анализа, предлагая решения от простых регулярных выражений до полноценного парсера Pascal или Source Code Analyzer (SCA).

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: Текст и Строки ::