is_drupal = FALSE;
$this->is_wordpress = TRUE;
}
/**
* @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);
}
}
/**
* @inheritDoc
*/
public function appendBreadCrumb($breadCrumbs) {
$breadCrumb = wp_get_breadcrumb();
if (is_array($breadCrumbs)) {
foreach ($breadCrumbs as $crumbs) {
if (stripos($crumbs['url'], 'id%%')) {
$args = array('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[] = "{$crumbs['title']}";
}
}
$template = CRM_Core_Smarty::singleton();
$template->assign_by_ref('breadcrumb', $breadCrumb);
wp_set_breadcrumb($breadCrumb);
}
/**
* @inheritDoc
*/
public function resetBreadCrumb() {
$bc = array();
wp_set_breadcrumb($bc);
}
/**
* @inheritDoc
*/
public function addHTMLHead($head) {
static $registered = FALSE;
if (!$registered) {
// front-end view
add_action('wp_head', array(__CLASS__, '_showHTMLHead'));
// back-end views
add_action('admin_head', array(__CLASS__, '_showHTMLHead'));
}
CRM_Core_Region::instance('wp_head')->add(array(
'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 mapConfigToSSL() {
global $base_url;
$base_url = str_replace('http://', 'https://', $base_url);
}
/**
* @inheritDoc
*/
public function url(
$path = NULL,
$query = NULL,
$absolute = FALSE,
$fragment = NULL,
$htmlize = TRUE,
$frontend = FALSE,
$forceBackend = FALSE
) {
$config = CRM_Core_Config::singleton();
$script = '';
$separator = $htmlize ? '&' : '&';
$wpPageParam = '';
$fragment = isset($fragment) ? ('#' . $fragment) : '';
$path = CRM_Utils_String::stripPathChars($path);
//this means wp function we are trying to use is not available,
//so load bootStrap
if (!function_exists('get_option')) {
$this->loadBootStrap(); // FIXME: Why bootstrap in url()? Generally want to define 1-2 strategic places to put bootstrap
}
if ($config->userFrameworkFrontend) {
if (get_option('permalink_structure') != '') {
global $post;
$script = get_permalink($post->ID);
}
// when shortcode is included in page
// also make sure we have valid query object
global $wp_query;
if (method_exists($wp_query, 'get')) {
if (get_query_var('page_id')) {
$wpPageParam = "page_id=" . get_query_var('page_id');
}
elseif (get_query_var('p')) {
// when shortcode is inserted in post
$wpPageParam = "p=" . get_query_var('p');
}
}
}
$base = $this->getBaseUrl($absolute, $frontend, $forceBackend);
if (!isset($path) && !isset($query)) {
// FIXME: This short-circuited codepath is the same as the general one below, except
// in that it ignores "permlink_structure" / $wpPageParam / $script . I don't know
// why it's different (and I can only find two obvious use-cases for this codepath,
// of which at least one looks gratuitous). A more ambitious person would simply remove
// this code.
return $base . $fragment;
}
if (!$forceBackend && get_option('permalink_structure') != '' && ($wpPageParam || $script != '')) {
$base = $script;
}
$queryParts = array();
if (isset($path)) {
$queryParts[] = 'page=CiviCRM';
$queryParts[] = "q={$path}";
}
if ($wpPageParam) {
$queryParts[] = $wpPageParam;
}
if (isset($query)) {
$queryParts[] = $query;
}
return $base . '?' . implode($separator, $queryParts) . $fragment;
}
/**
* @param $absolute
* @param $frontend
* @param $forceBackend
*
* @return mixed|null|string
*/
private function getBaseUrl($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 .= 'wp-admin/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;
}
/**
* @inheritDoc
*/
public function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
$config = CRM_Core_Config::singleton();
if ($loadCMSBootstrap) {
$config->userSystem->loadBootStrap($name, $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 array($contactID, $user->data->ID, mt_rand());
}
/**
* FIXME: Do something
*/
public function setMessage($message) {
}
/**
* FIXME: Do something
*/
public function loadUser($user) {
return TRUE;
}
/**
* FIXME: Use CMS-native approach
*/
public function permissionDenied() {
CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
}
/**
* @inheritDoc
*/
public function logout() {
// destroy session
if (session_id()) {
session_destroy();
}
wp_logout();
wp_redirect(wp_login_url());
}
/**
* @inheritDoc
*/
public function getUFLocale() {
// WPML plugin
if (defined('ICL_LANGUAGE_CODE')) {
$language = ICL_LANGUAGE_CODE;
}
// TODO: set language variable for others WordPress plugin
if (isset($language)) {
return CRM_Core_I18n_PseudoConstant::longForShort(substr($language, 0, 2));
}
else {
return NULL;
}
}
/**
* Load wordpress bootstrap.
*
* @param string $name
* optional username for login.
* @param string $pass
* optional password for login.
*
* @return bool
*/
public function loadBootStrap($name = NULL, $pass = NULL) {
global $wp, $wp_rewrite, $wp_the_query, $wp_query, $wpdb, $current_site, $current_blog, $current_user;
if (!defined('WP_USE_THEMES')) {
define('WP_USE_THEMES', false);
}
$cmsRootPath = $this->cmsRootPath();
if (!$cmsRootPath) {
CRM_Core_Error::fatal("Could not find the install directory for WordPress");
}
$path = CRM_Core_BAO_Setting::getItem('CiviCRM Preferences', '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 {
CRM_Core_Error::fatal("Could not find the bootstrap file for WordPress");
}
$wpUserTimezone = get_option('timezone_string');
if ($wpUserTimezone) {
date_default_timezone_set($wpUserTimezone);
CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
}
require_once $cmsRootPath . DIRECTORY_SEPARATOR . 'wp-includes/pluggable.php';
$uid = CRM_Utils_Array::value('uid', $name);
if (!$uid) {
$name = $name ? $name : trim(CRM_Utils_Array::value('name', $_REQUEST));
$pass = $pass ? $pass : trim(CRM_Utils_Array::value('pass', $_REQUEST));
if ($name) {
$uid = wp_authenticate($name, $pass); // this returns a WP_User object if successful
if (!$uid) {
if ($throwError) {
echo '
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 $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() {
$cmsRoot = $valid = NULL;
if (defined('CIVICRM_CMSDIR')) {
if ($this->validInstallDir(CIVICRM_CMSDIR)) {
$cmsRoot = CIVICRM_CMSDIR;
$valid = TRUE;
}
}
else {
$pathVars = explode('/', str_replace('\\', '/', $_SERVER['SCRIPT_FILENAME']));
//might be windows installation.
$firstVar = array_shift($pathVars);
if ($firstVar) {
$cmsRoot = $firstVar;
}
//start w/ csm 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, $mail) {
$user_data = array(
'ID' => '',
'user_pass' => $params['cms_pass'],
'user_login' => $params['cms_name'],
'user_email' => $params[$mail],
'nickname' => $params['cms_name'],
'role' => get_option('default_role'),
);
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'
);
}
}
$uid = wp_insert_user($user_data);
$creds = array();
$creds['user_login'] = $params['cms_name'];
$creds['user_password'] = $params['cms_pass'];
$creds['remember'] = TRUE;
$user = wp_signon($creds, FALSE);
wp_new_user_notification($uid, $user_data['user_pass']);
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 = array('ID' => $ufID, 'user_email' => $ufName);
if ($ufID) {
wp_update_user($values);
}
}
}
/**
* @param array $params
* @param $errors
* @param string $emailName
*/
public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
$config = CRM_Core_Config::singleton();
$dao = new CRM_Core_DAO();
$name = $dao->escape(CRM_Utils_Array::value('name', $params));
$email = $dao->escape(CRM_Utils_Array::value('mail', $params));
if (!empty($params['name'])) {
if (!validate_username($params['name'])) {
$errors['cms_name'] = ts("Your username contains invalid characters");
}
elseif (username_exists(sanitize_user($params['name']))) {
$errors['cms_name'] = ts('The username %1 is already taken. Please select another username.', array(1 => $params['name']));
}
}
if (!empty($params['mail'])) {
if (!is_email($params['mail'])) {
$errors[$emailName] = "Your email is invaid";
}
elseif (email_exists($params['mail'])) {
$resetUrl = $config->userFrameworkBaseURL . 'wp-login.php?action=lostpassword';
$errors[$emailName] = ts('The email address %1 is already registered. Have you forgotten your password?',
array(1 => $params['mail'], 2 => $resetUrl)
);
}
}
}
/**
* @inheritDoc
*/
public function isUserLoggedIn() {
$isloggedIn = FALSE;
if (function_exists('is_user_logged_in')) {
$isloggedIn = is_user_logged_in();
}
return $isloggedIn;
}
/**
* @return mixed
*/
public function getLoggedInUserObject() {
if (function_exists('is_user_logged_in') &&
is_user_logged_in()
) {
global $current_user;
}
return $current_user;
}
/**
* @inheritDoc
*/
public function getLoggedInUfID() {
$ufID = NULL;
$current_user = $this->getLoggedInUserObject();
return isset($current_user->ID) ? $current_user->ID : NULL;
}
/**
* @inheritDoc
*/
public function getLoggedInUniqueIdentifier() {
$user = $this->getLoggedInUserObject();
return $this->getUniqueIdentifierFromUserObject($user);
}
/**
* Get User ID from UserFramework system (Joomla)
* @param object $user
* Object as described by the CMS.
*
* @return int|null
*/
public function getUserIDFromUserObject($user) {
return !empty($user->ID) ? $user->ID : NULL;
}
/**
* @inheritDoc
*/
public function getUniqueIdentifierFromUserObject($user) {
return empty($user->user_email) ? NULL : $user->user_email;
}
/**
* @inheritDoc
*/
public function getLoginURL($destination = '') {
$config = CRM_Core_Config::singleton();
$loginURL = $config->userFrameworkBaseURL;
$loginURL .= 'wp-login.php';
return $loginURL;
}
/**
* FIXME: Do something
*/
public function getLoginDestination(&$form) {
return NULL;
}
/**
* @inheritDoc
*/
public function getVersion() {
if (function_exists('get_bloginfo')) {
return get_bloginfo('version', 'display');
}
else {
return 'Unknown';
}
}
/**
* @inheritDoc
*/
public function getTimeZoneString() {
return get_option('timezone_string');
}
/**
* @inheritDoc
*/
public function getUserRecordUrl($contactID) {
$uid = CRM_Core_BAO_UFMatch::getUFId($contactID);
if (CRM_Core_Session::singleton()
->get('userID') == $contactID || CRM_Core_Permission::checkAnyPerm(array('cms:administer users'))
) {
return CRM_Core_Config::singleton()->userFrameworkBaseURL . "wp-admin/user-edit.php?user_id=" . $uid;
}
}
/**
* Append WP js to coreResourcesList.
*/
public function appendCoreResources(&$list) {
$list[] = 'js/crm.wordpress.js';
}
}