MediaWiki  master
Exif.php
Go to the documentation of this file.
1 <?php
32 class Exif {
34  const BYTE = 1;
35 
39  const ASCII = 2;
40 
42  const SHORT = 3;
43 
45  const LONG = 4;
46 
50  const RATIONAL = 5;
51 
53  const SHORT_OR_LONG = 6;
54 
56  const UNDEFINED = 7;
57 
59  const SLONG = 9;
60 
64  const SRATIONAL = 10;
65 
67  const IGNORE = -1;
68 
73  private $mExifTags;
74 
76  private $mRawExifData;
77 
83 
85  private $file;
86 
88  private $basename;
89 
91  private $log = false;
92 
96  private $byteOrder;
97 
108  function __construct( $file, $byteOrder = '' ) {
117  $this->mExifTags = [
118  # TIFF Rev. 6.0 Attribute Information (p22)
119  'IFD0' => [
120  # Tags relating to image structure
121  'ImageWidth' => self::SHORT_OR_LONG, # Image width
122  'ImageLength' => self::SHORT_OR_LONG, # Image height
123  'BitsPerSample' => [ self::SHORT, 3 ], # Number of bits per component
124  # "When a primary image is JPEG compressed, this designation is not"
125  # "necessary and is omitted." (p23)
126  'Compression' => self::SHORT, # Compression scheme #p23
127  'PhotometricInterpretation' => self::SHORT, # Pixel composition #p23
128  'Orientation' => self::SHORT, # Orientation of image #p24
129  'SamplesPerPixel' => self::SHORT, # Number of components
130  'PlanarConfiguration' => self::SHORT, # Image data arrangement #p24
131  'YCbCrSubSampling' => [ self::SHORT, 2 ], # Subsampling ratio of Y to C #p24
132  'YCbCrPositioning' => self::SHORT, # Y and C positioning #p24-25
133  'XResolution' => self::RATIONAL, # Image resolution in width direction
134  'YResolution' => self::RATIONAL, # Image resolution in height direction
135  'ResolutionUnit' => self::SHORT, # Unit of X and Y resolution #(p26)
136 
137  # Tags relating to recording offset
138  'StripOffsets' => self::SHORT_OR_LONG, # Image data location
139  'RowsPerStrip' => self::SHORT_OR_LONG, # Number of rows per strip
140  'StripByteCounts' => self::SHORT_OR_LONG, # Bytes per compressed strip
141  'JPEGInterchangeFormat' => self::SHORT_OR_LONG, # Offset to JPEG SOI
142  'JPEGInterchangeFormatLength' => self::SHORT_OR_LONG, # Bytes of JPEG data
143 
144  # Tags relating to image data characteristics
145  'TransferFunction' => self::IGNORE, # Transfer function
146  'WhitePoint' => [ self::RATIONAL, 2 ], # White point chromaticity
147  'PrimaryChromaticities' => [ self::RATIONAL, 6 ], # Chromaticities of primarities
148  # Color space transformation matrix coefficients #p27
149  'YCbCrCoefficients' => [ self::RATIONAL, 3 ],
150  'ReferenceBlackWhite' => [ self::RATIONAL, 6 ], # Pair of black and white reference values
151 
152  # Other tags
153  'DateTime' => self::ASCII, # File change date and time
154  'ImageDescription' => self::ASCII, # Image title
155  'Make' => self::ASCII, # Image input equipment manufacturer
156  'Model' => self::ASCII, # Image input equipment model
157  'Software' => self::ASCII, # Software used
158  'Artist' => self::ASCII, # Person who created the image
159  'Copyright' => self::ASCII, # Copyright holder
160  ],
161 
162  # Exif IFD Attribute Information (p30-31)
163  'EXIF' => [
164  # @todo NOTE: Nonexistence of this field is taken to mean nonconformance
165  # to the Exif 2.1 AND 2.2 standards
166  'ExifVersion' => self::UNDEFINED, # Exif version
167  'FlashPixVersion' => self::UNDEFINED, # Supported Flashpix version #p32
168 
169  # Tags relating to Image Data Characteristics
170  'ColorSpace' => self::SHORT, # Color space information #p32
171 
172  # Tags relating to image configuration
173  'ComponentsConfiguration' => self::UNDEFINED, # Meaning of each component #p33
174  'CompressedBitsPerPixel' => self::RATIONAL, # Image compression mode
175  'PixelYDimension' => self::SHORT_OR_LONG, # Valid image height
176  'PixelXDimension' => self::SHORT_OR_LONG, # Valid image width
177 
178  # Tags relating to related user information
179  'MakerNote' => self::IGNORE, # Manufacturer notes
180  'UserComment' => self::UNDEFINED, # User comments #p34
181 
182  # Tags relating to related file information
183  'RelatedSoundFile' => self::ASCII, # Related audio file
184 
185  # Tags relating to date and time
186  'DateTimeOriginal' => self::ASCII, # Date and time of original data generation #p36
187  'DateTimeDigitized' => self::ASCII, # Date and time of original data generation
188  'SubSecTime' => self::ASCII, # DateTime subseconds
189  'SubSecTimeOriginal' => self::ASCII, # DateTimeOriginal subseconds
190  'SubSecTimeDigitized' => self::ASCII, # DateTimeDigitized subseconds
191 
192  # Tags relating to picture-taking conditions (p31)
193  'ExposureTime' => self::RATIONAL, # Exposure time
194  'FNumber' => self::RATIONAL, # F Number
195  'ExposureProgram' => self::SHORT, # Exposure Program #p38
196  'SpectralSensitivity' => self::ASCII, # Spectral sensitivity
197  'ISOSpeedRatings' => self::SHORT, # ISO speed rating
198  'OECF' => self::IGNORE,
199  # Optoelectronic conversion factor. Note: We don't have support for this atm.
200  'ShutterSpeedValue' => self::SRATIONAL, # Shutter speed
201  'ApertureValue' => self::RATIONAL, # Aperture
202  'BrightnessValue' => self::SRATIONAL, # Brightness
203  'ExposureBiasValue' => self::SRATIONAL, # Exposure bias
204  'MaxApertureValue' => self::RATIONAL, # Maximum land aperture
205  'SubjectDistance' => self::RATIONAL, # Subject distance
206  'MeteringMode' => self::SHORT, # Metering mode #p40
207  'LightSource' => self::SHORT, # Light source #p40-41
208  'Flash' => self::SHORT, # Flash #p41-42
209  'FocalLength' => self::RATIONAL, # Lens focal length
210  'SubjectArea' => [ self::SHORT, 4 ], # Subject area
211  'FlashEnergy' => self::RATIONAL, # Flash energy
212  'SpatialFrequencyResponse' => self::IGNORE, # Spatial frequency response. Not supported atm.
213  'FocalPlaneXResolution' => self::RATIONAL, # Focal plane X resolution
214  'FocalPlaneYResolution' => self::RATIONAL, # Focal plane Y resolution
215  'FocalPlaneResolutionUnit' => self::SHORT, # Focal plane resolution unit #p46
216  'SubjectLocation' => [ self::SHORT, 2 ], # Subject location
217  'ExposureIndex' => self::RATIONAL, # Exposure index
218  'SensingMethod' => self::SHORT, # Sensing method #p46
219  'FileSource' => self::UNDEFINED, # File source #p47
220  'SceneType' => self::UNDEFINED, # Scene type #p47
221  'CFAPattern' => self::IGNORE, # CFA pattern. not supported atm.
222  'CustomRendered' => self::SHORT, # Custom image processing #p48
223  'ExposureMode' => self::SHORT, # Exposure mode #p48
224  'WhiteBalance' => self::SHORT, # White Balance #p49
225  'DigitalZoomRatio' => self::RATIONAL, # Digital zoom ration
226  'FocalLengthIn35mmFilm' => self::SHORT, # Focal length in 35 mm film
227  'SceneCaptureType' => self::SHORT, # Scene capture type #p49
228  'GainControl' => self::SHORT, # Scene control #p49-50
229  'Contrast' => self::SHORT, # Contrast #p50
230  'Saturation' => self::SHORT, # Saturation #p50
231  'Sharpness' => self::SHORT, # Sharpness #p50
232  'DeviceSettingDescription' => self::IGNORE,
233  # Device settings description. This could maybe be supported. Need to find an
234  # example file that uses this to see if it has stuff of interest in it.
235  'SubjectDistanceRange' => self::SHORT, # Subject distance range #p51
236 
237  'ImageUniqueID' => self::ASCII, # Unique image ID
238  ],
239 
240  # GPS Attribute Information (p52)
241  'GPS' => [
242  'GPSVersion' => self::UNDEFINED,
243  # Should be an array of 4 Exif::BYTE's. However php treats it as an undefined
244  # Note exif standard calls this GPSVersionID, but php doesn't like the id suffix
245  'GPSLatitudeRef' => self::ASCII, # North or South Latitude #p52-53
246  'GPSLatitude' => [ self::RATIONAL, 3 ], # Latitude
247  'GPSLongitudeRef' => self::ASCII, # East or West Longitude #p53
248  'GPSLongitude' => [ self::RATIONAL, 3 ], # Longitude
249  'GPSAltitudeRef' => self::UNDEFINED,
250  # Altitude reference. Note, the exif standard says this should be an EXIF::Byte,
251  # but php seems to disagree.
252  'GPSAltitude' => self::RATIONAL, # Altitude
253  'GPSTimeStamp' => [ self::RATIONAL, 3 ], # GPS time (atomic clock)
254  'GPSSatellites' => self::ASCII, # Satellites used for measurement
255  'GPSStatus' => self::ASCII, # Receiver status #p54
256  'GPSMeasureMode' => self::ASCII, # Measurement mode #p54-55
257  'GPSDOP' => self::RATIONAL, # Measurement precision
258  'GPSSpeedRef' => self::ASCII, # Speed unit #p55
259  'GPSSpeed' => self::RATIONAL, # Speed of GPS receiver
260  'GPSTrackRef' => self::ASCII, # Reference for direction of movement #p55
261  'GPSTrack' => self::RATIONAL, # Direction of movement
262  'GPSImgDirectionRef' => self::ASCII, # Reference for direction of image #p56
263  'GPSImgDirection' => self::RATIONAL, # Direction of image
264  'GPSMapDatum' => self::ASCII, # Geodetic survey data used
265  'GPSDestLatitudeRef' => self::ASCII, # Reference for latitude of destination #p56
266  'GPSDestLatitude' => [ self::RATIONAL, 3 ], # Latitude destination
267  'GPSDestLongitudeRef' => self::ASCII, # Reference for longitude of destination #p57
268  'GPSDestLongitude' => [ self::RATIONAL, 3 ], # Longitude of destination
269  'GPSDestBearingRef' => self::ASCII, # Reference for bearing of destination #p57
270  'GPSDestBearing' => self::RATIONAL, # Bearing of destination
271  'GPSDestDistanceRef' => self::ASCII, # Reference for distance to destination #p57-58
272  'GPSDestDistance' => self::RATIONAL, # Distance to destination
273  'GPSProcessingMethod' => self::UNDEFINED, # Name of GPS processing method
274  'GPSAreaInformation' => self::UNDEFINED, # Name of GPS area
275  'GPSDateStamp' => self::ASCII, # GPS date
276  'GPSDifferential' => self::SHORT, # GPS differential correction
277  ],
278  ];
279 
280  $this->file = $file;
281  $this->basename = wfBaseName( $this->file );
282  if ( $byteOrder === 'BE' || $byteOrder === 'LE' ) {
283  $this->byteOrder = $byteOrder;
284  } else {
285  // Only give a warning for b/c, since originally we didn't
286  // require this. The number of things affected by this is
287  // rather small.
288  wfWarn( 'Exif class did not have byte order specified. ' .
289  'Some properties may be decoded incorrectly.' );
290  $this->byteOrder = 'BE'; // BE seems about twice as popular as LE in jpg's.
291  }
292 
293  $this->debugFile( __FUNCTION__, true );
294  if ( function_exists( 'exif_read_data' ) ) {
295  Wikimedia\suppressWarnings();
296  $data = exif_read_data( $this->file, 0, true );
297  Wikimedia\restoreWarnings();
298  } else {
299  throw new MWException( "Internal error: exif_read_data not present. " .
300  "\$wgShowEXIF may be incorrectly set or not checked by an extension." );
301  }
307  $this->mRawExifData = $data ?: [];
308  $this->makeFilteredData();
309  $this->collapseData();
310  $this->debugFile( __FUNCTION__, false );
311  }
312 
316  function makeFilteredData() {
317  $this->mFilteredExifData = [];
318 
319  foreach ( array_keys( $this->mRawExifData ) as $section ) {
320  if ( !array_key_exists( $section, $this->mExifTags ) ) {
321  $this->debug( $section, __FUNCTION__, "'$section' is not a valid Exif section" );
322  continue;
323  }
324 
325  foreach ( array_keys( $this->mRawExifData[$section] ) as $tag ) {
326  if ( !array_key_exists( $tag, $this->mExifTags[$section] ) ) {
327  $this->debug( $tag, __FUNCTION__, "'$tag' is not a valid tag in '$section'" );
328  continue;
329  }
330 
331  $this->mFilteredExifData[$tag] = $this->mRawExifData[$section][$tag];
332  // This is ok, as the tags in the different sections do not conflict.
333  // except in computed and thumbnail section, which we don't use.
334 
335  $value = $this->mRawExifData[$section][$tag];
336  if ( !$this->validate( $section, $tag, $value ) ) {
337  $this->debug( $value, __FUNCTION__, "'$tag' contained invalid data" );
338  unset( $this->mFilteredExifData[$tag] );
339  }
340  }
341  }
342  }
343 
362  function collapseData() {
363  $this->exifGPStoNumber( 'GPSLatitude' );
364  $this->exifGPStoNumber( 'GPSDestLatitude' );
365  $this->exifGPStoNumber( 'GPSLongitude' );
366  $this->exifGPStoNumber( 'GPSDestLongitude' );
367 
368  if ( isset( $this->mFilteredExifData['GPSAltitude'] )
369  && isset( $this->mFilteredExifData['GPSAltitudeRef'] )
370  ) {
371  // We know altitude data is a <num>/<denom> from the validation
372  // functions ran earlier. But multiplying such a string by -1
373  // doesn't work well, so convert.
374  list( $num, $denom ) = explode( '/', $this->mFilteredExifData['GPSAltitude'] );
375  $this->mFilteredExifData['GPSAltitude'] = $num / $denom;
376 
377  if ( $this->mFilteredExifData['GPSAltitudeRef'] === "\1" ) {
378  $this->mFilteredExifData['GPSAltitude'] *= -1;
379  }
380  unset( $this->mFilteredExifData['GPSAltitudeRef'] );
381  }
382 
383  $this->exifPropToOrd( 'FileSource' );
384  $this->exifPropToOrd( 'SceneType' );
385 
386  $this->charCodeString( 'UserComment' );
387  $this->charCodeString( 'GPSProcessingMethod' );
388  $this->charCodeString( 'GPSAreaInformation' );
389 
390  // ComponentsConfiguration should really be an array instead of a string...
391  // This turns a string of binary numbers into an array of numbers.
392 
393  if ( isset( $this->mFilteredExifData['ComponentsConfiguration'] ) ) {
394  $val = $this->mFilteredExifData['ComponentsConfiguration'];
395  $ccVals = [];
396 
397  $strLen = strlen( $val );
398  for ( $i = 0; $i < $strLen; $i++ ) {
399  $ccVals[$i] = ord( substr( $val, $i, 1 ) );
400  }
401  $ccVals['_type'] = 'ol'; // this is for formatting later.
402  $this->mFilteredExifData['ComponentsConfiguration'] = $ccVals;
403  }
404 
405  // GPSVersion(ID) is treated as the wrong type by php exif support.
406  // Go through each byte turning it into a version string.
407  // For example: "\x02\x02\x00\x00" -> "2.2.0.0"
408 
409  // Also change exif tag name from GPSVersion (what php exif thinks it is)
410  // to GPSVersionID (what the exif standard thinks it is).
411 
412  if ( isset( $this->mFilteredExifData['GPSVersion'] ) ) {
413  $val = $this->mFilteredExifData['GPSVersion'];
414  $newVal = '';
415 
416  $strLen = strlen( $val );
417  for ( $i = 0; $i < $strLen; $i++ ) {
418  if ( $i !== 0 ) {
419  $newVal .= '.';
420  }
421  $newVal .= ord( substr( $val, $i, 1 ) );
422  }
423 
424  if ( $this->byteOrder === 'LE' ) {
425  // Need to reverse the string
426  $newVal2 = '';
427  for ( $i = strlen( $newVal ) - 1; $i >= 0; $i-- ) {
428  $newVal2 .= substr( $newVal, $i, 1 );
429  }
430  $this->mFilteredExifData['GPSVersionID'] = $newVal2;
431  } else {
432  $this->mFilteredExifData['GPSVersionID'] = $newVal;
433  }
434  unset( $this->mFilteredExifData['GPSVersion'] );
435  }
436  }
437 
444  private function charCodeString( $prop ) {
445  if ( isset( $this->mFilteredExifData[$prop] ) ) {
446  if ( strlen( $this->mFilteredExifData[$prop] ) <= 8 ) {
447  // invalid. Must be at least 9 bytes long.
448 
449  $this->debug( $this->mFilteredExifData[$prop], __FUNCTION__, false );
450  unset( $this->mFilteredExifData[$prop] );
451 
452  return;
453  }
454  $charCode = substr( $this->mFilteredExifData[$prop], 0, 8 );
455  $val = substr( $this->mFilteredExifData[$prop], 8 );
456 
457  switch ( $charCode ) {
458  case "JIS\x00\x00\x00\x00\x00":
459  $charset = "Shift-JIS";
460  break;
461  case "UNICODE\x00":
462  $charset = "UTF-16" . $this->byteOrder;
463  break;
464  default: // ascii or undefined.
465  $charset = "";
466  break;
467  }
468  if ( $charset ) {
469  Wikimedia\suppressWarnings();
470  $val = iconv( $charset, 'UTF-8//IGNORE', $val );
471  Wikimedia\restoreWarnings();
472  } else {
473  // if valid utf-8, assume that, otherwise assume windows-1252
474  $valCopy = $val;
475  UtfNormal\Validator::quickIsNFCVerify( $valCopy ); // validates $valCopy.
476  if ( $valCopy !== $val ) {
477  Wikimedia\suppressWarnings();
478  $val = iconv( 'Windows-1252', 'UTF-8//IGNORE', $val );
479  Wikimedia\restoreWarnings();
480  }
481  }
482 
483  // trim and check to make sure not only whitespace.
484  $val = trim( $val );
485  if ( strlen( $val ) === 0 ) {
486  // only whitespace.
487  $this->debug( $this->mFilteredExifData[$prop], __FUNCTION__, "$prop: Is only whitespace" );
488  unset( $this->mFilteredExifData[$prop] );
489 
490  return;
491  }
492 
493  // all's good.
494  $this->mFilteredExifData[$prop] = $val;
495  }
496  }
497 
504  private function exifPropToOrd( $prop ) {
505  if ( isset( $this->mFilteredExifData[$prop] ) ) {
506  $this->mFilteredExifData[$prop] = ord( $this->mFilteredExifData[$prop] );
507  }
508  }
509 
515  private function exifGPStoNumber( $prop ) {
516  $loc =& $this->mFilteredExifData[$prop];
517  $dir =& $this->mFilteredExifData[$prop . 'Ref'];
518  $res = false;
519 
520  if ( isset( $loc ) && isset( $dir )
521  && ( $dir === 'N' || $dir === 'S' || $dir === 'E' || $dir === 'W' )
522  ) {
523  list( $num, $denom ) = explode( '/', $loc[0] );
524  $res = $num / $denom;
525  list( $num, $denom ) = explode( '/', $loc[1] );
526  $res += ( $num / $denom ) * ( 1 / 60 );
527  list( $num, $denom ) = explode( '/', $loc[2] );
528  $res += ( $num / $denom ) * ( 1 / 3600 );
529 
530  if ( $dir === 'S' || $dir === 'W' ) {
531  $res *= -1; // make negative
532  }
533  }
534 
535  // update the exif records.
536 
537  if ( $res !== false ) { // using !== as $res could potentially be 0
538  $this->mFilteredExifData[$prop] = $res;
539  unset( $this->mFilteredExifData[$prop . 'Ref'] );
540  } else { // if invalid
541  unset( $this->mFilteredExifData[$prop] );
542  unset( $this->mFilteredExifData[$prop . 'Ref'] );
543  }
544  }
545 
556  function getData() {
557  return $this->mRawExifData;
558  }
559 
564  function getFilteredData() {
566  }
567 
582  public static function version() {
583  return 2; // We don't need no bloddy constants!
584  }
585 
592  private function isByte( $in ) {
593  if ( !is_array( $in ) && sprintf( '%d', $in ) == $in && $in >= 0 && $in <= 255 ) {
594  $this->debug( $in, __FUNCTION__, true );
595 
596  return true;
597  } else {
598  $this->debug( $in, __FUNCTION__, false );
599 
600  return false;
601  }
602  }
603 
608  private function isASCII( $in ) {
609  if ( is_array( $in ) ) {
610  return false;
611  }
612 
613  if ( preg_match( "/[^\x0a\x20-\x7e]/", $in ) ) {
614  $this->debug( $in, __FUNCTION__, 'found a character not in our whitelist' );
615 
616  return false;
617  }
618 
619  if ( preg_match( '/^\s*$/', $in ) ) {
620  $this->debug( $in, __FUNCTION__, 'input consisted solely of whitespace' );
621 
622  return false;
623  }
624 
625  return true;
626  }
627 
632  private function isShort( $in ) {
633  if ( !is_array( $in ) && sprintf( '%d', $in ) == $in && $in >= 0 && $in <= 65536 ) {
634  $this->debug( $in, __FUNCTION__, true );
635 
636  return true;
637  } else {
638  $this->debug( $in, __FUNCTION__, false );
639 
640  return false;
641  }
642  }
643 
648  private function isLong( $in ) {
649  if ( !is_array( $in ) && sprintf( '%d', $in ) == $in && $in >= 0 && $in <= 4294967296 ) {
650  $this->debug( $in, __FUNCTION__, true );
651 
652  return true;
653  } else {
654  $this->debug( $in, __FUNCTION__, false );
655 
656  return false;
657  }
658  }
659 
664  private function isRational( $in ) {
665  $m = [];
666 
667  # Avoid division by zero
668  if ( !is_array( $in )
669  && preg_match( '/^(\d+)\/(\d+[1-9]|[1-9]\d*)$/', $in, $m )
670  ) {
671  return $this->isLong( $m[1] ) && $this->isLong( $m[2] );
672  } else {
673  $this->debug( $in, __FUNCTION__, 'fed a non-fraction value' );
674 
675  return false;
676  }
677  }
678 
683  private function isUndefined( $in ) {
684  $this->debug( $in, __FUNCTION__, true );
685 
686  return true;
687  }
688 
693  private function isSlong( $in ) {
694  if ( $this->isLong( abs( $in ) ) ) {
695  $this->debug( $in, __FUNCTION__, true );
696 
697  return true;
698  } else {
699  $this->debug( $in, __FUNCTION__, false );
700 
701  return false;
702  }
703  }
704 
709  private function isSrational( $in ) {
710  $m = [];
711 
712  # Avoid division by zero
713  if ( !is_array( $in ) &&
714  preg_match( '/^(-?\d+)\/(\d+[1-9]|[1-9]\d*)$/', $in, $m )
715  ) {
716  return $this->isSlong( $m[0] ) && $this->isSlong( $m[1] );
717  } else {
718  $this->debug( $in, __FUNCTION__, 'fed a non-fraction value' );
719 
720  return false;
721  }
722  }
723 
735  private function validate( $section, $tag, $val, $recursive = false ) {
736  $debug = "tag is '$tag'";
737  $etype = $this->mExifTags[$section][$tag];
738  $ecount = 1;
739  if ( is_array( $etype ) ) {
740  list( $etype, $ecount ) = $etype;
741  if ( $recursive ) {
742  $ecount = 1; // checking individual elements
743  }
744  }
745 
746  $count = 1;
747  if ( is_array( $val ) ) {
748  $count = count( $val );
749  if ( $ecount != $count ) {
750  $this->debug( $val, __FUNCTION__, "Expected $ecount elements for $tag but got $count" );
751  return false;
752  }
753  }
754  // If there are multiple values, recursively validate each of them.
755  if ( $count > 1 ) {
756  foreach ( $val as $v ) {
757  if ( !$this->validate( $section, $tag, $v, true ) ) {
758  return false;
759  }
760  }
761 
762  return true;
763  }
764  // Does not work if not typecast
765  switch ( (string)$etype ) {
766  case (string)self::BYTE:
767  $this->debug( $val, __FUNCTION__, $debug );
768 
769  return $this->isByte( $val );
770  case (string)self::ASCII:
771  $this->debug( $val, __FUNCTION__, $debug );
772 
773  return $this->isASCII( $val );
774  case (string)self::SHORT:
775  $this->debug( $val, __FUNCTION__, $debug );
776 
777  return $this->isShort( $val );
778  case (string)self::LONG:
779  $this->debug( $val, __FUNCTION__, $debug );
780 
781  return $this->isLong( $val );
782  case (string)self::RATIONAL:
783  $this->debug( $val, __FUNCTION__, $debug );
784 
785  return $this->isRational( $val );
786  case (string)self::SHORT_OR_LONG:
787  $this->debug( $val, __FUNCTION__, $debug );
788 
789  return $this->isShort( $val ) || $this->isLong( $val );
790  case (string)self::UNDEFINED:
791  $this->debug( $val, __FUNCTION__, $debug );
792 
793  return $this->isUndefined( $val );
794  case (string)self::SLONG:
795  $this->debug( $val, __FUNCTION__, $debug );
796 
797  return $this->isSlong( $val );
798  case (string)self::SRATIONAL:
799  $this->debug( $val, __FUNCTION__, $debug );
800 
801  return $this->isSrational( $val );
802  case (string)self::IGNORE:
803  $this->debug( $val, __FUNCTION__, $debug );
804 
805  return false;
806  default:
807  $this->debug( $val, __FUNCTION__, "The tag '$tag' is unknown" );
808 
809  return false;
810  }
811  }
812 
820  private function debug( $in, $fname, $action = null ) {
821  if ( !$this->log ) {
822  return;
823  }
824  $type = gettype( $in );
825  $class = ucfirst( __CLASS__ );
826  if ( is_array( $in ) ) {
827  $in = print_r( $in, true );
828  }
829 
830  if ( $action === true ) {
831  wfDebugLog( $this->log, "$class::$fname: accepted: '$in' (type: $type)" );
832  } elseif ( $action === false ) {
833  wfDebugLog( $this->log, "$class::$fname: rejected: '$in' (type: $type)" );
834  } elseif ( $action === null ) {
835  wfDebugLog( $this->log, "$class::$fname: input was: '$in' (type: $type)" );
836  } else {
837  wfDebugLog( $this->log, "$class::$fname: $action (type: $type; content: '$in')" );
838  }
839  }
840 
847  private function debugFile( $fname, $io ) {
848  if ( !$this->log ) {
849  return;
850  }
851  $class = ucfirst( __CLASS__ );
852  if ( $io ) {
853  wfDebugLog( $this->log, "$class::$fname: begin processing: '{$this->basename}'" );
854  } else {
855  wfDebugLog( $this->log, "$class::$fname: end processing: '{$this->basename}'" );
856  }
857  }
858 }
getData()
#-
Definition: Exif.php:556
charCodeString( $prop)
Do userComment tags and similar.
Definition: Exif.php:444
const RATIONAL
Two LONGs.
Definition: Exif.php:50
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
array $mFilteredExifData
A Filtered version of $mRawExifData that has been pruned of invalid tags and tags that contain conten...
Definition: Exif.php:82
collapseData()
Collapse some fields together.
Definition: Exif.php:362
const SLONG
A 32-bit (4-byte) signed integer (2&#39;s complement notation),.
Definition: Exif.php:59
isByte( $in)
Validates if a tag value is of the type it should be according to the Exif spec.
Definition: Exif.php:592
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition: globals.txt:10
static version()
#-
Definition: Exif.php:582
exifPropToOrd( $prop)
Convert an Exif::UNDEFINED from a raw binary string to its value.
Definition: Exif.php:504
width
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition: hooks.txt:115
debug( $in, $fname, $action=null)
Convenience function for debugging output.
Definition: Exif.php:820
null for the local wiki Added in
Definition: hooks.txt:1585
$value
Copyright(c) 2011-2015 MediaWiki Widgets Team and others under the terms of The MIT License(MIT)
array $mExifTags
Exif tags grouped by category, the tagname itself is the key and the type is the value, in the case of more than one possible value type they are separated by commas.
Definition: Exif.php:73
debugFile( $fname, $io)
Convenience function for debugging output.
Definition: Exif.php:847
const BYTE
An 8-bit (1-byte) unsigned integer.
Definition: Exif.php:34
title
isSlong( $in)
Definition: Exif.php:693
const SRATIONAL
Two SLONGs.
Definition: Exif.php:64
exifGPStoNumber( $prop)
Convert gps in exif form to a single floating point number for example 10 degress 2040` S -> -10...
Definition: Exif.php:515
string $byteOrder
The byte order of the file.
Definition: Exif.php:96
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
isASCII( $in)
Definition: Exif.php:608
string $basename
The basename of the file being processed.
Definition: Exif.php:88
isRational( $in)
Definition: Exif.php:664
string $file
The file being processed.
Definition: Exif.php:85
__construct( $file, $byteOrder='')
Definition: Exif.php:108
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
isLong( $in)
Definition: Exif.php:648
array $mRawExifData
The raw Exif data returned by exif_read_data()
Definition: Exif.php:76
isSrational( $in)
Definition: Exif.php:709
$res
Definition: database.txt:21
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
const SHORT
A 16-bit (2-byte) unsigned integer.
Definition: Exif.php:42
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after processing
Definition: hooks.txt:1982
const UNDEFINED
An 8-bit byte that can take any value depending on the field definition.
Definition: Exif.php:56
const ASCII
An 8-bit byte containing one 7-bit ASCII code.
Definition: Exif.php:39
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
validate( $section, $tag, $val, $recursive=false)
#-
Definition: Exif.php:735
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:123
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3051
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs source
Definition: hooks.txt:1637
makeFilteredData()
Make $this->mFilteredExifData.
Definition: Exif.php:316
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to and or sell copies of the Software
Definition: LICENSE.txt:10
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could change
Definition: distributors.txt:9
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition: postgres.txt:22
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
const LONG
A 32-bit (4-byte) unsigned integer.
Definition: Exif.php:45
const IGNORE
A fake value for things we don&#39;t want or don&#39;t support.
Definition: Exif.php:67
Class to extract and validate Exif data from jpeg (and possibly tiff) files.
Definition: Exif.php:32
isUndefined( $in)
Definition: Exif.php:683
isShort( $in)
Definition: Exif.php:632
$debug
Definition: mcc.php:31
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
string $log
The private log to log to, e.g.
Definition: Exif.php:91
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible values
Definition: hooks.txt:175
getFilteredData()
Get $this->mFilteredExifData.
Definition: Exif.php:564
const SHORT_OR_LONG
A 16-bit (2-byte) or 32-bit (4-byte) unsigned integer.
Definition: Exif.php:53