Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin;

[2] Fix | Delete

[3] Fix | Delete

use WP_Post;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Form Revisions.

[7] Fix | Delete

[8] Fix | Delete

* @since 1.7.3

[9] Fix | Delete

[10] Fix | Delete

class Revisions {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Current Form Builder panel view.

[14] Fix | Delete

[15] Fix | Delete

* @since 1.7.3

[16] Fix | Delete

[17] Fix | Delete

* @var string

[18] Fix | Delete

[19] Fix | Delete

private $view = 'revisions';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Current Form ID.

[23] Fix | Delete

[24] Fix | Delete

* @since 1.7.3

[25] Fix | Delete

[26] Fix | Delete

* @var int|false

[27] Fix | Delete

[28] Fix | Delete

private $form_id = false;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Current Form.

[32] Fix | Delete

[33] Fix | Delete

* @since 1.7.3

[34] Fix | Delete

[35] Fix | Delete

* @var WP_Post|null

[36] Fix | Delete

[37] Fix | Delete

private $form;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Current Form Revision ID.

[41] Fix | Delete

[42] Fix | Delete

* @since 1.7.3

[43] Fix | Delete

[44] Fix | Delete

* @var int|false

[45] Fix | Delete

[46] Fix | Delete

private $revision_id = false;

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Current Form Revision.

[50] Fix | Delete

[51] Fix | Delete

* @since 1.7.3

[52] Fix | Delete

[53] Fix | Delete

* @var WP_Post|null

[54] Fix | Delete

[55] Fix | Delete

private $revision;

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Whether revisions panel was already viewed by the user at least once.

[59] Fix | Delete

[60] Fix | Delete

* @since 1.7.3

[61] Fix | Delete

[62] Fix | Delete

* @var bool

[63] Fix | Delete

[64] Fix | Delete

private $viewed;

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Initialize the class if preconditions are met.

[68] Fix | Delete

[69] Fix | Delete

* @since 1.7.3

[70] Fix | Delete

[71] Fix | Delete

* @return void

[72] Fix | Delete

[73] Fix | Delete

public function init() {

[74] Fix | Delete

[75] Fix | Delete

if ( ! $this->allow_load() ) {

[76] Fix | Delete

return;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

// phpcs:disable WordPress.Security.NonceVerification.Recommended

[80] Fix | Delete

[81] Fix | Delete

if ( isset( $_REQUEST['view'] ) ) {

[82] Fix | Delete

$this->view = sanitize_key( $_REQUEST['view'] );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

if ( isset( $_REQUEST['revision_id'] ) ) {

[86] Fix | Delete

$this->revision_id = absint( $_REQUEST['revision_id'] );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

// phpcs:enable WordPress.Security.NonceVerification.Recommended

[90] Fix | Delete

[91] Fix | Delete

// Fetch revision, if needed.

[92] Fix | Delete

if ( $this->revision_id && wp_revisions_enabled( $this->form ) ) {

[93] Fix | Delete

$this->revision = wp_get_post_revision( $this->revision_id );

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

// Bail if we don't have a valid revision.

[97] Fix | Delete

if ( $this->revision_id && ! $this->revision instanceof WP_Post ) {

[98] Fix | Delete

return;

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

$this->hooks();

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/**

[105] Fix | Delete

* Whether it is allowed to load under certain conditions.

[106] Fix | Delete

[107] Fix | Delete

* - numeric, non-zero form ID provided,

[108] Fix | Delete

* - the form with this ID exists and was successfully fetched,

[109] Fix | Delete

* - we're in the Form Builder or processing an ajax request.

[110] Fix | Delete

[111] Fix | Delete

* @since 1.7.3

[112] Fix | Delete

[113] Fix | Delete

* @return bool

[114] Fix | Delete

[115] Fix | Delete

private function allow_load() {

[116] Fix | Delete

[117] Fix | Delete

if ( ! ( wpforms_is_admin_page( 'builder' ) || wp_doing_ajax() ) ) {

[118] Fix | Delete

return false;

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

// phpcs:disable WordPress.Security.NonceVerification.Recommended

[122] Fix | Delete

$id = wp_doing_ajax() && isset( $_REQUEST['id'] ) ? absint( $_REQUEST['id'] ) : false;

[123] Fix | Delete

$id = isset( $_REQUEST['form_id'] ) && ! is_array( $_REQUEST['form_id'] ) ? absint( $_REQUEST['form_id'] ) : $id;

[124] Fix | Delete

// phpcs:enable WordPress.Security.NonceVerification.Recommended

[125] Fix | Delete

[126] Fix | Delete

$this->form_id = $id;

[127] Fix | Delete

$form_handler = wpforms()->get( 'form' );

[128] Fix | Delete

[129] Fix | Delete

if ( ! $form_handler ) {

[130] Fix | Delete

return false;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

$this->form = $form_handler->get( $this->form_id );

[134] Fix | Delete

[135] Fix | Delete

return $this->form_id && $this->form instanceof WP_Post;

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Hook into WordPress lifecycle.

[140] Fix | Delete

[141] Fix | Delete

* @since 1.7.3

[142] Fix | Delete

[143] Fix | Delete

private function hooks() {

[144] Fix | Delete

[145] Fix | Delete

// Restore a revision. The `admin_init` action has already fired, `current_screen` fires before headers are sent.

[146] Fix | Delete

add_action( 'current_screen', [ $this, 'process_restore' ] );

[147] Fix | Delete

[148] Fix | Delete

// Refresh a rendered list of revisions on the frontend.

[149] Fix | Delete

add_action( 'wp_ajax_wpforms_get_form_revisions', [ $this, 'fetch_revisions_list' ] );

[150] Fix | Delete

[151] Fix | Delete

// Mark Revisions panel as viewed when viewed for the first time. Hides the error badge.

[152] Fix | Delete

add_action( 'wp_ajax_wpforms_mark_panel_viewed', [ $this, 'mark_panel_viewed' ] );

[153] Fix | Delete

[154] Fix | Delete

// Back-compat for forms created with revisions disabled.

[155] Fix | Delete

add_action( 'wpforms_builder_init', [ $this, 'maybe_create_initial_revision' ] );

[156] Fix | Delete

[157] Fix | Delete

// Pass localized strings to frontend.

[158] Fix | Delete

add_filter( 'wpforms_builder_strings', [ $this, 'get_localized_strings' ], 10, 2 );

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Get current revision, if available.

[163] Fix | Delete

[164] Fix | Delete

* @since 1.7.3

[165] Fix | Delete

[166] Fix | Delete

* @return WP_Post|null

[167] Fix | Delete

[168] Fix | Delete

public function get_revision() {

[169] Fix | Delete

[170] Fix | Delete

return $this->revision;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Get formatted date or time.

[175] Fix | Delete

[176] Fix | Delete

* @since 1.7.3

[177] Fix | Delete

[178] Fix | Delete

* @param string $datetime UTC datetime from the post object.

[179] Fix | Delete

* @param string $part What to return - date or time, defaults to date.

[180] Fix | Delete

[181] Fix | Delete

* @return string

[182] Fix | Delete

[183] Fix | Delete

public function get_formatted_datetime( $datetime, $part = 'date' ) {

[184] Fix | Delete

[185] Fix | Delete

if ( $part === 'time' ) {

[186] Fix | Delete

return wpforms_time_format( $datetime, '', true );

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

// M j format needs to keep one-line date.

[190] Fix | Delete

return wpforms_date_format( $datetime, 'M j', true );

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

/**

[194] Fix | Delete

* Get admin (Form Builder) base URL with additional query args.

[195] Fix | Delete

[196] Fix | Delete

* @since 1.7.3

[197] Fix | Delete

[198] Fix | Delete

* @param array $query_args Additional query args to append to the base URL.

[199] Fix | Delete

[200] Fix | Delete

* @return string

[201] Fix | Delete

[202] Fix | Delete

public function get_url( $query_args = [] ) {

[203] Fix | Delete

[204] Fix | Delete

$defaults = [

[205] Fix | Delete

'page' => 'wpforms-builder',

[206] Fix | Delete

'view' => $this->view,

[207] Fix | Delete

'form_id' => $this->form_id,

[208] Fix | Delete

];

[209] Fix | Delete

[210] Fix | Delete

return add_query_arg(

[211] Fix | Delete

wp_parse_args( $query_args, $defaults ),

[212] Fix | Delete

admin_url( 'admin.php' )

[213] Fix | Delete

);

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* Determine if Revisions panel was previously viewed by current user.

[218] Fix | Delete

[219] Fix | Delete

* @since 1.7.3

[220] Fix | Delete

[221] Fix | Delete

* @return bool

[222] Fix | Delete

[223] Fix | Delete

public function panel_viewed() {

[224] Fix | Delete

[225] Fix | Delete

if ( $this->viewed === null ) {

[226] Fix | Delete

$this->viewed = (bool) get_user_meta( get_current_user_id(), 'wpforms_revisions_disabled_notice_dismissed', true );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

return $this->viewed;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Mark Revisions panel as viewed by current user.

[234] Fix | Delete

[235] Fix | Delete

* @since 1.7.3

[236] Fix | Delete

[237] Fix | Delete

public function mark_panel_viewed() {

[238] Fix | Delete

[239] Fix | Delete

// Run a security check.

[240] Fix | Delete

check_ajax_referer( 'wpforms-builder', 'nonce' );

[241] Fix | Delete

[242] Fix | Delete

if ( ! $this->panel_viewed() ) {

[243] Fix | Delete

$this->viewed = update_user_meta( get_current_user_id(), 'wpforms_revisions_disabled_notice_dismissed', true );

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

wp_send_json_success( [ 'updated' => $this->viewed ] );

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Get a rendered list of all revisions.

[251] Fix | Delete

[252] Fix | Delete

* @since 1.7.3

[253] Fix | Delete

[254] Fix | Delete

* @return string

[255] Fix | Delete

[256] Fix | Delete

public function render_revisions_list() {

[257] Fix | Delete

[258] Fix | Delete

return wpforms_render(

[259] Fix | Delete

'builder/revisions/list',

[260] Fix | Delete

$this->prepare_template_render_arguments(),

[261] Fix | Delete

true

[262] Fix | Delete

);

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

/**

[266] Fix | Delete

* Prepare all arguments for the template to be rendered.

[267] Fix | Delete

[268] Fix | Delete

* Note: All data is escaped in the template.

[269] Fix | Delete

[270] Fix | Delete

* @since 1.7.3

[271] Fix | Delete

[272] Fix | Delete

* @return array

[273] Fix | Delete

[274] Fix | Delete

private function prepare_template_render_arguments() {

[275] Fix | Delete

[276] Fix | Delete

$args = [

[277] Fix | Delete

'active_class' => $this->revision ? '' : ' active',

[278] Fix | Delete

'current_version_url' => $this->get_url(),

[279] Fix | Delete

'author_id' => $this->form->post_author,

[280] Fix | Delete

'revisions' => [],

[281] Fix | Delete

'show_avatars' => get_option( 'show_avatars' ),

[282] Fix | Delete

];

[283] Fix | Delete

[284] Fix | Delete

$revisions = wp_get_post_revisions( $this->form_id );

[285] Fix | Delete

[286] Fix | Delete

if ( empty( $revisions ) ) {

[287] Fix | Delete

return $args;

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

// WordPress always orders entries by `post_date` column, which contains a date and time in site's timezone configured in settings.

[291] Fix | Delete

// This setting is per site, not per user, and it's not expected to be changed. However, if it was changed for whatever reason,

[292] Fix | Delete

// the order of revisions will be incorrect. This is definitely an edge case, but we can prevent this from ever happening

[293] Fix | Delete

// by sorting the results using `post_date_gmt` or `post_modified_gmt`, which contains UTC date and never changes.

[294] Fix | Delete

uasort(

[295] Fix | Delete

$revisions,

[296] Fix | Delete

static function ( $a, $b ) {

[297] Fix | Delete

[298] Fix | Delete

return strtotime( $a->post_modified_gmt ) > strtotime( $b->post_modified_gmt ) ? -1 : 1;

[299] Fix | Delete

}

[300] Fix | Delete

);

[301] Fix | Delete

[302] Fix | Delete

// The first revision is always identical to the current version and should not be displayed in the list.

[303] Fix | Delete

$current_revision = array_shift( $revisions );

[304] Fix | Delete

[305] Fix | Delete

// Display the author of current version instead of a form author.

[306] Fix | Delete

$args['author_id'] = $current_revision->post_author;

[307] Fix | Delete

[308] Fix | Delete

foreach ( $revisions as $revision ) {

[309] Fix | Delete

$time_diff = sprintf( /* translators: %s - relative time difference, e.g. "5 minutes", "12 days". */

[310] Fix | Delete

__( '%s ago', 'wpforms-lite' ),

[311] Fix | Delete

human_time_diff( strtotime( $revision->post_modified_gmt . ' +0000' ) )

[312] Fix | Delete

);

[313] Fix | Delete

[314] Fix | Delete

$date_time = sprintf( /* translators: %1$s - date, %2$s - time when item was created, e.g. "Oct 22 at 11:11am". */

[315] Fix | Delete

__( '%1$s at %2$s', 'wpforms-lite' ),

[316] Fix | Delete

$this->get_formatted_datetime( $revision->post_modified_gmt ),

[317] Fix | Delete

$this->get_formatted_datetime( $revision->post_modified_gmt, 'time' )

[318] Fix | Delete

);

[319] Fix | Delete

[320] Fix | Delete

$args['revisions'][] = [

[321] Fix | Delete

'active_class' => $this->revision && $this->revision->ID === $revision->ID ? ' active' : '',

[322] Fix | Delete

'url' => $this->get_url(

[323] Fix | Delete

[

[324] Fix | Delete

'revision_id' => $revision->ID,

[325] Fix | Delete

]

[326] Fix | Delete

[327] Fix | Delete

'author_id' => $revision->post_author,

[328] Fix | Delete

'time_diff' => $time_diff,

[329] Fix | Delete

'date_time' => $date_time,

[330] Fix | Delete

];

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

return $args;

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

/**

[337] Fix | Delete

* Fetch a list of revisions via ajax.

[338] Fix | Delete

[339] Fix | Delete

* @since 1.7.3

[340] Fix | Delete

[341] Fix | Delete

public function fetch_revisions_list() {

[342] Fix | Delete

[343] Fix | Delete

// Run a security check.

[344] Fix | Delete

check_ajax_referer( 'wpforms-builder', 'nonce' );

[345] Fix | Delete

[346] Fix | Delete

wp_send_json_success(

[347] Fix | Delete

[

[348] Fix | Delete

'html' => $this->render_revisions_list(),

[349] Fix | Delete

]

[350] Fix | Delete

);

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Restore the revision (if needed) and reload the Form Builder.

[355] Fix | Delete

[356] Fix | Delete

* @since 1.7.3

[357] Fix | Delete

[358] Fix | Delete

* @return void

[359] Fix | Delete

[360] Fix | Delete

public function process_restore() {

[361] Fix | Delete

[362] Fix | Delete

$is_restore_request = isset( $_GET['action'] ) && $_GET['action'] === 'restore_revision';

[363] Fix | Delete

[364] Fix | Delete

// Bail early.

[365] Fix | Delete

if (

[366] Fix | Delete

! $is_restore_request ||

[367] Fix | Delete

! $this->form_id ||

[368] Fix | Delete

! $this->form ||

[369] Fix | Delete

! $this->revision_id ||

[370] Fix | Delete

! $this->revision ||

[371] Fix | Delete

! check_admin_referer( 'restore_revision', 'wpforms_nonce' )

[372] Fix | Delete

) {

[373] Fix | Delete

return;

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete

$restored_id = wp_restore_post_revision( $this->revision );

[377] Fix | Delete

[378] Fix | Delete

if ( $restored_id ) {

[379] Fix | Delete

wp_safe_redirect(

[380] Fix | Delete

wpforms()->get( 'revisions' )->get_url(

[381] Fix | Delete

[

[382] Fix | Delete

'form_id' => $restored_id,

[383] Fix | Delete

]

[384] Fix | Delete

)

[385] Fix | Delete

);

[386] Fix | Delete

[387] Fix | Delete

exit;

[388] Fix | Delete

}

[389] Fix | Delete

}

[390] Fix | Delete

[391] Fix | Delete

/**

[392] Fix | Delete

* Create initial revision for existing form.

[393] Fix | Delete

[394] Fix | Delete

* When a new form is created with revisions enabled, WordPress immediately creates first revision which is identical to the form. But when

[395] Fix | Delete

* a form was created with revisions disabled, this initial revision does not exist. Revisions are saved after post update, so modifying

[396] Fix | Delete

* a form that have no initial revision will update the post first, then a revision of this updated post will be saved. The version of

[397] Fix | Delete

* the form that existed before this update is now gone. To avoid losing this pre-revisions state, we create this initial revision

[398] Fix | Delete

* when the Form Builder loads, if needed.

[399] Fix | Delete

[400] Fix | Delete

* @since 1.7.3

[401] Fix | Delete

[402] Fix | Delete

* @return void

[403] Fix | Delete

[404] Fix | Delete

public function maybe_create_initial_revision() {

[405] Fix | Delete

[406] Fix | Delete

// On new form creation there's no revisions yet, bail. Also, when revisions are disabled.

[407] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended

[408] Fix | Delete

if ( isset( $_GET['newform'] ) || ! wp_revisions_enabled( $this->form ) ) {

[409] Fix | Delete

return;

[410] Fix | Delete

}

[411] Fix | Delete

[412] Fix | Delete

$revisions = wp_get_post_revisions(

[413] Fix | Delete

$this->form_id,

[414] Fix | Delete

[

[415] Fix | Delete

'fields' => 'ids',

[416] Fix | Delete

'numberposts' => 1,

[417] Fix | Delete

]

[418] Fix | Delete

);

[419] Fix | Delete

[420] Fix | Delete

if ( $revisions ) {

[421] Fix | Delete

return;

[422] Fix | Delete

}

[423] Fix | Delete

[424] Fix | Delete

$initial_revision_id = wp_save_post_revision( $this->form_id );

[425] Fix | Delete

$initial_revision = wp_get_post_revision( $initial_revision_id );

[426] Fix | Delete

[427] Fix | Delete

// Initial revision should belong to the author of the original form.

[428] Fix | Delete

if ( $initial_revision->post_author !== $this->form->post_author ) {

[429] Fix | Delete

[430] Fix | Delete

wp_update_post(

[431] Fix | Delete

[

[432] Fix | Delete

'ID' => $initial_revision_id,

[433] Fix | Delete

'post_author' => $this->form->post_author,

[434] Fix | Delete

]

[435] Fix | Delete

);

[436] Fix | Delete

}

[437] Fix | Delete

}

[438] Fix | Delete

[439] Fix | Delete

/**

[440] Fix | Delete

* Pass localized strings to frontend.

[441] Fix | Delete

[442] Fix | Delete

* @since 1.7.3

[443] Fix | Delete

[444] Fix | Delete

* @param array $strings All strings that will be passed to frontend.

[445] Fix | Delete

* @param WP_Post $form Current form object.

[446] Fix | Delete

[447] Fix | Delete

* @return array

[448] Fix | Delete

[449] Fix | Delete

public function get_localized_strings( $strings, $form ) {

[450] Fix | Delete

[451] Fix | Delete

$strings['revision_update_confirm'] = esc_html__( 'You’re about to save a form revision. Continuing will make this the current version.', 'wpforms-lite' );

[452] Fix | Delete

[453] Fix | Delete

return $strings;

[454] Fix | Delete

}

[455] Fix | Delete

}

[456] Fix | Delete

[457] Fix | Delete