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

give / includes / install.php

give / includes Last commit date

install.php

550 lines

1	<?php
2
3	use Give\Form\Migrations\MoveOptionsToVisualAppearanceSection;
4	use Give\Framework\Migrations\Exceptions\DatabaseMigrationException;
5	use Give\Log\Migrations\MigrateExistingLogs;
6	use Give\MigrationLog\Migrations\CreateMigrationsTable;
7	use Give\Revenue\Migrations\AddPastDonationsToRevenueTable;
8
9	/**
10	* Install Function
11	*
12	* @package Give
13	* @since 1.0
14	* @copyright Copyright (c) 2016, GiveWP
15	* @license https://opensource.org/licenses/gpl-license GNU Public License
16	* @subpackage Functions/Install
17	*/
18
19	// Exit if accessed directly.
20	if (!defined('ABSPATH')) {
21	exit;
22	}
23
24	/**
25	* Install
26	*
27	* Runs on plugin install by setting up the post types, custom taxonomies, flushing rewrite rules to initiate the new
28	* 'donations' slug and also creates the plugin and populates the settings fields for those plugin pages. After
29	* successful install, the user is redirected to the Give Onboarding Wizard.
30	*
31	* @since 1.0
32	*
33	* @param bool $network_wide
34	*
35	* @return void
36	* @global $wpdb
37	*/
38	function give_install($network_wide = false)
39	{
40	global $wpdb;
41
42	if (is_multisite() && $network_wide) {
43	foreach ($wpdb->get_col("SELECT blog_id FROM $wpdb->blogs LIMIT 100") as $blog_id) {
44	switch_to_blog($blog_id);
45	give_run_install();
46	restore_current_blog();
47	}
48	} else {
49	give_run_install();
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	{
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	require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrade-functions.php';
117
118	// When new upgrade routines are added, mark them as complete on fresh install.
119	$upgrade_routines = [
120	'upgrade_give_user_caps_cleanup',
121	'upgrade_give_payment_customer_id',
122	'upgrade_give_offline_status',
123	'v18_upgrades_core_setting',
124	'v18_upgrades_form_metadata',
125	'v189_upgrades_levels_post_meta',
126	'v1812_update_amount_values',
127	'v1812_update_donor_purchase_values',
128	'v1813_update_user_roles',
129	'v1813_update_donor_user_roles',
130	'v1817_update_donation_iranian_currency_code',
131	'v1817_cleanup_user_roles',
132	'v1818_assign_custom_amount_set_donation',
133	'v1818_give_worker_role_cleanup',
134	'v20_upgrades_form_metadata',
135	'v20_logs_upgrades',
136	'v20_move_metadata_into_new_table',
137	'v20_rename_donor_tables',
138	'v20_upgrades_donor_name',
139	'v20_upgrades_user_address',
140	'v20_upgrades_payment_metadata',
141	'v201_upgrades_payment_metadata',
142	'v201_add_missing_donors',
143	'v201_move_metadata_into_new_table',
144	'v201_logs_upgrades',
145	'v210_verify_form_status_upgrades',
146	'v213_delete_donation_meta',
147	'v215_update_donor_user_roles',
148	'v220_rename_donation_meta_type',
149	'v224_update_donor_meta',
150	'v224_update_donor_meta_forms_id',
151	'v230_move_donor_note',
152	'v230_move_donation_note',
153	'v230_delete_donor_wall_related_donor_data',
154	'v230_delete_donor_wall_related_comment_data',
155	'v240_update_form_goal_progress',
156	'v241_remove_sale_logs',
157	'v270_store_stripe_account_for_donation',
158	AddPastDonationsToRevenueTable::id(),
159	MigrateExistingLogs::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	switch_to_blog($blog_id);
202	give_install();
203	restore_current_blog();
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	add_filter('wpmu_drop_tables', 'give_wpmu_drop_tables', 10, 2);
238
239	/**
240	* Post-installation
241	*
242	* Runs just after plugin installation and exposes the give_after_install hook.
243	*
244	* @since 1.0
245	* @return void
246	*/
247	function give_after_install()
248	{
249	if (!is_admin()) {
250	return;
251	}
252
253	$give_options = Give_Cache::get('_give_installed', true);
254	$give_table_check = get_option('_give_table_check', false);
255
256	if (false === $give_table_check \|\| current_time('timestamp') > $give_table_check) {
257	if (!@Give()->donor_meta->installed()) {
258	// Create the donor meta database.
259	// (this ensures it creates it on multisite instances where it is network activated).
260	@Give()->donor_meta->create_table();
261	}
262
263	if (!@Give()->donors->installed()) {
264	// Create the donor database.
265	// (this ensures it creates it on multisite instances where it is network activated).
266	@Give()->donors->create_table();
267	}
268
269	/**
270	* Fires after plugin installation.
271	*
272	* @since 1.0
273	*
274	* @param array $give_options Give plugin options.
275	*/
276	do_action('give_after_install', $give_options);
277
278	update_option('_give_table_check', (current_time('timestamp') + WEEK_IN_SECONDS), false);
279	}
280
281	// Delete the transient
282	if (false !== $give_options) {
283	Give_Cache::delete(Give_Cache::get_key('_give_installed'));
284	}
285	}
286
287	add_action('admin_init', 'give_after_install');
288
289
290	/**
291	* Install user roles on sub-sites of a network
292	*
293	* Roles do not get created when Give is network activation so we need to create them during admin_init
294	*
295	* @since 1.0
296	* @return void
297	*/
298	function give_install_roles_on_network()
299	{
300	global $wp_roles;
301
302	if (!is_object($wp_roles)) {
303	return;
304	}
305
306	if (!array_key_exists('give_manager', $wp_roles->roles)) {
307	// Create Give plugin roles
308	$roles = new Give_Roles();
309	$roles->add_roles();
310	$roles->add_caps();
311	}
312	}
313
314	add_action('admin_init', 'give_install_roles_on_network');
315
316	/**
317	* Default core setting values.
318	*
319	* @since 1.8
320	* @return array
321	*/
322	function give_get_default_settings()
323	{
324	$options = [
325	// General.
326	'base_country' => 'US',
327	'test_mode' => 'enabled',
328	'currency' => 'USD',
329	'currency_position' => 'before',
330	'session_lifetime' => '604800',
331	'email_access' => 'enabled',
332	'thousands_separator' => ',',
333	'decimal_separator' => '.',
334	'number_decimals' => 2,
335	'sequential-ordering_status' => 'enabled',
336
337	// Display options.
338	'css' => 'enabled',
339	'floatlabels' => 'disabled',
340	'company_field' => 'disabled',
341	'name_title_prefix' => 'disabled',
342	'forms_singular' => 'enabled',
343	'forms_archives' => 'enabled',
344	'forms_excerpt' => 'enabled',
345	'form_featured_img' => 'enabled',
346	'form_sidebar' => 'enabled',
347	'categories' => 'disabled',
348	'tags' => 'disabled',
349	'terms' => 'disabled',
350	'admin_notices' => 'enabled',
351	'cache' => 'enabled',
352	'uninstall_on_delete' => 'disabled',
353	'the_content_filter' => 'enabled',
354	'scripts_footer' => 'disabled',
355	'agree_to_terms_label' => __('Agree to Terms?', 'give'),
356	'agreement_text' => give_get_default_agreement_text(),
357	'babel_polyfill_script' => 'enabled',
358
359	// Default is manual gateway.
360	'gateways' => [
361	'manual' => 1,
362	'offline' => 1,
363	],
364	'gateways_v3' => [
365	'manual' => 1,
366	'offline' => 1,
367	],
368	'default_gateway' => 'manual',
369	'default_gateway_v3' => 'manual',
370
371	// Offline gateway setup.
372	'global_offline_donation_content' => give_get_default_offline_donation_content(),
373	'global_offline_donation_email' => give_get_default_offline_donation_content(),
374
375	// Billing address.
376	'give_offline_donation_enable_billing_fields' => 'disabled',
377
378	// Default donation notification email.
379	'donation_notification' => give_get_default_donation_notification_email(),
380
381	// Default email receipt message.
382	'donation_receipt' => give_get_default_donation_receipt_email(),
383
384	'donor_default_user_role' => 'give_donor',
385	Give()->routeForm->getOptionName() => 'give',
386
387	// Stripe accounts.
388	'_give_stripe_get_all_accounts' => [],
389
390	// Onboarding
391	'setup_page_enabled' => 'enabled',
392
393	// Advanced settings
394	'usage_tracking' => 'disabled',
395	];
396
397	return $options;
398	}
399
400	/**
401	* Default terms and conditions.
402	*/
403	function give_get_default_agreement_text()
404	{
405	$org_name = get_bloginfo('name');
406
407	$agreement = sprintf(
408	'<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>
409	<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>
410	<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>
411	<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>
412	<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>
413	<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>
414	<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>
415	<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>',
416	$org_name
417	);
418
419	return apply_filters('give_get_default_agreement_text', $agreement, $org_name);
420	}
421
422
423	/**
424	* This function will install give related page which is not created already.
425	*
426	* @since 1.8.11
427	*
428	* @return void
429	*/
430	function give_create_pages()
431	{
432	// Bailout if pages already created.
433	if (Give_Cache_Setting::get_option('give_install_pages_created')) {
434	return;
435	}
436
437	$options = [];
438
439	// Checks if the Success Page option exists AND that the page exists.
440	if (!get_post(give_get_option('success_page'))) {
441	// Donation Confirmation (Success) Page
442	$success = wp_insert_post(
443	[
444	'post_title' => esc_html__('Donation Confirmation', 'give'),
445	'post_content' => '[give_receipt]',
446	'post_status' => 'publish',
447	'post_author' => 1,
448	'post_type' => 'page',
449	'comment_status' => 'closed',
450	]
451	);
452
453	// Store our page IDs
454	$options['success_page'] = $success;
455	}
456
457	// Checks if the Failure Page option exists AND that the page exists.
458	if (!get_post(give_get_option('failure_page'))) {
459	// Failed Donation Page
460	$failed = wp_insert_post(
461	[
462	'post_title' => esc_html__('Donation Failed', 'give'),
463	'post_content' => esc_html__(
464	'We\'re sorry, your donation failed to process. Please try again or contact site support.',
465	'give'
466	),
467	'post_status' => 'publish',
468	'post_author' => 1,
469	'post_type' => 'page',
470	'comment_status' => 'closed',
471	]
472	);
473
474	$options['failure_page'] = $failed;
475	}
476
477	if (!empty($options)) {
478	update_option('give_settings', array_merge(give_get_settings(), $options), false);
479	}
480
481	add_option('give_install_pages_created', 1, '', false);
482	}
483
484	// @TODO we can add this hook only when plugin activate instead of every admin page load.
485	// @see known issue https://github.com/impress-org/give/issues/1848
486	add_action('admin_init', 'give_create_pages', -1);
487
488
489	/**
490	* Install tables on plugin update if missing
491	* Note: only for internal use
492	*
493	* @since 2.4.1
494	*
495	* @param string $old_version
496	*/
497	function give_install_tables_on_plugin_update($old_version)
498	{
499	update_option('give_version_upgraded_from', $old_version, false);
500	__give_register_tables();
501	}
502
503	add_action('update_option_give_version', 'give_install_tables_on_plugin_update', 0, 2);
504
505
506	/**
507	* Get array of table class objects
508	*
509	* Note: only for internal purpose use
510	*
511	* @sice 2.3.1
512	*/
513	function __give_get_tables()
514	{
515	$tables = [
516	'donors_db' => new Give_DB_Donors(),
517	'donor_meta_db' => new Give_DB_Donor_Meta(),
518	'comment_db' => new Give_DB_Comments(),
519	'comment_db_meta' => new Give_DB_Comment_Meta(),
520	'give_session' => new Give_DB_Sessions(),
521	'formmeta_db' => new Give_DB_Form_Meta(),
522	'sequential_db' => new Give_DB_Sequential_Ordering(),
523	'donation_meta' => new Give_DB_Payment_Meta(),
524	];
525
526	return $tables;
527	}
528
529	/**
530	* Register classes
531	* Note: only for internal purpose use
532	*
533	* @since 2.21.0 Install migration table on fresh install because this table is required to run migrations.
534	* @since 2.3.1
535	* @throws DatabaseMigrationException
536	*/
537	function __give_register_tables()
538	{
539	$tables = __give_get_tables();
540
541	/* @var Give_DB $table */
542	foreach ($tables as $table) {
543	if (!$table->installed()) {
544	$table->register_table();
545	}
546	}
547
548	give(CreateMigrationsTable::class)->run();
549	}
550