sync: master to devel

.codespellignore

@@ -0,0 +1,2 @@
+ede
+EDE

.editorconfig

@@ -0,0 +1,28 @@
+# EditorConfig is awesome: https://editorconfig.org/
+
+# top-most EditorConfig file
+root = true
+
+# A newline ending every file
+[*]
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+
+[*.css]
+indent_style = space
+indent_size = 2
+
+[scripts/**.js]
+indent_style = space
+indent_size = 2
+
+[package.json]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2

.github/dco.yml

@@ -0,0 +1,2 @@
+require:
+  members: false

.github/dependabot.yml

@@ -21,3 +21,15 @@ updates:
     versions:
     - 10.2.3
     - 10.2.4
+  reviewers:
+    - "pi-hole/web-maintainers"
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+    day: saturday
+    time: "10:00"
+  open-pull-requests-limit: 10
+  target-branch: devel
+  reviewers:
+    - "pi-hole/web-maintainers"

.github/release.yml

@@ -0,0 +1,7 @@
+changelog:
+  exclude:
+    labels:
+      - internal
+    authors:
+      - dependabot
+      - github-actions

.github/workflows/codespell.yml

@@ -0,0 +1,20 @@
+name: Codespell
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  spell-check:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout repository
+        uses: actions/checkout@v3
+      -
+        name: Spell-Checking
+        uses: codespell-project/actions-codespell@master
+        with:
+          ignore_words_file: .codespellignore
+          skip: ./scripts/vendor,./style/vendor

.github/workflows/editorconfig-checker

@@ -0,0 +1,14 @@
+name: editorconfig-checker
+
+on:
+    pull_request:
+    push:
+
+jobs:
+    build:
+      name: editorconfig-checker
+      runs-on: ubuntu-20.04
+      steps:
+        - uses: actions/checkout@v3
+        - uses: editorconfig-checker/action-editorconfig-checker@main
+        - run: editorconfig-checker

.github/workflows/phpstan.yml

@@ -9,6 +9,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Change PHP version
+      run: |
+        sudo update-alternatives --set php /usr/bin/php8.0
+        sudo update-alternatives --set phar /usr/bin/phar8.0
+        sudo update-alternatives --set phpdbg /usr/bin/phpdbg8.0
+        sudo update-alternatives --set php-cgi /usr/bin/php-cgi8.0
+        sudo update-alternatives --set phar.phar /usr/bin/phar.phar8.0
+        php -version
     - name: Validate composer.json and composer.lock
       run: composer validate
     - name: Cache Composer packages

.github/workflows/stale.yml

@@ -0,0 +1,26 @@
+name: Mark stale issues
+
+on:
+  schedule:
+    - cron: '0 8 * * *'
+  workflow_dispatch:
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+
+    steps:
+    - uses: actions/stale@v5
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-stale: 30
+        days-before-close: 5
+        stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Please comment or update this issue or it will be closed in 5 days.'
+        stale-issue-label: 'stale'
+        exempt-issue-labels: 'internal, Fixed In Next Release, Bug'
+        exempt-all-issue-assignees: true
+        operations-per-run: 300
+        close-issue-reason: 'not_planned'

.github/workflows/sync-back-to-dev.yml

@@ -0,0 +1,27 @@
+name: Sync Back to Development
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  sync-branches:
+    runs-on: ubuntu-latest
+    name: Syncing branches
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Opening pull request
+        id: pull
+        uses: tretuna/sync-branches@1.4.0
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FROM_BRANCH: 'master'
+          TO_BRANCH: 'devel'
+      - name: Label the pull request to ignore for release note generation
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          labels: internal
+          repo: ${{ github.repository }}
+          number: ${{ steps.pull.outputs.PULL_REQUEST_NUMBER }}

.github/workflows/test.yml

@@ -10,24 +10,25 @@ on:
       - "**"
 
 env:
-  CI: true
+  FORCE_COLOR: 2
 
 jobs:
   run:
-    name: Node ${{ matrix.node }}
+    name: Node
     runs-on: ubuntu-latest
 
     steps:
       - name: Clone repository
         uses: actions/checkout@v2
 
-      - name: Set Node.js version
-        uses: actions/setup-node@v1
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
         with:
-          node-version: "12.x"
+          node-version: "16.x"
+          cache: npm
 
       - name: Install npm dependencies
         run: npm ci
 
       - name: Run tests
-        run: npm test
+        run: npm run testpr

.stickler.yml

@@ -0,0 +1,9 @@
+---
+linters:
+  yamllint:
+    config: ./.yamllint.conf
+  remarklint:
+files:
+  ignore:
+    - 'scripts/vendor/*'
+    - 'style/vendor/*'

.yamllint.conf

@@ -0,0 +1,3 @@
+rules:
+  line-length: disable
+  document-start: disable

README.md

@@ -30,8 +30,8 @@ The Web interface is enabled by default when you install Pi-hole.
 
 There are several ways to [access the dashboard](https://discourse.pi-hole.net/t/how-do-i-access-pi-holes-dashboard-admin-interface/3168):
 
-1. `http://<IP_ADDPRESS_OF_YOUR_PI_HOLE>/admin/`
-2. `http:/pi.hole/admin/` (when using Pi-hole as your DNS server)
+1. `http://<IP_ADDRESS_OF_YOUR_PI_HOLE>/admin/`
+2. `http://pi.hole/admin/` (when using Pi-hole as your DNS server)
 3. `http://pi.hole/` (when using Pi-hole as your DNS server)
 
 Once logged in (forgot your password?), you can view your network stats to see things like:
@@ -46,7 +46,7 @@ Once logged in (forgot your password?), you can view your network stats to see t
 
 ## Pi-hole is free, but powered by your support
 
-There are many reoccurring costs involved with maintaining free, open source, and privacy respecting software; expenses which [our volunteer developers](https://github.com/orgs/pi-hole/people) pitch in to cover out-of-pocket. This is just one example of how strongly we feel about our software, as well as the importance of keeping it maintained.
+There are many reoccurring costs involved with maintaining free, open source, and privacy-respecting software; expenses which [our volunteer developers](https://github.com/orgs/pi-hole/people) pitch in to cover out-of-pocket. This is just one example of how strongly we feel about our software, as well as the importance of keeping it maintained.
 
 Make no mistake: **your support is absolutely vital to help keep us innovating!**
 
@@ -73,7 +73,7 @@ If you'd rather not [donate](https://pi-hole.net/donate/) (_which is okay!_), th
 
 We welcome _everyone_ to contribute to issue reports, suggest new features, and create pull requests.
 
-If you have something to add - anything from a typo through to a whole new feature, we're happy to check it out! Just make sure to fill out our template when submitting your request; the questions that it asks will help the volunteers quickly understand what you're aiming to achieve.
+If you have something to add - anything from a typo through to a whole new feature - we're happy to check it out! Just make sure to fill out our template when submitting your request; the questions that it asks will help the volunteers quickly understand what you're aiming to achieve.
 
 ### Presentations about Pi-hole
 

api.php

@@ -13,33 +13,10 @@
 require_once("scripts/pi-hole/php/auth.php");
 check_cors();
 
-$FTL_IP = "127.0.0.1";
-
 $data = array();
 
 // Common API functions
-if (isset($_GET['status']))
-{
-	$pistatus = pihole_execute('status web');
-	if(isset($pistatus[0]))
-    {
-        $pistatus = $pistatus[0];
-    }
-    else
-    {
-        $pistatus = null;
-    }
-	if ($pistatus === "1")
-	{
-		$data = array_merge($data, array("status" => "enabled"));
-	}
-	else
-	{
-		$data = array_merge($data, array("status" => "disabled"));
-	}
-}
-elseif (isset($_GET['enable']) && $auth)
-{
+if (isset($_GET['enable']) && $auth) {
 	if(isset($_GET["auth"]))
 	{
 	if($_GET["auth"] !== $pwhash)
@@ -160,17 +137,70 @@
 
 	return;
 }
+elseif(isset($_GET['customdns']) && $auth)
+{
+	if (isset($_GET["auth"])) {
+		if ($_GET["auth"] !== $pwhash) {
+			die("Not authorized!");
+		}
+	} else {
+		// Skip token validation if explicit auth string is given
+		check_csrf($_GET['token']);
+	}
+
+	switch ($_GET["action"]) {
+		case 'get':
+			$data = echoCustomDNSEntries();
+			break;
+
+		case 'add':
+			$data = addCustomDNSEntry();
+			break;
+
+		case 'delete':
+			$data = deleteCustomDNSEntry();
+			break;
+
+		default:
+			die("Wrong action");
+	}
+}
+elseif(isset($_GET['customcname']) && $auth)
+{
+	if (isset($_GET["auth"])) {
+		if ($_GET["auth"] !== $pwhash) {
+			die("Not authorized!");
+		}
+	} else {
+		// Skip token validation if explicit auth string is given
+		check_csrf($_GET['token']);
+	}
+
+	switch ($_GET["action"]) {
+		case 'get':
+			$data = echoCustomCNAMEEntries();
+			break;
+
+		case 'add':
+			$data = addCustomCNAMEEntry();
+			break;
+
+		case 'delete':
+			$data = deleteCustomCNAMEEntry();
+			break;
+
+		default:
+			die("Wrong action");
+	}
+}
 
 // Other API functions
 require("api_FTL.php");
 
 header('Content-type: application/json');
-if(isset($_GET["jsonForceObject"]))
-{
-	echo json_encode($data, JSON_FORCE_OBJECT);
-}
-else
-{
-	echo json_encode($data);
+if(isset($_GET["jsonForceObject"])) {
+    echo json_encode($data, JSON_FORCE_OBJECT);
+} else {
+    echo json_encode($data);
 }
 ?>