Source for file install.php

Documentation is available at install.php

  1. <?php
  2. /**
  3. * Simple Bumblebee installer -- creates an SQL and ini files from user input
  4. *
  5. * @author    Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Installer
  11. */
  12.  
  13. define('BUMBLEBEE', true);
  14.  
  15. $sqlSourceFile = 'setup-tables.sql';
  16. $sqlSetupFilename = 'bumblebee.sql';
  17. $iniSourceFile = 'db.ini';
  18. $iniSetupFilename = 'db.ini';
  19.  
  20.  
  21. error_reporting(E_ALL);
  22.  
  23. require_once 'installer/forms.php';
  24. require_once 'installer/fileoutput.php';
  25. require_once 'installer/sqlload.php';
  26. require_once 'installer/checks.php';
  27. require_once 'installer/createdatabase.php';
  28. require_once 'installer/constructini.php';
  29.  
  30. require_once 'installer/installstep.php';
  31.  
  32. $steps = new InstallStepCollection();
  33. $steps->addStep(new InstallStep('Usernames',          'do_userdata'));
  34. $steps->addStep(new InstallStep('Pre-install check',  'do_preinst'));
  35. $steps->addStep(new InstallStep('Create database',    'do_database'));
  36. $steps->addStep(new InstallStep('Copy db.ini',        'do_dbini'));
  37. $steps->addStep(new InstallStep('Customise',          'do_customise'));
  38. $steps->addStep(new InstallStep('Post-install check', 'do_postinst'));
  39. $steps->addStep(new InstallStep('Clean-up',           'do_cleanup'));
  40.  
  41. $steps->setCurrent(1);
  42. $userSubmitted = array_merge(getSetupDefaults(), $_POST);
  43.  
  44. if (! isset($_POST['havedata']) || isset($_POST['do_userdata'])) {
  45.   printStepUserForm($userSubmitted, $steps);
  46.   exit;
  47. }
  48.  
  49. $steps->increment();
  50. if (isset($_POST['do_preinst'])) {
  51.   $userSubmitted['preinst-results'] = check_preinst($userSubmitted);
  52.   printStepPreInst($userSubmitted, $steps);
  53.   exit;
  54. }
  55.  
  56. $steps->increment();
  57. if (isset($_POST['do_database'])) {
  58.   printStepDatabase($userSubmitted, $steps);
  59.   exit;
  60. }
  61. // do the database setup parts
  62. if (isset($_POST['submitsql'])) {
  63.   $includeAdmin = isset($_POST['includeAdmin']) ? $_POST['includeAdmin'] : false;
  64.   $s = constructSQL($sqlSourceFile, $userSubmitted, $includeAdmin);
  65.   outputTextFile($sqlSetupFilename, $s);
  66.   exit;
  67. }
  68. if (isset($_POST['submitsqlload'])) {
  69.   $s = constructSQL($sqlSourceFile, $userSubmitted, $_POST['includeAdmin']);
  70.   $userSubmitted['loadsql-results'] = loadSQL($s, $_POST['sqlHost'], $_POST['sqlAdminUsername'],
  71.                                                   $_POST['sqlAdminPassword']);
  72.   printStepDatabase($userSubmitted, $steps);
  73.   exit;
  74. }
  75.  
  76. $steps->increment();
  77. if (isset($_POST['do_dbini'])) {
  78.   printStepDBini($userSubmitted, $steps);
  79.   exit;
  80. }
  81. if (isset($_POST['submitini'])) {
  82.   $s = constructini($iniSourceFile, $userSubmitted);
  83.   outputTextFile($iniSetupFilename, $s);
  84.   exit;
  85. }
  86.  
  87. $steps->increment();
  88. if (isset($_POST['do_customise'])) {
  89.   printStepCustomise($userSubmitted, $steps);
  90.   exit;
  91. }
  92.  
  93. $steps->increment();
  94. if (isset($_POST['do_postinst'])) {
  95.   $userSubmitted['preinst-results']  = check_preinst($userSubmitted);
  96.   $userSubmitted['postinst-results'] = check_postinst($userSubmitted);
  97.   printStepPostInst($userSubmitted, $steps);
  98.   exit;
  99. }
  100.  
  101. $steps->increment();
  102. if (isset($_POST['do_cleanup'])) {
  103.   require_once 'installer/loadconfig.php';
  104.   loadInstalledConfig();
  105.   $conf = ConfigReader::getInstance();
  106.   $userSubmitted['BASEURL'] = $conf->BaseURL;
  107.   printStepCleanup($userSubmitted, $steps);
  108.   exit;
  109. }
  110.  
  111. printErrorMessage("I can't work out what you want me to do");
  112. exit;
  113.  
  114.  
  115.  
  116.  
  117.  
  118. /**
  119. * Find out from the user what username and passwords to use for connecting to the database etc
  120. */
  121. function printStepUserForm($values, $steps) {
  122.   startHTML_install($values, $steps);
  123.   ?>
  124.     <fieldset>
  125.       <legend>Input data</legend>
  126.       <table>
  127.         <?php
  128.           printInstallFormFields($values, false);
  129.         ?>
  130.       </table>
  131.     </fieldset>
  132.     <div id='buttonbar'>
  133.       <?php print $steps->getPrevNextButtons(); ?>
  134.     </div>
  135.   <?php
  136.   endHTML();
  137. }
  138.  
  139.  
  140. function reflectUserData($values, $visible=true) {
  141.   if ($visible) {
  142.     ?>
  143.     <fieldset>
  144.       <legend>Input data</legend>
  145.       <table>
  146.         <?php printInstallFormFields($values, true);?>
  147.       </table>
  148.       <input type='submit' name='do_userdata' value='&laquo; Go back and change data' />
  149.     </fieldset>
  150.     <?php
  151.   } else {
  152.     printInstallFormFields($values, true, true);
  153.   }
  154. }
  155.  
  156. function printStepPreInst($values, $steps) {
  157.   startHTML_install($values, $steps);
  158.   reflectUserData($values);
  159.   ?>
  160.     <fieldset>
  161.       <legend>Pre-installation check</legend>
  162.       <p>The setup script is having a look around your system to see if everything is OK for Bumblebee...</p>
  163.       <blockquote>
  164.         <?php print $values['preinst-results']; ?>
  165.       </blockquote>
  166.       <p>If you're happy with the results of the pre-install check, then proceed to the next step.</p>
  167.     </fieldset>
  168.     <div id='buttonbar'>
  169.       <?php print $steps->getPrevReloadNextButtons(NULL, 'Rerun test', NULL); ?>
  170.     </div>
  171.   <?php
  172.   endHTML();
  173. }
  174.  
  175. function printStepDatabase($values, $steps) {
  176.   startHTML_install($values, $steps);
  177.   reflectUserData($values, false);
  178.   printDatabaseSetupForm($values);
  179.   if (isset($values['loadsql-results'])) {
  180.     ?>
  181.       <fieldset>
  182.         <legend>Loading SQL into Database</legend>
  183.         <p>The setup script tried running the database upgrade and this is what MySQL said:</p>
  184.         <blockquote>
  185.           <?php print $values['loadsql-results']; ?>
  186.         </blockquote>
  187.         <p>If it all went well, then proceed to the next step. Otherwise, try to fix any
  188.         errors (wrong username and password, perhaps) in the forms and have another go using
  189.         the script or try to fix it up using phpMyAdmin.</p>
  190.       </fieldset>
  191.     <?php
  192.   }
  193.   ?>
  194.     <div id='buttonbar'>
  195.       <?php print $steps->getPrevNextButtons(); ?>
  196.     </div>
  197.   <?php
  198.   endHTML();
  199. }
  200.  
  201. function printStepDBini($values, $steps) {
  202.   startHTML_install($values, $steps);
  203.   reflectUserData($values, false);
  204.   ?>
  205.     <fieldset id='dbini'>
  206.       <legend>Config file generation</legend>
  207.       Bumblebee needs to know what username and password to use for connecting to your database.
  208.       Download the <code>db.ini</code> file (which will contain the values specified above)
  209.       and save it into your Bumblebee installation on the webserver as <code>config/db.ini</code>.<br />
  210.       <input type='submit' name='submitini' value='Generate db.ini file' />
  211.     </fieldset>
  212.     <div id='buttonbar'>
  213.       <?php print $steps->getPrevNextButtons(); ?>
  214.     </div>
  215.   <?php
  216.   endHTML();
  217. }
  218.  
  219. function printStepCustomise($values, $steps) {
  220.   startHTML_install($values, $steps);
  221.   reflectUserData($values, false);
  222.   ?>
  223.     <fieldset id='dbini'>
  224.       <legend>Customise Installation</legend>
  225.       <p>You now need to customise your <code>bumblebee.ini</code> file. This file can be found in
  226.       the <code>config/</code> directory of your installation. The most important things for you
  227.       to customise are in the first couple of sections of the file.</p>
  228.       <p>Please refer to the
  229.       <a href="http://bumblebeeman.sourceforge.net/documentation/configure">documentation</a>
  230.       for more information on how to do this.</p>
  231.     </fieldset>
  232.     <div id='buttonbar'>
  233.       <?php print $steps->getPrevNextButtons(); ?>
  234.     </div>
  235.   <?php
  236.   endHTML();
  237. }
  238.  
  239. function printStepPostInst($values, $steps) {
  240.   startHTML_install($values, $steps);
  241.   reflectUserData($values, false);
  242.   ?>
  243.     <fieldset>
  244.       <legend>Post-installation check</legend>
  245.       <p>The setup script is having a look around your system to see if everything is OK for Bumblebee
  246.       (just as it did before) as well as looking at how your installation went...</p>
  247.       <blockquote>
  248.         <?php print $values['preinst-results']; ?>
  249.       </blockquote>
  250.       <blockquote>
  251.         <?php print $values['postinst-results']; ?>
  252.       </blockquote>
  253.       <p>If you're happy with the results of the post-install check, then you're almost finished!</p>
  254.     </fieldset>
  255.     <div id='buttonbar'>
  256.       <?php print $steps->getPrevReloadNextButtons(NULL, 'Rerun test', NULL); ?>
  257.     </div>
  258.   <?php
  259.   endHTML();
  260. }
  261.  
  262. function printStepCleanup($values, $steps) {
  263.   startHTML_install($values, $steps);
  264.   reflectUserData($values, false);
  265.   genericCleanupInstructions($values, $steps);
  266.   endHTML();
  267. }
  268.  
  269. ?>

Documentation generated on Tue, 06 Mar 2007 10:01:37 +0000 by phpDocumentor 1.3.0