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 function collations_list_row($label, $name, $selected_id=null)
15 $mysql_collations = array(
16 'xx' => 'Unicode (multilanguage)',
23 'es' => 'Spanish', // or 'spanish2',
30 'sp' => 'Spanish (alternative)',
39 echo "<td class='label'>$label</td>\n";
42 echo array_selector($name, $selected_id, $mysql_collations,
43 array('select_submit'=> false) );
47 class fa2_4 extends fa_patch {
48 var $previous = '2.3rc'; // applicable database version
49 var $version = '2.4.0'; // version installed
51 var $sql = 'alter2.4.sql';
56 $this->description = _('Upgrade from version 2.3 to 2.4');
60 Shows parameters to be selected before upgrade (if any)
62 function show_params($comp)
64 display_note(_('Set optimal parameters and start upgrade:'));
65 start_table(TABLESTYLE);
67 collations_list_row(_('Text collation optimization:'), 'collation', substr($_SESSION['language']->code, 0, 2));
74 Fetches selected upgrade parameters.
78 $this->collation = get_mysql_collation(get_post('collation'));
83 // Install procedure. All additional changes
84 // not included in sql file should go here.
86 function install($company, $force=false)
88 global $db_version, $db_connections;
90 $pref = $db_connections[$company]['tbpref'];
92 if (get_company_pref('grn_clearing_act') === null) { // available form 2.3.1, can be not defined on pre-2.4 installations
93 set_company_pref('grn_clearing_act', 'glsetup.purchase', 'varchar', 15, 0);
95 if (get_company_pref('default_quote_valid_days') === null) { // new in 2.3.23 installations
96 set_company_pref('default_quote_valid_days', 'glsetup.sales', 'smallint', 6, 30);
98 if (get_company_pref('bcc_email') === null) { // available from 2.3.14, can be not defined on pre-2.4 installations
99 set_company_pref('bcc_email', 'setup.company', 'varchar', 100, '');
101 if (get_company_pref('alternative_tax_include_on_docs') === null) { // available from 2.3.14, can be not defined on pre-2.4 installations
102 set_company_pref('alternative_tax_include_on_docs', 'setup.company', 'tinyint', 1, '0');
104 if (get_company_pref('suppress_tax_rates') === null) { // available from 2.3.14, can be not defined on pre-2.4 installations
105 set_company_pref('suppress_tax_rates', 'setup.company', 'tinyint', 1, '0');
108 $result = $this->update_workorders() && $this->update_grn_rates() && $this->switch_database_to_utf($pref);
111 $result = $this->do_cleanup();
117 // optional procedure done after upgrade fail, before backup is restored
119 function post_fail($company)
121 $pref = $this->companies[$company]['tbpref'];
122 db_query("DROP TABLE IF EXISTS " . $pref . 'wo_costing');
125 function update_workorders()
129 $sql = "SELECT DISTINCT type, type_no, tran_date, person_id FROM ".TB_PREF."gl_trans WHERE `type`=".ST_WORKORDER
130 ." AND person_type_id=1";
131 $res = db_query($sql);
133 return $this->log_error(sprintf(_("Cannot update work orders costs:\n%s"), db_error_msg($db)));
135 while ($row = db_fetch($res))
137 $journal_id = get_next_trans_no(ST_JOURNAL);
139 $sql1 = "UPDATE ".TB_PREF."gl_trans SET `type`=".ST_JOURNAL.", type_no={$journal_id},
140 person_type_id=NULL, person_id=0
141 WHERE `type`=".ST_WORKORDER." AND type_no={$row['type_no']} AND tran_date='{$row['tran_date']}'
142 AND person_id='{$row['person_id']}'";
143 if (!db_query($sql1)) return false;
145 $sql2 = "INSERT INTO ".TB_PREF."wo_costing (workorder_id, cost_type, trans_no)
146 VALUES ({$row['type_no']}, {$row['person_id']}, {$journal_id})";
147 if (!db_query($sql2)) return false;
153 In previous versions FA ignored encoding settings on database/tables, so it depended on server settings,
154 but data stored is encoded in user language encoding. Now we switch to utf8 internal database encoding, while
155 user encoding can be selected independently.
157 To perform safe FA database switch to utf-8 encoding we have to first ensure that all text/char columns
158 have properly set encoding (the same as its content), so the algorithm performed on every table is as follows:
159 . set default table encoding for the table to currently used on client side;
160 . for all text/char column:
161 - suppress autorecoding by change of the type to related binary/blob type
162 - change column to utf8 encodding and selected collation.
163 . change default table encoding to utf8 and selected collation
165 function switch_database_to_utf($pref, $dbg = false) {
167 global $installed_languages, $dflt_lang;
169 $old_encoding = 'latin1'; // default client encoding
171 // site default encoding is presumed as encoding for all databases!
172 $lang = array_search_value($dflt_lang, $installed_languages, 'code');
173 $new_encoding = get_mysql_encoding_name(strtoupper($lang['encoding']));
175 $this->log_error(sprintf('Switching database to utf8 encoding from %s', $old_encoding), 'Info');
176 $collation = $this->collation;
177 $tsql = "SHOW TABLES LIKE '".($pref=='' ? '' : substr($pref, 0, -1).'\\_')."%'";
178 $tresult = db_query($tsql, "Cannot select all tables with prefix '$pref'");
179 while($tbl = db_fetch($tresult)) {
182 db_query("ALTER TABLE `$table` CONVERT TO CHARACTER SET $old_encoding"); // convert encoding on utf-8 tables
184 // set proper default table encoding for current user language (used on binary->text conversion)
185 db_query("ALTER TABLE `$table` CHARSET $new_encoding");
186 $csql = "SHOW COLUMNS FROM $table";
187 $cresult = db_query($csql, "Cannot select column names for table '$table'");
190 $to_binary = $to_default = $to_utf = array();
191 while($col = db_fetch($cresult)) {
193 $bintype = strtr($col['Type'], array('varchar' => 'varbinary', 'char'=>'varbinary', 'text'=>'blob', 'tinytext'=>'tinyblob'));
195 if ($bintype != $col['Type'])
196 { // this is char/text column, so change encoding to proper encoding
198 $this->log_error(sprintf('%s switched to uft8.', $table.'.'.$col['Field']), 'Debug');
200 $null = $col['Null'] === 'YES' ? ' NULL ' : ' NOT NULL ';
201 $default = $col['Null'] !== 'YES' && isset($col['Default']) ? ' DEFAULT '.db_escape($col['Default']) : '';
203 // to avoid column width multiplication x3 we old->binary->ui->utf column type change instead of column CONVERT
205 $to_binary[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$bintype;
206 $to_default[] = "CHANGE `".$col['Field']."` `".$col['Field']."` ".$col['Type'].$null.$default;
207 $to_utf[] = "MODIFY COLUMN `".$col['Field']."` ".$col['Type']." COLLATE ".$collation.$null.$default;
211 if(count($to_binary))
213 $sql = "ALTER TABLE `$table` ".implode(',',$to_binary);
215 $sql = "ALTER TABLE `$table` ".implode(',',$to_default);
217 $sql = "ALTER TABLE `$table` ".implode(',',$to_utf);
220 db_query("ALTER TABLE `$table` COLLATE $collation");
222 db_query("ALTER DATABASE COLLATE $collation");
223 $this->log_error(_('Convertion to utf8 done.'), 'Info');
228 function update_grn_rates()
230 $sql = "SELECT grn.id, grn.delivery_date, supp.curr_code
231 FROM ".TB_PREF."grn_batch grn, ".TB_PREF."suppliers supp
232 WHERE supp.supplier_id=grn.supplier_id AND supp.curr_code!='".get_company_pref('curr_default')."'";
233 $result = db_query($sql);
238 $sql = "UPDATE ".TB_PREF."grn_batch SET rate=%s WHERE id=%d";
239 while ($grn = db_fetch($result))
240 db_query(sprintf($sql, get_exchange_rate_from_home_currency($grn['curr_code'], sql2date($grn['delivery_date'])), $grn['id']));
245 function do_cleanup()
249 //remove obsolete and temporary columns.
250 // this have to be done here as db_import rearranges alter query order
252 'tax_group_items' => array('rate'),
253 'budget_trans' => array('type', 'type_no', 'person_id', 'person_type_id', 'memo_'),
254 'cust_branch' => array('contact_name', 'disable_trans'),
255 'stock_moves' => array('discount_percent', 'person_id'),
258 foreach($dropcol as $table => $columns)
259 foreach($columns as $col) {
260 if (db_query("ALTER TABLE `".TB_PREF."{$table}` DROP `$col`") == false) {
261 return $this->log_error(sprintf(_("Cannot drop column in %s table: %s"), $table, db_error_msg($db)));
268 $install = new fa2_4;