diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2011-12-03 13:29:22 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2011-12-03 13:29:22 +0100 |
commit | ca32f08966f1b51fcb19460f0996bb0c4048e6fe (patch) | |
tree | ec04cc15b867bc21eedca904cea9af0254531a11 /includes/media/XMPValidate.php | |
parent | a22fbfc60f36f5f7ee10d5ae6fe347340c2ee67c (diff) |
Update to MediaWiki 1.18.0
* also update ArchLinux skin to chagnes in MonoBook
* Use only css to hide our menu bar when printing
Diffstat (limited to 'includes/media/XMPValidate.php')
-rw-r--r-- | includes/media/XMPValidate.php | 323 |
1 files changed, 323 insertions, 0 deletions
diff --git a/includes/media/XMPValidate.php b/includes/media/XMPValidate.php new file mode 100644 index 00000000..0f1d375c --- /dev/null +++ b/includes/media/XMPValidate.php @@ -0,0 +1,323 @@ +<?php +/** +* This contains some static methods for +* validating XMP properties. See XMPInfo and XMPReader classes. +* +* Each of these functions take the same parameters +* * an info array which is a subset of the XMPInfo::items array +* * A value (passed as reference) to validate. This can be either a +* simple value or an array +* * A boolean to determine if this is validating a simple or complex values +* +* It should be noted that when an array is being validated, typically the validation +* function is called once for each value, and then once at the end for the entire array. +* +* These validation functions can also be used to modify the data. See the gps and flash one's +* for example. +* +* @see http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart1.pdf starting at pg 28 +* @see http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart2.pdf starting at pg 11 +*/ +class XMPValidate { + /** + * function to validate boolean properties ( True or False ) + * + * @param $info Array information about current property + * @param &$val Mixed current value to validate + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateBoolean( $info, &$val, $standalone ) { + if ( !$standalone ) { + // this only validates standalone properties, not arrays, etc + return; + } + if ( $val !== 'True' && $val !== 'False' ) { + wfDebugLog( 'XMP', __METHOD__ . " Expected True or False but got $val" ); + $val = null; + } + + } + + /** + * function to validate rational properties ( 12/10 ) + * + * @param $info Array information about current property + * @param &$val Mixed current value to validate + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateRational( $info, &$val, $standalone ) { + if ( !$standalone ) { + // this only validates standalone properties, not arrays, etc + return; + } + if ( !preg_match( '/^(?:-?\d+)\/(?:\d+[1-9]|[1-9]\d*)$/D', $val ) ) { + wfDebugLog( 'XMP', __METHOD__ . " Expected rational but got $val" ); + $val = null; + } + + } + + /** + * function to validate rating properties -1, 0-5 + * + * if its outside of range put it into range. + * + * @see MWG spec + * @param $info Array information about current property + * @param &$val Mixed current value to validate + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateRating( $info, &$val, $standalone ) { + if ( !$standalone ) { + // this only validates standalone properties, not arrays, etc + return; + } + if ( !preg_match( '/^[-+]?\d*(?:\.?\d*)$/D', $val ) + || !is_numeric($val) + ) { + wfDebugLog( 'XMP', __METHOD__ . " Expected rating but got $val" ); + $val = null; + return; + } else { + $nVal = (float) $val; + if ( $nVal < 0 ) { + // We do < 0 here instead of < -1 here, since + // the values between 0 and -1 are also illegal + // as -1 is meant as a special reject rating. + wfDebugLog( 'XMP', __METHOD__ . " Rating too low, setting to -1 (Rejected)"); + $val = '-1'; + return; + } + if ( $nVal > 5 ) { + wfDebugLog( 'XMP', __METHOD__ . " Rating too high, setting to 5"); + $val = '5'; + return; + } + } + } + + /** + * function to validate integers + * + * @param $info Array information about current property + * @param &$val Mixed current value to validate + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateInteger( $info, &$val, $standalone ) { + if ( !$standalone ) { + // this only validates standalone properties, not arrays, etc + return; + } + if ( !preg_match( '/^[-+]?\d+$/D', $val ) ) { + wfDebugLog( 'XMP', __METHOD__ . " Expected integer but got $val" ); + $val = null; + } + + } + + /** + * function to validate properties with a fixed number of allowed + * choices. (closed choice) + * + * @param $info Array information about current property + * @param &$val Mixed current value to validate + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateClosed( $info, &$val, $standalone ) { + if ( !$standalone ) { + // this only validates standalone properties, not arrays, etc + return; + } + + //check if its in a numeric range + $inRange = false; + if ( isset( $info['rangeLow'] ) + && isset( $info['rangeHigh'] ) + && is_numeric( $val ) + && ( intval( $val ) <= $info['rangeHigh'] ) + && ( intval( $val ) >= $info['rangeLow'] ) + ) { + $inRange = true; + } + + if ( !isset( $info['choices'][$val] ) && !$inRange ) { + wfDebugLog( 'XMP', __METHOD__ . " Expected closed choice, but got $val" ); + $val = null; + } + } + + /** + * function to validate and modify flash structure + * + * @param $info Array information about current property + * @param &$val Mixed current value to validate + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateFlash( $info, &$val, $standalone ) { + if ( $standalone ) { + // this only validates flash structs, not individual properties + return; + } + if ( !( isset( $val['Fired'] ) + && isset( $val['Function'] ) + && isset( $val['Mode'] ) + && isset( $val['RedEyeMode'] ) + && isset( $val['Return'] ) + ) ) { + wfDebugLog( 'XMP', __METHOD__ . " Flash structure did not have all the required components" ); + $val = null; + } else { + $val = ( "\0" | ( $val['Fired'] === 'True' ) + | ( intval( $val['Return'] ) << 1 ) + | ( intval( $val['Mode'] ) << 3 ) + | ( ( $val['Function'] === 'True' ) << 5 ) + | ( ( $val['RedEyeMode'] === 'True' ) << 6 ) ); + } + } + + /** + * function to validate LangCode properties ( en-GB, etc ) + * + * This is just a naive check to make sure it somewhat looks like a lang code. + * + * @see rfc 3066 + * @see http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart1.pdf page 30 (section 8.2.2.5) + * + * @param $info Array information about current property + * @param &$val Mixed current value to validate + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateLangCode( $info, &$val, $standalone ) { + if ( !$standalone ) { + // this only validates standalone properties, not arrays, etc + return; + } + if ( !preg_match( '/^[-A-Za-z0-9]{2,}$/D', $val) ) { + //this is a rather naive check. + wfDebugLog( 'XMP', __METHOD__ . " Expected Lang code but got $val" ); + $val = null; + } + + } + + /** + * function to validate date properties, and convert to Exif format. + * + * @param $info Array information about current property + * @param &$val Mixed current value to validate. Converts to TS_EXIF as a side-effect. + * @param $standalone Boolean if this is a simple property or array + */ + public static function validateDate( $info, &$val, $standalone ) { + if ( !$standalone ) { + // this only validates standalone properties, not arrays, etc + return; + } + $res = array(); + if ( !preg_match( + /* ahh! scary regex... */ + '/^([0-3]\d{3})(?:-([01]\d)(?:-([0-3]\d)(?:T([0-2]\d):([0-6]\d)(?::([0-6]\d)(?:\.\d+)?)?([-+]\d{2}:\d{2}|Z)?)?)?)?$/D' + , $val, $res) + ) { + wfDebugLog( 'XMP', __METHOD__ . " Expected date but got $val" ); + $val = null; + } else { + /* + * $res is formatted as follows: + * 0 -> full date. + * 1 -> year, 2-> month, 3-> day, 4-> hour, 5-> minute, 6->second + * 7-> Timezone specifier (Z or something like +12:30 ) + * many parts are optional, some aren't. For example if you specify + * minute, you must specify hour, day, month, and year but not second or TZ. + */ + + /* + * First of all, if year = 0000, Something is wrongish, + * so don't extract. This seems to happen when + * some programs convert between metadata formats. + */ + if ( $res[1] === '0000' ) { + wfDebugLog( 'XMP', __METHOD__ . " Invalid date (year 0): $val" ); + $val = null; + return; + } + //if month, etc unspecified, full out as 01. + $res[2] = isset( $res[2] ) ? $res[2] : '01'; //month + $res[3] = isset( $res[3] ) ? $res[3] : '01'; //day + if ( !isset( $res[4] ) ) { //hour + //just have the year month day + $val = $res[1] . ':' . $res[2] . ':' . $res[3]; + return; + } + //if hour is set, so is minute or regex above will fail. + //Extra check for empty string necessary due to TZ but no second case. + $res[6] = isset( $res[6] ) && $res[6] != '' ? $res[6] : '00'; + + if ( !isset( $res[7] ) || $res[7] === 'Z' ) { + $val = $res[1] . ':' . $res[2] . ':' . $res[3] + . ' ' . $res[4] . ':' . $res[5] . ':' . $res[6]; + return; + } + + //do timezone processing. We've already done the case that tz = Z. + + $unix = wfTimestamp( TS_UNIX, $res[1] . $res[2] . $res[3] . $res[4] . $res[5] . $res[6] ); + $offset = intval( substr( $res[7], 1, 2 ) ) * 60 * 60; + $offset += intval( substr( $res[7], 4, 2 ) ) * 60; + if ( substr( $res[7], 0, 1 ) === '-' ) { + $offset = -$offset; + } + $val = wfTimestamp( TS_EXIF, $unix + $offset ); + } + + } + + /** function to validate, and more importantly + * translate the XMP DMS form of gps coords to + * the decimal form we use. + * + * @see http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart2.pdf + * section 1.2.7.4 on page 23 + * + * @param $info Array unused (info about prop) + * @param &$val String GPS string in either DDD,MM,SSk or + * or DDD,MM.mmk form + * @param $standalone Boolean if its a simple prop (should always be true) + */ + public static function validateGPS ( $info, &$val, $standalone ) { + if ( !$standalone ) { + return; + } + + $m = array(); + if ( preg_match( + '/(\d{1,3}),(\d{1,2}),(\d{1,2})([NWSE])/D', + $val, $m ) + ) { + $coord = intval( $m[1] ); + $coord += intval( $m[2] ) * (1/60); + $coord += intval( $m[3] ) * (1/3600); + if ( $m[4] === 'S' || $m[4] === 'W' ) { + $coord = -$coord; + } + $val = $coord; + return; + } elseif ( preg_match( + '/(\d{1,3}),(\d{1,2}(?:.\d*)?)([NWSE])/D', + $val, $m ) + ) { + $coord = intval( $m[1] ); + $coord += floatval( $m[2] ) * (1/60); + if ( $m[3] === 'S' || $m[3] === 'W' ) { + $coord = -$coord; + } + $val = $coord; + return; + + } else { + wfDebugLog( 'XMP', __METHOD__ + . " Expected GPSCoordinate, but got $val." ); + $val = null; + return; + } + } +} |