ocm services

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>

3 files changed, 215 insertions, 0 deletions

diff --git a/core/Controller/OCMController.php b/core/Controller/OCMController.php
new file mode 100644
index 00000000000..de24cc75191
--- /dev/null
+++ b/core/Controller/OCMController.php
@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @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 OC\Core\Controller;
+
+use Exception;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\Capabilities\ICapability;
+use OCP\IConfig;
+use OCP\IRequest;
+use OCP\Server;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Controller about the endpoint /ocm-provider/
+ *
+ * @since 28.0.0
+ */
+class OCMController extends Controller {
+	public function __construct(
+		IRequest $request,
+		private IConfig $config,
+		private LoggerInterface $logger
+	) {
+		parent::__construct('core', $request);
+	}
+
+	/**
+	 * generate a OCMProvider with local data and send it as DataResponse.
+	 * This replaces the old PHP file ocm-provider/index.php
+	 *
+	 * @PublicPage
+	 * @NoCSRFRequired
+	 *
+	 * @return DataResponse
+	 *
+	 * 200: OCM Provider details returned
+	 * 500: OCM not supported
+	 */
+	public function discovery(): DataResponse {
+		try {
+			$cap = Server::get(
+				$this->config->getAppValue(
+					'core',
+					'ocm_providers',
+					'\OCA\CloudFederationAPI\Capabilities'
+				)
+			);
+
+			if (!($cap instanceof ICapability)) {
+				throw new Exception('loaded class does not implements OCP\Capabilities\ICapability');
+			}
+
+			return new DataResponse(
+				$cap->getCapabilities()['ocm'] ?? ['enabled' => false],
+				Http::STATUS_OK,
+				[
+					'X-NEXTCLOUD-OCM-PROVIDERS' => true,
+					'Content-Type' => 'application/json'
+				]
+			);
+		} catch (ContainerExceptionInterface|Exception $e) {
+			$this->logger->error('issue during OCM discovery request', ['exception' => $e]);
+
+			return new DataResponse(
+				['message' => '/ocm-provider/ not supported'],
+				Http::STATUS_INTERNAL_SERVER_ERROR
+			);
+		}
+	}
+}
diff --git a/core/openapi.json b/core/openapi.json
index 06e0047a190..fdc4bd3e6b8 100644
--- a/core/openapi.json
+++ b/core/openapi.json
@@ -1275,6 +1275,116 @@
                 }
             }
         },
+        "/index.php/ocm-provider": {
+            "get": {
+                "operationId": "ocm-discovery",
+                "summary": "generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php",
+                "tags": [
+                    "ocm"
+                ],
+                "security": [
+                    {},
+                    {
+                        "bearer_auth": []
+                    },
+                    {
+                        "basic_auth": []
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OCM Provider details returned",
+                        "headers": {
+                            "X-NEXTCLOUD-OCM-PROVIDERS": {
+                                "schema": {
+                                    "type": "boolean"
+                                }
+                            }
+                        },
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "enabled",
+                                        "apiVersion",
+                                        "endPoint",
+                                        "resourceTypes"
+                                    ],
+                                    "properties": {
+                                        "enabled": {
+                                            "type": "boolean"
+                                        },
+                                        "apiVersion": {
+                                            "type": "string"
+                                        },
+                                        "endPoint": {
+                                            "type": "string"
+                                        },
+                                        "resourceTypes": {
+                                            "type": "object",
+                                            "required": [
+                                                null
+                                            ],
+                                            "properties": {
+                                                "": {
+                                                    "type": "object",
+                                                    "required": [
+                                                        "name",
+                                                        "shareTypes",
+                                                        "protocols"
+                                                    ],
+                                                    "properties": {
+                                                        "name": {
+                                                            "type": "string"
+                                                        },
+                                                        "shareTypes": {
+                                                            "type": "array",
+                                                            "items": {
+                                                                "type": "string"
+                                                            }
+                                                        },
+                                                        "protocols": {
+                                                            "type": "object",
+                                                            "required": [
+                                                                "webdav"
+                                                            ],
+                                                            "properties": {
+                                                                "webdav": {
+                                                                    "type": "string"
+                                                                }
+                                                            }
+                                                        }
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "500": {
+                        "description": "OCM not supported",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "message"
+                                    ],
+                                    "properties": {
+                                        "message": {
+                                            "type": "string"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/ocs/v2.php/cloud/capabilities": {
             "get": {
                 "operationId": "ocs-get-capabilities",
@@ -4329,6 +4439,10 @@
         {
             "name": "guest_avatar",
             "description": "This controller handles guest avatar requests."
+        },
+        {
+            "name": "ocm",
+            "description": "Controller about the endpoint /ocm-provider/"
         }
     ]
 }
\ No newline at end of file
diff --git a/core/routes.php b/core/routes.php
index ad8638e0b1e..fcb5a15cf01 100644
--- a/core/routes.php
+++ b/core/routes.php
@@ -13,6 +13,7 @@ declare(strict_types=1);
  * @author John Molakvoæ <skjnldsv@protonmail.com>
  * @author Julius Härtl <jus@bitgrid.net>
  * @author Lukas Reschke <lukas@statuscode.ch>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  * @author Michael Weimann <mail@michael-weimann.eu>
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  * @author Thomas Müller <thomas.mueller@tmit.eu>
@@ -103,6 +104,9 @@ $application->registerRoutes($this, [
 		// Well known requests https://tools.ietf.org/html/rfc5785
 		['name' => 'WellKnown#handle', 'url' => '.well-known/{service}'],
 
+		// OCM Provider requests https://github.com/cs3org/OCM-API
+		['name' => 'OCM#discovery', 'url' => '/ocm-provider/'],
+
 		// Unsupported browser
 		['name' => 'UnsupportedBrowser#index', 'url' => 'unsupported'],
 	],