, cancel(): void}} a handle on the cancelable
+ * promise
+ */
+export const makeCancelable = (
+ promise,
+ { repeat = null, interval = 0 } = {}
+) => {
+ let hasCanceled = false;
+ let repeatId = null;
+
+ const handle = (resolve, reject, val, isError) => {
+ if (hasCanceled) reject({ isCanceled: true });
+ else {
+ if (isError) reject(val);
+ else resolve(val);
+
+ if (repeat) repeatId = setTimeout(repeat, interval);
+ }
+ };
+
+ const wrappedPromise = new Promise((resolve, reject) => {
+ promise.then(
+ val => handle(resolve, reject, val, false),
+ error => handle(resolve, reject, error, true)
+ );
+ });
+
+ return {
+ promise: wrappedPromise,
+ cancel() {
+ clearTimeout(repeatId);
+ hasCanceled = true;
+ }
+ };
+};
+
+/**
+ * Ignore canceled promises (pass into a promise's catch function)
+ *
+ * @param err the error from catching the promise
+ */
+export const ignoreCancel = err => {
+ if (!err.isCanceled) throw err;
+};
+
+/**
+ * A result type, similar to Rust's Result.
+ * A result can either be Ok or Err
+ */
+export const Result = {
+ /**
+ * Create a new Ok Result
+ *
+ * @param value the value of the result
+ */
+ Ok: value => ({ type: "Ok", value }),
+
+ /**
+ * Create a new Err Result
+ *
+ * @param value the value of the result (error)
+ */
+ Err: value => ({ type: "Err", value }),
+
+ /**
+ * Check if the result is Ok
+ * @param result the result
+ * @returns {boolean} if it is an Ok result
+ */
+ isOk: result => result.type === "Ok",
+
+ /**
+ * Check if the result is Err
+ * @param result the result
+ * @returns {boolean} if it is an Err result
+ */
+ isErr: result => result.type === "Err"
+};
diff --git a/src/utils.js b/src/utils.js
deleted file mode 100644
index d53e52c..0000000
--- a/src/utils.js
+++ /dev/null
@@ -1,205 +0,0 @@
-/* Pi-hole: A black hole for Internet advertisements
-* (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-* Network-wide ad blocking via your own hardware.
-*
-* Web Interface
-* Various utilities including the API
-*
-* This file is copyright under the latest version of the EUPL.
-* Please see LICENSE file for your rights under this license. */
-
-import config from "./config";
-
-export const padNumber = num => {
- return ("00" + num).substr(-2, 2);
-};
-
-export const makeCancelable = (
- promise,
- { repeat = null, interval = 0 } = {}
-) => {
- let hasCanceled = false;
- let repeatId = null;
-
- const handle = (resolve, reject, val, isError) => {
- if (hasCanceled) reject({ isCanceled: true });
- else {
- if (isError) reject(val);
- else resolve(val);
-
- if (repeat) repeatId = setTimeout(repeat, interval);
- }
- };
-
- const wrappedPromise = new Promise((resolve, reject) => {
- promise.then(
- val => handle(resolve, reject, val, false),
- error => handle(resolve, reject, error, true)
- );
- });
-
- return {
- promise: wrappedPromise,
- cancel() {
- clearTimeout(repeatId);
- hasCanceled = true;
- }
- };
-};
-
-export const ignoreCancel = err => {
- if (!err.isCanceled) throw err;
-};
-
-export const api = {
- loggedIn: false,
- authenticate(key) {
- return fetch(api.urlFor("auth"), {
- headers: new Headers({ "X-Pi-hole-Authenticate": key }),
- credentials: this.credentialType()
- })
- .then(api.convertJSON)
- .then(api.checkForErrors);
- },
- logout() {
- return api.delete("auth");
- },
- getSummary() {
- return api.get("stats/summary");
- },
- getHistoryGraph() {
- return api.get("stats/overTime/history");
- },
- getClientsGraph() {
- return api.get("stats/overTime/clients");
- },
- getQueryTypes() {
- return api.get("stats/query_types");
- },
- getForwardDestinations() {
- return api.get("stats/forward_destinations");
- },
- getTopDomains() {
- return api.get("stats/top_domains");
- },
- getTopBlocked() {
- return api.get("stats/top_blocked");
- },
- getTopClients() {
- return api.get("stats/top_clients");
- },
- getHistory() {
- return api.get("stats/history");
- },
- getWhitelist() {
- return api.get("dns/whitelist");
- },
- getBlacklist() {
- return api.get("dns/blacklist");
- },
- getRegexlist() {
- return api.get("dns/regexlist");
- },
- addWhitelist(domain) {
- return api.post("dns/whitelist", { domain: domain });
- },
- addBlacklist(domain) {
- return api.post("dns/blacklist", { domain: domain });
- },
- addRegexlist(domain) {
- return api.post("dns/regexlist", { domain: domain });
- },
- removeWhitelist(domain) {
- return api.delete("dns/whitelist/" + domain);
- },
- removeBlacklist(domain) {
- return api.delete("dns/blacklist/" + domain);
- },
- removeRegexlist(domain) {
- return api.delete("dns/regexlist/" + encodeURIComponent(domain));
- },
- getStatus() {
- return api.get("dns/status");
- },
- get(url) {
- return fetch(api.urlFor(url), {
- credentials: this.credentialType()
- })
- .then(api.checkIfLoggedOut)
- .then(api.convertJSON)
- .then(api.checkForErrors);
- },
- post(url, data) {
- return fetch(api.urlFor(url), {
- method: "POST",
- body: JSON.stringify(data),
- headers: new Headers({ "Content-Type": "application/json" }),
- credentials: this.credentialType()
- })
- .then(api.checkIfLoggedOut)
- .then(api.convertJSON)
- .then(api.checkForErrors);
- },
- delete(url) {
- return fetch(api.urlFor(url), {
- method: "DELETE",
- credentials: this.credentialType()
- })
- .then(api.checkIfLoggedOut)
- .then(api.convertJSON)
- .then(api.checkForErrors);
- },
- getNetworkInfo() {
- return api.get("settings/network");
- },
- getVersion() {
- return api.get("version");
- },
- getFTLdb() {
- return api.get("settings/ftldb");
- },
- getDNSInfo() {
- return api.get("settings/dns");
- },
- getDHCPInfo() {
- return api.get("settings/dhcp");
- },
- /**
- * If the user is logged in, check if the user's session has lapsed.
- * If so, log them out and refresh the page.
- */
- checkIfLoggedOut(response) {
- if (api.loggedIn && response.status === 401) {
- // Clear the user's old session and refresh the page
- document.cookie =
- "user_id=; Path=/; Expires=Thu, 01 Jan 1970 00:00:01 GMT;";
- window.location.reload();
- return Promise.reject({ isCanceled: true });
- }
-
- return Promise.resolve(response);
- },
- async convertJSON(data) {
- if (!data.ok) return Promise.reject({ data, json: await data.json() });
- else return data.json();
- },
- checkForErrors(data) {
- if (data.error) {
- return Promise.reject(data.error);
- }
- return Promise.resolve(data);
- },
- urlFor(endpoint) {
- let apiLocation;
-
- if (config.fakeAPI) apiLocation = process.env.PUBLIC_URL + "/fakeAPI";
- else apiLocation = "/admin/api";
-
- return apiLocation + "/" + endpoint;
- },
- credentialType() {
- // Development API requests use a different origin (pi.hole) since it is running off of the developer's machine.
- // Therefore, allow credentials to be used across origins when in development mode.
- return config.developmentMode ? "include" : "same-origin";
- }
-};
diff --git a/src/utils.test.js b/src/utils.test.js
index 4d2355c..bb83461 100644
--- a/src/utils.test.js
+++ b/src/utils.test.js
@@ -8,7 +8,7 @@
* This file is copyright under the latest version of the EUPL.
* Please see LICENSE file for your rights under this license. */
-import { api } from "./utils";
+import api from "./util/api";
// This is a dumb test used to set up the next test,
// which checks that the logged in state is reset before each test
diff --git a/src/views/Blacklist.js b/src/views/Blacklist.js
index ede888d..4c3e1c5 100644
--- a/src/views/Blacklist.js
+++ b/src/views/Blacklist.js
@@ -10,7 +10,7 @@
import React from "react";
import { translate } from "react-i18next";
-import { api } from "../utils";
+import api from "../util/api";
import ListPage from "../components/list/ListPage";
import { isValidDomain } from "../validate";
diff --git a/src/views/Dashboard.js b/src/views/Dashboard.js
index 88f1150..6357915 100644
--- a/src/views/Dashboard.js
+++ b/src/views/Dashboard.js
@@ -17,7 +17,7 @@ import ForwardDestinationsChart from "../components/dashboard/ForwardDestination
import TopDomains from "../components/dashboard/TopDomains";
import TopBlocked from "../components/dashboard/TopBlocked";
import TopClients from "../components/dashboard/TopClients";
-import { api } from "../utils";
+import api from "../util/api";
export default () => (
diff --git a/src/views/Login.js b/src/views/Login.js
index aa055f8..d65174f 100644
--- a/src/views/Login.js
+++ b/src/views/Login.js
@@ -11,7 +11,7 @@
import React, { Component, Fragment } from "react";
import { Redirect } from "react-router-dom";
import sha from "sha.js";
-import { api } from "../utils";
+import api from "../util/api";
import logo from "../img/logo.svg";
import { routes } from "../routes";
import ForgotPassword from "../components/login/ForgotPassword";
diff --git a/src/views/Logout.js b/src/views/Logout.js
index 8760779..c1f6bab 100644
--- a/src/views/Logout.js
+++ b/src/views/Logout.js
@@ -10,7 +10,7 @@
import React, { Component } from "react";
import { Redirect } from "react-router-dom";
-import { api } from "../utils";
+import api from "../util/api";
import config from "../config";
export default class Logout extends Component {
diff --git a/src/views/Regexlist.js b/src/views/Regexlist.js
index e453792..08e39a5 100644
--- a/src/views/Regexlist.js
+++ b/src/views/Regexlist.js
@@ -11,7 +11,7 @@
import React from "react";
import { translate } from "react-i18next";
import ListPage from "../components/list/ListPage";
-import { api } from "../utils";
+import api from "../util/api";
import { isValidRegex } from "../validate";
const Regexlist = props => {
diff --git a/src/views/Whitelist.js b/src/views/Whitelist.js
index 5f641c0..73e7aad 100644
--- a/src/views/Whitelist.js
+++ b/src/views/Whitelist.js
@@ -11,7 +11,7 @@
import React from "react";
import { translate } from "react-i18next";
import ListPage from "../components/list/ListPage";
-import { api } from "../utils";
+import api from "../util/api";
import { isValidDomain } from "../validate";
const Whitelist = props => {