pangolin/server/routers/client/getClient.ts

import { Request, Response, NextFunction } from "express";
import { z } from "zod";
import { db, olms } from "@server/db";
import { clients, fingerprints } from "@server/db";
import { eq, and } from "drizzle-orm";
import response from "@server/lib/response";
import HttpCode from "@server/types/HttpCode";
import createHttpError from "http-errors";
import logger from "@server/logger";
import stoi from "@server/lib/stoi";
import { fromError } from "zod-validation-error";
import { OpenAPITags, registry } from "@server/openApi";
import { getUserDeviceName } from "@server/db/names";

const getClientSchema = z.strictObject({
    clientId: z
        .string()
        .optional()
        .transform(stoi)
        .pipe(z.int().positive().optional())
        .optional(),
    niceId: z.string().optional(),
    orgId: z.string().optional()
});

async function query(clientId?: number, niceId?: string, orgId?: string) {
    if (clientId) {
        const [res] = await db
            .select()
            .from(clients)
            .where(eq(clients.clientId, clientId))
            .leftJoin(olms, eq(clients.clientId, olms.clientId))
            .leftJoin(fingerprints, eq(olms.olmId, fingerprints.olmId))
            .limit(1);
        return res;
    } else if (niceId && orgId) {
        const [res] = await db
            .select()
            .from(clients)
            .where(and(eq(clients.niceId, niceId), eq(clients.orgId, orgId)))
            .leftJoin(olms, eq(clients.clientId, olms.clientId))
            .leftJoin(fingerprints, eq(olms.olmId, fingerprints.olmId))
            .limit(1);
        return res;
    }
}

export type GetClientResponse = NonNullable<
    Awaited<ReturnType<typeof query>>
>["clients"] & {
    olmId: string | null;
    agent: string | null;
    olmVersion: string | null;
    fingerprint: {
        username: string | null;
        hostname: string | null;
        platform: string | null;
        osVersion: string | null;
        kernelVersion: string | null;
        arch: string | null;
        deviceModel: string | null;
        serialNumber: string | null;
        firstSeen: number | null;
        lastSeen: number | null;
    } | null;
};

registry.registerPath({
    method: "get",
    path: "/org/{orgId}/client/{niceId}",
    description:
        "Get a client by orgId and niceId. NiceId is a readable ID for the site and unique on a per org basis.",
    tags: [OpenAPITags.Org, OpenAPITags.Site],
    request: {
        params: z.object({
            orgId: z.string(),
            niceId: z.string()
        })
    },
    responses: {}
});

registry.registerPath({
    method: "get",
    path: "/client/{clientId}",
    description: "Get a client by its client ID.",
    tags: [OpenAPITags.Client],
    request: {
        params: z.object({
            clientId: z.number()
        })
    },
    responses: {}
});

export async function getClient(
    req: Request,
    res: Response,
    next: NextFunction
): Promise<any> {
    try {
        const parsedParams = getClientSchema.safeParse(req.params);
        if (!parsedParams.success) {
            logger.error(
                `Error parsing params: ${fromError(parsedParams.error).toString()}`
            );
            return next(
                createHttpError(
                    HttpCode.BAD_REQUEST,
                    fromError(parsedParams.error).toString()
                )
            );
        }

        const { clientId, niceId, orgId } = parsedParams.data;

        const client = await query(clientId, niceId, orgId);

        if (!client) {
            return next(
                createHttpError(HttpCode.NOT_FOUND, "Client not found")
            );
        }

        // Replace name with device name if OLM exists
        let clientName = client.clients.name;
        if (client.olms) {
            const model = client.fingerprints?.deviceModel || null;
            clientName = getUserDeviceName(model, client.clients.name);
        }

        // Build fingerprint data if available
        const fingerprintData = client.fingerprints
            ? {
                  username: client.fingerprints.username || null,
                  hostname: client.fingerprints.hostname || null,
                  platform: client.fingerprints.platform || null,
                  osVersion: client.fingerprints.osVersion || null,
                  kernelVersion: client.fingerprints.kernelVersion || null,
                  arch: client.fingerprints.arch || null,
                  deviceModel: client.fingerprints.deviceModel || null,
                  serialNumber: client.fingerprints.serialNumber || null,
                  firstSeen: client.fingerprints.firstSeen || null,
                  lastSeen: client.fingerprints.lastSeen || null
              }
            : null;

        const data: GetClientResponse = {
            ...client.clients,
            name: clientName,
            olmId: client.olms ? client.olms.olmId : null,
            agent: client.olms?.agent || null,
            olmVersion: client.olms?.version || null,
            fingerprint: fingerprintData
        };

        return response<GetClientResponse>(res, {
            data,
            success: true,
            error: false,
            message: "Client retrieved successfully",
            status: HttpCode.OK
        });
    } catch (error) {
        logger.error(error);
        return next(
            createHttpError(HttpCode.INTERNAL_SERVER_ERROR, "An error occurred")
        );
    }
}