From 3c7bb1b1873c6d4c0cc08267df6deb3e9aa03b68 Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Sun, 1 Mar 2015 12:01:07 -0500
Subject: [PATCH] CRM-15932 - Move ad-hoc strings into standard page/template
 for recurring preview

---
 CRM/Core/Page/AJAX/RecurringEntity.php        |  72 +---------
 CRM/Core/Page/RecurringEntityPreview.php      | 108 +++++++++++++++
 CRM/Core/xml/Menu/Misc.xml                    |   5 +-
 templates/CRM/Core/Form/RecurringEntity.tpl   | 127 +++---------------
 .../CRM/Core/Page/RecurringEntityPreview.tpl  |  68 ++++++++++
 5 files changed, 197 insertions(+), 183 deletions(-)
 create mode 100644 CRM/Core/Page/RecurringEntityPreview.php
 create mode 100644 templates/CRM/Core/Page/RecurringEntityPreview.tpl

diff --git a/CRM/Core/Page/AJAX/RecurringEntity.php b/CRM/Core/Page/AJAX/RecurringEntity.php
index 7ce02377a9..726fcc0ddd 100644
--- a/CRM/Core/Page/AJAX/RecurringEntity.php
+++ b/CRM/Core/Page/AJAX/RecurringEntity.php
@@ -13,15 +13,14 @@
 class CRM_Core_Page_AJAX_RecurringEntity {
 
   public static function updateMode() {
+    $finalResult = array();
     if (CRM_Utils_Array::value('mode', $_REQUEST) && CRM_Utils_Array::value('entityId', $_REQUEST) && CRM_Utils_Array::value('entityTable', $_REQUEST)) {
 
-      $finalResult = array();
       $mode = CRM_Utils_Type::escape($_REQUEST['mode'], 'Integer');
       $entityId = CRM_Utils_Type::escape($_REQUEST['entityId'], 'Integer');
       $entityTable = CRM_Utils_Type::escape($_REQUEST['entityTable'], 'String');
 
       if (CRM_Utils_Array::value('linkedEntityTable', $_REQUEST)) {
-        $result = array();
         $result = CRM_Core_BAO_RecurringEntity::updateModeLinkedEntity($entityId, $_REQUEST['linkedEntityTable'], $entityTable);
       }
 
@@ -44,74 +43,7 @@ class CRM_Core_Page_AJAX_RecurringEntity {
         $finalResult['status'] = 'Error';
       }
     }
-    echo json_encode($finalResult);
-    CRM_Utils_System::civiExit();
-  }
-
-  public static function generatePreview() {
-    $params = $formValues = $genericResult = array();
-    $formValues = $_REQUEST;
-    if (!empty($formValues) &&
-      CRM_Utils_Array::value('entity_table', $formValues)
-    ) {
-      $startDateColumnName = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['dateColumns'][0];
-      $endDateColumnName = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['intervalDateColumns'][0];
-
-      $recursion = new CRM_Core_BAO_RecurringEntity();
-      if (CRM_Utils_Array::value('dateColumns', CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']])) {
-        $recursion->dateColumns = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['dateColumns'];
-      }
-      $recursion->scheduleFormValues = $formValues;
-      if (!empty($formValues['exclude_date_list'])) {
-        $recursion->excludeDates = explode(',', $formValues['exclude_date_list']);
-      }
-      if (CRM_Utils_Array::value('excludeDateRangeColumns', CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']])) {
-        $recursion->excludeDateRangeColumns = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['excludeDateRangeColumns'];
-      }
-
-      if (CRM_Utils_Array::value('entity_id', $formValues)) {
-        $parentEventId = CRM_Core_BAO_RecurringEntity::getParentFor($formValues['entity_id'], $formValues['entity_table']);
-      }
-
-      //Check if there is any enddate column defined to find out the interval between the two range
-      if (CRM_Utils_Array::value('intervalDateColumns', CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']])) {
-        $daoName = CRM_Core_BAO_RecurringEntity::$_tableDAOMapper[$formValues['entity_table']];
-        if ($parentEventId) {
-          $startDate = CRM_Core_DAO::getFieldValue($daoName, $parentEventId, $startDateColumnName);
-          $endDate = CRM_Core_DAO::getFieldValue($daoName, $parentEventId, $endDateColumnName);
-        }
-        if ($endDate) {
-          $interval = $recursion->getInterval($startDate, $endDate);
-          $recursion->intervalDateColumns = array($endDateColumnName => $interval);
-        }
-      }
-
-      $result = $recursion->generateRecursiveDates();
-
-      foreach ($result as $key => $value) {
-        if ($startDateColumnName) {
-          $result[$key]['start_date'] = date('M d, Y h:i:s A \o\n l', strtotime($value[$startDateColumnName]));
-        }
-        if ($value[$endDateColumnName]) {
-          if ($endDateColumnName) {
-            $result[$key]['end_date'] = date('M d, Y h:i:s A \o\n l', strtotime($value[$endDateColumnName]));
-          }
-        }
-      }
-
-      //Show the list of participants registered for the events if any
-      if ($formValues['entity_table'] == "civicrm_event" && !empty($parentEventId)) {
-        $getConnectedEntities = CRM_Core_BAO_RecurringEntity::getEntitiesForParent($parentEventId, 'civicrm_event', TRUE);
-        if ($getConnectedEntities) {
-          $participantDetails = CRM_Event_Form_ManageEvent_Repeat::getParticipantCountforEvent($getConnectedEntities);
-          if (!empty($participantDetails['countByName'])) {
-            $result['participantData'] = $participantDetails['countByName'];
-          }
-        }
-      }
-    }
-    echo json_encode($result);
-    CRM_Utils_System::civiExit();
+    CRM_Utils_JSON::output($finalResult);
   }
 
 }
diff --git a/CRM/Core/Page/RecurringEntityPreview.php b/CRM/Core/Page/RecurringEntityPreview.php
new file mode 100644
index 0000000000..16cdcecda1
--- /dev/null
+++ b/CRM/Core/Page/RecurringEntityPreview.php
@@ -0,0 +1,108 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2014
+ * $Id$
+ *
+ */
+class CRM_Core_Page_RecurringEntityPreview extends CRM_Core_Page {
+
+  /**
+   * Run the basic page (run essentially starts execution for that page).
+   *
+   * @return void
+   */
+  public function run() {
+    $parentEventId = $startDate = $endDate = NULL;
+    $dates = array();
+    $formValues = $_REQUEST;
+    if (!empty($formValues['entity_table'])) {
+      $startDateColumnName = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['dateColumns'][0];
+      $endDateColumnName = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['intervalDateColumns'][0];
+
+      $recursion = new CRM_Core_BAO_RecurringEntity();
+      if (CRM_Utils_Array::value('dateColumns', CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']])) {
+        $recursion->dateColumns = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['dateColumns'];
+      }
+      $recursion->scheduleFormValues = $formValues;
+      if (!empty($formValues['exclude_date_list'])) {
+        $recursion->excludeDates = explode(',', $formValues['exclude_date_list']);
+      }
+      if (CRM_Utils_Array::value('excludeDateRangeColumns', CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']])) {
+        $recursion->excludeDateRangeColumns = CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']]['excludeDateRangeColumns'];
+      }
+
+      if (!empty($formValues['entity_id'])) {
+        $parentEventId = CRM_Core_BAO_RecurringEntity::getParentFor($formValues['entity_id'], $formValues['entity_table']);
+      }
+
+      //Check if there is any enddate column defined to find out the interval between the two range
+      if (CRM_Utils_Array::value('intervalDateColumns', CRM_Core_BAO_RecurringEntity::$_dateColumns[$formValues['entity_table']])) {
+        $daoName = CRM_Core_BAO_RecurringEntity::$_tableDAOMapper[$formValues['entity_table']];
+        if ($parentEventId) {
+          $startDate = CRM_Core_DAO::getFieldValue($daoName, $parentEventId, $startDateColumnName);
+          $endDate = CRM_Core_DAO::getFieldValue($daoName, $parentEventId, $endDateColumnName);
+        }
+        if ($endDate) {
+          $interval = $recursion->getInterval($startDate, $endDate);
+          $recursion->intervalDateColumns = array($endDateColumnName => $interval);
+        }
+      }
+
+      $dates = $recursion->generateRecursiveDates();
+
+      foreach ($dates as $key => &$value) {
+        if ($startDateColumnName) {
+          $value['start_date'] = date('M d, Y h:i:s A \o\n l', strtotime($value[$startDateColumnName]));
+        }
+        if ($endDateColumnName && !empty($value[$endDateColumnName])) {
+          $value['end_date'] = date('M d, Y h:i:s A \o\n l', strtotime($value[$endDateColumnName]));
+          $endDates = TRUE;
+        }
+      }
+
+      //Show the list of participants registered for the events if any
+      if ($formValues['entity_table'] == "civicrm_event" && !empty($parentEventId)) {
+        $getConnectedEntities = CRM_Core_BAO_RecurringEntity::getEntitiesForParent($parentEventId, 'civicrm_event', TRUE);
+        if ($getConnectedEntities) {
+          $participantDetails = CRM_Event_Form_ManageEvent_Repeat::getParticipantCountforEvent($getConnectedEntities);
+          if (!empty($participantDetails['countByName'])) {
+            $this->assign('participantData', $participantDetails['countByName']);
+          }
+        }
+      }
+    }
+    $this->assign('dates', $dates);
+    $this->assign('endDates', !empty($endDates));
+
+    return parent::run();
+  }
+
+}
diff --git a/CRM/Core/xml/Menu/Misc.xml b/CRM/Core/xml/Menu/Misc.xml
index 8de633f080..f6703f958f 100644
--- a/CRM/Core/xml/Menu/Misc.xml
+++ b/CRM/Core/xml/Menu/Misc.xml
@@ -191,9 +191,10 @@
      <access_arguments>access CiviCRM,access CiviEvent</access_arguments>
   </item>
   <item>
-     <path>civicrm/ajax/recurringentity/generate-preview</path>
-     <page_callback>CRM_Core_Page_AJAX_RecurringEntity::generatePreview</page_callback>
+     <path>civicrm/recurringentity/preview</path>
+     <page_callback>CRM_Core_Page_RecurringEntityPreview</page_callback>
      <access_arguments>access CiviCRM,access CiviEvent</access_arguments>
+     <title>Confirm dates</title>
   </item>
   <item>
     <path>civicrm/ajax/l10n-js</path>
diff --git a/templates/CRM/Core/Form/RecurringEntity.tpl b/templates/CRM/Core/Form/RecurringEntity.tpl
index 1d4a578086..c87dd6889c 100644
--- a/templates/CRM/Core/Form/RecurringEntity.tpl
+++ b/templates/CRM/Core/Form/RecurringEntity.tpl
@@ -93,6 +93,8 @@
 {literal}
 <script type="text/javascript">
   CRM.$(function($) {
+    var $form = $('form.{/literal}{$form.formClass}{literal}');
+
     $('#repetition_start_date_display').closest("tr").hide();
     /****** On load "Repeats By" and "Repeats On" blocks should be hidden if dropdown value is not week or month****** (Edit Mode)***/
     switch ($('#repetition_frequency_unit').val()) {
@@ -198,25 +200,16 @@
       $('#entity_status_1, #entity_status_2').prop('disabled', $(this).val() != 2);
     });
 
-    //Select all options in selectbox before submitting
-    $(this).submit(function() {
+    $form.submit(function() {
       //Check form for values submitted
       if ($('input[name=ends]:checked').val() == 1) {
         if ($('#start_action_offset').val() == "") {
-          if (!$('span#start_action_offset-error').length) {
-            $('#start_action_offset').after('<span id ="start_action_offset-error" class="crm-error"> This is a required field.</span>');
-            //Check if other message already present, hide it
-            $('span#repeat_absolute_date_display-error').toggle();
-          }
+          $('#start_action_offset').crmError();
           return false;
         }
       } else if ($('input[name=ends]:checked').val() == 2) {
         if ($('#repeat_absolute_date_display').val() == "") {
-          if (!$('span#repeat_absolute_date_display-error').length) {
-            $('#repeat_absolute_date_display').after('<span id="repeat_absolute_date_display-error" class="crm-error"> This is a required field.</span>');
-            //Check if other message already present, hide it
-            $('span#start_action_offset-error').toggle();
-          }
+          $('#repeat_absolute_date_display').crmError();
           return false;
         }
       }
@@ -270,108 +263,20 @@
 
     //If there are changes in repeat configuration, enable save button
     //Dialog for preview repeat Configuration dates
-    $('#preview-dialog').dialog({ autoOpen: false });
     function previewDialog() {
-      $('#generated_dates').html('').html('<div class="crm-loading-element"><span class="loading-text">{/literal}{ts escape='js'}Just a moment, generating dates{/ts}{literal}...</span></div>');
-      $('#preview-dialog').dialog('open');
-      $('#preview-dialog').dialog({
-        title: 'Confirm dates',
-        width: '650',
-        position: 'center',
-        //draggable: false,
-        buttons: {
-          Ok: function() {
-            $(this).dialog( "close" );
-            $('form#Repeat, form#Activity').submit();
-          },
-          Cancel: function() { //cancel
-            $(this).dialog( "close" );
-          }
-        }
-      });
-      var ajaxurl = CRM.url("civicrm/ajax/recurringentity/generate-preview");
-      var entityID = parseInt('{/literal}{$currentEntityId}{literal}');
-      var entityTable = '{/literal}{$entityTable}{literal}';
-      if (entityTable != "") {
-        ajaxurl += "?entity_table="+entityTable;
-      }
-      if (entityID != "") {
-        ajaxurl += "&entity_id="+entityID;
-      }
-      var formData = $('form').serializeArray();
-      $.ajax({
-        dataType: "json",
-        type: "POST",
-        data: formData,
-        url:  ajaxurl,
-        success: function (result) {
-          if (Object.keys(result).length > 0) {
-            var errors = [];
-            var participantData = [];
-            var html = 'Based on your repeat configuration, here is the list of dates. Do you wish to create a recurring set with these dates?<br/><table id="options" class="display"><thead><tr><th></th><th>Start date</th><th id="th-end-date">End date</th></tr><thead>';
-            var count = 1;
-            for(var i in result) {
-              if (i != 'errors') {
-                if (i == 'participantData') {
-                  participantData = result.participantData;
-                  break;
-                }
-                var start_date = result[i].start_date;
-                var end_date = result[i].end_date;
-
-                var end_date_text = '';
-                if (end_date !== undefined) {
-                  end_date_text = '<td>'+end_date+'</td>';
-                }
-                html += '<tr><td>'+count+'</td><td>'+start_date+'</td>'+end_date_text+'</tr>';
-                count = count + 1;
-              } else {
-                errors = result.errors;
-              }
-            }
-            html += '</table>';
-            var warningHtml = '';
-            if (Object.keys(participantData).length > 0) {
-              warningHtml += '<div class="messages status no-popup"><div class="icon inform-icon"></div>&nbsp;There are registrations for the repeating events already present in the set, continuing with the process would unlink them and repeating events without registration would be trashed. </div><table id="options" class="display"><thead><tr><th>Event ID</th><th>Event</th><th>Participant Count</th></tr><thead>';
-              for (var id in participantData) {
-                for(var data in participantData[id]) {
-                  warningHtml += '<tr><td>'+id+'</td><td> <a href="{/literal}{crmURL p="civicrm/event/manage/settings" q="reset=1&action=update&id="}{literal}'+id+'{/literal}{literal}">'+data+'</a></td><td><a href="{/literal}{crmURL p='civicrm/event/search' q="reset=1&force=1&status=true&event="}{literal}'+id+'{/literal}{literal}">'+participantData[id][data]+'</a></td></tr>';
-                }
-              }
-              warningHtml += '</table><br/>';
-            }
-            if (errors.length > 0) {
-              html = '';
-              for (var j = 0; j < errors.length; j++) {
-                html += '<span class="crm-error">*&nbsp;' + errors[j] + '</span><br/>';
-              }
-            }
-            if (warningHtml != "") {
-              $('#generated_dates').append(warningHtml).append(html);
-            } else {
-              $('#generated_dates').html(html);
-            }
-            if (end_date_text == "") {
-              $('#th-end-date').hide();
-            }
-            if ($("#preview-dialog").height() >= 300) {
-              $('#preview-dialog').css('height', '300');
-              $('#preview-dialog').css('overflow-y', 'auto');
-            }
-          } else {
-            $('div.ui-dialog-buttonset button span:contains(Ok)').hide();
-            $('#generated_dates').append("<span class='crm-error'>Sorry, no dates could be generated for the given criteria!</span>");
-          }
-        },
-        complete: function() {
-          $('div.crm-loading-element').hide();
-        }
-      });
-      return false;
+      var payload = $form.serialize() + '&entity_table={/literal}{$entityTable}{literal}&entity_id={/literal}{$currentEntityId}{literal}',
+        settings = CRM.utils.adjustDialogDefaults({
+          url: CRM.url("civicrm/recurringentity/preview", payload)
+        });
+      CRM.confirm(settings)
+        .on('crmConfirm:yes', function() {
+          $form.submit();
+        });
     }
 
-    $('#_qf_Repeat_submit-top, #_qf_Repeat_submit-bottom').click( function () {
-      return previewDialog();
+    $('#_qf_Repeat_submit-top, #_qf_Repeat_submit-bottom').click(function (e) {
+      previewDialog();
+      e.preventDefault();
     });
 
     $('#_qf_Activity_upload-top, #_qf_Activity_upload-bottom').click( function () {
diff --git a/templates/CRM/Core/Page/RecurringEntityPreview.tpl b/templates/CRM/Core/Page/RecurringEntityPreview.tpl
new file mode 100644
index 0000000000..7451cffdac
--- /dev/null
+++ b/templates/CRM/Core/Page/RecurringEntityPreview.tpl
@@ -0,0 +1,68 @@
+{*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+*}
+{if !empty($participantData)}
+  <div class="messages status no-popup">
+    <div class="icon ui-icon-alert"></div>
+    {ts}There are participants registered for repeating events being removed from the set. Those with participants will be converted to standalone events, and those without registration will be deleted.{/ts}
+  </div>
+  <table class="display">
+    <thead><tr>
+      <th>{ts}Event ID{/ts}</th>
+      <th>{ts}Event{/ts}</th>
+      <th>{ts}Participant Count{/ts}</th>
+    </tr><thead>
+    <tbody>
+      {foreach from=$participantData item="row" key="id"}
+        {foreach from=$row item="count" key="data"}
+          <tr class="{cycle values="odd-row,even-row"}">
+            <td>{$id}</td>
+            <td><a href="{crmURL p="civicrm/event/manage/settings" q="reset=1&action=update&id=$id"}">{$data}</a></td>
+            <td><a href="{crmURL p='civicrm/event/search' q="reset=1&force=1&status=true&event=$id"}">{$count}</a></td>
+          </tr>
+        {/foreach}
+      {/foreach}
+    </tbody>
+{/if}
+
+<h3>
+  {ts}A recurring set will be created with the following dates.{/ts}
+</h3>
+<table class="display row-highlight">
+  <thead><tr>
+    <th>#</th>
+    <th>{ts}Start date{/ts}</th>
+    {if $endDates}<th>{ts}End date{/ts}</th>{/if}
+  </tr><thead>
+  <tbody>
+    {foreach from=$dates item="row" key="count"}
+      <tr class="{cycle values="odd-row,even-row"}">
+        <td>{$count + 1}</td>
+        <td>{$row.start_date}</td>
+        {if $endDates}<td>{$row.end_date}</td>{/if}
+      </tr>
+    {/foreach}
+  </tbody>
+</table>
\ No newline at end of file
-- 
2.25.1