XoopsModules25x / userlog

class/stats.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 29 and the first side effect is on line 22.

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 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.
*/
/**
 *  userlog module
 *
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 * @package         userlog class
 * @since           1
 * @author          irmtfan (irmtfan@yahoo.com)
 * @author          XOOPS Project <www.xoops.org> <www.xoops.ir>
 */

defined('XOOPS_ROOT_PATH') || exit('Restricted access.');
require_once __DIR__ . '/../include/common.php';
xoops_loadLanguage('admin', USERLOG_DIRNAME);

/**
 * Class UserlogStats
 */
class UserlogStats extends XoopsObject

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @var string
     */
    public $userlog = null;
    public $period  = ['all' => 0, 'today' => 1, 'week' => 7, 'month' => 30];
    public $type    = [
        'log'      => _AM_USERLOG_STATS_LOG,
        'logdel'   => _AM_USERLOG_STATS_LOGDEL,
        'set'      => _AM_USERLOG_STATS_SET,
        'file'     => _AM_USERLOG_STATS_FILE,
        'fileall'  => _AM_USERLOG_STATS_FILEALL,
        'referral' => _AM_USERLOG_STATS_REFERRAL,
        'browser'  => _AM_USERLOG_STATS_BROWSER,
        'OS'       => _AM_USERLOG_STATS_OS,
        'views'    => _AM_USERLOG_STATS_VIEWS
    ];

    /**
     *
     */
    public function __construct()
    {
        $this->userlog = Userlog::getInstance();

It seems like \Userlog::getInstance() of type object<Userlog> is incompatible with the declared type string of property $userlog.

        $this->initVar('stats_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('stats_type', XOBJ_DTYPE_TXTBOX, null, false, 10);
        $this->initVar('stats_link', XOBJ_DTYPE_TXTBOX, null, false, 100);
        $this->initVar('stats_value', XOBJ_DTYPE_INT, null, false);
        $this->initVar('stats_period', XOBJ_DTYPE_INT, null, false);
        $this->initVar('time_update', XOBJ_DTYPE_INT, null, false);
    }

    /**
     * @param string $method
     * @param array  $args
     *
     * @return mixed
     */
    public function __call($method, $args)
    {
        $arg = isset($args[0]) ? $args[0] : null;

        return $this->getVar($method, $arg);
    }

    /**
     * @return UserlogStats
     */
    public static function getInstance()
    {
        static $instance;
        if (null === $instance) {
            $instance = new static();
        }

        return $instance;
    }

    /**
     * @return bool|string
     */
    public function time_update()
    {
        return $this->userlog->formatTime($this->getVar('time_update'));

The method formatTime cannot be called on $this->userlog (of type string).

    }
    // $type = null or array() => get all types

    /**
     * @param array  $type
     * @param int    $start
     * @param int    $limit
     * @param string $sort
     * @param string $order
     * @param null   $otherCriteria
     *
     * @return mixed
     */
    public function getAll(
        $type = [],
        $start = 0,
        $limit = 0,
        $sort = 'stats_value',
        $order = 'DESC',
        $otherCriteria = null
    ) {
        $criteria = new CriteriaCompo();
        if (!empty($type)) {
            $typeArr = is_array($type) ? $type : [$type];
            foreach ($typeArr as $tt) {
                $criteria->add(new Criteria('stats_type', $tt), 'OR');
            }
        }
        if (!empty($otherCriteria)) {
            $criteria->add($otherCriteria);
        }
        $criteria->setStart($start);
        $criteria->setLimit($limit);
        $criteria->setSort($sort);
        $criteria->setOrder($order);
        $statsObj = $this->userlog->getHandler('stats')->getAll($criteria);

The method getHandler cannot be called on $this->userlog (of type string).

        if (empty($statsObj)) {
            return false;
        } // if no result nothing in database
        foreach ($statsObj as $sObj) {
            $link = $sObj->stats_link();
            // if there is a link and only one type just index link
            $index1 = (!empty($link) && 1 == count($type)) ? $link : $sObj->stats_type() . $link;
            $index2 = $sObj->stats_period();
            if (!isset($ret[$index1])) {
                $ret[$index1] = [];

$ret was never initialized. Although not strictly required by PHP, it is generally a good practice to add $ret = array(); before regardless.

            }
            if (!isset($ret[$index1][$index2])) {
                $ret[$index1][$index2] = [];

The variable $ret does not seem to be defined for all execution paths leading up to this point.

            }
            $ret[$index1][$index2]['value']       = $sObj->stats_value();
            $ret[$index1][$index2]['time_update'] = $sObj->time_update();
        }

        return $ret;
    }

    /**
     * @param string $type
     * @param int    $prob
     *
     * @return bool
     */
    public function updateAll($type = 'log', $prob = 11)
    {
        if (!$this->userlog->probCheck($prob)) {

The method probCheck cannot be called on $this->userlog (of type string).

            return false;
        }
        switch ($type) {
            case 'set':
                // total
                $sets = $this->userlog->getHandler('setting')->getCount();

The method getHandler cannot be called on $this->userlog (of type string).

                $this->update('set', 0, $sets);
                break;
            case 'file':
                list($allFiles, $totalFiles) = $this->userlog->getAllLogFiles();

The method getAllLogFiles cannot be called on $this->userlog (of type string).

                foreach ($allFiles as $path => $files) {
                    $log_file = $path . '/' . $this->userlog->getConfig('logfilename') . '.' . $this->userlog->logext;

The method getConfig cannot be called on $this->userlog (of type string).

                    $this->update('file', 0, count($files), false, $log_file); // update working file in all paths (now 2)
                }
                // update all files in db link='all'
                $this->update('file', 0, $totalFiles, false, 'all');
                break;
            case 'views':
                break;
            case 'log':
                // if logs exceed the maxlogsperiod delete them
                if (0 != $this->userlog->getConfig('maxlogsperiod')) {

The method getConfig cannot be called on $this->userlog (of type string).

                    $criteriaDel = new CriteriaCompo();
                    $until       = time() - $this->userlog->getSinceTime($this->userlog->getConfig('maxlogsperiod'));

The method getConfig cannot be called on $this->userlog (of type string).

The method getSinceTime cannot be called on $this->userlog (of type string).

                    $criteriaDel->add(new Criteria('log_time', $until, '<'), 'AND');
                    $numDelPeriod = $this->delete('log', 0, 0, $criteriaDel); // all time = maxlogsperiod

$numDelPeriod is not used, you could remove the assignment.

                }
                foreach ($this->period as $per) {
                    $criteria = new CriteriaCompo();
                    if (!empty($per)) {

This code seems to be duplicated across your project.

                        // today, week, month
                        $since = $this->userlog->getSinceTime($per);

The method getSinceTime cannot be called on $this->userlog (of type string).

                        $criteria->add(new Criteria('log_time', time() - $since, '>'), 'AND');
                    }
                    $logs   = $this->userlog->getHandler('log')->getLogsCount($criteria);

The method getHandler cannot be called on $this->userlog (of type string).

                    $exceed = $logs - $this->userlog->getConfig('maxlogs');

The method getConfig cannot be called on $this->userlog (of type string).

                    // if logs exceed the maxlogs delete them
                    if ($exceed > 0) {
                        $numDel = $this->delete('log', $per, $exceed, null, true);
                        $logs   -= $numDel;
                    }
                    $this->update('log', $per, $logs);
                }
                break;
            case 'referral':
                $criteria = new CriteriaCompo();
                $criteria->add(new Criteria('referer', XOOPS_URL . '%', 'NOT LIKE'));
                $criteria->setGroupBy('referer');
                $outsideReferers = $this->userlog->getHandler('log')->getCounts($criteria);

The method getHandler cannot be called on $this->userlog (of type string).

                $referrals       = [];
                foreach ($outsideReferers as $ref => $views) {
                    if (empty($ref)) {
                        continue;
                    }
                    $outRef = parse_url($ref, PHP_URL_HOST);
                    if (!isset($referrals[$outRef])) {
                        $referrals[$outRef] = 0;
                    }
                    $referrals[$outRef] += $views;
                }
                foreach ($referrals as $ref => $views) {
                    $this->update('referral', 0, $views, false, $ref);
                }
                $this->deleteExpiredStats('referral');
                break;
            case 'browser':
            case 'OS':
                $criteria = new CriteriaCompo();
                $criteria->setGroupBy('user_agent');
                $agents   = $this->userlog->getHandler('log')->getCounts($criteria);

The method getHandler cannot be called on $this->userlog (of type string).

                $browsers = [];
                $OSes     = [];
                foreach ($agents as $agent => $views) {
                    if (empty($agent)) {
                        continue;
                    }
                    $browserArr    = $this->userlog->getBrowsCap()->getBrowser($agent, true);

The method getBrowsCap cannot be called on $this->userlog (of type string).

                    $browserParent = !empty($browserArr['Parent']) ? (!empty($browserArr['Crawler']) ? 'crawler: ' : '') . $browserArr['Parent'] : 'unknown';
                    if (!isset($browsers[$browserParent])) {
                        $browsers[$browserParent] = 0;
                    }
                    $browsers[$browserParent] += $views;
                    if (!isset($OSes[$browserArr['Platform']])) {
                        $OSes[$browserArr['Platform']] = 0;
                    }
                    $OSes[$browserArr['Platform']] += $views;
                }
                foreach ($browsers as $browser => $views) {
                    $this->update('browser', 0, $views, false, $browser);
                }
                foreach ($OSes as $OS => $views) {
                    $this->update('OS', 0, $views, false, $OS);
                }
                $this->deleteExpiredStats(['browser', 'OS']);
                break;
        }

        return true;
    }

    /**
     * @param string $type
     * @param int    $period
     * @param int    $limitDel
     * @param null   $criteria
     * @param bool   $asObject
     *
     * @return int
     */
    public function delete($type = 'log', $period = 0, $limitDel = 0, $criteria = null, $asObject = false)
    {
        switch ($type) {
            case 'log':
                if ($asObject) {
                    $logsObj = $this->userlog->getHandler('log')->getLogs($limitDel, 0, $criteria, 'log_id', 'ASC');

The method getHandler cannot be called on $this->userlog (of type string).

                    $numDel  = 0;
                    foreach (array_keys($logsObj) as $key) {
                        $numDel += $this->userlog->getHandler('log')->delete($logsObj[$key], true) ? 1 : 0;

The method getHandler cannot be called on $this->userlog (of type string).

                    }
                    if ($numDel > 0) {
                        $this->update('logdel', $period, $numDel, true); // increment
                    }
                    unset($logsObj);

                    return $numDel;
                }
                $numDel = $this->userlog->getHandler('log')->deleteAll($criteria, true, $asObject);

The method getHandler cannot be called on $this->userlog (of type string).

                if ($numDel > 0) {
                    $this->update('logdel', $period, $numDel, true); // increment
                }

                return $numDel;
                break;

break is not strictly necessary here and could be removed.

        }
    }

    /**
     * @param string $type
     * @param int    $period
     * @param null   $value
     * @param bool   $increment
     * @param string $link
     *
     * @return mixed
     */
    public function update($type = 'log', $period = 0, $value = null, $increment = false, $link = '')
    {
        // check if version is 115 => unique index is added
        if ($this->userlog->getModule()->getVar('version') < 115) {

The method getModule cannot be called on $this->userlog (of type string).

            return false;
        }
        // if there is nothing to add to db
        if (empty($value) && !empty($increment)) {
            return false;
        }
        // for file,referral,browser,OS we should have a link
        if (in_array($type, ['file', 'referral', 'browser', 'OS']) && empty($link)) {
            return false;
        }
        $statsObj = $this->userlog->getHandler('stats')->create();

The method getHandler cannot be called on $this->userlog (of type string).

        $statsObj->setVar('stats_type', $type);
        $statsObj->setVar('stats_period', $period);
        $statsObj->setVar('stats_link', $link);
        $statsObj->setVar('stats_value', $value);
        $statsObj->setVar('time_update', time());
        // increment value if increment is true
        $ret = $this->userlog->getHandler('stats')->insertUpdate($statsObj, [

The method getHandler cannot be called on $this->userlog (of type string).

            'stats_value' => empty($increment) ? $value : "stats_value + {$value}",
            'time_update' => time()
        ]);
        $this->unsetNew();

        return $ret;
    }

    /**
     * Delete expired statistics for types when time_update < expire time
     *
     * @access public
     *
     * @param array $types  - types ($this->type)
     * @param int   $expire - delete all records exist in the table before expire time - positive for days and negatice for hours - 0 = never expired
     *
     * @return int count of deleted rows
     */
    public function deleteExpiredStats($types = ['browser'], $expire = 1)
    {
        if (empty($expire)) {
            return false;

The return type of return false; (false) is incompatible with the return type documented by UserlogStats::deleteExpiredStats of type integer.

        } // if $expire = 0 dont delete
        $criteriaDel = new CriteriaCompo();
        $until       = time() - $this->userlog->getSinceTime($expire);

The method getSinceTime cannot be called on $this->userlog (of type string).

        if (!empty($types)) {
            $criteriaTypes = new CriteriaCompo();
            $types         = is_array($types) ? $types : [$types];
            foreach ($types as $type) {
                $criteriaTypes->add(new Criteria('stats_type', $type, '='), 'OR');
            }
            $criteriaDel->add($criteriaTypes, 'AND');
        }
        $criteriaTime = new CriteriaCompo();
        $criteriaTime->add(new Criteria('time_update', $until, '<'), 'AND');
        $criteriaDel->add($criteriaTime, 'AND');

        return $this->userlog->getHandler('stats')->deleteAll($criteriaDel); // function deleteAll($criteria = null, $force = true, $asObject = false)

The method getHandler cannot be called on $this->userlog (of type string).

44% of this comment could be valid code. Did you maybe forget this after debugging?

    }
}

/**
 * Class UserlogStatsHandler
 */
class UserlogStatsHandler extends XoopsPersistableObjectHandler

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    public $userlog = null;

    /**
     * @param null|XoopsDatabase $db
     */
    public function __construct(XoopsDatabase $db)
    {
        $this->userlog = Userlog::getInstance();
        parent::__construct($db, USERLOG_DIRNAME . '_stats', 'UserlogStats', 'stats_id', 'stats_type');
    }

    /**
     * @param       $object
     * @param array $duplicate
     * @param bool  $force
     *
     * @return bool
     */
    public function insertUpdate($object, $duplicate = [], $force = true)
    {
        $handler = $this->loadHandler('write');

        if (!$object->isDirty()) {

This code seems to be duplicated across your project.

            trigger_error("Data entry is not inserted - the object '" . get_class($object) . "' is not dirty," . "' with errors: " . implode(', ', $object->getErrors()), E_USER_NOTICE);

            return $object->getVar($this->keyName);
        }
        if (!$handler->cleanVars($object)) {

This code seems to be duplicated across your project.

            trigger_error("Insert failed in method 'cleanVars' of object '" . get_class($object) . "' with errors: " . implode(', ', $object->getErrors()), E_USER_WARNING);

            return $object->getVar($this->keyName);
        }
        $queryFunc = empty($force) ? 'query' : 'queryF';

        if ($object->isNew()) {
            $sql = "INSERT INTO {$this->table}";
            if (!empty($object->cleanVars)) {
                $keys = array_keys($object->cleanVars);
                $vals = array_values($object->cleanVars);
                $sql  .= ' (' . implode(', ', $keys) . ') VALUES (' . implode(',', $vals) . ')';
            } else {

This code seems to be duplicated across your project.

                trigger_error("Data entry is not inserted - no variable is changed in object of '" . get_class($object) . "' with errors: " . implode(', ', $object->getErrors()), E_USER_NOTICE);

                return $object->getVar($this->keyName);
            }
            // START ON DUPLICATE KEY UPDATE
            if (!empty($duplicate)) {
                $sql  .= ' ON DUPLICATE KEY UPDATE';
                $keys = [];
                foreach ($duplicate as $keyD => $valD) {
                    $keys[] = " {$keyD} = {$valD} ";
                }
                $sql .= implode(', ', $keys);
            }
            // END ON DUPLICATE KEY UPDATE
            if (!$result = $this->db->{$queryFunc}($sql)) {
                return false;
            }
            if (!$object->getVar($this->keyName) && $object_id = $this->db->getInsertId()) {
                $object->assignVar($this->keyName, $object_id);
            }
        } elseif (!empty($object->cleanVars)) {
            $keys = [];
            foreach ($object->cleanVars as $k => $v) {
                $keys[] = " `{$k}` = {$v}";
            }
            $sql = 'UPDATE `' . $this->table . '` SET ' . implode(',', $keys) . ' WHERE `' . $this->keyName . '` = ' . $this->db->quote($object->getVar($this->keyName));
            if (!$result = $this->db->{$queryFunc}($sql)) {
                return false;
            }
        }

        return $object->getVar($this->keyName);
    }

    /**
     * Show index in a table
     *
     * @access   public
     *
     * @param string $index - name of the index (will be used in KEY_NAME)

Should the type for parameter $index not be string|null?

     *
     * @internal param array $ret = Table    Non_unique    Key_name    Seq_in_index    Column_name        Collation    Cardinality        Sub_part    Packed    Null    Index_type    Comment    Index_comment
     *
     * @return array|bool
     */
    public function showIndex($index = null)

This method seems to be duplicated in your project.

    {
        $sql = "SHOW INDEX FROM {$this->table}";
        if (isset($index)) {
            $sql .= " WHERE KEY_NAME = '{$index}'";
        }
        if (!$result = $this->db->queryF($sql)) {
            xoops_error($this->db->error() . '<br>' . $sql);

            return false;
        }
        $ret = [];
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $ret[] = $myrow;
        }

        return $ret;
    }

    /**
     * Add Index to a table
     *
     * @access public
     *
     * @param string $index      - name of the index

Should the type for parameter $index not be string|null?

     * @param array  $fields     - array of table fields should be in the index
     * @param string $index_type - type of the index array("INDEX", "UNIQUE", "SPATIAL", "FULLTEXT")
     * @param        bool
     *
     * @return bool
     */
    public function addIndex($index = null, $fields = [], $index_type = 'INDEX')

This method seems to be duplicated in your project.

    {
        if (empty($index) || empty($fields)) {
            return false;
        }
        if ($this->showIndex($index)) {
            return false;
        } // index is exist
        $index_type = strtoupper($index_type);
        if (!in_array($index_type, ['INDEX', 'UNIQUE', 'SPATIAL', 'FULLTEXT'])) {
            return false;
        }
        $fields = is_array($fields) ? implode(',', $fields) : $fields;
        $sql    = "ALTER TABLE {$this->table} ADD {$index_type} {$index} ( {$fields} )";
        if (!$result = $this->db->queryF($sql)) {
            xoops_error($this->db->error() . '<br>' . $sql);

            return false;
        }

        return true;
    }

    /**
     * Drop index in a table
     *
     * @access public
     *
     * @param string $index - name of the index

Should the type for parameter $index not be string|null?

     * @param        bool
     *
     * @return bool
     */
    public function dropIndex($index = null)

This method seems to be duplicated in your project.

    {
        if (empty($index)) {
            return false;
        }
        if (!$this->showIndex($index)) {
            return false;
        } // index is not exist
        $sql = "ALTER TABLE {$this->table} DROP INDEX {$index}";
        if (!$result = $this->db->queryF($sql)) {
            xoops_error($this->db->error() . '<br>' . $sql);

            return false;
        }

        return true;
    }

    /**
     * Change Index = Drop index + Add Index
     *
     * @access public
     *
     * @param string $index      - name of the index

Should the type for parameter $index not be string|null?

     * @param array  $fields     - array of table fields should be in the index
     * @param string $index_type - type of the index array("INDEX", "UNIQUE", "SPATIAL", "FULLTEXT")
     * @param        bool
     *
     * @return bool
     */
    public function changeIndex($index = null, $fields = [], $index_type = 'INDEX')

This method seems to be duplicated in your project.

    {
        if ($this->showIndex($index) && !$this->dropIndex($index)) {
            return false;
        } // if index is exist but cannot drop it

        return $this->addIndex($index, $fields, $index_type);
    }
}