Edit File by line

<?php if ( ! defined( 'ABSPATH' ) ) exit;

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Class NF_Abstracts_RequiredUpdate

[3] Fix | Delete

[4] Fix | Delete

abstract class NF_Abstracts_RequiredUpdate

[5] Fix | Delete

{

[6] Fix | Delete

[7] Fix | Delete

protected $_slug = '';

[8] Fix | Delete

[9] Fix | Delete

protected $_requires = array();

[10] Fix | Delete

[11] Fix | Delete

protected $_class_name = '';

[12] Fix | Delete

[13] Fix | Delete

protected $db;

[14] Fix | Delete

[15] Fix | Delete

public $response = array();

[16] Fix | Delete

[17] Fix | Delete

public $debug = false;

[18] Fix | Delete

[19] Fix | Delete

public $lock_process = false;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Constructor

[23] Fix | Delete

[24] Fix | Delete

* @since 3.4.0

[25] Fix | Delete

[26] Fix | Delete

public function __construct( $data = array() )

[27] Fix | Delete

{

[28] Fix | Delete

// Save a reference to wpdb.

[29] Fix | Delete

global $wpdb;

[30] Fix | Delete

$this->db = $wpdb;

[31] Fix | Delete

//Bail if we aren't in the admin.

[32] Fix | Delete

if ( ! is_admin() ) return false;

[33] Fix | Delete

// If we weren't provided with a slug or a class name...

[34] Fix | Delete

if ( ! isset( $data[ 'slug' ] ) || ! isset( $data[ 'class_name' ] ) ) {

[35] Fix | Delete

// Bail.

[36] Fix | Delete

return false;

[37] Fix | Delete

}

[38] Fix | Delete

$this->_slug = $data[ 'slug' ];

[39] Fix | Delete

$this->_class_name = $data[ 'class_name' ];

[40] Fix | Delete

// Record debug settings if provided.

[41] Fix | Delete

if ( isset( $data[ 'debug' ] ) ) $this->debug = $data[ 'debug' ];

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Function to loop over the batch.

[47] Fix | Delete

[48] Fix | Delete

* @since 3.4.0

[49] Fix | Delete

[50] Fix | Delete

public function process()

[51] Fix | Delete

{

[52] Fix | Delete

/**

[53] Fix | Delete

* This function intentionlly left empty.

[54] Fix | Delete

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Function to run any setup steps necessary to begin processing.

[60] Fix | Delete

[61] Fix | Delete

* @since 3.4.0

[62] Fix | Delete

[63] Fix | Delete

public function startup()

[64] Fix | Delete

{

[65] Fix | Delete

/**

[66] Fix | Delete

* This function intentionally left empty.

[67] Fix | Delete

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Function to cleanup any lingering temporary elements of required updates after completion.

[73] Fix | Delete

[74] Fix | Delete

* @since 3.4.0

[75] Fix | Delete

[76] Fix | Delete

public function cleanup()

[77] Fix | Delete

{

[78] Fix | Delete

// Delete our required updates data.

[79] Fix | Delete

delete_option( 'ninja_forms_doing_required_updates' );

[80] Fix | Delete

// Flag that updates are done.

[81] Fix | Delete

update_option( 'ninja_forms_needs_updates', 0 );

[82] Fix | Delete

// Set our new db version.

[83] Fix | Delete

update_option( 'ninja_forms_db_version', Ninja_Forms::DB_VERSION );

[84] Fix | Delete

// Fetch our list of completed updates.

[85] Fix | Delete

$updates = get_option( 'ninja_forms_required_updates', array() );

[86] Fix | Delete

// If we got something back...

[87] Fix | Delete

if ( ! empty( $updates ) ) {

[88] Fix | Delete

// Send out a call to telemetry.

[89] Fix | Delete

Ninja_Forms()->dispatcher()->send( 'required_updates_complete', $updates );

[90] Fix | Delete

}

[91] Fix | Delete

// Output that we're done.

[92] Fix | Delete

$this->response[ 'updatesRemaining' ] = 0;

[93] Fix | Delete

$this->respond();

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Function to dump our JSON response and kill processing.

[99] Fix | Delete

[100] Fix | Delete

* @since 3.4.0

[101] Fix | Delete

[102] Fix | Delete

public function respond()

[103] Fix | Delete

{

[104] Fix | Delete

// Dump the response.

[105] Fix | Delete

echo( json_encode( $this->response ) );

[106] Fix | Delete

// Terminate processing.

[107] Fix | Delete

die();

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Function to run our table migrations.

[113] Fix | Delete

[114] Fix | Delete

* @param $callback (String) The callback function in the migration file.

[115] Fix | Delete

[116] Fix | Delete

* @since 3.4.0

[117] Fix | Delete

[118] Fix | Delete

protected function migrate( $callback )

[119] Fix | Delete

{

[120] Fix | Delete

$migrations = new NF_Database_Migrations();

[121] Fix | Delete

$migrations->do_upgrade( $callback );

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Function to prepare our query values for insert.

[126] Fix | Delete

[127] Fix | Delete

* @param $value (Mixed) The value to be escaped for SQL.

[128] Fix | Delete

* @return (String) The escaped (and possibly serialized) value of the string.

[129] Fix | Delete

[130] Fix | Delete

* @since 3.4.0

[131] Fix | Delete

[132] Fix | Delete

public function prepare( $value )

[133] Fix | Delete

{

[134] Fix | Delete

// If our value is a number...

[135] Fix | Delete

if ( is_float( $value ) ) {

[136] Fix | Delete

// Exit early and return the value.

[137] Fix | Delete

return $value;

[138] Fix | Delete

}

[139] Fix | Delete

// Serialize the value if necessary.

[140] Fix | Delete

$escaped = maybe_serialize( $value );

[141] Fix | Delete

// Escape it.

[142] Fix | Delete

$escaped = $this->db->_real_escape( $escaped );

[143] Fix | Delete

[144] Fix | Delete

return $escaped;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* Function used to call queries that are gated by debug.

[149] Fix | Delete

[150] Fix | Delete

* @param $sql (String) The query to be run.

[151] Fix | Delete

* @return (Object) The response to the wpdb query call.

[152] Fix | Delete

[153] Fix | Delete

* @since 3.4.0

[154] Fix | Delete

[155] Fix | Delete

protected function query( $sql )

[156] Fix | Delete

{

[157] Fix | Delete

// If we're not debugging...

[158] Fix | Delete

if ( ! $this->debug ) {

[159] Fix | Delete

// Run the query.

[160] Fix | Delete

return $this->db->query( $sql );

[161] Fix | Delete

} // Otherwise...

[162] Fix | Delete

// Append the query to the response object.

[163] Fix | Delete

$this->response[ 'queries' ][] = $sql;

[164] Fix | Delete

// Return false.

[165] Fix | Delete

return false;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Function to record the completion of our update in the DB.

[170] Fix | Delete

[171] Fix | Delete

* @since 3.4.0

[172] Fix | Delete

[173] Fix | Delete

protected function confirm_complete()

[174] Fix | Delete

{

[175] Fix | Delete

// If we're not debugging...

[176] Fix | Delete

if ( ! $this->debug ) {

[177] Fix | Delete

// Fetch our required updates array.

[178] Fix | Delete

$updates = get_option( 'ninja_forms_required_updates', array() );

[179] Fix | Delete

// Get a timestamp.

[180] Fix | Delete

date_default_timezone_set( 'UTC' );

[181] Fix | Delete

$now = date( "Y-m-d H:i:s" );

[182] Fix | Delete

// Append the current update to the array.

[183] Fix | Delete

$updates[ $this->_slug ] = $now;

[184] Fix | Delete

// Save it.

[185] Fix | Delete

update_option( 'ninja_forms_required_updates', $updates );

[186] Fix | Delete

}

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Enable Maintenance mode

[191] Fix | Delete

* Enables maintenance mode so the form will not render on the front end while updates are running.

[192] Fix | Delete

[193] Fix | Delete

* @since 3.4.0

[194] Fix | Delete

[195] Fix | Delete

* @param $prefix - the db prefix.

[196] Fix | Delete

* @param $form_id - The id of the form.

[197] Fix | Delete

[198] Fix | Delete

public function enable_maintenance_mode( $prefix, $form_id )

[199] Fix | Delete

{

[200] Fix | Delete

// Change maintenance column value to 1, run the query and then return.

[201] Fix | Delete

$sql = $this->db->prepare( 'UPDATE `' . $prefix . 'nf3_upgrades` SET `maintenance` = 1 WHERE `id` = %d', $form_id );

[202] Fix | Delete

$this->db->query( $sql );

[203] Fix | Delete

return;

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

/**

[207] Fix | Delete

* Disable Maintenance Mode

[208] Fix | Delete

* Disables maintenance mode, so the form will be displayed on the front end..

[209] Fix | Delete

[210] Fix | Delete

* @since 3.4.0

[211] Fix | Delete

[212] Fix | Delete

* @param $prefix - the db prefix.

[213] Fix | Delete

* @param $form_id - The id of the form.

[214] Fix | Delete

[215] Fix | Delete

public function disable_maintenance_mode( $prefix, $form_id )

[216] Fix | Delete

{

[217] Fix | Delete

// Change maintenance column value to 0, run the query and then return.

[218] Fix | Delete

$sql = $this->db->prepare( 'UPDATE `' . $prefix . 'nf3_upgrades` SET `maintenance` = 0 WHERE `id` = %d', $form_id );

[219] Fix | Delete

$this->db->query( $sql );

[220] Fix | Delete

return;

[221] Fix | Delete

}

[222] Fix | Delete

}

[223] Fix | Delete