expire_reflog(): pass flags through to expire_reflog_ent()
[gitweb.git] / builtin / reflog.c
index 2d85d260ca66deb060b837f86d81a7aad2761b69..08867a28910864ce077c2dbd353e2bba70218407 100644 (file)
@@ -20,19 +20,22 @@ static const char reflog_delete_usage[] =
 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
+};
+
 struct cmd_reflog_expire_cb {
        struct rev_info revs;
-       int dry_run;
        int stalefix;
        int rewrite;
-       int updateref;
        int verbose;
        unsigned long expire_total;
        unsigned long expire_unreachable;
        int recno;
 };
 
-struct expire_reflog_cb {
+struct expire_reflog_policy_cb {
        FILE *newlog;
        enum {
                UE_NORMAL,
@@ -43,12 +46,20 @@ struct expire_reflog_cb {
        unsigned long mark_limit;
        struct cmd_reflog_expire_cb *cmd;
        unsigned char last_kept_sha1[20];
+       struct commit *tip_commit;
+       struct commit_list *tips;
+};
+
+struct expire_reflog_cb {
+       unsigned int flags;
+       void *policy_cb;
 };
 
 struct collected_reflog {
        unsigned char sha1[20];
        char reflog[FLEX_ARRAY];
 };
+
 struct collect_reflog_cb {
        struct collected_reflog **e;
        int alloc;
@@ -220,7 +231,7 @@ static int keep_entry(struct commit **it, unsigned char *sha1)
  * the expire_limit and queue them back, so that the caller can call
  * us again to restart the traversal with longer expire_limit.
  */
-static void mark_reachable(struct expire_reflog_cb *cb)
+static void mark_reachable(struct expire_reflog_policy_cb *cb)
 {
        struct commit *commit;
        struct commit_list *pending;
@@ -259,7 +270,7 @@ static void mark_reachable(struct expire_reflog_cb *cb)
        cb->mark_list = leftover;
 }
 
-static int unreachable(struct expire_reflog_cb *cb, struct commit *commit, unsigned char *sha1)
+static int unreachable(struct expire_reflog_policy_cb *cb, struct commit *commit, unsigned char *sha1)
 {
        /*
         * We may or may not have the commit yet - if not, look it
@@ -288,55 +299,71 @@ static int unreachable(struct expire_reflog_cb *cb, struct commit *commit, unsig
        return !(commit->object.flags & REACHABLE);
 }
 
-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)
+/*
+ * Return true iff the specified reflog entry should be expired.
+ */
+static int should_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 *cb = cb_data;
        struct commit *old, *new;
 
        if (timestamp < cb->cmd->expire_total)
-               goto prune;
-
-       if (cb->cmd->rewrite)
-               osha1 = cb->last_kept_sha1;
+               return 1;
 
        old = new = NULL;
        if (cb->cmd->stalefix &&
            (!keep_entry(&old, osha1) || !keep_entry(&new, nsha1)))
-               goto prune;
+               return 1;
 
        if (timestamp < cb->cmd->expire_unreachable) {
                if (cb->unreachable_expire_kind == UE_ALWAYS)
-                       goto prune;
+                       return 1;
                if (unreachable(cb, old, osha1) || unreachable(cb, new, nsha1))
-                       goto prune;
+                       return 1;
        }
 
        if (cb->cmd->recno && --(cb->cmd->recno) == 0)
-               goto prune;
-
-       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->cmd->verbose)
-               printf("keep %s", message);
+               return 1;
+
        return 0;
- prune:
-       if (!cb->newlog)
-               printf("would prune %s", message);
-       else if (cb->cmd->verbose)
-               printf("prune %s", message);
+}
+
+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 (policy_cb->cmd->rewrite)
+               osha1 = policy_cb->last_kept_sha1;
+
+       if (should_expire_reflog_ent(osha1, nsha1, email, timestamp, tz,
+                                    message, policy_cb)) {
+               if (!policy_cb->newlog)
+                       printf("would prune %s", message);
+               else if (policy_cb->cmd->verbose)
+                       printf("prune %s", message);
+       } else {
+               if (policy_cb->newlog) {
+                       char sign = (tz < 0) ? '-' : '+';
+                       int zone = (tz < 0) ? (-tz) : tz;
+                       fprintf(policy_cb->newlog, "%s %s %s %lu %c%04d\t%s",
+                               sha1_to_hex(osha1), sha1_to_hex(nsha1),
+                               email, timestamp, sign, zone,
+                               message);
+                       hashcpy(policy_cb->last_kept_sha1, nsha1);
+               }
+               if (policy_cb->cmd->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)
 {
        struct commit_list **list = cb_data;
        struct commit *tip_commit;
@@ -349,104 +376,140 @@ static int push_tip_to_list(const char *refname, const unsigned char *sha1, int
        return 0;
 }
 
-static int expire_reflog(const char *ref, const unsigned char *sha1, int unused, void *cb_data)
+static void reflog_expiry_prepare(const char *refname,
+                                 const unsigned char *sha1,
+                                 struct expire_reflog_policy_cb *cb)
 {
-       struct cmd_reflog_expire_cb *cmd = cb_data;
-       struct expire_reflog_cb cb;
-       struct ref_lock *lock;
-       char *log_file, *newlog_path = NULL;
-       struct commit *tip_commit;
-       struct commit_list *tips;
-       int status = 0;
-
-       memset(&cb, 0, sizeof(cb));
-
-       /*
-        * we take the lock for the ref itself to prevent it from
-        * getting updated.
-        */
-       lock = lock_any_ref_for_update(ref, sha1, 0, NULL);
-       if (!lock)
-               return error("cannot lock ref '%s'", ref);
-       log_file = git_pathdup("logs/%s", ref);
-       if (!reflog_exists(ref))
-               goto finish;
-       if (!cmd->dry_run) {
-               newlog_path = git_pathdup("logs/%s.lock", ref);
-               cb.newlog = fopen(newlog_path, "w");
-       }
-
-       cb.cmd = cmd;
-
-       if (!cmd->expire_unreachable || !strcmp(ref, "HEAD")) {
-               tip_commit = NULL;
-               cb.unreachable_expire_kind = UE_HEAD;
+       if (!cb->cmd->expire_unreachable || !strcmp(refname, "HEAD")) {
+               cb->tip_commit = NULL;
+               cb->unreachable_expire_kind = UE_HEAD;
        } else {
-               tip_commit = lookup_commit_reference_gently(sha1, 1);
-               if (!tip_commit)
-                       cb.unreachable_expire_kind = UE_ALWAYS;
+               cb->tip_commit = lookup_commit_reference_gently(sha1, 1);
+               if (!cb->tip_commit)
+                       cb->unreachable_expire_kind = UE_ALWAYS;
                else
-                       cb.unreachable_expire_kind = UE_NORMAL;
+                       cb->unreachable_expire_kind = UE_NORMAL;
        }
 
-       if (cmd->expire_unreachable <= cmd->expire_total)
-               cb.unreachable_expire_kind = UE_ALWAYS;
+       if (cb->cmd->expire_unreachable <= cb->cmd->expire_total)
+               cb->unreachable_expire_kind = UE_ALWAYS;
 
-       cb.mark_list = NULL;
-       tips = NULL;
-       if (cb.unreachable_expire_kind != UE_ALWAYS) {
-               if (cb.unreachable_expire_kind == UE_HEAD) {
+       cb->mark_list = NULL;
+       cb->tips = NULL;
+       if (cb->unreachable_expire_kind != UE_ALWAYS) {
+               if (cb->unreachable_expire_kind == UE_HEAD) {
                        struct commit_list *elem;
-                       for_each_ref(push_tip_to_list, &tips);
-                       for (elem = tips; elem; elem = elem->next)
-                               commit_list_insert(elem->item, &cb.mark_list);
+                       for_each_ref(push_tip_to_list, &cb->tips);
+                       for (elem = cb->tips; elem; elem = elem->next)
+                               commit_list_insert(elem->item, &cb->mark_list);
                } else {
-                       commit_list_insert(tip_commit, &cb.mark_list);
+                       commit_list_insert(cb->tip_commit, &cb->mark_list);
                }
-               cb.mark_limit = cmd->expire_total;
-               mark_reachable(&cb);
+               cb->mark_limit = cb->cmd->expire_total;
+               mark_reachable(cb);
        }
+}
 
-       for_each_reflog_ent(ref, expire_reflog_ent, &cb);
-
-       if (cb.unreachable_expire_kind != UE_ALWAYS) {
-               if (cb.unreachable_expire_kind == UE_HEAD) {
+static void reflog_expiry_cleanup(struct expire_reflog_policy_cb *cb)
+{
+       if (cb->unreachable_expire_kind != UE_ALWAYS) {
+               if (cb->unreachable_expire_kind == UE_HEAD) {
                        struct commit_list *elem;
-                       for (elem = tips; elem; elem = elem->next)
+                       for (elem = cb->tips; elem; elem = elem->next)
                                clear_commit_marks(elem->item, REACHABLE);
-                       free_commit_list(tips);
+                       free_commit_list(cb->tips);
                } else {
-                       clear_commit_marks(tip_commit, REACHABLE);
+                       clear_commit_marks(cb->tip_commit, REACHABLE);
                }
        }
- finish:
-       if (cb.newlog) {
-               if (fclose(cb.newlog)) {
-                       status |= error("%s: %s", strerror(errno),
-                                       newlog_path);
-                       unlink(newlog_path);
-               } else if (cmd->updateref &&
+}
+
+static int expire_reflog(const char *refname, const unsigned char *sha1,
+                        unsigned int flags, struct cmd_reflog_expire_cb *cmd)
+{
+       static struct lock_file reflog_lock;
+       struct expire_reflog_cb cb;
+       struct expire_reflog_policy_cb policy_cb;
+       struct ref_lock *lock;
+       char *log_file;
+       int status = 0;
+
+       memset(&cb, 0, sizeof(cb));
+       memset(&policy_cb, 0, sizeof(policy_cb));
+       cb.flags = flags;
+       cb.policy_cb = &policy_cb;
+
+       /*
+        * 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;
+               }
+               policy_cb.newlog = fdopen_lock_file(&reflog_lock, "w");
+               if (!policy_cb.newlog) {
+                       error("cannot fdopen %s (%s)",
+                             reflog_lock.filename.buf, strerror(errno));
+                       goto failure;
+               }
+       }
+
+       policy_cb.cmd = cmd;
+
+       reflog_expiry_prepare(refname, sha1, &policy_cb);
+       for_each_reflog_ent(refname, expire_reflog_ent, &cb);
+       reflog_expiry_cleanup(&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 ||
+                               sha1_to_hex(policy_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",
+                       status |= error("couldn't write %s",
                                        lock->lk->filename.buf);
-                       unlink(newlog_path);
-               } else if (rename(newlog_path, log_file)) {
-                       status |= error("cannot rename %s to %s",
-                                       newlog_path, log_file);
-                       unlink(newlog_path);
-               } else if (cmd->updateref && commit_ref(lock)) {
-                       status |= error("Couldn't set %s", lock->ref_name);
-               } else {
-                       adjust_shared_perm(log_file);
+                       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(newlog_path);
        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)
@@ -594,6 +657,7 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix)
        unsigned long now = time(NULL);
        int i, status, do_all;
        int explicit_expiry = 0;
+       unsigned int flags = 0;
 
        default_reflog_expire_unreachable = now - 30 * 24 * 3600;
        default_reflog_expire = now - 90 * 24 * 3600;
@@ -609,7 +673,7 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix)
        for (i = 1; i < argc; i++) {
                const char *arg = argv[i];
                if (!strcmp(arg, "--dry-run") || !strcmp(arg, "-n"))
-                       cb.dry_run = 1;
+                       flags |= EXPIRE_REFLOGS_DRY_RUN;
                else if (starts_with(arg, "--expire=")) {
                        if (parse_expiry_date(arg + 9, &cb.expire_total))
                                die(_("'%s' is not a valid timestamp"), arg);
@@ -625,7 +689,7 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix)
                else if (!strcmp(arg, "--rewrite"))
                        cb.rewrite = 1;
                else if (!strcmp(arg, "--updateref"))
-                       cb.updateref = 1;
+                       flags |= EXPIRE_REFLOGS_UPDATE_REF;
                else if (!strcmp(arg, "--all"))
                        do_all = 1;
                else if (!strcmp(arg, "--verbose"))
@@ -663,7 +727,7 @@ 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, explicit_expiry, e->reflog);
-                       status |= expire_reflog(e->reflog, e->sha1, 0, &cb);
+                       status |= expire_reflog(e->reflog, e->sha1, flags, &cb);
                        free(e);
                }
                free(collected.e);
@@ -677,7 +741,7 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix)
                        continue;
                }
                set_reflog_expiry_param(&cb, explicit_expiry, ref);
-               status |= expire_reflog(ref, sha1, 0, &cb);
+               status |= expire_reflog(ref, sha1, flags, &cb);
        }
        return status;
 }
@@ -696,17 +760,18 @@ static int cmd_reflog_delete(int argc, const char **argv, const char *prefix)
 {
        struct cmd_reflog_expire_cb cb;
        int i, status = 0;
+       unsigned int flags = 0;
 
        memset(&cb, 0, sizeof(cb));
 
        for (i = 1; i < argc; i++) {
                const char *arg = argv[i];
                if (!strcmp(arg, "--dry-run") || !strcmp(arg, "-n"))
-                       cb.dry_run = 1;
+                       flags |= EXPIRE_REFLOGS_DRY_RUN;
                else if (!strcmp(arg, "--rewrite"))
                        cb.rewrite = 1;
                else if (!strcmp(arg, "--updateref"))
-                       cb.updateref = 1;
+                       flags |= EXPIRE_REFLOGS_UPDATE_REF;
                else if (!strcmp(arg, "--verbose"))
                        cb.verbose = 1;
                else if (!strcmp(arg, "--")) {
@@ -748,7 +813,7 @@ static int cmd_reflog_delete(int argc, const char **argv, const char *prefix)
                        cb.expire_total = 0;
                }
 
-               status |= expire_reflog(ref, sha1, 0, &cb);
+               status |= expire_reflog(ref, sha1, flags, &cb);
                free(ref);
        }
        return status;