The review of track T2 found these; each has a test in tests/mp-sim-*.
- Built-ins: an arg, array entry or draft that is '__proto__', 'constructor'
or 'prototype' is refused by the envelope check and again by the realm
(free text may still say them). After every realm call the trampoline
checks the realm's built-ins against what they were at load; a realm
whose built-ins changed answers {srvErr, polluted} and is replaced from
the worker's mark like one that timed out. S as one JSON per key is a
null-prototype object, so the epilogue's for…in never reads a prototype.
- A realm that cannot be built again is never used again: rebuild() tries
once more without the packed R, and when that fails too the network is
dropped (NO_REALM), and the engine tells the host (opts.onLost).
- A mark that fails or runs out of time changes nothing: it clears the old
mark first, the realm is built again from its own save, never from an
older mark, and the reply names the mark. A day rebuilds only from its
own attempt's mark.
- A day whose alone or nets is not a list is refused whole (ERR); a throw
in a load or day step answers that call, never ends the worker.
- An exit counts against the session the worker was running (the worker
says so before each job and step), else as before. Workers of their own
are capped (opts.maxOwn, 4): past that a session is given up.
- A worker that exits before it is ready is started again after a pause
that doubles; after 5 in a row every call answers SIM_DOWN.
- The game text is read and compiled once, in createEngine: a src/ that
does not compile throws there, and every worker, also one started after
an exit, runs the game engine.simId names.
- A damaged route memory never breaks a save that loads (routed from
nothing, logged), and only a server network loads (S.mp.sim, Normal).
- Routing memory (UI.rk, UI.rkR) is kept by the in-place restore and
carried in rt (rk), so a reloaded or rolled-back network skips the same
routings as the one that kept going.
- A fresh realm takes over the fx of the one it replaces (the mark's after
a failed call, all of them after a read): badges, windows and toasts
waiting for a page are not lost to a timeout.
- Windows: the stand-in elements answer querySelector from what was
written (a [data-x] marker) and have a working classList, never the
inert proxy that said every window is open. A request's ctx may name the
open window, ctx.win = {k, ui} (mp-sim-acts.js WINDOWS: bstd, routing,
charter, ops, pie), with the view state only the page holds (the
intern's POP, the pie window's tab and POP), checked in the realm. This
is an addition to the contract of design 5.8 that the page (T4) sends.
The stand-in is hidden again after an act.
- xpBuild's via is a TEXT arg (256): a six-span express fits.
- actDone, askDone and pulled carry ms, the worker time of the call;
engine.mem() and engine.has(code, nid) are public; prefs() passes a
realm's err through; after close() every call rejects CLOSED.
- The fake engine fails as the engine does (NO_REALM, ERR, a load without
a save, a day of an unknown session or naming an unloaded network,
GAVE_UP, SIM_DOWN, CLOSED, onLost), its greet says its one-shots once and
never 'told'; a test runs the same edge calls on both.
- SIM_DRAFT is built from DRAFT_TYPES.
616 lines
19 KiB
JavaScript
616 lines
19 KiB
JavaScript
// What a page of a server-run network may ask the session server to do, as plain data, and the envelope check every
|
||
// request body passes before anything reaches a game (docs: the server-sim design, sections 5.8-5.9 and 10).
|
||
// Shared by the realm (scripts/lib/mp-sim-realm.js), the host (scripts/lib/mp-sim.js) and the page's own copies
|
||
// (src/game/98-server-play/40-acts.js), which tests hold equal to these tables. Plain data only: no game code here,
|
||
// and nothing here is ever evaluated.
|
||
//
|
||
// Every ACT is in exactly one of SEND, ASK, VOTE, LOCAL or PUZZLE (tests/mp-sim-contract.test.js names the act and this
|
||
// file when one is not). SEND is the agent's API_CMD minus the pz* acts and teCheck, traceRun, closeModal, plus
|
||
// connCancel, pieRename and tutSkip: a test derives it again, so nobody counts it by hand.
|
||
'use strict';
|
||
|
||
// Acts that change the game: the page sends them, the server runs them as a click (ACT[act](args)).
|
||
const SEND = [
|
||
'accept',
|
||
'ad',
|
||
'addCh',
|
||
'addGen',
|
||
'addPair',
|
||
'addRouter',
|
||
'addSite',
|
||
'applyCn',
|
||
'bstdApply',
|
||
'bstdSet',
|
||
'buildLink',
|
||
'buildPop',
|
||
'buildScrub',
|
||
'buyIx',
|
||
'buyNni',
|
||
'buySat',
|
||
'buySpare',
|
||
'buyTE',
|
||
'buyTransit',
|
||
'buyVxc',
|
||
'cache',
|
||
'cacheSite',
|
||
'callBank',
|
||
'cancelIx',
|
||
'cancelPni',
|
||
'cancelTransit',
|
||
'cancelVxc',
|
||
'charter',
|
||
'cleanPipe',
|
||
'confGo',
|
||
'confSponsor',
|
||
'connCancel',
|
||
'coreLab',
|
||
'coreSet',
|
||
'coreUp',
|
||
'crews',
|
||
'ddosAuto',
|
||
'ddosEngage',
|
||
'ddosTest',
|
||
'decline',
|
||
'declineLoan',
|
||
'decomGo',
|
||
'demoAsk',
|
||
'dkAccept',
|
||
'dkHaggle',
|
||
'dkOptOut',
|
||
'dkStay',
|
||
'dkWalk',
|
||
'downIx',
|
||
'downP',
|
||
'downT',
|
||
'dropBiz',
|
||
'fixInc',
|
||
'foundIx',
|
||
'hackback',
|
||
'hwLock',
|
||
'ip4Back',
|
||
'ip4Buy',
|
||
'ip4Lease',
|
||
'ip4Nat',
|
||
'ip4Nat64',
|
||
'ip4Out',
|
||
'ip4Return',
|
||
'ip4Sell',
|
||
'ip6Go',
|
||
'ip6Stop',
|
||
'lagIx',
|
||
'lagNni',
|
||
'lagP',
|
||
'lagT',
|
||
'launchBB',
|
||
'layShip',
|
||
'listFiber',
|
||
'metricMode',
|
||
'metricSet',
|
||
'mkBanana',
|
||
'mktCfg',
|
||
'mktHold',
|
||
'mktRoute',
|
||
'myIxUp',
|
||
'opsCap',
|
||
'opsFire',
|
||
'opsFloor',
|
||
'opsHire',
|
||
'opsNewPop',
|
||
'opsParam',
|
||
'opsPop',
|
||
'opsToggle',
|
||
'opsTpl',
|
||
'orderCable',
|
||
'orderDf',
|
||
'pathAuto',
|
||
'pathMove',
|
||
'pathPin',
|
||
'peer',
|
||
'peerAll',
|
||
'peerPol',
|
||
'pieAnt',
|
||
'pieBid',
|
||
'pieDish',
|
||
'pieExim',
|
||
'pieFactory',
|
||
'pieFound',
|
||
'pieLaunch',
|
||
'pieLic',
|
||
'pieName',
|
||
'piePad',
|
||
'pieRd',
|
||
'pieRename',
|
||
'pieSafe',
|
||
'pieSpatPick',
|
||
'pni',
|
||
'pniAll',
|
||
'pniChase',
|
||
'popStdClear',
|
||
'popStdSet',
|
||
'regen',
|
||
'renameGo',
|
||
'renewLet',
|
||
'renewMatch',
|
||
'renewMeet',
|
||
'repayLoan',
|
||
'rmCache',
|
||
'rmCh',
|
||
'rmLink',
|
||
'rmNni',
|
||
'rmRouter',
|
||
'rmScrub',
|
||
'rmSite',
|
||
'rs',
|
||
'rtbh',
|
||
'sacrif',
|
||
'salesAuto',
|
||
'salesFire',
|
||
'salesHire',
|
||
'salesMin',
|
||
'salesRen',
|
||
'salesVp',
|
||
'satSize',
|
||
'scrubMode',
|
||
'scrubUp',
|
||
'seaRush',
|
||
'seatBuy',
|
||
'seatNo',
|
||
'sellSpare',
|
||
'setCarry',
|
||
'setChCount',
|
||
'setMetric',
|
||
'setPref',
|
||
'setRoute',
|
||
'setStandby',
|
||
'siteSet',
|
||
'spares',
|
||
'subUpgrade',
|
||
'takeLoan',
|
||
'teClear',
|
||
'teDeploy',
|
||
'teToggle',
|
||
'teleBuild',
|
||
'teleRm',
|
||
'teleTrk',
|
||
'togglePrem',
|
||
'tutSkip',
|
||
'unlistFiber',
|
||
'unpeer',
|
||
'unrtbh',
|
||
'upLink',
|
||
'upRouter',
|
||
'upSys',
|
||
'upVxc',
|
||
'utilityCaches',
|
||
'utilityKit',
|
||
'utilityPeers',
|
||
'utilityRouteServers',
|
||
'xpBuild',
|
||
'xpCh',
|
||
];
|
||
// What-ifs the server answers with the window they open, putting the game back as it was (5.9).
|
||
const ASK = ['linkCheck', 'teCheck', 'teSlop'];
|
||
// The clock's buttons: on a server network they are a vote for the session's speed (4.5).
|
||
const VOTE = ['phonePlay', 'phoneSpeed', 'speed'];
|
||
// The page runs these itself: views, drafts, settings, slots, session acts, teOpt.
|
||
const LOCAL = [
|
||
'addParallel',
|
||
'animSet',
|
||
'bank',
|
||
'bankClose',
|
||
'bstdOpen',
|
||
'chaosSet',
|
||
'chartToggle',
|
||
'closeModal',
|
||
'closePanel',
|
||
'cnPrem',
|
||
'connCity',
|
||
'connF',
|
||
'connFor',
|
||
'connNet',
|
||
'connOpen',
|
||
'connSort',
|
||
'cont',
|
||
'custCity',
|
||
'custF',
|
||
'custGo',
|
||
'custOpen',
|
||
'custSort',
|
||
'dash',
|
||
'dashClose',
|
||
'dashLink',
|
||
'dashSort',
|
||
'dashTab',
|
||
'decomOpen',
|
||
'decomToggle',
|
||
'dfMode',
|
||
'dfSrc',
|
||
'dfSys',
|
||
'exportSave',
|
||
'findGo',
|
||
'findOpen',
|
||
'focusCity',
|
||
'goConn',
|
||
'goEgress',
|
||
'help',
|
||
'helpClose',
|
||
'importGo',
|
||
'importPick',
|
||
'install',
|
||
'ip4Open',
|
||
'ip4Pick',
|
||
'keepPlaying',
|
||
'keys',
|
||
'langSet',
|
||
'leaseSwap',
|
||
'leftTab',
|
||
'listMore',
|
||
'logAll',
|
||
'logOpen',
|
||
'mapSet',
|
||
'marketOpen',
|
||
'meetGo',
|
||
'menu',
|
||
'modeSet',
|
||
'models',
|
||
'mpBack',
|
||
'mpChat',
|
||
'mpCopyLink',
|
||
'mpDoor',
|
||
'mpJoin',
|
||
'mpKeep',
|
||
'mpLeave',
|
||
'mpLeaveAsk',
|
||
'mpNewer',
|
||
'mpOpen',
|
||
'mpShare',
|
||
'mpStart',
|
||
'mute',
|
||
'netFilter',
|
||
'netFocus',
|
||
'newgame',
|
||
'nocWindow',
|
||
'offerStep',
|
||
'openVxc',
|
||
'opsCity',
|
||
'opsOpen',
|
||
'ownCab',
|
||
'pathOpen',
|
||
'phoneTab',
|
||
'pickHome',
|
||
'pickStart',
|
||
'pieCity',
|
||
'pieGlobeNight',
|
||
'pieGovOpen',
|
||
'pieHi',
|
||
'pieIns',
|
||
'pieLas',
|
||
'pieOpen',
|
||
'pieSpatOpen',
|
||
'pieTab',
|
||
'pitchSkip',
|
||
'pniAllOpen',
|
||
'pniAllSize',
|
||
'pniFilter',
|
||
'pniGrp',
|
||
'pniSort',
|
||
'popGo',
|
||
'popStep',
|
||
'popsReg',
|
||
'popsSort',
|
||
'prefSet',
|
||
'presetSet',
|
||
'puzzleDoor',
|
||
'puzzleMenu',
|
||
'randomName',
|
||
'rename',
|
||
'resetAsk',
|
||
'route',
|
||
'routingOpen',
|
||
'salesOpen',
|
||
'satOpen',
|
||
'scenarios',
|
||
'seaDesign',
|
||
'seaPackage',
|
||
'selLink',
|
||
'settings',
|
||
'settingsClose',
|
||
'share',
|
||
'shareDl',
|
||
'shareGo',
|
||
'slotBack',
|
||
'slotDel',
|
||
'slotDelGo',
|
||
'slotExport',
|
||
'slotMenu',
|
||
'slotRetry',
|
||
'slotSpace',
|
||
'slotSwitch',
|
||
'slotTake',
|
||
'soundSet',
|
||
'start',
|
||
'startScn',
|
||
'startWeekly',
|
||
'tab',
|
||
'tailTog',
|
||
'teBack',
|
||
'teClose',
|
||
'teEdit',
|
||
'teExample',
|
||
'teHelp',
|
||
'teOpt',
|
||
'teRecipe',
|
||
'themeSet',
|
||
'toTitle',
|
||
'toggleLeft',
|
||
'trace',
|
||
'traceCopy',
|
||
'traceMode',
|
||
'traceRun',
|
||
'updateLater',
|
||
'updateNow',
|
||
'utilities',
|
||
'utilityPick',
|
||
'via',
|
||
'vpSet',
|
||
'whatsNewShow',
|
||
'wsShare',
|
||
'xpOpen',
|
||
'zoomStep',
|
||
];
|
||
// Puzzles never run on the server: they stay on the device, like everything that starts with pz.
|
||
const PUZZLE = [
|
||
'pzAddPar',
|
||
'pzArAll',
|
||
'pzArGo',
|
||
'pzArNext',
|
||
'pzArSkip',
|
||
'pzArStart',
|
||
'pzCity',
|
||
'pzDiv',
|
||
'pzFinish',
|
||
'pzLeave',
|
||
'pzLink',
|
||
'pzLinkTo',
|
||
'pzLook',
|
||
'pzMkSkip',
|
||
'pzMonkey',
|
||
'pzPop',
|
||
'pzReset',
|
||
'pzRetry',
|
||
'pzRmLink',
|
||
'pzRmPop',
|
||
'pzRoute',
|
||
'pzRtAdd',
|
||
'pzRtModel',
|
||
'pzRtRm',
|
||
'pzShare',
|
||
'pzStart',
|
||
'pzTab',
|
||
'pzTier',
|
||
'pzUndo',
|
||
'pzVia',
|
||
'pzWeekly',
|
||
];
|
||
|
||
/* Two-click buttons: the first click arms the button on the page (a view change), only the second is sent, with
|
||
confirmed:true. 'arg': the act takes ok:1 and runs at once. Anything else: the key the first click writes to
|
||
UI.confirm, as a template over the act's args ({id} is String(args.id)); the server sets UI.confirm to it and runs the
|
||
act once. */
|
||
const CONFIRM = {
|
||
cancelIx: 'arg',
|
||
cancelPni: 'arg',
|
||
cancelTransit: 'arg',
|
||
cancelVxc: '{id}',
|
||
connCancel: 'cc:{k}:{id}',
|
||
dkOptOut: 'dk{city}{n}',
|
||
dropBiz: '{id}',
|
||
ip4Sell: '{id}',
|
||
opsFire: 'opsFire',
|
||
repayLoan: '{id}',
|
||
rmLink: '{id}',
|
||
rmScrub: 'scrub:{city}',
|
||
rmSite: 'site{city}',
|
||
salesFire: 'salesFire',
|
||
teleRm: 'tele:{city}',
|
||
};
|
||
// The UI.confirm key a preset act's first click writes (null for 'arg' acts and acts that do not confirm).
|
||
const SRV_ARM = Object.fromEntries(Object.entries(CONFIRM).filter(([, v]) => v !== 'arg'));
|
||
function armKey(act, args) {
|
||
const t = Object.prototype.hasOwnProperty.call(SRV_ARM, act) ? SRV_ARM[act] : null;
|
||
return t === null ? null : t.replace(/\{(\w+)\}/g, (m, k) => String(args && args[k] !== undefined ? args[k] : ''));
|
||
}
|
||
|
||
/* The UI drafts an act reads, and the only UI keys a request may set (its ui object). Types are checked here; the realm
|
||
checks the values against the game's catalogs (cities, CABLES, DF_SYS, SEA_DESIGNS, the route picker's values). */
|
||
const DRAFTS = {
|
||
buildLink: ['pending', 'route', 'via', 'cnPrem'],
|
||
decomGo: ['decom'],
|
||
orderCable: ['pending', 'seaDesign', 'seaterminal', 'seaengineering'],
|
||
orderDf: ['pending', 'dfSrc', 'dfSys'],
|
||
pieLaunch: ['pieIns', 'pieLas'],
|
||
teDeploy: ['slop'],
|
||
};
|
||
// pair: {a, b}, two different city-like ids; id: a short id string; ids: an array of at most 200 of them (a Set in the game).
|
||
const DRAFT_TYPES = {
|
||
cnPrem: 'boolean',
|
||
decom: 'ids',
|
||
dfSrc: ['lease', 'build', 'cable'],
|
||
dfSys: 'id',
|
||
pending: 'pair',
|
||
pieIns: 'boolean',
|
||
pieLas: 'boolean',
|
||
route: 'string',
|
||
seaDesign: 'id',
|
||
seaengineering: 'boolean',
|
||
seaterminal: 'boolean',
|
||
slop: 'boolean',
|
||
via: 'string',
|
||
};
|
||
|
||
// Args longer than the envelope's 64 characters: their own cap (the game cuts the texts shorter itself).
|
||
const TEXT = {
|
||
metricSet: { v: 16 },
|
||
// A pinned path's cities, comma-separated: a long path is longer than 64 characters.
|
||
pathPin: { via: 1024 },
|
||
pieRename: { name: 64 },
|
||
renameGo: { name: 64 },
|
||
teCheck: { script: 4000 },
|
||
teDeploy: { script: 4000 },
|
||
utilityCaches: { quote: 1024 },
|
||
// An express's spans, as link ids joined by ',' (up to XP_HOPS = 6 ids of about 10 characters).
|
||
xpBuild: { via: 256 },
|
||
};
|
||
|
||
/* Acts that charge a total the player saw in a window, planned again at the click: the arg that carries what the window
|
||
showed. The game refuses a different one ("The quote changed"); the server also refuses a request without it.
|
||
'quote' is the plan's key (a string), any other name the total (a number). pniAll: the exact total (fixed prices, so
|
||
the total names the plan). bstdApply: the plan's key, plus its total q, which may drift 1% (hardware prices move
|
||
daily under the market rule). utilityKit: the total, within 1%. utilityCaches: the list of boxes. */
|
||
const QUOTE = {
|
||
bstdApply: 'quote',
|
||
pniAll: 'q',
|
||
utilityCaches: 'quote',
|
||
utilityKit: 'cost',
|
||
};
|
||
|
||
/* The windows a request's ctx.win may name: the one the page has open when the click came from inside it. The game asks
|
||
which window is open by its class and by a marker inside it (pieRe: class 'pie'; bstdShown: [data-sheet="bstd"];
|
||
routingRefresh: [data-routing]; charter), so the realm's stand-in has to be that window, or a redraw on the server
|
||
opens another one. c: its class (#modal's className); sel: the marker inside #modalCard, if it has one; ui: the view
|
||
state it draws from that only the page holds (set by LOCAL acts: the intern window's POP, the pie window's tab and
|
||
POP), each checked against the game in the realm. The page names the first entry, in this order, whose c is the open
|
||
window's class and whose sel (when it has one) matches inside it; a window none names is sent as ctx.modal alone. */
|
||
const WINDOWS = {
|
||
bstd: { c: 'ops', sel: '[data-sheet="bstd"]' },
|
||
routing: { c: '', sel: '[data-routing]' },
|
||
charter: { c: 'charter' },
|
||
ops: { c: 'ops', ui: ['opsCity'] },
|
||
pie: { c: 'pie', ui: ['pieCity', 'pieTab'] },
|
||
};
|
||
|
||
const ID_RE = /^[a-z0-9]{8,16}$/, SIM_RE = /^[0-9a-f]{12}$/, KEY_RE = /^[A-Za-z][A-Za-z0-9]{0,15}$/, VIEW_RE = /^[a-z0-9]{1,16}$/, SHORT_RE = /^[A-Za-z0-9_.:|~-]{1,40}$/;
|
||
const SPEEDS = [0, 0.5, 1, 2, 4, 8];
|
||
// The viewport a request's ctx may set on the realm, in CSS pixels: checkEnvelope clamps ctx.w and ctx.h into it.
|
||
const VIEW_MIN = 200, VIEW_MAX = 4000;
|
||
const PREFS = ['pauseFurious', 'pauseIncident', 'warnUnhappy'];
|
||
const SETS = { SEND: new Set(SEND), ASK: new Set(ASK), CONFIRM: new Set(Object.keys(CONFIRM)) };
|
||
const own = (o, k) => Object.prototype.hasOwnProperty.call(o, k);
|
||
const plain = (o) => !!o && typeof o === 'object' && !Array.isArray(o) && (Object.getPrototypeOf(o) === Object.prototype || Object.getPrototypeOf(o) === null);
|
||
const prim = (v, cap) => v === null || typeof v === 'boolean' || (typeof v === 'number' && Number.isFinite(v)) || (typeof v === 'string' && v.length <= cap);
|
||
// Keys a request object may never carry, whatever the regex says; nor values, where a value names something: written
|
||
// through as a key (S.pops[city]), they reach a prototype. Free text (TEXT) may say them.
|
||
const BAD_KEY = new Set(['__proto__', 'constructor', 'prototype']);
|
||
const badVal = (v) => (typeof v === 'string' ? BAD_KEY.has(v) : Array.isArray(v) ? v.some(badVal) : !!v && typeof v === 'object' && Object.keys(v).some((k) => BAD_KEY.has(k) || badVal(v[k])));
|
||
|
||
function bad(error, code = 400, extra = {}) { return { ok: false, code, error, ...extra }; }
|
||
|
||
function checkArgs(act, args) {
|
||
if (!plain(args)) return 'args must be an object';
|
||
const keys = Object.keys(args);
|
||
if (keys.length > 12) return 'too many args';
|
||
const caps = own(TEXT, act) ? TEXT[act] : {};
|
||
for (const k of keys) {
|
||
if (!KEY_RE.test(k) || BAD_KEY.has(k)) return `bad arg name ${JSON.stringify(k).slice(0, 40)}`;
|
||
const v = args[k], cap = own(caps, k) ? caps[k] : 64;
|
||
if (!own(caps, k) && badVal(v)) return `bad arg ${k}`;
|
||
if (Array.isArray(v)) { if (v.length > 64 || !v.every((x) => prim(x, 64))) return `bad arg ${k}`; continue; }
|
||
if (!prim(v, cap)) return `bad arg ${k}`;
|
||
}
|
||
if (own(QUOTE, act)) { const q = args[QUOTE[act]]; if (QUOTE[act] === 'quote' ? typeof q !== 'string' : !(typeof q === 'number' && Number.isFinite(q))) return `${act} needs the quoted ${QUOTE[act]}`; }
|
||
return null;
|
||
}
|
||
function checkDraft(k, v) {
|
||
const t = DRAFT_TYPES[k];
|
||
if (badVal(v)) return false;
|
||
if (Array.isArray(t)) return t.includes(v);
|
||
if (t === 'boolean') return typeof v === 'boolean';
|
||
if (t === 'string') return typeof v === 'string' && v.length <= 64;
|
||
if (t === 'id') return typeof v === 'string' && SHORT_RE.test(v);
|
||
// Two different places: the game's own drag never opens a link from a city to itself.
|
||
if (t === 'pair') return plain(v) && Object.keys(v).length === 2 && typeof v.a === 'string' && typeof v.b === 'string' && SHORT_RE.test(v.a) && SHORT_RE.test(v.b) && v.a !== v.b;
|
||
if (t === 'ids') return Array.isArray(v) && v.length <= 200 && v.every((x) => typeof x === 'string' && SHORT_RE.test(x));
|
||
return false;
|
||
}
|
||
function checkCtx(c) {
|
||
if (!plain(c)) return 'ctx must be an object';
|
||
for (const k of Object.keys(c)) {
|
||
const v = c[k];
|
||
if (k === 'sel') { if (v !== null && !(plain(v) && Object.keys(v).length === 2 && (v.type === 'city' || v.type === 'link') && typeof v.id === 'string' && SHORT_RE.test(v.id))) return 'bad ctx.sel'; }
|
||
else if (k === 'tab' || k === 'left') { if (v !== null && !(typeof v === 'string' && VIEW_RE.test(v))) return `bad ctx.${k}`; }
|
||
else if (k === 'modal' || k === 'coarse') { if (typeof v !== 'boolean') return `bad ctx.${k}`; }
|
||
// The page sends its innerWidth/innerHeight as they are: a 5120-px monitor, or a desktop zoomed out, is wider than
|
||
// anything the layout tells apart (isPhone() and the like only ask whether it is under about 760). Clamped, not refused.
|
||
else if (k === 'w' || k === 'h') { if (!(typeof v === 'number' && Number.isFinite(v) && v > 0 && v <= 1e5)) return `bad ctx.${k}`; c[k] = Math.min(VIEW_MAX, Math.max(VIEW_MIN, v)); }
|
||
// The open window, by name, with its view state (WINDOWS): {k, ui?}.
|
||
else if (k === 'win') {
|
||
const W = plain(v) && typeof v.k === 'string' && own(WINDOWS, v.k) ? WINDOWS[v.k] : null;
|
||
if (!W || !Object.keys(v).every((x) => x === 'k' || x === 'ui')) return 'bad ctx.win';
|
||
if (v.ui !== undefined && !(plain(v.ui) && Object.keys(v.ui).every((u) => (W.ui || []).includes(u) && (v.ui[u] === null || (typeof v.ui[u] === 'string' && SHORT_RE.test(v.ui[u]) && !BAD_KEY.has(v.ui[u])))))) return 'bad ctx.win.ui';
|
||
}
|
||
else return `unknown ctx.${String(k).slice(0, 20)}`;
|
||
}
|
||
return null;
|
||
}
|
||
const bool = (v) => v === undefined || typeof v === 'boolean';
|
||
|
||
/* The envelope of one request body, before anything reaches a game. kind: 'act' | 'ask' | 'vote' | 'here' | 'prefs'.
|
||
opts.sim: the server's build id; a request built by another one answers 409 {old:true}. Returns {ok:true} or
|
||
{ok:false, code (400 or 409), error, old?}. Only shapes are checked here; what the ids name is the realm's to check.
|
||
One repair, in place: ctx.w and ctx.h (any finite width up to 100000) are clamped into VIEW_MIN–VIEW_MAX, so the
|
||
realm only ever sees a viewport in that range. */
|
||
function checkEnvelope(kind, body, opts = {}) {
|
||
if (!plain(body)) return bad('the body must be a JSON object');
|
||
const keys = Object.keys(body);
|
||
const only = (allowed) => { for (const k of keys) if (!allowed.includes(k)) return `unknown field ${JSON.stringify(k).slice(0, 40)}`; return null; };
|
||
const simOk = () => {
|
||
if (typeof body.sim !== 'string' || !SIM_RE.test(body.sim)) return bad('sim must be the page\'s build id');
|
||
if (opts.sim && body.sim !== opts.sim) return bad('this page is from another build', 409, { old: true });
|
||
return null;
|
||
};
|
||
if (kind === 'act' || kind === 'ask') {
|
||
const e = only(kind === 'act' ? ['rid', 'dev', 'sim', 'act', 'args', 'ui', 'confirmed', 'ctx'] : ['rid', 'dev', 'sim', 'act', 'args', 'ctx']);
|
||
if (e) return bad(e);
|
||
if (typeof body.rid !== 'string' || !ID_RE.test(body.rid)) return bad('bad rid');
|
||
if (typeof body.dev !== 'string' || !ID_RE.test(body.dev)) return bad('bad dev');
|
||
const s = simOk(); if (s) return s;
|
||
if (typeof body.act !== 'string' || !(kind === 'act' ? SETS.SEND : SETS.ASK).has(body.act)) return bad(`${kind} ${JSON.stringify(String(body.act).slice(0, 40))} is not one the server runs`);
|
||
const a = checkArgs(body.act, body.args === undefined ? {} : body.args); if (a) return bad(a);
|
||
if (body.ui !== undefined) {
|
||
if (kind !== 'act' || !plain(body.ui)) return bad('bad ui');
|
||
const allowed = own(DRAFTS, body.act) ? DRAFTS[body.act] : [];
|
||
for (const k of Object.keys(body.ui)) if (!allowed.includes(k) || !checkDraft(k, body.ui[k])) return bad(`bad ui.${String(k).slice(0, 20)}`);
|
||
}
|
||
if (body.confirmed !== undefined && (body.confirmed !== true || !SETS.CONFIRM.has(body.act))) return bad('confirmed only goes with a two-click act');
|
||
if (body.ctx !== undefined) { const c = checkCtx(body.ctx); if (c) return bad(c); }
|
||
return { ok: true };
|
||
}
|
||
if (kind === 'vote') {
|
||
const e = only(['speed', 'sim']); if (e) return bad(e);
|
||
const s = simOk(); if (s) return s;
|
||
if (body.speed !== null && !SPEEDS.includes(body.speed)) return bad('bad speed');
|
||
return { ok: true };
|
||
}
|
||
if (kind === 'here') {
|
||
const e = only(['dev', 'hidden', 'hold', 'idle', 'away', 'view']); if (e) return bad(e);
|
||
if (typeof body.dev !== 'string' || !ID_RE.test(body.dev)) return bad('bad dev');
|
||
if (!['hidden', 'hold', 'idle', 'away'].every((k) => bool(body[k]))) return bad('bad flag');
|
||
if (body.view !== undefined) {
|
||
const v = body.view;
|
||
if (v !== null && !(plain(v) && Object.keys(v).every((k) => (k === 'link' || k === 'peer') && (v[k] === null || (typeof v[k] === 'string' && SHORT_RE.test(v[k])))))) return bad('bad view');
|
||
}
|
||
return { ok: true };
|
||
}
|
||
if (kind === 'prefs') {
|
||
const e = only(['prefs', 'lang']); if (e) return bad(e);
|
||
if (body.prefs !== undefined && !(plain(body.prefs) && Object.keys(body.prefs).every((k) => PREFS.includes(k) && typeof body.prefs[k] === 'boolean'))) return bad('bad prefs');
|
||
if (body.lang !== undefined && !(typeof body.lang === 'string' && /^[a-z]{2}(-[A-Za-z]{2,4})?$/.test(body.lang))) return bad('bad lang');
|
||
return { ok: true };
|
||
}
|
||
return bad(`unknown kind ${String(kind).slice(0, 20)}`);
|
||
}
|
||
|
||
// Body size caps per kind, in bytes (section 10), for the host's readJson.
|
||
const BODY_MAX = { act: 16384, ask: 8192, here: 2048, prefs: 1024, vote: 256 };
|
||
|
||
module.exports = { SEND, ASK, VOTE, LOCAL, PUZZLE, CONFIRM, SRV_ARM, armKey, DRAFTS, DRAFT_TYPES, TEXT, QUOTE, WINDOWS, SPEEDS, PREFS, VIEW_MIN, VIEW_MAX, BODY_MAX, checkEnvelope };
|