Initial commit of admin-console plugin This is the first revision of plugin admin-console. It currently functions in ssh-only mode, and is providing user level information to Gerrit Administrators Change-Id: I3d2d6608024d831035d428aff68b589f94c78901
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0ebe6cf --- /dev/null +++ b/.gitignore
@@ -0,0 +1,5 @@ +/target +/.classpath +/.settings +/.project +*.DS_Store
diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..11069ed --- /dev/null +++ b/LICENSE
@@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +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.
diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..cbf36ae --- /dev/null +++ b/pom.xml
@@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +Copyright (C) 2012 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. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <groupId>com.google.gerrit.plugins</groupId> + <artifactId>admin-console</artifactId> + <packaging>jar</packaging> + <version>0.1</version> + <properties> + <Gerrit-ApiType>plugin</Gerrit-ApiType> + <Gerrit-ApiVersion>2.7-SNAPSHOT</Gerrit-ApiVersion> + <jettyVersion>8.1.7.v20120910</jettyVersion> + </properties> + + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jar-plugin</artifactId> + <version>2.4</version> + <configuration> + <archive> + <manifestEntries> + <Gerrit-SshModule>com.google.gerrit.plugins.AdminConsoleCommandModule</Gerrit-SshModule> + + <Implementation-Vendor>Gerrit Code Review</Implementation-Vendor> + <Implementation-URL>http://code.google.com/p/gerrit/</Implementation-URL> + + <Implementation-Title>Plugin ${project.artifactId}</Implementation-Title> + <Implementation-Version>${project.version}</Implementation-Version> + + <Gerrit-ApiType>${Gerrit-ApiType}</Gerrit-ApiType> + <Gerrit-ApiVersion>${Gerrit-ApiVersion}</Gerrit-ApiVersion> + </manifestEntries> + </archive> + </configuration> + </plugin> + + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <version>2.3.2</version> + <configuration> + <source>1.6</source> + <target>1.6</target> + <encoding>UTF-8</encoding> + </configuration> + </plugin> + </plugins> + + </build> + + <dependencies> + <dependency> + <groupId>com.google.gerrit</groupId> + <artifactId>gerrit-${Gerrit-ApiType}-api</artifactId> + <version>${Gerrit-ApiVersion}</version> + <scope>provided</scope> + </dependency> + </dependencies> + + <repositories> + <repository> + <id>gerrit-api-repository</id> + <url>https://gerrit-api.commondatastorage.googleapis.com/snapshot/</url> + </repository> + </repositories> +</project>
diff --git a/src/main/java/com/google/gerrit/plugins/AdminConsoleCommandModule.java b/src/main/java/com/google/gerrit/plugins/AdminConsoleCommandModule.java new file mode 100644 index 0000000..be523e4 --- /dev/null +++ b/src/main/java/com/google/gerrit/plugins/AdminConsoleCommandModule.java
@@ -0,0 +1,25 @@ +// Copyright (C) 2012 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.plugins; + +import com.google.gerrit.sshd.PluginCommandModule; + +public class AdminConsoleCommandModule extends PluginCommandModule { + @Override + protected void configureCommands() { + command(ShowAccountCommand.class); + alias("show-account", ShowAccountCommand.class); + } +}
diff --git a/src/main/java/com/google/gerrit/plugins/ShowAccountCommand.java b/src/main/java/com/google/gerrit/plugins/ShowAccountCommand.java new file mode 100644 index 0000000..2d35ab5 --- /dev/null +++ b/src/main/java/com/google/gerrit/plugins/ShowAccountCommand.java
@@ -0,0 +1,161 @@ +// Copyright (C) 2012 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.plugins; +import java.io.IOException; +import java.util.Collections; +import java.util.Comparator; +import java.util.List; +import java.util.Set; + +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.kohsuke.args4j.Argument; +import org.kohsuke.args4j.Option; + +import com.google.gerrit.reviewdb.client.Account; +import com.google.gerrit.reviewdb.client.Account.Id; +import com.google.gerrit.reviewdb.client.AccountExternalId; +import com.google.gerrit.reviewdb.client.AccountSshKey; +import com.google.gerrit.reviewdb.server.ReviewDb; +import com.google.gerrit.server.CurrentUser; +import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.account.AccountResolver; +import com.google.gerrit.server.account.AccountResource; +import com.google.gerrit.server.account.GetGroups; +import com.google.gerrit.server.group.GroupJson.GroupInfo; +import com.google.gerrit.sshd.CommandMetaData; +import com.google.gerrit.sshd.SshCommand; +import com.google.gwtorm.server.ResultSet; +import com.google.gwtorm.server.SchemaFactory; +import com.google.inject.Inject; +import com.google.inject.Provider; + +@CommandMetaData(name="show-account", descr="Displays user information") +public final class ShowAccountCommand extends SshCommand { + + @Argument(usage = "User information to find: LastName,\\ Firstname, email@address.com, account id or an user name. Be sure to double-escape spaces, for example: \"show-account Last,\\\\ First\"") + private String name = ""; + + @Option(name = "--show-groups", usage = "show group membership by user?") + private boolean showGroups = false; + + @Option(name = "--filter-groups", usage = "filter group string") + private String filterGroups = null; + + @Option(name = "--show-keys", usage = "show user's public keys?") + private boolean showKeys = false; + + final CurrentUser currentUser; + final AccountResolver accountResolver; + private final SchemaFactory<ReviewDb> schema; + private final Provider<GetGroups> accountGetGroups; + private final IdentifiedUser.GenericFactory userFactory; + + @Inject + ShowAccountCommand(final CurrentUser cu, AccountResolver ar, final Provider<GetGroups> accountGetGroups, final IdentifiedUser.GenericFactory userFactory, SchemaFactory<ReviewDb> schema) + throws ConfigInvalidException, IOException { + currentUser = cu; + accountResolver = ar; + this.accountGetGroups = accountGetGroups; + this.userFactory = userFactory; + this.schema = schema; + } + + @Override + public void run() throws UnloggedFailure, Failure, Exception { + Account account; + if (!currentUser.getCapabilities().canAdministrateServer()) { + stdout.println("You must be a Gerrit Administrator to run this command. Goodbye"); + return; + } + + if (name.isEmpty()) { + stdout.print("You need to tell me who to find: LastName,\\ Firstname, email@address.com, account id or an user name. Be sure to double-escape spaces, for example: \"show-account Last,\\\\ First\""); + return; + } + + Set<Id> idList = accountResolver.findAll(name); + if (idList.isEmpty()) { + stdout.println("No accounts found for your query: \"" + name + "\""); + stdout.println("Tip: Try double-escaping spaces, for example: \"show-account Last,\\\\ First\""); + return; + } + else { + stdout.println("Found " + idList.size() + " result" + (idList.size() > 1 ? "s" : "") + ": for query: \"" + name + "\""); + stdout.println(); + } + + for (Id id: idList) { + account = accountResolver.find(id.toString()); + stdout.println("Full name: " + account.getFullName()); + stdout.println("Account Id: " + id.toString()); + stdout.println("Preferred Email: " + account.getPreferredEmail()); + stdout.println("User Name: " + account.getUserName()); + stdout.println("Active: " + account.isActive()); + stdout.println("Registered on: " + account.getRegisteredOn()); + + final ReviewDb db = schema.open(); + + stdout.println(""); + stdout.println("External Ids:"); + stdout.println(String.format("%-50s %s", "Email Address:", "External Id:")); + for (AccountExternalId accountExternalId : db.accountExternalIds().byAccount(account.getId())) { + stdout.println(String.format("%-50s %s", + (accountExternalId.getEmailAddress() == null ? "" : accountExternalId.getEmailAddress()), + accountExternalId.getExternalId())); + } + + if (showKeys) { + stdout.println(""); + stdout.println("Public Keys:"); + List<AccountSshKey> sshKeys = db.accountSshKeys().byAccount(account.getId()).toList(); + if (sshKeys == null || sshKeys.isEmpty()){ + stdout.println("None"); + } + else{ + stdout.println(String.format("%-9s %s", "Status:", "Key:")); + for (AccountSshKey sshKey : sshKeys ) { + stdout.println(String.format("%-9s %s", + (sshKey.isValid() ? "Active" : "Inactive"), + sshKey.getSshPublicKey())); + } + } + } + + db.close(); + + if (showGroups) { + stdout.println(); + stdout.println("Member of groups" + (filterGroups == null ? "" : " (Filtering on \"" + filterGroups + "\")") + ":"); + List<GroupInfo> groupInfos = accountGetGroups.get().apply( + new AccountResource(userFactory.create(id))); + + Collections.sort(groupInfos, new CustomComparator()); + for (GroupInfo groupInfo: groupInfos) { + if (null == filterGroups) { + stdout.println(groupInfo.name); + } + } + } + stdout.println(""); + } + } + + private static class CustomComparator implements Comparator<GroupInfo> { + @Override + public int compare(GroupInfo o1, GroupInfo o2) { + return o1.name.compareTo(o2.name); + } + } +} \ No newline at end of file
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md new file mode 100644 index 0000000..16200d6 --- /dev/null +++ b/src/main/resources/Documentation/about.md
@@ -0,0 +1,2 @@ +Plugin to provide administrator-only functionality, intended to simplify common administrator tasks. +Currently providing user-level information.
diff --git a/src/main/resources/Documentation/cmd-show-account.md b/src/main/resources/Documentation/cmd-show-account.md new file mode 100644 index 0000000..096b407 --- /dev/null +++ b/src/main/resources/Documentation/cmd-show-account.md
@@ -0,0 +1,72 @@ +admin-console show-account +================ + +NAME +---- +admin-console show-account show user account information + +SYNOPSIS +-------- +> ssh -p <port> <host> admin-console show-account +> [user] +> [--show-groups] +> [--filter-groups] [filter-string] +> [--show-keys] + +DESCRIPTION +----------- +Displays useful information about a specific user. For search strings that match >1 user, will return multiple result sets. + +OPTIONS +------- + +user +> User to look up: This can be in one of several formats: LastName,\\\\ FirstName, email\@address.com, account id or an user name. Be sure to double-escape spaces. Case-sensitive + +--show-groups +> Show all groups user is a member of? + +--filter-groups +> Filter group list? + +--filter-string +> String to perform group filtering on. Does not currently support regex. Case-insensitive. + +--show-keys +> Show users ssh public keys? + +--help + +-h +> Display usage information. + +ACCESS +------ +Gerrit Administrators only. + +SCRIPTING +--------- +This command is not intended to be used in scripts. + +EXAMPLES +-------- + +Find a user named Foo + +> $ ssh -p 29418 review.example.com admin-console show-user Foo + +Find a user with email foo@bar.com + +> $ ssh -p 29418 review.example.com admin-console show-user foo@bar.com + +Find a user named Foo Bar + +> $ ssh -p 29418 review.example.com admin-console show-user Bar,\\\\ Foo + +Find a user named Foo and show all groups the user is a member of + +> $ ssh -p 29418 review.example.com admin-console show-user Foo --show-groups + +Find a user named Foo and show all groups containing "baz" that the user is a member of + +> $ ssh -p 29418 review.example.com admin-console show-user Foo --show-groups --filter-groups baz