Merge branch 'jc/add-2.0-ignore-removal'
[gitweb.git] / contrib / credential / gnome-keyring / git-credential-gnome-keyring.c
index b70bd5395901c8048b783b7821c0ea1a0006b6c0..2a317fca442a51dd6f47bfeeaa19bf32ed6e670f 100644 (file)
 #include <stdlib.h>
 #include <glib.h>
 #include <gnome-keyring.h>
+
+#ifdef GNOME_KEYRING_DEFAULT
+
+   /* Modern gnome-keyring */
+
 #include <gnome-keyring-memory.h>
 
+#else
+
+   /*
+    * 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.
+    */
+
+#define GNOME_KEYRING_DEFAULT NULL
+
 /*
- * This credential struct and API is simplified from git's credential.{h,c}
+ * 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
+
+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";
+       }
+}
+
+/*
+ * 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 ??
  */
-struct credential
+#if GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 8
+
+static void gnome_keyring_done_cb(GnomeKeyringResult result, gpointer user_data)
+{
+       gpointer *data = (gpointer *)user_data;
+       int *done = (int *)data[0];
+       GnomeKeyringResult *r = (GnomeKeyringResult *)data[1];
+
+       *r = result;
+       *done = 1;
+}
+
+static void wait_for_request_completion(int *done)
+{
+       GMainContext *mc = g_main_context_default();
+       while (!*done)
+               g_main_context_iteration(mc, TRUE);
+}
+
+static GnomeKeyringResult gnome_keyring_item_delete_sync(const char *keyring, guint32 id)
 {
-       char          *protocol;
-       char          *host;
+       int done = 0;
+       GnomeKeyringResult result;
+       gpointer data[] = { &done, &result };
+
+       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;
+       char *path;
+       char *username;
+       char *password;
 };
 
-#define CREDENTIAL_INIT \
-  { NULL,NULL,0,NULL,NULL,NULL }
+#define CREDENTIAL_INIT { NULL, NULL, 0, NULL, NULL, NULL }
 
-typedef int (*credential_op_cb)(struct credential*);
+typedef int (*credential_op_cb)(struct credential *);
 
-struct credential_operation
-{
-       char             *name;
+struct credential_operation {
+       char *name;
        credential_op_cb op;
 };
 
-#define CREDENTIAL_OP_END \
-  { NULL,NULL }
+#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;
@@ -73,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;
@@ -107,7 +200,7 @@ static int keyring_get(struct credential *c)
        }
 
        /* 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);
@@ -124,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.
@@ -139,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 */,
@@ -152,12 +246,19 @@ static int keyring_store(struct credential *c)
                                &item_id);
 
        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;
@@ -193,22 +294,20 @@ static int keyring_erase(struct credential *c)
        if (result == GNOME_KEYRING_RESULT_CANCELLED)
                return EXIT_SUCCESS;
 
-       if (result != GNOME_KEYRING_RESULT_OK)
-       {
+       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)
-       {
+       if (result != GNOME_KEYRING_RESULT_OK) {
                g_critical("%s", gnome_keyring_result_to_message(result));
                return EXIT_FAILURE;
        }
@@ -220,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
@@ -248,24 +346,23 @@ static void credential_clear(struct credential *c)
 
 static int credential_read(struct credential *c)
 {
-       char    *buf;
+       char *buf;
        size_t line_len;
-       char   *key;
-       char   *value;
+       char *key;
+       char *value;
 
        key = buf = gnome_keyring_memory_alloc(1024);
 
-       while (fgets(buf, 1024, 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) {
                        g_warning("invalid credential line: %s", key);
                        gnome_keyring_memory_free(buf);
@@ -279,7 +376,7 @@ static int credential_read(struct credential *c)
                } else if (!strcmp(key, "host")) {
                        g_free(c->host);
                        c->host = g_strdup(value);
-                       value = strrchr(c->host,':');
+                       value = strrchr(c->host, ':');
                        if (value) {
                                *value++ = '\0';
                                c->port = atoi(value);
@@ -293,7 +390,8 @@ static int credential_read(struct credential *c)
                } 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
@@ -324,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[])
@@ -341,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]);