func.php

<?php
/* Pi-hole: A black hole for Internet advertisements
*  (c) 2017 Pi-hole, LLC (https://pi-hole.net)
*  Network-wide ad blocking via your own hardware.
*
*  This file is copyright under the latest version of the EUPL.
*  Please see LICENSE file for your rights under this license.
*/

// Credit: http://stackoverflow.com/a/4694816/2087442
// Modified because of https://github.com/pi-hole/AdminLTE/pull/533
ini_set('pcre.recursion_limit', 1500);
function validDomain($domain_name, &$message = null)
{
    // special handling of the root zone `.`
    if ($domain_name == '.') {
        return true;
    }

    if (!preg_match('/^((-|_)*[a-z\\d]((-|_)*[a-z\\d])*(-|_)*)(\\.(-|_)*([a-z\\d]((-|_)*[a-z\\d])*))*$/i', $domain_name)) {
        if ($message !== null) {
            $message = 'it contains invalid characters';
        }

        return false;
    }
    if (!preg_match('/^.{1,253}$/', $domain_name)) {
        if ($message !== null) {
            $message = 'its length is invalid';
        }

        return false;
    }
    if (!preg_match('/^[^\\.]{1,63}(\\.[^\\.]{1,63})*$/', $domain_name)) {
        if ($message !== null) {
            $message = 'at least one label is of invalid length';
        }

        return false;
    }

    // everything is okay
    return true;
}

function validDomainWildcard($domain_name)
{
    // Skip this checks for the root zone `.`
    if ($domain_name == '.') {
        return true;
    }
    // There has to be either no or at most one "*" at the beginning of a line
    $validChars = preg_match('/^((\\*\\.)?[_a-z\\d](-*[_a-z\\d])*)(\\.([_a-z\\d](-*[a-z\\d])*))*(\\.([_a-z\\d])*)*$/i', $domain_name);
    $lengthCheck = preg_match('/^.{1,253}$/', $domain_name);
    $labelLengthCheck = preg_match('/^[^\\.]{1,63}(\\.[^\\.]{1,63})*$/', $domain_name);

    return $validChars && $lengthCheck && $labelLengthCheck; // length of each label
}

function validIP($address)
{
    if (preg_match('/[.:0]/', $address) && !preg_match('/[1-9a-f]/', $address)) {
        // Test if address contains either `:` or `0` but not 1-9 or a-f
        return false;
    }

    return !filter_var($address, FILTER_VALIDATE_IP) === false;
}

function validCIDRIP($address)
{
    // This validation strategy has been taken from ../js/groups-common.js
    $isIPv6 = strpos($address, ':') !== false;
    if ($isIPv6) {
        // One IPv6 element is 16bit: 0000 - FFFF
        $v6elem = '[0-9A-Fa-f]{1,4}';
        // dnsmasq allows arbitrary prefix-length since https://thekelleys.org.uk/gitweb/?p=dnsmasq.git;a=commit;h=35f93081dc9a52e64ac3b7196ad1f5c1106f8932
        $v6cidr = '([1-9]|[1-9][0-9]|1[01][0-9]|12[0-8])';
        $validator = "/^(((?:{$v6elem}))((?::{$v6elem}))*::((?:{$v6elem}))((?::{$v6elem}))*|((?:{$v6elem}))((?::{$v6elem})){7})\\/{$v6cidr}$/";

        return preg_match($validator, $address);
    }
    // One IPv4 element is 8bit: 0 - 256
    $v4elem = '(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]?|0)';
    // dnsmasq allows arbitrary prefix-length
    $allowedv4cidr = '(([1-9]|[12][0-9]|3[0-2]))';
    $validator = "/^{$v4elem}\\.{$v4elem}\\.{$v4elem}\\.{$v4elem}\\/{$allowedv4cidr}$/";

    return preg_match($validator, $address);
}

function validMAC($mac_addr)
{
    // Accepted input format: 00:01:02:1A:5F:FF (characters may be lower case)
    return !filter_var($mac_addr, FILTER_VALIDATE_MAC) === false;
}

function get_ip_type($ip)
{
    return filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) ? 4 :
        (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) ? 6 :
        0);
}

function checkfile($filename)
{
    if (is_readable($filename)) {
        return $filename;
    }
    // substitute dummy file
    return '/dev/null';
}

// Avoid browser caching old versions of a file, using the last modification time
//   Receive the file URL (without "/admin/");
//   Return the string containin URL + "?v=xxx", where xxx is the last modified time of the file.
function fileversion($url)
{
    $filename = $_SERVER['DOCUMENT_ROOT'].'/admin/'.$url;
    $ver = 0;  // Default
    if (file_exists($filename)) {
        $ver = filemtime($filename);
    }

    return $url.'?v='.$ver;
}

// Credit: http://php.net/manual/en/function.hash-equals.php#119576
if (!function_exists('hash_equals')) {
    function hash_equals($known_string, $user_string)
    {
        $ret = 0;

        if (strlen($known_string) !== strlen($user_string)) {
            $user_string = $known_string;
            $ret = 1;
        }

        $res = $known_string ^ $user_string;

        for ($i = strlen($res) - 1; $i >= 0; --$i) {
            $ret |= ord($res[$i]);
        }

        return !$ret;
    }
}

/**
 * More safely execute a command with pihole shell script.
 *
 * For example,
 *
 *   pihole_execute("-h");
 *
 * would execute command
 *
 *   sudo pihole -h
 *
 * and returns output of that command as a string.
 *
 * @param $argument_string String of arguments to run pihole with
 */
function pihole_execute($argument_string)
{
    $escaped = escapeshellcmd($argument_string);
    $output = null;
    $return_status = -1;
    $command = 'sudo pihole '.$escaped;
    exec($command, $output, $return_status);
    if ($return_status !== 0) {
        trigger_error("Executing {$command} failed.", E_USER_WARNING);
    }

    return $output;
}

// Custom DNS
$customDNSFile = '/etc/pihole/custom.list';

function echoCustomDNSEntries()
{
    $entries = getCustomDNSEntries();

    $data = array();
    foreach ($entries as $entry) {
        $data[] = array($entry->domain, $entry->ip);
    }

    return array('data' => $data);
}

function getCustomDNSEntries()
{
    global $customDNSFile;

    $entries = array();

    $handle = fopen($customDNSFile, 'r');
    if ($handle) {
        while (($line = fgets($handle)) !== false) {
            $line = str_replace("\r", '', $line);
            $line = str_replace("\n", '', $line);
            $explodedLine = explode(' ', $line);

            if (count($explodedLine) != 2) {
                continue;
            }

            $data = new \stdClass();
            $data->ip = $explodedLine[0];
            $data->domain = $explodedLine[1];
            $data->domains = array_slice($explodedLine, 0, -1);
            $entries[] = $data;
        }

        fclose($handle);
    }

    return $entries;
}

function addCustomDNSEntry($ip = '', $domain = '', $reload = '', $json = true, $teleporter = false)
{
    try {
        if (isset($_REQUEST['ip'])) {
            $ip = trim($_REQUEST['ip']);
        }

        if (isset($_REQUEST['domain'])) {
            $domain = trim($_REQUEST['domain']);
        }

        if (isset($_REQUEST['reload'])) {
            $reload = $_REQUEST['reload'];
        }

        if (empty($ip)) {
            return returnError('IP must be set', $json);
        }

        $ipType = get_ip_type($ip);

        if (!$ipType) {
            return returnError('IP must be valid', $json);
        }

        if (empty($domain)) {
            return returnError('Domain must be set', $json);
        }

        $num = 0;
        // Check if each submitted domain is valid
        $domains = array_map('trim', explode(',', $domain));
        foreach ($domains as $d) {
            if (!validDomain($d)) {
                return returnError("Domain '{$d}' is not valid", $json);
            }
            ++$num;
        }

        // Only check for duplicates if adding new records from the web UI (not through Teleporter)
        if (isset($_REQUEST['ip']) || isset($_REQUEST['domain'])) {
            $existingEntries = getCustomDNSEntries();
            foreach ($existingEntries as $entry) {
                foreach ($domains as $d) {
                    if ($entry->domain == $d && get_ip_type($entry->ip) == $ipType) {
                        return returnError("The domain {$d} already has a custom DNS entry for an IPv".$ipType, $json);
                    }
                }
            }
        }

        // if $reload is not set and more then one domain is supplied, restart FTL only once after all entries were added
        if (($num > 0) && (empty($reload))) {
            $reload = 'false';
        }
        // Add records
        foreach ($domains as $domain) {
            pihole_execute('-a addcustomdns '.$ip.' '.$domain.' '.$reload);
        }
        // restart only if not called from teleporter.php as it handles restarts itself
        if (($num > 0) && (!$teleporter)) {
            pihole_execute('restartdns');
        }

        return returnSuccess('', $json);
    } catch (\Exception $ex) {
        return returnError($ex->getMessage(), $json);
    }
}

function deleteCustomDNSEntry()
{
    try {
        $ip = !empty($_REQUEST['ip']) ? $_REQUEST['ip'] : '';
        $domain = !empty($_REQUEST['domain']) ? $_REQUEST['domain'] : '';

        if (empty($ip)) {
            return returnError('IP must be set');
        }

        if (empty($domain)) {
            return returnError('Domain must be set');
        }

        $existingEntries = getCustomDNSEntries();

        $found = false;
        foreach ($existingEntries as $entry) {
            if ($entry->domain == $domain) {
                if ($entry->ip == $ip) {
                    $found = true;

                    break;
                }
            }
        }

        if (!$found) {
            return returnError('This domain/ip association does not exist');
        }

        pihole_execute('-a removecustomdns '.$ip.' '.$domain);

        return returnSuccess();
    } catch (\Exception $ex) {
        return returnError($ex->getMessage());
    }
}

function deleteAllCustomDNSEntries($reload = '')
{
    try {
        if (isset($_REQUEST['reload'])) {
            $reload = $_REQUEST['reload'];
        }

        $existingEntries = getCustomDNSEntries();
        // passing false to pihole_execute stops pihole from reloading after each entry has been deleted
        foreach ($existingEntries as $entry) {
            pihole_execute('-a removecustomdns '.$entry->ip.' '.$entry->domain.' '.$reload);
        }
    } catch (\Exception $ex) {
        return returnError($ex->getMessage());
    }

    return returnSuccess();
}

// CNAME
$customCNAMEFile = '/etc/dnsmasq.d/05-pihole-custom-cname.conf';

function echoCustomCNAMEEntries()
{
    $entries = getCustomCNAMEEntries();

    $data = array();
    foreach ($entries as $entry) {
        $data[] = array($entry->domain, $entry->target);
    }

    return array('data' => $data);
}

function getCustomCNAMEEntries()
{
    global $customCNAMEFile;

    $entries = array();

    if (!file_exists($customCNAMEFile)) {
        return $entries;
    }

    $handle = fopen($customCNAMEFile, 'r');
    if ($handle) {
        while (($line = fgets($handle)) !== false) {
            $line = str_replace('cname=', '', $line);
            $line = str_replace("\r", '', $line);
            $line = str_replace("\n", '', $line);
            $explodedLine = explode(',', $line);

            if (count($explodedLine) <= 1) {
                continue;
            }

            $data = new \stdClass();
            $data->domains = array_slice($explodedLine, 0, -1);
            $data->domain = implode(',', $data->domains);
            $data->target = $explodedLine[count($explodedLine) - 1];
            $entries[] = $data;
        }

        fclose($handle);
    }

    return $entries;
}

function addCustomCNAMEEntry($domain = '', $target = '', $reload = '', $json = true, $teleporter = false)
{
    try {
        if (isset($_REQUEST['domain'])) {
            $domain = $_REQUEST['domain'];
        }

        if (isset($_REQUEST['target'])) {
            $target = trim($_REQUEST['target']);
        }

        if (isset($_REQUEST['reload'])) {
            $reload = $_REQUEST['reload'];
        }

        if (empty($domain)) {
            return returnError('Domain must be set', $json);
        }

        if (empty($target)) {
            return returnError('Target must be set', $json);
        }

        if (!validDomain($target)) {
            return returnError('Target must be valid', $json);
        }

        $num = 0;
        $domains = array_map('trim', explode(',', $domain));
        foreach ($domains as $d) {
            // Check if each submitted domain is valid
            if (!validDomain($d)) {
                return returnError("Domain '{$d}' is not valid", $json);
            }

            // Check if each submitted domain is different than the target to avoid loops
            if (strtolower($d) === strtolower($target)) {
                return returnError('Domain and target cannot be the same', $json);
            }

            ++$num;
        }

        $existingEntries = getCustomCNAMEEntries();

        // Check if a record for one of the domains already exists
        foreach ($existingEntries as $entry) {
            foreach ($domains as $d) {
                if (in_array($d, $entry->domains)) {
                    return returnError("There is already a CNAME record for '{$d}'", $json);
                }
            }
        }

        // if $reload is not set and more then one domain is supplied, restart FTL only once after all entries were added
        if (($num > 0) && (empty($reload))) {
            $reload = 'false';
        }
        // add records
        foreach ($domains as $d) {
            pihole_execute('-a addcustomcname '.$d.' '.$target.' '.$reload);
        }

        // restart only if not called from teleporter.php as it handles restarts itself
        if (($num > 0) && (!$teleporter)) {
            pihole_execute('restartdns');
        }

        return returnSuccess('', $json);
    } catch (\Exception $ex) {
        return returnError($ex->getMessage(), $json);
    }
}

function deleteCustomCNAMEEntry()
{
    try {
        $target = !empty($_REQUEST['target']) ? $_REQUEST['target'] : '';
        $domain = !empty($_REQUEST['domain']) ? $_REQUEST['domain'] : '';

        if (empty($target)) {
            return returnError('Target must be set');
        }

        if (empty($domain)) {
            return returnError('Domain must be set');
        }

        $existingEntries = getCustomCNAMEEntries();

        $found = false;
        foreach ($existingEntries as $entry) {
            if ($entry->domain == $domain) {
                if ($entry->target == $target) {
                    $found = true;

                    break;
                }
            }
        }

        if (!$found) {
            return returnError('This domain/ip association does not exist');
        }

        pihole_execute('-a removecustomcname '.$domain.' '.$target);

        return returnSuccess();
    } catch (\Exception $ex) {
        return returnError($ex->getMessage());
    }
}

function deleteAllCustomCNAMEEntries($reload = '')
{
    try {
        if (isset($_REQUEST['reload'])) {
            $reload = $_REQUEST['reload'];
        }

        $existingEntries = getCustomCNAMEEntries();
        // passing false to pihole_execute stops pihole from reloading after each entry has been deleted
        foreach ($existingEntries as $entry) {
            pihole_execute('-a removecustomcname '.$entry->domain.' '.$entry->target.' '.$reload);
        }
    } catch (\Exception $ex) {
        return returnError($ex->getMessage());
    }

    return returnSuccess();
}

function returnSuccess($message = '', $json = true)
{
    if ($json) {
        return array('success' => true, 'message' => $message);
    }
    echo $message.'<br>';

    return true;
}

function returnError($message = '', $json = true)
{
    $message = htmlentities($message);
    if ($json) {
        return array('success' => false, 'message' => $message);
    }
    echo $message.'<br>';

    return false;
}

function getQueryTypeStr($querytype)
{
    $qtypes = array('A', 'AAAA', 'ANY', 'SRV', 'SOA', 'PTR', 'TXT', 'NAPTR', 'MX', 'DS', 'RRSIG', 'DNSKEY', 'NS', 'OTHER', 'SVCB', 'HTTPS');
    $qtype = intval($querytype);
    if ($qtype > 0 && $qtype <= count($qtypes)) {
        return $qtypes[$qtype - 1];
    }

    return 'TYPE'.($qtype - 100);
}

// Functions to return Alert messages (success, error, warning) in JSON format.
// Used in multiple pages.

// Return Success message in JSON format
function JSON_success($message = null)
{
    header('Content-type: application/json');
    echo json_encode(array('success' => true, 'message' => $message));
}

// Return Error message in JSON format
function JSON_error($message = null)
{
    header('Content-type: application/json');
    $response = array('success' => false, 'message' => $message);
    if (isset($_POST['action'])) {
        array_push($response, array('action' => $_POST['action']));
    }
    echo json_encode($response);
}

// Return Warning message in JSON format.
// - sends "success", because it wasn't a failure.
// - sends "warning" to use the correct alert type.
function JSON_warning($message = null)
{
    header('Content-type: application/json');
    echo json_encode(array(
        'success' => true,
        'warning' => true,
        'message' => $message,
    ));
}

// Returns an integer representing pihole blocking status
function piholeStatus()
{
    // Retrieve DNS Port calling FTL API directly
    $port = callFTLAPI('dns-port');

    // Retrieve FTL status
    $FTLstats = callFTLAPI('stats');

    if (array_key_exists('FTLnotrunning', $port) || array_key_exists('FTLnotrunning', $FTLstats)) {
        // FTL is not running
        $ret = -1;
    } elseif (in_array('status enabled', $FTLstats)) {
        // FTL is enabled
        if (intval($port[0]) <= 0) {
            // Port=0; FTL is not listening
            $ret = -1;
        } else {
            // FTL is running on this port
            $ret = intval($port[0]);
        }
    } elseif (in_array('status disabled', $FTLstats)) {
        // FTL is disabled
        $ret = 0;
    } else {
        // Unknown (unexpected) response
        $ret = -2;
    }

    return $ret;
}

// Returns the default gateway address and interface
function getGateway()
{
    $gateway = callFTLAPI('gateway');
    if (array_key_exists('FTLnotrunning', $gateway)) {
        $ret = array('ip' => -1);
    } else {
        $ret = array_combine(array('ip', 'iface'), array_pad(explode(' ', $gateway[0]), 2, ''));
    }

    return $ret;
}

// Returns the maxlogage used by FTL
function getMaxlogage()
{
    $api_return = callFTLAPI('maxlogage');

    if (array_key_exists('FTLnotrunning', $api_return)) {
        // FTL is offline. Return "-1"
        $maxlogage = -1;
    } else {
        // Convert seconds to hours and rounds to one decimal place.
        $maxlogage = round(intval($api_return[0]) / 3600, 1);
        // Return 24h if value is 0, empty, null or non numeric.
        $maxlogage = $maxlogage ?: 24;
    }

    return $maxlogage;
}

// Try to convert possible IDNA domain to Unicode
function convertIDNAToUnicode($IDNA)
{
    if (extension_loaded('intl')) {
        // we try the UTS #46 standard first
        // as this is the new default, see https://sourceforge.net/p/icu/mailman/message/32980778/
        // We know that this fails for some Google domains violating the standard
        // see https://github.com/pi-hole/AdminLTE/issues/1223
        if (defined('INTL_IDNA_VARIANT_UTS46')) {
            // We have to use the option IDNA_NONTRANSITIONAL_TO_ASCII here
            // to ensure sparkasse-gießen.de is not converted into
            // sparkass-giessen.de but into xn--sparkasse-gieen-2ib.de
            // as mandated by the UTS #46 standard
            $unicode = idn_to_utf8($IDNA, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
        } elseif (defined('INTL_IDNA_VARIANT_2003')) {
            // If conversion failed, try with the (deprecated!) IDNA 2003 variant
            // We have to check for its existence as support of this variant is
            // scheduled for removal with PHP 8.0
            // see https://wiki.php.net/rfc/deprecate-and-remove-intl_idna_variant_2003
            $unicode = idn_to_utf8($IDNA, IDNA_DEFAULT, INTL_IDNA_VARIANT_2003);
        }
    }

    // if the conversion failed (e.g. domain to long) return the original domain
    if ($unicode == false) {
        return $IDNA;
    } else {
        return $unicode;
    }
}

// Convert a given (unicode) domain to IDNA ASCII
function convertUnicodeToIDNA($unicode)
{
    if (extension_loaded('intl')) {
        // Be prepared that this may fail and see our comments about convertIDNAToUnicode()
        if (defined('INTL_IDNA_VARIANT_UTS46')) {
            $IDNA = idn_to_ascii($unicode, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
        } elseif (defined('INTL_IDNA_VARIANT_2003')) {
            $IDNA = idn_to_ascii($unicode, IDNA_DEFAULT, INTL_IDNA_VARIANT_2003);
        }
    }

    // if the conversion failed (e.g. domain to long) return the original domain
    if ($IDNA == false) {
        return $unicode;
    } else {
        return $IDNA;
    }
}

// Return PID of FTL (used in settings.php)
function pidofFTL()
{
    return shell_exec('pidof pihole-FTL');
}

// Get FTL process information (used in settings.php)
function get_FTL_data($FTLpid, $arg)
{
    return trim(exec('ps -p '.$FTLpid.' -o '.$arg));
}

// Convert seconds into readable time (used in settings.php)
function convertseconds($argument)
{
    $seconds = round($argument);
    if ($seconds < 60) {
        return sprintf('%ds', $seconds);
    }
    if ($seconds < 3600) {
        return sprintf('%dm %ds', $seconds / 60, $seconds % 60);
    }
    if ($seconds < 86400) {
        return sprintf('%dh %dm %ds', $seconds / 3600 % 24, $seconds / 60 % 60, $seconds % 60);
    }

    return sprintf('%dd %dh %dm %ds', $seconds / 86400, $seconds / 3600 % 24, $seconds / 60 % 60, $seconds % 60);
}

function start_php_session()
{
    // Prevent Session ID from being passed through URLs
    ini_set('session.use_only_cookies', 1);
    session_start();
    // HttpOnly: Prevents javascript XSS attacks aimed to steal the session ID
    //
    // SameSite=Strict: Allows servers to assert that a cookie ought not to be
    // sent along with cross-site requests. This assertion allows user agents to
    // mitigate the risk of cross-origin information leakage, and provides some
    // protection against cross-site request forgery attacks.
    // Direct support of Samesite has been added to PHP only in version 7.3
    // We manually set the cookie option ourselves to ensure backwards compatibility
    header('Set-Cookie: PHPSESSID='.session_id().'; path=/; HttpOnly; SameSite=Strict');
}