我的 XForms 專書在 2003 年秋天同時於實體書店與網路發行。時間不長,我就收到大量書讀者的來信,內容幾乎都是 XForms 出了問題,附件往往是一兩頁錯漏處處的 XML 原始碼。
一般來說我樂於回覆郵件,但一頁一頁翻別人的 XML、找出常見的打錯字問題,既不愉快又慢。我需要一個更好的辦法。
我是「建設性偷懶」的信徒,於是決定寫一個線上工具:接受 XForms 文件作為輸入,然後把裡面所有錯誤或可疑的標記結構都報告出來。我從那些來信文件中歸納出讀者最常犯的錯誤樣本,兩者結合之後,就成了一套能讓表單作者自己揪出問題的工具。
XForms 1.0 規範定義了一組元素、屬性與內容模型,但它刻意沒有定義根元素——這件事留給宿主語言去決定。最常見的兩種宿主語言是 XHTML 與 SVG,但原則上幾乎任何 XML 詞彙表都能勝任。因此,驗證器的第一項任務就是從文件中把 XForms 的部分分離出來。為此我自創了「XForms 島」這個說法。
由於 XForms 把用途與表示分開,除了最簡單的表單之外,多數文件至少會有兩個 XForms 島:一個是 XForms Model(定義表單做什麼),一個是 XForms User Interface(定義表單長什麼樣)。
清單 1 是一個簡單的 XForms + XHTML 文件——或許過於簡單,但其中藏著一個很典型的錯誤。
清單 1. 一個普通但帶有錯誤的 XForms + XHTML 文件
<?XML version="1.0"?>
<html XMLns="https://www.w3.org/1999/xHtml"
XMLns:x="https://www.w3.org/2002/xforms"
xmlns:ev="https://www.w3.org/2001/XML-events">
<head>
<title>Basic mixed document</title>
<x:model>
<x:instance>
<!-- @@@ forgot XMLns="" on <root> @@@ -->
<root>
<child/>
</root>
</x:instance>
<x:bind nodeset="child" required="1"/>
</x:model>
</head>
<body>
<x:input ref="child">
<x:label>Label</x:label>
</x:input>
</body>
</Html>
清單 1 顯然有兩個 XForms 島:x:model 與 x:input。問題是程式碼該如何定位這兩處?其實不難,因為能標記為 XForms 島的元素必須同時滿足兩個條件:
這個判斷可以用 XPath 完成,但我更想試試用 Python 處理 XML 的另一種路徑。於是我寫了一個過濾器函式,用來判斷某個節點是否開啟了一座 XForms 島。
清單 2. 挑出 XForms 島
# extract islands
def island_filter(node, usedns):
"""
An 'island' element has
1) the XForms NS
2) no ancestors with the XForms NS
usedns is a string containing the XForms Namespace URI
"""
if node.type != "element": return False # skip non-elements
rc = True
if (get_element_ns(node) != usedns): rc = False
node = node.parent
while node is not None:
if (node.type=="element" and get_element_ns(node)==usedns):
rc = False
break
node = node.parent
return rc
def get_element_ns(elem):
ns = None
try:
ns = elem.ns().content
except libXML2.treeError, e:
pass
return ns
驗證器會把找到的 XForms 島存起來以備後續處理。清單 1 中的錯誤(如註解所述)在於不小心把 root 元素留在了預設的 XHTML 命名空間裡。這類問題以及其他相似狀況,可以用下面的 XPath 檢查探測出來,它會回傳可疑的元素節點。
清單 3. 用 XPath 檢查命名空間的漏洞
//xf:instance//*[namespace-uri(.)=namespace-uri(/*) or
namespace-uri(.)=$usedns]
這裡有兩點值得注意。第一,因為清單 3 不預設宿主語言的結構,所以大量使用了 XPath 的 // 縮寫形式,透過 descendant-or-self 軸搜尋整份文件。第二,XPath 中的命名空間前綴對應(xf:)不必與目標文件使用的一致(x:),兩者是各自獨立的。
這個測試檢查 x:instance 的後代節點,看它們是否落在 XForms 命名空間或根節點的命名空間中。嚴格來說,名稱的限定部分命中這個條件是完全合法的,所以驗證器不會直接判錯,而是發出一則警告——畢竟它同时也是發現清單 1 那類編輯疏失的好機會。
另一種常見錯誤是 ID 與 IDREF 對不上。這個問題有部分歷史成因:定義 ID 的機制原本依附在 DTD 上。一些工具(在很大程度上取決於作者如何看待 XML Schema 與 Infoset)也允許透過 Schema 資料型別來定義 ID。但實務上你很少看到這類定義,更常遇到的是恰好命名為 id 的普通屬性。
這種情況不太理想,但實用的驗證工具必須處理它。驗證器的做法是:找出 XForms 中所有型別為 IDREF 的屬性,先嘗試內建的 id() 函式;若找不到對應元素,就退回用 XPath 尋找名為 id 或 xml:id 的屬性(後者依據當時尚未定案的 W3C 草案)。程式碼如下:
//*[@id='idstr' or @XML:id='idstr']
最後一步是分析每座 XForms 島,並用 RELAX NG 驗證它。這件事比表面看起來複雜,因為 XForms 的每個部分(例如 label)都可能嵌入來自宿主語言的標記,更别提那些到處都允許存在的屬性。
為此,驗證器採用了一套高度模組化的 RELAX NG 模式,把它整合進一個非常寬容的宿主語言框架中。所謂「高度模組化」,指的是每個元素定義、每組元素屬性、每個內容模型都被賦予唯一名稱,可以獨立擴充。清單 4 示範了處理單一元素定義的過程,使用 RELAX NG 緊湊語法。
清單 4. RELAX NG 模組化的元素定義
Common.Attributes = empty
Single.Node.Binding.Attributes = attribute bind { xsd:NCName } |
(attribute model { xsd:NCName }?, attribute ref { xsd:string })
UI.Common.Attributes &=
#host language to add Accesskey, navindex, etc. here
attribute appearance { xsd:QName { pattern = "[^:]+:[^:]+" } |
"minimal" | "compact" | "full" }?
Select = element select { Select.Attributes, Select.Content }
Select.Attributes &=
Common.Attributes,
Single.Node.Binding.Attributes,
UI.Common.Attributes,
attribute selection { "open" | "closed" }?,
attribute incremental { xsd:boolean }?
Select.Content = Label, List.UI.Common.Content, UI.Common.Content
值得留意的是,即使這裡出現了型別為 xsd:NCName 的 IDREF 屬性,也只做詞法層次的驗證。如前所述,真正的 ID–IDREF 關聯檢查是在另一個層次上進行的。把各成分分開定義的主要好處是擴充容易——例如想為所有表單控制項加上 class 屬性,只需改一處。
而這正是宿主語言模式要做的事。驗證器的這部分仍在開發中,但清單 5 說明了宿主語言該如何定義。
清單 5. XForms + 宿主語言定義
Common.Attributes &=
attribute id { xsd:NCName }?,
attribute XML:id { xsd:NCName }?,
attribute class { xsd:NMTOKENS }?
只要把這段內容包含進 XForms 的主模式,就能擴充原本的定義,讓 class、id 這類日常常用結構順利通過驗證。由於被包含的宿主語言片段幾乎沒有格式限制,這一部分仍需依實際用法進一步調整。
驗證器在執行過程中會把結果記錄到記憶體中的一份 XML 文件,最後透過 XSL 轉換成 HTML 並送出。
命名空間一直是個微妙的話題,對作者尤其如此。標準化的努力能讓事情變簡單,而針對這個問題,目前有兩套正在發展中的標準。
第一套被稱為 Document Schema Definition Languages(文件模式定義語言,簡稱 DSDL),各部分的進度不一,但都朝著 ISO Final Draft International Standard 的方向前進。這組標準被切成十個部分,本身就說明了整個驗證議題的複雜程度。其中包含 RELAX NG 的定義(第 2 部分)、Schematron(第 3 部分),以及一套類似 XForms 島、能從大型文件中挑選驗證區段的機制(第 4 部分)。其餘部分涵蓋字元指示表驗證、結合不同模式語言的方法等各種領域。
第二套相關標準與工具集是 OASIS 的 CAM,也就是 Content Assembly Mechanism(內容組裝機制)。這項技術可以用業務規則來定義、驗證與組裝文件,把模式片段組織起來,進而拼出更大的複合文件。
總的來說,混合命名空間的驗證是 XML 開發中一個很值得深挖的領域。這個 XForms 驗證器仍在持續開發,而對有興趣的人而言,它本身就是一個很好的學習題材。