diff options
Diffstat (limited to 'java/com/google/gerrit/server/index/account/AccountField.java')
| -rw-r--r-- | java/com/google/gerrit/server/index/account/AccountField.java | 178 |
1 files changed, 178 insertions, 0 deletions
diff --git a/java/com/google/gerrit/server/index/account/AccountField.java b/java/com/google/gerrit/server/index/account/AccountField.java new file mode 100644 index 0000000000..f67a41d045 --- /dev/null +++ b/java/com/google/gerrit/server/index/account/AccountField.java @@ -0,0 +1,178 @@ +// Copyright (C) 2016 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.index.account; + +import static com.google.gerrit.index.FieldDef.exact; +import static com.google.gerrit.index.FieldDef.integer; +import static com.google.gerrit.index.FieldDef.prefix; +import static com.google.gerrit.index.FieldDef.storedOnly; +import static com.google.gerrit.index.FieldDef.timestamp; +import static java.util.stream.Collectors.toSet; + +import com.google.common.base.Predicates; +import com.google.common.collect.FluentIterable; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.Iterables; +import com.google.gerrit.common.data.GlobalCapability; +import com.google.gerrit.index.FieldDef; +import com.google.gerrit.index.RefState; +import com.google.gerrit.index.SchemaUtil; +import com.google.gerrit.reviewdb.client.RefNames; +import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.account.externalids.ExternalId; +import java.sql.Timestamp; +import java.util.Arrays; +import java.util.Collections; +import java.util.Locale; +import java.util.Set; +import org.eclipse.jgit.lib.ObjectId; + +/** Secondary index schemas for accounts. */ +public class AccountField { + public static final FieldDef<AccountState, Integer> ID = + integer("id").stored().build(a -> a.getAccount().getId().get()); + + /** + * External IDs. + * + * <p>This field includes secondary emails. Use this field only if the current user is allowed to + * see secondary emails (requires the {@link GlobalCapability#MODIFY_ACCOUNT} capability). + */ + public static final FieldDef<AccountState, Iterable<String>> EXTERNAL_ID = + exact("external_id") + .buildRepeatable(a -> Iterables.transform(a.getExternalIds(), id -> id.key().get())); + + /** + * Fuzzy prefix match on name and email parts. + * + * <p>This field includes parts from the secondary emails. Use this field only if the current user + * is allowed to see secondary emails (requires the {@link GlobalCapability#MODIFY_ACCOUNT} + * capability). + * + * <p>Use the {@link AccountField#NAME_PART_NO_SECONDARY_EMAIL} if the current user can't see + * secondary emails. + */ + public static final FieldDef<AccountState, Iterable<String>> NAME_PART = + prefix("name") + .buildRepeatable( + a -> getNameParts(a, Iterables.transform(a.getExternalIds(), ExternalId::email))); + + /** + * Fuzzy prefix match on name and preferred email parts. Parts of secondary emails are not + * included. + */ + public static final FieldDef<AccountState, Iterable<String>> NAME_PART_NO_SECONDARY_EMAIL = + prefix("name2") + .buildRepeatable(a -> getNameParts(a, Arrays.asList(a.getAccount().getPreferredEmail()))); + + public static final FieldDef<AccountState, String> FULL_NAME = + exact("full_name").build(a -> a.getAccount().getFullName()); + + public static final FieldDef<AccountState, String> ACTIVE = + exact("inactive").build(a -> a.getAccount().isActive() ? "1" : "0"); + + /** + * All emails (preferred email + secondary emails). Use this field only if the current user is + * allowed to see secondary emails (requires the 'Modify Account' capability). + * + * <p>Use the {@link AccountField#PREFERRED_EMAIL} if the current user can't see secondary emails. + */ + public static final FieldDef<AccountState, Iterable<String>> EMAIL = + prefix("email") + .buildRepeatable( + a -> + FluentIterable.from(a.getExternalIds()) + .transform(ExternalId::email) + .append(Collections.singleton(a.getAccount().getPreferredEmail())) + .filter(Predicates.notNull()) + .transform(String::toLowerCase) + .toSet()); + + public static final FieldDef<AccountState, String> PREFERRED_EMAIL = + prefix("preferredemail") + .build( + a -> { + String preferredEmail = a.getAccount().getPreferredEmail(); + return preferredEmail != null ? preferredEmail.toLowerCase() : null; + }); + + public static final FieldDef<AccountState, String> PREFERRED_EMAIL_EXACT = + exact("preferredemail_exact").build(a -> a.getAccount().getPreferredEmail()); + + public static final FieldDef<AccountState, Timestamp> REGISTERED = + timestamp("registered").build(a -> a.getAccount().getRegisteredOn()); + + public static final FieldDef<AccountState, String> USERNAME = + exact("username").build(a -> a.getUserName().map(String::toLowerCase).orElse("")); + + public static final FieldDef<AccountState, Iterable<String>> WATCHED_PROJECT = + exact("watchedproject") + .buildRepeatable( + a -> + FluentIterable.from(a.getProjectWatches().keySet()) + .transform(k -> k.project().get()) + .toSet()); + + /** + * All values of all refs that were used in the course of indexing this document, except the + * refs/meta/external-ids notes branch which is handled specially (see {@link + * #EXTERNAL_ID_STATE}). + * + * <p>Emitted as UTF-8 encoded strings of the form {@code project:ref/name:[hex sha]}. + */ + public static final FieldDef<AccountState, Iterable<byte[]>> REF_STATE = + storedOnly("ref_state") + .buildRepeatable( + a -> { + if (a.getAccount().getMetaId() == null) { + return ImmutableList.of(); + } + + return ImmutableList.of( + RefState.create( + RefNames.refsUsers(a.getAccount().getId()), + ObjectId.fromString(a.getAccount().getMetaId())) + .toByteArray(a.getAllUsersNameForIndexing())); + }); + + /** + * All note values of all external IDs that were used in the course of indexing this document. + * + * <p>Emitted as UTF-8 encoded strings of the form {@code [hex sha of external ID]:[hex sha of + * note blob]}, or with other words {@code [note ID]:[note data ID]}. + */ + public static final FieldDef<AccountState, Iterable<byte[]>> EXTERNAL_ID_STATE = + storedOnly("external_id_state") + .buildRepeatable( + a -> + a.getExternalIds().stream() + .filter(e -> e.blobId() != null) + .map(ExternalId::toByteArray) + .collect(toSet())); + + private static final Set<String> getNameParts(AccountState a, Iterable<String> emails) { + String fullName = a.getAccount().getFullName(); + Set<String> parts = SchemaUtil.getNameParts(fullName, emails); + + // Additional values not currently added by getPersonParts. + // TODO(dborowitz): Move to getPersonParts and remove this hack. + if (fullName != null) { + parts.add(fullName.toLowerCase(Locale.US)); + } + return parts; + } + + private AccountField() {} +} |