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
  13 class fa2_4 extends fa_patch {
  14         var $previous = '2.3rc';                // applicable database version
  15         var $version = '2.4.1'; // version installed
  16         var $description;
  17         var $sql = 'alter2.4.sql';
  18         var $preconf = true;
  19
  20         function fa2_4() {
  21                 parent::fa_patch();
  22                 $this->description = _('Upgrade from version 2.3 to 2.4RC1');
  23         }
  24
  25     /*
  26             Shows parameters to be selected before upgrade (if any)
  27         */
  28     function show_params($comp)
  29         {
  30           display_note(_('Set optimal parameters and start upgrade:'));
  31           start_table(TABLESTYLE);
  32           start_row();
  33                 collations_list_row(_('Text collation optimization:'), 'collation', substr($_SESSION['language']->code, 0, 2));
  34           end_row();
  35           end_table();
  36           br();
  37     }
  38
  39         /*
  40             Fetches selected upgrade parameters.
  41     */
  42         function prepare()
  43     {
  44                 $this->collation = get_post('collation');
  45                 return true;
  46         }
  47
  48         //
  49         //      Install procedure. All additional changes
  50         //      not included in sql file should go here.
  51         //
  52         function install($company, $force=false)
  53         {
  54                 global $db_version, $db_connections;
  55
  56                 $pref = $db_connections[$company]['tbpref'];
  57
  58                 if (get_company_pref('grn_clearing_act') === null) { // available form 2.3.1, can be not defined on pre-2.4 installations
  59                         set_company_pref('grn_clearing_act', 'glsetup.purchase', 'varchar', 15, 0);
  60                 }
  61                 if (get_company_pref('default_quote_valid_days') === null) { // new in 2.3.23 installations
  62                         set_company_pref('default_quote_valid_days', 'glsetup.sales', 'smallint', 6, 30);
  63                 }
  64                 if (get_company_pref('bcc_email') === null) { // available from 2.3.14, can be not defined on pre-2.4 installations
  65                         set_company_pref('bcc_email', 'setup.company', 'varchar', 100, '');
  66                 }
  67                 if (get_company_pref('alternative_tax_include_on_docs') === null) { // available from 2.3.14, can be not defined on pre-2.4 installations
  68                         set_company_pref('alternative_tax_include_on_docs', 'setup.company', 'tinyint', 1, '0');
  69                 }
  70                 if (get_company_pref('suppress_tax_rates') === null) { // available from 2.3.14, can be not defined on pre-2.4 installations
  71                         set_company_pref('suppress_tax_rates', 'setup.company', 'tinyint', 1, '0');
  72                 }
  73
  74                 $result = $this->update_workorders()  && $this->update_grn_rates() && $this->switch_database_to_utf($pref);
  75
  76                 if ($result)
  77                         $result = $this->do_cleanup();
  78                 if ($result)
  79                 {
  80                         $db_connections[$company]['collation'] = $this->collation;
  81                         if (write_config_db())
  82                                 return $this->log_error(_("Cannot update config_db.php file."));
  83                 }
  84
  85                 $sec_updates = array(
  86                         'SA_SETUPCOMPANY' => array(
  87                                 'SA_ASSET', 'SA_ASSETCATEGORY', 'SA_ASSETCLASS',
  88                                 'SA_ASSETSTRANSVIEW','SA_ASSETTRANSFER', 'SA_ASSETDISPOSAL',
  89                                 'SA_DEPRECIATION', 'SA_ASSETSANALYTIC'),
  90                 );
  91                 $result = $this->update_security_roles($sec_updates);
  92
  93                 return $result;
  94         }
  95
  96         //
  97         // optional procedure done after upgrade fail, before backup is restored
  98         //
  99         function post_fail($company)
 100         {
 101                 $pref = $this->companies[$company]['tbpref'];
 102                 db_query("DROP TABLE IF EXISTS " . $pref . 'wo_costing');
 103                 db_query("DROP TABLE IF EXISTS " . $pref . 'stock_fa_class');
 104         }
 105
 106         function update_workorders()
 107         {
 108                 global $db;
 109
 110                 $sql = "SELECT DISTINCT type, type_no, tran_date, person_id FROM ".TB_PREF."gl_trans WHERE `type`=".ST_WORKORDER
 111                 ." AND person_type_id=1";
 112                 $res = db_query($sql);
 113                 if (!$res)
 114                         return $this->log_error(sprintf(_("Cannot update work orders costs:\n%s"), db_error_msg($db)));
 115
 116                 while ($row = db_fetch($res))
 117                 {
 118                         $journal_id = get_next_trans_no(ST_JOURNAL);
 119
 120                         $sql1 = "UPDATE ".TB_PREF."gl_trans SET `type`=".ST_JOURNAL.", type_no={$journal_id},
 121                                 person_type_id=NULL, person_id=0
 122                                 WHERE `type`=".ST_WORKORDER." AND type_no={$row['type_no']} AND tran_date='{$row['tran_date']}'
 123                                 AND person_id='{$row['person_id']}'";
 124                         if (!db_query($sql1)) return false;
 125
 126                         $sql2 = "INSERT INTO ".TB_PREF."wo_costing (workorder_id, cost_type, trans_no)
 127                                 VALUES ({$row['type_no']}, {$row['person_id']}, {$journal_id})";
 128                         if (!db_query($sql2)) return false;
 129                 }
 130                 return true;
 131         }
 132
 133 /*
 134         In previous versions FA ignored encoding settings on database/tables, so it depended on server settings,
 135         but data stored is encoded in user language encoding. Now we switch to utf8 internal database encoding, while
 136         user encoding can be selected independently.
 137
 138         To perform safe FA database switch to utf-8 encoding we have to first ensure that all text/char columns
 139         have properly set encoding (the same as its content), so the algorithm performed on every table is as follows:
 140         . set default table encoding for the table to currently used on client side;
 141         . for all text/char column:
 142          - suppress autorecoding by change of the type to related binary/blob type
 143          - change column to utf8 encodding and selected collation.
 144         . change default table encoding to utf8 and selected collation
 145 */
 146         function switch_database_to_utf($pref, $dbg = false) {
 147
 148                 global $installed_languages, $dflt_lang;
 149
 150                 $old_encoding = 'latin1'; // default client encoding
 151
 152                 // uncomment in case of 1071 errors (requires SUPER privileges)
 153                 // db_query("SET @@global.innodb_large_prefix=1", "Cannot set large prefix");
 154
 155                  // site default encoding is presumed as encoding for all databases!
 156                 $lang = array_search_value($dflt_lang, $installed_languages, 'code');
 157                 $new_encoding = get_mysql_encoding_name(strtoupper($lang['encoding']));
 158
 159                 $this->log_error(sprintf('Switching database to utf8 encoding from %s', $old_encoding), 'Info');
 160                 $collation = get_mysql_collation($this->collation);
 161                 $tsql = "SHOW TABLES LIKE '".($pref=='' ? '' : substr($pref, 0, -1).'\\_')."%'";
 162                 $tresult = db_query($tsql, "Cannot select all tables with prefix '$pref'");
 163                 while($tbl = db_fetch($tresult)) {
 164                         $table = $tbl[0];
 165
 166                         db_query("ALTER TABLE `$table` CONVERT TO CHARACTER SET $old_encoding"); // convert encoding on utf-8 tables
 167
 168                         // set proper default table encoding for current user language (used on binary->text conversion)
 169                         db_query("ALTER TABLE `$table` CHARSET $new_encoding");
 170                         $csql = "SHOW COLUMNS FROM $table";
 171                         $cresult = db_query($csql, "Cannot select column names for table '$table'");
 172                         $convert = false;
 173
 174                         $to_binary = $to_default = $to_utf = array();
 175                         while($col = db_fetch($cresult)) {
 176
 177                                 $bintype = strtr($col['Type'], array('varchar' => 'varbinary', 'char'=>'varbinary', 'text'=>'blob', 'tinytext'=>'tinyblob'));
 178
 179                                 if ($bintype != $col['Type'])
 180                                 { // this is char/text column, so change encoding to proper encoding
 181                                         if ($dbg)
 182                                                 $this->log_error(sprintf('%s switched to uft8.', $table.'.'.$col['Field']), 'Debug');
 183
 184                                         $null = $col['Null'] === 'YES' ? ' NULL ' : ' NOT NULL ';
 185                                         $default = $col['Null'] !== 'YES' && isset($col['Default']) ? ' DEFAULT '.db_escape($col['Default']) : '';
 186
 187                                         // to avoid column width multiplication x3 we old->binary->ui->utf column type change instead of column CONVERT
 188
 189                                         $to_binary[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$bintype;
 190                                         $to_default[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$col['Type'].$null.$default;
 191                                         $to_utf[] = "MODIFY COLUMN `".$col['Field']."` ".$col['Type']." COLLATE ".$collation.$null.$default;
 192                                         $convert = true;
 193                                 }
 194                         }
 195                         if(count($to_binary))
 196                         {
 197                                 $sql = "ALTER TABLE `$table` ".implode(',',$to_binary);
 198                                 db_query($sql);
 199                                 $sql = "ALTER TABLE `$table` ".implode(',',$to_default);
 200                                 db_query($sql);
 201                                 $sql = "ALTER TABLE `$table` ".implode(',',$to_utf);
 202                                 db_query($sql);
 203                         }
 204                         db_query("ALTER TABLE `$table` COLLATE $collation");
 205                 }
 206                 db_query("ALTER DATABASE COLLATE $collation");
 207                 $this->log_error(_('Convertion to utf8 done.'), 'Info');
 208
 209                 return true;
 210         }
 211
 212         function update_grn_rates()
 213         {
 214                 $sql = "SELECT grn.id, grn.delivery_date, supp.curr_code
 215                         FROM ".TB_PREF."grn_batch grn, ".TB_PREF."suppliers supp
 216                         WHERE supp.supplier_id=grn.supplier_id AND supp.curr_code!='".get_company_pref('curr_default')."'";
 217                 $result = db_query($sql);
 218
 219                 if (!$result)
 220                         return false;
 221
 222                 $sql = "UPDATE ".TB_PREF."grn_batch SET rate=%s WHERE id=%d";
 223                 while ($grn = db_fetch($result))
 224                         db_query(sprintf($sql, get_exchange_rate_from_home_currency($grn['curr_code'], sql2date($grn['delivery_date'])), $grn['id']));
 225
 226                 return true;
 227         }
 228
 229         function do_cleanup()
 230         {
 231                 global $db;
 232
 233                 //remove obsolete and temporary columns.
 234                 // this have to be done here as db_import rearranges alter query order
 235                 $dropcol = array(
 236                                 'tax_groups' => array('tax_shipping'),
 237                                 'tax_group_items' => array('rate'),
 238                                 'budget_trans' => array('type', 'type_no', 'person_id', 'person_type_id', 'memo_'),
 239                                 'cust_branch' => array('contact_name', 'disable_trans'),
 240                                 'stock_moves' => array('discount_percent', 'visible', 'person_id'),
 241                 );
 242
 243                 foreach($dropcol as $table => $columns)
 244                         foreach($columns as $col) {
 245                                 if (db_query("ALTER TABLE `".TB_PREF."{$table}` DROP `$col`") == false) {
 246                                         return $this->log_error(sprintf(_("Cannot drop column in %s table: %s"), $table, db_error_msg($db)));
 247                                 }
 248                         }
 249                 return true;
 250   }
 251 }
 252
 253 $install = new fa2_4;