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 ***********************************************************************/
13 class fa2_4 extends fa_patch {
14 var $previous = '2.3rc'; // applicable database version
15 var $version = '2.4.1'; // version installed
17 var $sql = 'alter2.4.sql';
19 var $max_upgrade_time = 900; // table recoding is really long process
21 function __construct() {
22 parent::__construct();
23 $this->description = _('Upgrade from version 2.3 to 2.4');
27 Shows parameters to be selected before upgrade (if any)
29 function show_params($comp)
31 display_note(_('Set optimal parameters and start upgrade:'));
32 start_table(TABLESTYLE);
34 collations_list_row(_('Text collation optimization:'), 'collation', substr($_SESSION['language']->code, 0, 2));
41 Fetches selected upgrade parameters.
45 $this->collation = get_post('collation');
50 // Install procedure. All additional changes
51 // not included in sql file should go here.
53 function install($company, $force=false)
55 global $db_version, $db_connections;
57 $pref = $db_connections[$company]['tbpref'];
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);
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);
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, '');
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');
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');
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');
77 if (get_company_pref('barcodes_on_stock') === null) { // available from 2.4.3, during updates
78 set_company_pref('barcodes_on_stock', 'setup.company', 'tinyint', 1, '0');
80 if (get_company_pref('ref_no_auto_increase') === null) { // available from 2.4.4, during updates
81 set_company_pref('ref_no_auto_increase', 'setup.company', 'tinyint', 1, '0');
83 if (get_company_pref('shortname_name_in_list') === null) { // available from 2.4.2, during updates
84 set_company_pref('shortname_name_in_list', 'setup.company', 'tinyint', 1, '0');
87 $result = $this->update_workorders() && $this->update_grn_rates() && $this->switch_database_to_utf($pref);
90 $result = $this->do_cleanup();
93 $db_connections[$company]['collation'] = $this->collation;
94 if (write_config_db())
95 return $this->log_error(_("Cannot update config_db.php file."));
99 'SA_SETUPCOMPANY' => array(
100 'SA_ASSET', 'SA_ASSETCATEGORY', 'SA_ASSETCLASS',
101 'SA_ASSETSTRANSVIEW','SA_ASSETTRANSFER', 'SA_ASSETDISPOSAL',
102 'SA_DEPRECIATION', 'SA_ASSETSANALYTIC'),
104 $result = $this->update_security_roles($sec_updates);
110 // optional procedure done after upgrade fail, before backup is restored
112 function post_fail($company)
114 $pref = $this->companies[$company]['tbpref'];
115 db_query("DROP TABLE IF EXISTS " . $pref . 'wo_costing');
116 db_query("DROP TABLE IF EXISTS " . $pref . 'stock_fa_class');
117 db_query("DELETE FROM ".$pref."sys_prefs
119 'gl_closing_date', 'deferred_income_act', 'no_zero_lines_amount', 'accounts_alpha',
120 'tax_algorithm', 'grn_clearing_act', 'default_receival_required',
121 'default_quote_valid_days', 'no_zero_lines_amount', 'show_po_item_codes', 'accounts_alpha',
122 'loc_notification', 'print_invoice_no', 'allow_negative_prices', 'print_item_images_on_quote',
123 'bcc_email', 'alternative_tax_include_on_docs', 'suppress_tax_rates', 'company_logo_report',
124 'barcodes_on_stock', 'ref_no_auto_increase')");
127 function update_workorders()
131 $sql = "SELECT DISTINCT type, type_no, tran_date, person_id FROM ".TB_PREF."gl_trans WHERE `type`=".ST_WORKORDER
132 ." AND person_type_id=1";
133 $res = db_query($sql);
135 return $this->log_error(sprintf(_("Cannot update work orders costs:\n%s"), db_error_msg($db)));
137 while ($row = db_fetch($res))
139 $journal_id = get_next_trans_no(ST_JOURNAL);
141 $sql1 = "UPDATE ".TB_PREF."gl_trans SET `type`=".ST_JOURNAL.", type_no={$journal_id},
142 person_type_id=NULL, person_id=0
143 WHERE `type`=".ST_WORKORDER." AND type_no={$row['type_no']} AND tran_date='{$row['tran_date']}'
144 AND person_id='{$row['person_id']}'";
145 if (!db_query($sql1)) return false;
147 $sql2 = "INSERT INTO ".TB_PREF."wo_costing (workorder_id, cost_type, trans_no)
148 VALUES ({$row['type_no']}, {$row['person_id']}, {$journal_id})";
149 if (!db_query($sql2)) return false;
155 In previous versions FA ignored encoding settings on database/tables, so it depended on server settings,
156 but data stored is encoded in user language encoding. Now we switch to utf8 internal database encoding, while
157 user encoding can be selected independently.
159 To perform safe FA database switch to utf-8 encoding we have to first ensure that all text/char columns
160 have properly set encoding (the same as its content), so the algorithm performed on every table is as follows:
161 . set default table encoding for the table to currently used on client side;
162 . for all text/char column:
163 - suppress autorecoding by change of the type to related binary/blob type
164 - change column to utf8 encodding and selected collation.
165 . change default table encoding to utf8 and selected collation
167 function switch_database_to_utf($pref, $dbg = false) {
169 global $installed_languages, $dflt_lang;
171 $old_encoding = 'latin1'; // default client encoding
173 // uncomment in case of 1071 errors (requires SUPER privileges)
174 // db_query("SET @@global.innodb_large_prefix=1", "Cannot set large prefix");
176 // site default encoding is presumed as encoding for all databases!
177 $lang = array_search_value($dflt_lang, $installed_languages, 'code');
178 $new_encoding = get_mysql_encoding_name(strtoupper($lang['encoding']));
180 $this->log_error(sprintf('Switching database to utf8 encoding from %s', $old_encoding), 'Info');
181 $collation = get_mysql_collation($this->collation);
182 $tsql = "SHOW TABLES LIKE '".($pref=='' ? '' : substr($pref, 0, -1).'\\_')."%'";
183 $tresult = db_query($tsql, "Cannot select all tables with prefix '$pref'");
184 while($tbl = db_fetch($tresult)) {
187 db_query("ALTER TABLE `$table` CONVERT TO CHARACTER SET $old_encoding"); // convert encoding on utf-8 tables
189 // set proper default table encoding for current user language (used on binary->text conversion)
190 db_query("ALTER TABLE `$table` CHARSET $new_encoding");
191 $csql = "SHOW COLUMNS FROM $table";
192 $cresult = db_query($csql, "Cannot select column names for table '$table'");
195 $to_binary = $to_default = $to_utf = array();
196 while($col = db_fetch($cresult)) {
198 $bintype = strtr($col['Type'], array('varchar' => 'varbinary', 'char'=>'varbinary', 'text'=>'blob', 'tinytext'=>'tinyblob'));
200 if ($bintype != $col['Type'])
201 { // this is char/text column, so change encoding to proper encoding
203 $this->log_error(sprintf('%s switched to uft8.', $table.'.'.$col['Field']), 'Debug');
205 $null = $col['Null'] === 'YES' ? ' NULL ' : ' NOT NULL ';
206 $default = $col['Null'] !== 'YES' && isset($col['Default']) ? ' DEFAULT '.db_escape($col['Default']) : '';
208 // to avoid column width multiplication x3 we old->binary->ui->utf column type change instead of column CONVERT
210 $to_binary[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$bintype;
211 $to_default[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$col['Type'].$null.$default;
212 $to_utf[] = "MODIFY COLUMN `".$col['Field']."` ".$col['Type']." COLLATE ".$collation.$null.$default;
216 if(count($to_binary))
218 $sql = "ALTER TABLE `$table` ".implode(',',$to_binary);
220 $sql = "ALTER TABLE `$table` ".implode(',',$to_default);
222 $sql = "ALTER TABLE `$table` ".implode(',',$to_utf);
225 db_query("ALTER TABLE `$table` COLLATE $collation");
227 db_query("ALTER DATABASE COLLATE $collation");
228 $this->log_error(_('Convertion to utf8 done.'), 'Info');
233 function update_grn_rates()
235 $sql = "SELECT grn.id, grn.delivery_date, supp.curr_code
236 FROM ".TB_PREF."grn_batch grn, ".TB_PREF."suppliers supp
237 WHERE supp.supplier_id=grn.supplier_id AND supp.curr_code!='".get_company_pref('curr_default')."'";
238 $result = db_query($sql);
243 $sql = "UPDATE ".TB_PREF."grn_batch SET rate=%s WHERE id=%d";
244 while ($grn = db_fetch($result))
245 db_query(sprintf($sql, get_exchange_rate_from_home_currency($grn['curr_code'], sql2date($grn['delivery_date'])), $grn['id']));
250 function do_cleanup()
254 //remove obsolete and temporary columns.
255 // this have to be done here as db_import rearranges alter query order
257 'tax_groups' => array('tax_shipping'),
258 'tax_group_items' => array('rate'),
259 'budget_trans' => array('type', 'type_no', 'person_id', 'person_type_id', 'memo_'),
260 'cust_branch' => array('contact_name', 'disable_trans'),
261 'stock_moves' => array('discount_percent', 'visible', 'person_id'),
264 foreach($dropcol as $table => $columns)
265 foreach($columns as $col) {
266 if (db_query("ALTER TABLE `".TB_PREF."{$table}` DROP `$col`") == false) {
267 return $this->log_error(sprintf(_("Cannot drop column in %s table: %s"), $table, db_error_msg($db)));
274 $install = new fa2_4;