Completed
Push — issues/1435 ( 51870f...2201af )
by Ravinder
35:02 queued 14:57
created

install.php ➔ give_run_install()   D

Complexity

Conditions 10
Paths 128

Size

Total Lines 172
Code Lines 92

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 10
eloc 92
nc 128
nop 0
dl 0
loc 172
rs 4.606
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 29 and the first side effect is on line 14.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
/**
3
 * Install Function
4
 *
5
 * @package     Give
6
 * @subpackage  Functions/Install
7
 * @copyright   Copyright (c) 2016, WordImpress
8
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
9
 * @since       1.0
10
 */
11
12
// Exit if accessed directly.
13
if ( ! defined( 'ABSPATH' ) ) {
14
	exit;
15
}
16
17
/**
18
 * Install
19
 *
20
 * Runs on plugin install by setting up the post types, custom taxonomies, flushing rewrite rules to initiate the new 'donations' slug and also creates the plugin and populates the settings fields for those plugin pages. After successful install, the user is redirected to the Give Welcome screen.
21
 *
22
 * @since 1.0
23
 *
24
 * @param bool $network_wide
25
 *
26
 * @global     $wpdb
27
 * @return void
28
 */
29
function give_install( $network_wide = false ) {
30
31
	global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
32
33
	if ( is_multisite() && $network_wide ) {
34
35
		foreach ( $wpdb->get_col( "SELECT blog_id FROM $wpdb->blogs LIMIT 100" ) as $blog_id ) {
36
37
			switch_to_blog( $blog_id );
38
			give_run_install();
39
			restore_current_blog();
40
41
		}
42
43
	} else {
44
45
		give_run_install();
46
47
	}
48
49
}
50
51
register_activation_hook( GIVE_PLUGIN_FILE, 'give_install' );
52
53
/**
54
 * Run the Give Install process.
55
 *
56
 * @since  1.5
57
 * @return void
58
 */
59
function give_run_install() {
60
61
	$give_options = give_get_settings();
62
63
	// Setup the Give Custom Post Types.
64
	give_setup_post_types();
65
66
	// Clear the permalinks.
67
	flush_rewrite_rules( false );
68
69
	// Add Upgraded From Option.
70
	$current_version = get_option( 'give_version' );
71
	if ( $current_version ) {
72
		update_option( 'give_version_upgraded_from', $current_version );
73
	}
74
75
	// Setup some default options.
76
	$options = array();
77
78
	// Checks if the Success Page option exists AND that the page exists.
79
	if ( ! get_post( give_get_option( 'success_page' ) ) ) {
80
81
		// Donation Confirmation (Success) Page
82
		$success = wp_insert_post(
83
			array(
84
				'post_title'     => esc_html__( 'Donation Confirmation', 'give' ),
85
				'post_content'   => '[give_receipt]',
86
				'post_status'    => 'publish',
87
				'post_author'    => 1,
88
				'post_type'      => 'page',
89
				'comment_status' => 'closed'
90
			)
91
		);
92
93
		// Store our page IDs
94
		$options['success_page'] = $success;
95
	}
96
97
	// Checks if the Failure Page option exists AND that the page exists.
98
	if ( ! get_post( give_get_option( 'failure_page' ) ) ) {
99
100
		// Failed Donation Page
101
		$failed = wp_insert_post(
102
			array(
103
				'post_title'     => esc_html__( 'Donation Failed', 'give' ),
104
				'post_content'   => esc_html__( 'We\'re sorry, your donation failed to process. Please try again or contact site support.', 'give' ),
105
				'post_status'    => 'publish',
106
				'post_author'    => 1,
107
				'post_type'      => 'page',
108
				'comment_status' => 'closed'
109
			)
110
		);
111
112
		$options['failure_page'] = $failed;
113
	}
114
115
	// Checks if the History Page option exists AND that the page exists.
116
	if ( ! get_post( give_get_option( 'history_page' ) ) ) {
117
		// Donation History Page
118
		$history = wp_insert_post(
119
			array(
120
				'post_title'     => esc_html__( 'Donation History', 'give' ),
121
				'post_content'   => '[donation_history]',
122
				'post_status'    => 'publish',
123
				'post_author'    => 1,
124
				'post_type'      => 'page',
125
				'comment_status' => 'closed'
126
			)
127
		);
128
129
		$options['history_page'] = $history;
130
	}
131
132
	//Fresh Install? Setup Test Mode, Base Country (US), Test Gateway, Currency.
133
	if ( empty( $current_version ) ) {
134
135
		// General.
136
		$options['base_country']       = 'US';
137
		$options['test_mode']          = 'enabled';
138
		$options['currency']           = 'USD';
139
		$options['currency_position']   = 'before';
140
		$options['session_lifetime']   = '604800';
141
		$options['email_access']       = 'disabled';
142
		$options['number_decimals']    = 2;
143
144
		// Display options.
145
		$options['css']                  = 'enabled';
146
		$options['floatlabels']          = 'disabled';
147
		$options['welcome']              = 'enabled';
148
		$options['forms_singular']       = 'enabled';
149
		$options['forms_archives']       = 'enabled';
150
		$options['forms_excerpt']        = 'enabled';
151
		$options['form_featured_img']    = 'enabled';
152
		$options['form_sidebar']         = 'enabled';
153
		$options['categories']           = 'disabled';
154
		$options['tags']                 = 'disabled';
155
		$options['terms']                = 'disabled';
156
		$options['admin_notices']        = 'enabled';
157
		$options['uninstall_on_delete']  = 'disabled';
158
		$options['the_content_filter']   = 'enabled';
159
		$options['scripts_footer']       = 'disabled';
160
161
		// Paypal IPN verification.
162
		$options['paypal_verification']       = 'enabled';
163
164
		// Default is manual gateway.
165
		$options['gateways']['manual'] = 1;
166
		$options['default_gateway']    = 'manual';
167
168
		// Offline gateway setup.
169
		$options['gateways']['offline']             = 1;
170
		$options['global_offline_donation_content'] = give_get_default_offline_donation_content();
171
		$options['global_offline_donation_email']   = give_get_default_offline_donation_content();
172
173
		// Billing address.
174
		$options['give_offline_donation_enable_billing_fields'] = 'disabled';
175
176
		// Default donation notification email.
177
		$options['donation_notification'] = give_get_default_donation_notification_email();
178
179
		// Default email receipt message.
180
		$options['donation_receipt'] = give_get_default_donation_receipt_email();
181
182
	}
183
184
	// Populate the default values.
185
	update_option( 'give_settings', array_merge( $give_options, $options ) );
186
	update_option( 'give_version', GIVE_VERSION );
187
188
	// Create Give roles.
189
	$roles = new Give_Roles();
190
	$roles->add_roles();
191
	$roles->add_caps();
192
193
	$api = new Give_API();
194
	update_option( 'give_default_api_version', 'v' . $api->get_version() );
195
196
	// Create the customers databases.
197
	@Give()->customers->create_table();
198
	@Give()->customer_meta->create_table();
199
200
	// Check for PHP Session support, and enable if available.
201
	Give()->session->use_php_sessions();
202
203
	// Add a temporary option to note that Give pages have been created.
204
	set_transient( '_give_installed', $options, 30 );
205
206
	if ( ! $current_version ) {
207
208
		require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrade-functions.php';
209
210
		// When new upgrade routines are added, mark them as complete on fresh install.
211
		$upgrade_routines = array(
212
			'upgrade_give_user_caps_cleanup',
213
			'upgrade_give_payment_customer_id',
214
			'upgrade_give_offline_status'
215
		);
216
217
		foreach ( $upgrade_routines as $upgrade ) {
218
			give_set_upgrade_complete( $upgrade );
219
		}
220
	}
221
222
	// Bail if activating from network, or bulk.
223
	if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) {
224
		return;
225
	}
226
227
	// Add the transient to redirect.
228
	set_transient( '_give_activation_redirect', true, 30 );
229
230
}
231
232
register_activation_hook( GIVE_PLUGIN_FILE, 'give_install' );
233
234
/**
235
 * Network Activated New Site Setup.
236
 *
237
 * When a new site is created when Give is network activated this function runs the appropriate install function to set up the site for Give.
238
 *
239
 * @since      1.3.5
240
 *
241
 * @param  int    $blog_id The Blog ID created.
242
 * @param  int    $user_id The User ID set as the admin.
243
 * @param  string $domain  The URL.
244
 * @param  string $path    Site Path.
245
 * @param  int    $site_id The Site ID.
246
 * @param  array  $meta    Blog Meta.
247
 */
248
function on_create_blog( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {
0 ignored issues
show
Unused Code introduced by
The parameter $user_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $domain is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $path is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $site_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $meta is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
249
250
	if ( is_plugin_active_for_network( GIVE_PLUGIN_BASENAME ) ) {
251
252
		switch_to_blog( $blog_id );
253
		give_install();
254
		restore_current_blog();
255
256
	}
257
258
}
259
260
add_action( 'wpmu_new_blog', 'on_create_blog', 10, 6 );
261
262
263
/**
264
 * Drop Give's custom tables when a mu site is deleted.
265
 *
266
 * @since  1.4.3
267
 *
268
 * @param  array $tables  The tables to drop.
269
 * @param  int   $blog_id The Blog ID being deleted.
270
 *
271
 * @return array          The tables to drop.
272
 */
273
function give_wpmu_drop_tables( $tables, $blog_id ) {
274
275
	switch_to_blog( $blog_id );
276
	$customers_db     = new Give_DB_Customers();
277
	$customer_meta_db = new Give_DB_Customer_Meta();
278
279
	if ( $customers_db->installed() ) {
280
		$tables[] = $customers_db->table_name;
281
		$tables[] = $customer_meta_db->table_name;
282
	}
283
	restore_current_blog();
284
285
	return $tables;
286
287
}
288
289
add_filter( 'wpmu_drop_tables', 'give_wpmu_drop_tables', 10, 2 );
290
291
/**
292
 * Post-installation
293
 *
294
 * Runs just after plugin installation and exposes the give_after_install hook.
295
 *
296
 * @since 1.0
297
 * @return void
298
 */
299
function give_after_install() {
300
301
	if ( ! is_admin() ) {
302
		return;
303
	}
304
305
	$give_options     = get_transient( '_give_installed' );
306
	$give_table_check = get_option( '_give_table_check', false );
307
308
	if ( false === $give_table_check || current_time( 'timestamp' ) > $give_table_check ) {
309
310
		if ( ! @Give()->customer_meta->installed() ) {
311
312
			// Create the customer meta database
313
			// (this ensures it creates it on multisite instances where it is network activated).
314
			@Give()->customer_meta->create_table();
315
316
		}
317
318
		if ( ! @Give()->customers->installed() ) {
319
			// Create the customers database
320
			// (this ensures it creates it on multisite instances where it is network activated).
321
			@Give()->customers->create_table();
322
323
			/**
324
			 * Fires after plugin installation.
325
			 *
326
			 * @since 1.0
327
			 *
328
			 * @param array $give_options Give plugin options.
329
			 */
330
			do_action( 'give_after_install', $give_options );
331
		}
332
333
		update_option( '_give_table_check', ( current_time( 'timestamp' ) + WEEK_IN_SECONDS ) );
334
335
	}
336
337
	// Delete the transient
338
	if ( false !== $give_options ) {
339
		delete_transient( '_give_installed' );
340
	}
341
342
343
}
344
345
add_action( 'admin_init', 'give_after_install' );
346
347
348
/**
349
 * Install user roles on sub-sites of a network
350
 *
351
 * Roles do not get created when Give is network activation so we need to create them during admin_init
352
 *
353
 * @since 1.0
354
 * @return void
355
 */
356
function give_install_roles_on_network() {
357
358
	global $wp_roles;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
359
360
	if ( ! is_object( $wp_roles ) ) {
361
		return;
362
	}
363
364
	if ( ! array_key_exists( 'give_manager', $wp_roles->roles ) ) {
365
366
		// Create Give plugin roles
367
		$roles = new Give_Roles();
368
		$roles->add_roles();
369
		$roles->add_caps();
370
371
	}
372
373
}
374
375
add_action( 'admin_init', 'give_install_roles_on_network' );
376