[PHP] 檢查 XML 文件結構

利用 SimpleXML 去檢查 XML 結構是否符合規格，為了讓這個程式可以多用途，採用了一個基準文件的作為結構準則，依據裡面定義的節點跟屬性，去檢查文件是否符合基本要求的格式。

原始碼

1. <?php 
2.  
3. /**檢查 XML 文件結構 
4. * @param string $baseFilePath 基準結構文件 
5. * @param string $checkFilePath 待檢查文件 
6. * @return bool 當結構與基準文件相符合時則回傳 true，否則是 false 
7. * */ 
8. function checkXmlFileStructure($baseFilePath,$checkFilePath){ 
9.    /*開啟 Base File*/ 
10.    if(!file_exists($baseFilePath)){ return false; } 
11.    $base = simplexml_load_file($baseFilePath); 
12.    if($base===false){ return false; } 
13.  
14.    /*開啟 Check File*/ 
15.    if(!file_exists($checkFilePath)){ return false; } 
16.    $check = simplexml_load_file($checkFilePath); 
17.    if($check===false){ return false; } 
18.  
19.    /*比較起始點的名稱*/ 
20.    if($base->getName() != $check->getName()){ return false; } 
21.  
22.    /*比較結構*/ 
23.    return checkXmlStructure($base,$check); 
24. } 
25.  
26. /**檢查 XML 結構 
27. * @param SimpleXMLElement $base 基準結構物件 
28. * @param SimpleXMLElement $check 待檢查 XML 物件 
29. * @return bool 當結構與基準物件相符合時則回傳 true，否則是 false 
30. * */ 
31. function checkXmlStructure($base,$check){ 
32.    /*檢查屬性*/ 
33.    foreach ($base->attributes() as $name => $baseAttr){ 
34.        /*必要的屬性不存在*/ 
35.        if(!isset($check->attributes()->$name)){ return false; } 
36.    } 
37.  
38.    /*當沒有子節點時，則檢查對象也不能有子節點*/ 
39.    if(count($base->children())==0){ 
40.        return (count($check->children())==0); 
41.    } 
42.  
43.    /*將檢查對象的子節點分群*/ 
44.    $checkChilds = array(); 
45.    foreach($check->children() as $name => $child){ 
46.        $checkChilds[$name][] = $child; 
47.    } 
48.  
49.    /*檢查子節點*/ 
50.    $checked = array(); 
51.    foreach($base->children() as $name => $baseChild){ 
52.        /*跳過已經檢查的子節點*/ 
53.        if(in_array($name, $checked)){ continue; } 
54.        $checked[] = $name; 
55.  
56.        /*檢查必要的子節點是否存在*/ 
57.        if(empty($checkChilds[$name])){ return false; } 
58.  
59.        foreach ($checkChilds[$name] as $child){ 
60.            /*遞迴檢查子節點*/ 
61.            if( !checkXmlStructure($baseChild, $child) ){ return false; } 
62.        } 
63.    } 
64.  
65.    return true; 
66. } 
67.  
68.  
69. /*==============================================================================*/ 
70.  
71. if(isset($_SERVER['argv'])){ 
72.    parse_str(preg_replace('/&[\-]+/','&',join('&',$_SERVER['argv'])), $_GET); 
73.  
74.    if(empty($_GET['base_file']) || empty($_GET['check_file'])){ 
75.        echo "Run: ".basename(__FILE__)." base_file=base.xml check_file=check.xml\n"; exit(1); 
76.    } 
77.  
78.    exit( checkXmlFileStructure($_GET['base_file'],$_GET['check_file']) ? 0 : 1); 
79.  
80. }else{ 
81.    if(empty($_GET['base_file']) || empty($_GET['check_file'])){ 
82.        echo "Run: ".basename(__FILE__)."?base_file=base.xml&check_file=check.xml<br />"; exit; 
83.    } 
84.  
85.    echo( checkXmlFileStructure($_GET['base_file'],$_GET['check_file']) ? '1' : '0'); 
86. } 

<?php

/**檢查 XML 文件結構
 * @param string $baseFilePath 基準結構文件
 * @param string $checkFilePath 待檢查文件
 * @return bool 當結構與基準文件相符合時則回傳 true，否則是 false
 * */
function checkXmlFileStructure($baseFilePath,$checkFilePath){
    /*開啟 Base File*/
    if(!file_exists($baseFilePath)){ return false; }
    $base = simplexml_load_file($baseFilePath);
    if($base===false){ return false; }

    /*開啟 Check File*/
    if(!file_exists($checkFilePath)){ return false; }
    $check = simplexml_load_file($checkFilePath);
    if($check===false){ return false; }

    /*比較起始點的名稱*/
    if($base->getName() != $check->getName()){ return false; }

    /*比較結構*/
    return checkXmlStructure($base,$check);
}

/**檢查 XML 結構
 * @param SimpleXMLElement $base 基準結構物件
 * @param SimpleXMLElement $check 待檢查 XML 物件
 * @return bool 當結構與基準物件相符合時則回傳 true，否則是 false
 * */
function checkXmlStructure($base,$check){
    /*檢查屬性*/
    foreach ($base->attributes() as $name => $baseAttr){
        /*必要的屬性不存在*/
        if(!isset($check->attributes()->$name)){ return false; }
    }

    /*當沒有子節點時，則檢查對象也不能有子節點*/
    if(count($base->children())==0){
        return (count($check->children())==0);
    }

    /*將檢查對象的子節點分群*/
    $checkChilds = array();
    foreach($check->children() as $name => $child){
        $checkChilds[$name][] = $child;
    }

    /*檢查子節點*/
    $checked = array();
    foreach($base->children() as $name => $baseChild){
        /*跳過已經檢查的子節點*/
        if(in_array($name, $checked)){ continue; }
        $checked[] = $name;

        /*檢查必要的子節點是否存在*/
        if(empty($checkChilds[$name])){ return false; }

        foreach ($checkChilds[$name] as $child){
            /*遞迴檢查子節點*/
            if( !checkXmlStructure($baseChild, $child) ){ return false; }
        }
    }

    return true;
}


/*==============================================================================*/

if(isset($_SERVER['argv'])){
    parse_str(preg_replace('/&[\-]+/','&',join('&',$_SERVER['argv'])), $_GET);

    if(empty($_GET['base_file']) || empty($_GET['check_file'])){
        echo "Run: ".basename(__FILE__)." base_file=base.xml check_file=check.xml\n"; exit(1);
    }

    exit( checkXmlFileStructure($_GET['base_file'],$_GET['check_file']) ? 0 : 1);

}else{
    if(empty($_GET['base_file']) || empty($_GET['check_file'])){
        echo "Run: ".basename(__FILE__)."?base_file=base.xml&check_file=check.xml<br />"; exit;
    }

    echo( checkXmlFileStructure($_GET['base_file'],$_GET['check_file']) ? '1' : '0');
}

使用方式(shell)

原始碼

1. php check_xml_file_structure.php base_file=base.xml check_file=check.xml 
2.  
3. if [ "j$?" != "j0" ]; then 
4.    echo "Run Error" 
5. fi 

php check_xml_file_structure.php base_file=base.xml check_file=check.xml

if [ "j$?" != "j0" ]; then
    echo "Run Error"
fi

測試範例 1
base_1.xml

原始碼

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <items> 
3.    <item> 
4.        <Category>Category文字</Category> 
5.        <Title>Title文字</Title> 
6.    </item> 
7. </items> 

<?xml version="1.0" encoding="UTF-8"?>
<items>
    <item>
        <Category>Category文字</Category>
        <Title>Title文字</Title>
    </item>
</items>

check_1.xml

原始碼

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <items> 
3.    <item> 
4.        <Category>Category文字</Category> 
5.        <Title>Title文字</Title> 
6.    </item> 
7.    <item> 
8.        <Category>Category文字</Category> 
9.        <Title>Title文字</Title> 
10.        <Description>Description文字</Description> 
11.    </item> 
12. </items> 

<?xml version="1.0" encoding="UTF-8"?>
<items>
    <item>
        <Category>Category文字</Category>
        <Title>Title文字</Title>
    </item>
    <item>
        <Category>Category文字</Category>
        <Title>Title文字</Title>
        <Description>Description文字</Description>
    </item>
</items>

測試範例 2
base_2.xml

原始碼

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <items> 
3.    <item category="Category文字" Title="Title文字"/> 
4. </items> 

<?xml version="1.0" encoding="UTF-8"?>
<items>
    <item category="Category文字" Title="Title文字"/>
</items>

check_2.xml

原始碼

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <items> 
3.    <item category="Category文字" Title="Title文字" Description="Description文字" /> 
4.    <item category="Category文字" Title="Title文字" /> 
5.    <item category="Category文字" Title="Title文字" Description="Description文字" /> 
6. </items> 

<?xml version="1.0" encoding="UTF-8"?>
<items>
    <item category="Category文字" Title="Title文字" Description="Description文字" />
    <item category="Category文字" Title="Title文字" />
    <item category="Category文字" Title="Title文字" Description="Description文字" />
</items>