/** @file sysfs_util.c
  *
  * Functions for reading /sys file system
  */

// Copyright (C) 2016-2024 Sanford Rockowitz <rockowitz@minsoft.com>
// SPDX-License-Identifier: GPL-2.0-or-later

//* \cond */
#include <assert.h>
#include <errno.h>
#include <glib-2.0/glib.h>
#include <libgen.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
/** \endcond */

#include "coredefs_base.h"
#include "debug_util.h"
#include "file_util.h"
#include "report_util.h"
#include "string_util.h"

#include "sysfs_util.h"


//  -Wstringop-trunction is brain dead
//  compile will fail if -Werror set
// #pragma GCC diagnostic push
// #pragma GCC diagnostic ignored "-Wstringop-truncation"


/** Reads a /sys attribute file, which is 1 line of text
 *
 * \param  dirname    directory name
 * \param  attrname   attribute name, i.e. file name
 * \param  verbose    if true, write message to stderr if unable to open file
 * \return pointer to attribute value string, caller is responsible for freeing
 */
char *
read_sysfs_attr(
      const char * dirname,
      const char * attrname,
      bool         verbose)
{
   char fn[PATH_MAX];
   sprintf(fn, "%s/%s", dirname, attrname);
   return file_get_first_line(fn, verbose);
}


/** Reads a /sys attribute file, which is 1 line of text.
 *  If the attribute is not found, returns a default value
 *
 * \param  dirname        directory name
 * \param  attrname       attribute name, i.e. file name
 * \param  default_value  default value, duplicated
 * \param  verbose        if true, write message to stderr if unable to open file
 * \return pointer to attribute value string, caller is responsible for freeing
 */
char *
read_sysfs_attr_w_default(
      const char * dirname,
      const char * attrname,
      const char * default_value,
      bool         verbose)
{
   char fn[PATH_MAX];
   sprintf(fn, "%s/%s", dirname, attrname);
   char * result = file_get_first_line(fn, verbose);
   if (!result)
      result = g_strdup(default_value);  // g_strdup() so caller can free any result
   return result;
}


/** Reads a /sys attribute file, which is 1 line of text, into a buffer
 *  provided by the caller.
 *  If the attribute is not found, returns a default value
 *
 * \param  dirname        directory name
 * \param  attrname       attribute name, i.e. file name
 * \param  default_value  default value, duplicated
 * \param  buf            pointer to buffer
 * \param  bufsz          size of buffer
 * \param  verbose        if true, write message to stderr if unable to open file
 * \return buf
 *
 *  If the string to be returned is too large for the buffer, it is truncated
 *  to fit with a trailing '\0'.
 */
char *
read_sysfs_attr_w_default_r(
      const char * dirname,
      const char * attrname,
      const char * default_value,
      char *       buf,
      unsigned     bufsz,
      bool         verbose)
{
   assert(strlen(default_value) < bufsz);
   char fn[PATH_MAX];
   sprintf(fn, "%s/%s", dirname, attrname);
   char * result = file_get_first_line(fn, verbose);
   if (result) {
      STRLCPY(buf, result, bufsz);
      free(result);
   }
   else {
      STRLCPY(buf, default_value, bufsz);
   }
   return buf;
}


/** Reads a binary /sys attribute file
 *
 * \param  dirname   directory name
 * \param  attrname  attribute name, i.e. file name
 * \param  est_size  estimated size
 * \param  verbose   if open fails, write message to stderr
 * \return if successful, a **GByteArray** of bytes, caller is responsible for freeing
 *          if failure, then NULL
 */
GByteArray *
read_binary_sysfs_attr(
      const char * dirname,
      const char * attrname,
      int          est_size,
      bool         verbose)
{
   assert(dirname);
   assert(attrname);

   char fn[PATH_MAX];
   sprintf(fn, "%s/%s", dirname, attrname);

   return read_binary_file(fn, est_size, verbose);
}


/** For a given directory path, returns the last component of the
 *  resolved absolute path.
 *
 *  \param   path  path to resolve
 *  \return  base name of resolved path, caller is responsible for freeing
 */
char *
get_rpath_basename(
      const char * path)
{
   char * result = NULL;
   char   resolved_path[PATH_MAX];
   char * rpath = realpath(path, resolved_path);
   // printf("(%s) rpath=|%s|\n", __func__, rpath);
   if (rpath) {
      result = g_path_get_basename(rpath);
   }
   // printf("(%s) busno=%d, returning %s\n", __func__, busno, driver_name);
   return result;
}


//
// Functions for probing /sys
//

/*
The rpt_attr...() functions share a common set of behaviors.

1) They write the value read to the fout() device, typically sysout.

2) A message is not actually written if either global setting set_rpt_sysfs_attr_silent(true)
   or the logical indentation depth (depth parm) is less than 0.

3) If the value_loc parm is non-null, it is the address at which the function
   returns the address of newly allocated memory containing the value.
   NULL is returned if the attribute is not found.

4) The depth and value_loc arguments are followed by 1 or more parts
   of a file name.  The parts are assembled to create the fully qualified
   name of the attribute.
 */


static bool rpt2_silent = false;

/** Globally controls whether values read are actually written to the terminal.
 *
 *  \param  onoff
 *  \return prior value
 */
bool
set_rpt_sysfs_attr_silent(
      bool onoff)
{
   bool old = rpt2_silent;
   rpt2_silent = onoff;
   return old;
}


/** This is the core function for writing attribute values to the terminal.
 *
 *  \param  depth  logical indentation depth
 *  \param  node   fully qualified attribute name (i.e. file name)
 *  \param  op     "=" or ":"
 *  \param  value  attribute value if op is "=",
 *                 a string like "found" if op is ":"
 *                 realpath or basename if op is "->"
 *
 *  The attribute name is padded on the right tp be at least 70 characters wide.
 */
void
rpt_attr_output(
      int depth,
      const char * node,
      const char * op,
      const char * value)
{
   if (!rpt2_silent) {
      int offset = 70;
      if (depth >= 0)
         rpt_vstring(depth, "%-*s%-2s %s", offset, node, op, value);
   }
}


/** Reads a normal, single line attribute value from a file.
 *
 *  \param  fq_attrname  fully qualified attribute name (i.e. file name)
 *  \param  verbose      if true, write message to stderr if unable to open file
 *  \retval non-NULL     pointer to line read (caller responsible for freeing)
 *  \retval NULL         if error or no lines in file
 */
static inline char *
read_sysfs_attr0(
      const char * fq_attrname,
      bool         verbose)
{
   return file_get_first_line(fq_attrname, verbose);
}


/** Returns the name of the first subdirectory of a specified directory
 *  whose name satisfies the filter function.
 *  \param dirname name of directory to search
 *  \param filter  pointer to filter function
 *  \param val     comparison value passed to filter function
 *  \retval simple name of first subdirectory that satisfies the filter function
 *          (caller responsible for freeing)
 *  \retval NULL if not found
 */
static char *
get_single_subdir_name(
      const char * dirname,
      Fn_Filter    filter,
      const char * val)
{
   bool debug = false;
   int d1 = 1;
   DIR* dir2 = opendir(dirname);
   char * result = NULL;
   if (!dir2) {
      rpt_vstring(d1, "Unexpected error. Unable to open sysfs directory %s: %s",
                      dirname, strerror(errno));
     }
     else {
        struct dirent *dent2;
        while ((dent2 = readdir(dir2)) != NULL) {
           DBGF(debug, "%s", dent2->d_name);
           if (!str_starts_with(dent2->d_name, ".")) {
              if (!filter || filter(dent2->d_name, val)) {
                 result = g_strdup(dent2->d_name);
                 break;
              }
           }
        }
        closedir(dir2);
     }
   DBGF(debug, "directory: %s, first subdir: %s", dirname, result);
   return result;
}


/** Assembles a file (sysfs attribute) name from one or more segments.
 *  \param  buffer     buffer in which to return the assembled name
 *  \param  bufsz      size of buffer
 *  \param  fn_segment first segment of name
 *  \param  ap         remaining segments
 *  \return assembled attribute name (buffer)
 *
 *  The assembled value will be silently truncated if necessary to fit in buffer
 */
char *
assemble_sysfs_path2(
      char *        buffer,
      int           bufsz,
      const char *  fn_segment,
      va_list       ap)
{
   assert(buffer && bufsz > 0);
   bool debug = false;
   DBGF(debug, "Starting.  bufsz=%d, fn_segment=|%s|", bufsz, fn_segment);
   
   STRLCPY(buffer, fn_segment, bufsz-1);
   int segment_ct = 1;
   while(true) {
      char * segment = va_arg(ap, char*);
      if (!segment)
         break;
      segment_ct++;
      DBGF(debug, "segment_ct: %d, segment=%p", segment_ct, segment);
      // hex_dump((const Byte*)segment,32);
      DBGF(debug, "segment |%s|", segment);
      STRLCAT(buffer, "/", bufsz);
      STRLCAT(buffer, segment, bufsz);
   }
   DBGF(debug,"Returning: %s", buffer);
   return buffer;
}


/** Reports the value of a simple text attribute (the most common case)
 *  to the sysout device.
 *
 *  If the attribute is not found, reports "Not found".
 *
 *  \param  depth      logical indentation depth, if < 0, output nothing
 *  \param  value_loc  if non-NULL, the address at which to return a copy of
 *                     the attribute value (caller is responsible for freeing).
 *                     or NULL if the attribute cannot be read
 *  \param  fn_segment first segment of attribute name
 *  \param  ...         remaining segments of name
 *  \return true if attribute found, false if not
 *
 *  \remark
 *  *value_loc is set iff result is true
 */
bool
rpt_attr_text(
      int          depth,
      char **      value_loc,
      const char * fn_segment,
      ...)
{
   bool debug = false;
   if (debug)
      printf("(%s) Starting. fn_segment=%s\n", __func__, fn_segment);

   bool found = false;
   if (value_loc)
      *value_loc = NULL;

   char pb1[PATH_MAX];
   va_list ap;
   va_start(ap, fn_segment);
   assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
   va_end(ap);
   if (debug)
      printf("(%s) pb1=%s\n", __func__, pb1);

   char * val = read_sysfs_attr0(pb1, false);
   if (val) {
      found = true;
      rpt_attr_output(depth, pb1, "=", val);
      if (value_loc)
         *value_loc = val;
      else
         free(val);
  }
  else {
     rpt_attr_output(depth, pb1, ": ", "Not Found");
  }

  if (debug)
     printf("(%s) Done.\n", __func__);

  if (value_loc)
     ASSERT_IFF(found, *value_loc);
  return found;
}


bool
rpt_attr_int(
      int          depth,
      int *        value_loc,
      const char * fn_segment,
      ...)
{
   bool debug = false;

   char pb1[PATH_MAX];
   va_list ap;
   va_start(ap, fn_segment);
   assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
   va_end(ap);
   if (debug)
      printf("(%s) pb1=%s\n", __func__, pb1);

   bool found = false;
   if (value_loc)
      *value_loc = -1;

   int ival = -1;
   char * sval = read_sysfs_attr0(pb1, false);
   if (sval) {
      found = str_to_int(sval, &ival, 10);
      if (!found) {
         char buf[40];
         g_strdup_printf(buf, 40, "Not an integer: %s", sval);
         rpt_attr_output(depth, pb1, ": ", buf);
      }
      else {
         rpt_attr_output(depth, pb1, "=", sval);
         if (value_loc)
            *value_loc = ival;
      }
      free(sval);
   }
   else  {
     rpt_attr_output(depth, pb1, ": ", "Not Found");
  }

  if (debug)
     printf("(%s) Done.\n", __func__);

  return found;
}



/** Reads a binary attribute and reports "Found" or "Not found".
 *
 *  \param  depth      logical indentation depth, if < 0, output nothing
 *  \param  value_loc  if non-NULL, the address at which to return a pointer to
 *                     a GByteArray containing the value. (caller is responsible for freeing).
 *                     If the attribute cannot be read, or is 0 length, NULL is returned.
 *  \param  fn_segment first segment of attribute name
 *  \param  ap         remaining segments of name
 *  \return true if attribute found, false if not
 *
 *  \remark
 *  *value_loc is set iff result is true
 */
bool
rpt_attr_binary(
      int           depth,
      GByteArray ** value_loc,
      const char *  fn_segment,
      ...)
{
   bool debug = false;
   if (debug) {
      printf("(%s) Starting.  depth=%d, value_loc=%p\n", __func__, depth, value_loc);
      if (debug && depth < 0)
         depth=1;
   }

   char pb1[PATH_MAX];
   va_list ap;
   va_start(ap, fn_segment);
   assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
   va_end(ap);

   bool found = false;
   if (value_loc)
      *value_loc = NULL;
   GByteArray * bytes = read_binary_file(pb1, /*estimated size=*/ 256, true);
   if (bytes) {
      if (bytes->len > 0) {
         found = true;
         rpt_attr_output(depth, pb1, ":", "Found");
         // rpt_vstring(depth, "%-*s =  %s", offset, pb1, val);
         if (value_loc)
            *value_loc = bytes;
      }
      else {
         g_byte_array_free(bytes, true);
         rpt_attr_output(depth, pb1, ": ", "0 length");
      }
   }
   else
      rpt_attr_output(depth, pb1, ": ", "Not Found");
   if (debug) {
      if (value_loc)
         printf("(%s) Returning: %s. *value_loc=%p\n", __func__, SBOOL(found), (void*)*value_loc);
      else
         printf("(%s) Returning: %s\n", __func__, SBOOL(found));
   }
   return found;
}


/** Reports a binary attribute that represents an EDID.
 *
 *  \param  depth      logical indentation depth, if < 0, output nothing
 *  \param  value_loc  if non-NULL, the address at which to return a pointer to
 *                     a GByteArray containing the value. (caller is responsible for freeing).
 *                     If the attribute cannot be read NULL is set.
 *  \param  fn_segment first segment of attribute name
 *  \param  ...        remaining segments of name
 *  \return true if attribute found, false if not
 *
 *  \remark
 *  if result == true, *value_loc will be set iff non-null
 */
bool
rpt_attr_edid(
       int           depth,
       GByteArray ** value_loc,
       const char *  fn_segment,
       ...)
 {
    bool debug = false;
    DBGF(debug, "Starting.  depth=%d, value_loc=%p, fn_segment=|%s|", depth, value_loc, fn_segment);
    if (debug) {
       show_backtrace(0);
       if (redirect_reports_to_syslog)
          backtrace_to_syslog(LOG_NOTICE, 0);
    }
    if (debug && depth < 0)
          depth=1;

    char pb1[PATH_MAX];
    va_list ap;
    va_start(ap, fn_segment);
    assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
    va_end(ap);
    // DBGMSG("pb1=%s", pb1);

    bool found = false;
    if (value_loc)
       *value_loc = NULL;
    GByteArray * edid = NULL;
    found = rpt_attr_binary(depth, &edid, pb1, NULL);
    ASSERT_IFF(found, edid);
    if (edid) {
       if (!rpt2_silent && depth >= 0) {
          if (redirect_reports_to_syslog) {
             GPtrArray * collector = g_ptr_array_new_with_free_func(g_free);
             hex_dump_indented_collect(collector, edid->data, edid->len, depth+4);
             for (int ndx = 0; ndx < collector->len; ndx++) {
                syslog(LOG_NOTICE, "%s", (char*) g_ptr_array_index(collector, ndx));
             }
          }
          else
             rpt_hex_dump(edid->data, edid->len, depth+4);
       }
       if (value_loc)
          *value_loc = edid;
       else {
          g_byte_array_free(edid, true);
       }
    }

    if (debug) {
       DBG("Returning %s.", SBOOL(found));
       if (value_loc && *value_loc) {
          GByteArray * gba = *value_loc;
          DBG("               data=%p, len=%d\n", (void*) gba->data, gba->len);
       }
    }

    if (value_loc)
       ASSERT_IFF(found, *value_loc);
    return found;
 }


/** Reports the realpath of a file name, or "Invalid path" if the file name
 *  is invalid.
 *
 *  \param  depth      logical indentation depth, if < 0, output nothing
 *  \param  value_loc  if non-NULL, the address at which to return a pointer to
 *                     the path name (caller is responsible for freeing).
 *                     If the path is invalid, NULL is returned.
 *  \param  fn_segment first segment of attribute name
 *  \param  ...        remaining segments of name
 *  \return true if attribute found, false if not
 *
 *  \remark
 *  *value_loc is set iff result is true
 */
bool
rpt_attr_realpath(
      int          depth,
      char **      value_loc,
      const char * fn_segment,
      ...)
{
   bool debug = false;
   DBGF(debug, "fn_segment=|%s|", fn_segment);
   if (value_loc)
      *value_loc = NULL;
   char pb1[PATH_MAX];

   va_list ap;
   va_start(ap, fn_segment);
   assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
   va_end(ap);

   char * result = realpath(pb1, NULL);
   bool found = (result);
   if (result) {
      rpt_attr_output(depth, pb1, "->", result);
      if (value_loc)
         *value_loc = result;
      else
         free(result);
   }
   else {
      rpt_attr_output(depth, pb1, "->", "Invalid path");
   }

   if (value_loc)
      ASSERT_IFF(found, *value_loc);
   return found;
}


/** Reports the base name of a file name's realpath, or "Invalid path" if the file name
 *  is invalid.
 *
 *  \param  depth      logical indentation depth, if < 0, output nothing
 *  \param  value_loc  if non-NULL, the address at which to return a pointer to
 *                     the name (caller is responsible for freeing).
 *                     If the path is invalid, NULL is returned.
 *  \param  fn_segment first segment of attribute name
 *  \param  ...        remaining segments of name
 *  \return true if attribute found, false if not
 *
 *  \remark
 *  *value_loc is set iff result is true
 */
bool
rpt_attr_realpath_basename(
      int          depth,
      char **      value_loc,
      const char * fn_segment,
      ...)
{
   char pb1[PATH_MAX];
   va_list ap;
   va_start(ap, fn_segment);
   assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
   va_end(ap);

   bool found = false;
   if (value_loc)
      *value_loc = NULL;
   char pb2[PATH_MAX];
   char * rpath = realpath(pb1, pb2);  // without assignment, get warning that return value unused
   if (rpath) {
      char * bpath = basename(rpath);
      if (bpath) {
         found = true;
         rpt_attr_output(depth, pb1, "->", bpath);
         if (value_loc)
            *value_loc = g_strdup(bpath);
      }
   }
   if (!found) {
      rpt_attr_output(depth, pb1, "->", "Invalid path");
   }

   if (value_loc)
      ASSERT_IFF(found, *value_loc);
   return found;
}


/** Checks for the first subdirectory of a given directory whose name satisfies
 *  some predicate, and reports whether it is found and if so its name.
 *
 *  \param  depth      logical indentation depth, if < 0, output nothing
 *  \param  value_loc  if non-NULL, the address at which to return a pointer to
 *                     the name (caller is responsible for freeing).
 *                     If the path is invalid, NULL is returned.
 *  \param  predicate_function pointer to test function
 *  \param  predicate_value    comparison argument passed to test function
 *  \param  fn_segment first segment of attribute name
 *  \param  ...        remaining segments of name
 *  \return true if subdirectory found, false if not
 *
 *  \remark
 *  *value_loc is set iff result is true
 */
bool
rpt_attr_single_subdir(
      int          depth,
      char **      value_loc,
      Fn_Filter    predicate_function,
      const char * predicate_value,
      const char * fn_segment,
      ...)
{
   bool debug = false;
   if (debug)
      printf("(%s) Starting. depth=%d, value_loc=%p\n", __func__, depth, (void*)value_loc);

   char pb1[PATH_MAX];
   va_list ap;
   va_start(ap, fn_segment);
   assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
   va_end(ap);
   if (debug)
      printf("(%s) pb1=|%s|\n", __func__, pb1);

   if (value_loc)
      *value_loc = NULL;
   char * subdir_name = get_single_subdir_name(pb1, predicate_function, predicate_value);
   bool found = false;
   if (subdir_name) {
      char buf[PATH_MAX+100];
      g_snprintf(buf, PATH_MAX+100, "Found subdirectory = %s", subdir_name);
      rpt_attr_output(depth, pb1, ":", buf);
      if (value_loc)
         *value_loc = subdir_name;
      else
         free(subdir_name);
      found = true;
   }
   else {
      char buf[PATH_MAX+100];
      g_snprintf(buf, PATH_MAX+100, "No %s subdirectory found", predicate_value);
      rpt_attr_output(depth, pb1, ":", buf);
   }
   if (debug)
      printf("(%s) Done.    Returning %s\n", __func__, SBOOL(found));

   if (value_loc)
      ASSERT_IFF(found, *value_loc);
   return found;
}


/** Reports whether a subdirectory exists.
 *
 *  \param  depth      logical indentation depth, if < 0, output nothing
 *  \param  value_loc  if non-NULL, *value_loc is always set = NULL
 *  \param  fn_segment first segment of directory name
 *  \param  ...        remaining segments of name (requires at least 1)
 *  \return true if subdirectory found, false if not
 */
bool
rpt_attr_note_subdir(
      int          depth,
      char **      value_loc,
      const char * fn_segment,
      ...)
{
   bool debug = false;
   DBGF(debug, "fn_segment=|%s|", fn_segment);

   char pb1[PATH_MAX];
   va_list ap;
   va_start(ap, fn_segment);
   assemble_sysfs_path2(pb1, PATH_MAX, fn_segment, ap);
   va_end(ap);
   DBGF(debug, "pb1: %s", pb1);

   if (value_loc)
      *value_loc = NULL;

   bool found = directory_exists(pb1);

   if (found)
      rpt_attr_output(depth, pb1, ":", "Subdirectory");
   else
      rpt_attr_output(depth, pb1, ":", "No such subdirectory");

   return found;
}

