GlideStringUtil - Scoped, Global

The GlideStringUtil API provides string handling methods.

Access these methods using the static object GlideStringUtil. This class is available in scoped and global scripts.

Parent Topic:Server API reference

GlideStringUtil - dotToUnderBar(String sourceString)

Replaces periods with underscore characters.

var filename="../../../../../../etc/passwd";
cleanFilename=GlideStringUtil.dotToUnderBar(filename);
gs.info(cleanFilename);

Output:

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

GlideStringUtil - escapeAllQuotes(String sourceString)

Removes quotes from a string.

mystring="let's escape some quotes";
escapeQuote=GlideStringUtil.escapeAllQuotes(mystring);
gs.info(escapeQuote);

Output:

lets escape some quotes

GlideStringUtil - escapeForHomePage(String sourceString)

Replaces problem characters with escape characters.

mystring="<test> string \n to escape";
escapedString=GlideStringUtil.escapeForHomePage(mystring);
gs.info(escapedString);

Output:

%3ctest%3e string \n to escape

GlideStringUtil - escapeHTML(String htmlString)

Replaces illegal characters with their escape codes.

Using this method removes illegal characters that might cause the UI to render improperly, or trigger a client side attack such as JavaScript or HTML injection.

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

Output:

"<>&

GlideStringUtil - escapeNonPrintable(String sourceString)

Replaces non-printable characters with their printable notation.

mystring="test \x09 non \x00 printable \x07 chars";
escapedString=GlideStringUtil.escapeNonPrintable(mystring);
gs.info(escapedString);

Output:

test \t non \u0000 printable \u0007 chars

GlideStringUtil - escapeQueryTermSeparator(String sourceString)

Replaces query term separators "^" with their escape sequence "^^".

myquery="test^Test";
escapedQuery=GlideStringUtil.escapeQueryTermSeparator(myquery);
gs.info(escapedQuery);

Output:

test^^Test

GlideStringUtil - escapeTicks(String sourceString)

Replaces quotes with escape characters by adding a backslash before each quote.

mystring="let's try escapeTicks";
escaped=GlideStringUtil.escapeTicks(mystring);
gs.info(escaped); 

Output:

let\'s try escapeTicks

GlideStringUtil - getHTMLValue(String sourceString)

Replaces illegal HTML characters into HTML notation.

Using this method removes illegal characters that might cause the UI to render improperly, or trigger a client side attack such as JavaScript or HTML injection.

mydata='&';
htmlvalue=GlideStringUtil.getHTMLValue(mydata);
gs.info(htmlvalue);

Output:

&

GlideStringUtil - getNumeric(String sourceString)

Extracts numeric characters from a string.

mystring='123 test 456 String 789 cleaning';
onlyNumeric=GlideStringUtil.getNumeric(mystring);
gs.info(onlyNumeric); 

Output:

123456789

GlideStringUtil - isBase64(String sourceString)

Validates whether the specified string is a valid base64 string.

//(adding a "*" to corrupt the base64 format)
base64="GethdTYehdtshetB*";
isValid=GlideStringUtil.isBase64(base64);
gs.info(isValid);

Output:

false

GlideStringUtil - isEligibleSysID(String sourceString)

Validates whether the specified string is in valid sys_id format.

The sys_id format is a sequence of 32 hexadecimal characters where all the characters are in the range [0-9, a-f, A-F].

sysID="62826bf03710200044e0bfc8bcbe5df1";
isElig=GlideStringUtil.isEligibleSysID(sysID);
gs.info(isElig);

Output:

true

GlideStringUtil - newLinesToBreaks(String sourceString)

Replaces the new line character, /n, with a break code, <br/>.

mystring="new line break \n, this is after the break";
replaceNewLine=GlideStringUtil.newLinesToBreaks(mystring);
gs.info(replaceNewLine); 

Output:

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

GlideStringUtil - normalizeWhitespace(String sourceString)

Replaces carriage returns, line feeds, and tabs with spaces, and then removes leading, trailing, and duplicate spaces.

mystring="test with \n (new line) and \t (tabulation)";
normalizedString=GlideStringUtil.normalizeWhitespace(mystring);
gs.info(normalizedString);

Output:

test with (new line) and (tabulation)

GlideStringUtil - unEscapeHTML(String htmlString)

Replaces escape characters with their respective character.

This method replaces these escape characters: < &gt:   & &quote;.

Note: In scoped applications call this method as unescapeHTML(String). In global applications call this method as unEscapeHTML(String).

This code example shows the method being called in a global application.

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

Output:

"<>&

This code example shows the method being called in a scoped application.

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

Output:

"<>&

GlideStringUtil - urlEncode(String url)

Encodes non-ASCII characters, unsafe ASCII characters, and spaces so you can use the returned string on the Internet. Uses UTF-8 encoding. Uses percent (%) encoding.

Note: Only available in global scope.

var mystring='Test characters: " < > & &quot; &lt; &gt; &amp;';
escapedString=GlideStringUtil.urlEncode(mystring);
gs.info(escapedString);

Output:

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