org.cyclos.impl.utils

Interface RichTextHandler

public interface RichTextHandler

Contains methods to handle rich text formatting, as well as replacing image URL's with internal tags.

Author:

luis

See Also:

RichText

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	TAG_PATTERN
static java.lang.String	URL_TAG_PREFIX
static java.lang.String	URL_TAG_SEPARATOR
static java.lang.String	URL_TAG_SUFFIX

Method Summary

Modifier and Type	Method and Description
java.lang.String	applyPropertyMapping(org.cyclos.impl.contentmanagement.DataTranslationPropertyMapping propertyMapping, java.lang.String value, boolean fromClient) Apply all property mapping definitions to the translated value according if the data is received or sent to the client
void	ensureRichTextNotLost(java.lang.String html) Sanitizes the given text using the logged user's policy.
java.lang.String	escapeTags(java.lang.String text) Replaces all '<' by '< ', effectively invalidating all HTML tags
java.lang.String	replaceTagsByUrls(java.lang.String html) Replaces internal tags to URLs.
java.lang.String	replaceTagsByUrls(java.lang.String html, ConfigurationAccessor configuration) Same as replaceTagsByUrls(String) but using the root url and network of the specified accessor,
java.lang.String	replaceUrlsByTags(java.lang.String html) Replaces URLs to to internal tags.
java.lang.String	replaceUrlsByTags(java.lang.String html, ConfigurationAccessor configuration) Same as replaceUrlsByTags(String) but using the root url and network of the specified user,
java.lang.String	sanitize(java.lang.String html) Sanitizes the given HTML, removing blacklisted tags, correctly closing unclosed tags and removing leading / trailing whitespaces.
java.lang.String	unescapeTags(java.lang.String text) Replaces all '< ' by '<', reverting the result of escapeTags(String)

Field Detail

URL_TAG_PREFIX

static final java.lang.String URL_TAG_PREFIX

See Also:

Constant Field Values

URL_TAG_SEPARATOR

static final java.lang.String URL_TAG_SEPARATOR

See Also:

Constant Field Values

URL_TAG_SUFFIX

static final java.lang.String URL_TAG_SUFFIX

See Also:

Constant Field Values

TAG_PATTERN

static final java.util.regex.Pattern TAG_PATTERN

Method Detail

applyPropertyMapping

java.lang.String applyPropertyMapping(org.cyclos.impl.contentmanagement.DataTranslationPropertyMapping propertyMapping,
                                      java.lang.String value,
                                      boolean fromClient)

Apply all property mapping definitions to the translated value according if the data is received or sent to the client

ensureRichTextNotLost

void ensureRichTextNotLost(java.lang.String html)
                    throws ValidationException

Sanitizes the given text using the logged user's policy. If some text it would be lost, throws a ValidationException

Throws:

ValidationException

escapeTags

java.lang.String escapeTags(java.lang.String text)

Replaces all '<' by '< ', effectively invalidating all HTML tags

replaceTagsByUrls

java.lang.String replaceTagsByUrls(java.lang.String html)

Replaces internal tags to URLs. Should be invoked when converting a data to be sent to a client on an entity model (VO / DTO) from an entity.

See Also:

replaceUrlsByTags(String)

replaceTagsByUrls

java.lang.String replaceTagsByUrls(java.lang.String html,
                                   ConfigurationAccessor configuration)

Same as replaceTagsByUrls(String) but using the root url and network of the specified accessor,

Parameters:

configuration - If null or was obtained using SessionData.getConfiguration() then it resolve to the loggued user.

replaceUrlsByTags

java.lang.String replaceUrlsByTags(java.lang.String html)

Replaces URLs to to internal tags. Normally a call to sanitize(String) is sufficient, but there might be cases where an HTML sanitization is not needed, just the replacing of URL tags by full URLs. The following tags are handled:

• {{config:<name>}}: Configuration image URL. See ConfigurationImageType.
• {{user:<key>:<size>}}: User profile image URL. See UserImage.
• {{usercustom:<key>:size>}}: User custom image URL. See UserCustomImage.
• {{ad:<key>:size>}}: Advertisement image URL. See AdImage.
• {{systemcustom:<key>:size>}}: System custom image URL. See SystemCustomImage.

replaceUrlsByTags

java.lang.String replaceUrlsByTags(java.lang.String html,
                                   ConfigurationAccessor configuration)

Same as replaceUrlsByTags(String) but using the root url and network of the specified user,

Parameters:

configuration - If null or was obtained using SessionData.getConfiguration() then it resolve to the loggued user.

sanitize

java.lang.String sanitize(java.lang.String html)

Sanitizes the given HTML, removing blacklisted tags, correctly closing unclosed tags and removing leading / trailing whitespaces. Administrators are allowed to use iframes and forms, but not regular users. Scripts and style tags are forbidden. Null inputs, as well as empty strings, results in null.

unescapeTags

java.lang.String unescapeTags(java.lang.String text)

Replaces all '< ' by '<', reverting the result of escapeTags(String)