org.exoplatform.wiki.utils

Class Utils

java.lang.Object

org.exoplatform.wiki.utils.Utils

public class Utils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPARE_REVISION
static String	DOT
static String	PAGE
static String	SLASH
static String	SPACE
static String	SPLIT_TEXT_OF_DRAFT_FOR_NEW_PAGE
static String	VER_NAME
static String	WIKI_RESOUCE_BUNDLE_NAME

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static long	countSearchResult(WikiSearchData data)
static String	escapeIllegalCharacterInName(String name)
static String	escapeIllegalCharacterInQuery(String query)
static HashMap<String,IDType>	getACLForAdmins()
static String	getAttachmentCssClass(Attachment attachment, String append)
static String	getCurrentUser()
static String	getDefaultRestBaseURI()
static String	getDocumentURL(WikiContext wikiContext)
static String	getEmailUser(String userName)
static List<String>	getListOfUserEditingPage(String pageId) Get the list of user that're editing the wiki page
static Map<String,WikiPageHistory>	getLogOfPage(String pageId) Get the editting log of wiki page
static Object	getObjectFromParams(WikiPageParams param)
static String	getPageNameForAddingPage()
static String	getPageNameForAddingPage(String sessionId)
static String	getPermanlink(WikiPageParams params, boolean hasDowmainUrl) Get the permalink of current wiki page With the current page param: type = "group" owner = "spaces/test_space" pageId = "test_page" The permalink will be: http://int.exoplatform.org/portal/intranet/wiki/group/spaces/test_space/test_page
static String	getPortalName()
static String	getRestContextName() gets rest context name
static Stack<WikiPageParams>	getStackParams(Page page)
static String	getURL(String url, String verName)
static WikiPageParams	getWikiPageParams(Page page)
static String	getWikiResourceBundle(String key, ClassLoader cl) Get resource bundle from given resource file
static boolean	isDescendantPage(Page page, Page parentPage)
static void	logEditPageTime(WikiPageParams pageParams, String username, long updateTime, String draftName, boolean isNewPage) Log the edit page action of user
static void	removeLogEditPage(WikiPageParams pageParams, String user) removes the log of user editing page.
static void	sendMailOnChangeContent(Page page)
static String	validateWikiOwner(String wikiType, String wikiOwner) Validate wikiOwner depending on wikiType.

Methods inherited from class java.lang.Object

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

Field Detail

SLASH

public static final String SLASH

See Also:

Constant Field Values

DOT

public static final String DOT

See Also:

Constant Field Values

SPACE

public static final String SPACE

See Also:

Constant Field Values

PAGE

public static final String PAGE

See Also:

Constant Field Values

COMPARE_REVISION

public static final String COMPARE_REVISION

See Also:

Constant Field Values

VER_NAME

public static final String VER_NAME

See Also:

Constant Field Values

WIKI_RESOUCE_BUNDLE_NAME

public static final String WIKI_RESOUCE_BUNDLE_NAME

See Also:

Constant Field Values

SPLIT_TEXT_OF_DRAFT_FOR_NEW_PAGE

public static final String SPLIT_TEXT_OF_DRAFT_FOR_NEW_PAGE

See Also:

Constant Field Values

Constructor Detail

Utils

public Utils()

Method Detail

escapeIllegalCharacterInQuery

public static String escapeIllegalCharacterInQuery(String query)

escapeIllegalCharacterInName

public static String escapeIllegalCharacterInName(String name)

getPortalName

public static String getPortalName()

getWikiResourceBundle

public static String getWikiResourceBundle(String key,
                                           ClassLoader cl)

Get resource bundle from given resource file

Parameters:

key - key

cl - ClassLoader to load resource file

Returns:

The value of key in resource bundle

logEditPageTime

public static void logEditPageTime(WikiPageParams pageParams,
                                   String username,
                                   long updateTime,
                                   String draftName,
                                   boolean isNewPage)

Log the edit page action of user

Parameters:

pageParams - The page that has been editing

username - The name of user that editing wiki page

updateTime - The time that this page is edited

draftName - The name of draft for this edit

isNewPage - Is the wiki page a draft or not

removeLogEditPage

public static void removeLogEditPage(WikiPageParams pageParams,
                                     String user)

removes the log of user editing page.

Parameters:

pageParams -

user -

getListOfUserEditingPage

public static List<String> getListOfUserEditingPage(String pageId)

Get the list of user that're editing the wiki page

Parameters:

pageId - The id of wiki page

Returns:

The list of user that're editing this wiki page

getPermanlink

public static String getPermanlink(WikiPageParams params,
                                   boolean hasDowmainUrl)
                            throws Exception

Get the permalink of current wiki page
With the current page param:

• type = "group"
• owner = "spaces/test_space"
• pageId = "test_page"

The permalink will be:

• http://int.exoplatform.org/portal/intranet/wiki/group/spaces/test_space/test_page

Returns:

The permalink of current wiki page

Throws:

Exception

getPageNameForAddingPage

public static String getPageNameForAddingPage()

getPageNameForAddingPage

public static String getPageNameForAddingPage(String sessionId)

getLogOfPage

public static Map<String,WikiPageHistory> getLogOfPage(String pageId)

Get the editting log of wiki page

Parameters:

pageId - The id of wiki page to get log

Returns:

The editting log of wiki pgae

validateWikiOwner

public static String validateWikiOwner(String wikiType,
                                       String wikiOwner)

Validate wikiOwner depending on wikiType.
If wikiType is PortalConfig.GROUP_TYPE, wikiOwner is checked to removed slashes at the begin and the end point of it.

Parameters:

wikiType -

wikiOwner -

Returns:

wikiOwner after validated.

getDefaultRestBaseURI

public static String getDefaultRestBaseURI()

getDocumentURL

public static String getDocumentURL(WikiContext wikiContext)

getCurrentUser

public static String getCurrentUser()

isDescendantPage

public static boolean isDescendantPage(Page page,
                                       Page parentPage)
                                throws WikiException

Throws:

WikiException

getObjectFromParams

public static Object getObjectFromParams(WikiPageParams param)
                                  throws WikiException

Throws:

WikiException

getStackParams

public static Stack<WikiPageParams> getStackParams(Page page)
                                            throws WikiException

Throws:

WikiException

getWikiPageParams

public static WikiPageParams getWikiPageParams(Page page)

sendMailOnChangeContent

public static void sendMailOnChangeContent(Page page)
                                    throws WikiException,
                                           org.suigeneris.jrcs.diff.DifferentiationFailedException,
                                           org.xwiki.component.manager.ComponentLookupException,
                                           org.xwiki.rendering.converter.ConversionException

Throws:

WikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

org.xwiki.component.manager.ComponentLookupException

org.xwiki.rendering.converter.ConversionException

getEmailUser

public static String getEmailUser(String userName)
                           throws WikiException

Throws:

WikiException

getACLForAdmins

public static HashMap<String,IDType> getACLForAdmins()

getURL

public static String getURL(String url,
                            String verName)

countSearchResult

public static long countSearchResult(WikiSearchData data)
                              throws Exception

Throws:

Exception

getAttachmentCssClass

public static String getAttachmentCssClass(Attachment attachment,
                                           String append)
                                    throws Exception

Throws:

Exception

getRestContextName

public static String getRestContextName()

gets rest context name

Returns:

rest context name