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

give / includes / install.php

give / includes Last commit date

install.php

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