Opt Out

1#!/usr/bin/env python3
2"""Opt the user out of usage-data collection.
3
4    python3 scripts/telemetry/consent/opt_out.py
5
6The command the notice names, and the only way to opt out — there is no
7environment variable, because the record file is the single source of truth.
8Writes {"installId": "<uuid>", "consentStatus": "OPT_OUT"}.
9
10Recording the opt-out is also what stops the session-start hook raising the notice
11again, so it has to be written down as deliberately as an acknowledgement. An
12install ID is written too, so a later change of heart is not a new install; nothing
13emits it, since every telemetry path is gated on `is_accepted()`.
14
15Sends nothing. `ConsentRecordedDetails` is empty and cannot say which way the user
16answered, so a request from here would be indistinguishable from a yes.
17
18The plugin is fully functional after opting out.
19"""
20
21import sys
22from pathlib import Path
23
24sys.path.insert(0, str(Path(__file__).resolve().parent))
25
26import record  # noqa: E402  (path set above so this resolves in-plugin)
27
28
29def main():
30    try:
31        record.write_state(record.OPT_OUT)
32    except OSError as exc:
33        print(
34            "Could not record your choice at %s: %s\n"
35            "No usage data will be collected either way — the plugin only emits "
36            "when an acknowledged record exists. But because nothing was saved, "
37            "the notice will be shown again next session." % (record.state_path(), exc),
38            file=sys.stderr,
39        )
40        return 1
41
42    print(
43        "You are opted out — usage data collection is OFF and no data will be "
44        "sent.\n"
45        "Recorded at %s so you are not asked again.\n"
46        "Every feature of the plugin still works." % record.state_path()
47    )
48    return 0
49
50
51if __name__ == "__main__":
52    sys.exit(main())