/
ngDroplet.js
1168 lines (893 loc) · 39 KB
/
ngDroplet.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
(function($angular) {
"use strict";
/**
* @property blankImage
* @type {String}
*/
var blankImage = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';
// The truest wisdom is a resolute determination...
var module = $angular.module('ngDroplet', []).directive('droplet', ['$rootScope', '$window', '$timeout', '$q',
function DropletDirective($rootScope, $window, $timeout, $q) {
return {
/**
* @property restrict
* @type {String}
*/
restrict: 'EA',
/**
* @property require
* @type {String}
*/
require: '?ngModel',
/**
* @property scope
* @type {Object}
*/
scope: {
interface: '=ngModel',
onLoad: '&',
onAdd: '&',
onDelete: '&',
onSuccess: '&',
onError: '&'
},
/**
* @method controller
* @param $scope {Object}
* @return {void}
*/
controller: ['$scope', function DropletController($scope) {
/**
* @constant FILE_TYPES
* @type {Object}
*/
$scope.FILE_TYPES = { VALID: 1, INVALID: 2, DELETED: 4, UPLOADED: 8, FAILED: 16 };
// Dynamically add the `ALL` property.
$scope.FILE_TYPES.ALL = Object.keys($scope.FILE_TYPES).reduce(function map(current, key) {
return (current |= $scope.FILE_TYPES[key]);
}, 0);
/**
* @property files
* @type {Array}
*/
$scope.files = [];
/**
* @property isUploading
* @type {Boolean}
*/
$scope.isUploading = false;
/**
* @property isError
* @type {Boolean}
*/
$scope.isError = false;
/**
* @method isValid
* @param value {String|Number}
* @param values {Array}
* @return {Boolean}
* @private
*/
var isValid = function isValid(value, values) {
/**
* @method conditionallyLowercase
* @param value {String|Number}
* @return {String|Number}
*/
var conditionallyLowercase = function conditionallyLowercase(value) {
if (typeof value === 'string') {
return value.toLowerCase();
}
return value;
};
return values.some(function some(currentValue) {
var isRegExp = (currentValue instanceof $window.RegExp);
if (isRegExp) {
// Evaluate the status code as a regular expression.
return currentValue.test(conditionallyLowercase(value));
}
return conditionallyLowercase(currentValue) === conditionallyLowercase(value);
});
};
/**
* Responsible for determining if the event is actually a jQuery event, which has therefore
* placed the original event inside of the `originalEvent` property.
*
* @method getEvent
* @param event {Object}
* @return {Object}
*/
$scope.getEvent = function getEvent(event) {
if ('originalEvent' in event) {
// jQuery likes to send across its own event, and place the original event
// in the `originalEvent` property.
return event.originalEvent;
}
return event;
};
/**
* @method isValidHTTPStatus
* @param statusCode {Number}
* @return {Boolean}
*/
$scope.isValidHTTPStatus = function isValidHTTPStatus(statusCode) {
return isValid(statusCode, $scope.options.statuses.success);
};
/**
* @method isValidExtension
* @param extension {String}
* @return {Boolean}
*/
$scope.isValidExtension = function isValidExtension(extension) {
return isValid(extension, $scope.options.extensions);
};
/**
* @property options
* @type {Object}
*/
$scope.options = {
/**
* URL that will be called when making the POST request.
*
* @property requestUrl
* @type {String}
*/
requestUrl: '',
/**
* Name of the file property in the request.
*
* @property fileProperty
* @type {String}
*/
fileProperty: 'file',
/**
* Determines whether the X-File-Size header is appended to the request.
*
* @property disableXFileSize
* @type {Boolean}
*/
disableXFileSize: false,
/**
* @property parserFn
* @type {Function}
*/
parserFn: function parserFunction(responseText) {
return $window.JSON.parse(responseText);
},
/**
* Whether to use the array notation for the file parameter, or not.
*
* @property useArray
* @type {Boolean}
*/
useArray: true,
/**
* @property maximumValidFiles
* @type {Number|Infinity}
* @default Infinity
*/
maximumValidFiles: Infinity,
/**
* Additional headers to append to the request.
*
* @property requestHeaders
* @type {Object}
*/
requestHeaders: {},
/**
* Additional POST to data to be appended to the FormData object.
*
* @property requestPostData
* @type {Object}
*/
requestPostData: {},
/**
* List of valid extensions for uploading to the server.
*
* @property extensions
* @type {Array}
*/
extensions: [],
/**
* @property statuses
* @type {Object}
*/
statuses: {
/**
* List of HTTP status codes that denote a successful HTTP request.
*
* @property success
* @type {Array}
*/
success: [/2.{2}/]
}
};
/**
* @property requestProgress
* @type {Object}
*/
$scope.requestProgress = { percent: 0, total: 0, loaded: 0 };
/**
* @property listeners
* @type {Object}
*/
$scope.listeners = {
/**
* @property files
* @type {Array}
*/
files: [],
/**
* @property deferred
* @type {$q.defer|null}
*/
deferred: null,
/**
* @property httpRequest
* @type {XMLHttpRequest|null}
*/
httpRequest: null,
/**
* Invoked once everything has been uploaded.
*
* @method success
* @return {void}
*/
success: function success() {
this.httpRequest.onreadystatechange = function onReadyStateChange() {
if (this.httpRequest.readyState === 4) {
if ($scope.isValidHTTPStatus(this.httpRequest.status)) {
$scope.$apply(function apply() {
// Parse the response, and then emit the event passing along the response
// and the uploaded files!
function parseJSON(str) {
var result;
try {
result = $scope.options.parserFn(str);
} catch (e) {
return str;
}
return result;
}
var response = parseJSON(this.httpRequest.responseText);
this.deferred.resolve(response, this.files);
$scope.finishedUploading();
$angular.forEach(this.files, function forEach(model) {
// Advance the status of the file to that of an uploaded file.
model.setType($scope.FILE_TYPES.UPLOADED);
});
$rootScope.$broadcast('$dropletSuccess', response, this.files);
$scope.onSuccess({ response: response, files: this.files });
}.bind(this));
return;
}
// Error was thrown instead.
this.httpRequest.upload.onerror();
}
}.bind(this);
},
/**
* Invoked when an error is thrown when uploading the files.
*
* @method error
* @return {void}
*/
error: function error() {
this.httpRequest.upload.onerror = function onError() {
$scope.$apply(function apply() {
$scope.finishedUploading();
$scope.isError = true;
var response = $scope.options.parserFn(this.httpRequest.responseText);
$rootScope.$broadcast('$dropletError', response);
$scope.onError({ response: response });
this.deferred.reject(response);
}.bind(this));
}.bind(this);
},
/**
* Invoked each time there's a progress update on the files being uploaded.
*
* @method progress
* @return {void}
*/
progress: function progress() {
var requestLength = $scope.getRequestLength(this.files);
this.httpRequest.upload.onprogress = function onProgress(event) {
$scope.$apply(function apply() {
if (event.lengthComputable) {
// Update the progress object.
$scope.requestProgress.percent = Math.round((event.loaded / requestLength) * 100);
$scope.requestProgress.loaded = event.loaded;
$scope.requestProgress.total = requestLength;
}
});
};
}
};
/**
* @method createModelBlueprint
* @return {void}
*/
(function createModelBlueprint() {
/**
* @model DropletModel
* @constructor
*/
$scope.DropletModel = function DropletModel() {};
/**
* @property prototype
* @type {Object}
*/
$scope.DropletModel.prototype = {
/**
* @method file
* @param file {File}
* @return {void}
*/
load: function load(file) {
if (!(file instanceof $window.File) && !(file instanceof $window.Blob)) {
$scope.throwException('Loaded files must be an instance of the "File" or "Blob" objects');
}
this.file = file;
this.date = new $window.Date();
this.mimeType = file.type;
this.extension = $scope.getExtension(file);
// File has been added!
$rootScope.$broadcast('$dropletFileAdded', this);
$scope.onAdd({ file: this });
},
/**
* @method deleteFile
* @return {void}
*/
deleteFile: function deleteFile() {
this.setType($scope.FILE_TYPES.DELETED);
// File has been deleted!
$rootScope.$broadcast('$dropletFileDeleted', this);
$scope.onDelete({ file: this });
},
/**
* @method setType
* @param type {Number}
* @return {void}
*/
setType: function setType(type) {
this.type = type;
},
/**
* @method isImage
* @return {Boolean}
*/
isImage: function isImage() {
return !!this.file.type.match(/^image\//i);
}
};
})();
/**
* @method finishedUploading
* @return {void}
*/
$scope.finishedUploading = function finishedUploading() {
$scope.progress = { percent: 0, total: 0, loaded: 0 };
$scope.isUploading = false;
};
/**
* Utility method for iterating over files of a given type.
*
* @method forEachFile
* @param type {Number}
* @param callbackFn {Function}
* @return {void}
*/
$scope.forEachFile = function forEachFile(type, callbackFn) {
$angular.forEach($scope.filterFiles(type || $scope.FILE_TYPES.VALID), function forEach(model) {
callbackFn(model);
});
};
/**
* @method addFile
* @param file {File}
* @param type {Number}
* @return {Object}
*/
$scope.addFile = function addFile(file, type) {
// If the developer didn't specify the type then we'll assume it's a valid file
// that they're adding.
type = type || $scope.FILE_TYPES.VALID;
// Create the model and then register the file.
var model = new $scope.DropletModel();
model.setType(type);
$scope.files.push(model);
model.load(file); //will broadcast the event once the model is complete
return model;
};
/**
* @method filterFiles
* @param type {Number}
* @return {Array}
*/
$scope.filterFiles = function filterFiles(type) {
return $scope.files.filter(function filter(file) {
return type & file.type;
});
};
/**
* @method getExtension
* @param file {File}
* @return {String}
*/
$scope.getExtension = function getExtension(file) {
var str, separator;
if ( typeof file.name !== 'undefined' ) {
str = file.name;
separator = '.';
} else {
str = file.type;
separator = '/';
}
if (str.indexOf(separator) === -1) {
// Filename doesn't actually have an extension.
return '';
}
return str.split(separator).pop().trim().toLowerCase();
};
/**
* @method traverseFiles
* @param files {FileList}
* @return {void}
*/
$scope.traverseFiles = function traverseFiles(files) {
for (var index = 0, numFiles = files.length; index < numFiles; index++) {
var file = files[index],
extension = $scope.getExtension(file),
type = $scope.FILE_TYPES.VALID,
maximum = $scope.options.maximumValidFiles || Infinity,
current = $scope.filterFiles($scope.FILE_TYPES.VALID).length;
if (!$scope.isValidExtension(extension) || current >= maximum) {
// Invalid extension which we must reject!
type = $scope.FILE_TYPES.INVALID;
}
// Finally we'll register the file using the type that has been deduced.
$scope.addFile(file, type);
}
};
/**
* @method uploadFiles
* @return {$q.promise}
*/
$scope.uploadFiles = function uploadFiles() {
// Reset...
$scope.isError = false;
var httpRequest = new $window.XMLHttpRequest(),
formData = new $window.FormData(),
queuedFiles = $scope.filterFiles($scope.FILE_TYPES.VALID),
fileProperty = $scope.options.useArray ?
$scope.options.fileProperty + '[]' :
$scope.options.fileProperty,
requestLength = $scope.getRequestLength(queuedFiles),
deferred = $q.defer();
// Initiate the HTTP request.
httpRequest.open('post', $scope.options.requestUrl, true);
/**
* @method appendCustomData
* @return {void}
*/
(function appendCustomData() {
if (!$scope.options.disableXFileSize) {
// Setup the file size of the request.
httpRequest.setRequestHeader('X-File-Size', requestLength);
}
// ...And any other additional HTTP request headers, and POST data.
$scope.addRequestHeaders(httpRequest);
$scope.addPostData(formData);
})();
/**
* @method attachEventListeners
* @return {void}
*/
(function attachEventListeners() {
// Define the files property so that each listener has the same interface.
$scope.listeners.files = queuedFiles;
$scope.listeners.deferred = deferred;
$scope.listeners.httpRequest = httpRequest;
// Configure the event listeners for the impending request.
$scope.listeners.progress();
$scope.listeners.success();
$scope.listeners.error();
})();
// Iterate all of the valid files to append them to the previously created
// `formData` object.
$angular.forEach(queuedFiles, function forEach(model) {
formData.append(fileProperty, model.file, $window.encodeURIComponent(model.file.name));
});
// Voila...
$scope.isUploading = true;
httpRequest.send(formData);
return deferred.promise;
};
/**
* Iterate over any additional headers added by the developer and append to the current
* request being generated.
*
* @method addRequestHeaders
* @param httpRequest {XMLHttpRequest}
* @return {Array}
*/
$scope.addRequestHeaders = function addRequestHeaders(httpRequest) {
for (var header in $scope.options.requestHeaders) {
if ($scope.options.requestHeaders.hasOwnProperty(header)) {
httpRequest.setRequestHeader(header, $scope.options.requestHeaders[header]);
}
}
return Object.keys($scope.options.requestHeaders);
};
/**
* Iterate over any additional POST data that must be bundled with the request.
*
* @method addPostData
* @param formData {FormData}
* @return {Array}
*/
$scope.addPostData = function addPostData(formData) {
for (var header in $scope.options.requestPostData) {
if ($scope.options.requestPostData.hasOwnProperty(header)) {
formData.append(header, $scope.options.requestPostData[header]);
}
}
return Object.keys($scope.options.requestPostData);
};
/**
* Determine the size of the request based on the files preparing to be uploaded.
*
* @method getRequestLength
* @param [files=[]] {Array}
* @return {Number}
*/
$scope.getRequestLength = function getRequestLength(files) {
var allFiles = files || $scope.filterFiles($scope.FILE_TYPES.VALID);
// Iterate over all of the files to determine the size of all the specified files.
return allFiles.reduce(function reduce(previousValue, currentModel) {
return previousValue + currentModel.file.size;
}, 0);
};
/**
* @method throwException
* @param message {String}
* @return {void}
*/
$scope.throwException = function throwException(message) {
throw "ngDroplet: " + message + ".";
};
/**
* Responsible for setting up the interface that allows the developer to interact
* with the directive from outside.
*
* @method setupDirectiveInterface
* @return {void}
*/
(function setupDirectiveInterface() {
/**
* @property interface
* @type {Object}
*/
$scope.interface = {
/**
* @constant FILE_TYPES
* @type {Object}
*/
FILE_TYPES: $scope.FILE_TYPES,
/**
* @method uploadFiles
* @return {void}
*/
uploadFiles: $scope.uploadFiles,
/**
* @property progress
* @type {Object}
*/
progress: $scope.requestProgress,
/**
* @method useParser
* @param parserFn {Function}
* @return {void}
*/
useParser: function useParser(parserFn) {
if (typeof parserFn !== 'function') {
$scope.throwException('Parser function must be typeof "function"');
}
$scope.options.parserFn = parserFn;
},
/**
* @method isUploading
* @return {Boolean}
*/
isUploading: function isUploading() {
return $scope.isUploading;
},
/**
* @method isError
* @type {Boolean}
*/
isError: function isError() {
return $scope.isError;
},
/**
* Determines if there are files ready and waiting to be uploaded.
*
* @method isReady
* @return {Boolean}
*/
isReady: function isReady() {
return !!$scope.filterFiles($scope.FILE_TYPES.VALID).length;
},
/**
* @method addFile
* @param file {File}
* @param type {Number}
* @return {void}
*/
addFile: $scope.addFile,
/**
* @method traverseFiles
* @param files {FileList}
* @return {void}
*/
traverseFiles: $scope.traverseFiles,
/**
* @method disableXFileSize
* @return {void}
*/
disableXFileSize: function disableXFileSize() {
$scope.options.disableXFileSize = true;
},
/**
* @method useArray
* @param value {Boolean}
* @return {void}
*/
useArray: function useArray(value) {
$scope.options.useArray = !!value;
},
/**
* @method setRequestUrl
* @param url {String}
* @return {void}
*/
setRequestUrl: function setRequestUrl(url) {
$scope.options.requestUrl = url;
},
/**
* @method setFileProperty
* @param name {String}
* @return {void}
*/
setFileProperty: function setFileProperty(name) {
$scope.options.fileProperty = name;
},
/**
* @method setMaximumValidFiles
* @param value {Number}
* @return {void}
*/
setMaximumValidFiles: function setMaximumValidFiles(value) {
$scope.options.maximumValidFiles = Number(value);
},
/**
* @method setRequestHeaders
* @param headers {Object}
* @return {void}
*/
setRequestHeaders: function setRequestHeaders(headers) {
$scope.options.requestHeaders = headers;
},
/**
* @method setPostData
* @param data {Object}
* @return {void}
*/
setPostData: function setPostData(data) {
$scope.options.requestPostData = data;
},
/**
* @method getFiles
* @param type {Number}
* @return {Array}
*/
getFiles: function getFiles(type) {
if (type) {
// Apply any necessary filters if a bitwise value has been supplied.
return $scope.filterFiles(type);
}
// Otherwise we'll yield the entire set of files.
return $scope.files;
},
/**
* @method allowedExtensions
* @param extensions {Array}
* @return {void}
*/
allowedExtensions: function allowedExtensions(extensions) {
if (!$angular.isArray(extensions)) {
// Developer didn't pass an array of extensions!
$scope.throwException('Extensions must be an array');
}
$scope.options.extensions = extensions;
},
/**
* @method defineHTTPSuccess
* @param statuses {Array}
* @return {void}
*/
defineHTTPSuccess: function defineHTTPSuccess(statuses) {
if (!$angular.isArray(statuses)) {
// Developer didn't pass an array of extensions!
$scope.throwException('Status list must be an array');
}
$scope.options.statuses.success = statuses;
}
};
$timeout(function timeout() {
// Emit the event to notify any listening scopes that the interface has been attached
// for communicating with the directive.
$rootScope.$broadcast('$dropletReady', $scope.interface);
$scope.onLoad({ interface: $scope.interface });
});
})();
}],
/**
* @method link
* @param scope {Object}
* @param element {Object}
* @return {void}
*/
link: function link(scope, element) {
/**
* @method _preventDefault
* @param event {Object}
* @return {void}
* @private
*/
var _preventDefault = function _preventDefault(event) {
event = scope.getEvent(event);
// Remove all of the possible class names.
element.removeClass('event-dragleave');
element.removeClass('event-dragenter');
element.removeClass('event-dragover');
element.removeClass('event-drop');
// ...And then add the current class name.
element.addClass('event-' + event.type);
event.preventDefault();
event.stopPropagation();
};
// Events that merely need their default behaviour quelling.
element.bind('dragover dragenter dragleave', _preventDefault);
// Bind to the "drop" event which will contain the items the user dropped
// onto the element.
element.bind('drop', function onDrop(event) {
_preventDefault(event);
scope.$apply(function apply() {
event = scope.getEvent(event);
scope.traverseFiles(event.dataTransfer.files);