[pihole] Integration of API v6

bundles/org.openhab.binding.pihole/README.md

@@ -22,9 +22,10 @@ The Pi-hole Binding allows you to monitor Pi-hole statistics and control its fun
 
 | Name            | Type    | Description                                                                               | Default | Required | Advanced |
 |-----------------|---------|-------------------------------------------------------------------------------------------|---------|----------|----------|
-| hostname        | text    | Hostname or IP address of the device                                                      | N/A     | yes      | no       |
+| hostname        | text    | Url (hostname or IP address) of the pihole web server                                     | N/A     | yes      | no       |
 | token           | text    | Token to access the device. To generate token go to `settings` > `API` > `Show API token` | N/A     | yes      | no       |
-| refreshInterval | integer | Interval the device is polled in sec.                                                     | 600     | no       | yes      |
+| refreshInterval | integer | Interval the device is polled in sec                                                      | 600     | no       | yes      |
+| serverVersion   | text    | Defines the API to be used with this server                                               | v5      | no       | yes      |
 
 ## Channels
 

bundles/org.openhab.binding.pihole/src/main/java/org/openhab/binding/pihole/internal/PiHoleActions.java

@@ -53,15 +53,11 @@ public void disableBlocking(
             return;
         }
 
-        if (timeUnit == null) {
-            timeUnit = SECONDS;
-        }
-
         var local = handler;
         if (local == null) {
             return;
         }
-        local.disableBlocking(timeUnit.toSeconds(time));
+        local.disableBlocking((timeUnit == null ? SECONDS : timeUnit).toSeconds(time));
     }
 
     public static void disableBlocking(@Nullable ThingActions actions, long time, @Nullable TimeUnit timeUnit)

bundles/org.openhab.binding.pihole/src/main/java/org/openhab/binding/pihole/internal/PiHoleConfiguration.java

@@ -21,7 +21,11 @@
  */
 @NonNullByDefault
 public class PiHoleConfiguration {
+    public static final String API_V6 = "v6";
+    public static final String API_V5 = "v5";
+
     public String hostname = "";
     public String token = "";
     public int refreshIntervalSeconds = 600;
+    public String serverVersion = API_V5;
 }

bundles/org.openhab.binding.pihole/src/main/java/org/openhab/binding/pihole/internal/PiHoleHandler.java

@@ -33,8 +33,10 @@
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.jetty.client.HttpClient;
+import org.openhab.binding.pihole.internal.PiHoleBindingConstants.Channels.DisableEnable;
 import org.openhab.binding.pihole.internal.rest.AdminService;
 import org.openhab.binding.pihole.internal.rest.JettyAdminService;
+import org.openhab.binding.pihole.internal.rest.JettyAdminServiceV6;
 import org.openhab.binding.pihole.internal.rest.model.DnsStatistics;
 import org.openhab.core.i18n.TimeZoneProvider;
 import org.openhab.core.library.types.DateTimeType;
@@ -51,28 +53,32 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.google.gson.Gson;
+
 /**
  * The {@link PiHoleHandler} is responsible for handling commands, which are
  * sent to one of the channels.
  *
  * @author Martin Grzeslowski - Initial contribution
  */
 @NonNullByDefault
-public class PiHoleHandler extends BaseThingHandler implements AdminService {
+public class PiHoleHandler extends BaseThingHandler {
     private static final int HTTP_DELAY_SECONDS = 1;
     private final Logger logger = LoggerFactory.getLogger(PiHoleHandler.class);
     private final Object lock = new Object();
     private final TimeZoneProvider timeZoneProvider;
     private final HttpClient httpClient;
+    private final Gson gson;
 
     private @Nullable AdminService adminService;
     private @Nullable DnsStatistics dnsStatistics;
     private @Nullable ScheduledFuture<?> scheduledFuture;
 
-    public PiHoleHandler(Thing thing, TimeZoneProvider timeZoneProvider, HttpClient httpClient) {
+    public PiHoleHandler(Thing thing, TimeZoneProvider timeZoneProvider, HttpClient httpClient, Gson gson) {
         super(thing);
         this.timeZoneProvider = timeZoneProvider;
         this.httpClient = httpClient;
+        this.gson = gson;
     }
 
     @Override
@@ -101,7 +107,11 @@ public void initialize() {
             updateStatus(OFFLINE, CONFIGURATION_ERROR, "@text/handler.init.noToken");
             return;
         }
-        adminService = new JettyAdminService(config.token, hostname, httpClient);
+
+        adminService = PiHoleConfiguration.API_V6.equals(config.serverVersion)
+                ? new JettyAdminServiceV6(config.token, hostname, httpClient, gson)
+                : new JettyAdminService(config.token, hostname, httpClient, gson);
+
         scheduledFuture = scheduler.scheduleWithFixedDelay(this::update, 0, config.refreshIntervalSeconds, SECONDS);
 
         // do not set status here, the background task will do it.
@@ -234,7 +244,6 @@ public void dispose() {
         super.dispose();
     }
 
-    @Override
     public Optional<DnsStatistics> summary() throws PiHoleException {
         var local = adminService;
         if (local == null) {
@@ -243,7 +252,6 @@ public Optional<DnsStatistics> summary() throws PiHoleException {
         return local.summary();
     }
 
-    @Override
     public void disableBlocking(long seconds) throws PiHoleException {
         var local = adminService;
         if (local == null) {
@@ -259,7 +267,6 @@ public void disableBlocking(long seconds) throws PiHoleException {
         }
     }
 
-    @Override
     public void enableBlocking() throws PiHoleException {
         var local = adminService;
         if (local == null) {

bundles/org.openhab.binding.pihole/src/main/java/org/openhab/binding/pihole/internal/PiHoleHandlerFactory.java

@@ -29,6 +29,10 @@
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
 
+import com.google.gson.FieldNamingPolicy;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
 /**
  * The {@link PiHoleHandlerFactory} is responsible for creating things and thing
  * handlers.
@@ -38,8 +42,10 @@
 @NonNullByDefault
 @Component(configurationPid = "binding.pihole", service = ThingHandlerFactory.class)
 public class PiHoleHandlerFactory extends BaseThingHandlerFactory {
-
     private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(PI_HOLE_TYPE);
+    private static final Gson GSON = new GsonBuilder()
+            .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES).create();
+
     private final TimeZoneProvider timeZoneProvider;
     private final HttpClientFactory httpClientFactory;
 
@@ -60,7 +66,7 @@ public boolean supportsThingType(ThingTypeUID thingTypeUID) {
         ThingTypeUID thingTypeUID = thing.getThingTypeUID();
 
         if (PI_HOLE_TYPE.equals(thingTypeUID)) {
-            return new PiHoleHandler(thing, timeZoneProvider, httpClientFactory.getCommonHttpClient());
+            return new PiHoleHandler(thing, timeZoneProvider, httpClientFactory.getCommonHttpClient(), GSON);
         }
 
         return null;

bundles/org.openhab.binding.pihole/src/main/java/org/openhab/binding/pihole/internal/rest/AdminService.java

@@ -13,36 +13,67 @@
 package org.openhab.binding.pihole.internal.rest;
 
 import java.util.Optional;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeoutException;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jetty.client.HttpClient;
+import org.eclipse.jetty.client.api.ContentResponse;
+import org.eclipse.jetty.client.api.Request;
 import org.openhab.binding.pihole.internal.PiHoleException;
 import org.openhab.binding.pihole.internal.rest.model.DnsStatistics;
 
+import com.google.gson.Gson;
+
 /**
- * @author Martin Grzeslowski - Initial contribution
+ * @author Gaël L'hopital - Initial contribution
  */
 @NonNullByDefault
-public interface AdminService {
+public abstract class AdminService {
+    protected static final long TIMEOUT_SECONDS = 10L;
+
+    protected final String token;
+
+    protected final HttpClient client;
+    protected final Gson gson;
+
+    public AdminService(String token, HttpClient client, Gson gson) {
+        super();
+        this.token = token;
+        this.client = client;
+        this.gson = gson;
+    }
+
     /**
      * Retrieves a summary of DNS statistics.
      *
      * @return An optional containing the DNS statistics.
      * @throws PiHoleException In case of error
      */
-    Optional<DnsStatistics> summary() throws PiHoleException;
+    public abstract Optional<DnsStatistics> summary() throws PiHoleException;
 
     /**
      * Disables blocking for a specified duration.
      *
      * @param seconds The duration in seconds for which blocking should be disabled.
      * @throws PiHoleException In case of error
      */
-    void disableBlocking(long seconds) throws PiHoleException;
+    public abstract void disableBlocking(long seconds) throws PiHoleException;
 
     /**
      * Enables blocking.
      *
      * @throws PiHoleException In case of error
      */
-    void enableBlocking() throws PiHoleException;
-}
+    public abstract void enableBlocking() throws PiHoleException;
+
+    protected static ContentResponse send(Request request) throws PiHoleException {
+        try {
+            return request.send();
+        } catch (InterruptedException | TimeoutException | ExecutionException e) {
+            throw new PiHoleException(
+                    "Exception while sending request to Pi-hole. %s".formatted(e.getLocalizedMessage()), e);
+        }
+    }
+
+}

bundles/org.openhab.binding.pihole/src/main/java/org/openhab/binding/pihole/internal/rest/JettyAdminService.java

@@ -16,39 +16,28 @@
 
 import java.net.URI;
 import java.util.Optional;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.TimeoutException;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jetty.client.HttpClient;
-import org.eclipse.jetty.client.api.ContentResponse;
-import org.eclipse.jetty.client.api.Request;
 import org.openhab.binding.pihole.internal.PiHoleException;
 import org.openhab.binding.pihole.internal.rest.model.DnsStatistics;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.gson.FieldNamingPolicy;
 import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 
 /**
  * @author Martin Grzeslowski - Initial contribution
  */
 @NonNullByDefault
-public class JettyAdminService implements AdminService {
-    private static final Gson GSON = new GsonBuilder()
-            .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES).create();
-    private static final long TIMEOUT_SECONDS = 10L;
+public class JettyAdminService extends AdminService {
     private final Logger logger = LoggerFactory.getLogger(JettyAdminService.class);
-    private final String token;
+
     private final URI baseUrl;
-    private final HttpClient client;
 
-    public JettyAdminService(String token, URI baseUrl, HttpClient client) {
-        this.token = token;
+    public JettyAdminService(String token, URI baseUrl, HttpClient client, Gson gson) {
+        super(token, client, gson);
         this.baseUrl = baseUrl;
-        this.client = client;
     }
 
     @Override
@@ -58,16 +47,7 @@ public Optional<DnsStatistics> summary() throws PiHoleException {
         var request = client.newRequest(url).timeout(TIMEOUT_SECONDS, SECONDS);
         var response = send(request);
         var content = response.getContentAsString();
-        return Optional.ofNullable(GSON.fromJson(content, DnsStatistics.class));
-    }
-
-    private static ContentResponse send(Request request) throws PiHoleException {
-        try {
-            return request.send();
-        } catch (InterruptedException | TimeoutException | ExecutionException e) {
-            throw new PiHoleException(
-                    "Exception while sending request to Pi-hole. %s".formatted(e.getLocalizedMessage()), e);
-        }
+        return Optional.ofNullable(gson.fromJson(content, DnsStatistics.class));
     }
 
     @Override

bundles/org.openhab.binding.pihole/src/main/java/org/openhab/binding/pihole/internal/rest/JettyAdminServiceV6.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2010-2025 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.pihole.internal.rest;
+
+import static java.util.concurrent.TimeUnit.SECONDS;
+
+import java.net.URI;
+import java.util.Optional;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.eclipse.jetty.client.HttpClient;
+import org.eclipse.jetty.client.util.StringContentProvider;
+import org.eclipse.jetty.http.HttpHeader;
+import org.eclipse.jetty.http.HttpMethod;
+import org.openhab.binding.pihole.internal.PiHoleException;
+import org.openhab.binding.pihole.internal.rest.model.DnsStatistics;
+import org.openhab.binding.pihole.internal.rest.model.v6.Password;
+import org.openhab.binding.pihole.internal.rest.model.v6.SessionAnswer;
+import org.openhab.binding.pihole.internal.rest.model.v6.SessionAnswer.Session;
+import org.openhab.binding.pihole.internal.rest.model.v6.StatAnswer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.google.gson.Gson;
+
+/**
+ * @author Martin Grzeslowski - Initial contribution
+ */
+@NonNullByDefault
+public class JettyAdminServiceV6 extends AdminService {
+    private final Logger logger = LoggerFactory.getLogger(JettyAdminServiceV6.class);
+    protected final URI apiUrl;
+    private @Nullable Session session;
+
+    public JettyAdminServiceV6(String token, URI baseUrl, HttpClient client, Gson gson) {
+        super(token, client, gson);
+        apiUrl = baseUrl.resolve("/api");
+    }
+
+    private void getAuth() throws PiHoleException {
+        logger.debug("Check if authentication is required");
+        var authUrl = apiUrl.resolve(apiUrl.getPath() + "/auth");
+        var request = client.newRequest(authUrl).timeout(TIMEOUT_SECONDS, SECONDS).method(HttpMethod.POST)
+                .header(HttpHeader.ACCEPT, "application/json")
+                .content(new StringContentProvider(gson.toJson(new Password(token))));
+        var response = send(request);
+        var content = response.getContentAsString();
+        SessionAnswer answer = gson.fromJson(content, SessionAnswer.class);
+        logger.debug(answer.session().message());
+        session = answer.session();
+    }
+
+    @Override
+    public Optional<DnsStatistics> summary() throws PiHoleException {
+        logger.debug("Getting summary");
+        getAuth();
+        var url = apiUrl.resolve(apiUrl.getPath() + "/stats/summary");
+        var request = client.newRequest(url).timeout(TIMEOUT_SECONDS, SECONDS).method(HttpMethod.GET)
+                .header(HttpHeader.ACCEPT, "application/json").header("sid", session.sid());
+        var response = send(request);
+        var content = response.getContentAsString();
+        StatAnswer answer = gson.fromJson(content, StatAnswer.class);
+        DnsStatistics translated = new DnsStatistics(answer.gravity().domainsBeingBlocked(), null, null, null,
+                answer.queries().uniqueDomains(), answer.queries().forwarded(), answer.queries().cached(), null, null,
+                null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null,
+                null, null);
+        return Optional.of(translated);
+    }
+
+    @Override
+    public void disableBlocking(long seconds) throws PiHoleException {
+        logger.debug("Disabling blocking for {} seconds", seconds);
+        // var url = baseUrl.resolve("/admin/api.php?disable=%s&auth=%s".formatted(seconds, token));
+        // var request = client.newRequest(url).timeout(TIMEOUT_SECONDS, SECONDS);
+        // send(request);
+    }
+
+    @Override
+    public void enableBlocking() throws PiHoleException {
+        logger.debug("Enabling blocking");
+        // var url = baseUrl.resolve("/admin/api.php?enable&auth=%s".formatted(token));
+        // var request = client.newRequest(url).timeout(TIMEOUT_SECONDS, SECONDS);
+        // send(request);
+    }
+}