clearnhelper.php

См. документацию.

<?php

class CLearnHelper
{
    const GRAPH_STATUS_NOT_SET          = '1';      // status wasn't set yet (we must determine, is our tables updated to graph or not)
    const GRAPH_STATUS_LEGACY           = '2';
    const GRAPH_STATUS_UPDATED_TO_GRAPH = '3';
    const GRAPH_STATUS_UNDEFINED        = '4';
 
    const MODULE_ID     = 'learning';
    const OPTION_ID     = '~CLearnHelper::isUpdatedToGraph();';
    const DEFAULT_VALUE = self::GRAPH_STATUS_NOT_SET;      // be default
    const SITE_ID       = '';        // request shared options for all sites
 
    const ACCESS_READ   = 0x001;
    const ACCESS_MODIFY = 0x003;   // includes ACCESS_READ

    public static function PatchLessonContentLinks($strContent, $contextCourseId = false)
    {
        static $arCourseLinksPatterns = array(
            '{SELF}'
        );
 
        $argsCheck = is_string($strContent)
            && ($contextCourseId !== false)
            && ($contextCourseId > 0);
 
        if ( ! $argsCheck )
            return ($strContent);
 
        $arCourseResolvedLinks = str_replace(
            '{SELF}',
            (string) ((int) $contextCourseId),
            $arCourseLinksPatterns
        );
 
        $rc = str_replace(
            $arCourseLinksPatterns,
            $arCourseResolvedLinks,
            $strContent
        );
 
        return ($rc);
    }
 

    public static function FireEvent ($eventName, $eventParams)
    {
        $events = GetModuleEvents('learning', $eventName);
        while ($arEvent = $events->Fetch())
            ExecuteModuleEventEx($arEvent, array($eventParams));
    }
 

    public static function SQLClauseForAllSubLessons ($parentLessonId)
    {
        if ( ! (
            is_numeric($parentLessonId)
            && is_int($parentLessonId + 0)
            )
        )
        {
            throw new LearnException (
                '$parentLessonId must be strictly castable to integer',
                LearnException::EXC_ERR_ALL_PARAMS);
        }
 
        // MySQL & MSSQL supports "WHERE IN(...)" clause for more than 10 000 elements
 
        $oTree = CLearnLesson::GetTree($parentLessonId, array('EDGE_SORT' => 'ASC'), array('CHECK_PERMISSIONS' => 'N'));
        $arChildLessonsIds = $oTree->GetLessonsIdListInTree();  // parent lesson id isn't included
 
        // We need escape data for SQL
        $arChildLessonsIdsEscaped = array_map('intval', $arChildLessonsIds);
 
        $sqlChildLessonsIdsList = implode (', ', $arChildLessonsIdsEscaped);
 
        // No childs => nothing must be selected
        if ($sqlChildLessonsIdsList == '')
            $sqlChildLessonsIdsList = 'NULL';       // NULL != any value. NULL != NULL too.
 
        return ($sqlChildLessonsIdsList);
    }
 

    public static function MkOperationFilter($key)
    {
        if(mb_substr($key, 0, 1) == "=") //Identical
        {
            $key = mb_substr($key, 1);
            $cOperationType = "I";
        }
        elseif(mb_substr($key, 0, 2) == "!=") //not Identical
        {
            $key = mb_substr($key, 2);
            $cOperationType = "NI";
        }
        elseif(mb_substr($key, 0, 1) == "%") //substring
        {
            $key = mb_substr($key, 1);
            $cOperationType = "S";
        }
        elseif(mb_substr($key, 0, 2) == "!%") //not substring
        {
            $key = mb_substr($key, 2);
            $cOperationType = "NS";
        }
        elseif(mb_substr($key, 0, 1) == "?") //logical
        {
            $key = mb_substr($key, 1);
            $cOperationType = "?";
        }
        elseif(mb_substr($key, 0, 2) == "><") //between
        {
            $key = mb_substr($key, 2);
            $cOperationType = "B";
        }
        elseif(mb_substr($key, 0, 3) == "!><") //not between
        {
            $key = mb_substr($key, 3);
            $cOperationType = "NB";
        }
        elseif(mb_substr($key, 0, 2) == ">=") //greater or equal
        {
            $key = mb_substr($key, 2);
            $cOperationType = "GE";
        }
        elseif(mb_substr($key, 0, 1) == ">")  //greater
        {
            $key = mb_substr($key, 1);
            $cOperationType = "G";
        }
        elseif(mb_substr($key, 0, 2) == "<=")  //less or equal
        {
            $key = mb_substr($key, 2);
            $cOperationType = "LE";
        }
        elseif(mb_substr($key, 0, 1) == "<")  //less
        {
            $key = mb_substr($key, 1);
            $cOperationType = "L";
        }
        elseif(mb_substr($key, 0, 1) == "!") // not field LIKE val
        {
            $key = mb_substr($key, 1);
            $cOperationType = "N";
        }
        else
            $cOperationType = "E";  // field LIKE val
 
        return Array("FIELD"=>$key, "OPERATION"=>$cOperationType);
    }

    public static function FilterCreate($fname, $vals, $type, &$bFullJoin, $cOperationType=false, $bSkipEmpty = true)
    {
        global $DB;
        if(!is_array($vals))
            $vals=Array($vals);
 
        if(count($vals)<1)
            return "";
 
        if(is_bool($cOperationType))
        {
            if($cOperationType===true)
                $cOperationType = "N";
            else
                $cOperationType = "E";
        }
 
        if($cOperationType=="G")
            $strOperation = ">";
        elseif($cOperationType=="GE")
            $strOperation = ">=";
        elseif($cOperationType=="LE")
            $strOperation = "<=";
        elseif($cOperationType=="L")
            $strOperation = "<";
        else
            $strOperation = "=";
 
        $bFullJoin = false;
        $bWasLeftJoin = false;
 
        $res = Array();
        for($i=0; $i<count($vals); $i++)
        {
            $val = $vals[$i];
 
            if(!$bSkipEmpty || (string)$val <> '' || (is_bool($val) && $val===false))
            {
                switch ($type)
                {
                case "string_equal":
                    if((string)$val == '')
                        $res[] =
                        ($cOperationType=="N"?"NOT":"").
                        "(".
                        $fname." IS NULL OR ".$DB->Length($fname).
                        "<=0)";
                    else
                        $res[] =
                        "(".
                        ($cOperationType=="N"?" ".$fname." IS NULL OR NOT (":"").
                        CCourse::_Upper($fname).$strOperation.CCourse::_Upper("'".$DB->ForSql($val)."'").
                        ($cOperationType=="N"?")":"").
                        ")";
                    break;
                case "string":
                    if($cOperationType=="?")
                    {
                        if((string)$val <> '')
                            $res[] = GetFilterQuery($fname, $val, "Y",array(),"N");
                    }
                    elseif((string)$val == '')
                    {
                        $res[] = ($cOperationType=="N"?"NOT":"")."(".$fname." IS NULL OR ".$DB->Length($fname)."<=0)";
                    }
                    else
                    {
                        if($strOperation=="=")
                            $res[] =
                            "(".
                            ($cOperationType=="N"?" ".$fname." IS NULL OR NOT (":"").
                            ($DB->type == "ORACLE"?CCourse::_Upper($fname)." LIKE ".CCourse::_Upper("'".$DB->ForSqlLike($val)."'")." ESCAPE '\\'" : $fname." ".($strOperation=="="?"LIKE":$strOperation)." '".$DB->ForSqlLike($val)."'").
                            ($cOperationType=="N"?")":"").
                            ")";
                        else
                            $res[] =
                            "(".
                            ($cOperationType=="N"?" ".$fname." IS NULL OR NOT (":"").
                            ($DB->type == "ORACLE"?CCourse::_Upper($fname).
                            " ".$strOperation." ".CCourse::_Upper("'".$DB->ForSql($val)."'")." " : $fname." ".$strOperation." '".$DB->ForSql($val)."'").
                            ($cOperationType=="N"?")":"").
                            ")";
                    }
                    break;
                case "date":
                    if((string)$val == '')
                        $res[] = ($cOperationType=="N"?"NOT":"")."(".$fname." IS NULL)";
                    else
                        $res[] =
                        "(".
                        ($cOperationType=="N"?" ".$fname." IS NULL OR NOT (":"").
                        $fname." ".$strOperation." ".$DB->CharToDateFunction($DB->ForSql($val), "FULL").
                        ($cOperationType=="N"?")":"").
                        ")";
                    break;
                case "number":
                    if((string)$val == '')
                        $res[] = ($cOperationType=="N"?"NOT":"")."(".$fname." IS NULL)";
                    else
                        $res[] =
                        "(".
                        ($cOperationType=="N"?" ".$fname." IS NULL OR NOT (":"").
                        $fname." ".$strOperation." '".DoubleVal($val).
                        ($cOperationType=="N"?"')":"'").
                        ")";
                    break;
                /*
                case "number_above":
                    if(strlen($val)<=0)
                        $res[] = ($cOperationType=="N"?"NOT":"")."(".$fname." IS NULL)";
                    else
                        $res[] = ($cOperationType=="N"?" ".$fname." IS NULL OR NOT ":"")."(".$fname." ".$strOperation." '".$DB->ForSql($val)."')";
                    break;
                */
                }
 
                // INNER JOIN in this case
                if((string)$val <> '' && $cOperationType!="N")
                    $bFullJoin = true;
                else
                    $bWasLeftJoin = true;
            }
        }
 
        $strResult = "";
        for($i=0; $i<count($res); $i++)
        {
            if($i>0)
                $strResult .= ($cOperationType=="N"?" AND ":" OR ");
            $strResult .= $res[$i];
        }
 
        if (count($res) > 1)
            $strResult = "(".$strResult.")";
 
 
        if($bFullJoin && $bWasLeftJoin && $cOperationType!="N")
            $bFullJoin = false;
 
        return $strResult;
    }

    public static function isUpdatedToGraph()
    {
        if (self::getUpdatedToGraphStatus() === self::GRAPH_STATUS_UPDATED_TO_GRAPH)
            return true;
        else
            return false;
    }

    public static function setUpdatedToGraphStatus($status)
    {
        $description = '';
 
        $isSaved = COption::SetOptionString(self::MODULE_ID, self::OPTION_ID,
            $status, $description, self::SITE_ID);
 
        return ($isSaved);
    }

    public static function getUpdatedToGraphStatus()
    {
 
        $rc = COption::GetOptionString(self::MODULE_ID, self::OPTION_ID, self::DEFAULT_VALUE, self::SITE_ID);
 
        // status wasn't set yet (we must determine, is our tables updated to graph or not)
        if ($rc === self::DEFAULT_VALUE)
        {
            // Set determined mode in global options
            self::setUpdatedToGraphStatus(self::GRAPH_STATUS_LEGACY);
        }
 
        $allowed_statuses = array (
            self::GRAPH_STATUS_LEGACY,
            self::GRAPH_STATUS_UPDATED_TO_GRAPH,
            self::GRAPH_STATUS_UNDEFINED
            );
 
        if ( ! in_array($rc, $allowed_statuses, true) )
        {
            AddMessage2Log('Invalid COption ~CLearnHelper::isUpdatedToGraph();: `'
                . $rc . '`;', 'learning');
 
            $rc = self::GRAPH_STATUS_UNDEFINED;
        }
 
        return ($rc);
    }
 
 
    public static function IsBaseFilenameSafe($filename)
    {
 
        $isUnSafe = IsFileUnsafe($filename)
            || HasScriptExtension($filename)
            || ( ! (preg_match("#^[^\\\/:*?\"\'~%<>|]+$#is", $filename) > 0) );
 
        return ( ! $isUnSafe );
    }
 
 
    public static function CopyDirFiles($path_from, $path_to, $ReWrite = True, $Recursive = False)
    {
        if (mb_strpos($path_to."/", $path_from."/") === 0 || realpath($path_to) === realpath($path_from))
            return false;
 
        if (is_dir($path_from))
        {
            CheckDirPath($path_to."/");
        }
        elseif(is_file($path_from))
        {
            $p = bxstrrpos($path_to, "/");
            $path_to_dir = mb_substr($path_to, 0, $p);
            CheckDirPath($path_to_dir."/");
 
            if (file_exists($path_to) && !$ReWrite)
                return False;
 
            @copy($path_from, $path_to);
            if(is_file($path_to))
                @chmod($path_to, BX_FILE_PERMISSIONS);
 
            return True;
        }
        else
        {
            return True;
        }
 
        if ($handle = @opendir($path_from))
        {
            while (($file = readdir($handle)) !== false)
            {
                if ($file == "." || $file == "..")
                    continue;
 
                // skip files with non-safe names
                if ( ! CLearnHelper::IsBaseFilenameSafe($file) )
                    continue;
 
                if (is_dir($path_from."/".$file) && $Recursive)
                {
                    self::CopyDirFiles($path_from."/".$file, $path_to."/".$file, $ReWrite, $Recursive);
                }
                elseif (is_file($path_from."/".$file))
                {
                    if (file_exists($path_to."/".$file) && !$ReWrite)
                        continue;
 
                    @copy($path_from."/".$file, $path_to."/".$file);
                    @chmod($path_to."/".$file, BX_FILE_PERMISSIONS);
                }
            }
            @closedir($handle);
 
            return true;
        }
 
        return false;
    }
}