modules/postcard/postcard.module

<?php
// $Id: postcard.module,v 1.26 2007/09/12 22:25:24 add1sun Exp $

/**
 * @file
 *  Allows the creation of postcards (image + text) and sends a link by email.
 *
 * @todo
 *  - Allow multiselect for galleries
 *  - Allow admin to pick picture size for creation and display
 *  - Give admin/user a link to all postcards sent
 *  - Email to sender when recipient views
 *  - Allow recipient to respond
 *  - Random pic block to "send postcards"
 *
 */

/**
 * Implementation of hook_perm().
 */
function postcard_perm() {
  return array('view postcards', 'send postcards');
}

/**
 * Implementation of hook_help().
 */
function postcard_help($section) {
  switch ($section) {
    case 'admin/help#postcard':
      return t('Allows a user to create postcards and send them to friends by e-mail. Note: to have a separate postcard gallery requires image and image_gallery modules to be installed and enabled.');
  }
}

/**
 * Implementation of hook_menu().
 */
function postcard_menu($may_cache) {
  $items = array();
  if ($may_cache) {
    $items[] = array(
      'path' => 'postcard',
      'title' => t('Postcards'),
      'callback' => 'postcard_page',
      'access' => user_access('view postcards'),
      'type' => MENU_SUGGESTED_ITEM,
    );
  }
  $items[] = array(
    'path' => 'admin/settings/postcard',
    'title' => t('Postcard'),
    'description' => t('Choose your postcard gallery and set default messages.'),
    'callback' => 'drupal_get_form',
    'callback arguments' => 'postcard_admin_settings',
    'access' => user_access('administer site configuration'),
    'type' => MENU_NORMAL_ITEM,
   );
  return $items;
}

/**
 * Form for the settings page.
 *
 * @return
 *  form
 */
function postcard_admin_settings() {

  $form['main'] = array(
    '#type' => 'fieldset',
    '#title' => t('Postcard details'),
  );
  if (module_exists('taxonomy')) {
    $terms[] = '<'. t('none') .'>';
    // TODO: we need to pick our vocab (taking into account the gallery stuff?)
    foreach (taxonomy_get_tree(5) as $term) {
     $terms[$term->tid] = str_repeat('--', $term->depth) . $term->name;
    }
    // TODO: allow multiselect
    $form['main']['postcard_term'] = array(
      '#type' => 'select',
      '#multiple' => false,
      '#title' => t('Image Galleries'),
      '#default_value' => variable_get('postcard_term', array()),
      '#options' => $terms,
      '#description' => t('Select top term of postcard image gallery. Select none for including all terms of the vocabulary.'),
    );
  } 
  ///////////////////////////////////////////////////////////////
  // get all of the sizes and presets and then put them in one select
  $image_sizes = array_keys(_image_get_sizes());
  $imagecache_presets = _imagecache_get_presets();
  $all_sizes = array_merge($image_sizes, $imagecache_presets);
  $sizes = drupal_map_assoc($all_sizes);
   
  if (module_exists('imagecache')) {
    $form['main']['postcard_size'] = array(
      '#type' => 'select',
      '#multiple' => false,
      '#title' => t('Postcard image size'),
      '#default_value' => variable_get('postcard_size', ''),
      '#options' => $sizes,
      '#description' => t('Select which size you would like to use for your postcards.'),
    );
  }
  //////////////////////////////////////////////////
  $form['letter'] = array(
    '#type' => 'fieldset',
    '#title' => t('Letter customization'),
  );
  $form['letter']['postcard_subject'] = array(
    '#type' => 'textfield',
    '#title' => t('Subject'),
    '#default_value' => variable_get('postcard_subject', 'Postcard from %site'),
    '#size' => 70,
    '#maxlength' => 70,
    '#description' => t('Custom subject for email which will be sent to the postcard recipient.'),
  );
  $form['letter']['postcard_letter'] = array(
    '#type' => 'textarea',
    '#title' => t('Body'),
    '#default_value' => variable_get('postcard_letter', _postcard_letter()),
    '#cols' => 70,
    '#rows' => 5,
    '#description' => t('This text is the body of the email that the card recipient will see.  These are the variables you may use: %site = your site name, %site_url = your site URL, %site_mail = your site email address, %card_url = the URL for the postcard, %sender = sender name, %user = sender site username, %recipient = recipient name, %postcards = URL of postcards page, %card_text = postcard message'),
  );
  
  $form['misc'] = array(
    '#type' => 'fieldset',
    '#title' => t('Miscellaneous settings'),
  );
  $form['misc']['postcard_cron'] = array(
    '#type' => 'textfield',
    '#title' => t('Days to keep postcards'),
    '#description' => t('Postcards that are aged more than the number of days entered above will automatically be deleted from the database. Use 0 to never delete. Note that this will only be checked when cron.php is run.'),
    '#size' => '2',
    '#default_value' => variable_get('postcard_cron', '0'),
  );
  $form['misc']['postcard_send'] = array(
    '#type' => 'checkbox',
    '#title' => '<strong>'. t('Show "Send this as a postcard" link') .'</strong>',
    '#description' => t('Checking this box will make a "Send this as a postcard" link appear with the other links under the image for nodes that fall within the postcard gallery selected above.'),
    '#default_value' => variable_get('postcard_send', 1),
  );
  $form['misc']['postcard_help'] = array(
    '#type' => 'textarea',
    '#title' => t('Explanation or submission guidelines'),
    '#default_value' => variable_get('postcard_help', ''),
    '#cols' => 70,
    '#rows' => 5,
    '#description' => t('This text will be displayed at the top of the postcard creation form.  It is useful for helping or instructing your users.'),
  );

  return system_settings_form($form);
}

/**
 * Display the postcard page
 *
 * @param $arg1, $arg2, $arg3
 *  URL arguments
 */

function postcard_page($arg1=0, $arg2=0, $arg3=0) {
  global $user;
  $breadcrumb[] = l(t('Home'), NULL);
  $breadcrumb[] = l(t('Postcards'), 'postcard');
	// check permissions
  if (!user_access('view postcards') && !user_access('send postcards')) {
    return drupal_access_denied();
  }
	// are we dealing with postcard stuff?
  if (arg(0) == 'postcard' && is_numeric($arg1)) {
    $nid = $arg1;
		// do we have a postcard, if so, show it baby
    if (!empty($arg2)) {
      // check permissions
      if (!user_access('view postcards') && !($user->uid && ($card->uid == $user->uid))) {
        return drupal_access_denied();
      }
      // view a postcard
      $card = db_fetch_object(db_query("SELECT p.pid, p.nid, p.uid, p.sender_name, p.sender_mail, p.recp_name, p.recp_mail, p.body, p.send_time, f.nid, f.filepath FROM {postcard} p INNER JOIN {files} f ON p.nid = f.nid INNER JOIN {node} n ON n.nid = p.nid  WHERE p.pid = '%s'", $arg2));
        $title = t('A Postcard for you');
        $output = theme('postcard_image', $card);
      if (isset($card)) {
        // don't do this if the sender is reviewing the card
        if (empty($arg3)) {
          if (empty($card->recp_time)) {
            $update[] = "recp_time = ". time();
          }
        $update[] = "count_view =". ($card->count_view + 1);
        db_query("UPDATE {postcard} SET ". implode(', ', $update) ." WHERE pid = '". $card->pid ."'");
       }
    }
    else {
      $title = t('Postcard not found');
      $output = t('Requested postcard not found. It was probably too old and was deleted from the site. Sorry.');
    }
  }
	// create a postcard
  else {
    // check permissions to make postcards
    if (!user_access('send postcards')) {
      return drupal_access_denied();
    }
    $title = t('Create your postcard');
    
    // find taxonomy and create breadcrumbs for page
    // TODO: this can't be a hard-coded vocab :p
    $terms = taxonomy_node_get_terms_by_vocabulary($nid, 5);
    $term = array_pop($terms);
    if (isset($term)) {
      // TODO: same here (vocab)
      $vocabulary = taxonomy_get_vocabulary(5);
      // Breadcrumb navigation
      if ($parents = taxonomy_get_parents_all($term->tid)) {
        $parents = array_reverse($parents);
        foreach ($parents as $parent) {
          $breadcrumb[] = l($parent->name, 'postcard/tid/'. $parent->tid);
        }
      }
    }
    // display help text if we have any
    $helptext = variable_get('postcard_help', '');
    if (!empty($helptext)) {
      $output .= '<div class="help">'. filter_xss_admin($helptext) .'</div>';
    }
    //////////////////////////////////////////////////
    // display the image we are using for the postcard
    // if the image is from image module use that
    //if (module_exists('image')) {
     // $node = node_load(array('nid' => $nid));
    //  $output .= image_display($node, variable_get('postcard_size', 'preview'));
    //}
    // otherwise see if they are using imagecache and use that
    // get the image info we need
    $image = db_fetch_object(db_query("SELECT nid, filepath FROM {files} WHERE nid = %d", $nid));
    if (module_exists('imagecache')) {
      $output .= theme('imagecache', variable_get('postcard_size', ''), $image->filepath);
    }
    //$output .= dsm($sizes);
    //////////////////////////////////////////////////
    // get our postcard creation form
    $output .= drupal_get_form('postcard_create_form');
    }
  }
	// if no postcard to display, then show us the postcard gallery
  else {
    // this will require image_gallery module
    if (!module_exists('image_galley')) {
      return 'There are no postcard galleries available.';
    }
    else {
      // check permissions
      if (!user_access('send postcards')) {
          return drupal_access_denied();
      }

      $tid = $arg2 ? $arg2: variable_get('postcard_term', 0);

      // show galleries
      $galleries = taxonomy_get_tree(_image_gallery_get_vid(), $tid, -1, 1);
      for ($i=0; $i < count($galleries); $i++) {
        $galleries[$i]->count = taxonomy_term_count_nodes($galleries[$i]->tid, 'image');
        $tree = taxonomy_get_tree(_image_gallery_get_vid(), $galleries[$i]->tid, -1);
        $descendant_tids = array_merge(array($galleries[$i]->tid), array_map('_taxonomy_get_tid_from_term', $tree));
        $last = db_fetch_object(db_query_range(db_rewrite_sql('SELECT n.nid FROM {node} n INNER JOIN {term_node} tn ON n.nid = tn.nid WHERE tn.tid IN (%s) AND n.status = 1 ORDER BY n.sticky DESC, n.created DESC'), implode(',', $descendant_tids), 0, 1));
        $galleries[$i]->latest = node_load(array('nid' => $last->nid));
      }
      // show images
      $images = array();
      if (isset($tid)) {
        $result = pager_query(db_rewrite_sql("SELECT n.nid FROM {term_node} t INNER JOIN {node} n ON t.nid=n.nid WHERE n.status=1 AND n.type='image' AND t.tid=%d ORDER BY n.sticky DESC, n.created DESC"), variable_get('image_images_per_page', 6), 0, NULL, $tid);
        while ($node = db_fetch_object($result)) {
          $images[] = node_load(array('nid' => $node->nid));
        }
      }
      // set the page title to the gallery name
      $gallery = taxonomy_get_term($tid);
      $title = $gallery->name;
      // set breadcrumbs
      $parents = taxonomy_get_parents_all($tid);
      array_shift($parents);
      $parents = array_reverse($parents);
      foreach ($parents as $parent) {
        $breadcrumb[] = l($parent->name, 'postcard/tid/'. $parent->tid);
      }
      $output = theme('postcard_gallery', $galleries, $images);
    }
  }


  // prepare the page for printing
  drupal_set_title($title);
  drupal_set_breadcrumb($breadcrumb);

  // print the page
  return $output;
}

/**
 * Form to create a new postcard
 *
 * @return
 *  form to render
 */
function postcard_create_form() {
  global $user;
  $sndr_name = $user->name;
  $sndr_mail = $user->mail;
  $form['field_rcpt'] = array(
    '#type' => 'textfield',
    '#title' => t('Name of recipient'),
    '#size' => 60,
    '#maxlength' => 64,
    '#required' => TRUE,
  );
  $form['field_to'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail(s) of recipient(s)'),
    '#size' => 60,
    '#maxlength' => 64,
    '#required' => TRUE,
    '#description' => t('You may enter multiple emails separated by a comma (,).'),
  );
  $form['field_sndr'] = array(
    '#type' => 'textfield',
    '#title' => t('Your full name'),
    '#default_value' => $sndr_name,
    '#size' => 60,
    '#maxlength' => 64,
    '#required' => TRUE,
  );
  $form['field_from'] = array(
    '#type' => 'textfield',
    '#title' => t('Your email'),
    '#default_value' => $sndr_mail,
    '#size' => 60,
    '#maxlength' => 64,
    '#required' => TRUE,
  );
  $form['field_nid'] = array(
    '#type' => 'value',
    '#value' => arg(1),
  );
  $form['field_body'] = array(
    '#type' => 'textarea',
    '#title' => t("Message"),
    '#cols' => 64,
    '#rows' => 15,
    '#required' => TRUE,
  );
  // CC sender upon request.
  $form['send_copy'] = array(
  '#type' => 'checkbox',
  '#title' => t('Send yourself a copy.'),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Send Postcard'),
  );
  return $form;
}

/**
 * Implementation of hook_validate().
 */
function postcard_create_form_validate($form_id, $form_values) {
  // split it up if we have muliple emails
  $emails = explode(',', $form_values['field_to']);
  foreach ($emails as $email) {
    if (!valid_email_address(trim($email))) {
      form_set_error('', t('E-mail for recipient @email is invalid.', array('@email' => $email)));
    }
  }
  if (!valid_email_address($form_values['field_from'])) {
    form_set_error('', t('Your e-mail address is invalid'));
  }
  if ($form_values['field_nid'] == '' || !is_numeric($form_values['field_nid'])) {
    form_set_error('', t('Image not selected. Select image again and refill form fields.'));
  }
}

/**
 * Send postcard link by email and insert data
 *
 * Implementation of hook_submit().
 */
function postcard_create_form_submit($form_id, $form_values) {
  global $user, $base_url;
  // the nid of the postcard
  $arg = arg(1);
  // set our email variables
  $name = $form_values['field_sndr'];
  $from = $form_values['field_from'];
  $to = $form_values['field_to'];
  unset($postid);
  while (!$postid) {
    $postid = strtr(substr(crypt(microtime(), $user->uid), 2), '/\|$^&.,;?+=!@#$%^&*()', '_-_-_-_-_-_-_-_-_-_-_-');
    $result = db_fetch_object(db_query("SELECT nid FROM {postcard} WHERE pid = '%s'", $postid));
    if ($result) unset($postid);
  }
  // set the base variable from the clean url value
  if (variable_get('clean_url', 0)) {
    $base = $base_url .'/';
  }
  else {
    $base = $base_url .'/index.php?q=';
  }
  // set the variables
  $variables = array('%site' => variable_get('site_name', 'drupal'), '%site_url' => $base_url, '%site_mail' => variable_get('site_mail', 'root@localhost'), '%card_url' => $base .'postcard/'. $form_values['field_nid'] .'/'. $postid, '%sender' => $name, '%user' => $user->name, '%recipient' => $form_values['field_rcpt'], '%postcards' => $base .'postcard', '%card_text' => $form_values['field_body']);
  $body = strtr(variable_get('postcard_letter', _postcard_letter()), $variables);
  $subject = strtr(variable_get('postcard_subject', 'Postcard from %site'), $variables);
  $subject = mime_header_encode($subject, 'UTF-8');
  $send_date = time();
  // set headers to bcc: sender if selected
  if ($form_values['send_copy']) {
    $headers = array( 'bcc' => $from );
  }

  // insert our data into the db
  db_query("INSERT INTO {postcard} (pid, nid, uid, sender_name, sender_mail, recp_name, recp_mail, body, send_time) VALUES ('%s', %d, %d, '%s', '%s', '%s', '%s', '%s', %d)", $postid, $form_values['field_nid'], $user->uid, $name, $from, $form_values['field_rcpt'], $to, $form_values['field_body'], $send_date);

  // send the card and return a message for the user
  if (isset($postid)) {
    // email it out
    if (!empty($headers)) {
      drupal_mail('postcard', $to, $subject, $body, $from, $headers);
    }
    else {
      drupal_mail('postcard', $to, $subject, $body, $from);
    }
    // log it
    watchdog('postcard', t('User %name sent a postcard to %recipient.', array('%name' => $user->name, '%recipient' => $to)));
    $output .= t('Your postcard was sent! %recipient will get a message by email with a link to your picture and message. ', array('%recipient' => $form_values['field_rcpt']));
    $output .= l(t('View sent postcard.'), "postcard/$arg/$postid/review");
  }
	// there was a problem here, Houston
  else {
    watchdog('postcard', t('There was a problem creating a postcard.  The $postid variable was not set.'));
    $output .= t('There was a problem creating your card!  Please contact the site administrator.');
  }
  drupal_set_message($output);
  // TODO: dont always want to go back here....
  drupal_goto('postcard');
}

/**
 * Implementation of hook_link().
 *
 * This adds the "send this as a postcard" link to an Image node.
 **/
function postcard_link($type) {
  if (user_access('send postcards')) {
    if (variable_get('postcard_send', 1) == 1) {
      $links = array();
      $terms = array();

      if ($type = 'node' && is_numeric(arg(1))) {
        // get the taxonomy info from the node object
        $node = node_load(arg(1));
        $taxonomy = array_keys($node->taxonomy);
        foreach ($taxonomy as $tid) {
          $terms[] = $tid;
          // get the parent(s) as well
          $parents = taxonomy_get_parents($tid);
          foreach ($parents as $parent) {
            $terms[] = $parent->tid;
          }
        }
        
        // If the node term, a parent term or all terms are in 
        // the postcard variable, make a postcard link.
        if (in_array(variable_get('postcard_term', 0), $terms) || (variable_get('postcard_term', 0) == 0)) {
          $links['send_postcard'] = array(
            'title' => t('Send this as a postcard'),
            'href' => 'postcard/'. $node->nid,
          );
          
          return $links;      
        }
      }
    }
  }
}


/**
 * Implementation of hook_cron().
 **/
function postcard_cron() {
  // convert cron days into timestamp
  $postcard_cron = variable_get('postcard_cron', '0') * 86400;
  // delete postcards older than setting
  if (!empty($postcard_cron)) {
  db_query('DELETE FROM {postcard} WHERE send_time < %d', time() - $postcard_cron);
  }
}

/**
 * Set up the standard letter
 *
 * This is done so that there is a default reusable, translatable string 
 * for the letter even without visiting the settings page.
 **/
function _postcard_letter() {
  $output = t("Dear %recipient!\n\n%sender made an e-postcard for you.\nAt any time you may see your card by clicking this link:\n\n%card_url\n\n(if your email client doesn't allow you to click on the site link,\nthen just copy and paste the URL into your browser)\n\nAny complaints about this e-postcard service please send to %site_mail\n\n-- \nThis postcard was sent through %site");
  return $output;
}

/**
 * Theme a gallery page (taken from theme_image_gallery)
 *
 * @return
 *  HTML for postcard gallery
 */
function theme_postcard_gallery($galleries, $images) {
  drupal_add_css(drupal_get_path('module', 'image_gallery') .'/image_gallery.css');

  // This check is needed due to an api change in image module at 5.x-1.3.
  if (function_exists('_image_get_sizes')) {
    $size = _image_get_sizes('thumbnail');
  }
  else {
    $size = _image_get_dimensions('thumbnail');
  }
  $width = $size['width'];
  $height = $size['height'];

  $content = '';
  if (count($galleries)) {
    $content .= '<ul class="galleries">';
    foreach ($galleries as $gallery) {
      $content .= '<li>';
      if ($gallery->count)
      $content .= l(image_display($gallery->latest, 'thumbnail'), 'postcard/tid/'. $gallery->tid, array(), NULL, NULL, FALSE, TRUE);
      $content .= "<h3>". l($gallery->name, 'postcard/tid/'. $gallery->tid) ."</h3>\n";
      $content .= '<div class="description">'. check_markup($gallery->description) ."</div>\n";
      $content .= '<p class="count">'. format_plural($gallery->count, 'There is 1 image in this gallery', 'There are @count images in this gallery') ."</p>\n";
      if ($gallery->latest->changed) {
        $content .= '<p class="last">'. t('Last updated: %date', array('%date' => format_date($gallery->latest->changed))) ."</p>\n";
      }
      $content .= "</li>\n";
    }
    $content .= "</ul>\n";
  }

  if (count($images)) {
    $height += 75;
    $content .= '<ul class="images">';
    foreach ($images as $image) {
      $content .= '<li';
      if ($image->sticky) {
        $content .= ' class="sticky"';
      }
      $content .= ' style="height : '. $height .'px; width : '. $width .'px;"';
      $content .= ">\n";
      $content .= l(image_display($image, 'thumbnail'), 'postcard/'. $image->nid, array(), NULL, NULL, FALSE, TRUE);
      $content .= '<h3>'. l($image->title, 'postcard/'. $image->nid) ."</h3>";
      if (variable_get('image_gallery_node_info', 0)) {
        $content .= '<div class="author">'. t('Posted by: !name', array('!name' => theme('username', $image))) ."</div>\n";
        if ($image->created > 0) {
          $content .= '<div class="date">'. format_date($image->created) ."</div>\n";
        }
      }
      $content .= "</li>\n";
    }
    $content .= "</ul>\n";
  }

  if ($pager = theme('pager', NULL, variable_get('image_images_per_page', 6), 0)) {
    $content .= $pager;
  }

  if (count($images) + count($galleries) == 0) {
      $content .= '<p class="count">'. format_plural(0, 'There is 1 image in this gallery', 'There are @count images in this gallery') ."</p>\n";
  }

  return $content;
}


/**
 * Theme function for a single postcard.
 *
 * To change the image size for all postcards, change 'preview' in the
 * image_display function below to a size label that you have listed in your
 * Image module image sizes setting at admin/settings/image
 *
 * @return
 *  HTML for postcard node
 */
function theme_postcard_image($card) {
  // get the node and user info
  $node = node_load(array('nid' => $card->nid));
  $account = user_load(array('uid' => $card->uid));
  // build the postcard page
  //////////////////////////////////////////////////
  // display the image we are using for the postcard
  // if the image is from image module use that
  //if (module_exists('image')) {
   // $node = node_load(array('nid' => $nid));
  //  $output .= image_display($node, variable_get('postcard_size', 'preview'));
  //}
  // otherwise see if they are using imagecache and use that
  // get the image info we need
  $image = db_fetch_object(db_query("SELECT nid, filepath FROM {files} WHERE nid = %d", $card->nid));
  if (module_exists('imagecache')) {
    $output .= theme('imagecache', variable_get('postcard_size', ''), $image->filepath);
  }
  //$output .= dsm($sizes);
  //////////////////////////////////////////////////
  $output .= '<br />'. t('To: ') . check_plain($card->recp_name);
  $output .= '<hr />'. check_plain($card->body) .'<hr />';
  // this shows the user picture if the "display in node" setting is checked on the theme
  if (theme_get_setting('toggle_node_user_picture')) {
    $output .= theme('user_picture', $account);
  }
  $output .= t('Sent: ') . format_date($card->send_time);
  $output .= '<br />'. t('From: ') . check_plain($card->sender_name);
  $output .= '<br />'. t('Email: ') . check_plain($card->sender_mail);
  return $output;
}