Skip to content
Snippets Groups Projects
civicrm.php 43.4 KiB
Newer Older
  • Learn to ignore specific revisions
  • Kevin Cristiano's avatar
    Kevin Cristiano committed
    1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
        $setting = CRM_Core_BAO_Setting::getItem('CiviCRM Preferences', 'wpLoadPhp');
    
        // if we don't have one, create it
        if ( is_null( $setting ) ) {
          CRM_Core_BAO_Setting::setItem($path, 'CiviCRM Preferences', 'wpLoadPhp');
        }
    
        // is it different to the one we've stored?
        if ( $setting !== $path ) {
          // yes - set new path (this could be because we've changed server or location)
          CRM_Core_BAO_Setting::setItem($path, 'CiviCRM Preferences', 'wpLoadPhp');
        }
    
      }
    
    
      /**
       * Perform necessary stuff prior to CiviCRM being loaded on the front end
       * This needs to be a method because it can then be hooked into WP at the
       * right time
       *
       * @return void
       */
      public function front_end_page_load() {
    
        static $frontend_loaded = FALSE;
        if ( $frontend_loaded ) {
          return;
        }
    
        // add resources for front end
        $this->add_core_resources( TRUE );
    
        // merge CiviCRM's HTML header with the WordPress theme's header
        add_action( 'wp_head', array( $this, 'wp_head' ) );
    
        // set flag so this only happens once
        $frontend_loaded = TRUE;
    
      }
    
    
      /**
       * Load only the CiviCRM CSS. This is needed because $this->front_end_page_load()
       * is only called when there is a single Civi entity present on a page or archive
       * and, whilst we don't want all the Javascript to load, we do want stylesheets
       *
       * @return void
       */
      public function front_end_css_load() {
    
        static $frontend_css_loaded = FALSE;
        if ( $frontend_css_loaded ) {
          return;
        }
    
        if (!$this->initialize()) {
          return;
        }
    
        $config = CRM_Core_Config::singleton();
    
        // default custom CSS to standalone
        $dependent = NULL;
    
        // Load core CSS
        if (!CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'disable_core_css')) {
    
          // enqueue stylesheet
          wp_enqueue_style(
            'civicrm_css',
            $config->resourceBase . 'css/civicrm.css',
            NULL, // dependencies
            CIVICRM_PLUGIN_VERSION, // version
            'all' // media
          );
    
          // custom CSS is dependent
          $dependent = array( 'civicrm_css' );
    
        }
    
        // Load custom CSS
        if (!empty($config->customCSSURL)) {
          wp_enqueue_style(
            'civicrm_custom_css',
            $config->customCSSURL,
            $dependent, // dependencies
            CIVICRM_PLUGIN_VERSION, // version
            'all' // media
          );
        }
    
        // set flag so this only happens once
        $frontend_css_loaded = TRUE;
    
      }
    
    
      /**
       * Add CiviCRM core resources
       *
       * @param bool $front_end True if on WP front end, false otherwise
       * @return void
       */
      public function add_core_resources( $front_end = TRUE ) {
    
        if (!$this->initialize()) {
          return;
        }
    
        $config = CRM_Core_Config::singleton();
        $config->userFrameworkFrontend = $front_end;
    
        // add CiviCRM core resources
        CRM_Core_Resources::singleton()->addCoreResources();
    
      }
    
    
      /**
       * Merge CiviCRM's HTML header with the WordPress theme's header
       * Callback from WordPress 'admin_head' and 'wp_head' hooks
       *
       * @return void
       */
      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 '<!-- CiviCRM html header -->';
          echo $region->render( '' );
        }
    
      }
    
    
      // ---------------------------------------------------------------------------
      // CiviCRM Invocation (this outputs Civi's markup)
      // ---------------------------------------------------------------------------
    
    
      /**
       * Invoke CiviCRM in a WordPress context
       * Callback function from add_menu_page()
       * Callback from WordPress 'init' and 'the_content' hooks
       * Also called by shortcode_render() and _civicrm_update_user()
       *
       * @return void
       */
      public function invoke() {
    
        static $alreadyInvoked = FALSE;
        if ( $alreadyInvoked ) {
          return;
        }
    
        // bail if this is called via a content-preprocessing plugin
        if ( $this->is_page_request() && !in_the_loop() && !is_admin() ) {
          return;
        }
    
        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();
        }
    
        // CRM-95XX
        // At this point we are calling a CiviCRM function
        // WP always quotes the request, CiviCRM needs to reverse what it just did
        $this->remove_wp_magic_quotes();
    
        // Code inside invoke() requires the current user to be set up
        $current_user = wp_get_current_user();
    
        /**
         * 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' ) {
          $this->users->sync_user( $current_user );
        }
    
        // set flag
        $alreadyInvoked = TRUE;
    
        // get args
        $argdata = $this->get_request_args();
    
        // set dashboard as default if args are empty
       if ( !isset( $_GET['q'] ) ) {
          $_GET['q']      = 'civicrm/dashboard';
          $_GET['reset']  = 1;
          $argdata['args'] = array('civicrm', 'dashboard');
        }
    
        // do the business
        CRM_Core_Invoke::invoke($argdata['args']);
    
        // restore WP's timezone
        if ($wpBaseTimezone) {
          date_default_timezone_set($wpBaseTimezone);
        }
    
        // restore WP's arrays
        $this->restore_wp_magic_quotes();
    
        // notify plugins
        do_action( 'civicrm_invoked' );
    
      }
    
    
      /**
       * Non-destructively override WordPress magic quotes
       * Only called by invoke() to undo WordPress default behaviour
       * CMW: Should probably be a private method
       *
       * @return void
       */
      public function remove_wp_magic_quotes() {
    
        // save original arrays
        $this->wp_get     = $_GET;
        $this->wp_post    = $_POST;
        $this->wp_cookie  = $_COOKIE;
        $this->wp_request = $_REQUEST;
    
        // reassign globals
        $_GET     = stripslashes_deep($_GET);
        $_POST    = stripslashes_deep($_POST);
        $_COOKIE  = stripslashes_deep($_COOKIE);
        $_REQUEST = stripslashes_deep($_REQUEST);
    
      }
    
    
      /**
       * Restore WordPress magic quotes
       * Only called by invoke() to redo WordPress default behaviour
       * CMW: Should probably be a private method
       *
       * @return void
       */
      public function restore_wp_magic_quotes() {
    
        // restore original arrays
        $_GET     = $this->wp_get;
        $_POST    = $this->wp_post;
        $_COOKIE  = $this->wp_cookie;
        $_REQUEST = $this->wp_request;
    
      }
    
    
      /**
       * Detect Ajax, snippet, or file requests
       *
       * @return boolean True if request is for a CiviCRM page, false otherwise
       */
      public function is_page_request() {
    
        // kick out if not CiviCRM
        if (!$this->initialize()) {
          return;
        }
    
        // get args
        $argdata = $this->get_request_args();
    
        // FIXME: It's not sustainable to hardcode a whitelist of all of non-HTML
        // pages. Maybe the menu-XML should include some metadata to make this
        // unnecessary?
        if (CRM_Utils_Array::value('HTTP_X_REQUESTED_WITH', $_SERVER) == 'XMLHttpRequest'
            || ($argdata['args'][0] == 'civicrm' && in_array($argdata['args'][1], array('ajax', 'file')) )
            || !empty($_REQUEST['snippet'])
            || strpos($argdata['argString'], 'civicrm/event/ical') === 0 && empty($_GET['html'])
            || strpos($argdata['argString'], 'civicrm/contact/imagefile') === 0
        ) {
          return FALSE;
        }
        else {
          return TRUE;
        }
      }
    
    
      /**
       * Get arguments and request string from $_GET
       *
       * @return array $argdata Array containing request arguments and request string
       */
      public function get_request_args() {
    
        $argString = NULL;
        $args = array();
        if (isset( $_GET['q'])) {
          $argString = trim($_GET['q']);
          $args = explode('/', $argString);
        }
        $args = array_pad($args, 2, '');
    
        return array(
          'args' => $args,
          'argString' => $argString
        );
    
      }
    
      /**
       * Add CiviCRM's title to the header's <title>
       *
       * @param string $title
       * @return string
       */
      public function set_admin_title($title) {
        global $civicrm_wp_title;
        if (!$civicrm_wp_title) {
          return $title;
        }
        // Replace 1st occurance of "CiviCRM" in the title
        $pos = strpos($title, 'CiviCRM');
        if ($pos !== FALSE) {
          return substr_replace($title, $civicrm_wp_title, $pos, 7);
        }
        return $civicrm_wp_title;
      }
    
    
      /**
       * Override a WordPress page title with the CiviCRM entity title
       * Callback method for 'single_page_title' hook, always called from WP front-end
       *
       * @param string $post_title The title of the WordPress page or post
       * @param object $post The WordPress post object the title applies to
       * @return string $civicrm_wp_title The title of the CiviCRM entity
       */
      public function single_page_title( $post_title, $post ) {
    
        // sanity check and override
        global $civicrm_wp_title;
        if (!empty($civicrm_wp_title)) {
          return $civicrm_wp_title;
        }
    
        // fallback
        return $post_title;
    
      }
    
    
      /**
       * Remove edit link from page content
       * Callback from 'edit_post_link' hook
       *
       * @return string Always empty
       */
      public function clear_edit_post_link() {
        return '';
      }
    
    
      /**
       * Remove edit link in WP Admin Bar
       * Callback from 'wp_before_admin_bar_render' hook
       *
       * @return void
       */
      public function clear_edit_post_menu_item() {
    
        // access object
        global $wp_admin_bar;
    
        // bail if in admin
        if ( is_admin() ) return;
    
        // remove the menu item from front end
        $wp_admin_bar->remove_menu( 'edit' );
    
      }
    
    
      /**
       * Clone of CRM_Utils_System_WordPress::getBaseUrl() whose access is set to
       * private. Until it is public, we cannot access the URL of the basepage since
       * CRM_Utils_System_WordPress::url()
       *
       * @param bool $absolute Passing TRUE prepends the scheme and domain, FALSE doesn't
       * @param bool $frontend Passing FALSE returns the admin URL
       * @param $forceBackend Passing TRUE overrides $frontend and returns the admin URL
       * @return mixed|null|string
       */
      public function get_base_url($absolute, $frontend, $forceBackend) {
        $config    = CRM_Core_Config::singleton();
    
        if (!isset($config->useFrameworkRelativeBase)) {
          $base = parse_url($config->userFrameworkBaseURL);
          $config->useFrameworkRelativeBase = $base['path'];
        }
    
        $base = $absolute ? $config->userFrameworkBaseURL : $config->useFrameworkRelativeBase;
    
        if ((is_admin() && !$frontend) || $forceBackend) {
          $base .= admin_url( 'admin.php' );
          return $base;
        }
        elseif (defined('CIVICRM_UF_WP_BASEPAGE')) {
          $base .= CIVICRM_UF_WP_BASEPAGE;
          return $base;
        }
        elseif (isset($config->wpBasePage)) {
          $base .= $config->wpBasePage;
          return $base;
        }
    
        return $base;
      }
    
    
    } // class CiviCRM_For_WordPress ends
    
    
    /*
    --------------------------------------------------------------------------------
    Procedures start here
    --------------------------------------------------------------------------------
    */
    
    
    /**
     * The main function responsible for returning the CiviCRM_For_WordPress instance
     * to functions everywhere.
     *
     * Use this function like you would a global variable, except without needing
     * to declare the global.
     *
     * Example: $civi = civi_wp();
     *
     * @return CiviCRM_For_WordPress instance
     */
    function civi_wp() {
      return CiviCRM_For_WordPress::singleton();
    }
    
    
    /**
     * Hook CiviCRM_For_WordPress early onto the 'plugins_loaded' action.
     *
     * This gives all other plugins the chance to load before CiviCRM, to get their
     * actions, filters, and overrides setup without CiviCRM being in the way.
     */
    if ( defined( 'CIVICRM_LATE_LOAD' ) ) {
      add_action( 'plugins_loaded', 'civi_wp', (int) CIVICRM_LATE_LOAD );
    
    // initialize
    } else {
      civi_wp();
    }
    
    
    /**
     * Tell WordPress to call plugin activation method - no longer calls legacy
     * global scope function
     */
    register_activation_hook( CIVICRM_PLUGIN_FILE, array( civi_wp(), 'activate' ) );
    
    
    /**
     * Tell WordPress to call plugin deactivation method - needed in order to reset
     * the option that is set on activation.
     */
    register_deactivation_hook( CIVICRM_PLUGIN_FILE, array( civi_wp(), 'deactivate' ) );
    
    
    // uninstall uses the 'uninstall.php' method
    // see: http://codex.wordpress.org/Function_Reference/register_uninstall_hook
    
    
    
    /*
    --------------------------------------------------------------------------------
    The global scope functions below are to maintain backwards compatibility with
    previous versions of the CiviCRM WordPress plugin.
    --------------------------------------------------------------------------------
    */
    
    
    /**
     * add CiviCRM access capabilities to WordPress roles
     * Called by postProcess() in civicrm/CRM/ACL/Form/WordPress/Permissions.php
     * Also a callback for the 'init' hook in civi_wp()->register_hooks()
     */
    function wp_civicrm_capability() {
      civi_wp()->users->set_access_capabilities();
    }
    
    /**
     * Test if CiviCRM is currently being displayed in WordPress
     * Called by setTitle() in civicrm/CRM/Utils/System/WordPress.php
     * Also called at the top of this plugin file to determine AJAX status
     */
    function civicrm_wp_in_civicrm() {
      return civi_wp()->civicrm_in_wordpress();
    }
    
    /**
     * This was the original name of the initialization function and is
     * retained for backward compatibility
     */
    function civicrm_wp_initialize() {
      return civi_wp()->initialize();
    }
    
    /**
     * Initialize CiviCRM. Call this function from other modules too if
     * they use the CiviCRM API.
     */
    function civicrm_initialize() {
      return civi_wp()->initialize();
    }
    
    /**
     * Callback from 'edit_post_link' hook to remove edit link in civicrm_set_post_blank()
     */
    function civicrm_set_blank() {
      return civi_wp()->clear_edit_post_link();
    }
    
    /**
     * Authentication function used by civicrm_wp_frontend()
     */
    function civicrm_check_permission( $args ) {
      return civi_wp()->users->check_permission( $args );
    }
    
    /**
     * Called when authentication fails in civicrm_wp_frontend()
     */
    function civicrm_set_frontendmessage() {
      return civi_wp()->users->get_permission_denied();
    }
    
    /**
     * Invoke CiviCRM in a WordPress context
     * Callback function from add_menu_page()
     * Callback from WordPress 'init' and 'the_content' hooks
     * Also used by civicrm_wp_shortcode_includes() and _civicrm_update_user()
     */
    function civicrm_wp_invoke() {
      civi_wp()->invoke();
    }
    
    /**
     * Method that runs only when civicrm plugin is activated.
     */
    function civicrm_activate() {
      civi_wp()->activate();
    }
    
    /**
     * Function to create anonymous_user' role, if 'anonymous_user' role is not in the wordpress installation
     * and assign minimum capabilities for all wordpress roles
     * This function is called on plugin activation and also from upgrade_4_3_alpha1()
     */
    function civicrm_wp_set_capabilities() {
      civi_wp()->users->set_wp_user_capabilities();
    }
    
    /**
     * Callback function for add_options_page() that runs the CiviCRM installer
     */
    function civicrm_run_installer() {
      civi_wp()->run_installer();
    }
    
    /**
     * Function to get the contact type
     * @param string $default contact type
     * @return $ctype contact type
     */
    function civicrm_get_ctype( $default = NULL ) {
      return civi_wp()->users->get_civicrm_contact_type( $default );
    }
    
    /**
     * Getter function for global $wp_set_breadCrumb
     * Called by appendBreadCrumb() in civicrm/CRM/Utils/System/WordPress.php
     */
    function wp_get_breadcrumb() {
      global $wp_set_breadCrumb;
      return $wp_set_breadCrumb;
    }
    
    /**
     * Setter function for global $wp_set_breadCrumb
     * Called by appendBreadCrumb() in civicrm/CRM/Utils/System/WordPress.php
     * Called by resetBreadCrumb() in civicrm/CRM/Utils/System/WordPress.php
     */
    function wp_set_breadcrumb( $breadCrumb ) {
      global $wp_set_breadCrumb;
      $wp_set_breadCrumb = $breadCrumb;
      return $wp_set_breadCrumb;
    }
    
    
    /**
     * Incorporate WP-CLI Integration
     * Based on drush civicrm functionality, work done by Andy Walker
     * https://github.com/andy-walker/wp-cli-civicrm
     */
    if ( defined('WP_CLI') && WP_CLI ) {
      // changed from __DIR__ because of possible symlink issues
      include_once CIVICRM_PLUGIN_DIR . 'wp-cli/civicrm.php';
    }