tablepress / classes / class-controller.php

class-controller.php in TablePress – Tables in WordPress made easy 1.14, at classes/class-controller.php

176 lines 6.2 KB

Raw Download Zip

1	<?php
2	/**
3	* TablePress Base Controller with members and methods for all controllers
4	*
5	* @package TablePress
6	* @subpackage Controllers
7	* @author Tobias Bäthge
8	* @since 1.0.0
9	*/
10
11	// Prohibit direct script loading.
12	defined( 'ABSPATH' ) \|\| die( 'No direct script access allowed!' );
13
14	/**
15	* Base Controller class
16	* @package TablePress
17	* @subpackage Controllers
18	* @author Tobias Bäthge
19	* @since 1.0.0
20	*/
21	abstract class TablePress_Controller {
22
23	/**
24	* Instance of the Options Model.
25	*
26	* @since 1.0.0
27	* @var TablePress_Options_Model
28	*/
29	public $model_options;
30
31	/**
32	* Instance of the Table Model.
33	*
34	* @since 1.0.0
35	* @var TablePress_Table_Model
36	*/
37	public $model_table;
38
39	/**
40	* File name of the admin screens' parent page in the admin menu.
41	*
42	* @since 1.0.0
43	* @var string
44	*/
45	public $parent_page = 'middle';
46
47	/**
48	* Whether TablePress admin screens are a top-level menu item in the admin menu.
49	*
50	* @since 1.0.0
51	* @var bool
52	*/
53	public $is_top_level_page = false;
54
55	/**
56	* Initialize all controllers, by loading Plugin and User Options, and by performing an update check.
57	*
58	* @since 1.0.0
59	*/
60	public function __construct() {
61	/*
62	* References to the TablePress models (only for backwards compatibility in TablePress Extensions!).
63	* Using `TablePress::$model_options` and `TablePress::$model_table` is recommended!
64	*/
65	$this->model_options = TablePress::$model_options;
66	$this->model_table = TablePress::$model_table;
67
68	// Update check, in all controllers (frontend and admin), to make sure we always have up-to-date options, should be done very early.
69	$this->plugin_update_check();
70
71	/**
72	* Filter the admin menu parent page, which is needed for the construction of plugin URLs.
73	*
74	* @since 1.0.0
75	*
76	* @param string $parent_page Current admin menu parent page.
77	*/
78	$this->parent_page = apply_filters( 'tablepress_admin_menu_parent_page', TablePress::$model_options->get( 'admin_menu_parent_page' ) );
79	$this->is_top_level_page = in_array( $this->parent_page, array( 'top', 'middle', 'bottom' ), true );
80	}
81
82	/**
83	* Check if the plugin was updated and perform necessary actions, like updating the options.
84	*
85	* @since 1.0.0
86	*/
87	protected function plugin_update_check() {
88	// First activation or plugin update.
89	$current_plugin_options_db_version = TablePress::$model_options->get( 'plugin_options_db_version' );
90	if ( $current_plugin_options_db_version < TablePress::db_version ) {
91	// Allow more PHP execution time for update process.
92	// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
93	@set_time_limit( 300 );
94
95	// Add TablePress capabilities to the WP_Roles objects, for new installations and all versions below 12.
96	if ( $current_plugin_options_db_version < 12 ) {
97	TablePress::$model_options->add_access_capabilities();
98	}
99
100	if ( 0 === TablePress::$model_options->get( 'first_activation' ) ) {
101	// Save initial set of plugin options, and time of first activation of the plugin, on first activation.
102	TablePress::$model_options->update( array(
103	'first_activation' => time(),
104	'plugin_options_db_version' => TablePress::db_version,
105	) );
106	} else {
107	// Update Plugin Options Options, if necessary.
108	TablePress::$model_options->merge_plugin_options_defaults();
109	$updated_options = array(
110	'plugin_options_db_version' => TablePress::db_version,
111	'prev_tablepress_version' => TablePress::$model_options->get( 'tablepress_version' ),
112	'tablepress_version' => TablePress::version,
113	'message_plugin_update' => true,
114	);
115
116	// Only write files, if "Custom CSS" is to be used, and if there is "Custom CSS".
117	if ( TablePress::$model_options->get( 'use_custom_css' ) && '' !== TablePress::$model_options->get( 'custom_css' ) ) {
118	// Re-save "Custom CSS" to re-create all files (as TablePress Default CSS might have changed).
119	/**
120	* Load WP file functions to provide filesystem access functions early.
121	*/
122	require_once ABSPATH . 'wp-admin/includes/file.php';
123	/**
124	* Load WP admin template functions to provide `submit_button()` which is necessary for `request_filesystem_credentials()`.
125	*/
126	require_once ABSPATH . 'wp-admin/includes/template.php';
127	$tablepress_css = TablePress::load_class( 'TablePress_CSS', 'class-css.php', 'classes' );
128	$result = $tablepress_css->save_custom_css_to_file( TablePress::$model_options->get( 'custom_css' ), TablePress::$model_options->get( 'custom_css_minified' ) );
129	// If saving was successful, use "Custom CSS" file.
130	$updated_options['use_custom_css_file'] = $result;
131	// Increase the "Custom CSS" version number for cache busting.
132	if ( $result ) {
133	$updated_options['custom_css_version'] = TablePress::$model_options->get( 'custom_css_version' ) + 1;
134	}
135	}
136
137	TablePress::$model_options->update( $updated_options );
138
139	// Clear table caches.
140	TablePress::$model_table->invalidate_table_output_caches();
141
142	// Add mime type field to existing posts with the TablePress Custom Post Type, so that other plugins know that they are not dealing with plain text.
143	if ( $current_plugin_options_db_version < 25 ) {
144	TablePress::$model_table->add_mime_type_to_posts();
145	}
146
147	// Convert old parameter names to new ones in DataTables "Custom Commands".
148	if ( $current_plugin_options_db_version < 26 ) {
149	TablePress::$model_table->convert_datatables_parameter_names_tp15();
150	}
151	}
152	}
153
154	// Maybe update the table scheme in each existing table, independently from updating the plugin options.
155	if ( TablePress::$model_options->get( 'table_scheme_db_version' ) < TablePress::table_scheme_version ) {
156	TablePress::$model_table->merge_table_options_defaults();
157
158	TablePress::$model_options->update( array(
159	'table_scheme_db_version' => TablePress::table_scheme_version,
160	) );
161	}
162
163	/*
164	* Update User Options, if necessary.
165	* User Options are not saved in DB until first change occurs.
166	*/
167	if ( is_user_logged_in() && ( TablePress::$model_options->get( 'user_options_db_version' ) < TablePress::db_version ) ) {
168	TablePress::$model_options->merge_user_options_defaults();
169	TablePress::$model_options->update( array(
170	'user_options_db_version' => TablePress::db_version,
171	) );
172	}
173	}
174
175	} // class TablePress_Controller
176