See ChangeLog: Sat May 22 22:47:26 CEST 1999 Werner Koch
[gnupg.git] / g10 / kbnode.c
1 /* kbnode.c -  keyblock node utility functions
2  *      Copyright (C) 1998 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26 #include "util.h"
27 #include "memory.h"
28 #include "packet.h"
29 #include "keydb.h"
30
31 #define USE_UNUSED_NODES 1
32
33 static KBNODE unused_nodes;
34
35 static KBNODE
36 alloc_node(void)
37 {
38     KBNODE n;
39
40     n = unused_nodes;
41     if( n )
42         unused_nodes = n->next;
43     else
44         n = m_alloc( sizeof *n );
45     n->next = NULL;
46     n->pkt = NULL;
47     n->flag = 0;
48     n->private_flag=0;
49     n->recno = 0;
50     return n;
51 }
52
53 static void
54 free_node( KBNODE n )
55 {
56     if( n ) {
57       #if USE_UNUSED_NODES
58         n->next = unused_nodes;
59         unused_nodes = n;
60       #else
61         m_free( n );
62       #endif
63     }
64 }
65
66
67
68 KBNODE
69 new_kbnode( PACKET *pkt )
70 {
71     KBNODE n = alloc_node();
72     n->pkt = pkt;
73     return n;
74 }
75
76
77 KBNODE
78 clone_kbnode( KBNODE node )
79 {
80     KBNODE n = alloc_node();
81
82     n->pkt = node->pkt;
83     n->private_flag = node->private_flag | 2; /* mark cloned */
84     return n;
85 }
86
87
88 void
89 release_kbnode( KBNODE n )
90 {
91     KBNODE n2;
92
93     while( n ) {
94         n2 = n->next;
95         if( !is_cloned_kbnode(n) ) {
96             free_packet( n->pkt );
97             m_free( n->pkt );
98         }
99         free_node( n );
100         n = n2;
101     }
102 }
103
104
105 /****************
106  * Delete NODE.
107  * Note: This only works with walk_kbnode!!
108  */
109 void
110 delete_kbnode( KBNODE node )
111 {
112     node->private_flag |= 1;
113 }
114
115
116
117 /****************
118  * Append NODE to ROOT.  ROOT must exist!
119  */
120 void
121 add_kbnode( KBNODE root, KBNODE node )
122 {
123     KBNODE n1;
124
125     for(n1=root; n1->next; n1 = n1->next)
126         ;
127     n1->next = node;
128 }
129
130 /****************
131  * Insert NODE into the list after root but before a packet which is not of
132  * type PKTTYPE
133  * (only if PKTTYPE != 0)
134  */
135 void
136 insert_kbnode( KBNODE root, KBNODE node, int pkttype )
137 {
138     if( !pkttype ) {
139         node->next = root->next;
140         root->next = node;
141     }
142     else {
143         KBNODE n1;
144
145         for(n1=root; n1->next;  n1 = n1->next)
146             if( pkttype != n1->next->pkt->pkttype ) {
147                 node->next = n1->next;
148                 n1->next = node;
149                 return;
150             }
151         /* no such packet, append */
152         node->next = NULL;
153         n1->next = node;
154     }
155 }
156
157
158 /****************
159  * Find the previous node (if PKTTYPE = 0) or the previous node
160  * with pkttype PKTTYPE in the list starting with ROOT of NODE.
161  */
162 KBNODE
163 find_prev_kbnode( KBNODE root, KBNODE node, int pkttype )
164 {
165     KBNODE n1;
166
167     for(n1=NULL ; root && root != node; root = root->next )
168         if( !pkttype || root->pkt->pkttype == pkttype )
169             n1 = root;
170     return n1;
171 }
172
173 /****************
174  * Ditto, but find the next packet.  The behaviour is trivial if
175  * PKTTYPE is 0 but if it is specified, the next node with a packet
176  * of this type is returned.  The function has some knowledge about
177  * the valid ordering of packets: e.g. if the next signature packet
178  * is requested, the function will not return one if it encounters
179  * a user-id.
180  */
181 KBNODE
182 find_next_kbnode( KBNODE node, int pkttype )
183 {
184     for( node=node->next ; node; node = node->next ) {
185         if( !pkttype )
186             return node;
187         else if( pkttype == PKT_USER_ID
188                  && (   node->pkt->pkttype == PKT_PUBLIC_KEY
189                      || node->pkt->pkttype == PKT_SECRET_KEY ) )
190             return NULL;
191         else if( pkttype == PKT_SIGNATURE
192                  && (   node->pkt->pkttype == PKT_USER_ID
193                      || node->pkt->pkttype == PKT_PUBLIC_KEY
194                      || node->pkt->pkttype == PKT_SECRET_KEY ) )
195             return NULL;
196         else if( node->pkt->pkttype == pkttype )
197             return node;
198     }
199     return NULL;
200 }
201
202
203 KBNODE
204 find_kbnode( KBNODE node, int pkttype )
205 {
206     for( ; node; node = node->next ) {
207         if( node->pkt->pkttype == pkttype )
208             return node;
209     }
210     return NULL;
211 }
212
213
214
215 /****************
216  * Walk through a list of kbnodes. This function returns
217  * the next kbnode for each call; before using the function the first
218  * time, the caller must set CONTEXT to NULL (This has simply the effect
219  * to start with ROOT).
220  */
221 KBNODE
222 walk_kbnode( KBNODE root, KBNODE *context, int all )
223 {
224     KBNODE n;
225
226     do {
227         if( !*context ) {
228             *context = root;
229             n = root;
230         }
231         else {
232             n = (*context)->next;
233             *context = n;
234         }
235     } while( !all && n && is_deleted_kbnode(n) );
236
237     return n;
238 }
239
240 void
241 clear_kbnode_flags( KBNODE n )
242 {
243     for( ; n; n = n->next ) {
244         n->flag = 0;
245     }
246 }
247
248
249 /****************
250  * Commit changes made to the kblist at ROOT. Note that ROOT my change,
251  * and it is therefore passed by reference.
252  * The function has the effect of removing all nodes marked as deleted.
253  * returns true if any node has been changed
254  */
255 int
256 commit_kbnode( KBNODE *root )
257 {
258     KBNODE n, nl;
259     int changed = 0;
260
261     for( n = *root, nl=NULL; n; n = nl->next ) {
262         if( is_deleted_kbnode(n) ) {
263             if( n == *root )
264                 *root = nl = n->next;
265             else
266                 nl->next = n->next;
267             if( !is_cloned_kbnode(n) ) {
268                 free_packet( n->pkt );
269                 m_free( n->pkt );
270             }
271             free_node( n );
272             changed = 1;
273         }
274         else
275             nl = n;
276     }
277     return changed;
278 }
279
280 void
281 remove_kbnode( KBNODE *root, KBNODE node )
282 {
283     KBNODE n, nl;
284
285     for( n = *root, nl=NULL; n; n = nl->next ) {
286         if( n == node ) {
287             if( n == *root )
288                 *root = nl = n->next;
289             else
290                 nl->next = n->next;
291             if( !is_cloned_kbnode(n) ) {
292                 free_packet( n->pkt );
293                 m_free( n->pkt );
294             }
295             free_node( n );
296         }
297         else
298             nl = n;
299     }
300 }
301
302
303 /****************
304  * Move NODE behind right after WHERE or to the beginning if WHERE is NULL.
305  */
306 void
307 move_kbnode( KBNODE *root, KBNODE node, KBNODE where )
308 {
309     KBNODE tmp, prev;
310
311     if( !root || !*root || !node )
312         return;  /* sanity check */
313     for( prev = *root; prev && prev->next != node; prev = prev->next )
314         ;
315     if( !prev )
316         return; /* node is not in the list */
317
318     if( !where ) {  /* move node before root */
319         if( node == *root ) /* move to itself */
320             return;
321         prev->next = node->next;
322         node->next = *root;
323         *root = node;
324         return;
325     }
326     /* move it after where */
327     if( node == where )
328         return;
329     tmp = node->next;
330     node->next = where->next;
331     where->next = node;
332     prev->next = tmp;
333 }
334
335
336
337
338 void
339 dump_kbnode( KBNODE node )
340 {
341     for(; node; node = node->next ) {
342         const char *s;
343         switch( node->pkt->pkttype ) {
344           case 0:               s="empty"; break;
345           case PKT_PUBLIC_KEY:  s="public-key"; break;
346           case PKT_SECRET_KEY:  s="secret-key"; break;
347           case PKT_SECRET_SUBKEY: s= "secret-subkey"; break;
348           case PKT_PUBKEY_ENC:  s="public-enc"; break;
349           case PKT_SIGNATURE:   s="signature"; break;
350           case PKT_ONEPASS_SIG: s="onepass-sig"; break;
351           case PKT_USER_ID:     s="user-id"; break;
352           case PKT_PUBLIC_SUBKEY: s="public-subkey"; break;
353           case PKT_COMMENT:     s="comment"; break;
354           case PKT_RING_TRUST:  s="trust"; break;
355           case PKT_PLAINTEXT:   s="plaintext"; break;
356           case PKT_COMPRESSED:  s="compressed"; break;
357           case PKT_ENCRYPTED:   s="encrypted"; break;
358           default:              s="unknown"; break;
359         }
360         fprintf(stderr, "node %p %02x/%02x type=%s",
361                 node, node->flag, node->private_flag, s);
362         if( node->pkt->pkttype == PKT_USER_ID ) {
363             fputs("  \"", stderr);
364             print_string( stderr, node->pkt->pkt.user_id->name,
365                                   node->pkt->pkt.user_id->len, 0 );
366             fputs("\"\n", stderr);
367         }
368         else if( node->pkt->pkttype == PKT_SIGNATURE ) {
369             fprintf(stderr, "  class=%02x keyid=%08lX\n",
370                    node->pkt->pkt.signature->sig_class,
371                    (ulong)node->pkt->pkt.signature->keyid[1] );
372         }
373         else if( node->pkt->pkttype == PKT_PUBLIC_KEY
374                  || node->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
375             fprintf(stderr, "  keyid=%08lX\n", (ulong)
376                   keyid_from_pk( node->pkt->pkt.public_key, NULL ));
377         }
378         else
379             fputs("\n", stderr);
380     }
381 }
382