buildzip.php

#!/usr/bin/env php -d memory_limit=256M
<?php
/*
   The goal of that php CLI script is to make zip package of your module
   as an alternative to web "build zip" or "perl script makepack"
*/
 
// ============================================= configuration
 
$listOfModuleContent = [
  'admin',
  'ajax',
  'backport',
  'class',
  'css',
  'COPYING',
  'core',
  'img',
  'js',
  'langs',
  'lib',
  'sql',
  'tpl',
  '*.md',
  '*.json',
  '*.php',
  'modulebuilder.txt',
];
 
$exclude_list = [
  '/^.git$/',
  '/.*js.map/',
  '/DEV.md/'
];
 
// ============================================= end of configuration
 
function detectModule()
{
  $name  = $version = "";
  $tab = glob("core/modules/mod*.class.php");
  if (count($tab) == 0) {
    echo "[fail] Error on auto detect data : there is no mod*.class.php file into core/modules dir\n";
    exit(1);
  }
  if (count($tab) == 1) {
    $file = $tab[0];
    $pattern = "/.*mod(?<mod>.*)\.class\.php/";
    if (preg_match_all($pattern, $file, $matches)) {
      $name = strtolower(reset($matches['mod']));
    }
 
    echo "extract data from $file\n";
    if (!file_exists($file) || $name == "") {
      echo "[fail] Error on auto detect data\n";
      exit(2);
    }
  } else {
    echo "[fail] Error there is more than one mod*.class.php file into core/modules dir\n";
    exit(3);
  }
 
  //extract version from file
  $contents = file_get_contents($file);
  $pattern = "/^.*this->version\s*=\s*'(?<version>.*)'\s*;.*\$/m";
 
  // search, and store all matching occurrences in $matches
  if (preg_match_all($pattern, $contents, $matches)) {
    $version = reset($matches['version']);
  }
 
  if (version_compare($version, '0.0.1', '>=') != 1) {
    echo "[fail] Error auto extract version fail\n";
    exit(4);
  }
 
  echo "module name = $name, version = $version\n";
  return [(string) $name, (string) $version];
}
 
function delTree($dir)
{
  $files = array_diff(scandir($dir), array('.', '..'));
  foreach ($files as $file) {
    (is_dir("$dir/$file")) ? delTree("$dir/$file") : secureUnlink("$dir/$file");
  }
  return rmdir($dir);
}
 
 
function secureUnlink($path)
{
  if (file_exists($path)) {
    if (unlink($path)) {
      //then check if really deleted
      clearstatcache();
      if (file_exists($path)) { // @phpstan-ignore-line
        echo "[fail] unlink of $path fail !\n";
        exit(5);
      }
    } else {
      echo "[fail] unlink of $path fail !\n";
      exit(6);
    }
  }
  return true;
}
 
function mkdirAndCheck($path)
{
  if (mkdir($path)) {
    clearstatcache();
    if (is_dir($path)) {
      return true;
    }
  }
  echo "[fail] Error on $path (mkdir)\n";
  exit(7);
}
 
function is_excluded($filename)
{
  global $exclude_list;
  $count = 0;
  $notused = preg_filter($exclude_list, '1', $filename, -1, $count);
  if ($count > 0) {
    echo " - exclude $filename\n";
    return true;
  }
  return false;
}
 
function rcopy($src, $dst)
{
  if (is_dir($src)) {
    // Make the destination directory if not exist
    mkdirAndCheck($dst);
    // open the source directory
    $dir = opendir($src);
 
    // Loop through the files in source directory
    while ($file = readdir($dir)) {
      if (($file != '.') && ($file != '..')) {
        if (is_dir($src . '/' . $file)) {
          // Recursively calling custom copy function
          // for sub directory
          if (!rcopy($src . '/' . $file, $dst . '/' . $file)) {
            return false;
          }
        } else {
          if (!is_excluded($file)) {
            if (!copy($src . '/' . $file, $dst . '/' . $file)) {
              return false;
            }
          }
        }
      }
    }
    closedir($dir);
  } elseif (is_file($src)) {
    if (!is_excluded($src)) {
      if (!copy($src, $dst)) {
        return false;
      }
    }
  }
  return true;
}
 
function zipDir($folder, &$zip, $root = "")
{
  foreach (new \DirectoryIterator($folder) as $f) {
    if ($f->isDot()) {
      continue;
    } //skip . ..
    $src = $folder . '/' . $f;
    $dst = substr($f->getPathname(), strlen($root));
    if ($f->isDir()) {
      if ($zip->addEmptyDir($dst)) {
        if (zipDir($src, $zip, $root)) {
          continue;
        } else {
          return false;
        }
      } else {
        return false;
      }
    }
    if ($f->isFile()) {
      if (! $zip->addFile($src, $dst)) {
        return false;
      }
    }
  }
  return true;
}
 
list($mod, $version) = detectModule();
$outzip = sys_get_temp_dir() . "/module_" . $mod . "-" . $version . ".zip";
if (file_exists($outzip)) {
  secureUnlink($outzip);
}
 
//copy all sources into system temp directory
$tmpdir = tempnam(sys_get_temp_dir(), $mod . "-module");
secureUnlink($tmpdir);
mkdirAndCheck($tmpdir);
$dst = $tmpdir . "/" . $mod;
mkdirAndCheck($dst);
 
foreach ($listOfModuleContent as $moduleContent) {
  foreach (glob($moduleContent) as $entry) {
    if (!rcopy($entry, $dst . '/' . $entry)) {
      echo "[fail]  Error on copy " . $entry . " to " . $dst . "/" . $entry . "\n";
      echo "Please take time to analyze the problem and fix the bug\n";
      exit(8);
    }
  }
}
 
$z = new ZipArchive();
$z->open($outzip, ZipArchive::CREATE);
zipDir($tmpdir, $z, $tmpdir . '/');
$z->close();
delTree($tmpdir);
if (file_exists($outzip)) {
  echo "[success] module archive is ready : $outzip ...\n";
} else {
  echo "[fail] build zip error\n";
  exit(9);
}