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

give / includes / install.php

give / includes Last commit date

install.php

480 lines

1	<?php
2	/**
3	* Install Function
4	*
5	* @package Give
6	* @subpackage Functions/Install
7	* @copyright Copyright (c) 2016, WordImpress
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
45	} else {
46
47	give_run_install();
48
49	}
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	$give_options = give_get_settings();
61
62	// Setup the Give Custom Post Types.
63	give_setup_post_types();
64
65	// Add Upgraded From Option.
66	$current_version = get_option( 'give_version' );
67	if ( $current_version ) {
68	update_option( 'give_version_upgraded_from', $current_version );
69	}
70
71	// Setup some default options.
72	$options = array();
73
74	//Fresh Install? Setup Test Mode, Base Country (US), Test Gateway, Currency.
75	if ( empty( $current_version ) ) {
76	$options = array_merge( $options, give_get_default_settings() );
77	}
78
79	// Populate the default values.
80	update_option( 'give_settings', array_merge( $give_options, $options ) );
81
82	/**
83	* Run plugin upgrades.
84	*
85	* @since 1.8
86	*/
87	do_action( 'give_upgrades' );
88
89	if ( GIVE_VERSION !== get_option( 'give_version' ) ) {
90	update_option( 'give_version', GIVE_VERSION );
91	}
92
93	// Create Give roles.
94	$roles = new Give_Roles();
95	$roles->add_roles();
96	$roles->add_caps();
97
98	// Set api version, end point and refresh permalink.
99	$api = new Give_API();
100	$api->add_endpoint();
101	update_option( 'give_default_api_version', 'v' . $api->get_version() );
102
103	flush_rewrite_rules();
104
105	// Create the donor databases.
106	$donors_db = new Give_DB_Donors();
107	$donors_db->create_table();
108	$donor_meta = new Give_DB_Donor_Meta();
109	$donor_meta->create_table();
110
111	// Check for PHP Session support, and enable if available.
112	$give_sessions = new Give_Session();
113	$give_sessions->use_php_sessions();
114
115	// Add a temporary option to note that Give pages have been created.
116	Give_Cache::set( '_give_installed', $options, 30, true );
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 = array(
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	);
151
152	foreach ( $upgrade_routines as $upgrade ) {
153	give_set_upgrade_complete( $upgrade );
154	}
155	}
156
157	// Bail if activating from network, or bulk.
158	if ( is_network_admin() \|\| isset( $_GET['activate-multi'] ) ) {
159	return;
160	}
161
162	// Add the transient to redirect.
163	Give_Cache::set( '_give_activation_redirect', true, 30, true );
164	}
165
166	/**
167	* Network Activated New Site Setup.
168	*
169	* When a new site is created when Give is network activated this function runs the appropriate install function to set
170	* up the site for Give.
171	*
172	* @since 1.3.5
173	*
174	* @param int $blog_id The Blog ID created.
175	* @param int $user_id The User ID set as the admin.
176	* @param string $domain The URL.
177	* @param string $path Site Path.
178	* @param int $site_id The Site ID.
179	* @param array $meta Blog Meta.
180	*/
181	function give_on_create_blog( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {
182
183	if ( is_plugin_active_for_network( GIVE_PLUGIN_BASENAME ) ) {
184
185	switch_to_blog( $blog_id );
186	give_install();
187	restore_current_blog();
188
189	}
190
191	}
192
193	add_action( 'wpmu_new_blog', 'give_on_create_blog', 10, 6 );
194
195
196	/**
197	* Drop Give's custom tables when a mu site is deleted.
198	*
199	* @since 1.4.3
200	*
201	* @param array $tables The tables to drop.
202	* @param int $blog_id The Blog ID being deleted.
203	*
204	* @return array The tables to drop.
205	*/
206	function give_wpmu_drop_tables( $tables, $blog_id ) {
207
208	switch_to_blog( $blog_id );
209	$donors_db = new Give_DB_Donors();
210	$donor_meta_db = new Give_DB_Donor_Meta();
211
212	if ( $donors_db->installed() ) {
213	$tables[] = $donors_db->table_name;
214	$tables[] = $donor_meta_db->table_name;
215	}
216	restore_current_blog();
217
218	return $tables;
219
220	}
221
222	add_filter( 'wpmu_drop_tables', 'give_wpmu_drop_tables', 10, 2 );
223
224	/**
225	* Post-installation
226	*
227	* Runs just after plugin installation and exposes the give_after_install hook.
228	*
229	* @since 1.0
230	* @return void
231	*/
232	function give_after_install() {
233
234	if ( ! is_admin() ) {
235	return;
236	}
237
238	$give_options = Give_Cache::get( '_give_installed', true );
239	$give_table_check = get_option( '_give_table_check', false );
240
241	if ( false === $give_table_check \|\| current_time( 'timestamp' ) > $give_table_check ) {
242
243	if ( ! @Give()->donor_meta->installed() ) {
244
245	// Create the donor meta database.
246	// (this ensures it creates it on multisite instances where it is network activated).
247	@Give()->donor_meta->create_table();
248
249	}
250
251	if ( ! @Give()->donors->installed() ) {
252	// Create the donor database.
253	// (this ensures it creates it on multisite instances where it is network activated).
254	@Give()->donors->create_table();
255
256	/**
257	* Fires after plugin installation.
258	*
259	* @since 1.0
260	*
261	* @param array $give_options Give plugin options.
262	*/
263	do_action( 'give_after_install', $give_options );
264	}
265
266	update_option( '_give_table_check', ( current_time( 'timestamp' ) + WEEK_IN_SECONDS ) );
267
268	}
269
270	// Delete the transient
271	if ( false !== $give_options ) {
272	Give_Cache::delete( Give_Cache::get_key( '_give_installed' ) );
273	}
274
275
276	}
277
278	add_action( 'admin_init', 'give_after_install' );
279
280
281	/**
282	* Install user roles on sub-sites of a network
283	*
284	* Roles do not get created when Give is network activation so we need to create them during admin_init
285	*
286	* @since 1.0
287	* @return void
288	*/
289	function give_install_roles_on_network() {
290
291	global $wp_roles;
292
293	if ( ! is_object( $wp_roles ) ) {
294	return;
295	}
296
297	if ( ! array_key_exists( 'give_manager', $wp_roles->roles ) ) {
298
299	// Create Give plugin roles
300	$roles = new Give_Roles();
301	$roles->add_roles();
302	$roles->add_caps();
303
304	}
305
306	}
307
308	add_action( 'admin_init', 'give_install_roles_on_network' );
309
310	/**
311	* Default core setting values.
312	*
313	* @since 1.8
314	* @return array
315	*/
316	function give_get_default_settings() {
317
318	$options = array(
319	// General.
320	'base_country' => 'US',
321	'test_mode' => 'enabled',
322	'currency' => 'USD',
323	'currency_position' => 'before',
324	'session_lifetime' => '604800',
325	'email_access' => 'enabled',
326	'thousands_separator' => ',',
327	'decimal_separator' => '.',
328	'number_decimals' => 2,
329	'sequential-ordering_status' => 'enabled',
330
331	// Display options.
332	'css' => 'enabled',
333	'floatlabels' => 'disabled',
334	'welcome' => 'enabled',
335	'company_field' => 'disabled',
336	'forms_singular' => 'enabled',
337	'forms_archives' => 'enabled',
338	'forms_excerpt' => 'enabled',
339	'form_featured_img' => 'enabled',
340	'form_sidebar' => 'enabled',
341	'categories' => 'disabled',
342	'tags' => 'disabled',
343	'terms' => 'disabled',
344	'admin_notices' => 'enabled',
345	'cache' => 'enabled',
346	'uninstall_on_delete' => 'disabled',
347	'the_content_filter' => 'enabled',
348	'scripts_footer' => 'disabled',
349	'agree_to_terms_label' => __( 'Agree to Terms?', 'give' ),
350	'agreement_text' => give_get_default_agreement_text(),
351
352	// Paypal IPN verification.
353	'paypal_verification' => 'enabled',
354
355	// Default is manual gateway.
356	'gateways' => array( 'manual' => 1, 'offline' => 1 ),
357	'default_gateway' => 'manual',
358
359	// Offline gateway setup.
360	'global_offline_donation_content' => give_get_default_offline_donation_content(),
361	'global_offline_donation_email' => give_get_default_offline_donation_content(),
362
363	// Billing address.
364	'give_offline_donation_enable_billing_fields' => 'disabled',
365
366	// Default donation notification email.
367	'donation_notification' => give_get_default_donation_notification_email(),
368
369	// Default email receipt message.
370	'donation_receipt' => give_get_default_donation_receipt_email(),
371
372	'donor_default_user_role' => 'give_donor',
373
374	);
375
376	return $options;
377	}
378
379	/**
380	* Default terms and conditions.
381	*/
382	function give_get_default_agreement_text() {
383
384	$org_name = get_bloginfo( 'name' );
385
386	$agreement = sprintf(
387	'<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>
388	<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>
389	<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>
390	<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>
391	<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>
392	<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>
393	<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>
394	<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>',
395	$org_name
396	);
397
398	return apply_filters( 'give_get_default_agreement_text', $agreement, $org_name );
399	}
400
401
402	/**
403	* This function will install give related page which is not created already.
404	*
405	* @since 1.8.11
406	*
407	* @return void
408	*/
409	function give_create_pages() {
410
411	// Bailout if pages already created.
412	if ( get_option( 'give_install_pages_created' ) ) {
413	return false;
414	}
415
416	$options = array();
417
418	// Checks if the Success Page option exists AND that the page exists.
419	if ( ! get_post( give_get_option( 'success_page' ) ) ) {
420
421	// Donation Confirmation (Success) Page
422	$success = wp_insert_post(
423	array(
424	'post_title' => esc_html__( 'Donation Confirmation', 'give' ),
425	'post_content' => '[give_receipt]',
426	'post_status' => 'publish',
427	'post_author' => 1,
428	'post_type' => 'page',
429	'comment_status' => 'closed'
430	)
431	);
432
433	// Store our page IDs
434	$options['success_page'] = $success;
435	}
436
437	// Checks if the Failure Page option exists AND that the page exists.
438	if ( ! get_post( give_get_option( 'failure_page' ) ) ) {
439
440	// Failed Donation Page
441	$failed = wp_insert_post(
442	array(
443	'post_title' => esc_html__( 'Donation Failed', 'give' ),
444	'post_content' => esc_html__( 'We\'re sorry, your donation failed to process. Please try again or contact site support.', 'give' ),
445	'post_status' => 'publish',
446	'post_author' => 1,
447	'post_type' => 'page',
448	'comment_status' => 'closed'
449	)
450	);
451
452	$options['failure_page'] = $failed;
453	}
454
455	// Checks if the History Page option exists AND that the page exists.
456	if ( ! get_post( give_get_option( 'history_page' ) ) ) {
457	// Donation History Page
458	$history = wp_insert_post(
459	array(
460	'post_title' => esc_html__( 'Donation History', 'give' ),
461	'post_content' => '[donation_history]',
462	'post_status' => 'publish',
463	'post_author' => 1,
464	'post_type' => 'page',
465	'comment_status' => 'closed'
466	)
467	);
468
469	$options['history_page'] = $history;
470	}
471
472	if ( ! empty( $options ) ) {
473	update_option( 'give_settings', array_merge( give_get_settings(), $options ) );
474	}
475
476	add_option( 'give_install_pages_created', 1, '', 'no' );
477	}
478
479	add_action( 'admin_init', 'give_create_pages', - 1 );
480