Copyright (C) 2004-2009, Ryan Djurovich
Website Baker is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Website Baker is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Website Baker; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
This file contains routines to edit the optional module files: frontend.css and backend.css
Mechanism was introduced with WB 2.7 to provide a global solution for all modules
To use this function, include this file from your module (e.g. from modify.php)
Then simply call the function edit_css('your_module_directory') - that�s it
NOTE: Some functions were added for module developers to make the creation of own module easier
*/
/* -------------------------------------------------------- */
// Must include code to stop this file being accessed directly
if(!defined('WB_PATH')) {
require_once(dirname(__FILE__).'/globalExceptionHandler.php');
throw new IllegalFileException();
}
/* -------------------------------------------------------- */
/*
:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
FUNCTIONS REQUIRED TO EDIT THE OPTIONAL MODULE CSS FILES
:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
*/
// this function checks the validity of the specified module directory
if(!function_exists('check_module_dir')) {
function check_module_dir($mod_dir) {
// check if module directory is formal correct (only characters: "a-z,0-9,_,-")
if(!preg_match('/^[a-z0-9_-]+$/iD', $mod_dir)) return '';
// check if the module folder contains the required info.php file
return (file_exists(WB_PATH .'/modules/' .$mod_dir .'/info.php')) ? $mod_dir : '';
}
}
// this function checks if the specified optional module file exists
if (!function_exists('mod_file_exists')) {
function mod_file_exists($mod_dir, $mod_file='frontend.css') {
// check if the module file exists
return file_exists(WB_PATH .'/modules/' .$mod_dir .'/' .$mod_file);
}
}
// this function displays the "Edit CSS" button in modify.php
if (!function_exists('edit_module_css')) {
function edit_module_css($mod_dir) {
global $page_id, $section_id, $admin;
// check if the required edit_module_css.php file exists
if(!file_exists(WB_PATH .'/modules/edit_module_files.php')) return;
// check if specified module directory is valid
if(check_module_dir($mod_dir) == '') return;
// check if frontend.css or backend.css exist
$frontend_css = mod_file_exists($mod_dir, 'frontend.css');
$backend_css = mod_file_exists($mod_dir, 'backend.css');
// output the edit CSS submtin button if required
if($frontend_css || $backend_css) {
// default text used for the edit CSS routines if not defined in the WB core language files
$edit_css_caption = (isset($GLOBALS['TEXT_CAP_EDIT_CSS'])) ?$GLOBALS['TEXT_CAP_EDIT_CSS'] :'Edit CSS';
?>
Error: ';
echo 'Default language file (EN.php) of module "' .htmlentities($mymod_dir) .'" does not exist.
';
return false;
}
}
}
}
// function to include module CSS files in (only if WB < 2.6.7 or register_frontend_modfiles('css') not invoked in template)
if (!function_exists('include_module_css')) {
function include_module_css($mymod_dir, $css_file) {
if(!in_array(strtolower($css_file), array('frontend.css', 'backend.css'))) return;
if($css_file == 'frontend.css') {
// check if frontend.css needs to be included into the section
if(!((!function_exists('register_frontend_modfiles') || !defined('MOD_FRONTEND_CSS_REGISTERED')) &&
file_exists(WB_PATH .'/modules/' .$mymod_dir .'/frontend.css'))) {
return false;
}
} else {
// check if backend.css needs to be included into the section
global $admin;
if(!(!method_exists($admin, 'register_backend_modfiles') && file_exists(WB_PATH .'/modules/' .$mymod_dir .'/backend.css'))) {
return false;
}
}
// include frontend.css or backend.css into the section
echo "\n".'\n";
return true;
}
}
// function to check if the optional module Javascript files are loaded into the section
if (!function_exists('requires_module_js')) {
function requires_module_js($mymod_dir, $js_file) {
if(!in_array(strtolower($js_file), array('frontend.js', 'backend.js'))) {
echo 'Note: Javascript file "' .htmlentities($js_file) .'"
specified in module "' .htmlentities($mymod_dir) .'" not valid.';
return false;
}
if($js_file == 'frontend.js') {
// check if frontend.js is included to the section
if(!defined('MOD_FRONTEND_JAVASCRIPT_REGISTERED')) {
echo 'Note: The module: "' .htmlentities($mymod_dir) .'" requires WB 2.6.7 or higher
This module uses Javascript functions contained in frontend.js of the module.
Add the code below to the <head> section in the index.php of your template
to ensure that module frontend.js files are automatically loaded if required.
<?php
if(function_exists(\'register_frontend_modfiles\')) {
register_frontend_modfiles(\'js\');
?>
Tip: For WB 2.6.7 copy the code above to the index.php of your template.
Then open the view.php of the "' .htmlentities($mymod_dir) .'" module and set the variable
$requires_frontend_js to false. This may do the trick.
All WB versions below 2.6.7 needs
to be upgraded to work with this module.
';
return false;
}
} else {
// check if backend.js is included to the section
global $admin;
if(!method_exists($admin, 'register_backend_modfiles') && file_exists(WB_PATH .'/modules/' .$mymod_dir .'/backend.js')) {
echo 'Note: The module: "' .htmlentities($mymod_dir) .'" requires WB 2.6.7 or higher
This module uses Javascript functions contained in backend.js of the module.
You need WB 2.6.7 or higher to ensure that module backend.js files are automatically loaded if required.
Sorry, you can not use this tool with your WB installation, please upgrade to the latest WB version available.
';
return false;
}
}
return true;
}
}
// function to check if the optional module Javascript files are loaded into the section
if (!function_exists('requires_module_body_js')) {
function requires_module_body_js($mymod_dir, $js_file) {
if(!in_array(strtolower($js_file), array('frontend_body.js', 'backend_body.js'))) {
echo 'Note: Javascript file "' .htmlentities($js_file) .'"
specified in module "' .htmlentities($mymod_dir) .'" not valid.';
return false;
}
if($js_file == 'frontend_body.js') {
// check if frontend_body.js is included to the section
if(!defined('MOD_FRONTEND_BODY_JAVASCRIPT_REGISTERED')) {
echo 'Note: The module: "' .htmlentities($mymod_dir) .'" requires WB 2.6.7 or higher
This module uses Javascript functions contained in frontend_body.js of the module.
Add the code below before to the </body> section in the index.php of your template
to ensure that module frontend_body.js files are automatically loaded if required.
<?php
if(function_exists(\'register_frontend_modfiles_body\')) {
register_frontend_modfiles_body(\'js\');
?>
Tip: For WB 2.6.7 copy the code above to the index.php of your template.
Then open the view.php of the "' .htmlentities($mymod_dir) .'" module and set the variable
$requires_frontend_body_js to false. This may do the trick.
All WB versions below 2.6.7 needs
to be upgraded to work with this module.
';
return false;
}
} else {
// check if backend_body.js is included to the section
global $admin;
if(!method_exists($admin, 'register_backend_modfiles_body') && file_exists(WB_PATH .'/modules/' .$mymod_dir .'/backend_body.js')) {
echo 'Note: The module: "' .htmlentities($mymod_dir) .'" requires WB 2.6.7 or higher
This module uses Javascript functions contained in backend_body.js of the module.
You need WB 2.6.7 or higher to ensure that module backend_body.js files are automatically loaded if required.
Sorry, you can not use this tool with your WB installation, please upgrade to the latest WB version available.
';
return false;
}
}
return true;
}
}