CLI

1#!/usr/bin/env python3
2"""Print the usage-data notice, or report its status.
3
4    python3 scripts/telemetry/consent/cli.py show     # print the notice text
5    python3 scripts/telemetry/consent/cli.py status   # the setting, for a human
6
7`show` exists so the user reads the notice as *tool output* rather than as model
8prose: tool output reaches the terminal byte for byte, and a paraphrased legal
9notice is not the notice. It is read-only and mints no install ID — printing the
10text is not acknowledgement. Only `accept.py` and `opt_out.py` write.
11
12`status` always exits 0: "not recorded" is a state, not an error.
13"""
14
15import sys
16from pathlib import Path
17
18sys.path.insert(0, str(Path(__file__).resolve().parent))
19
20import record  # noqa: E402  (path set above so this resolves in-plugin)
21
22USAGE = "usage: cli.py {show|status}"
23
24CONSENT_DIR = Path(__file__).resolve().parent
25
26
27def status_report():
28    """One human-readable paragraph describing the current setting.
29
30    Reads the record and nothing else — there is no environment variable to rank
31    against it, so what this prints is what the plugin acts on.
32    """
33    state = record.read_state()
34    status = state["consentStatus"] if state else None
35
36    if status == record.ACCEPTED:
37        return (
38            "Usage data collection: ON. You acknowledged the notice.\n"
39            "Install ID: %s\n"
40            "Recorded at: %s\n"
41            "\n"
42            "%s"
43            % (
44                state["installId"],
45                record.state_path(),
46                record.opt_out_help(),
47            )
48        )
49
50    if status == record.OPT_OUT:
51        return (
52            "Usage data collection: OFF. You opted out, and nothing is sent.\n"
53            "Recorded at: %s\n"
54            'To turn it back on, run: python3 "%s/accept.py"'
55            % (record.state_path(), CONSENT_DIR)
56        )
57
58    # Also what a corrupt record reports: the gate treats the two identically.
59    return (
60        "Usage data collection: OFF. Nothing is recorded yet, so nothing is "
61        "sent.\n"
62        "The notice will be shown at the start of your next session.\n"
63        "Expected record location: %s" % record.state_path()
64    )
65
66
67def main(argv):
68    if len(argv) != 1 or argv[0] in ("-h", "--help"):
69        print(USAGE, file=sys.stderr)
70        return 0 if argv and argv[0] in ("-h", "--help") else 2
71
72    command = argv[0]
73
74    if command == "show":
75        print(record.disclaimer(), end="")  # already ends with a newline
76        return 0
77
78    if command == "status":
79        print(status_report())
80        return 0
81
82    print("%s\n%s" % ("unknown command: %s" % command, USAGE), file=sys.stderr)
83    return 2
84
85
86if __name__ == "__main__":
87    sys.exit(main(sys.argv[1:]))