/**
* Fetch customer key by id
* @param string $key
* @return OAuthKey|false
*/
public static function fetchKey($key)
{
if (isset(self::$keys_cache[$key])) {
return self::$keys_cache[$key];
}
$k = new self();
if ($k->getByKey($key)) {
self::$keys_cache[$key] = $k;
BeanFactory::registerBean("OAuthKeys", $k);
return $k;
}
return false;
}
/**
* Fetch customer key by id
* @param string $key
* @param string $oauth_type Either "oauth1" or "oauth2", defaults to "oauth1"
* @return OAuthKey|false
*/
public static function fetchKey($key, $oauth_type = "oauth1")
{
if (isset(self::$keys_cache[$key]) && self::$keys_cache[$key]->oauth_type == $oauth_type) {
return self::$keys_cache[$key];
}
$k = new self();
if ($k->getByKey($key, $oauth_type)) {
self::$keys_cache[$key] = $k;
BeanFactory::registerBean($k);
return $k;
}
return false;
}
/**
* Implements a generic insert and update logic for any SugarBean
* This method only works for subclasses that implement the same variable names.
* This method uses the presence of an id field that is not null to signify and update.
* The id field should not be set otherwise.
*
* @param boolean $check_notify Optional, default false, if set to true assignee of the record is notified via email.
* @todo Add support for field type validation and encoding of parameters.
*/
function save($check_notify = FALSE)
{
$this->in_save = true;
// cn: SECURITY - strip XSS potential vectors
$this->cleanBean();
// This is used so custom/3rd-party code can be upgraded with fewer issues, this will be removed in a future release
$this->fixUpFormatting();
global $timedate;
global $current_user, $action;
$isUpdate = true;
if (empty($this->id)) {
$isUpdate = false;
}
if ($this->new_with_id == true) {
$isUpdate = false;
}
if (empty($this->date_modified) || $this->update_date_modified) {
$this->date_modified = $GLOBALS['timedate']->nowDb();
}
$this->_checkOptimisticLocking($action, $isUpdate);
if (!empty($this->modified_by_name)) {
$this->old_modified_by_name = $this->modified_by_name;
}
if ($this->update_modified_by) {
$this->modified_user_id = 1;
if (!empty($current_user)) {
$this->modified_user_id = $current_user->id;
$this->modified_by_name = $current_user->user_name;
}
}
if ($this->deleted != 1) {
$this->deleted = 0;
}
if (!$isUpdate) {
if (empty($this->date_entered)) {
$this->date_entered = $this->date_modified;
}
if ($this->set_created_by == true) {
// created by should always be this user
$this->created_by = isset($current_user) ? $current_user->id : "";
}
if ($this->new_with_id == false) {
$this->id = create_guid();
}
}
require_once "data/BeanFactory.php";
BeanFactory::registerBean($this->module_name, $this);
if (empty($GLOBALS['updating_relationships']) && empty($GLOBALS['saving_relationships']) && empty($GLOBALS['resavingRelatedBeans'])) {
$GLOBALS['saving_relationships'] = true;
// let subclasses save related field changes
$this->save_relationship_changes($isUpdate);
$GLOBALS['saving_relationships'] = false;
}
if ($isUpdate && !$this->update_date_entered) {
unset($this->date_entered);
}
// call the custom business logic
$custom_logic_arguments['check_notify'] = $check_notify;
$this->call_custom_logic("before_save", $custom_logic_arguments);
unset($custom_logic_arguments);
// If we're importing back semi-colon separated non-primary emails
if ($this->hasEmails() && !empty($this->email_addresses_non_primary) && is_array($this->email_addresses_non_primary)) {
// Add each mail to the account
foreach ($this->email_addresses_non_primary as $mail) {
$this->emailAddress->addAddress($mail);
}
$this->emailAddress->save($this->id, $this->module_dir);
}
if (isset($this->custom_fields)) {
$this->custom_fields->bean = $this;
$this->custom_fields->save($isUpdate);
}
// use the db independent query generator
$this->preprocess_fields_on_save();
//construct the SQL to create the audit record if auditing is enabled.
$auditDataChanges = array();
if ($this->is_AuditEnabled()) {
if ($isUpdate && !isset($this->fetched_row)) {
$GLOBALS['log']->debug('Auditing: Retrieve was not called, audit record will not be created.');
} else {
$auditDataChanges = $this->db->getAuditDataChanges($this);
}
}
$this->_sendNotifications($check_notify);
if ($isUpdate) {
$this->db->update($this);
} else {
$this->db->insert($this);
}
if (!empty($auditDataChanges) && is_array($auditDataChanges)) {
foreach ($auditDataChanges as $change) {
$this->db->save_audit_records($this, $change);
}
}
if (empty($GLOBALS['resavingRelatedBeans'])) {
SugarRelationship::resaveRelatedBeans();
}
// populate fetched row with current bean values
foreach ($auditDataChanges as $change) {
$this->fetched_row[$change['field_name']] = $change['after'];
}
//If we aren't in setup mode and we have a current user and module, then we track
if (isset($GLOBALS['current_user']) && isset($this->module_dir)) {
$this->track_view($current_user->id, $this->module_dir, 'save');
}
$this->call_custom_logic('after_save', '');
//Now that the record has been saved, we don't want to insert again on further saves
$this->new_with_id = false;
$this->in_save = false;
return $this->id;
}
/**
* Implements a generic insert and update logic for any SugarBean
* This method only works for subclasses that implement the same variable names.
* This method uses the presence of an id field that is not null to signify and update.
* The id field should not be set otherwise.
*
* @param boolean $check_notify Optional, default false, if set to true assignee of the record is notified via email.
* @todo Add support for field type validation and encoding of parameters.
*/
function save($check_notify = false)
{
$this->in_save = true;
// cn: SECURITY - strip XSS potential vectors
$this->cleanBean();
// This is used so custom/3rd-party code can be upgraded with fewer issues, this will be removed in a future release
$this->fixUpFormatting();
global $timedate;
global $current_user, $action;
$isUpdate = true;
if (empty($this->id) || !empty($this->new_with_id)) {
$isUpdate = false;
}
if (empty($this->date_modified) || $this->update_date_modified) {
$this->date_modified = $GLOBALS['timedate']->nowDb();
}
$this->_checkOptimisticLocking($action, $isUpdate);
if (!empty($this->modified_by_name)) {
$this->old_modified_by_name = $this->modified_by_name;
}
if ($this->update_modified_by) {
$this->modified_user_id = 1;
if (!empty($current_user)) {
$this->modified_user_id = $current_user->id;
$this->modified_by_name = $current_user->user_name;
}
}
if ($this->deleted != 1) {
$this->deleted = 0;
}
if (!$isUpdate) {
if (empty($this->date_entered)) {
$this->date_entered = $this->date_modified;
}
if ($this->set_created_by == true) {
// created by should always be this user
$this->created_by = isset($current_user) ? $current_user->id : "";
}
if ($this->new_with_id == false) {
$this->id = create_guid();
}
}
// if the module has a team_id field and no team_id is specified, set team_id as the current_user's default team
// currently, the default_team is only enforced in the presentation layer-- this enforces it at the data layer as well
$usedDefaultTeam = false;
if (empty($this->team_id) && isset($this->field_defs['team_id']) && isset($current_user)) {
$this->team_id = $current_user->team_id;
$usedDefaultTeam = true;
}
// if this bean has a currency_id and base_rate, verify that base_rate is set to the correct amount
if (isset($this->field_defs['currency_id']) && isset($this->field_defs['base_rate'])) {
SugarCurrency::verifyCurrencyBaseRateSet($this, $isUpdate);
}
require_once "data/BeanFactory.php";
BeanFactory::registerBean($this);
if (!static::inOperation('saving_related') && static::enterOperation('updating_relationships')) {
// let subclasses save related field changes
$this->save_relationship_changes($isUpdate);
static::leaveOperation('updating_relationships');
}
$this->updateCalculatedFields();
if ($isUpdate && !$this->update_date_entered) {
unset($this->date_entered);
}
// call the custom business logic
$custom_logic_arguments = array('check_notify' => $check_notify, 'isUpdate' => $isUpdate);
$this->call_custom_logic("before_save", $custom_logic_arguments);
unset($custom_logic_arguments);
if (isset($this->custom_fields)) {
$this->custom_fields->bean = $this;
$this->custom_fields->save($isUpdate);
}
//rrs new functionality to check if the team_id is set and the team_set_id is not set,
//then see what we can do about saving to team_set_id. It is important for this code block to be below
//the 'before_save' custom logic hook as that is where workflow is called.
if (isset($this->field_defs['team_id'])) {
if (empty($this->teams)) {
$this->load_relationship('teams');
}
if (!empty($this->teams)) {
//we do not need to the TeamSetLink to update the bean's table here
//since it will be handled below.
$this->teams->save(false, $usedDefaultTeam);
}
}
// use the db independent query generator
$this->preprocess_fields_on_save();
$dataChanges = $this->db->getDataChanges($this);
//construct the SQL to create the audit record if auditing is enabled.
$auditDataChanges = array();
if ($this->is_AuditEnabled()) {
if ($isUpdate && !isset($this->fetched_row)) {
$GLOBALS['log']->debug('Auditing: Retrieve was not called, audit record will not be created.');
} else {
$auditFields = $this->getAuditEnabledFieldDefinitions();
$auditDataChanges = array_intersect_key($dataChanges, $auditFields);
}
}
$this->_sendNotifications($check_notify);
if ($isUpdate) {
$this->db->update($this);
} elseif ($this->db->insert($this)) {
//Now that the record has been saved, we don't want to insert again on further saves
$this->new_with_id = false;
}
if (!empty($auditDataChanges) && is_array($auditDataChanges)) {
foreach ($auditDataChanges as $change) {
$this->db->save_audit_records($this, $change);
}
}
$this->updateRelatedCalcFields();
// populate fetched row with newest changes in the bean
foreach ($dataChanges as $change) {
$this->fetched_row[$change['field_name']] = $change['after'];
}
// the reason we need to skip this is so that any RelatedBeans that are targeted to be saved
// after the delete happens, wait to be saved till them.
if (!static::inOperation('delete')) {
SugarRelationship::resaveRelatedBeans();
}
//rrs - bug 7908
$this->process_workflow_alerts();
//rrs
//If we aren't in setup mode and we have a current user and module, then we track
if (isset($GLOBALS['current_user']) && isset($this->module_dir)) {
$this->track_view($current_user->id, $this->module_dir, 'save');
}
$this->call_custom_logic('after_save', array('isUpdate' => $isUpdate, 'dataChanges' => $dataChanges));
$this->in_save = false;
return $this->id;
}
/**
* Implements a generic insert and update logic for any SugarBean
* This method only works for subclasses that implement the same variable names.
* This method uses the presence of an id field that is not null to signify and update.
* The id field should not be set otherwise.
*
* @param boolean $check_notify Optional, default false, if set to true assignee of the record is notified via email.
* @todo Add support for field type validation and encoding of parameters.
*/
function save($check_notify = FALSE)
{
$this->in_save = true;
// cn: SECURITY - strip XSS potential vectors
$this->cleanBean();
// This is used so custom/3rd-party code can be upgraded with fewer issues, this will be removed in a future release
$this->fixUpFormatting();
global $timedate;
global $current_user, $action;
$isUpdate = true;
if (empty($this->id)) {
$isUpdate = false;
}
if ($this->new_with_id == true) {
$isUpdate = false;
}
if (empty($this->date_modified) || $this->update_date_modified) {
$this->date_modified = $GLOBALS['timedate']->nowDb();
}
$this->_checkOptimisticLocking($action, $isUpdate);
if (!empty($this->modified_by_name)) {
$this->old_modified_by_name = $this->modified_by_name;
}
if ($this->update_modified_by) {
$this->modified_user_id = 1;
if (!empty($current_user)) {
$this->modified_user_id = $current_user->id;
$this->modified_by_name = $current_user->user_name;
}
}
if ($this->deleted != 1) {
$this->deleted = 0;
}
if ($isUpdate) {
$query = "Update ";
} else {
if (empty($this->date_entered)) {
$this->date_entered = $this->date_modified;
}
if ($this->set_created_by == true) {
// created by should always be this user
$this->created_by = isset($current_user) ? $current_user->id : "";
}
if ($this->new_with_id == false) {
$this->id = create_guid();
}
$query = "INSERT into ";
}
require_once "data/BeanFactory.php";
BeanFactory::registerBean($this->module_name, $this);
if (empty($GLOBALS['updating_relationships']) && empty($GLOBALS['saving_relationships']) && empty($GLOBALS['resavingRelatedBeans'])) {
$GLOBALS['saving_relationships'] = true;
// let subclasses save related field changes
$this->save_relationship_changes($isUpdate);
$GLOBALS['saving_relationships'] = false;
}
if ($isUpdate && !$this->update_date_entered) {
unset($this->date_entered);
}
// call the custom business logic
$custom_logic_arguments['check_notify'] = $check_notify;
$this->call_custom_logic("before_save", $custom_logic_arguments);
unset($custom_logic_arguments);
if (isset($this->custom_fields)) {
$this->custom_fields->bean = $this;
$this->custom_fields->save($isUpdate);
}
// use the db independent query generator
$this->preprocess_fields_on_save();
//construct the SQL to create the audit record if auditing is enabled.
$dataChanges = array();
if ($this->is_AuditEnabled()) {
if ($isUpdate && !isset($this->fetched_row)) {
$GLOBALS['log']->debug('Auditing: Retrieve was not called, audit record will not be created.');
} else {
$dataChanges = $this->dbManager->helper->getDataChanges($this);
}
}
$this->_sendNotifications($check_notify);
if ($this->db->dbType == "oci8") {
}
if ($this->db->dbType == 'mysql') {
// write out the SQL statement.
$query .= $this->table_name . " set ";
$firstPass = 0;
foreach ($this->field_defs as $field => $value) {
if (!isset($value['source']) || $value['source'] == 'db') {
// Do not write out the id field on the update statement.
// We are not allowed to change ids.
if ($isUpdate && 'id' == $field) {
continue;
}
//custom fields handle there save seperatley
if (isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_type'])) {
continue;
}
// Only assign variables that have been set.
if (isset($this->{$field})) {
//bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
//set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
if (!empty($value['type']) && $value['type'] == 'bool') {
$this->{$field} = $this->getFieldValue($field);
}
if (strlen($this->{$field}) <= 0) {
if (!$isUpdate && isset($value['default']) && strlen($value['default']) > 0) {
$this->{$field} = $value['default'];
} else {
$this->{$field} = null;
}
}
// Try comparing this element with the head element.
if (0 == $firstPass) {
$firstPass = 1;
} else {
$query .= ", ";
}
if (is_null($this->{$field})) {
$query .= $field . "=null";
} else {
//added check for ints because sql-server does not like casting varchar with a decimal value
//into an int.
if (isset($value['type']) and $value['type'] == 'int') {
$query .= $field . "=" . $this->db->quote($this->{$field});
} elseif (isset($value['len'])) {
$query .= $field . "='" . $this->db->quote($this->db->truncate(from_html($this->{$field}), $value['len'])) . "'";
} else {
$query .= $field . "='" . $this->db->quote($this->{$field}) . "'";
}
}
}
}
}
if ($isUpdate) {
$query = $query . " WHERE ID = '{$this->id}'";
$GLOBALS['log']->info("Update {$this->object_name}: " . $query);
} else {
$GLOBALS['log']->info("Insert: " . $query);
}
$GLOBALS['log']->info("Save: {$query}");
$this->db->query($query, true);
}
//process if type is set to mssql
if ($this->db->dbType == 'mssql') {
if ($isUpdate) {
// build out the SQL UPDATE statement.
$query = "UPDATE " . $this->table_name . " SET ";
$firstPass = 0;
foreach ($this->field_defs as $field => $value) {
if (!isset($value['source']) || $value['source'] == 'db') {
// Do not write out the id field on the update statement.
// We are not allowed to change ids.
if ($isUpdate && 'id' == $field) {
continue;
}
// If the field is an auto_increment field, then we shouldn't be setting it. This was added
// specially for Bugs and Cases which have a number associated with them.
if ($isUpdate && isset($this->field_name_map[$field]['auto_increment']) && $this->field_name_map[$field]['auto_increment'] == true) {
continue;
}
//custom fields handle their save seperatley
if (isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_type'])) {
continue;
}
// Only assign variables that have been set.
if (isset($this->{$field})) {
//bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
//set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
if (!empty($value['type']) && $value['type'] == 'bool') {
$this->{$field} = $this->getFieldValue($field);
}
if (strlen($this->{$field}) <= 0) {
if (!$isUpdate && isset($value['default']) && strlen($value['default']) > 0) {
$this->{$field} = $value['default'];
} else {
$this->{$field} = null;
}
}
// Try comparing this element with the head element.
if (0 == $firstPass) {
$firstPass = 1;
} else {
$query .= ", ";
}
if (is_null($this->{$field})) {
$query .= $field . "=null";
} elseif (isset($value['len'])) {
$query .= $field . "='" . $this->db->quote($this->db->truncate(from_html($this->{$field}), $value['len'])) . "'";
} else {
$query .= $field . "='" . $this->db->quote($this->{$field}) . "'";
}
}
}
}
$query = $query . " WHERE ID = '{$this->id}'";
$GLOBALS['log']->info("Update {$this->object_name}: " . $query);
} else {
$colums = array();
$values = array();
foreach ($this->field_defs as $field => $value) {
if (!isset($value['source']) || $value['source'] == 'db') {
// Do not write out the id field on the update statement.
// We are not allowed to change ids.
//if($isUpdate && ('id' == $field)) continue;
//custom fields handle there save seperatley
if (isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_module'])) {
continue;
}
// Only assign variables that have been set.
if (isset($this->{$field})) {
//trim the value in case empty space is passed in.
//this will allow default values set in db to take effect, otherwise
//will insert blanks into db
$trimmed_field = trim($this->{$field});
//if this value is empty, do not include the field value in statement
if ($trimmed_field == '') {
continue;
}
//bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
//set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
if (!empty($value['type']) && $value['type'] == 'bool') {
$this->{$field} = $this->getFieldValue($field);
}
//added check for ints because sql-server does not like casting varchar with a decimal value
//into an int.
if (isset($value['type']) and $value['type'] == 'int') {
$values[] = $this->db->quote($this->{$field});
} elseif (isset($value['len'])) {
$values[] = "'" . $this->db->quote($this->db->truncate(from_html($this->{$field}), $value['len'])) . "'";
} else {
$values[] = "'" . $this->db->quote($this->{$field}) . "'";
}
$columns[] = $field;
}
}
}
// build out the SQL INSERT statement.
$query = "INSERT INTO {$this->table_name} (" . implode(",", $columns) . " ) VALUES ( " . implode(",", $values) . ')';
$GLOBALS['log']->info("Insert: " . $query);
}
$GLOBALS['log']->info("Save: {$query}");
$this->db->query($query, true);
}
if (!empty($dataChanges) && is_array($dataChanges)) {
foreach ($dataChanges as $change) {
$this->dbManager->helper->save_audit_records($this, $change);
}
}
//If we aren't in setup mode and we have a current user and module, then we track
if (isset($GLOBALS['current_user']) && isset($this->module_dir)) {
$this->track_view($current_user->id, $this->module_dir, 'save');
}
$this->call_custom_logic('after_save', '');
//Now that the record has been saved, we don't want to insert again on further saves
$this->new_with_id = false;
$this->in_save = false;
return $this->id;
}
function deleteRelatedLink($api, $args)
{
$primaryBean = $this->loadBean($api, $args);
list($linkName, $relatedBean) = $this->checkRelatedSecurity($api, $args, $primaryBean, 'view', 'view');
$relatedBean->retrieve($args['remote_id']);
if (empty($relatedBean->id)) {
// Retrieve failed, probably doesn't have permissions
throw new SugarApiExceptionNotFound('Could not find the related bean');
}
BeanFactory::registerBean($relatedBean);
$primaryBean->{$linkName}->delete($primaryBean->id, $relatedBean);
//Clean up any hanging related records.
SugarRelationship::resaveRelatedBeans();
// Get fresh copies of primary and related beans so that the newly deleted relationship
// shows as deleted. See BR-1055, BR-1630
$primaryBean = BeanFactory::getBean($primaryBean->module_name, $primaryBean->id, array('use_cache' => false));
$relatedBean = BeanFactory::getBean($relatedBean->module_name, $relatedBean->id, array('use_cache' => false));
//Because the relationship is now deleted, we need to pass the $relatedBean data into formatNearAndFarRecords
return $this->formatNearAndFarRecords($api, $args, $primaryBean, $this->formatBean($api, $args, $relatedBean));
}
