forked from civicrm/civicrm-drupal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcivicrm.module
1605 lines (1447 loc) · 51.7 KB
/
civicrm.module
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
/**
* Project: CiviCRM: Constituent Relationship Management for NP's
* File: civicrm.module
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
/**
* Drupal module file.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2013
*/
require_once 'civicrm_user.inc';
define('CIVICRM_UF_HEAD', TRUE);
/**
* Utilities
*/
/**
* Provides a link to the CSS stylesheet associated with this module.
* and the javascript files needed by this module
*
* @return a <style> tag that indicates what file browsers should import
*/
function civicrm_html_head($force_load = FALSE) {
static $added;
global $base_url, $base_path;
if (!civicrm_initialize()) {
return;
}
if ($added && !$force_load) {
return;
}
$config = CRM_Core_Config::singleton();
$head = '';
$crm_path = preg_replace('/drupal$/', '', drupal_get_path('module', 'civicrm'));
drupal_add_js(array('civicrm' => array('resourceBase' => $base_url.$base_path.$crm_path)), 'setting');
drupal_add_js( $base_url.$base_path.$crm_path . 'js/insights.js?v'.$config->ver, array('scope' => 'footer', 'every_page' => TRUE, 'weight' => 999, 'defer' => TRUE, 'preprocess' => FALSE, 'type' => 'file'));
if ( arg(0) == 'civicrm' || arg(0) == 'user' || $force_load) {
$template = CRM_Core_Smarty::singleton( );
$buffer = $template->fetch( 'CRM/common/jquery.files.tpl' );
$lines = preg_split( '/\s+/', $buffer );
$options = array('type' => 'file', 'scope' => 'header', 'weight' => 900, 'group' => 999);
foreach ( $lines as $line ) {
$line = trim( $line );
if ( empty( $line ) ) {
continue;
}
if ( strpos( $line, '.js' ) !== false ) {
$options['weight']++;
drupal_add_js( $crm_path . $line, $options);
}
else if ( strpos( $line, '.css' ) !== false ) {
drupal_add_css( $crm_path . $line );
}
}
// add Common.js
$options['weight'] = 999;
drupal_add_js( $crm_path . 'js/Common.js', $options);
// add noconflict.js
// set weight to 999.9 to ensure that the file is at the end
$options['weight'] = 999.9;
drupal_add_js($crm_path . 'js/noconflict.js', $options);
}
$options['weight'] = 990;
$options['group'] = CSS_DEFAULT;
drupal_add_css($crm_path . 'css/civicrm.css', $options);
$options['weight'] = 991;
drupal_add_css($crm_path . 'css/extras.css', $options);
$customCSS = variable_get('civicrm_custom_css_url', '');
if (!empty($config->customCSSURL)) {
$options['type'] = 'external';
$options['weight'] = 1000;
$options['group'] = CSS_THEME;
drupal_add_css($config->customCSSURL, $options);
if ($customCSS != $config->customCSSURL) {
variable_set('civicrm_custom_css_url', $config->customCSSURL);
}
}
elseif(!empty($customCSS)) {
variable_set('civicrm_custom_css_url', '');
}
$added = TRUE;
return $head;
}
/**
* implements hook_init
*/
function civicrm_init() {
$customCSS = variable_get('civicrm_custom_css_url', '');
if ($customCSS) {
$options = array(
'type' => 'external',
'scope' => 'header',
'weight' => 1000,
'group' => CSS_THEME,
);
drupal_add_css($customCSS, $options);
}
}
/**
* Implements hook_help().
*/
function civicrm_help($section) {
switch ($section) {
case 'admin/help#civicrm':
return;
// FIXME - should not invoke any civicrm stuff here
// way too expensive
$docLinkAdmin = CRM_Utils_System::docURL2("Administrator's Guide", TRUE);
$docLinkAccess = CRM_Utils_System::docURL2("Access Control", TRUE);
$output = '<p>' . t('The CiviCRM module stores information on the universe of people associated with a community and on their interactions such as emails, donations, petitions, events, etc. It can act as a stand alone contact management system or it can be integrated with mass mailer, volunteer management, petition, and event finding. CiviCRM enables organizations to maintain all these activities in a single database, creating efficiencies and new opportunities for communities to better communicate and benefit from relationships with their community members.') . '</p>';
$output .= '<p>' . t('The CiviCRM module allows you to create contacts, or import them from other sources. You can record relationships between contacts, such as indicating they live in the same household. There are two types of groups of contacts. You can create static groups which have a set list of contacts. You can also create dynamic (smart) groups based on characteristics that contacts have in common. For example, you could create a group of all contacts who live in California AND who have volunteered for your organization within the past year. The CiviCRM module also allows for tagging for less formal categorization of contacts or groups. You can easily extend CiviCRM to record community member information which is specific to your community or organization using custom fields. For example, you can create a set of fields to track volunteer skills and preferences. CiviCRM profile gives you a way to allow community members (\'users\') to update their own information, as well as share some of that information with others. Finally, you can configure custom activity types such as volunteering or attending events.') . '</p>';
$output .= '<p>' . t('You can:') . '</p>';
$output .= '<ul>';
$output .= '<li>' . t('read the <a href="!1">CiviCRM Administrator Guide</a>.', array(
'!1' => $docLinkAdmin)) . '</li>';
$output .= '<li>' . t('enable CiviCRM blocks at <a href="!1">Administer » Site Building » Blocks</a>.', array(
'!1' => url('admin/build/block'))) . '</li>';
$output .= '<li>' . t('read about <a href="!1">CiviCRM access permissions</a> and set access permissions at <a href="!2">Administer CiviCRM » Users and Permissions » Permissions (Access Control)</a>.', array(
'!1' => $docLinkAccess, '!2' => url('civicrm/admin/access', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('find contacts by name, email address, group membership and or tagging at <a href="!1">Find Contacts</a>.', array(
'!1' => url('civicrm/contact/search/basic', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('do complex searches based on tags, group membership, location, activities and custom fields at <a href="!1">Advanced Search</a>.', array(
'!1' => url('civicrm/contact/search/advanced', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('create or manage groups at <a href="!1">Manage Groups</a>.', array(
'!1' => url('civicrm/group', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('import contacts from other sources at <a href="!1">Import Contacts</a>.', array(
'!1' => url('civicrm/import', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('create or administer tags (e.g. organizer, foundation, environment...) at <a href="!1">CiviCRM » Administer » Customize Data and Screens » Tags</a>.', array(
'!1' => url('civicrm/admin/tag', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('create or administer relationship types (e.g. household member, board member, spouse...) <a href="!1">CiviCRM » Administer » Customize Data and Screens » Relationship Types</a>.', array(
'!1' => url('civicrm/admin/reltype', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('create or administer location types (e.g. home, work, school...) <a href="!1">CiviCRM » Administer » Customize Data and Screens » Dropdown Options » Location Types</a>.', array(
'!1' => url('civicrm/admin/locationType', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('create or administer activity types (e.g. house meeting, intake interview...) at <a href="!1">CiviCRM » Administer » Customize Data and Screens » Activity Types</a>.', array(
'!1' => url('civicrm/admin/options/activity_type', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('create or administer custom data fields (e.g. volunteer skills, emergency contact info...) <a href="!1">CiviCRM » Administer » Customize Data and Screens » Custom Fields</a>.', array(
'!1' => url('civicrm/admin/custom/group', array('query' => 'reset=1')))) . '</li>';
$output .= '<li>' . t('create or administer CiviCRM profiles (i.e. what contact data is collected during user registration and included in My Account) at <a href="!1">CiviCRM » Administer » Customize Data and Screens » Profiles</a>.', array(
'!1' => url('civicrm/admin/uf/group', array('query' => 'reset=1')))) . '</li>';
$output .= '</ul>';
$output .= '<p>' . t('For more information please refer to the <a href="!1">CiviCRM web-site</a> which includes project information, documentation and support resources and more.', array(
'!1' => 'http://civicrm.org')) . '</p>';
return $output;
case 'admin/modules#description':
// This description is shown in the listing at admin/modules.
return t('Constituent Relationship Management (CiviCRM !1). Allows sites to manage contacts, relationships and groups, and track contact activities, contributions, memberships and events. For more information please refer to the <a href="!2">CiviCRM web-site</a> which includes project information, documentation and support resources and more.', array('!1' => '2.2', '!2' => 'http://civicrm.org/'));
}
}
/**
* Implements hook_permissions().
*/
function civicrm_permission() {
// make sure the system is initialized
if (!civicrm_initialize()) {
return;
}
$config = CRM_Core_Config::singleton();
$permissions = CRM_Core_Permission::basicPermissions();
$perms_array = array();
$restrict = array(
'profile edit',
'profile listings',
'profile listings and forms',
'profile view',
'translate CiviCRM',
'access CiviCRM',
'administer CiviCRM',
'administer Reserved Option',
);
foreach ($permissions as $perm => $title) {
//order matters here, but we deal with that later
if(preg_match('/(administer|view all|delete|edit all)/', $perm) || in_array($perm, $restrict)){
$restrict_access = TRUE;
}
else{
$restrict_access = FALSE;
}
$perms_array[$perm] = array(
'title' => $title,
'restrict access' => $restrict_access,
);
}
return $perms_array;
}
/**
* Implements hook_block_info
*/
function civicrm_block_info() {
if (!civicrm_initialize()) {
return;
}
$block = CRM_Core_Block::getInfo();
return $block;
}
/**
* Implements hook_block_view
*/
function civicrm_block_view($delta = '0') {
if (!civicrm_initialize()) {
return;
}
$block = CRM_Core_Block::getContent($delta);
return $block;
}
/**
* Implements hook_menu().
*/
function civicrm_menu() {
if (!civicrm_initialize()) {
return;
}
return array(
'civicrm' => array(
'title' => 'CiviCRM',
'access callback' => '_civicrm_checkmenu',
'access arguments' => array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9),
'page callback' => 'civicrm_invoke',
'type' => MENU_CALLBACK,
'weight' => 0,
),
'tappay/ipn' => array(
'title' => 'CiviCRM',
'access callback' => '_civicrm_checkmenu',
'access arguments' => array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9),
'page callback' => 'civicrm_invoke',
'type' => MENU_CALLBACK,
'weight' => 0,
),
'spgateway/ipn' => array(
'title' => 'CiviCRM',
'access callback' => '_civicrm_checkmenu',
'access arguments' => array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9),
'page callback' => 'civicrm_invoke',
'type' => MENU_CALLBACK,
'weight' => 0,
),
'spgateway/neweb-transfer' => array(
'title' => 'CiviCRM',
'access callback' => '_civicrm_checkmenu',
'access arguments' => array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9),
'page callback' => 'civicrm_invoke',
'type' => MENU_CALLBACK,
'weight' => 0,
),
'allpay/ipn' => array(
'title' => 'Allpay',
'access callback' => '_civicrm_checkmenu',
'access arguments' => array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9),
'page callback' => 'civicrm_invoke',
'type' => MENU_CALLBACK,
'weight' => 0,
),
'allpay/record' => array(
'title' => 'Allpay',
'access callback' => '_civicrm_checkmenu',
'access arguments' => array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9),
'page callback' => 'civicrm_invoke',
'type' => MENU_CALLBACK,
'weight' => 0,
),
// administration section for civicrm integration modules.
'admin/config/civicrm' => array(
'title' => 'CiviCRM',
'description' => 'Configure CiviCRM integration modules.',
'position' => 'left',
'weight' => -10,
'page callback' => 'system_admin_menu_block_page',
'access arguments' => array('access administration pages'),
'file' => 'system.admin.inc',
'file path' => drupal_get_path('module', 'system'),
),
);
}
/**
* Syncronize civicrm menu and druipal menu permission
*/
function _civicrm_checkmenu( ){
global $user;
$args = func_get_args();
$path = trim(implode('/', $args), '/');
static $checked;
if(isset($checked[$path])){
return $checked[$path];
}
civicrm_initialize();
$item = CRM_Core_Menu::get( $path );
if($item){
if(!empty($item['is_public'])){
return true;
}
if(strstr($item['path'], 'civicrm/ajax')){
if(CRM_Core_Permission::checkMenuItem( $item )){
$checked[$path] = true;
return true;
}
}
elseif($item['access_callback'] && is_numeric($item['access_callback']) && !$user->uid){
if($access = $item['access_arguments'][0][0]){
if(user_access($access)){
return true;
}
}
}
elseif ( CRM_Core_Permission::checkMenuItem( $item ) ) {
$checked[$path] = true;
return true;
}
}
return false;
}
/**
* hook cron
* Period doing some purgnation
*/
function civicrm_cron() {
if (!empty(variable_get('maintenance_mode', ''))) {
return;
}
civicrm_initialize();
$last = variable_get('civicrm_cron', array());
$time = REQUEST_TIME;
$hour = date('G', $time);
// minutely
if ($time - $last['minutely'] >= 55) {
// It works when set up to execute cron by minutely.
$last['minutely'] = $time;
CRM_Batch_BAO_Batch::runQueue();
}
// hourly
// Avoiding totally fit the time, so reducing 50 seconds.
if ($time - $last['hourly'] >= 3550) {
# refs #41959, change batch expiration to drupal cron
if ($hour == 1) {
CRM_Batch_BAO_Batch::expireBatch();
}
# smart marketing sync
if ($hour == 6) {
CRM_Mailing_External_SmartMarketing::syncAll();
}
# tappay sync
$disableTappay = variable_get('disable_civicrm_tappay_execute_recur', false);
if ($hour > 7 && !$disableTappay) {
CRM_Core_Payment_TapPay::doExecuteAllRecur($time);
}
# cancel stuck batch
CRM_Batch_BAO_Batch::cancelStuckBatch();
$last['hourly'] = $time;
}
// daily
if ($hour >= 6 && $hour <= 8) {
if ($time - $last['daily'] >= 86350) {
CRM_Core_Payment_TapPay::doSyncLastDaysRecords();
CRM_Core_Payment_TapPay::doStatusCheck();
CRM_Contribute_BAO_TaiwanACH::doStatusCheck();
CRM_Contribute_BAO_Contribution_Utils::clearDonateAgainLink();
if ($hour >= 7) {
CRM_Contact_BAO_GroupContactCache::checkAll();
}
$last['daily'] = $time;
}
}
// weekly , monthly
if ($hour >= 1 && $hour < 4) {
// sunday
if ($time - $last['weekly'] >= (86300*7)) {
CRM_Core_Config::singleton()->clearTempTables();
CRM_Core_BAO_File::clearUploadDir(28);
CRM_Utils_Mail::validDKIMDomainList(TRUE, CRM_Utils_Mail::DKIM_EXTERNAL_VERIFIED_FILE);
$last['weekly'] = $time;
}
// start of month
if ($time - $last['monthly'] >= (86400*30 - 50) && date('j') == '1') {
CRM_Core_Error::purge();
$last['monthly'] = $time;
}
}
variable_set('civicrm_cron', $last);
}
/**
* Implementation of hook_page_build
*/
function civicrm_page_build($page) {
// CRM-11823 - If Civi bootstrapped, then merge its HTML header with the CMS's header
/*
global $civicrm_root;
if (empty($civicrm_root)) {
return;
}
if ($region = CRM_Core_Region::instance('html-header', FALSE)) {
CRM_Utils_System::addHTMLHead($region->render(''));
}
*/
}
/**
* Initialize CiviCRM. Call this function from other modules too if
* they use the CiviCRM API.
*/
function civicrm_initialize() {
// Check for php version and ensure its greater than minPhpVersion
$minPhpVersion = '5.3.3';
if (version_compare(PHP_VERSION, $minPhpVersion) < 0) {
echo "CiviCRM requires PHP Version $minPhpVersion or greater. You are running PHP Version " . PHP_VERSION . "<p>";
exit();
}
_civicrm_registerClassLoader();
static $initialized = FALSE;
static $failure = FALSE;
if ($failure) {
return FALSE;
}
if (!$initialized) {
// lets ensure we minimize errors
error_reporting(error_reporting() & ~E_DEPRECATED & ~E_STRICT);
if (function_exists('conf_path')) {
$settingsFile = DRUPAL_ROOT.'/'.conf_path() . '/civicrm.settings.php';
}
else {
$settingsFile = DRUPAL_ROOT.'/'.conf_init() . '/civicrm.settings.php';
}
if (!defined('CIVICRM_SETTINGS_PATH')) {
define('CIVICRM_SETTINGS_PATH', $settingsFile);
}
$error = include_once ($settingsFile);
// get ready for problems
$docLinkInstall = "http://wiki.civicrm.org/confluence/display/CRMDOC/Drupal+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";
$errorMsgAdd = t("Please review the <a href='!1'>Drupal Installation Guide</a> and the <a href='!2'>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='!3'>installation support section of the community forum</a>.</strong></p>",
array('!1' => $docLinkInstall, '!2' => $docLinkTrouble, '!3' => $forumLink)
);
if ($error == FALSE) {
$failure = TRUE;
drupal_set_message("<strong><p class='error'>" .
t("Oops! - The CiviCRM settings file (civicrm.settings.php) was not found in the expected location ") .
"(" . $settingsFile . "). </p><p class='error'>" .
$errorMsgAdd . '</p></strong>'
);
return FALSE;
}
// this does pretty much all of the civicrm initialization
$error = include_once ('CRM/Core/Config.php');
if ($error == FALSE) {
$failure = TRUE;
drupal_set_message("<strong><p class='error'>" .
t("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 (!1).",
array('!1' => $settingsFile)
) .
"</p><p class='error'> » " .
t("civicrm_root is currently set to: <em>!1</em>.", array(
'!1' => $civicrm_root)) .
"</p><p class='error'>" . $errorMsgAdd . "</p></strong>"
);
return FALSE;
}
$initialized = TRUE;
// initialize the system by creating a config object
$config = CRM_Core_Config::singleton();
// Add module-specific header elements
$header = civicrm_html_head();
if (!empty($header)) {
drupal_add_html_head($header);
}
$args = explode('/', $_GET['q']);
if (
(!isset($args[1]) || $args[1] != 'upgrade')
// &&
// drupal wysiwyg
//CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'editor_id') == 4
) {
// CRM-12164
if (function_exists('wysiwyg_get_profile')) {
//we have to ensure that wysiwyg is loaded since
//pages load only with ajax callbacks
$formats = filter_formats();
foreach ($formats as $id => $format) {
wysiwyg_get_profile($id);
}
$path = drupal_get_path('module', 'filter');
drupal_add_js($path . '/filter.js');
drupal_add_css($path . '/filter.css');
}
}
// CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
}
return TRUE;
}
/**
* Find & register classloader and store location in Drupal variable.
* Per CRM-13737 this allows for drupal code to be outside the core directory
* which makes it easier for sites managing their own installation methods that
* may need to cover different drupal versions
*/
function _civicrm_registerClassLoader() {
$path = variable_get('civicrm_class_loader', '');
if (empty($path) || !file_exists($path)) {
$candidates = array(
dirname(__FILE__) . '/../CRM/Core/ClassLoader.php',
dirname(__FILE__) . '/../civicrm-core/CRM/Core/ClassLoader.php',
dirname(__FILE__) . '/../core/CRM/Core/ClassLoader.php',
// ... ad nauseum ...
);
foreach ($candidates as $candidate) {
if (file_exists($candidate)) {
$path = $candidate;
variable_set('civicrm_class_loader', $candidate);
break;
}
}
}
require_once $path;
CRM_Core_ClassLoader::singleton()->register();
}
/**
* Function to get the contact type
*
* @param string $default contact type
*
* @return $ctype contact type
*/
function civicrm_get_ctype($default = NULL) {
// here we are creating a new contact
// get the contact type from the POST variables if any
if (isset($_REQUEST['ctype'])) {
$ctype = $_REQUEST['ctype'];
}
elseif (isset($_REQUEST['edit']) &&
isset($_REQUEST['edit']['ctype'])
) {
$ctype = $_REQUEST['edit']['ctype'];
}
else {
$ctype = $default;
}
if ($ctype != 'Individual' &&
$ctype != 'Organization' &&
$ctype != 'Household'
) {
$ctype = $default;
}
return $ctype;
}
/**
* This is the main function that is called on any civicrm page
*/
function civicrm_invoke() {
// check if this is a redirect and maybe a user login?
// this changed between D6 and D7, seems hackish but not sure
// what we can / should do
// CRM-9853
if (isset($_POST['form_build_id']) &&
isset($_POST['form_id']) &&
($_POST['form_id'] == 'user_login_block' || $_POST['form_id'] == 'user_login') &&
isset($_GET['destination'])
) {
// process the user login form and let it do the redirect?
return drupal_get_form('user_login');
}
// make sure the system is initialized
if (!civicrm_initialize()) {
return drupal_not_found();
}
civicrm_cache_disable();
$args = explode('/', $_GET['q']);
// synchronize the drupal uid with the contacts db
global $user;
/* FIXME: hack to bypass synchronize if running upgrade to avoid
any serious non-recoverable error which might hinder the
upgrade process. */
if (!isset($args[1]) ||
$args[1] != 'upgrade'
) {
CRM_Core_BAO_UFMatch::synchronize($user, FALSE, 'Drupal',
civicrm_get_ctype('Individual')
);
}
// fix the path for the url alias module
$urlAlias = FALSE;
foreach ($args as $index => $arg) {
if (strpos($arg, '=') !== FALSE) {
$keepArg = NULL;
// first check if there is a ?
if (strpos($arg, '?') !== FALSE) {
$items = CRM_Utils_System::explode('?', $arg, 2);
$keepArg = $items[0];
$item = $items[1];
}
else {
$item = $arg;
}
// next split it on &
$elements = explode('&', $item);
foreach ($elements as $element) {
// finally split on =
list($key, $value) = CRM_Utils_System::explode('=', $element, 2);
if ($value) {
$_REQUEST[$key] = $value;
}
}
if ($keepArg) {
$args[$index] = $keepArg;
}
else {
unset($args[$index]);
}
$urlAlias = TRUE;
}
}
if ($urlAlias) {
$_GET['q'] = implode('/', $args);
}
// correct exception handling
try {
ob_start();
CRM_Core_Invoke::invoke($args);
$content = ob_get_clean();
}
catch (CRM_Core_Exception $e) {
// force content to white
$content = '';
// this will save civicrm session correctly
$message = $e->getMessage();
if (CRM_Core_Config::singleton()->userFrameworkLogging) {
watchdog('civicrm', strip_tags($message), array(), WATCHDOG_ERROR);
}
$data = $e->getErrorData();
$code = $e->getErrorCode();
switch ($code) {
case CRM_Core_Error::NO_ERROR:
// CRM already output header and content to client
drupal_exit();
break;
case CRM_Core_Error::STATUS_BOUNCE:
CRM_Core_Session::setStatus(FALSE, FALSE, 'warning'); // remove duplicate status display in CRM
CRM_Utils_System::civiBeforeShutdown();
if (!empty($data['redirect'])) {
$url = $data['redirect'];
}
drupal_set_message($message, 'warning');
if ($url) {
header('Location: ' . $url, TRUE, $code);
}
return; // make sure no code execution after redirect
break;
case CRM_Core_Error::FATAL_ERROR:
case CRM_Core_Error::DATABASE_ERROR:
CRM_Core_Session::setStatus(FALSE, FALSE, 'error'); // remove duplicate status display in CRM
CRM_Utils_System::civiBeforeShutdown();
if ($data['content']) {
$content = $data['content']; // this will fetch fatal.tpl from crm
}
else {
drupal_set_message($message, 'error');
}
return $content;
break;
default:
CRM_Utils_System::civiBeforeShutdown();
throw new Exception('Unknow Exception');
$content = '';
break;
}
}
// not one of CRM_Core_Exception
/* We may not need this here.
catch (\Exception $e) {
throw new Exception($e->getMessage());
}
*/
return $content;
}
/**
* Determine if the user is on a CiviCRM generated page, i.e. the form has some civicrm unique token
*/
function civicrm_on_user_page() {
return isset($_POST['_qf_default']);
}
function _civicrm_categories_access($profile_id) {
if (!civicrm_initialize()) {
return FALSE;
}
$allUFGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup('User Account', 0, TRUE);
if (is_array(CRM_Utils_Array::value($profile_id, $allUFGroups))) {
return TRUE;
}
}
function civicrm_register_data($edit, &$user, $category, $reset, $doNotProcess = FALSE) {
// lets suppress key generation for all registration forms
civicrm_key_disable();
$ctype = civicrm_get_ctype('Individual');
if ($user->uid) {
// Happens on $type == 'insert'
// $reset == false always
// $doNotProcess == false always
CRM_Core_BAO_UFMatch::synchronize($user, TRUE, 'Drupal', $ctype);
$userID = CRM_Core_BAO_UFMatch::getContactId($user->uid);
// CRM-7858
if (isset($edit['mail'])) {
CRM_Core_BAO_UFMatch::updateContactEmail($userID,
trim($edit['mail'])
);
}
$html = CRM_Core_BAO_UFGroup::getEditHTML($userID, '',
2,
TRUE,
$reset, NULL,
$doNotProcess, $ctype
);
}
else {
// Happens on $type == 'register'
$html = CRM_Core_BAO_UFGroup::getEditHTML(NULL, '',
1,
TRUE,
$reset, NULL,
$doNotProcess, $ctype
);
}
$output = array();
if ($html) {
$html = civicrm_add_jquery($html);
$index = empty($category) ? 'civicrm-profile-register' : $category;
$output[$index] = array(
'#title' => $category,
'#type' => 'item',
'#markup' => $html,
'#weight' => 1,
);
}
return $output;
}
function civicrm_form_data($edit, &$user, $category, $reset, $doNotProcess = FALSE) {
civicrm_initialize();
// lets suppress key generation for all CMS forms
civicrm_key_disable();
$output = array();
$userID = CRM_Core_BAO_UFMatch::getContactId($user->uid);
if (!$userID) {
$ctype = civicrm_get_ctype('Individual');
CRM_Core_BAO_UFMatch::synchronize($user, FALSE, 'Drupal', $ctype);
$userID = CRM_Core_BAO_UFMatch::getContactId($user->uid);
}
// at this point we better have a valid userID
if (!$userID) {
// we get into this scenario if we do not like the email address supplied by the user
return;
}
// Check if a user is currently logged in
if ($GLOBALS['user']) {
$loginUserID = $GLOBALS['user']->uid;
if ($loginUserID == $user->uid) {
// make sure we have userID set in session
CRM_Core_BAO_UFMatch::synchronize($user, FALSE, 'Drupal', $ctype);
}
}
// shouldn't allow edit when user doesn't have permission
if ($user->uid != $loginUserID && !user_access('edit all contacts')) {
CRM_Utils_System::permissionDenied();
return;
}
$ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID, 'contact_type');
//to allow Edit any profile if user have permission
$profileID = CRM_Core_DAO::getFieldValue("CRM_Core_DAO_UFGroup", $category, 'id', 'name');
$ufGroupIDs = CRM_Core_Permission::ufGroupClause(CRM_Core_Permission::EDIT, NULL, TRUE);
if (in_array($profileID, $ufGroupIDs)) {
// get all the data for this specific category
$html = CRM_Core_BAO_UFGroup::getEditHTML($userID, $category, NULL, FALSE, $reset, $profileID, $doNotProcess, $ctype);
$title = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'title');
}
else {
CRM_Core_Error::fatal(ts('The requested Profile (gid=%1) is disabled OR it is not configured to be used for \'Profile\' listings in its Settings OR there is no Profile with that ID OR you do not have permission to access this profile. Please contact the site administrator if you need assistance.',
array(1 => $profileID)
));
}
if ($html) {
$html = civicrm_add_jquery($html);
$index = empty($category) ? 'civicrm-profile-my-account' : $category;
$output[$index][] = array(
'#title' => $title,
'#type' => 'item',
'#markup' => $html,
'#weight' => 1,
);
}
return $output;
}
function civicrm_user_form_validate($form, &$form_state) {
// lets suppress key generation for all validation also
civicrm_key_disable();
static $validated = FALSE;
if ($validated) {
return;
}
$validated = TRUE;
// check for either user/register or admin/people/create
$register =
((arg(0) == 'user' && arg(1) == 'register') ||
(arg(0) == 'admin' && arg(1) == 'people' && arg(2) == 'create')
) ? TRUE : FALSE;
$userID = NULL;
if (!empty($form['#user'])) {
$userID = CRM_Core_BAO_UFMatch::getContactId($form['#user']->uid);
}
$errors = CRM_Core_BAO_UFGroup::isValid($userID, $form['#user_category'], $register);
if ($errors && is_array($errors)) {
foreach ($errors as $name => $error) {
form_set_error($name, $error);
}
return FALSE;
}
return TRUE;
}
/**
* Disable the drupal cache for all civicrm pages which should not be cached
*/
function civicrm_cache_disable() {
if (function_exists('drupal_page_is_cacheable')) {
//this is a Drupal 7 function only - using 'easy option' of checking function
drupal_page_is_cacheable(FALSE);
}
}
/**
* Disable civicrm key for all forms that interact with the CMS
* We do not control the CMS form generation and hence should suppress
* qfKey
*/
function civicrm_key_disable() {
if (!civicrm_initialize()) {
return FALSE;
}
$config = CRM_Core_Config::singleton();
$config->keyDisable = TRUE;
}
function civicrm_enable() {
db_query("UPDATE {system} SET weight = 100 WHERE name = 'civicrm'");
menu_rebuild();
menu_link_maintain('civicrm', 'delete', 'civicrm', 'CiviCRM');
$options = array(
'link_title' => 'CiviCRM',
'link_path' => 'civicrm/dashboard',
'module' => 'civicrm',
'options' => array('alter' => TRUE),
);
menu_link_save($options);
if (!civicrm_initialize()) {
return;
}
// also invoke civicrm menu rebuild
CRM_Core_Menu::store();
//Update the 'blocks' DB table with the blocks
_block_rehash();
// setup permissions
$anonymous_perm = array(
'make online contributions' => TRUE,
'register for events' => TRUE,
'view event info' => TRUE,
'profile create' => TRUE,
);
user_role_change_permissions(DRUPAL_ANONYMOUS_RID, $anonymous_perm);
user_role_change_permissions(DRUPAL_AUTHENTICATED_RID, $anonymous_perm);
}
/**
* An Implements hook_translated_menu_item_alter(). This is a hack
* to hide the CiviCRM menu from the drupal navigation block for folks
* who dont have access CiviCRM permissions
*/
function civicrm_translated_menu_link_alter(&$item) {
if ($item['router_path'] == 'civicrm' &&
$item['module'] == 'civicrm' &&
!user_access('access CiviCRM')
) {