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

give / includes / install.php

give / includes Last commit date

install.php

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