Merge branch 'pi-hole:master' into feature/cli-teleport-restore

.github/dependabot.yml

@@ -10,3 +10,13 @@ updates:
  target-branch: development
  reviewers:
  - "pi-hole/core-maintainers"
+- package-ecosystem: pip
+ directory: "/test"
+ schedule:
+ interval: weekly
+ day: saturday
+ time: "10:00"
+ open-pull-requests-limit: 10
+ target-branch: development
+ reviewers:
+ - "pi-hole/core-maintainers"

.github/workflows/codeql-analysis.yml

@@ -25,7 +25,7 @@ jobs:
  steps:
  -
  name: Checkout repository
- uses: actions/checkout@v3.1.0
+ uses: actions/checkout@v3.3.0
  # Initializes the CodeQL tools for scanning.
  -
  name: Initialize CodeQL

.github/workflows/merge-conflict.yml

@@ -0,0 +1,21 @@
+name: "Check for merge conflicts"
+on:
+ # So that PRs touching the same files as the push are updated
+ push:
+ # So that the `dirtyLabel` is removed if conflicts are resolve
+ # We recommend `pull_request_target` so that github secrets are available.
+ # In `pull_request` we wouldn't be able to change labels of fork PRs
+ pull_request_target:
+ types: [synchronize]
+
+jobs:
+ main:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Check if PRs are have merge conflicts
+ uses: eps1lon/[email protected]
+ with:
+ dirtyLabel: "PR: Merge Conflict"
+ repoToken: "${{ secrets.GITHUB_TOKEN }}"
+ commentOnDirty: "This pull request has conflicts, please resolve those before we can evaluate the pull request."
+ commentOnClean: "Conflicts have been resolved."

.github/workflows/stale.yml

@@ -13,7 +13,7 @@ jobs:
  issues: write
 
  steps:
- - uses: actions/stale@v6.0.1
+ - uses: actions/stale@v7.0.0
  with:
  repo-token: ${{ secrets.GITHUB_TOKEN }}
  days-before-stale: 30

.github/workflows/stale_pr.yml

@@ -0,0 +1,35 @@
+name: Close stale PR
+# This action will add a `stale` label and close immediately every PR that meets the following conditions:
+# - it is already marked with "merge conflict" label
+# - there was no update/comment on the PR in the last 30 days.
+
+on:
+ schedule:
+ - cron: '0 10 * * *'
+ workflow_dispatch:
+
+jobs:
+ stale:
+
+ runs-on: ubuntu-latest
+ permissions:
+ issues: write
+ pull-requests: write
+
+ steps:
+ - uses: actions/[email protected]
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ # Do not automatically mark PR/issue as stale
+ days-before-stale: -1
+ # Override 'days-before-stale' for PR only
+ days-before-pr-stale: 30
+ # Close PRs immediately, after marking them 'stale'
+ days-before-pr-close: 0
+ # only run the action on merge conflict PR
+ any-of-labels: 'PR: Merge Conflict'
+ exempt-pr-labels: 'internal, never-stale, ON HOLD, WIP'
+ exempt-all-pr-assignees: true
+ operations-per-run: 300
+ stale-pr-message: ''
+ close-pr-message: 'Existing merge conflicts have not been addressed. This PR is considered abandoned.'

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

@@ -11,17 +11,8 @@ jobs:
  name: Syncing branches
  steps:
  - name: Checkout
- uses: actions/checkout@v3.1.0
+ uses: actions/checkout@v3.3.0
  - name: Opening pull request
- id: pull
- uses: tretuna/[email protected]
- with:
+ run: gh pr create -B development -H master --title 'Sync master back into development' --body 'Created by Github action' --label 'internal'
+ env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- FROM_BRANCH: 'master'
- TO_BRANCH: 'development'
- - name: Label the pull request to ignore for release note generation
- uses: actions-ecosystem/[email protected]
- with:
- labels: internal
- repo: ${{ github.repository }}
- number: ${{ steps.pull.outputs.PULL_REQUEST_NUMBER }}

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Checkout repository
- uses: actions/checkout@v3.1.0
+ uses: actions/checkout@v3.3.0
 
  - name: Check scripts in repository are executable
  run: |
@@ -55,17 +55,17 @@ jobs:
  ubuntu_22,
  centos_8,
  centos_9,
- fedora_35,
  fedora_36,
+ fedora_37,
  ]
  env:
  DISTRO: ${{matrix.distro}}
  steps:
  - name: Checkout repository
- uses: actions/checkout@v3.1.0
+ uses: actions/checkout@v3.3.0
 
  - name: Set up Python 3.10
- uses: actions/setup-python@v4.3.0
+ uses: actions/setup-python@v4.5.0
  with:
  python-version: "3.10"
 

advanced/Scripts/piholeDebug.sh

@@ -66,6 +66,8 @@ RUN_DIRECTORY="/run"
 LOG_DIRECTORY="/var/log/pihole"
 WEB_SERVER_LOG_DIRECTORY="/var/log/lighttpd"
 WEB_SERVER_CONFIG_DIRECTORY="/etc/lighttpd"
+WEB_SERVER_CONFIG_DIRECTORY_FEDORA="${WEB_SERVER_CONFIG_DIRECTORY}/conf.d"
+WEB_SERVER_CONFIG_DIRECTORY_DEBIAN="${WEB_SERVER_CONFIG_DIRECTORY}/conf-enabled"
 HTML_DIRECTORY="/var/www/html"
 WEB_GIT_DIRECTORY="${HTML_DIRECTORY}/admin"
 SHM_DIRECTORY="/dev/shm"
@@ -77,6 +79,8 @@ PIHOLE_CRON_FILE="${CRON_D_DIRECTORY}/pihole"
 
 WEB_SERVER_CONFIG_FILE="${WEB_SERVER_CONFIG_DIRECTORY}/lighttpd.conf"
 WEB_SERVER_CUSTOM_CONFIG_FILE="${WEB_SERVER_CONFIG_DIRECTORY}/external.conf"
+WEB_SERVER_PIHOLE_CONFIG_FILE_DEBIAN="${WEB_SERVER_CONFIG_DIRECTORY_DEBIAN}/15-pihole-admin.conf"
+WEB_SERVER_PIHOLE_CONFIG_FILE_FEDORA="${WEB_SERVER_CONFIG_DIRECTORY_FEDORA}/pihole-admin.conf"
 
 PIHOLE_INSTALL_LOG_FILE="${PIHOLE_DIRECTORY}/install.log"
 PIHOLE_RAW_BLOCKLIST_FILES="${PIHOLE_DIRECTORY}/list.*"
@@ -140,6 +144,8 @@ PIHOLE_PROCESSES=( "lighttpd" "pihole-FTL" )
 REQUIRED_FILES=("${PIHOLE_CRON_FILE}"
 "${WEB_SERVER_CONFIG_FILE}"
 "${WEB_SERVER_CUSTOM_CONFIG_FILE}"
+"${WEB_SERVER_PIHOLE_CONFIG_FILE_DEBIAN}"
+"${WEB_SERVER_PIHOLE_CONFIG_FILE_FEDORA}"
 "${PIHOLE_INSTALL_LOG_FILE}"
 "${PIHOLE_RAW_BLOCKLIST_FILES}"
 "${PIHOLE_LOCAL_HOSTS_FILE}"
@@ -394,41 +400,53 @@ os_check() {
  # Extract dig response
  response="${cmdResult%%$'\n'*}"
 
- IFS=" " read -r -a supportedOS < <(echo "${response}" | tr -d '"')
- for distro_and_versions in "${supportedOS[@]}"
- do
- distro_part="${distro_and_versions%%=*}"
- versions_part="${distro_and_versions##*=}"
-
- if [[ "${detected_os^^}" =~ ${distro_part^^} ]]; then
- valid_os=true
- IFS="," read -r -a supportedVer <<<"${versions_part}"
- for version in "${supportedVer[@]}"
- do
- if [[ "${detected_version}" =~ $version ]]; then
- valid_version=true
- break
- fi
- done
- break
- fi
- done
-
- log_write "${INFO} dig return code: ${digReturnCode}"
- log_write "${INFO} dig response: ${response}"
+ if [ "${digReturnCode}" -ne 0 ]; then
+ log_write "${INFO} Distro: ${detected_os^}"
+ log_write "${INFO} Version: ${detected_version}"
+ log_write "${CROSS} dig return code: ${COL_RED}${digReturnCode}${COL_NC}"
+ log_write "${CROSS} dig response: ${response}"
+ log_write "${CROSS} Error: ${COL_RED}dig command failed - Unable to check OS${COL_NC}"
+ else
+ IFS=" " read -r -a supportedOS < <(echo "${response}" | tr -d '"')
+ for distro_and_versions in "${supportedOS[@]}"
+ do
+ distro_part="${distro_and_versions%%=*}"
+ versions_part="${distro_and_versions##*=}"
+
+ if [[ "${detected_os^^}" =~ ${distro_part^^} ]]; then
+ valid_os=true
+ IFS="," read -r -a supportedVer <<<"${versions_part}"
+ for version in "${supportedVer[@]}"
+ do
+ if [[ "${detected_version}" =~ $version ]]; then
+ valid_version=true
+ break
+ fi
+ done
+ break
+ fi
+ done
 
- if [ "$valid_os" = true ]; then
- log_write "${TICK} Distro: ${COL_GREEN}${detected_os^}${COL_NC}"
+ local finalmsg
+ if [ "$valid_os" = true ]; then
+ log_write "${TICK} Distro: ${COL_GREEN}${detected_os^}${COL_NC}"
 
- if [ "$valid_version" = true ]; then
- log_write "${TICK} Version: ${COL_GREEN}${detected_version}${COL_NC}"
+ if [ "$valid_version" = true ]; then
+ log_write "${TICK} Version: ${COL_GREEN}${detected_version}${COL_NC}"
+ finalmsg="${TICK} ${COL_GREEN}Distro and version supported${COL_NC}"
+ else
+ log_write "${CROSS} Version: ${COL_RED}${detected_version}${COL_NC}"
+ finalmsg="${CROSS} Error: ${COL_RED}${detected_os^} is supported but version ${detected_version} is currently unsupported ${COL_NC}(${FAQ_HARDWARE_REQUIREMENTS})${COL_NC}"
+ fi
  else
- log_write "${CROSS} Version: ${COL_RED}${detected_version}${COL_NC}"
- log_write "${CROSS} Error: ${COL_RED}${detected_os^} is supported but version ${detected_version} is currently unsupported (${FAQ_HARDWARE_REQUIREMENTS})${COL_NC}"
+ log_write "${CROSS} Distro: ${COL_RED}${detected_os^}${COL_NC}"
+ finalmsg="${CROSS} Error: ${COL_RED}${detected_os^} is not a supported distro ${COL_NC}(${FAQ_HARDWARE_REQUIREMENTS})${COL_NC}"
  fi
- else
- log_write "${CROSS} Distro: ${COL_RED}${detected_os^}${COL_NC}"
- log_write "${CROSS} Error: ${COL_RED}${detected_os^} is not a supported distro (${FAQ_HARDWARE_REQUIREMENTS})${COL_NC}"
+
+ # Print dig response and the final check result
+ log_write "${TICK} dig return code: ${COL_GREEN}${digReturnCode}${COL_NC}"
+ log_write "${INFO} dig response: ${response}"
+ log_write "${finalmsg}"
  fi
 }
 
@@ -965,6 +983,20 @@ ftl_full_status(){
  fi
 }
 
+lighttpd_test_configuration(){
+ # let lighttpd test it's own configuration
+ local lighttpd_conf_test
+ echo_current_diagnostic "Lighttpd configuration test"
+ lighttpd_conf_test=$(lighttpd -tt -f /etc/lighttpd/lighttpd.conf)
+ if [ -z "${lighttpd_conf_test}" ]; then
+ # empty output
+ log_write "${TICK} ${COL_GREEN}No error in lighttpd configuration${COL_NC}"
+ else
+ log_write "${CROSS} ${COL_RED}Error in lighttpd configuration${COL_NC}"
+ log_write " ${lighttpd_conf_test}"
+ fi
+}
+
 make_array_from_file() {
  local filename="${1}"
  # The second argument can put a limit on how many line should be read from the file
@@ -1057,17 +1089,33 @@ dir_check() {
  # check if exists first; if it does,
  if ls "${filename}" 1> /dev/null 2>&1; then
  # do nothing
- :
+ true
+ return
  else
  # Otherwise, show an error
  log_write "${COL_RED}${directory} does not exist.${COL_NC}"
+ false
+ return
  fi
  done
 }
 
 list_files_in_dir() {
  # Set the first argument passed to this function as a named variable for better readability
  local dir_to_parse="${1}"
+
+ # show files and sizes of some directories, don't print the file content (yet)
+ if [[ "${dir_to_parse}" == "${SHM_DIRECTORY}" ]]; then
+ # SHM file - we do not want to see the content, but we want to see the files and their sizes
+ log_write "$(ls -lh "${dir_to_parse}/")"
+ elif [[ "${dir_to_parse}" == "${WEB_SERVER_CONFIG_DIRECTORY_FEDORA}" ]]; then
+ # we want to see all files files in /etc/lighttpd/conf.d
+ log_write "$(ls -lh "${dir_to_parse}/" 2> /dev/null )"
+ elif [[ "${dir_to_parse}" == "${WEB_SERVER_CONFIG_DIRECTORY_DEBIAN}" ]]; then
+ # we want to see all files files in /etc/lighttpd/conf.d
+ log_write "$(ls -lh "${dir_to_parse}/"/ 2> /dev/null )"
+ fi
+
  # Store the files found in an array
  mapfile -t files_found < <(ls "${dir_to_parse}")
  # For each file in the array,
@@ -1083,11 +1131,8 @@ list_files_in_dir() {
  [[ "${dir_to_parse}/${each_file}" == "${PIHOLE_WEB_SERVER_ACCESS_LOG_FILE}" ]] || \
  [[ "${dir_to_parse}/${each_file}" == "${PIHOLE_LOG_GZIPS}" ]]; then
  :
- elif [[ "${dir_to_parse}" == "${SHM_DIRECTORY}" ]]; then
- # SHM file - we do not want to see the content, but we want to see the files and their sizes
- log_write "$(ls -lhd "${dir_to_parse}"/"${each_file}")"
  elif [[ "${dir_to_parse}" == "${DNSMASQ_D_DIRECTORY}" ]]; then
- # in case of the dnsmasq directory inlcuede all files in the debug output
+ # in case of the dnsmasq directory include all files in the debug output
  log_write "\\n${COL_GREEN}$(ls -lhd "${dir_to_parse}"/"${each_file}")${COL_NC}"
  make_array_from_file "${dir_to_parse}/${each_file}"
  else
@@ -1120,16 +1165,19 @@ show_content_of_files_in_dir() {
  # Set a local variable for better readability
  local directory="${1}"
  # Check if the directory exists
- dir_check "${directory}"
- # if it does, list the files in it
- list_files_in_dir "${directory}"
+ if dir_check "${directory}"; then
+ # if it does, list the files in it
+ list_files_in_dir "${directory}"
+ fi
 }
 
 show_content_of_pihole_files() {
  # Show the content of the files in each of Pi-hole's folders
  show_content_of_files_in_dir "${PIHOLE_DIRECTORY}"
  show_content_of_files_in_dir "${DNSMASQ_D_DIRECTORY}"
  show_content_of_files_in_dir "${WEB_SERVER_CONFIG_DIRECTORY}"
+ show_content_of_files_in_dir "${WEB_SERVER_CONFIG_DIRECTORY_FEDORA}"
+ show_content_of_files_in_dir "${WEB_SERVER_CONFIG_DIRECTORY_DEBIAN}"
  show_content_of_files_in_dir "${CRON_D_DIRECTORY}"
  show_content_of_files_in_dir "${WEB_SERVER_LOG_DIRECTORY}"
  show_content_of_files_in_dir "${LOG_DIRECTORY}"
@@ -1484,6 +1532,7 @@ check_name_resolution
 check_dhcp_servers
 process_status
 ftl_full_status
+lighttpd_test_configuration
 parse_setup_vars
 check_x_headers
 analyze_ftl_db

advanced/Scripts/query.sh

@@ -77,7 +77,7 @@ fi
 
 # Strip valid options, leaving only the domain and invalid options
 # This allows users to place the options before or after the domain
-options=$(sed -E 's/ ?-(adlists?|all|exact) ?//g' <<< "${options}")
+options=$(sed -E 's/ ?-(all|exact) ?//g' <<< "${options}")
 
 # Handle remaining options
 # If $options contain non ASCII characters, convert to punycode