forked from civicrm/civicrm-wordpress
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcivicrm.php
1599 lines (1260 loc) · 46.4 KB
/
civicrm.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.4 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2013 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2013
*
*/
/*
Plugin Name: CiviCRM
Plugin URI: http://civicrm.org/
Description: CiviCRM - Growing and Sustaining Relationships
Author: CiviCRM LLC
Version: 4.4
Author URI: http://civicrm.org/
License: AGPL3
*/
/*
--------------------------------------------------------------------------------
WordPress resources for developers
--------------------------------------------------------------------------------
Not that they're ever adhered to anywhere other than core, but people do their
best to comply...
WordPress core coding standards:
http://make.wordpress.org/core/handbook/coding-standards/php/
WordPress HTML standards:
http://make.wordpress.org/core/handbook/coding-standards/html/
WordPress JavaScript standards:
http://make.wordpress.org/core/handbook/coding-standards/javascript/
--------------------------------------------------------------------------------
*/
// this file must not accessed directly
if ( ! defined( 'ABSPATH' ) ) exit;
// set version here: when it changes, will force JS to reload
define( 'CIVICRM_PLUGIN_VERSION', '4.4' );
// define commonly used items as constants
define( 'CIVICRM_PLUGIN_DIR', plugin_dir_path(__FILE__) );
if (!defined('CIVICRM_SETTINGS_PATH')) {
define( 'CIVICRM_SETTINGS_PATH', CIVICRM_PLUGIN_DIR . 'civicrm.settings.php' );
}
// prevent CiviCRM from rendering its own header
define( 'CIVICRM_UF_HEAD', TRUE );
/*
--------------------------------------------------------------------------------
CiviCRM_For_WordPress Class
--------------------------------------------------------------------------------
*/
class CiviCRM_For_WordPress {
/**
* declare our properties
*/
// plugin instance
private static $instance;
// plugin context
static $in_wordpress;
/**
* @description: getter method which returns the CiviCRM instance and optionally
* creates one if it does not already exist. Standard CiviCRM singleton pattern.
* @return CiviCRM plugin instance
*/
public static function singleton() {
// if it doesn't already exist...
if ( ! isset( self::$instance ) ) {
// create it
self::$instance = new CiviCRM_For_WordPress;
self::$instance->setup_instance();
}
// return existing instance
return self::$instance;
}
/**
* @description: dummy instance constructor
*/
function __construct() {}
/**
* @description: dummy magic method to prevent CiviCRM_For_WordPress from being cloned
*/
public function __clone() {
_doing_it_wrong( __FUNCTION__, __( 'Only one instance of CiviCRM_For_WordPress please', 'civicrm-wordpress' ), '4.4' );
}
/**
* @description: dummy magic method to prevent CiviCRM_For_WordPress from being unserialized
*/
public function __wakeup() {
_doing_it_wrong( __FUNCTION__, __( 'Please do not serialize CiviCRM_For_WordPress', 'civicrm-wordpress' ), '4.4' );
}
/**
* @description: method that runs only when CiviCRM plugin is activated
*/
public function activate() {
// Assign minimum capabilities for all WordPress roles and create 'anonymous_user' role
$this->set_wp_user_capabilities();
}
/**
* @description: set up the CiviCRM plugin instance
*/
public function setup_instance() {
// kick out if another instance is being inited
if ( isset( $this->in_wordpress ) ) {
wp_die( __( 'Only one instance of CiviCRM_For_WordPress please', 'civicrm-wordpress' ) );
}
// store context
self::$in_wordpress = ( isset( $_GET['page'] ) && $_GET['page'] == 'CiviCRM' ) ? TRUE : FALSE;
// there is no session handling in WP hence we start it for CiviCRM pages
if (!session_id()) {
session_start();
}
// this is required for ajax calls in civicrm
if ( $this->civicrm_in_wordpress() ) {
$_GET['noheader'] = TRUE;
} else {
$_GET['civicrm_install_type'] = 'wordpress';
}
$this->register_hooks();
// notify plugins
do_action( 'civicrm_instance_loaded' );
}
/**
* @description: getter for testing if CiviCRM is currently being displayed in WordPress
* @return bool $in_wordpress
*/
public function civicrm_in_wordpress() {
// already stored
return self::$in_wordpress;
}
/**
* @description: register hooks
*/
public function register_hooks() {
// always add the following hooks
// use translation files
add_action( 'plugins_loaded', array( $this, 'enable_translation' ) );
// add CiviCRM access capabilities to WordPress roles
add_action( 'init', array( $this, 'set_access_capabilities' ) );
// synchronise users on insert and update
add_action( 'user_register', array( $this, 'update_user' ) );
add_action( 'profile_update', array( $this, 'update_user' ) );
// register the CiviCRM shortcode
add_shortcode( 'civicrm', array( $this, 'shortcode_handler' ) );
// only when in WordPress admin...
if ( is_admin() ) {
// modify the admin menu
add_action( 'admin_menu', array( $this, 'add_menu_items' ) );
// the following three hooks CiviCRM button to post and page screens
// adds the CiviCRM button to post and page screens
add_action( 'media_buttons_context', array( $this, 'add_form_button' ) );
// adds the HTML triggered by the button above
add_action( 'admin_footer', array( $this, 'add_form_button_html' ) );
// add the javascript to make it all happen
add_action( 'admin_enqueue_scripts', array( $this, 'add_form_button_js' ) );
// check if settings file exist, do not show configuration link on
// install / settings page
if ( isset( $_GET['page'] ) && $_GET['page'] != 'civicrm-install' ) {
if ( ! file_exists( CIVICRM_SETTINGS_PATH ) ) {
add_action( 'admin_notices', array( $this, 'show_setup_warning' ) );
}
}
// merge CiviCRM's HTML header with the WordPress theme's header
add_action( 'admin_head', array( $this, 'wp_head' ) );
// not in admin
} else {
// merge CiviCRM's HTML header with the WordPress theme's header
add_action( 'wp_head', array( $this, 'wp_head' ) );
// invoke CiviCRM when a shortcode is detected in the post content
add_filter( 'get_header', array( $this, 'add_shortcode_includes' ) );
// if embedded...
if ( $this->civicrm_in_wordpress() ) {
// output buffer in footer
add_action( 'wp_footer', array( $this, 'buffer_end' ) );
// we do this here rather than as an action, since we don't control the order
$this->buffer_start();
$this->wp_frontend();
}
}
}
/**
* @description: initialize CiviCRM
* @return bool $success
*/
public function initialize() {
static $initialized = FALSE;
static $failure = FALSE;
if ( $failure ) {
return FALSE;
}
if ( ! $initialized ) {
// Check for php version and ensure its greater than minPhpVersion
$minPhpVersion = '5.3.3';
if ( version_compare( PHP_VERSION, $minPhpVersion ) < 0 ) {
echo '<p>' .
sprintf(
__( 'CiviCRM requires PHP Version %s or greater. You are running PHP Version %s', 'civicrm-wordpress' ),
$minPhpVersion,
PHP_VERSION
) .
'<p>';
exit();
}
// check for settings
if ( ! file_exists( CIVICRM_SETTINGS_PATH ) ) {
$error = FALSE;
} else {
$error = include_once ( CIVICRM_SETTINGS_PATH );
}
// autoload
require_once 'CRM/Core/ClassLoader.php';
CRM_Core_ClassLoader::singleton()->register();
// get ready for problems
$installLink = admin_url() . "options-general.php?page=civicrm-install";
$docLinkInstall = "http://wiki.civicrm.org/confluence/display/CRMDOC/WordPress+Installation+Guide";
$docLinkTrouble = "http://wiki.civicrm.org/confluence/display/CRMDOC/Installation+and+Configuration+Trouble-shooting";
$forumLink = "http://forum.civicrm.org/index.php/board,6.0.html";
// construct message
$errorMsgAdd = sprintf(
__( 'Please review the <a href="%s">WordPress Installation Guide</a> and the <a href="%s">Trouble-shooting page</a> for assistance. If you still need help installing, you can often find solutions to your issue by searching for the error message in the <a href="%s">installation support section of the community forum</a>.', 'civicrm-wordpress' ),
$docLinkInstall,
$docLinkTrouble,
$forumLink
);
// does install message get used?
$installMessage = sprintf(
__( 'Click <a href="%s">here</a> for fresh install.', 'civicrm-wordpress' ),
$installLink
);
if ($error == FALSE) {
header( 'Location: ' . admin_url() . 'options-general.php?page=civicrm-install' );
return FALSE;
}
// this does pretty much all of the civicrm initialization
if ( ! file_exists( $civicrm_root . 'CRM/Core/Config.php' ) ) {
$error = FALSE;
} else {
$error = include_once ( 'CRM/Core/Config.php' );
}
// have we got it?
if ( $error == FALSE ) {
// set static flag
$failure = TRUE;
// FIX ME - why?
wp_die(
"<strong><p class='error'>" .
sprintf(
__( 'Oops! - The path for including CiviCRM code files is not set properly. Most likely there is an error in the <em>civicrm_root</em> setting in your CiviCRM settings file (%s).', 'civicrm-wordpress' ),
CIVICRM_SETTINGS_PATH
) .
"</p><p class='error'> » " .
sprintf(
__( 'civicrm_root is currently set to: <em>%s</em>.', 'civicrm-wordpress' ),
$civicrm_root
) .
"</p><p class='error'>" . $errorMsgAdd . "</p></strong>"
);
// won't reach here!
return FALSE;
}
// set static flag
$initialized = TRUE;
// initialize the system by creating a config object
$config = CRM_Core_Config::singleton();
// sync the logged in user with WP
global $current_user;
if ( $current_user ) {
// sync procedure sets session values for logged in users
require_once 'CRM/Core/BAO/UFMatch.php';
CRM_Core_BAO_UFMatch::synchronize(
$current_user, // user object
FALSE, // do not update
'WordPress', // CMS
$this->get_civicrm_contact_type('Individual')
);
}
}
// notify plugins
do_action( 'civicrm_initialized' );
// success!
return TRUE;
}
/**
* @description: invoke CiviCRM in a WordPress context
* Callback function from add_menu_page()
* Callback from WordPress 'init' and 'the_content' hooks
* Also called by add_shortcode_includes() and _civicrm_update_user()
*/
public function invoke() {
if ( !in_the_loop() && !is_admin() && empty($_REQUEST['snippet']) ) {
return;
}
static $alreadyInvoked = FALSE;
if ( $alreadyInvoked ) {
return;
}
$alreadyInvoked = TRUE;
if ( ! $this->initialize() ) {
return '';
}
// CRM-12523
// WordPress has it's own timezone calculations
// Civi relies on the php default timezone which WP
// overrides with UTC in wp-settings.php
$wpBaseTimezone = date_default_timezone_get();
$wpUserTimezone = get_option('timezone_string');
if ($wpUserTimezone) {
date_default_timezone_set($wpUserTimezone);
CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
}
// Add our standard css & js
CRM_Core_Resources::singleton()->addCoreResources();
// CRM-95XX
// At this point we are calling a civicrm function
// Since WP messes up and always quotes the request, we need to reverse
// what it just did
$this->remove_wp_magic_quotes();
if ( isset( $_GET['q'] ) ) {
$args = explode('/', trim($_GET['q']));
} else {
$_GET['q'] = 'civicrm/dashboard';
$_GET['reset'] = 1;
$args = array('civicrm', 'dashboard');
}
global $current_user;
get_currentuserinfo();
/*
* bypass synchronize if running upgrade
* to avoid any serious non-recoverable error
* which might hinder the upgrade process.
*/
if ( CRM_Utils_Array::value('q', $_GET) != 'civicrm/upgrade' ) {
require_once 'CRM/Core/BAO/UFMatch.php';
CRM_Core_BAO_UFMatch::synchronize( $current_user, FALSE, 'WordPress', 'Individual', TRUE );
}
// do the business
CRM_Core_Invoke::invoke($args);
// restore WP's timezone
if ($wpBaseTimezone) {
date_default_timezone_set($wpBaseTimezone);
}
// notify plugins
do_action( 'civicrm_invoked' );
}
/**
* @description: load translation files
* A good reference on how to implement translation in WordPress:
* http://ottopress.com/2012/internationalization-youre-probably-doing-it-wrong/
*/
public function enable_translation() {
// not used, as there are no translations as yet
load_plugin_textdomain(
// unique name
'civicrm-wordpress',
// deprecated argument
FALSE,
// relative path to directory containing translation files
dirname( plugin_basename( __FILE__ ) ) . '/languages/'
);
}
/**
* @description: Adds menu items to WordPress admin menu
* Callback method for 'admin_menu' hook as set in register_hooks()
*/
public function add_menu_items() {
// check for settings file
if ( file_exists( CIVICRM_SETTINGS_PATH ) ) {
// use plugins_url( 'path/to/file.png', __FILE__ )
// see http://codex.wordpress.org/Function_Reference/plugins_url
// NB: given that URLs always use /, I see no need for DIR_SEP
$civilogo = plugins_url(
'civicrm/i/logo16px.png',
__FILE__
);
// add top level menu item
add_menu_page(
__( 'CiviCRM', 'civicrm-wordpress' ),
__( 'CiviCRM', 'civicrm-wordpress' ),
'access_civicrm',
'CiviCRM',
array( $this, 'invoke' ),
$civilogo
);
} else {
// add menu item to options menu
add_options_page(
__( 'CiviCRM Installer', 'civicrm-wordpress' ),
__( 'CiviCRM Installer', 'civicrm-wordpress' ),
'manage_options',
'civicrm-install',
array( $this, 'run_installer' )
);
}
}
/**
* @description: callback function for add_options_page() that runs the CiviCRM installer
*/
public function run_installer() {
// uses CIVICRM_PLUGIN_DIR instead of WP_PLUGIN_DIR
$installFile =
CIVICRM_PLUGIN_DIR .
'civicrm' . DIRECTORY_SEPARATOR .
'install' . DIRECTORY_SEPARATOR .
'index.php';
// Notice: Undefined variable: siteDir in:
// wp-content/plugins/civicrm/civicrm/install/index.php on line 456
include ( $installFile );
}
/**
* @description: callback function for missing settings file in register_hooks()
*/
public function show_setup_warning() {
$installLink = admin_url() . "options-general.php?page=civicrm-install";
echo '<div id="civicrm-warning" class="updated fade">' .
'<p><strong>' .
__( 'CiviCRM is almost ready.', 'civicrm-wordpress' ) .
'</strong> ' .
sprintf(
__( 'You must <a href="%s">configure CiviCRM</a> for it to work.', 'civicrm-wordpress' ),
$installLink
) .
'</p></div>';
}
/**
* @description: merge CiviCRM's HTML header with the WordPress theme's header
* Callback from WordPress 'admin_head' and 'wp_head' hooks
*/
public function wp_head() {
// CRM-11823 - If Civi bootstrapped, then merge its HTML header with the CMS's header
global $civicrm_root;
if ( empty( $civicrm_root ) ) {
return;
}
$region = CRM_Core_Region::instance('html-header', FALSE);
if ( $region ) {
echo $region->render( '' );
}
}
/**
* @description: callback function for 'get_header' hook
*/
public function add_shortcode_includes() {
global $post;
// don't parse content when there's no post object, eg on 404 pages
if ( ! is_object( $post ) ) return;
// check for existence of shortcode in content
if ( preg_match( '/\[civicrm/', $post->post_content ) ) {
if (!$this->initialize()) {
return;
}
// add CiviCRM core resources
CRM_Core_Resources::singleton()->addCoreResources();
}
}
/**
* @description: start buffering, called in register_hooks()
*/
public function buffer_start() {
ob_start( array( $this, 'buffer_callback' ) );
}
/**
* @description: flush buffer, callback for 'wp_footer'
*/
public function buffer_end() {
ob_end_flush();
}
/**
* @description: Callback for ob_start() in buffer_start()
* @return string $buffer the markup
*/
public function buffer_callback($buffer) {
// modify buffer here, and then return the updated code
return $buffer;
}
/**
* @description: CiviCRM's theme integration method
* Called by register_hooks() and shortcode_handler()
*/
public function wp_frontend( $shortcode = FALSE ) {
// kick out if not CiviCRM
if ( ! $this->initialize() ) { return; }
// add CiviCRM core resources
CRM_Core_Resources::singleton()->addCoreResources();
// set the frontend part for civicrm code
$config = CRM_Core_Config::singleton();
$config->userFrameworkFrontend = TRUE;
$argString = NULL;
$args = array();
if (isset( $_GET['q'])) {
$argString = trim($_GET['q']);
$args = explode('/', $argString);
}
$args = array_pad($args, 2, '');
// CMW: hacky procedure for overriding WordPress page/post:
// see comments on set_post_blank()
if ( $shortcode ) {
$this->turn_comments_off();
// CMW: this fails, because a lot of the page (eg, title) has already been rendered
$this->set_post_blank();
} else {
add_filter( 'get_header', array( $this, 'turn_comments_off' ) );
add_filter( 'get_header', array( $this, 'set_post_blank' ) );
}
// check permission
if ( ! $this->check_permission( $args ) ) {
if ( $shortcode ) {
$this->show_permission_denied();
} else {
add_filter( 'the_content', array( $this, 'show_permission_denied' ) );
}
return;
}
// CMW: why do we need this? Nothing that follows uses it...
require_once ABSPATH . WPINC . '/pluggable.php';
// output civicrm html only in a few cases and skip the WP header
if (
// snippet is set - i.e. ajax call
!empty($_GET['snippet']) ||
// ical feed (unless 'html' is specified)
(strpos($argString, 'civicrm/event/ical') === 0 && empty($_GET['html'])) ||
// ajax and file download urls
($args[0]) == 'civicrm' && in_array($args[1], array('ajax', 'file'))
) {
// from my limited understanding, putting this in the init hook allows civi to
// echo all output and exit before the theme code outputs anything - lobo
add_filter( 'init', array( $this, 'invoke' ) );
return;
}
// this places civicrm inside frontend theme
// wp documentation rocks if you know what you are looking for
// but best way is to check other plugin implementation :)
if ( $shortcode ) {
// CMW: review in the light of proper shortcode research
// First question: I can add more than one shortcode to a page, but
// only the first one appears in the output, even though this runs twice
ob_start(); // start buffering
$this->invoke(); // now, instead of echoing, shortcode output ends up in buffer
$content = ob_get_clean(); // save the output and flush the buffer
return $content;
} else {
// see comments on set_post_blank()
add_filter( 'the_content', array( $this, 'invoke' ) );
}
}
/**
* @description: override WordPress post comment status attribute in wp_frontend()
* see comments on set_post_blank()
*/
public function turn_comments_off() {
global $post;
// kick out when there's no post object, eg on 404 pages
if ( ! is_object( $post ) ) return;
// CMW: is there a reason why comments are not allowed?
$post->comment_status = 'closed';
}
/**
* @description: override WordPress post attributes in wp_frontend()
*
* CMW: the process of overriding WordPress post content should be done in a way
* analogous to how BuddyPress injects its content into a theme. After I have
* refactored the plugin, I will look into this more thoroughly.
*/
public function set_post_blank() {
global $post;
// kick out when there's no post object, eg on 404 pages
if ( ! is_object( $post ) ) return;
/*
CMW: the following is a proper no-no and affects much more than "posted on".
Not only does it not do what CiviCRM hopes it will, it throws:
Notice: Trying to get property of non-object in wp-includes/link-template.php on line 936
in most themes.
*/
// to hide posted on
$post->post_type = '';
/*
CMW: depending on the theme, clearing the post title here may not be effective.
Indeed, in the case of shortcodes (which are only parsed when the template has already
written out the markup for the post title) this absolutely cannot work.
What needs to be done is that the templating process needs to be intercepted and an
alternative dummy post needs to be created, which entirely replaces the existing post
object. BuddyPress has absctracted this, so it shouldn't be too problematic to copy
the logic it deploys.
I'm beginning to wonder why CiviCRM is even trying to take over the post/page...
If CiviCRM wants to offer pages that are Civi-specific, surely a Custom Post Type
would be a better option? There could then be CPTs for each "type" of CiviCRM content,
perhaps even auto-generated by CiviCRM through day-to-day use of the system.
*/
// to hide post title
$post->post_title = '';
// CMW: why is the author's edit post link cleared?
// hide the edit link
add_action( 'edit_post_link', array( $this, 'set_blank' ) );
}
/**
* @description: callback from 'edit_post_link' hook to remove edit link in set_post_blank()
* @return string always empty
*/
public function set_blank() {
return '';
}
/**
* @description: authentication function used by wp_frontend()
* @return bool true if authenticated, false otherwise
*/
public function check_permission( $args ) {
if ( $args[0] != 'civicrm' ) {
return FALSE;
}
$config = CRM_Core_Config::singleton();
// set frontend true
$config->userFrameworkFrontend = TRUE;
require_once 'CRM/Utils/Array.php';
// all profile and file urls, as well as user dashboard and tell-a-friend are valid
$arg1 = CRM_Utils_Array::value(1, $args);
$invalidPaths = array('admin');
if ( in_array( $arg1, $invalidPaths ) ) {
return FALSE;
}
return TRUE;
}
/**
* @description: called when authentication fails in wp_frontend()
* @return string warning message
*/
public function show_permission_denied() {
return __( 'You do not have permission to execute this url.', 'civicrm-wordpress' );
}
/**
* @description: only called by invoke() to undo WordPress default behaviour
* CMW: Should probably be a private method
*/
public function remove_wp_magic_quotes() {
// reassign globals
$_GET = stripslashes_deep($_GET);
$_POST = stripslashes_deep($_POST);
$_COOKIE = stripslashes_deep($_COOKIE);
$_REQUEST = stripslashes_deep($_REQUEST);
}
/**
* @description: keep WordPress user synced with CiviCRM Contact
* Callback function for 'user_register' hook
* Callback function for 'profile_update' hook
*
* CMW: seems to (wrongly) create new CiviCRM Contact every time a user changes their
* first_name or last_name attributes in WordPress.
*/
public function update_user( $userID ) {
$user = get_userdata( $userID );
if ( $user ) {
if (!$this->initialize()) {
return;
}
require_once 'CRM/Core/BAO/UFMatch.php';
// this does not return anything, so if we want to do anything further
// to the CiviCRM Contact, we have to search for it all over again...
CRM_Core_BAO_UFMatch::synchronize(
$user, // user object
TRUE, // update = true
'WordPress', // CMS
'Individual' // contact type
);
/*
// IN progress: synchronizeUFMatch does return the contact object, however
$civi_contact = CRM_Core_BAO_UFMatch::synchronizeUFMatch(
$user, // user object
$user->ID, // ID
$user->user_mail, // unique identifier
null // unused
'WordPress' // CMS
'Individual' // contact type
);
// now we can allow other plugins to do their thing
do_action( 'civicrm_contact_synced', $user, $civi_contact );
*/
}
}
/**
* @description: function to create 'anonymous_user' role, if 'anonymous_user' role is not
* in the WordPress installation and assign minimum capabilities for all WordPress roles
*
* The legacy global scope function civicrm_wp_set_capabilities() is called from
* upgrade_4_3_alpha1()
*/
public function set_wp_user_capabilities() {
global $wp_roles;
if ( ! isset( $wp_roles ) ) {
$wp_roles = new WP_Roles();
}
// Minimum capabilities (Civicrm permissions) arrays
$default_min_capabilities = array(
'access_civimail_subscribe_unsubscribe_pages' => 1,
'access_all_custom_data' => 1,
'access_uploaded_files' => 1,
'make_online_contributions' => 1,
'profile_create' => 1,
'profile_edit' => 1,
'profile_view' => 1,
'register_for_events' => 1,
'view_event_info' => 1,
'sign_civicrm_petition' => 1,
'view_public_civimail_content' => 1,
);
// allow other plugins to filter
$min_capabilities = apply_filters( 'civicrm_min_capabilities', $default_min_capabilities );
// Assign the Minimum capabilities (Civicrm permissions) to all WP roles
foreach ( $wp_roles->role_names as $role => $name ) {
$roleObj = $wp_roles->get_role( $role );
foreach ( $min_capabilities as $capability_name => $capability_value ) {
$roleObj->add_cap( $capability_name );
}
}
// Add the 'anonymous_user' role with minimum capabilities.
if ( ! in_array( 'anonymous_user' , $wp_roles->roles ) ) {
add_role(
'anonymous_user',
__( 'Anonymous User', 'civicrm-wordpress' ),
$min_capabilities
);
}
}
/**
* @description: add CiviCRM access capabilities to WordPress roles
* this is a callback for the 'init' hook in register_hooks()
*
* The legacy global scope function wp_civicrm_capability() is called by
* postProcess() in civicrm/CRM/ACL/Form/WordPress/Permissions.php
*/
public function set_access_capabilities() {
// test for existing global
global $wp_roles;
if ( ! isset( $wp_roles ) ) {
$wp_roles = new WP_Roles();
}
// give access to civicrm page menu link to particular roles
$roles = apply_filters( 'civicrm_access_roles', array( 'super admin', 'administrator' ) );
foreach ( $roles as $role ) {
$roleObj = $wp_roles->get_role( $role );
if (
is_object( $roleObj ) &&
is_array( $roleObj->capabilities ) &&
! array_key_exists( 'access_civicrm', $wp_roles->get_role( $role )->capabilities )
) {
$wp_roles->add_cap( $role, 'access_civicrm' );