"""Terms-of-use acceptance and version records for a spaCR profile.
spaCR presents its terms during setup and records the accepted
:data:`TERMS_VERSION` with a UTC timestamp. A profile must accept a revised
version explicitly; acceptance of an earlier version is not carried forward.
The record is stored with the other setup values under the ``onboarding/``
prefix.
"""
from __future__ import annotations
import logging
from typing import Dict, Tuple
#: The version of the terms below.
#:
#: BUMP IT WHENEVER THE WORDS CHANGE. Nothing else makes a rewrite a new
#: agreement: the recorded version is compared against this one, so terms
#: edited without bumping it are terms nobody was asked about.
#:
#: 2.0 is the first version that states how the developers may use what a
#: profile sends them, so a profile that accepted 1.0 accepted a document
#: that did not say it and is asked again.
#:
#: 4.0 is the version that RELICENSES spaCR from PolyForm Noncommercial to
#: BSD 3-Clause. That is a widening -- everything a profile could do under
#: 3.0 it may still do -- but it is not a wording change: the licence a
#: profile accepted is a different licence, the noncommercial restriction
#: is gone, and the warranty and liability terms are now the licence's own
#: rather than this document's. A profile that accepted 3.0 is asked again.
#: 4.1 adds Section 11.4, the governing-language clause, when the
#: agreement began being presented in nine languages on 2026-09-02. A
#: translation is a convenience and the English governs; that is a term
#: of the agreement rather than a note about it, so it is IN the
#: agreement and a profile that accepted 4.0 is asked again.
#: 4.2 adds Section 5.6, AUTOMATIC ERROR REPORTS: automatic filing is the
#: default, and a user agrees to it in the agreement when the mode is
#: 'always'. Sections 5.1 and 5.5 said nothing was ever transmitted
#: automatically and that Diagnostic Data was not published, and neither is
#: true with 'always'. A profile that accepted 4.1 accepted neither, and is
#: asked again.
LOG = logging.getLogger(__name__)
TERMS_VERSION = "4.2"
#: What the licence is called, and where the whole of it can be read.
#:
#: BSD 3-CLAUSE, the licence CellProfiler, napari, Cellpose, scikit-image,
#: numpy and scipy all use. spaCR is a methods tool for the scientific
#: community, and every one of its own dependencies is permissive -- a
#: noncommercial layer on top of a BSD stack made spaCR the one component a
#: core facility, a company reproducing a published analysis, or a distro
#: packager could not use.
LICENSE_NAME = "BSD 3-Clause License"
LICENSE_URL = "https://opensource.org/licenses/BSD-3-Clause"
#: The notice the licence itself requires be carried with the software.
#:
#: BSD's first two clauses require this notice, the conditions and the
#: disclaimer to travel with every copy, in source and in binary. It is
#: the whole of what a redistributor owes.
REQUIRED_NOTICE = ("Copyright (c) 2025-2026, Einar Birnir Olafsson and the "
"spaCR contributors. All rights reserved.")
#: The agreement, in the words it is accepted in.
#:
#: WRITTEN AS AN END USER LICENCE AGREEMENT, because that is the form a
#: reader already knows how to read. The earlier draft explained itself in
#: an essayist's voice -- "this section is the one worth reading twice" --
#: which reads as someone talking ABOUT terms rather than as terms, and
#: leaves a reader unsure whether they have agreed to anything. The shape
#: here is the one Apple, Microsoft and Google all use: an acceptance
#: paragraph, defined terms, a licence grant, restrictions, ownership,
#: data, warranty and liability in the capitals those two sections are
#: always set in, then term, changes and general provisions.
#:
#: Section 2 summarises the BSD 3-Clause License and says so: the licence
#: itself governs, and its three numbered conditions are what Section 3 is
#: written against.
#:
#: THE LICENCE IS PERMISSIVE AND THE AGREEMENT IS STILL LONG, which looks
#: like a contradiction and is not. What survives relicensing is everything
#: BSD does NOT speak to: what leaves the machine, what may be done with a
#: bug report or an uploaded model, what there is no promise about, and how
#: to say no. Those were always the clauses worth reading, and they are
#: unchanged.
#:
#: LONG ENOUGH TO BE TERMS. A four-sentence summary is a thing a reader
#: takes in without noticing they agreed to anything, and the clauses that
#: matter here -- the ones about what the developers may do with what you
#: send them -- are exactly the clauses a summary drops. They are set out in
#: numbered sections, in the order a reader wants them: what the licence is,
#: what they may do, what there is no promise about, what leaves the
#: machine, what may be done with it, what is never made public, and how to
#: say no.
#:
#: THE LENGTH IS LOAD-BEARING, not padding: the acceptance on the setup
#: slide is disabled until the end of this text has been on screen, so the
#: document has to be long enough that reaching its end is an act.
TERMS: Tuple[str, ...] = (
"END USER LICENCE AGREEMENT",
"PLEASE READ THIS AGREEMENT CAREFULLY. By selecting \u201cI have read "
"and agree to these terms\u201d, or by installing, copying or otherwise "
"using spaCR, You agree to be bound by the terms of this Agreement. If "
"You do not agree, do not install or use spaCR.",
"1. DEFINITIONS",
"1.1 \u201cAgreement\u201d means this End User Licence Agreement.",
"1.2 \u201cLicensor\u201d means the copyright holder identified in the "
"notice at the end of this Agreement.",
"1.3 \u201cSoftware\u201d means the spaCR application, its source code, "
"its documentation, and any updates the Licensor makes available.",
"1.4 \u201cYou\u201d means the individual or entity accepting this "
"Agreement.",
"1.5 \u201cYour Content\u201d means the images, measurements, "
"annotations, models, figures and other data You supply to the Software "
"or that the Software produces from them on Your equipment.",
"1.6 \u201cDiagnostic Data\u201d means logs, error reports, stack "
"traces, configuration values, software and hardware version "
"information, and timing measurements describing how the Software ran.",
"1.7 \u201cShared Resource\u201d means any model hub, public dataset, "
"community repository or similar service to which You choose to upload "
"material.",
"2. LICENCE GRANT",
"2.1 The Software is open source. It is made available under the BSD "
"3-Clause License, the full text of which ships with the Software as "
"the file LICENSE and is linked below. That licence governs Your use "
"of the Software and prevails over anything in this Agreement that "
"conflicts with it.",
"2.2 You may use, copy, modify, merge, publish, distribute, "
"sublicense and sell the Software and works derived from it, FOR ANY "
"PURPOSE, commercial or otherwise. No separate permission is needed "
"and no fee is payable.",
"2.3 There is no noncommercial restriction. Earlier versions of spaCR "
"were licensed under the BSD 3-Clause License; that "
"restriction has been removed and does not apply to this version.",
"3. WHAT THE LICENCE ASKS IN RETURN",
"3.1 Redistributions in source form must retain the copyright notice "
"at the end of this Agreement, the licence conditions, and the "
"disclaimer of warranties.",
"3.2 Redistributions in binary form must reproduce the same three "
"things in the documentation or other materials supplied with the "
"distribution.",
"3.3 Neither the name of the copyright holder nor the names of "
"contributors may be used to endorse or promote a derived product "
"without prior written permission. This is a rule about endorsement "
"only: it does not restrict what You may build or sell.",
"3.4 If You publish work that relied on the Software, a citation is "
"asked for and is not a condition of the licence. See CITATION.cff in "
"the Software for the form it should take.",
"4. OWNERSHIP OF YOUR CONTENT",
"4.1 As between You and the Licensor, You retain all right, title and "
"interest in and to Your Content. This Agreement grants the Licensor no "
"ownership of it and makes no claim of authorship over any result the "
"Software produces from it.",
"4.2 The Licensor retains all right, title and interest in and to the "
"Software, subject to the licence granted in Section 2.",
"5. DIAGNOSTIC DATA AND HOW IT MAY BE USED",
"5.1 The Software contains no telemetry, no background upload and no "
"analytics. Apart from the automatic error reports described in "
"Section 5.6, Diagnostic Data is transmitted only as the result of an "
"action You take.",
"5.2 Where You elect to send a bug report, or one is filed "
"automatically under Section 5.6, and You do not clear the setting "
"\u201cInclude recent logs in a report\u201d, You grant the Licensor a "
"perpetual, worldwide, "
"royalty-free licence to use the Diagnostic Data contained in that "
"report for the purposes of diagnosing faults, improving the Software, "
"and any other purpose connected with its development.",
"5.3 Where You upload image data or trained models to a Shared "
"Resource, You grant the Licensor a perpetual, worldwide, "
"royalty-free licence to use that material to develop the Software "
"further and to produce community resources, including but not limited "
"to object detection and segmentation models made available to other "
"users.",
"5.4 The licences in Sections 5.2 and 5.3 are non-exclusive. They do "
"not transfer ownership, and they do not limit what You may do with the "
"same material.",
"5.5 A bug report filed through the Software is PUBLISHED as an issue "
"on the public spaCR repository, github.com/EinarOlafsson/spacr, under "
"Your GitHub account. It contains the error's traceback, the settings "
"of the run that failed, and the versions of the Software, Python, the "
"operating system and principal libraries. Before it is sent, "
"credential-shaped values, database file names, and this computer's "
"login and host names are replaced with placeholders, and so are file "
"and folder names unless You restore them in a preview. Public issues "
"are world-readable, "
"indexed and mirrored, and cannot be reliably unpublished. The log is "
"never published: any log accompanying a report is written to a file "
"on Your equipment, and the issue records the path rather than the "
"contents. Sending that file is a separate act You take.",
"5.6 AUTOMATIC ERROR REPORTS. The setting “One-click issue "
"filing” has three values. With “always”, WHICH IS THE "
"DEFAULT, the Software files the report described in Section 5.5 "
"automatically when a run fails, without showing it to You first. It "
"files each distinct error once: where an open issue already carries "
"the same error, the report is added to that issue as a comment instead "
"of opening a new one. Automatic filing uses the GitHub command line "
"tool’s sign-in or a GITHUB_TOKEN on Your equipment; without one, "
"nothing is filed automatically. With “ask”, a report is shown "
"to You in an editable preview and is sent only when You press Send "
"report. With “never”, no report is sent. BY ACCEPTING THIS "
"AGREEMENT WITH THE SETTING AT “always”, YOU AGREE TO THE "
"AUTOMATIC FILING OF THESE REPORTS. You may change the setting at any "
"time under Help > Set spaCR up again…, on the page “When "
"something breaks”, or stop all reports by turning off “Report "
"errors as GitHub issues” in the AI Console’s settings.",
"5.7 You are responsible for the content of anything You elect to send "
"or allow to be sent automatically. The Software redacts "
"credential-shaped values and file paths on a best efforts basis; it "
"cannot identify material that is confidential for reasons particular "
"to Your work.",
"6. THIRD PARTY SERVICES",
"6.1 The Software can be configured to send a question to a third party "
"coding assistant. Such requests are made through that vendor's own "
"command line tool under Your own account and are governed by that "
"vendor's terms. The Licensor does not receive Your credentials and is "
"not a party to those communications.",
"6.2 The Software queries public package indexes to determine whether a "
"newer release exists. Such queries transmit no information about You "
"or Your Content.",
"7. DISCLAIMER OF WARRANTIES",
"7.1 TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE SOFTWARE IS "
"PROVIDED \u201cAS IS\u201d AND \u201cAS AVAILABLE\u201d, WITH ALL "
"FAULTS AND WITHOUT WARRANTY OR CONDITION OF ANY KIND, WHETHER EXPRESS, "
"IMPLIED OR STATUTORY, INCLUDING ANY IMPLIED WARRANTY OF "
"MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, ACCURACY OR "
"NON-INFRINGEMENT.",
"7.2 The Software is research software. It is written to be correct and "
"it is tested, and it remains capable of producing results that are "
"wrong for Your data in ways not previously encountered. You are "
"responsible for validating any result on which You rely, and no result "
"produced by the Software constitutes scientific, medical, diagnostic "
"or clinical advice.",
"7.3 The Software writes to the directories You direct it to. You are "
"responsible for maintaining backups of Your Content.",
"8. LIMITATION OF LIABILITY",
"8.1 TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT "
"SHALL THE LICENSOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, "
"SPECIAL, CONSEQUENTIAL OR EXEMPLARY DAMAGES, INCLUDING WITHOUT "
"LIMITATION LOSS OF DATA, LOSS OF PROFITS, OR COST OF SUBSTITUTE "
"SOFTWARE, ARISING OUT OF OR RELATING TO THIS AGREEMENT OR THE USE OF "
"OR INABILITY TO USE THE SOFTWARE, UNDER ANY THEORY OF LIABILITY, EVEN "
"IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.",
"8.2 Nothing in this Agreement excludes or limits liability that cannot "
"be excluded or limited under applicable law.",
"9. TERM AND TERMINATION",
"9.1 This Agreement takes effect when You accept it and continues until "
"terminated.",
"9.2 You may terminate it at any time by ceasing all use of the "
"Software and destroying Your copies of it.",
"9.3 Sections 3, 4, 5, 7, 8 and 10 survive termination.",
"10. CHANGES TO THIS AGREEMENT",
"10.1 The Licensor may revise this Agreement. A revised Agreement "
"carries a new version number and is presented to You for acceptance "
"before the Software next runs.",
"10.2 Your acceptance applies to the version You were shown. Continuing "
"to use an earlier version of the Software does not bind You to a "
"later Agreement.",
"11. GENERAL",
"11.1 If any provision of this Agreement is held unenforceable, the "
"remaining provisions continue in full force.",
"11.2 A failure to enforce any provision is not a waiver of it.",
"11.3 This Agreement, together with the BSD 3-Clause License "
"referenced in Section 2.1, is the entire agreement between You and "
"the Licensor concerning the Software. Where the two differ, the "
"licence governs.",
"11.4 LANGUAGE. This Agreement is written in English. spaCR may present a translation of it for convenience, and a translation is not a separate agreement: if a translated version differs from the English in any respect, THE ENGLISH VERSION GOVERNS. You accept the English Agreement whichever language You read it in.",
)
#: The line shown on the agreement control itself.
AGREE_LABEL = "I have read and agree to these terms"
#: What the screen says while the end of the terms has not been reached.
#:
#: THE GATE HAS TO EXPLAIN ITSELF. A control that is greyed with nothing
#: beside it is a control the reader has to guess at, and "scroll further"
#: is not a guess anyone makes about a switch. It is shown from the moment
#: the slide opens, not only after a press, because the reader meets the
#: greyed switch before they meet the button.
SCROLL_HINT = (
"Scroll to the end of the terms to enable the acceptance checkbox.")
#: What the screen says when the user asks to move on without agreeing.
#:
#: NOT A DEAD BUTTON. A Next that is greyed with nothing beside it tells the
#: reader neither what is missing nor where to look for it, so the button
#: stays live and answers the press with the reason.
WHY_NOT_YET = (
"Accept the terms of use to complete setup. If you close this window "
"without accepting, spaCR will present the terms again at the next "
"startup.")
#: Where the accepted version is remembered, and when it was accepted.
_KEY_VERSION = "onboarding/terms_agreed_version"
_KEY_WHEN = "onboarding/terms_agreed_at"
def _settings():
"""Open spaCR's ``QSettings``.
:returns: the settings store.
"""
from .preferences import _settings as store
return store()
[docs]
def terms_text(language: str | None = None) -> str:
"""Return the terms with a blank line between clauses.
:param language: language code to present the agreement in. ``None`` uses
the profile's current language. A locale with no translated
presentation gets the English, which is always correct here.
THE ENGLISH IS THE AGREEMENT. Section 11.4 says so: a translation is a
convenience and the English governs. So a missing or partial translation
is never an error condition -- it falls back and the document a profile
accepts is unchanged, which is why `record_agreement` stores
`TERMS_VERSION` and nothing about the language on screen.
"""
if language is None:
try:
from .i18n import current_language
language = current_language()
except Exception: # noqa: BLE001
language = "en"
if str(language) != "en":
try:
from . import terms_i18n
translated = terms_i18n.paragraphs(str(language))
if translated:
return "\n\n".join(translated)
except Exception: # noqa: BLE001
LOG.debug("no translated agreement for %s", language,
exc_info=True)
return "\n\n".join(TERMS)
[docs]
def agreed_version() -> str:
"""The terms version this profile accepted, or ``""`` if none."""
try:
return str(_settings().value(_KEY_VERSION, "") or "")
except Exception: # noqa: BLE001
return ""
[docs]
def agreed_at() -> str:
"""When this profile accepted, in UTC ISO-8601, or ``""`` if never."""
try:
return str(_settings().value(_KEY_WHEN, "") or "")
except Exception: # noqa: BLE001
return ""
[docs]
def agreement_record() -> Dict[str, str]:
"""Return the recorded and current agreement metadata.
:returns: ``{'version', 'accepted_at', 'current_version', 'license'}``.
``version`` is empty for a profile that has never accepted, which is
a different answer from having accepted an older version and the
reason both are reported rather than one boolean.
"""
return {
"version": agreed_version(),
"accepted_at": agreed_at(),
"current_version": TERMS_VERSION,
"license": LICENSE_NAME,
}
[docs]
def record_agreement(version: str = "") -> str:
"""Record acceptance of a terms version and return the stored version.
:param version: the terms version accepted. Defaults to
:data:`TERMS_VERSION`, which is what the screen shows.
"""
stamped = str(version or TERMS_VERSION)
from datetime import datetime, timezone
when = datetime.now(timezone.utc).replace(microsecond=0).isoformat()
store = _settings()
store.setValue(_KEY_VERSION, stamped)
store.setValue(_KEY_WHEN, when)
try:
store.sync()
except Exception: # noqa: BLE001
pass
return stamped
[docs]
def needs_agreement(version: str = "") -> bool:
"""Return whether the profile must accept the requested terms version.
:param version: the version to check against. Defaults to
:data:`TERMS_VERSION`.
Returns ``True`` when no acceptance is recorded or when the recorded
version differs from the requested version.
"""
return agreed_version() != str(version or TERMS_VERSION)
#: The slide's own captions, translated. ``(source, (sv, de, es, zh_CN, pt,
#: hi, ko, is, fr))`` -- :data:`spacr.qt.i18n.LANGUAGES` order after English.
#:
#: THE CHROME IS TRANSLATED AND THE DOCUMENT IS NOT. The title, the sentence
#: introducing the terms, the acceptance and the reason for refusing are the
#: screen talking, and they are translated like everything else on it. The
#: TERMS THEMSELVES are not: a translated licence summary is not the licence,
#: and offering one as though it were would be the screen making a promise
#: the document does not. They are shown in the language the licence is
#: written in, with its name and its URL beside them.
TRANSLATIONS: Tuple[Tuple[str, Tuple[str, ...]], ...] = (
("Terms of use", (
"Användningsvillkor", "Nutzungsbedingungen", "Condiciones de uso",
"使用条款", "Termos de uso", "उपयोग की शर्तें", "이용 약관",
"Notkunarskilmálar", "Conditions d’utilisation")),
("Review the terms of use and scroll to the end to enable acceptance. "
"Use the license link to read the full BSD 3-Clause "
"License.", (
"Läs igenom användningsvillkoren och rulla till slutet för att "
"aktivera godkännandet. Använd licenslänken för att läsa hela "
"BSD 3-Clause License.",
"Lesen Sie die Nutzungsbedingungen und scrollen Sie bis zum Ende, "
"um die Zustimmung zu aktivieren. Über den Lizenzlink können Sie die "
"vollständige BSD 3-Clause License lesen.",
"Revise las condiciones de uso y desplácese hasta el final para "
"habilitar la aceptación. Utilice el enlace de la licencia para leer "
"la BSD 3-Clause License completa.",
"请查看使用条款并滚动到末尾以启用接受选项。使用许可证链接可阅读完整的 "
"BSD 3-Clause License。",
"Revise os termos de uso e role até o final para habilitar a "
"aceitação. Use o link da licença para ler a BSD 3-Clause "
"License completa.",
"उपयोग की शर्तों की समीक्षा करें और स्वीकृति सक्षम करने के लिए अंत तक स्क्रॉल करें। "
"पूर्ण BSD 3-Clause License पढ़ने के लिए लाइसेंस लिंक का उपयोग करें।",
"이용 약관을 검토하고 끝까지 스크롤하여 동의 항목을 활성화하십시오. "
"라이선스 링크에서 전체 BSD 3-Clause License을 확인할 수 있습니다.",
"Farðu yfir notkunarskilmálana og skrunaðu til enda til að "
"virkja samþykki. Notaðu leyfistengilinn til að lesa BSD "
"3-Clause License í heild.",
"Consultez les conditions d’utilisation et faites défiler jusqu’à la "
"fin pour activer l’acceptation. Utilisez le lien de licence pour lire "
"l’intégralité de la BSD 3-Clause License.")),
(AGREE_LABEL, (
"Jag har läst och godkänner dessa villkor",
"Ich habe diese Bedingungen gelesen und stimme ihnen zu",
"He leído y acepto estos términos",
"我已阅读并同意这些条款",
"Li e aceito estes termos",
"मैंने इन शर्तों को पढ़ लिया है और मैं इन्हें स्वीकार करता हूँ",
"이 약관을 읽었으며 이에 동의합니다",
"Ég hef lesið og samþykki þessa skilmála",
"J’ai lu et j’accepte ces conditions")),
(SCROLL_HINT, (
"Rulla till slutet av villkoren för att aktivera kryssrutan för "
"godkännande.",
"Scrollen Sie bis zum Ende der Nutzungsbedingungen, um das "
"Kontrollkästchen zur Zustimmung zu aktivieren.",
"Desplácese hasta el final de las condiciones para habilitar la "
"casilla de aceptación.",
"滚动到条款末尾以启用接受复选框。",
"Role até o final dos termos para habilitar a caixa de seleção de "
"aceitação.",
"स्वीकृति चेकबॉक्स सक्षम करने के लिए शर्तों के अंत तक स्क्रॉल करें।",
"약관 끝까지 스크롤하여 동의 확인란을 활성화하십시오.",
"Skrunaðu til enda skilmálanna til að virkja samþykkisreitinn.",
"Faites défiler jusqu’à la fin des conditions pour activer la case "
"d’acceptation.")),
(WHY_NOT_YET, (
"Godkänn användningsvillkoren för att slutföra konfigurationen. Om "
"du stänger fönstret utan att godkänna dem visar spaCR villkoren igen "
"vid nästa start.",
"Akzeptieren Sie die Nutzungsbedingungen, um die Einrichtung "
"abzuschließen. Wenn Sie dieses Fenster ohne Zustimmung schließen, "
"zeigt spaCR die Bedingungen beim nächsten Start erneut an.",
"Acepte las condiciones de uso para completar la configuración. Si "
"cierra esta ventana sin aceptarlas, spaCR volverá a mostrar las "
"condiciones en el próximo inicio.",
"接受使用条款以完成设置。如果未接受就关闭此窗口，spaCR 将在下次启动时再次显示这些条款。",
"Aceite os termos de uso para concluir a configuração. Se fechar "
"esta janela sem aceitá-los, o spaCR apresentará os termos novamente "
"na próxima inicialização.",
"सेटअप पूरा करने के लिए उपयोग की शर्तें स्वीकार करें। यदि आप बिना स्वीकार किए यह विंडो "
"बंद करते हैं, तो spaCR अगली बार शुरू होने पर शर्तें फिर दिखाएगा।",
"설정을 완료하려면 이용 약관에 동의하십시오. 동의하지 않고 이 창을 닫으면 spaCR가 "
"다음 시작 시 약관을 다시 표시합니다.",
"Samþykktu notkunarskilmálana til að ljúka uppsetningu. Ef þú "
"lokar þessum glugga án þess að samþykkja birtir spaCR skilmálana "
"aftur við næstu ræsingu.",
"Acceptez les conditions d’utilisation pour terminer la configuration. "
"Si vous fermez cette fenêtre sans les accepter, spaCR les présentera "
"de nouveau au prochain démarrage.")),
)
[docs]
def register_translations() -> int:
"""Register this screen's localized captions.
:returns: number of rows added; repeated registration returns ``0``.
"""
try:
from .i18n import add_translation
except Exception: # noqa: BLE001
return 0
added = 0
for source, values in TRANSLATIONS:
try:
added += bool(add_translation(source, values))
except ValueError:
continue
return added