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
|
// Copyright (C) 2011 The Android Open Source Project
//
// 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.
package com.google.gerrit.server.permissions;
import static com.google.common.collect.ImmutableList.toImmutableList;
import com.google.auto.value.AutoValue;
import com.google.auto.value.extension.memoized.Memoized;
import com.google.common.cache.Cache;
import com.google.common.collect.ImmutableList;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.entities.AccessSection;
import com.google.gerrit.server.cache.CacheModule;
import com.google.gerrit.server.util.MostSpecificComparator;
import com.google.inject.Inject;
import com.google.inject.Module;
import com.google.inject.Singleton;
import com.google.inject.name.Named;
import java.util.ArrayList;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
/**
* Caches the order AccessSections should be sorted for evaluation.
*
* <p>Access specifications for a more specific ref (eg. refs/heads/master rather than refs/heads/*)
* take precedence in ACL evaluations. So for each combination of (ref, list of access specs) we
* have to order the access specs by their distance from the ref to be matched. This is expensive,
* so cache the sorted ordering.
*/
@Singleton
public class SectionSortCache {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
private static final String CACHE_NAME = "permission_sort";
public static Module module() {
return new CacheModule() {
@Override
protected void configure() {
cache(CACHE_NAME, EntryKey.class, EntryVal.class);
bind(SectionSortCache.class);
}
};
}
private final Cache<EntryKey, EntryVal> cache;
@Inject
SectionSortCache(@Named(CACHE_NAME) Cache<EntryKey, EntryVal> cache) {
this.cache = cache;
}
/**
* Sorts the given sections in-place, but does not disturb ordering between equally exact
* sections.
*/
void sort(String ref, List<AccessSection> sections) {
final int cnt = sections.size();
if (cnt <= 1) {
return;
}
EntryKey key = EntryKey.create(ref, sections);
EntryVal val;
try {
val = cache.get(key, new Loader(key, sections));
} catch (ExecutionException e) {
logger.atWarning().withCause(e).log("Error happened while sorting access sections.");
return;
}
ImmutableList<Integer> order = val.order();
List<AccessSection> sorted = new ArrayList<>();
for (int i = 0; i < cnt; i++) {
sorted.add(sections.get(order.get(i)));
}
for (int i = 0; i < cnt; i++) {
sections.set(i, sorted.get(i));
}
}
private static class Loader implements Callable<EntryVal> {
private final List<AccessSection> sections;
EntryKey key;
Loader(EntryKey key, List<AccessSection> sections) {
this.key = key;
this.sections = sections;
}
@Override
public EntryVal call() throws Exception {
// We use IdentityHashMap (which uses reference equality for keys/values) to preserve distinct
// entries in the map for identical AccessSection keys
IdentityHashMap<AccessSection, Integer> srcMap = new IdentityHashMap<>();
for (int i = 0; i < sections.size(); i++) {
srcMap.put(sections.get(i), i);
}
ImmutableList<AccessSection> sorted =
sections.stream()
.sorted(new MostSpecificComparator(key.ref()))
.collect(toImmutableList());
ImmutableList.Builder<Integer> order = ImmutableList.builderWithExpectedSize(sections.size());
for (int i = 0; i < sorted.size(); i++) {
order.add(srcMap.get(sorted.get(i)));
}
return EntryVal.create(order.build());
}
}
@AutoValue
abstract static class EntryKey {
public abstract String ref();
public abstract List<String> patterns();
static EntryKey create(String refName, List<AccessSection> sections) {
List<String> patterns = new ArrayList<>(sections.size());
for (AccessSection s : sections) {
patterns.add(s.getName());
}
return new AutoValue_SectionSortCache_EntryKey(refName, ImmutableList.copyOf(patterns));
}
@Memoized
@Override
public int hashCode() {
int hc = ref().hashCode();
for (String n : patterns()) {
hc = hc * 31 + n.hashCode();
}
return hc;
}
}
@AutoValue
abstract static class EntryVal {
/**
* Maps the input index to the output index.
*
* <p>For {@code x == order[y]} the expression means move the item at source position {@code x}
* to the output position {@code y}.
*/
abstract ImmutableList<Integer> order();
static EntryVal create(ImmutableList<Integer> order) {
return new AutoValue_SectionSortCache_EntryVal(order);
}
}
}
|
