changelog.php ➔ addLogEntry() - Code Metrics - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

changelog.php ➔ addLogEntry() F
last analyzed 2021-06-08 18:02 UTC

↳ Parent: Project

Complexity

Conditions	21
Paths	448

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	21
nc	448
nop	7
dl	0
loc	73
rs	0.7665
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * Changelog handling functions
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <[email protected]>
 */

/**
 * parses a changelog line into it's components
 *
 * @author Ben Coburn <[email protected]>
 *
 * @param string $line changelog line
 * @return array|bool parsed line or false
 */
function parseChangelogLine($line) {
    $line = rtrim($line, "\n");
    $tmp = explode("\t", $line);
    if ($tmp!==false && count($tmp)>1) {
        $info = array();
        $info['date']  = (int)$tmp[0]; // unix timestamp
        $info['ip']    = $tmp[1]; // IPv4 address (127.0.0.1)
        $info['type']  = $tmp[2]; // log line type
        $info['id']    = $tmp[3]; // page id
        $info['user']  = $tmp[4]; // user name
        $info['sum']   = $tmp[5]; // edit summary (or action reason)
        $info['extra'] = $tmp[6]; // extra data (varies by line type)
        if(isset($tmp[7]) && $tmp[7] !== '') { //last item has line-end||
            $info['sizechange'] = (int) $tmp[7];
        } else {
            $info['sizechange'] = null;
        }
        return $info;
    } else {
        return false;
    }
}

/**
 * Adds an entry to the changelog and saves the metadata for the page
 *
 * @param int    $date      Timestamp of the change
 * @param String $id        Name of the affected page
 * @param String $type      Type of the change see DOKU_CHANGE_TYPE_*
 * @param String $summary   Summary of the change
 * @param mixed  $extra     In case of a revert the revision (timestmp) of the reverted page
 * @param array  $flags     Additional flags in a key value array.
 *                             Available flags:
 *                             - ExternalEdit - mark as an external edit.
 * @param null|int $sizechange Change of filesize
 *
 * @author Andreas Gohr <[email protected]>
 * @author Esther Brunner <[email protected]>
 * @author Ben Coburn <[email protected]>
 */
function addLogEntry($date, $id, $type=DOKU_CHANGE_TYPE_EDIT, $summary='', $extra='', $flags=null, $sizechange = null){
    global $conf, $INFO;
    /** @var Input $INPUT */
    global $INPUT;

    // check for special flags as keys
    if (!is_array($flags)) { $flags = array(); }
    $flagExternalEdit = isset($flags['ExternalEdit']);

    $id = cleanid($id);
    $file = wikiFN($id);
    $created = @filectime($file);
    $minor = ($type===DOKU_CHANGE_TYPE_MINOR_EDIT);
    $wasRemoved = ($type===DOKU_CHANGE_TYPE_DELETE);

    if(!$date) $date = time(); //use current time if none supplied
    $remote = (!$flagExternalEdit)?clientIP(true):'127.0.0.1';
    $user   = (!$flagExternalEdit)?$INPUT->server->str('REMOTE_USER'):'';
    if($sizechange === null) {
        $sizechange = '';
    } else {
        $sizechange = (int) $sizechange;
    }

    $strip = array("\t", "\n");
    $logline = array(
        'date'       => $date,
        'ip'         => $remote,
        'type'       => str_replace($strip, '', $type),
        'id'         => $id,
        'user'       => $user,
        'sum'        => \dokuwiki\Utf8\PhpString::substr(str_replace($strip, '', $summary), 0, 255),
        'extra'      => str_replace($strip, '', $extra),
        'sizechange' => $sizechange
    );

    $wasCreated = ($type===DOKU_CHANGE_TYPE_CREATE);
    $wasReverted = ($type===DOKU_CHANGE_TYPE_REVERT);
    // update metadata
    if (!$wasRemoved) {
        $oldmeta = p_read_metadata($id)['persistent'];
        $meta    = array();
        if (
            $wasCreated && (
                empty($oldmeta['date']['created']) ||
                $oldmeta['date']['created'] === $created
            )
        ){
            // newly created
            $meta['date']['created'] = $created;
            if ($user){
                $meta['creator'] = isset($INFO) ? $INFO['userinfo']['name'] : null;
                $meta['user']    = $user;
            }
        } elseif (($wasCreated || $wasReverted) && !empty($oldmeta['date']['created'])) {
            // re-created / restored
            $meta['date']['created']  = $oldmeta['date']['created'];
            $meta['date']['modified'] = $created; // use the files ctime here
            $meta['creator'] = isset($oldmeta['creator']) ? $oldmeta['creator'] : null;
            if ($user) $meta['contributor'][$user] = isset($INFO) ? $INFO['userinfo']['name'] : null;
        } elseif (!$minor) {   // non-minor modification
            $meta['date']['modified'] = $date;
            if ($user) $meta['contributor'][$user] = isset($INFO) ? $INFO['userinfo']['name'] : null;
        }
        $meta['last_change'] = $logline;
        p_set_metadata($id, $meta);
    }

    // add changelog lines
    $logline = implode("\t", $logline)."\n";
    io_saveFile(metaFN($id,'.changes'),$logline,true); //page changelog
    io_saveFile($conf['changelog'],$logline,true); //global changelog cache
}

/**
 * Add's an entry to the media changelog
 *
 * @author Michael Hamann <[email protected]>
 * @author Andreas Gohr <[email protected]>
 * @author Esther Brunner <[email protected]>
 * @author Ben Coburn <[email protected]>
 *
 * @param int    $date      Timestamp of the change
 * @param String $id        Name of the affected page
 * @param String $type      Type of the change see DOKU_CHANGE_TYPE_*
 * @param String $summary   Summary of the change
 * @param mixed  $extra     In case of a revert the revision (timestmp) of the reverted page
 * @param array  $flags     Additional flags in a key value array.
 *                             Available flags:
 *                             - (none, so far)
 * @param null|int $sizechange Change of filesize
 */
function addMediaLogEntry(
    $date,
    $id,
    $type=DOKU_CHANGE_TYPE_EDIT,
    $summary='',
    $extra='',
    $flags=null,

    $sizechange = null)
{
    global $conf;
    /** @var Input $INPUT */
    global $INPUT;

    $id = cleanid($id);

    if(!$date) $date = time(); //use current time if none supplied
    $remote = clientIP(true);
    $user   = $INPUT->server->str('REMOTE_USER');
    if($sizechange === null) {
        $sizechange = '';
    } else {
        $sizechange = (int) $sizechange;
    }

    $strip = array("\t", "\n");
    $logline = array(
        'date'       => $date,
        'ip'         => $remote,
        'type'       => str_replace($strip, '', $type),
        'id'         => $id,
        'user'       => $user,
        'sum'        => \dokuwiki\Utf8\PhpString::substr(str_replace($strip, '', $summary), 0, 255),
        'extra'      => str_replace($strip, '', $extra),
        'sizechange' => $sizechange
    );

    // add changelog lines
    $logline = implode("\t", $logline)."\n";
    io_saveFile($conf['media_changelog'],$logline,true); //global media changelog cache
    io_saveFile(mediaMetaFN($id,'.changes'),$logline,true); //media file's changelog
}

/**
 * returns an array of recently changed files using the
 * changelog
 *
 * The following constants can be used to control which changes are
 * included. Add them together as needed.
 *
 * RECENTS_SKIP_DELETED   - don't include deleted pages
 * RECENTS_SKIP_MINORS    - don't include minor changes
 * RECENTS_ONLY_CREATION  - only include new created pages and media
 * RECENTS_SKIP_SUBSPACES - don't include subspaces
 * RECENTS_MEDIA_CHANGES  - return media changes instead of page changes
 * RECENTS_MEDIA_PAGES_MIXED  - return both media changes and page changes
 *
 * @param int    $first   number of first entry returned (for paginating
 * @param int    $num     return $num entries
 * @param string $ns      restrict to given namespace
 * @param int    $flags   see above
 * @return array recently changed files
 *
 * @author Ben Coburn <[email protected]>
 * @author Kate Arzamastseva <[email protected]>
 */
function getRecents($first,$num,$ns='',$flags=0){
    global $conf;
    $recent = array();
    $count  = 0;

    if(!$num)
        return $recent;

    // read all recent changes. (kept short)
    if ($flags & RECENTS_MEDIA_CHANGES) {
        $lines = @file($conf['media_changelog']) ?: [];
    } else {
        $lines = @file($conf['changelog']) ?: [];
    }
    if (!is_array($lines)) {
        $lines = array();
    }
    $lines_position = count($lines)-1;
    $media_lines_position = 0;
    $media_lines = array();

    if ($flags & RECENTS_MEDIA_PAGES_MIXED) {
        $media_lines = @file($conf['media_changelog']) ?: [];
        if (!is_array($media_lines)) {
            $media_lines = array();
        }
        $media_lines_position = count($media_lines)-1;
    }

    $seen = array(); // caches seen lines, _handleRecent() skips them

    // handle lines
    while ($lines_position >= 0 || (($flags & RECENTS_MEDIA_PAGES_MIXED) && $media_lines_position >=0)) {
        if (empty($rec) && $lines_position >= 0) {
            $rec = _handleRecent(@$lines[$lines_position], $ns, $flags, $seen);
            if (!$rec) {
                $lines_position --;
                continue;
            }
        }
        if (($flags & RECENTS_MEDIA_PAGES_MIXED) && empty($media_rec) && $media_lines_position >= 0) {
            $media_rec = _handleRecent(
                @$media_lines[$media_lines_position],
                $ns,
                $flags | RECENTS_MEDIA_CHANGES,
                $seen
            );
            if (!$media_rec) {
                $media_lines_position --;
                continue;
            }
        }
        if (($flags & RECENTS_MEDIA_PAGES_MIXED) && @$media_rec['date'] >= @$rec['date']) {
            $media_lines_position--;
            $x = $media_rec;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            $x['media'] = true;
            $media_rec = false;
        } else {
            $lines_position--;
            $x = $rec;
            if ($flags & RECENTS_MEDIA_CHANGES) $x['media'] = true;
            $rec = false;
        }
        if(--$first >= 0) continue; // skip first entries
        $recent[] = $x;
        $count++;
        // break when we have enough entries
        if($count >= $num){ break; }
    }
    return $recent;
}

/**
 * returns an array of files changed since a given time using the
 * changelog
 *
 * The following constants can be used to control which changes are
 * included. Add them together as needed.
 *
 * RECENTS_SKIP_DELETED   - don't include deleted pages
 * RECENTS_SKIP_MINORS    - don't include minor changes
 * RECENTS_ONLY_CREATION  - only include new created pages and media
 * RECENTS_SKIP_SUBSPACES - don't include subspaces
 * RECENTS_MEDIA_CHANGES  - return media changes instead of page changes
 *
 * @param int    $from    date of the oldest entry to return
 * @param int    $to      date of the newest entry to return (for pagination, optional)
 * @param string $ns      restrict to given namespace (optional)
 * @param int    $flags   see above (optional)
 * @return array of files
 *
 * @author Michael Hamann <[email protected]>
 * @author Ben Coburn <[email protected]>
 */
function getRecentsSince($from,$to=null,$ns='',$flags=0){
    global $conf;
    $recent = array();

    if($to && $to < $from)
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
        return $recent;

    // read all recent changes. (kept short)
    if ($flags & RECENTS_MEDIA_CHANGES) {
        $lines = @file($conf['media_changelog']);
    } else {
        $lines = @file($conf['changelog']);
    }
    if(!$lines) return $recent;

    // we start searching at the end of the list
    $lines = array_reverse($lines);

    // handle lines
    $seen = array(); // caches seen lines, _handleRecent() skips them

    foreach($lines as $line){
        $rec = _handleRecent($line, $ns, $flags, $seen);
        if($rec !== false) {
            if ($rec['date'] >= $from) {
                if (!$to || $rec['date'] <= $to) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                    $recent[] = $rec;
                }
            } else {
                break;
            }
        }
    }

    return array_reverse($recent);
}

/**
 * Internal function used by getRecents
 *
 * don't call directly
 *
 * @see getRecents()
 * @author Andreas Gohr <[email protected]>
 * @author Ben Coburn <[email protected]>
 *
 * @param string $line   changelog line
 * @param string $ns     restrict to given namespace
 * @param int    $flags  flags to control which changes are included
 * @param array  $seen   listing of seen pages
 * @return array|bool    false or array with info about a change
 */
function _handleRecent($line,$ns,$flags,&$seen){
    if(empty($line)) return false;   //skip empty lines

    // split the line into parts
    $recent = parseChangelogLine($line);
    if ($recent===false) { return false; }

    // skip seen ones
    if(isset($seen[$recent['id']])) return false;

    // skip changes, of only new items are requested
    if($recent['type']!==DOKU_CHANGE_TYPE_CREATE && ($flags & RECENTS_ONLY_CREATION)) return false;

    // skip minors
    if($recent['type']===DOKU_CHANGE_TYPE_MINOR_EDIT && ($flags & RECENTS_SKIP_MINORS)) return false;

    // remember in seen to skip additional sights
    $seen[$recent['id']] = 1;

    // check if it's a hidden page
    if(isHiddenPage($recent['id'])) return false;

    // filter namespace
    if (($ns) && (strpos($recent['id'],$ns.':') !== 0)) return false;

    // exclude subnamespaces
    if (($flags & RECENTS_SKIP_SUBSPACES) && (getNS($recent['id']) != $ns)) return false;

    // check ACL
    if ($flags & RECENTS_MEDIA_CHANGES) {
        $recent['perms'] = auth_quickaclcheck(getNS($recent['id']).':*');
    } else {
        $recent['perms'] = auth_quickaclcheck($recent['id']);
    }
    if ($recent['perms'] < AUTH_READ) return false;

    // check existance
    if($flags & RECENTS_SKIP_DELETED){
        $fn = (($flags & RECENTS_MEDIA_CHANGES) ? mediaFN($recent['id']) : wikiFN($recent['id']));
        if(!file_exists($fn)) return false;
    }

    return $recent;
}


1			<?php
2			/**
3			* Changelog handling functions
4			*
5			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6			* @author Andreas Gohr <[email protected]>
7			*/
8
9			/**
10			* parses a changelog line into it's components
11			*
12			* @author Ben Coburn <[email protected]>
13			*
14			* @param string $line changelog line
15			* @return array\|bool parsed line or false
16			*/
17			function parseChangelogLine($line) {
18			$line = rtrim($line, "\n");
19			$tmp = explode("\t", $line);
20			if ($tmp!==false && count($tmp)>1) {
21			$info = array();
22			$info['date'] = (int)$tmp[0]; // unix timestamp
23			$info['ip'] = $tmp[1]; // IPv4 address (127.0.0.1)
24			$info['type'] = $tmp[2]; // log line type
25			$info['id'] = $tmp[3]; // page id
26			$info['user'] = $tmp[4]; // user name
27			$info['sum'] = $tmp[5]; // edit summary (or action reason)
28			$info['extra'] = $tmp[6]; // extra data (varies by line type)
29			if(isset($tmp[7]) && $tmp[7] !== '') { //last item has line-end\|\|
30			$info['sizechange'] = (int) $tmp[7];
31			} else {
32			$info['sizechange'] = null;
33			}
34			return $info;
35			} else {
36			return false;
37			}
38			}
39
40			/**
41			* Adds an entry to the changelog and saves the metadata for the page
42			*
43			* @param int $date Timestamp of the change
44			* @param String $id Name of the affected page
45			* @param String $type Type of the change see DOKU_CHANGE_TYPE_*
46			* @param String $summary Summary of the change
47			* @param mixed $extra In case of a revert the revision (timestmp) of the reverted page
48			* @param array $flags Additional flags in a key value array.
49			* Available flags:
50			* - ExternalEdit - mark as an external edit.
51			* @param null\|int $sizechange Change of filesize
52			*
53			* @author Andreas Gohr <[email protected]>
54			* @author Esther Brunner <[email protected]>
55			* @author Ben Coburn <[email protected]>
56			*/
57			function addLogEntry($date, $id, $type=DOKU_CHANGE_TYPE_EDIT, $summary='', $extra='', $flags=null, $sizechange = null){
58			global $conf, $INFO;
59			/** @var Input $INPUT */
60			global $INPUT;
61
62			// check for special flags as keys
63			if (!is_array($flags)) { $flags = array(); }
64			$flagExternalEdit = isset($flags['ExternalEdit']);
65
66			$id = cleanid($id);
67			$file = wikiFN($id);
68			$created = @filectime($file);
69			$minor = ($type===DOKU_CHANGE_TYPE_MINOR_EDIT);
70			$wasRemoved = ($type===DOKU_CHANGE_TYPE_DELETE);
71
72			if(!$date) $date = time(); //use current time if none supplied
73			$remote = (!$flagExternalEdit)?clientIP(true):'127.0.0.1';
74			$user = (!$flagExternalEdit)?$INPUT->server->str('REMOTE_USER'):'';
75			if($sizechange === null) {
76			$sizechange = '';
77			} else {
78			$sizechange = (int) $sizechange;
79			}
80
81			$strip = array("\t", "\n");
82			$logline = array(
83			'date' => $date,
84			'ip' => $remote,
85			'type' => str_replace($strip, '', $type),
86			'id' => $id,
87			'user' => $user,
88			'sum' => \dokuwiki\Utf8\PhpString::substr(str_replace($strip, '', $summary), 0, 255),
89			'extra' => str_replace($strip, '', $extra),
90			'sizechange' => $sizechange
91			);
92
93			$wasCreated = ($type===DOKU_CHANGE_TYPE_CREATE);
94			$wasReverted = ($type===DOKU_CHANGE_TYPE_REVERT);
95			// update metadata
96			if (!$wasRemoved) {
97			$oldmeta = p_read_metadata($id)['persistent'];
98			$meta = array();
99			if (
100			$wasCreated && (
101			empty($oldmeta['date']['created']) \|\|
102			$oldmeta['date']['created'] === $created
103			)
104			){
105			// newly created
106			$meta['date']['created'] = $created;
107			if ($user){
108			$meta['creator'] = isset($INFO) ? $INFO['userinfo']['name'] : null;
109			$meta['user'] = $user;
110			}
111			} elseif (($wasCreated \|\| $wasReverted) && !empty($oldmeta['date']['created'])) {
112			// re-created / restored
113			$meta['date']['created'] = $oldmeta['date']['created'];
114			$meta['date']['modified'] = $created; // use the files ctime here
115			$meta['creator'] = isset($oldmeta['creator']) ? $oldmeta['creator'] : null;
116			if ($user) $meta['contributor'][$user] = isset($INFO) ? $INFO['userinfo']['name'] : null;
117			} elseif (!$minor) { // non-minor modification
118			$meta['date']['modified'] = $date;
119			if ($user) $meta['contributor'][$user] = isset($INFO) ? $INFO['userinfo']['name'] : null;
120			}
121			$meta['last_change'] = $logline;
122			p_set_metadata($id, $meta);
123			}
124
125			// add changelog lines
126			$logline = implode("\t", $logline)."\n";
127			io_saveFile(metaFN($id,'.changes'),$logline,true); //page changelog
128			io_saveFile($conf['changelog'],$logline,true); //global changelog cache
129			}
130
131			/**
132			* Add's an entry to the media changelog
133			*
134			* @author Michael Hamann <[email protected]>
135			* @author Andreas Gohr <[email protected]>
136			* @author Esther Brunner <[email protected]>
137			* @author Ben Coburn <[email protected]>
138			*
139			* @param int $date Timestamp of the change
140			* @param String $id Name of the affected page
141			* @param String $type Type of the change see DOKU_CHANGE_TYPE_*
142			* @param String $summary Summary of the change
143			* @param mixed $extra In case of a revert the revision (timestmp) of the reverted page
144			* @param array $flags Additional flags in a key value array.
145			* Available flags:
146			* - (none, so far)
147			* @param null\|int $sizechange Change of filesize
148			*/
149			function addMediaLogEntry(
150			$date,
151			$id,
152			$type=DOKU_CHANGE_TYPE_EDIT,
153			$summary='',
154			$extra='',
155			$flags=null,
			0 ignored issues – show Unused Code introduced 2018-04-27 17:13 UTC by Report Bug Copy Issue Report The parameter `$flags` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
156			$sizechange = null)
157			{
158			global $conf;
159			/** @var Input $INPUT */
160			global $INPUT;
161
162			$id = cleanid($id);
163
164			if(!$date) $date = time(); //use current time if none supplied
165			$remote = clientIP(true);
166			$user = $INPUT->server->str('REMOTE_USER');
167			if($sizechange === null) {
168			$sizechange = '';
169			} else {
170			$sizechange = (int) $sizechange;
171			}
172
173			$strip = array("\t", "\n");
174			$logline = array(
175			'date' => $date,
176			'ip' => $remote,
177			'type' => str_replace($strip, '', $type),
178			'id' => $id,
179			'user' => $user,
180			'sum' => \dokuwiki\Utf8\PhpString::substr(str_replace($strip, '', $summary), 0, 255),
181			'extra' => str_replace($strip, '', $extra),
182			'sizechange' => $sizechange
183			);
184
185			// add changelog lines
186			$logline = implode("\t", $logline)."\n";
187			io_saveFile($conf['media_changelog'],$logline,true); //global media changelog cache
188			io_saveFile(mediaMetaFN($id,'.changes'),$logline,true); //media file's changelog
189			}
190
191			/**
192			* returns an array of recently changed files using the
193			* changelog
194			*
195			* The following constants can be used to control which changes are
196			* included. Add them together as needed.
197			*
198			* RECENTS_SKIP_DELETED - don't include deleted pages
199			* RECENTS_SKIP_MINORS - don't include minor changes
200			* RECENTS_ONLY_CREATION - only include new created pages and media
201			* RECENTS_SKIP_SUBSPACES - don't include subspaces
202			* RECENTS_MEDIA_CHANGES - return media changes instead of page changes
203			* RECENTS_MEDIA_PAGES_MIXED - return both media changes and page changes
204			*
205			* @param int $first number of first entry returned (for paginating
206			* @param int $num return $num entries
207			* @param string $ns restrict to given namespace
208			* @param int $flags see above
209			* @return array recently changed files
210			*
211			* @author Ben Coburn <[email protected]>
212			* @author Kate Arzamastseva <[email protected]>
213			*/
214			function getRecents($first,$num,$ns='',$flags=0){
215			global $conf;
216			$recent = array();
217			$count = 0;
218
219			if(!$num)
220			return $recent;
221
222			// read all recent changes. (kept short)
223			if ($flags & RECENTS_MEDIA_CHANGES) {
224			$lines = @file($conf['media_changelog']) ?: [];
225			} else {
226			$lines = @file($conf['changelog']) ?: [];
227			}
228			if (!is_array($lines)) {
229			$lines = array();
230			}
231			$lines_position = count($lines)-1;
232			$media_lines_position = 0;
233			$media_lines = array();
234
235			if ($flags & RECENTS_MEDIA_PAGES_MIXED) {
236			$media_lines = @file($conf['media_changelog']) ?: [];
237			if (!is_array($media_lines)) {
238			$media_lines = array();
239			}
240			$media_lines_position = count($media_lines)-1;
241			}
242
243			$seen = array(); // caches seen lines, _handleRecent() skips them
244
245			// handle lines
246			while ($lines_position >= 0 \|\| (($flags & RECENTS_MEDIA_PAGES_MIXED) && $media_lines_position >=0)) {
247			if (empty($rec) && $lines_position >= 0) {
248			$rec = _handleRecent(@$lines[$lines_position], $ns, $flags, $seen);
249			if (!$rec) {
250			$lines_position --;
251			continue;
252			}
253			}
254			if (($flags & RECENTS_MEDIA_PAGES_MIXED) && empty($media_rec) && $media_lines_position >= 0) {
255			$media_rec = _handleRecent(
256			@$media_lines[$media_lines_position],
257			$ns,
258			$flags \| RECENTS_MEDIA_CHANGES,
259			$seen
260			);
261			if (!$media_rec) {
262			$media_lines_position --;
263			continue;
264			}
265			}
266			if (($flags & RECENTS_MEDIA_PAGES_MIXED) && @$media_rec['date'] >= @$rec['date']) {
267			$media_lines_position--;
268			$x = $media_rec;
			0 ignored issues – show Bug introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report The variable `$media_rec` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
269			$x['media'] = true;
270			$media_rec = false;
271			} else {
272			$lines_position--;
273			$x = $rec;
274			if ($flags & RECENTS_MEDIA_CHANGES) $x['media'] = true;
275			$rec = false;
276			}
277			if(--$first >= 0) continue; // skip first entries
278			$recent[] = $x;
279			$count++;
280			// break when we have enough entries
281			if($count >= $num){ break; }
282			}
283			return $recent;
284			}
285
286			/**
287			* returns an array of files changed since a given time using the
288			* changelog
289			*
290			* The following constants can be used to control which changes are
291			* included. Add them together as needed.
292			*
293			* RECENTS_SKIP_DELETED - don't include deleted pages
294			* RECENTS_SKIP_MINORS - don't include minor changes
295			* RECENTS_ONLY_CREATION - only include new created pages and media
296			* RECENTS_SKIP_SUBSPACES - don't include subspaces
297			* RECENTS_MEDIA_CHANGES - return media changes instead of page changes
298			*
299			* @param int $from date of the oldest entry to return
300			* @param int $to date of the newest entry to return (for pagination, optional)
301			* @param string $ns restrict to given namespace (optional)
302			* @param int $flags see above (optional)
303			* @return array of files
304			*
305			* @author Michael Hamann <[email protected]>
306			* @author Ben Coburn <[email protected]>
307			*/
308			function getRecentsSince($from,$to=null,$ns='',$flags=0){
309			global $conf;
310			$recent = array();
311
312			if($to && $to < $from)
			0 ignored issues – show Bug Best Practice introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report The expression `$to` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
313			return $recent;
314
315			// read all recent changes. (kept short)
316			if ($flags & RECENTS_MEDIA_CHANGES) {
317			$lines = @file($conf['media_changelog']);
318			} else {
319			$lines = @file($conf['changelog']);
320			}
321			if(!$lines) return $recent;
322
323			// we start searching at the end of the list
324			$lines = array_reverse($lines);
325
326			// handle lines
327			$seen = array(); // caches seen lines, _handleRecent() skips them
328
329			foreach($lines as $line){
330			$rec = _handleRecent($line, $ns, $flags, $seen);
331			if($rec !== false) {
332			if ($rec['date'] >= $from) {
333			if (!$to \|\| $rec['date'] <= $to) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-25 07:06 UTC by Report Bug Copy Issue Report The expression `$to` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
334			$recent[] = $rec;
335			}
336			} else {
337			break;
338			}
339			}
340			}
341
342			return array_reverse($recent);
343			}
344
345			/**
346			* Internal function used by getRecents
347			*
348			* don't call directly
349			*
350			* @see getRecents()
351			* @author Andreas Gohr <[email protected]>
352			* @author Ben Coburn <[email protected]>
353			*
354			* @param string $line changelog line
355			* @param string $ns restrict to given namespace
356			* @param int $flags flags to control which changes are included
357			* @param array $seen listing of seen pages
358			* @return array\|bool false or array with info about a change
359			*/
360			function _handleRecent($line,$ns,$flags,&$seen){
361			if(empty($line)) return false; //skip empty lines
362
363			// split the line into parts
364			$recent = parseChangelogLine($line);
365			if ($recent===false) { return false; }
366
367			// skip seen ones
368			if(isset($seen[$recent['id']])) return false;
369
370			// skip changes, of only new items are requested
371			if($recent['type']!==DOKU_CHANGE_TYPE_CREATE && ($flags & RECENTS_ONLY_CREATION)) return false;
372
373			// skip minors
374			if($recent['type']===DOKU_CHANGE_TYPE_MINOR_EDIT && ($flags & RECENTS_SKIP_MINORS)) return false;
375
376			// remember in seen to skip additional sights
377			$seen[$recent['id']] = 1;
378
379			// check if it's a hidden page
380			if(isHiddenPage($recent['id'])) return false;
381
382			// filter namespace
383			if (($ns) && (strpos($recent['id'],$ns.':') !== 0)) return false;
384
385			// exclude subnamespaces
386			if (($flags & RECENTS_SKIP_SUBSPACES) && (getNS($recent['id']) != $ns)) return false;
387
388			// check ACL
389			if ($flags & RECENTS_MEDIA_CHANGES) {
390			$recent['perms'] = auth_quickaclcheck(getNS($recent['id']).':*');
391			} else {
392			$recent['perms'] = auth_quickaclcheck($recent['id']);
393			}
394			if ($recent['perms'] < AUTH_READ) return false;
395
396			// check existance
397			if($flags & RECENTS_SKIP_DELETED){
398			$fn = (($flags & RECENTS_MEDIA_CHANGES) ? mediaFN($recent['id']) : wikiFN($recent['id']));
399			if(!file_exists($fn)) return false;
400			}
401
402			return $recent;
403			}
404

splitbrain / dokuwiki

changelog.php ➔ addLogEntry() F last analyzed 2021-06-08 18:02 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like

changelog.php ➔ addLogEntry() F
last analyzed 2021-06-08 18:02 UTC