public function render($file, $arr_vars = array())
{
//--
if (!is_array($arr_vars)) {
$arr_vars = array();
}
//end if
//--
if (!\SmartFileSysUtils::check_file_or_dir_name($this->dir . $file)) {
throw new \Exception('Twig Templating / Render File / The file name / path contains invalid characters: ' . $this->dir . $file);
return;
}
//end if
//--
if (!is_file($this->dir . $file)) {
throw new \Exception('Twig Templating / The Template file to render does not exists: ' . $this->dir . $file);
return;
}
//end if
//--
return (string) $this->twig->render((string) $file, (array) $arr_vars);
//--
}
public static function Run()
{
//--
global $configs;
//--
//==
//--
if (self::$MiddlewareCompleted !== false) {
// avoid to execute more than 1 this middleware !
self::Raise500Error('Middleware App Execution already completed ...');
return;
}
//end if
self::$MiddlewareCompleted = true;
//--
$the_midmark = '[A]';
//--
if (SMART_FRAMEWORK_ADMIN_AREA !== true) {
Smart::raise_error('Admin Middleware ERROR: SMART_FRAMEWORK_ADMIN_AREA is not set to TRUE', 'Invalid Area / This middleware is designed for Admin area and requires to turn ON the Administration flag ...');
return;
}
//end if
//--
if (!defined('SMART_APP_TEMPLATES_DIR')) {
self::Raise500Error('The SMART_APP_TEMPLATES_DIR not defined ...');
return;
}
//end if
//--
if (defined('SMART_APP_MODULE_AREA')) {
self::Raise500Error('Smart App Area must NOT be Defined outside controllers ...');
return;
}
//end if
if (defined('SMART_APP_MODULE_AUTH')) {
self::Raise500Error('Smart App Module Auth must NOT be Defined outside controllers ...');
return;
}
//end if
if (defined('SMART_APP_MODULE_REALM_AUTH')) {
self::Raise500Error('Smart App Module Realm Auth must NOT be Defined outside controllers ...');
return;
}
//end if
if (defined('SMART_APP_MODULE_DIRECT_OUTPUT')) {
self::Raise500Error('Smart App Module Direct Output must NOT be Defined outside controllers ...');
return;
}
//end if
//--
//==
//--
$smartframeworkservice = '';
// special operation
if (SmartFrameworkRegistry::issetRequestVar('smartframeworkservice') === true) {
$smartframeworkservice = (string) strtolower((string) SmartUnicode::utf8_to_iso((string) SmartFrameworkRegistry::getRequestVar('smartframeworkservice')));
switch ((string) $smartframeworkservice) {
case 'status':
case 'debug':
break;
default:
// invalid value
$smartframeworkservice = '';
}
//end switch
}
//end if
//--
//==
//-- switch language by cookie (this needs to be before loading the app core)
if (strlen(trim((string) $_COOKIE['SmartApp_ADM_LANGUAGE_SET'])) > 0) {
SmartTextTranslations::setLanguage(trim((string) $_COOKIE['SmartApp_ADM_LANGUAGE_SET']));
}
//end if
//-- switch language by print cookie (this needs to be before loading the app core and after language by cookie)
if (SmartFrameworkRegistry::issetRequestVar((string) SMART_FRAMEWORK_URL_PARAM_PRINTABLE) === true) {
if (strtolower((string) SmartFrameworkRegistry::getRequestVar((string) SMART_FRAMEWORK_URL_PARAM_PRINTABLE)) == strtolower((string) SMART_FRAMEWORK_URL_VALUE_ENABLED)) {
if (strlen(trim((string) $_COOKIE['SmartApp_ADM_PRINT_LANGUAGE_SET'])) > 0) {
SmartTextTranslations::setLanguage(trim((string) $_COOKIE['SmartApp_ADM_PRINT_LANGUAGE_SET']));
}
//end if
}
//end if
}
//end if
//--
//== RAW OUTPUT FOR STATUS
//--
if ((string) $smartframeworkservice == 'status') {
//--
if (SMART_SOFTWARE_DISABLE_STATUS_POWERED === true) {
$status_powered_info = '';
} else {
$status_powered_info = (string) SmartComponents::draw_powered_info('no');
}
//end if else
//--
self::HeadersNoCache();
// headers: cache control, force no-cache
echo SmartComponents::http_status_message('Smart.Framework :: Status :: [OK]', '<script type="text/javascript">setTimeout(function(){ self.location = self.location; }, 60000);</script><img src="lib/core/img/busy_bar.gif"><div><h1>' . date('Y-m-d H:i:s O') . ' // Service Ready :: ' . $the_midmark . '</h1></div>' . $status_powered_info . '<br>');
//--
return;
// break stop
//--
}
//end if
//--
//== OVERALL AUTHENTICATION BREAKPOINT
//--
SmartAppBootstrap::Authenticate('admin');
// if the auth uses session it may start now
//--
//== RAW OUTPUT FOR DEBUG
//--
if ((string) $smartframeworkservice == 'debug') {
//--
if ((string) SMART_FRAMEWORK_DEBUG_MODE == 'yes') {
self::HeadersNoCache();
// headers: cache control, force no-cache
$the_debug_cookie = trim((string) $_COOKIE['SmartFramework__DebugAdmID']);
echo SmartDebugProfiler::print_debug_info('adm', $the_debug_cookie);
} else {
http_response_code(404);
echo SmartComponents::http_message_404_notfound('No Debug service has been activated on this server ...');
}
//end if
//--
return;
// break stop
//--
}
//end if else
//--
//== LOAD THE MODULE (OR DEFAULT MODULE)
//--
$reserved_controller_names = ['php', 'html', 'stml', 'css', 'js', 'json', 'xml', 'rss', 'txt', 'csv', 'sql', 'png', 'gif', 'jpg', 'pdf', 'svg', 'zip', '7z', 'netarch'];
// these are reserved extensions and cannot be used as controller names because they need to be used also with friendly URLs as the 2nd param if module is missing from URL page param
//--
$err404 = '';
$arr = array();
//--
$page = (string) SmartUnicode::utf8_to_iso((string) SmartFrameworkRegistry::getRequestVar('page'));
$page = trim(str_replace(array('/', '\\', ':', '?', '&', '=', '%'), array('', '', '', '', '', '', ''), $page));
// fix for get as it automatically replaces . with _ (so, reverse), but also fix some invalid characters ...
if ((string) $page == '') {
$page = (string) $configs['app']['admin-home'];
}
//end if
//--
if (strpos($page, '.') !== false) {
// page can be as module.controller / module.controller(.php|html|stml|css|js|json|xml|rss|txt|csv|sql|png|gif|jpg|pdf|svg|zip|7z|netarch)
//--
$arr = (array) explode('.', (string) $page, 3);
// separe 1st and 2nd from the rest
//--
//#
//#
$arr[0] = trim(strtolower((string) $arr[0]));
// module
$arr[1] = trim(strtolower((string) $arr[1]));
// controller
//#
//# Admin will NOT integrate with friendly URLs SMART_FRAMEWORK_SEMANTIC_URL_SKIP_MODULE
//# that feature is just for Index
//#
//--
} elseif ((string) $configs['app']['admin-default-module'] != '') {
//--
$arr[0] = trim(strtolower((string) $configs['app']['admin-default-module']));
// get default module
$arr[1] = trim(strtolower((string) $page));
// controller
//--
} else {
//--
if ((string) $err404 == '') {
$err404 = 'Invalid Page (Invalid URL Page Segments Syntax): ' . $page;
}
//end if
//--
}
//end if else
//--
if ((string) $arr[0] == '' or (string) $arr[1] == '') {
if ((string) $err404 == '') {
$err404 = 'Invalid Page (Empty or Missing URL Page Segments): ' . $page;
}
//end if
}
//end if
if (!preg_match('/^[a-z0-9_\\-]+$/', (string) $arr[0]) or !preg_match('/^[a-z0-9_\\-]+$/', (string) $arr[1])) {
if ((string) $err404 == '') {
$err404 = 'Invalid Page (Invalid Characters in the URL Page Segments): ' . $page;
}
//end if
}
//end if
if (in_array((string) $arr[1], (array) $reserved_controller_names)) {
if ((string) $err404 == '') {
$err404 = 'Invalid Page (Reserved Page Controller Name): [' . $arr[1] . '] in: ' . $page;
}
//end if
}
//end if
//--
$the_controller_name = (string) $arr[0] . '.' . $arr[1];
$the_path_to_module = Smart::safe_pathname(SmartFileSysUtils::add_dir_last_slash('modules/mod-' . Smart::safe_filename($arr[0])));
$the_module = Smart::safe_pathname($the_path_to_module . Smart::safe_filename($arr[1]) . '.php');
if (!is_file($the_module)) {
if ((string) $err404 == '') {
$err404 = 'Page does not exist: ' . $page;
}
//end if
}
//end if
//--
if ((string) $err404 != '') {
self::Raise404Error((string) $err404);
return;
}
//end if
//--
if (!SmartFileSysUtils::check_file_or_dir_name($the_path_to_module) or !SmartFileSysUtils::check_file_or_dir_name($the_module)) {
self::Raise400Error('Insecure Module Access for Page: ' . $page);
return;
}
//end if
//--
if (class_exists('SmartAppIndexController') or class_exists('SmartAppAdminController')) {
self::Raise500Error('Module Class Runtimes must be defined only in modules ...');
return;
}
//end if
//--
require (string) $the_module;
//--
if ((string) SMART_APP_MODULE_AREA !== 'ADMIN' and (string) SMART_APP_MODULE_AREA !== 'SHARED') {
self::Raise403Error('Page Access Denied for Admin Area: ' . $page);
return;
}
//end if
if (defined('SMART_APP_MODULE_AUTH')) {
if (SmartAuth::check_login() !== true) {
self::Raise403Error('Page Access Denied ! No Authentication: ' . $page);
return;
}
//end if
if (defined('SMART_APP_MODULE_REALM_AUTH')) {
if ((string) SmartAuth::get_login_realm() !== (string) SMART_APP_MODULE_REALM_AUTH) {
self::Raise403Error('Page Access Denied ! Invalid Login Realm: ' . $page);
return;
}
//end if
}
//end if
}
//end if
//--
if (!class_exists('SmartAppAdminController')) {
self::Raise500Error('Invalid Module Class Runtime for Page: ' . $page);
return;
}
//end if
if (!is_subclass_of('SmartAppAdminController', 'SmartAbstractAppController')) {
self::Raise500Error('Invalid Module Class Inheritance for Controller Page: ' . $page);
return;
}
//end if
//--
//== PATHS
//--
$base_script = SmartUtils::get_server_current_script();
$base_full_path = SmartUtils::get_server_current_path();
$base_full_url = SmartUtils::get_server_current_url();
//--
//== RUN THE MODULE
//--
$appModule = new SmartAppAdminController($the_path_to_module, $base_script, $base_full_path, $base_full_url, $page, $the_controller_name);
//--
if (SMART_APP_MODULE_DIRECT_OUTPUT !== true) {
ob_start();
}
//end if
$appStatusCode = (int) $appModule->Run();
$appModule->ShutDown();
if (SMART_APP_MODULE_DIRECT_OUTPUT !== true) {
$ctrl_output = ob_get_contents();
ob_end_clean();
if ((string) $ctrl_output != '') {
Smart::log_warning('The middleware service ' . $the_midmark . ' detected an illegal output in the controller: ' . $page . "\n" . 'The result of this output is: ' . $ctrl_output);
}
//end if
$ctrl_output = '';
} else {
return;
// break stop after the controller has terminated the direct output
}
//end if else
//--
$appSettings = (array) $appModule->PageViewGetCfgs();
//--
//== CACHE CONTROL
//--
if ((int) $appSettings['expires'] > 0 and (string) SMART_FRAMEWORK_DEBUG_MODE != 'yes') {
self::HeadersCacheExpire((int) $appSettings['expires'], (int) $appSettings['modified']);
// headers: cache expiration control
} else {
self::HeadersNoCache();
// headers: cache control, force no-cache
}
//end if else
//--
//== STATUS CODE
//--
switch ((int) $appStatusCode) {
//-- client errors
case 400:
self::Raise400Error((string) $appSettings['error']);
return;
break;
case 401:
self::Raise401Error((string) $appSettings['error']);
return;
break;
case 403:
self::Raise403Error((string) $appSettings['error']);
return;
break;
case 404:
self::Raise404Error((string) $appSettings['error']);
return;
break;
case 429:
self::Raise429Error((string) $appSettings['error']);
return;
break;
//-- server errors
//-- server errors
case 500:
self::Raise500Error((string) $appSettings['error']);
return;
break;
case 502:
self::Raise502Error((string) $appSettings['error']);
return;
break;
case 503:
self::Raise503Error((string) $appSettings['error']);
return;
break;
case 504:
self::Raise504Error((string) $appSettings['error']);
return;
break;
//-- extended 2xx statuses: NOTICE / WARNING / ERROR that can be used for REST / API
//-- extended 2xx statuses: NOTICE / WARNING / ERROR that can be used for REST / API
case 202:
// NOTICE
if (!headers_sent()) {
http_response_code(202);
// Accepted (this should be used only as an alternate SUCCESS code instead of 200 for NOTICES)
} else {
Smart::log_warning('Headers Already Sent before 202 ...');
}
//end if else
break;
case 203:
// WARNING
if (!headers_sent()) {
http_response_code(203);
// Non-Authoritative Information (this should be used only as an alternate SUCCESS code instead of 200 for WARNINGS)
} else {
Smart::log_warning('Headers Already Sent before 203 ...');
}
//end if else
break;
case 208:
// ERROR
if (!headers_sent()) {
http_response_code(208);
// Already Reported (this should be used only as an alternate SUCCESS code instead of 200 for ERRORS)
} else {
Smart::log_warning('Headers Already Sent before 208 ...');
}
//end if else
break;
//-- DEFAULT: OK
//-- DEFAULT: OK
case 200:
default:
// any other codes not listed above are not supported and will be interpreted as 200
// nothing to do here ...
}
//end switch
//--
//== PREPARE THE OUTPUT
//--
if (stripos((string) $configs['js']['popup-override-mobiles'], '<' . SmartUtils::get_os_browser_ip('os') . '>') !== false) {
$configs['js']['popup-mode'] = 'popup';
// particular os settings for mobiles
}
//end if
//--
$rawpage = '';
if (isset($appSettings['rawpage'])) {
$rawpage = strtolower((string) $appSettings['rawpage']);
if ((string) $rawpage == 'yes') {
$rawpage = 'yes';
// standardize the value
}
//end if
}
//end if
if ((string) $rawpage != 'yes') {
$rawpage = '';
}
//end if
//--
$rawmime = '';
if (isset($appSettings['rawmime'])) {
$rawmime = (string) $appSettings['rawmime'];
if ((string) $rawmime != '') {
$rawmime = SmartValidator::validate_mime_type($rawmime);
}
//end if
}
//end if else
//--
$rawdisp = '';
if (isset($appSettings['rawdisp'])) {
$rawdisp = (string) $appSettings['rawdisp'];
if ((string) $rawdisp != '') {
$rawdisp = SmartValidator::validate_mime_disposition($rawdisp);
}
//end if
}
//end if else
//--
$appData = (array) $appModule->PageViewGetVars();
//--
$appData['base-path'] = (string) $base_full_path;
$appData['base-url'] = (string) $base_full_url;
//--
//== REDIRECTION HANDLER (this can be set only explicit from Controllers)
//--
if ((string) $appSettings['redirect-url'] != '') {
// expects a valid URL
//--
$the_redirect_link = '<a href="' . Smart::escape_html((string) $appSettings['redirect-url']) . '">' . Smart::escape_html((string) $appSettings['redirect-url']) . '</a>';
//--
if (headers_sent()) {
Smart::log_warning('Headers Already Sent before Redirection: [' . $appStatusCode . '] ; URL: ' . $appSettings['redirect-url']);
self::Raise500Error('The app failed to Redirect to: ' . $the_redirect_link);
return;
}
//end if
switch ((int) $appStatusCode) {
case 301:
http_response_code(301);
$the_redirect_text = 'Moved Permanently';
// permanent redirect for HTTP 1.0 / HTTP 1.1
break;
case 302:
default:
// any other code will be interpreted as 302 (the default redirection in PHP)
http_response_code(302);
$the_redirect_text = 'Found';
// temporary redirect for HTTP 1.0 / HTTP 1.1
break;
}
//end switch
header('Location: ' . SmartFrameworkSecurity::FilterUnsafeString((string) $appSettings['redirect-url']));
echo '<h1>' . Smart::escape_html($the_redirect_text) . '</h1>' . '<br>' . 'If the page redirection fails, click on the below link:' . '<br>' . $the_redirect_link;
return;
// break stop
}
//end if
//--
//== DOWNLOADS HANDLER (downloads can be set only explicit from Controllers)
//--
if ((string) $appSettings['download-packet'] != '' and (string) $appSettings['download-key'] != '') {
// expects an encrypted data packet and a key
$dwl_result = self::DownloadsHandler((string) $appSettings['download-packet'], (string) $appSettings['download-key']);
if ((string) $dwl_result != '') {
Smart::log_info('File Download - Client: ' . SmartUtils::get_visitor_signature(), (string) $dwl_result);
// log result and mark it as finalized
}
//end if
return;
// break stop
}
//end if
//--
//== RAW OUTPUT FOR PAGES
//--
if ((string) $rawpage == 'yes') {
//-- {{{SYNC-RESOURCES}}}
if (function_exists('memory_get_peak_usage')) {
$res_memory = @memory_get_peak_usage(false);
} else {
$res_memory = 'unknown';
}
//end if else
$res_time = (double) (microtime(true) - (double) SMART_FRAMEWORK_RUNTIME_READY);
//-- #END-SYNC
if ((string) SMART_FRAMEWORK_DEBUG_MODE == 'yes') {
//-- {{{SYNC-DEBUG-META-INFO}}}
SmartFrameworkRegistry::setDebugMsg('stats', 'memory', $res_memory);
// bytes
SmartFrameworkRegistry::setDebugMsg('stats', 'time', $res_time);
// seconds
//-- #END-SYNC
$the_debug_cookie = trim((string) $_COOKIE['SmartFramework__DebugAdmID']);
SmartDebugProfiler::save_debug_info('adm', $the_debug_cookie, false);
} else {
$the_debug_cookie = '';
}
//end if
//--
if (headers_sent()) {
Smart::raise_error('Middleware ERROR: Headers already sent', 'ERROR: Headers already sent !');
return;
// avoid serve raw pages with errors injections before headers
}
//end if
//--
if ((string) $rawmime != '') {
header('Content-Type: ' . $rawmime);
}
//end if
if ((string) $rawdisp != '') {
header('Content-Disposition: ' . $rawdisp);
}
//end if
header('Content-Length: ' . (0 + strlen((string) $appData['main'])));
// must be strlen NOT SmartUnicode::str_len as it must get number of bytes not characters
echo (string) $appData['main'];
return;
// break stop
//--
}
//end if else
//--
//== DEFAULT OUTPUT
//--
if (isset($appSettings['template-path'])) {
if ((string) $appSettings['template-path'] == '@') {
// if template path is set to self (module)
$the_template_path = '@';
// this is a special setting
} else {
$the_template_path = Smart::safe_pathname(SmartFileSysUtils::add_dir_last_slash(trim((string) $appSettings['template-path'])));
}
//end if else
} else {
$the_template_path = Smart::safe_pathname(SmartFileSysUtils::add_dir_last_slash(trim((string) $configs['app']['admin-template-path'])));
// use default template path
}
//end if else
//--
if (isset($appSettings['template-file'])) {
$the_template_file = Smart::safe_filename(trim((string) $appSettings['template-file']));
} else {
$the_template_file = Smart::safe_filename(trim((string) $configs['app']['admin-template-file']));
// use default template
}
//end if else
//--
if ((string) $the_template_path == '@') {
$the_template_path = (string) $the_path_to_module . 'templates/';
// must have the dir last slash as above
} else {
$the_template_path = (string) SMART_APP_TEMPLATES_DIR . $the_template_path;
// finally normalize and set the complete template path
}
//end if else
$the_template_file = (string) $the_template_file;
// finally normalize
//--
if (!SmartFileSysUtils::check_file_or_dir_name($the_template_path)) {
Smart::log_warning('Invalid Page Template Path: ' . $the_template_path);
self::Raise500Error('Invalid Page Template Path. See the error log !');
return;
}
//end if
if (!is_dir($the_template_path)) {
Smart::log_warning('Page Template Path does not Exists: ' . $the_template_path);
self::Raise500Error('Page Template Path does not Exists. See the error log !');
return;
}
//end if
if (!SmartFileSysUtils::check_file_or_dir_name($the_template_path . $the_template_file)) {
Smart::log_warning('Invalid Page Template File: ' . $the_template_path . $the_template_file);
self::Raise500Error('Invalid Page Template File. See the error log !');
return;
}
//end if
if (!is_file($the_template_path . $the_template_file)) {
Smart::log_warning('Page Template File does not Exists: ' . $the_template_path . $the_template_file);
self::Raise500Error('Page Template File does not Exists. See the error log !');
return;
}
//end if
//--
$the_template_content = trim(SmartMarkersTemplating::read_template_file($the_template_path . $the_template_file));
if ((string) $the_template_content == '') {
Smart::log_warning('Page Template File is Empty or cannot be read: ' . $the_template_path . $the_template_file);
self::Raise500Error('Page Template File is Empty or cannot be read. See the error log !');
return;
}
//end if
//--
if ((string) SMART_FRAMEWORK_DEBUG_MODE == 'yes') {
$the_template_content = str_ireplace('</head>', "\n" . SmartDebugProfiler::js_headers_debug('admin.php?smartframeworkservice=debug') . "\n" . '</head>', $the_template_content);
$the_template_content = str_ireplace('</body>', "\n" . SmartDebugProfiler::div_main_debug() . "\n" . '</body>', $the_template_content);
}
//end if
//--
$appData['app-domain'] = (string) $configs['app']['admin-domain'];
$appData['template-file'] = $the_template_path . $the_template_file;
$appData['template-path'] = $the_template_path;
$appData['js.settings'] = SmartComponents::js_inc_settings((string) $configs['js']['popup-mode'], true, (bool) SMART_APP_VISITOR_COOKIE);
$appData['head-meta'] = (string) $appData['head-meta'];
if ((string) $appData['head-meta'] == '') {
$appData['head-meta'] = '<!-- Head Meta -->';
}
//end if
$appData['title'] = (string) $appData['title'];
$appData['main'] = (string) $appData['main'];
$appData['lang'] = SmartTextTranslations::getLanguage();
//--
if ((string) SMART_FRAMEWORK_DEBUG_MODE == 'yes') {
//--
$the_debug_cookie = 'adm-' . Smart::uuid_10_seq() . '-' . Smart::uuid_10_num() . '-' . Smart::uuid_10_str();
@setcookie('SmartFramework__DebugAdmID', (string) $the_debug_cookie, 0, '/');
// debug token cookie is set just on main request
//--
}
//end if
//--
echo SmartMarkersTemplating::render_mixed_template((string) $the_template_content, (array) $appData, (string) $appData['template-path'], 'no', 'no');
//-- {{{SYNC-RESOURCES}}}
if (function_exists('memory_get_peak_usage')) {
$res_memory = @memory_get_peak_usage(false);
} else {
$res_memory = 'unknown';
}
//end if else
$res_time = (double) (microtime(true) - (double) SMART_FRAMEWORK_RUNTIME_READY);
//-- #END-SYNC
if ((string) SMART_FRAMEWORK_DEBUG_MODE == 'yes') {
//-- {{{SYNC-DEBUG-META-INFO}}}
SmartFrameworkRegistry::setDebugMsg('stats', 'memory', $res_memory);
// bytes
SmartFrameworkRegistry::setDebugMsg('stats', 'time', $res_time);
// seconds
//-- #END-SYNC
SmartDebugProfiler::save_debug_info('adm', $the_debug_cookie, true);
//--
}
//end if else
//--
if (SMART_SOFTWARE_DISABLE_STATUS_POWERED !== true) {
echo "\n" . '<!-- Smart.Framework スマート.フレームワーク :: ' . SMART_FRAMEWORK_RELEASE_TAGVERSION . ' / ' . SMART_FRAMEWORK_RELEASE_VERSION . ' @ ' . $the_midmark . ' :: ' . SMART_FRAMEWORK_RELEASE_URL . ' -->';
}
//end if
echo "\n" . '<!-- Resources: [' . Smart::format_number_dec($res_time, 13, '.', '') . ' sec.] / [' . Smart::format_number_dec($res_memory, 0, '.', ' ') . ' by.]' . ' -->' . "\n";
//--
}
public static function dir_delete($dir_name, $recursive = true)
{
//--
if ((string) $dir_name == '') {
Smart::log_warning('LibFileSys // DeleteDir // Dir Name is Empty !');
return 0;
}
//end if
//-- THIS MUST BE DONE BEFORE ADDING THE TRAILING SLASH
if (is_link($dir_name)) {
//--
return self::delete($dir_name);
// avoid deleting content from a linked dir, just remove the link
//--
}
//end if
//--
$dir_name = SmartFileSysUtils::add_dir_last_slash($dir_name);
// fix invalid path (must end with /)
//--
SmartFileSysUtils::raise_error_if_unsafe_path($dir_name);
//--
@clearstatcache();
//--
if (!self::file_or_link_exists($dir_name)) {
//--
return 1;
//--
}
//end if
//--
if (is_link($dir_name)) {
// {{{SYNC-BROKEN-LINK-DELETE}}}
//--
$f_cx = @unlink($dir_name);
//--
if ($f_cx and !is_link($dir_name)) {
return 1;
} else {
return 0;
}
//end if else
//--
}
//end if
//--
$result = false;
//-- remove all subdirs and files within
if (SmartFileSysUtils::check_file_or_dir_name($dir_name)) {
//--
if (is_dir($dir_name) and !is_link($dir_name)) {
//--
@chmod($dir_name, SMART_FRAMEWORK_CHMOD_DIRS);
//apply chmod
//--
if ($handle = opendir($dir_name)) {
//--
while (false !== ($file = readdir($handle))) {
//--
if ((string) $file != '.' and (string) $file != '..') {
//--
if (is_dir($dir_name . $file) and !is_link($dir_name . $file)) {
//--
if ($recursive == true) {
//--
self::dir_delete($dir_name . $file, $recursive);
//--
} else {
//--
return 0;
// not recursive and in this case sub-folders are not deleted
//--
}
//end if else
//--
} else {
// file or link
//--
self::delete($dir_name . $file);
//--
}
//end if else
//--
}
//end if
//--
}
//end while
//--
@closedir($handle);
//--
} else {
//--
$result = false;
Smart::log_warning('LibFileSys // DeleteDir // FAILED to open the directory: ' . $dir_name);
//--
}
//end if
//-- finally, remove itself
$result = @rmdir($dir_name);
//--
} else {
// the rest of cases: is a file or a link
//--
$result = false;
Smart::log_warning('LibFileSys // DeleteDir // This is not a directory: ' . $dir_name);
//--
}
//end if
//--
}
//end if
//--
if (self::file_or_link_exists($dir_name)) {
// last final check
$result = false;
Smart::log_warning('LibFileSys // DeleteDir // FAILED to delete a directory: ' . $dir_name);
}
//end if
//--
if ($result == true) {
$out = 1;
} else {
$out = 0;
}
//end if
//--
return $out;
//--
}
/**
* [PUBLIC] Draw an Image Gallery
*
* @param STRING $y_title :: a title for the gallery
* @param STRING $y_dir :: path to scan
* @param *OPTIONAL[yes/no] $y_process_previews_and_images :: If = 'yes', will create previews for images and videos (movies) and will create conformed images
* @param *OPTIONAL[yes/no] $y_remove_originals :: If = 'yes', will remove original (images) after creating previews [$y_process_previews_and_images must be yes]
* @param *OPTIONAL[>=0] $y_display_limit :: Items limit to display
*/
public function draw($y_title, $y_dir, $y_process_previews_and_images = 'no', $y_remove_originals = 'no', $y_display_limit = '0')
{
//--
$y_title = (string) $y_title;
//--
$y_dir = (string) $y_dir;
//--
$y_process_previews_and_images = (string) $y_process_previews_and_images;
if ((string) $y_process_previews_and_images != 'yes') {
$y_process_previews_and_images = 'no';
}
//end if
//--
$y_display_limit = Smart::format_number_int($y_display_limit, '+');
//--
//--
if ((string) $this->use_secure_links == 'yes') {
if ((string) $this->secure_download_link == '' or (string) $this->secure_download_ctrl_key == '') {
return '<h1>WARNING: Media Gallery / Secure Links Mode is turned ON but at least one of the: download link or the controller was NOT provided ...</h1>';
}
//end if
}
//end if
//--
//--
if (!SmartFileSysUtils::check_file_or_dir_name($y_dir)) {
return '<h1>ERROR: Invalid Folder for Media Gallery ...</h1>';
}
//end if
//--
$y_dir = SmartFileSysUtils::add_dir_last_slash($y_dir);
SmartFileSysUtils::raise_error_if_unsafe_path($y_dir);
//--
if (!is_dir($y_dir)) {
return '<h1>WARNING: The Folder for Media Gallery does not exists ...</h1>';
}
//end if
//--
//--
$this->gallery_items = 0;
//--
//-- constraint of params
if ((string) $y_process_previews_and_images != 'yes') {
$y_remove_originals = 'no';
}
//end if
//--
if (strlen($this->preview_formvar) > 0) {
// avoid processing if it is displayed in a form
$y_process_previews_and_images = 'no';
$y_remove_originals = 'no';
}
//end if
//--
//-- some inits ...
$out = '';
$arr_files = array();
$processed = 0;
//--
//--
$arr_storage = (array) (new SmartGetFileSystem(true))->get_storage($y_dir, false, false);
$all_mg_files = (array) $arr_storage['list-files'];
//--
//--
for ($i = 0; $i < Smart::array_size($all_mg_files); $i++) {
//--
$file = (string) $all_mg_files[$i];
$ext = strtolower(SmartFileSysUtils::get_file_extension_from_path($file));
//--
if (substr($file, 0, 1) != '.' and strpos($file, '.#') === false and strpos($file, '#.') === false) {
//--
if (is_file($y_dir . $file) and ((string) $ext == 'jpeg' or (string) $ext == 'jpg' or (string) $ext == 'gif' or (string) $ext == 'png')) {
//--
if (SmartFileSysUtils::version_check($file, 'mg-preview')) {
//-- it is an image preview file
if (!is_file($y_dir . SmartFileSysUtils::version_add($file, 'mg-image'))) {
SmartFileSystem::delete($y_dir . $file);
// remove preview if orphan
}
//end if
//--
} elseif (SmartFileSysUtils::version_check($file, 'mg-image')) {
//-- it is an image file
if ((string) $y_process_previews_and_images == 'yes') {
//--
$tmp_file = $y_dir . SmartFileSysUtils::version_add($file, 'mg-preview');
//--
if (!is_file($tmp_file)) {
//--
$out .= $this->img_preview_create($y_dir . $file, $tmp_file) . '<br>';
$processed += 1;
//--
}
//end if
//--
}
//end if
//--
$arr_files[] = $file;
$this->gallery_items += 1;
//--
} elseif (SmartFileSysUtils::version_check($file, 'mg-vpreview')) {
//-- it is a movie preview file
if (stripos($file, '.#tmp-preview#.jpg') === false) {
//--
$tmp_linkback_file = SmartFileSysUtils::get_noext_file_name_from_path(SmartFileSysUtils::version_remove($file));
//--
if (!is_file($y_dir . $tmp_linkback_file)) {
SmartFileSystem::delete($y_dir . $file);
// remove if orphan
}
//end if
//--
}
//end if
//--
} else {
// unprocessed image
//--
if ((string) $y_process_previews_and_images == 'yes') {
//--
$tmp_file = $y_dir . SmartFileSysUtils::version_add($file, 'mg-image');
//--
if (!is_file($tmp_file)) {
//--
if ((string) $y_dir . $file != (string) $y_dir . strtolower($file)) {
SmartFileSystem::rename($y_dir . $file, $y_dir . strtolower($file));
// make sure is lowercase, to be ok for back-check since versioned is lowercase
}
//end if
//--
$out .= $this->img_conform_create($y_dir . $file, $tmp_file) . '<br>';
$processed += 1;
//--
} else {
//--
if ((string) $y_remove_originals == 'yes') {
//--
SmartFileSystem::delete($y_dir . $file);
$out .= '<table width="550" bgcolor="#FF3300"><tr><td>removing original image: \'' . Smart::escape_html($file) . '\'</td></tr></table><br>';
$processed += 1;
//--
}
//end if
//--
}
//end if else
//--
}
//end if
//--
}
//end if else
//--
} elseif (is_file($y_dir . $file) and ((string) $ext == 'webm' or (string) $ext == 'ogv' or (string) $ext == 'mp4' or (string) $ext == 'mov' or (string) $ext == 'flv')) {
// WEBM, OGV, MP4, MOV, FLV
//-- process preview FLV / MOV ...
if ((string) $y_process_previews_and_images == 'yes') {
//--
$tmp_file = $y_dir . SmartFileSysUtils::version_add($file, 'mg-vpreview') . '.jpg';
//--
if (!is_file($tmp_file)) {
//--
if ((string) $y_dir . $file != (string) $y_dir . strtolower($file)) {
SmartFileSystem::rename($y_dir . $file, $y_dir . strtolower($file));
// make sure is lowercase, to be ok for back-check since versioned is lowercase
}
//end if
//--
$out .= $this->mov_preview_create($y_dir . strtolower($file), $tmp_file) . '<br>';
$processed += 1;
//--
}
//end if
//--
}
//end if
//--
$arr_files[] = $file;
$this->gallery_items += 1;
//--
}
//end if else
//--
}
//end if
//--
}
//end for
//--
//--
$out .= '<!-- START MEDIA GALLERY -->' . "\n";
//--
if ((string) $this->use_styles == 'yes') {
$out .= '<div id="mediagallery_box">' . "\n";
}
//end if
//--
//--
$out_arr = array();
//--
if ($processed <= 0) {
//--
$arr_files = Smart::array_sort($arr_files, 'natsort');
//--
$max_loops = Smart::array_size($arr_files);
if ($y_display_limit > 0) {
if ($y_display_limit < $max_loops) {
$max_loops = $y_display_limit;
}
//end if
}
//end if
//--
for ($i = 0; $i < $max_loops; $i++) {
//--
$tmp_the_ext = strtolower(SmartFileSysUtils::get_file_extension_from_path($arr_files[$i]));
// [OK]
//--
if ((string) $tmp_the_ext == 'webm' or (string) $tmp_the_ext == 'ogv' or (string) $tmp_the_ext == 'mp4' or (string) $tmp_the_ext == 'mov' or (string) $tmp_the_ext == 'flv') {
$out_arr[] = $this->mov_draw_box($y_dir, $arr_files[$i], $tmp_the_ext);
} else {
$out_arr[] = $this->img_draw_box($y_dir, $arr_files[$i]);
}
//end if
//--
}
//end for
//--
$out .= '<div title="' . Smart::escape_html($this->gallery_show_counter) . '">' . "\n";
//--
if ((string) $y_title != '') {
$out .= '<div id="mediagallery_title">' . Smart::escape_html($y_title) . '</div><br>';
}
//end if
$out .= '<div id="mediagallery_row">';
for ($i = 0; $i < Smart::array_size($out_arr); $i++) {
$out .= '<div id="mediagallery_cell">';
$out .= $out_arr[$i];
$out .= '</div>' . "\n";
}
//end for
$out .= '</div>';
//--
$out .= '</div>' . "\n";
//--
}
//end if
//--
$out_arr = array();
//--
//--
if ((string) $this->use_styles == 'yes') {
$out .= '</div>' . "\n";
}
//end if
//--
$out .= '<!-- END MEDIA GALLERY -->' . "\n";
//--
//--
if ((string) SMART_FRAMEWORK_DEBUG_MODE != 'yes') {
if ($processed > 0) {
$out = '<img src="' . $this->pict_reloading . '" alt="[Reloading Page ...]" title="[Reloading Page ...]"><script type="text/javascript">setTimeout(function(){ self.location = self.location; }, 2000);</script>' . '<br><hr><br>' . $out;
define('SMART_FRAMEWORK__MEDIA_GALLERY_IS_PROCESSING', $processed);
// notice that the media galery is processing
}
//end if
}
//end if
//--
//--
return $out;
//--
}
public static function test_fs()
{
//--
if (SMART_FRAMEWORK_TESTUNIT_ALLOW_FS_TESTS !== true) {
return SmartComponents::operation_notice('Test Unit File System Tests are DISABLED ...');
}
//end if
//--
//--
$time = microtime(true);
//--
//--
$err = '';
$tests = array();
//--
//--
if ((string) DIRECTORY_SEPARATOR != '\\') {
// broken links do not work on Windows !
$tests[] = '##### FileSystem OPERATIONS / TESTS - ALL: #####';
} else {
$tests[] = '##### FileSystem OPERATIONS / TESTS *** PARTIAL SUPPORT ONLY (BY PLATFORM) ***: #####';
}
//end if else
//--
//--
$test_string = '#START#' . "\n" . 'グッド' . "\n" . 'SmartFramework/Test/FileSystem' . "\n" . time() . "\n" . SMART_FRAMEWORK_HTACCESS_NOINDEXING . SMART_FRAMEWORK_HTACCESS_FORBIDDEN . SMART_FRAMEWORK_HTACCESS_NOEXECUTION . "\n" . '#END#';
$test_str_cksum = SmartHashCrypto::sha512($test_string);
$long_prefixed = SmartFileSysUtils::prefixed_sha1_path(sha1(time()));
$short_prefixed = SmartFileSysUtils::prefixed_uuid10_dir(Smart::uuid_10_seq());
//--
$the_base_folder = 'tmp/tests/';
$the_sufx_folder = 'Folder1';
$the_base_file = 'NORMAL-Write_123_@#.txt';
//--
$the_folder = $the_base_folder . $the_sufx_folder . '/';
$the_copy_folder = $the_base_folder . 'folder2';
$the_move_folder = $the_base_folder . 'FOLDER3';
$the_extra_folder = $the_folder . 'extra/';
$the_file = $the_folder . $the_base_file;
//--
$get_folder = SmartFileSysUtils::add_dir_last_slash(SmartFileSysUtils::get_dir_from_path($the_folder));
$get_file = SmartFileSysUtils::get_file_name_from_path($the_file);
$get_xfile = SmartFileSysUtils::get_noext_file_name_from_path($the_file);
$get_ext = SmartFileSysUtils::get_file_extension_from_path($the_file);
//--
$the_copy_file = $the_file . '.copy.txt';
$the_move_file = $the_extra_folder . $the_base_file . '.copy.moved.txt';
$the_broken_link = $the_extra_folder . 'a-broken-link';
$the_broken_dir_link = $the_extra_folder . 'a-broken-dir-link';
$the_good_link = $the_extra_folder . 'a-good-link';
$the_good_dir_link = $the_extra_folder . 'a-good-dir-link';
//--
//--
$tests[] = 'INITIAL-FOLDER: ' . $get_folder;
$tests[] = 'NEW-FOLDER: ' . $the_folder;
$tests[] = 'NEW-FILE: ' . $the_file;
//--
//--
if ((string) $err == '') {
$the_test = 'CHECK TEST SAFE PATH NAME: DIR / FILE ...';
$tests[] = $the_test;
if ((string) Smart::safe_pathname((string) $get_folder) !== (string) $get_folder or (string) Smart::safe_pathname((string) $the_copy_file) !== (string) $the_copy_file) {
$err = 'ERROR: SAFE PATH NAME TEST ... FAILED !!!';
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'CHECK TEST ABSOLUTE / BACKWARD PATHS ...';
$tests[] = $the_test;
if (!SmartFileSysUtils::check_file_or_dir_name('/this/is/absolute', 'no') or SmartFileSysUtils::check_file_or_dir_name('/this/is/absolute') or SmartFileSysUtils::check_file_or_dir_name('/this/is/../backward/path')) {
$err = 'ERROR: CHECK TEST ABSOLUTE / BACKWARD PATHS ... FAILED !!!';
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'CHECK EXTRACT FOLDER FROM PATH ...';
$tests[] = $the_test;
if ((string) $get_folder != SmartFileSysUtils::add_dir_last_slash(Smart::dir_name($the_folder))) {
$err = 'ERROR: Path Extraction FAILED: Dir=' . $get_folder . ' ; DirName=' . SmartFileSysUtils::add_dir_last_slash(Smart::dir_name($the_folder));
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'CHECK EXTRACT FILE AND EXTENSION FROM PATH (1) ...';
$tests[] = $the_test;
if ((string) $get_folder . SmartFileSysUtils::add_dir_last_slash($the_sufx_folder) . $get_file != $the_file) {
$err = 'ERROR :: Path Extraction FAILED: Re-Composed-File=' . $get_folder . SmartFileSysUtils::add_dir_last_slash($the_sufx_folder) . $get_file . ' ; File=' . $the_file;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'CHECK EXTRACT FILE AND EXTENSION FROM PATH (2) ...';
$tests[] = $the_test;
if ((string) $get_file != $get_xfile . '.' . $get_ext) {
$err = 'ERROR :: Path Extraction FAILED: File=' . $get_file . ' ; XFile=' . $get_xfile . ' ; Ext=' . $get_ext;
}
//end if
}
//end if
//--
SmartFileSysUtils::raise_error_if_unsafe_path($the_folder);
if ((string) $err == '') {
$the_test = 'CHECK PATH NAME DIR: check_file_or_dir_name() : ' . $the_folder;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSysUtils::check_file_or_dir_name($the_folder);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
SmartFileSysUtils::raise_error_if_unsafe_path($the_file);
if ((string) $err == '') {
$the_test = 'CHECK PATH NAME FILE: check_file_or_dir_name() : ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSysUtils::check_file_or_dir_name($the_file);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
//--
if ((string) $err == '') {
$parent_folder = SmartFileSysUtils::add_dir_last_slash('');
$the_test = 'Check Add Dir Last (trailing) Slash: Empty Folder Name';
$tests[] = $the_test;
if ((string) $parent_folder != './') {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$parent_folder = SmartFileSysUtils::add_dir_last_slash('.');
$the_test = 'Check Add Dir Last (trailing) Slash: Dot Folder Name: ' . $parent_folder;
$tests[] = $the_test;
if ((string) $parent_folder != './') {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$parent_folder = SmartFileSysUtils::add_dir_last_slash('./');
$the_test = 'Check Add Dir Last (trailing) Slash: DotSlash Folder Name: ' . $parent_folder;
$tests[] = $the_test;
if ((string) $parent_folder != './') {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$parent_folder = SmartFileSysUtils::add_dir_last_slash(Smart::dir_name($the_base_folder));
$the_test = 'Check Parent Dir Name with Add Dir Last (trailing) Slash: ' . $parent_folder . ' # from: ' . $the_base_folder;
$tests[] = $the_test;
if ((string) $parent_folder != 'tmp/') {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
//--
if ((string) $err == '') {
if (is_dir($get_folder)) {
$the_test = 'DIR DELETE - INIT CLEANUP: dir_delete() + recursive: ' . $get_folder;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_delete($the_base_folder, true);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
} else {
$tests[] = 'DIR DELETE - INIT CLEANUP: Test Not Run (folder does not exists): ' . $get_folder;
}
//end if else
}
//end if
//--
if ((string) $err == '') {
$the_test = 'DIR CREATE RECURSIVE: dir_recursive_create() : ' . $the_folder . $long_prefixed . $short_prefixed;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_recursive_create($the_folder . $long_prefixed . $short_prefixed);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'DIR CREATE NON-RECURSIVE: dir_create() : extra/ in : ' . $the_extra_folder;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_recursive_create($the_extra_folder);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) DIRECTORY_SEPARATOR != '\\') {
// broken links do not work on Windows !
if ((string) $err == '') {
$the_test = 'CREATE BROKEN FILE LINK FOR DELETION (1): link_create() : as : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create('tmp/cache', $the_broken_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'DELETE BROKEN FILE LINK (1): delete() : as : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::delete($the_broken_link);
if ($result !== 1 || is_link($the_broken_link)) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'CREATE BROKEN FILE LINK FOR DELETION (2): link_create() : as : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create('tmp/index.html', $the_broken_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'DELETE BROKEN FILE LINK (2): dir_delete() : as : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_delete($the_broken_link);
if ($result !== 1 || is_link($the_broken_link)) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'CREATE BROKEN FILE LINK: link_create() : as : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create('tmp/index.html', $the_broken_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'CREATE BROKEN DIR LINK: link_create() : as : ' . $the_broken_dir_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create('tmp/', $the_broken_dir_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'CREATE A FILE LINK: link_create() : as : ' . $the_good_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create(Smart::real_path('tmp/index.html'), $the_good_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'CREATE A DIR LINK: link_create() : as : ' . $the_good_dir_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create(Smart::real_path('tmp/'), $the_good_dir_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'FILE WRITE with empty content: write() : ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::write($the_file, '');
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE WRITE: write() / before append : ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::write($the_file, $test_string);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE WRITE: write() +append : ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::write($the_file, $test_string, 'a');
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE READ / Append: read() Full Size: ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::read($the_file);
if ((string) SmartHashCrypto::sha512($result) != (string) SmartHashCrypto::sha512($test_string . $test_string)) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE WRITE: re-write() : ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::write($the_file, $test_string);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) DIRECTORY_SEPARATOR != '\\') {
// broken links do not work on Windows !
if ((string) $err == '') {
$the_test = 'FILE WRITE TO A BROKEN LINK: write() : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::write($the_broken_link, $test_string);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'DELETE THE BROKEN LINK AFTER write() and RE-CREATE IT : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::delete($the_broken_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'RE-CREATE BROKEN FILE LINK [AFTER WRITE]: link_create() : as : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create('tmp/index.html', $the_broken_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE WRITE: write_if_not_exists() with Content Compare to a broken link : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::write_if_not_exists($the_broken_link, $test_string, 'yes');
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'DELETE THE BROKEN LINK AFTER write_if_not_exists() and RE-CREATE IT : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::delete($the_broken_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'RE-CREATE BROKEN FILE LINK [AFTER WRITE-IF-NOT-EXISTS]: link_create() : as : ' . $the_broken_link;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::link_create('tmp/index.html', $the_broken_link);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'FILE WRITE: write_if_not_exists() without Content Compare : ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::write_if_not_exists($the_file, $test_string, 'no');
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'FILE READ: read() Full Size: ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::read($the_file);
if ((string) SmartHashCrypto::sha512($result) != (string) $test_str_cksum) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE READ: read() Partial Size, First 10 bytes: ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::read($the_file, 10);
if ((string) sha1($result) != (string) sha1(substr($test_string, 0, 10))) {
// here we read bytes so substr() not SmartUnicode::sub_str() should be used
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'FILE STATIC-READ: staticread() Full Size: ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::staticread($the_file);
if ((string) SmartHashCrypto::sha512($result) != (string) $test_str_cksum) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE STATIC-READ: staticread() Partial Size, First 10 bytes: ' . $the_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::staticread($the_file, 10);
if ((string) sha1($result) != (string) sha1(substr($test_string, 0, 10))) {
// here we read bytes so substr() not SmartUnicode::sub_str() should be used
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'FILE COPY: copy() : ' . $the_file . ' to: ' . $the_copy_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::copy($the_file, $the_copy_file);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE COPY with OVERWRITE: copy() : ' . $the_file . ' to: ' . $the_copy_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::copy($the_file, $the_copy_file, true);
// overwrite destination file(s)
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE RE-COPY (test should re-write the destination): copy() : ' . $the_file . ' to: ' . $the_move_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::copy($the_file, $the_move_file);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
} else {
$the_test = 'FILE DELETE: delete() : ' . $the_move_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::delete($the_move_file);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'FILE RENAME/MOVE: rename() : ' . $the_copy_file . ' to: ' . $the_move_file;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::rename($the_copy_file, $the_move_file);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) $err == '') {
if (is_dir('__development/')) {
//--
$the_test = 'RECURSIVE COPY (CLONE) DIR [DEVELOPMENT]: dir_copy() : ' . '__development/' . ' to: ' . $the_folder . '__development';
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_copy('__development/', $the_folder . '__development');
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
//--
if ((string) $err == '') {
$the_test = 'DIR COMPARE THE [DEVELOPMENT] SOURCE WITH [DEVELOPMENT] DESTINATION AFTER DIR COPY AND DIR MOVE:' . "\n" . 'compare_folders() : ' . '__development/' . ' with: ' . $the_folder . '__development/';
$tests[] = $the_test;
$arr_diff = array();
$arr_diff = SmartFileSystem::compare_folders('__development', $the_folder . '__development', true, true);
if (Smart::array_size($arr_diff) > 0) {
$err = 'ERROR :: ' . $the_test . ' #DIFFERENCES=' . print_r($arr_diff, 1);
}
//end if
}
//end if
//--
} else {
$tests[] = 'RECURSIVE COPY (CLONE) DIR [DEVELOPMENT]: Test Not Run (Development environment not detected) ...';
}
//end if else
}
//end if
//--
if ((string) $err == '') {
$the_test = 'RECURSIVE COPY (CLONE) DIR: dir_copy() : ' . $the_folder . ' to: ' . $the_copy_folder;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_copy($the_folder, $the_copy_folder);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'MOVE/RENAME DIR: dir_rename() : ' . $the_copy_folder . ' to: ' . $the_move_folder;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_rename($the_copy_folder, $the_move_folder);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'DIR COMPARE THE SOURCE WITH DESTINATION AFTER DIR COPY AND DIR MOVE: ' . $the_folder . ' with: ' . $the_move_folder;
$tests[] = $the_test;
$arr_diff = array();
$arr_diff = SmartFileSystem::compare_folders($the_folder, $the_move_folder, true, true);
if (Smart::array_size($arr_diff) > 0) {
$err = 'ERROR :: ' . $the_test . ' #DIFFERENCES=' . print_r($arr_diff, 1);
}
//end if
}
//end if
//--
if ((string) $err == '') {
$the_test = 'DIR DELETE - SIMPLE: dir_delete() non-recursive: ' . $the_extra_folder;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_delete($the_extra_folder, false);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
if ((string) $err == '') {
$the_test = 'DIR DELETE - LAST CLEANUP: dir_delete() + recursive: ' . $get_folder;
$tests[] = $the_test;
$result = 0;
$result = SmartFileSystem::dir_delete($the_base_folder, true);
if ($result !== 1) {
$err = 'ERROR :: ' . $the_test . ' #RESULT=' . $result;
}
//end if
}
//end if
//--
//--
$time = 'TOTAL TIME was: ' . (microtime(true) - $time);
//--
//--
$end_tests = '##### END TESTS ... ' . $time . ' sec. #####';
//--
//--
if ((string) $err == '') {
$img_sign = 'lib/core/img/sign_info.png';
$img_check = 'lib/core/img/q_completed.png';
$text_main = Smart::escape_js('<span style="color:#83B953;">Good ... Perfect :: グッド ... パーフェクト</span>');
$text_info = Smart::escape_js('<h2><span style="color:#83B953;">All</span> the SmartFramework FS Operations <span style="color:#83B953;">Tests PASSED on PHP</span><hr></h2><span style="font-size:14px;">' . Smart::nl_2_br(Smart::escape_html(implode("\n" . '* ', $tests) . "\n" . $end_tests)) . '</span>');
} else {
$img_sign = 'lib/core/img/sign_error.png';
$img_check = 'lib/core/img/q_warning.png';
$text_main = Smart::escape_js('<span style="color:#FF5500;">An ERROR occured ... :: エラーが発生しました ...</span>');
$text_info = Smart::escape_js('<h2><span style="color:#FF5500;">A test FAILED</span> when testing FS Operations.<span style="color:#FF5500;"><hr>FAILED Test Details</span>:</h2><br><h3>' . Smart::escape_html($tests[Smart::array_size($tests) - 1]) . '</h3><br><span style="font-size:14px;"><pre>' . Smart::escape_html($err) . '</pre></span>');
}
//end if else
//--
//--
$html = <<<HTML
<h1>SmartFramework LibFileSystem Tests: DONE ... [ Time: {$time} sec. ]</h1>
<script type="text/javascript">
\tSmartJS_BrowserUtils.alert_Dialog(
\t\t'<img src="{$img_sign}" align="right"><h1>{$text_main}</h1><hr><span style="color:#333333;"><img src="{$img_check}" align="right">{$text_info}<br>',
\t\t'',
\t\t'FileSystem Operations Test Suite for SmartFramework: PHP',
\t\t'920',
\t\t'480'
\t);
</script>
HTML;
//--
//--
return $html;
//--
}
public static final function DownloadsHandler($encrypted_download_pack, $controller_key)
{
//--
$encrypted_download_pack = (string) $encrypted_download_pack;
$controller_key = (string) $controller_key;
//--
$client_signature = SmartUtils::get_visitor_signature();
//--
if ((string) SMART_APP_VISITOR_COOKIE == '') {
Smart::log_info('File Download', 'Failed: 400 / Invalid Visitor Cookie' . ' on Client: ' . $client_signature);
self::Raise400Error('ERROR: Invalid Visitor UUID. Cookies must be enabled to enable this feature !');
return '';
}
//end if
//--
$downloaded_file = '';
// init
//--
$decoded_download_packet = (string) trim((string) SmartUtils::crypto_decrypt((string) $encrypted_download_pack, 'SmartFramework//DownloadLink' . SMART_FRAMEWORK_SECURITY_KEY));
//--
if ((string) $decoded_download_packet != '') {
// if data is corrupted, decrypt checksum does not match, will return an empty string
//--
if (SMART_FRAMEWORK_ADMIN_AREA === true) {
// {{{SYNC-DWN-CTRL-PREFIX}}}
$controller_key = (string) 'AdminArea/' . $controller_key;
} else {
$controller_key = (string) 'IndexArea/' . $controller_key;
}
//end if
//-- {{{SYNC-DOWNLOAD-ENCRYPT-ARR}}}
$arr_metadata = explode("\n", (string) $decoded_download_packet, 6);
// only need first 5 parts
//print_r($arr_metadata);
// #PACKET-STRUCTURE# [we will have an array like below, according with the: SmartUtils::create_download_link()]
// [TimedAccess]\n
// [FilePath]\n
// [AccessKey]\n
// [UniqueKey]\n
// [SFR.UA]\n
// #END#
//--
$crrtime = (string) trim((string) $arr_metadata[0]);
$filepath = (string) trim((string) $arr_metadata[1]);
$access_key = (string) trim((string) $arr_metadata[2]);
$unique_key = (string) trim((string) $arr_metadata[3]);
//--
unset($arr_metadata);
//--
$timed_hours = 1;
// default expire in 1 hour
if (defined('SMART_FRAMEWORK_DOWNLOAD_EXPIRE')) {
if ((int) SMART_FRAMEWORK_DOWNLOAD_EXPIRE > 0) {
if ((int) SMART_FRAMEWORK_DOWNLOAD_EXPIRE <= 24) {
// max is 24 hours (since download link is bind to unique browser signature + unique cookie ... make non-sense to keep more)
$timed_hours = (int) SMART_FRAMEWORK_DOWNLOAD_EXPIRE;
}
//end if
}
//end if
}
//end if
//--
if ((int) $timed_hours > 0) {
if ((int) $crrtime < (int) (time() - 60 * 60 * $timed_hours)) {
Smart::log_info('File Download', 'Failed: 403 / Download expired at: ' . date('Y-m-d H:i:s O', (int) $crrtime) . ' for: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise403Error('ERROR: The Access Key for this Download is Expired !');
return '';
}
//end if
}
//end if
//--
if ((string) $access_key != (string) sha1('DownloadLink:' . SMART_SOFTWARE_NAMESPACE . '-' . SMART_FRAMEWORK_SECURITY_KEY . '-' . SMART_APP_VISITOR_COOKIE . ':' . $filepath . '^' . $controller_key)) {
Smart::log_info('File Download', 'Failed: 403 / Invalid Access Key for: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise403Error('ERROR: Invalid Access Key for this Download !');
return '';
}
//end if
//--
if ((string) $unique_key != (string) SmartHashCrypto::sha1('Time=' . $crrtime . '#' . SMART_SOFTWARE_NAMESPACE . '-' . SMART_FRAMEWORK_SECURITY_KEY . '-' . $access_key . '-' . SmartUtils::unique_auth_client_private_key() . ':' . $filepath . '+' . $controller_key)) {
Smart::log_info('File Download', 'Failed: 403 / Invalid Client (Unique) Key for: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise403Error('ERROR: Invalid Client Key to Access this Download !');
return '';
}
//end if
//--
if (SmartFileSysUtils::check_file_or_dir_name($filepath)) {
//--
$skip_log = 'no';
// default log
if (defined('SMART_FRAMEWORK_DOWNLOAD_SKIP_LOG')) {
$skip_log = 'yes';
// do not log if accessed via admin area and user is authenticated
}
//end if
//--
$tmp_file_ext = (string) strtolower(SmartFileSysUtils::get_file_extension_from_path($filepath));
// [OK]
$tmp_file_name = (string) strtolower(SmartFileSysUtils::get_file_name_from_path($filepath));
//--
$tmp_eval = SmartFileSysUtils::mime_eval($tmp_file_name);
$mime_type = (string) $tmp_eval[0];
$mime_disp = (string) $tmp_eval[1];
//-- the path must not start with / but this is tested below
$tmp_arr_paths = (array) explode('/', $filepath, 2);
// only need 1st part for testing
//-- allow file downloads just from specific folders like wpub/ or wsys/ (this is a very important security fix to dissalow any downloads that are not in the specific folders)
if (substr((string) $filepath, 0, 1) != '/' and strpos((string) SMART_FRAMEWORK_DOWNLOAD_FOLDERS, '<' . trim((string) $tmp_arr_paths[0]) . '>') !== false and stripos((string) SMART_FRAMEWORK_DENY_UPLOAD_EXTENSIONS, '<' . $tmp_file_ext . '>') === false) {
//--
SmartFileSysUtils::raise_error_if_unsafe_path($filepath);
// re-test finally
//--
@clearstatcache();
//--
if (is_file($filepath)) {
//--
if (!headers_sent()) {
//--
$fp = @fopen($filepath, 'rb');
$fsize = @filesize($filepath);
//--
if (!$fp || $fsize <= 0) {
//--
Smart::log_info('File Download', 'Failed: 404 / The requested File is Empty or Not Readable: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise404Error('WARNING: The requested File is Empty or Not Readable !');
return '';
//--
}
//end if
//-- set max execution time to zero
ini_set('max_execution_time', 0);
// we can expect a long time if file is big, but this will be anyway overriden by the WebServer Timeout Directive
//--
// cache headers are presumed to be sent by runtime before of this step
//--
header('Content-Type: ' . $mime_type);
header('Content-Disposition: ' . $mime_disp);
header('Content-Length: ' . $fsize);
//--
@fpassthru($fp);
// output without reading all in memory
//--
@fclose($fp);
//--
} else {
//--
Smart::log_info('File Download', 'Failed: 500 / Headers Already Sent: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise500Error('ERROR: Download Failed, Headers Already Sent !');
return '';
//--
}
//end if else
//--
if ((string) $skip_log != 'yes') {
//--
$downloaded_file = (string) $filepath;
// return the file name to be logged
//--
}
//end if
//--
} else {
//--
Smart::log_info('File Download', 'Failed: 404 / The requested File does not Exists: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise404Error('WARNING: The requested File for Download does not Exists !');
return '';
//--
}
//end if else
} else {
//--
Smart::log_info('File Download', 'Failed: 403 / Access to this File is Denied: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise403Error('ERROR: Download Access to this File is Denied !');
return '';
//--
}
//end if else
//--
} else {
//--
Smart::log_info('File Download', 'Failed: 400 / Unsafe File Path: ' . $filepath . ' on Client: ' . $client_signature);
self::Raise400Error('ERROR: Unsafe Download File Path !');
return '';
//--
}
//end if else
//--
} else {
//--
Smart::log_info('File Download', 'Failed: 400 / Invalid Data Packet' . ' on Client: ' . $client_signature);
self::Raise400Error('ERROR: Invalid Download Data Packet !');
return '';
//--
}
//end if else
//--
return (string) $downloaded_file;
//--
}
public static function create_download_link($y_file, $y_ctrl_key)
{
//--
$y_file = (string) trim((string) $y_file);
if ((string) $y_file == '') {
Smart::log_warning('Utils / Create Download Link: Empty File Path has been provided. This means the download link will be unavaliable (empty) to assure security protection.');
return '';
}
//end if
if (!SmartFileSysUtils::check_file_or_dir_name($y_file)) {
Smart::log_warning('Utils / Create Download Link: Invalid File Path has been provided. This means the download link will be unavaliable (empty) to assure security protection. File: ' . $y_file);
return '';
}
//end if
//--
$y_ctrl_key = (string) trim((string) $y_ctrl_key);
if ((string) $y_ctrl_key == '') {
Smart::log_warning('Utils / Create Download Link: Empty Controller Key has been provided. This means the download link will be unavaliable (empty) to assure security protection.');
return '';
}
//end if
if (SMART_FRAMEWORK_ADMIN_AREA === true) {
// {{{SYNC-DWN-CTRL-PREFIX}}}
$y_ctrl_key = (string) 'AdminArea/' . $y_ctrl_key;
} else {
$y_ctrl_key = (string) 'IndexArea/' . $y_ctrl_key;
}
//end if
//--
$crrtime = (int) time();
$access_key = SmartHashCrypto::sha1('DownloadLink:' . SMART_SOFTWARE_NAMESPACE . '-' . SMART_FRAMEWORK_SECURITY_KEY . '-' . SMART_APP_VISITOR_COOKIE . ':' . $y_file . '^' . $y_ctrl_key);
$unique_key = SmartHashCrypto::sha1('Time=' . $crrtime . '#' . SMART_SOFTWARE_NAMESPACE . '-' . SMART_FRAMEWORK_SECURITY_KEY . '-' . $access_key . '-' . self::unique_auth_client_private_key() . ':' . $y_file . '+' . $y_ctrl_key);
//-- {{{SYNC-DOWNLOAD-ENCRYPT-ARR}}}
$safe_download_link = self::crypto_encrypt(trim((string) $crrtime) . "\n" . trim((string) $y_file) . "\n" . trim((string) $access_key) . "\n" . trim((string) $unique_key) . "\n" . '-' . "\n", 'SmartFramework//DownloadLink' . SMART_FRAMEWORK_SECURITY_KEY);
//--
return (string) Smart::escape_url(trim((string) $safe_download_link));
//--
}
public static function decode_mime_fileurl($y_enc_msg_file, $y_ctrl_key)
{
//--
$y_enc_msg_file = (string) trim((string) $y_enc_msg_file);
if ((string) $y_enc_msg_file == '') {
Smart::log_warning('Mail-Utils / Decode Mime File URL: Empty Message File Path has been provided. This means the URL link will be unavaliable (empty) to assure security protection.');
return '';
}
//end if
if (!SmartFileSysUtils::check_file_or_dir_name($y_enc_msg_file)) {
Smart::log_warning('Mail-Utils / Decode Mime File URL: Invalid Message File Path has been provided. This means the URL link will be unavaliable (empty) to assure security protection. Message File: ' . $y_enc_msg_file);
return '';
}
//end if
//--
$y_ctrl_key = (string) trim((string) $y_ctrl_key);
if ((string) $y_ctrl_key == '') {
Smart::log_warning('Mail-Utils / Decode Mime File URL: Empty Controller Key has been provided. This means the URL link will be unavaliable (empty) to assure security protection.');
return '';
}
//end if
if (SMART_FRAMEWORK_ADMIN_AREA === true) {
// {{{SYNC-ENCMIMEURL-CTRL-PREFIX}}}
$y_ctrl_key = (string) 'AdminMailUtilArea/' . $y_ctrl_key;
} else {
$y_ctrl_key = (string) 'IndexMailUtilArea/' . $y_ctrl_key;
}
//end if
//--
$the_sep_arr = (array) self::mime_separe_part_link($y_enc_msg_file);
$y_enc_msg_file = (string) $the_sep_arr['msg'];
$the_msg_part = (string) $the_sep_arr['part'];
unset($the_sep_arr);
//--
$arr = array();
// {{{SYNC-MIME-ENCRYPT-ARR}}}
$arr['error'] = '';
// by default, no error
//--
if ((string) SMART_APP_VISITOR_COOKIE == '') {
$arr['error'] = 'WARNING: Access Forbidden ... No Visitor ID set ...!';
return (array) $arr;
}
//end if
//--
if ((string) $the_msg_part != '') {
$the_msg_part = strtolower(trim((string) SmartUtils::url_hex_decode((string) $the_msg_part)));
}
//end if
//--
$decoded_link = trim((string) SmartUtils::crypto_decrypt((string) $y_enc_msg_file, 'SmartFramework//MimeLink' . SMART_FRAMEWORK_SECURITY_KEY));
$dec_arr = (array) explode("\n", trim((string) $decoded_link));
//print_r($dec_arr);
//--
$arr['creation-time'] = trim((string) $dec_arr[0]);
$arr['message-file'] = trim((string) $dec_arr[1]);
$arr['message-part'] = trim((string) $the_msg_part);
$arr['access-key'] = trim((string) $dec_arr[2]);
$arr['bw-unique-key'] = trim((string) $dec_arr[3]);
$arr['sf-robot-key'] = trim((string) $dec_arr[4]);
//-- check if file path is valid
if ((string) $arr['message-file'] == '') {
$arr = array();
$arr['error'] = 'ERROR: Empty Message Path ...';
return (array) $arr;
}
//end if
if (!SmartFileSysUtils::check_file_or_dir_name($arr['message-file'])) {
$arr = array();
$arr['error'] = 'ERROR: Unsafe Message Path Access ...';
return (array) $arr;
}
//end if
//--
$browser_os_ip_identification = SmartUtils::get_os_browser_ip();
// get browser and os identification
//-- re-compose the access key
$crrtime = (int) $arr['creation-time'];
$access_key = sha1('MimeLink:' . SMART_SOFTWARE_NAMESPACE . '-' . SMART_FRAMEWORK_SECURITY_KEY . '-' . SMART_APP_VISITOR_COOKIE . ':' . $arr['message-file'] . '>' . $y_ctrl_key);
$uniq_key = sha1('Time=' . $crrtime . '#' . SMART_SOFTWARE_NAMESPACE . '-' . SMART_FRAMEWORK_SECURITY_KEY . '-' . $access_key . '-' . SmartUtils::unique_auth_client_private_key() . ':' . $arr['message-file'] . '>' . $y_ctrl_key);
$self_robot_key = sha1('Time=' . $crrtime . '#' . SmartAuth::get_login_id() . '*' . SMART_SOFTWARE_NAMESPACE . '-' . SMART_FRAMEWORK_SECURITY_KEY . '-' . trim($browser_os_ip_identification['signature']) . '$' . $access_key . ':' . $arr['message-file'] . '>' . $y_ctrl_key);
//-- check access key
if ((string) $arr['error'] == '') {
if ((string) $access_key != (string) $arr['access-key']) {
$arr = array();
$arr['error'] = 'ERROR: Access Forbidden ... Invalid ACCESS KEY ...';
}
//end if
}
//end if
//-- check the client key
if ((string) $arr['error'] == '') {
//--
$ok_client_key = false;
//--
if ((string) $the_msg_part == '' and (string) $arr['bw-unique-key'] == (string) $uniq_key) {
// no message part, allow only client browser
$ok_client_key = true;
} elseif ((string) $the_msg_part != '' and ((string) $arr['bw-unique-key'] == (string) $uniq_key or (string) $browser_os_ip_identification['bw'] == '@s#' and (string) $arr['sf-robot-key'] == (string) $self_robot_key)) {
$ok_client_key = true;
} else {
$ok_client_key = false;
}
//end if else
//--
if ($ok_client_key != true) {
$arr = array();
$arr['error'] = 'ERROR: Access Forbidden ... Invalid CLIENT KEY ...';
}
//end if
//--
}
//end if
//--
return (array) $arr;
//--
}
