Skip to content

Commit e991b4a

Browse files
addaleaxaddaleax
authored
feat(uuidhelpers): move snippet here (#6)
* feat(uuidhelpers): move snippet here * fixup: remove dashes from HexData(), wrap in IIFE and selectively epxose
1 parent 9a3196a commit e991b4a

File tree

4 files changed

+372
-0
lines changed

4 files changed

+372
-0
lines changed

‎snippets/uuidhelpers/LICENSE

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2020 MongoDB Inc.
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.
192+

‎snippets/uuidhelpers/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# uuidhelpers
2+
3+
A new home for the C#/.NET driver's [uuidhelpers.js](https://github.com/mongodb/mongo-csharp-driver/blob/ac2b2a61c6b7a193cf0266dfb8c65f86c2bf7572/uuidhelpers.js).

‎snippets/uuidhelpers/index.js

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
// originally taken from https://github.com/mongodb/mongo-csharp-driver/blob/ac2b2a61c6b7a193cf0266dfb8c65f86c2bf7572/uuidhelpers.js
2+
3+
// Javascript helper functions for parsing and displaying UUIDs in the MongoDB shell.
4+
// To create BinData values corresponding to the various driver encodings use:
5+
// var s = "{00112233-4455-6677-8899-aabbccddeeff}";
6+
// var uuid = UUID(s); // new Standard encoding
7+
// var juuid = JUUID(s); // JavaLegacy encoding
8+
// var csuuid = CSUUID(s); // CSharpLegacy encoding
9+
// var pyuuid = PYUUID(s); // PythonLegacy encoding
10+
// To convert the various BinData values back to human readable UUIDs use:
11+
// uuid.toUUID() => 'UUID("00112233-4455-6677-8899-aabbccddeeff")'
12+
// juuid.ToJUUID() => 'JUUID("00112233-4455-6677-8899-aabbccddeeff")'
13+
// csuuid.ToCSUUID() => 'CSUUID("00112233-4455-6677-8899-aabbccddeeff")'
14+
// pyuuid.ToPYUUID() => 'PYUUID("00112233-4455-6677-8899-aabbccddeeff")'
15+
// With any of the UUID variants you can use toHexUUID to echo the raw BinData with subtype and hex string:
16+
// uuid.toHexUUID() => 'HexData(4, "00112233445566778899aabbccddeeff")'
17+
// juuid.toHexUUID() => 'HexData(3, "7766554433221100ffeeddccbbaa9988")'
18+
// csuuid.toHexUUID() => 'HexData(3, "33221100554477668899aabbccddeeff")'
19+
// pyuuid.toHexUUID() => 'HexData(3, "00112233445566778899aabbccddeeff")'
20+
21+
(() => {
22+
function HexToBase64(hex) {
23+
var base64Digits = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
24+
var base64 = "";
25+
var group;
26+
for (var i = 0; i < 30; i += 6) {
27+
group = parseInt(hex.substr(i, 6), 16);
28+
base64 += base64Digits[(group >> 18) & 0x3f];
29+
base64 += base64Digits[(group >> 12) & 0x3f];
30+
base64 += base64Digits[(group >> 6) & 0x3f];
31+
base64 += base64Digits[group & 0x3f];
32+
}
33+
group = parseInt(hex.substr(30, 2), 16);
34+
base64 += base64Digits[(group >> 2) & 0x3f];
35+
base64 += base64Digits[(group << 4) & 0x3f];
36+
base64 += "==";
37+
return base64;
38+
}
39+
40+
function Base64ToHex(base64) {
41+
var base64Digits = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
42+
var hexDigits = "0123456789abcdef";
43+
var hex = "";
44+
for (var i = 0; i < 24; ) {
45+
var e1 = base64Digits.indexOf(base64[i++]);
46+
var e2 = base64Digits.indexOf(base64[i++]);
47+
var e3 = base64Digits.indexOf(base64[i++]);
48+
var e4 = base64Digits.indexOf(base64[i++]);
49+
var c1 = (e1 << 2) | (e2 >> 4);
50+
var c2 = ((e2 & 15) << 4) | (e3 >> 2);
51+
var c3 = ((e3 & 3) << 6) | e4;
52+
hex += hexDigits[c1 >> 4];
53+
hex += hexDigits[c1 & 15];
54+
if (e3 != 64) {
55+
hex += hexDigits[c2 >> 4];
56+
hex += hexDigits[c2 & 15];
57+
}
58+
if (e4 != 64) {
59+
hex += hexDigits[c3 >> 4];
60+
hex += hexDigits[c3 & 15];
61+
}
62+
}
63+
return hex;
64+
}
65+
66+
function UUID(uuid) {
67+
var hex = uuid.replace(/[{}-]/g, ""); // remove extra characters
68+
var base64 = HexToBase64(hex);
69+
return new BinData(4, base64); // new subtype 4
70+
}
71+
72+
function JUUID(uuid) {
73+
var hex = uuid.replace(/[{}-]/g, ""); // remove extra characters
74+
var msb = hex.substr(0, 16);
75+
var lsb = hex.substr(16, 16);
76+
msb = msb.substr(14, 2) + msb.substr(12, 2) + msb.substr(10, 2) + msb.substr(8, 2) + msb.substr(6, 2) + msb.substr(4, 2) + msb.substr(2, 2) + msb.substr(0, 2);
77+
lsb = lsb.substr(14, 2) + lsb.substr(12, 2) + lsb.substr(10, 2) + lsb.substr(8, 2) + lsb.substr(6, 2) + lsb.substr(4, 2) + lsb.substr(2, 2) + lsb.substr(0, 2);
78+
hex = msb + lsb;
79+
var base64 = HexToBase64(hex);
80+
return new BinData(3, base64);
81+
}
82+
83+
function CSUUID(uuid) {
84+
var hex = uuid.replace(/[{}-]/g, ""); // remove extra characters
85+
var a = hex.substr(6, 2) + hex.substr(4, 2) + hex.substr(2, 2) + hex.substr(0, 2);
86+
var b = hex.substr(10, 2) + hex.substr(8, 2);
87+
var c = hex.substr(14, 2) + hex.substr(12, 2);
88+
var d = hex.substr(16, 16);
89+
hex = a + b + c + d;
90+
var base64 = HexToBase64(hex);
91+
return new BinData(3, base64);
92+
}
93+
94+
function PYUUID(uuid) {
95+
var hex = uuid.replace(/[{}-]/g, ""); // remove extra characters
96+
var base64 = HexToBase64(hex);
97+
return new BinData(3, base64);
98+
}
99+
100+
BinData.prototype.toUUID = function () {
101+
var hex = Base64ToHex(this.base64()); // don't use BinData's hex function because it has bugs in older versions of the shell
102+
var uuid = hex.substr(0, 8) + '-' + hex.substr(8, 4) + '-' + hex.substr(12, 4) + '-' + hex.substr(16, 4) + '-' + hex.substr(20, 12);
103+
return 'UUID("' + uuid + '")';
104+
}
105+
106+
BinData.prototype.toJUUID = function () {
107+
var hex = Base64ToHex(this.base64()); // don't use BinData's hex function because it has bugs in older versions of the shell
108+
var msb = hex.substr(0, 16);
109+
var lsb = hex.substr(16, 16);
110+
msb = msb.substr(14, 2) + msb.substr(12, 2) + msb.substr(10, 2) + msb.substr(8, 2) + msb.substr(6, 2) + msb.substr(4, 2) + msb.substr(2, 2) + msb.substr(0, 2);
111+
lsb = lsb.substr(14, 2) + lsb.substr(12, 2) + lsb.substr(10, 2) + lsb.substr(8, 2) + lsb.substr(6, 2) + lsb.substr(4, 2) + lsb.substr(2, 2) + lsb.substr(0, 2);
112+
hex = msb + lsb;
113+
var uuid = hex.substr(0, 8) + '-' + hex.substr(8, 4) + '-' + hex.substr(12, 4) + '-' + hex.substr(16, 4) + '-' + hex.substr(20, 12);
114+
return 'JUUID("' + uuid + '")';
115+
}
116+
117+
BinData.prototype.toCSUUID = function () {
118+
var hex = Base64ToHex(this.base64()); // don't use BinData's hex function because it has bugs in older versions of the shell
119+
var a = hex.substr(6, 2) + hex.substr(4, 2) + hex.substr(2, 2) + hex.substr(0, 2);
120+
var b = hex.substr(10, 2) + hex.substr(8, 2);
121+
var c = hex.substr(14, 2) + hex.substr(12, 2);
122+
var d = hex.substr(16, 16);
123+
hex = a + b + c + d;
124+
var uuid = hex.substr(0, 8) + '-' + hex.substr(8, 4) + '-' + hex.substr(12, 4) + '-' + hex.substr(16, 4) + '-' + hex.substr(20, 12);
125+
return 'CSUUID("' + uuid + '")';
126+
}
127+
128+
BinData.prototype.toPYUUID = function () {
129+
var hex = Base64ToHex(this.base64()); // don't use BinData's hex function because it has bugs
130+
var uuid = hex.substr(0, 8) + '-' + hex.substr(8, 4) + '-' + hex.substr(12, 4) + '-' + hex.substr(16, 4) + '-' + hex.substr(20, 12);
131+
return 'PYUUID("' + uuid + '")';
132+
}
133+
134+
135+
BinData.prototype.toHexUUID = function () {
136+
var uuid = Base64ToHex(this.base64()); // don't use BinData's hex function because it has bugs
137+
return 'HexData(' + this.subtype() + ', "' + uuid + '")';
138+
}
139+
140+
// for compatibility with the new mongosh shell
141+
if (BinData.prototype.base64 === undefined && BinData.prototype.subtype === undefined) {
142+
BinData.prototype.base64 = function() { return this.buffer.base64Slice(); };
143+
BinData.prototype.subtype = function() { return this.sub_type; };
144+
}
145+
146+
function TestUUIDHelperFunctions() {
147+
var s = "{00112233-4455-6677-8899-aabbccddeeff}";
148+
var uuid = UUID(s);
149+
var juuid = JUUID(s);
150+
var csuuid = CSUUID(s);
151+
var pyuuid = PYUUID(s);
152+
print(uuid.toUUID());
153+
print(juuid.toJUUID());
154+
print(csuuid.toCSUUID());
155+
print(pyuuid.toPYUUID());
156+
print(uuid.toHexUUID());
157+
print(juuid.toHexUUID());
158+
print(csuuid.toHexUUID());
159+
print(pyuuid.toHexUUID());
160+
}
161+
162+
Object.assign(globalThis, {
163+
UUID, JUUID, CSUUID, PYUUID, TestUUIDHelperFunctions
164+
});
165+
166+
})();

‎snippets/uuidhelpers/package.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "@mongosh/snippet-uuidhelpers",
3+
"snippetName": "uuidhelpers",
4+
"version": "0.1.0",
5+
"description": "Mongosh snippet containing various small utilities for working with UUIDs.",
6+
"main": "index.js",
7+
"license": "Apache-2.0",
8+
"publishConfig": {
9+
"access": "public"
10+
}
11+
}

0 commit comments

Comments
 (0)