src/charging-station/ui-server/AbstractUIServer.ts

   1 import { type IncomingMessage, Server, type ServerResponse } from 'node:http';
   2
   3 import type { WebSocket } from 'ws';
   4
   5 import type { AbstractUIService } from './ui-services/AbstractUIService';
   6 import { UIServiceFactory } from './ui-services/UIServiceFactory';
   7 import { BaseError } from '../../exception';
   8 import {
   9   AuthenticationType,
  10   type ChargingStationData,
  11   type ProcedureName,
  12   type ProtocolRequest,
  13   type ProtocolResponse,
  14   type ProtocolVersion,
  15   type RequestPayload,
  16   type ResponsePayload,
  17   type UIServerConfiguration,
  18 } from '../../types';
  19
  20 export abstract class AbstractUIServer {
  21   public readonly chargingStations: Map<string, ChargingStationData>;
  22   protected readonly httpServer: Server;
  23   protected readonly responseHandlers: Map<string, ServerResponse | WebSocket>;
  24   protected readonly uiServices: Map<ProtocolVersion, AbstractUIService>;
  25
  26   public constructor(protected readonly uiServerConfiguration: UIServerConfiguration) {
  27     this.chargingStations = new Map<string, ChargingStationData>();
  28     this.httpServer = new Server();
  29     this.responseHandlers = new Map<string, ServerResponse | WebSocket>();
  30     this.uiServices = new Map<ProtocolVersion, AbstractUIService>();
  31   }
  32
  33   public buildProtocolRequest(
  34     id: string,
  35     procedureName: ProcedureName,
  36     requestPayload: RequestPayload
  37   ): ProtocolRequest {
  38     return [id, procedureName, requestPayload];
  39   }
  40
  41   public buildProtocolResponse(id: string, responsePayload: ResponsePayload): ProtocolResponse {
  42     return [id, responsePayload];
  43   }
  44
  45   public stop(): void {
  46     this.chargingStations.clear();
  47   }
  48
  49   protected startHttpServer(): void {
  50     if (this.httpServer.listening === false) {
  51       this.httpServer.listen(this.uiServerConfiguration.options);
  52     }
  53   }
  54
  55   protected registerProtocolVersionUIService(version: ProtocolVersion): void {
  56     if (this.uiServices.has(version) === false) {
  57       this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this));
  58     }
  59   }
  60
  61   protected authenticate(req: IncomingMessage, next: (err?: Error) => void): void {
  62     if (this.isBasicAuthEnabled() === true) {
  63       if (this.isValidBasicAuth(req) === false) {
  64         next(new BaseError('Unauthorized'));
  65       }
  66       next();
  67     }
  68     next();
  69   }
  70
  71   private isBasicAuthEnabled(): boolean {
  72     return (
  73       this.uiServerConfiguration.authentication?.enabled === true &&
  74       this.uiServerConfiguration.authentication?.type === AuthenticationType.BASIC_AUTH
  75     );
  76   }
  77
  78   private isValidBasicAuth(req: IncomingMessage): boolean {
  79     const authorizationHeader = req.headers.authorization ?? '';
  80     const authorizationToken = authorizationHeader.split(/\s+/).pop() ?? '';
  81     const authentication = Buffer.from(authorizationToken, 'base64').toString();
  82     const authenticationParts = authentication.split(/:/);
  83     const username = authenticationParts.shift();
  84     const password = authenticationParts.join(':');
  85     return (
  86       this.uiServerConfiguration.authentication?.username === username &&
  87       this.uiServerConfiguration.authentication?.password === password
  88     );
  89   }
  90
  91   public abstract start(): void;
  92   public abstract sendRequest(request: ProtocolRequest): void;
  93   public abstract sendResponse(response: ProtocolResponse): void;
  94   public abstract logPrefix(
  95     moduleName?: string,
  96     methodName?: string,
  97     prefixSuffix?: string
  98   ): string;
  99 }