com.atlassian.confluence.util
Class GeneralUtil

java.lang.Object
  com.atlassian.confluence.util.GeneralUtil

public final class GeneralUtil
extends Object

Constructor Summary

GeneralUtil()

Method Summary

static String	alwaysMaskEmail(String emailAddress) Masks an email address by replacing '@' with 'at' and '.' with 'dot'.
static String	appendAmpsandOrQuestionMark(String str)
int	arraySize(int[] array) convenience method to allow us to determine the size of an int array a velocity file
static String	base64Decode(String s)
static String	base64Encode(String s)
static String	checkPartnerDetails(com.atlassian.license.License license, String buildPartnerName)
static String	completeUrlEncode(String url) A utility method to encode the given url for protocols which the CompleteURLEncoder supports.
static String	constrainLength(String s, int length) Truncate a string after n characters
static Map	convertBeanToMap(Object bean)
static Date	convertMailFormatDate(String date)
static Boolean	convertToBoolean(Object obj)
static boolean	convertToBoolean(Object bool, boolean defaultValue)
static Character	convertToCharacter(Object obj)
static Integer	convertToInteger(Object obj)
static String	convertToString(Object obj)
static void	copyDate(Calendar original, Calendar copy) Takes two calendar objects and sets the Date of the second to the Date of the first.
static File	createTempDirectoryInConfluenceTemp(String prefix)
static File	createTempFile(String directory)
static String	customGetPageUrl(AbstractPage page) Need a special case of generalutils getpageurl that appends ? or ampersand smartly this is used to prefix url parameters that are appended after this path like: showcomments=true#addcomment
static String	displayShortUrl(String url)
static String	displayShortUrl(String url, int length)
static String	doubleUrlEncode(String s)
static String	escapeCDATA(String s)
static List	escapeCommas(List toEscape) Escape commas on each entry in the given list of strings.
static String	escapeCommas(String toEscape) Escapes commas and backslashes with leading backslashes.
static String	escapeForJavascript(String s) Escapes ', " and \ with a leading \.
static String[]	escapeXml(Object[] args) Produces an array of XML escaped Strings from a list of Objects.
static String	escapeXml(String stringToEscape)
static String	escapeXMLCharacters(String input) Take a String which may contain <, > or & and return an XML string containing entities
static List	filterNulls(Collection in) Return a List with no null entries
static String	findAndMaskEmail(String text, com.atlassian.user.User currentUser)
static String	format(Number number) Deprecated. since 3.1 unused anywhere in the application.
static String	format(Object obj)
static String	format(String str)
static String	formatDateFull(Date date)
static String	formatLongTime(long time)
static Date	getBuildDate()
static String	getBuildDateString()
static String	getBuildExcludedLocale()
static String	getBuildNumber()
static String	getBuildPartner()
static String	getCharacterEncoding()
static String	getCompactDuration(long time) Returns the duration in a compact HH:mm:ss format.
static File	getConfluenceTempDirectory()
static String	getConfluenceTempDirectoryPath() Checks if temp directory exists before returning the path.
static String	getCookieValue(String key)
static ResourceBundle	getDefaultResourceBundle()
static String	getFormatDateSimple(Date date)
static Settings	getGlobalSettings()
static I18NBean	getI18n()
static String	getIdBasedPageUrl(AbstractPage page) Get page URL that is id based (i.e.
static com.atlassian.core.util.ImageInfo	getImageInfo(File pathToImage)
static String	getNiceDuration(int minutes, int seconds)
static String	getPageUrl(AbstractPage page)
static String	getPageUrl(VersionHistorySummary summary)
long	getPercentage(long numerator, long denom) converts a fraction into a percentage
long	getPercentage(String numeratorAsString, String denomAsString)
static <T> List<T>	getRandomSubSet(List<T> list, int sizeOfSubset, Random random) Returns a randomised subset of the list provided.
static String	getRelativeTime(Date date) Deprecated. since 2.7 use FriendlyDateFormatter
static String	getStackTrace(Throwable t)
static Long	getSystemStartupTime()
static String	getUploadFileTooLargeMessage(String errorMessage) if this error message is of the type: "java.io.IOException: Content Length Error" convert it to something nicer
static UserAccessor	getUserAccessor()
static String	getVersionNumber()
static String	hackSingleQuotes(String s) hack to make strings that contain singles compatible with javascript (which also uses single quotes denote strings)
static boolean	hasTooManyUsers() Check if the current installation has more active users than is allowed by the license
static String	highlight(String content, String searchwords)
static String	htmlEncode(String text)
static String	htmlEncodeAndReplaceSpaces(String text)
static String	htmlEscapeQuotes(String input) Take a string and escape the quotes in it with \" and HTML escape them afterwards.
static boolean	isAllAscii(String s)
static boolean	isAllLettersOrNumbers(String s)
static boolean	isDefaultUserProfilePicture(String username) Deprecated. This method must not be used anymore, it is horribly inefficient. Rather use the ProfilePictureInfo: since it is never null, you can ask that object is the user has a default profile picture or not
static boolean	isInLastDays(Date date, int maxDays)
static boolean	isLicenseExpired()
static boolean	isOutgoingMailConfigured()
static boolean	isSafeTitleForFilesystem(String title) Ensure the title is safe to be written to the file system.
static boolean	isSafeTitleForUrl(String title) Is "title" something we can safely put in a /foo/bar/title URL? Or should we reference this thing by ID just to be safe?
static boolean	isSetupComplete()
static boolean	isSuperUser(com.atlassian.user.User user)
static void	loadDefaultProperties() Deprecated. since 3.0 because it doesn't do anything
static String	lookupDomainName(HttpServletRequest request) Get the default domain name.
static String	makeFlatSummary(String content) Create a summary of this content fragment.
static String	makeFlatSummary(String content, String query) Create a summary of this content fragment given a query
static Summary	makeSummary(String content) Create a proper summary of this content fragment.
static Summary	makeSummary(String content, String query) Create a proper summary of this content fragment given a query
static String	maskEmail(String emailAddress) If configured, masks an email address to defeat the most simplistic spam bots.
static ConfluenceActionSupport	newWiredConfluenceActionSupport()
static String	personalSpaceUrl(String contextPath, String username)
static String	plain2html(String text)
static String	populateSimpleMessage(String template, List<String> values) Populate the template String supplied using the given values.
static Map	prefixAllMapKeys(String prefix, Map map) Convert the supplied Map so that all of the keys in the Map are prefixed by the supplied String followed by a full stop.
static void	profilePop(String s)
static void	profilePush(String s)
static String	rdfEncode(String s) A fairly evil hack to work around CONF-10364.
static String	replaceConfluenceHomeConstant(String in, String confHome)
static String	replaceInvalidXmlCharacters(String text) Take a String which may contain characters outside of the XML character range (http://www.w3.org/TR/REC-xml/#charsets) and return a String with those characters converted to Unicode "Replacement Character"s (0xFFFD).
static List	safeSubList(List list, int max)
static Cookie	setCookie(String key, String value) Sets a cookie.
static void	setSystemStartupTime(Long systemStartupTime)
static void	setUserAccessor(UserAccessor userAcc)
static String	shortenString(String str, int max) Returns a substring of the specified string if it is longer than max.
static boolean	shouldUrlDecode(String str)
static Collection	specialLowerCaseCollection(Collection collection) Takes a collection of Strings and lowercases the entries.
static String	specialToLowerCase(String str) the database lower() function in PostgreSQL only works for ASCII strings.
static String[]	splitCommaDelimitedString(String escapedNames) Method will turn a String of comma seperated entities into a String Array.
static boolean	stringSet(String str)
long	subtract(long a, long b)
long	subtract(String firstOperandAsString, String secondOperandAsString)
static String	summarise(String content) Deprecated. since 2.0 use RendererUtil.summarise(String) instead.
static Date	toEndOfMonth(Calendar postDate) Takes a Calendar object and returns the very end (last day, hour, minute, second and milisecond) of the month that the Calendar is in.
static String	trimDownStringToWord(String s)
static String	unescapeCDATA(String s)
static String	unescapeEntities(String str)
static void	unzipFile(File zipFile, File dirToExtractTo) Unzips the zip file to a folder in temp and returns the File pointing to that expanded folder.
static void	unzipUrl(URL zipUrl, File dirToExtractTo) Unzips the zip url to a folder in temp and returns the File pointing to that expanded folder.
static String	urlDecode(String url)
static String	urlEncode(String url) A utility method to encode HTTP form parameter/values.
static String	urlEncode(String value, String encoding)
static String	wordWrap(String str, int max) For really long strings that have no spaces or line breaks, browsers such as firefox, Netscape, have difficulty wrapping them inside a table cell, and so these strings end up stretching the cell longer than its suppose to be = ugly we want to simulate IE's word-wrap/break function here

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeneralUtil

public GeneralUtil()

Method Detail

loadDefaultProperties

public static void loadDefaultProperties()

Deprecated. since 3.0 because it doesn't do anything

See Also:

BuildInformation

getStackTrace

public static String getStackTrace(Throwable t)

format

public static String format(Number number)

Deprecated. since 3.1 unused anywhere in the application.

TODO: Replace with a NumberFormatter, similar to DateFormatter

Returns:

the number formatted a String, or null if an exception occurred.

format

public static String format(String str)

format

public static String format(Object obj)

convertMailFormatDate

public static Date convertMailFormatDate(String date)
                                  throws ParseException

Throws:

ParseException

convertToCharacter

public static Character convertToCharacter(Object obj)

convertToInteger

public static Integer convertToInteger(Object obj)

convertToBoolean

public static Boolean convertToBoolean(Object obj)

convertToBoolean

public static boolean convertToBoolean(Object bool,
                                       boolean defaultValue)

convertToString

public static String convertToString(Object obj)

completeUrlEncode

public static String completeUrlEncode(String url)

A utility method to encode the given url for protocols which the CompleteURLEncoder supports. To only encode HTTP form parameter/values or fragments, use urlEncode() instead.

Parameters:

url - - the entire URL to encode

Returns:

encoded url

urlEncode

public static String urlEncode(String url)

A utility method to encode HTTP form parameter/values. To encode entire URLs, use completeUrlEncode() instead.

Parameters:

url - - part of the url to encode

Returns:

encoded url

urlEncode

public static String urlEncode(String value,
                               String encoding)

urlDecode

public static String urlDecode(String url)

shouldUrlDecode

public static boolean shouldUrlDecode(String str)

getPageUrl

public static String getPageUrl(VersionHistorySummary summary)

getPageUrl

public static String getPageUrl(AbstractPage page)

getIdBasedPageUrl

public static String getIdBasedPageUrl(AbstractPage page)

Get page URL that is id based (i.e. in the format /pages/viewpage.action?pageId=<pageId>)

Parameters:

page - the page to generate a url for

Returns:

page URL that is id based

isSafeTitleForUrl

public static boolean isSafeTitleForUrl(String title)

Is "title" something we can safely put in a /foo/bar/title URL? Or should we reference this thing by ID just to be safe?

isSafeTitleForFilesystem

public static boolean isSafeTitleForFilesystem(String title)

Ensure the title is safe to be written to the file system. See CONF-10741.

Parameters:

title -

Returns:

customGetPageUrl

public static String customGetPageUrl(AbstractPage page)

Need a special case of generalutils getpageurl that appends ? or ampersand smartly this is used to prefix url parameters that are appended after this path like: showcomments=true#addcomment

appendAmpsandOrQuestionMark

public static String appendAmpsandOrQuestionMark(String str)

wordWrap

public static String wordWrap(String str,
                              int max)

For really long strings that have no spaces or line breaks, browsers such as firefox, Netscape, have difficulty wrapping them inside a table cell, and so these strings end up stretching the cell longer than its suppose to be = ugly

we want to simulate IE's word-wrap/break function here

Parameters:

str -

max - - max length of string allowed per line

highlight

public static String highlight(String content,
                               String searchwords)

doubleUrlEncode

public static String doubleUrlEncode(String s)

isAllAscii

public static boolean isAllAscii(String s)

isAllLettersOrNumbers

public static boolean isAllLettersOrNumbers(String s)

getVersionNumber

public static String getVersionNumber()

getBuildDate

public static Date getBuildDate()

getBuildDateString

public static String getBuildDateString()

getBuildNumber

public static String getBuildNumber()

getBuildPartner

public static String getBuildPartner()

getBuildExcludedLocale

public static String getBuildExcludedLocale()

getSystemStartupTime

public static Long getSystemStartupTime()

setSystemStartupTime

public static void setSystemStartupTime(Long systemStartupTime)

isLicenseExpired

public static boolean isLicenseExpired()

checkPartnerDetails

public static String checkPartnerDetails(com.atlassian.license.License license,
                                         String buildPartnerName)

hasTooManyUsers

public static boolean hasTooManyUsers()

Check if the current installation has more active users than is allowed by the license

Returns:

true if the number exceeds the license, false otherwise.

stringSet

public static boolean stringSet(String str)

formatLongTime

public static String formatLongTime(long time)

displayShortUrl

public static String displayShortUrl(String url)

displayShortUrl

public static String displayShortUrl(String url,
                                     int length)

formatDateFull

public static String formatDateFull(Date date)

toEndOfMonth

public static Date toEndOfMonth(Calendar postDate)

Takes a Calendar object and returns the very end (last day, hour, minute, second and milisecond) of the month that the Calendar is in. The original Calendar object is left unaltered.

Returns:

Date object signifying the very end of the Calendar's month

copyDate

public static void copyDate(Calendar original,
                            Calendar copy)

Takes two calendar objects and sets the Date of the second to the Date of the first. Used to keep dates consistent regardless of timezones.

isSuperUser

public static boolean isSuperUser(com.atlassian.user.User user)

getCharacterEncoding

public static String getCharacterEncoding()

escapeXml

public static String escapeXml(String stringToEscape)

escapeXml

public static String[] escapeXml(Object[] args)

Produces an array of XML escaped Strings from a list of Objects. String.valueOf(Object) is used to produce Strings from the Objects

escapeForJavascript

public static String escapeForJavascript(String s)

Escapes ', " and \ with a leading \.

isSetupComplete

public static boolean isSetupComplete()

maskEmail

public static String maskEmail(String emailAddress)

If configured, masks an email address to defeat the most simplistic spam bots. If Confluence is not configured to mask email addresses, just returns the original address.

Passing in null to this method will just get you null back

Parameters:

emailAddress - the email address to mask

Returns:

the masked email address, or the original address if masking is not configured

alwaysMaskEmail

public static String alwaysMaskEmail(String emailAddress)

Masks an email address by replacing '@' with 'at' and '.' with 'dot'.

Parameters:

emailAddress - an email address to mask, eg [email protected]

Returns:

a masked version of the email, eg dwillis at atlassian dot com

findAndMaskEmail

public static String findAndMaskEmail(String text,
                                      com.atlassian.user.User currentUser)

escapeCDATA

public static String escapeCDATA(String s)

unescapeCDATA

public static String unescapeCDATA(String s)

createTempDirectoryInConfluenceTemp

public static File createTempDirectoryInConfluenceTemp(String prefix)

createTempFile

public static File createTempFile(String directory)

unescapeEntities

public static String unescapeEntities(String str)

base64Decode

public static String base64Decode(String s)

base64Encode

public static String base64Encode(String s)

hackSingleQuotes

public static String hackSingleQuotes(String s)

hack to make strings that contain singles compatible with javascript (which also uses single quotes denote strings)

Parameters:

s -

isInLastDays

public static boolean isInLastDays(Date date,
                                   int maxDays)

Parameters:

date - the date to check

maxDays - the number of days into the past the date can fall

Returns:

Whether whether the date falls within maxDays before the present.

getRelativeTime

public static String getRelativeTime(Date date)

Deprecated. since 2.7 use FriendlyDateFormatter

Returns:

A relative time period, 'X hours, Y minutes ago'

getFormatDateSimple

public static String getFormatDateSimple(Date date)

setCookie

public static Cookie setCookie(String key,
                               String value)

Sets a cookie. set to use a default cookie age of one year and the context path as the default path

Parameters:

key -

value -

getCookieValue

public static String getCookieValue(String key)

htmlEncode

public static String htmlEncode(String text)

htmlEncodeAndReplaceSpaces

public static String htmlEncodeAndReplaceSpaces(String text)

plain2html

public static String plain2html(String text)

See Also:

PlainTextToHtmlConverter

unzipFile

public static void unzipFile(File zipFile,
                             File dirToExtractTo)
                      throws Exception

Unzips the zip file to a folder in temp and returns the File pointing to that expanded folder.

Throws:

Exception

unzipUrl

public static void unzipUrl(URL zipUrl,
                            File dirToExtractTo)
                     throws Exception

Unzips the zip url to a folder in temp and returns the File pointing to that expanded folder.

Throws:

Exception

getUploadFileTooLargeMessage

public static String getUploadFileTooLargeMessage(String errorMessage)

if this error message is of the type: "java.io.IOException: Content Length Error" convert it to something nicer

Parameters:

errorMessage -

getDefaultResourceBundle

public static ResourceBundle getDefaultResourceBundle()

getI18n

public static I18NBean getI18n()

Returns:

The I18NBean for the current user

arraySize

public int arraySize(int[] array)

convenience method to allow us to determine the size of an int array a velocity file

Parameters:

array -

escapeXMLCharacters

public static String escapeXMLCharacters(String input)

Take a String which may contain <, > or & and return an XML string containing entities

replaceInvalidXmlCharacters

public static String replaceInvalidXmlCharacters(String text)

Take a String which may contain characters outside of the XML character range (http://www.w3.org/TR/REC-xml/#charsets) and return a String with those characters converted to Unicode "Replacement Character"s (0xFFFD). Note that this method does not "escape" the string (e.g. "&" is not converted to "&"). Similar to org.jdom.Verifier#checkCharacterData(String) but converts illegals instead of throwing Exceptions.

htmlEscapeQuotes

public static String htmlEscapeQuotes(String input)

Take a string and escape the quotes in it with \" and HTML escape them afterwards. We need this function to escape strings containing quotes passed into JavaScript functions null input will be returned as an empty String.

filterNulls

public static List filterNulls(Collection in)

Return a List with no null entries

shortenString

public static String shortenString(String str,
                                   int max)

Returns a substring of the specified string if it is longer than max. This method also appends "..." to the end of the string if it does truncate it.

Returns:

a substring of the specified string if it is longer than max.

specialToLowerCase

public static String specialToLowerCase(String str)

the database lower() function in PostgreSQL only works for ASCII strings. All other unicode and multibyte characters like capital umlaut are not properly converted. At the moment, when searching for pages we do the following comparison:

lower(page.title) = :pageTitle (Where :pageTitle is normally .toLowerCase() first before being passed in)

This special lower case function will skip the JAVA .toLowerCase() for postgres whose database lower() is ineffective.

Parameters:

str -

replaceConfluenceHomeConstant

public static String replaceConfluenceHomeConstant(String in,
                                                   String confHome)

specialLowerCaseCollection

public static Collection specialLowerCaseCollection(Collection collection)

Takes a collection of Strings and lowercases the entries.

Parameters:

collection -

Returns:

lowercased collection of strings

safeSubList

public static List safeSubList(List list,
                               int max)

summarise

public static String summarise(String content)

Deprecated. since 2.0 use RendererUtil.summarise(String) instead.

makeSummary

public static Summary makeSummary(String content)

Create a proper summary of this content fragment.

See Also:

Summarizer

makeSummary

public static Summary makeSummary(String content,
                                  String query)

Create a proper summary of this content fragment given a query

See Also:

Summarizer

makeFlatSummary

public static String makeFlatSummary(String content)

Create a summary of this content fragment.

See Also:

Summarizer

makeFlatSummary

public static String makeFlatSummary(String content,
                                     String query)

Create a summary of this content fragment given a query

See Also:

Summarizer

getUserAccessor

public static UserAccessor getUserAccessor()

setUserAccessor

public static void setUserAccessor(UserAccessor userAcc)

getImageInfo

public static com.atlassian.core.util.ImageInfo getImageInfo(File pathToImage)

getNiceDuration

public static String getNiceDuration(int minutes,
                                     int seconds)

getCompactDuration

public static String getCompactDuration(long time)

Returns the duration in a compact HH:mm:ss format.

Parameters:

time - duration in milliseconds

Returns:

the duration in a compact HH:mm:ss format.

newWiredConfluenceActionSupport

public static ConfluenceActionSupport newWiredConfluenceActionSupport()

profilePush

public static void profilePush(String s)

profilePop

public static void profilePop(String s)

lookupDomainName

public static String lookupDomainName(HttpServletRequest request)

Get the default domain name.

Parameters:

request -

Returns:

null if request is null, otherwise a base URL derived from the request.

getGlobalSettings

public static Settings getGlobalSettings()

personalSpaceUrl

public static String personalSpaceUrl(String contextPath,
                                      String username)

getPercentage

public long getPercentage(long numerator,
                          long denom)

converts a fraction into a percentage

Parameters:

numerator -

denom -

subtract

public long subtract(long a,
                     long b)

getPercentage

public long getPercentage(String numeratorAsString,
                          String denomAsString)

subtract

public long subtract(String firstOperandAsString,
                     String secondOperandAsString)

getConfluenceTempDirectoryPath

public static String getConfluenceTempDirectoryPath()

Checks if temp directory exists before returning the path. Create it if it doesn't already exist.

Returns:

path to temp directory inside Confluence home

getConfluenceTempDirectory

public static File getConfluenceTempDirectory()

splitCommaDelimitedString

public static String[] splitCommaDelimitedString(String escapedNames)

Method will turn a String of comma seperated entities into a String Array. Spaces before or after the comma will be cropped. Backslashes are treated as escaped characters. Eg when "backslash""comma" is encountered, the backslash is discarded and the comma is not treated as a delimiter.

Parameters:

escapedNames - Comma delimited string with original commas and backslashes escaped by backslashes

Returns:

String[] of escapedNames

escapeCommas

public static List escapeCommas(List toEscape)

Escape commas on each entry in the given list of strings.

Parameters:

toEscape - Strings to escape

Returns:

escaped Strings

escapeCommas

public static String escapeCommas(String toEscape)

Escapes commas and backslashes with leading backslashes.

Parameters:

toEscape - string to escape. If null, then null will be returned.

constrainLength

public static String constrainLength(String s,
                                     int length)

Truncate a string after n characters

Parameters:

s - The String to truncate

length - The maximum length allowed.

Returns:

The truncated String -- or the original String if no truncation was needed.

isOutgoingMailConfigured

public static boolean isOutgoingMailConfigured()

convertBeanToMap

public static Map convertBeanToMap(Object bean)

Parameters:

bean - a bean to be converted to a Map.

Returns:

a Map where the keys are the property names from the beans, and the values are the property values. An empty Map will be returned if the bean cannot be converted.

prefixAllMapKeys

public static Map prefixAllMapKeys(String prefix,
                                   Map map)

Convert the supplied Map so that all of the keys in the Map are prefixed by the supplied String followed by a full stop. e.g. monkey could become howler.monkey.

If any of the keys in the Map are not Strings then they will be ignored.

Parameters:

prefix - the prefix to be pre-pended to each Map key, if null then the original Map will be returned.

map - the Map to be modified. If null, then an empty Map will be returned.

Returns:

a new Map containing the modified keys and the supplied values.

isDefaultUserProfilePicture

public static boolean isDefaultUserProfilePicture(String username)

Deprecated. This method must not be used anymore, it is horribly inefficient. Rather use the ProfilePictureInfo: since it is never null, you can ask that object is the user has a default profile picture or not

rdfEncode

public static String rdfEncode(String s)

A fairly evil hack to work around CONF-10364. It sucks, but is necessary.

Parameters:

s - to encode

Returns:

the input String with double hyphens replaced by --

populateSimpleMessage

public static String populateSimpleMessage(String template,
                                           List<String> values)

Populate the template String supplied using the given values. The template may contain place holders which are denoted numerically in the form {n} where n is an index into the supplied values list.

e.g. "The template called {1} will expects a colour here {0}".

This template will use value 0 and value 1 from the supplied values array. If the referenced value cannot be found then the place holder will simply be removed.

Parameters:

template - the template to be populated

values - the values used to populate the template

Returns:

a populated template with all place holder markers removed.

getRandomSubSet

public static <T> List<T> getRandomSubSet(List<T> list,
                                          int sizeOfSubset,
                                          Random random)

Returns a randomised subset of the list provided. If the size of the subset is larger than the list, the entire list is returned in a random order.

Parameters:

list - - the list to subset

sizeOfSubset - - the size of the subset to return

random - - the source of randomness

Returns:

a randomised subset of the list

trimDownStringToWord

public static String trimDownStringToWord(String s)