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