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

give / includes / install.php

give / includes Last commit date

install.php

552 lines

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