core/templates/services/validators.service.ts - develop - githubmirror/oppia

core/templates/services/validators.service.ts
152 строки4 KB
Kartik Suryavanshi
Refactored SkillObjectFactory to skill.model (#22912)
11 авг 2025, 21:46
11 авг 2025, 21:46acd67ce
// Copyright 2014 The Oppia Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @fileoverview Service for validating things and (optionally) displaying
 * warning messages if the validation fails.
 */

import {Injectable} from '@angular/core';

import {AlertsService} from 'services/alerts.service';
import {AppConstants} from 'app.constants';
import {NormalizeWhitespacePipe} from 'filters/string-utility-filters/normalize-whitespace.pipe';

@Injectable({
  providedIn: 'root',
})
export class ValidatorsService {
  constructor(
    private alerts: AlertsService,
    private whitespacefilter: NormalizeWhitespacePipe
  ) {}

  /**
   * Checks whether an entity name is valid, and displays a warning message
   * if it isn't.
   * @param {string} input - The input to be checked.
   * @param {boolean} showWarnings - Whether to show warnings in the
   *   butterbar.
   * @return {boolean} True if the entity name is valid, false otherwise.
   */
  isValidEntityName(
    input: string,
    showWarnings: boolean,
    allowEmpty: boolean
  ): boolean {
    input = this.whitespacefilter.transform(input);
    if (!input && !allowEmpty) {
      if (showWarnings) {
        this.alerts.addWarning('Please enter a non-empty name.');
      }
      return false;
    }
    for (var i = 0; i < AppConstants.INVALID_NAME_CHARS.length; i++) {
      if (input.indexOf(AppConstants.INVALID_NAME_CHARS[i]) !== -1) {
        if (showWarnings) {
          this.alerts.addWarning(
            'Invalid input. Please use a non-empty description ' +
              'consisting of alphanumeric characters, spaces and/or hyphens.'
          );
        }
        return false;
      }
    }
    return true;
  }

  isValidExplorationTitle(input: string, showWarnings: boolean): boolean {
    if (!this.isValidEntityName(input, showWarnings, false)) {
      return false;
    }

    if (input.length > 40) {
      if (showWarnings) {
        this.alerts.addWarning(
          'Exploration titles should be at most 40 characters long.'
        );
      }
      return false;
    }

    return true;
  }

  // NB: this does not check whether the card name already exists in the
  // states dict.
  isValidStateName(input: string, showWarnings: boolean): boolean {
    if (!this.isValidEntityName(input, showWarnings, false)) {
      return false;
    }

    if (input.length > 50) {
      if (showWarnings) {
        this.alerts.addWarning(
          'Card names should be at most 50 characters long.'
        );
      }
      return false;
    }

    return true;
  }

  isNonempty(input: string, showWarnings: boolean): boolean {
    if (!input) {
      if (showWarnings) {
        // TODO(#20336): Allow this warning to be more specific in terms of
        // what needs to be entered.
        this.alerts.addWarning('Please enter a non-empty value.');
      }
      return false;
    }
    return true;
  }

  isValidExplorationId(input: string, showWarnings: boolean): boolean {
    // Exploration IDs are urlsafe base64-encoded.
    var VALID_ID_CHARS_REGEX = /^[a-zA-Z0-9_\-]+$/g;
    if (!input || !VALID_ID_CHARS_REGEX.test(input)) {
      if (showWarnings) {
        this.alerts.addWarning('Please enter a valid exploration ID.');
      }
      return false;
    }
    return true;
  }

  hasValidDescription(description: string): boolean {
    var allowDescriptionToBeBlank = false;
    return this.isValidEntityName(
      description,
      false,
      allowDescriptionToBeBlank
    );
  }

  isValidReviewMessage(input: string, showWarnings: boolean): boolean {
    if (!input) {
      return true;
    }
    if (input.length > AppConstants.MAX_REVIEW_MESSAGE_LENGTH && showWarnings) {
      this.alerts.addWarning(
        'Review message should be at most ' +
          AppConstants.MAX_REVIEW_MESSAGE_LENGTH +
          ' characters long.'
      );
      return false;
    }
    return true;
  }
}