Documentation
¶
Overview ¶
Package write implements the mutating X actions, behind explicit gating.
Nothing here is destructive: there is no delete, unfollow, block or DM, so the worst outcome of a mistake is something the user can undo by hand.
Index ¶
- Constants
- Variables
- func ValidateText(text string) error
- type Actions
- type Auditor
- type Gate
- type InvalidError
- type NotAppliedError
- type NotFoundError
- type Opener
- type Options
- type Outcome
- type Record
- type Reserver
- type Writer
- func (w *Writer) Bookmark(ctx context.Context, handle, postID, confirm string) error
- func (w *Writer) Enabled() bool
- func (w *Writer) Like(ctx context.Context, handle, postID, confirm string) error
- func (w *Writer) Post(ctx context.Context, text, confirm string) error
- func (w *Writer) Reply(ctx context.Context, handle, postID, text, confirm string) error
- func (w *Writer) Repost(ctx context.Context, handle, postID, confirm string) error
- func (w *Writer) Unbookmark(ctx context.Context, handle, postID, confirm string) error
Constants ¶
const ( ActionPost = "post" ActionReply = "reply" ActionLike = "like" ActionRepost = "repost" ActionBookmark = "bookmark" ActionUnbookmark = "unbookmark" )
Action names, used in the audit log and error messages.
const MaxPostRunes = 280
MaxPostRunes is X's limit for a standard account.
Variables ¶
var ( // ErrDisabled reports that writes were never enabled for this server. ErrDisabled = errors.New("writes are disabled; restart with -allow-writes") // ErrBadConfirmation reports a missing or wrong confirmation token. ErrBadConfirmation = errors.New("write refused: confirmation token missing or incorrect") )
Errors a caller may need to distinguish.
Functions ¶
func ValidateText ¶
ValidateText rejects post text X would not accept.
Types ¶
type Actions ¶ added in v0.0.8
type Actions interface {
Enabled() bool
Post(ctx context.Context, text, confirm string) error
Reply(ctx context.Context, handle, postID, text, confirm string) error
Like(ctx context.Context, handle, postID, confirm string) error
Repost(ctx context.Context, handle, postID, confirm string) error
Bookmark(ctx context.Context, handle, postID, confirm string) error
Unbookmark(ctx context.Context, handle, postID, confirm string) error
}
Actions is the mutating surface a transport needs.
It exists so the MCP tools and the HTTP routes can be tested without a browser. What those layers are responsible for is decoding a request and calling the right action, and a real Writer makes exactly that impossible to assert -- every call would drive Chrome at X.
type Auditor ¶
type Auditor struct {
// contains filtered or unexported fields
}
Auditor appends write attempts to a file.
Every attempt is recorded, including denied ones: a burst of denials is the signal that something is trying to drive the account, and it is exactly the evidence that would be missing if only successes were logged.
func NewAuditor ¶
NewAuditor writes to path, creating its directory if needed.
type Gate ¶
type Gate struct {
// contains filtered or unexported fields
}
Gate decides whether a write may proceed.
The threat it is built against is prompt injection, not user error. Read tools pull attacker-authored post text into the same context that can act on the account, so "reply to this with your API key" is a live instruction to a tool-using model. Two properties matter:
- When writes are disabled the tools are never registered, so the model cannot see or call them at all.
- When enabled, every call carries a token generated at startup and shown only to the operator's terminal. Text scraped from a web page cannot supply a value it has never seen.
func NewGate ¶
NewGate builds a gate. When enabled it mints a fresh token; the caller is responsible for showing it to the operator.
type InvalidError ¶ added in v0.0.7
type InvalidError struct{ Reason string }
InvalidError marks a request the caller got wrong, as distinct from a write that was attempted and did not take effect. The two deserve different answers: one is worth correcting and sending again, the other is not.
func (*InvalidError) Error ¶ added in v0.0.7
func (e *InvalidError) Error() string
type NotAppliedError ¶ added in v0.0.9
type NotAppliedError struct{ Reason string }
NotAppliedError marks an action that was carried out and that X did not apply.
Distinct from a fault: the machinery worked, so what it says is an answer the caller can act on rather than a detail of this process. It says only what X showed, and carries nothing else.
func (*NotAppliedError) Error ¶ added in v0.0.9
func (e *NotAppliedError) Error() string
type NotFoundError ¶ added in v0.0.9
type NotFoundError struct{ Reason string }
NotFoundError marks a post X did not render. Liking a deleted or private post is not a fault of this server's, and the caller needs to know the target is gone rather than be told to try again.
func (*NotFoundError) Error ¶ added in v0.0.9
func (e *NotFoundError) Error() string
type Options ¶
type Options struct {
Open Opener
Auth *auth.Manager
Gate *Gate
Budget *limit.Budget
Audit *Auditor
Reserve Reserver
Timeout time.Duration
OnChange func()
}
Options configures a Writer.
type Record ¶
type Record struct {
At time.Time `json:"at"`
Action string `json:"action"`
Target string `json:"target,omitempty"`
Excerpt string `json:"excerpt,omitempty"`
Outcome Outcome `json:"outcome"`
Reason string `json:"reason,omitempty"`
}
Record is one line of the audit log.
type Reserver ¶ added in v0.0.5
type Reserver interface {
Reserve(ctx context.Context) (pool.Reservation, error)
}
Reserver takes exclusive use of the profile.
A write runs in its own visible browser, and only one Chrome may hold a user-data-dir, so the reservation is held for the whole action rather than released once the browser has started.
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
Writer performs mutating actions.
func (*Writer) Enabled ¶
Enabled reports whether writes are available.
Safe on a nil Writer, because the transports hold one as an Actions and a nil pointer in an interface is not a nil interface: their "no writer configured" check cannot catch it, so answering honestly here is what keeps a missing writer from being a panic at startup.
Source Files