summaryrefslogtreecommitdiffstats
path: root/deluge/ui/web/js/deluge-all/Formatters.js
blob: 443bfdf562635a36036675931a9cdb0234036b2e (plain)
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
/**
 * Deluge.Formatters.js
 *
 * Copyright (c) Damien Churchill 2009-2010 <damoxc@gmail.com>
 *
 * This file is part of Deluge and is licensed under GNU General Public License 3.0, or later, with
 * the additional special exception to link portions of this program with the OpenSSL library.
 * See LICENSE for more details.
 */

/**
 * A collection of functions for string formatting values.
 * @class Deluge.Formatters
 * @author Damien Churchill <damoxc@gmail.com>
 * @version 1.3
 * @singleton
 */
Deluge.Formatters = {
    /**
     * Formats a date string in the date representation of the current locale,
     * based on the systems timezone.
     *
     * @param {Number} timestamp time in seconds since the Epoch.
     * @return {String} a string in the date representation of the current locale
     * or "" if seconds < 0.
     */
    date: function (timestamp) {
        function zeroPad(num, count) {
            var numZeropad = num + '';
            while (numZeropad.length < count) {
                numZeropad = '0' + numZeropad;
            }
            return numZeropad;
        }
        timestamp = timestamp * 1000;
        var date = new Date(timestamp);
        return String.format(
            '{0}/{1}/{2} {3}:{4}:{5}',
            zeroPad(date.getDate(), 2),
            zeroPad(date.getMonth() + 1, 2),
            date.getFullYear(),
            zeroPad(date.getHours(), 2),
            zeroPad(date.getMinutes(), 2),
            zeroPad(date.getSeconds(), 2)
        );
    },

    /**
     * Formats the bytes value into a string with KiB, MiB or GiB units.
     *
     * @param {Number} bytes the filesize in bytes
     * @param {Boolean} showZero pass in true to displays 0 values
     * @return {String} formatted string with KiB, MiB or GiB units.
     */
    size: function (bytes, showZero) {
        if (!bytes && !showZero) return '';
        bytes = bytes / 1024.0;

        if (bytes < 1024) {
            return bytes.toFixed(1) + ' KiB';
        } else {
            bytes = bytes / 1024;
        }

        if (bytes < 1024) {
            return bytes.toFixed(1) + ' MiB';
        } else {
            bytes = bytes / 1024;
        }

        return bytes.toFixed(1) + ' GiB';
    },

    /**
     * Formats the bytes value into a string with K, M or G units.
     *
     * @param {Number} bytes the filesize in bytes
     * @param {Boolean} showZero pass in true to displays 0 values
     * @return {String} formatted string with K, M or G units.
     */
    sizeShort: function (bytes, showZero) {
        if (!bytes && !showZero) return '';
        bytes = bytes / 1024.0;

        if (bytes < 1024) {
            return bytes.toFixed(1) + ' K';
        } else {
            bytes = bytes / 1024;
        }

        if (bytes < 1024) {
            return bytes.toFixed(1) + ' M';
        } else {
            bytes = bytes / 1024;
        }

        return bytes.toFixed(1) + ' G';
    },

    /**
     * Formats a string to display a transfer speed utilizing {@link #size}
     *
     * @param {Number} bytes the number of bytes per second
     * @param {Boolean} showZero pass in true to displays 0 values
     * @return {String} formatted string with KiB, MiB or GiB units.
     */
    speed: function (bytes, showZero) {
        return !bytes && !showZero ? '' : fsize(bytes, showZero) + '/s';
    },

    /**
     * Formats a string to show time in a human readable form.
     *
     * @param {Number} time the number of seconds
     * @return {String} a formatted time string. will return '' if seconds == 0
     */
    timeRemaining: function (time) {
        if (time <= 0) {
            return '&infin;';
        }
        time = time.toFixed(0);
        if (time < 60) {
            return time + 's';
        } else {
            time = time / 60;
        }

        if (time < 60) {
            var minutes = Math.floor(time);
            var seconds = Math.round(60 * (time - minutes));
            if (seconds > 0) {
                return minutes + 'm ' + seconds + 's';
            } else {
                return minutes + 'm';
            }
        } else {
            time = time / 60;
        }

        if (time < 24) {
            var hours = Math.floor(time);
            var minutes = Math.round(60 * (time - hours));
            if (minutes > 0) {
                return hours + 'h ' + minutes + 'm';
            } else {
                return hours + 'h';
            }
        } else {
            time = time / 24;
        }

        var days = Math.floor(time);
        var hours = Math.round(24 * (time - days));
        if (hours > 0) {
            return days + 'd ' + hours + 'h';
        } else {
            return days + 'd';
        }
    },

    /**
     * Simply returns the value untouched, for when no formatting is required.
     *
     * @param {Mixed} value the value to be displayed
     * @return the untouched value.
     */
    plain: function (value) {
        return value;
    },

    cssClassEscape: function (value) {
        return value.toLowerCase().replace('.', '_');
    },
};
var fsize = Deluge.Formatters.size;
var fsize_short = Deluge.Formatters.sizeShort;
var fspeed = Deluge.Formatters.speed;
var ftime = Deluge.Formatters.timeRemaining;
var fdate = Deluge.Formatters.date;
var fplain = Deluge.Formatters.plain;
Ext.util.Format.cssClassEscape = Deluge.Formatters.cssClassEscape;