CacheWayPointPool::fill() - Code Metrics - Inspection of "Merge pull request #705 from nlubisch/feature/move..." - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( f93eb8...ffa1a0 )

by Thomas

created 2017-11-26 19:47 UTC

CacheWayPointPool::fill() B

↳ Parent: CacheWayPointPool

Complexity

Conditions	6
Paths	12

Size

Total Lines	56
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	24
nc	12
nop	1
dl	0
loc	56
rs	8.7592
c	0
b	0
f	0

How to fix Long Method

<?php
/***************************************************************************
 * for license information see LICENSE.md
 *
 *
 *  This cronjob fills the table cache_waypoint_pool with waypoints that
 *  can be assigned to new caches. The code is cpu intensive on database
 *  server.
 ***************************************************************************/

checkJob(new CacheWayPointPool());

class CacheWayPointPool
namespace YourVendor;

class YourClass { }
{
    public $name = 'cache_waypoint_pool';
    public $interval = 604800; // once a week

    public function run()
    {
        global $opt;
        $nLastInsertsCount = 1;

        // check if the pool needs to be filled up and repeat until the
        $nPoolSize = $this->getCurrentPoolSize();
        if ($nPoolSize < $opt['logic']['waypoint_pool']['min_count']) {
            while (($nPoolSize < $opt['logic']['waypoint_pool']['max_count']) && ($nLastInsertsCount > 0)) {
                $nLastInsertsCount = $this->fill($opt['logic']['waypoint_pool']['max_count'] - $nPoolSize);
                $nPoolSize = $this->getCurrentPoolSize();
            }
        }
    }

    public function getCurrentPoolSize()
    {
        return sql_value('SELECT COUNT(*) FROM `cache_waypoint_pool`', 0);

    }

    public function fill($max_inserts_count)
    {
        global $opt;

        $rowCount = 0;
        $nInsertCount = 0;

        if ($opt['logic']['waypoint_pool']['fill_gaps'] === true) {
            // query the first unused waypoint (between other waypoints)
            $rsStartWp = sql(

                "SELECT SQL_BUFFER_RESULT DECTOWP(WPTODEC(`c`.`wp_oc`, '&1')+1, '&1') AS `free_wp`
                               FROM `caches` AS `c`
                          LEFT JOIN `caches` AS `cNext` ON DECTOWP(WPTODEC(`c`.`wp_oc`, '&1')+1, '&1')=`cNext`.`wp_oc`
                          LEFT JOIN `cache_waypoint_pool` ON DECTOWP(WPTODEC(`c`.`wp_oc` ,'&1')+1, '&1')=`cache_waypoint_pool`.`wp_oc`
                              WHERE `c`.`wp_oc` REGEXP '&2'
                                AND ISNULL(`cNext`.`wp_oc`)
                                AND ISNULL(`cache_waypoint_pool`.`wp_oc`)
                           ORDER BY `free_wp` ASC
                              LIMIT 250",
                $opt['logic']['waypoint_pool']['prefix'],
                '^' . $opt['logic']['waypoint_pool']['prefix'] . '[' . $opt['logic']['waypoint_pool']['valid_chars'] . ']{1,}$'
            );
        } else {
            // query the last used waypoint
            $rsStartWp = sql(

                "SELECT SQL_BUFFER_RESULT DECTOWP(MAX(dec_wp)+1, '&2') AS `free_wp`
                           FROM (
                                   SELECT MAX(WPTODEC(`wp_oc`, '&2')) AS dec_wp
                                     FROM `caches`
                                    WHERE `wp_oc` REGEXP '&1'
                              UNION
                                   SELECT MAX(WPTODEC(`wp_oc`, '&2')) AS dec_wp
                                     FROM `cache_waypoint_pool`
                                 ) AS tbl",
                '^' . $opt['logic']['waypoint_pool']['prefix'] . '[' . $opt['logic']['waypoint_pool']['valid_chars'] . ']{1,}$',
                $opt['logic']['waypoint_pool']['prefix']
            );
        }

        while (($rStartWp = sql_fetch_assoc($rsStartWp)) && ($nInsertCount < $max_inserts_count)) {

            $free_wp = $rStartWp['free_wp'];
            if ($free_wp == '') {
                $free_wp = $opt['logic']['waypoint_pool']['prefix'] . '0001';
            }
            $nInsertCount += $this->fillTurn($free_wp, $max_inserts_count - $nInsertCount);
            $rowCount++;
        }
        sql_free_result($rsStartWp);


        if ($rowCount == 0) {
            // new database ...
            $nInsertCount += $this->fillTurn($opt['logic']['waypoint_pool']['prefix'] . '0001', $max_inserts_count);
        }

        return $nInsertCount;
    }

    // search for the next free range and use that waypoints to fill the waypoint pool
    public function fillTurn($start_wp, $max_inserts_count)
    {
        global $opt;

        // query the end of this waypoint range
        $end_wp = sql_value(

            "SELECT DECTOWP(MIN(dec_wp), '&3')
                           FROM (
                                   SELECT MIN(WPTODEC(`wp_oc`, '&3')) AS dec_wp
                                     FROM `caches`
                                    WHERE WPTODEC(`wp_oc`, '&3')>WPTODEC('&1', '&3')
                                      AND `wp_oc` REGEXP '&2'
                              UNION
                                   SELECT MIN(WPTODEC(`wp_oc`, '&3')) AS dec_wp
                                     FROM `cache_waypoint_pool`
                                    WHERE WPTODEC(`wp_oc`, '&3')>WPTODEC('&1', '&3')
                                 ) AS tbl",
            $opt['logic']['waypoint_pool']['prefix'] . '100000',
            $start_wp,
            '^' . $opt['logic']['waypoint_pool']['prefix'] . '[' . $opt['logic']['waypoint_pool']['valid_chars'] . ']{1,}$',
            $opt['logic']['waypoint_pool']['prefix']
        );

        // now, we have start and end waypoints ...
        $nWaypointsGenerated = 0;
        while (($nWaypointsGenerated < $max_inserts_count) && ($start_wp != $end_wp)) {
            sql("INSERT INTO `cache_waypoint_pool` (`wp_oc`) VALUES ('&1')", $start_wp);

            $nWaypointsGenerated++;
            $start_wp = $this->incrementWayPoint($start_wp, $opt['logic']['waypoint_pool']['prefix']);
        }

        return $nWaypointsGenerated;
    }

    // see mysql functions in doc/sql/stored-proc/maintain.php for explanation
    public function incrementWayPoint($wp, $prefix)
    {
        global $opt;

        $wp_chars = $opt['logic']['waypoint_pool']['valid_chars'];
        $b36_chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';

        if (substr($wp, 0, 2) != $prefix) {
            return '';
        }

        $wp_value = substr($wp, 2);
        $b36_value = '';
        $wpValueLen = strlen($wp_value);
        for ($i = 0; $i < $wpValueLen; $i++) {
            $b36_value .= substr($b36_chars, strpos($wp_chars, substr($wp_value, $i, 1)), 1);
        }

        $dec_value = base_convert($b36_value, strlen($wp_chars), 10) + 1;
        $b36_value = strtoupper(base_convert($dec_value, 10, strlen($wp_chars)));

        $wp_value = '';
        $b36ValueLen = strlen($b36_value);
        for ($i = 0; $i < $b36ValueLen; $i++) {
            $wp_value .= substr($wp_chars, strpos($b36_chars, substr($b36_value, $i, 1)), 1);
        }

        if (strlen($wp_value) < 4) {
            return $prefix . substr('0000' . $wp_value, - 4);
        }

        return $prefix . $wp_value;
    }
}


1		<?php
2		/***************************************************************************
3		* for license information see LICENSE.md
4		*
5		*
6		* This cronjob fills the table cache_waypoint_pool with waypoints that
7		* can be assigned to new caches. The code is cpu intensive on database
8		* server.
9		***************************************************************************/
10
11		checkJob(new CacheWayPointPool());
12
13		class CacheWayPointPool
		0 ignored issues – show Coding Style Compatibility introduced 2016-05-24 20:56 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
14		{
15		public $name = 'cache_waypoint_pool';
16		public $interval = 604800; // once a week
17
18		public function run()
19		{
20		global $opt;
21		$nLastInsertsCount = 1;
22
23		// check if the pool needs to be filled up and repeat until the
24		$nPoolSize = $this->getCurrentPoolSize();
25		if ($nPoolSize < $opt['logic']['waypoint_pool']['min_count']) {
26		while (($nPoolSize < $opt['logic']['waypoint_pool']['max_count']) && ($nLastInsertsCount > 0)) {
27		$nLastInsertsCount = $this->fill($opt['logic']['waypoint_pool']['max_count'] - $nPoolSize);
28		$nPoolSize = $this->getCurrentPoolSize();
29		}
30		}
31		}
32
33		public function getCurrentPoolSize()
34		{
35		return sql_value('SELECT COUNT(*) FROM `cache_waypoint_pool`', 0);
		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...
36		}
37
38		public function fill($max_inserts_count)
39		{
40		global $opt;
41
42		$rowCount = 0;
43		$nInsertCount = 0;
44
45		if ($opt['logic']['waypoint_pool']['fill_gaps'] === true) {
46		// query the first unused waypoint (between other waypoints)
47		$rsStartWp = sql(
		0 ignored issues – show Deprecated Code introduced 2017-10-17 14:32 UTC by Report Bug Copy Issue Report The function `sql()` 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...
48		"SELECT SQL_BUFFER_RESULT DECTOWP(WPTODEC(`c`.`wp_oc`, '&1')+1, '&1') AS `free_wp`
49		FROM `caches` AS `c`
50		LEFT JOIN `caches` AS `cNext` ON DECTOWP(WPTODEC(`c`.`wp_oc`, '&1')+1, '&1')=`cNext`.`wp_oc`
51		LEFT JOIN `cache_waypoint_pool` ON DECTOWP(WPTODEC(`c`.`wp_oc` ,'&1')+1, '&1')=`cache_waypoint_pool`.`wp_oc`
52		WHERE `c`.`wp_oc` REGEXP '&2'
53		AND ISNULL(`cNext`.`wp_oc`)
54		AND ISNULL(`cache_waypoint_pool`.`wp_oc`)
55		ORDER BY `free_wp` ASC
56		LIMIT 250",
57		$opt['logic']['waypoint_pool']['prefix'],
58		'^' . $opt['logic']['waypoint_pool']['prefix'] . '[' . $opt['logic']['waypoint_pool']['valid_chars'] . ']{1,}$'
59		);
60		} else {
61		// query the last used waypoint
62		$rsStartWp = sql(
		0 ignored issues – show Deprecated Code introduced 2017-10-17 14:32 UTC by Report Bug Copy Issue Report The function `sql()` 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...
63		"SELECT SQL_BUFFER_RESULT DECTOWP(MAX(dec_wp)+1, '&2') AS `free_wp`
64		FROM (
65		SELECT MAX(WPTODEC(`wp_oc`, '&2')) AS dec_wp
66		FROM `caches`
67		WHERE `wp_oc` REGEXP '&1'
68		UNION
69		SELECT MAX(WPTODEC(`wp_oc`, '&2')) AS dec_wp
70		FROM `cache_waypoint_pool`
71		) AS tbl",
72		'^' . $opt['logic']['waypoint_pool']['prefix'] . '[' . $opt['logic']['waypoint_pool']['valid_chars'] . ']{1,}$',
73		$opt['logic']['waypoint_pool']['prefix']
74		);
75		}
76
77		while (($rStartWp = sql_fetch_assoc($rsStartWp)) && ($nInsertCount < $max_inserts_count)) {
		0 ignored issues – show Deprecated Code introduced 2017-10-17 14:32 UTC by Report Bug Copy Issue Report The function `sql_fetch_assoc()` 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...
78		$free_wp = $rStartWp['free_wp'];
79		if ($free_wp == '') {
80		$free_wp = $opt['logic']['waypoint_pool']['prefix'] . '0001';
81		}
82		$nInsertCount += $this->fillTurn($free_wp, $max_inserts_count - $nInsertCount);
83		$rowCount++;
84		}
85		sql_free_result($rsStartWp);
		0 ignored issues – show Deprecated Code introduced 2017-10-17 14:32 UTC by Report Bug Copy Issue Report The function `sql_free_result()` 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...
86
87		if ($rowCount == 0) {
88		// new database ...
89		$nInsertCount += $this->fillTurn($opt['logic']['waypoint_pool']['prefix'] . '0001', $max_inserts_count);
90		}
91
92		return $nInsertCount;
93		}
94
95		// search for the next free range and use that waypoints to fill the waypoint pool
96		public function fillTurn($start_wp, $max_inserts_count)
97		{
98		global $opt;
99
100		// query the end of this waypoint range
101		$end_wp = sql_value(
		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...
102		"SELECT DECTOWP(MIN(dec_wp), '&3')
103		FROM (
104		SELECT MIN(WPTODEC(`wp_oc`, '&3')) AS dec_wp
105		FROM `caches`
106		WHERE WPTODEC(`wp_oc`, '&3')>WPTODEC('&1', '&3')
107		AND `wp_oc` REGEXP '&2'
108		UNION
109		SELECT MIN(WPTODEC(`wp_oc`, '&3')) AS dec_wp
110		FROM `cache_waypoint_pool`
111		WHERE WPTODEC(`wp_oc`, '&3')>WPTODEC('&1', '&3')
112		) AS tbl",
113		$opt['logic']['waypoint_pool']['prefix'] . '100000',
114		$start_wp,
115		'^' . $opt['logic']['waypoint_pool']['prefix'] . '[' . $opt['logic']['waypoint_pool']['valid_chars'] . ']{1,}$',
116		$opt['logic']['waypoint_pool']['prefix']
117		);
118
119		// now, we have start and end waypoints ...
120		$nWaypointsGenerated = 0;
121		while (($nWaypointsGenerated < $max_inserts_count) && ($start_wp != $end_wp)) {
122		sql("INSERT INTO `cache_waypoint_pool` (`wp_oc`) VALUES ('&1')", $start_wp);
		0 ignored issues – show Deprecated Code introduced 2017-10-17 14:32 UTC by Report Bug Copy Issue Report The function `sql()` 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...
123		$nWaypointsGenerated++;
124		$start_wp = $this->incrementWayPoint($start_wp, $opt['logic']['waypoint_pool']['prefix']);
125		}
126
127		return $nWaypointsGenerated;
128		}
129
130		// see mysql functions in doc/sql/stored-proc/maintain.php for explanation
131		public function incrementWayPoint($wp, $prefix)
132		{
133		global $opt;
134
135		$wp_chars = $opt['logic']['waypoint_pool']['valid_chars'];
136		$b36_chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
137
138		if (substr($wp, 0, 2) != $prefix) {
139		return '';
140		}
141
142		$wp_value = substr($wp, 2);
143		$b36_value = '';
144		$wpValueLen = strlen($wp_value);
145	View Code Duplication	for ($i = 0; $i < $wpValueLen; $i++) {
146		$b36_value .= substr($b36_chars, strpos($wp_chars, substr($wp_value, $i, 1)), 1);
147		}
148
149		$dec_value = base_convert($b36_value, strlen($wp_chars), 10) + 1;
150		$b36_value = strtoupper(base_convert($dec_value, 10, strlen($wp_chars)));
151
152		$wp_value = '';
153		$b36ValueLen = strlen($b36_value);
154	View Code Duplication	for ($i = 0; $i < $b36ValueLen; $i++) {
155		$wp_value .= substr($wp_chars, strpos($b36_chars, substr($b36_value, $i, 1)), 1);
156		}
157
158		if (strlen($wp_value) < 4) {
159		return $prefix . substr('0000' . $wp_value, - 4);
160		}
161
162		return $prefix . $wp_value;
163		}
164		}
165

OpencachingDeutschland / oc-server3

Push — development ( f93eb8...ffa1a0 )

CacheWayPointPool::fill() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like