created small user-agent detection framework to choose the right encoding for basic authentication

2025-10-31 02:25:53 +01:00 · 2014-10-17 15:43:28 +02:00
parent 8e3e42ebf5
commit 8e608d2439
18 changed files with 1527 additions and 29 deletions
--- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitUserAgentProvider.java
+++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/web/GitUserAgentProvider.java
@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer. 2. Redistributions in
+ * binary form must reproduce the above copyright notice, this list of
+ * conditions and the following disclaimer in the documentation and/or other
+ * materials provided with the distribution. 3. Neither the name of SCM-Manager;
+ * nor the names of its contributors may be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.web;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Charsets;
+
+import sonia.scm.plugin.ext.Extension;
+
+/**
+ *
+ * @author Sebastian Sdorra <sebastian.sdorra@triology.de>
+ */
+@Extension
+public class GitUserAgentProvider implements UserAgentProvider
+{
+
+  /** Field description */
+  @VisibleForTesting
+  static final UserAgent GIT = UserAgent.builder("Git").browser(
+                                 false).basicAuthenticationCharset(
+                                 Charsets.UTF_8).build();
+
+  /** Field description */
+  @VisibleForTesting
+  static final UserAgent MSYSGIT = UserAgent.builder("msysGit").browser(
+                                     false).basicAuthenticationCharset(
+                                     Charsets.UTF_8).build();
+
+  /** Field description */
+  private static final String PREFIX = "git/";
+
+  /** Field description */
+  private static final String SUFFIX = "msysgit";
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param userAgentString
+   *
+   * @return
+   */
+  @Override
+  public UserAgent parseUserAgent(String userAgentString)
+  {
+    UserAgent ua = null;
+
+    if (userAgentString.startsWith(PREFIX))
+    {
+      if (userAgentString.contains(SUFFIX))
+      {
+        ua = MSYSGIT;
+      }
+      else
+      {
+        ua = GIT;
+      }
+    }
+
+    return ua;
+  }
+}