Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / source / swfupload.speed.html
diff --git a/docs/source/swfupload.speed.html b/docs/source/swfupload.speed.html
deleted file mode 100644 (file)
index 820ad69..0000000
+++ /dev/null
@@ -1,351 +0,0 @@
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js">/*\r
-       Speed Plug-in\r
-       \r
-       Features:\r
-               *Adds several properties to the 'file' object indicated upload speed, time left, upload time, etc.\r
-                       - currentSpeed -- String indicating the upload speed, bytes per second\r
-                       - averageSpeed -- Overall average upload speed, bytes per second\r
-                       - movingAverageSpeed -- Speed over averaged over the last several measurements, bytes per second\r
-                       - timeRemaining -- Estimated remaining upload time in seconds\r
-                       - timeElapsed -- Number of seconds passed for this upload\r
-                       - percentUploaded -- Percentage of the file uploaded (0 to 100)\r
-                       - sizeUploaded -- Formatted size uploaded so far, bytes\r
-               \r
-               *Adds setting 'moving_average_history_size' for defining the window size used to calculate the moving average speed.\r
-               \r
-               *Adds several Formatting functions for formatting that values provided on the file object.\r
-                       - SWFUpload.speed.formatBPS(bps) -- outputs string formatted in the best units (Gbps, Mbps, Kbps, bps)\r
-                       - SWFUpload.speed.formatTime(seconds) -- outputs string formatted in the best units (x Hr y M z S)\r
-                       - SWFUpload.speed.formatSize(bytes) -- outputs string formatted in the best units (w GB x MB y KB z B )\r
-                       - SWFUpload.speed.formatPercent(percent) -- outputs string formatted with a percent sign (x.xx %)\r
-                       - SWFUpload.speed.formatUnits(baseNumber, divisionArray, unitLabelArray, fractionalBoolean)\r
-                               - Formats a number using the division array to determine how to apply the labels in the Label Array\r
-                               - factionalBoolean indicates whether the number should be returned as a single fractional number with a unit (speed)\r
-                                   or as several numbers labeled with units (time)\r
-       */\r
-\r
-var SWFUpload;\r
-if (typeof(SWFUpload) === "function") {\r
-       SWFUpload.speed = {};\r
-       \r
-       SWFUpload.prototype.initSettings = (function (oldInitSettings) {\r
-               return function () {\r
-                       if (typeof(oldInitSettings) === "function") {\r
-                               oldInitSettings.call(this);\r
-                       }\r
-                       \r
-                       this.ensureDefault = function (settingName, defaultValue) {\r
-                               this.settings[settingName] = (this.settings[settingName] == undefined) ? defaultValue : this.settings[settingName];\r
-                       };\r
-\r
-                       // List used to keep the speed stats for the files we are tracking\r
-                       this.fileSpeedStats = {};\r
-                       this.speedSettings = {};\r
-\r
-                       this.ensureDefault("moving_average_history_size", "10");\r
-                       \r
-                       this.speedSettings.user_file_queued_handler = this.settings.file_queued_handler;\r
-                       this.speedSettings.user_file_queue_error_handler = this.settings.file_queue_error_handler;\r
-                       this.speedSettings.user_upload_start_handler = this.settings.upload_start_handler;\r
-                       this.speedSettings.user_upload_error_handler = this.settings.upload_error_handler;\r
-                       this.speedSettings.user_upload_progress_handler = this.settings.upload_progress_handler;\r
-                       this.speedSettings.user_upload_success_handler = this.settings.upload_success_handler;\r
-                       this.speedSettings.user_upload_complete_handler = this.settings.upload_complete_handler;\r
-                       \r
-                       this.settings.file_queued_handler = SWFUpload.speed.fileQueuedHandler;\r
-                       this.settings.file_queue_error_handler = SWFUpload.speed.fileQueueErrorHandler;\r
-                       this.settings.upload_start_handler = SWFUpload.speed.uploadStartHandler;\r
-                       this.settings.upload_error_handler = SWFUpload.speed.uploadErrorHandler;\r
-                       this.settings.upload_progress_handler = SWFUpload.speed.uploadProgressHandler;\r
-                       this.settings.upload_success_handler = SWFUpload.speed.uploadSuccessHandler;\r
-                       this.settings.upload_complete_handler = SWFUpload.speed.uploadCompleteHandler;\r
-                       \r
-                       delete this.ensureDefault;\r
-               };\r
-       })(SWFUpload.prototype.initSettings);\r
-\r
-       \r
-       SWFUpload.speed.fileQueuedHandler = function (file) {\r
-               if (typeof this.speedSettings.user_file_queued_handler === "function") {\r
-                       file = SWFUpload.speed.extendFile(file);\r
-                       \r
-                       return this.speedSettings.user_file_queued_handler.call(this, file);\r
-               }\r
-       };\r
-       \r
-       SWFUpload.speed.fileQueueErrorHandler = function (file, errorCode, message) {\r
-               if (typeof this.speedSettings.user_file_queue_error_handler === "function") {\r
-                       file = SWFUpload.speed.extendFile(file);\r
-                       \r
-                       return this.speedSettings.user_file_queue_error_handler.call(this, file, errorCode, message);\r
-               }\r
-       };\r
-\r
-       SWFUpload.speed.uploadStartHandler = function (file) {\r
-               if (typeof this.speedSettings.user_upload_start_handler === "function") {\r
-                       file = SWFUpload.speed.extendFile(file, this.fileSpeedStats);\r
-                       return this.speedSettings.user_upload_start_handler.call(this, file);\r
-               }\r
-       };\r
-       \r
-       SWFUpload.speed.uploadErrorHandler = function (file, errorCode, message) {\r
-               file = SWFUpload.speed.extendFile(file, this.fileSpeedStats);\r
-               SWFUpload.speed.removeTracking(file, this.fileSpeedStats);\r
-\r
-               if (typeof this.speedSettings.user_upload_error_handler === "function") {\r
-                       return this.speedSettings.user_upload_error_handler.call(this, file, errorCode, message);\r
-               }\r
-       };\r
-       SWFUpload.speed.uploadProgressHandler = function (file, bytesComplete, bytesTotal) {\r
-               this.updateTracking(file, bytesComplete);\r
-               file = SWFUpload.speed.extendFile(file, this.fileSpeedStats);\r
-\r
-               if (typeof this.speedSettings.user_upload_progress_handler === "function") {\r
-                       return this.speedSettings.user_upload_progress_handler.call(this, file, bytesComplete, bytesTotal);\r
-               }\r
-       };\r
-       \r
-       SWFUpload.speed.uploadSuccessHandler = function (file, serverData) {\r
-               if (typeof this.speedSettings.user_upload_success_handler === "function") {\r
-                       file = SWFUpload.speed.extendFile(file, this.fileSpeedStats);\r
-                       return this.speedSettings.user_upload_success_handler.call(this, file, serverData);\r
-               }\r
-       };\r
-       SWFUpload.speed.uploadCompleteHandler = function (file) {\r
-               file = SWFUpload.speed.extendFile(file, this.fileSpeedStats);\r
-               SWFUpload.speed.removeTracking(file, this.fileSpeedStats);\r
-\r
-               if (typeof this.speedSettings.user_upload_complete_handler === "function") {\r
-                       return this.speedSettings.user_upload_complete_handler.call(this, file);\r
-               }\r
-       };\r
-       \r
-       // Private: extends the file object with the speed plugin values\r
-       SWFUpload.speed.extendFile = function (file, trackingList) {\r
-               var tracking;\r
-               \r
-               if (trackingList) {\r
-                       tracking = trackingList[file.id];\r
-               }\r
-               \r
-               if (tracking) {\r
-                       file.currentSpeed = tracking.currentSpeed;\r
-                       file.averageSpeed = tracking.averageSpeed;\r
-                       file.movingAverageSpeed = tracking.movingAverageSpeed;\r
-                       file.timeRemaining = tracking.timeRemaining;\r
-                       file.timeElapsed = tracking.timeElapsed;\r
-                       file.percentUploaded = tracking.percentUploaded;\r
-                       file.sizeUploaded = tracking.bytesUploaded;\r
-\r
-               } else {\r
-                       file.currentSpeed = 0;\r
-                       file.averageSpeed = 0;\r
-                       file.movingAverageSpeed = 0;\r
-                       file.timeRemaining = 0;\r
-                       file.timeElapsed = 0;\r
-                       file.percentUploaded = 0;\r
-                       file.sizeUploaded = 0;\r
-               }\r
-               \r
-               return file;\r
-       };\r
-       \r
-       // Private: Updates the speed tracking object, or creates it if necessary\r
-       SWFUpload.prototype.updateTracking = function (file, bytesUploaded) {\r
-               var tracking = this.fileSpeedStats[file.id];\r
-               if (!tracking) {\r
-                       this.fileSpeedStats[file.id] = tracking = {};\r
-               }\r
-               \r
-               // Sanity check inputs\r
-               bytesUploaded = bytesUploaded || tracking.bytesUploaded || 0;\r
-               if (bytesUploaded < 0) {\r
-                       bytesUploaded = 0;\r
-               }\r
-               if (bytesUploaded > file.size) {\r
-                       bytesUploaded = file.size;\r
-               }\r
-               \r
-               var tickTime = (new Date()).getTime();\r
-               if (!tracking.startTime) {\r
-                       tracking.startTime = (new Date()).getTime();\r
-                       tracking.lastTime = tracking.startTime;\r
-                       tracking.currentSpeed = 0;\r
-                       tracking.averageSpeed = 0;\r
-                       tracking.movingAverageSpeed = 0;\r
-                       tracking.movingAverageHistory = [];\r
-                       tracking.timeRemaining = 0;\r
-                       tracking.timeElapsed = 0;\r
-                       tracking.percentUploaded = bytesUploaded / file.size;\r
-                       tracking.bytesUploaded = bytesUploaded;\r
-               } else if (tracking.startTime > tickTime) {\r
-                       this.debug("When backwards in time");\r
-               } else {\r
-                       // Get time and deltas\r
-                       var now = (new Date()).getTime();\r
-                       var lastTime = tracking.lastTime;\r
-                       var deltaTime = now - lastTime;\r
-                       var deltaBytes = bytesUploaded - tracking.bytesUploaded;\r
-                       \r
-                       if (deltaBytes === 0 || deltaTime === 0) {\r
-                               return tracking;\r
-                       }\r
-                       \r
-                       // Update tracking object\r
-                       tracking.lastTime = now;\r
-                       tracking.bytesUploaded = bytesUploaded;\r
-                       \r
-                       // Calculate speeds\r
-                       tracking.currentSpeed = (deltaBytes * 8 ) / (deltaTime / 1000);\r
-                       tracking.averageSpeed = (tracking.bytesUploaded * 8) / ((now - tracking.startTime) / 1000);\r
-\r
-                       // Calculate moving average\r
-                       tracking.movingAverageHistory.push(tracking.currentSpeed);\r
-                       if (tracking.movingAverageHistory.length > this.settings.moving_average_history_size) {\r
-                               tracking.movingAverageHistory.shift();\r
-                       }\r
-                       \r
-                       tracking.movingAverageSpeed = SWFUpload.speed.calculateMovingAverage(tracking.movingAverageHistory);\r
-                       \r
-                       // Update times\r
-                       tracking.timeRemaining = (file.size - tracking.bytesUploaded) * 8 / tracking.movingAverageSpeed;\r
-                       tracking.timeElapsed = (now - tracking.startTime) / 1000;\r
-                       \r
-                       // Update percent\r
-                       tracking.percentUploaded = (tracking.bytesUploaded / file.size * 100);\r
-               }\r
-               \r
-               return tracking;\r
-       };\r
-       SWFUpload.speed.removeTracking = function (file, trackingList) {\r
-               try {\r
-                       trackingList[file.id] = null;\r
-                       delete trackingList[file.id];\r
-               } catch (ex) {\r
-               }\r
-       };\r
-       \r
-       SWFUpload.speed.formatUnits = function (baseNumber, unitDivisors, unitLabels, singleFractional) {\r
-               var i, unit, unitDivisor, unitLabel;\r
-\r
-               if (baseNumber === 0) {\r
-                       return "0 " + unitLabels[unitLabels.length - 1];\r
-               }\r
-               \r
-               if (singleFractional) {\r
-                       unit = baseNumber;\r
-                       unitLabel = unitLabels.length >= unitDivisors.length ? unitLabels[unitDivisors.length - 1] : "";\r
-                       for (i = 0; i < unitDivisors.length; i++) {\r
-                               if (baseNumber >= unitDivisors[i]) {\r
-                                       unit = (baseNumber / unitDivisors[i]).toFixed(2);\r
-                                       unitLabel = unitLabels.length >= i ? " " + unitLabels[i] : "";\r
-                                       break;\r
-                               }\r
-                       }\r
-                       \r
-                       return unit + unitLabel;\r
-               } else {\r
-                       var formattedStrings = [];\r
-                       var remainder = baseNumber;\r
-                       \r
-                       for (i = 0; i < unitDivisors.length; i++) {\r
-                               unitDivisor = unitDivisors[i];\r
-                               unitLabel = unitLabels.length > i ? " " + unitLabels[i] : "";\r
-                               \r
-                               unit = remainder / unitDivisor;\r
-                               if (i < unitDivisors.length -1) {\r
-                                       unit = Math.floor(unit);\r
-                               } else {\r
-                                       unit = unit.toFixed(2);\r
-                               }\r
-                               if (unit > 0) {\r
-                                       remainder = remainder % unitDivisor;\r
-                                       \r
-                                       formattedStrings.push(unit + unitLabel);\r
-                               }\r
-                       }\r
-                       \r
-                       return formattedStrings.join(" ");\r
-               }\r
-       };\r
-       \r
-       SWFUpload.speed.formatBPS = function (baseNumber) {\r
-               var bpsUnits = [1073741824, 1048576, 1024, 1], bpsUnitLabels = ["Gbps", "Mbps", "Kbps", "bps"];\r
-               return SWFUpload.speed.formatUnits(baseNumber, bpsUnits, bpsUnitLabels, true);\r
-       \r
-       };\r
-       SWFUpload.speed.formatTime = function (baseNumber) {\r
-               var timeUnits = [86400, 3600, 60, 1], timeUnitLabels = ["d", "h", "m", "s"];\r
-               return SWFUpload.speed.formatUnits(baseNumber, timeUnits, timeUnitLabels, false);\r
-       \r
-       };\r
-       SWFUpload.speed.formatBytes = function (baseNumber) {\r
-               var sizeUnits = [1073741824, 1048576, 1024, 1], sizeUnitLabels = ["GB", "MB", "KB", "bytes"];\r
-               return SWFUpload.speed.formatUnits(baseNumber, sizeUnits, sizeUnitLabels, true);\r
-       \r
-       };\r
-       SWFUpload.speed.formatPercent = function (baseNumber) {\r
-               return baseNumber.toFixed(2) + " %";\r
-       };\r
-       \r
-       SWFUpload.speed.calculateMovingAverage = function (history) {\r
-               var vals = [], size, sum = 0.0, mean = 0.0, varianceTemp = 0.0, variance = 0.0, standardDev = 0.0;\r
-               var i;\r
-               var mSum = 0, mCount = 0;\r
-               \r
-               size = history.length;\r
-               \r
-               // Check for sufficient data\r
-               if (size >= 8) {\r
-                       // Clone the array and Calculate sum of the values \r
-                       for (i = 0; i < size; i++) {\r
-                               vals[i] = history[i];\r
-                               sum += vals[i];\r
-                       }\r
-\r
-                       mean = sum / size;\r
-\r
-                       // Calculate variance for the set\r
-                       for (i = 0; i < size; i++) {\r
-                               varianceTemp += Math.pow((vals[i] - mean), 2);\r
-                       }\r
-\r
-                       variance = varianceTemp / size;\r
-                       standardDev = Math.sqrt(variance);\r
-                       \r
-                       //Standardize the Data\r
-                       for (i = 0; i < size; i++) {\r
-                               vals[i] = (vals[i] - mean) / standardDev;\r
-                       }\r
-\r
-                       // Calculate the average excluding outliers\r
-                       var deviationRange = 2.0;\r
-                       for (i = 0; i < size; i++) {\r
-                               \r
-                               if (vals[i] <= deviationRange && vals[i] >= -deviationRange) {\r
-                                       mCount++;\r
-                                       mSum += history[i];\r
-                               }\r
-                       }\r
-                       \r
-               } else {\r
-                       // Calculate the average (not enough data points to remove outliers)\r
-                       mCount = size;\r
-                       for (i = 0; i < size; i++) {\r
-                               mSum += history[i];\r
-                       }\r
-               }\r
-\r
-               return mSum / mCount;\r
-       };\r
-       \r
-}</pre>    \r
-</body>\r
-</html>
\ No newline at end of file