Lib.Util.php

Go to the documentation of this file.

<?php
/*
 * @author Anakeen
 * @package FDL
*/
/**
 * Utilities functions for freedom
 *
 * @author Anakeen
 * @version $Id: Lib.Util.php,v 1.23 2009/01/07 18:05:08 eric Exp $
 * @package FDL
 * @subpackage
 */
/**
 */

function newFreeVaultFile($dbaccess)
{
    include_once ("VAULT/Class.VaultFile.php");
    return new VaultFile($dbaccess, "FREEDOM");
}
/**
 * for FDLGEN directory
 * @param $dbaccess
 * @return string
 */
function getGen($dbaccess)
{
    return "GEN";
}
/**
 * convert French date to iso8601
 * @param string $fdate DD/MM/YYYY HH:MM:SS (CET)
 * @param string $wtz with timezone add time zone in the end if true
 * @return string date YYYY-MM-DD HH:MM:SS
 * @deprecated use stringDateToIso() instead
 */
function toIso8601($fdate, $wtz = false)
{
    deprecatedFunction();
    $isoDate = "";
    $tz = "";
    if (preg_match("/^(\d\d)\/(\d\d)\/(\d\d\d\d)\s(\d\d)?:?(\d\d)?:?(\d\d)?\s+?(\w+)?$/", $fdate, $reg)) {
        $isoDate = sprintf("%04d-%02d-%02d %02d:%02d:%02d", $reg[3], $reg[2], $reg[1], $reg[4], $reg[5], $reg[6]);
        if ($reg[8] != "") $tz = $reg[7];
    }
    // ISO 8601
    if ($wtz && $tz) $isoDate.= " " . $tz;
    
    return $isoDate;
}

function StringDateToJD($sdate)
{
    $jd = FrenchDateToJD($sdate);
    if ($jd === false) $jd = Iso8601ToJD($sdate);
    return $jd;
}
/**
 * convert French date to Julian day
 * the seconds are ignored
 * @param string $fdate DD/MM/YYYY HH:MM
 * @return float julian day (return false if incorrect date)
 */
function FrenchDateToJD($fdate)
{
    if (preg_match("/^(\d\d)\/(\d\d)\/(\d\d\d\d)\s?(\d\d)?:?(\d\d)?:?(\d\d)?(\.\d)*/", $fdate, $reg)) {
        if (empty($reg[4])) {
            $reg[4] = 0;
        }
        if (empty($reg[5])) {
            $reg[5] = 0;
        }
        return cal2jd("CE", $reg[3], $reg[2], $reg[1], $reg[4], $reg[5], 0);
    }
    return false;
}
/**
 * convert French date to unix timestamp
 * date must be > 01/01/1970 and < 2038
 * @param string $fdate DD/MM/YYYY HH:MM
 * @return float number of second since epoch (return -1 if incorrect date)
 */
function FrenchDateToUnixTs($fdate, $utc = false)
{
    if (preg_match("/^(\d\d)\/(\d\d)\/(\d\d\d\d)\s?(\d\d)?:?(\d\d)?:?(\d\d)?/", $fdate, $r)) {
        $r[4] = isset($r[4]) ? $r[4] : 0;
        $r[5] = isset($r[5]) ? $r[5] : 0;
        $r[6] = isset($r[6]) ? $r[6] : 0;
        if ($utc) $dt = gmmktime($r[4], $r[5], $r[6], $r[2], $r[1], $r[3]);
        else $dt = mktime($r[4], $r[5], $r[6], $r[2], $r[1], $r[3]);
    } else {
        $dt = - 1;
    }
    return $dt;
}

function stringDateToLocaleDate($fdate, $format = '')
{
    if (preg_match('/^(\d\d\d\d)-(\d\d)-(\d\d)[\s|T]?(\d\d)?:?(\d\d)?:?(\d\d)?/', $fdate, $r)) {
        // convert to french
        $yy = $r[1];
        $mo = $r[2];
        $dd = $r[3];
        $hh = isset($r[4]) ? $r[4] : null;
        $mm = isset($r[5]) ? $r[5] : null;
        $ss = isset($r[6]) ? $r[6] : null;
        if (!$hh && !$mm && !$ss) {
            $fdate = sprintf("%s/%s/%s", $dd, $mo, $yy);
        } elseif (!$ss) {
            
            $fdate = sprintf("%s/%s/%s %s:%s", $dd, $mo, $yy, $hh, $mm);
        } else {
            
            $fdate = sprintf("%s/%s/%s %s:%s:%s", $dd, $mo, $yy, $hh, $mm, $ss);
        }
    }
    return FrenchDateToLocaleDate($fdate, $format);
}
/**
 *
 * @param string $fdate
 * @return string
 */
function FrenchDateToLocaleDate($fdate, $format = '')
{
    if (empty($fdate)) {
        return "";
    }
    if (empty($format)) {
        $localeconfig = getLocaleConfig();
        if ($localeconfig !== false) {
            if (strlen($fdate) >= 16) {
                $format = $localeconfig['dateTimeFormat'];
            } else {
                $format = $localeconfig['dateFormat'];
            }
        } else {
            return $fdate;
        }
    }
    $ldate = $format;
    $d = substr($fdate, 0, 2);
    $m = substr($fdate, 3, 2);
    $y = substr($fdate, 6, 4);
    if (!ctype_digit($d)) return $fdate;
    if (!ctype_digit($m)) return $fdate;
    if (!ctype_digit($y)) return $fdate;
    if (strlen($fdate) >= 16) {
        $h = substr($fdate, 11, 2);
        $i = substr($fdate, 14, 2);
        if (!ctype_digit($h)) return $fdate;
        if (!ctype_digit($i)) return $fdate;
        if (strlen($fdate) == 19) {
            $s = substr($fdate, 17, 2);
            if (!ctype_digit($s)) return $fdate;
        }
    }
    $ldate = str_replace('%d', $d, $ldate);
    $ldate = str_replace('%m', $m, $ldate);
    $ldate = str_replace('%Y', $y, $ldate);
    if (isset($h)) {
        $ldate = str_replace('%H', $h, $ldate);
    }
    if (isset($i)) {
        $ldate = str_replace('%M', $i, $ldate);
    }
    if (isset($s)) {
        $ldate = str_replace('%S', $s, $ldate);
    }
    return $ldate;
}
/**
 * convert French date DD/MM/YYYY to iso
 * date must be > 01/01/1970 and < 2038
 * @param string $fdate DD/MM/YYYY HH:MM
 * @param boolean $withT return YYYY-MM-DDTHH:MM:SS else YYYY-MM-DD HH:MM:SS
 * @return string  YYYY-MM-DD HH:MM:SS
 */
function FrenchDateToIso($fdate, $withT = true)
{
    if (!$fdate) return '';
    if (preg_match('/^(\d\d)\/(\d\d)\/(\d\d\d\d)\s?(\d\d)?:?(\d\d)?:?(\d\d)?/', $fdate, $r)) {
        
        if (empty($r[4])) $dt = sprintf("%04d-%02d-%02d", $r[3], $r[2], $r[1]);
        else $dt = sprintf("%04d-%02d-%02d%s%02d:%02d:%02d", $r[3], $r[2], $r[1], ($withT) ? 'T' : ' ', $r[4], $r[5], $r[6]);
    } else {
        $dt = "";
    }
    return $dt;
}
/**
 * convert iso date to unix timestamp
 * date must be > 1970-01-01 and < 2038
 * @param string $isodate YYYY-MM-DD HH:MM
 * @return float number of second since epoch (return -1 if incorrect date)
 */
function iso8601DateToUnixTs($isodate, $utc = false)
{
    if (preg_match("/^(\d\d\d\d)-(\d\d)-(\d\d)[\s|T]?(\d\d)?:?(\d\d)?:?(\d\d)?/", $isodate, $r)) {
        if (empty($r[4])) $r[4] = 0;
        if (empty($r[5])) $r[5] = 0;
        if (empty($r[6])) $r[6] = 0;
        if ($utc) $dt = gmmktime($r[4], $r[5], $r[6], $r[2], $r[3], $r[1]);
        else $dt = mktime($r[4], $r[5], $r[6], $r[2], $r[3], $r[1]);
    } else {
        $dt = - 1;
    }
    return $dt;
}
/**
 * convert date to unix timestamp
 * date must be > 1970-01-01 and < 2038
 * @param string $isodate YYYY-MM-DD HH:MM
 * @return float number of second since epoch (return -1 if incorrect date)
 */
function stringDateToUnixTs($isodate, $utc = false)
{
    $dt = FrenchDateToUnixTs($isodate, $utc);
    if ($dt < 0) $dt = iso8601DateToUnixTs($isodate, $utc);
    return $dt;
}
/**
 * verify if a date seems valid
 * @param string $date iso, french english date
 * @return bool true if it ia a valid date
 */
function isValidDate($date)
{
    if ((strlen($date) > 0) && (strlen($date) < 3)) return false;
    $date = stringDateToIso($date, "");
    if (preg_match('/^(\d\d\d\d)-(\d\d)-(\d\d)/', $date, $reg)) {
        return checkdate($reg[2], $reg[3], $reg[1]);
    }
    return false;
}
/**
 * convert string date to iso
 * @note if the $date input is not recognised like a date the function return the original $date argument
 *
 * @param string $date DD/MM/YYYY HH:MM or YYYY-MM-DD HH:MM or YYYY-MM-DDTHH:MM
 * @param bool|string optionnal input $format to indicate locale : french default is "%d/%m/%Y %H:%M". If not set use locale configuration of server
 * @param bool $withT to add a T between day and hour: YYYY-MM-DDTHH:MM
 * @return string YYYY-MM-DD HH:MM
 */
function stringDateToIso($date, $format = false, $withT = false)
{
    if ($format === false) {
        if (preg_match('/^(\d\d\d\d)-(\d\d)-(\d\d)[\s|T]?(\d\d)?:?(\d\d)?:?(\d\d)?/', $date, $r)) {
            if ($withT) {
                if (strlen($date) > 11) {
                    $date[10] = 'T';
                }
            }
            return $date;
        } else {
            $dt = FrenchDateToIso($date, $withT);
            if (!$dt) return $date;
            return $dt;
        }
    }
    if (empty($format)) {
        $localeconfig = getLocaleConfig();
        if ($localeconfig !== false) {
            $format = $localeconfig['dateTimeFormat'];
            if (strlen($date) < strlen($format)) {
                $format = $localeconfig['dateFormat'];
            }
        }
    }
    if (!empty($format)) {
        $format = str_replace('%Y', '%YYY', $format);
        if (strlen($date) < strlen($format)) {
            return $date;
        }
        // date
        $d = strpos($format, '%d');
        $m = strpos($format, '%m');
        $y = strpos($format, '%YYY');
        if ($d !== false && $m !== false && $y !== false) {
            $tmp = substr($date, $y, 4);
            if (!ctype_digit($tmp)) return $date;
            $dt = $tmp . '-';
            $tmp = substr($date, $m, 2);
            if (!ctype_digit($tmp)) return $date;
            $dt.= $tmp . '-';
            $tmp = substr($date, $d, 2);
            if (!ctype_digit($tmp)) return $date;
            $dt.= $tmp;
        } else {
            return $date;
        }
        // time
        $h = strpos($format, '%H');
        $m = strpos($format, '%M');
        $s = strpos($format, '%S');
        if ($h !== false && $m !== false) {
            $dt.= ($withT ? 'T' : ' ') . substr($date, $h, 2) . ':' . substr($date, $m, 2);
            if ($s !== false) {
                $dt.= ':' . substr($date, $s, 2);
            }
        }
        return $dt;
    } else {
        $dt = FrenchDateToIso($date, $withT);
        if (!$dt) return $date;
        return $dt;
    }
}
/**
 * convert iso8601 date to Julian day
 * the seconds are ignored
 * @param string $isodate YYYY-MM-DD HH:MM
 * @return float julian day (return false if incorrect date)
 */
function Iso8601ToJD($isodate)
{
    if (preg_match("/^(\d\d\d\d)-(\d\d)-(\d\d)\s?(\d\d)?:?(\d\d)?:?(\d\d)?/", $isodate, $reg)) {
        if (!isset($reg[4])) $reg[4] = 0;
        if (!isset($reg[5])) $reg[5] = 0;
        return cal2jd("CE", $reg[1], $reg[2], $reg[3], $reg[4], $reg[5], 0);
    }
    return false;
}

function cal2jd($era, $y, $m, $d, $h, $mn, $s)
{
    if (($y > 1969) && ($y < 2038)) {
        $nd = unixtojd(mktime($h, $mn, $s, $m, $d, $y));
        $nm = (($h * 60 + $mn) - 720) / 1440;
        $nd+= round($nm, 5);
        return $nd;
    } else {
        
        if ($y == 0) {
            AddWarningMsg("There is no year 0 in the Julian system!");
            return "invalid";
        }
        if ($y == 1582 && $m == 10 && $d > 4 && $d < 15 && $era != "BCE") {
            AddWarningMsg("The dates 5 through 14 October, 1582, do not exist in the Gregorian system!");
            return "invalid";
        }
        
        if ($era == "BCE") $y = - $y + 1;
        if ($m > 2) {
            $jy = $y;
            $jm = $m + 1;
        } else {
            $jy = $y - 1;
            $jm = $m + 13;
        }
        
        $intgr = floor(floor(365.25 * $jy) + floor(30.6001 * $jm) + $d + 1720995);
        //check for switch to Gregorian calendar
        $gregcal = 15 + 31 * (10 + 12 * 1582);
        if ($d + 31 * ($m + 12 * $y) >= $gregcal) {
            $ja = floor(0.01 * $jy);
            $intgr+= 2 - $ja + floor(0.25 * $ja);
        }
        //correct for half-day offset
        $dayfrac = $h / 24.0 - 0.5;
        if ($dayfrac < 0.0) {
            $dayfrac+= 1.0;
            $intgr--;
        }
        //now set the fraction of a day
        $frac = $dayfrac + ($mn + $s / 60.0) / 60.0 / 24.0;
        //round to nearest second
        $jd0 = ($intgr + $frac) * 100000;
        $jd = floor($jd0);
        if ($jd0 - $jd > 0.5) $jd++;
        return $jd / 100000;
    }
}
/**
 * return the day of the week (1 id Monday, 7 is Sunday)
 * @param float $jd julian date
 * @return int
 */
function jdWeekDay($jd)
{
    //weekday
    $t = doubleval($jd) + 0.5;
    $wd = floor(($t / 7 - floor($t / 7)) * 7 + 0.000000000317); //add 0.01 sec for truncation error correction
    return $wd + 1;
}
/**
 * return the number of the week in year
 * @param float $jd julian date
 * @return int between 1 and 53
 */
function jdWeekNumber($jd)
{
    $j = doubleval($jd) + 0.5;
    $d4 = ((($j + 31741 - ($j % 7)) % 146097) % 36524) % 1461;
    $l = floor($d4 / 1460);
    $d1 = (($d4 - $l) % 365) + $l;
    $wn = floor($d1 / 7) + 1;
    return ($wn);
}
/**
 * return date in string format
 * @param float $jd julian date
 * @param string $dformat the format (default iso8601)
 * @return string the formatted date
 */
function jd2cal($jd, $dformat = '')
{
    //
    // get the date from the Julian day number
    //
    $intgr = floor($jd);
    $frac = $jd - $intgr;
    $gregjd = 2299160.5;
    if ($jd >= $gregjd) { //Gregorian calendar correction
        $tmp = floor((($intgr - 1867216.0) - 0.25) / 36524.25);
        $j1 = $intgr + 1 + $tmp - floor(0.25 * $tmp);
    } else $j1 = $intgr;
    //correction for half day offset
    $df = $frac + 0.5;
    if ($df >= 1.0) {
        $df-= 1.0;
        $j1++;
    }
    
    $j2 = $j1 + 1524.0;
    $j3 = floor(6680.0 + (($j2 - 2439870.0) - 122.1) / 365.25);
    $j4 = floor($j3 * 365.25);
    $j5 = floor(($j2 - $j4) / 30.6001);
    
    $d = floor($j2 - $j4 - floor($j5 * 30.6001));
    $m = floor($j5 - 1.0);
    if ($m > 12) $m-= 12;
    $y = floor($j3 - 4715.0);
    if ($m > 2) $y--;
    if ($y <= 0) $y--;
    //
    // get time of day from day fraction
    //
    $hr = floor($df * 24.0);
    $mn = floor(($df * 24.0 - $hr) * 60.0);
    $f = (($df * 24.0 - $hr) * 60.0 - $mn) * 60.0;
    $sc = floor($f);
    $f-= $sc;
    if ($f > 0.5) $sc++;
    if ($sc == 60) {
        $sc = 0;
        $mn++;
    }
    if ($mn == 60) {
        $mn = 0;
        $hr++;
    }
    if ($hr == 24) {
        $hr = 0;
        $d++; //this could cause a bug, but probably will never happen in practice
        
    }
    
    if ($y < 0) {
        $y = - $y;
        $ce = ' BCE';
        // form.era[1].checked = true;
        
    } else {
        $ce = '';
        //   form.era[0].checked = true;
        
    }
    switch ($dformat) {
        case 'M':
            $retiso8601 = $m;
            break;

        case 'Y':
            $retiso8601 = $y;
            break;

        case 'd':
            $retiso8601 = $d;
            break;

        case 'French':
            $retiso8601 = sprintf("%02d/%02d/%04s", $d, $m, $y);
            break;

        case 'FrenchLong':
            $retiso8601 = sprintf("%02d/%02d/%04s %02d:%02d %s", $d, $m, $y, $hr, $mn, $ce);
            break;

        default:
            $retiso8601 = sprintf("%04d-%02d-%02s %02d:%02d%s", $y, $m, $d, $hr, $mn, $ce);
    }
    return $retiso8601;
}
/**
 * backslash quote and replace double-quote by html entity
 */
function addJsSlashes($s)
{
    return str_replace(array(
        "'",
        "\""
    ) , array(
        "\\'",
        "&#34;"
    ) , $s);
}
/**
 * Remove Character Accents
 * Replaces accented characters in a string with their unaccented versions, for instance, converts "ÉéÜüÄäÖ" into "EeUuAaO". The function will handle any accented character for which there exists an HTML entity in PHP's translation table (i.e. pretty much any and all characters). Credits go to jennings at trad dot uji dot es for the original version of this incredibly useful little function. I used this function to good effect in OpenSEF.
 */
function unaccent_($text)
{
    static $search, $replace;
    if (!$search) {
        $search = $replace = array();
        // Get the HTML entities table into an array
        $trans = get_html_translation_table(HTML_ENTITIES);
        // Go through the entity mappings one-by-one
        foreach ($trans as $literal => $entity) {
            // Make sure we don't process any other characters
            // such as fractions, quotes etc:
            if (ord($literal) >= 192) {
                // Get the accented form of the letter
                $search[] = $literal;
                // Get e.g. 'E' from the string '&Eacute'
                $replace[] = $entity[1];
            }
        }
    }
    return str_replace($search, $replace, $text);
}

function unaccent_iso8859_1($string)
{
    $string = strtr($string, "\xA1\xAA\xBA\xBF\xC0\xC1\xC2\xC3\xC5\xC7
       \xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1
       \xD2\xD3\xD4\xD5\xD8\xD9\xDA\xDB\xDD\xE0
       \xE1\xE2\xE3\xE5\xE7\xE8\xE9\xEA\xEB\xEC
       \xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF8
       \xF9\xFA\xFB\xFD\xFF", "!ao?AAAAAC
       EEEEIIIIDN
       OOOOOUUUYa
       aaaaceeeei
       iiidnooooo
       uuuyy");
    $string = strtr($string, array(
        "\xC4" => "Ae",
        "\xC6" => "AE",
        "\xD6" => "Oe",
        "\xDC" => "Ue",
        "\xDE" => "TH",
        "\xDF" => "ss",
        "\xE4" => "ae",
        "\xE6" => "ae",
        "\xF6" => "oe",
        "\xFC" => "ue",
        "\xFE" => "th"
    ));
    return ($string);
}

function unaccent_utf8($string)
{
    return iconv("UTF-8", "ASCII//TRANSLIT", $string);
}

function unaccent($s)
{
    return unaccent_utf8($s);
}
/**
 * replace a string separate by $sep
 */
function sep_replace($ak, $idx, $by = "-", $sep = "\n")
{
    $endoff = - 1;
    do {
        $offset = $endoff + 1;
        $endoff = strpos($ak, "\n", $offset);
        $idx--;
    } while (($idx >= 0) && ($endoff !== false));
    
    if ($idx >= 0) return $ak . str_repeat("\n-", $idx) . "\n$by";
    else if ($endoff == false) {
        if ($offset == 0) return "$by";
        else return substr($ak, 0, $offset - 1) . "\n$by";
    } else return substr($ak, 0, $offset) . "$by\n" . substr($ak, $endoff + 1);
}
/**
 * change & < and > character to respetiv entity
 * @param string $s string to encode
 * @return string encoded string
 */
function xml_entity_encode($s)
{
    return str_replace(array(
        '&',
        "<",
        ">"
    ) , array(
        "&amp;",
        "&lt;",
        "&gt;"
    ) , $s);
}
function xml_entity_encode_all($s)
{
    return str_replace(array(
        '"',
        "'"
    ) , array(
        "&quot;",
        "&apos;"
    ) , xml_entity_encode($s));
}
/**
 * Remove JS and other insecure elements from HTML.
 *
 * @param string $html
 * @return string
 */
function cleanhtmljs($html)
{
    /* Tags to remove */
    $tag_list = array(
        'script',
        'iframe',
        'frame',
        'frameset',
        'object',
        'embed',
        'applet'
    );
    /* Attributes to remove */
    $attr_list = 'on[a-z]+';
    /* Pre-compute tag_list regexes */
    $remove_list = array();
    foreach ($tag_list as $tag) {
        $remove_list[] = array(
            'name' => $tag,
            'start' => sprintf('#^<%s\b#i', $tag) ,
            'end' => sprintf('#^</%s\b#i', $tag)
        );
    }
    /*
     * Tokenize HTML: stream of ["text", "<TAG>", "text", "</TAG>", "text", "<FOO/>", "text", etc.]
    */
    $tokens = preg_split("#(<[^>]*?>)#", $html, NULL, PREG_SPLIT_DELIM_CAPTURE);
    /* Parse tokens and remove unwanted elements */
    $skip = false;
    foreach ($tokens as & $elmt) {
        /*
         * Pass 1: remove tags
        */
        foreach ($remove_list as $tag) {
            if (!$skip && preg_match($tag['start'], $elmt)) {
                /* Skip tag */
                $elmt = '';
                /* If not a self-closing tag, then mark to skip it's content */
                if (!preg_match(':/>$:', $elmt)) {
                    $skip = $tag['name'];
                }
                break;
            } elseif ($skip == $tag['name'] && preg_match($tag['end'], $elmt)) {
                /* End of skipped tag's content */
                $skip = false;
                $elmt = '';
                break;
            } elseif (!$skip && preg_match($tag['end'], $elmt)) {
                /* Remove ending tags that have not been started */
                $elmt = '';
                break;
            }
        }
        if ($skip) {
            /* Skip content from removed tags */
            $elmt = '';
            continue;
        }
        /*
         * Pass 2: remove attributes
        */
        if (preg_match('#^<[^>]*?>$#s', $elmt)) {
            $elmt = preg_replace("#\\s*\\b$attr_list\\b\\s*=\\s*(['\"])(.*?)(\\1)#is", "", $elmt);
        }
    }
    unset($elmt);
    /* Recompose content */
    return join('', $tokens);
}