/**
* Method used to add a new issue using the normal report form.
*
* @return integer The new issue ID
*/
public static function createFromPost()
{
$keys = array('add_primary_contact', 'attached_emails', 'category', 'contact', 'contact_email', 'contact_extra_emails', 'contact_person_fname', 'contact_person_lname', 'contact_phone', 'contact_timezone', 'contract', 'customer', 'custom_fields', 'description', 'estimated_dev_time', 'group', 'notify_customer', 'notify_senders', 'priority', 'private', 'release', 'severity', 'summary', 'users', 'product', 'product_version', 'expected_resolution_date', 'associated_issues');
$data = array();
foreach ($keys as $key) {
if (isset($_POST[$key])) {
$data[$key] = $_POST[$key];
}
}
$prj_id = Auth::getCurrentProject();
$current_usr_id = Auth::getUserID();
$usr_id = $current_usr_id;
// if we are creating an issue for a customer, put the
// main customer contact as the reporter for it
if (CRM::hasCustomerIntegration($prj_id)) {
$crm = CRM::getInstance($prj_id);
$contact_usr_id = User::getUserIDByContactID($data['contact']);
if (empty($contact_usr_id)) {
$contact_usr_id = $usr_id;
}
$data['reporter'] = $contact_usr_id;
} else {
$data['reporter'] = $usr_id;
}
$data['msg_id'] = Mail_Helper::generateMessageID();
$issue_id = self::insertIssue($prj_id, $data);
if ($issue_id == -1) {
return -1;
}
$has_RR = false;
$info = User::getNameEmail($usr_id);
// log the creation of the issue
History::add($issue_id, $current_usr_id, 'issue_opened', 'Issue opened by {user}', array('user' => User::getFullName($current_usr_id)));
$clone_iss_id = isset($_POST['clone_iss_id']) ? (int) $_POST['clone_iss_id'] : null;
if ($clone_iss_id && Access::canCloneIssue($clone_iss_id, $current_usr_id)) {
History::add($issue_id, $current_usr_id, 'issue_cloned_from', 'Issue cloned from #{issue_id}', array('issue_id' => $clone_iss_id));
History::add($clone_iss_id, $current_usr_id, 'issue_cloned_to', 'Issue cloned to #{issue_id}', array('issue_id' => $issue_id));
self::addAssociation($issue_id, $clone_iss_id, $usr_id, true);
}
$emails = array();
if (CRM::hasCustomerIntegration($prj_id)) {
$customer = $crm->getCustomer($data['customer']);
$contract = $crm->getContract($data['contract']);
if (!empty($data['contact_extra_emails']) && count($data['contact_extra_emails']) > 0) {
$emails = $data['contact_extra_emails'];
}
// add the primary contact to the notification list
if (isset($data['add_primary_contact']) && $data['add_primary_contact'] == 'yes') {
$contact_email = User::getEmailByContactID($data['contact']);
if (!empty($contact_email)) {
$emails[] = $contact_email;
}
}
// if there are any technical account managers associated with this customer, add these users to the notification list
$managers = $customer->getEventumAccountManagers();
foreach ($managers as $manager) {
$emails[] = $manager['usr_email'];
}
}
// add the reporter to the notification list
$emails[] = $info['usr_email'];
$emails = array_unique($emails);
foreach ($emails as $address) {
Notification::subscribeEmail($usr_id, $issue_id, $address, Notification::getDefaultActions($issue_id, $address, 'new_issue'));
}
// only assign the issue to an user if the associated customer has any technical account managers
$users = array();
$has_TAM = false;
if (CRM::hasCustomerIntegration($prj_id) && count($managers) > 0) {
foreach ($managers as $manager) {
if ($manager['cam_type'] == 'intpart') {
continue;
}
$users[] = $manager['cam_usr_id'];
self::addUserAssociation($usr_id, $issue_id, $manager['cam_usr_id'], false);
History::add($issue_id, $usr_id, 'issue_auto_assigned', 'Issue auto-assigned to {assignee} (TAM)', array('assignee' => User::getFullName($manager['cam_usr_id'])));
}
$has_TAM = true;
}
// now add the user/issue association (aka assignments)
if (!empty($data['users']) && count($data['users']) > 0) {
foreach ($data['users'] as $user) {
$actions = Notification::getDefaultActions($issue_id, User::getEmail($user), 'new_issue');
Notification::subscribeUser($usr_id, $issue_id, $user, $actions);
self::addUserAssociation($usr_id, $issue_id, $user);
if ($user != $usr_id) {
$users[] = $user;
}
}
} else {
// only use the round-robin feature if this new issue was not
// already assigned to a customer account manager
if (@count($managers) < 1) {
$assignee = Round_Robin::getNextAssignee($prj_id);
// assign the issue to the round robin person
if (!empty($assignee)) {
$users[] = $assignee;
self::addUserAssociation($usr_id, $issue_id, $assignee, false);
History::add($issue_id, APP_SYSTEM_USER_ID, 'rr_issue_assigned', 'Issue auto-assigned to {assignee} (RR)', array('assignee' => User::getFullName($assignee)));
$has_RR = true;
}
}
}
// set product and version
if (isset($data['product']) && $data['product'] != '-1') {
Product::addIssueProductVersion($issue_id, $data['product'], $data['product_version']);
}
// process any files being uploaded
// from ajax upload, attachment file ids
$iaf_ids = !empty($_POST['iaf_ids']) ? explode(',', $_POST['iaf_ids']) : null;
// if no iaf_ids passed, perhaps it's old style upload
// TODO: verify that the uploaded file(s) owner is same as attachment owner.
if (!$iaf_ids && isset($_FILES['file'])) {
$iaf_ids = Attachment::addFiles($_FILES['file']);
}
if ($iaf_ids) {
Attachment::attachFiles($issue_id, $usr_id, $iaf_ids, false, 'Files uploaded at issue creation time');
}
// need to associate any emails ?
if (!empty($data['attached_emails'])) {
$items = explode(',', $data['attached_emails']);
Support::associate($usr_id, $issue_id, $items);
}
// need to notify any emails being converted into issues ?
if (@count($data['notify_senders']) > 0) {
$recipients = Notification::notifyEmailConvertedIntoIssue($prj_id, $issue_id, $data['notify_senders'], @$data['customer']);
} else {
$recipients = array();
}
// need to process any custom fields ?
if (@count($data['custom_fields']) > 0) {
foreach ($data['custom_fields'] as $fld_id => $value) {
Custom_Field::associateIssue($issue_id, $fld_id, $value);
}
}
// also send a special confirmation email to the customer contact
if (@$data['notify_customer'] == 'yes' && !empty($data['contact'])) {
$contact = $contract->getContact($data['contact']);
// also need to pass the list of sender emails already notified,
// so we can avoid notifying the same person again
$contact_email = User::getEmailByContactID($data['contact']);
if (@(!in_array($contact_email, $recipients))) {
$contact->notifyNewIssue($issue_id);
}
// now check for additional emails in contact_extra_emails
if (@count($data['contact_extra_emails']) > 0) {
$notification_emails = $data['contact_extra_emails'];
foreach ($notification_emails as $notification_email) {
if (@(!in_array($notification_email, $recipients))) {
try {
$notification_contact = $crm->getContactByEmail($notification_email);
$notification_contact->notifyNewIssue($issue_id);
} catch (ContactNotFoundException $e) {
}
}
}
}
}
// handle associated issues
if (isset($data['associated_issues'])) {
$associated_issues = explode(',', $data['associated_issues']);
if ($clone_iss_id) {
$associated_issues[] = $clone_iss_id;
}
self::updateAssociatedIssuesRelations($issue_id, $associated_issues);
}
Workflow::handleNewIssue($prj_id, $issue_id, $has_TAM, $has_RR);
// also notify any users that want to receive emails anytime a new issue is created
Notification::notifyNewIssue($prj_id, $issue_id);
return $issue_id;
}
/**
* Processes the template and assigns common variables automatically.
*
* @access private
*/
function processTemplate()
{
global $HTTP_SERVER_VARS;
// determine the correct CSS file to use
if (ereg('MSIE ([0-9].[0-9]{1,2})', @$HTTP_SERVER_VARS["HTTP_USER_AGENT"], $log_version)) {
$user_agent = 'ie';
} else {
$user_agent = 'other';
}
$this->assign("user_agent", $user_agent);
// create the list of projects
$usr_id = Auth::getUserID();
if ($usr_id != '') {
$prj_id = Auth::getCurrentProject();
if (!empty($prj_id)) {
$role_id = User::getRoleByUser($usr_id, $prj_id);
$this->assign("current_project", $prj_id);
$this->assign("current_project_name", Auth::getCurrentProjectName());
$has_customer_integration = Customer::hasCustomerIntegration($prj_id);
$this->assign("has_customer_integration", $has_customer_integration);
if ($has_customer_integration) {
$this->assign("customer_backend_name", Customer::getBackendImplementationName($prj_id));
}
if ($role_id == User::getRoleID('administrator') || $role_id == User::getRoleID('manager')) {
$this->assign("show_admin_link", true);
}
if ($role_id > 0) {
$this->assign("current_role", (int) $role_id);
$this->assign("current_role_name", User::getRole($role_id));
}
}
$info = User::getNameEmail($usr_id);
$this->assign("active_projects", Project::getAssocList($usr_id));
$this->assign("current_full_name", $info["usr_full_name"]);
$this->assign("current_email", $info["usr_email"]);
$this->assign("current_user_id", $usr_id);
$this->assign("is_current_user_clocked_in", User::isClockedIn($usr_id));
$this->assign("roles", User::getAssocRoleIDs());
}
$this->assign("app_setup", Setup::load());
$this->assign("app_setup_path", APP_SETUP_PATH);
$this->assign("app_setup_file", APP_SETUP_FILE);
$this->assign("application_version", APP_VERSION);
$this->assign("application_title", APP_NAME);
$this->assign("app_base_url", APP_BASE_URL);
$this->assign("rel_url", APP_RELATIVE_URL);
$this->assign("lang", APP_CURRENT_LANG);
$this->assign("SID", SID);
// now for the browser detection stuff
Net_UserAgent_Detect::detect();
$this->assign("browser", Net_UserAgent_Detect::_getStaticProperty('browser'));
$this->assign("os", Net_UserAgent_Detect::_getStaticProperty('os'));
// this is only used by the textarea resize script
$js_script_name = str_replace('/', '_', str_replace('.php', '', $HTTP_SERVER_VARS['PHP_SELF']));
$this->assign("js_script_name", $js_script_name);
$this->assign("total_queries", $GLOBALS['TOTAL_QUERIES']);
$this->assign(array("cell_color" => APP_CELL_COLOR, "light_color" => APP_LIGHT_COLOR, "middle_color" => APP_MIDDLE_COLOR, "dark_color" => APP_DARK_COLOR, "cycle" => APP_CYCLE_COLORS, "internal_color" => APP_INTERNAL_COLOR));
}
/**
* Returns the number of emails sent by a user in a time range.
*
* @param string $usr_id The ID of the user
* @param integer $start The timestamp of the start date
* @param integer $end The timestamp of the end date
* @param boolean $associated If this should return emails associated with issues or non associated emails.
* @return integer The number of emails sent by the user.
*/
public static function getSentEmailCountByUser($usr_id, $start, $end, $associated)
{
$usr_info = User::getNameEmail($usr_id);
$stmt = 'SELECT
COUNT(sup_id)
FROM
{{%support_email}},
{{%email_account}}
WHERE
ema_id = sup_ema_id AND
ema_prj_id = ? AND
sup_date BETWEEN ? AND ? AND
sup_from LIKE ? AND
sup_iss_id ';
if ($associated == true) {
$stmt .= '!= 0';
} else {
$stmt .= '= 0';
}
$params = array(Auth::getCurrentProject(), $start, $end, "%{$usr_info['usr_email']}%");
try {
$res = DB_Helper::getInstance()->getOne($stmt, $params);
} catch (DbException $e) {
return '';
}
return $res;
}
/**
* Method used to add a new issue using the normal report form.
*
* @access public
* @return integer The new issue ID
*/
function insert()
{
global $HTTP_POST_VARS, $HTTP_POST_FILES, $insert_errors;
$usr_id = Auth::getUserID();
$prj_id = Auth::getCurrentProject();
$initial_status = Project::getInitialStatus($prj_id);
$insert_errors = array();
$missing_fields = array();
if ($HTTP_POST_VARS["category"] == '-1') {
$missing_fields[] = "Category";
}
if ($HTTP_POST_VARS["priority"] == '-1') {
$missing_fields[] = "Priority";
}
if ($HTTP_POST_VARS["estimated_dev_time"] == '') {
$HTTP_POST_VARS["estimated_dev_time"] = 0;
}
// add new issue
$stmt = "INSERT INTO\n " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "issue\n (\n iss_prj_id,\n";
if (!empty($HTTP_POST_VARS["group"])) {
$stmt .= "iss_grp_id,\n";
}
if (!empty($HTTP_POST_VARS["category"])) {
$stmt .= "iss_prc_id,\n";
}
if (!empty($HTTP_POST_VARS["release"])) {
$stmt .= "iss_pre_id,\n";
}
if (!empty($HTTP_POST_VARS["priority"])) {
$stmt .= "iss_pri_id,\n";
}
$stmt .= "iss_usr_id,";
if (!empty($initial_status)) {
$stmt .= "iss_sta_id,";
}
if (Customer::hasCustomerIntegration($prj_id)) {
$stmt .= "\n iss_customer_id,\n iss_customer_contact_id,\n iss_contact_person_lname,\n iss_contact_person_fname,\n iss_contact_email,\n iss_contact_phone,\n iss_contact_timezone,";
}
$stmt .= "\n iss_created_date,\n iss_last_public_action_date,\n iss_last_public_action_type,\n iss_summary,\n iss_description,\n iss_dev_time,\n iss_private,\n iss_root_message_id\n ) VALUES (\n " . $prj_id . ",\n";
if (!empty($HTTP_POST_VARS["group"])) {
$stmt .= Misc::escapeInteger($HTTP_POST_VARS["group"]) . ",\n";
}
if (!empty($HTTP_POST_VARS["category"])) {
$stmt .= Misc::escapeInteger($HTTP_POST_VARS["category"]) . ",\n";
}
if (!empty($HTTP_POST_VARS["release"])) {
$stmt .= Misc::escapeInteger($HTTP_POST_VARS["release"]) . ",\n";
}
if (!empty($HTTP_POST_VARS["priority"])) {
$stmt .= Misc::escapeInteger($HTTP_POST_VARS["priority"]) . ",";
}
// if we are creating an issue for a customer, put the
// main customer contact as the reporter for it
if (Customer::hasCustomerIntegration($prj_id)) {
$contact_usr_id = User::getUserIDByContactID($HTTP_POST_VARS['contact']);
if (empty($contact_usr_id)) {
$contact_usr_id = $usr_id;
}
$stmt .= Misc::escapeInteger($contact_usr_id) . ",";
} else {
$stmt .= $usr_id . ",";
}
if (!empty($initial_status)) {
$stmt .= Misc::escapeInteger($initial_status) . ",";
}
if (Customer::hasCustomerIntegration($prj_id)) {
$stmt .= "\n " . Misc::escapeInteger($HTTP_POST_VARS['customer']) . ",\n " . Misc::escapeInteger($HTTP_POST_VARS['contact']) . ",\n '" . Misc::escapeString($HTTP_POST_VARS["contact_person_lname"]) . "',\n '" . Misc::escapeString($HTTP_POST_VARS["contact_person_fname"]) . "',\n '" . Misc::escapeString($HTTP_POST_VARS["contact_email"]) . "',\n '" . Misc::escapeString($HTTP_POST_VARS["contact_phone"]) . "',\n '" . Misc::escapeString($HTTP_POST_VARS["contact_timezone"]) . "',";
}
$stmt .= "\n '" . Date_API::getCurrentDateGMT() . "',\n '" . Date_API::getCurrentDateGMT() . "',\n 'created',\n '" . Misc::escapeString($HTTP_POST_VARS["summary"]) . "',\n '" . Misc::escapeString($HTTP_POST_VARS["description"]) . "',\n " . Misc::escapeString($HTTP_POST_VARS["estimated_dev_time"]) . ",\n " . Misc::escapeInteger($HTTP_POST_VARS["private"]) . " ,\n '" . Misc::escapeString(Mail_API::generateMessageID()) . "'\n )";
$res = $GLOBALS["db_api"]->dbh->query($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return -1;
} else {
$new_issue_id = $GLOBALS["db_api"]->get_last_insert_id();
$has_TAM = false;
$has_RR = false;
$info = User::getNameEmail($usr_id);
// log the creation of the issue
History::add($new_issue_id, Auth::getUserID(), History::getTypeID('issue_opened'), 'Issue opened by ' . User::getFullName(Auth::getUserID()));
$emails = array();
if (Customer::hasCustomerIntegration($prj_id)) {
if (@count($HTTP_POST_VARS['contact_extra_emails']) > 0) {
$emails = $HTTP_POST_VARS['contact_extra_emails'];
}
// add the primary contact to the notification list
if ($HTTP_POST_VARS['add_primary_contact'] == 'yes') {
$contact_email = User::getEmailByContactID($HTTP_POST_VARS['contact']);
if (!empty($contact_email)) {
$emails[] = $contact_email;
}
}
// if there are any technical account managers associated with this customer, add these users to the notification list
$managers = Customer::getAccountManagers($prj_id, $HTTP_POST_VARS['customer']);
$manager_usr_ids = array_keys($managers);
$manager_emails = array_values($managers);
$emails = array_merge($emails, $manager_emails);
}
// add the reporter to the notification list
$emails[] = $info['usr_email'];
$emails = array_unique($emails);
// COMPAT: version >= 4.0.1
$actions = Notification::getDefaultActions();
foreach ($emails as $address) {
Notification::subscribeEmail($usr_id, $new_issue_id, $address, $actions);
}
// only assign the issue to an user if the associated customer has any technical account managers
$users = array();
$has_TAM = false;
if (Customer::hasCustomerIntegration($prj_id) && count($manager_usr_ids) > 0) {
foreach ($manager_usr_ids as $manager_usr_id) {
$users[] = $manager_usr_id;
Issue::addUserAssociation($usr_id, $new_issue_id, $manager_usr_id, false);
History::add($new_issue_id, $usr_id, History::getTypeID('issue_auto_assigned'), 'Issue auto-assigned to ' . User::getFullName($manager_usr_id) . ' (TAM)');
}
$has_TAM = true;
}
// now add the user/issue association (aka assignments)
if (@count($HTTP_POST_VARS["users"]) > 0) {
for ($i = 0; $i < count($HTTP_POST_VARS["users"]); $i++) {
Notification::subscribeUser($usr_id, $new_issue_id, $HTTP_POST_VARS["users"][$i], $actions);
Issue::addUserAssociation($usr_id, $new_issue_id, $HTTP_POST_VARS["users"][$i]);
if ($HTTP_POST_VARS["users"][$i] != $usr_id) {
$users[] = $HTTP_POST_VARS["users"][$i];
}
}
} else {
// only use the round-robin feature if this new issue was not
// already assigned to a customer account manager
if (@count($manager_usr_ids) < 1) {
$assignee = Round_Robin::getNextAssignee($prj_id);
// assign the issue to the round robin person
if (!empty($assignee)) {
$users[] = $assignee;
Issue::addUserAssociation($usr_id, $new_issue_id, $assignee, false);
History::add($new_issue_id, APP_SYSTEM_USER_ID, History::getTypeID('rr_issue_assigned'), 'Issue auto-assigned to ' . User::getFullName($assignee) . ' (RR)');
$has_RR = true;
}
}
}
// now process any files being uploaded
$found = 0;
for ($i = 0; $i < count(@$HTTP_POST_FILES["file"]["name"]); $i++) {
if (!@empty($HTTP_POST_FILES["file"]["name"][$i])) {
$found = 1;
break;
}
}
if ($found) {
$files = array();
for ($i = 0; $i < count($HTTP_POST_FILES["file"]["name"]); $i++) {
$filename = @$HTTP_POST_FILES["file"]["name"][$i];
if (empty($filename)) {
continue;
}
$blob = Misc::getFileContents($HTTP_POST_FILES["file"]["tmp_name"][$i]);
if (empty($blob)) {
// error reading a file
$insert_errors["file[{$i}]"] = "There was an error uploading the file '{$filename}'.";
continue;
}
$files[] = array("filename" => $filename, "type" => $HTTP_POST_FILES['file']['type'][$i], "blob" => $blob);
}
if (count($files) > 0) {
$attachment_id = Attachment::add($new_issue_id, $usr_id, 'Files uploaded at issue creation time');
foreach ($files as $file) {
Attachment::addFile($attachment_id, $new_issue_id, $file["filename"], $file["type"], $file["blob"]);
}
}
}
// need to associate any emails ?
if (!empty($HTTP_POST_VARS["attached_emails"])) {
$items = explode(",", $HTTP_POST_VARS["attached_emails"]);
Support::associate($usr_id, $new_issue_id, $items, true);
}
// need to notify any emails being converted into issues ?
if (@count($HTTP_POST_VARS["notify_senders"]) > 0) {
$recipients = Notification::notifyEmailConvertedIntoIssue($prj_id, $new_issue_id, $HTTP_POST_VARS["notify_senders"], $customer_id);
} else {
$recipients = array();
}
// need to process any custom fields ?
if (@count($HTTP_POST_VARS["custom_fields"]) > 0) {
foreach ($HTTP_POST_VARS["custom_fields"] as $fld_id => $value) {
Custom_Field::associateIssue($new_issue_id, $fld_id, $value);
}
}
// also send a special confirmation email to the customer contact
if (@$HTTP_POST_VARS['notify_customer'] == 'yes' && !empty($HTTP_POST_VARS['contact'])) {
// also need to pass the list of sender emails already notified,
// so we can avoid notifying the same person again
$contact_email = User::getEmailByContactID($HTTP_POST_VARS['contact']);
if (@(!in_array($contact_email, $recipients))) {
Customer::notifyCustomerIssue($prj_id, $new_issue_id, $HTTP_POST_VARS['contact']);
}
}
Workflow::handleNewIssue($prj_id, $new_issue_id, $has_TAM, $has_RR);
// also notify any users that want to receive emails anytime a new issue is created
Notification::notifyNewIssue($prj_id, $new_issue_id);
return $new_issue_id;
}
}
/**
* Returns the number of emails sent by a user in a time range.
*
* @access public
* @param string $usr_id The ID of the user
* @param integer $start The timestamp of the start date
* @param integer $end The timestanp of the end date
* @param boolean $associated If this should return emails associated with issues or non associated emails.
* @return integer The number of emails sent by the user.
*/
function getSentEmailCountByUser($usr_id, $start, $end, $associated)
{
$usr_info = User::getNameEmail($usr_id);
$stmt = "SELECT\n COUNT(sup_id)\n FROM\n " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "support_email\n WHERE\n sup_date BETWEEN '" . Misc::escapeString($start) . "' AND '" . Misc::escapeString($end) . "' AND\n sup_from LIKE '%" . Misc::escapeString($usr_info["usr_email"]) . "%' AND\n sup_iss_id ";
if ($associated == true) {
$stmt .= "!= 0";
} else {
$stmt .= "= 0";
}
$res = $GLOBALS["db_api"]->dbh->getOne($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return "";
}
return $res;
}
/**
* Method used to get the details of a given email notification
* subscription.
*
* @param integer $sub_id The subscription ID
* @return array The details of the subscription
*/
public static function getDetails($sub_id)
{
$stmt = 'SELECT
*
FROM
{{%subscription}}
WHERE
sub_id=?';
try {
$res = DB_Helper::getInstance()->getRow($stmt, array($sub_id));
} catch (DbException $e) {
return '';
}
if ($res['sub_usr_id'] != 0) {
$user_info = User::getNameEmail($res['sub_usr_id']);
$res['sub_email'] = $user_info['usr_email'];
}
return array_merge($res, self::getSubscribedActions($sub_id));
}
/**
* Method used to get the appropriate 'From' header for a
* specified user.
*
* @access public
* @param integer $usr_id The user ID
* @return string The formatted 'From' header
*/
function getFromHeader($usr_id)
{
$info = User::getNameEmail($usr_id);
return $info["usr_full_name"] . " <" . $info["usr_email"] . ">";
}
/**
* Routes an email to the correct issue.
*
* @param string $full_message The full email message, including headers
* @return mixed true or array(ERROR_CODE, ERROR_STRING) in case of failure
*/
public static function route_emails($full_message)
{
// need some validation here
if (empty($full_message)) {
return array(self::EX_NOINPUT, ev_gettext('Error: The email message was empty') . ".\n");
}
// save the full message for logging purposes
Support::saveRoutedEmail($full_message);
// check if the email routing interface is even supposed to be enabled
$setup = Setup::get();
if ($setup['email_routing']['status'] != 'enabled') {
return array(self::EX_CONFIG, ev_gettext('Error: The email routing interface is disabled.') . "\n");
}
if (empty($setup['email_routing']['address_prefix'])) {
return array(self::EX_CONFIG, ev_gettext('Error: Please configure the email address prefix.') . "\n");
}
if (empty($setup['email_routing']['address_host'])) {
return array(self::EX_CONFIG, ev_gettext('Error: Please configure the email address domain.') . "\n");
}
// associate routed emails to the internal system account
$sys_account = User::getNameEmail(APP_SYSTEM_USER_ID);
if (empty($sys_account['usr_email'])) {
return array(self::EX_CONFIG, ev_gettext('Error: The associated user for the email routing interface needs to be set.') . "\n");
}
unset($sys_account);
// join the Content-Type line (for easier parsing?)
if (preg_match('/^boundary=/m', $full_message)) {
$pattern = "#(Content-Type: multipart/.+); ?\r?\n(boundary=.*)\$#im";
$replacement = '$1; $2';
$full_message = preg_replace($pattern, $replacement, $full_message);
}
// remove the reply-to: header
if (preg_match('/^reply-to:.*/im', $full_message)) {
$full_message = preg_replace("/^(reply-to:).*\n/im", '', $full_message, 1);
}
AuthCookie::setAuthCookie(APP_SYSTEM_USER_ID);
$structure = Mime_Helper::decode($full_message, true, true);
// find which issue ID this email refers to
if (isset($structure->headers['to'])) {
$issue_id = self::getMatchingIssueIDs($structure->headers['to'], 'email');
}
// we need to try the Cc header as well
if (empty($issue_id) and isset($structure->headers['cc'])) {
$issue_id = self::getMatchingIssueIDs($structure->headers['cc'], 'email');
}
if (empty($issue_id)) {
return array(self::EX_DATAERR, ev_gettext('Error: The routed email had no associated Eventum issue ID or had an invalid recipient address.') . "\n");
}
$issue_prj_id = Issue::getProjectID($issue_id);
if (empty($issue_prj_id)) {
return array(self::EX_DATAERR, ev_gettext('Error: The routed email had no associated Eventum issue ID or had an invalid recipient address.') . "\n");
}
$email_account_id = Email_Account::getEmailAccount($issue_prj_id);
if (empty($email_account_id)) {
return array(self::EX_CONFIG, ev_gettext('Error: Please provide the email account ID.') . "\n");
}
$body = $structure->body;
// hack for clients that set more then one from header
if (is_array($structure->headers['from'])) {
$structure->headers['from'] = $structure->headers['from'][0];
}
// associate the email to the issue
$parts = array();
Mime_Helper::parse_output($structure, $parts);
// get the sender's email address
$sender_email = strtolower(Mail_Helper::getEmailAddress($structure->headers['from']));
// strip out the warning message sent to staff users
if ($setup['email_routing']['status'] == 'enabled' && $setup['email_routing']['warning']['status'] == 'enabled') {
$full_message = Mail_Helper::stripWarningMessage($full_message);
$body = Mail_Helper::stripWarningMessage($body);
}
$prj_id = Issue::getProjectID($issue_id);
AuthCookie::setAuthCookie(APP_SYSTEM_USER_ID);
AuthCookie::setProjectCookie($prj_id);
if (Mime_Helper::hasAttachments($structure)) {
$has_attachments = 1;
} else {
$has_attachments = 0;
}
// remove certain CC addresses
if (!empty($structure->headers['cc']) && $setup['smtp']['save_outgoing_email'] == 'yes') {
$ccs = explode(',', @$structure->headers['cc']);
foreach ($ccs as $i => $address) {
if (Mail_Helper::getEmailAddress($address) == $setup['smtp']['save_address']) {
unset($ccs[$i]);
}
}
$structure->headers['cc'] = implode(', ', $ccs);
}
// Remove excess Re's
$structure->headers['subject'] = Mail_Helper::removeExcessRe(@$structure->headers['subject'], true);
$t = array('issue_id' => $issue_id, 'ema_id' => $email_account_id, 'message_id' => @$structure->headers['message-id'], 'date' => Date_Helper::getCurrentDateGMT(), 'from' => @$structure->headers['from'], 'to' => @$structure->headers['to'], 'cc' => @$structure->headers['cc'], 'subject' => @$structure->headers['subject'], 'body' => @$body, 'full_email' => @$full_message, 'has_attachment' => $has_attachments, 'headers' => @$structure->headers);
// automatically associate this incoming email with a customer
if (CRM::hasCustomerIntegration($prj_id)) {
$crm = CRM::getInstance($prj_id);
if (!empty($structure->headers['from'])) {
try {
$contact = $crm->getContactByEmail($sender_email);
$issue_contract = $crm->getContract(Issue::getContractID($issue_id));
if ($contact->canAccessContract($issue_contract)) {
$t['customer_id'] = $issue_contract->getCustomerID();
}
} catch (CRMException $e) {
}
}
}
if (empty($t['customer_id'])) {
$t['customer_id'] = null;
}
if (Support::blockEmailIfNeeded($t)) {
return true;
}
// re-write Threading headers if needed
list($t['full_email'], $t['headers']) = Mail_Helper::rewriteThreadingHeaders($t['issue_id'], $t['full_email'], $t['headers'], 'email');
$res = Support::insertEmail($t, $structure, $sup_id);
if ($res != -1) {
Support::extractAttachments($issue_id, $structure);
// notifications about new emails are always external
$internal_only = false;
$assignee_only = false;
// special case when emails are bounced back, so we don't want a notification to customers about those
if (Notification::isBounceMessage($sender_email)) {
// broadcast this email only to the assignees for this issue
$internal_only = true;
$assignee_only = true;
}
Notification::notifyNewEmail(Auth::getUserID(), $issue_id, $t, $internal_only, $assignee_only, '', $sup_id);
// try to get usr_id of sender, if not, use system account
$usr_id = User::getUserIDByEmail(Mail_Helper::getEmailAddress($structure->headers['from']));
if (!$usr_id) {
$usr_id = APP_SYSTEM_USER_ID;
}
// mark this issue as updated
if (!empty($t['customer_id']) && $t['customer_id'] != null) {
Issue::markAsUpdated($issue_id, 'customer action');
} else {
if (!empty($usr_id) && $usr_id != APP_SYSTEM_USER_ID && User::getRoleByUser($usr_id, $prj_id) > User::ROLE_CUSTOMER) {
Issue::markAsUpdated($issue_id, 'staff response');
} else {
Issue::markAsUpdated($issue_id, 'user response');
}
}
// log routed email
History::add($issue_id, $usr_id, 'email_routed', 'Email routed from {from}', array('from' => $structure->headers['from']));
}
return true;
}
/**
* Method used to get the details of a given email notification
* subscription.
*
* @access public
* @param integer $sub_id The subcription ID
* @return array The details of the subscription
*/
function getDetails($sub_id)
{
$stmt = "SELECT\r\n *\r\n FROM\r\n " . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "subscription\r\n WHERE\r\n sub_id=" . Misc::escapeInteger($sub_id);
$res = $GLOBALS["db_api"]->dbh->getRow($stmt, DB_FETCHMODE_ASSOC);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return "";
} else {
if ($res["sub_usr_id"] != 0) {
$user_info = User::getNameEmail($res["sub_usr_id"]);
$res["sub_email"] = $user_info["usr_email"];
}
return array_merge($res, Notification::getSubscribedActions($sub_id));
}
}
/**
* Routes an email to the correct issue.
*
* @param string $full_message The full email message, including headers
* @param integer $email_account_id The ID of the email account this email should be routed too. If empty this method will try to figure it out
*/
function route_emails($full_message, $email_account_id = 0)
{
global $HTTP_POST_VARS;
// save the full message for logging purposes
Support::saveRoutedEmail($full_message);
if (preg_match("/^(boundary=).*/m", $full_message)) {
$pattern = "/(Content-Type: multipart\\/)(.+); ?\r?\n(boundary=)(.*)\$/im";
$replacement = '$1$2; $3$4';
$full_message = preg_replace($pattern, $replacement, $full_message);
}
// associate routed emails to the internal system account
$sys_account = User::getNameEmail(APP_SYSTEM_USER_ID);
$associated_user = $sys_account['usr_email'];
// need some validation here
if (empty($full_message)) {
return array(66, "Error: The email message was empty.\n");
}
if (empty($associated_user)) {
return array(78, "Error: The associated user for the email routing interface needs to be set.\n");
}
//
// DON'T EDIT ANYTHING BELOW THIS LINE
//
// remove the reply-to: header
if (preg_match("/^(reply-to:).*/im", $full_message)) {
$full_message = preg_replace("/^(reply-to:).*\n/im", '', $full_message, 1);
}
// check for magic cookie
if (Mail_API::hasMagicCookie($full_message)) {
// strip the magic cookie
$full_message = Mail_API::stripMagicCookie($full_message);
$has_magic_cookie = true;
} else {
$has_magic_cookie = false;
}
Auth::createFakeCookie(APP_SYSTEM_USER_ID);
// check if the email routing interface is even supposed to be enabled
$setup = Setup::load();
if ($setup['email_routing']['status'] != 'enabled') {
return array(78, "Error: The email routing interface is disabled.\n");
}
$prefix = $setup['email_routing']['address_prefix'];
// escape plus signs so '*****@*****.**' becomes a valid routing address
$prefix = str_replace('+', '\\+', $prefix);
$mail_domain = quotemeta($setup['email_routing']['address_host']);
$mail_domain_alias = quotemeta(@$setup['email_routing']['host_alias']);
if (!empty($mail_domain_alias)) {
$mail_domain = "(?:" . $mail_domain . "|" . $mail_domain_alias . ")";
}
if (empty($prefix)) {
return array(78, "Error: Please configure the email address prefix.\n");
}
if (empty($mail_domain)) {
return array(78, "Error: Please configure the email address domain.\n");
}
$structure = Mime_Helper::decode($full_message, true, true);
// find which issue ID this email refers to
@preg_match("/{$prefix}(\\d*)@{$mail_domain}/i", $structure->headers['to'], $matches);
@($issue_id = $matches[1]);
// validation is always a good idea
if (empty($issue_id)) {
// we need to try the Cc header as well
@preg_match("/{$prefix}(\\d*)@{$mail_domain}/i", $structure->headers['cc'], $matches);
if (!empty($matches[1])) {
$issue_id = $matches[1];
} else {
return array(65, "Error: The routed email had no associated Eventum issue ID or had an invalid recipient address.\n");
}
}
if (empty($email_account_id)) {
$issue_prj_id = Issue::getProjectID($issue_id);
if (empty($issue_prj_id)) {
return array(65, "Error: The routed email had no associated Eventum issue ID or had an invalid recipient address.\n");
}
$email_account_id = Email_Account::getEmailAccount($issue_prj_id);
}
if (empty($email_account_id)) {
return array(78, "Error: Please provide the email account ID.\n");
}
$body = Mime_Helper::getMessageBody($structure);
// hack for clients that set more then one from header
if (is_array($structure->headers['from'])) {
$structure->headers['from'] = $structure->headers['from'][0];
}
// associate the email to the issue
$parts = array();
Mime_Helper::parse_output($structure, $parts);
// get the sender's email address
$sender_email = strtolower(Mail_API::getEmailAddress($structure->headers['from']));
// strip out the warning message sent to staff users
if ($setup['email_routing']['status'] == 'enabled' && $setup['email_routing']['warning']['status'] == 'enabled') {
$full_message = Mail_API::stripWarningMessage($full_message);
$body = Mail_API::stripWarningMessage($body);
}
$prj_id = Issue::getProjectID($issue_id);
Auth::createFakeCookie(APP_SYSTEM_USER_ID, $prj_id);
$staff_emails = Project::getUserEmailAssocList($prj_id, 'active', User::getRoleID('Customer'));
$staff_emails = array_map('strtolower', $staff_emails);
// only allow staff users to use the magic cookie
if (!in_array($sender_email, array_values($staff_emails))) {
$has_magic_cookie = false;
}
if (Mime_Helper::hasAttachments($full_message)) {
$has_attachments = 1;
} else {
$has_attachments = 0;
}
// remove certain CC addresses
if (!empty($structure->headers['cc']) && @$setup['smtp']['save_outgoing_email'] == 'yes') {
$ccs = explode(",", @$structure->headers['cc']);
for ($i = 0; $i < count($ccs); $i++) {
if (Mail_API::getEmailAddress($ccs[$i]) == $setup['smtp']['save_address']) {
unset($ccs[$i]);
}
}
@($structure->headers['cc'] = join(', ', $ccs));
}
// Remove excess Re's
@($structure->headers['subject'] = Mail_API::removeExcessRe(@$structure->headers['subject'], true));
$t = array('issue_id' => $issue_id, 'ema_id' => $email_account_id, 'message_id' => @$structure->headers['message-id'], 'date' => Date_API::getCurrentDateGMT(), 'from' => @$structure->headers['from'], 'to' => @$structure->headers['to'], 'cc' => @$structure->headers['cc'], 'subject' => @$structure->headers['subject'], 'body' => @$body, 'full_email' => @$full_message, 'has_attachment' => $has_attachments, 'headers' => @$structure->headers);
// automatically associate this incoming email with a customer
if (Customer::hasCustomerIntegration($prj_id)) {
if (!empty($structure->headers['from'])) {
list($customer_id, ) = Customer::getCustomerIDByEmails($prj_id, array($sender_email));
if (!empty($customer_id)) {
$t['customer_id'] = $customer_id;
}
}
}
if (empty($t['customer_id'])) {
$t['customer_id'] = "NULL";
}
if (!$has_magic_cookie && Support::blockEmailIfNeeded($t)) {
return true;
}
// re-write Threading headers if needed
list($t['full_email'], $t['headers']) = Mail_API::rewriteThreadingHeaders($t['issue_id'], $t['full_email'], $t['headers'], "email");
$res = Support::insertEmail($t, $structure, $sup_id);
if ($res != -1) {
Support::extractAttachments($issue_id, $full_message);
// notifications about new emails are always external
$internal_only = false;
$assignee_only = false;
// special case when emails are bounced back, so we don't want a notification to customers about those
if (Notification::isBounceMessage($sender_email)) {
// broadcast this email only to the assignees for this issue
$internal_only = true;
$assignee_only = true;
}
Notification::notifyNewEmail(Auth::getUserID(), $issue_id, $t, $internal_only, $assignee_only, '', $sup_id);
// try to get usr_id of sender, if not, use system account
$usr_id = User::getUserIDByEmail(Mail_API::getEmailAddress($structure->headers['from']));
if (!$usr_id) {
$usr_id = APP_SYSTEM_USER_ID;
}
// mark this issue as updated
if (!empty($t['customer_id']) && $t['customer_id'] != 'NULL') {
Issue::markAsUpdated($issue_id, 'customer action');
} else {
if (!empty($usr_id) && User::getRoleByUser($usr_id, $prj_id) > User::getRoleID('Customer')) {
Issue::markAsUpdated($issue_id, 'staff response');
} else {
Issue::markAsUpdated($issue_id, 'user response');
}
}
// log routed email
History::add($issue_id, $usr_id, History::getTypeID('email_routed'), "Email routed from " . $structure->headers['from']);
}
return true;
}
