flexisip-account-manager/xmlrpc/src/misc/utilities.php

<?php

/*
    Flexisip Account Manager is a set of tools to manage SIP accounts.
    Copyright (C) 2020 Belledonne Communications SARL, All rights reserved.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

include_once __DIR__ . '/../config/config.php';
include_once __DIR__ . '/../objects/account.php';
include_once __DIR__ . '/logging.php';

if (EMAIL_ENABLED) {
    include_once __DIR__ . '/email.php';
}
if (SMS_API_ENABLED) {
    include_once __DIR__ . '/sms.php';
}

define('CLEAR', 'clrtxt');
define('MD5', 'MD5');
define('SHA256', 'SHA-256');

function startswith($hay, $needle)
{
    return substr($hay, 0, strlen($needle)) === $needle;
}

function endswith($hay, $needle)
{
    return $needle === "" || (($temp = strlen($hay) - strlen($needle)) >= 0 and strpos($hay, $needle, $temp) !== false);
}

function getIp()
{
    $ip = $_SERVER['REMOTE_ADDR'];
    if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
        $ip = $_SERVER['HTTP_CLIENT_IP'];
    } elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
        $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
    }
    return $ip;
}

function get_trial_expiration_date()
{
    $expiration_date = new DateTime('now +' . TRIAL_DURATION_DAYS . ' days');
    $expiration = $expiration_date->getTimestamp() * 1000;
    return $expiration;
}

function is_activated($activated)
{
    return $activated == "1";
}

// XMLRPC parameters

function check_parameter($param, $param_name = "username")
{
    if ($param == null || $param == "") {
        Logger::getInstance()->warning("Parameter " . $param_name . " is missing");
        return false;
    }
    return true;
}

function get_algo($algo)
{
    if ($algo == null || $algo == "") {
        Logger::getInstance()->warning("Algo parameter wasn't found, assume " . DEFAULT_ALGORITHM);
        return DEFAULT_ALGORITHM;
    }
    if ($algo == MD5 || $algo == SHA256 || $algo == CLEAR) {
        return $algo;
    }
    Logger::getInstance()->error("Algo " . $algo . " is not supported");
    return null;
}

function get_domain($param)
{
    if ($param == null || $param == "") {
        Logger::getInstance()->warning("Domain parameter wasn't found, assume " . SIP_DOMAIN);
        $param = SIP_DOMAIN;
    }
    return $param;
}

function get_lang($param)
{
    if ($param == null || $param == "") {
        Logger::getInstance()->warning("lang parameter wasn't found, use US");
        return 'US';
    } elseif (strlen($param) > 2) {
        $param = substr($param, 0, 2);
    }
    return strtoupper($param);
}

// Password

function hash_password($user, $password, $domain, $algo)
{
    $hashed_password = $password;
    if ($algo == "" || $algo == MD5) {
        $hashed_password = hash("md5", $user . ":" . $domain . ":" . $password);
    } elseif ($algo == SHA256) {
        $hashed_password = hash("sha256", $user . ":" . $domain . ":" . $password);
    } else {
        Logger::getInstance()->error("Algorithm not supported: " . $algo);
    }
    return $hashed_password;
}

function generate_username()
{
    $generated_username = substr(str_shuffle(GENERATED_USERNAME_CHARACTERS), 0, GENERATED_USERNAME_LENGTH);
    return $generated_username;
}

function generate_password()
{
    $generated_password = substr(str_shuffle(GENERATED_PASSWORD_CHARACTERS), 0, GENERATED_PASSWORD_LENGTH);
    return $generated_password;
}

function generate_4_digits_code()
{
    $generated_password = substr(str_shuffle("0123456789"), 0, 4);
    return $generated_password;
}

function password_match($pwd1, $pwd2)
{
    if ($pwd1 != $pwd2) {
        Logger::getInstance()->error("Password doesn't match");
        return false;
    }
    return true;
}

function is_key_matching($key, $account)
{
    $key_db = $account->confirmation_key;
    if ($key == INVALID_CONFIRMATION_KEY || $key != $key_db) {
        if ($key_db != INVALID_CONFIRMATION_KEY) {
            $account->confirmation_key = INVALID_CONFIRMATION_KEY;
            $account->update();
        }

        Logger::getInstance()->error("Key doesn't match");
        return false;
    }

    if (REMOVE_CONFIRMATION_KEY_AFTER_USE) {
        // Key is one time only
        $account->confirmation_key = INVALID_CONFIRMATION_KEY;
        $account->update();
    }
    return true;
}

// Time

function time_elapsed_as_string($secs)
{
    $bit = array(
        'y' => $secs / 31556926 % 12,
        'w' => $secs / 604800 % 52,
        'd' => $secs / 86400 % 7,
        'h' => $secs / 3600 % 24,
        'm' => $secs / 60 % 60,
        's' => $secs % 60
    );

    foreach ($bit as $k => $v) {
        if ($v > 0) {
            $ret[] = $v . $k;
        }
    }

    return join(' ', $ret);
}
// /!\ ALWAYS enter the const config value under quotes, otherwize it won't be taken into account
function get_config_value($param_name, $default_value) {
        return defined($param_name) ? constant($param_name) : $default_value;
}