Install script to fetch javascript dependencies defined in jsdeps.json (#5535)

1 files changed, 279 insertions, 0 deletions

diff --git a/bin/install-jsdeps.sh b/bin/install-jsdeps.sh
new file mode 100755
index 000000000..d34fb7f6b
--- /dev/null
+++ b/bin/install-jsdeps.sh
@@ -0,0 +1,279 @@
+#!/usr/bin/env php
+<?php
+/*
+ +-----------------------------------------------------------------------+
+ | bin/install-jsdeps.sh                                                 |
+ |                                                                       |
+ | This file is part of the Roundcube Webmail client                     |
+ | Copyright (C) 2015, The Roundcube Dev Team                            |
+ |                                                                       |
+ | Licensed under the GNU General Public License version 3 or            |
+ | any later version with exceptions for skins & plugins.                |
+ | See the README file for a full license statement.                     |
+ |                                                                       |
+ | PURPOSE:                                                              |
+ |   Utility script to fetch and install all 3rd party javascript        |
+ |   libraries unsed in Roundcube from source.                           |
+ +-----------------------------------------------------------------------+
+ | Author: Thomas Bruederli <thomas@roundcube.net>                       |
+ +-----------------------------------------------------------------------+
+*/
+
+define('INSTALL_PATH', realpath(__DIR__ . '/..') . '/' );
+
+require_once INSTALL_PATH . 'program/include/clisetup.php';
+
+$SOURCES = json_decode(file_get_contents(INSTALL_PATH . 'jsdeps.json'), true);
+
+if (empty($SOURCES['dependencies'])) {
+  die("ERROR: Failed to read sources from " . INSTALL_PATH . "jsdeps.json\n");
+}
+
+$CURL = trim(`which curl`);
+$WGET = trim(`which wget`);
+$UNZIP = trim(`which unzip`);
+$FILEINFO = trim(`which file`);
+
+$CACHEDIR = sys_get_temp_dir();
+
+if (is_writeable(INSTALL_PATH . 'temp/js_cache') || mkdir(INSTALL_PATH . 'temp/js_cache', 0774, true)) {
+  $CACHEDIR = INSTALL_PATH . 'temp/js_cache';
+}
+
+
+//////////////// License definitions
+
+$LICENSES = array();
+$LICENSES['MIT'] = <<<EOM
+ * Licensed under the MIT licenses
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+EOM;
+
+$LICENSES['GPLv3'] = <<<EOG
+ * The JavaScript code in this page is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU
+ * General Public License (GNU GPL) as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option)
+ * any later version.  The code is distributed WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
+ *
+ * As additional permission under GNU GPL version 3 section 7, you
+ * may distribute non-source (e.g., minimized or compacted) forms of
+ * that code without the copy of the GNU GPL normally required by
+ * section 4, provided you include this license notice and a URL
+ * through which recipients can access the Corresponding Source.
+
+EOG;
+
+$LICENSES['LGPL'] = <<<EOL
+ * The JavaScript code in this page is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU
+ * Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option)
+ * any later version.
+
+EOL;
+
+
+//////////////// Functions
+
+/**
+ *
+ */
+function fetch_from_source($package, $useCache = true, &$filetype = null)
+{
+  global $CURL, $FILEINFO, $CACHEDIR;
+
+  $filetype = pathinfo($package['url'], PATHINFO_EXTENSION) ?: 'tmp';
+  $cache_file = $CACHEDIR . '/' . $package['lib'] . '-' . $package['version'] . '.' . $filetype;
+
+  if (!is_readable($cache_file)) {
+    echo "Fetching $package[url]\n";
+    exec(sprintf('%s -s %s -o %s', $CURL, escapeshellarg($package['url']), $cache_file), $out, $retval);
+    if ($retval !== 0) {
+      die("ERROR: Failed to download source file from " . $package['url'] . "\n");
+    }
+  }
+
+  if (!empty($package['sha1']) && ($sum = sha1_file($cache_file)) !== $package['sha1']) {
+    die("ERROR: Incorrect sha1 sum of $cache_file. Expected: $package[sha1], got: $sum\n");
+  }
+
+  // detect downloaded/cached file type
+  exec(sprintf('%s -b %s', $FILEINFO, $cache_file), $out);
+  if (stripos($out[0], 'zip') === 0) {
+    $filetype = 'zip';
+  }
+
+  return $cache_file;
+}
+
+/**
+ *
+ */
+function compose_destfile($package, $srcfile)
+{
+  global $LICENSES;
+
+  $header = sprintf("/**\n * %s - v%s\n *\n", $package['name'], $package['version']);
+
+  if (!empty($package['source'])) {
+    $header .= " * @source " . $package['source'] . "\n";
+    $header .= " *\n";
+  }
+
+  if (!empty($package['license']) && isset($LICENSES[$package['license']])) {
+    $header .= " * @licstart  The following is the entire license notice for the\n";
+    $header .= " * JavaScript code in this file.\n";
+    $header .= " *\n";
+    if (!empty($package['copyright'])) {
+      $header .= " * " . $package['copyright'] . "\n";
+      $header .= " *\n";
+    }
+
+    $header .= $LICENSES[$package['license']];
+    $header .= " *\n";
+    $header .= " * @licend  The above is the entire license notice\n";
+    $header .= " * for the JavaScript code in this file.\n";
+  }
+
+  $header .= " */\n";
+
+  if (file_put_contents(INSTALL_PATH . $package['dest'], $header . file_get_contents($srcfile))) {
+    echo "Wrote file " . INSTALL_PATH . $package['dest'] . "\n";
+  }
+  else {
+    die("ERROR: Failed to write destination file " . INSTALL_PATH . $package['dest'] . "\n");
+  }
+}
+
+/**
+ *
+ */
+function extrac_zipfile($package, $srcfile)
+{
+  global $UNZIP, $CACHEDIR;
+
+  $destdir = INSTALL_PATH . $package['dest'];
+  if (!is_dir($destdir)) {
+    mkdir($destdir, 0774, true);
+  }
+
+  if (!is_writeable($destdir)) {
+    die("ERROR: Cannot write to destination directory $destdir\n");
+  }
+
+  // pick files from zip archive
+  if (!empty($package['pick'])) {
+    foreach ($package['pick'] as $pattern) {
+      echo "Extracting files $pattern into $destdir\n";
+      exec(sprintf('%s -o %s %s -d %s', $UNZIP, escapeshellarg($srcfile), escapeshellarg($pattern), $destdir), $out, $retval);
+      if ($retval !== 0) {
+        echo "ERROR: Failed to unpack $pattern; " . join('; ' . $out) . "\n";
+      }
+    }
+  }
+  // unzip the archive and map source to dest files/directories
+  else if (!empty($package['map'])) {
+    $extract = $CACHEDIR . '/' . $package['lib'] . '-extract';
+    exec(sprintf('%s -o %s -d %s', $UNZIP, escapeshellarg($srcfile), $extract), $out, $retval);
+
+    foreach ($package['map'] as $src => $dest) {
+      echo "Installing files $extract/$src into $destdir/$dest\n";
+
+      // make sure the destination's parent directory exists
+      if (strpos($dest, '/') !== false) {
+        $parentdir = dirname($destdir . '/' . $dest);
+        if (!is_dir($parentdir)) {
+          mkdir($parentdir, 0774, true);
+        }
+      }
+
+      // avoid copying source directory as a child into destination
+      if (is_dir($extract . '/' . $src) && is_dir($destdir . '/' . $dest)) {
+        exec(sprintf('rm -rf %s/%s', $destdir, $dest));
+      }
+
+      exec(sprintf('mv -f %s/%s %s/%s', $extract, $src, $destdir, $dest), $out, $retval);
+      if ($retval !== 0) {
+        echo "ERROR: Failed to move $src into $destdir/$dest; " . join('; ' . $out) . "\n";
+      }
+    }
+
+    // remove temp extraction dir
+    exec('rm -rf ' . $extract);
+  }
+  // extract the archive into the destination directory
+  else {
+    echo "Extracting zip archive into $destdir\n";
+    exec(sprintf('%s -o %s -d %s', $UNZIP, escapeshellarg($srcfile), $destdir), $out, $retval);
+    if ($retval !== 0) {
+      echo "ERROR: Failed to unzip $srcfile; " . join('; ' . $out) . "\n";
+    }
+  }
+
+  // remove some files from the destination
+  if (!empty($package['omit'])) {
+    foreach ((array)$package['omit'] as $glob) {
+      exec(sprintf('rm -rf %s/%s', $destdir, escapeshellarg($glob)));
+    }
+  }
+
+  // prepend license header to extracted files
+  if (!empty($package['addlicense'])) {
+    foreach ((array)$package['addlicense'] as $filename) {
+      $pkg = $package;
+      $pkg['dest'] = $package['dest'] . '/' . $filename;
+      compose_destfile($pkg, $destdir . '/' . $filename);
+    }
+  }
+}
+
+
+//////////////// Execution
+
+$WHAT = isset($_SERVER['argv'][1]) ? $_SERVER['argv'][1] : null;
+
+foreach ($SOURCES['dependencies'] as $package) {
+  if (!isset($package['name'])) {
+    $package['name'] = $package['lib'];
+  }
+
+  if ($WHAT && $package['lib'] !== $WHAT) {
+    continue;
+  }
+
+  echo "Installing $package[name]...\n";
+
+  $srcfile = fetch_from_source($package, true, $filetype);
+
+  if ($filetype === 'zip') {
+    extrac_zipfile($package, $srcfile);
+  }
+  else {
+    compose_destfile($package, $srcfile);
+  }
+
+  echo "Done.\n\n";
+}
+