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

give / includes / install.php

give / includes Last commit date

install.php

550 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	} 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 = array();
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	}
77
78	// Populate the default values.
79	update_option( 'give_settings', array_merge( $give_options, $options ), false );
80
81	/**
82	* Run plugin upgrades.
83	*
84	* @since 1.8
85	*/
86	do_action( 'give_upgrades' );
87
88	if ( GIVE_VERSION !== get_option( 'give_version' ) ) {
89	update_option( 'give_version', GIVE_VERSION, false );
90	}
91
92	// Create Give roles.
93	$roles = new Give_Roles();
94	$roles->add_roles();
95	$roles->add_caps();
96
97	// Set api version, end point and refresh permalink.
98	$api = new Give_API();
99	$api->add_endpoint();
100	update_option( 'give_default_api_version', 'v' . $api->get_version(), false );
101
102	flush_rewrite_rules();
103
104	// Create databases.
105	__give_register_tables();
106
107	// Add a temporary option to note that Give pages have been created.
108	Give_Cache::set( '_give_installed', $options, 30, true );
109
110	if ( ! $current_version ) {
111
112	require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrade-functions.php';
113
114	// When new upgrade routines are added, mark them as complete on fresh install.
115	$upgrade_routines = array(
116	'upgrade_give_user_caps_cleanup',
117	'upgrade_give_payment_customer_id',
118	'upgrade_give_offline_status',
119	'v18_upgrades_core_setting',
120	'v18_upgrades_form_metadata',
121	'v189_upgrades_levels_post_meta',
122	'v1812_update_amount_values',
123	'v1812_update_donor_purchase_values',
124	'v1813_update_user_roles',
125	'v1813_update_donor_user_roles',
126	'v1817_update_donation_iranian_currency_code',
127	'v1817_cleanup_user_roles',
128	'v1818_assign_custom_amount_set_donation',
129	'v1818_give_worker_role_cleanup',
130	'v20_upgrades_form_metadata',
131	'v20_logs_upgrades',
132	'v20_move_metadata_into_new_table',
133	'v20_rename_donor_tables',
134	'v20_upgrades_donor_name',
135	'v20_upgrades_user_address',
136	'v20_upgrades_payment_metadata',
137	'v201_upgrades_payment_metadata',
138	'v201_add_missing_donors',
139	'v201_move_metadata_into_new_table',
140	'v201_logs_upgrades',
141	'v210_verify_form_status_upgrades',
142	'v213_delete_donation_meta',
143	'v215_update_donor_user_roles',
144	'v220_rename_donation_meta_type',
145	'v224_update_donor_meta',
146	'v224_update_donor_meta_forms_id',
147	'v230_move_donor_note',
148	'v230_move_donation_note',
149	'v230_delete_donor_wall_related_donor_data',
150	'v230_delete_donor_wall_related_comment_data',
151	'v240_update_form_goal_progress',
152	'v241_remove_sale_logs',
153	);
154
155	foreach ( $upgrade_routines as $upgrade ) {
156	give_set_upgrade_complete( $upgrade );
157	}
158	}
159
160	// Bail if activating from network, or bulk.
161	if ( is_network_admin() \|\| isset( $_GET['activate-multi'] ) ) {
162	return;
163	}
164
165	// Add the transient to redirect.
166	Give_Cache::set( '_give_activation_redirect', true, 30, true );
167	}
168
169	/**
170	* Network Activated New Site Setup.
171	*
172	* When a new site is created when Give is network activated this function runs the appropriate install function to set
173	* up the site for Give.
174	*
175	* @since 1.3.5
176	*
177	* @param int $blog_id The Blog ID created.
178	* @param int $user_id The User ID set as the admin.
179	* @param string $domain The URL.
180	* @param string $path Site Path.
181	* @param int $site_id The Site ID.
182	* @param array $meta Blog Meta.
183	*/
184	function give_on_create_blog( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {
185
186	if ( is_plugin_active_for_network( GIVE_PLUGIN_BASENAME ) ) {
187
188	switch_to_blog( $blog_id );
189	give_install();
190	restore_current_blog();
191
192	}
193
194	}
195
196	add_action( 'wpmu_new_blog', 'give_on_create_blog', 10, 6 );
197
198
199	/**
200	* Drop Give's custom tables when a mu site is deleted.
201	*
202	* @since 1.4.3
203	*
204	* @param array $tables The tables to drop.
205	* @param int $blog_id The Blog ID being deleted.
206	*
207	* @return array The tables to drop.
208	*/
209	function give_wpmu_drop_tables( $tables, $blog_id ) {
210
211	switch_to_blog( $blog_id );
212	$custom_tables = __give_get_tables();
213
214	/* @var Give_DB $table */
215	foreach ( $custom_tables as $table ) {
216	if ( $table->installed() ) {
217	$tables[] = $table->table_name;
218	}
219	}
220
221	restore_current_blog();
222
223	return $tables;
224
225	}
226
227	add_filter( 'wpmu_drop_tables', 'give_wpmu_drop_tables', 10, 2 );
228
229	/**
230	* Post-installation
231	*
232	* Runs just after plugin installation and exposes the give_after_install hook.
233	*
234	* @since 1.0
235	* @return void
236	*/
237	function give_after_install() {
238
239	if ( ! is_admin() ) {
240	return;
241	}
242
243	$give_options = Give_Cache::get( '_give_installed', true );
244	$give_table_check = get_option( '_give_table_check', false );
245
246	if ( false === $give_table_check \|\| current_time( 'timestamp' ) > $give_table_check ) {
247
248	if ( ! @Give()->donor_meta->installed() ) {
249
250	// Create the donor meta database.
251	// (this ensures it creates it on multisite instances where it is network activated).
252	@Give()->donor_meta->create_table();
253
254	}
255
256	if ( ! @Give()->donors->installed() ) {
257	// Create the donor database.
258	// (this ensures it creates it on multisite instances where it is network activated).
259	@Give()->donors->create_table();
260
261	/**
262	* Fires after plugin installation.
263	*
264	* @since 1.0
265	*
266	* @param array $give_options Give plugin options.
267	*/
268	do_action( 'give_after_install', $give_options );
269	}
270
271	update_option( '_give_table_check', ( current_time( 'timestamp' ) + WEEK_IN_SECONDS ), false );
272
273	}
274
275	// Delete the transient
276	if ( false !== $give_options ) {
277	Give_Cache::delete( Give_Cache::get_key( '_give_installed' ) );
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(
363	'manual' => 1,
364	'offline' => 1,
365	'stripe' => 1,
366	),
367	'default_gateway' => 'manual',
368
369	// Offline gateway setup.
370	'global_offline_donation_content' => give_get_default_offline_donation_content(),
371	'global_offline_donation_email' => give_get_default_offline_donation_content(),
372
373	// Billing address.
374	'give_offline_donation_enable_billing_fields' => 'disabled',
375
376	// Default donation notification email.
377	'donation_notification' => give_get_default_donation_notification_email(),
378
379	// Default email receipt message.
380	'donation_receipt' => give_get_default_donation_receipt_email(),
381
382	'donor_default_user_role' => 'give_donor',
383
384	);
385
386	return $options;
387	}
388
389	/**
390	* Default terms and conditions.
391	*/
392	function give_get_default_agreement_text() {
393
394	$org_name = get_bloginfo( 'name' );
395
396	$agreement = sprintf(
397	'<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>
398	<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>
399	<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>
400	<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>
401	<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>
402	<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>
403	<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>
404	<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>',
405	$org_name
406	);
407
408	return apply_filters( 'give_get_default_agreement_text', $agreement, $org_name );
409	}
410
411
412	/**
413	* This function will install give related page which is not created already.
414	*
415	* @since 1.8.11
416	*
417	* @return void
418	*/
419	function give_create_pages() {
420
421	// Bailout if pages already created.
422	if ( Give_Cache_Setting::get_option( 'give_install_pages_created' ) ) {
423	return;
424	}
425
426	$options = array();
427
428	// Checks if the Success Page option exists AND that the page exists.
429	if ( ! get_post( give_get_option( 'success_page' ) ) ) {
430
431	// Donation Confirmation (Success) Page
432	$success = wp_insert_post(
433	array(
434	'post_title' => esc_html__( 'Donation Confirmation', 'give' ),
435	'post_content' => '[give_receipt]',
436	'post_status' => 'publish',
437	'post_author' => 1,
438	'post_type' => 'page',
439	'comment_status' => 'closed',
440	)
441	);
442
443	// Store our page IDs
444	$options['success_page'] = $success;
445	}
446
447	// Checks if the Failure Page option exists AND that the page exists.
448	if ( ! get_post( give_get_option( 'failure_page' ) ) ) {
449
450	// Failed Donation Page
451	$failed = wp_insert_post(
452	array(
453	'post_title' => esc_html__( 'Donation Failed', 'give' ),
454	'post_content' => esc_html__( 'We\'re sorry, your donation failed to process. Please try again or contact site support.', 'give' ),
455	'post_status' => 'publish',
456	'post_author' => 1,
457	'post_type' => 'page',
458	'comment_status' => 'closed',
459	)
460	);
461
462	$options['failure_page'] = $failed;
463	}
464
465	// Checks if the History Page option exists AND that the page exists.
466	if ( ! get_post( give_get_option( 'history_page' ) ) ) {
467	// Donation History Page
468	$history = wp_insert_post(
469	array(
470	'post_title' => esc_html__( 'Donation History', 'give' ),
471	'post_content' => '[donation_history]',
472	'post_status' => 'publish',
473	'post_author' => 1,
474	'post_type' => 'page',
475	'comment_status' => 'closed',
476	)
477	);
478
479	$options['history_page'] = $history;
480	}
481
482	if ( ! empty( $options ) ) {
483	update_option( 'give_settings', array_merge( give_get_settings(), $options ), false );
484	}
485
486	add_option( 'give_install_pages_created', 1, '', false );
487	}
488
489	// @TODO we can add this hook only when plugin activate instead of every admin page load.
490	// @see known issue https://github.com/impress-org/give/issues/1848
491	add_action( 'admin_init', 'give_create_pages', - 1 );
492
493
494	/**
495	* Install tables on plugin update if missing
496	* Note: only for internal use
497	*
498	* @since 2.4.1
499	*
500	* @param string $old_version
501	*/
502	function give_install_tables_on_plugin_update( $old_version ) {
503	update_option( 'give_version_upgraded_from', $old_version, false );
504	__give_register_tables();
505	}
506
507	add_action( 'update_option_give_version', 'give_install_tables_on_plugin_update', 0, 2 );
508
509
510	/**
511	* Get array of table class objects
512	*
513	* Note: only for internal purpose use
514	*
515	* @sice 2.3.1
516	*/
517	function __give_get_tables() {
518	$tables = array(
519	'donors_db' => new Give_DB_Donors(),
520	'donor_meta_db' => new Give_DB_Donor_Meta(),
521	'comment_db' => new Give_DB_Comments(),
522	'comment_db_meta' => new Give_DB_Comment_Meta(),
523	'give_session' => new Give_DB_Sessions(),
524	'log_db' => new Give_DB_Logs(),
525	'logmeta_db' => new Give_DB_Log_Meta(),
526	'formmeta_db' => new Give_DB_Form_Meta(),
527	'sequential_db' => new Give_DB_Sequential_Ordering(),
528	'donation_meta' => new Give_DB_Payment_Meta(),
529	);
530
531	return $tables;
532	}
533
534	/**
535	* Register classes
536	* Note: only for internal purpose use
537	*
538	* @sice 2.3.1
539	*/
540	function __give_register_tables() {
541	$tables = __give_get_tables();
542
543	/* @var Give_DB $table */
544	foreach ( $tables as $table ) {
545	if ( ! $table->installed() ) {
546	$table->register_table();
547	}
548	}
549	}
550