messenger_api_list_tunnels.c

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2020--2024 GNUnet e.V.
 
   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   or (at your option) any later version.
 
   GNUnet is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Affero General Public License for more details.
 
   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
   SPDX-License-Identifier: AGPL3.0-or-later
 */
#include "messenger_api_list_tunnels.h"
 
void
init_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels)
{
  GNUNET_assert (tunnels);
 
  tunnels->head = NULL;
  tunnels->tail = NULL;
}
 
 
void
clear_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels)
{
  GNUNET_assert (tunnels);
 
  struct GNUNET_MESSENGER_ListTunnel *element;
  for (element = tunnels->head; element;
       element = remove_from_list_tunnels (tunnels, element))
 
    tunnels->head = NULL;
  tunnels->tail = NULL;
}
 
 
static int
compare_list_tunnels (void *cls,
                      struct GNUNET_MESSENGER_ListTunnel *element0,
                      struct GNUNET_MESSENGER_ListTunnel *element1)
{
  struct GNUNET_PeerIdentity peer0, peer1;
 
  GNUNET_PEER_resolve (element0->peer, &peer0);
  GNUNET_PEER_resolve (element1->peer, &peer1);
 
  return GNUNET_memcmp (&peer0, &peer1);
}
 
 
void
add_to_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                     const struct GNUNET_PeerIdentity *peer,
                     const struct GNUNET_HashCode *hash)
{
  GNUNET_assert ((tunnels) && (peer));
 
  struct GNUNET_MESSENGER_ListTunnel *element = GNUNET_new (struct
                                                            GNUNET_MESSENGER_ListTunnel);
 
  element->peer = GNUNET_PEER_intern (peer);
  element->hash = hash ? GNUNET_memdup (hash, sizeof (struct GNUNET_HashCode)) :
                  NULL;
 
  memset (&(element->connection), 0, sizeof (element->connection));
 
  GNUNET_CONTAINER_DLL_insert_sorted (struct GNUNET_MESSENGER_ListTunnel,
                                      compare_list_tunnels, NULL, tunnels->head,
                                      tunnels->tail, element);
}
 
 
struct GNUNET_MESSENGER_ListTunnel*
find_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                   const struct GNUNET_PeerIdentity *peer,
                   size_t *index)
{
  GNUNET_assert ((tunnels) && (peer));
 
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;
 
  if (index)
    *index = 0;
 
  for (element = tunnels->head; element; element = element->next)
  {
    GNUNET_PEER_resolve (element->peer, &pid);
 
    if (0 == GNUNET_memcmp (&pid, peer))
      return element;
 
    if (index)
      (*index) = (*index) + 1;
  }
 
  return NULL;
}
 
 
struct GNUNET_MESSENGER_ListTunnel*
find_list_tunnels_alternate (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                             const struct GNUNET_PeerIdentity *peer)
{
  GNUNET_assert ((tunnels) && (peer));
 
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;
 
  for (element = tunnels->head; element; element = element->next)
  {
    GNUNET_PEER_resolve (element->peer, &pid);
 
    if (0 != GNUNET_memcmp (&pid, peer))
      return element;
  }
 
  return NULL;
}
 
 
enum GNUNET_GenericReturnValue
verify_list_tunnels_flag_token (const struct
                                GNUNET_MESSENGER_ListTunnels *tunnels,
                                const struct GNUNET_PeerIdentity *peer,
                                enum GNUNET_MESSENGER_ConnectionFlags flag)
{
  GNUNET_assert ((tunnels) && (peer) && (flag));
 
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;
 
  for (element = tunnels->head; element; element = element->next)
  {
    if ((element->connection.flags & flag) != flag)
      continue;
 
    GNUNET_PEER_resolve (element->peer, &pid);
 
    if (0 == GNUNET_memcmp (&pid, peer))
      return GNUNET_OK;
  }
 
  return GNUNET_SYSERR;
}
 
 
void
update_to_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                        const struct GNUNET_PeerIdentity *peer,
                        const struct GNUNET_HashCode *hash)
{
  GNUNET_assert ((tunnels) && (peer));
 
  struct GNUNET_MESSENGER_ListTunnel *element = find_list_tunnels (tunnels,
                                                                   peer,
                                                                   NULL);
  if (! element)
    return;
 
  if (element->hash)
  {
    if (hash)
      GNUNET_memcpy (element->hash, hash, sizeof(struct GNUNET_HashCode));
    else
    {
      GNUNET_free (element->hash);
      element->hash = NULL;
    }
  }
  else if (hash)
    element->hash = GNUNET_memdup (hash, sizeof(struct GNUNET_HashCode));
}
 
 
enum GNUNET_GenericReturnValue
contains_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                       const struct GNUNET_PeerIdentity *peer)
{
  GNUNET_assert ((tunnels) && (peer));
 
  return find_list_tunnels (tunnels, peer, NULL) != NULL ? GNUNET_YES :
         GNUNET_NO;
}
 
 
struct GNUNET_MESSENGER_ListTunnel*
remove_from_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                          struct GNUNET_MESSENGER_ListTunnel *element)
{
  GNUNET_assert ((tunnels) && (element));
 
  struct GNUNET_MESSENGER_ListTunnel *next = element->next;
 
  if ((tunnels->head) && (tunnels->tail))
    GNUNET_CONTAINER_DLL_remove (tunnels->head, tunnels->tail, element);
 
  if (element->hash)
    GNUNET_free (element->hash);
 
  GNUNET_PEER_change_rc (element->peer, -1);
  GNUNET_free (element);
 
  return next;
}
 
 
void
load_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                   const char *path)
{
  GNUNET_assert ((tunnels) && (path));
 
  if (GNUNET_YES != GNUNET_DISK_file_test (path))
    return;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Load list of tunnels from path: %s\n",
              path);
 
  enum GNUNET_DISK_AccessPermissions permission = (GNUNET_DISK_PERM_USER_READ
                                                   | GNUNET_DISK_PERM_USER_WRITE);
 
  struct GNUNET_DISK_FileHandle *handle = GNUNET_DISK_file_open (
    path, GNUNET_DISK_OPEN_READ, permission
    );
 
  if (! handle)
    return;
 
  GNUNET_DISK_file_seek (handle, 0, GNUNET_DISK_SEEK_SET);
 
  struct GNUNET_PeerIdentity peer;
  ssize_t len;
 
  do {
    len = GNUNET_DISK_file_read (handle, &peer, sizeof(peer));
 
    if (len != sizeof(peer))
      break;
 
    add_to_list_tunnels (tunnels, &peer, NULL);
  } while (len == sizeof(peer));
 
  GNUNET_DISK_file_close (handle);
}
 
 
void
save_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels,
                   const char *path)
{
  GNUNET_assert ((tunnels) && (path));
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Save list of tunnels to path: %s\n",
              path);
 
  enum GNUNET_DISK_AccessPermissions permission = (GNUNET_DISK_PERM_USER_READ
                                                   | GNUNET_DISK_PERM_USER_WRITE);
 
  struct GNUNET_DISK_FileHandle *handle = GNUNET_DISK_file_open (
    path, GNUNET_DISK_OPEN_CREATE | GNUNET_DISK_OPEN_WRITE, permission
    );
 
  if (! handle)
    return;
 
  GNUNET_DISK_file_seek (handle, 0, GNUNET_DISK_SEEK_SET);
 
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;
 
  for (element = tunnels->head; element; element = element->next)
  {
    GNUNET_PEER_resolve (element->peer, &pid);
 
    GNUNET_DISK_file_write (handle, &pid, sizeof(pid));
  }
 
  GNUNET_DISK_file_sync (handle);
  GNUNET_DISK_file_close (handle);
}