1 files changed, 101 insertions, 0 deletions
diff --git a/lib/public/Profiler/IProfiler.php b/lib/public/Profiler/IProfiler.php
new file mode 100644
index 00000000000..78325089523
--- /dev/null
+++ b/lib/public/Profiler/IProfiler.php
@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2022 Carl Schwan <carl@carlschwan.eu>
+ *
+ * @author Carl Schwan <carl@carlschwan.eu>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Profiler;
+
+use OC\AppFramework\Http\Request;
+use OCP\AppFramework\Http\Response;
+use OCP\DataCollector\IDataCollector;
+
+/**
+ * This interface allows to interact with the built-in Nextcloud profiler.
+ * @since 24.0.0
+ */
+interface IProfiler {
+	/**
+	 * Add a new data collector to the profiler. This allows to later on
+	 * collect all the data from every registered collector.
+	 *
+	 * @see IDataCollector
+	 * @since 24.0.0
+	 */
+	public function add(IDataCollector $dataCollector): void;
+
+	/**
+	 * Load a profile from a response object
+	 * @since 24.0.0
+	 */
+	public function loadProfileFromResponse(Response $response): ?IProfile;
+
+	/**
+	 * Load a profile from the response token
+	 * @since 24.0.0
+	 */
+	public function loadProfile(string $token): ?IProfile;
+
+	/**
+	 * Save a profile on the disk. This allows to later load it again in the
+	 * profiler user interface.
+	 * @since 24.0.0
+	 */
+	public function saveProfile(IProfile $profile): bool;
+
+	/**
+	 * Find a profile from various search parameters
+	 * @since 24.0.0
+	 */
+	public function find(?string $url, ?int $limit, ?string $method, ?int $start, ?int $end, string $statusCode = null): array;
+
+	/**
+	 * Get the list of data providers by identifier
+	 * @return string[]
+	 * @since 24.0.0
+	 */
+	public function dataProviders(): array;
+
+	/**
+	 * Check if the profiler is enabled.
+	 *
+	 * If it is not enabled, data provider shouldn't be created and
+	 * shouldn't collect any data.
+	 * @since 24.0.0
+	 */
+	public function isEnabled(): bool;
+
+	/**
+	 * Set if the profiler is enabled.
+	 * @see isEnabled
+	 * @since 24.0.0
+	 */
+	public function setEnabled(bool $enabled): void;
+
+	/**
+	 * Collect all the information from the current request and construct
+	 * a IProfile from it.
+	 * @since 24.0.0
+	 */
+	public function collect(Request $request, Response $response): IProfile;
+}