reflog_expire(): new function in the reference API
authorMichael Haggerty <mhagger@alum.mit.edu>
Fri, 12 Dec 2014 08:56:59 +0000 (09:56 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 22 Dec 2014 18:11:40 +0000 (10:11 -0800)
Move expire_reflog() into refs.c and rename it to reflog_expire().
Turn the three policy functions into function pointers that are passed
into reflog_expire(). Add function prototypes and documentation to
refs.h.

[jc: squashed in $gmane/261582, drop "extern" in function definition]

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Reviewed-by: Stefan Beller <sbeller@google.com>
Tweaked-by: Ramsay Jones
Signed-off-by: Junio C Hamano <gitster@pobox.com>
builtin/reflog.c
refs.c
refs.h
index 0df5721c8836c4bc3ca52938af09b61ba4d53240..49c64f96d8adba41261741cfa48f0e36fcd9f3bb 100644 (file)
@@ -20,13 +20,6 @@ static const char reflog_delete_usage[] =
 static unsigned long default_reflog_expire;
 static unsigned long default_reflog_expire_unreachable;
 
 static unsigned long default_reflog_expire;
 static unsigned long default_reflog_expire_unreachable;
 
-enum expire_reflog_flags {
-       EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
-       EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
-       EXPIRE_REFLOGS_VERBOSE = 1 << 2,
-       EXPIRE_REFLOGS_REWRITE = 1 << 3
-};
-
 struct cmd_reflog_expire_cb {
        struct rev_info revs;
        int stalefix;
 struct cmd_reflog_expire_cb {
        struct rev_info revs;
        int stalefix;
@@ -48,13 +41,6 @@ struct expire_reflog_policy_cb {
        struct commit_list *tips;
 };
 
        struct commit_list *tips;
 };
 
-struct expire_reflog_cb {
-       unsigned int flags;
-       void *policy_cb;
-       FILE *newlog;
-       unsigned char last_kept_sha1[20];
-};
-
 struct collected_reflog {
        unsigned char sha1[20];
        char reflog[FLEX_ARRAY];
 struct collected_reflog {
        unsigned char sha1[20];
        char reflog[FLEX_ARRAY];
@@ -330,38 +316,6 @@ static int should_expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
        return 0;
 }
 
        return 0;
 }
 
-static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
-               const char *email, unsigned long timestamp, int tz,
-               const char *message, void *cb_data)
-{
-       struct expire_reflog_cb *cb = cb_data;
-       struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;
-
-       if (cb->flags & EXPIRE_REFLOGS_REWRITE)
-               osha1 = cb->last_kept_sha1;
-
-       if (should_expire_reflog_ent(osha1, nsha1, email, timestamp, tz,
-                                    message, policy_cb)) {
-               if (!cb->newlog)
-                       printf("would prune %s", message);
-               else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
-                       printf("prune %s", message);
-       } else {
-               if (cb->newlog) {
-                       char sign = (tz < 0) ? '-' : '+';
-                       int zone = (tz < 0) ? (-tz) : tz;
-                       fprintf(cb->newlog, "%s %s %s %lu %c%04d\t%s",
-                               sha1_to_hex(osha1), sha1_to_hex(nsha1),
-                               email, timestamp, sign, zone,
-                               message);
-                       hashcpy(cb->last_kept_sha1, nsha1);
-               }
-               if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
-                       printf("keep %s", message);
-       }
-       return 0;
-}
-
 static int push_tip_to_list(const char *refname, const unsigned char *sha1,
                            int flags, void *cb_data)
 {
 static int push_tip_to_list(const char *refname, const unsigned char *sha1,
                            int flags, void *cb_data)
 {
@@ -428,90 +382,6 @@ static void reflog_expiry_cleanup(void *cb_data)
        }
 }
 
        }
 }
 
-static int expire_reflog(const char *refname, const unsigned char *sha1,
-                        unsigned int flags, void *policy_cb_data)
-{
-       static struct lock_file reflog_lock;
-       struct expire_reflog_cb cb;
-       struct ref_lock *lock;
-       char *log_file;
-       int status = 0;
-
-       memset(&cb, 0, sizeof(cb));
-       cb.flags = flags;
-       cb.policy_cb = policy_cb_data;
-
-       /*
-        * The reflog file is locked by holding the lock on the
-        * reference itself, plus we might need to update the
-        * reference if --updateref was specified:
-        */
-       lock = lock_any_ref_for_update(refname, sha1, 0, NULL);
-       if (!lock)
-               return error("cannot lock ref '%s'", refname);
-       if (!reflog_exists(refname)) {
-               unlock_ref(lock);
-               return 0;
-       }
-
-       log_file = git_pathdup("logs/%s", refname);
-       if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
-               /*
-                * Even though holding $GIT_DIR/logs/$reflog.lock has
-                * no locking implications, we use the lock_file
-                * machinery here anyway because it does a lot of the
-                * work we need, including cleaning up if the program
-                * exits unexpectedly.
-                */
-               if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
-                       struct strbuf err = STRBUF_INIT;
-                       unable_to_lock_message(log_file, errno, &err);
-                       error("%s", err.buf);
-                       strbuf_release(&err);
-                       goto failure;
-               }
-               cb.newlog = fdopen_lock_file(&reflog_lock, "w");
-               if (!cb.newlog) {
-                       error("cannot fdopen %s (%s)",
-                             reflog_lock.filename.buf, strerror(errno));
-                       goto failure;
-               }
-       }
-
-       reflog_expiry_prepare(refname, sha1, cb.policy_cb);
-       for_each_reflog_ent(refname, expire_reflog_ent, &cb);
-       reflog_expiry_cleanup(cb.policy_cb);
-
-       if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
-               if (close_lock_file(&reflog_lock)) {
-                       status |= error("couldn't write %s: %s", log_file,
-                                       strerror(errno));
-               } else if ((flags & EXPIRE_REFLOGS_UPDATE_REF) &&
-                       (write_in_full(lock->lock_fd,
-                               sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||
-                        write_str_in_full(lock->lock_fd, "\n") != 1 ||
-                        close_ref(lock) < 0)) {
-                       status |= error("couldn't write %s",
-                                       lock->lk->filename.buf);
-                       rollback_lock_file(&reflog_lock);
-               } else if (commit_lock_file(&reflog_lock)) {
-                       status |= error("unable to commit reflog '%s' (%s)",
-                                       log_file, strerror(errno));
-               } else if ((flags & EXPIRE_REFLOGS_UPDATE_REF) && commit_ref(lock)) {
-                       status |= error("couldn't set %s", lock->ref_name);
-               }
-       }
-       free(log_file);
-       unlock_ref(lock);
-       return status;
-
- failure:
-       rollback_lock_file(&reflog_lock);
-       free(log_file);
-       unlock_ref(lock);
-       return -1;
-}
-
 static int collect_reflog(const char *ref, const unsigned char *sha1, int unused, void *cb_data)
 {
        struct collected_reflog *e;
 static int collect_reflog(const char *ref, const unsigned char *sha1, int unused, void *cb_data)
 {
        struct collected_reflog *e;
@@ -727,7 +597,11 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix)
                for (i = 0; i < collected.nr; i++) {
                        struct collected_reflog *e = collected.e[i];
                        set_reflog_expiry_param(&cb.cmd, explicit_expiry, e->reflog);
                for (i = 0; i < collected.nr; i++) {
                        struct collected_reflog *e = collected.e[i];
                        set_reflog_expiry_param(&cb.cmd, explicit_expiry, e->reflog);
-                       status |= expire_reflog(e->reflog, e->sha1, flags, &cb);
+                       status |= reflog_expire(e->reflog, e->sha1, flags,
+                                               reflog_expiry_prepare,
+                                               should_expire_reflog_ent,
+                                               reflog_expiry_cleanup,
+                                               &cb);
                        free(e);
                }
                free(collected.e);
                        free(e);
                }
                free(collected.e);
@@ -741,7 +615,11 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix)
                        continue;
                }
                set_reflog_expiry_param(&cb.cmd, explicit_expiry, ref);
                        continue;
                }
                set_reflog_expiry_param(&cb.cmd, explicit_expiry, ref);
-               status |= expire_reflog(ref, sha1, flags, &cb);
+               status |= reflog_expire(ref, sha1, flags,
+                                       reflog_expiry_prepare,
+                                       should_expire_reflog_ent,
+                                       reflog_expiry_cleanup,
+                                       &cb);
        }
        return status;
 }
        }
        return status;
 }
@@ -813,7 +691,11 @@ static int cmd_reflog_delete(int argc, const char **argv, const char *prefix)
                        cb.cmd.expire_total = 0;
                }
 
                        cb.cmd.expire_total = 0;
                }
 
-               status |= expire_reflog(ref, sha1, flags, &cb);
+               status |= reflog_expire(ref, sha1, flags,
+                                       reflog_expiry_prepare,
+                                       should_expire_reflog_ent,
+                                       reflog_expiry_cleanup,
+                                       &cb);
                free(ref);
        }
        return status;
                free(ref);
        }
        return status;
diff --git a/refs.c b/refs.c
index 150c98024717ba37566ff798db064f01028b437a..4b27a1ba8ec152b6c893d1575a80b2e8562d3363 100644 (file)
--- a/refs.c
+++ b/refs.c
@@ -3943,3 +3943,132 @@ int ref_is_hidden(const char *refname)
        }
        return 0;
 }
        }
        return 0;
 }
+
+struct expire_reflog_cb {
+       unsigned int flags;
+       reflog_expiry_should_prune_fn *should_prune_fn;
+       void *policy_cb;
+       FILE *newlog;
+       unsigned char last_kept_sha1[20];
+};
+
+static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
+                            const char *email, unsigned long timestamp, int tz,
+                            const char *message, void *cb_data)
+{
+       struct expire_reflog_cb *cb = cb_data;
+       struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;
+
+       if (cb->flags & EXPIRE_REFLOGS_REWRITE)
+               osha1 = cb->last_kept_sha1;
+
+       if ((*cb->should_prune_fn)(osha1, nsha1, email, timestamp, tz,
+                                  message, policy_cb)) {
+               if (!cb->newlog)
+                       printf("would prune %s", message);
+               else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
+                       printf("prune %s", message);
+       } else {
+               if (cb->newlog) {
+                       char sign = (tz < 0) ? '-' : '+';
+                       int zone = (tz < 0) ? (-tz) : tz;
+                       fprintf(cb->newlog, "%s %s %s %lu %c%04d\t%s",
+                               sha1_to_hex(osha1), sha1_to_hex(nsha1),
+                               email, timestamp, sign, zone,
+                               message);
+                       hashcpy(cb->last_kept_sha1, nsha1);
+               }
+               if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
+                       printf("keep %s", message);
+       }
+       return 0;
+}
+
+int reflog_expire(const char *refname, const unsigned char *sha1,
+                unsigned int flags,
+                reflog_expiry_prepare_fn prepare_fn,
+                reflog_expiry_should_prune_fn should_prune_fn,
+                reflog_expiry_cleanup_fn cleanup_fn,
+                void *policy_cb_data)
+{
+       static struct lock_file reflog_lock;
+       struct expire_reflog_cb cb;
+       struct ref_lock *lock;
+       char *log_file;
+       int status = 0;
+
+       memset(&cb, 0, sizeof(cb));
+       cb.flags = flags;
+       cb.policy_cb = policy_cb_data;
+       cb.should_prune_fn = should_prune_fn;
+
+       /*
+        * The reflog file is locked by holding the lock on the
+        * reference itself, plus we might need to update the
+        * reference if --updateref was specified:
+        */
+       lock = lock_any_ref_for_update(refname, sha1, 0, NULL);
+       if (!lock)
+               return error("cannot lock ref '%s'", refname);
+       if (!reflog_exists(refname)) {
+               unlock_ref(lock);
+               return 0;
+       }
+
+       log_file = git_pathdup("logs/%s", refname);
+       if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
+               /*
+                * Even though holding $GIT_DIR/logs/$reflog.lock has
+                * no locking implications, we use the lock_file
+                * machinery here anyway because it does a lot of the
+                * work we need, including cleaning up if the program
+                * exits unexpectedly.
+                */
+               if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
+                       struct strbuf err = STRBUF_INIT;
+                       unable_to_lock_message(log_file, errno, &err);
+                       error("%s", err.buf);
+                       strbuf_release(&err);
+                       goto failure;
+               }
+               cb.newlog = fdopen_lock_file(&reflog_lock, "w");
+               if (!cb.newlog) {
+                       error("cannot fdopen %s (%s)",
+                             reflog_lock.filename.buf, strerror(errno));
+                       goto failure;
+               }
+       }
+
+       (*prepare_fn)(refname, sha1, cb.policy_cb);
+       for_each_reflog_ent(refname, expire_reflog_ent, &cb);
+       (*cleanup_fn)(cb.policy_cb);
+
+       if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
+               if (close_lock_file(&reflog_lock)) {
+                       status |= error("couldn't write %s: %s", log_file,
+                                       strerror(errno));
+               } else if ((flags & EXPIRE_REFLOGS_UPDATE_REF) &&
+                       (write_in_full(lock->lock_fd,
+                               sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||
+                        write_str_in_full(lock->lock_fd, "\n") != 1 ||
+                        close_ref(lock) < 0)) {
+                       status |= error("couldn't write %s",
+                                       lock->lk->filename.buf);
+                       rollback_lock_file(&reflog_lock);
+               } else if (commit_lock_file(&reflog_lock)) {
+                       status |= error("unable to commit reflog '%s' (%s)",
+                                       log_file, strerror(errno));
+               } else if ((flags & EXPIRE_REFLOGS_UPDATE_REF) && commit_ref(lock)) {
+                       status |= error("couldn't set %s", lock->ref_name);
+               }
+       }
+       free(log_file);
+       unlock_ref(lock);
+       return status;
+
+ failure:
+       rollback_lock_file(&reflog_lock);
+       free(log_file);
+       unlock_ref(lock);
+       return -1;
+}
diff --git a/refs.h b/refs.h
index 7d675b71276b36c3235eed93412c733a4bcaf6a6..99e707b1b6a79dbfbc4a55ade74cd576450fd874 100644 (file)
--- a/refs.h
+++ b/refs.h
@@ -353,4 +353,50 @@ int update_ref(const char *action, const char *refname,
 extern int parse_hide_refs_config(const char *var, const char *value, const char *);
 extern int ref_is_hidden(const char *);
 
 extern int parse_hide_refs_config(const char *var, const char *value, const char *);
 extern int ref_is_hidden(const char *);
 
+enum expire_reflog_flags {
+       EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
+       EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
+       EXPIRE_REFLOGS_VERBOSE = 1 << 2,
+       EXPIRE_REFLOGS_REWRITE = 1 << 3
+};
+
+/*
+ * The following interface is used for reflog expiration. The caller
+ * calls reflog_expire(), supplying it with three callback functions,
+ * of the following types. The callback functions define the
+ * expiration policy that is desired.
+ *
+ * reflog_expiry_prepare_fn -- Called once after the reference is
+ *     locked.
+ *
+ * reflog_expiry_should_prune_fn -- Called once for each entry in the
+ *     existing reflog. It should return true iff that entry should be
+ *     pruned.
+ *
+ * reflog_expiry_cleanup_fn -- Called once before the reference is
+ *     unlocked again.
+ */
+typedef void reflog_expiry_prepare_fn(const char *refname,
+                                     const unsigned char *sha1,
+                                     void *cb_data);
+typedef int reflog_expiry_should_prune_fn(unsigned char *osha1,
+                                         unsigned char *nsha1,
+                                         const char *email,
+                                         unsigned long timestamp, int tz,
+                                         const char *message, void *cb_data);
+typedef void reflog_expiry_cleanup_fn(void *cb_data);
+
+/*
+ * Expire reflog entries for the specified reference. sha1 is the old
+ * value of the reference. flags is a combination of the constants in
+ * enum expire_reflog_flags. The three function pointers are described
+ * above. On success, return zero.
+ */
+extern int reflog_expire(const char *refname, const unsigned char *sha1,
+                        unsigned int flags,
+                        reflog_expiry_prepare_fn prepare_fn,
+                        reflog_expiry_should_prune_fn should_prune_fn,
+                        reflog_expiry_cleanup_fn cleanup_fn,
+                        void *policy_cb_data);
+
 #endif /* REFS_H */
 #endif /* REFS_H */