<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Forms\Fields\Traits;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Access restrictions trait.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.9.8

[7] Fix | Delete

*/

[8] Fix | Delete

trait AccessRestrictionsTrait {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* User roles.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.9.8

[14] Fix | Delete

*

[15] Fix | Delete

* @var array

[16] Fix | Delete

*/

[17] Fix | Delete

private $user_roles = [];

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Add access restrictions options to the field.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.9.8

[23] Fix | Delete

*

[24] Fix | Delete

* @param array $field Field data and settings.

[25] Fix | Delete

*/

[26] Fix | Delete

private function access_restrictions_options( array $field ) {

[27] Fix | Delete

[28] Fix | Delete

$access_restrictions = $this->field_element(

[29] Fix | Delete

'toggle',

[30] Fix | Delete

$field,

[31] Fix | Delete

[

[32] Fix | Delete

'slug' => 'is_restricted',

[33] Fix | Delete

'value' => ! empty( $field['is_restricted'] ) ? 1 : '',

[34] Fix | Delete

'desc' => esc_html__( 'Enable File Access Restrictions', 'wpforms-lite' ),

[35] Fix | Delete

'tooltip' => esc_html__( 'Choose who can access the uploaded files.', 'wpforms-lite' ),

[36] Fix | Delete

'class' => $this->get_access_restrictions_toggle_class(),

[37] Fix | Delete

],

[38] Fix | Delete

false

[39] Fix | Delete

);

[40] Fix | Delete

[41] Fix | Delete

$this->field_element(

[42] Fix | Delete

'row',

[43] Fix | Delete

$field,

[44] Fix | Delete

[

[45] Fix | Delete

'slug' => 'access_restrictions',

[46] Fix | Delete

'attrs' => $this->get_access_restrictions_options_attrs(),

[47] Fix | Delete

'content' => $access_restrictions,

[48] Fix | Delete

]

[49] Fix | Delete

);

[50] Fix | Delete

[51] Fix | Delete

// User Restriction.

[52] Fix | Delete

$this->user_restriction_options( $field );

[53] Fix | Delete

[54] Fix | Delete

// Password Protection.

[55] Fix | Delete

$this->password_protection_options( $field );

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Get access restrictions toggle class.

[60] Fix | Delete

*

[61] Fix | Delete

* @since 1.9.8

[62] Fix | Delete

*

[63] Fix | Delete

* @return string

[64] Fix | Delete

*/

[65] Fix | Delete

protected function get_access_restrictions_toggle_class(): string {

[66] Fix | Delete

[67] Fix | Delete

return 'wpforms-file-upload-access-restrictions';

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Get access restrictions options attributes.

[72] Fix | Delete

*

[73] Fix | Delete

* @since 1.9.8

[74] Fix | Delete

*

[75] Fix | Delete

* @return array

[76] Fix | Delete

*/

[77] Fix | Delete

protected function get_access_restrictions_options_attrs(): array {

[78] Fix | Delete

[79] Fix | Delete

return [];

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Add user restrictions options to the field.

[84] Fix | Delete

*

[85] Fix | Delete

* @since 1.9.8

[86] Fix | Delete

*

[87] Fix | Delete

* @param array $field Field data and settings.

[88] Fix | Delete

*/

[89] Fix | Delete

private function user_restriction_options( array $field ) {

[90] Fix | Delete

[91] Fix | Delete

$user_restrictions_value = $this->get_user_restrictions_value( $field );

[92] Fix | Delete

[93] Fix | Delete

$this->add_user_restrictions_select( $field, $user_restrictions_value );

[94] Fix | Delete

[95] Fix | Delete

$hide_user_restrictions = $this->should_hide_user_restrictions( $user_restrictions_value, $field );

[96] Fix | Delete

[97] Fix | Delete

$this->add_user_roles_restrictions( $field, $hide_user_restrictions );

[98] Fix | Delete

$this->add_user_names_restrictions( $field, $hide_user_restrictions );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Get user restrictions value.

[103] Fix | Delete

*

[104] Fix | Delete

* @since 1.9.8

[105] Fix | Delete

*

[106] Fix | Delete

* @param array $field Field data and settings.

[107] Fix | Delete

*

[108] Fix | Delete

* @return string

[109] Fix | Delete

*/

[110] Fix | Delete

private function get_user_restrictions_value( array $field ): string {

[111] Fix | Delete

[112] Fix | Delete

return ! empty( $field['user_restrictions'] ) ? $field['user_restrictions'] : 'none';

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

/**

[116] Fix | Delete

* Add user restrictions select to the field.

[117] Fix | Delete

*

[118] Fix | Delete

* @since 1.9.8

[119] Fix | Delete

*

[120] Fix | Delete

* @param array $field Field data and settings.

[121] Fix | Delete

* @param string $user_restrictions_value User restrictions value.

[122] Fix | Delete

*/

[123] Fix | Delete

private function add_user_restrictions_select( array $field, string $user_restrictions_value ) {

[124] Fix | Delete

[125] Fix | Delete

$label = $this->field_element(

[126] Fix | Delete

'label',

[127] Fix | Delete

$field,

[128] Fix | Delete

[

[129] Fix | Delete

'slug' => 'user_restrictions',

[130] Fix | Delete

'value' => esc_html__( 'User Restriction', 'wpforms-lite' ),

[131] Fix | Delete

],

[132] Fix | Delete

false

[133] Fix | Delete

);

[134] Fix | Delete

[135] Fix | Delete

$select = $this->field_element(

[136] Fix | Delete

'select',

[137] Fix | Delete

$field,

[138] Fix | Delete

[

[139] Fix | Delete

'slug' => 'user_restrictions',

[140] Fix | Delete

'value' => $user_restrictions_value,

[141] Fix | Delete

'options' => [

[142] Fix | Delete

'none' => esc_html__( 'None', 'wpforms-lite' ),

[143] Fix | Delete

'logged' => esc_html__( 'Logged-in Users', 'wpforms-lite' ),

[144] Fix | Delete

],

[145] Fix | Delete

'class' => 'wpforms-file-upload-user-restrictions',

[146] Fix | Delete

],

[147] Fix | Delete

false

[148] Fix | Delete

);

[149] Fix | Delete

[150] Fix | Delete

$this->field_element(

[151] Fix | Delete

'row',

[152] Fix | Delete

$field,

[153] Fix | Delete

[

[154] Fix | Delete

'slug' => 'user_restrictions',

[155] Fix | Delete

'content' => $label . $select,

[156] Fix | Delete

'class' => $this->is_restricted( $field ) ? '' : 'wpforms-hidden',

[157] Fix | Delete

]

[158] Fix | Delete

);

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Check if user restrictions should be hidden.

[163] Fix | Delete

*

[164] Fix | Delete

* @since 1.9.8

[165] Fix | Delete

*

[166] Fix | Delete

* @param string $user_restrictions_value User restrictions value.

[167] Fix | Delete

* @param array $field Field data and settings.

[168] Fix | Delete

*

[169] Fix | Delete

* @return bool

[170] Fix | Delete

*/

[171] Fix | Delete

private function should_hide_user_restrictions( string $user_restrictions_value, array $field ): bool {

[172] Fix | Delete

[173] Fix | Delete

return $user_restrictions_value === 'none' || ! $this->is_restricted( $field );

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Add user roles restrictions to the field.

[178] Fix | Delete

*

[179] Fix | Delete

* @since 1.9.8

[180] Fix | Delete

*

[181] Fix | Delete

* @param array $field Field data and settings.

[182] Fix | Delete

* @param bool $hide_user_restrictions Should user restrictions be hidden.

[183] Fix | Delete

*/

[184] Fix | Delete

private function add_user_roles_restrictions( array $field, bool $hide_user_restrictions ) {

[185] Fix | Delete

[186] Fix | Delete

$label = $this->field_element(

[187] Fix | Delete

'label',

[188] Fix | Delete

$field,

[189] Fix | Delete

[

[190] Fix | Delete

'slug' => 'user_roles_restrictions',

[191] Fix | Delete

'value' => esc_html__( 'User Roles', 'wpforms-lite' ),

[192] Fix | Delete

'tooltip' => esc_html__( 'Select the user roles that can access the uploaded files.', 'wpforms-lite' ),

[193] Fix | Delete

],

[194] Fix | Delete

false

[195] Fix | Delete

);

[196] Fix | Delete

[197] Fix | Delete

$select = $this->field_element(

[198] Fix | Delete

'select-multiple',

[199] Fix | Delete

$field,

[200] Fix | Delete

[

[201] Fix | Delete

'slug' => 'user_roles_restrictions',

[202] Fix | Delete

'value' => $this->get_selected_roles( $field ),

[203] Fix | Delete

'desc' => esc_html__( 'All users with selected roles will be able to access the uploaded files.', 'wpforms-lite' ),

[204] Fix | Delete

'options' => $this->get_user_roles(),

[205] Fix | Delete

'choicesjs' => false,

[206] Fix | Delete

'class' => 'wpforms-file-upload-user-roles-select',

[207] Fix | Delete

],

[208] Fix | Delete

false

[209] Fix | Delete

);

[210] Fix | Delete

[211] Fix | Delete

$this->field_element(

[212] Fix | Delete

'row',

[213] Fix | Delete

$field,

[214] Fix | Delete

[

[215] Fix | Delete

'slug' => 'user_roles_restrictions',

[216] Fix | Delete

'content' => $label . $select,

[217] Fix | Delete

'class' => $hide_user_restrictions ? 'wpforms-hidden' : '',

[218] Fix | Delete

]

[219] Fix | Delete

);

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

/**

[223] Fix | Delete

* Get selected roles.

[224] Fix | Delete

*

[225] Fix | Delete

* @since 1.9.8

[226] Fix | Delete

*

[227] Fix | Delete

* @param array $field Field data and settings.

[228] Fix | Delete

*

[229] Fix | Delete

* @return array

[230] Fix | Delete

*/

[231] Fix | Delete

private function get_selected_roles( array $field ): array {

[232] Fix | Delete

[233] Fix | Delete

$selected_roles = ! empty( $field['user_roles_restrictions'] ) ? json_decode( $field['user_roles_restrictions'], true ) : [];

[234] Fix | Delete

[235] Fix | Delete

array_unshift( $selected_roles, 'administrator' );

[236] Fix | Delete

[237] Fix | Delete

return array_unique( $selected_roles );

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Get user roles.

[242] Fix | Delete

*

[243] Fix | Delete

* @since 1.9.8

[244] Fix | Delete

*

[245] Fix | Delete

* @return array

[246] Fix | Delete

*/

[247] Fix | Delete

private function get_user_roles(): array {

[248] Fix | Delete

[249] Fix | Delete

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

[250] Fix | Delete

$roles = get_editable_roles();

[251] Fix | Delete

[252] Fix | Delete

$this->user_roles = array_map(

[253] Fix | Delete

static function ( $item ) {

[254] Fix | Delete

[255] Fix | Delete

return $item['name'];

[256] Fix | Delete

},

[257] Fix | Delete

$roles

[258] Fix | Delete

);

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

return $this->user_roles;

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

/**

[265] Fix | Delete

* Add user names restrictions to the field.

[266] Fix | Delete

*

[267] Fix | Delete

* @since 1.9.8

[268] Fix | Delete

*

[269] Fix | Delete

* @param array $field Field data and settings.

[270] Fix | Delete

* @param bool $hide_user_restrictions Should user restrictions be hidden.

[271] Fix | Delete

*/

[272] Fix | Delete

private function add_user_names_restrictions( array $field, bool $hide_user_restrictions ) {

[273] Fix | Delete

[274] Fix | Delete

$label = $this->field_element(

[275] Fix | Delete

'label',

[276] Fix | Delete

$field,

[277] Fix | Delete

[

[278] Fix | Delete

'slug' => 'user_names_restrictions',

[279] Fix | Delete

'value' => esc_html__( 'Users', 'wpforms-lite' ),

[280] Fix | Delete

'tooltip' => esc_html__( 'Select the users that can access the uploaded files.', 'wpforms-lite' ),

[281] Fix | Delete

],

[282] Fix | Delete

false

[283] Fix | Delete

);

[284] Fix | Delete

[285] Fix | Delete

$select = $this->field_element(

[286] Fix | Delete

'select-multiple',

[287] Fix | Delete

$field,

[288] Fix | Delete

[

[289] Fix | Delete

'slug' => 'user_names_restrictions',

[290] Fix | Delete

'value' => array_map( 'intval', $this->get_user_ids( $field ) ),

[291] Fix | Delete

'options' => $this->get_user_list( $field ),

[292] Fix | Delete

'choicesjs' => false,

[293] Fix | Delete

'class' => 'wpforms-file-upload-user-names-select',

[294] Fix | Delete

],

[295] Fix | Delete

false

[296] Fix | Delete

);

[297] Fix | Delete

[298] Fix | Delete

$this->field_element(

[299] Fix | Delete

'row',

[300] Fix | Delete

$field,

[301] Fix | Delete

[

[302] Fix | Delete

'slug' => 'user_names_restrictions',

[303] Fix | Delete

'content' => $label . $select,

[304] Fix | Delete

'class' => $hide_user_restrictions ? 'wpforms-hidden' : '',

[305] Fix | Delete

]

[306] Fix | Delete

);

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

/**

[310] Fix | Delete

* Get user ids.

[311] Fix | Delete

*

[312] Fix | Delete

* @since 1.9.8

[313] Fix | Delete

*

[314] Fix | Delete

* @param array $field Field data and settings.

[315] Fix | Delete

*

[316] Fix | Delete

* @return array

[317] Fix | Delete

*/

[318] Fix | Delete

private function get_user_ids( array $field ): array {

[319] Fix | Delete

[320] Fix | Delete

return ! empty( $field['user_names_restrictions'] ) ? json_decode( $field['user_names_restrictions'], true ) : [];

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

/**

[324] Fix | Delete

* Get user list.

[325] Fix | Delete

*

[326] Fix | Delete

* @since 1.9.8

[327] Fix | Delete

*

[328] Fix | Delete

* @param array $field Field data and settings.

[329] Fix | Delete

*

[330] Fix | Delete

* @return array

[331] Fix | Delete

*/

[332] Fix | Delete

private function get_user_list( array $field ): array {

[333] Fix | Delete

[334] Fix | Delete

$user_ids = $this->get_user_ids( $field );

[335] Fix | Delete

[336] Fix | Delete

return $this->get_selected_users( $user_ids );

[337] Fix | Delete

}

[338] Fix | Delete

[339] Fix | Delete

/**

[340] Fix | Delete

* Get selected users.

[341] Fix | Delete

*

[342] Fix | Delete

* @since 1.9.8

[343] Fix | Delete

*

[344] Fix | Delete

* @param array $user_ids User IDs.

[345] Fix | Delete

*

[346] Fix | Delete

* @return array

[347] Fix | Delete

*/

[348] Fix | Delete

private function get_selected_users( array $user_ids ): array {

[349] Fix | Delete

[350] Fix | Delete

$selected_users = [];

[351] Fix | Delete

[352] Fix | Delete

if ( ! empty( $user_ids ) ) {

[353] Fix | Delete

$users = get_users(

[354] Fix | Delete

[

[355] Fix | Delete

'include' => $user_ids,

[356] Fix | Delete

'fields' => [ 'ID', 'display_name' ],

[357] Fix | Delete

'orderby' => 'include',

[358] Fix | Delete

]

[359] Fix | Delete

);

[360] Fix | Delete

[361] Fix | Delete

$selected_users = wp_list_pluck( $users, 'display_name', 'ID' );

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

return $selected_users;

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

/**

[368] Fix | Delete

* Add password protection options to the field.

[369] Fix | Delete

*

[370] Fix | Delete

* @since 1.9.8

[371] Fix | Delete

*

[372] Fix | Delete

* @param array $field Field data and settings.

[373] Fix | Delete

*/

[374] Fix | Delete

private function password_protection_options( array $field ) {

[375] Fix | Delete

[376] Fix | Delete

$this->add_password_toggle( $field );

[377] Fix | Delete

$this->add_password_label( $field );

[378] Fix | Delete

$this->add_password_fields( $field );

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

/**

[382] Fix | Delete

* Add password toggle to the field.

[383] Fix | Delete

*

[384] Fix | Delete

* @since 1.9.8

[385] Fix | Delete

*

[386] Fix | Delete

* @param array $field Field data and settings.

[387] Fix | Delete

*/

[388] Fix | Delete

private function add_password_toggle( array $field ) {

[389] Fix | Delete

[390] Fix | Delete

$password = $this->field_element(

[391] Fix | Delete

'toggle',

[392] Fix | Delete

$field,

[393] Fix | Delete

[

[394] Fix | Delete

'slug' => 'is_protected',

[395] Fix | Delete

'value' => ! empty( $field['is_protected'] ) ? 1 : '',

[396] Fix | Delete

'desc' => esc_html__( 'Password Protection', 'wpforms-lite' ),

[397] Fix | Delete

'tooltip' => esc_html__( 'Check this option to password protect the uploaded files.', 'wpforms-lite' ),

[398] Fix | Delete

'class' => 'wpforms-file-upload-password-restrictions',

[399] Fix | Delete

],

[400] Fix | Delete

false

[401] Fix | Delete

);

[402] Fix | Delete

[403] Fix | Delete

$this->field_element(

[404] Fix | Delete

'row',

[405] Fix | Delete

$field,

[406] Fix | Delete

[

[407] Fix | Delete

'slug' => 'password_restrictions',

[408] Fix | Delete

'content' => $password,

[409] Fix | Delete

'class' => $this->is_restricted( $field ) ? '' : 'wpforms-hidden',

[410] Fix | Delete

]

[411] Fix | Delete

);

[412] Fix | Delete

}

[413] Fix | Delete

[414] Fix | Delete

/**

[415] Fix | Delete

* Add password label to the field.

[416] Fix | Delete

*

[417] Fix | Delete

* @since 1.9.8

[418] Fix | Delete

*

[419] Fix | Delete

* @param array $field Field data and settings.

[420] Fix | Delete

*/

[421] Fix | Delete

private function add_password_label( array $field ) {

[422] Fix | Delete

[423] Fix | Delete

$password_label = $this->field_element(

[424] Fix | Delete

'label',

[425] Fix | Delete

$field,

[426] Fix | Delete

[

[427] Fix | Delete

'slug' => 'protection_password_label',

[428] Fix | Delete

'value' => esc_html__( 'Password', 'wpforms-lite' ),

[429] Fix | Delete

'tooltip' => esc_html__( 'Set a password to protect the uploaded files.', 'wpforms-lite' ),

[430] Fix | Delete

],

[431] Fix | Delete

false

[432] Fix | Delete

);

[433] Fix | Delete

[434] Fix | Delete

$this->field_element(

[435] Fix | Delete

'row',

[436] Fix | Delete

$field,

[437] Fix | Delete

[

[438] Fix | Delete

'slug' => 'protection_password_label',

[439] Fix | Delete

'content' => $password_label,

[440] Fix | Delete

'class' => $this->is_protected( $field ) ? '' : 'wpforms-hidden',

[441] Fix | Delete

]

[442] Fix | Delete

);

[443] Fix | Delete

}

[444] Fix | Delete

[445] Fix | Delete

/**

[446] Fix | Delete

* Add password fields to the field.

[447] Fix | Delete

*

[448] Fix | Delete

* @since 1.9.8

[449] Fix | Delete

*

[450] Fix | Delete

* @param array $field Field data and settings.

[451] Fix | Delete

*/

[452] Fix | Delete

private function add_password_fields( array $field ) {

[453] Fix | Delete

[454] Fix | Delete

$password_field_row = $this->get_password_field( $field );

[455] Fix | Delete

$password_confirm_field_row = $this->get_password_confirm_field( $field );

[456] Fix | Delete

[457] Fix | Delete

$password_columns = $this->field_element(

[458] Fix | Delete

'row',

[459] Fix | Delete

$field,

[460] Fix | Delete

[

[461] Fix | Delete

'content' => $password_field_row . $password_confirm_field_row,

[462] Fix | Delete

'class' => [

[463] Fix | Delete

'wpforms-field-options-columns',

[464] Fix | Delete

],

[465] Fix | Delete

],

[466] Fix | Delete

false

[467] Fix | Delete

);

[468] Fix | Delete

[469] Fix | Delete

$this->field_element(

[470] Fix | Delete

'row',

[471] Fix | Delete

$field,

[472] Fix | Delete

[

[473] Fix | Delete

'slug' => 'protection_password_columns',

[474] Fix | Delete

'content' => $password_columns,

[475] Fix | Delete

'class' => $this->is_protected( $field ) ? '' : 'wpforms-hidden',

[476] Fix | Delete

]

[477] Fix | Delete

);

[478] Fix | Delete

}

[479] Fix | Delete

[480] Fix | Delete

/**

[481] Fix | Delete

* Add password field to the field.

[482] Fix | Delete

*

[483] Fix | Delete

* @since 1.9.8

[484] Fix | Delete

*

[485] Fix | Delete

* @param array $field Field data and settings.

[486] Fix | Delete

*/

[487] Fix | Delete

private function get_password_field( array $field ): string {

[488] Fix | Delete

[489] Fix | Delete

$clean_button = $this->field_element(

[490] Fix | Delete

'button',

[491] Fix | Delete

$field,

[492] Fix | Delete

[

[493] Fix | Delete

'slug' => 'password_restrictions_clean_button',

[494] Fix | Delete

'value' => '<i class="fa fa-times-circle fa-lg"></i>',

[495] Fix | Delete

'class' => [

[496] Fix | Delete

'wpforms-file-upload-password-clean',

[497] Fix | Delete

'wpforms-hidden',

[498] Fix | Delete

],

[499] Fix | Delete