summaryrefslogtreecommitdiffstats
path: root/Bugzilla/Memcached.pm
blob: 1623296f8a2e35dbb073170705ea64c93e811002 (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
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

package Bugzilla::Memcached;

use 5.10.1;
use strict;
use warnings;

use Bugzilla::Error;
use Scalar::Util qw(blessed);
use List::Util qw(sum);
use Bugzilla::Util qw(trick_taint);
use URI::Escape;
use Encode;
use Sys::Syslog qw(:DEFAULT);

# memcached keys have a maximum length of 250 bytes
use constant MAX_KEY_LENGTH => 250;
use constant RATE_LIMIT_PREFIX => "rate:";

sub _new {
    my $invocant = shift;
    my $class = ref($invocant) || $invocant;
    my $self = {};

    # always return an object to simplify calling code when memcached is
    # disabled.
    my $servers = Bugzilla->localconfig->{memcached_servers};
    if (Bugzilla->feature('memcached') && $servers) {
        $self->{namespace} = Bugzilla->localconfig->{memcached_namespace};
        $self->{memcached} = Cache::Memcached::Fast->new({
            servers   => [ split(/[, ]+/, $servers) ],
            namespace => $self->{namespace},
            max_size  => 1024 * 1024 * 4,
        });
    }
    return bless($self, $class);
}

sub enabled {
    return $_[0]->{memcached} ? 1 : 0;
}

sub set {
    my ($self, $args) = @_;
    return unless $self->{memcached};

    # { key => $key, value => $value }
    if (exists $args->{key}) {
        $self->_set($args->{key}, $args->{value});
    }

    # { table => $table, id => $id, name => $name, data => $data }
    elsif (exists $args->{table} && exists $args->{id} && exists $args->{name}) {
        # For caching of Bugzilla::Object, we have to be able to clear the
        # cached values when given either the object's id or name.
        my ($table, $id, $name, $data) = @$args{qw(table id name data)};
        $self->_set("$table.id.$id", $data);
        if (defined $name) {
            $self->_set("$table.name_id.$name", $id);
            $self->_set("$table.id_name.$id", $name);
        }
    }

    else {
        ThrowCodeError('params_required', { function => "Bugzilla::Memcached::set",
                                            params   => [ 'key', 'table' ] });
    }
}

sub get {
    my ($self, $args) = @_;
    return unless $self->{memcached};

    # { key => $key }
    if (exists $args->{key}) {
        return $self->_get($args->{key});
    }

    # { table => $table, id => $id }
    elsif (exists $args->{table} && exists $args->{id}) {
        my ($table, $id) = @$args{qw(table id)};
        return $self->_get("$table.id.$id");
    }

    # { table => $table, name => $name }
    elsif (exists $args->{table} && exists $args->{name}) {
        my ($table, $name) = @$args{qw(table name)};
        return unless my $id = $self->_get("$table.name_id.$name");
        return $self->_get("$table.id.$id");
    }

    else {
        ThrowCodeError('params_required', { function => "Bugzilla::Memcached::get",
                                            params   => [ 'key', 'table' ] });
    }
}

sub set_config {
    my ($self, $args) = @_;
    return unless $self->{memcached};

    if (exists $args->{key}) {
        return $self->_set($self->_config_prefix . '.' . $args->{key}, $args->{data});
    }
    else {
        ThrowCodeError('params_required', { function => "Bugzilla::Memcached::set_config",
                                            params   => [ 'key' ] });
    }
}

sub get_config {
    my ($self, $args) = @_;
    return unless $self->{memcached};

    if (exists $args->{key}) {
        return $self->_get($self->_config_prefix . '.' . $args->{key});
    }
    else {
        ThrowCodeError('params_required', { function => "Bugzilla::Memcached::get_config",
                                            params   => [ 'key' ] });
    }
}

sub set_bloomfilter {
    my ($self, $args) = @_;
    return unless $self->{memcached};
    if (exists $args->{name}) {
        return $self->_set($self->_bloomfilter_prefix . '.' . $args->{name}, $args->{filter});
    }
    else {
        ThrowCodeError('params_required', { function => "Bugzilla::Memcached::set_bloomfilter",
                                            params   => [ 'name' ] });
    }
}

sub get_bloomfilter {
    my ($self, $args) = @_;
    return unless $self->{memcached};
    if (exists $args->{name}) {
        return $self->_get($self->_bloomfilter_prefix . '.' . $args->{name});
    }
    else {
        ThrowCodeError('params_required', { function => "Bugzilla::Memcached::set_bloomfilter",
                                            params   => [ 'name' ] });
    }
}

sub clear_bloomfilter {
    my ($self, $args) = @_;
    return unless $self->{memcached};
    if ($args && exists $args->{name}) {
        $self->_delete($self->_config_prefix . '.' . $args->{name});
    }
    else {
        $self->_inc_prefix("bloomfilter");
    }
}

sub clear {
    my ($self, $args) = @_;
    return unless $self->{memcached};

    # { key => $key }
    if (exists $args->{key}) {
        $self->_delete($args->{key});
    }

    # { table => $table, id => $id }
    elsif (exists $args->{table} && exists $args->{id}) {
        my ($table, $id) = @$args{qw(table id)};
        my $name = $self->_get("$table.id_name.$id");
        $self->_delete("$table.id.$id");
        $self->_delete("$table.name_id.$name") if defined $name;
        $self->_delete("$table.id_name.$id");
    }

    # { table => $table, name => $name }
    elsif (exists $args->{table} && exists $args->{name}) {
        my ($table, $name) = @$args{qw(table name)};
        return unless my $id = $self->_get("$table.name_id.$name");
        $self->_delete("$table.id.$id");
        $self->_delete("$table.name_id.$name");
        $self->_delete("$table.id_name.$id");
    }

    else {
        ThrowCodeError('params_required', { function => "Bugzilla::Memcached::clear",
                                            params   => [ 'key', 'table' ] });
    }
}

sub should_rate_limit {
    my ($self, $name, $rate_max, $rate_seconds, $tries) = @_;
    my $prefix    = RATE_LIMIT_PREFIX . $name . ':';
    my $memcached = $self->{memcached};

    $tries //= 3;

    for (0 .. $tries) {
        my $now = time;
        my ($key, @keys) = map { $prefix . ( $now - $_ ) } 0 .. $rate_seconds;
        $memcached->add($key, 0, $rate_seconds+1);
        my $tokens = $memcached->get_multi(@keys);
        my $cas    = $memcached->gets($key);
        $tokens->{$key} = $cas->[1]++;
        return 1 if sum(values %$tokens) >= $rate_max;
        return 0 if $memcached->cas($key, @$cas, $rate_seconds+1);
    }
    return 1;
}

sub clear_all {
    my ($self) = @_;
    return unless $self->{memcached};
    $self->_inc_prefix("global");
}

sub clear_config {
    my ($self, $args) = @_;
    return unless $self->{memcached};
    if ($args && exists $args->{key}) {
        $self->_delete($self->_config_prefix . '.' . $args->{key});
    }
    else {
        $self->_inc_prefix("config");
    }
}

# in order to clear all our keys, we add a prefix to all our keys.  when we
# need to "clear" all current keys, we increment the prefix.
sub _prefix {
    my ($self, $name) = @_;
    # we don't want to change prefixes in the middle of a request
    my $request_cache = Bugzilla->request_cache;
    my $request_cache_key = "memcached_prefix_$name";
    if (!$request_cache->{$request_cache_key}) {
        my $memcached = $self->{memcached};
        my $prefix = $memcached->get($name);
        if (!$prefix) {
            $prefix = time();
            if (!$memcached->add($name, $prefix)) {
                # if this failed, either another process set the prefix, or
                # memcached is down.  assume we lost the race, and get the new
                # value.  if that fails, memcached is down so use a dummy
                # prefix for this request.
                $prefix = $memcached->get($name) || 0;
            }
        }
        $request_cache->{$request_cache_key} = $prefix;
    }
    return $request_cache->{$request_cache_key};
}

sub _inc_prefix {
    my ($self, $name) = @_;
    my $memcached = $self->{memcached};
    if (!$memcached->incr($name, 1)) {
        $memcached->add($name, time());
    }
    delete Bugzilla->request_cache->{"memcached_prefix_$name"};

    # BMO - log that we've wiped the cache
    openlog('apache', 'cons,pid', 'local4');
    syslog('notice', encode_utf8("[memcached] $name cache cleared"));
    closelog();
}

sub _global_prefix {
    return $_[0]->_prefix("global");
}

sub _config_prefix {
    return $_[0]->_prefix("config");
}

sub _bloomfilter_prefix {
    return $_[0]->_prefix("bloomfilter");
}

sub _encode_key {
    my ($self, $key) = @_;
    $key = $self->_global_prefix . '.' . uri_escape_utf8($key);
    trick_taint($key) if defined $key;
    return length($self->{namespace} . $key) > MAX_KEY_LENGTH
        ? undef
        : $key;
}

sub _set {
    my ($self, $key, $value) = @_;
    if (blessed($value)) {
        # we don't support blessed objects
        ThrowCodeError('param_invalid', { function => "Bugzilla::Memcached::set",
                                          param    => "value" });
    }

    $key = $self->_encode_key($key)
        or return;
    return $self->{memcached}->set($key, $value);
}

sub _get {
    my ($self, $key) = @_;

    $key = $self->_encode_key($key)
        or return;
    return $self->{memcached}->get($key);
}

sub _delete {
    my ($self, $key) = @_;
    $key = $self->_encode_key($key)
        or return;
    return $self->{memcached}->delete($key);
}

1;

__END__

=head1 NAME

Bugzilla::Memcached - Interface between Bugzilla and Memcached.

=head1 SYNOPSIS

 use Bugzilla;

 my $memcached = Bugzilla->memcached;

 # grab data from the cache. there is no need to check if memcached is
 # available or enabled.
 my $data = $memcached->get({ key => 'data_key' });
 if (!defined $data) {
     # not in cache, generate the data and populate the cache for next time
     $data = some_long_process();
     $memcached->set({ key => 'data_key', value => $data });
 }
 # do something with $data

 # updating the profiles table directly shouldn't be attempted unless you know
 # what you're doing. if you do update a table directly, you need to clear that
 # object from memcached.
 $dbh->do("UPDATE profiles SET request_count=10 WHERE login_name=?", undef, $login);
 $memcached->clear({ table => 'profiles', name => $login });

=head1 DESCRIPTION

If Memcached is installed and configured, Bugzilla can use it to cache data
across requests and between webheads. Unlike the request and process caches,
only scalars, hashrefs, and arrayrefs can be stored in Memcached.

Memcached integration is only required for large installations of Bugzilla --
if you have multiple webheads then configuring Memcache is recommended.

L<Bugzilla::Memcached> provides an interface to a Memcached server/servers, with
the ability to get, set, or clear entries from the cache.

The stored value must be an unblessed hashref, unblessed array ref, or a
scalar.

All values are stored in the Memcached systems using the prefix configured with
the C<memcached_namespace> parameter, as well as an additional prefix managed
by this class to allow all values to be cleared when C<checksetup.pl> is
executed.

Do not create an instance of this object directly, instead use
L<Bugzilla-E<gt>memcached()|Bugzilla/memcached>.

=head1 METHODS

=over

=item C<enabled>

Returns true if Memcached support is available and enabled.

=back

=head2 Setting

Adds a value to Memcached.

=over

=item C<set({ key =E<gt> $key, value =E<gt> $value })>

Adds the C<value> using the specific C<key>.

=item C<set({ table =E<gt> $table, id =E<gt> $id, name =E<gt> $name, data =E<gt> $data })>

Adds the C<data> using a keys generated from the C<table>, C<id>, and C<name>.
All three parameters must be provided, however C<name> can be provided but set
to C<undef>.

This is a convenience method which allows cached data to be later retrieved by
specifying the C<table> and either the C<id> or C<name>.

=item C<set_config({ key =E<gt> $key, data =E<gt> $data })>

Adds the C<data> using the C<key> while identifying the data as part of
Bugzilla's configuration (such as fields, products, components, groups, etc).
Values set with C<set_config> are automatically cleared when changes are made
to Bugzilla's configuration.

=back

=head2 Getting

Retrieves a value from Memcached.  Returns C<undef> if no matching values were
found in the cache.

=over

=item C<get({ key =E<gt> $key })>

Return C<value> with the specified C<key>.

=item C<get({ table =E<gt> $table, id =E<gt> $id })>

Return C<value> with the specified C<table> and C<id>.

=item C<get({ table =E<gt> $table, name =E<gt> $name })>

Return C<value> with the specified C<table> and C<name>.

=item C<get_config({ key =E<gt> $key })>

Return C<value> with the specified C<key> from the configuration cache.  See
C<set_config> for more information.

=back

=head2 Clearing

Removes the matching value from Memcached.

=over

=item C<clear({ key =E<gt> $key })>

Removes C<value> with the specified C<key>.

=item C<clear({ table =E<gt> $table, id =E<gt> $id })>

Removes C<value> with the specified C<table> and C<id>, as well as the
corresponding C<table> and C<name> entry.

=item C<clear({ table =E<gt> $table, name =E<gt> $name })>

Removes C<value> with the specified C<table> and C<name>, as well as the
corresponding C<table> and C<id> entry.

=item C<clear_config({ key =E<gt> $key })>

Remove C<value> with the specified C<key> from the configuration cache.  See
C<set_config> for more information.

=item C<clear_config>

Removes all configuration related values from the cache.  See C<set_config> for
more information.

=item C<clear_all>

Removes all values from the cache.

=back

=head1 Bugzilla::Object CACHE

The main driver for Memcached integration is to allow L<Bugzilla::Object> based
objects to be automatically cached in Memcache. This is enabled on a
per-package basis by setting the C<USE_MEMCACHED> constant to any true value.

The current implementation is an opt-in (USE_MEMCACHED is false by default),
however this will change to opt-out once further testing has been completed
(USE_MEMCACHED will be true by default).

=head1 DIRECT DATABASE UPDATES

If an object is cached and the database is updated directly (instead of via
C<$object-E<gt>update()>), then it's possible for the data in the cache to be
out of sync with the database.

As an example let's consider an extension which adds a timestamp field
C<last_activitiy_ts> to the profiles table and user object which contains the
user's last activity.  If the extension were to call C<$user-E<gt>update()>,
then an audit entry would be created for each change to the C<last_activity_ts>
field, which is undesirable.

To remedy this, the extension updates the table directly.  It's critical with
Memcached that it then clears the cache:

 $dbh->do("UPDATE profiles SET last_activity_ts=? WHERE userid=?",
          undef, $timestamp, $user_id);
 Bugzilla->memcached->clear({ table => 'profiles', id => $user_id });