calendar_systems.patch.inc in Calendar Systems 6.2

A collection of internal helpers around the compatibility patches.

@todo

• Break out the patch wrapper code into its own separate module, so we can focus on the real Calendar Systems module.

File

calendar_systems.patch.inc

<?php

/**
 * @file
 * A collection of internal helpers around the compatibility patches.
 *
 * @todo
 *   - Break out the patch wrapper code into its own separate module, so we can
 *     focus on the real Calendar Systems module.
 */

/**
 * Internal helper which acts as a patch information pool.
 *
 * @param $req
 *   Imply whether to return all patches information or just the required ones.
 *
 * @return
 *   Either partial or full patch files info.
 *
 * @todo
 *   - Make the pool pluggable if required!
 */
function _calendar_systems_patches($req = FALSE) {
  $t = get_t();
  $required = $optional = array();

  // Required patches.
  $required['common.inc'] = array(
    // Relative path to target file:
    'target' => 'includes/common.inc',
    // Target component name:
    'target module' => 'core',
    // Target component version:
    'target version' => '6.19',
    // The name of the patch file itself:
    'name' => 'common.inc-format_date.d6.patch',
    // Relative path to patch file's directory:
    'path' => drupal_get_path('module', 'calendar_systems') . '/patches/',
    // Patch fingerprint to check the target file contents against:
    'fingerprint' => 'foreach (module_implements(\'format_date\') as $module)',
    // A description of what the patch supposed to do:
    'description' => $t('Drupal core common.inc expansion to support hook_format_date() implementations.'),
    // Patch title:
    'title' => $t('Calendar Systems common.inc patch for Drupal core'),
    // Drupal.org issue number, if available:
    'issue' => NULL,
  );

  // Optional patches.
  $optional['uc_deliverytimeslot'] = array(
    // Relative path to target file:
    'target' => drupal_get_path('module', 'uc_deliverytimeslot') . '/uc_deliverytimeslot.module',
    // Target component name:
    'target module' => 'uc_deliverytimeslot',
    // Target component version:
    'target version' => '6.x-1.0-beta4',
    // The name of the patch file itself:
    'name' => 'uc_deliverytimeslot-format_date.d6.patch',
    // Relative path to patch file's directory:
    'path' => drupal_get_path('module', 'calendar_systems') . '/patches/',
    // Patch fingerprint to check the target file contents against:
    'fingerprint' => '$row[] = array(\'data\' => t(\'!day\', array(\'!day\' => format_date($timestamps, \'custom\', \'l\'))),',
    // A description of what the patch supposed to do:
    'description' => $t('Ubercart Delivery Timeslot module to use format_date() and support for calendar_systems.module.'),
    // Patch title:
    'title' => $t('Calendar Systems patch for Ubercart Delivery Timeslot module'),
    // Drupal.org issue number, if available:
    'issue' => '970768',
  );
  return $req ? $required : $required + $optional;
}

/**
 * Internal helper to check whether the required patches are currently applied.
 *
 * @return
 *   TRUE if all required patches are applies, FALSE otherwise.
 */
function _calendar_systems_patches_applied() {

  // Get required patch arrays.
  $patches = _calendar_systems_patches(TRUE);
  foreach ($patches as $identifier => $patch) {

    // Findout patch target absolute path.
    // $patch['target'] should have its relative path in.
    $target = function_exists('absolute_path') ? absolute_path() . '/' . $patch['target'] : realpath(drupal_get_path('module', 'system') . '/../../' . $patch['target']);

    // Applied?
    if (strpos(file_get_contents($target), $patch['fingerprint']) === FALSE) {
      return FALSE;
    }
  }
  return TRUE;
}

/**
 * Internal helper of hook_requirements() implementation.
 *
 * @return
 *   An array requirements checking results as per required by
 *   hook_requirements() implementation.
 */
function _calendar_systems_patches_requirements() {
  $t = get_t();

  // Requirements array as per required by hook_requirements().
  $requirements = array(
    'calendar_systems' => array(
      'title' => $t('Calendar Systems'),
      'value' => $t('Not installed correctly.'),
    ),
  );

  // The message to be shown when the requirements are not met.
  $error = $t('Calendar Systems required patches are not applied yet. Please read the <a href="!link">installation instructions</a>.', array(
    '!link' => drupal_get_path('module', 'calendar_systems') . '/INSTALL.txt',
  ));

  // Check if the required patches are currently applied.
  if (_calendar_systems_patches_applied()) {
    $requirements['calendar_systems']['severity'] = REQUIREMENT_OK;
    $requirements['calendar_systems']['value'] = $t('Installed correctly.');
    return $requirements;
  }

  // Allow user to enable the module if there are a 'patch manager' module available,
  // even if the requirements are not met yet.
  if ($phase == 'install' && (module_exists('patchdoq') || module_exists('patch_manager'))) {
    $severity = REQUIREMENT_WARNING;
  }
  else {
    $severity = REQUIREMENT_ERROR;
  }
  $requirements['calendar_systems'] += array(
    'severity' => $severity,
    'description' => $error,
  );
  return $requirements;
}

/**
 * Internal helper to create patch records for the lazy patch_manager project.
 *
 * Saves a "patch" typed node as per required by patch_manager.module once the
 * Calendar Systems gets installed.
 *
 * @param $patch_filename
 *   The name of the patch file.
 * @param $patch_filepath
 *   The relative path to the patch file.
 *
 * @return
 *   Boolean value indicating the process result.
 *
 * @see http://drupal.org/project/patch_manager
 *
 * @todo
 *   - Watch for duplicate patch introductions!
 */
function _calendar_systems_patches_pm_insert($patch_filename = FALSE, $patch_filepath = FALSE) {
  if (!module_exists('patch_manager')) {
    return;
  }

  // Get all required and optional patch arrays.
  $patches = _calendar_systems_patches();

  // Delete the previously introduced patch nodes, if any.
  _calendar_systems_patches_pm_delete($patches);

  // Create and save a node per patch array.
  foreach ($patches as $identifier => $patch) {

    // Copy the patch to Drupal's files directory, This way the file
    // can be seen by CCK filefield, sorry for the suppression load!
    $new_path = file_directory_path() . '/';
    if (!@copy($patch['path'] . $patch['name'], $new_path . $patch['name'])) {

      // #FAIL.
      return FALSE;
    }

    // Oh, I wish I could automate eth!
    // chmod($patch['target'], 0646);
    global $user;

    // Create and save the patch file.
    $file = (object) array(
      'file' => 1,
      'uid' => $user->uid,
      'timestamp' => time(),
      'filename' => $patch['name'],
      'filesource' => $patch['name'],
      'filemime' => file_get_mimetype($patch['name']),
      'filepath' => $new_path . $patch['name'],
      'filesize' => filesize($new_path . $patch['name']),
      'status' => FILE_STATUS_PERMANENT,
    );

    // Oh, missing D7 file_save().
    drupal_write_record('files', $file);

    // Retrive the fid of the inserted file to be used in the "patch" typed node.
    $file->fid = db_result(db_query("SELECT fid FROM {files} WHERE filepath = '%s'", $file->filepath));

    // Build the patch node.
    $node = new stdClass();
    $node->type = 'patch';
    $node->language = 'en';
    $node->uid = $user->uid;
    $node->title = $patch['title'];
    $node->body = $patch['description'];

    // CCK module field:
    $node->field_module[0]['value'] = $patch['target module'];

    // CCK issue number field:
    if (!is_null($patch['issue']) && is_numeric($patch['issue'])) {
      $node->field_drupal_issue[0]['value'] = $patch['issue'];
    }

    // Attach the patch file to the node.
    $node->field_patch[0] = array(
      'list' => 1,
      'fid' => $file->fid,
      'title' => $file->filename,
      'filename' => $file->filename,
      'filepath' => $file->filepath,
      'filesize' => $file->filesize,
      'mimetype' => $file->filemime,
    );

    // Save the patch node.
    content_presave($node);
    node_save($node);
    content_insert($node);
  }

  // Yo Happy?
  return TRUE;
}

/**
 * Internal helper to remove a patch_manager.module patch record.
 *
 * @param $patches
 *   Optional array of patches to get un-introduced!
 *
 * @see http://drupal.org/node/292151
 * @see http://drupal.org/project/patch_manager
 */
function _calendar_systems_patches_pm_delete($patches = FALSE) {
  if (module_exists('patch_manager')) {

    // Get all available patches, if not passed.
    if (!$patches) {
      $patches = _calendar_systems_patches();
    }

    // Delete all corresponding "patch" typed nodes.
    foreach ($patches as $identifier => $patch) {

      // Remember that we copied the patch into files directory.
      $path = file_directory_path() . '/' . $patch['name'];
      $query = "SELECT ctp.nid\n                FROM {files} f\n                LEFT JOIN {content_type_patch} ctp ON f.fid = ctp.field_patch_fid\n                WHERE f.filepath = '%s'";

      // Delete patch's corresponding node, if any.
      if ($nid = db_result(db_query($query, $path))) {
        node_delete($nid);
      }
    }
  }
}

Functions

Name	Description
_calendar_systems_patches	Internal helper which acts as a patch information pool.
_calendar_systems_patches_applied	Internal helper to check whether the required patches are currently applied.
_calendar_systems_patches_pm_delete	Internal helper to remove a patch_manager.module patch record.
_calendar_systems_patches_pm_insert	Internal helper to create patch records for the lazy patch_manager project.
_calendar_systems_patches_requirements	Internal helper of hook_requirements() implementation.