X-Git-Url: https://git.cweiske.de/surrogator.git/blobdiff_plain/c083f00a1813729162aca77fcc72642c5b7eb6b0..fc412baac7378a01d9c5ab90405365b56d3abe4b:/surrogator.php

diff --git a/surrogator.php b/surrogator.php
index 6270cdc..fdbd384 100755
--- a/surrogator.php
+++ b/surrogator.php
@@ -1,5 +1,18 @@
 #!/usr/bin/env php
 <?php
+/**
+ * Tool to create avatar images in different sizes.
+ *
+ * Part of Surrogator - a simple libravatar avatar image server
+ *
+ * PHP version 5
+ *
+ * @category Tools
+ * @package  Surrogator
+ * @author   Christian Weiske <cweiske@cweiske.de>
+ * @license  http://www.gnu.org/licenses/agpl.html AGPLv3 or later
+ * @link     https://sourceforge.net/p/surrogator/
+ */
 namespace surrogator;
 $cfgFile = __DIR__ . '/data/surrogator.config.php';
 if (!file_exists($cfgFile)) {
@@ -39,6 +52,11 @@ foreach ($argv as $arg) {
     }
 }
 
+/**
+ * Echos the --help screen.
+ *
+ * @return void
+ */
 function showHelp()
 {
     echo <<<HLP
@@ -97,6 +115,18 @@ foreach ($sizes as $size) {
         mkdir($varDir . '/' . $size, 0755);
     }
 }
+foreach (array('mm.png', 'default.png') as $resFile) {
+    if (!file_exists($rawDir . '/' . $resFile)) {
+        log($resFile . ' missing, copying it from res/', 2);
+        copy($resDir . '/' . $resFile, $rawDir . '/' . $resFile);
+    }
+}
+foreach (array('index.html', 'robots.txt', 'favicon.ico') as $resFile) {
+    if (!file_exists($wwwDir . '/' . $resFile) && is_writable($wwwDir)) {
+        log('no www/' . $resFile . ' found, copying default over', 1);
+        copy($resDir . '/www/' . $resFile, $wwwDir . '/' . $resFile);
+    }
+}
 
 if (count($files)) {
     $fileInfos = array();
@@ -117,7 +147,7 @@ foreach ($fileInfos as $fileInfo) {
         . substr($fileName, 0, -strlen($ext)) . 'png';
 
     log('processing ' . $fileName, 1);
-    if (image_uptodate($origPath, $squarePath)) {
+    if (imageUptodate($origPath, $squarePath)) {
         log(' image up to date', 2);
         continue;
     }
@@ -128,6 +158,8 @@ foreach ($fileInfos as $fileInfo) {
 
     if ($fileName == 'default.png') {
         $md5 = $sha256 = 'default';
+    } else if ($fileName == 'mm.png') {
+        $md5 = $sha256 = 'mm';
     } else {
         list($md5, $sha256) = getHashes($fileName);
     }
@@ -148,7 +180,7 @@ foreach ($fileInfos as $fileInfo) {
             imagecolorallocatealpha($imgSize, 0, 0, 0, 127)
         );
         imagecopyresampled(
-            $imgSize, $imgSquare, 
+            $imgSize, $imgSquare,
             0, 0, 0, 0,
             $size, $size, $maxSize, $maxSize
         );
@@ -156,11 +188,18 @@ foreach ($fileInfos as $fileInfo) {
         imagepng($imgSize, $sizePathMd5);
         imagepng($imgSize, $sizePathSha256);
         imagedestroy($imgSize);
-        
+
     }
     imagedestroy($imgSquare);
 }
 
+/**
+ * Create and return md5 and sha256 hashes from a filename.
+ *
+ * @param string $fileName filename without path, e.g. "foo@example.org.png"
+ *
+ * @return array Array with 2 values: md5 and sha256 hash
+ */
 function getHashes($fileName)
 {
     $fileNameNoExt = substr($fileName, 0, -strlen(strrpos($fileName, '.')) - 2);
@@ -171,7 +210,17 @@ function getHashes($fileName)
     );
 }
 
-
+/**
+ * Creates the square image from the given image in maximum size.
+ * Scales the image up or down and makes the non-covered parts transparent.
+ *
+ * @param string  $origPath   Full path to original image
+ * @param string  $ext        File extension ("jpg" or "png")
+ * @param string  $targetPath Full path to target image file
+ * @param integer $maxSize    Maxium image size the server supports
+ *
+ * @return boolean True if all went well, false if there was an error
+ */
 function createSquare($origPath, $ext, $targetPath, $maxSize)
 {
     if ($ext == 'png') {
@@ -207,7 +256,7 @@ function createSquare($origPath, $ext, $targetPath, $maxSize)
     $nHeight = (int)($oHeight * $flScale);
 
     imagecopyresampled(
-        $imgSquare, $imgOrig, 
+        $imgSquare, $imgOrig,
         ($maxSize - $nWidth) / 2, ($maxSize - $nHeight) / 2,
         0, 0,
         $nWidth, $nHeight,
@@ -222,7 +271,15 @@ function createSquare($origPath, $ext, $targetPath, $maxSize)
     return true;
 }
 
-function image_uptodate($sourcePath, $targetPath)
+/**
+ * Check if the target file is newer than the source file.
+ *
+ * @param string $sourcePath Full source file path
+ * @param string $targetPath Full target file path
+ *
+ * @return boolean True if target file is newer than the source file
+ */
+function imageUptodate($sourcePath, $targetPath)
 {
     global $forceUpdate;
     if ($forceUpdate) {
@@ -239,6 +296,14 @@ function image_uptodate($sourcePath, $targetPath)
     return true;
 }
 
+/**
+ * Write a log message to stdout
+ *
+ * @param string  $msg   Message to write
+ * @param integer $level Log level - 1 is important, 3 is unimportant
+ *
+ * @return void
+ */
 function log($msg, $level = 1)
 {
     global $logLevel;
@@ -247,6 +312,13 @@ function log($msg, $level = 1)
     }
 }
 
+/**
+ * Write an error message to stderr
+ *
+ * @param string $msg Message to write
+ *
+ * @return void
+ */
 function logErr($msg)
 {
     file_put_contents('php://stderr', $msg . "\n");