Skip to content

Commit

Permalink
KNL-1234 Enable MathJax on content in resources. (sakaiproject#3069)
Browse files Browse the repository at this point in the history 
KNL-1234 Enable MathJax on content in resources.

Ideally this should be extracted out so that tools/plugins can contribute to the scripts, but to get it working we’re just putting the MathJax code in the kernel.
This also fixes a but where a site local skin wasn't getting picked up.

The default URL for which MathJax is loaded from is in kernel.properties now so it doesn’t need to be scatter about the codebase.
  • Loading branch information
@buckett
buckett authored Aug 24, 2016
1 parent b0520b7 commit 5812f71
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 11 deletions.
3 changes: 3 additions & 0 deletions kernel/component-manager/src/main/bundle/org/sakaiproject/config/kernel.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,9 @@ memory.org.sakaiproject.user.api.UserDirectoryService=maxElementsInMemory=100000
#KNL-1306 default
content.mimeMagic.ignorecontent.extensions=js

# KNL-1234 Enable MathJax on content in resources
portal.mathjax.src.path=https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default,Safe

# KNL-1399
copyright.type.default=

Expand Down
46 changes: 43 additions & 3 deletions kernel/kernel-impl/src/main/java/org/sakaiproject/content/impl/HtmlPageFilter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@

import java.text.MessageFormat;

import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.sakaiproject.component.api.ServerConfigurationService;
import org.sakaiproject.content.api.ContentFilter;
import org.sakaiproject.content.api.ContentResource;
Expand All @@ -30,6 +32,7 @@
import org.sakaiproject.entity.api.Reference;
import org.sakaiproject.entity.api.ResourceProperties;
import org.sakaiproject.site.api.Site;
import org.sakaiproject.site.api.SiteService;
import org.sakaiproject.util.Validator;

/**
Expand All @@ -41,6 +44,9 @@
*/
public class HtmlPageFilter implements ContentFilter {

private static final String MATHJAX_ENABLED = "mathJaxEnabled";
private static final String MATHJAX_SRC_PATH_SAKAI_PROP = "portal.mathjax.src.path";

private EntityManager entityManager;

private ServerConfigurationService serverConfigurationService;
Expand All @@ -56,6 +62,7 @@ public class HtmlPageFilter implements ContentFilter {
" <link href=\"{0}/tool_base.css\" type=\"text/css\" rel=\"stylesheet\" media=\"all\" />\n" +
" <link href=\"{0}/{1}/tool.css\" type=\"text/css\" rel=\"stylesheet\" media=\"all\" />\n" +
" <script type=\"text/javascript\" language=\"JavaScript\" src=\"/library/js/headscripts.js\"></script>\n" +
"{3}"+
" <style>body '{ padding: 5px !important; }'</style>\n" +
" </head>\n" +
" <body>\n";
Expand All @@ -64,6 +71,10 @@ public class HtmlPageFilter implements ContentFilter {
" </body>\n" +
"</html>\n";

private String mathjaxTemplate =
" <script type=\"text/x-mathjax-config\">\nMathJax.Hub.Config('{'\ntex2jax: '{' inlineMath: [[''\\\\('',''\\\\)'']] '}'\n'}');\n</script>\n" +
" <script src=\"{0}\" language=\"JavaScript\" type=\"text/javascript\"></script>\n" ;

public void setEntityManager(EntityManager entityManager) {
this.entityManager = entityManager;
}
Expand Down Expand Up @@ -94,7 +105,7 @@ public ContentResource wrap(final ContentResource content) {
return content;
}
Reference contentRef = entityManager.newReference(content.getReference());
Reference siteRef = entityManager.newReference(contentRef.getContext());
Reference siteRef = entityManager.newReference(Entity.SEPARATOR+ SiteService.SITE_SUBTYPE+ Entity.SEPARATOR+ contentRef.getContext());
Entity entity = siteRef.getEntity();

String addHtml = content.getProperties().getProperty(ResourceProperties.PROP_ADD_HTML);
Expand All @@ -110,7 +121,14 @@ public ContentResource wrap(final ContentResource content) {
String docType = serverConfigurationService.getString("content.html.doctype", "<!DOCTYPE html>");
header.append(docType + "\n");
}
header.append(MessageFormat.format(headerTemplate, skinRepo, siteSkin, title));
StringBuilder additionalScripts = new StringBuilder();
if (isMathJaxEnabled(entity)) {
additionalScripts.append(MessageFormat.format(mathjaxTemplate,
serverConfigurationService.getString(MATHJAX_SRC_PATH_SAKAI_PROP
)
));
}
header.append(MessageFormat.format(headerTemplate, skinRepo, siteSkin, title, additionalScripts));

return new WrappedContentResource(content, header.toString(), footerTemplate, detectHtml);
}
Expand All @@ -136,8 +154,30 @@ private String getSiteSkin(Entity entity) {
siteSkin = site.getSkin();
}
}

return siteSkin;
}

/**
* Check if MathJax should be enabled for this site.
* @param entity The Site that the content is in.
* @return <code>true</code> if we should enabled MathJax
*/
private boolean isMathJaxEnabled(Entity entity) {
if (serverConfigurationService.getBoolean("portal.mathjax.enabled", true)) {
if (entity instanceof Site) {
Site site = (Site)entity;
String strMathJaxEnabled = site.getProperties().getProperty(MATHJAX_ENABLED);
if (!StringUtils.isBlank(strMathJaxEnabled))
{
String[] mathJaxTools = strMathJaxEnabled.split(",");
if (ArrayUtils.contains(mathJaxTools, "sakai.resources"))
{
return true;
}
}
}
}
return false;
}

}
3 changes: 1 addition & 2 deletions portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/SkinnableCharonPortal.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,8 @@ public class SkinnableCharonPortal extends HttpServlet implements Portal
private static final String MATHJAX_ENABLED = "mathJaxEnabled";
private static final String MATHJAX_SRC_PATH_SAKAI_PROP = "portal.mathjax.src.path";
private static final String MATHJAX_ENABLED_SAKAI_PROP = "portal.mathjax.enabled";
private static final String SRC_PATH_SAKAI_PROP_DEFAULT = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default,Safe";
private static final boolean ENABLED_SAKAI_PROP_DEFAULT = true;
private static final String MATHJAX_SRC_PATH = ServerConfigurationService.getString(MATHJAX_SRC_PATH_SAKAI_PROP, SRC_PATH_SAKAI_PROP_DEFAULT);
private static final String MATHJAX_SRC_PATH = ServerConfigurationService.getString(MATHJAX_SRC_PATH_SAKAI_PROP);
private static final boolean MATHJAX_ENABLED_AT_SYSTEM_LEVEL = ServerConfigurationService.getBoolean(MATHJAX_ENABLED_SAKAI_PROP, ENABLED_SAKAI_PROP_DEFAULT) && !MATHJAX_SRC_PATH.trim().isEmpty();

private PortalSiteHelper siteHelper = null;
Expand Down
3 changes: 1 addition & 2 deletions portal/portal-tool/tool/src/java/org/sakaiproject/portal/tool/ToolPortal.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,8 @@ public class ToolPortal extends HttpServlet
private static final String MATHJAX_ENABLED = "mathJaxEnabled";
private static final String MATHJAX_SRC_PATH_SAKAI_PROP = "portal.mathjax.src.path";
private static final String MATHJAX_ENABLED_SAKAI_PROP = "portal.mathjax.enabled";
private static final String SRC_PATH_SAKAI_PROP_DEFAULT = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default,Safe";
private static final boolean ENABLED_SAKAI_PROP_DEFAULT = true;
private static final String MATHJAX_SRC_PATH = ServerConfigurationService.getString(MATHJAX_SRC_PATH_SAKAI_PROP, SRC_PATH_SAKAI_PROP_DEFAULT);
private static final String MATHJAX_SRC_PATH = ServerConfigurationService.getString(MATHJAX_SRC_PATH_SAKAI_PROP);
private static final boolean MATHJAX_ENABLED_AT_SYSTEM_LEVEL = ServerConfigurationService.getBoolean(MATHJAX_ENABLED_SAKAI_PROP, ENABLED_SAKAI_PROP_DEFAULT) && !MATHJAX_SRC_PATH.trim().isEmpty();

/**
Expand Down
3 changes: 1 addition & 2 deletions ...o/samigo-app/src/java/org/sakaiproject/tool/assessment/ui/bean/delivery/DeliveryBean.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,7 @@ public class DeliveryBean

private static final String MATHJAX_ENABLED = "mathJaxEnabled";
private static final String MATHJAX_SRC_PATH_SAKAI_PROP = "portal.mathjax.src.path";
private static final String SRC_PATH_SAKAI_PROP_DEFAULT = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default,Safe";
private static final String MATHJAX_SRC_PATH = ServerConfigurationService.getString(MATHJAX_SRC_PATH_SAKAI_PROP, SRC_PATH_SAKAI_PROP_DEFAULT);
private static final String MATHJAX_SRC_PATH = ServerConfigurationService.getString(MATHJAX_SRC_PATH_SAKAI_PROP);

private String assessmentId;
private String assessmentTitle;
Expand Down
3 changes: 1 addition & 2 deletions site-manage/site-manage-tool/tool/src/java/org/sakaiproject/site/tool/MathJaxEnabler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ public class MathJaxEnabler
private static final String SRC_PATH_SAKAI_PROP = "portal.mathjax.src.path";
private static final String VERSION_SERVICE_SAKAI_PROP = "version.service";
private static final String VERSION_SERVICE_DEFAULT = "Sakai";
private static final String SRC_PATH_SAKAI_PROP_DEFAULT = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default,Safe";
private static final boolean ENABLED_SAKAI_PROP_DEFAULT = true;
private static final boolean ENABLED_SAKAI_NEW_SITE_DEFAULT = false;

Expand All @@ -62,7 +61,7 @@ public class MathJaxEnabler
private static final String PARAM_MATHJAX_ALLOWED_KEY = "allowMathJax";
private static final String TOOL_DELIM = ",";

private static final String SRC_PATH = ServerConfigurationService.getString(SRC_PATH_SAKAI_PROP, SRC_PATH_SAKAI_PROP_DEFAULT);
private static final String SRC_PATH = ServerConfigurationService.getString(SRC_PATH_SAKAI_PROP);
private static final boolean ENABLED_AT_SYSTEM_LEVEL = ServerConfigurationService.getBoolean(ENABLED_SAKAI_PROP, ENABLED_SAKAI_PROP_DEFAULT) && !SRC_PATH.trim().isEmpty();
private static final boolean ENABLED_AT_NEW_SITE_CREATION_LEVEL = ServerConfigurationService.getBoolean(ENABLED_SAKAI_PROP_NEW_SITE, ENABLED_SAKAI_NEW_SITE_DEFAULT) && ENABLED_AT_SYSTEM_LEVEL;
private static final String SAKAI_SERVICE = ServerConfigurationService.getString(VERSION_SERVICE_SAKAI_PROP, VERSION_SERVICE_DEFAULT);
Expand Down

0 comments on commit 5812f71

Please sign in to comment.