mirror of
https://github.com/WordPress/WordPress-Coding-Standards.git
synced 2026-07-31 13:01:24 +08:00
83 lines
2.5 KiB
PHP
83 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* Disallow Filesystem writes
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* @category PHP
|
|
* @package PHP_CodeSniffer
|
|
* @author Shady Sharaf <shady@x-team.com>
|
|
* @link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/69
|
|
*/
|
|
class WordPress_Sniffs_VIP_FileSystemWritesDisallowSniff extends Generic_Sniffs_PHP_ForbiddenFunctionsSniff
|
|
{
|
|
|
|
/**
|
|
* A list of forbidden functions with their alternatives.
|
|
*
|
|
* The value is NULL if no alternative exists. IE, the
|
|
* function should just not be used.
|
|
*
|
|
* @var array(string => string|null)
|
|
*/
|
|
protected $forbiddenFunctions = array(
|
|
'file_put_contents' => null,
|
|
'fwrite' => null,
|
|
'fputcsv' => null,
|
|
'fputs' => null,
|
|
'ftruncate' => null,
|
|
'link' => null,
|
|
'symlink' => null,
|
|
'mkdir' => null,
|
|
'rename' => null,
|
|
'rmdir' => null,
|
|
'tempnam' => null,
|
|
'touch' => null,
|
|
'unlink' => null,
|
|
'is_writable' => null,
|
|
'is_writeable' => null,
|
|
'lchgrp' => null,
|
|
'lchown' => null,
|
|
'fputcsv' => null,
|
|
'delete' => null,
|
|
'chmod' => null,
|
|
'chown' => null,
|
|
'chgrp' => null,
|
|
'chmod' => null,
|
|
'chmod' => null,
|
|
'flock' => null,
|
|
);
|
|
|
|
/**
|
|
* If true, an error will be thrown; otherwise a warning.
|
|
*
|
|
* @var bool
|
|
*/
|
|
public $error = true;
|
|
|
|
/**
|
|
* Generates the error or warning for this sniff.
|
|
*
|
|
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
|
|
* @param int $stackPtr The position of the forbidden function
|
|
* in the token array.
|
|
* @param string $function The name of the forbidden function.
|
|
* @param string $pattern The pattern used for the match.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function addError( $phpcsFile, $stackPtr, $function, $pattern = null )
|
|
{
|
|
$data = array($function);
|
|
$error = 'Filesystem writes are forbidden, you should not be using %s()';
|
|
|
|
if ( $this->error === true ) {
|
|
$phpcsFile->addError( $error, $stackPtr, '', $data );
|
|
} else {
|
|
$phpcsFile->addWarning( $error, $stackPtr, '', $data );
|
|
}
|
|
|
|
}//end addError()
|
|
|
|
|
|
}//end class
|
