Merge branch 'jc/add-2.0-ignore-removal'
[gitweb.git] / contrib / credential / gnome-keyring / git-credential-gnome-keyring.c
index d8a7038a6e938bf2338cc5d26fb7e905ef5972e1..2a317fca442a51dd6f47bfeeaa19bf32ed6e670f 100644 (file)
 
 #include <stdio.h>
 #include <string.h>
-#include <stdarg.h>
 #include <stdlib.h>
-#include <errno.h>
 #include <glib.h>
 #include <gnome-keyring.h>
-#include <gnome-keyring-memory.h>
 
-/*
- * This credential struct and API is simplified from git's credential.{h,c}
- */
-struct credential
-{
-       char          *protocol;
-       char          *host;
-       unsigned short port;
-       char          *path;
-       char          *username;
-       char          *password;
-};
+#ifdef GNOME_KEYRING_DEFAULT
 
-#define CREDENTIAL_INIT \
-  { NULL,NULL,0,NULL,NULL,NULL }
+   /* Modern gnome-keyring */
 
-typedef int (*credential_op_cb)(struct credential*);
+#include <gnome-keyring-memory.h>
 
-struct credential_operation
-{
-       char             *name;
-       credential_op_cb op;
-};
+#else
 
-#define CREDENTIAL_OP_END \
-  { NULL,NULL }
+   /*
+    * Support ancient gnome-keyring, circ. RHEL 5.X.
+    * GNOME_KEYRING_DEFAULT seems to have been introduced with Gnome 2.22,
+    * and the other features roughly around Gnome 2.20, 6 months before.
+    * Ubuntu 8.04 used Gnome 2.22 (I think).  Not sure any distro used 2.20.
+    * So the existence/non-existence of GNOME_KEYRING_DEFAULT seems like
+    * a decent thing to use as an indicator.
+    */
 
-/* ---------------- common helper functions ----------------- */
+#define GNOME_KEYRING_DEFAULT NULL
 
-static inline void warning(const char *fmt, ...)
-{
-       va_list ap;
+/*
+ * ancient gnome-keyring returns DENIED when an entry is not found.
+ * Setting NO_MATCH to DENIED will prevent us from reporting DENIED
+ * errors during get and erase operations, but we will still report
+ * DENIED errors during a store.
+ */
+#define GNOME_KEYRING_RESULT_NO_MATCH GNOME_KEYRING_RESULT_DENIED
+
+#define gnome_keyring_memory_alloc g_malloc
+#define gnome_keyring_memory_free gnome_keyring_free_password
+#define gnome_keyring_memory_strdup g_strdup
 
-       va_start(ap, fmt);
-       fprintf(stderr, "warning: ");
-       vfprintf(stderr, fmt, ap);
-       fprintf(stderr, "\n" );
-       va_end(ap);
+static const char *gnome_keyring_result_to_message(GnomeKeyringResult result)
+{
+       switch (result) {
+       case GNOME_KEYRING_RESULT_OK:
+               return "OK";
+       case GNOME_KEYRING_RESULT_DENIED:
+               return "Denied";
+       case GNOME_KEYRING_RESULT_NO_KEYRING_DAEMON:
+               return "No Keyring Daemon";
+       case GNOME_KEYRING_RESULT_ALREADY_UNLOCKED:
+               return "Already UnLocked";
+       case GNOME_KEYRING_RESULT_NO_SUCH_KEYRING:
+               return "No Such Keyring";
+       case GNOME_KEYRING_RESULT_BAD_ARGUMENTS:
+               return "Bad Arguments";
+       case GNOME_KEYRING_RESULT_IO_ERROR:
+               return "IO Error";
+       case GNOME_KEYRING_RESULT_CANCELLED:
+               return "Cancelled";
+       case GNOME_KEYRING_RESULT_ALREADY_EXISTS:
+               return "Already Exists";
+       default:
+               return "Unknown Error";
+       }
 }
 
-static inline void error(const char *fmt, ...)
+/*
+ * Support really ancient gnome-keyring, circ. RHEL 4.X.
+ * Just a guess for the Glib version.  Glib 2.8 was roughly Gnome 2.12 ?
+ * Which was released with gnome-keyring 0.4.3 ??
+ */
+#if GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 8
+
+static void gnome_keyring_done_cb(GnomeKeyringResult result, gpointer user_data)
 {
-       va_list ap;
+       gpointer *data = (gpointer *)user_data;
+       int *done = (int *)data[0];
+       GnomeKeyringResult *r = (GnomeKeyringResult *)data[1];
 
-       va_start(ap, fmt);
-       fprintf(stderr, "error: ");
-       vfprintf(stderr, fmt, ap);
-       fprintf(stderr, "\n" );
-       va_end(ap);
+       *r = result;
+       *done = 1;
 }
 
-static inline void die_errno(int err)
+static void wait_for_request_completion(int *done)
 {
-       error("%s", strerror(err));
-       exit(EXIT_FAILURE);
+       GMainContext *mc = g_main_context_default();
+       while (!*done)
+               g_main_context_iteration(mc, TRUE);
 }
 
-static inline char *xstrdup(const char *str)
+static GnomeKeyringResult gnome_keyring_item_delete_sync(const char *keyring, guint32 id)
 {
-       char *ret = strdup(str);
-       if (!ret)
-               die_errno(errno);
+       int done = 0;
+       GnomeKeyringResult result;
+       gpointer data[] = { &done, &result };
 
-       return ret;
+       gnome_keyring_item_delete(keyring, id, gnome_keyring_done_cb, data,
+               NULL);
+
+       wait_for_request_completion(&done);
+
+       return result;
 }
 
+#endif
+#endif
+
+/*
+ * This credential struct and API is simplified from git's credential.{h,c}
+ */
+struct credential {
+       char *protocol;
+       char *host;
+       unsigned short port;
+       char *path;
+       char *username;
+       char *password;
+};
+
+#define CREDENTIAL_INIT { NULL, NULL, 0, NULL, NULL, NULL }
+
+typedef int (*credential_op_cb)(struct credential *);
+
+struct credential_operation {
+       char *name;
+       credential_op_cb op;
+};
+
+#define CREDENTIAL_OP_END { NULL, NULL }
+
 /* ----------------- GNOME Keyring functions ----------------- */
 
 /* create a special keyring option string, if path is given */
-static charkeyring_object(struct credential *c)
+static char *keyring_object(struct credential *c)
 {
        if (!c->path)
                return NULL;
@@ -114,7 +166,7 @@ static char* keyring_object(struct credential *c)
 
 static int keyring_get(struct credential *c)
 {
-       charobject = NULL;
+       char *object = NULL;
        GList *entries;
        GnomeKeyringNetworkPasswordData *password_data;
        GnomeKeyringResult result;
@@ -134,7 +186,7 @@ static int keyring_get(struct credential *c)
                                c->port,
                                &entries);
 
-       free(object);
+       g_free(object);
 
        if (result == GNOME_KEYRING_RESULT_NO_MATCH)
                return EXIT_SUCCESS;
@@ -143,18 +195,18 @@ static int keyring_get(struct credential *c)
                return EXIT_SUCCESS;
 
        if (result != GNOME_KEYRING_RESULT_OK) {
-               error("%s",gnome_keyring_result_to_message(result));
+               g_critical("%s", gnome_keyring_result_to_message(result));
                return EXIT_FAILURE;
        }
 
        /* pick the first one from the list */
-       password_data = (GnomeKeyringNetworkPasswordData *) entries->data;
+       password_data = (GnomeKeyringNetworkPasswordData *)entries->data;
 
        gnome_keyring_memory_free(c->password);
        c->password = gnome_keyring_memory_strdup(password_data->password);
 
        if (!c->username)
-               c->username = xstrdup(password_data->user);
+               c->username = g_strdup(password_data->user);
 
        gnome_keyring_network_password_list_free(entries);
 
@@ -165,7 +217,8 @@ static int keyring_get(struct credential *c)
 static int keyring_store(struct credential *c)
 {
        guint32 item_id;
-       char  *object = NULL;
+       char *object = NULL;
+       GnomeKeyringResult result;
 
        /*
         * Sanity check that what we are storing is actually sensible.
@@ -180,7 +233,7 @@ static int keyring_store(struct credential *c)
 
        object = keyring_object(c);
 
-       gnome_keyring_set_network_password_sync(
+       result = gnome_keyring_set_network_password_sync(
                                GNOME_KEYRING_DEFAULT,
                                c->username,
                                NULL /* domain */,
@@ -192,13 +245,20 @@ static int keyring_store(struct credential *c)
                                c->password,
                                &item_id);
 
-       free(object);
+       g_free(object);
+
+       if (result != GNOME_KEYRING_RESULT_OK &&
+           result != GNOME_KEYRING_RESULT_CANCELLED) {
+               g_critical("%s", gnome_keyring_result_to_message(result));
+               return EXIT_FAILURE;
+       }
+
        return EXIT_SUCCESS;
 }
 
 static int keyring_erase(struct credential *c)
 {
-       char  *object = NULL;
+       char *object = NULL;
        GList *entries;
        GnomeKeyringNetworkPasswordData *password_data;
        GnomeKeyringResult result;
@@ -226,7 +286,7 @@ static int keyring_erase(struct credential *c)
                                c->port,
                                &entries);
 
-       free(object);
+       g_free(object);
 
        if (result == GNOME_KEYRING_RESULT_NO_MATCH)
                return EXIT_SUCCESS;
@@ -234,23 +294,21 @@ static int keyring_erase(struct credential *c)
        if (result == GNOME_KEYRING_RESULT_CANCELLED)
                return EXIT_SUCCESS;
 
-       if (result != GNOME_KEYRING_RESULT_OK)
-       {
-               error("%s",gnome_keyring_result_to_message(result));
+       if (result != GNOME_KEYRING_RESULT_OK) {
+               g_critical("%s", gnome_keyring_result_to_message(result));
                return EXIT_FAILURE;
        }
 
        /* pick the first one from the list (delete all matches?) */
-       password_data = (GnomeKeyringNetworkPasswordData *) entries->data;
+       password_data = (GnomeKeyringNetworkPasswordData *)entries->data;
 
        result = gnome_keyring_item_delete_sync(
                password_data->keyring, password_data->item_id);
 
        gnome_keyring_network_password_list_free(entries);
 
-       if (result != GNOME_KEYRING_RESULT_OK)
-       {
-               error("%s",gnome_keyring_result_to_message(result));
+       if (result != GNOME_KEYRING_RESULT_OK) {
+               g_critical("%s", gnome_keyring_result_to_message(result));
                return EXIT_FAILURE;
        }
 
@@ -261,9 +319,8 @@ static int keyring_erase(struct credential *c)
  * Table with helper operation callbacks, used by generic
  * credential helper main function.
  */
-static struct credential_operation const credential_helper_ops[] =
-{
-       { "get",   keyring_get   },
+static struct credential_operation const credential_helper_ops[] = {
+       { "get",   keyring_get },
        { "store", keyring_store },
        { "erase", keyring_erase },
        CREDENTIAL_OP_END
@@ -278,10 +335,10 @@ static void credential_init(struct credential *c)
 
 static void credential_clear(struct credential *c)
 {
-       free(c->protocol);
-       free(c->host);
-       free(c->path);
-       free(c->username);
+       g_free(c->protocol);
+       g_free(c->host);
+       g_free(c->path);
+       g_free(c->username);
        gnome_keyring_memory_free(c->password);
 
        credential_init(c);
@@ -289,49 +346,52 @@ static void credential_clear(struct credential *c)
 
 static int credential_read(struct credential *c)
 {
-       char    buf[1024];
+       char *buf;
        size_t line_len;
-       char   *key      = buf;
-       char   *value;
+       char *key;
+       char *value;
+
+       key = buf = gnome_keyring_memory_alloc(1024);
 
-       while (fgets(buf, sizeof(buf), stdin))
-       {
+       while (fgets(buf, 1024, stdin)) {
                line_len = strlen(buf);
 
                if (line_len && buf[line_len-1] == '\n')
-                       buf[--line_len]='\0';
+                       buf[--line_len] = '\0';
 
                if (!line_len)
                        break;
 
-               value = strchr(buf,'=');
+               value = strchr(buf, '=');
                if (!value) {
-                       warning("invalid credential line: %s", key);
+                       g_warning("invalid credential line: %s", key);
+                       gnome_keyring_memory_free(buf);
                        return -1;
                }
                *value++ = '\0';
 
                if (!strcmp(key, "protocol")) {
-                       free(c->protocol);
-                       c->protocol = xstrdup(value);
+                       g_free(c->protocol);
+                       c->protocol = g_strdup(value);
                } else if (!strcmp(key, "host")) {
-                       free(c->host);
-                       c->host = xstrdup(value);
-                       value = strrchr(c->host,':');
+                       g_free(c->host);
+                       c->host = g_strdup(value);
+                       value = strrchr(c->host, ':');
                        if (value) {
                                *value++ = '\0';
                                c->port = atoi(value);
                        }
                } else if (!strcmp(key, "path")) {
-                       free(c->path);
-                       c->path = xstrdup(value);
+                       g_free(c->path);
+                       c->path = g_strdup(value);
                } else if (!strcmp(key, "username")) {
-                       free(c->username);
-                       c->username = xstrdup(value);
+                       g_free(c->username);
+                       c->username = g_strdup(value);
                } else if (!strcmp(key, "password")) {
                        gnome_keyring_memory_free(c->password);
                        c->password = gnome_keyring_memory_strdup(value);
-                       while (*value) *value++ = '\0';
+                       while (*value)
+                               *value++ = '\0';
                }
                /*
                 * Ignore other lines; we don't know what they mean, but
@@ -339,6 +399,9 @@ static int credential_read(struct credential *c)
                 * learn new lines, and the helpers are updated to match.
                 */
        }
+
+       gnome_keyring_memory_free(buf);
+
        return 0;
 }
 
@@ -359,16 +422,16 @@ static void credential_write(const struct credential *c)
 static void usage(const char *name)
 {
        struct credential_operation const *try_op = credential_helper_ops;
-       const char *basename = strrchr(name,'/');
+       const char *basename = strrchr(name, '/');
 
        basename = (basename) ? basename + 1 : name;
        fprintf(stderr, "usage: %s <", basename);
        while (try_op->name) {
-               fprintf(stderr,"%s",(try_op++)->name);
+               fprintf(stderr, "%s", (try_op++)->name);
                if (try_op->name)
-                       fprintf(stderr,"%s","|");
+                       fprintf(stderr, "%s", "|");
        }
-       fprintf(stderr,"%s",">\n");
+       fprintf(stderr, "%s", ">\n");
 }
 
 int main(int argc, char *argv[])
@@ -376,7 +439,7 @@ int main(int argc, char *argv[])
        int ret = EXIT_SUCCESS;
 
        struct credential_operation const *try_op = credential_helper_ops;
-       struct credential                  cred   = CREDENTIAL_INIT;
+       struct credential cred = CREDENTIAL_INIT;
 
        if (!argv[1]) {
                usage(argv[0]);