-
-
Notifications
You must be signed in to change notification settings - Fork 814
/
WordPress.php
1740 lines (1538 loc) · 50.4 KB
/
WordPress.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
/*
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
/**
* WordPress specific stuff goes here
*/
class CRM_Utils_System_WordPress extends CRM_Utils_System_Base {
/**
* Get a normalized version of the wpBasePage.
*/
public static function getBasePage() {
return strtolower(rtrim(Civi::settings()->get('wpBasePage'), '/'));
}
/**
*/
public function __construct() {
/**
* deprecated property to check if this is a drupal install. The correct method is to have functions on the UF classes for all UF specific
* functions and leave the codebase oblivious to the type of CMS
* @deprecated
* @var bool
*/
$this->is_drupal = FALSE;
$this->is_wordpress = TRUE;
}
public function initialize() {
parent::initialize();
$this->registerPathVars();
}
/**
* Specify the default computation for various paths/URLs.
*/
protected function registerPathVars():void {
$isNormalBoot = function_exists('get_option');
if ($isNormalBoot) {
// Normal mode - CMS boots first, then calls Civi. "Normal" web pages and newer extern routes.
// To simplify the code-paths, some items are re-registered with WP-specific functions.
$cmsRoot = function() {
return [
'path' => untrailingslashit(ABSPATH),
'url' => home_url(),
];
};
Civi::paths()->register('cms', $cmsRoot);
Civi::paths()->register('cms.root', $cmsRoot);
Civi::paths()->register('civicrm.root', function () {
return [
'path' => CIVICRM_PLUGIN_DIR . 'civicrm' . DIRECTORY_SEPARATOR,
'url' => CIVICRM_PLUGIN_URL . 'civicrm/',
];
});
Civi::paths()->register('wp.frontend.base', function () {
return [
'url' => home_url('/'),
];
});
Civi::paths()->register('wp.frontend', function () {
$config = CRM_Core_Config::singleton();
$basepage = get_page_by_path($config->wpBasePage);
return [
'url' => get_permalink($basepage->ID),
];
});
Civi::paths()->register('wp.backend.base', function () {
return [
'url' => admin_url(),
];
});
Civi::paths()->register('wp.backend', function() {
return [
'url' => admin_url('admin.php'),
];
});
Civi::paths()->register('civicrm.files', function () {
$upload_dir = wp_get_upload_dir();
$old = CRM_Core_Config::singleton()->userSystem->getDefaultFileStorage();
$new = [
'path' => $upload_dir['basedir'] . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR,
'url' => $upload_dir['baseurl'] . '/civicrm/',
];
if ($old['path'] === $new['path']) {
return $new;
}
$oldExists = file_exists($old['path']);
$newExists = file_exists($new['path']);
if ($oldExists && !$newExists) {
return $old;
}
elseif (!$oldExists && $newExists) {
return $new;
}
elseif (!$oldExists && !$newExists) {
// neither exists. but that's ok. we're in one of these two cases:
// - we're just starting installation... which will get sorted in a moment
// when someone calls mkdir().
// - we're running a bespoke setup... which will get sorted in a moment
// by applying $civicrm_paths.
return $new;
}
elseif ($oldExists && $newExists) {
// situation ambiguous. encourage admin to set value explicitly.
if (!isset($GLOBALS['civicrm_paths']['civicrm.files'])) {
\Civi::log()->warning("The system has data from both old+new conventions. Please use civicrm.settings.php to set civicrm.files explicitly.");
}
return $new;
}
});
}
else {
// Legacy support - only relevant for older extern routes.
Civi::paths()
->register('wp.frontend.base', function () {
return ['url' => rtrim(CIVICRM_UF_BASEURL, '/') . '/'];
})
->register('wp.frontend', function () {
$config = \CRM_Core_Config::singleton();
$suffix = defined('CIVICRM_UF_WP_BASEPAGE') ? CIVICRM_UF_WP_BASEPAGE : $config->wpBasePage;
return [
'url' => Civi::paths()->getVariable('wp.frontend.base', 'url') . $suffix,
];
})
->register('wp.backend.base', function () {
return ['url' => rtrim(CIVICRM_UF_BASEURL, '/') . '/wp-admin/'];
})
->register('wp.backend', function () {
return [
'url' => Civi::paths()->getVariable('wp.backend.base', 'url') . 'admin.php',
];
});
}
}
/**
* @inheritDoc
*/
public function setTitle($title, $pageTitle = NULL) {
if (!$pageTitle) {
$pageTitle = $title;
}
// FIXME: Why is this global?
global $civicrm_wp_title;
$civicrm_wp_title = $title;
// yes, set page title, depending on context
$context = civi_wp()->civicrm_context_get();
switch ($context) {
case 'admin':
case 'shortcode':
$template = CRM_Core_Smarty::singleton();
$template->assign('pageTitle', $pageTitle);
}
}
/**
* Moved from CRM_Utils_System_Base
*/
public function getDefaultFileStorage() {
// NOTE: On WordPress, this will be circumvented in the future. However,
// should retain it to allow transitional/upgrade code determine the old value.
$config = CRM_Core_Config::singleton();
$cmsUrl = CRM_Utils_System::languageNegotiationURL($config->userFrameworkBaseURL, FALSE, TRUE);
$cmsPath = $this->cmsRootPath();
$filesPath = CRM_Utils_File::baseFilePath();
$filesRelPath = CRM_Utils_File::relativize($filesPath, $cmsPath);
$filesURL = rtrim($cmsUrl, '/') . '/' . ltrim($filesRelPath, ' /');
return [
'url' => CRM_Utils_File::addTrailingSlash($filesURL, '/'),
'path' => CRM_Utils_File::addTrailingSlash($filesPath),
];
}
/**
* Determine the location of the CiviCRM source tree.
*
* @return array
* - url: string. ex: "http://example.com/sites/all/modules/civicrm"
* - path: string. ex: "/var/www/sites/all/modules/civicrm"
*/
public function getCiviSourceStorage():array {
global $civicrm_root;
// Don't use $config->userFrameworkBaseURL; it has garbage on it.
// More generally, we shouldn't be using $config here.
if (!defined('CIVICRM_UF_BASEURL')) {
throw new RuntimeException('Undefined constant: CIVICRM_UF_BASEURL');
}
$cmsPath = $this->cmsRootPath();
// $config = CRM_Core_Config::singleton();
// overkill? // $cmsUrl = CRM_Utils_System::languageNegotiationURL($config->userFrameworkBaseURL, FALSE, TRUE);
$cmsUrl = CIVICRM_UF_BASEURL;
if (CRM_Utils_System::isSSL()) {
$cmsUrl = str_replace('http://', 'https://', $cmsUrl);
}
$civiRelPath = CRM_Utils_File::relativize(realpath($civicrm_root), realpath($cmsPath));
$civiUrl = rtrim($cmsUrl, '/') . '/' . ltrim($civiRelPath, ' /');
return [
'url' => CRM_Utils_File::addTrailingSlash($civiUrl, '/'),
'path' => CRM_Utils_File::addTrailingSlash($civicrm_root),
];
}
/**
* @inheritDoc
*/
public function appendBreadCrumb($breadCrumbs) {
$breadCrumb = wp_get_breadcrumb();
if (is_array($breadCrumbs)) {
foreach ($breadCrumbs as $crumbs) {
if (stripos($crumbs['url'], 'id%%')) {
$args = ['cid', 'mid'];
foreach ($args as $a) {
$val = CRM_Utils_Request::retrieve($a, 'Positive', CRM_Core_DAO::$_nullObject,
FALSE, NULL, $_GET
);
if ($val) {
$crumbs['url'] = str_ireplace("%%{$a}%%", $val, $crumbs['url']);
}
}
}
$breadCrumb[] = "<a href=\"{$crumbs['url']}\">{$crumbs['title']}</a>";
}
}
CRM_Core_Smarty::singleton()->assign('breadcrumb', $breadCrumb);
wp_set_breadcrumb($breadCrumb);
}
/**
* @inheritDoc
*/
public function resetBreadCrumb() {
$bc = [];
wp_set_breadcrumb($bc);
}
/**
* @inheritDoc
*/
public function addHTMLHead($head) {
static $registered = FALSE;
if (!$registered) {
// front-end view
add_action('wp_head', [__CLASS__, '_showHTMLHead']);
// back-end views
add_action('admin_head', [__CLASS__, '_showHTMLHead']);
$registered = TRUE;
}
CRM_Core_Region::instance('wp_head')->add([
'markup' => $head,
]);
}
/**
* WP action callback.
*/
public static function _showHTMLHead() {
$region = CRM_Core_Region::instance('wp_head', FALSE);
if ($region) {
echo $region->render('');
}
}
/**
* @inheritDoc
*/
public function url(
$path = NULL,
$query = NULL,
$absolute = FALSE,
$fragment = NULL,
$frontend = FALSE,
$forceBackend = FALSE
) {
$config = CRM_Core_Config::singleton();
$frontend_url = '';
$separator = '&';
$fragment = isset($fragment) ? ('#' . $fragment) : '';
$path = CRM_Utils_String::stripPathChars($path);
$basepage = FALSE;
// FIXME: Why bootstrap in url()?
// Generally want to define 1-2 strategic places to put bootstrap.
if (!function_exists('get_option')) {
$this->loadBootStrap();
}
// When on the front-end.
if ($config->userFrameworkFrontend) {
// Try and find the "calling" page/post.
global $post;
if ($post) {
$frontend_url = get_permalink($post->ID);
if (civi_wp()->basepage->is_match($post->ID)) {
$basepage = TRUE;
}
}
}
else {
// Get the Base Page URL for building front-end URLs.
if ($frontend && !$forceBackend) {
$frontend_url = $this->getBasePageUrl();
$basepage = TRUE;
}
}
// Get either the relative Base Page URL or the relative Admin Page URL.
$base = $this->getBaseUrl($absolute, $frontend, $forceBackend);
// Overwrite base URL if we already have a front-end URL.
if (!$forceBackend && $frontend_url != '') {
$base = $frontend_url;
}
$queryParts = [];
$admin_request = ((is_admin() && !$frontend) || $forceBackend);
/**
* Filter the Base URL.
*
* @since 5.67
*
* @param str $base The Base URL.
* @param bool $admin_request True if building an admin URL, false otherwise.
*/
$base = apply_filters('civicrm/core/url/base', $base, $admin_request);
if (
// If not using Clean URLs.
!$config->cleanURL
// Or requesting an admin URL.
|| $admin_request
// Or this is a Shortcode.
|| (!$basepage && $frontend_url != '')
) {
// Build URL according to pre-existing logic.
if (!empty($path)) {
// Admin URLs still need "page=CiviCRM", front-end URLs do not.
if ($admin_request) {
$queryParts[] = 'page=CiviCRM';
}
else {
$queryParts[] = 'civiwp=CiviCRM';
}
$queryParts[] = 'q=' . rawurlencode($path);
}
if (!empty($query)) {
$queryParts[] = $query;
}
// Append our query parts, taking Permlink Structure into account.
if (get_option('permalink_structure') == '' && !$admin_request) {
$final = $base . $separator . implode($separator, $queryParts) . $fragment;
}
else {
$final = $base . '?' . implode($separator, $queryParts) . $fragment;
}
}
else {
// Build Clean URL.
if (!empty($path)) {
$base = trailingslashit($base) . str_replace('civicrm/', '', $path) . '/';
}
if (!empty($query)) {
$query = ltrim($query, '=?&');
$queryParts[] = $query;
}
if (!empty($queryParts)) {
$final = $base . '?' . implode($separator, $queryParts) . $fragment;
}
else {
$final = $base . $fragment;
}
}
return $final;
}
/**
* Get either the relative Base Page URL or the relative Admin Page URL.
*
* @param bool $absolute
* Whether to force the output to be an absolute link beginning with http(s).
* @param bool $frontend
* True if this link should be to the CMS front end.
* @param bool $forceBackend
* True if this link should be to the CMS back end.
*
* @return mixed|null|string
*/
public function getBaseUrl($absolute, $frontend, $forceBackend) {
$config = CRM_Core_Config::singleton();
if ((is_admin() && !$frontend) || $forceBackend) {
return Civi::paths()->getUrl('[wp.backend]/.', $absolute ? 'absolute' : 'relative');
}
else {
return Civi::paths()->getUrl('[wp.frontend]/.', $absolute ? 'absolute' : 'relative');
}
}
/**
* Get the URL of the WordPress Base Page.
*
* @return string|bool
* The Base Page URL, or false on failure.
*/
public function getBasePageUrl() {
return civi_wp()->basepage->url_get();
}
/**
* @inheritDoc
*/
public function getNotifyUrl(
$path = NULL,
$query = NULL,
$absolute = FALSE,
$fragment = NULL,
$frontend = FALSE,
$forceBackend = FALSE
) {
$config = CRM_Core_Config::singleton();
$separator = '&';
$fragment = isset($fragment) ? ('#' . $fragment) : '';
$path = CRM_Utils_String::stripPathChars($path);
$queryParts = [];
// Get the Base Page URL.
$base = $this->getBasePageUrl();
// If not using Clean URLs.
if (!$config->cleanURL) {
// Build URL according to pre-existing logic.
if (!empty($path)) {
$queryParts[] = 'civiwp=CiviCRM';
$queryParts[] = 'q=' . rawurlencode($path);
}
if (!empty($query)) {
$queryParts[] = $query;
}
// Append our query parts, taking Permlink Structure into account.
if (get_option('permalink_structure') == '') {
$final = $base . $separator . implode($separator, $queryParts) . $fragment;
}
else {
$final = $base . '?' . implode($separator, $queryParts) . $fragment;
}
}
else {
// Build Clean URL.
if (!empty($path)) {
$base = trailingslashit($base) . str_replace('civicrm/', '', $path) . '/';
}
if (!empty($query)) {
$query = ltrim($query, '=?&');
$queryParts[] = $query;
}
if (!empty($queryParts)) {
$final = $base . '?' . implode($separator, $queryParts) . $fragment;
}
else {
$final = $base . $fragment;
}
}
return $final;
}
/**
* @inheritDoc
*/
public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
/* Before we do any loading, let's start the session and write to it.
* We typically call authenticate only when we need to bootstrap the CMS
* directly via Civi and hence bypass the normal CMS auth and bootstrap
* process typically done in CLI and cron scripts. See: CRM-12648
*/
$session = CRM_Core_Session::singleton();
$session->set('civicrmInitSession', TRUE);
$config = CRM_Core_Config::singleton();
if ($loadCMSBootstrap) {
$config->userSystem->loadBootStrap([
'name' => $name,
'pass' => $password,
]);
}
$user = wp_authenticate($name, $password);
if (is_a($user, 'WP_Error')) {
return FALSE;
}
// TODO: need to change this to make sure we matched only one row
CRM_Core_BAO_UFMatch::synchronizeUFMatch($user->data, $user->data->ID, $user->data->user_email, 'WordPress');
$contactID = CRM_Core_BAO_UFMatch::getContactId($user->data->ID);
if (!$contactID) {
return FALSE;
}
return [$contactID, $user->data->ID, mt_rand()];
}
/**
* FIXME: Do something
*
* @param string $message
*/
public function setMessage($message) {
}
/**
* @param \string $user
*
* @return bool
*/
public function loadUser($user) {
$userdata = get_user_by('login', $user);
if (empty($userdata->ID)) {
return FALSE;
}
$uid = $userdata->ID;
wp_set_current_user($uid);
$contactID = CRM_Core_BAO_UFMatch::getContactId($uid);
// Lets store contact id and user id in session.
$session = CRM_Core_Session::singleton();
$session->set('ufID', $uid);
$session->set('userID', $contactID);
return TRUE;
}
/**
* FIXME: Use CMS-native approach
* @throws \CRM_Core_Exception
*/
public function permissionDenied() {
status_header(403);
global $civicrm_wp_title;
$civicrm_wp_title = ts('You do not have permission to access this page.');
throw new CRM_Core_Exception(ts('You do not have permission to access this page.'));
}
/**
* Determine the native ID of the CMS user.
*
* @param string $username
*
* @return int|null
*/
public function getUfId($username) {
$userdata = get_user_by('login', $username);
if (empty($userdata->ID)) {
return NULL;
}
return $userdata->ID;
}
/**
* @inheritDoc
*/
public function logout() {
// destroy session
if (session_id()) {
session_destroy();
}
wp_logout();
wp_redirect(wp_login_url());
}
/**
* @inheritDoc
*/
public function getUFLocale() {
/*
* Bail early if method is called when WordPress isn't bootstrapped.
* Additionally, the function checked here is located in pluggable.php
* and is required by wp_get_referer() - so this also bails early if it is
* called too early in the request lifecycle.
*
* @see https://core.trac.wordpress.org/ticket/25294
*/
if (!function_exists('wp_validate_redirect')) {
return NULL;
}
// Default to WordPress User locale.
$locale = get_user_locale();
// Is this a "back-end" AJAX call?
$is_backend = FALSE;
if (wp_doing_ajax() && FALSE !== strpos(wp_get_referer(), admin_url())) {
$is_backend = TRUE;
}
// Ignore when in WordPress admin or it's a "back-end" AJAX call.
if (!(is_admin() || $is_backend)) {
// Reaching here means it is very likely to be a front-end context.
// Default to WordPress locale.
$locale = get_locale();
/**
* Filter the default WordPress locale.
*
* The CiviCRM-WordPress plugin supports Polylang and WPML via this filter.
*
* @since 5.67
*
* @param str $locale The WordPress locale.
*/
$locale = apply_filters('civicrm/core/locale', $locale);
}
if (!empty($locale)) {
// If for some reason only we get a language code, convert it to a locale.
if (2 === strlen($locale)) {
$locale = CRM_Core_I18n_PseudoConstant::longForShort($locale);
}
return $locale;
}
else {
return NULL;
}
}
/**
* @inheritDoc
*/
public function setUFLocale($civicrm_language) {
// TODO (probably not possible with WPML?)
return TRUE;
}
/**
* @internal
* @return bool
*/
public function isLoaded(): bool {
return function_exists('__');
}
/**
* Tries to bootstrap WordPress.
*
* @param array $params
* Optional credentials
* - name: string, cms username
* - pass: string, cms password
* @param bool $loadUser
* @param bool $throwError
* @param mixed $realPath
*
* @return bool
* @throws \CRM_Core_Exception
*/
public function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
global $wp, $wp_rewrite, $wp_the_query, $wp_query, $wpdb, $current_site, $current_blog, $current_user;
$name = $params['name'] ?? NULL;
$pass = $params['pass'] ?? NULL;
if (!defined('WP_USE_THEMES')) {
define('WP_USE_THEMES', FALSE);
}
// Load bootstrap file.
$cmsRootPath = $this->cmsRootPath();
if (!$cmsRootPath) {
throw new CRM_Core_Exception("Could not find the install directory for WordPress");
}
$path = Civi::settings()->get('wpLoadPhp');
if (!empty($path)) {
require_once $path;
}
elseif (file_exists($cmsRootPath . DIRECTORY_SEPARATOR . 'wp-load.php')) {
require_once $cmsRootPath . DIRECTORY_SEPARATOR . 'wp-load.php';
}
else {
throw new CRM_Core_Exception("Could not find the bootstrap file for WordPress");
}
// Match CiviCRM timezone to WordPress site timezone.
$wpSiteTimezone = $this->getTimeZoneString();
if ($wpSiteTimezone) {
$this->setTimeZone($wpSiteTimezone);
}
// Make sure pluggable WordPress functions are available.
if (!function_exists('wp_set_current_user')) {
require_once $cmsRootPath . DIRECTORY_SEPARATOR . 'wp-includes/pluggable.php';
}
// Maybe login user.
$uid = $params['uid'] ?? NULL;
if (!$uid) {
$name = $name ?: trim($_REQUEST['name'] ?? '');
$pass = $pass ?: trim($_REQUEST['pass'] ?? '');
if ($name) {
$uid = wp_authenticate($name, $pass);
if (!$uid) {
if ($throwError) {
echo '<br />Sorry, unrecognized username or password.';
exit();
}
return FALSE;
}
}
}
if ($uid) {
if ($uid instanceof WP_User) {
$account = wp_set_current_user($uid->ID);
}
else {
$account = wp_set_current_user($uid);
}
if ($account && $account->data->ID) {
global $user;
$user = $account;
return TRUE;
}
}
return TRUE;
}
/**
* @param string $dir
*
* @return bool
*/
public function validInstallDir($dir) {
$includePath = "$dir/wp-includes";
if (@file_exists("$includePath/version.php")) {
return TRUE;
}
return FALSE;
}
/**
* Determine the location of the CMS root.
*
* @return string|NULL
* local file system path to CMS root, or NULL if it cannot be determined
*/
public function cmsRootPath() {
// Return early if the path is already set.
global $civicrm_paths;
if (!empty($civicrm_paths['cms.root']['path'])) {
return $civicrm_paths['cms.root']['path'];
}
// Return early if constant has been defined.
if (defined('CIVICRM_CMSDIR')) {
if ($this->validInstallDir(CIVICRM_CMSDIR)) {
return CIVICRM_CMSDIR;
}
}
// Return early if path to wp-load.php can be retrieved from settings.
$setting = Civi::settings()->get('wpLoadPhp');
if (!empty($setting)) {
$path = str_replace('wp-load.php', '', $setting);
$cmsRoot = rtrim($path, '/\\');
if ($this->validInstallDir($cmsRoot)) {
return $cmsRoot;
}
}
/*
* Keep previous logic as fallback of last resort.
*
* At some point, it would be good to remove this because there are serious
* problems in correctly locating WordPress in this manner. In summary, it
* is impossible to do so reliably.
*
* @see https://github.com/civicrm/civicrm-wordpress/pull/63#issuecomment-61792328
* @see https://github.com/civicrm/civicrm-core/pull/11086#issuecomment-335454992
*/
$cmsRoot = $valid = NULL;
$pathVars = explode('/', str_replace('\\', '/', $_SERVER['SCRIPT_FILENAME']));
// Might be Windows installation.
$firstVar = array_shift($pathVars);
if ($firstVar) {
$cmsRoot = $firstVar;
}
// Start with CMS dir search.
foreach ($pathVars as $var) {
$cmsRoot .= "/$var";
if ($this->validInstallDir($cmsRoot)) {
// Stop as we found bootstrap.
$valid = TRUE;
break;
}
}
return ($valid) ? $cmsRoot : NULL;
}
/**
* @inheritDoc
*/
public function createUser(&$params, $mailParam) {
$user_data = [
'ID' => '',
'user_login' => $params['cms_name'],
'user_email' => $params[$mailParam],
'nickname' => $params['cms_name'],
'role' => get_option('default_role'),
];
/*
* The notify parameter was ignored on WordPress and default behaviour
* was to always notify. Preserve that behaviour but allow the "notify"
* parameter to be used.
*/
if (!isset($params['notify'])) {
$params['notify'] = TRUE;
}
// If there's a password add it, otherwise generate one.
if (!empty($params['cms_pass'])) {
$user_data['user_pass'] = $params['cms_pass'];
}
else {
$user_data['user_pass'] = wp_generate_password(12, FALSE);
}
// Assign WordPress User "name" field(s).
if (isset($params['contactID'])) {
$contactType = CRM_Contact_BAO_Contact::getContactType($params['contactID']);
if ($contactType == 'Individual') {
$user_data['first_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
$params['contactID'], 'first_name'
);
$user_data['last_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
$params['contactID'], 'last_name'
);
}
if ($contactType == 'Organization') {
$user_data['first_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
$params['contactID'], 'organization_name'
);
}
if ($contactType == 'Household') {
$user_data['first_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
$params['contactID'], 'household_name'
);
}
}
/**
* Fires when CiviCRM is about to create a WordPress User.
*
* @since 5.37
* @since 5.71 Added $params, $mailParam and $user_data.
*
* @param array $params The array of source Contact data.
* @param string $mailParam The name of the param which contains the email address.
* @param array $user_data The array of data to create the WordPress User with.
*/
do_action('civicrm_pre_create_user', $params, $mailParam, $user_data);
// Remove the CiviCRM-WordPress listeners.
$this->hooks_core_remove();
// User is not logged in by default.
$logged_in = FALSE;
// Now go ahead and create a WordPress User.
$uid = wp_insert_user($user_data);
if (is_wp_error($uid)) {
Civi::log()->error("Could not create the user. WordPress returned: " . $uid->get_error_message());
}
else {
/*
* Call wp_signon if we aren't already logged in.
* For example, we might be creating a new user from the Contact record.
*/
if (!current_user_can('create_users')) {
$creds = [];
$creds['user_login'] = $params['cms_name'];
$creds['user_password'] = $user_data['user_pass'];
$creds['remember'] = TRUE;
// Authenticate and log the user in.
$user = wp_signon($creds, FALSE);
if (is_wp_error($user)) {
Civi::log()->error("Could not log the user in. WordPress returned: " . $user->get_error_message());
}
else {
$logged_in = TRUE;
}
}
if ($params['notify']) {
// Fire the new user action. Sends notification email by default.
do_action('register_new_user', $uid);
}
}
// Restore the CiviCRM-WordPress listeners.
$this->hooks_core_add();
/**
* Fires after CiviCRM has tried to create a WordPress User.
*
* @since 5.37
* @since 5.71 Added $uid and $params.
*
* @param int|WP_Error $uid The ID of the new WordPress User, or WP_Error on failure.
* @param array $params The array of source Contact data.
* @param bool $logged_in TRUE when the User has been auto-logged-in, FALSE otherwise.
*/
do_action('civicrm_post_create_user', $uid, $params, $logged_in);
return $uid;
}
/**
* @inheritDoc
*/
public function updateCMSName($ufID, $ufName) {
// CRM-10620
if (function_exists('wp_update_user')) {
$ufID = CRM_Utils_Type::escape($ufID, 'Integer');
$ufName = CRM_Utils_Type::escape($ufName, 'String');
$values = ['ID' => $ufID, 'user_email' => $ufName];
if ($ufID) {
wp_update_user($values);
}
}
}
/**
* @inheritdoc
*/
public function getEmailFieldName(CRM_Core_Form $form, array $fields):string {
$emailName = '';
$billingLocationTypeID = CRM_Core_BAO_LocationType::getBilling();
if (array_key_exists("email-{$billingLocationTypeID}", $fields)) {
// this is a transaction related page
$emailName = 'email-' . $billingLocationTypeID;
}
else {
// find the email field in a profile page
foreach ($fields as $name => $dontCare) {
if (str_starts_with($name, 'email')) {