iterator.h File Reference

#include "lsc_crypt.h"
#include <glib.h>

Include dependency graph for iterator.h:

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

Go to the source code of this file.

Data Structures
struct	iterator
	A generic SQL iterator. More...

Typedefs
typedef long long int	resource_t
	A resource, like a task or target. More...
typedef struct sql_stmt	sql_stmt_t
	A prepared SQL statement. More...
typedef struct iterator	iterator_t

Functions
void	cleanup_iterator (iterator_t *)
	Cleanup an iterator. More...
gboolean	next (iterator_t *)
	Increment an iterator. More...

Typedef Documentation

typedef struct iterator iterator_t

Definition at line 60 of file iterator.h.

typedef long long int resource_t

A resource, like a task or target.

Definition at line 42 of file iterator.h.

typedef struct sql_stmt sql_stmt_t

A prepared SQL statement.

Definition at line 47 of file iterator.h.

Function Documentation

void cleanup_iterator

(

iterator_t *

iterator

)

Cleanup an iterator.

Parameters

[in]

iterator

Iterator.

Definition at line 664 of file sql.c.

Referenced by acl_users_with_access_sql(), auto_delete_reports(), buffer_results_xml(), check_db_sequences(), check_generate_scripts(), cleanup_task_schedule_iterator(), create_asset_report(), create_target(), delete_report_format(), delete_reports(), delete_user(), get_nvti_xml(), get_ovaldi_files(), host_routes_xml(), manage_complete_nvt_cache_update(), manage_empty_trashcan(), manage_get_scanners(), manage_get_users(), manage_read_info(), manage_report(), manage_restore(), manage_set_config_families(), manage_set_config_nvts(), migrate_122_to_123(), migrate_12_to_13(), migrate_143_to_144(), migrate_153_to_154(), migrate_156_to_157(), migrate_158_to_159(), migrate_160_to_161(), migrate_165_to_166(), migrate_168_to_169(), migrate_16_to_17(), migrate_19_to_20(), migrate_1_to_2(), migrate_21_to_22(), migrate_24_to_25(), migrate_35_to_36(), migrate_3_to_4(), migrate_4_to_5_copy_data(), migrate_55_to_56(), migrate_9_to_10(), modify_credential(), modify_schedule(), nvt_selector_nvt_count(), ovaldef_cves(), refresh_nvt_cves(), report_add_result(), report_cache_counts(), report_severity(), reports_add_all(), reports_add_for_override(), reports_build_count_cache(), run_otp_task(), schedule_info(), sql_rename_column(), stop_active_tasks(), target_port_range(), task_observers(), update_config_cache_init(), user_resources_in_use(), verify_agent(), and verify_scanner().

{
  if (iterator == NULL)
    {
      g_warning ("%s: null iterator pointer.\n", __FUNCTION__);
      return;
    }

  if (iterator->prepared == 0)
    sql_finalize (iterator->stmt);
  if (iterator->crypt_ctx)
    {
      lsc_crypt_release (iterator->crypt_ctx);
      iterator->crypt_ctx = NULL;
    }
}

Here is the caller graph for this function:

gboolean next

(

iterator_t *

iterator

)

Increment an iterator.

Parameters

[in]

iterator

Iterator.

Returns

TRUE if there was a next item, else FALSE.

Definition at line 689 of file sql.c.

Referenced by acl_users_with_access_sql(), buffer_aggregate_wc_xml(), buffer_aggregate_xml(), buffer_results_xml(), check_db_sequences(), get_nvti_xml(), get_ovaldi_files(), manage_read_info(), manage_schedule(), migrate_122_to_123(), migrate_12_to_13(), migrate_138_to_139(), migrate_143_to_144(), migrate_153_to_154(), migrate_156_to_157(), migrate_158_to_159(), migrate_160_to_161(), migrate_165_to_166(), migrate_168_to_169(), migrate_16_to_17(), migrate_19_to_20(), migrate_1_to_2(), migrate_21_to_22(), migrate_24_to_25(), migrate_35_to_36(), migrate_3_to_4(), migrate_4_to_5_copy_data(), migrate_55_to_56(), migrate_9_to_10(), modify_schedule(), run_otp_task(), and sql_rename_column().

{
  int ret;

  if (iterator->done) return FALSE;

  lsc_crypt_flush (iterator->crypt_ctx);
  while (1)
    {
      ret = sql_exec_internal (1, iterator->stmt);
      if (ret == 0)
        {
          iterator->done = TRUE;
          return FALSE;
        }
      if (ret == -1)
        {
          if (log_errors)
            g_warning ("%s: sql_exec_internal failed\n", __FUNCTION__);
          abort ();
        }
      if (ret == -2)
        {
          /* Busy or locked, with statement reset.  Just try step again like
           * we used to do in sql_exec_internal.  We're not supposed to do this
           * for SQLite, but it would mean quite a bit of reworking in the
           * callers to be able to handle this case. */
          g_warning ("%s: stepping after reset\n", __FUNCTION__);
          continue;
        }
      if (ret == 2)
        {
          /* Schema changed, for example an internal change due to a VACUUM.
           * Retrying will result in the same error, so abort.  We lock
           * exclusively around the VACUUM in --optimize, so hopefully when
           * using --optimize the schema error will happen earlier, in the
           * the init function for the iterator.
           *
           * This only applies to SQLite3. */
          g_warning ("%s: schema error.\n"
                     "  This is possibly due to running VACUUM while Manager\n"
                     "  is running.  Restart Manager.  In future use\n"
                     "  --optimize=vacuum instead of running VACUUM"
                     "  directly.\n",
                     __FUNCTION__);
          abort ();
        }
      break;
    }
  assert (ret == 1);
  return TRUE;
}

Here is the caller graph for this function: