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

give / includes / install.php

give / includes Last commit date

install.php

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