/
object_id.rb
395 lines (361 loc) · 10.4 KB
/
object_id.rb
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
# Copyright (C) 2009-2014 MongoDB Inc.
#
# 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.
require "digest/md5"
require "socket"
require "thread"
module BSON
# Represents object_id data.
#
# @see http://bsonspec.org/#/specification
#
# @since 2.0.0
class ObjectId
include Comparable
include JSON
# A object_id is type 0x07 in the BSON spec.
#
# @since 2.0.0
BSON_TYPE = 7.chr.force_encoding(BINARY).freeze
# Check equality of the object id with another object.
#
# @example Check if the object id is equal to the other.
# object_id == other
#
# @param [ Object ] other The object to check against.
#
# @return [ true, false ] If the objects are equal.
#
# @since 2.0.0
def ==(other)
return false unless other.is_a?(ObjectId)
to_bson == other.to_bson
end
alias :eql? :==
# Check case equality on the object id.
#
# @example Check case equality.
# object_id === other
#
# @param [ Object ] other The object to check against.
#
# @return [ true, false ] If the objects are equal in a case.
#
# @since 2.0.0
def ===(other)
return to_str === other.to_str if other.respond_to?(:to_str)
super
end
# Return the object id as a JSON hash representation.
#
# @example Get the object id as JSON.
# object_id.as_json
#
# @return [ Hash ] The object id as a JSON hash.
#
# @since 2.0.0
def as_json(*args)
{ "$oid" => to_s }
end
# Compare this object id with another object for use in sorting.
#
# @example Compare the object id with the other object.
# object <=> other
#
# @param [ Object ] other The object to compare to.
#
# @return [ Integer ] The result of the comparison.
#
# @since 2.0.0
def <=>(other)
to_bson <=> other.to_bson
end
# Return the UTC time at which this ObjectId was generated. This may
# be used instread of a created_at timestamp since this information
# is always encoded in the object id.
#
# @example Get the generation time.
# object_id.generation_time
#
# @return [ Time ] The time the id was generated.
#
# @since 2.0.0
def generation_time
::Time.at(to_bson.unpack("N")[0]).utc
end
# Get the hash value for the object id.
#
# @example Get the hash value.
# object_id.hash
#
# @return [ Integer ] The hash value.
#
# @since 2.0.0
def hash
to_bson.hash
end
# Get a nice string for use with object inspection.
#
# @example Inspect the object id.
# object_id.inspect
#
# @return [ String ] The object id in form BSON::ObjectId('id')
#
# @since 2.0.0
def inspect
"<BSON::ObjectId:0x#{object_id} data=#{to_s}>"
end
# Dump the raw bson when calling Marshal.dump.
#
# @example Dump the raw bson.
# Marshal.dump(object_id)
#
# @return [ String ] The raw bson bytes.
#
# @since 2.0.0
def marshal_dump
to_bson
end
# Unmarshal the data into an object id.
#
# @example Unmarshal the data.
# Marshal.load(data)
#
# @param [ String ] data The raw bson bytes.
#
# @return [ String ] The raw bson bytes.
#
# @since 2.0.0
def marshal_load(data)
@raw_data = data
end
# Get the object id as it's raw BSON data.
#
# @example Get the raw bson bytes.
# object_id.to_bson
#
# @note Since Moped's BSON and MongoDB BSON before 2.0.0 have different
# internal representations, we will attempt to repair the data for cases
# where the object was instantiated in a non-standard way. (Like a
# Marshal.load)
#
# @return [ String ] The raw bytes.
#
# @see http://bsonspec.org/#/specification
#
# @since 2.0.0
def to_bson(encoded = ''.force_encoding(BINARY))
repair if defined?(@data)
@raw_data ||= @@generator.next_object_id
encoded << @raw_data
end
# Get the string representation of the object id.
#
# @example Get the object id as a string.
# object_id.to_s
#
# @return [ String ] The object id as a string.
#
# @since 2.0.0
def to_s
to_bson.to_hex_string.force_encoding(UTF8)
end
alias :to_str :to_s
# Raised when trying to create an object id with invalid data.
#
# @since 2.0.0
class Invalid < RuntimeError; end
private
def repair
@raw_data = @data.to_bson_object_id
remove_instance_variable(:@data)
end
class << self
# Deserialize the object id from raw BSON bytes.
#
# @example Get the object id from BSON.
# ObjectId.from_bson(bson)
#
# @param [ String ] bson The raw BSON bytes.
#
# @return [ BSON::ObjectId ] The object id.
#
# @since 2.0.0
def from_bson(bson)
from_data(bson.read(12))
end
# Create a new object id from raw bytes.
#
# @example Create an object id from raw bytes.
# BSON::ObjectId.from_data(data)
#
# @param [ String ] data The raw bytes.
#
# @return [ ObjectId ] The new object id.
#
# @since 2.0.0
def from_data(data)
object_id = allocate
object_id.instance_variable_set(:@raw_data, data)
object_id
end
# Create a new object id from a string.
#
# @example Create an object id from the string.
# BSON::ObjectId.from_string(id)
#
# @param [ String ] string The string to create the id from.
#
# @raise [ BSON::ObjectId::Invalid ] If the provided string is invalid.
#
# @return [ BSON::ObjectId ] The new object id.
#
# @since 2.0.0
def from_string(string)
unless legal?(string)
raise Invalid.new("'#{string}' is an invalid ObjectId.")
end
from_data([ string ].pack("H*"))
end
# Create a new object id from a time.
#
# @example Create an object id from a time.
# BSON::ObjectId.from_id(time)
#
# @example Create an object id from a time, ensuring uniqueness.
# BSON::ObjectId.from_id(time, unique: true)
#
# @param [ Time ] time The time to generate from.
# @param [ Hash ] options The options.
#
# @option options [ true, false ] :unique Whether the id should be
# unique.
#
# @return [ ObjectId ] The new object id.
#
# @since 2.0.0
def from_time(time, options = {})
from_data(options[:unique] ? @@generator.next_object_id(time.to_i) : [ time.to_i ].pack("Nx8"))
end
# Determine if the provided string is a legal object id.
#
# @example Is the string a legal object id?
# BSON::ObjectId.legal?(string)
#
# @param [ String ] The string to check.
#
# @return [ true, false ] If the string is legal.
#
# @since 2.0.0
def legal?(string)
string.to_s =~ /^[0-9a-f]{24}$/i ? true : false
end
# Executes the provided block only if the size of the provided object is
# 12. Used in legacy id repairs.
#
# @example Execute in a repairing block.
# BSON::ObjectId.repair("test") { obj }
#
# @param [ String, Array ] object The object to repair.
#
# @raise [ Invalid ] If the array is not 12 elements.
#
# @return [ String ] The result of the block.
#
# @since 2.0.0
def repair(object)
if object.size == 12
block_given? ? yield(object) : object
else
raise Invalid.new("#{object.inspect} is not a valid object id.")
end
end
end
# Inner class that encapsulates the behaviour of actually generating each
# part of the ObjectId.
#
# @api private
#
# @since 2.0.0
class Generator
# @!attribute machine_id
# @return [ String ] The unique machine id.
# @since 2.0.0
attr_reader :machine_id
# Instantiate the new object id generator. Will set the machine id once
# on the initial instantiation.
#
# @example Instantiate the generator.
# BSON::ObjectId::Generator.new
#
# @since 2.0.0
def initialize
@counter = 0
@machine_id = Digest::MD5.digest(Socket.gethostname).unpack("N")[0]
@mutex = Mutex.new
end
# Return object id data based on the current time, incrementing the
# object id counter. Will use the provided time if not nil.
#
# @example Get the next object id data.
# generator.next_object_id
#
# @param [ Time ] time The optional time to generate with.
#
# @return [ String ] The raw object id bytes.
#
# @since 2.0.0
def next_object_id(time = nil)
@mutex.lock
begin
count = @counter = (@counter + 1) % 0xFFFFFF
ensure
@mutex.unlock rescue nil
end
generate(time || ::Time.new.to_i, count)
end
# Generate object id data for a given time using the provided counter.
#
# @example Generate the object id bytes.
# generator.generate(time)
#
# @param [ Integer ] time The time since epoch in seconds.
# @param [ Integer ] counter The optional counter.
#
# @return [ String ] The raw object id bytes.
#
# @since 2.0.0
def generate(time, counter = 0)
[ time, machine_id, process_id, counter << 8 ].pack("N NX lXX NX")
end
private
if Environment.jruby?
def process_id
"#{Process.pid}#{Thread.current.object_id}".hash % 0xFFFF
end
else
def process_id
Process.pid % 0xFFFF
end
end
end
# We keep one global generator for object ids.
#
# @since 2.0.0
@@generator = Generator.new
# Register this type when the module is loaded.
#
# @since 2.0.0
Registry.register(BSON_TYPE, self)
end
end