From 95fd5cb20a32adbe6053e9f49fa3db0485c663bd Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Tue, 27 Jan 2015 21:44:03 -0800
Subject: [PATCH] CRM-15855 - crmMailing - Fix autosave for attachments

---
 js/angular-crmAttachment.js            | 28 ++++++++++++++++++++++++++
 partials/crmMailing/edit-unified.html  |  2 +-
 partials/crmMailing/edit-unified2.html |  2 +-
 partials/crmMailing/edit-wizard.html   |  2 +-
 partials/crmMailing/edit.html          |  2 +-
 5 files changed, 32 insertions(+), 4 deletions(-)

diff --git a/js/angular-crmAttachment.js b/js/angular-crmAttachment.js
index a859f92587..35dd1c582f 100644
--- a/js/angular-crmAttachment.js
+++ b/js/angular-crmAttachment.js
@@ -10,6 +10,7 @@
       var crmAttachments = this;
       this._target = target;
       this.files = [];
+      this.trash = [];
       this.uploader = new FileUploader({
         url: CRM.url('civicrm/ajax/attachment'),
         onAfterAddingFile: function onAfterAddingFile(item) {
@@ -88,6 +89,26 @@
             return dfr.promise;
           });
       },
+      // Compute a digest over the list of files. The signature should change if the attachment list has changed
+      // (become dirty).
+      getAutosaveSignature: function getAutosaveSignature() {
+        var sig = [];
+        // Attachments have a special lifecycle, and attachments.queue is not properly serializable, so
+        // it takes some special effort to figure out a suitable signature. Issues which can cause gratuitous saving:
+        //  - Files move from this.uploader.queue to this.files after upload.
+        //  - File names are munged after upload.
+        //  - Deletes are performed immediately (outside the save process).
+        angular.forEach(this.files, function(item) {
+          sig.push({f: item.name.replace(/[^a-zA0-Z0-9\.]/, '_'), d: item.description});
+        });
+        angular.forEach(this.uploader.queue, function(item) {
+          sig.push({f: item.file.name.replace(/[^a-zA0-Z0-9\.]/, '_'), d: item.crmData.description});
+        });
+        angular.forEach(this.trash, function(item) {
+          sig.push({f: item.name.replace(/[^a-zA0-Z0-9\.]/, '_'), d: item.description});
+        });
+        return _.sortBy(sig, 'name');
+      },
       // @param Object file APIv3 attachment record (e.g. id, entity_table, entity_id, description)
       deleteFile: function deleteFile(file) {
         var crmAttachments = this;
@@ -97,6 +118,8 @@
           this.files.splice(idx, 1);
         }
 
+        this.trash.push(file);
+
         if (file.id) {
           var p = crmApi('Attachment', 'delete', {id: file.id}).then(
             function () { // success
@@ -105,6 +128,11 @@
               var msg = angular.isObject(response) ? response.error_message : '';
               CRM.alert(msg, ts('Deletion failed'));
               crmAttachments.files.push(file);
+
+              var trashIdx = _.indexOf(crmAttachments.trash, file);
+              if (trashIdx != -1) {
+                crmAttachments.trash.splice(trashIdx, 1);
+              }
             }
           );
           return crmStatus({start: ts('Deleting...'), success: ts('Deleted')}, p);
diff --git a/partials/crmMailing/edit-unified.html b/partials/crmMailing/edit-unified.html
index 6e46a03ff3..24e497c67b 100644
--- a/partials/crmMailing/edit-unified.html
+++ b/partials/crmMailing/edit-unified.html
@@ -6,7 +6,7 @@
   {{ts('This mailing has been submitted.')}}
 </div>
 
-<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="mailing" crm-autosave-if="true">
+<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="[mailing, attachments.getAutosaveSignature()]" crm-autosave-if="true">
   <div class="crm-block crm-form-block crmMailing">
 
     <div crm-mailing-block-summary crm-mailing="mailing"/>
diff --git a/partials/crmMailing/edit-unified2.html b/partials/crmMailing/edit-unified2.html
index eee356fd51..1d1916086c 100644
--- a/partials/crmMailing/edit-unified2.html
+++ b/partials/crmMailing/edit-unified2.html
@@ -6,7 +6,7 @@
   {{ts('This mailing has been submitted.')}}
 </div>
 
-<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="mailing" crm-autosave-if="true">
+<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="[mailing, attachments.getAutosaveSignature()]" crm-autosave-if="true">
   <div class="crm-block crm-form-block crmMailing">
 
     <div crm-mailing-block-summary crm-mailing="mailing"/>
diff --git a/partials/crmMailing/edit-wizard.html b/partials/crmMailing/edit-wizard.html
index 0a05f22e58..7bda0d62c8 100644
--- a/partials/crmMailing/edit-wizard.html
+++ b/partials/crmMailing/edit-wizard.html
@@ -6,7 +6,7 @@
   {{ts('This mailing has been submitted.')}}
 </div>
 
-<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="mailing" crm-autosave-if="true">
+<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="[mailing, attachments.getAutosaveSignature()]" crm-autosave-if="true">
   <div class="crm-block crm-form-block crmMailing">
 
     <div crm-ui-wizard>
diff --git a/partials/crmMailing/edit.html b/partials/crmMailing/edit.html
index adac47dd88..6c33c71554 100644
--- a/partials/crmMailing/edit.html
+++ b/partials/crmMailing/edit.html
@@ -6,7 +6,7 @@
   {{ts('This mailing has been submitted.')}}
 </div>
 
-<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="mailing" crm-autosave-if="true">
+<form name="crmMailing" novalidate ng-hide="isSubmitted()" crm-autosave="save()" crm-autosave-model="[mailing, attachments.getAutosaveSignature()]" crm-autosave-if="true">
 
   <div class="crm-block crm-form-block crmMailing">
     <div crm-ui-wizard>
-- 
2.25.1