OpenWRT UCI API的使用——C語言
阿新 • • 發佈:2019-02-07
UCI 是OpenWRT為實現配置集中化而引入的一個軟體包, 通過修改UCI,可以實現對OpenWRT的絕對部分配置的修改.LUCI(OpenWRT 的WEB配置介面)也是通過讀UCI配置檔案的操作來實現使用者對路由的配置的。通過掌握UCI的API的使用,可以方便地將您的軟體的配置介面整合到LUCI中.
LUCI配置檔案簡介
LUCI的配置檔案一般儲存在 /etc/config目錄下。比如網路配置檔案則是 /etc/config/network 無線的配置檔案是 /etc/config/wireless. 跟多配置檔案的含義參考官方 WIKI
基本概念
UCI上下文: struct uci_context *
包(Package): 一個包對應一個UCI格式的檔案.型別是 struct uci_package *
節(Section): 一個配置檔案的節點. 型別是 struct uci_list *
值(Value):一個節下面可能包含多個值 一個值具有一個名字.
UCI配置檔案的基本操作.
首先您需要引入標頭檔案
- #include <unistd.h>
- #include <stdio.h>
- #include <string.h>
- #include <uci.h>
-
staticstruct uci_context * ctx = NULL; //定義一個UCI上下文的靜態變數.
- /*********************************************
- * 載入配置檔案,並遍歷Section.
- */
- bool load_config()
- {
- struct uci_package * pkg = NULL;
- struct uci_element *e;
- ctx = uci_alloc_context(); // 申請一個UCI上下文.
- if (UCI_OK != uci_load(ctx, UCI_CONFIG_FILE, &pkg))
-
goto cleanup; //如果開啟UCI檔案失敗,則跳到末尾 清理 UCI 上下文.
- /*遍歷UCI的每一個節*/
- uci_foreach_element(&pkg->sections, e)
- {
- struct uci_section *s = uci_to_section(e);
- // 將一個 element 轉換為 section型別, 如果節點有名字,則 s->anonymous 為 false.
- // 此時通過 s->e->name 來獲取.
- // 此時 您可以通過 uci_lookup_option()來獲取 當前節下的一個值.
- if (NULL != (value = uci_lookup_option_string(ctx, s, "ipaddr")))
- {
- ip = strdup(value) //如果您想持有該變數值,一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
- }
- // 如果您不確定是 string型別 可以先使用 uci_lookup_option() 函式得到Option 然後再判斷.
- // Option 的型別有 UCI_TYPE_STRING 和 UCI_TYPE_LIST 兩種.
- }
- uci_unload(ctx, pkg); // 釋放 pkg
- cleanup:
- uci_free_context(ctx);
- ctx = NULL;
- }
遍歷一個UCI_TYPE_LIST 型別.
加入現在有一個如下的配置檔案:
- config "server" "webserver"
- list "index" "index.html"
- list "index" "index.php"
- list "index" "default.html"
程式碼片:
- // s 為 section.
- struct uci_option * o = uci_lookup_option(ctx, s, "index");
- if ((NULL != o) && (UCI_TYPE_LIST == o->type)) //o存在 且 型別是 UCI_TYPE_LIST則可以繼續.
- {
- struct uci_element *e;
- uci_foreach_element(&o->v.list, e)
- {
- //這裡會迴圈遍歷 list
- // e->name 的值依次是 index.html, index.php, default.html
- }
- }
寫配置
UCI提供了一個簡潔的辦法來操作配置資訊,例如有一個配置檔案
- #檔名: testconfig
- config 'servver'
- option 'value' '123' # 我們想修改 'value' 的值為 '456'
程式碼如下:
- struct uci_context * ctx = uci_alloc_context(); //申請上下文
- struct uci_ptr ptr ={
- .package = "config",
- .section = "servver",
- .option = "value",
- .value = "256",
- };
- uci_set(_ctx,&ptr); //寫入配置
- uci_commit(_ctx, &ptr.p, false); //提交儲存更改
- uci_unload(_ctx,ptr.p); //解除安裝包
- uci_free_context(ctx); //釋放上下文
依照上面的例子,我們可以舉一反三, uci_ptr 用來指定資訊.而是用uci_set則是寫入資訊.同類的函式有如下幾個: 針對list的操作:
- uci_add_list() // 新增一個list 值
- uci_del_list() // 刪除一個list 值
- uci_delete() // 刪除一個option值