cachelog::getNeedsMaintenance() - Code Metrics - Inspection of "Merge pull request #789 from following5/patch-3" - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — next ( 5f2bc0...cef70f )

by Thomas

created 2020-09-08 06:40 UTC

cachelog::getNeedsMaintenance() A

↳ Parent: cachelog

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/***************************************************************************
 * for license information see LICENSE.md
 *
 *
 *   get/set has to be committed with save
 *   add/remove etc. is executed instantly
 ***************************************************************************/

require_once __DIR__ . '/logtypes.inc.php';

class cachelog
{
    const LOGTYPE_FOUND = 1;
    const LOGTYPE_NOTFOUND = 2;
    const LOGTYPE_NOTE = 3;
    const LOGTYPE_ATTENDED = 7;
    const LOGTYPE_WILLATTEND = 8;
    const LOGTYPE_ARCHIVED = 9;
    const LOGTYPE_ACTIVE = 10;
    const LOGTYPE_DISABLED = 11;
    const LOGTYPE_LOCKED = 13;
    const LOGTYPE_LOCKED_INVISIBLE = 14;

    public $nLogId = 0;

    public $reCacheLog;

    public static function logIdFromUUID($uuid)
    {
        $cacheid = sql_value("SELECT `id` FROM `cache_logs` WHERE `uuid`='&1'", 0, $uuid);


        return $cacheid;
    }

    public static function fromUUID($uuid)
    {
        $logid = self::logIdFromUUID($uuid);
        if ($logid == 0) {
            return null;
        }

        return new self($logid);
    }

    public static function createNew($nCacheId, $nUserId)

    {
        global $opt;

        // check if user is allowed to log this cache!
        $cache = new cache($nCacheId);
        if ($cache->exist() == false) {

            return false;
        }
        if ($cache->allowLog() == false) {

            return false;
        }

        $oCacheLog = new self(ID_NEW);
        $oCacheLog->setUserId($nUserId);
        $oCacheLog->setCacheId($nCacheId);
        $oCacheLog->setNode($opt['logic']['node']['id']);

        return $oCacheLog;
    }

    public static function createNewFromCache($oCache, $nUserId)

    {
        global $opt;

        // check if user is allowed to log this cache!
        if ($oCache->exist() == false) {
            return false;
        }
        if ($oCache->allowLog() == false) {
            return false;
        }

        $oCacheLog = new self(ID_NEW);
        $oCacheLog->setUserId($nUserId);
        $oCacheLog->setCacheId($oCache->getCacheId());
        $oCacheLog->setNode($opt['logic']['node']['id']);

        return $oCacheLog;
    }

    public function __construct($nNewLogId = ID_NEW)
    {
        $this->reCacheLog = new rowEditor('cache_logs');
        $this->reCacheLog->addPKInt('id', null, false, RE_INSERT_AUTOINCREMENT);
        $this->reCacheLog->addString('uuid', '', false, RE_INSERT_AUTOUUID);
        $this->reCacheLog->addInt('node', 0, false);
        $this->reCacheLog->addDate('date_created', time(), true, RE_INSERT_IGNORE);
        $this->reCacheLog->addDate('last_modified', time(), true, RE_INSERT_IGNORE);
        $this->reCacheLog->addInt('cache_id', 0, false);
        $this->reCacheLog->addInt('user_id', 0, false);
        $this->reCacheLog->addInt('type', 0, false);
        $this->reCacheLog->addInt('oc_team_comment', 0, false);
        $this->reCacheLog->addDate('date', time(), false);
        $this->reCacheLog->addInt('needs_maintenance', 0, false);
        $this->reCacheLog->addInt('listing_outdated', 0, false);
        $this->reCacheLog->addString('text', '', false);
        $this->reCacheLog->addInt('text_html', 1, false);
        $this->reCacheLog->addInt('text_htmledit', 1, false);
        $this->reCacheLog->addInt('owner_notified', 0, false);
        $this->reCacheLog->addInt('picture', 0, false);

        $this->nLogId = $nNewLogId + 0;

        if ($nNewLogId == ID_NEW) {
            $this->reCacheLog->addNew(null);
        } else {
            $this->reCacheLog->load($this->nLogId);
        }
    }

    public function exist()
    {
        return $this->reCacheLog->exist();
    }

    public function getLogId()
    {
        return $this->nLogId;
    }

    public function getUserId()
    {
        return $this->reCacheLog->getValue('user_id');
    }

    public function setUserId($value)
    {
        return $this->reCacheLog->setValue('user_id', $value);
    }

    public function getCacheId()
    {
        return $this->reCacheLog->getValue('cache_id');
    }

    public function setCacheId($value)
    {
        return $this->reCacheLog->setValue('cache_id', $value);
    }

    public function getType()
    {
        return $this->reCacheLog->getValue('type');
    }

    public function setType($value, $force = false)
    {
        if (!$force) {
            $nValidLogTypes = $this->getValidLogTypes();
            if (array_search($value, $nValidLogTypes) === false) {
                return false;
            }
        }

        return $this->reCacheLog->setValue('type', $value);
    }

    public function getOcTeamComment()
    {
        return $this->reCacheLog->getValue('oc_team_comment');
    }

    public function setOcTeamComment($value)
    {
        return $this->reCacheLog->setValue('oc_team_comment', $value);
    }

    public function getDate()
    {
        return $this->reCacheLog->getValue('date');
    }

    public function setDate($value)
    {
        return $this->reCacheLog->setValue('date', $value);
    }

    public function getNeedsMaintenance()
    {
        return $this->reCacheLog->getValue('needs_maintenance');
    }

    public function setNeedsMaintenance($value)
    {
        return $this->reCacheLog->setValue('needs_maintenance', $value);
    }

    public function getListingOutdated()
    {
        return $this->reCacheLog->getValue('listing_outdated');
    }

    public function setListingOutdated($value)
    {
        return $this->reCacheLog->setValue('listing_outdated', $value);
    }

    public function getText()
    {
        return $this->reCacheLog->getValue('text');
    }

    public function setText($value)
    {
        return $this->reCacheLog->setValue('text', $value);
    }

    public function getTextHtml()
    {
        return $this->reCacheLog->getValue('text_html');
    }

    public function setTextHtml($value)
    {
        return $this->reCacheLog->setValue('text_html', $value ? 1 : 0);
    }

    public function getTextHtmlEdit()
    {
        return $this->reCacheLog->getValue('text_html');
    }

    public function setTextHtmlEdit($value)
    {
        return $this->reCacheLog->setValue('text_htmledit', $value ? 1 : 0);
    }

    public function getUUID()
    {
        return $this->reCacheLog->getValue('uuid');
    }

    public function getLastModified()
    {
        return $this->reCacheLog->getValue('last_modified');
    }

    public function getDateCreated()
    {
        return $this->reCacheLog->getValue('date_created');
    }

    public function getNode()
    {
        return $this->reCacheLog->getValue('node');
    }

    public function setNode($value)
    {
        return $this->reCacheLog->setValue('node', $value);
    }

    public function getOwnerNotified()
    {
        return $this->reCacheLog->getValue('owner_notified') != 0;
    }

    /**
     * @param int $value
     * @return bool
     */
    public function setOwnerNotified($value)
    {
        return $this->reCacheLog->setValue('owner_notified', $value ? 1 : 0);
    }

    public function getAnyChanged()
    {
        return $this->reCacheLog->getAnyChanged();
    }

    // return if successfull (with insert)
    public function save()
    {
        // additional safeguard against setting unallowd log flags
        if (!sql_value(

            "SELECT `maintenance_logs` FROM `log_types` WHERE `id`='&1'",
            false,
            $this->getType()
        )
        ) {
            $this->setNeedsMaintenance(false);
            $this->setListingOutdated(false);
        }

        sql_slave_exclude();

        $saved = $this->reCacheLog->save();
        if ($saved && $this->nLogId == ID_NEW) {
            $this->nLogId = $this->reCacheLog->getValue('id');
        }

        return $saved;
    }

    public function updatePictureStat(): void
    {
        sql(

            "UPDATE `cache_logs` SET `picture` =
               (SELECT COUNT(*) FROM `pictures` WHERE `object_type`=1 AND `object_id`='&1')
             WHERE `id`= '&1'",
            $this->getLogId()
        );
    }

    public function allowView()

    {
        global $login;

        $login->verify();
        $allow = sql_value(

            "SELECT `cache_status`.`allow_user_view`
             FROM `caches`
             INNER JOIN `cache_status`
                 ON `caches`.`status`=`cache_status`.`id`
             WHERE `caches`.`cache_id`='&1'",
            0,
            $this->getCacheId()
        );
        if ($allow == 1) {
            return true;
        } elseif ($login->userid == sql_value(

            "SELECT `user_id` FROM `caches` WHERE `cache_id`='&1'",
            0,
            $this->getCacheId()
        )) {
            return true;
        }

        return false;
    }

    public function allowEdit()

    {
        global $login;

        $login->verify();
        if ($this->getUserId() == $login->userid) {
            return true;
        }

        return false;
    }

    public function getValidLogTypes()
    {
        $cache = new cache($this->getCacheId());
        if ($cache->exist() == false) {

            return [];
        }
        // if ($cache->allowLog() == false)
        //     return array();
        // Logic Error - log types are still valid when no NEW logs are allowed for the cache.
        // (Would e.g. block admin logs and log-type restoring for locked caches.)
        return get_cache_log_types($this->getCacheId(), $this->getType());  // depends on userid
    }

    public static function isDuplicate($cacheId, $userId, $logType, $logDate, $logText)
    {
        // get info if exact the same values are already in database
        return sql_value(

            "SELECT COUNT(`id`)
             FROM `cache_logs`
             WHERE
                `cache_id`='&1'
                AND `user_id`='&2'
                AND `type`='&3'
                AND `date`='&4'
                AND `text`='&5'",
            0,
            $cacheId,
            $userId,
            $logType,
            $logDate,
            $logText
        ) != 0;
    }

    public static function isMasslogging($userId)
    {
        global $opt;

        // check for probably wrong-dated mass logs

        $rs = sql(

            "
                    SELECT `date`, `text`
                    FROM `cache_logs`
                    WHERE `id`= (
                        SELECT `id`
                        FROM `cache_logs`
                        WHERE `user_id`='&1'
                        ORDER BY `date_created` DESC,
                                 `id` DESC
                        LIMIT 1)",
            $userId
        );

        $rLastLog = sql_fetch_array($rs);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        sql_free_result($rs);


        if ($rLastLog) {

            $rs = sql(

                "
                        SELECT COUNT(*) AS `masslogs`
                        FROM `cache_logs`
                        WHERE `user_id`='&1'
                            AND `date`='&2'
                            AND `text`='&3'",
                $userId,
                $rLastLog['date'],
                $rLastLog['text']
            );

            $r = sql_fetch_array($rs);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $masslogs = $r['masslogs'];
            sql_free_result($rs);

        } else {
            $masslogs = 0;
        }

        return ($masslogs > $opt['logic']['masslog']['count']);
    }

    public static function validateDate($year, $month, $day, $hour, $minute, $submit)
    {
        $dateOk = false;

        if (($hour . $minute === '' || is_numeric($hour))
            && ($minute === '' || is_numeric($minute))
        ) {
            $dateOk = checkdate($month, $day, $year)
                && ($year >= 2000)
                && ($hour >= 0)
                && ($hour <= 23)
                && ($minute >= 0)
                && ($minute <= 59);
            if ($dateOk && $submit) {
                $dateOk = (
                    mktime(
                        (int) $hour,
                        (int) $minute,
                        0,
                        $month,
                        $day,
                        $year
                    )
                    < time()
                );
            }
        }

        return $dateOk;
    }
}


1			<?php
2			/***************************************************************************
3			* for license information see LICENSE.md
4			*
5			*
6			* get/set has to be committed with save
7			* add/remove etc. is executed instantly
8			***************************************************************************/
9
10			require_once __DIR__ . '/logtypes.inc.php';
11
12			class cachelog
13			{
14			const LOGTYPE_FOUND = 1;
15			const LOGTYPE_NOTFOUND = 2;
16			const LOGTYPE_NOTE = 3;
17			const LOGTYPE_ATTENDED = 7;
18			const LOGTYPE_WILLATTEND = 8;
19			const LOGTYPE_ARCHIVED = 9;
20			const LOGTYPE_ACTIVE = 10;
21			const LOGTYPE_DISABLED = 11;
22			const LOGTYPE_LOCKED = 13;
23			const LOGTYPE_LOCKED_INVISIBLE = 14;
24
25			public $nLogId = 0;
26
27			public $reCacheLog;
28
29			public static function logIdFromUUID($uuid)
30			{
31			$cacheid = sql_value("SELECT `id` FROM `cache_logs` WHERE `uuid`='&1'", 0, $uuid);
			0 ignored issues – show Deprecated Code introduced 2017-10-17 14:32 UTC by Report Bug Copy Issue Report The function `sql_value()` has been deprecated with message: use DBAL Conenction instead. See adminreports.php for an example implementation This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
32
33			return $cacheid;
34			}
35
36			public static function fromUUID($uuid)
37			{
38			$logid = self::logIdFromUUID($uuid);
39			if ($logid == 0) {

OpencachingDeutschland / oc-server3

Push — next ( 5f2bc0...cef70f )

cachelog::getNeedsMaintenance() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like