context

context is not only context

下载安装

简易版

在Mac或Linux上，可以直接用脚本下载

$ mkdir context && cd context
$ curl https://shylinux.com/code/upgrade/boot_sh | bash -s install

完整版

如果对源码有兴趣，使用更丰富的功能，可以直接下载源码，

$ git clone https://github.com/shylinux/context.git

下载完源码后，如果安装了golang，就可以对源码直接进行编译， 如果没有可以去官网下载安装golang（https://golang.org/dl/）。 第一次make时，会自动下载各种依赖库，所以会慢一些。

$ cd context && make

启动服务

bin目录下是各种可执行文件，如启动脚本boot.sh与node.sh。

node.sh用来启动单机版context，boot.sh用来启动网络版context。

如下，直接运行脚本，即可启动context。

启动context后，就可以解析执行各种命令，即可是本地的shell命令，也可以是内部模块命令。

$ bin/node.sh
0[03:58:43]ssh>

文件管理

调用本地命令，查看当前目录下的文件列表，

0[10:53:25]ssh> ls
total 0
drwxr-xr-x  5 shaoying  staff  160 May 10 03:57 bin
drwxr-xr-x  5 shaoying  staff  160 May 10 03:30 etc
drwxr-xr-x  2 shaoying  staff   64 May 10 03:30 usr
drwxr-xr-x  8 shaoying  staff  256 May 10 03:36 var

调用内部命令，查看文件列表，如下dir与ls命令用途相似，但提供了更丰富的功能，如统计文件行数

5[10:56:24]ssh> dir etc
time                 size  line  filename
2019-04-14 21:29:21  316   10    common.shy
2019-04-29 21:12:28  130   7     exit.shy
2019-04-29 21:12:12  191   12    init.shy

"%"是一个内部命令，可以对前一步命令结果进行各种处理。如下按字段line排序

5[10:56:24]ssh> dir etc % order line
time                 size  line  filename
2019-04-29 21:12:12  191   12    init.shy
2019-04-14 21:29:21  316   10    common.shy
2019-04-29 21:12:28  130   7     exit.shy

如下按字段""聚合，即可得到汇总结果，所有文件的总字节数、总行数、总文件数

16[11:04:30]ssh> dir etc % group ""
time                 size  line  filename    count
2019-04-14 21:29:21  637   29    common.shy  3

时间管理

查看当前时间戳

18[11:11:01]ssh> time
1557457862000

将时间戳转换成日期

19[11:11:14]ssh> time 1557457862000
2019-05-10 11:11:02

将日期转换成时间戳

20[11:11:25]ssh> time "2019-05-10 11:11:02"
1557457862000

网卡管理

2[10:53:25]ssh> ifconfig
index  name  ip             mask  hard
5      en0   192.168.0.106  24    c4:b3:01:cf:0b:51

组建集群

context不仅只是一个shell，还可以用来组建集群。

启动服务节点

启动服务节点，使用脚本boot.sh， 与node.sh不同的是，boot.sh启动的context， 会启动web模块监听9094端口，会启动ssh模块监听9090端口。

$ cd context
$ bin/boot.sh
0[11:23:03]ssh>

启动工作节点

启动工作节点，使用脚本node.sh， 它启动的context，会主动连接本地9090端口，向服务节点注册自己。

如下，新打开一个终端，调用boot.sh，创建并启动服务节点demo。

$ cd context
$ bin/node.sh create app/demo
0[11:23:03]ssh>

如下，再打开一个终端，调用boot.sh，创建并启动服务节点led。

$ cd context
$ bin/node.sh create app/led
0[11:23:03]ssh>

调用远程命令

如下回到服务节点终端，执行remote命令，可以查看到所有远程节点。

22[11:35:12]ssh> remote
key   create_time          module          name   type
com   2019-05-09 20:57:21  ctx.nfs.file4   com    master
led   2019-05-09 20:59:28  ctx.nfs.file5   led    worker
demo  2019-05-09 20:59:28  ctx.nfs.file5   demo   worker

远程命令只需要在命令前加上节点名与冒号即可。

如下，远程调用led节点的命令。

24[11:41:15]ssh> led:pwd
/Users/shaoying/context/app/led/var

如下，远程调用demo节点的命令。

24[11:41:15]ssh> demo:pwd
/Users/shaoying/context/app/demo/var

如下，远程调用所有子节点的命令。

29[11:44:09]ssh> *:pwd
/Users/shaoying/context/app/led/var

/Users/shaoying/context/app/demo/var

启动分机服务

boot.sh不仅可以用来启动本地服务，还可以将不同的主机组建在一起。

在另外一台计算机上，重新下载安装一下context，然后启动服务节点。

其中环境变量ctx_dev，用来指定上级服务节点。

$ cd context
$ ctx_dev=http://192.168.0.106:9094 boot.sh
0[11:53:11]ssh>

回到原主机的服务节点终端， 使用remote命令，可以查看到新加的从机节点。

30[11:55:38]ssh> remote
key   create_time          module          name   type
com   2019-05-09 20:57:21  ctx.nfs.file4   com    master
mac   2019-05-10 10:53:00  ctx.nfs.file13  mac    server
led   2019-05-09 20:59:28  ctx.nfs.file5   led    worker
demo  2019-05-09 20:59:28  ctx.nfs.file5   demo   worker

当然，也可以在本地启动多个服务节点，根据ctx_dev指定不同的上级节点，可以级联，也可以并联。

$ cd context
$ ctx_dev=http://localhost:9094 boot.sh create app/sub

注意，不指定ctx_dev时，默认连接 https://shylinux.com ，如果不信任此主机，记得设置ctx_dev

网页服务

下载完整版的context，启动的服务节点，就会带有前端网页服务。

工具链

code模块提供了工具链管理。

访问服务节点：http://localhost:9094/code

因为工具链，可以直接调用各种命令，为了安全，所以需要用户认证才能授权。

可以在服务节点的终端，直接添加用户认证信息。

如下，添加一个角色为root的，用户名为who，用户密码为ppp。

25[11:54:44]ssh> ~aaa role root user who ppp

也可以在启动文件中，加入这条配置，记得重启一下服务节点

$ cat etc/local.shy
~aaa
    role root user who who

然后，在登录网页上输入用户名与密码，即可登入网页工作台。

页面工作台，只是对命令进行了一层封装，但提供了更流畅的交互。

以fieldset的形式，将各种命令以弱耦合的形式，组织在一起。

每一个fielset就是一个命令，默认的工具链有

• buffer，tmux粘贴板管理
• upload，文件上传
• dir，文件列表管理
• pod，节点列表管理
• ctx，模块列表管理
• cmd，命令行

使用pod，选择任意远程节点， 然后使用ctx，选择任意模块， 然后在cmd执行的命令，都会发送给指定的节点与模块。

知识库

wiki模块提供了知识库管理。

访问：http://localhost:9094/wiki

wiki模块会将usr/wiki目录下的md文件进行解析，生成网页文件，并自动生成目录与索引。

可以创建自己的知识库，如下创建目录与文件。

$ mkdir -p usr/wiki/some
$ echo "hello world" > usr/wiki/some/hi.md

然后在服务终端上，切换到新建的知识库，

0[10:53:25]ssh> ~wiki config wiki_level wiki/some

也可以加到启动文件中，

$ cat etc/local.shy
~wiki
    config wiki_level wiki/some

信息流

chat模块提供了信息管理。

所有目录

一级目录

• src
• etc
• bin
• var
• usr

源码目录

• src/toolkit
• src/context
• src/example
• src/plugin

配置文件

• etc/init.shy
• etc/common.shy
• etc/exit.shy

执行文件

• bin/boot.sh
• bin/node.sh
• bin/bench

日志文件

• var/log/boot.log
• var/log/error.log
• var/log/right.log
• var/log/bench.log
• var/log/debug.log
• var/run/bench.pid
• var/run/user/cert.pem
• var/run/user/key.pem
• var/run/node/cert.pem
• var/run/node/key.pem
• var/tmp/runtime.json
• var/tmp/auth.json

应用目录

• usr/template
• usr/librarys
• usr/upgrade
• usr/client

应用开发

• Windows
• Mac
• pi
• mp
• iOS
• Android

应用接口

context的应用模块都是web的子模块，在web模块启动HTTP服务后，会根据模块名与命令名自动生成路由。 web模块会将所有的HTTP请求转换成context的命令调用，所以HTTP的应用接口和普通命令，除了名字必须以"/"开头，其它没有太大区别。

当web接收到HTTP请求后，可以调用单个命令如 http://shylinux.com/code/consul 就会调用code模块下的/consul命令

可以调用多个命令如 http://shylinux.com/code/?componet_group=login 就会调用web模块下的/render命令， 根据code的componet下的login组件，依次调用每个接口的命令，然后将执行结果与参数一起，调用golang的template，渲染生成HTML。

所有命令都解析完成后就可以生成一个完整的网页。当然如果Accept是application/json，则会跳过模块渲染，直接返回多条命令的执行结果。 所以componet就是接口的集合，统一提供参数配置、权限检查、命令执行、模板渲染，降低内部命令与外部应用的耦合性，但又将前后端完全融合在一起。

如下，是web.code模块的应用接口定义。配置componet下定义了多个组件，每个组件下定义了多个接口。

login就是登录页面，下面定义了三个接口code、login、tail， 其中code，使用模板head生成网页头，会包括一些配置，如favicon可以指定图标文件，styles指定引用模式表。 其中tail，使用模板tail生成网页尾，会包括一些配置，如scripts指定引用脚本文件。

login就是网页组件了，生成一个网页登录的输入表单，并接收表单请求调用aaa模块的auth命令，进行用户身份的验证。 其中arguments指定了Form表单字段的列表。

...
var Index = &ctx.Context{Name: "code", Help: "代码中心",
	Caches: map[string]*ctx.Cache{},
	Configs: map[string]*ctx.Config{
		"skip_login": &ctx.Config{Name: "skip_login", Value: map[string]interface{}{"/consul": "true"}, Help: "免密登录"},
        "componet": &ctx.Config{Name: "componet", Value: map[string]interface{}{
            "login": []interface{}{
                map[string]interface{}{"componet_name": "code", "componet_tmpl": "head", "metas": []interface{}{
                    map[string]interface{}{"name": "viewport", "content": "width=device-width, initial-scale=0.7, user-scalable=no"},
                }, "favicon": "favicon.ico", "styles": []interface{}{"example.css", "code.css"}},

                map[string]interface{}{"componet_name": "login", "componet_help": "login", "componet_tmpl": "componet",
                    "componet_ctx": "aaa", "componet_cmd": "auth", "componet_args": []interface{}{"@sessid", "ship", "username", "@username", "password", "@password"}, "inputs": []interface{}{
                        map[string]interface{}{"type": "text", "name": "username", "value": "", "label": "username"},
                        map[string]interface{}{"type": "password", "name": "password", "value": "", "label": "password"},
                        map[string]interface{}{"type": "button", "value": "login"},
                    },
                    "display_append": "", "display_result": "",
                },

                map[string]interface{}{"componet_name": "tail", "componet_tmpl": "tail",
                    "scripts": []interface{}{"toolkit.js", "context.js", "example.js", "code.js"},
                },
            },
...

网页开发

模板

usr/template 存放了网页的模板文件，context会调用golang的template接口进行后端渲染，生成html文件。

componet下每一个接口都会指定一个模板，web模块下的/render命令会依次渲染，从而生成一个完整的网页。

• usr/template/common.tmpl 公共模板
• usr/template/code/ code模块的模板
• usr/template/wiki/ wiki
• usr/template/chat/

usr/librarys 存放了css与js

小程序

开发板

接口开发

componet

python

java

c

模块开发

应用模块

简单模块

复杂模块

脚本模块

插件模块

独立插件

扩展插件

核心模块

模块中心ctx

命令中心cli

认证中心aaa

应用中心web

网络中心tcp

存储中心nfs

集群中心ssh

数据中心mdb

系统架构

	数据流	命令流	权限流	应用流
应用层	ctx	cli	aaa	web
控制层	lex	yac	log	gdb
数据层	tcp	nfs	ssh	mdb

应用框架

模块

context内部使用模块组织功能，每个模块都可以独立编译，独立运行。 解除了代码之间的包依赖、库依赖、引用依赖、调用依赖。 通过map查找模块，通过map查找命令，通过map查找配置，从而实现完全自由的模块。

模块定义：

type Context struct { // src/contexts/ctx/ctx.go
    Name string
    Help string

    Caches   map[string]*Cache
    Configs  map[string]*Config
    Commands map[string]*Command

    ...

    contexts map[string]*Context
    context  *Context
    root     *Context

    ...
    Server
}

Name：模块名称，Help：模块帮助。 模糊搜索搜索时，会根据Name与Help进行匹配。

每个模块会有命令集合Commands，配置集合Configs，缓存集合Caches。通过这种形式提供功能集合。

contexts：所有子模块，context：指向父模块，root：指向根模块。 从而组成一个模块树，所以可以通过路由查找模块， 如ctx.web.code，code的父模块是web，web的父模块是ctx，ctx是根模块。 所以可以通过命令，查看到当前程序所有模块的信息。

缓存定义：

type Cache struct {
	Value string
	Name  string
	Help  string
	Hand  func(m *Message, x *Cache, arg ...string) string
}

Value：存放的数据，Name：变量名称，Help：变量帮助，Hand读写函数。

缓存数量是一种数据接口，用来存放一些状态量，向外部显示程序进行状态，对外部来说一般是只读的。对内部来说可读可写。 所以可以通过命令，查看到当前程序任意模块的状态数据。

如下，ncontext当前有多少个模块。nserver有多少个模块运行了守护协程。

"nserver":    &Cache{Name: "nserver", Value: "0", Help: "服务数量"},
"ncontext":   &Cache{Name: "ncontext", Value: "0", Help: "模块数量"},

缓存读写：

func (m *Message) Cap(key string, arg ...interface{}) string {}
func (m *Message) Capi(key string, arg ...interface{}) int {}
func (m *Message) Caps(key string, arg ...interface{}) bool {}

定义了缓存数据的三种读写接口。

m.Cap()只有一个参数时，会从当前模块查询缓存变量，如果查到则返回Value，如果没有，则依次查询父模块。 如果查找到根模块还没有查到找，变返回空字符串。

m.Cap()有两个参数时，同样会从当前模块依次查询父模块，直到查到变量，然后设置其值。

m.Capi()是对m.Cap()封装了一下，在int与str相互转换，从而实现用str存储int。 所有转换失败的数据，都会返回0。

m.Caps()，实现了str存储bool。返回false的值有"", "0", "false", "off", "no", "error: "，其它都返回true。

配置定义：

type Config struct {
	Value interface{}
	Name  string
	Help  string
	Hand  func(m *Message, x *Cache, arg ...string) string
}

Value：存放的数据，Name：变量名称，Help：变量帮助，Hand读写函数。 与Cache相似，只是Value的类型不再是String而是interface{}，所以可以用来存放更复杂的数据。

一般用来存放配置数据，是外部控制内部数据接口。 所以可以通过命令，实时修改当前程序任意模块的配置数据。 避免只是修改某个配置变量，就要重启整个进程，从而实现高效灵活的配置。 把每个进程当成一个生命来对待，不要轻易杀死任何一个进程。有问题可以用微创手术解决。

配置读写：

func (m *Message) Conf(key string, args ...interface{}) string {}
func (m *Message) Confi(key string, arg ...interface{}) int {}
func (m *Message) Confs(key string, arg ...interface{}) bool {}
func (m *Message) Confx(key string, args ...interface{}) string {}
func (m *Message) Confv(key string, args ...interface{}) interface{} {}
func (m *Message) Confm(key string, args ...interface{}) map[string]interface{} {}

与Cache相似，也定义了各种读写的接口。

因为interface{}可以是任意复合类型，所以数据嵌套很深时，查询会涉及各种类型转换，非常麻烦。 Conf()定义了键值链。内部去处理类型转换与嵌套的深入。 如m.Conf("runtime", "user.node")、m.Conf("runtime", []string{"user", "node"})、m.Conf("runtime", []interface{}{"user", "node"}) 都会查询配置runtime下的user下的node的值。

m.Confx()内部进行选择，如果m.Option(key)中取到了值，则直接返回m.Option(key)，否则返回m.Conf(key)。 把配置当成一个备用的默认值，如果命令参数设置了此参数，则用命令中的参数。

m.Confv()直接读写原始数据。 m.Confm()则定义了更丰富的接口，m就是map意思，直接返回map[string]interface{} m另外一个意思就是magic，可以传入各种回调函数。 如下配置node类型是map[string]interface{}，m.Confm()会遍历此map，查到value也是map[string]interface{}的键值，调用回调函数。

    ...
    m.Confm("node", func(name string, node map[string]interface{}) {
        if kit.Format(node["type"]) != "master" {
            ps = append(ps, kit.Format(node["module"]))
        }
    })
    ...

命令定义：

type Command struct {
	Form map[string]int
	Name string
	Help interface{}
	Auto func(m *Message, c *Context, key string, arg ...string) (ok bool)
	Hand func(m *Message, c *Context, key string, arg ...string) (e error)
}

Name：命令语法，Help：命令帮助。

Hand：命令处理函数，m是调用消息，c是当前模块，key是命令名，arg是命令参数。

在命令解析时，会根据Form将[key value...]形式的参数，取出存放到m.Option中，方便用key直接查找参数。 所以arg中只剩下序列参数，通过index序号查找参数。

Auto：终端自动补全函数。在使用终端每输入一个单词时，就调用此函数输出提示信息。所以在命令执行前，这个函数会被调用多次。

如下定义了trans命令

    ...
    "trans": &Command{Name: "trans option [type|data|json] limit 10 [index...]", Help: "数据转换",
        Form: map[string]int{"format": 1, "fields": -1},
        Hand: func(m *Message, c *Context, key string, arg ...string) (e error) {
            ...
        }}
    ...

命令调用：

func (m *Message) Cmd(args ...interface{}) *Message {}
func (m *Message) Cmdx(args ...interface{}) string {}
func (m *Message) Cmds(args ...interface{}) bool {}
func (m *Message) Cmdy(args ...interface{}) *Message {}
func (m *Message) Cmdm(args ...interface{}) *Message {}

m.Cmd()根据第一个参数去当前查找命令，如果没有查找到，则去父模块查找。如果没有查找，则不会执行。 剩下的参数会根据Form定义来解析，存放到m.Option中。

m.Cmds()当返回值转换成bool规则同m.Caps()与m.Confs()。 m.Cmdx()当返回值转换成str。 m.Cmdy()将结果复制到当前Message。

m.Cmdm()，m同样是magic，会根据当前会话，自动定向到远程某主机某模块，远程调用其命令，当然也可能定向到本机。

协程

消息

context内部调用都是

解析引擎

文件扫描

词法解析

语法解析

执行命令

通信框架

节点路由

每个节点在启动时，自动向上级注册，生成一个动态域名，作为本节点的地址。 如com.mac.led，led的上级节点是mac，mac的上级节点是com。 其它节点，就可以通过个这个地址查找到此节点。

在调用远程命令时，通信模块根据远程地址的第一个字段，查找子节点，查取成功后，会将剩余的地址与命令发送给查到的子节点。 子节点收到地址与命令后，继续查找子节点，直到目标节点收到命令，然后将执行结果原路返回。

在查找的过程中，如果没有查找到子节点，则会传给上级节点重新处理。

节点认证

节点加密 每个节点都有证书与密钥。每个节点在发送命令时，都会用自己的密钥签名，目标节点都会用它的证书验签。以此保证命令来源的可靠性。

节点类型

• 初始节点，没有归属的节点

• 主控节点，有用户证书与密钥的节点

• 从属节点，有用户证书的节点

• 代理节点，主控节点指定的代理节点

• 共享节点，允许多个用户控制的节点

• 认证节点，专门用来存放与查询用户证书的节点

用户在某一设备上添加自己的证书与密钥，此节点即为主控节点。 在其它节点上绑定自己的证书，此即为从属节点。

主控节点就可任意控制从属节点，从属节点不能控制主控节点，从属节点之间也不能相互控制。

主控节点可以指定代理节点，代理节点可以代替主控节点控制从属节点。

共享节点，会有多个用户，可能产生冲突，所以需要认证节点协调。

访问共享节点前，需要向认证节点注册，共享节点会从认证节点取出访问用户的信息。

节点权限

角色

每个访问用户，都会指定一个角色。 主控节点的用户默认有root权限。即拥有设备的所有控制权限。

认证节点的用户默认有tech权限。一般是部分功能。

其它节点的用户默认有void权限。即拥有最小集合的权限，一般是只读的命令。

组件

组件是功能的集合，远程访问至少要有remote与source组件的权限才可以执行命令。

每个角色下都会有多个组件的权限。

命令

命令就节点向外提供功能的最小单元。

每个组件下都会有多条命令。

规则

每条命令内部可以用组件与命令的权限机制自定义权限检查。

权限的分配完全由主控节点与从属节点自己配置，其它节点不许配置。

示例

如下配置，用户shy的角色是tech，角色tech下有两个组件remote与source，每个组件下都有命令pwd与dir，所以用户shy就可以远程调用命令dir与pwd

role tech user shy
role tech componet remote command pwd dir
role tech componet source command pwd dir

存储引擎

配置

缓存

数据