wikimedia /
mediawiki
| Conditions | 24 |
| Paths | 497 |
| Total Lines | 128 |
| Code Lines | 75 |
| 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 |
||
| 53 | function wfImageAuthMain() { |
||
| 54 | global $wgImgAuthUrlPathMap; |
||
| 55 | |||
| 56 | $request = RequestContext::getMain()->getRequest(); |
||
| 57 | $publicWiki = in_array( 'read', User::getGroupPermissions( [ '*' ] ), true ); |
||
| 58 | |||
| 59 | // Get the requested file path (source file or thumbnail) |
||
| 60 | $matches = WebRequest::getPathInfo(); |
||
| 61 | if ( !isset( $matches['title'] ) ) { |
||
| 62 | wfForbidden( 'img-auth-accessdenied', 'img-auth-nopathinfo' ); |
||
| 63 | return; |
||
| 64 | } |
||
| 65 | $path = $matches['title']; |
||
| 66 | if ( $path && $path[0] !== '/' ) { |
||
| 67 | // Make sure $path has a leading / |
||
| 68 | $path = "/" . $path; |
||
| 69 | } |
||
| 70 | |||
| 71 | // Check for bug 28235: QUERY_STRING overriding the correct extension |
||
| 72 | $whitelist = []; |
||
| 73 | $extension = FileBackend::extensionFromPath( $path, 'rawcase' ); |
||
| 74 | if ( $extension != '' ) { |
||
| 75 | $whitelist[] = $extension; |
||
| 76 | } |
||
| 77 | if ( !$request->checkUrlExtension( $whitelist ) ) { |
||
| 78 | return; |
||
| 79 | } |
||
| 80 | |||
| 81 | // Various extensions may have their own backends that need access. |
||
| 82 | // Check if there is a special backend and storage base path for this file. |
||
| 83 | foreach ( $wgImgAuthUrlPathMap as $prefix => $storageDir ) { |
||
| 84 | $prefix = rtrim( $prefix, '/' ) . '/'; // implicit trailing slash |
||
| 85 | if ( strpos( $path, $prefix ) === 0 ) { |
||
| 86 | $be = FileBackendGroup::singleton()->backendFromPath( $storageDir ); |
||
| 87 | $filename = $storageDir . substr( $path, strlen( $prefix ) ); // strip prefix |
||
| 88 | // Check basic user authorization |
||
| 89 | if ( !RequestContext::getMain()->getUser()->isAllowed( 'read' ) ) { |
||
| 90 | wfForbidden( 'img-auth-accessdenied', 'img-auth-noread', $path ); |
||
| 91 | return; |
||
| 92 | } |
||
| 93 | if ( $be->fileExists( [ 'src' => $filename ] ) ) { |
||
| 94 | wfDebugLog( 'img_auth', "Streaming `" . $filename . "`." ); |
||
| 95 | $be->streamFile( [ 'src' => $filename ], |
||
| 96 | [ 'Cache-Control: private', 'Vary: Cookie' ] ); |
||
| 97 | } else { |
||
| 98 | wfForbidden( 'img-auth-accessdenied', 'img-auth-nofile', $path ); |
||
| 99 | } |
||
| 100 | return; |
||
| 101 | } |
||
| 102 | } |
||
| 103 | |||
| 104 | // Get the local file repository |
||
| 105 | $repo = RepoGroup::singleton()->getRepo( 'local' ); |
||
| 106 | $zone = strstr( ltrim( $path, '/' ), '/', true ); |
||
| 107 | |||
| 108 | // Get the full file storage path and extract the source file name. |
||
| 109 | // (e.g. 120px-Foo.png => Foo.png or page2-120px-Foo.png => Foo.png). |
||
| 110 | // This only applies to thumbnails/transcoded, and each of them should |
||
| 111 | // be under a folder that has the source file name. |
||
| 112 | if ( $zone === 'thumb' || $zone === 'transcoded' ) { |
||
| 113 | $name = wfBaseName( dirname( $path ) ); |
||
| 114 | $filename = $repo->getZonePath( $zone ) . substr( $path, strlen( "/" . $zone ) ); |
||
| 115 | // Check to see if the file exists |
||
| 116 | if ( !$repo->fileExists( $filename ) ) { |
||
| 117 | wfForbidden( 'img-auth-accessdenied', 'img-auth-nofile', $filename ); |
||
| 118 | return; |
||
| 119 | } |
||
| 120 | } else { |
||
| 121 | $name = wfBaseName( $path ); // file is a source file |
||
| 122 | $filename = $repo->getZonePath( 'public' ) . $path; |
||
| 123 | // Check to see if the file exists and is not deleted |
||
| 124 | $bits = explode( '!', $name, 2 ); |
||
| 125 | if ( substr( $path, 0, 9 ) === '/archive/' && count( $bits ) == 2 ) { |
||
| 126 | $file = $repo->newFromArchiveName( $bits[1], $name ); |
||
| 127 | } else { |
||
| 128 | $file = $repo->newFile( $name ); |
||
| 129 | } |
||
| 130 | if ( !$file->exists() || $file->isDeleted( File::DELETED_FILE ) ) { |
||
| 131 | wfForbidden( 'img-auth-accessdenied', 'img-auth-nofile', $filename ); |
||
| 132 | return; |
||
| 133 | } |
||
| 134 | } |
||
| 135 | |||
| 136 | $headers = []; // extra HTTP headers to send |
||
| 137 | |||
| 138 | if ( !$publicWiki ) { |
||
| 139 | // For private wikis, run extra auth checks and set cache control headers |
||
| 140 | $headers[] = 'Cache-Control: private'; |
||
| 141 | $headers[] = 'Vary: Cookie'; |
||
| 142 | |||
| 143 | $title = Title::makeTitleSafe( NS_FILE, $name ); |
||
| 144 | if ( !$title instanceof Title ) { // files have valid titles |
||
| 145 | wfForbidden( 'img-auth-accessdenied', 'img-auth-badtitle', $name ); |
||
| 146 | return; |
||
| 147 | } |
||
| 148 | |||
| 149 | // Run hook for extension authorization plugins |
||
| 150 | /** @var $result array */ |
||
| 151 | $result = null; |
||
| 152 | if ( !Hooks::run( 'ImgAuthBeforeStream', [ &$title, &$path, &$name, &$result ] ) ) { |
||
| 153 | wfForbidden( $result[0], $result[1], array_slice( $result, 2 ) ); |
||
| 154 | return; |
||
| 155 | } |
||
| 156 | |||
| 157 | // Check user authorization for this title |
||
| 158 | // Checks Whitelist too |
||
| 159 | if ( !$title->userCan( 'read' ) ) { |
||
| 160 | wfForbidden( 'img-auth-accessdenied', 'img-auth-noread', $name ); |
||
| 161 | return; |
||
| 162 | } |
||
| 163 | } |
||
| 164 | |||
| 165 | $options = []; // HTTP header options |
||
| 166 | if ( isset( $_SERVER['HTTP_RANGE'] ) ) { |
||
| 167 | $options['range'] = $_SERVER['HTTP_RANGE']; |
||
| 168 | } |
||
| 169 | if ( isset( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) { |
||
| 170 | $options['if-modified-since'] = $_SERVER['HTTP_IF_MODIFIED_SINCE']; |
||
| 171 | } |
||
| 172 | |||
| 173 | if ( $request->getCheck( 'download' ) ) { |
||
| 174 | $headers[] = 'Content-Disposition: attachment'; |
||
| 175 | } |
||
| 176 | |||
| 177 | // Stream the requested file |
||
| 178 | wfDebugLog( 'img_auth', "Streaming `" . $filename . "`." ); |
||
| 179 | $repo->streamFile( $filename, $headers, $options ); |
||
| 180 | } |
||
| 181 | |||
| 223 |
Loading history...
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.