<<< Date Index >>>     <<< Thread Index >>>

Re: X-Label editing patch inclusion?



* On 16 Jul 2010, Jan Larres wrote: 
> Hi,
> 
> I'm curious if there is a chance that the X-Label editing patch from
> http://home.uchicago.edu/~dgc/mutt/#x-label is going to be included in mutt. I
> know there are ways for label editing without that patch, but they are clumsy
> and don't allow for editing multiple tagged messages. If there are no
> principal objections I could adjust it to the current version and see if it
> can be improved usability-wise.

Current version attached.  This applies to HEAD as of July 3.

-- 
 -D.    dgc@xxxxxxxxxxxx    IT Services    University of Chicago
diff -r 1695b015d75a OPS
--- a/OPS       Wed Dec 02 18:52:05 2009 -0600
+++ b/OPS       Wed Dec 02 18:52:07 2009 -0600
@@ -56,6 +56,7 @@
 OP_DISPLAY_ADDRESS "display full address of sender"
 OP_DISPLAY_HEADERS "display message and toggle header weeding"
 OP_DISPLAY_MESSAGE "display a message"
+OP_EDIT_LABEL "add, change, or delete a message's label"
 OP_EDIT_MESSAGE "edit the raw message"
 OP_EDITOR_BACKSPACE "delete the char in front of the cursor"
 OP_EDITOR_BACKWARD_CHAR "move the cursor one character to the left"
diff -r 1695b015d75a PATCHES
--- a/PATCHES   Wed Dec 02 18:52:05 2009 -0600
+++ b/PATCHES   Wed Dec 02 18:52:07 2009 -0600
@@ -1,1 +1,2 @@
+patch-1.5.16.dgc.xlabel_ext.9
 patch-1.5.11.ats.mark_old.1.5
diff -r 1695b015d75a commands.c
--- a/commands.c        Wed Dec 02 18:52:05 2009 -0600
+++ b/commands.c        Wed Dec 02 18:52:07 2009 -0600
@@ -533,9 +533,9 @@
   int method = Sort; /* save the current method in case of abort */
 
   switch (mutt_multi_choice (reverse ?
-                            _("Rev-Sort 
(d)ate/(f)rm/(r)ecv/(s)ubj/t(o)/(t)hread/(u)nsort/si(z)e/s(c)ore/s(p)am?: ") :
-                            _("Sort 
(d)ate/(f)rm/(r)ecv/(s)ubj/t(o)/(t)hread/(u)nsort/si(z)e/s(c)ore/s(p)am?: "),
-                            _("dfrsotuzcp")))
+                            _("Rev-Sort 
Date/Frm/Recv/Subj/tO/Thread/Unsort/siZe/sCore/sPam/Label?: ") :
+                            _("Sort 
Date/Frm/Recv/Subj/tO/Thread/Unsort/siZe/sCore/sPam/Label?: "),
+                            _("dfrsotuzcpl")))
   {
   case -1: /* abort - don't resort */
     return -1;
@@ -579,6 +579,10 @@
   case 10: /* s(p)am */
     Sort = SORT_SPAM;
     break;
+
+  case 11: /* (l)abel */
+    Sort = SORT_LABEL;
+    break;
   }
   if (reverse)
     Sort |= SORT_REVERSE;
diff -r 1695b015d75a copy.c
--- a/copy.c    Wed Dec 02 18:52:05 2009 -0600
+++ b/copy.c    Wed Dec 02 18:52:07 2009 -0600
@@ -111,6 +111,10 @@
        ignore = 0;
       }
 
+      if (flags & CH_UPDATE_LABEL &&
+         mutt_strncasecmp ("X-Label:", buf, 8) == 0)
+       continue;
+
       if (!ignore && fputs (buf, out) == EOF)
        return (-1);
     }
@@ -412,6 +416,15 @@
       fprintf (out, "Lines: %d\n", h->lines);
   }
 
+  if (flags & CH_UPDATE_LABEL && h->xlabel_changed)
+  {
+    h->xlabel_changed = 0;
+    if (h->env->x_label != NULL)
+      if (fprintf(out, "X-Label: %s\n", h->env->x_label) !=
+                 10 + strlen(h->env->x_label))
+        return -1;
+  }
+
   if ((flags & CH_NONEWLINE) == 0)
   {
     if (flags & CH_PREFIX)
@@ -492,6 +505,9 @@
       _mutt_make_string (prefix, sizeof (prefix), NONULL (Prefix), Context, 
hdr, 0);
   }
 
+  if (hdr->xlabel_changed)
+    chflags |= CH_UPDATE_LABEL;
+
   if ((flags & M_CM_NOHEADER) == 0)
   {
     if (flags & M_CM_PREFIX)
diff -r 1695b015d75a copy.h
--- a/copy.h    Wed Dec 02 18:52:05 2009 -0600
+++ b/copy.h    Wed Dec 02 18:52:07 2009 -0600
@@ -53,6 +53,7 @@
 #define CH_UPDATE_IRT     (1<<16) /* update In-Reply-To: */
 #define CH_UPDATE_REFS    (1<<17) /* update References: */
 #define CH_DISPLAY        (1<<18) /* display result to user */
+#define CH_UPDATE_LABEL   (1<<19) /* update X-Label: from hdr->env->x_label? */
 
 
 int mutt_copy_hdr (FILE *, FILE *, LOFF_T, LOFF_T, int, const char *);
diff -r 1695b015d75a curs_main.c
--- a/curs_main.c       Wed Dec 02 18:52:05 2009 -0600
+++ b/curs_main.c       Wed Dec 02 18:52:07 2009 -0600
@@ -1932,6 +1932,21 @@
        menu->redraw = REDRAW_FULL;
        break;
 
+      case OP_EDIT_LABEL:
+
+       CHECK_MSGCOUNT;
+       CHECK_READONLY;
+       rc = mutt_label_message(tag ? NULL : CURHDR);
+       if (rc > 0) {
+         Context->changed = 1;
+         menu->redraw = REDRAW_FULL;
+         mutt_message ("%d label%s changed.", rc, rc == 1 ? "" : "s");
+       }
+       else {
+         mutt_message _("No labels changed.");
+       }
+       break;
+
       case OP_LIST_REPLY:
 
        CHECK_ATTACH;
diff -r 1695b015d75a doc/manual.xml.head
--- a/doc/manual.xml.head       Wed Dec 02 18:52:05 2009 -0600
+++ b/doc/manual.xml.head       Wed Dec 02 18:52:07 2009 -0600
@@ -5826,6 +5826,12 @@
 </para>
 
 <para>
+You can change or delete the <quote>X-Label:</quote> field within
+Mutt using the <quote>edit-label</quote> command, bound to the
+<quote>y</quote> key by default.  This works for tagged messages, too.
+</para>
+
+<para>
 Lastly, Mutt has the ability to <link linkend="sort">sort</link> the
 mailbox into <link linkend="threads">threads</link>.  A thread is a
 group of messages which all relate to the same subject.  This is usually
diff -r 1695b015d75a functions.h
--- a/functions.h       Wed Dec 02 18:52:05 2009 -0600
+++ b/functions.h       Wed Dec 02 18:52:07 2009 -0600
@@ -99,6 +99,7 @@
   { "delete-thread",           OP_DELETE_THREAD,               "\004" },
   { "delete-subthread",                OP_DELETE_SUBTHREAD,            "\033d" 
},
   { "edit",                    OP_EDIT_MESSAGE,                "e" },
+  { "edit-label",              OP_EDIT_LABEL,                  "y" },
   { "edit-type",               OP_EDIT_TYPE,                   "\005" },
   { "forward-message",         OP_FORWARD_MESSAGE,             "f" },
   { "flag-message",            OP_FLAG_MESSAGE,                "F" },
@@ -186,6 +187,7 @@
   { "set-flag",        OP_MAIN_SET_FLAG,               "w" },
   { "clear-flag",       OP_MAIN_CLEAR_FLAG,            "W" },
   { "edit",            OP_EDIT_MESSAGE,                "e" },
+  { "edit-label",      OP_EDIT_LABEL,                  "y" },
   { "edit-type",       OP_EDIT_TYPE,                   "\005" },
   { "forward-message", OP_FORWARD_MESSAGE,             "f" },
   { "flag-message",    OP_FLAG_MESSAGE,                "F" },
diff -r 1695b015d75a headers.c
--- a/headers.c Wed Dec 02 18:52:05 2009 -0600
+++ b/headers.c Wed Dec 02 18:52:07 2009 -0600
@@ -215,3 +215,59 @@
     }
   }
 }
+
+/*
+ * dgc: Add an X-Label: field.
+ */
+static int label_message(HEADER *hdr, char *new)
+{
+       if (hdr == NULL)
+               return 0;
+       if (hdr->env->x_label == NULL && new == NULL)
+               return 0;
+       if (hdr->env->x_label != NULL && new != NULL &&
+                       strcmp(hdr->env->x_label, new) == 0)
+               return 0;
+       if (hdr->env->x_label != NULL)
+               FREE(&hdr->env->x_label);
+       if (new == NULL)
+               hdr->env->x_label = NULL;
+       else
+               hdr->env->x_label = safe_strdup(new);
+       return hdr->changed = hdr->xlabel_changed = 1;
+}
+
+int mutt_label_message(HEADER *hdr)
+{
+       char buf[LONG_STRING], *new;
+       int i;
+       int changed;
+
+       *buf = '\0';
+       if (hdr != NULL && hdr->env->x_label != NULL) {
+               strncpy(buf, hdr->env->x_label, LONG_STRING);
+       }
+
+       mutt_get_field("Label: ", buf, sizeof(buf), 0 /* | M_CLEAR */);
+       new = buf;
+       SKIPWS(new);
+       if (*new == '\0')
+               new = NULL;
+
+       changed = 0;
+       if (hdr != NULL) {
+               changed += label_message(hdr, new);
+       } else {
+#define HDR_OF(index)  Context->hdrs[Context->v2r[(index)]]
+               for (i = 0; i < Context->vcount; ++i) {
+                       if (HDR_OF(i)->tagged)
+                               if (label_message(HDR_OF(i), new)) {
+                                       ++changed;
+                                       mutt_set_flag(Context, HDR_OF(i),
+                                               M_TAG, 0);
+                               }
+               }
+       }
+
+       return changed;
+}
diff -r 1695b015d75a imap/imap.c
--- a/imap/imap.c       Wed Dec 02 18:52:05 2009 -0600
+++ b/imap/imap.c       Wed Dec 02 18:52:07 2009 -0600
@@ -1225,7 +1225,7 @@
        * we delete the message and reupload it.
        * This works better if we're expunging, of course. */
       if ((h->env && (h->env->refs_changed || h->env->irt_changed)) ||
-         h->attach_del)
+         h->attach_del || h->xlabel_changed)
       {
         mutt_message (_("Saving changed messages... [%d/%d]"), n+1,
                       ctx->msgcount);
@@ -1235,6 +1235,7 @@
          dprint (1, (debugfile, "imap_sync_mailbox: Error opening mailbox in 
append mode\n"));
        else
          _mutt_save_message (h, appendctx, 1, 0, 0);
+       h->xlabel_changed = 0;
       }
     }
   }
diff -r 1695b015d75a imap/message.c
--- a/imap/message.c    Wed Dec 02 18:52:05 2009 -0600
+++ b/imap/message.c    Wed Dec 02 18:52:07 2009 -0600
@@ -398,6 +398,7 @@
   IMAP_CACHE *cache;
   int read;
   int rc;
+  char *x_label = NULL;
   /* Sam's weird courier server returns an OK response even when FETCH
    * fails. Thanks Sam. */
   short fetched = 0;
diff -r 1695b015d75a init.h
--- a/init.h    Wed Dec 02 18:52:05 2009 -0600
+++ b/init.h    Wed Dec 02 18:52:07 2009 -0600
@@ -3378,6 +3378,7 @@
   { "to",              SORT_TO },
   { "score",           SORT_SCORE },
   { "spam",            SORT_SPAM },
+  { "label",           SORT_LABEL },
   { NULL,               0 }
 };
 
@@ -3397,6 +3398,7 @@
   { "to",              SORT_TO },
   { "score",           SORT_SCORE },
   { "spam",            SORT_SPAM },
+  { "label",           SORT_LABEL },
   { NULL,               0 }
 };
 
diff -r 1695b015d75a mh.c
--- a/mh.c      Wed Dec 02 18:52:05 2009 -0600
+++ b/mh.c      Wed Dec 02 18:52:07 2009 -0600
@@ -1559,7 +1559,7 @@
 {
   HEADER *h = ctx->hdrs[msgno];
 
-  if (h->attach_del || 
+  if (h->attach_del || h->xlabel_changed ||
       (h->env && (h->env->refs_changed || h->env->irt_changed)))
     if (mh_rewrite_message (ctx, msgno) != 0)
       return -1;
@@ -1571,7 +1571,7 @@
 {
   HEADER *h = ctx->hdrs[msgno];
 
-  if (h->attach_del || 
+  if (h->attach_del || h->xlabel_changed ||
       (h->env && (h->env->refs_changed || h->env->irt_changed)))
   {
     /* when doing attachment deletion/rethreading, fall back to the MH case. */
@@ -1693,6 +1693,7 @@
       }
     }
     else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
+            ctx->hdrs[i]->xlabel_changed ||
             (ctx->magic == M_MAILDIR
              && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
              && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash)))
diff -r 1695b015d75a mutt.h
--- a/mutt.h    Wed Dec 02 18:52:05 2009 -0600
+++ b/mutt.h    Wed Dec 02 18:52:07 2009 -0600
@@ -723,6 +723,7 @@
                                         * This flag is used by the 
maildir_trash
                                         * option.
                                         */
+  unsigned int xlabel_changed : 1;     /* editable - used for syncing */
   
   /* timezone of the sender of this message */
   unsigned int zhours : 5;
diff -r 1695b015d75a pager.c
--- a/pager.c   Wed Dec 02 18:52:05 2009 -0600
+++ b/pager.c   Wed Dec 02 18:52:07 2009 -0600
@@ -2699,6 +2699,18 @@
        redraw = REDRAW_FULL;
        break;
 
+     case OP_EDIT_LABEL:
+        CHECK_MODE(IsHeader (extra));
+        rc = mutt_label_message(extra->hdr);
+        if (rc > 0) {
+          Context->changed = 1;
+          redraw = REDRAW_FULL;
+          mutt_message ("%d label%s changed.", rc, rc == 1 ? "" : "s");
+        }
+        else {
+          mutt_message _("No labels changed.");
+        }
+        break;
 
       case OP_MAIL_KEY:
         if (!(WithCrypto & APPLICATION_PGP))
diff -r 1695b015d75a protos.h
--- a/protos.h  Wed Dec 02 18:52:05 2009 -0600
+++ b/protos.h  Wed Dec 02 18:52:07 2009 -0600
@@ -183,6 +183,7 @@
 void mutt_edit_file (const char *, const char *);
 void mutt_edit_headers (const char *, const char *, HEADER *, char *, size_t);
 int mutt_filter_unprintable (char **);
+int mutt_label_message (HEADER *);
 void mutt_curses_error (const char *, ...);
 void mutt_curses_message (const char *, ...);
 void mutt_encode_path (char *, size_t, const char *);
diff -r 1695b015d75a sort.c
--- a/sort.c    Wed Dec 02 18:52:05 2009 -0600
+++ b/sort.c    Wed Dec 02 18:52:07 2009 -0600
@@ -210,6 +210,36 @@
   return (SORTCODE(result));
 }
 
+int compare_label (const void *a, const void *b)
+{
+  HEADER **ppa = (HEADER **) a;
+  HEADER **ppb = (HEADER **) b;
+  int     ahas, bhas, result;
+
+  /* As with compare_spam, not all messages will have the x-label
+   * property.  Blank X-Labels are treated as null in the index
+   * display, so we'll consider them as null for sort, too.       */
+  ahas = (*ppa)->env && (*ppa)->env->x_label && *((*ppa)->env->x_label);
+  bhas = (*ppb)->env && (*ppb)->env->x_label && *((*ppb)->env->x_label);
+
+  /* First we bias toward a message with a label, if the other does not. */
+  if (ahas && !bhas)
+    return (SORTCODE(-1));
+  if (!ahas && bhas)
+    return (SORTCODE(1));
+
+  /* If neither has a label, use aux sort. */
+  if (!ahas && !bhas)
+  {
+    AUXSORT(result, a, b);
+    return (SORTCODE(result));
+  }
+
+  /* If both have a label, we just do a lexical compare. */
+  result = mutt_strcasecmp((*ppa)->env->x_label, (*ppb)->env->x_label);
+  return (SORTCODE(result));
+}
+
 sort_t *mutt_get_sort_func (int method)
 {
   switch (method & SORT_MASK)
@@ -232,6 +262,8 @@
       return (compare_score);
     case SORT_SPAM:
       return (compare_spam);
+    case SORT_LABEL:
+      return (compare_label);
     default:
       return (NULL);
   }
diff -r 1695b015d75a sort.h
--- a/sort.h    Wed Dec 02 18:52:05 2009 -0600
+++ b/sort.h    Wed Dec 02 18:52:07 2009 -0600
@@ -31,6 +31,7 @@
 #define SORT_KEYID     12
 #define SORT_TRUST     13
 #define SORT_SPAM      14
+#define SORT_LABEL     15
 /* dgc: Sort & SortAux are shorts, so I'm bumping these bitflags up from
  * bits 4 & 5 to bits 8 & 9 to make room for more sort keys in the future. */
 #define SORT_MASK      0xff