globus_i_gridftp_server_control_facts.h

#ifndef GLOBUS_I_GRIDFTP_SERVER_CONTROL_FACTS_H
#define GLOBUS_I_GRIDFTP_SERVER_CONTROL_FACTS_H
 
#include "globus_gridftp_server_control.h"
 
/*
 *  Extra MLSx facts, for the GridFTP server.
 *
 *  This header is not installed: the server ships in the same package as
 *  this library, so these functions can change along with it.  They are
 *  still exported from the library, because libglobus_gridftp_server calls
 *  them.
 */
 
/*
 *  Register MLSx facts beyond the built-in ones, so that FEAT lists them and
 *  OPTS MLST can select them.  fact_names is "name;name;" in the order the
 *  facts should be printed, e.g. "X.foo;X.bar;".  Names match
 *  case-insensitively and must not contain '=', ';', spaces or control
 *  characters, repeat each other or a built-in fact.  At most 16 names.
 *
 *  Call it once per server, before the client selects facts; later calls
 *  fail, because OPTS MLST selections refer to the names by position.
 */
globus_result_t
globus_i_gsc_add_mlst_facts(
    globus_gridftp_server_control_t         server,
    const char *                            fact_names);
 
/*
 *  globus_gridftp_server_control_finished_resource() with extra facts.
 *  facts is NULL, or stat_count strings (entries may be NULL): facts[i]
 *  holds entry i's extra facts as "name=value;name=value;" with URL-encoded
 *  values.  MLST and MLSC send a fact only if the client selected it with
 *  OPTS MLST.  The strings are copied.
 */
globus_result_t
globus_i_gsc_finished_resource_facts(
    globus_gridftp_server_control_op_t      op,
    globus_gridftp_server_control_stat_t *  stat_info_array,
    int                                     stat_count,
    int                                     uid,
    int                                     gid_count,
    int *                                   gid_array,
    char **                                 facts,
    globus_gridftp_server_control_response_t response_code,
    const char *                            msg);
 
/*
 *  Or'ed into the resource mask for MLST and MLSC when the client selected
 *  at least one extra fact, so the user can skip looking them up otherwise.
 *  Existing users test the mask with &, so the extra bit does not change
 *  their behaviour.
 */
#define GLOBUS_I_GSC_RESOURCE_EXT_FACTS         4
 
/*
 *  The registered extra facts the client's current OPTS MLST selection
 *  includes, as "name;name;" (e.g. "X.foo;X.bar;"), or NULL if none.  The
 *  caller frees the result.
 */
char *
globus_i_gsc_get_ext_facts(
    globus_gridftp_server_control_t         server);
 
#endif