<?php
-
/**
* RandomImageGenerator -- does what it says on the tin.
- * Requires Imagick, the ImageMagick library for PHP, or the command line equivalent (usually 'convert').
+ * Requires Imagick, the ImageMagick library for PHP, or the command line
+ * equivalent (usually 'convert').
*
- * Because MediaWiki tests the uniqueness of media upload content, and filenames, it is sometimes useful to generate
- * files that are guaranteed (or at least very likely) to be unique in both those ways.
- * This generates a number of filenames with random names and random content (colored triangles)
+ * Because MediaWiki tests the uniqueness of media upload content, and
+ * filenames, it is sometimes useful to generate files that are guaranteed (or
+ * at least very likely) to be unique in both those ways. This generates a
+ * number of filenames with random names and random content (colored triangles).
*
- * It is also useful to have fresh content because our tests currently run in a "destructive" mode, and don't create a fresh new wiki for each
- * test run.
- * Consequently, if we just had a few static files we kept re-uploading, we'd get lots of warnings about matching content or filenames,
- * and even if we deleted those files, we'd get warnings about archived files.
+ * It is also useful to have fresh content because our tests currently run in a
+ * "destructive" mode, and don't create a fresh new wiki for each test run.
+ * Consequently, if we just had a few static files we kept re-uploading, we'd
+ * get lots of warnings about matching content or filenames, and even if we
+ * deleted those files, we'd get warnings about archived files.
*
- * This can also be used with a cronjob to generate random files all the time -- I use it to have a constant, never ending supply when I'm
- * testing interactively.
+ * This can also be used with a cronjob to generate random files all the time.
+ * I use it to have a constant, never ending supply when I'm testing
+ * interactively.
*
* @file
* @author Neil Kandalgaonkar <neilk@wikimedia.org>
* Can fetch a random image, or also write a number of them to disk with random filenames.
*/
class RandomImageGenerator {
-
private $dictionaryFile;
private $minWidth = 400;
private $maxWidth = 800;
private $shapesToDraw = 5;
/**
- * Orientations: 0th row, 0th column, Exif orientation code, rotation 2x2 matrix that is opposite of orientation
- * n.b. we do not handle the 'flipped' orientations, which is why there is no entry for 2, 4, 5, or 7. Those
- * seem to be rare in real images anyway
- * (we also would need a non-symmetric shape for the images to test those, like a letter F)
+ * Orientations: 0th row, 0th column, Exif orientation code, rotation 2x2
+ * matrix that is opposite of orientation. N.b. we do not handle the
+ * 'flipped' orientations, which is why there is no entry for 2, 4, 5, or 7.
+ * Those seem to be rare in real images anyway (we also would need a
+ * non-symmetric shape for the images to test those, like a letter F).
*/
private static $orientations = array(
array(
);
public function __construct( $options = array() ) {
- foreach ( array( 'dictionaryFile', 'minWidth', 'minHeight', 'maxWidth', 'maxHeight', 'shapesToDraw' ) as $property ) {
+ foreach ( array( 'dictionaryFile', 'minWidth', 'minHeight',
+ 'maxWidth', 'maxHeight', 'shapesToDraw' ) as $property
+ ) {
if ( isset( $options[$property] ) ) {
$this->$property = $options[$property];
}
}
}
if ( !isset( $this->dictionaryFile ) ) {
- throw new Exception( "RandomImageGenerator: dictionary file not found or not specified properly" );
+ throw new Exception( "RandomImageGenerator: dictionary file not "
+ . "found or not specified properly" );
}
}
/**
- * Writes random images with random filenames to disk in the directory you specify, or current working directory
+ * Writes random images with random filenames to disk in the directory you
+ * specify, or current working directory.
*
- * @param $number Integer: number of filenames to write
- * @param $format String: optional, must be understood by ImageMagick, such as 'jpg' or 'gif'
- * @param $dir String: directory, optional (will default to current working directory)
- * @return Array: filenames we just wrote
+ * @param int $number Number of filenames to write
+ * @param string $format Optional, must be understood by ImageMagick, such as 'jpg' or 'gif'
+ * @param string $dir Directory, optional (will default to current working directory)
+ * @return array Filenames we just wrote
*/
function writeImages( $number, $format = 'jpg', $dir = null ) {
$filenames = $this->getRandomFilenames( $number, $format, $dir );
global $wgExiv2Command;
if ( class_exists( 'Imagick' ) && $wgExiv2Command && is_executable( $wgExiv2Command ) ) {
return 'writeImageWithApi';
- } elseif ( $wgUseImageMagick && $wgImageMagickConvertCommand && is_executable( $wgImageMagickConvertCommand ) ) {
+ } elseif ( $wgUseImageMagick
+ && $wgImageMagickConvertCommand
+ && is_executable( $wgImageMagickConvertCommand )
+ ) {
return 'writeImageWithCommandLine';
}
}
- throw new Exception( "RandomImageGenerator: could not find a suitable method to write images in '$format' format" );
+ throw new Exception( "RandomImageGenerator: could not find a suitable "
+ . "method to write images in '$format' format" );
}
/**
* Return a number of randomly-generated filenames
* Each filename uses two words randomly drawn from the dictionary, like elephantine_spatula.jpg
*
- * @param $number Integer: of filenames to generate
- * @param $extension String: optional, defaults to 'jpg'
- * @param $dir String: optional, defaults to current working directory
- * @return Array: of filenames
+ * @param int $number Number of filenames to generate
+ * @param string $extension Optional, defaults to 'jpg'
+ * @param string $dir Optional, defaults to current working directory
+ * @return array Array of filenames
*/
private function getRandomFilenames( $number, $extension = 'jpg', $dir = null ) {
if ( is_null( $dir ) ) {
/**
* Generate data representing an image of random size (within limits),
- * consisting of randomly colored and sized upward pointing triangles against a random background color
- * (This data is used in the writeImage* methods).
- * @return {Mixed}
+ * consisting of randomly colored and sized upward pointing triangles
+ * against a random background color. (This data is used in the
+ * writeImage* methods).
+ *
+ * @return mixed
*/
public function getImageSpec() {
$spec = array();
* Given array( array('x' => 10, 'y' => 20), array( 'x' => 30, y=> 5 ) )
* returns "10,20 30,5"
* Useful for SVG and imagemagick command line arguments
- * @param $shape: Array of arrays, each array containing x & y keys mapped to numeric values
+ * @param array $shape Array of arrays, each array containing x & y keys mapped to numeric values
* @return string
*/
static function shapePointsToString( $shape ) {
* Based on image specification, write a very simple SVG file to disk.
* Ignores the background spec because transparency is cool. :)
*
- * @param array $spec spec describing background and shapes to draw
- * @param string $format file format to write (which is obviously always svg here)
- * @param string $filename filename to write to
+ * @param array $spec Spec describing background and shapes to draw
+ * @param string $format File format to write (which is obviously always svg here)
+ * @param string $filename Filename to write to
*
* @throws Exception
*/
/**
* Based on an image specification, write such an image to disk, using Imagick PHP extension
- * @param array $spec spec describing background and circles to draw
- * @param string $format file format to write
- * @param string $filename filename to write to
+ * @param array $spec Spec describing background and circles to draw
+ * @param string $format File format to write
+ * @param string $filename Filename to write to
*/
public function writeImageWithApi( $spec, $format, $filename ) {
// this is a hack because I can't get setImageOrientation() to work. See below.
$image = new Imagick();
/**
- * If the format is 'jpg', will also add a random orientation -- the image will be drawn rotated with triangle points
- * facing in some direction (0, 90, 180 or 270 degrees) and a countering rotation should turn the triangle points upward again
+ * If the format is 'jpg', will also add a random orientation -- the
+ * image will be drawn rotated with triangle points facing in some
+ * direction (0, 90, 180 or 270 degrees) and a countering rotation
+ * should turn the triangle points upward again.
*/
$orientation = self::$orientations[0]; // default is normal orientation
if ( $format == 'jpg' ) {
$image->writeImage( $filename );
- // because the above setImageOrientation call doesn't work... nor can I get an external imagemagick binary to do this either...
- // hacking this for now (only works if you have exiv2 installed, a program to read and manipulate exif)
+ // because the above setImageOrientation call doesn't work... nor can I
+ // get an external imagemagick binary to do this either... Hacking this
+ // for now (only works if you have exiv2 installed, a program to read
+ // and manipulate exif).
if ( $wgExiv2Command ) {
$cmd = wfEscapeShellArg( $wgExiv2Command )
. " -M "
/**
* Given an image specification, produce rotated version
* This is used when simulating a rotated image capture with Exif orientation
- * @param $spec Object returned by getImageSpec
- * @param $matrix 2x2 transformation matrix
+ * @param array $spec Returned by getImageSpec
+ * @param array $matrix 2x2 transformation matrix
* @return array transformed Spec
*/
private static function rotateImageSpec( &$spec, $matrix ) {
/**
* Given a matrix and a pair of images, return new position
- * @param $matrix: 2x2 rotation matrix
- * @param $x: x-coordinate number
- * @param $y: y-coordinate number
- * @return Array transformed with properties x, y
+ * @param array $matrix 2x2 rotation matrix
+ * @param int $x x-coordinate number
+ * @param int $y y-coordinate number
+ * @return array Transformed with properties x, y
*/
private static function matrixMultiply2x2( $matrix, $x, $y ) {
return array(
}
/**
- * Based on an image specification, write such an image to disk, using the command line ImageMagick program ('convert').
+ * Based on an image specification, write such an image to disk, using the
+ * command line ImageMagick program ('convert').
*
* Sample command line:
* $ convert -size 100x60 xc:rgb(90,87,45) \
* -draw 'fill rgb(99,123,231) circle 59,39 56,57' \
* -draw 'fill rgb(240,12,32) circle 50,21 50,3' filename.png
*
- * @param array $spec spec describing background and shapes to draw
- * @param string $format file format to write (unused by this method but kept so it has the same signature as
- * writeImageWithApi)
- * @param string $filename filename to write to
+ * @param array $spec Spec describing background and shapes to draw
+ * @param string $format File format to write (unused by this method but
+ * kept so it has the same signature as writeImageWithApi).
+ * @param string $filename Filename to write to
*
* @return bool
*/
}
/**
- * Get an array of random pairs of random words, like array( array( 'foo', 'bar' ), array( 'quux', 'baz' ) );
+ * Get an array of random pairs of random words, like
+ * array( array( 'foo', 'bar' ), array( 'quux', 'baz' ) );
*
- * @param $number Integer: number of pairs
- * @return Array: of two-element arrays
+ * @param int $number Number of pairs
+ * @return array two-element arrays
*/
private function getRandomWordPairs( $number ) {
$lines = $this->getRandomLines( $number * 2 );
* @param int $number_desired number of lines desired
*
* @throws Exception
- * @return array of exactly n elements, drawn randomly from lines the file
+ * @return array Array of exactly n elements, drawn randomly from lines the file
*/
private function getRandomLines( $number_desired ) {
$filepath = $this->dictionaryFile;
}
/*
- * This algorithm obtains N random lines from a file in one single pass. It does this by replacing elements of
- * a fixed-size array of lines, less and less frequently as it reads the file.
+ * This algorithm obtains N random lines from a file in one single pass.
+ * It does this by replacing elements of a fixed-size array of lines,
+ * less and less frequently as it reads the file.
*/
$fh = fopen( $filepath, "r" );
if ( !$fh ) {
dépôts / lhc / web / wiklou.git / blobdiff