1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<?php
// phpcs:ignoreFile
namespace AutomateWoo\Admin\Controllers;
use AutomateWoo\Admin;
use AutomateWoo\Clean;
/**
* Base admin controller class
* @since 3.2.4
*/
abstract class Base {
/** @var string */
public $name;
/** @var array */
private $messages = [];
/** @var array */
private $errors = [];
/** @var string */
protected $default_route = 'list';
/** @var string */
protected $heading;
/** @var array */
protected $heading_links = [];
/**
* Handle controller requests
* @return void
*/
abstract function handle();
/**
* @return string
*/
function get_heading() {
if ( isset( $this->heading ) ) {
return $this->heading;
}
return get_admin_page_title();
}
/**
* @return array
*/
function get_heading_links() {
return $this->heading_links;
}
function output_messages() {
if ( sizeof( $this->errors ) > 0 ) {
foreach ( $this->errors as $error ) {
echo $this->format_notice( $error, 'error' );
}
}
elseif ( sizeof( $this->messages ) > 0 ) {
foreach ( $this->messages as $message ) {
echo $this->format_notice( $message, 'success' );
}
}
}
/**
* @param $notice_data
* @param $type
* @return string
*/
function format_notice( $notice_data, $type ) {
$class = "notice notice-$type automatewoo-notice";
if ( is_array( $notice_data ) ) {
$main_text = $notice_data['main'];
$extra_text = isset($notice_data['extra']) ? $notice_data['extra'] : '';
$class .= ' ' . $notice_data['class'];
}
else {
$main_text = $notice_data;
$extra_text = '';
}
return '<div class="' . $class .'"><p><strong>'.esc_html($main_text).'</strong> '.$extra_text.'</p></div>';
}
/**
* @return string
*/
function get_messages() {
ob_start();
$this->output_messages();
return ob_get_clean();
}
/**
* @return string
*/
function get_current_action() {
if ( isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] )
return Clean::string( $_REQUEST['action'] );
if ( isset( $_REQUEST['action2'] ) && -1 != $_REQUEST['action2'] )
return Clean::string( $_REQUEST['action2'] );
return $this->default_route;
}
/**
* @return string
*/
function get_nonce_action() {
return 'automatewoo-' . $this->name;
}
/**
* Verify nonce
* @param bool|string $nonce_action - optional custom nonce
*/
function verify_nonce_action( $nonce_action = false ) {
$nonce = Clean::string( aw_request( '_wpnonce' ) );
if ( ! $nonce_action ) {
$nonce_action = $this->get_nonce_action();
}
if ( ! wp_verify_nonce( $nonce, $nonce_action ) ) {
wp_die( 'Security check failed.' );
}
}
/**
* @param string $main_text
* @param string $extra_text
* @param string $extra_classes
*/
function add_message( $main_text, $extra_text = '', $extra_classes = '' ) {
$this->messages[] = [
'main' => $main_text,
'extra' => $extra_text,
'class' => $extra_classes
];
}
/**
* @param string $main_text
* @param string $extra_text
* @param string $extra_classes
*/
function add_error( $main_text, $extra_text = '', $extra_classes = '' ) {
$this->errors[] = [
'main' => $main_text,
'extra' => $extra_text,
'class' => $extra_classes
];
}
/**
* @return string
*/
function get_responses_option_name() {
return '_automatewoo_admin_temp_messages_' . get_current_user_id();
}
function store_responses() {
update_option( $this->get_responses_option_name(), [
'errors' => $this->errors,
'messages' => $this->messages
], false );
}
function load_stored_responses() {
if ( $store = get_option( $this->get_responses_option_name() ) ) {
$this->messages = $store['messages'];
$this->errors = $store['errors'];
}
$this->clear_stored_responses();
}
function clear_stored_responses() {
delete_option( $this->get_responses_option_name() );
}
/**
* @param string $action
* @param array $query_args
*/
function redirect_after_action( $action = '', $query_args = [] ) {
$this->store_responses();
$args = [
'did-action' => $this->get_current_action()
];
if ( $action ) {
$args['action'] = $action;
}
$query_args = array_merge( $args, $query_args );
wp_safe_redirect( add_query_arg( $query_args, Admin::page_url( $this->name ) ), 302 );
exit;
}
/**
* Outputs an controller view.
* Adds relevant variables to scope.
*
* IMPORTANT not to name $import_variables something as $args
* can cause errors if there is a conflicting key name in the array
*
* @param $view
* @param array $imported_variables
* @param bool|string $path
*/
function output_view( $view, $imported_variables = [], $path = false ) {
$imported_variables['controller'] = $this;
$imported_variables['page'] = $this->name;
$imported_variables['heading'] = $this->get_heading();
$imported_variables['messages'] = $this->get_messages();
if ( $imported_variables && is_array( $imported_variables ) ) {
extract( $imported_variables );
}
if ( $path ) {
if ( ! file_exists( "$path/$view.php" ) ) {
$path = false; // fall back to original views dir
}
}
if ( ! $path ) {
$path = AW()->admin_path( '/views' );
}
include "$path/$view.php"; // nosemgrep All the calls to this function are internal, w/o user input.
}
}
|