maintenance/importImages.inc

   1 <?php
   2 /**
   3  * Support functions for the importImages 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  */
  25
  26 /**
  27  * Search a directory for files with one of a set of extensions
  28  *
  29  * @param $dir Path to directory to search
  30  * @param $exts Array of extensions to search for
  31  * @return mixed Array of filenames on success, or false on failure
  32  */
  33 function findFiles( $dir, $exts ) {
  34         if ( is_dir( $dir ) ) {
  35                 $dhl = opendir( $dir );
  36                 if ( $dhl ) {
  37                         $files = array();
  38                         while ( ( $file = readdir( $dhl ) ) !== false ) {
  39                                 if ( is_file( $dir . '/' . $file ) ) {
  40                                         list( /* $name */, $ext ) = splitFilename( $dir . '/' . $file );
  41                                         if ( array_search( strtolower( $ext ), $exts ) !== false )
  42                                                 $files[] = $dir . '/' . $file;
  43                                 }
  44                         }
  45                         return $files;
  46                 } else {
  47                         return array();
  48                 }
  49         } else {
  50                 return array();
  51         }
  52 }
  53
  54 /**
  55  * Split a filename into filename and extension
  56  *
  57  * @param $filename string Filename
  58  * @return array
  59  */
  60 function splitFilename( $filename ) {
  61         $parts = explode( '.', $filename );
  62         $ext = $parts[ count( $parts ) - 1 ];
  63         unset( $parts[ count( $parts ) - 1 ] );
  64         $fname = implode( '.', $parts );
  65         return array( $fname, $ext );
  66 }
  67
  68 /**
  69  * Find an auxilliary file with the given extension, matching
  70  * the give base file path. $maxStrip determines how many extensions
  71  * may be stripped from the original file name before appending the
  72  * new extension. For example, with $maxStrip = 1 (the default),
  73  * file files acme.foo.bar.txt and acme.foo.txt would be auxilliary
  74  * files for acme.foo.bar and the extension ".txt". With $maxStrip = 2,
  75  * acme.txt would also be acceptable.
  76  *
  77  * @param $file base path
  78  * @param $auxExtension the extension to be appended to the base path
  79  * @param $maxStrip the maximum number of extensions to strip from the base path (default: 1)
  80  * @return string or false
  81  */
  82 function findAuxFile( $file, $auxExtension, $maxStrip = 1 ) {
  83         if ( strpos( $auxExtension, '.' ) !== 0 ) {
  84                 $auxExtension = '.' . $auxExtension;
  85         }
  86
  87         $d = dirname( $file );
  88         $n = basename( $file );
  89
  90         while ( $maxStrip >= 0 ) {
  91                 $f = $d . '/' . $n . $auxExtension;
  92
  93                 if ( file_exists( $f ) ) {
  94                         return $f;
  95                 }
  96
  97                 $idx = strrpos( $n, '.' );
  98                 if ( !$idx ) break;
  99
 100                 $n = substr( $n, 0, $idx );
 101                 $maxStrip -= 1;
 102         }
 103
 104         return false;
 105 }
 106
 107 # FIXME: Access the api in a saner way and performing just one query (preferably batching files too).
 108 function getFileCommentFromSourceWiki( $wiki_host, $file ) {
 109         $url = $wiki_host . '/api.php?action=query&format=xml&titles=File:' . rawurlencode( $file ) . '&prop=imageinfo&&iiprop=comment';
 110         $body = Http::get( $url );
 111         if ( preg_match( '#<ii comment="([^"]*)" />#', $body, $matches ) == 0 ) {
 112                 return false;
 113         }
 114
 115         return html_entity_decode( $matches[1] );
 116 }
 117
 118 function getFileUserFromSourceWiki( $wiki_host, $file ) {
 119         $url = $wiki_host . '/api.php?action=query&format=xml&titles=File:' . rawurlencode( $file ) . '&prop=imageinfo&&iiprop=user';
 120         $body = Http::get( $url );
 121         if ( preg_match( '#<ii user="([^"]*)" />#', $body, $matches ) == 0 ) {
 122                 return false;
 123         }
 124
 125         return html_entity_decode( $matches[1] );
 126 }
 127