mirrors/cosmopolitan
1
0
Fork 0
mirror of https://github.com/jart/cosmopolitan.git synced 2025-01-31 11:37:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Polish redbean APIs and docs (#446)

Browse source 
* Remove undocumented ProgramSslCompression
* Rename GetLastModified to GetAssetLastModified
* Rename IsCompressed to IsAssetCompressed
* Reorganize currently deprecated functions
* Update sockopt documentation for clarity
This commit is contained in:
Paul Kulchenko 2022-06-23 18:54:35 -07:00 committed by GitHub
parent a9d77362f9
commit 1bce1ca2e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 71 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
tool/net/demo/redbean.lua
View file

@ -317,7 +317,7 @@ local function main()
if not IsAcceptablePath(paths[i]) then
Write(' <small>[BLOCKED]</small>')
end
if not IsCompressed(paths[i]) then
if not IsAssetCompressed(paths[i]) then
Write(' <small>[UNCOMPRESSED]</small>')
end
if (GetAssetMode(paths[i]) & 0xF000) == 0x4000 then
@ -325,7 +325,7 @@ local function main()
end
Write('<br>\r\n')
Write('Modified: ')
Write(FormatHttpDateTime(GetLastModifiedTime(paths[i])))
Write(FormatHttpDateTime(GetAssetLastModifiedTime(paths[i])))
Write('<br>\r\n')
Write('Mode: ')
Write("0%o" % {GetAssetMode(paths[i])})

98
tool/net/help.txt
View file

@ -725,6 +725,11 @@ FUNCTIONS
EscapeUser(str) → str
Escapes URL username. See kescapeauthority.c.
EvadeDragnetSurveillance(bool)
If this option is programmed then redbean will not transmit a
Server Name Indicator (SNI) when performing Fetch() requests.
This function is not available in unsecure mode.
Fetch(url:str[,body:str|{method=value:str,body=value:str,headers=table,...}])
→ status:int,{header:str=value:str,...},body:str
Sends an HTTP/HTTPS request to the specified URL. If only the URL is
@ -761,15 +766,24 @@ FUNCTIONS
GetAssetComment(path:str) → str
Returns comment text associated with asset in the ZIP central
directory. Also available as GetComment (deprecated).
directory.
Also available as GetComment (deprecated).
GetAssetLastModifiedTime(path:str) → seconds:number
Returns UNIX timestamp for modification time of a ZIP asset (or
local file if the -D flag is used).
If both a file and a ZIP asset are present, then the file is used.
Also available as GetLastModifiedTime (deprecated).
GetAssetMode(path:str) → int
Returns UNIX-style octal mode for ZIP asset (or local file if the
-D flag is used)
-D flag is used).
If both a file and a ZIP asset are present, then the file is used.
GetAssetSize(path:str) → int
Returns byte size of uncompressed contents of ZIP asset (or local
file if the -D flag is used)
file if the -D flag is used).
If both a file and a ZIP asset are present, then the file is used.
GetBody() → str
Returns the request message body if present or an empty string.
@ -927,8 +941,8 @@ FUNCTIONS
GetHttpVersion() → int
Returns the request HTTP protocol version, which can be 9 for
HTTP/0.9, 10 for HTTP/1.0, or 11 for HTTP/1.1. Also available
as GetVersion (deprecated).
HTTP/0.9, 10 for HTTP/1.0, or 11 for HTTP/1.1.
Also available as GetVersion (deprecated).
GetRandomBytes([length:int]) → str
Returns string with the specified number of random bytes (1..256).
@ -965,9 +979,10 @@ FUNCTIONS
Returns true if IP address is part of the localhost network
(127.0.0.0/8).
IsCompressed(path:str) → bool
IsAssetCompressed(path:str) → bool
Returns true if ZIP artifact at path is stored on disk using
DEFLATE compression.
Also available as IsCompressed (deprecated).
IndentLines(str[,int]) → str
Adds spaces to beginnings of multiline string. If the int
@ -1122,11 +1137,6 @@ FUNCTIONS
handshake performance 10x and eliminates a network round trip.
This function is not available in unsecure mode.
EvadeDragnetSurveillance(bool)
If this option is programmed then redbean will not transmit a
Server Name Indicator (SNI) when performing Fetch() requests.
This function is not available in unsecure mode.
ProgramSslPresharedKey(key:str,identity:str)
This function can be used to enable the PSK ciphersuites which
simplify SSL and enhance its performance in controlled
@ -2667,8 +2677,8 @@ UNIX MODULE
Tunes networking parameters.
`level` and `optname` may be one of the following. The ellipses type
signature above changes depending on which options are used.
`level` and `optname` may be one of the following pairs. The ellipses
type signature above changes depending on which options are used.
unix.getsockopt(fd:int, level:int, optname:int)
├─→ value:int
@ -2677,20 +2687,20 @@ UNIX MODULE
├─→ true
└─→ nil, unix.Errno
- `SOL_SOCKET` + `SO_TYPE`
- `SOL_SOCKET` + `SO_DEBUG`
- `SOL_SOCKET` + `SO_ACCEPTCONN`
- `SOL_SOCKET` + `SO_BROADCAST`
- `SOL_SOCKET` + `SO_REUSEADDR`
- `SOL_SOCKET` + `SO_REUSEPORT`
- `SOL_SOCKET` + `SO_KEEPALIVE`
- `SOL_SOCKET` + `SO_DONTROUTE`
- `SOL_TCP` + `TCP_NODELAY`
- `SOL_TCP` + `TCP_CORK`
- `SOL_TCP` + `TCP_QUICKACK`
- `SOL_TCP` + `TCP_FASTOPEN_CONNECT`
- `SOL_TCP` + `TCP_DEFER_ACCEPT`
- `SOL_IP` + `IP_HDRINCL`
- `SOL_SOCKET`, `SO_TYPE`
- `SOL_SOCKET`, `SO_DEBUG`
- `SOL_SOCKET`, `SO_ACCEPTCONN`
- `SOL_SOCKET`, `SO_BROADCAST`
- `SOL_SOCKET`, `SO_REUSEADDR`
- `SOL_SOCKET`, `SO_REUSEPORT`
- `SOL_SOCKET`, `SO_KEEPALIVE`
- `SOL_SOCKET`, `SO_DONTROUTE`
- `SOL_TCP`, `TCP_NODELAY`
- `SOL_TCP`, `TCP_CORK`
- `SOL_TCP`, `TCP_QUICKACK`
- `SOL_TCP`, `TCP_FASTOPEN_CONNECT`
- `SOL_TCP`, `TCP_DEFER_ACCEPT`
- `SOL_IP`, `IP_HDRINCL`
unix.getsockopt(fd:int, level:int, optname:int)
├─→ value:int
@ -2699,21 +2709,21 @@ UNIX MODULE
├─→ true
└─→ nil, unix.Errno
- `SOL_SOCKET` + `SO_SNDBUF`
- `SOL_SOCKET` + `SO_RCVBUF`
- `SOL_SOCKET` + `SO_RCVLOWAT`
- `SOL_SOCKET` + `SO_SNDLOWAT`
- `SOL_TCP` + `TCP_KEEPIDLE`
- `SOL_TCP` + `TCP_KEEPINTVL`
- `SOL_TCP` + `TCP_FASTOPEN`
- `SOL_TCP` + `TCP_KEEPCNT`
- `SOL_TCP` + `TCP_MAXSEG`
- `SOL_TCP` + `TCP_SYNCNT`
- `SOL_TCP` + `TCP_NOTSENT_LOWAT`
- `SOL_TCP` + `TCP_WINDOW_CLAMP`
- `SOL_IP` + `IP_TOS`
- `SOL_IP` + `IP_MTU`
- `SOL_IP` + `IP_TTL`
- `SOL_SOCKET`, `SO_SNDBUF`
- `SOL_SOCKET`, `SO_RCVBUF`
- `SOL_SOCKET`, `SO_RCVLOWAT`
- `SOL_SOCKET`, `SO_SNDLOWAT`
- `SOL_TCP`, `TCP_KEEPIDLE`
- `SOL_TCP`, `TCP_KEEPINTVL`
- `SOL_TCP`, `TCP_FASTOPEN`
- `SOL_TCP`, `TCP_KEEPCNT`
- `SOL_TCP`, `TCP_MAXSEG`
- `SOL_TCP`, `TCP_SYNCNT`
- `SOL_TCP`, `TCP_NOTSENT_LOWAT`
- `SOL_TCP`, `TCP_WINDOW_CLAMP`
- `SOL_IP`, `IP_TOS`
- `SOL_IP`, `IP_MTU`
- `SOL_IP`, `IP_TTL`
unix.getsockopt(fd:int, level:int, optname:int)
├─→ secs:int, nsecs:int
@ -2722,14 +2732,14 @@ UNIX MODULE
├─→ true
└─→ nil, unix.Errno
- `SOL_SOCKET` + `SO_RCVTIMEO`: If this option is specified then
- `SOL_SOCKET`, `SO_RCVTIMEO`: If this option is specified then
your stream socket will have a read() / recv() timeout. If the
specified interval elapses without receiving data, then EAGAIN
shall be returned by read. If this option is used on listening
sockets, it'll be inherited by accepted sockets. Your redbean
already does this for GetClientFd() based on the `-t` flag.
- `SOL_SOCKET` + `SO_SNDTIMEO`: This is the same as `SO_RCVTIMEO`
- `SOL_SOCKET`, `SO_SNDTIMEO`: This is the same as `SO_RCVTIMEO`
but it applies to the write() / send() functions.
unix.getsockopt(fd:int, unix.SOL_SOCKET, unix.SO_LINGER)

35
tool/net/redbean.c
View file

@ -4796,17 +4796,6 @@ static int LuaEvadeDragnetSurveillance(lua_State *L) {
return LuaProgramBool(L, &evadedragnetsurveillance);
}
static int LuaProgramSslCompression(lua_State *L) {
#ifndef UNSECURE
if (!unsecure) {
OnlyCallFromInitLua(L, "ProgramSslCompression");
conf.disable_compression = confcli.disable_compression =
!lua_toboolean(L, 1);
}
#endif
return 0;
}
static int LuaHidePath(lua_State *L) {
size_t pathlen;
const char *path;
@ -4857,7 +4846,7 @@ static int LuaGetAssetMode(lua_State *L) {
return 1;
}
static int LuaGetLastModifiedTime(lua_State *L) {
static int LuaGetAssetLastModifiedTime(lua_State *L) {
size_t pathlen;
struct Asset *a;
const char *path;
@ -4895,7 +4884,7 @@ static int LuaGetAssetSize(lua_State *L) {
return 1;
}
static int LuaIsCompressed(lua_State *L) {
static int LuaIsAssetCompressed(lua_State *L) {
size_t pathlen;
struct Asset *a;
const char *path;
@ -4964,6 +4953,7 @@ static const char *const kDontAutoComplete[] = {
"GetBody", //
"GetClientAddr", //
"GetClientFd", //
"GetComment", // deprecated
"GetCookie", //
"GetEffectivePath", //
"GetFragment", //
@ -4971,11 +4961,13 @@ static const char *const kDontAutoComplete[] = {
"GetHeaders", //
"GetHost", //
"GetHttpVersion", //
"GetLastModifiedTime", // deprecated
"GetMethod", //
"GetParam", //
"GetParams", //
"GetPass", //
"GetPath", //
"GetPayload", // deprecated
"GetPort", //
"GetRemoteAddr", //
"GetScheme", //
@ -4984,8 +4976,10 @@ static const char *const kDontAutoComplete[] = {
"GetStatus", //
"GetUrl", //
"GetUser", //
"GetVersion", // deprecated
"HasParam", //
"IsClientUsingSsl", //
"IsCompressed", // deprecated
"LaunchBrowser", //
"LuaProgramSslRequired", // TODO
"ProgramAddr", // TODO
@ -4999,7 +4993,6 @@ static const char *const kDontAutoComplete[] = {
"ProgramPrivateKey", // TODO
"ProgramSslCiphersuite", // TODO
"ProgramSslClientVerify", // TODO
"ProgramSslCompression", //
"ProgramSslTicketLifetime", //
"ProgramTimeout", // TODO
"ProgramUid", //
@ -5050,12 +5043,12 @@ static const luaL_Reg kLuaFuncs[] = {
{"FormatHttpDateTime", LuaFormatHttpDateTime}, //
{"FormatIp", LuaFormatIp}, //
{"GetAssetComment", LuaGetAssetComment}, //
{"GetAssetLastModifiedTime", LuaGetAssetLastModifiedTime}, //
{"GetAssetMode", LuaGetAssetMode}, //
{"GetAssetSize", LuaGetAssetSize}, //
{"GetBody", LuaGetBody}, //
{"GetClientAddr", LuaGetClientAddr}, //
{"GetClientFd", LuaGetClientFd}, //
{"GetComment", LuaGetAssetComment}, //
{"GetCookie", LuaGetCookie}, //
{"GetCpuCore", LuaGetCpuCore}, //
{"GetCpuCount", LuaGetCpuCount}, //
@ -5070,7 +5063,6 @@ static const luaL_Reg kLuaFuncs[] = {
{"GetHostOs", LuaGetHostOs}, //
{"GetHttpReason", LuaGetHttpReason}, //
{"GetHttpVersion", LuaGetHttpVersion}, //
{"GetLastModifiedTime", LuaGetLastModifiedTime}, //
{"GetLogLevel", LuaGetLogLevel}, //
{"GetMethod", LuaGetMethod}, //
{"GetMonospaceWidth", LuaGetMonospaceWidth}, //
@ -5078,7 +5070,6 @@ static const luaL_Reg kLuaFuncs[] = {
{"GetParams", LuaGetParams}, //
{"GetPass", LuaGetPass}, //
{"GetPath", LuaGetPath}, //
{"GetPayload", LuaGetBody}, //
{"GetPort", LuaGetPort}, //
{"GetRandomBytes", LuaGetRandomBytes}, //
{"GetRedbeanVersion", LuaGetRedbeanVersion}, //
@ -5089,7 +5080,6 @@ static const luaL_Reg kLuaFuncs[] = {
{"GetTime", LuaGetTime}, //
{"GetUrl", LuaGetUrl}, //
{"GetUser", LuaGetUser}, //
{"GetVersion", LuaGetHttpVersion}, //
{"GetZipPaths", LuaGetZipPaths}, //
{"HasControlCodes", LuaHasControlCodes}, //
{"HasParam", LuaHasParam}, //
@ -5099,7 +5089,7 @@ static const luaL_Reg kLuaFuncs[] = {
{"IsAcceptablePath", LuaIsAcceptablePath}, //
{"IsAcceptablePort", LuaIsAcceptablePort}, //
{"IsClientUsingSsl", LuaIsClientUsingSsl}, //
{"IsCompressed", LuaIsCompressed}, //
{"IsAssetCompressed", LuaIsAssetCompressed}, //
{"IsDaemon", LuaIsDaemon}, //
{"IsHeaderRepeatable", LuaIsHeaderRepeatable}, //
{"IsHiddenPath", LuaIsHiddenPath}, //
@ -5176,13 +5166,18 @@ static const luaL_Reg kLuaFuncs[] = {
{"ProgramPrivateKey", LuaProgramPrivateKey}, //
{"ProgramSslCiphersuite", LuaProgramSslCiphersuite}, //
{"ProgramSslClientVerify", LuaProgramSslClientVerify}, //
{"ProgramSslCompression", LuaProgramSslCompression}, //
{"ProgramSslFetchVerify", LuaProgramSslFetchVerify}, //
{"ProgramSslInit", LuaProgramSslInit}, //
{"ProgramSslPresharedKey", LuaProgramSslPresharedKey}, //
{"ProgramSslRequired", LuaProgramSslRequired}, //
{"ProgramSslTicketLifetime", LuaProgramSslTicketLifetime}, //
#endif
// deprecated
{"GetPayload", LuaGetBody}, //
{"GetComment", LuaGetAssetComment}, //
{"GetVersion", LuaGetHttpVersion}, //
{"IsCompressed", LuaIsAssetCompressed}, //
{"GetLastModifiedTime", LuaGetAssetLastModifiedTime}, //
};
static const luaL_Reg kLuaLibs[] = {