tests: Make make distcheck work again.
[gnupg.git] / kbx / keybox-util.c
1 /* keybox-util.c - Utility functions for Keybox
2  *      Copyright (C) 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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdlib.h>
22 #include <stdio.h>
23 #include <string.h>
24 #ifdef  HAVE_DOSISH_SYSTEM
25 # define WIN32_LEAN_AND_MEAN  /* We only need the OS core stuff.  */
26 # include <windows.h>
27 #endif
28
29 #include "keybox-defs.h"
30
31
32 static void *(*alloc_func)(size_t n) = malloc;
33 static void *(*realloc_func)(void *p, size_t n) = realloc;
34 static void (*free_func)(void*) = free;
35
36
37
38 void
39 keybox_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
40                           void *(*new_realloc_func)(void *p, size_t n),
41                           void (*new_free_func)(void*) )
42 {
43   alloc_func        = new_alloc_func;
44   realloc_func      = new_realloc_func;
45   free_func         = new_free_func;
46 }
47
48 void *
49 _keybox_malloc (size_t n)
50 {
51   return alloc_func (n);
52 }
53
54 void *
55 _keybox_realloc (void *a, size_t n)
56 {
57   return realloc_func (a, n);
58 }
59
60 void *
61 _keybox_calloc (size_t n, size_t m)
62 {
63   void *p = _keybox_malloc (n*m);
64   if (p)
65     memset (p, 0, n* m);
66   return p;
67 }
68
69 void
70 _keybox_free (void *p)
71 {
72   if (p)
73     free_func (p);
74 }
75
76
77 /* Store the two malloced temporary file names used for keybox updates
78    of file FILENAME at R_BAKNAME and R_TMPNAME.  On error an error
79    code is returned and NULL stored at R_BAKNAME and R_TMPNAME.  If
80    FOR_KEYRING is true the returned names match those used by GnuPG's
81    keyring code.  */
82 gpg_error_t
83 keybox_tmp_names (const char *filename, int for_keyring,
84                   char **r_bakname, char **r_tmpname)
85 {
86   gpg_error_t err;
87   char *bak_name, *tmp_name;
88
89   *r_bakname = NULL;
90   *r_tmpname = NULL;
91
92 # ifdef USE_ONLY_8DOT3
93   /* Here is another Windoze bug?:
94    * you can't rename("pubring.kbx.tmp", "pubring.kbx");
95    * but        rename("pubring.kbx.tmp", "pubring.aaa");
96    * works.  So we replace ".kbx" by ".kb_" or ".k__".  Note that we
97    * can't use ".bak" and ".tmp", because these suffixes are used by
98    * gpg's keyrings and would lead to a sharing violation or data
99    * corruption.  If the name does not end in ".kbx" we assume working
100    * on a modern file system and append the suffix.  */
101   {
102     const char *ext   = for_keyring? EXTSEP_S GPGEXT_GPG : EXTSEP_S "kbx";
103     const char *b_ext = for_keyring? EXTSEP_S "bak"      : EXTSEP_S "kb_";
104     const char *t_ext = for_keyring? EXTSEP_S "tmp"      : EXTSEP_S "k__";
105     int repl;
106
107     if (strlen (ext) != 4 || strlen (b_ext) != 4)
108       BUG ();
109     repl = (strlen (filename) > 4
110             && !strcmp (filename + strlen (filename) - 4, ext));
111     bak_name = xtrymalloc (strlen (filename) + (repl?0:4) + 1);
112     if (!bak_name)
113       return gpg_error_from_syserror ();
114     strcpy (bak_name, filename);
115     strcpy (bak_name + strlen (filename) - (repl?4:0), b_ext);
116
117     tmp_name = xtrymalloc (strlen (filename) + (repl?0:4) + 1);
118     if (!tmp_name)
119       {
120         err = gpg_error_from_syserror ();
121         xfree (bak_name);
122         return err;
123       }
124     strcpy (tmp_name, filename);
125     strcpy (tmp_name + strlen (filename) - (repl?4:0), t_ext);
126   }
127 # else /* Posix file names */
128   (void)for_keyring;
129   bak_name = xtrymalloc (strlen (filename) + 2);
130   if (!bak_name)
131     return gpg_error_from_syserror ();
132   strcpy (stpcpy (bak_name, filename), "~");
133
134   tmp_name = xtrymalloc (strlen (filename) + 5);
135   if (!tmp_name)
136     {
137       err = gpg_error_from_syserror ();
138       xfree (bak_name);
139       return err;
140     }
141   strcpy (stpcpy (tmp_name,filename), EXTSEP_S "tmp");
142 # endif /* Posix filename */
143
144   *r_bakname = bak_name;
145   *r_tmpname = tmp_name;
146   return 0;
147 }
148
149
150 /* Wrapper for rename(2) to handle Windows peculiarities.  */
151 gpg_error_t
152 keybox_file_rename (const char *oldname, const char *newname)
153 {
154   gpg_error_t err = 0;
155
156 #ifdef HAVE_DOSISH_SYSTEM
157   int wtime = 0;
158
159   gnupg_remove (newname);
160  again:
161   if (rename (oldname, newname))
162     {
163       if (GetLastError () == ERROR_SHARING_VIOLATION)
164         {
165           /* Another process has the file open.  We do not use a lock
166            * for read but instead we wait until the other process has
167            * closed the file.  This may take long but that would also
168            * be the case with a dotlock approach for read and write.
169            * Note that we don't need this on Unix due to the inode
170            * concept.
171            *
172            * So let's wait until the rename has worked.  The retry
173            * intervals are 50, 100, 200, 400, 800, 50ms, ...  */
174           if (!wtime || wtime >= 800)
175             wtime = 50;
176           else
177             wtime *= 2;
178
179           if (wtime >= 800)
180             log_info ("waiting for file '%s' to become accessible ...\n",
181                       oldname);
182
183           Sleep (wtime);
184           goto again;
185         }
186       err = gpg_error_from_syserror ();
187     }
188
189 #else /* Unix */
190
191 #ifdef __riscos__
192   gnupg_remove (newname);
193 #endif
194   if (rename (oldname, newname) )
195     err = gpg_error_from_syserror ();
196
197 #endif /* Unix */
198
199   if (err)
200     log_error ("renaming '%s' to '%s' failed: %s\n",
201                oldname, newname, gpg_strerror (err));
202   return err;
203 }