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