import type { Concat } from './concat.ts'; import type { DlrMerger } from './dlr-merger.ts'; import type { ErrorName } from './defs/errors.ts'; import type { LostGroup, Refusal } from './reassembly.ts'; import type { OnRequest } from './session-options.ts'; import type { PduObject, PduObjectInput } from './pdu.ts'; import type { Result, VoidResult } from './result.ts'; import type { Session } from './session.ts'; import type { SmppLog } from './log.ts'; import type { SmsIdFormat } from './sms-id.ts'; import { HeldMessages } from './held-messages.ts'; import { Reassembler, decodeSegments } from './reassembly.ts'; import { bindCommands, defaults, standsInFor } from './session-options.ts'; import { concatOf } from './concat.ts'; import { createSms } from './sms.ts'; import { dlrFromPdu } from './dlr.ts'; import { paramText } from './defs/types.ts'; import { respIdParams, segmentId } from './sms-id.ts'; /** SMPP 3.4 lists ESME_RMSGQFUL under submit_sm_resp only; 4.6.2's retryable code is another. */ export function refusedSegmentStatus( carriedAs: string, refusal: Refusal, spelling: Concat['spelling'], ): ErrorName { // A sar_* segment's esm_class is 0x00 and correct: naming it would name the part the peer got right. if (refusal === 'unplaceable') { return spelling === 'sar' ? 'ESME_RINVTLVVAL' : 'ESME_RINVESMCLASS'; } return carriedAs === 'submit_sm' ? 'ESME_RMSGQFUL' : 'ESME_RX_T_APPN'; } const lostReasons: Record = { evicted: 'the reassembly buffer filled', expired: 'no further segment arrived in time', linkGone: 'the link they arrived on went', }; export type IncomingRequestsOptions = { dlrMerger: DlrMerger; log: SmppLog; maxOctets?: number | undefined; maxReassembly?: number | undefined; onRequest?: OnRequest | undefined; reassemblyTimeout?: number | undefined; /** Past a drain's refusal, for a receipt the drain is itself waiting for. */ sendPastDrain: (input: PduObjectInput) => Promise>; session: Session; smsIdFormat?: SmsIdFormat | undefined; systemId?: string | undefined; }; /** Everything the peer asks of a session: messages, receipts, links and the answers to them. */ export class IncomingRequests { private readonly dlrMerger: DlrMerger; /** The rejection handler is handed the Sms back as an `unknown`, so its hold is found by identity. */ private readonly emitted = new WeakMap void>(); private readonly held: HeldMessages; private readonly log: SmppLog; private readonly onRequest: OnRequest | undefined; private readonly reassembler: Reassembler; private readonly sendPastDrain: IncomingRequestsOptions['sendPastDrain']; private readonly session: Session; private readonly smsIdFormat: SmsIdFormat; private readonly systemId: string; private linkGeneration = 0; constructor(options: IncomingRequestsOptions) { this.dlrMerger = options.dlrMerger; this.held = new HeldMessages({ log: options.log, max: defaults.maxHeldMessages, timeout: defaults.heldMessageTimeout, }); this.log = options.log; this.onRequest = options.onRequest; this.reassembler = new Reassembler({ log: options.log, max: options.maxReassembly ?? defaults.maxReassembly, maxOctets: options.maxOctets, onLost: lost => { this.reportLost(lost); }, timeout: options.reassemblyTimeout ?? defaults.reassemblyTimeout, }); this.sendPastDrain = options.sendPastDrain; this.session = options.session; this.smsIdFormat = options.smsIdFormat ?? {}; this.systemId = options.systemId ?? defaults.systemId; } async handle(pduObj: PduObject): Promise { const generation = this.linkGeneration; if (this.onRequest && await this.onRequest(this.session, pduObj)) return; // The link it arrived on went while the hook ran, so nothing we answer now correlates. if (this.linkGeneration !== generation) { this.log.info('session - dropping a request whose link went', { cmdName: pduObj.cmdName }); return; } if (!this.session.bindAllows(pduObj.cmdName)) { this.log.info('session - command the peer\'s bind direction does not carry', { bindType: this.session.boundAs ?? '', cmdName: pduObj.cmdName, }); await this.session.sendReturn(pduObj, 'ESME_RINVBNDSTS'); return; } await this.route(pduObj); } private async route(pduObj: PduObject): Promise { switch (pduObj.cmdName) { case 'data_sm': case 'deliver_sm': // A data_sm at the SMSC end is a submission, and a submission is never a report. await (this.carriedAs(pduObj) === 'submit_sm' ? this.onMessage(pduObj) : this.onDelivery(pduObj)); break; case 'enquire_link': await this.session.sendReturn(pduObj); break; case 'submit_sm': await this.onMessage(pduObj); break; case 'unbind': await this.session.sendReturn(pduObj); // A peer that has said it is finished will not answer what we still have outstanding. await this.session.close({ signal: AbortSignal.abort() }); break; default: await this.unhandled(pduObj); } } /** Drops the segments of every message that never became whole, and of every one still held. */ clear(): void { this.linkGeneration++; this.held.clear(); this.reassembler.clear(); } /** One `sms` listener gave up on a message; the last one to do so is what releases the hold. */ listenerRejected(sms: unknown): void { if (typeof sms !== 'object' || sms === null) return; this.emitted.get(sms)?.(); } /** Waits out the messages the application still holds, and says how many it never answered. */ async drain(timeout: number, signal: AbortSignal | undefined): Promise { const unanswered = await this.held.idle(timeout, signal); if (unanswered === 0) return {}; this.log.warn('session - shutting down with messages unanswered', { timeout, unanswered }); return { err: new Error(`Shut down with ${String(unanswered)} message(s) unanswered`) }; } private async unhandled(pduObj: PduObject): Promise { if (bindCommands.includes(pduObj.cmdName)) { this.log.info('session - bind on an already bound session', { cmdName: pduObj.cmdName }); await this.session.sendReturn(pduObj, 'ESME_RALYBND', { system_id: this.systemId }); return; } this.log.info('session - no handler for command', { cmdName: pduObj.cmdName }); await this.session.sendReturn(pduObj, 'ESME_RINVCMDID'); } private carriedAs(pduObj: PduObject): string { return standsInFor(pduObj.cmdName, this.session.linkEnd); } /** SMPP carries a mobile-originated message and a delivery receipt on the same command. */ private async onDelivery(pduObj: PduObject): Promise { const dlr = dlrFromPdu(pduObj, this.smsIdFormat); if (!dlr) { await this.onMessage(pduObj); return; } this.session.emit('dlr', dlr, pduObj); const merged = this.dlrMerger.collect(dlr); if (merged) this.session.emit('messageDlr', merged); await this.session.sendReturn(pduObj); } /** * A concatenated message is answered segment by segment as it arrives: a peer that dispatches * one request at a time never sends the second segment until the first has been answered. */ private async onMessage(pduObj: PduObject): Promise { const concat = concatOf(pduObj); if (!concat) { this.emitSms([pduObj]); return; } const collected = this.reassembler.collect(pduObj, concat); if (!collected.kept) { await this.session.sendReturn( pduObj, refusedSegmentStatus(this.carriedAs(pduObj), collected.refusal, concat.spelling), ); return; } await this.session.sendReturn( pduObj, 'ESME_ROK', respIdParams(pduObj.cmdName, segmentId(collected.smsId, concat.part - 1, concat.total)), ); if (collected.whole) this.emitSms(collected.whole, collected.smsId); } private reportLost(lost: LostGroup): void { this.session.emit('sessionError', new Error( `Gave up ${String(lost.parts)} of ${String(lost.total)} segments of an incomplete concatenated message: ${lostReasons[lost.reason]}`, )); } private emitSms(pduObjs: PduObject[], answeredAs?: string): void { const first = pduObjs[0]; if (!first) return; const generation = this.linkGeneration; // A turn later, so a listener sending its receipt straight after the response still holds. const release = (): void => { setImmediate(() => { this.held.release(pduObjs); }); }; const sms = createSms({ answeredAs, from: paramText(first.params.source_addr), message: decodeSegments(pduObjs), pduObjs, session: this.session, to: paramText(first.params.destination_addr), }, { lostLink: () => this.linkGeneration !== generation, onAnswered: release, // Past the refusal only while a drain is still waiting for this message; an ordinary send after. send: input => (this.held.has(pduObjs) ? this.sendPastDrain(input) : this.session.send(input)), }); // A rejection leaves the other listeners running, so only the last one to fail gives the message up. let working = this.session.listenerCount('sms'); this.held.hold(pduObjs); this.emitted.set(sms, () => { working--; if (working <= 0) release(); }); // A message nobody took is not work a shutdown can wait for. if (!this.session.emit('sms', sms)) this.held.release(pduObjs); } }