'
*
* - import './egw_core.js';
* - import { something } from '../../vendor/class.js';
* - import { something } from './other'; (in TS without extension!)
* @ToDo import { something } from 'module/sub'
*
* b) Write a comment starting with "/*egw:uses". A linebreak has to follow.
* Then write all files which have to be included separated by ";". A JS file
* include may have the following syntax:
*
* 1) File in the same directory as the current file. Simply write the filename
* without ".js". Example:
* egw_action;
* 2) Files in a certain application and package. The syntax is
* [$app.]$package.$file
* The first "$app" part is optional. It defaults to phpgwapi. Examples:
* /vendor/bower-asset/jquery-ui/jquery-ui.js; // Loads /vendor/bower-asset/jquery-ui/jquery-ui.js
* stylite.filemanager.filemanager; // Loads /stylite/filemanager/filemanager.js
* 3) Absolute file paths starting with "/". Example:
* /api/js/jquery/jquery-ui.js;
* 4) Absolute path with "*"-wildcard
* /myapp/js/plugins/*.js;
*
* Comments can be started with "//".
*
* Complete example of such an uses-clause:
* /*egw:uses
* egw_action_common;
* egw_action;
* vendor.bower-asset.jquery.dist.jquery; // Includes jquery.js from package jquery in phpgwapi
* /vendor/bower-asset/jquery-ui/jquery-ui.js; // Includes jquery-ui.js
*
* Class can be tested by opening it in browser:
*
* http://localhost/egroupware/api/src/Framework/IncludeMgr.inc.php?path=/api/js/jsapi/egw_calendar.js
*
* This will then show the parsed dependencies of the given path.
*/
class IncludeMgr
{
static private $DEBUG_MODE = true;
/**
* The parsed_files array holds all files which have already been processed
* by this class.
*
* @var array of path => true
*/
private $parsed_files = array();
/**
* The included files array holds all files which will really be included
* as a result of the current request.
*
* @var array of path => true
*/
private $included_files = array();
/**
* Set to the file which is currently processed, in order to get usable
* debug messages.
*/
private $debug_processing_file = false;
/**
* @var bool true: echo out debug info, for direct call see end of this file
*/
private $debug_parsing_imports = false;
/**
* Size of file parsed, must include all /*egw:uses and include statements
*
* etemplate2.js is ~3900 currently
*/
const PARSE_SIZE = 4096;
/**
* Parses the js file for includes and returns all required files
*/
private function parse_file($file)
{
// file is from url and can contain query-params, eg. /phpgwapi/inc/jscalendar-setup.php?dateformat=d.m.Y&lang=de
if (strpos($file,'?') !== false) list($file) = explode('?',$file);
// Mark the file as parsed
$this->parsed_files[$file] = true;
// extension to add, if dependency has none
$extension = substr($file, -3) === '.ts' ? '.ts' : '.js';
$modules = $modules2 = [];
// Try to open the given file
if (($header = file_get_contents(EGW_SERVER_ROOT.$file, false, null, 0, self::PARSE_SIZE)))
{
if ($this->debug_parsing_imports) echo "$file
\n";
$matches = null;
if (preg_match_all('/import\s+({[^}]+}\s*from\s+)?["\']([^;\s]+)["\']/', $header, $matches))
{
if ($this->debug_parsing_imports) echo "imports:".json_encode($matches, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES)."
\n";
$modules = $matches[2];
}
// either use es5 import or old /*egw:uses */ annotation
elseif (preg_match('#/\*egw:uses(.*);\s+\*/#sU', $header, $matches) &&
($matches = array_filter(preg_split('/;[^\n]*\n\s*/', trim($matches[1])), static function($use)
{
return !preg_match('#^\s*//#', $use); // filter out commented out ones
})))
{
if ($this->debug_parsing_imports) echo "egw:uses:".json_encode($matches, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES)."
\n";
$modules = array_merge($modules, $matches);
}
// Split all modules at "." and remove entries with empty parts
foreach ($modules as $mod)
{
if ($mod)
{
if ($mod !== trim($mod))
{
throw new \Exception("'$mod' contains whitespace!");
}
// Split the given module string at the dot, if this isn't
// an relative (starting ./) or absolute path (initialized by "/").
if (substr($mod, 0, 2) === './')
{
if (!preg_match('/\.(js|ts)$/', $mod)) $mod .= $extension;
$mod = [dirname($file).substr($mod, 1)];
}
elseif (substr($mod, 0, 3) === '../')
{
if (!preg_match('/\.(js|ts)$/', $mod)) $mod .= $extension;
$dir = dirname($file);
while(substr($mod, 0, 3) === '../')
{
$mod = substr($mod, 3);
$dir = dirname($dir);
}
$mod = [($dir !== '/' ? $dir : '').'/'.$mod];
}
elseif ($mod[0] != '/')
{
$mod = explode(".", $mod, 3);
}
else
{
$mod = array($mod);
}
$empty = false;
// Remove all space characters
foreach ($mod as &$entry)
{
$entry = trim($entry);
$empty = $empty || !$entry;
}
if (!$empty)
{
$modules2[] = $mod;
}
}
}
return $modules2;
}
return false;
}
private function file_processed($file)
{
return array_key_exists($file, $this->included_files) ||
array_key_exists($file, $this->parsed_files);
}
/**
* Parses the given files and adds all dependencies to the passed modules array
*/
private function parse_deps($path, array &$module)
{
$this->debug_processing_file = $path;
// Parse the given file for dependencies
$uses = [];//$this->parse_file($path);
foreach ((array)$uses as $entry)
{
$uses_path = false;
// Check whether just a filename was given - if yes, check whether
// a file with the given name exists inside the directory of the
// base file
if (count($entry) == 1)
{
if ($entry[0][0] == "/")
{
if (!($uses_path = $this->translate_params($entry[0], null, '')) &&
strpos($entry[0], '*') !== false)
{
$start = strlen(EGW_SERVER_ROOT);
foreach(glob(EGW_SERVER_ROOT.$entry[0]) as $file)
{
$this->parse_deps(substr($file, $start), $module);
}
}
}
else
{
// Assemble a filename
$filename = dirname($path).'/'.$entry[0].'.js';
if (is_readable(EGW_SERVER_ROOT.($filename)))
{
if (!$this->file_processed($filename))
{
$uses_path = $filename;
}
}
else
{
$uses_path = $this->translate_params($entry[0]);
}
}
}
else if (count($entry) == 2)
{
$uses_path = $this->translate_params($entry[0], $entry[1]);
}
else if (count($entry) == 3)
{
$uses_path = $this->translate_params($entry[1], $entry[2], $entry[0]);
}
else
{
error_log(__METHOD__." invalid egw:require in js_file '$path' -> ".array2string($entry));
}
if ($uses_path)
{
$this->parse_deps($uses_path, $module);
}
}
// Add the file to the top of the list
array_push($module, $path);
$this->debug_processing_file = false;
}
/**
* Includes the given module files - this function will have the task to
* cache/shrink/concatenate the files in the future.
*
* @param array $modules pathes to include
* @param boolean $append =true false: prepend modules before already included ones, keeping their order
*/
private function include_module(array $modules, $append=true)
{
if (self::$DEBUG_MODE)
{
if ($append)
{
foreach ($modules as $path)
{
$this->included_files[$path] = true;
}
}
else
{
$this->included_files = array_merge(array_combine($modules, array_fill(0, count($modules), true)),
$this->included_files);
}
}
else
{
// TODO
}
}
/**
* Translates the given parameters into a path and checks it for validity.
*
* Example call syntax:
* a) egw_framework::validate_file('jscalendar','calendar')
* --> /phpgwapi/js/jscalendar/calendar.js
* b) egw_framework::validate_file('/phpgwapi/inc/calendar-setup.js',array('lang'=>'de'))
* --> /phpgwapi/inc/calendar-setup.js?lang=de
*
* @param string $package package or complete path (relative to EGW_SERVER_ROOT) to be included
* @param string|array $file =null file to be included - no ".js" on the end or array with get params
* @param string $app ='api' application directory to search - default = phpgwapi
*
* @returns the correct path on the server if the file is found or false, if the
* file is not found or no further processing is needed.
*/
private function translate_params($package, $file=null, $app='api')
{
if ($package[0] == '/' && is_readable(EGW_SERVER_ROOT.parse_url($path = $package, PHP_URL_PATH)) ||
// fix old /phpgwapi/js/ path by replacing it with /api/js/
substr($package, 0, 13) == '/phpgwapi/js/' && is_readable(EGW_SERVER_ROOT.parse_url($path = str_replace('/phpgwapi/js/', '/api/js/', $package), PHP_URL_PATH)) ||
$package[0] == '/' && is_readable(EGW_SERVER_ROOT.($path = $package)) ||
$package == '.' && is_readable(EGW_SERVER_ROOT.($path="/$app/js/$file.js")) ||
is_readable(EGW_SERVER_ROOT.($path="/$app/js/$package/$file.js")) ||
// fix not found by using app='api'
$app != 'api' && is_readable(EGW_SERVER_ROOT.($path="/api/js/$package/$file.js")) ||
$app != 'phpgwapi' && is_readable(EGW_SERVER_ROOT.($path="/phpgwapi/js/$package/$file.js")))
{
// normalise /./ to /
$path = str_replace('/./', '/', $path);
// Handle the special case, that the file is an url - in this case
// we will do no further processing but just include the file
// XXX: Is this case still used? If yes, it will not work with
// adding the ctime to all js files...
if (is_array($file))
{
foreach($file as $name => $val)
{
$args .= (empty($args) ? '?' : '&').$name.'='.urlencode($val);
}
$path .= $args;
$this->included_files[$path] = true;
return false;
}
// Return false if the file is already included or parsed
if ($this->file_processed($path))
{
return false;
}
else
{
return $path;
}
}
if (self::$DEBUG_MODE) // DEBUG_MODE is currently ALWAYS true. Comment this code out if you don't want error messages.
{
//error_log(__METHOD__."($package,$file,$app) $path NOT found".($this->debug_processing_file ? " while processing file '{$this->debug_processing_file}'." : "!").' '.function_backtrace());
}
return false;
}
/**
* Include a javascript file
*
* Example call syntax:
* a) include_js_file('jscalendar','calendar')
* --> /phpgwapi/js/jscalendar/calendar.js
* b) include_js_file('/phpgwapi/inc/calendar-setup.js',array('lang'=>'de'))
* --> /phpgwapi/inc/calendar-setup.js?lang=de
*
* @param string $package package or complete path (relative to EGW_SERVER_ROOT) to be included
* @param string|array $file =null file to be included - no ".js" on the end or array with get params
* @param string $app ='phpgwapi' application directory to search - default = phpgwapi
* @param boolean $append =true true append file, false prepend (add as first) file used eg. for template itself
*/
public function include_js_file($package, $file = null, $app = 'phpgwapi', $append=true)
{
// Translate the given parameters into a valid path - false is returned
// if the file is not found or the file is already included/has already
// been parsed by this class.
$path = $this->translate_params($package, $file, $app);
if ($path !== false)
{
// TODO: Check whether the given path is cached, if yes, include the
// cached module file and add all files this module contains
// to the "parsed_files" array
// Collect the possible list of dependant modules of this file in
// the "module" array.
$module = array();
$this->parse_deps($path, $module);
$this->include_module($module, $append);
}
}
/**
* Include given files, optionally clear list of files to include
*
* @param array $files
* @param boolean $clear_files =false if true clear list of files, before including given ones
*/
public function include_files(array $files, $clear_files=false)
{
if ($clear_files) $this->included_files = array();
foreach ($files as $file)
{
$this->include_js_file($file);
}
}
/**
* Return all files
*
* @param boolean $clear_files =false if true clear list of files after returning them
* @return array
*/
public function get_included_files($clear_files=false)
{
$ret = array_keys($this->included_files);
if ($clear_files) $this->included_files = array();
return $ret;
}
/**
* Get importMap for browser
*/
public function getImportMap()
{
$files = $this->get_included_files();
$imports = array_combine(array_map(static function($url)
{
return parse_url($url, PHP_URL_PATH);
}, $files), $files);
return ['imports' => $imports];
}
/**
* Constructor
*
* @param array $files =null optional files to include as for include_files method
* @param bool $debug_parsing_imports =false true: echo out debug infos
*/
public function __construct(array $files = null, bool $debug_parsing_imports=false)
{
$this->debug_parsing_imports = $debug_parsing_imports;
if (isset($files) && is_array($files))
{
$this->include_files($files);
}
}
}
// Small test for this class
// specify one or more files in url, eg. path[]=/phpgwapi/js/jsapi/egw.js&path[]=/etemplate/js/etemplate2.js
if (isset($_SERVER['SCRIPT_FILENAME']) && $_SERVER['SCRIPT_FILENAME'] == __FILE__)
{
define('EGW_SERVER_ROOT', dirname(dirname(dirname(__DIR__))));
define('EGW_INCLUDE_ROOT', dirname(dirname(dirname(__DIR__))));
include_once(EGW_SERVER_ROOT.'/api/src/loader/common.php');
$mgr = new IncludeMgr(null, true);
echo "\n\n\tDependencies\n\n\n";
$paths = !empty($_GET['path']) ? (array)$_GET['path'] : (array)'/stylite/js/filemanager/filemanager.js';
foreach($paths as $path)
{
echo "\t".htmlspecialchars($path)."
\n";
$mgr->include_js_file($path);
foreach ($mgr->get_included_files(true) as $file)
{
echo "\t$file
\n";
}
}
echo "\n\n";
}