macro.module

<?php
// $Id$

/**
 * @file
 * Allows administrators to record form sumissions and play back the recordings.
 */

/**
 * Implementation of hook_help().
 */
function macro_help($section) {
  switch ($section) {
    case 'admin/help#macro':
      $output = t('Todo: Add help text.');
    case 'admin/build/macro/export' :
      return t('This output can be saved to the profile`s .macro file, to be automatically played back upon completed install or used on an import on another site.');
    case 'admin/build/macro/import' :
      return t('Insert recorded macro here to be played into your site. All referenced modules needs to be enabled.');
    case 'admin/build/macro':
      return t('Configuration settings for the drupal macro engine.');
  }
}

/**
 * Implementation of hook_menu().
 */
function macro_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'admin/build/macro',
      'title' => t('Macro engine'),
      'description' => t('Configure the Drupal macro engine. Export recorded macros or import previously recorded macros.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('macro_admin_settings'),
      'access' => user_access('administer macro settings'),
      'type' => MENU_NORMAL_ITEM,
    );
    $items[] = array(
      'title' => t('Export'),
      'path' => 'admin/build/macro/export', 
      'access' => true, 
      'callback' => 'drupal_get_form',
      'callback arguments' => array(t('macro_export_macro')),
      'access' => user_access('macro access'),
      'type' => MENU_LOCAL_TASK,
    );
    $items[] = array(
      'title' => t('Import'),
      'path' => 'admin/build/macro/import', 
      'access' => true, 
      'callback' => 'drupal_get_form',
      'callback arguments' => array(t('macro_import_macro')),
      'access' => user_access('macro access'),
      'type' => MENU_LOCAL_TASK,
    );
    $items[] = array('path' => 'admin/build/macro/settings',
      'title' => t('Configure'),
      'description' => t('Configure the Drupal macro engine. Export recorded macros or import previously recorded macros.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('macro_admin_settings'),
      'access' => user_access('administer macro settings'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
    );

  }

  return $items;
}


/**
 * Implementation of hook_perm().
 */
function macro_perm() {
  return array('macro access');
}

/**
 * Implementation of hook_form_alter().
 * Optionally record all form submissions, for later use in building distributions
 */
function macro_form_alter($form_id, &$form) {
  if ($form_id != 'macro_import_macro' && variable_get('macro_enabled', FALSE)) {
    $form['#submit']['macro_record_macro'] = array($form);
  }
  if (variable_get('macro_delete', FALSE)) {
    variable_set('macro_submissions', array());
    variable_set('macro_delete', FALSE);
  }
}

/**
 * A form submission handler, that stores the form submissions into the variables table
 */
function macro_record_macro($form_id, $edit, $form) {
  $subs = variable_get('macro_submissions', array());
  $subs[] = array('form_id' => $form_id, 'parameters' => $form['#parameters'], 'values' => $edit);
  variable_set('macro_submissions', $subs);
}


/**
 * A form callback that displays the macro exported.
 *
 * The output of this callback should be saved to the profiles/$profile/macros.inc file, to be 
 * automatically played back upon completed install.
 * @return a textarea containing the recorded macros
 */
function macro_export_macro() {
  $form['code'] = array(
    '#type' => 'textarea',
    '#title' => 'macros exported',
    '#default_value' => macro_get_macro(),
    '#rows' => 20,
  );
  return $form;	

}

/**
 * The output of this callback should be saved to the profiles/$profile/macros.inc file, to be 
 * automatically played back upon completed install.
 * @return a code representation of the recorded macro.
 */
function macro_get_macro() {  
  $subs = variable_get('macro_submissions', array());
  foreach ($subs as $key => $form) {
    $string .= "\$macro[$key]['form_id'] = " . var_export($form['form_id'], TRUE) . ";\n";
    $string .= "\$macro[$key]['values']  = " . var_export((array) $form['values'], TRUE) . ";\n";

    // the form parameters are being used here. 
    array_shift($form['parameters']);
    $string .= "\$macro[$key]['parameters']  = " . var_export(serialize($form['parameters']), TRUE) . ";\n\n";
    
  }

  return $string;
}

/**
 * A form callback that displays the macro import form.
 *
 * @return a form for importing a previously recorded macro
 */
function macro_import_macro() {
  $form['macro'] = array(
    '#type' => 'textarea',
    '#title' => 'macro to import',
    '#rows' => 20,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('play macro'),
  );
  return $form; 
}

/**
 * Implementation of macro_import_macro hook_submit function.
 * 
 * Plays back the submitted macro.
 */
function macro_import_macro_submit($form_id, $form_values) {
  include_once './includes/install.inc';
  eval($form_values['macro']);
  drupal_execute_macro($macro);
}


/**
 * Menu callback for the macro settings form.
 */
function macro_admin_settings() {

  $form['settings_general'] = array(
    '#type' => 'fieldset',
    '#title' => t('Macro settings'),
    '#collapsible' => TRUE,
  );
  $form['settings_general']['macro_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable macro recording'),
    '#default_value' => variable_get('macro_enabled', FALSE),
    '#description' => t('Set whether the macro engine will record form submissions.'),
  );
  $form['settings_general']['macro_delete'] = array(
    '#type' => 'checkbox',
    '#title' => t('Delete recorded macro'),
    '#default_value' => variable_get('macro_delete', FALSE),
    '#description' => t('Set whether to clear previously recorded macro.'),
  );
  
  return system_settings_form($form);
}

/**
+ * Attempts to programmatically submit all the forms that have been specified in the $macros collection.
+ */
function drupal_execute_macro($macro) {
  foreach ($macro as $key => $data) {
    // print_r($data);
    $param = unserialize($data['parameters']);
    $args = array($data['form_id'], $data['values']);
    $args = array_merge($args, $param);
    call_user_func_array('drupal_execute', $args);
    if (form_get_errors()) {
       drupal_set_message(t("An error has occured with macro #%macro_number , form_id %form_id. Please check the errors displayed for more details.", array('%macro_number' => $key, '%form_id' => $data['form_id'])));
    }
  }
}