chapter 03-05

資料的存取 (網頁端程式-進階)

使用基本模式的 get 取得資料時, 對於 gd 類型的資料會一次取出全部, 無法指定只要取出某幾筆資料, 使用進階模式可以指定只取出某幾筆資料.

此部分除了網頁端之外還需要撰寫 CGI 模組處理要取出哪幾筆資料.

分成 [網頁端] 和 [CGI 端] 說明.

使用的資料模型範例如下 :

<?xml version="1.0"?>

<base version="1.0">
<device type="gs" max="1" save="1">
  <ekey type="ek">0</ekey>
  <descript type="s:256">Network-Device</descript>
  <serial_number type="b:10">0022E5A1CC9F</serial_number>

  <system type="gs" max="1" save="1">
    <ekey type="ek">0</ekey>
    <date type="s:12">2015/01/01</date>
    <ip_addr type="s:46">192.168.1.1</ip_addr>
    <uptime type="iull">0</uptime>
    <loading type="fd">0</loading>
  </system>

  <vap type="gd" max="16" save="1">
    <ekey type="ek">0</ekey>
    <ssid type="s:64"></ssid>
    <channel type="iui">0</channel>

    <extra type="gs" max="1" save="1">
      <ekey type="ek">0</ekey>
      <hidden type="isc">0</hidden>
      <tx_power type="iss">0</tx_power>
    </extra>

    <station type="gd" max="32" save="1">
      <ekey type="ek">0</ekey>
      <mac_addr type="s:18">00:00:00:00:00:00</mac_addr>
      <rule type="rk">0</rule>

      <user type="gd" max="8" save="1">
        <ekey type="ek">0</ekey>
        <name type="s:32"></name>
        <gender type="iuc">0</gender>
      </user>
    </station>
  </vap>

  <limit type="gd" max="64" save="1">
    <ekey type="ek">0</ekey>
    <name type="s:32"></name>
    <priority type="isi">-1</priority>
  </limit>

  <filter type="gs" max="1" save="0">
    <ekey type="ek">0</ekey>
    <rule1 type="isi">0</rule1>
  </filter>
</device>
</base>

網頁端

進階模式的 get 指令格式.

讀出資料 (get)

格式 :

"&get.$(mask_path)=$(function_name)"

$(mask_path)	目標的路徑 [詳細]
$(function_name)	需要在 CGI 模組撰寫對應的的處理函式, 需要指定處理的函式

注意事項 :

01.	資料存取模式可以是 mcm_session_permission.ro 或 mcm_session_permission.rw.
02.	CGI 端的處理函式的資料存取模式會繼承網頁端指定的模式.
03.	只有含有任意一個 gd 類型資料的路徑會執行指定的 CGI 端的處理函式. [備註-01]
04.	如果同時設定了多個 get 指令, 而且指令之間有階層關係, 則需要注意指令的順序. [備註-02a] [備註-02b]
05.	只會讀出目標本身的資料, 不會讀出 child-group 的資料.
06.	得到的資料是 JSON 格式.

範例 :

"&get.device.vap.*=find_5g_vap"
取出 vap 資料時, 執行 CGI 模組的 find_5g_vap() 函式, 指定只取出需要哪幾筆資料.

"&get.device.vap.*.station.*=find_mobile_station"
取出 station 資料時, 執行 CGI 模組的 find_idle_station() 函式, 指定只取出需要哪幾筆資料.

備註-01 (只有含有任意一個 gd 類型資料的路徑會執行指定的 CGI 端的處理函式) :

"&get.device=update_device"
device 是 gs 類型, update_device() 不會被執行.

"&get.device.system=get_load"
device 和 system 都是 gs 類型, get_load() 不會被執行.

"&get.device.vap.*=find_5g_vap"
device 是 gs 類型, vap 是 gd 類型, find_5g_vap() 會被執行.

"&get.device.vap.*.extra=find_hidden_vap"
device 是 gs 類型, vap 是 gd 類型, extra 是 ds 類型, find_hidden_vap() 會被執行.

備註-02a (如果同時設定了多個 get 指令, 而且指令之間有階層關係, 則需要注意指令的順序) :

CGI 端在處理 get 指令時, 會依照路徑的階層由上到下處理.
01. 對於路徑上非最後一層, 檢查是否已經處理過 (多條 get 指令的情況).
    01. 沒處理過, 取出資料的索引.
    02. 有處理過, 跳過不處理.
02. 對於路徑上的最後一層, 檢查是否已經處理過 (多條 get 指令的情況).
    01. 沒處理過, 取出資料的索引和內容.
    02. 有處理過, 因為不允許有重複的指令, 所以實際上會是在其他 get 指令的非最後一層被處理,
        也就是在其他地方已經取出資料的索引, 補上這些資料的內容.

例如-01 (單條 get 指令) :
req_cmd += "&get.device.vap.*.station.*";
device  => 取出資料索引.
vap     => 取出每個 device 之下的 vap 的資料索引.
station => 取出每個 vap 之下的 station 的資料索引和內容.

例如-02 (多條 get 指令) :
req_cmd += "&get.device.vap.*" +
           "&get.device.vap.*.station.*";
處理 "&get.device.vap.*"
device => 取出資料索引.
vap    => 取出每個 device 之下的 vap 的資料索引和內容.
處理 "&get.device.vap.*.station"
device  => 已經處理過, 跳過.
vap     => 已經處理過, 跳過.
station => 取出每個 vap 之下的 station 的資料索引和內容.

例如-03 (多條 get 指令) :
req_cmd += "&get.device.vap.*.station.*" +
           "&get.device.vap.*";
處理 "&get.device.vap.*.station"
device  => 取出資料索引.
vap     => 取出每個 device 之下的 vap 的資料索引.
station => 取出每個 vap 之下的 station 的資料索引和內容.
處理 "&get.device.vap.*"
device  => 已經處理過, 跳過.
vap     => 已經處理過 (只有資料索引), 補上這些資料的內容.

在一般模式的情況下多個 get 指令可以不用照順序排列 (範例 02 和 03).

CGI 端

模組程式要放在 mint_cm/mcm_cgi/mcm_cgi_config_module
沒有限制函式的放置方式, 可以依據不同的功能將各種函式分類放在不同的檔案.

步驟-01 : 加入基本的標頭檔 :

#include <stdlib.h>
#include "mcm_lib/mcm_lheader/mcm_type.h"
#include "mcm_lib/mcm_lheader/mcm_size.h"
#include "mcm_lib/mcm_lheader/mcm_connect.h"
#include "mcm_lib/mcm_lheader/mcm_return.h"
#include "mcm_lib/mcm_lheader/mcm_data_exinfo_auto.h"
#include "mcm_lib/mcm_lulib/mcm_lulib_api.h"
#include "mcm_cgi_module_debug.h"

步驟-02 : 加入處函式.
函式格式 :

int $(function_name)(
    struct mcm_lulib_lib_t *this_lulib,
    MCM_DTYPE_EK_TD part_level,
    MCM_DTYPE_EK_TD *part_key,
    MCM_DTYPE_EK_TD **key_list_buf,
    MCM_DTYPE_EK_TD *key_count_buf)
{
    ...
}

$(function_name)
自定義的函式名稱.

參數的用途 :

參數

說明

struct mcm_lulib_lib_t *
this_lulib

紀錄 mcm_lulib_api 的資料 [詳細]

注意事項 :

01.	CGI 會處理釋放使用權的動作, 不可在模組函式內對 this_lulib 使用 mcm_lulib_exit()

MCM_DTYPE_EK_TD
part_level

紀錄目前是要處理第幾層路徑 (1 ~ N)

CGI 處理路徑時會逐層處理, 如果該層路徑是 gd 類型就會呼叫模組函式, 並指出現在是第幾層路徑, 如果路徑上有多個 gd 類型則會呼叫多次模組函式

例如 :

"&get.device.vap.*=find_5g_vap"
device 是第 1 層, vap 是第 2 層,
處理 vap 時因為是 gd 類型所以會呼叫模組函式, part_level = 2.

"&get.device.vap.*.extra=find_hidden_vap"
處理 vap 時因為是 gd 類型所以會呼叫模組函式, part_level = 2,
處理 extra 時因為是 gs 類型所以不會呼叫模組函式.

"&get.device.vap.*.station=find_mobile_station"
處理 vap 時因為是 gd 類型所以會呼叫模組函式, part_level = 2,
處理 station 時因為是 gd 類型所以會呼叫模組函式, part_level = 3.

MCM_DTYPE_EK_TD *
part_key

紀錄目前處理的目標的上面幾層的 key 值

如果目標的上層是 gd 類型, 則 CGI 在處理目標層時會根據上層的資料筆數呼叫多次模組函式, 每次呼叫會指出上層的資料的 key 值

注意事項 :

01.	part_key 是一維陣列, 元素數目等於 part_level, 每個元素的 key 值依據該層的類型而不同, 如果是最後一個元素, 則是 0, 如果不是最後一個元素, 而該層是 gs 類型, 則是 0, 如果不是最後一個元素, 而該層是 gd 類型, 則是該層目前處理的 key 值

例如 :

"&get.device.vap.*=find_5g_vap"
# 處理 vap 時呼叫模組函式,
  vap 的上層 device 是 gs 類型固定只有一筆資料, 所以只會呼叫一次 find_5g_vap(),
- 第 1 次呼叫 find_5g_vap() :
  part_level 是 2, part_key 的陣列大小是 2, 內容 :
  part_key[0] 表示 device 的 key 值, 因為 device 是 gs 類型所以是 0,
  part_key[1] 是最後一個元素, 固定是 0.

"&get.device.vap.*.station.*=find_mobile_station"
# 處理 vap 時呼叫模組函式,
  vap 的上層 device 是 gs 類型固定只有一筆資料, 所以只會呼叫一次 find_mobile_station(),
- 處理 vap 時第 1 次呼叫 find_mobile_station() :
  part_level = 2, part_key[] = 2 :
  part_key[0] = 0,
  # 處理 station 時呼叫模組函式,
    station 的上層 vap 是 gd 類型有多筆資料, 這時會根據 vap 的資料筆數呼叫多次 find_mobile_station(),
    假設 vap 有 3 筆資料, key 值分別是 8, 15, 23,
  = 處理  station 時第 1 次呼叫 find_mobile_station() (device.vap.#8) :
    part_level = 3, part_key[] = 3 :
    part_key[0] = 0,
    part_key[1] = 8,
  = 處理  station 時第 2 次呼叫 find_mobile_station() (device.vap.#15) :
    part_level = 3, part_key[] = 3 :
    part_key[0] = 0,
    part_key[1] = 15,
  = 處理  station 時第 3 次呼叫 find_mobile_station() (device.vap.#23) :
    part_level = 3, part_key[] = 3 :
    part_key[0] = 0,
    part_key[1] = 23.

"&get.device.vap.*.station.*.user.*=find_online_user"
假設資料庫內有這幾筆資料 :
device.vap.#8
device.vap.#8.station.#11
device.vap.#8.station.#13
device.vap.#15
device.vap.#15.station.#24
device.vap.#23
呼叫模組函式的流程 :
# 處理 vap, 呼叫 1 次 find_online_user(),
- 處理 vap 時第 1 次呼叫 find_online_user(),
  part_level = 2, part_key[] = 2 :
  part_key[0] = 0,
  # 處理 station, 呼叫 3 次 find_online_user(),
  = 處理 station 時第 1 次呼叫 find_online_user() (device.vap.#8),
    part_level = 3, part_key[] = 3 :
    part_key[0] = 0,
    part_key[1] = 8,
    # 處理 user, 呼叫 2 次 find_online_user(),
    + 處理 user 時第 1 次呼叫 find_online_user() (device.vap.#8.station.#11),
      part_level = 4, part_key[] = 4 :
      part_key[0] = 0,
      part_key[1] = 8,
      part_key[2] = 11,
    + 處理 user 時第 2 次呼叫 find_online_user() (device.vap.#8.station.#13),
      part_level = 4, part_key[] = 4 :
      part_key[0] = 0,
      part_key[1] = 8,
      part_key[2] = 13,
  = 處理 station 時第 2 次呼叫 find_online_user() (device.vap.#15),
    part_level = 3, part_key[] = 3 :
    part_key[0] = 0,
    part_key[1] = 15,
    # 處理 user, 呼叫 1 次 find_online_user(),
    + 處理 user 時第 1 次呼叫 find_online_user() (device.vap.#15.station.#24),
      part_level = 4, part_key[] = 4 :
      part_key[0] = 0,
      part_key[1] = 15,
      part_key[2] = 24,
  = 處理 station 時第 3 次呼叫 find_online_user() (device.vap.#23),
    part_level = 3, part_key[] = 3 :
    part_key[0] = 0,
    part_key[1] = 23,
    # 處理 user, 呼叫 0 次 find_online_user()

MCM_DTYPE_EK_TD **
key_list_buf

資料緩衝, 回報要取出的資料的 key 值

MCM_DTYPE_EK_TD *
key_count_buf

資料緩衝, 回報要取出的資料筆數

key_list_buf 和 key_count_buf 的注意事項 :

01.	需要在模組函式內手動配置一維陣列的空間給 key_list_buf, 每個元素紀錄要取出的資料的 key 值, CGI 處理完後會釋放此空間
02.	CGI 端要輸出的資料筆數會以 key_count_buf 為準, 配置給 key_list_buf 的元素大小空間可以大於 key_count_buf
03.	key_list_buf 內每個元素紀錄的 key 值不可重複
04.	允許 key_list_buf != NULL 而 key_count_buf == 0 的情況
05.	如果要回報的資料筆數是 0, 則不用設定 key_count_buf 和 key_list_buf

例如 :

// 假設 vap 有 #8, #15, #23, #45 這幾筆資料, 現在要回報 CGI 取出前 3 筆資料.
int find_5g_vap(
    struct mcm_lulib_lib_t *this_lulib,
    MCM_DTYPE_EK_TD part_level,
    MCM_DTYPE_EK_TD *part_key,
    MCM_DTYPE_EK_TD **key_list_buf,
    MCM_DTYPE_EK_TD *key_count_buf)
{
    MCM_DTYPE_EK_TD rep_count, *rep_list;

    rep_count = 3;

    rep_list = malloc(sizeof(MCM_DTYPE_EK_TD) * rep_count);
    rep_list[0] = 8;
    rep_list[1] = 15;
    rep_list[2] = 23;

    *key_list_buf = rep_list;
    *key_count_buf = rep_count;

    return MCM_CCODE_PASS;
}

// 如果要回報 0 筆資料.
int find_5g_vap(
    struct mcm_lulib_lib_t *this_lulib,
    MCM_DTYPE_EK_TD part_level,
    MCM_DTYPE_EK_TD *part_key,
    MCM_DTYPE_EK_TD **key_list_buf,
    MCM_DTYPE_EK_TD *key_count_buf)
{
    // 不用設定 key_list_buf 和 key_count_buf.

    return MCM_CCODE_PASS;
}

模組函式的回傳值 :

回傳	說明
= MCM_RCODE_PASS	成功
< MCM_RCODE_PASS	錯誤

其他 : 在 console 顯示除錯訊息.
在 CGI 使用 printf() 會被網頁伺服器導向輸出給瀏覽器, 訊息要寫入 console 設備才能顯示.

在模組函式的開頭加入打開 console 設備 :

#if MCM_CCMEMODE | MCM_CCMDMODE
    dbg_console_fd = open(MCM_DBG_CONSOLE, O_WRONLY);
    if(dbg_console_fd == -1)
        return MCM_RCODE_CGI_CONFIG_INTERNAL_ERROR;
#endif

在離開模組函式時加入關閉 console 設備 :

#if MCM_CCMEMODE | MCM_CCMDMODE
close(dbg_console_fd);
#endif

[MCM_CCMEMODE]
定義, 是否要顯示錯誤訊息.
開關的值的定義在 mint_cm/mcm_lib/mcm_lheader/mcm_debug.h.

[MCM_CCMDMODE]
定義, 是否要顯示除錯訊息.
開關的值的定義在 mint_cm/mcm_lib/mcm_lheader/mcm_debug.h.

[MCM_DBG_CONSOLE]
定義, console 設備的路徑.
路徑的值定義在 mint_cm/mcm_lib/mcm_lheader/mcm_debug.h.

[int dbg_console_fd]
變數, 紀錄開啟的設備的檔案編號.
變數的宣告定義在 mcm_cgi_module_debug.h.

[char dbg_msg_buf[MCM_DBG_BUFFER_SIZE]]
變數, 儲存訊息的緩衝.
變數的宣告定義在 mcm_cgi_module_debug.h.
緩衝大小的定義在 mint_cm/mcm_lib/mcm_lheader/mcm_debug.h.

[MCM_CCMEMSG(msg_fmt, msg_args...)]
巨集, 顯示訊息 (錯誤類), 用法同 printf().
巨集的定義在 mcm_cgi_module_debug.h.

[MCM_CCMDMSG(msg_fmt, msg_args...)]
巨集, 顯示訊息 (除錯類), 用法同 printf().
巨集的定義在 mcm_cgi_module_debug.h.

範例-01 :

網頁端

<html>
<head>
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<script type="text/javascript" src="jquery_main.js"></script>
<script type="text/javascript" src="json3.js"></script>
<script type="text/javascript" src="mcm_jslib_api.js"></script>
<script type="text/javascript" src="mcm_jslib_data_info_auto.js"></script>
<script type="text/javascript">
function main_init()
{
    var self_jslib, req_cmd, rep_ret, mcm_dv, i;

    // 找出使用 5G 設定的 vap.
    req_cmd = "&get.device.vap.*=find_5g_vap";

    self_jslib = new mcm_jslib_lib_t();
    self_jslib.socket_path = "@mintcm";
    self_jslib.session_permission = mcm_session_permission.ro;
    self_jslib.session_stack_size = 0;
    self_jslib.request_command = req_cmd;
    self_jslib.data_format = mcm_data_format.all_default;
    self_jslib.other_query = "";
    rep_ret = mcm_jslib_obtain_config(self_jslib);
    if(rep_ret.rep_code < mcm_return_code.pass)
    {
        alert("call mcm_jslib_obtain_config() fail" +
              "[" + rep_ret.rep_code + "]");
        mcm_jslib_run_script(rep_ret.rep_data);
        return;
    }
    mcm_dv = JSON.parse(rep_ret.rep_data);

    for(i = 0; i < mcm_dv.device.vap.length; i++)
    {
        console.log("device.vap.@" + (i + 1) + ".ekey = " +
                    mcm_dv.device.vap[i].ekey);
        console.log("device.vap.@" + (i + 1) + ".ssid = " +
                    mcm_dv.device.vap[i].ssid);
        console.log("device.vap.@" + (i + 1) + ".channel = " +
                    mcm_dv.device.vap[i].channel);
    }
}
</script>
</head>
<body>
  <button type="button" onclick="main_init()">test</button>
</body>
</html>

CGI 端 (模組函式)

#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include "mcm_lib/mcm_lheader/mcm_type.h"
#include "mcm_lib/mcm_lheader/mcm_size.h"
#include "mcm_lib/mcm_lheader/mcm_connect.h"
#include "mcm_lib/mcm_lheader/mcm_return.h"
#include "mcm_lib/mcm_lheader/mcm_data_exinfo_auto.h"
#include "mcm_lib/mcm_lulib/mcm_lulib_api.h"
#include "mcm_cgi_module_debug.h"

int find_5g_vap(
    struct mcm_lulib_lib_t *this_lulib,
    MCM_DTYPE_USIZE_TD part_level,
    MCM_DTYPE_EK_TD *part_key,
    MCM_DTYPE_EK_TD **key_list_buf,
    MCM_DTYPE_EK_TD *key_count_buf)
{
    int fret;
    char *path1, path2[MCM_PATH_MAX_LENGTH];
    struct mcm_dv_device_vap_t *vap_v;
    MCM_DTYPE_EK_TD vap_idx, vap_count, *rep_list = NULL, rep_count = 0;

#if MCM_CCMEMODE | MCM_CCMDMODE
    dbg_console_fd = open(MCM_DBG_CONSOLE, O_WRONLY);
    if(dbg_console_fd == -1)
        return MCM_RCODE_CGI_CONFIG_INTERNAL_ERROR;
#endif

    MCM_CCMDMSG("part_level = %u", part_level);

    // 讀出所有的 device.vap.*
    path1 = "device.vap.*";
    fret = mcm_lulib_get_all_entry(this_lulib, path1, (void **) &vap_v, &vap_count);
    if(fret < MCM_RCODE_PASS)
    {
        MCM_CCMEMSG("call mcm_lulib_get_all_entry(%s) fail", path1);
        goto FREE_01;
    }

    if(vap_count > 0)
    {
        // 配置空間放置 key (為了方便操作直接配置 vap_count 的數目).
        rep_list = (MCM_DTYPE_EK_TD *) malloc(sizeof(MCM_DTYPE_EK_TD) * vap_count);
        if(rep_list == NULL)
        {
            MCM_CCMEMSG("call malloc() fail [%s]", strerror(errno));
            goto FREE_02;
        }

        for(vap_idx = 0; vap_idx < vap_count; vap_idx++)
        {
            snprintf(path2, sizeof(path2), "device.vap.#%u", vap_v[vap_idx].ekey);
            MCM_CCMDMSG("%s.ssid = " MCM_DTYPE_S_PF, path2, vap_v[vap_idx].ssid);
            MCM_CCMDMSG("%s.channel = " MCM_DTYPE_IUI_PF, path2, vap_v[vap_idx].channel);

            // 檢查是否符合, 是的話把 key 加入到 rep_list.
            if(vap_v[vap_idx].channel >= 36)
            {
                MCM_CCMDMSG("this vap is match");
                rep_list[rep_count] = vap_v[vap_idx].ekey;
                rep_count++;
            }
            else
            {
                MCM_CCMDMSG("this vap is not match");
            }
        }
    }

    *key_list_buf = rep_list;
    *key_count_buf = rep_count;

FREE_02:
    free(vap_v);
FREE_01:
#if MCM_CCMEMODE | MCM_CCMDMODE
    close(dbg_console_fd);
#endif
    return fret;
}

範例-02 :

網頁端

<html>
<head>
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<script type="text/javascript" src="jquery_main.js"></script>
<script type="text/javascript" src="json3.js"></script>
<script type="text/javascript" src="mcm_jslib_api.js"></script>
<script type="text/javascript" src="mcm_jslib_data_info_auto.js"></script>
<script type="text/javascript">
function main_init()
{
    var self_jslib, req_cmd = "", rep_ret, mcm_dv, i, j;

    // 把要過濾的規則寫入到資料庫, 之後 CGI 端模組函式再從資料庫讀出過濾規則.
    req_cmd += "&set.device.filter.rule1=" +
               $("#rule_select").val();

    // 找出顯示或隱藏的 vap 以及之下的 extra 資料和 station 資料.
    req_cmd += "&get.device.vap.*=find_visible_or_hidden_vap" +
               // extra 和 station 路徑和 vap 路徑有階層關係, 需要注意順序,
               // 因為是要找出指定的 vap 資料以及之下的 station 資料,
               // 所以 extra 和 station 指令必須在 vap 指令之後.
               "&get.device.vap.*.extra" +
               "&get.device.vap.*.station.*";

    self_jslib = new mcm_jslib_lib_t();
    self_jslib.socket_path = "@mintcm";
    self_jslib.session_permission = mcm_session_permission.rw;
    self_jslib.session_stack_size = 0;
    self_jslib.request_command = req_cmd;
    self_jslib.data_format = mcm_data_format.all_default;
    self_jslib.other_query = "";
    rep_ret = mcm_jslib_obtain_config(self_jslib);
    if(rep_ret.rep_code < mcm_return_code.pass)
    {
        alert("call mcm_jslib_obtain_config() fail" +
              "[" + rep_ret.rep_code + "]");
        mcm_jslib_run_script(rep_ret.rep_data);
        return;
    }
    mcm_dv = JSON.parse(rep_ret.rep_data);

    for(i = 0; i < mcm_dv.device.vap.length; i++)
    {
        console.log("device.vap.@" + (i + 1) + ".ekey = " +
                    mcm_dv.device.vap[i].ekey);
        console.log("device.vap.@" + (i + 1) + ".ssid = " +
                    mcm_dv.device.vap[i].ssid);
        console.log("device.vap.@" + (i + 1) + ".channel = " +
                    mcm_dv.device.vap[i].channel);

        // 只會取得符合規則的 vap 的 extra.
        console.log("device.vap.@" + (i + 1) + ".extra.hidden = " +
                    mcm_dv.device.vap[i].extra.hidden);
        console.log("device.vap.@" + (i + 1) + ".extra.tx_power = " +
                    mcm_dv.device.vap[i].extra.tx_power);

        // 只會取得符合規則的 vap 的 station.
        for(j = 0; j < mcm_dv.device.vap[i].station.length; j++)
        {
            console.log("device.vap.@" + (i + 1) + ".station.@" + (j + 1) + ".ekey = " +
                        mcm_dv.device.vap[i].station[j].ekey);
            console.log("device.vap.@" + (i + 1) + ".station.@" + (j + 1) + ".mac_addr = " +
                        mcm_dv.device.vap[i].station[j].mac_addr);
            console.log("device.vap.@" + (i + 1) + ".station.@" + (j + 1) + ".rule = " +
                        mcm_dv.device.vap[i].station[j].rule);
        }
    }
}
</script>
</head>
<body>
  <select id="rule_select">
    <option value="0">find visible vap</option>
    <option value="1">find hidden vap</option>
    <option value="2">find unknown vap</option>
  </select>
  <br>
  <button type="button" onclick="main_init()">test</button>
</body>
</html>

CGI 端 (模組函式)

#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include "mcm_lib/mcm_lheader/mcm_type.h"
#include "mcm_lib/mcm_lheader/mcm_size.h"
#include "mcm_lib/mcm_lheader/mcm_connect.h"
#include "mcm_lib/mcm_lheader/mcm_return.h"
#include "mcm_lib/mcm_lheader/mcm_data_exinfo_auto.h"
#include "mcm_lib/mcm_lulib/mcm_lulib_api.h"
#include "mcm_cgi_module_debug.h"

int find_visible_or_hidden_vap(
    struct mcm_lulib_lib_t *this_lulib,
    MCM_DTYPE_USIZE_TD part_level,
    MCM_DTYPE_EK_TD *part_key,
    MCM_DTYPE_EK_TD **key_list_buf,
    MCM_DTYPE_EK_TD *key_count_buf)
{
    int fret;
    char *path1, path2[MCM_PATH_MAX_LENGTH];
    struct mcm_dv_device_vap_extra_t extra_v;
    MCM_DTYPE_ISI_TD get_hidden;
    MCM_DTYPE_EK_TD vap_idx, vap_count, *vap_key, *rep_list = NULL, rep_count = 0;

#if MCM_CCMEMODE | MCM_CCMDMODE
    dbg_console_fd = open(MCM_DBG_CONSOLE, O_WRONLY);
    if(dbg_console_fd == -1)
        return MCM_RCODE_CGI_CONFIG_INTERNAL_ERROR;
#endif

    MCM_CCMDMSG("part_level = %u", part_level);

    // 讀出規則.
    path1 = "device.filter.rule1";
    fret = mcm_lulib_get_alone(this_lulib, path1, &get_hidden);
    if(fret < MCM_RCODE_PASS)
    {
        MCM_CCMEMSG("call mcm_lulib_get_alone(%s) fail", path1);
        goto FREE_01;
    }
    MCM_CCMDMSG("find %s vap", get_hidden == 0 ? "visible" : "hidden");

    //  讀出 device.vap.* 所有的 key, 再逐一讀出 device.vap.*.extra
    path1 = "device.vap.*";
    fret = mcm_lulib_get_all_key(this_lulib, path1, (MCM_DTYPE_EK_TD **) &vap_key, &vap_count);
    if(fret < MCM_RCODE_PASS)
    {
        MCM_CCMEMSG("call mcm_lulib_get_all_key(%s) fail", path1);
        goto FREE_01;
    }

    if(vap_count > 0)
    {
        // 配置空間放置 key.
        rep_list = (MCM_DTYPE_EK_TD *) malloc(sizeof(MCM_DTYPE_EK_TD) * vap_count);
        if(rep_list == NULL)
        {
            MCM_CCMEMSG("call malloc() fail [%s]", strerror(errno));
            goto FREE_02;
        }

        for(vap_idx = 0; vap_idx < vap_count; vap_idx++)
        {
            // 逐一讀出 device.vap.*.extra
            snprintf(path2, sizeof(path2), "device.vap.#%u.extra", vap_key[vap_idx]);
            fret = mcm_lulib_get_entry(this_lulib, path2, &extra_v);
            if(fret < MCM_RCODE_PASS)
            {
                MCM_CCMEMSG("call mcm_lulib_get_entry(%s) fail", path2);
                goto FREE_02;
            }

            MCM_CCMDMSG("%s.hidden = " MCM_DTYPE_ISC_PF, path2, extra_v.hidden);
            MCM_CCMDMSG("%s.tx_power = " MCM_DTYPE_ISS_PF, path2, extra_v.tx_power);

            // 檢查是否符合.
            if(get_hidden == extra_v.hidden)
            {
                MCM_CCMDMSG("this vap is match");
                rep_list[rep_count] = vap_key[vap_idx];
                rep_count++;
            }
            else
            {
                MCM_CCMDMSG("this vap is not match");
            }
        }
    }

    *key_list_buf = rep_list;
    *key_count_buf = rep_count;

FREE_02:
    free(vap_key);
FREE_01:
#if MCM_CCMEMODE | MCM_CCMDMODE
    close(dbg_console_fd);
#endif
    return fret;
}

範例-03 :

網頁端

<html>
<head>
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<script type="text/javascript" src="jquery_main.js"></script>
<script type="text/javascript" src="json3.js"></script>
<script type="text/javascript" src="mcm_jslib_api.js"></script>
<script type="text/javascript" src="mcm_jslib_data_info_auto.js"></script>
<script type="text/javascript">
function main_init()
{
    var self_jslib, req_cmd = "", rep_ret, mcm_dv, i, j;

    // 把要過濾的規則寫入到資料庫, 之後 CGI 端模組函式再從資料庫讀出過濾規則.
    req_cmd += "&set.device.filter.rule1=" +
               $("#rule_select").val();

    // 找出符合規則類型的 station 以及所屬的 vap.
    req_cmd += "&get.device.vap.*.station.*=find_match_rule_station" +
               // vap 指令必須在 station 指令後面,
               // 這樣 vap 部分才會只取出符合規則的 station 所屬的 vap.
               "&get.device.vap.*";

    self_jslib = new mcm_jslib_lib_t();
    self_jslib.socket_path = "@mintcm";
    self_jslib.session_permission = mcm_session_permission.rw;
    self_jslib.session_stack_size = 0;
    self_jslib.request_command = req_cmd;
    self_jslib.data_format = mcm_data_format.all_default;
    self_jslib.other_query = "";
    rep_ret = mcm_jslib_obtain_config(self_jslib);
    if(rep_ret.rep_code < mcm_return_code.pass)
    {
        alert("call mcm_jslib_obtain_config() fail" +
              "[" + rep_ret.rep_code + "]");
        mcm_jslib_run_script(rep_ret.rep_data);
        return;
    }
    mcm_dv = JSON.parse(rep_ret.rep_data);

    for(i = 0; i < mcm_dv.device.vap.length; i++)
    {
        console.log("device.vap.@" + (i + 1) + ".ekey = " +
                    mcm_dv.device.vap[i].ekey);
        console.log("device.vap.@" + (i + 1) + ".ssid = " +
                    mcm_dv.device.vap[i].ssid);
        console.log("device.vap.@" + (i + 1) + ".channel = " +
                    mcm_dv.device.vap[i].channel);

        for(j = 0; j < mcm_dv.device.vap[i].station.length; j++)
        {
            console.log("device.vap.@" + (i + 1) + ".station.@" + (j + 1) + ".ekey = " +
                        mcm_dv.device.vap[i].station[j].ekey);
            console.log("device.vap.@" + (i + 1) + ".station.@" + (j + 1) + ".mac_addr = " +
                        mcm_dv.device.vap[i].station[j].mac_addr);
            console.log("device.vap.@" + (i + 1) + ".station.@" + (j + 1) + ".rule = " +
                        mcm_dv.device.vap[i].station[j].rule);
        }
    }
}
</script>
</head>
<body>
  <select id="rule_select">
    <option value="1">find phone (rule = 1) station</option>
    <option value="2">find mobile (rule = 2) station</option>
    <option value="3">find geme (rule = 3) station</option>
    <option value="4">find stream (rule = 4) station</option>
    <option value="5">find remote (rule = 5) station</option>
    <option value="6">find control (rule = 6) station</option>
    <option value="7">find security (rule = 7) station</option>
    <option value="8">find unknown (rule = 8) station</option>
  </select>
  <br>
  <button type="button" onclick="main_init()">test</button>
</body>
</html>

CGI 端 (模組函式)

#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include "mcm_lib/mcm_lheader/mcm_type.h"
#include "mcm_lib/mcm_lheader/mcm_size.h"
#include "mcm_lib/mcm_lheader/mcm_connect.h"
#include "mcm_lib/mcm_lheader/mcm_return.h"
#include "mcm_lib/mcm_lheader/mcm_data_exinfo_auto.h"
#include "mcm_lib/mcm_lulib/mcm_lulib_api.h"
#include "mcm_cgi_module_debug.h"

int find_match_rule_station(
    struct mcm_lulib_lib_t *this_lulib,
    MCM_DTYPE_USIZE_TD part_level,
    MCM_DTYPE_EK_TD *part_key,
    MCM_DTYPE_EK_TD **key_list_buf,
    MCM_DTYPE_EK_TD *key_count_buf)
{
    int fret;
    char *path1, path2[MCM_PATH_MAX_LENGTH];
    struct mcm_dv_device_vap_station_t *station_v;
    MCM_DTYPE_ISI_TD target_rule;
    MCM_DTYPE_EK_TD vap_idx, vap_count, *vap_key = NULL, target_vap, station_idx, station_count,
        rep_idx, *rep_list = NULL, rep_count = 0;

#if MCM_CCMEMODE | MCM_CCMDMODE
    dbg_console_fd = open(MCM_DBG_CONSOLE, O_WRONLY);
    if(dbg_console_fd == -1)
        return MCM_RCODE_CGI_CONFIG_INTERNAL_ERROR;
#endif

    MCM_CCMDMSG("part_level = %u", part_level);

    // 讀出規則.
    path1 = "device.filter.rule1";
    fret = mcm_lulib_get_alone(this_lulib, path1, &target_rule);
    if(fret < MCM_RCODE_PASS)
    {
        MCM_CCMEMSG("call mcm_lulib_get_alone(%s) fail", path1);
        goto FREE_01;
    }
    MCM_CCMDMSG("find rule (" MCM_DTYPE_ISI_PF ") station", target_rule);

    // 處理 device.vap.*.station.* 的 vap 部分,
    // 回報符合規則的 station 所屬的 vap.
    if(part_level == 2)
    {
        MCM_CCMDMSG("process vap part");

        //  讀出 device.vap.* 所有的 key, 再逐一讀出 device.vap.*.station.*
        path1 = "device.vap.*";
        fret = mcm_lulib_get_all_key(this_lulib, path1, (MCM_DTYPE_EK_TD **) &vap_key, &vap_count);
        if(fret < MCM_RCODE_PASS)
        {
            MCM_CCMEMSG("call mcm_lulib_get_all_key(%s) fail", path1);
            goto FREE_01;
        }

        if(vap_count > 0)
        {
            // 配置空間放置 key.
            rep_list = (MCM_DTYPE_EK_TD *) malloc(sizeof(MCM_DTYPE_EK_TD) * vap_count);
            if(rep_list == NULL)
            {
                MCM_CCMEMSG("call malloc() fail [%s]", strerror(errno));
                goto FREE_02;
            }

            for(vap_idx = 0; vap_idx < vap_count; vap_idx++)
            {
                // 讀出 device.vap.#{vap_key[i]}.station.*
                snprintf(path2, sizeof(path2), "device.vap.#%u.station.*", vap_key[vap_idx]);
                fret = mcm_lulib_get_all_entry(this_lulib, path2, (void **) &station_v,
                                               &station_count);
                if(fret < MCM_RCODE_PASS)
                {
                    MCM_CCMEMSG("call mcm_lulib_get_all_entry(%s) fail", path2);
                    goto FREE_03;
                }

                for(station_idx = 0; station_idx < station_count; station_idx++)
                {
                    snprintf(path2, sizeof(path2), "device.vap.#%u.station.#%u",
                             vap_key[vap_idx], station_v[station_idx].ekey);
                    MCM_CCMDMSG("%s.mac_addr = " MCM_DTYPE_S_PF,
                                path2, station_v[station_idx].mac_addr);
                    MCM_CCMDMSG("%s.rule = " MCM_DTYPE_RK_PF,
                                path2, station_v[station_idx].rule);

                    //檢查是否符合.
                    if(target_rule == station_v[station_idx].rule)
                    {
                        MCM_CCMDMSG("this vap is match");
                        // 檢查是否已經在表內, 沒有才加入.
                        for(rep_idx = 0; rep_idx < rep_count; rep_idx++)
                            if(rep_list[rep_idx] == vap_key[vap_idx])
                                break;
                        if(rep_idx == rep_count)
                        {
                            rep_list[rep_count] = vap_key[vap_idx];
                            rep_count++;
                        }
                    }
                    else
                    {
                        MCM_CCMDMSG("this vap is not match");
                    }
                }

                free(station_v);
            }
        }
    }
    else
    // 處理 device.vap.*.station.* 的 station 部分.
    // 回報處理的 vap 內有哪些 station 符合.
    if(part_level == 3)
    {
        MCM_CCMDMSG("process station part");
        MCM_CCMDMSG("device.vap.#%u.station.*", part_key[1]);

        target_vap = part_key[1];

        // 讀出 device.vap.#{target_vap}.station.*
        snprintf(path2, sizeof(path2), "device.vap.#%u.station.*", target_vap);
        fret = mcm_lulib_get_all_entry(this_lulib, path2, (void **) &station_v, &station_count);
        if(fret < MCM_RCODE_PASS)
        {
            MCM_CCMEMSG("call mcm_lulib_get_all_entry(%s) fail", path2);
            goto FREE_01;
        }

        if(vap_count > 0)
        {
            // 配置空間放置 key.
            rep_list = (MCM_DTYPE_EK_TD *) malloc(sizeof(MCM_DTYPE_EK_TD) * vap_count);
            if(rep_list == NULL)
            {
                MCM_CCMEMSG("call malloc() fail [%s]", strerror(errno));
                goto FREE_02;
            }

            //檢查是否符合.
            for(station_idx = 0; station_idx < station_count; station_idx++)
            {
                snprintf(path2, sizeof(path2), "device.vap.#%u.station.#%u",
                         target_vap, station_v[station_idx].ekey);
                MCM_CCMDMSG("%s.mac_addr = " MCM_DTYPE_S_PF,
                            path2, station_v[station_idx].mac_addr);
                MCM_CCMDMSG("%s.rule = " MCM_DTYPE_RK_PF,
                            path2, station_v[station_idx].rule);

                if(target_rule == station_v[station_idx].rule)
                {
                    MCM_CCMDMSG("this station is match");
                    rep_list[rep_count] = station_v[station_idx].ekey;
                    rep_count++;
                }
                else
                {
                    MCM_CCMDMSG("this station is not match");
                }
            }
        }
    }

    *key_list_buf = rep_list;
    *key_count_buf = rep_count;

FREE_03:
    if(fret < MCM_RCODE_PASS)
        if(part_level == 2)
            free(rep_list);
FREE_02:
    if(part_level == 2)
        free(vap_key);
    else
    if(part_level == 3)
        free(station_v);
FREE_01:
#if MCM_CCMEMODE | MCM_CCMDMODE
    close(dbg_console_fd);
#endif
    return fret;
}

備註-02b (如果同時設定了多個 get 指令, 而且指令之間有階層關係, 則需要注意指令的順序) :

以上述的 [範例-03] 為例 :

找出符合規則類型的 station 以及所屬的 vap.


req_cmd += "&get.device.vap.*" +
           "&get.device.vap.*.station.*=find_match_rule_station";
錯誤用法.

處理 "&get.device.vap.*"
device => 取出資料索引.
vap    => 取出每個 device 之下的 vap 的資料索引.

處理 "&get.device.vap.*.station.*=find_match_rule_station"
device  => 已經處理過, 跳過.
vap     => 已經處理過, 跳過, 不執行 find_match_rule_station(part_level == 2).
station => 依據 vap 的資料筆數多次執行 find_match_rule_station(part_level == 3),
           取出每個 vap 之下符合的 station 的資料索引和內容.

應該是要先找出符合的 vap, 在依據符合的 vap 去處理符合的 station.


req_cmd += "&get.device.vap.*.station.*=find_match_rule_station" +
           "&get.device.vap.*";
正確用法.

處理 "&get.device.vap.*.station.*=find_match_rule_station"
device  => 取出資料索引.
vap     => 依據 device 的資料筆數多次執行 find_match_rule_station(part_level == 2),
           先找出符合的 vap (不含資料內容).
station => 依據符合的 vap 的資料筆數多次執行 find_match_rule_station(part_level == 3),
           取出符合的 vap 之下符合的 station 的資料索引和內容.
處理 "&get.device.vap.*"
device => 已經處理過, 跳過.
vap    => 已經處理過 (只有資料索引), 補上這些資料的內容.

其他

此方法因為必須將資料從資料庫中取出作分析, 所以會耗費較多的時間, 若是要加快處理速度可以在 CGI 端的模組函式內使用 mcm_lulib_run, 將 part_level, part_key 等資料傳遞給內部模組 (內部模組的用法在 #04-01# 說明, 資料傳遞的用法在 #05-01# #05-02# 說明), 並在內部模組處理分析資料的部分, 最後再將符合的資料的 key 從內部模組回傳給 CGI 的模組函式. [範例 #05-04#]

範例程式的使用

01.	範例程式目錄在 mint_cm/usage/example/0305.

02.	下面關於 make 的操作沒有特別註明的話都是在 mint_cm 目錄.

03.	先修改 mini_httpd 讀取網頁的路徑. 修改 mint_cm/http_server/mini_httpd/last/mini_httpd.conf, 裡面的 dir=/mint_cm/run 必須改成 mint_cm/run 資料夾實際的路徑.

04.	第一次使用, 使用 make example_add KEY=0305 載入範例並編譯.

05.

web_app 是範例程式.

範例項目 :

case-01	簡單範例
case-02	指令路徑有階層關係
case-03	將過濾規則寫入資料庫
case-04	將過濾規則寫入資料庫指令路徑有階層關係執行多個 CGI 模組
case-05	將過濾規則寫入資料庫指令路徑有階層關係執行多個 CGI 模組

06.	mini_httpd 執行方法, 進入 mint_cm/run 目錄, 指令 : ./mini_httpd -C mini_httpd.conf

07.	先執行 mcm_daemon 和 mini_httpd 才可測試.

08.	瀏覽器連至 http://<server-address>/web_app_0305_index.html 就可以看到範例頁面.

09.	測試完畢不使用後, 使用 make example_del KEY=0305 將範例移除.

10.

範例程式目錄下的檔案在做完 make example_add 後會複製到真正使用的位置, 要修改做測試的話要改在複製後的.

來源 profile/mcm_data_profile_0305.xml
目地 mint_cm/mcm_build/mcm_data_profile.xml
資料模型範例
有修改要使用 make all 重新編譯

來源 profile/mcm_store_profile_default_0305.txt
目地 mint_cm/mcm_build/mcm_store_profile_default.txt
資料預設值範例
使用 make all 後會再複製到 mint_cm/run

來源 web_app
目地 mint_cm/run/web
網頁程式範例

來源 module/mcm_module_0305.c
目地 mint_cm/mcm_daemon/mcm_module
搭配 run 使用的內部模組範例
有修改要使用 make all 重新編譯