1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
<?php
/**
* Handler for the Gimp's native file format (XCF)
*
* Overview:
* http://en.wikipedia.org/wiki/XCF_(file_format)
* Specification in Gnome repository:
* http://svn.gnome.org/viewvc/gimp/trunk/devel-docs/xcf.txt?view=markup
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Media
*/
/**
* Handler for the Gimp's native file format; getimagesize() doesn't
* support these files
*
* @ingroup Media
*/
class XCFHandler extends BitmapHandler {
/**
* @param File $file
* @return bool
*/
function mustRender( $file ) {
return true;
}
/**
* Render files as PNG
*
* @param string $ext
* @param string $mime
* @param array $params
* @return array
*/
function getThumbType( $ext, $mime, $params = null ) {
return array( 'png', 'image/png' );
}
/**
* Get width and height from the XCF header.
*
* @param File $image
* @param string $filename
* @return array
*/
function getImageSize( $image, $filename ) {
$header = self::getXCFMetaData( $filename );
if ( !$header ) {
return false;
}
# Forge a return array containing metadata information just like getimagesize()
# See PHP documentation at: http://www.php.net/getimagesize
$metadata = array();
$metadata[0] = $header['width'];
$metadata[1] = $header['height'];
$metadata[2] = null; # IMAGETYPE constant, none exist for XCF.
$metadata[3] = sprintf(
'height="%s" width="%s"', $header['height'], $header['width']
);
$metadata['mime'] = 'image/x-xcf';
$metadata['channels'] = null;
$metadata['bits'] = 8; # Always 8-bits per color
assert( '7 == count($metadata); ' .
'# return array must contains 7 elements just like getimagesize() return' );
return $metadata;
}
/**
* Metadata for a given XCF file
*
* Will return false if file magic signature is not recognized
* @author Hexmode
* @author Hashar
*
* @param string $filename Full path to a XCF file
* @return bool|array Metadata Array just like PHP getimagesize()
*/
static function getXCFMetaData( $filename ) {
# Decode master structure
$f = fopen( $filename, 'rb' );
if ( !$f ) {
return false;
}
# The image structure always starts at offset 0 in the XCF file.
# So we just read it :-)
$binaryHeader = fread( $f, 26 );
fclose( $f );
# Master image structure:
#
# byte[9] "gimp xcf " File type magic
# byte[4] version XCF version
# "file" - version 0
# "v001" - version 1
# "v002" - version 2
# byte 0 Zero-terminator for version tag
# uint32 width With of canvas
# uint32 height Height of canvas
# uint32 base_type Color mode of the image; one of
# 0: RGB color
# 1: Grayscale
# 2: Indexed color
# (enum GimpImageBaseType in libgimpbase/gimpbaseenums.h)
try {
$header = wfUnpack(
"A9magic" . # A: space padded
"/a5version" . # a: zero padded
"/Nwidth" . # \
"/Nheight" . # N: unsigned long 32bit big endian
"/Nbase_type", # /
$binaryHeader
);
} catch ( MWException $mwe ) {
return false;
}
# Check values
if ( $header['magic'] !== 'gimp xcf' ) {
wfDebug( __METHOD__ . " '$filename' has invalid magic signature.\n" );
return false;
}
# TODO: we might want to check for sane values of width and height
wfDebug( __METHOD__ .
": canvas size of '$filename' is {$header['width']} x {$header['height']} px\n" );
return $header;
}
/**
* Store the channel type
*
* Greyscale files need different command line options.
*
* @param File $file The image object, or false if there isn't one.
* Warning, FSFile::getPropsFromPath might pass an (object)array() instead (!)
* @param string $filename The filename
* @return string
*/
public function getMetadata( $file, $filename ) {
$header = self::getXCFMetadata( $filename );
$metadata = array();
if ( $header ) {
// Try to be consistent with the names used by PNG files.
// Unclear from base media type if it has an alpha layer,
// so just assume that it does since it "potentially" could.
switch ( $header['base_type'] ) {
case 0:
$metadata['colorType'] = 'truecolour-alpha';
break;
case 1:
$metadata['colorType'] = 'greyscale-alpha';
break;
case 2:
$metadata['colorType'] = 'index-coloured';
break;
default:
$metadata['colorType'] = 'unknown';
}
} else {
// Marker to prevent repeated attempted extraction
$metadata['error'] = true;
}
return serialize( $metadata );
}
/**
* Should we refresh the metadata
*
* @param File $file The file object for the file in question
* @param string $metadata Serialized metadata
* @return bool One of the self::METADATA_(BAD|GOOD|COMPATIBLE) constants
*/
public function isMetadataValid( $file, $metadata ) {
if ( !$metadata ) {
// Old metadata when we just put an empty string in there
return self::METADATA_BAD;
} else {
return self::METADATA_GOOD;
}
}
/**
* Must use "im" for XCF
*
* @param string $dstPath
* @param bool $checkDstPath
* @return string
*/
protected function getScalerType( $dstPath, $checkDstPath = true ) {
return "im";
}
/**
* Can we render this file?
*
* Image magick doesn't support indexed xcf files as of current
* writing (as of 6.8.9-3)
* @param File $file
* @return bool
*/
public function canRender( $file ) {
wfSuppressWarnings();
$xcfMeta = unserialize( $file->getMetadata() );
wfRestoreWarnings();
if ( isset( $xcfMeta['colorType'] ) && $xcfMeta['colorType'] === 'index-coloured' ) {
return false;
}
return parent::canRender( $file );
}
}
|
