Merge pull request #54 from cash/dev-tools

Fixes #3564 Adds the inspection tool and logging to the web page

1 files changed, 111 insertions, 0 deletions

diff --git a/mod/developers/start.php b/mod/developers/start.php
index c05432e30..d9e1141e0 100644
--- a/mod/developers/start.php
+++ b/mod/developers/start.php
@@ -12,11 +12,19 @@ function developers_init() {
 	elgg_register_event_handler('pagesetup', 'system', 'developers_setup_menu');
 
 	elgg_extend_view('css/admin', 'developers/css');
+	elgg_extend_view('css/elgg', 'developers/css');
 
 	elgg_register_page_handler('theme_preview', 'developers_theme_preview_controller');
 
 	$action_base = elgg_get_plugins_path() . 'developers/actions/developers';
 	elgg_register_action('developers/settings', "$action_base/settings.php", 'admin');
+	elgg_register_action('developers/inspect', "$action_base/inspect.php", 'admin');
+
+	elgg_register_js('jquery.jstree', 'mod/developers/vendors/jsTree/jquery.jstree.js', 'footer');
+	elgg_register_css('jquery.jstree', 'mod/developers/vendors/jsTree/themes/default/style.css');
+
+	elgg_register_js('elgg.dev', 'js/developers/developers.js', 'footer');
+	elgg_load_js('elgg.dev');
 }
 
 function developers_process_settings() {
@@ -25,16 +33,119 @@ function developers_process_settings() {
 	} else {
 		ini_set('display_errors', 0);
 	}
+
+	if (elgg_get_plugin_setting('screen_log', 'developers') == 1) {
+		$cache = new ElggLogCache();
+		elgg_set_config('log_cache', $cache);
+		elgg_register_plugin_hook_handler('debug', 'log', array($cache, 'insertDump'));
+		elgg_extend_view('page/elements/foot', 'developers/log');
+	}
+
+	if (elgg_get_plugin_setting('show_strings', 'developers') == 1) {
+		// first and last in case a plugin registers a translation in an init method
+		elgg_register_event_handler('init', 'system', 'developers_clear_strings', 1000);
+		elgg_register_event_handler('init', 'system', 'developers_clear_strings', 1);
+	}
+
+	if (elgg_get_plugin_setting('wrap_views', 'developers') == 1) {
+		elgg_register_plugin_hook_handler('view', 'all', 'developers_wrap_views');
+	}
+
+	if (elgg_get_plugin_setting('log_events', 'developers') == 1) {
+		elgg_register_event_handler('all', 'all', 'developers_log_events', 1);
+		elgg_register_plugin_hook_handler('all', 'all', 'developers_log_events', 1);
+	}
 }
 
 function developers_setup_menu() {
 	if (elgg_in_context('admin')) {
 		elgg_register_admin_menu_item('develop', 'settings', 'developers');
+		elgg_register_admin_menu_item('develop', 'inspect', 'developers');
 		elgg_register_admin_menu_item('develop', 'preview', 'developers');
 	}
 }
 
 /**
+* Clear all the strings so the raw descriptor strings are displayed
+*/
+function developers_clear_strings() {
+	global $CONFIG;
+
+	$language = get_language();
+	$CONFIG->translations[$language] = array();
+	$CONFIG->translations['en'] = array();
+}
+
+/**
+ * Post-process a view to add wrapper comments to it
+ */
+function developers_wrap_views($hook, $type, $result, $params) {
+	if (elgg_get_viewtype() != "default") {
+		return;
+	}
+
+	$excluded_bases = array('css', 'js', 'input', 'output', 'embed', 'icon',);
+
+	$excluded_views = array(
+		'page/default',
+		'page/admin',
+		'page/elements/head',
+	);
+
+	$view = $params['view'];
+
+	$view_hierarchy = explode('/',$view);
+	if (in_array($view_hierarchy[0], $excluded_bases)) {
+		return;
+	}
+
+	if (in_array($view, $excluded_views)) {
+		return;
+	}
+
+	if ($result) {
+		$result = "<!-- developers:begin $view -->$result<!-- developers:end $view -->";
+	}
+
+	return $result;
+}
+
+/**
+* Log the events and plugin hooks
+*/
+function developers_log_events($name, $type) {
+
+	// filter out some very common events
+	if ($name == 'view' || $name == 'display' || $name == 'log' || $name == 'debug') {
+		return;
+	}
+	if ($name == 'session:get' || $name == 'validate') {
+		return;
+	}
+
+	$stack = debug_backtrace();
+	if ($stack[2]['function'] == 'elgg_trigger_event') {
+		$event_type = 'Event';
+	} else {
+		$event_type = 'Plugin hook';
+	}
+	$function = $stack[3]['function'] . '()';
+	if ($function == 'require_once' || $function == 'include_once') {
+		$function = $stack[3]['file'];
+	}
+
+	$msg = elgg_echo('developers:event_log_msg', array(
+		$event_type,
+		$name,
+		$type,
+		$function,
+	));
+	elgg_dump($msg, false, 'WARNING');
+
+	unset($stack);
+}
+
+/**
  * Serve the theme preview pages
  *
  * @param array $page