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

give / includes / install.php

give / includes Last commit date

install.php

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