Public Member Functions
	MarkerHelper (IConstructor constructor)

String	getQRCodeFromCurrent ()

String	getQRCodeFromUrl (String url)

String	getImageFromUrl (String url)

String	getContent (String values)

String	getContent (KeyValueMap values)

String	getEntryPoint (String entryPoint, String values)

String	getEntryPoint (String entryPoint, KeyValueMap values)

Repository	getRepository (String path)

String	imageOrEmpty (String image)

String	imageOrDefault (String image)

boolean	imageExists (String image)

IDirectContent	getCookies ()

IDirectContent	getTracker ()

IDirectContent	getPushNotification ()

IDirectContent	getMessageQueue ()

boolean	needCookies ()

String	processMacrosForWeb (String text)

Set< IUserMenu >	getUserMenu ()

Set< IElephantUserContent >	getUserContents ()

Set< String >	getUserContentTags ()

IDirectContent	getAnonymous ()

String	getIdFrom (String value)

String	getUniqueId ()

String	getHelpLink (ElContext context)

String	getEntityInfoURL (String entityPath)

String	getUserActivityURL (IContact contact)

String	webTags ()

String	navigateToWebTag (String fromTag, String webTag)

String	navigateAndSetWebTag (String fromTag, String path)

String	obfuscateParameters (String parameters)

String	obfuscateRightNowPars (String parameters)

String	getObfuscatedParameter (String parameter)

String	getTrick (int seconds)

String	getSiteAddress ()

String	truncate (String text, int max)

String	truncateHTML (String html, int max)

String	truncateHTMLtoPlain (String html, int max)

Colors.Color	color (String color)

String	downloadPath (Document document)

Static Public Member Functions
static String	setObfuscatedParsPOST (String parameters)

static String	setObfuscatedPars (String parameters)

static String	setObfuscatedPars (KeyValueMap parameters)

static String	setObfuscatedRightNowPars (String parameters)

static String	setObfuscatedRightNowPars (KeyValueMap parameters)

static KeyValueMap	getObfuscatedParameters ()

static KeyValueMap	getObfuscatedParameters (HttpServletRequest request)

static KeyValueMap	getObfuscatedFrom (String obfuscated)

static KeyValueMap	getAllParameters ()

static KeyValueMap	getAllParameters (Map< String, String[]> parameterMap)

static String	obsfuscatedPOST (String context, String values)

static String	createPOST (String id, String values)

static String	createPOST (String id, String domId, String values)

static String	createURL (String id, String values)

static String	createDirectURL (IConstructor constructor, IContact contact, String directContentId, String values, int daysValid, boolean withDomain)

Static Public Attributes
static final String	OBFUSCATED_PAR = "el_xpar"

Detailed Description

Author: Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 77 of file MarkerHelper.java.

Constructor & Destructor Documentation

◆ MarkerHelper()

org.turro.marker.MarkerHelper.MarkerHelper ( IConstructor constructor )

Definition at line 83 of file MarkerHelper.java.

                                                 {
     this.constructor = constructor;
   }

Member Function Documentation

◆ color()

Colors.Color org.turro.marker.MarkerHelper.color ( String color )

Definition at line 410 of file MarkerHelper.java.

                                           {
     return Optional.ofNullable(Colors.of(color)).map(c -> c.color()).orElse(null);
   }

◆ createDirectURL()

static String org.turro.marker.MarkerHelper.createDirectURL	(	IConstructor	constructor,
		IContact	contact,
		String	directContentId,
		String	values,
		int	daysValid,
		boolean	withDomain
	)

static

Definition at line 377 of file MarkerHelper.java.

                                                                                     {
     String exrino = null;
     try {
       KeyValueMap kvm = new KeyValueMap(values);
       kvm.put(Actions.USER_PAR, contact.getConnector(IUser.CONNECTOR_EMAIL));
       kvm.put(Actions.REDIR_PAR, (withDomain ? ElephantContext.getServerBase("http") : "") + constructor.getCurrentContext().getWebPath());
       exrino = Actions.createAction(kvm, daysValid, false);
     } catch (ParserException ex) {
       Logger.getLogger(MarkerHelper.class.getName()).log(Level.SEVERE, null, ex);
     }
     return (withDomain ? ElephantContext.getServerBase("http") : "") +
             ElephantContext.getRootWebPath() +
             DirectContents.DIRECT_CONTENT_PATH + directContentId +
             "?" + exrino;
   }

◆ createPOST() [1/2]

static String org.turro.marker.MarkerHelper.createPOST	(	String	id,
		String	domId,
		String	values
	)

static

Definition at line 369 of file MarkerHelper.java.

                                                                           {
     return DirectContents.doCreatePOST(id, domId, values);
   }

◆ createPOST() [2/2]

static String org.turro.marker.MarkerHelper.createPOST	(	String	id,
		String	values
	)

static

Definition at line 365 of file MarkerHelper.java.

                                                             {
     return DirectContents.doCreatePOST(id, values);
   }

◆ createURL()

static String org.turro.marker.MarkerHelper.createURL	(	String	id,
		String	values
	)

static

Definition at line 373 of file MarkerHelper.java.

                                                            {
     return DirectContents.doCreateURL(id, values);
   }

◆ downloadPath()

String org.turro.marker.MarkerHelper.downloadPath ( Document document )

Definition at line 416 of file MarkerHelper.java.

                                                 {
     return ElephantContext.getRootWebPath() + "/down_" + 
             ElephantContext.removeWebContext(
                     ElephantContext.getRelativePath(document.path().toString()));
   }

Here is the call graph for this function:

◆ getAllParameters() [1/2]

static KeyValueMap org.turro.marker.MarkerHelper.getAllParameters ( )

static

Definition at line 330 of file MarkerHelper.java.

                                                {
     HttpServletRequest request = Application.getApplication().getHttpServletRequest();
     if(request != null) {
       return getAllParameters(request.getParameterMap());
     }
     return new KeyValueMap(new HashMap());
   }

Here is the call graph for this function:

◆ getAllParameters() [2/2]

static KeyValueMap org.turro.marker.MarkerHelper.getAllParameters ( Map< String, String[]> parameterMap )

static

Definition at line 338 of file MarkerHelper.java.

                                                                                  {
     final Map map = new HashMap();
     if(parameterMap != null) {
       parameterMap.keySet().forEach((key) -> {
         if(OBFUSCATED_PAR.equals(key)) {
           KeyValueMap kvm = MarkerHelper.getObfuscatedFrom(parameterMap.get(key)[0]);
           if(kvm != null) {
             map.putAll(kvm);
           }
         } else {
           map.put(key, parameterMap.get(key)[0]);
         }
       });
     }
     return new KeyValueMap(map);
   }

◆ getAnonymous()

IDirectContent org.turro.marker.MarkerHelper.getAnonymous ( )

Definition at line 189 of file MarkerHelper.java.

                                        {
     return Plugins.loadImplementation(IDirectContent.class, "anonymous-ctrl");
   }

Here is the call graph for this function:

◆ getContent() [1/2]

String org.turro.marker.MarkerHelper.getContent ( KeyValueMap values )

Definition at line 109 of file MarkerHelper.java.

                                                {
     return ContentService.createURL(constructor, values);
   }

◆ getContent() [2/2]

String org.turro.marker.MarkerHelper.getContent ( String values )

Definition at line 105 of file MarkerHelper.java.

                                           {
     return ContentService.createURL(constructor, values);
   }

Here is the caller graph for this function:

◆ getCookies()

IDirectContent org.turro.marker.MarkerHelper.getCookies ( )

Definition at line 139 of file MarkerHelper.java.

                                      {
     return DirectContents.getDirectContent("cookie-management");
   }

Here is the call graph for this function:

◆ getEntityInfoURL()

String org.turro.marker.MarkerHelper.getEntityInfoURL ( String entityPath )

Definition at line 211 of file MarkerHelper.java.

                                                     {
     return EntityInfoContent.createURL(EntityInfoType.FULL, LinkType.WEB) + "&path=" + entityPath;
   }

Here is the call graph for this function:

◆ getEntryPoint() [1/2]

String org.turro.marker.MarkerHelper.getEntryPoint	(	String	entryPoint,
		KeyValueMap	values
	)

Definition at line 117 of file MarkerHelper.java.

                                                                      {
     return ContentService.createEntryPoint(constructor, entryPoint, values);
   }

◆ getEntryPoint() [2/2]

String org.turro.marker.MarkerHelper.getEntryPoint	(	String	entryPoint,
		String	values
	)

Definition at line 113 of file MarkerHelper.java.

                                                                 {
     return ContentService.createEntryPoint(constructor, entryPoint, values);
   }

◆ getHelpLink()

String org.turro.marker.MarkerHelper.getHelpLink ( ElContext context )

Definition at line 205 of file MarkerHelper.java.

                                                {
     return context != null ? HelpContext.helpLink(context.getPath()) : null;
   }

Here is the call graph for this function:

◆ getIdFrom()

String org.turro.marker.MarkerHelper.getIdFrom ( String value )

Definition at line 195 of file MarkerHelper.java.

                                         {
     return Strings.identifier(value);
   }

◆ getImageFromUrl()

String org.turro.marker.MarkerHelper.getImageFromUrl ( String url )

Definition at line 98 of file MarkerHelper.java.

                                             {
     HashMap map = new HashMap();
     map.put("type", "image");
     map.put("data", url);
     return getContent(new KeyValueMap(map));
   }

Here is the call graph for this function:

◆ getMessageQueue()

IDirectContent org.turro.marker.MarkerHelper.getMessageQueue ( )

Definition at line 151 of file MarkerHelper.java.

                                           {
     return DirectContents.getDirectContent("message-queue");
   }

Here is the call graph for this function:

◆ getObfuscatedFrom()

static KeyValueMap org.turro.marker.MarkerHelper.getObfuscatedFrom ( String obfuscated )

static

Definition at line 319 of file MarkerHelper.java.

                                                                  {
     if(!Strings.isBlank(obfuscated)) {
       try {
         return new KeyValueMap(ElephantContext.decrypt(URLDecoder.decode(obfuscated, charset)));
       } catch (Exception ex) {
         WebLoggers.info(MarkerHelper.class).exception(ex).log();
       }
     }
     return null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObfuscatedParameter()

String org.turro.marker.MarkerHelper.getObfuscatedParameter ( String parameter )

Definition at line 260 of file MarkerHelper.java.

                                                          {
     try {
       return getMapFromObfuscated().get(parameter);
     } catch (Exception ex) {
       Logger.getLogger(MarkerHelper.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
     return null;
   }

Here is the call graph for this function:

◆ getObfuscatedParameters() [1/2]

static KeyValueMap org.turro.marker.MarkerHelper.getObfuscatedParameters ( )

static

Definition at line 311 of file MarkerHelper.java.

                                                       {
     return getObfuscatedFrom(Application.getApplication().getConstructor().getParameter(OBFUSCATED_PAR));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObfuscatedParameters() [2/2]

static KeyValueMap org.turro.marker.MarkerHelper.getObfuscatedParameters ( HttpServletRequest request )

static

Definition at line 315 of file MarkerHelper.java.

                                                                                 {
     return getObfuscatedFrom(request.getParameter(OBFUSCATED_PAR));
   }

Here is the call graph for this function:

◆ getPushNotification()

IDirectContent org.turro.marker.MarkerHelper.getPushNotification ( )

Definition at line 147 of file MarkerHelper.java.

                                               {
     return DirectContents.getDirectContent("push-notification");
   }

Here is the call graph for this function:

◆ getQRCodeFromCurrent()

String org.turro.marker.MarkerHelper.getQRCodeFromCurrent ( )

Definition at line 87 of file MarkerHelper.java.

                                        {
     return getQRCodeFromUrl(constructor.getRequest().getRequestURL().toString());
   }

Here is the call graph for this function:

◆ getQRCodeFromUrl()

String org.turro.marker.MarkerHelper.getQRCodeFromUrl ( String url )

Definition at line 91 of file MarkerHelper.java.

                                              {
     HashMap map = new HashMap();
     map.put("type", "qrcode");
     map.put("data", url);
     return getContent(new KeyValueMap(map));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRepository()

Repository org.turro.marker.MarkerHelper.getRepository ( String path )

Definition at line 121 of file MarkerHelper.java.

                                                {
     return new Repository(constructor, path);
   }

◆ getSiteAddress()

String org.turro.marker.MarkerHelper.getSiteAddress ( )

Definition at line 361 of file MarkerHelper.java.

                                  {
     return ElephantContext.getServerUrl("http");
   }

Here is the call graph for this function:

◆ getTracker()

IDirectContent org.turro.marker.MarkerHelper.getTracker ( )

Definition at line 143 of file MarkerHelper.java.

                                      {
     return DirectContents.getDirectContent("img-tk");
   }

Here is the call graph for this function:

◆ getTrick()

String org.turro.marker.MarkerHelper.getTrick ( int seconds )

Definition at line 285 of file MarkerHelper.java.

                                       {
     return FormTrick.createTrick(seconds);
   }

Here is the call graph for this function:

◆ getUniqueId()

String org.turro.marker.MarkerHelper.getUniqueId ( )

Definition at line 199 of file MarkerHelper.java.

                               {
     return UUID.randomUUID().toString();
   }

◆ getUserActivityURL()

String org.turro.marker.MarkerHelper.getUserActivityURL ( IContact contact )

Definition at line 217 of file MarkerHelper.java.

                                                      {
     return new UserActivityContent().createURL(contact, ActivityType.values());
   }

Here is the call graph for this function:

◆ getUserContents()

Set<IElephantUserContent> org.turro.marker.MarkerHelper.getUserContents ( )

Definition at line 179 of file MarkerHelper.java.

                                                      {
     return UserContents.getContents(constructor, (IContact) constructor.getUser());
   }

Here is the call graph for this function:

◆ getUserContentTags()

Set<String> org.turro.marker.MarkerHelper.getUserContentTags ( )

Definition at line 183 of file MarkerHelper.java.

                                           {
     return UserContents.getTags(constructor, (IContact) constructor.getUser());
   }

Here is the call graph for this function:

◆ getUserMenu()

Set<IUserMenu> org.turro.marker.MarkerHelper.getUserMenu ( )

Definition at line 173 of file MarkerHelper.java.

                                       {
     return UserMenus.getUserMenu(constructor);
   }

Here is the call graph for this function:

◆ imageExists()

boolean org.turro.marker.MarkerHelper.imageExists ( String image )

Definition at line 133 of file MarkerHelper.java.

                                            {
     if(Strings.isBlank(image)) return false;
     image = image.contains("?") ? image.substring(0, image.indexOf("?")) : image;
     return new File(ElephantContext.getRealPath(image)).exists();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ imageOrDefault()

String org.turro.marker.MarkerHelper.imageOrDefault ( String image )

Definition at line 129 of file MarkerHelper.java.

                                              {
     return imageExists(image) ? image : "/_zul/images/noimg/noimage.png";
   }

Here is the call graph for this function:

◆ imageOrEmpty()

String org.turro.marker.MarkerHelper.imageOrEmpty ( String image )

Definition at line 125 of file MarkerHelper.java.

                                            {
     return imageExists(image) ? image : "/_zul/images/no_img.png";
   }

Here is the call graph for this function:

◆ navigateAndSetWebTag()

String org.turro.marker.MarkerHelper.navigateAndSetWebTag	(	String	fromTag,
		String	path
	)

Definition at line 243 of file MarkerHelper.java.

                                                                   {
     return TagsServlet.navigateAndSet(fromTag, path);
   }

Here is the call graph for this function:

◆ navigateToWebTag()

String org.turro.marker.MarkerHelper.navigateToWebTag	(	String	fromTag,
		String	webTag
	)

Definition at line 239 of file MarkerHelper.java.

                                                                 {
     return TagsServlet.navigateFromTo(fromTag, webTag);
   }

Here is the call graph for this function:

◆ needCookies()

boolean org.turro.marker.MarkerHelper.needCookies ( )

Definition at line 155 of file MarkerHelper.java.

                                {
     HttpServletRequest request = constructor.getRequest();
     return request != null;
   }

Here is the call graph for this function:

◆ obfuscateParameters()

String org.turro.marker.MarkerHelper.obfuscateParameters ( String parameters )

Definition at line 252 of file MarkerHelper.java.

                                                        {
     return setObfuscatedPars(parameters);
   }

Here is the call graph for this function:

◆ obfuscateRightNowPars()

String org.turro.marker.MarkerHelper.obfuscateRightNowPars ( String parameters )

Definition at line 256 of file MarkerHelper.java.

                                                          {
     return setObfuscatedRightNowPars(parameters);
   }

Here is the call graph for this function:

◆ obsfuscatedPOST()

static String org.turro.marker.MarkerHelper.obsfuscatedPOST	(	String	context,
		String	values
	)

static

Definition at line 355 of file MarkerHelper.java.

                                                                       {
     return "$.post(\"" + context + "\", { " + setObfuscatedParsPOST(values) + " })";
   }

◆ processMacrosForWeb()

String org.turro.marker.MarkerHelper.processMacrosForWeb ( String text )

Definition at line 160 of file MarkerHelper.java.

                                                  {
     if(text.contains("{@")) {
       StringWriter swriter = new StringWriter();
       try(PrintWriter writer = new PrintWriter(swriter)) {
         Parser.processMacros(constructor, writer, text);
         text = swriter.toString();
       } catch (IOException | ServletException ex) {
         Logger.getLogger(MarkerHelper.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
       }
     }
     return MailSenders.processMacros((IContact) constructor.getUser(), text, true);
   }

Here is the call graph for this function:

◆ setObfuscatedPars() [1/2]

static String org.turro.marker.MarkerHelper.setObfuscatedPars ( KeyValueMap parameters )

static

Definition at line 299 of file MarkerHelper.java.

                                                                  {
     return OBFUSCATED_PAR + "=" + URLEncoder.encode(Actions.createPars(parameters, 30), charset);
   }

Here is the call graph for this function:

◆ setObfuscatedPars() [2/2]

static String org.turro.marker.MarkerHelper.setObfuscatedPars ( String parameters )

static

Definition at line 295 of file MarkerHelper.java.

                                                             {
     return OBFUSCATED_PAR + "=" + URLEncoder.encode(Actions.createPars(parameters, 30), charset);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObfuscatedParsPOST()

static String org.turro.marker.MarkerHelper.setObfuscatedParsPOST ( String parameters )

static

Definition at line 291 of file MarkerHelper.java.

                                                                 {
     return OBFUSCATED_PAR + ":\"" + URLEncoder.encode(Actions.createPars(parameters, 30), charset) + "\"";
   }

Here is the call graph for this function:

◆ setObfuscatedRightNowPars() [1/2]

static String org.turro.marker.MarkerHelper.setObfuscatedRightNowPars ( KeyValueMap parameters )

static

Definition at line 307 of file MarkerHelper.java.

                                                                          {
     return OBFUSCATED_PAR + "=" + URLEncoder.encode(Actions.createRightNowParameter(parameters), charset);
   }

Here is the call graph for this function:

◆ setObfuscatedRightNowPars() [2/2]

static String org.turro.marker.MarkerHelper.setObfuscatedRightNowPars ( String parameters )

static

Definition at line 303 of file MarkerHelper.java.

                                                                     {
     return OBFUSCATED_PAR + "=" + URLEncoder.encode(Actions.createRightNowParameter(parameters), charset);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ truncate()

String org.turro.marker.MarkerHelper.truncate	(	String	text,
		int	max
	)

Definition at line 396 of file MarkerHelper.java.

                                                {
     return Strings.truncate(text, max);
   }

◆ truncateHTML()

String org.turro.marker.MarkerHelper.truncateHTML	(	String	html,
		int	max
	)

Definition at line 400 of file MarkerHelper.java.

                                                    {
     return HtmlContent.truncate(html, max);
   }

◆ truncateHTMLtoPlain()

String org.turro.marker.MarkerHelper.truncateHTMLtoPlain	(	String	html,
		int	max
	)

Definition at line 404 of file MarkerHelper.java.

                                                           {
     return HtmlContent.plain(html, max);
   }

◆ webTags()

String org.turro.marker.MarkerHelper.webTags ( )

Definition at line 235 of file MarkerHelper.java.

                           {
     return SessionTags.get(constructor).path();
   }

Here is the call graph for this function:

Member Data Documentation

◆ OBFUSCATED_PAR

final String org.turro.marker.MarkerHelper.OBFUSCATED_PAR = "el_xpar"

static

Definition at line 249 of file MarkerHelper.java.

The documentation for this class was generated from the following file:

MarkerHelper.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MarkerHelper()

Member Function Documentation

◆ color()

◆ createDirectURL()

◆ createPOST() [1/2]

◆ createPOST() [2/2]

◆ createURL()

◆ downloadPath()

◆ getAllParameters() [1/2]

◆ getAllParameters() [2/2]

◆ getAnonymous()

◆ getContent() [1/2]

◆ getContent() [2/2]

◆ getCookies()

◆ getEntityInfoURL()

◆ getEntryPoint() [1/2]

◆ getEntryPoint() [2/2]

◆ getHelpLink()

◆ getIdFrom()

◆ getImageFromUrl()

◆ getMessageQueue()

◆ getObfuscatedFrom()

◆ getObfuscatedParameter()

◆ getObfuscatedParameters() [1/2]

◆ getObfuscatedParameters() [2/2]

◆ getPushNotification()

◆ getQRCodeFromCurrent()

◆ getQRCodeFromUrl()

◆ getRepository()

◆ getSiteAddress()

◆ getTracker()

◆ getTrick()

◆ getUniqueId()

◆ getUserActivityURL()

◆ getUserContents()

◆ getUserContentTags()

◆ getUserMenu()

◆ imageExists()

◆ imageOrDefault()

◆ imageOrEmpty()

◆ navigateAndSetWebTag()

◆ navigateToWebTag()

◆ needCookies()

◆ obfuscateParameters()

◆ obfuscateRightNowPars()

◆ obsfuscatedPOST()

◆ processMacrosForWeb()

◆ setObfuscatedPars() [1/2]

◆ setObfuscatedPars() [2/2]

◆ setObfuscatedParsPOST()

◆ setObfuscatedRightNowPars() [1/2]

◆ setObfuscatedRightNowPars() [2/2]

◆ truncate()

◆ truncateHTML()

◆ truncateHTMLtoPlain()

◆ webTags()

Member Data Documentation

◆ OBFUSCATED_PAR