From 3812a77bb00ee70369906f6ea24d1aef21bb1644 Mon Sep 17 00:00:00 2001
From: Ramesh Mane <101566080+rameshmane7218@users.noreply.github.com>
Date: Tue, 26 Nov 2024 05:46:53 +0000
Subject: [PATCH] fix: add get custom url path and check availability api

---
 .../dlg/share-and-collaborate/SharePage.vue   |  38 +++++--
 .../src/controllers/custom-urls.controller.ts |  44 ++++++++
 packages/nocodb/src/models/CustomUrl.ts       |  32 +++++-
 packages/nocodb/src/models/View.ts            |  34 ++++++
 packages/nocodb/src/schema/swagger-v2.json    | 106 +++++++++++++++++-
 packages/nocodb/src/schema/swagger.json       |  14 ++-
 .../src/services/custom-urls.service.ts       |  20 ++++
 packages/nocodb/src/services/views.service.ts |   6 +-
 8 files changed, 277 insertions(+), 17 deletions(-)
 create mode 100644 packages/nocodb/src/controllers/custom-urls.controller.ts
 create mode 100644 packages/nocodb/src/services/custom-urls.service.ts

diff --git a/packages/nc-gui/components/dlg/share-and-collaborate/SharePage.vue b/packages/nc-gui/components/dlg/share-and-collaborate/SharePage.vue
index c3f7ab9201..51198ff83b 100644
--- a/packages/nc-gui/components/dlg/share-and-collaborate/SharePage.vue
+++ b/packages/nc-gui/components/dlg/share-and-collaborate/SharePage.vue
@@ -108,11 +108,11 @@ const isOpenCustomUrl = computed(() => {
 })
 
 const customUrl = computed({
-  get: () => (isOpenCustomUrl.value ? activeView.value?.custom_path ?? '' : ''),
+  get: () => (isOpenCustomUrl.value ? activeView.value?.custom_url_path ?? '' : ''),
   set: async (value) => {
     if (!activeView.value) return
 
-    activeView.value = { ...(activeView.value as any), custom_path: isOpenCustomUrl.value ? value : null }
+    activeView.value = { ...(activeView.value as any), custom_url_path: isOpenCustomUrl.value ? value : null }
   },
 })
 
@@ -124,9 +124,9 @@ const toggleCustomUrl = async () => {
   isUpdating.value.password = true
   try {
     if (passwordProtected.value) {
-      activeView.value = { ...(activeView.value as any), custom_path: null }
+      activeView.value = { ...(activeView.value as any), custom_url_path: null }
     } else {
-      activeView.value = { ...(activeView.value as any), custom_path: '' }
+      activeView.value = { ...(activeView.value as any), custom_url_path: '' }
     }
 
     await updateSharedView()
@@ -251,6 +251,17 @@ function sharedViewUrl() {
   }`
 }
 
+const dashboardUrl1 = computed(() => {
+  // get base url for workspace
+  const baseUrl = getBaseUrl(workspaceStore.activeWorkspaceId)
+
+  if (baseUrl) {
+    return `${baseUrl}${appInfo.value?.dashboardPath}`
+  }
+
+  return dashboardUrl.value
+})
+
 const toggleViewShare = async () => {
   if (!activeView.value?.id) return
 
@@ -317,7 +328,7 @@ async function updateSharedView() {
     await $api.dbViewShare.update(activeView.value.id!, {
       meta,
       password: activeView.value.password,
-      ...(activeView.value?.custom_path ? { custom_path: activeView.value?.custom_path } : {}),
+      custom_url_path: activeView.value?.custom_url_path ?? null,
     })
   } catch (e: any) {
     message.error(await extractSdkResponseErrorMsg(e))
@@ -337,8 +348,6 @@ const updateSharedViewWithDebounce = useDebounceFn(
 async function savePreFilledMode() {
   await updateSharedView()
 }
-
-watchEffect(() => {})
 </script>
 
 <template>
@@ -374,15 +383,26 @@ watchEffect(() => {})
             />
           </div>
           <Transition mode="out-in" name="layout">
-            <div v-if="isOpenCustomUrl" class="flex gap-2 mt-2 w-2/3">
+            <div
+              v-if="isOpenCustomUrl"
+              class="flex items-center mt-2 pl-2 pr-1 w-full border-1 rounded-lg focus-within:(border-1 border-nc-border-brand shadow-selected)"
+            >
+              <div class="text-nc-content-gray-muted">{{ dashboardUrl1 }}#/shared/</div>
               <a-input
                 v-model:value="customUrl"
                 placeholder="Enter custom url"
-                class="!rounded-lg !py-1 !bg-white"
+                class="!rounded-lg !py-1 h-8"
                 data-testid="nc-modal-share-view__custom-url"
                 size="small"
+                :bordered="false"
+                autocomplete="off"
                 @update:value="updateSharedViewWithDebounce"
               />
+              <div>
+                <NcButton size="xs" @click.stop="updateSharedView">
+                  {{ $t('general.save') }}
+                </NcButton>
+              </div>
             </div>
           </Transition>
         </div>
diff --git a/packages/nocodb/src/controllers/custom-urls.controller.ts b/packages/nocodb/src/controllers/custom-urls.controller.ts
new file mode 100644
index 0000000000..eb23cc7bc5
--- /dev/null
+++ b/packages/nocodb/src/controllers/custom-urls.controller.ts
@@ -0,0 +1,44 @@
+import {
+  Body,
+  Controller,
+  Get,
+  HttpCode,
+  Param,
+  Post,
+  UseGuards,
+} from '@nestjs/common';
+import { GlobalGuard } from '~/guards/global/global.guard';
+import { MetaApiLimiterGuard } from '~/guards/meta-api-limiter.guard';
+import { TenantContext } from '~/decorators/tenant-context.decorator';
+import { NcContext } from '~/interface/config';
+import { CustomUrlsService } from 'src/services/custom-urls.service';
+
+@Controller()
+@UseGuards(MetaApiLimiterGuard, GlobalGuard)
+export class CustomUrlsController {
+  constructor(protected readonly customUrlsService: CustomUrlsService) {}
+
+  @Get([
+    '/api/v1/db/meta/custom-url/:customPath',
+    '/api/v2/meta/custom-url/:customPath',
+  ])
+  async getOriginalPath(
+    @TenantContext() context: NcContext,
+    @Param('customPath') customPath: string,
+  ) {
+    await this.customUrlsService.getOriginalPath(context, customPath);
+  }
+
+  @Post(['/api/v1/db/meta/custom-url/check-path', '/api/v2/meta/check-path'])
+  @HttpCode(200)
+  async checkAvailability(
+    @TenantContext() context: NcContext,
+    @Body()
+    body: {
+      id?: string;
+      custom_path?: string;
+    },
+  ) {
+    await this.customUrlsService.checkAvailability(context, body);
+  }
+}
diff --git a/packages/nocodb/src/models/CustomUrl.ts b/packages/nocodb/src/models/CustomUrl.ts
index 4d1836b028..40a0111b62 100644
--- a/packages/nocodb/src/models/CustomUrl.ts
+++ b/packages/nocodb/src/models/CustomUrl.ts
@@ -39,7 +39,7 @@ export default class CustomUrl {
     return customUrl && new CustomUrl(customUrl);
   }
 
-  public static async getByCustomPath(
+  public static async getOriginUrlByCustomPath(
     _context: NcContext,
     customPath: string,
     ncMeta = Noco.ncMeta,
@@ -64,6 +64,8 @@ export default class CustomUrl {
       }
     }
 
+    console.log('custom url', customUrl);
+
     return customUrl && new CustomUrl(customUrl);
   }
 
@@ -134,6 +136,34 @@ export default class CustomUrl {
     );
   }
 
+  public static async checkAvailability(
+    _context: NcContext,
+    params: Pick<CustomUrl, 'id' | 'custom_path'>,
+    ncMeta = Noco.ncMeta,
+  ) {
+    const condition = extractProps(params, ['custom_path']);
+
+    const customUrlList = await ncMeta.metaList2(
+      RootScopes.ROOT,
+      RootScopes.ROOT,
+      MetaTable.CUSTOM_URLS,
+      {
+        condition,
+        xcCondition: params.id
+          ? {
+              _not: {
+                id: {
+                  neq: params.id,
+                },
+              },
+            }
+          : null,
+      },
+    );
+
+    return !!customUrlList.length;
+  }
+
   static async delete(
     _context: NcContext,
     customUrl: Pick<CustomUrl, 'id' | 'view_id'>,
diff --git a/packages/nocodb/src/models/View.ts b/packages/nocodb/src/models/View.ts
index 5a7ad9c3e2..cf50866d74 100644
--- a/packages/nocodb/src/models/View.ts
+++ b/packages/nocodb/src/models/View.ts
@@ -103,6 +103,7 @@ export default class View implements ViewType {
   show_system_fields?: boolean;
   meta?: any;
   fk_custom_url_id?: string;
+  custom_url_path?: string;
 
   constructor(data: View) {
     Object.assign(this, data);
@@ -128,6 +129,15 @@ export default class View implements ViewType {
       );
       if (view) {
         view.meta = parseMetaProp(view);
+
+        if (view.fk_custom_url_id) {
+          const customUrl = await CustomUrl.get(context, {
+            id: view.fk_custom_url_id,
+          });
+
+          view.custom_url_path = customUrl.custom_path || null;
+        }
+
         await NocoCache.set(`${CacheScope.VIEW}:${view.id}`, view);
       }
     }
@@ -170,6 +180,14 @@ export default class View implements ViewType {
       );
 
       if (view) {
+        if (view.fk_custom_url_id) {
+          const customUrl = await CustomUrl.get(context, {
+            id: view.fk_custom_url_id,
+          });
+
+          view.custom_url_path = customUrl.custom_path || null;
+        }
+
         await NocoCache.set(
           `${CacheScope.VIEW}:${fk_model_id}:${view.id}`,
           view,
@@ -210,6 +228,14 @@ export default class View implements ViewType {
       );
       if (view) {
         view.meta = parseMetaProp(view);
+        if (view.fk_custom_url_id) {
+          const customUrl = await CustomUrl.get(context, {
+            id: view.fk_custom_url_id,
+          });
+
+          view.custom_url_path = customUrl.custom_path || null;
+        }
+
         await NocoCache.set(`${CacheScope.VIEW}:${fk_model_id}:default`, view);
       }
     }
@@ -240,6 +266,14 @@ export default class View implements ViewType {
       );
       for (const view of viewsList) {
         view.meta = parseMetaProp(view);
+
+        if (view.fk_custom_url_id) {
+          const customUrl = await CustomUrl.get(context, {
+            id: view.fk_custom_url_id,
+          });
+
+          view.custom_url_path = customUrl.custom_path || null;
+        }
       }
       await NocoCache.setList(CacheScope.VIEW, [modelId], viewsList);
     }
diff --git a/packages/nocodb/src/schema/swagger-v2.json b/packages/nocodb/src/schema/swagger-v2.json
index 6f3cefe642..7a7660e65d 100644
--- a/packages/nocodb/src/schema/swagger-v2.json
+++ b/packages/nocodb/src/schema/swagger-v2.json
@@ -12970,6 +12970,93 @@
           "$ref": "#/components/parameters/xc-token"
         }
       ]
+    },
+    "/api/v2/meta/custom-url/{customPath}": {
+      "get": {
+        "summary": "Get original path from custom url path",
+        "operationId": "get-original-path",
+        "description": "Get original path from custom url path",
+        "tags": [
+          "CustomUrl", "Internal"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {},
+                "examples": {
+                  "Example 1": {
+                    "value": "nc/form/957b3e5b-c7fe-4805-bdb2-e4048e974f62"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          }
+        }
+      },
+      "parameters": [
+        {
+          "schema": {
+            "type": "string"
+          },
+          "name": "customPath",
+          "in": "path",
+          "required": true,
+          "description": "Custom url path"
+        },
+        {
+          "$ref": "#/components/parameters/xc-token"
+        }
+      ]
+    },
+    "/api/v2/meta/custom-url/check-path": {
+      "get": {
+        "summary": "Check custom url path availability",
+        "operationId": "check-availability",
+        "description": "Check custom url path availability",
+        "tags": [
+          "CustomUrl", "Internal"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "status": {
+                    "custom_path": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {},
+                "examples": {
+                  "Example 1": {
+                    "value": true
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -19841,7 +19928,8 @@
         "examples": [
           {
             "meta": {},
-            "password": "123456789"
+            "password": "123456789",
+            "custom_url_path": "feedback-form"
           }
         ],
         "title": "Shared View Request Model",
@@ -19854,6 +19942,10 @@
           "password": {
             "$ref": "#/components/schemas/StringOrNull",
             "description": "Password to restrict access"
+          },
+          "custom_url_path": {
+            "$ref": "#/components/schemas/StringOrNull",
+            "description": "Custom url path"
           }
         },
         "x-stoplight": {
@@ -21205,6 +21297,18 @@
               }
             ],
             "description": "Associated View Model"
+          },
+          "owned_by": {
+            "$ref": "#/components/schemas/Id",
+            "description": "ID of view owner user"
+          },
+          "fk_custom_url_id": {
+            "$ref": "#/components/schemas/StringOrNull",
+            "description": "Custom url id of view"
+          },
+          "custom_url_path": {
+            "$ref": "#/components/schemas/StringOrNull",
+            "description": "Custom url path"
           }
         },
         "required": [
diff --git a/packages/nocodb/src/schema/swagger.json b/packages/nocodb/src/schema/swagger.json
index de25f22eb6..14c9b69a1e 100644
--- a/packages/nocodb/src/schema/swagger.json
+++ b/packages/nocodb/src/schema/swagger.json
@@ -24958,7 +24958,7 @@
           {
             "meta": {},
             "password": "123456789",
-            "custom_path": "feedback-form"
+            "custom_url_path": "feedback-form"
           }
         ],
         "title": "Shared View Request Model",
@@ -24972,9 +24972,9 @@
             "$ref": "#/components/schemas/StringOrNull",
             "description": "Password to restrict access"
           },
-          "custom_path": {
+          "custom_url_path": {
             "$ref": "#/components/schemas/StringOrNull",
-            "description": "Custom url"
+            "description": "Custom url path"
           }
         },
         "x-stoplight": {
@@ -26360,6 +26360,14 @@
           "owned_by": {
             "$ref": "#/components/schemas/Id",
             "description": "ID of view owner user"
+          },
+          "fk_custom_url_id": {
+            "$ref": "#/components/schemas/StringOrNull",
+            "description": "Custom url id of view"
+          },
+          "custom_url_path": {
+            "$ref": "#/components/schemas/StringOrNull",
+            "description": "Custom url path"
           }
         },
         "required": ["fk_model_id", "show", "title", "type"],
diff --git a/packages/nocodb/src/services/custom-urls.service.ts b/packages/nocodb/src/services/custom-urls.service.ts
new file mode 100644
index 0000000000..b5c1338715
--- /dev/null
+++ b/packages/nocodb/src/services/custom-urls.service.ts
@@ -0,0 +1,20 @@
+import { Injectable } from '@nestjs/common';
+import type { NcContext } from '~/interface/config';
+import { AppHooksService } from '~/services/app-hooks/app-hooks.service';
+import CustomUrl from 'src/models/CustomUrl';
+
+@Injectable()
+export class CustomUrlsService {
+  constructor(private readonly appHooksService: AppHooksService) {}
+
+  async checkAvailability(
+    context: NcContext,
+    params: Pick<CustomUrl, 'id' | 'custom_path'>,
+  ) {
+    return await CustomUrl.checkAvailability(context, params);
+  }
+
+  async getOriginalPath(context: NcContext, custom_path: string) {
+    return await CustomUrl.getOriginUrlByCustomPath(context, custom_path);
+  }
+}
diff --git a/packages/nocodb/src/services/views.service.ts b/packages/nocodb/src/services/views.service.ts
index 5f77e8a529..1fd3cbce5b 100644
--- a/packages/nocodb/src/services/views.service.ts
+++ b/packages/nocodb/src/services/views.service.ts
@@ -279,9 +279,9 @@ export class ViewsService {
     });
 
     if (customUrl?.id) {
-      if (param.sharedView.custom_path) {
+      if (param.sharedView.custom_url_path) {
         await CustomUrl.update(context, view.fk_custom_url_id, {
-          custom_path: param.sharedView.custom_path,
+          custom_path: param.sharedView.custom_url_path,
         });
       } else {
         await CustomUrl.delete(context, { id: view.fk_custom_url_id });
@@ -295,7 +295,7 @@ export class ViewsService {
         view_id: view.id,
         // Todo: add original path
         original_path: '',
-        custom_path: param.sharedView.custom_path,
+        custom_path: param.sharedView.custom_url_path,
       });
     }