1.0.0

Author: benkeen

system_check/files.php renamed to files.php

@@ -77,7 +77,7 @@
   case "verify_component_files":
   	$component = $request["component"];
 
-  	$return_info = array("result" => "pass", "bah" => "stupid");
+  	$return_info = array("result" => "pass");
   	if ($component == "core")
   	{
       $missing_files = sc_check_core_files();
@@ -108,12 +108,6 @@
     }
     echo ft_convert_to_json($return_info);
   	break;
-
-  case "find_table_orphans":
-  	$remove_orphans = isset($request["remove_orphans"]) ? true : false;
-    $results = sc_find_table_orphans($request["table_name"], $remove_orphans);
-    echo ft_convert_to_json($results);
-  	break;
 }
 
 

system_check/global/code/actions.php renamed to global/code/actions.php

@@ -0,0 +1,129 @@
+<?php
+
+
+/**
+ * Figures out which (if any) of the installed modules are available for a particular test.
+ *
+ * @param string $test "tables", "hooks" or "files"
+ * @return array all compatible modules (not the module_config.php info).
+ */
+function sc_get_compatible_modules($test)
+{
+  global $g_root_dir;
+
+  $module_list = ft_get_modules();
+
+  $compatible_modules = array();
+  foreach ($module_list as $module_info)
+  {
+    $module_folder = $module_info["module_folder"];
+    if ($module_info["is_installed"] != "yes")
+      continue;
+
+    $module_config = sc_get_module_config_file_contents($module_folder);
+    if (!$module_config["is_compatible"])
+      continue;
+
+    $relevant = false;
+    switch ($test)
+    {
+    	case "tables":
+    		if ($module_config["includes_table_info"])
+    		  $relevant = true;
+    		break;
+      case "hooks":
+        if ($module_config["includes_hook_info"])
+          $relevant = true;
+        break;
+      case "files":
+        if ($module_config["includes_file_info"])
+          $relevant = true;
+        break;
+    }
+
+    $module_info["module_config"] = $module_config;
+
+    if ($relevant)
+      $compatible_modules[] = $module_info;
+  }
+
+  return $compatible_modules;
+}
+
+
+/**
+ * This is the one entry point for getting data from a module config file.
+ *
+ * This function returns all config info about a module that can be used by the System Check module.
+ * It's compatible with the old Database Integrity module, which required a database_integrity.php file
+ * defined in the module root. The new System Check module requires a module_config.php file to be
+ * defined in the module root.
+ *
+ * The module_config.php can define any of the following globals:
+ *   $STRUCTURE - which contains the database structure of all module tables. If there's no database,
+ *                it (should) define an empty array.
+ *   $FILES     - a list of files for this module
+ *   $HOOKS     - the list of hook calls that the module uses - or an empty array if none.
+ *
+ * @param string $module_folder
+ * @return array
+ */
+function sc_get_module_config_file_contents($module_folder)
+{
+  global $g_root_dir;
+
+  // Database Integrity compatibility
+  $is_compatible = false;
+
+  // if the module is sporting compatibility with the new System Check module, use that file. Otherwise, use
+  // the older Database Integrity module file
+  if (is_file("$g_root_dir/modules/$module_folder/module_config.php"))
+  {
+    $is_compatible = true;
+    require("$g_root_dir/modules/$module_folder/module_config.php");
+  }
+
+  else if (is_file("$g_root_dir/modules/$module_folder/database_integrity.php"))
+  {
+  	$is_compatible = true;
+    require("$g_root_dir/modules/$module_folder/database_integrity.php");
+  }
+
+  $return_info = array(
+    "is_compatible"       => $is_compatible,
+    "includes_table_info" => false,
+    "includes_hook_info"  => false,
+    "includes_file_info"  => false
+  );
+
+  // if data is available for the module, tack it all together and return the result
+  if ($is_compatible)
+  {
+  	$includes_table_info = isset($STRUCTURE) ? true : false;
+  	$tables = array();
+  	if ($includes_table_info)
+  	{
+  		$return_info["includes_table_info"] = $includes_table_info;
+  		$return_info["tables"]              = $STRUCTURE;
+  	}
+
+    $includes_hook_info = isset($HOOKS) ? true : false;
+    $hooks = array();
+    if ($includes_hook_info)
+    {
+      $return_info["includes_hook_info"] = $includes_hook_info;
+      $return_info["hooks"]              = $HOOKS;
+    }
+
+    $includes_file_info = isset($FILES) ? true : false;
+    $files = array();
+    if ($includes_file_info)
+    {
+      $return_info["includes_file_info"] = $includes_file_info;
+      $return_info["files"]              = $FILES;
+    }
+  }
+
+  return $return_info;
+}
+

system_check/global/code/files.php renamed to global/code/files.php

@@ -13,14 +13,12 @@ table.log_table .full_log_heading {
 	color: white;
 	font-weight: bold;
 	font-size: 8pt;
-	padding-left: 3px;
 }
 table.log_table .error_log_heading {
 	background-color: #990000;
 	color: white;
 	font-weight: bold;
 	font-size: 8pt;
-	padding-left: 3px;
 }
 table.log_table td {
 	background-color: #efefef;

global/code/general.php

@@ -1,32 +1,30 @@
 /**
- * This file contains all the client-side code for all tests in the module.
+ * This file contains all the client-side code for the three tests: file, table and hook verification. It's arranged
+ * into general functions first, then test-specific functions below, grouped under the appropriate heading.
+ *
  */
 
 var sc_ns = {
 
-  // common vars (used for all, or most tests)
+  // common vars (used for all tests)
   is_processing: false, // any time a test is running
   component_list: [],   // contains "core" and/or any module IDs, depending on what's selected for the test
   current_component: null, // core / module ID
   current_component_name: null, // for display purposes
 
 
   /**
-   * This initiates the test process for any of the tests, called from the individual test pages. It
-   * does the following:
-   *
+   * This initiates the test process for any of the 3 tests. This does the following:
    * 1. Clears the logs already outputted
    * 2. marks the test as having begun (is_processing = true)
    * 3. stores the list of components (module IDs + core) that the user selected
-   * 4. Calls the appropriate init test function
+   * 4. Calls the
    */
   start: function(start_test_func) {
     sc_ns.clear_logs();
     sc_ns.is_processing = true;
     sc_ns.component_list = [];
     sc_ns.file_verification_problems = null;
-    sc_ns.total_orphan_tests_run = 0;
-    sc_ns.total_num_orphans_found = 0;
 
     $(".components:checked").each(function() {
       sc_ns.component_list.push(this.value);
@@ -345,114 +343,6 @@ var sc_ns = {
       }
       return;
     }
-  },
-
-
-  // ----------------------------------------------------------------------------------------------
-
-  // Orphan Record Check
-
-  total_orphan_tests_run: 0,
-  total_num_orphans_found: 0,
-
-  /**
-   * Called for each component on the Table Verification page. This method returns all tables
-   * for the component, which are passed to sc_ns.verify_component_tables which does the actual
-   * verification.
-   */
-  init_orphan_record_test: function() {
-    $("#result__" + sc_ns.current_component).html("<img src=\"images/loading.gif\" />");
-    $.ajax({
-      url:      g.root_url + "/modules/system_check/global/code/actions.php",
-      data:     { action: "get_component_tables", component: "core" },
-      type:     "POST",
-      dataType: "json",
-      success:  sc_ns.find_orphan_records
-    });
-  },
-
-  find_orphan_records: function(core_info) {
-    sc_ns.current_component_name   = core_info.tables.shift();
-    sc_ns.current_component        = core_info.tables.shift();
-    sc_ns.current_component_tables = core_info.tables;
-    sc_ns.current_component_table  = core_info.tables[0];
-
-    // update the log section
-    var log = g.messages["word_testing_c"] + sc_ns.current_component_name + "\n"
-            + "------------------------------------------\n";
-
-    // if this isn't the first thing outputted to the log, add some visual padding
-    if ($("#full_log").val() != "")
-      log = "\n\n" + log;
-
-    sc_ns.log_message(log);
-
-    // now start processing this component's tables
-    sc_ns.find_next_table_orphans();
-  },
-
-  find_next_table_orphans: function() {
-    $.ajax({
-      url:      g.root_url + "/modules/system_check/global/code/actions.php",
-      data:     { action: "find_table_orphans", table_name: sc_ns.current_component_table },
-      type:     "POST",
-      dataType: "json",
-      success:  sc_ns.display_orphan_test_results
-    });
-  },
-
-  display_orphan_test_results: function(results) {
-    var log = "TABLE: " + results.table_name + "\n";
-    if (results.has_test) {
-      log += "Test description:\n" + results.test_descriptions + "\n"
-           + "Results:\n"
-           + "- num tests: " + results.num_tests + "\n"
-           + "- num orphans: " + results.num_orphans;
-
-      sc_ns.total_orphan_tests_run += results.num_tests;
-      sc_ns.total_num_orphans_found += results.num_orphans;
-    } else {
-      log += "- No test";
-    }
-    sc_ns.log_message(log);
-    sc_ns.log_message("_______________________\n");
-
-    if (results.num_orphans > 0) {
-      var log = "TABLE: " + results.table_name + "\n"
-              + "- num orphans: " + results.num_orphans + "\n"
-              + "- error description: \n";
-      for (var i=1; i<=results.problems.length; i++) {
-        log += i + ". " + results.problems[i-1] + "\n";
-      }
-      sc_ns.log_error(log + "_______________________\n");
-    }
-
-    var next_table = null;
-    for (var i=0; i<sc_ns.current_component_tables.length-1; i++) {
-      if (sc_ns.current_component_tables[i] == sc_ns.current_component_table) {
-        next_table = sc_ns.current_component_tables[i+1];
-        break;
-      }
-    }
-
-    if (next_table != null) {
-      sc_ns.current_component_table = next_table;
-      sc_ns.find_next_table_orphans();
-    } else {
-      var message = "Number of tests run: <b>" + sc_ns.total_orphan_tests_run + "</b>, "
-        + "total number of orphans found: <b>" + sc_ns.total_num_orphans_found + "</b>";
-
-      var error_type = 1;
-      if (sc_ns.total_num_orphans_found > 0) {
-        error_type = 0;
-        message += ". <a href=\"orphans.php?clean\">Click here</a> to delete all the orphaned records / references.";
-      } else {
-        message += ". Passed!";
-      }
-
-      ft.display_message("ft_message", error_type, message);
-      return;
-    }
   }
 
 };

system_check/global/code/generation.php renamed to global/code/generation.php

@@ -10,7 +10,7 @@
 }
 
 // example
-//sc_generate_module_hook_array("module_hooks_manager_rules", "1.1.4");
+//sc_generate_module_hook_array("form_backup", "1.1.4");
 //exit;
 
 $word_testing_uc = mb_strtoupper($L["word_untested"]);

system_check/global/code/hooks.php renamed to global/code/hooks.php

@@ -11,9 +11,6 @@
 $L["word_passed"] = "Passed";
 $L["word_failed"] = "Failed";
 $L["word_result"] = "Result";
-$L["word_summary"] = "Summary";
-$L["word_installed"] = "Installed";
-$L["word_available"] = "Available";
 
 $L["phrase_missing_table_c"] = "missing table: ";
 $L["phrase_missing_column_c"] = "missing column: ";
@@ -29,30 +26,16 @@
 $L["phrase_uses_hooks_q"] = "Uses Hooks?";
 $L["phrase_nothing_to_test"] = "nothing to test";
 $L["phrase_has_tables_q"] = "Has Tables?";
-$L["phrase_orphan_clean_up"] = "Orphan Clean-up";
-$L["phrase_run_test"] = "Run Test";
-$L["phrase_form_integrity_check"] = "Form Integrity Check";
-$L["phrase_environment_info"] = "Environment Info";
-$L["phrase_not_installed"] = "Not Installed";
-$L["phrase_not_available"] = "Not Available";
-$L["phrase_environment_overview"] = "Environment Overview";
-$L["phrase_php_sessions"] = "PHP Sessions";
-$L["phrase_suhosin_extension"] = "Suhosin Extension";
-$L["phrase_curl_extension"] = "Curl Extension";
-$L["phrase_simplexml_extension"] = "SimpleXML Extension";
 
 $L["text_tables_test"] = "The following tables will be tested to confirm they exist, and that the column information is valid.";
-$L["text_module_intro"] = "This module lets you run tests on your Form Tools installation to look for potential problems. Choose one of the tests below.";
+$L["text_module_intro"] = "This module lets you run tests on your Form Tools installation to verify the structure and files. Choose one of the tests below.";
 $L["text_table_verification_intro"] = "This examines and verifies the existence and structure of your Core database tables and any compatible modules.";
 $L["text_hook_verification_intro"] = "Modules interact with the Core script through <i>hooks</i>. They attach their own functionality to act at particular junctions in the code. If this gets corrupted, it can prevent the module from working properly. This test examines your database to confirm that the hooks for all your modules are configured properly.";
 $L["text_problems_identified_and_fixed"] = "Problems are both identified and fixed.";
 $L["text_problems_identified_not_fixed"] = "Problems are only identified, not fixed.";
 $L["text_help"] = "For more information on this module, please see the <a href=\"http://modules.formtools.org/system_check/\" target=\"_blank\">help documentation</a> on the Form Tools site.";
 $L["text_file_check"] = "This examines all compatible components (Core, modules and themes) to confirm that the component's files exist.";
 $L["text_file_verification_intro"] = "This checks over your Core, modules and themes to confirm that all the necessary files have been uploaded properly. If any are missing, you will need to re-download the appropriate component and upload them to your server.";
-$L["text_orphan_record_check_intro"] = "This is a house-keeping test to examine the Core database tables for any unwanted orphaned records and references. Orphaned records are database entries that are no longer needed and should have been deleted along with their \"parents\". For example, when you delete a form, any references to that form ID should also be deleted. Orphaned records shouldn't cause problems, but add unnecessary clutter to your database. <b>If this test finds anything, we'd appreciate it if you <a href=\"http://forums.formtools.org/\">report them in the forums</a>!</b>";
-$L["text_orphan_desc_short"] = "A housekeeping test to identify and remove old database records and references that are no longer needed and should have been deleted.";
-$L["text_environment_overview_summary"] = "This section below contains a report of key information about your Form Tools installation and environment, which can be helpful when reporting bugs.";
 
 $L["notify_test_complete_problems"] = "The test is complete. We found a problem with one or more of your installed components.";
 $L["notify_test_complete_no_problems"] = "The test is complete. No problems were found.";

system_check/global/code/tables.php renamed to global/code/tables.php

@@ -4,5 +4,4 @@
 require_once(dirname(__FILE__) . "/global/code/general.php");
 require_once(dirname(__FILE__) . "/global/code/generation.php");
 require_once(dirname(__FILE__) . "/global/code/hooks.php");
-require_once(dirname(__FILE__) . "/global/code/orphans.php");
 require_once(dirname(__FILE__) . "/global/code/tables.php");