Static module: extract logic from controller to service

2026-07-08 20:37:41 +00:00 · 2022-12-05 20:38:29 +02:00
parent b4ad786d62
commit 9f85c11d2e
5 changed files with 99 additions and 110 deletions
@@ -1,106 +1,21 @@
-import {
-  Controller,
-  Get,
-  Next,
-  NotFoundException,
-  Req,
-  Res,
-  UnauthorizedException,
-} from '@nestjs/common';
+import { Controller, Get, Next, Req, Res } from '@nestjs/common';
 import { NextFunction, Request, Response } from 'express';
-import { readdir, stat } from 'fs/promises';
-import { join } from 'path';
-import { Stats } from 'fs';
+import { StaticService } from './static.service';

@Controller('*')
 export class StaticController {
+  constructor(private readonly staticService: StaticService) {}
  @Get()
  async main(
    @Req() request: Request,
    @Res() response: Response,
    @Next() next: NextFunction,
  ) {
-    //todo - refactor to use service
-    const relPath = request.url;
-    //relPath = relPath.split('%2E').join('.');
-    //relPath = relPath.split('%2e').join('.');
-
-    if (relPath.indexOf('..') > -1) {
-      throw new UnauthorizedException(
-        'You are not authorized to visit ' + request.url,
-      );
-    }
-
-    const path = join(__dirname, process.env.STATIC_SERVE_FOLDER, relPath);
-
-    const stats: Stats | false = await stat(path).catch(() => false);
-
-    if (stats === false) {
-      throw new NotFoundException('Path not found: ' + relPath);
-    }
-
-    if (!stats.isDirectory()) {
+    const dirIndexHtml = await this.staticService.provideDirIndex(request.url);
+    if (dirIndexHtml === null) {
      return next();
    }

-    response.status(200).send(await readDirectory(path, relPath));
-
-    return;
+    return response.status(200).send(dirIndexHtml);
  }
 }
-
-//todo - move this to service
-async function readDirectory(path: string, relPath: string) {
-  let files = await readdir(path);
-  let longestFileLength = 0;
-
-  files = files.filter((fileName: string) => {
-    const fileIncluded = fileName[0] !== '.';
-    longestFileLength =
-      fileIncluded && longestFileLength < fileName.length
-        ? fileName.length
-        : longestFileLength;
-
-    return fileIncluded;
-  });
-
-  longestFileLength += 10;
-
-  let result: string;
-  const resultHtmlStart = `
-    <html lang="en">
-        <head><title>Index of ${relPath} </title></head>
-        <body>
-          <h1>Index of ${relPath}</h1>
-          <hr><pre>`;
-
-  result = `<a href="../">../</a>`;
-
-  for (const file of files) {
-    const stats: Stats | false = await stat(join(path, file)).catch(
-      () => false,
-    );
-
-    if (stats === false) {
-      continue;
-    }
-    const arrDate: Array<string> = stats.birthtime.toUTCString().split(' ');
-    const strDate: string =
-      ' '.repeat(longestFileLength - file.length) +
-      `${arrDate[1]}-${arrDate[2]}-${arrDate[3]} ${arrDate[4]}`;
-
-    if (stats.isDirectory()) {
-      const strSize = ' '.repeat(19) + '-';
-      result += '\n' + `<a href="${file}/">${file}/</a>${strDate + strSize}`;
-      continue;
-    }
-    let strSize = stats.size.toString();
-    strSize = ' '.repeat(20 - strSize.length) + strSize;
-
-    result += '\n' + `<a href="${file}">${file}</a> ${strDate + strSize}`;
-  }
-
-  const resultHtmlEnd = `</pre><hr></body></html>`;
-
-  return resultHtmlStart + result + resultHtmlEnd;
-}
@@ -8,6 +8,7 @@ import { ServeStaticModule } from '@nestjs/serve-static';
 import { join } from 'path';
 import { StaticController } from './static.controller';
 import { RemoveQueryUrlRewriteMiddleware } from './UrlRewrite/url-rewrite.middleware';
+import { StaticService } from './static.service';

@Module({
  imports: [
@@ -16,7 +17,7 @@ import { RemoveQueryUrlRewriteMiddleware } from './UrlRewrite/url-rewrite.middle
    }),
  ],
  controllers: [StaticController],
-  providers: [],
+  providers: [StaticService],
 })
 export class StaticModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
@@ -0,0 +1,88 @@
+import {
+  Injectable,
+  NotFoundException,
+  UnauthorizedException,
+} from '@nestjs/common';
+import { readdir, stat } from 'fs/promises';
+import { Stats } from 'fs';
+import { join } from 'path';
+
+@Injectable()
+export class StaticService {
+  async provideDirIndex(relPath: string): Promise<string> {
+    if (relPath.indexOf('..') > -1) {
+      throw new UnauthorizedException(
+        'You are not authorized to visit ' + relPath,
+      );
+    }
+
+    const path = join(__dirname, process.env.STATIC_SERVE_FOLDER, relPath);
+
+    const stats: Stats | false = await stat(path).catch(() => false);
+
+    if (stats === false) {
+      throw new NotFoundException('Path not found: ' + relPath);
+    }
+
+    if (!stats.isDirectory()) {
+      return null;
+    }
+
+    return this.readDirectory(path, relPath);
+  }
+
+  private async readDirectory(path: string, relPath: string) {
+    let files = await readdir(path);
+    let longestFileLength = 0;
+
+    files = files.filter((fileName: string) => {
+      const fileIncluded = fileName[0] !== '.';
+      longestFileLength =
+        fileIncluded && longestFileLength < fileName.length
+          ? fileName.length
+          : longestFileLength;
+
+      return fileIncluded;
+    });
+
+    longestFileLength += 10;
+
+    let result: string;
+    const resultHtmlStart = `
+    <html lang="en">
+        <head><title>Index of ${relPath} </title></head>
+        <body>
+          <h1>Index of ${relPath}</h1>
+          <hr><pre>`;
+
+    result = `<a href="../">../</a>`;
+
+    for (const file of files) {
+      const stats: Stats | false = await stat(join(path, file)).catch(
+        () => false,
+      );
+
+      if (stats === false) {
+        continue;
+      }
+      const arrDate: Array<string> = stats.birthtime.toUTCString().split(' ');
+      const strDate: string =
+        ' '.repeat(longestFileLength - file.length) +
+        `${arrDate[1]}-${arrDate[2]}-${arrDate[3]} ${arrDate[4]}`;
+
+      if (stats.isDirectory()) {
+        const strSize = ' '.repeat(19) + '-';
+        result += '\n' + `<a href="${file}/">${file}/</a>${strDate + strSize}`;
+        continue;
+      }
+      let strSize = stats.size.toString();
+      strSize = ' '.repeat(20 - strSize.length) + strSize;
+
+      result += '\n' + `<a href="${file}">${file}</a> ${strDate + strSize}`;
+    }
+
+    const resultHtmlEnd = `</pre><hr></body></html>`;
+
+    return resultHtmlStart + result + resultHtmlEnd;
+  }
+}
@@ -1,14 +1,5 @@
-import {
-  //MiddlewareConsumer,
-  Module,
-  //NestModule,
-  //RequestMethod,
-} from '@nestjs/common';
+import { Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
-//import { AppService } from './app.service';
-//import { KodiApiController } from './KodiApi/kodi-api.controller';
-//import { StaticController } from './Static/static.controller';
-//import { KodiApiUrlRewriteMiddleware } from './KodiApi/UrlRewrite/url-rewrite.middleware';
 import { KodiApiModule } from './KodiApi/kodi-api.module';
 import { StaticModule } from './Static/static.module';

@@ -18,10 +9,3 @@ import { StaticModule } from './Static/static.module';
  providers: [],
 })
 export class AppModule {}
-// export class AppModule implements NestModule {
-//   configure(consumer: MiddlewareConsumer) {
-//     consumer
-//       .apply(KodiApiUrlRewriteMiddleware)
-//       .forRoutes({ path: '/api*', method: RequestMethod.ALL });
-//   }
-// }