applications/luci-app-frpc/htdocs/luci-static/resources/view/frpc.js

   1 'use strict';
   2 'require view';
   3 'require ui';
   4 'require form';
   5 'require tools.widgets as widgets';
   6
   7 //      [Widget, Option, Title, Description, {Param: 'Value'}],
   8 var startupConf = [
   9         [form.Flag, 'stdout', _('Log stdout')],
  10         [form.Flag, 'stderr', _('Log stderr')],
  11         [widgets.UserSelect, 'user', _('Run daemon as user')],
  12         [widgets.GroupSelect, 'group', _('Run daemon as group')],
  13         [form.Flag, 'respawn', _('Respawn when crashed')],
  14         [form.DynamicList, 'env', _('Environment variable'), _('OS environments pass to frp for config file template, see <a href="https://github.com/fatedier/frp#configuration-file-template">frp README</a>'), {placeholder: 'ENV_NAME=value'}],
  15         [form.DynamicList, 'conf_inc', _('Additional configs'), _('Config files include in temporary config file'), {placeholder: '/etc/frp/frpc.d/frpc_full.ini'}]
  16 ];
  17
  18 var commonConf = [
  19         [form.Value, 'server_addr', _('Server address'), _('ServerAddr specifies the address of the server to connect to.<br>By default, this value is "0.0.0.0".'), {datatype: 'ipaddr'}],
  20         [form.Value, 'server_port', _('Server port'), _('ServerPort specifies the port to connect to the server on.<br>By default, this value is 7000.'), {datatype: 'port'}],
  21         [form.Value, 'http_proxy', _('HTTP proxy'), _('HttpProxy specifies a proxy address to connect to the server through. If this value is "", the server will be connected to directly.<br>By default, this value is read from the "http_proxy" environment variable.')],
  22         [form.ListValue, 'log_level', _('Log level'), _('LogLevel specifies the minimum log level. Valid values are "trace", "debug", "info", "warn", and "error".<br>By default, this value is "info".'), {values: ['trace', 'debug', 'info', 'warn', 'error']}],
  23         [form.Flag, 'disable_log_color', _('Disable log color'), _('DisableLogColor disables log colors when LogWay == "console" when set to true.'), {datatype: 'bool', default: 'true'}],
  24         [form.Value, 'token', _('Token'), _('Token specifies the authorization token used to create keys to be sent to the server. The server must have a matching token for authorization to succeed. <br>By default, this value is "".')],
  25         [form.Value, 'admin_addr', _('Admin address'), _('AdminAddr specifies the address that the admin server binds to.<br>By default, this value is "127.0.0.1".'), {datatype: 'ipaddr'}],
  26         [form.Value, 'admin_port', _('Admin port'), _('AdminPort specifies the port for the admin server to listen on. If this value is 0, the admin server will not be started.<br>By default, this value is 0.'), {datatype: 'port'}],
  27         [form.Value, 'admin_user', _('Admin user'), _('AdminUser specifies the username that the admin server will use for login.<br>By default, this value is "admin".')],
  28         [form.Value, 'admin_pwd', _('Admin password'), _('AdminPwd specifies the password that the admin server will use for login.<br>By default, this value is "admin".'), {password: true}],
  29         [form.Value, 'assets_dir', _('Assets dir'), _('AssetsDir specifies the local directory that the admin server will load resources from. If this value is "", assets will be loaded from the bundled executable using statik.<br>By default, this value is "".')],
  30         [form.Flag, 'tcp_mux', _('TCP mux'), _('TcpMux toggles TCP stream multiplexing. This allows multiple requests from a client to share a single TCP connection. If this value is true, the server must have TCP multiplexing enabled as well.<br>By default, this value is true.'), {datatype: 'bool', default: 'true'}],
  31         [form.Value, 'user', _('User'), _('User specifies a prefix for proxy names to distinguish them from other clients. If this value is not "", proxy names will automatically be changed to "{user}.{proxy_name}".<br>By default, this value is "".')],
  32         [form.Flag, 'login_fail_exit', _('Exit when login fail'), _('LoginFailExit controls whether or not the client should exit after a failed login attempt. If false, the client will retry until a login attempt succeeds.<br>By default, this value is true.'), {datatype: 'bool', default: 'true'}],
  33         [form.ListValue, 'protocol', _('Protocol'), _('Protocol specifies the protocol to use when interacting with the server. Valid values are "tcp", "kcp", and "websocket".<br>By default, this value is "tcp".'), {values: ['tcp', 'kcp', 'websocket']}],
  34         [form.Flag, 'tls_enable', _('TLS'), _('TLSEnable specifies whether or not TLS should be used when communicating with the server.'), {datatype: 'bool'}],
  35         [form.Value, 'heartbeat_interval', _('Heartbeat interval'), _('HeartBeatInterval specifies at what interval heartbeats are sent to the server, in seconds. It is not recommended to change this value.<br>By default, this value is 30.'), {datatype: 'uinteger'}],
  36         [form.Value, 'heartbeat_timeout', _('Heartbeat timeout'), _('HeartBeatTimeout specifies the maximum allowed heartbeat response delay before the connection is terminated, in seconds. It is not recommended to change this value.<br>By default, this value is 90.'), {datatype: 'uinteger'}],
  37         [form.DynamicList, '_', _('Additional settings'), _('This list can be used to specify some additional parameters which have not been included in this LuCI.'), {placeholder: 'Key-A=Value-A'}]
  38 ];
  39
  40 var baseProxyConf = [
  41         [form.ListValue, 'type', _('Proxy type'), _('ProxyType specifies the type of this proxy. Valid values include "tcp", "udp", "http", "https", "stcp", and "xtcp".<br>By default, this value is "tcp".'), {values: ['tcp', 'udp', 'http', 'https', 'stcp', 'xtcp']}],
  42         [form.Flag, 'use_encryption', _('Encryption'), _('UseEncryption controls whether or not communication with the server will be encrypted. Encryption is done using the tokens supplied in the server and client configuration.<br>By default, this value is false.'), {datatype: 'bool'}],
  43         [form.Flag, 'use_compression', _('Compression'), _('UseCompression controls whether or not communication with the server will be compressed.<br>By default, this value is false.'), {datatype: 'bool'}],
  44         [form.Value, 'local_ip', _('Local IP'), _('LocalIp specifies the IP address or host name to proxy to.'), {datatype: 'ipaddr'}],
  45         [form.Value, 'local_port', _('Local port'), _('LocalPort specifies the port to proxy to.'), {datatype: 'port'}],
  46 ];
  47
  48 var bindInfoConf = [
  49         [form.Value, 'remote_port', _('Remote port'), _('If remote_port is 0, frps will assign a random port for you'), {datatype: 'port'}]
  50 ];
  51
  52 var domainConf = [
  53         [form.Value, 'custom_domains', _('Custom domains')],
  54         [form.Value, 'sub_domain', _('Subdomain')],
  55 ];
  56
  57 var httpProxyConf = [
  58         [form.Value, 'locations', _('Locations')],
  59         [form.Value, 'http_user', _('HTTP user')],
  60         [form.Value, 'http_pwd', _('HTTP password')],
  61         [form.Value, 'host_header_rewrite', _('Host header rewrite')],
  62         // [form.Value, 'headers', _('Headers')], // FIXME
  63 ];
  64
  65 var stcpProxyConf = [
  66         [form.ListValue, 'role', _('Role'), undefined, {values: ['server', 'visitor']}],
  67         [form.Value, 'sk', _('Sk')],
  68 ];
  69
  70 function setParams(o, params) {
  71         if (!params) return;
  72         for (var key in params) {
  73                 var val = params[key];
  74                 if (key === 'values') {
  75                         for (var j = 0; j < val.length; j++) {
  76                                 var args = val[j];
  77                                 if (!Array.isArray(args))
  78                                         args = [args];
  79                                 o.value.apply(o, args);
  80                         }
  81                 } else if (key === 'depends') {
  82                         if (!Array.isArray(val))
  83                                 val = [val];
  84                         for (var j = 0; j < val.length; j++) {
  85                                 var args = val[j];
  86                                 if (!Array.isArray(args))
  87                                         args = [args];
  88                                 o.depends.apply(o, args);
  89                         }
  90                 } else {
  91                         o[key] = params[key];
  92                 }
  93         }
  94         if (params['datatype'] === 'bool') {
  95                 o.enabled = 'true';
  96                 o.disabled = 'false';
  97         }
  98 }
  99
 100 function defTabOpts(s, t, opts, params) {
 101         for (var i = 0; i < opts.length; i++) {
 102                 var opt = opts[i];
 103                 var o = s.taboption(t, opt[0], opt[1], opt[2], opt[3]);
 104                 setParams(o, opt[4]);
 105                 setParams(o, params);
 106         }
 107 }
 108
 109 function defOpts(s, opts, params) {
 110         for (var i = 0; i < opts.length; i++) {
 111                 var opt = opts[i];
 112                 var o = s.option(opt[0], opt[1], opt[2], opt[3]);
 113                 setParams(o, opt[4]);
 114                 setParams(o, params);
 115         }
 116 }
 117
 118 return view.extend({
 119         render: function() {
 120                 var m, s, o;
 121
 122                 m = new form.Map('frpc', _('frp Client'));
 123
 124                 s = m.section(form.NamedSection, 'common', 'conf');
 125                 s.dynamic = true;
 126
 127                 s.tab('common', _('Common Settings'));
 128                 s.tab('init', _('Startup Settings'));
 129
 130                 defTabOpts(s, 'common', commonConf, {optional: true});
 131
 132                 o = s.taboption('init', form.SectionValue, 'init', form.TypedSection, 'init', _('Startup Settings'));
 133                 s = o.subsection;
 134                 s.anonymous = true;
 135                 s.dynamic = true;
 136
 137                 defOpts(s, startupConf);
 138
 139                 s = m.section(form.GridSection, 'conf', _('Proxy Settings'));
 140                 s.addremove = true;
 141                 s.filter = function(s) { return s !== 'common'; };
 142                 s.renderSectionAdd = function(extra_class) {
 143                         var el = form.GridSection.prototype.renderSectionAdd.apply(this, arguments),
 144                                 nameEl = el.querySelector('.cbi-section-create-name');
 145                         ui.addValidator(nameEl, 'uciname', true, function(v) {
 146                                 if (v === 'common') return _('Name can not be "common"');
 147                                 return true;
 148                         }, 'blur', 'keyup');
 149                         return el;
 150                 }
 151
 152                 s.tab('general', _('General Settings'));
 153                 s.tab('http', _('HTTP Settings'));
 154
 155                 s.option(form.Value, 'type', _('Proxy type')).modalonly = false;
 156                 s.option(form.Value, 'local_ip', _('Local IP')).modalonly = false;
 157                 s.option(form.Value, 'local_port', _('Local port')).modalonly = false;
 158
 159                 defTabOpts(s, 'general', baseProxyConf, {modalonly: true});
 160
 161                 // TCP and UDP
 162                 defTabOpts(s, 'general', bindInfoConf, {optional: true, modalonly: true, depends: [{type: 'tcp'}, {type: 'udp'}]});
 163
 164                 // HTTP and HTTPS
 165                 defTabOpts(s, 'http', domainConf, {optional: true, modalonly: true, depends: [{type: 'http'}, {type: 'https'}]});
 166
 167                 // HTTP
 168                 defTabOpts(s, 'http', httpProxyConf, {optional: true, modalonly: true, depends: {type: 'http'}});
 169
 170                 // STCP and XTCP
 171                 defTabOpts(s, 'general', stcpProxyConf, {modalonly: true, depends: [{type: 'stcp'}, {type: 'xtcp'}]});
 172
 173                 return m.render();
 174         }
 175 });