Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace StringLocator\Tests;

[2] Fix | Delete

[3] Fix | Delete

class Smart_Scan {

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* The content that will be scanned.

[7] Fix | Delete

[8] Fix | Delete

* @var string

[9] Fix | Delete

[10] Fix | Delete

private $content = '';

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* An array holding any errors returned during testing.

[14] Fix | Delete

[15] Fix | Delete

* @var array

[16] Fix | Delete

[17] Fix | Delete

public $errors = array();

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* SmartScan constructor.

[21] Fix | Delete

[22] Fix | Delete

public function __construct() {

[23] Fix | Delete

add_action( 'string_locator_editor_checks', array( $this, 'print_checks_option' ) );

[24] Fix | Delete

[25] Fix | Delete

add_filter( 'string_locator_pre_save', array( $this, 'maybe_perform_test' ), 10, 2 );

[26] Fix | Delete

add_filter( 'string_locator_pre_save_fail_notice', array( $this, 'return_failure_notices' ) );

[27] Fix | Delete

}

[28] Fix | Delete

[29] Fix | Delete

public function return_failure_notices( $notices ) {

[30] Fix | Delete

if ( empty( $this->errors ) ) {

[31] Fix | Delete

return $notices;

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

return array_merge(

[35] Fix | Delete

$notices,

[36] Fix | Delete

$this->errors

[37] Fix | Delete

);

[38] Fix | Delete

}

[39] Fix | Delete

[40] Fix | Delete

public function maybe_perform_test( $can_save, $content ) {

[41] Fix | Delete

// If another addon has determined the file can not be saved, bail early.

[42] Fix | Delete

if ( ! $can_save ) {

[43] Fix | Delete

return $can_save;

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

// Do not perform a smart scan if the option for it is disabled.

[47] Fix | Delete

if ( ! isset( $_POST['string-locator-smart-edit'] ) ) {

[48] Fix | Delete

return $can_save;

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

return $this->run( $content );

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

public function print_checks_option() {

[55] Fix | Delete

[56] Fix | Delete

[57] Fix | Delete

[58] Fix | Delete

<label>

[59] Fix | Delete

[60] Fix | Delete

<?php esc_html_e( 'Enable a smart-scan of your code to help detect bracket mismatches before saving.', 'string-locator' ); ?>

[61] Fix | Delete

</label>

[62] Fix | Delete

</div>

[63] Fix | Delete

[64] Fix | Delete

<?php

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* A helper function to return any errors.

[69] Fix | Delete

[70] Fix | Delete

* @return array

[71] Fix | Delete

[72] Fix | Delete

public function get_errors() {

[73] Fix | Delete

return $this->errors;

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Main test runner.

[78] Fix | Delete

[79] Fix | Delete

* @param string $content The content to scan.

[80] Fix | Delete

[81] Fix | Delete

* @return bool

[82] Fix | Delete

[83] Fix | Delete

public function run( $content ) {

[84] Fix | Delete

$this->content = $content;

[85] Fix | Delete

[86] Fix | Delete

// Reset the stored errors for a fresh run.

[87] Fix | Delete

$this->errors = array();

[88] Fix | Delete

[89] Fix | Delete

$this->check_braces();

[90] Fix | Delete

$this->check_brackets();

[91] Fix | Delete

$this->check_parenthesis();

[92] Fix | Delete

[93] Fix | Delete

if ( ! empty( $this->errors ) ) {

[94] Fix | Delete

return false;

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

return true;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

private function check_braces() {

[101] Fix | Delete

$open_brace = substr_count( $this->content, '{' );

[102] Fix | Delete

$close_brace = substr_count( $this->content, '}' );

[103] Fix | Delete

[104] Fix | Delete

if ( $open_brace !== $close_brace ) {

[105] Fix | Delete

$opened = $this->compare( '{', '}' );

[106] Fix | Delete

[107] Fix | Delete

foreach ( $opened as $line ) {

[108] Fix | Delete

$this->errors[] = array(

[109] Fix | Delete

'type' => 'error',

[110] Fix | Delete

'message' => sprintf(

[111] Fix | Delete

// translators: 1: Line number with an error.

[112] Fix | Delete

__( 'There is an inconsistency in the opening and closing braces, { and }, of your file on line %s', 'string-locator' ),

[113] Fix | Delete

'<a href="#" class="string-locator-edit-goto" data-goto-line="' . ( $line + 1 ) . '">' . ( $line + 1 ) . '</a>'

[114] Fix | Delete

[115] Fix | Delete

);

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

return false;

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

return true;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

private function check_brackets() {

[125] Fix | Delete

$open_bracket = substr_count( $this->content, '[' );

[126] Fix | Delete

$close_bracket = substr_count( $this->content, ']' );

[127] Fix | Delete

[128] Fix | Delete

if ( $open_bracket !== $close_bracket ) {

[129] Fix | Delete

$opened = $this->compare( '[', ']' );

[130] Fix | Delete

[131] Fix | Delete

foreach ( $opened as $line ) {

[132] Fix | Delete

$this->errors[] = array(

[133] Fix | Delete

'type' => 'error',

[134] Fix | Delete

'message' => sprintf(

[135] Fix | Delete

// translators: 1: Line number with an error.

[136] Fix | Delete

__( 'There is an inconsistency in the opening and closing braces, [ and ], of your file on line %s', 'string-locator' ),

[137] Fix | Delete

'<a href="#" class="string-locator-edit-goto" data-goto-line="' . ( $line + 1 ) . '">' . ( $line + 1 ) . '</a>'

[138] Fix | Delete

[139] Fix | Delete

);

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

return false;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

return true;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

private function check_parenthesis() {

[149] Fix | Delete

$open_parenthesis = substr_count( $this->content, '(' );

[150] Fix | Delete

$close_parenthesis = substr_count( $this->content, ')' );

[151] Fix | Delete

[152] Fix | Delete

if ( $open_parenthesis !== $close_parenthesis ) {

[153] Fix | Delete

$this->failed_edit = true;

[154] Fix | Delete

[155] Fix | Delete

$opened = $this->compare( '(', ')' );

[156] Fix | Delete

[157] Fix | Delete

foreach ( $opened as $line ) {

[158] Fix | Delete

$this->errors[] = array(

[159] Fix | Delete

'type' => 'error',

[160] Fix | Delete

'message' => sprintf(

[161] Fix | Delete

// translators: 1: Line number with an error.

[162] Fix | Delete

__( 'There is an inconsistency in the opening and closing braces, ( and ), of your file on line %s', 'string-locator' ),

[163] Fix | Delete

'<a href="#" class="string-locator-edit-goto" data-goto-line="' . ( $line + 1 ) . '">' . ( $line + 1 ) . '</a>'

[164] Fix | Delete

[165] Fix | Delete

);

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

return false;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

return true;

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

/**

[175] Fix | Delete

* Check for inconsistencies in brackets and similar.

[176] Fix | Delete

[177] Fix | Delete

* @param string $start Start delimited.

[178] Fix | Delete

* @param string $end End delimiter.

[179] Fix | Delete

[180] Fix | Delete

* @return array

[181] Fix | Delete

[182] Fix | Delete

function compare( $start, $end ) {

[183] Fix | Delete

$opened = array();

[184] Fix | Delete

[185] Fix | Delete

$lines = explode( "\n", $this->content );

[186] Fix | Delete

for ( $i = 0; $i < count( $lines ); $i ++ ) {

[187] Fix | Delete

if ( stristr( $lines[ $i ], $start ) ) {

[188] Fix | Delete

$opened[] = $i;

[189] Fix | Delete

}

[190] Fix | Delete

if ( stristr( $lines[ $i ], $end ) ) {

[191] Fix | Delete

array_pop( $opened );

[192] Fix | Delete

}

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

return $opened;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

new Smart_Scan();

[201] Fix | Delete

[202] Fix | Delete