<?php
// $Id: petition.module,v 1.4 2006/07/17 17:20:33 morbus Exp $

/**
 * @file
 * Enables users to create online petitions and for other users to sign it. 
 */

/**
 * hook init is called even on cached pages, but we don't want to actually do anything in that case.
 */
function petition_init() {
  $path = drupal_get_path('module', 'petition');
  $mechanism = _petition_get_mechanism();  
  require_once("$path/petition_$mechanism.inc");
}

/**
 * Check if the petition is already signed. If it's signed - don't allow the user to sign it again. Return the current comment.
 */
function petition_is_signed($pid, $cid, &$comment) {
  $query = 
    db_query(
      "SELECT * FROM {petition_signatories} WHERE cid = %d AND pid = %d", 
      $cid, $pid);
  $row = db_fetch_object($query);   
  if ($row) {
    $comment = $row->comment;
    return TRUE;
  }
  return FALSE;
}

/**
 * Implementation of hook_help().
 */
function petition_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      return t('Enables users to create online petitions and for other users to sign it.');

    case 'node/add#petition':
      return t('Creates a new petition for users to sign and support.');
    case 'node/add/petition':
      return '<p>'.petition_help('node/add#petition').'</p>';

    case 'admin/petition':
      return '<p>'.t('You can view statistics about your petitions below.').'</p>';

    case 'admin/petition/comments/'.arg(3):
      return '<p>'.t('The following comments have been left about this petition:').'</p>';

    case 'admin/petition/signatories/'.arg(3):
      return '<p>'.t('The following people have signed this petition:').'</p>';

    case 'admin/petition/trending/'.arg(3):
      return '<p>'.t('The following is the number of people who signed this petition for each week:').'</p>';
  }
}

/**
 * Implementation of hook_perm().
 */
function petition_perm() {
  return array('create petition', 'respond to petition', 'access petition stats');
}

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

  if ($may_cache) {
    $items[] = array('title'   => t('petition'),
                     'path'    => 'node/add/petition',
                     'access'  => user_access('create petition'),
    );
    $items[] = array('title'    => t('petitions'),
                     'path'     => 'petition',
                     'callback' => 'petition_overview',
                     'access'   => user_access('respond to petition'),
    );
    $items[] = array('title'    => t('petition statistics'),
                     'path'     => 'admin/petition', 
                     'callback' => 'petition_results_overview',
                     'access'   => user_access('access petition stats'),
    );
    $items[] = array('title'    => t('comments'),
                     'path'     => 'admin/petition/comments', 
                     'callback' => 'petition_results_comments',
                     'access'   => user_access('access petition stats'),
                     'type'     => MENU_CALLBACK,
    );
    $items[] = array('title'    => t('signatories'),
                     'path'     => 'admin/petition/signatories', 
                     'callback' => 'petition_results_signatories',
                     'access'   => user_access('access petition stats'),
                     'type'     => MENU_CALLBACK,
    );
    $items[] = array('title'    => t('signatories (csv)'),
                     'path'     => 'admin/petition/signatories/csv',
                     'callback' => 'petition_results_signatories_csv',
                     'access'   => user_access('access petition stats'),
                     'type'     => MENU_CALLBACK,
    );
    $items[] = array('title'    => t('trending'),
                     'path'     => 'admin/petition/trending', 
                     'callback' => 'petition_results_trending',
                     'access'   => user_access('access petition stats'),
                     'type'     => MENU_CALLBACK,
    );
  }

  return $items;
}

/**
 * Implementation of hook_node_info().
 */
function petition_node_info() {
  return array('petition' => array('name' => t('petition'), 'base' => 'petition'));
}

/**
 * Implementation of hook_access().
 */
function petition_access($op, $node) {
  global $user;
  if ($op == 'create') {
    return user_access('create petition');
  }
  if ($op == 'update' || $op == 'delete') {
    if (user_access('edit petition') && ($user->uid == $node->uid)) {
      return TRUE;
    }
  }
}

/**
 * Implementation of hook_form().
 */
function petition_form(&$node) {

  $form['title'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Title'),
    '#required'      => TRUE,
    '#default_value' => $node->title,
  );
  $form['target'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Target'),
    '#default_value' => $node->target,
    '#description'   => t('The number of responses you are looking for from this petition.'),
    '#required'      => TRUE,
  );
  $form['body'] = array(
    '#type'          => 'textarea',
    '#title'         => t('Body'),
    '#default_value' => $node->body,
    '#description'   => t('The petition itself: what it is users are going to be supporting.'),
    '#required'      => TRUE,
    '#rows'          => 10,
  );
  $form['appeal'] = array(
    '#type'          => 'textarea',
    '#title'         => t('Appeal'),
    '#default_value' => $node->appeal,
    '#description'   => t('Explain why the petition is important and appeal to the users on why they should sign.'),
    '#required'      => TRUE,
    '#rows'          => 10,
  );
  $form['personal'] = array(
    '#type'          => 'textarea',
    '#title'         => t('Personal Message'),
    '#default_value' => $node->personal,
    '#description'   => t('An optional personal message, usually from the petition creators themselves.'),
    '#rows'          => 10,
  );
  $form['statistics'] = array(
    '#type'          => 'radios',
    '#title'         => 'Display Signee Statistics',
    '#default_value' => ($node->statistics ? $node->statistics : 0),
    '#options'       => array('No', 'Yes'),
    '#description'   => t('Controls whether or not public users can see the number of people who have signed this petition.'),
    '#required'      => TRUE,
  );
  $form['defaultibles'] = array(
    '#type'          => 'fieldset',
    '#collapsible'   => TRUE,
    '#title'         => t('Default Petition Settings'),
    '#description'   => t('If these settings are unchanged, they will use the defaults set by the administrator.'),
  );
  $form['defaultibles']['thank_you_page'] = array(
    '#type'          => 'textfield',
    '#title'         => t('"Thank You" Page'),
    '#default_value' => $node->thank_you_page,
    '#description'   => t('The path in your site to which users will be taken after completing a petition.'),
  );

  // emails enabled, so allow message customization.
  if (variable_get('petition_default_autorespond', 1)) {
    $wildcards = _petition_get_wildcards();

    $form['defaultibles']['autorespond_from'] = array(
      '#type'          => 'textfield',
      '#title'         => t('Email Auto-Respond From'),
      '#default_value' => $node->autorespond_from,
      '#description'   => t('Enter the email address that will appear in the "From: " header of sent messages.'),
    );
    $form['defaultibles']['autorespond_subject'] = array(
      '#type'          => 'textfield',
      '#title'         => t('Email Auto-Respond Subject'),
      '#default_value' => $node->autorespond_subject,
      '#description'   => t('Subject of auto-response email message to be sent. You may include the following wildcards: %wild.', array('%wild' => $wildcards)),
    );
    $form['defaultibles']['autorespond_message'] = array(
      '#type'          => 'textarea',
      '#title'         => t('Email Auto-Respond Message'),
      '#default_value' => $node->autorespond_message,
      '#description'   => t('Body of auto-response email message to be sent. You may include the following wildcards: %wild.', array('%wild' => $wildcards)),
    );
  }

  // the same format applies to all our boxes.
  $form['filter'] = filter_form($node->format);

  return $form;
}

/**
 * Implementation of hook_insert().
 */
function petition_insert($node) {
  db_query("INSERT INTO {petition} (nid, appeal, personal, target, statistics, thank_you_page, autorespond_from, autorespond_subject, autorespond_message) VALUES (%d, '%s', '%s', %d, %d, '%s', '%s', '%s', '%s')",
           $node->nid, $node->appeal, $node->personal, $node->target, $node->statistics, $node->thank_you_page, $node->autorespond_from, $node->autorespond_subject, $node->autorespond_message);
}

/**
 * Implementation of hook_update().
 */
function petition_update($node) {
  db_query("UPDATE {petition} SET appeal = '%s', personal = '%s', target = %d, statistics = %d, thank_you_page = '%s', autorespond_from = '%s', autorespond_subject = '%s', autorespond_message = '%s' WHERE nid = %d",
           $node->appeal, $node->personal, $node->target, $node->statistics, $node->thank_you_page, $node->autorespond_from, $node->autorespond_subject, $node->autorespond_message, $node->nid);
}

/**
 * Implementation of hook_delete().
 */
function petition_delete($node) {
  db_query('DELETE FROM {petition} WHERE nid = %d', $node->nid);
}

/**
 * Implementation of hook_load().
 */
function petition_load($node) {
  $content = db_fetch_object(db_query('SELECT * FROM {petition} WHERE nid = %d', $node->nid));
  if ($node->nid) { $content->signatures = petition_count_signatures($node->nid); }
  return $content;
}

/**
 * Implementation of hook_view().
 */
function petition_view(&$node, $teaser = FALSE, $page = FALSE) {
//  if ($page) {
    $form = array();
    petition_build_signup_form(&$node, &$form);
    $node->petition_signup_form = drupal_get_form('petition_signup_form_data', $form);
    
    // @@@ Move to theme
    if ($page) {
      $node->petition_signup_form = str_replace ('<label>', "<label style='float:right; padding-left:10px;'>", $node->petition_signup_form);
    }
    
//  } 
  // Check markups
  $node->body = check_markup($node->body, $node->format, FALSE);
  $node->teaser = check_markup($node->teaser, $node->format, FALSE);
  $node->appeal = check_markup($node->appeal, $node->format, FALSE);
  $node->personal = $node->personal ? check_markup($node->personal, $node->format, FALSE) : NULL;
  
  // Display the petition + sign data / sign form
  $node->body = theme('petition_view', $node);
}

/**
 * Registers that a user has signed a petition.
 */
function petition_register_signatory($pid, $cid, $comment = NULL) {
  $comment = check_markup($comment, FILTER_FORMAT_DEFAULT, FALSE);
  $check_sql = db_query("SELECT cid FROM {petition_signatories} WHERE cid = %d AND pid = %d", $cid, $pid);
  if (db_num_rows($check_sql) == 0) {
    $sql = db_query("INSERT INTO {petition_signatories} (pid, cid, created, comment) VALUES (%d, %d, %d, '%s')", $pid, $cid, time(), $comment);
  } else {
    $sql = 
      db_query(
        "UPDATE {petition_signatories} SET comment = '%s' WHERE cid = %d AND pid = %d", 
        $comment, 
        $cid, 
        $pid);
  }
}

/**
 * Displays the entire petition to the user.
 */
function theme_petition_view($node) {
  theme_add_style(drupal_get_path('module', 'petition').'/petition.css');
  $output  = '<div id="petition">';

  if ($node->statistics) {
    $output .= '<div id="petition_statistics">';
    $output .= t('%x of %y people have signed this petition.',
      array('%x' => $node->signatures, '%y' => $node->target));
    $output .= '</div>';
  }

  $output .= '<div id="petition_appeal">'.$node->appeal.'</div>';
  $output .= '<div id="petition_body">'.$node->body.'</div>';

  // if there is no personal message, our form takes up the width of the
  // entire page. If this is, however, then wel split the page in two
  // columns (via CSS): one for the signup form, and another for the message.
  if (!$node->personal) {
    $output .= '<div id="petition_signup_form">'.$node->petition_signup_form.'</div>';
  }
  else {
    $output .= '<div id="petition_group">';
    $output .=   '<div id="petition_personal">'.$node->personal.'</div>';
    $output .=   '<div id="petition_signup_form">'.$node->petition_signup_form.'</div>';
    $output .= '</div>';
  }

  $output .= '</div>';
  return $output;
}

/**
 * Displays a list of active petitions.
 */
function petition_overview() {
  $results = db_query('SELECT n.nid FROM {petition} p JOIN {node} n ON p.nid = n.nid');
  while ($row = db_fetch_object($results)){
    $content .= theme('petition_overview', node_load($row->nid));
  } return $content ? $content : t('No petitions have been defined.');
}

/**
 * Displays a petition on the petition overview page.
 */
function theme_petition_overview($node) {
  $output = '<div class="petition_overview">';
  $output .= '<h2>'.l($node->title, 'node/'.$node->nid).'</h2>';
  $output .= '<div class="petition_appeal">'.$node->appeal.'</div>';
  $output .= '<div class="petition_more">'.l(t('read more') . ' - ' . $node->title, 'node/'.$node->nid).'</div>';
  $output .= '</div>';
  return $output;
}

/**
 * Implementation of hook_settings().
 */
function petition_settings() {
  $form['petition'] = array(
    '#type'          => 'fieldset',
    '#title'         => t('Default Settings'),
  );
  $form['petition']['petition_default_goto_page'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Default "Thank You" Page'),
    '#default_value' => variable_get('petition_default_goto_page', 'node'),
    '#description'   => t('Enter the page users will be taken to after they sign a petition. This option can be overridden at the petition level.'),
  );
  $form['petition']['petition_default_autorespond'] = array(
    '#type'          => 'radios',
    '#title'         => t('Default Email Auto-Respond'),
    '#options'       => array(t('No'), t('Yes')),
    '#default_value' => variable_get('petition_default_autorespond', 1),
    '#description'   => t('Should petitions submitted through this site send an email auto-response to the signer?'),
  );

  // wildcards, like %thing, can be used to customize the email autoresponse.
  $wildcards = _petition_get_wildcards();
  
  $form['petition']['petition_default_autorespond_subject'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Default Email Auto-Respond Subject'),
    '#default_value' => variable_get('petition_default_autorespond_subject', t('Thanks for signing %petition_title')),
    '#description'   => t('Subject of auto-response email message to be sent. You may include the following wildcards: %wild.', array('%wild' => $wildcards)),
  );
  $form['petition']['petition_default_autorespond_message'] = array(
    '#type'          => 'textarea',
    '#title'         => t('Default Email Auto-Respond Message'),
    '#default_value' => variable_get('petition_default_autorespond_message', t('Thanks for signing this petition, %first_name!')),
    '#description'   => t('Body of auto-response email message to be sent. You may include the following wildcards: %wild.', array('%wild' => $wildcards)),
  );

  // The mechanism to use
  $form['petition']['petition_mechanism'] = array(
        '#type'          => 'radios',
        '#title'         => t('Mechanism for saving petition subscribers'),
        '#default_value' => variable_get('petition_mechanism', 1),
        '#options'       => array(t('CiviCRM'), t('Profile Fields')),
        '#description'   => t('Controls the mechanism in which your subscribers are saved.'),
        '#required'      => TRUE,
  );
   
  // Add more settings fields according to the current mechanism in use
  _petition_mechanism_settings(&$form);
  
  return $form;
}

/**
 * Overview of all petitions.
 */
function petition_results_overview() {
  $rows    = array();
  $headers = array(t('Title'), t('Comments'), t('Signatures'), t('Operations'));
  $results = pager_query('SELECT nid FROM {petition}', 50);
  while ($result = db_fetch_object($results)) { // we'll load in the count and the entire node itself.
    $count = db_query('SELECT COUNT(*) AS total FROM {petition_signatories} WHERE pid = %s AND comment != ""', $result->nid);
    $node = node_load($result->nid); $count = db_fetch_object($count);
    $rows[] = array(
      $node->title,
      $count->total,
      petition_count_signatures($node->nid).' '.t('(of %target)', array('%target' => $node->target)),
      l(t('Signatories'), 'admin/petition/signatories/'.$node->nid)
        .' | '. l(t('Trending'), 'admin/petition/trending/'.$node->nid)
        .' | '. l(t('Comments'), 'admin/petition/comments/'.$node->nid)
    );
  }

  $output .= theme('table', $headers, $rows);
  $output .= theme('pager', NULL, 50, 0);
  return $output;
}

/**
 * Display petition comments.
 */
function petition_results_comments($pid = NULL) {
  if (!is_numeric($pid)) { return NULL; } // no numbah, no winnings.

  $headers = array(t('ID'), t('Comment'));
  $results = 
    pager_query('SELECT cid, comment FROM {petition_signatories} WHERE pid = %d AND comment != ""', 25, 0, NULL, $pid);
  while ($result = db_fetch_object($results)) { // Display a link to the user's record
    $rows[] = array(_petition_get_userlink($result->cid), $result->comment); 
  }

  if (count($rows) == 0) { // no data, no happy ending!
    $rows[] = array(array('data' => t('No records were found.'), 'colspan' => 2));
  }

  $output .= theme('table', $headers, $rows);
  $output .= theme('pager', NULL, 25, 0);
  return $output;
}

/**
 * Signatories for a specific petition.
 */
function petition_results_signatories($pid = NULL) {
  $node = node_load($pid);
  $fields = _petition_get_fields();
  
  // build the headers
  $headers = array(t('ID'));
  foreach ($fields as $key => $value) {
    $headers[] = $value['title'];
  } 
  $headers[] = t('Date Signed');

  $rows = array();
  $results = pager_query(
    "SELECT cid, created FROM {petition_signatories} 
    WHERE pid = %d ORDER BY created", 
    50, 0, NULL, $pid);
  while ($result = db_fetch_object($results)) {
    $row = array(); // for this row only. 
    $row[] = _petition_get_userlink($result->cid);
    $values = _petition_get_values ($result->cid);
    
    foreach ($fields as $key => $value) {
      $row[] = $values[$key];
    } $row[] = format_date($result->created, 'small');
    $rows[] = $row;
  }

  $output  = '<h2>'.$node->title.'</h2>';
  $output .= l(t('Export this petition in CSV format'), 'admin/petition/signatories/csv/'.$pid);
  $output .= theme('table', $headers, $rows);
  $output .= theme('pager', NULL, 50);
  return $output;
}

/**
 * Displays a trending report.
 */
function petition_results_trending($pid = NULL) {
  $rows    = array();
  $headers = array(t('Week Starting'), t('Signatures'), t('Trend'));
  $results = db_query('SELECT COUNT(DISTINCT(cid)) AS signups, MAKEDATE(YEAR(NOW()), (WEEK(FROM_UNIXTIME(created)) * 7)-6) AS week_starting FROM {petition_signatories} WHERE pid = %d GROUP BY week_starting', $pid);

  $old_val = 0;
  while ($result = db_fetch_object($results)) {
    $row = array();
    $row['week_starting'] = $result->week_starting;
    $row['signatures']    = $result->signups;
    $row['trend'] = ($result->signups > $old_val)
      ? theme('petition_trend', 'pos', '+' . ($result->signups - $old_val))
      : theme('petition_trend', 'neg', '-' . ($old_val - $result->signups));
    $old_val = $result->signups;
    $rows[] = $row;
  }

  $node    = node_load($pid);
  $output  = '<h2>'.$node->title.'</h2>';
  $output .= theme('table', $headers, $rows);
  return $output;
}

/**
 * Themes the +/- of a trend report.
 *
 */
function theme_petition_trend($trend = 'pos', $data) {
  theme_add_style(drupal_get_path('module', 'petition').'/petition.css');
  $output = ($trend == 'pos')
    ? '<span class="trend_positive">'
    : '<span class="trend_negative">';
  $output .= "$data</span>";
  return $output;
}

/**
 * Returns number of a petition's signatures.
 */
function petition_count_signatures($pid = NULL) {
  $count = db_fetch_object(db_query("SELECT COUNT(cid) AS total FROM {petition_signatories} WHERE pid = %d", $pid));
  return $count->total;
}

/**
 * Signatories for a specific petition, exported as a CSV file
 * @param petition_id  - the ID of the petition
 * @return CSV File
 */
function petition_results_signatories_csv($petition_id) {
  $sort = $_GET;
  $petition = node_load($petition_id);

  // return a list of fields used in the petition signup form
  // turn the fields into headers on the form
  $fields = _petition_get_fields(); 
   
  // set up headers for the table
  // and fields for the CRM contact search
  foreach ($fields as $key => $field) {
    $header[] = $field['title'];
  }
  $header[] = 'Contact ID';
  $header[] = 'Date Signed';
  $headers = $header;

  $rows = array();

  $sql = db_query(
    db_rewrite_sql(
      "SELECT DISTINCT(cid), created FROM {petition_signatories} 
      WHERE pid = %d ORDER BY created"), 
      $petition_id);
  
  while($row = db_fetch_object($sql)){ 
    $field_values = _petition_get_values ($row->cid);
    foreach($fields as $key => $value){
      $signer[$key] = $field_values[$key];
    }
    $signer['cid'] = $row->cid;
    $signer['created'] = $row->created;
    $rows[] = $signer;
  }
  
  $filename = str_replace(' ', '_', $petition->title) .'_'. date("Y-m-d"). '.csv';

  $now       = gmdate('D, d M Y H:i:s') . ' GMT';
  $mime_type = 'text/x-csv';
  $ext       = 'csv';

  // send the write header statements to the browser
  header('Content-Type: ' . $mime_type); 
  header('Expires: ' . $now);

  // lem9 & loic1: IE need specific headers
  $isIE = strstr( $_SERVER['HTTP_USER_AGENT'], 'MSIE' );
  if ( $isIE ) {
      header('Content-Disposition: inline; filename="' . $filename . '"');
      header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
      header('Pragma: public');
  } else {
      header('Content-Disposition: attachment; filename="' . $filename . '"');
      header('Pragma: no-cache');
  }

  $result = '';

  $seperator     = ',';
  $enclosed      = '"';
  $escaped       = $enclosed;
  $add_character = "\015\012";
  
  $schema_insert = '';
  foreach ( $headers as $field ) {
    if ($enclosed == '') {
        $schema_insert .= stripslashes($field);
    } else {
        $schema_insert .=
              $enclosed
            . str_replace($enclosed, $escaped . $enclosed, stripslashes($field))
            . $enclosed;
    }
    $schema_insert     .= $seperator;
  } // end while

  // need to add PMA_exportOutputHandler functionality out here, rather than
  // doing it the moronic way of assembling a buffer

  $out = trim(substr($schema_insert, 0, -1)) . $add_character;
  echo $out;
  
  $i = 0;
  $fields_cnt = count($headers);
  
  foreach ( $rows as $row ) {
    
      $schema_insert = '';
      foreach ( $row as $j => $value ) {
        
        if (!isset($value) || is_null($value)) {
            $schema_insert .= '';
        } else if ($value == '0' || $value != '') {
            // loic1 : always enclose fields
            $value = ereg_replace("\015(\012)?", "\012", $value);
            if ($enclosed == '') {
                $schema_insert .= $value;
            } else {
                $schema_insert .=
                      $enclosed
                    . str_replace($enclosed, $escaped . $enclosed, $value)
                    . $enclosed;
            }
        } else {
            $schema_insert .= '';
        }
 
        if ($j < $fields_cnt-1) {
            $schema_insert .= $seperator;
        }
      } // end foreach

      $out = $schema_insert . $add_character;
      echo $out;
      ++$i;

  } // end for
  
}


/**
 * Hardwired into CiviCRM. Integer values are undocumented,
 * but used several places in the app. Likely to break soon.
 * @return array
 */
function _petition_location_types(){
  return array(
    1 => t('Home'),
    2 => t('Work'),
    3 => t('Main'),
    4 => t('Other')
  );
}

/*
 * Get petition profile field names, if we use the user's profile mechanism 
 */ 

/**
 * Get petition wildcard field names for the email messages- wrapper for mechanism details
 */
function _petition_get_wildcards() {  
  $wildcards = array('%petition_title'); // we'll use the node->title here when it comes time.
  $fields = _petition_get_fields(); // get public field names.
  foreach ($fields as $key => $value) { 
    $wildcards[] = "%$key"; 
  }
  $wildcards = implode(', ', $wildcards); // for #description display.
  return $wildcards;
}

/**
 * Get the mechanism currently used on petitions
 */
 
define('PETITION_USE_PROFILE', 'profile');
define('PETITION_USE_CIVICRM', 'civicrm');

function _petition_get_mechanism() {
  static $petition_mechanism;
  //see if the mechanism is already set.
  if (!isset ($petition_mechanism)) {
    $petition_mechanism = variable_get('petition_mechanism', PETITION_USE_PROFILE);
    if ($petition_mechanism == PETITION_USE_CIVICRM) {
      civicrm_initialize(true);
    }
  }
  return $petition_mechanism;  
}