在服务器端为 ColdFusion 实现 Showdown.js markdown 解析器

Question

这是一个“事实调查”问题，旨在了解使用 创建 ColdFusion UDF 来解析服务器上的 markdown 有多困难showdown.js 解析器。 已经有一个利用 showdown.js 的 java 实现（请参阅本文末尾的代码），我想了解如何为 ColdFusion 实现它。我没有 Java 经验，我不会特别称自己为“程序员”，但我不希望这阻止我尝试。

摘要

我想在服务器端运行 Shadown.js 以转换 markdown到 HTML。

为什么？

保存用户条目的两个版本，一个是 Markdown 格式，另一个是 HTML 格式，这样我们就可以向最终用户显示原始 Markdown 版本，以防他们想要编辑其条目。

为什么不使用服务器端解析器？

有两个原因：

1. 到目前为止，还没有用于此特定目的的 ColdFusion markdown 解析器
2. 在客户端使用 Showdown.js，然后在客户端使用不同的解析器服务器端将导致向客户端显示的预览与数据库中存储的版本之间的标记不一致。鉴于 markdown 的定义很松散，大多数解析器实现都会有细微的差异。

有一个非常好的博客条目讨论这个问题。

为什么不在客户端进行所有解析并发布两个版本？

我认为这不是一个安全的解决方案。我还认为用户可能会发布带有不匹配 HTML 的 Markdown。

是否有任何现有的实现？

有一个名为 CFShowdown 的实现，但它不是用于此特定目的。相反，它用于处理页面上的输出。 上述博客的评论部分具有由名为 David 的用户编写的纯 Java 实现：

ScriptEngineManager manager = new ScriptEngineManager();
ScriptEngine jsEngine = manager.getEngineByName("js");
try
{
    jsEngine.eval(new InputStreamReader(getClass().getResourceAsStream("showdown.js")));
    showdownConverter = jsEngine.eval("new Showdown.converter()");
}
catch (Exception e)
{
    log.error("could not create showdown converter", e);
}

try
{
    return ((Invocable) jsEngine).invokeMethod(
        showdownConverter, 
        "makeHtml", 
        markdownString
    ) + "";
}
catch (Exception e)
{
    log.error("error while converting markdown to html", e);
    return "[could not convert input]";
}

目标

创建一个 java 类，该类允许我们将此实现与 ColdFusion UDF 或组件内的自定义标记一起使用，类似于 < code>

由于我没有 Java 经验，因此我希望从用户那里获得一些关于从何处以及如何开始执行此任务的建议和意见。我创建了一个

Answer 1

将文件 showdown.js 和文件 markdown.txt （下面的示例）放在同一目录。

showdown.cfm

<cfscript>
manager = createObject("java", "javax.script.ScriptEngineManager").init();
jsEngine = manager.getEngineByName("js");

showdownJS = fileRead('#getDirectoryFromPath(getCurrentTemplatePath())#/showdown.js');

jsEngine.eval(showdownJS);
showdownConverter = jsEngine.eval("new Showdown.converter()");

markdownString = fileRead("#getDirectoryFromPath(getCurrentTemplatePath())#/markdown.txt");

args = [markdownString];

result = jsEngine.invokeMethod(
    showdownConverter,
    "makeHtml",
    args
) & "";
</cfscript>

ma​​rkdown.txt

Showdown Demo
-------------

You can try out Showdown on this page:

  - Type some [Markdown] text on the left side.
  - See the corresponding HTML on the right.

For a Markdown cheat-sheet, switch the right-hand window from *Preview* to *Syntax Guide*.

Showdown is a JavaScript port of the original Perl version of Markdown.  You can get the full [source code] by clicking on the version number at the bottom of the page.

Also check out [WMD, the Wysiwym Markdown Editor][wmd].  It'll be open source soon; email me at the address below if you'd like to help me test the standalone version.

**Start with a [blank page] or edit this document in the left window.**

  [Markdown]: http://daringfireball.net/projects/markdown/
  [source code]: http://attacklab.net/showdown/showdown-v0.9.zip
  [wmd]: http://wmd-editor.com/
  [blank page]: ?blank=1 "Clear all text"

更新

这是一个采用Adam Presley 在 Java 中的工作 并在 CFC 中完成这一切。请注意，我采用了他在 showdown.js 末尾添加的一点点魔法，并将其放入附加了返回值的 CFC 函数中（即 showdownAdapterJS()）。

氟氯化碳

<cfcomponent output="false" accessors="true">
    <cffunction name="init" output="false" access="public" returntype="Showdown" hint="Constructor">
        <cfset variables.manager = createObject("java", "javax.script.ScriptEngineManager").init()>
        <cfset variables.engine = manager.getEngineByName("javascript")>
        <cfreturn this/>
    </cffunction>

    <cffunction name="toHTML" output="false" access="public" returntype="any" hint="">
        <cfargument name="markdownText" type="string" required="true"/>
        <cfset var local = structNew()/>
        <cfset var bindings = variables.engine.createBindings()>
        <cfset var result = "">

        <cftry>
            <cfset bindings.put("markdownText", arguments.markdownText)>
            <cfset variables.engine.setBindings(bindings, createObject("java", "javax.script.ScriptContext").ENGINE_SCOPE)>
            <cfset var showdownJS = fileRead('#getDirectoryFromPath(getCurrentTemplatePath())#/showdown.js')>
            <cfset showdownJS &= showdownAdapterJS()>
            <cfset result = engine.eval(showdownJS)>
            <cfcatch type="javax.script.ScriptException">
                <cfset result = "The script had an error: " & cfcatch.Message>
            </cfcatch>
        </cftry>

        <cfreturn result>
    </cffunction>

    <cffunction name="showdownAdapterJS" output="false" access="private" returntype="string" hint="">
        <cfset var local = structNew()/>
<cfsavecontent variable="local.javascript">
<cfoutput>#chr(13)##chr(10)#var __converter = new Showdown.converter();
__converter.makeHtml(markdownText);</cfoutput>
</cfsavecontent>
        <cfreturn local.javascript>
    </cffunction>
</cfcomponent>

的使用

<cfset showdown = createObject("component", "Showdown").init()>
<cfset markdownString = fileRead("#getDirectoryFromPath(getCurrentTemplatePath())#/markdown.txt")>
<cfoutput>#showdown.toHTML(markdownString)#</cfoutput>

Answer 2

您可以使用 CFGroovy 在 CF 中运行服务器端 javascript - 它基本上允许您运行与 CFML 内联的任何 JSR-223 脚本语言。

Ben Nadel 有一个运行示例使用 CFGroovy 和 Rhino 的服务器端 javascript

该示例包含您需要的一切 - 假设您已经将 javascript 代码放在一起。

Answer 3

事实上，我已经将 Showdown 封装在一个可以在 ColdFusion 中使用的 Java 库中。我提供的示例（我承认文档很差）使用了自定义标记，但您可以像这样轻松地使用 Java 组件。

<cfset obj = createObject('java', 'com.adampresley.cfshowdown.Showdown').init() />
<cfset parsedText = obj.toHTML(trim(someMarkdownContent)) />

也许这有帮助？不管怎样，Markdown 万岁！ :)

Answer 4

鉴于 Markdown 不是一种常规语言，并且大多数实现都是一系列正则表达式，因此它们之间必然存在差异，正如您所指出的。几乎无法避免它。

如果您的目标只是：

1. 提供具有实时预览功能的客户端 Markdown 编辑器（如 Stack Overflow 问题/答案编辑器），并
2. 存储生成的 html 的相同处理副本以供最终用户显示

那么我只看到两个实际选项：

1. 在服务器端执行所有 Markdown 处理，并使用 AJAX 提交 Markdown 并获取更新的预览 html 完成预览（使用最终用于生成存储的 html 的同一库），或者
2. 执行所有 Markdown 处理客户端，并提交两者原始 Markdown 和生成的 HTML 作为内容合成表单的一部分并存储两者；这样您就可以显示原始 Markdown 进行编辑，并显示生成的 HTML 进行显示。

就我个人而言，我会选择选项 2。