abilities
2 months ago
blocks
5 days ago
contact-form
5 days ago
dashboard
5 days ago
form-editor
3 months ago
modules
5 days ago
service
5 days ago
store
3 months ago
util
3 months ago
class-jetpack-forms.php
5 days ago
class-jetpack-forms.php
295 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Package description here |
| 4 | * |
| 5 | * @package automattic/jetpack-forms |
| 6 | */ |
| 7 | |
| 8 | namespace Automattic\Jetpack\Forms; |
| 9 | |
| 10 | use Automattic\Jetpack\Feature_Flags\Feature_Flags; |
| 11 | use Automattic\Jetpack\Forms\ContactForm\Feedback_Source; |
| 12 | use Automattic\Jetpack\Forms\ContactForm\Util; |
| 13 | use Automattic\Jetpack\Forms\Dashboard\Dashboard; |
| 14 | /** |
| 15 | * Understands the Jetpack Forms package. |
| 16 | */ |
| 17 | class Jetpack_Forms { |
| 18 | |
| 19 | const PACKAGE_VERSION = '7.25.0'; |
| 20 | |
| 21 | /** |
| 22 | * Name of the feature flag gating field conditional logic. |
| 23 | */ |
| 24 | const CONDITIONAL_LOGIC_FLAG = 'forms-conditional-logic'; |
| 25 | |
| 26 | /** |
| 27 | * Register the package's feature flags. |
| 28 | * |
| 29 | * Registration is unconditional and happens as the package loads, so the full set stays |
| 30 | * discoverable through `Feature_Flags::all()` and nothing can call `is_enabled()` on an |
| 31 | * unregistered flag. |
| 32 | * |
| 33 | * @return void |
| 34 | */ |
| 35 | public static function register_feature_flags() { |
| 36 | Feature_Flags::register( |
| 37 | self::CONDITIONAL_LOGIC_FLAG, |
| 38 | array( |
| 39 | 'default' => false, |
| 40 | 'description' => 'Show or hide a form field based on the answer to another field.', |
| 41 | 'owner' => 'jetpack-forms', |
| 42 | ) |
| 43 | ); |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Load the contact form module. |
| 48 | */ |
| 49 | public static function load_contact_form() { |
| 50 | self::register_feature_flags(); |
| 51 | |
| 52 | Util::init(); |
| 53 | |
| 54 | if ( self::is_feedback_dashboard_enabled() ) { |
| 55 | $dashboard = new Dashboard(); |
| 56 | $dashboard->init(); |
| 57 | } |
| 58 | |
| 59 | if ( is_admin() && apply_filters_deprecated( 'tmp_grunion_allow_editor_view', array( true ), '0.30.5', '', 'This functionality will be removed in an upcoming version.' ) ) { |
| 60 | add_action( 'current_screen', '\Automattic\Jetpack\Forms\ContactForm\Editor_View::add_hooks' ); |
| 61 | } |
| 62 | |
| 63 | add_action( 'init', '\Automattic\Jetpack\Forms\ContactForm\Util::register_pattern' ); |
| 64 | |
| 65 | // Add hook to delete file attachments when a feedback post is deleted |
| 66 | add_action( 'before_delete_post', array( '\Automattic\Jetpack\Forms\ContactForm\Contact_Form', 'delete_feedback_files' ) ); |
| 67 | |
| 68 | // Invalidate the source post IDs cache when a feedback post is permanently deleted. |
| 69 | add_action( 'deleted_post', array( '\Automattic\Jetpack\Forms\ContactForm\Feedback', 'invalidate_source_ids_cache_on_delete' ), 10, 2 ); |
| 70 | |
| 71 | // Enforces the availability of block support controls in the UI for classic themes. |
| 72 | add_filter( 'wp_theme_json_data_default', array( '\Automattic\Jetpack\Forms\ContactForm\Contact_Form', 'add_theme_json_data_for_classic_themes' ) ); |
| 73 | |
| 74 | // Initialize abilities registration for WordPress Abilities API (WP 6.9+) |
| 75 | \Automattic\Jetpack\Forms\Abilities\Forms_Abilities::init(); |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Get the plugin URL. |
| 80 | */ |
| 81 | public static function plugin_url() { |
| 82 | return plugin_dir_url( __FILE__ ); |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * Get the assets URL. |
| 87 | */ |
| 88 | public static function assets_url() { |
| 89 | return plugin_dir_url( __DIR__ ) . 'assets'; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Returns true if the feedback dashboard is enabled. |
| 94 | * |
| 95 | * @return boolean |
| 96 | */ |
| 97 | public static function is_feedback_dashboard_enabled() { |
| 98 | /** |
| 99 | * Enable the new Jetpack Forms dashboard. |
| 100 | * |
| 101 | * @module contact-form |
| 102 | * @since 0.3.0 |
| 103 | * |
| 104 | * @param bool false Should the new Jetpack Forms dashboard be enabled? Default to false. |
| 105 | */ |
| 106 | return apply_filters( 'jetpack_forms_dashboard_enable', true ); |
| 107 | } |
| 108 | |
| 109 | /** |
| 110 | * Returns true if the legacy menu item is retired. |
| 111 | * |
| 112 | * @return boolean |
| 113 | */ |
| 114 | public static function is_legacy_menu_item_retired() { |
| 115 | return apply_filters( 'jetpack_forms_retire_legacy_menu_item', true ); |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Returns true if MailPoet integration is enabled. |
| 120 | * |
| 121 | * @return boolean |
| 122 | */ |
| 123 | public static function is_mailpoet_enabled() { |
| 124 | /** |
| 125 | * Enable MailPoet integration. |
| 126 | * |
| 127 | * @param bool false Whether MailPoet integration be enabled. Default is false. |
| 128 | */ |
| 129 | return apply_filters( 'jetpack_forms_mailpoet_enable', true ); |
| 130 | } |
| 131 | |
| 132 | /** |
| 133 | * Returns true if Hostinger Reach integration is enabled. |
| 134 | * |
| 135 | * @return boolean |
| 136 | */ |
| 137 | public static function is_hostinger_reach_enabled() { |
| 138 | /** |
| 139 | * Enable Hostinger Reach integration. |
| 140 | * |
| 141 | * @param bool false Whether Hostinger Reach integration be enabled. Default is false. |
| 142 | */ |
| 143 | return apply_filters( 'jetpack_forms_hostinger_reach_enable', false ); |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Returns true if the Integrations UI should be enabled. |
| 148 | * |
| 149 | * @return boolean |
| 150 | */ |
| 151 | public static function is_integrations_enabled() { |
| 152 | /** |
| 153 | * Whether to enable the Integrations UI. |
| 154 | * |
| 155 | * @param bool true Whether to enable the Integrations UI. Default true. |
| 156 | */ |
| 157 | return apply_filters( 'jetpack_forms_is_integrations_enabled', true ); |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Returns true if field conditional logic is enabled. |
| 162 | * |
| 163 | * One switch for the whole feature: the editor panel, the front-end show/hide, and the |
| 164 | * submission-time enforcement in validation and storage. Gating them together means a |
| 165 | * form can never hide a field from the visitor while still requiring it on submit. |
| 166 | * |
| 167 | * Turning the flag off on a form that already has conditions is safe: the conditions are |
| 168 | * simply ignored, so every field renders, validates and stores as an ordinary field. |
| 169 | * |
| 170 | * @return boolean |
| 171 | */ |
| 172 | public static function is_conditional_logic_enabled() { |
| 173 | return Feature_Flags::is_enabled( self::CONDITIONAL_LOGIC_FLAG ); |
| 174 | } |
| 175 | |
| 176 | /** |
| 177 | * Returns true if webhooks are enabled. |
| 178 | * |
| 179 | * @return boolean |
| 180 | */ |
| 181 | public static function is_webhooks_enabled() { |
| 182 | /** |
| 183 | * Whether to enable webhooks for Jetpack Forms. |
| 184 | * |
| 185 | * @param bool true Whether webhooks should be enabled. Default true. |
| 186 | */ |
| 187 | return apply_filters( 'jetpack_forms_webhooks_enabled', true ); |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * Whether author-configured outbound destinations from a form source should be honored. |
| 192 | * |
| 193 | * Destinations declared in the form content (webhooks, the legacy postToUrl attribute and |
| 194 | * the Salesforce integration) carry submission data to an outbound URL, so they are only |
| 195 | * honored when whoever placed the form had an administrator-level capability: |
| 196 | * |
| 197 | * - For post/page forms (`single`, numeric source id) the source post's author must have |
| 198 | * the `manage_options` capability. Editor/Author/Contributor-authored forms are dropped. |
| 199 | * - For block templates, block template parts and widgets the source id is not a numeric |
| 200 | * post, so there is no author to check. Editing any of those surfaces already requires |
| 201 | * the `edit_theme_options` capability — administrator-tier, strictly above the |
| 202 | * capabilities an Editor/Author/Contributor holds — so their destinations are trusted. |
| 203 | * |
| 204 | * The source type is established server-side (from the signed JWT, or by re-rendering the |
| 205 | * real template/template part on the legacy path) and is not forgeable by the submitter. |
| 206 | * |
| 207 | * Returns false for any other unresolved source (non-numeric id of an unknown type, or a |
| 208 | * numeric id with no admin-capable author). |
| 209 | * |
| 210 | * @param int|string $source_id The form source id: a post id for post/page forms, or a |
| 211 | * non-numeric value for widget or block-template sources. |
| 212 | * @param string $source_type The form source type: single, widget, block_template or |
| 213 | * block_template_part. Defaults to 'single'. |
| 214 | * @return boolean |
| 215 | */ |
| 216 | public static function should_honor_content_destinations( $source_id, $source_type = 'single' ) { |
| 217 | // Block templates, template parts and widgets can only be authored by users with the |
| 218 | // administrator-tier `edit_theme_options` capability, so their destinations are trusted |
| 219 | // even though the source id is not a numeric post. |
| 220 | if ( in_array( $source_type, Feedback_Source::ADMIN_TIER_SOURCE_TYPES, true ) ) { |
| 221 | return true; |
| 222 | } |
| 223 | |
| 224 | if ( ! is_numeric( $source_id ) ) { |
| 225 | return false; |
| 226 | } |
| 227 | |
| 228 | $source_id = (int) $source_id; |
| 229 | if ( $source_id <= 0 ) { |
| 230 | return false; |
| 231 | } |
| 232 | |
| 233 | $author_id = (int) get_post_field( 'post_author', $source_id ); |
| 234 | |
| 235 | return $author_id > 0 && user_can( $author_id, 'manage_options' ); |
| 236 | } |
| 237 | |
| 238 | /** |
| 239 | * Returns true if the Integrations UI should be shown in the Forms dashboard. |
| 240 | * |
| 241 | * @since 6.22.0 |
| 242 | * |
| 243 | * @return boolean |
| 244 | */ |
| 245 | public static function show_dashboard_integrations() { |
| 246 | /** |
| 247 | * Whether to show Integrations UI in the Forms dashboard. |
| 248 | * |
| 249 | * @since 6.22.0 |
| 250 | * |
| 251 | * @param bool true Whether to show the Integrations UI in the dashboard. Default true. |
| 252 | */ |
| 253 | return apply_filters( 'jetpack_forms_show_dashboard_integrations', true ); |
| 254 | } |
| 255 | |
| 256 | /** |
| 257 | * Returns true if the Integrations UI should be shown in the Form block editor. |
| 258 | * |
| 259 | * @since 6.22.0 |
| 260 | * |
| 261 | * @return boolean |
| 262 | */ |
| 263 | public static function show_block_integrations() { |
| 264 | /** |
| 265 | * Whether to show Integrations UI in the Form block editor. |
| 266 | * |
| 267 | * @since 6.22.0 |
| 268 | * |
| 269 | * @param bool true Whether to show the Integrations UI in the editor. Default true. |
| 270 | */ |
| 271 | return apply_filters( 'jetpack_forms_show_block_integrations', true ); |
| 272 | } |
| 273 | |
| 274 | /** |
| 275 | * Returns true if integration icons should be shown (editor sidebar and integrations modal). |
| 276 | * |
| 277 | * @since 6.22.0 |
| 278 | * |
| 279 | * @return boolean |
| 280 | */ |
| 281 | public static function show_integration_icons() { |
| 282 | /** |
| 283 | * Whether to show integration icons in the UI. |
| 284 | * |
| 285 | * If set to false, the ActiveIntegrations component (editor sidebar) will be hidden |
| 286 | * and integration icons in the integrations modal will not be rendered. |
| 287 | * |
| 288 | * @since 6.22.0 |
| 289 | * |
| 290 | * @param bool true Whether to show integration icons. Default true. |
| 291 | */ |
| 292 | return apply_filters( 'jetpack_forms_show_integration_icons', true ); |
| 293 | } |
| 294 | } |
| 295 |