Compare commits
2 Commits
0.13.3
...
dead-urls-
| Author | SHA1 | Date | |
|---|---|---|---|
|
6720a46d2e | ||
|
|
287b8e61a0 |
32
.github/actions/force-ipv4/README.md
vendored
32
.github/actions/force-ipv4/README.md
vendored
@@ -1,32 +0,0 @@
|
||||
# force-ipv4
|
||||
|
||||
## Overview
|
||||
|
||||
This GitHub action enforces IPv4 for all outgoing network requests. It addresses connectivity issues encountered in GitHub runners, where IPv6 requests may lead to timeouts due to the lack of IPv6 support [1] [2].
|
||||
|
||||
## Background
|
||||
|
||||
Some applications attempt network connections over IPv6.
|
||||
Such as requests made by Node's `fetch` API causes `UND_ERR_CONNECT_TIMEOUT` [3] [4] and similar issues [5].
|
||||
This happens when the software cannot handle this such as by using Happy Eyeballs [6] [7].
|
||||
|
||||
## Usage
|
||||
|
||||
To use this action in your GitHub workflow, add the following step before any job that requires network access:
|
||||
|
||||
```yaml
|
||||
- name: Enforce IPv4 Connectivity
|
||||
uses: ./.github/actions/force-ipv4
|
||||
```
|
||||
|
||||
## Note
|
||||
|
||||
This action is a workaround addressing specific IPv6-related connectivity issues on GitHub runners and may not be necessary if GitHub's infrastructure evolves to fully support IPv6 in the future.
|
||||
|
||||
[1]: https://archive.ph/2024.03.28-185829/https://github.com/actions/runner/issues/3138 "Actions Runner fails on IPv6 only host · Issue #3138 · actions/runner · GitHub | github.com"
|
||||
[2]: https://archive.ph/2024.03.28-185838/https://github.com/actions/runner-images/issues/668 "IPv6 on GitHub-hosted runners · Issue #668 · actions/runner-images · GitHub | github.com"
|
||||
[3]: https://archive.ph/2024.03.28-185847/https://github.com/actions/runner/issues/3213 "GitHub runner cannot send `fetch` with `node`, failing with IPv6 DNS error `UND_ERR_CONNECT_TIMEOUT` · Issue #3213 · actions/runner · GitHub | github.com"
|
||||
[4]: https://archive.ph/2024.03.28-185853/https://github.com/actions/runner-images/issues/9540 "Cannot send outbound requests using node fetch, failing with IPv6 DNS error UND_ERR_CONNECT_TIMEOUT · Issue #9540 · actions/runner-images · GitHub | github.com"
|
||||
[5]: https://archive.today/2024.03.30-113315/https://github.com/nodejs/node/issues/40537 "\"localhost\" favours IPv6 in node v17, used to favour IPv4 · Issue #40537 · nodejs/node · GitHub"
|
||||
[6]: https://archive.ph/2024.03.28-185900/https://github.com/nodejs/node/issues/41625 "Happy Eyeballs support (address IPv6 issues in Node 17) · Issue #41625 · nodejs/node · GitHub | github.com"
|
||||
[7]: https://archive.ph/2024.03.28-185910/https://github.com/nodejs/undici/issues/1531 "fetch times out in under 5 seconds · Issue #1531 · nodejs/undici · GitHub | github.com"
|
||||
12
.github/actions/force-ipv4/action.yml
vendored
12
.github/actions/force-ipv4/action.yml
vendored
@@ -1,12 +0,0 @@
|
||||
inputs:
|
||||
project-root:
|
||||
required: false
|
||||
default: '.'
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
-
|
||||
name: Run prefer IPv4 script
|
||||
shell: bash
|
||||
run: ./.github/actions/force-ipv4/force-ipv4.sh
|
||||
working-directory: ${{ inputs.project-root }}
|
||||
80
.github/actions/force-ipv4/force-ipv4.sh
vendored
80
.github/actions/force-ipv4/force-ipv4.sh
vendored
@@ -1,80 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
main() {
|
||||
if is_linux; then
|
||||
echo 'Configuring Linux...'
|
||||
|
||||
configure_warp_with_doh_and_ipv6_exclusion_on_linux # [WORKS] Resolves the issue when run independently on GitHub runners lacking IPv6 support.
|
||||
prefer_ipv4_on_linux # [DOES NOT WORK] It does not resolve the issue when run independently on GitHub runners without IPv6 support.
|
||||
|
||||
# Considered alternatives:
|
||||
# - `sysctl` commands, and direct changes to `/proc/sys/net/` and `/etc/sysctl.conf` led to silent
|
||||
# Node 18 exits (code: 13) when using `fetch`.
|
||||
elif is_macos; then
|
||||
echo 'Configuring macOS...'
|
||||
|
||||
configure_warp_with_doh_and_ipv6_exclusion_on_macos # [WORKS] Resolves the issue when run independently on GitHub runners lacking IPv6 support.
|
||||
disable_ipv6_on_macos # [WORKS INCONSISTENTLY] Resolves the issue inconsistently when run independently on GitHub runners without IPv6 support.
|
||||
fi
|
||||
echo "IPv4: $(curl --ipv4 --silent --max-time 15 --retry 3 --user-agent Mozilla https://api.ip.sb/geoip)"
|
||||
echo "IPv6: $(curl --ipv6 --silent --max-time 15 --retry 3 --user-agent Mozilla https://api.ip.sb/geoip)"
|
||||
}
|
||||
|
||||
is_linux() {
|
||||
[[ "$(uname -s)" == "Linux" ]]
|
||||
}
|
||||
|
||||
is_macos() {
|
||||
[[ "$(uname -s)" == "Darwin" ]]
|
||||
}
|
||||
|
||||
configure_warp_with_doh_and_ipv6_exclusion_on_linux() {
|
||||
install_warp_on_debian
|
||||
configure_warp_doh_and_exclude_ipv6
|
||||
}
|
||||
|
||||
configure_warp_with_doh_and_ipv6_exclusion_on_macos() {
|
||||
brew install cloudflare-warp
|
||||
configure_warp_doh_and_exclude_ipv6
|
||||
}
|
||||
|
||||
configure_warp_doh_and_exclude_ipv6() {
|
||||
echo 'Beginning configuration of the Cloudflare WARP client with DNS-over-HTTPS and IPv6 exclusion...'
|
||||
echo 'Initiating client registration with Cloudflare...'
|
||||
warp-cli --accept-tos registration new
|
||||
echo 'Configuring WARP to operate in DNS-over-HTTPS mode (warp+doh)...'
|
||||
warp-cli --accept-tos mode warp+doh
|
||||
echo 'Excluding IPv6 traffic from WARP by configuring it as a split tunnel...'
|
||||
warp-cli --accept-tos add-excluded-route '::/0' # Exclude IPv6, forcing IPv4 resolution
|
||||
# `tunnel ip add` does not work with IP ranges, see https://community.cloudflare.com/t/cant-cidr-for-split-tunnling/630834
|
||||
echo 'Establishing WARP connection...'
|
||||
warp-cli --accept-tos connect
|
||||
}
|
||||
|
||||
install_warp_on_debian() {
|
||||
curl -fsSL https://pkg.cloudflareclient.com/pubkey.gpg | sudo gpg --yes --dearmor --output /usr/share/keyrings/cloudflare-warp-archive-keyring.gpg
|
||||
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/cloudflare-warp-archive-keyring.gpg] https://pkg.cloudflareclient.com/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/cloudflare-client.list
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y cloudflare-warp
|
||||
}
|
||||
|
||||
disable_ipv6_on_macos() {
|
||||
networksetup -listallnetworkservices \
|
||||
| tail -n +2 \
|
||||
| while IFS= read -r interface; do
|
||||
echo "Disabling IPv6 on: $interface..."
|
||||
networksetup -setv6off "$interface"
|
||||
done
|
||||
}
|
||||
|
||||
prefer_ipv4_on_linux() {
|
||||
local -r gai_config_file_path='/etc/gai.conf'
|
||||
if [ ! -f "$gai_config_file_path" ]; then
|
||||
echo "Creating $gai_config_file_path since it doesn't exist..."
|
||||
touch "$gai_config_file_path"
|
||||
fi
|
||||
echo "precedence ::ffff:0:0/96 100" | sudo tee -a "$gai_config_file_path" > /dev/null
|
||||
echo "Configuration complete."
|
||||
}
|
||||
|
||||
main
|
||||
3
.github/actions/setup-node/action.yml
vendored
3
.github/actions/setup-node/action.yml
vendored
@@ -5,5 +5,4 @@ runs:
|
||||
name: Setup node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20.x
|
||||
# check-latest: true # Newest versions can potentially have undiscovered bugs or regressions
|
||||
node-version: 18.x
|
||||
|
||||
8
.github/workflows/checks.build.yaml
vendored
8
.github/workflows/checks.build.yaml
vendored
@@ -95,12 +95,6 @@ jobs:
|
||||
-
|
||||
name: Run Docker image on port 8080
|
||||
run: docker run -d -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest
|
||||
-
|
||||
name: Enforce IPv4 Connectivity # Used due to GitHub runners' lack of IPv6 support, preventing request timeouts.
|
||||
uses: ./.github/actions/force-ipv4
|
||||
-
|
||||
name: Check server is up and returns HTTP 200
|
||||
run: >-
|
||||
node ./scripts/verify-web-server-status.js \
|
||||
--url http://localhost:8080 \
|
||||
--max-retries ${{ matrix.os == 'macos' && '90' || '30' }}
|
||||
run: node ./scripts/verify-web-server-status.js --url http://localhost:8080
|
||||
|
||||
7
.github/workflows/checks.external-urls.yaml
vendored
7
.github/workflows/checks.external-urls.yaml
vendored
@@ -18,13 +18,10 @@ jobs:
|
||||
-
|
||||
name: Install dependencies
|
||||
uses: ./.github/actions/npm-install-dependencies
|
||||
-
|
||||
name: Enforce IPv4 Connectivity # Used due to GitHub runners' lack of IPv6 support, preventing request timeouts.
|
||||
uses: ./.github/actions/force-ipv4
|
||||
-
|
||||
name: Test
|
||||
run: npm run check:external-urls
|
||||
env:
|
||||
RANDOMIZED_URL_CHECK_LIMIT: "${{ github.event_name == 'push' && '100' || '3000' }}"
|
||||
# - Scheduled checks has high limit for thorough testing.
|
||||
RANDOMIZED_URL_CHECK_LIMIT: "${{ github.event_name == 'push' && '10' || '' }}"
|
||||
# - Scheduled checks has no limits, ensuring thorough testing.
|
||||
# - For push events, triggered by code changes, the amount of URLs are limited to provide quick feedback.
|
||||
|
||||
48
.github/workflows/checks.quality.yaml
vendored
48
.github/workflows/checks.quality.yaml
vendored
@@ -1,4 +1,4 @@
|
||||
name: checks.quality
|
||||
name: quality-checks
|
||||
|
||||
on: [ push, pull_request ]
|
||||
|
||||
@@ -28,49 +28,3 @@ jobs:
|
||||
-
|
||||
name: Lint
|
||||
run: ${{ matrix.lint-command }}
|
||||
|
||||
todo-check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
-
|
||||
name: Scan latest commit for TODO comments
|
||||
shell: bash
|
||||
run: |-
|
||||
readonly todo_comment_search_pattern='TODO'':' # Define search pattern in parts to prevent IDE from flagging this script line as a TODO item
|
||||
if git grep "$todo_comment_search_pattern" HEAD; then
|
||||
echo 'TODO comments found in the latest commit.'
|
||||
exit 1
|
||||
else
|
||||
echo 'No TODO comments found in the latest commit.'
|
||||
exit 0
|
||||
fi
|
||||
|
||||
pylint:
|
||||
runs-on: ${{ matrix.os }}-latest
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ macos, ubuntu, windows ]
|
||||
fail-fast: false # Still interested to see results from other combinations
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
-
|
||||
name: Setup node
|
||||
uses: ./.github/actions/setup-node
|
||||
-
|
||||
name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.x'
|
||||
-
|
||||
name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install pylint
|
||||
-
|
||||
name: Analyzing the code with pylint
|
||||
run: npm run lint:pylint
|
||||
|
||||
32
.github/workflows/checks.scripts.yaml
vendored
32
.github/workflows/checks.scripts.yaml
vendored
@@ -15,10 +15,6 @@ jobs:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
-
|
||||
name: Install ImageMagick on macOS
|
||||
if: matrix.os == 'macos'
|
||||
run: brew install imagemagick
|
||||
-
|
||||
name: Setup node
|
||||
uses: ./.github/actions/setup-node
|
||||
@@ -57,31 +53,3 @@ jobs:
|
||||
-
|
||||
name: Run install-deps
|
||||
run: ${{ matrix.install-command }}
|
||||
|
||||
configure-vscode:
|
||||
runs-on: ${{ matrix.os.name }}-latest
|
||||
strategy:
|
||||
matrix:
|
||||
os:
|
||||
- name: macos
|
||||
install-vscode-command: brew install --cask visual-studio-code
|
||||
- name: ubuntu
|
||||
install-vscode-command: sudo snap install code --classic
|
||||
- name: windows
|
||||
install-vscode-command: choco install vscode
|
||||
fail-fast: false # Still interested to see results from other combinations
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
-
|
||||
name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.x'
|
||||
-
|
||||
name: Install VSCode
|
||||
run: ${{ matrix.os.install-vscode-command }}
|
||||
-
|
||||
name: Configure VSCode
|
||||
run: python3 ./scripts/configure_vscode.py
|
||||
|
||||
44
CHANGELOG.md
44
CHANGELOG.md
@@ -1,49 +1,5 @@
|
||||
# Changelog
|
||||
|
||||
## 0.13.2 (2024-04-15)
|
||||
|
||||
* Update documentation for `logo-update.js` script | [4a9b430](https://github.com/undergroundwires/privacy.sexy/commit/4a9b430702bc6082426b50ecc3a06362b5720796)
|
||||
* win: improve and document removing Phone apps #279 | [8924337](https://github.com/undergroundwires/privacy.sexy/commit/89243371faa5d6aef5fce52b0d54a442143cdd39)
|
||||
* Fix bottom gap in card expansion panel | [79183d6](https://github.com/undergroundwires/privacy.sexy/commit/79183d64173e588d88bf074d5b50a52a71c2d885)
|
||||
* ci/cd: Fix macOS Docker build reliability issues | [8a5592f](https://github.com/undergroundwires/privacy.sexy/commit/8a5592f92be4366a806afc9eee9135696a1dd993)
|
||||
* ci/cd: fix IPv6 timeouts with `force-ipv4` action | [52fadcd](https://github.com/undergroundwires/privacy.sexy/commit/52fadcd6177ed06216be9c67dad57192ae02a4f9)
|
||||
* ci/cd: bump Node.js environment to 20.x | [59decd1](https://github.com/undergroundwires/privacy.sexy/commit/59decd17e273bada1493eaa855c43cbabf90308f)
|
||||
* ci/cd: trigger URL checks more, and limit amount | [4fb6302](https://github.com/undergroundwires/privacy.sexy/commit/4fb6302c67f2a3fedff419e8c22872593cf800ef)
|
||||
* Fix overflow in tree node content on small screens | [557cea3](https://github.com/undergroundwires/privacy.sexy/commit/557cea3f4866dc33236874f5fe4d2d69ee963dae)
|
||||
* Fix horizontal layout shift after script selection | [bc7e1fa](https://github.com/undergroundwires/privacy.sexy/commit/bc7e1faa1c3f2b61bf2046fdd6d6a4141b484662)
|
||||
* Fix card header expansion glitch on card collapse | [5d940b5](https://github.com/undergroundwires/privacy.sexy/commit/5d940b57ef2a4c219932cd15201401f8550cfb41)
|
||||
* Ignore `ResizeObserver` errors in Cypress tests | [4472c28](https://github.com/undergroundwires/privacy.sexy/commit/4472c2852e4b87083bda7979471ab9f377d17a01)
|
||||
* win: improve and document secret key scripts | [49f22f0](https://github.com/undergroundwires/privacy.sexy/commit/49f22f048f39e7388633c488b5fe59101b831984)
|
||||
* Fix card arrow not being animated in sync | [7b546c5](https://github.com/undergroundwires/privacy.sexy/commit/7b546c567c4683a37fe94595362f4c2bf92ffd59)
|
||||
* win: improve Windows feature disablement scripts | [b68711e](https://github.com/undergroundwires/privacy.sexy/commit/b68711ef88982c0ee2b1d41b4452e899821adc64)
|
||||
* Fix top script menu overflow on small screens | [b7a20d9](https://github.com/undergroundwires/privacy.sexy/commit/b7a20d9d41ea8bcefdd553b87641f3c22b4cde97)
|
||||
* win: fix Visual Studio remote analysis script #327 | [4142d08](https://github.com/undergroundwires/privacy.sexy/commit/4142d084f64a3b540487ff68b28032977d12006d)
|
||||
* win: improve firewall docs /w `winget` impact #142 | [ffd647d](https://github.com/undergroundwires/privacy.sexy/commit/ffd647d1529375474b81900cc7bee4c32fbf861f)
|
||||
* Centralize and use global spacing variables | [ae17200](https://github.com/undergroundwires/privacy.sexy/commit/ae172000a64416e5a3e2b2e32b7846f039f445f0)
|
||||
* win: improve service revert and docs | [b87b7aa](https://github.com/undergroundwires/privacy.sexy/commit/b87b7aac7d118a23a0d1bfb881e385347de4adb7)
|
||||
* Bump dependencies to latest, hold ESLint | [f3571ab](https://github.com/undergroundwires/privacy.sexy/commit/f3571abeafdbe1e6d152958fab26de91a9c08bc3)
|
||||
* Fix inability to tap outside modal on mobile | [cb144ae](https://github.com/undergroundwires/privacy.sexy/commit/cb144ae47273deeb7058d4b1380e480ebccdaf81)
|
||||
|
||||
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.1...0.13.2)
|
||||
|
||||
## 0.13.1 (2024-03-22)
|
||||
|
||||
* ci/cd: Fix cross-platform git command compability | [255c51c](https://github.com/undergroundwires/privacy.sexy/commit/255c51c8a0524d3ea8a3b16ffc1b178650525010)
|
||||
* Fix tooltip falling behind elements on fade out | [1964524](https://github.com/undergroundwires/privacy.sexy/commit/19645248ab7bc78dc872fa176c1a3650d7d6d644)
|
||||
* Improve VSCode detection in `configure_vscode.py` | [98845e6](https://github.com/undergroundwires/privacy.sexy/commit/98845e6caee168db131aaf0736533e450827a52c)
|
||||
* Bump TypeScript to 5.3 with `verbatimModuleSyntax` | [a721e82](https://github.com/undergroundwires/privacy.sexy/commit/a721e82a4fb603c0732ccfdffc87396c2a01363e)
|
||||
* Migrate to Vite 5 and adjust configurations | [4ac1425](https://github.com/undergroundwires/privacy.sexy/commit/4ac1425f76079352268c488f3ff607d1fdc1beb2)
|
||||
* win: improve and unify service start/stop logic | [adc2089](https://github.com/undergroundwires/privacy.sexy/commit/adc20898873d50a8873ffc74c48257e69a45d367)
|
||||
* Upgrade vitest to v1 and fix test definitions | [e721885](https://github.com/undergroundwires/privacy.sexy/commit/e7218850ba62a7bebaf4768b13e46cba0dedd906)
|
||||
* Improve URL checks to reduce false-negatives | [5abf8ff](https://github.com/undergroundwires/privacy.sexy/commit/5abf8ff216a1da737fd489864eeee880f78d6601)
|
||||
* win: improve OneDrive data deletion safety | [5eff3a0](https://github.com/undergroundwires/privacy.sexy/commit/5eff3a04886d0d23a6e4c13a0178bb247105c5cb)
|
||||
* Bump Electron to latest and use native ESM | [840adf9](https://github.com/undergroundwires/privacy.sexy/commit/840adf9429ed47f9e88c05e90f1d3ab930c2dfc4)
|
||||
* Fix tooltip styling inconsistency | [ec34ac1](https://github.com/undergroundwires/privacy.sexy/commit/ec34ac1124e8b8ae53bf31a4dbdc88bb078b3d4e)
|
||||
* win: fix VSCode manual update switch script #312 | [b71ad79](https://github.com/undergroundwires/privacy.sexy/commit/b71ad797a3af0db45143249903cb5e178692de7c)
|
||||
* mac, linux, win: fix dead URLs and improve docs | [abec9de](https://github.com/undergroundwires/privacy.sexy/commit/abec9def075d82fdaee9663ef8fe1a488911f45b)
|
||||
|
||||
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.0...0.13.1)
|
||||
|
||||
## 0.13.0 (2024-02-11)
|
||||
|
||||
* win: add disabling clipboard features #251, #247 | [c6ebba8](https://github.com/undergroundwires/privacy.sexy/commit/c6ebba85fb1b362be0d81d3078f19db71e0528b2)
|
||||
|
||||
11
README.md
11
README.md
@@ -60,8 +60,8 @@
|
||||
<br />
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
alt="Status of quality checks"
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.quality/badge.svg"
|
||||
alt="Quality checks status"
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/quality-checks/badge.svg"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
|
||||
@@ -122,12 +122,9 @@
|
||||
## Get started
|
||||
|
||||
- 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
|
||||
- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.2/privacy.sexy-Setup-0.13.2.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.2/privacy.sexy-0.13.2.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.2/privacy.sexy-0.13.2.AppImage). For more options, see [here](#additional-install-options).
|
||||
- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.0/privacy.sexy-Setup-0.13.0.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.0/privacy.sexy-0.13.0.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.0/privacy.sexy-0.13.0.AppImage). For more options, see [here](#additional-install-options).
|
||||
|
||||
See also:
|
||||
|
||||
- [Desktop vs. Web Features](./docs/desktop/desktop-vs-web-features.md): Differences and unique aspects of desktop and web versions.
|
||||
- [System Requirements](./docs/desktop/system-requirements.md): Hardware and software requirements for the desktop version.
|
||||
For a detailed comparison of features between the desktop and web versions of privacy.sexy, see [Desktop vs. Web Features](./docs/desktop-vs-web-features.md).
|
||||
|
||||
💡 Regularly applying your configuration with privacy.sexy is recommended, especially after each new release and major operating system updates. Each version updates scripts to enhance stability, privacy, and security.
|
||||
|
||||
|
||||
15
SECURITY.md
15
SECURITY.md
@@ -43,17 +43,10 @@ privacy.sexy adopts a defense in depth strategy to protect users on multiple lay
|
||||
elevation of privileges for system modifications with explicit user consent and logs every action taken with high privileges. This
|
||||
approach actively minimizes potential security risks by limiting privileged operations and aligning with the principle of least privilege.
|
||||
- **Secure Script Execution/Storage:**
|
||||
- **Antivirus scans:**
|
||||
Before executing any script, the desktop application stores a copy to allow antivirus software to perform scans.
|
||||
This step allows confirming that the scripts are secure and safe to use.
|
||||
- **Tamper protection:**
|
||||
The application incorporates integrity checks for tamper protection.
|
||||
If the script file differs from the user's selected script, the application will not execute or save the script, ensuring the processing
|
||||
of authentic scripts.
|
||||
This safeguards against any unwanted modifications.
|
||||
- **Clean-up:**
|
||||
Recognizing that some users prefer not to keep these records, privacy.sexy provides specialized scripts for deletion of these scripts.
|
||||
This allows users to maintain their privacy by removing traces of their usage patterns or script preferences.
|
||||
Before executing any script, the desktop application stores a copy to allow antivirus software to perform scans. This safeguards against
|
||||
any unwanted modifications. Furthermore, the application incorporates integrity checks for tamper protection. If the script file differs from
|
||||
the user's selected script, the application will not execute or save the script, ensuring the processing of authentic scripts.
|
||||
Recognizing that some users prefer not to keep these records, privacy.sexy provides specialized scripts for deletion of these scripts.
|
||||
|
||||
### Update Security and Integrity
|
||||
|
||||
|
||||
5
build/README.md
Normal file
5
build/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# build
|
||||
|
||||
This folder contains files that are used by Electron to serve the desktop version.
|
||||
|
||||
Icons are created from the main logo file and should not be changed manually, see [related documentation](./../img/README.md).
|
||||
BIN
build/icons/1024x1024.png
Normal file
BIN
build/icons/1024x1024.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
BIN
build/icons/128x128.png
Normal file
BIN
build/icons/128x128.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.1 KiB |
BIN
build/icons/16x16.png
Normal file
BIN
build/icons/16x16.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 553 B |
BIN
build/icons/24x24.png
Normal file
BIN
build/icons/24x24.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 963 B |
BIN
build/icons/256x256.png
Normal file
BIN
build/icons/256x256.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
build/icons/32x32.png
Normal file
BIN
build/icons/32x32.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
BIN
build/icons/48x48.png
Normal file
BIN
build/icons/48x48.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
BIN
build/icons/512x512.png
Normal file
BIN
build/icons/512x512.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
build/icons/64x64.png
Normal file
BIN
build/icons/64x64.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.9 KiB |
BIN
build/icons/icon.icns
Normal file
BIN
build/icons/icon.icns
Normal file
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 364 KiB After Width: | Height: | Size: 353 KiB |
@@ -1,6 +1,6 @@
|
||||
# Desktop vs. Web Features
|
||||
|
||||
This table outlines the differences between the desktop and web versions of `privacy.sexy`.
|
||||
This table highlights differences between the desktop and web versions of `privacy.sexy`.
|
||||
|
||||
| Feature | Desktop | Web |
|
||||
| ------- | ------- | --- |
|
||||
@@ -8,8 +8,10 @@ This table outlines the differences between the desktop and web versions of `pri
|
||||
| [Offline usage](#offline-usage) | 🟢 Available | 🟡 Partially available |
|
||||
| [Auto-updates](#auto-updates) | 🟢 Available | 🟢 Available |
|
||||
| [Logging](#logging) | 🟢 Available | 🔴 Not available |
|
||||
| [Secure script execution/storage](#secure-script-executionstorage) | 🟢 Available | 🔴 Not available |
|
||||
| [Script execution](#script-execution) | 🟢 Available | 🔴 Not available |
|
||||
| [Error handling](#error-handling) | 🟢 Advanced | 🟡 Limited |
|
||||
| [Native dialogs](#native-dialogs) | 🟢 Available | 🔴 Not available |
|
||||
| [Secure script execution/storage](#secure-script-executionstorage) | 🟢 Available | 🔴 Not available |
|
||||
|
||||
## Feature descriptions
|
||||
|
||||
@@ -28,11 +30,11 @@ Desktop version inherently allows offline usage.
|
||||
|
||||
### Auto-updates
|
||||
|
||||
Both the desktop and web versions of privacy.sexy provide timely access to the latest features and security improvements. The updates are automatically deployed from source code, reflecting the latest changes for enhanced security and reliability. For more details, see [CI/CD documentation](./../ci-cd.md).
|
||||
Both the desktop and web versions of privacy.sexy provide timely access to the latest features and security improvements. The updates are automatically deployed from source code, reflecting the latest changes for enhanced security and reliability. For more details, see [CI/CD documentation](./ci-cd.md).
|
||||
|
||||
The desktop version ensures secure delivery through cryptographic signatures and version checks.
|
||||
|
||||
[Security is a top priority](./../../SECURITY.md#update-security-and-integrity) at privacy.sexy.
|
||||
[Security is a top priority](./../SECURITY.md#update-security-and-integrity) at privacy.sexy.
|
||||
|
||||
> **Note for macOS users:** On macOS, the desktop version's auto-update process involves manual steps due to Apple's code signing costs.
|
||||
> Users get notified about updates but might need to complete the installation manually.
|
||||
@@ -51,7 +53,7 @@ Log file locations vary by operating system:
|
||||
|
||||
> 💡 privacy.sexy provides scripts to securely erase these logs.
|
||||
|
||||
### Secure script execution/storage
|
||||
### Script execution
|
||||
|
||||
The desktop version of privacy.sexy enables direct script execution, providing a seamless and integrated experience.
|
||||
This direct execution capability isn't available in the web version due to inherent browser restrictions.
|
||||
@@ -67,27 +69,31 @@ These locations vary based on the operating system:
|
||||
|
||||
> 💡 privacy.sexy provides scripts to securely erase your script execution history.
|
||||
|
||||
**Script antivirus scans:**
|
||||
|
||||
To enhance system protection, the desktop version of privacy.sexy automatically verifies the security of script
|
||||
execution files by reading them back.
|
||||
This process triggers antivirus scans to verify that scripts are safe before the execution.
|
||||
|
||||
**Script integrity checks:**
|
||||
|
||||
The desktop version of privacy.sexy implements robust integrity checks for both script execution and storage.
|
||||
Featuring tamper protection, the application actively verifies the integrity of script files before executing or saving them.
|
||||
If the actual contents of a script file do not align with the expected contents, the application refuses to execute or save the script.
|
||||
This proactive approach ensures only unaltered and verified scripts undergo processing, thereby enhancing both security and reliability.
|
||||
|
||||
**Error handling:**
|
||||
### Error handling
|
||||
|
||||
The desktop version of privacy.sexy features advanced error handling capabilities.
|
||||
In scenarios where script execution or storage encounters failure, the desktop application initiates automated troubleshooting and self-healing processes.
|
||||
It employs robust and reliable execution strategies, including self-healing mechanisms, and provides guidance and troubleshooting information to resolve issues effectively.
|
||||
This proactive error handling and user guidance enhances the application's security and reliability.
|
||||
In contrast, the web version has more basic error handling due to browser limitations and the nature of web applications.
|
||||
|
||||
### Native dialogs
|
||||
|
||||
The desktop version uses native dialogs, offering more features and reliability compared to the browser's file system dialogs.
|
||||
These native dialogs provide a more integrated and user-friendly experience, aligning with the operating system's standard interface and functionalities.
|
||||
|
||||
### Secure script execution/storage
|
||||
|
||||
**Integrity checks:**
|
||||
|
||||
The desktop version of privacy.sexy implements robust integrity checks for both script execution and storage.
|
||||
Featuring tamper protection, the application actively verifies the integrity of script files before executing or saving them.
|
||||
If the actual contents of a script file do not align with the expected contents, the application refuses to execute or save the script.
|
||||
This proactive approach ensures only unaltered and verified scripts undergo processing, thereby enhancing both security and reliability.
|
||||
Due to browser constraints, this feature is absent in the web version.
|
||||
|
||||
**Error handling:**
|
||||
|
||||
In scenarios where script execution or storage encounters failure, the desktop application initiates automated troubleshooting and self-healing processes.
|
||||
It also guides users through potential issues with filesystem or third-party software, such as antivirus interventions.
|
||||
Specifically, the application is capable of identifying when antivirus software blocks or removes a script, providing users with tailored error messages
|
||||
and detailed resolution steps. This level of proactive error handling and user guidance enhances the application's security and reliability,
|
||||
offering a feature not achievable in the web version due to browser limitations.
|
||||
@@ -1,40 +0,0 @@
|
||||
# System Requirements for the Desktop Version
|
||||
|
||||
The following system requirements are the official ones for the desktop version.
|
||||
While we have tested and confirmed these requirements, the application might also work on other
|
||||
systems or configurations that haven't undergone official testing.
|
||||
|
||||
## Windows
|
||||
|
||||
- **Version:** Windows 10 and later.
|
||||
- **Processor:** Intel Pentium 4 or later.
|
||||
- **Architecture:** 64-bit (x64), ARM.
|
||||
|
||||
> **⚠️ Compatibility Note:**
|
||||
> ARM version is only compatible with Windows 11 and later.
|
||||
> It runs non-natively, leading to slower performance due to emulation [1].
|
||||
|
||||
## macOS
|
||||
|
||||
- **Version:** macOS Catalina (10.15) and later.
|
||||
- **Architecture:** Intel-based (64-bit), Apple Silicon (ARM).
|
||||
|
||||
> **⚠️ Compatibility Note:**
|
||||
> Apple Silicon version runs non-natively, leading to slower performance due to emulation [2].
|
||||
|
||||
## Linux
|
||||
|
||||
- **Version:** Ubuntu 18.04 and later, Fedora 32 and later, and Debian 10 and later.
|
||||
- **Processor:** Intel Pentium 4 or later.
|
||||
- **Architecture:** 64-bit (x64).
|
||||
|
||||
## References
|
||||
|
||||
System requirements reflect Electron's platform capabilities [3] and Chromium's recommended configurations [4].
|
||||
|
||||
For details on the build process, see [electron-builder configuration file](./../../electron-builder.cjs).
|
||||
|
||||
[1]: https://web.archive.org/web/20240428082726/https://learn.microsoft.com/en-us/windows/arm/add-arm-support#emulation-on-arm-based-devices-for-x86-or-x64-windows-apps "Add support Arm devices to your Windows app | Microsoft Learn | learn.microsoft.com"
|
||||
[2]: https://archive.today/2024.04.28-082901/https://developer.apple.com/documentation/apple-silicon/building-a-universal-macos-binary%23overview "Building a universal macOS binary | Apple Developer Documentation | developer.apple.com"
|
||||
[3]: https://archive.ph/2024.04.28-082958/https://github.com/electron/electron/blob/main/README.md#platform-support "Platform Support | electron/README.md at main · electron/electron · GitHub | github.com"
|
||||
[4]: https://web.archive.org/web/20240428082945/https://support.google.com/chrome/a/answer/7100626?hl=en "Chrome browser system requirements - Chrome Enterprise and Education Help | support.google.com"
|
||||
@@ -14,19 +14,18 @@ The presentation layer uses an event-driven architecture for bidirectional react
|
||||
- [**`main.ts`**](./../src/presentation/main.ts): Starts Vue app.
|
||||
- [**`index.html`**](./../src/presentation/index.html): The `index.html` entry file, located at the root of the project as required by Vite
|
||||
- [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue components and plugins.
|
||||
- [**`components/`**](./../src/presentation/components/): Contains Vue components, helpers and styles coupled to Vue components.
|
||||
- [**`components/`**](./../src/presentation/components/): Contains Vue components and helpers.
|
||||
- [**`Shared/`**](./../src/presentation/components/Shared): Contains shared Vue components and helpers.
|
||||
- [**`Hooks`**](../src/presentation/components/Shared/Hooks): Hooks used by components through [dependency injection](#dependency-injections).
|
||||
- [**`/public/`**](../src/presentation/public/): Contains static assets.
|
||||
- [**`assets/`**](./../src/presentation/assets/styles/): Contains assets processed by Vite.
|
||||
- [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts.
|
||||
- [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles.
|
||||
- [**`components/`**](./../src/presentation/assets/styles/components): Contains styles coupled to Vue components.
|
||||
- [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Main Sass file, imported by other components as single entrypoint..
|
||||
- [**`electron/`**](./../src/presentation/electron/): Contains Electron code.
|
||||
- [`/main/` **`index.ts`**](./../src/presentation/electron/main/index.ts): Main entry for Electron, managing application windows and lifecycle events.
|
||||
- [`/preload/` **`index.ts`**](./../src/presentation/electron/preload/index.ts): Script executed before the renderer, securing Node.js features for renderer use.
|
||||
- [**`/shared/`**](./../src/presentation/electron/shared/): Shared logic between different Electron processes.
|
||||
- [**`/build/`**](./../src/presentation/electron/build/): `electron-builder` build resources directory, [README.md](./../src/presentation/electron/build/README.md).
|
||||
- [`/main/` **`index.ts`**](./../src/presentation/main.ts): Main entry for Electron, managing application windows and lifecycle events.
|
||||
- [`/preload/` **`index.ts`**](./../src/presentation/main.ts): Script executed before the renderer, securing Node.js features for renderer use.
|
||||
- [**`/vite.config.ts`**](./../vite.config.ts): Contains Vite configurations for building web application.
|
||||
- [**`/electron.vite.config.ts`**](./../electron.vite.config.ts): Contains Vite configurations for building desktop applications.
|
||||
- [**`/postcss.config.cjs`**](./../postcss.config.cjs): Contains PostCSS configurations for Vite.
|
||||
@@ -39,13 +38,6 @@ The presentation layer uses an event-driven architecture for bidirectional react
|
||||
They should also have different visual state when hovering/touching on them that indicates that they are being clicked, which helps with accessibility.
|
||||
- **Borders**:
|
||||
privacy.sexy prefers sharper edges in its design language.
|
||||
- **Fonts**:
|
||||
- Use the primary font for regular text and monospace font for code or specific data.
|
||||
- Use cursive and logo fonts solely for branding.
|
||||
- Refer to [standardized font size variables](../src/presentation/assets/styles/_typography.scss) for font sizing, avoiding arbitrary `px`, `em`, `rem`, or percentage values.
|
||||
- **Spacing**:
|
||||
Use [global spacing variables](../src/presentation/assets/styles/_spacing.scss) for consistent margin, padding, and gap definitions.
|
||||
This provides uniform spatial distribution and alignment of elements, enhancing visual harmony and making the UI more scalable and maintainable.
|
||||
|
||||
## Application data
|
||||
|
||||
|
||||
@@ -27,7 +27,6 @@ Key attributes of a good script:
|
||||
- `Minimize` over `Limit`, `Reduce`
|
||||
- `Maximize` over `Extend`, `Delay`, `Postpone`, `Prolong`
|
||||
- `Remove` over `Uninstall`
|
||||
- `Improve` over `Increase`
|
||||
- Structure your phrases for clarity, examples:
|
||||
- Prefer `Disable XX telemetry` over `Disable telemetry in XX`
|
||||
- Prefer `Clear XX data` over `Clear data from XX`, or `Clear data of XX`.
|
||||
@@ -36,8 +35,8 @@ Key attributes of a good script:
|
||||
## Documentation
|
||||
|
||||
- Use credible and reputable sources for references.
|
||||
- Use archived links by using [archive.org](https://archive.org) or [archive.ph](https://archive.ph).
|
||||
- Format archive.today links fully, for example: `https://archive.ph/YYYYMMDDhhmmss/https://privacy.sexy`.
|
||||
- Use archived links by using [archive.org](https://archive.org) or [archive.today](https://archive.today).
|
||||
- Format archive.today links fully, for example: `https://archive.today/YYYYMMDDhhmmss/https://privacy.sexy`.
|
||||
- Explain the default behavior if the script is not executed.
|
||||
|
||||
## Shared functions
|
||||
|
||||
@@ -1,13 +1,8 @@
|
||||
/* eslint-disable no-template-curly-in-string */
|
||||
|
||||
const { join, resolve } = require('node:path');
|
||||
const { readdirSync, existsSync } = require('node:fs');
|
||||
const { join } = require('node:path');
|
||||
const { electronBundled, electronUnbundled } = require('./dist-dirs.json');
|
||||
|
||||
/**
|
||||
* @type {import('electron-builder').Configuration}
|
||||
* @see https://www.electron.build/configuration/configuration
|
||||
*/
|
||||
module.exports = {
|
||||
// Common options
|
||||
publish: {
|
||||
@@ -17,12 +12,9 @@ module.exports = {
|
||||
},
|
||||
directories: {
|
||||
output: electronBundled,
|
||||
buildResources: resolvePathFromProjectRoot('src/presentation/electron/build'),
|
||||
},
|
||||
extraMetadata: {
|
||||
main: findMainEntryFile(
|
||||
join(electronUnbundled, 'main'), // do not `path.resolve`, it expects a relative path
|
||||
),
|
||||
main: join(electronUnbundled, 'main/index.cjs'), // do not `path.resolve`, it expects a relative path
|
||||
},
|
||||
|
||||
// Windows
|
||||
@@ -49,23 +41,3 @@ module.exports = {
|
||||
artifactName: '${name}-${version}.${ext}',
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* Finds by accommodating different JS file extensions and module formats.
|
||||
*/
|
||||
function findMainEntryFile(parentDirectory) {
|
||||
const absoluteParentDirectory = resolvePathFromProjectRoot(parentDirectory);
|
||||
if (!existsSync(absoluteParentDirectory)) {
|
||||
return null; // Avoid disrupting other processes such `npm install`.
|
||||
}
|
||||
const files = readdirSync(absoluteParentDirectory);
|
||||
const entryFile = files.find((file) => /^index\.(cjs|mjs|js)$/.test(file));
|
||||
if (!entryFile) {
|
||||
throw new Error(`Main entry file not found in ${absoluteParentDirectory}.`);
|
||||
}
|
||||
return join(parentDirectory, entryFile);
|
||||
}
|
||||
|
||||
function resolvePathFromProjectRoot(pathSegment) {
|
||||
return resolve(__dirname, pathSegment);
|
||||
}
|
||||
|
||||
@@ -14,7 +14,7 @@ const ELECTRON_DIST_SUBDIRECTORIES = {
|
||||
renderer: resolveElectronDistSubdirectory('renderer'),
|
||||
};
|
||||
|
||||
process.env.ELECTRON_ENTRY = resolve(ELECTRON_DIST_SUBDIRECTORIES.main, 'index.mjs');
|
||||
process.env.ELECTRON_ENTRY = resolve(ELECTRON_DIST_SUBDIRECTORIES.main, 'index.cjs');
|
||||
|
||||
export default defineConfig({
|
||||
main: getSharedElectronConfig({
|
||||
@@ -54,23 +54,13 @@ function getSharedElectronConfig(options: {
|
||||
},
|
||||
rollupOptions: {
|
||||
output: {
|
||||
format: 'es',
|
||||
|
||||
// Ensure all generated files use '.mjs' for module consistency.
|
||||
// Otherwise, preloader process get `.mjs` extension but main process get `.js` extension, see https://github.com/alex8088/electron-vite/issues/397.
|
||||
entryFileNames: '[name].mjs',
|
||||
// Mark: electron-esm-support
|
||||
// This is needed so `type="module"` works
|
||||
entryFileNames: '[name].cjs',
|
||||
},
|
||||
},
|
||||
},
|
||||
plugins: [externalizeDepsPlugin({
|
||||
exclude: [
|
||||
// Keep 'electron-log' in bundling process.
|
||||
// This is a workaround for inability of Electron's ESM loader to resolve subpath imports.
|
||||
// Do not externalize `electron-log` so subpath imports such as `electron-log/main` works.
|
||||
// See https://github.com/electron/electron/issues/41241, https://github.com/alex8088/electron-vite/issues/401
|
||||
'electron-log',
|
||||
],
|
||||
})],
|
||||
plugins: [externalizeDepsPlugin()],
|
||||
define: {
|
||||
...getClientEnvironmentVariables(),
|
||||
},
|
||||
|
||||
11854
package-lock.json
generated
11854
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
82
package.json
82
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "privacy.sexy",
|
||||
"version": "0.13.2",
|
||||
"version": "0.13.0",
|
||||
"private": true,
|
||||
"slogan": "Privacy is sexy",
|
||||
"description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy.",
|
||||
@@ -14,7 +14,7 @@
|
||||
"test:integration": "vitest run --dir tests/integration",
|
||||
"test:cy:run": "start-server-and-test \"vite build && vite preview --port 7070\" http://localhost:7070 \"cypress run --config baseUrl=http://localhost:7070\"",
|
||||
"test:cy:open": "start-server-and-test \"vite --port 7070 --mode production\" http://localhost:7070 \"cypress open --config baseUrl=http://localhost:7070\"",
|
||||
"lint": "npm run lint:md && npm run lint:md:consistency && npm run lint:md:relative-urls && npm run lint:eslint && npm run lint:yaml && npm run lint:pylint",
|
||||
"lint": "npm run lint:md && npm run lint:md:consistency && npm run lint:md:relative-urls && npm run lint:eslint && npm run lint:yaml",
|
||||
"install-deps": "node scripts/npm-install.js",
|
||||
"icons:build": "node scripts/logo-update.js",
|
||||
"check:desktop": "vitest run --dir tests/checks/desktop-runtime-errors --environment node",
|
||||
@@ -29,68 +29,66 @@
|
||||
"lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent",
|
||||
"lint:md:relative-urls": "remark . --frail --use remark-validate-links",
|
||||
"lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
|
||||
"lint:pylint": "pylint **/*.py",
|
||||
"postinstall": "electron-builder install-app-deps",
|
||||
"postuninstall": "electron-builder install-app-deps"
|
||||
},
|
||||
"dependencies": {
|
||||
"@floating-ui/vue": "^1.0.6",
|
||||
"@floating-ui/vue": "^1.0.2",
|
||||
"@juggle/resize-observer": "^3.4.0",
|
||||
"ace-builds": "^1.33.0",
|
||||
"electron-log": "^5.1.2",
|
||||
"electron-progressbar": "^2.2.1",
|
||||
"electron-updater": "^6.1.9",
|
||||
"@types/markdown-it": "^13.0.7",
|
||||
"ace-builds": "^1.30.0",
|
||||
"electron-log": "^5.0.1",
|
||||
"electron-progressbar": "^2.1.0",
|
||||
"electron-updater": "^6.1.4",
|
||||
"file-saver": "^2.0.5",
|
||||
"markdown-it": "^14.1.0",
|
||||
"vue": "^3.4.21"
|
||||
"markdown-it": "^13.0.2",
|
||||
"vue": "^3.3.7"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@modyfi/vite-plugin-yaml": "^1.1.0",
|
||||
"@rushstack/eslint-patch": "^1.10.2",
|
||||
"@types/ace": "^0.0.52",
|
||||
"@types/file-saver": "^2.0.7",
|
||||
"@types/markdown-it": "^14.0.1",
|
||||
"@typescript-eslint/eslint-plugin": "6.21.0",
|
||||
"@typescript-eslint/parser": "6.21.0",
|
||||
"@rushstack/eslint-patch": "^1.6.1",
|
||||
"@types/ace": "^0.0.49",
|
||||
"@types/file-saver": "^2.0.5",
|
||||
"@typescript-eslint/eslint-plugin": "^6.17.0",
|
||||
"@typescript-eslint/parser": "^6.17.0",
|
||||
"@vitejs/plugin-legacy": "^5.3.2",
|
||||
"@vitejs/plugin-vue": "^5.0.4",
|
||||
"@vue/eslint-config-airbnb-with-typescript": "^8.0.0",
|
||||
"@vue/eslint-config-typescript": "12.0.0",
|
||||
"@vue/test-utils": "^2.4.5",
|
||||
"autoprefixer": "^10.4.19",
|
||||
"cypress": "^13.7.3",
|
||||
"electron": "^29.3.0",
|
||||
"electron-builder": "^24.13.3",
|
||||
"@vue/eslint-config-typescript": "^12.0.0",
|
||||
"@vue/test-utils": "^2.4.1",
|
||||
"autoprefixer": "^10.4.16",
|
||||
"cypress": "^13.3.1",
|
||||
"electron": "^27.0.0",
|
||||
"electron-builder": "^24.6.4",
|
||||
"electron-devtools-installer": "^3.2.0",
|
||||
"electron-icon-builder": "^2.0.1",
|
||||
"electron-vite": "^2.1.0",
|
||||
"eslint": "8.57.0",
|
||||
"eslint": "^8.56.0",
|
||||
"eslint-plugin-cypress": "^2.15.1",
|
||||
"eslint-plugin-vue": "^9.25.0",
|
||||
"eslint-plugin-vuejs-accessibility": "^2.2.1",
|
||||
"jsdom": "^24.0.0",
|
||||
"markdownlint-cli": "^0.39.0",
|
||||
"postcss": "^8.4.38",
|
||||
"eslint-plugin-vue": "^9.19.2",
|
||||
"eslint-plugin-vuejs-accessibility": "^2.2.0",
|
||||
"icon-gen": "^4.0.0",
|
||||
"jsdom": "^22.1.0",
|
||||
"markdownlint-cli": "^0.37.0",
|
||||
"postcss": "^8.4.31",
|
||||
"remark-cli": "^12.0.0",
|
||||
"remark-lint-no-dead-urls": "^1.1.0",
|
||||
"remark-preset-lint-consistent": "^6.0.0",
|
||||
"remark-validate-links": "^13.0.1",
|
||||
"sass": "^1.75.0",
|
||||
"start-server-and-test": "^2.0.3",
|
||||
"terser": "^5.30.3",
|
||||
"remark-preset-lint-consistent": "^5.1.2",
|
||||
"remark-validate-links": "^13.0.0",
|
||||
"sass": "^1.69.3",
|
||||
"start-server-and-test": "^2.0.1",
|
||||
"svgexport": "^0.4.2",
|
||||
"terser": "^5.21.0",
|
||||
"tslib": "^2.6.2",
|
||||
"typescript": "^5.4.5",
|
||||
"vite": "^5.2.8",
|
||||
"vitest": "^1.5.0",
|
||||
"vue-tsc": "^2.0.13",
|
||||
"typescript": "^5.3.3",
|
||||
"vite": "^5.1.6",
|
||||
"vitest": "^1.3.1",
|
||||
"vue-tsc": "^1.8.19",
|
||||
"yaml-lint": "^1.7.0"
|
||||
},
|
||||
"//devDependencies": {
|
||||
"terser": "Used by `@vitejs/plugin-legacy` for minification",
|
||||
"@rushstack/eslint-patch": "Needed by `@vue/eslint-config-typescript` and `@vue/eslint-config-airbnb-with-typescript`",
|
||||
"@typescript-eslint/eslint-plugin": "Cannot migrate to v7 because of `@vue/eslint-config-airbnb-with-typescript`, see https://github.com/vuejs/eslint-config-airbnb/issues/63",
|
||||
"@typescript-eslint/parser": "Cannot migrate to v7 because of `@vue/eslint-config-airbnb-with-typescript`, see https://github.com/vuejs/eslint-config-airbnb/issues/63",
|
||||
"@vue/eslint-config-typescript": "Cannot migrate to v13 because of `@vue/eslint-config-airbnb-with-typescript`, see https://github.com/vuejs/eslint-config-airbnb/issues/63",
|
||||
"eslint": "Cannot migrate to v9 `@typescript-eslint/eslint-plugin` (≤ v7), `@typescript-eslint/parser` (≤ v7), `@vue/eslint-config-airbnb-with-typescript@` (≤ v8) requires `eslint` ≤ v8, see https://github.com/vuejs/eslint-config-airbnb/issues/65, https://github.com/typescript-eslint/typescript-eslint/issues/8211"
|
||||
"@rushstack/eslint-patch": "Needed by `@vue/eslint-config-typescript` and `@vue/eslint-config-airbnb-with-typescript`"
|
||||
},
|
||||
"homepage": "https://privacy.sexy",
|
||||
"repository": {
|
||||
|
||||
@@ -1,10 +1,6 @@
|
||||
"""
|
||||
Description:
|
||||
This script configures project-level VSCode settings in '.vscode/settings.json' for
|
||||
development and installs recommended extensions from '.vscode/extensions.json'.
|
||||
|
||||
Usage:
|
||||
python3 ./scripts/configure_vscode.py
|
||||
This script configures project-level VSCode settings in '.vscode/settings.json' for
|
||||
development and installs recommended extensions from '.vscode/extensions.json'.
|
||||
"""
|
||||
# pylint: disable=missing-function-docstring
|
||||
|
||||
@@ -44,7 +40,7 @@ def ensure_setting_file_exists() -> None:
|
||||
print_success(f"Created empty {VSCODE_SETTINGS_JSON_FILE}")
|
||||
except IOError as error:
|
||||
print_error(f"Error creating file {VSCODE_SETTINGS_JSON_FILE}: {error}")
|
||||
print_success(f"Created empty {VSCODE_SETTINGS_JSON_FILE}")
|
||||
print(f"📄 Created empty {VSCODE_SETTINGS_JSON_FILE}")
|
||||
|
||||
def add_or_update_settings() -> None:
|
||||
configure_setting_key('eslint.validate', ['vue', 'javascript', 'typescript'])
|
||||
@@ -102,8 +98,7 @@ def locate_vscode_cli() -> Optional[str]:
|
||||
if vscode_alias:
|
||||
return vscode_alias
|
||||
potential_vscode_cli_paths = [
|
||||
# VS Code on macOS may not register 'code' command in PATH
|
||||
'/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code'
|
||||
'/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code' # macOS VS Code may not register 'code' command in PATH
|
||||
]
|
||||
for vscode_cli_candidate_path in potential_vscode_cli_paths:
|
||||
if Path(vscode_cli_candidate_path).is_file():
|
||||
@@ -114,7 +109,7 @@ def remove_json_comments(json_like: str) -> str:
|
||||
pattern: str = r'(?:"(?:\\.|[^"\\])*"|/\*[\s\S]*?\*/|//.*)|([^:]//.*$)'
|
||||
return re.sub(
|
||||
pattern,
|
||||
lambda m: '' if m.group(1) else m.group(0), json_like, flags=re.MULTILINE,
|
||||
lambda m: '' if m.group(1) else m.agroup(0), json_like, flags=re.MULTILINE,
|
||||
)
|
||||
|
||||
def install_vscode_extensions(vscode_cli_path: str, extensions: list[str]) -> None:
|
||||
@@ -171,16 +166,16 @@ def print_installation_results(successful_installations: int, total_extensions:
|
||||
print_error("Failed to install any of the recommended extensions.")
|
||||
|
||||
def print_error(message: str) -> None:
|
||||
print(f"[ERROR] {message}", file=sys.stderr)
|
||||
print(f"💀 Error: {message}", file=sys.stderr)
|
||||
|
||||
def print_success(message: str) -> None:
|
||||
print(f"[SUCCESS] {message}")
|
||||
print(f"✅ Success: {message}")
|
||||
|
||||
def print_skip(message: str) -> None:
|
||||
print(f"[SKIPPED] {message}")
|
||||
print(f"⏩ Skipped: {message}")
|
||||
|
||||
def print_warning(message: str) -> None:
|
||||
print(f"[WARNING] {message}", file=sys.stderr)
|
||||
print(f"⚠️ Warning: {message}", file=sys.stderr)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
@@ -1,120 +1,84 @@
|
||||
/**
|
||||
* Description:
|
||||
* This script updates the logo images across the project based on the primary
|
||||
* logo file ('img/logo.svg' file).
|
||||
*
|
||||
* It handles the creation and update of various icon sizes for different purposes,
|
||||
* including desktop launcher icons, tray icons, and web favicons from a single source
|
||||
* SVG logo file.
|
||||
*
|
||||
* Usage:
|
||||
* node ./scripts/logo-update.js
|
||||
*
|
||||
* Notes:
|
||||
* ImageMagick must be installed and accessible in the system's PATH
|
||||
*/
|
||||
|
||||
import { resolve, join, dirname } from 'node:path';
|
||||
import { stat } from 'node:fs/promises';
|
||||
#!/usr/bin/env bash
|
||||
import { resolve, join } from 'node:path';
|
||||
import { rm, mkdtemp, stat } from 'node:fs/promises';
|
||||
import { spawn } from 'node:child_process';
|
||||
import { URL, fileURLToPath } from 'node:url';
|
||||
import electronBuilderConfig from '../electron-builder.cjs';
|
||||
|
||||
class ImageAssetPaths {
|
||||
constructor(currentScriptDirectory) {
|
||||
const projectRoot = resolve(currentScriptDirectory, '../');
|
||||
class Paths {
|
||||
constructor(selfDirectory) {
|
||||
const projectRoot = resolve(selfDirectory, '../');
|
||||
this.sourceImage = join(projectRoot, 'img/logo.svg');
|
||||
this.publicDirectory = join(projectRoot, 'src/presentation/public');
|
||||
this.electronBuildResourcesDirectory = electronBuilderConfig.directories.buildResources;
|
||||
}
|
||||
|
||||
get electronTrayIconFile() {
|
||||
return join(this.publicDirectory, 'icon.png');
|
||||
}
|
||||
|
||||
get webFaviconFile() {
|
||||
return join(this.publicDirectory, 'favicon.ico');
|
||||
this.electronBuildDirectory = join(projectRoot, 'build');
|
||||
}
|
||||
|
||||
toString() {
|
||||
return `Source image: ${this.sourceImage}`
|
||||
+ `\nPublic directory: ${this.publicDirectory}`
|
||||
+ `\n\t Electron tray icon file: ${this.electronTrayIconFile}`
|
||||
+ `\n\t Web favicon file: ${this.webFaviconFile}`
|
||||
+ `\nElectron build directory: ${this.electronBuildResourcesDirectory}`;
|
||||
return `Source image: ${this.sourceImage}\n`
|
||||
+ `Public directory: ${this.publicDirectory}\n`
|
||||
+ `Electron build directory: ${this.electronBuildDirectory}`;
|
||||
}
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const paths = new ImageAssetPaths(getCurrentScriptDirectory());
|
||||
const paths = new Paths(getCurrentScriptDirectory());
|
||||
console.log(`Paths:\n\t${paths.toString().replaceAll('\n', '\n\t')}`);
|
||||
const convertCommand = await findAvailableImageMagickCommand();
|
||||
await generateDesktopAndTrayIcons(
|
||||
paths.sourceImage,
|
||||
paths.electronTrayIconFile,
|
||||
convertCommand,
|
||||
);
|
||||
await generateWebFavicon(
|
||||
paths.sourceImage,
|
||||
paths.webFaviconFile,
|
||||
convertCommand,
|
||||
);
|
||||
await generateDesktopIcons(
|
||||
paths.sourceImage,
|
||||
paths.electronBuildResourcesDirectory,
|
||||
convertCommand,
|
||||
);
|
||||
await updateDesktopLauncherAndTrayIcon(paths.sourceImage, paths.publicDirectory);
|
||||
await updateWebFavicon(paths.sourceImage, paths.publicDirectory);
|
||||
await updateDesktopIcons(paths.sourceImage, paths.electronBuildDirectory);
|
||||
console.log('🎉 (Re)created icons successfully.');
|
||||
}
|
||||
|
||||
async function generateDesktopAndTrayIcons(sourceImage, targetFile, convertCommand) {
|
||||
// Reference: https://web.archive.org/web/20240502124306/https://www.electronjs.org/docs/latest/api/tray
|
||||
console.log(`Updating desktop launcher and tray icon at ${targetFile}.`);
|
||||
async function updateDesktopLauncherAndTrayIcon(sourceImage, publicFolder) {
|
||||
await ensureFileExists(sourceImage);
|
||||
await ensureParentFolderExists(targetFile);
|
||||
await convertFromSvgToPng(
|
||||
convertCommand,
|
||||
await ensureFolderExists(publicFolder);
|
||||
const electronTrayIconFile = join(publicFolder, 'icon.png');
|
||||
console.log(`Updating desktop launcher and tray icon at ${electronTrayIconFile}.`);
|
||||
await runCommand(
|
||||
'npx',
|
||||
'svgexport',
|
||||
sourceImage,
|
||||
targetFile,
|
||||
'512x512',
|
||||
electronTrayIconFile,
|
||||
);
|
||||
}
|
||||
|
||||
async function generateWebFavicon(sourceImage, faviconFilePath, convertCommand) {
|
||||
console.log(`Updating favicon at ${faviconFilePath}.`);
|
||||
async function updateWebFavicon(sourceImage, faviconFolder) {
|
||||
console.log('Updating favicon');
|
||||
await ensureFileExists(sourceImage);
|
||||
await ensureParentFolderExists(faviconFilePath);
|
||||
await convertFromSvgToIco(
|
||||
convertCommand,
|
||||
sourceImage,
|
||||
faviconFilePath,
|
||||
[16, 24, 32, 48, 64, 128, 256],
|
||||
await ensureFolderExists(faviconFolder);
|
||||
await runCommand(
|
||||
'npx',
|
||||
'icon-gen',
|
||||
`--input ${sourceImage}`,
|
||||
`--output ${faviconFolder}`,
|
||||
'--ico',
|
||||
'--ico-name \'favicon\'',
|
||||
'--report',
|
||||
);
|
||||
}
|
||||
|
||||
async function generateDesktopIcons(sourceImage, electronBuildResourcesDirectory, convertCommand) {
|
||||
console.log(`Creating Electron icon files to ${electronBuildResourcesDirectory}.`);
|
||||
// Reference: https://web.archive.org/web/20240501103645/https://www.electron.build/icons.html
|
||||
await ensureFolderExists(electronBuildResourcesDirectory);
|
||||
async function updateDesktopIcons(sourceImage, electronIconsDir) {
|
||||
await ensureFileExists(sourceImage);
|
||||
const electronMainIconFile = join(electronBuildResourcesDirectory, 'icon.png');
|
||||
await convertFromSvgToPng(
|
||||
convertCommand,
|
||||
await ensureFolderExists(electronIconsDir);
|
||||
const temporaryDir = await mkdtemp('icon-');
|
||||
const temporaryPngFile = join(temporaryDir, 'icon.png');
|
||||
console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by `icon-builder`
|
||||
await runCommand(
|
||||
'npx',
|
||||
'svgexport',
|
||||
sourceImage,
|
||||
electronMainIconFile,
|
||||
'1024x1024', // Should be at least 512x512
|
||||
temporaryPngFile,
|
||||
'1024:1024',
|
||||
);
|
||||
// Relying on `electron-builder`s conversion from png to ico results in pixelated look on Windows
|
||||
// 10 and 11 according to tests, see:
|
||||
// - https://web.archive.org/web/20240502114650/https://github.com/electron-userland/electron-builder/issues/7328
|
||||
// - https://web.archive.org/web/20240502115448/https://github.com/electron-userland/electron-builder/issues/3867
|
||||
const electronWindowsIconFile = join(electronBuildResourcesDirectory, 'icon.ico');
|
||||
await convertFromSvgToIco(
|
||||
convertCommand,
|
||||
sourceImage,
|
||||
electronWindowsIconFile,
|
||||
[16, 24, 32, 48, 64, 128, 256],
|
||||
console.log(`Creating electron icons to ${electronIconsDir}.`);
|
||||
await runCommand(
|
||||
'npx',
|
||||
'electron-icon-builder',
|
||||
`--input="${temporaryPngFile}"`,
|
||||
`--output="${electronIconsDir}"`,
|
||||
'--flatten',
|
||||
);
|
||||
console.log('Cleaning up temporary directory.');
|
||||
await rm(temporaryDir, { recursive: true, force: true });
|
||||
}
|
||||
|
||||
async function ensureFileExists(filePath) {
|
||||
@@ -125,60 +89,12 @@ async function ensureFileExists(filePath) {
|
||||
}
|
||||
|
||||
async function ensureFolderExists(folderPath) {
|
||||
if (!folderPath) {
|
||||
throw new Error('Path is missing');
|
||||
}
|
||||
const path = await stat(folderPath);
|
||||
if (!path.isDirectory()) {
|
||||
throw new Error(`Not a directory: ${folderPath}`);
|
||||
}
|
||||
}
|
||||
|
||||
function ensureParentFolderExists(filePath) {
|
||||
return ensureFolderExists(dirname(filePath));
|
||||
}
|
||||
|
||||
const BaseImageMagickConvertArguments = Object.freeze([
|
||||
'-background none', // Transparent, so they do not get filled with white.
|
||||
'-strip', // Strip metadata.
|
||||
'-gravity Center', // Center the image when there's empty space
|
||||
]);
|
||||
|
||||
async function convertFromSvgToIco(
|
||||
convertCommand,
|
||||
inputFile,
|
||||
outputFile,
|
||||
sizes,
|
||||
) {
|
||||
await runCommand(
|
||||
convertCommand,
|
||||
...BaseImageMagickConvertArguments,
|
||||
`-density ${Math.max(...sizes).toString()}`, // High enough for sharpness
|
||||
`-define icon:auto-resize=${sizes.map((s) => s.toString()).join(',')}`, // Automatically store multiple sizes in an ico image
|
||||
'-compress None',
|
||||
inputFile,
|
||||
outputFile,
|
||||
);
|
||||
}
|
||||
|
||||
async function convertFromSvgToPng(
|
||||
convertCommand,
|
||||
inputFile,
|
||||
outputFile,
|
||||
size = undefined,
|
||||
) {
|
||||
await runCommand(
|
||||
convertCommand,
|
||||
...BaseImageMagickConvertArguments,
|
||||
...(size === undefined ? [] : [
|
||||
`-resize ${size}`,
|
||||
`-density ${size}`, // High enough for sharpness
|
||||
]),
|
||||
inputFile,
|
||||
outputFile,
|
||||
);
|
||||
}
|
||||
|
||||
async function runCommand(...args) {
|
||||
const command = args.join(' ');
|
||||
console.log(`Running command: ${command}`);
|
||||
@@ -208,27 +124,4 @@ function getCurrentScriptDirectory() {
|
||||
return fileURLToPath(new URL('.', import.meta.url));
|
||||
}
|
||||
|
||||
async function findAvailableImageMagickCommand() {
|
||||
// Reference: https://web.archive.org/web/20240502120041/https://imagemagick.org/script/convert.php
|
||||
const potentialBaseCommands = [
|
||||
'convert', // Legacy command, usually available on Linux/macOS installations
|
||||
'magick convert', // Newer command, available on Windows installations
|
||||
];
|
||||
for (const baseCommand of potentialBaseCommands) {
|
||||
const testCommand = `${baseCommand} -version`;
|
||||
try {
|
||||
await runCommand(testCommand); // eslint-disable-line no-await-in-loop
|
||||
console.log(`Confirmed: ImageMagick command '${baseCommand}' is available and operational.`);
|
||||
return baseCommand;
|
||||
} catch (err) {
|
||||
console.log(`Error: The command '${baseCommand}' is not found or failed to execute. Detailed error: ${err.message}"`);
|
||||
}
|
||||
}
|
||||
throw new Error([
|
||||
'Unable to locate any operational ImageMagick command.',
|
||||
`Attempted commands were: ${potentialBaseCommands.join(', ')}.`,
|
||||
'Please ensure ImageMagick is correctly installed and accessible.',
|
||||
].join('\n'));
|
||||
}
|
||||
|
||||
await main();
|
||||
|
||||
@@ -44,8 +44,8 @@ function getBuildVerificationConfigs() {
|
||||
'--electron-unbundled': {
|
||||
printDistDirScriptArgument: '--electron-unbundled',
|
||||
filePatterns: [
|
||||
/main[/\\]index\.(cjs|mjs|js)/,
|
||||
/preload[/\\]index\.(cjs|mjs|js)/,
|
||||
/main[/\\]index\.cjs/,
|
||||
/preload[/\\]index\.cjs/,
|
||||
/renderer[/\\]index\.htm(l)?/,
|
||||
],
|
||||
},
|
||||
|
||||
@@ -1,87 +1,62 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Description:
|
||||
* This script checks if a server, provided as a CLI argument, is up
|
||||
* and returns an HTTP 200 status code.
|
||||
* It is designed to provide easy verification of server availability
|
||||
* and will retry a specified number of times.
|
||||
* This script checks if a server, provided as a CLI argument, is up
|
||||
* and returns an HTTP 200 status code.
|
||||
* It is designed to provide easy verification of server availability
|
||||
* and will retry a specified number of times.
|
||||
*
|
||||
* Usage:
|
||||
* node ./scripts/verify-web-server-status.js --url [URL] [--max-retries NUMBER]
|
||||
* node ./scripts/verify-web-server-status.js --url [URL]
|
||||
*
|
||||
* Options:
|
||||
* --url URL of the server to check
|
||||
* --max-retries Maximum number of retry attempts (default: 30)
|
||||
* --url URL of the server to check
|
||||
*/
|
||||
|
||||
const DEFAULT_MAX_RETRIES = 30;
|
||||
const RETRY_DELAY_IN_SECONDS = 3;
|
||||
const PARAMETER_NAME_URL = '--url';
|
||||
const PARAMETER_NAME_MAX_RETRIES = '--max-retries';
|
||||
import { get } from 'http';
|
||||
|
||||
async function checkServer(currentRetryCount = 1) {
|
||||
const serverUrl = readRequiredParameterValue(PARAMETER_NAME_URL);
|
||||
const maxRetries = parseNumber(
|
||||
readOptionalParameterValue(PARAMETER_NAME_MAX_RETRIES, DEFAULT_MAX_RETRIES),
|
||||
);
|
||||
console.log(`🌐 Requesting ${serverUrl}...`);
|
||||
try {
|
||||
const response = await fetch(serverUrl);
|
||||
if (response.status === 200) {
|
||||
const MAX_RETRIES = 30;
|
||||
const RETRY_DELAY_IN_SECONDS = 3;
|
||||
const URL_PARAMETER_NAME = '--url';
|
||||
|
||||
function checkServer(currentRetryCount = 1) {
|
||||
const serverUrl = getServerUrl();
|
||||
console.log(`Requesting ${serverUrl}...`);
|
||||
get(serverUrl, (res) => {
|
||||
if (res.statusCode === 200) {
|
||||
console.log('🎊 Success: The server is up and returned HTTP 200.');
|
||||
process.exit(0);
|
||||
} else {
|
||||
exitWithError(`Server returned unexpected HTTP status code ${response.statusCode}.`);
|
||||
console.log(`Server returned HTTP status code ${res.statusCode}.`);
|
||||
retry(currentRetryCount);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Error making the request:', error);
|
||||
scheduleNextRetry(maxRetries, currentRetryCount);
|
||||
}
|
||||
}).on('error', (err) => {
|
||||
console.error('Error making the request:', err);
|
||||
retry(currentRetryCount);
|
||||
});
|
||||
}
|
||||
|
||||
function scheduleNextRetry(maxRetries, currentRetryCount) {
|
||||
console.log(`Attempt ${currentRetryCount}/${maxRetries}:`);
|
||||
function retry(currentRetryCount) {
|
||||
console.log(`Attempt ${currentRetryCount}/${MAX_RETRIES}:`);
|
||||
console.log(`Retrying in ${RETRY_DELAY_IN_SECONDS} seconds.`);
|
||||
|
||||
const remainingTime = (maxRetries - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
|
||||
const remainingTime = (MAX_RETRIES - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
|
||||
console.log(`Time remaining before timeout: ${remainingTime}s`);
|
||||
|
||||
if (currentRetryCount < maxRetries) {
|
||||
if (currentRetryCount < MAX_RETRIES) {
|
||||
setTimeout(() => checkServer(currentRetryCount + 1), RETRY_DELAY_IN_SECONDS * 1000);
|
||||
} else {
|
||||
exitWithError('The server at did not return HTTP 200 within the allocated time.');
|
||||
console.log('Failure: The server at did not return HTTP 200 within the allocated time. Exiting.');
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
function readRequiredParameterValue(parameterName) {
|
||||
const parameterValue = readOptionalParameterValue(parameterName);
|
||||
if (parameterValue === undefined) {
|
||||
exitWithError(`Parameter "${parameterName}" is required but not provided.`);
|
||||
function getServerUrl() {
|
||||
const urlIndex = process.argv.indexOf(URL_PARAMETER_NAME);
|
||||
if (urlIndex === -1 || urlIndex === process.argv.length - 1) {
|
||||
console.error(`Parameter "${URL_PARAMETER_NAME}" is not provided.`);
|
||||
process.exit(1);
|
||||
}
|
||||
return parameterValue;
|
||||
return process.argv[urlIndex + 1];
|
||||
}
|
||||
|
||||
function readOptionalParameterValue(parameterName, defaultValue) {
|
||||
const index = process.argv.indexOf(parameterName);
|
||||
if (index === -1 || index === process.argv.length - 1) {
|
||||
return defaultValue;
|
||||
}
|
||||
return process.argv[index + 1];
|
||||
}
|
||||
|
||||
function parseNumber(numberLike) {
|
||||
const number = parseInt(numberLike, 10);
|
||||
if (Number.isNaN(number)) {
|
||||
exitWithError(`Invalid number: ${numberLike}`);
|
||||
}
|
||||
return number;
|
||||
}
|
||||
|
||||
function exitWithError(message) {
|
||||
console.error(`Failure: ${message}`);
|
||||
console.log('Exiting');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
await checkServer();
|
||||
checkServer();
|
||||
|
||||
@@ -11,11 +11,10 @@ export type CodeRunErrorType =
|
||||
| 'FileWriteError'
|
||||
| 'FileReadbackVerificationError'
|
||||
| 'FilePathGenerationError'
|
||||
| 'UnsupportedPlatform'
|
||||
| 'DirectoryCreationError'
|
||||
| 'FilePermissionChangeError'
|
||||
| 'UnsupportedOperatingSystem'
|
||||
| 'FileExecutionError'
|
||||
| 'ExternalProcessTermination';
|
||||
| 'DirectoryCreationError'
|
||||
| 'UnexpectedError';
|
||||
|
||||
interface CodeRunStatus {
|
||||
readonly success: boolean;
|
||||
|
||||
@@ -1,156 +1,44 @@
|
||||
/* eslint-disable max-classes-per-file */
|
||||
import { PlatformTimer } from './PlatformTimer';
|
||||
import type { Timer, TimeoutType } from './Timer';
|
||||
|
||||
export type CallbackType = (..._: readonly unknown[]) => void;
|
||||
|
||||
export interface ThrottleOptions {
|
||||
/** Skip the immediate execution of the callback on the first invoke */
|
||||
readonly excludeLeadingCall: boolean;
|
||||
readonly timer: Timer;
|
||||
}
|
||||
|
||||
const DefaultOptions: ThrottleOptions = {
|
||||
excludeLeadingCall: false,
|
||||
timer: PlatformTimer,
|
||||
};
|
||||
|
||||
export function throttle(
|
||||
callback: CallbackType,
|
||||
waitInMs: number,
|
||||
options: Partial<ThrottleOptions> = DefaultOptions,
|
||||
timer: Timer = PlatformTimer,
|
||||
): CallbackType {
|
||||
const defaultedOptions: ThrottleOptions = {
|
||||
...DefaultOptions,
|
||||
...options,
|
||||
};
|
||||
const throttler = new Throttler(waitInMs, callback, defaultedOptions);
|
||||
const throttler = new Throttler(timer, waitInMs, callback);
|
||||
return (...args: unknown[]) => throttler.invoke(...args);
|
||||
}
|
||||
|
||||
class Throttler {
|
||||
private lastExecutionTime: number | null = null;
|
||||
private queuedExecutionId: TimeoutType | undefined;
|
||||
|
||||
private executionScheduler: DelayedCallbackScheduler;
|
||||
|
||||
constructor(
|
||||
private readonly waitInMs: number,
|
||||
private readonly callback: CallbackType,
|
||||
private readonly options: ThrottleOptions,
|
||||
) {
|
||||
if (!waitInMs) { throw new Error('missing delay'); }
|
||||
if (waitInMs < 0) { throw new Error('negative delay'); }
|
||||
this.executionScheduler = new DelayedCallbackScheduler(options.timer);
|
||||
}
|
||||
|
||||
public invoke(...args: unknown[]): void {
|
||||
switch (true) {
|
||||
case this.isLeadingCallWithinThrottlePeriod(): {
|
||||
if (this.options.excludeLeadingCall) {
|
||||
this.scheduleNext(args);
|
||||
return;
|
||||
}
|
||||
this.executeNow(args);
|
||||
return;
|
||||
}
|
||||
case this.isAlreadyScheduled(): {
|
||||
this.updateNextScheduled(args);
|
||||
return;
|
||||
}
|
||||
case !this.isThrottlePeriodPassed(): {
|
||||
this.scheduleNext(args);
|
||||
return;
|
||||
}
|
||||
default:
|
||||
throw new Error('Throttle logical error: no conditions for execution or scheduling were met.');
|
||||
}
|
||||
}
|
||||
|
||||
private isLeadingCallWithinThrottlePeriod(): boolean {
|
||||
return this.isThrottlePeriodPassed()
|
||||
&& !this.isAlreadyScheduled();
|
||||
}
|
||||
|
||||
private isThrottlePeriodPassed(): boolean {
|
||||
if (this.lastExecutionTime === null) {
|
||||
return true;
|
||||
}
|
||||
const timeSinceLastExecution = this.options.timer.dateNow() - this.lastExecutionTime;
|
||||
const isThrottleTimePassed = timeSinceLastExecution >= this.waitInMs;
|
||||
return isThrottleTimePassed;
|
||||
}
|
||||
|
||||
private isAlreadyScheduled(): boolean {
|
||||
return this.executionScheduler.getNext() !== null;
|
||||
}
|
||||
|
||||
private scheduleNext(args: unknown[]): void {
|
||||
if (this.executionScheduler.getNext()) {
|
||||
throw new Error('An execution is already scheduled.');
|
||||
}
|
||||
this.executionScheduler.resetNext(
|
||||
() => this.executeNow(args),
|
||||
this.waitInMs,
|
||||
);
|
||||
}
|
||||
|
||||
private updateNextScheduled(args: unknown[]): void {
|
||||
const nextScheduled = this.executionScheduler.getNext();
|
||||
if (!nextScheduled) {
|
||||
throw new Error('A non-existent scheduled execution cannot be updated.');
|
||||
}
|
||||
const nextDelay = nextScheduled.scheduledTime - this.dateNow();
|
||||
this.executionScheduler.resetNext(
|
||||
() => this.executeNow(args),
|
||||
nextDelay,
|
||||
);
|
||||
}
|
||||
|
||||
private executeNow(args: unknown[]): void {
|
||||
this.callback(...args);
|
||||
this.lastExecutionTime = this.dateNow();
|
||||
}
|
||||
|
||||
private dateNow(): number {
|
||||
return this.options.timer.dateNow();
|
||||
}
|
||||
}
|
||||
|
||||
interface ScheduledCallback {
|
||||
readonly scheduleTimeoutId: TimeoutType;
|
||||
readonly scheduledTime: number;
|
||||
}
|
||||
|
||||
class DelayedCallbackScheduler {
|
||||
private scheduledCallback: ScheduledCallback | null = null;
|
||||
private previouslyRun: number;
|
||||
|
||||
constructor(
|
||||
private readonly timer: Timer,
|
||||
) { }
|
||||
|
||||
public getNext(): ScheduledCallback | null {
|
||||
return this.scheduledCallback;
|
||||
}
|
||||
|
||||
public resetNext(
|
||||
callback: () => void,
|
||||
delayInMs: number,
|
||||
private readonly waitInMs: number,
|
||||
private readonly callback: CallbackType,
|
||||
) {
|
||||
this.clear();
|
||||
this.scheduledCallback = {
|
||||
scheduledTime: this.timer.dateNow() + delayInMs,
|
||||
scheduleTimeoutId: this.timer.setTimeout(() => {
|
||||
this.clear();
|
||||
callback();
|
||||
}, delayInMs),
|
||||
};
|
||||
if (!waitInMs) { throw new Error('missing delay'); }
|
||||
if (waitInMs < 0) { throw new Error('negative delay'); }
|
||||
}
|
||||
|
||||
private clear() {
|
||||
if (this.scheduledCallback === null) {
|
||||
return;
|
||||
public invoke(...args: unknown[]): void {
|
||||
const now = this.timer.dateNow();
|
||||
if (this.queuedExecutionId !== undefined) {
|
||||
this.timer.clearTimeout(this.queuedExecutionId);
|
||||
this.queuedExecutionId = undefined;
|
||||
}
|
||||
if (!this.previouslyRun || (now - this.previouslyRun >= this.waitInMs)) {
|
||||
this.callback(...args);
|
||||
this.previouslyRun = now;
|
||||
} else {
|
||||
const nextCall = () => this.invoke(...args);
|
||||
const nextCallDelayInMs = this.waitInMs - (now - this.previouslyRun);
|
||||
this.queuedExecutionId = this.timer.setTimeout(nextCall, nextCallDelayInMs);
|
||||
}
|
||||
this.timer.clearTimeout(this.scheduledCallback.scheduleTimeoutId);
|
||||
this.scheduledCallback = null;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -95,7 +95,7 @@ function getLines(code: string): string[] {
|
||||
|
||||
/*
|
||||
Merges inline here-strings to a single lined string with Windows line terminator (\r\n)
|
||||
https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_quoting_rules?view=powershell-7.4#here-strings
|
||||
https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_quoting_rules#here-strings
|
||||
*/
|
||||
function mergeHereStrings(code: string) {
|
||||
const regex = /@(['"])\s*(?:\r\n|\r|\n)((.|\n|\r)+?)(\r\n|\r|\n)\1@/g;
|
||||
|
||||
@@ -74,7 +74,7 @@ actions:
|
||||
- [tcsh source code](https://web.archive.org/web/20221029212024/https://github.com/tcsh-org/tcsh).
|
||||
|
||||
[1]: https://web.archive.org/web/20221029134950/https://linux.die.net/man/1/tcsh "tcsh(1) - Linux man page | linux.die.net"
|
||||
[2]: https://web.archive.org/web/20221029135007/https://books.google.com/books?id=LyDP5b2xzaMC&pg=PA56#v=onepage&q&f=false "Sams Teach Yourself FreeBSD in 24 Hours - Michael Urban, Brian Tiemann - Google Books | books.google.com"
|
||||
[2]: https://web.archive.org/web/20221029135041/https://books.google.com/books?id=LyDP5b2xzaMC&pg=PA56 "Sams Teach Yourself FreeBSD in 24 Hours - Michael Urban, Brian Tiemann - Google Books | books.google.com"
|
||||
call:
|
||||
function: DeleteFileFromUserAndRootHome
|
||||
parameters:
|
||||
@@ -184,7 +184,7 @@ actions:
|
||||
> - Logs are valuable for diagnosing issues and understanding past actions [1].
|
||||
> - Script files can help review changes made to the system and aid in reverting those changes if needed.
|
||||
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[2]: https://github.com/undergroundwires/privacy.sexy/blob/master/SECURITY.md "SECURITY.md | privacy.sexy | github.com"
|
||||
children:
|
||||
-
|
||||
@@ -202,7 +202,7 @@ actions:
|
||||
> - This action is irreversible. Deleted script files cannot be retrieved.
|
||||
> - These files might be necessary for troubleshooting if you experience issues after using privacy.sexy scripts.
|
||||
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[2]: https://github.com/undergroundwires/privacy.sexy/blob/master/SECURITY.md "SECURITY.md | privacy.sexy | github.com"
|
||||
call:
|
||||
function: ClearDirectoryContents
|
||||
@@ -223,7 +223,7 @@ actions:
|
||||
> - Removing logs will prevent you from reviewing the application's activities, which could be helpful in diagnosing issues.
|
||||
> - Logs can contain valuable information for technical support should you need assistance.
|
||||
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[2]: https://github.com/undergroundwires/privacy.sexy/blob/master/SECURITY.md "SECURITY.md | privacy.sexy | github.com"
|
||||
call:
|
||||
function: ClearDirectoryContents
|
||||
@@ -1733,7 +1733,7 @@ actions:
|
||||
See also:
|
||||
- [Source code for the Ubuntu Report tool | github.com](https://web.archive.org/web/20221029221854/https://github.com/ubuntu/ubuntu-report/)
|
||||
- [Statistics gathered and visualized | ubuntu.com/desktop/statistics](https://web.archive.org/web/20221029221910/https://ubuntu.com/desktop/statistics)
|
||||
- [ubuntu-devel mailing list thread where ubuntu-report was first proposed | lists.ubuntu.com](https://web.archive.org/web/20221029162523/https://lists.ubuntu.com/archives/ubuntu-devel/2018-February/040139.html)
|
||||
- [ubuntu-devel mailing list thread where ubuntu-report was first proposed, | lists.ubuntu.com ](https://web.archive.org/web/20221029221924/https://lists.ubuntu.com/archives/ubuntu-devel/2018-February/040139.html)
|
||||
|
||||
[1]: https://web.archive.org/web/20221029162505/https://github.com/ubuntu/ubuntu-report/blob/30e902ebc17e4e10d83392d7cd3dc05fc9e35cc4/README.md "ubuntu-report/README.md at master · ubuntu/ubuntu-report | github.com"
|
||||
[2]: https://web.archive.org/web/20221029162538/https://github.com/ubuntu/ubuntu-report/blob/8e6030ff9bbeacacf41a9b58ea638a5c9a6f864d/README.md "More diagnostics data from desktop | lists.ubuntu.com"
|
||||
@@ -1974,10 +1974,10 @@ actions:
|
||||
|
||||
Read more about Zeitgeist:
|
||||
|
||||
- [Official website | zeitgeist.freedesktop.org](https://web.archive.org/web/20221029150843/https://zeitgeist.freedesktop.org/)
|
||||
- [Official website | zeitgeist.freedesktop.org](https://web.archive.org/web/20221029222739/https://zeitgeist.freedesktop.org/)
|
||||
- [Wikipedia article | en.wikipedia.org](https://web.archive.org/web/20221029222921/https://en.wikipedia.org/wiki/Zeitgeist_%28free_software%29)
|
||||
- [Launchpad project page | launchpad.net](https://web.archive.org/web/20221029223026/https://launchpad.net/zeitgeist/)
|
||||
- [ArchWiki article | wiki.archlinux.org](https://web.archive.org/web/20221029164539/https://wiki.archlinux.org/title/Zeitgeist)
|
||||
- [ArchWiki article | wiki.archlinux.org](https://web.archive.org/web/20221029223033/https://wiki.archlinux.org/title/Zeitgeist)
|
||||
|
||||
[1]: https://web.archive.org/web/20221029163704/https://packages.debian.org/en/sid/libdevel/libzeitgeist-2.0-dev "libzeitgeist-2.0-dev | Debian Packages | packages.debian.org"
|
||||
[2]: https://web.archive.org/web/20221029163817/https://gitlab.gnome.org/crvi/gnome-activity-journal "crvi / GNOME Activity Journal · GitLab | gitlab.gnome.org"
|
||||
@@ -2116,7 +2116,7 @@ actions:
|
||||
[3]: https://web.archive.org/web/20221029170026/https://packages.ubuntu.com/bionic/all/network-manager-config-connectivity-ubuntu/filelist "Ubuntu - File list of package network-manager-config-connectivity-ubuntu/bionic/all | packages.ubuntu.com"
|
||||
[4]: https://web.archive.org/web/20221029170108/https://github.com/pop-os/connectivity/blob/master/debian/20-connectivity-pop.conf "connectivity/20-connectivity-pop.conf at master · pop-os/connectivity | github.com"
|
||||
[5]: https://web.archive.org/web/20221029170202/https://cgit.freedesktop.org/NetworkManager/NetworkManager/tree/contrib/fedora/rpm/20-connectivity-fedora.conf "20-connectivity-fedora.conf\rpm\fedora\contrib - NetworkManager/NetworkManager - Network connection manager and user applications | reedesktop.org"
|
||||
[6]: https://archive.ph/2023.12.06-185917/https://pkgs.org/download/NetworkManager-config-connectivity-fedora "Networkmanager-config-connectivity-fedora Download (RPM) | pkgs.org"
|
||||
[6]: https://web.archive.org/web/20221029170207/https://fedora.pkgs.org/35/fedora-updates-testing-x86_64/NetworkManager-config-connectivity-fedora-1.32.12-1.fc35.noarch.rpm.html "NetworkManager-config-connectivity-fedora | fedora.pkgs.org"
|
||||
call:
|
||||
function: RunIfCommandExists
|
||||
parameters:
|
||||
@@ -2202,7 +2202,7 @@ actions:
|
||||
- Diagnostic information about your system and usage is sent to Microsoft servers [3].
|
||||
- Your usage data and data about feature performance [3].
|
||||
|
||||
[1]: https://web.archive.org/web/20221029142001/https://en.wikipedia.org/wiki/Visual_Studio_Code "Visual Studio Code - Wikipedia | en.wikipedia.org"
|
||||
[1]: https://web.archive.org/web/20221029170818/https://en.wikipedia.org/wiki/Visual_Studio_Code "Visual Studio Code - Wikipedia | en.wikipedia.org"
|
||||
[2]: https://web.archive.org/web/20221029170840/https://code.visualstudio.com/updates/v1_26#_offline-mode "Visual Studio Code July 2018 | code.visualstudio.com"
|
||||
[3]: https://web.archive.org/web/20221029171138/https://code.visualstudio.com/docs/getstarted/telemetry "Visual Studio Code Telemetry | code.visualstudio.com"
|
||||
children:
|
||||
@@ -2697,7 +2697,7 @@ actions:
|
||||
[2]: https://web.archive.org/web/20231003094154/https://bugzilla.mozilla.org/show_bug.cgi?id=1746646 "1746646 - (tcp-mochitests) [meta] Make mochitests work with TCP enabled (cookieBehavior = 5) | bugzilla.mozilla.org"
|
||||
[3]: https://web.archive.org/web/20230918172155/https://developer.mozilla.org/en-US/docs/Web/Privacy/State_Partitioning#disable_dynamic_state_partitioning "State Partitioning - Privacy on the web | MDN"
|
||||
[4]: https://web.archive.org/web/20231003094207/https://bugzilla.mozilla.org/show_bug.cgi?id=1649876#c5 "1649876 - Migrate FPI users to dFPI | bugzilla.mozilla.org"
|
||||
[5]: https://web.archive.org/web/20231207105610/https://blog.mozilla.org/en/products/firefox/firefox-rolls-out-total-cookie-protection-by-default-to-all-users-worldwide/ "Firefox Rolls Out Total Cookie Protection By Default"
|
||||
[5]: https://blog.mozilla.org/en/products/firefox/firefox-rolls-out-total-cookie-protection-by-default-to-all-users-worldwide/ "Firefox Rolls Out Total Cookie Protection By Default"
|
||||
[6]: https://web.archive.org/web/20231003094350/https://bugzilla.mozilla.org/show_bug.cgi?id=1631676#c25 "1631676 - Disable dfpi when privacy.firstparty.isolate=true | bugzilla.mozilla.org"
|
||||
call:
|
||||
function: AddFirefoxPrefs
|
||||
@@ -2761,7 +2761,7 @@ actions:
|
||||
docs: |-
|
||||
Firefox provides an option for Enhanced Tracking Protection [1], which blocks trackers that
|
||||
gather information about your browsing behavior without disrupting site functionality [1].
|
||||
This feature also includes protections against harmful scripts such as malware that drain
|
||||
This feature also includes protections against harmful scripts such as malware that drains
|
||||
your battery [1].
|
||||
|
||||
This script enables the `privacy.resistFingerprinting` preference,
|
||||
@@ -2791,7 +2791,7 @@ actions:
|
||||
This script enables the `privacy.resistFingerprinting` preference, activating
|
||||
anti-fingerprinting [1][2].
|
||||
|
||||
As an experimental feature, it might cause some website breakages [2], such as impacting web
|
||||
As an experimental feature, it might cause some website breakage [2], such as impacting web
|
||||
speech functionality [3] and favicons [4].
|
||||
|
||||
[1]: https://web.archive.org/web/20221025201025/https://support.mozilla.org/en-US/kb/firefox-protection-against-fingerprinting "Firefox's protection against fingerprinting | Firefox Help | support.mozilla.org"
|
||||
@@ -2876,7 +2876,7 @@ actions:
|
||||
|
||||
It's configured to be enabled in nightly, aurora, beta, or default (developer) builds.
|
||||
In release builds, however, it's set to false [1]. This setting is hard-coded into the C++
|
||||
code to prevent easy disabling [2]. Developers have been approached about this issue, but
|
||||
code to prevent easy disabling [2]. Developers have been approached about this issue but
|
||||
have rejected proposals to unlock it [3].
|
||||
|
||||
Mozilla's plan is to deprecate this setting eventually, followed by removal [1].
|
||||
@@ -2887,7 +2887,7 @@ actions:
|
||||
setting [4].
|
||||
|
||||
[1]: https://web.archive.org/web/20221015102124/https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/internals/preferences.html "Preferences and Defines — Firefox Source Docs documentation | firefox-source-docs.mozilla.org"
|
||||
[2]: https://web.archive.org/web/20221015102338/https://searchfox.org/mozilla-central/source/modules/libpref/Preferences.cpp#3213
|
||||
[2]: https://web.archive.org/web/20221015102305/https://searchfox.org/mozilla-central/source/modules/libpref/Preferences.cpp#3213
|
||||
[3]: https://web.archive.org/web/20221015102419/https://bugzilla.mozilla.org/show_bug.cgi?id=1422689#c1
|
||||
[4]: https://web.archive.org/web/20221015102604/https://stigviewer.com/stig/mozilla_firefox/2020-12-10/finding/V-223170
|
||||
call:
|
||||
@@ -3012,7 +3012,7 @@ actions:
|
||||
recommend: standard
|
||||
docs: |-
|
||||
This script sets `toolkit.telemetry.server` to be empty.
|
||||
This preference defines the server to which telemetry pings are sent [1].
|
||||
This preference defines the server to which Telemetry pings are sent [1].
|
||||
|
||||
[1]: https://web.archive.org/web/20221015102124/https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/internals/preferences.html "Preferences and Defines — Firefox Source Docs documentation | firefox-source-docs.mozilla.org"
|
||||
call:
|
||||
@@ -3133,7 +3133,7 @@ actions:
|
||||
name: Disable Firefox Pioneer study monitoring
|
||||
recommend: standard
|
||||
docs: |-
|
||||
This script configures `toolkit.telemetry.pioneer-new-studies-available` to be disabled to opt out
|
||||
This script configures `toolkit.telemetry.pioneer-new-studies-available` to be disabled to opt out.
|
||||
Firefox Pioneer program.
|
||||
|
||||
This setting disables availability check for Firefox Pioneer studies [1].
|
||||
@@ -3173,7 +3173,7 @@ actions:
|
||||
portal is in place and blocking traffic, this feature prevents all other connection attempts,
|
||||
possibly revealing your usage habits.
|
||||
|
||||
See also: [Captive portal | Wikipedia](https://web.archive.org/web/20221029163002/https://en.wikipedia.org/wiki/Captive_portal).
|
||||
See also: [Captive portal | Wikipedia](https://web.archive.org/web/20221029223534/https://en.wikipedia.org/wiki/Captive_portal).
|
||||
|
||||
This script sets `network.captive-portal-service.enabled` to 'false', thereby disabling automatic
|
||||
connections [1].
|
||||
@@ -3207,7 +3207,7 @@ actions:
|
||||
There have been concerns about the potential for Google Safe Browsing to be used for censorship
|
||||
in the future, although this has not occurred as of yet [3].
|
||||
|
||||
[1]: https://web.archive.org/web/20221026164502/https://wiki.mozilla.org/Security/Safe_Browsing "Security/Safe Browsing - MozillaWiki | wiki.mozilla.org"
|
||||
[1]: https://web.archive.org/web/20221025192643/https://wiki.mozilla.org/Security/Safe_Browsing "Security/Safe Browsing - MozillaWiki | wiki.mozilla.org"
|
||||
[2]: https://web.archive.org/web/20221025193000/https://support.mozilla.org/en-US/kb/how-does-phishing-and-malware-protection-work#w_what-information-is-sent-to-mozilla-or-its-partners-when-phishing-and-malware-protection-is-enabled
|
||||
[3]: https://web.archive.org/web/20221025192516/https://www.usnews.com/opinion/articles/2016-06-22/google-is-the-worlds-biggest-censor-and-its-power-must-be-regulated "Google Is the World's Biggest Censor and Its Power Must Be Regulated | usnews.com"
|
||||
children:
|
||||
@@ -3226,7 +3226,7 @@ actions:
|
||||
|
||||
If this blocking is removed, the user should be knowledgeable about the potential risks and will take precautions.
|
||||
|
||||
[1]: https://web.archive.org/web/20221026164502/https://wiki.mozilla.org/Security/Safe_Browsing#Prefs "Security/Safe Browsing - MozillaWiki | wiki.mozilla.org"
|
||||
[1]: https://web.archive.org/web/20221025192643/https://wiki.mozilla.org/Security/Safe_Browsing#Prefs "Security/Safe Browsing - MozillaWiki | wiki.mozilla.org"
|
||||
[2]: https://web.archive.org/web/20230811024650/https://blog.mozilla.org/addons/2020/08/24/introducing-a-scalable-add-ons-blocklist/ "Introducing a scalable add-ons blocklist | Mozilla Add-ons Community Blog"
|
||||
call:
|
||||
function: AddFirefoxPrefs
|
||||
@@ -3286,7 +3286,7 @@ actions:
|
||||
|
||||
It is active by default [2].
|
||||
|
||||
[1]: https://web.archive.org/web/20221026164502/https://wiki.mozilla.org/Security/Safe_Browsing#Prefs "Security/Safe Browsing - MozillaWiki | wiki.mozilla.org"
|
||||
[1]: https://web.archive.org/web/20221025192643/https://wiki.mozilla.org/Security/Safe_Browsing#Prefs "Security/Safe Browsing - MozillaWiki | wiki.mozilla.org"
|
||||
[2]: https://web.archive.org/web/20221029173442/https://github.com/mozilla/policy-templates/blob/master/README.md#preferences "policy-templates/README.md at master · mozilla/policy-templates · GitHub | github.com"
|
||||
call:
|
||||
function: AddFirefoxPrefs
|
||||
@@ -3711,7 +3711,7 @@ functions:
|
||||
# User-specific:
|
||||
# [~/.profile]
|
||||
# User-specific shell initialization scripts.
|
||||
# ✅ Recommended by Debian to edit for user-specific environment variables.
|
||||
# ✅ Recomended by Debian to edit for user-specific environment variables.
|
||||
# [~/.bashrc]
|
||||
# User-based configuration file to set environment variables for Bash shell.
|
||||
# ❌ Bash-specific.
|
||||
@@ -3783,7 +3783,7 @@ functions:
|
||||
if [[ -f "$cronjob_path" ]]; then
|
||||
if [[ -x "$cronjob_path" ]]; then
|
||||
sudo chmod -x "$cronjob_path"
|
||||
echo "Successfully disabled cronjob \"$job_name\"."
|
||||
echo "Succesfully disabled cronjob \"$job_name\"."
|
||||
else
|
||||
echo "Skipping, cronjob \"$job_name\" is already disabled."
|
||||
fi
|
||||
@@ -3797,7 +3797,7 @@ functions:
|
||||
echo "Skipping, cronjob \"$job_name\" is already enabled."
|
||||
else
|
||||
sudo chmod +x "$cronjob_path"
|
||||
echo "Successfully enabled cronjob \"$job_name\"."
|
||||
echo "Succesfully enabled cronjob \"$job_name\"."
|
||||
fi
|
||||
else
|
||||
>&2 echo "Failed to enable cronjob \"$job_name\" because it's missing."
|
||||
@@ -3939,7 +3939,7 @@ functions:
|
||||
echo "Backup file exists: $file."
|
||||
sudo mv "$backup_file" "$file"
|
||||
echo "Moved to: $file."
|
||||
echo "Successfully restored."
|
||||
echo "Succesfully restored."
|
||||
else
|
||||
>&2 echo "Failed to restore, backup file could not be found at $backup_file."
|
||||
>&2 echo "Was the change initially applied by privacy.sexy?"
|
||||
|
||||
@@ -108,7 +108,7 @@ actions:
|
||||
name: Clear user activity audit logs (login, logout, authentication, etc.)
|
||||
docs:
|
||||
- https://papers.put.as/papers/macosx/2012/Mac_Log_Analysis_Sarah_Edwards_DFIRSummit2012.pdf
|
||||
- https://web.archive.org/web/20240314054514/https://bpb-us-e1.wpmucdn.com/sites.psu.edu/dist/4/24696/files/2016/06/psumac2016-19-osxlogs_macadmins_2016.pdf
|
||||
- http://macadmins.psu.edu/wp-content/uploads/sites/24696/2016/06/psumac2016-19-osxlogs_macadmins_2016.pdf
|
||||
code: |-
|
||||
sudo rm -rfv /var/audit/*
|
||||
sudo rm -rfv /private/var/audit/*
|
||||
@@ -171,7 +171,7 @@ actions:
|
||||
-
|
||||
name: Clear Safari last session (open tabs) history
|
||||
docs:
|
||||
- https://web.archive.org/web/20240314061752/https://apple.stackexchange.com/questions/374099/where-does-safari-store-the-open-tabs/374116#374116
|
||||
- https://apple.stackexchange.com/a/374116
|
||||
- https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2013-7127
|
||||
code: rm -f ~/Library/Safari/LastSession.plist
|
||||
-
|
||||
@@ -191,7 +191,7 @@ actions:
|
||||
name: Clear Safari webpage previews (thumbnails)
|
||||
docs:
|
||||
- https://davidkoepi.wordpress.com/2013/04/20/safariforensic/
|
||||
- https://archive.ph/2024.03.14-100910/https://www.reddit.com/r/apple/comments/18lp92/your_apple_computer_keeps_a_screen_shot_of_nearly/?rdt=59921
|
||||
- https://www.reddit.com/r/apple/comments/18lp92/your_apple_computer_keeps_a_screen_shot_of_nearly/
|
||||
code: rm -rfv ~/Library/Caches/com.apple.Safari/Webpage\ Previews
|
||||
-
|
||||
name: Clear Safari history copy
|
||||
@@ -204,8 +204,8 @@ actions:
|
||||
-
|
||||
name: Clear Safari cookies
|
||||
docs:
|
||||
- https://web.archive.org/web/20240314132018/https://community.spiceworks.com/t/understanding-the-safari-cookies-binarycookies-file-format/928827
|
||||
- https://web.archive.org/web/20240314060318/https://link.springer.com/content/pdf/10.1007/0-387-36891-4_13.pdf
|
||||
- https://www.toolbox.com/tech/operating-systems/blogs/understanding-the-safari-cookiesbinarycookies-file-format-010712/
|
||||
- https://link.springer.com/content/pdf/10.1007/0-387-36891-4_13.pdf
|
||||
code: |-
|
||||
rm -f ~/Library/Cookies/Cookies.binarycookies
|
||||
# Used before Safari 5.1
|
||||
@@ -300,7 +300,7 @@ actions:
|
||||
> - Logs are valuable for diagnosing issues and understanding past actions [1].
|
||||
> - Script files can help review changes made to the system and aid in reverting those changes if needed.
|
||||
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[2]: https://github.com/undergroundwires/privacy.sexy/blob/master/SECURITY.md "SECURITY.md | privacy.sexy | github.com"
|
||||
children:
|
||||
-
|
||||
@@ -318,7 +318,7 @@ actions:
|
||||
> - This action is irreversible. Deleted script files cannot be retrieved.
|
||||
> - These files might be necessary for troubleshooting if you experience issues after using privacy.sexy scripts.
|
||||
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[2]: https://github.com/undergroundwires/privacy.sexy/blob/master/SECURITY.md "SECURITY.md | privacy.sexy | github.com"
|
||||
call:
|
||||
function: ClearDirectoryContents
|
||||
@@ -339,7 +339,7 @@ actions:
|
||||
> - Removing logs will prevent you from reviewing the application's activities, which could be helpful in diagnosing issues.
|
||||
> - Logs can contain valuable information for technical support should you need assistance.
|
||||
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[1]: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop-vs-web-features.md "Desktop vs. Web Features | privacy.sexy | github.com"
|
||||
[2]: https://github.com/undergroundwires/privacy.sexy/blob/master/SECURITY.md "SECURITY.md | privacy.sexy | github.com"
|
||||
call:
|
||||
function: ClearDirectoryContents
|
||||
@@ -520,7 +520,7 @@ actions:
|
||||
you'll be prompted to grant or deny permission. It's a proactive step to ensure that your sensitive information
|
||||
or system services are accessed only with your current and informed consent.
|
||||
children:
|
||||
# Main documentation: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services
|
||||
# Main documentation: https://archive.ph/26Hlq (https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services)
|
||||
-
|
||||
name: Clear **"All"** permissions
|
||||
docs: |-
|
||||
@@ -536,7 +536,7 @@ actions:
|
||||
This script resets permissions for camera access [1].
|
||||
It ensures no application can access the system camera without explicit user permission, protecting against unauthorized surveillance and data breaches.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -547,7 +547,7 @@ actions:
|
||||
This script resets permissions for microphone access [1].
|
||||
It revokes all granted access to the microphone, protecting against eavesdropping and unauthorized audio recording by applications.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -558,7 +558,7 @@ actions:
|
||||
This script resets permissions for accessibility features [1].
|
||||
It revokes application access to accessibility services, preventing misuse and ensuring these features are used only with user consent.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -569,7 +569,7 @@ actions:
|
||||
This script resets permissions for screen capture [1].
|
||||
It ensures applications cannot capture screen content without user authorization, protecting sensitive information displayed on the screen.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -580,7 +580,7 @@ actions:
|
||||
This script resets permissions for accessing reminders information managed by the Reminders app [1].
|
||||
It ensures applications cannot access or modify reminders data without explicit user permission, maintaining the privacy of personal reminders.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -591,7 +591,7 @@ actions:
|
||||
This script resets permissions for accessing the pictures managed by the Photos app [1].
|
||||
It revokes all permissions granted to applications, safeguarding personal photos and media from unauthorized access.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -602,7 +602,7 @@ actions:
|
||||
This script resets permissions for accessing the calendar information managed by the Calendar app [1].
|
||||
It ensures that applications cannot access calendar data without user consent, protecting personal and sensitive calendar information.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -614,7 +614,7 @@ actions:
|
||||
Full disk access allows the application access to all protected files, including system administration files [1].
|
||||
It revokes broad file access from applications, significantly reducing the risk of data exposure and enhancing overall system security.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -626,7 +626,7 @@ actions:
|
||||
The contact information managed by the Contacts app [1].
|
||||
It ensures that applications cannot access the user's contact list without explicit permission, maintaining the confidentiality of personal contacts.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -637,7 +637,7 @@ actions:
|
||||
This script resets permissions for accessing the Desktop folder [1].
|
||||
It revokes application access to files on the desktop, protecting personal and work-related documents from unauthorized access.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -648,7 +648,7 @@ actions:
|
||||
This script resets permissions for accessing the Documents folder [1].
|
||||
It prevents applications from accessing files in this folder without user consent, safeguarding important and private documents.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -659,7 +659,7 @@ actions:
|
||||
This script resets permissions for accessing the Downloads folder [1].
|
||||
It ensures that applications cannot access downloaded files without user authorization, protecting downloaded content from misuse.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -670,7 +670,7 @@ actions:
|
||||
This script resets permissions for Apple Events [1].
|
||||
It revokes permissions for applications to send restricted Apple Events to other processes [1], enhancing privacy and security.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -681,7 +681,7 @@ actions:
|
||||
This script resets permissions for File Provider Presence [1].
|
||||
It revokes the ability of File Provider applications to know when the user is accessing their managed files [1], enhancing user privacy.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -692,7 +692,7 @@ actions:
|
||||
This script resets "ListenEvent" permissions [1].
|
||||
It revokes application access to listen to system events [1], preventing unauthorized monitoring of user interactions with the system.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -703,7 +703,7 @@ actions:
|
||||
This script resets permissions for accessing the Media Library [1].
|
||||
It ensures that applications cannot access Apple Music, music and video activity, and the media library [1] without user consent.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -714,7 +714,7 @@ actions:
|
||||
This script resets permissions for sending "PostEvent" [1].
|
||||
It prevents applications from using CoreGraphics APIs to send system events [1], safeguarding against potential misuse.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -726,7 +726,7 @@ actions:
|
||||
This script resets permissions for using Speech Recognition [1].
|
||||
It revokes application access to the speech recognition facility and sending speech data to Apple [1], protecting user privacy.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -737,7 +737,7 @@ actions:
|
||||
This script resets permissions for modifying other apps [1].
|
||||
It prevents applications from updating or deleting other apps [1], maintaining system integrity and user control.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -748,7 +748,7 @@ actions:
|
||||
This script resets permissions for accessing application data [1].
|
||||
It revokes application access to specific application data, enhancing privacy and data security.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -759,7 +759,7 @@ actions:
|
||||
This script resets permissions for accessing files on network volumes [1].
|
||||
It ensures applications cannot access network files without user authorization.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -770,7 +770,7 @@ actions:
|
||||
This script resets permissions for accessing files on removable volumes [1].
|
||||
It protects data on external drives from unauthorized application access.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -781,7 +781,7 @@ actions:
|
||||
This script resets permissions for accessing system administration files [1].
|
||||
It enhances system security by restricting application access to critical system files.
|
||||
|
||||
[1]: https://archive.ph/2023.11.24-170934/https://developer.apple.com/documentation/devicemanagement/privacypreferencespolicycontrol/services "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
[1]: https://archive.ph/26Hlq "PrivacyPreferencesPolicyControl.Services | Apple Developer Documentation | apple.com"
|
||||
call:
|
||||
function: ResetServicePermissions
|
||||
parameters:
|
||||
@@ -877,7 +877,7 @@ actions:
|
||||
There is also `WelcomeScreenPromo.PromoOff` setting that's pre-configured to `1` (`no` as
|
||||
default). It's undocumented but still kept disabled by this script.
|
||||
|
||||
[1]: https://web.archive.org/web/20240314062932/https://forum.parallels.com/threads/unable-to-process-the-upgrade-request.345603/ "Unable to process the upgrade request | Parallels Forums | forum.parallels.com"
|
||||
[1]: https://web.archive.org/save/https://forum.parallels.com/threads/unable-to-process-the-upgrade-request.345603/ "Unable to process the upgrade request | Parallels Forums | forum.parallels.com"
|
||||
[2]: https://web.archive.org/web/20221012151800/https://kb.parallels.com/114422 "How do I turn off notifications in Parallels Desktop and Parallels Access? | Knowledge Base | parallels.com"
|
||||
code: |-
|
||||
defaults write 'com.parallels.Parallels Desktop' 'ProductPromo.ForcePromoOff' -bool yes
|
||||
@@ -988,16 +988,16 @@ actions:
|
||||
recommend: strict
|
||||
docs:
|
||||
- https://github.com/privacysexy-forks/starter/blob/master/system/siri.sh
|
||||
- https://web.archive.org/web/20201002133713/https://machippie.github.io/system/
|
||||
- https://machippie.github.io/system/
|
||||
code: defaults write com.apple.assistant.backedup 'Use device speaker for TTS' -int 3
|
||||
revertCode: defaults write com.apple.assistant.backedup 'Use device speaker for TTS' -int 2
|
||||
-
|
||||
name: Disable Siri services (Siri and assistantd)
|
||||
recommend: strict
|
||||
docs:
|
||||
- https://web.archive.org/web/20240314060540/https://apple.stackexchange.com/questions/57514/what-is-assistantd
|
||||
- https://archive.ph/2024.03.14-055010/https://community.jamf.com/t5/jamf-pro/kill-siri/td-p/171543
|
||||
- https://web.archive.org/web/20240314060501/https://apple.stackexchange.com/questions/258816/how-to-completely-disable-siri-on-sierra/370426#370426
|
||||
- https://apple.stackexchange.com/questions/57514/what-is-assistantd
|
||||
- https://www.jamf.com/jamf-nation/discussions/22757/kill-siri#responseChild137563
|
||||
- https://apple.stackexchange.com/a/370426
|
||||
# To see status: • `launchctl print-disabled system` • `launchctl print-disabled user/$UID` • `launchctl print-disabled gui/$UID`
|
||||
code: |-
|
||||
launchctl disable "user/$UID/com.apple.assistantd"
|
||||
@@ -1021,20 +1021,10 @@ actions:
|
||||
fi
|
||||
-
|
||||
name: Disable "Do you want to enable Siri?" pop-up
|
||||
docs: |-
|
||||
This script stops the "Enable Siri" pop-up [1] from appearing the first time a user logs into macOS [2].
|
||||
|
||||
Introduced in macOS version 10.12 [2], this pop-up asks, "Do you want to enable Siri?" [1]
|
||||
which could lead to Siri being enabled unintentionally.
|
||||
|
||||
This script configures the `com.apple.SetupAssistant!DidSeeSiriSetup` setting to suppress this pop-up [1] [2] [3] [4].
|
||||
This command tells the system that the Siri setup is complete, preventing the pop-up in future sessions and
|
||||
enhancing privacy by avoiding unintended Siri activation.
|
||||
|
||||
[1]: https://archive.ph/2024.03.14-053325/https://discussions.apple.com/thread/7694127?answerId=30752577022&sortBy=best%2330752577022 "macOS keeps nagging me about enabling Siri - Apple Community | discussions.apple.com"
|
||||
[2]: https://web.archive.org/web/20240314052600/https://derflounder.wordpress.com/2016/09/20/supressing-siri-pop-up-windows-on-macos-sierra/ "Suppressing Siri pop-up windows on macOS Sierra | Der Flounder"
|
||||
[3]: https://web.archive.org/web/20240314052901/https://windowsreport.com/mac/siri-keeps-popping-up/ "Siri keeps popping up on Mac? Here's how to easily fix that • MacTips | windowsreport.com"
|
||||
[4]: https://web.archive.org/web/20240314052247/https://community.jamf.com/t5/jamf-pro/disable-siri-setup-assistant-in-macos-sierra/m-p/205836/highlight/true#M194536 "Solved: Re: Disable Siri setup assistant in macOS Sierra - Jamf Nation Community - 205834 | community.jamf.com"
|
||||
docs:
|
||||
- https://discussions.apple.com/thread/7694127?answerId=30752577022#30752577022
|
||||
- https://windowsreport.com/mac/siri-keeps-popping-up/
|
||||
- https://www.jamf.com/jamf-nation/discussions/21783/disable-siri-setup-assistant-in-macos-sierra#responseChild131588
|
||||
code: defaults write com.apple.SetupAssistant 'DidSeeSiriSetup' -bool True
|
||||
revertCode: defaults delete com.apple.SetupAssistant 'DidSeeSiriSetup'
|
||||
-
|
||||
@@ -1094,7 +1084,7 @@ actions:
|
||||
by default.
|
||||
|
||||
[1]: https://web.archive.org/web/20230731152633/https://www.apple.com/legal/privacy/data/en/apple-advertising/ "Legal - Apple Advertising & Privacy - Apple"
|
||||
[2]: https://web.archive.org/web/20220805052411/https://support.apple.com/en-sg/guide/mac-help/mh32356/mac "Change Privacy preferences on Mac - Apple Support (SG)"
|
||||
[2]: https://web.archive.org/web/20220805052411/https://support.apple.com/en-sg/guide/mac-help/mh32356/mac: "Change Privacy preferences on Mac - Apple Support (SG)"
|
||||
[3]: https://web.archive.org/web/20230731155827/https://developer.apple.com/documentation/devicemanagement/restrictions "Restrictions | Apple Developer Documentation"
|
||||
[4]: https://web.archive.org/web/20230731155653/https://paper.bobylive.com/Security/CIS/CIS_Apple_macOS_11_0_Big_Sur_Benchmark_v2_0_0.pdf "CIS Apple macOS 11.0 Big Sur Benchmark"
|
||||
[5]: https://web.archive.org/web/20230731155131/https://developer.apple.com/documentation/adsupport/asidentifiermanager/1614151-advertisingidentifier "advertisingIdentifier | Apple Developer Documentation"
|
||||
@@ -1290,7 +1280,7 @@ actions:
|
||||
# OS tracks downloaded files with help of quarantine-aware applications
|
||||
# (such as Safari, Chrome) adding quarantine extended attributes to files.
|
||||
# then OS warns and asks if you really want to open it
|
||||
docs: https://web.archive.org/web/20210319081714/https://support.apple.com/en-gb/HT202491
|
||||
docs: https://support.apple.com/en-gb/HT202491
|
||||
children:
|
||||
-
|
||||
category: Clean File Quarantine from downloaded files
|
||||
@@ -1401,7 +1391,7 @@ actions:
|
||||
name: Disable Gatekeeper's automatic reactivation
|
||||
docs:
|
||||
- https://osxdaily.com/2015/11/05/stop-gatekeeper-auto-rearm-mac-os-x/
|
||||
- https://web.archive.org/web/20230327050142/https://www.cnet.com/tech/computing/how-to-disable-gatekeeper-permanently-on-os-x/
|
||||
- https://www.cnet.com/tech/computing/how-to-disable-gatekeeper-permanently-on-os-x/
|
||||
code: sudo defaults write /Library/Preferences/com.apple.security GKAutoRearm -bool true
|
||||
revertCode: sudo defaults write /Library/Preferences/com.apple.security GKAutoRearm -bool false
|
||||
-
|
||||
@@ -1460,19 +1450,13 @@ actions:
|
||||
revertCode: sudo defaults write /Library/Preferences/com.apple.security.libraryvalidation.plist 'DisableLibraryValidation' -bool false
|
||||
-
|
||||
category: Disable automatic updates
|
||||
docs: |-
|
||||
This category contains scripts to disable automatic operating system updates.
|
||||
|
||||
Disabling automatic updates gives users full control over when and which updates are applied to their system.
|
||||
It improves privacy by preventing unwanted data collection, new vulnerabilities and unapproved changes to system settings.
|
||||
|
||||
> **Caution**:
|
||||
> Disabling automatic updates can leave your system vulnerable to unpatched exploits.
|
||||
> Manually check and apply updates to stay protected.
|
||||
docs:
|
||||
- https://developer.apple.com/documentation/devicemanagement/deviceinformationresponse/queryresponses/osupdatesettings
|
||||
- https://macadminsdoc.readthedocs.io/en/master/Profiles-and-Settings/OS-X-Updates.html
|
||||
children:
|
||||
-
|
||||
name: Disable automatic checks for updates
|
||||
docs: https://archive.ph/2024.03.21-180353/https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
docs: https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
code: |-
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticCheckEnabled' -bool false
|
||||
@@ -1481,7 +1465,7 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticCheckEnabled' -bool true
|
||||
-
|
||||
name: Disable automatic downloads for updates
|
||||
docs: https://archive.ph/2024.03.21-180353/https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
docs: https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
code: |-
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticDownload' -bool false
|
||||
@@ -1490,41 +1474,12 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticDownload' -bool true
|
||||
-
|
||||
name: Disable automatic installation of macOS updates
|
||||
docs: |-
|
||||
This script stops macOS from automatically installing updates.
|
||||
|
||||
This script improves privacy by reducing unwanted data collection and ensuring updates don't change
|
||||
settings or data without your approval.
|
||||
|
||||
The Center for Internet Security (CIS) advises against automatic updates in scenarios where changes require
|
||||
thorough testing and approval processes to avoid operational disruptions [1] [2] [3] [4].
|
||||
|
||||
This script configures following to stop macOS from installing updates automatically:
|
||||
|
||||
1. `/Library/Preferences/com.apple.commerce!AutoUpdateRestartRequired`:
|
||||
This preference stops the system from automatically installing macOS updates [1] [2] [3] [4] [5] [6] [7] [8].
|
||||
By doing this, updates will only be installed when you decide, giving you a chance to check them first [1] [2] [3] [4] [5] [6] [7] [8].
|
||||
This setting applies to OS X Yosemite through macOS High Sierra [7] [9].
|
||||
|
||||
2. `/Library/Preferences/com.apple.commerce!AutomaticallyInstallMacOSUpdates`:
|
||||
Changing this setting stops macOS from installing updates automatically [3] [5] [9] [10], giving you control over when to update.
|
||||
If restricts the *Install macOS Updates* option and prevents the user from changing the option [10].
|
||||
While this setting enhances privacy, it's generally not advised by NIST due to potential security risks [9].
|
||||
This setting applies to macOS Mojave and newer versions [9].
|
||||
|
||||
> **Caution**: Disabling automatic updates requires you to manually check and apply updates to stay protected against security threats [1] [2] [3] [4].
|
||||
|
||||
[1]: https://web.archive.org/web/20240321165149/https://www.tenable.com/audits/items/CIS_Apple_macOS_10.12_v1.1.0_Level_1.audit:e02dfdd6bec9556a3ce537f60b91b549 "CIS Apple macOS 10.12 L1 v1.1.0 | 1.5 Enable OS X update installs | Tenable®"
|
||||
[2]: https://web.archive.org/web/20240321165851/https://paper.bobylive.com/Security/CIS/CIS_Apple_macOS_10_13_Benchmark_v1_1_0---PDF.pdf "CIS Apple macOS 10.13 Benchmark v1.1.0 | paper.bobylive.com"
|
||||
[3]: https://web.archive.org/web/20240321170400/https://www.tenable.com/audits/items/CIS_Apple_macOS_13.0_Ventura_v1.0.0_L1.audit:fe03c59a39c7c949507ff20d07f89993 "1.4 Ensure Install of macOS Updates Is Enabled | Tenable® | www.tenable.com"
|
||||
[4]: https://web.archive.org/web/20240321170036/https://paper.bobylive.com/Security/CIS/CIS_Apple_macOS_10_14_Benchmark_v1_4_0_PDF.pdf "CIS Apple macOS 10.14 Benchmark v1.4.0 | paper.bobylive.com"
|
||||
[5]: https://web.archive.org/web/20240321164917/https://www.ncsc.gov.uk/files/macos_provisioning_script.sh_.txt "macOS provisioning script | UK National Cyber Security Centre | www.ncsc.gov.uk"
|
||||
[6]: https://web.archive.org/web/20240321165118/https://macadminsdoc.readthedocs.io/en/master/Profiles-and-Settings/OS-X-Updates.html "macOS Updates — MacAdmins Community Documentation documentation | macadminsdoc.readthedocs.io"
|
||||
[7]: https://web.archive.org/web/20240321165304/https://derflounder.wordpress.com/2014/12/29/managing-automatic-app-store-and-os-x-update-installation-on-yosemite/ "Managing automatic App Store and OS X update installation on Yosemite | Der Flounder | derflounder.wordpress.com"
|
||||
[8]: https://web.archive.org/web/20240321170034/https://krypted.com/mac-os-x/app-store-preferences-set-server-5-4-macos-high-sierra/ "App Store Preferences To Set In On Server 5.4 for macOS High Sierra – krypted | krypted.com"
|
||||
[9]: https://web.archive.org/web/20240321170251/https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/ "Enabling automatic macOS software updates for OS X Yosemite through macOS Mojave | Der Flounder | derflounder.wordpress.com"
|
||||
[10]: https://archive.ph/2024.03.21-180353/https://developer.apple.com/documentation/devicemanagement/softwareupdate "SoftwareUpdate | Apple Developer Documentation | developer.apple.com"
|
||||
[11]: https://web.archive.org/web/20240321165931/https://csrc.nist.gov/CSRC/media/Projects/national-vulnerability-database/documents/CCE/CCE-macos_monterey.xls "CCE-91129-7 | CCE-macos_monterey.xls | Sheet 1 - NIST Computer Security Resource Center | csrc.nist.gov"
|
||||
docs:
|
||||
# References for AutoUpdateRestartRequired
|
||||
- https://kb.vmware.com/s/article/2960635
|
||||
- https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
|
||||
# References for AutomaticallyInstallMacOSUpdates
|
||||
- https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
code: |-
|
||||
# For OS X Yosemite through macOS High Sierra (>= 10.10 && < 10.14)
|
||||
sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdateRestartRequired' -bool false
|
||||
@@ -1537,44 +1492,9 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallMacOSUpdates' -bool true
|
||||
-
|
||||
name: Disable automatic app updates from the App Store
|
||||
docs: |-
|
||||
This script disables automatic app updates [1] [2] [3] [4] from the App Store [5] [6] [7] [8] [9] [10] [11] [12] [13].
|
||||
It prevents automatic installation of application updates as soon as they become available from Apple [2] [3] [6] [9] [11] [12] [13].
|
||||
Thus, applications are updated only when you choose to do so [5].
|
||||
|
||||
Disabling automatic updates prevents unexpected app behavior or settings changes.
|
||||
It helps you to maintain your current app configurations and privacy settings.
|
||||
It also protects against potential zero-day vulnerabilities in your apps.
|
||||
This gives you the ability to choose which updates to install and when, enabling you to review the details of updates before deciding to proceed.
|
||||
|
||||
The script modifies the following settings:
|
||||
|
||||
1. `/Library/Preferences/com.apple.commerce!AutoUpdate`:
|
||||
Disables automated app updates [1] [2] [3] [6] [9] [10] [13] from the App Store [7] [8].
|
||||
This setting applies to OS X Yosemite and newer versions [1].
|
||||
2. `/Library/Preferences/com.apple.SoftwareUpdate!AutomaticallyInstallAppUpdates`:
|
||||
Stops the automatic installation of app updates [1] [4] from App Store [9] [10] [11] [12] [13].
|
||||
It deselects the *Install app updates from the App Store* option and prevents the user from changing the option [10].
|
||||
While this setting enhances privacy, it's generally not advised by NIST due to potential security risks [4].
|
||||
This setting applies to macOS Mojave and newer versions [1].
|
||||
|
||||
> **Caution**:
|
||||
> Disabling app updates means you should manually check for and install important security patches for every application
|
||||
> to protect against vulnerabilities [2] [3] [5] [6] [9] [11] [12] [13].
|
||||
|
||||
[1]: https://web.archive.org/web/20240321170251/https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/ "Enabling automatic macOS software updates for OS X Yosemite through macOS Mojave | Der Flounder | derflounder.wordpress.com"
|
||||
[2]: https://web.archive.org/web/20240321190032/https://www.irs.gov/pub/irs-utl/safeguards-scsem-macosx-v6-1-093021.xlsx "SCSEM OSX 10.14 | Internal Revenue Service Office of Safeguards | www.irs.gov"
|
||||
[3]: https://web.archive.org/web/20240321170036/https://paper.bobylive.com/Security/CIS/CIS_Apple_macOS_10_14_Benchmark_v1_4_0_PDF.pdf "CIS Apple macOS 10.14 Benchmark v1.4.0 | paper.bobylive.com"
|
||||
[5]: https://web.archive.org/web/20240321190244/https://github-wiki-see.page/m/edamametechnologies/threatmodels/wiki/threatmodel-macOS-EN "threatmodel macOS EN - edamametechnologies/threatmodels GitHub Wiki | github-wiki-see.page"
|
||||
[6]: https://web.archive.org/web/20240321190315/https://www.tenable.com/audits/items/CIS_Apple_macOS_14.0_Sonoma_v1.0.0_L1.audit:66d3b86318384ba7947a3409e0c6e902 "1.5 Ensure Install Application Updates from the App Store Is E... | Tenable® | www.tenable.com"
|
||||
[7]: https://web.archive.org/web/20240321165304/https://derflounder.wordpress.com/2014/12/29/managing-automatic-app-store-and-os-x-update-installation-on-yosemite/ "Managing automatic App Store and OS X update installation on Yosemite | Der Flounder | derflounder.wordpress.com"
|
||||
[8]: https://web.archive.org/web/20240321190410/https://krypted.com/mac-security/app-store-preferences-set-server-5-2-macos-sierra/ "App Store Preferences To Set In On Server 5.2 for macOS Sierra – krypted | krypted.com"
|
||||
[4]: https://web.archive.org/web/20240321165931/https://csrc.nist.gov/CSRC/media/Projects/national-vulnerability-database/documents/CCE/CCE-macos_monterey.xls "CCE-91129-7 | CCE-macos_monterey.xls | Sheet 1 - NIST Computer Security Resource Center | csrc.nist.gov"
|
||||
[9]: https://web.archive.org/web/20240321190114/https://www.irs.gov/pub/irs-utl/safeguards-scsem-macosx.xlsx "SCSEM OSX 13.0 | Internal Revenue Service Office of Safeguards | www.irs.gov"
|
||||
[10]: https://archive.ph/2024.03.21-180353/https://developer.apple.com/documentation/devicemanagement/softwareupdate "SoftwareUpdate | Apple Developer Documentation | developer.apple.com"
|
||||
[11]: https://web.archive.org/web/20240321190122/https://paper.bobylive.com/Security/CIS/CIS_Apple_macOS_12_0_Monterey_Benchmark_v1_0_0.pdf "CIS Apple macOS 12.0 Monterey | CIS Benchmarks | paper.bobylive.com"
|
||||
[12]: https://web.archive.org/web/20240321190537/https://www.tenable.com/audits/items/CIS_Apple_macOS_11_v2.0.0_L1.audit:55e8759872dce781b8dbc5a3f42e23b9 "1.4 Ensure Installation of App Update Is Enabled | Tenable® | www.tenable.com"
|
||||
[13]: https://web.archive.org/web/20240321164917/https://www.ncsc.gov.uk/files/macos_provisioning_script.sh_.txt "macOS provisioning script | UK National Cyber Security Centre | www.ncsc.gov.uk"
|
||||
docs:
|
||||
- https://kb.vmware.com/s/article/2960635
|
||||
- https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
|
||||
code: |-
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdate' -bool false
|
||||
@@ -1587,7 +1507,7 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallAppUpdates' -bool true
|
||||
-
|
||||
name: Disable macOS beta release installation
|
||||
docs: https://web.archive.org/web/20170106103856/https://support.apple.com/en-gb/HT203018
|
||||
docs: https://support.apple.com/en-gb/HT203018
|
||||
code: |-
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AllowPreReleaseInstallation' -bool false
|
||||
@@ -1596,7 +1516,7 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AllowPreReleaseInstallation' -bool true
|
||||
-
|
||||
name: Disable automatic installation for configuration data (e.g. XProtect, Gatekeeper, MRT)
|
||||
docs: https://web.archive.org/web/20240321170251/https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
|
||||
docs: https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
|
||||
code: |-
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'ConfigDataInstall' -bool false
|
||||
@@ -1605,47 +1525,12 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'ConfigDataInstall' -bool true
|
||||
-
|
||||
name: Disable automatic installation for system data files and security updates
|
||||
docs: |-
|
||||
This script stops automatic installations of critical updates [1],
|
||||
including security [1] [2] [3] [4] [5] [6] [7] and system data file [1] [8] updates.
|
||||
|
||||
It improves privacy by providing:
|
||||
|
||||
- **Control Over Update Timing**:
|
||||
Users can review updates before installation to ensure they meet privacy standards and do not introduce
|
||||
unwanted telemetry or changes.
|
||||
- **Reduced External Communications**:
|
||||
Reduces how often it connects to update servers, potentially protection user information.
|
||||
|
||||
The script configures the `/Library/Preferences/com.apple.SoftwareUpdate!CriticalUpdateInstall` setting [1] [4] [5] [7] [8].
|
||||
This action prevents automatic downloads and installations of updates [1].
|
||||
It also prevents users from changing the Install system data files and security updates option manually [1].
|
||||
This script is compatible with OS X Yosemite and later versions [6] [8].
|
||||
|
||||
The revert script triggers `softwareupdate --background-critical` to install any pending critical updates directly [2] [9].
|
||||
|
||||
> **Caution:**
|
||||
> Only disable automatic updates if you're committed to manually installing them quickly to maintain your computer's security [4] [5] [8].
|
||||
> It's important to install updates soon to protect your computer. [4] [5] [8].
|
||||
>
|
||||
> This script disables:
|
||||
>
|
||||
> - Definition updates for **XProtect** and **Gatekeeper** that keep your computer safe from new threats [5].
|
||||
> - **Rapid Security Response** [10] [11].
|
||||
> **Rapid Security Responses** are software releases providing important security improvements between standard updates [12].
|
||||
|
||||
[1]: https://archive.ph/2024.03.21-180353/https://developer.apple.com/documentation/devicemanagement/softwareupdate "SoftwareUpdate | Apple Developer Documentation | developer.apple.com"
|
||||
[2]: https://web.archive.org/web/20240321201417/https://derflounder.wordpress.com/2014/12/24/managing-os-xs-automatic-security-updates/ "Managing OS X’s automatic security updates | Der Flounder | derflounder.wordpress.com"
|
||||
[3]: https://web.archive.org/web/20240321165118/https://macadminsdoc.readthedocs.io/en/master/Profiles-and-Settings/OS-X-Updates.html "macOS Updates — MacAdmins Community Documentation documentation | macadminsdoc.readthedocs.io"
|
||||
[4]: https://web.archive.org/web/20240321165931/https://csrc.nist.gov/CSRC/media/Projects/national-vulnerability-database/documents/CCE/CCE-macos_monterey.xls "CCE-91129-7 | CCE-macos_monterey.xls | Sheet 1 - NIST Computer Security Resource Center | csrc.nist.gov"
|
||||
[5]: https://web.archive.org/web/20240321201450/https://paper.bobylive.com/Security/CIS/CIS_Apple_OSX_10_9_Benchmark_v1_3_0.pdf "CIS Apple OSX 10.9 Benchmark | paper.bobylive.com"
|
||||
[6]: https://web.archive.org/web/20240321201643/https://derflounder.wordpress.com/2014/12/27/managing-automatic-installation-of-configdata-and-security-software-updates-on-yosemite/ "Managing automatic installation of ConfigData and security software updates on Yosemite | Der Flounder | derflounder.wordpress.com"
|
||||
[7]: https://web.archive.org/web/20240321201652/https://ss64.com/mac/syntax-defaults.html "System preference settings for macOS - macOS - SS64.com | ss64.com"
|
||||
[8]: https://web.archive.org/web/20240321201436/https://www.tenable.com/audits/items/CIS_OSX_10.10_v1.2.0_L1.audit:97f36c2eaa06045e85a1beff1a76a088 "1.4 Enable system data files and security update installs - 'C... | Tenable® | www.tenable.com"
|
||||
[9]: https://web.archive.org/web/20240321201406/https://managingosx.wordpress.com/2013/04/30/undocumented-options/ "Undocumented options – Managing OS X | managingosx.wordpress.com"
|
||||
[10]: https://web.archive.org/web/20240321201558/https://www.intuneirl.com/rapid-security-response/ "Managing Rapid Security Response on Apple Devices | www.intuneirl.com"
|
||||
[11]: https://web.archive.org/web/20240321201614/https://onsitegroup.co.za/rapid-security-response/ "Rapid security response - Onsite | onsitegroup.co.za"
|
||||
[12]: https://web.archive.org/web/20240321201623/https://support.apple.com/en-us/102657 "About Rapid Security Responses for iOS, iPadOS, and macOS - Apple Support | support.apple.com"
|
||||
docs:
|
||||
# References for CriticalUpdateInstall
|
||||
- https://derflounder.wordpress.com/2014/12/24/managing-os-xs-automatic-security-updates/
|
||||
- https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
# References for softwareupdate --background-critical
|
||||
- https://managingosx.wordpress.com/2013/04/30/undocumented-options/
|
||||
code: |-
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'CriticalUpdateInstall' -bool false
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +0,0 @@
|
||||
export interface CommandDefinition {
|
||||
buildShellCommand(filePath: string): string;
|
||||
isExecutionTerminatedExternally(exitCode: number): boolean;
|
||||
isExecutablePermissionsRequiredOnFile(): boolean;
|
||||
}
|
||||
@@ -1,61 +0,0 @@
|
||||
import { PosixShellArgumentEscaper } from './ShellArgument/PosixShellArgumentEscaper';
|
||||
import type { CommandDefinition } from '../CommandDefinition';
|
||||
import type { ShellArgumentEscaper } from './ShellArgument/ShellArgumentEscaper';
|
||||
|
||||
export const LinuxTerminalEmulator = 'x-terminal-emulator';
|
||||
|
||||
export class LinuxVisibleTerminalCommand implements CommandDefinition {
|
||||
constructor(
|
||||
private readonly escaper: ShellArgumentEscaper = new PosixShellArgumentEscaper(),
|
||||
) { }
|
||||
|
||||
public buildShellCommand(filePath: string): string {
|
||||
return `${LinuxTerminalEmulator} -e ${this.escaper.escapePathArgument(filePath)}`;
|
||||
/*
|
||||
🤔 Potential improvements:
|
||||
Use user-friendly GUI sudo prompt (not terminal-based).
|
||||
If `pkexec` exists, we could do `x-terminal-emulator -e pkexec 'path'`, which always
|
||||
prompts with user-friendly GUI sudo prompt.
|
||||
📝 Options:
|
||||
`x-terminal-emulator -e 'path'`:
|
||||
✅ Visible terminal window
|
||||
❌ Terminal-based (not GUI) sudo prompt.
|
||||
`x-terminal-emulator -e pkexec 'path'
|
||||
✅ Visible terminal window
|
||||
✅ Always prompts with user-friendly GUI sudo prompt.
|
||||
🤔 Not using `pkexec` as it is not in all Linux distributions. It should have smarter
|
||||
logic to handle if it does not exist.
|
||||
`electron.shell.openPath`:
|
||||
❌ Opens the script in the default text editor, verified on
|
||||
Debian/Ubuntu-based distributions.
|
||||
`child_process.execFile()`:
|
||||
❌ Script execution in the background without a visible terminal.
|
||||
*/
|
||||
}
|
||||
|
||||
public isExecutionTerminatedExternally(exitCode: number): boolean {
|
||||
return exitCode === 137;
|
||||
/*
|
||||
`x-terminal-emulator` may return exit code `137` under specific circumstances like when the
|
||||
user closes the terminal (observed with `gnome-terminal` on Pop!_OS). This exit code (128 +
|
||||
Unix signal 9) indicates the process was terminated by a SIGKILL signal, which can occur due
|
||||
to user action (cancelling the progress) or the system (e.g., due to memory shortages).
|
||||
|
||||
Additional exit codes noted for future consideration (currently not handled as they have not
|
||||
been reproduced):
|
||||
|
||||
- 130 (130 = 128 + Unix signal 2): Indicates the script was terminated by the user
|
||||
(Control-C), corresponding to a SIGINT signal.
|
||||
- 143 (128 + Unix signal 15): Indicates termination by a SIGTERM signal, suggesting a request
|
||||
to gracefully terminate the process.
|
||||
*/
|
||||
}
|
||||
|
||||
public isExecutablePermissionsRequiredOnFile(): boolean {
|
||||
/*
|
||||
On Linux, a script file without executable permissions cannot be run directly by its path
|
||||
without specifying a shell explicitly.
|
||||
*/
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -1,46 +0,0 @@
|
||||
import { PosixShellArgumentEscaper } from './ShellArgument/PosixShellArgumentEscaper';
|
||||
import type { CommandDefinition } from '../CommandDefinition';
|
||||
import type { ShellArgumentEscaper } from './ShellArgument/ShellArgumentEscaper';
|
||||
|
||||
export class MacOsVisibleTerminalCommand implements CommandDefinition {
|
||||
constructor(
|
||||
private readonly escaper: ShellArgumentEscaper = new PosixShellArgumentEscaper(),
|
||||
) { }
|
||||
|
||||
public buildShellCommand(filePath: string): string {
|
||||
return `open -a Terminal.app ${this.escaper.escapePathArgument(filePath)}`;
|
||||
/*
|
||||
📝 Options:
|
||||
`child_process.execFile()`
|
||||
"path", `cmd.exe /c "path"`
|
||||
❌ Script execution in the background without a visible terminal.
|
||||
This occurs only when the user runs the application as administrator, as seen
|
||||
in Windows Pro VMs on Azure.
|
||||
`PowerShell Start -Verb RunAs "path"`
|
||||
✅ Visible terminal window
|
||||
✅ GUI sudo prompt (through `RunAs` option)
|
||||
`PowerShell Start "path"`
|
||||
`explorer.exe "path"`
|
||||
`electron.shell.openPath`
|
||||
`start cmd.exe /c "$path"`
|
||||
✅ Visible terminal window
|
||||
✅ GUI sudo prompt (through `RunAs` option)
|
||||
👍 Among all options `start` command is the most explicit one, being the most resilient
|
||||
against the potential changes in Windows or Electron framework (e.g. https://github.com/electron/electron/issues/36765).
|
||||
`%COMSPEC%` environment variable should be checked before defaulting to `cmd.exe.
|
||||
Related docs: https://web.archive.org/web/20240106002357/https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows
|
||||
*/
|
||||
}
|
||||
|
||||
public isExecutionTerminatedExternally(): boolean {
|
||||
return false;
|
||||
}
|
||||
|
||||
public isExecutablePermissionsRequiredOnFile(): boolean {
|
||||
/*
|
||||
On macOS, a script file without executable permissions cannot be run directly by its path
|
||||
without specifying a shell explicitly.
|
||||
*/
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -1,32 +0,0 @@
|
||||
import type { PowerShellInvokeShellCommandCreator } from './PowerShellInvokeShellCommandCreator';
|
||||
|
||||
/**
|
||||
Encoding PowerShell commands resolve issues with quote handling.
|
||||
|
||||
There are known problems with PowerShell's handling of double quotes in command line arguments:
|
||||
- Quote stripping in PowerShell command line arguments: https://web.archive.org/web/20240507102706/https://stackoverflow.com/questions/6714165/powershell-stripping-double-quotes-from-command-line-arguments
|
||||
- privacy.sexy double quotes issue when calling PowerShell from command line: https://web.archive.org/web/20240507102841/https://github.com/undergroundwires/privacy.sexy/issues/351
|
||||
- Challenges with single quotes in PowerShell command line: https://web.archive.org/web/20240507102047/https://stackoverflow.com/questions/20958388/command-line-escaping-single-quote-for-powershell
|
||||
|
||||
Using the `EncodedCommand` parameter is recommended by Microsoft for handling
|
||||
complex quoting scenarios. This approach helps avoid issues by encoding the entire
|
||||
command as a Base64 string:
|
||||
- Microsoft's documentation on using the `EncodedCommand` parameter: https://web.archive.org/web/20240507102733/https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_powershell_exe?view=powershell-5.1#-encodedcommand-base64encodedcommand
|
||||
*/
|
||||
export class EncodedPowerShellInvokeCmdCommandCreator
|
||||
implements PowerShellInvokeShellCommandCreator {
|
||||
public createCommandToInvokePowerShell(powerShellScript: string): string {
|
||||
return generateEncodedPowershellCommand(powerShellScript);
|
||||
}
|
||||
}
|
||||
|
||||
function generateEncodedPowershellCommand(powerShellScript: string): string {
|
||||
const encodedCommand = encodeForPowershellExecution(powerShellScript);
|
||||
return `PowerShell -EncodedCommand ${encodedCommand}`;
|
||||
}
|
||||
|
||||
function encodeForPowershellExecution(script: string): string {
|
||||
// The string must be formatted using UTF-16LE character encoding, see: https://web.archive.org/web/20240507102733/https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_powershell_exe?view=powershell-5.1#-encodedcommand-base64encodedcommand
|
||||
const buffer = Buffer.from(script, 'utf16le');
|
||||
return buffer.toString('base64');
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
export interface PowerShellInvokeShellCommandCreator {
|
||||
createCommandToInvokePowerShell(powerShellCommand: string): string;
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
import type { ShellArgumentEscaper } from './ShellArgumentEscaper';
|
||||
|
||||
export class PosixShellArgumentEscaper implements ShellArgumentEscaper {
|
||||
public escapePathArgument(pathArgument: string): string {
|
||||
return posixShellPathArgumentEscape(pathArgument);
|
||||
}
|
||||
}
|
||||
|
||||
function posixShellPathArgumentEscape(pathArgument: string): string {
|
||||
/*
|
||||
- Wraps the path in single quotes, which is a standard practice in POSIX shells
|
||||
(like bash and zsh) found on macOS/Linux to ensure that characters like spaces, '*', and
|
||||
'?' are treated as literals, not as special characters.
|
||||
- Escapes any single quotes within the path itself. This allows paths containing single
|
||||
quotes to be correctly interpreted in POSIX-compliant systems, such as Linux and macOS.
|
||||
*/
|
||||
return `'${pathArgument.replaceAll('\'', '\'\\\'\'')}'`;
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
import type { ShellArgumentEscaper } from './ShellArgumentEscaper';
|
||||
|
||||
export class PowerShellArgumentEscaper implements ShellArgumentEscaper {
|
||||
public escapePathArgument(pathArgument: string): string {
|
||||
return powerShellPathArgumentEscape(pathArgument);
|
||||
}
|
||||
}
|
||||
|
||||
function powerShellPathArgumentEscape(pathArgument: string): string {
|
||||
// - Encloses the path in single quotes to handle spaces and most special characters.
|
||||
// - Single quotes are used in PowerShell to ensure the string is treated as a literal string.
|
||||
// - Paths in Windows can include single quotes ('), so any internal single quotes are escaped
|
||||
// using double quotes.
|
||||
return `'${pathArgument.replace(/'/g, "''")}'`;
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
export interface ShellArgumentEscaper {
|
||||
escapePathArgument(pathArgument: string): string;
|
||||
}
|
||||
@@ -1,61 +0,0 @@
|
||||
import type { Logger } from '@/application/Common/Log/Logger';
|
||||
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
|
||||
import { PowerShellArgumentEscaper } from './ShellArgument/PowerShellArgumentEscaper';
|
||||
import { EncodedPowerShellInvokeCmdCommandCreator } from './PowerShellInvoke/EncodedPowerShellInvokeCmdCommandCreator';
|
||||
import type { ShellArgumentEscaper } from './ShellArgument/ShellArgumentEscaper';
|
||||
import type { CommandDefinition } from '../CommandDefinition';
|
||||
import type { PowerShellInvokeShellCommandCreator } from './PowerShellInvoke/PowerShellInvokeShellCommandCreator';
|
||||
|
||||
export class WindowsVisibleTerminalCommand implements CommandDefinition {
|
||||
constructor(
|
||||
private readonly escaper: ShellArgumentEscaper = new PowerShellArgumentEscaper(),
|
||||
private readonly powershellCommandCreator: PowerShellInvokeShellCommandCreator
|
||||
= new EncodedPowerShellInvokeCmdCommandCreator(),
|
||||
private readonly logger: Logger = ElectronLogger,
|
||||
) { }
|
||||
|
||||
public buildShellCommand(filePath: string): string {
|
||||
const powershellCommand = [
|
||||
'Start-Process',
|
||||
'-Verb RunAs', // Run as administrator with GUI sudo prompt
|
||||
`-FilePath ${this.escaper.escapePathArgument(filePath)}`,
|
||||
].join(' ');
|
||||
/*
|
||||
Running PowerShell command is preferred due to its flexibility and the way it provides
|
||||
GUI sudo prompt through `RunAs` argument.
|
||||
Other options considered:
|
||||
`child_process.execFile()`
|
||||
"path", `cmd.exe /c "path"`
|
||||
❌ Script execution in the background without a visible terminal.
|
||||
This occurs only when the user runs the application as administrator, as seen
|
||||
in Windows Pro VMs on Azure.
|
||||
`PowerShell Start -Verb RunAs "path"`
|
||||
✅ Visible terminal window
|
||||
✅ GUI sudo prompt (through `RunAs` option)
|
||||
`PowerShell Start "path"`
|
||||
`explorer.exe "path"`
|
||||
`electron.shell.openPath`
|
||||
`start cmd.exe /c "$path"`
|
||||
✅ Visible terminal window
|
||||
✅ GUI sudo prompt (through `RunAs` option)
|
||||
👍 Among all options `start` command is the most explicit one, being the most resilient
|
||||
against the potential changes in Windows or Electron framework (e.g. https://github.com/electron/electron/issues/36765).
|
||||
`%COMSPEC%` environment variable should be checked before defaulting to `cmd.exe.
|
||||
Related docs: https://web.archive.org/web/20240106002357/https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows
|
||||
*/
|
||||
this.logger.info(`Building command for PowerShell execution:\n\tCommand: ${powershellCommand}`);
|
||||
return this.powershellCommandCreator.createCommandToInvokePowerShell(powershellCommand);
|
||||
}
|
||||
|
||||
public isExecutionTerminatedExternally(): boolean {
|
||||
return false;
|
||||
}
|
||||
|
||||
public isExecutablePermissionsRequiredOnFile(): boolean {
|
||||
/*
|
||||
In Windows, whether a file can be executed is determined by its file extension
|
||||
(.exe, .bat, .cmd, etc.) rather than executable permissions set on the file.
|
||||
*/
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
import type { CommandDefinition } from '../CommandDefinition';
|
||||
|
||||
export interface CommandDefinitionFactory {
|
||||
provideCommandDefinition(): CommandDefinition;
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||
import type { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
||||
import { WindowsVisibleTerminalCommand } from '../Commands/WindowsVisibleTerminalCommand';
|
||||
import { LinuxVisibleTerminalCommand } from '../Commands/LinuxVisibleTerminalCommand';
|
||||
import { MacOsVisibleTerminalCommand } from '../Commands/MacOsVisibleTerminalCommand';
|
||||
import type { CommandDefinitionFactory } from './CommandDefinitionFactory';
|
||||
import type { CommandDefinition } from '../CommandDefinition';
|
||||
|
||||
export class OsSpecificTerminalLaunchCommandFactory implements CommandDefinitionFactory {
|
||||
constructor(
|
||||
private readonly environment: RuntimeEnvironment = CurrentEnvironment,
|
||||
) { }
|
||||
|
||||
public provideCommandDefinition(): CommandDefinition {
|
||||
const { os } = this.environment;
|
||||
if (os === undefined) {
|
||||
throw new Error('Operating system could not be identified from environment.');
|
||||
}
|
||||
return getOperatingSystemCommandDefinition(os);
|
||||
}
|
||||
}
|
||||
|
||||
function getOperatingSystemCommandDefinition(
|
||||
operatingSystem: OperatingSystem,
|
||||
): CommandDefinition {
|
||||
const definition = SupportedDesktopCommandDefinitions[operatingSystem];
|
||||
if (!definition) {
|
||||
throw new Error(`Unsupported operating system: ${OperatingSystem[operatingSystem]}`);
|
||||
}
|
||||
return definition;
|
||||
}
|
||||
|
||||
const SupportedDesktopCommandDefinitions: Readonly<Partial<Record<
|
||||
OperatingSystem,
|
||||
CommandDefinition>>> = {
|
||||
[OperatingSystem.Windows]: new WindowsVisibleTerminalCommand(),
|
||||
[OperatingSystem.Linux]: new LinuxVisibleTerminalCommand(),
|
||||
[OperatingSystem.macOS]: new MacOsVisibleTerminalCommand(),
|
||||
} as const;
|
||||
@@ -1,9 +0,0 @@
|
||||
import type { ScriptFileExecutionOutcome } from '../../ScriptFileExecutor';
|
||||
import type { CommandDefinition } from '../CommandDefinition';
|
||||
|
||||
export interface CommandDefinitionRunner {
|
||||
runCommandDefinition(
|
||||
commandDefinition: CommandDefinition,
|
||||
filePath: string,
|
||||
): Promise<ScriptFileExecutionOutcome>;
|
||||
}
|
||||
@@ -1,80 +0,0 @@
|
||||
import type { CodeRunErrorType } from '@/application/CodeRunner/CodeRunner';
|
||||
import { FileSystemExecutablePermissionSetter } from './PermissionSetter/FileSystemExecutablePermissionSetter';
|
||||
import { LoggingNodeShellCommandRunner } from './ShellRunner/LoggingNodeShellCommandRunner';
|
||||
import type { FailedScriptFileExecution, ScriptFileExecutionOutcome } from '../../ScriptFileExecutor';
|
||||
import type { CommandDefinition } from '../CommandDefinition';
|
||||
import type { CommandDefinitionRunner } from './CommandDefinitionRunner';
|
||||
import type { ExecutablePermissionSetter } from './PermissionSetter/ExecutablePermissionSetter';
|
||||
import type { ShellCommandOutcome, ShellCommandRunner } from './ShellRunner/ShellCommandRunner';
|
||||
|
||||
export class ExecutableFileShellCommandDefinitionRunner implements CommandDefinitionRunner {
|
||||
constructor(
|
||||
private readonly executablePermissionSetter: ExecutablePermissionSetter
|
||||
= new FileSystemExecutablePermissionSetter(),
|
||||
private readonly shellCommandRunner: ShellCommandRunner
|
||||
= new LoggingNodeShellCommandRunner(),
|
||||
) { }
|
||||
|
||||
public async runCommandDefinition(
|
||||
commandDefinition: CommandDefinition,
|
||||
filePath: string,
|
||||
): Promise<ScriptFileExecutionOutcome> {
|
||||
if (commandDefinition.isExecutablePermissionsRequiredOnFile()) {
|
||||
const filePermissionsResult = await this.executablePermissionSetter
|
||||
.makeFileExecutable(filePath);
|
||||
if (!filePermissionsResult.success) {
|
||||
return filePermissionsResult;
|
||||
}
|
||||
}
|
||||
const command = commandDefinition.buildShellCommand(filePath);
|
||||
const shellOutcome = await this.shellCommandRunner.runShellCommand(command);
|
||||
return interpretShellOutcome(shellOutcome, commandDefinition);
|
||||
}
|
||||
}
|
||||
|
||||
function interpretShellOutcome(
|
||||
outcome: ShellCommandOutcome,
|
||||
commandDefinition: CommandDefinition,
|
||||
): ScriptFileExecutionOutcome {
|
||||
switch (outcome.type) {
|
||||
case 'RegularProcessExit':
|
||||
if (outcome.exitCode === 0) {
|
||||
return { success: true };
|
||||
}
|
||||
if (commandDefinition.isExecutionTerminatedExternally(outcome.exitCode)) {
|
||||
return createFailureOutcome(
|
||||
'ExternalProcessTermination',
|
||||
`Process terminated externally: Exit code ${outcome.exitCode}.`,
|
||||
);
|
||||
}
|
||||
return createFailureOutcome(
|
||||
'FileExecutionError',
|
||||
`Unexpected exit code: ${outcome.exitCode}.`,
|
||||
);
|
||||
case 'ExternallyTerminated':
|
||||
return createFailureOutcome(
|
||||
'ExternalProcessTermination',
|
||||
`Process terminated by signal ${outcome.terminationSignal}.`,
|
||||
);
|
||||
case 'ExecutionError':
|
||||
return createFailureOutcome(
|
||||
'FileExecutionError',
|
||||
`Execution error: ${outcome.error.message}.`,
|
||||
);
|
||||
default:
|
||||
throw new Error(`Unknown outcome type: ${outcome}`);
|
||||
}
|
||||
}
|
||||
|
||||
function createFailureOutcome(
|
||||
type: CodeRunErrorType,
|
||||
errorMessage: string,
|
||||
): FailedScriptFileExecution {
|
||||
return {
|
||||
success: false,
|
||||
error: {
|
||||
type,
|
||||
message: `Error during command execution: ${errorMessage}`,
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
import type { ScriptFileExecutionOutcome } from '@/infrastructure/CodeRunner/Execution/ScriptFileExecutor';
|
||||
|
||||
export interface ExecutablePermissionSetter {
|
||||
makeFileExecutable(filePath: string): Promise<ScriptFileExecutionOutcome>;
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
import { NodeElectronSystemOperations } from '@/infrastructure/CodeRunner/System/NodeElectronSystemOperations';
|
||||
import type { Logger } from '@/application/Common/Log/Logger';
|
||||
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
|
||||
import type { SystemOperations } from '@/infrastructure/CodeRunner/System/SystemOperations';
|
||||
import type { ScriptFileExecutionOutcome } from '@/infrastructure/CodeRunner/Execution/ScriptFileExecutor';
|
||||
import type { ExecutablePermissionSetter } from './ExecutablePermissionSetter';
|
||||
|
||||
export class FileSystemExecutablePermissionSetter implements ExecutablePermissionSetter {
|
||||
constructor(
|
||||
private readonly system: SystemOperations = new NodeElectronSystemOperations(),
|
||||
private readonly logger: Logger = ElectronLogger,
|
||||
) { }
|
||||
|
||||
public async makeFileExecutable(filePath: string): Promise<ScriptFileExecutionOutcome> {
|
||||
/*
|
||||
This is required on macOS and Linux otherwise the terminal emulators will refuse to
|
||||
execute the script. It's not needed on Windows.
|
||||
*/
|
||||
try {
|
||||
this.logger.info(`Setting execution permissions for file at ${filePath}`);
|
||||
await this.system.fileSystem.setFilePermissions(filePath, '755');
|
||||
this.logger.info(`Execution permissions set successfully for ${filePath}`);
|
||||
return { success: true };
|
||||
} catch (error) {
|
||||
this.logger.error(error);
|
||||
return {
|
||||
success: false,
|
||||
error: {
|
||||
type: 'FilePermissionChangeError',
|
||||
message: `Error setting script file permission: ${error.message}`,
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
import type { Logger } from '@/application/Common/Log/Logger';
|
||||
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
|
||||
import type { SystemOperations } from '@/infrastructure/CodeRunner/System/SystemOperations';
|
||||
import { NodeElectronSystemOperations } from '@/infrastructure/CodeRunner/System/NodeElectronSystemOperations';
|
||||
import type { ShellCommandOutcome, ShellCommandRunner } from './ShellCommandRunner';
|
||||
|
||||
export class LoggingNodeShellCommandRunner implements ShellCommandRunner {
|
||||
constructor(
|
||||
private readonly logger: Logger = ElectronLogger,
|
||||
private readonly systemOps: SystemOperations = new NodeElectronSystemOperations(),
|
||||
) {
|
||||
}
|
||||
|
||||
public runShellCommand(command: string): Promise<ShellCommandOutcome> {
|
||||
this.logger.info(`Executing command: ${command}`);
|
||||
return new Promise((resolve) => {
|
||||
this.systemOps.command.exec(command)
|
||||
// https://archive.today/2024.01.19-004011/https://nodejs.org/api/child_process.html#child_process_event_exit
|
||||
.on('exit', (
|
||||
code, // The exit code if the child exited on its own.
|
||||
signal, // The signal by which the child process was terminated.
|
||||
) => {
|
||||
// One of `code` or `signal` will always be non-null.
|
||||
// If the process exited, code is the final exit code of the process, otherwise null.
|
||||
if (code !== null) {
|
||||
this.logger.info(`Command completed with exit code ${code}.`);
|
||||
resolve({ type: 'RegularProcessExit', exitCode: code });
|
||||
return; // Prevent further execution to avoid multiple promise resolutions and logs.
|
||||
}
|
||||
// If the process terminated due to receipt of a signal, signal is the string name of
|
||||
// the signal, otherwise null.
|
||||
resolve({ type: 'ExternallyTerminated', terminationSignal: signal as NodeJS.Signals });
|
||||
this.logger.warn(`Command terminated by signal: ${signal}`);
|
||||
})
|
||||
.on('error', (error) => {
|
||||
// https://archive.ph/20200912193803/https://nodejs.org/api/child_process.html#child_process_event_error
|
||||
// The 'error' event is emitted whenever:
|
||||
// - The process could not be spawned, or
|
||||
// - The process could not be killed, or
|
||||
// - Sending a message to the child process failed.
|
||||
// The 'exit' event may or may not fire after an error has occurred.
|
||||
this.logger.error('Command execution failed:', error);
|
||||
resolve({ type: 'ExecutionError', error });
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
export interface ShellCommandRunner {
|
||||
runShellCommand(command: string): Promise<ShellCommandOutcome>;
|
||||
}
|
||||
|
||||
export type ShellCommandOutcome = ProcessStatus & ({
|
||||
readonly type: 'RegularProcessExit',
|
||||
readonly exitCode: number;
|
||||
} | {
|
||||
readonly type: 'ExternallyTerminated';
|
||||
readonly terminationSignal: NodeJS.Signals;
|
||||
} | {
|
||||
readonly type: 'ExecutionError';
|
||||
readonly error: Error;
|
||||
});
|
||||
|
||||
type ProcessOutcomeType = 'RegularProcessExit' | 'ExternallyTerminated' | 'ExecutionError';
|
||||
|
||||
interface ProcessStatus {
|
||||
readonly type: ProcessOutcomeType;
|
||||
readonly error?: Error;
|
||||
readonly terminationSignal?: NodeJS.Signals;
|
||||
readonly exitCode?: number;
|
||||
}
|
||||
@@ -1,71 +0,0 @@
|
||||
import type { Logger } from '@/application/Common/Log/Logger';
|
||||
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
|
||||
import { OsSpecificTerminalLaunchCommandFactory } from './CommandDefinition/Factory/OsSpecificTerminalLaunchCommandFactory';
|
||||
import { ExecutableFileShellCommandDefinitionRunner } from './CommandDefinition/Runner/ExecutableFileShellCommandDefinitionRunner';
|
||||
import type { ScriptFileExecutionOutcome, ScriptFileExecutor } from './ScriptFileExecutor';
|
||||
import type { CommandDefinitionFactory } from './CommandDefinition/Factory/CommandDefinitionFactory';
|
||||
import type { CommandDefinitionRunner } from './CommandDefinition/Runner/CommandDefinitionRunner';
|
||||
import type { CommandDefinition } from './CommandDefinition/CommandDefinition';
|
||||
|
||||
export class VisibleTerminalFileRunner implements ScriptFileExecutor {
|
||||
constructor(
|
||||
private readonly logger: Logger = ElectronLogger,
|
||||
private readonly commandFactory: CommandDefinitionFactory
|
||||
= new OsSpecificTerminalLaunchCommandFactory(),
|
||||
private readonly commandRunner: CommandDefinitionRunner
|
||||
= new ExecutableFileShellCommandDefinitionRunner(),
|
||||
) { }
|
||||
|
||||
public async executeScriptFile(
|
||||
filePath: string,
|
||||
): Promise<ScriptFileExecutionOutcome> {
|
||||
this.logger.info(`Executing script file: ${filePath}.`);
|
||||
const outcome = await this.findAndExecuteCommand(filePath);
|
||||
this.logOutcome(outcome);
|
||||
return outcome;
|
||||
}
|
||||
|
||||
private async findAndExecuteCommand(
|
||||
filePath: string,
|
||||
): Promise<ScriptFileExecutionOutcome> {
|
||||
try {
|
||||
let commandDefinition: CommandDefinition;
|
||||
try {
|
||||
commandDefinition = this.commandFactory.provideCommandDefinition();
|
||||
} catch (error) {
|
||||
return {
|
||||
success: false,
|
||||
error: {
|
||||
type: 'UnsupportedPlatform',
|
||||
message: `Error finding command: ${error.message}`,
|
||||
},
|
||||
};
|
||||
}
|
||||
const runOutcome = await this.commandRunner.runCommandDefinition(
|
||||
commandDefinition,
|
||||
filePath,
|
||||
);
|
||||
return runOutcome;
|
||||
} catch (error) {
|
||||
return {
|
||||
success: false,
|
||||
error: {
|
||||
type: 'FileExecutionError',
|
||||
message: `Unexpected error: ${error.message}`,
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
private logOutcome(outcome: ScriptFileExecutionOutcome) {
|
||||
if (outcome.success) {
|
||||
this.logger.info('Executed script file in terminal successfully.');
|
||||
return;
|
||||
}
|
||||
this.logger.error(
|
||||
'Failed to execute the script file in terminal.',
|
||||
outcome.error.type,
|
||||
outcome.error.message,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,214 @@
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import type { CommandOps, SystemOperations } from '@/infrastructure/CodeRunner/System/SystemOperations';
|
||||
import type { Logger } from '@/application/Common/Log/Logger';
|
||||
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
|
||||
import type { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
||||
import { NodeElectronSystemOperations } from '@/infrastructure/CodeRunner/System/NodeElectronSystemOperations';
|
||||
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||
import type { CodeRunErrorType } from '@/application/CodeRunner/CodeRunner';
|
||||
import { isString } from '@/TypeHelpers';
|
||||
import type { FailedScriptFileExecution, ScriptFileExecutionOutcome, ScriptFileExecutor } from './ScriptFileExecutor';
|
||||
|
||||
export class VisibleTerminalScriptExecutor implements ScriptFileExecutor {
|
||||
constructor(
|
||||
private readonly system: SystemOperations = new NodeElectronSystemOperations(),
|
||||
private readonly logger: Logger = ElectronLogger,
|
||||
private readonly environment: RuntimeEnvironment = CurrentEnvironment,
|
||||
) { }
|
||||
|
||||
public async executeScriptFile(filePath: string): Promise<ScriptFileExecutionOutcome> {
|
||||
const { os } = this.environment;
|
||||
if (os === undefined) {
|
||||
return this.handleError('UnsupportedOperatingSystem', 'Operating system could not be identified from environment.');
|
||||
}
|
||||
const filePermissionsResult = await this.setFileExecutablePermissions(filePath);
|
||||
if (!filePermissionsResult.success) {
|
||||
return filePermissionsResult;
|
||||
}
|
||||
const scriptExecutionResult = await this.runFileWithRunner(filePath, os);
|
||||
if (!scriptExecutionResult.success) {
|
||||
return scriptExecutionResult;
|
||||
}
|
||||
return {
|
||||
success: true,
|
||||
};
|
||||
}
|
||||
|
||||
private async setFileExecutablePermissions(
|
||||
filePath: string,
|
||||
): Promise<ScriptFileExecutionOutcome> {
|
||||
/*
|
||||
This is required on macOS and Linux otherwise the terminal emulators will refuse to
|
||||
execute the script. It's not needed on Windows.
|
||||
*/
|
||||
try {
|
||||
this.logger.info(`Setting execution permissions for file at ${filePath}`);
|
||||
await this.system.fileSystem.setFilePermissions(filePath, '755');
|
||||
this.logger.info(`Execution permissions set successfully for ${filePath}`);
|
||||
return { success: true };
|
||||
} catch (error) {
|
||||
return this.handleError('FileExecutionError', error);
|
||||
}
|
||||
}
|
||||
|
||||
private async runFileWithRunner(
|
||||
filePath: string,
|
||||
os: OperatingSystem,
|
||||
): Promise<ScriptFileExecutionOutcome> {
|
||||
this.logger.info(`Executing script file: ${filePath} on ${OperatingSystem[os]}.`);
|
||||
const runner = TerminalRunners[os];
|
||||
if (!runner) {
|
||||
return this.handleError('UnsupportedOperatingSystem', `Unsupported operating system: ${OperatingSystem[os]}`);
|
||||
}
|
||||
const context: TerminalExecutionContext = {
|
||||
scriptFilePath: filePath,
|
||||
commandOps: this.system.command,
|
||||
logger: this.logger,
|
||||
};
|
||||
try {
|
||||
await runner(context);
|
||||
this.logger.info('Command script file successfully.');
|
||||
return { success: true };
|
||||
} catch (error) {
|
||||
return this.handleError('FileExecutionError', error);
|
||||
}
|
||||
}
|
||||
|
||||
private handleError(
|
||||
type: CodeRunErrorType,
|
||||
error: Error | string,
|
||||
): FailedScriptFileExecution {
|
||||
const errorMessage = 'Error during script file execution';
|
||||
this.logger.error([type, errorMessage, ...(error ? [error] : [])]);
|
||||
return {
|
||||
success: false,
|
||||
error: {
|
||||
type,
|
||||
message: `${errorMessage}: ${isString(error) ? error : errorMessage}`,
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
interface TerminalExecutionContext {
|
||||
readonly scriptFilePath: string;
|
||||
readonly commandOps: CommandOps;
|
||||
readonly logger: Logger;
|
||||
}
|
||||
|
||||
type TerminalRunner = (context: TerminalExecutionContext) => Promise<void>;
|
||||
|
||||
export const LinuxTerminalEmulator = 'x-terminal-emulator';
|
||||
|
||||
const TerminalRunners: Partial<Record<OperatingSystem, TerminalRunner>> = {
|
||||
[OperatingSystem.Windows]: async (context) => {
|
||||
const command = [
|
||||
'PowerShell',
|
||||
'Start-Process',
|
||||
'-Verb RunAs', // Run as administrator with GUI sudo prompt
|
||||
`-FilePath ${cmdShellPathArgumentEscape(context.scriptFilePath)}`,
|
||||
].join(' ');
|
||||
/*
|
||||
📝 Options:
|
||||
`child_process.execFile()`
|
||||
"path", `cmd.exe /c "path"`
|
||||
❌ Script execution in the background without a visible terminal.
|
||||
This occurs only when the user runs the application as administrator, as seen
|
||||
in Windows Pro VMs on Azure.
|
||||
`PowerShell Start -Verb RunAs "path"`
|
||||
✅ Visible terminal window
|
||||
✅ GUI sudo prompt (through `RunAs` option)
|
||||
`PowerShell Start "path"`
|
||||
`explorer.exe "path"`
|
||||
`electron.shell.openPath`
|
||||
`start cmd.exe /c "$path"`
|
||||
✅ Visible terminal window
|
||||
✅ GUI sudo prompt (through `RunAs` option)
|
||||
👍 Among all options `start` command is the most explicit one, being the most resilient
|
||||
against the potential changes in Windows or Electron framework (e.g. https://github.com/electron/electron/issues/36765).
|
||||
`%COMSPEC%` environment variable should be checked before defaulting to `cmd.exe.
|
||||
Related docs: https://web.archive.org/web/20240106002357/https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows
|
||||
*/
|
||||
await runCommand(command, context);
|
||||
},
|
||||
[OperatingSystem.Linux]: async (context) => {
|
||||
const command = `${LinuxTerminalEmulator} -e ${posixShellPathArgumentEscape(context.scriptFilePath)}`;
|
||||
/*
|
||||
🤔 Potential improvements:
|
||||
Use user-friendly GUI sudo prompt (not terminal-based).
|
||||
If `pkexec` exists, we could do `x-terminal-emulator -e pkexec 'path'`, which always
|
||||
prompts with user-friendly GUI sudo prompt.
|
||||
📝 Options:
|
||||
`x-terminal-emulator -e 'path'`:
|
||||
✅ Visible terminal window
|
||||
❌ Terminal-based (not GUI) sudo prompt.
|
||||
`x-terminal-emulator -e pkexec 'path'
|
||||
✅ Visible terminal window
|
||||
✅ Always prompts with user-friendly GUI sudo prompt.
|
||||
🤔 Not using `pkexec` as it is not in all Linux distributions. It should have smarter
|
||||
logic to handle if it does not exist.
|
||||
`electron.shell.openPath`:
|
||||
❌ Opens the script in the default text editor, verified on
|
||||
Debian/Ubuntu-based distributions.
|
||||
`child_process.execFile()`:
|
||||
❌ Script execution in the background without a visible terminal.
|
||||
*/
|
||||
await runCommand(command, context);
|
||||
},
|
||||
[OperatingSystem.macOS]: async (context) => {
|
||||
const command = `open -a Terminal.app ${posixShellPathArgumentEscape(context.scriptFilePath)}`;
|
||||
// -a Specifies the application to use for opening the file
|
||||
/* eslint-disable vue/max-len */
|
||||
/*
|
||||
🤔 Potential improvements:
|
||||
Use user-friendly GUI sudo prompt for running the script.
|
||||
📝 Options:
|
||||
`open -a Terminal.app 'path'`
|
||||
✅ Visible terminal window
|
||||
❌ Terminal-based (not GUI) sudo prompt.
|
||||
❌ Terminal app requires many privileges to execute the script, this prompts user
|
||||
to grant privileges to the Terminal app.
|
||||
`osascript -e 'do shell script "'/tmp/test.sh'" with administrator privileges'`
|
||||
✅ Script as root
|
||||
✅ GUI sudo prompt.
|
||||
❌ Script execution in the background without a visible terminal.
|
||||
`osascript -e 'do shell script "open -a 'Terminal.app' '/tmp/test.sh'" with administrator privileges'`
|
||||
❌ Script as user, not root
|
||||
✅ GUI sudo prompt.
|
||||
✅ Visible terminal window
|
||||
`osascript -e 'do shell script "/System/Applications/Utilities/Terminal.app/Contents/MacOS/Terminal '/tmp/test.sh'" with administrator privileges'`
|
||||
✅ Script as root
|
||||
✅ GUI sudo prompt.
|
||||
✅ Visible terminal window
|
||||
Useful resources about `do shell script .. with administrator privileges`:
|
||||
- Change "osascript wants to make changes" prompt: https://web.archive.org/web/20240109191128/https://apple.stackexchange.com/questions/283353/how-to-rename-osascript-in-the-administrator-privileges-dialog
|
||||
- More about `do shell script`: https://web.archive.org/web/20100906222226/http://developer.apple.com/mac/library/technotes/tn2002/tn2065.html
|
||||
*/
|
||||
/* eslint-enable vue/max-len */
|
||||
await runCommand(command, context);
|
||||
},
|
||||
} as const;
|
||||
|
||||
async function runCommand(command: string, context: TerminalExecutionContext): Promise<void> {
|
||||
context.logger.info(`Executing command:\n${command}`);
|
||||
await context.commandOps.exec(command);
|
||||
context.logger.info('Executed command successfully.');
|
||||
}
|
||||
|
||||
function posixShellPathArgumentEscape(pathArgument: string): string {
|
||||
/*
|
||||
- Wraps the path in single quotes, which is a standard practice in POSIX shells
|
||||
(like bash and zsh) found on macOS/Linux to ensure that characters like spaces, '*', and
|
||||
'?' are treated as literals, not as special characters.
|
||||
- Escapes any single quotes within the path itself. This allows paths containing single
|
||||
quotes to be correctly interpreted in POSIX-compliant systems, such as Linux and macOS.
|
||||
*/
|
||||
return `'${pathArgument.replaceAll('\'', '\'\\\'\'')}'`;
|
||||
}
|
||||
|
||||
function cmdShellPathArgumentEscape(pathArgument: string): string {
|
||||
// - Encloses the path in double quotes, which is necessary for Windows command line (cmd.exe)
|
||||
// to correctly handle paths containing spaces.
|
||||
// - Paths in Windows cannot include double quotes `"` themselves, so these are not escaped.
|
||||
return `"${pathArgument}"`;
|
||||
}
|
||||
@@ -4,15 +4,15 @@ import type {
|
||||
CodeRunError, CodeRunOutcome, CodeRunner, FailedCodeRun,
|
||||
} from '@/application/CodeRunner/CodeRunner';
|
||||
import { ElectronLogger } from '../Log/ElectronLogger';
|
||||
import { VisibleTerminalScriptExecutor } from './Execution/VisibleTerminalScriptFileExecutor';
|
||||
import { ScriptFileCreationOrchestrator } from './Creation/ScriptFileCreationOrchestrator';
|
||||
import { VisibleTerminalFileRunner } from './Execution/VisibleTerminalFileRunner';
|
||||
import type { ScriptFileExecutor } from './Execution/ScriptFileExecutor';
|
||||
import type { ScriptFileCreator } from './Creation/ScriptFileCreator';
|
||||
|
||||
export class ScriptFileCodeRunner implements CodeRunner {
|
||||
constructor(
|
||||
private readonly scriptFileExecutor
|
||||
: ScriptFileExecutor = new VisibleTerminalFileRunner(),
|
||||
: ScriptFileExecutor = new VisibleTerminalScriptExecutor(),
|
||||
private readonly scriptFileCreator: ScriptFileCreator = new ScriptFileCreationOrchestrator(),
|
||||
private readonly logger: Logger = ElectronLogger,
|
||||
) { }
|
||||
|
||||
@@ -6,9 +6,6 @@ import type {
|
||||
CommandOps, FileSystemOps, LocationOps, OperatingSystemOps, SystemOperations,
|
||||
} from './SystemOperations';
|
||||
|
||||
/**
|
||||
* Thin wrapper for Node and Electron APIs.
|
||||
*/
|
||||
export class NodeElectronSystemOperations implements SystemOperations {
|
||||
public readonly operatingSystem: OperatingSystemOps = {
|
||||
/*
|
||||
@@ -52,6 +49,13 @@ export class NodeElectronSystemOperations implements SystemOperations {
|
||||
};
|
||||
|
||||
public readonly command: CommandOps = {
|
||||
exec,
|
||||
exec: (command) => new Promise((resolve, reject) => {
|
||||
exec(command, (error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
}
|
||||
resolve();
|
||||
});
|
||||
}),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import type { exec } from 'node:child_process';
|
||||
|
||||
export interface SystemOperations {
|
||||
readonly operatingSystem: OperatingSystemOps;
|
||||
readonly location: LocationOps;
|
||||
@@ -16,7 +14,7 @@ export interface LocationOps {
|
||||
}
|
||||
|
||||
export interface CommandOps {
|
||||
exec(command: string): ReturnType<typeof exec>;
|
||||
exec(command: string): Promise<void>;
|
||||
}
|
||||
|
||||
export interface FileSystemOps {
|
||||
|
||||
@@ -128,8 +128,3 @@
|
||||
$calculated-width-in-em: calc(#{$estimated-width-per-character-in-em} * #{$value-in-ch});
|
||||
#{$property}: $calculated-width-in-em;
|
||||
}
|
||||
|
||||
@mixin base-font-style {
|
||||
font-family: $font-family-main;
|
||||
font-size: $font-size-absolute-normal;
|
||||
}
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
// Use for fixed-size elements where consistent spacing is important
|
||||
// regardless of context.
|
||||
$spacing-absolute-xx-small: 3px;
|
||||
$spacing-absolute-x-small : 4px;
|
||||
$spacing-absolute-small : 6px;
|
||||
$spacing-absolute-medium : 10px;
|
||||
$spacing-absolute-large : 15px;
|
||||
$spacing-absolute-x-large : 20px;
|
||||
$spacing-absolute-xx-large: 30px;
|
||||
|
||||
// Use for elements with text content where spacing should
|
||||
// scale with text size.
|
||||
$spacing-relative-x-small : 0.25em;
|
||||
$spacing-relative-small : 0.5em;
|
||||
$spacing-relative-medium : 1em;
|
||||
$spacing-relative-large : 2em;
|
||||
@@ -5,28 +5,26 @@
|
||||
CSS Base applies a style foundation for HTML elements that is consistent for baseline browsers
|
||||
*/
|
||||
|
||||
@use "../colors" as *;
|
||||
@use "../mixins" as *;
|
||||
@use "../vite-path" as *;
|
||||
@use "../typography" as *;
|
||||
@use "../spacing" as *;
|
||||
@use "@/presentation/assets/styles/colors" as *;
|
||||
@use "@/presentation/assets/styles/mixins" as *;
|
||||
@use "@/presentation/assets/styles/vite-path" as *;
|
||||
@use "@/presentation/assets/styles/typography" as *;
|
||||
@use "_code-styling" as *;
|
||||
@use "_margin-padding" as *;
|
||||
@use "_link-styling" as *;
|
||||
@use "_prevent-scrollbar-layout-shift" as *;
|
||||
|
||||
$base-spacing: 1em;
|
||||
|
||||
* {
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html {
|
||||
@include prevent-scrollbar-layout-shift;
|
||||
}
|
||||
|
||||
body {
|
||||
background: $color-background;
|
||||
@include base-font-style;
|
||||
@include apply-uniform-spacing;
|
||||
font-family: $font-family-main;
|
||||
font-size: $font-size-absolute-normal;
|
||||
|
||||
@include apply-uniform-spacing($base-spacing: $base-spacing)
|
||||
}
|
||||
|
||||
input {
|
||||
@@ -34,12 +32,12 @@ input {
|
||||
}
|
||||
|
||||
blockquote {
|
||||
padding: 0 $spacing-relative-medium;
|
||||
border-left: $spacing-absolute-x-small solid $color-primary;
|
||||
padding: 0 $base-spacing;
|
||||
border-left: .25em solid $color-primary;
|
||||
}
|
||||
|
||||
@include style-code-elements(
|
||||
$code-block-padding: $spacing-relative-medium,
|
||||
$code-block-padding: $base-spacing,
|
||||
$color-background: $color-primary-darker,
|
||||
);
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
@use 'sass:math';
|
||||
@use "../spacing" as *;
|
||||
|
||||
@mixin no-margin($selectors) {
|
||||
#{$selectors} {
|
||||
@@ -27,7 +26,7 @@
|
||||
}
|
||||
}
|
||||
|
||||
@mixin apply-uniform-vertical-spacing {
|
||||
@mixin apply-uniform-vertical-spacing($base-vertical-spacing) {
|
||||
/* Reset default top/bottom margins added by browser. */
|
||||
@include no-margin('p');
|
||||
@include no-margin('h1, h2, h3, h4, h5, h6');
|
||||
@@ -37,27 +36,29 @@
|
||||
@include no-margin('ul, ol');
|
||||
|
||||
/* Add spacing between elements using `margin-bottom` only (bottom-up instead of top-down strategy). */
|
||||
@include bottom-margin('p', $spacing-relative-medium);
|
||||
@include bottom-margin('li > p', $spacing-relative-small); // Reduce margin for paragraphs directly within list items to visually group related content.
|
||||
@include bottom-margin('h1, h2, h3, h4, h5, h6', $spacing-relative-small);
|
||||
@include bottom-margin('ul, ol', $spacing-relative-medium);
|
||||
@include bottom-margin('li', $spacing-relative-small);
|
||||
@include bottom-margin('table', $spacing-relative-medium);
|
||||
@include bottom-margin('blockquote', $spacing-relative-medium);
|
||||
@include bottom-margin('pre', $spacing-relative-medium);
|
||||
@include bottom-margin('article', $spacing-relative-medium);
|
||||
@include bottom-margin('hr', $spacing-relative-medium);
|
||||
$small-vertical-spacing: math.div($base-vertical-spacing, 2);
|
||||
@include bottom-margin('p', $base-vertical-spacing);
|
||||
@include bottom-margin('li > p', $small-vertical-spacing); // Reduce margin for paragraphs directly within list items to visually group related content.
|
||||
@include bottom-margin('h1, h2, h3, h4, h5, h6', $small-vertical-spacing);
|
||||
@include bottom-margin('ul, ol', $base-vertical-spacing);
|
||||
@include bottom-margin('li', $small-vertical-spacing);
|
||||
@include bottom-margin('table', $base-vertical-spacing);
|
||||
@include bottom-margin('blockquote', $base-vertical-spacing);
|
||||
@include bottom-margin('pre', $base-vertical-spacing);
|
||||
@include bottom-margin('article', $base-vertical-spacing);
|
||||
@include bottom-margin('hr', $base-vertical-spacing);
|
||||
}
|
||||
|
||||
@mixin apply-uniform-horizontal-spacing {
|
||||
@mixin apply-uniform-horizontal-spacing($base-horizontal-spacing) {
|
||||
/* Reset default left/right paddings added by browser. */
|
||||
@include no-padding('ul, ol');
|
||||
|
||||
/* Add spacing for list items. */
|
||||
@include left-padding('ul, ol', $spacing-relative-large);
|
||||
$large-horizontal-spacing: $base-horizontal-spacing * 2;
|
||||
@include left-padding('ul, ol', $large-horizontal-spacing);
|
||||
}
|
||||
|
||||
@mixin apply-uniform-spacing {
|
||||
@include apply-uniform-vertical-spacing;
|
||||
@include apply-uniform-horizontal-spacing;
|
||||
@mixin apply-uniform-spacing($base-spacing) {
|
||||
@include apply-uniform-vertical-spacing($base-spacing);
|
||||
@include apply-uniform-horizontal-spacing($base-spacing);
|
||||
}
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
// This mixin prevents layout shifts caused by the appearance of a vertical scrollbar
|
||||
// in Chromium-based browsers on Linux and Windows.
|
||||
// It creates a reserved space for the scrollbar, ensuring content remains stable and does
|
||||
// not shift horizontally when the scrollbar appears.
|
||||
@mixin prevent-scrollbar-layout-shift {
|
||||
scrollbar-gutter: stable;
|
||||
|
||||
@supports not (scrollbar-gutter: stable) { // https://caniuse.com/mdn-css_properties_scrollbar-gutter
|
||||
// Safari workaround: Shift content to accommodate non-overlay scrollbar.
|
||||
// An issue: On small screens, the appearance of the scrollbar can shift content, due to limited space for
|
||||
// both content and scrollbar.
|
||||
$full-width-including-scrollbar: 100vw;
|
||||
$full-width-excluding-scrollbar: 100%;
|
||||
$scrollbar-width: calc($full-width-including-scrollbar - $full-width-excluding-scrollbar);
|
||||
padding-inline-start: $scrollbar-width; // Allows both right-to-left (RTL) and left-to-right (LTR) text direction support
|
||||
}
|
||||
|
||||
// More details: https://web.archive.org/web/20240509122237/https://stackoverflow.com/questions/1417934/how-to-prevent-scrollbar-from-repositioning-web-page
|
||||
}
|
||||
1
src/presentation/assets/styles/components/_card.scss
Normal file
1
src/presentation/assets/styles/components/_card.scss
Normal file
@@ -0,0 +1 @@
|
||||
$card-gap: 15px;
|
||||
@@ -5,5 +5,6 @@
|
||||
@forward "./media";
|
||||
@forward "./colors";
|
||||
@forward "./base";
|
||||
@forward "./spacing";
|
||||
@forward "./mixins";
|
||||
|
||||
@forward "./components/card";
|
||||
|
||||
@@ -16,7 +16,6 @@ import { useCodeRunner } from '@/presentation/components/Shared/Hooks/UseCodeRun
|
||||
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||
import { useDialog } from '@/presentation/components/Shared/Hooks/Dialog/UseDialog';
|
||||
import { useScriptDiagnosticsCollector } from '@/presentation/components/Shared/Hooks/UseScriptDiagnosticsCollector';
|
||||
import { useAutoUnsubscribedEventListener } from '@/presentation/components/Shared/Hooks/UseAutoUnsubscribedEventListener';
|
||||
|
||||
export function provideDependencies(
|
||||
context: IApplicationContext,
|
||||
@@ -78,10 +77,6 @@ export function provideDependencies(
|
||||
InjectionKeys.useScriptDiagnosticsCollector,
|
||||
useScriptDiagnosticsCollector,
|
||||
),
|
||||
useAutoUnsubscribedEventListener: (di) => di.provide(
|
||||
InjectionKeys.useAutoUnsubscribedEventListener,
|
||||
useAutoUnsubscribedEventListener,
|
||||
),
|
||||
};
|
||||
registerAll(Object.values(resolvers), api);
|
||||
}
|
||||
|
||||
@@ -50,48 +50,24 @@ function getOptionalDevToolkitComponent(): Component | undefined {
|
||||
|
||||
<style lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
@use 'sass:math';
|
||||
|
||||
@mixin responsive-spacing {
|
||||
// Avoid using percentage-based values for spacing the avoid unintended layout shifts.
|
||||
margin-left: $spacing-absolute-medium;
|
||||
margin-right: $spacing-absolute-medium;
|
||||
padding: $spacing-absolute-xx-large;
|
||||
@media screen and (max-width: $media-screen-big-width) {
|
||||
margin-left: $spacing-absolute-small;
|
||||
margin-right: $spacing-absolute-small;
|
||||
padding: $spacing-absolute-x-large;
|
||||
}
|
||||
@media screen and (max-width: $media-screen-medium-width) {
|
||||
margin-left: $spacing-absolute-x-small;
|
||||
margin-right: $spacing-absolute-x-small;
|
||||
padding: $spacing-absolute-medium;
|
||||
}
|
||||
@media screen and (max-width: $media-screen-small-width) {
|
||||
margin-left: 0;
|
||||
margin-right: 0;
|
||||
padding: $spacing-absolute-small;
|
||||
}
|
||||
}
|
||||
|
||||
#app {
|
||||
margin-right: auto;
|
||||
margin-left: auto;
|
||||
max-width: 1600px;
|
||||
.app__wrapper {
|
||||
margin: 0% 2% 0% 2%;
|
||||
background-color: $color-surface;
|
||||
color: $color-on-surface;
|
||||
box-shadow: 0 0 5px 0 rgba(0, 0, 0, 0.06);
|
||||
|
||||
@include responsive-spacing;
|
||||
|
||||
padding: 2%;
|
||||
display:flex;
|
||||
flex-direction: column;
|
||||
.app__row {
|
||||
margin-bottom: $spacing-absolute-large;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
.app__code-buttons {
|
||||
padding-bottom: $spacing-absolute-medium;
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,7 +11,6 @@
|
||||
import { defineComponent, computed } from 'vue';
|
||||
import { injectKey } from '@/presentation/injectionSymbols';
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import type { CodeRunError } from '@/application/CodeRunner/CodeRunner';
|
||||
import IconButton from './IconButton.vue';
|
||||
import { createScriptErrorDialog } from './ScriptErrorDialog';
|
||||
|
||||
@@ -39,19 +38,15 @@ export default defineComponent({
|
||||
currentContext.state.collection.scripting.fileExtension,
|
||||
);
|
||||
if (!success) {
|
||||
await handleCodeRunFailure(error);
|
||||
dialog.showError(...(await createScriptErrorDialog({
|
||||
errorContext: 'run',
|
||||
errorType: error.type,
|
||||
errorMessage: error.message,
|
||||
isFileReadbackError: error.type === 'FileReadbackVerificationError',
|
||||
}, scriptDiagnosticsCollector)));
|
||||
}
|
||||
}
|
||||
|
||||
async function handleCodeRunFailure(error: CodeRunError) {
|
||||
dialog.showError(...(await createScriptErrorDialog({
|
||||
errorContext: 'run',
|
||||
errorType: error.type,
|
||||
errorMessage: error.message,
|
||||
isFileReadbackError: error.type === 'FileReadbackVerificationError',
|
||||
}, scriptDiagnosticsCollector)));
|
||||
}
|
||||
|
||||
return {
|
||||
canRun,
|
||||
runCode,
|
||||
|
||||
@@ -74,6 +74,7 @@ export default defineComponent({
|
||||
color: $color-on-secondary;
|
||||
|
||||
border: none;
|
||||
padding: 20px;
|
||||
transition-duration: 0.4s;
|
||||
overflow: hidden;
|
||||
box-shadow: 0 3px 9px $color-primary-darkest;
|
||||
|
||||
@@ -54,14 +54,14 @@ export default defineComponent({
|
||||
|
||||
.copyable-command {
|
||||
display: inline-flex;
|
||||
padding: $spacing-relative-x-small;
|
||||
padding: 0.25em;
|
||||
font-size: $font-size-absolute-small;
|
||||
.dollar {
|
||||
margin-right: $spacing-relative-small;
|
||||
margin-right: 0.5rem;
|
||||
user-select: none;
|
||||
}
|
||||
.copy-action-container {
|
||||
margin-left: $spacing-relative-medium;
|
||||
margin-left: 1rem;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
import { defineComponent } from 'vue';
|
||||
|
||||
export default defineComponent({
|
||||
// Empty component for ESLint compatibility, workaround for https://github.com/vuejs/vue-eslint-parser/issues/125.
|
||||
name: 'InstructionSteps', // Define component name for empty component for Vue build and ESLint compatibility.
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
@@ -8,6 +8,6 @@
|
||||
import { defineComponent } from 'vue';
|
||||
|
||||
export default defineComponent({
|
||||
// Empty component for ESLint compatibility, workaround for https://github.com/vuejs/vue-eslint-parser/issues/125.
|
||||
name: 'InstructionSteps', // Define component name for empty component for Vue build and ESLint compatibility.
|
||||
});
|
||||
</script>
|
||||
|
||||
@@ -1,28 +1,21 @@
|
||||
import type { CodeRunErrorType } from '@/application/CodeRunner/CodeRunner';
|
||||
import type { ScriptDiagnosticData, ScriptDiagnosticsCollector } from '@/application/ScriptDiagnostics/ScriptDiagnosticsCollector';
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import type { Dialog, SaveFileErrorType } from '@/presentation/common/Dialog';
|
||||
|
||||
type ErrorDialogParameters = Parameters<Dialog['showError']>;
|
||||
import type { Dialog } from '@/presentation/common/Dialog';
|
||||
|
||||
export async function createScriptErrorDialog(
|
||||
information: ScriptErrorDetails,
|
||||
scriptDiagnosticsCollector: ScriptDiagnosticsCollector | undefined,
|
||||
): Promise<ErrorDialogParameters> {
|
||||
): Promise<Parameters<Dialog['showError']>> {
|
||||
const diagnostics = await scriptDiagnosticsCollector?.collectDiagnosticInformation();
|
||||
if (information.isFileReadbackError) {
|
||||
return createAntivirusErrorDialog(information, diagnostics);
|
||||
}
|
||||
if (information.errorContext === 'run'
|
||||
&& information.errorType === 'ExternalProcessTermination') {
|
||||
return createScriptInterruptedDialog(information);
|
||||
}
|
||||
return createGenericErrorDialog(information, diagnostics);
|
||||
}
|
||||
|
||||
export interface ScriptErrorDetails {
|
||||
readonly errorContext: 'run' | 'save';
|
||||
readonly errorType: CodeRunErrorType | SaveFileErrorType;
|
||||
readonly errorType: string;
|
||||
readonly errorMessage: string;
|
||||
readonly isFileReadbackError: boolean;
|
||||
}
|
||||
@@ -30,7 +23,7 @@ export interface ScriptErrorDetails {
|
||||
function createGenericErrorDialog(
|
||||
information: ScriptErrorDetails,
|
||||
diagnostics: ScriptDiagnosticData | undefined,
|
||||
): ErrorDialogParameters {
|
||||
): Parameters<Dialog['showError']> {
|
||||
return [
|
||||
selectBasedOnErrorContext({
|
||||
runningScript: 'Error Running Script',
|
||||
@@ -73,7 +66,7 @@ function createGenericErrorDialog(
|
||||
function createAntivirusErrorDialog(
|
||||
information: ScriptErrorDetails,
|
||||
diagnostics: ScriptDiagnosticData | undefined,
|
||||
): ErrorDialogParameters {
|
||||
): Parameters<Dialog['showError']> {
|
||||
const defenderSteps = generateDefenderSteps(information, diagnostics);
|
||||
return [
|
||||
'Possible Antivirus Script Block',
|
||||
@@ -124,33 +117,6 @@ function createAntivirusErrorDialog(
|
||||
];
|
||||
}
|
||||
|
||||
function createScriptInterruptedDialog(
|
||||
information: ScriptErrorDetails,
|
||||
): ErrorDialogParameters {
|
||||
return [
|
||||
'Script Stopped',
|
||||
[
|
||||
'The script stopped before it could finish.',
|
||||
'This happens if the script is cancelled manually or if the system terminates the process.',
|
||||
'\n',
|
||||
generateUnorderedSolutionList({
|
||||
title: 'To ensure successful script completion:',
|
||||
solutions: [
|
||||
'Keep the terminal window open during script execution.',
|
||||
'If the script closed unexpectedly, try running it again.',
|
||||
'Check for sufficient memory (RAM) and system resources.',
|
||||
'Avoid running tasks that might disrupt the script.',
|
||||
],
|
||||
}),
|
||||
'\n',
|
||||
'If you intentionally stopped the script, ignore this message.',
|
||||
'Reach out to the community for further assistance.',
|
||||
'\n',
|
||||
generateTechnicalDetails(information),
|
||||
].join('\n'),
|
||||
];
|
||||
}
|
||||
|
||||
interface SolutionListOptions {
|
||||
readonly solutions: readonly string[];
|
||||
readonly title: string;
|
||||
|
||||
@@ -34,15 +34,12 @@ export default defineComponent({
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
.container {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
justify-content: center;
|
||||
gap: $spacing-absolute-xx-large;
|
||||
gap: 30px;
|
||||
}
|
||||
|
||||
.code-button {
|
||||
width: 10%;
|
||||
min-width: 90px;
|
||||
|
||||
@@ -31,7 +31,6 @@ import { defineComponent, ref } from 'vue';
|
||||
import { injectKey } from '@/presentation/injectionSymbols';
|
||||
import FlatButton from '@/presentation/components/Shared/FlatButton.vue';
|
||||
import { dumpNames } from './DumpNames';
|
||||
import { useScrollbarGutterWidth } from './UseScrollbarGutterWidth';
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
@@ -40,7 +39,6 @@ export default defineComponent({
|
||||
setup() {
|
||||
const { log } = injectKey((keys) => keys.useLogger);
|
||||
const isOpen = ref(true);
|
||||
const scrollbarGutterWidth = useScrollbarGutterWidth();
|
||||
|
||||
const devActions: readonly DevAction[] = [
|
||||
{
|
||||
@@ -60,7 +58,6 @@ export default defineComponent({
|
||||
devActions,
|
||||
isOpen,
|
||||
close,
|
||||
scrollbarGutterWidth,
|
||||
};
|
||||
},
|
||||
});
|
||||
@@ -74,17 +71,13 @@ interface DevAction {
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
$viewport-edge-offset: $spacing-absolute-large; // close to Chromium gutter width (15px)
|
||||
|
||||
.dev-toolkit-container {
|
||||
position: fixed;
|
||||
|
||||
top: $viewport-edge-offset;
|
||||
right: max(v-bind(scrollbarGutterWidth), $viewport-edge-offset);
|
||||
|
||||
top: 0;
|
||||
right: 0;
|
||||
background-color: rgba($color-on-surface, 0.5);
|
||||
color: $color-on-primary;
|
||||
padding: $spacing-absolute-medium;
|
||||
padding: 10px;
|
||||
z-index: 10000;
|
||||
|
||||
display:flex;
|
||||
@@ -120,14 +113,14 @@ $viewport-edge-offset: $spacing-absolute-large; // close to Chromium gutter widt
|
||||
.action-buttons {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: $spacing-absolute-medium;
|
||||
gap: 10px;
|
||||
@include reset-ul;
|
||||
|
||||
.action-button {
|
||||
@include reset-button;
|
||||
|
||||
display: block;
|
||||
padding: $spacing-absolute-x-small $spacing-absolute-medium;
|
||||
padding: 5px 10px;
|
||||
background-color: $color-primary;
|
||||
color: $color-on-primary;
|
||||
border: none;
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
import {
|
||||
computed, readonly, ref, watch,
|
||||
} from 'vue';
|
||||
import { throttle } from '@/application/Common/Timing/Throttle';
|
||||
import { useAutoUnsubscribedEventListener } from '../Shared/Hooks/UseAutoUnsubscribedEventListener';
|
||||
|
||||
const RESIZE_EVENT_THROTTLE_MS = 200;
|
||||
|
||||
export function useScrollbarGutterWidth() {
|
||||
const scrollbarWidthInPx = ref(getScrollbarGutterWidth());
|
||||
|
||||
const { startListening } = useAutoUnsubscribedEventListener();
|
||||
startListening(window, 'resize', throttle(() => {
|
||||
scrollbarWidthInPx.value = getScrollbarGutterWidth();
|
||||
}, RESIZE_EVENT_THROTTLE_MS));
|
||||
|
||||
const bodyWidth = useBodyWidth();
|
||||
watch(() => bodyWidth.value, () => {
|
||||
scrollbarWidthInPx.value = getScrollbarGutterWidth();
|
||||
}, { immediate: false });
|
||||
|
||||
const scrollbarWidthStyle = computed(() => `${scrollbarWidthInPx.value}px`);
|
||||
return readonly(scrollbarWidthStyle);
|
||||
}
|
||||
|
||||
function getScrollbarGutterWidth(): number {
|
||||
return document.documentElement.clientWidth - document.documentElement.offsetWidth;
|
||||
}
|
||||
|
||||
function useBodyWidth() {
|
||||
const width = ref(document.body.offsetWidth);
|
||||
const observer = new ResizeObserver((entries) => throttle(() => {
|
||||
for (const entry of entries) {
|
||||
width.value = entry.borderBoxSize[0].inlineSize;
|
||||
}
|
||||
}, RESIZE_EVENT_THROTTLE_MS));
|
||||
observer.observe(document.body, { box: 'border-box' });
|
||||
return readonly(width);
|
||||
}
|
||||
@@ -25,7 +25,7 @@ export default defineComponent({
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
$gap: $spacing-relative-x-small;
|
||||
$gap: 0.25rem;
|
||||
.list {
|
||||
display: flex;
|
||||
:deep(.items) {
|
||||
|
||||
@@ -37,10 +37,8 @@ export default defineComponent({
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
.circle-rating {
|
||||
display: inline-flex;
|
||||
gap: $spacing-relative-x-small;
|
||||
gap: 0.2em;
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -1,17 +1,19 @@
|
||||
<template>
|
||||
<span class="circle-container">
|
||||
<svg :viewBox="viewBox">
|
||||
<circle
|
||||
:cx="circleRadiusInPx"
|
||||
:cy="circleRadiusInPx"
|
||||
:r="circleRadiusWithoutStrokeInPx"
|
||||
:stroke-width="circleStrokeWidthStyleValue"
|
||||
:class="{
|
||||
filled,
|
||||
}"
|
||||
/>
|
||||
</svg>
|
||||
</span>
|
||||
<svg
|
||||
:style="{
|
||||
'--circle-stroke-width': `${circleStrokeWidthInPx}px`,
|
||||
}"
|
||||
:viewBox="viewBox"
|
||||
>
|
||||
<circle
|
||||
:cx="circleRadiusInPx"
|
||||
:cy="circleRadiusInPx"
|
||||
:r="circleRadiusWithoutStrokeInPx"
|
||||
:class="{
|
||||
filled,
|
||||
}"
|
||||
/>
|
||||
</svg>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
@@ -41,13 +43,10 @@ export default defineComponent({
|
||||
const height = circleDiameterInPx + circleStrokeWidthInPx;
|
||||
return `${minX} ${minY} ${width} ${height}`;
|
||||
});
|
||||
const circleStrokeWidthStyleValue = computed(() => {
|
||||
return `${circleStrokeWidthInPx}px`;
|
||||
});
|
||||
return {
|
||||
circleRadiusInPx,
|
||||
circleDiameterInPx,
|
||||
circleStrokeWidthStyleValue,
|
||||
circleStrokeWidthInPx,
|
||||
circleRadiusWithoutStrokeInPx,
|
||||
viewBox,
|
||||
};
|
||||
@@ -56,18 +55,17 @@ export default defineComponent({
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
$circle-color: currentColor;
|
||||
$circle-height: $font-size-relative-smaller;
|
||||
$circleColor: currentColor;
|
||||
$circleHeight: 0.8em;
|
||||
$circleStrokeWidth: var(--circle-stroke-width);
|
||||
|
||||
svg {
|
||||
font-size: $circle-height;
|
||||
height: 1em;
|
||||
height: $circleHeight;
|
||||
circle {
|
||||
stroke: $circle-color;
|
||||
stroke: $circleColor;
|
||||
stroke-width: $circleStrokeWidth;
|
||||
&.filled {
|
||||
fill: $circle-color;
|
||||
fill: $circleColor;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -88,7 +88,7 @@ export default defineComponent({
|
||||
|
||||
@mixin horizontal-stack {
|
||||
display: flex;
|
||||
gap: $spacing-relative-small;
|
||||
gap: 0.5em;
|
||||
}
|
||||
|
||||
@mixin apply-icon-color($color) {
|
||||
|
||||
@@ -55,7 +55,7 @@ export default defineComponent({
|
||||
|
||||
@mixin horizontal-stack {
|
||||
display: flex;
|
||||
gap: $spacing-relative-small;
|
||||
gap: 0.5em;
|
||||
}
|
||||
|
||||
@mixin apply-icon-color($color) {
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
<template>
|
||||
<div class="scripts-menu">
|
||||
<div class="scripts-menu-item scripts-menu-rows">
|
||||
<TheRecommendationSelector class="scripts-menu-item" />
|
||||
<TheRevertSelector class="scripts-menu-item" />
|
||||
<div id="container">
|
||||
<div class="item rows">
|
||||
<TheRecommendationSelector class="item" />
|
||||
<TheRevertSelector class="item" />
|
||||
</div>
|
||||
<TheOsChanger class="scripts-menu-item" />
|
||||
<TheOsChanger class="item" />
|
||||
<TheViewChanger
|
||||
v-if="!isSearching"
|
||||
class="scripts-menu-item"
|
||||
class="item"
|
||||
@view-changed="$emit('viewChanged', $event)"
|
||||
/>
|
||||
</div>
|
||||
@@ -67,44 +67,29 @@ export default defineComponent({
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
@use 'sass:math';
|
||||
|
||||
@mixin center-middle-flex-item {
|
||||
&:first-child, &:last-child {
|
||||
flex-grow: 1;
|
||||
flex-basis: 0;
|
||||
}
|
||||
&:last-child {
|
||||
justify-content: flex-end;
|
||||
}
|
||||
}
|
||||
|
||||
$responsive-alignment-breakpoint: $media-screen-medium-width;
|
||||
|
||||
.scripts-menu {
|
||||
$margin-between-lines: 7px;
|
||||
#container {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
column-gap: $spacing-relative-medium;
|
||||
row-gap: $spacing-relative-small;
|
||||
flex-wrap: wrap;
|
||||
align-items: center;
|
||||
margin-left: $spacing-absolute-small;
|
||||
margin-right: $spacing-absolute-small;
|
||||
@media screen and (max-width: $responsive-alignment-breakpoint) {
|
||||
justify-content: space-around;
|
||||
}
|
||||
.scripts-menu-item {
|
||||
margin-top: -$margin-between-lines;
|
||||
.item {
|
||||
flex: 1;
|
||||
white-space: nowrap;
|
||||
display: flex;
|
||||
@media screen and (min-width: $responsive-alignment-breakpoint) {
|
||||
@include center-middle-flex-item;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
margin: $margin-between-lines 5px 0 5px;
|
||||
&:first-child {
|
||||
justify-content: flex-start;
|
||||
}
|
||||
&:last-child {
|
||||
justify-content: flex-end;
|
||||
}
|
||||
}
|
||||
.scripts-menu-rows {
|
||||
.rows {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: flex-start;
|
||||
row-gap: $spacing-relative-x-small;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
<template>
|
||||
<div class="slider">
|
||||
<div
|
||||
class="slider"
|
||||
:style="{
|
||||
'--vertical-margin': verticalMargin,
|
||||
'--first-min-width': firstMinWidth,
|
||||
'--first-initial-width': firstInitialWidth,
|
||||
'--second-min-width': secondMinWidth,
|
||||
}"
|
||||
>
|
||||
<div ref="firstElement" class="first">
|
||||
<slot name="first" />
|
||||
</div>
|
||||
@@ -19,6 +27,10 @@ export default defineComponent({
|
||||
SliderHandle,
|
||||
},
|
||||
props: {
|
||||
verticalMargin: {
|
||||
type: String,
|
||||
required: true,
|
||||
},
|
||||
firstMinWidth: {
|
||||
type: String,
|
||||
required: true,
|
||||
@@ -59,18 +71,21 @@ export default defineComponent({
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
.first {
|
||||
min-width: v-bind(firstMinWidth);
|
||||
width: v-bind(firstInitialWidth);
|
||||
min-width: var(--first-min-width);
|
||||
width: var(--first-initial-width);
|
||||
}
|
||||
.second {
|
||||
flex: 1;
|
||||
min-width: v-bind(secondMinWidth);
|
||||
min-width: var(--second-min-width);
|
||||
}
|
||||
@media screen and (max-width: $media-vertical-view-breakpoint) {
|
||||
flex-direction: column;
|
||||
.first {
|
||||
width: auto !important;
|
||||
}
|
||||
.second {
|
||||
margin-top: var(--vertical-margin);
|
||||
}
|
||||
.handle {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@@ -81,7 +81,7 @@ $cursor : v-bind(cursorCssValue);
|
||||
.icon {
|
||||
color: $color;
|
||||
}
|
||||
margin-right: $spacing-absolute-small;
|
||||
margin-left: $spacing-absolute-small;
|
||||
margin-right: 5px;
|
||||
margin-left: 5px;
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
<div class="script-area">
|
||||
<TheScriptsMenu @view-changed="currentView = $event" />
|
||||
<HorizontalResizeSlider
|
||||
class="horizontal-slider"
|
||||
class="row"
|
||||
vertical-margin="15px"
|
||||
first-initial-width="55%"
|
||||
first-min-width="20%"
|
||||
second-min-width="20%"
|
||||
@@ -41,17 +42,9 @@ export default defineComponent({
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
.script-area {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: $spacing-absolute-medium;
|
||||
}
|
||||
|
||||
.horizontal-slider {
|
||||
// Add row gap between lines on mobile (smaller screens)
|
||||
// when the slider turns into rows.
|
||||
row-gap: $spacing-absolute-large;
|
||||
gap: 6px;
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
<template>
|
||||
<transition name="card-expand-collapse-transition">
|
||||
<slot />
|
||||
</transition>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent } from 'vue';
|
||||
|
||||
export default defineComponent({
|
||||
// Empty component for ESLint compatibility, workaround for https://github.com/vuejs/vue-eslint-parser/issues/125.
|
||||
});
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
.card-expand-collapse-transition-enter-active {
|
||||
transition:
|
||||
opacity 0.3s ease-in-out,
|
||||
max-height 0.3s ease-in-out;
|
||||
}
|
||||
|
||||
.card-expand-collapse-transition-enter-from {
|
||||
opacity: 0; // Fade-in
|
||||
max-height: 0; // Expand
|
||||
}
|
||||
</style>
|
||||
@@ -1,32 +0,0 @@
|
||||
<template>
|
||||
<div class="arrow-container">
|
||||
<div class="arrow" />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent } from 'vue';
|
||||
|
||||
export default defineComponent({
|
||||
// Empty component for ESLint compatibility, workaround for https://github.com/vuejs/vue-eslint-parser/issues/125.
|
||||
});
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
$arrow-size: $font-size-absolute-normal;
|
||||
|
||||
.arrow-container {
|
||||
position: relative;
|
||||
.arrow {
|
||||
position: absolute;
|
||||
left: calc(50% - $arrow-size * 1.5);
|
||||
top: calc(-0.35 * $arrow-size);
|
||||
border: solid $color-primary-darker;
|
||||
border-width: 0 $arrow-size $arrow-size 0;
|
||||
padding: $arrow-size;
|
||||
transform: rotate(-135deg);
|
||||
}
|
||||
}
|
||||
</style>
|
||||
@@ -40,7 +40,7 @@
|
||||
|
||||
<script lang="ts">
|
||||
import {
|
||||
defineComponent, ref, computed,
|
||||
defineComponent, ref, onMounted, onUnmounted, computed,
|
||||
} from 'vue';
|
||||
import { injectKey } from '@/presentation/injectionSymbols';
|
||||
import SizeObserver from '@/presentation/components/Shared/SizeObserver.vue';
|
||||
@@ -54,7 +54,6 @@ export default defineComponent({
|
||||
},
|
||||
setup() {
|
||||
const { currentState, onStateChange } = injectKey((keys) => keys.useCollectionState);
|
||||
const { startListening } = injectKey((keys) => keys.useAutoUnsubscribedEventListener);
|
||||
|
||||
const width = ref<number | undefined>();
|
||||
|
||||
@@ -71,7 +70,7 @@ export default defineComponent({
|
||||
collapseAllCards();
|
||||
}, { immediate: true });
|
||||
|
||||
startListening(document, 'click', (event) => {
|
||||
const outsideClickListener = (event: PointerEvent): void => {
|
||||
if (areAllCardsCollapsed()) {
|
||||
return;
|
||||
}
|
||||
@@ -80,6 +79,14 @@ export default defineComponent({
|
||||
if (element && !element.contains(target)) {
|
||||
onOutsideOfActiveCardClicked(target);
|
||||
}
|
||||
};
|
||||
|
||||
onMounted(() => {
|
||||
document.addEventListener('click', outsideClickListener);
|
||||
});
|
||||
|
||||
onUnmounted(() => {
|
||||
document.removeEventListener('click', outsideClickListener);
|
||||
});
|
||||
|
||||
function onOutsideOfActiveCardClicked(clickedElement: Element): void {
|
||||
@@ -118,7 +125,6 @@ function isClickable(element: Element) {
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
@use "./card-gap" as *;
|
||||
|
||||
.cards {
|
||||
display: flex;
|
||||
@@ -129,7 +135,7 @@ function isClickable(element: Element) {
|
||||
It ensures that there's room to grow, so the animation is shown without overflowing
|
||||
with scrollbars.
|
||||
*/
|
||||
padding: $spacing-absolute-medium;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
.error {
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
ref="cardElement"
|
||||
class="card"
|
||||
:class="{
|
||||
'is-collapsed': !isExpanded,
|
||||
'is-inactive': activeCategoryId && activeCategoryId !== categoryId,
|
||||
'is-expanded': isExpanded,
|
||||
}"
|
||||
@@ -28,28 +29,20 @@
|
||||
:category-id="categoryId"
|
||||
/>
|
||||
</div>
|
||||
<CardExpandTransition>
|
||||
<div v-show="isExpanded">
|
||||
<CardExpansionArrow />
|
||||
<div
|
||||
class="card__expander"
|
||||
@click.stop
|
||||
>
|
||||
<div class="card__expander__close-button">
|
||||
<FlatButton
|
||||
icon="xmark"
|
||||
@click="collapse()"
|
||||
/>
|
||||
</div>
|
||||
<div class="card__expander__content">
|
||||
<ScriptsTree
|
||||
:category-id="categoryId"
|
||||
:has-top-padding="false"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card__expander" @click.stop>
|
||||
<div class="card__expander__close-button">
|
||||
<FlatButton
|
||||
icon="xmark"
|
||||
@click="collapse()"
|
||||
/>
|
||||
</div>
|
||||
</CardExpandTransition>
|
||||
<div class="card__expander__content">
|
||||
<ScriptsTree
|
||||
:category-id="categoryId"
|
||||
:has-top-padding="false"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
@@ -63,8 +56,6 @@ import { injectKey } from '@/presentation/injectionSymbols';
|
||||
import ScriptsTree from '@/presentation/components/Scripts/View/Tree/ScriptsTree.vue';
|
||||
import { sleep } from '@/infrastructure/Threading/AsyncSleep';
|
||||
import CardSelectionIndicator from './CardSelectionIndicator.vue';
|
||||
import CardExpandTransition from './CardExpandTransition.vue';
|
||||
import CardExpansionArrow from './CardExpansionArrow.vue';
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
@@ -72,8 +63,6 @@ export default defineComponent({
|
||||
AppIcon,
|
||||
CardSelectionIndicator,
|
||||
FlatButton,
|
||||
CardExpandTransition,
|
||||
CardExpansionArrow,
|
||||
},
|
||||
props: {
|
||||
categoryId: {
|
||||
@@ -138,14 +127,16 @@ export default defineComponent({
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
@use "./card-gap" as *;
|
||||
|
||||
$card-inner-padding : $spacing-absolute-xx-large;
|
||||
$expanded-margin-top : $spacing-absolute-xx-large;
|
||||
$card-inner-padding : 30px;
|
||||
$arrow-size : 15px;
|
||||
$expanded-margin-top : 30px;
|
||||
$card-horizontal-gap : $card-gap;
|
||||
|
||||
.card {
|
||||
.card__inner {
|
||||
transition: all 0.2s ease-in-out;
|
||||
|
||||
&__inner {
|
||||
padding-top: $card-inner-padding;
|
||||
padding-right: $card-inner-padding;
|
||||
padding-bottom: 0;
|
||||
@@ -158,7 +149,7 @@ $card-horizontal-gap : $card-gap;
|
||||
width: 100%;
|
||||
text-transform: uppercase;
|
||||
text-align: center;
|
||||
transition: transform 0.2s ease-in-out;
|
||||
transition: all 0.2s ease-in-out;
|
||||
|
||||
display:flex;
|
||||
flex-direction: column;
|
||||
@@ -169,6 +160,9 @@ $card-horizontal-gap : $card-gap;
|
||||
color: $color-on-secondary;
|
||||
transform: scale(1.05);
|
||||
}
|
||||
&:after {
|
||||
transition: all 0.3s ease-in-out;
|
||||
}
|
||||
.card__inner__title {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
@@ -179,18 +173,19 @@ $card-horizontal-gap : $card-gap;
|
||||
.card__inner__selection_indicator {
|
||||
height: $card-inner-padding;
|
||||
margin-right: -$card-inner-padding;
|
||||
padding-right: $spacing-absolute-medium;
|
||||
padding-right: 10px;
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
}
|
||||
.card__inner__expand-icon {
|
||||
width: 100%;
|
||||
margin-top: $spacing-relative-x-small;
|
||||
margin-top: .25em;
|
||||
vertical-align: middle;
|
||||
font-size: $font-size-absolute-normal;
|
||||
}
|
||||
}
|
||||
.card__expander {
|
||||
transition: all 0.2s ease-in-out;
|
||||
position: relative;
|
||||
background-color: $color-primary-darker;
|
||||
color: $color-on-primary;
|
||||
@@ -210,7 +205,7 @@ $card-horizontal-gap : $card-gap;
|
||||
.card__expander__close-button {
|
||||
font-size: $font-size-absolute-large;
|
||||
align-self: flex-end;
|
||||
margin-right: $spacing-absolute-small;
|
||||
margin-right: 0.25em;
|
||||
@include clickable;
|
||||
color: $color-primary-light;
|
||||
@include hover-or-touch {
|
||||
@@ -219,15 +214,43 @@ $card-horizontal-gap : $card-gap;
|
||||
}
|
||||
}
|
||||
|
||||
&.is-collapsed {
|
||||
.card__inner {
|
||||
&:after {
|
||||
content: "";
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.card__expander {
|
||||
max-height: 0;
|
||||
min-height: 0;
|
||||
overflow: hidden;
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
|
||||
&.is-expanded {
|
||||
.card__inner {
|
||||
height: auto;
|
||||
background-color: $color-secondary;
|
||||
color: $color-on-secondary;
|
||||
&:after { // arrow
|
||||
content: "";
|
||||
display: block;
|
||||
position: absolute;
|
||||
bottom: calc(-1 * #{$expanded-margin-top});
|
||||
left: calc(50% - #{$arrow-size});
|
||||
border-left: #{$arrow-size} solid transparent;
|
||||
border-right: #{$arrow-size} solid transparent;
|
||||
border-bottom: #{$arrow-size} solid $color-primary-darker;
|
||||
}
|
||||
}
|
||||
|
||||
.card__expander {
|
||||
min-height: 200px;
|
||||
margin-top: $expanded-margin-top;
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
@include hover-or-touch {
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
$card-gap: $spacing-absolute-large;
|
||||
@@ -128,7 +128,10 @@ export default defineComponent({
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
$margin-inner: 4px;
|
||||
|
||||
.scripts-view {
|
||||
margin-top: $margin-inner;
|
||||
@media screen and (min-width: $media-vertical-view-breakpoint) {
|
||||
// so the current code is always visible
|
||||
overflow: auto;
|
||||
@@ -140,17 +143,16 @@ export default defineComponent({
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
background-color: $color-scripts-bg;
|
||||
padding-top: $spacing-absolute-large;
|
||||
padding-bottom:$spacing-absolute-large;
|
||||
.search__query {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
flex-direction: row;
|
||||
align-items: center;
|
||||
margin-top: 1em;
|
||||
color: $color-primary-light;
|
||||
.search__query__close-button {
|
||||
font-size: $font-size-absolute-large;
|
||||
margin-left: $spacing-relative-x-small;
|
||||
margin-left: 0.25rem;
|
||||
}
|
||||
}
|
||||
.search-no-matches {
|
||||
@@ -159,9 +161,11 @@ export default defineComponent({
|
||||
word-break:break-word;
|
||||
color: $color-on-primary;
|
||||
font-size: $font-size-absolute-large;
|
||||
padding: $spacing-absolute-medium;
|
||||
padding:10px;
|
||||
text-align:center;
|
||||
gap: $spacing-relative-small;
|
||||
> div {
|
||||
padding-bottom:13px;
|
||||
}
|
||||
a {
|
||||
color: $color-primary;
|
||||
}
|
||||
|
||||
@@ -69,7 +69,7 @@ export default defineComponent({
|
||||
flex: 1; // Expands the container to fill available horizontal space, enabling alignment of child items.
|
||||
max-width: 100%; // Prevents horizontal expansion of inner content (e.g., when a code block is shown)
|
||||
*:not(:first-child) {
|
||||
margin-left: $spacing-absolute-small;
|
||||
margin-left: 5px;
|
||||
}
|
||||
.header {
|
||||
display: flex;
|
||||
@@ -80,10 +80,10 @@ export default defineComponent({
|
||||
}
|
||||
.docs {
|
||||
background: $color-primary-darkest;
|
||||
margin-top: $spacing-relative-x-small;
|
||||
margin-top: 0.25em;
|
||||
color: $color-on-primary;
|
||||
text-transform: none;
|
||||
padding: $spacing-absolute-medium;
|
||||
padding: 0.5em;
|
||||
&-collapsed {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import MarkdownIt from 'markdown-it';
|
||||
import type { MarkdownRenderer } from '../MarkdownRenderer';
|
||||
import type { RenderRule } from 'markdown-it/lib/renderer.mjs'; // eslint-disable-line import/extensions
|
||||
import type { RenderRule } from 'markdown-it/lib/renderer';
|
||||
|
||||
export class MarkdownItHtmlRenderer implements MarkdownRenderer {
|
||||
public render(markdownContent: string): string {
|
||||
|
||||
@@ -1,15 +1,12 @@
|
||||
<template>
|
||||
<DocumentableNode
|
||||
class="node-content-wrapper"
|
||||
:docs="nodeMetadata.docs"
|
||||
>
|
||||
<div class="node-content">
|
||||
<div class="node-content-item">
|
||||
<DocumentableNode :docs="nodeMetadata.docs">
|
||||
<div id="node">
|
||||
<div class="item">
|
||||
<NodeTitle :title="nodeMetadata.text" />
|
||||
</div>
|
||||
<RevertToggle
|
||||
v-if="nodeMetadata.isReversible"
|
||||
class="node-content-item"
|
||||
class="item"
|
||||
:node="nodeMetadata"
|
||||
/>
|
||||
</div>
|
||||
@@ -41,22 +38,13 @@ export default defineComponent({
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
.node-content-wrapper {
|
||||
/*
|
||||
Compensate word breaking when it causes overflows of the node content,
|
||||
This issue happens on small devices when nodes are being rendered during search where the node header or
|
||||
documentation grows to cause to overflow.
|
||||
*/
|
||||
overflow-wrap: anywhere;
|
||||
#node {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
flex-wrap: wrap;
|
||||
|
||||
.node-content {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
flex-wrap: wrap;
|
||||
|
||||
.node-content-item:not(:first-child) {
|
||||
margin-left: $spacing-relative-small;
|
||||
}
|
||||
.item:not(:first-child) {
|
||||
margin-left: 5px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<ToggleSwitch
|
||||
v-model="isReverted"
|
||||
:stop-click-propagation="true"
|
||||
label="Revert"
|
||||
:label="'Revert'"
|
||||
/>
|
||||
</template>
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user