5 * This applies database files from
6 * a) OLD - {MODULE}/DataObjects/XXXX.{dbtype}.sql
8 * b) NEW - {MODULE}/sql/XXX.sql (SHARED or translable)
9 * and {MODULE}/{dbtype}/XXX.sql (SHARED or translable)
14 require_once 'Pman.php';
15 class Pman_Core_UpdateDatabase extends Pman
18 static $cli_desc = "Update SQL - Beta (it will run updateData of all modules)";
20 static $cli_opts = array(
23 'desc' => 'prefix for the password (eg. fred > xxx4fred - prefix is xxx4)',
30 'desc' => 'only run the updateData - do not run import the tables and procedures.',
37 'add-company' => array(
38 'desc' => 'add a company name of the company',
44 'add-company-with-type' => array(
45 'desc' => 'the type of company (default OWNER)',
52 'desc' => 'Initialize the database (pg only supported)',
58 'only-module-sql' => array(
59 'desc' => 'Only run sql import on this modules - eg. Core',
64 'procedures-only' => array(
65 'desc' => 'Only import procedures (not supported by most modules yet) - ignores sql directory',
72 'json-person' => array(
73 'desc' => 'Person JSON file',
81 static function cli_opts()
84 $ret = self::$cli_opts;
85 $ff = HTML_FlexyFramework::get();
87 $mods = $a->modulesList();
88 foreach($mods as $m) {
90 $fd = $ff->rootDir. "/Pman/$m/UpdateDatabase.php";
91 if (!file_exists($fd)) {
97 $cls = new ReflectionClass('Pman_'. $m . '_UpdateDatabase');
99 $ret = array_merge($ret, $cls->getStaticPropertyValue('cli_opts'));
108 var $disabled = array();
115 $ff = HTML_FlexyFramework::get();
116 if (!empty($ff->cli)) {
121 parent::getAuth(); // load company!
122 $au = $this->getAuthUser();
123 if (!$au || $au->company()->comptype != 'OWNER') {
124 $this->jerr("Not authenticated", array('authFailure' => true));
126 $this->authUser = $au;
130 function get($args, $opts)
132 PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
134 $this->checkSystem();
136 $ff = HTML_FlexyFramework::get();
138 $this->disabled = explode(',', $ff->disable);
140 //$this->fixSequencesPgsql();exit;
143 // ask all the modules to verify the opts
145 $this->checkOpts($opts);
147 if (empty($opts['data-only'])) {
150 if (!empty($opts['only-module-sql'])) {
154 $this->runUpdateModulesData();
157 if (!empty($opts['add-company']) && !in_array('Core', $this->disabled)) {
158 // make sure we have a good cache...?
160 DB_DataObject::factory('companies')->initCompanies($this, $opts);
163 $this->runExtensions();
171 * imports SQL files from all DataObjects directories....
173 * except any matching /migrate/
178 // loop through all the modules, and see if they have a importSQL method?
181 $ff = HTML_Flexyframework::get();
183 $dburl = parse_url($ff->DB_DataObject['database']);
185 //$this->{'import' . $url['scheme']}($url);
187 $dbtype = $dburl['scheme'];
188 $dirmethod = 'import' . $dburl['scheme'] . 'dir';
193 $ar = $this->modulesList();
198 if(in_array($m, $this->disabled)){
199 echo "module $m is disabled \n";
203 echo "Importing SQL from module $m\n";
204 if (!empty($this->opts['only-module-sql']) && $m != $this->opts['only-module-sql']) {
209 // check to see if the class has
213 $file = $this->rootDir. "/Pman/$m/UpdateDatabase.php";
214 if($m != 'Core' && file_exists($file)){
217 $class = "Pman_{$m}_UpdateDatabase";
219 if(method_exists($x, 'importModuleSQL')){
220 echo "Importing SQL from module $m using Module::importModuleSQL\n";
221 $x->opts = $this->opts;
222 $x->rootDir = $this->rootDir;
223 $x->importModuleSQL($dburl);
228 echo "Importing SQL from module $m\n";
231 // if init has been called
233 if (!empty($this->opts['init'])) {
234 $this->{$dirmethod}($dburl, $this->rootDir. "/Pman/$m/{$dbtype}.init");
240 $fd = $this->rootDir. "/Pman/$m/DataObjects";
242 $this->{$dirmethod}($dburl, $fd);
245 // new -- sql directory..
246 // new style will not support migrate ... they have to go into mysql-migrate.... directories..
247 // new style will not support pg.sql etc.. naming - that's what the direcotries are for..
249 $this->{$dirmethod}($dburl, $this->rootDir. "/Pman/$m/sql");
250 $this->{$dirmethod}($dburl, $this->rootDir. "/Pman/$m/{$dbtype}");
254 if (!empty($this->opts['init']) && file_exists($this->rootDir. "/Pman/$m/{$dbtype}.initdata")) {
255 HTML_FlexyFramework::get()->generateDataobjectsCache(true);
257 $this->{$dirmethod}($dburl, $this->rootDir. "/Pman/$m/{$dbtype}.initdata");
258 $this->{'fixSequences'. $dbtype}();
270 /** -------------- code to handle importing a whole directory of files into the database ------- **/
273 function importpgsqldir($url, $dir, $disable_triggers = false)
275 $ff = HTML_FlexyFramework::get();
277 require_once 'System.php';
278 $cat = System::which('cat');
279 $psql = System::which('psql');
282 if (!empty($url['pass'])) {
283 putenv("PGPASSWORD=". $url['pass']);
287 ' -h ' . $url['host'] .
288 ' -U' . escapeshellarg($url['user']) .
289 ' ' . basename($url['path']);
292 echo $psql_cmd . "\n" ;
293 echo "scan : $dir\n";
296 $files = array($dir);
301 $files = glob($dir.'/*.sql');
302 uksort($files, 'strcasecmp');
304 //$lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
305 //usort($files, $lsort);
308 foreach($files as $bfn) {
311 if (preg_match('/migrate/i', basename($bfn))) { // skip migration scripts at present..
314 if (preg_match('#\.[a-z]{2}\.sql#i', basename($bfn))
315 && !preg_match('#\.pg\.sql#i', basename($bfn))
316 ) { // skip migration scripts at present..
321 if (!preg_match('/pgsql/', basename($dir) )) {
322 if ( !preg_match('#\.pg\.sql$#', basename($bfn))) {
323 $fn = $this->convertToPG($bfn);
327 // files ending in .pg.sql are native postgres files.. ## depricated
330 $cmd = "$psql_cmd < " . escapeshellarg($fn ? $fn : $bfn) . ' 2>&1' ;
332 echo "$bfn: $cmd ". ($ff->cli ? "\n" : "<BR>\n");
348 * mysql - does not support conversions.
354 function importmysqldir($dburl, $dir)
357 $this->fixMysqlInnodb(); /// run once
359 echo "Import MYSQL :: $dir\n";
362 require_once 'System.php';
363 $cat = System::which('cat');
364 $mysql = System::which('mysql');
368 $mysql_cmd = $mysql .
369 ' -h ' . $dburl['host'] .
370 ' -u' . escapeshellarg($dburl['user']) .
371 (!empty($dburl['pass']) ? ' -p' . escapeshellarg($dburl['pass']) : '') .
372 ' ' . basename($dburl['path']);
373 //echo $mysql_cmd . "\n" ;
375 $files = glob($dir.'/*.sql');
376 uksort($files, 'strcasecmp');
379 foreach($files as $fn) {
382 if (preg_match('/migrate/i', basename($fn))) { // skip migration scripts at present..
385 // .my.sql but not .pg.sql
386 if (preg_match('#\.[a-z]{2}\.sql#i', basename($fn))
387 && !preg_match('#\.my\.sql#i', basename($fn))
388 ) { // skip migration scripts at present..
391 if (!strlen(trim($fn))) {
395 $cmd = "$mysql_cmd -f < " . escapeshellarg($fn) ." 2>&1" ;
397 echo basename($dir).'/'. basename($fn) . '::' . $cmd. ($this->cli ? "\n" : "<BR>\n");
400 $fp = popen($cmd, "r");
403 // send the current file part to the browser
404 $line = trim(fgets($fp, 1024));
406 if (!preg_match('/^ERROR\s+([0-9]+)/', $line, $matches)) {
407 echo "OK - {$line}\n"; flush();
411 switch($matches[1]) {
412 case 1050: // create tables triggers this..
413 case 1060: // Duplicate column name
420 echo "IGNORE - {$line}\n"; flush();
424 // 1051: // Unknown table -- normally drop = add iff exists..
426 print_r(array($line,$matches));exit;
441 * simple regex based convert mysql to pgsql...
443 function convertToPG($src)
445 //echo "Convert $src\n";
447 $fn = $this->tempName('sql');
449 $ret = array( ); // pad it a bit.
450 $extra = array("", "" );
453 foreach(file($src) as $l) {
456 if (!strlen($l) || $l[0] == '#') {
460 if (preg_match('#create\s+table\s+([a-z0-9_]+)#i', $l, $m)) {
463 if (preg_match('#create\s+table\s+\`([a-z0-9_]+)\`#i', $l, $m)) {
464 $tbl = 'shop_' . strtolower($m[1]);
465 $l = preg_replace('#create\s+table\s+\`([a-z0-9_]+)\`#i', "CREATE TABLE {$tbl}", $l);
467 if (preg_match('#\`([a-z0-9_]+)\`#i', $l, $m) && !preg_match('#alter\s+table\s+#i', $l)) {
468 $l = preg_replace('#\`([a-z0-9_]+)\`#i', "{$m[1]}_name", $l);
471 if ($tbl && preg_match('#auto_increment#i', $l, $m)) {
472 $l = preg_replace('#auto_increment#i', "default nextval('{$tbl}_seq')", $l);
473 $extra[] = "create sequence {$tbl}_seq;";
477 if (preg_match('#alter\s+table\s+(\`[a-z0-9_]+\`)#i', $l, $m)){
478 $l = preg_replace('#alter\s+table\s+(\`[a-z0-9_]+\`)#i', "ALTER TABLE {$tbl}", $l);
481 // enum value -- use the text instead..
483 if ($tbl && preg_match('#([\w]+)\s+(enum\([\w|\W]+\))#i', $l, $m)) {
484 $l = preg_replace('#enum\([\w|\W]+\)#i', "TEXT", $l);
486 // ignore the alter enum
487 if ($tbl && preg_match('#alter\s+table\s+([\w|\W]+)\s+enum\([\w|\W]+\)#i', $l, $m)) {
491 // UNIQUE KEY .. ignore
492 if ($tbl && preg_match('#UNIQUE KEY#i', $l, $m)) {
493 $last = array_pop($ret);
494 $ret[] = trim($last, ",");
498 if ($tbl && preg_match('#RENAME\s+TO#i', $l, $m)) {
502 if ($tbl && preg_match('#change\s+column#i', $l, $m)) {
506 // INDEX lookup ..ignore
507 if ($tbl && preg_match('#INDEX lookup+([\w|\W]+)#i', $l, $m)) {
508 $last = array_pop($ret);
509 $ret[] = trim($last, ",");
514 // CREATE INDEX ..ignore
515 if (preg_match('#alter\s+table\s+([a-z0-9_]+)\s+add\s+index\s+#i', $l, $m)) {
516 // $l = "CREATE INDEX {$m[1]}_{$m[2]} ON {$m[1]} {$m[3]}";
521 $l = preg_replace('#int\([0-9]+\)#i', 'INT', $l);
523 $l = preg_replace('# datetime#i', ' TIMESTAMP WITHOUT TIME ZONE', $l);
524 $l = preg_replace('# blob#i', ' TEXT', $l);
525 $l = preg_replace('# longtext#i', ' TEXT', $l);
526 $l = preg_replace('# tinyint#i', ' INT', $l);
532 $ret = array_merge($extra,$ret);
533 // echo implode("\n", $ret); exit;
535 file_put_contents($fn, implode("\n", $ret));
541 function checkOpts($opts)
545 foreach($opts as $o=>$v) {
546 if (!preg_match('/^json-/', $o) || empty($v)) {
549 if (!file_exists($v)) {
550 die("File does not exist : OPTION --{$o} = {$v} \n");
554 $modules = array_reverse($this->modulesList());
556 // move 'project' one to the end...
558 foreach ($modules as $module){
559 $file = $this->rootDir. "/Pman/$module/UpdateDatabase.php";
560 if($module == 'Core' || !file_exists($file)){
564 $class = "Pman_{$module}_UpdateDatabase";
566 if(!method_exists($x, 'checkOpts')){
569 $x->checkOpts($opts);
573 static function jsonImportFromArray($opts)
575 foreach($opts as $o=>$v) {
576 if (!preg_match('/^json-/', $o) || empty($v)) {
579 $type = str_replace('_', '-', substr($o,5));
581 $data= json_decode(file_get_contents($v),true);
582 $pg = HTML_FlexyFramework::get()->page;
583 DB_DataObject::factory($type)->importFromArray($pg ,$data,$opts);
593 function runUpdateModulesData()
595 HTML_FlexyFramework::get()->generateDataobjectsCache(true);
597 if(!in_array('Core', $this->disabled)){
598 echo "Running jsonImportFromArray\n";
599 Pman_Core_UpdateDatabase::jsonImportFromArray($this->opts);
602 echo "Running updateData on modules\n";
608 $modules = array_reverse($this->modulesList());
610 // move 'project' one to the end...
612 foreach ($modules as $module){
613 if(in_array($module, $this->disabled)){
616 $file = $this->rootDir. "/Pman/$module/UpdateDatabase.php";
617 if($module == 'Core' || !file_exists($file)){
622 $class = "Pman_{$module}_UpdateDatabase";
624 if(!method_exists($x, 'updateData')){
634 function updateDataEnums()
637 $enum = DB_DataObject::Factory('core_enum');
638 //DB_DAtaObject::debugLevel(1);
643 'name' => 'COMPTYPE',
644 'display_name' => 'Company Types',
645 'is_system_enum' => 1,
649 'display_name' => 'Owner',
650 'seqid' => 999, // last...
651 'is_system_enum' => 1,
658 'name' => 'HtmlEditor.font-family',
659 'display_name' => 'HTML Editor font families',
660 'is_system_enum' => 1,
663 'name' => 'Helvetica,Arial,sans-serif',
664 'display_name' => 'Helvetica',
669 'name' => 'Courier New',
670 'display_name' => 'Courier',
675 'display_name' => 'Tahoma',
679 'name' => 'Times New Roman,serif',
680 'display_name' => 'Times',
685 'display_name' => 'Verdana',
697 function updateDataGroups()
700 $groups = DB_DataObject::factory('groups');
701 $groups->initGroups();
703 $groups->initDatabase($this,array(
705 'name' => 'bcc-email', // group who are bcc'ed on all requests.
706 'type' => 0, // system
709 'name' => 'system-email-from',
710 'type' => 0, // system
713 'name' => 'core-person-signup-bcc',
714 'type' => 0, // system
720 function updateDataCompanies()
723 // fix comptypes enums..
724 $c = DB_DataObject::Factory('Companies');
726 $c->selectAdd('distinct(comptype) as comptype');
727 $c->whereAdd("comptype != ''");
730 foreach($c->fetchAll('comptype') as $cts) {
734 $ctb[]= array( 'etype'=>'COMPTYPE', 'name' => $cts, 'display_name' => ucfirst(strtolower($cts)));
737 $c = DB_DataObject::Factory('core_enum');
740 //DB_DataObject::debugLevel(1);
742 $c = DB_DataObject::Factory('Companies');
746 comptype_id = (SELECT id FROM core_enum where etype='comptype' and name=Companies.comptype LIMIT 1)
760 function initEmails($templateDir, $emails)
763 $pg = HTML_FlexyFramework::get()->page;
764 foreach($emails as $name=>$data) {
765 $cm = DB_DataObject::factory('core_email');
766 $update = $cm->get('name', $name);
769 if (empty($cm->bcc_group)) {
770 if (empty($data['bcc_group'])) {
771 $this->jerr("missing bcc_group for template $name");
773 $g = DB_DataObject::Factory('Groups')->lookup('name',$data['bcc_group']);
776 $this->jerr("bcc_group {$data['bcc_group']} does not exist when importing template $name");
778 if (!$g->members('email')) {
779 $this->jerr("bcc_group {$data['bcc_group']} does not have any members");
783 $cm->bcc_group = $g->id;
785 if (empty($cm->test_class)) {
786 if (empty($data['test_class'])) {
787 $this->jerr("missing test_class for template $name");
789 $cm->test_class = $data['test_class'];
791 require_once $cm->test_class . '.php';
793 $clsname = str_replace('/','_', $cm->test_class);
795 $method = new ReflectionMethod($clsname , 'test_'. $name) ;
796 $got_it = $method->isStatic();
797 } catch(Exception $e) {
802 $this->jerr("template {$name} does not have a test method {$clsname}::test_{$name}");
806 echo "email: {$name} - checked\n";
807 continue; /// we do not import the body content of templates that exist...
813 // $basedir = $this->bootLoader->rootDir . $mail_template_dir;
817 'file' => $templateDir. $name .'.html'
820 if (!empty($data['master'])) {
821 $opts['master'] = $templateDir . $master .'.html';
823 require_once 'Pman/Core/Import/Core_email.php';
824 $x = new Pman_Core_Import_Core_email();
827 echo "email: {$name} - CREATED\n";
832 function updateData()
835 HTML_FlexyFramework::get()->generateDataobjectsCache(true);
836 $this->updateDataEnums();
837 $this->updateDataGroups();
838 $this->updateDataCompanies();
840 $c = DB_DataObject::Factory('I18n');
848 function fixMysqlInnodb()
851 static $done_check = false;
855 // innodb in single files is far more efficient that MYD or one big innodb file.
856 // first check if database is using this format.
857 $db = DB_DataObject::factory('core_enum');
858 $db->query("show variables like 'innodb_file_per_table'");
860 if ($db->Value == 'OFF') {
861 die("Error: set innodb_file_per_table = 1 in my.cnf\n\n");
875 /** ------------- schema fixing ... there is an issue with data imported having the wrong sequence names... --- */
877 function fixSequencesMysql()
882 function fixSequencesPgsql()
886 //DB_DataObject::debugLevel(1);
887 $cs = DB_DataObject::factory('core_enum');
891 CASE WHEN strpos(seq_name, '.') > 0 THEN
894 quote_ident(min(schema_name)) ||'.'|| quote_ident(min(seq_name))
897 ||' OWNED BY '|| quote_ident(min(schema_name)) || '.' ||
898 quote_ident(min(table_name)) ||'.'|| quote_ident(min(column_name)) ||';' as cmd
902 n.nspname AS schema_name,
903 c.relname AS table_name,
904 a.attname AS column_name,
905 regexp_replace(regexp_replace(d.adsrc, E'nextval\\\\(+[''\\\"]*', ''),E'[''\\\"]*::.*\$','') AS seq_name
907 JOIN pg_attribute a ON (c.oid=a.attrelid)
908 JOIN pg_attrdef d ON (a.attrelid=d.adrelid AND a.attnum=d.adnum)
909 JOIN pg_namespace n ON (c.relnamespace=n.oid)
910 WHERE has_schema_privilege(n.oid,'USAGE')
911 AND n.nspname NOT LIKE 'pg!_%' escape '!'
912 AND has_table_privilege(c.oid,'SELECT')
913 AND (NOT a.attisdropped)
914 AND d.adsrc ~ '^nextval'
918 CASE WHEN strpos(seq_name, '.') > 0 THEN
919 substring(seq_name, 1,strpos(seq_name,'.')-1)
924 GROUP BY seq_name HAVING count(*)=1
927 while ($cs->fetch()) {
930 foreach($cmds as $cmd) {
931 $cs = DB_DataObject::factory('core_enum');
935 $cs = DB_DataObject::factory('core_enum');
937 SELECT 'SELECT SETVAL(' ||
938 quote_literal(quote_ident(nspname) || '.' || quote_ident(S.relname)) ||
939 ', MAX(' || quote_ident(C.attname)|| ')::integer ) FROM ' || nspname || '.' || quote_ident(T.relname)|| ';' as cmd
945 WHERE S.relkind = 'S'
947 AND D.refobjid = T.oid
948 AND D.refobjid = C.attrelid
949 AND D.refobjsubid = C.attnum
950 AND NS.oid = T.relnamespace
954 while ($cs->fetch()) {
957 foreach($cmds as $cmd) {
958 $cs = DB_DataObject::factory('core_enum');
965 var $extensions = array(
970 function runExtensions()
973 $ff = HTML_Flexyframework::get();
975 $dburl = parse_url($ff->DB_DataObject['database']);
977 $dbtype = $dburl['scheme'];
979 foreach($this->extensions as $ext) {
981 $scls = ucfirst($dbtype). $ext;
982 $cls = __CLASS__ . '_'. $scls;
983 $fn = implode('/',explode('_', $cls)).'.php';
984 if (!file_exists(__DIR__.'/UpdateDatabase/'. $scls .'.php')) {
995 function checkSystem()
997 // most of these are from File_Convert...
999 // these are required - and have simple dependancies.
1000 require_once 'System.php';
1006 'rsvg-convert', //librsvg2-bin
1012 // these are prefered - but may have complicated depenacies
1017 'html2text', // not availabe in debian squeeze
1018 'pdftocairo', //poppler-utils - not available in debian squeeze.
1028 foreach($req as $r) {
1029 if (!System::which($r)) {
1035 $this->jerr("Missing these programs - need installing\n" . implode("\n",$res));
1037 foreach($pref as $r) {
1038 if (!System::which($r)) {
1044 echo "WARNING: Missing these programs - they may need installing\n". implode("\n",$res);