编写规则集 (Sun Java System Portal Server Secure Remote Access 7.2 管理指南)

Sun Java System Portal Server Secure Remote Access 7.2 管理指南

编写规则集

有关定义规则集的详细信息，参见 Portal Server 管理指南。创建新规则集后，需要定义所需的规则。

本节涵盖以下主题：

公共接口（规则集 DTD）

规则集 DTD：

<?xml version="1.0" encoding="UTF-8"?>
<!--
The following constraints are not represented in DTD, but taken care of programmatically
    1. In a Rule, All Mandatory attributes cannot be "*".
    2. Only one instance of the below elements is allowed, but in any order.
    1)HTMLRules
    2)JSRules
    3)XMLRules
    3. ID should always be in lower case.
-->
<!ENTITY % eURL ’URL’>
<!ENTITY % eEXPRESSION ’EXPRESSION’>
<!ENTITY % eDHTML ’DHTML’>
<!ENTITY % eDJS ’DJS’>
<!ENTITY % eSYSTEM ’SYSTEM’>

<!ENTITY % ruleSetElements ’(HTMLRules | JSRules | XMLRules)?’>
<!ENTITY % htmlElements ’(Form | Applet | Attribute)*’>
<!ENTITY % jsElements ’(Variable | Function)*’>
<!ENTITY % xmlElements ’(Attribute | TagText)*’>

<!ELEMENT RuleSet (%ruleSetElements;,%ruleSetElements;,%ruleSetElements;)>
<!ATTLIST RuleSet
    id ID #REQUIRED
    extends CDATA "none"
>

<!-- Rules for identifying rules in HTML content -->
<!ELEMENT HTMLRules (%htmlElements;)>
<!ELEMENT Form EMPTY>
<!ATTLIST Form
    name CDATA #REQUIRED
    field CDATA #REQUIRED
    valuePatterns CDATA ""
    source CDATA "*"
>

<!ELEMENT Applet EMPTY>
<!ATTLIST Applet
    code CDATA #REQUIRED
    param CDATA "*"
    valuePatterns CDATA ""
    source CDATA "*"
>

<!-- Rules for identifying rules in JS content -->
<!ELEMENT JSRules (%jsElements;)>
<!ELEMENT Variable EMPTY>
<!ATTLIST Variable
    name CDATA #REQUIRED
    type (%eURL; | %eEXPRESSION; | %eDHTML; | %eDJS; | %eSYSTEM;) "EXPRESSION"
    source CDATA "*"
>

<!ELEMENT Function EMPTY>
<!ATTLIST Function
    name CDATA #REQUIRED
    paramPatterns CDATA #REQUIRED
    type (%eURL; | %eEXPRESSION; | %eDHTML; | %eDJS;) "EXPRESSION"
    source CDATA "*"
>

<!-- Rules for identifying rules in XML content -->
<!ELEMENT XMLRules (%xmlElements;)>
<!ELEMENT TagText EMPTY>
<!ATTLIST TagText
    tag CDATA #REQUIRED
    attributePatterns CDATA ""
    source CDATA "*"
>

<!ELEMENT Attribute EMPTY>
<!ATTLIST Attribute
    name CDATA #REQUIRED
    tag CDATA "*"
    valuePatterns CDATA ""
    type (%eURL; | %eDHTML; | %eDJS; ) "URL"
    source CDATA "*"
>

注 –

除必需的属性值不能只为 * 以外，您可以使用 * 作为规则值的一部分。此类规则会被忽略，但会将消息记录在 RuleSetInfo 日志文件中。有关该日志文件的信息，参见调试文件名称。

XML DTD 示例

本节包含一个示例规则集。第 140 页的“案例研究”用于举例说明重写器是如何解释这些规则的。

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Rules for integrating a mail client with the gateway.
-->
<!DOCTYPE RuleSet SYSTEM "jar://rewriter.jar/resources/RuleSet.dtd">
<RuleSet type="GROUPED" id="owa">
<HTMLRules>
<Attribute name="action" />
<Attribute name="background" />
<Attribute name="codebase" />
<Attribute name="href" />
<Attribute name="src" />
<Attribute name="lowsrc" />
<Attribute name="imagePath" />
<Attribute name="viewClass" />
<Attribute name="emptyURL" />
<Attribute name="draftsURL" />
<Attribute name="folderURL" />
<Attribute name="prevMonthImage" />
<Attribute name="nextMonthImage" />
<Attribute name="style" />
<Attribute name="content" tag="meta" />
</HTMLRules>
<JSRules>
<!-- Rules for Rewriting JavaScript variables in URLs -->
<Variable name="URL"> _fr.location </Variable>
<Variable name="URL"> g_szUserBase </Variable>
<Variable name="URL"> g_szPublicFolderUrl </Variable>
<Variable name="URL"> g_szExWebDir </Variable>
<Variable name="URL"> g_szViewClassURL </Variable>
<Variable name="URL"> g_szVirtualRoot </Variable>
<Variable name="URL"> g_szBaseURL </Variable>
<Variable name="URL"> g_szURL </Variable>
<Function name="EXPRESSION" name="NavigateTo" paramPatterns="y"/>
</JSRules>
<XMLRules>
<Attribute name="xmlns"/>
<Attribute name="href" tag="a"/>
<TagText tag="baseroot" />
<TagText tag="prop2" />
<TagText tag="prop1" />
<TagText tag="img" />
<TagText tag="xsl:attribute"
attributePatterns="name=src" />
</XMLRules>
</RuleSet>

规则编写步骤

编写规则的一般程序为：

确定哪些目录包含内容需重写的 HTML 页。
在这些目录中，确定需重写的页。
确定各页需重写的 URL。确定大多数 URL 的简便方法是搜索“http”和“/”。
确定 URL 的内容类型：HTML、JavaScript 或 XML。
编写上述各 URL 所需的重写规则，这可通过在 Access Manager 管理控制台的 Portal Server 配置下编辑重写器服务中的必需规则集来完成。
将所有规则合并到该域的规则集中。

规则集指导原则

当创建规则集时，请谨记以下内容：

特定主机的优先顺序以匹配最长的 URL 为基础。例如，对于以下规则集
```
mail1.central.abc.com|iplanet_mail_ruleset
*.sfbay.abc.com|sfbay_ruleset
*.abc.com|generic_ruleset
```
由于 sfbay_ruleset 匹配最长，因此使用它。
规则集中的规则会依次应用于页面中的每条语句，直到有一项规则与某条语句相匹配为止。

编写规则时，切记不要忘了规则的顺序。规则是按它们在规则集中的出现顺序应用于页中的语句的。如果既有特定规则又有包含 "*" 的一般规则，要先定义特定规则，然后再定义一般规则。否则，一般规则将先于特定规则应用于所有语句。
所有规则都需要包括在 <RuleSet> </RuleSet> 标记内。
在规则集的 <HTMLRules> </HTMLRules> 部分加入需要重写 HTML 内容的所有规则。
在规则集的 <JSRules> </JSRules> 部分加入需要重写 JavaScript 内容的所有规则。
在规则集的 <XMLRules> </XMLRules> 部分加入需要重写 XML 内容的所有规则。
在内联网页中，确定需要重写的 URL，并在规则集的适当部分（HTML、JSRules 或 XMLRules）加入所需规则。
将规则集分配给所需的域。

重新启动网关以使所有更改生效：

gateway-install-root/SUNWportal/bin/gateway -n gateway-profile-name start

定义规则集根元素

规则集根元素有两个属性：

RuleSetName，例如，default_ruleset。在规则集到 URI 的映射中会引用此名称。
Extends。该属性是指规则集的继承功能。该值指向您希望从中派生出规则集的规则集。

可使用值 none 表示这个新的独立规则集不依赖于其他任何规则集，或者指定 RuleSetName 表示您的规则集依赖于另一规则集。

使用递归功能

重写器使用递归功能对同一模式进行搜索，直到匹配字符串模式的末尾。

例如，重写器解析以下字符串时：

<a href="src=abc.jpg,src=bcd.jpg,src=xyz.jpg>

规则

<Attribute name="href" valuePatterns="*src=**"/>

仅重写首先出现的模式，其形式如下：

<a href="src=http://jane.sun.com/abc.jpg>

如果使用递归选项

<Attribute name="href" valuePatterns="REC:*src=**"/>;

重写器会对同一模式进行搜索，直到匹配字符串模式的末尾，因此输出为：

<a href="src=http://jane.sun.com/abc.jpg,src=http://jane.sun.com/bcd.jpg,src=http://jane.sun.com/xyz.jpg>