近在学习openwrt luci方面的知识,为了贯穿整个知识体系,练习题目为:
通过页面配置周期性地往/tmp/addtest文件写入内容和时间戳
1.在web主页面的下拉菜单做一个按钮,进入设置页面;
2.两个设置项:输入的内容和周期;
3,读取/tmp/addtest中的内容并显示在页面上;
代码已经开源,欢迎交流~
这部分网上相关文章很多,也可以参见拙作
首先回答一个问题:什么是Luci?>LuCI是OpenWrt上的Web管理界面,LuCI采用了MVC三层架构,使用Lua脚本开发.
简单地说,Luci就是用来做openwrt的页面的.不同于常见的html+css+javascript,Openwrt是用lua脚本语言开发的.
怎么开发一个页面呢?
要开发一个新的功能页面,开发者只要根据MVC框架写些简单的lua脚本,剩下的部分由openwrt为你自动完成.
说到MVC框架了,什么是MVC框架呢?
MVC是model+view+controller的简写.为了便于开发,openwrt将实现不同功能的lua脚本放在不同的文件夹中.请看下图:
什么是controller控制器?
我们在这里设置功能在页面的位置,同时设置点击页面后,将要调用的功能.是要去Model模型读写配置数据呢?还是要呈现一个静态页面,或者是直接执行lua脚本函数.
什么是model模型?
这里我们常用的是,通过cbi模块和UCI(统一配置接口)进行交互.简单地说,就是我们在这里将页面和路由器里面的配置关联起来,从而将页面的设置写到路由器当中.
什么是view视图?
这个应该是最容易理解的,就是呈现的页面的样式,有点类似于传统的html页面.
上面说到了UCI(Unified Configuartion Interface),这是什么龟?
openwrt将配置用统一的格式书写,放在规定的地方(/etc/config/),同时提供接口函数进行读取和设置.
如果还不太明白,接着向下看.如果有可能跟着我动动手,相信你很快就会掌握:)
我们先看下最终效果图:
我们在页面上面的System下拉框的下面加了一个AddTest按钮,下面有两个子选项:Set和Info.其中Set用于选择是否开启功能,设置时间间隔和内容.Info用于显示/tmp/addtest文件中的内容.
首先,嗯~
你得有环境,得有电,有源码,编译过简单的ipk.如果没有,请回炉重造.
其次,建立相应的文件夹及文件.至于linux操作神马的,我相信你一定没有问题.
$mkdir -p ~/temp/addtest
$cd ~/temp/addtest
最终文件树形图
骨架已经有了,下面只需要往里面填肉了,是不是感觉很快~
不要管为什么要这样,我们后面慢慢解释.
前面我们提到,controller主要用于控制页面按钮位置,以及调用的功能.首先来编辑这个文件.
$vim ~/temp/addtest/files/usr/lib/lua/luci/controller/addtest.lua
代码如下:
module("luci.controller.addtest",package.seeall)
function index()
entry({"admin","system","addtest"},alias("admin","system","addtest","set"),_("AddTest"),99).index=true
entry({"admin","system","addtest","set"},cbi("addtest"),_("Set"),1)
entry({"admin","system","addtest","info"},call("action_info"),_("Info"),2)
end
function action_info()
if not nixio.fs.access("/tmp/addtest") then
return
end
local info=nixio.fs.readfile("/tmp/addtest")
luci.template.render("addtest_info",{info=info})
end
格式模板:
module("luci.controller.控制器名", package.seeall)
function index()
entry(路径, 调用目标, _("显示名称"), 显示顺序)
end
这个脚本文件可以分为3块:第1行,3~7行,9~16行
第1行说明了模块的名称,本文在controller目录下创建了addtest.lua文件,将模板中的控制器名替换为addtest即可.第3行第3~7行定义按钮的位置,调用的功能,显示名称.其中第3行和第7行是固定的模板格式,不需要修改第4行entry表示添加新的模块.
第一个参数{"admin","system","addtest"}表示按钮的位置.admin表示我们这个功能只有以管理员身份登录页面才可以看到.system表示一级菜单名,addtest则是一级菜单下的子菜单.
第二个参数alias("admin","system","addtest","set")表示调用的功能.这个按钮没有独立的功能,而是将它关联到它的下一级子菜单set.
第三个参数_("AddTest")表示显示名称,可选.如果页面按钮想做成中文,可以在这里设置.
第四个参数99表示显示顺序的优先级,Luci根据这个值为同一父菜单的所有子菜单排序.第5行第一个参数{"admin","system","addtest","set"}表示在addtest下再增加一个子选项set.
第二个参数cbi("addtest")表示调用cbi模块,这里将会调用到/usr/lib/lua/luci/model/cbi/addtest.lua第6行第二个参数call("action_info")表示执行指定方法,这里将会调用我们下面写的acttion_info函数.备注关于entry第二个参数调用目标.我们还有一个template没有涉及,它表示访问指定页面.比如template(addtest_info)将会直接访问/usr/lib/lua/luci/view/addtest_info.htm.9~16行这里使用lua语言调用nixio接口写了一个简单的函数,首先判断文件是否存在,然后读取其中的内容赋值给变量info,最后访问指定页面/usr/lib/lua/luci/view/addtest_info.htm,同时将变量info传递过去.
luci接口手册
nixio接口手册
UCI是openwrt的配置管理机制,它将配置统一放到/etc/config文件夹下.详细地介绍请参考这里.
下面来编辑这个文件
$vim ~/temp/addtest/files/etc/config/addtest
代码如下:
config arguments
option interval ''
option content ''
Section开始语法: config '类型' '名字'
参数定义语法: option '键' '值'
列表定义语法: list '集合名字' '值'
简单解释下,我们在/etc/config下新建一个名为addtest的配置文件,其中类型为arguments,名字省略.有两个键,一个名为interval用来存时间间隔.一个名为content用来存准备周期性输入的内容.
在controller章节中,我们提到cbi会调用到model文件夹中的addtest.lua文件.下面我们来编辑它.
$vim ~/temp/addtest/files/usr/lib/lua/luci/model/cbi/addtest.lua
代码如下:
m=Map("addtest",translate("Luci practice"),translate("fat cheng's test"))
s=m:section(TypedSection,"arguments","")
s.addremove=true
s.anonymous=false
s:option(Flag,"enable",translate("Enable"))
s:option(Value,"interval",translate("Interval"))
s:option(Value,"content",translate("Content"))
local apply=luci.http.formvalue("cbi.apply")
if apply then
io.popen("/etc/init.d/addtestd restart")
end
return m
下面我们来解释下这个文件.
第1行模板m=Map("配置文件文件名", "配置页面标题", "配置页面说明")
第一个参数:上一步我们新建配置文件/etc/config/addtest.这里就是建立与配置文件的联系.
第二,三两个参数,则是页面的主标题和副标题.还不清楚的话,翻上去看看最终效果图,看看它们在哪里.第3行在一个配置文件中可能有很多Section,所以我们需要创建与配置文件中我们想要的Section的联系.
有两种方式可以选择:NamedSection(name,type,title,description)和TypedSection(type,title,description),前者根据配置文件中的Section名,而后者根据配置文件中的Section类型.我们选用了第二种.第4行设定不允许增加或删除Section第5行设定显示Section的名称,这里建议你可以试试设定为true,看看会发生什么.7~9行接着则是建立与Section中的option之间的联系.模板s:option(交互形式,option键值,显示名称).
第一个参数:常见的交互形式有Value(文本框),ListValue(下拉框),Flag(选择框).,不知道为啥我打不开官方文档,这里也可以参考
第二个参数表示在配置文件中的option的键值
第三个参数表示,你希望在页面上呈现的名称.
创建后开发者无需考虑读取以及写入配置文件的问题,系统会自动处理.11~14行系统会为我们在页面上自动创建一些按钮Save&Apply,Save,Reset.我们仅仅将配置写入/etc/config下对应的文件是不够的,我们还希望可以根据这个配置进行一些操作.
这部分代码的作用是,当你按下页面的apply按钮后,相当于在串口shell下输入/etc/init.d/addtestd restart
上一节我们已经可以读写配置了,怎么根据配置来进行操作呢?这是我们这一节要谈的.我们来编辑~/temp/addtest/files/etc/init.d/addtestd这个文件.
代码如下:
#!/bin/sh /etc/rc.common
START=50
run_addtest()
{
local enable
config_get_bool enable $1 enable
if [ $enable ]; then
local interval
local content
config_get interval $1 interval
config_get content $1 content
addtest $interval $content
fi
}
start()
{
config_load addtest
config_foreach run_addtest arguments
}
stop()
{
result=`pidof addtest`
kill -9 $result
echo "addtest has stoped"
}
第1行Linux 系统根据 “#!” 及该字串后面的信息确定该文件的类型,表示这个文件需要由/bin/sh和/etc/rc.common来解释执行.第2行表示启动的优先级,这里暂时用不到4~17行是一个函数,主要作用是读取/etc/config/addtest中的内容,然后根据是否打开开关在第15行将配置传递给可执行文件addtest,由它根据配置执行指定的操作.
读取配置的方法,我强烈推荐你阅读官方文档,精炼而简洁.
获取布尔值类型:config_get_bool 变量名 Section名 Section参数名
获取变量值:config_get 变量名 Section名 Section参数名19~23行对应于/etc/init.d/addtestd start.首先使用config_load 配置文件名的方法载入配置文件,然后使用config_foreach 遍历函数名 Section类型的方法,遍历配置文件中的Section.25~30行对应于/etc/init.d/addtestd stop.找到addtest这个进程的进程号,然后杀死它备注前一节提到的/etc/init.d/addtestd restart中的restart命令,在/etc/rc.common进行了定义,简单来讲就是先执行了stop命令,再执行start命令.
最后务必执行$sudo chmod 755 ~/temp/addtest/files/etc/init.d/addtestd.
前一节,我们谈到run_addtest调用可执行文件addtest,现在我们编辑这部分内容
$vim ~/temp/addtest/files/src/addtest.c
代码如下:
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
int main(int argc, char *argv[])
{
int index;
for(index=0; index<10; index++)
{
FILE *fp=fopen("/tmp/addtest","at");
system("date >> /tmp/addtest");
fprintf(fp, "%s\n", argv[2]);
fclose(fp);
printf("interval=%d\n",atoi(argv[1]));
sleep( atoi(argv[1]) );
}
return 0;
}
这部分代码比较简短,我们不再解释.需要掌握的点有:
1.argc和argv[]的使用方法
2.fopen函数,fclose函数以及fprintf函数的使用方法
3.system函数的使用方法
4.sleep函数和atoi函数的使用方法,argv[1]的类型为char需要转换为整型.
通过这个可执行文件,我们周期性地将时间戳和内容写入了/tmp/addtest文件.
最后我们写一个简单的Makefile:
$vim $vim ~/temp/addtest/files/src/Makefile
代码如下:
addtest : addtest.o
$(CC) addtest.o -o addtest
addtest.o : addtest.c
$(CC) -c addtest.c
clean :
rm *.o addtest
上一节,我们已经根据配置将指定的内容周期性地写入了/tmp/addtest.在controller那一节,我们的函数action_info读取了/tmp/addtest中的内容并访问指定页面/usr/lib/lua/luci/view/addtest_info.htm,同时将读取的内容通过变量info传递过去.
下面我们来编辑这个页面,
$vim ~/temp/addtest/files/usr/lib/lua/luci/view/addtest_info.htm
代码如下:
<%+header%>
<h2><a id="content" name="content"><%:Addtest Info%></a></h2>
<div id="content_addtest_info">
<textarea readonly="readonly" wrap="off" rows="<%=info:cmatch("\n")+2%>" id="info"><%=info:pcdata()%></textarea>
</div>
<%+footer%>
这部分和传统的html很类似,我主要是根据其他页面照猫画虎,不是很美观.有机会还要加强这个方面的学习.
不知不觉,我们居然已经将代码全部写完了,竟还有点恋恋不舍呢.下面我们用一个Makefie文件将它们打包生成一个ipk文件.
$vim ~/temp/addtest/Makefile
代码如下:
include $(TOPDIR)/rules.mk
PKG_NAME:=addtest
PKG_VERSION=1.0
PKG_RELEASE:=1
PKG_BUILD_DIR:=$(BUILD_DIR)/$(PKG_NAME)
include $(INCLUDE_DIR)/package.mk
define Package/addtest
SECTION:=utils
CATEGORY:=Utilities
TITLE:=Addtest--print something to /var/addtest
endef
define Package/addtest/description
It's a test,print something to /var/addtest cyclicaliy
endef
define Build/Prepare
mkdir -p $(PKG_BUILD_DIR)
$(CP) ./src/* $(PKG_BUILD_DIR)/
endef
define Package/addtest/postinst
#!/bin/sh
rm -rf /tmp/luci*
endef
define Build/Configure
endef
define Build/Compile
$(call Build/Compile/Default)
endef
define Package/$(PKG_NAME)/install
$(CP) ./files/* $(1)/
$(INSTALL_DIR) $(1)/bin
$(INSTALL_BIN) $(PKG_BUILD_DIR)/addtest $(1)/bin
endef
$(eval $(call BuildPackage,$(PKG_NAME)))
Makefile的解释,请参见拙作.我们这里稍作补充.
26~29行由于luci会将模块加载到/tmp目录下运行,每次新加载luci模块后,需要执行$rm -rf /tmp/luci*.这里表示安装了ipk之后,将会自动执行删除命令,重新载入.39行$(1)是传入的参数,表示系统镜像目录,你可以将之视为路由器最后的文件系统.所以这句的意思就是将我们files下的内容拷贝到路由器的文件系统中.这也是我们为什么要建立一开始那么复杂的目录树的原因.
简直像裹脚布一样,又臭又长.不要说读了,我自己写的都快有点受不了了.读到这里的人真是辛苦了,下面到了我们收获果实的时候了.
将文件拷贝到源码目录的package目录下.其余部分,请参考拙作
$cp ~/temp/addtest ~/openwrt/package
把它拷贝到你的开发板中,试试看.
我们当然希望可以一次成功,不过世间不如意之事十之八九.我来谈谈我自己的调试方法.
src部分src文件下有Makefile文件,你可以直接在编译机上执行$make生成可执行文件addtest,然后在编译机上src目录下执行$./addtest 参数1 参数2.最后记得执行$make clean.luci部分将ipk安装到开发板后,可以通过串口或者ssh的方式登录开发板,然后直接在开发板中修改文件内容,再执行$rm -rf /tmp/luci*.最后重新载入设备页面.
cgi-bin:存放luci启动脚本
luci-static:存放HTML相关文件,包含CSS、JS及网页图片等文件
C(controller):控制器,生成页面的菜单栏并定义各个页面的调用方法
M(model):数据模型,根据底层UCI配置文件生成页面
V(view):视图,HTML页面
由此可以看出,LUCI的文件框架都是以luci-base目录为基础,其他主题及模式都是在此基础之上进行增减。
cgi-bin:此文件从luci-base下拷贝过来的,存放luci启动脚本
index.html :http请求的主页面,默认是/www/index.html,这个文件里显示了登录时常看见的那句话“LuCI - Lua Configuration Interface”,同时也指定了href链接/cgi-bin/luci
luci-static:存放HTML相关文件,包含CSS、JS及网页图片等文件。不同主题的htdocs/luci-static都将拷贝到这个目录下
usr/lib/lua/路径,顾名思义,存放了与LUA相关的文件,在LUA脚本中,通过require命令引用的脚本及函数,起始路径都是该目录。同时,不同模型及主题的luasrc文件夹都拷贝到/usr/lib/lua/luci目录下,通过/etc/config/luci中的mediaurlbase字段决定当前使用的主题及语言。
果你经常需要从GitHub上Pull一些开源的项目啥的!国外的服务器还好,但是国内的服务器就非常慢了!经常是下不动或者只有 10KB 的速度。
这篇文章就来分享几个特别简单的可以加速GitHub 下载的方法,鸡肋的方法就不介绍了。
1.1、关于Gitee
官网:https://gitee.com/
OSCHINA 推出的代码托管·协作开发平台,开发者超过 500 万,托管项目超过 1000 万,汇聚几乎所有本土原创开源项目,并于 2016 年推出企业版,提供企业级代码托管服务,成为开发领域领先的 SaaS 服务提供商。
支持 Git / SVN,个人版免费5G仓库容量。
1.2、部署流程
1)注册账号
2)登陆Gitee账号,击右上角新建仓库的“+”,选择 【 从 GitHub / GitLab 导入仓库】或者【进入https://gitee.com/login注册】
3)填写要导入的项目即可(如果之前有人导入过该仓库,可以直接复用他的仓库即可)。
4)等待项目成功导入码云后,直接从码云将项目 clone 到本地,速度非常快
对比之前github的速度。
1、网址:http://g.widora.cn/
2、网址:https://d.serctl.com/
使用方法和上面一样,具体看图:
3、http://toolwa.com/github/
用法和上面类似,这里不在赘述。
前提是你有一台国外的vps,你把项目git到你的vps上,然后再从自己的vps里面下载项目,速度也会不错。比如说你安装了宝塔,可以利用宝塔面板自带的外链分享来实现下载。
前提是有一台境外的vps,搭建一个工具,然后,设置全局服务,git的速度也是很快的。这个方法这里就不讨论了。
方法都有缺陷,最好的就是最后一种方法,用Gitee的话,如果是最新版本还需要去github下载。
如果你有自己vps,那么可以先clone到VPS上,然后再拉回来。
利用第三方工具来下载也是个不错的方法。
还有一种cdn加速方法,就是寻找github的加速地址即可,不过,这个方法有点啰嗦了,不符合简洁好用的范畴,这里也就不讨论了。
如果你有更好的方法,不妨留言分享。
原文链接:https://www.haah.net/archives/4103.html
*请认真填写需求信息,我们会在24小时内与您取得联系。