diff --git a/.github/ISSUE_TEMPLATE/ask_for_help.yml b/.github/ISSUE_TEMPLATE/ask_for_help.yml index 2156c5be0..312c09445 100644 --- a/.github/ISSUE_TEMPLATE/ask_for_help.yml +++ b/.github/ISSUE_TEMPLATE/ask_for_help.yml @@ -10,14 +10,13 @@ body: value: | 🚫 **We kindly ask you to refrain from pinging maintainers unless absolutely necessary. Pings are reserved for critical/urgent issues that require immediate attention.** - **Why**: Reserving pings for urgent matters ensures maintainers can prioritize critical tasks effectively - - type: checkboxes id: no-duplicate-question attributes: label: ⚠️ Please verify that your question has not already been reported description: | - To avoid duplicate reports, please search for any existing issues before submitting a new one. You can find the list of existing issues **[HERE](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc%20)**. + To avoid duplicate reports, please search for any existing issues before submitting a new one. + You can find the list of existing issues **[HERE](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc%20)**. options: - label: | I have searched the [existing issues](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc%20) and found no similar reports. @@ -28,7 +27,8 @@ body: attributes: label: 🛡️ Security Policy description: | - Please review and acknowledge the Security Policy before reporting any security-related issues or bugs. You can find the full Security Policy **[HERE](https://github.com/louislam/uptime-kuma/security/policy)**. + Please review and acknowledge the Security Policy before reporting any security-related issues or bugs. + You can find the full Security Policy **[HERE](https://github.com/louislam/uptime-kuma/security/policy)**. options: - label: | I have read and agree to Uptime Kuma's [Security Policy](https://github.com/louislam/uptime-kuma/security/policy). @@ -41,7 +41,8 @@ body: attributes: label: 📝 Describe your problem description: | - Please walk us through it step by step. Include all important details and add screenshots where appropriate + Please walk us through it step by step. + Include all important details and add screenshots where appropriate. placeholder: | Describe what are you asking for ... @@ -50,7 +51,8 @@ body: attributes: label: 📝 Error Message(s) or Log description: | - Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + Please copy and paste any relevant log output. + This will be automatically formatted into code, so no need for backticks. render: bash session validations: required: false @@ -60,7 +62,8 @@ body: attributes: label: 🐻 Uptime-Kuma Version description: | - What version of Uptime-Kuma are you running? Please do not provide Docker tags like `latest` or `1`. + What version of Uptime-Kuma are you running? + Please do not provide Docker tags like `latest` or `1`. placeholder: | e.g., 1.23.16 or 2.0.0-beta.2 validations: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d0330c70a..1d0bb1429 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,8 +10,6 @@ body: value: | 🚫 **We kindly ask you to refrain from pinging maintainers unless absolutely necessary. Pings are reserved for critical/urgent issues that require immediate attention.** - **Why**: Reserving pings for urgent matters ensures maintainers can prioritize critical tasks effectively - - type: textarea id: related-issues validations: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 61d647a4f..72f5bb3f6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -25,29 +25,6 @@ body: placeholder: | Example: This relates to issue #1, which also affects the ... system. It should not be merged because ... - - type: dropdown - id: feature-area - attributes: - label: 🏷️ Feature Request Type - description: | - What kind of feature request is this? - multiple: true - options: - - API / automation options - - New notification-provider - - Change to existing notification-provider - - New monitor - - Change to existing monitor - - Dashboard - - Status-page - - Maintenance - - Deployment - - Certificate expiry - - Settings - - Other - validations: - required: true - - type: textarea id: feature-description validations: diff --git a/.github/ISSUE_TEMPLATE/security_issue.yml b/.github/ISSUE_TEMPLATE/security_issue.yml index fa86d9ddb..4beb090bc 100644 --- a/.github/ISSUE_TEMPLATE/security_issue.yml +++ b/.github/ISSUE_TEMPLATE/security_issue.yml @@ -11,9 +11,12 @@ body: value: | ## ❗ IMPORTANT: DO NOT SHARE VULNERABILITY DETAILS HERE - ## Do not report any upstream dependency issues / scan results by any tools. - - It will be closed immediately without explanation, unless you have a PoC to prove that the upstream issue affects Uptime Kuma. + ## Please do not open issues for upstream dependency scan results. + + Automated security tools often report false-positive issues that are not exploitable in the context of Uptime Kuma. + Reviewing these without concrete impact does not scale for us. + + If you can demonstrate that an upstream issue is actually exploitable in Uptime Kuma (e.g. with a PoC or reproducible steps), we’re happy to take a look. ### ⚠️ Report a Security Vulnerability @@ -30,13 +33,15 @@ body: ## **Step 1: Submit a GitHub Security Advisory** - Right-click the link below and select `Open link in new tab` to access the page. This will keep the security issue open, allowing you to easily return and paste the Advisory URL here later. + Right-click the link below and select `Open link in new tab` to access the page. + This will keep the security issue open, allowing you to easily return and paste the Advisory URL here later. ➡️ [Create a New Security Advisory](https://github.com/louislam/uptime-kuma/security/advisories/new) ## **Step 2: Share the Advisory URL** - Once you've created your advisory, please share the URL below. This will notify Louis Lam and enable them to take the appropriate action. + Once you've created your advisory, please share the URL below. + This will notify Louis Lam and enable them to take the appropriate action. - type: textarea id: github-advisory-url diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 407d97b18..416296f6a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -_ℹ️ To keep reviews fast and effective, please make sure you’ve [read our pull request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma)_ +ℹ️ To keep reviews fast and effective, please make sure you’ve [read our pull request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma) ## 📝 Summary of changes done and why they are done @@ -17,13 +17,13 @@ _ℹ️ To keep reviews fast and effective, please make sure you’ve [read our Please follow this checklist to avoid unnecessary back and forth (click to expand) - [ ] ⚠️ If there are Breaking change (a fix or feature that alters existing functionality in a way that could cause issues) I have called them out +- [ ] 🧠 I have disclosed any use of LLMs/AI in this contribution and reviewed all generated content. + I understand that I am responsible for and able to explain every line of code I submit. - [ ] 🔍 My code adheres to the style guidelines of this project. -- [ ] 🦿 I have indicated where (if any) I used an LLM for the contributions -- [ ] ✅ I ran ESLint and other code linters for modified files. - [ ] ⚠️ My changes generate no new warnings. - [ ] 🛠️ I have reviewed and tested my code. - [ ] 📝 I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods). -- [ ] 🤖 My code needed automated testing. I have added them (this is an optional task). +- [ ] 🤖 I added or updated automated tests where appropriate. - [ ] 📄 Documentation updates are included (if applicable). - [ ] 🔒 I have considered potential security impacts and mitigated risks. - [ ] 🧰 Dependency updates are listed and explained. @@ -48,12 +48,3 @@ Please upload the image directly here by pasting it or dragging and dropping. | `DOWN` | ![Before](image-link) | ![After](image-link) | | Certificate-expiry | ![Before](image-link) | ![After](image-link) | | Testing | ![Before](image-link) | ![After](image-link) | - - diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml new file mode 100644 index 000000000..e8217e3a4 --- /dev/null +++ b/.github/workflows/autofix.yml @@ -0,0 +1,41 @@ +name: autofix.ci + +on: + push: + branches: [ "master", "1.23.X"] + pull_request: +permissions: {} + +jobs: + autofix: + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + with: { persist-credentials: false } + + - name: Cache/Restore node_modules + uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1 + id: node-modules-cache + with: + path: node_modules + key: node-modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }} + + - name: Setup Node.js + uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 + with: + node-version: 20 + + - name: Install dependencies + run: npm ci + + - name: Auto-fix JavaScript/Vue linting issues + run: npm run lint-fix:js + continue-on-error: true + + - name: Auto-fix CSS/SCSS linting issues + run: npm run lint-fix:style + continue-on-error: true + + - uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27 \ No newline at end of file diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index aa0b3c860..c71e83302 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -41,3 +41,15 @@ jobs: uses: github/codeql-action/analyze@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9 with: category: "/language:${{matrix.language}}" + zizmor: + runs-on: ubuntu-latest + permissions: + security-events: write + contents: read + actions: read + steps: + - name: Checkout repository + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + with: { persist-credentials: false } + - name: Run zizmor + uses: zizmorcore/zizmor-action@e639db99335bc9038abc0e066dfcd72e23d26fb4 # v0.3.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4cae2ad0..d212a5af0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,9 +6,11 @@ Because of this, I also never thought that other people would actually read and edit my code. Parts of the code are not very well-structured or commented, sorry about that. -The project was created with `vite.js` and is written in `vue3`. Our backend -lives in the `server`-directory and mostly communicates via websockets. Both -frontend and backend share the same `package.json`. +Before you start, please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand our community standards. + +The project was created with `vite` and is written in `vue3`. Our backend +lives in the `server`-directory and mostly communicates via websockets. +Both frontend and backend share the same `package.json`. For production, the frontend is built into the `dist`-directory and the server (`express.js`) exposes the `dist` directory as the root of the endpoint. For @@ -77,23 +79,17 @@ to review the appropriate one for your contribution. -
Translations / Internationalisation (i18n) (click to expand)

- We use weblate to localise this project into many languages. If you are - unhappy with a translation this is the best start. On how to translate using - weblate, please see - [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md). - - There are two cases in which a change cannot be done in weblate and requires a - PR: - - - A text may not be currently localisable. In this case, **adding a new - language key** via `$t("languageKey")` might be necessary - - language keys need to be **added to `en.json`** to be visible in weblate. If - this has not happened, a PR is appreciated. - - **Adding a new language** requires a new file see - [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md) - - Because maintainer time is precious, junior maintainers may merge - uncontroversial PRs in this area. + Please add **all** strings that are translatable to `src/lang/en.json`. If translation keys are omitted, they cannot be translated. **Do not include any other languages in your initial pull request** (even if it is your mother tongue) to avoid merge conflicts between Weblate and `master`. Once your PR is merged into `master`, the strings can be translated by awesome people donating their language skills. + + We use Weblate to localise this project into many languages. If you want to help translate Uptime Kuma into your language, please see [these instructions on how to translate using Weblate](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md). + + There are some cases where a change cannot be done directly in Weblate and requires a PR: + + - A text may not yet be localisable. In this case, **adding a new language key** via `{{ $t("Translation key") }}` or [``](https://vue-i18n.intlify.dev/guide/advanced/component.html) might be necessary. + - Language keys need to be **added to `en.json`** to appear in Weblate. If this has not been done, a PR is appreciated. + - **Adding a new language** requires creating a new file. See [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md). + + Because maintainer time is precious, junior maintainers may merge uncontroversial PRs in this area.

@@ -154,6 +150,7 @@ to review the appropriate one for your contribution. - `UP`/`DOWN` - Certificate Expiry via + - Domain Expiry via and a larger time set - Testing (the test button on the notification provider setup page)
@@ -162,10 +159,11 @@ to review the appropriate one for your contribution. ```md | Event | Before | After | - | ------------------ | --------------------- | -------------------- | + |--------------------|-----------------------|----------------------| | `UP` | ![Before](image-link) | ![After](image-link) | | `DOWN` | ![Before](image-link) | ![After](image-link) | | Certificate-expiry | ![Before](image-link) | ![After](image-link) | + | Domain-expiry | ![Before](image-link) | ![After](image-link) | | Testing | ![Before](image-link) | ![After](image-link) | ``` @@ -180,13 +178,11 @@ to review the appropriate one for your contribution. To set up a new notification provider these files need to be modified/created: - - `server/monitor-types/MONITORING_TYPE.js` is the core of each monitor. the - `async check(...)`-function should: - - - throw an error for each fault that is detected with an actionable error - - message - in the happy-path, you should set `heartbeat.msg` to a successful - message and set `heartbeat.status = UP` + - `server/monitor-types/MONITORING_TYPE.js` is the core of each monitor. + The `async check(...)`-function should: + - in the happy-path: set `heartbeat.msg` to a successful message and set `heartbeat.status = UP` + - in the unhappy-path: throw an `Error` for each fault that is detected with an actionable error message. + - NEVER set `heartbeat.status = DOWN` unless you want to explicitly ignore retries. - `server/uptime-kuma-server.js` is where the monitoring backend needs to be registered. _If you have an idea how we can skip this step, we would love to @@ -197,7 +193,7 @@ to review the appropriate one for your contribution. credentials - included all the necessary helptexts/placeholder/.. to make sure the notification provider is simple to setup for new users. - include all translations (`{{ $t("Translation key") }}`, - [`i18n-t keypath="Translation key">`](https://vue-i18n.intlify.dev/guide/advanced/component.html)) + [``](https://vue-i18n.intlify.dev/guide/advanced/component.html)) in `src/lang/en.json` to enable our translators to translate this Because maintainer time is precious, junior maintainers may merge @@ -210,8 +206,9 @@ to review the appropriate one for your contribution.

be sure to **create an empty draft pull request or open an issue, so we can - have a discussion first**. This is especially important for a large pull - request or when you don't know if it will be merged or not. + have a discussion first**. + This is especially important for large pull requests or when you don't know if it will be merged or not. + When adding new features, please also add tests to ensure your changes work as expected and to prevent future regressions. Because of the large impact of this work, only senior maintainers may merge PRs in this area. @@ -219,101 +216,35 @@ to review the appropriate one for your contribution.

--
Pull Request Guidelines (click to expand) +-
As a First-Time Contributor (click to expand)

- ## Steps to Submit a Pull Request + Contributing is easy and fun. We will guide you through the process: - 1. **Fork** the [Uptime-Kuma repository]. - - [Uptime-Kuma repository]: https://github.com/louislam/uptime-kuma/ - - 2. **Clone** your forked repository to your local machine. - 3. **Create a new branch** for your changes (e.g., - `feature/add-new-notification-provider-signal`). - 4. **Initiate a discussion before making major changes** by creating an empty - commit: - - ```sh - git commit -m "" --allow-empty - ``` - - 5. **Push** your branch to your forked repository. - 6. **Open a pull request** using this link: [Compare & Pull Request]. - - [Compare & Pull Request]: https://github.com/louislam/uptime-kuma/compare/ - - 7. **Select the correct source and target branches**. - 8. **Link to related issues** for context. - 9. **Provide a clear and concise description** explaining the changes and - their purpose. - - - **Type of changes** - - - Bugfix (a non-breaking change that resolves an issue) - - New feature (a non-breaking change that adds new functionality) - - Breaking change (a fix or feature that alters existing functionality in a - way that could cause issues) - - User Interface (UI) updates - - New Documentation (addition of new documentation) - - Documentation Update (modification of existing documentation) - - Documentation Update Required (the change requires updates to related - documentation) - - Other (please specify): - - Provide additional details here. - - - **Checklist** - - - My code adheres to the style guidelines of this project. - - I ran ESLint and other code linters for modified files. - - I have reviewed and tested my code. - - I have commented my code, especially in hard-to-understand areas (e.g., - using JSDoc for methods). - - My changes generate no new warnings. - - My code needed automated testing. I have added them (this is an optional - task). - - Documentation updates are included (if applicable). - - I have considered potential security impacts and mitigated risks. - - Dependency updates are listed and explained. - - I have read and understood the - [Pull Request guidelines](#recommended-pull-request-guideline). - - 10. **When publishing your PR, set it as a** `Draft pull request` **to allow - for review and prevent automatic merging.** - 11. **Maintainers will assign relevant labels** (e.g., `A:maintenance`, - `A:notifications`). - 12. **Complete the PR checklist**, ensuring that: - - - Documentation is updated if necessary. - - Tests are written or updated. - - CI/CD checks pass successfully. - - 13. **Request feedback** from team members to refine your changes before the - final review. + 1. **Fork** the [Uptime-Kuma repository](https://github.com/louislam/uptime-kuma/) and **clone** it to your local machine. + 2. **Create a new branch** for your changes (e.g., `signal-notification-provider`). + 3. **Make your changes** and **commit** them with a clear message. + 4. **Push** your changes to your forked repository. + 5. **Open a pull request** to the `master` branch of the Uptime Kuma repository. + - For large changes, please open a **draft pull request** first to discuss the changes with the maintainers. + 6. **Provide a clear and concise description** of the changes you've made and link any related issues. + 7. **Complete the PR checklist** and make sure all CI checks pass. + 8. **Request a review** when your pull request is ready. ## When Can You Change the PR Status to "Ready for Review"? - A PR should remain in **draft status** until all tasks are completed. Only - change the status to **Ready for Review** when: + A PR should remain in **draft status** until all tasks are completed. + Only change the status to **Ready for Review** when: - You have implemented all planned changes. - - You have addressed all feedback. - - Your code is fully tested and ready for integration. + - Your code is fully tested and ready for review. - You have updated or created the necessary tests. - You have verified that CI/CD checks pass successfully. -
+ A volunteer maintainer will review your PR as soon as possible. + You can help us by reviewing other PRs or taking a look at open issues. - A **work-in-progress (WIP) PR** must stay in **draft status** until everything - is finalized. - - Since maintainer time is valuable, junior maintainers may merge - uncontroversial PRs. - -

-
- -## The following rules are essential for making your PR mergable +## The following rules are essential for making your PR mergeable - Merging multiple issues by a huge PR is more difficult to review and causes conflicts with other PRs. Please @@ -335,18 +266,20 @@ to review the appropriate one for your contribution. - Don't modify or delete existing logic without a valid reason. - Don't convert existing code into other programming languages for no reason. -I ([@louislam](https://github.com/louislam)) have the final say. If your pull -request does not meet my expectations, I will reject it, no matter how much time -you spent on it. Therefore, it is essential to have a discussion beforehand. +### Continuous Integration -I will assign your pull request to a [milestone], if I plan to review and merge -it. +All pull requests must pass our continuous integration checks. These checks include: +- **Linting**: We use ESLint and Stylelint to enforce code style. You can run the linter locally with `npm run lint`. +- **Testing**: We use Playwright for end-to-end tests and have a suite of backend tests. You can run the tests locally with `npm test`. -[milestone]: https://github.com/louislam/uptime-kuma/milestones +I ([@louislam](https://github.com/louislam)) have the final say. +If your pull request does not meet my expectations, I will reject it, no matter how much time +you spent on it. -Please don't rush or ask for an ETA. We have to understand the pull request, -make sure it has no breaking changes and stick to the vision of this project, -especially for large pull requests. +We will assign your pull request to a [milestone](https://github.com/louislam/uptime-kuma/milestones), if we plan to review and merge it. + +Please don't rush or ask for an ETA. +We have to understand the pull request, make sure it has no breaking changes and stick to the vision of this project, especially for large pull requests. ## I'd Like to Work on an Issue. How Do I Do That? @@ -354,92 +287,9 @@ We have found that assigning people to issues is unnecessary management overhead. Instead, a short comment stating that you want to work on an issue is appreciated, as it saves time for other developers. If you encounter any problems during development, feel free to leave a comment describing what you -are stuck on. +are stuck on. We are here to help. -### Recommended Pull Request Guideline - -Before jumping into coding, it's recommended to initiate a discussion by -creating an empty pull request. This approach allows us to align on the -direction and scope of the feature, ensuring it doesn't conflict with existing -or planned work. It also provides an opportunity to identify potential pitfalls -early on, helping to avoid issues down the line. - -1. **Fork** the [Uptime-Kuma repository]. -2. **Clone** your forked repository to your local machine. -3. **Create a new branch** for your changes (e.g., - `feature/add-new-notification-provider-signal`). -4. **Initiate a discussion before making major changes** by creating an empty - commit: - - ```sh - git commit -m "" --allow-empty - ``` - -5. **Push** your branch to your forked repository. -6. **Open a pull request** using this link: [Compare & Pull Request]. -7. **Select the correct source and target branches**. -8. **Link to related issues** for context. -9. **Provide a clear and concise description** explaining the changes and their - purpose. - - - **Type of changes** - - - Bugfix (a non-breaking change that resolves an issue) - - New feature (a non-breaking change that adds new functionality) - - Breaking change (a fix or feature that alters existing functionality in a - way that could cause issues) - - User Interface (UI) updates - - New Documentation (addition of new documentation) - - Documentation Update (modification of existing documentation) - - Documentation Update Required (the change requires updates to related - documentation) - - Other (please specify): - - Provide additional details here. - - - **Checklist** - - - My code adheres to the style guidelines of this project. - - I ran ESLint and other code linters for modified files. - - I have reviewed and tested my code. - - I have commented my code, especially in hard-to-understand areas (e.g., - using JSDoc for methods). - - My changes generate no new warnings. - - My code needed automated testing. I have added them (this is an optional - task). - - Documentation updates are included (if applicable). - - I have considered potential security impacts and mitigated risks. - - Dependency updates are listed and explained. - - I have read and understood the - [Pull Request guidelines](#recommended-pull-request-guideline). - -10. **When publishing your PR, set it as a** `Draft pull request` **to allow for - review and prevent automatic merging.** -11. **Maintainers will assign relevant labels** (e.g., `A:maintenance`, - `A:notifications`). -12. **Complete the PR checklist**, ensuring that: - - - Documentation is updated if necessary. - - Tests are written or updated. - - CI/CD checks pass successfully. - -13. **Request feedback** from team members to refine your changes before the - final review. - -### When Can You Change the PR Status to "Ready for Review"? - -A PR should remain in **draft status** until all tasks are completed. Only -change the status to **Ready for Review** when: - -- You have implemented all planned changes. -- You have addressed all feedback. -- Your code is fully tested and ready for integration. -- You have updated or created the necessary tests. -- You have verified that CI/CD checks pass successfully. - -A **work-in-progress (WIP) PR** must stay in **draft status** until everything -is finalized. - -## Project Styles +## Project Style I personally do not like something that requires a lot of configuration before you can finally start the app. The goal is to make the Uptime Kuma installation @@ -476,7 +326,7 @@ as easy as installing a mobile app. ## Tools -- [`Node.js`](https://nodejs.org/) >= 18 +- [`Node.js`](https://nodejs.org/) >= 20.4.0 - [`npm`](https://www.npmjs.com/) >= 9.3 - [`git`](https://git-scm.com/) - IDE that supports [`ESLint`](https://eslint.org/) and EditorConfig (I am using @@ -501,8 +351,6 @@ npm ci ## Dev Server -(2022-04-26 Update) - We can start the frontend dev server and the backend dev server in one command. Port `3000` and port `3001` will be used. @@ -549,16 +397,10 @@ in the `socket.io` handlers. `express.js` is also used to serve: It binds to `0.0.0.0:3000` by default. The frontend dev server is used for development only. -For production, it is not used. It will be compiled to `dist` directory instead. +For production, it is not used. It will be compiled to `dist` directory instead via `npm run build`. You can use Vue.js devtools Chrome extension for debugging. -### Build the frontend - -```bash -npm run build -``` - ### Frontend Details Uptime Kuma Frontend is a single page application (SPA). Most paths are handled @@ -566,8 +408,7 @@ by Vue Router. The router is in `src/router.js` -As you can see, most data in the frontend is stored at the root level, even -though you changed the current router to any other pages. +Most data in the frontend is stored at the root level, even though the router can navigate to different pages. The data and socket logic are in `src/mixins/socket.js`. @@ -577,6 +418,8 @@ See: ## Unit Test +To run unit tests, use the following command: + ```bash npm run build npm test @@ -584,8 +427,8 @@ npm test ## Dependencies -Both frontend and backend share the same `package.json`. However, the frontend -dependencies are eventually not used in the production environment, because it +Both frontend and backend share the same `package.json`. +However, the frontend dependencies are eventually not used in the production environment, because it is usually also baked into `dist` files. So: - Frontend dependencies = "devDependencies" @@ -605,26 +448,10 @@ Patch release = the third digit ([Semantic Versioning](https://semver.org/)) If for security / bug / other reasons, a library must be updated, breaking changes need to be checked by the person proposing the change. -## Translations - -Please add **all** the strings which are translatable to `src/lang/en.json` (if -translation keys are omitted, they can not be translated.) - -**Don't include any other languages in your initial pull request** (even if this -is your mother tongue), to avoid merge-conflicts between weblate and `master`. -The translations can then (after merging a PR into `master`) be translated by -awesome people donating their language skills. - -If you want to help by translating Uptime Kuma into your language, please visit -the [instructions on how to translate using weblate]. - -[instructions on how to translate using weblate]: - https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md - ## Spelling & Grammar -Feel free to correct the grammar in the documentation or code. My mother -language is not English and my grammar is not that great. +Feel free to correct the spelling and grammar in the documentation or code. +English is not the native language of the maintainers. ## Wiki @@ -633,47 +460,8 @@ repo to do that. -## Docker - -### Arch - -- amd64 -- arm64 -- armv7 - -### Docker Tags - -#### v2 - -- `2`, `latest-2`: v2 with full features such as Chromium and bundled MariaDB -- `2.x.x` -- `2-slim`: v2 with basic features -- `2.x.x-slim` -- `beta2`: Latest beta build -- `2.x.x-beta.x` -- `nightly2`: Dev build -- `base2`: Basic Debian setup without Uptime Kuma source code (Full features) -- `base2-slim`: Basic Debian setup without Uptime Kuma source code -- `pr-test2`: For testing pull request without setting up a local environment - -#### v1 - -- `1`, `latest`, `1-debian`, `debian`: Latest version of v1 -- `1.x.x`, `1.x.x-debian` -- `1.x.x-beta.x`: Beta build -- `beta`: Latest beta build -- `nightly`: Dev build -- `base-debian`: Basic Debian setup without Uptime Kuma source code -- `pr-test`: For testing pull request without setting up a local environment -- `base-alpine`: (Deprecated) Basic Alpine setup without Uptime Kuma source code -- `1-alpine`, `alpine`: (Deprecated) -- `1.x.x-alpine`: (Deprecated) - ## Maintainer -Check the latest issues and pull requests: - - ### What is a maintainer and what are their roles? This project has multiple maintainers who specialise in different areas. diff --git a/db/knex_migrations/2025-02-17-2142-generalize-analytics.js b/db/knex_migrations/2025-02-17-2142-generalize-analytics.js new file mode 100644 index 000000000..8c5fda990 --- /dev/null +++ b/db/knex_migrations/2025-02-17-2142-generalize-analytics.js @@ -0,0 +1,23 @@ +// Udpate status_page table to generalize analytics fields +exports.up = function (knex) { + return knex.schema + .alterTable("status_page", function (table) { + table.renameColumn("google_analytics_tag_id", "analytics_id"); + table.string("analytics_script_url"); + table.enu("analytics_type", [ "google", "umami", "plausible", "matomo" ]).defaultTo(null); + + }).then(() => { + // After a succesful migration, add google as default for previous pages + knex("status_page").whereNotNull("analytics_id").update({ + "analytics_type": "google", + }); + }); +}; + +exports.down = function (knex) { + return knex.schema.alterTable("status_page", function (table) { + table.renameColumn("analytics_id", "google_analytics_tag_id"); + table.dropColumn("analytics_script_url"); + table.dropColumn("analytics_type"); + }); +}; diff --git a/db/knex_migrations/2026-01-02-0713-gamedig-v4-to-v5.js b/db/knex_migrations/2026-01-02-0713-gamedig-v4-to-v5.js new file mode 100644 index 000000000..63931a705 --- /dev/null +++ b/db/knex_migrations/2026-01-02-0713-gamedig-v4-to-v5.js @@ -0,0 +1,198 @@ +// Migration to update monitor.game from GameDig v4 to v5 game IDs +// Reference: https://github.com/gamedig/node-gamedig/blob/master/MIGRATE_IDS.md + +// Lookup table mapping v4 game IDs to v5 game IDs +const gameDig4to5IdMap = { + "americasarmypg": "aapg", + "7d2d": "sdtd", + "as": "actionsource", + "ageofchivalry": "aoc", + "arkse": "ase", + "arcasimracing": "asr08", + "arma": "aaa", + "arma2oa": "a2oa", + "armacwa": "acwa", + "armar": "armaresistance", + "armare": "armareforger", + "armagetron": "armagetronadvanced", + "bat1944": "battalion1944", + "bf1942": "battlefield1942", + "bfv": "battlefieldvietnam", + "bf2": "battlefield2", + "bf2142": "battlefield2142", + "bfbc2": "bbc2", + "bf3": "battlefield3", + "bf4": "battlefield4", + "bfh": "battlefieldhardline", + "bd": "basedefense", + "bs": "bladesymphony", + "buildandshoot": "bas", + "cod4": "cod4mw", + "callofjuarez": "coj", + "chivalry": "cmw", + "commandos3": "c3db", + "cacrenegade": "cacr", + "contactjack": "contractjack", + "cs15": "counterstrike15", + "cs16": "counterstrike16", + "cs2": "counterstrike2", + "crossracing": "crce", + "darkesthour": "dhe4445", + "daysofwar": "dow", + "deadlydozenpt": "ddpt", + "dh2005": "deerhunter2005", + "dinodday": "ddd", + "dirttrackracing2": "dtr2", + "dmc": "deathmatchclassic", + "dnl": "dal", + "drakan": "dootf", + "dys": "dystopia", + "em": "empiresmod", + "empyrion": "egs", + "f12002": "formulaone2002", + "flashpointresistance": "ofr", + "fivem": "gta5f", + "forrest": "theforrest", + "graw": "tcgraw", + "graw2": "tcgraw2", + "giantscitizenkabuto": "gck", + "ges": "goldeneyesource", + "gore": "gus", + "hldm": "hld", + "hldms": "hlds", + "hlopfor": "hlof", + "hl2dm": "hl2d", + "hidden": "thehidden", + "had2": "hiddendangerous2", + "igi2": "i2cs", + "il2": "il2sturmovik", + "insurgencymic": "imic", + "isle": "theisle", + "jamesbondnightfire": "jb007n", + "jc2mp": "jc2m", + "jc3mp": "jc3m", + "kingpin": "kloc", + "kisspc": "kpctnc", + "kspdmp": "kspd", + "kzmod": "kreedzclimbing", + "left4dead": "l4d", + "left4dead2": "l4d2", + "m2mp": "m2m", + "mohsh": "mohaas", + "mohbt": "mohaab", + "mohab": "moha", + "moh2010": "moh", + "mohwf": "mohw", + "minecraftbe": "mbe", + "mtavc": "gtavcmta", + "mtasa": "gtasamta", + "ns": "naturalselection", + "ns2": "naturalselection2", + "nwn": "neverwinternights", + "nwn2": "neverwinternights2", + "nolf": "tonolf", + "nolf2": "nolf2asihw", + "pvkii": "pvak2", + "ps": "postscriptum", + "primalcarnage": "pce", + "pc": "projectcars", + "pc2": "projectcars2", + "prbf2": "prb2", + "przomboid": "projectzomboid", + "quake1": "quake", + "quake3": "q3a", + "ragdollkungfu": "rdkf", + "r6": "rainbowsix", + "r6roguespear": "rs2rs", + "r6ravenshield": "rs3rs", + "redorchestraost": "roo4145", + "redm": "rdr2r", + "riseofnations": "ron", + "rs2": "rs2v", + "samp": "gtasam", + "saomp": "gtasao", + "savage2": "s2ats", + "ss": "serioussam", + "ss2": "serioussam2", + "ship": "theship", + "sinep": "sinepisodes", + "sonsoftheforest": "sotf", + "swbf": "swb", + "swbf2": "swb2", + "swjk": "swjkja", + "swjk2": "swjk2jo", + "takeonhelicopters": "toh", + "tf2": "teamfortress2", + "terraria": "terrariatshock", + "tribes1": "t1s", + "ut": "unrealtournament", + "ut2003": "unrealtournament2003", + "ut2004": "unrealtournament2004", + "ut3": "unrealtournament3", + "v8supercar": "v8sc", + "vcmp": "vcm", + "vs": "vampireslayer", + "wheeloftime": "wot", + "wolfenstein2009": "wolfenstein", + "wolfensteinet": "wet", + "wurm": "wurmunlimited", +}; + +/** + * Migrate game IDs from v4 to v5 + * @param {import("knex").Knex} knex - Knex instance + * @returns {Promise} + */ +exports.up = async function (knex) { + await knex.transaction(async (trx) => { + // Get all monitors that use the gamedig type + const monitors = await trx("monitor") + .select("id", "game") + .where("type", "gamedig") + .whereNotNull("game"); + + // Update each monitor with the new game ID if it needs migration + for (const monitor of monitors) { + const oldGameId = monitor.game; + const newGameId = gameDig4to5IdMap[oldGameId]; + + if (newGameId) { + await trx("monitor") + .where("id", monitor.id) + .update({ game: newGameId }); + } + } + }); +}; + +/** + * Revert game IDs from v5 back to v4 + * @param {import("knex").Knex} knex - Knex instance + * @returns {Promise} + */ +exports.down = async function (knex) { + // Create reverse mapping from the same LUT + const gameDig5to4IdMap = Object.fromEntries( + Object.entries(gameDig4to5IdMap).map(([ v4, v5 ]) => [ v5, v4 ]) + ); + + await knex.transaction(async (trx) => { + // Get all monitors that use the gamedig type + const monitors = await trx("monitor") + .select("id", "game") + .where("type", "gamedig") + .whereNotNull("game"); + + // Revert each monitor back to the old game ID if it was migrated + for (const monitor of monitors) { + const newGameId = monitor.game; + const oldGameId = gameDig5to4IdMap[newGameId]; + + if (oldGameId) { + await trx("monitor") + .where("id", monitor.id) + .update({ game: oldGameId }); + } + } + }); +}; diff --git a/package-lock.json b/package-lock.json index 5d1e8fe98..196ea902c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34,7 +34,7 @@ "express-static-gzip": "~2.1.7", "feed": "^4.2.2", "form-data": "~4.0.0", - "gamedig": "^4.2.0", + "gamedig": "^5.0.1", "html-escaper": "^3.0.3", "http-cookie-agent": "~5.0.4", "http-graceful-shutdown": "~3.1.7", @@ -4957,12 +4957,12 @@ "license": "BSD-3-Clause" }, "node_modules/@sindresorhus/is": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", - "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-5.6.0.tgz", + "integrity": "sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g==", "license": "MIT", "engines": { - "node": ">=10" + "node": ">=14.16" }, "funding": { "url": "https://github.com/sindresorhus/is?sponsor=1" @@ -5761,18 +5761,6 @@ "@popperjs/core": "^2.9.2" } }, - "node_modules/@types/cacheable-request": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/@types/cacheable-request/-/cacheable-request-6.0.3.tgz", - "integrity": "sha512-IQ3EbTzGxIigb1I3qPZc1rWJnH0BmSKv5QYTalEwweFvyBDLSAe24zP0le/hyi7ecGfZVlIVAg4BZqb8WBwKqw==", - "license": "MIT", - "dependencies": { - "@types/http-cache-semantics": "*", - "@types/keyv": "^3.1.4", - "@types/node": "*", - "@types/responselike": "^1.0.0" - } - }, "node_modules/@types/connect": { "version": "3.4.38", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", @@ -5894,15 +5882,6 @@ "integrity": "sha512-lZuNAY9xeJt7Bx4t4dx0rYCDqGPW8RXhQZK1td7d4H6E9zYbLoOtjBvfwdTKpsyxQI/2jv+armjX/RW+ZNpXOQ==", "license": "MIT" }, - "node_modules/@types/keyv": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@types/keyv/-/keyv-3.1.4.tgz", - "integrity": "sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/koa": { "version": "2.15.0", "resolved": "https://registry.npmjs.org/@types/koa/-/koa-2.15.0.tgz", @@ -5985,15 +5964,6 @@ "dev": true, "license": "MIT" }, - "node_modules/@types/responselike": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@types/responselike/-/responselike-1.0.3.tgz", - "integrity": "sha512-H/+L+UkTV33uf49PH5pCAUBVPNj2nDBXTN+qS1dOwyyg24l3CcicicCA7ca+HMvJBZcFgl5r8e+RR6elsb4Lyw==", - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/semver": { "version": "7.7.1", "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.1.tgz", @@ -7821,54 +7791,30 @@ } }, "node_modules/cacheable-lookup": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-6.1.0.tgz", - "integrity": "sha512-KJ/Dmo1lDDhmW2XDPMo+9oiy/CeqosPguPCrgcVzKyZrL6pM1gU2GmPY/xo6OQPTUaA/c0kwHuywB4E6nmT9ww==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz", + "integrity": "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==", "license": "MIT", "engines": { - "node": ">=10.6.0" + "node": ">=14.16" } }, "node_modules/cacheable-request": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-7.0.4.tgz", - "integrity": "sha512-v+p6ongsrp0yTGbJXjgxPow2+DL93DASP4kXCDKb8/bwRtt9OEF3whggkkDkGNzgcWy2XaF4a8nZglC7uElscg==", + "version": "10.2.14", + "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-10.2.14.tgz", + "integrity": "sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ==", "license": "MIT", "dependencies": { - "clone-response": "^1.0.2", - "get-stream": "^5.1.0", - "http-cache-semantics": "^4.0.0", - "keyv": "^4.0.0", - "lowercase-keys": "^2.0.0", - "normalize-url": "^6.0.1", - "responselike": "^2.0.0" + "@types/http-cache-semantics": "^4.0.2", + "get-stream": "^6.0.1", + "http-cache-semantics": "^4.1.1", + "keyv": "^4.5.3", + "mimic-response": "^4.0.0", + "normalize-url": "^8.0.0", + "responselike": "^3.0.0" }, "engines": { - "node": ">=8" - } - }, - "node_modules/cacheable-request/node_modules/get-stream": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", - "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", - "license": "MIT", - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/cacheable-request/node_modules/lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", - "license": "MIT", - "engines": { - "node": ">=8" + "node": ">=14.16" } }, "node_modules/call-bind": { @@ -8201,18 +8147,6 @@ "node": ">=12" } }, - "node_modules/clone-response": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/clone-response/-/clone-response-1.0.3.tgz", - "integrity": "sha512-ROoL94jJH2dUVML2Y/5PEDNaSHgeOdSDicUyS7izcF63G6sTc/FTjLub4b8Il9S8S0beOfYt0TaA5qvFK+w0wA==", - "license": "MIT", - "dependencies": { - "mimic-response": "^1.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/cluster-key-slot": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.2.tgz", @@ -9544,6 +9478,14 @@ "dev": true, "license": "ISC" }, + "node_modules/emitter-component": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/emitter-component/-/emitter-component-1.1.2.tgz", + "integrity": "sha512-QdXO3nXOzZB4pAjM0n6ZE+R9/+kPpECA/XSELIcc54NeYVnBqIk+4DFiBgK+8QbV3mdvTG6nedl7dTYgO+5wDw==", + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", @@ -10366,7 +10308,6 @@ } ], "license": "MIT", - "optional": true, "dependencies": { "strnum": "^2.1.0" }, @@ -10687,10 +10628,13 @@ } }, "node_modules/form-data-encoder": { - "version": "1.7.1", - "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-1.7.1.tgz", - "integrity": "sha512-EFRDrsMm/kyqbTQocNvRXMLjc7Es2Vk+IQFx/YW7hkUH1eBl4J1fqiP34l74Yt0pFLCNpc06fkbVk00008mzjg==", - "license": "MIT" + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-2.1.4.tgz", + "integrity": "sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==", + "license": "MIT", + "engines": { + "node": ">= 14.17" + } }, "node_modules/formdata-node": { "version": "6.0.3", @@ -10895,171 +10839,42 @@ } }, "node_modules/gamedig": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/gamedig/-/gamedig-4.3.2.tgz", - "integrity": "sha512-TjYwybvy8HNAhkv2EJccd5HROIiMeMriWmeX8vT8m5Ibat5JMzVpugzsD8L8XZVrOfiXnVg/9DhWYM8k/VG/vw==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/gamedig/-/gamedig-5.3.2.tgz", + "integrity": "sha512-R2b1LwjW783PZsHRl9M8R06UkvJwXmJ6PDKk48UukJQ9ktiwrCeAk90MAZx6nF3oA444uf7r5eHjfaYbNoSV+Q==", "license": "MIT", "dependencies": { - "cheerio": "1.0.0-rc.10", + "fast-xml-parser": "5.2.5", "gbxremote": "0.2.1", - "got": "12.1.0", - "iconv-lite": "0.6.3", - "long": "5.2.0", - "minimist": "1.2.6", - "punycode": "2.1.1", + "got": "13.0.0", + "iconv-lite": "0.7.0", + "long": "5.3.2", + "minimist": "1.2.8", "seek-bzip": "2.0.0", + "telnet-client": "2.2.6", "varint": "6.0.0" }, "bin": { "gamedig": "bin/gamedig.js" }, "engines": { - "node": ">=14.0.0" + "node": ">=16.20.0" } }, - "node_modules/gamedig/node_modules/cheerio": { - "version": "1.0.0-rc.10", - "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.10.tgz", - "integrity": "sha512-g0J0q/O6mW8z5zxQ3A8E8J1hUgp4SMOvEoW/x84OwyHKe/Zccz83PVT4y5Crcr530FV6NgmKI1qvGTKVl9XXVw==", + "node_modules/gamedig/node_modules/iconv-lite": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.0.tgz", + "integrity": "sha512-cf6L2Ds3h57VVmkZe+Pn+5APsT7FpqJtEhhieDCvrE2MK5Qk9MyffgQyuxQTm6BChfeZNtcOLHp9IcWRVcIcBQ==", "license": "MIT", "dependencies": { - "cheerio-select": "^1.5.0", - "dom-serializer": "^1.3.2", - "domhandler": "^4.2.0", - "htmlparser2": "^6.1.0", - "parse5": "^6.0.1", - "parse5-htmlparser2-tree-adapter": "^6.0.1", - "tslib": "^2.2.0" + "safer-buffer": ">= 2.1.2 < 3.0.0" }, "engines": { - "node": ">= 6" + "node": ">=0.10.0" }, "funding": { - "url": "https://github.com/cheeriojs/cheerio?sponsor=1" - } - }, - "node_modules/gamedig/node_modules/cheerio-select": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-1.6.0.tgz", - "integrity": "sha512-eq0GdBvxVFbqWgmCm7M3XGs1I8oLy/nExUnh6oLqmBditPO9AqQJrkslDpMun/hZ0yyTs8L0m85OHp4ho6Qm9g==", - "license": "BSD-2-Clause", - "dependencies": { - "css-select": "^4.3.0", - "css-what": "^6.0.1", - "domelementtype": "^2.2.0", - "domhandler": "^4.3.1", - "domutils": "^2.8.0" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, - "node_modules/gamedig/node_modules/css-select": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", - "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0", - "css-what": "^6.0.1", - "domhandler": "^4.3.1", - "domutils": "^2.8.0", - "nth-check": "^2.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, - "node_modules/gamedig/node_modules/dom-serializer": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", - "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", - "license": "MIT", - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^4.2.0", - "entities": "^2.0.0" - }, - "funding": { - "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" - } - }, - "node_modules/gamedig/node_modules/domhandler": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", - "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", - "license": "BSD-2-Clause", - "dependencies": { - "domelementtype": "^2.2.0" - }, - "engines": { - "node": ">= 4" - }, - "funding": { - "url": "https://github.com/fb55/domhandler?sponsor=1" - } - }, - "node_modules/gamedig/node_modules/domutils": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", - "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", - "license": "BSD-2-Clause", - "dependencies": { - "dom-serializer": "^1.0.1", - "domelementtype": "^2.2.0", - "domhandler": "^4.2.0" - }, - "funding": { - "url": "https://github.com/fb55/domutils?sponsor=1" - } - }, - "node_modules/gamedig/node_modules/entities": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", - "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", - "license": "BSD-2-Clause", - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, - "node_modules/gamedig/node_modules/htmlparser2": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", - "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", - "funding": [ - "https://github.com/fb55/htmlparser2?sponsor=1", - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "MIT", - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^4.0.0", - "domutils": "^2.5.2", - "entities": "^2.0.0" - } - }, - "node_modules/gamedig/node_modules/long": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/long/-/long-5.2.0.tgz", - "integrity": "sha512-9RTUNjK60eJbx3uz+TEGF7fUr29ZDxR5QzXcyDpeSfeH28S9ycINflOgOlppit5U+4kNTe83KQnMEerw7GmE8w==", - "license": "Apache-2.0" - }, - "node_modules/gamedig/node_modules/parse5": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/parse5/-/parse5-6.0.1.tgz", - "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", - "license": "MIT" - }, - "node_modules/gamedig/node_modules/parse5-htmlparser2-tree-adapter": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-6.0.1.tgz", - "integrity": "sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA==", - "license": "MIT", - "dependencies": { - "parse5": "^6.0.1" + "type": "opencollective", + "url": "https://opencollective.com/express" } }, "node_modules/gauge": { @@ -11416,27 +11231,25 @@ } }, "node_modules/got": { - "version": "12.1.0", - "resolved": "https://registry.npmjs.org/got/-/got-12.1.0.tgz", - "integrity": "sha512-hBv2ty9QN2RdbJJMK3hesmSkFTjVIHyIDDbssCKnSmq62edGgImJWD10Eb1k77TiV1bxloxqcFAVK8+9pkhOig==", + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/got/-/got-13.0.0.tgz", + "integrity": "sha512-XfBk1CxOOScDcMr9O1yKkNaQyy865NbYs+F7dr4H0LZMVgCj2Le59k6PqbNHoL5ToeaEQUYh6c6yMfVcc6SJxA==", "license": "MIT", "dependencies": { - "@sindresorhus/is": "^4.6.0", + "@sindresorhus/is": "^5.2.0", "@szmarczak/http-timer": "^5.0.1", - "@types/cacheable-request": "^6.0.2", - "@types/responselike": "^1.0.0", - "cacheable-lookup": "^6.0.4", - "cacheable-request": "^7.0.2", + "cacheable-lookup": "^7.0.0", + "cacheable-request": "^10.2.8", "decompress-response": "^6.0.0", - "form-data-encoder": "1.7.1", + "form-data-encoder": "^2.1.2", "get-stream": "^6.0.1", "http2-wrapper": "^2.1.10", "lowercase-keys": "^3.0.0", "p-cancelable": "^3.0.0", - "responselike": "^2.0.0" + "responselike": "^3.0.0" }, "engines": { - "node": ">=14.16" + "node": ">=16" }, "funding": { "url": "https://github.com/sindresorhus/got?sponsor=1" @@ -13624,12 +13437,15 @@ } }, "node_modules/mimic-response": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-1.0.1.tgz", - "integrity": "sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-4.0.0.tgz", + "integrity": "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==", "license": "MIT", "engines": { - "node": ">=4" + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/minimalistic-assert": { @@ -13654,10 +13470,13 @@ } }, "node_modules/minimist": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", - "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==", - "license": "MIT" + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/minimist-options": { "version": "4.1.0", @@ -14108,6 +13927,12 @@ "node": ">= 0.6" } }, + "node_modules/net": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/net/-/net-1.0.2.tgz", + "integrity": "sha512-kbhcj2SVVR4caaVnGLJKmlk2+f+oLkjqdKeQlmUtz6nGzOpbcobwVIeSURNgraV/v3tlmGIX82OcPCl0K6RbHQ==", + "license": "MIT" + }, "node_modules/net-snmp": { "version": "3.26.0", "resolved": "https://registry.npmjs.org/net-snmp/-/net-snmp-3.26.0.tgz", @@ -14389,12 +14214,12 @@ } }, "node_modules/normalize-url": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.1.0.tgz", - "integrity": "sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==", + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-8.1.1.tgz", + "integrity": "sha512-JYc0DPlpGWB40kH5g07gGTrYuMqV653k3uBKY6uITPWds3M0ov3GaWGp9lbE3Bzngx8+XkfzgvASb9vk9JDFXQ==", "license": "MIT", "engines": { - "node": ">=10" + "node": ">=14.16" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -16273,26 +16098,20 @@ } }, "node_modules/responselike": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/responselike/-/responselike-2.0.1.tgz", - "integrity": "sha512-4gl03wn3hj1HP3yzgdI7d3lCkF95F21Pz4BPGvKHinyQzALR5CapwC8yIi0Rh58DEMQ/SguC03wFj2k0M/mHhw==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/responselike/-/responselike-3.0.0.tgz", + "integrity": "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==", "license": "MIT", "dependencies": { - "lowercase-keys": "^2.0.0" + "lowercase-keys": "^3.0.0" + }, + "engines": { + "node": ">=14.16" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/responselike/node_modules/lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/retimer": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/retimer/-/retimer-3.0.0.tgz", @@ -17255,6 +17074,15 @@ "node": ">= 0.4" } }, + "node_modules/stream": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stream/-/stream-0.0.2.tgz", + "integrity": "sha512-gCq3NDI2P35B2n6t76YJuOp7d6cN/C7Rt0577l91wllh0sY9ZBuw9KaSGqH/b0hzn3CWWJbpbW0W0WvQ1H/Q7g==", + "license": "MIT", + "dependencies": { + "emitter-component": "^1.1.1" + } + }, "node_modules/stream-shift": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/stream-shift/-/stream-shift-1.0.3.tgz", @@ -17553,8 +17381,7 @@ "url": "https://github.com/sponsors/NaturalIntelligence" } ], - "license": "MIT", - "optional": true + "license": "MIT" }, "node_modules/style-search": { "version": "0.1.0", @@ -17970,6 +17797,20 @@ "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } }, + "node_modules/telnet-client": { + "version": "2.2.6", + "resolved": "https://registry.npmjs.org/telnet-client/-/telnet-client-2.2.6.tgz", + "integrity": "sha512-ZUYrLsPtQupQww3eSEORDVOb6ztdtKEghya6TVXPo2tg/UQq2pn5rHhvwuUvyYpbnsoqdNY1fyD1GNkXHR8dYA==", + "license": "MIT", + "dependencies": { + "net": "^1.0.2", + "stream": "^0.0.2" + }, + "funding": { + "type": "paypal", + "url": "https://paypal.me/kozjak" + } + }, "node_modules/temp-dir": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/temp-dir/-/temp-dir-2.0.0.tgz", @@ -19140,16 +18981,6 @@ "proxy-from-env": "^1.1.0" } }, - "node_modules/wait-on/node_modules/minimist": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", - "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/web-push": { "version": "3.6.7", "resolved": "https://registry.npmjs.org/web-push/-/web-push-3.6.7.tgz", diff --git a/package.json b/package.json index 4d4173217..0a81863f1 100644 --- a/package.json +++ b/package.json @@ -95,7 +95,7 @@ "express-static-gzip": "~2.1.7", "feed": "^4.2.2", "form-data": "~4.0.0", - "gamedig": "^4.2.0", + "gamedig": "^5.0.1", "html-escaper": "^3.0.3", "http-cookie-agent": "~5.0.4", "http-graceful-shutdown": "~3.1.7", diff --git a/server/analytics/analytics.js b/server/analytics/analytics.js new file mode 100644 index 000000000..229d463e0 --- /dev/null +++ b/server/analytics/analytics.js @@ -0,0 +1,48 @@ +const googleAnalytics = require("./google-analytics"); +const umamiAnalytics = require("./umami-analytics"); +const plausibleAnalytics = require("./plausible-analytics"); +const matomoAnalytics = require("./matomo-analytics"); + +/** + * Returns a string that represents the javascript that is required to insert the selected Analytics' script + * into a webpage. + * @param {typeof import("../model/status_page").StatusPage} statusPage Status page populate HTML with + * @returns {string} HTML script tags to inject into page + */ +function getAnalyticsScript(statusPage) { + switch (statusPage.analyticsType) { + case "google": + return googleAnalytics.getGoogleAnalyticsScript(statusPage.analyticsId); + case "umami": + return umamiAnalytics.getUmamiAnalyticsScript(statusPage.analyticsScriptUrl, statusPage.analyticsId); + case "plausible": + return plausibleAnalytics.getPlausibleAnalyticsScript(statusPage.analyticsScriptUrl, statusPage.analyticsId); + case "matomo": + return matomoAnalytics.getMatomoAnalyticsScript(statusPage.analyticsScriptUrl, statusPage.analyticsId); + default: + return null; + } +} + +/** + * Function that checks wether the selected analytics has been configured properly + * @param {typeof import("../model/status_page").StatusPage} statusPage Status page populate HTML with + * @returns {boolean} Boolean defining if the analytics config is valid + */ +function isValidAnalyticsConfig(statusPage) { + switch (statusPage.analyticsType) { + case "google": + return statusPage.analyticsId != null; + case "umami": + case "plausible": + case "matomo": + return statusPage.analyticsId != null && statusPage.analyticsScriptUrl != null; + default: + return false; + } +} + +module.exports = { + getAnalyticsScript, + isValidAnalyticsConfig +}; diff --git a/server/google-analytics.js b/server/analytics/google-analytics.js similarity index 100% rename from server/google-analytics.js rename to server/analytics/google-analytics.js diff --git a/server/analytics/matomo-analytics.js b/server/analytics/matomo-analytics.js new file mode 100644 index 000000000..fdc009e63 --- /dev/null +++ b/server/analytics/matomo-analytics.js @@ -0,0 +1,47 @@ +const jsesc = require("jsesc"); +const { escape } = require("html-escaper"); + +/** + * Returns a string that represents the javascript that is required to insert the Matomo Analytics script + * into a webpage. + * @param {string} matomoUrl Domain name with tld to use with the Matomo Analytics script. + * @param {string} siteId Site ID to use with the Matomo Analytics script. + * @returns {string} HTML script tags to inject into page + */ +function getMatomoAnalyticsScript(matomoUrl, siteId) { + let escapedMatomoUrlJS = jsesc(matomoUrl, { isScriptContext: true }); + let escapedSiteIdJS = jsesc(siteId, { isScriptContext: true }); + + if (escapedMatomoUrlJS) { + escapedMatomoUrlJS = escapedMatomoUrlJS.trim(); + } + + if (escapedSiteIdJS) { + escapedSiteIdJS = escapedSiteIdJS.trim(); + } + + // Escape the domain url for use in an HTML attribute. + let escapedMatomoUrlHTMLAttribute = escape(escapedMatomoUrlJS); + + // Escape the website id for use in an HTML attribute. + let escapedSiteIdHTMLAttribute = escape(escapedSiteIdJS); + + return ` + + `; +} + +module.exports = { + getMatomoAnalyticsScript, +}; diff --git a/server/analytics/plausible-analytics.js b/server/analytics/plausible-analytics.js new file mode 100644 index 000000000..131f1136b --- /dev/null +++ b/server/analytics/plausible-analytics.js @@ -0,0 +1,36 @@ +const jsesc = require("jsesc"); +const { escape } = require("html-escaper"); + +/** + * Returns a string that represents the javascript that is required to insert the Plausible Analytics script + * into a webpage. + * @param {string} scriptUrl the Plausible Analytics script url. + * @param {string} domainsToMonitor Domains to track seperated by a ',' to add Plausible Analytics script. + * @returns {string} HTML script tags to inject into page + */ +function getPlausibleAnalyticsScript(scriptUrl, domainsToMonitor) { + let escapedScriptUrlJS = jsesc(scriptUrl, { isScriptContext: true }); + let escapedWebsiteIdJS = jsesc(domainsToMonitor, { isScriptContext: true }); + + if (escapedScriptUrlJS) { + escapedScriptUrlJS = escapedScriptUrlJS.trim(); + } + + if (escapedWebsiteIdJS) { + escapedWebsiteIdJS = escapedWebsiteIdJS.trim(); + } + + // Escape the domain url for use in an HTML attribute. + let escapedScriptUrlHTMLAttribute = escape(escapedScriptUrlJS); + + // Escape the website id for use in an HTML attribute. + let escapedWebsiteIdHTMLAttribute = escape(escapedWebsiteIdJS); + + return ` + + `; +} + +module.exports = { + getPlausibleAnalyticsScript +}; diff --git a/server/analytics/umami-analytics.js b/server/analytics/umami-analytics.js new file mode 100644 index 000000000..48c8b2eca --- /dev/null +++ b/server/analytics/umami-analytics.js @@ -0,0 +1,36 @@ +const jsesc = require("jsesc"); +const { escape } = require("html-escaper"); + +/** + * Returns a string that represents the javascript that is required to insert the Umami Analytics script + * into a webpage. + * @param {string} scriptUrl the Umami Analytics script url. + * @param {string} websiteId Website ID to use with the Umami Analytics script. + * @returns {string} HTML script tags to inject into page + */ +function getUmamiAnalyticsScript(scriptUrl, websiteId) { + let escapedScriptUrlJS = jsesc(scriptUrl, { isScriptContext: true }); + let escapedWebsiteIdJS = jsesc(websiteId, { isScriptContext: true }); + + if (escapedScriptUrlJS) { + escapedScriptUrlJS = escapedScriptUrlJS.trim(); + } + + if (escapedWebsiteIdJS) { + escapedWebsiteIdJS = escapedWebsiteIdJS.trim(); + } + + // Escape the Script url for use in an HTML attribute. + let escapedScriptUrlHTMLAttribute = escape(escapedScriptUrlJS); + + // Escape the website id for use in an HTML attribute. + let escapedWebsiteIdHTMLAttribute = escape(escapedWebsiteIdJS); + + return ` + + `; +} + +module.exports = { + getUmamiAnalyticsScript, +}; diff --git a/server/model/status_page.js b/server/model/status_page.js index 0fef5caa8..500473587 100644 --- a/server/model/status_page.js +++ b/server/model/status_page.js @@ -3,7 +3,7 @@ const { R } = require("redbean-node"); const cheerio = require("cheerio"); const { UptimeKumaServer } = require("../uptime-kuma-server"); const jsesc = require("jsesc"); -const googleAnalytics = require("../google-analytics"); +const analytics = require("../analytics/analytics"); const { marked } = require("marked"); const { Feed } = require("feed"); const config = require("../config"); @@ -121,9 +121,9 @@ class StatusPage extends BeanModel { const head = $("head"); - if (statusPage.google_analytics_tag_id) { - let escapedGoogleAnalyticsScript = googleAnalytics.getGoogleAnalyticsScript(statusPage.google_analytics_tag_id); - head.append($(escapedGoogleAnalyticsScript)); + if (analytics.isValidAnalyticsConfig(statusPage)) { + let escapedAnalyticsScript = analytics.getAnalyticsScript(statusPage); + head.append($(escapedAnalyticsScript)); } // OG Meta Tags @@ -411,7 +411,9 @@ class StatusPage extends BeanModel { customCSS: this.custom_css, footerText: this.footer_text, showPoweredBy: !!this.show_powered_by, - googleAnalyticsId: this.google_analytics_tag_id, + analyticsId: this.analytics_id, + analyticsScriptUrl: this.analytics_script_url, + analyticsType: this.analytics_type, showCertificateExpiry: !!this.show_certificate_expiry, showOnlyLastHeartbeat: !!this.show_only_last_heartbeat }; @@ -435,7 +437,9 @@ class StatusPage extends BeanModel { customCSS: this.custom_css, footerText: this.footer_text, showPoweredBy: !!this.show_powered_by, - googleAnalyticsId: this.google_analytics_tag_id, + analyticsId: this.analytics_id, + analyticsScriptUrl: this.analytics_script_url, + analyticsType: this.analytics_type, showCertificateExpiry: !!this.show_certificate_expiry, showOnlyLastHeartbeat: !!this.show_only_last_heartbeat }; diff --git a/server/monitor-types/gamedig.js b/server/monitor-types/gamedig.js index b20c2435c..35a015f98 100644 --- a/server/monitor-types/gamedig.js +++ b/server/monitor-types/gamedig.js @@ -1,6 +1,6 @@ const { MonitorType } = require("./monitor-type"); -const { UP, DOWN } = require("../../src/util"); -const Gamedig = require("gamedig"); +const { UP } = require("../../src/util"); +const { GameDig } = require("gamedig"); const dns = require("dns").promises; const net = require("net"); @@ -11,15 +11,13 @@ class GameDigMonitorType extends MonitorType { * @inheritdoc */ async check(monitor, heartbeat, server) { - heartbeat.status = DOWN; - let host = monitor.hostname; if (net.isIP(host) === 0) { host = await this.resolveHostname(host); } try { - const state = await Gamedig.query({ + const state = await GameDig.query({ type: monitor.game, host: host, port: monitor.port, diff --git a/server/notification-providers/telegram.js b/server/notification-providers/telegram.js index a98c326d7..790f06a69 100644 --- a/server/notification-providers/telegram.js +++ b/server/notification-providers/telegram.js @@ -4,6 +4,47 @@ const axios = require("axios"); class Telegram extends NotificationProvider { name = "telegram"; + /** + * Escapes special characters for Telegram MarkdownV2 format + * @param {string} text Text to escape + * @returns {string} Escaped text + */ + escapeMarkdownV2(text) { + if (!text) { + return text; + } + + // Characters that need to be escaped in MarkdownV2 + // https://core.telegram.org/bots/api#markdownv2-style + return String(text).replace(/[_*[\]()~>#+\-=|{}.!\\]/g, "\\$&"); + } + + /** + * Recursively escapes string properties of an object for Telegram MarkdownV2 + * @param {object|string} obj Object or string to escape + * @returns {object|string} Escaped object or string + */ + escapeObjectRecursive(obj) { + if (typeof obj === "string") { + return this.escapeMarkdownV2(obj); + } + if (typeof obj === "object" && obj !== null) { + // Check if array + if (Array.isArray(obj)) { + return obj.map(item => this.escapeObjectRecursive(item)); + } + + const newObj = {}; + for (const key in obj) { + if (Object.prototype.hasOwnProperty.call(obj, key)) { + newObj[key] = this.escapeObjectRecursive(obj[key]); + } + } + return newObj; + } + return obj; + } + /** * @inheritdoc */ @@ -24,7 +65,29 @@ class Telegram extends NotificationProvider { } if (notification.telegramUseTemplate) { - params.text = await this.renderTemplate(notification.telegramTemplate, msg, monitorJSON, heartbeatJSON); + let monitorJSONCopy = monitorJSON; + let heartbeatJSONCopy = heartbeatJSON; + + if (notification.telegramTemplateParseMode === "MarkdownV2") { + msg = this.escapeMarkdownV2(msg); + + if (monitorJSONCopy) { + monitorJSONCopy = this.escapeObjectRecursive(monitorJSONCopy); + } else { + // for testing monitorJSON is null, provide escaped defaults + monitorJSONCopy = { + name: this.escapeMarkdownV2("Monitor Name not available"), + hostname: this.escapeMarkdownV2("testing.hostname"), + url: this.escapeMarkdownV2("testing.hostname"), + }; + } + + if (heartbeatJSONCopy) { + heartbeatJSONCopy = this.escapeObjectRecursive(heartbeatJSONCopy); + } + } + + params.text = await this.renderTemplate(notification.telegramTemplate, msg, monitorJSONCopy, heartbeatJSONCopy); if (notification.telegramTemplateParseMode !== "plain") { params.parse_mode = notification.telegramTemplateParseMode; diff --git a/server/socket-handlers/general-socket-handler.js b/server/socket-handlers/general-socket-handler.js index b996efe7b..ad57d7b1e 100644 --- a/server/socket-handlers/general-socket-handler.js +++ b/server/socket-handlers/general-socket-handler.js @@ -2,30 +2,35 @@ const { log } = require("../../src/util"); const { Settings } = require("../settings"); const { sendInfo } = require("../client"); const { checkLogin } = require("../util-server"); -const GameResolver = require("gamedig/lib/GameResolver"); +const { games } = require("gamedig"); const { testChrome } = require("../monitor-types/real-browser-monitor-type"); const fsAsync = require("fs").promises; const path = require("path"); -let gameResolver = new GameResolver(); -let gameList = null; - /** * Get a game list via GameDig - * @returns {object[]} list of games supported by GameDig + * @returns {object} list of games supported by GameDig */ function getGameList() { - if (gameList == null) { - gameList = gameResolver._readGames().games.sort((a, b) => { - if ( a.pretty < b.pretty ) { - return -1; - } - if ( a.pretty > b.pretty ) { - return 1; - } - return 0; - }); - } + let gameList = []; + gameList = Object.keys(games).map(key => { + const item = games[key]; + return { + keys: [ key ], + pretty: item.name, + options: item.options, + extra: item.extra || {} + }; + }); + gameList.sort((a, b) => { + if ( a.pretty < b.pretty ) { + return -1; + } + if ( a.pretty > b.pretty ) { + return 1; + } + return 0; + }); return gameList; } diff --git a/server/socket-handlers/status-page-socket-handler.js b/server/socket-handlers/status-page-socket-handler.js index 7fb93cfaf..e42b13607 100644 --- a/server/socket-handlers/status-page-socket-handler.js +++ b/server/socket-handlers/status-page-socket-handler.js @@ -167,7 +167,9 @@ module.exports.statusPageSocketHandler = (socket) => { statusPage.show_only_last_heartbeat = config.showOnlyLastHeartbeat; statusPage.show_certificate_expiry = config.showCertificateExpiry; statusPage.modified_date = R.isoDateTime(); - statusPage.google_analytics_tag_id = config.googleAnalyticsId; + statusPage.analytics_id = config.analyticsId; + statusPage.analytics_script_url = config.analyticsScriptUrl; + statusPage.analytics_type = config.analyticsType; await R.store(statusPage); diff --git a/src/components/PingChart.vue b/src/components/PingChart.vue index 3dcc74fa7..f26bf4739 100644 --- a/src/components/PingChart.vue +++ b/src/components/PingChart.vue @@ -25,12 +25,12 @@