Localisation updates from http://translatewiki.net.
[mediawiki.git] / maintenance / importImages.inc
blob5ae6d6bec824c0664a3ebf0e755d7bc27da49282
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 <robchur@gmail.com>
23  * @author Mij <mij@bitchx.it>
24  */
26 /**
27  * Search a directory for files with one of a set of extensions
28  *
29  * @param $dir string Path to directory to search
30  * @param $exts Array of extensions to search for
31  * @param $recurse Bool Search subdirectories recursively
32  * @return mixed 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 = array();
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                         return $files;
50                 } else {
51                         return array();
52                 }
53         } else {
54                 return array();
55         }
58 /**
59  * Split a filename into filename and extension
60  *
61  * @param $filename string Filename
62  * @return array
63  */
64 function splitFilename( $filename ) {
65         $parts = explode( '.', $filename );
66         $ext = $parts[ count( $parts ) - 1 ];
67         unset( $parts[ count( $parts ) - 1 ] );
68         $fname = implode( '.', $parts );
69         return array( $fname, $ext );
72 /**
73  * Find an auxilliary file with the given extension, matching
74  * the give base file path. $maxStrip determines how many extensions
75  * may be stripped from the original file name before appending the
76  * new extension. For example, with $maxStrip = 1 (the default),
77  * file files acme.foo.bar.txt and acme.foo.txt would be auxilliary
78  * files for acme.foo.bar and the extension ".txt". With $maxStrip = 2,
79  * acme.txt would also be acceptable.
80  *
81  * @param $file string base path
82  * @param $auxExtension string the extension to be appended to the base path
83  * @param $maxStrip int the maximum number of extensions to strip from the base path (default: 1)
84  * @return string or false
85  */
86 function findAuxFile( $file, $auxExtension, $maxStrip = 1 ) {
87         if ( strpos( $auxExtension, '.' ) !== 0 ) {
88                 $auxExtension = '.' . $auxExtension;
89         }
91         $d = dirname( $file );
92         $n = basename( $file );
94         while ( $maxStrip >= 0 ) {
95                 $f = $d . '/' . $n . $auxExtension;
97                 if ( file_exists( $f ) ) {
98                         return $f;
99                 }
101                 $idx = strrpos( $n, '.' );
102                 if ( !$idx ) {
103                         break;
104                 }
106                 $n = substr( $n, 0, $idx );
107                 $maxStrip -= 1;
108         }
110         return false;
113 # FIXME: Access the api in a saner way and performing just one query (preferably batching files too).
114 function getFileCommentFromSourceWiki( $wiki_host, $file ) {
115         $url = $wiki_host . '/api.php?action=query&format=xml&titles=File:' . rawurlencode( $file ) . '&prop=imageinfo&&iiprop=comment';
116         $body = Http::get( $url );
117         if ( preg_match( '#<ii comment="([^"]*)" />#', $body, $matches ) == 0 ) {
118                 return false;
119         }
121         return html_entity_decode( $matches[1] );
124 function getFileUserFromSourceWiki( $wiki_host, $file ) {
125         $url = $wiki_host . '/api.php?action=query&format=xml&titles=File:' . rawurlencode( $file ) . '&prop=imageinfo&&iiprop=user';
126         $body = Http::get( $url );
127         if ( preg_match( '#<ii user="([^"]*)" />#', $body, $matches ) == 0 ) {
128                 return false;
129         }
131         return html_entity_decode( $matches[1] );