gpg: Replace two sprintf calls.
[gnupg.git] / g10 / kbnode.c
index 11b0e46..e814fa8 100644 (file)
@@ -1,43 +1,99 @@
 /* kbnode.c -  keyblock node utility functions
- *     Copyright (C) 1998 Free Software Foundation, Inc.
+ * Copyright (C) 1998, 1999, 2000, 2001, 2002,
+ *               2005, 2010 Free Software Foundation, Inc.
  *
- * This file is part of GNUPG.
+ * This file is part of GnuPG.
  *
- * GNUPG is free software; you can redistribute it and/or modify
+ * GnuPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
- * GNUPG is distributed in the hope that it will be useful,
+ * GnuPG 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 General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <config.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
-#include <assert.h>
+
+#include "gpg.h"
 #include "util.h"
-#include "memory.h"
+#include "../common/init.h"
 #include "packet.h"
 #include "keydb.h"
 
+#define USE_UNUSED_NODES 1
+
+static int cleanup_registered;
+static KBNODE unused_nodes;
+
+static void
+release_unused_nodes (void)
+{
+#if USE_UNUSED_NODES
+  while (unused_nodes)
+    {
+      kbnode_t next = unused_nodes->next;
+      xfree (unused_nodes);
+      unused_nodes = next;
+    }
+#endif /*USE_UNUSED_NODES*/
+}
+
+
+static kbnode_t
+alloc_node (void)
+{
+  kbnode_t n;
+
+  n = unused_nodes;
+  if (n)
+    unused_nodes = n->next;
+  else
+    {
+      if (!cleanup_registered)
+        {
+          cleanup_registered = 1;
+          register_mem_cleanup_func (release_unused_nodes);
+        }
+      n = xmalloc (sizeof *n);
+    }
+  n->next = NULL;
+  n->pkt = NULL;
+  n->flag = 0;
+  n->private_flag=0;
+  n->recno = 0;
+  return n;
+}
+
+static void
+free_node( KBNODE n )
+{
+  if (n)
+    {
+#if USE_UNUSED_NODES
+      n->next = unused_nodes;
+      unused_nodes = n;
+#else
+      xfree (n);
+#endif
+    }
+}
+
 
 
 KBNODE
 new_kbnode( PACKET *pkt )
 {
-    KBNODE n = m_alloc( sizeof *n );
-    n->next = NULL;
+    KBNODE n = alloc_node();
     n->pkt = pkt;
-    n->flag = 0;
-    n->private_flag=0;
     return n;
 }
 
@@ -45,10 +101,9 @@ new_kbnode( PACKET *pkt )
 KBNODE
 clone_kbnode( KBNODE node )
 {
-    KBNODE n = m_alloc( sizeof *n );
-    n->next = NULL;
+    KBNODE n = alloc_node();
+
     n->pkt = node->pkt;
-    n->flag = 0;
     n->private_flag = node->private_flag | 2; /* mark cloned */
     return n;
 }
@@ -61,17 +116,19 @@ release_kbnode( KBNODE n )
 
     while( n ) {
        n2 = n->next;
-       if( !(n->private_flag & 2) )
+       if( !is_cloned_kbnode(n) ) {
            free_packet( n->pkt );
-       m_free( n );
+           xfree( n->pkt );
+       }
+       free_node( n );
        n = n2;
     }
 }
 
 
 /****************
- * Delete NODE from ROOT, ROOT must exist!
- * Note: This does only work with walk_kbnode!!
+ * Delete NODE.
+ * Note: This only works with walk_kbnode!!
  */
 void
 delete_kbnode( KBNODE node )
@@ -79,9 +136,8 @@ delete_kbnode( KBNODE node )
     node->private_flag |= 1;
 }
 
-
 /****************
- * Append NODE to ROOT, ROOT must exist!
+ * Append NODE to ROOT ROOT must exist!
  */
 void
 add_kbnode( KBNODE root, KBNODE node )
@@ -94,7 +150,8 @@ add_kbnode( KBNODE root, KBNODE node )
 }
 
 /****************
- * Insert NODE into the list after root but before a packet with type PKTTYPE
+ * Insert NODE into the list after root but before a packet which is not of
+ * type PKTTYPE
  * (only if PKTTYPE != 0)
  */
 void
@@ -108,7 +165,7 @@ insert_kbnode( KBNODE root, KBNODE node, int pkttype )
        KBNODE n1;
 
        for(n1=root; n1->next;  n1 = n1->next)
-           if( pkttype == n1->next->pkt->pkttype ) {
+           if( pkttype != n1->next->pkt->pkttype ) {
                node->next = n1->next;
                n1->next = node;
                return;
@@ -129,14 +186,15 @@ find_prev_kbnode( KBNODE root, KBNODE node, int pkttype )
 {
     KBNODE n1;
 
-    for(n1=NULL ; root && root != node; root = root->next )
-       if( !pkttype || root->pkt->pkttype == pkttype )
-           n1 = root;
+    for (n1=NULL; root && root != node; root = root->next ) {
+        if (!pkttype ||root->pkt->pkttype == pkttype)
+            n1 = root;
+    }
     return n1;
 }
 
 /****************
- * Ditto, but find the next package.  The behaviour is trivial if
+ * Ditto, but find the next packet.  The behaviour is trivial if
  * PKTTYPE is 0 but if it is specified, the next node with a packet
  * of this type is returned.  The function has some knowledge about
  * the valid ordering of packets: e.g. if the next signature packet
@@ -150,13 +208,13 @@ find_next_kbnode( KBNODE node, int pkttype )
        if( !pkttype )
            return node;
        else if( pkttype == PKT_USER_ID
-                && (   node->pkt->pkttype == PKT_PUBLIC_CERT
-                    || node->pkt->pkttype == PKT_SECRET_CERT ) )
+                && (   node->pkt->pkttype == PKT_PUBLIC_KEY
+                    || node->pkt->pkttype == PKT_SECRET_KEY ) )
            return NULL;
        else if( pkttype == PKT_SIGNATURE
                 && (   node->pkt->pkttype == PKT_USER_ID
-                    || node->pkt->pkttype == PKT_PUBLIC_CERT
-                    || node->pkt->pkttype == PKT_SECRET_CERT ) )
+                    || node->pkt->pkttype == PKT_PUBLIC_KEY
+                    || node->pkt->pkttype == PKT_SECRET_KEY ) )
            return NULL;
        else if( node->pkt->pkttype == pkttype )
            return node;
@@ -178,7 +236,7 @@ find_kbnode( KBNODE node, int pkttype )
 
 
 /****************
- * Walk through a list of kbnodes. This functions returns
+ * Walk through a list of kbnodes. This function returns
  * the next kbnode for each call; before using the function the first
  * time, the caller must set CONTEXT to NULL (This has simply the effect
  * to start with ROOT).
@@ -197,7 +255,7 @@ walk_kbnode( KBNODE root, KBNODE *context, int all )
            n = (*context)->next;
            *context = n;
        }
-    } while( !all && n && (n->private_flag & 1) );
+    } while( !all && n && is_deleted_kbnode(n) );
 
     return n;
 }
@@ -213,9 +271,9 @@ clear_kbnode_flags( KBNODE n )
 
 /****************
  * Commit changes made to the kblist at ROOT. Note that ROOT my change,
- * and it is therefor passed by reference.
+ * and it is therefore passed by reference.
  * The function has the effect of removing all nodes marked as deleted.
- * returns true, if any node has been changed
+ * returns true if any node has been changed
  */
 int
 commit_kbnode( KBNODE *root )
@@ -224,14 +282,16 @@ commit_kbnode( KBNODE *root )
     int changed = 0;
 
     for( n = *root, nl=NULL; n; n = nl->next ) {
-       if( (n->private_flag & 1) ) {
+       if( is_deleted_kbnode(n) ) {
            if( n == *root )
                *root = nl = n->next;
            else
                nl->next = n->next;
-           if( !(n->private_flag & 2) )
+           if( !is_cloned_kbnode(n) ) {
                free_packet( n->pkt );
-           m_free( n );
+               xfree( n->pkt );
+           }
+           free_node( n );
            changed = 1;
        }
        else
@@ -240,47 +300,132 @@ commit_kbnode( KBNODE *root )
     return changed;
 }
 
-
 void
-dump_kbnode( KBNODE node )
+remove_kbnode( KBNODE *root, KBNODE node )
 {
-    for(; node; node = node->next ) {
-       const char *s;
-       switch( node->pkt->pkttype ) {
-         case 0:               s="empty"; break;
-         case PKT_PUBLIC_CERT: s="public-key"; break;
-         case PKT_SECRET_CERT: s="secret-key"; break;
-         case PKT_SECKEY_SUBCERT:  s= "secret-subkey"; break;
-         case PKT_PUBKEY_ENC:  s="public-enc"; break;
-         case PKT_SIGNATURE:   s="signature"; break;
-         case PKT_ONEPASS_SIG: s="onepass-sig"; break;
-         case PKT_USER_ID:     s="user-id"; break;
-         case PKT_PUBKEY_SUBCERT: s="public-subkey"; break;
-         case PKT_COMMENT:     s="comment"; break;
-         case PKT_RING_TRUST:  s="trust"; break;
-         case PKT_PLAINTEXT:   s="plaintext"; break;
-         case PKT_COMPRESSED:  s="compressed"; break;
-         case PKT_ENCRYPTED:   s="encrypted"; break;
-         default:              s="unknown"; break;
-       }
-       fprintf(stderr, "node %p %02x/%02x type=%s",
-               node, node->flag, node->private_flag, s);
-       if( node->pkt->pkttype == PKT_USER_ID ) {
-           fputs("  \"", stderr);
-           print_string( stderr, node->pkt->pkt.user_id->name,
-                                 node->pkt->pkt.user_id->len, 0 );
-           fputs("\"\n", stderr);
-       }
-       else if( node->pkt->pkttype == PKT_SIGNATURE ) {
-           fprintf(stderr, "  keyid=%08lX\n",
-                  (ulong)node->pkt->pkt.signature->keyid[1] );
-       }
-       else if( node->pkt->pkttype == PKT_PUBLIC_CERT ) {
-           fprintf(stderr, "  keyid=%08lX\n", (ulong)
-                 keyid_from_pkc( node->pkt->pkt.public_cert, NULL ));
+    KBNODE n, nl;
+
+    for( n = *root, nl=NULL; n; n = nl->next ) {
+       if( n == node ) {
+           if( n == *root )
+               *root = nl = n->next;
+           else
+               nl->next = n->next;
+           if( !is_cloned_kbnode(n) ) {
+               free_packet( n->pkt );
+               xfree( n->pkt );
+           }
+           free_node( n );
        }
        else
-           fputs("\n", stderr);
+           nl = n;
+    }
+}
+
+
+/****************
+ * Move NODE behind right after WHERE or to the beginning if WHERE is NULL.
+ */
+void
+move_kbnode( KBNODE *root, KBNODE node, KBNODE where )
+{
+    KBNODE tmp, prev;
+
+    if( !root || !*root || !node )
+       return;  /* sanity check */
+    for( prev = *root; prev && prev->next != node; prev = prev->next )
+       ;
+    if( !prev )
+       return; /* node is not in the list */
+
+    if( !where ) {  /* move node before root */
+       if( node == *root ) /* move to itself */
+           return;
+       prev->next = node->next;
+       node->next = *root;
+       *root = node;
+       return;
     }
+    /* move it after where */
+    if( node == where )
+       return;
+    tmp = node->next;
+    node->next = where->next;
+    where->next = node;
+    prev->next = tmp;
 }
 
+
+
+
+void
+dump_kbnode (KBNODE node)
+{
+  for (; node; node = node->next )
+    {
+      const char *s;
+      switch (node->pkt->pkttype)
+        {
+        case 0:                s="empty"; break;
+        case PKT_PUBLIC_KEY:   s="public-key"; break;
+        case PKT_SECRET_KEY:   s="secret-key"; break;
+        case PKT_SECRET_SUBKEY: s= "secret-subkey"; break;
+        case PKT_PUBKEY_ENC:   s="public-enc"; break;
+        case PKT_SIGNATURE:    s="signature"; break;
+        case PKT_ONEPASS_SIG: s="onepass-sig"; break;
+        case PKT_USER_ID:      s="user-id"; break;
+        case PKT_PUBLIC_SUBKEY: s="public-subkey"; break;
+        case PKT_COMMENT:      s="comment"; break;
+        case PKT_RING_TRUST:   s="trust"; break;
+        case PKT_PLAINTEXT:    s="plaintext"; break;
+        case PKT_COMPRESSED:   s="compressed"; break;
+        case PKT_ENCRYPTED:    s="encrypted"; break;
+        case PKT_GPG_CONTROL: s="gpg-control"; break;
+        default:               s="unknown"; break;
+       }
+      log_debug ("node %p %02x/%02x type=%s",
+                 node, node->flag, node->private_flag, s);
+      if (node->pkt->pkttype == PKT_USER_ID)
+        {
+          PKT_user_id *uid = node->pkt->pkt.user_id;
+          log_printf ("  \"");
+          es_write_sanitized (log_get_stream (), uid->name, uid->len,
+                              NULL, NULL);
+          log_printf ("\" %c%c%c%c\n",
+                      uid->is_expired? 'e':'.',
+                      uid->is_revoked? 'r':'.',
+                      uid->created?    'v':'.',
+                      uid->is_primary? 'p':'.' );
+        }
+      else if (node->pkt->pkttype == PKT_SIGNATURE)
+        {
+          log_printf ("  class=%02x keyid=%08lX ts=%lu\n",
+                      node->pkt->pkt.signature->sig_class,
+                      (ulong)node->pkt->pkt.signature->keyid[1],
+                      (ulong)node->pkt->pkt.signature->timestamp);
+        }
+      else if (node->pkt->pkttype == PKT_GPG_CONTROL)
+        {
+          log_printf (" ctrl=%d len=%u\n",
+                      node->pkt->pkt.gpg_control->control,
+                      (unsigned int)node->pkt->pkt.gpg_control->datalen);
+        }
+      else if (node->pkt->pkttype == PKT_PUBLIC_KEY
+               || node->pkt->pkttype == PKT_PUBLIC_SUBKEY)
+        {
+          PKT_public_key *pk = node->pkt->pkt.public_key;
+
+          log_printf ("  keyid=%08lX a=%d u=%d %c%c%c%c\n",
+                      (ulong)keyid_from_pk( pk, NULL ),
+                      pk->pubkey_algo, pk->pubkey_usage,
+                      pk->has_expired? 'e':'.',
+                      pk->flags.revoked? 'r':'.',
+                      pk->flags.valid?    'v':'.',
+                      pk->flags.mdc?   'm':'.');
+        }
+      else
+        log_printf ("\n");
+
+      log_flush ();
+    }
+}