Completed
Push — issues/1413 ( 44ccf0...c3d80f )
by Ravinder
69:45 queued 49:41
created

install.php ➔ give_run_install()   F

Complexity

Conditions 11
Paths 256

Size

Total Lines 138
Code Lines 66

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 11
eloc 66
nc 256
nop 0
dl 0
loc 138
rs 3.8181
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
		$options = array_merge( $options, give_get_default_settings() );
135
	}
136
137
	// Populate the default values.
138
	update_option( 'give_settings', array_merge( $give_options, $options ) );
139
140
	/**
141
	 * Run plugin upgrades.
142
	 *
143
	 * @since 1.8
144
	 */
145
	do_action( 'give_upgrades' );
146
147
148
	if( GIVE_VERSION !== get_option( 'give_version' ) ) {
149
		update_option( 'give_version', GIVE_VERSION );
150
	}
151
152
	// Create Give roles.
153
	$roles = new Give_Roles();
154
	$roles->add_roles();
155
	$roles->add_caps();
156
157
	$api = new Give_API();
158
	update_option( 'give_default_api_version', 'v' . $api->get_version() );
159
160
	// Create the customers databases.
161
	@Give()->customers->create_table();
162
	@Give()->customer_meta->create_table();
163
164
	// Check for PHP Session support, and enable if available.
165
	Give()->session->use_php_sessions();
166
167
	// Add a temporary option to note that Give pages have been created.
168
	set_transient( '_give_installed', $options, 30 );
169
170
	if ( ! $current_version ) {
171
172
		require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrade-functions.php';
173
174
		// When new upgrade routines are added, mark them as complete on fresh install.
175
		$upgrade_routines = array(
176
			'upgrade_give_user_caps_cleanup',
177
			'upgrade_give_payment_customer_id',
178
			'upgrade_give_offline_status',
179
			'v18_upgrades_core_setting',
180
			'v18_upgrades_form_metadata'
181
		);
182
183
		foreach ( $upgrade_routines as $upgrade ) {
184
			give_set_upgrade_complete( $upgrade );
185
		}
186
	}
187
188
	// Bail if activating from network, or bulk.
189
	if ( is_network_admin() || isset( $_GET['activate-multi'] ) ) {
190
		return;
191
	}
192
193
	// Add the transient to redirect.
194
	set_transient( '_give_activation_redirect', true, 30 );
195
196
}
197
198
register_activation_hook( GIVE_PLUGIN_FILE, 'give_install' );
199
200
/**
201
 * Network Activated New Site Setup.
202
 *
203
 * 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.
204
 *
205
 * @since      1.3.5
206
 *
207
 * @param  int    $blog_id The Blog ID created.
208
 * @param  int    $user_id The User ID set as the admin.
209
 * @param  string $domain  The URL.
210
 * @param  string $path    Site Path.
211
 * @param  int    $site_id The Site ID.
212
 * @param  array  $meta    Blog Meta.
213
 */
214
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...
215
216
	if ( is_plugin_active_for_network( GIVE_PLUGIN_BASENAME ) ) {
217
218
		switch_to_blog( $blog_id );
219
		give_install();
220
		restore_current_blog();
221
222
	}
223
224
}
225
226
add_action( 'wpmu_new_blog', 'on_create_blog', 10, 6 );
227
228
229
/**
230
 * Drop Give's custom tables when a mu site is deleted.
231
 *
232
 * @since  1.4.3
233
 *
234
 * @param  array $tables  The tables to drop.
235
 * @param  int   $blog_id The Blog ID being deleted.
236
 *
237
 * @return array          The tables to drop.
238
 */
239
function give_wpmu_drop_tables( $tables, $blog_id ) {
240
241
	switch_to_blog( $blog_id );
242
	$customers_db     = new Give_DB_Customers();
243
	$customer_meta_db = new Give_DB_Customer_Meta();
244
245
	if ( $customers_db->installed() ) {
246
		$tables[] = $customers_db->table_name;
247
		$tables[] = $customer_meta_db->table_name;
248
	}
249
	restore_current_blog();
250
251
	return $tables;
252
253
}
254
255
add_filter( 'wpmu_drop_tables', 'give_wpmu_drop_tables', 10, 2 );
256
257
/**
258
 * Post-installation
259
 *
260
 * Runs just after plugin installation and exposes the give_after_install hook.
261
 *
262
 * @since 1.0
263
 * @return void
264
 */
265
function give_after_install() {
266
267
	if ( ! is_admin() ) {
268
		return;
269
	}
270
271
	$give_options     = get_transient( '_give_installed' );
272
	$give_table_check = get_option( '_give_table_check', false );
273
274
	if ( false === $give_table_check || current_time( 'timestamp' ) > $give_table_check ) {
275
276
		if ( ! @Give()->customer_meta->installed() ) {
277
278
			// Create the customer meta database
279
			// (this ensures it creates it on multisite instances where it is network activated).
280
			@Give()->customer_meta->create_table();
281
282
		}
283
284
		if ( ! @Give()->customers->installed() ) {
285
			// Create the customers database
286
			// (this ensures it creates it on multisite instances where it is network activated).
287
			@Give()->customers->create_table();
288
289
			/**
290
			 * Fires after plugin installation.
291
			 *
292
			 * @since 1.0
293
			 *
294
			 * @param array $give_options Give plugin options.
295
			 */
296
			do_action( 'give_after_install', $give_options );
297
		}
298
299
		update_option( '_give_table_check', ( current_time( 'timestamp' ) + WEEK_IN_SECONDS ) );
300
301
	}
302
303
	// Delete the transient
304
	if ( false !== $give_options ) {
305
		delete_transient( '_give_installed' );
306
	}
307
308
309
}
310
311
add_action( 'admin_init', 'give_after_install' );
312
313
314
/**
315
 * Install user roles on sub-sites of a network
316
 *
317
 * Roles do not get created when Give is network activation so we need to create them during admin_init
318
 *
319
 * @since 1.0
320
 * @return void
321
 */
322
function give_install_roles_on_network() {
323
324
	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...
325
326
	if ( ! is_object( $wp_roles ) ) {
327
		return;
328
	}
329
330
	if ( ! array_key_exists( 'give_manager', $wp_roles->roles ) ) {
331
332
		// Create Give plugin roles
333
		$roles = new Give_Roles();
334
		$roles->add_roles();
335
		$roles->add_caps();
336
337
	}
338
339
}
340
341
add_action( 'admin_init', 'give_install_roles_on_network' );
342
343
/**
344
 * Default core setting values.
345
 *
346
 * @since 1.8
347
 * @return array
348
 */
349
function give_get_default_settings() {
350
	$options = array(
351
		// General.
352
		'base_country'                                => 'US',
353
		'test_mode'                                   => 'enabled',
354
		'currency'                                    => 'USD',
355
		'currency_position'                           => 'before',
356
		'session_lifetime'                            => '604800',
357
		'email_access'                                => 'disabled',
358
		'number_decimals'                             => 2,
359
360
		// Display options.
361
		'css'                                         => 'enabled',
362
		'floatlabels'                                 => 'disabled',
363
		'welcome'                                     => 'enabled',
364
		'forms_singular'                              => 'enabled',
365
		'forms_archives'                              => 'enabled',
366
		'forms_excerpt'                               => 'enabled',
367
		'form_featured_img'                           => 'enabled',
368
		'form_sidebar'                                => 'enabled',
369
		'categories'                                  => 'disabled',
370
		'tags'                                        => 'disabled',
371
		'terms'                                       => 'disabled',
372
		'admin_notices'                               => 'enabled',
373
		'uninstall_on_delete'                         => 'disabled',
374
		'the_content_filter'                          => 'enabled',
375
		'scripts_footer'                              => 'disabled',
376
377
		// Paypal IPN verification.
378
		'paypal_verification'                         => 'enabled',
379
380
		// Default is manual gateway.
381
		'gateways'                                    => array( 'manual' => 1, 'offline' => 1 ),
382
		'default_gateway'                             => 'manual',
383
384
		// Offline gateway setup.
385
		'global_offline_donation_content'             => give_get_default_offline_donation_content(),
386
		'global_offline_donation_email'               => give_get_default_offline_donation_content(),
387
388
		// Billing address.
389
		'give_offline_donation_enable_billing_fields' => 'disabled',
390
391
		// Default donation notification email.
392
		'donation_notification'                       => give_get_default_donation_notification_email(),
393
394
		// Default email receipt message.
395
		'donation_receipt'                            => give_get_default_donation_receipt_email(),
396
	);
397
398
	return $options;
399
}
400