Conditions | 21 |
Paths | 2410 |
Total Lines | 118 |
Code Lines | 82 |
Lines | 0 |
Ratio | 0 % |
Changes | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
63 | public function doDBUpdates() { |
||
64 | $method = $this->getOption( 'method', 'normal' ); |
||
65 | $file = $this->getOption( 'file', '' ); |
||
66 | $force = $this->getOption( 'force' ); |
||
67 | $isRegen = ( $force || $file != '' ); // forced recalculation? |
||
68 | |||
69 | $t = -microtime( true ); |
||
70 | $dbw = $this->getDB( DB_MASTER ); |
||
71 | if ( $file != '' ) { |
||
72 | $res = $dbw->select( |
||
73 | 'image', |
||
74 | [ 'img_name' ], |
||
75 | [ 'img_name' => $file ], |
||
76 | __METHOD__ |
||
77 | ); |
||
78 | if ( !$res ) { |
||
79 | $this->error( "No such file: $file", true ); |
||
80 | |||
81 | return false; |
||
82 | } |
||
83 | $this->output( "Populating img_sha1 field for specified files\n" ); |
||
84 | } else { |
||
85 | if ( $this->hasOption( 'multiversiononly' ) ) { |
||
86 | $conds = []; |
||
87 | $this->output( "Populating and recalculating img_sha1 field for versioned files\n" ); |
||
88 | } elseif ( $force ) { |
||
89 | $conds = []; |
||
90 | $this->output( "Populating and recalculating img_sha1 field\n" ); |
||
91 | } else { |
||
92 | $conds = [ 'img_sha1' => '' ]; |
||
93 | $this->output( "Populating img_sha1 field\n" ); |
||
94 | } |
||
95 | if ( $this->hasOption( 'multiversiononly' ) ) { |
||
96 | $res = $dbw->select( 'oldimage', |
||
97 | [ 'img_name' => 'DISTINCT(oi_name)' ], $conds, __METHOD__ ); |
||
98 | } else { |
||
99 | $res = $dbw->select( 'image', [ 'img_name' ], $conds, __METHOD__ ); |
||
100 | } |
||
101 | } |
||
102 | |||
103 | $imageTable = $dbw->tableName( 'image' ); |
||
104 | $oldImageTable = $dbw->tableName( 'oldimage' ); |
||
105 | |||
106 | if ( $method == 'pipe' ) { |
||
107 | // Opening a pipe allows the SHA-1 operation to be done in parallel |
||
108 | // with the database write operation, because the writes are queued |
||
109 | // in the pipe buffer. This can improve performance by up to a |
||
110 | // factor of 2. |
||
111 | global $wgDBuser, $wgDBserver, $wgDBpassword, $wgDBname; |
||
112 | $cmd = 'mysql -u' . wfEscapeShellArg( $wgDBuser ) . |
||
113 | ' -h' . wfEscapeShellArg( $wgDBserver ) . |
||
114 | ' -p' . wfEscapeShellArg( $wgDBpassword, $wgDBname ); |
||
115 | $this->output( "Using pipe method\n" ); |
||
116 | $pipe = popen( $cmd, 'w' ); |
||
117 | } |
||
118 | |||
119 | $numRows = $res->numRows(); |
||
120 | $i = 0; |
||
121 | foreach ( $res as $row ) { |
||
122 | if ( $i % $this->mBatchSize == 0 ) { |
||
123 | $this->output( sprintf( |
||
124 | "Done %d of %d, %5.3f%% \r", $i, $numRows, $i / $numRows * 100 ) ); |
||
125 | wfWaitForSlaves(); |
||
126 | } |
||
127 | |||
128 | $file = wfLocalFile( $row->img_name ); |
||
129 | if ( !$file ) { |
||
130 | continue; |
||
131 | } |
||
132 | |||
133 | // Upgrade the current file version... |
||
134 | $sha1 = $file->getRepo()->getFileSha1( $file->getPath() ); |
||
135 | if ( strval( $sha1 ) !== '' ) { // file on disk and hashed properly |
||
136 | if ( $isRegen && $file->getSha1() !== $sha1 ) { |
||
137 | // The population was probably done already. If the old SHA1 |
||
138 | // does not match, then both fix the SHA1 and the metadata. |
||
139 | $file->upgradeRow(); |
||
140 | } else { |
||
141 | $sql = "UPDATE $imageTable SET img_sha1=" . $dbw->addQuotes( $sha1 ) . |
||
142 | " WHERE img_name=" . $dbw->addQuotes( $file->getName() ); |
||
143 | if ( $method == 'pipe' ) { |
||
144 | fwrite( $pipe, "$sql;\n" ); |
||
145 | } else { |
||
146 | $dbw->query( $sql, __METHOD__ ); |
||
147 | } |
||
148 | } |
||
149 | } |
||
150 | // Upgrade the old file versions... |
||
151 | foreach ( $file->getHistory() as $oldFile ) { |
||
152 | $sha1 = $oldFile->getRepo()->getFileSha1( $oldFile->getPath() ); |
||
153 | if ( strval( $sha1 ) !== '' ) { // file on disk and hashed properly |
||
154 | if ( $isRegen && $oldFile->getSha1() !== $sha1 ) { |
||
155 | // The population was probably done already. If the old SHA1 |
||
156 | // does not match, then both fix the SHA1 and the metadata. |
||
157 | $oldFile->upgradeRow(); |
||
158 | } else { |
||
159 | $sql = "UPDATE $oldImageTable SET oi_sha1=" . $dbw->addQuotes( $sha1 ) . |
||
160 | " WHERE (oi_name=" . $dbw->addQuotes( $oldFile->getName() ) . " AND" . |
||
161 | " oi_archive_name=" . $dbw->addQuotes( $oldFile->getArchiveName() ) . ")"; |
||
162 | if ( $method == 'pipe' ) { |
||
163 | fwrite( $pipe, "$sql;\n" ); |
||
164 | } else { |
||
165 | $dbw->query( $sql, __METHOD__ ); |
||
166 | } |
||
167 | } |
||
168 | } |
||
169 | } |
||
170 | $i++; |
||
171 | } |
||
172 | if ( $method == 'pipe' ) { |
||
173 | fflush( $pipe ); |
||
174 | pclose( $pipe ); |
||
175 | } |
||
176 | $t += microtime( true ); |
||
177 | $this->output( sprintf( "\nDone %d files in %.1f seconds\n", $numRows, $t ) ); |
||
178 | |||
179 | return !$file; // we only updated *some* files, don't log |
||
180 | } |
||
181 | } |
||
185 |
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.