forked from DiscipleTools/disciple-tools-import
-
Notifications
You must be signed in to change notification settings - Fork 0
/
disciple-tools-import.php
364 lines (332 loc) · 12.1 KB
/
disciple-tools-import.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<?php
/**
* Plugin Name: Disciple Tools - Import
* Plugin URI: https://github.com/DiscipleTools/disciple-tools-import
* Description: Disciple Tools - Import description
* Version: 0.3
* Author URI: https://github.com/DiscipleTools
* GitHub Plugin URI: https://github.com/DiscipleTools/disciple-tools-import
* Requires at least: 4.7.0
* (Requires 4.7+ because of the integration of the REST API at 4.7 and the security requirements of this milestone version.)
* Tested up to: 5.1
*
* @package Disciple_Tools
* @link https://github.com/DiscipleTools
* @license GPL-2.0 or later
* https://www.gnu.org/licenses/gpl-2.0.html
*/
/*******************************************************************
/**
* The starter plugin is equipped with:
* 1. Wordpress style requirements
* 2. Travis Continuous Integration
* 3. Disciple Tools Theme presence check
* 4. Remote upgrade system for ongoing updates outside the Wordpress Directory
* 5. Multilingual ready
* 6. PHP Code Sniffer support (composer) @use /vendor/bin/phpcs and /vendor/bin/phpcbf
* 7. Starter Admin menu and options page with tabs.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
$disciple_tools_import_required_dt_theme_version = '0.19.0';
/**
* Gets the instance of the `Disciple_Tools_Import` class.
*
* @since 0.1
* @access public
* @return object|bool
*/
function disciple_tools_import() {
global $disciple_tools_import_required_dt_theme_version;
$wp_theme = wp_get_theme();
$version = $wp_theme->version;
/*
* Check if the Disciple.Tools theme is loaded and is the latest required version
*/
$is_theme_dt = strpos( $wp_theme->get_template(), "disciple-tools-theme" ) !== false || $wp_theme->name === "Disciple Tools";
if ( $is_theme_dt && version_compare( $version, $disciple_tools_import_required_dt_theme_version, "<" ) ) {
add_action( 'admin_notices', 'disciple_tools_import_hook_admin_notice' );
add_action( 'wp_ajax_dismissed_notice_handler', 'dt_hook_ajax_notice_handler' );
return false;
}
if ( !$is_theme_dt ){
return false;
}
/**
* Load useful function from the theme
*/
if ( !defined( 'DT_FUNCTIONS_READY' ) ){
require_once get_template_directory() . '/dt-core/global-functions.php';
}
/*
* Don't load the plugin on every rest request. Only those with the metrics namespace
*/
$is_rest = dt_is_rest();
if ( !$is_rest || strpos( dt_get_url_path(), 'disciple_tools_import' ) !== false ){
return Disciple_Tools_Import::get_instance();
}
}
add_action( 'after_setup_theme', 'disciple_tools_import' );
/**
* Singleton class for setting up the plugin.
*
* @since 0.1
* @access public
*/
class Disciple_Tools_Import {
/**
* Declares public variables
*
* @since 0.1
* @access public
* @return object
*/
public $token;
public $version;
public $dir_path = '';
public $dir_uri = '';
public $img_uri = '';
public $includes_path;
/**
* Returns the instance.
*
* @since 0.1
* @access public
* @return object
*/
public static function get_instance() {
static $instance = null;
if ( is_null( $instance ) ) {
$instance = new disciple_tools_import();
$instance->setup();
$instance->includes();
$instance->setup_actions();
}
return $instance;
}
/**
* Constructor method.
*
* @since 0.1
* @access private
* @return void
*/
private function __construct() {
}
/**
* Loads files needed by the plugin.
*
* @since 0.1
* @access public
* @return void
*/
private function includes() {
require_once( 'includes/admin/class-dt-import.php' );
require_once( 'includes/admin/admin-menu-and-tabs.php' );
}
/**
* Sets up globals.
*
* @since 0.1
* @access public
* @return void
*/
private function setup() {
// Main plugin directory path and URI.
$this->dir_path = trailingslashit( plugin_dir_path( __FILE__ ) );
$this->dir_uri = trailingslashit( plugin_dir_url( __FILE__ ) );
// Plugin directory paths.
$this->includes_path = trailingslashit( $this->dir_path . 'includes' );
// Plugin directory URIs.
$this->img_uri = trailingslashit( $this->dir_uri . 'img' );
// Admin and settings variables
$this->token = 'disciple_tools_import';
$this->version = '0.1';
// sample rest api class
require_once( 'includes/rest-api.php' );
Disciple_Tools_Import_Endpoints::instance();
}
/**
* Sets up main plugin actions and filters.
*
* @since 0.1
* @access public
* @return void
*/
private function setup_actions() {
if ( is_admin() ){
// Check for plugin updates
if ( ! class_exists( 'Puc_v4_Factory' ) ) {
require( get_template_directory() . '/dt-core/libraries/plugin-update-checker/plugin-update-checker.php' );
}
/**
* Below is the publicly hosted .json file that carries the version information. This file can be hosted
* anywhere as long as it is publicly accessible. You can download the version file listed below and use it as
* a template.
* Also, see the instructions for version updating to understand the steps involved.
* @see https://github.com/DiscipleTools/disciple-tools-version-control/wiki/How-to-Update-the-Starter-Plugin
*/
// @todo enable this section with your own hosted file
// $hosted_json = "https://raw.githubusercontent.com/DiscipleTools/disciple-tools-version-control/master/disciple-tools-starter-plugin-version-control.json";
// Puc_v4_Factory::buildUpdateChecker(
// $hosted_json,
// __FILE__,
// 'disciple-tools-starter-plugin'
// );
}
// Internationalize the text strings used.
add_action( 'plugins_loaded', array( $this, 'i18n' ), 2 );
}
/**
* Method that runs only when the plugin is activated.
*
* @since 0.1
* @access public
* @return void
*/
public static function activation() {
// Confirm 'Administrator' has 'manage_dt' privilege. This is key in 'remote' configuration when
// Disciple Tools theme is not installed, otherwise this will already have been installed by the Disciple Tools Theme
$role = get_role( 'administrator' );
if ( !empty( $role ) ) {
$role->add_cap( 'manage_dt' ); // gives access to dt plugin options
}
}
/**
* Method that runs only when the plugin is deactivated.
*
* @since 0.1
* @access public
* @return void
*/
public static function deactivation() {
delete_option( 'dismissed-dt-import' );
}
/**
* Loads the translation files.
*
* @since 0.1
* @access public
* @return void
*/
public function i18n() {
load_plugin_textdomain( 'disciple_tools_import', false, trailingslashit( dirname( plugin_basename( __FILE__ ) ) ). 'languages' );
}
/**
* Magic method to output a string if trying to use the object as a string.
*
* @since 0.1
* @access public
* @return string
*/
public function __toString() {
return 'disciple_tools_import';
}
/**
* Magic method to keep the object from being cloned.
*
* @since 0.1
* @access public
* @return void
*/
public function __clone() {
_doing_it_wrong( __FUNCTION__, esc_html__( 'Whoah, partner!', 'disciple_tools_import' ), '0.1' );
}
/**
* Magic method to keep the object from being unserialized.
*
* @since 0.1
* @access public
* @return void
*/
public function __wakeup() {
_doing_it_wrong( __FUNCTION__, esc_html__( 'Whoah, partner!', 'disciple_tools_import' ), '0.1' );
}
/**
* Magic method to prevent a fatal error when calling a method that doesn't exist.
*
* @since 0.1
* @access public
* @return null
*/
public function __call( $method = '', $args = array() ) {
// @codingStandardsIgnoreLine
_doing_it_wrong( "disciple_tools_import::{$method}", esc_html__( 'Method does not exist.', 'disciple_tools_import' ), '0.1' );
unset( $method, $args );
return null;
}
}
// end main plugin class
// Register activation hook.
register_activation_hook( __FILE__, [ 'Disciple_Tools_Import', 'activation' ] );
register_deactivation_hook( __FILE__, [ 'Disciple_Tools_Import', 'deactivation' ] );
function disciple_tools_import_hook_admin_notice() {
global $disciple_tools_import_required_dt_theme_version;
$wp_theme = wp_get_theme();
$current_version = $wp_theme->version;
$message = __( "'Disciple Tools - Starter Plugin' plugin requires 'Disciple Tools' theme to work. Please activate 'Disciple Tools' theme or make sure it is latest version.", "disciple_tools_import" );
if ( $wp_theme->get_template() === "disciple-tools-theme" ){
$message .= sprintf( esc_html__( 'Current Disciple Tools version: %1$s, required version: %2$s', 'disciple_tools_import' ), esc_html( $current_version ), esc_html( $disciple_tools_import_required_dt_theme_version ) );
}
// Check if it's been dismissed...
if ( ! get_option( 'dismissed-dt-import', false ) ) { ?>
<div class="notice notice-error notice-dt-import is-dismissible" data-notice="dt-import">
<p><?php echo esc_html( $message );?></p>
</div>
<script>
jQuery(function($) {
$( document ).on( 'click', '.notice-dt-import .notice-dismiss', function () {
$.ajax( ajaxurl, {
type: 'POST',
data: {
action: 'dismissed_notice_handler',
type: 'dt-import',
security: '<?php echo esc_html( wp_create_nonce( 'wp_rest_dismiss' ) ) ?>'
}
})
});
});
</script>
<?php }
}
/**
* AJAX handler to store the state of dismissible notices.
*/
//if ( !function_exists( "dt_hook_ajax_notice_handler" )){
// function dt_hook_ajax_notice_handler(){
// check_ajax_referer( 'wp_rest_dismiss', 'security' );
// if ( isset( $_POST["type"] ) ){
// $type = sanitize_text_field( wp_unslash( $_POST["type"] ) );
// update_option( 'dismissed-' . $type, true );
// }
// }
//}
/**
* Check for plugin updates even when the active theme is not Disciple.Tools
*
* Below is the publicly hosted .json file that carries the version information. This file can be hosted
* anywhere as long as it is publicly accessible. You can download the version file listed below and use it as
* a template.
* Also, see the instructions for version updating to understand the steps involved.
* @see https://github.com/DiscipleTools/disciple-tools-version-control/wiki/How-to-Update-the-Starter-Plugin
*/
add_action( 'plugins_loaded', function (){
if ( is_admin() || wp_doing_cron() ){
if ( ! class_exists( 'Puc_v4_Factory' ) ) {
// find the Disciple.Tools theme and load the plugin update checker.
foreach ( wp_get_themes() as $theme ){
if ( $theme->get( 'TextDomain' ) === "disciple_tools" && file_exists( $theme->get_stylesheet_directory() . '/dt-core/libraries/plugin-update-checker/plugin-update-checker.php' ) ){
require( $theme->get_stylesheet_directory() . '/dt-core/libraries/plugin-update-checker/plugin-update-checker.php' );
}
}
}
if ( class_exists( 'Puc_v4_Factory' ) ){
Puc_v4_Factory::buildUpdateChecker(
'https://raw.githubusercontent.com/DiscipleTools/disciple-tools-import/master/version-control.json',
__FILE__,
'disciple-tools-import'
);
}
}
} );