import works
[gnupg.git] / g10 / kbnode.c
1 /* kbnode.c -  keyblock node utility functions
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 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  * G10 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
32
33 KBNODE
34 new_kbnode( PACKET *pkt )
35 {
36     KBNODE n = m_alloc( sizeof *n );
37     n->next = NULL;
38     n->pkt = pkt;
39     n->flag = 0;
40     n->private_flag=0;
41     return n;
42 }
43
44
45 KBNODE
46 clone_kbnode( KBNODE node )
47 {
48     KBNODE n = m_alloc( sizeof *n );
49     n->next = NULL;
50     n->pkt = node->pkt;
51     n->private_flag |= 2; /* mark cloned */
52     n->flag = 0;
53     return n;
54 }
55
56
57 void
58 release_kbnode( KBNODE n )
59 {
60     KBNODE n2;
61
62     while( n ) {
63         n2 = n->next;
64         if( !(n->private_flag & 2) )
65             free_packet( n->pkt );
66         m_free( n );
67         n = n2;
68     }
69 }
70
71
72 /****************
73  * Delete NODE from ROOT, ROOT must exist!
74  * Note: This does only work with walk_kbnode!!
75  */
76 void
77 delete_kbnode( KBNODE node )
78 {
79     node->private_flag |= 1;
80 }
81
82
83 /****************
84  * Append NODE to ROOT, ROOT must exist!
85  */
86 void
87 add_kbnode( KBNODE root, KBNODE node )
88 {
89     KBNODE n1;
90
91     for(n1=root; n1->next; n1 = n1->next)
92         ;
93     n1->next = node;
94 }
95
96 /****************
97  * Insert NODE into the list after root but before a packet with type PKTTYPE
98  * (only if PKTTYPE != 0)
99  */
100 void
101 insert_kbnode( KBNODE root, KBNODE node, int pkttype )
102 {
103     if( !pkttype ) {
104         node->next = root->next;
105         root->next = node;
106     }
107     else {
108         KBNODE n1;
109
110         for(n1=root; n1->next;  n1 = n1->next)
111             if( pkttype == n1->next->pkt->pkttype ) {
112                 node->next = n1->next;
113                 n1->next = node;
114                 return;
115             }
116         /* no such packet, append */
117         node->next = NULL;
118         n1->next = node;
119     }
120 }
121
122
123 /****************
124  * Find the previous node (if PKTTYPE = 0) or the previous node
125  * with pkttype PKTTYPE in the list starting with ROOT of NODE.
126  */
127 KBNODE
128 find_prev_kbnode( KBNODE root, KBNODE node, int pkttype )
129 {
130     KBNODE n1;
131
132     for(n1=NULL ; root && root != node; root = root->next )
133         if( !pkttype || root->pkt->pkttype == pkttype )
134             n1 = root;
135     return n1;
136 }
137
138 /****************
139  * Ditto, but find the next package.  The behaviour is trivial if
140  * PKTTYPE is 0 but if it is specified, the next node with a packet
141  * of this type is returned.  The function has some knowledge about
142  * the valid ordering of packets: e.g. if the next signature packet
143  * is requested, the function will not return one if it encounters
144  * a user-id.
145  */
146 KBNODE
147 find_next_kbnode( KBNODE node, int pkttype )
148 {
149     for( node=node->next ; node; node = node->next ) {
150         if( !pkttype )
151             return node;
152         else if( pkttype == PKT_USER_ID
153                  && (   node->pkt->pkttype == PKT_PUBLIC_CERT
154                      || node->pkt->pkttype == PKT_SECRET_CERT ) )
155             return NULL;
156         else if( pkttype == PKT_SIGNATURE
157                  && (   node->pkt->pkttype == PKT_USER_ID
158                      || node->pkt->pkttype == PKT_PUBLIC_CERT
159                      || node->pkt->pkttype == PKT_SECRET_CERT ) )
160             return NULL;
161         else if( node->pkt->pkttype == pkttype )
162             return node;
163     }
164     return NULL;
165 }
166
167
168 KBNODE
169 find_kbnode( KBNODE node, int pkttype )
170 {
171     for( ; node; node = node->next ) {
172         if( node->pkt->pkttype == pkttype )
173             return node;
174     }
175     return NULL;
176 }
177
178
179
180 /****************
181  * Walk through a list of kbnodes. This functions returns
182  * the next kbnode for each call; before using the function the first
183  * time, the caller must set CONTEXT to NULL (This has simply the effect
184  * to start with ROOT).
185  */
186 KBNODE
187 walk_kbnode( KBNODE root, KBNODE *context, int all )
188 {
189     KBNODE n;
190
191     do {
192         if( !*context ) {
193             *context = root;
194             n = root;
195         }
196         else {
197             n = (*context)->next;
198             *context = n;
199         }
200     } while( !all && n && (n->private_flag & 1) );
201
202     return n;
203 }
204
205 void
206 clear_kbnode_flags( KBNODE n )
207 {
208     for( ; n; n = n->next ) {
209         n->flag = 0;
210     }
211 }
212
213
214 /****************
215  * Commit changes made to the kblist at ROOT. Note that ROOT my change,
216  * and it is therefor passed by reference.
217  * The function has the effect of removing all nodes marked as deleted.
218  * returns true, if any node has been changed
219  */
220 int
221 commit_kbnode( KBNODE *root )
222 {
223     KBNODE n, nl;
224     int changed = 0;
225
226     for( n = *root, nl=NULL; n; n = nl->next ) {
227         if( (n->private_flag & 1) ) {
228             if( n == *root )
229                 *root = nl = n->next;
230             else
231                 nl->next = n->next;
232             if( !(n->private_flag & 2) )
233                 free_packet( n->pkt );
234             m_free( n );
235             changed = 1;
236         }
237         else
238             nl = n;
239     }
240     return changed;
241 }
242
243
244 void
245 dump_kbnode( KBNODE node )
246 {
247     for(; node; node = node->next ) {
248         const char *s;
249         switch( node->pkt->pkttype ) {
250           case 0:               s="empty"; break;
251           case PKT_PUBLIC_CERT: s="public-key"; break;
252           case PKT_SECRET_CERT: s="secret-key"; break;
253           case PKT_SECKEY_SUBCERT:  s= "secret-subkey"; break;
254           case PKT_PUBKEY_ENC:  s="public-enc"; break;
255           case PKT_SIGNATURE:   s="signature"; break;
256           case PKT_ONEPASS_SIG: s="onepass-sig"; break;
257           case PKT_USER_ID:     s="user-id"; break;
258           case PKT_PUBKEY_SUBCERT: s="public-subkey"; break;
259           case PKT_COMMENT:     s="comment"; break;
260           case PKT_RING_TRUST:  s="trust"; break;
261           case PKT_PLAINTEXT:   s="plaintext"; break;
262           case PKT_COMPRESSED:  s="compressed"; break;
263           case PKT_ENCRYPTED:   s="encrypted"; break;
264           default:              s="unknown"; break;
265         }
266         fprintf(stderr, "node %p %02x/%02x type=%s",
267                 node, node->flag, node->private_flag, s);
268         if( node->pkt->pkttype == PKT_USER_ID ) {
269             fputs("  \"", stderr);
270             print_string( stderr, node->pkt->pkt.user_id->name,
271                                   node->pkt->pkt.user_id->len );
272             fputs("\"\n", stderr);
273         }
274         else if( node->pkt->pkttype == PKT_SIGNATURE ) {
275             fprintf(stderr, "  keyid=%08lX\n",
276                    (ulong)node->pkt->pkt.signature->keyid[1] );
277         }
278         else if( node->pkt->pkttype == PKT_PUBLIC_CERT ) {
279             fprintf(stderr, "  keyid=%08lX\n", (ulong)
280                   keyid_from_pkc( node->pkt->pkt.public_cert, NULL ));
281         }
282         else
283             fputs("\n", stderr);
284     }
285 }
286