design/src/messenger/webim/libs/chat.php

<?php
/*
 * Copyright 2005-2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

require_once(dirname(__FILE__).'/track.php');
require_once(dirname(__FILE__).'/classes/thread.php');
require_once(dirname(__FILE__).'/classes/mibew_api.php');
require_once(dirname(__FILE__).'/classes/mibew_api_interaction.php');
require_once(dirname(__FILE__).'/classes/mibew_api_chat_interaction.php');
require_once(dirname(__FILE__).'/classes/mibew_api_execution_context.php');
require_once(dirname(__FILE__).'/classes/request_processor.php');
require_once(dirname(__FILE__).'/classes/client_side_processor.php');
require_once(dirname(__FILE__).'/classes/thread_processor.php');

$namecookie = "WEBIM_Data";
$usercookie = "WEBIM_UserID";

function get_user_id()
{
	return (time() + microtime()) . rand(0, 99999999);
}

function message_to_text($msg)
{
	$message_time = date("H:i:s ", $msg['created']);
	if ($msg['kind'] == Thread::KIND_USER || $msg['kind'] == Thread::KIND_AGENT) {
		if ($msg['name'])
			return $message_time . $msg['name'] . ": " . $msg['message'] . "\n";
		else
			return $message_time . $msg['message'] . "\n";
	} else if ($msg['kind'] == Thread::KIND_INFO) {
		return $message_time . $msg['message'] . "\n";
	} else {
		return $message_time . "[" . $msg['message'] . "]\n";
	}
}

function get_user_name($username, $addr, $id)
{
	return str_replace(
		"{addr}", $addr,
		str_replace(
			"{id}", $id,
			str_replace("{name}", $username, Settings::get('usernamepattern'))
		)
	);
}

function is_ajax_browser($browserid, $ver, $useragent)
{
	if ($browserid == "opera")
		return $ver >= 8.02;
	if ($browserid == "safari")
		return $ver >= 125;
	if ($browserid == "msie")
		return $ver >= 5.5 && !strstr($useragent, "powerpc");
	if ($browserid == "netscape")
		return $ver >= 7.1;
	if ($browserid == "mozilla")
		return $ver >= 1.4;
	if ($browserid == "firefox")
		return $ver >= 1.0;
	if ($browserid == "chrome")
		return true;

	return false;
}

$knownAgents = array("opera", "msie", "chrome", "safari", "firefox", "netscape", "mozilla");

function get_remote_level($useragent)
{
	global $knownAgents;
	$useragent = strtolower($useragent);
	foreach ($knownAgents as $agent) {
		if (strstr($useragent, $agent)) {
			if (preg_match("/" . $agent . "[\\s\/]?(\\d+(\\.\\d+)?)/", $useragent, $matches)) {
				$ver = $matches[1];

				if (is_ajax_browser($agent, $ver, $useragent)) {
					return "ajaxed";
				} else {
					return "old";
				}

			}
		}
	}
	return "ajaxed";
}

function is_agent_opera95()
{
	$useragent = strtolower($_SERVER['HTTP_USER_AGENT']);
	if (strstr($useragent, "opera")) {
		if (preg_match("/opera[\\s\/]?(\\d+(\\.\\d+)?)/", $useragent, $matches)) {
			$ver = $matches[1];

			if ($ver >= "9.5")
				return true;
		}
	}
	return false;
}

function is_mac_opera()
{
	$useragent = strtolower($_SERVER['HTTP_USER_AGENT']);
	return strstr($useragent, "opera") && strstr($useragent, "mac");
}

function needsFramesrc()
{
	$useragent = strtolower($_SERVER['HTTP_USER_AGENT']);
	return strstr($useragent, "safari/");
}

/**
 * Prepare logo data
 *
 * @param array $group Group info
 * @return array Array of logo data
 */
function setup_logo($group = NULL) {
	$data = array();

	$toplevelgroup = (!$group)?array():get_top_level_group($group);

	$data['company'] = array(
		'name' => topage(empty($toplevelgroup['vctitle'])
			? Settings::get('title')
			: $toplevelgroup['vctitle']),

		'chatLogoURL' => topage(empty($toplevelgroup['vclogo'])
			? Settings::get('logo')
			: $toplevelgroup['vclogo'])
	);

	$data['webimHost'] = topage(empty($toplevelgroup['vchosturl'])
		? Settings::get('hosturl')
		: $toplevelgroup['vchosturl']);

	return $data;
}

/**
 * Prepare values common for chat, prechat survey form and leave message form.
 * @return array
 */
function prepare_chat_app_data() {
	$data = array();

	// Set enter key shortcut
	if (Settings::get('sendmessagekey') == 'enter') {
		$data['send_shortcut'] = "Enter";
	} else {
		$data['send_shortcut'] = is_mac_opera()
			? "&#8984;-Enter"
			: "Ctrl-Enter";
	}

	// Set refresh frequency
	$data['frequency'] = Settings::get('updatefrequency_chat');

	// Set some localized strings
	$data['localized'] = array(
		'email.required' => no_field("form.field.email"),
		'name.required' => no_field("form.field.name"),
		'message.required' => no_field("form.field.message"),
		'wrong.email' => wrong_field("form.field.email")
	);

	return $data;
}

/**
 * Prepare data to display leave message form
 *
 * @param string $name User name
 * @param string $email User email
 * @param int $group_id Id of selected group
 * @param string $info User info
 * @param string $referrer URL of referrer page
 * @return array Array of leave message form data
 */
function setup_leavemessage($name, $email, $group_id, $info, $referrer) {
	$data = prepare_chat_app_data();

	// Create some empty arrays
	$data['leaveMessage'] = array();

	$group = group_by_id($group_id);
	$group_name = '';
	if ($group) {
		$group_name = get_group_name($group);
	}

	$data['leaveMessage']['leaveMessageForm'] = array(
		'name' => topage($name),
		'email' => topage($email),
		'groupId' => $group_id,
		'groupName' => $group_name,
		'info' => topage($info),
		'referrer' => topage($referrer),
		'showCaptcha' => (bool)(Settings::get("enablecaptcha") == "1"
			&& can_show_captcha())
	);

	$data['page.title'] = (empty($group_name)?'':$group_name.': ')
		. getlocal('leavemessage.title');
	$data['leaveMessage']['page'] = array(
		'title' => $data['page.title']
	);

	if (Settings::get('enablegroups') == '1') {
		$data['leaveMessage']['leaveMessageForm']['groups']
			= prepare_groups_select($group_id);
	}

	$data['startFrom'] = 'leaveMessage';

	return $data;
}

/**
 * Prepare data to dispaly pre-chat survey
 *
 * @param string $name User name
 * @param string $email User email
 * @param int $group_id Id of selected group
 * @param string $info User info
 * @param string $referrer URL of referrer page
 * @return array Array of survey data
 */
function setup_survey($name, $email, $group_id, $info, $referrer) {
	$data = prepare_chat_app_data();

	// Create some empty arrays
	$data['survey'] = array();

	$data['survey']['surveyForm'] = array(
		'name' => topage($name),
		'groupId' => $group_id,
		'email' => topage($email),
		'info' => topage($info),
		'referrer' => topage($referrer),
		'showEmail' => (bool)(Settings::get("surveyaskmail") == "1"),
		'showMessage' => (bool)(Settings::get("surveyaskmessage") == "1"),
		'canChangeName' => (bool)(Settings::get('usercanchangename') == "1")
	);

	$data['page.title'] = getlocal('presurvey.title');
	$data['survey']['page'] = array(
		'title' => $data['page.title']
	);

	if (Settings::get('enablegroups') == '1'
			&& Settings::get('surveyaskgroup') == '1') {
		$data['survey']['surveyForm']['groups']
			= prepare_groups_select($group_id);
	}

	$data['startFrom'] = 'survey';

	return $data;
}

/**
 * Prepare groups list to build group select box.
 *
 * If $group_id specified groups list will consist of group with id equals to
 * $group_id and its children.
 *
 * @param int $group_id Id of selected group
 * @return array|boolean Array of groups info arrays or boolean false if there
 * are no suitable groups.
 * Group info array contain following keys:
 *  - 'id': int, group id;
 *  - 'name': string, group name;
 *  - 'description': string, group description;
 *  - 'online': boolean, indicates if group online;
 *  - 'selected': boolean, indicates if group selected by default.
 */
function prepare_groups_select($group_id) {
	$show_groups = ($group_id == '')
		? true
		: group_has_children($group_id);

	if (!$show_groups) {
		return false;
	}

	$all_groups = get_groups(false);

	if (empty($all_groups)) {
		return false;
	}

	$groups_list = array();
	$selected_group_id = $group_id;

	foreach($all_groups as $group) {
		$group_is_empty = (bool)($group['inumofagents'] == 0);
		$group_related_with_specified = (empty($group_id)
			|| $group['parent'] == $group_id
			|| $group['groupid'] == $group_id);

		if ($group_is_empty || !$group_related_with_specified) {
			continue;
		}

		if (group_is_online($group) && !$selected_group_id) {
			$selected_group_id = $group['groupid'];
		}

		$groups_list[] = array(
			'id' => $group['groupid'],
			'name' => get_group_name($group),
			'description' => get_group_description($group),
			'online' => group_is_online($group),
			'selected' => (bool)($group['groupid'] == $selected_group_id)
		);
	}

	// One group must be selected by default
	if (! empty($groups_list)) {
		// Check if there is selected group
		$selected_group_present = false;
		foreach($groups_list as $group) {
			if ($group['selected']) {
				$selected_group_present = true;
				break;
			}
		}

		// If there is no selected group select the first one
		if (! $selected_group_present) {
			$groups_list[0]['selected'] = true;
		}
	}

	return $groups_list;
}

/**
 * Prepare some data for chat for both user and operator
 *
 * @param Thread $thread thread object
 * @return array Array of chat view data
 */
function setup_chatview(Thread $thread) {
	$data = prepare_chat_app_data();

	// Get group info
	if (! empty($thread->groupId)) {
		$group = group_by_id($thread->groupId);
		$group = get_top_level_group($group);
	} else {
		$group = array();
	}

	// Create some empty arrays
	$data['chat'] = array(
		'messageForm' => array(),
		'links' => array(),
		'windowsParams' => array()
	);

	// Set thread params
	$data['chat']['thread'] = array(
		'id' => $thread->id,
		'token' => $thread->lastToken
	);

	$data['page.title'] = topage(
		empty($group['vcchattitle'])
			? Settings::get('chattitle')
			: $group['vcchattitle']
	);
	$data['chat']['page'] = array(
		'title' => $data['page.title']
	);

	// Setup logo
	$data = array_merge_recursive(
		$data,
		setup_logo($group)
	);

	// Set enter key shortcut
	if (Settings::get('sendmessagekey') == 'enter') {
		$data['chat']['messageForm']['ignoreCtrl'] = true;
	} else {
		$data['chat']['messageForm']['ignoreCtrl'] = false;
	}

	// Set some browser info
	$data['isOpera95'] = is_agent_opera95();
	$data['neediframesrc'] = needsFramesrc();

	// Load dialogs style options
	$style_config = get_dialogs_style_config(getchatstyle());
	$data['chat']['windowsParams']['mail']
		= $style_config['mail']['window_params'];

	// Load core style options
	$style_config = get_core_style_config();
	$data['chat']['windowsParams']['history']
		= $style_config['history']['window_params'];

	$data['startFrom'] = 'chat';

	return $data;
}

/**
 * Prepare some data for chat for user
 *
 * @global string $webimroot Root URL path for Mibew
 * @param Thread $thread thread object
 * be used
 * @return array Array of chat view data
 */
function setup_chatview_for_user(Thread $thread) {
	global $webimroot;

	$data = setup_chatview($thread);

	// Load JavaScript plugins and JavaScripts, CSS files required by them
	$data['additional_css'] = get_additional_css('client_chat_window');
	$data['additional_js'] = get_additional_js('client_chat_window');
	$data['js_plugin_options'] = get_js_plugin_options('client_chat_window');

	// Set user info
	$data['chat']['user'] = array(
		'name' => htmlspecialchars(topage($thread->userName)),
		'canChangeName' => (bool)(Settings::get('usercanchangename') == "1"),
		'defaultName' => (bool)(getstring("chat.default.username")
			!= $thread->userName),
		'canPost' => true,
		'isAgent' => false
	);

	$params = "thread=" . $thread->id . "&amp;token=" . $thread->lastToken;

	// Set link to send mail page
	$data['chat']['links']['mail'] = "$webimroot/client.php?"
		. $params
		. "&amp;act=mailthread";

	// Set SSL link
	if (Settings::get('enablessl') == "1" && !is_secure_request()) {
		$data['chat']['links']['ssl'] = get_app_location(true, true)
			. "/client.php?"
			. $params;
	}

	return $data;
}

/**
 * Prepare some data for chat for operator
 *
 * @global string $webimroot Root URL path for Mibew
 * @global string $webim_encoding Current Mibew encoding
 * @param Thread $thread thread object
 * @return array Array of chat view data
 */
function setup_chatview_for_operator(Thread $thread, $operator) {
	global $webimroot, $webim_encoding;

	$data = setup_chatview($thread);

	// Load JavaScript plugins and JavaScripts, CSS files required by them
	$data['additional_css'] = get_additional_css('agent_chat_window');
	$data['additional_js'] = get_additional_js('agent_chat_window');
	$data['js_plugin_options'] = get_js_plugin_options('agent_chat_window');

	// Set operator info
	$data['chat']['user'] = array(
		'name' => htmlspecialchars(
			topage(
				get_user_name(
					$thread->userName,
					$thread->remote,
					$thread->userId
				)
			)
		),
		'canPost' => (bool)($thread->agentId == $operator['operatorid']),
		'isAgent' => true
	);

	// Set SSL link
	if (Settings::get('enablessl') == "1" && !is_secure_request()) {
		$data['chat']['links']['ssl'] = get_app_location(true, true)
			. "/operator/agent.php?thread="
			. $thread->id
			. "&amp;token="
			. $thread->lastToken;
	}

	// Set history window params
	$history_link_params = array("userid" => (string)$thread->userId);
	$data['chat']['links']['history'] = add_params(
		$webimroot . "/operator/userhistory.php",
		$history_link_params
	);

	// Set tracking params
	if (Settings::get('enabletracking')) {
	    $visitor = track_get_visitor_by_threadid($thread->id);
		$tracked_link_params = array("visitor" => "" . $visitor['visitorid']);
		$data['chat']['links']['tracked'] = add_params(
			$webimroot . "/operator/tracked.php",
			$tracked_link_params
		);
	}

	// Check if agent can post messages
	if ($thread->agentId == $operator['operatorid']) {
		// Get predefined answers
		$canned_messages = load_canned_messages($thread->locale, 0);
		if ($thread->groupId) {
			$canned_messages = array_merge(
				load_canned_messages($thread->locale, $thread->groupId),
				$canned_messages
			);
		};

		$predefined_answers = array();
		foreach ($canned_messages as $answer) {
			$predefined_answers[] = array(
				'short' => htmlspecialchars(
					topage($answer['vctitle']
						? $answer['vctitle']
						: cutstring($answer['vcvalue'], 97, '...'))
				),
				'full' => myiconv(
					$webim_encoding,
					getoutputenc(),
					$answer['vcvalue']
				)
			);
		}
		$data['chat']['messageForm']['predefinedAnswers'] = $predefined_answers;
	}
	// Set link to user redirection page
	$params = "thread=" . $thread->id . "&amp;token=" . $thread->lastToken;
	$data['chat']['links']['redirect'] = "$webimroot/operator/agent.php?"
		. $params
		. "&amp;act=redirect";

	$data['namePostfix'] = "";

	return $data;
}

function ban_for_addr($addr)
{
	$db = Database::getInstance();
	return $db->query(
		"select banid,comment from {chatban} " .
		"where dtmtill > :now AND address = :addr",
		array(
			':addr' => $addr,
			':now' => time()
		),
		array('return_rows' => Database::RETURN_ONE_ROW)
	);
}

function visitor_from_request()
{
	global $namecookie, $webim_encoding, $usercookie;
	$defaultName = getstring("chat.default.username");
	$userName = $defaultName;
	if (isset($_COOKIE[$namecookie])) {
		$data = base64_decode(strtr($_COOKIE[$namecookie], '-_,', '+/='));
		if (strlen($data) > 0) {
			$userName = myiconv("utf-8", $webim_encoding, $data);
		}
	}

	if ($userName == $defaultName) {
		$userName = getgetparam('name', $userName);
	}

	if (isset($_COOKIE[$usercookie])) {
		$userId = $_COOKIE[$usercookie];
	} else {
		$userId = get_user_id();
		setcookie($usercookie, $userId, time() + 60 * 60 * 24 * 365);
	}
	return array('id' => $userId, 'name' => $userName);
}

function get_remote_host()
{
	$extAddr = $_SERVER['REMOTE_ADDR'];
	if (isset($_SERVER['HTTP_X_FORWARDED_FOR']) &&
		$_SERVER['HTTP_X_FORWARDED_FOR'] != $_SERVER['REMOTE_ADDR']) {
		$extAddr = $_SERVER['REMOTE_ADDR'] . ' (' . $_SERVER['HTTP_X_FORWARDED_FOR'] . ')';
	}
	return isset($_SERVER['REMOTE_HOST']) ? $_SERVER['REMOTE_HOST'] : $extAddr;
}

/**
 * Start chat thread for user
 *
 * @global string $current_locale Current locale code
 * @param int $group_id Id of group related to thread
 * @param string $visitor_id Id of the visitor
 * @param string $visitor_name Name of the visitor
 * @param string $referrer Page user came from
 * @param string $info User info
 */
function chat_start_for_user($group_id, $visitor_id, $visitor_name, $referrer, $info) {
	global $current_locale;

	// Get user info
	$remote_host = get_remote_host();
	$user_browser = $_SERVER['HTTP_USER_AGENT'];

	// Check connection limit
	if(Thread::connectionLimitReached($remote_host)) {
		die("number of connections from your IP is exceeded, try again later");
	}

	// Create thread
	$thread = Thread::create();
	$thread->groupId = $group_id;
	$thread->userName = $visitor_name;
	$thread->remote = $remote_host;
	$thread->referer = $referrer;
	$thread->locale = $current_locale;
	$thread->userId = $visitor_id;
	$thread->userAgent = $user_browser;
	$thread->state = Thread::STATE_LOADING;
	$thread->save();

	$_SESSION['threadid'] = $thread->id;

	// Check if invitation accept
	$operator = invitation_accept($_SESSION['visitorid'], $thread->id);
	if ($operator) {
		$operator = operator_by_id($operator);
		$operator_name = get_operator_name($operator);
		$thread->postMessage(
			Thread::KIND_FOR_AGENT,
			getstring2(
				'chat.visitor.invitation.accepted',
				array($operator_name)
			)
		);
	}

	// Send some messages
	if ($referrer) {
		$thread->postMessage(
			Thread::KIND_FOR_AGENT,
			getstring2('chat.came.from',array($referrer))
		);
	}

	$thread->postMessage(Thread::KIND_INFO, getstring('chat.wait'));

	// TODO: May be move sending this message somewhere else?
	if ($info) {
		$thread->postMessage(
			Thread::KIND_FOR_AGENT,
			getstring2('chat.visitor.info',array($info))
		);
	}

	return $thread;
}

?>