displayControl();
} else {
echo(false);
}
} elseif($_GET['action'] == 'control-post-list-show') {
if(isset($_POST['module_id'])) {
$all_modules = K2SBM::get_all_modules();
$all_modules[$_POST['module_id']]->displayPostList();
} else {
echo(false);
}
} elseif($_GET['action'] == 'control-page-list-show') {
if(isset($_POST['module_id'])) {
$all_modules = K2SBM::get_all_modules();
$all_modules[$_POST['module_id']]->displayPageList();
} else {
echo(false);
}
} else {
// Set the output type
header('Content-type: text/xml');
// XML prelude
echo('');
// Begin the response
echo('');
// Check what the action is
switch($_GET['action']) {
// List of the modules in the sidebar
case 'list':
foreach($k2sbm_registered_sidebars as $sidebar) {
$tmp_modules[] = $sidebar->modules;
}
$tmp_modules[] = $k2sbm_disabled_modules;
if($tmp_modules) {
// Output the modules
foreach($tmp_modules as $modules) {
echo('');
if($modules) {
foreach($modules as $module) {
// With a little help from PHP.net - Woo!
echo('' . preg_replace('/([^\x09\x0A\x0D\x20-\x7F]|[\x21-\x2F]|[\x3A-\x40]|[\x5B-\x60])/e', '"&#".ord("$0").";"', utf8_decode($module->name)) . '');
}
}
echo('');
}
}
break;
// Add a module to the sidebar
case 'add':
// Check the title was correct
if(isset($_POST['add_name']) and trim((string)($_POST['add_name'])) != '') {
K2SBM::add_module(stripslashes($_POST['add_name']), $_POST['add_type'], $_POST['add_sidebar']);
} else {
K2SBM::set_error_text(__('You must specify a valid module name', 'k2_domain'));
}
break;
// Update a module
case 'update':
if(isset($_POST['sidebar_id']) and isset($_POST['module_id'])) {
K2SBM::update_module($_POST['sidebar_id'], $_POST['module_id']);
} else {
K2SBM::set_error_text(__('Missing sidebar and module ids', 'k2_domain'));
}
break;
// Remove a module from the sidebar
case 'remove':
if(isset($_POST['sidebar_id']) and isset($_POST['module_id'])) {
K2SBM::remove_module($_POST['sidebar_id'], $_POST['module_id']);
} else {
K2SBM::set_error_text(__('Missing sidebar and module ids', 'k2_domain'));
}
break;
// Re-order the modules in the sidebar
case 'reorder':
if(isset($_POST['sidebar_ordering'])) {
K2SBM::reorder_sidebar($_POST['sidebar_ordering']);
} else {
K2SBM::set_error_text(__('Missing ordering data', 'k2_domain'));
}
break;
// Error
default:
K2SBM::set_error_text(__('Invalid call', 'k2_domain'));
break;
}
if($k2sbm_error_text != null) {
echo('' . $k2sbm_error_text . '');
echo(false);
} else {
echo(true);
}
// End the response
echo('');
// Safeguard
wp_cache_flush();
}
}
function pre_bootstrap() {
// Load the modules
K2SBM::load_modules();
// Scan for in-built modules
K2SBM::module_scan();
}
function post_bootstrap() {
// Allow the Widgets and SBM defined in plugins & themes to be loaded
do_action('sbm_init');
do_action('widgets_init');
}
function k2_init() {
// Add menus
add_action('admin_menu', array('K2SBM', 'add_menus'));
// Check if this page is the one being shown, if so then add stuff to the header
if($_GET['page'] == 'k2-sbm-modules') {
add_action('admin_head', array('K2SBM', 'module_admin_head'));
}
}
function add_menus() {
// Add the submenus
add_submenu_page('themes.php', __('K2 Sidebar Modules', 'k2_domain'), __('K2 Sidebar Modules', 'k2_domain'), 5, 'k2-sbm-modules', array('K2SBM', 'module_admin'));
}
function module_admin() {
global $k2sbm_registered_sidebars, $k2sbm_registered_modules;
if(count($k2sbm_registered_sidebars) == 0) {
?>
You have no registered sidebars.
You have no modules or Widgets installed & activated.
\n";
$sidebar = new k2sbmSidebar($args['name'], $args['before_widget'], $args['after_widget'], $args['before_title'], $args['after_title']);
// Add the sidebar to the list
$k2sbm_registered_sidebars[$sidebar->id] = $sidebar;
}
function unregister_sidebar($name) {
global $k2sbm_registered_sidebars;
$id = K2SBM::name_to_id($name);
// Unregister the sidebar
unset($k2sbm_registered_sidebars[$id]);
}
function get_sidebars() {
global $k2sbm_registered_sidebars;
return $k2sbm_registered_sidebars;
}
function register_sidebars($count = 1, $args = array()) {
// Apparently, WPW lets you pass arguments as a string
if(is_string($args)) {
parse_str($args, $args);
}
// Check for a name
$arg_name = isset($args['name']) ? $args['name'] : __('Sidebar %d', 'k2_domain');
// Check there is a count in the name
if(!strstr($arg_name, '%d')) {
$arg_name += __(' %d', 'k2_domain');
}
// Register the sidebars
for($i = 0; $i < $count; $i++) {
$args['name'] = sprintf($arg_name, $i + 1);
register_sidebar($args);
}
}
function dynamic_sidebar($name = 1) {
global $k2sbm_registered_sidebars;
$return = false;
if(count($k2sbm_registered_sidebars) > 0) {
// Check if this is an integer ID of a sidebar
if(is_int($name)) {
$name = sprintf(__('Sidebar %d', 'k2_domain'), $name);
}
// Get the sidebar
$id = K2SBM::name_to_id($name);
if(isset($k2sbm_registered_sidebars[$id])) {
$return = $k2sbm_registered_sidebars[$id]->display();
}
}
return $return;
}
function load_modules() {
global $k2sbm_active_modules, $k2sbm_disabled_modules;
if(empty($k2sbm_active_modules) and empty($k2sbm_disabled_modules)) {
$k2sbm_active_modules = get_option('k2sbm_modules_active');
$k2sbm_disabled_modules = get_option('k2sbm_modules_disabled');
}
}
function save_modules() {
global $k2sbm_active_modules, $k2sbm_disabled_modules;
update_option('k2sbm_modules_active', $k2sbm_active_modules);
update_option('k2sbm_modules_disabled', $k2sbm_disabled_modules);
}
function register_sidebar_module($name, $callback, $css_class = '', $options = array()) {
global $k2sbm_registered_modules;
// Another odd bit of WPW code
// Better include it for the sake of Widget developers
if(is_array($name)) {
$id = K2SBM::name_to_id(sprintf($name[0], $name[2]));
$name = sprintf(__($name[0], $name[1], 'k2_domain'), $name[2]);
} else {
$id = K2SBM::name_to_id($name);
$name = __($name, 'k2_domain');
}
$css_class = (string)$css_class == '' ? (string)$callback : $css_class;
// Add the module to the array
$k2sbm_registered_modules[$id] = array(
'name' => $name,
'callback' => $callback,
'control_callback' => '',
'css_class' => $css_class,
'options' => $options
);
}
function unregister_sidebar_module($name) {
global $k2sbm_registered_modules;
$id = K2SBM::name_to_id($name);
// Unset the module
unset($k2sbm_registered_modules[$id]);
}
function is_active_module($callback) {
global $k2sbm_registered_modules, $k2sbm_active_modules, $wp_query;
$active = false;
if($k2sbm_active_modules) {
$tmp_modules = array_values($k2sbm_active_modules);
// Check if a module with this callback is active
for($i = 0; $i < count($tmp_modules) and !$active; $i++) {
for($j = 0; $j < count($tmp_modules[$i]) and !$active; $j++) {
$current_module = $tmp_modules[$i][$j];
// We can only check if the module can be displayed if $wp_query is set
// Otherwise, just assume it can. Ugly, but true.
if($k2sbm_registered_modules[$current_module->type]['callback'] == $callback
and (!$wp_query or $current_module->canDisplay())
) {
$active = true;
}
}
}
}
return $active;
}
function register_sidebar_module_control($name, $callback) {
global $k2sbm_registered_modules;
// Another odd bit of WPW code
// Better include it for the sake of Widget developers
if(is_array($name)) {
$id = K2SBM::name_to_id(sprintf($name[0], $name[2]));
$name = sprintf(__($name[0], $name[1], 'k2_domain'), $name[2]);
} else {
$id = K2SBM::name_to_id($name);
$name = __($name, 'k2_domain');
}
// Add the module control to the array
if($k2sbm_registered_modules[$id]) {
$k2sbm_registered_modules[$id]['control_callback'] = $callback;
}
}
function unregister_sidebar_module_control($name) {
global $k2sbm_registered_modules;
$id = K2SBM::name_to_id($name);
// Unset the module control
// Add the module control to the array
if($k2sbm_registered_modules[$id]) {
$k2sbm_registered_modules[$id]['control_callback'] = '';
}
}
function get_installed_modules() {
global $k2sbm_registered_modules;
// Sort the list of registered modules
asort($k2sbm_registered_modules);
// Return the list
return $k2sbm_registered_modules;
}
function module_scan() {
K2SBM::module_scan_dir(dirname(dirname(__FILE__)) . '/modules/');
}
function module_scan_dir($directory_path) {
// Open the module directory
$dir = dir($directory_path);
// Get all the files from the directory
while(($file = $dir->read()) !== false) {
// Check the file is a module file
if(is_file($directory_path . $file) and preg_match('/^(.+)\.php$/i', $file)) {
// Include the file
require_once($directory_path . $file);
}
}
// Close the widget directory
$dir->close();
}
function get_all_modules() {
global $k2sbm_active_modules, $k2sbm_disabled_modules;
$all_modules = array();
if($k2sbm_active_modules) {
foreach($k2sbm_active_modules as $sidebar_modules) {
foreach($sidebar_modules as $sidebar_module) {
$all_modules[$sidebar_module->id] = $sidebar_module;
}
}
}
if($k2sbm_disabled_modules) {
foreach($k2sbm_disabled_modules as $sidebar_module) {
$all_modules[$sidebar_module->id] = $sidebar_module;
}
}
return $all_modules;
}
function add_module($name, $type, $sidebar) {
global $k2sbm_registered_modules, $k2sbm_active_modules, $k2sbm_disabled_modules;
$module_id = K2SBM::name_to_id($type);
// Load the base module
$base_module = $k2sbm_registered_modules[$module_id];
// Check the base module is registered
if($base_module) {
// Create the ID for the module
// Quick & cheap
$next_id = get_option('k2sbm_modules_next_id');
$module_id = 'module-' . $next_id;
update_option('k2sbm_modules_next_id', ++$next_id);
// Create the new module
$new_module = new k2sbmModule($module_id, $name, $type, $base_module['options']);
// Add the module to the list
if($sidebar == 'disabled') {
$k2sbm_disabled_modules[] = $new_module;
} else {
$k2sbm_active_modules[K2SBM::name_to_id($sidebar)][] = $new_module;
}
K2SBM::save_modules();
}
}
function update_module($sidebar_id, $module_id) {
global $k2sbm_disabled_modules, $k2sbm_active_modules;
// Start the capture
ob_start();
if($sidebar_id == 'disabled') {
foreach($k2sbm_disabled_modules as $key => $module) {
if($module->id == $module_id) {
$k2sbm_disabled_modules[$key]->displayControl();
}
}
} else {
foreach($k2sbm_active_modules[$sidebar_id] as $key => $module) {
if($module->id == $module_id) {
$k2sbm_active_modules[$sidebar_id][$key]->displayControl();
}
}
}
K2SBM::save_modules();
// Junk the capture
ob_end_clean();
}
function remove_module($sidebar_id, $module_id) {
global $k2sbm_disabled_modules, $k2sbm_active_modules;
if($sidebar_id == 'disabled') {
foreach($k2sbm_disabled_modules as $key => $module) {
if($module->id == $module_id) {
unset($k2sbm_disabled_modules[$key]);
}
}
} else {
foreach($k2sbm_active_modules[$sidebar_id] as $key => $module) {
if($module->id == $module_id) {
unset($k2sbm_active_modules[$sidebar_id][$key]);
}
}
}
K2SBM::save_modules();
}
function reorder_sidebar($ordering) {
global $k2sbm_disabled_modules, $k2sbm_active_modules;
$all_modules = K2SBM::get_all_modules();
$k2sbm_disabled_modules = array();
$k2sbm_active_modules = array();
foreach($ordering as $sidebar_id => $modules) {
if($sidebar_id == 'disabled') {
foreach($modules as $module_id) {
$k2sbm_disabled_modules[] = $all_modules[$module_id];
}
} else {
foreach($modules as $module_id) {
$k2sbm_active_modules[$sidebar_id][] = $all_modules[$module_id];
}
}
}
K2SBM::save_modules();
}
function output_module_css_files() {
global $k2sbm_active_modules;
$css_files = array();
foreach($k2sbm_active_modules as $modules) {
foreach($modules as $module) {
// If this module has a CSS file to show, and will be shown on this page
// then get the file
if($module->output['css_file'] and $module->canDisplay()) {
$css_files[] = $module->output['css_file'];
}
}
}
// Strip duplicates
$css_files = array_unique($css_files);
// Output the links
if($css_files) {
foreach($css_files as $css_file) {
echo('');
}
}
}
function name_to_id($name) {
// Use the WP function to do this
return sanitize_title($name);
}
}
class k2sbmSidebar {
var $id;
var $name;
var $before_module;
var $after_module;
var $before_title;
var $after_title;
var $modules;
function k2sbmSidebar($name, $before_module, $after_module, $before_title, $after_title) {
global $k2sbm_active_modules;
// Set the generic data from the parameters
$this->id = K2SBM::name_to_id($name);
$this->name = $name;
$this->before_module = $before_module;
$this->after_module = $after_module;
$this->before_title = $before_title;
$this->after_title = $after_title;
$this->modules = array();
// Load the modules
if($k2sbm_active_modules[$this->id]) {
foreach($k2sbm_active_modules[$this->id] as $module_id => $module) {
$this->modules[$module_id] = $module;
}
}
}
function display() {
// Check there are some modules present
if(count($this->modules) > 0) {
$return = false;
// Output the modules
foreach($this->modules as $module) {
$return |= $module->display($this);
}
return $return;
} else {
return false;
}
}
}
class k2sbmModule {
var $id;
var $name;
var $type;
var $display;
var $output;
var $options;
function k2sbmModule($id, $name, $type, $options) {
// Set the generic data from the parameters
$this->id = $id;
$this->name = $name;
$this->type = $type;
$this->display = array(
'home' => true,
'archives' => true,
'post' => true,
'post_id' => array('show' => 'show', 'ids' => false),
'search' => true,
'pages' => true,
'page_id' => array('show' => 'show', 'ids' => false),
'error' => true
);
$this->output = array('show_title' => true, 'css_file' => false);
$this->options = $options;
}
function display($sidebar) {
global $k2sbm_registered_modules, $k2sbm_current_module, $post;
static $k2sbm_count_id;
// Get the base module details
$base_module = $k2sbm_registered_modules[$this->type];
// Check that the function exists & that this module is to be displayed
if(function_exists($base_module['callback'])) {
if($this->canDisplay()) {
$k2sbm_current_module = $this;
$id = K2SBM::name_to_id($this->name);
$k2sbm_count_id[$id]++;
$id = $id . ($k2sbm_count_id[$id] > 1 ? '-' . $k2sbm_count_id[$id] : '');
// Call the display callback
$params[0] = array(
'before_module' => sprintf($sidebar->before_module, $id, $base_module['css_class']),
'after_module' => $sidebar->after_module
);
// Allow the user to hide the title, simplest method is to unset the title elements
if($this->output['show_title']) {
$params[0]['before_title'] = $sidebar->before_title;
$params[0]['title'] = $this->name;
$params[0]['after_title'] = $sidebar->after_title;
} else {
$params[0]['before_title'] = '';
$params[0]['title'] = '';
$params[0]['after_title'] = '';
}
$params[0]['before_widget'] = $params[0]['before_module'];
$params[0]['after_widget'] = $params[0]['after_module'];
call_user_func_array($base_module['callback'], $params);
// Update options in any PHP < 5
if(version_compare(PHP_VERSION, '5.0') < 0) {
foreach($k2sbm_current_module->options as $key => $value) {
$this->update_option($key, $value);
}
}
$k2sbm_current_module = false;
return true;
}
} else {
// Remove this module - it dosn't exist properly
K2SBM::remove_module($sidebar->id, $this->id);
}
return false;
}
function displayControl() {
global $k2sbm_registered_modules, $k2sbm_current_module;
// Handle default control stuff
// Handle the module name form
if(isset($_POST['module_name']) and trim((string)$_POST['module_name']) != '') {
$this->name = stripslashes((string)$_POST['module_name']);
} else {
K2SBM::set_error_text(__('You must specify a valid module name', 'k2_domain'));
}
// Handle the advanced output options form
if(isset($_POST['output'])) {
// Don't set anything...
foreach($this->output as $key => $value) {
$this->output[$key] = false;
}
// ...unless given
foreach($_POST['output'] as $key => $value) {
$this->output[$key] = $value;
}
}
// Handle the module display form
if(isset($_POST['display'])) {
// Store the page and post IDs, AJAX mess
$old_post_id = $this->display['post_id'];
$old_page_id = $this->display['page_id'];
// Don't display anything...
foreach($this->display as $page => $display) {
$this->display[$page] = false;
}
// ...unless specified
foreach($_POST['display'] as $page => $display) {
$this->display[$page] = $display;
}
// Add the exceptional circumstances, if required
if(!isset($_POST['display']['post_id'])) {
$this->display['post_id'] = $old_post_id;
}
if(!isset($_POST['display']['page_id'])) {
$this->display['page_id'] = $old_page_id;
}
}
// Display the generic edit form
extract(array('module' => $this));
include(TEMPLATEPATH . '/app/display/sbm-ajax/edit-module-form.php');
// Get the base module details
$base_module = $k2sbm_registered_modules[$this->type];
if(function_exists($base_module['control_callback'])) {
$k2sbm_current_module = $this;
// Call the control callback
call_user_func($base_module['control_callback']);
// Update options in any PHP < 5
if(version_compare(PHP_VERSION, '5.0') < 0) {
foreach($k2sbm_current_module->options as $key => $value) {
$this->update_option($key, $value);
}
}
$k2sbm_current_module = false;
return true;
} else {
return false;
}
}
function displayPostList() {
// Display the generic post list
extract(array('module' => $this));
include(TEMPLATEPATH . '/app/display/sbm-ajax/edit-module-posts-form.php');
?>
$this));
include(TEMPLATEPATH . '/app/display/sbm-ajax/edit-module-pages-form.php');
}
function canDisplay() {
global $post;
return ($this->display['home'] and is_home())
or ($this->display['archives'] and (is_archive() or (function_exists('is_tag') and is_tag())))
or ($this->display['post'] and is_single() and (
!$this->display['post_id']['ids']
or ($this->display['post_id']['show'] == 'show' and $this->display['post_id']['ids'][$post->ID])
or ($this->display['post_id']['show'] == 'hide' and !$this->display['post_id']['ids'][$post->ID]))
)
or ($this->display['search'] and is_search())
or ($this->display['pages'] and is_page() and (
!$this->display['page_id']['ids']
or ($this->display['page_id']['show'] == 'show' and $this->display['page_id']['ids'][$post->ID])
or ($this->display['page_id']['show'] == 'hide' and !$this->display['page_id']['ids'][$post->ID]))
)
or ($this->display['error'] and (is_404() or !($post or have_posts()))
);
}
function get_option($name) {
return $this->options[$name];
}
function add_option($name, $value = '') {
$this->options[$name] = $value;
}
function update_option($name, $newvalue) {
$this->options[$name] = $newvalue;
}
function delete_option($name) {
unset($this->options[$name]);
}
}
add_action('k2_install', array('K2SBM', 'install'));
add_action('k2_uninstall', array('K2SBM', 'uninstall'));
?>