eventespresso /
event-espresso-core
@@ -17,13 +17,13 @@ |
||
| 17 | 17 | */ |
| 18 | 18 | interface JsonWpOptionSerializableInterface extends JsonSerializableAndUnserializable |
| 19 | 19 | { |
| 20 | - /** |
|
| 21 | - * Gets the value to use for wp_options.option_name. Note this is not static, so it can use object properties to |
|
| 22 | - * determine what option name to use. |
|
| 23 | - * @since $VID:$ |
|
| 24 | - * @return string |
|
| 25 | - */ |
|
| 26 | - public function getWpOptionName(); |
|
| 20 | + /** |
|
| 21 | + * Gets the value to use for wp_options.option_name. Note this is not static, so it can use object properties to |
|
| 22 | + * determine what option name to use. |
|
| 23 | + * @since $VID:$ |
|
| 24 | + * @return string |
|
| 25 | + */ |
|
| 26 | + public function getWpOptionName(); |
|
| 27 | 27 | } |
| 28 | 28 | // End of file JsonWpOptionSerializableInterface.php |
| 29 | 29 | // Location: EventEspresso\core\services\options/JsonWpOptionSerializableInterface.php |
@@ -10,53 +10,53 @@ |
||
| 10 | 10 | class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base |
| 11 | 11 | { |
| 12 | 12 | |
| 13 | - protected $_regex = null; |
|
| 14 | - /** |
|
| 15 | - * |
|
| 16 | - * @param string $validation_error_message |
|
| 17 | - * @param string $regex a PHP regex; the javascript regex will be derived from this |
|
| 18 | - */ |
|
| 19 | - public function __construct($validation_error_message = null, $regex = null) |
|
| 20 | - { |
|
| 21 | - $this->_regex = $regex; |
|
| 22 | - parent::__construct($validation_error_message); |
|
| 23 | - } |
|
| 13 | + protected $_regex = null; |
|
| 14 | + /** |
|
| 15 | + * |
|
| 16 | + * @param string $validation_error_message |
|
| 17 | + * @param string $regex a PHP regex; the javascript regex will be derived from this |
|
| 18 | + */ |
|
| 19 | + public function __construct($validation_error_message = null, $regex = null) |
|
| 20 | + { |
|
| 21 | + $this->_regex = $regex; |
|
| 22 | + parent::__construct($validation_error_message); |
|
| 23 | + } |
|
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @param $normalized_value |
|
| 27 | - */ |
|
| 28 | - public function validate($normalized_value) |
|
| 29 | - { |
|
| 30 | - $string_normalized_value = (string) $normalized_value; |
|
| 31 | - if ($this->_regex && $string_normalized_value) { |
|
| 32 | - if (! preg_match($this->_regex, $string_normalized_value)) { |
|
| 33 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'regex'); |
|
| 34 | - } |
|
| 35 | - } |
|
| 36 | - } |
|
| 25 | + /** |
|
| 26 | + * @param $normalized_value |
|
| 27 | + */ |
|
| 28 | + public function validate($normalized_value) |
|
| 29 | + { |
|
| 30 | + $string_normalized_value = (string) $normalized_value; |
|
| 31 | + if ($this->_regex && $string_normalized_value) { |
|
| 32 | + if (! preg_match($this->_regex, $string_normalized_value)) { |
|
| 33 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'regex'); |
|
| 34 | + } |
|
| 35 | + } |
|
| 36 | + } |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @return array |
|
| 40 | - */ |
|
| 41 | - public function get_jquery_validation_rule_array() |
|
| 42 | - { |
|
| 43 | - if ($this->_regex !== null) { |
|
| 44 | - return array( 'regex'=> $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) ); |
|
| 45 | - } else { |
|
| 46 | - return array(); |
|
| 47 | - } |
|
| 48 | - } |
|
| 38 | + /** |
|
| 39 | + * @return array |
|
| 40 | + */ |
|
| 41 | + public function get_jquery_validation_rule_array() |
|
| 42 | + { |
|
| 43 | + if ($this->_regex !== null) { |
|
| 44 | + return array( 'regex'=> $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) ); |
|
| 45 | + } else { |
|
| 46 | + return array(); |
|
| 47 | + } |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | /** |
| 51 | 51 | * Translates a PHP regex into a javscript regex (eg, PHP needs separate delimieters, whereas |
| 52 | 52 | * javscript does not |
| 53 | 53 | * @return string |
| 54 | 54 | */ |
| 55 | - public function regex_js() |
|
| 56 | - { |
|
| 57 | - // first character must be the delimiter |
|
| 58 | - $delimeter = $this->_regex[0]; |
|
| 59 | - $last_occurence_of_delimieter = strrpos($this->_regex, $delimeter); |
|
| 60 | - return substr($this->_regex, 1, $last_occurence_of_delimieter - 1); |
|
| 61 | - } |
|
| 55 | + public function regex_js() |
|
| 56 | + { |
|
| 57 | + // first character must be the delimiter |
|
| 58 | + $delimeter = $this->_regex[0]; |
|
| 59 | + $last_occurence_of_delimieter = strrpos($this->_regex, $delimeter); |
|
| 60 | + return substr($this->_regex, 1, $last_occurence_of_delimieter - 1); |
|
| 61 | + } |
|
| 62 | 62 | } |
@@ -28,8 +28,8 @@ discard block |
||
| 28 | 28 | public function validate($normalized_value) |
| 29 | 29 | { |
| 30 | 30 | $string_normalized_value = (string) $normalized_value; |
| 31 | - if ($this->_regex && $string_normalized_value) { |
|
| 32 | - if (! preg_match($this->_regex, $string_normalized_value)) { |
|
| 31 | + if ($this->_regex && $string_normalized_value) { |
|
| 32 | + if ( ! preg_match($this->_regex, $string_normalized_value)) { |
|
| 33 | 33 | throw new EE_Validation_Error($this->get_validation_error_message(), 'regex'); |
| 34 | 34 | } |
| 35 | 35 | } |
@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | public function get_jquery_validation_rule_array() |
| 42 | 42 | { |
| 43 | 43 | if ($this->_regex !== null) { |
| 44 | - return array( 'regex'=> $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) ); |
|
| 44 | + return array('regex'=> $this->regex_js(), 'messages' => array('regex' => $this->get_validation_error_message())); |
|
| 45 | 45 | } else { |
| 46 | 46 | return array(); |
| 47 | 47 | } |
@@ -11,1240 +11,1240 @@ |
||
| 11 | 11 | abstract class EE_Form_Input_Base extends EE_Form_Section_Validatable |
| 12 | 12 | { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * the input's name attribute |
|
| 16 | - * |
|
| 17 | - * @var string |
|
| 18 | - */ |
|
| 19 | - protected $_html_name; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * id for the html label tag |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $_html_label_id; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * class for teh html label tag |
|
| 30 | - * |
|
| 31 | - * @var string |
|
| 32 | - */ |
|
| 33 | - protected $_html_label_class; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * any additional html attributes that you may want to add |
|
| 37 | - * |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 40 | - protected $_html_other_attributes; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * style for teh html label tag |
|
| 44 | - * |
|
| 45 | - * @var string |
|
| 46 | - */ |
|
| 47 | - protected $_html_label_style; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * text to be placed in the html label |
|
| 51 | - * |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 54 | - protected $_html_label_text; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * the full html label. If used, all other html_label_* properties are invalid |
|
| 58 | - * |
|
| 59 | - * @var string |
|
| 60 | - */ |
|
| 61 | - protected $_html_label; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * HTML to use for help text (normally placed below form input), in a span which normally |
|
| 65 | - * has a class of 'description' |
|
| 66 | - * |
|
| 67 | - * @var string |
|
| 68 | - */ |
|
| 69 | - protected $_html_help_text; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * CSS classes for displaying the help span |
|
| 73 | - * |
|
| 74 | - * @var string |
|
| 75 | - */ |
|
| 76 | - protected $_html_help_class = 'description'; |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * CSS to put in the style attribute on the help span |
|
| 80 | - * |
|
| 81 | - * @var string |
|
| 82 | - */ |
|
| 83 | - protected $_html_help_style; |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Stores whether or not this input's response is required. |
|
| 87 | - * Because certain styling elements may also want to know that this |
|
| 88 | - * input is required etc. |
|
| 89 | - * |
|
| 90 | - * @var boolean |
|
| 91 | - */ |
|
| 92 | - protected $_required; |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * css class added to required inputs |
|
| 96 | - * |
|
| 97 | - * @var string |
|
| 98 | - */ |
|
| 99 | - protected $_required_css_class = 'ee-required'; |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * css styles applied to button type inputs |
|
| 103 | - * |
|
| 104 | - * @var string |
|
| 105 | - */ |
|
| 106 | - protected $_button_css_attributes; |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * The raw data submitted for this, like in the $_POST super global. |
|
| 110 | - * Generally unsafe for usage in client code |
|
| 111 | - * |
|
| 112 | - * @var mixed string or array |
|
| 113 | - */ |
|
| 114 | - protected $_raw_value; |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Value normalized according to the input's normalization strategy. |
|
| 118 | - * The normalization strategy dictates whether this is a string, int, float, |
|
| 119 | - * boolean, or array of any of those. |
|
| 120 | - * |
|
| 121 | - * @var mixed |
|
| 122 | - */ |
|
| 123 | - protected $_normalized_value; |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Normalized default value either initially set on the input, or provided by calling |
|
| 128 | - * set_default(). |
|
| 129 | - * @var mixed |
|
| 130 | - */ |
|
| 131 | - protected $_default; |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Strategy used for displaying this field. |
|
| 135 | - * Child classes must use _get_display_strategy to access it. |
|
| 136 | - * |
|
| 137 | - * @var EE_Display_Strategy_Base |
|
| 138 | - */ |
|
| 139 | - private $_display_strategy; |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * Gets all the validation strategies used on this field |
|
| 143 | - * |
|
| 144 | - * @var EE_Validation_Strategy_Base[] |
|
| 145 | - */ |
|
| 146 | - private $_validation_strategies = array(); |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * The normalization strategy for this field |
|
| 150 | - * |
|
| 151 | - * @var EE_Normalization_Strategy_Base |
|
| 152 | - */ |
|
| 153 | - private $_normalization_strategy; |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Strategy for removing sensitive data after we're done with the form input |
|
| 157 | - * |
|
| 158 | - * @var EE_Sensitive_Data_Removal_Base |
|
| 159 | - */ |
|
| 160 | - protected $_sensitive_data_removal_strategy; |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * Whether this input has been disabled or not. |
|
| 164 | - * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled. |
|
| 165 | - * (Client-side code that wants to dynamically disable it must also add this hidden input). |
|
| 166 | - * When the form is submitted, if the input is disabled in the PHP formsection, then input is ignored. |
|
| 167 | - * If the input is missing from the $_REQUEST data but the hidden input indicating the input is disabled, then the input is again ignored. |
|
| 168 | - * |
|
| 169 | - * @var boolean |
|
| 170 | - */ |
|
| 171 | - protected $disabled = false; |
|
| 172 | - |
|
| 173 | - |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * @param array $input_args { |
|
| 177 | - * @type string $html_name the html name for the input |
|
| 178 | - * @type string $html_label_id the id attribute to give to the html label tag |
|
| 179 | - * @type string $html_label_class the class attribute to give to the html label tag |
|
| 180 | - * @type string $html_label_style the style attribute to give ot teh label tag |
|
| 181 | - * @type string $html_label_text the text to put in the label tag |
|
| 182 | - * @type string $html_label the full html label. If used, |
|
| 183 | - * all other html_label_* args are invalid |
|
| 184 | - * @type string $html_help_text text to put in help element |
|
| 185 | - * @type string $html_help_style style attribute to give to teh help element |
|
| 186 | - * @type string $html_help_class class attribute to give to the help element |
|
| 187 | - * @type string $default default value NORMALIZED (eg, if providing the default |
|
| 188 | - * for a Yes_No_Input, you should provide TRUE or FALSE, not '1' or '0') |
|
| 189 | - * @type EE_Display_Strategy_Base $display strategy |
|
| 190 | - * @type EE_Normalization_Strategy_Base $normalization_strategy |
|
| 191 | - * @type EE_Validation_Strategy_Base[] $validation_strategies |
|
| 192 | - * @type boolean $ignore_input special argument which can be used to avoid adding any validation strategies, |
|
| 193 | - * and sets the normalization strategy to the Null normalization. This is good |
|
| 194 | - * when you want the input to be totally ignored server-side (like when using |
|
| 195 | - * React.js form inputs) |
|
| 196 | - * } |
|
| 197 | - */ |
|
| 198 | - public function __construct($input_args = array()) |
|
| 199 | - { |
|
| 200 | - $input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this); |
|
| 201 | - // the following properties must be cast as arrays |
|
| 202 | - if (isset($input_args['validation_strategies'])) { |
|
| 203 | - foreach ((array) $input_args['validation_strategies'] as $validation_strategy) { |
|
| 204 | - if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) { |
|
| 205 | - $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy; |
|
| 206 | - } |
|
| 207 | - } |
|
| 208 | - unset($input_args['validation_strategies']); |
|
| 209 | - } |
|
| 210 | - if (isset($input_args['ignore_input'])) { |
|
| 211 | - $this->_validation_strategies = array(); |
|
| 212 | - } |
|
| 213 | - // loop thru incoming options |
|
| 214 | - foreach ($input_args as $key => $value) { |
|
| 215 | - // add underscore to $key to match property names |
|
| 216 | - $_key = '_' . $key; |
|
| 217 | - if (property_exists($this, $_key)) { |
|
| 218 | - $this->{$_key} = $value; |
|
| 219 | - } |
|
| 220 | - } |
|
| 221 | - // ensure that "required" is set correctly |
|
| 222 | - $this->set_required( |
|
| 223 | - $this->_required, |
|
| 224 | - isset($input_args['required_validation_error_message']) |
|
| 225 | - ? $input_args['required_validation_error_message'] |
|
| 226 | - : null |
|
| 227 | - ); |
|
| 228 | - // $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE; |
|
| 229 | - $this->_display_strategy->_construct_finalize($this); |
|
| 230 | - foreach ($this->_validation_strategies as $validation_strategy) { |
|
| 231 | - $validation_strategy->_construct_finalize($this); |
|
| 232 | - } |
|
| 233 | - if (isset($input_args['ignore_input'])) { |
|
| 234 | - $this->_normalization_strategy = new EE_Null_Normalization(); |
|
| 235 | - } |
|
| 236 | - if (! $this->_normalization_strategy) { |
|
| 237 | - $this->_normalization_strategy = new EE_Text_Normalization(); |
|
| 238 | - } |
|
| 239 | - $this->_normalization_strategy->_construct_finalize($this); |
|
| 240 | - // at least we can use the normalization strategy to populate the default |
|
| 241 | - if (isset($input_args['default'])) { |
|
| 242 | - $this->set_default($input_args['default']); |
|
| 243 | - unset($input_args['default']); |
|
| 244 | - } |
|
| 245 | - if (! $this->_sensitive_data_removal_strategy) { |
|
| 246 | - $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal(); |
|
| 247 | - } |
|
| 248 | - $this->_sensitive_data_removal_strategy->_construct_finalize($this); |
|
| 249 | - parent::__construct($input_args); |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - |
|
| 253 | - |
|
| 254 | - /** |
|
| 255 | - * Sets the html_name to its default value, if none was specified in teh constructor. |
|
| 256 | - * Calculation involves using the name and the parent's html_name |
|
| 257 | - * |
|
| 258 | - * @throws \EE_Error |
|
| 259 | - */ |
|
| 260 | - protected function _set_default_html_name_if_empty() |
|
| 261 | - { |
|
| 262 | - if (! $this->_html_name) { |
|
| 263 | - $this->_html_name = $this->name(); |
|
| 264 | - if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) { |
|
| 265 | - $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]"; |
|
| 266 | - } |
|
| 267 | - } |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - |
|
| 271 | - |
|
| 272 | - /** |
|
| 273 | - * @param $parent_form_section |
|
| 274 | - * @param $name |
|
| 275 | - * @throws \EE_Error |
|
| 276 | - */ |
|
| 277 | - public function _construct_finalize($parent_form_section, $name) |
|
| 278 | - { |
|
| 279 | - parent::_construct_finalize($parent_form_section, $name); |
|
| 280 | - if ($this->_html_label === null && $this->_html_label_text === null) { |
|
| 281 | - $this->_html_label_text = ucwords(str_replace("_", " ", $name)); |
|
| 282 | - } |
|
| 283 | - do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name); |
|
| 284 | - } |
|
| 285 | - |
|
| 286 | - |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Returns the strategy for displaying this form input. If none is set, throws an exception. |
|
| 290 | - * |
|
| 291 | - * @return EE_Display_Strategy_Base |
|
| 292 | - * @throws EE_Error |
|
| 293 | - */ |
|
| 294 | - protected function _get_display_strategy() |
|
| 295 | - { |
|
| 296 | - $this->ensure_construct_finalized_called(); |
|
| 297 | - if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) { |
|
| 298 | - throw new EE_Error( |
|
| 299 | - sprintf( |
|
| 300 | - __( |
|
| 301 | - "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor", |
|
| 302 | - "event_espresso" |
|
| 303 | - ), |
|
| 304 | - $this->html_name(), |
|
| 305 | - $this->html_id() |
|
| 306 | - ) |
|
| 307 | - ); |
|
| 308 | - } else { |
|
| 309 | - return $this->_display_strategy; |
|
| 310 | - } |
|
| 311 | - } |
|
| 312 | - |
|
| 313 | - |
|
| 314 | - |
|
| 315 | - /** |
|
| 316 | - * Sets the display strategy. |
|
| 317 | - * |
|
| 318 | - * @param EE_Display_Strategy_Base $strategy |
|
| 319 | - */ |
|
| 320 | - protected function _set_display_strategy(EE_Display_Strategy_Base $strategy) |
|
| 321 | - { |
|
| 322 | - $this->_display_strategy = $strategy; |
|
| 323 | - } |
|
| 324 | - |
|
| 325 | - |
|
| 326 | - |
|
| 327 | - /** |
|
| 328 | - * Sets the sanitization strategy |
|
| 329 | - * |
|
| 330 | - * @param EE_Normalization_Strategy_Base $strategy |
|
| 331 | - */ |
|
| 332 | - protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy) |
|
| 333 | - { |
|
| 334 | - $this->_normalization_strategy = $strategy; |
|
| 335 | - } |
|
| 336 | - |
|
| 337 | - |
|
| 338 | - |
|
| 339 | - /** |
|
| 340 | - * Gets sensitive_data_removal_strategy |
|
| 341 | - * |
|
| 342 | - * @return EE_Sensitive_Data_Removal_Base |
|
| 343 | - */ |
|
| 344 | - public function get_sensitive_data_removal_strategy() |
|
| 345 | - { |
|
| 346 | - return $this->_sensitive_data_removal_strategy; |
|
| 347 | - } |
|
| 348 | - |
|
| 349 | - |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Sets sensitive_data_removal_strategy |
|
| 353 | - * |
|
| 354 | - * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy |
|
| 355 | - * @return boolean |
|
| 356 | - */ |
|
| 357 | - public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy) |
|
| 358 | - { |
|
| 359 | - $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy; |
|
| 360 | - } |
|
| 361 | - |
|
| 362 | - |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * Gets the display strategy for this input |
|
| 366 | - * |
|
| 367 | - * @return EE_Display_Strategy_Base |
|
| 368 | - */ |
|
| 369 | - public function get_display_strategy() |
|
| 370 | - { |
|
| 371 | - return $this->_display_strategy; |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - |
|
| 375 | - |
|
| 376 | - /** |
|
| 377 | - * Overwrites the display strategy |
|
| 378 | - * |
|
| 379 | - * @param EE_Display_Strategy_Base $display_strategy |
|
| 380 | - */ |
|
| 381 | - public function set_display_strategy($display_strategy) |
|
| 382 | - { |
|
| 383 | - $this->_display_strategy = $display_strategy; |
|
| 384 | - $this->_display_strategy->_construct_finalize($this); |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - |
|
| 388 | - |
|
| 389 | - /** |
|
| 390 | - * Gets the normalization strategy set on this input |
|
| 391 | - * |
|
| 392 | - * @return EE_Normalization_Strategy_Base |
|
| 393 | - */ |
|
| 394 | - public function get_normalization_strategy() |
|
| 395 | - { |
|
| 396 | - return $this->_normalization_strategy; |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - |
|
| 400 | - |
|
| 401 | - /** |
|
| 402 | - * Overwrites the normalization strategy |
|
| 403 | - * |
|
| 404 | - * @param EE_Normalization_Strategy_Base $normalization_strategy |
|
| 405 | - */ |
|
| 406 | - public function set_normalization_strategy($normalization_strategy) |
|
| 407 | - { |
|
| 408 | - $this->_normalization_strategy = $normalization_strategy; |
|
| 409 | - $this->_normalization_strategy->_construct_finalize($this); |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - |
|
| 413 | - |
|
| 414 | - /** |
|
| 415 | - * Returns all teh validation strategies which apply to this field, numerically indexed |
|
| 416 | - * |
|
| 417 | - * @return EE_Validation_Strategy_Base[] |
|
| 418 | - */ |
|
| 419 | - public function get_validation_strategies() |
|
| 420 | - { |
|
| 421 | - return $this->_validation_strategies; |
|
| 422 | - } |
|
| 423 | - |
|
| 424 | - |
|
| 425 | - |
|
| 426 | - /** |
|
| 427 | - * Adds this strategy to the field so it will be used in both JS validation and server-side validation |
|
| 428 | - * |
|
| 429 | - * @param EE_Validation_Strategy_Base $validation_strategy |
|
| 430 | - * @return void |
|
| 431 | - */ |
|
| 432 | - protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy) |
|
| 433 | - { |
|
| 434 | - $validation_strategy->_construct_finalize($this); |
|
| 435 | - $this->_validation_strategies[] = $validation_strategy; |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - |
|
| 439 | - |
|
| 440 | - /** |
|
| 441 | - * Adds a new validation strategy onto the form input |
|
| 442 | - * |
|
| 443 | - * @param EE_Validation_Strategy_Base $validation_strategy |
|
| 444 | - * @return void |
|
| 445 | - */ |
|
| 446 | - public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy) |
|
| 447 | - { |
|
| 448 | - $this->_add_validation_strategy($validation_strategy); |
|
| 449 | - } |
|
| 450 | - |
|
| 451 | - |
|
| 452 | - |
|
| 453 | - /** |
|
| 454 | - * The classname of the validation strategy to remove |
|
| 455 | - * |
|
| 456 | - * @param string $validation_strategy_classname |
|
| 457 | - */ |
|
| 458 | - public function remove_validation_strategy($validation_strategy_classname) |
|
| 459 | - { |
|
| 460 | - foreach ($this->_validation_strategies as $key => $validation_strategy) { |
|
| 461 | - if ($validation_strategy instanceof $validation_strategy_classname |
|
| 462 | - || is_subclass_of($validation_strategy, $validation_strategy_classname) |
|
| 463 | - ) { |
|
| 464 | - unset($this->_validation_strategies[ $key ]); |
|
| 465 | - } |
|
| 466 | - } |
|
| 467 | - } |
|
| 468 | - |
|
| 469 | - |
|
| 470 | - |
|
| 471 | - /** |
|
| 472 | - * returns true if input employs any of the validation strategy defined by the supplied array of classnames |
|
| 473 | - * |
|
| 474 | - * @param array $validation_strategy_classnames |
|
| 475 | - * @return bool |
|
| 476 | - */ |
|
| 477 | - public function has_validation_strategy($validation_strategy_classnames) |
|
| 478 | - { |
|
| 479 | - $validation_strategy_classnames = is_array($validation_strategy_classnames) |
|
| 480 | - ? $validation_strategy_classnames |
|
| 481 | - : array($validation_strategy_classnames); |
|
| 482 | - foreach ($this->_validation_strategies as $key => $validation_strategy) { |
|
| 483 | - if (in_array($key, $validation_strategy_classnames)) { |
|
| 484 | - return true; |
|
| 485 | - } |
|
| 486 | - } |
|
| 487 | - return false; |
|
| 488 | - } |
|
| 489 | - |
|
| 490 | - |
|
| 491 | - |
|
| 492 | - /** |
|
| 493 | - * Gets the HTML |
|
| 494 | - * |
|
| 495 | - * @return string |
|
| 496 | - */ |
|
| 497 | - public function get_html() |
|
| 498 | - { |
|
| 499 | - return $this->_parent_section->get_html_for_input($this); |
|
| 500 | - } |
|
| 501 | - |
|
| 502 | - |
|
| 503 | - |
|
| 504 | - /** |
|
| 505 | - * Gets the HTML for the input itself (no label or errors) according to the |
|
| 506 | - * input's display strategy |
|
| 507 | - * Makes sure the JS and CSS are enqueued for it |
|
| 508 | - * |
|
| 509 | - * @return string |
|
| 510 | - * @throws \EE_Error |
|
| 511 | - */ |
|
| 512 | - public function get_html_for_input() |
|
| 513 | - { |
|
| 514 | - return $this->_form_html_filter |
|
| 515 | - ? $this->_form_html_filter->filterHtml( |
|
| 516 | - $this->_get_display_strategy()->display(), |
|
| 517 | - $this |
|
| 518 | - ) |
|
| 519 | - : $this->_get_display_strategy()->display(); |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - |
|
| 523 | - |
|
| 524 | - /** |
|
| 525 | - * @return string |
|
| 526 | - */ |
|
| 527 | - public function html_other_attributes() |
|
| 528 | - { |
|
| 529 | - return ! empty($this->_html_other_attributes) ? ' ' . $this->_html_other_attributes : ''; |
|
| 530 | - } |
|
| 531 | - |
|
| 532 | - |
|
| 533 | - |
|
| 534 | - /** |
|
| 535 | - * @param string $html_other_attributes |
|
| 536 | - */ |
|
| 537 | - public function set_html_other_attributes($html_other_attributes) |
|
| 538 | - { |
|
| 539 | - $this->_html_other_attributes = $html_other_attributes; |
|
| 540 | - } |
|
| 541 | - |
|
| 542 | - |
|
| 543 | - |
|
| 544 | - /** |
|
| 545 | - * Gets the HTML for displaying the label for this form input |
|
| 546 | - * according to the form section's layout strategy |
|
| 547 | - * |
|
| 548 | - * @return string |
|
| 549 | - */ |
|
| 550 | - public function get_html_for_label() |
|
| 551 | - { |
|
| 552 | - return $this->_parent_section->get_layout_strategy()->display_label($this); |
|
| 553 | - } |
|
| 554 | - |
|
| 555 | - |
|
| 556 | - |
|
| 557 | - /** |
|
| 558 | - * Gets the HTML for displaying the errors section for this form input |
|
| 559 | - * according to the form section's layout strategy |
|
| 560 | - * |
|
| 561 | - * @return string |
|
| 562 | - */ |
|
| 563 | - public function get_html_for_errors() |
|
| 564 | - { |
|
| 565 | - return $this->_parent_section->get_layout_strategy()->display_errors($this); |
|
| 566 | - } |
|
| 567 | - |
|
| 568 | - |
|
| 569 | - |
|
| 570 | - /** |
|
| 571 | - * Gets the HTML for displaying the help text for this form input |
|
| 572 | - * according to the form section's layout strategy |
|
| 573 | - * |
|
| 574 | - * @return string |
|
| 575 | - */ |
|
| 576 | - public function get_html_for_help() |
|
| 577 | - { |
|
| 578 | - return $this->_parent_section->get_layout_strategy()->display_help_text($this); |
|
| 579 | - } |
|
| 580 | - |
|
| 581 | - |
|
| 582 | - |
|
| 583 | - /** |
|
| 584 | - * Validates the input's sanitized value (assumes _sanitize() has already been called) |
|
| 585 | - * and returns whether or not the form input's submitted value is value |
|
| 586 | - * |
|
| 587 | - * @return boolean |
|
| 588 | - */ |
|
| 589 | - protected function _validate() |
|
| 590 | - { |
|
| 591 | - if ($this->isDisabled()) { |
|
| 592 | - return true; |
|
| 593 | - } |
|
| 594 | - foreach ($this->_validation_strategies as $validation_strategy) { |
|
| 595 | - if ($validation_strategy instanceof EE_Validation_Strategy_Base) { |
|
| 596 | - try { |
|
| 597 | - $validation_strategy->validate($this->normalized_value()); |
|
| 598 | - } catch (EE_Validation_Error $e) { |
|
| 599 | - $this->add_validation_error($e); |
|
| 600 | - } |
|
| 601 | - } |
|
| 602 | - } |
|
| 603 | - if ($this->get_validation_errors()) { |
|
| 604 | - return false; |
|
| 605 | - } else { |
|
| 606 | - return true; |
|
| 607 | - } |
|
| 608 | - } |
|
| 609 | - |
|
| 610 | - |
|
| 611 | - |
|
| 612 | - /** |
|
| 613 | - * Performs basic sanitization on this value. But what sanitization can be performed anyways? |
|
| 614 | - * This value MIGHT be allowed to have tags, so we can't really remove them. |
|
| 615 | - * |
|
| 616 | - * @param string $value |
|
| 617 | - * @return null|string |
|
| 618 | - */ |
|
| 619 | - protected function _sanitize($value) |
|
| 620 | - { |
|
| 621 | - return $value !== null ? stripslashes(html_entity_decode(trim($value))) : null; |
|
| 622 | - } |
|
| 623 | - |
|
| 624 | - |
|
| 625 | - |
|
| 626 | - /** |
|
| 627 | - * Picks out the form value that relates to this form input, |
|
| 628 | - * and stores it as the sanitized value on the form input, and sets the normalized value. |
|
| 629 | - * Returns whether or not any validation errors occurred |
|
| 630 | - * |
|
| 631 | - * @param array $req_data like $_POST |
|
| 632 | - * @return boolean whether or not there was an error |
|
| 633 | - * @throws \EE_Error |
|
| 634 | - */ |
|
| 635 | - protected function _normalize($req_data) |
|
| 636 | - { |
|
| 637 | - // any existing validation errors don't apply so clear them |
|
| 638 | - $this->_validation_errors = array(); |
|
| 639 | - // if the input is disabled, ignore whatever input was sent in |
|
| 640 | - if ($this->isDisabled()) { |
|
| 641 | - $this->_set_raw_value(null); |
|
| 642 | - $this->_set_normalized_value($this->get_default()); |
|
| 643 | - return false; |
|
| 644 | - } |
|
| 645 | - try { |
|
| 646 | - $raw_input = $this->find_form_data_for_this_section($req_data); |
|
| 647 | - // super simple sanitization for now |
|
| 648 | - if (is_array($raw_input)) { |
|
| 649 | - $raw_value = array(); |
|
| 650 | - foreach ($raw_input as $key => $value) { |
|
| 651 | - $raw_value[ $key ] = $this->_sanitize($value); |
|
| 652 | - } |
|
| 653 | - $this->_set_raw_value($raw_value); |
|
| 654 | - } else { |
|
| 655 | - $this->_set_raw_value($this->_sanitize($raw_input)); |
|
| 656 | - } |
|
| 657 | - // we want to mostly leave the input alone in case we need to re-display it to the user |
|
| 658 | - $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value())); |
|
| 659 | - return false; |
|
| 660 | - } catch (EE_Validation_Error $e) { |
|
| 661 | - $this->add_validation_error($e); |
|
| 662 | - return true; |
|
| 663 | - } |
|
| 664 | - } |
|
| 665 | - |
|
| 666 | - |
|
| 667 | - |
|
| 668 | - /** |
|
| 669 | - * @return string |
|
| 670 | - */ |
|
| 671 | - public function html_name() |
|
| 672 | - { |
|
| 673 | - $this->_set_default_html_name_if_empty(); |
|
| 674 | - return $this->_html_name; |
|
| 675 | - } |
|
| 676 | - |
|
| 677 | - |
|
| 678 | - |
|
| 679 | - /** |
|
| 680 | - * @return string |
|
| 681 | - */ |
|
| 682 | - public function html_label_id() |
|
| 683 | - { |
|
| 684 | - return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id() . '-lbl'; |
|
| 685 | - } |
|
| 686 | - |
|
| 687 | - |
|
| 688 | - |
|
| 689 | - /** |
|
| 690 | - * @return string |
|
| 691 | - */ |
|
| 692 | - public function html_label_class() |
|
| 693 | - { |
|
| 694 | - return $this->_html_label_class; |
|
| 695 | - } |
|
| 696 | - |
|
| 697 | - |
|
| 698 | - |
|
| 699 | - /** |
|
| 700 | - * @return string |
|
| 701 | - */ |
|
| 702 | - public function html_label_style() |
|
| 703 | - { |
|
| 704 | - return $this->_html_label_style; |
|
| 705 | - } |
|
| 706 | - |
|
| 707 | - |
|
| 708 | - |
|
| 709 | - /** |
|
| 710 | - * @return string |
|
| 711 | - */ |
|
| 712 | - public function html_label_text() |
|
| 713 | - { |
|
| 714 | - return $this->_html_label_text; |
|
| 715 | - } |
|
| 716 | - |
|
| 717 | - |
|
| 718 | - |
|
| 719 | - /** |
|
| 720 | - * @return string |
|
| 721 | - */ |
|
| 722 | - public function html_help_text() |
|
| 723 | - { |
|
| 724 | - return $this->_html_help_text; |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - |
|
| 728 | - |
|
| 729 | - /** |
|
| 730 | - * @return string |
|
| 731 | - */ |
|
| 732 | - public function html_help_class() |
|
| 733 | - { |
|
| 734 | - return $this->_html_help_class; |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - |
|
| 738 | - |
|
| 739 | - /** |
|
| 740 | - * @return string |
|
| 741 | - */ |
|
| 742 | - public function html_help_style() |
|
| 743 | - { |
|
| 744 | - return $this->_html_style; |
|
| 745 | - } |
|
| 746 | - |
|
| 747 | - |
|
| 748 | - |
|
| 749 | - /** |
|
| 750 | - * returns the raw, UNSAFE, input, almost exactly as the user submitted it. |
|
| 751 | - * Please note that almost all client code should instead use the normalized_value; |
|
| 752 | - * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag, |
|
| 753 | - * mostly by escaping quotes) |
|
| 754 | - * Note, we do not store the exact original value sent in the user's request because |
|
| 755 | - * it may have malicious content, and we MIGHT want to store the form input in a transient or something... |
|
| 756 | - * in which case, we would have stored the malicious content to our database. |
|
| 757 | - * |
|
| 758 | - * @return string |
|
| 759 | - */ |
|
| 760 | - public function raw_value() |
|
| 761 | - { |
|
| 762 | - return $this->_raw_value; |
|
| 763 | - } |
|
| 764 | - |
|
| 765 | - |
|
| 766 | - |
|
| 767 | - /** |
|
| 768 | - * Returns a string safe to usage in form inputs when displaying, because |
|
| 769 | - * it escapes all html entities |
|
| 770 | - * |
|
| 771 | - * @return string |
|
| 772 | - */ |
|
| 773 | - public function raw_value_in_form() |
|
| 774 | - { |
|
| 775 | - return htmlentities($this->raw_value(), ENT_QUOTES, 'UTF-8'); |
|
| 776 | - } |
|
| 777 | - |
|
| 778 | - |
|
| 779 | - |
|
| 780 | - /** |
|
| 781 | - * returns the value after it's been sanitized, and then converted into it's proper type |
|
| 782 | - * in PHP. Eg, a string, an int, an array, |
|
| 783 | - * |
|
| 784 | - * @return mixed |
|
| 785 | - */ |
|
| 786 | - public function normalized_value() |
|
| 787 | - { |
|
| 788 | - return $this->_normalized_value; |
|
| 789 | - } |
|
| 790 | - |
|
| 791 | - |
|
| 792 | - |
|
| 793 | - /** |
|
| 794 | - * Returns the normalized value is a presentable way. By default this is just |
|
| 795 | - * the normalized value by itself, but it can be overridden for when that's not |
|
| 796 | - * the best thing to display |
|
| 797 | - * |
|
| 798 | - * @return string |
|
| 799 | - */ |
|
| 800 | - public function pretty_value() |
|
| 801 | - { |
|
| 802 | - return $this->_normalized_value; |
|
| 803 | - } |
|
| 804 | - |
|
| 805 | - |
|
| 806 | - |
|
| 807 | - /** |
|
| 808 | - * When generating the JS for the jquery validation rules like<br> |
|
| 809 | - * <code>$( "#myform" ).validate({ |
|
| 810 | - * rules: { |
|
| 811 | - * password: "required", |
|
| 812 | - * password_again: { |
|
| 813 | - * equalTo: "#password" |
|
| 814 | - * } |
|
| 815 | - * } |
|
| 816 | - * });</code> |
|
| 817 | - * if this field had the name 'password_again', it should return |
|
| 818 | - * <br><code>password_again: { |
|
| 819 | - * equalTo: "#password" |
|
| 820 | - * }</code> |
|
| 821 | - * |
|
| 822 | - * @return array |
|
| 823 | - */ |
|
| 824 | - public function get_jquery_validation_rules() |
|
| 825 | - { |
|
| 826 | - $jquery_validation_js = array(); |
|
| 827 | - $jquery_validation_rules = array(); |
|
| 828 | - foreach ($this->get_validation_strategies() as $validation_strategy) { |
|
| 829 | - $jquery_validation_rules = array_replace_recursive( |
|
| 830 | - $jquery_validation_rules, |
|
| 831 | - $validation_strategy->get_jquery_validation_rule_array() |
|
| 832 | - ); |
|
| 833 | - } |
|
| 834 | - if (! empty($jquery_validation_rules)) { |
|
| 835 | - foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) { |
|
| 836 | - $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules; |
|
| 837 | - } |
|
| 838 | - } |
|
| 839 | - return $jquery_validation_js; |
|
| 840 | - } |
|
| 841 | - |
|
| 842 | - |
|
| 843 | - |
|
| 844 | - /** |
|
| 845 | - * Sets the input's default value for use in displaying in the form. Note: value should be |
|
| 846 | - * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0') |
|
| 847 | - * |
|
| 848 | - * @param mixed $value |
|
| 849 | - * @return void |
|
| 850 | - */ |
|
| 851 | - public function set_default($value) |
|
| 852 | - { |
|
| 853 | - $this->_default = $value; |
|
| 854 | - $this->_set_normalized_value($value); |
|
| 855 | - $this->_set_raw_value($value); |
|
| 856 | - } |
|
| 857 | - |
|
| 858 | - |
|
| 859 | - |
|
| 860 | - /** |
|
| 861 | - * Sets the normalized value on this input |
|
| 862 | - * |
|
| 863 | - * @param mixed $value |
|
| 864 | - */ |
|
| 865 | - protected function _set_normalized_value($value) |
|
| 866 | - { |
|
| 867 | - $this->_normalized_value = $value; |
|
| 868 | - } |
|
| 869 | - |
|
| 870 | - |
|
| 871 | - |
|
| 872 | - /** |
|
| 873 | - * Sets the raw value on this input (ie, exactly as the user submitted it) |
|
| 874 | - * |
|
| 875 | - * @param mixed $value |
|
| 876 | - */ |
|
| 877 | - protected function _set_raw_value($value) |
|
| 878 | - { |
|
| 879 | - $this->_raw_value = $this->_normalization_strategy->unnormalize($value); |
|
| 880 | - } |
|
| 881 | - |
|
| 882 | - |
|
| 883 | - |
|
| 884 | - /** |
|
| 885 | - * Sets the HTML label text after it has already been defined |
|
| 886 | - * |
|
| 887 | - * @param string $label |
|
| 888 | - * @return void |
|
| 889 | - */ |
|
| 890 | - public function set_html_label_text($label) |
|
| 891 | - { |
|
| 892 | - $this->_html_label_text = $label; |
|
| 893 | - } |
|
| 894 | - |
|
| 895 | - |
|
| 896 | - |
|
| 897 | - /** |
|
| 898 | - * Sets whether or not this field is required, and adjusts the validation strategy. |
|
| 899 | - * If you want to use the EE_Conditionally_Required_Validation_Strategy, |
|
| 900 | - * please add it as a validation strategy using add_validation_strategy as normal |
|
| 901 | - * |
|
| 902 | - * @param boolean $required boolean |
|
| 903 | - * @param null $required_text |
|
| 904 | - */ |
|
| 905 | - public function set_required($required = true, $required_text = null) |
|
| 906 | - { |
|
| 907 | - $required = filter_var($required, FILTER_VALIDATE_BOOLEAN); |
|
| 908 | - // whether $required is a string or a boolean, we want to add a required validation strategy |
|
| 909 | - if ($required) { |
|
| 910 | - $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text)); |
|
| 911 | - } else { |
|
| 912 | - $this->remove_validation_strategy('EE_Required_Validation_Strategy'); |
|
| 913 | - } |
|
| 914 | - $this->_required = $required; |
|
| 915 | - } |
|
| 916 | - |
|
| 917 | - |
|
| 918 | - |
|
| 919 | - /** |
|
| 920 | - * Returns whether or not this field is required |
|
| 921 | - * |
|
| 922 | - * @return boolean |
|
| 923 | - */ |
|
| 924 | - public function required() |
|
| 925 | - { |
|
| 926 | - return $this->_required; |
|
| 927 | - } |
|
| 928 | - |
|
| 929 | - |
|
| 930 | - |
|
| 931 | - /** |
|
| 932 | - * @param string $required_css_class |
|
| 933 | - */ |
|
| 934 | - public function set_required_css_class($required_css_class) |
|
| 935 | - { |
|
| 936 | - $this->_required_css_class = $required_css_class; |
|
| 937 | - } |
|
| 938 | - |
|
| 939 | - |
|
| 940 | - |
|
| 941 | - /** |
|
| 942 | - * @return string |
|
| 943 | - */ |
|
| 944 | - public function required_css_class() |
|
| 945 | - { |
|
| 946 | - return $this->_required_css_class; |
|
| 947 | - } |
|
| 948 | - |
|
| 949 | - |
|
| 950 | - |
|
| 951 | - /** |
|
| 952 | - * @param bool $add_required |
|
| 953 | - * @return string |
|
| 954 | - */ |
|
| 955 | - public function html_class($add_required = false) |
|
| 956 | - { |
|
| 957 | - return $add_required && $this->required() |
|
| 958 | - ? $this->required_css_class() . ' ' . $this->_html_class |
|
| 959 | - : $this->_html_class; |
|
| 960 | - } |
|
| 961 | - |
|
| 962 | - |
|
| 963 | - /** |
|
| 964 | - * Sets the help text, in case |
|
| 965 | - * |
|
| 966 | - * @param string $text |
|
| 967 | - */ |
|
| 968 | - public function set_html_help_text($text) |
|
| 969 | - { |
|
| 970 | - $this->_html_help_text = $text; |
|
| 971 | - } |
|
| 972 | - |
|
| 973 | - |
|
| 974 | - |
|
| 975 | - /** |
|
| 976 | - * Uses the sensitive data removal strategy to remove the sensitive data from this |
|
| 977 | - * input. If there is any kind of sensitive data removal on this input, we clear |
|
| 978 | - * out the raw value completely |
|
| 979 | - * |
|
| 980 | - * @return void |
|
| 981 | - */ |
|
| 982 | - public function clean_sensitive_data() |
|
| 983 | - { |
|
| 984 | - // if we do ANY kind of sensitive data removal on this, then just clear out the raw value |
|
| 985 | - // if we need more logic than this we'll make a strategy for it |
|
| 986 | - if ($this->_sensitive_data_removal_strategy |
|
| 987 | - && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal |
|
| 988 | - ) { |
|
| 989 | - $this->_set_raw_value(null); |
|
| 990 | - } |
|
| 991 | - // and clean the normalized value according to the appropriate strategy |
|
| 992 | - $this->_set_normalized_value( |
|
| 993 | - $this->get_sensitive_data_removal_strategy()->remove_sensitive_data( |
|
| 994 | - $this->_normalized_value |
|
| 995 | - ) |
|
| 996 | - ); |
|
| 997 | - } |
|
| 998 | - |
|
| 999 | - |
|
| 1000 | - |
|
| 1001 | - /** |
|
| 1002 | - * @param bool $primary |
|
| 1003 | - * @param string $button_size |
|
| 1004 | - * @param string $other_attributes |
|
| 1005 | - */ |
|
| 1006 | - public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '') |
|
| 1007 | - { |
|
| 1008 | - $button_css_attributes = 'button'; |
|
| 1009 | - $button_css_attributes .= $primary === true ? ' button-primary' : ' button-secondary'; |
|
| 1010 | - switch ($button_size) { |
|
| 1011 | - case 'xs': |
|
| 1012 | - case 'extra-small': |
|
| 1013 | - $button_css_attributes .= ' button-xs'; |
|
| 1014 | - break; |
|
| 1015 | - case 'sm': |
|
| 1016 | - case 'small': |
|
| 1017 | - $button_css_attributes .= ' button-sm'; |
|
| 1018 | - break; |
|
| 1019 | - case 'lg': |
|
| 1020 | - case 'large': |
|
| 1021 | - $button_css_attributes .= ' button-lg'; |
|
| 1022 | - break; |
|
| 1023 | - case 'block': |
|
| 1024 | - $button_css_attributes .= ' button-block'; |
|
| 1025 | - break; |
|
| 1026 | - case 'md': |
|
| 1027 | - case 'medium': |
|
| 1028 | - default: |
|
| 1029 | - $button_css_attributes .= ''; |
|
| 1030 | - } |
|
| 1031 | - $this->_button_css_attributes .= ! empty($other_attributes) |
|
| 1032 | - ? $button_css_attributes . ' ' . $other_attributes |
|
| 1033 | - : $button_css_attributes; |
|
| 1034 | - } |
|
| 1035 | - |
|
| 1036 | - |
|
| 1037 | - |
|
| 1038 | - /** |
|
| 1039 | - * @return string |
|
| 1040 | - */ |
|
| 1041 | - public function button_css_attributes() |
|
| 1042 | - { |
|
| 1043 | - if (empty($this->_button_css_attributes)) { |
|
| 1044 | - $this->set_button_css_attributes(); |
|
| 1045 | - } |
|
| 1046 | - return $this->_button_css_attributes; |
|
| 1047 | - } |
|
| 1048 | - |
|
| 1049 | - |
|
| 1050 | - |
|
| 1051 | - /** |
|
| 1052 | - * find_form_data_for_this_section |
|
| 1053 | - * using this section's name and its parents, finds the value of the form data that corresponds to it. |
|
| 1054 | - * For example, if this form section's HTML name is my_form[subform][form_input_1], |
|
| 1055 | - * then it's value should be in $_REQUEST at $_REQUEST['my_form']['subform']['form_input_1']. |
|
| 1056 | - * (If that doesn't exist, we also check for this subsection's name |
|
| 1057 | - * at the TOP LEVEL of the request data. Eg $_REQUEST['form_input_1'].) |
|
| 1058 | - * This function finds its value in the form. |
|
| 1059 | - * |
|
| 1060 | - * @param array $req_data |
|
| 1061 | - * @return mixed whatever the raw value of this form section is in the request data |
|
| 1062 | - * @throws \EE_Error |
|
| 1063 | - */ |
|
| 1064 | - public function find_form_data_for_this_section($req_data) |
|
| 1065 | - { |
|
| 1066 | - $name_parts = $this->getInputNameParts(); |
|
| 1067 | - // now get the value for the input |
|
| 1068 | - $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data); |
|
| 1069 | - // check if this thing's name is at the TOP level of the request data |
|
| 1070 | - if ($value === null && isset($req_data[ $this->name() ])) { |
|
| 1071 | - $value = $req_data[ $this->name() ]; |
|
| 1072 | - } |
|
| 1073 | - return $value; |
|
| 1074 | - } |
|
| 1075 | - |
|
| 1076 | - |
|
| 1077 | - |
|
| 1078 | - /** |
|
| 1079 | - * If this input's name is something like "foo[bar][baz]" |
|
| 1080 | - * returns an array like `array('foo','bar',baz')` |
|
| 1081 | - * @return array |
|
| 1082 | - */ |
|
| 1083 | - protected function getInputNameParts() |
|
| 1084 | - { |
|
| 1085 | - // break up the html name by "[]" |
|
| 1086 | - if (strpos($this->html_name(), '[') !== false) { |
|
| 1087 | - $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '[')); |
|
| 1088 | - } else { |
|
| 1089 | - $before_any_brackets = $this->html_name(); |
|
| 1090 | - } |
|
| 1091 | - // grab all of the segments |
|
| 1092 | - preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches); |
|
| 1093 | - if (isset($matches[1]) && is_array($matches[1])) { |
|
| 1094 | - $name_parts = $matches[1]; |
|
| 1095 | - array_unshift($name_parts, $before_any_brackets); |
|
| 1096 | - } else { |
|
| 1097 | - $name_parts = array($before_any_brackets); |
|
| 1098 | - } |
|
| 1099 | - return $name_parts; |
|
| 1100 | - } |
|
| 1101 | - |
|
| 1102 | - |
|
| 1103 | - |
|
| 1104 | - /** |
|
| 1105 | - * @param array $html_name_parts |
|
| 1106 | - * @param array $req_data |
|
| 1107 | - * @return array | NULL |
|
| 1108 | - */ |
|
| 1109 | - public function findRequestForSectionUsingNameParts($html_name_parts, $req_data) |
|
| 1110 | - { |
|
| 1111 | - $first_part_to_consider = array_shift($html_name_parts); |
|
| 1112 | - if (isset($req_data[ $first_part_to_consider ])) { |
|
| 1113 | - if (empty($html_name_parts)) { |
|
| 1114 | - return $req_data[ $first_part_to_consider ]; |
|
| 1115 | - } else { |
|
| 1116 | - return $this->findRequestForSectionUsingNameParts( |
|
| 1117 | - $html_name_parts, |
|
| 1118 | - $req_data[ $first_part_to_consider ] |
|
| 1119 | - ); |
|
| 1120 | - } |
|
| 1121 | - } else { |
|
| 1122 | - return null; |
|
| 1123 | - } |
|
| 1124 | - } |
|
| 1125 | - |
|
| 1126 | - |
|
| 1127 | - |
|
| 1128 | - /** |
|
| 1129 | - * Checks if this form input's data is in the request data |
|
| 1130 | - * |
|
| 1131 | - * @param array $req_data like $_POST |
|
| 1132 | - * @return boolean |
|
| 1133 | - * @throws \EE_Error |
|
| 1134 | - */ |
|
| 1135 | - public function form_data_present_in($req_data = null) |
|
| 1136 | - { |
|
| 1137 | - if ($req_data === null) { |
|
| 1138 | - $req_data = $_POST; |
|
| 1139 | - } |
|
| 1140 | - $checked_value = $this->find_form_data_for_this_section($req_data); |
|
| 1141 | - if ($checked_value !== null) { |
|
| 1142 | - return true; |
|
| 1143 | - } else { |
|
| 1144 | - return false; |
|
| 1145 | - } |
|
| 1146 | - } |
|
| 1147 | - |
|
| 1148 | - |
|
| 1149 | - |
|
| 1150 | - /** |
|
| 1151 | - * Overrides parent to add js data from validation and display strategies |
|
| 1152 | - * |
|
| 1153 | - * @param array $form_other_js_data |
|
| 1154 | - * @return array |
|
| 1155 | - */ |
|
| 1156 | - public function get_other_js_data($form_other_js_data = array()) |
|
| 1157 | - { |
|
| 1158 | - $form_other_js_data = $this->get_other_js_data_from_strategies($form_other_js_data); |
|
| 1159 | - return $form_other_js_data; |
|
| 1160 | - } |
|
| 1161 | - |
|
| 1162 | - |
|
| 1163 | - |
|
| 1164 | - /** |
|
| 1165 | - * Gets other JS data for localization from this input's strategies, like |
|
| 1166 | - * the validation strategies and the display strategy |
|
| 1167 | - * |
|
| 1168 | - * @param array $form_other_js_data |
|
| 1169 | - * @return array |
|
| 1170 | - */ |
|
| 1171 | - public function get_other_js_data_from_strategies($form_other_js_data = array()) |
|
| 1172 | - { |
|
| 1173 | - $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data); |
|
| 1174 | - foreach ($this->get_validation_strategies() as $validation_strategy) { |
|
| 1175 | - $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data); |
|
| 1176 | - } |
|
| 1177 | - return $form_other_js_data; |
|
| 1178 | - } |
|
| 1179 | - |
|
| 1180 | - |
|
| 1181 | - |
|
| 1182 | - /** |
|
| 1183 | - * Override parent because we want to give our strategies an opportunity to enqueue some js and css |
|
| 1184 | - * |
|
| 1185 | - * @return void |
|
| 1186 | - */ |
|
| 1187 | - public function enqueue_js() |
|
| 1188 | - { |
|
| 1189 | - // ask our display strategy and validation strategies if they have js to enqueue |
|
| 1190 | - $this->enqueue_js_from_strategies(); |
|
| 1191 | - } |
|
| 1192 | - |
|
| 1193 | - |
|
| 1194 | - |
|
| 1195 | - /** |
|
| 1196 | - * Tells strategies when its ok to enqueue their js and css |
|
| 1197 | - * |
|
| 1198 | - * @return void |
|
| 1199 | - */ |
|
| 1200 | - public function enqueue_js_from_strategies() |
|
| 1201 | - { |
|
| 1202 | - $this->get_display_strategy()->enqueue_js(); |
|
| 1203 | - foreach ($this->get_validation_strategies() as $validation_strategy) { |
|
| 1204 | - $validation_strategy->enqueue_js(); |
|
| 1205 | - } |
|
| 1206 | - } |
|
| 1207 | - |
|
| 1208 | - |
|
| 1209 | - |
|
| 1210 | - /** |
|
| 1211 | - * Gets the default value set on the input (not the current value, which may have been |
|
| 1212 | - * changed because of a form submission). If no default was set, this us null. |
|
| 1213 | - * @return mixed |
|
| 1214 | - */ |
|
| 1215 | - public function get_default() |
|
| 1216 | - { |
|
| 1217 | - return $this->_default; |
|
| 1218 | - } |
|
| 1219 | - |
|
| 1220 | - |
|
| 1221 | - |
|
| 1222 | - /** |
|
| 1223 | - * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"', |
|
| 1224 | - * and server-side if any input was received it will be ignored |
|
| 1225 | - */ |
|
| 1226 | - public function disable($disable = true) |
|
| 1227 | - { |
|
| 1228 | - $disabled_attribute = ' disabled="disabled"'; |
|
| 1229 | - $this->disabled = filter_var($disable, FILTER_VALIDATE_BOOLEAN); |
|
| 1230 | - if ($this->disabled) { |
|
| 1231 | - if (strpos($this->_other_html_attributes, $disabled_attribute) === false) { |
|
| 1232 | - $this->_other_html_attributes .= $disabled_attribute; |
|
| 1233 | - } |
|
| 1234 | - $this->_set_normalized_value($this->get_default()); |
|
| 1235 | - } else { |
|
| 1236 | - $this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes); |
|
| 1237 | - } |
|
| 1238 | - } |
|
| 1239 | - |
|
| 1240 | - |
|
| 1241 | - |
|
| 1242 | - /** |
|
| 1243 | - * Returns whether or not this input is currently disabled. |
|
| 1244 | - * @return bool |
|
| 1245 | - */ |
|
| 1246 | - public function isDisabled() |
|
| 1247 | - { |
|
| 1248 | - return $this->disabled; |
|
| 1249 | - } |
|
| 14 | + /** |
|
| 15 | + * the input's name attribute |
|
| 16 | + * |
|
| 17 | + * @var string |
|
| 18 | + */ |
|
| 19 | + protected $_html_name; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * id for the html label tag |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $_html_label_id; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * class for teh html label tag |
|
| 30 | + * |
|
| 31 | + * @var string |
|
| 32 | + */ |
|
| 33 | + protected $_html_label_class; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * any additional html attributes that you may want to add |
|
| 37 | + * |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | + protected $_html_other_attributes; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * style for teh html label tag |
|
| 44 | + * |
|
| 45 | + * @var string |
|
| 46 | + */ |
|
| 47 | + protected $_html_label_style; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * text to be placed in the html label |
|
| 51 | + * |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | + protected $_html_label_text; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * the full html label. If used, all other html_label_* properties are invalid |
|
| 58 | + * |
|
| 59 | + * @var string |
|
| 60 | + */ |
|
| 61 | + protected $_html_label; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * HTML to use for help text (normally placed below form input), in a span which normally |
|
| 65 | + * has a class of 'description' |
|
| 66 | + * |
|
| 67 | + * @var string |
|
| 68 | + */ |
|
| 69 | + protected $_html_help_text; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * CSS classes for displaying the help span |
|
| 73 | + * |
|
| 74 | + * @var string |
|
| 75 | + */ |
|
| 76 | + protected $_html_help_class = 'description'; |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * CSS to put in the style attribute on the help span |
|
| 80 | + * |
|
| 81 | + * @var string |
|
| 82 | + */ |
|
| 83 | + protected $_html_help_style; |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Stores whether or not this input's response is required. |
|
| 87 | + * Because certain styling elements may also want to know that this |
|
| 88 | + * input is required etc. |
|
| 89 | + * |
|
| 90 | + * @var boolean |
|
| 91 | + */ |
|
| 92 | + protected $_required; |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * css class added to required inputs |
|
| 96 | + * |
|
| 97 | + * @var string |
|
| 98 | + */ |
|
| 99 | + protected $_required_css_class = 'ee-required'; |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * css styles applied to button type inputs |
|
| 103 | + * |
|
| 104 | + * @var string |
|
| 105 | + */ |
|
| 106 | + protected $_button_css_attributes; |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * The raw data submitted for this, like in the $_POST super global. |
|
| 110 | + * Generally unsafe for usage in client code |
|
| 111 | + * |
|
| 112 | + * @var mixed string or array |
|
| 113 | + */ |
|
| 114 | + protected $_raw_value; |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * Value normalized according to the input's normalization strategy. |
|
| 118 | + * The normalization strategy dictates whether this is a string, int, float, |
|
| 119 | + * boolean, or array of any of those. |
|
| 120 | + * |
|
| 121 | + * @var mixed |
|
| 122 | + */ |
|
| 123 | + protected $_normalized_value; |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * Normalized default value either initially set on the input, or provided by calling |
|
| 128 | + * set_default(). |
|
| 129 | + * @var mixed |
|
| 130 | + */ |
|
| 131 | + protected $_default; |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Strategy used for displaying this field. |
|
| 135 | + * Child classes must use _get_display_strategy to access it. |
|
| 136 | + * |
|
| 137 | + * @var EE_Display_Strategy_Base |
|
| 138 | + */ |
|
| 139 | + private $_display_strategy; |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * Gets all the validation strategies used on this field |
|
| 143 | + * |
|
| 144 | + * @var EE_Validation_Strategy_Base[] |
|
| 145 | + */ |
|
| 146 | + private $_validation_strategies = array(); |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * The normalization strategy for this field |
|
| 150 | + * |
|
| 151 | + * @var EE_Normalization_Strategy_Base |
|
| 152 | + */ |
|
| 153 | + private $_normalization_strategy; |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Strategy for removing sensitive data after we're done with the form input |
|
| 157 | + * |
|
| 158 | + * @var EE_Sensitive_Data_Removal_Base |
|
| 159 | + */ |
|
| 160 | + protected $_sensitive_data_removal_strategy; |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * Whether this input has been disabled or not. |
|
| 164 | + * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled. |
|
| 165 | + * (Client-side code that wants to dynamically disable it must also add this hidden input). |
|
| 166 | + * When the form is submitted, if the input is disabled in the PHP formsection, then input is ignored. |
|
| 167 | + * If the input is missing from the $_REQUEST data but the hidden input indicating the input is disabled, then the input is again ignored. |
|
| 168 | + * |
|
| 169 | + * @var boolean |
|
| 170 | + */ |
|
| 171 | + protected $disabled = false; |
|
| 172 | + |
|
| 173 | + |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * @param array $input_args { |
|
| 177 | + * @type string $html_name the html name for the input |
|
| 178 | + * @type string $html_label_id the id attribute to give to the html label tag |
|
| 179 | + * @type string $html_label_class the class attribute to give to the html label tag |
|
| 180 | + * @type string $html_label_style the style attribute to give ot teh label tag |
|
| 181 | + * @type string $html_label_text the text to put in the label tag |
|
| 182 | + * @type string $html_label the full html label. If used, |
|
| 183 | + * all other html_label_* args are invalid |
|
| 184 | + * @type string $html_help_text text to put in help element |
|
| 185 | + * @type string $html_help_style style attribute to give to teh help element |
|
| 186 | + * @type string $html_help_class class attribute to give to the help element |
|
| 187 | + * @type string $default default value NORMALIZED (eg, if providing the default |
|
| 188 | + * for a Yes_No_Input, you should provide TRUE or FALSE, not '1' or '0') |
|
| 189 | + * @type EE_Display_Strategy_Base $display strategy |
|
| 190 | + * @type EE_Normalization_Strategy_Base $normalization_strategy |
|
| 191 | + * @type EE_Validation_Strategy_Base[] $validation_strategies |
|
| 192 | + * @type boolean $ignore_input special argument which can be used to avoid adding any validation strategies, |
|
| 193 | + * and sets the normalization strategy to the Null normalization. This is good |
|
| 194 | + * when you want the input to be totally ignored server-side (like when using |
|
| 195 | + * React.js form inputs) |
|
| 196 | + * } |
|
| 197 | + */ |
|
| 198 | + public function __construct($input_args = array()) |
|
| 199 | + { |
|
| 200 | + $input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this); |
|
| 201 | + // the following properties must be cast as arrays |
|
| 202 | + if (isset($input_args['validation_strategies'])) { |
|
| 203 | + foreach ((array) $input_args['validation_strategies'] as $validation_strategy) { |
|
| 204 | + if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) { |
|
| 205 | + $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy; |
|
| 206 | + } |
|
| 207 | + } |
|
| 208 | + unset($input_args['validation_strategies']); |
|
| 209 | + } |
|
| 210 | + if (isset($input_args['ignore_input'])) { |
|
| 211 | + $this->_validation_strategies = array(); |
|
| 212 | + } |
|
| 213 | + // loop thru incoming options |
|
| 214 | + foreach ($input_args as $key => $value) { |
|
| 215 | + // add underscore to $key to match property names |
|
| 216 | + $_key = '_' . $key; |
|
| 217 | + if (property_exists($this, $_key)) { |
|
| 218 | + $this->{$_key} = $value; |
|
| 219 | + } |
|
| 220 | + } |
|
| 221 | + // ensure that "required" is set correctly |
|
| 222 | + $this->set_required( |
|
| 223 | + $this->_required, |
|
| 224 | + isset($input_args['required_validation_error_message']) |
|
| 225 | + ? $input_args['required_validation_error_message'] |
|
| 226 | + : null |
|
| 227 | + ); |
|
| 228 | + // $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE; |
|
| 229 | + $this->_display_strategy->_construct_finalize($this); |
|
| 230 | + foreach ($this->_validation_strategies as $validation_strategy) { |
|
| 231 | + $validation_strategy->_construct_finalize($this); |
|
| 232 | + } |
|
| 233 | + if (isset($input_args['ignore_input'])) { |
|
| 234 | + $this->_normalization_strategy = new EE_Null_Normalization(); |
|
| 235 | + } |
|
| 236 | + if (! $this->_normalization_strategy) { |
|
| 237 | + $this->_normalization_strategy = new EE_Text_Normalization(); |
|
| 238 | + } |
|
| 239 | + $this->_normalization_strategy->_construct_finalize($this); |
|
| 240 | + // at least we can use the normalization strategy to populate the default |
|
| 241 | + if (isset($input_args['default'])) { |
|
| 242 | + $this->set_default($input_args['default']); |
|
| 243 | + unset($input_args['default']); |
|
| 244 | + } |
|
| 245 | + if (! $this->_sensitive_data_removal_strategy) { |
|
| 246 | + $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal(); |
|
| 247 | + } |
|
| 248 | + $this->_sensitive_data_removal_strategy->_construct_finalize($this); |
|
| 249 | + parent::__construct($input_args); |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + |
|
| 253 | + |
|
| 254 | + /** |
|
| 255 | + * Sets the html_name to its default value, if none was specified in teh constructor. |
|
| 256 | + * Calculation involves using the name and the parent's html_name |
|
| 257 | + * |
|
| 258 | + * @throws \EE_Error |
|
| 259 | + */ |
|
| 260 | + protected function _set_default_html_name_if_empty() |
|
| 261 | + { |
|
| 262 | + if (! $this->_html_name) { |
|
| 263 | + $this->_html_name = $this->name(); |
|
| 264 | + if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) { |
|
| 265 | + $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]"; |
|
| 266 | + } |
|
| 267 | + } |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + |
|
| 271 | + |
|
| 272 | + /** |
|
| 273 | + * @param $parent_form_section |
|
| 274 | + * @param $name |
|
| 275 | + * @throws \EE_Error |
|
| 276 | + */ |
|
| 277 | + public function _construct_finalize($parent_form_section, $name) |
|
| 278 | + { |
|
| 279 | + parent::_construct_finalize($parent_form_section, $name); |
|
| 280 | + if ($this->_html_label === null && $this->_html_label_text === null) { |
|
| 281 | + $this->_html_label_text = ucwords(str_replace("_", " ", $name)); |
|
| 282 | + } |
|
| 283 | + do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name); |
|
| 284 | + } |
|
| 285 | + |
|
| 286 | + |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Returns the strategy for displaying this form input. If none is set, throws an exception. |
|
| 290 | + * |
|
| 291 | + * @return EE_Display_Strategy_Base |
|
| 292 | + * @throws EE_Error |
|
| 293 | + */ |
|
| 294 | + protected function _get_display_strategy() |
|
| 295 | + { |
|
| 296 | + $this->ensure_construct_finalized_called(); |
|
| 297 | + if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) { |
|
| 298 | + throw new EE_Error( |
|
| 299 | + sprintf( |
|
| 300 | + __( |
|
| 301 | + "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor", |
|
| 302 | + "event_espresso" |
|
| 303 | + ), |
|
| 304 | + $this->html_name(), |
|
| 305 | + $this->html_id() |
|
| 306 | + ) |
|
| 307 | + ); |
|
| 308 | + } else { |
|
| 309 | + return $this->_display_strategy; |
|
| 310 | + } |
|
| 311 | + } |
|
| 312 | + |
|
| 313 | + |
|
| 314 | + |
|
| 315 | + /** |
|
| 316 | + * Sets the display strategy. |
|
| 317 | + * |
|
| 318 | + * @param EE_Display_Strategy_Base $strategy |
|
| 319 | + */ |
|
| 320 | + protected function _set_display_strategy(EE_Display_Strategy_Base $strategy) |
|
| 321 | + { |
|
| 322 | + $this->_display_strategy = $strategy; |
|
| 323 | + } |
|
| 324 | + |
|
| 325 | + |
|
| 326 | + |
|
| 327 | + /** |
|
| 328 | + * Sets the sanitization strategy |
|
| 329 | + * |
|
| 330 | + * @param EE_Normalization_Strategy_Base $strategy |
|
| 331 | + */ |
|
| 332 | + protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy) |
|
| 333 | + { |
|
| 334 | + $this->_normalization_strategy = $strategy; |
|
| 335 | + } |
|
| 336 | + |
|
| 337 | + |
|
| 338 | + |
|
| 339 | + /** |
|
| 340 | + * Gets sensitive_data_removal_strategy |
|
| 341 | + * |
|
| 342 | + * @return EE_Sensitive_Data_Removal_Base |
|
| 343 | + */ |
|
| 344 | + public function get_sensitive_data_removal_strategy() |
|
| 345 | + { |
|
| 346 | + return $this->_sensitive_data_removal_strategy; |
|
| 347 | + } |
|
| 348 | + |
|
| 349 | + |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Sets sensitive_data_removal_strategy |
|
| 353 | + * |
|
| 354 | + * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy |
|
| 355 | + * @return boolean |
|
| 356 | + */ |
|
| 357 | + public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy) |
|
| 358 | + { |
|
| 359 | + $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy; |
|
| 360 | + } |
|
| 361 | + |
|
| 362 | + |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * Gets the display strategy for this input |
|
| 366 | + * |
|
| 367 | + * @return EE_Display_Strategy_Base |
|
| 368 | + */ |
|
| 369 | + public function get_display_strategy() |
|
| 370 | + { |
|
| 371 | + return $this->_display_strategy; |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + |
|
| 375 | + |
|
| 376 | + /** |
|
| 377 | + * Overwrites the display strategy |
|
| 378 | + * |
|
| 379 | + * @param EE_Display_Strategy_Base $display_strategy |
|
| 380 | + */ |
|
| 381 | + public function set_display_strategy($display_strategy) |
|
| 382 | + { |
|
| 383 | + $this->_display_strategy = $display_strategy; |
|
| 384 | + $this->_display_strategy->_construct_finalize($this); |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + |
|
| 388 | + |
|
| 389 | + /** |
|
| 390 | + * Gets the normalization strategy set on this input |
|
| 391 | + * |
|
| 392 | + * @return EE_Normalization_Strategy_Base |
|
| 393 | + */ |
|
| 394 | + public function get_normalization_strategy() |
|
| 395 | + { |
|
| 396 | + return $this->_normalization_strategy; |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + |
|
| 400 | + |
|
| 401 | + /** |
|
| 402 | + * Overwrites the normalization strategy |
|
| 403 | + * |
|
| 404 | + * @param EE_Normalization_Strategy_Base $normalization_strategy |
|
| 405 | + */ |
|
| 406 | + public function set_normalization_strategy($normalization_strategy) |
|
| 407 | + { |
|
| 408 | + $this->_normalization_strategy = $normalization_strategy; |
|
| 409 | + $this->_normalization_strategy->_construct_finalize($this); |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + |
|
| 413 | + |
|
| 414 | + /** |
|
| 415 | + * Returns all teh validation strategies which apply to this field, numerically indexed |
|
| 416 | + * |
|
| 417 | + * @return EE_Validation_Strategy_Base[] |
|
| 418 | + */ |
|
| 419 | + public function get_validation_strategies() |
|
| 420 | + { |
|
| 421 | + return $this->_validation_strategies; |
|
| 422 | + } |
|
| 423 | + |
|
| 424 | + |
|
| 425 | + |
|
| 426 | + /** |
|
| 427 | + * Adds this strategy to the field so it will be used in both JS validation and server-side validation |
|
| 428 | + * |
|
| 429 | + * @param EE_Validation_Strategy_Base $validation_strategy |
|
| 430 | + * @return void |
|
| 431 | + */ |
|
| 432 | + protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy) |
|
| 433 | + { |
|
| 434 | + $validation_strategy->_construct_finalize($this); |
|
| 435 | + $this->_validation_strategies[] = $validation_strategy; |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + |
|
| 439 | + |
|
| 440 | + /** |
|
| 441 | + * Adds a new validation strategy onto the form input |
|
| 442 | + * |
|
| 443 | + * @param EE_Validation_Strategy_Base $validation_strategy |
|
| 444 | + * @return void |
|
| 445 | + */ |
|
| 446 | + public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy) |
|
| 447 | + { |
|
| 448 | + $this->_add_validation_strategy($validation_strategy); |
|
| 449 | + } |
|
| 450 | + |
|
| 451 | + |
|
| 452 | + |
|
| 453 | + /** |
|
| 454 | + * The classname of the validation strategy to remove |
|
| 455 | + * |
|
| 456 | + * @param string $validation_strategy_classname |
|
| 457 | + */ |
|
| 458 | + public function remove_validation_strategy($validation_strategy_classname) |
|
| 459 | + { |
|
| 460 | + foreach ($this->_validation_strategies as $key => $validation_strategy) { |
|
| 461 | + if ($validation_strategy instanceof $validation_strategy_classname |
|
| 462 | + || is_subclass_of($validation_strategy, $validation_strategy_classname) |
|
| 463 | + ) { |
|
| 464 | + unset($this->_validation_strategies[ $key ]); |
|
| 465 | + } |
|
| 466 | + } |
|
| 467 | + } |
|
| 468 | + |
|
| 469 | + |
|
| 470 | + |
|
| 471 | + /** |
|
| 472 | + * returns true if input employs any of the validation strategy defined by the supplied array of classnames |
|
| 473 | + * |
|
| 474 | + * @param array $validation_strategy_classnames |
|
| 475 | + * @return bool |
|
| 476 | + */ |
|
| 477 | + public function has_validation_strategy($validation_strategy_classnames) |
|
| 478 | + { |
|
| 479 | + $validation_strategy_classnames = is_array($validation_strategy_classnames) |
|
| 480 | + ? $validation_strategy_classnames |
|
| 481 | + : array($validation_strategy_classnames); |
|
| 482 | + foreach ($this->_validation_strategies as $key => $validation_strategy) { |
|
| 483 | + if (in_array($key, $validation_strategy_classnames)) { |
|
| 484 | + return true; |
|
| 485 | + } |
|
| 486 | + } |
|
| 487 | + return false; |
|
| 488 | + } |
|
| 489 | + |
|
| 490 | + |
|
| 491 | + |
|
| 492 | + /** |
|
| 493 | + * Gets the HTML |
|
| 494 | + * |
|
| 495 | + * @return string |
|
| 496 | + */ |
|
| 497 | + public function get_html() |
|
| 498 | + { |
|
| 499 | + return $this->_parent_section->get_html_for_input($this); |
|
| 500 | + } |
|
| 501 | + |
|
| 502 | + |
|
| 503 | + |
|
| 504 | + /** |
|
| 505 | + * Gets the HTML for the input itself (no label or errors) according to the |
|
| 506 | + * input's display strategy |
|
| 507 | + * Makes sure the JS and CSS are enqueued for it |
|
| 508 | + * |
|
| 509 | + * @return string |
|
| 510 | + * @throws \EE_Error |
|
| 511 | + */ |
|
| 512 | + public function get_html_for_input() |
|
| 513 | + { |
|
| 514 | + return $this->_form_html_filter |
|
| 515 | + ? $this->_form_html_filter->filterHtml( |
|
| 516 | + $this->_get_display_strategy()->display(), |
|
| 517 | + $this |
|
| 518 | + ) |
|
| 519 | + : $this->_get_display_strategy()->display(); |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + |
|
| 523 | + |
|
| 524 | + /** |
|
| 525 | + * @return string |
|
| 526 | + */ |
|
| 527 | + public function html_other_attributes() |
|
| 528 | + { |
|
| 529 | + return ! empty($this->_html_other_attributes) ? ' ' . $this->_html_other_attributes : ''; |
|
| 530 | + } |
|
| 531 | + |
|
| 532 | + |
|
| 533 | + |
|
| 534 | + /** |
|
| 535 | + * @param string $html_other_attributes |
|
| 536 | + */ |
|
| 537 | + public function set_html_other_attributes($html_other_attributes) |
|
| 538 | + { |
|
| 539 | + $this->_html_other_attributes = $html_other_attributes; |
|
| 540 | + } |
|
| 541 | + |
|
| 542 | + |
|
| 543 | + |
|
| 544 | + /** |
|
| 545 | + * Gets the HTML for displaying the label for this form input |
|
| 546 | + * according to the form section's layout strategy |
|
| 547 | + * |
|
| 548 | + * @return string |
|
| 549 | + */ |
|
| 550 | + public function get_html_for_label() |
|
| 551 | + { |
|
| 552 | + return $this->_parent_section->get_layout_strategy()->display_label($this); |
|
| 553 | + } |
|
| 554 | + |
|
| 555 | + |
|
| 556 | + |
|
| 557 | + /** |
|
| 558 | + * Gets the HTML for displaying the errors section for this form input |
|
| 559 | + * according to the form section's layout strategy |
|
| 560 | + * |
|
| 561 | + * @return string |
|
| 562 | + */ |
|
| 563 | + public function get_html_for_errors() |
|
| 564 | + { |
|
| 565 | + return $this->_parent_section->get_layout_strategy()->display_errors($this); |
|
| 566 | + } |
|
| 567 | + |
|
| 568 | + |
|
| 569 | + |
|
| 570 | + /** |
|
| 571 | + * Gets the HTML for displaying the help text for this form input |
|
| 572 | + * according to the form section's layout strategy |
|
| 573 | + * |
|
| 574 | + * @return string |
|
| 575 | + */ |
|
| 576 | + public function get_html_for_help() |
|
| 577 | + { |
|
| 578 | + return $this->_parent_section->get_layout_strategy()->display_help_text($this); |
|
| 579 | + } |
|
| 580 | + |
|
| 581 | + |
|
| 582 | + |
|
| 583 | + /** |
|
| 584 | + * Validates the input's sanitized value (assumes _sanitize() has already been called) |
|
| 585 | + * and returns whether or not the form input's submitted value is value |
|
| 586 | + * |
|
| 587 | + * @return boolean |
|
| 588 | + */ |
|
| 589 | + protected function _validate() |
|
| 590 | + { |
|
| 591 | + if ($this->isDisabled()) { |
|
| 592 | + return true; |
|
| 593 | + } |
|
| 594 | + foreach ($this->_validation_strategies as $validation_strategy) { |
|
| 595 | + if ($validation_strategy instanceof EE_Validation_Strategy_Base) { |
|
| 596 | + try { |
|
| 597 | + $validation_strategy->validate($this->normalized_value()); |
|
| 598 | + } catch (EE_Validation_Error $e) { |
|
| 599 | + $this->add_validation_error($e); |
|
| 600 | + } |
|
| 601 | + } |
|
| 602 | + } |
|
| 603 | + if ($this->get_validation_errors()) { |
|
| 604 | + return false; |
|
| 605 | + } else { |
|
| 606 | + return true; |
|
| 607 | + } |
|
| 608 | + } |
|
| 609 | + |
|
| 610 | + |
|
| 611 | + |
|
| 612 | + /** |
|
| 613 | + * Performs basic sanitization on this value. But what sanitization can be performed anyways? |
|
| 614 | + * This value MIGHT be allowed to have tags, so we can't really remove them. |
|
| 615 | + * |
|
| 616 | + * @param string $value |
|
| 617 | + * @return null|string |
|
| 618 | + */ |
|
| 619 | + protected function _sanitize($value) |
|
| 620 | + { |
|
| 621 | + return $value !== null ? stripslashes(html_entity_decode(trim($value))) : null; |
|
| 622 | + } |
|
| 623 | + |
|
| 624 | + |
|
| 625 | + |
|
| 626 | + /** |
|
| 627 | + * Picks out the form value that relates to this form input, |
|
| 628 | + * and stores it as the sanitized value on the form input, and sets the normalized value. |
|
| 629 | + * Returns whether or not any validation errors occurred |
|
| 630 | + * |
|
| 631 | + * @param array $req_data like $_POST |
|
| 632 | + * @return boolean whether or not there was an error |
|
| 633 | + * @throws \EE_Error |
|
| 634 | + */ |
|
| 635 | + protected function _normalize($req_data) |
|
| 636 | + { |
|
| 637 | + // any existing validation errors don't apply so clear them |
|
| 638 | + $this->_validation_errors = array(); |
|
| 639 | + // if the input is disabled, ignore whatever input was sent in |
|
| 640 | + if ($this->isDisabled()) { |
|
| 641 | + $this->_set_raw_value(null); |
|
| 642 | + $this->_set_normalized_value($this->get_default()); |
|
| 643 | + return false; |
|
| 644 | + } |
|
| 645 | + try { |
|
| 646 | + $raw_input = $this->find_form_data_for_this_section($req_data); |
|
| 647 | + // super simple sanitization for now |
|
| 648 | + if (is_array($raw_input)) { |
|
| 649 | + $raw_value = array(); |
|
| 650 | + foreach ($raw_input as $key => $value) { |
|
| 651 | + $raw_value[ $key ] = $this->_sanitize($value); |
|
| 652 | + } |
|
| 653 | + $this->_set_raw_value($raw_value); |
|
| 654 | + } else { |
|
| 655 | + $this->_set_raw_value($this->_sanitize($raw_input)); |
|
| 656 | + } |
|
| 657 | + // we want to mostly leave the input alone in case we need to re-display it to the user |
|
| 658 | + $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value())); |
|
| 659 | + return false; |
|
| 660 | + } catch (EE_Validation_Error $e) { |
|
| 661 | + $this->add_validation_error($e); |
|
| 662 | + return true; |
|
| 663 | + } |
|
| 664 | + } |
|
| 665 | + |
|
| 666 | + |
|
| 667 | + |
|
| 668 | + /** |
|
| 669 | + * @return string |
|
| 670 | + */ |
|
| 671 | + public function html_name() |
|
| 672 | + { |
|
| 673 | + $this->_set_default_html_name_if_empty(); |
|
| 674 | + return $this->_html_name; |
|
| 675 | + } |
|
| 676 | + |
|
| 677 | + |
|
| 678 | + |
|
| 679 | + /** |
|
| 680 | + * @return string |
|
| 681 | + */ |
|
| 682 | + public function html_label_id() |
|
| 683 | + { |
|
| 684 | + return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id() . '-lbl'; |
|
| 685 | + } |
|
| 686 | + |
|
| 687 | + |
|
| 688 | + |
|
| 689 | + /** |
|
| 690 | + * @return string |
|
| 691 | + */ |
|
| 692 | + public function html_label_class() |
|
| 693 | + { |
|
| 694 | + return $this->_html_label_class; |
|
| 695 | + } |
|
| 696 | + |
|
| 697 | + |
|
| 698 | + |
|
| 699 | + /** |
|
| 700 | + * @return string |
|
| 701 | + */ |
|
| 702 | + public function html_label_style() |
|
| 703 | + { |
|
| 704 | + return $this->_html_label_style; |
|
| 705 | + } |
|
| 706 | + |
|
| 707 | + |
|
| 708 | + |
|
| 709 | + /** |
|
| 710 | + * @return string |
|
| 711 | + */ |
|
| 712 | + public function html_label_text() |
|
| 713 | + { |
|
| 714 | + return $this->_html_label_text; |
|
| 715 | + } |
|
| 716 | + |
|
| 717 | + |
|
| 718 | + |
|
| 719 | + /** |
|
| 720 | + * @return string |
|
| 721 | + */ |
|
| 722 | + public function html_help_text() |
|
| 723 | + { |
|
| 724 | + return $this->_html_help_text; |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + |
|
| 728 | + |
|
| 729 | + /** |
|
| 730 | + * @return string |
|
| 731 | + */ |
|
| 732 | + public function html_help_class() |
|
| 733 | + { |
|
| 734 | + return $this->_html_help_class; |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + |
|
| 738 | + |
|
| 739 | + /** |
|
| 740 | + * @return string |
|
| 741 | + */ |
|
| 742 | + public function html_help_style() |
|
| 743 | + { |
|
| 744 | + return $this->_html_style; |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + |
|
| 748 | + |
|
| 749 | + /** |
|
| 750 | + * returns the raw, UNSAFE, input, almost exactly as the user submitted it. |
|
| 751 | + * Please note that almost all client code should instead use the normalized_value; |
|
| 752 | + * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag, |
|
| 753 | + * mostly by escaping quotes) |
|
| 754 | + * Note, we do not store the exact original value sent in the user's request because |
|
| 755 | + * it may have malicious content, and we MIGHT want to store the form input in a transient or something... |
|
| 756 | + * in which case, we would have stored the malicious content to our database. |
|
| 757 | + * |
|
| 758 | + * @return string |
|
| 759 | + */ |
|
| 760 | + public function raw_value() |
|
| 761 | + { |
|
| 762 | + return $this->_raw_value; |
|
| 763 | + } |
|
| 764 | + |
|
| 765 | + |
|
| 766 | + |
|
| 767 | + /** |
|
| 768 | + * Returns a string safe to usage in form inputs when displaying, because |
|
| 769 | + * it escapes all html entities |
|
| 770 | + * |
|
| 771 | + * @return string |
|
| 772 | + */ |
|
| 773 | + public function raw_value_in_form() |
|
| 774 | + { |
|
| 775 | + return htmlentities($this->raw_value(), ENT_QUOTES, 'UTF-8'); |
|
| 776 | + } |
|
| 777 | + |
|
| 778 | + |
|
| 779 | + |
|
| 780 | + /** |
|
| 781 | + * returns the value after it's been sanitized, and then converted into it's proper type |
|
| 782 | + * in PHP. Eg, a string, an int, an array, |
|
| 783 | + * |
|
| 784 | + * @return mixed |
|
| 785 | + */ |
|
| 786 | + public function normalized_value() |
|
| 787 | + { |
|
| 788 | + return $this->_normalized_value; |
|
| 789 | + } |
|
| 790 | + |
|
| 791 | + |
|
| 792 | + |
|
| 793 | + /** |
|
| 794 | + * Returns the normalized value is a presentable way. By default this is just |
|
| 795 | + * the normalized value by itself, but it can be overridden for when that's not |
|
| 796 | + * the best thing to display |
|
| 797 | + * |
|
| 798 | + * @return string |
|
| 799 | + */ |
|
| 800 | + public function pretty_value() |
|
| 801 | + { |
|
| 802 | + return $this->_normalized_value; |
|
| 803 | + } |
|
| 804 | + |
|
| 805 | + |
|
| 806 | + |
|
| 807 | + /** |
|
| 808 | + * When generating the JS for the jquery validation rules like<br> |
|
| 809 | + * <code>$( "#myform" ).validate({ |
|
| 810 | + * rules: { |
|
| 811 | + * password: "required", |
|
| 812 | + * password_again: { |
|
| 813 | + * equalTo: "#password" |
|
| 814 | + * } |
|
| 815 | + * } |
|
| 816 | + * });</code> |
|
| 817 | + * if this field had the name 'password_again', it should return |
|
| 818 | + * <br><code>password_again: { |
|
| 819 | + * equalTo: "#password" |
|
| 820 | + * }</code> |
|
| 821 | + * |
|
| 822 | + * @return array |
|
| 823 | + */ |
|
| 824 | + public function get_jquery_validation_rules() |
|
| 825 | + { |
|
| 826 | + $jquery_validation_js = array(); |
|
| 827 | + $jquery_validation_rules = array(); |
|
| 828 | + foreach ($this->get_validation_strategies() as $validation_strategy) { |
|
| 829 | + $jquery_validation_rules = array_replace_recursive( |
|
| 830 | + $jquery_validation_rules, |
|
| 831 | + $validation_strategy->get_jquery_validation_rule_array() |
|
| 832 | + ); |
|
| 833 | + } |
|
| 834 | + if (! empty($jquery_validation_rules)) { |
|
| 835 | + foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) { |
|
| 836 | + $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules; |
|
| 837 | + } |
|
| 838 | + } |
|
| 839 | + return $jquery_validation_js; |
|
| 840 | + } |
|
| 841 | + |
|
| 842 | + |
|
| 843 | + |
|
| 844 | + /** |
|
| 845 | + * Sets the input's default value for use in displaying in the form. Note: value should be |
|
| 846 | + * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0') |
|
| 847 | + * |
|
| 848 | + * @param mixed $value |
|
| 849 | + * @return void |
|
| 850 | + */ |
|
| 851 | + public function set_default($value) |
|
| 852 | + { |
|
| 853 | + $this->_default = $value; |
|
| 854 | + $this->_set_normalized_value($value); |
|
| 855 | + $this->_set_raw_value($value); |
|
| 856 | + } |
|
| 857 | + |
|
| 858 | + |
|
| 859 | + |
|
| 860 | + /** |
|
| 861 | + * Sets the normalized value on this input |
|
| 862 | + * |
|
| 863 | + * @param mixed $value |
|
| 864 | + */ |
|
| 865 | + protected function _set_normalized_value($value) |
|
| 866 | + { |
|
| 867 | + $this->_normalized_value = $value; |
|
| 868 | + } |
|
| 869 | + |
|
| 870 | + |
|
| 871 | + |
|
| 872 | + /** |
|
| 873 | + * Sets the raw value on this input (ie, exactly as the user submitted it) |
|
| 874 | + * |
|
| 875 | + * @param mixed $value |
|
| 876 | + */ |
|
| 877 | + protected function _set_raw_value($value) |
|
| 878 | + { |
|
| 879 | + $this->_raw_value = $this->_normalization_strategy->unnormalize($value); |
|
| 880 | + } |
|
| 881 | + |
|
| 882 | + |
|
| 883 | + |
|
| 884 | + /** |
|
| 885 | + * Sets the HTML label text after it has already been defined |
|
| 886 | + * |
|
| 887 | + * @param string $label |
|
| 888 | + * @return void |
|
| 889 | + */ |
|
| 890 | + public function set_html_label_text($label) |
|
| 891 | + { |
|
| 892 | + $this->_html_label_text = $label; |
|
| 893 | + } |
|
| 894 | + |
|
| 895 | + |
|
| 896 | + |
|
| 897 | + /** |
|
| 898 | + * Sets whether or not this field is required, and adjusts the validation strategy. |
|
| 899 | + * If you want to use the EE_Conditionally_Required_Validation_Strategy, |
|
| 900 | + * please add it as a validation strategy using add_validation_strategy as normal |
|
| 901 | + * |
|
| 902 | + * @param boolean $required boolean |
|
| 903 | + * @param null $required_text |
|
| 904 | + */ |
|
| 905 | + public function set_required($required = true, $required_text = null) |
|
| 906 | + { |
|
| 907 | + $required = filter_var($required, FILTER_VALIDATE_BOOLEAN); |
|
| 908 | + // whether $required is a string or a boolean, we want to add a required validation strategy |
|
| 909 | + if ($required) { |
|
| 910 | + $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text)); |
|
| 911 | + } else { |
|
| 912 | + $this->remove_validation_strategy('EE_Required_Validation_Strategy'); |
|
| 913 | + } |
|
| 914 | + $this->_required = $required; |
|
| 915 | + } |
|
| 916 | + |
|
| 917 | + |
|
| 918 | + |
|
| 919 | + /** |
|
| 920 | + * Returns whether or not this field is required |
|
| 921 | + * |
|
| 922 | + * @return boolean |
|
| 923 | + */ |
|
| 924 | + public function required() |
|
| 925 | + { |
|
| 926 | + return $this->_required; |
|
| 927 | + } |
|
| 928 | + |
|
| 929 | + |
|
| 930 | + |
|
| 931 | + /** |
|
| 932 | + * @param string $required_css_class |
|
| 933 | + */ |
|
| 934 | + public function set_required_css_class($required_css_class) |
|
| 935 | + { |
|
| 936 | + $this->_required_css_class = $required_css_class; |
|
| 937 | + } |
|
| 938 | + |
|
| 939 | + |
|
| 940 | + |
|
| 941 | + /** |
|
| 942 | + * @return string |
|
| 943 | + */ |
|
| 944 | + public function required_css_class() |
|
| 945 | + { |
|
| 946 | + return $this->_required_css_class; |
|
| 947 | + } |
|
| 948 | + |
|
| 949 | + |
|
| 950 | + |
|
| 951 | + /** |
|
| 952 | + * @param bool $add_required |
|
| 953 | + * @return string |
|
| 954 | + */ |
|
| 955 | + public function html_class($add_required = false) |
|
| 956 | + { |
|
| 957 | + return $add_required && $this->required() |
|
| 958 | + ? $this->required_css_class() . ' ' . $this->_html_class |
|
| 959 | + : $this->_html_class; |
|
| 960 | + } |
|
| 961 | + |
|
| 962 | + |
|
| 963 | + /** |
|
| 964 | + * Sets the help text, in case |
|
| 965 | + * |
|
| 966 | + * @param string $text |
|
| 967 | + */ |
|
| 968 | + public function set_html_help_text($text) |
|
| 969 | + { |
|
| 970 | + $this->_html_help_text = $text; |
|
| 971 | + } |
|
| 972 | + |
|
| 973 | + |
|
| 974 | + |
|
| 975 | + /** |
|
| 976 | + * Uses the sensitive data removal strategy to remove the sensitive data from this |
|
| 977 | + * input. If there is any kind of sensitive data removal on this input, we clear |
|
| 978 | + * out the raw value completely |
|
| 979 | + * |
|
| 980 | + * @return void |
|
| 981 | + */ |
|
| 982 | + public function clean_sensitive_data() |
|
| 983 | + { |
|
| 984 | + // if we do ANY kind of sensitive data removal on this, then just clear out the raw value |
|
| 985 | + // if we need more logic than this we'll make a strategy for it |
|
| 986 | + if ($this->_sensitive_data_removal_strategy |
|
| 987 | + && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal |
|
| 988 | + ) { |
|
| 989 | + $this->_set_raw_value(null); |
|
| 990 | + } |
|
| 991 | + // and clean the normalized value according to the appropriate strategy |
|
| 992 | + $this->_set_normalized_value( |
|
| 993 | + $this->get_sensitive_data_removal_strategy()->remove_sensitive_data( |
|
| 994 | + $this->_normalized_value |
|
| 995 | + ) |
|
| 996 | + ); |
|
| 997 | + } |
|
| 998 | + |
|
| 999 | + |
|
| 1000 | + |
|
| 1001 | + /** |
|
| 1002 | + * @param bool $primary |
|
| 1003 | + * @param string $button_size |
|
| 1004 | + * @param string $other_attributes |
|
| 1005 | + */ |
|
| 1006 | + public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '') |
|
| 1007 | + { |
|
| 1008 | + $button_css_attributes = 'button'; |
|
| 1009 | + $button_css_attributes .= $primary === true ? ' button-primary' : ' button-secondary'; |
|
| 1010 | + switch ($button_size) { |
|
| 1011 | + case 'xs': |
|
| 1012 | + case 'extra-small': |
|
| 1013 | + $button_css_attributes .= ' button-xs'; |
|
| 1014 | + break; |
|
| 1015 | + case 'sm': |
|
| 1016 | + case 'small': |
|
| 1017 | + $button_css_attributes .= ' button-sm'; |
|
| 1018 | + break; |
|
| 1019 | + case 'lg': |
|
| 1020 | + case 'large': |
|
| 1021 | + $button_css_attributes .= ' button-lg'; |
|
| 1022 | + break; |
|
| 1023 | + case 'block': |
|
| 1024 | + $button_css_attributes .= ' button-block'; |
|
| 1025 | + break; |
|
| 1026 | + case 'md': |
|
| 1027 | + case 'medium': |
|
| 1028 | + default: |
|
| 1029 | + $button_css_attributes .= ''; |
|
| 1030 | + } |
|
| 1031 | + $this->_button_css_attributes .= ! empty($other_attributes) |
|
| 1032 | + ? $button_css_attributes . ' ' . $other_attributes |
|
| 1033 | + : $button_css_attributes; |
|
| 1034 | + } |
|
| 1035 | + |
|
| 1036 | + |
|
| 1037 | + |
|
| 1038 | + /** |
|
| 1039 | + * @return string |
|
| 1040 | + */ |
|
| 1041 | + public function button_css_attributes() |
|
| 1042 | + { |
|
| 1043 | + if (empty($this->_button_css_attributes)) { |
|
| 1044 | + $this->set_button_css_attributes(); |
|
| 1045 | + } |
|
| 1046 | + return $this->_button_css_attributes; |
|
| 1047 | + } |
|
| 1048 | + |
|
| 1049 | + |
|
| 1050 | + |
|
| 1051 | + /** |
|
| 1052 | + * find_form_data_for_this_section |
|
| 1053 | + * using this section's name and its parents, finds the value of the form data that corresponds to it. |
|
| 1054 | + * For example, if this form section's HTML name is my_form[subform][form_input_1], |
|
| 1055 | + * then it's value should be in $_REQUEST at $_REQUEST['my_form']['subform']['form_input_1']. |
|
| 1056 | + * (If that doesn't exist, we also check for this subsection's name |
|
| 1057 | + * at the TOP LEVEL of the request data. Eg $_REQUEST['form_input_1'].) |
|
| 1058 | + * This function finds its value in the form. |
|
| 1059 | + * |
|
| 1060 | + * @param array $req_data |
|
| 1061 | + * @return mixed whatever the raw value of this form section is in the request data |
|
| 1062 | + * @throws \EE_Error |
|
| 1063 | + */ |
|
| 1064 | + public function find_form_data_for_this_section($req_data) |
|
| 1065 | + { |
|
| 1066 | + $name_parts = $this->getInputNameParts(); |
|
| 1067 | + // now get the value for the input |
|
| 1068 | + $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data); |
|
| 1069 | + // check if this thing's name is at the TOP level of the request data |
|
| 1070 | + if ($value === null && isset($req_data[ $this->name() ])) { |
|
| 1071 | + $value = $req_data[ $this->name() ]; |
|
| 1072 | + } |
|
| 1073 | + return $value; |
|
| 1074 | + } |
|
| 1075 | + |
|
| 1076 | + |
|
| 1077 | + |
|
| 1078 | + /** |
|
| 1079 | + * If this input's name is something like "foo[bar][baz]" |
|
| 1080 | + * returns an array like `array('foo','bar',baz')` |
|
| 1081 | + * @return array |
|
| 1082 | + */ |
|
| 1083 | + protected function getInputNameParts() |
|
| 1084 | + { |
|
| 1085 | + // break up the html name by "[]" |
|
| 1086 | + if (strpos($this->html_name(), '[') !== false) { |
|
| 1087 | + $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '[')); |
|
| 1088 | + } else { |
|
| 1089 | + $before_any_brackets = $this->html_name(); |
|
| 1090 | + } |
|
| 1091 | + // grab all of the segments |
|
| 1092 | + preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches); |
|
| 1093 | + if (isset($matches[1]) && is_array($matches[1])) { |
|
| 1094 | + $name_parts = $matches[1]; |
|
| 1095 | + array_unshift($name_parts, $before_any_brackets); |
|
| 1096 | + } else { |
|
| 1097 | + $name_parts = array($before_any_brackets); |
|
| 1098 | + } |
|
| 1099 | + return $name_parts; |
|
| 1100 | + } |
|
| 1101 | + |
|
| 1102 | + |
|
| 1103 | + |
|
| 1104 | + /** |
|
| 1105 | + * @param array $html_name_parts |
|
| 1106 | + * @param array $req_data |
|
| 1107 | + * @return array | NULL |
|
| 1108 | + */ |
|
| 1109 | + public function findRequestForSectionUsingNameParts($html_name_parts, $req_data) |
|
| 1110 | + { |
|
| 1111 | + $first_part_to_consider = array_shift($html_name_parts); |
|
| 1112 | + if (isset($req_data[ $first_part_to_consider ])) { |
|
| 1113 | + if (empty($html_name_parts)) { |
|
| 1114 | + return $req_data[ $first_part_to_consider ]; |
|
| 1115 | + } else { |
|
| 1116 | + return $this->findRequestForSectionUsingNameParts( |
|
| 1117 | + $html_name_parts, |
|
| 1118 | + $req_data[ $first_part_to_consider ] |
|
| 1119 | + ); |
|
| 1120 | + } |
|
| 1121 | + } else { |
|
| 1122 | + return null; |
|
| 1123 | + } |
|
| 1124 | + } |
|
| 1125 | + |
|
| 1126 | + |
|
| 1127 | + |
|
| 1128 | + /** |
|
| 1129 | + * Checks if this form input's data is in the request data |
|
| 1130 | + * |
|
| 1131 | + * @param array $req_data like $_POST |
|
| 1132 | + * @return boolean |
|
| 1133 | + * @throws \EE_Error |
|
| 1134 | + */ |
|
| 1135 | + public function form_data_present_in($req_data = null) |
|
| 1136 | + { |
|
| 1137 | + if ($req_data === null) { |
|
| 1138 | + $req_data = $_POST; |
|
| 1139 | + } |
|
| 1140 | + $checked_value = $this->find_form_data_for_this_section($req_data); |
|
| 1141 | + if ($checked_value !== null) { |
|
| 1142 | + return true; |
|
| 1143 | + } else { |
|
| 1144 | + return false; |
|
| 1145 | + } |
|
| 1146 | + } |
|
| 1147 | + |
|
| 1148 | + |
|
| 1149 | + |
|
| 1150 | + /** |
|
| 1151 | + * Overrides parent to add js data from validation and display strategies |
|
| 1152 | + * |
|
| 1153 | + * @param array $form_other_js_data |
|
| 1154 | + * @return array |
|
| 1155 | + */ |
|
| 1156 | + public function get_other_js_data($form_other_js_data = array()) |
|
| 1157 | + { |
|
| 1158 | + $form_other_js_data = $this->get_other_js_data_from_strategies($form_other_js_data); |
|
| 1159 | + return $form_other_js_data; |
|
| 1160 | + } |
|
| 1161 | + |
|
| 1162 | + |
|
| 1163 | + |
|
| 1164 | + /** |
|
| 1165 | + * Gets other JS data for localization from this input's strategies, like |
|
| 1166 | + * the validation strategies and the display strategy |
|
| 1167 | + * |
|
| 1168 | + * @param array $form_other_js_data |
|
| 1169 | + * @return array |
|
| 1170 | + */ |
|
| 1171 | + public function get_other_js_data_from_strategies($form_other_js_data = array()) |
|
| 1172 | + { |
|
| 1173 | + $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data); |
|
| 1174 | + foreach ($this->get_validation_strategies() as $validation_strategy) { |
|
| 1175 | + $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data); |
|
| 1176 | + } |
|
| 1177 | + return $form_other_js_data; |
|
| 1178 | + } |
|
| 1179 | + |
|
| 1180 | + |
|
| 1181 | + |
|
| 1182 | + /** |
|
| 1183 | + * Override parent because we want to give our strategies an opportunity to enqueue some js and css |
|
| 1184 | + * |
|
| 1185 | + * @return void |
|
| 1186 | + */ |
|
| 1187 | + public function enqueue_js() |
|
| 1188 | + { |
|
| 1189 | + // ask our display strategy and validation strategies if they have js to enqueue |
|
| 1190 | + $this->enqueue_js_from_strategies(); |
|
| 1191 | + } |
|
| 1192 | + |
|
| 1193 | + |
|
| 1194 | + |
|
| 1195 | + /** |
|
| 1196 | + * Tells strategies when its ok to enqueue their js and css |
|
| 1197 | + * |
|
| 1198 | + * @return void |
|
| 1199 | + */ |
|
| 1200 | + public function enqueue_js_from_strategies() |
|
| 1201 | + { |
|
| 1202 | + $this->get_display_strategy()->enqueue_js(); |
|
| 1203 | + foreach ($this->get_validation_strategies() as $validation_strategy) { |
|
| 1204 | + $validation_strategy->enqueue_js(); |
|
| 1205 | + } |
|
| 1206 | + } |
|
| 1207 | + |
|
| 1208 | + |
|
| 1209 | + |
|
| 1210 | + /** |
|
| 1211 | + * Gets the default value set on the input (not the current value, which may have been |
|
| 1212 | + * changed because of a form submission). If no default was set, this us null. |
|
| 1213 | + * @return mixed |
|
| 1214 | + */ |
|
| 1215 | + public function get_default() |
|
| 1216 | + { |
|
| 1217 | + return $this->_default; |
|
| 1218 | + } |
|
| 1219 | + |
|
| 1220 | + |
|
| 1221 | + |
|
| 1222 | + /** |
|
| 1223 | + * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"', |
|
| 1224 | + * and server-side if any input was received it will be ignored |
|
| 1225 | + */ |
|
| 1226 | + public function disable($disable = true) |
|
| 1227 | + { |
|
| 1228 | + $disabled_attribute = ' disabled="disabled"'; |
|
| 1229 | + $this->disabled = filter_var($disable, FILTER_VALIDATE_BOOLEAN); |
|
| 1230 | + if ($this->disabled) { |
|
| 1231 | + if (strpos($this->_other_html_attributes, $disabled_attribute) === false) { |
|
| 1232 | + $this->_other_html_attributes .= $disabled_attribute; |
|
| 1233 | + } |
|
| 1234 | + $this->_set_normalized_value($this->get_default()); |
|
| 1235 | + } else { |
|
| 1236 | + $this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes); |
|
| 1237 | + } |
|
| 1238 | + } |
|
| 1239 | + |
|
| 1240 | + |
|
| 1241 | + |
|
| 1242 | + /** |
|
| 1243 | + * Returns whether or not this input is currently disabled. |
|
| 1244 | + * @return bool |
|
| 1245 | + */ |
|
| 1246 | + public function isDisabled() |
|
| 1247 | + { |
|
| 1248 | + return $this->disabled; |
|
| 1249 | + } |
|
| 1250 | 1250 | } |
@@ -24,666 +24,666 @@ |
||
| 24 | 24 | class EEH_File extends EEH_Base implements EEHI_File |
| 25 | 25 | { |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var string $_credentials_form |
|
| 29 | - */ |
|
| 30 | - private static $_credentials_form; |
|
| 31 | - |
|
| 32 | - protected static $_wp_filesystem_direct; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * @param string|null $filepath the filepath we want to work in. If its in the |
|
| 36 | - * wp uploads directory, we'll want to just use the filesystem directly. |
|
| 37 | - * If not provided, we have to assume its not in the uploads directory |
|
| 38 | - * @throws EE_Error if filesystem credentials are required |
|
| 39 | - * @return WP_Filesystem_Base |
|
| 40 | - */ |
|
| 41 | - private static function _get_wp_filesystem($filepath = null) |
|
| 42 | - { |
|
| 43 | - if (apply_filters( |
|
| 44 | - 'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct', |
|
| 45 | - $filepath && EEH_File::is_in_uploads_folder($filepath), |
|
| 46 | - $filepath |
|
| 47 | - ) ) { |
|
| 48 | - if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) { |
|
| 49 | - require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php'); |
|
| 50 | - $method = 'direct'; |
|
| 51 | - $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method); |
|
| 52 | - // check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem() |
|
| 53 | - if (! defined('FS_CHMOD_DIR')) { |
|
| 54 | - define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 )); |
|
| 55 | - } |
|
| 56 | - if (! defined('FS_CHMOD_FILE')) { |
|
| 57 | - define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 )); |
|
| 58 | - } |
|
| 59 | - require_once($wp_filesystem_direct_file); |
|
| 60 | - EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array()); |
|
| 61 | - } |
|
| 62 | - return EEH_File::$_wp_filesystem_direct; |
|
| 63 | - } |
|
| 64 | - global $wp_filesystem; |
|
| 65 | - // no filesystem setup ??? |
|
| 66 | - if (! $wp_filesystem instanceof WP_Filesystem_Base) { |
|
| 67 | - // if some eager beaver's just trying to get in there too early... |
|
| 68 | - // let them do it, because we are one of those eager beavers! :P |
|
| 69 | - /** |
|
| 70 | - * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base |
|
| 71 | - * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process |
|
| 72 | - * is setup to mostly happen on 'init', and refactoring to have it happen on |
|
| 73 | - * 'wp_loaded' is too much work on a BETA milestone. |
|
| 74 | - * So this fix is expected to work if the WP files are owned by the server user, |
|
| 75 | - * but probably not if the user needs to enter their FTP credentials to modify files |
|
| 76 | - * and there may be troubles if the WP files are owned by a different user |
|
| 77 | - * than the server user. But both of these issues should exist in 4.4 and earlier too |
|
| 78 | - */ |
|
| 79 | - if (false && ! did_action('wp_loaded')) { |
|
| 80 | - $msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'); |
|
| 81 | - if (WP_DEBUG) { |
|
| 82 | - $msg .= '<br />' . __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso'); |
|
| 83 | - } |
|
| 84 | - throw new EE_Error($msg); |
|
| 85 | - } else { |
|
| 86 | - // should be loaded if we are past the wp_loaded hook... |
|
| 87 | - if (! function_exists('WP_Filesystem')) { |
|
| 88 | - require_once(ABSPATH . 'wp-admin/includes/file.php'); |
|
| 89 | - require_once(ABSPATH . 'wp-admin/includes/template.php'); |
|
| 90 | - } |
|
| 91 | - // turn on output buffering so that we can capture the credentials form |
|
| 92 | - ob_start(); |
|
| 93 | - $credentials = request_filesystem_credentials(''); |
|
| 94 | - // store credentials form for the time being |
|
| 95 | - EEH_File::$_credentials_form = ob_get_clean(); |
|
| 96 | - // basically check for direct or previously configured access |
|
| 97 | - if (! WP_Filesystem($credentials)) { |
|
| 98 | - // if credentials do NOT exist |
|
| 99 | - if ($credentials === false) { |
|
| 100 | - add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999); |
|
| 101 | - throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso')); |
|
| 102 | - } elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) { |
|
| 103 | - add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999); |
|
| 104 | - throw new EE_Error( |
|
| 105 | - sprintf( |
|
| 106 | - __('WP Filesystem Error: $1%s', 'event_espresso'), |
|
| 107 | - $wp_filesystem->errors->get_error_message() |
|
| 108 | - ) |
|
| 109 | - ); |
|
| 110 | - } |
|
| 111 | - } |
|
| 112 | - } |
|
| 113 | - } |
|
| 114 | - return $wp_filesystem; |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * display_request_filesystem_credentials_form |
|
| 119 | - */ |
|
| 120 | - public static function display_request_filesystem_credentials_form() |
|
| 121 | - { |
|
| 122 | - if (! empty(EEH_File::$_credentials_form)) { |
|
| 123 | - echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>'; |
|
| 124 | - } |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * verify_filepath_and_permissions |
|
| 131 | - * checks that a file is readable and has sufficient file permissions set to access |
|
| 132 | - * |
|
| 133 | - * @access public |
|
| 134 | - * @param string $full_file_path - full server path to the folder or file |
|
| 135 | - * @param string $file_name - name of file if checking a file |
|
| 136 | - * @param string $file_ext - file extension (ie: "php") if checking a file |
|
| 137 | - * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages |
|
| 138 | - * @throws EE_Error if filesystem credentials are required |
|
| 139 | - * @return bool |
|
| 140 | - */ |
|
| 141 | - public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '') |
|
| 142 | - { |
|
| 143 | - // load WP_Filesystem and set file permissions |
|
| 144 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 145 | - $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 146 | - if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 147 | - $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name; |
|
| 148 | - $file_name .= ! empty($file_ext) ? ' file' : ' folder'; |
|
| 149 | - $msg = sprintf( |
|
| 150 | - __('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'), |
|
| 151 | - $file_name, |
|
| 152 | - '<br />' |
|
| 153 | - ); |
|
| 154 | - if (EEH_File::exists($full_file_path)) { |
|
| 155 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file); |
|
| 156 | - } else { |
|
| 157 | - // no file permissions means the file was not found |
|
| 158 | - $msg .= sprintf( |
|
| 159 | - __('Please ensure the following path is correct: "%s".', 'event_espresso'), |
|
| 160 | - $full_file_path |
|
| 161 | - ); |
|
| 162 | - } |
|
| 163 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 164 | - throw new EE_Error($msg . '||' . $msg); |
|
| 165 | - } |
|
| 166 | - return false; |
|
| 167 | - } |
|
| 168 | - return true; |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder |
|
| 175 | - * |
|
| 176 | - * @access private |
|
| 177 | - * @param string $full_file_path - full server path to the folder or file |
|
| 178 | - * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages |
|
| 179 | - * @throws EE_Error if filesystem credentials are required |
|
| 180 | - * @return string |
|
| 181 | - */ |
|
| 182 | - private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '') |
|
| 183 | - { |
|
| 184 | - // load WP_Filesystem and set file permissions |
|
| 185 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 186 | - // check file permissions |
|
| 187 | - $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)); |
|
| 188 | - if ($perms) { |
|
| 189 | - // file permissions exist, but way be set incorrectly |
|
| 190 | - $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : ''; |
|
| 191 | - $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder'; |
|
| 192 | - return sprintf( |
|
| 193 | - __('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'), |
|
| 194 | - $type_of_file, |
|
| 195 | - $perms |
|
| 196 | - ); |
|
| 197 | - } else { |
|
| 198 | - // file exists but file permissions could not be read ?!?! |
|
| 199 | - return sprintf( |
|
| 200 | - __('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'), |
|
| 201 | - $full_file_path |
|
| 202 | - ); |
|
| 203 | - } |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * ensure_folder_exists_and_is_writable |
|
| 210 | - * ensures that a folder exists and is writable, will attempt to create folder if it does not exist |
|
| 211 | - * Also ensures all the parent folders exist, and if not tries to create them. |
|
| 212 | - * Also, if this function creates the folder, adds a .htaccess file and index.html file |
|
| 213 | - * @param string $folder |
|
| 214 | - * @throws EE_Error if the folder exists and is writeable, but for some reason we |
|
| 215 | - * can't write to it |
|
| 216 | - * @return bool false if folder isn't writable; true if it exists and is writeable, |
|
| 217 | - */ |
|
| 218 | - public static function ensure_folder_exists_and_is_writable($folder = '') |
|
| 219 | - { |
|
| 220 | - if (empty($folder)) { |
|
| 221 | - return false; |
|
| 222 | - } |
|
| 223 | - // remove ending DS |
|
| 224 | - $folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\')); |
|
| 225 | - $parent_folder = EEH_File::get_parent_folder($folder); |
|
| 226 | - // add DS to folder |
|
| 227 | - $folder = EEH_File::end_with_directory_separator($folder); |
|
| 228 | - $wp_filesystem = EEH_File::_get_wp_filesystem($folder); |
|
| 229 | - if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 230 | - // ok so it doesn't exist. Does its parent? Can we write to it? |
|
| 231 | - if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 232 | - return false; |
|
| 233 | - } |
|
| 234 | - if (! EEH_File::verify_is_writable($parent_folder, 'folder')) { |
|
| 235 | - return false; |
|
| 236 | - } else { |
|
| 237 | - if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 238 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 239 | - $msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder); |
|
| 240 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder); |
|
| 241 | - throw new EE_Error($msg); |
|
| 242 | - } |
|
| 243 | - return false; |
|
| 244 | - } |
|
| 245 | - EEH_File::add_index_file($folder); |
|
| 246 | - } |
|
| 247 | - } elseif (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 248 | - return false; |
|
| 249 | - } |
|
| 250 | - return true; |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - |
|
| 254 | - |
|
| 255 | - /** |
|
| 256 | - * verify_is_writable - checks if a file or folder is writable |
|
| 257 | - * @param string $full_path - full server path to file or folder |
|
| 258 | - * @param string $file_or_folder - whether checking a file or folder |
|
| 259 | - * @throws EE_Error if filesystem credentials are required |
|
| 260 | - * @return bool |
|
| 261 | - */ |
|
| 262 | - public static function verify_is_writable($full_path = '', $file_or_folder = 'folder') |
|
| 263 | - { |
|
| 264 | - // load WP_Filesystem and set file permissions |
|
| 265 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_path); |
|
| 266 | - $full_path = EEH_File::standardise_directory_separators($full_path); |
|
| 267 | - if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) { |
|
| 268 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 269 | - $msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder); |
|
| 270 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path); |
|
| 271 | - throw new EE_Error($msg); |
|
| 272 | - } |
|
| 273 | - return false; |
|
| 274 | - } |
|
| 275 | - return true; |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - |
|
| 279 | - |
|
| 280 | - /** |
|
| 281 | - * ensure_file_exists_and_is_writable |
|
| 282 | - * ensures that a file exists and is writable, will attempt to create file if it does not exist. |
|
| 283 | - * Also ensures all the parent folders exist, and if not tries to create them. |
|
| 284 | - * @param string $full_file_path |
|
| 285 | - * @throws EE_Error if filesystem credentials are required |
|
| 286 | - * @return bool |
|
| 287 | - */ |
|
| 288 | - public static function ensure_file_exists_and_is_writable($full_file_path = '') |
|
| 289 | - { |
|
| 290 | - // load WP_Filesystem and set file permissions |
|
| 291 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 292 | - $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 293 | - $parent_folder = EEH_File::get_parent_folder($full_file_path); |
|
| 294 | - if (! EEH_File::exists($full_file_path)) { |
|
| 295 | - if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 296 | - return false; |
|
| 297 | - } |
|
| 298 | - if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 299 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 300 | - $msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path); |
|
| 301 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path); |
|
| 302 | - throw new EE_Error($msg); |
|
| 303 | - } |
|
| 304 | - return false; |
|
| 305 | - } |
|
| 306 | - } |
|
| 307 | - if (! EEH_File::verify_is_writable($full_file_path, 'file')) { |
|
| 308 | - return false; |
|
| 309 | - } |
|
| 310 | - return true; |
|
| 311 | - } |
|
| 312 | - |
|
| 313 | - /** |
|
| 314 | - * Gets the parent folder. If provided with file, gets the folder that contains it. |
|
| 315 | - * If provided a folder, gets its parent folder. |
|
| 316 | - * @param string $file_or_folder_path |
|
| 317 | - * @return string parent folder, ENDING with a directory separator |
|
| 318 | - */ |
|
| 319 | - public static function get_parent_folder($file_or_folder_path) |
|
| 320 | - { |
|
| 321 | - // find the last DS, ignoring a DS on the very end |
|
| 322 | - // eg if given "/var/something/somewhere/", we want to get "somewhere"'s |
|
| 323 | - // parent folder, "/var/something/" |
|
| 324 | - $ds = strlen($file_or_folder_path) > 1 |
|
| 325 | - ? strrpos($file_or_folder_path, DS, -2) |
|
| 326 | - : strlen($file_or_folder_path); |
|
| 327 | - return substr($file_or_folder_path, 0, $ds + 1); |
|
| 328 | - } |
|
| 329 | - |
|
| 330 | - // public static function ensure_folder_exists_recursively( $folder ) { |
|
| 331 | - // |
|
| 332 | - // } |
|
| 333 | - |
|
| 334 | - |
|
| 335 | - |
|
| 336 | - /** |
|
| 337 | - * get_file_contents |
|
| 338 | - * @param string $full_file_path |
|
| 339 | - * @throws EE_Error if filesystem credentials are required |
|
| 340 | - * @return string |
|
| 341 | - */ |
|
| 342 | - public static function get_file_contents($full_file_path = '') |
|
| 343 | - { |
|
| 344 | - $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 345 | - if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) { |
|
| 346 | - // load WP_Filesystem and set file permissions |
|
| 347 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 348 | - return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)); |
|
| 349 | - } |
|
| 350 | - return ''; |
|
| 351 | - } |
|
| 352 | - |
|
| 353 | - |
|
| 354 | - |
|
| 355 | - /** |
|
| 356 | - * write_file |
|
| 357 | - * @param string $full_file_path |
|
| 358 | - * @param string $file_contents - the content to be written to the file |
|
| 359 | - * @param string $file_type |
|
| 360 | - * @throws EE_Error if filesystem credentials are required |
|
| 361 | - * @return bool |
|
| 362 | - */ |
|
| 363 | - public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '') |
|
| 364 | - { |
|
| 365 | - $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 366 | - $file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : ''; |
|
| 367 | - $folder = EEH_File::remove_filename_from_filepath($full_file_path); |
|
| 368 | - if (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 369 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 370 | - $msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path); |
|
| 371 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path); |
|
| 372 | - throw new EE_Error($msg); |
|
| 373 | - } |
|
| 374 | - return false; |
|
| 375 | - } |
|
| 376 | - // load WP_Filesystem and set file permissions |
|
| 377 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 378 | - // write the file |
|
| 379 | - if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) { |
|
| 380 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 381 | - $msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path); |
|
| 382 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f'); |
|
| 383 | - throw new EE_Error($msg); |
|
| 384 | - } |
|
| 385 | - return false; |
|
| 386 | - } |
|
| 387 | - return true; |
|
| 388 | - } |
|
| 389 | - |
|
| 390 | - /** |
|
| 391 | - * Wrapper for WP_Filesystem_Base::delete |
|
| 392 | - * |
|
| 393 | - * @param string $filepath |
|
| 394 | - * @param boolean $recursive |
|
| 395 | - * @param boolean|string $type 'd' for directory, 'f' for file |
|
| 396 | - * @throws EE_Error if filesystem credentials are required |
|
| 397 | - * @return boolean |
|
| 398 | - */ |
|
| 399 | - public static function delete($filepath, $recursive = false, $type = false) |
|
| 400 | - { |
|
| 401 | - $wp_filesystem = EEH_File::_get_wp_filesystem(); |
|
| 402 | - return $wp_filesystem->delete($filepath, $recursive, $type) ? true : false; |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - |
|
| 406 | - |
|
| 407 | - /** |
|
| 408 | - * exists |
|
| 409 | - * checks if a file exists using the WP filesystem |
|
| 410 | - * @param string $full_file_path |
|
| 411 | - * @throws EE_Error if filesystem credentials are required |
|
| 412 | - * @return bool |
|
| 413 | - */ |
|
| 414 | - public static function exists($full_file_path = '') |
|
| 415 | - { |
|
| 416 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 417 | - return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? true : false; |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - |
|
| 421 | - |
|
| 422 | - /** |
|
| 423 | - * is_readable |
|
| 424 | - * checks if a file is_readable using the WP filesystem |
|
| 425 | - * |
|
| 426 | - * @param string $full_file_path |
|
| 427 | - * @throws EE_Error if filesystem credentials are required |
|
| 428 | - * @return bool |
|
| 429 | - */ |
|
| 430 | - public static function is_readable($full_file_path = '') |
|
| 431 | - { |
|
| 432 | - $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 433 | - if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 434 | - return true; |
|
| 435 | - } else { |
|
| 436 | - return false; |
|
| 437 | - } |
|
| 438 | - } |
|
| 439 | - |
|
| 440 | - |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * remove_filename_from_filepath |
|
| 444 | - * given a full path to a file including the filename itself, this removes the filename and returns the path, up to, but NOT including the filename OR slash |
|
| 445 | - * |
|
| 446 | - * @param string $full_file_path |
|
| 447 | - * @return string |
|
| 448 | - */ |
|
| 449 | - public static function remove_filename_from_filepath($full_file_path = '') |
|
| 450 | - { |
|
| 451 | - return pathinfo($full_file_path, PATHINFO_DIRNAME); |
|
| 452 | - } |
|
| 453 | - |
|
| 454 | - |
|
| 455 | - /** |
|
| 456 | - * get_filename_from_filepath. Arguably the same as basename() |
|
| 457 | - * |
|
| 458 | - * @param string $full_file_path |
|
| 459 | - * @return string |
|
| 460 | - */ |
|
| 461 | - public static function get_filename_from_filepath($full_file_path = '') |
|
| 462 | - { |
|
| 463 | - return pathinfo($full_file_path, PATHINFO_BASENAME); |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * get_file_extension |
|
| 469 | - * |
|
| 470 | - * @param string $full_file_path |
|
| 471 | - * @return string |
|
| 472 | - */ |
|
| 473 | - public static function get_file_extension($full_file_path = '') |
|
| 474 | - { |
|
| 475 | - return pathinfo($full_file_path, PATHINFO_EXTENSION); |
|
| 476 | - } |
|
| 477 | - |
|
| 478 | - |
|
| 479 | - |
|
| 480 | - /** |
|
| 481 | - * add_htaccess_deny_from_all so the webserver cannot access this folder |
|
| 482 | - * @param string $folder |
|
| 483 | - * @throws EE_Error if filesystem credentials are required |
|
| 484 | - * @return bool |
|
| 485 | - */ |
|
| 486 | - public static function add_htaccess_deny_from_all($folder = '') |
|
| 487 | - { |
|
| 488 | - $folder = EEH_File::standardise_and_end_with_directory_separator($folder); |
|
| 489 | - if (! EEH_File::exists($folder . '.htaccess')) { |
|
| 490 | - if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) { |
|
| 491 | - return false; |
|
| 492 | - } |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - return true; |
|
| 496 | - } |
|
| 497 | - |
|
| 498 | - /** |
|
| 499 | - * Adds an index file to this folder, so folks can't list all the file's contents |
|
| 500 | - * @param string $folder |
|
| 501 | - * @throws EE_Error if filesystem credentials are required |
|
| 502 | - * @return boolean |
|
| 503 | - */ |
|
| 504 | - public static function add_index_file($folder) |
|
| 505 | - { |
|
| 506 | - $folder = EEH_File::standardise_and_end_with_directory_separator($folder); |
|
| 507 | - if (! EEH_File::exists($folder . 'index.php')) { |
|
| 508 | - if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) { |
|
| 509 | - return false; |
|
| 510 | - } |
|
| 511 | - } |
|
| 512 | - return true; |
|
| 513 | - } |
|
| 514 | - |
|
| 515 | - |
|
| 516 | - |
|
| 517 | - /** |
|
| 518 | - * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php), |
|
| 519 | - * extract that classname. |
|
| 520 | - * @param string $file_path |
|
| 521 | - * @return string |
|
| 522 | - */ |
|
| 523 | - public static function get_classname_from_filepath_with_standard_filename($file_path) |
|
| 524 | - { |
|
| 525 | - // extract file from path |
|
| 526 | - $filename = basename($file_path); |
|
| 527 | - // now remove the first period and everything after |
|
| 528 | - $pos_of_first_period = strpos($filename, '.'); |
|
| 529 | - return substr($filename, 0, $pos_of_first_period); |
|
| 530 | - } |
|
| 531 | - |
|
| 532 | - |
|
| 533 | - |
|
| 534 | - /** |
|
| 535 | - * standardise_directory_separators |
|
| 536 | - * convert all directory separators in a file path to whatever is set for DS |
|
| 537 | - * @param string $file_path |
|
| 538 | - * @return string |
|
| 539 | - */ |
|
| 540 | - public static function standardise_directory_separators($file_path) |
|
| 541 | - { |
|
| 542 | - return str_replace(array( '\\', '/' ), DS, $file_path); |
|
| 543 | - } |
|
| 544 | - |
|
| 545 | - |
|
| 546 | - |
|
| 547 | - /** |
|
| 548 | - * end_with_directory_separator |
|
| 549 | - * ensures that file path ends with DS |
|
| 550 | - * @param string $file_path |
|
| 551 | - * @return string |
|
| 552 | - */ |
|
| 553 | - public static function end_with_directory_separator($file_path) |
|
| 554 | - { |
|
| 555 | - return rtrim($file_path, '/\\') . DS; |
|
| 556 | - } |
|
| 557 | - |
|
| 558 | - |
|
| 559 | - |
|
| 560 | - /** |
|
| 561 | - * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators |
|
| 562 | - * @param $file_path |
|
| 563 | - * @return string |
|
| 564 | - */ |
|
| 565 | - public static function standardise_and_end_with_directory_separator($file_path) |
|
| 566 | - { |
|
| 567 | - return self::end_with_directory_separator(self::standardise_directory_separators($file_path)); |
|
| 568 | - } |
|
| 569 | - |
|
| 570 | - |
|
| 571 | - |
|
| 572 | - /** |
|
| 573 | - * takes the folder name (with or without trailing slash) and finds the files it in, |
|
| 574 | - * and what the class's name inside of each should be. |
|
| 575 | - * @param array $folder_paths |
|
| 576 | - * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically; |
|
| 577 | - * if FALSE (Default), returned array will be indexed by the filenames minus extensions. |
|
| 578 | - * Set it TRUE if you know there are files in the directory with the same name but different extensions |
|
| 579 | - * @throws EE_Error if filesystem credentials are required |
|
| 580 | - * @return array if $index_numerically == TRUE keys are numeric , |
|
| 581 | - * if $index_numerically == FALSE (Default) keys are what the class names SHOULD be; |
|
| 582 | - * and values are their filepaths |
|
| 583 | - */ |
|
| 584 | - public static function get_contents_of_folders($folder_paths = array(), $index_numerically = false) |
|
| 585 | - { |
|
| 586 | - $class_to_folder_path = array(); |
|
| 587 | - foreach ($folder_paths as $folder_path) { |
|
| 588 | - $folder_path = self::standardise_and_end_with_directory_separator($folder_path); |
|
| 589 | - // load WP_Filesystem and set file permissions |
|
| 590 | - $files_in_folder = glob($folder_path . '*'); |
|
| 591 | - $class_to_folder_path = array(); |
|
| 592 | - if ($files_in_folder) { |
|
| 593 | - foreach ($files_in_folder as $file_path) { |
|
| 594 | - // only add files, not folders |
|
| 595 | - if (! is_dir($file_path)) { |
|
| 596 | - if ($index_numerically) { |
|
| 597 | - $class_to_folder_path[] = $file_path; |
|
| 598 | - } else { |
|
| 599 | - $classname = self::get_classname_from_filepath_with_standard_filename($file_path); |
|
| 600 | - $class_to_folder_path[ $classname ] = $file_path; |
|
| 601 | - } |
|
| 602 | - } |
|
| 603 | - } |
|
| 604 | - } |
|
| 605 | - } |
|
| 606 | - return $class_to_folder_path; |
|
| 607 | - } |
|
| 608 | - |
|
| 609 | - |
|
| 610 | - |
|
| 611 | - /** |
|
| 612 | - * Copies a file. Mostly a wrapper of WP_Filesystem::copy |
|
| 613 | - * @param string $source_file |
|
| 614 | - * @param string $destination_file |
|
| 615 | - * @param boolean $overwrite |
|
| 616 | - * @throws EE_Error if filesystem credentials are required |
|
| 617 | - * @return boolean success |
|
| 618 | - */ |
|
| 619 | - public static function copy($source_file, $destination_file, $overwrite = false) |
|
| 620 | - { |
|
| 621 | - $full_source_path = EEH_File::standardise_directory_separators($source_file); |
|
| 622 | - if (! EEH_File::exists($full_source_path)) { |
|
| 623 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 624 | - $msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path); |
|
| 625 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path); |
|
| 626 | - throw new EE_Error($msg); |
|
| 627 | - } |
|
| 628 | - return false; |
|
| 629 | - } |
|
| 630 | - |
|
| 631 | - $full_dest_path = EEH_File::standardise_directory_separators($destination_file); |
|
| 632 | - $folder = EEH_File::remove_filename_from_filepath($full_dest_path); |
|
| 633 | - EEH_File::ensure_folder_exists_and_is_writable($folder); |
|
| 634 | - if (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 635 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 636 | - $msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path); |
|
| 637 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path); |
|
| 638 | - throw new EE_Error($msg); |
|
| 639 | - } |
|
| 640 | - return false; |
|
| 641 | - } |
|
| 642 | - |
|
| 643 | - // load WP_Filesystem and set file permissions |
|
| 644 | - $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file); |
|
| 645 | - // write the file |
|
| 646 | - if (! $wp_filesystem->copy( |
|
| 647 | - EEH_File::convert_local_filepath_to_remote_filepath($full_source_path), |
|
| 648 | - EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path), |
|
| 649 | - $overwrite |
|
| 650 | - )) { |
|
| 651 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 652 | - $msg = sprintf(__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path); |
|
| 653 | - $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f'); |
|
| 654 | - throw new EE_Error($msg); |
|
| 655 | - } |
|
| 656 | - return false; |
|
| 657 | - } |
|
| 658 | - return true; |
|
| 659 | - } |
|
| 660 | - |
|
| 661 | - /** |
|
| 662 | - * Reports whether or not the filepath is in the EE uploads folder or not |
|
| 663 | - * @param string $filepath |
|
| 664 | - * @return boolean |
|
| 665 | - */ |
|
| 666 | - public static function is_in_uploads_folder($filepath) |
|
| 667 | - { |
|
| 668 | - $uploads = wp_upload_dir(); |
|
| 669 | - return strpos($filepath, $uploads['basedir']) === 0 ? true : false; |
|
| 670 | - } |
|
| 671 | - |
|
| 672 | - /** |
|
| 673 | - * Given a "local" filepath (what you probably thought was the only filepath), |
|
| 674 | - * converts it into a "remote" filepath (the filepath the currently-in-use |
|
| 675 | - * $wp_filesystem needs to use access the folder or file). |
|
| 676 | - * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins |
|
| 677 | - * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one |
|
| 678 | - * is in use, so you need to provide it |
|
| 679 | - * @param string $local_filepath the filepath to the folder/file locally |
|
| 680 | - * @throws EE_Error if filesystem credentials are required |
|
| 681 | - * @return string the remote filepath (eg the filepath the filesystem method, eg |
|
| 682 | - * ftp or ssh, will use to access the folder |
|
| 683 | - */ |
|
| 684 | - public static function convert_local_filepath_to_remote_filepath($local_filepath) |
|
| 685 | - { |
|
| 686 | - $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath); |
|
| 687 | - return str_replace(WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath); |
|
| 688 | - } |
|
| 27 | + /** |
|
| 28 | + * @var string $_credentials_form |
|
| 29 | + */ |
|
| 30 | + private static $_credentials_form; |
|
| 31 | + |
|
| 32 | + protected static $_wp_filesystem_direct; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * @param string|null $filepath the filepath we want to work in. If its in the |
|
| 36 | + * wp uploads directory, we'll want to just use the filesystem directly. |
|
| 37 | + * If not provided, we have to assume its not in the uploads directory |
|
| 38 | + * @throws EE_Error if filesystem credentials are required |
|
| 39 | + * @return WP_Filesystem_Base |
|
| 40 | + */ |
|
| 41 | + private static function _get_wp_filesystem($filepath = null) |
|
| 42 | + { |
|
| 43 | + if (apply_filters( |
|
| 44 | + 'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct', |
|
| 45 | + $filepath && EEH_File::is_in_uploads_folder($filepath), |
|
| 46 | + $filepath |
|
| 47 | + ) ) { |
|
| 48 | + if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) { |
|
| 49 | + require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php'); |
|
| 50 | + $method = 'direct'; |
|
| 51 | + $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method); |
|
| 52 | + // check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem() |
|
| 53 | + if (! defined('FS_CHMOD_DIR')) { |
|
| 54 | + define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 )); |
|
| 55 | + } |
|
| 56 | + if (! defined('FS_CHMOD_FILE')) { |
|
| 57 | + define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 )); |
|
| 58 | + } |
|
| 59 | + require_once($wp_filesystem_direct_file); |
|
| 60 | + EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array()); |
|
| 61 | + } |
|
| 62 | + return EEH_File::$_wp_filesystem_direct; |
|
| 63 | + } |
|
| 64 | + global $wp_filesystem; |
|
| 65 | + // no filesystem setup ??? |
|
| 66 | + if (! $wp_filesystem instanceof WP_Filesystem_Base) { |
|
| 67 | + // if some eager beaver's just trying to get in there too early... |
|
| 68 | + // let them do it, because we are one of those eager beavers! :P |
|
| 69 | + /** |
|
| 70 | + * more explanations are probably merited. http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base |
|
| 71 | + * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process |
|
| 72 | + * is setup to mostly happen on 'init', and refactoring to have it happen on |
|
| 73 | + * 'wp_loaded' is too much work on a BETA milestone. |
|
| 74 | + * So this fix is expected to work if the WP files are owned by the server user, |
|
| 75 | + * but probably not if the user needs to enter their FTP credentials to modify files |
|
| 76 | + * and there may be troubles if the WP files are owned by a different user |
|
| 77 | + * than the server user. But both of these issues should exist in 4.4 and earlier too |
|
| 78 | + */ |
|
| 79 | + if (false && ! did_action('wp_loaded')) { |
|
| 80 | + $msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'); |
|
| 81 | + if (WP_DEBUG) { |
|
| 82 | + $msg .= '<br />' . __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso'); |
|
| 83 | + } |
|
| 84 | + throw new EE_Error($msg); |
|
| 85 | + } else { |
|
| 86 | + // should be loaded if we are past the wp_loaded hook... |
|
| 87 | + if (! function_exists('WP_Filesystem')) { |
|
| 88 | + require_once(ABSPATH . 'wp-admin/includes/file.php'); |
|
| 89 | + require_once(ABSPATH . 'wp-admin/includes/template.php'); |
|
| 90 | + } |
|
| 91 | + // turn on output buffering so that we can capture the credentials form |
|
| 92 | + ob_start(); |
|
| 93 | + $credentials = request_filesystem_credentials(''); |
|
| 94 | + // store credentials form for the time being |
|
| 95 | + EEH_File::$_credentials_form = ob_get_clean(); |
|
| 96 | + // basically check for direct or previously configured access |
|
| 97 | + if (! WP_Filesystem($credentials)) { |
|
| 98 | + // if credentials do NOT exist |
|
| 99 | + if ($credentials === false) { |
|
| 100 | + add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999); |
|
| 101 | + throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso')); |
|
| 102 | + } elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) { |
|
| 103 | + add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999); |
|
| 104 | + throw new EE_Error( |
|
| 105 | + sprintf( |
|
| 106 | + __('WP Filesystem Error: $1%s', 'event_espresso'), |
|
| 107 | + $wp_filesystem->errors->get_error_message() |
|
| 108 | + ) |
|
| 109 | + ); |
|
| 110 | + } |
|
| 111 | + } |
|
| 112 | + } |
|
| 113 | + } |
|
| 114 | + return $wp_filesystem; |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * display_request_filesystem_credentials_form |
|
| 119 | + */ |
|
| 120 | + public static function display_request_filesystem_credentials_form() |
|
| 121 | + { |
|
| 122 | + if (! empty(EEH_File::$_credentials_form)) { |
|
| 123 | + echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>'; |
|
| 124 | + } |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * verify_filepath_and_permissions |
|
| 131 | + * checks that a file is readable and has sufficient file permissions set to access |
|
| 132 | + * |
|
| 133 | + * @access public |
|
| 134 | + * @param string $full_file_path - full server path to the folder or file |
|
| 135 | + * @param string $file_name - name of file if checking a file |
|
| 136 | + * @param string $file_ext - file extension (ie: "php") if checking a file |
|
| 137 | + * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages |
|
| 138 | + * @throws EE_Error if filesystem credentials are required |
|
| 139 | + * @return bool |
|
| 140 | + */ |
|
| 141 | + public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '') |
|
| 142 | + { |
|
| 143 | + // load WP_Filesystem and set file permissions |
|
| 144 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 145 | + $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 146 | + if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 147 | + $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name; |
|
| 148 | + $file_name .= ! empty($file_ext) ? ' file' : ' folder'; |
|
| 149 | + $msg = sprintf( |
|
| 150 | + __('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'), |
|
| 151 | + $file_name, |
|
| 152 | + '<br />' |
|
| 153 | + ); |
|
| 154 | + if (EEH_File::exists($full_file_path)) { |
|
| 155 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file); |
|
| 156 | + } else { |
|
| 157 | + // no file permissions means the file was not found |
|
| 158 | + $msg .= sprintf( |
|
| 159 | + __('Please ensure the following path is correct: "%s".', 'event_espresso'), |
|
| 160 | + $full_file_path |
|
| 161 | + ); |
|
| 162 | + } |
|
| 163 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 164 | + throw new EE_Error($msg . '||' . $msg); |
|
| 165 | + } |
|
| 166 | + return false; |
|
| 167 | + } |
|
| 168 | + return true; |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a file or folder |
|
| 175 | + * |
|
| 176 | + * @access private |
|
| 177 | + * @param string $full_file_path - full server path to the folder or file |
|
| 178 | + * @param string $type_of_file - general type of file (ie: "module"), this is only used to improve error messages |
|
| 179 | + * @throws EE_Error if filesystem credentials are required |
|
| 180 | + * @return string |
|
| 181 | + */ |
|
| 182 | + private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '') |
|
| 183 | + { |
|
| 184 | + // load WP_Filesystem and set file permissions |
|
| 185 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 186 | + // check file permissions |
|
| 187 | + $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)); |
|
| 188 | + if ($perms) { |
|
| 189 | + // file permissions exist, but way be set incorrectly |
|
| 190 | + $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : ''; |
|
| 191 | + $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder'; |
|
| 192 | + return sprintf( |
|
| 193 | + __('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'), |
|
| 194 | + $type_of_file, |
|
| 195 | + $perms |
|
| 196 | + ); |
|
| 197 | + } else { |
|
| 198 | + // file exists but file permissions could not be read ?!?! |
|
| 199 | + return sprintf( |
|
| 200 | + __('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'), |
|
| 201 | + $full_file_path |
|
| 202 | + ); |
|
| 203 | + } |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * ensure_folder_exists_and_is_writable |
|
| 210 | + * ensures that a folder exists and is writable, will attempt to create folder if it does not exist |
|
| 211 | + * Also ensures all the parent folders exist, and if not tries to create them. |
|
| 212 | + * Also, if this function creates the folder, adds a .htaccess file and index.html file |
|
| 213 | + * @param string $folder |
|
| 214 | + * @throws EE_Error if the folder exists and is writeable, but for some reason we |
|
| 215 | + * can't write to it |
|
| 216 | + * @return bool false if folder isn't writable; true if it exists and is writeable, |
|
| 217 | + */ |
|
| 218 | + public static function ensure_folder_exists_and_is_writable($folder = '') |
|
| 219 | + { |
|
| 220 | + if (empty($folder)) { |
|
| 221 | + return false; |
|
| 222 | + } |
|
| 223 | + // remove ending DS |
|
| 224 | + $folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\')); |
|
| 225 | + $parent_folder = EEH_File::get_parent_folder($folder); |
|
| 226 | + // add DS to folder |
|
| 227 | + $folder = EEH_File::end_with_directory_separator($folder); |
|
| 228 | + $wp_filesystem = EEH_File::_get_wp_filesystem($folder); |
|
| 229 | + if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 230 | + // ok so it doesn't exist. Does its parent? Can we write to it? |
|
| 231 | + if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 232 | + return false; |
|
| 233 | + } |
|
| 234 | + if (! EEH_File::verify_is_writable($parent_folder, 'folder')) { |
|
| 235 | + return false; |
|
| 236 | + } else { |
|
| 237 | + if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 238 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 239 | + $msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder); |
|
| 240 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder); |
|
| 241 | + throw new EE_Error($msg); |
|
| 242 | + } |
|
| 243 | + return false; |
|
| 244 | + } |
|
| 245 | + EEH_File::add_index_file($folder); |
|
| 246 | + } |
|
| 247 | + } elseif (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 248 | + return false; |
|
| 249 | + } |
|
| 250 | + return true; |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + |
|
| 254 | + |
|
| 255 | + /** |
|
| 256 | + * verify_is_writable - checks if a file or folder is writable |
|
| 257 | + * @param string $full_path - full server path to file or folder |
|
| 258 | + * @param string $file_or_folder - whether checking a file or folder |
|
| 259 | + * @throws EE_Error if filesystem credentials are required |
|
| 260 | + * @return bool |
|
| 261 | + */ |
|
| 262 | + public static function verify_is_writable($full_path = '', $file_or_folder = 'folder') |
|
| 263 | + { |
|
| 264 | + // load WP_Filesystem and set file permissions |
|
| 265 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_path); |
|
| 266 | + $full_path = EEH_File::standardise_directory_separators($full_path); |
|
| 267 | + if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) { |
|
| 268 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 269 | + $msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder); |
|
| 270 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path); |
|
| 271 | + throw new EE_Error($msg); |
|
| 272 | + } |
|
| 273 | + return false; |
|
| 274 | + } |
|
| 275 | + return true; |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + |
|
| 279 | + |
|
| 280 | + /** |
|
| 281 | + * ensure_file_exists_and_is_writable |
|
| 282 | + * ensures that a file exists and is writable, will attempt to create file if it does not exist. |
|
| 283 | + * Also ensures all the parent folders exist, and if not tries to create them. |
|
| 284 | + * @param string $full_file_path |
|
| 285 | + * @throws EE_Error if filesystem credentials are required |
|
| 286 | + * @return bool |
|
| 287 | + */ |
|
| 288 | + public static function ensure_file_exists_and_is_writable($full_file_path = '') |
|
| 289 | + { |
|
| 290 | + // load WP_Filesystem and set file permissions |
|
| 291 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 292 | + $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 293 | + $parent_folder = EEH_File::get_parent_folder($full_file_path); |
|
| 294 | + if (! EEH_File::exists($full_file_path)) { |
|
| 295 | + if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 296 | + return false; |
|
| 297 | + } |
|
| 298 | + if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 299 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 300 | + $msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path); |
|
| 301 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path); |
|
| 302 | + throw new EE_Error($msg); |
|
| 303 | + } |
|
| 304 | + return false; |
|
| 305 | + } |
|
| 306 | + } |
|
| 307 | + if (! EEH_File::verify_is_writable($full_file_path, 'file')) { |
|
| 308 | + return false; |
|
| 309 | + } |
|
| 310 | + return true; |
|
| 311 | + } |
|
| 312 | + |
|
| 313 | + /** |
|
| 314 | + * Gets the parent folder. If provided with file, gets the folder that contains it. |
|
| 315 | + * If provided a folder, gets its parent folder. |
|
| 316 | + * @param string $file_or_folder_path |
|
| 317 | + * @return string parent folder, ENDING with a directory separator |
|
| 318 | + */ |
|
| 319 | + public static function get_parent_folder($file_or_folder_path) |
|
| 320 | + { |
|
| 321 | + // find the last DS, ignoring a DS on the very end |
|
| 322 | + // eg if given "/var/something/somewhere/", we want to get "somewhere"'s |
|
| 323 | + // parent folder, "/var/something/" |
|
| 324 | + $ds = strlen($file_or_folder_path) > 1 |
|
| 325 | + ? strrpos($file_or_folder_path, DS, -2) |
|
| 326 | + : strlen($file_or_folder_path); |
|
| 327 | + return substr($file_or_folder_path, 0, $ds + 1); |
|
| 328 | + } |
|
| 329 | + |
|
| 330 | + // public static function ensure_folder_exists_recursively( $folder ) { |
|
| 331 | + // |
|
| 332 | + // } |
|
| 333 | + |
|
| 334 | + |
|
| 335 | + |
|
| 336 | + /** |
|
| 337 | + * get_file_contents |
|
| 338 | + * @param string $full_file_path |
|
| 339 | + * @throws EE_Error if filesystem credentials are required |
|
| 340 | + * @return string |
|
| 341 | + */ |
|
| 342 | + public static function get_file_contents($full_file_path = '') |
|
| 343 | + { |
|
| 344 | + $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 345 | + if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) { |
|
| 346 | + // load WP_Filesystem and set file permissions |
|
| 347 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 348 | + return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)); |
|
| 349 | + } |
|
| 350 | + return ''; |
|
| 351 | + } |
|
| 352 | + |
|
| 353 | + |
|
| 354 | + |
|
| 355 | + /** |
|
| 356 | + * write_file |
|
| 357 | + * @param string $full_file_path |
|
| 358 | + * @param string $file_contents - the content to be written to the file |
|
| 359 | + * @param string $file_type |
|
| 360 | + * @throws EE_Error if filesystem credentials are required |
|
| 361 | + * @return bool |
|
| 362 | + */ |
|
| 363 | + public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '') |
|
| 364 | + { |
|
| 365 | + $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
|
| 366 | + $file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : ''; |
|
| 367 | + $folder = EEH_File::remove_filename_from_filepath($full_file_path); |
|
| 368 | + if (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 369 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 370 | + $msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path); |
|
| 371 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path); |
|
| 372 | + throw new EE_Error($msg); |
|
| 373 | + } |
|
| 374 | + return false; |
|
| 375 | + } |
|
| 376 | + // load WP_Filesystem and set file permissions |
|
| 377 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 378 | + // write the file |
|
| 379 | + if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) { |
|
| 380 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 381 | + $msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path); |
|
| 382 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f'); |
|
| 383 | + throw new EE_Error($msg); |
|
| 384 | + } |
|
| 385 | + return false; |
|
| 386 | + } |
|
| 387 | + return true; |
|
| 388 | + } |
|
| 389 | + |
|
| 390 | + /** |
|
| 391 | + * Wrapper for WP_Filesystem_Base::delete |
|
| 392 | + * |
|
| 393 | + * @param string $filepath |
|
| 394 | + * @param boolean $recursive |
|
| 395 | + * @param boolean|string $type 'd' for directory, 'f' for file |
|
| 396 | + * @throws EE_Error if filesystem credentials are required |
|
| 397 | + * @return boolean |
|
| 398 | + */ |
|
| 399 | + public static function delete($filepath, $recursive = false, $type = false) |
|
| 400 | + { |
|
| 401 | + $wp_filesystem = EEH_File::_get_wp_filesystem(); |
|
| 402 | + return $wp_filesystem->delete($filepath, $recursive, $type) ? true : false; |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + |
|
| 406 | + |
|
| 407 | + /** |
|
| 408 | + * exists |
|
| 409 | + * checks if a file exists using the WP filesystem |
|
| 410 | + * @param string $full_file_path |
|
| 411 | + * @throws EE_Error if filesystem credentials are required |
|
| 412 | + * @return bool |
|
| 413 | + */ |
|
| 414 | + public static function exists($full_file_path = '') |
|
| 415 | + { |
|
| 416 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 417 | + return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? true : false; |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + |
|
| 421 | + |
|
| 422 | + /** |
|
| 423 | + * is_readable |
|
| 424 | + * checks if a file is_readable using the WP filesystem |
|
| 425 | + * |
|
| 426 | + * @param string $full_file_path |
|
| 427 | + * @throws EE_Error if filesystem credentials are required |
|
| 428 | + * @return bool |
|
| 429 | + */ |
|
| 430 | + public static function is_readable($full_file_path = '') |
|
| 431 | + { |
|
| 432 | + $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
|
| 433 | + if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 434 | + return true; |
|
| 435 | + } else { |
|
| 436 | + return false; |
|
| 437 | + } |
|
| 438 | + } |
|
| 439 | + |
|
| 440 | + |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * remove_filename_from_filepath |
|
| 444 | + * given a full path to a file including the filename itself, this removes the filename and returns the path, up to, but NOT including the filename OR slash |
|
| 445 | + * |
|
| 446 | + * @param string $full_file_path |
|
| 447 | + * @return string |
|
| 448 | + */ |
|
| 449 | + public static function remove_filename_from_filepath($full_file_path = '') |
|
| 450 | + { |
|
| 451 | + return pathinfo($full_file_path, PATHINFO_DIRNAME); |
|
| 452 | + } |
|
| 453 | + |
|
| 454 | + |
|
| 455 | + /** |
|
| 456 | + * get_filename_from_filepath. Arguably the same as basename() |
|
| 457 | + * |
|
| 458 | + * @param string $full_file_path |
|
| 459 | + * @return string |
|
| 460 | + */ |
|
| 461 | + public static function get_filename_from_filepath($full_file_path = '') |
|
| 462 | + { |
|
| 463 | + return pathinfo($full_file_path, PATHINFO_BASENAME); |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * get_file_extension |
|
| 469 | + * |
|
| 470 | + * @param string $full_file_path |
|
| 471 | + * @return string |
|
| 472 | + */ |
|
| 473 | + public static function get_file_extension($full_file_path = '') |
|
| 474 | + { |
|
| 475 | + return pathinfo($full_file_path, PATHINFO_EXTENSION); |
|
| 476 | + } |
|
| 477 | + |
|
| 478 | + |
|
| 479 | + |
|
| 480 | + /** |
|
| 481 | + * add_htaccess_deny_from_all so the webserver cannot access this folder |
|
| 482 | + * @param string $folder |
|
| 483 | + * @throws EE_Error if filesystem credentials are required |
|
| 484 | + * @return bool |
|
| 485 | + */ |
|
| 486 | + public static function add_htaccess_deny_from_all($folder = '') |
|
| 487 | + { |
|
| 488 | + $folder = EEH_File::standardise_and_end_with_directory_separator($folder); |
|
| 489 | + if (! EEH_File::exists($folder . '.htaccess')) { |
|
| 490 | + if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) { |
|
| 491 | + return false; |
|
| 492 | + } |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + return true; |
|
| 496 | + } |
|
| 497 | + |
|
| 498 | + /** |
|
| 499 | + * Adds an index file to this folder, so folks can't list all the file's contents |
|
| 500 | + * @param string $folder |
|
| 501 | + * @throws EE_Error if filesystem credentials are required |
|
| 502 | + * @return boolean |
|
| 503 | + */ |
|
| 504 | + public static function add_index_file($folder) |
|
| 505 | + { |
|
| 506 | + $folder = EEH_File::standardise_and_end_with_directory_separator($folder); |
|
| 507 | + if (! EEH_File::exists($folder . 'index.php')) { |
|
| 508 | + if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) { |
|
| 509 | + return false; |
|
| 510 | + } |
|
| 511 | + } |
|
| 512 | + return true; |
|
| 513 | + } |
|
| 514 | + |
|
| 515 | + |
|
| 516 | + |
|
| 517 | + /** |
|
| 518 | + * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php), |
|
| 519 | + * extract that classname. |
|
| 520 | + * @param string $file_path |
|
| 521 | + * @return string |
|
| 522 | + */ |
|
| 523 | + public static function get_classname_from_filepath_with_standard_filename($file_path) |
|
| 524 | + { |
|
| 525 | + // extract file from path |
|
| 526 | + $filename = basename($file_path); |
|
| 527 | + // now remove the first period and everything after |
|
| 528 | + $pos_of_first_period = strpos($filename, '.'); |
|
| 529 | + return substr($filename, 0, $pos_of_first_period); |
|
| 530 | + } |
|
| 531 | + |
|
| 532 | + |
|
| 533 | + |
|
| 534 | + /** |
|
| 535 | + * standardise_directory_separators |
|
| 536 | + * convert all directory separators in a file path to whatever is set for DS |
|
| 537 | + * @param string $file_path |
|
| 538 | + * @return string |
|
| 539 | + */ |
|
| 540 | + public static function standardise_directory_separators($file_path) |
|
| 541 | + { |
|
| 542 | + return str_replace(array( '\\', '/' ), DS, $file_path); |
|
| 543 | + } |
|
| 544 | + |
|
| 545 | + |
|
| 546 | + |
|
| 547 | + /** |
|
| 548 | + * end_with_directory_separator |
|
| 549 | + * ensures that file path ends with DS |
|
| 550 | + * @param string $file_path |
|
| 551 | + * @return string |
|
| 552 | + */ |
|
| 553 | + public static function end_with_directory_separator($file_path) |
|
| 554 | + { |
|
| 555 | + return rtrim($file_path, '/\\') . DS; |
|
| 556 | + } |
|
| 557 | + |
|
| 558 | + |
|
| 559 | + |
|
| 560 | + /** |
|
| 561 | + * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators |
|
| 562 | + * @param $file_path |
|
| 563 | + * @return string |
|
| 564 | + */ |
|
| 565 | + public static function standardise_and_end_with_directory_separator($file_path) |
|
| 566 | + { |
|
| 567 | + return self::end_with_directory_separator(self::standardise_directory_separators($file_path)); |
|
| 568 | + } |
|
| 569 | + |
|
| 570 | + |
|
| 571 | + |
|
| 572 | + /** |
|
| 573 | + * takes the folder name (with or without trailing slash) and finds the files it in, |
|
| 574 | + * and what the class's name inside of each should be. |
|
| 575 | + * @param array $folder_paths |
|
| 576 | + * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically; |
|
| 577 | + * if FALSE (Default), returned array will be indexed by the filenames minus extensions. |
|
| 578 | + * Set it TRUE if you know there are files in the directory with the same name but different extensions |
|
| 579 | + * @throws EE_Error if filesystem credentials are required |
|
| 580 | + * @return array if $index_numerically == TRUE keys are numeric , |
|
| 581 | + * if $index_numerically == FALSE (Default) keys are what the class names SHOULD be; |
|
| 582 | + * and values are their filepaths |
|
| 583 | + */ |
|
| 584 | + public static function get_contents_of_folders($folder_paths = array(), $index_numerically = false) |
|
| 585 | + { |
|
| 586 | + $class_to_folder_path = array(); |
|
| 587 | + foreach ($folder_paths as $folder_path) { |
|
| 588 | + $folder_path = self::standardise_and_end_with_directory_separator($folder_path); |
|
| 589 | + // load WP_Filesystem and set file permissions |
|
| 590 | + $files_in_folder = glob($folder_path . '*'); |
|
| 591 | + $class_to_folder_path = array(); |
|
| 592 | + if ($files_in_folder) { |
|
| 593 | + foreach ($files_in_folder as $file_path) { |
|
| 594 | + // only add files, not folders |
|
| 595 | + if (! is_dir($file_path)) { |
|
| 596 | + if ($index_numerically) { |
|
| 597 | + $class_to_folder_path[] = $file_path; |
|
| 598 | + } else { |
|
| 599 | + $classname = self::get_classname_from_filepath_with_standard_filename($file_path); |
|
| 600 | + $class_to_folder_path[ $classname ] = $file_path; |
|
| 601 | + } |
|
| 602 | + } |
|
| 603 | + } |
|
| 604 | + } |
|
| 605 | + } |
|
| 606 | + return $class_to_folder_path; |
|
| 607 | + } |
|
| 608 | + |
|
| 609 | + |
|
| 610 | + |
|
| 611 | + /** |
|
| 612 | + * Copies a file. Mostly a wrapper of WP_Filesystem::copy |
|
| 613 | + * @param string $source_file |
|
| 614 | + * @param string $destination_file |
|
| 615 | + * @param boolean $overwrite |
|
| 616 | + * @throws EE_Error if filesystem credentials are required |
|
| 617 | + * @return boolean success |
|
| 618 | + */ |
|
| 619 | + public static function copy($source_file, $destination_file, $overwrite = false) |
|
| 620 | + { |
|
| 621 | + $full_source_path = EEH_File::standardise_directory_separators($source_file); |
|
| 622 | + if (! EEH_File::exists($full_source_path)) { |
|
| 623 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 624 | + $msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path); |
|
| 625 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path); |
|
| 626 | + throw new EE_Error($msg); |
|
| 627 | + } |
|
| 628 | + return false; |
|
| 629 | + } |
|
| 630 | + |
|
| 631 | + $full_dest_path = EEH_File::standardise_directory_separators($destination_file); |
|
| 632 | + $folder = EEH_File::remove_filename_from_filepath($full_dest_path); |
|
| 633 | + EEH_File::ensure_folder_exists_and_is_writable($folder); |
|
| 634 | + if (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 635 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 636 | + $msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path); |
|
| 637 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path); |
|
| 638 | + throw new EE_Error($msg); |
|
| 639 | + } |
|
| 640 | + return false; |
|
| 641 | + } |
|
| 642 | + |
|
| 643 | + // load WP_Filesystem and set file permissions |
|
| 644 | + $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file); |
|
| 645 | + // write the file |
|
| 646 | + if (! $wp_filesystem->copy( |
|
| 647 | + EEH_File::convert_local_filepath_to_remote_filepath($full_source_path), |
|
| 648 | + EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path), |
|
| 649 | + $overwrite |
|
| 650 | + )) { |
|
| 651 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 652 | + $msg = sprintf(__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path); |
|
| 653 | + $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f'); |
|
| 654 | + throw new EE_Error($msg); |
|
| 655 | + } |
|
| 656 | + return false; |
|
| 657 | + } |
|
| 658 | + return true; |
|
| 659 | + } |
|
| 660 | + |
|
| 661 | + /** |
|
| 662 | + * Reports whether or not the filepath is in the EE uploads folder or not |
|
| 663 | + * @param string $filepath |
|
| 664 | + * @return boolean |
|
| 665 | + */ |
|
| 666 | + public static function is_in_uploads_folder($filepath) |
|
| 667 | + { |
|
| 668 | + $uploads = wp_upload_dir(); |
|
| 669 | + return strpos($filepath, $uploads['basedir']) === 0 ? true : false; |
|
| 670 | + } |
|
| 671 | + |
|
| 672 | + /** |
|
| 673 | + * Given a "local" filepath (what you probably thought was the only filepath), |
|
| 674 | + * converts it into a "remote" filepath (the filepath the currently-in-use |
|
| 675 | + * $wp_filesystem needs to use access the folder or file). |
|
| 676 | + * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins |
|
| 677 | + * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one |
|
| 678 | + * is in use, so you need to provide it |
|
| 679 | + * @param string $local_filepath the filepath to the folder/file locally |
|
| 680 | + * @throws EE_Error if filesystem credentials are required |
|
| 681 | + * @return string the remote filepath (eg the filepath the filesystem method, eg |
|
| 682 | + * ftp or ssh, will use to access the folder |
|
| 683 | + */ |
|
| 684 | + public static function convert_local_filepath_to_remote_filepath($local_filepath) |
|
| 685 | + { |
|
| 686 | + $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath); |
|
| 687 | + return str_replace(WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath); |
|
| 688 | + } |
|
| 689 | 689 | } |
@@ -44,17 +44,17 @@ discard block |
||
| 44 | 44 | 'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct', |
| 45 | 45 | $filepath && EEH_File::is_in_uploads_folder($filepath), |
| 46 | 46 | $filepath |
| 47 | - ) ) { |
|
| 48 | - if (! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) { |
|
| 49 | - require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php'); |
|
| 47 | + )) { |
|
| 48 | + if ( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) { |
|
| 49 | + require_once(ABSPATH.'wp-admin/includes/class-wp-filesystem-base.php'); |
|
| 50 | 50 | $method = 'direct'; |
| 51 | - $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method); |
|
| 51 | + $wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH.'wp-admin/includes/class-wp-filesystem-'.$method.'.php', $method); |
|
| 52 | 52 | // check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem() |
| 53 | - if (! defined('FS_CHMOD_DIR')) { |
|
| 54 | - define('FS_CHMOD_DIR', ( fileperms(ABSPATH) & 0777 | 0755 )); |
|
| 53 | + if ( ! defined('FS_CHMOD_DIR')) { |
|
| 54 | + define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0777 | 0755)); |
|
| 55 | 55 | } |
| 56 | - if (! defined('FS_CHMOD_FILE')) { |
|
| 57 | - define('FS_CHMOD_FILE', ( fileperms(ABSPATH . 'index.php') & 0777 | 0644 )); |
|
| 56 | + if ( ! defined('FS_CHMOD_FILE')) { |
|
| 57 | + define('FS_CHMOD_FILE', (fileperms(ABSPATH.'index.php') & 0777 | 0644)); |
|
| 58 | 58 | } |
| 59 | 59 | require_once($wp_filesystem_direct_file); |
| 60 | 60 | EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array()); |
@@ -63,7 +63,7 @@ discard block |
||
| 63 | 63 | } |
| 64 | 64 | global $wp_filesystem; |
| 65 | 65 | // no filesystem setup ??? |
| 66 | - if (! $wp_filesystem instanceof WP_Filesystem_Base) { |
|
| 66 | + if ( ! $wp_filesystem instanceof WP_Filesystem_Base) { |
|
| 67 | 67 | // if some eager beaver's just trying to get in there too early... |
| 68 | 68 | // let them do it, because we are one of those eager beavers! :P |
| 69 | 69 | /** |
@@ -79,14 +79,14 @@ discard block |
||
| 79 | 79 | if (false && ! did_action('wp_loaded')) { |
| 80 | 80 | $msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'); |
| 81 | 81 | if (WP_DEBUG) { |
| 82 | - $msg .= '<br />' . __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso'); |
|
| 82 | + $msg .= '<br />'.__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso'); |
|
| 83 | 83 | } |
| 84 | 84 | throw new EE_Error($msg); |
| 85 | 85 | } else { |
| 86 | 86 | // should be loaded if we are past the wp_loaded hook... |
| 87 | - if (! function_exists('WP_Filesystem')) { |
|
| 88 | - require_once(ABSPATH . 'wp-admin/includes/file.php'); |
|
| 89 | - require_once(ABSPATH . 'wp-admin/includes/template.php'); |
|
| 87 | + if ( ! function_exists('WP_Filesystem')) { |
|
| 88 | + require_once(ABSPATH.'wp-admin/includes/file.php'); |
|
| 89 | + require_once(ABSPATH.'wp-admin/includes/template.php'); |
|
| 90 | 90 | } |
| 91 | 91 | // turn on output buffering so that we can capture the credentials form |
| 92 | 92 | ob_start(); |
@@ -94,13 +94,13 @@ discard block |
||
| 94 | 94 | // store credentials form for the time being |
| 95 | 95 | EEH_File::$_credentials_form = ob_get_clean(); |
| 96 | 96 | // basically check for direct or previously configured access |
| 97 | - if (! WP_Filesystem($credentials)) { |
|
| 97 | + if ( ! WP_Filesystem($credentials)) { |
|
| 98 | 98 | // if credentials do NOT exist |
| 99 | 99 | if ($credentials === false) { |
| 100 | - add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999); |
|
| 100 | + add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999); |
|
| 101 | 101 | throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso')); |
| 102 | 102 | } elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) { |
| 103 | - add_action('admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999); |
|
| 103 | + add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999); |
|
| 104 | 104 | throw new EE_Error( |
| 105 | 105 | sprintf( |
| 106 | 106 | __('WP Filesystem Error: $1%s', 'event_espresso'), |
@@ -119,8 +119,8 @@ discard block |
||
| 119 | 119 | */ |
| 120 | 120 | public static function display_request_filesystem_credentials_form() |
| 121 | 121 | { |
| 122 | - if (! empty(EEH_File::$_credentials_form)) { |
|
| 123 | - echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>'; |
|
| 122 | + if ( ! empty(EEH_File::$_credentials_form)) { |
|
| 123 | + echo '<div class="updated espresso-notices-attention"><p>'.EEH_File::$_credentials_form.'</p></div>'; |
|
| 124 | 124 | } |
| 125 | 125 | } |
| 126 | 126 | |
@@ -143,8 +143,8 @@ discard block |
||
| 143 | 143 | // load WP_Filesystem and set file permissions |
| 144 | 144 | $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
| 145 | 145 | $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
| 146 | - if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 147 | - $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name; |
|
| 146 | + if ( ! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 147 | + $file_name = ! empty($type_of_file) ? $file_name.' '.$type_of_file : $file_name; |
|
| 148 | 148 | $file_name .= ! empty($file_ext) ? ' file' : ' folder'; |
| 149 | 149 | $msg = sprintf( |
| 150 | 150 | __('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'), |
@@ -161,7 +161,7 @@ discard block |
||
| 161 | 161 | ); |
| 162 | 162 | } |
| 163 | 163 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 164 | - throw new EE_Error($msg . '||' . $msg); |
|
| 164 | + throw new EE_Error($msg.'||'.$msg); |
|
| 165 | 165 | } |
| 166 | 166 | return false; |
| 167 | 167 | } |
@@ -187,7 +187,7 @@ discard block |
||
| 187 | 187 | $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)); |
| 188 | 188 | if ($perms) { |
| 189 | 189 | // file permissions exist, but way be set incorrectly |
| 190 | - $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : ''; |
|
| 190 | + $type_of_file = ! empty($type_of_file) ? $type_of_file.' ' : ''; |
|
| 191 | 191 | $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder'; |
| 192 | 192 | return sprintf( |
| 193 | 193 | __('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'), |
@@ -226,15 +226,15 @@ discard block |
||
| 226 | 226 | // add DS to folder |
| 227 | 227 | $folder = EEH_File::end_with_directory_separator($folder); |
| 228 | 228 | $wp_filesystem = EEH_File::_get_wp_filesystem($folder); |
| 229 | - if (! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 229 | + if ( ! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 230 | 230 | // ok so it doesn't exist. Does its parent? Can we write to it? |
| 231 | - if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 231 | + if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 232 | 232 | return false; |
| 233 | 233 | } |
| 234 | - if (! EEH_File::verify_is_writable($parent_folder, 'folder')) { |
|
| 234 | + if ( ! EEH_File::verify_is_writable($parent_folder, 'folder')) { |
|
| 235 | 235 | return false; |
| 236 | 236 | } else { |
| 237 | - if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 237 | + if ( ! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) { |
|
| 238 | 238 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 239 | 239 | $msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder); |
| 240 | 240 | $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder); |
@@ -244,7 +244,7 @@ discard block |
||
| 244 | 244 | } |
| 245 | 245 | EEH_File::add_index_file($folder); |
| 246 | 246 | } |
| 247 | - } elseif (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 247 | + } elseif ( ! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 248 | 248 | return false; |
| 249 | 249 | } |
| 250 | 250 | return true; |
@@ -264,7 +264,7 @@ discard block |
||
| 264 | 264 | // load WP_Filesystem and set file permissions |
| 265 | 265 | $wp_filesystem = EEH_File::_get_wp_filesystem($full_path); |
| 266 | 266 | $full_path = EEH_File::standardise_directory_separators($full_path); |
| 267 | - if (! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) { |
|
| 267 | + if ( ! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) { |
|
| 268 | 268 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 269 | 269 | $msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder); |
| 270 | 270 | $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path); |
@@ -291,11 +291,11 @@ discard block |
||
| 291 | 291 | $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
| 292 | 292 | $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
| 293 | 293 | $parent_folder = EEH_File::get_parent_folder($full_file_path); |
| 294 | - if (! EEH_File::exists($full_file_path)) { |
|
| 295 | - if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 294 | + if ( ! EEH_File::exists($full_file_path)) { |
|
| 295 | + if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) { |
|
| 296 | 296 | return false; |
| 297 | 297 | } |
| 298 | - if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 298 | + if ( ! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) { |
|
| 299 | 299 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 300 | 300 | $msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path); |
| 301 | 301 | $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path); |
@@ -304,7 +304,7 @@ discard block |
||
| 304 | 304 | return false; |
| 305 | 305 | } |
| 306 | 306 | } |
| 307 | - if (! EEH_File::verify_is_writable($full_file_path, 'file')) { |
|
| 307 | + if ( ! EEH_File::verify_is_writable($full_file_path, 'file')) { |
|
| 308 | 308 | return false; |
| 309 | 309 | } |
| 310 | 310 | return true; |
@@ -363,9 +363,9 @@ discard block |
||
| 363 | 363 | public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '') |
| 364 | 364 | { |
| 365 | 365 | $full_file_path = EEH_File::standardise_directory_separators($full_file_path); |
| 366 | - $file_type = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : ''; |
|
| 366 | + $file_type = ! empty($file_type) ? rtrim($file_type, ' ').' ' : ''; |
|
| 367 | 367 | $folder = EEH_File::remove_filename_from_filepath($full_file_path); |
| 368 | - if (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 368 | + if ( ! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 369 | 369 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 370 | 370 | $msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path); |
| 371 | 371 | $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path); |
@@ -376,7 +376,7 @@ discard block |
||
| 376 | 376 | // load WP_Filesystem and set file permissions |
| 377 | 377 | $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path); |
| 378 | 378 | // write the file |
| 379 | - if (! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) { |
|
| 379 | + if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) { |
|
| 380 | 380 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 381 | 381 | $msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path); |
| 382 | 382 | $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f'); |
@@ -486,8 +486,8 @@ discard block |
||
| 486 | 486 | public static function add_htaccess_deny_from_all($folder = '') |
| 487 | 487 | { |
| 488 | 488 | $folder = EEH_File::standardise_and_end_with_directory_separator($folder); |
| 489 | - if (! EEH_File::exists($folder . '.htaccess')) { |
|
| 490 | - if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) { |
|
| 489 | + if ( ! EEH_File::exists($folder.'.htaccess')) { |
|
| 490 | + if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) { |
|
| 491 | 491 | return false; |
| 492 | 492 | } |
| 493 | 493 | } |
@@ -504,8 +504,8 @@ discard block |
||
| 504 | 504 | public static function add_index_file($folder) |
| 505 | 505 | { |
| 506 | 506 | $folder = EEH_File::standardise_and_end_with_directory_separator($folder); |
| 507 | - if (! EEH_File::exists($folder . 'index.php')) { |
|
| 508 | - if (! EEH_File::write_to_file($folder . 'index.php', 'You are not permitted to read from this folder', '.php')) { |
|
| 507 | + if ( ! EEH_File::exists($folder.'index.php')) { |
|
| 508 | + if ( ! EEH_File::write_to_file($folder.'index.php', 'You are not permitted to read from this folder', '.php')) { |
|
| 509 | 509 | return false; |
| 510 | 510 | } |
| 511 | 511 | } |
@@ -539,7 +539,7 @@ discard block |
||
| 539 | 539 | */ |
| 540 | 540 | public static function standardise_directory_separators($file_path) |
| 541 | 541 | { |
| 542 | - return str_replace(array( '\\', '/' ), DS, $file_path); |
|
| 542 | + return str_replace(array('\\', '/'), DS, $file_path); |
|
| 543 | 543 | } |
| 544 | 544 | |
| 545 | 545 | |
@@ -552,7 +552,7 @@ discard block |
||
| 552 | 552 | */ |
| 553 | 553 | public static function end_with_directory_separator($file_path) |
| 554 | 554 | { |
| 555 | - return rtrim($file_path, '/\\') . DS; |
|
| 555 | + return rtrim($file_path, '/\\').DS; |
|
| 556 | 556 | } |
| 557 | 557 | |
| 558 | 558 | |
@@ -587,17 +587,17 @@ discard block |
||
| 587 | 587 | foreach ($folder_paths as $folder_path) { |
| 588 | 588 | $folder_path = self::standardise_and_end_with_directory_separator($folder_path); |
| 589 | 589 | // load WP_Filesystem and set file permissions |
| 590 | - $files_in_folder = glob($folder_path . '*'); |
|
| 590 | + $files_in_folder = glob($folder_path.'*'); |
|
| 591 | 591 | $class_to_folder_path = array(); |
| 592 | 592 | if ($files_in_folder) { |
| 593 | 593 | foreach ($files_in_folder as $file_path) { |
| 594 | 594 | // only add files, not folders |
| 595 | - if (! is_dir($file_path)) { |
|
| 595 | + if ( ! is_dir($file_path)) { |
|
| 596 | 596 | if ($index_numerically) { |
| 597 | 597 | $class_to_folder_path[] = $file_path; |
| 598 | 598 | } else { |
| 599 | 599 | $classname = self::get_classname_from_filepath_with_standard_filename($file_path); |
| 600 | - $class_to_folder_path[ $classname ] = $file_path; |
|
| 600 | + $class_to_folder_path[$classname] = $file_path; |
|
| 601 | 601 | } |
| 602 | 602 | } |
| 603 | 603 | } |
@@ -619,7 +619,7 @@ discard block |
||
| 619 | 619 | public static function copy($source_file, $destination_file, $overwrite = false) |
| 620 | 620 | { |
| 621 | 621 | $full_source_path = EEH_File::standardise_directory_separators($source_file); |
| 622 | - if (! EEH_File::exists($full_source_path)) { |
|
| 622 | + if ( ! EEH_File::exists($full_source_path)) { |
|
| 623 | 623 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 624 | 624 | $msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path); |
| 625 | 625 | $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path); |
@@ -631,7 +631,7 @@ discard block |
||
| 631 | 631 | $full_dest_path = EEH_File::standardise_directory_separators($destination_file); |
| 632 | 632 | $folder = EEH_File::remove_filename_from_filepath($full_dest_path); |
| 633 | 633 | EEH_File::ensure_folder_exists_and_is_writable($folder); |
| 634 | - if (! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 634 | + if ( ! EEH_File::verify_is_writable($folder, 'folder')) { |
|
| 635 | 635 | if (defined('WP_DEBUG') && WP_DEBUG) { |
| 636 | 636 | $msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path); |
| 637 | 637 | $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path); |
@@ -643,7 +643,7 @@ discard block |
||
| 643 | 643 | // load WP_Filesystem and set file permissions |
| 644 | 644 | $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file); |
| 645 | 645 | // write the file |
| 646 | - if (! $wp_filesystem->copy( |
|
| 646 | + if ( ! $wp_filesystem->copy( |
|
| 647 | 647 | EEH_File::convert_local_filepath_to_remote_filepath($full_source_path), |
| 648 | 648 | EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path), |
| 649 | 649 | $overwrite |
@@ -684,6 +684,6 @@ discard block |
||
| 684 | 684 | public static function convert_local_filepath_to_remote_filepath($local_filepath) |
| 685 | 685 | { |
| 686 | 686 | $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath); |
| 687 | - return str_replace(WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath); |
|
| 687 | + return str_replace(WP_CONTENT_DIR.DS, $wp_filesystem->wp_content_dir(), $local_filepath); |
|
| 688 | 688 | } |
| 689 | 689 | } |
@@ -16,39 +16,39 @@ |
||
| 16 | 16 | */ |
| 17 | 17 | class JsonWpOptionManager |
| 18 | 18 | { |
| 19 | - /** |
|
| 20 | - * Updates the object with what's in the DB (specifically, the wp_options table). If nothing is in the DB, leaves |
|
| 21 | - * the object alone and returns false. |
|
| 22 | - * @since $VID:$ |
|
| 23 | - * @param JsonWpOptionSerializableInterface $obj |
|
| 24 | - * @return bool |
|
| 25 | - */ |
|
| 26 | - public function populateFromDb(JsonWpOptionSerializableInterface $obj) |
|
| 27 | - { |
|
| 28 | - $option = get_option($obj->getWpOptionName()); |
|
| 29 | - if ($option) { |
|
| 30 | - $json = json_decode($option); |
|
| 31 | - if (is_array($json) || $json instanceof stdClass) { |
|
| 32 | - return $obj->fromJsonSerializedData($json); |
|
| 33 | - } |
|
| 34 | - } |
|
| 35 | - return false; |
|
| 36 | - } |
|
| 19 | + /** |
|
| 20 | + * Updates the object with what's in the DB (specifically, the wp_options table). If nothing is in the DB, leaves |
|
| 21 | + * the object alone and returns false. |
|
| 22 | + * @since $VID:$ |
|
| 23 | + * @param JsonWpOptionSerializableInterface $obj |
|
| 24 | + * @return bool |
|
| 25 | + */ |
|
| 26 | + public function populateFromDb(JsonWpOptionSerializableInterface $obj) |
|
| 27 | + { |
|
| 28 | + $option = get_option($obj->getWpOptionName()); |
|
| 29 | + if ($option) { |
|
| 30 | + $json = json_decode($option); |
|
| 31 | + if (is_array($json) || $json instanceof stdClass) { |
|
| 32 | + return $obj->fromJsonSerializedData($json); |
|
| 33 | + } |
|
| 34 | + } |
|
| 35 | + return false; |
|
| 36 | + } |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Saves the object's data to the wp_options table for later use. |
|
| 40 | - * @since $VID:$ |
|
| 41 | - * @param JsonWpOptionSerializableInterface $obj |
|
| 42 | - * @return bool |
|
| 43 | - */ |
|
| 44 | - public function saveToDb(JsonWpOptionSerializableInterface $obj) |
|
| 45 | - { |
|
| 46 | - return update_option( |
|
| 47 | - $obj->getWpOptionName(), |
|
| 48 | - wp_json_encode($obj->toJsonSerializableData()), |
|
| 49 | - false |
|
| 50 | - ); |
|
| 51 | - } |
|
| 38 | + /** |
|
| 39 | + * Saves the object's data to the wp_options table for later use. |
|
| 40 | + * @since $VID:$ |
|
| 41 | + * @param JsonWpOptionSerializableInterface $obj |
|
| 42 | + * @return bool |
|
| 43 | + */ |
|
| 44 | + public function saveToDb(JsonWpOptionSerializableInterface $obj) |
|
| 45 | + { |
|
| 46 | + return update_option( |
|
| 47 | + $obj->getWpOptionName(), |
|
| 48 | + wp_json_encode($obj->toJsonSerializableData()), |
|
| 49 | + false |
|
| 50 | + ); |
|
| 51 | + } |
|
| 52 | 52 | } |
| 53 | 53 | // End of file JsonWpOptionManager.php |
| 54 | 54 | // Location: EventEspresso\core\services\options/JsonWpOptionManager.php |
@@ -19,164 +19,164 @@ |
||
| 19 | 19 | */ |
| 20 | 20 | class FileSubmission implements FileSubmissionInterface |
| 21 | 21 | { |
| 22 | - /** |
|
| 23 | - * @var string original name on the client machine |
|
| 24 | - */ |
|
| 25 | - protected $name; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * @var string mime type |
|
| 29 | - */ |
|
| 30 | - protected $type; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var string file extension |
|
| 34 | - */ |
|
| 35 | - protected $extension; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * @var int in bytes |
|
| 39 | - */ |
|
| 40 | - protected $size; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * @var string local filepath to the temporary file |
|
| 44 | - */ |
|
| 45 | - protected $tmp_file; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values |
|
| 49 | - * although those aren't expected. |
|
| 50 | - */ |
|
| 51 | - protected $error_code; |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * FileSubmission constructor. |
|
| 55 | - * @param $name |
|
| 56 | - * @param $tmp_file |
|
| 57 | - * @param $size |
|
| 58 | - * @param null $error_code |
|
| 59 | - * @throws InvalidArgumentException |
|
| 60 | - */ |
|
| 61 | - public function __construct($name, $tmp_file, $size, $error_code = null) |
|
| 62 | - { |
|
| 63 | - $this->name = basename($name); |
|
| 64 | - $scheme = parse_url($tmp_file, PHP_URL_SCHEME); |
|
| 65 | - if (in_array($scheme, ['http', 'https'])) { |
|
| 66 | - // Wait a minute- just local filepaths please, no URL schemes allowed! |
|
| 67 | - throw new InvalidArgumentException( |
|
| 68 | - sprintf( |
|
| 69 | - // @codingStandardsIgnoreStart |
|
| 70 | - esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'), |
|
| 71 | - // @codingStandardsIgnoreEnd |
|
| 72 | - $scheme, |
|
| 73 | - $tmp_file |
|
| 74 | - ) |
|
| 75 | - ); |
|
| 76 | - } |
|
| 77 | - $this->tmp_file = (string) $tmp_file; |
|
| 78 | - $this->size = (int) $size; |
|
| 79 | - $this->error_code = (int) $error_code; |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * @return string |
|
| 84 | - */ |
|
| 85 | - public function getName() |
|
| 86 | - { |
|
| 87 | - return $this->name; |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Gets the file's mime type |
|
| 92 | - * @return string |
|
| 93 | - */ |
|
| 94 | - public function getType() |
|
| 95 | - { |
|
| 96 | - if (!$this->type) { |
|
| 97 | - $this->type = $this->determineType(); |
|
| 98 | - } |
|
| 99 | - return $this->type; |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * @since $VID:$ |
|
| 104 | - * @return string |
|
| 105 | - */ |
|
| 106 | - protected function determineType() |
|
| 107 | - { |
|
| 108 | - if (!$this->getTmpFile()) { |
|
| 109 | - return ''; |
|
| 110 | - } |
|
| 111 | - $finfo = new finfo(FILEINFO_MIME_TYPE); |
|
| 112 | - return $finfo->file($this->getTmpFile()); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Gets the file's extension. |
|
| 117 | - * @since $VID:$ |
|
| 118 | - * @return string |
|
| 119 | - */ |
|
| 120 | - public function getExtension() |
|
| 121 | - { |
|
| 122 | - if (!$this->extension) { |
|
| 123 | - $this->extension = $this->determineExtension(); |
|
| 124 | - } |
|
| 125 | - return $this->extension; |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * Determine's the file's extension given the temporary file. |
|
| 130 | - * @since $VID:$ |
|
| 131 | - * @return string |
|
| 132 | - */ |
|
| 133 | - protected function determineExtension() |
|
| 134 | - { |
|
| 135 | - $position_of_period = strrpos($this->getName(), '.'); |
|
| 136 | - if ($position_of_period === false) { |
|
| 137 | - return ''; |
|
| 138 | - } |
|
| 139 | - return mb_substr( |
|
| 140 | - $this->getName(), |
|
| 141 | - $position_of_period + 1 |
|
| 142 | - ); |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Gets the size of the file |
|
| 147 | - * @return int |
|
| 148 | - */ |
|
| 149 | - public function getSize() |
|
| 150 | - { |
|
| 151 | - return $this->size; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Gets the path to the temporary file which was uploaded. |
|
| 156 | - * @return string |
|
| 157 | - */ |
|
| 158 | - public function getTmpFile() |
|
| 159 | - { |
|
| 160 | - return $this->tmp_file; |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * @since $VID:$ |
|
| 165 | - * @return string |
|
| 166 | - */ |
|
| 167 | - public function __toString() |
|
| 168 | - { |
|
| 169 | - return $this->getName(); |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * Gets the error code PHP reported for the file upload. |
|
| 174 | - * @return string |
|
| 175 | - */ |
|
| 176 | - public function getErrorCode() |
|
| 177 | - { |
|
| 178 | - return $this->error_code; |
|
| 179 | - } |
|
| 22 | + /** |
|
| 23 | + * @var string original name on the client machine |
|
| 24 | + */ |
|
| 25 | + protected $name; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * @var string mime type |
|
| 29 | + */ |
|
| 30 | + protected $type; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var string file extension |
|
| 34 | + */ |
|
| 35 | + protected $extension; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * @var int in bytes |
|
| 39 | + */ |
|
| 40 | + protected $size; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * @var string local filepath to the temporary file |
|
| 44 | + */ |
|
| 45 | + protected $tmp_file; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values |
|
| 49 | + * although those aren't expected. |
|
| 50 | + */ |
|
| 51 | + protected $error_code; |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * FileSubmission constructor. |
|
| 55 | + * @param $name |
|
| 56 | + * @param $tmp_file |
|
| 57 | + * @param $size |
|
| 58 | + * @param null $error_code |
|
| 59 | + * @throws InvalidArgumentException |
|
| 60 | + */ |
|
| 61 | + public function __construct($name, $tmp_file, $size, $error_code = null) |
|
| 62 | + { |
|
| 63 | + $this->name = basename($name); |
|
| 64 | + $scheme = parse_url($tmp_file, PHP_URL_SCHEME); |
|
| 65 | + if (in_array($scheme, ['http', 'https'])) { |
|
| 66 | + // Wait a minute- just local filepaths please, no URL schemes allowed! |
|
| 67 | + throw new InvalidArgumentException( |
|
| 68 | + sprintf( |
|
| 69 | + // @codingStandardsIgnoreStart |
|
| 70 | + esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'), |
|
| 71 | + // @codingStandardsIgnoreEnd |
|
| 72 | + $scheme, |
|
| 73 | + $tmp_file |
|
| 74 | + ) |
|
| 75 | + ); |
|
| 76 | + } |
|
| 77 | + $this->tmp_file = (string) $tmp_file; |
|
| 78 | + $this->size = (int) $size; |
|
| 79 | + $this->error_code = (int) $error_code; |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * @return string |
|
| 84 | + */ |
|
| 85 | + public function getName() |
|
| 86 | + { |
|
| 87 | + return $this->name; |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Gets the file's mime type |
|
| 92 | + * @return string |
|
| 93 | + */ |
|
| 94 | + public function getType() |
|
| 95 | + { |
|
| 96 | + if (!$this->type) { |
|
| 97 | + $this->type = $this->determineType(); |
|
| 98 | + } |
|
| 99 | + return $this->type; |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * @since $VID:$ |
|
| 104 | + * @return string |
|
| 105 | + */ |
|
| 106 | + protected function determineType() |
|
| 107 | + { |
|
| 108 | + if (!$this->getTmpFile()) { |
|
| 109 | + return ''; |
|
| 110 | + } |
|
| 111 | + $finfo = new finfo(FILEINFO_MIME_TYPE); |
|
| 112 | + return $finfo->file($this->getTmpFile()); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Gets the file's extension. |
|
| 117 | + * @since $VID:$ |
|
| 118 | + * @return string |
|
| 119 | + */ |
|
| 120 | + public function getExtension() |
|
| 121 | + { |
|
| 122 | + if (!$this->extension) { |
|
| 123 | + $this->extension = $this->determineExtension(); |
|
| 124 | + } |
|
| 125 | + return $this->extension; |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * Determine's the file's extension given the temporary file. |
|
| 130 | + * @since $VID:$ |
|
| 131 | + * @return string |
|
| 132 | + */ |
|
| 133 | + protected function determineExtension() |
|
| 134 | + { |
|
| 135 | + $position_of_period = strrpos($this->getName(), '.'); |
|
| 136 | + if ($position_of_period === false) { |
|
| 137 | + return ''; |
|
| 138 | + } |
|
| 139 | + return mb_substr( |
|
| 140 | + $this->getName(), |
|
| 141 | + $position_of_period + 1 |
|
| 142 | + ); |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Gets the size of the file |
|
| 147 | + * @return int |
|
| 148 | + */ |
|
| 149 | + public function getSize() |
|
| 150 | + { |
|
| 151 | + return $this->size; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Gets the path to the temporary file which was uploaded. |
|
| 156 | + * @return string |
|
| 157 | + */ |
|
| 158 | + public function getTmpFile() |
|
| 159 | + { |
|
| 160 | + return $this->tmp_file; |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * @since $VID:$ |
|
| 165 | + * @return string |
|
| 166 | + */ |
|
| 167 | + public function __toString() |
|
| 168 | + { |
|
| 169 | + return $this->getName(); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * Gets the error code PHP reported for the file upload. |
|
| 174 | + * @return string |
|
| 175 | + */ |
|
| 176 | + public function getErrorCode() |
|
| 177 | + { |
|
| 178 | + return $this->error_code; |
|
| 179 | + } |
|
| 180 | 180 | } |
| 181 | 181 | // End of file FileSubmission.php |
| 182 | 182 | // Location: EventEspresso\core\services\request\files/FileSubmission.php |
@@ -15,21 +15,21 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | interface JsonSerializableAndUnserializable |
| 17 | 17 | { |
| 18 | - /** |
|
| 19 | - * Creates a simple PHP array or stdClass from this object's properties, which can be easily serialized using |
|
| 20 | - * wp_json_serialize(). |
|
| 21 | - * @since $VID:$ |
|
| 22 | - * @return mixed |
|
| 23 | - */ |
|
| 24 | - public function toJsonSerializableData(); |
|
| 18 | + /** |
|
| 19 | + * Creates a simple PHP array or stdClass from this object's properties, which can be easily serialized using |
|
| 20 | + * wp_json_serialize(). |
|
| 21 | + * @since $VID:$ |
|
| 22 | + * @return mixed |
|
| 23 | + */ |
|
| 24 | + public function toJsonSerializableData(); |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * Initializes this object from data |
|
| 28 | - * @since $VID:$ |
|
| 29 | - * @param mixed $data |
|
| 30 | - * @return boolean success |
|
| 31 | - */ |
|
| 32 | - public function fromJsonSerializedData($data); |
|
| 26 | + /** |
|
| 27 | + * Initializes this object from data |
|
| 28 | + * @since $VID:$ |
|
| 29 | + * @param mixed $data |
|
| 30 | + * @return boolean success |
|
| 31 | + */ |
|
| 32 | + public function fromJsonSerializedData($data); |
|
| 33 | 33 | } |
| 34 | 34 | // End of file JsonSerializableAndUnserializable.php |
| 35 | 35 | // Location: EventEspresso\core\services\json/JsonSerializableAndUnserializable.php |
@@ -28,356 +28,356 @@ |
||
| 28 | 28 | class EED_Batch extends EED_Module |
| 29 | 29 | { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that |
|
| 33 | - * processes data only |
|
| 34 | - */ |
|
| 35 | - const batch_job = 'job'; |
|
| 36 | - /** |
|
| 37 | - * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that |
|
| 38 | - * produces a file for download |
|
| 39 | - */ |
|
| 40 | - const batch_file_job = 'file'; |
|
| 41 | - /** |
|
| 42 | - * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT |
|
| 43 | - * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ] |
|
| 44 | - * at all |
|
| 45 | - */ |
|
| 46 | - const batch_not_job = 'none'; |
|
| 31 | + /** |
|
| 32 | + * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that |
|
| 33 | + * processes data only |
|
| 34 | + */ |
|
| 35 | + const batch_job = 'job'; |
|
| 36 | + /** |
|
| 37 | + * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that |
|
| 38 | + * produces a file for download |
|
| 39 | + */ |
|
| 40 | + const batch_file_job = 'file'; |
|
| 41 | + /** |
|
| 42 | + * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT |
|
| 43 | + * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ] |
|
| 44 | + * at all |
|
| 45 | + */ |
|
| 46 | + const batch_not_job = 'none'; |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * |
|
| 50 | - * @var string 'file', or 'job', or false to indicate its not a batch request at all |
|
| 51 | - */ |
|
| 52 | - protected $_batch_request_type = null; |
|
| 48 | + /** |
|
| 49 | + * |
|
| 50 | + * @var string 'file', or 'job', or false to indicate its not a batch request at all |
|
| 51 | + */ |
|
| 52 | + protected $_batch_request_type = null; |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Because we want to use the response in both the localized JS and in the body |
|
| 56 | - * we need to make this response available between method calls |
|
| 57 | - * |
|
| 58 | - * @var \EventEspressoBatchRequest\Helpers\JobStepResponse |
|
| 59 | - */ |
|
| 60 | - protected $_job_step_response = null; |
|
| 54 | + /** |
|
| 55 | + * Because we want to use the response in both the localized JS and in the body |
|
| 56 | + * we need to make this response available between method calls |
|
| 57 | + * |
|
| 58 | + * @var \EventEspressoBatchRequest\Helpers\JobStepResponse |
|
| 59 | + */ |
|
| 60 | + protected $_job_step_response = null; |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * @var LoaderInterface |
|
| 64 | - */ |
|
| 65 | - protected $loader; |
|
| 62 | + /** |
|
| 63 | + * @var LoaderInterface |
|
| 64 | + */ |
|
| 65 | + protected $loader; |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Gets the batch instance |
|
| 69 | - * |
|
| 70 | - * @return EED_Batch |
|
| 71 | - */ |
|
| 72 | - public static function instance() |
|
| 73 | - { |
|
| 74 | - return self::get_instance(); |
|
| 75 | - } |
|
| 67 | + /** |
|
| 68 | + * Gets the batch instance |
|
| 69 | + * |
|
| 70 | + * @return EED_Batch |
|
| 71 | + */ |
|
| 72 | + public static function instance() |
|
| 73 | + { |
|
| 74 | + return self::get_instance(); |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Sets hooks to enable batch jobs on the frontend. Disabled by default |
|
| 79 | - * because it's an attack vector and there are currently no implementations |
|
| 80 | - */ |
|
| 81 | - public static function set_hooks() |
|
| 82 | - { |
|
| 83 | - // because this is a possibel attack vector, let's have this disabled until |
|
| 84 | - // we at least have a real use for it on the frontend |
|
| 85 | - if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) { |
|
| 86 | - add_action('wp_enqueue_scripts', array(self::instance(), 'enqueue_scripts')); |
|
| 87 | - add_filter('template_include', array(self::instance(), 'override_template'), 99); |
|
| 88 | - } |
|
| 89 | - } |
|
| 77 | + /** |
|
| 78 | + * Sets hooks to enable batch jobs on the frontend. Disabled by default |
|
| 79 | + * because it's an attack vector and there are currently no implementations |
|
| 80 | + */ |
|
| 81 | + public static function set_hooks() |
|
| 82 | + { |
|
| 83 | + // because this is a possibel attack vector, let's have this disabled until |
|
| 84 | + // we at least have a real use for it on the frontend |
|
| 85 | + if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) { |
|
| 86 | + add_action('wp_enqueue_scripts', array(self::instance(), 'enqueue_scripts')); |
|
| 87 | + add_filter('template_include', array(self::instance(), 'override_template'), 99); |
|
| 88 | + } |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Initializes some hooks for the admin in order to run batch jobs |
|
| 93 | - */ |
|
| 94 | - public static function set_hooks_admin() |
|
| 95 | - { |
|
| 96 | - add_action('admin_menu', array(self::instance(), 'register_admin_pages')); |
|
| 97 | - add_action('admin_enqueue_scripts', array(self::instance(), 'enqueue_scripts')); |
|
| 91 | + /** |
|
| 92 | + * Initializes some hooks for the admin in order to run batch jobs |
|
| 93 | + */ |
|
| 94 | + public static function set_hooks_admin() |
|
| 95 | + { |
|
| 96 | + add_action('admin_menu', array(self::instance(), 'register_admin_pages')); |
|
| 97 | + add_action('admin_enqueue_scripts', array(self::instance(), 'enqueue_scripts')); |
|
| 98 | 98 | |
| 99 | - // ajax |
|
| 100 | - add_action('wp_ajax_espresso_batch_continue', array(self::instance(), 'batch_continue')); |
|
| 101 | - add_action('wp_ajax_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup')); |
|
| 102 | - add_action('wp_ajax_nopriv_espresso_batch_continue', array(self::instance(), 'batch_continue')); |
|
| 103 | - add_action('wp_ajax_nopriv_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup')); |
|
| 104 | - } |
|
| 99 | + // ajax |
|
| 100 | + add_action('wp_ajax_espresso_batch_continue', array(self::instance(), 'batch_continue')); |
|
| 101 | + add_action('wp_ajax_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup')); |
|
| 102 | + add_action('wp_ajax_nopriv_espresso_batch_continue', array(self::instance(), 'batch_continue')); |
|
| 103 | + add_action('wp_ajax_nopriv_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup')); |
|
| 104 | + } |
|
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * @since $VID:$ |
|
| 108 | - * @return LoaderInterface |
|
| 109 | - * @throws InvalidArgumentException |
|
| 110 | - * @throws InvalidDataTypeException |
|
| 111 | - * @throws InvalidInterfaceException |
|
| 112 | - */ |
|
| 113 | - protected function getLoader() |
|
| 114 | - { |
|
| 115 | - if (!$this->loader instanceof LoaderInterface) { |
|
| 116 | - $this->loader = LoaderFactory::getLoader(); |
|
| 117 | - } |
|
| 118 | - return $this->loader; |
|
| 119 | - } |
|
| 106 | + /** |
|
| 107 | + * @since $VID:$ |
|
| 108 | + * @return LoaderInterface |
|
| 109 | + * @throws InvalidArgumentException |
|
| 110 | + * @throws InvalidDataTypeException |
|
| 111 | + * @throws InvalidInterfaceException |
|
| 112 | + */ |
|
| 113 | + protected function getLoader() |
|
| 114 | + { |
|
| 115 | + if (!$this->loader instanceof LoaderInterface) { |
|
| 116 | + $this->loader = LoaderFactory::getLoader(); |
|
| 117 | + } |
|
| 118 | + return $this->loader; |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Enqueues batch scripts on the frontend or admin, and creates a job |
|
| 123 | - */ |
|
| 124 | - public function enqueue_scripts() |
|
| 125 | - { |
|
| 126 | - if (isset($_REQUEST['espresso_batch']) |
|
| 127 | - || |
|
| 128 | - ( |
|
| 129 | - isset($_REQUEST['page']) |
|
| 130 | - && $_REQUEST['page'] == 'espresso_batch' |
|
| 131 | - ) |
|
| 132 | - ) { |
|
| 133 | - switch ($this->batch_request_type()) { |
|
| 134 | - case self::batch_job: |
|
| 135 | - $this->enqueue_scripts_styles_batch_create(); |
|
| 136 | - break; |
|
| 137 | - case self::batch_file_job: |
|
| 138 | - $this->enqueue_scripts_styles_batch_file_create(); |
|
| 139 | - break; |
|
| 140 | - } |
|
| 141 | - } |
|
| 142 | - } |
|
| 121 | + /** |
|
| 122 | + * Enqueues batch scripts on the frontend or admin, and creates a job |
|
| 123 | + */ |
|
| 124 | + public function enqueue_scripts() |
|
| 125 | + { |
|
| 126 | + if (isset($_REQUEST['espresso_batch']) |
|
| 127 | + || |
|
| 128 | + ( |
|
| 129 | + isset($_REQUEST['page']) |
|
| 130 | + && $_REQUEST['page'] == 'espresso_batch' |
|
| 131 | + ) |
|
| 132 | + ) { |
|
| 133 | + switch ($this->batch_request_type()) { |
|
| 134 | + case self::batch_job: |
|
| 135 | + $this->enqueue_scripts_styles_batch_create(); |
|
| 136 | + break; |
|
| 137 | + case self::batch_file_job: |
|
| 138 | + $this->enqueue_scripts_styles_batch_file_create(); |
|
| 139 | + break; |
|
| 140 | + } |
|
| 141 | + } |
|
| 142 | + } |
|
| 143 | 143 | |
| 144 | - /** |
|
| 145 | - * Create a batch job, enqueues a script to run it, and localizes some data for it |
|
| 146 | - */ |
|
| 147 | - public function enqueue_scripts_styles_batch_create() |
|
| 148 | - { |
|
| 149 | - $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job(); |
|
| 150 | - wp_enqueue_script( |
|
| 151 | - 'batch_runner_init', |
|
| 152 | - BATCH_URL . 'assets/batch_runner_init.js', |
|
| 153 | - array('batch_runner'), |
|
| 154 | - EVENT_ESPRESSO_VERSION, |
|
| 155 | - true |
|
| 156 | - ); |
|
| 157 | - wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array()); |
|
| 158 | - wp_localize_script( |
|
| 159 | - 'batch_runner_init', |
|
| 160 | - 'ee_job_i18n', |
|
| 161 | - array( |
|
| 162 | - 'return_url' => $_REQUEST['return_url'], |
|
| 163 | - ) |
|
| 164 | - ); |
|
| 165 | - } |
|
| 144 | + /** |
|
| 145 | + * Create a batch job, enqueues a script to run it, and localizes some data for it |
|
| 146 | + */ |
|
| 147 | + public function enqueue_scripts_styles_batch_create() |
|
| 148 | + { |
|
| 149 | + $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job(); |
|
| 150 | + wp_enqueue_script( |
|
| 151 | + 'batch_runner_init', |
|
| 152 | + BATCH_URL . 'assets/batch_runner_init.js', |
|
| 153 | + array('batch_runner'), |
|
| 154 | + EVENT_ESPRESSO_VERSION, |
|
| 155 | + true |
|
| 156 | + ); |
|
| 157 | + wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array()); |
|
| 158 | + wp_localize_script( |
|
| 159 | + 'batch_runner_init', |
|
| 160 | + 'ee_job_i18n', |
|
| 161 | + array( |
|
| 162 | + 'return_url' => $_REQUEST['return_url'], |
|
| 163 | + ) |
|
| 164 | + ); |
|
| 165 | + } |
|
| 166 | 166 | |
| 167 | - /** |
|
| 168 | - * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it |
|
| 169 | - */ |
|
| 170 | - public function enqueue_scripts_styles_batch_file_create() |
|
| 171 | - { |
|
| 172 | - // creates a job based on the request variable |
|
| 173 | - $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job(); |
|
| 174 | - wp_enqueue_script( |
|
| 175 | - 'batch_file_runner_init', |
|
| 176 | - BATCH_URL . 'assets/batch_file_runner_init.js', |
|
| 177 | - array('batch_runner'), |
|
| 178 | - EVENT_ESPRESSO_VERSION, |
|
| 179 | - true |
|
| 180 | - ); |
|
| 181 | - wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array()); |
|
| 182 | - wp_localize_script( |
|
| 183 | - 'batch_file_runner_init', |
|
| 184 | - 'ee_job_i18n', |
|
| 185 | - array( |
|
| 186 | - 'download_and_redirecting' => sprintf( |
|
| 187 | - __('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso'), |
|
| 188 | - '<a href="' . $_REQUEST['return_url'] . '">', |
|
| 189 | - '</a>' |
|
| 190 | - ), |
|
| 191 | - 'return_url' => $_REQUEST['return_url'], |
|
| 192 | - ) |
|
| 193 | - ); |
|
| 194 | - } |
|
| 167 | + /** |
|
| 168 | + * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it |
|
| 169 | + */ |
|
| 170 | + public function enqueue_scripts_styles_batch_file_create() |
|
| 171 | + { |
|
| 172 | + // creates a job based on the request variable |
|
| 173 | + $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job(); |
|
| 174 | + wp_enqueue_script( |
|
| 175 | + 'batch_file_runner_init', |
|
| 176 | + BATCH_URL . 'assets/batch_file_runner_init.js', |
|
| 177 | + array('batch_runner'), |
|
| 178 | + EVENT_ESPRESSO_VERSION, |
|
| 179 | + true |
|
| 180 | + ); |
|
| 181 | + wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array()); |
|
| 182 | + wp_localize_script( |
|
| 183 | + 'batch_file_runner_init', |
|
| 184 | + 'ee_job_i18n', |
|
| 185 | + array( |
|
| 186 | + 'download_and_redirecting' => sprintf( |
|
| 187 | + __('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso'), |
|
| 188 | + '<a href="' . $_REQUEST['return_url'] . '">', |
|
| 189 | + '</a>' |
|
| 190 | + ), |
|
| 191 | + 'return_url' => $_REQUEST['return_url'], |
|
| 192 | + ) |
|
| 193 | + ); |
|
| 194 | + } |
|
| 195 | 195 | |
| 196 | - /** |
|
| 197 | - * Enqueues scripts and styles common to any batch job, and creates |
|
| 198 | - * a job from the request data, and stores the response in the |
|
| 199 | - * $this->_job_step_response property |
|
| 200 | - * |
|
| 201 | - * @return \EventEspressoBatchRequest\Helpers\JobStepResponse |
|
| 202 | - */ |
|
| 203 | - protected function _enqueue_batch_job_scripts_and_styles_and_start_job() |
|
| 204 | - { |
|
| 205 | - wp_register_script( |
|
| 206 | - 'progress_bar', |
|
| 207 | - EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js', |
|
| 208 | - array('jquery') |
|
| 209 | - ); |
|
| 210 | - wp_enqueue_style( |
|
| 211 | - 'progress_bar', |
|
| 212 | - EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css', |
|
| 213 | - array(), |
|
| 214 | - EVENT_ESPRESSO_VERSION |
|
| 215 | - ); |
|
| 216 | - wp_enqueue_script( |
|
| 217 | - 'batch_runner', |
|
| 218 | - EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js', |
|
| 219 | - array('progress_bar') |
|
| 220 | - ); |
|
| 221 | - // just copy the bits of EE admin's eei18n that we need in the JS |
|
| 222 | - wp_localize_script( |
|
| 223 | - 'batch_runner', |
|
| 224 | - 'eei18n', |
|
| 225 | - array( |
|
| 226 | - 'ajax_url' => WP_AJAX_URL, |
|
| 227 | - 'is_admin' => (bool) is_admin(), |
|
| 228 | - 'error_message' => esc_html__('An error occurred and the job has been stopped. Please refresh the page to try again.', 'event_espresso'), |
|
| 229 | - ) |
|
| 230 | - ); |
|
| 231 | - $job_handler_classname = stripslashes($_GET['job_handler']); |
|
| 232 | - $request_data = array_diff_key( |
|
| 233 | - $_REQUEST, |
|
| 234 | - array_flip(array('action', 'page', 'ee', 'batch')) |
|
| 235 | - ); |
|
| 236 | - $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor'); |
|
| 237 | - // eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport' |
|
| 238 | - $job_response = $batch_runner->create_job($job_handler_classname, $request_data); |
|
| 239 | - // remember the response for later. We need it to display the page body |
|
| 240 | - $this->_job_step_response = $job_response; |
|
| 241 | - return $job_response; |
|
| 242 | - } |
|
| 196 | + /** |
|
| 197 | + * Enqueues scripts and styles common to any batch job, and creates |
|
| 198 | + * a job from the request data, and stores the response in the |
|
| 199 | + * $this->_job_step_response property |
|
| 200 | + * |
|
| 201 | + * @return \EventEspressoBatchRequest\Helpers\JobStepResponse |
|
| 202 | + */ |
|
| 203 | + protected function _enqueue_batch_job_scripts_and_styles_and_start_job() |
|
| 204 | + { |
|
| 205 | + wp_register_script( |
|
| 206 | + 'progress_bar', |
|
| 207 | + EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js', |
|
| 208 | + array('jquery') |
|
| 209 | + ); |
|
| 210 | + wp_enqueue_style( |
|
| 211 | + 'progress_bar', |
|
| 212 | + EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css', |
|
| 213 | + array(), |
|
| 214 | + EVENT_ESPRESSO_VERSION |
|
| 215 | + ); |
|
| 216 | + wp_enqueue_script( |
|
| 217 | + 'batch_runner', |
|
| 218 | + EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js', |
|
| 219 | + array('progress_bar') |
|
| 220 | + ); |
|
| 221 | + // just copy the bits of EE admin's eei18n that we need in the JS |
|
| 222 | + wp_localize_script( |
|
| 223 | + 'batch_runner', |
|
| 224 | + 'eei18n', |
|
| 225 | + array( |
|
| 226 | + 'ajax_url' => WP_AJAX_URL, |
|
| 227 | + 'is_admin' => (bool) is_admin(), |
|
| 228 | + 'error_message' => esc_html__('An error occurred and the job has been stopped. Please refresh the page to try again.', 'event_espresso'), |
|
| 229 | + ) |
|
| 230 | + ); |
|
| 231 | + $job_handler_classname = stripslashes($_GET['job_handler']); |
|
| 232 | + $request_data = array_diff_key( |
|
| 233 | + $_REQUEST, |
|
| 234 | + array_flip(array('action', 'page', 'ee', 'batch')) |
|
| 235 | + ); |
|
| 236 | + $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor'); |
|
| 237 | + // eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport' |
|
| 238 | + $job_response = $batch_runner->create_job($job_handler_classname, $request_data); |
|
| 239 | + // remember the response for later. We need it to display the page body |
|
| 240 | + $this->_job_step_response = $job_response; |
|
| 241 | + return $job_response; |
|
| 242 | + } |
|
| 243 | 243 | |
| 244 | - /** |
|
| 245 | - * If we are doing a frontend batch job, this makes it so WP shows our template's HTML |
|
| 246 | - * |
|
| 247 | - * @param string $template |
|
| 248 | - * @return string |
|
| 249 | - */ |
|
| 250 | - public function override_template($template) |
|
| 251 | - { |
|
| 252 | - if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) { |
|
| 253 | - return EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_frontend_wrapper.template.html'; |
|
| 254 | - } |
|
| 255 | - return $template; |
|
| 256 | - } |
|
| 244 | + /** |
|
| 245 | + * If we are doing a frontend batch job, this makes it so WP shows our template's HTML |
|
| 246 | + * |
|
| 247 | + * @param string $template |
|
| 248 | + * @return string |
|
| 249 | + */ |
|
| 250 | + public function override_template($template) |
|
| 251 | + { |
|
| 252 | + if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) { |
|
| 253 | + return EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_frontend_wrapper.template.html'; |
|
| 254 | + } |
|
| 255 | + return $template; |
|
| 256 | + } |
|
| 257 | 257 | |
| 258 | - /** |
|
| 259 | - * Adds an admin page which doesn't appear in the admin menu |
|
| 260 | - */ |
|
| 261 | - public function register_admin_pages() |
|
| 262 | - { |
|
| 263 | - add_submenu_page( |
|
| 264 | - '', // parent slug. we don't want this to actually appear in the menu |
|
| 265 | - __('Batch Job', 'event_espresso'), // page title |
|
| 266 | - 'n/a', // menu title |
|
| 267 | - 'read', // we want this page to actually be accessible to anyone, |
|
| 268 | - 'espresso_batch', // menu slug |
|
| 269 | - array(self::instance(), 'show_admin_page') |
|
| 270 | - ); |
|
| 271 | - } |
|
| 258 | + /** |
|
| 259 | + * Adds an admin page which doesn't appear in the admin menu |
|
| 260 | + */ |
|
| 261 | + public function register_admin_pages() |
|
| 262 | + { |
|
| 263 | + add_submenu_page( |
|
| 264 | + '', // parent slug. we don't want this to actually appear in the menu |
|
| 265 | + __('Batch Job', 'event_espresso'), // page title |
|
| 266 | + 'n/a', // menu title |
|
| 267 | + 'read', // we want this page to actually be accessible to anyone, |
|
| 268 | + 'espresso_batch', // menu slug |
|
| 269 | + array(self::instance(), 'show_admin_page') |
|
| 270 | + ); |
|
| 271 | + } |
|
| 272 | 272 | |
| 273 | - /** |
|
| 274 | - * Renders the admin page, after most of the work was already done during enqueuing scripts |
|
| 275 | - * of creating the job and localizing some data |
|
| 276 | - */ |
|
| 277 | - public function show_admin_page() |
|
| 278 | - { |
|
| 279 | - echo EEH_Template::locate_template( |
|
| 280 | - EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_wrapper.template.html', |
|
| 281 | - array('batch_request_type' => $this->batch_request_type()) |
|
| 282 | - ); |
|
| 283 | - } |
|
| 273 | + /** |
|
| 274 | + * Renders the admin page, after most of the work was already done during enqueuing scripts |
|
| 275 | + * of creating the job and localizing some data |
|
| 276 | + */ |
|
| 277 | + public function show_admin_page() |
|
| 278 | + { |
|
| 279 | + echo EEH_Template::locate_template( |
|
| 280 | + EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_wrapper.template.html', |
|
| 281 | + array('batch_request_type' => $this->batch_request_type()) |
|
| 282 | + ); |
|
| 283 | + } |
|
| 284 | 284 | |
| 285 | - /** |
|
| 286 | - * Receives ajax calls for continuing a job |
|
| 287 | - */ |
|
| 288 | - public function batch_continue() |
|
| 289 | - { |
|
| 290 | - $job_id = sanitize_text_field($_REQUEST['job_id']); |
|
| 291 | - $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor'); |
|
| 292 | - $response_obj = $batch_runner->continue_job($job_id); |
|
| 293 | - $this->_return_json($response_obj->to_array()); |
|
| 294 | - } |
|
| 285 | + /** |
|
| 286 | + * Receives ajax calls for continuing a job |
|
| 287 | + */ |
|
| 288 | + public function batch_continue() |
|
| 289 | + { |
|
| 290 | + $job_id = sanitize_text_field($_REQUEST['job_id']); |
|
| 291 | + $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor'); |
|
| 292 | + $response_obj = $batch_runner->continue_job($job_id); |
|
| 293 | + $this->_return_json($response_obj->to_array()); |
|
| 294 | + } |
|
| 295 | 295 | |
| 296 | - /** |
|
| 297 | - * Receives the ajax call to cleanup a job |
|
| 298 | - * |
|
| 299 | - * @return type |
|
| 300 | - */ |
|
| 301 | - public function batch_cleanup() |
|
| 302 | - { |
|
| 303 | - $job_id = sanitize_text_field($_REQUEST['job_id']); |
|
| 304 | - $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor'); |
|
| 305 | - $response_obj = $batch_runner->cleanup_job($job_id); |
|
| 306 | - $this->_return_json($response_obj->to_array()); |
|
| 307 | - } |
|
| 296 | + /** |
|
| 297 | + * Receives the ajax call to cleanup a job |
|
| 298 | + * |
|
| 299 | + * @return type |
|
| 300 | + */ |
|
| 301 | + public function batch_cleanup() |
|
| 302 | + { |
|
| 303 | + $job_id = sanitize_text_field($_REQUEST['job_id']); |
|
| 304 | + $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor'); |
|
| 305 | + $response_obj = $batch_runner->cleanup_job($job_id); |
|
| 306 | + $this->_return_json($response_obj->to_array()); |
|
| 307 | + } |
|
| 308 | 308 | |
| 309 | 309 | |
| 310 | - /** |
|
| 311 | - * Returns a json response |
|
| 312 | - * |
|
| 313 | - * @param array $data The data we want to send echo via in the JSON response's "data" element |
|
| 314 | - * |
|
| 315 | - * The returned json object is created from an array in the following format: |
|
| 316 | - * array( |
|
| 317 | - * 'notices' => '', // - contains any EE_Error formatted notices |
|
| 318 | - * 'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. |
|
| 319 | - * We're also going to include the template args with every package (so js can pick out any specific template |
|
| 320 | - * args that might be included in here) |
|
| 321 | - * 'isEEajax' => true,//indicates this is a response from EE |
|
| 322 | - * ) |
|
| 323 | - */ |
|
| 324 | - protected function _return_json($data) |
|
| 325 | - { |
|
| 326 | - $json = array( |
|
| 327 | - 'notices' => EE_Error::get_notices(), |
|
| 328 | - 'data' => $data, |
|
| 329 | - 'isEEajax' => true |
|
| 330 | - // special flag so any ajax.Success methods in js can identify this return package as a EEajax package. |
|
| 331 | - ); |
|
| 310 | + /** |
|
| 311 | + * Returns a json response |
|
| 312 | + * |
|
| 313 | + * @param array $data The data we want to send echo via in the JSON response's "data" element |
|
| 314 | + * |
|
| 315 | + * The returned json object is created from an array in the following format: |
|
| 316 | + * array( |
|
| 317 | + * 'notices' => '', // - contains any EE_Error formatted notices |
|
| 318 | + * 'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js. |
|
| 319 | + * We're also going to include the template args with every package (so js can pick out any specific template |
|
| 320 | + * args that might be included in here) |
|
| 321 | + * 'isEEajax' => true,//indicates this is a response from EE |
|
| 322 | + * ) |
|
| 323 | + */ |
|
| 324 | + protected function _return_json($data) |
|
| 325 | + { |
|
| 326 | + $json = array( |
|
| 327 | + 'notices' => EE_Error::get_notices(), |
|
| 328 | + 'data' => $data, |
|
| 329 | + 'isEEajax' => true |
|
| 330 | + // special flag so any ajax.Success methods in js can identify this return package as a EEajax package. |
|
| 331 | + ); |
|
| 332 | 332 | |
| 333 | 333 | |
| 334 | - // make sure there are no php errors or headers_sent. Then we can set correct json header. |
|
| 335 | - if (null === error_get_last() || ! headers_sent()) { |
|
| 336 | - header('Content-Type: application/json; charset=UTF-8'); |
|
| 337 | - } |
|
| 338 | - echo wp_json_encode($json); |
|
| 339 | - exit(); |
|
| 340 | - } |
|
| 334 | + // make sure there are no php errors or headers_sent. Then we can set correct json header. |
|
| 335 | + if (null === error_get_last() || ! headers_sent()) { |
|
| 336 | + header('Content-Type: application/json; charset=UTF-8'); |
|
| 337 | + } |
|
| 338 | + echo wp_json_encode($json); |
|
| 339 | + exit(); |
|
| 340 | + } |
|
| 341 | 341 | |
| 342 | - /** |
|
| 343 | - * Gets the job step response which was done during the enqueuing of scripts |
|
| 344 | - * |
|
| 345 | - * @return \EventEspressoBatchRequest\Helpers\JobStepResponse |
|
| 346 | - */ |
|
| 347 | - public function job_step_response() |
|
| 348 | - { |
|
| 349 | - return $this->_job_step_response; |
|
| 350 | - } |
|
| 342 | + /** |
|
| 343 | + * Gets the job step response which was done during the enqueuing of scripts |
|
| 344 | + * |
|
| 345 | + * @return \EventEspressoBatchRequest\Helpers\JobStepResponse |
|
| 346 | + */ |
|
| 347 | + public function job_step_response() |
|
| 348 | + { |
|
| 349 | + return $this->_job_step_response; |
|
| 350 | + } |
|
| 351 | 351 | |
| 352 | - /** |
|
| 353 | - * Gets the batch request type indicated in the $_REQUEST |
|
| 354 | - * |
|
| 355 | - * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job |
|
| 356 | - */ |
|
| 357 | - public function batch_request_type() |
|
| 358 | - { |
|
| 359 | - if ($this->_batch_request_type === null) { |
|
| 360 | - if (isset($_GET['batch'])) { |
|
| 361 | - if ($_GET['batch'] == self::batch_job) { |
|
| 362 | - $this->_batch_request_type = self::batch_job; |
|
| 363 | - } elseif ($_GET['batch'] == self::batch_file_job) { |
|
| 364 | - $this->_batch_request_type = self::batch_file_job; |
|
| 365 | - } |
|
| 366 | - } |
|
| 367 | - // if we didn't find that it was a batch request, indicate it wasn't |
|
| 368 | - if ($this->_batch_request_type === null) { |
|
| 369 | - $this->_batch_request_type = self::batch_not_job; |
|
| 370 | - } |
|
| 371 | - } |
|
| 372 | - return $this->_batch_request_type; |
|
| 373 | - } |
|
| 352 | + /** |
|
| 353 | + * Gets the batch request type indicated in the $_REQUEST |
|
| 354 | + * |
|
| 355 | + * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job |
|
| 356 | + */ |
|
| 357 | + public function batch_request_type() |
|
| 358 | + { |
|
| 359 | + if ($this->_batch_request_type === null) { |
|
| 360 | + if (isset($_GET['batch'])) { |
|
| 361 | + if ($_GET['batch'] == self::batch_job) { |
|
| 362 | + $this->_batch_request_type = self::batch_job; |
|
| 363 | + } elseif ($_GET['batch'] == self::batch_file_job) { |
|
| 364 | + $this->_batch_request_type = self::batch_file_job; |
|
| 365 | + } |
|
| 366 | + } |
|
| 367 | + // if we didn't find that it was a batch request, indicate it wasn't |
|
| 368 | + if ($this->_batch_request_type === null) { |
|
| 369 | + $this->_batch_request_type = self::batch_not_job; |
|
| 370 | + } |
|
| 371 | + } |
|
| 372 | + return $this->_batch_request_type; |
|
| 373 | + } |
|
| 374 | 374 | |
| 375 | - /** |
|
| 376 | - * Unnecessary |
|
| 377 | - * |
|
| 378 | - * @param type $WP |
|
| 379 | - */ |
|
| 380 | - public function run($WP) |
|
| 381 | - { |
|
| 382 | - } |
|
| 375 | + /** |
|
| 376 | + * Unnecessary |
|
| 377 | + * |
|
| 378 | + * @param type $WP |
|
| 379 | + */ |
|
| 380 | + public function run($WP) |
|
| 381 | + { |
|
| 382 | + } |
|
| 383 | 383 | } |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | */ |
| 113 | 113 | protected function getLoader() |
| 114 | 114 | { |
| 115 | - if (!$this->loader instanceof LoaderInterface) { |
|
| 115 | + if ( ! $this->loader instanceof LoaderInterface) { |
|
| 116 | 116 | $this->loader = LoaderFactory::getLoader(); |
| 117 | 117 | } |
| 118 | 118 | return $this->loader; |
@@ -149,7 +149,7 @@ discard block |
||
| 149 | 149 | $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job(); |
| 150 | 150 | wp_enqueue_script( |
| 151 | 151 | 'batch_runner_init', |
| 152 | - BATCH_URL . 'assets/batch_runner_init.js', |
|
| 152 | + BATCH_URL.'assets/batch_runner_init.js', |
|
| 153 | 153 | array('batch_runner'), |
| 154 | 154 | EVENT_ESPRESSO_VERSION, |
| 155 | 155 | true |
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job(); |
| 174 | 174 | wp_enqueue_script( |
| 175 | 175 | 'batch_file_runner_init', |
| 176 | - BATCH_URL . 'assets/batch_file_runner_init.js', |
|
| 176 | + BATCH_URL.'assets/batch_file_runner_init.js', |
|
| 177 | 177 | array('batch_runner'), |
| 178 | 178 | EVENT_ESPRESSO_VERSION, |
| 179 | 179 | true |
@@ -185,7 +185,7 @@ discard block |
||
| 185 | 185 | array( |
| 186 | 186 | 'download_and_redirecting' => sprintf( |
| 187 | 187 | __('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso'), |
| 188 | - '<a href="' . $_REQUEST['return_url'] . '">', |
|
| 188 | + '<a href="'.$_REQUEST['return_url'].'">', |
|
| 189 | 189 | '</a>' |
| 190 | 190 | ), |
| 191 | 191 | 'return_url' => $_REQUEST['return_url'], |
@@ -204,18 +204,18 @@ discard block |
||
| 204 | 204 | { |
| 205 | 205 | wp_register_script( |
| 206 | 206 | 'progress_bar', |
| 207 | - EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js', |
|
| 207 | + EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.js', |
|
| 208 | 208 | array('jquery') |
| 209 | 209 | ); |
| 210 | 210 | wp_enqueue_style( |
| 211 | 211 | 'progress_bar', |
| 212 | - EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css', |
|
| 212 | + EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.css', |
|
| 213 | 213 | array(), |
| 214 | 214 | EVENT_ESPRESSO_VERSION |
| 215 | 215 | ); |
| 216 | 216 | wp_enqueue_script( |
| 217 | 217 | 'batch_runner', |
| 218 | - EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js', |
|
| 218 | + EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/batch_runner.js', |
|
| 219 | 219 | array('progress_bar') |
| 220 | 220 | ); |
| 221 | 221 | // just copy the bits of EE admin's eei18n that we need in the JS |
@@ -250,7 +250,7 @@ discard block |
||
| 250 | 250 | public function override_template($template) |
| 251 | 251 | { |
| 252 | 252 | if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) { |
| 253 | - return EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_frontend_wrapper.template.html'; |
|
| 253 | + return EE_MODULES.'batch'.DS.'templates'.DS.'batch_frontend_wrapper.template.html'; |
|
| 254 | 254 | } |
| 255 | 255 | return $template; |
| 256 | 256 | } |
@@ -277,7 +277,7 @@ discard block |
||
| 277 | 277 | public function show_admin_page() |
| 278 | 278 | { |
| 279 | 279 | echo EEH_Template::locate_template( |
| 280 | - EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_wrapper.template.html', |
|
| 280 | + EE_MODULES.'batch'.DS.'templates'.DS.'batch_wrapper.template.html', |
|
| 281 | 281 | array('batch_request_type' => $this->batch_request_type()) |
| 282 | 282 | ); |
| 283 | 283 | } |
@@ -25,215 +25,215 @@ |
||
| 25 | 25 | */ |
| 26 | 26 | class BatchRequestProcessor |
| 27 | 27 | { |
| 28 | - // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 29 | - // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 30 | - /** |
|
| 31 | - * Current job's ID (if assigned) |
|
| 32 | - * |
|
| 33 | - * @var string|null |
|
| 34 | - */ |
|
| 35 | - protected $_job_id; |
|
| 28 | + // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore |
|
| 29 | + // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 30 | + /** |
|
| 31 | + * Current job's ID (if assigned) |
|
| 32 | + * |
|
| 33 | + * @var string|null |
|
| 34 | + */ |
|
| 35 | + protected $_job_id; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * Current job's parameters |
|
| 39 | - * |
|
| 40 | - * @var JobParameters|null |
|
| 41 | - */ |
|
| 42 | - protected $_job_parameters; |
|
| 43 | - /** |
|
| 44 | - * @var LoaderInterface |
|
| 45 | - */ |
|
| 46 | - private $loader; |
|
| 37 | + /** |
|
| 38 | + * Current job's parameters |
|
| 39 | + * |
|
| 40 | + * @var JobParameters|null |
|
| 41 | + */ |
|
| 42 | + protected $_job_parameters; |
|
| 43 | + /** |
|
| 44 | + * @var LoaderInterface |
|
| 45 | + */ |
|
| 46 | + private $loader; |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * BatchRequestProcessor constructor. |
|
| 50 | - * @param LoaderInterface $loader |
|
| 51 | - */ |
|
| 52 | - public function __construct(LoaderInterface $loader) |
|
| 53 | - { |
|
| 54 | - $this->loader = $loader; |
|
| 55 | - } |
|
| 56 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 57 | - /** |
|
| 58 | - * Creates a job for the specified batch handler class (which should be autoloaded) |
|
| 59 | - * and the specified request data |
|
| 60 | - * |
|
| 61 | - * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface |
|
| 62 | - * @param array $request_data to be used by the batch job handler |
|
| 63 | - * @return JobStepResponse |
|
| 64 | - */ |
|
| 65 | - public function create_job($batch_job_handler_class, $request_data) |
|
| 66 | - { |
|
| 67 | - try { |
|
| 68 | - $this->_job_id = wp_generate_password(15, false); |
|
| 69 | - $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class); |
|
| 70 | - $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data); |
|
| 71 | - $response = $obj->create_job($this->_job_parameters); |
|
| 72 | - if (! $response instanceof JobStepResponse) { |
|
| 73 | - throw new BatchRequestException( |
|
| 74 | - sprintf( |
|
| 75 | - __( |
|
| 76 | - 'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception', |
|
| 77 | - 'event_espresso' |
|
| 78 | - ), |
|
| 79 | - wp_json_encode($request_data) |
|
| 80 | - ) |
|
| 81 | - ); |
|
| 82 | - } |
|
| 83 | - $success = $this->_job_parameters->save(true); |
|
| 84 | - if (! $success) { |
|
| 85 | - throw new BatchRequestException( |
|
| 86 | - sprintf( |
|
| 87 | - __( |
|
| 88 | - 'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s', |
|
| 89 | - 'event_espresso' |
|
| 90 | - ), |
|
| 91 | - $this->_job_id, |
|
| 92 | - wp_json_encode($request_data) |
|
| 93 | - ) |
|
| 94 | - ); |
|
| 95 | - } |
|
| 96 | - } catch (\Exception $e) { |
|
| 97 | - $response = $this->_get_error_response($e, 'create_job'); |
|
| 98 | - } |
|
| 99 | - return $response; |
|
| 100 | - } |
|
| 48 | + /** |
|
| 49 | + * BatchRequestProcessor constructor. |
|
| 50 | + * @param LoaderInterface $loader |
|
| 51 | + */ |
|
| 52 | + public function __construct(LoaderInterface $loader) |
|
| 53 | + { |
|
| 54 | + $this->loader = $loader; |
|
| 55 | + } |
|
| 56 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 57 | + /** |
|
| 58 | + * Creates a job for the specified batch handler class (which should be autoloaded) |
|
| 59 | + * and the specified request data |
|
| 60 | + * |
|
| 61 | + * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface |
|
| 62 | + * @param array $request_data to be used by the batch job handler |
|
| 63 | + * @return JobStepResponse |
|
| 64 | + */ |
|
| 65 | + public function create_job($batch_job_handler_class, $request_data) |
|
| 66 | + { |
|
| 67 | + try { |
|
| 68 | + $this->_job_id = wp_generate_password(15, false); |
|
| 69 | + $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class); |
|
| 70 | + $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data); |
|
| 71 | + $response = $obj->create_job($this->_job_parameters); |
|
| 72 | + if (! $response instanceof JobStepResponse) { |
|
| 73 | + throw new BatchRequestException( |
|
| 74 | + sprintf( |
|
| 75 | + __( |
|
| 76 | + 'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception', |
|
| 77 | + 'event_espresso' |
|
| 78 | + ), |
|
| 79 | + wp_json_encode($request_data) |
|
| 80 | + ) |
|
| 81 | + ); |
|
| 82 | + } |
|
| 83 | + $success = $this->_job_parameters->save(true); |
|
| 84 | + if (! $success) { |
|
| 85 | + throw new BatchRequestException( |
|
| 86 | + sprintf( |
|
| 87 | + __( |
|
| 88 | + 'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s', |
|
| 89 | + 'event_espresso' |
|
| 90 | + ), |
|
| 91 | + $this->_job_id, |
|
| 92 | + wp_json_encode($request_data) |
|
| 93 | + ) |
|
| 94 | + ); |
|
| 95 | + } |
|
| 96 | + } catch (\Exception $e) { |
|
| 97 | + $response = $this->_get_error_response($e, 'create_job'); |
|
| 98 | + } |
|
| 99 | + return $response; |
|
| 100 | + } |
|
| 101 | 101 | |
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * Retrieves the job's arguments |
|
| 105 | - * |
|
| 106 | - * @param string $job_id |
|
| 107 | - * @param int $batch_size |
|
| 108 | - * @return JobStepResponse |
|
| 109 | - */ |
|
| 110 | - public function continue_job($job_id, $batch_size = 50) |
|
| 111 | - { |
|
| 112 | - try { |
|
| 113 | - $this->_job_id = $job_id; |
|
| 114 | - $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size; |
|
| 115 | - // get the corresponding WordPress option for the job |
|
| 116 | - $this->_job_parameters = JobParameters::load($this->_job_id); |
|
| 117 | - $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname()); |
|
| 118 | - // continue it |
|
| 119 | - $response = $handler_obj->continue_job($this->_job_parameters, $batch_size); |
|
| 120 | - if (! $response instanceof JobStepResponse) { |
|
| 121 | - throw new BatchRequestException( |
|
| 122 | - sprintf( |
|
| 123 | - __( |
|
| 124 | - 'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 125 | - 'event_espresso' |
|
| 126 | - ), |
|
| 127 | - $this->_job_id |
|
| 128 | - ) |
|
| 129 | - ); |
|
| 130 | - } |
|
| 131 | - $this->_job_parameters->save(); |
|
| 132 | - } catch (\Exception $e) { |
|
| 133 | - $response = $this->_get_error_response($e, 'continue_job'); |
|
| 134 | - } |
|
| 135 | - return $response; |
|
| 136 | - } |
|
| 103 | + /** |
|
| 104 | + * Retrieves the job's arguments |
|
| 105 | + * |
|
| 106 | + * @param string $job_id |
|
| 107 | + * @param int $batch_size |
|
| 108 | + * @return JobStepResponse |
|
| 109 | + */ |
|
| 110 | + public function continue_job($job_id, $batch_size = 50) |
|
| 111 | + { |
|
| 112 | + try { |
|
| 113 | + $this->_job_id = $job_id; |
|
| 114 | + $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size; |
|
| 115 | + // get the corresponding WordPress option for the job |
|
| 116 | + $this->_job_parameters = JobParameters::load($this->_job_id); |
|
| 117 | + $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname()); |
|
| 118 | + // continue it |
|
| 119 | + $response = $handler_obj->continue_job($this->_job_parameters, $batch_size); |
|
| 120 | + if (! $response instanceof JobStepResponse) { |
|
| 121 | + throw new BatchRequestException( |
|
| 122 | + sprintf( |
|
| 123 | + __( |
|
| 124 | + 'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 125 | + 'event_espresso' |
|
| 126 | + ), |
|
| 127 | + $this->_job_id |
|
| 128 | + ) |
|
| 129 | + ); |
|
| 130 | + } |
|
| 131 | + $this->_job_parameters->save(); |
|
| 132 | + } catch (\Exception $e) { |
|
| 133 | + $response = $this->_get_error_response($e, 'continue_job'); |
|
| 134 | + } |
|
| 135 | + return $response; |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | 138 | |
| 139 | - /** |
|
| 140 | - * Instantiates an object of type $classname, which implements |
|
| 141 | - * JobHandlerInterface |
|
| 142 | - * |
|
| 143 | - * @param string $classname |
|
| 144 | - * @return JobHandlerInterface |
|
| 145 | - * @throws BatchRequestException |
|
| 146 | - */ |
|
| 147 | - public function instantiate_batch_job_handler_from_classname($classname) |
|
| 148 | - { |
|
| 149 | - if (! class_exists($classname)) { |
|
| 150 | - throw new BatchRequestException( |
|
| 151 | - sprintf( |
|
| 152 | - __( |
|
| 153 | - 'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.', |
|
| 154 | - 'event_espresso' |
|
| 155 | - ), |
|
| 156 | - $classname |
|
| 157 | - ) |
|
| 158 | - ); |
|
| 159 | - } |
|
| 160 | - $obj = $this->loader->getNew($classname); |
|
| 161 | - if (! $obj instanceof JobHandlerInterface) { |
|
| 162 | - throw new BatchRequestException( |
|
| 163 | - sprintf( |
|
| 164 | - __( |
|
| 165 | - 'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job', |
|
| 166 | - 'event_espresso' |
|
| 167 | - ), |
|
| 168 | - $classname |
|
| 169 | - ) |
|
| 170 | - ); |
|
| 171 | - } |
|
| 172 | - return $obj; |
|
| 173 | - } |
|
| 139 | + /** |
|
| 140 | + * Instantiates an object of type $classname, which implements |
|
| 141 | + * JobHandlerInterface |
|
| 142 | + * |
|
| 143 | + * @param string $classname |
|
| 144 | + * @return JobHandlerInterface |
|
| 145 | + * @throws BatchRequestException |
|
| 146 | + */ |
|
| 147 | + public function instantiate_batch_job_handler_from_classname($classname) |
|
| 148 | + { |
|
| 149 | + if (! class_exists($classname)) { |
|
| 150 | + throw new BatchRequestException( |
|
| 151 | + sprintf( |
|
| 152 | + __( |
|
| 153 | + 'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.', |
|
| 154 | + 'event_espresso' |
|
| 155 | + ), |
|
| 156 | + $classname |
|
| 157 | + ) |
|
| 158 | + ); |
|
| 159 | + } |
|
| 160 | + $obj = $this->loader->getNew($classname); |
|
| 161 | + if (! $obj instanceof JobHandlerInterface) { |
|
| 162 | + throw new BatchRequestException( |
|
| 163 | + sprintf( |
|
| 164 | + __( |
|
| 165 | + 'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job', |
|
| 166 | + 'event_espresso' |
|
| 167 | + ), |
|
| 168 | + $classname |
|
| 169 | + ) |
|
| 170 | + ); |
|
| 171 | + } |
|
| 172 | + return $obj; |
|
| 173 | + } |
|
| 174 | 174 | |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Forces a job to be cleaned up |
|
| 178 | - * |
|
| 179 | - * @param string $job_id |
|
| 180 | - * @return JobStepResponse |
|
| 181 | - * @throws BatchRequestException |
|
| 182 | - */ |
|
| 183 | - public function cleanup_job($job_id) |
|
| 184 | - { |
|
| 185 | - try { |
|
| 186 | - $this->_job_id = $job_id; |
|
| 187 | - $job_parameters = JobParameters::load($this->_job_id); |
|
| 188 | - $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname()); |
|
| 189 | - // continue it |
|
| 190 | - $response = $handler_obj->cleanup_job($job_parameters); |
|
| 191 | - if (! $response instanceof JobStepResponse) { |
|
| 192 | - throw new BatchRequestException( |
|
| 193 | - sprintf( |
|
| 194 | - __( |
|
| 195 | - 'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 196 | - 'event_espresso' |
|
| 197 | - ), |
|
| 198 | - $this->_job_id |
|
| 199 | - ) |
|
| 200 | - ); |
|
| 201 | - } |
|
| 202 | - $job_parameters->set_status(JobParameters::status_cleaned_up); |
|
| 203 | - $job_parameters->delete(); |
|
| 204 | - return $response; |
|
| 205 | - } catch (\Exception $e) { |
|
| 206 | - $response = $this->_get_error_response($e, 'cleanup_job'); |
|
| 207 | - } |
|
| 208 | - return $response; |
|
| 209 | - } |
|
| 176 | + /** |
|
| 177 | + * Forces a job to be cleaned up |
|
| 178 | + * |
|
| 179 | + * @param string $job_id |
|
| 180 | + * @return JobStepResponse |
|
| 181 | + * @throws BatchRequestException |
|
| 182 | + */ |
|
| 183 | + public function cleanup_job($job_id) |
|
| 184 | + { |
|
| 185 | + try { |
|
| 186 | + $this->_job_id = $job_id; |
|
| 187 | + $job_parameters = JobParameters::load($this->_job_id); |
|
| 188 | + $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname()); |
|
| 189 | + // continue it |
|
| 190 | + $response = $handler_obj->cleanup_job($job_parameters); |
|
| 191 | + if (! $response instanceof JobStepResponse) { |
|
| 192 | + throw new BatchRequestException( |
|
| 193 | + sprintf( |
|
| 194 | + __( |
|
| 195 | + 'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception', |
|
| 196 | + 'event_espresso' |
|
| 197 | + ), |
|
| 198 | + $this->_job_id |
|
| 199 | + ) |
|
| 200 | + ); |
|
| 201 | + } |
|
| 202 | + $job_parameters->set_status(JobParameters::status_cleaned_up); |
|
| 203 | + $job_parameters->delete(); |
|
| 204 | + return $response; |
|
| 205 | + } catch (\Exception $e) { |
|
| 206 | + $response = $this->_get_error_response($e, 'cleanup_job'); |
|
| 207 | + } |
|
| 208 | + return $response; |
|
| 209 | + } |
|
| 210 | 210 | |
| 211 | 211 | |
| 212 | - /** |
|
| 213 | - * Creates a valid JobStepResponse object from an exception and method name. |
|
| 214 | - * |
|
| 215 | - * @param \Exception $exception |
|
| 216 | - * @param string $method_name |
|
| 217 | - * @return JobStepResponse |
|
| 218 | - */ |
|
| 219 | - protected function _get_error_response(\Exception $exception, $method_name) |
|
| 220 | - { |
|
| 221 | - if (! $this->_job_parameters instanceof JobParameters) { |
|
| 222 | - $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array()); |
|
| 223 | - } |
|
| 224 | - $this->_job_parameters->set_status(JobParameters::status_error); |
|
| 225 | - return new JobStepResponse( |
|
| 226 | - $this->_job_parameters, |
|
| 227 | - sprintf( |
|
| 228 | - __( |
|
| 229 | - 'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s', |
|
| 230 | - 'event_espresso' |
|
| 231 | - ), |
|
| 232 | - get_class($exception), |
|
| 233 | - 'BatchRunner::' . $method_name . '()', |
|
| 234 | - $exception->getMessage(), |
|
| 235 | - $exception->getTraceAsString() |
|
| 236 | - ) |
|
| 237 | - ); |
|
| 238 | - } |
|
| 212 | + /** |
|
| 213 | + * Creates a valid JobStepResponse object from an exception and method name. |
|
| 214 | + * |
|
| 215 | + * @param \Exception $exception |
|
| 216 | + * @param string $method_name |
|
| 217 | + * @return JobStepResponse |
|
| 218 | + */ |
|
| 219 | + protected function _get_error_response(\Exception $exception, $method_name) |
|
| 220 | + { |
|
| 221 | + if (! $this->_job_parameters instanceof JobParameters) { |
|
| 222 | + $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array()); |
|
| 223 | + } |
|
| 224 | + $this->_job_parameters->set_status(JobParameters::status_error); |
|
| 225 | + return new JobStepResponse( |
|
| 226 | + $this->_job_parameters, |
|
| 227 | + sprintf( |
|
| 228 | + __( |
|
| 229 | + 'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s', |
|
| 230 | + 'event_espresso' |
|
| 231 | + ), |
|
| 232 | + get_class($exception), |
|
| 233 | + 'BatchRunner::' . $method_name . '()', |
|
| 234 | + $exception->getMessage(), |
|
| 235 | + $exception->getTraceAsString() |
|
| 236 | + ) |
|
| 237 | + ); |
|
| 238 | + } |
|
| 239 | 239 | } |
@@ -69,7 +69,7 @@ discard block |
||
| 69 | 69 | $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class); |
| 70 | 70 | $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data); |
| 71 | 71 | $response = $obj->create_job($this->_job_parameters); |
| 72 | - if (! $response instanceof JobStepResponse) { |
|
| 72 | + if ( ! $response instanceof JobStepResponse) { |
|
| 73 | 73 | throw new BatchRequestException( |
| 74 | 74 | sprintf( |
| 75 | 75 | __( |
@@ -81,7 +81,7 @@ discard block |
||
| 81 | 81 | ); |
| 82 | 82 | } |
| 83 | 83 | $success = $this->_job_parameters->save(true); |
| 84 | - if (! $success) { |
|
| 84 | + if ( ! $success) { |
|
| 85 | 85 | throw new BatchRequestException( |
| 86 | 86 | sprintf( |
| 87 | 87 | __( |
@@ -117,7 +117,7 @@ discard block |
||
| 117 | 117 | $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname()); |
| 118 | 118 | // continue it |
| 119 | 119 | $response = $handler_obj->continue_job($this->_job_parameters, $batch_size); |
| 120 | - if (! $response instanceof JobStepResponse) { |
|
| 120 | + if ( ! $response instanceof JobStepResponse) { |
|
| 121 | 121 | throw new BatchRequestException( |
| 122 | 122 | sprintf( |
| 123 | 123 | __( |
@@ -146,7 +146,7 @@ discard block |
||
| 146 | 146 | */ |
| 147 | 147 | public function instantiate_batch_job_handler_from_classname($classname) |
| 148 | 148 | { |
| 149 | - if (! class_exists($classname)) { |
|
| 149 | + if ( ! class_exists($classname)) { |
|
| 150 | 150 | throw new BatchRequestException( |
| 151 | 151 | sprintf( |
| 152 | 152 | __( |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | ); |
| 159 | 159 | } |
| 160 | 160 | $obj = $this->loader->getNew($classname); |
| 161 | - if (! $obj instanceof JobHandlerInterface) { |
|
| 161 | + if ( ! $obj instanceof JobHandlerInterface) { |
|
| 162 | 162 | throw new BatchRequestException( |
| 163 | 163 | sprintf( |
| 164 | 164 | __( |
@@ -188,7 +188,7 @@ discard block |
||
| 188 | 188 | $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname()); |
| 189 | 189 | // continue it |
| 190 | 190 | $response = $handler_obj->cleanup_job($job_parameters); |
| 191 | - if (! $response instanceof JobStepResponse) { |
|
| 191 | + if ( ! $response instanceof JobStepResponse) { |
|
| 192 | 192 | throw new BatchRequestException( |
| 193 | 193 | sprintf( |
| 194 | 194 | __( |
@@ -218,7 +218,7 @@ discard block |
||
| 218 | 218 | */ |
| 219 | 219 | protected function _get_error_response(\Exception $exception, $method_name) |
| 220 | 220 | { |
| 221 | - if (! $this->_job_parameters instanceof JobParameters) { |
|
| 221 | + if ( ! $this->_job_parameters instanceof JobParameters) { |
|
| 222 | 222 | $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array()); |
| 223 | 223 | } |
| 224 | 224 | $this->_job_parameters->set_status(JobParameters::status_error); |
@@ -230,7 +230,7 @@ discard block |
||
| 230 | 230 | 'event_espresso' |
| 231 | 231 | ), |
| 232 | 232 | get_class($exception), |
| 233 | - 'BatchRunner::' . $method_name . '()', |
|
| 233 | + 'BatchRunner::'.$method_name.'()', |
|
| 234 | 234 | $exception->getMessage(), |
| 235 | 235 | $exception->getTraceAsString() |
| 236 | 236 | ) |
