maintenance/importImages.inc::findAuxFile()   B
last analyzed

Complexity

Conditions 5
Paths 8

Size

Total Lines 26
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
eloc 15
nc 8
nop 3
dl 0
loc 26
rs 8.439
c 0
b 0
f 0
1
<?php
2
/**
3
 * Support functions for the importImages.php script
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of the GNU General Public License as published by
7
 * the Free Software Foundation; either version 2 of the License, or
8
 * (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License along
16
 * with this program; if not, write to the Free Software Foundation, Inc.,
17
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
 * http://www.gnu.org/copyleft/gpl.html
19
 *
20
 * @file
21
 * @ingroup Maintenance
22
 * @author Rob Church <[email protected]>
23
 * @author Mij <[email protected]>
24
 */
25
26
/**
27
 * Search a directory for files with one of a set of extensions
28
 *
29
 * @param string $dir Path to directory to search
30
 * @param array $exts Array of extensions to search for
31
 * @param bool $recurse Search subdirectories recursively
32
 * @return array|bool Array of filenames on success, or false on failure
33
 */
34
function findFiles( $dir, $exts, $recurse = false ) {
35
	if ( is_dir( $dir ) ) {
36
		$dhl = opendir( $dir );
37
		if ( $dhl ) {
38
			$files = [];
39
			while ( ( $file = readdir( $dhl ) ) !== false ) {
40
				if ( is_file( $dir . '/' . $file ) ) {
41
					list( /* $name */, $ext ) = splitFilename( $dir . '/' . $file );
42
					if ( array_search( strtolower( $ext ), $exts ) !== false ) {
43
						$files[] = $dir . '/' . $file;
44
					}
45
				} elseif ( $recurse && is_dir( $dir . '/' . $file ) && $file !== '..' && $file !== '.' ) {
46
					$files = array_merge( $files, findFiles( $dir . '/' . $file, $exts, true ) );
47
				}
48
			}
49
50
			return $files;
51
		} else {
52
			return [];
53
		}
54
	} else {
55
		return [];
56
	}
57
}
58
59
/**
60
 * Split a filename into filename and extension
61
 *
62
 * @param string $filename Filename
63
 * @return array
64
 */
65
function splitFilename( $filename ) {
66
	$parts = explode( '.', $filename );
67
	$ext = $parts[count( $parts ) - 1];
68
	unset( $parts[count( $parts ) - 1] );
69
	$fname = implode( '.', $parts );
70
71
	return [ $fname, $ext ];
72
}
73
74
/**
75
 * Find an auxilliary file with the given extension, matching
76
 * the give base file path. $maxStrip determines how many extensions
77
 * may be stripped from the original file name before appending the
78
 * new extension. For example, with $maxStrip = 1 (the default),
79
 * file files acme.foo.bar.txt and acme.foo.txt would be auxilliary
80
 * files for acme.foo.bar and the extension ".txt". With $maxStrip = 2,
81
 * acme.txt would also be acceptable.
82
 *
83
 * @param string $file Base path
84
 * @param string $auxExtension The extension to be appended to the base path
85
 * @param int $maxStrip The maximum number of extensions to strip from the base path (default: 1)
86
 * @return string|bool
87
 */
88
function findAuxFile( $file, $auxExtension, $maxStrip = 1 ) {
89
	if ( strpos( $auxExtension, '.' ) !== 0 ) {
90
		$auxExtension = '.' . $auxExtension;
91
	}
92
93
	$d = dirname( $file );
94
	$n = basename( $file );
95
96
	while ( $maxStrip >= 0 ) {
97
		$f = $d . '/' . $n . $auxExtension;
98
99
		if ( file_exists( $f ) ) {
100
			return $f;
101
		}
102
103
		$idx = strrpos( $n, '.' );
104
		if ( !$idx ) {
105
			break;
106
		}
107
108
		$n = substr( $n, 0, $idx );
109
		$maxStrip -= 1;
110
	}
111
112
	return false;
113
}
114
115
# @todo FIXME: Access the api in a saner way and performing just one query
116
# (preferably batching files too).
117 View Code Duplication
function getFileCommentFromSourceWiki( $wiki_host, $file ) {
0 ignored issues
show
Duplication introduced by
This function seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
118
	$url = $wiki_host . '/api.php?action=query&format=xml&titles=File:'
119
		. rawurlencode( $file ) . '&prop=imageinfo&&iiprop=comment';
120
	$body = Http::get( $url, [], __METHOD__ );
121
	if ( preg_match( '#<ii comment="([^"]*)" />#', $body, $matches ) == 0 ) {
122
		return false;
123
	}
124
125
	return html_entity_decode( $matches[1] );
126
}
127
128 View Code Duplication
function getFileUserFromSourceWiki( $wiki_host, $file ) {
0 ignored issues
show
Duplication introduced by
This function seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
129
	$url = $wiki_host . '/api.php?action=query&format=xml&titles=File:'
130
		. rawurlencode( $file ) . '&prop=imageinfo&&iiprop=user';
131
	$body = Http::get( $url, [], __METHOD__ );
132
	if ( preg_match( '#<ii user="([^"]*)" />#', $body, $matches ) == 0 ) {
133
		return false;
134
	}
135
136
	return html_entity_decode( $matches[1] );
137
}
138