Границы обращения к метаданным

docs/diagnostics/MetadataBorders.md

@@ -0,0 +1,75 @@
+# Границы метаданных (MetadataBorders)
+
+|      Тип      |    Поддерживаются<br>языки    |     Важность     |    Включена<br>по умолчанию    |    Время на<br>исправление (мин)    |  Теги   |
+|:-------------:|:-----------------------------:|:----------------:|:------------------------------:|:-----------------------------------:|:-------:|
+| `Дефект кода` |         `BSL`<br>`OS`         | `Информационный` |             `Нет`              |                 `1`                 | `error` |
+
+## Параметры
+
+
+|             Имя             |   Тип    |                                                                                         Описание                                                                                          |    Значение<br>по умолчанию    |
+|:---------------------------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------:|
+| `metadataBordersParameters` | `Строка` | `JSON-структура для пар "регулярное выражение для операторов":"регулярное выражение для имени модуля". Например, "Регистры?Сведений.КонтактнаяИнформация:ОбщийМодуль.РаботаСКонтактами".` |               ``               |
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Описание диагностики
+Диагностика обращения к метаданным за пределами разрешенных границ.
+Нужна, если, например, в компании установлены правила обращения
+к каким-то метаданным только из определенного общего модуля.
+
+## Примеры
+Например, получение контактной информации по внутренним правилам должно происходить 
+только через функции общего модуля РаботаСКонтактами.
+Тогда заданные настройки вида
+
+```{"Регистры?Сведений.КонтактнаяИнформация":"CommonModules/РаботаСКонтактами"}```
+
+вызовут срабатывание диагностики на запросе с текстом
+
+```
+"ВЫБРАТЬ
+    ...
+ИЗ
+    РегистрСведений.КонтактнаяИнформация КАК КИ"
+```
+
+если этот запрос будет не в общем модуле РаботаСКонтактами.
+
+Так же эта диагностика с такой настройкой сработает и на оператор
+
+```НаборЗаписей = РегистрыСведений.ИспользованиеКонтактов.СоздатьНаборЗаписей();```
+
+В настройках обе части - это регулярные выражения java.
+Вторая часть настройки сравнивается с путем к файлу выгрузки конфигурации.
+
+Можно запретить использование нескольких метаданных:
+
+```{"Регистры?Сведений.КонтактнаяИнформация|Справочники?.Контакты":"CommonModules/РаботаСКонтактами"}```
+
+Настройки задаются в виде json-строки:
+```
+{ 
+   "Регистры?Сведений.КонтактнаяИнформация":"CommonModules/РаботаСКонтактами",
+   "Справочники?.СтрокиСоединения":"DataProcessors/ВнешниеСоединения|CommonModules/ПодключениеК*"
+}
+```
+
+
+## Источники
+
+## Сниппеты
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Экранирование кода
+
+```bsl
+// BSLLS:MetadataBorders-off
+// BSLLS:MetadataBorders-on
+```
+
+### Параметр конфигурационного файла
+
+```json
+"MetadataBorders": {
+    "metadataBordersParameters": ""
+}
+```

docs/diagnostics/index.md

@@ -8,12 +8,12 @@
 
 ## Список реализованных диагностик
 
-Общее количество: **145**
+Общее количество: **146**
 
 * Потенциальная уязвимость: **4**
 * Уязвимость: **4**
 * Ошибка: **44**
-* Дефект кода: **93**
+* Дефект кода: **94**
 
 
 | Ключ | Название | Включена по умолчанию | Важность | Тип | Тэги |
@@ -91,6 +91,7 @@
  [LogicalOrInTheWhereSectionOfQuery](LogicalOrInTheWhereSectionOfQuery.md) | Использование логического "ИЛИ" в секции "ГДЕ" запроса | Да | Важный | Дефект кода | `sql`<br>`performance`<br>`standard` 
  [MagicDate](MagicDate.md) | Магические даты | Да | Незначительный | Дефект кода | `badpractice`<br>`brainoverload` 
  [MagicNumber](MagicNumber.md) | Магические числа | Да | Незначительный | Дефект кода | `badpractice` 
+ [MetadataBorders](MetadataBorders.md) | Границы метаданных | Да | Информационный | Дефект кода | `error` 
  [MetadataObjectNameLength](MetadataObjectNameLength.md) | Имена объектов метаданных не должны превышать допустимой длины наименования | Да | Важный | Ошибка | `standard` 
  [MethodSize](MethodSize.md) | Ограничение на размер метода | Да | Важный | Дефект кода | `badpractice` 
  [MissingCodeTryCatchEx](MissingCodeTryCatchEx.md) | Конструкция "Попытка...Исключение...КонецПопытки" не содержит кода в исключении | Да | Важный | Ошибка | `standard`<br>`badpractice` 

docs/en/diagnostics/MetadataBorders.md

@@ -0,0 +1,44 @@
+# Metadata borders (MetadataBorders)
+
+|     Type     |        Scope        | Severity |    Activated<br>by default    |    Minutes<br>to fix    |  Tags   |
+|:------------:|:-------------------:|:--------:|:-----------------------------:|:-----------------------:|:-------:|
+| `Code smell` |    `BSL`<br>`OS`    |  `Info`  |             `No`              |           `1`           | `error` |
+
+## Parameters
+
+
+|            Name             |   Type   |                                                                    Description                                                                    | Default value |
+|:---------------------------:|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:|
+| `metadataBordersParameters` | `String` | `JSON-structure for pairs "regex for statements":"regex for module names". Etc "InformationRegisters?.RegisterName:CommonModules/SpecialModule".` |      ``       |
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Description
+<!-- Описание диагностики заполняется вручную. Необходимо понятным языком описать смысл и схему работу -->
+
+## Examples
+<!-- В данном разделе приводятся примеры, на которые диагностика срабатывает, а также можно привести пример, как можно исправить ситуацию -->
+
+## Sources
+<!-- Необходимо указывать ссылки на все источники, из которых почерпнута информация для создания диагностики -->
+<!-- Примеры источников
+
+* Источник: [Стандарт: Тексты модулей](https://its.1c.ru/db/v8std#content:456:hdoc)
+* Полезная информация: [Отказ от использования модальных окон](https://its.1c.ru/db/metod8dev#content:5272:hdoc)
+* Источник: [Cognitive complexity, ver. 1.4](https://www.sonarsource.com/docs/CognitiveComplexity.pdf) -->
+
+## Snippets
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Diagnostic ignorance in code
+
+```bsl
+// BSLLS:MetadataBorders-off
+// BSLLS:MetadataBorders-on
+```
+
+### Parameter for config
+
+```json
+"MetadataBorders": {
+    "metadataBordersParameters": ""
+}
+```

docs/en/diagnostics/index.md

@@ -8,12 +8,12 @@ To escape individual sections of code or files from triggering diagnostics, you
 
 ## Implemented diagnostics
 
-Total: **145**
+Total: **146**
 
 * Security Hotspot: **4**
 * Vulnerability: **4**
 * Error: **44**
-* Code smell: **93**
+* Code smell: **94**
 
 
 | Key | Name| Enabled by default | Severity | Type | Tags |
@@ -91,6 +91,7 @@ Total: **145**
  [LogicalOrInTheWhereSectionOfQuery](LogicalOrInTheWhereSectionOfQuery.md) | Using a logical "OR" in the "WHERE" section of a query | Yes | Major | Code smell | `sql`<br>`performance`<br>`standard` 
  [MagicDate](MagicDate.md) | Magic dates | Yes | Minor | Code smell | `badpractice`<br>`brainoverload` 
  [MagicNumber](MagicNumber.md) | Magic numbers | Yes | Minor | Code smell | `badpractice` 
+ [MetadataBorders](MetadataBorders.md) | Metadata borders | Yes | Info | Code smell | `error` 
  [MetadataObjectNameLength](MetadataObjectNameLength.md) | Metadata object names must not exceed the allowed length | Yes | Major | Error | `standard` 
  [MethodSize](MethodSize.md) | Method size | Yes | Major | Code smell | `badpractice` 
  [MissingCodeTryCatchEx](MissingCodeTryCatchEx.md) | Missing code in Raise block in "Try ... Raise ... EndTry" | Yes | Major | Error | `standard`<br>`badpractice` 

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

@@ -0,0 +1,101 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2021
+ * Alexey Sosnoviy <[email protected]>, Nikita Gryzlov <[email protected]> and contributors
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * BSL Language Server is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * BSL Language Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with BSL Language Server.
+ */
+package com.github._1c_syntax.bsl.languageserver.diagnostics;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.type.MapType;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticParameter;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticSeverity;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticTag;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticType;
+import com.github._1c_syntax.bsl.parser.BSLParser;
+import com.github._1c_syntax.utils.CaseInsensitivePattern;
+import org.antlr.v4.runtime.tree.ParseTree;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+@DiagnosticMetadata(
+  type = DiagnosticType.CODE_SMELL,
+  severity = DiagnosticSeverity.INFO,
+  minutesToFix = 1,
+  activatedByDefault = false,
+  tags = {
+    DiagnosticTag.DESIGN
+  }
+
+)
+public class MetadataBordersDiagnostic extends AbstractVisitorDiagnostic {
+
+  private static final String METADATA_BORDERS_DEFAULT = "";
+
+  @DiagnosticParameter(
+    type = String.class,
+    defaultValue = ""
+  )
+  private Map<Pattern, Pattern> metadataBordersParameters = MapFromJSON(METADATA_BORDERS_DEFAULT);
+
+  private static Map<Pattern, Pattern> MapFromJSON(String userSettings) {
+    ObjectMapper mapper = new ObjectMapper();
+    MapType mapType = mapper.getTypeFactory().constructMapType(HashMap.class, String.class, String.class);
+    try {
+      Map<String, String> stringMap = mapper.readValue(userSettings, mapType);
+      return stringMap.entrySet().stream()
+        .filter(entry -> ! entry.getKey().isBlank() && ! entry.getValue().isBlank())
+        .collect(Collectors.toMap(
+            entry -> CaseInsensitivePattern.compile(entry.getKey()),
+            entry -> CaseInsensitivePattern.compile(entry.getValue())));
+    } catch (JsonProcessingException e) {
+      return Collections.emptyMap();
+    }
+  }
+
+  @Override
+  public void configure(Map<String, Object> configuration) {
+    this.metadataBordersParameters = MapFromJSON(
+              (String) configuration.getOrDefault("metadataBordersParameters", METADATA_BORDERS_DEFAULT));
+  }
+
+  @Override
+  public ParseTree visitStatement(BSLParser.StatementContext ctx){
+
+    for (Map.Entry<Pattern, Pattern> entry: metadataBordersParameters.entrySet()) {
+
+      boolean insideBorders = entry.getValue().matcher(this.documentContext.getUri().getPath()).find();
+
+      if (! insideBorders) {
+
+        Matcher matcher = entry.getKey().matcher(ctx.getText());
+        while (matcher.find()) {
+          diagnosticStorage.addDiagnostic(ctx);
+        }
+      }
+    }
+    return super.visitStatement(ctx);
+  }
+}

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json

@@ -38,6 +38,24 @@
             "title": "Assigning aliases to selected fields in a query",
             "$id": "#/definitions/AssignAliasFieldsInQuery"
         },
+        "BadWords": {
+            "description": "Prohibited words",
+            "default": true,
+            "type": [
+                "boolean",
+                "object"
+            ],
+            "title": "Prohibited words",
+            "properties": {
+                "badWords": {
+                    "description": "Regular expression for prohibited words. Ex.: \"badWord1|badWord2\".",
+                    "default": "",
+                    "type": "string",
+                    "title": "Regular expression for prohibited words. Ex.: \"badWord1|badWord2\"."
+                }
+            },
+            "$id": "#/definitions/BadWords"
+        },
         "BeginTransactionBeforeTryCatch": {
             "description": "Violating transaction rules for the 'BeginTransaction' method",
             "default": true,
@@ -924,6 +942,24 @@
             },
             "$id": "#/definitions/MagicNumber"
         },
+        "MetadataBorders": {
+            "description": "Metadata borders",
+            "default": true,
+            "type": [
+                "boolean",
+                "object"
+            ],
+            "title": "Metadata borders",
+            "properties": {
+                "metadataBordersParameters": {
+                    "description": "JSON-structure for pairs \"regex for statements\":\"regex for module names\". Etc \"InformationRegisters?.RegisterName:CommonModules/SpecialModule\".",
+                    "default": "",
+                    "type": "string",
+                    "title": "JSON-structure for pairs \"regex for statements\":\"regex for module names\". Etc \"InformationRegisters?.RegisterName:CommonModules/SpecialModule\"."
+                }
+            },
+            "$id": "#/definitions/MetadataBorders"
+        },
         "MetadataObjectNameLength": {
             "description": "Metadata object names must not exceed the allowed length",
             "default": true,

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/schema.json

@@ -29,6 +29,9 @@
                 "AssignAliasFieldsInQuery": {
                     "$ref": "parameters-schema.json#/definitions/AssignAliasFieldsInQuery"
                 },
+                "BadWords": {
+                    "$ref": "parameters-schema.json#/definitions/BadWords"
+                },
                 "BeginTransactionBeforeTryCatch": {
                     "$ref": "parameters-schema.json#/definitions/BeginTransactionBeforeTryCatch"
                 },
@@ -242,6 +245,9 @@
                 "MagicNumber": {
                     "$ref": "parameters-schema.json#/definitions/MagicNumber"
                 },
+                "MetadataBorders": {
+                    "$ref": "parameters-schema.json#/definitions/MetadataBorders"
+                },
                 "MetadataObjectNameLength": {
                     "$ref": "parameters-schema.json#/definitions/MetadataObjectNameLength"
                 },

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic_en.properties

@@ -0,0 +1,4 @@
+diagnosticMessage=Use metadata outside the borders
+diagnosticName=Metadata borders
+metadataBordersParameters=JSON-structure for pairs "regex for statements":"regex for module names". Etc "InformationRegisters?.RegisterName:CommonModules/SpecialModule".
+

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic_ru.properties

@@ -0,0 +1,3 @@
+diagnosticMessage=Обращение к метаданным за пределами разрешенных границ
+diagnosticName=Границы метаданных
+metadataBordersParameters=JSON-структура для пар "регулярное выражение для операторов":"регулярное выражение для имени модуля". Например, "Регистры?Сведений.КонтактнаяИнформация:ОбщийМодуль.РаботаСКонтактами".