webgm_core

简介

提供webgm的核心功能

组件接口

FCustomLogByMongo.gs

以mongo形式存储自定义日志

函数原型	函数作用
string check_log_fields(map fields)	检查日志字段

FDataBaseBasic.gs

WebGM的数据库基础组件

函数原型	函数作用
void set_inited(bool flag)	设置初始化状态
bool is_inited()	是否完成初始化
void set_debug_printf(bool flag)	设置是否调试打印
bool setup()	数据库安装
bool init_database(string db_name, string coll_name, map field2ctype, string major_key)	数据库初始化
bool create_index(string db_name, string coll_name, string index_name, array key_list, bool is_unique)	创建索引
bool exist_data(string db_name, string coll_name, map conditions)	存在数据
map find_one(string db_name, string coll_name, map conditions, map opts)	加载单条数据
array find_many(string db_name, string coll_name, map conditions, map opts)	加载所有数据
bool insert_one(string db_name, string coll_name, map data)	插入新数据
bool insert_many(string db_name, string coll_name, array data_list)	批量插入数据
bool update_one(string db_name, string coll_name, map conditions, map data, bool upsert)	更新单条数据(增量更新)
bool update_many(string db_name, string coll_name, map conditions, map data, bool upsert)	更新所有数据(增量更新)
bool replace_one(string db_name, string coll_name, map conditions, map data, bool upsert)	替换单条数据(全量覆盖)
bool delete_one(string db_name, string coll_name, map conditions)	删除单条数据
bool delete_many(string db_name, string coll_name, map conditions)	删除所有数据
void debug_printf(...)	调试打印

AccountD.gs

账号管理，支持账号的注册/修改（密码/等级）/删除

函数原型	函数作用
bool is_legal_account(mixed account)	是不是合法的帐号格式
bool is_legal_passwd(mixed passwd)	是不是合法的密码格式(必须包含数字，大小写字母，特殊字符)
bool is_default_account_and_passwd(mixed account, mixed input_text)	是否为默认账号及密码
bool register(string account, string passwd, string secret, string type, int level)	账号注册
bool remove(string account)	账号删除
bool update(string account, mixed data, bool allow_insert)	账号更新
mixed query(string account, string path)	账号信息查询

AuthD.gs

认证管理，提供认证相关的功能，支持账号认证/权限认证

函数原型	函数作用
bool can_visit_url(mixed account, string url)	权限检查，判断该用户是否有权限可以访问url
int get_url_level(string url)	获取url的最小等级限制
void add_url_level(string url, int level)	设置指定URL允许的最小等级
map get_url2level()	获取url2level
void add_url_prefix_level(string url_prefix, int level)	设置URL前缀允许的最小等级
bool verify(string account, string input_text)	账号认证
bool verify_by_password(string passwd, string input_text)	密码认证
bool verify_by_authcode(string secret, string input_text)	校验码认证

DataBaseD.gs

WebGM的数据库管理

函数原型	函数作用
bool init_database(string db_name, string coll_name, map field2ctype, string major_key)	数据库初始化
bool create_index(string db_name, string coll_name, string index_name, array key_list, bool is_unique)	创建索引
bool exist_data(string db_name, string coll_name, map conditions)	存在数据
map find_one(string db_name, string coll_name, map conditions, map opts)	加载单条数据
array find_many(string db_name, string coll_name, map conditions, map opts)	加载所有数据
bool insert_one(string db_name, string coll_name, map data)	插入新数据
bool insert_many(string db_name, string coll_name, array data_list)	批量插入数据
bool update_one(string db_name, string coll_name, map conditions, map data, bool upsert)	更新单条数据(增量更新)
bool update_many(string db_name, string coll_name, map conditions, map data, bool upsert)	更新所有数据(增量更新)
bool replace_one(string db_name, string coll_name, map conditions, map data, bool upsert)	替换单条数据(全量覆盖)
bool delete_one(string db_name, string coll_name, map conditions)	删除单条数据
bool delete_many(string db_name, string coll_name, map conditions)	删除所有数据

GmClusterD.gs

GM集群的实例管理

函数原型	函数作用
bool activated()	是否已激活GM集群
void activate(bool activate)	是否开启GM集群
map post(string url, map data, int type, map headers, map extra)	发送post请求(规范返回值)

GmUrlD.gs

GM连接管理

函数原型	函数作用
void refresh_url(map m)	刷新URL设置
void refresh_urls()	刷新所有URL设置
bool update_async(string url, int level, map flags)	URL更新

HttpLogD.gs

请求日志-请求&回包日志记录

函数原型	函数作用
bool request_log(string major_key, string source, string account, string cmd, mixed inputs)	http请求相关的日志记录
bool response_log(string major_key, int resp_code, string resp_type, mixed resp_result)	http回包相关的日志记录

JsonDataD.gs

json数据的相关操作

函数原型	函数作用
void export_to_json_file(string json_path, mixed json_data, string line_break, string tab_interval, string prefix)	按照正常的书写格式生成json文件
buffer get_json_content(mixed json_data, string line_break, string tab_interval, string prefix)	获取json文本(buffer)
string parse_json_data(mixed data, string line_break, string tab_interval, string prefix)	解析Json数据

LarkNotifyD.gs

函数原型	函数作用
void send_card(mixed content, string title, string link_url, string header_template)	发送卡片信息到飞书群(异步)
map send_card_sync(mixed content, string title, string link_url, string header_template)	发送卡片信息到飞书群(同步)
void send_message(string text)	发送普通信息到飞书群(异步)
map send_message_sync(string text)	发送普通信息到飞书群(同步)

MenuD.gs

菜单管理，扫描指定目录并记录信息

函数原型	函数作用
void refresh_menu(int level)	刷新当前菜单
map get_menus()	获取菜单配置
map get_menu2file()	获取菜单对应的配置文件
array get_web_menu(int level)	获取web的菜单列表
map load_menu(string dir, map menu2path)	加载文件夹中的菜单配置文件
bool append_internal_menu_dirs(mixed dir_or_dirs, bool on_tail)	增加内部菜单列表
bool remove_internal_menu_dirs(mixed dir_or_dirs)	移除内部菜单列表
void save_menus(string file_path)	存储菜单配置

MongoD.gs

Mongo数据库的管理

函数原型	函数作用
bool setup()	数据库安装
bool init_database(string db_name, string coll_name, map field2ctype, string major_key)	数据库初始化
bool create_index(string db_name, string coll_name, string index_name, array key_list, bool is_unique)	创建索引
bool exist_data(string db_name, string coll_name, map conditions)	存在数据
map find_one(string db_name, string coll_name, map conditions, map opts)	加载单条数据
array find_many(string db_name, string coll_name, map conditions, map opts)	加载所有数据
bool insert_one(string db_name, string coll_name, map data)	插入新数据
bool insert_many(string db_name, string coll_name, array data_list)	批量插入数据
bool update_one(string db_name, string coll_name, map conditions, map data, bool upsert)	更新单条数据(增量更新)
bool update_many(string db_name, string coll_name, map conditions, map data, bool upsert)	更新所有数据(增量更新)
bool replace_one(string db_name, string coll_name, map conditions, map data, bool upsert)	替换单条数据(全量覆盖)
bool delete_one(string db_name, string coll_name, map conditions)	删除单条数据
bool delete_many(string db_name, string coll_name, map conditions)	删除所有数据

SqliteD.gs

Sqlite数据库的管理

函数原型	函数作用
bool setup()	数据库安装
bool init_database(string db_name, string coll_name, map field2ctype, string major_key)	数据库初始化
bool create_index(string db_name, string coll_name, string index_name, array key_list, bool is_unique)	创建索引
bool exist_data(string db_name, string coll_name, map conditions)	存在数据
map find_one(string db_name, string coll_name, map conditions, map opts)	加载单条数据
array find_many(string db_name, string coll_name, map conditions, map opts)	加载所有数据
bool insert_one(string db_name, string coll_name, map data)	插入新数据
bool insert_many(string db_name, string coll_name, array data_list)	批量插入数据
bool update_one(string db_name, string coll_name, map conditions, map data, bool upsert)	更新单条数据(增量更新)
bool update_many(string db_name, string coll_name, map conditions, map data, bool upsert)	更新所有数据(增量更新)
bool replace_one(string db_name, string coll_name, map conditions, map data, bool upsert)	替换单条数据(全量覆盖)
bool delete_one(string db_name, string coll_name, map conditions)	删除单条数据
bool delete_many(string db_name, string coll_name, map conditions)	删除所有数据

TaskTimerD.gs

定时模块，支持持久化存储

函数原型	函数作用
bool create_task(string name, function func, int exec_time, int interval, int exec_limit)	自定义创建任务项
bool remove_task(string name)	移除任务项
map query_task(string name, bool remove_when_inexistence)	查询任务项
void dump()	打印任务列表

TransmitD.gs

GM命令的转发处理模块

函数原型	函数作用
void set_gm_url_func(function gm_url_func)	设置gm请求的url
mixed get_gm_url(mixed data, mixed cmd)	获取gm请求的url
void set_handler_func(function handler_func)	设置处理程序
mixed call_handler_func(mixed data, mixed cmd)	调用处理程序
map transmit_cmd_by_url(string url, mixed data, int type, map headers, map extra)	转发请求给url
map transmit_cmd_by_urls(map url2data, int type, map headers, map extra)	批量转发请求
string default_gm_url_func(mixed data, mixed cmd)	默认的获取gm请求的url
map default_handler_func(mixed data, mixed cmd)	默认的处理函数

UtilD.gs

工具模块

函数原型	函数作用
string gen_std_ctime(int time_sec)	获取标准时间ctime
string gen_mem_info(int mem_size)	生成内存信息
string gen_file_token(mixed buff_or_path)	生成文件token
void send_response_file(object res, string file_name, mixed buff_or_path)	发送文件数据的回包

hotfix_script.gs

函数原型	函数作用
string check_handler(string file_path)	(热更前的)参数检查

UIFrame.gs

UI框架对象，用于生成整个页面

函数原型	函数作用
bool set_index(int index)	设置控件的所在行索引
void append(map widget, int index)	添加UI控件

logger_service.gs

通用日志管理-服务器/客户端/游戏/崩溃/报错

函数原型	函数作用
void debug(int type_count, int account_count, int log_count)	调试接口-生成游戏日志