mirror of
https://github.com/MasterAcnolo/Freedom-Loader.git
synced 2026-09-28 04:21:15 +02:00
Compare commits
49 Commits
39c4a69be1
...
copilot/fi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9d09cf1b5d | ||
|
|
c80d65483a | ||
|
|
d11c0f9839 | ||
|
|
1e0b2affee | ||
|
|
9975b2b583 | ||
|
|
b319a1e445 | ||
|
|
4a64a40226 | ||
|
|
2c0f5b315b | ||
|
|
58b6637eeb | ||
|
|
8af5a4a383 | ||
|
|
23f04bafc3 | ||
|
|
35ffd7077e | ||
|
|
408df0e2f6 | ||
|
|
7dee94da6f | ||
|
|
cd43ae10fc | ||
|
|
6978277b4b | ||
|
|
b91c20d450 | ||
|
|
014b1ad52a | ||
|
|
ec93d20a39 | ||
|
|
09c511fcb8 | ||
|
|
f343fbd148 | ||
|
|
6d99d5f91c | ||
|
|
0f0bb874bf | ||
|
|
b9267ec408 | ||
|
|
311bff6df5 | ||
|
|
e4243a01ae | ||
|
|
52be9c6b4f | ||
|
|
e541eb442a | ||
|
|
e2c2dde4a2 | ||
|
|
ed4022dfd1 | ||
|
|
fcbc3f95ac | ||
|
|
f3293ef89a | ||
|
|
05e864b93a | ||
|
|
8ec901dc07 | ||
|
|
104500a82a | ||
|
|
3444f2fc0b | ||
|
|
86b595beff | ||
|
|
ed6efcf812 | ||
|
|
2c84ac7a70 | ||
|
|
3c649173a2 | ||
|
|
b4d4ff2665 | ||
|
|
c2584b6df3 | ||
|
|
ec16b5209d | ||
|
|
f2f1649493 | ||
|
|
e5076b0e0b | ||
|
|
4573917541 | ||
|
|
62c109939a | ||
|
|
b56ec1e62e | ||
|
|
1a68c58ee3 |
2
.env.example
Normal file
2
.env.example
Normal file
@@ -0,0 +1,2 @@
|
||||
BUG_REPORT_URL=
|
||||
BUG_REPORT_API_KEY=
|
||||
3
.github/ISSUE_TEMPLATE/performance-issue.md
vendored
3
.github/ISSUE_TEMPLATE/performance-issue.md
vendored
@@ -29,6 +29,9 @@ Clear description of the performance issue.
|
||||
- **Storage**: [e.g. SSD/HDD]
|
||||
- **Other Applications Opened**: [e.g. Discord/Opera GX]
|
||||
|
||||
> [!INFO]
|
||||
> At the start of the application, SystemInfo is printed in the logs, so you can just copy and paste it!
|
||||
|
||||
## Reproduction Details
|
||||
|
||||
- **Download URL**: [if applicable]
|
||||
|
||||
4
.github/ISSUE_TEMPLATE/question.md
vendored
4
.github/ISSUE_TEMPLATE/question.md
vendored
@@ -9,8 +9,8 @@ assignees: 'MasterAcnolo'
|
||||
|
||||
## Pre-submission Checklist
|
||||
|
||||
- [ ] I have checked the [FAQ](https://masteracnolo.github.io/Freedom-Loader-Site/pages/faq)
|
||||
- [ ] I have reviewed the [Wiki](https://masteracnolo.github.io/Freedom-Loader-Site/pages/wiki)
|
||||
- [ ] I have checked the [FAQ](https://masteracnolo.github.io/Freedom-Loader-Site/#/faq)
|
||||
- [ ] I have reviewed the [Wiki](https://masteracnolo.github.io/Freedom-Loader-Site/#/wiki)
|
||||
- [ ] I have searched existing issues
|
||||
|
||||
## Question
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Brief description of what this PR does.
|
||||
|
||||
## Related Issue
|
||||
## Related Issue (if applicable)
|
||||
|
||||
Fixes #(issue number)
|
||||
Closes #(issue number)
|
||||
@@ -30,7 +30,7 @@ Related to #(issue number)
|
||||
- [ ] I have tested with different download scenarios (video/audio, playlists)
|
||||
- [ ] I have checked the application logs for errors
|
||||
- [ ] I have verified the UI changes (if applicable)
|
||||
- [ ] I have tested on Windows 10 and/or Windows 11
|
||||
- [ ] I have tested on Windows 10 and/or Windows 11 or in any Linux Distribution
|
||||
|
||||
## Screenshots (if applicable)
|
||||
|
||||
|
||||
46
.github/workflows/codeql.yml
vendored
Normal file
46
.github/workflows/codeql.yml
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
name: "CodeQL PR"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
schedule:
|
||||
- cron: '00 00 * * 1'
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze (${{ matrix.language }})
|
||||
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
|
||||
permissions:
|
||||
security-events: write
|
||||
packages: read
|
||||
actions: read
|
||||
contents: read
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- language: javascript-typescript
|
||||
build-mode: none
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v4
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
build-mode: ${{ matrix.build-mode }}
|
||||
|
||||
- name: Run manual build steps
|
||||
if: matrix.build-mode == 'manual'
|
||||
shell: bash
|
||||
run: |
|
||||
echo 'Manual build required'
|
||||
exit 1
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v4
|
||||
with:
|
||||
category: "/language:${{matrix.language}}"
|
||||
13
.gitignore
vendored
13
.gitignore
vendored
@@ -6,12 +6,21 @@
|
||||
/out
|
||||
/srpm-out
|
||||
|
||||
# .env
|
||||
*.env
|
||||
|
||||
# Config JSON File. Create it and fill it if you want to have dev only settings
|
||||
config/config.dev.json
|
||||
|
||||
# IDE
|
||||
/.idea
|
||||
/.vscode
|
||||
.idea/
|
||||
.vscode/
|
||||
.zed/
|
||||
|
||||
# OS generated files
|
||||
.DS_Store
|
||||
.DS_Store?
|
||||
Thumbs.db
|
||||
|
||||
# Linux executable
|
||||
ffmpeg
|
||||
|
||||
@@ -6,6 +6,7 @@ Welcome! Thanks for your interest in Freedom Loader. Your contributions—bug re
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Development Guide](DEVELOPMENT.md)
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md)
|
||||
- [Issue Templates](.github/ISSUE_TEMPLATE/)
|
||||
- [Pull Request Templates](.github/PULL_REQUEST_TEMPLATE/)
|
||||
@@ -23,7 +24,7 @@ Found a bug or unexpected behavior? Open an [**issue**](https://github.com/Maste
|
||||
- Clear description of the bug
|
||||
- Steps to reproduce
|
||||
- App version and environment (Windows version, Firefox version if relevant)
|
||||
- Logs from: `C:\Users\[USERNAME]\AppData\Local\FreedomLoader\logs\LOGS-YYYY-MM-DD.log`
|
||||
- Logs from: `C:\Users\[USERNAME]\AppData\Local\FreedomLoader\logs\LOGS-YYYY-MM-DD.log` (Windows) or `~/.local/share/FreedomLoader/logs/` (Linux)
|
||||
- Screenshots if applicable
|
||||
|
||||
### 2. Request a Feature
|
||||
@@ -43,13 +44,11 @@ Have an idea to improve Freedom Loader? Open a [**Feature Request**](https://git
|
||||
- Follow the project's code style and conventions
|
||||
|
||||
**Process:**
|
||||
1. Fork the repository
|
||||
2. Create a feature branch: `git checkout -b feature/your-feature-name`
|
||||
3. Make your changes
|
||||
4. Test thoroughly on Windows 10/11
|
||||
5. Commit with clear messages: `git commit -m "Add feature X"`
|
||||
6. Push to your fork: `git push origin feature/your-feature-name`
|
||||
7. Open a Pull Request using the appropriate template
|
||||
1. Fork the repository.
|
||||
2. Check out our [**Developer Guide (DEVELOPMENT.md)**](./DEVELOPMENT.md) to set up your environment.
|
||||
3. Create a feature branch following our branching conventions.
|
||||
4. Make your changes and test thoroughly on Windows and/or Linux.
|
||||
5. Open a Pull Request using the appropriate template.
|
||||
|
||||
**Code Guidelines:**
|
||||
- Use camelCase for variables and functions
|
||||
@@ -72,41 +71,9 @@ Small contributions matter—don't hesitate to submit documentation PRs.
|
||||
|
||||
## Development Setup
|
||||
|
||||
### Prerequisites
|
||||
- Node.js 16.x or higher
|
||||
- npm or yarn
|
||||
- Git
|
||||
- Windows 10/11 (for testing)
|
||||
Want to write some code? Awesome!
|
||||
|
||||
### Setup
|
||||
```bash
|
||||
# Clone your fork
|
||||
git clone https://github.com/YOUR-USERNAME/Freedom-Loader.git
|
||||
cd Freedom-Loader
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Run in development mode
|
||||
npm start
|
||||
|
||||
# Build for production
|
||||
npm run build
|
||||
```
|
||||
|
||||
### Project Structure
|
||||
```
|
||||
Freedom-Loader/
|
||||
├── main.js # Electron main process
|
||||
├── preload.js # Electron preload script
|
||||
├── config.js # Global configuration
|
||||
├── server/ # Express backend
|
||||
│ ├── routes/ # API routes
|
||||
│ ├── controller/ # Business logic
|
||||
│ └── helpers/ # Utility functions
|
||||
├── public/ # Frontend (HTML, CSS, JS)
|
||||
└── resources/ # Binaries (yt-dlp, ffmpeg, etc.)
|
||||
```
|
||||
Please read our [**Developer Guide (DEVELOPMENT.md)**](./DEVELOPMENT.md) for instructions on how to set up your local environment, our project architecture, and our Git branching rules.
|
||||
|
||||
---
|
||||
|
||||
@@ -114,12 +81,9 @@ Freedom-Loader/
|
||||
|
||||
Before submitting a PR, verify:
|
||||
- [ ] Download functionality works (video/audio)
|
||||
- [ ] Playlist downloads work
|
||||
- [ ] Settings panel functions correctly
|
||||
- [ ] Custom path selection works
|
||||
- [ ] No errors in application logs
|
||||
- [ ] UI changes work on all themes (if applicable)
|
||||
- [ ] Tested on Windows 10 and/or Windows 11
|
||||
- [ ] Any features wasn't break during the development
|
||||
- [ ] Tested on Windows 10/11 and/or any Linux Distribution
|
||||
|
||||
---
|
||||
|
||||
|
||||
388
DEVELOPMENT.md
Normal file
388
DEVELOPMENT.md
Normal file
@@ -0,0 +1,388 @@
|
||||
# Freedom Loader - Development Guide
|
||||
|
||||
Welcome to the Developer Guide! This document explains how to set up your local environment, project architecture, Git workflow, and the release process.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, ensure you have the following installed on your machine:
|
||||
|
||||
- **Node.js** (v22 or higher recommended)
|
||||
- **npm** (comes with Node.js)
|
||||
- **Git**
|
||||
- **yt-dlp binaries**: Freedom Loader requires native binaries to function. Read [BINARIES.md](./BINARIES.md) for download instructions and placement in `resources/binaries/`.
|
||||
|
||||
## Setup Instructions
|
||||
|
||||
### 1. Clone the repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/MasterAcnolo/Freedom-Loader.git
|
||||
cd Freedom-Loader
|
||||
```
|
||||
|
||||
### 2. Install dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### 3. Install the Binaries
|
||||
|
||||
Follow the instructions in `BINARIES.md` to place `yt-dlp`, `ffmpeg`, `ffprobe`, and `deno` in the correct `resources/binaries/` folder for your OS.
|
||||
|
||||
### 4. Run in Development Mode
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
**Note**: Development mode automatically enables detailed colored logs and the DevTron extension for debugging.
|
||||
|
||||
---
|
||||
|
||||
## Available Scripts
|
||||
|
||||
### Development
|
||||
|
||||
- `npm start` — Start the app in development mode (no warnings)
|
||||
- `npm run start:warn` — Start with deprecation warnings visible
|
||||
- `npm run start:debug` — Start with full debug logging (Wayland, Electron logging, stack dumps)
|
||||
- `npm run dev` — Start with auto-reload on file changes (watches server/, app/, main.js, config.js)
|
||||
- `npm run dev:warn` — Dev mode with warnings
|
||||
- `npm run dev:debug` — Dev mode with full debug output and auto-reload
|
||||
|
||||
### Building
|
||||
|
||||
- `npm run build:linux` — Build Linux packages (AppImage, deb, snap)
|
||||
- `npm run build:win` — Build Windows installer (.exe)
|
||||
- `npm run build:rpm` — Build RPM and SRPM for COPR (Fedora)
|
||||
- `npm run build:all` — Build both Windows and Linux (not recommended because it adds both OS binaries into a single package. The output file is 2x bigger than expected).
|
||||
|
||||
### Testing
|
||||
|
||||
- `npm test` — Run all tests (unit + integration)
|
||||
- `npm run test:unit` — Run unit tests only
|
||||
|
||||
### Release Pipeline
|
||||
|
||||
- `npm run release` — Build all packages and create a draft GitHub release (no store publishing)
|
||||
- `npm run release:publish` — Build all packages and publish to Snap Store + COPR
|
||||
- `npm run release:dry-run` — Simulate the full release pipeline without publishing anything
|
||||
|
||||
### Maintenance
|
||||
|
||||
- `npm update` — Update npm dependencies
|
||||
|
||||
---
|
||||
|
||||
## Project Architecture
|
||||
|
||||
Freedom Loader is built with **Electron** (frontend) and **Node.js + Express** (backend), using a modular structure:
|
||||
|
||||
---
|
||||
|
||||
## Git & Branching Workflow
|
||||
|
||||
I use **Trunk-Based Development** (GitHub Flow):
|
||||
|
||||
### Core Principles
|
||||
|
||||
- **`main` is always deployable**: The `main` branch contains the latest stable code and must never be broken.
|
||||
- **No long-lived branches**: I no longer maintain version branches like `v1.6` or `v1.7`.
|
||||
- **Pull Requests for review**: All code changes go through PR review before merging to `main`.
|
||||
|
||||
### How to Contribute
|
||||
|
||||
#### 1. Create a feature branch
|
||||
|
||||
```bash
|
||||
git checkout -b feat/add-new-button
|
||||
# or for fixes:
|
||||
git checkout -b fix/ui-bug
|
||||
```
|
||||
|
||||
**Branch naming convention**:
|
||||
- `feat/` — New features
|
||||
- `fix/` — Bug fixes
|
||||
- `refactor/` — Code cleanup (no behavior change)
|
||||
- `docs/` — Documentation updates
|
||||
- `chore/` — Dependency updates, build config, etc.
|
||||
|
||||
#### 2. Make commits
|
||||
|
||||
```bash
|
||||
# Make changes
|
||||
git add .
|
||||
git commit -m "Brief, imperative description of the change"
|
||||
```
|
||||
|
||||
**Commit message tips**:
|
||||
- Use imperative mood: "Add theme caching" not "Added theme caching"
|
||||
- Keep commits logical and focused (one feature per commit if possible)
|
||||
- Link to issues if relevant: "Fix crash on download (fixes #42)"
|
||||
|
||||
#### 3. Push and open a PR
|
||||
|
||||
```bash
|
||||
git push origin feat/add-new-button
|
||||
```
|
||||
|
||||
Then open a PR on GitHub against `main`.
|
||||
|
||||
#### 4. Review and merge
|
||||
|
||||
- Address feedback in new commits (don't rebase — easier to review)
|
||||
- Once approved, merge via GitHub (use "Squash and merge" for clean history if many small commits and you find it relevant)
|
||||
|
||||
---
|
||||
|
||||
## Release Process
|
||||
|
||||
**Note**: Only project maintainers release to production. This section documents the process for transparency and for future maintainers.
|
||||
|
||||
Releases are fully automated via the `release.sh` script. The process handles building, packaging, and publishing to **all distribution channels**:
|
||||
- **GitHub Releases** (Windows .exe, Linux packages)
|
||||
- **Fedora COPR** (automatic RPM builds for Fedora 43+)
|
||||
- **Snap Store** (universal Linux)
|
||||
|
||||
### Before You Release
|
||||
|
||||
1. **Ensure `main` is green**: All tests pass, features are stable.
|
||||
2. **Update `package.json` version**:
|
||||
|
||||
```json
|
||||
"version": "1.6.1"
|
||||
```
|
||||
3. **Commit the version bump**: `git add package.json && git commit -m "chore: v1.6.1"`
|
||||
4. **Push to `main`**: `git push origin main`
|
||||
|
||||
### Step 1: Local Build & Draft Release
|
||||
|
||||
```bash
|
||||
npm run release
|
||||
```
|
||||
|
||||
This:
|
||||
1. Builds Linux packages (AppImage, deb, snap)
|
||||
2. Builds RPM and SRPM for COPR
|
||||
3. Builds Windows installer
|
||||
4. Creates a draft GitHub release
|
||||
|
||||
### Step 2: Edit & Publish on GitHub
|
||||
|
||||
1. Go to https://github.com/MasterAcnolo/Freedom-Loader/releases
|
||||
2. Edit the draft release — fill in changelog
|
||||
3. Click **"Publish"** to make it live
|
||||
|
||||
### Step 3: Publish to Distribution Channels
|
||||
|
||||
```bash
|
||||
npm run release:publish
|
||||
```
|
||||
|
||||
This automatically:
|
||||
- **Uploads to Snap Store**: Makes the app available via `snap install freedom-loader`
|
||||
- **Submits to Fedora COPR**: Builds and publishes RPMs for Fedora 43+ (users can `dnf install freedom-loader` from the COPR repo)
|
||||
|
||||
Both happen in parallel — users across all platforms get the release simultaneously.
|
||||
|
||||
---
|
||||
|
||||
## Linux Development Considerations
|
||||
|
||||
### Cross-Distribution Compatibility
|
||||
|
||||
Freedom Loader targets **Debian-based** (Ubuntu, Debian) and **Fedora-based** (Fedora, RHEL, openSUSE) distributions. When developing features, keep this in mind:
|
||||
|
||||
#### What to test
|
||||
|
||||
- **Feature works on Fedora 44+** (primary Linux development environment)
|
||||
- **Feature works on Ubuntu/Debian** (via deb package or AppImage)
|
||||
- **Feature doesn't break Snap confinement** (Snap has restricted filesystem/IPC access)
|
||||
- **Feature gracefully degrades on missing system dependencies**
|
||||
|
||||
#### Desktop Environment (DE) Compatibility
|
||||
|
||||
Test on at least **GNOME** and **KDE** (the most common DEs). Common pain points:
|
||||
|
||||
- **Themes**: May render differently on KDE vs GNOME — test both if possible
|
||||
- **File dialogs**: Some DEs use native file pickers, others fall back to Electron's
|
||||
- **Notifications**: System notification APIs vary (D-Bus, libnotify)
|
||||
- **Tray icons**: May not work identically across DEs
|
||||
|
||||
#### How to check locally
|
||||
|
||||
```bash
|
||||
# Test on Fedora (if available)
|
||||
npm run build:linux
|
||||
sudo dnf install dist/freedom-loader-*.x86_64.rpm
|
||||
freedom-loader
|
||||
|
||||
# Test AppImage (works on any distro)
|
||||
chmod +x dist/Freedom\ Loader-*.AppImage
|
||||
./dist/Freedom\ Loader-*.AppImage
|
||||
```
|
||||
|
||||
### CI/CD Gap
|
||||
|
||||
**Currently**: No automated testing across distros or DEs. Releases rely on manual testing before publish.
|
||||
|
||||
**Future improvement**: Automated tests via GitHub Actions (Ubuntu) + local testing on Fedora would catch cross-distro issues early. This is planned but not yet implemented.
|
||||
|
||||
For now, if you fix a Linux-specific bug or add a DE-dependent feature, **please mention it in your PR description** so reviewers can test extra carefully.
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
### Unit Tests
|
||||
|
||||
Test individual functions in isolation (no Electron required).
|
||||
|
||||
```bash
|
||||
npm run test:unit
|
||||
```
|
||||
|
||||
Covered:
|
||||
|
||||
(Tests will come soon)
|
||||
|
||||
### End-to-End Tests (Playwright)
|
||||
|
||||
Test the actual Electron app launching and basic UI interactions.
|
||||
|
||||
```bash
|
||||
npm run test
|
||||
```
|
||||
|
||||
Covered:
|
||||
|
||||
(Tests will come soon)
|
||||
|
||||
|
||||
### Running All Tests
|
||||
|
||||
```bash
|
||||
npm test
|
||||
```
|
||||
|
||||
Or include tests before release:
|
||||
|
||||
```bash
|
||||
npm test && npm run release
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Tasks
|
||||
|
||||
### Add a new feature
|
||||
|
||||
1. Create a feature branch: `git checkout -b feat/my-feature`
|
||||
2. Make changes, commit: `git add . && git commit -m "feat: my feature"`
|
||||
3. Push: `git push origin feat/my-feature`
|
||||
4. Open a PR on GitHub
|
||||
5. Once approved, merge to `main`
|
||||
6. (Later) Cut a release when ready: `npm run release`
|
||||
|
||||
### Fix a bug
|
||||
|
||||
Same as above, but use `fix/bug-name` branch and `git commit -m "fix: description"`.
|
||||
|
||||
### Test the app before releasing
|
||||
|
||||
```bash
|
||||
npm run dev # Auto-reload on file changes
|
||||
# Make changes, test in the UI
|
||||
npm test # Run all tests
|
||||
npm run release:dry-run # Simulate release (builds but doesn't publish)
|
||||
```
|
||||
|
||||
### Update dependencies
|
||||
|
||||
```bash
|
||||
npm update
|
||||
git add package.json package-lock.json
|
||||
git commit -m "chore: update dependencies"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
### Rebuild only Linux (after quick fixes)
|
||||
|
||||
```bash
|
||||
npm run build:linux
|
||||
# Or just the RPM:
|
||||
npm run build:rpm
|
||||
```
|
||||
|
||||
### Publish to stores manually
|
||||
|
||||
If `npm run release:publish` fails partway:
|
||||
|
||||
```bash
|
||||
# Just Snap:
|
||||
snapcraft upload dist/freedom-loader_*.snap --release=stable
|
||||
|
||||
# Just COPR:
|
||||
copr-cli build freedom-loader srpm-out/*.src.rpm
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### App won't start in dev mode
|
||||
|
||||
```bash
|
||||
npm run start:debug
|
||||
```
|
||||
|
||||
Check the debug output for errors. Most common:
|
||||
- Missing binaries in `resources/binaries/`
|
||||
- Port 8787 already in use
|
||||
- A dead instance is still running — open Task Manager and kill the "Freedom Loader" process
|
||||
|
||||
### (Linux) Binaries in the right place but app still won't launch
|
||||
|
||||
You probably forgot to make them executable:
|
||||
|
||||
```bash
|
||||
chmod +x resources/binaries/linux/*
|
||||
```
|
||||
|
||||
The app will fail silently if binaries lack execute permissions.
|
||||
|
||||
### Build fails with "permission denied"
|
||||
|
||||
Make sure you have write access to `dist/` and `srpm-out/`:
|
||||
|
||||
```bash
|
||||
chmod -R u+w dist srpm-out
|
||||
npm run build:linux
|
||||
```
|
||||
|
||||
### Tests fail
|
||||
|
||||
Check for:
|
||||
- Missing test files in `tests/unit/`
|
||||
- Node modules out of sync: `rm -rf node_modules && npm install`
|
||||
|
||||
### GitHub release publish fails
|
||||
|
||||
Verify `gh` CLI is installed and authenticated:
|
||||
|
||||
```bash
|
||||
gh auth login
|
||||
gh release list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Questions?
|
||||
|
||||
For more info:
|
||||
- **Electron docs**: https://www.electronjs.org/docs
|
||||
- **electron-builder**: https://www.electron.build/
|
||||
- **This repo**: https://github.com/MasterAcnolo/Freedom-Loader
|
||||
|
||||
Happy coding! 🎉
|
||||
186
README.md
186
README.md
@@ -15,8 +15,6 @@
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Freedom Loader is a desktop application built with Electron that provides a straightforward way to download video and audio content with full metadata support. The application focuses on reliability, transparency, and user privacy-no ads, no tracking, no questionable third-party services.
|
||||
@@ -25,7 +23,7 @@ The primary goal is to make media downloading accessible to users who want offli
|
||||
|
||||
### See related repo:
|
||||
|
||||
- **[Website](https://masteracnolo.github.io/Freedom-Loader-Site/)** - Official project website and documentation
|
||||
- **[Website](https://github.com/MasterAcnolo/Freedom-Loader-Site/)** - Official project website and documentation
|
||||
- **[Workshop](https://github.com/MasterAcnolo/Freedom-Loader-Workshop)** - Theme creation tool and theme browser
|
||||
|
||||
## Table of Contents
|
||||
@@ -35,14 +33,12 @@ The primary goal is to make media downloading accessible to users who want offli
|
||||
- [Usage](#usage)
|
||||
- [Preview](#preview)
|
||||
- [Configuration](#configuration)
|
||||
- [Project Structure](#project-structure)
|
||||
- [Theme Workshop](#Theme-Workshop)
|
||||
- [Technology Stack](#technology-stack)
|
||||
- [Development](#development)
|
||||
- [Roadmap](#roadmap)
|
||||
- [Contributing](#contributing)
|
||||
- [Submitting a community theme](#Submitting-a-community-theme)
|
||||
- [Support](#support)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
@@ -254,7 +250,7 @@ Freedom Loader can be configured either through the settings panel in the UI or
|
||||
| Option | Type | Default | Description |
|
||||
|------------------------------|---------|----------|------------------------------------------------------------|
|
||||
| `autoUpdate` | boolean | `true` | Enable automatic application updates |
|
||||
| `systemTray` | boolean | `true` | Allow app to minimize on close [EXPERIMENTAL] |
|
||||
| `systemTray` | boolean | `false` | Allow app to minimize on close [EXPERIMENTAL] |
|
||||
| `discordRPC` | boolean | `true` | Enable Discord Rich Presence integration |
|
||||
| `customTopBar` | boolean | `true` | Use custom application top bar |
|
||||
| `autoCheckInfo` | boolean | `true` | Automatically fetch video information on URL paste |
|
||||
@@ -263,7 +259,7 @@ Freedom Loader can be configured either through the settings panel in the UI or
|
||||
| `verboseLogs` | boolean | `false` | Enable detailed logging for debugging |
|
||||
| `autoDownloadPlaylist` | boolean | `true` | Automatically download entire playlists |
|
||||
| `keepPlaylistOrder` | boolean | `false` | Add index before title, usefull for album |
|
||||
| `createPlaylistFolders` | boolean | `true` | Automatically create a folder for a playlist |
|
||||
| `createPlaylistFolders` | boolean | `false` | Automatically create a folder for a playlist |
|
||||
| `customCodec` | string | `"h264"` | Video codec for encoding (supported: h264, h265, vp9, av1) |
|
||||
| `logSystem` | boolean | `true` | Enable application logging |
|
||||
| `outputTitleCheck` | boolean | `true` | Verify output file titles |
|
||||
@@ -285,89 +281,6 @@ Freedom Loader can be configured either through the settings panel in the UI or
|
||||
> [!NOTE]
|
||||
> Some configuration changes may require an application restart to take effect.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
Freedom-Loader/
|
||||
├── app/ # Electron main process modules
|
||||
│ ├── autoUpdater.js
|
||||
│ ├── dependencyCheck.js
|
||||
│ ├── discordRPC.js
|
||||
│ ├── ipcHandlers.js
|
||||
│ ├── pathValidator.js
|
||||
│ ├── splashManager.js
|
||||
│ ├── themeManager.js
|
||||
│ ├── tray.js
|
||||
│ ├── windowManager.js
|
||||
│ └── ytDlpUpdater.js
|
||||
├── build/ # Build resources and assets
|
||||
│ ├── app-icon.ico
|
||||
│ ├── app-icon.png
|
||||
│ ├── banner.png
|
||||
│ └── ...
|
||||
├── config/ # Configuration files
|
||||
│ ├── config.default.json
|
||||
│ └── config.dev.json # Configuration Used when i dev mode
|
||||
├── dist/ # Compiled executables (.exe, .AppImage, .deb, .rpm, .snap)
|
||||
├── public/ # Frontend assets and UI
|
||||
│ ├── index.html
|
||||
│ ├── splash.html # Splash Screen (Start of the application)
|
||||
│ ├── assets/
|
||||
│ │ ├── icon/ # Application icons
|
||||
│ │ └── logo/ # Logo assets
|
||||
│ ├── script/ # Frontend JavaScript modules
|
||||
│ │ ├── appVersion.js
|
||||
│ │ ├── clipboardPaste.js
|
||||
│ │ ├── custompath.js
|
||||
│ │ ├── customthemes.js
|
||||
│ │ ├── downloadstatus.js
|
||||
│ │ ├── fetchinfo.js
|
||||
│ │ ├── progressBar.js
|
||||
│ │ ├── settingsPanel.js
|
||||
│ │ ├── toast.js
|
||||
│ │ └── topbar.js
|
||||
│ └── styles/ # CSS stylesheets
|
||||
│ ├── styles.css
|
||||
│ ├── variables.css
|
||||
│ ├── components/ # Component-specific styles
|
||||
│ └── layout/ # Layout styles
|
||||
├── resources/ # Internal resources (binaries : yt-dlp, ffmpeg...)
|
||||
├── server/ # Express backend server
|
||||
│ ├── logger.js
|
||||
│ ├── server.js
|
||||
│ ├── controller/ # Request handlers
|
||||
│ │ ├── download.controller.js
|
||||
│ │ └── info.controller.js
|
||||
│ ├── helpers/ # Utility functions
|
||||
│ │ ├── buildArgs.helpers.js
|
||||
│ │ ├── getBrowser.helpers.js
|
||||
│ │ ├── notify.helpers.js
|
||||
│ │ ├── parseInfo.helpers.js
|
||||
│ │ ├── path.helpers.js
|
||||
│ │ ├── rateLimit.helpers.js
|
||||
│ │ └── validation.helpers.js
|
||||
│ ├── routes/ # API route definitions
|
||||
│ │ ├── download.route.js
|
||||
│ │ └── info.route.js
|
||||
│ └── services/ # Business logic layer
|
||||
│ ├── download.services.js
|
||||
│ └── info.services.js
|
||||
├── theme/ # Theme system
|
||||
│ ├── template.theme.json # Theme template
|
||||
│ ├── Dark/ # Default dark theme
|
||||
│ └── Light/ # Default light theme
|
||||
├── BINARIES.md # External dependencies & binaries documentation
|
||||
├── CODE_OF_CONDUCT.md # Community guidelines
|
||||
├── config.js # Global configuration loader
|
||||
├── CONTRIBUTING.md # Contribution guidelines
|
||||
├── jest.config.js # Unit testing configuration
|
||||
├── LICENSE # GPLv3 license
|
||||
├── main.js # Electron main process entry point
|
||||
├── package.json # Project metadata and dependencies
|
||||
├── preload.js # Electron preload script (IPC bridge)
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
### Architecture Overview
|
||||
|
||||
Freedom Loader uses a client-server architecture within a single Electron application:
|
||||
@@ -414,28 +327,7 @@ Freedom Loader includes a web-based theme creator available at [Freedom Loader W
|
||||
|
||||
## Development
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js 16.x or higher
|
||||
- npm or yarn
|
||||
- Git
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/MasterAcnolo/Freedom-Loader.git
|
||||
cd Freedom-Loader
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Run in development mode
|
||||
npm start
|
||||
|
||||
# Build for production
|
||||
npm run build
|
||||
```
|
||||
If you are interested by running a local non compiled version of Freedom Loader or just interested by contributing, see [DEVELOPMENT](./DEVELOPMENT.md)
|
||||
|
||||
### Additional Dependencies
|
||||
|
||||
@@ -446,40 +338,19 @@ You must download the required binaries and place them in the `resources` folder
|
||||
|
||||
#### Required binaries
|
||||
|
||||
- **Deno**
|
||||
- Download from: https://sourceforge.net/projects/deno.mirror/files/latest/download
|
||||
- Rename to: `deno.exe`
|
||||
|
||||
- **FFmpeg**
|
||||
- Download from: https://www.ffmpeg.org/download.html
|
||||
- Required files:
|
||||
- `ffmpeg.exe`
|
||||
- `ffprobe.exe`
|
||||
|
||||
- **yt-dlp**
|
||||
- Already bundled with the project
|
||||
- No manual installation required
|
||||
|
||||
Final folder structure:
|
||||
|
||||
```
|
||||
resources/
|
||||
├── deno.exe
|
||||
├── ffmpeg.exe
|
||||
├── ffprobe.exe
|
||||
└── yt-dlp.exe
|
||||
```
|
||||
|
||||
> These binaries are required for the application to start correctly.
|
||||
> If any of them are missing, an error message will be displayed at application startup.
|
||||
See [BINARIES.md](./BINARIES.md) for how to setup the binaries.
|
||||
|
||||
### Development Guidelines
|
||||
|
||||
- Follow existing code style and conventions
|
||||
- Write clear commit messages
|
||||
- Test thoroughly before submitting changes
|
||||
- Update documentation when adding features
|
||||
- Maintain compatibility with Windows 10+ and Linux
|
||||
- Write clear, imperative commit messages (e.g., "Add playlist indexing" not "Added")
|
||||
- Test thoroughly on both Windows and Linux before submitting changes
|
||||
- Update documentation (README, DEVELOPMENT.md) when adding features
|
||||
- Maintain compatibility with:
|
||||
- Windows 10+
|
||||
- Fedora 43+ / Debian 11+ / Ubuntu 20.04+
|
||||
- GNOME and KDE desktop environments (when possible)
|
||||
- Consider Linux distribution differences early (see [DEVELOPMENT.md](./DEVELOPMENT.md#linux-development-considerations))
|
||||
|
||||
## Roadmap
|
||||
|
||||
@@ -496,13 +367,29 @@ Head over to the [Freedom Loader Workshop repository](https://github.com/MasterA
|
||||
|
||||
### Bug Reports
|
||||
|
||||
Use the GitHub Issues system and include:
|
||||
You can report bugs either using the built-in application system or via the GitHub Issues system.
|
||||
|
||||
#### Using the Built-in Report Tool
|
||||
|
||||
1. Open Freedom Loader.
|
||||
2. Trigger the bug report interface.
|
||||
3. Fill in the title and description of the issue.
|
||||
4. Choose whether to include today's logs automatically.
|
||||
5. Submit the report.
|
||||
|
||||
> [!NOTE]
|
||||
> If you need to attach extra context like screenshots or screen recordings, it is recommended to use the GitHub Issues
|
||||
system instead.
|
||||
|
||||
#### Using GitHub Issues
|
||||
|
||||
Open a new issue on the GitHub repository and include:
|
||||
|
||||
- Clear description of the issue
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Relevant logs from `AppData\Local\FreedomLoader\logs\` or `~/.local/share/FreedomLoader/logs/`
|
||||
- Screenshots if applicable
|
||||
- Screenshots or recordings if applicable
|
||||
|
||||
### Feature Requests
|
||||
|
||||
@@ -521,15 +408,7 @@ Open a feature request issue with:
|
||||
5. Update documentation as needed
|
||||
6. Submit a pull request with a detailed description
|
||||
|
||||
Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before contributing.
|
||||
|
||||
## Support
|
||||
|
||||
If you find this project useful and want to support its development:
|
||||
|
||||
[](https://paypal.me/axelnicolas25)
|
||||
|
||||
Your support helps maintain infrastructure, develop new features, and keep the project free and ad-free.
|
||||
Please read [CONTRIBUTING.md](CONTRIBUTING.md), [DEVELOPMENT.md](./DEVELOPMENT.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before contributing.
|
||||
|
||||
## License
|
||||
|
||||
@@ -547,7 +426,6 @@ You are free to use, modify, and redistribute this software under the terms of t
|
||||
- [@SpicyFire21](https://github.com/SpicyFire21) to be the spiciest one
|
||||
- [@AureCX](https://github.com/AureCX) for being the Official Windows Tester!
|
||||
- Zakaria for the website icon
|
||||
- Jacques Chirac to love Apples
|
||||
- All users who test, report issues, and help improve the application
|
||||
|
||||
---
|
||||
|
||||
@@ -9,7 +9,6 @@
|
||||
*/
|
||||
|
||||
const { autoUpdater } = require("electron-updater");
|
||||
const { dialog } = require("electron");
|
||||
const { logger } = require("../server/logger");
|
||||
|
||||
/**
|
||||
@@ -21,6 +20,26 @@ const { logger } = require("../server/logger");
|
||||
autoUpdater.autoDownload = false;
|
||||
autoUpdater.autoInstallOnAppQuit = false;
|
||||
|
||||
let updateAvailable = false;
|
||||
|
||||
/**
|
||||
* Determines how the update should be handled based on the platform
|
||||
* @returns {"auto" | "snap" | "flatpak" | "linux-native"}
|
||||
*/
|
||||
function getUpdateEnvironment() {
|
||||
if (
|
||||
process.env.APPIMAGE ||
|
||||
process.platform === "win32" ||
|
||||
process.platform === "darwin"
|
||||
) {
|
||||
return "auto";
|
||||
}
|
||||
if (process.env.SNAP) return "snap";
|
||||
if (process.env.FLATPAK_ID) return "flatpak";
|
||||
|
||||
return "linux-native";
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes application auto-update lifecycle.
|
||||
*
|
||||
@@ -32,7 +51,6 @@ autoUpdater.autoInstallOnAppQuit = false;
|
||||
* @param {BrowserWindow} mainWindow - main Electron window instance
|
||||
*/
|
||||
function initAutoUpdater(mainWindow) {
|
||||
|
||||
/**
|
||||
* Triggered when a new version is detected.
|
||||
* Prompts user to install or defer update.
|
||||
@@ -40,23 +58,12 @@ function initAutoUpdater(mainWindow) {
|
||||
autoUpdater.on("update-available", async (info) => {
|
||||
logger.info(`Update available: ${info.version}`);
|
||||
|
||||
const { response } = await dialog.showMessageBox(mainWindow, {
|
||||
type: "info",
|
||||
title: "Update Available",
|
||||
message: `Version ${info.version} is available.`,
|
||||
detail: "Would you like to download and install it now?",
|
||||
buttons: ["Install Update", "Maybe Later"],
|
||||
defaultId: 0,
|
||||
cancelId: 1,
|
||||
mainWindow?.webContents.send("update-available", {
|
||||
version: info.version,
|
||||
environment: getUpdateEnvironment(),
|
||||
});
|
||||
updateAvailable = true;
|
||||
|
||||
if (response === 0) {
|
||||
await autoUpdater.downloadUpdate();
|
||||
} else {
|
||||
mainWindow?.webContents.executeJavaScript(
|
||||
`window.showUpdateBadge && window.showUpdateBadge("${info.version}")`
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -66,8 +73,10 @@ function initAutoUpdater(mainWindow) {
|
||||
autoUpdater.on("download-progress", (progress) => {
|
||||
logger.info(`Download progress: ${Math.round(progress.percent)}%`);
|
||||
mainWindow?.webContents.send("update-progress", {
|
||||
percent: Math.round(progress.percent),
|
||||
speed: progress.bytesPerSecond,
|
||||
percent: progress.percent,
|
||||
bytesPerSecond: progress.bytesPerSecond,
|
||||
transferred: progress.transferred,
|
||||
total: progress.total,
|
||||
});
|
||||
});
|
||||
|
||||
@@ -78,17 +87,9 @@ function initAutoUpdater(mainWindow) {
|
||||
autoUpdater.on("update-downloaded", async (info) => {
|
||||
logger.info(`Update downloaded: ${info.version}`);
|
||||
|
||||
const { response } = await dialog.showMessageBox(mainWindow, {
|
||||
type: "info",
|
||||
title: "Update Ready",
|
||||
message: `Version ${info.version} has been downloaded.`,
|
||||
detail: "The application will restart to apply the update.",
|
||||
buttons: ["Install Now", "Later"],
|
||||
defaultId: 0,
|
||||
cancelId: 1,
|
||||
});
|
||||
mainWindow?.webContents.send("update-downloaded", info);
|
||||
|
||||
|
||||
if (response === 0) autoUpdater.quitAndInstall();
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -102,14 +103,15 @@ function initAutoUpdater(mainWindow) {
|
||||
* If no update is available, I put this because there is no Linux version before 1.6.0
|
||||
* @type {boolean}
|
||||
*/
|
||||
const isNoUpdateAvailable = /404/.test(msg) || /Cannot find latest.*\.yml/i.test(msg);
|
||||
const isNoUpdateAvailable =
|
||||
/404/.test(msg) || /Cannot find latest.*\.yml/i.test(msg);
|
||||
|
||||
if (isNoUpdateAvailable) {
|
||||
logger.warn("Auto update: no update metadata found (probably no previous release), ignoring", msg);
|
||||
return;
|
||||
}
|
||||
|
||||
logger.error("Auto update error:", msg);
|
||||
logger.error("Auto update error:", err);
|
||||
});
|
||||
|
||||
checkForUpdates();
|
||||
@@ -120,19 +122,7 @@ function initAutoUpdater(mainWindow) {
|
||||
* Separated from init for reusability and testability.
|
||||
*/
|
||||
async function checkForUpdates() {
|
||||
|
||||
/**
|
||||
* Prevents electron-updater from running inside sandboxed environments.
|
||||
* Snap and Flatpak lock the file system in read-only mode, causing the updater to crash.
|
||||
* In these environments, updates are safely handled by snapd or the Flatpak runtime.
|
||||
* Standalone Linux packages (.deb, .rpm, AppImage) will bypass this and update normally.
|
||||
*/
|
||||
if (process.env.SNAP || process.env.FLATPAK_ID) {
|
||||
logger.info("Running as Snap or Flatpak. Updates are managed by the OS store. Skipping electron-updater.");
|
||||
return;
|
||||
}
|
||||
|
||||
if (!require("electron").app.isPackaged) return ;
|
||||
if (!require("electron").app.isPackaged) return;
|
||||
|
||||
try {
|
||||
await autoUpdater.checkForUpdates();
|
||||
@@ -150,6 +140,7 @@ async function downloadUpdate() {
|
||||
await autoUpdater.downloadUpdate();
|
||||
} catch (err) {
|
||||
logger.error("Download failed:", err.message);
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -160,4 +151,13 @@ function installUpdate() {
|
||||
autoUpdater.quitAndInstall();
|
||||
}
|
||||
|
||||
module.exports = { initAutoUpdater, downloadUpdate, installUpdate };
|
||||
function isUpdateAvailable() {
|
||||
return updateAvailable;
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
initAutoUpdater,
|
||||
downloadUpdate,
|
||||
installUpdate,
|
||||
isUpdateAvailable,
|
||||
};
|
||||
|
||||
@@ -97,12 +97,12 @@ function startRPC() {
|
||||
details: `Open Source Download Tools - ${config.version}`,
|
||||
state: "masteracnolo.github.io/FreedomLoader",
|
||||
};
|
||||
rpc.clearActivity()
|
||||
rpc.clearActivity();
|
||||
rpc.setActivity(presence);
|
||||
|
||||
});
|
||||
|
||||
rpc.login({ clientId }).catch(err => {
|
||||
rpc.login({ clientId }).catch(() => {
|
||||
// Since 1.6.2, it no longer print the error. This is because if discord is not opened, it will send an error.
|
||||
// logger.error("Unable to connect to the RPC:", err);
|
||||
logger.info("Unable to connect to the Discord RPC. Discord is maybe not launched");
|
||||
@@ -123,14 +123,6 @@ async function stopRPC() {
|
||||
try {
|
||||
if (intervalId) clearInterval(intervalId);
|
||||
|
||||
/**
|
||||
* Ensures RPC connection AND the underlying socket exist
|
||||
* before attempting to clear activity to prevent crash.
|
||||
*/
|
||||
if (rpc.transport && rpc.transport.socket) {
|
||||
await rpc.clearActivity();
|
||||
}
|
||||
|
||||
await rpc.destroy();
|
||||
|
||||
} catch (err) {
|
||||
|
||||
@@ -13,12 +13,14 @@
|
||||
const { ipcMain, dialog, shell } = require("electron");
|
||||
const fs = require("fs");
|
||||
const { logger, logDir } = require("../server/logger");
|
||||
const { configFeatures, featuresPath } = require("../config");
|
||||
const { configFeatures, featuresPath, devMode } = require("../config");
|
||||
const { getThemes, reloadThemes } = require("./themeManager");
|
||||
const config = require("../config");
|
||||
const { validateDownloadPath, getDefaultDownloadPath } = require("./pathValidator");
|
||||
const { userThemesPath } = require("../server/helpers/path.helpers");
|
||||
const { createSystemTray, destroyTray } = require("./tray");
|
||||
const { sendReport } = require("./sendReport");
|
||||
const { isUpdateAvailable, downloadUpdate, installUpdate } = require("./autoUpdater");
|
||||
|
||||
/**
|
||||
* Security whitelist for feature flags that can be modified at runtime.
|
||||
@@ -64,7 +66,6 @@ const themeFolderPath = userThemesPath;
|
||||
* @param {Function} getMainWindow - Function returning current BrowserWindow instance
|
||||
*/
|
||||
function registerIpcHandlers(getMainWindow) {
|
||||
|
||||
/**
|
||||
* Returns application version from config.
|
||||
*/
|
||||
@@ -114,7 +115,17 @@ function registerIpcHandlers(getMainWindow) {
|
||||
/**
|
||||
* Window minimize request from renderer.
|
||||
*/
|
||||
ipcMain.on("window-minimize", () => getMainWindow()?.minimize());
|
||||
ipcMain.on("window-minimize", () => {
|
||||
// Minimize to tray
|
||||
if (configFeatures.systemTray) {
|
||||
getMainWindow()?.hide();
|
||||
logger.info("Window Minimized in SystemTray (Using Minimize Button)");
|
||||
} else {
|
||||
// Native minimize
|
||||
getMainWindow()?.minimize();
|
||||
logger.info("Window minimized normally");
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Toggles maximize/unmaximize state of main window.
|
||||
@@ -130,7 +141,6 @@ function registerIpcHandlers(getMainWindow) {
|
||||
*/
|
||||
ipcMain.on("window-close", () => getMainWindow()?.close());
|
||||
|
||||
|
||||
/**
|
||||
* Opens Chromium DevTools in detached mode.
|
||||
*/
|
||||
@@ -141,7 +151,7 @@ function registerIpcHandlers(getMainWindow) {
|
||||
/**
|
||||
* Opens application logs directory in system file explorer.
|
||||
*/
|
||||
ipcMain.on("open-logs", () => logDir && shell.openPath(logDir));
|
||||
ipcMain.on("open-logs", () => logDir && shell.openPath(logDir));
|
||||
|
||||
/**
|
||||
* Opens external website in default browser.
|
||||
@@ -169,7 +179,12 @@ function registerIpcHandlers(getMainWindow) {
|
||||
*/
|
||||
ipcMain.on("open-config", () => shell.openPath(configFolderPath));
|
||||
|
||||
|
||||
/**
|
||||
* Front end logger
|
||||
*/
|
||||
ipcMain.on("log-error", (_, message) => logger.error(`[Frontend] ${message}`));
|
||||
ipcMain.on("log-info", (_, message) => logger.info(`[Frontend] ${message}`));
|
||||
ipcMain.on("log-warn", (_, message) => logger.warn(`[Frontend] ${message}`));
|
||||
|
||||
/**
|
||||
* Retrieves available themes from filesystem.
|
||||
@@ -188,6 +203,31 @@ function registerIpcHandlers(getMainWindow) {
|
||||
return await reloadThemes();
|
||||
});
|
||||
|
||||
/**
|
||||
* Send bug report
|
||||
*/
|
||||
ipcMain.handle("send-report", async (_, params) => {
|
||||
return await sendReport(params);
|
||||
});
|
||||
|
||||
ipcMain.handle("is-update-available", () => {
|
||||
return isUpdateAvailable();
|
||||
});
|
||||
|
||||
ipcMain.handle("download-update", async () => {
|
||||
return await downloadUpdate();
|
||||
});
|
||||
|
||||
ipcMain.handle("install-update", async () => {
|
||||
return installUpdate();
|
||||
});
|
||||
|
||||
ipcMain.on("open-release-page", () => {
|
||||
shell.openExternal(
|
||||
"https://github.com/MasterAcnolo/Freedom-Loader/releases/latest",
|
||||
);
|
||||
});
|
||||
|
||||
/**
|
||||
* Updates a runtime feature flag and persists it to disk.
|
||||
*
|
||||
@@ -205,47 +245,46 @@ function registerIpcHandlers(getMainWindow) {
|
||||
* @returns {boolean} success state
|
||||
*/
|
||||
ipcMain.handle("set-feature", (event, { key, value }) => {
|
||||
try {
|
||||
if (!FEATURE_WHITELIST.has(key)) {
|
||||
logger.warn(`Rejected feature (not whitelisted): ${key}`);
|
||||
return false;
|
||||
}
|
||||
try {
|
||||
if (!FEATURE_WHITELIST.has(key)) {
|
||||
logger.warn(`Rejected feature (not whitelisted): ${key}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (configFeatures[key] === value) {
|
||||
return true;
|
||||
}
|
||||
if (configFeatures[key] === value) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dynamically intercepts and applies System Tray state changes at runtime.
|
||||
* Instantiates or destroys the tray icon immediately to prevent window
|
||||
* lifecycle desynchronization (e.g., minimizing a window to a non-existent tray).
|
||||
*/
|
||||
if (key === "systemTray") {
|
||||
if (value === true) {
|
||||
logger.info("System Tray enabled dynamically.");
|
||||
createSystemTray(getMainWindow(), config.devMode);
|
||||
} else {
|
||||
logger.info("System Tray disabled dynamically.");
|
||||
destroyTray();
|
||||
}
|
||||
}
|
||||
|
||||
configFeatures[key] = value;
|
||||
|
||||
fs.writeFileSync(
|
||||
configFolderPath,
|
||||
JSON.stringify(configFeatures, null, 2),
|
||||
"utf-8"
|
||||
);
|
||||
|
||||
logger.info(`Feature updated: ${key} = ${value}`);
|
||||
return true;
|
||||
|
||||
} catch (err) {
|
||||
logger.error(`set-feature failed (${key}): ${err.message}`);
|
||||
return false;
|
||||
/**
|
||||
* Dynamically intercepts and applies System Tray state changes at runtime.
|
||||
* Instantiates or destroys the tray icon immediately to prevent window
|
||||
* lifecycle desynchronization (e.g., minimizing a window to a non-existent tray).
|
||||
*/
|
||||
if (key === "systemTray") {
|
||||
if (value === true) {
|
||||
logger.info("System Tray enabled dynamically.");
|
||||
createSystemTray(devMode);
|
||||
} else {
|
||||
logger.info("System Tray disabled dynamically.");
|
||||
destroyTray();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
configFeatures[key] = value;
|
||||
|
||||
fs.writeFileSync(
|
||||
configFolderPath,
|
||||
JSON.stringify(configFeatures, null, 2),
|
||||
"utf-8",
|
||||
);
|
||||
|
||||
logger.info(`Feature updated: ${key} = ${value}`);
|
||||
return true;
|
||||
} catch (err) {
|
||||
logger.error(`set-feature failed (${key}): ${err.message}`);
|
||||
return false;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
module.exports = { registerIpcHandlers };
|
||||
@@ -66,7 +66,7 @@ function validateDownloadPath(userPath) {
|
||||
const real = fs.realpathSync(absolutePath);
|
||||
|
||||
if (!isSafePath(real)) {
|
||||
throw new Error("Path not allowed: system folders are blocked!");
|
||||
logger.error("Path not allowed: system folders are blocked!");
|
||||
}
|
||||
|
||||
return real;
|
||||
|
||||
54
app/sendReport.js
Normal file
54
app/sendReport.js
Normal file
@@ -0,0 +1,54 @@
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
const {logger, logDir} = require("../server/logger");
|
||||
|
||||
async function sendReport(params) {
|
||||
try {
|
||||
const {title, description, includeLogs} = params;
|
||||
|
||||
if (!title || !description) {
|
||||
throw new Error("Title and description are required.");
|
||||
}
|
||||
|
||||
const formData = new FormData();
|
||||
formData.append("title", title);
|
||||
formData.append("context", description);
|
||||
|
||||
if (includeLogs === "yes" && logDir) {
|
||||
// YYYY-MM-DD
|
||||
const today = new Date().toISOString().split("T")[0];
|
||||
|
||||
const logFilePath = path.join(logDir, `LOGS-${today}.log`);
|
||||
|
||||
if (fs.existsSync(logFilePath)) {
|
||||
const logFileContent = fs.readFileSync(logFilePath);
|
||||
const blob = new Blob([logFileContent], {type: "text/plain"});
|
||||
formData.append("file", blob, `LOGS-${today}.log`);
|
||||
logger.info("Logs attached to bug report.");
|
||||
} else {
|
||||
logger.warn(`Log file not found for today: ${logFilePath}`);
|
||||
}
|
||||
}
|
||||
|
||||
const response = await fetch(process.env.BUG_REPORT_URL, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"X-Api-Key": process.env.BUG_REPORT_API_KEY
|
||||
},
|
||||
body: formData
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
logger.error(`Server returned an error: ${response.status}`);
|
||||
throw new Error(`Server responded with status ${response.status}`);
|
||||
}
|
||||
|
||||
logger.info("Bug report successfully sent.");
|
||||
return true;
|
||||
} catch (err) {
|
||||
logger.error(`Failed to send bug report: ${err.message}`);
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = {sendReport};
|
||||
23
app/tray.js
23
app/tray.js
@@ -2,6 +2,7 @@ const {app, Menu, Tray, nativeImage} = require("electron");
|
||||
const path = require("path");
|
||||
const {logger} = require("../server/logger"); // Ajuste le chemin si besoin
|
||||
const fs = require("fs");
|
||||
const {getMainWindow} = require("./windowManager");
|
||||
|
||||
/**
|
||||
* Global reference to the Tray instance to prevent garbage collection.
|
||||
@@ -17,11 +18,10 @@ let tray = null;
|
||||
* - Builds the right-click context menu.
|
||||
* - Handles left-click behavior to toggle main window visibility.
|
||||
*
|
||||
* @param {import('electron').BrowserWindow} mainWindow - The main application window.
|
||||
* @param {boolean} devMode - Indicates whether the application is running in development mode.
|
||||
* @returns {Tray} The created Tray instance.
|
||||
*/
|
||||
function createSystemTray(mainWindow, devMode) {
|
||||
function createSystemTray(devMode) {
|
||||
// Prevent creating multiple tray instances
|
||||
if (tray) return tray;
|
||||
|
||||
@@ -58,7 +58,12 @@ function createSystemTray(mainWindow, devMode) {
|
||||
{
|
||||
label: "Show Freedom Loader",
|
||||
click: () => {
|
||||
mainWindow.show();
|
||||
const window = getMainWindow();
|
||||
if (window && !window.isDestroyed()) {
|
||||
window.show();
|
||||
window.focus();
|
||||
logger.info("Window Restored from SystemTray (Using Show Action)");
|
||||
}
|
||||
},
|
||||
},
|
||||
{ type: "separator" },
|
||||
@@ -82,11 +87,15 @@ function createSystemTray(mainWindow, devMode) {
|
||||
* but it remains standard practice for Windows and Linux environments.
|
||||
*/
|
||||
tray.on("click", () => {
|
||||
if (mainWindow.isVisible()) {
|
||||
mainWindow.hide();
|
||||
const window = getMainWindow();
|
||||
if (!window || window.isDestroyed()) return;
|
||||
|
||||
if (window.isVisible()) {
|
||||
window.hide();
|
||||
} else {
|
||||
mainWindow.show();
|
||||
mainWindow.focus();
|
||||
window.show();
|
||||
window.focus();
|
||||
logger.info("Window Restored from SystemTray (Double Click on Tray Icon)");
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
@@ -87,9 +87,11 @@ async function createMainWindow() {
|
||||
* cancels the destruction and hides the window instead.
|
||||
*/
|
||||
mainWindow.on('close', (event) => {
|
||||
if (!app.isQuitting && config.systemTray ) {
|
||||
|
||||
if (!app.isQuitting && config.configFeatures.systemTray) {
|
||||
event.preventDefault();
|
||||
mainWindow.hide();
|
||||
logger.info("Window Minimized in SystemTray (Using Close Button)");
|
||||
return false;
|
||||
}
|
||||
});
|
||||
|
||||
@@ -7,7 +7,7 @@ const path = require("path");
|
||||
* Indicates whether the application is running in development mode.
|
||||
* Determined by Electron's packaging state.
|
||||
*/
|
||||
const devMode = process.env.NODE_ENV === "test" || !app?.isPackaged;
|
||||
const devMode = !app.isPackaged || process.env.NODE_ENV === "test";
|
||||
|
||||
/**
|
||||
* Resolves the configuration file path depending on runtime environment.
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"verboseLogs": false,
|
||||
"autoDownloadPlaylist": true,
|
||||
"keepPlaylistOrder": false,
|
||||
"createPlaylistFolders": true,
|
||||
"createPlaylistFolders": false,
|
||||
"customCodec": "h264",
|
||||
"logSystem": true,
|
||||
"outputTitleCheck": true,
|
||||
|
||||
40
eslint.config.js
Normal file
40
eslint.config.js
Normal file
@@ -0,0 +1,40 @@
|
||||
const js = require("@eslint/js");
|
||||
const globals = require("globals");
|
||||
|
||||
module.exports = [
|
||||
js.configs.recommended,
|
||||
|
||||
{ignores: ["node_modules/**", "srpm-out/**", "dist/**", "test/**"]},
|
||||
|
||||
{
|
||||
languageOptions: {
|
||||
ecmaVersion: "latest",
|
||||
sourceType: "commonjs",
|
||||
},
|
||||
rules: {
|
||||
"no-unused-vars": ["error", {argsIgnorePattern: "^_"}],
|
||||
"no-console": "off",
|
||||
"semi": ["error", "always"]
|
||||
},
|
||||
|
||||
|
||||
},
|
||||
{
|
||||
files: ["app/**", "server/**", "main.js"],
|
||||
languageOptions: {
|
||||
globals: {...globals.node}
|
||||
}
|
||||
},
|
||||
{
|
||||
files: ["public/**"],
|
||||
languageOptions: {
|
||||
globals: {...globals.browser}
|
||||
}
|
||||
},
|
||||
{
|
||||
files: ["preload.js"],
|
||||
languageOptions: {
|
||||
globals: {...globals.node, ...globals.browser}
|
||||
}
|
||||
}
|
||||
];
|
||||
59
main.js
59
main.js
@@ -38,7 +38,7 @@ app.setAppUserModelId("com.masteracnolo.freedomloader");
|
||||
* Load the app dependencies for hardware choice
|
||||
*/
|
||||
const { logger, logSessionStart, logSessionEnd, logDir } = require("./server/logger");
|
||||
const { configFeatures } = require("./config");
|
||||
const { configFeatures, devMode} = require("./config");
|
||||
|
||||
/**
|
||||
* In-memory snapshot of application feature flags.
|
||||
@@ -48,18 +48,18 @@ const { configFeatures } = require("./config");
|
||||
*/
|
||||
if (!configFeatures.enableHardwareAcceleration){
|
||||
app.disableHardwareAcceleration();
|
||||
logger.info("Disabled Hardware Acceleration")
|
||||
logger.info("Disabled Hardware Acceleration");
|
||||
} else {
|
||||
logger.info("Enable Hardware Acceleration")
|
||||
logger.info("Enable Hardware Acceleration");
|
||||
}
|
||||
|
||||
if(configFeatures.devMode){
|
||||
if(devMode){
|
||||
/**
|
||||
* Start devTron extensions - @see https://github.com/electron/devtron
|
||||
*/
|
||||
const { devtron } = require('@electron/devtron');
|
||||
devtron.install();
|
||||
logger.info("Loaded DevTron Extension")
|
||||
logger.info("Loaded DevTron Extension");
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -74,8 +74,14 @@ const { updateYtDlp } = require("./app/ytDlpUpdater");
|
||||
const { createMainWindow, getMainWindow } = require("./app/windowManager");
|
||||
const { registerIpcHandlers } = require("./app/ipcHandlers");
|
||||
const { createSplashWindow, closeSplashWindow, setSplashProgress } = require("./app/splashManager");
|
||||
const { userThemesPath, initUserThemes, isWindows, validateBinaries, defaultDownloadFolder } = require("./server/helpers/path.helpers");
|
||||
const { userThemesPath, initUserThemes, validateBinaries, defaultDownloadFolder } = require("./server/helpers/path.helpers");
|
||||
const {createSystemTray, destroyTray} = require("./app/tray");
|
||||
const { stopServer } = require("./server/server");
|
||||
|
||||
/**
|
||||
* Expose .env in process.env
|
||||
*/
|
||||
require("dotenv").config();
|
||||
|
||||
/**
|
||||
* Global flag indicating if the application is intentionally shutting down.
|
||||
@@ -91,6 +97,28 @@ app.isQuitting = false;
|
||||
*/
|
||||
let isCleanedUp = false;
|
||||
|
||||
/**
|
||||
* Performs a graceful shutdown of all application services asynchronously.
|
||||
* Once finished, it re-triggers the app.quit() process.
|
||||
*/
|
||||
async function cleanShutdown() {
|
||||
try {
|
||||
destroyTray();
|
||||
await stopRPC();
|
||||
stopServer();
|
||||
|
||||
} catch (err) {
|
||||
logger.error("Error during cleanup:", err);
|
||||
|
||||
} finally {
|
||||
logger.info("All services stopped. Have a nice day!");
|
||||
logSessionEnd();
|
||||
|
||||
isCleanedUp = true;
|
||||
app.quit();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* If another instance want to run
|
||||
*/
|
||||
@@ -112,7 +140,7 @@ app.whenReady().then(async () => {
|
||||
|
||||
createSplashWindow();
|
||||
|
||||
if (!configFeatures.devMode && !checkNativeDependencies()) return;
|
||||
if (!devMode && !checkNativeDependencies()) return;
|
||||
|
||||
const { userYtDlp } = require("./server/helpers/path.helpers");
|
||||
updateYtDlp(userYtDlp);
|
||||
@@ -138,7 +166,7 @@ app.whenReady().then(async () => {
|
||||
getMainWindow().show();
|
||||
|
||||
if (configFeatures.systemTray) {
|
||||
createSystemTray(getMainWindow(), configFeatures.devMode);
|
||||
createSystemTray(devMode);
|
||||
}
|
||||
|
||||
if (configFeatures.discordRPC) startRPC();
|
||||
@@ -166,19 +194,6 @@ app.on("before-quit", (event) => {
|
||||
if (!isCleanedUp) {
|
||||
event.preventDefault();
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
destroyTray();
|
||||
await stopRPC();
|
||||
} catch (err) {
|
||||
logger.error("Error during cleanup:", err);
|
||||
} finally {
|
||||
logger.info("All services stopped. Have a nice day!");
|
||||
logSessionEnd();
|
||||
|
||||
isCleanedUp = true;
|
||||
app.quit();
|
||||
}
|
||||
})();
|
||||
cleanShutdown();
|
||||
}
|
||||
});
|
||||
1086
package-lock.json
generated
1086
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
97
package.json
97
package.json
@@ -1,7 +1,8 @@
|
||||
{
|
||||
"name": "freedom-loader",
|
||||
"desktopName": "com.masteracnolo.freedomloader",
|
||||
"productName": "Freedom Loader",
|
||||
"version": "1.6.2",
|
||||
"version": "1.6.4",
|
||||
"author": "MasterAcnolo <MasterAcnolo@users.noreply.github.com>",
|
||||
"description": "Free and open-source GUI for yt-dlp — download video and audio from hundreds of platforms",
|
||||
"homepage": "https://masteracnolo.github.io/Freedom-Loader-Site/",
|
||||
@@ -21,7 +22,6 @@
|
||||
"dev": "nodemon --watch server --watch app --watch main.js --watch config.js --ext js,json --exec \"electron --no-warnings .\"",
|
||||
"dev:warn": "nodemon --watch server --watch app --watch main.js --watch config.js --ext js,json --exec \"electron --trace-warnings .\"",
|
||||
"dev:debug": "nodemon --watch server --watch app --watch main.js --watch config.js --ext js,json --exec \"WAYLAND_DEBUG=1 ELECTRON_ENABLE_LOGGING=1 ELECTRON_ENABLE_STACK_DUMPING=1 electron --enable-logging --v=1 .\"",
|
||||
|
||||
"build": "electron-builder",
|
||||
"build:win": "electron-builder --win",
|
||||
"build:linux": "electron-builder --linux",
|
||||
@@ -30,16 +30,17 @@
|
||||
"release": "bash scripts/release.sh",
|
||||
"release:publish": "bash scripts/release.sh --publish",
|
||||
"release:dry-run": "bash scripts/release.sh --dry-run",
|
||||
|
||||
"test": "jest",
|
||||
"test:unit": "jest test/unit",
|
||||
|
||||
"lint": "eslint . --format pretty",
|
||||
"lint:fix": "eslint . --fix --format pretty",
|
||||
"update": "npm update"
|
||||
},
|
||||
"dependencies": {
|
||||
"chalk": "^4.1.2",
|
||||
"debug": "^4.4.1",
|
||||
"discord-rpc": "^4.0.1",
|
||||
"dotenv": "^17.4.2",
|
||||
"electron-updater": "^6.6.2",
|
||||
"express": "^5.1.0",
|
||||
"express-rate-limit": "^8.2.1",
|
||||
@@ -50,10 +51,14 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@electron/devtron": "^2.1.1",
|
||||
"@eslint/js": "^10.0.1",
|
||||
"@jest/globals": "^30.4.1",
|
||||
"@playwright/test": "^1.62.1",
|
||||
"electron": "^43.3.0",
|
||||
"electron": "^44.3.0",
|
||||
"electron-builder": "^26.15.3",
|
||||
"eslint": "^10.10.0",
|
||||
"eslint-formatter-pretty": "^7.1.0",
|
||||
"globals": "^17.12.0",
|
||||
"jest": "^30.4.2",
|
||||
"nodemon": "^3.1.14",
|
||||
"playwright": "^1.62.1"
|
||||
@@ -84,33 +89,21 @@
|
||||
"from": "theme",
|
||||
"to": "theme"
|
||||
},
|
||||
{
|
||||
"from": "build/app-icon.ico",
|
||||
"to": "app-icon.ico"
|
||||
},
|
||||
{
|
||||
"from": "build/app-icon-64x64.png",
|
||||
"to": "app-icon-64x64.png"
|
||||
},
|
||||
{
|
||||
"from": "build/confirm-icon.png",
|
||||
"to": "confirm-icon.png"
|
||||
},
|
||||
{
|
||||
"from": "build/banner.bmp",
|
||||
"to": "banner.bmp"
|
||||
},
|
||||
{
|
||||
"from": "build/banner.png",
|
||||
"to": "banner.png"
|
||||
},
|
||||
{
|
||||
"from": "build/error.png",
|
||||
"to": "error.png"
|
||||
},
|
||||
{
|
||||
"from": "config/config.default.json",
|
||||
"to": "config/config.default.json"
|
||||
},
|
||||
{
|
||||
"from": "build",
|
||||
"to": ".",
|
||||
"filter": [
|
||||
"app-icon.ico",
|
||||
"app-icon-64x64.png",
|
||||
"confirm-icon.png",
|
||||
"banner.bmp",
|
||||
"banner.png",
|
||||
"error.png"
|
||||
]
|
||||
}
|
||||
],
|
||||
"win": {
|
||||
@@ -119,20 +112,14 @@
|
||||
"artifactName": "Freedom-Loader-Setup-${version}.${ext}",
|
||||
"extraResources": [
|
||||
{
|
||||
"from": "resources/binaries/win-32/yt-dlp.exe",
|
||||
"to": "binaries/yt-dlp.exe"
|
||||
},
|
||||
{
|
||||
"from": "resources/binaries/win-32/ffmpeg.exe",
|
||||
"to": "binaries/ffmpeg.exe"
|
||||
},
|
||||
{
|
||||
"from": "resources/binaries/win-32/ffprobe.exe",
|
||||
"to": "binaries/ffprobe.exe"
|
||||
},
|
||||
{
|
||||
"from": "resources/binaries/win-32/deno.exe",
|
||||
"to": "binaries/deno.exe"
|
||||
"from": "resources/binaries/win-32",
|
||||
"to": "binaries",
|
||||
"filter": [
|
||||
"yt-dlp.exe",
|
||||
"ffmpeg.exe",
|
||||
"ffprobe.exe",
|
||||
"deno.exe"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -154,24 +141,20 @@
|
||||
"snap"
|
||||
],
|
||||
"category": "Utility",
|
||||
"synopsis": "GUI for yt-dlp to download video and audio with metadata",
|
||||
"maintainer": "MasterAcnolo",
|
||||
"icon": "build/app-icon.png",
|
||||
"executableName": "freedom-loader",
|
||||
"extraResources": [
|
||||
{
|
||||
"from": "resources/binaries/linux/yt-dlp",
|
||||
"to": "binaries/yt-dlp"
|
||||
},
|
||||
{
|
||||
"from": "resources/binaries/linux/ffmpeg",
|
||||
"to": "binaries/ffmpeg"
|
||||
},
|
||||
{
|
||||
"from": "resources/binaries/linux/ffprobe",
|
||||
"to": "binaries/ffprobe"
|
||||
},
|
||||
{
|
||||
"from": "resources/binaries/linux/deno",
|
||||
"to": "binaries/deno"
|
||||
"from": "resources/binaries/linux",
|
||||
"to": "binaries",
|
||||
"filter": [
|
||||
"yt-dlp",
|
||||
"ffmpeg",
|
||||
"ffprobe",
|
||||
"deno"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
89
preload.js
89
preload.js
@@ -8,6 +8,26 @@ const { contextBridge, ipcRenderer } = require("electron");
|
||||
* All calls are explicitly whitelisted.
|
||||
*/
|
||||
contextBridge.exposeInMainWorld("electronAPI", {
|
||||
/**
|
||||
* Sends error log message.
|
||||
*
|
||||
* @param {...any} args - Values to log
|
||||
*/
|
||||
logError: (...args) => ipcRenderer.send("log-error", args.map(arg => typeof arg === "object" ? JSON.stringify(arg) : arg).join(" ")),
|
||||
|
||||
/**
|
||||
* Sends info log message.
|
||||
*
|
||||
* @param {...any} args - Values to log
|
||||
*/
|
||||
logInfo: (...args) => ipcRenderer.send("log-info", args.map(arg => typeof arg === "object" ? JSON.stringify(arg) : arg).join(" ")),
|
||||
|
||||
/**
|
||||
* Sends warning log message.
|
||||
*
|
||||
* @param {...any} args - Values to log
|
||||
*/
|
||||
logWarn: (...args) => ipcRenderer.send("log-warn", args.map(arg => typeof arg === "object" ? JSON.stringify(arg) : arg).join(" ")),
|
||||
|
||||
/**
|
||||
* Return process.platform to renderer
|
||||
@@ -42,12 +62,11 @@ contextBridge.exposeInMainWorld("electronAPI", {
|
||||
* @param {string} key - Feature name
|
||||
* @param {any} value - Feature value
|
||||
*/
|
||||
setFeature: (key, value) =>
|
||||
ipcRenderer.invoke("set-feature", { key, value }),
|
||||
setFeature: (key, value) => ipcRenderer.invoke("set-feature", { key, value }),
|
||||
|
||||
/**
|
||||
* Returns the current application version.
|
||||
*/
|
||||
*/
|
||||
getVersion: () => ipcRenderer.invoke("version"),
|
||||
|
||||
/**
|
||||
@@ -67,8 +86,61 @@ contextBridge.exposeInMainWorld("electronAPI", {
|
||||
* Forces a reload of theme files (useful after modification/import).
|
||||
*/
|
||||
reloadThemes: () => ipcRenderer.invoke("reload-themes"),
|
||||
});
|
||||
|
||||
/*
|
||||
* ==========================================
|
||||
* Auto Updater IPC
|
||||
* ==========================================
|
||||
*/
|
||||
|
||||
/**
|
||||
* Checks if an update has already been detected by the main process.
|
||||
*
|
||||
* @returns {Promise<boolean>} Resolves to true if an update is available.
|
||||
*/
|
||||
isUpdateAvailable: () => ipcRenderer.invoke("is-update-available"),
|
||||
|
||||
/**
|
||||
* Subscribes to the update available event pushed by the main process.
|
||||
*
|
||||
* @param {Function} callback - Function executed with update info when an update is found.
|
||||
*/
|
||||
onUpdateAvailable: (callback) =>
|
||||
ipcRenderer.on("update-available", (_, info) => callback(info)),
|
||||
|
||||
/**
|
||||
* Instructs the main process to start downloading the available update.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
downloadUpdate: () => ipcRenderer.invoke("download-update"),
|
||||
|
||||
/**
|
||||
* Instructs the main process to quit the application and install the downloaded update.
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
installUpdate: () => ipcRenderer.invoke("install-update"),
|
||||
|
||||
/**
|
||||
* Subscribes to the download progress event.
|
||||
*
|
||||
* @param {Function} callback - Function executed with progress metrics (percent, bytesPerSecond, transferred, total).
|
||||
*/
|
||||
onDownloadProgress: (callback) =>
|
||||
ipcRenderer.on("update-progress", (_, progress) => callback(progress)),
|
||||
|
||||
/**
|
||||
* Subscribes to the update downloaded event.
|
||||
* Triggered when the update file is fully downloaded and ready to install.
|
||||
*
|
||||
* @param {Function} callback - Function executed with update info.
|
||||
*/
|
||||
onUpdateDownloaded: (callback) =>
|
||||
ipcRenderer.on("update-downloaded", (_, info) => callback(info)),
|
||||
|
||||
openReleasePage: () => ipcRenderer.send("open-release-page"),
|
||||
});
|
||||
|
||||
/**
|
||||
* Exposes window control and developer utilities for the custom topbar UI.
|
||||
@@ -76,7 +148,6 @@ contextBridge.exposeInMainWorld("electronAPI", {
|
||||
* These methods forward commands to the Electron main process via IPC.
|
||||
*/
|
||||
contextBridge.exposeInMainWorld("topbarAPI", {
|
||||
|
||||
/**
|
||||
* Minimizes the application window.
|
||||
*/
|
||||
@@ -126,4 +197,12 @@ contextBridge.exposeInMainWorld("topbarAPI", {
|
||||
* Opens configuration/settings panel.
|
||||
*/
|
||||
openConfig: () => ipcRenderer.send("open-config"),
|
||||
|
||||
/**
|
||||
* Send Bug Report
|
||||
*
|
||||
* @param params
|
||||
* @returns {Promise<any>}
|
||||
*/
|
||||
sendReport: (params) => ipcRenderer.invoke("send-report", params),
|
||||
});
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 10 KiB |
@@ -13,6 +13,8 @@
|
||||
<link rel="stylesheet" href="styles/styles.css">
|
||||
<link rel="stylesheet" href="styles/layout/topbar.css">
|
||||
|
||||
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined" rel="stylesheet">
|
||||
<link href="https://fonts.googleapis.com/icon?family=Material+Icons+Round" rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
@@ -21,6 +23,7 @@
|
||||
<div class="custom-controls">
|
||||
<button id="devtools-btn" title="Dev Tools">Tools</button>
|
||||
<button id="logs-btn" title="Logs">Logs</button>
|
||||
<button id="report-bug-btn" title="Report a bug">Report a Bug</button> <!-- TODO: Find a better place -->
|
||||
<button id="website-btn" title="Website">Website</button>
|
||||
<button id="wiki-btn" title="Wiki">Wiki</button>
|
||||
<button id="workshop-btn" title="Workshop">Theme Workshop</button>
|
||||
@@ -262,7 +265,7 @@
|
||||
</div>
|
||||
|
||||
<div class="download-path">
|
||||
Will be save on <span id="savePath"></span>
|
||||
Will be saved in <span id="savePath"></span>
|
||||
<button id="changePath">Edit</button>
|
||||
</div>
|
||||
|
||||
@@ -295,7 +298,6 @@
|
||||
|
||||
<span id="version-badge" class="version-badge"></span>
|
||||
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<!-- Toast Container -->
|
||||
@@ -303,6 +305,31 @@
|
||||
|
||||
<h2 id="reference"> Because Why Not ? </h2>
|
||||
|
||||
<div id="updateAvailable" style="display:none">
|
||||
<div class="update-banner">
|
||||
<div class="banner-row">
|
||||
<div class="banner-left">
|
||||
<div class="icon-wrap">
|
||||
<span class="material-symbols-outlined" id="update-icon">download</span>
|
||||
</div>
|
||||
<div class="text-block">
|
||||
<span class="update-title" id="update-title">Update available</span>
|
||||
<span class="update-sub" id="update-sub">A new version is ready</span>
|
||||
</div>
|
||||
</div>
|
||||
<button class="btn-update" id="btn-update">Download</button>
|
||||
</div>
|
||||
<div class="progress-wrap" id="progress-wrap" style="display:none">
|
||||
<div class="progress-track">
|
||||
<div class="progress-fill" id="progress-fill"></div>
|
||||
</div>
|
||||
<div class="progress-meta">
|
||||
<span id="progress-pct">0%</span>
|
||||
<span id="progress-eta"></span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Scripts -->
|
||||
<script src="script/toast.js"></script>
|
||||
@@ -314,6 +341,8 @@
|
||||
<script src="script/fetchinfo.js"></script>
|
||||
<script src="script/progressBar.js"></script>
|
||||
<script src="script/customthemes.js"></script>
|
||||
<script src="script/reportBug.js"></script>
|
||||
<script src="script/autoUpdate.js"></script>
|
||||
<script type="module" src="script/topbar.js"></script>
|
||||
|
||||
</body>
|
||||
|
||||
99
public/script/autoUpdate.js
Normal file
99
public/script/autoUpdate.js
Normal file
@@ -0,0 +1,99 @@
|
||||
async function initUpdateUI() {
|
||||
const container = document.getElementById("updateAvailable");
|
||||
|
||||
const hasUpdate = await window.electronAPI.isUpdateAvailable();
|
||||
if (hasUpdate) {
|
||||
setupAndShowUpdateUI();
|
||||
}
|
||||
|
||||
window.electronAPI.onUpdateAvailable((info) => {
|
||||
setupAndShowUpdateUI(info);
|
||||
});
|
||||
|
||||
function setupAndShowUpdateUI(info) {
|
||||
container.style.display = "block";
|
||||
|
||||
const btn = document.getElementById("btn-update");
|
||||
const icon = document.getElementById("update-icon");
|
||||
const title = document.getElementById("update-title");
|
||||
const sub = document.getElementById("update-sub");
|
||||
const progressWrap = document.getElementById("progress-wrap");
|
||||
const progressFill = document.getElementById("progress-fill");
|
||||
const progressPct = document.getElementById("progress-pct");
|
||||
const progressEta = document.getElementById("progress-eta");
|
||||
|
||||
if (info && info.version) {
|
||||
sub.textContent = `A new version (${info.version}) is ready`;
|
||||
}
|
||||
|
||||
if (info && info.environment && info.environment !== "auto") {
|
||||
icon.textContent = "open_in_new";
|
||||
|
||||
if (info.environment === "snap") {
|
||||
sub.textContent = `Version ${info.version} is out. Use the Snap Store or run "snap refresh".`;
|
||||
btn.textContent = "View Release";
|
||||
} else {
|
||||
sub.textContent = `Version ${info.version} is out. Update via your package manager or download it manually.`;
|
||||
btn.textContent = "Download manually";
|
||||
}
|
||||
|
||||
btn.onclick = () => {
|
||||
window.electronAPI.openReleasePage();
|
||||
container.style.display = "none";
|
||||
};
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
const initialButtonText = btn.textContent;
|
||||
const initialIconText = icon.textContent;
|
||||
const initialTitleText = title.textContent;
|
||||
const initialSubText = sub.textContent;
|
||||
|
||||
btn.onclick = async () => {
|
||||
btn.disabled = true;
|
||||
btn.textContent = "Downloading...";
|
||||
icon.textContent = "download";
|
||||
title.textContent = "Downloading update";
|
||||
progressWrap.style.display = "flex";
|
||||
|
||||
try {
|
||||
await window.electronAPI.downloadUpdate();
|
||||
} catch {
|
||||
btn.disabled = false;
|
||||
btn.textContent = initialButtonText;
|
||||
icon.textContent = initialIconText;
|
||||
title.textContent = initialTitleText;
|
||||
sub.textContent = initialSubText;
|
||||
progressWrap.style.display = "none";
|
||||
progressFill.style.width = "0%";
|
||||
progressPct.textContent = "0%";
|
||||
progressEta.textContent = "";
|
||||
}
|
||||
};
|
||||
|
||||
window.electronAPI.onDownloadProgress((progress) => {
|
||||
const pct = Math.round(progress.percent);
|
||||
progressFill.style.width = pct + "%";
|
||||
progressPct.textContent = pct + "%";
|
||||
|
||||
const remaining = (progress.total - progress.transferred) / progress.bytesPerSecond;
|
||||
progressEta.textContent =
|
||||
remaining > 0 ? `~${Math.ceil(remaining)}s left` : "almost done";
|
||||
});
|
||||
|
||||
window.electronAPI.onUpdateDownloaded(() => {
|
||||
progressFill.style.width = "100%";
|
||||
progressPct.textContent = "100%";
|
||||
progressEta.textContent = "Done";
|
||||
icon.textContent = "check";
|
||||
title.textContent = "Ready to install";
|
||||
sub.textContent = "Restart to apply the update";
|
||||
btn.textContent = "Restart";
|
||||
btn.disabled = false;
|
||||
btn.onclick = () => window.electronAPI.installUpdate();
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
initUpdateUI();
|
||||
@@ -269,7 +269,7 @@ async function init() {
|
||||
infoDiv.classList.add("visible");
|
||||
});
|
||||
|
||||
})
|
||||
});
|
||||
|
||||
}
|
||||
|
||||
|
||||
121
public/script/reportBug.js
Normal file
121
public/script/reportBug.js
Normal file
@@ -0,0 +1,121 @@
|
||||
class BugReportModal {
|
||||
constructor() {
|
||||
this.modal = null;
|
||||
this.form = null;
|
||||
this.init();
|
||||
}
|
||||
|
||||
init() {
|
||||
this.modal = document.createElement("div");
|
||||
this.modal.className = "bug-modal-overlay";
|
||||
this.modal.style.cssText = "display:none; position:fixed; top:0; left:0; width:100%; height:100%; background:rgba(0,0,0,0.7); justify-content:center; align-items:center; z-index:99999; font-family:sans-serif;";
|
||||
|
||||
this.modal.innerHTML = `
|
||||
<div class="bug-modal-content" style="background:#14141491 !important; color:#ffffff !important; padding:24px !important; border-radius:10px !important; width:420px !important; box-shadow: 0 10px 25px rgba(0,0,0,0.8) !important; display:flex !important; flex-direction:column !important; gap:16px !important; border: 1px solid #333 !important; box-sizing: border-box !important;">
|
||||
<h3 style="margin:0 !important; font-size:1.2rem !important; font-weight:600 !important; color:#ffffff !important;">Report a Bug</h3>
|
||||
<form id="bugReportForm" style="display:flex !important; flex-direction:column !important; gap:12px !important; width:unset !important; margin:0 !important; background:transparent !important; box-shadow: unset !important;">
|
||||
<div style="display:flex !important; flex-direction:column !important; gap:4px !important;">
|
||||
<label style="font-size:0.85rem !important; color:#aaaaaa !important;">Title <span style="color: red; font-weight: bold" >*</span> </label>
|
||||
<input type="text" id="bugTitle" required style="background:#2a2a2a !important; border:1px solid #444 !important; color:#ffffff !important; border-radius:6px !important; padding:8px 10px !important; outline:none !important; width:100% !important; box-sizing: border-box !important;" />
|
||||
</div>
|
||||
<div style="display:flex !important; flex-direction:column !important; gap:4px !important;">
|
||||
<label style="font-size:0.85rem !important; color:#aaaaaa !important;">Description <span style="color: red; font-weight: bold" >*</span></label>
|
||||
<textarea id="bugDescription" placeholder="Provide some details about the bug" required rows="4" style="background:#2a2a2a !important; border:1px solid #444 !important; color:#ffffff !important; border-radius:6px !important; padding:8px 10px !important; outline:none !important; resize:vertical !important; width:100% !important; box-sizing: border-box !important;"></textarea>
|
||||
</div>
|
||||
<div style="display:flex !important; flex-direction:column !important; gap:4px !important;">
|
||||
<label style="font-size:0.85rem !important; color:#aaaaaa !important;">Include Logs From Today</label>
|
||||
<select id="bugIncludeLogs" style="background:#2a2a2a !important; border:1px solid #444 !important; color:#ffffff !important; border-radius:6px !important; padding:8px 10px !important; outline:none !important; width:100% !important; box-sizing: border-box !important;">
|
||||
<option value="yes" style="background:#2a2a2a !important; color:#ffffff !important;">Yes</option>
|
||||
<option value="no" style="background:#2a2a2a !important; color:#ffffff !important;">No</option>
|
||||
</select>
|
||||
</div>
|
||||
<div style="display:flex !important; justify-content:flex-end !important; gap:8px !important; margin-top:8px !important;">
|
||||
<button type="button" id="bugCancelBtn" style="background:#333333 !important; border:none !important; color:#cccccc !important; padding:8px 14px !important; border-radius:6px !important; cursor:pointer !important;">Cancel</button>
|
||||
<button type="submit" style="background:#4f46e5 !important; border:none !important; color:#ffffff !important; padding:8px 16px !important; border-radius:6px !important; cursor:pointer !important; font-weight:500 !important;">Send</button>
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
`;
|
||||
|
||||
document.body.appendChild(this.modal);
|
||||
this.form = this.modal.querySelector("#bugReportForm");
|
||||
|
||||
this.bindEvents();
|
||||
}
|
||||
|
||||
bindEvents() {
|
||||
const titleInput = this.modal.querySelector("#bugTitle");
|
||||
const descInput = this.modal.querySelector("#bugDescription");
|
||||
|
||||
titleInput.addEventListener("input", () => {
|
||||
localStorage.setItem("draft_bug_title", titleInput.value);
|
||||
});
|
||||
|
||||
descInput.addEventListener("input", () => {
|
||||
localStorage.setItem("draft_bug_desc", descInput.value);
|
||||
});
|
||||
|
||||
this.modal.querySelector("#bugCancelBtn").addEventListener("click", () => {
|
||||
this.close();
|
||||
});
|
||||
|
||||
this.modal.addEventListener("click", (e) => {
|
||||
if (e.target === this.modal) {
|
||||
this.close();
|
||||
}
|
||||
});
|
||||
|
||||
this.form.addEventListener("submit", async (e) => {
|
||||
e.preventDefault();
|
||||
const data = {
|
||||
title: titleInput.value,
|
||||
description: descInput.value,
|
||||
includeLogs: this.modal.querySelector("#bugIncludeLogs").value
|
||||
};
|
||||
|
||||
window.electronAPI.logInfo("Submitting:", data);
|
||||
|
||||
try {
|
||||
const success = await window.electronAPI.sendReport(data);
|
||||
|
||||
if (success) {
|
||||
localStorage.removeItem("draft_bug_title");
|
||||
localStorage.removeItem("draft_bug_desc");
|
||||
this.form.reset();
|
||||
this.close();
|
||||
window.showSuccess("Bug report sent successfully!");
|
||||
}
|
||||
} catch (err) {
|
||||
window.showError("Failed to send bug report.");
|
||||
window.electronAPI.logError("Failed to send bug report:", err.message);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
loadState() {
|
||||
const savedTitle = localStorage.getItem("draft_bug_title");
|
||||
const savedDesc = localStorage.getItem("draft_bug_desc");
|
||||
|
||||
if (savedTitle) {
|
||||
this.modal.querySelector("#bugTitle").value = savedTitle;
|
||||
}
|
||||
if (savedDesc) {
|
||||
this.modal.querySelector("#bugDescription").value = savedDesc;
|
||||
}
|
||||
}
|
||||
|
||||
open() {
|
||||
this.loadState();
|
||||
this.modal.style.display = "flex";
|
||||
}
|
||||
|
||||
close() {
|
||||
this.modal.style.display = "none";
|
||||
}
|
||||
}
|
||||
|
||||
window.bugModal = new BugReportModal();
|
||||
|
||||
document.getElementById("report-bug-btn").addEventListener("click", () => {
|
||||
window.bugModal.open();
|
||||
});
|
||||
@@ -16,8 +16,7 @@ let isOpen = false;
|
||||
* Toggles visibility of the settings panel when clicking the settings button.
|
||||
*/
|
||||
settingsButton.addEventListener("click", () => {
|
||||
const currentlyOpen = settingsPanel.style.display === "block";
|
||||
settingsPanel.style.display = currentlyOpen ? "none" : "block";
|
||||
settingsPanel.classList.toggle("open");
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -25,7 +24,7 @@ settingsButton.addEventListener("click", () => {
|
||||
*/
|
||||
function closePanel() {
|
||||
isOpen = false;
|
||||
settingsPanel.style.display = "none";
|
||||
settingsPanel.classList.remove("open");
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -17,18 +17,20 @@ window.showToast = function (message, type = "info", duration = 4000) {
|
||||
toast.classList.add("toast", type);
|
||||
|
||||
const icons = {
|
||||
success: "✓",
|
||||
error: "✕",
|
||||
warning: "⚠",
|
||||
info: "ℹ"
|
||||
success: "check_circle",
|
||||
error: "error",
|
||||
warning: "warning",
|
||||
info: "info"
|
||||
};
|
||||
|
||||
const icon = icons[type] || icons.info;
|
||||
|
||||
toast.style.setProperty("--toast-duration", `${duration}ms`);
|
||||
toast.innerHTML = `
|
||||
<span class="toast-icon">${icon}</span>
|
||||
<span class="toast-icon material-icons-round">${icon}</span>
|
||||
<span class="toast-message">${message}</span>
|
||||
<button class="toast-close" title="Close">×</button>
|
||||
<div class="toast-progress"></div>
|
||||
`;
|
||||
|
||||
const closeBtn = toast.querySelector(".toast-close");
|
||||
|
||||
128
public/styles/components/autoUpdate.css
Normal file
128
public/styles/components/autoUpdate.css
Normal file
@@ -0,0 +1,128 @@
|
||||
:root {
|
||||
--border-accent: #0ea5e966;
|
||||
--bg-accent: #0ea5e915;
|
||||
--fill-accent: #0ea5e9;
|
||||
--text-accent: #0369a1;
|
||||
--text-secondary: #64748b;
|
||||
}
|
||||
|
||||
#updateAvailable {
|
||||
display: none;
|
||||
width: fit-content;
|
||||
max-width: 420px;
|
||||
position: absolute;
|
||||
right: 18px;
|
||||
bottom: 5%;
|
||||
z-index: 50;
|
||||
}
|
||||
|
||||
.update-banner {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 12px;
|
||||
padding: 12px 16px;
|
||||
border-radius: 10px;
|
||||
border: 0.5px solid var(--border-accent);
|
||||
background: var(--bg-accent);
|
||||
backdrop-filter: blur(8px);
|
||||
}
|
||||
|
||||
.banner-row {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
gap: 16px;
|
||||
}
|
||||
|
||||
.banner-left {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
.icon-wrap {
|
||||
width: 32px;
|
||||
height: 32px;
|
||||
border-radius: 8px;
|
||||
background: var(--fill-accent);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.icon-wrap i {
|
||||
font-size: 16px;
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.text-block {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 4px;
|
||||
}
|
||||
|
||||
.update-title {
|
||||
font-size: 13px;
|
||||
font-weight: 600;
|
||||
color: var(--text-accent);
|
||||
}
|
||||
|
||||
.update-sub {
|
||||
font-size: 11px;
|
||||
color: var(--text-secondary);
|
||||
line-height: 1.4;
|
||||
}
|
||||
|
||||
.btn-update {
|
||||
font-size: 12px;
|
||||
font-weight: 500;
|
||||
padding: 6px 14px;
|
||||
border-radius: 8px;
|
||||
background: var(--fill-accent);
|
||||
color: #fff;
|
||||
border: none;
|
||||
cursor: pointer;
|
||||
white-space: nowrap;
|
||||
flex-shrink: 0;
|
||||
transition: opacity 0.2s;
|
||||
}
|
||||
|
||||
.btn-update:hover:not(:disabled) {
|
||||
opacity: 0.9;
|
||||
}
|
||||
|
||||
.btn-update:disabled {
|
||||
opacity: 0.6;
|
||||
cursor: not-allowed;
|
||||
}
|
||||
|
||||
.progress-wrap {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 6px;
|
||||
}
|
||||
|
||||
.progress-track {
|
||||
height: 4px;
|
||||
border-radius: 99px;
|
||||
background: var(--border-accent);
|
||||
overflow: hidden;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.progress-fill {
|
||||
height: 100%;
|
||||
border-radius: 99px;
|
||||
background: var(--fill-accent);
|
||||
width: 0%;
|
||||
transition: width 0.3s ease;
|
||||
}
|
||||
|
||||
.progress-meta {
|
||||
font-size: 11px;
|
||||
color: var(--text-secondary);
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
}
|
||||
@@ -5,73 +5,70 @@
|
||||
right: 20px;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 8px;
|
||||
gap: 12px;
|
||||
z-index: 9999;
|
||||
pointer-events: none;
|
||||
}
|
||||
|
||||
/* Toast */
|
||||
.toast {
|
||||
position: relative;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 10px;
|
||||
padding: 10px 14px;
|
||||
background-color: rgba(50, 50, 50, 0.9);
|
||||
border-radius: 6px;
|
||||
color: #ffffff;
|
||||
font-size: 0.9rem;
|
||||
max-width: 220px;
|
||||
min-width: 100px;
|
||||
animation: slideIn 0.25s ease-out;
|
||||
gap: 12px;
|
||||
padding: 14px 16px;
|
||||
background-color: rgba(30, 30, 30, 0.9);
|
||||
backdrop-filter: blur(12px);
|
||||
-webkit-backdrop-filter: blur(12px);
|
||||
border: 1px solid rgba(255, 255, 255, 0.08);
|
||||
border-radius: 10px;
|
||||
color: #f3f4f6;
|
||||
font-family: inherit;
|
||||
font-size: 0.875rem;
|
||||
max-width: 320px;
|
||||
min-width: 220px;
|
||||
box-shadow: 0 10px 25px -5px rgba(0, 0, 0, 0.3), 0 8px 10px -6px rgba(0, 0, 0, 0.2);
|
||||
animation: slideIn 0.3s cubic-bezier(0.16, 1, 0.3, 1) forwards;
|
||||
pointer-events: auto;
|
||||
backdrop-filter: blur(8px);
|
||||
}
|
||||
|
||||
.toast.success {
|
||||
background-color: rgba(40, 167, 69, 0.15);
|
||||
}
|
||||
|
||||
.toast.error {
|
||||
background-color: rgba(220, 53, 69, 0.15);
|
||||
}
|
||||
|
||||
.toast.warning {
|
||||
background-color: rgba(255, 193, 7, 0.15);
|
||||
}
|
||||
|
||||
.toast.info {
|
||||
background-color: rgba(23, 162, 184, 0.15);
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Toast Icon */
|
||||
.toast-icon {
|
||||
flex-shrink: 0;
|
||||
font-size: 18px;
|
||||
font-size: 20px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.toast-icon svg {
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
.toast.success .toast-icon {
|
||||
color: #28a745;
|
||||
color: #22c55e;
|
||||
}
|
||||
|
||||
.toast.error .toast-icon {
|
||||
color: #dc3545;
|
||||
color: #ef4444;
|
||||
}
|
||||
|
||||
.toast.warning .toast-icon {
|
||||
color: #ffc107;
|
||||
color: #f59e0b;
|
||||
}
|
||||
|
||||
.toast.info .toast-icon {
|
||||
color: #17a2b8;
|
||||
color: #0ea5e9;
|
||||
}
|
||||
|
||||
/* Toast Message */
|
||||
.toast-message {
|
||||
flex: 1;
|
||||
font-weight: 500;
|
||||
font-weight: 400;
|
||||
line-height: 1.4;
|
||||
word-break: break-word;
|
||||
}
|
||||
|
||||
/* Toast Close Button */
|
||||
@@ -79,54 +76,83 @@
|
||||
flex-shrink: 0;
|
||||
background: none;
|
||||
border: none;
|
||||
color: currentColor;
|
||||
color: #9ca3af;
|
||||
cursor: pointer;
|
||||
font-size: 18px;
|
||||
padding: 0;
|
||||
font-size: 16px;
|
||||
width: 24px;
|
||||
height: 24px;
|
||||
border-radius: 4px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
opacity: 0.5;
|
||||
transition: opacity 0.2s ease;
|
||||
transition: background-color 0.15s ease, color 0.15s ease;
|
||||
}
|
||||
|
||||
.toast-close:hover {
|
||||
opacity: 1;
|
||||
background-color: rgba(255, 255, 255, 0.1);
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
.toast-progress {
|
||||
position: absolute;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
height: 3px;
|
||||
width: 100%;
|
||||
background-color: rgba(255, 255, 255, 0.1);
|
||||
animation: progress var(--toast-duration, 4000ms) linear forwards;
|
||||
}
|
||||
|
||||
.toast.success .toast-progress {
|
||||
background-color: #22c55e;
|
||||
}
|
||||
|
||||
.toast.error .toast-progress {
|
||||
background-color: #ef4444;
|
||||
}
|
||||
|
||||
/* Animations */
|
||||
@keyframes slideIn {
|
||||
from {
|
||||
transform: translateX(350px);
|
||||
transform: translateY(-20px);
|
||||
opacity: 0;
|
||||
}
|
||||
to {
|
||||
transform: translateX(0);
|
||||
transform: translateY(0);
|
||||
opacity: 1;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes slideOut {
|
||||
from {
|
||||
transform: translateX(0);
|
||||
transform: translateY(0);
|
||||
opacity: 1;
|
||||
}
|
||||
to {
|
||||
transform: translateX(350px);
|
||||
transform: translateY(-20px);
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.toast.removing {
|
||||
animation: slideOut 0.25s ease-out;
|
||||
@keyframes progress {
|
||||
from {
|
||||
width: 100%;
|
||||
}
|
||||
to {
|
||||
width: 0%;
|
||||
}
|
||||
}
|
||||
|
||||
.toast.removing {
|
||||
animation: slideOut 0.25s ease-in forwards;
|
||||
}
|
||||
|
||||
/* Responsive */
|
||||
@media (max-width: 480px) {
|
||||
#toast-container {
|
||||
bottom: 12px;
|
||||
right: 12px;
|
||||
left: 12px;
|
||||
top: auto;
|
||||
bottom: 16px;
|
||||
right: 16px;
|
||||
left: 16px;
|
||||
}
|
||||
|
||||
.toast {
|
||||
|
||||
@@ -45,11 +45,22 @@
|
||||
border-radius: 12px;
|
||||
padding: 20px;
|
||||
box-shadow: 0 8px 24px rgba(0,0,0,0.4);
|
||||
display: none;
|
||||
overflow-y: auto;
|
||||
z-index: 9999;
|
||||
animation: slideIn 0.2s ease-out;
|
||||
/*animation: slideIn 0.2s ease-out; */
|
||||
color: var(--settings-text-color);
|
||||
|
||||
display: block;
|
||||
opacity: 0;
|
||||
pointer-events: none;
|
||||
transform: translateX(20px);
|
||||
transition: opacity 0.2s ease-out, transform 0.2s ease-out;
|
||||
}
|
||||
|
||||
.settings-panel.open {
|
||||
opacity: 1;
|
||||
pointer-events: auto;
|
||||
transform: translateX(0);
|
||||
}
|
||||
|
||||
.settings-panel::-webkit-scrollbar {
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
@import url("components/editpathbutton.css");
|
||||
@import url("components/progressBar.css");
|
||||
@import url("components/toast.css");
|
||||
@import url("components/autoUpdate.css");
|
||||
|
||||
@import url('https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap');
|
||||
|
||||
|
||||
1
scripts/CHANGELOG.md
Normal file
1
scripts/CHANGELOG.md
Normal file
@@ -0,0 +1 @@
|
||||
[//]: # (This file is used for the release CHANGELOG. Please use Markdown to describe changes.)
|
||||
@@ -4,6 +4,13 @@ set -euo pipefail
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
|
||||
VERSION=$(node -p "require('$ROOT_DIR/package.json').version")
|
||||
|
||||
if [[ "$VERSION" == *"-preview"* ]]; then
|
||||
echo "Error: The current version ($VERSION) is a 'preview"
|
||||
echo "Unable to launch release pipeline. Please update the package.json with a stable version.."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
TAG="$VERSION"
|
||||
|
||||
# Parse arguments
|
||||
@@ -17,7 +24,7 @@ for arg in "$@"; do
|
||||
--copr) PUBLISH_COPR=true ;;
|
||||
--publish) PUBLISH_SNAP=true; PUBLISH_COPR=true ;;
|
||||
--dry-run) DRY_RUN=true ;;
|
||||
*) echo "⚠️ Argument inconnu : $arg" ; exit 1 ;;
|
||||
*) echo "Unknown Argument : $arg" ; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
@@ -57,6 +64,16 @@ echo "[0/5] Cleaning workspace..."
|
||||
rm -rf "$ROOT_DIR/dist" "$ROOT_DIR/srpm-out"
|
||||
echo "Workspace cleaned (dist/ and srpm-out/ removed)"
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Step 0.3 - Retrieve Changelog
|
||||
# ------------------------------------------------------------
|
||||
if [ ! -f "$ROOT_DIR/CHANGELOG.md" ]; then
|
||||
echo "Warning: CHANGELOG.md not found, release notes will be empty."
|
||||
CHANGELOG=""
|
||||
else
|
||||
CHANGELOG="$(cat "$ROOT_DIR/CHANGELOG.md")"
|
||||
echo "Changelog retrieved successfully"
|
||||
fi
|
||||
# ------------------------------------------------------------
|
||||
# Step 1 - Build Linux packages (AppImage, deb, snap)
|
||||
# ------------------------------------------------------------
|
||||
@@ -98,19 +115,13 @@ PREV_TAG=$(git rev-list --tags --skip=1 --max-count=1 | xargs git describe --tag
|
||||
|
||||
RELEASE_NOTES="# Freedom Loader - $VERSION
|
||||
|
||||
## Changelog
|
||||
|
||||
$CHANGELOG
|
||||
|
||||
## Found a bug or issue?
|
||||
Please report it in the [GitHub Issues](https://github.com/MasterAcnolo/Freedom-Loader/issues) section.
|
||||
|
||||
## Next Release (non-exhaustive roadmap)
|
||||
- More format options
|
||||
- Subtitle support
|
||||
- Improved UI / UX
|
||||
- Language selection
|
||||
- Download specific parts of videos
|
||||
- File renaming options
|
||||
- Parallel downloads
|
||||
- Skip sponsored parts automatically
|
||||
|
||||
**Full Changelog**: https://github.com/MasterAcnolo/Freedom-Loader/compare/${PREV_TAG}...${TAG}"
|
||||
|
||||
if [ "$DRY_RUN" = false ]; then
|
||||
|
||||
@@ -2,6 +2,7 @@ const { fetchInfo } = require("../services/info.services");
|
||||
const { parseVideo, parsePlaylist } = require("../helpers/parseInfo.helpers");
|
||||
const { logger } = require("../logger");
|
||||
const { isValidUrl } = require("../helpers/validation.helpers");
|
||||
const {isUrlPlaylist} = require("../helpers/playlist.helpers");
|
||||
|
||||
/**
|
||||
* Handles metadata retrieval for a video or playlist.
|
||||
@@ -36,7 +37,7 @@ async function infoController(req, res) {
|
||||
logger.info(`Info request received. ENCODED: ${encodedUrl}`);
|
||||
|
||||
// Lightweight heuristic to detect playlist URLs. It works for Youtube.
|
||||
const isPlaylistUrl = url.includes("&list") || url.includes("?list");
|
||||
const isPlaylistUrl = isUrlPlaylist(url);
|
||||
|
||||
logger.info(
|
||||
isPlaylistUrl
|
||||
@@ -76,11 +77,11 @@ async function infoController(req, res) {
|
||||
);
|
||||
|
||||
// Preserve original error context
|
||||
throw err;
|
||||
logger.error(err);
|
||||
}
|
||||
|
||||
} else {
|
||||
throw err;
|
||||
logger.error(err);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
const path = require("path");
|
||||
|
||||
const getUserBrowser = require("./getBrowser.helpers.js");
|
||||
const {getUserBrowser} = require("./getBrowser.helpers.js");
|
||||
const { ffmpegPath, denoPath} = require("./path.helpers.js");
|
||||
const { configFeatures } = require("../../config.js");
|
||||
const { logger } = require("../logger.js");
|
||||
@@ -135,7 +135,7 @@ function buildYtDlpArgs({url, audioOnly, quality, outputFolder, isPlaylist}) {
|
||||
if (configFeatures.addMetadata) {
|
||||
args.push(
|
||||
"--postprocessor-args",
|
||||
`ffmpeg:-metadata comment="Downloaded with Freedom Loader v${config.version}"`
|
||||
`ffmpeg:-metadata comment="Downloaded with Freedom Loader ${config.version}"`
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
const fs = require("fs");
|
||||
const os = require("os");
|
||||
const path = require("path");
|
||||
const notify = require("./notify.helpers")
|
||||
const notify = require("./notify.helpers");
|
||||
const { logger } = require("../logger");
|
||||
|
||||
/**
|
||||
@@ -22,41 +21,38 @@ const { logger } = require("../logger");
|
||||
* @returns {string} The detected browser identifier.
|
||||
*/
|
||||
function getUserBrowser() {
|
||||
//const userProfile = os.homedir();
|
||||
const firefoxPath = getFirefoxProfilePath();
|
||||
const platform = process.platform;
|
||||
let isFirefoxHere = false;
|
||||
|
||||
/**
|
||||
* Browsers supported by yt-dlp cookie extraction.
|
||||
*
|
||||
* Only Firefox is currently enabled and tested.
|
||||
* Additional browsers can be enabled in the future
|
||||
* once compatibility has been verified.
|
||||
*/
|
||||
const browsers = [
|
||||
{ name: "firefox", path: firefoxPath },
|
||||
// { name: "chrome", path: path.join(userProfile, "AppData", "Local", "Google", "Chrome", "User Data", "Default") },
|
||||
// { name: "brave", path: path.join(userProfile, "AppData", "Local", "BraveSoftware", "Brave-Browser", "User Data", "Default") },
|
||||
// { name: "edge", path: path.join(userProfile, "AppData", "Local", "Microsoft", "Edge", "User Data", "Default") },
|
||||
// { name: "opera", path: path.join(userProfile, "AppData", "Roaming", "Opera Software", "Opera Stable") },
|
||||
// { name: "vivaldi", path: path.join(userProfile, "AppData", "Local", "Vivaldi", "User Data", "Default") },
|
||||
// { name: "safari", path: path.join(userProfile, "AppData", "Local", "Apple Computer", "Safari") },
|
||||
// { name: "whale", path: path.join(userProfile, "AppData", "Local", "Naver", "Naver Whale", "User Data", "Default") }
|
||||
];
|
||||
if (platform === "win32") {
|
||||
const paths = [
|
||||
"C:\\Program Files\\Mozilla Firefox\\firefox.exe",
|
||||
"C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe",
|
||||
`${process.env.LOCALAPPDATA}\\Mozilla Firefox\\firefox.exe`,
|
||||
];
|
||||
|
||||
// Search for the first available browser profile.
|
||||
for (const browser of browsers) {
|
||||
if (browser.path && fs.existsSync(browser.path)) {
|
||||
logger.info(`Browser found: ${browser.name}`);
|
||||
return browser.name;
|
||||
}
|
||||
isFirefoxHere = paths.some(p => fs.existsSync(p));
|
||||
}
|
||||
|
||||
// No supported browser found => Notify User
|
||||
logger.warn("No supported browser found on the system");
|
||||
if (platform === "linux") {
|
||||
const paths = [
|
||||
"/usr/bin/firefox",
|
||||
"/usr/bin/firefox-esr",
|
||||
"/usr/local/bin/firefox",
|
||||
"/snap/bin/firefox",
|
||||
"/var/lib/flatpak/exports/bin/org.mozilla.firefox",
|
||||
`${os.homedir()}/.local/share/flatpak/exports/bin/org.mozilla.firefox`,
|
||||
];
|
||||
isFirefoxHere = paths.some(p => fs.existsSync(p));
|
||||
}
|
||||
|
||||
// If you somehow managed to live without Firefox and need help installing it. - Don't applied to my Linux chad
|
||||
if (process.platform === "win32") {
|
||||
if (!isFirefoxHere) {
|
||||
// If you somehow managed to live without Firefox and need help installing it. - Don't applied to my Linux chad
|
||||
// No supported browser found => Notify User
|
||||
logger.warn("No supported browser found on the system");
|
||||
notify.notifyFirefoxBrowserMissing();
|
||||
} else {
|
||||
logger.info("Browser found: firefox");
|
||||
}
|
||||
|
||||
// Fallback to Firefox and let yt-dlp handle the error gracefully.
|
||||
@@ -64,39 +60,4 @@ function getUserBrowser() {
|
||||
return "firefox";
|
||||
}
|
||||
|
||||
function getFirefoxProfilePath() {
|
||||
const home = os.homedir();
|
||||
|
||||
if (process.platform === "win32") {
|
||||
return path.join(
|
||||
home,
|
||||
"AppData",
|
||||
"Roaming",
|
||||
"Mozilla",
|
||||
"Firefox",
|
||||
"Profiles"
|
||||
);
|
||||
}
|
||||
|
||||
if (process.platform === "linux") {
|
||||
return path.join(
|
||||
"usr",
|
||||
"bin",
|
||||
"firefox"
|
||||
);
|
||||
}
|
||||
|
||||
if (process.platform === "darwin") {
|
||||
return path.join(
|
||||
home,
|
||||
"Library",
|
||||
"Application Support",
|
||||
"Firefox",
|
||||
"Profiles"
|
||||
);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
module.exports = getUserBrowser
|
||||
module.exports = {getUserBrowser};
|
||||
@@ -260,7 +260,7 @@ function validateBinaries() {
|
||||
|
||||
/**
|
||||
* Helper to lazy load logger, avoid circular import
|
||||
* @returns {winston.Logger}
|
||||
* @returns {import("winston").Logger}
|
||||
*/
|
||||
function getLogger() {
|
||||
return require("../logger.js").logger;
|
||||
|
||||
12
server/helpers/playlist.helpers.js
Normal file
12
server/helpers/playlist.helpers.js
Normal file
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Determines whether a URL targets a playlist.
|
||||
*
|
||||
* The detection is based on the presence of the YouTube
|
||||
* playlist query parameter (`list`).
|
||||
*
|
||||
* @param {string} url - URL to inspect.
|
||||
* @returns {boolean} True if the URL appears to be a playlist.
|
||||
*/
|
||||
export function isUrlPlaylist(url) {
|
||||
return url.includes("?list=") || url.includes("&list=") || url.includes("@");
|
||||
}
|
||||
@@ -17,11 +17,6 @@ try {
|
||||
console.error(`Failed to create log directory: ${error.message}`);
|
||||
}
|
||||
|
||||
const logFormat = format.combine(
|
||||
format.timestamp({ format: "YYYY-MM-DD HH:mm:ss" }),
|
||||
format.printf(({ timestamp, level, message }) => `${timestamp} | ${level.toUpperCase()} | ${message}`)
|
||||
);
|
||||
|
||||
/**
|
||||
* Format used by the saved file
|
||||
* @type {Format}
|
||||
|
||||
@@ -1,11 +1,17 @@
|
||||
const express = require("express");
|
||||
const path = require("path");
|
||||
const { logger, logSessionEnd } = require("./logger");
|
||||
const config = require("../config");
|
||||
|
||||
const {logger} = require("./logger");
|
||||
const { rateLimit } = require("./helpers/rateLimit.helpers");
|
||||
|
||||
const app = express();
|
||||
|
||||
/**
|
||||
* Store the state of the server
|
||||
*/
|
||||
let serverInstance = null;
|
||||
|
||||
// Middlewares
|
||||
app.use(express.json());
|
||||
app.use(express.urlencoded({ extended: true }));
|
||||
@@ -30,33 +36,32 @@ app.get("/", rateLimit, (req, res) => {
|
||||
*/
|
||||
async function startServer() {
|
||||
return new Promise((resolve, reject) => {
|
||||
const server = app.listen(config.applicationPort, () => {
|
||||
const serverInstance = app.listen(config.applicationPort, () => {
|
||||
logger.info(`Express server ready at http://localhost:${config.applicationPort}`);
|
||||
resolve(server);
|
||||
resolve(serverInstance);
|
||||
});
|
||||
|
||||
server.on("error", (err) => {
|
||||
serverInstance.on("error", (err) => {
|
||||
logger.error("Express server error:", err);
|
||||
reject(err);
|
||||
});
|
||||
|
||||
/**
|
||||
* Clean exit function
|
||||
* - Stop Log
|
||||
* - Stop Express Server
|
||||
* - Stop Electron App
|
||||
*/
|
||||
const gracefulExit = () => {
|
||||
logSessionEnd();
|
||||
server.close(() => {
|
||||
logger.info("Express server closed cleanly.");
|
||||
process.exit();
|
||||
});
|
||||
};
|
||||
|
||||
process.on("SIGINT", gracefulExit);
|
||||
process.on("SIGTERM", gracefulExit);
|
||||
});
|
||||
}
|
||||
|
||||
module.exports = { startServer };
|
||||
/**
|
||||
* Clean exit function called by Electron
|
||||
*/
|
||||
function stopServer() {
|
||||
if (serverInstance) {
|
||||
try{
|
||||
serverInstance.close();
|
||||
logger.info("Express server closed cleanly");
|
||||
} catch (err){
|
||||
logger.error("Express server was not closed cleanly:", err)
|
||||
}
|
||||
} else {
|
||||
logger.info("Express server was already closed");
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { startServer, stopServer };
|
||||
@@ -7,6 +7,7 @@ const notify = require("../helpers/notify.helpers");
|
||||
const path = require("path");
|
||||
const { isSafePath } = require("../helpers/validation.helpers");
|
||||
const {reloadFeatures} = require("../../config");
|
||||
const {isUrlPlaylist} = require("../helpers/playlist.helpers");
|
||||
|
||||
/**
|
||||
* Reference to the currently running yt-dlp process.
|
||||
@@ -18,19 +19,6 @@ const {reloadFeatures} = require("../../config");
|
||||
*/
|
||||
let currentDownloadProcess = null;
|
||||
|
||||
/**
|
||||
* Determines whether a URL targets a playlist.
|
||||
*
|
||||
* The detection is based on the presence of the YouTube
|
||||
* playlist query parameter (`list`).
|
||||
*
|
||||
* @param {string} url - URL to inspect.
|
||||
* @returns {boolean} True if the URL appears to be a playlist.
|
||||
*/
|
||||
function isPlaylistUrl(url) {
|
||||
return url.includes("?list=") || url.includes("&list=");
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a dedicated download folder for a playlist.
|
||||
*
|
||||
@@ -49,8 +37,8 @@ function isPlaylistUrl(url) {
|
||||
*/
|
||||
function createPlaylistFolder(basePath, playlistTitle) {
|
||||
const sanitizedTitle = playlistTitle
|
||||
.replace(/[<>:"|?*]/g, '')
|
||||
.replace(/\s+/g, ' ')
|
||||
.replace(/[<>:"|?*]/g, '')
|
||||
.replace(/\s+/g, ' ')
|
||||
.trim()
|
||||
.substring(0, 200);
|
||||
|
||||
@@ -77,7 +65,7 @@ function createPlaylistFolder(basePath, playlistTitle) {
|
||||
}
|
||||
|
||||
logger.error(`Could not find available playlist folder after 1000 attempts`);
|
||||
throw new Error("Unable to create playlist folder");
|
||||
logger.error("Unable to create playlist folder");
|
||||
|
||||
} catch (err) {
|
||||
logger.warn(`Failed to create playlist folder with title "${sanitizedTitle}": ${err.message}`);
|
||||
@@ -160,7 +148,7 @@ function fetchDownload(options, progressListeners, speedListeners, stageListener
|
||||
}
|
||||
|
||||
// Détecte si c'est une playlist et crée un dossier approprié
|
||||
const isPlaylist = options.playlistTitle || isPlaylistUrl(options.url);
|
||||
const isPlaylist = options.playlistTitle || isUrlPlaylist(options.url);
|
||||
|
||||
if (isPlaylist && userConfig.createPlaylistFolders) {
|
||||
try {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
const { execFile } = require("child_process");
|
||||
const { userYtDlp, denoPath } = require("../helpers/path.helpers");
|
||||
const getUserBrowser = require("../helpers/getBrowser.helpers");
|
||||
const {getUserBrowser} = require("../helpers/getBrowser.helpers");
|
||||
const { logger } = require("../logger");
|
||||
|
||||
/**
|
||||
@@ -61,6 +61,7 @@ function fetchInfo(url) {
|
||||
|
||||
try {
|
||||
const data = JSON.parse(stdout);
|
||||
|
||||
resolve(data);
|
||||
} catch (e) {
|
||||
logger.error(`JSON Parsing Error: ${e.message}`);
|
||||
|
||||
53
test/unit/autoUpdater.test.js
Normal file
53
test/unit/autoUpdater.test.js
Normal file
@@ -0,0 +1,53 @@
|
||||
const mockDownloadUpdate = jest.fn();
|
||||
const mockCheckForUpdates = jest.fn();
|
||||
const mockOn = jest.fn();
|
||||
const mockQuitAndInstall = jest.fn();
|
||||
|
||||
jest.mock("electron-updater", () => ({
|
||||
autoUpdater: {
|
||||
autoDownload: true,
|
||||
autoInstallOnAppQuit: true,
|
||||
on: mockOn,
|
||||
checkForUpdates: mockCheckForUpdates,
|
||||
downloadUpdate: mockDownloadUpdate,
|
||||
quitAndInstall: mockQuitAndInstall,
|
||||
},
|
||||
}));
|
||||
|
||||
jest.mock("electron", () => ({
|
||||
app: {
|
||||
isPackaged: true,
|
||||
},
|
||||
}));
|
||||
|
||||
const mockLoggerError = jest.fn();
|
||||
jest.mock("../../server/logger", () => ({
|
||||
logger: {
|
||||
info: jest.fn(),
|
||||
warn: jest.fn(),
|
||||
error: mockLoggerError,
|
||||
},
|
||||
}));
|
||||
|
||||
const { downloadUpdate } = require("../../app/autoUpdater");
|
||||
|
||||
describe("autoUpdater.downloadUpdate", () => {
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
test("resolves when electron-updater download succeeds", async () => {
|
||||
mockDownloadUpdate.mockResolvedValue(undefined);
|
||||
|
||||
await expect(downloadUpdate()).resolves.toBeUndefined();
|
||||
expect(mockDownloadUpdate).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
test("rejects when electron-updater download fails", async () => {
|
||||
const error = new Error("network down");
|
||||
mockDownloadUpdate.mockRejectedValue(error);
|
||||
|
||||
await expect(downloadUpdate()).rejects.toThrow("network down");
|
||||
expect(mockLoggerError).toHaveBeenCalledWith("Download failed:", "network down");
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user