pierre@0: <?php
pierre@1: // $Id: ad_text.module,v 1.2.2.7.2.24.2.13.2.3 2009/03/31 04:41:03 jeremy Exp $
pierre@0: 
pierre@0: /**
pierre@0:  * @file
pierre@0:  * Enhances the ad module to support static text ads.
pierre@0:  *
pierre@0:  * Copyright (c) 2005-2009.
pierre@0:  *   Jeremy Andrews <jeremy@tag1consulting.com>.
pierre@0:  */
pierre@0: 
pierre@0: /**
pierre@0:  * Function used to display the selected ad.
pierre@0:  */
pierre@0: function ad_text_display_ad($ad) {
pierre@0:   return theme('ad_text_ad', $ad);
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Return a themed ad of type ad_text.
pierre@0:  *
pierre@0:  * @param @ad
pierre@0:  *   The ad object.
pierre@0:  * @return
pierre@0:  *   A string containing the ad markup.
pierre@0:  */
pierre@0: function theme_ad_text_ad($ad) {
pierre@0:   if (isset($ad->aid)) {
pierre@1:     if (!isset($ad->adheader)) {
pierre@1:       $ad = node_load($ad->aid);
pierre@1:     }
pierre@0:     $output = '<div class="text-advertisement" id="ad-'. $ad->aid .'">';
pierre@0:     if (isset($ad->url) && !empty($ad->url)) {
pierre@0:       $output .= theme('ad_text_text', ad_text_display_prepare($ad->adheader, $ad->format), ad_text_display_prepare($ad->adbody, $ad->format), $ad->redirect .'/@HOSTID___');
pierre@0:     }
pierre@0:     else {
pierre@0:       $output .= theme('ad_text_text', ad_text_display_prepare($ad->adheader, $ad->format), ad_text_display_prepare($ad->adbody, $ad->format));
pierre@0:     }
pierre@0:     $output .= '</div>';
pierre@0:     return $output;
pierre@0:   }
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Return a themed text ad.
pierre@0:  *
pierre@0:  * @param $header
pierre@0:  *  The header of the text ad.
pierre@0:  * @param $body
pierre@0:  *  The body of the text ad.
pierre@0:  * @param $link
pierre@0:  *  Optional link URL for header.
pierre@0:  * @return
pierre@0:  *  A string containing the text ad.
pierre@0:  */
pierre@0: function theme_ad_text_text($header, $body, $link = NULL) {
pierre@0:   $output  = '<div class="ad-header">';
pierre@0:   if (isset($link) && !empty($link)) {
pierre@0:     $output .= l($header, $link, array('attributes' => ad_link_attributes(), 'html' => TRUE));
pierre@0:   }
pierre@0:   else {
pierre@0:     $output .= $header;
pierre@0:   }
pierre@0:   $output .= '</div>';
pierre@0:   $output .= '<div class="ad-body">'. $body .'</div>';
pierre@0:   return $output;
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Strip illegal characters, apply input filters, then encode the rest UTF-8.
pierre@0:  */
pierre@0: function ad_text_display_prepare($string, $format) {
pierre@0:   $string = preg_replace("/[\b\f\n\r\t]/", ' ', $string);
pierre@0:   $string = check_markup($string, $format, FALSE);
pierre@0:   return $string;
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Implementation of hook_theme().
pierre@0:  */
pierre@0: function ad_text_theme() {
pierre@0:   return array(
pierre@0:     'ad_text_ad' => array(
pierre@0:       'file' => 'ad_text.module',
pierre@0:       'arguments' => array(
pierre@0:         'ad' => NULL,
pierre@0:       ),
pierre@0:     ),
pierre@0:     'ad_text_text' => array(
pierre@0:       'file' => 'ad_text.module',
pierre@0:       'arguments' => array(
pierre@0:         'header' => NULL,
pierre@0:         'body' => NULL,
pierre@0:         'link' => NULL,
pierre@0:       ),
pierre@0:     ),
pierre@0:   );
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Implementation of hook_help().
pierre@0:  */
pierre@0: function ad_text_help($path, $arg) {
pierre@0:   $output = '';
pierre@0:   switch ($path) {
pierre@0:     case 'node/add/ad#text':
pierre@0:       $output = t('A text advertisement.');
pierre@0:       break;
pierre@0:   }
pierre@0:   return $output;
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Implementation of hook_access().
pierre@0:  */
pierre@0: function ad_text_access($op, $node, $account) {
pierre@0:   return ad_access($op, $node, $account);
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Text ad settings form.
pierre@0:  */
pierre@0: function ad_text_global_settings($form_state) {
pierre@0:   $form = array();
pierre@0: 
pierre@0:   $form['header_min'] = array(
pierre@0:     '#type' => 'textfield',
pierre@0:     '#title' => t('Header minimum length'),
pierre@0:     '#size' => 3,
pierre@0:     '#maxlength' => 3,
pierre@0:     '#default_value' => variable_get('header_min', 0),
pierre@0:     '#description' => t('Optionally specify the minimum number of characters allowed in the header of a text ad.  Set to <em>0</em> to specify no minimum length.'),
pierre@0:   );
pierre@0:   $form['header_max'] = array(
pierre@0:     '#type' => 'textfield',
pierre@0:     '#title' => t('Header maximum length'),
pierre@0:     '#size' => 3,
pierre@0:     '#maxlength' => 3,
pierre@0:     '#default_value' => variable_get('header_max', 0),
pierre@0:     '#description' => t('Optionally specify the maximum number of characters allowed in the header of a text ad.  Set to <em>0</em> to specify no maximum length.'),
pierre@0:   );
pierre@0:   $form['body_min'] = array(
pierre@0:     '#type' => 'textfield',
pierre@0:     '#title' => t('Body minimum length'),
pierre@0:     '#size' => 10,
pierre@0:     '#maxlength' => 10,
pierre@0:     '#default_value' => variable_get('body_min', 0),
pierre@0:     '#description' => t('Optionally specify the minimum number of characters allowed in the body of a text ad.  Set to <em>0</em> to specify no minimum length.'),
pierre@0:   );
pierre@0:   $form['body_max'] = array(
pierre@0:     '#type' => 'textfield',
pierre@0:     '#title' => t('Body maximum length'),
pierre@0:     '#size' => 10,
pierre@0:     '#maxlength' => 10,
pierre@0:     '#default_value' => variable_get('body_max', 0),
pierre@0:     '#description' => t('Optionally specify the maximum number of characters allowed in the body of a text ad.  Set to <em>0</em> to specify no maximum length.'),
pierre@0:   );
pierre@0: 
pierre@0: 
pierre@0:   $form['save'] = array(
pierre@0:     '#type' => 'submit',
pierre@0:     '#value' => t('Save'),
pierre@0:   );
pierre@0: 
pierre@0:   return $form;
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Settings form validation handler.
pierre@0:  */
pierre@0: function ad_text_global_settings_validate($form, &$form_state) {
pierre@0:   if ((int)$form_state['values']['header_min'] > (int)$form_state['values']['header_max']) {
pierre@0:     form_set_error('header_min', t('The header minimum length can not be greater than the header maximum length.'));
pierre@0:   }
pierre@0:   if ((int)$form_state['values']['body_min'] > (int)$form_state['values']['body_max']) {
pierre@0:     form_set_error('body_min', t('The body minimum length can not be greater than the body maximum length.'));
pierre@0:   }
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Settings form submit handler.
pierre@0:  */
pierre@0: function ad_text_global_settings_submit($form, &$form_state) {
pierre@0:   variable_set('header_min', $form_state['values']['header_min']);
pierre@0:   variable_set('header_max', $form_state['values']['header_max']);
pierre@0:   variable_set('body_min', $form_state['values']['body_min']);
pierre@0:   variable_set('body_max', $form_state['values']['body_max']);
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Implementation of hook_adapi().
pierre@0:  */
pierre@0: function ad_text_adapi($op, &$node) {
pierre@0:   switch ($op) {
pierre@0:     case 'load':
pierre@0:       $return = db_fetch_array(db_query('SELECT aid, url, adheader, adbody FROM {ad_text} WHERE aid = %d', $node['aid']));
pierre@0:       $return['ad'] = ad_text_display_prepare($return['adheader'], $node['format']) .'<br />'. ad_text_display_prepare($return['adbody'], $node['format']);
pierre@0:       return $return;
pierre@0: 
pierre@0:     case 'insert':
pierre@0:       db_query("INSERT INTO {ad_text} (aid, url, adheader, adbody) VALUES(%d, '%s', '%s', '%s')", $node->nid, $node->url, $node->adheader, $node->adbody);
pierre@0:       break;
pierre@0: 
pierre@0:     case 'update':
pierre@1:       if (ad_permission($node->nid, 'manage ad text')) {
pierre@0:         db_query("UPDATE {ad_text} SET url = '%s', adheader = '%s', adbody = '%s' WHERE aid = %d", $node->url, $node->adheader, $node->adbody, $node->nid);
pierre@0:       }
pierre@0:       break;
pierre@0: 
pierre@0:     case 'delete':
pierre@0:       db_query('DELETE FROM {ad_text} WHERE aid = %d', $node->nid);
pierre@0:       break;
pierre@0: 
pierre@0:     case 'form':
pierre@0:       return ad_text_node_form($node);
pierre@0: 
pierre@0:     case 'view':
pierre@0:       return ad_text_node_view($node);
pierre@0: 
pierre@0:     case 'redirect':
pierre@0:       return db_result(db_query('SELECT url FROM {ad_text} WHERE aid = %d', $node->nid));
pierre@0: 
pierre@0:     case 'validate':
pierre@0:       $todo = array();
pierre@0:       return ad_text_node_validate($node, $todo);
pierre@0: 
pierre@0:     case 'type':
pierre@0:       return array(
pierre@0:         'text' => array(
pierre@0:           'name' => t('Text ad'),
pierre@0:           'module' => 'ad_text',
pierre@0:           'description' => t('A text advertisement.'),
pierre@0:           'help' => t('A text advertisement.'),
pierre@0:         ),
pierre@0:       );
pierre@0: 
pierre@0:     case 'permissions':
pierre@0:       if (!isset($node->adtype) || $node->adtype == 'text') {
pierre@1:         return array('manage ad text' => TRUE);
pierre@0:       }
pierre@0:   }
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Adapi helper function for displaying a node form.
pierre@0:  */
pierre@0: function ad_text_node_form(&$node) {
pierre@0:   $form = array();
pierre@0: 
pierre@0:   $form['ad_text'] = array(
pierre@0:     '#type' => 'fieldset',
pierre@0:     '#title' => t('Text'),
pierre@0:     '#collapsible' => TRUE,
pierre@0:   );
pierre@0: 
pierre@1:   if (arg(1) == 'add' && user_access('create advertisements') || ad_permission($node->nid, 'manage ad text')) {
pierre@0:     $access = TRUE;
pierre@0:   }
pierre@0:   else {
pierre@0:     $access = FALSE;
pierre@0:     $form['ad_text']['notice'] = array(
pierre@0:       '#type' => 'markup',
pierre@0:       '#value' => '<p>'. t('You do not have permission to edit this advertisement.') .'</p>',
pierre@0:     );
pierre@0:   }
pierre@0: 
pierre@0:   $form['ad_text']['text'] = array(
pierre@0:     '#type' => 'markup',
pierre@0:     '#value' => ad_text_display_ad($node),
pierre@0:   );
pierre@0: 
pierre@0:   $form['ad_text']['url'] = array(
pierre@0:     '#type' => 'textfield',
pierre@0:     '#title' => t('Destination URL'),
pierre@0:     '#maxlength' => 255,
pierre@0:     '#default_value' => isset($node->url) ? $node->url : '',
pierre@0:     '#description' => t('Enter the complete URL where you want people to be redirected when they click on this advertisement.  The URL must be valid and begin with http:// or https://, for example %url, unless you !disable.  If you do not enter a URL, the advertisement will not be clickable.', array('%url' => t('http://www.sample.org/'), '!disable' => l(t('disable URL validation'), 'admin/content/ad/configure', array('fragment' => 'edit-ad-validate-url-wrapper')))),
pierre@0:     '#disabled' => !$access,
pierre@0:   );
pierre@0: 
pierre@0:   $form['ad_text']['adheader'] = array(
pierre@0:     '#type' => 'textfield',
pierre@0:     '#title' => t('Ad header'),
pierre@0:     '#required' => $access,
pierre@0:     '#default_value' => isset($node->adheader) ? $node->adheader : '',
pierre@0:     '#description' => t('This is the first line of the ad which will be linked to the URL entered above.'),
pierre@0:     '#disabled' => !$access,
pierre@0:   );
pierre@0:   $form['ad_text']['adbody'] = array(
pierre@0:     '#type' => 'textarea',
pierre@0:     '#title' => t('Ad body'),
pierre@0:     '#required' => $access,
pierre@0:     '#default_value' => isset($node->adbody) ? $node->adbody : '',
pierre@0:     '#description' => t('This is the rest of the ad.'),
pierre@0:     '#disabled' => !$access,
pierre@0:   );
pierre@0: 
pierre@0:   return $form;
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Adapi helper function for displaying ad itself.
pierre@0:  */
pierre@0: function ad_text_node_view(&$node) {
pierre@0:   $node->content['ad'] = array(
pierre@0:     '#value' => theme('box', '', preg_replace('&@HOSTID___&', '0', (ad_text_display_ad($node)))),
pierre@0:     '#weight' => -1,
pierre@0:   );
pierre@0:   if (!empty($node->url)) {
pierre@0:     $link = t('Links to !url.', array('!url' => $node->url));
pierre@0:     $link = check_plain($link, $node->format, FALSE);
pierre@0:     $node->content['ad-link'] = array(
pierre@0:       '#value' => "<div class=\"links-to\">$link</div>",
pierre@0:       '#weight' => 1,
pierre@0:     );
pierre@0:   }
pierre@0: }
pierre@0: 
pierre@0: /**
pierre@0:  * Text ads node validator.
pierre@0:  */
pierre@0: function ad_text_node_validate($node, &$form_state) {
pierre@0:   // Enforce minimum and maximum lengths.
pierre@0:   $header_len = isset($node->adheader) ? strlen($node->adheader) : 0;
pierre@0:   $header_min = variable_get('header_min', 0);
pierre@0:   $header_max = variable_get('header_max', 0);
pierre@0:   if ($header_min && ($header_len < $header_min)) {
pierre@0:     form_set_error('adheader', t('Your text ad header is only %cur characters but must be at least %min characters.', array('%cur' => $header_len, '%min' => $header_min)));
pierre@0:   }
pierre@0:   else if ($header_max && ($header_len > $header_max)) {
pierre@0:     form_set_error('adheader', t('Your text ad header is %cur characters but can not be more than %max characters.', array('%cur' => $header_len, '%max' => $header_max)));
pierre@0:   }
pierre@0:   $body_len = strlen($node->adbody);
pierre@0:   $body_min = variable_get('body_min', 0);
pierre@0:   $body_max = variable_get('body_max', 0);
pierre@0:   if ($body_min && ($body_len < $body_min)) {
pierre@0:     form_set_error('adbody', t('Your text ad body is only %cur characters but must be at least %min characters.', array('%cur' => $body_len, '%min' => $body_min)));
pierre@0:   }
pierre@0:   else if ($body_max && ($body_len > $body_max)) {
pierre@0:     form_set_error('adbody', t('Your text ad body is %cur characters but can not be more than %max characters.', array('%cur' => $body_len, '%max' => $body_max)));
pierre@0:   }
pierre@0: 
pierre@0:   if ($node->url && variable_get('ad_validate_url', 1) && (!valid_url($node->url, TRUE))) {
pierre@0:     form_set_error('url', t('You must specify a valid %field.', array('%field' => t('Destination URL'))));
pierre@0:   }
pierre@0: }