<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Forms;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Notice;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Bulk actions on All Forms page.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.7.3

[9] Fix | Delete

*/

[10] Fix | Delete

class BulkActions {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Allowed actions.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.7.3

[16] Fix | Delete

*

[17] Fix | Delete

* @const array

[18] Fix | Delete

*/

[19] Fix | Delete

const ALLOWED_ACTIONS = [

[20] Fix | Delete

'trash',

[21] Fix | Delete

'restore',

[22] Fix | Delete

'delete',

[23] Fix | Delete

'duplicate',

[24] Fix | Delete

'empty_trash',

[25] Fix | Delete

];

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Forms ids.

[29] Fix | Delete

*

[30] Fix | Delete

* @since 1.7.3

[31] Fix | Delete

*

[32] Fix | Delete

* @var array

[33] Fix | Delete

*/

[34] Fix | Delete

private $ids;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Current action.

[38] Fix | Delete

*

[39] Fix | Delete

* @since 1.7.3

[40] Fix | Delete

*

[41] Fix | Delete

* @var string

[42] Fix | Delete

*/

[43] Fix | Delete

private $action;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Current view.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 1.7.3

[49] Fix | Delete

*

[50] Fix | Delete

* @var string

[51] Fix | Delete

*/

[52] Fix | Delete

private $view;

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Determine if the class is allowed to load.

[56] Fix | Delete

*

[57] Fix | Delete

* @since 1.7.3

[58] Fix | Delete

*

[59] Fix | Delete

* @return bool

[60] Fix | Delete

*/

[61] Fix | Delete

private function allow_load() {

[62] Fix | Delete

[63] Fix | Delete

// Load only on the `All Forms` admin page.

[64] Fix | Delete

return wpforms_is_admin_page( 'overview' );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Initialize class.

[69] Fix | Delete

*

[70] Fix | Delete

* @since 1.7.3

[71] Fix | Delete

*/

[72] Fix | Delete

public function init() {

[73] Fix | Delete

[74] Fix | Delete

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

[75] Fix | Delete

return;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

$this->view = wpforms()->obj( 'forms_views' )->get_current_view();

[79] Fix | Delete

[80] Fix | Delete

$this->hooks();

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* Hooks.

[85] Fix | Delete

*

[86] Fix | Delete

* @since 1.7.3

[87] Fix | Delete

*/

[88] Fix | Delete

private function hooks() {

[89] Fix | Delete

[90] Fix | Delete

add_action( 'load-toplevel_page_wpforms-overview', [ $this, 'notices' ] );

[91] Fix | Delete

add_action( 'load-toplevel_page_wpforms-overview', [ $this, 'process' ] );

[92] Fix | Delete

add_filter( 'removable_query_args', [ $this, 'removable_query_args' ] );

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Process the bulk actions.

[97] Fix | Delete

*

[98] Fix | Delete

* @since 1.7.3

[99] Fix | Delete

*/

[100] Fix | Delete

public function process() {

[101] Fix | Delete

[102] Fix | Delete

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

[103] Fix | Delete

$this->ids = isset( $_GET['form_id'] ) ? array_map( 'absint', (array) $_GET['form_id'] ) : [];

[104] Fix | Delete

$this->action = isset( $_REQUEST['action'] ) ? sanitize_key( $_REQUEST['action'] ) : false;

[105] Fix | Delete

[106] Fix | Delete

if ( $this->action === '-1' ) {

[107] Fix | Delete

$this->action = ! empty( $_REQUEST['action2'] ) ? sanitize_key( $_REQUEST['action2'] ) : false;

[108] Fix | Delete

}

[109] Fix | Delete

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

[110] Fix | Delete

[111] Fix | Delete

if ( empty( $this->ids ) || empty( $this->action ) ) {

[112] Fix | Delete

return;

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

// Check exact action values.

[116] Fix | Delete

if ( ! in_array( $this->action, self::ALLOWED_ACTIONS, true ) ) {

[117] Fix | Delete

return;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

if ( empty( $_GET['_wpnonce'] ) ) {

[121] Fix | Delete

return;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

// Check the nonce.

[125] Fix | Delete

if (

[126] Fix | Delete

! wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'bulk-forms' ) &&

[127] Fix | Delete

! wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'wpforms_' . $this->action . '_form_nonce' )

[128] Fix | Delete

) {

[129] Fix | Delete

return;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

// Finally, we can process the action.

[133] Fix | Delete

$this->process_action();

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Process action.

[138] Fix | Delete

*

[139] Fix | Delete

* @since 1.7.3

[140] Fix | Delete

*

[141] Fix | Delete

* @uses process_action_trash

[142] Fix | Delete

* @uses process_action_restore

[143] Fix | Delete

* @uses process_action_delete

[144] Fix | Delete

* @uses process_action_duplicate

[145] Fix | Delete

* @uses process_action_empty_trash

[146] Fix | Delete

*/

[147] Fix | Delete

private function process_action() {

[148] Fix | Delete

[149] Fix | Delete

$method = "process_action_{$this->action}";

[150] Fix | Delete

[151] Fix | Delete

// Check that we have a method for this action.

[152] Fix | Delete

if ( ! method_exists( $this, $method ) ) {

[153] Fix | Delete

return;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

if ( empty( $this->ids ) || ! is_array( $this->ids ) ) {

[157] Fix | Delete

return;

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

$query_args = [];

[161] Fix | Delete

[162] Fix | Delete

if ( count( $this->ids ) === 1 ) {

[163] Fix | Delete

$query_args['type'] = wpforms_is_form_template( $this->ids[0] ) ? 'template' : 'form';

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

$result = [];

[167] Fix | Delete

[168] Fix | Delete

foreach ( $this->ids as $id ) {

[169] Fix | Delete

$result[ $id ] = $this->$method( $id );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

$count_result = count( array_keys( array_filter( $result ) ) );

[173] Fix | Delete

[174] Fix | Delete

// Empty trash action returns count of deleted forms.

[175] Fix | Delete

if ( $method === 'process_action_empty_trash' ) {

[176] Fix | Delete

$count_result = $result[1] ?? 0;

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

$query_args[ rtrim( $this->action, 'e' ) . 'ed' ] = $count_result;

[180] Fix | Delete

[181] Fix | Delete

// Unset get vars and perform redirect to avoid action reuse.

[182] Fix | Delete

wp_safe_redirect(

[183] Fix | Delete

add_query_arg(

[184] Fix | Delete

$query_args,

[185] Fix | Delete

remove_query_arg( [ 'action', 'action2', '_wpnonce', 'form_id', 'paged', '_wp_http_referer' ] )

[186] Fix | Delete

)

[187] Fix | Delete

);

[188] Fix | Delete

exit;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Trash the form.

[193] Fix | Delete

*

[194] Fix | Delete

* @since 1.7.3

[195] Fix | Delete

*

[196] Fix | Delete

* @param int $id Form ID to trash.

[197] Fix | Delete

*

[198] Fix | Delete

* @return bool

[199] Fix | Delete

*/

[200] Fix | Delete

private function process_action_trash( $id ) {

[201] Fix | Delete

[202] Fix | Delete

return wpforms()->obj( 'form' )->update_status( $id, 'trash' );

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

/**

[206] Fix | Delete

* Restore the form.

[207] Fix | Delete

*

[208] Fix | Delete

* @since 1.7.3

[209] Fix | Delete

*

[210] Fix | Delete

* @param int $id Form ID to restore from trash.

[211] Fix | Delete

*

[212] Fix | Delete

* @return bool

[213] Fix | Delete

*/

[214] Fix | Delete

private function process_action_restore( $id ) {

[215] Fix | Delete

[216] Fix | Delete

return wpforms()->obj( 'form' )->update_status( $id, 'publish' );

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

* Delete the form.

[221] Fix | Delete

*

[222] Fix | Delete

* @since 1.7.3

[223] Fix | Delete

*

[224] Fix | Delete

* @param int $id Form ID to delete.

[225] Fix | Delete

*

[226] Fix | Delete

* @return bool

[227] Fix | Delete

*/

[228] Fix | Delete

private function process_action_delete( $id ) {

[229] Fix | Delete

[230] Fix | Delete

return wpforms()->obj( 'form' )->delete( $id );

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Duplicate the form.

[235] Fix | Delete

*

[236] Fix | Delete

* @since 1.7.3

[237] Fix | Delete

*

[238] Fix | Delete

* @param int $id Form ID to duplicate.

[239] Fix | Delete

*

[240] Fix | Delete

* @return bool

[241] Fix | Delete

*/

[242] Fix | Delete

private function process_action_duplicate( $id ) {

[243] Fix | Delete

[244] Fix | Delete

if ( ! wpforms_current_user_can( 'create_forms' ) ) {

[245] Fix | Delete

return false;

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

if ( ! wpforms_current_user_can( 'view_form_single', $id ) ) {

[249] Fix | Delete

return false;

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

return wpforms()->obj( 'form' )->duplicate( $id );

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Empty trash.

[257] Fix | Delete

*

[258] Fix | Delete

* @since 1.7.3

[259] Fix | Delete

*

[260] Fix | Delete

* @param int $id Form ID. This parameter is not used in this method,

[261] Fix | Delete

* but we need to keep it here because all the `process_action_*` methods

[262] Fix | Delete

* should be called with the $id parameter.

[263] Fix | Delete

*

[264] Fix | Delete

* @return bool

[265] Fix | Delete

*/

[266] Fix | Delete

private function process_action_empty_trash( $id ) {

[267] Fix | Delete

[268] Fix | Delete

// Empty trash is actually the "delete all forms in trash" action.

[269] Fix | Delete

// So, after the execution we should display the same notice as for the `delete` action.

[270] Fix | Delete

$this->action = 'delete';

[271] Fix | Delete

[272] Fix | Delete

return wpforms()->obj( 'form' )->empty_trash();

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

/**

[276] Fix | Delete

* Define bulk actions available for forms overview table.

[277] Fix | Delete

*

[278] Fix | Delete

* @since 1.7.3

[279] Fix | Delete

*

[280] Fix | Delete

* @return array

[281] Fix | Delete

*/

[282] Fix | Delete

public function get_dropdown_items() {

[283] Fix | Delete

[284] Fix | Delete

$items = [];

[285] Fix | Delete

[286] Fix | Delete

if ( wpforms_current_user_can( 'delete_forms' ) ) {

[287] Fix | Delete

if ( $this->view === 'trash' ) {

[288] Fix | Delete

$items = [

[289] Fix | Delete

'restore' => esc_html__( 'Restore', 'wpforms-lite' ),

[290] Fix | Delete

'delete' => esc_html__( 'Delete Permanently', 'wpforms-lite' ),

[291] Fix | Delete

];

[292] Fix | Delete

} else {

[293] Fix | Delete

$items = [

[294] Fix | Delete

'trash' => esc_html__( 'Move to Trash', 'wpforms-lite' ),

[295] Fix | Delete

];

[296] Fix | Delete

}

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

// phpcs:disable WPForms.Comments.ParamTagHooks.InvalidParamTagsQuantity

[300] Fix | Delete

[301] Fix | Delete

/**

[302] Fix | Delete

* Filters the Bulk Actions dropdown items.

[303] Fix | Delete

*

[304] Fix | Delete

* @since 1.7.5

[305] Fix | Delete

*

[306] Fix | Delete

* @param array $items Dropdown items.

[307] Fix | Delete

*/

[308] Fix | Delete

$items = apply_filters( 'wpforms_admin_forms_bulk_actions_get_dropdown_items', $items );

[309] Fix | Delete

[310] Fix | Delete

// phpcs:enable WPForms.Comments.ParamTagHooks.InvalidParamTagsQuantity

[311] Fix | Delete

[312] Fix | Delete

if ( empty( $items ) ) {

[313] Fix | Delete

// We should have dummy item, otherwise, WP will hide the Bulk Actions Dropdown,

[314] Fix | Delete

// which is not good from a design point of view.

[315] Fix | Delete

return [

[316] Fix | Delete

'' => '&mdash;',

[317] Fix | Delete

];

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

return $items;

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

/**

[324] Fix | Delete

* Admin notices.

[325] Fix | Delete

*

[326] Fix | Delete

* @since 1.7.3

[327] Fix | Delete

*/

[328] Fix | Delete

public function notices() {

[329] Fix | Delete

[330] Fix | Delete

// phpcs:disable WordPress.Security.NonceVerification

[331] Fix | Delete

$results = [

[332] Fix | Delete

'trashed' => ! empty( $_REQUEST['trashed'] ) ? sanitize_key( $_REQUEST['trashed'] ) : false,

[333] Fix | Delete

'restored' => ! empty( $_REQUEST['restored'] ) ? sanitize_key( $_REQUEST['restored'] ) : false,

[334] Fix | Delete

'deleted' => ! empty( $_REQUEST['deleted'] ) ? sanitize_key( $_REQUEST['deleted'] ) : false,

[335] Fix | Delete

'duplicated' => ! empty( $_REQUEST['duplicated'] ) ? sanitize_key( $_REQUEST['duplicated'] ) : false,

[336] Fix | Delete

'type' => ! empty( $_REQUEST['type'] ) ? sanitize_key( $_REQUEST['type'] ) : 'form',

[337] Fix | Delete

];

[338] Fix | Delete

// phpcs:enable WordPress.Security.NonceVerification

[339] Fix | Delete

[340] Fix | Delete

// Display notice in case of error.

[341] Fix | Delete

if ( in_array( 'error', $results, true ) ) {

[342] Fix | Delete

Notice::add(

[343] Fix | Delete

esc_html__( 'Security check failed. Please try again.', 'wpforms-lite' ),

[344] Fix | Delete

'error'

[345] Fix | Delete

);

[346] Fix | Delete

[347] Fix | Delete

return;

[348] Fix | Delete

}

[349] Fix | Delete

[350] Fix | Delete

$this->notices_success( $results );

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Admin success notices.

[355] Fix | Delete

*

[356] Fix | Delete

* @since 1.7.3

[357] Fix | Delete

*

[358] Fix | Delete

* @param array $results Action results data.

[359] Fix | Delete

*/

[360] Fix | Delete

private function notices_success( array $results ) {

[361] Fix | Delete

[362] Fix | Delete

$type = $results['type'] ?? '';

[363] Fix | Delete

[364] Fix | Delete

if ( ! in_array( $type, [ 'form', 'template' ], true ) ) {

[365] Fix | Delete

return;

[366] Fix | Delete

}

[367] Fix | Delete

[368] Fix | Delete

$method = "get_notice_success_for_{$type}";

[369] Fix | Delete

$actions = [ 'trashed', 'restored', 'deleted', 'duplicated' ];

[370] Fix | Delete

[371] Fix | Delete

foreach ( $actions as $action ) {

[372] Fix | Delete

$count = (int) $results[ $action ];

[373] Fix | Delete

[374] Fix | Delete

if ( ! $count ) {

[375] Fix | Delete

continue;

[376] Fix | Delete

}

[377] Fix | Delete

[378] Fix | Delete

$notice = $this->$method( $action, $count );

[379] Fix | Delete

[380] Fix | Delete

if ( ! $notice ) {

[381] Fix | Delete

continue;

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

Notice::add( $notice, 'info' );

[385] Fix | Delete

}

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

/**

[389] Fix | Delete

* Remove certain arguments from a query string that WordPress should always hide for users.

[390] Fix | Delete

*

[391] Fix | Delete

* @since 1.7.3

[392] Fix | Delete

*

[393] Fix | Delete

* @param array $removable_query_args An array of parameters to remove from the URL.

[394] Fix | Delete

*

[395] Fix | Delete

* @return array Extended/filtered array of parameters to remove from the URL.

[396] Fix | Delete

*/

[397] Fix | Delete

public function removable_query_args( $removable_query_args ) {

[398] Fix | Delete

[399] Fix | Delete

$removable_query_args[] = 'trashed';

[400] Fix | Delete

$removable_query_args[] = 'restored';

[401] Fix | Delete

$removable_query_args[] = 'deleted';

[402] Fix | Delete

$removable_query_args[] = 'duplicated';

[403] Fix | Delete

$removable_query_args[] = 'type';

[404] Fix | Delete

[405] Fix | Delete

return $removable_query_args;

[406] Fix | Delete

}

[407] Fix | Delete

[408] Fix | Delete

/**

[409] Fix | Delete

* Get notice success message for form.

[410] Fix | Delete

*

[411] Fix | Delete

* @since 1.9.2.3

[412] Fix | Delete

*

[413] Fix | Delete

* @param string $action Action type.

[414] Fix | Delete

* @param int $count Count of forms.

[415] Fix | Delete

*

[416] Fix | Delete

* @return string

[417] Fix | Delete

* @noinspection PhpUnusedPrivateMethodInspection

[418] Fix | Delete

*/

[419] Fix | Delete

private function get_notice_success_for_form( string $action, int $count ): string {

[420] Fix | Delete

[421] Fix | Delete

switch ( $action ) {

[422] Fix | Delete

case 'restored':

[423] Fix | Delete

/* translators: %1$d - restored forms count. */

[424] Fix | Delete

$notice = _n( '%1$d form was successfully restored.', '%1$d forms were successfully restored.', $count, 'wpforms-lite' );

[425] Fix | Delete

break;

[426] Fix | Delete

[427] Fix | Delete

case 'deleted':

[428] Fix | Delete

/* translators: %1$d - deleted forms count. */

[429] Fix | Delete

$notice = _n( '%1$d form was successfully permanently deleted.', '%1$d forms were successfully permanently deleted.', $count, 'wpforms-lite' );

[430] Fix | Delete

break;

[431] Fix | Delete

[432] Fix | Delete

case 'duplicated':

[433] Fix | Delete

/* translators: %1$d - duplicated forms count. */

[434] Fix | Delete

$notice = _n( '%1$d form was successfully duplicated.', '%1$d forms were successfully duplicated.', $count, 'wpforms-lite' );

[435] Fix | Delete

break;

[436] Fix | Delete

[437] Fix | Delete

case 'trashed':

[438] Fix | Delete

/* translators: %1$d - trashed forms count. */

[439] Fix | Delete

$notice = _n( '%1$d form was successfully moved to Trash.', '%1$d forms were successfully moved to Trash.', $count, 'wpforms-lite' );

[440] Fix | Delete

break;

[441] Fix | Delete

[442] Fix | Delete

default:

[443] Fix | Delete

// phpcs:ignore WPForms.Formatting.EmptyLineBeforeReturn.AddEmptyLineBeforeReturnStatement

[444] Fix | Delete

return '';

[445] Fix | Delete

}

[446] Fix | Delete

[447] Fix | Delete

return sprintf( $notice, $count );

[448] Fix | Delete

}

[449] Fix | Delete

[450] Fix | Delete

/**

[451] Fix | Delete

* Get notice success message for template.

[452] Fix | Delete

*

[453] Fix | Delete

* @since 1.9.2.3

[454] Fix | Delete

*

[455] Fix | Delete

* @param string $action Action type.

[456] Fix | Delete

* @param int $count Count of forms.

[457] Fix | Delete

*

[458] Fix | Delete

* @return string

[459] Fix | Delete

* @noinspection PhpUnusedPrivateMethodInspection

[460] Fix | Delete

*/

[461] Fix | Delete

private function get_notice_success_for_template( string $action, int $count ): string {

[462] Fix | Delete

[463] Fix | Delete

switch ( $action ) {

[464] Fix | Delete

case 'restored':

[465] Fix | Delete

/* translators: %1$d - restored templates count. */

[466] Fix | Delete

$notice = _n( '%1$d template was successfully restored.', '%1$d templates were successfully restored.', $count, 'wpforms-lite' );

[467] Fix | Delete

break;

[468] Fix | Delete

[469] Fix | Delete

case 'deleted':

[470] Fix | Delete

/* translators: %1$d - deleted templates count. */

[471] Fix | Delete

$notice = _n( '%1$d template was successfully permanently deleted.', '%1$d templates were successfully permanently deleted.', $count, 'wpforms-lite' );

[472] Fix | Delete

break;

[473] Fix | Delete

[474] Fix | Delete

case 'duplicated':

[475] Fix | Delete

/* translators: %1$d - duplicated templates count. */

[476] Fix | Delete

$notice = _n( '%1$d template was successfully duplicated.', '%1$d templates were successfully duplicated.', $count, 'wpforms-lite' );

[477] Fix | Delete

break;

[478] Fix | Delete

[479] Fix | Delete

case 'trashed':

[480] Fix | Delete

/* translators: %1$d - trashed templates count. */

[481] Fix | Delete

$notice = _n( '%1$d template was successfully moved to Trash.', '%1$d templates were successfully moved to Trash.', $count, 'wpforms-lite' );

[482] Fix | Delete

break;

[483] Fix | Delete

[484] Fix | Delete

default:

[485] Fix | Delete

// phpcs:ignore WPForms.Formatting.EmptyLineBeforeReturn.AddEmptyLineBeforeReturnStatement

[486] Fix | Delete

return '';

[487] Fix | Delete

}

[488] Fix | Delete

[489] Fix | Delete

return sprintf( $notice, $count );

[490] Fix | Delete

}

[491] Fix | Delete

}

[492] Fix | Delete

[493] Fix | Delete