開發OpenWrt路由器上LuCI的模塊

時間 2019-12-09

原文原文鏈接

【題外話】html

學校裏最近改造了校園網，要求必須用iNode驗證，萬幸的是路由器能刷OpenWrt，而且OpenWrt上有好多iNode認證的開源項目，好比njit8021xclient（如下簡稱njit-client）就很是好用。雖然程序寫的好用，可是配置起來仍是稍微麻煩一些的，你們一般的方法是在/etc/init.d下寫啓動腳本，把用戶名、密碼什麼的都直接填進去，但畢竟配置起來不方便，同時往後修改起來也不便。好在用Lua爲LuCI寫配置模塊很簡單，索性就本身作了一個，如今把開發的流程寫一下，方便初學的同窗去作。爲njit-client作好的Web配置界面也已經開源，地址：https://github.com/mayswind/luci-app-njitclient，或者直接下載編譯好（不限平臺）的文件：http://pan.baidu.com/s/1CbPallinux

【文章索引】git

【1、LuCI配置界面開發的框架】github

LuCI是OpenWrt上的Web管理界面，LuCI採用了MVC三層架構，同時其使用Lua腳本開發，因此開發LuCI的配置界面不須要編輯任何的Html代碼，除非想本身單獨去建立網頁（View層），不然咱們基本上只須要修改Model層就能夠了。官方也有一個如何去建立模塊的說明文檔，雖然寫的比較晦澀：http://luci.subsignal.org/trac/wiki/Documentation/ModulesHowToapi

要爲LuCI增長一個新模塊，首先須要建立兩個文件，一個位於Controller（/usr/lib/lua/luci/controller/）下，定義模塊的入口；另外一個位於Model（/usr/lib/lua/luci/model/cbi/）下，爲配置模塊實際的代碼。數組

首先咱們定義模塊的入口，在/usr/lib/lua/luci/controller/下建立一個lua文件，相似以下：瀏覽器

module("luci.controller.控制器名", package.seeall)

function index()
        entry(路徑, 調用目標, _("顯示名稱"), 顯示順序)
        end

第一行說明了程序和模塊的名稱，好比在controller/目錄建立一個mymodule.lua，那麼就能夠寫成「luci.controller.mymodule」，若是你的程序比較多，可能分爲好幾個模塊，那麼能夠在controller下再常見一個子目錄，好比controller/myapp/，那麼就能夠寫成「luci.controller.myapp.mymodule」。網絡

接下來的entry表示添加一個新的模塊入口，官方給出了entry的定義，其中後兩項都是能夠爲空的：架構

entry(path, target, title=nil, order=nil)

第一項是訪問的路徑，不過路徑是按字符串數組給定的，好比路徑按以下方式寫「{"click", "here", "now"}」，那麼就能夠在瀏覽器裏訪問「http://192.168.1.1/cgi-bin/luci/click/here/now」來訪問這個腳本。而一般咱們但願爲管理員菜單添加腳本，那麼咱們須要按以下方式編寫「{"admin", "一級菜單名", "菜單項名"}」，系統會自動在對應的菜單中生成菜單項。好比想在「網絡」菜單下建立一個菜單項，那麼一級菜單名能夠寫爲「network」。app

第二項爲調用目標，調用目標分爲三種，分別是執行指定方法（Action）、訪問指定頁面（Views）以及調用CBI Module。

第一種能夠直接調用指定的函數，好比點擊菜單項就直接重啓路由器等等，好比寫爲「call("function_name")」，而後在lua文件下編寫名爲function_name的函數就能夠調用了。
第二種能夠訪問指定的頁面，好比寫爲「template("myapp/mymodule")」就能夠調用/usr/lib/lua/luci/view/myapp/mymodule.htm文件了。
而若是要編寫配置頁面，那麼使用第三種方法無非是最方便的，好比寫爲「cbi("myapp/mymodule")」就能夠調用/usr/lib/lua/luci/model/cbi/myapp/mymodule.lua文件了。

而title和order無非是針對管理員菜單來的，能夠參考其餘的lua文件來決定編寫的內容。

這裏咱們建立/usr/lib/lua/luci/controller/njitclient.lua文件，定義咱們的入口，代碼以下：

module("luci.controller.njitclient", package.seeall)

function index()
        entry({"admin", "network", "njitclient"}, cbi("njitclient"), _("NJIT Client"), 100)
        end

【2、用Lua和UCI接口開發LuCI配置模塊】

咱們要作的實際上就是但願能將用戶名、密碼等信息存儲在路由器文件中，同時路由器開機時能根據設定的配置自動運行njit-client，同時咱們還但願能動態的禁用和啓用njit-client等等。因此最方便的方式就是使用CBI Module，上一節咱們也添加了這個調用，那麼接下來咱們就要根據上邊寫的路徑來建立/usr/lib/lua/luci/model/cbi/njitclient.lua文件。

開發LuCI的配置模塊有不少種方式，比較基本的能夠用SimpleForm，就跟開發普通的Web應用相似，固然最方便的仍是使用UCI（Unified Configuration Interface，統一配置接口）的方式，由於使用UCI接口可使得在LuCI中能夠無需考慮配置文件如何存儲和讀取（這種方式也會自動建立「保存&應用」、「保存」以及「復位」三個按鈕），同時在Bash文件中也能夠很是方便的存儲和讀取。

對於使用UCI的方式，咱們首先須要建立對應的配置文件（若是配置文件不存在的話，訪問配置頁面將會報錯），格式即爲linux配置文件的格式，文件須要存儲在/etc/config，好比文件路徑爲「/etc/config/njitclient」，內容以下：

config login
    option username ''
    option password ''
    option ifname 'eth0'
    option domain ''

而後咱們要在CBI Module的lua文件中首先須要映射與存儲文件的關係，好比：

m = Map("配置文件文件名", "配置頁面標題", "配置頁面說明")

第一個參數即爲配置文件存儲的文件名，不包含路徑，好比按上述建立的話，應該寫爲「njitclient」，而第二與第三個參數則是用在來頁面上顯示的，好比以下所示的圖：

接下來須要建立與配置文件中對應的Section，Section分爲兩種，NamedSection和TypedSection，前者根據配置文件中的Section名，然後者根據配置文件中的Section類型，這裏咱們使用後者，代碼以下。同時咱們設定不容許增長或刪除Section（「.addremove = false」），以及不顯示Section的名稱（「.anonymous = true」）。

s = m:section(TypedSection, "login", "")
s.addremove = false
s.anonymous = true

接下來咱們須要建立Section中不一樣內容的交互（建立Option），常見的好比有Value（文本框）、ListValue（下拉框）、Flag（選擇框）等等，詳細的能夠參考官方的文檔：http://luci.subsignal.org/trac/wiki/Documentation/CBI

建立Option的過程很是簡單，並且建立後系統會無需考慮讀取以及寫入配置文件的問題，系統都會自動處理。可是根據上述的要求，咱們在應用配置之後可能但願啓用、禁用或從新啓動njit-client，因此咱們還須要在頁面最後判斷用戶是否點擊了「應用」按鈕，這裏與編寫asp網頁等都是相同的，咱們能夠經過以下的代碼判斷是否點擊了「應用」按鈕：

local apply = luci.http.formvalue("cbi.apply")
if apply then
    --[[
        須要處理的代碼
    ]]--
end

因爲剩餘的代碼都很是簡單，因此因此這部分的所有代碼見下：

 1 require("luci.sys")
 2 
 3 m = Map("njitclient", translate("NJIT Client"), translate("Configure NJIT 802.11x client."))
 4 
 5 s = m:section(TypedSection, "login", "")
 6 s.addremove = false
 7 s.anonymous = true
 8 
 9 enable = s:option(Flag, "enable", translate("Enable"))
10 name = s:option(Value, "username", translate("Username"))
11 pass = s:option(Value, "password", translate("Password"))
12 pass.password = true
13 domain = s:option(Value, "domain", translate("Domain"))
14 
15 ifname = s:option(ListValue, "ifname", translate("Interfaces"))
16 for k, v in ipairs(luci.sys.net.devices()) do
17     if v ~= "lo" then
18         ifname:value(v)
19     end
20 end
21 
22 local apply = luci.http.formvalue("cbi.apply")
23 if apply then
24     io.popen("/etc/init.d/njitclient restart")
25 end
26 
27 return m

其中Luci所有類庫的函數定義和使用說明能夠參考以下地址：http://luci.subsignal.org/api/luci/index.html

【3、在Bash文件中調用UCI接口】

上邊咱們已經完成了LuCI配置界面的開發，在配置界面中咱們已經能讀取並保存配置文件了。接下來咱們要編寫/etc/init.d/njitclient腳本，使程序最終能運行起來。關於UCI接口在腳本文件中的官方說明能夠參考：http://wiki.openwrt.org/doc/devel/config-scripting

要使用UCI調用腳本，首先第一步須要讀取配置文件，命令爲「config_load 配置文件名」，好比咱們能夠這樣讀入剛纔的配置文件：

config_load njitclient

接下來要遍歷配置文件中的Section，可使用「config_foreach 遍歷函數名 Section類型」，例如咱們能夠這樣：

config_foreach run_njit login

而後咱們去編寫名爲「run_njit」的函數，在這個函數中，咱們可使用「config_get 變量名 Section名 Section參數名」獲取變量的值，或者使用「config_get_bool 變量名 Section名 Section參數名」獲取布爾型的值。因此所有的代碼見下：

 1 #!/bin/sh /etc/rc.common
 2 START=50
 3 
 4 run_njit()
 5 {
 6     local enable
 7     config_get_bool enable $1 enable
 8     
 9     if [ $enable ]; then
10         local username
11         local password
12         local domain
13         local ifname
14         
15         config_get username $1 username
16         config_get password $1 password
17         config_get domain $1 domain
18         config_get ifname $1 ifname
19         
20         if [ "$domain" != "" ]; then
21             njit-client $username@$domain $password $ifname &
22         else
23             njit-client $username $password $ifname &
24         fi
25         
26         echo "NJIT Client has started."
27     fi
28 }
29 
30 start()
31 {
32     config_load njitclient
33     config_foreach run_njit login
34 }
35 
36 stop()
37 {
38     killall njit-client
39     killall udhcpc
40     
41     echo "NJIT Client has stoped."
42 }

【4、編譯開發的程序】

若是按上述內容建立好上述4個文件，那麼配置頁面和程序就能在OpenWrt上運行起來了。可是若是要想把本身寫的程序打包，還須要建立OpenWrt的Makefile來使用OpenWrt的SDK進行編譯。

關於LuCI上配置Makefile的官方說明能夠見這個地址：http://luci.subsignal.org/trac/wiki/Documentation/Modules

無非就是定義包的名稱（PKG_NAME）、版本和生成次數（PKG_VERSION、PKG_RELEASE）、在menuconfig中的分類說明等（define Package/luci-app-njitclient）以及安裝時進行的操做（define Package/luci-app-njitclient/install）等等。其中安裝的文件分爲三種，分別是配置文件、可執行文件以及其餘數據文件，其中配置可執行文件時，會自動加入執行權限的，因此不須要額外進行處理。Makefile所有的代碼見下：

 1 include $(TOPDIR)/rules.mk
 2 
 3 PKG_NAME:=luci-app-njitclient
 4 PKG_VERSION=1.0
 5 PKG_RELEASE:=1
 6 
 7 PKG_BUILD_DIR:=$(BUILD_DIR)/$(PKG_NAME)
 8 
 9 include $(INCLUDE_DIR)/package.mk
10 
11 define Package/luci-app-njitclient
12     SECTION:=luci
13     CATEGORY:=LuCI
14     SUBMENU:=3. Applications
15     TITLE:=NJIT 802.1X Client for LuCI
16     PKGARCH:=all
17 endef
18 
19 define Package/luci-app-njitclient/description
20     This package contains LuCI configuration pages for njit8021xclient.
21 endef
22 
23 define Build/Prepare
24 endef
25 
26 define Build/Configure
27 endef
28 
29 define Build/Compile
30 endef
31 
32 define Package/luci-app-njitclient/install
33     $(INSTALL_DIR) $(1)/etc/config
34     $(INSTALL_DIR) $(1)/etc/init.d
35     $(INSTALL_DIR) $(1)/usr/lib/lua/luci/model/cbi
36     $(INSTALL_DIR) $(1)/usr/lib/lua/luci/controller
37     
38     $(INSTALL_CONF) ./files/root/etc/config/njitclient $(1)/etc/config/njitclient
39     $(INSTALL_BIN) ./files/root/etc/init.d/njitclient $(1)/etc/init.d/njitclient
40     $(INSTALL_DATA) ./files/root/usr/lib/lua/luci/model/cbi/njitclient.lua $(1)/usr/lib/lua/luci/model/cbi/njitclient.lua
41     $(INSTALL_DATA) ./files/root/usr/lib/lua/luci/controller/njitclient.lua $(1)/usr/lib/lua/luci/controller/njitclient.lua
42 endef
43 
44 $(eval $(call BuildPackage,luci-app-njitclient))