diff --git a/README.txt b/README.txt index dcc0e7a..fc92f35 100644 --- a/README.txt +++ b/README.txt @@ -1,12 +1,12 @@ = Resource Conflict = This module allows for users to detect overlapping dates and respond with Rules. -This is most often used for tracking bookable resources. For example, a student -can book a microscope for use within their lab, but only one microscope can be -booked at a time. +This is most often used for tracking bookable resources. For example, a student +can book a microscope for use within their lab, but only one microscope can be +booked at a time. By default, this module throws a form error for every overlapping date it finds -among conflict-enabled nodes. It is intended to be customized using Rules, for +among conflict-enabled nodes. It is intended to be customized using Rules, for example to only throw errors when certain field values are identical. == Requirements == @@ -19,15 +19,15 @@ Date: http://drupal.org/project/date Download the module to your modules directory, and enable it from admin/modules. -You may wish to disable or modify the built in example Rule, which shows a form error -message for conflicts as they are detected. +You may wish to disable or modify the built in example Rule, which shows a form +error message for conflicts as they are detected. == Usage == 1) Create a content type with a date field. -2) On the Content Type Edit page, enable Conflict Checking for this Content Type. - Select the date field which should be used for conflict checking, and save - the form. +2) On the Content Type Edit page, enable Conflict Checking for this Content + Type. Select the date field which should be used for conflict checking, and + save the form. 3) Create two nodes with overlapping dates to see the default Rule in action. Or create your own Rule. @@ -39,21 +39,22 @@ specific resource here: https://drupal.org/node/2090487 EVENT: A RESOURCE CONFLICT WAS DETECTED -This event is triggered any time a resource conflict is detected. By itself, this event -will never fire. +This event is triggered any time a resource conflict is detected. By itself, +this event will never fire. EVENT: A RESOURCE CONFLICT NODE FORM IS VALIDATED -This rule fires during node form validation on Resource Conflict enabled content types. -You should use this event if you want to set form errors, or if you want to interact with -Rules_forms module. It provides both a node object of the node being created/edited and a -form object for use with rules_forms. This is the event trigger for the default Rule. +This rule fires during node form validation on Resource Conflict enabled content +types. You should use this event if you want to set form errors, or if you want +to interact with Rules_forms module. It provides both a node object of the node +being created/edited and a form object for use with rules_forms. This is the +event trigger for the default Rule. CONDITION: CONTAINS A RESOURCE CONFLICT - -Evaluate a node object for conflicts. Returns TRUE if there are conflicts for the node. +Evaluate a node object for conflicts. Returns TRUE if there are conflicts for +the node. ACTION: LOAD A LIST OF CONFLICTING NODES @@ -63,29 +64,29 @@ Creates a list of nodes that conflict with the given node. ACTION: SET A FORM VALIDATION ERROR -Stores a form validation error to be fired the next time a validation hook is called on -a conflict-enabled node. This is intended for use with the "A Resource Conflict Node Form -is Validated" Event, but you could probably find other creative uses for it. When this action -fires, the next resource conflict enabled node to go through validation will get a form error -on the resource conflict enabled date field. - +Stores a form validation error to be fired the next time a validation hook is +called on a conflict-enabled node. This is intended for use with the "A Resource +Conflict Node Form is Validated" Event, but you could probably find other +creative uses for it. When this action fires, the next resource conflict enabled +node to go through validation will get a form error on the resource conflict +enabled date field. == To Do == -* Setting a form validation error currently works by setting a variable in $_SESSION, and -retrieving it in hook_node_validate. This is open to all sorts of abuse, and if mis-used -properly could throw errors on the wrong node forms. At the very least, I should set a time -expiry on these messages to avoid accidental abuse. Proper caching would be even smarter. +* Setting a form validation error currently works by setting a variable in + $_SESSION, and retrieving it in hook_node_validate. This is open to all + sorts of abuse, and if mis-used properly could throw errors on the wrong + node forms. At the very least, I should set a time expiry on these messages + to avoid accidental abuse. Proper caching would be even smarter. -* Make ANY fieldable entity capable of handling conflict detection. +* Make ANY fieldable entity capable of handling conflict detection. == Contact == -This module was originally developed by Andrew Berry (andrewberry@sentex.net) +This module was originally developed by Andrew Berry (andrewberry@sentex.net) for use at the Protein Dynamics lab at the University of Guelph. -It was re-written for Rules and Entity integration by Campbell Vertesi (campbell@vertesi.com) -for use on a private project. +It was re-written for Rules and Entity integration by Campbell Vertesi +(campbell@vertesi.com) for use on a private project. Project Page: http://drupal.org/project/resource_conflict - diff --git a/resource_conflict.info b/resource_conflict.info index f015d30..897e3a9 100644 --- a/resource_conflict.info +++ b/resource_conflict.info @@ -5,6 +5,4 @@ dependencies[] = entityreference dependencies[] = rules dependencies[] = date dependencies[] = date_api -project = "resource_conflict" core = "7.x" - diff --git a/resource_conflict.install b/resource_conflict.install index 55ba4cc..faff144 100644 --- a/resource_conflict.install +++ b/resource_conflict.install @@ -1,8 +1,12 @@ $pattern)); + $sql = "SELECT name FROM {variable} WHERE name LIKE :pattern"; + $result = db_query($sql, array(':pattern' => $pattern)); foreach ($result as $row) { variable_del($row->name); } } /** - * Remove any duplicates types that were set due to this bug: - * https://drupal.org/node/1872030 + * Remove any duplicates types due to this bug: https://drupal.org/node/1872030. * - * We also can't trust that all the types in that array are - * accurate because of that bug. To address, we verify that each - * one should actually be there by checking the individual - * setting for that content type + * We also can't trust that all the types in that array are accurate because of + * that bug. To address, we verify that each one should actually be there by + * checking the individual setting for that content type. */ function resource_conflict_update_7300() { $types = variable_get('rc_types', array()); @@ -43,11 +46,10 @@ function resource_conflict_update_7300() { foreach ($deduped_types as $index => $type) { if (variable_get('rc_type_' . $type, 0) !== 1) { - // This content type should not be enabled + // This content type should not be enabled. unset($deduped_types[$index]); } } variable_set('rc_types', $deduped_types); } - diff --git a/resource_conflict.module b/resource_conflict.module index b9dff30..f2ee277 100644 --- a/resource_conflict.module +++ b/resource_conflict.module @@ -1,23 +1,28 @@ type, FALSE)) { - // Conflict handling is not enabled for this content type + // Conflict handling is not enabled for this content type. return; } - + rules_invoke_event('resource_conflict_node_validation', $node, $form); if (isset($_SESSION['resource_conflict_message'])) { - // Find the date field that handles conflicts + // Find the date field that handles conflicts. $date_field = variable_get('rc_date_field_' . $node->type, FALSE); $form_error = theme('item_list', $_SESSION['resource_conflict_message']); $message = implode('
', $_SESSION['resource_conflict_message']); @@ -27,7 +32,7 @@ function resource_conflict_node_validate($node, $form) { } /** - * Check a node for conflicts + * Check a node for conflicts. */ function _resource_conflict_get_conflicting_nids($node) { // Check the content type to make sure conflict handling is enabled. @@ -37,7 +42,7 @@ function _resource_conflict_get_conflicting_nids($node) { $time_spans = _resource_conflict_get_timespans($node); - // Back out if we don't have date data to compare with + // Back out if we don't have date data to compare with. if (empty($time_spans)) { return array(); } @@ -46,8 +51,7 @@ function _resource_conflict_get_conflicting_nids($node) { } /** - * Load an array of start/end times for the RC enabled date field - * from the passed in node + * Load an array of start/end times for the RC enabled date field on the node. */ function _resource_conflict_get_timespans($node) { $time_spans = array(); @@ -63,10 +67,11 @@ function _resource_conflict_get_timespans($node) { $date_field_info = field_info_field($date_field); $date_format = date_type_format($date_field_info['type']); $date_items = field_get_items('node', $node, $date_field); - - // Date repeat fields may have multiple values, so we iterate over each + + // Date repeat fields may have multiple values, so we iterate over each. foreach ($date_items as $single_repetition_date) { - // Avoid the "Add another item" element that is added for date repeat fields + // Avoid the "Add another item" element that is added for date repeat + // fields. if (!is_array($single_repetition_date)) { continue; } @@ -74,7 +79,7 @@ function _resource_conflict_get_timespans($node) { $start = $single_repetition_date['value']; $end = $single_repetition_date['value2']; - // Skip unless the user filled in a start and end date + // Skip unless the user filled in a start and end date. if (empty($start) || empty($end)) { continue; } @@ -82,24 +87,25 @@ function _resource_conflict_get_timespans($node) { if (!empty($start_buffer)) { $dateobj = DateObject::createFromFormat($date_format, $start); if ($dateobj->modify($start_buffer)) { - $start = $dateobj->format($date_format); + $start = $dateobj->format($date_format); } } if (!empty($end_buffer)) { $dateobj = DateObject::createFromFormat($date_format, $end); if ($dateobj->modify($end_buffer)) { - $end = $dateobj->format($date_format); + $end = $dateobj->format($date_format); } } - // Unix stamps should be interpreted as integers, but field_get_items pulls them - // out as strings. We need to cast back to int or our database comparisons fail + // Unix stamps should be interpreted as integers, but field_get_items pulls + // them out as strings. We need to cast back to int or our database + // comparisons fail. if ($date_format == DATE_FORMAT_UNIX) { - $start = (int)$start; - $end = (int)$end; + $start = (int) $start; + $end = (int) $end; } - + $time_spans[] = array( 'start' => $start, 'end' => $end, @@ -110,9 +116,10 @@ function _resource_conflict_get_timespans($node) { } /** - * Rules Action: poor mans way of passing a form error to our form validation - * for a resource conflict node form. See resource_conflict_node_validate() - * for how this session var is used to set a form error + * Rules Action: Poor mans way of passing a form error to form validation. + * + * Used for a resource conflict node form. See resource_conflict_node_validate() + * for how this session var is used to set a form error. */ function resource_conflict_form_error($message) { $_SESSION['resource_conflict_message'][] = $message; @@ -127,7 +134,7 @@ function resource_conflict_contains_conflict($node) { return FALSE; } - // Fire Rules event for each conflict detected + // Fire Rules event for each conflict detected. foreach ($conflicting_node_ids as $conflicting_node_id) { $conflicting_node = node_load($conflicting_node_id); rules_invoke_event('resource_conflict_conflict_detected', $node, $conflicting_node); @@ -137,7 +144,7 @@ function resource_conflict_contains_conflict($node) { } /** - * Rules Action: load list of conflicting nodes, if any + * Rules Action: load list of conflicting nodes, if any. */ function resource_conflict_load_conflict_list($node) { $conflicting_node_ids = _resource_conflict_get_conflicting_nids($node); @@ -154,27 +161,28 @@ function resource_conflict_load_conflict_list($node) { } /** - * Determine if any conflict enabled nodes overlap the specified times + * Determine if any conflict enabled nodes overlap the specified times. * * 1. $start is within the event time * 2. $end is within the event time * 3. The event encompasses $start and $end - * 4. Allow the end of one event to occur at the start of the next + * 4. Allow the end of one event to occur at the start of the next. * - * @param $time_spans + * @param array $time_spans * An array of 'time span' arrays with the following keys: * - start: Start of an event * - end: End of an event * The date format of each pair is that of the unsaved node's date format - * All date fields that are compared must be of the same format - * @param $nid - * The node ID of the resource that we're conflict checking for - * @return + * All date fields that are compared must be of the same format. + * @param int $nid + * The node ID of the resource that we're conflict checking for. + * + * @return array * An array of node IDs. */ -function _resource_conflict_query_for_conflicts($time_spans, $nid) { +function _resource_conflict_query_for_conflicts(array $time_spans, $nid) { $nids = array(); - $conflict_types = variable_get("rc_types", array()); + $conflict_types = variable_get('rc_types', array()); foreach ($conflict_types as $type) { $date_field = variable_get('rc_date_field_' . $type, FALSE); $date_table = '{field_data_' . $date_field . '}'; @@ -185,14 +193,14 @@ function _resource_conflict_query_for_conflicts($time_spans, $nid) { $query = db_select('node', 'n'); $query->join($date_table, 'date_table', 'n.vid = date_table.revision_id'); $query->fields('n', array('nid')) - ->condition(db_or() - ->condition(db_and()->condition($start_field, $time_span['start'], '<=')->condition($end_field, $time_span['start'], '>')) - ->condition(db_and()->condition($start_field, $time_span['end'], '<')->condition($end_field, $time_span['end'], '>=')) - ->condition(db_and()->condition($start_field, $time_span['start'], '>=')->condition($end_field, $time_span['end'], '<=')) + ->condition(db_or() + ->condition(db_and()->condition($start_field, $time_span['start'], '<=')->condition($end_field, $time_span['start'], '>')) + ->condition(db_and()->condition($start_field, $time_span['end'], '<')->condition($end_field, $time_span['end'], '>=')) + ->condition(db_and()->condition($start_field, $time_span['start'], '>=')->condition($end_field, $time_span['end'], '<=')) ) - ->addTag('resource_conflict') - ->distinct(); - // $nid may be null if the unsaved node was not yet created + ->addTag('resource_conflict') + ->distinct(); + // $nid may be null if the unsaved node was not yet created. if ($nid) { $query->condition('n.nid', $nid, '<>'); } @@ -223,7 +231,7 @@ function resource_conflict_form_alter(&$form, $form_state, $form_id) { $disabled_msg = t('To set up this content type for conflict checking, first add a Date field with a required end date (repeate dates are supported). When the conditions have been met, this section will be enabled for configuration.'); - // The user is adding a new content type + // The user is adding a new content type. if ($type == NULL) { $form['resource_conflict_set']['rc_info'] = array( '#prefix' => '

', @@ -243,7 +251,7 @@ function resource_conflict_form_alter(&$form, $form_state, $form_id) { if (empty($date_fields)) { $form['resource_conflict_set']['requirements'] = array( - '#prefix' => '

', + '#prefix' => '

', '#suffix' => '

', '#weight' => -10, '#markup' => $disabled_msg, @@ -269,81 +277,85 @@ function resource_conflict_form_alter(&$form, $form_state, $form_id) { $form['resource_conflict_set']['rc_conflict_buffer_start'] = array( '#type' => 'textfield', '#title' => t('Conflict Buffer - Start'), - '#description' => t('Added to the start date of bookings to extend the conflict zone. !strtotime format. Example: "-5 minutes".', array('!strtotime' => l('strtotime', 'http://us1.php.net/strtotime'))), + '#description' => t('Added to the start date of bookings to extend the conflict zone. strtotime format. Example: "-5 minutes".', array('@strtotime' => 'http://us1.php.net/strtotime')), '#default_value' => variable_get('rc_conflict_buffer_start_' . $type, ''), ); $form['resource_conflict_set']['rc_conflict_buffer_end'] = array( '#type' => 'textfield', '#title' => t('Conflict Buffer - End'), - '#description' => t('Added to the end date of bookings to extend the conflict zone. !strtotime format. Example: "+5 minutes".', array('!strtotime' => l('strtotime', 'http://us1.php.net/strtotime'))), + '#description' => t('Added to the end date of bookings to extend the conflict zone. strtotime format. Example: "+5 minutes".', array('@strtotime' => 'http://us1.php.net/strtotime')), '#default_value' => variable_get('rc_conflict_buffer_end_' . $type, ''), ); } - // Add our custom submission handler so we can manage the RC settings + // Add our custom submission handler so we can manage the RC settings. $form['#validate'][] = 'resource_conflict_form_validate'; $form['#submit'][] = 'resource_conflict_form_submit'; } /** - * Our custom validate handler for when a content type is saved + * Our custom validate handler for when a content type is saved. */ function resource_conflict_form_validate($form, &$form_state) { if (!empty($form_state['values']['rc_conflict_buffer_start'])) { - if (strtotime($form_state['values']['rc_conflict_buffer_start']) === false) { + if (strtotime($form_state['values']['rc_conflict_buffer_start']) === FALSE) { form_set_error('rc_conflict_buffer_start', t('Start buffer not valid. Check PHP documentation for strtotime().')); } } if (!empty($form_state['values']['rc_conflict_buffer_end'])) { - if (strtotime($form_state['values']['rc_conflict_buffer_end']) === false) { + if (strtotime($form_state['values']['rc_conflict_buffer_end']) === FALSE) { form_set_error('rc_conflict_buffer_end', t('End buffer not valid. Check PHP documentation for strtotime().')); } } } /** - * Our custom submit handler for when a content type is saved + * Our custom submit handler for when a content type is saved. */ function resource_conflict_form_submit($form, &$form_state) { $type = $form_state['values']['type']; if (isset($form_state['values']['rc_type']) && $form_state['values']['rc_type'] == 1) { _resource_conflict_add_type($type); - } else { + } + else { _resource_conflict_remove_type($type); } } /** - * Implements hook_field_delete_instance() + * Implements hook_field_delete_instance(). * * If this field was assigned as an RC date field, we want to delete it's data * from our registry and possibly warn the user that RC was disabled for this - * content type + * content type. */ function resource_conflict_field_delete_instance($instance) { $rc_date_field = variable_get('rc_date_field_' . $instance['bundle'], FALSE); if ($rc_date_field == $instance['field_name']) { variable_del('rc_date_field_' . $instance['bundle']); - // Msg user if the content type was enabled for RC - $content_type_enabled = variable_get('rc_type_'. $instance['bundle'], FALSE); + // Msg user if the content type was enabled for RC. + $content_type_enabled = variable_get('rc_type_' . $instance['bundle'], FALSE); if ($content_type_enabled == 1) { $msg = t('Resource Conflict has been disabled for the %type content type as the date field has been deleted.', array('%type' => $instance['bundle'])); drupal_set_message($msg, 'warning'); watchdog('resource conflict', $msg, WATCHDOG_WARNING); } - // Delete the reg values for this content type whether it was enabled or not + // Delete the reg values for this content type whether it was enabled or + // not. _resource_conflict_remove_type($instance['bundle']); } } /** - * Implements hook_field_update_instance() - * Notice when an RC-enabled field is modified, and make sure it still meets requirements. + * Implements hook_field_update_instance(). + * + * Notice when an RC-enabled field is modified, and make sure it still meets + * requirements. */ function resource_conflict_field_update_instance($instance, $prior_instance) { if (variable_get('rc_type_' . $instance['bundle'], FALSE) && variable_get('rc_date_field_' . $instance['bundle'], FALSE) == $instance['field_name']) { @@ -359,7 +371,7 @@ function resource_conflict_field_update_instance($instance, $prior_instance) { } /** - * Adds the provided content type to our list of enabled RC types + * Adds the provided content type to our list of enabled RC types. */ function _resource_conflict_add_type($content_type) { $conflict_types = variable_get("rc_types", array()); @@ -371,7 +383,7 @@ function _resource_conflict_add_type($content_type) { } /** - * Removes the provided content type from our list of enabled RC types + * Removes the provided content type from our list of enabled RC types. */ function _resource_conflict_remove_type($content_type) { $conflict_types = variable_get("rc_types", array()); @@ -381,18 +393,16 @@ function _resource_conflict_remove_type($content_type) { variable_set("rc_types", $conflict_types); } - variable_del('rc_type_'. $content_type); + variable_del('rc_type_' . $content_type); } /** - * Checks if the provided field instance is compatible with our module + * Checks if the provided field instance is compatible with our module. */ function _resource_conflict_check_field_compatibility($field_instance) { $field_info = field_info_field($field_instance['field_name']); if ($field_info['module'] == 'date' && $field_info['settings']['todate'] == 'required') { - return true; + return TRUE; } - return false; + return FALSE; } - - diff --git a/resource_conflict.rules.inc b/resource_conflict.rules.inc index bd8bac7..f126d48 100644 --- a/resource_conflict.rules.inc +++ b/resource_conflict.rules.inc @@ -1,8 +1,15 @@ 'node', 'label' => t('unsaved node'), ), - ) - ) + ), + ), ); // If rules_forms is enabled, we can pass the form object as a variable @@ -47,8 +54,9 @@ function resource_conflict_rules_event_info() { return $events; } -/** - * Implementation of hook_rules_condition_info() +/** + * Implements hook_rules_condition_info(). + * * Provides a Rules condition for "contains a resource conflict" */ function resource_conflict_rules_condition_info() { @@ -61,15 +69,15 @@ function resource_conflict_rules_condition_info() { 'node' => array( 'type' => 'node', 'label' => t('Node'), - ) + ), ), ), ); } - -/** - * Implementation of hook_rules_action_info() +/** + * Implements hook_rules_action_info(). + * * Provides a Rules action for "load list of conflicting nodes" */ function resource_conflict_rules_action_info() { diff --git a/resource_conflict.rules_defaults.inc b/resource_conflict.rules_defaults.inc index 326825b..520bb32 100644 --- a/resource_conflict.rules_defaults.inc +++ b/resource_conflict.rules_defaults.inc @@ -2,7 +2,7 @@ /** * @file - * Default rule configurations for Resource Conflict. + * Default rule configurations for Resource Conflict. */ /** @@ -11,7 +11,8 @@ function resource_conflict_default_rules_configuration() { $rules = array(); - // Add an example reaction rule to display a warning message if conflicts detected + // Add an example reaction rule to display a warning message if conflicts + // detected. $rules['rules_display_conflict_message_on_node_save'] = entity_import('rules_config', '{ "rules_display_conflict_message_on_node_save" : { "LABEL" : "Display conflict message on node save", "PLUGIN" : "reaction rule", @@ -38,4 +39,3 @@ function resource_conflict_default_rules_configuration() { return($rules); } -?>