GlideStringUtil : champ d’application, global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture
  • L’API GlideStringUtil fournit des méthodes de gestion des chaînes.

    Accédez à ces méthodes à l’aide de l’objet statique GlideStringUtil. Cette classe est disponible dans les scripts étendus et globaux.

    GlideStringUtil : dotToUnderBar(String sourceString)

    Remplace les points par des traits de soulignement.

    Tableau 1. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 2. Renvoie
    Type Description
    Chaîne Le texte avec des points a été remplacé par des traits de soulignement.
    var filename="../../../../../../etc/passwd";
    cleanFilename=GlideStringUtil.dotToUnderBar(filename);
    gs.info(cleanFilename);

    Sortie :

     __/__/__/__/__/__/etc/passwd

    GlideStringUtil : escapeAllQuotes(String sourceString)

    Supprime les guillemets d’une chaîne.

    Tableau 3. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Chaîne à traiter.
    Tableau 4. Renvoie
    Type Description
    Chaîne Chaîne avec guillemets supprimés.
    mystring="let's escape some quotes";
    escapeQuote=GlideStringUtil.escapeAllQuotes(mystring);
    gs.info(escapeQuote);

    Sortie :

    lets escape some quotes

    GlideStringUtil : escapeForHomePage(String sourceString)

    Remplace les caractères problématiques par des caractères d’échappement.

    Tableau 5. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 6. Renvoie
    Type Description
    Chaîne Le texte comportant des caractères problématiques a été remplacé par des caractères d’échappement.
    mystring="<test> string \n to escape";
    escapedString=GlideStringUtil.escapeForHomePage(mystring);
    gs.info(escapedString);

    Sortie :

    %3ctest%3e string \n to escape

    GlideStringUtil : escapeHTML(String htmlString)

    Remplace les caractères illégaux par leurs codes d’échappement.

    Cette méthode supprime les caractères illégaux susceptibles d’entraîner un mauvais rendu de l’interface utilisateur ou de déclencher une attaque côté client telle que JavaScript ou une injection HTML.

    Tableau 7. Paramètres
    Nom Type Description
    Chaîne HTML Chaîne Texte à traiter.
    Tableau 8. Renvoie
    Type Description
    Chaîne Le texte contenant des caractères illégaux a été remplacé par leur code d’échappement.
    mydata='"<>&';
    mydata=GlideStringUtil.escapeHTML(mydata);
    gs.info(mydata);

    Sortie :

    "<>&

    GlideStringUtil : escapeNonPrintable(String sourceString)

    Remplace les caractères non imprimables par leur notation imprimable.

    Tableau 9. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 10. Renvoie
    Type Description
    Chaîne Le texte avec des caractères non imprimables est remplacé par une notation imprimable.
    mystring="test \x09 non \x00 printable \x07 chars";
    escapedString=GlideStringUtil.escapeNonPrintable(mystring);
    gs.info(escapedString);

    Sortie :

    test \t non \u0000 printable \u0007 chars

    GlideStringUtil : escapeQueryTermSeparator(String sourceString)

    Remplace les séparateurs de termes de requête « ^ » par leur séquence d’échappement « ^^ ».

    Tableau 11. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 12. Renvoie
    Type Description
    Chaîne Le texte contenant des séparateurs de termes de requête a été remplacé par des caractères d’échappement.
    myquery="test^Test";
    escapedQuery=GlideStringUtil.escapeQueryTermSeparator(myquery);
    gs.info(escapedQuery);

    Sortie :

    test^^Test

    GlideStringUtil : escapeTicks(String sourceString)

    Remplace les guillemets par des caractères d’échappement en ajoutant une barre oblique inverse avant chaque guillemet.

    Tableau 13. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 14. Renvoie
    Type Description
    Chaîne Texte avec barres obliques inverses ajoutées avant les guillemets.
    mystring="let's try escapeTicks";
    escaped=GlideStringUtil.escapeTicks(mystring);
    gs.info(escaped); 

    Sortie :

    let\'s try escapeTicks

    GlideStringUtil : getHTMLValue(String sourceString)

    Remplace les caractères HTML illégaux dans la notation HTML.

    Cette méthode supprime les caractères illégaux susceptibles d’entraîner un mauvais rendu de l’interface utilisateur ou de déclencher une attaque côté client telle que JavaScript ou une injection HTML.

    Tableau 15. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 16. Renvoie
    Type Description
    Chaîne Le texte contenant des caractères illégaux est remplacé par une notation HTML.
    mydata='&';
    htmlvalue=GlideStringUtil.getHTMLValue(mydata);
    gs.info(htmlvalue);

    Sortie :

    &

    GlideStringUtil : getNumeric(String sourceString)

    Extrait les caractères numériques d’une chaîne.

    Tableau 17. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 18. Renvoie
    Type Description
    Chaîne Texte ne contenant que des chiffres.
    mystring='123 test 456 String 789 cleaning';
    onlyNumeric=GlideStringUtil.getNumeric(mystring);
    gs.info(onlyNumeric); 

    Sortie :

    123456789

    GlideStringUtil : isBase64(String sourceString)

    Valide si la chaîne spécifiée est une chaîne base64 valide.

    Tableau 19. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 20. Renvoie
    Type Description
    Booléen Marqueur indiquant si la chaîne spécifiée est au format base64 valide.
    Valeurs possibles :
    • vrai : chaîne formatée base64 valide.
    • false : chaîne formatée base64 non valide.
    //(adding a "*" to corrupt the base64 format)
    base64="GethdTYehdtshetB*";
    isValid=GlideStringUtil.isBase64(base64);
    gs.info(isValid);

    Sortie :

    false

    GlideStringUtil : isEligibleSysID(String sourceString)

    Valide si la chaîne spécifiée est au format sys_id valide.

    Le format sys_id est une séquence de 32 caractères hexadécimaux où tous les caractères sont dans la plage [0-9, a-f, A-F].

    Tableau 21. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 22. Renvoie
    Type Description
    Booléen Marqueur indiquant si la chaîne spécifiée est au format sys_id valide.
    Valeurs possibles :
    • vrai : valide sys_id chaîne formatée.
    • false : chaîne formatée sys_id non valide.
    sysID="62826bf03710200044e0bfc8bcbe5df1";
    isElig=GlideStringUtil.isEligibleSysID(sysID);
    gs.info(isElig);

    Sortie :

    true

    GlideStringUtil : newLinesToBreaks(String sourceString)

    Remplace le nouveau caractère de ligne, /n, par un code de coupure, <br/>.

    Tableau 23. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 24. Renvoie
    Type Description
    Chaîne Le texte avec des caractères de nouvelle ligne est remplacé par un code de rupture HTML.
    mystring="new line break \n, this is after the break";
    replaceNewLine=GlideStringUtil.newLinesToBreaks(mystring);
    gs.info(replaceNewLine); 

    Sortie :

    new line break <br/>, this is after the break

    GlideStringUtil : normalizeWhitespace(String sourceString)

    Remplace les retours chariot, les sauts de ligne et les tabulations par des espaces, puis supprime les espaces de début, de fin et de doublon.

    Tableau 25. Paramètres
    Nom Type Description
    sourceString (en anglais seulement) Chaîne Texte à traiter.
    Tableau 26. Renvoie
    Type Description
    Chaîne Le texte avec des retours chariot, des sauts de ligne et des tabulations a été remplacé par des espaces, puis les espaces de début, de fin et de doublon ont été supprimés.
    mystring="test with \n (new line) and \t (tabulation)";
    normalizedString=GlideStringUtil.normalizeWhitespace(mystring);
    gs.info(normalizedString);

    Sortie :

    test with (new line) and (tabulation)

    GlideStringUtil - unEscapeHTML(String htmlString)

    Remplace les caractères d’échappement par leur caractère respectif.

    Cette méthode remplace les caractères d’échappement suivants : < > & & &quote ;.

    Remarque :
    Dans les applications incluses dans le périmètre, appelez cette méthode en tant que unescapeHTML(String). Dans les applications globales, appelez cette méthode en tant que unEscapeHTML(String).
    Tableau 27. Paramètres
    Nom Type Description
    Chaîne HTML Chaîne Chaîne à traiter.
    Tableau 28. Renvoie
    Type Description
    Chaîne Chaîne avec les caractères d’échappement remplacés.

    Cet exemple de code montre la méthode appelée dans une application globale.

    mydata='"<>&';
    unescaped=GlideStringUtil.unEscapeHTML(mydata);
    gs.info(unescaped);

    Sortie :

    "<>&

    Cet exemple de code montre la méthode appelée dans une application incluse dans le périmètre.

    mydata='"<>&';
    unescaped=GlideStringUtil.unescapeHTML(mydata);
    gs.info(unescaped);

    Sortie :

    "<>&

    GlideStringUtil : urlEncode(String url)

    Encode les caractères non-ASCII, les caractères ASCII non sécurisés et les espaces afin que vous puissiez utiliser la chaîne renvoyée sur Internet. Utilise l’encodage UTF-8. Utilise l’encodage de pourcentage (%).

    Remarque :
    Disponible uniquement dans le champ d’application global.
    Tableau 29. Paramètres
    Nom Type Description
    URL Chaîne Chaîne à coder.
    Tableau 30. Renvoie
    Type Description
    Chaîne Chaîne avec des caractères non ASCII, des caractères ASCII non sécurisés et des espaces codés.
    var mystring='Test characters: " < > & " < > &';
    escapedString=GlideStringUtil.urlEncode(mystring);
    gs.info(escapedString);

    Sortie :

    Test+characters%3A+%22+%3C+%3E+%26+%26quot%3B+%26lt%3B+%26gt%3B+%26amp%3B