These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | /** |
||
3 | * Convert user options to the new `user_properties` table. |
||
4 | * |
||
5 | * This program is free software; you can redistribute it and/or modify |
||
6 | * it under the terms of the GNU General Public License as published by |
||
7 | * the Free Software Foundation; either version 2 of the License, or |
||
8 | * (at your option) any later version. |
||
9 | * |
||
10 | * This program is distributed in the hope that it will be useful, |
||
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
||
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||
13 | * GNU General Public License for more details. |
||
14 | * |
||
15 | * You should have received a copy of the GNU General Public License along |
||
16 | * with this program; if not, write to the Free Software Foundation, Inc., |
||
17 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
||
18 | * http://www.gnu.org/copyleft/gpl.html |
||
19 | * |
||
20 | * @file |
||
21 | * @ingroup Maintenance |
||
22 | */ |
||
23 | |||
24 | require_once __DIR__ . '/Maintenance.php'; |
||
25 | |||
26 | /** |
||
27 | * Maintenance script to convert user options to the new `user_properties` table. |
||
28 | * |
||
29 | * @ingroup Maintenance |
||
30 | */ |
||
31 | class ConvertUserOptions extends Maintenance { |
||
32 | |||
33 | private $mConversionCount = 0; |
||
34 | |||
35 | public function __construct() { |
||
36 | parent::__construct(); |
||
37 | $this->addDescription( 'Convert user options from old to new system' ); |
||
38 | $this->setBatchSize( 50 ); |
||
39 | } |
||
40 | |||
41 | public function execute() { |
||
42 | $this->output( "...batch conversion of user_options: " ); |
||
43 | $id = 0; |
||
44 | $dbw = $this->getDB( DB_MASTER ); |
||
45 | |||
46 | if ( !$dbw->fieldExists( 'user', 'user_options', __METHOD__ ) ) { |
||
47 | $this->output( "nothing to migrate. " ); |
||
48 | |||
49 | return; |
||
50 | } |
||
51 | while ( $id !== null ) { |
||
52 | $res = $dbw->select( 'user', |
||
53 | [ 'user_id', 'user_options' ], |
||
54 | [ |
||
55 | 'user_id > ' . $dbw->addQuotes( $id ), |
||
56 | "user_options != " . $dbw->addQuotes( '' ), |
||
57 | ], |
||
58 | __METHOD__, |
||
59 | [ |
||
60 | 'ORDER BY' => 'user_id', |
||
61 | 'LIMIT' => $this->mBatchSize, |
||
62 | ] |
||
63 | ); |
||
64 | $id = $this->convertOptionBatch( $res, $dbw ); |
||
65 | |||
66 | wfWaitForSlaves(); |
||
0 ignored issues
–
show
|
|||
67 | |||
68 | if ( $id ) { |
||
69 | $this->output( "--Converted to ID $id\n" ); |
||
70 | } |
||
71 | } |
||
72 | $this->output( "done. Converted " . $this->mConversionCount . " user records.\n" ); |
||
73 | } |
||
74 | |||
75 | /** |
||
76 | * @param ResultWrapper $res |
||
77 | * @param Database $dbw |
||
78 | * @return null|int |
||
79 | */ |
||
80 | function convertOptionBatch( $res, $dbw ) { |
||
81 | $id = null; |
||
82 | foreach ( $res as $row ) { |
||
83 | $this->mConversionCount++; |
||
84 | $insertRows = []; |
||
85 | foreach ( explode( "\n", $row->user_options ) as $s ) { |
||
86 | $m = []; |
||
87 | if ( !preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) { |
||
88 | continue; |
||
89 | } |
||
90 | |||
91 | // MW < 1.16 would save even default values. Filter them out |
||
92 | // here (as in User) to avoid adding many unnecessary rows. |
||
93 | $defaultOption = User::getDefaultOption( $m[1] ); |
||
94 | if ( is_null( $defaultOption ) || $m[2] != $defaultOption ) { |
||
95 | $insertRows[] = [ |
||
96 | 'up_user' => $row->user_id, |
||
97 | 'up_property' => $m[1], |
||
98 | 'up_value' => $m[2], |
||
99 | ]; |
||
100 | } |
||
101 | } |
||
102 | |||
103 | if ( count( $insertRows ) ) { |
||
104 | $dbw->insert( 'user_properties', $insertRows, __METHOD__, [ 'IGNORE' ] ); |
||
105 | } |
||
106 | |||
107 | $dbw->update( |
||
108 | 'user', |
||
109 | [ 'user_options' => '' ], |
||
110 | [ 'user_id' => $row->user_id ], |
||
111 | __METHOD__ |
||
112 | ); |
||
113 | $id = $row->user_id; |
||
114 | } |
||
115 | |||
116 | return $id; |
||
117 | } |
||
118 | } |
||
119 | |||
120 | $maintClass = "ConvertUserOptions"; |
||
121 | require_once RUN_MAINTENANCE_IF_MAIN; |
||
122 |
This function has been deprecated. The supplier of the file has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead.