/* $OpenBSD: cmd-list-clients.c,v 1.42 2026/02/27 08:25:12 nicm Exp $ */

/*
 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/types.h>

#include <stdlib.h>
#include <string.h>
#include <time.h>

#include "tmux.h"

/*
 * List all clients.
 */

#define LIST_CLIENTS_TEMPLATE                                           \
        "#{client_name}: #{session_name} "                              \
        "[#{client_width}x#{client_height} #{client_termname}] "        \
        "#{?#{!=:#{client_uid},#{uid}},"                                \
        "[user #{?client_user,#{client_user},#{client_uid},}] ,}"       \
        "#{?client_flags,(,}#{client_flags}#{?client_flags,),}"

static enum cmd_retval  cmd_list_clients_exec(struct cmd *, struct cmdq_item *);

const struct cmd_entry cmd_list_clients_entry = {
        .name = "list-clients",
        .alias = "lsc",

        .args = { "F:f:O:rt:", 0, 0, NULL },
        .usage = "[-F format] [-f filter] [-O order]" CMD_TARGET_SESSION_USAGE,

        .target = { 't', CMD_FIND_SESSION, 0 },

        .flags = CMD_READONLY|CMD_AFTERHOOK,
        .exec = cmd_list_clients_exec
};

static enum cmd_retval
cmd_list_clients_exec(struct cmd *self, struct cmdq_item *item)
{
        struct args              *args = cmd_get_args(self);
        struct cmd_find_state    *target = cmdq_get_target(item);
        struct client           **l;
        struct session           *s;
        struct format_tree       *ft;
        const char               *template, *filter;
        u_int                     i, n;
        char                     *line, *expanded;
        int                       flag;
        struct sort_criteria      sort_crit;

        if (args_has(args, 't'))
                s = target->s;
        else
                s = NULL;

        if ((template = args_get(args, 'F')) == NULL)
                template = LIST_CLIENTS_TEMPLATE;
        filter = args_get(args, 'f');

        sort_crit.order = sort_order_from_string(args_get(args, 'O'));
        if (sort_crit.order == SORT_END && args_has(args, 'O')) {
                cmdq_error(item, "invalid sort order");
                return (CMD_RETURN_ERROR);
        }
        sort_crit.reversed = args_has(args, 'r');

        l = sort_get_clients(&n, &sort_crit);
        for (i = 0; i < n; i++) {
                if (l[i]->session == NULL || (s != NULL && s != l[i]->session))
                        continue;

                ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, 0);
                format_add(ft, "line", "%u", i);
                format_defaults(ft, l[i], NULL, NULL, NULL);

                if (filter != NULL) {
                        expanded = format_expand(ft, filter);
                        flag = format_true(expanded);
                        free(expanded);
                } else
                        flag = 1;
                if (flag) {
                        line = format_expand(ft, template);
                        cmdq_print(item, "%s", line);
                        free(line);
                }

                format_free(ft);
        }

        return (CMD_RETURN_NORMAL);
}