com.github._1c_syntax.bsl.languageserver.diagnostics.FileSystemAccessDiagnostic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bsl-language-server Show documentation
Language Server Protocol implementation for 1C (BSL) - 1C:Enterprise 8 and OneScript languages.
The newest version!
/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2024
 * Alexey Sosnoviy , Nikita Fedkin  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.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.DiagnosticScope;
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.languageserver.utils.bsl.Constructors;
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.Map;
import java.util.regex.Pattern;

@DiagnosticMetadata(
  type = DiagnosticType.VULNERABILITY,
  severity = DiagnosticSeverity.MAJOR,
  minutesToFix = 3,
  tags = {
    DiagnosticTag.SUSPICIOUS
  },
  scope = DiagnosticScope.BSL,
  activatedByDefault = false
)
public class FileSystemAccessDiagnostic extends AbstractFindMethodDiagnostic {
  public static final String NEW_EXPRESSION = "File|Файл|xBase|HTMLWriter|ЗаписьHTML|HTMLReader|ЧтениеHTML" +
    "|FastInfosetReader|ЧтениеFastInfoset|FastInfosetWriter|ЗаписьFastInfoset|XSLTransform|ПреобразованиеXSL" +
    "|ZipFileWriter|ЗаписьZipФайла|ZipFileReader|ЧтениеZipФайла|TextReader|ЧтениеТекста|TextWriter|ЗаписьТекста" +
    "|TextExtraction|ИзвлечениеТекста|BinaryData|ДвоичныеДанные|FileStream|ФайловыйПоток" +
    "|FileStreamsManager|МенеджерФайловыхПотоков|DataWriter|ЗаписьДанных|DataReader|ЧтениеДанных";

  public static final String GLOBAL_METHODS = "ЗначениеВФайл|ValueToFile|КопироватьФайл|FileCopy" +
    "|ОбъединитьФайлы|MergeFiles|ПереместитьФайл|MoveFile|РазделитьФайл|SplitFile|СоздатьКаталог|CreateDirectory|" +
    "УдалитьФайлы|DeleteFiles|КаталогПрограммы|BinDir|КаталогВременныхФайлов|TempFilesDir" +
    "|КаталогДокументов|DocumentsDir|РабочийКаталогДанныхПользователя|UserDataWorkDir" +
    "|НачатьПодключениеРасширенияРаботыСФайлами|BeginAttachingFileSystemExtension" +
    "|НачатьУстановкуРасширенияРаботыСФайлами|BeginInstallFileSystemExtension" +
    "|УстановитьРасширениеРаботыСФайлами|InstallFileSystemExtension" +
    "|УстановитьРасширениеРаботыСФайламиАсинх|InstallFileSystemExtensionAsync" +
    "|ПодключитьРасширениеРаботыСФайламиАсинх|AttachFileSystemExtensionAsync|" +
    "КаталогВременныхФайловАсинх|TempFilesDirAsync|КаталогДокументовАсинх|DocumentsDirAsync" +
    "|НачатьПолучениеКаталогаВременныхФайлов|BeginGettingTempFilesDir" +
    "|НачатьПолучениеКаталогаДокументов|BeginGettingDocumentsDir" +
    "|НачатьПолучениеРабочегоКаталогаДанныхПользователя|BeginGettingUserDataWorkDir" +
    "|РабочийКаталогДанныхПользователяАсинх|UserDataWorkDirAsync" +
    "|КопироватьФайлАсинх|CopyFileAsync|НайтиФайлыАсинх|FindFilesAsync|НачатьКопированиеФайла|BeginCopyingFile" +
    "|НачатьПеремещениеФайла|BeginMovingFile|НачатьПоискФайлов|BeginFindingFiles" +
    "|НачатьСозданиеДвоичныхДанныхИзФайла|BeginCreateBinaryDataFromFile" +
    "|НачатьСозданиеКаталога|BeginCreatingDirectory" +
    "|НачатьУдалениеФайлов|BeginDeletingFiles|ПереместитьФайлАсинх|MoveFileAsync" +
    "|СоздатьДвоичныеДанныеИзФайлаАсинх|CreateBinaryDataFromFileAsync|СоздатьКаталогАсинх|CreateDirectoryAsync" +
    "|УдалитьФайлыАсинх|DeleteFilesAsync";
  private static final Pattern GLOBAL_METHODS_PATTERN = getPattern(GLOBAL_METHODS);

  @DiagnosticParameter(
    type = String.class,
    defaultValue = GLOBAL_METHODS
  )
  private String globalMethods = GLOBAL_METHODS;

  @DiagnosticParameter(
    type = String.class,
    defaultValue = NEW_EXPRESSION
  )
  private String newExpression = NEW_EXPRESSION;
  private Pattern newExpressionPattern = getPattern(newExpression);

  public FileSystemAccessDiagnostic() {
    super(GLOBAL_METHODS_PATTERN);
  }

  private static Pattern getPattern(String newExpression) {
    return CaseInsensitivePattern.compile(newExpression);
  }

  @Override
  public void configure(Map configuration) {
    super.configure(configuration);
    setMethodPattern(getPattern(globalMethods));
    newExpressionPattern = getPattern(newExpression);
  }

  @Override
  protected boolean checkMethodCall(BSLParser.MethodCallContext ctx) {
    return false;
  }

  @Override
  public ParseTree visitNewExpression(BSLParser.NewExpressionContext ctx) {
    Constructors.typeName(ctx).ifPresent((String typeName) -> {
      var matcherTypeName = newExpressionPattern.matcher(typeName);
      if (matcherTypeName.matches()) {
        diagnosticStorage.addDiagnostic(ctx);
      }
    });
    return super.visitNewExpression(ctx);
  }
}