2009-11-05 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / src / vfs-mount.c
1 /* vfs-mount.c - vfs mount support in GPGME
2    Copyright (C) 2009 g10 Code GmbH
3
4    This file is part of GPGME.
5  
6    GPGME is free software; you can redistribute it and/or modify it
7    under the terms of the GNU Lesser General Public License as
8    published by the Free Software Foundation; either version 2.1 of
9    the License, or (at your option) any later version.
10    
11    GPGME is distributed in the hope that it will be useful, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15    
16    You should have received a copy of the GNU Lesser General Public
17    License along with this program; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
19    02111-1307, USA.  */
20
21 #if HAVE_CONFIG_H
22 #include <config.h>
23 #endif
24
25 #include <stdlib.h>
26
27 #include "gpgme.h"
28 #include "debug.h"
29 #include "context.h"
30 #include "ops.h"
31 #include "util.h"
32
33 typedef struct
34 {
35   struct _gpgme_op_vfs_mount_result result;
36 } *op_data_t;
37
38
39 \f
40 gpgme_vfs_mount_result_t
41 gpgme_op_vfs_mount_result (gpgme_ctx_t ctx)
42 {
43   gpgme_error_t err;
44   void *hook;
45   op_data_t opd;
46
47   err = _gpgme_op_data_lookup (ctx, OPDATA_VFS_MOUNT, &hook, -1, NULL);
48   opd = hook;
49   /* Check in case this function is used without having run a command
50      before.  */
51   if (err || !opd)
52     return NULL;
53
54   return &opd->result;
55 }
56
57
58 static gpgme_error_t
59 _gpgme_vfs_mount_status_handler (void *priv, const char *code, const char *args)
60 {
61   gpgme_ctx_t ctx = (gpgme_ctx_t) priv;
62   gpgme_error_t err;
63   void *hook;
64   op_data_t opd;
65
66   err = _gpgme_op_data_lookup (ctx, OPDATA_VFS_MOUNT, &hook, -1, NULL);
67   opd = hook;
68   if (err)
69     return err;
70
71   if (! strcasecmp ("MOUNTPOINT", code))
72     {
73       if (opd->result.mount_dir)
74         free (opd->result.mount_dir);
75       opd->result.mount_dir = strdup (args);
76     }
77
78   return 0;
79 }
80
81
82 static gpgme_error_t
83 vfs_start (gpgme_ctx_t ctx, int synchronous,
84            const char *command,
85            gpgme_assuan_data_cb_t data_cb,
86            void *data_cb_value,
87            gpgme_assuan_inquire_cb_t inq_cb,
88            void *inq_cb_value,
89            gpgme_assuan_status_cb_t status_cb,
90            void *status_cb_value)
91 {
92   gpgme_error_t err;
93   void *hook;
94   op_data_t opd;
95
96   if (!command || !*command)
97     return gpg_error (GPG_ERR_INV_VALUE);
98
99   /* The flag value 256 is used to suppress an engine reset.  This is
100      required to keep the connection running.  */
101   err = _gpgme_op_reset (ctx, ((synchronous & 255) | 256));
102   if (err)
103     return err;
104
105   err = _gpgme_op_data_lookup (ctx, OPDATA_VFS_MOUNT, &hook, sizeof (*opd),
106                                NULL);
107   opd = hook;
108   if (err)
109     return err;
110
111   return _gpgme_engine_op_assuan_transact (ctx->engine, command,
112                                            data_cb, data_cb_value,
113                                            inq_cb, inq_cb_value,
114                                            status_cb, status_cb_value);
115 }
116
117
118
119 /* XXXX.  This is the asynchronous variant. */
120 static gpgme_error_t
121 gpgme_op_vfs_transact_start (gpgme_ctx_t ctx, 
122                              const char *command,
123                              gpgme_assuan_data_cb_t data_cb,
124                              void *data_cb_value,
125                              gpgme_assuan_inquire_cb_t inq_cb,
126                              void *inq_cb_value,
127                              gpgme_assuan_status_cb_t status_cb,
128                              void *status_cb_value)
129 {
130   return vfs_start (ctx, 0, command, data_cb, data_cb_value,
131                     inq_cb, inq_cb_value, status_cb, status_cb_value);
132 }
133
134
135 /* XXXX.  This is the synchronous variant. */
136 static gpgme_error_t
137 gpgme_op_vfs_transact (gpgme_ctx_t ctx,
138                        const char *command,
139                        gpgme_assuan_data_cb_t data_cb,
140                        void *data_cb_value,
141                        gpgme_assuan_inquire_cb_t inq_cb,
142                        void *inq_cb_value,
143                        gpgme_assuan_status_cb_t status_cb,
144                        void *status_cb_value,
145                        gpgme_error_t *op_err)
146 {
147   gpgme_error_t err;
148   
149   err = vfs_start (ctx, 1, command, data_cb, data_cb_value,
150                    inq_cb, inq_cb_value, status_cb, status_cb_value);
151   if (!err)
152     err = _gpgme_wait_one_ext (ctx, op_err);
153   return err;
154 }
155
156 \f
157 /* The actual exported interface follows.  */
158
159 /* The container is automatically unmounted when the context is reset
160    or destroyed.  This is a synchronous convenience interface, which
161    automatically returns an operation error if there is no
162    transmission error.  */
163 static gpgme_error_t
164 _gpgme_op_vfs_mount (gpgme_ctx_t ctx, const char *container_file,
165                      const char *mount_dir, int flags, gpgme_error_t *op_err)
166 {
167   gpg_error_t err;
168   char *cmd;
169   char *container_file_esc = NULL;
170
171   /* We want to encourage people to check error values, so not getting
172      them is discouraged here.  Also makes our code easier.  */
173   if (! op_err)
174     return gpg_error (GPG_ERR_INV_VALUE);
175
176   err = _gpgme_encode_percent_string (container_file, &container_file_esc, 0);
177   if (err)
178     return err;
179
180   if (asprintf (&cmd, "OPEN -- %s", container_file_esc) < 0)
181     {
182       err = gpg_error_from_syserror ();
183       free (container_file_esc);
184       return err;
185     }
186   free (container_file_esc);
187
188   err = gpgme_op_vfs_transact (ctx, cmd, NULL, NULL, NULL, NULL,
189                                NULL, NULL, op_err);
190   free (cmd);
191   if (err || *op_err)
192     return err;
193
194   if (mount_dir)
195     {
196       char *mount_dir_esc = NULL;
197
198       err = _gpgme_encode_percent_string (mount_dir, &mount_dir_esc, 0);
199       if (err)
200         return err;
201
202       if (asprintf (&cmd, "MOUNT -- %s", mount_dir_esc) < 0)
203         {
204           err = gpg_error_from_syserror ();
205           free (mount_dir_esc);
206           return err;
207         }
208       free (mount_dir_esc);
209     }
210   else
211     {
212       if (asprintf (&cmd, "MOUNT") < 0)
213         return gpg_error_from_syserror ();
214     }
215     
216   err = gpgme_op_vfs_transact (ctx, cmd, NULL, NULL, NULL, NULL,
217                                _gpgme_vfs_mount_status_handler, ctx, op_err);
218   free (cmd);
219
220   return err;
221 }
222
223 gpgme_error_t
224 gpgme_op_vfs_mount (gpgme_ctx_t ctx, const char *container_file,
225                     const char *mount_dir, unsigned int flags,
226                     gpgme_error_t *op_err)
227 {
228   gpg_error_t err;
229
230   TRACE_BEG4 (DEBUG_CTX, "gpgme_op_vfs_mount", ctx,
231               "container=%s, mount_dir=%s, flags=0x%x, op_err=%p",
232               container_file, mount_dir, flags, op_err);
233   err = _gpgme_op_vfs_mount (ctx, container_file, mount_dir, flags, op_err);
234   return TRACE_ERR (err);
235 }
236