donor_rally.profile

<?php
// $Id: donor_rally.profile 880 2009-09-04 00:10:54Z jhedstrom $

/**
 * Return an array of the modules to be enabled when this profile is installed.
 *
 * @return array
 *   An array of modules to enable.
 */
function donor_rally_profile_modules() {
  $modules = array(
    // Drupal core modules.
    'help', 'menu', 'taxonomy', 'dblog', 'path',

    // Contributed modules.
    'admin',
    'advanced_help',
    'better_formats',
    'ctools',
    'content',
    'contextual',
    'features',
    'less',
    'pathauto',
    'role_delegation',
    'strongarm',
    'token',
    'vertical_tabs',
    'views',
  );

  return $modules;
}

/**
 * Return a description of the profile for the initial installation screen.
 *
 * @return
 *   An array with keys 'name' and 'description' describing this profile,
 *   and optional 'language' to override the language selection for
 *   language-specific profiles.
 */
function donor_rally_profile_details() {
  return array(
    'name' => 'Donor Rally',
    'description' => st('Select this profile to enable a Donor Rally installation.'),
  );
}

/**
 * Return a list of tasks that this profile supports.
 *
 * @return
 *   A keyed array of tasks the profile will perform during
 *   the final stage. The keys of the array will be used internally,
 *   while the values will be displayed to the user in the installer
 *   task list.
 */
function donor_rally_profile_task_list() {
  $tasks['donor-rally-payment-gateway'] = st('Select Donor Rally payment gateway');
  $tasks['donor-rally-modules-batch'] = st('Install Donor Rally modules');
  $tasks['donor-rally-configure'] = st('Configure Donor Rally');
  $tasks['donor-rally-configure-goal'] = st('Set Fundraising Goal');
  return $tasks;
}

/**
 * Perform any final installation tasks for this profile.
 *
 * The installer goes through the profile-select -> locale-select
 * -> requirements -> database -> profile-install-batch
 * -> locale-initial-batch -> configure -> locale-remaining-batch
 * -> finished -> done tasks, in this order, if you don't implement
 * this function in your profile.
 *
 * If this function is implemented, you can have any number of
 * custom tasks to perform after 'configure', implementing a state
 * machine here to walk the user through those tasks. First time,
 * this function gets called with $task set to 'profile', and you
 * can advance to further tasks by setting $task to your tasks'
 * identifiers, used as array keys in the hook_profile_task_list()
 * above. You must avoid the reserved tasks listed in
 * install_reserved_tasks(). If you implement your custom tasks,
 * this function will get called in every HTTP request (for form
 * processing, printing your information screens and so on) until
 * you advance to the 'profile-finished' task, with which you
 * hand control back to the installer. Each custom page you
 * return needs to provide a way to continue, such as a form
 * submission or a link. You should also set custom page titles.
 *
 * You should define the list of custom tasks you implement by
 * returning an array of them in hook_profile_task_list(), as these
 * show up in the list of tasks on the installer user interface.
 *
 * Remember that the user will be able to reload the pages multiple
 * times, so you might want to use variable_set() and variable_get()
 * to remember your data and control further processing, if $task
 * is insufficient. Should a profile want to display a form here,
 * it can; the form should set '#redirect' to FALSE, and rely on
 * an action in the submit handler, such as variable_set(), to
 * detect submission and proceed to further tasks. See the configuration
 * form handling code in install_tasks() for an example.
 *
 * Important: Any temporary variables should be removed using
 * variable_del() before advancing to the 'profile-finished' phase.
 *
 * @param $task
 *   The current $task of the install system. When hook_profile_tasks()
 *   is first called, this is 'profile'.
 * @param $url
 *   Complete URL to be used for a link or form action on a custom page,
 *   if providing any, to allow the user to proceed with the installation.
 *
 * @return
 *   An optional HTML string to display to the user. Only used if you
 *   modify the $task, otherwise discarded.
 */
function donor_rally_profile_tasks(&$task, $url) {
  if ($task == 'profile') {
    // Insert default user-defined node types into the database. For a complete
    // list of available node type attributes, refer to the node type API
    // documentation at: http://api.drupal.org/api/HEAD/function/hook_node_info.
    $types = array(
      array(
        'type' => 'page',
        'name' => st('Page'),
        'module' => 'node',
        'description' => st("A <em>page</em> is a simple method for creating and displaying information that rarely changes, such as an \"About us\" section of a website. By default, a <em>page</em> entry does not allow visitor comments and is not featured on the site's initial home page."),
        'custom' => TRUE,
        'modified' => TRUE,
        'locked' => FALSE,
        'help' => '',
        'min_word_count' => '',
      ),
    );

    foreach ($types as $type) {
      $type = (object) _node_type_set_defaults($type);
      node_type_save($type);
    }

    // Default page to not be promoted, and have comments disabled, and create new revisions.
    variable_set('node_options_page', array('status', 'revision'));
    variable_set('comment_page', COMMENT_NODE_DISABLED);

    // Don't display date and author information for page nodes by default.
    $theme_settings = variable_get('theme_settings', array());
    $theme_settings['toggle_node_info_page'] = FALSE;
    $theme_settings['toggle_node_info_team'] = FALSE;
    variable_set('theme_settings', $theme_settings);

    // Admin theme.
    variable_set('admin_theme', 'rubik');
    variable_set('views_no_hover_links', TRUE);

    // Default footer.
    variable_set('site_footer', st('Donor Rally&trade; &mdash; built by <a href="!url">OpenSourcery</a>', array('!url' => url('http://www.opensourcery.com'))));

    // Set default theme. This needes some more set up on next page load
    // We cannot do everything here because of _system_theme_data() static cache
    system_theme_data();
    db_query("UPDATE {system} SET status = 0 WHERE type = 'theme' and name ='%s'", 'garland');
    variable_set('theme_default', 'huddle');
    // Disable all DB blocks.
    db_query("UPDATE {blocks} SET status = 0, region = ''");

    // Create roles.
    _donor_rally_user_roles();
    // Assign sensible input filter defaults to roles.
    _donor_rally_better_formats();
    // Initial permissions.
    _donor_rally_set_permissions();
    // Pathauto defaults.
    _donor_rally_pathauto();
    // Core configuration and tweaks.
    _donor_rally_core();

    $task = 'donor-rally-payment-gateway';
 }

  if ($task == 'donor-rally-payment-gateway') {
    $output = drupal_get_form('donor_rally_payment_gateway_form', $url); 
    if (!variable_get('dr_base_payment_gateway', FALSE)) {
      drupal_set_title(st('Select Donor Rally Payment Gateway'));
      return $output;
    }
    $task = 'donor-rally-modules';
  }

  // We are running a batch task for this profile so basically do
  // nothing and return page.
  if (in_array($task, array('donor-rally-modules-batch'))) {
    include_once 'includes/batch.inc';
    $output = _batch_page();
    return $output;
  }

  if ($task == 'donor-rally-modules') {
    $modules = _donor_rally_modules();
    $files = module_rebuild_cache();
    // Create batch
    foreach ($modules as $module) {
      $batch['operations'][] = array('_install_module_batch', array($module, $files[$module]->info['name']));
    }
    $batch['operations'][] = array('_donor_rally_clean', array());
    $batch['finished'] = '_donor_rally_profile_batch_finished';
    $batch['title'] = st('Installing @drupal', array('@drupal' => drupal_install_profile_name()));
    $batch['error_message'] = st('The installation has encountered an error.');

    variable_set('install_task', 'donor-rally-modules-batch');
    batch_set($batch);
    batch_process($url, $url);

    // Jut for cli installs. We'll never reach here on interactive installs.
    return;
  }

  if ($task == 'donor-rally-configure') {
    $output = drupal_get_form('donor_rally_configure_form', $url);

    if (!variable_get('donor_rally_configured', FALSE)) {
      return $output;
    }
    else {
      variable_set('donor_rally_configured', FALSE);
      $task = 'donor-rally-configure-goal';
    }
  }

  if ($task == 'donor-rally-configure-goal') {
    $output = drupal_get_form('donor_rally_fundraising_goal');
    if (!variable_get('donor_rally_configured', FALSE)) {
      return $output;
    }
    else {
      // Clean-up install profile variables.
      variable_del('donor_rally_configured');
      variable_set('install_task', 'profile-finished');
      $task = 'profile-finished';
    }
  }
}

/**
 * Implementation of hook_form_alter().
 *
 * Allows the profile to alter the site-configuration form. This is
 * called through custom invocation, so $form_state is not populated.
 */
function donor_rally_form_alter(&$form, $form_state, $form_id) {
  if ($form_id == 'install_configure') {
    // Set default for site name field.
    $form['site_information']['site_name']['#default_value'] = $_SERVER['SERVER_NAME'];
  }
}

/**
 * Creates Team Leader and Administrator roles.
 */
function _donor_rally_user_roles() {
  foreach (array('campaign coordinator', 'administrator') as $role) {
    if (!db_result(db_query("SELECT rid FROM {role} WHERE name = '%s'", array(':role_name' => $role)))) {
      db_query("INSERT INTO {role} (name) VALUES ('%s')", $role);
      drupal_set_message(t('The %role role has been added.', array('%role' => $role)));
      $dummy = array();
      better_formats_new_role($dummy, $dummy);
    }
  }
}

/**
 * Set campaign coordinator and administrator default input format to full HTML.
 */
function _donor_rally_better_formats() {
  $roles = array();
  foreach (user_roles() as $rid => $name) {
    if (in_array($name, array('campaign coordinator', 'administrator'))) {
      $roles[] = $rid;
      // Float admin to top, campaign coordinator 2nd highest.
      $weight = -2 * $rid;
      db_query("UPDATE {better_formats_defaults} SET format = %d, weight = %d WHERE rid = %d AND type = '%s'", array(':format' => 2, ':weight' => $weight, ':rid' => $rid, ':type' => 'node'));
      db_query("UPDATE {better_formats_defaults} SET format = %d, weight = %d WHERE rid = %d AND type = '%s'", array(':format' => 2, ':weight' => $weight, ':rid' => $rid, ':type' => 'comment'));
    }
  }
  $current = db_result(db_query("SELECT roles FROM {filter_formats} WHERE format = 2"));
  if ($current) {
    $current = explode(',', $roles);
    $roles = array_merge($current, $roles);
  }
  $roles = ','. implode(',', $roles) .',';
  // Allow campaign coordinators and administrators to use HTML;
  db_query("UPDATE {filter_formats} SET roles = '%s' WHERE format = 2", array(':roles' => $roles));
}

/**
 * Set some sensible permissions.
 */
function _donor_rally_set_permissions() {
  $roles = user_roles();
  $admin_rid = array_search('administrator', $roles);
  $admin_user_perms = array(
    'access administration menu',
    'create url aliases',
    'administer menu',
    'administer nodes',
    'create page content',
    'delete any page content',
    'edit any page content',
    'revert revisions',
    'view revisions',
    'assign campaign coordinator role',
    'assign administrator role',
    'administer users',
    'access administration pages',
  );
  if (!db_result(db_query("SELECT rid FROM {permission} LEFT JOIN {role} USING (rid) WHERE name = '%s'", array(':role_name' => 'administrator')))) {
    db_query("INSERT INTO {permission} (rid, perm) VALUES (%d, '%s')", array(':rid' => $admin_rid, implode(', ', $admin_user_perms)));
    drupal_set_message(t("Set sensible defaults for %role role.", array('%role' => 'administrator')));
  }

  $team_leader_rid = array_search('campaign coordinator', $roles);
  $team_leader_user_perms = array(
    'create url aliases',
    'create page content',
    'delete own page content',
    'edit any page content',
    'revert revisions',
    'view revisions',
  );
  if (!db_result(db_query("SELECT rid FROM {permission} LEFT JOIN {role} USING (rid) WHERE name = '%s'", array(':role_name' => 'campaign coordinator')))) {
    db_query("INSERT INTO {permission} (rid, perm) VALUES (%d, '%s')", array(':rid' => $team_leader_rid, implode(', ', $team_leader_user_perms)));
    drupal_set_message(t("Set sensible defaults for %role role.", array('%role' => 'campaign coordinator')));
  }
}

/**
 * Initial settings for pathauto and path redirect.
 */
function _donor_rally_pathauto() {
  // Get rid of wonky content/foo pattern.
  // The rationale is that it's easier to bulk-update pathauto aliases
  // than it is to remove unwanted ones.
  // We leave this blank because there's no one-size-fits all pattern.
  variable_set('pathauto_node_pattern', '');
  // Remove story pattern.  Even though we didn't create a story type,
  // pathauto will insert this default anyway.
  variable_del('pathauto_node_story_pattern');

}

/**
 * Core customization.
 */
function _donor_rally_core() {
  // Change default anonymous to "Visitor".
  variable_set('anonymous', 'Visitor');
  
  // Increase the capacity of the Drupal watchdog.
  // The default of 1000 rows overflows too quickly, sometimes losing important
  // debug information.  100k rows is big, yet should still keep the watchdog
  // table under 10MB.
  variable_set('dblog_row_limit', 100000);
  
  // Set to open registration.
  variable_set('user_register', 1);

  // Disable all blocks.
  db_query("UPDATE {blocks} SET status = 0, region = ''");
}

/**
 * Additional modules to enable.
 */
function  _donor_rally_modules() {
  $modules = array(
    // Modules required by the features below.
    'boxes',
    'content_permissions',
    'content_profile',
    'content_profile_registration',
    'context',
    'dr_base',
    'fieldgroup',
    'filefield',
    'filefield_paths',
    'imageapi',
    'imageapi_gd',
    'imagecache',
    'imagefield',
    'imagefield_tokens',
    'jquery_ui',
    'location', // @TODO use something other than the location module.
    'number',
    'text',
    'views_bonus_export',
    'views_or',

    // Social networking modules.
    'forward',
    'forward_services',
    'general_services',
    'service_links',
    'shorten',
    'shorturl',

    // Donor Rally features.
    'dr_team', 'dr_blog', 'dr_social',
  );

  // Enable selected Donor Rally payment gateway.
  switch (variable_get('dr_base_payment_gateway', '')) {
    case 'dr_paypal':
      $modules = array_merge($modules, array(
        'simple_payments',
        'simple_payments_paypal',
        'dr_paypal',
      ));
      break;

    case 'dr_salsa':
      $modules = array_merge($modules, array(
        'salsa_api',
        'dr_salsa',
      ));
      break;
  }
    
  return $modules;
}

/**
 * Finished callback.
 */
function _donor_rally_profile_batch_finished($success, $results) {
  variable_set('install_task', 'donor-rally-configure');
}

/**
 * Clear and rebuild caches.
 */
function _donor_rally_clean() {
  // Remove 'profile' node type added by content_profile.
  node_type_delete('profile');

  // Since content_profile adds a value for this variable during
  // install, we must delete it here.
  variable_del('content_profile_profile');

  // Rebuild key tables/caches
  module_rebuild_cache(); // Detects the newly added bootstrap modules
  node_access_rebuild();
  drupal_get_schema(NULL, TRUE); // Clear schema DB cache
  drupal_flush_all_caches();    
  system_theme_data();  // Rebuild theme cache.
  _block_rehash();      // Rebuild block cache.
  views_invalidate_cache(); // Rebuild the views.
  menu_rebuild();       // Rebuild the menu.
  features_rebuild();   // Features rebuild scripts.
  node_access_needs_rebuild(FALSE);
}

/**
 * Configuration form.
 */
function donor_rally_configure_form(&$form_state, $url) {
  $form['#action'] = $url;
  $form['#redirect'] = FALSE;

  switch (variable_get('dr_base_payment_gateway', FALSE)) {
    case 'dr_paypal':
      drupal_set_title(st('Configure PayPal account'));
      $form['simple_payments_paypal_account'] = array(
        '#type' => 'textfield',
        '#title' => st('PayPal account e-mail'),
      );
      $form['submit'] = array(
        '#type' => 'submit',
        '#value' => st('Continue'),
      );

      if (variable_get('simple_payments_paypal_account', FALSE)) {
      }
      return $form;

      break;

    case 'dr_salsa':
      // @TODO
      drupal_set_title(st('Configure Salsa'));
      $form['#value'] = st('Not yet supported during install time.');
      return $form;
      break;
  }
}

/**
 * Submit handler for the configuration form.
 */
function donor_rally_configure_form_submit($form, &$form_state) {
  switch (variable_get('dr_base_payment_gateway', FALSE)) {
    case 'dr_paypal':
      variable_set('simple_payments_paypal_account', $form_state['values']['simple_payments_paypal_account']);
      variable_set('donor_rally_configured', TRUE);
      break;

    case 'dr_salsa':
      // @TODO
      variable_set('donor_rally_configured', TRUE);
      break;

    default:
      // No gateway selected, move on.
      variable_set('donor_rally_configured', TRUE);
  }
}

/**
 * Select the payment gateway.
 */
function donor_rally_payment_gateway_form(&$form_state, $url) {
  $form['#action'] = $url;
  $form['#redirect'] = FALSE;

  $form['dr_base_payment_gateway'] = array(
    '#type' => 'select',
    '#title' => st('Payment Gateway'),
    '#description' => st('Select the payment gateway to use for donations and reporting.'),
    '#required' => TRUE,
    '#options' => _donor_rally_get_payment_gateways(),
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => st('Continue'),
  );

  return $form;
}

/**
 * Validate form.
 */
function donor_rally_payment_gateway_form_validate($form, &$form_state) {
  if (!in_array($form_state['values']['dr_base_payment_gateway'], array_keys(_donor_rally_get_payment_gateways()))) {
    form_set_error('dr_base_payment_gateway', st('Invaled payment gateway: %gateway.', array('%gateway' => $form_state['values']['dr_base_payment_gateway'])));
  }
}

/**
 * Configuration form submit handler.
 */
function donor_rally_payment_gateway_form_submit($form, &$form_state) {
  drupal_set_message('Set Donor Rally payment gateway: %gateway', array('%gateway' => $form_state['values']['dr_base_payment_gateway']));
  variable_set('dr_base_payment_gateway', $form_state['values']['dr_base_payment_gateway']);
}

/**
 * Sitewide fundraising goal.
 */
function donor_rally_fundraising_goal($form_state) {
  $form['#redirect'] = FALSE;
  $form['dr_base_goal'] = array(
    '#type' => 'textfield',
    '#title' => st('Total Fundraising Goal'),
    '#description' => t('This will be used for the total on the site-wide thermometer.'),
    '#required' => TRUE,
    '#default_value' => variable_get('dr_base_goal', ''),
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => st('Continue'),
  );
  return $form;
}

/**
 * Sitewide fundraising goal submit handler.
 */
function donor_rally_fundraising_goal_submit($form, &$form_state) {
  variable_set('dr_base_goal', $form_state['values']['dr_base_goal']);
  variable_set('donor_rally_configured', TRUE);
}

function _donor_rally_get_payment_gateways() {
  return array(
    'dr_paypal' => st('PayPal'),
    'dr_salsa' => st('Salsa/Democracy in Action'),
  );
}

/**
 * Set Donor Rally as the default install profile.
 */
if (!function_exists('system_form_install_select_profile_form_alter')) {
  function system_form_install_select_profile_form_alter(&$form, $form_state) {
    foreach($form['profile'] as $key => $element) {
      $form['profile'][$key]['#value'] = 'donor_rally';
    }
  }
}