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
|
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
// This file creates a set of helper functions that will be loaded for all html
// templates. These functions should be self contained and not rely on any
// external dependencies as they are loaded prior to the application. We may
// want to change this later, but for now this should be thought of as a
// "purely functional" helper system.
define([
"core/utils",
"d3"
],
function(utils, d3) {
var Helpers = {};
Helpers.removeSpecialCharacters = utils.removeSpecialCharacters;
Helpers.safeURL = utils.safeURLName;
Helpers.imageUrl = function(path) {
// TODO: add dynamic path for different deploy targets
return path;
};
// Get the URL for documentation, wiki, wherever we store it.
// update the URLs in documentation_urls.js
Helpers.docs = {
"docs": "http://docs.couchdb.org/en/latest/intro/api.html#documents",
"all_dbs": "http://docs.couchdb.org/en/latest/api/server/common.html?highlight=all_dbs#get--_all_dbs",
"replication_doc": "http://docs.couchdb.org/en/latest/replication/replicator.html#basics",
"design_doc": "http://docs.couchdb.org/en/latest/couchapp/ddocs.html#design-docs",
"view_functions": "http://docs.couchdb.org/en/latest/couchapp/ddocs.html#view-functions",
"map_functions": "http://docs.couchdb.org/en/latest/couchapp/ddocs.html#map-functions",
"reduce_functions": "http://docs.couchdb.org/en/latest/couchapp/ddocs.html#reduce-and-rereduce-functions",
"api_reference": "http://docs.couchdb.org/en/latest/http-api.html",
"database_permission": "http://docs.couchdb.org/en/latest/api/database/security.html#db-security",
"stats": "http://docs.couchdb.org/en/latest/api/server/common.html?highlight=stats#get--_stats",
"_active_tasks": "http://docs.couchdb.org/en/latest/api/server/common.html?highlight=stats#active-tasks",
"log": "http://docs.couchdb.org/en/latest/api/server/common.html?highlight=stats#log",
"config": "http://docs.couchdb.org/en/latest/config/index.html",
"views": "http://docs.couchdb.org/en/latest/intro/overview.html#views",
"changes": "http://docs.couchdb.org/en/latest/api/database/changes.html?highlight=changes#post--db-_changes"
};
Helpers.getDocUrl = function(docKey){
return Helpers.docs[docKey] || '#';
};
// File size pretty printing, taken from futon.format.js
Helpers.formatSize = function(size) {
var jump = 512;
if (size < jump) return size + " bytes";
var units = ["KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
var i = 0;
while (size >= jump && i < units.length) {
i += 1;
size /= 1024;
}
return size.toFixed(1) + ' ' + units[i - 1];
};
Helpers.formatDate = function(timestamp){
var format = d3.time.format("%b. %e at %H:%M%p");
return format(new Date(timestamp*1000));
};
return Helpers;
});
|
