forked from interconnectit/Search-Replace-DB
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsrdb.class.php
1340 lines (1083 loc) · 41.6 KB
/
srdb.class.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
*
* Safe Search and Replace on Database with Serialized Data
*
* This script is to solve the problem of doing database search and replace when
* some data is stored within PHP serialized arrays or objects.
*
* For more information, see
* http://interconnectit.com/124/search-and-replace-for-wordpress-databases/
*
* To contribute go to
* http://github.com/interconnectit/search-replace-db
*
* To use, load the script on your server and point your web browser to it.
* In some situations, consider using the command line interface version.
*
* BIG WARNING! Take a backup first, and carefully test the results of this
* code. If you don't, and you vape your data then you only have yourself to
* blame. Seriously. And if your English is bad and you don't fully
* understand the instructions then STOP. Right there. Yes. Before you do any
* damage.
*
* USE OF THIS SCRIPT IS ENTIRELY AT YOUR OWN RISK. I/We accept no liability
* from its use.
*
* First Written 2009-05-25 by David Coveney of Interconnect IT Ltd (UK)
* http://www.davidcoveney.com or http://interconnectit.com
* and released under the GPL v3
* ie, do what ever you want with the code, and we take no responsibility for it
* OK? If you don't wish to take responsibility, hire us at Interconnect IT Ltd
* on +44 (0)151 331 5140 and we will do the work for you at our hourly rate,
* minimum 1hr
*
*
* This file is part of Search-Replace-DB.
* Copyright © 2020 Interconnect IT Limited
*
* Search-Replace-DB is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or any later version.
*
* Search-Replace-DB is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Search-Replace-DB.
* If not, see <https://www.gnu.org/licenses/>.
*/
class icit_srdb {
/**
* @var array List of all the tables in the database
*/
public $all_tables = array();
/**
* @var array Tables to run the replacement on
*/
public $tables = array();
public $exclude_tables = array();
/**
* @var string Search term
*/
public $search = false;
/**
* @var string Replacement
*/
public $replace = false;
/**
* @var bool Use regular expressions to perform search and replace
*/
public $regex = false;
/**
* @var bool Leave guid column alone
*/
public $guid = false;
/**
* @var array Available engines
*/
public $engines = array();
/**
* @var bool|string Convert to new engine
*/
public $alter_engine = false;
/**
* @var bool|string Convert to new collation
*/
public $alter_collate = false;
/**
* @var array Column names to exclude
*/
public $exclude_cols = array();
/**
* @var array Column names to include
*/
public $include_cols = array();
/**
* @var bool True if doing a dry run
*/
public $dry_run = true;
/**
* @var string Database connection details
*/
public $name = '';
public $user = '';
public $pass = '';
public $host = '127.0.0.1';
public $port = 0;
public $charset = 'utf8';
public $collate = '';
public $ssl_key = false;
public $ssl_cert = false;
public $ssl_ca = false;
public $ssl_ca_dir = null;
public $ssl_cipher = null;
public $debug = false;
/**
* @var array Stores a list of exceptions
*/
public $errors = array(
'search' => array(),
'db' => array(),
'tables' => array(),
'results' => array(),
'exclude_tables' => array(),
'compatibility' => array()
);
public $error_type = 'search';
/**
* @var array Stores the report array
*/
public $report = array();
/**
* @var int Number of modifications to return in report array
*/
public $report_change_num = 30;
/**
* @var bool Whether to echo report as script runs
*/
public $verbose = false;
/**
* @var mysqli|PDO connection
*/
public $db;
/**
* @var bool
*/
public $use_pdo = true;
/**
* How many rows to select at a time when replacing
* @var int
*/
public $page_size = 50000;
/**
* Searches for WP or Drupal context
* Checks for $_POST data
* Initialises database connection
* Handles ajax
* Runs replacement
*
* @param string $name database name
* @param string $user database username
* @param string $pass database password
* @param string $host database hostname
* @param string $port database connection port
* @param string $search search string / regex
* @param string $replace replacement string
* @param array $tables tables to run replcements against
* @param bool $live live run
* @param array $exclude_cols tables to run replcements against
*
* @return array|void
*/
public function __construct( $args ) {
$args = array_merge( array(
'name' => '',
'user' => '',
'pass' => '',
'host' => '',
'port' => 3306,
'search' => '',
'replace' => '',
'tables' => array(),
'exclude_tables' => array(),
'exclude_cols' => array(),
'include_cols' => array(),
'dry_run' => true,
'regex' => false,
'pagesize' => 50000,
'alter_engine' => false,
'alter_collation' => false,
'verbose' => false,
'ssl_key' => false,
'ssl_cert' => false,
'ssl_ca' => false,
'ssl_check' => true,
'ssl_ca_dir' => null,
'ssl_cipher' => null,
'debug' => false
), $args );
// handle exceptions
set_exception_handler( array( $this, 'exceptions' ) );
// handle errors
if ( $args['debug'] === false ) {
set_error_handler( array( $this, 'error_handler' ), E_ERROR | E_WARNING );
}
// Setting this so that mb_split works correctly.
// BEAR IN MIND that this affects the handling of strings INTERNALLY rather than
// at the html output interface, the console interface, json interface, or the database interface.
// This means that if the DB has a different charset (utf16?), we need to make sure that it's
// normalised to utf-8 internally and output in the appropriate charset.
mb_regex_encoding( 'UTF-8' );
// allow a string for columns
foreach ( array( 'exclude_cols', 'include_cols', 'tables', 'exclude_tables' ) as $maybe_string_arg ) {
ini_set( 'unserialize_callback_func', 'object_serializer' );
if ( is_string( $args[ $maybe_string_arg ] ) ) {
$args[ $maybe_string_arg ] = array_filter( array_map( 'trim',
explode( ',', $args[ $maybe_string_arg ] ) ) );
}
}
// verify that the port number is logical
// work around PHPs inability to stringify a zero without making it an empty string
// AND without casting away trailing characters if they are present.
$port_as_string = (string) $args['port'] ? (string) $args['port'] : "0";
if ( (string) abs( (int) $args['port'] ) !== $port_as_string ) {
$port_error = 'Port number must be a positive integer if specified.';
$this->add_error( $port_error, 'db' );
if ( defined( 'STDIN' ) ) {
echo 'Error: ' . $port_error;
}
return;
}
// set class vars
foreach ( $args as $name => $value ) {
if ( is_string( $value ) ) {
$value = stripcslashes( $value );
}
if ( is_array( $value ) ) {
$value = array_map( 'stripcslashes', $value );
}
$this->set( $name, $value );
}
// only for non cli call, cli set no timeout, no memory limit
if ( ! defined( 'STDIN' ) ) {
// increase time out limit
@set_time_limit( 60 * 10 );
// try to push the allowed memory up, while we're at it
@ini_set( 'memory_limit', '1024M' );
}
// set up db connection
$this->db_setup();
if ( $this->db_valid() ) {
// update engines
if ( $this->alter_engine ) {
$report = $this->update_engine( $this->alter_engine, $this->tables );
} // update collation
elseif ( $this->alter_collation ) {
$report = $this->update_collation( $this->alter_collation, $this->tables );
} elseif ( is_array( $this->search ) ) {
$report = array();
for ( $i = 0; $i < count( $this->search ); $i ++ ) {
$report[ $i ] = $this->replacer( $this->search[ $i ], $this->replace[ $i ], $this->tables,
$this->exclude_tables );
}
} else {
$report = $this->replacer( $this->search, $this->replace, $this->tables, $this->exclude_tables );
}
} else {
$report = $this->report;
}
// store report
$this->report = $report;
return $report;
}
/**
* Terminates db connection
*
* @return void
*/
public function __destruct() {
if ( $this->db_valid() ) {
$this->db_close();
}
}
public function get( $property ) {
return $this->$property;
}
public function set( $property, $value ) {
$this->$property = $value;
}
/**
* @param $exception Exception
*/
public function exceptions( $exception ) {
echo $exception->getMessage() . "\n";
}
/**
* Custom error handler
*
* @param $errno
* @param $message
* @param $file
* @param $line
*
* @return bool
*/
public function error_handler( $errno, $message, $file, $line ) {
if ( ! ( error_reporting() & $errno ) ) {
return false;
}
switch ( $errno ) {
case E_USER_ERROR:
echo "ERROR [$errno]: $message\n";
echo "Aborting...\n";
exit( $errno );
break;
case E_USER_WARNING:
echo "WARNING [$errno] $message\n";
break;
default:
echo "Unknown error: [$errno] $message in $file on line $line\n";
exit( $errno );
break;
}
/* Don't execute PHP internal error handler */
return true;
}
public function log( $type = '' ) {
$args = array_slice( func_get_args(), 1 );
if ( $this->verbose ) {
echo "{$type}: ";
print_r( $args );
echo "\n";
}
return $args;
}
public function add_error( $error, $type = null ) {
if ( $type !== null ) {
$this->error_type = $type;
}
$this->errors[ $this->error_type ][] = $error;
$this->log( 'error', $this->error_type, $error );
}
/**
* Setup connection, populate tables array
* Also responsible for selecting the type of connection to use.
*
* @return void|bool
*/
public function db_setup() {
$mysqli_available = class_exists( 'mysqli' );
$pdo_available = class_exists( 'PDO' );
$connection_type = '';
// Default to mysqli type.
// Only advance to PDO if all conditions are met.
if ( $mysqli_available ) {
$connection_type = 'mysqli';
}
if ( $pdo_available ) {
// PDO is the interface, but it may not have the 'mysql' module.
$mysql_driver_present = in_array( 'mysql', pdo_drivers() );
if ( $mysql_driver_present ) {
$connection_type = 'pdo';
}
}
// Abort if mysqli and PDO are both broken.
if ( '' === $connection_type ) {
$this->add_error( 'Could not find any MySQL database drivers. (MySQLi or PDO required.)', 'db' );
return false;
}
// connect
$this->db = $this->connect( $connection_type );
}
/**
* Database connection type router
*
* @param string $type
*
* @return PDO|mysqli|null
*/
public function connect( $type = '' ) {
if ( $type == 'mysqli' ) {
return $this->connect_mysqli();
}
if ( $type == 'pdo' ) {
return $this->connect_pdo();
}
$this->add_error( 'Cannot connect using the method ' . $type );
return null;
}
/**
* Creates the database connection using newer mysqli functions
*
* @return mysqli
*/
public function connect_mysqli() {
// switch off PDO
$this->use_pdo = false;
$connection = mysqli_init();
if ( PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 ) {
mysqli_options( $connection, MYSQLI_OPT_SSL_VERIFY_SERVER_CERT, $this->get( 'ssl_check' ) );
}
if ( $this->get( 'ssl_key' ) || $this->get( 'ssl_cert' ) || $this->get( 'ssl_ca' ) ) {
$status = mysqli_ssl_set(
$connection,
$this->get( 'ssl_key' ),
$this->get( 'ssl_cert' ),
$this->get( 'ssl_ca' ),
$this->get( 'ssl_ca_dir' ),
$this->get( 'ssl_cipher' )
);
if ( $status === false ) {
$this->add_error( 'Cannot use SSL using mysqli', 'db' );
}
}
if ( $this->get( 'debug' ) ) {
mysqli_report( MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT );
}
// unset if not available
if ( mysqli_real_connect( $connection, $this->host, $this->user, $this->pass, $this->name,
$this->port ) === false ) {
$this->add_error( mysqli_connect_error(), 'db' );
}
return $connection;
}
/**
* Sets up database connection using PDO
*
* @return PDO|bool
*/
public function connect_pdo() {
try {
$params_map = array(
'ssl_key' => PDO::MYSQL_ATTR_SSL_KEY,
'ssl_cert' => PDO::MYSQL_ATTR_SSL_CERT,
'ssl_ca' => PDO::MYSQL_ATTR_SSL_CA,
'ssl_ca_dir' => PDO::MYSQL_ATTR_SSL_CAPATH,
'ssl_cipher' => PDO::MYSQL_ATTR_SSL_CIPHER
);
$params = array();
foreach ( $params_map as $property => $pdo_param ) {
if ( $this->get( $property ) ) {
$params[ $pdo_param ] = $this->get( $property );
}
}
if ( PHP_MAJOR_VERSION >= 7 && ! empty( $params ) ) {
$params[ PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT ] = $this->get( 'ssl_check' );
}
if ( $this->get( 'debug' ) ) {
$params[ PDO::ATTR_ERRMODE ] = PDO::ERRMODE_EXCEPTION;
}
$connection = new PDO(
"mysql:host={$this->host};port={$this->port};dbname={$this->name}",
$this->user,
$this->pass,
$params
);
} catch ( PDOException $exception ) {
if ( $this->get( 'debug' ) ) {
throw $exception;
}
$this->add_error( $exception->getMessage(), 'db' );
$connection = false;
}
// check if there's a problem with our database at this stage
if ( $connection && ! $connection->query( 'SHOW TABLES' ) ) {
$error_info = $connection->errorInfo();
if ( ! empty( $error_info ) && is_array( $error_info ) ) {
$this->add_error( array_pop( $error_info ), 'db' );
} // Array pop will only accept a $var..
$connection = false;
}
return $connection;
}
/**
* Retrieve all tables from the database
*
* @return array
*/
public function get_tables() {
// get tables
// A clone of show table status but with character set for the table.
$show_table_status = "SELECT
t.`TABLE_NAME` as Name,
t.`ENGINE` as `Engine`,
t.`version` as `Version`,
t.`ROW_FORMAT` AS `Row_format`,
t.`TABLE_ROWS` AS `Rows`,
t.`AVG_ROW_LENGTH` AS `Avg_row_length`,
t.`DATA_LENGTH` AS `Data_length`,
t.`MAX_DATA_LENGTH` AS `Max_data_length`,
t.`INDEX_LENGTH` AS `Index_length`,
t.`DATA_FREE` AS `Data_free`,
t.`AUTO_INCREMENT` as `Auto_increment`,
t.`CREATE_TIME` AS `Create_time`,
t.`UPDATE_TIME` AS `Update_time`,
t.`CHECK_TIME` AS `Check_time`,
t.`TABLE_COLLATION` as Collation,
c.`CHARACTER_SET_NAME` as Character_set,
t.`Checksum`,
t.`Create_options`,
t.`table_Comment` as `Comment`
FROM information_schema.`TABLES` t
LEFT JOIN information_schema.`COLLATION_CHARACTER_SET_APPLICABILITY` c
ON ( t.`TABLE_COLLATION` = c.`COLLATION_NAME` )
WHERE t.`TABLE_SCHEMA` = '{$this->name}'
ORDER BY t.`TABLE_NAME`;
";
$all_tables_mysql = $this->db_query( $show_table_status );
$all_tables = array();
if ( ! $all_tables_mysql ) {
$this->add_error( $this->db_error(), 'db' );
} else {
// set the character set
//$this->db_set_charset( $this->get( 'charset' ) );
while ( $table = $this->db_fetch( $all_tables_mysql ) ) {
// ignore views
if ( $table['Comment'] == 'VIEW' ) {
continue;
}
$all_tables[ $table[0] ] = $table;
}
}
return $all_tables;
}
/**
* Get the character set for the current table
*
* @param string $table_name The name of the table we want to get the char
* set for
*
* @return string The character encoding;
*/
public function get_table_character_set( $table_name = '' ) {
$table_name = $this->db_escape( $table_name );
$schema = $this->db_escape( $this->name );
$charset = $this->db_query( "SELECT c.`character_set_name`
FROM information_schema.`TABLES` t
LEFT JOIN information_schema.`COLLATION_CHARACTER_SET_APPLICABILITY` c
ON (t.`TABLE_COLLATION` = c.`COLLATION_NAME`)
WHERE t.table_schema = {$schema}
AND t.table_name = {$table_name}
LIMIT 1;" );
$encoding = false;
if ( ! $charset ) {
$this->add_error( $this->db_error(), 'db' );
} else {
$result = $this->db_fetch( $charset );
$encoding = isset( $result['character_set_name'] ) ? $result['character_set_name'] : false;
}
return $encoding;
}
/**
* Retrieve all supported database engines
*
* @return array
*/
public function get_engines() {
// get available engines
$mysql_engines = $this->db_query( 'SHOW ENGINES;' );
$engines = array();
if ( ! $mysql_engines ) {
$this->add_error( $this->db_error(), 'db' );
} else {
while ( $engine = $this->db_fetch( $mysql_engines ) ) {
if ( in_array( $engine['Support'], array( 'YES', 'DEFAULT' ) ) ) {
$engines[] = $engine['Engine'];
}
}
}
return $engines;
}
public function db_query( $query ) {
if ( $this->use_pdo ) {
return $this->db->query( $query );
} else {
return mysqli_query( $this->db, $query );
}
}
public function db_update( $query ) {
if ( $this->use_pdo ) {
return $this->db->exec( $query );
} else {
return mysqli_query( $this->db, $query );
}
}
public function db_error() {
if ( $this->use_pdo ) {
$error_info = $this->db->errorInfo();
return ! empty( $error_info ) && is_array( $error_info ) ? array_pop( $error_info ) : 'Unknown error';
} else {
return mysqli_error( $this->db );
}
}
/**
* @param $data mysqli_result|PDOStatement
*
* @return array|null
*/
public function db_fetch( $data ) {
if ( $this->use_pdo ) {
return $data->fetch();
} else {
return mysqli_fetch_array( $data );
}
}
public function db_escape( $string ) {
if ( $this->use_pdo ) {
return $this->db->quote( $string );
} else {
return "'" . mysqli_real_escape_string( $this->db, $string ) . "'";
}
}
public function db_free_result( $data ) {
if ( $this->use_pdo ) {
return $data->closeCursor();
} else {
return mysqli_free_result( $data );
}
}
public function db_set_charset( $charset = '' ) {
if ( ! empty( $charset ) ) {
if ( ! $this->use_pdo && function_exists( 'mysqli_set_charset' ) ) {
mysqli_set_charset( $this->db, $charset );
} else {
$this->db_query( 'SET NAMES ' . $charset );
}
}
}
public function db_close() {
if ( $this->use_pdo ) {
unset( $this->db );
} else {
mysqli_close( $this->db );
}
}
public function db_valid() {
return (bool) $this->db;
}
/**
* Walk an array replacing one element for another. ( NOT USED ANY MORE )
*
* @param string $find The string we want to replace.
* @param string $replace What we'll be replacing it with.
* @param array $data Used to pass any subordinate arrays back to the
* function for searching.
*
* @return array The original array with the replacements made.
*/
public function recursive_array_replace( $find, $replace, $data ) {
if ( is_array( $data ) ) {
foreach ( $data as $key => $value ) {
if ( is_array( $value ) ) {
$this->recursive_array_replace( $find, $replace, $data[ $key ] );
} else {
// have to check if it's string to ensure no switching to string for booleans/numbers/nulls - don't need any nasty conversions
if ( is_string( $value ) ) {
$data[ $key ] = $this->str_replace( $find, $replace, $value );
}
}
}
} else {
if ( is_string( $data ) ) {
$data = $this->str_replace( $find, $replace, $data );
}
}
}
/**
* Take a serialised array and unserialise it replacing elements as needed and
* unserialising any subordinate arrays and performing the replace on those too.
*
* @param string $from String we're looking to replace.
* @param string $to What we want it to be replaced with
* @param array $data Used to pass any subordinate arrays back to in.
* @param bool $serialised Does the array passed via $data need serialising.
*
* @return array The original array with all elements replaced as needed.
*/
public function recursive_unserialize_replace( $from = '', $to = '', $data = '', $serialised = false ) {
// some unserialised data cannot be re-serialised eg. SimpleXMLElements
try {
if ( is_string( $data ) && ( $unserialized = @unserialize( $data ) ) !== false ) {
$data = $this->recursive_unserialize_replace( $from, $to, $unserialized, true );
} elseif ( is_array( $data ) ) {
$_tmp = array();
foreach ( $data as $key => $value ) {
$_tmp[ $key ] = $this->recursive_unserialize_replace( $from, $to, $value, false );
}
$data = $_tmp;
unset( $_tmp );
} elseif ( is_object( $data ) && ! is_a( $data, '__PHP_Incomplete_Class' ) ) {
$_tmp = $data;
$props = get_object_vars( $data );
foreach ( $props as $key => $value ) {
$_tmp->$key = $this->recursive_unserialize_replace( $from, $to, $value, false );
}
$data = $_tmp;
unset( $_tmp );
} else {
if ( is_string( $data ) ) {
$data = $this->str_replace( $from, $to, $data );
}
}
if ( $serialised ) {
return serialize( $data );
}
} catch ( Exception $error ) {
$this->add_error( $error->getMessage() . ':: This is usually caused by a plugin storing classes as a
serialised string which other PHP classes can\'t then access. It is not possible to unserialise this data
because the PHP can\'t access this class. P.S. It\'s most commonly a Yoast plugin that causes this error.',
'results' );
}
return $data;
}
/**
* Regular expression callback to fix serialised string lengths
*
* @param array $matches matches from the regular expression
*
* @return string
*/
public function preg_fix_serialised_count( $matches ) {
$length = mb_strlen( $matches[2] );
if ( $length !== intval( $matches[1] ) ) {
return "s:{$length}:\"{$matches[2]}\";";
}
return $matches[0];
}
/**
* The main loop triggered in step 5. Up here to keep it out of the way of the
* HTML. This walks every table in the db that was selected in step 3 and then
* walks every row and column replacing all occurences of a string with another.
* We split large tables into 50,000 row blocks when dealing with them to save
* on memmory consumption.
*
* @param string $search What we want to replace
* @param string $replace What we want to replace it with.
* @param array $tables The tables we want to look at.
*
* @return array|bool Collection of information gathered during the run.
*/
public function replacer( $search = '', $replace = '', $tables = array(), $exclude_tables = array() ) {
$search = (string) $search;
// check we have a search string, bail if not
if ( '' === $search ) {
$this->add_error( 'Search string is empty', 'search' );
return false;
}
$report = array(
'tables' => 0,
'rows' => 0,
'change' => 0,
'updates' => 0,
'start' => microtime( true ),
'end' => microtime( true ),
'errors' => array(),
'table_reports' => array()
);
$table_report = array(
'rows' => 0,
'change' => 0,
'changes' => array(),
'updates' => 0,
'start' => microtime( true ),
'end' => microtime( true ),
'errors' => array(),
);
$dry_run = $this->get( 'dry_run' );
$errors = $this->get( 'errors' );
if ( $this->get( 'dry_run' ) and ! ( in_array( 'The dry-run option was selected. No replacements will be made.',
$errors['results'] ) ) ) // Report this as a search-only run.
{
$this->add_error( 'The dry-run option was selected. No replacements will be made.', 'results' );
}
// if no tables selected assume all
if ( empty( $tables ) ) {
$all_tables = $this->get_tables();
$tables = array_keys( $all_tables );
}
if ( is_array( $tables ) && ! empty( $tables ) ) {
foreach ( $tables as $table ) {
if ( in_array( $table, $exclude_tables ) ) {
$this->add_error( 'Ignoring Table: ' . $table );
continue;
}
$encoding = $this->get_table_character_set( $table );
switch ( $encoding ) {
// Tables encoded with this work for me only when I set names to utf8. I don't trust this in the wild so I'm going to avoid.
case 'utf16':
case 'utf32':
//$encoding = 'utf8';
$this->add_error( "The table \"{$table}\" is encoded using \"{$encoding}\" which is currently unsupported.",
'results' );
continue 2;
break;
default:
$this->db_set_charset( $encoding );
break;
}
$report['tables'] ++;
// get primary key and columns
list( $primary_key, $columns ) = $this->get_columns( $table );
if ( $primary_key === null || empty( $primary_key ) ) {
$this->add_error( "The table \"{$table}\" has no primary key. Changes will have to be made manually.",
'results' );
continue;
}
// create new table report instance
$new_table_report = $table_report;
$new_table_report['start'] = microtime( true );
$this->log( 'search_replace_table_start', $table, $search, $replace );
// Count the number of rows we have in the table if large we'll split into blocks, This is a mod from Simon Wheatley
$row_count = $this->db_query( "SELECT COUNT(*) FROM `{$table}`" );
$rows_result = $this->db_fetch( $row_count );
$row_count = $rows_result[0];
$page_size = $this->page_size;
$pages = ceil( $row_count / $page_size );
for ( $page = 0; $page < $pages; $page ++ ) {
$start = $page * $page_size;
// Grab the content of the table
$data = $this->db_query( sprintf( 'SELECT * FROM `%s` LIMIT %d, %d', $table, $start, $page_size ) );