Skip to content

Commit

Permalink
SAK-43496 Deprecated utils.FormattedText => api.FormattedText (sakaip…
Browse files Browse the repository at this point in the history 
…roject#8108)

* SAK-43496 Deprecated utils.FormattedText => api.FormattedText

* SAK-43496 codacy: Fields should be declared at the top of the class, before any method declarations, constructors, initializers or inner classes
  • Loading branch information
@axxter99
axxter99 authored Mar 31, 2020
1 parent beeffeb commit 8fe191e
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 64 deletions.
57 changes: 32 additions & 25 deletions ...l/portal-impl/impl/src/java/org/sakaiproject/portal/charon/site/PortalSiteHelperImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
Expand Down Expand Up @@ -78,11 +77,10 @@
import org.sakaiproject.user.cover.PreferencesService;
import org.sakaiproject.user.cover.UserDirectoryService;
import org.sakaiproject.util.ArrayUtil;
import org.sakaiproject.util.FormattedText;
import org.sakaiproject.util.MapUtil;
import org.sakaiproject.util.Validator;
import org.sakaiproject.util.Web;
import org.sakaiproject.util.RequestFilter;
import org.sakaiproject.util.Web;
import org.sakaiproject.util.api.FormattedText;
import org.sakaiproject.util.comparator.AliasCreatedTimeComparator;

import lombok.extern.slf4j.Slf4j;
Expand Down Expand Up @@ -124,6 +122,8 @@ public class PortalSiteHelperImpl implements PortalSiteHelper
// private final String PROP_PARENT_ID = "sakai:parent-id";

private ToolManager toolManager;
private FormattedText formattedText;
private SimplePageToolDao simplePageToolDao;

public ToolManager getToolManager() {
//To work around injection for test case
Expand All @@ -132,12 +132,19 @@ public ToolManager getToolManager() {
}
return toolManager;
}

public FormattedText getFormattedText() {
if (formattedText == null) {
formattedText = ComponentManager.get(FormattedText.class);
}
return formattedText;
}

private static AuthzGroupService getAuthzGroupService() {
return (AuthzGroupService) ComponentManager.get(AuthzGroupService.class.getName());
}

private SimplePageToolDao simplePageToolDao;

public SimplePageToolDao getSimplePageToolDao() {
if (simplePageToolDao == null) {
simplePageToolDao = (SimplePageToolDao) ComponentManager.get(SimplePageToolDao.class.getName());
Expand Down Expand Up @@ -422,12 +429,12 @@ public String getUserSpecificSiteTitle(Site site, boolean truncated, boolean esc
String retVal = SiteService.getUserSpecificSiteTitle( site, UserDirectoryService.getCurrentUser().getId(), siteProviders );
if( truncated )
{
retVal = FormattedText.makeShortenedText( retVal, null, null, null );
retVal = getFormattedText().makeShortenedText( retVal, null, null, null );
}

if( escaped )
{
retVal = Web.escapeHtml( retVal );
retVal = getFormattedText().escapeHtml( retVal );
}

return retVal;
Expand Down Expand Up @@ -462,8 +469,8 @@ public Map convertSiteToMap(HttpServletRequest req, Site s, String prefix,
.equals(myWorkspaceSiteId))));

String siteTitleRaw = getUserSpecificSiteTitle(s, false, false, siteProviders);
String siteTitle = Validator.escapeHtml(siteTitleRaw);
String siteTitleTruncated = Validator.escapeHtml(FormattedText.makeShortenedText(siteTitleRaw, null, null, null));
String siteTitle = getFormattedText().escapeHtml(siteTitleRaw);
String siteTitleTruncated = getFormattedText().escapeHtml(getFormattedText().makeShortenedText(siteTitleRaw, null, null, null));
m.put("siteTitle", siteTitle);
m.put("siteTitleTrunc", siteTitleTruncated);
m.put("fullTitle", siteTitle);
Expand All @@ -473,15 +480,15 @@ public Map convertSiteToMap(HttpServletRequest req, Site s, String prefix,
if ( s.getShortDescription() !=null && s.getShortDescription().trim().length()>0 ){
// SAK-23895: Allow display of site description in the tab instead of site title
String shortDesc = s.getShortDescription();
String shortDesc_trimmed = FormattedText.makeShortenedText(shortDesc, null, null, null);
m.put("shortDescription", Web.escapeHtml(shortDesc_trimmed));
String shortDesc_trimmed = getFormattedText().makeShortenedText(shortDesc, null, null, null);
m.put("shortDescription", getFormattedText().escapeHtml(shortDesc_trimmed));
}

String siteUrl = RequestFilter.serverUrl(req)
+ ServerConfigurationService.getString("portalPath") + "/";
if (prefix != null) siteUrl = siteUrl + prefix + "/";
// siteUrl = siteUrl + Web.escapeUrl(siteHelper.getSiteEffectiveId(s));
m.put("siteUrl", siteUrl + Web.escapeUrl(getSiteEffectiveId(s)));
m.put("siteUrl", siteUrl + getFormattedText().escapeUrl(getSiteEffectiveId(s)));
m.put("siteType", s.getType());
m.put("siteId", s.getId());

Expand Down Expand Up @@ -509,10 +516,10 @@ public Map convertSiteToMap(HttpServletRequest req, Site s, String prefix,
List<String> providers = getProviderIDsForSite(site);

String parentSiteTitle = getUserSpecificSiteTitle(site, false, false, providers);
String parentSiteTitleTruncated = FormattedText.makeShortenedText(parentSiteTitle, null, null, null);
String parentSiteTitleTruncated = getFormattedText().makeShortenedText(parentSiteTitle, null, null, null);
pm.put("siteTitle", parentSiteTitle);
pm.put("siteTitleTrunc", parentSiteTitleTruncated);
pm.put("siteUrl", siteUrl + Web.escapeUrl(getSiteEffectiveId(site)));
pm.put("siteUrl", siteUrl + getFormattedText().escapeUrl(getSiteEffectiveId(site)));

l.add(pm);
isChild = true;
Expand Down Expand Up @@ -758,10 +765,10 @@ else if ("always".equals(showHelpGlobal))
m.put("current", Boolean.valueOf(current));
m.put("ispopup", Boolean.valueOf(p.isPopUp()));
m.put("pagePopupUrl", pagePopupUrl);
m.put("pageTitle", Web.escapeHtml(p.getTitle()));
m.put("jsPageTitle", Web.escapeJavascript(p.getTitle()));
m.put("pageId", Web.escapeUrl(p.getId()));
m.put("jsPageId", Web.escapeJavascript(p.getId()));
m.put("pageTitle", getFormattedText().escapeHtml(p.getTitle()));
m.put("jsPageTitle", getFormattedText().escapeJavascript(p.getTitle()));
m.put("pageId", getFormattedText().escapeUrl(p.getId()));
m.put("jsPageId", getFormattedText().escapeJavascript(p.getId()));
m.put("pageRefUrl", pagerefUrl);
m.put("pageResetUrl", pageResetUrl);
m.put("toolpopup", Boolean.valueOf(source!=null));
Expand Down Expand Up @@ -803,7 +810,7 @@ else if ("always".equals(showHelpGlobal))
}

String toolUrl = Web.returnUrl(req, "/" + portalPrefix + "/"
+ Web.escapeUrl(getSiteEffectiveId(site)));
+ getFormattedText().escapeUrl(getSiteEffectiveId(site)));
if (resetTools) {
toolUrl = toolUrl + "/tool-reset/";
} else {
Expand All @@ -820,15 +827,15 @@ else if ("always".equals(showHelpGlobal))
Tool tool = placement.getTool();
if (tool != null)
{
String toolrefUrl = toolUrl + Web.escapeUrl(placement.getId());
String toolrefUrl = toolUrl + getFormattedText().escapeUrl(placement.getId());

Map<String, Object> m = new HashMap<String, Object>();
m.put("isPage", Boolean.valueOf(false));
m.put("toolId", Web.escapeUrl(placement.getId()));
m.put("jsToolId", Web.escapeJavascript(placement.getId()));
m.put("toolId", getFormattedText().escapeUrl(placement.getId()));
m.put("jsToolId", getFormattedText().escapeJavascript(placement.getId()));
m.put("toolRegistryId", placement.getToolId());
m.put("toolTitle", Web.escapeHtml(placement.getTitle()));
m.put("jsToolTitle", Web.escapeJavascript(placement.getTitle()));
m.put("toolTitle", getFormattedText().escapeHtml(placement.getTitle()));
m.put("jsToolTitle", getFormattedText().escapeJavascript(placement.getTitle()));
m.put("toolrefUrl", toolrefUrl);
m.put("toolpopup", Boolean.valueOf(source!=null));
m.put("toolpopupurl", source);
Expand Down Expand Up @@ -913,7 +920,7 @@ else if ("always".equals(showHelpGlobal))
showPresence = false;

String presenceUrl = Web.returnUrl(req, "/presence/"
+ Web.escapeUrl(site.getId()));
+ getFormattedText().escapeUrl(site.getId()));

// theMap.put("pageNavSitPresenceTitle",
// Web.escapeHtml(rb.getString("sit_presencetitle")));
Expand Down
8 changes: 4 additions & 4 deletions ...r-impl/impl/src/java/org/sakaiproject/portal/render/portlet/PortletToolRenderService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@
import org.apache.pluto.spi.PortletURLProvider;
import org.w3c.tidy.Tidy;

import org.sakaiproject.util.Web;
import org.sakaiproject.util.FormattedText;
import org.sakaiproject.util.api.FormattedText;
import org.sakaiproject.portal.api.Portal;
import org.sakaiproject.portal.api.PortalService;
import org.sakaiproject.portal.util.BufferedServletResponse;
Expand All @@ -67,6 +66,7 @@
import org.sakaiproject.portal.render.portlet.services.state.PortletStateEncoder;
import org.sakaiproject.portal.render.portlet.servlet.SakaiServletActionRequest;
import org.sakaiproject.portal.render.portlet.servlet.SakaiServletRequest;
import org.sakaiproject.component.cover.ComponentManager;
import org.sakaiproject.component.cover.ServerConfigurationService;
import org.sakaiproject.site.api.ToolConfiguration;
import org.sakaiproject.tool.api.Placement;
Expand Down Expand Up @@ -310,7 +310,7 @@ public String getContent() throws ToolRenderException
final PrintWriter printWriter = new PrintWriter(result);
log.error(bufferedException.getMessage(), bufferedException);
String storedContent = "<div class=\"portlettraceback\">\n" +
FormattedText.escapeHtml(result.toString(),true) +
ComponentManager.get(FormattedText.class).escapeHtml(result.toString(),true) +
"\n</pre>\n";
return storedContent;
}
Expand Down Expand Up @@ -360,7 +360,7 @@ public String getTitle() throws ToolRenderException
try
{
renderResponse();
return Web.escapeHtml(PortletStateAccess.getPortletState(req, window.getId().getStringId())
return ComponentManager.get(FormattedText.class).escapeHtml(PortletStateAccess.getPortletState(req, window.getId().getStringId())
.getTitle());
}
catch(Exception e)
Expand Down
29 changes: 16 additions & 13 deletions ...area/FCKeditor/connector/src/java/org/sakaiproject/connector/fck/FCKConnectorServlet.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,17 @@
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.fileupload.DiskFileUpload;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import org.apache.commons.lang3.StringUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

import org.sakaiproject.authz.api.SecurityAdvisor;
import org.sakaiproject.authz.api.SecurityService;
import org.sakaiproject.api.app.messageforums.entity.DecoratedForumInfo;
import org.sakaiproject.api.app.messageforums.entity.DecoratedTopicInfo;
import org.sakaiproject.component.cover.ComponentManager;
import org.sakaiproject.authz.api.SecurityAdvisor;
import org.sakaiproject.authz.api.SecurityService;
import org.sakaiproject.component.api.ServerConfigurationService;
import org.sakaiproject.component.cover.ComponentManager;
import org.sakaiproject.content.api.ContentCollection;
import org.sakaiproject.content.api.ContentCollectionEdit;
import org.sakaiproject.content.api.ContentHostingService;
Expand All @@ -82,7 +76,12 @@
import org.sakaiproject.tool.api.SessionManager;
import org.sakaiproject.util.ResourceLoader;
import org.sakaiproject.util.Validator;
import org.sakaiproject.util.FormattedText;
import org.sakaiproject.util.api.FormattedText;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

import lombok.extern.slf4j.Slf4j;

/**
* Conenctor Servlet to upload and browse files to a Sakai worksite for the FCK editor.<br>
Expand Down Expand Up @@ -133,6 +132,7 @@ public class FCKConnectorServlet extends HttpServlet {
private EntityBroker entityBroker;
private ServerConfigurationService serverConfigurationService = null;
private ResourceLoader resourceLoader = null;
private FormattedText formattedText;

/**
* Injects dependencies using the ComponentManager cover.
Expand Down Expand Up @@ -168,10 +168,13 @@ private void initialize() {
if (siteService == null) {
siteService = (SiteService) inject("org.sakaiproject.site.api.SiteService");
if (entityBroker == null) {
entityBroker = (EntityBroker) inject("org.sakaiproject.entitybroker.EntityBroker");
entityBroker = (EntityBroker) inject("org.sakaiproject.entitybroker.EntityBroker");
}
if (serverConfigurationService == null) {
serverConfigurationService = (ServerConfigurationService) inject("org.sakaiproject.component.api.ServerConfigurationService");
serverConfigurationService = (ServerConfigurationService) inject("org.sakaiproject.component.api.ServerConfigurationService");
}
if (formattedText == null) {
formattedText = (FormattedText) inject("org.sakaiproject.util.api.FormattedText");
}

//Default providers to exclude, add addition with the property textarea.hiddenProviders if needed
Expand Down Expand Up @@ -550,7 +553,7 @@ else if (requestStream != null) {

out.println("window.parent.OnUploadCompleted(" + status + ",'"
+ (attachment!=null?attachment.getUrl():"")
+ "','" + FormattedText.escapeJsQuoted(fileName) + "','" + errorMessage + "');");
+ "','" + formattedText.escapeJsQuoted(fileName) + "','" + errorMessage + "');");

out.println("</script>");
}
Expand Down
9 changes: 5 additions & 4 deletions velocity/tool/src/java/org/sakaiproject/vm/ActionURL.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@

import javax.servlet.http.HttpServletRequest;

import org.sakaiproject.component.cover.ComponentManager;
import org.sakaiproject.thread_local.cover.ThreadLocalManager;
import org.sakaiproject.tool.api.ToolURL;
import org.sakaiproject.tool.api.ToolURLManager;
import org.sakaiproject.util.FormattedText;
import org.sakaiproject.util.api.FormattedText;

/**
* <p>
Expand All @@ -55,7 +56,7 @@ public class ActionURL
protected String m_base = null;

/** parameters. */
protected Map m_parameters = new Hashtable();
protected Map m_parameters = new Hashtable<>();

/** The portlet window id, if any. */
protected String m_pid = null;
Expand Down Expand Up @@ -199,7 +200,7 @@ public ActionURL setPanel(String panel)
public String toString()
{
String toolURL = getToolURL();
if (toolURL != null) return FormattedText.sanitizeHrefURL(toolURL);
if (toolURL != null) return ComponentManager.get(FormattedText.class).sanitizeHrefURL(toolURL);

String rv = m_base;
char c = '?';
Expand Down Expand Up @@ -249,7 +250,7 @@ public String toString()
}

reset();
return FormattedText.sanitizeHrefURL(rv);
return ComponentManager.get(FormattedText.class).sanitizeHrefURL(rv);
}

private String getToolURL()
Expand Down
Loading

0 comments on commit 8fe191e

Please sign in to comment.