<?php /********************************************************************* class.setup.php osTicket setup wizard. Peter Rotich <peter@osticket.com> Copyright (c) 2006-2012 osTicket http://www.osticket.com Released under the GNU General Public License WITHOUT ANY WARRANTY. See LICENSE.TXT for details. vim: expandtab sw=4 ts=4 sts=4: **********************************************************************/ Class SetupWizard { //Mimimum requirements var $prereq = array('php' => '4.3', 'mysql' => '4.4'); //Version info - same as the latest version. var $version ='1.7-rc1'; var $version_verbose='1.7 RC 1'; //Errors var $errors=array(); function SetupWizard(){ $this->errors=array(); } function load_sql_file($file, $prefix, $debug=false) { if(!file_exists($file) || !($schema=file_get_contents($file))) return $this->abort('Error accessing SQL file'); return $this->load_sql($schema, $prefix, $debug); } /* load SQL schema - assumes MySQL && existing connection */ function load_sql($schema, $prefix, $debug=false) { # Strip comments and remarks $schema=preg_replace('%^\s*(#|--).*$%m','',$schema); # Replace table prefis $schema = str_replace('%TABLE_PREFIX%',$prefix, $schema); # Split by semicolons - and cleanup if(!($statements = array_filter(array_map('trim', @explode(';', $schema))))) return $this->abort('Error parsing SQL schema'); @mysql_query('SET SESSION SQL_MODE =""'); foreach($statements as $k=>$sql) { if(!mysql_query($sql)) { if($debug) echo "[$sql]=>".mysql_error(); return $this->abort("[$sql] - ".mysql_error()); } } return true; } function getVersion() { return $this->version; } function getVersionVerbose() { return $this->version_verbose; } function getPHPVersion() { return $this->prereq['php']; } function getMySQLVersion() { return $this->prereq['mysql']; } function check_php() { return (version_compare(PHP_VERSION,$this->getPHPVersion())>=0); } function check_mysql() { return (extension_loaded('mysql')); } function check_prereq() { return ($this->check_php() && $this->check_mysql()); } /* @error is a mixed var. */ function abort($error) { if($error && is_array($error)) $this->errors = array_merge($this->errors,$error); elseif($error) $this->errors[] = $error; //Always returns FALSE. return false; } function getErrors(){ return $this->errors; } /* Access and user validation*/ function getThisUser() { } } class Upgrader extends SetupWizard { var $prefix; function Upgrader($prefix) { $this->prefix = $prefix; $this->errors = array(); } function getTablePrefix() { return $this->prefix; } /* upgrade magic related to the given version */ function upgradeTo($version) { $errors = array(); switch($version) { case '1.7-RC1': //TODO: latest upgrade logic. break; case '1.6 ST': //TODO: refactor code from 1.6 ST. break; case '1.6 RC5': //TODO: refactor code from 1.6 ST. break; default: //XXX: escape version return $this->abort('Trying to upgrade unknown version '.$version); } if($errors) return $this->abort($errors); return true; } /* Do base upgrade Does fall-through upgrade until we reach the current version. We're assumming the user - is upgrading upgradable version of osTicket! @version - version number to upgrade from! */ function upgradeFrom($version) { if(!$version || $this->getErrors()) return false; if(!strcasecmp($version,$this->getVersion())) return true; //XXX: Note FALLTHROUGH (we only break on error) and uppercase cases. switch(strtoupper($version)) { case 'OLD': //Upgrade old versions to 1.6 ST. if(!$this->upgradeTo('1.6 RC5')) break; /* FALLTHROUGH */ case '1.6 RC5': //Upgrade 1.6 RC5 to 1.6 ST if(!$this->upgradeTo('1.6 ST')) break; /* FALLTHROUGH */ case '1.6 ST': //Upgrade 1.6 ST to to 1.7 RC1 if(!$this->upgradeTo('1.7-RC1')) break; /* LAST CASE IS NOT FALLTHROUGH */ break; default: //Catch all - Upgrading older versions 1.3+ return $this->upgradeFrom('OLD'); } //XXX: Set errors??? return (!$this->getErrors()); } function cleanup() { //FIXME: cleanup logic here. sleep(2); return true; } } /* Installer class - latest version. */ class Installer extends SetupWizard { var $config; function Installer($configfile) { $this->config =$configfile; $this->errors=array(); } function getConfigFile() { return $this->config; } function config_exists() { return ($this->getConfigFile() && file_exists($this->getConfigFile())); } function config_writable() { return ($this->getConfigFile() && is_writable($this->getConfigFile())); } function check_config() { return ($this->config_exists() && $this->config_writable()); } //XXX: Latest version insall logic...no carry over. function install($vars) { $this->errors=$f=array(); $f['name'] = array('type'=>'string', 'required'=>1, 'error'=>'Name required'); $f['email'] = array('type'=>'email', 'required'=>1, 'error'=>'Valid email required'); $f['fname'] = array('type'=>'string', 'required'=>1, 'error'=>'First name required'); $f['lname'] = array('type'=>'string', 'required'=>1, 'error'=>'Last name required'); $f['admin_email'] = array('type'=>'email', 'required'=>1, 'error'=>'Valid email required'); $f['username'] = array('type'=>'username', 'required'=>1, 'error'=>'Username required'); $f['passwd'] = array('type'=>'password', 'required'=>1, 'error'=>'Password required'); $f['passwd2'] = array('type'=>'string', 'required'=>1, 'error'=>'Confirm password'); $f['prefix'] = array('type'=>'string', 'required'=>1, 'error'=>'Table prefix required'); $f['dbhost'] = array('type'=>'string', 'required'=>1, 'error'=>'Hostname required'); $f['dbname'] = array('type'=>'string', 'required'=>1, 'error'=>'Database name required'); $f['dbuser'] = array('type'=>'string', 'required'=>1, 'error'=>'Username required'); $f['dbpass'] = array('type'=>'string', 'required'=>1, 'error'=>'password required'); if(!Validator::process($f,$vars,$this->errors) && !$this->errors['err']) $this->errors['err']='Missing or invalid data - correct the errors and try again.'; //Staff's email can't be same as system emails. if($vars['admin_email'] && $vars['email'] && !strcasecmp($vars['admin_email'],$vars['email'])) $this->errors['admin_email']='Conflicts with system email above'; //Admin's pass confirmation. if(!$this->errors && strcasecmp($vars['passwd'],$vars['passwd2'])) $this->errors['passwd2']='passwords to not match!'; //Check table prefix underscore required at the end! if($vars['prefix'] && substr($vars['prefix'], -1)!='_') $this->errors['prefix']='Bad prefix. Must have underscore (_) at the end. e.g \'ost_\''; //Make sure admin username is not very predictable. XXX: feels dirty but necessary if(!$this->errors['username'] && in_array(strtolower($vars['username']),array('admin','admins','username','osticket'))) $this->errors['username']='Bad username'; //MYSQL: Connect to the DB and check the version & database (create database if it doesn't exist!) if(!$this->errors) { if(!db_connect($vars['dbhost'],$vars['dbuser'],$vars['dbpass'])) $this->errors['db']='Unable to connect to MySQL server. Possibly invalid login info.'; elseif(db_version()< $this->getMySQLVersion()) $this->errors['db']=sprintf('osTicket requires MySQL %s or better!',$this->getMySQLVersion()); elseif(!db_select_database($vars['dbname']) && !db_create_database($vars['dbname'])) { $this->errors['dbname']='Database doesn\'t exist'; $this->errors['db']='Unable to create the database.'; } elseif(!db_select_database($vars['dbname'])) { $this->errors['dbname']='Unable to select the database'; } } //bailout on errors. if($this->errors) return false; /*************** We're ready to install ************************/ define('ADMIN_EMAIL',$vars['admin_email']); //Needed to report SQL errors during install. define('PREFIX',$vars['prefix']); //Table prefix $schemaFile =INC_DIR.'sql/osticket-v1.7-mysql.sql'; //DB dump. $debug = true; //XXX:Change it to true to show SQL errors. //Last minute checks. if(!file_exists($schemaFile)) $this->errors['err']='Internal Error - please make sure your download is the latest (#1)'; elseif(!file_exists($this->getConfigFile()) || !($configFile=file_get_contents($this->getConfigFile()))) $this->errors['err']='Unable to read config file. Permission denied! (#2)'; elseif(!($fp = @fopen($this->getConfigFile(),'r+'))) $this->errors['err']='Unable to open config file for writing. Permission denied! (#3)'; elseif(!$this->load_sql_file($schemaFile,$vars['prefix'],$debug)) $this->errors['err']='Error parsing SQL schema! Get help from developers (#4)'; if(!$this->errors) { //Create admin user. $sql='INSERT INTO '.PREFIX.'staff SET created=NOW() ' .', isactive=1, isadmin=1, group_id=1, dept_id=1, timezone_id=8 ' .', email='.db_input($_POST['admin_email']) .', firstname='.db_input($vars['fname']) .', lastname='.db_input($vars['lname']) .', username='.db_input($vars['username']) .', passwd='.db_input(Passwd::hash($vars['passwd'])); if(!mysql_query($sql) || !($uid=mysql_insert_id())) $this->errors['err']='Unable to create admin user (#6)'; } if(!$this->errors) { //Create config settings---default settings! //XXX: rename ostversion helpdesk_* ?? $sql='INSERT INTO '.PREFIX.'config SET updated=NOW(), isonline=0 ' .', default_email_id=1, alert_email_id=2, default_dept_id=1 ' .', default_sla_id=1, default_timezone_id=8, default_template_id=1 ' .', admin_email='.db_input($vars['admin_email']) .', schema_signature='.db_input(md5_file($schemaFile)) .', helpdesk_url='.db_input(URL) .', helpdesk_title='.db_input($vars['name']); if(!mysql_query($sql) || !($cid=mysql_insert_id())) $this->errors['err']='Unable to create config settings (#7)'; } if($this->errors) return false; //Abort on internal errors. //Rewrite the config file - MUST be done last to allow for installer recovery. $configFile= str_replace("define('OSTINSTALLED',FALSE);","define('OSTINSTALLED',TRUE);",$configFile); $configFile= str_replace('%ADMIN-EMAIL',$vars['admin_email'],$configFile); $configFile= str_replace('%CONFIG-DBHOST',$vars['dbhost'],$configFile); $configFile= str_replace('%CONFIG-DBNAME',$vars['dbname'],$configFile); $configFile= str_replace('%CONFIG-DBUSER',$vars['dbuser'],$configFile); $configFile= str_replace('%CONFIG-DBPASS',$vars['dbpass'],$configFile); $configFile= str_replace('%CONFIG-PREFIX',$vars['prefix'],$configFile); $configFile= str_replace('%CONFIG-SIRI',Misc::randcode(32),$configFile); if(!$fp || !ftruncate($fp,0) || !fwrite($fp,$configFile)) { $this->errors['err']='Unable to write to config file. Permission denied! (#5)'; return false; } @fclose($fp); /************* Make the system happy ***********************/ //Create default emails! $email = $vars['email']; list(,$domain)=explode('@',$vars['email']); $sql='INSERT INTO '.PREFIX.'email (`email_id`, `dept_id`, `name`,`email`,`created`,`updated`) VALUES ' ." (1,1,'Support','$email',NOW(),NOW())" .",(2,1,'osTicket Alerts','alerts@$domain',NOW(),NOW())" .",(3,1,'','noreply@$domain',NOW(),NOW())"; @mysql_query($sql); //Create a ticket to make the system warm and happy. $sql='INSERT INTO '.PREFIX.'ticket SET created=NOW(), status="open", source="Web" ' .' ,priority_id=2, dept_id=1, topic_id=1 ' .' ,ticketID='.db_input(Misc::randNumber(6)) .' ,email="support@osticket.com" ' .' ,name="osTicket Support" ' .' ,subject="osTicket Installed!"'; if(mysql_query($sql) && ($tid=mysql_insert_id())) { if(!($msg=file_get_contents(INC_DIR.'msg/installed.txt'))) $msg='Congratulations and Thank you for choosing osTicket!'; $sql='INSERT INTO '.PREFIX.'ticket_message SET created=NOW(),source="Web" ' .', ticket_id='.db_input($tid) .', message='.db_input($msg); @mysql_query($sql); } //TODO: create another personalized ticket and assign to admin?? //Log a message. $msg="Congratulations osTicket basic installation completed!\n\nThank you for choosing osTicket!"; $sql='INSERT INTO '.PREFIX.'syslog SET created=NOW(),updated=NOW(),log_type="Debug" ' .', title="osTicket installed!"' .', log='.db_input($msg) .', ip_address='.db_input($_SERVER['REMOTE_ADDR']); @mysql_query($sql); return true; } } ?>