install.php — GiveWP – Donation Plugin and Fundraising Platform 2.3.1

give / includes / install.php

give / includes Last commit date

install.php

530 lines

1	<?php
2	/**
3	* Install Function
4	*
5	* @package Give
6	* @subpackage Functions/Install
7	* @copyright Copyright (c) 2016, GiveWP
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
21	* 'donations' slug and also creates the plugin and populates the settings fields for those plugin pages. After
22	* successful install, the user is redirected to the Give Welcome screen.
23	*
24	* @since 1.0
25	*
26	* @param bool $network_wide
27	*
28	* @global $wpdb
29	* @return void
30	*/
31	function give_install( $network_wide = false ) {
32
33	global $wpdb;
34
35	if ( is_multisite() && $network_wide ) {
36
37	foreach ( $wpdb->get_col( "SELECT blog_id FROM $wpdb->blogs LIMIT 100" ) as $blog_id ) {
38
39	switch_to_blog( $blog_id );
40	give_run_install();
41	restore_current_blog();
42
43	}
44
45	} else {
46
47	give_run_install();
48
49	}
50
51	}
52
53	/**
54	* Run the Give Install process.
55	*
56	* @since 1.5
57	* @return void
58	*/
59	function give_run_install() {
60	$give_options = give_get_settings();
61
62	// Setup the Give Custom Post Types.
63	give_setup_post_types();
64
65	// Add Upgraded From Option.
66	$current_version = get_option( 'give_version' );
67	if ( $current_version ) {
68	update_option( 'give_version_upgraded_from', $current_version, false );
69	}
70
71	// Setup some default options.
72	$options = array();
73
74	//Fresh Install? Setup Test Mode, Base Country (US), Test Gateway, Currency.
75	if ( empty( $current_version ) ) {
76	$options = array_merge( $options, give_get_default_settings() );
77	}
78
79	// Populate the default values.
80	update_option( 'give_settings', array_merge( $give_options, $options ), false );
81
82	/**
83	* Run plugin upgrades.
84	*
85	* @since 1.8
86	*/
87	do_action( 'give_upgrades' );
88
89	if ( GIVE_VERSION !== get_option( 'give_version' ) ) {
90	update_option( 'give_version', GIVE_VERSION, false );
91	}
92
93	// Create Give roles.
94	$roles = new Give_Roles();
95	$roles->add_roles();
96	$roles->add_caps();
97
98	// Set api version, end point and refresh permalink.
99	$api = new Give_API();
100	$api->add_endpoint();
101	update_option( 'give_default_api_version', 'v' . $api->get_version(), false );
102
103	flush_rewrite_rules();
104
105	// Create databases.
106	__give_register_tables();
107
108	// Add a temporary option to note that Give pages have been created.
109	Give_Cache::set( '_give_installed', $options, 30, true );
110
111	if ( ! $current_version ) {
112
113	require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrade-functions.php';
114
115	// When new upgrade routines are added, mark them as complete on fresh install.
116	$upgrade_routines = array(
117	'upgrade_give_user_caps_cleanup',
118	'upgrade_give_payment_customer_id',
119	'upgrade_give_offline_status',
120	'v18_upgrades_core_setting',
121	'v18_upgrades_form_metadata',
122	'v189_upgrades_levels_post_meta',
123	'v1812_update_amount_values',
124	'v1812_update_donor_purchase_values',
125	'v1813_update_user_roles',
126	'v1813_update_donor_user_roles',
127	'v1817_update_donation_iranian_currency_code',
128	'v1817_cleanup_user_roles',
129	'v1818_assign_custom_amount_set_donation',
130	'v1818_give_worker_role_cleanup',
131	'v20_upgrades_form_metadata',
132	'v20_logs_upgrades',
133	'v20_move_metadata_into_new_table',
134	'v20_rename_donor_tables',
135	'v20_upgrades_donor_name',
136	'v20_upgrades_user_address',
137	'v20_upgrades_payment_metadata',
138	'v201_upgrades_payment_metadata',
139	'v201_add_missing_donors',
140	'v201_move_metadata_into_new_table',
141	'v201_logs_upgrades',
142	'v210_verify_form_status_upgrades',
143	'v213_delete_donation_meta',
144	'v215_update_donor_user_roles',
145	'v220_rename_donation_meta_type',
146	'v224_update_donor_meta',
147	'v224_update_donor_meta_forms_id',
148	'v230_move_donor_note',
149	'v230_move_donation_note',
150	'v230_delete_donor_wall_related_donor_data',
151	'v230_delete_donor_wall_related_comment_data'
152	);
153
154	foreach ( $upgrade_routines as $upgrade ) {
155	give_set_upgrade_complete( $upgrade );
156	}
157	}
158
159	// Bail if activating from network, or bulk.
160	if ( is_network_admin() \|\| isset( $_GET['activate-multi'] ) ) {
161	return;
162	}
163
164	// Add the transient to redirect.
165	Give_Cache::set( '_give_activation_redirect', true, 30, true );
166	}
167
168	/**
169	* Network Activated New Site Setup.
170	*
171	* When a new site is created when Give is network activated this function runs the appropriate install function to set
172	* up the site for Give.
173	*
174	* @since 1.3.5
175	*
176	* @param int $blog_id The Blog ID created.
177	* @param int $user_id The User ID set as the admin.
178	* @param string $domain The URL.
179	* @param string $path Site Path.
180	* @param int $site_id The Site ID.
181	* @param array $meta Blog Meta.
182	*/
183	function give_on_create_blog( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {
184
185	if ( is_plugin_active_for_network( GIVE_PLUGIN_BASENAME ) ) {
186
187	switch_to_blog( $blog_id );
188	give_install();
189	restore_current_blog();
190
191	}
192
193	}
194
195	add_action( 'wpmu_new_blog', 'give_on_create_blog', 10, 6 );
196
197
198	/**
199	* Drop Give's custom tables when a mu site is deleted.
200	*
201	* @since 1.4.3
202	*
203	* @param array $tables The tables to drop.
204	* @param int $blog_id The Blog ID being deleted.
205	*
206	* @return array The tables to drop.
207	*/
208	function give_wpmu_drop_tables( $tables, $blog_id ) {
209
210	switch_to_blog( $blog_id );
211	$custom_tables = __give_get_tables();
212
213	/* @var Give_DB $table */
214	foreach ( $custom_tables as $table ) {
215	if ( $table->installed() ) {
216	$tables[] = $table->table_name;
217	}
218	}
219
220	restore_current_blog();
221
222	return $tables;
223
224	}
225
226	add_filter( 'wpmu_drop_tables', 'give_wpmu_drop_tables', 10, 2 );
227
228	/**
229	* Post-installation
230	*
231	* Runs just after plugin installation and exposes the give_after_install hook.
232	*
233	* @since 1.0
234	* @return void
235	*/
236	function give_after_install() {
237
238	if ( ! is_admin() ) {
239	return;
240	}
241
242	$give_options = Give_Cache::get( '_give_installed', true );
243	$give_table_check = get_option( '_give_table_check', false );
244
245	if ( false === $give_table_check \|\| current_time( 'timestamp' ) > $give_table_check ) {
246
247	if ( ! @Give()->donor_meta->installed() ) {
248
249	// Create the donor meta database.
250	// (this ensures it creates it on multisite instances where it is network activated).
251	@Give()->donor_meta->create_table();
252
253	}
254
255	if ( ! @Give()->donors->installed() ) {
256	// Create the donor database.
257	// (this ensures it creates it on multisite instances where it is network activated).
258	@Give()->donors->create_table();
259
260	/**
261	* Fires after plugin installation.
262	*
263	* @since 1.0
264	*
265	* @param array $give_options Give plugin options.
266	*/
267	do_action( 'give_after_install', $give_options );
268	}
269
270	update_option( '_give_table_check', ( current_time( 'timestamp' ) + WEEK_IN_SECONDS ), false );
271
272	}
273
274	// Delete the transient
275	if ( false !== $give_options ) {
276	Give_Cache::delete( Give_Cache::get_key( '_give_installed' ) );
277	}
278
279
280	}
281
282	add_action( 'admin_init', 'give_after_install' );
283
284
285	/**
286	* Install user roles on sub-sites of a network
287	*
288	* Roles do not get created when Give is network activation so we need to create them during admin_init
289	*
290	* @since 1.0
291	* @return void
292	*/
293	function give_install_roles_on_network() {
294
295	global $wp_roles;
296
297	if ( ! is_object( $wp_roles ) ) {
298	return;
299	}
300
301	if ( ! array_key_exists( 'give_manager', $wp_roles->roles ) ) {
302
303	// Create Give plugin roles
304	$roles = new Give_Roles();
305	$roles->add_roles();
306	$roles->add_caps();
307
308	}
309
310	}
311
312	add_action( 'admin_init', 'give_install_roles_on_network' );
313
314	/**
315	* Default core setting values.
316	*
317	* @since 1.8
318	* @return array
319	*/
320	function give_get_default_settings() {
321
322	$options = array(
323	// General.
324	'base_country' => 'US',
325	'test_mode' => 'enabled',
326	'currency' => 'USD',
327	'currency_position' => 'before',
328	'session_lifetime' => '604800',
329	'email_access' => 'enabled',
330	'thousands_separator' => ',',
331	'decimal_separator' => '.',
332	'number_decimals' => 2,
333	'sequential-ordering_status' => 'enabled',
334
335	// Display options.
336	'css' => 'enabled',
337	'floatlabels' => 'disabled',
338	'welcome' => 'enabled',
339	'company_field' => 'disabled',
340	'name_title_prefix' => 'disabled',
341	'forms_singular' => 'enabled',
342	'forms_archives' => 'enabled',
343	'forms_excerpt' => 'enabled',
344	'form_featured_img' => 'enabled',
345	'form_sidebar' => 'enabled',
346	'categories' => 'disabled',
347	'tags' => 'disabled',
348	'terms' => 'disabled',
349	'admin_notices' => 'enabled',
350	'cache' => 'enabled',
351	'uninstall_on_delete' => 'disabled',
352	'the_content_filter' => 'enabled',
353	'scripts_footer' => 'disabled',
354	'agree_to_terms_label' => __( 'Agree to Terms?', 'give' ),
355	'agreement_text' => give_get_default_agreement_text(),
356	'babel_polyfill_script' => 'enabled',
357
358	// Paypal IPN verification.
359	'paypal_verification' => 'enabled',
360
361	// Default is manual gateway.
362	'gateways' => array( 'manual' => 1, 'offline' => 1 ),
363	'default_gateway' => 'manual',
364
365	// Offline gateway setup.
366	'global_offline_donation_content' => give_get_default_offline_donation_content(),
367	'global_offline_donation_email' => give_get_default_offline_donation_content(),
368
369	// Billing address.
370	'give_offline_donation_enable_billing_fields' => 'disabled',
371
372	// Default donation notification email.
373	'donation_notification' => give_get_default_donation_notification_email(),
374
375	// Default email receipt message.
376	'donation_receipt' => give_get_default_donation_receipt_email(),
377
378	'donor_default_user_role' => 'give_donor',
379
380	);
381
382	return $options;
383	}
384
385	/**
386	* Default terms and conditions.
387	*/
388	function give_get_default_agreement_text() {
389
390	$org_name = get_bloginfo( 'name' );
391
392	$agreement = sprintf(
393	'<p>Acceptance of any contribution, gift or grant is at the discretion of the %1$s. The %1$s will not accept any gift unless it can be used or expended consistently with the purpose and mission of the %1$s.</p>
394	<p>No irrevocable gift, whether outright or life-income in character, will be accepted if under any reasonable set of circumstances the gift would jeopardize the donor’s financial security.</p>
395	<p>The %1$s will refrain from providing advice about the tax or other treatment of gifts and will encourage donors to seek guidance from their own professional advisers to assist them in the process of making their donation.</p>
396	<p>The %1$s will accept donations of cash or publicly traded securities. Gifts of in-kind services will be accepted at the discretion of the %1$s.</p>
397	<p>Certain other gifts, real property, personal property, in-kind gifts, non-liquid securities, and contributions whose sources are not transparent or whose use is restricted in some manner, must be reviewed prior to acceptance due to the special obligations raised or liabilities they may pose for %1$s.</p>
398	<p>The %1$s will provide acknowledgments to donors meeting tax requirements for property received by the charity as a gift. However, except for gifts of cash and publicly traded securities, no value shall be ascribed to any receipt or other form of substantiation of a gift received by %1$s.</p>
399	<p>The %1$s will respect the intent of the donor relating to gifts for restricted purposes and those relating to the desire to remain anonymous. With respect to anonymous gifts, the %1$s will restrict information about the donor to only those staff members with a need to know.</p>
400	<p>The %1$s will not compensate, whether through commissions, finders\' fees, or other means, any third party for directing a gift or a donor to the %1$s.</p>',
401	$org_name
402	);
403
404	return apply_filters( 'give_get_default_agreement_text', $agreement, $org_name );
405	}
406
407
408	/**
409	* This function will install give related page which is not created already.
410	*
411	* @since 1.8.11
412	*
413	* @return void
414	*/
415	function give_create_pages() {
416
417	// Bailout if pages already created.
418	if ( get_option( 'give_install_pages_created' ) ) {
419	return false;
420	}
421
422	$options = array();
423
424	// Checks if the Success Page option exists AND that the page exists.
425	if ( ! get_post( give_get_option( 'success_page' ) ) ) {
426
427	// Donation Confirmation (Success) Page
428	$success = wp_insert_post(
429	array(
430	'post_title' => esc_html__( 'Donation Confirmation', 'give' ),
431	'post_content' => '[give_receipt]',
432	'post_status' => 'publish',
433	'post_author' => 1,
434	'post_type' => 'page',
435	'comment_status' => 'closed'
436	)
437	);
438
439	// Store our page IDs
440	$options['success_page'] = $success;
441	}
442
443	// Checks if the Failure Page option exists AND that the page exists.
444	if ( ! get_post( give_get_option( 'failure_page' ) ) ) {
445
446	// Failed Donation Page
447	$failed = wp_insert_post(
448	array(
449	'post_title' => esc_html__( 'Donation Failed', 'give' ),
450	'post_content' => esc_html__( 'We\'re sorry, your donation failed to process. Please try again or contact site support.', 'give' ),
451	'post_status' => 'publish',
452	'post_author' => 1,
453	'post_type' => 'page',
454	'comment_status' => 'closed'
455	)
456	);
457
458	$options['failure_page'] = $failed;
459	}
460
461	// Checks if the History Page option exists AND that the page exists.
462	if ( ! get_post( give_get_option( 'history_page' ) ) ) {
463	// Donation History Page
464	$history = wp_insert_post(
465	array(
466	'post_title' => esc_html__( 'Donation History', 'give' ),
467	'post_content' => '[donation_history]',
468	'post_status' => 'publish',
469	'post_author' => 1,
470	'post_type' => 'page',
471	'comment_status' => 'closed'
472	)
473	);
474
475	$options['history_page'] = $history;
476	}
477
478	if ( ! empty( $options ) ) {
479	update_option( 'give_settings', array_merge( give_get_settings(), $options ), false );
480	}
481
482	add_option( 'give_install_pages_created', 1, '', false );
483	}
484
485	add_action( 'admin_init', 'give_create_pages', - 1 );
486
487
488	/**
489	* Get array of table class objects
490	*
491	* Note: only for internal purpose use
492	*
493	* @sice 2.3.1
494	*
495	*/
496	function __give_get_tables() {
497	$tables = array(
498	'donors_db' => new Give_DB_Donors(),
499	'donor_meta_db' => new Give_DB_Donor_Meta(),
500	'comment_db' => new Give_DB_Comments(),
501	'comment_db_meta' => new Give_DB_Comment_Meta(),
502	'give_session' => new Give_DB_Sessions(),
503	'log_db' => new Give_DB_Logs(),
504	'logmeta_db' => new Give_DB_Log_Meta(),
505	'formmeta_db' => new Give_DB_Form_Meta(),
506	'sequential_db' => new Give_DB_Sequential_Ordering(),
507	'donation_meta' => new Give_DB_Payment_Meta(),
508	);
509
510	return $tables;
511	}
512
513	/**
514	* Register classes
515	* Note: only for internal purpose use
516	*
517	* @sice 2.3.1
518	*
519	*/
520	function __give_register_tables() {
521	$tables = __give_get_tables();
522
523	/* @var Give_DB $table */
524	foreach ( $tables as $table ) {
525	if( ! $table->installed() ) {
526	$table->register_table();
527	}
528	}
529	}
530