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