nasl_isotime.h File Reference

Protos and data structures for ISOTIME functions used by NASL scripts. More...

#include "nasl_lex_ctxt.h"

Include dependency graph for nasl_isotime.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
tree_cell *	nasl_isotime_now (lex_ctxt *lexic)
	Return the current time in ISO format. More...
tree_cell *	nasl_isotime_is_valid (lex_ctxt *lexic)
	Check whether an ISO time string is valid. More...
tree_cell *	nasl_isotime_scan (lex_ctxt *lexic)
	Convert a string into an ISO time string. More...
tree_cell *	nasl_isotime_print (lex_ctxt *lexic)
	Convert an SIO time string into a better readable string. More...
tree_cell *	nasl_isotime_add (lex_ctxt *lexic)
	Add days or seconds to an ISO time string. More...

Detailed Description

Protos and data structures for ISOTIME functions used by NASL scripts.

This file contains the protos for nasl_isotime.c

Definition in file nasl_isotime.h.

Function Documentation

nasl_isotime_add()

tree_cell* nasl_isotime_add

(

lex_ctxt *

lexic

)

Add days or seconds to an ISO time string.

NASL Function: isotime_add\n

This function adds days or seconds to an ISO time string and returns the resulting time string. The number of days or seconds are given using the named parameters; if none are given nothing is added; if both are given both additions are performed. This function won't work for dates before the Gregorian calendar switch.

NASL Unnamed Parameters:\n

• An ISO time string

NASL Named Parameters:\n

• years An integer with the number of years to add to the timestamp.
• days An integer with the number of days to add to the timestamp.
• seconds An integer with the number of seconds to add to the timestamp.

NASL Returns:\n The resulting ISO time string or NULL if the provided ISO

time string is not valid or the result would overflow (i.e. year > 9999).

Parameters

[in]

lexic

Lexical context of the NASL interpreter.

Returns

A tree cell.

Definition at line 727 of file nasl_isotime.c.

{
  tree_cell *retc;
  my_isotime_t timebuf;
  const char *string;
  int nyears, ndays, nseconds;
 
  string = get_str_var_by_num (lexic, 0);
  if (!string || get_var_size_by_num (lexic, 0) < ISOTIME_SIZE - 1
      || check_isotime (string))
    return NULL;
  memcpy (timebuf, string, ISOTIME_SIZE - 1);
  timebuf[ISOTIME_SIZE - 1] = 0;
 
  nyears = get_int_var_by_name (lexic, "years", 0);
  ndays = get_int_var_by_name (lexic, "days", 0);
  nseconds = get_int_var_by_name (lexic, "seconds", 0);
 
  if (nyears && add_years_to_isotime (timebuf, nyears))
    return NULL;
  if (ndays && add_days_to_isotime (timebuf, ndays))
    return NULL;
  if (nseconds && add_seconds_to_isotime (timebuf, nseconds))
    return NULL;
  /* If nothing was added, explicitly add 0 years.  */
  if (!nyears && !ndays && !nseconds && add_years_to_isotime (timebuf, 0))
    return NULL;
 
  retc = alloc_typed_cell (CONST_STR);
  retc->x.str_val = g_strdup (timebuf);
  retc->size = strlen (timebuf);
  return retc;
}

References add_days_to_isotime(), add_seconds_to_isotime(), add_years_to_isotime(), alloc_typed_cell(), check_isotime(), CONST_STR, get_int_var_by_name(), get_str_var_by_num(), get_var_size_by_num(), ISOTIME_SIZE, TC::size, TC::str_val, and TC::x.

Here is the call graph for this function:

nasl_isotime_is_valid()

tree_cell* nasl_isotime_is_valid

(

lex_ctxt *

lexic

)

Check whether an ISO time string is valid.

NASL Function: isotime_is_valid\n

NASL Unnamed Parameters:\n

• A string. Both, the standard 15 byte string and the better human readable up to 19 byte format are accepted here. If a plain data type is is provided only the 15 byte format is accepted.

NASL Returns:\n True is this is an ISO string; false if not.

Parameters

[in]

lexic

Lexical context of the NASL interpreter.

Returns

A tree cell.

Definition at line 575 of file nasl_isotime.c.

{
  int result = 0;
  tree_cell *retc;
  my_isotime_t timebuf;
  const char *string;
  int datalen;
 
  string = get_str_var_by_num (lexic, 0);
  if (string)
    {
      switch (get_var_type_by_num (lexic, 0))
        {
        case VAR2_DATA:
          datalen = get_var_size_by_num (lexic, 0);
          if (datalen < ISOTIME_SIZE - 1)
            break; /* Too short */
          memcpy (timebuf, string, ISOTIME_SIZE - 1);
          timebuf[ISOTIME_SIZE - 1] = 0;
          string = timebuf;
          /* FALLTHRU */
        case VAR2_STRING:
          if (isotime_p (string) || isotime_human_p (string))
            result = 1;
          break;
        default:
          break;
        }
    }
 
  retc = alloc_typed_cell (CONST_INT);
  retc->x.i_val = result;
  return retc;
}

References alloc_typed_cell(), CONST_INT, get_str_var_by_num(), get_var_size_by_num(), get_var_type_by_num(), TC::i_val, isotime_human_p(), isotime_p(), ISOTIME_SIZE, VAR2_DATA, VAR2_STRING, and TC::x.

Here is the call graph for this function:

nasl_isotime_now()

tree_cell* nasl_isotime_now

(

lex_ctxt *

lexic

)

Return the current time in ISO format.

NASL Function: isotime_now\n

NASL Unnamed Parameters:\n

• None

NASL Returns:\n A string with the ISO time. If the current time is not

available an empty string is returned.

Parameters

[in]

lexic

Lexical context of the NASL interpreter.

Returns

A tree cell.

Definition at line 543 of file nasl_isotime.c.

{
  tree_cell *retc;
  my_isotime_t timebuf;
 
  (void) lexic;
  get_current_isotime (timebuf);
 
  retc = alloc_typed_cell (CONST_STR);
  retc->x.str_val = g_strdup (timebuf);
  retc->size = strlen (timebuf);
  return retc;
}

References alloc_typed_cell(), CONST_STR, get_current_isotime(), TC::size, TC::str_val, and TC::x.

Here is the call graph for this function:

nasl_isotime_print()

tree_cell* nasl_isotime_print

(

lex_ctxt *

lexic

)

Convert an SIO time string into a better readable string.

NASL Function: isotime_print\n

NASL Unnamed Parameters:\n

• An ISO time string.

NASL Returns:\n A string in the format "YYYY-MM-DD HH:MM:SS" or "[none]"

if the provided time string is not valid.

Parameters

[in]

lexic

Lexical context of the NASL interpreter.

Returns

A tree cell.

Definition at line 677 of file nasl_isotime.c.

{
  tree_cell *retc;
  const char *string;
  char helpbuf[20];
 
  string = get_str_var_by_num (lexic, 0);
  if (!string || get_var_size_by_num (lexic, 0) < 15 || check_isotime (string))
    strcpy (helpbuf, "[none]");
  else
    snprintf (helpbuf, sizeof helpbuf, "%.4s-%.2s-%.2s %.2s:%.2s:%.2s", string,
              string + 4, string + 6, string + 9, string + 11, string + 13);
  retc = alloc_typed_cell (CONST_STR);
  retc->x.str_val = g_strdup (helpbuf);
  retc->size = strlen (helpbuf);
  return retc;
}

References alloc_typed_cell(), check_isotime(), CONST_STR, get_str_var_by_num(), get_var_size_by_num(), TC::size, TC::str_val, and TC::x.

Here is the call graph for this function:

nasl_isotime_scan()

tree_cell* nasl_isotime_scan

(

lex_ctxt *

lexic

)

Convert a string into an ISO time string.

NASL Function: isotime_scan\n

NASL Unnamed Parameters:\n

• A string

NASL Returns:\n A ISO time string on success or NULL on error.

Parameters

[in]

lexic

Lexical context of the NASL interpreter.

Returns

A tree cell.

Definition at line 626 of file nasl_isotime.c.

{
  tree_cell *retc;
  my_isotime_t timebuf;
  int datalen;
  const char *string;
 
  *timebuf = 0;
  string = get_str_var_by_num (lexic, 0);
  if (!string)
    return NULL;
  switch (get_var_type_by_num (lexic, 0))
    {
    case VAR2_DATA:
      datalen = get_var_size_by_num (lexic, 0);
      if (datalen < ISOTIME_SIZE - 1)
        return NULL; /* Too short */
      memcpy (timebuf, string, ISOTIME_SIZE - 1);
      timebuf[ISOTIME_SIZE - 1] = 0;
      string = timebuf;
      /* FALLTHRU */
    case VAR2_STRING:
      if (!string2isotime (timebuf, string))
        return NULL;
      break;
    default:
      return NULL;
    }
 
  retc = alloc_typed_cell (CONST_STR);
  retc->x.str_val = g_strdup (timebuf);
  retc->size = strlen (timebuf);
  return retc;
}

References alloc_typed_cell(), CONST_STR, get_str_var_by_num(), get_var_size_by_num(), get_var_type_by_num(), ISOTIME_SIZE, TC::size, TC::str_val, string2isotime(), VAR2_DATA, VAR2_STRING, and TC::x.

Here is the call graph for this function: