2026-04-15 08:29:37 -07:00
|
|
|
{
|
|
|
|
|
example_write.pas - post one test message to any supported base
|
|
|
|
|
via the unified API.
|
|
|
|
|
|
|
|
|
|
usage: example_write <format> <path> <from> <to> <subject> <body>
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
example_write jam /tmp/testarea Sysop All Hello 'Hello, world'
|
|
|
|
|
|
|
|
|
|
For Hudson/GoldBase/MSG the path is a directory; for JAM/Squish
|
|
|
|
|
it is <dir>/<areaname> (no extension); for PKT it is the full
|
|
|
|
|
*.pkt filename; for EzyCom it is the base directory and board 1
|
|
|
|
|
is used by default.
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
program example_write;
|
|
|
|
|
|
|
|
|
|
{$mode objfpc}{$H+}
|
|
|
|
|
|
|
|
|
|
uses
|
|
|
|
|
SysUtils,
|
Rename ma.* -> mb.* namespace (cosmetic, breaking)
Across-the-board rename so the unit prefix matches the repo
name (mb = msgbase). Brings naming into line with
fpc-ftn-transport's tt.* prefix and avoids the historical
"ma" abbreviation that meant nothing to new readers.
Files renamed via git mv:
src/ma.{api,events,kludge,lock,paths,types}.pas
-> src/mb.{...}.pas
src/formats/ma.fmt.{jam,squish,hudson,msg,pcboard,ezycom,
goldbase,wildcat,wcutil}{,.uni}.pas
-> src/formats/mb.fmt.*.pas
All `unit ma.X` declarations and `uses ma.X` clauses rewritten
to `mb.X` across src/, examples/, tests/.
Suite: 47/47 (read 7, hwm 11, lock 4, pack 4, write 5,
wildcat 5, consumer_round1 5, batch's gone w/ PKT relocation,
plus testutil).
Consumer impact: anyone with `uses ma.api;` etc. needs to
update to `uses mb.api;`. No semantic changes; a search/replace
on the consumer's source tree is the only migration step.
NR's notes (~/.MSGAPI_MSGS.md round 3) align this against
their already-pinned 8130b40; the next NR pin bump rolls in
both this rename and any further work in one step.
2026-04-18 13:19:15 -07:00
|
|
|
mb.types, mb.events, mb.api,
|
|
|
|
|
mb.fmt.hudson, mb.fmt.hudson.uni,
|
|
|
|
|
mb.fmt.jam, mb.fmt.jam.uni,
|
|
|
|
|
mb.fmt.squish, mb.fmt.squish.uni,
|
|
|
|
|
mb.fmt.msg, mb.fmt.msg.uni,
|
|
|
|
|
mb.fmt.pcboard, mb.fmt.pcboard.uni,
|
|
|
|
|
mb.fmt.ezycom, mb.fmt.ezycom.uni,
|
|
|
|
|
mb.fmt.goldbase, mb.fmt.goldbase.uni;
|
2026-04-15 08:29:37 -07:00
|
|
|
|
|
|
|
|
function ParseFormat(const S: string; out AFormat: TMsgBaseFormat): boolean;
|
|
|
|
|
begin
|
|
|
|
|
Result := True;
|
|
|
|
|
case LowerCase(S) of
|
|
|
|
|
'hudson': AFormat := mbfHudson;
|
|
|
|
|
'jam': AFormat := mbfJam;
|
|
|
|
|
'squish': AFormat := mbfSquish;
|
|
|
|
|
'msg': AFormat := mbfMsg;
|
|
|
|
|
'pcboard': AFormat := mbfPCBoard;
|
|
|
|
|
'ezycom': AFormat := mbfEzyCom;
|
|
|
|
|
'goldbase': AFormat := mbfGoldBase;
|
|
|
|
|
else
|
|
|
|
|
Result := False;
|
|
|
|
|
end;
|
|
|
|
|
end;
|
|
|
|
|
|
|
|
|
|
procedure Usage;
|
|
|
|
|
begin
|
|
|
|
|
WriteLn('Usage: example_write <format> <path> <from> <to> <subject> <body>');
|
|
|
|
|
WriteLn(' formats: hudson jam squish msg pcboard ezycom goldbase');
|
|
|
|
|
Halt(2);
|
|
|
|
|
end;
|
|
|
|
|
|
|
|
|
|
var
|
|
|
|
|
fmtName, path, whoFrom, whoTo, subject, body: string;
|
|
|
|
|
fmt: TMsgBaseFormat;
|
|
|
|
|
base: TMessageBase;
|
|
|
|
|
msg: TUniMessage;
|
|
|
|
|
begin
|
|
|
|
|
if ParamCount < 6 then Usage;
|
|
|
|
|
fmtName := ParamStr(1);
|
|
|
|
|
path := ParamStr(2);
|
|
|
|
|
whoFrom := ParamStr(3);
|
|
|
|
|
whoTo := ParamStr(4);
|
|
|
|
|
subject := ParamStr(5);
|
|
|
|
|
body := ParamStr(6);
|
|
|
|
|
|
|
|
|
|
if not ParseFormat(fmtName, fmt) then Usage;
|
|
|
|
|
|
|
|
|
|
try
|
|
|
|
|
base := MessageBaseOpen(fmt, path, momReadWrite);
|
|
|
|
|
except
|
|
|
|
|
on E: Exception do begin
|
|
|
|
|
WriteLn('error: ', E.Message);
|
|
|
|
|
Halt(1);
|
|
|
|
|
end;
|
|
|
|
|
end;
|
|
|
|
|
|
|
|
|
|
if not base.Open then begin
|
|
|
|
|
WriteLn('error: Open returned False (missing files? lock busy?)');
|
|
|
|
|
base.Free;
|
|
|
|
|
Halt(1);
|
|
|
|
|
end;
|
|
|
|
|
|
Lossless message model: Body + Attributes (showstopper fix)
Replaces TUniMessage's 13-field flat record with a strict two-area
model: Body holds only the message text; Attributes holds everything
else (from/to/subject/dates/addresses/MSGID/SEEN-BY/PATH/format-
specific fields) as namespaced key/value pairs.
Why this fix is required NOW: the previous JAM adapter dropped
MSGID, ReplyID, PID, Flags, SEEN-BY and PATH on every Read/Write
through the unified API. A NetReader parity test surfaced it (17/21
pass with 4 kludge failures). All 9 adapters had the same bug. For
tossers and scanners the impact is silent corruption: dropped MSGID
→ dupe storms, dropped PATH → mail loops, dropped SEEN-BY → broken
routing. Three downstream consumers (Fimail's codex-transport branch,
NetReader, future Allfix) had halted integration work pending this
fix. Without it, anyone vendoring fpc-msgbase 0.1 ships with a
known-corrupting adapter.
Design choice: per Ken's call, "message is just the message text;
everything else is an attribute, including from/to/subject/dates."
Same architecture as RFC 822 email (headers + body). Each backend
fills attributes it knows on Read; reads attributes it understands
on Write; ignores unknown attributes silently (RFC 822 X-header
semantics). Forward-compatible -- a new backend (e.g. a planned SQL
message store) just adds its own attribute keys; old backends ignore
them.
Composition is the consumer's job. The library never reassembles
Body + Attributes into kludge-laden display text. A BBS that wants
inline kludges walks Attributes and prepends ^aMSGID etc. to its
own display. A tosser that needs MSGID for dupe detection reads
Attributes.Get('msgid') directly -- no body parsing required.
src/ma.types.pas:
- New TMsgAttribute / TMsgAttributes records with Get/SetValue,
typed accessors (GetInt/GetBool/GetDate/GetAddr), Has/Remove,
iteration. Linear-search lookup, fine for the ~30-50 keys per
message. Switch to hash later if profiling shows need.
- Replaced TUniMessage with the minimal Body + Attributes record.
- New UniAttrBitsToAttributes / UniAttrBitsFromAttributes helpers
to bridge the canonical MSG_ATTR_* cardinal bitset to/from
individual `attr.*` boolean keys.
- {$modeswitch advancedrecords} added so records have methods.
src/ma.api.pas:
- New capabilities API: TStringDynArray return type,
ClassSupportedAttributes (virtual class fn, default empty),
SupportedAttributes (instance sugar), SupportsAttribute (per-key
query). Each backend overrides ClassSupportedAttributes with the
static list of keys it knows. Callers query before setting so a
BBS UI can hide controls the underlying backend has no slot for.
src/formats/ma.fmt.*.uni.pas (all 9):
- Rewrote each XxxToUni and XxxFromUni for the new model. Read
populates Attributes with universal/FTSC/format-specific keys per
the attribute registry (to be published in phase 5). Write reads
attributes back and writes native form.
- JAM walks SubFields[] for SEEN-BY/PATH/TZUTC/TRACE plus passthrough
of unknown subfield IDs as `jam.subfield.<id>` for round-trip
safety. Squish parses CtrlInfo (NUL-separated ^A lines) into
individual attributes, rebuilds on Write. MSG and PKT (which keep
kludges inline in body per FTS-1) parse leading ^A lines and
trailing SEEN-BY/PATH out of the body so TUniMessage.Body is
always plain user text; on Write they reassemble the on-disk form.
- Each backend ships ClassSupportedAttributes with its key list.
src/ma.batch.pas: PktToUni signature updated to (in,out var) form.
tests/* + examples/*: migrated all callers from Msg.WhoFrom (etc.)
to Msg.Attributes.Get('from'). MakeMsg helpers now use SetValue/
SetBool/SetAddr.
Verified: 24/24 tests pass across all 7 test programs (read,
roundtrip, lock, batch, wildcat, write_existing, pack). Wildcat
walks all 7 vendored conferences clean.
Out of scope (next phases):
- docs/attributes-registry.md publishing the full key list with
per-format support matrix
- cross-format round-trip + capabilities-driven copy test
- update architecture.md / PROPOSAL.md to reflect the new model
2026-04-17 14:11:15 -07:00
|
|
|
msg.Attributes.Clear;
|
|
|
|
|
msg.Attributes.SetValue('from', whoFrom);
|
|
|
|
|
msg.Attributes.SetValue('to', whoTo);
|
|
|
|
|
msg.Attributes.SetValue('subject', subject);
|
|
|
|
|
msg.Attributes.SetDate('date.written', Now);
|
|
|
|
|
msg.Attributes.SetBool('attr.local', true);
|
|
|
|
|
msg.Attributes.SetAddr('addr.orig', MakeFTNAddress(1, 1, 1, 0));
|
|
|
|
|
msg.Attributes.SetAddr('addr.dest', MakeFTNAddress(1, 1, 2, 0));
|
|
|
|
|
msg.Body := body + #13;
|
2026-04-15 08:29:37 -07:00
|
|
|
|
|
|
|
|
try
|
|
|
|
|
if base.WriteMessage(msg) then
|
Lossless message model: Body + Attributes (showstopper fix)
Replaces TUniMessage's 13-field flat record with a strict two-area
model: Body holds only the message text; Attributes holds everything
else (from/to/subject/dates/addresses/MSGID/SEEN-BY/PATH/format-
specific fields) as namespaced key/value pairs.
Why this fix is required NOW: the previous JAM adapter dropped
MSGID, ReplyID, PID, Flags, SEEN-BY and PATH on every Read/Write
through the unified API. A NetReader parity test surfaced it (17/21
pass with 4 kludge failures). All 9 adapters had the same bug. For
tossers and scanners the impact is silent corruption: dropped MSGID
→ dupe storms, dropped PATH → mail loops, dropped SEEN-BY → broken
routing. Three downstream consumers (Fimail's codex-transport branch,
NetReader, future Allfix) had halted integration work pending this
fix. Without it, anyone vendoring fpc-msgbase 0.1 ships with a
known-corrupting adapter.
Design choice: per Ken's call, "message is just the message text;
everything else is an attribute, including from/to/subject/dates."
Same architecture as RFC 822 email (headers + body). Each backend
fills attributes it knows on Read; reads attributes it understands
on Write; ignores unknown attributes silently (RFC 822 X-header
semantics). Forward-compatible -- a new backend (e.g. a planned SQL
message store) just adds its own attribute keys; old backends ignore
them.
Composition is the consumer's job. The library never reassembles
Body + Attributes into kludge-laden display text. A BBS that wants
inline kludges walks Attributes and prepends ^aMSGID etc. to its
own display. A tosser that needs MSGID for dupe detection reads
Attributes.Get('msgid') directly -- no body parsing required.
src/ma.types.pas:
- New TMsgAttribute / TMsgAttributes records with Get/SetValue,
typed accessors (GetInt/GetBool/GetDate/GetAddr), Has/Remove,
iteration. Linear-search lookup, fine for the ~30-50 keys per
message. Switch to hash later if profiling shows need.
- Replaced TUniMessage with the minimal Body + Attributes record.
- New UniAttrBitsToAttributes / UniAttrBitsFromAttributes helpers
to bridge the canonical MSG_ATTR_* cardinal bitset to/from
individual `attr.*` boolean keys.
- {$modeswitch advancedrecords} added so records have methods.
src/ma.api.pas:
- New capabilities API: TStringDynArray return type,
ClassSupportedAttributes (virtual class fn, default empty),
SupportedAttributes (instance sugar), SupportsAttribute (per-key
query). Each backend overrides ClassSupportedAttributes with the
static list of keys it knows. Callers query before setting so a
BBS UI can hide controls the underlying backend has no slot for.
src/formats/ma.fmt.*.uni.pas (all 9):
- Rewrote each XxxToUni and XxxFromUni for the new model. Read
populates Attributes with universal/FTSC/format-specific keys per
the attribute registry (to be published in phase 5). Write reads
attributes back and writes native form.
- JAM walks SubFields[] for SEEN-BY/PATH/TZUTC/TRACE plus passthrough
of unknown subfield IDs as `jam.subfield.<id>` for round-trip
safety. Squish parses CtrlInfo (NUL-separated ^A lines) into
individual attributes, rebuilds on Write. MSG and PKT (which keep
kludges inline in body per FTS-1) parse leading ^A lines and
trailing SEEN-BY/PATH out of the body so TUniMessage.Body is
always plain user text; on Write they reassemble the on-disk form.
- Each backend ships ClassSupportedAttributes with its key list.
src/ma.batch.pas: PktToUni signature updated to (in,out var) form.
tests/* + examples/*: migrated all callers from Msg.WhoFrom (etc.)
to Msg.Attributes.Get('from'). MakeMsg helpers now use SetValue/
SetBool/SetAddr.
Verified: 24/24 tests pass across all 7 test programs (read,
roundtrip, lock, batch, wildcat, write_existing, pack). Wildcat
walks all 7 vendored conferences clean.
Out of scope (next phases):
- docs/attributes-registry.md publishing the full key list with
per-format support matrix
- cross-format round-trip + capabilities-driven copy test
- update architecture.md / PROPOSAL.md to reflect the new model
2026-04-17 14:11:15 -07:00
|
|
|
WriteLn('wrote message #', msg.Attributes.GetInt('msg.num'))
|
2026-04-15 08:29:37 -07:00
|
|
|
else
|
|
|
|
|
WriteLn('error: WriteMessage returned False');
|
|
|
|
|
finally
|
|
|
|
|
base.Close;
|
|
|
|
|
base.Free;
|
|
|
|
|
end;
|
|
|
|
|
end.
|