sidebar.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) ????-2004 Justin Hibbits <jrh29@po.cwru.edu>
   4  * Copyright (C) 2004 Thomer M. Gil <mutt@thomer.com>
   5  *
   6  * Parts were written/modified by:
   7  * Rocco Rutte <pdmef@cs.tu-berlin.de>
   8  * Nico Golde <nico@ngolde.de>
   9  *
  10  * This file is part of mutt-ng, see http://www.muttng.org/.
  11  * It's licensed under the GNU General Public License,
  12  * please see the file GPL in the top level source directory.
  13  */
  14
  15 #include "mutt.h"
  16 #include "mutt_menu.h"
  17 #include "mutt_curses.h"
  18 #include "sidebar.h"
  19 #include "buffy.h"
  20 #include "keymap.h"
  21
  22 #include "lib/mem.h"
  23 #include "lib/str.h"
  24 #include "lib/intl.h"
  25
  26 #include <libgen.h>
  27 #include <ctype.h>
  28
  29 static int TopBuffy = 0;
  30 static int CurBuffy = 0;
  31 static int known_lines = 0;
  32 static short initialized = 0;
  33 static short prev_show_value;
  34 static short saveSidebarWidth;
  35
  36 /* computes first entry to be shown */
  37 void calc_boundaries (int menu)
  38 {
  39   int lines = 0;
  40
  41   if (list_empty(Incoming))
  42     return;
  43   if (CurBuffy < 0 || CurBuffy >= Incoming->length)
  44     CurBuffy = 0;
  45   if (TopBuffy < 0 || TopBuffy >= Incoming->length)
  46     TopBuffy = 0;
  47   /* correct known_lines if it has changed because of a window resize */
  48   /*  if (known_lines != LINES)
  49     known_lines = LINES; */
  50
  51   lines = LINES - 2 - (menu != MENU_PAGER || option (OPTSTATUSONTOP));
  52   known_lines = lines;
  53   if (option (OPTSIDEBARNEWMAILONLY)) {
  54     int i = CurBuffy;
  55     TopBuffy = CurBuffy - 1;
  56     while (i >= 0) {
  57       if (((BUFFY*) Incoming->data[i])->new > 0)
  58         TopBuffy = i;
  59       i--;
  60     }
  61   } else
  62     TopBuffy = CurBuffy - (CurBuffy % lines);
  63   if (TopBuffy < 0)
  64     TopBuffy = 0;
  65 }
  66
  67 static char *shortened_hierarchy (char *box, int maxlen)
  68 {
  69   int dots = 0;
  70   char *last_dot = NULL;
  71   int i, j, len = str_len (box);
  72   char *new_box;
  73
  74   if (!SidebarBoundary || !*SidebarBoundary)
  75     return (str_dup (box));
  76
  77   for (i = 0; i < len; ++i) {
  78     if (strchr (SidebarBoundary, box[i])) {
  79       ++dots;
  80       last_dot = &box[i];
  81     }
  82   }
  83
  84   if (last_dot) {
  85     ++last_dot;
  86     new_box = mem_malloc (maxlen + 1);
  87     new_box[0] = box[0];
  88     for (i = 1, j = 1; j < maxlen && i < len; ++i) {
  89       if (strchr (SidebarBoundary, box[i])) {
  90         new_box[j++] = box[i];
  91         new_box[j] = 0;
  92         if (&box[i + 1] != last_dot || j + str_len (last_dot) > maxlen) {
  93           new_box[j++] = box[i + 1];
  94           new_box[j] = 0;
  95         } else {
  96           strcat (&new_box[j], last_dot);
  97           break;
  98         }
  99       }
 100     }
 101     return new_box;
 102   }
 103   return str_dup (box);
 104 }
 105
 106 static const char* sidebar_number_format (char* dest, size_t destlen, char op,
 107                                           const char* src, const char* fmt,
 108                                           const char* ifstr, const char* elstr,
 109                                           unsigned long data, format_flag flags) {
 110   char tmp[SHORT_STRING];
 111   BUFFY* b = (BUFFY*) Incoming->data[data];
 112   int opt = flags & M_FORMAT_OPTIONAL;
 113   int c = Context && str_eq (Context->path, b->path);
 114
 115   switch (op) {
 116     /* deleted */
 117     case 'd':
 118       if (!opt) {
 119         snprintf (tmp, sizeof (tmp), "%%%sd", fmt);
 120         snprintf (dest, destlen, tmp, c ? Context->deleted : 0);
 121       } else if ((c && Context->deleted == 0) || !c)
 122         opt = 0;
 123       break;
 124     /* flagged */
 125     case 'F':
 126     case 'f':                   /* for compatibility */
 127       if (!opt) {
 128         snprintf (tmp, sizeof (tmp), "%%%sd", fmt);
 129         snprintf (dest, destlen, tmp, c ? Context->flagged : b->msg_flagged);
 130       } else if ((c && Context->flagged == 0) || (!c && b->msg_flagged == 0))
 131         opt = 0;
 132       break;
 133     /* total */
 134     case 'c':                   /* for compatibility */
 135     case 'm':
 136       if (!opt) {
 137         snprintf (tmp, sizeof (tmp), "%%%sd", fmt);
 138         snprintf (dest, destlen, tmp, c ? Context->msgcount : b->msgcount);
 139       } else if ((c && Context->msgcount == 0) || (!c && b->msgcount == 0))
 140         opt = 0;
 141       break;
 142     /* total shown, i.e. not hidden by limit */
 143     case 'M':
 144       if (!opt) {
 145         snprintf (tmp, sizeof (tmp), "%%%sd", fmt);
 146         snprintf (dest, destlen, tmp, c ? Context->vcount : 0);
 147       } else if ((c && Context->vcount == 0) || !c)
 148         opt = 0;
 149       break;
 150     /* new */
 151     case 'n':
 152       if (!opt) {
 153         snprintf (tmp, sizeof (tmp), "%%%sd", fmt);
 154         snprintf (dest, destlen, tmp, c ? Context->unread : b->msg_unread);
 155       } else if ((c && Context->unread == 0) || (!c && b->msg_unread == 0))
 156         opt = 0;
 157       break;
 158     /* tagged */
 159     case 't':
 160       if (!opt) {
 161         snprintf (tmp, sizeof (tmp), "%%%sd", fmt);
 162         snprintf (dest, destlen, tmp, c ? Context->tagged : 0);
 163       } else if ((c && Context->tagged == 0) || !c)
 164         opt = 0;
 165       break;
 166   }
 167
 168   if (opt)
 169     mutt_FormatString (dest, destlen, ifstr, sidebar_number_format,
 170                        data, M_FORMAT_OPTIONAL);
 171   else if (flags & M_FORMAT_OPTIONAL)
 172     mutt_FormatString (dest, destlen, elstr, sidebar_number_format,
 173                        data, M_FORMAT_OPTIONAL);
 174   return (src);
 175 }
 176
 177 int sidebar_need_count (void) {
 178   if (!option (OPTMBOXPANE) || SidebarWidth == 0 ||
 179       !SidebarNumberFormat || !*SidebarNumberFormat)
 180     return (0);
 181   return (1);
 182 }
 183
 184 /* print single item
 185  * returns:
 186  *      0       item was not printed ('cause of $sidebar_newmail_only)
 187  *      1       item was printed
 188  */
 189 int make_sidebar_entry (char* box, int idx, size_t len)
 190 {
 191   int shortened = 0, lencnt = 0;
 192   char no[SHORT_STRING], entry[SHORT_STRING];
 193 #if USE_IMAP
 194   int l = str_len (ImapHomeNamespace);
 195 #endif
 196   int l_m = str_len (Maildir);
 197
 198   if (SidebarWidth > COLS)
 199     SidebarWidth = COLS;
 200
 201   if (option (OPTSIDEBARNEWMAILONLY) && box && Context && Context->path &&
 202       !str_eq (Context->path, box) && ((BUFFY*) Incoming->data[idx])->new == 0)
 203     /* if $sidebar_newmail_only is set, don't display the
 204      * box only if it's not the currently opened
 205      * (i.e. always display the currently opened) */
 206     return (0);
 207
 208   mutt_FormatString (no, len, NONULL (SidebarNumberFormat),
 209                      sidebar_number_format, idx, M_FORMAT_OPTIONAL);
 210   lencnt = str_len (no);
 211   memset (&entry, ' ', sizeof (entry));
 212
 213 #if USE_IMAP
 214   if (l > 0 && str_ncmp (box, ImapHomeNamespace, l) == 0 &&
 215       str_len (box) > l)
 216     box += l + 1; /* we're trimming the ImapHomeNamespace, the "+ 1" is for the separator */
 217   else
 218 #endif
 219   if (l_m > 0 && str_ncmp (box, Maildir, l_m) == 0 &&
 220       str_len (box) > l_m) {
 221     box += l_m;
 222     if (Maildir[strlen(Maildir)-1]!='/') {
 223       box += 1;
 224     }
 225   } else
 226     box = basename (box);
 227
 228   if (option (OPTSHORTENHIERARCHY) && str_len (box) > len-lencnt-1) {
 229     box = shortened_hierarchy (box, len-lencnt-1);
 230     shortened = 1;
 231   }
 232
 233   snprintf (entry, len-lencnt, "%s", box);
 234   entry[str_len (entry)] = ' ';
 235   strncpy (entry + (len - lencnt), no, lencnt);
 236
 237   addnstr (entry, len);
 238
 239   if (shortened)
 240     mem_free(&box);
 241
 242   return (1);
 243 }
 244
 245 /* returns folder name of currently
 246  * selected folder for <sidebar-open>
 247  */
 248 const char* sidebar_get_current (void) {
 249   if (list_empty(Incoming))
 250     return (NULL);
 251   return ((char*) ((BUFFY*) Incoming->data[CurBuffy])->path);
 252 }
 253
 254 /* internally sets item to buf */
 255 void sidebar_set_current (const char* buf) {
 256   int i = buffy_lookup (buf);
 257   if (i >= 0)
 258     CurBuffy = i;
 259 }
 260
 261 /* fix counters for a context
 262  * FIXME since ctx must not be of our business, move it elsewhere
 263  */
 264 void sidebar_set_buffystats (CONTEXT* Context) {
 265   int i = 0;
 266   BUFFY* tmp = NULL;
 267   if (!Context || list_empty(Incoming) || (i = buffy_lookup (Context->path)) < 0)
 268     return;
 269   tmp = (BUFFY*) Incoming->data[i];
 270   tmp->new = Context->new;
 271   tmp->msg_unread = Context->unread;
 272   tmp->msgcount = Context->msgcount;
 273   tmp->msg_flagged = Context->flagged;
 274 }
 275
 276 /* actually draws something
 277  * FIXME this needs some clue when to do it
 278  */
 279 int sidebar_draw (int menu)
 280 {
 281
 282   int lines = option (OPTHELP) ? 1 : 0, draw_devider = 1, i = 0;
 283   BUFFY *tmp;
 284   short delim_len = str_len (SidebarDelim);
 285   char blank[SHORT_STRING];
 286
 287   /* initialize first time */
 288   if (!initialized) {
 289     prev_show_value = option (OPTMBOXPANE);
 290     saveSidebarWidth = SidebarWidth;
 291     if (!option (OPTMBOXPANE)){
 292       SidebarWidth = 0;
 293       draw_devider = 1;
 294     }
 295     initialized = 1;
 296   }
 297
 298   /* save or restore the value SidebarWidth */
 299   if (prev_show_value != option (OPTMBOXPANE)) {
 300     if (prev_show_value && !option (OPTMBOXPANE)) {
 301       saveSidebarWidth = SidebarWidth;
 302       SidebarWidth = 0;
 303     }
 304     else if (!prev_show_value && option (OPTMBOXPANE)) {
 305       SidebarWidth = saveSidebarWidth;
 306       /* after toggle: force recounting of all mail */
 307       buffy_check (2);
 308     }
 309     prev_show_value = option (OPTMBOXPANE);
 310   }
 311
 312   if (SidebarWidth > 0 && option (OPTMBOXPANE)
 313       && str_len (SidebarDelim) >= SidebarWidth) {
 314     mutt_error (_("Value for sidebar_delim is too long. Disabling sidebar."));
 315     sleep (2);
 316     unset_option (OPTMBOXPANE);
 317     return (0);
 318   }
 319
 320   if (SidebarWidth == 0 || !option (OPTMBOXPANE))
 321     return 0;
 322   /* draw devider only if necessary (if the sidebar becomes visible e.g.)*/
 323   if (draw_devider == 1){
 324     /* draw the divider */
 325     SETCOLOR (MT_COLOR_SIDEBAR);
 326     for (lines = 1;
 327          lines < LINES - 1 - (menu != MENU_PAGER || option (OPTSTATUSONTOP));
 328          lines++) {
 329       move (lines, SidebarWidth - delim_len);
 330       if (option (OPTASCIICHARS))
 331         addstr (NONULL (SidebarDelim));
 332       else if (!option (OPTASCIICHARS) && !str_cmp (SidebarDelim, "|"))
 333         addch (ACS_VLINE);
 334       else if ((Charset_is_utf8) && !str_cmp (SidebarDelim, "|"))
 335         addstr ("\342\224\202");
 336       else
 337         addstr (NONULL (SidebarDelim));
 338     }
 339   }
 340   SETCOLOR (MT_COLOR_NORMAL);
 341
 342   if (list_empty(Incoming))
 343     return 0;
 344   lines = option (OPTHELP) ? 1 : 0;     /* go back to the top */
 345   calc_boundaries (menu);
 346
 347   /* actually print items */
 348   for (i = TopBuffy; i < Incoming->length && lines < LINES - 1 -
 349        (menu != MENU_PAGER || option (OPTSTATUSONTOP)); i++) {
 350     tmp = (BUFFY*) Incoming->data[i];
 351
 352     if (i == CurBuffy)
 353       SETCOLOR (MT_COLOR_INDICATOR);
 354     else if (tmp->new > 0)
 355       SETCOLOR (MT_COLOR_NEW);
 356     else if (tmp->msg_flagged > 0)
 357       SETCOLOR (MT_COLOR_FLAGGED);
 358     else
 359       SETCOLOR (MT_COLOR_NORMAL);
 360
 361     move (lines, 0);
 362     lines += make_sidebar_entry (tmp->path, i, SidebarWidth-delim_len);
 363   }
 364
 365   /* fill with blanks to bottom */
 366   memset (&blank, ' ', sizeof (blank));
 367   SETCOLOR (MT_COLOR_NORMAL);
 368   for (; lines < LINES - 1 - (menu != MENU_PAGER || option (OPTSTATUSONTOP)); lines++) {
 369     move (lines, 0);
 370     addnstr (blank, SidebarWidth-delim_len);
 371   }
 372   return 0;
 373 }
 374
 375 /* returns index of new item with new mail or -1 */
 376 static int exist_next_new () {
 377   int i = 0;
 378   if (list_empty(Incoming))
 379     return (-1);
 380   i = CurBuffy + 1;
 381   while (i < Incoming->length)
 382     if (((BUFFY*) Incoming->data[i++])->new > 0)
 383       return (i-1);
 384   return (-1);
 385 }
 386
 387 /* returns index of prev item with new mail or -1 */
 388 static int exist_prev_new () {
 389   int i = 0;
 390   if (list_empty(Incoming))
 391     return (-1);
 392   i = CurBuffy - 1;
 393   while (i >= 0)
 394     if (((BUFFY*) Incoming->data[i--])->new > 0)
 395       return (i+1);
 396   return (-1);
 397 }
 398
 399 void sidebar_scroll (int op, int menu) {
 400   int i = 0;
 401
 402   if (!SidebarWidth || list_empty(Incoming))
 403     return;
 404
 405   switch (op) {
 406   case OP_SIDEBAR_NEXT:
 407     if (!option (OPTSIDEBARNEWMAILONLY)) {
 408       if (CurBuffy + 1 == Incoming->length) {
 409         mutt_error (_("You are on the last mailbox."));
 410         return;
 411       }
 412       CurBuffy++;
 413       break;
 414     }                           /* the fall-through is intentional */
 415   case OP_SIDEBAR_NEXT_NEW:
 416     if ((i = exist_next_new ()) < 0) {
 417       mutt_error (_("No next mailboxes with new mail."));
 418       return;
 419     }
 420     else
 421       CurBuffy = i;
 422     break;
 423   case OP_SIDEBAR_PREV:
 424     if (!option (OPTSIDEBARNEWMAILONLY)) {
 425       if (CurBuffy == 0) {
 426         mutt_error (_("You are on the first mailbox."));
 427         return;
 428       }
 429       CurBuffy--;
 430       break;
 431     }                           /* the fall-through is intentional */
 432   case OP_SIDEBAR_PREV_NEW:
 433     if ((i = exist_prev_new ()) < 0) {
 434       mutt_error (_("No previous mailbox with new mail."));
 435       return;
 436     }
 437     else
 438       CurBuffy = i;
 439     break;
 440
 441   case OP_SIDEBAR_SCROLL_UP:
 442     if (CurBuffy == 0) {
 443       mutt_error (_("You are on the first mailbox."));
 444       return;
 445     }
 446     CurBuffy -= known_lines;
 447     if (CurBuffy < 0)
 448       CurBuffy = 0;
 449     break;
 450   case OP_SIDEBAR_SCROLL_DOWN:
 451     if (CurBuffy + 1 == Incoming->length) {
 452       mutt_error (_("You are on the last mailbox."));
 453       return;
 454     }
 455     CurBuffy += known_lines;
 456     if (CurBuffy >= Incoming->length)
 457       CurBuffy = Incoming->length - 1;
 458     break;
 459   default:
 460     return;
 461   }
 462   calc_boundaries (menu);
 463   sidebar_draw (menu);
 464 }