sql/alter2.4.php

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12 class fa2_4 {
  13         var $version = '2.4.0'; // version installed
  14         var $description;
  15         var $sql = 'alter2.4.sql';
  16         var $preconf = true;
  17
  18         function fa2_4() {
  19                 $this->description = _('Upgrade from version 2.3 to 2.4');
  20         }
  21
  22         //
  23         //      Install procedure. All additional changes
  24         //      not included in sql file should go here.
  25         //
  26         function install($company, $force=false)
  27         {
  28                 global $db_version, $db_connections;
  29
  30                 $pref = $db_connections[$company]['tbpref'];
  31
  32                 if (get_company_pref('grn_clearing_act') === null) { // available form 2.3.1, can be not defined on pre-2.4 installations
  33                         set_company_pref('grn_clearing_act', 'glsetup.purchase', 'varchar', 15, 0);
  34                 }
  35                 if (get_company_pref('default_receival_required') === null) { // new in 2.4 installations
  36                         set_company_pref('default_receival_required', 'glsetup.purchase', 'smallint', 6, 10);
  37                 }
  38                 $result = $this->update_workorders() && $this->switch_database_to_utf($pref);
  39                 if ($result)
  40                         $result = $this->do_cleanup();
  41
  42                 return  update_company_prefs(array('version_id'=>$db_version));
  43         }
  44         //
  45         //      Checking before install
  46         //
  47         function pre_check($pref, $force)
  48         {
  49                 return true;
  50         }
  51
  52         //
  53         // optional procedure done after upgrade fail, before backup is restored
  54         //
  55         function post_fail($pref)
  56         {
  57                 db_query("DROP TABLE IF EXISTS " . $pref . 'wo_costing');
  58         }
  59         //
  60         //      Test if patch was applied before.
  61         //
  62         function installed($pref)
  63         {
  64                 $n = 2; // number of patches to be installed
  65                 $patchcnt = 0;
  66
  67                 if (!check_table($pref, 'suppliers', 'tax_algorithm')) $patchcnt++;
  68                 if (!check_table($pref, 'wo_costing')) $patchcnt++;
  69                 return $n == $patchcnt ? true : ($patchcnt ? ($patchcnt.'/'. $n) : 0);
  70         }
  71
  72         function update_workorders()
  73         {
  74                 global $db;
  75
  76                 $sql = "SELECT DISTINCT type, type_no, tran_date, person_id FROM ".TB_PREF."gl_trans WHERE `type`=".ST_WORKORDER
  77                 ." AND person_type_id=1";
  78                 $res = db_query($sql);
  79                 if (!$res)
  80                 {
  81                         display_error("Cannot update work orders costs"
  82                                 .':<br>'. db_error_msg($db));
  83                         return false;
  84                 }
  85                 while ($row = db_fetch($res))
  86                 {
  87                         $journal_id = get_next_trans_no(ST_JOURNAL);
  88
  89                         $sql1 = "UPDATE ".TB_PREF."gl_trans SET `type`=".ST_JOURNAL.", type_no={$journal_id},
  90                                 person_type_id=NULL, person_id=0
  91                                 WHERE `type`=".ST_WORKORDER." AND type_no={$row['type_no']} AND tran_date='{$row['tran_date']}'
  92                                 AND person_id='{$row['person_id']}'";
  93                         if (!db_query($sql1)) return false;
  94
  95                         $sql2 = "INSERT INTO ".TB_PREF."wo_costing (workorder_id, cost_type, trans_no)
  96                                 VALUES ({$row['type_no']}, {$row['person_id']}, {$journal_id})";
  97                         if (!db_query($sql2)) return false;
  98                 }
  99                 return true;
 100         }
 101
 102 /*
 103         In previous versions FA ignored encoding settings on database/tables, so it depended on server settings,
 104         but data stored is encoded in user language encoding. Now we switch to utf8 internal database encoding, while
 105         user encoding can be selected independently.
 106
 107         To perform safe FA database switch to utf-8 encoding we have to first ensure that all text/char columns
 108         have properly set encoding (the same as its content), so the algorithm performed on every table is as follows:
 109         . set default table encoding for the table to currently used on client side;
 110         . for all text/char column:
 111          - suppress autorecoding by change of the type to related binary/blob type
 112          - change column to utf8 encodding and selected collation.
 113         . change default table encoding to utf8
 114 */
 115         function switch_database_to_utf($pref, $test = false) {
 116
 117                 global $installed_languages, $dflt_lang;
 118
 119                 $old_encoding = 'latin1'; // default client encoding
 120
 121                  // site default encoding is presumed as encoding for all databases!
 122                 $lang = array_search_value($dflt_lang, $installed_languages, 'code');
 123                 $new_encoding = get_mysql_encoding_name(strtoupper($lang['encoding']));
 124         //      get_usec();
 125                 if ($test)
 126                         error_log('Switching database to utf8 encoding from '.$old_encoding);
 127                 $collation = get_mysql_collation();
 128                 $tsql = "SHOW TABLES LIKE '".($pref=='' ? '' : substr($pref, 0, -1).'\\_')."%'";
 129                 $tresult = db_query($tsql, "Cannot select all tables with prefix '$pref'");
 130                 while($tbl = db_fetch($tresult)) {
 131                         $table = $tbl[0];
 132                 // if ($table != '1_chart_master') continue; _vd($table); get_usec(); // fast debug on single table
 133
 134                         db_query("ALTER TABLE `$table` CONVERT TO CHARACTER SET $old_encoding"); // convert encoding on utf-8 tables
 135
 136                         // set proper default table encoding for current user language (used on binary->text conversion)
 137                         db_query("ALTER TABLE `$table` CHARSET $new_encoding");
 138                         $csql = "SHOW COLUMNS FROM $table";
 139                         $cresult = db_query($csql, "Cannot select column names for table '$table'");
 140                         $convert = false;
 141
 142                         $to_binary = $to_default = $to_utf = array();
 143                         while($col = db_fetch($cresult)) {
 144
 145                                 $bintype = strtr($col['Type'], array('varchar' => 'varbinary', 'char'=>'varbinary', 'text'=>'blob', 'tinytext'=>'tinyblob'));
 146
 147                                 if ($bintype != $col['Type'])
 148                                 { // this is char/text column, so change encoding to proper encoding
 149                                         if ($test)
 150                                                 error_log($table.'.'.$col['Field']);
 151
 152                                         $null = $col['Null'] === 'YES' ? ' NULL ' : ' NOT NULL ';
 153                                         $default = $col['Null'] !== 'YES' && isset($col['Default']) ? ' DEFAULT '.db_escape($col['Default']) : '';
 154
 155                                         // to avoid column width multiplication x3 we old->binary->ui->utf column type change instead of column CONVERT
 156
 157                                         $to_binary[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$bintype;
 158                                         $to_default[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$col['Type'].$null.$default;
 159                                         $to_utf[] = "MODIFY COLUMN `".$col['Field']."` ".$col['Type']." COLLATE ".$collation.$null.$default;
 160                                         $convert = true;
 161                                 }
 162                         }
 163                         if(count($to_binary))
 164                         {
 165                                 $sql = "ALTER TABLE `$table` ".implode(',',$to_binary);
 166                                 db_query($sql);
 167                                 $sql = "ALTER TABLE `$table` ".implode(',',$to_default);
 168                                 db_query($sql);
 169                                 $sql = "ALTER TABLE `$table` ".implode(',',$to_utf);
 170                                 db_query($sql);
 171                         }
 172                         db_query("ALTER TABLE `$table` COLLATE $collation");
 173                 }
 174                 db_query("ALTER DATABASE COLLATE $collation");
 175                 if ($test)
 176                         error_log('Convertion to utf8 done.');
 177
 178                 return true;
 179         }
 180
 181         function do_cleanup()
 182         {
 183                 $dropcol = array(
 184                                 'tax_group_items' => array('rate'),
 185                                 'budget_trans' => array('type', 'type_no', 'person_id', 'person_type_id', 'memo_'),
 186                 );
 187
 188                 foreach($dropcol as $table => $columns)
 189                         foreach($columns as $col) {
 190                                 if (db_query("ALTER TABLE `".TB_PREF."{$table}` DROP `$col`") == false) {
 191                                         display_error("Cannot drop {$table}.{$col} column:<br>".db_error_msg($db));
 192                                         return false;
 193                                 }
 194                         }
 195         }
 196 }
 197
 198 $install = new fa2_4;