[Done v1.3.9a] Double Discount Coupon message

[andy1234]

Hi All,

I am getting a double discount coupon congratulations message on the Step 2 of checkout (zen 1.3.8)

Congratulations you have redeemed the Discount Coupon
Congratulations you have redeemed the Discount Coupon

it loooks as either ot_coupon.php is called twice or writes two values to the $messageStack


Any ideas what could be wrong here?

Thanks

A

[andy1234]

I have found the reason and here is a quick fix. The problem is in the message_stack.php:

  function messageStack() {

    $this->messages = array();

    if (isset($_SESSION['messageToStack']) && $_SESSION['messageToStack']) {
      $messageToStack = $_SESSION['messageToStack'];
      for ($i=0, $n=sizeof($messageToStack); $i<$n; $i++) {
        $this->add($messageToStack[$i]['class'], $messageToStack[$i]['text'], $messageToStack[$i]['type']);
      }
      $_SESSION['messageToStack']= '';
    }
  }

If $_SESSION['messageToStack'] is not empty, this function adds a double message to $messageToStack

This is a quick fix (for the message type "success" only, because I had troubles with this type of messages only):

 function add($class, $message, $type = 'error') {
    global $template, $current_page_base;

    $message = trim($message);
    if (strlen($message) > 0) {
    //checking if it is not a double message
    $double = 0;
    for ($i=0, $n=sizeof($this->messages); $i<$n; $i++) {
    if($this->messages[$i]['text'] ==  zen_image($template->get_template_dir(ICON_IMAGE_SUCCESS, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_SUCCESS, ICON_SUCCESS_ALT) . '  ' . $message) $double = 1;
    }
    if($double == 0) {
      if ($type == 'error') {
        $this->messages[] = array('params' => 'class="messageStackError larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_ERROR, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_ERROR, ICON_ERROR_ALT) . '  ' . $message);
      } elseif ($type == 'warning') {
        $this->messages[] = array('params' => 'class="messageStackWarning larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_WARNING, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_WARNING, ICON_WARNING_ALT) . '  ' . $message);
      } elseif ($type == 'success') {
        $this->messages[] = array('params' => 'class="messageStackSuccess larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_SUCCESS, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_SUCCESS, ICON_SUCCESS_ALT) . '  ' . $message);
      } elseif ($type == 'caution') {
        $this->messages[] = array('params' => 'class="messageStackCaution larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_WARNING, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_WARNING, ICON_WARNING_ALT) . '  ' . $message);
      } else {
        $this->messages[] = array('params' => 'class="messageStackError larger"', 'class' => $class, 'text' => $message);
      }
      }
    }
  }

[DrByte]

This would probably be somewhat more efficient:

  function add($class, $message, $type = 'error') {
    global $template, $current_page_base;
    $message = trim($message);
    $duplicate = false;
    if (strlen($message) > 0) {
      if ($type == 'error') {
        $theMessage[] = array('params' => 'class="messageStackError larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_ERROR, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_ERROR, ICON_ERROR_ALT) . '  ' . $message);
      } elseif ($type == 'warning') {
        $theMessage[] = array('params' => 'class="messageStackWarning larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_WARNING, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_WARNING, ICON_WARNING_ALT) . '  ' . $message);
      } elseif ($type == 'success') {
        $theMessage[] = array('params' => 'class="messageStackSuccess larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_SUCCESS, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_SUCCESS, ICON_SUCCESS_ALT) . '  ' . $message);
      } elseif ($type == 'caution') {
        $theMessage[] = array('params' => 'class="messageStackCaution larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_WARNING, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_WARNING, ICON_WARNING_ALT) . '  ' . $message);
      } else {
        $theMessage[] = array('params' => 'class="messageStackError larger"', 'class' => $class, 'text' => $message);
      }
      for ($i=0, $n=sizeof($this->messages); $i<$n; $i++) {
        if (strip_tags($theMessage['text']) == strip_tags($this->messages[$i]['text']) && $theMessage['class'] == $this->messages[$i]['class']) $duplicate = true;
      }
      if (!$duplicate) $this->messages[] = $theMessage;
    }
  }

[DrByte]

However, the bug is NOT that the messageStack is displaying duplicates.
The real issue is that the coupon module is registering the message twice.

But, at least you have a bandage for now.

[andy1234]

yes, it is a better structured code, but it does not work. The first instance of $duplicate should be false.

Even after I changed it to false, it does not show any messages at all. I will debbug it later to see what is happening here.

Also, I have been checking it step-by-step in phpEd. The first instance of success message is added by

$messageToStack = $_SESSION['messageToStack']; (line 28)

The second one appears as a result of cycling through, i.e.

$this->add($messageToStack[$i]['class'], $messageToStack[$i]['text'], $messageToStack[$i]['type']); (line 30)

Note that $_SESSION['messageToStack']; includes only one instance of that message correctly

[DrByte]

The first instance of $duplicate should be false.

Oops ... correct.

[Rebelwax]

I too have this issue of the double message. Where abouts in the message_stack.php do i drop your code to fix this?

[andy1234]

Just replace the function add (about the line 37 of message_stack.php) by that code:

 function add($class, $message, $type = 'error') {
    global $template, $current_page_base;
    $message = trim($message);
    if (strlen($message) > 0) {
 //checking if it is not a double message
 $double = 0;
 for ($i=0, $n=sizeof($this->messages); $i<$n; $i++) {
 if($this->messages[$i]['text'] ==  zen_image($template->get_template_dir(ICON_IMAGE_SUCCESS, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_SUCCESS, ICON_SUCCESS_ALT) . '  ' . $message) $double = 1;
 }
 if($double == 0) {
      if ($type == 'error') {
        $this->messages[] = array('params' => 'class="messageStackError larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_ERROR, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_ERROR, ICON_ERROR_ALT) . '  ' . $message);
      } elseif ($type == 'warning') {
        $this->messages[] = array('params' => 'class="messageStackWarning larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_WARNING, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_WARNING, ICON_WARNING_ALT) . '  ' . $message);
      } elseif ($type == 'success') {
        $this->messages[] = array('params' => 'class="messageStackSuccess larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_SUCCESS, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_SUCCESS, ICON_SUCCESS_ALT) . '  ' . $message);
      } elseif ($type == 'caution') {
        $this->messages[] = array('params' => 'class="messageStackCaution larger"', 'class' => $class, 'text' => zen_image($template->get_template_dir(ICON_IMAGE_WARNING, DIR_WS_TEMPLATE, $current_page_base,'images/icons'). '/' . ICON_IMAGE_WARNING, ICON_WARNING_ALT) . '  ' . $message);
      } else {
        $this->messages[] = array('params' => 'class="messageStackError larger"', 'class' => $class, 'text' => $message);
      }
   }
    }
  }

Note that it will eliminate the double message of the "success" type only. If you have other type double messages the "if" condition should be changed accordingly. I have not managed to get the code of DrByte working and did not have time to debug it.

[Rebelwax]

awesome...thanks

[dejavu]

These seems like it should work. I modified the add function and I'm still sending out dups.

Did this work for other folks?