4 * Tool to create avatar images in different sizes.
6 * Part of Surrogator - a simple libravatar avatar image server
12 * @author Christian Weiske <cweiske@cweiske.de>
13 * @license http://www.gnu.org/licenses/agpl.html AGPLv3 or later
14 * @link http://git.cweiske.de/?p=surrogator.git
17 $cfgFile = __DIR__ . '/data/surrogator.config.php';
18 if (!file_exists($cfgFile)) {
19 $cfgFile = '/etc/surrogator.config.php';
20 if (!file_exists($cfgFile)) {
22 "Configuration file does not exist.\n"
23 . "Copy data/surrogator.config.php.dist to data/surrogator.config.php"
32 foreach ($argv as $arg) {
33 if ($arg == '-v' || $arg == '--verbose') {
35 } else if ($arg == '-vv') {
37 } else if ($arg == '-q' || $arg == '--quiet') {
39 } else if ($arg == '-f' || $arg == '--force') {
41 } else if ($arg == '-h' || $arg == '--help') {
44 } else if ($arg == '--version') {
45 echo "surrogator 0.0.1\n";
47 } else if (file_exists($arg)) {
50 logErr('Unknown argument: ' . $arg);
56 * Echos the --help screen.
63 Usage: php surrogator.php [options] [filename(s)]
65 surrogator - a simple libravatar server
66 Put files in raw/ dir and run surrogator.php to generate different sizes
71 -v, --verbose Be verbose (more log messages, also -vv)
72 -q, --quiet Be quiet (no log messages)
73 -f, --force Force update of all files
74 --version Show program version
76 filenames One or several files whose small images shall get generated.
77 If none given, all will be checked
82 if (!isset($rawDir)) {
83 logErr('$rawDir not set');
86 if (!isset($varDir)) {
87 logErr('$varDir not set');
91 logErr('$sizes not set');
94 if (!isset($maxSize)) {
95 logErr('$maxSize not set');
98 if (!isset($logLevel)) {
99 logErr('$logLevel not set');
104 if (!is_dir($varDir . '/square')) {
105 log('creating square dir: ' . $varDir . '/square');
106 if (!mkdir($varDir . '/square', 0755, true)) {
107 logErr('cannot create square dir');
111 log('sizes: ' . implode(', ', $sizes), 2);
112 foreach ($sizes as $size) {
113 if (!is_dir($varDir . '/' . $size)) {
114 log('creating size dir: ' . $varDir . '/' . $size);
115 mkdir($varDir . '/' . $size, 0755);
118 if (!file_exists($rawDir . '/mm.png')) {
119 log('mm.png missing, copying it from res/', 2);
120 copy(__DIR__ . '/res/mm.png', $rawDir . '/mm.png');
124 $fileInfos = array();
125 foreach ($files as $file) {
126 $fileInfos[] = new \SplFileInfo($file);
129 $fileInfos = new \RegexIterator(
130 new \DirectoryIterator($rawDir),
134 foreach ($fileInfos as $fileInfo) {
135 $origPath = $fileInfo->getPathname();
136 $fileName = $fileInfo->getFilename();
137 $ext = strtolower(substr($fileName, strrpos($fileName, '.') + 1));
138 $squarePath = $varDir . '/square/'
139 . substr($fileName, 0, -strlen($ext)) . 'png';
141 log('processing ' . $fileName, 1);
142 if (imageUptodate($origPath, $squarePath)) {
143 log(' image up to date', 2);
147 if (!createSquare($origPath, $ext, $squarePath, $maxSize)) {
151 if ($fileName == 'default.png') {
152 $md5 = $sha256 = 'default';
153 } else if ($fileName == 'mm.png') {
154 $md5 = $sha256 = 'mm';
156 list($md5, $sha256) = getHashes($fileName);
159 log(' creating sizes for ' . $fileName, 2);
160 log(' md5: ' . $md5, 3);
161 log(' sha256: ' . $sha256, 3);
162 $imgSquare = imagecreatefrompng($squarePath);
163 foreach ($sizes as $size) {
164 log(' size ' . $size, 3);
165 $sizePathMd5 = $varDir . '/' . $size . '/' . $md5 . '.png';
166 $sizePathSha256 = $varDir . '/' . $size . '/' . $sha256 . '.png';
168 $imgSize = imagecreatetruecolor($size, $size);
169 imagealphablending($imgSize, false);
170 imagefilledrectangle(
171 $imgSize, 0, 0, $size - 1, $size - 1,
172 imagecolorallocatealpha($imgSize, 0, 0, 0, 127)
175 $imgSize, $imgSquare,
177 $size, $size, $maxSize, $maxSize
179 imagesavealpha($imgSize, true);
180 imagepng($imgSize, $sizePathMd5);
181 imagepng($imgSize, $sizePathSha256);
182 imagedestroy($imgSize);
185 imagedestroy($imgSquare);
189 * Create and return md5 and sha256 hashes from a filename.
191 * @param string $fileName filename without path, e.g. "foo@example.org.png"
193 * @return array Array with 2 values: md5 and sha256 hash
195 function getHashes($fileName)
197 $fileNameNoExt = substr($fileName, 0, -strlen(strrpos($fileName, '.')) - 2);
198 $emailAddress = trim(strtolower($fileNameNoExt));
201 md5($emailAddress), hash('sha256', $emailAddress)
206 * Creates the square image from the given image in maximum size.
207 * Scales the image up or down and makes the non-covered parts transparent.
209 * @param string $origPath Full path to original image
210 * @param string $ext File extension ("jpg" or "png")
211 * @param string $targetPath Full path to target image file
212 * @param integer $maxSize Maxium image size the server supports
214 * @return boolean True if all went well, false if there was an error
216 function createSquare($origPath, $ext, $targetPath, $maxSize)
219 $imgOrig = imagecreatefrompng($origPath);
220 } else if ($ext == 'jpg' || $ext == 'jpeg') {
221 $imgOrig = imagecreatefromjpeg($origPath);
227 if ($imgOrig === false) {
228 logErr('Error loading image file: ' . $origPath);
232 $imgSquare = imagecreatetruecolor($maxSize, $maxSize);
233 imagealphablending($imgSquare, false);
234 imagefilledrectangle(
235 $imgSquare, 0, 0, $maxSize - 1, $maxSize - 1,
236 imagecolorallocatealpha($imgSquare, 0, 0, 0, 127)
238 imagealphablending($imgSquare, true);
240 $oWidth = imagesx($imgOrig);
241 $oHeight = imagesy($imgOrig);
242 if ($oWidth > $oHeight) {
243 $flScale = $maxSize / $oWidth;
245 $flScale = $maxSize / $oHeight;
247 $nWidth = (int)($oWidth * $flScale);
248 $nHeight = (int)($oHeight * $flScale);
251 $imgSquare, $imgOrig,
252 ($maxSize - $nWidth) / 2, ($maxSize - $nHeight) / 2,
258 imagesavealpha($imgSquare, true);
259 imagepng($imgSquare, $targetPath);
261 imagedestroy($imgSquare);
262 imagedestroy($imgOrig);
267 * Check if the target file is newer than the source file.
269 * @param string $sourcePath Full source file path
270 * @param string $targetPath Full target file path
272 * @return boolean True if target file is newer than the source file
274 function imageUptodate($sourcePath, $targetPath)
280 if (!file_exists($targetPath)) {
283 if (filemtime($sourcePath) > filemtime($targetPath)) {
292 * Write a log message to stdout
294 * @param string $msg Message to write
295 * @param integer $level Log level - 1 is important, 3 is unimportant
299 function log($msg, $level = 1)
302 if ($level <= $logLevel) {
308 * Write an error message to stderr
310 * @param string $msg Message to write
314 function logErr($msg)
316 file_put_contents('php://stderr', $msg . "\n");