123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398 |
- <?php
- /**
- * @file
- * Contains rules integration for the data module needed during evaluation.
- *
- * @addtogroup rules
- * @{
- */
- /**
- * Action: Modify data.
- */
- function rules_action_data_set($wrapper, $value, $settings, $state, $element) {
- if ($wrapper instanceof EntityMetadataWrapper) {
- try {
- // Update the value first then save changes, if possible.
- $wrapper->set($value);
- }
- catch (EntityMetadataWrapperException $e) {
- throw new RulesEvaluationException('Unable to modify data "@selector": ' . $e->getMessage(), array('@selector' => $settings['data:select']));
- }
- // Save changes if a property of a variable has been changed.
- if (strpos($element->settings['data:select'], ':') !== FALSE) {
- $info = $wrapper->info();
- // We always have to save the changes in the parent entity. E.g. when the
- // node author is changed, we don't want to save the author but the node.
- $state->saveChanges(implode(':', explode(':', $settings['data:select'], -1)), $info['parent']);
- }
- }
- else {
- // A not wrapped variable (e.g. a number) is being updated. Just overwrite
- // the variable with the new value.
- return array('data' => $value);
- }
- }
- /**
- * Info alter callback for the data_set action.
- */
- function rules_action_data_set_info_alter(&$element_info, $element) {
- $element->settings += array('data:select' => NULL);
- if ($wrapper = $element->applyDataSelector($element->settings['data:select'])) {
- $info = $wrapper->info();
- $element_info['parameter']['value']['type'] = $wrapper->type();
- $element_info['parameter']['value']['options list'] = !empty($info['options list']) ? 'rules_data_selector_options_list' : FALSE;
- }
- }
- /**
- * Action: Calculate a value.
- */
- function rules_action_data_calc($input1, $op, $input2, $settings, $state, $element) {
- $info = $element->pluginParameterInfo();
- // Make sure to apply date offsets intelligently.
- if ($info['input_1']['type'] == 'date' && $info['input_2']['type'] == 'duration') {
- $input2 = ($op == '-') ? $input2 * -1 : $input2;
- return array('result' => (int) RulesDateOffsetProcessor::applyOffset($input1, $input2));
- }
- switch ($op) {
- case '+':
- $result = $input1 + $input2;
- break;
- case '-':
- $result = $input1 - $input2;
- break;
- case '*':
- $result = $input1 * $input2;
- break;
- case '/':
- $result = $input1 / $input2;
- break;
- }
- if (isset($result)) {
- // Ensure results are valid integer values if necessary.
- $variables = $element->providesVariables();
- $var_info = reset($variables);
- if ($var_info['type'] == 'integer') {
- $result = (int) $result;
- }
- return array('result' => $result);
- }
- }
- /**
- * Info alter callback for the data_calc action.
- */
- function rules_action_data_calc_info_alter(&$element_info, RulesPlugin $element) {
- if ($info = $element->getArgumentInfo('input_1')) {
- // Only allow durations as offset for date values.
- if ($info['type'] == 'date') {
- $element_info['parameter']['input_2']['type'] = 'duration';
- }
- // Specify the data type of the result.
- $element_info['provides']['result']['type'] = $info['type'];
- if ($info['type'] == 'integer' && ($info2 = $element->getArgumentInfo('input_2')) && $info2['type'] == 'decimal') {
- $element_info['provides']['result']['type'] = 'decimal';
- }
- // A division with two integers results in a decimal.
- elseif (isset($element->settings['op']) && $element->settings['op'] == '/') {
- $element_info['provides']['result']['type'] = 'decimal';
- }
- }
- }
- /**
- * Action: Add a list item.
- */
- function rules_action_data_list_add($list, $item, $unique = FALSE, $pos = 'end', $settings, $state) {
- // Optionally, only add the list item if it is not yet contained.
- if ($unique && rules_condition_data_list_contains($list, $item, $settings, $state)) {
- return;
- }
- switch ($pos) {
- case 'start':
- array_unshift($list, $item);
- break;
- default:
- $list[] = $item;
- break;
- }
- return array('list' => $list);
- }
- /**
- * Info alteration callback for the "Add and Remove a list item" actions.
- */
- function rules_data_list_info_alter(&$element_info, RulesAbstractPlugin $element) {
- // Update the required type for the list item if it is known.
- $element->settings += array('list:select' => NULL);
- if ($wrapper = $element->applyDataSelector($element->settings['list:select'])) {
- if ($type = entity_property_list_extract_type($wrapper->type())) {
- $info = $wrapper->info();
- $element_info['parameter']['item']['type'] = $type;
- $element_info['parameter']['item']['options list'] = !empty($info['options list']) ? 'rules_data_selector_options_list' : FALSE;
- }
- }
- }
- /**
- * Action: Remove a list item.
- */
- function rules_action_data_list_remove($list, $item) {
- foreach (array_keys($list, $item) as $key) {
- unset($list[$key]);
- }
- return array('list' => $list);
- }
- /**
- * Action: Add variable.
- */
- function rules_action_variable_add($args, $element) {
- return array('variable_added' => $args['value']);
- }
- /**
- * Info alteration callback for variable add action.
- */
- function rules_action_variable_add_info_alter(&$element_info, RulesAbstractPlugin $element) {
- if (isset($element->settings['type']) && $type = $element->settings['type']) {
- $cache = rules_get_cache();
- $type_info = $cache['data_info'][$type];
- $element_info['parameter']['value']['type'] = $type;
- $element_info['provides']['variable_added']['type'] = $type;
- // For lists, we default to an empty list so subsequent actions can add
- // items.
- if (entity_property_list_extract_type($type)) {
- $element_info['parameter']['value']['default value'] = array();
- }
- }
- }
- /**
- * Action: Convert a value.
- */
- function rules_action_data_convert($arguments, RulesPlugin $element, $state) {
- $value_info = $element->getArgumentInfo('value');
- $from_type = $value_info['type'];
- $target_type = $arguments['type'];
- // First apply the rounding behavior if given.
- if (isset($arguments['rounding_behavior'])) {
- switch ($arguments['rounding_behavior']) {
- case 'up':
- $arguments['value'] = ceil($arguments['value']);
- break;
- case 'down':
- $arguments['value'] = floor($arguments['value']);
- break;
- default:
- case 'round':
- $arguments['value'] = round($arguments['value']);
- break;
- }
- }
- switch ($target_type) {
- case 'decimal':
- $result = floatval($arguments['value']);
- break;
- case 'integer':
- $result = intval($arguments['value']);
- break;
- case 'text':
- $result = strval($arguments['value']);
- break;
- }
- return array('conversion_result' => $result);
- }
- /**
- * Info alteration callback for variable add action.
- */
- function rules_action_data_convert_info_alter(&$element_info, RulesAbstractPlugin $element) {
- if (isset($element->settings['type']) && $type = $element->settings['type']) {
- $element_info['provides']['conversion_result']['type'] = $type;
- if ($type != 'integer') {
- // Only support the rounding behavior option for integers.
- unset($element_info['parameter']['rounding_behavior']);
- }
- // Configure compatible source-types:
- switch ($type) {
- case 'integer':
- $sources = array('decimal', 'text', 'token', 'uri', 'date', 'duration', 'boolean');
- break;
- case 'decimal':
- $sources = array('integer', 'text', 'token', 'uri', 'date', 'duration', 'boolean');
- break;
- case 'text':
- $sources = array('integer', 'decimal', 'token', 'uri', 'date', 'duration', 'boolean');
- break;
- }
- $element_info['parameter']['value']['type'] = $sources;
- }
- }
- /**
- * Action: Create data.
- */
- function rules_action_data_create($args, $element) {
- $type = $args['type'];
- $values = array();
- foreach ($element->pluginParameterInfo() as $name => $info) {
- if ($name != 'type') {
- // Remove the parameter name prefix 'param_'.
- $values[substr($name, 6)] = $args[$name];
- }
- }
- $cache = rules_get_cache();
- $type_info = $cache['data_info'][$type];
- if (isset($type_info['creation callback'])) {
- try {
- $data = $type_info['creation callback']($values, $type);
- return array('data_created' => $data);
- }
- catch (EntityMetadataWrapperException $e) {
- throw new RulesEvaluationException('Unable to create @data": ' . $e->getMessage(), array('@data' => $type), $element);
- }
- }
- else {
- throw new RulesEvaluationException('Unable to create @data, no creation callback found.', array('@data' => $type), $element, RulesLog::ERROR);
- }
- }
- /**
- * Info alteration callback for data create action.
- */
- function rules_action_data_create_info_alter(&$element_info, RulesAbstractPlugin $element) {
- if (!empty($element->settings['type'])) {
- $type = $element->settings['type'];
- $cache = rules_get_cache();
- $type_info = $cache['data_info'][$type];
- if (isset($type_info['property info'])) {
- // Add the data type's properties as parameters.
- foreach ($type_info['property info'] as $property => $property_info) {
- // Prefix parameter names to avoid name clashes with existing parameters.
- $element_info['parameter']['param_' . $property] = array_intersect_key($property_info, array_flip(array('type', 'label')));
- if (empty($property_info['required'])) {
- $element_info['parameter']['param_' . $property]['optional'] = TRUE;
- }
- }
- }
- $element_info['provides']['data_created']['type'] = $type;
- }
- }
- /**
- * Creation callback for array structured data.
- */
- function rules_action_data_create_array($values = array(), $type) {
- // $values is an array already, so we can just pass it to the wrapper.
- return rules_wrap_data($values, array('type' => $type));
- }
- /**
- * Condition: Compare data.
- */
- function rules_condition_data_is($data, $op, $value) {
- switch ($op) {
- default:
- case '==':
- // In case both values evaluate to FALSE, further differentiate between
- // NULL values and values evaluating to FALSE.
- if (!$data && !$value) {
- return (isset($data) && isset($value)) || (!isset($data) && !isset($value));
- }
- return $data == $value;
- case '<':
- return $data < $value;
- case '>':
- return $data > $value;
- // Note: This is deprecated by the text comparison condition and IN below.
- case 'contains':
- return is_string($data) && strpos($data, $value) !== FALSE || is_array($data) && in_array($value, $data);
- case 'IN':
- return is_array($value) && in_array($data, $value);
- }
- }
- /**
- * Info alteration callback for the data_is condition.
- *
- * If we check the bundle property of a variable, add an assertion so that later
- * evaluated elements can make use of this information.
- */
- function rules_condition_data_is_info_alter(&$element_info, RulesAbstractPlugin $element) {
- $element->settings += array('data:select' => NULL, 'op' => '==');
- if ($wrapper = $element->applyDataSelector($element->settings['data:select'])) {
- $info = $wrapper->info();
- $element_info['parameter']['value']['type'] = $element->settings['op'] == 'IN' ? 'list<' . $wrapper->type() . '>' : $wrapper->type();
- $element_info['parameter']['value']['options list'] = !empty($info['options list']) ? 'rules_data_selector_options_list' : FALSE;
- }
- }
- /**
- * Condition: List contains.
- */
- function rules_condition_data_list_contains($list, $item, $settings, $state) {
- $wrapper = $state->currentArguments['item'];
- if ($wrapper instanceof EntityStructureWrapper && $id = $wrapper->getIdentifier()) {
- // Check for equal items using the identifier if there is one.
- foreach ($state->currentArguments['list'] as $i) {
- if ($i->getIdentifier() == $id) {
- return TRUE;
- }
- }
- return FALSE;
- }
- return in_array($item, $list);
- }
- /**
- * Condition: Data value is empty.
- */
- function rules_condition_data_is_empty($data) {
- // Note that some primitive variables might not be wrapped at all.
- if ($data instanceof EntityMetadataWrapper) {
- try {
- // We cannot use the dataAvailable() method from the wrapper because it
- // is protected, so we catch possible exceptions with the value() method.
- $value = $data->value();
- return empty($value);
- }
- catch (EntityMetadataWrapperException $e) {
- // An exception means that the wrapper is somehow broken and we treat
- // that as empty.
- return TRUE;
- }
- }
- return empty($data);
- }
- /**
- * Condition: Textual comparison.
- */
- function rules_data_text_comparison($text, $text2, $op = 'contains') {
- switch ($op) {
- case 'contains':
- return strpos($text, $text2) !== FALSE;
- case 'starts':
- return strpos($text, $text2) === 0;
- case 'ends':
- return strrpos($text, $text2) === (strlen($text) - strlen($text2));
- case 'regex':
- return (bool) preg_match('/'. str_replace('/', '\\/', $text2) .'/', $text);
- }
- }
|